@firebase/firestore 3.4.13 → 3.4.14-canary.04dcdbb0f

package/dist/lite/packages/firestore/test/integration/util/firebase_export.d.ts

@@ -17,6 +17,7 @@
 import { FirebaseApp } from '@firebase/app';
 import { Firestore } from '../../../src';
 import { PrivateSettings } from '../../../src/lite-api/settings';
-export declare function newTestFirestore(projectId: string, nameOrApp?: string | FirebaseApp, settings?: PrivateSettings): Firestore;
+export declare function newTestApp(projectId: string, appName?: string): FirebaseApp;
+export declare function newTestFirestore(app: FirebaseApp, settings?: PrivateSettings, dbName?: string): Firestore;
 export * from '../../../src';
 export { PrivateSettings };

package/dist/lite/packages/firestore/test/integration/util/helpers.d.ts

@@ -37,6 +37,7 @@ export declare function withTestDb(persistence: boolean, fn: (db: Firestore) =>
 export declare function withAlternateTestDb(persistence: boolean, fn: (db: Firestore) => Promise<void>): Promise<void>;
 export declare function withTestDbs(persistence: boolean, numDbs: number, fn: (db: Firestore[]) => Promise<void>): Promise<void>;
 export declare function withTestDbsSettings(persistence: boolean, projectId: string, settings: PrivateSettings, numDbs: number, fn: (db: Firestore[]) => Promise<void>): Promise<void>;
+export declare function withNamedTestDbsOrSkipUnlessUsingEmulator(persistence: boolean, dbNames: string[], fn: (db: Firestore[]) => Promise<void>): Promise<void>;
 export declare function withTestDoc(persistence: boolean, fn: (doc: DocumentReference, db: Firestore) => Promise<void>): Promise<void>;
 export declare function withTestDocAndSettings(persistence: boolean, settings: PrivateSettings, fn: (doc: DocumentReference) => Promise<void>): Promise<void>;
 export declare function withTestDocAndInitialData(persistence: boolean, initialData: DocumentData | null, fn: (doc: DocumentReference, db: Firestore) => Promise<void>): Promise<void>;

package/dist/lite/packages/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/packages/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/packages/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/packages/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/packages/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/packages/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 {};

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.
  */
@@ -854,18 +856,18 @@ declare abstract class Filter {
 export declare class Firestore implements FirestoreService {
     _authCredentials: CredentialsProvider<User>;
     _appCheckCredentials: CredentialsProvider<string>;
+    readonly _databaseId: DatabaseId;
+    readonly _app?: FirebaseApp | undefined;
     /**
      * Whether it's a Firestore or Firestore Lite instance.
      */
     type: 'firestore-lite' | 'firestore';
-    readonly _databaseId: DatabaseId;
     readonly _persistenceKey: string;
     private _settings;
     private _settingsFrozen;
     private _terminateTask?;
-    _app?: FirebaseApp;
     /** @hideconstructor */
-    constructor(databaseIdOrApp: DatabaseId | FirebaseApp, _authCredentials: CredentialsProvider<User>, _appCheckCredentials: CredentialsProvider<string>);
+    constructor(_authCredentials: CredentialsProvider<User>, _appCheckCredentials: CredentialsProvider<string>, _databaseId: DatabaseId, _app?: FirebaseApp | undefined);
     /**
      * The {@link @firebase/app#FirebaseApp} associated with this `Firestore` service
      * instance.
@@ -1337,6 +1339,7 @@ declare interface FirstPartyCredentialsSettings {
     ['client']: unknown;
     ['sessionIndex']: string;
     ['iamToken']: string | null;
+    ['authTokenFactory']: AuthTokenFactory | null;
 }
 
 /**
@@ -1429,15 +1432,28 @@ export declare function getDoc<T>(reference: DocumentReference<T>): Promise<Docu
 export declare function getDocs<T>(query: Query<T>): Promise<QuerySnapshot<T>>;
 
 /**
- * Returns the existing `Firestore` instance that is associated with the
+ * Returns the existing default {@link Firestore} instance that is associated with the
+ * default {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
+ * instance with default settings.
+ *
+ * @returns The {@link Firestore} instance of the provided app.
+ */
+export declare function getFirestore(): Firestore;
+
+/**
+ * Returns the existing default {@link Firestore} instance that is associated with the
  * provided {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
  * instance with default settings.
  *
- * @param app - The {@link @firebase/app#FirebaseApp} instance that the returned `Firestore`
+ * @param app - The {@link @firebase/app#FirebaseApp} instance that the returned {@link Firestore}
  * instance is associated with.
- * @returns The `Firestore` instance of the provided app.
+ * @returns The {@link Firestore} instance of the provided app.
  */
-export declare function getFirestore(app?: FirebaseApp): Firestore;
+export declare function getFirestore(app: FirebaseApp): Firestore;
+
+/* Excluded declaration from this release type: getFirestore */
+
+/* Excluded declaration from this release type: getFirestore */
 
 /**
  * Returns a special value that can be used with {@link @firebase/firestore/lite#(setDoc:1)} or {@link
@@ -1477,6 +1493,8 @@ declare type IndexState = 'STATE_UNSPECIFIED' | 'CREATING' | 'READY' | 'ERROR';
  */
 export declare function initializeFirestore(app: FirebaseApp, settings: Settings): Firestore;
 
+/* Excluded declaration from this release type: initializeFirestore */
+
 /**
  * Creates a {@link QueryConstraint} that only returns the first matching documents.
  *