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

package/dist/internal.d.ts

@@ -138,6 +138,8 @@ declare interface AsyncQueue {
     verifyOperationInProgress(): void;
 }
 
+declare type AuthTokenFactory = () => string;
+
 /**
  * Path represents an ordered sequence of string segments.
  */
@@ -2233,6 +2235,7 @@ declare interface FirstPartyCredentialsSettings {
     ['client']: unknown;
     ['sessionIndex']: string;
     ['iamToken']: string | null;
+    ['authTokenFactory']: AuthTokenFactory | null;
 }
 
 /**
@@ -2407,6 +2410,7 @@ export declare function increment(n: number): FieldValue;
 
 /**
  * The SDK definition of a Firestore index.
+ * @beta
  */
 export declare interface Index {
     /** The ID of the collection to index. */
@@ -2421,6 +2425,7 @@ export declare 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 declare interface IndexConfiguration {
     /** A list of all Firestore indexes. */
@@ -2430,6 +2435,7 @@ export declare interface IndexConfiguration {
 
 /**
  * A single field element in an index configuration.
+ * @beta
  */
 export declare interface IndexField {
     /** The field path to index. */
@@ -4737,6 +4743,7 @@ export declare function setDoc<T>(reference: DocumentReference<T>, data: Partial
  * @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>;
 
@@ -4764,6 +4771,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>;
 

package/dist/lite/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/lite/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[];