@firebase/firestore 3.5.0-canary.e35db6f95 → 3.5.0-canary.fdd4ab464

package/dist/firestore/lite/index.d.ts

@@ -6,6 +6,8 @@
  * directly to the backend, and `onSnapshot()` APIs are not supported.
  * @packageDocumentation
  */
+export { aggregateQuerySnapshotEqual, getCount } from '../src/lite-api/aggregate';
+export { AggregateField, AggregateFieldType, AggregateSpec, AggregateSpecData, AggregateQuerySnapshot } from '../src/lite-api/aggregate_types';
 export { FirestoreSettings as Settings } from '../src/lite-api/settings';
 export { Firestore as Firestore, EmulatorMockTokenOptions, initializeFirestore, getFirestore, terminate, connectFirestoreEmulator } from '../src/lite-api/database';
 export { DocumentData, UpdateData, WithFieldValue, PartialWithFieldValue, SetOptions, DocumentReference, Query, CollectionReference, collection, collectionGroup, doc, refEqual, queryEqual } from '../src/lite-api/reference';

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

@@ -15,14 +15,28 @@
  * limitations under the License.
  */
 import { Query } from '../api';
-import { AggregateField, AggregateQuerySnapshot } from '../lite-api/aggregate';
+import { AggregateField, AggregateQuerySnapshot } from '../lite-api/aggregate_types';
+export { aggregateQuerySnapshotEqual } from '../lite-api/aggregate';
 /**
- * Executes the query and returns the results as a `AggregateQuerySnapshot` from the
- * server. Returns an error if the network is not available.
+ * Calculates the number of documents in the result set of the given query,
+ * without actually downloading the documents.
  *
- * @param query - The `Query` to execute.
+ * Using this function to count the documents is efficient because only the
+ * final count, not the documents' data, is downloaded. This function can even
+ * count the documents if the result set would be prohibitively large to
+ * download entirely (e.g. thousands of documents).
  *
- * @returns A `Promise` that will be resolved with the results of the query.
+ * The result received from the server is presented, unaltered, without
+ * considering any local state. That is, documents in the local cache are not
+ * taken into consideration, neither are local modifications not yet
+ * synchronized with the server. Previously-downloaded results, if any, are not
+ * used: every request using this source necessarily involves a round trip to
+ * the server.
+ *
+ * @param query - The query whose result set size to calculate.
+ * @returns A Promise that will be resolved with the count; the count can be
+ * retrieved from `snapshot.data().count`, where `snapshot` is the
+ * `AggregateQuerySnapshot` to which the returned Promise resolves.
  */
 export declare function getCountFromServer(query: Query<unknown>): Promise<AggregateQuerySnapshot<{
     count: AggregateField<number>;

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

@@ -39,7 +39,7 @@ export declare const CACHE_SIZE_UNLIMITED = -1;
 /**
  * The Cloud Firestore service interface.
  *
- * Do not call this constructor directly. Instead, use {@link getFirestore}.
+ * Do not call this constructor directly. Instead, use {@link (getFirestore:1)}.
  */
 export declare class Firestore extends LiteFirestore {
     /**
@@ -56,8 +56,8 @@ export declare class Firestore extends LiteFirestore {
 /**
  * Initializes a new instance of {@link Firestore} with the provided settings.
  * Can only be called before any other function, including
- * {@link getFirestore}. If the custom settings are empty, this function is
- * equivalent to calling {@link getFirestore}.
+ * {@link (getFirestore:1)}. If the custom settings are empty, this function is
+ * equivalent to calling {@link (getFirestore:1)}.
  *
  * @param app - The {@link @firebase/app#FirebaseApp} with which the {@link Firestore} instance will
  * be associated.
@@ -66,14 +66,6 @@ export declare class Firestore extends LiteFirestore {
  * @returns A newly initialized {@link Firestore} instance.
  */
 export declare function initializeFirestore(app: FirebaseApp, settings: FirestoreSettings, databaseId?: string): Firestore;
-/**
- * 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
@@ -95,7 +87,15 @@ export declare function getFirestore(app: FirebaseApp): Firestore;
  */
 export declare function getFirestore(databaseId: string): Firestore;
 /**
- * Returns the existing {@link 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.
  *
@@ -115,7 +115,7 @@ export declare function configureFirestore(firestore: Firestore): void;
  * Attempts to enable persistent storage, if possible.
  *
  * Must be called before any other functions (other than
- * {@link initializeFirestore}, {@link getFirestore} or
+ * {@link initializeFirestore}, {@link (getFirestore:1)} or
  * {@link clearIndexedDbPersistence}.
  *
  * If this fails, `enableIndexedDbPersistence()` will reject the promise it
@@ -165,7 +165,7 @@ export declare function enableMultiTabIndexedDbPersistence(firestore: Firestore)
  * Must be called while the {@link Firestore} instance is not started (after the app is
  * terminated or when the app is first initialized). On startup, this function
  * must be called before other functions (other than {@link
- * initializeFirestore} or {@link getFirestore})). If the {@link Firestore}
+ * initializeFirestore} or {@link (getFirestore:1)})). If the {@link Firestore}
  * instance is still running, the promise will be rejected with the error code
  * of `failed-precondition`.
  *
@@ -221,7 +221,7 @@ export declare function disableNetwork(firestore: Firestore): Promise<void>;
  * may be used. Any other function will throw a `FirestoreError`.
  *
  * To restart after termination, create a new instance of FirebaseFirestore with
- * {@link getFirestore}.
+ * {@link (getFirestore:1)}.
  *
  * Termination does not cancel any pending writes, and any promises that are
  * awaiting a response from the server will not be resolved. If you have

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

@@ -14,6 +14,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+export { aggregateQuerySnapshotEqual, getCountFromServer } from './api/aggregate';
+export { AggregateField, AggregateFieldType, AggregateSpec, AggregateSpecData, AggregateQuerySnapshot } from './lite-api/aggregate_types';
 export { FieldPath, documentId } from './api/field_path';
 export { Firestore, EmulatorMockTokenOptions, initializeFirestore, getFirestore, enableIndexedDbPersistence, enableMultiTabIndexedDbPersistence, clearIndexedDbPersistence, waitForPendingWrites, disableNetwork, enableNetwork, terminate, connectFirestoreEmulator, loadBundle, namedQuery, ensureFirestoreConfigured } from './api/database';
 export { LoadBundleTask, LoadBundleTaskProgress, TaskState } from './api/bundle';

package/dist/firestore/src/core/count_query_runner.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @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.
+ */
+import { AbstractUserDataWriter, Query } from '../api';
+import { AggregateField, AggregateQuerySnapshot } from '../lite-api/aggregate_types';
+import { Datastore } from '../remote/datastore';
+/**
+ * CountQueryRunner encapsulates the logic needed to run the count aggregation
+ * queries.
+ */
+export declare class CountQueryRunner {
+    private readonly query;
+    private readonly datastore;
+    private readonly userDataWriter;
+    constructor(query: Query<unknown>, datastore: Datastore, userDataWriter: AbstractUserDataWriter);
+    run(): Promise<AggregateQuerySnapshot<{
+        count: AggregateField<number>;
+    }>>;
+}

package/dist/firestore/src/core/firestore_client.d.ts

@@ -15,10 +15,10 @@
  * limitations under the License.
  */
 import { GetOptions } from '@firebase/firestore-types';
+import { AbstractUserDataWriter, AggregateField, AggregateQuerySnapshot } from '../api';
 import { LoadBundleTask } from '../api/bundle';
 import { CredentialsProvider } from '../api/credentials';
 import { User } from '../auth/user';
-import { AggregateField, AggregateQuerySnapshot } from '../lite-api/aggregate';
 import { Query as LiteQuery } from '../lite-api/reference';
 import { LocalStore } from '../local/local_store';
 import { Document } from '../model/document';
@@ -117,7 +117,7 @@ export declare function firestoreClientAddSnapshotsInSyncListener(client: Firest
  * performed before any writes. Transactions must be performed while online.
  */
 export declare function firestoreClientTransaction<T>(client: FirestoreClient, updateFunction: (transaction: Transaction) => Promise<T>, options: TransactionOptions): Promise<T>;
-export declare function firestoreClientRunCountQuery(client: FirestoreClient, query: LiteQuery<unknown>): Promise<AggregateQuerySnapshot<{
+export declare function firestoreClientRunCountQuery(client: FirestoreClient, query: LiteQuery<unknown>, userDataWriter: AbstractUserDataWriter): Promise<AggregateQuerySnapshot<{
     count: AggregateField<number>;
 }>>;
 export declare function firestoreClientLoadBundle(client: FirestoreClient, databaseId: DatabaseId, data: ReadableStream<Uint8Array> | ArrayBuffer | string, resultTask: LoadBundleTask): void;

package/dist/firestore/src/lite-api/aggregate.d.ts

@@ -14,79 +14,35 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { AggregateField, AggregateQuerySnapshot, AggregateSpec } from './aggregate_types';
 import { Query } from './reference';
 /**
- * An `AggregateField`that captures input type T.
- */
-export declare class AggregateField<T> {
-    type: string;
-}
-/**
- * Creates and returns an aggregation field that counts the documents in the result set.
- * @returns An `AggregateField` object with number input type.
- */
-export declare function count(): AggregateField<number>;
-/**
- * The union of all `AggregateField` types that are returned from the factory
- * functions.
- */
-export declare type AggregateFieldType = ReturnType<typeof count>;
-/**
- * A type whose values are all `AggregateField` objects.
- * This is used as an argument to the "getter" functions, and the snapshot will
- * map the same names to the corresponding values.
- */
-export interface AggregateSpec {
-    [field: string]: AggregateFieldType;
-}
-/**
- * A type whose keys are taken from an `AggregateSpec` type, and whose values
- * are the result of the aggregation performed by the corresponding
- * `AggregateField` from the input `AggregateSpec`.
- */
-export declare type AggregateSpecData<T extends AggregateSpec> = {
-    [P in keyof T]: T[P] extends AggregateField<infer U> ? U : never;
-};
-/**
- * An `AggregateQuerySnapshot` contains the results of running an aggregate query.
- */
-export declare class AggregateQuerySnapshot<T extends AggregateSpec> {
-    readonly query: Query<unknown>;
-    private readonly _data;
-    readonly type = "AggregateQuerySnapshot";
-    /** @hideconstructor */
-    constructor(query: Query<unknown>, _data: AggregateSpecData<T>);
-    /**
-     * The results of the requested aggregations. The keys of the returned object
-     * will be the same as those of the `AggregateSpec` object specified to the
-     * aggregation method, and the values will be the corresponding aggregation
-     * result.
-     *
-     * @returns The aggregation statistics result of running a query.
-     */
-    data(): AggregateSpecData<T>;
-}
-/**
- * Counts the number of documents in the result set of the given query, ignoring
- * any locally-cached data and any locally-pending writes and simply surfacing
- * whatever the server returns. If the server cannot be reached then the
- * returned promise will be rejected.
+ * Calculates the number of documents in the result set of the given query,
+ * without actually downloading the documents.
  *
- * @param query - The `Query` to execute.
+ * Using this function to count the documents is efficient because only the
+ * final count, not the documents' data, is downloaded. This function can even
+ * count the documents if the result set would be prohibitively large to
+ * download entirely (e.g. thousands of documents).
  *
- * @returns An `AggregateQuerySnapshot` that contains the number of documents.
+ * @param query - The query whose result set size to calculate.
+ * @returns A Promise that will be resolved with the count; the count can be
+ * retrieved from `snapshot.data().count`, where `snapshot` is the
+ * `AggregateQuerySnapshot` to which the returned Promise resolves.
  */
 export declare function getCount(query: Query<unknown>): Promise<AggregateQuerySnapshot<{
     count: AggregateField<number>;
 }>>;
 /**
  * Compares two `AggregateQuerySnapshot` instances for equality.
+ *
  * Two `AggregateQuerySnapshot` instances are considered "equal" if they have
- * the same underlying query, and the same data.
+ * underlying queries that compare equal, and the same data.
  *
- * @param left - The `AggregateQuerySnapshot` to compare.
- * @param right - The `AggregateQuerySnapshot` to compare.
+ * @param left - The first `AggregateQuerySnapshot` to compare.
+ * @param right - The second `AggregateQuerySnapshot` to compare.
  *
- * @returns true if the AggregateQuerySnapshots are equal.
+ * @returns `true` if the objects are "equal", as defined above, or `false`
+ * otherwise.
  */
 export declare function aggregateQuerySnapshotEqual<T extends AggregateSpec>(left: AggregateQuerySnapshot<T>, right: AggregateQuerySnapshot<T>): boolean;

package/dist/firestore/src/lite-api/aggregate_types.d.ts

@@ -0,0 +1,69 @@
+/**
+ * @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.
+ */
+import { Query } from './reference';
+/**
+ * Represents an aggregation that can be performed by Firestore.
+ */
+export declare class AggregateField<T> {
+    /** A type string to uniquely identify instances of this class. */
+    type: string;
+}
+/**
+ * The union of all `AggregateField` types that are supported by Firestore.
+ */
+export declare type AggregateFieldType = AggregateField<number>;
+/**
+ * A type whose property values are all `AggregateField` objects.
+ */
+export interface AggregateSpec {
+    [field: string]: AggregateFieldType;
+}
+/**
+ * A type whose keys are taken from an `AggregateSpec`, and whose values are the
+ * result of the aggregation performed by the corresponding `AggregateField`
+ * from the input `AggregateSpec`.
+ */
+export declare type AggregateSpecData<T extends AggregateSpec> = {
+    [P in keyof T]: T[P] extends AggregateField<infer U> ? U : never;
+};
+/**
+ * The results of executing an aggregation query.
+ */
+export declare class AggregateQuerySnapshot<T extends AggregateSpec> {
+    private readonly _data;
+    /** A type string to uniquely identify instances of this class. */
+    readonly type = "AggregateQuerySnapshot";
+    /**
+     * The underlying query over which the aggregations recorded in this
+     * `AggregateQuerySnapshot` were performed.
+     */
+    readonly query: Query<unknown>;
+    /** @hideconstructor */
+    constructor(query: Query<unknown>, _data: AggregateSpecData<T>);
+    /**
+     * Returns the results of the aggregations performed over the underlying
+     * query.
+     *
+     * The keys of the returned object will be the same as those of the
+     * `AggregateSpec` object specified to the aggregation method, and the values
+     * will be the corresponding aggregation result.
+     *
+     * @returns The results of the aggregations performed over the underlying
+     * query.
+     */
+    data(): AggregateSpecData<T>;
+}

package/dist/firestore/src/lite-api/database.d.ts

@@ -21,6 +21,7 @@ import { User } from '../auth/user';
 import { DatabaseId } from '../core/database_info';
 import { FirestoreService } from './components';
 import { FirestoreSettingsImpl, PrivateSettings, FirestoreSettings } from './settings';
+export { EmulatorMockTokenOptions } from '@firebase/util';
 declare module '@firebase/component' {
     interface NameServiceMapping {
         'firestore/lite': Firestore;
@@ -29,7 +30,7 @@ declare module '@firebase/component' {
 /**
  * The Cloud Firestore service interface.
  *
- * Do not call this constructor directly. Instead, use {@link getFirestore}.
+ * Do not call this constructor directly. Instead, use {@link (getFirestore:1)}.
  */
 export declare class Firestore implements FirestoreService {
     _authCredentials: CredentialsProvider<User>;
@@ -71,8 +72,8 @@ export declare class Firestore implements FirestoreService {
 /**
  * Initializes a new instance of Cloud Firestore with the provided settings.
  * Can only be called before any other functions, including
- * {@link getFirestore}. If the custom settings are empty, this function is
- * equivalent to calling {@link getFirestore}.
+ * {@link (getFirestore:1)}. If the custom settings are empty, this function is
+ * equivalent to calling {@link (getFirestore:1)}.
  *
  * @param app - The {@link @firebase/app#FirebaseApp} with which the `Firestore` instance will
  * be associated.
@@ -83,8 +84,8 @@ export declare function initializeFirestore(app: FirebaseApp, settings: Firestor
 /**
  * Initializes a new instance of Cloud Firestore with the provided settings.
  * Can only be called before any other functions, including
- * {@link getFirestore}. If the custom settings are empty, this function is
- * equivalent to calling {@link getFirestore}.
+ * {@link (getFirestore:1)}. If the custom settings are empty, this function is
+ * equivalent to calling {@link (getFirestore:1)}.
  *
  * @param app - The {@link @firebase/app#FirebaseApp} with which the `Firestore` instance will
  * be associated.
@@ -134,7 +135,6 @@ export declare function getFirestore(databaseId: string): Firestore;
  * @internal
  */
 export declare function getFirestore(app: FirebaseApp, databaseId: string): Firestore;
-export { EmulatorMockTokenOptions } from '@firebase/util';
 /**
  * Modify this instance to communicate with the Cloud Firestore emulator.
  *
@@ -160,7 +160,7 @@ export declare function connectFirestoreEmulator(firestore: Firestore, host: str
  * response from the server will not be resolved.
  *
  * To restart after termination, create a new instance of `Firestore` with
- * {@link getFirestore}.
+ * {@link (getFirestore:1)}.
  *
  * Note: Under normal circumstances, calling `terminate()` is not required. This
  * function is useful only when you want to force this instance to release all of

package/dist/firestore/test/integration/api/aggregation.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 {};