@firebase/firestore 3.4.13 → 3.4.14-canary.6f4ba2525

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,10 +2410,9 @@ export declare function increment(n: number): FieldValue;
 
 /**
  * The SDK definition of a Firestore index.
- *
- * @internal
+ * @beta
  */
-declare interface Index {
+export declare interface Index {
     /** The ID of the collection to index. */
     readonly collectionGroup: string;
     /** A list of fields to index. */
@@ -2423,10 +2425,9 @@ 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.
- *
- * @internal
+ * @beta
  */
-declare interface IndexConfiguration {
+export declare interface IndexConfiguration {
     /** A list of all Firestore indexes. */
     readonly indexes?: Index[];
     [key: string]: unknown;
@@ -2434,10 +2435,9 @@ declare interface IndexConfiguration {
 
 /**
  * A single field element in an index configuration.
- *
- * @internal
+ * @beta
  */
-declare interface IndexField {
+export declare interface IndexField {
     /** The field path to index. */
     readonly fieldPath: string;
     /**
@@ -4738,14 +4738,14 @@ export declare function setDoc<T>(reference: DocumentReference<T>, data: Partial
  * 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.
  * @returns A `Promise` that resolves once all indices are successfully
  * configured.
+ * @beta
  */
-export declare function _setIndexConfiguration(firestore: Firestore, configuration: IndexConfiguration): Promise<void>;
+export declare function setIndexConfiguration(firestore: Firestore, configuration: IndexConfiguration): Promise<void>;
 
 /**
  * Configures indexing for local query execution. Any previous index
@@ -4766,14 +4766,14 @@ export declare function _setIndexConfiguration(firestore: Firestore, configurati
  * 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.
  * @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 setIndexConfiguration(firestore: Firestore, json: string): Promise<void>;
 
 /**
  * Sets the verbosity of Cloud Firestore logs (debug, error, or silent).

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

@@ -14,12 +14,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { FieldIndex } from '../model/field_index';
 import { Firestore } from './database';
 export { connectFirestoreEmulator, EmulatorMockTokenOptions } from '../lite-api/database';
 /**
  * A single field element in an index configuration.
- *
- * @internal
+ * @beta
  */
 export interface IndexField {
     /** The field path to index. */
@@ -42,8 +42,7 @@ export interface IndexField {
 }
 /**
  * The SDK definition of a Firestore index.
- *
- * @internal
+ * @beta
  */
 export interface Index {
     /** The ID of the collection to index. */
@@ -57,8 +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.
- *
- * @internal
+ * @beta
  */
 export interface IndexConfiguration {
     /** A list of all Firestore indexes. */
@@ -80,12 +78,12 @@ 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.
  * @returns A `Promise` that resolves once all indices are successfully
  * configured.
+ * @beta
  */
 export declare function setIndexConfiguration(firestore: Firestore, configuration: IndexConfiguration): Promise<void>;
 /**
@@ -107,11 +105,12 @@ export declare function setIndexConfiguration(firestore: Firestore, configuratio
  * 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.
  * @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/firestore/src/api.d.ts

@@ -36,6 +36,7 @@ export { CACHE_SIZE_UNLIMITED } from './api/database';
 export { FirestoreErrorCode, FirestoreError } from './util/error';
 export { AbstractUserDataWriter } from './lite-api/user_data_writer';
 export { Primitive, NestedUpdateFields, ChildUpdateFields, AddPrefixToKeys, UnionToIntersection } from '../src/lite-api/types';
+export { setIndexConfiguration, Index, IndexConfiguration, IndexField } from './api/index_configuration';
 /**
  * Internal exports
  */
@@ -50,4 +51,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';

package/dist/lite/firestore/src/local/indexeddb_schema.d.ts

@@ -20,8 +20,6 @@ import { BundledQuery } from '../protos/firestore_bundle_proto';
 import { Document as ProtoDocument, DocumentsTarget as ProtoDocumentsTarget, QueryTarget as ProtoQueryTarget, Write as ProtoWrite } from '../protos/firestore_proto_api';
 import { EncodedResourcePath } from './encoded_resource_path';
 import { DbTimestampKey } from './indexeddb_sentinels';
-export declare const INDEXING_ENABLED = false;
-export declare const INDEXING_SCHEMA_VERSION = 15;
 /**
  * Schema Version for the Web client:
  * 1.  Initial version including Mutation Queue, Query Cache, and Remote
@@ -46,7 +44,7 @@ export declare const INDEXING_SCHEMA_VERSION = 15;
  * 14. Add overlays.
  * 15. Add indexing support.
  */
-export declare const SCHEMA_VERSION: number;
+export declare const SCHEMA_VERSION = 15;
 /**
  * Wrapper class to store timestamps (seconds and nanos) in IndexedDb objects.
  */

package/dist/lite/firestore/src/local/local_store_impl.d.ts

@@ -23,6 +23,7 @@ import { BatchId, TargetId } from '../core/types';
 import { DocumentKeySet, DocumentMap } from '../model/collections';
 import { Document } from '../model/document';
 import { DocumentKey } from '../model/document_key';
+import { FieldIndex } from '../model/field_index';
 import { Mutation } from '../model/mutation';
 import { MutationBatch, MutationBatchResult } from '../model/mutation_batch';
 import { BundleMetadata, NamedQuery as ProtoNamedQuery } from '../protos/firestore_bundle_proto';
@@ -192,3 +193,4 @@ export declare function localStoreGetNamedQuery(localStore: LocalStore, queryNam
  * Saves the given `NamedQuery` to local persistence.
  */
 export declare function localStoreSaveNamedQuery(localStore: LocalStore, query: ProtoNamedQuery, documents?: DocumentKeySet): Promise<void>;
+export declare function localStoreConfigureFieldIndexes(localStore: LocalStore, newFieldIndexes: FieldIndex[]): Promise<void>;

package/dist/lite/firestore/src/util/array.d.ts

@@ -28,3 +28,21 @@ export declare function some<T>(array: T[], predicate: (t: T) => boolean): boole
  * predicate does not return true for any item, null is returned.
  */
 export declare function findIndex<A>(array: A[], predicate: (value: A) => boolean): number | null;
+/**
+ * Compares two array for equality using comparator. The method computes the
+ * intersection and invokes `onAdd` for every element that is in `after` but not
+ * `before`. `onRemove` is invoked for every element in `before` but missing
+ * from `after`.
+ *
+ * The method creates a copy of both `before` and `after` and runs in O(n log
+ * n), where n is the size of the two lists.
+ *
+ * @param before - The elements that exist in the original array.
+ * @param after - The elements to diff against the original array.
+ * @param comparator - The comparator for the elements in before and after.
+ * @param onAdd - A function to invoke for every element that is part of `
+ * after` but not `before`.
+ * @param onRemove - A function to invoke for every element that is part of
+ * `before` but not `after`.
+ */
+export declare function diffArrays<T>(before: T[], after: T[], comparator: (l: T, r: T) => number, onAdd: (entry: T) => void, onRemove: (entry: T) => void): void;

package/dist/lite/firestore/test/unit/local/counting_query_engine.d.ts

@@ -50,9 +50,20 @@ export declare class CountingQueryEngine extends QueryEngine {
      * and `getEntries()` APIs (since the last call to `resetCounts()`)
      */
     documentsReadByKey: number;
+    /**
+     * The number of documents returned by the OverlayCache's `getOverlays()`
+     * API (since the last call to `resetCounts()`)
+     */
+    overlaysReadByCollection: number;
+    /**
+     * The number of documents returned by the OverlayCache's `getOverlay()`
+     * APIs (since the last call to `resetCounts()`)
+     */
+    overlaysReadByKey: number;
     resetCounts(): void;
     getDocumentsMatchingQuery(transaction: PersistenceTransaction, query: Query, lastLimboFreeSnapshotVersion: SnapshotVersion, remoteKeys: DocumentKeySet): PersistencePromise<DocumentMap>;
     initialize(localDocuments: LocalDocumentsView, indexManager: IndexManager): void;
     private wrapRemoteDocumentCache;
     private wrapMutationQueue;
+    private wrapDocumentOverlayCache;
 }

package/dist/lite/firestore/test/unit/local/local_store_indexeddb.test.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};

package/dist/lite/firestore/test/unit/specs/index_spec.test.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};

package/dist/lite/firestore/test/unit/specs/spec_builder.d.ts

@@ -14,12 +14,14 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { IndexConfiguration } from '../../../src/api/index_configuration';
 import { Query } from '../../../src/core/query';
 import { Target } from '../../../src/core/target';
 import { TargetIdGenerator } from '../../../src/core/target_id_generator';
 import { TargetId } from '../../../src/core/types';
 import { Document } from '../../../src/model/document';
 import { DocumentKey } from '../../../src/model/document_key';
+import { FieldIndex } from '../../../src/model/field_index';
 import { JsonObject } from '../../../src/model/object_value';
 import { TimerId } from '../../../src/util/async_queue';
 import { Code } from '../../../src/util/error';
@@ -113,6 +115,7 @@ export declare class SpecBuilder {
     userAddsSnapshotsInSyncListener(): this;
     userRemovesSnapshotsInSyncListener(): this;
     loadBundle(bundleContent: string): this;
+    setIndexConfiguration(jsonOrConfiguration: string | IndexConfiguration): this;
     becomeHidden(): this;
     becomeVisible(): this;
     runTimer(timerId: TimerId): this;
@@ -130,6 +133,8 @@ export declare class SpecBuilder {
     /** Stops failing database operations. */
     recoverDatabase(): this;
     expectIsShutdown(): this;
+    /** Expects indexes to exist (in any order) */
+    expectIndexes(indexes: FieldIndex[]): this;
     /** Overrides the currently expected set of active targets. */
     expectActiveTargets(...targets: Array<{
         query: Query;

package/dist/lite/firestore/test/unit/specs/spec_test_runner.d.ts

@@ -14,8 +14,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { IndexConfiguration } from '../../../src/api/index_configuration';
 import { Query } from '../../../src/core/query';
 import { TargetId } from '../../../src/core/types';
+import { FieldIndex } from '../../../src/model/field_index';
 import { JsonObject } from '../../../src/model/object_value';
 import { TestSnapshotVersion } from '../../util/helpers';
 import { ActiveTargetMap } from './spec_builder';
@@ -95,6 +97,10 @@ export interface SpecStep {
     waitForPendingWrites?: true;
     /** Fails the listed database actions. */
     failDatabase?: false | PersistenceAction[];
+    /**
+     * Set Index Configuration
+     */
+    setIndexConfiguration?: string | IndexConfiguration;
     /**
      * Run a queued timer task (without waiting for the delay to expire). See
      * TimerId enum definition for possible values).
@@ -306,5 +312,7 @@ export interface StateExpectation {
         acknowledgedDocs: string[];
         rejectedDocs: string[];
     };
+    /** Indexes */
+    indexes?: FieldIndex[];
 }
 export {};

package/dist/lite/firestore/test/unit/util/array.test.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};