@firebase/firestore 3.4.1 → 3.4.2-202205224240

package/dist/lite/index.d.ts

@@ -9,6 +9,7 @@
 import { FirebaseApp } from '@firebase/app';
 import { LogLevelString as LogLevel } from '@firebase/logger';
 import { EmulatorMockTokenOptions } from '@firebase/util';
+import { FirebaseError } from '@firebase/util';
 
 /* Excluded from this release type: AbstractUserDataWriter */
 /**
@@ -22,6 +23,7 @@ import { EmulatorMockTokenOptions } from '@firebase/util';
  *
  * @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.
  */
@@ -552,7 +554,7 @@ export declare interface FirestoreDataConverter<T> {
     fromFirestore(snapshot: QueryDocumentSnapshot<DocumentData>): 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.
      */
@@ -561,28 +563,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:
@@ -961,6 +945,7 @@ export declare function serverTimestamp(): FieldValue;
  *
  * @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.
  */
@@ -978,6 +963,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.
  */
@@ -1004,10 +990,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;
@@ -1241,6 +1229,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;
@@ -1253,6 +1242,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;
@@ -1265,6 +1255,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;
@@ -1280,6 +1271,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;
@@ -1325,6 +1317,7 @@ export declare type UpdateData<T> = T extends Primitive ? T : T extends {} ? {
  * @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.
  */
@@ -1346,6 +1339,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.
  */
@@ -1403,6 +1397,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;
@@ -1415,6 +1410,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;
@@ -1430,6 +1426,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/lite/index.node.cjs.js

@@ -14,7 +14,7 @@ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'defau
 
 var nodeFetch__default = /*#__PURE__*/_interopDefaultLegacy(nodeFetch);
 
-const version$1 = "3.4.1";
+const version$1 = "3.4.2-202205224240";
 
 /**
  * @license
@@ -67,7 +67,7 @@ User.GOOGLE_CREDENTIALS = new User('google-credentials-uid');
 User.FIRST_PARTY = new User('first-party-uid');
 User.MOCK_USER = new User('mock-user');
 
-const version = "9.6.1";
+const version = "9.6.2-202205224240";
 
 /**
  * @license
@@ -368,7 +368,7 @@ const Code = {
     DATA_LOSS: 'data-loss'
 };
 /** An error returned by a Firestore operation. */
-class FirestoreError extends Error {
+class FirestoreError extends util.FirebaseError {
     /** @hideconstructor */
     constructor(
     /**
@@ -379,11 +379,9 @@ class FirestoreError extends Error {
      * A custom error description.
      */
     message) {
-        super(message);
+        super(code, message);
         this.code = code;
         this.message = message;
-        /** The custom name for all FirestoreErrors. */
-        this.name = 'FirebaseError';
         // HACK: We write a toString property directly because Error is not a real
         // class and so inheritance does not work correctly. We could alternatively
         // do the same "back-door inheritance" trick that FirebaseError does.
@@ -1924,6 +1922,19 @@ class ByteString {
         const binaryString = binaryStringFromUint8Array(array);
         return new ByteString(binaryString);
     }
+    [Symbol.iterator]() {
+        let i = 0;
+        return {
+            next: () => {
+                if (i < this.binaryString.length) {
+                    return { value: this.binaryString.charCodeAt(i++), done: false };
+                }
+                else {
+                    return { value: undefined, done: true };
+                }
+            }
+        };
+    }
     toBase64() {
         return encodeBase64(this.binaryString);
     }
@@ -2203,6 +2214,9 @@ function typeOrder(value) {
 }
 /** Tests `left` and `right` for equality based on the backend semantics. */
 function valueEquals(left, right) {
+    if (left === right) {
+        return true;
+    }
     const leftType = typeOrder(left);
     const rightType = typeOrder(right);
     if (leftType !== rightType) {
@@ -2293,6 +2307,9 @@ function arrayValueContains(haystack, needle) {
     return ((haystack.values || []).find(v => valueEquals(v, needle)) !== undefined);
 }
 function valueCompare(left, right) {
+    if (left === right) {
+        return 0;
+    }
     const leftType = typeOrder(left);
     const rightType = typeOrder(right);
     if (leftType !== rightType) {
@@ -2733,7 +2750,7 @@ class MutableDocument {
             this.documentState === other.documentState &&
             this.data.isEqual(other.data));
     }
-    clone() {
+    mutableCopy() {
         return new MutableDocument(this.key, this.documentType, this.version, this.data.clone(), this.documentState);
     }
     toString() {
@@ -6711,6 +6728,7 @@ function deleteDoc(reference) {
  *
  * @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.
  */