@firebase/firestore 3.4.5-2022116201138 → 3.4.5-canary.091e8676f

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # @firebase/firestore
 
-## 3.4.5-2022116201138
+## 3.4.5
 
 ### Patch Changes
 

package/dist/firestore/src/index/index_entry.d.ts

@@ -22,5 +22,11 @@ export declare class IndexEntry {
     readonly arrayValue: Uint8Array;
     readonly directionalValue: Uint8Array;
     constructor(indexId: number, documentKey: DocumentKey, arrayValue: Uint8Array, directionalValue: Uint8Array);
+    /**
+     * Returns an IndexEntry entry that sorts immediately after the current
+     * directional value.
+     */
+    successor(): IndexEntry;
 }
 export declare function indexEntryComparator(left: IndexEntry, right: IndexEntry): number;
+export declare function compareByteArrays(left: Uint8Array, right: Uint8Array): number;

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

@@ -73,9 +73,9 @@ export 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.

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

@@ -39,6 +39,11 @@ export declare class IndexedDbIndexManager implements IndexManager {
      */
     private collectionParentsCache;
     private uid;
+    /**
+     * Maps from a target to its equivalent list of sub-targets. Each sub-target
+     * contains only one term from the target's disjunctive normal form (DNF).
+     */
+    private targetToDnfSubTargets;
     constructor(user: User);
     /**
      * Adds a new entry to the collection parent index.
@@ -51,7 +56,22 @@ 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, fieldIndex: FieldIndex, target: Target): PersistencePromise<DocumentKeySet>;
+    getDocumentsMatchingTarget(transaction: PersistenceTransaction, target: Target): PersistencePromise<DocumentKeySet | null>;
+    private getSubTargets;
+    /**
+     * Constructs a key range query on `DbIndexEntry.store` that unions all
+     * bounds.
+     */
+    private generateIndexRanges;
+    /** Generates the lower bound for `arrayValue` and `directionalValue`. */
+    private generateLowerBound;
+    /** Generates the upper bound for `arrayValue` and `directionalValue`. */
+    private generateUpperBound;
+    /**
+     * Generates an empty bound that scopes the index scan to the current index
+     * and user.
+     */
+    private generateEmptyBound;
     getFieldIndex(transaction: PersistenceTransaction, target: Target): PersistencePromise<FieldIndex | null>;
     /**
      * Returns the byte encoded form of the directional values in the field index.
@@ -61,6 +81,27 @@ export declare class IndexedDbIndexManager implements IndexManager {
     private encodeDirectionalElements;
     /** Encodes a single value to the ascending index format. */
     private encodeSingleElement;
+    /**
+     * Encodes the given field values according to the specification in `target`.
+     * For IN queries, a list of possible values is returned.
+     */
+    private encodeValues;
+    /**
+     * Encodes the given bounds according to the specification in `target`. For IN
+     * queries, a list of possible values is returned.
+     */
+    private encodeBound;
+    /** Returns the byte representation for the provided encoders. */
+    private getEncodedBytes;
+    /**
+     * Creates a separate encoder for each element of an array.
+     *
+     * The method appends each value to all existing encoders (e.g. filter("a",
+     * "==", "a1").filter("b", "in", ["b1", "b2"]) becomes ["a1,b1", "a1,b2"]). A
+     * list of new encoders is returned.
+     */
+    private expandIndexValues;
+    private isInFilter;
     getFieldIndexes(transaction: PersistenceTransaction, collectionGroup?: string): PersistencePromise<FieldIndex[]>;
     getNextCollectionGroupToUpdate(transaction: PersistenceTransaction): PersistencePromise<string | null>;
     updateCollectionGroup(transaction: PersistenceTransaction, collectionGroup: string, offset: IndexOffset): PersistencePromise<void>;
@@ -77,4 +118,10 @@ export declare class IndexedDbIndexManager implements IndexManager {
      */
     private updateEntries;
     private getNextSequenceNumber;
+    /**
+     * Returns a new set of IDB ranges that splits the existing range and excludes
+     * any values that match the `notInValue` from these ranges. As an example,
+     * '[foo > 2 && foo != 3]` becomes  `[foo > 2 && < 3, foo > 3]`.
+     */
+    private createRange;
 }

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

@@ -30,7 +30,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, fieldIndex: FieldIndex, target: Target): PersistencePromise<DocumentKeySet>;
+    getDocumentsMatchingTarget(transaction: PersistenceTransaction, target: Target): PersistencePromise<DocumentKeySet | 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

@@ -182,9 +182,20 @@ export declare class SimpleDbStore<KeyType extends IDBValidKey, ValueType extend
      * Returns the number of rows in the store.
      */
     count(): PersistencePromise<number>;
+    /** Loads all elements from the object store. */
     loadAll(): PersistencePromise<ValueType[]>;
+    /** Loads all elements for the index range from the object store. */
     loadAll(range: IDBKeyRange): PersistencePromise<ValueType[]>;
+    /**
+     * Loads all elements from the object store that fall into the provided in the
+     * index range for the given index.
+     */
     loadAll(index: string, range: IDBKeyRange): PersistencePromise<ValueType[]>;
+    /**
+     * Loads the first `count` elements from the provided index range. Loads all
+     * elements if no limit is provided.
+     */
+    loadFirst(range: IDBKeyRange, count: number | null): PersistencePromise<ValueType[]>;
     deleteAll(): PersistencePromise<void>;
     deleteAll(range: IDBKeyRange): PersistencePromise<void>;
     deleteAll(index: string, range: IDBKeyRange): PersistencePromise<void>;

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

@@ -70,6 +70,8 @@ export declare function fieldIndexGetDirectionalSegments(fieldIndex: FieldIndex)
  * index ID.
  */
 export declare function fieldIndexSemanticComparator(left: FieldIndex, right: FieldIndex): number;
+/** Returns a debug representation of the field index */
+export declare function fieldIndexToString(fieldIndex: FieldIndex): string;
 /** The type of the index, e.g. for which type of query it can be used. */
 export declare const enum IndexKind {
     /**

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

@@ -32,5 +32,6 @@ export declare const enum TypeOrder {
     RefValue = 7,
     GeoPointValue = 8,
     ArrayValue = 9,
-    ObjectValue = 10
+    ObjectValue = 10,
+    MaxValue = 9007199254740991
 }

package/dist/firestore/src/platform/node/base64.d.ts

@@ -14,6 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/** Converts a Base64 encoded string to a binary string. */
 export declare function decodeBase64(encoded: string): string;
 /** Converts a binary string to a Base64 encoded string. */
 export declare function encodeBase64(raw: string): string;

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

@@ -34,7 +34,7 @@ export declare class TestIndexManager {
     deleteFieldIndex(index: FieldIndex): Promise<void>;
     getFieldIndexes(collectionGroup?: string): Promise<FieldIndex[]>;
     getFieldIndex(target: Target): Promise<FieldIndex | null>;
-    getDocumentsMatchingTarget(fieldIndex: FieldIndex, target: Target): Promise<DocumentKeySet>;
+    getDocumentsMatchingTarget(target: Target): Promise<DocumentKeySet | null>;
     getNextCollectionGroupToUpdate(): Promise<string | null>;
     updateCollectionGroup(collectionGroup: string, offset: IndexOffset): Promise<void>;
     updateIndexEntries(documents: DocumentMap): Promise<void>;