@firebase/firestore 3.4.1-canary.31db4b706 → 3.4.1-canary.3d8109ca3

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,14 @@
+import { ByteString } from '../util/byte_string';
+export declare class OrderedCodeWriter {
+    writeBytesAscending(value: ByteString): void;
+    writeBytesDescending(value: ByteString): void;
+    writeUtf8Ascending(sequence: string): void;
+    writeUtf8Descending(sequence: string): void;
+    writeNumberAscending(val: number): void;
+    writeNumberDescending(val: number): void;
+    writeInfinityAscending(): void;
+    writeInfinityDescending(): void;
+    reset(): void;
+    encodedBytes(): Uint8Array;
+    seed(encodedBytes: Uint8Array): void;
+}

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/index.d.ts

@@ -1504,10 +1504,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 +1799,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 +1812,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 +1825,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 +1841,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 +1979,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 +1992,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 +2008,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/index.esm2017.js

@@ -66,7 +66,7 @@ D.MOCK_USER = new D("mock-user");
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-let C = "9.6.1-canary.31db4b706";
+let C = "9.6.1-canary.3d8109ca3";
 
 /**
  * @license
@@ -1524,6 +1524,7 @@ function Pt(t) {
 }
 
 /** Tests `left` and `right` for equality based on the backend semantics. */ function Ct(t, e) {
+    if (t === e) return !0;
     const n = Dt(t);
     if (n !== Dt(e)) return !1;
     switch (n) {
@@ -1593,6 +1594,7 @@ function Nt(t, e) {
 }
 
 function kt(t, e) {
+    if (t === e) return 0;
     const n = Dt(t), s = Dt(e);
     if (n !== s) return it(n, s);
     switch (n) {
@@ -1997,7 +1999,7 @@ function Lt(t) {
     isEqual(t) {
         return t instanceof Wt && this.key.isEqual(t.key) && this.version.isEqual(t.version) && this.documentType === t.documentType && this.documentState === t.documentState && this.data.isEqual(t.data);
     }
-    clone() {
+    mutableCopy() {
         return new Wt(this.key, this.documentType, this.version, this.data.clone(), this.documentState);
     }
     toString() {
@@ -9669,7 +9671,7 @@ class Cr {
      */    addEntry(t, e, n) {
         const s = e.key, i = this.docs.get(s), r = i ? i.size : 0, o = this.Ts(e);
         return this.docs = this.docs.insert(s, {
-            document: e.clone(),
+            document: e.mutableCopy(),
             size: o,
             readTime: n
         }), this.size += o - r, this.Jt.addToCollectionParentIndex(t, s.path.popLast());
@@ -9685,13 +9687,13 @@ class Cr {
     }
     getEntry(t, e) {
         const n = this.docs.get(e);
-        return Gs.resolve(n ? n.document.clone() : Wt.newInvalidDocument(e));
+        return Gs.resolve(n ? n.document.mutableCopy() : Wt.newInvalidDocument(e));
     }
     getEntries(t, e) {
         let n = An();
         return e.forEach((t => {
             const e = this.docs.get(t);
-            n = n.insert(t, e ? e.document.clone() : Wt.newInvalidDocument(t));
+            n = n.insert(t, e ? e.document.mutableCopy() : Wt.newInvalidDocument(t));
         })), Gs.resolve(n);
     }
     getDocumentsMatchingQuery(t, e, n) {
@@ -9702,7 +9704,7 @@ class Cr {
         for (;r.hasNext(); ) {
             const {key: t, value: {document: i, readTime: o}} = r.getNext();
             if (!e.path.isPrefixOf(t.path)) break;
-            o.compareTo(n) <= 0 || Se(e, i) && (s = s.insert(i.key, i.clone()));
+            o.compareTo(n) <= 0 || Se(e, i) && (s = s.insert(i.key, i.mutableCopy()));
         }
         return Gs.resolve(s);
     }
@@ -17832,9 +17834,9 @@ function Ih(t, e) {
         return n = Object.assign({
             useFetchStreams: e
         }, n), i._setSettings(n), i;
-    }), "PUBLIC")), registerVersion(S, "3.4.1-canary.31db4b706", t), 
+    }), "PUBLIC")), registerVersion(S, "3.4.1-canary.3d8109ca3", t), 
     // BUILD_TARGET will be replaced by values like esm5, esm2017, cjs5, etc during the compilation
-    registerVersion(S, "3.4.1-canary.31db4b706", "esm2017");
+    registerVersion(S, "3.4.1-canary.3d8109ca3", "esm2017");
 }();
 
 export { rh as AbstractUserDataWriter, eu as Bytes, Fc as CACHE_SIZE_UNLIMITED, vc as CollectionReference, bc as DocumentReference, xu as DocumentSnapshot, Zc as FieldPath, nu as FieldValue, Oc as Firestore, j as FirestoreError, su as GeoPoint, $c as LoadBundleTask, Pc as Query, Bu as QueryConstraint, $u as QueryDocumentSnapshot, Fu as QuerySnapshot, ku as SnapshotMetadata, at as Timestamp, bh as Transaction, ch as WriteBatch, dc as _DatabaseId, St as _DocumentKey, tt as _EmptyAppCheckTokenProvider, G as _EmptyAuthCredentialsProvider, _t as _FieldPath, Tc as _cast, U as _debugAssert, gt as _isBase64Available, O as _logWarn, mc as _validateIsNotUsedTogether, Th as addDoc, Dh as arrayRemove, Sh as arrayUnion, Qc as clearIndexedDbPersistence, Vc as collection, Sc as collectionGroup, Rc as connectFirestoreEmulator, ph as deleteDoc, vh as deleteField, zc as disableNetwork, Dc as doc, tu as documentId, qc as enableIndexedDbPersistence, Kc as enableMultiTabIndexedDbPersistence, Gc as enableNetwork, th as endAt, Zu as endBefore, Bc as ensureFirestoreConfigured, Ah as executeWrite, hh as getDoc, fh as getDocFromCache, dh as getDocFromServer, wh as getDocs, _h as getDocsFromCache, mh as getDocsFromServer, Lc as getFirestore, Ch as increment, Mc as initializeFirestore, Gu as limit, zu as limitToLast, Jc as loadBundle, Yc as namedQuery, Eh as onSnapshot, Ih as onSnapshotsInSync, Qu as orderBy, Uu as query, Nc as queryEqual, Cc as refEqual, Ph as runTransaction, Vh as serverTimestamp, gh as setDoc, x as setLogLevel, Mu as snapshotEqual, Yu as startAfter, Ju as startAt, Hc as terminate, yh as updateDoc, Wc as waitForPendingWrites, Ku as where, Nh as writeBatch };