@firebase/firestore 3.4.1 → 3.4.2-202205224240

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @firebase/firestore
 
+## 3.4.2-202205224240
+
+### Patch Changes
+
+- [`3b481f572`](https://github.com/firebase/firebase-js-sdk/commit/3b481f572456e1eab3435bfc25717770d95a8c49) [#5831](https://github.com/firebase/firebase-js-sdk/pull/5831) (fixes [#5754](https://github.com/firebase/firebase-js-sdk/issues/5754)) - FirestoreError and StorageError now extend FirebaseError
+
+* [`7f05d22e8`](https://github.com/firebase/firebase-js-sdk/commit/7f05d22e827f1fd0732ad33fda203a20566d3964) [#5835](https://github.com/firebase/firebase-js-sdk/pull/5835) - Fixed an issue that can cause incomplete Query snapshots when the SDK is backgrounded during query execution.
+
+* Updated dependencies [[`3b481f572`](https://github.com/firebase/firebase-js-sdk/commit/3b481f572456e1eab3435bfc25717770d95a8c49)]:
+  - @firebase/util@1.4.3-202205224240
+  - @firebase/app@0.7.12-202205224240
+  - @firebase/component@0.5.10-202205224240
+
 ## 3.4.1
 
 ### Patch Changes

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

@@ -0,0 +1,24 @@
+/**
+ * @license
+ * Copyright 2021 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 { ByteString } from '../util/byte_string';
+/** An index value encoder.  */
+export interface DirectionalIndexByteEncoder {
+    writeBytes(value: ByteString): void;
+    writeString(value: string): void;
+    writeNumber(value: number): void;
+    writeInfinity(): void;
+}

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

@@ -0,0 +1,33 @@
+/**
+ * @license
+ * Copyright 2021 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 { Value } from '../protos/firestore_proto_api';
+import { DirectionalIndexByteEncoder } from './directional_index_byte_encoder';
+/** Firestore index value writer.  */
+export declare class FirestoreIndexValueWriter {
+    static INSTANCE: FirestoreIndexValueWriter;
+    private constructor();
+    /** Writes an index value.  */
+    writeIndexValue(value: Value, encoder: DirectionalIndexByteEncoder): void;
+    private writeIndexValueAux;
+    private writeIndexString;
+    private writeUnlabeledIndexString;
+    private writeIndexMap;
+    private writeIndexArray;
+    private writeIndexEntityRef;
+    private writeValueTypeLabel;
+    private writeTruncationMarker;
+}

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

@@ -0,0 +1,14 @@
+import { DirectionalIndexByteEncoder } from './directional_index_byte_encoder';
+/**
+ * Implements `DirectionalIndexByteEncoder` using `OrderedCodeWriter` for the
+ * actual encoding.
+ */
+export declare class IndexByteEncoder {
+    private orderedCode;
+    private ascending;
+    private descending;
+    seed(encodedBytes: Uint8Array): void;
+    forKind(kind: 'asc' | 'desc'): DirectionalIndexByteEncoder;
+    encodedBytes(): Uint8Array;
+    reset(): void;
+}

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

@@ -0,0 +1,60 @@
+import { ByteString } from '../util/byte_string';
+/**
+ * Counts the number of zeros in a byte.
+ *
+ * Visible for testing.
+ */
+export declare function numberOfLeadingZerosInByte(x: number): number;
+/**
+ * OrderedCodeWriter is a minimal-allocation implementation of the writing
+ * behavior defined by the backend.
+ *
+ * The code is ported from its Java counterpart.
+ */
+export declare class OrderedCodeWriter {
+    buffer: Uint8Array;
+    position: number;
+    writeBytesAscending(value: ByteString): void;
+    writeBytesDescending(value: ByteString): void;
+    /** Writes utf8 bytes into this byte sequence, ascending. */
+    writeUtf8Ascending(sequence: string): void;
+    /** Writes utf8 bytes into this byte sequence, descending */
+    writeUtf8Descending(sequence: string): void;
+    writeNumberAscending(val: number): void;
+    writeNumberDescending(val: number): void;
+    /**
+     * Writes the "infinity" byte sequence that sorts after all other byte
+     * sequences written in ascending order.
+     */
+    writeInfinityAscending(): void;
+    /**
+     * Writes the "infinity" byte sequence that sorts before all other byte
+     * sequences written in descending order.
+     */
+    writeInfinityDescending(): void;
+    /**
+     * Resets the buffer such that it is the same as when it was newly
+     * constructed.
+     */
+    reset(): void;
+    seed(encodedBytes: Uint8Array): void;
+    /** Makes a copy of the encoded bytes in this buffer.  */
+    encodedBytes(): Uint8Array;
+    /**
+     * Encodes `val` into an encoding so that the order matches the IEEE 754
+     * floating-point comparison results with the following exceptions:
+     *   -0.0 < 0.0
+     *   all non-NaN < NaN
+     *   NaN = NaN
+     */
+    private toOrderedBits;
+    /** Writes a single byte ascending to the buffer. */
+    private writeByteAscending;
+    /** Writes a single byte descending to the buffer.  */
+    private writeByteDescending;
+    private writeSeparatorAscending;
+    private writeSeparatorDescending;
+    private writeEscapedByteAscending;
+    private writeEscapedByteDescending;
+    private ensureAvailable;
+}

package/dist/firestore/src/lite-api/reference.d.ts

@@ -61,10 +61,12 @@ export declare type UpdateData<T> = T extends Primitive ? T : T extends {} ? {
  *
  * @param merge - Changes the behavior of a `setDoc()` call to only replace the
  * values specified in its data argument. Fields omitted from the `setDoc()`
- * call remain untouched.
+ * call remain untouched. If your input sets any field to an empty map, all
+ * nested fields are overwritten.
  * @param mergeFields - Changes the behavior of `setDoc()` calls to only replace
  * the specified field paths. Any field path that is not specified is ignored
- * and remains untouched.
+ * and remains untouched. If your input sets any field to an empty map, all
+ * nested fields are overwritten.
  */
 export declare type SetOptions = {
     readonly merge?: boolean;

package/dist/firestore/src/lite-api/reference_impl.d.ts

@@ -77,6 +77,7 @@ export declare function getDocs<T>(query: Query<T>): Promise<QuerySnapshot<T>>;
  *
  * @param reference - A reference to the document to write.
  * @param data - A map of the fields and values for the document.
+ * @throws Error - If the provided input is not a valid Firestore document.
  * @returns A `Promise` resolved once the data has been successfully written
  * to the backend.
  */
@@ -94,6 +95,7 @@ export declare function setDoc<T>(reference: DocumentReference<T>, data: WithFie
  * @param reference - A reference to the document to write.
  * @param data - A map of the fields and values for the document.
  * @param options - An object to configure the set behavior.
+ * @throws Error - If the provided input is not a valid Firestore document.
  * @returns A `Promise` resolved once the data has been successfully written
  * to the backend.
  */
@@ -112,6 +114,7 @@ export declare function setDoc<T>(reference: DocumentReference<T>, data: Partial
  * @param data - An object containing the fields and values with which to
  * update the document. Fields can contain dots to reference nested fields
  * within the document.
+ * @throws Error - If the provided input is not valid Firestore data.
  * @returns A `Promise` resolved once the data has been successfully written
  * to the backend.
  */
@@ -133,6 +136,7 @@ export declare function updateDoc<T>(reference: DocumentReference<T>, data: Upda
  * @param field - The first field to update.
  * @param value - The first value.
  * @param moreFieldsAndValues - Additional key value pairs.
+ * @throws Error - If the provided input is not valid Firestore data.
  * @returns A `Promise` resolved once the data has been successfully written
  * to the backend.
  */
@@ -161,6 +165,7 @@ export declare function deleteDoc(reference: DocumentReference<unknown>): Promis
  *
  * @param reference - A reference to the collection to add this document to.
  * @param data - An Object containing the data for the new document.
+ * @throws Error - If the provided input is not a valid Firestore document.
  * @returns A `Promise` resolved with a `DocumentReference` pointing to the
  * newly created document after it has been written to the backend.
  */

package/dist/firestore/src/lite-api/transaction.d.ts

@@ -45,6 +45,7 @@ export declare class Transaction {
      *
      * @param documentRef - A reference to the document to be set.
      * @param data - An object of the fields and values for the document.
+     * @throws Error - If the provided input is not a valid Firestore document.
      * @returns This `Transaction` instance. Used for chaining method calls.
      */
     set<T>(documentRef: DocumentReference<T>, data: WithFieldValue<T>): this;
@@ -57,6 +58,7 @@ export declare class Transaction {
      * @param documentRef - A reference to the document to be set.
      * @param data - An object of the fields and values for the document.
      * @param options - An object to configure the set behavior.
+     * @throws Error - If the provided input is not a valid Firestore document.
      * @returns This `Transaction` instance. Used for chaining method calls.
      */
     set<T>(documentRef: DocumentReference<T>, data: PartialWithFieldValue<T>, options: SetOptions): this;
@@ -69,6 +71,7 @@ export declare class Transaction {
      * @param data - An object containing the fields and values with which to
      * update the document. Fields can contain dots to reference nested fields
      * within the document.
+     * @throws Error - If the provided input is not valid Firestore data.
      * @returns This `Transaction` instance. Used for chaining method calls.
      */
     update<T>(documentRef: DocumentReference<T>, data: UpdateData<T>): this;
@@ -84,6 +87,7 @@ export declare class Transaction {
      * @param field - The first field to update.
      * @param value - The first value.
      * @param moreFieldsAndValues - Additional key/value pairs.
+     * @throws Error - If the provided input is not valid Firestore data.
      * @returns This `Transaction` instance. Used for chaining method calls.
      */
     update(documentRef: DocumentReference<unknown>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): this;

package/dist/firestore/src/lite-api/write_batch.d.ts

@@ -53,6 +53,7 @@ export declare class WriteBatch {
      * @param documentRef - A reference to the document to be set.
      * @param data - An object of the fields and values for the document.
      * @param options - An object to configure the set behavior.
+     * @throws Error - If the provided input is not a valid Firestore document.
      * @returns This `WriteBatch` instance. Used for chaining method calls.
      */
     set<T>(documentRef: DocumentReference<T>, data: PartialWithFieldValue<T>, options: SetOptions): WriteBatch;
@@ -65,6 +66,7 @@ export declare class WriteBatch {
      * @param data - An object containing the fields and values with which to
      * update the document. Fields can contain dots to reference nested fields
      * within the document.
+     * @throws Error - If the provided input is not valid Firestore data.
      * @returns This `WriteBatch` instance. Used for chaining method calls.
      */
     update<T>(documentRef: DocumentReference<T>, data: UpdateData<T>): WriteBatch;
@@ -80,6 +82,7 @@ export declare class WriteBatch {
      * @param field - The first field to update.
      * @param value - The first value.
      * @param moreFieldsAndValues - Additional key value pairs.
+     * @throws Error - If the provided input is not valid Firestore data.
      * @returns This `WriteBatch` instance. Used for chaining method calls.
      */
     update(documentRef: DocumentReference<unknown>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): WriteBatch;

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

@@ -16,11 +16,16 @@
  */
 import { SnapshotVersion } from '../core/snapshot_version';
 import { MutableDocumentMap } from '../model/collections';
+import { MutableDocument } from '../model/document';
 import { IndexManager } from './index_manager';
 import { LocalSerializer } from './local_serializer';
 import { PersistencePromise } from './persistence_promise';
 import { PersistenceTransaction } from './persistence_transaction';
 import { RemoteDocumentCache } from './remote_document_cache';
+export interface DocumentSizeEntry {
+    document: MutableDocument;
+    size: number;
+}
 export interface IndexedDbRemoteDocumentCache extends RemoteDocumentCache {
 }
 /**

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

@@ -21,10 +21,6 @@ import { SortedSet } from '../util/sorted_set';
 import { Document, MutableDocument } from './document';
 import { DocumentKey } from './document_key';
 /** Miscellaneous collection types / constants. */
-export interface DocumentSizeEntry {
-    document: MutableDocument;
-    size: number;
-}
 export declare type MutableDocumentMap = SortedMap<DocumentKey, MutableDocument>;
 export declare function mutableDocumentMap(): MutableDocumentMap;
 export interface DocumentSizeEntries {

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

@@ -61,6 +61,8 @@ export interface Document {
      */
     isUnknownDocument(): boolean;
     isEqual(other: Document | null | undefined): boolean;
+    /** Creates a mutable copy of this document. */
+    mutableCopy(): MutableDocument;
     toString(): string;
 }
 /**
@@ -124,7 +126,7 @@ export declare class MutableDocument implements Document {
     isNoDocument(): boolean;
     isUnknownDocument(): boolean;
     isEqual(other: Document | null | undefined): boolean;
-    clone(): MutableDocument;
+    mutableCopy(): MutableDocument;
     toString(): string;
 }
 /**

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

@@ -18,6 +18,7 @@ import { DatabaseId } from '../core/database_info';
 import { ArrayValue, MapValue, Value } from '../protos/firestore_proto_api';
 import { DocumentKey } from './document_key';
 import { TypeOrder } from './type_order';
+export declare const MAX_VALUE: Value;
 /** Extracts the backend's type order for the provided value. */
 export declare function typeOrder(value: Value): TypeOrder;
 /** Tests `left` and `right` for equality based on the backend semantics. */
@@ -73,3 +74,5 @@ export declare function isMapValue(value?: Value | null): value is {
 };
 /** Creates a deep copy of `source`. */
 export declare function deepClone(source: Value): Value;
+/** Returns true if the Value represents the canonical {@link #MAX_VALUE} . */
+export declare function isMaxValue(value: Value): boolean;

package/dist/firestore/src/util/byte_string.d.ts

@@ -29,6 +29,7 @@ export declare class ByteString {
     private constructor();
     static fromBase64String(base64: string): ByteString;
     static fromUint8Array(array: Uint8Array): ByteString;
+    [Symbol.iterator](): Iterator<number>;
     toBase64(): string;
     toUint8Array(): Uint8Array;
     approximateByteSize(): number;

package/dist/firestore/src/util/error.d.ts

@@ -14,6 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { FirebaseError } from '@firebase/util';
 /**
  * The set of Firestore status codes. The codes are the same at the ones
  * exposed by gRPC here:
@@ -170,7 +171,7 @@ export declare const Code: {
     DATA_LOSS: FirestoreErrorCode;
 };
 /** An error returned by a Firestore operation. */
-export declare class FirestoreError extends Error {
+export declare class FirestoreError extends FirebaseError {
     /**
      * The backend error code associated with this error.
      */
@@ -179,8 +180,6 @@ export declare class FirestoreError extends Error {
      * A custom error description.
      */
     readonly message: string;
-    /** The custom name for all FirestoreErrors. */
-    readonly name: string;
     /** The stack of the error. */
     readonly stack?: string;
     /** @hideconstructor */

package/dist/firestore/test/unit/index/ordered_code_writer.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -71,6 +71,7 @@ export declare function bound(values: Array<[string, {}, firestore.OrderByDirect
 export declare function query(resourcePath: string, ...constraints: Array<OrderBy | Filter>): Query;
 export declare function targetData(targetId: TargetId, queryPurpose: TargetPurpose, path: string): TargetData;
 export declare function noChangeEvent(targetId: number, snapshotVersion: number, resumeToken?: ByteString): RemoteEvent;
+export declare function existenceFilterEvent(targetId: number, count: number, snapshotVersion: number): RemoteEvent;
 export declare function docAddedRemoteEvent(docOrDocs: MutableDocument | MutableDocument[], updatedInTargets?: TargetId[], removedFromTargets?: TargetId[], activeTargets?: TargetId[]): RemoteEvent;
 export declare function docUpdateRemoteEvent(doc: MutableDocument, updatedInTargets?: TargetId[], removedFromTargets?: TargetId[], limboTargets?: TargetId[]): RemoteEvent;
 export declare class TestBundledDocuments {

package/dist/index.d.ts

@@ -6,6 +6,7 @@
 import { FirebaseApp } from '@firebase/app';
 import { LogLevelString as LogLevel } from '@firebase/logger';
 import { EmulatorMockTokenOptions } from '@firebase/util';
+import { FirebaseError } from '@firebase/util';
 
 /**
  * Add a new document to specified `CollectionReference` with the given data,
@@ -684,7 +685,7 @@ export declare interface FirestoreDataConverter<T> {
     fromFirestore(snapshot: QueryDocumentSnapshot<DocumentData>, options?: SnapshotOptions): T;
 }
 /** An error returned by a Firestore operation. */
-export declare class FirestoreError extends Error {
+export declare class FirestoreError extends FirebaseError {
     /**
      * The backend error code associated with this error.
      */
@@ -693,28 +694,10 @@ export declare class FirestoreError extends Error {
      * A custom error description.
      */
     readonly message: string;
-    /** The custom name for all FirestoreErrors. */
-    readonly name: string;
     /** The stack of the error. */
     readonly stack?: string;
     private constructor();
 }
-/**
- * @license
- * Copyright 2017 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.
- */
 /**
  * The set of Firestore status codes. The codes are the same at the ones
  * exposed by gRPC here:
@@ -1504,10 +1487,12 @@ export declare function setLogLevel(logLevel: LogLevel): void;
  *
  * @param merge - Changes the behavior of a `setDoc()` call to only replace the
  * values specified in its data argument. Fields omitted from the `setDoc()`
- * call remain untouched.
+ * call remain untouched. If your input sets any field to an empty map, all
+ * nested fields are overwritten.
  * @param mergeFields - Changes the behavior of `setDoc()` calls to only replace
  * the specified field paths. Any field path that is not specified is ignored
- * and remains untouched.
+ * and remains untouched. If your input sets any field to an empty map, all
+ * nested fields are overwritten.
  */
 export declare type SetOptions = {
     readonly merge?: boolean;
@@ -1797,6 +1782,7 @@ export declare class Transaction {
      * 
      * @param documentRef - A reference to the document to be set.
      * @param data - An object of the fields and values for the document.
+     * @throws Error - If the provided input is not a valid Firestore document.
      * @returns This `Transaction` instance. Used for chaining method calls.
      */
     set<T>(documentRef: DocumentReference<T>, data: WithFieldValue<T>): this;
@@ -1809,6 +1795,7 @@ export declare class Transaction {
      * @param documentRef - A reference to the document to be set.
      * @param data - An object of the fields and values for the document.
      * @param options - An object to configure the set behavior.
+     * @throws Error - If the provided input is not a valid Firestore document.
      * @returns This `Transaction` instance. Used for chaining method calls.
      */
     set<T>(documentRef: DocumentReference<T>, data: PartialWithFieldValue<T>, options: SetOptions): this;
@@ -1821,6 +1808,7 @@ export declare class Transaction {
      * @param data - An object containing the fields and values with which to
 update the document. Fields can contain dots to reference nested fields
 within the document.
+     * @throws Error - If the provided input is not valid Firestore data.
      * @returns This `Transaction` instance. Used for chaining method calls.
      */
     update<T>(documentRef: DocumentReference<T>, data: UpdateData<T>): this;
@@ -1836,6 +1824,7 @@ within the document.
      * @param field - The first field to update.
      * @param value - The first value.
      * @param moreFieldsAndValues - Additional key/value pairs.
+     * @throws Error - If the provided input is not valid Firestore data.
      * @returns This `Transaction` instance. Used for chaining method calls.
      */
     update(documentRef: DocumentReference<unknown>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): this;
@@ -1973,6 +1962,7 @@ export declare class WriteBatch {
      * @param documentRef - A reference to the document to be set.
      * @param data - An object of the fields and values for the document.
      * @param options - An object to configure the set behavior.
+     * @throws Error - If the provided input is not a valid Firestore document.
      * @returns This `WriteBatch` instance. Used for chaining method calls.
      */
     set<T>(documentRef: DocumentReference<T>, data: PartialWithFieldValue<T>, options: SetOptions): WriteBatch;
@@ -1985,6 +1975,7 @@ export declare class WriteBatch {
      * @param data - An object containing the fields and values with which to
      * update the document. Fields can contain dots to reference nested fields
      * within the document.
+     * @throws Error - If the provided input is not valid Firestore data.
      * @returns This `WriteBatch` instance. Used for chaining method calls.
      */
     update<T>(documentRef: DocumentReference<T>, data: UpdateData<T>): WriteBatch;
@@ -2000,6 +1991,7 @@ export declare class WriteBatch {
      * @param field - The first field to update.
      * @param value - The first value.
      * @param moreFieldsAndValues - Additional key value pairs.
+     * @throws Error - If the provided input is not valid Firestore data.
      * @returns This `WriteBatch` instance. Used for chaining method calls.
      */
     update(documentRef: DocumentReference<unknown>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): WriteBatch;