@firebase/firestore 3.4.5 → 3.4.6-canary.3198d58dc

package/dist/private.d.ts

@@ -870,7 +870,7 @@ declare interface DocumentOverlayCache {
      * Saves the given document mutation map to persistence as overlays.
      * All overlays will have their largest batch id set to `largestBatchId`.
      */
-    saveOverlays(transaction: PersistenceTransaction, largestBatchId: number, overlays: Map<_DocumentKey, Mutation>): PersistencePromise<void>;
+    saveOverlays(transaction: PersistenceTransaction, largestBatchId: number, overlays: MutationMap): PersistencePromise<void>;
     /** Removes overlays for the given document keys and batch ID. */
     removeOverlaysForBatchId(transaction: PersistenceTransaction, documentKeys: DocumentKeySet, batchId: number): PersistencePromise<void>;
     /**
@@ -882,7 +882,7 @@ declare interface DocumentOverlayCache {
      * Only overlays that contain a change past `sinceBatchId` are returned.
      * @returns Mapping of each document key in the collection to its overlay.
      */
-    getOverlaysForCollection(transaction: PersistenceTransaction, collection: _ResourcePath, sinceBatchId: number): PersistencePromise<Map<_DocumentKey, Overlay>>;
+    getOverlaysForCollection(transaction: PersistenceTransaction, collection: _ResourcePath, sinceBatchId: number): PersistencePromise<OverlayMap>;
     /**
      * Returns `count` overlays with a batch ID higher than `sinceBatchId` for the
      * provided collection group, processed by ascending batch ID. The method
@@ -897,7 +897,7 @@ declare interface DocumentOverlayCache {
      * batch contains more entries.
      * @return Mapping of each document key in the collection group to its overlay.
      */
-    getOverlaysForCollectionGroup(transaction: PersistenceTransaction, collectionGroup: string, sinceBatchId: number, count: number): PersistencePromise<Map<_DocumentKey, Overlay>>;
+    getOverlaysForCollectionGroup(transaction: PersistenceTransaction, collectionGroup: string, sinceBatchId: number, count: number): PersistencePromise<OverlayMap>;
 }
 
 /**
@@ -2309,9 +2309,9 @@ declare interface IndexManager {
     getFieldIndex(transaction: PersistenceTransaction, target: Target): PersistencePromise<FieldIndex | null>;
     /**
      * Returns the documents that match the given target based on the provided
-     * index.
+     * index or `null` if the target does not have a matching index.
      */
-    getDocumentsMatchingTarget(transaction: PersistenceTransaction, fieldIndex: FieldIndex, target: Target): PersistencePromise<DocumentKeySet>;
+    getDocumentsMatchingTarget(transaction: PersistenceTransaction, target: Target): PersistencePromise<DocumentKeySet | null>;
     /**
      * Returns the next collection group to update. Returns `null` if no group
      * exists.
@@ -2357,8 +2357,10 @@ declare class IndexOffset {
      * `DocumentKey.empty()` if no document has been indexed.
      */
     documentKey: _DocumentKey, largestBatchId: number);
-    /** The state of an index that has not yet been backfilled. */
+    /** Returns an offset that sorts before all regular offsets. */
     static min(): IndexOffset;
+    /** Returns an offset that sorts after all regular offsets. */
+    static max(): IndexOffset;
 }
 
 /** An index component consisting of field path and index type.  */
@@ -2818,6 +2820,8 @@ declare class MutationBatchResult {
     static from(batch: MutationBatch, commitVersion: SnapshotVersion, results: MutationResult[]): MutationBatchResult;
 }
 
+declare type MutationMap = ObjectMap<_DocumentKey, Mutation>;
+
 /** A queue of mutations to apply to the remote store. */
 declare interface MutationQueue {
     /** Returns true if this queue contains no mutation batches. */
@@ -3044,6 +3048,8 @@ declare class ObjectMap<KeyType, ValueType> {
      * constant time lookups in practice.
      */
     private inner;
+    /** The number of entries stored in the map */
+    private innerSize;
     constructor(mapKeyFn: (key: KeyType) => string, equalsFn: (l: KeyType, r: KeyType) => boolean);
     /** Get a value for this key, or undefined if it does not exist. */
     get(key: KeyType): ValueType | undefined;
@@ -3056,6 +3062,7 @@ declare class ObjectMap<KeyType, ValueType> {
     delete(key: KeyType): boolean;
     forEach(fn: (key: KeyType, val: ValueType) => void): void;
     isEmpty(): boolean;
+    size(): number;
 }
 
 /**
@@ -3422,6 +3429,8 @@ declare class Overlay {
     toString(): string;
 }
 
+declare type OverlayMap = ObjectMap<_DocumentKey, Overlay>;
+
 declare interface ParseContext {
     readonly databaseId: _DatabaseId;
     readonly ignoreUndefinedProperties: boolean;
@@ -3996,11 +4005,20 @@ declare interface RemoteDocumentCache {
      * Returns the documents from the provided collection.
      *
      * @param collection - The collection to read.
-     * @param sinceReadTime - If not set to SnapshotVersion.min(), return only
-     *     documents that have been read since this snapshot version (exclusive).
+     * @param offset - The offset to start the scan at (exclusive).
+     * @returns The set of matching documents.
+     */
+    getAllFromCollection(transaction: PersistenceTransaction, collection: _ResourcePath, offset: IndexOffset): PersistencePromise<MutableDocumentMap>;
+    /**
+     * Looks up the next `limit` documents for a collection group based on the
+     * provided offset. The ordering is based on the document's read time and key.
+     *
+     * @param collectionGroup - The collection group to scan.
+     * @param offset - The offset to start the scan at (exclusive).
+     * @param limit - The maximum number of results to return.
      * @returns The set of matching documents.
      */
-    getAll(transaction: PersistenceTransaction, collection: _ResourcePath, sinceReadTime: SnapshotVersion): PersistencePromise<MutableDocumentMap>;
+    getAllFromCollectionGroup(transaction: PersistenceTransaction, collectionGroup: string, offset: IndexOffset, limit: number): PersistencePromise<MutableDocumentMap>;
     /**
      * Provides access to add or update the contents of the cache. The buffer
      * handles proper size accounting for the change.
@@ -4401,8 +4419,10 @@ declare interface SharedClientState {
     /**
      * Notifies other clients when remote documents have changed due to loading
      * a bundle.
+     *
+     * @param collectionGroups The collection groups affected by this bundle.
      */
-    notifyBundleLoaded(): void;
+    notifyBundleLoaded(collectionGroups: Set<string>): void;
 }
 
 /**
@@ -4490,6 +4510,7 @@ declare class SnapshotVersion {
     private timestamp;
     static fromTimestamp(value: Timestamp): SnapshotVersion;
     static min(): SnapshotVersion;
+    static max(): SnapshotVersion;
     private constructor();
     compareTo(other: SnapshotVersion): number;
     isEqual(other: SnapshotVersion): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firebase/firestore",
-  "version": "3.4.5",
+  "version": "3.4.6-canary.3198d58dc",
   "engines": {
     "node": ">=10.10.0"
   },
@@ -77,22 +77,22 @@
     "lite/package.json"
   ],
   "dependencies": {
-    "@firebase/component": "0.5.10",
-    "@firebase/logger": "0.3.2",
-    "@firebase/util": "1.4.3",
-    "@firebase/webchannel-wrapper": "0.6.1",
+    "@firebase/component": "0.5.11-canary.3198d58dc",
+    "@firebase/logger": "0.3.2-canary.3198d58dc",
+    "@firebase/util": "1.5.0-canary.3198d58dc",
+    "@firebase/webchannel-wrapper": "0.6.1-canary.3198d58dc",
     "@grpc/grpc-js": "^1.3.2",
     "@grpc/proto-loader": "^0.6.0",
     "node-fetch": "2.6.7",
     "tslib": "^2.1.0"
   },
   "peerDependencies": {
-    "@firebase/app": "0.x"
+    "@firebase/app": "0.7.19-canary.3198d58dc"
   },
   "devDependencies": {
-    "@firebase/app": "0.7.17",
-    "@firebase/app-compat": "0.1.18",
-    "@firebase/auth": "0.19.9",
+    "@firebase/app": "0.7.19-canary.3198d58dc",
+    "@firebase/app-compat": "0.1.20-canary.3198d58dc",
+    "@firebase/auth": "0.19.10-canary.3198d58dc",
     "@rollup/plugin-alias": "3.1.5",
     "@rollup/plugin-json": "4.1.0",
     "@types/eslint": "7.28.0",