@firebase/firestore 3.4.14-canary.a80e29cbb → 3.4.14-canary.fcd4b8ac3

package/dist/firestore/src/api/credentials.d.ts

@@ -19,11 +19,13 @@ import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
 import { Provider } from '@firebase/component';
 import { User } from '../auth/user';
 import { AsyncQueue } from '../util/async_queue';
+export declare type AuthTokenFactory = () => string;
 export interface FirstPartyCredentialsSettings {
     ['type']: 'gapi';
     ['client']: unknown;
     ['sessionIndex']: string;
     ['iamToken']: string | null;
+    ['authTokenFactory']: AuthTokenFactory | null;
 }
 export interface ProviderCredentialsSettings {
     ['type']: 'provider';
@@ -146,16 +148,24 @@ interface Gapi {
     };
 }
 export declare class FirstPartyToken implements Token {
+    private readonly gapi;
+    private readonly sessionIndex;
+    private readonly iamToken;
+    private readonly authTokenFactory;
     type: TokenType;
     user: User;
-    headers: Map<any, any>;
-    constructor(gapi: Gapi, sessionIndex: string, iamToken: string | null);
+    private _headers;
+    constructor(gapi: Gapi | null, sessionIndex: string, iamToken: string | null, authTokenFactory: AuthTokenFactory | null);
+    /** Gets an authorization token, using a provided factory function, or falling back to First Party GAPI. */
+    private getAuthToken;
+    get headers(): Map<string, string>;
 }
 export declare class FirstPartyAuthCredentialsProvider implements CredentialsProvider<User> {
     private gapi;
     private sessionIndex;
     private iamToken;
-    constructor(gapi: Gapi, sessionIndex: string, iamToken: string | null);
+    private authTokenFactory;
+    constructor(gapi: Gapi | null, sessionIndex: string, iamToken: string | null, authTokenFactory: AuthTokenFactory | null);
     getToken(): Promise<Token | null>;
     start(asyncQueue: AsyncQueue, changeListener: CredentialChangeListener<User>): void;
     shutdown(): void;

package/dist/firestore/src/api/index_configuration.d.ts

@@ -19,6 +19,7 @@ import { Firestore } from './database';
 export { connectFirestoreEmulator, EmulatorMockTokenOptions } from '../lite-api/database';
 /**
  * A single field element in an index configuration.
+ * @beta
  */
 export interface IndexField {
     /** The field path to index. */
@@ -41,6 +42,7 @@ export interface IndexField {
 }
 /**
  * The SDK definition of a Firestore index.
+ * @beta
  */
 export interface Index {
     /** The ID of the collection to index. */
@@ -54,6 +56,7 @@ 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.
+ * @beta
  */
 export interface IndexConfiguration {
     /** A list of all Firestore indexes. */
@@ -80,6 +83,7 @@ export interface IndexConfiguration {
  * @throws FirestoreError if the JSON format is invalid.
  * @returns A `Promise` that resolves once all indices are successfully
  * configured.
+ * @beta
  */
 export declare function setIndexConfiguration(firestore: Firestore, configuration: IndexConfiguration): Promise<void>;
 /**
@@ -106,6 +110,7 @@ export declare function setIndexConfiguration(firestore: Firestore, configuratio
  * @throws FirestoreError if the JSON format is invalid.
  * @returns A `Promise` that resolves once all indices are successfully
  * configured.
+ * @beta
  */
 export declare function setIndexConfiguration(firestore: Firestore, json: string): Promise<void>;
 export declare function parseIndexes(jsonOrConfiguration: string | IndexConfiguration): FieldIndex[];

package/dist/index.d.ts

@@ -929,49 +929,6 @@ export declare function getFirestore(app?: FirebaseApp): Firestore;
  * `updateDoc()`
  */
 export declare function increment(n: number): FieldValue;
-/**
- * The SDK definition of a Firestore index.
- */
-export declare interface Index {
-    /** The ID of the collection to index. */
-    readonly collectionGroup: string;
-    /** A list of fields to index. */
-    readonly fields?: IndexField[];
-    [key: string]: unknown;
-}
-/**
- * A list of Firestore indexes to speed up local query execution.
- *
- * See {@link https://firebase.google.com/docs/reference/firestore/indexes/#json_format | JSON Format}
- * for a description of the format of the index definition.
- */
-export declare interface IndexConfiguration {
-    /** A list of all Firestore indexes. */
-    readonly indexes?: Index[];
-    [key: string]: unknown;
-}
-/**
- * A single field element in an index configuration.
- */
-export declare interface IndexField {
-    /** The field path to index. */
-    readonly fieldPath: string;
-    /**
-     * What type of array index to create. Set to `CONTAINS` for `array-contains`
-     * and `array-contains-any` indexes.
-     *
-     * Only one of `arrayConfig` or `order` should be set;
-     */
-    readonly arrayConfig?: 'CONTAINS';
-    /**
-     * What type of array index to create. Set to `ASCENDING` or 'DESCENDING` for
-     * `==`, `!=`, `<=`, `<=`, `in` and `not-in` filters.
-     *
-     * Only one of `arrayConfig` or `order` should be set.
-     */
-    readonly order?: 'ASCENDING' | 'DESCENDING';
-    [key: string]: unknown;
-}
 /**
  * Initializes a new instance of {@link Firestore} with the provided settings.
  * Can only be called before any other function, including
@@ -1514,54 +1471,7 @@ export declare function setDoc<T>(reference: DocumentReference<T>, data: WithFie
  * to the backend (note that it won't resolve while you're offline).
  */
 export declare function setDoc<T>(reference: DocumentReference<T>, data: PartialWithFieldValue<T>, options: SetOptions): Promise<void>;
-/**
- * Configures indexing for local query execution. Any previous index
- * configuration is overridden. The `Promise` resolves once the index
- * configuration has been persisted.
- *
- * The index entries themselves are created asynchronously. You can continue to
- * use queries that require indexing even if the indices are not yet available.
- * Query execution will automatically start using the index once the index
- * entries have been written.
- *
- * Indexes are only supported with IndexedDb persistence. Invoke either
- * `enableIndexedDbPersistence()` or `enableMultiTabIndexedDbPersistence()`
- * before setting an index configuration. If IndexedDb is not enabled, any
- * index configuration is ignored.
- *
- * @param firestore - The {@link Firestore} instance to configure indexes for.
- * @param configuration -The index definition.
- * @throws FirestoreError if the JSON format is invalid.
- * @returns A `Promise` that resolves once all indices are successfully
- * configured.
- */
-export declare 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
- * configuration has been persisted.
- *
- * The index entries themselves are created asynchronously. You can continue to
- * use queries that require indexing even if the indices are not yet available.
- * Query execution will automatically start using the index once the index
- * entries have been written.
- *
- * Indexes are only supported with IndexedDb persistence. Invoke either
- * `enableIndexedDbPersistence()` or `enableMultiTabIndexedDbPersistence()`
- * before setting an index configuration. If IndexedDb is not enabled, any
- * index configuration is ignored.
- *
- * The method accepts the JSON format exported by the Firebase CLI (`firebase
- * firestore:indexes`). If the JSON format is invalid, this method throws an
- * error.
- *
- * @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.
- * @returns A `Promise` that resolves once all indices are successfully
- * configured.
- */
-export declare function setIndexConfiguration(firestore: Firestore, json: string): Promise<void>;
+/* Excluded from this release type: setIndexConfiguration */
 /**
  * Sets the verbosity of Cloud Firestore logs (debug, error, or silent).
  *