@firebase/firestore 3.4.1-2021118224937 → 3.4.1-canary.4c042b2f9

package/CHANGELOG.md

@@ -1,10 +1,12 @@
 # @firebase/firestore
 
-## 3.4.1-2021118224937
+## 3.4.1
 
 ### Patch Changes
 
-- [`8298cf8a9`](https://github.com/firebase/firebase-js-sdk/commit/8298cf8a9343dbba6c628d64941dfbe5d17c44aa) [#5741](https://github.com/firebase/firebase-js-sdk/pull/5741) - fix firestore node tests
+- [`fd8cd3ec4`](https://github.com/firebase/firebase-js-sdk/commit/fd8cd3ec4b7d0747fca258d468ee094573a08bbb) [#5809](https://github.com/firebase/firebase-js-sdk/pull/5809) - Hardcode grpc-js version as a temporary fix for `createRequire` issues in Node CJS.
+
+* [`8298cf8a9`](https://github.com/firebase/firebase-js-sdk/commit/8298cf8a9343dbba6c628d64941dfbe5d17c44aa) [#5741](https://github.com/firebase/firebase-js-sdk/pull/5741) - fix firestore node tests
 
 ## 3.4.0
 

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/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;