@google-cloud/firestore - npm Package Compare versions

Comparing version 5.0.1 to 5.0.2

build/src/bulk-writer.d.ts

@@ -246,2 +246,3 @@ /*!
      * @param {T} data The object to serialize as the document.
+     * @throws {Error} If the provided input is not a valid Firestore document.
      * @returns {Promise<WriteResult>} A promise that resolves with the result of
@@ -324,2 +325,3 @@ * the write. If the write fails, the promise is rejected with a
      * restrict this update
+     * @throws {Error} If the provided input is not valid Firestore data.
      * @returns {Promise<WriteResult>} A promise that resolves with the result of
@@ -326,0 +328,0 @@ * the write. If the write fails, the promise is rejected with a

build/src/bulk-writer.js

@@ -402,2 +402,3 @@ "use strict";
      * @param {T} data The object to serialize as the document.
+     * @throws {Error} If the provided input is not a valid Firestore document.
      * @returns {Promise<WriteResult>} A promise that resolves with the result of
@@ -471,8 +472,11 @@ * the write. If the write fails, the promise is rejected with a
      * @param {SetOptions=} options An object to configure the set behavior.
+     * @throws {Error} If the provided input is not a valid Firestore document.
      * @param {boolean=} options.merge - If true, set() merges the values
      * specified in its data argument. Fields omitted from this set() call remain
-     * untouched.
+     * untouched. If your input sets any field to an empty map, all nested fields
+     * are overwritten.
      * @param {Array.<string|FieldPath>=} options.mergeFields - If provided, set()
      * only replaces the specified field paths. Any field path that is not
-     * specified is ignored and remains untouched.
+     * specified is ignored and remains untouched. If your input sets any field to
+     * an empty map, all nested fields are overwritten.
      * @returns {Promise<WriteResult>} A promise that resolves with the result of
@@ -533,2 +537,3 @@ * the write. If the write fails, the promise is rejected with a
      * restrict this update
+     * @throws {Error} If the provided input is not valid Firestore data.
      * @returns {Promise<WriteResult>} A promise that resolves with the result of
@@ -535,0 +540,0 @@ * the write. If the write fails, the promise is rejected with a

build/src/reference.d.ts

@@ -213,2 +213,3 @@ /*!
      * serialize as the document.
+     * @throws {Error} If the provided input is not a valid Firestore document.
      * @returns {Promise.<WriteResult>} A Promise that resolves with the
@@ -276,2 +277,3 @@ * write time of this create.
      * this update.
+     * @throws {Error} If the provided input is not valid Firestore data.
      * @returns {Promise.<WriteResult>} A Promise that resolves once the
@@ -395,2 +397,3 @@ * data has been successfully written to the backend.
     toProto(): api.StructuredQuery.IFilter;
+    isEqual(other: FieldFilter): boolean;
 }
@@ -641,2 +644,3 @@ /**
     isEqual(other: QueryOptions<T>): boolean;
+    private fieldFiltersEqual;
 }
@@ -1205,2 +1209,3 @@ /**
      * document.
+     * @throws {Error} If the provided input is not a valid Firestore document.
      * @returns {Promise.<DocumentReference>} A Promise resolved with a
@@ -1207,0 +1212,0 @@ * [DocumentReference]{@link DocumentReference} pointing to the

build/src/transaction.d.ts

@@ -139,2 +139,3 @@ /*!
      * to to enforce on this update.
+     * @throws {Error} If the provided input is not valid Firestore data.
      * @returns {Transaction} This Transaction instance. Used for
@@ -141,0 +142,0 @@ * chaining method calls.

build/src/transaction.js

@@ -169,7 +169,10 @@ "use strict";
      * @param {boolean=} options.merge - If true, set() merges the values
-     * specified in its data argument. Fields omitted from this set() call
-     * remain untouched.
+     * specified in its data argument. Fields omitted from this set() call remain
+     * untouched. If your input sets any field to an empty map, all nested fields
+     * are overwritten.
      * @param {Array.<string|FieldPath>=} options.mergeFields - If provided,
      * set() only replaces the specified field paths. Any field path that is not
-     * specified is ignored and remains untouched.
+     * specified is ignored and remains untouched. If your input sets any field to
+     * an empty map, all nested fields are overwritten.
+     * @throws {Error} If the provided input is not a valid Firestore document.
      * @returns {Transaction} This Transaction instance. Used for
@@ -219,2 +222,3 @@ * chaining method calls.
      * to to enforce on this update.
+     * @throws {Error} If the provided input is not valid Firestore data.
      * @returns {Transaction} This Transaction instance. Used for
@@ -221,0 +225,0 @@ * chaining method calls.

build/src/write-batch.d.ts

@@ -119,2 +119,3 @@ /*!
      * @param {T} data The object to serialize as the document.
+     * @throws {Error} If the provided input is not a valid Firestore document.
      * @returns {WriteBatch} This WriteBatch instance. Used for chaining
@@ -189,2 +190,3 @@ * method calls.
      * to restrict this update.
+     * @throws {Error} If the provided input is not valid Firestore data.
      * @returns {WriteBatch} This WriteBatch instance. Used for chaining
@@ -191,0 +193,0 @@ * method calls.

build/src/write-batch.js

@@ -132,2 +132,3 @@ "use strict";
      * @param {T} data The object to serialize as the document.
+     * @throws {Error} If the provided input is not a valid Firestore document.
      * @returns {WriteBatch} This WriteBatch instance. Used for chaining
@@ -223,6 +224,9 @@ * method calls.
      * specified in its data argument. Fields omitted from this set() call
-     * remain untouched.
+     * remain untouched. If your input sets any field to an empty map, all nested
+     * fields are overwritten.
      * @param {Array.<string|FieldPath>=} options.mergeFields - If provided,
-     * set() only replaces the specified field paths. Any field path that is not
-     * specified is ignored and remains untouched.
+     * set() only replaces the specified field paths. Any field path that is no
+     * specified is ignored and remains untouched. If your input sets any field to
+     * an empty map, all nested fields are overwritten.
+     * @throws {Error} If the provided input is not a valid Firestore document.
      * @returns {WriteBatch} This WriteBatch instance. Used for chaining
@@ -311,2 +315,3 @@ * method calls.
      * to restrict this update.
+     * @throws {Error} If the provided input is not valid Firestore data.
      * @returns {WriteBatch} This WriteBatch instance. Used for chaining
@@ -313,0 +318,0 @@ * method calls.

CHANGELOG.md

@@ -7,2 +7,9 @@ # Changelog
 
+### [5.0.2](https://www.github.com/googleapis/nodejs-firestore/compare/v5.0.1...v5.0.2) (2022-01-07)
+
+
+### Bug Fixes
+
+* remove serializer check from Query.isEqual() ([#1654](https://www.github.com/googleapis/nodejs-firestore/issues/1654)) ([f13da18](https://www.github.com/googleapis/nodejs-firestore/commit/f13da184bd2b4f9abfe920f6d9f7af8f2f6f37cb))
+
 ### [5.0.1](https://www.github.com/googleapis/nodejs-firestore/compare/v5.0.0...v5.0.1) (2021-12-02)
@@ -9,0 +16,0 @@

package.json

 {
   "name": "@google-cloud/firestore",
   "description": "Firestore Client Library for Node.js",
-  "version": "5.0.1",
+  "version": "5.0.2",
   "license": "Apache-2.0",
@@ -6,0 +6,0 @@ "author": "Google Inc.",

README.md

@@ -7,5 +7,4 @@ [//]: # "This README.md file is auto-generated, all changes to this file will be lost."
 
-[![release level](https://img.shields.io/badge/release%20level-general%20availability%20%28GA%29-brightgreen.svg?style=flat)](https://cloud.google.com/terms/launch-stages)
+[![release level](https://img.shields.io/badge/release%20level-stable-brightgreen.svg?style=flat)](https://cloud.google.com/terms/launch-stages)
 [![npm version](https://img.shields.io/npm/v/@google-cloud/firestore.svg)](https://www.npmjs.org/package/@google-cloud/firestore)
-[![codecov](https://img.shields.io/codecov/c/github/googleapis/nodejs-firestore/main.svg?style=flat)](https://codecov.io/gh/googleapis/nodejs-firestore)
 
@@ -146,6 +145,6 @@
 
-This library is considered to be **General Availability (GA)**. This means it
-is stable; the code surface will not change in backwards-incompatible ways
+
+This library is considered to be **stable**. The code surface will not change in backwards-incompatible ways
 unless absolutely necessary (e.g. because of critical security issues) or with
-an extensive deprecation period. Issues and requests against **GA** libraries
+an extensive deprecation period. Issues and requests against **stable** libraries
 are addressed with the highest priority.
@@ -157,2 +156,3 @@
 
+
 More Information: [Google Cloud Platform Launch Stages][launch_stages]
@@ -159,0 +159,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5551454

increased by0.11%

Lines of code

105270

increased by0.09%

No dependency changes