Expose setIndexConfiguration

.changeset/honest-waves-brake.md

@@ -0,0 +1,5 @@
+---
+'@firebase/firestore': patch
+---
+
+Expose client side indexing feature with `setIndexConfiguration`.

common/api-review/firestore.api.md

@@ -233,6 +233,30 @@ export function getFirestore(app?: FirebaseApp): Firestore;
 // @public
 export function increment(n: number): FieldValue;
 
+// @public
+export interface Index {
+    // (undocumented)
+    [key: string]: unknown;
+    readonly collectionGroup: string;
+    readonly fields?: IndexField[];
+}
+
+// @public
+export interface IndexConfiguration {
+    // (undocumented)
+    [key: string]: unknown;
+    readonly indexes?: Index[];
+}
+
+// @public
+export interface IndexField {
+    // (undocumented)
+    [key: string]: unknown;
+    readonly arrayConfig?: 'CONTAINS';
+    readonly fieldPath: string;
+    readonly order?: 'ASCENDING' | 'DESCENDING';
+}
+
 // @public
 export function initializeFirestore(app: FirebaseApp, settings: FirestoreSettings): Firestore;
 
@@ -396,6 +420,12 @@ export function setDoc<T>(reference: DocumentReference<T>, data: WithFieldValue<
 // @public
 export function setDoc<T>(reference: DocumentReference<T>, data: PartialWithFieldValue<T>, options: SetOptions): Promise<void>;
 
+// @public
+export function setIndexConfiguration(firestore: Firestore, configuration: IndexConfiguration): Promise<void>;
+
+// @public
+export function setIndexConfiguration(firestore: Firestore, json: string): Promise<void>;
+
 // @public
 export function setLogLevel(logLevel: LogLevel): void;
 

packages/firestore/src/api.ts

@@ -143,6 +143,13 @@ export {
   UnionToIntersection
 } from '../src/lite-api/types';
 
+export {
+  setIndexConfiguration,
+  Index,
+  IndexConfiguration,
+  IndexField
+} from './api/index_configuration';
+
 /**
  * Internal exports
  */
@@ -160,4 +167,3 @@ export type { ByteString as _ByteString } from './util/byte_string';
 export { logWarn as _logWarn } from './util/log';
 export { EmptyAuthCredentialsProvider as _EmptyAuthCredentialsProvider } from './api/credentials';
 export { EmptyAppCheckTokenProvider as _EmptyAppCheckTokenProvider } from './api/credentials';
-export { setIndexConfiguration as _setIndexConfiguration } from './api/index_configuration';

packages/firestore/src/api/index_configuration.ts

@@ -39,8 +39,6 @@ export {
 
 /**
  * A single field element in an index configuration.
- *
- * @internal
  */
 export interface IndexField {
   /** The field path to index. */
@@ -65,8 +63,6 @@ export interface IndexField {
 
 /**
  * The SDK definition of a Firestore index.
- *
- * @internal
  */
 export interface Index {
   /** The ID of the collection to index. */
@@ -82,8 +78,6 @@ export interface Index {
  *
  * See {@link https://firebase.google.com/docs/reference/firestore/indexes/#json_format | JSON Format}
  * for a description of the format of the index definition.
- *
- * @internal
  */
 export interface IndexConfiguration {
   /** A list of all Firestore indexes. */
@@ -107,7 +101,6 @@ export interface IndexConfiguration {
  * before setting an index configuration. If IndexedDb is not enabled, any
  * index configuration is ignored.
  *
- * @internal
  * @param firestore - The {@link Firestore} instance to configure indexes for.
  * @param configuration -The index definition.
  * @throws FirestoreError if the JSON format is invalid.
@@ -118,6 +111,7 @@ export function setIndexConfiguration(
   firestore: Firestore,
   configuration: IndexConfiguration
 ): Promise<void>;
+
 /**
  * Configures indexing for local query execution. Any previous index
  * configuration is overridden. The `Promise` resolves once the index
@@ -137,7 +131,6 @@ export function setIndexConfiguration(
  * firestore:indexes`). If the JSON format is invalid, this method throws an
  * error.
  *
- * @internal
  * @param firestore - The {@link Firestore} instance to configure indexes for.
  * @param json -The JSON format exported by the Firebase CLI.
  * @throws FirestoreError if the JSON format is invalid.
@@ -148,6 +141,7 @@ export function setIndexConfiguration(
   firestore: Firestore,
   json: string
 ): Promise<void>;
+
 export function setIndexConfiguration(
   firestore: Firestore,
   jsonOrConfiguration: string | IndexConfiguration

packages/firestore/test/integration/api/index_configuration.test.ts

@@ -17,7 +17,7 @@
 
 import { expect } from 'chai';
 
-import { _setIndexConfiguration as setIndexConfiguration } from '../util/firebase_export';
+import { setIndexConfiguration } from '../util/firebase_export';
 import { apiDescribe, withTestDb } from '../util/helpers';
 
 apiDescribe('Index Configuration:', (persistence: boolean) => {