@firebase/firestore 3.5.0 → 3.6.0-canary.0a112bd2a

package/dist/lite/firestore/src/protos/firestore_proto_api.d.ts

@@ -295,6 +295,32 @@ export declare namespace firestoreV1ApiClientInterfaces {
         readTime?: string;
         skippedResults?: number;
     }
+    interface RunAggregationQueryRequest {
+        parent?: string;
+        structuredAggregationQuery?: StructuredAggregationQuery;
+        transaction?: string;
+        newTransaction?: TransactionOptions;
+        readTime?: string;
+    }
+    interface RunAggregationQueryResponse {
+        result?: AggregationResult;
+        transaction?: string;
+        readTime?: string;
+    }
+    interface AggregationResult {
+        aggregateFields?: ApiClientObjectMap<Value>;
+    }
+    interface StructuredAggregationQuery {
+        structuredQuery?: StructuredQuery;
+        aggregations?: Aggregation[];
+    }
+    interface Aggregation {
+        count?: Count;
+        alias?: string;
+    }
+    interface Count {
+        upTo?: number;
+    }
     interface Status {
         code?: number;
         message?: string;
@@ -417,6 +443,8 @@ export declare type ReadWrite = firestoreV1ApiClientInterfaces.ReadWrite;
 export declare type RollbackRequest = firestoreV1ApiClientInterfaces.RollbackRequest;
 export declare type RunQueryRequest = firestoreV1ApiClientInterfaces.RunQueryRequest;
 export declare type RunQueryResponse = firestoreV1ApiClientInterfaces.RunQueryResponse;
+export declare type RunAggregationQueryRequest = firestoreV1ApiClientInterfaces.RunAggregationQueryRequest;
+export declare type RunAggregationQueryResponse = firestoreV1ApiClientInterfaces.RunAggregationQueryResponse;
 export declare type Status = firestoreV1ApiClientInterfaces.Status;
 export declare type StructuredQuery = firestoreV1ApiClientInterfaces.StructuredQuery;
 export declare type Target = firestoreV1ApiClientInterfaces.Target;

package/dist/lite/firestore/src/remote/connection.d.ts

@@ -62,6 +62,13 @@ export interface Connection {
      * @param token - the Token to use for the RPC.
      */
     openStream<Req, Resp>(rpcName: string, authToken: Token | null, appCheckToken: Token | null): Stream<Req, Resp>;
+    /**
+     * Returns whether or not the implementation requires that the "path" of the resource
+     * (a document or a collection) be present in the request message. If true, then the
+     * request message must include the path. If false, then the request message must NOT
+     * include the path.
+     */
+    readonly shouldResourcePathBeIncludedInRequest: boolean;
 }
 /**
  * A bidirectional stream that can be used to send an receive messages.

package/dist/lite/firestore/src/remote/datastore.d.ts

@@ -20,6 +20,7 @@ import { Query } from '../core/query';
 import { Document } from '../model/document';
 import { DocumentKey } from '../model/document_key';
 import { Mutation } from '../model/mutation';
+import { Value as ProtoValue } from '../protos/firestore_proto_api';
 import { AsyncQueue } from '../util/async_queue';
 import { Connection } from './connection';
 import { PersistentListenStream, PersistentWriteStream, WatchStreamListener, WriteStreamListener } from './persistent_stream';
@@ -36,5 +37,6 @@ export declare function newDatastore(authCredentials: CredentialsProvider<User>,
 export declare function invokeCommitRpc(datastore: Datastore, mutations: Mutation[]): Promise<void>;
 export declare function invokeBatchGetDocumentsRpc(datastore: Datastore, keys: DocumentKey[]): Promise<Document[]>;
 export declare function invokeRunQueryRpc(datastore: Datastore, query: Query): Promise<Document[]>;
+export declare function invokeRunAggregationQueryRpc(datastore: Datastore, query: Query): Promise<ProtoValue[]>;
 export declare function newPersistentWriteStream(datastore: Datastore, queue: AsyncQueue, listener: WriteStreamListener): PersistentWriteStream;
 export declare function newPersistentWatchStream(datastore: Datastore, queue: AsyncQueue, listener: WatchStreamListener): PersistentListenStream;

package/dist/lite/firestore/src/remote/remote_event.d.ts

@@ -76,7 +76,7 @@ export declare class RemoteEvent {
      * used to create a synthesized RemoteEvent that can be used to apply a
      * CURRENT status change to a View, for queries executed in a different tab.
      */
-    static createSynthesizedRemoteEventForCurrentChange(targetId: TargetId, current: boolean): RemoteEvent;
+    static createSynthesizedRemoteEventForCurrentChange(targetId: TargetId, current: boolean, resumeToken: ByteString): RemoteEvent;
 }
 /**
  * A TargetChange specifies the set of changes for a specific target as part of
@@ -149,5 +149,5 @@ export declare class TargetChange {
      * apply a CURRENT status change to a View (for queries executed in a different
      * tab) or for new queries (to raise snapshots with correct CURRENT status).
      */
-    static createSynthesizedTargetChangeForCurrentChange(targetId: TargetId, current: boolean): TargetChange;
+    static createSynthesizedTargetChangeForCurrentChange(targetId: TargetId, current: boolean, resumeToken: ByteString): TargetChange;
 }

package/dist/lite/firestore/src/remote/rest_connection.d.ts

@@ -27,6 +27,7 @@ export declare abstract class RestConnection implements Connection {
     protected readonly databaseId: DatabaseId;
     protected readonly baseUrl: string;
     private readonly databaseRoot;
+    get shouldResourcePathBeIncludedInRequest(): boolean;
     constructor(databaseInfo: DatabaseInfo);
     invokeRPC<Req, Resp>(rpcName: string, path: string, req: Req, authToken: Token | null, appCheckToken: Token | null): Promise<Resp>;
     invokeStreamingRPC<Req, Resp>(rpcName: string, path: string, request: Req, authToken: Token | null, appCheckToken: Token | null, expectedResponseCount?: number): Promise<Resp[]>;

package/dist/lite/firestore/src/remote/serializer.d.ts

@@ -26,7 +26,7 @@ import { FieldMask } from '../model/field_mask';
 import { Mutation, MutationResult } from '../model/mutation';
 import { ObjectValue } from '../model/object_value';
 import { FieldPath, ResourcePath } from '../model/path';
-import { ApiClientObjectMap as ProtoApiClientObjectMap, BatchGetDocumentsResponse as ProtoBatchGetDocumentsResponse, Document as ProtoDocument, DocumentMask as ProtoDocumentMask, DocumentsTarget as ProtoDocumentsTarget, FieldFilterOp as ProtoFieldFilterOp, FieldReference as ProtoFieldReference, Filter as ProtoFilter, ListenResponse as ProtoListenResponse, Order as ProtoOrder, OrderDirection as ProtoOrderDirection, QueryTarget as ProtoQueryTarget, Target as ProtoTarget, Timestamp as ProtoTimestamp, Write as ProtoWrite, WriteResult as ProtoWriteResult } from '../protos/firestore_proto_api';
+import { ApiClientObjectMap as ProtoApiClientObjectMap, BatchGetDocumentsResponse as ProtoBatchGetDocumentsResponse, Document as ProtoDocument, DocumentMask as ProtoDocumentMask, DocumentsTarget as ProtoDocumentsTarget, FieldFilterOp as ProtoFieldFilterOp, FieldReference as ProtoFieldReference, Filter as ProtoFilter, ListenResponse as ProtoListenResponse, Order as ProtoOrder, OrderDirection as ProtoOrderDirection, QueryTarget as ProtoQueryTarget, RunAggregationQueryRequest as ProtoRunAggregationQueryRequest, Target as ProtoTarget, Timestamp as ProtoTimestamp, Write as ProtoWrite, WriteResult as ProtoWriteResult } from '../protos/firestore_proto_api';
 import { ByteString } from '../util/byte_string';
 import { Serializer } from './number_serializer';
 import { WatchChange } from './watch_change';
@@ -82,6 +82,7 @@ export declare function fromWriteResults(protos: ProtoWriteResult[] | undefined,
 export declare function toDocumentsTarget(serializer: JsonProtoSerializer, target: Target): ProtoDocumentsTarget;
 export declare function fromDocumentsTarget(documentsTarget: ProtoDocumentsTarget): Target;
 export declare function toQueryTarget(serializer: JsonProtoSerializer, target: Target): ProtoQueryTarget;
+export declare function toRunAggregationQueryRequest(serializer: JsonProtoSerializer, target: Target): ProtoRunAggregationQueryRequest;
 export declare function convertQueryTargetToQuery(target: ProtoQueryTarget): Query;
 export declare function fromQueryTarget(target: ProtoQueryTarget): Target;
 export declare function toListenRequestLabels(serializer: JsonProtoSerializer, targetData: TargetData): ProtoApiClientObjectMap<string> | null;

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

package/dist/lite/firestore/test/integration/api_internal/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 {};

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

@@ -44,6 +44,7 @@ export declare function withTestDocAndInitialData(persistence: boolean, initialD
 export declare function withTestCollection(persistence: boolean, docs: {
     [key: string]: DocumentData;
 }, fn: (collection: CollectionReference, db: Firestore) => Promise<void>): Promise<void>;
+export declare function withEmptyTestCollection(persistence: boolean, fn: (collection: CollectionReference, db: Firestore) => Promise<void>): Promise<void>;
 export declare function withTestCollectionSettings(persistence: boolean, settings: PrivateSettings, docs: {
     [key: string]: DocumentData;
 }, fn: (collection: CollectionReference, db: Firestore) => Promise<void>): Promise<void>;

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

@@ -96,6 +96,7 @@ export declare class MockConnection implements Connection {
     writeStreamRequestCount: number;
     nextWriteStreamToken: number;
     constructor(queue: AsyncQueue);
+    shouldResourcePathBeIncludedInRequest: boolean;
     /**
      * Tracks the currently active watch targets as detected by the mock watch
      * stream, as a mapping from target ID to query Target.

package/dist/lite/firestore/test/util/api_helpers.d.ts

@@ -46,4 +46,4 @@ export declare function querySnapshot(path: string, oldDocs: {
     [key: string]: JsonObject<unknown>;
 }, docsToAdd: {
     [key: string]: JsonObject<unknown>;
-}, mutatedKeys: DocumentKeySet, fromCache: boolean, syncStateChanged: boolean): QuerySnapshot;
+}, mutatedKeys: DocumentKeySet, fromCache: boolean, syncStateChanged: boolean, hasCachedResults?: boolean): QuerySnapshot;