@firebase/firestore 3.4.7 → 3.4.8-2022312211851

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @firebase/firestore
 
+## 3.4.8-2022312211851
+
+### Patch Changes
+
+- [`05dc9d6a0`](https://github.com/firebase/firebase-js-sdk/commit/05dc9d6a0db3058611dd7a2dc34daa726f9ba20d) [#6128](https://github.com/firebase/firebase-js-sdk/pull/6128) (fixes [#6110](https://github.com/firebase/firebase-js-sdk/issues/6110)) - Fixes an issue during multi-document lookup that resulted in the IndexedDB error "The parameter is less than or equal to this cursor's".
+
+- Updated dependencies [[`e9e5f6b3c`](https://github.com/firebase/firebase-js-sdk/commit/e9e5f6b3ca9d61323b22f87986d9959f5297ec59)]:
+  - @firebase/util@1.5.2-2022312211851
+  - @firebase/app@0.7.21-2022312211851
+  - @firebase/component@0.5.13-2022312211851
+
 ## 3.4.7
 
 ### Patch Changes

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

@@ -15,7 +15,8 @@
  * limitations under the License.
  */
 import { Target } from '../core/target';
-import { DocumentKeySet, DocumentMap } from '../model/collections';
+import { DocumentMap } from '../model/collections';
+import { DocumentKey } from '../model/document_key';
 import { FieldIndex, IndexOffset } from '../model/field_index';
 import { ResourcePath } from '../model/path';
 import { PersistencePromise } from './persistence_promise';
@@ -75,7 +76,7 @@ export interface IndexManager {
      * Returns the documents that match the given target based on the provided
      * index or `null` if the target does not have a matching index.
      */
-    getDocumentsMatchingTarget(transaction: PersistenceTransaction, target: Target): PersistencePromise<DocumentKeySet | null>;
+    getDocumentsMatchingTarget(transaction: PersistenceTransaction, target: Target): PersistencePromise<DocumentKey[] | null>;
     /**
      * Returns the next collection group to update. Returns `null` if no group
      * exists.

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

@@ -15,8 +15,10 @@
  * limitations under the License.
  */
 import { User } from '../auth/user';
+import { DatabaseId } from '../core/database_info';
 import { Target } from '../core/target';
-import { DocumentKeySet, DocumentMap } from '../model/collections';
+import { DocumentMap } from '../model/collections';
+import { DocumentKey } from '../model/document_key';
 import { FieldIndex, IndexOffset } from '../model/field_index';
 import { ResourcePath } from '../model/path';
 import { IndexManager } from './index_manager';
@@ -30,6 +32,7 @@ import { PersistenceTransaction } from './persistence_transaction';
  */
 export declare class IndexedDbIndexManager implements IndexManager {
     private user;
+    private readonly databaseId;
     /**
      * An in-memory copy of the index entries we've already written since the SDK
      * launched. Used to avoid re-writing the same entry repeatedly.
@@ -44,7 +47,7 @@ export declare class IndexedDbIndexManager implements IndexManager {
      * contains only one term from the target's disjunctive normal form (DNF).
      */
     private targetToDnfSubTargets;
-    constructor(user: User);
+    constructor(user: User, databaseId: DatabaseId);
     /**
      * Adds a new entry to the collection parent index.
      *
@@ -56,7 +59,7 @@ export declare class IndexedDbIndexManager implements IndexManager {
     getCollectionParents(transaction: PersistenceTransaction, collectionId: string): PersistencePromise<ResourcePath[]>;
     addFieldIndex(transaction: PersistenceTransaction, index: FieldIndex): PersistencePromise<void>;
     deleteFieldIndex(transaction: PersistenceTransaction, index: FieldIndex): PersistencePromise<void>;
-    getDocumentsMatchingTarget(transaction: PersistenceTransaction, target: Target): PersistencePromise<DocumentKeySet | null>;
+    getDocumentsMatchingTarget(transaction: PersistenceTransaction, target: Target): PersistencePromise<DocumentKey[] | null>;
     private getSubTargets;
     /**
      * Constructs a key range query on `DbIndexEntryStore` that unions all
@@ -81,6 +84,11 @@ export declare class IndexedDbIndexManager implements IndexManager {
     private encodeDirectionalElements;
     /** Encodes a single value to the ascending index format. */
     private encodeSingleElement;
+    /**
+     * Returns an encoded form of the document key that sorts based on the key
+     * ordering of the field index.
+     */
+    private encodeDirectionalKey;
     /**
      * Encodes the given field values according to the specification in `target`.
      * For IN queries, a list of possible values is returned.

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

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 import { MutableDocument } from '../model/document';
+import { DocumentKey } from '../model/document_key';
 import { LocalSerializer } from './local_serializer';
 import { RemoteDocumentCache } from './remote_document_cache';
 export interface DocumentSizeEntry {
@@ -25,3 +26,11 @@ export interface IndexedDbRemoteDocumentCache extends RemoteDocumentCache {
 }
 /** Creates a new IndexedDbRemoteDocumentCache. */
 export declare function newIndexedDbRemoteDocumentCache(serializer: LocalSerializer): IndexedDbRemoteDocumentCache;
+/**
+ * Comparator that compares document keys according to the primary key sorting
+ * used by the `DbRemoteDocumentDocument` store (by prefix path, collection id
+ * and then document ID).
+ *
+ * Visible for testing.
+ */
+export declare function dbKeyComparator(l: DocumentKey, r: DocumentKey): number;

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

@@ -470,8 +470,13 @@ export interface DbIndexEntry {
     arrayValue: Uint8Array;
     /** The encoded directional value for equality and inequality filters. */
     directionalValue: Uint8Array;
-    /** The document key this entry points to. */
-    documentKey: EncodedResourcePath;
+    /**
+     * The document key this entry points to. This entry is encoded by an ordered
+     * encoder to match the key order of the index.
+     */
+    orderedDocumentKey: Uint8Array;
+    /** The segments of the document key this entry points to. */
+    documentKey: string[];
 }
 /**
  * An object representing a document overlay.

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

@@ -204,9 +204,16 @@ export declare const DbIndexStateSequenceNumberIndexPath: string[];
 /**
  * The key for each index entry consists of the index id and its user id,
  * the encoded array and directional value for the indexed fields as well as
- * the encoded document path for the indexed document.
+ * an ordered and an encoded document path for the indexed document.
  */
-export declare type DbIndexEntryKey = [number, string, Uint8Array, Uint8Array, string];
+export declare type DbIndexEntryKey = [
+    number,
+    string,
+    Uint8Array,
+    Uint8Array,
+    Uint8Array,
+    string[]
+];
 /** Name of the IndexedDb object store. */
 export declare const DbIndexEntryStore = "indexEntries";
 export declare const DbIndexEntryKeyPath: string[];

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

@@ -15,7 +15,8 @@
  * limitations under the License.
  */
 import { Target } from '../core/target';
-import { DocumentKeySet, DocumentMap } from '../model/collections';
+import { DocumentMap } from '../model/collections';
+import { DocumentKey } from '../model/document_key';
 import { FieldIndex, IndexOffset } from '../model/field_index';
 import { ResourcePath } from '../model/path';
 import { IndexManager } from './index_manager';
@@ -30,7 +31,7 @@ export declare class MemoryIndexManager implements IndexManager {
     getCollectionParents(transaction: PersistenceTransaction, collectionId: string): PersistencePromise<ResourcePath[]>;
     addFieldIndex(transaction: PersistenceTransaction, index: FieldIndex): PersistencePromise<void>;
     deleteFieldIndex(transaction: PersistenceTransaction, index: FieldIndex): PersistencePromise<void>;
-    getDocumentsMatchingTarget(transaction: PersistenceTransaction, target: Target): PersistencePromise<DocumentKeySet | null>;
+    getDocumentsMatchingTarget(transaction: PersistenceTransaction, target: Target): PersistencePromise<DocumentKey[] | null>;
     getFieldIndex(transaction: PersistenceTransaction, target: Target): PersistencePromise<FieldIndex | null>;
     getFieldIndexes(transaction: PersistenceTransaction, collectionGroup?: string): PersistencePromise<FieldIndex[]>;
     getNextCollectionGroupToUpdate(transaction: PersistenceTransaction): PersistencePromise<string | null>;

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

@@ -186,6 +186,8 @@ export declare class SimpleDbStore<KeyType extends IDBValidKey, ValueType extend
     loadAll(): PersistencePromise<ValueType[]>;
     /** Loads all elements for the index range from the object store. */
     loadAll(range: IDBKeyRange): PersistencePromise<ValueType[]>;
+    /** Loads all elements ordered by the given index. */
+    loadAll(index: string): PersistencePromise<ValueType[]>;
     /**
      * Loads all elements from the object store that fall into the provided in the
      * index range for the given index.

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

@@ -70,6 +70,12 @@ export declare class FieldIndex {
 export declare function fieldIndexGetArraySegment(fieldIndex: FieldIndex): IndexSegment | undefined;
 /** Returns all directional (ascending/descending) segments for this index. */
 export declare function fieldIndexGetDirectionalSegments(fieldIndex: FieldIndex): IndexSegment[];
+/**
+ * Returns the order of the document key component for the given index.
+ *
+ * PORTING NOTE: This is only used in the Web IndexedDb implementation.
+ */
+export declare function fieldIndexGetKeyOrder(fieldIndex: FieldIndex): IndexKind;
 /**
  * Compares indexes by collection group and segments. Ignores update time and
  * index ID.

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

@@ -17,7 +17,8 @@
 import { Target } from '../../../src/core/target';
 import { IndexManager } from '../../../src/local/index_manager';
 import { Persistence } from '../../../src/local/persistence';
-import { DocumentKeySet, DocumentMap } from '../../../src/model/collections';
+import { DocumentMap } from '../../../src/model/collections';
+import { DocumentKey } from '../../../src/model/document_key';
 import { FieldIndex, IndexOffset } from '../../../src/model/field_index';
 import { ResourcePath } from '../../../src/model/path';
 /**
@@ -34,7 +35,7 @@ export declare class TestIndexManager {
     deleteFieldIndex(index: FieldIndex): Promise<void>;
     getFieldIndexes(collectionGroup?: string): Promise<FieldIndex[]>;
     getFieldIndex(target: Target): Promise<FieldIndex | null>;
-    getDocumentsMatchingTarget(target: Target): Promise<DocumentKeySet | null>;
+    getDocumentsMatchingTarget(target: Target): Promise<DocumentKey[] | null>;
     getNextCollectionGroupToUpdate(): Promise<string | null>;
     updateCollectionGroup(collectionGroup: string, offset: IndexOffset): Promise<void>;
     updateIndexEntries(documents: DocumentMap): Promise<void>;

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

@@ -47,10 +47,6 @@ export declare class TestRemoteDocumentCache {
     getEntries(documentKeys: DocumentKeySet): 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;
-    }>;
     getSize(): Promise<number>;
     newChangeBuffer(options?: {
         trackRemovals: boolean;