@firebase/firestore 3.4.5-canary.e987dac26 → 3.4.6-canary.69aa7b02d

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @firebase/firestore
 
+## 3.4.6
+
+### Patch Changes
+
+- Updated dependencies [[`2d672cead`](https://github.com/firebase/firebase-js-sdk/commit/2d672cead167187cb714cd89b638c0884ba58f03)]:
+  - @firebase/util@1.5.0
+  - @firebase/component@0.5.11
+
 ## 3.4.5
 
 ### Patch Changes

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

@@ -23,6 +23,7 @@ export 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/dist/firestore/src/local/indexeddb_mutation_batch_impl.d.ts

@@ -16,6 +16,7 @@
  */
 import { DocumentKey } from '../model/document_key';
 import { DbRemoteDocument } from './indexeddb_schema';
+import { DbRemoteDocument as DbRemoteDocumentLegacy } from './indexeddb_schema_legacy';
 import { PersistencePromise } from './persistence_promise';
 import { SimpleDbTransaction } from './simple_db';
 /**
@@ -31,4 +32,4 @@ export declare function removeMutationBatch(txn: SimpleDbTransaction, userId: st
 /**
  * Returns an approximate size for the given document.
  */
-export declare function dbDocumentSize(doc: DbRemoteDocument | null): number;
+export declare function dbDocumentSize(doc: DbRemoteDocument | DbRemoteDocumentLegacy | null): number;

package/dist/firestore/src/local/indexeddb_schema.d.ts

@@ -20,7 +20,7 @@ import { BundledQuery } from '../protos/firestore_bundle_proto';
 import { Document as ProtoDocument, DocumentsTarget as ProtoDocumentsTarget, QueryTarget as ProtoQueryTarget, Write as ProtoWrite } from '../protos/firestore_proto_api';
 import { EncodedResourcePath } from './encoded_resource_path';
 import { DbTimestampKey } from './indexeddb_sentinels';
-export declare const INDEXING_SCHEMA_VERSION = 13;
+export declare const INDEXING_SCHEMA_VERSION = 14;
 /**
  * Schema Version for the Web client:
  * 1.  Initial version including Mutation Queue, Query Cache, and Remote
@@ -40,7 +40,9 @@ export declare const INDEXING_SCHEMA_VERSION = 13;
  * 10. Rewrite the canonical IDs to the explicit Protobuf-based format.
  * 11. Add bundles and named_queries for bundle support.
  * 12. Add document overlays.
- * 13. Add indexing support.
+ * 13. Rewrite the keys of the remote document cache to allow for efficient
+ *     document lookup via `getAll()`.
+ * 14. Add indexing support.
  */
 export declare const SCHEMA_VERSION: number;
 /**
@@ -174,10 +176,21 @@ export interface DbUnknownDocument {
  * - An "unknown document" representing a document that is known to exist (at
  * some version) but whose contents are unknown.
  *
+ * The document key is split up across `prefixPath`, `collectionGroup` and
+ * `documentId`.
+ *
  * Note: This is the persisted equivalent of a MaybeDocument and could perhaps
  * be made more general if necessary.
  */
 export interface DbRemoteDocument {
+    /** The path to the document's collection (excluding). */
+    prefixPath: string[];
+    /** The collection ID the document is direclty nested under. */
+    collectionGroup: string;
+    /** The document ID. */
+    documentId: string;
+    /** When the document was read from the backend. */
+    readTime: DbTimestampKey;
     /**
      * Set to an instance of DbUnknownDocument if the data for a document is
      * not known, but it is known that a document exists at the specified
@@ -200,17 +213,7 @@ export interface DbRemoteDocument {
      * documents are potentially inconsistent with the backend's copy and use
      * the write's commit version as their document version.
      */
-    hasCommittedMutations?: boolean;
-    /**
-     * When the document was read from the backend. Undefined for data written
-     * prior to schema version 9.
-     */
-    readTime?: DbTimestampKey;
-    /**
-     * The path of the collection this document is part of. Undefined for data
-     * written prior to schema version 9.
-     */
-    parentPath?: string[];
+    hasCommittedMutations: boolean;
 }
 /**
  * Contains a single entry that has metadata about the remote document cache.

package/dist/firestore/src/local/indexeddb_schema_converter.d.ts

@@ -38,4 +38,5 @@ export declare class SchemaConverter implements SimpleDbSchemaConverter {
     private ensureSequenceNumbers;
     private createCollectionParentIndex;
     private rewriteCanonicalIds;
+    private rewriteRemoteDocumentCache;
 }

package/dist/firestore/src/local/indexeddb_schema_legacy.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @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 { Document as ProtoDocument } from '../protos/firestore_proto_api';
+import { DbNoDocument, DbUnknownDocument } from './indexeddb_schema';
+import { DbTimestampKey } from './indexeddb_sentinels';
+export interface DbRemoteDocument {
+    unknownDocument?: DbUnknownDocument;
+    noDocument?: DbNoDocument;
+    document?: ProtoDocument;
+    hasCommittedMutations?: boolean;
+    readTime?: DbTimestampKey;
+    parentPath?: string[];
+}
+export declare type DbRemoteDocumentKey = string[];
+export declare const DbRemoteDocumentStore = "remoteDocuments";

package/dist/firestore/src/local/indexeddb_sentinels.d.ts

@@ -79,7 +79,22 @@ export declare function newDbDocumentMutationKey(userId: string, path: ResourceP
  */
 export declare const DbDocumentMutationPlaceholder: DbDocumentMutation;
 export declare const DbDocumentMutationStore = "documentMutations";
-export declare const DbRemoteDocumentStore = "remoteDocuments";
+export declare const DbRemoteDocumentStore = "remoteDocumentsV14";
+/**
+ * A key in the 'remoteDocumentsV14' object store is an array containing the
+ * collection path, the collection group, the read time and the document id.
+ */
+export declare type DbRemoteDocumentKey = [
+    /** path to collection */ string[],
+    /** collection group */ string,
+    /** read time */ DbTimestampKey,
+    /** document ID */ string
+];
+/**
+ * The primary key of the remote documents store, which allows for efficient
+ * access by collection path and read time.
+ */
+export declare const DbRemoteDocumentKeyPath: string[];
 /**
  * An index that provides access to all entries sorted by read time (which
  * corresponds to the last modification time of each row).
@@ -88,15 +103,17 @@ export declare const DbRemoteDocumentStore = "remoteDocuments";
  */
 export declare const DbRemoteDocumentReadTimeIndex = "readTimeIndex";
 export declare const DbRemoteDocumentReadTimeIndexPath = "readTime";
+/** An index that provides access to documents by key. */
+export declare const DbRemoteDocumentDocumentKeyIndex = "documentKeyIndex";
+export declare const DbRemoteDocumentDocumentKeyIndexPath: string[];
 /**
- * An index that provides access to documents in a collection sorted by read
+ * An index that provides access to documents by collection group and read
  * time.
  *
- * This index is used to allow the RemoteDocumentCache to fetch newly changed
- * documents in a collection.
+ * This index is used by the index backfiller.
  */
-export declare const DbRemoteDocumentCollectionReadTimeIndex = "collectionReadTimeIndex";
-export declare const DbRemoteDocumentCollectionReadTimeIndexPath: string[];
+export declare const DbRemoteDocumentCollectionGroupIndex = "collectionGroupIndex";
+export declare const DbRemoteDocumentCollectionGroupIndexPath: string[];
 export declare const DbRemoteDocumentGlobalStore = "remoteDocumentGlobal";
 export declare const DbRemoteDocumentGlobalKey = "remoteDocumentGlobalKey";
 export declare type DbRemoteDocumentGlobalKey = typeof DbRemoteDocumentGlobalKey;
@@ -223,6 +240,7 @@ export declare const V8_STORES: string[];
 export declare const V11_STORES: string[];
 export declare const V12_STORES: string[];
 export declare const V13_STORES: string[];
+export declare const V14_STORES: string[];
 /**
  * The list of all default IndexedDB stores used throughout the SDK. This is
  * used when creating transactions so that access across all stores is done
@@ -231,8 +249,3 @@ export declare const V13_STORES: string[];
 export declare const ALL_STORES: string[];
 /** Returns the object stores for the provided schema. */
 export declare function getObjectStores(schemaVersion: number): string[];
-/**
- * A key in the 'remoteDocuments' object store is a string array containing the
- * segments that make up the path.
- */
-export declare type DbRemoteDocumentKey = string[];

package/dist/firestore/src/local/local_documents_view.d.ts

@@ -15,10 +15,10 @@
  * limitations under the License.
  */
 import { Query } from '../core/query';
-import { SnapshotVersion } from '../core/snapshot_version';
 import { DocumentKeySet, DocumentMap, MutableDocumentMap } from '../model/collections';
 import { Document } from '../model/document';
 import { DocumentKey } from '../model/document_key';
+import { IndexOffset } from '../model/field_index';
 import { IndexManager } from './index_manager';
 import { MutationQueue } from './mutation_queue';
 import { PersistencePromise } from './persistence_promise';
@@ -62,10 +62,9 @@ export declare class LocalDocumentsView {
      *
      * @param transaction - The persistence transaction.
      * @param query - The query to match documents against.
-     * @param sinceReadTime - If not set to SnapshotVersion.min(), return only
-     *     documents that have been read since this snapshot version (exclusive).
+     * @param offset - Read time and key to start scanning by (exclusive).
      */
-    getDocumentsMatchingQuery(transaction: PersistenceTransaction, query: Query, sinceReadTime: SnapshotVersion): PersistencePromise<DocumentMap>;
+    getDocumentsMatchingQuery(transaction: PersistenceTransaction, query: Query, offset: IndexOffset): PersistencePromise<DocumentMap>;
     private getDocumentsMatchingDocumentQuery;
     private getDocumentsMatchingCollectionGroupQuery;
     private getDocumentsMatchingCollectionQuery;

package/dist/firestore/src/local/local_serializer.d.ts

@@ -25,7 +25,7 @@ import { MutationBatch } from '../model/mutation_batch';
 import { Overlay } from '../model/overlay';
 import { BundledQuery as ProtoBundledQuery, BundleMetadata as ProtoBundleMetadata, NamedQuery as ProtoNamedQuery } from '../protos/firestore_bundle_proto';
 import { JsonProtoSerializer } from '../remote/serializer';
-import { DbBundle, DbDocumentOverlay, DbIndexConfiguration, DbIndexState, DbMutationBatch, DbNamedQuery, DbRemoteDocument, DbTarget } from './indexeddb_schema';
+import { DbBundle, DbDocumentOverlay, DbIndexConfiguration, DbIndexState, DbMutationBatch, DbNamedQuery, DbRemoteDocument, DbTarget, DbTimestamp } from './indexeddb_schema';
 import { DbDocumentOverlayKey, DbTimestampKey } from './indexeddb_sentinels';
 import { TargetData } from './target_data';
 /** Serializer for values stored in the LocalStore. */
@@ -39,6 +39,7 @@ export declare function fromDbRemoteDocument(localSerializer: LocalSerializer, r
 export declare function toDbRemoteDocument(localSerializer: LocalSerializer, document: MutableDocument): DbRemoteDocument;
 export declare function toDbTimestampKey(snapshotVersion: SnapshotVersion): DbTimestampKey;
 export declare function fromDbTimestampKey(dbTimestampKey: DbTimestampKey): SnapshotVersion;
+export declare function toDbTimestamp(snapshotVersion: SnapshotVersion): DbTimestamp;
 /** Encodes a batch of mutations into a DbMutationBatch for local storage. */
 export declare function toDbMutationBatch(localSerializer: LocalSerializer, userId: string, batch: MutationBatch): DbMutationBatch;
 /** Decodes a DbMutationBatch into a MutationBatch */

package/dist/firestore/src/local/remote_document_cache.d.ts

@@ -14,10 +14,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { SnapshotVersion } from '../core/snapshot_version';
 import { DocumentKeySet, MutableDocumentMap } from '../model/collections';
 import { MutableDocument } from '../model/document';
 import { DocumentKey } from '../model/document_key';
+import { IndexOffset } from '../model/field_index';
 import { ResourcePath } from '../model/path';
 import { IndexManager } from './index_manager';
 import { PersistencePromise } from './persistence_promise';
@@ -53,11 +53,20 @@ export 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.
      */
-    getAll(transaction: PersistenceTransaction, collection: ResourcePath, sinceReadTime: SnapshotVersion): PersistencePromise<MutableDocumentMap>;
+    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.
+     */
+    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.

package/dist/firestore/src/model/field_index.d.ts

@@ -18,6 +18,11 @@ import { SnapshotVersion } from '../core/snapshot_version';
 import { Document } from './document';
 import { DocumentKey } from './document_key';
 import { FieldPath } from './path';
+/**
+ * The initial mutation batch id for each index. Gets updated during index
+ * backfill.
+ */
+export declare const INITIAL_LARGEST_BATCH_ID = -1;
 /**
  * The initial sequence number for each index. Gets updated during index
  * backfill.
@@ -152,7 +157,9 @@ export 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;
 }
 export declare function indexOffsetComparator(left: IndexOffset, right: IndexOffset): number;

package/dist/firestore/test/unit/local/test_remote_document_cache.d.ts

@@ -21,6 +21,7 @@ import { RemoteDocumentChangeBuffer } from '../../../src/local/remote_document_c
 import { DocumentKeySet, MutableDocumentMap } from '../../../src/model/collections';
 import { MutableDocument } from '../../../src/model/document';
 import { DocumentKey } from '../../../src/model/document_key';
+import { IndexOffset } from '../../../src/model/field_index';
 import { ResourcePath } from '../../../src/model/path';
 /**
  * A wrapper around a RemoteDocumentCache that automatically creates a
@@ -44,7 +45,8 @@ export declare class TestRemoteDocumentCache {
     removeEntry(documentKey: DocumentKey, version?: SnapshotVersion): Promise<void>;
     getEntry(documentKey: DocumentKey): Promise<MutableDocument>;
     getEntries(documentKeys: DocumentKeySet): Promise<MutableDocumentMap>;
-    getAll(collection: ResourcePath, sinceReadTime: SnapshotVersion): Promise<MutableDocumentMap>;
+    getAllFromCollection(collection: ResourcePath, offset: IndexOffset): Promise<MutableDocumentMap>;
+    getAllFromCollectionGroup(collectionGroup: string, offset: IndexOffset, limit: number): Promise<MutableDocumentMap>;
     getNewDocumentChanges(sinceReadTime: SnapshotVersion): Promise<{
         changedDocs: MutableDocumentMap;
         readTime: SnapshotVersion;