Expose IndexConfiguration types

Author: tom-andersen

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,7 +143,12 @@ export {
   UnionToIntersection
 } from '../src/lite-api/types';
 
-export { setIndexConfiguration } from './api/index_configuration';
+export {
+  setIndexConfiguration,
+  Index,
+  IndexConfiguration,
+  IndexField
+} from './api/index_configuration';
 
 /**
  * Internal exports

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. */