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

package/dist/lite/internal.d.ts

@@ -140,6 +140,8 @@ declare interface AsyncQueue {
     verifyOperationInProgress(): void;
 }
 
+declare type AuthTokenFactory = () => string;
+
 /**
  * Path represents an ordered sequence of string segments.
  */
@@ -1460,6 +1462,7 @@ declare interface FirstPartyCredentialsSettings {
     ['client']: unknown;
     ['sessionIndex']: string;
     ['iamToken']: string | null;
+    ['authTokenFactory']: AuthTokenFactory | null;
 }
 
 /**

package/dist/lite/packages/firestore/dist/lite/index.browser.esm2017.d.ts

@@ -978,18 +978,18 @@ import { FirebaseError as c } from "@firebase/util/dist/src/errors";
     constructor(t: any, e: any, n: any);
     databaseId: any;
     ignoreUndefinedProperties: any;
-    q: any;
-    /** Creates a new top-level parse context. */ ht(t: any, e: any, n: any, r?: boolean): $n;
+    C: any;
+    /** Creates a new top-level parse context. */ dt(t: any, e: any, n: any, r?: boolean): $n;
 }
 declare class Ln extends An {
     constructor(t: any, e: any);
-    lt: any;
+    wt: any;
     _toFieldTransform(t: any): Ae;
     isEqual(t: any): boolean;
 }
 declare class Cn extends An {
     constructor(t: any, e: any);
-    lt: any;
+    wt: any;
     _toFieldTransform(t: any): Ae;
     isEqual(t: any): boolean;
 }
@@ -1000,27 +1000,27 @@ declare class qn extends An {
 declare class pr extends sr {
     constructor(t: any, e: any, n: any);
     type: any;
-    bt: any;
-    Et: any;
+    It: any;
+    At: any;
     _apply(t: any): mn;
 }
 declare class Mn extends An {
     constructor(t: any, e: any);
-    ft: any;
+    yt: any;
     _toFieldTransform(t: any): Ae;
     isEqual(t: any): boolean;
 }
 declare class hr extends sr {
     constructor(t: any, e: any, n: any);
     type: any;
-    gt: any;
-    vt: any;
+    Et: any;
+    Tt: any;
     _apply(t: any): mn;
 }
 declare class cr extends sr {
     constructor(t: any, e: any);
-    dt: any;
     _t: any;
+    bt: any;
     type: string;
     _apply(t: any): mn;
 }
@@ -1031,15 +1031,15 @@ declare class kn extends An {
 declare class dr extends sr {
     constructor(t: any, e: any, n: any);
     type: any;
-    bt: any;
-    Et: any;
+    It: any;
+    At: any;
     _apply(t: any): mn;
 }
 declare class or extends sr {
     constructor(t: any, e: any, n: any);
-    dt: any;
-    wt: any;
-    yt: any;
+    _t: any;
+    gt: any;
+    vt: any;
     type: string;
     _apply(t: any): mn;
 }
@@ -1105,20 +1105,20 @@ declare class J {
     constructor(t: any, e: any, n: any, r: any, s: any, i: any);
     settings: any;
     databaseId: any;
-    q: any;
+    C: any;
     ignoreUndefinedProperties: any;
     fieldTransforms: any;
     fieldMask: any;
     get path(): any;
-    get tt(): any;
-    /** Returns a new context with the specified settings overwritten. */ et(t: any): $n;
-    nt(t: any): $n;
+    get rt(): any;
+    /** Returns a new context with the specified settings overwritten. */ st(t: any): $n;
     it(t: any): $n;
-    ot(t: any): $n;
-    ut(t: any): L;
+    ct(t: any): $n;
+    at(t: any): $n;
+    ht(t: any): L;
     /** Returns 'true' if 'fieldPath' was traversed when creating this context. */ contains(t: any): boolean;
-    Z(): void;
-    st(t: any): void;
+    nt(): void;
+    ut(t: any): void;
 }
 /**
  * @license

package/dist/lite/packages/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/packages/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/lite/private.d.ts

@@ -123,6 +123,8 @@ declare interface AsyncQueue {
     verifyOperationInProgress(): void;
 }
 
+declare type AuthTokenFactory = () => string;
+
 /**
  * Path represents an ordered sequence of string segments.
  */
@@ -1337,6 +1339,7 @@ declare interface FirstPartyCredentialsSettings {
     ['client']: unknown;
     ['sessionIndex']: string;
     ['iamToken']: string | null;
+    ['authTokenFactory']: AuthTokenFactory | null;
 }
 
 /**

package/dist/packages/firestore/dist/index.esm2017.d.ts

@@ -1420,16 +1420,16 @@ declare function Tl(t: any, e: any, n: any, ...s: any[]): Promise<any>;
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */ declare class Ma {
-    Mc: Promise<void>;
-    Oc: any[];
-    Fc: boolean;
-    $c: any[];
-    Bc: any;
+    $c: Promise<void>;
+    Bc: any[];
     Lc: boolean;
-    Uc: boolean;
-    qc: any[];
-    So: ru;
-    Kc: () => void;
+    Uc: any[];
+    qc: any;
+    Kc: boolean;
+    Gc: boolean;
+    Qc: any[];
+    xo: ru;
+    jc: () => void;
     get isShuttingDown(): boolean;
     /**
      * Adds a new operation to the queue without waiting for it to complete (i.e.
@@ -1442,30 +1442,30 @@ declare function Tl(t: any, e: any, n: any, ...s: any[]): Promise<any>;
     /**
      * Runs the next operation from the retryable queue. If the operation fails,
      * reschedules with backoff.
-     */ jc(): Promise<void>;
-    Qc(t: any): Promise<any>;
+     */ Hc(): Promise<void>;
+    zc(t: any): Promise<any>;
     enqueueAfterDelay(t: any, e: any, n: any): Lu;
-    Gc(): void;
+    Wc(): void;
     verifyOperationInProgress(): void;
     /**
      * Waits until all currently queued tasks are finished executing. Delayed
      * operations are not run.
-     */ zc(): Promise<void>;
+     */ Yc(): Promise<void>;
     /**
      * For Tests: Determine if a delayed operation with a particular TimerId
      * exists.
-     */ Hc(t: any): boolean;
+     */ Xc(t: any): boolean;
     /**
      * For Tests: Runs some or all delayed operations early.
      *
      * @param lastTimerId - Delayed operations up to and including this TimerId
      * will be drained. Pass TimerId.All to run all delayed operations.
      * @returns a Promise that resolves once all operations have been run.
-     */ Jc(t: any): Promise<void>;
+     */ Zc(t: any): Promise<void>;
     /**
      * For Tests: Skip all subsequent delays for a timer id.
-     */ Yc(t: any): void;
-    /** Called once a DelayedOperation is run or canceled. */ Wc(t: any): void;
+     */ ta(t: any): void;
+    /** Called once a DelayedOperation is run or canceled. */ Jc(t: any): void;
 }
 import { FirebaseError as c } from "@firebase/util/dist/src/errors";
 /**
@@ -1495,8 +1495,8 @@ import { FirebaseError as c } from "@firebase/util/dist/src/errors";
     constructor(t: any, e: any, n: any);
     databaseId: any;
     ignoreUndefinedProperties: any;
-    wt: any;
-    /** Creates a new top-level parse context. */ aa(t: any, e: any, n: any, s?: boolean): hh;
+    It: any;
+    /** Creates a new top-level parse context. */ fa(t: any, e: any, n: any, s?: boolean): hh;
 }
 declare class Z {
     constructor(t: any);
@@ -1546,13 +1546,13 @@ declare class at {
 }
 declare class yh extends ih {
     constructor(t: any, e: any);
-    ha: any;
+    da: any;
     _toFieldTransform(t: any): Fn;
     isEqual(t: any): boolean;
 }
 declare class gh extends ih {
     constructor(t: any, e: any);
-    ha: any;
+    da: any;
     _toFieldTransform(t: any): Fn;
     isEqual(t: any): boolean;
 }
@@ -1563,27 +1563,27 @@ declare class _h extends ih {
 declare class tl extends qh {
     constructor(t: any, e: any, n: any);
     type: any;
-    ya: any;
-    pa: any;
+    Ta: any;
+    Ea: any;
     _apply(t: any): Va;
 }
 declare class ph extends ih {
     constructor(t: any, e: any);
-    la: any;
+    _a: any;
     _toFieldTransform(t: any): Fn;
     isEqual(t: any): boolean;
 }
 declare class zh extends qh {
     constructor(t: any, e: any, n: any);
     type: any;
-    ma: any;
-    ga: any;
+    pa: any;
+    Ia: any;
     _apply(t: any): Va;
 }
 declare class jh extends qh {
     constructor(t: any, e: any);
-    fa: any;
     wa: any;
+    ya: any;
     type: string;
     _apply(t: any): Va;
 }
@@ -1594,15 +1594,15 @@ declare class mh extends ih {
 declare class Yh extends qh {
     constructor(t: any, e: any, n: any);
     type: any;
-    ya: any;
-    pa: any;
+    Ta: any;
+    Ea: any;
     _apply(t: any): Va;
 }
 declare class Gh extends qh {
     constructor(t: any, e: any, n: any);
-    fa: any;
-    da: any;
-    _a: any;
+    wa: any;
+    ma: any;
+    ga: any;
     type: string;
     _apply(t: any): Va;
 }
@@ -1653,15 +1653,15 @@ declare class Ra {
  */
 declare class ru {
     constructor(t: any, e: any, n?: number, s?: number, i?: number);
-    js: any;
+    Hs: any;
     timerId: any;
-    lo: number;
-    fo: number;
-    _o: number;
     wo: number;
-    mo: any;
-    /** The last backoff attempt, as epoch milliseconds. */
+    mo: number;
     yo: number;
+    po: number;
+    Io: any;
+    /** The last backoff attempt, as epoch milliseconds. */
+    To: number;
     /**
      * Resets the backoff delay.
      *
@@ -1672,15 +1672,15 @@ declare class ru {
     /**
      * Resets the backoff delay to the maximum delay (e.g. for use after a
      * RESOURCE_EXHAUSTED error).
-     */ po(): void;
+     */ Eo(): void;
     /**
      * Returns a promise that resolves after currentDelayMs, and increases the
      * delay for any subsequent attempts. If there was a pending backoff operation
      * already, it will be canceled.
-     */ Io(t: any): void;
-    Eo(): void;
+     */ Ao(t: any): void;
+    bo(): void;
     cancel(): void;
-    /** Returns a random value in the range [-currentBaseMs/2, currentBaseMs/2] */ To(): number;
+    /** Returns a random value in the range [-currentBaseMs/2, currentBaseMs/2] */ Ro(): number;
 }
 /**
  * @license
@@ -1773,20 +1773,20 @@ declare class Lu {
     constructor(t: any, e: any, n: any, s: any, i: any, r: any);
     settings: any;
     databaseId: any;
-    wt: any;
+    It: any;
     ignoreUndefinedProperties: any;
     fieldTransforms: any;
     fieldMask: any;
     get path(): any;
-    get Zc(): any;
-    /** Returns a new context with the specified settings overwritten. */ ta(t: any): hh;
-    ea(t: any): hh;
+    get na(): any;
+    /** Returns a new context with the specified settings overwritten. */ sa(t: any): hh;
     ia(t: any): hh;
-    ra(t: any): hh;
-    oa(t: any): Q;
+    ua(t: any): hh;
+    ca(t: any): hh;
+    aa(t: any): Q;
     /** Returns 'true' if 'fieldPath' was traversed when creating this context. */ contains(t: any): boolean;
-    Xc(): void;
-    sa(t: any): void;
+    ea(): void;
+    oa(t: any): void;
 }
 /**
  * @license

package/dist/packages/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/packages/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/private.d.ts

@@ -121,6 +121,8 @@ declare interface AsyncQueue {
     verifyOperationInProgress(): void;
 }
 
+declare type AuthTokenFactory = () => string;
+
 /**
  * Path represents an ordered sequence of string segments.
  */
@@ -2065,6 +2067,7 @@ declare interface FirstPartyCredentialsSettings {
     ['client']: unknown;
     ['sessionIndex']: string;
     ['iamToken']: string | null;
+    ['authTokenFactory']: AuthTokenFactory | null;
 }
 
 /**
@@ -2237,51 +2240,11 @@ export declare function getFirestore(app?: FirebaseApp): Firestore;
  */
 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;
-}
+/* Excluded from this release type: Index */
 
-/**
- * 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;
-}
+/* Excluded from this release type: IndexConfiguration */
 
-/**
- * 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;
-}
+/* Excluded from this release type: IndexField */
 
 declare type IndexFieldMode = 'MODE_UNSPECIFIED' | 'ASCENDING' | 'DESCENDING';
 
@@ -4525,55 +4488,7 @@ export declare function setDoc<T>(reference: DocumentReference<T>, data: WithFie
  */
 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).