@firebase/firestore 4.1.0-canary.86f148c40 → 4.1.0-canary.9f90a07ac

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

@@ -57,4 +57,5 @@ export { logWarn as _logWarn } from './util/log';
 export type { AuthTokenFactory, FirstPartyCredentialsSettings } from './api/credentials';
 export { EmptyAuthCredentialsProvider as _EmptyAuthCredentialsProvider } from './api/credentials';
 export { EmptyAppCheckTokenProvider as _EmptyAppCheckTokenProvider } from './api/credentials';
-export { TestingHooks as _TestingHooks } from './util/testing_hooks';
+export { ExistenceFilterMismatchCallback as _TestingHooksExistenceFilterMismatchCallback, TestingHooks as _TestingHooks } from './util/testing_hooks';
+export { ExistenceFilterMismatchInfo as _TestingHooksExistenceFilterMismatchInfo } from './util/testing_hooks_spi';

package/dist/firestore/src/global_index.d.ts

@@ -9084,75 +9084,9 @@ declare function cast<T>(obj: object, constructor: {
 declare function debugAssert(assertion: boolean, message: string): asserts assertion;
 
 /**
- * @license
- * Copyright 2023 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.
- */
-/**
- * Manages "testing hooks", hooks into the internals of the SDK to verify
- * internal state and events during integration tests. Do not use this class
- * except for testing purposes.
- *
- * There are two ways to retrieve the global singleton instance of this class:
- * 1. The `instance` property, which returns null if the global singleton
- *      instance has not been created. Use this property if the caller should
- *      "do nothing" if there are no testing hooks registered, such as when
- *      delivering an event to notify registered callbacks.
- * 2. The `getOrCreateInstance()` method, which creates the global singleton
- *      instance if it has not been created. Use this method if the instance is
- *      needed to, for example, register a callback.
- *
+ * Information about an existence filter mismatch.
  * @internal
  */
-declare class TestingHooks {
-    private readonly onExistenceFilterMismatchCallbacks;
-    private constructor();
-    /**
-     * Returns the singleton instance of this class, or null if it has not been
-     * initialized.
-     */
-    static get instance(): TestingHooks | null;
-    /**
-     * Returns the singleton instance of this class, creating it if is has never
-     * been created before.
-     */
-    static getOrCreateInstance(): TestingHooks;
-    /**
-     * Registers a callback to be notified when an existence filter mismatch
-     * occurs in the Watch listen stream.
-     *
-     * The relative order in which callbacks are notified is unspecified; do not
-     * rely on any particular ordering. If a given callback is registered multiple
-     * times then it will be notified multiple times, once per registration.
-     *
-     * @param callback the callback to invoke upon existence filter mismatch.
-     *
-     * @return a function that, when called, unregisters the given callback; only
-     * the first invocation of the returned function does anything; all subsequent
-     * invocations do nothing.
-     */
-    onExistenceFilterMismatch(callback: ExistenceFilterMismatchCallback): () => void;
-    /**
-     * Invokes all currently-registered `onExistenceFilterMismatch` callbacks.
-     * @param info Information about the existence filter mismatch.
-     */
-    notifyOnExistenceFilterMismatch(info: ExistenceFilterMismatchInfo): void;
-}
-/**
- * Information about an existence filter mismatch, as specified to callbacks
- * registered with `TestingUtils.onExistenceFilterMismatch()`.
- */
 interface ExistenceFilterMismatchInfo {
     /** The number of documents that matched the query in the local cache. */
     localCacheCount: number;
@@ -9196,12 +9130,59 @@ interface ExistenceFilterMismatchInfo {
          */
         mightContain?: (value: string) => boolean;
     };
+}
+
+/**
+ * @license
+ * Copyright 2023 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.
+ */
+
+/**
+ * Testing hooks for use by Firestore's integration test suite to reach into the
+ * SDK internals to validate logic and behavior that is not visible from the
+ * public API surface.
+ *
+ * @internal
+ */
+declare class TestingHooks {
+    private constructor();
+    /**
+     * Registers a callback to be notified when an existence filter mismatch
+     * occurs in the Watch listen stream.
+     *
+     * The relative order in which callbacks are notified is unspecified; do not
+     * rely on any particular ordering. If a given callback is registered multiple
+     * times then it will be notified multiple times, once per registration.
+     *
+     * @param callback the callback to invoke upon existence filter mismatch.
+     *
+     * @return a function that, when called, unregisters the given callback; only
+     * the first invocation of the returned function does anything; all subsequent
+     * invocations do nothing.
+     */
+    static onExistenceFilterMismatch(callback: ExistenceFilterMismatchCallback): Unsubscribe;
 }
 /**
  * The signature of callbacks registered with
  * `TestingUtils.onExistenceFilterMismatch()`.
+ *
+ * The return value, if any, is ignored.
+ *
+ * @internal
  */
-declare type ExistenceFilterMismatchCallback = (info: ExistenceFilterMismatchInfo) => void;
+declare type ExistenceFilterMismatchCallback = (info: ExistenceFilterMismatchInfo) => unknown;
 
 /**
  * Cloud Firestore
@@ -9215,4 +9196,4 @@ declare module '@firebase/component' {
     }
 }
 
-export { AbstractUserDataWriter, AddPrefixToKeys, AggregateField, AggregateFieldType, AggregateQuerySnapshot, AggregateSpec, AggregateSpecData, AggregateType, AuthTokenFactory, Bytes, CACHE_SIZE_UNLIMITED, ChildUpdateFields, CollectionReference, DocumentChange, DocumentChangeType, DocumentData, DocumentReference, DocumentSnapshot, EmulatorMockTokenOptions, ExperimentalLongPollingOptions, FieldPath, FieldValue, Firestore, FirestoreDataConverter, FirestoreError, FirestoreErrorCode, FirestoreLocalCache, FirestoreSettings, FirstPartyCredentialsSettings, GeoPoint, Index, IndexConfiguration, IndexField, LoadBundleTask, LoadBundleTaskProgress, LogLevelString as LogLevel, MemoryCacheSettings, MemoryEagerGarbageCollector, MemoryGarbageCollector, MemoryLocalCache, MemoryLruGarbageCollector, NestedUpdateFields, OrderByDirection, PartialWithFieldValue, PersistenceSettings, PersistentCacheSettings, PersistentLocalCache, PersistentMultipleTabManager, PersistentSingleTabManager, PersistentSingleTabManagerSettings, PersistentTabManager, Primitive, PrivateSettings, Query, QueryCompositeFilterConstraint, QueryConstraint, QueryConstraintType, QueryDocumentSnapshot, QueryEndAtConstraint, QueryFieldFilterConstraint, QueryFilterConstraint, QueryLimitConstraint, QueryNonFilterConstraint, QueryOrderByConstraint, QuerySnapshot, QueryStartAtConstraint, SetOptions, SnapshotListenOptions, SnapshotMetadata, SnapshotOptions, TaskState, Timestamp$1 as Timestamp, Transaction, TransactionOptions, UnionToIntersection, Unsubscribe, UpdateData, WhereFilterOp, WithFieldValue, WriteBatch, ByteString as _ByteString, DatabaseId as _DatabaseId, DocumentKey as _DocumentKey, EmptyAppCheckTokenProvider as _EmptyAppCheckTokenProvider, EmptyAuthCredentialsProvider as _EmptyAuthCredentialsProvider, FieldPath$1 as _FieldPath, ResourcePath as _ResourcePath, TestingHooks as _TestingHooks, cast as _cast, debugAssert as _debugAssert, isBase64Available as _isBase64Available, logWarn as _logWarn, validateIsNotUsedTogether as _validateIsNotUsedTogether, addDoc, aggregateFieldEqual, aggregateQuerySnapshotEqual, and, arrayRemove, arrayUnion, average, clearIndexedDbPersistence, collection, collectionGroup, connectFirestoreEmulator, count, deleteDoc, deleteField, disableNetwork, doc, documentId, enableIndexedDbPersistence, enableMultiTabIndexedDbPersistence, enableNetwork, endAt, endBefore, ensureFirestoreConfigured, executeWrite, getAggregateFromServer, getCountFromServer, getDoc, getDocFromCache, getDocFromServer, getDocs, getDocsFromCache, getDocsFromServer, getFirestore, increment, initializeFirestore, limit, limitToLast, loadBundle, memoryEagerGarbageCollector, memoryLocalCache, memoryLruGarbageCollector, namedQuery, onSnapshot, onSnapshotsInSync, or, orderBy, persistentLocalCache, persistentMultipleTabManager, persistentSingleTabManager, query, queryEqual, refEqual, runTransaction, serverTimestamp, setDoc, setIndexConfiguration, setLogLevel, snapshotEqual, startAfter, startAt, sum, terminate, updateDoc, waitForPendingWrites, where, writeBatch };
+export { AbstractUserDataWriter, AddPrefixToKeys, AggregateField, AggregateFieldType, AggregateQuerySnapshot, AggregateSpec, AggregateSpecData, AggregateType, AuthTokenFactory, Bytes, CACHE_SIZE_UNLIMITED, ChildUpdateFields, CollectionReference, DocumentChange, DocumentChangeType, DocumentData, DocumentReference, DocumentSnapshot, EmulatorMockTokenOptions, ExperimentalLongPollingOptions, FieldPath, FieldValue, Firestore, FirestoreDataConverter, FirestoreError, FirestoreErrorCode, FirestoreLocalCache, FirestoreSettings, FirstPartyCredentialsSettings, GeoPoint, Index, IndexConfiguration, IndexField, LoadBundleTask, LoadBundleTaskProgress, LogLevelString as LogLevel, MemoryCacheSettings, MemoryEagerGarbageCollector, MemoryGarbageCollector, MemoryLocalCache, MemoryLruGarbageCollector, NestedUpdateFields, OrderByDirection, PartialWithFieldValue, PersistenceSettings, PersistentCacheSettings, PersistentLocalCache, PersistentMultipleTabManager, PersistentSingleTabManager, PersistentSingleTabManagerSettings, PersistentTabManager, Primitive, PrivateSettings, Query, QueryCompositeFilterConstraint, QueryConstraint, QueryConstraintType, QueryDocumentSnapshot, QueryEndAtConstraint, QueryFieldFilterConstraint, QueryFilterConstraint, QueryLimitConstraint, QueryNonFilterConstraint, QueryOrderByConstraint, QuerySnapshot, QueryStartAtConstraint, SetOptions, SnapshotListenOptions, SnapshotMetadata, SnapshotOptions, TaskState, Timestamp$1 as Timestamp, Transaction, TransactionOptions, UnionToIntersection, Unsubscribe, UpdateData, WhereFilterOp, WithFieldValue, WriteBatch, ByteString as _ByteString, DatabaseId as _DatabaseId, DocumentKey as _DocumentKey, EmptyAppCheckTokenProvider as _EmptyAppCheckTokenProvider, EmptyAuthCredentialsProvider as _EmptyAuthCredentialsProvider, FieldPath$1 as _FieldPath, ResourcePath as _ResourcePath, TestingHooks as _TestingHooks, ExistenceFilterMismatchCallback as _TestingHooksExistenceFilterMismatchCallback, ExistenceFilterMismatchInfo as _TestingHooksExistenceFilterMismatchInfo, cast as _cast, debugAssert as _debugAssert, isBase64Available as _isBase64Available, logWarn as _logWarn, validateIsNotUsedTogether as _validateIsNotUsedTogether, addDoc, aggregateFieldEqual, aggregateQuerySnapshotEqual, and, arrayRemove, arrayUnion, average, clearIndexedDbPersistence, collection, collectionGroup, connectFirestoreEmulator, count, deleteDoc, deleteField, disableNetwork, doc, documentId, enableIndexedDbPersistence, enableMultiTabIndexedDbPersistence, enableNetwork, endAt, endBefore, ensureFirestoreConfigured, executeWrite, getAggregateFromServer, getCountFromServer, getDoc, getDocFromCache, getDocFromServer, getDocs, getDocsFromCache, getDocsFromServer, getFirestore, increment, initializeFirestore, limit, limitToLast, loadBundle, memoryEagerGarbageCollector, memoryLocalCache, memoryLruGarbageCollector, namedQuery, onSnapshot, onSnapshotsInSync, or, orderBy, persistentLocalCache, persistentMultipleTabManager, persistentSingleTabManager, query, queryEqual, refEqual, runTransaction, serverTimestamp, setDoc, setIndexConfiguration, setLogLevel, snapshotEqual, startAfter, startAt, sum, terminate, updateDoc, waitForPendingWrites, where, writeBatch };

package/dist/firestore/src/util/testing_hooks.d.ts

@@ -14,35 +14,17 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { Unsubscribe } from '../api/reference_impl';
+import { ExistenceFilterMismatchInfo } from './testing_hooks_spi';
 /**
- * Manages "testing hooks", hooks into the internals of the SDK to verify
- * internal state and events during integration tests. Do not use this class
- * except for testing purposes.
- *
- * There are two ways to retrieve the global singleton instance of this class:
- * 1. The `instance` property, which returns null if the global singleton
- *      instance has not been created. Use this property if the caller should
- *      "do nothing" if there are no testing hooks registered, such as when
- *      delivering an event to notify registered callbacks.
- * 2. The `getOrCreateInstance()` method, which creates the global singleton
- *      instance if it has not been created. Use this method if the instance is
- *      needed to, for example, register a callback.
+ * Testing hooks for use by Firestore's integration test suite to reach into the
+ * SDK internals to validate logic and behavior that is not visible from the
+ * public API surface.
  *
  * @internal
  */
 export declare class TestingHooks {
-    private readonly onExistenceFilterMismatchCallbacks;
     private constructor();
-    /**
-     * Returns the singleton instance of this class, or null if it has not been
-     * initialized.
-     */
-    static get instance(): TestingHooks | null;
-    /**
-     * Returns the singleton instance of this class, creating it if is has never
-     * been created before.
-     */
-    static getOrCreateInstance(): TestingHooks;
     /**
      * Registers a callback to be notified when an existence filter mismatch
      * occurs in the Watch listen stream.
@@ -57,63 +39,14 @@ export declare class TestingHooks {
      * the first invocation of the returned function does anything; all subsequent
      * invocations do nothing.
      */
-    onExistenceFilterMismatch(callback: ExistenceFilterMismatchCallback): () => void;
-    /**
-     * Invokes all currently-registered `onExistenceFilterMismatch` callbacks.
-     * @param info Information about the existence filter mismatch.
-     */
-    notifyOnExistenceFilterMismatch(info: ExistenceFilterMismatchInfo): void;
-}
-/**
- * Information about an existence filter mismatch, as specified to callbacks
- * registered with `TestingUtils.onExistenceFilterMismatch()`.
- */
-export interface ExistenceFilterMismatchInfo {
-    /** The number of documents that matched the query in the local cache. */
-    localCacheCount: number;
-    /**
-     * The number of documents that matched the query on the server, as specified
-     * in the ExistenceFilter message's `count` field.
-     */
-    existenceFilterCount: number;
-    /**
-     * The projectId used when checking documents for membership in the bloom
-     * filter.
-     */
-    projectId: string;
-    /**
-     * The databaseId used when checking documents for membership in the bloom
-     * filter.
-     */
-    databaseId: string;
-    /**
-     * Information about the bloom filter provided by Watch in the ExistenceFilter
-     * message's `unchangedNames` field. If this property is omitted or undefined
-     * then that means that Watch did _not_ provide a bloom filter.
-     */
-    bloomFilter?: {
-        /**
-         * Whether a full requery was averted by using the bloom filter. If false,
-         * then something happened, such as a false positive, to prevent using the
-         * bloom filter to avoid a full requery.
-         */
-        applied: boolean;
-        /** The number of hash functions used in the bloom filter. */
-        hashCount: number;
-        /** The number of bytes in the bloom filter's bitmask. */
-        bitmapLength: number;
-        /** The number of bits of padding in the last byte of the bloom filter. */
-        padding: number;
-        /**
-         * Tests the given string for membership in the bloom filter created from
-         * the existence filter; will be undefined if creating the bloom filter
-         * failed.
-         */
-        mightContain?: (value: string) => boolean;
-    };
+    static onExistenceFilterMismatch(callback: ExistenceFilterMismatchCallback): Unsubscribe;
 }
 /**
  * The signature of callbacks registered with
  * `TestingUtils.onExistenceFilterMismatch()`.
+ *
+ * The return value, if any, is ignored.
+ *
+ * @internal
  */
-export declare type ExistenceFilterMismatchCallback = (info: ExistenceFilterMismatchInfo) => void;
+export declare type ExistenceFilterMismatchCallback = (info: ExistenceFilterMismatchInfo) => unknown;

package/dist/firestore/src/util/testing_hooks_spi.d.ts

@@ -0,0 +1,93 @@
+/**
+ * @license
+ * Copyright 2023 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.
+ */
+/**
+ * The global, singleton instance of TestingHooksSpi.
+ *
+ * This variable will be `null` in all cases _except_ when running from
+ * integration tests that have registered callbacks to be notified of events
+ * that happen during the test execution.
+ */
+export declare let testingHooksSpi: TestingHooksSpi | null;
+/**
+ * Sets the value of the `testingHooksSpi` object.
+ * @param instance the instance to set.
+ */
+export declare function setTestingHooksSpi(instance: TestingHooksSpi): void;
+/**
+ * The "service provider interface" for the testing hooks.
+ *
+ * The implementation of this object will handle the callbacks made by the SDK
+ * to be handled by the integration tests.
+ *
+ * This "SPI" is separated from the implementation to avoid import cycles and
+ * to enable production builds to fully tree-shake away the testing hooks logic.
+ */
+export interface TestingHooksSpi {
+    /**
+     * Invokes all callbacks registered with
+     * `TestingHooks.onExistenceFilterMismatch()` with the given info.
+     */
+    notifyOnExistenceFilterMismatch(info: ExistenceFilterMismatchInfo): void;
+}
+/**
+ * Information about an existence filter mismatch.
+ * @internal
+ */
+export interface ExistenceFilterMismatchInfo {
+    /** The number of documents that matched the query in the local cache. */
+    localCacheCount: number;
+    /**
+     * The number of documents that matched the query on the server, as specified
+     * in the ExistenceFilter message's `count` field.
+     */
+    existenceFilterCount: number;
+    /**
+     * The projectId used when checking documents for membership in the bloom
+     * filter.
+     */
+    projectId: string;
+    /**
+     * The databaseId used when checking documents for membership in the bloom
+     * filter.
+     */
+    databaseId: string;
+    /**
+     * Information about the bloom filter provided by Watch in the ExistenceFilter
+     * message's `unchangedNames` field. If this property is omitted or undefined
+     * then that means that Watch did _not_ provide a bloom filter.
+     */
+    bloomFilter?: {
+        /**
+         * Whether a full requery was averted by using the bloom filter. If false,
+         * then something happened, such as a false positive, to prevent using the
+         * bloom filter to avoid a full requery.
+         */
+        applied: boolean;
+        /** The number of hash functions used in the bloom filter. */
+        hashCount: number;
+        /** The number of bytes in the bloom filter's bitmask. */
+        bitmapLength: number;
+        /** The number of bits of padding in the last byte of the bloom filter. */
+        padding: number;
+        /**
+         * Tests the given string for membership in the bloom filter created from
+         * the existence filter; will be undefined if creating the bloom filter
+         * failed.
+         */
+        mightContain?: (value: string) => boolean;
+    };
+}

package/dist/firestore/test/integration/util/testing_hooks_util.d.ts

@@ -28,8 +28,8 @@ export declare function captureExistenceFilterMismatches<T>(callback: () => Prom
  * Information about an existence filter mismatch, captured during an invocation
  * of `captureExistenceFilterMismatches()`.
  *
- * See the documentation of `TestingHooks.notifyOnExistenceFilterMismatch()`
- * for the meaning of these values.
+ * See the documentation of `ExistenceFilterMismatchInfo` in
+ * `testing_hooks_spi.ts` for the meaning of these values.
  */
 export interface ExistenceFilterMismatchInfo {
     localCacheCount: number;