Socket
Socket
Sign inDemoInstall

@google-cloud/firestore

Package Overview
Dependencies
Maintainers
1
Versions
145
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@google-cloud/firestore - npm Package Compare versions

Comparing version 6.4.2 to 6.4.3

2

build/src/serializer.js

@@ -257,3 +257,3 @@ "use strict";

function validateUserInput(arg, value, desc, options, path, level, inArray) {
if (path && path.size > MAX_DEPTH) {
if (path && path.size - 1 > MAX_DEPTH) {
throw new Error(`${(0, validate_1.invalidArgumentMessage)(arg, desc)} Input object is deeper than ${MAX_DEPTH} levels or contains a cycle.`);

@@ -260,0 +260,0 @@ }

58

build/src/v1/firestore_admin_client.d.ts

@@ -150,3 +150,3 @@ /// <reference types="node" />

* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [Index]{@link google.firestore.admin.v1.Index}.
* The first element of the array is an object representing {@link google.firestore.admin.v1.Index | Index}.
* Please see the

@@ -176,3 +176,3 @@ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)

* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [Empty]{@link google.protobuf.Empty}.
* The first element of the array is an object representing {@link google.protobuf.Empty | Empty}.
* Please see the

@@ -202,3 +202,3 @@ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)

* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [Field]{@link google.firestore.admin.v1.Field}.
* The first element of the array is an object representing {@link google.firestore.admin.v1.Field | Field}.
* Please see the

@@ -228,3 +228,3 @@ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)

* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [Database]{@link google.firestore.admin.v1.Database}.
* The first element of the array is an object representing {@link google.firestore.admin.v1.Database | Database}.
* Please see the

@@ -254,3 +254,3 @@ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)

* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [ListDatabasesResponse]{@link google.firestore.admin.v1.ListDatabasesResponse}.
* The first element of the array is an object representing {@link google.firestore.admin.v1.ListDatabasesResponse | ListDatabasesResponse}.
* Please see the

@@ -541,3 +541,3 @@ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)

* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is Array of [Index]{@link google.firestore.admin.v1.Index}.
* The first element of the array is Array of {@link google.firestore.admin.v1.Index | Index}.
* The client library will perform auto-pagination by default: it will call the API as many

@@ -577,3 +577,3 @@ * times as needed and will merge results from all the pages into this array.

* @returns {Stream}
* An object stream which emits an object representing [Index]{@link google.firestore.admin.v1.Index} on 'data' event.
* An object stream which emits an object representing {@link google.firestore.admin.v1.Index | Index} on 'data' event.
* The client library will perform auto-pagination by default: it will call the API as many

@@ -610,3 +610,3 @@ * times as needed. Note that it can affect your quota.

* When you iterate the returned iterable, each element will be an object representing
* [Index]{@link google.firestore.admin.v1.Index}. The API will be called under the hood as needed, once per the page,
* {@link google.firestore.admin.v1.Index | Index}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.

@@ -648,3 +648,3 @@ * Please see the

* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is Array of [Field]{@link google.firestore.admin.v1.Field}.
* The first element of the array is Array of {@link google.firestore.admin.v1.Field | Field}.
* The client library will perform auto-pagination by default: it will call the API as many

@@ -688,3 +688,3 @@ * times as needed and will merge results from all the pages into this array.

* @returns {Stream}
* An object stream which emits an object representing [Field]{@link google.firestore.admin.v1.Field} on 'data' event.
* An object stream which emits an object representing {@link google.firestore.admin.v1.Field | Field} on 'data' event.
* The client library will perform auto-pagination by default: it will call the API as many

@@ -725,3 +725,3 @@ * times as needed. Note that it can affect your quota.

* When you iterate the returned iterable, each element will be an object representing
* [Field]{@link google.firestore.admin.v1.Field}. The API will be called under the hood as needed, once per the page,
* {@link google.firestore.admin.v1.Field | Field}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.

@@ -743,5 +743,5 @@ * Please see the

* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [Location]{@link google.cloud.location.Location}.
* The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
* Please see the

@@ -775,3 +775,3 @@ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)

* When you iterate the returned iterable, each element will be an object representing
* [Location]{@link google.cloud.location.Location}. The API will be called under the hood as needed, once per the page,
* {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.

@@ -799,5 +799,5 @@ * Please see the

* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See [gax.CallOptions]{@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions} for the
* details.
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
* for the details.
* @param {function(?Error, ?Object)=} callback

@@ -807,9 +807,7 @@ * The function which will be called with the result of the API call.

* The second parameter to the callback is an object representing
* [google.longrunning.Operation]{@link
* external:"google.longrunning.Operation"}.
* {@link google.longrunning.Operation | google.longrunning.Operation}.
* @return {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing
* [google.longrunning.Operation]{@link
* external:"google.longrunning.Operation"}. The promise has a method named
* "cancel" which cancels the ongoing API call.
* {@link google.longrunning.Operation | google.longrunning.Operation}.
* The promise has a method named "cancel" which cancels the ongoing API call.
*

@@ -842,7 +840,7 @@ * @example

* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See [gax.CallOptions]{@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions} for the
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
* details.
* @returns {Object}
* An iterable Object that conforms to @link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols.
* An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
*

@@ -873,4 +871,4 @@ * @example

* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See [gax.CallOptions]{@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions} for the
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
* details.

@@ -900,5 +898,5 @@ * @param {function(?Error)=} callback

* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See [gax.CallOptions]{@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions} for the
* details.
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
* for the details.
* @param {function(?Error)=} callback

@@ -905,0 +903,0 @@ * The function which will be called with the result of the API call.

46

build/src/v1/firestore_admin_client.js
"use strict";
// Copyright 2022 Google LLC
// Copyright 2023 Google LLC
//

@@ -678,3 +678,3 @@ // Licensed under the Apache License, Version 2.0 (the "License");

* @returns {Stream}
* An object stream which emits an object representing [Index]{@link google.firestore.admin.v1.Index} on 'data' event.
* An object stream which emits an object representing {@link google.firestore.admin.v1.Index | Index} on 'data' event.
* The client library will perform auto-pagination by default: it will call the API as many

@@ -725,3 +725,3 @@ * times as needed. Note that it can affect your quota.

* When you iterate the returned iterable, each element will be an object representing
* [Index]{@link google.firestore.admin.v1.Index}. The API will be called under the hood as needed, once per the page,
* {@link google.firestore.admin.v1.Index | Index}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.

@@ -792,3 +792,3 @@ * Please see the

* @returns {Stream}
* An object stream which emits an object representing [Field]{@link google.firestore.admin.v1.Field} on 'data' event.
* An object stream which emits an object representing {@link google.firestore.admin.v1.Field | Field} on 'data' event.
* The client library will perform auto-pagination by default: it will call the API as many

@@ -843,3 +843,3 @@ * times as needed. Note that it can affect your quota.

* When you iterate the returned iterable, each element will be an object representing
* [Field]{@link google.firestore.admin.v1.Field}. The API will be called under the hood as needed, once per the page,
* {@link google.firestore.admin.v1.Field | Field}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.

@@ -875,5 +875,5 @@ * Please see the

* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [Location]{@link google.cloud.location.Location}.
* The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
* Please see the

@@ -909,3 +909,3 @@ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)

* When you iterate the returned iterable, each element will be an object representing
* [Location]{@link google.cloud.location.Location}. The API will be called under the hood as needed, once per the page,
* {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.

@@ -935,5 +935,5 @@ * Please see the

* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See [gax.CallOptions]{@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions} for the
* details.
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
* for the details.
* @param {function(?Error, ?Object)=} callback

@@ -943,9 +943,7 @@ * The function which will be called with the result of the API call.

* The second parameter to the callback is an object representing
* [google.longrunning.Operation]{@link
* external:"google.longrunning.Operation"}.
* {@link google.longrunning.Operation | google.longrunning.Operation}.
* @return {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing
* [google.longrunning.Operation]{@link
* external:"google.longrunning.Operation"}. The promise has a method named
* "cancel" which cancels the ongoing API call.
* {@link google.longrunning.Operation | google.longrunning.Operation}.
* The promise has a method named "cancel" which cancels the ongoing API call.
*

@@ -980,7 +978,7 @@ * @example

* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See [gax.CallOptions]{@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions} for the
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
* details.
* @returns {Object}
* An iterable Object that conforms to @link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols.
* An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
*

@@ -1013,4 +1011,4 @@ * @example

* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See [gax.CallOptions]{@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions} for the
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
* details.

@@ -1042,5 +1040,5 @@ * @param {function(?Error)=} callback

* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See [gax.CallOptions]{@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions} for the
* details.
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
* for the details.
* @param {function(?Error)=} callback

@@ -1047,0 +1045,0 @@ * The function which will be called with the result of the API call.

161

build/src/v1/firestore_client.js
"use strict";
// Copyright 2022 Google LLC
// Copyright 2023 Google LLC
//

@@ -37,4 +37,4 @@ // Licensed under the Apache License, Version 2.0 (the "License");

* live synchronization and offline support, while its security features and
* integrations with Firebase and Google Cloud Platform (GCP) accelerate
* building truly serverless apps.
* integrations with Firebase and Google Cloud Platform accelerate building
* truly serverless apps.
* @class

@@ -485,3 +485,3 @@ * @memberof v1

* @returns {Stream}
* An object stream which emits [BatchGetDocumentsResponse]{@link google.firestore.v1.BatchGetDocumentsResponse} on 'data' event.
* An object stream which emits {@link google.firestore.v1.BatchGetDocumentsResponse | BatchGetDocumentsResponse} on 'data' event.
* Please see the

@@ -535,3 +535,3 @@ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming)

* @returns {Stream}
* An object stream which emits [RunQueryResponse]{@link google.firestore.v1.RunQueryResponse} on 'data' event.
* An object stream which emits {@link google.firestore.v1.RunQueryResponse | RunQueryResponse} on 'data' event.
* Please see the

@@ -559,4 +559,5 @@ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming)

*
* Rather than producing {@link google.firestore.v1.Document|Document} results like {@link google.firestore.v1.Firestore.RunQuery|Firestore.RunQuery},
* this API allows running an aggregation to produce a series of
* Rather than producing {@link google.firestore.v1.Document|Document} results like
* {@link google.firestore.v1.Firestore.RunQuery|Firestore.RunQuery}, this API
* allows running an aggregation to produce a series of
* {@link google.firestore.v1.AggregationResult|AggregationResult} server-side.

@@ -600,3 +601,3 @@ *

* @returns {Stream}
* An object stream which emits [RunAggregationQueryResponse]{@link google.firestore.v1.RunAggregationQueryResponse} on 'data' event.
* An object stream which emits {@link google.firestore.v1.RunAggregationQueryResponse | RunAggregationQueryResponse} on 'data' event.
* Please see the

@@ -622,3 +623,4 @@ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming)

/**
* Streams batches of document updates and deletes, in order.
* Streams batches of document updates and deletes, in order. This method is
* only available via the gRPC API (not REST).
*

@@ -629,4 +631,4 @@ * @param {object} [options]

* An object stream which is both readable and writable. It accepts objects
* representing [WriteRequest]{@link google.firestore.v1.WriteRequest} for write() method, and
* will emit objects representing [WriteResponse]{@link google.firestore.v1.WriteResponse} on 'data' event asynchronously.
* representing {@link google.firestore.v1.WriteRequest | WriteRequest} for write() method, and
* will emit objects representing {@link google.firestore.v1.WriteResponse | WriteResponse} on 'data' event asynchronously.
* Please see the

@@ -643,3 +645,4 @@ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#bi-directional-streaming)

/**
* Listens to changes.
* Listens to changes. This method is only available via the gRPC API (not
* REST).
*

@@ -650,4 +653,4 @@ * @param {object} [options]

* An object stream which is both readable and writable. It accepts objects
* representing [ListenRequest]{@link google.firestore.v1.ListenRequest} for write() method, and
* will emit objects representing [ListenResponse]{@link google.firestore.v1.ListenResponse} on 'data' event asynchronously.
* representing {@link google.firestore.v1.ListenRequest | ListenRequest} for write() method, and
* will emit objects representing {@link google.firestore.v1.ListenResponse | ListenResponse} on 'data' event asynchronously.
* Please see the

@@ -693,36 +696,56 @@ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#bi-directional-streaming)

* `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
*
* For example:
* `projects/my-project/databases/my-database/documents` or
* `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
* @param {string} request.collectionId
* Required. The collection ID, relative to `parent`, to list. For example: `chatrooms`
* or `messages`.
* @param {number} request.pageSize
* The maximum number of documents to return.
* @param {string} request.pageToken
* The `next_page_token` value returned from a previous List request, if any.
* @param {string} request.orderBy
* The order to sort results by. For example: `priority desc, name`.
* @param {google.firestore.v1.DocumentMask} request.mask
* The fields to return. If not set, returns all fields.
* @param {string} [request.collectionId]
* Optional. The collection ID, relative to `parent`, to list.
*
* For example: `chatrooms` or `messages`.
*
* This is optional, and when not provided, Firestore will list documents
* from all collections under the provided `parent`.
* @param {number} [request.pageSize]
* Optional. The maximum number of documents to return in a single response.
*
* Firestore may return fewer than this value.
* @param {string} [request.pageToken]
* Optional. A page token, received from a previous `ListDocuments` response.
*
* Provide this to retrieve the subsequent page. When paginating, all other
* parameters (with the exception of `page_size`) must match the values set
* in the request that generated the page token.
* @param {string} [request.orderBy]
* Optional. The optional ordering of the documents to return.
*
* For example: `priority desc, __name__ desc`.
*
* This mirrors the {@link google.firestore.v1.StructuredQuery.order_by|`ORDER BY`}
* used in Firestore queries but in a string representation. When absent,
* documents are ordered based on `__name__ ASC`.
* @param {google.firestore.v1.DocumentMask} [request.mask]
* Optional. The fields to return. If not set, returns all fields.
*
* If a document has a field that is not present in this mask, that field
* will not be returned in the response.
* @param {Buffer} request.transaction
* Reads documents in a transaction.
* Perform the read as part of an already active transaction.
* @param {google.protobuf.Timestamp} request.readTime
* Reads documents as they were at the given time.
* Perform the read at the provided time.
*
* This may not be older than 270 seconds.
* @param {boolean} request.showMissing
* If the list should show missing documents. A missing document is a
* document that does not exist but has sub-documents. These documents will
* be returned with a key but will not have fields, {@link google.firestore.v1.Document.create_time|Document.create_time},
* or {@link google.firestore.v1.Document.update_time|Document.update_time} set.
* If the list should show missing documents.
*
* Requests with `show_missing` may not specify `where` or
* `order_by`.
* A document is missing if it does not exist, but there are sub-documents
* nested underneath it. When true, such missing documents will be returned
* with a key but will not have fields,
* {@link google.firestore.v1.Document.create_time|`create_time`}, or
* {@link google.firestore.v1.Document.update_time|`update_time`} set.
*
* Requests with `show_missing` may not specify `where` or `order_by`.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Stream}
* An object stream which emits an object representing [Document]{@link google.firestore.v1.Document} on 'data' event.
* An object stream which emits an object representing {@link google.firestore.v1.Document | Document} on 'data' event.
* The client library will perform auto-pagination by default: it will call the API as many

@@ -762,32 +785,52 @@ * times as needed. Note that it can affect your quota.

* `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
*
* For example:
* `projects/my-project/databases/my-database/documents` or
* `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
* @param {string} request.collectionId
* Required. The collection ID, relative to `parent`, to list. For example: `chatrooms`
* or `messages`.
* @param {number} request.pageSize
* The maximum number of documents to return.
* @param {string} request.pageToken
* The `next_page_token` value returned from a previous List request, if any.
* @param {string} request.orderBy
* The order to sort results by. For example: `priority desc, name`.
* @param {google.firestore.v1.DocumentMask} request.mask
* The fields to return. If not set, returns all fields.
* @param {string} [request.collectionId]
* Optional. The collection ID, relative to `parent`, to list.
*
* For example: `chatrooms` or `messages`.
*
* This is optional, and when not provided, Firestore will list documents
* from all collections under the provided `parent`.
* @param {number} [request.pageSize]
* Optional. The maximum number of documents to return in a single response.
*
* Firestore may return fewer than this value.
* @param {string} [request.pageToken]
* Optional. A page token, received from a previous `ListDocuments` response.
*
* Provide this to retrieve the subsequent page. When paginating, all other
* parameters (with the exception of `page_size`) must match the values set
* in the request that generated the page token.
* @param {string} [request.orderBy]
* Optional. The optional ordering of the documents to return.
*
* For example: `priority desc, __name__ desc`.
*
* This mirrors the {@link google.firestore.v1.StructuredQuery.order_by|`ORDER BY`}
* used in Firestore queries but in a string representation. When absent,
* documents are ordered based on `__name__ ASC`.
* @param {google.firestore.v1.DocumentMask} [request.mask]
* Optional. The fields to return. If not set, returns all fields.
*
* If a document has a field that is not present in this mask, that field
* will not be returned in the response.
* @param {Buffer} request.transaction
* Reads documents in a transaction.
* Perform the read as part of an already active transaction.
* @param {google.protobuf.Timestamp} request.readTime
* Reads documents as they were at the given time.
* Perform the read at the provided time.
*
* This may not be older than 270 seconds.
* @param {boolean} request.showMissing
* If the list should show missing documents. A missing document is a
* document that does not exist but has sub-documents. These documents will
* be returned with a key but will not have fields, {@link google.firestore.v1.Document.create_time|Document.create_time},
* or {@link google.firestore.v1.Document.update_time|Document.update_time} set.
* If the list should show missing documents.
*
* Requests with `show_missing` may not specify `where` or
* `order_by`.
* A document is missing if it does not exist, but there are sub-documents
* nested underneath it. When true, such missing documents will be returned
* with a key but will not have fields,
* {@link google.firestore.v1.Document.create_time|`create_time`}, or
* {@link google.firestore.v1.Document.update_time|`update_time`} set.
*
* Requests with `show_missing` may not specify `where` or `order_by`.
* @param {object} [options]

@@ -798,3 +841,3 @@ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.

* When you iterate the returned iterable, each element will be an object representing
* [Document]{@link google.firestore.v1.Document}. The API will be called under the hood as needed, once per the page,
* {@link google.firestore.v1.Document | Document}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.

@@ -895,3 +938,3 @@ * Please see the

* @returns {Stream}
* An object stream which emits an object representing [Cursor]{@link google.firestore.v1.Cursor} on 'data' event.
* An object stream which emits an object representing {@link google.firestore.v1.Cursor | Cursor} on 'data' event.
* The client library will perform auto-pagination by default: it will call the API as many

@@ -975,3 +1018,3 @@ * times as needed. Note that it can affect your quota.

* When you iterate the returned iterable, each element will be an object representing
* [Cursor]{@link google.firestore.v1.Cursor}. The API will be called under the hood as needed, once per the page,
* {@link google.firestore.v1.Cursor | Cursor}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.

@@ -1119,5 +1162,5 @@ * Please see the

* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [Location]{@link google.cloud.location.Location}.
* The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
* Please see the

@@ -1153,3 +1196,3 @@ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)

* When you iterate the returned iterable, each element will be an object representing
* [Location]{@link google.cloud.location.Location}. The API will be called under the hood as needed, once per the page,
* {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.

@@ -1156,0 +1199,0 @@ * Please see the

40

build/src/v1beta1/firestore_client.d.ts

@@ -136,3 +136,3 @@ /// <reference types="node" />

* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [Document]{@link google.firestore.v1beta1.Document}.
* The first element of the array is an object representing {@link google.firestore.v1beta1.Document | Document}.
* Please see the

@@ -178,3 +178,3 @@ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)

* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [Document]{@link google.firestore.v1beta1.Document}.
* The first element of the array is an object representing {@link google.firestore.v1beta1.Document | Document}.
* Please see the

@@ -207,3 +207,3 @@ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)

* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [Empty]{@link google.protobuf.Empty}.
* The first element of the array is an object representing {@link google.protobuf.Empty | Empty}.
* Please see the

@@ -236,3 +236,3 @@ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)

* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [BeginTransactionResponse]{@link google.firestore.v1beta1.BeginTransactionResponse}.
* The first element of the array is an object representing {@link google.firestore.v1beta1.BeginTransactionResponse | BeginTransactionResponse}.
* Please see the

@@ -268,3 +268,3 @@ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)

* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [CommitResponse]{@link google.firestore.v1beta1.CommitResponse}.
* The first element of the array is an object representing {@link google.firestore.v1beta1.CommitResponse | CommitResponse}.
* Please see the

@@ -296,3 +296,3 @@ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)

* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [Empty]{@link google.protobuf.Empty}.
* The first element of the array is an object representing {@link google.protobuf.Empty | Empty}.
* Please see the

@@ -338,3 +338,3 @@ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)

* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [BatchWriteResponse]{@link google.firestore.v1beta1.BatchWriteResponse}.
* The first element of the array is an object representing {@link google.firestore.v1beta1.BatchWriteResponse | BatchWriteResponse}.
* Please see the

@@ -378,3 +378,3 @@ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)

* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [Document]{@link google.firestore.v1beta1.Document}.
* The first element of the array is an object representing {@link google.firestore.v1beta1.Document | Document}.
* Please see the

@@ -427,3 +427,3 @@ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)

* @returns {Stream}
* An object stream which emits [BatchGetDocumentsResponse]{@link google.firestore.v1beta1.BatchGetDocumentsResponse} on 'data' event.
* An object stream which emits {@link google.firestore.v1beta1.BatchGetDocumentsResponse | BatchGetDocumentsResponse} on 'data' event.
* Please see the

@@ -463,3 +463,3 @@ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming)

* @returns {Stream}
* An object stream which emits [RunQueryResponse]{@link google.firestore.v1beta1.RunQueryResponse} on 'data' event.
* An object stream which emits {@link google.firestore.v1beta1.RunQueryResponse | RunQueryResponse} on 'data' event.
* Please see the

@@ -479,4 +479,4 @@ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming)

* An object stream which is both readable and writable. It accepts objects
* representing [WriteRequest]{@link google.firestore.v1beta1.WriteRequest} for write() method, and
* will emit objects representing [WriteResponse]{@link google.firestore.v1beta1.WriteResponse} on 'data' event asynchronously.
* representing {@link google.firestore.v1beta1.WriteRequest | WriteRequest} for write() method, and
* will emit objects representing {@link google.firestore.v1beta1.WriteResponse | WriteResponse} on 'data' event asynchronously.
* Please see the

@@ -496,4 +496,4 @@ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#bi-directional-streaming)

* An object stream which is both readable and writable. It accepts objects
* representing [ListenRequest]{@link google.firestore.v1beta1.ListenRequest} for write() method, and
* will emit objects representing [ListenResponse]{@link google.firestore.v1beta1.ListenResponse} on 'data' event asynchronously.
* representing {@link google.firestore.v1beta1.ListenRequest | ListenRequest} for write() method, and
* will emit objects representing {@link google.firestore.v1beta1.ListenResponse | ListenResponse} on 'data' event asynchronously.
* Please see the

@@ -548,3 +548,3 @@ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#bi-directional-streaming)

* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is Array of [Document]{@link google.firestore.v1beta1.Document}.
* The first element of the array is Array of {@link google.firestore.v1beta1.Document | Document}.
* The client library will perform auto-pagination by default: it will call the API as many

@@ -607,3 +607,3 @@ * times as needed and will merge results from all the pages into this array.

* @returns {Stream}
* An object stream which emits an object representing [Document]{@link google.firestore.v1beta1.Document} on 'data' event.
* An object stream which emits an object representing {@link google.firestore.v1beta1.Document | Document} on 'data' event.
* The client library will perform auto-pagination by default: it will call the API as many

@@ -663,3 +663,3 @@ * times as needed. Note that it can affect your quota.

* When you iterate the returned iterable, each element will be an object representing
* [Document]{@link google.firestore.v1beta1.Document}. The API will be called under the hood as needed, once per the page,
* {@link google.firestore.v1beta1.Document | Document}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.

@@ -724,3 +724,3 @@ * Please see the

* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is Array of [Cursor]{@link google.firestore.v1beta1.Cursor}.
* The first element of the array is Array of {@link google.firestore.v1beta1.Cursor | Cursor}.
* The client library will perform auto-pagination by default: it will call the API as many

@@ -790,3 +790,3 @@ * times as needed and will merge results from all the pages into this array.

* @returns {Stream}
* An object stream which emits an object representing [Cursor]{@link google.firestore.v1beta1.Cursor} on 'data' event.
* An object stream which emits an object representing {@link google.firestore.v1beta1.Cursor | Cursor} on 'data' event.
* The client library will perform auto-pagination by default: it will call the API as many

@@ -853,3 +853,3 @@ * times as needed. Note that it can affect your quota.

* When you iterate the returned iterable, each element will be an object representing
* [Cursor]{@link google.firestore.v1beta1.Cursor}. The API will be called under the hood as needed, once per the page,
* {@link google.firestore.v1beta1.Cursor | Cursor}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.

@@ -856,0 +856,0 @@ * Please see the

22

build/src/v1beta1/firestore_client.js
"use strict";
// Copyright 2022 Google LLC
// Copyright 2023 Google LLC
//

@@ -483,3 +483,3 @@ // Licensed under the Apache License, Version 2.0 (the "License");

* @returns {Stream}
* An object stream which emits [BatchGetDocumentsResponse]{@link google.firestore.v1beta1.BatchGetDocumentsResponse} on 'data' event.
* An object stream which emits {@link google.firestore.v1beta1.BatchGetDocumentsResponse | BatchGetDocumentsResponse} on 'data' event.
* Please see the

@@ -531,3 +531,3 @@ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming)

* @returns {Stream}
* An object stream which emits [RunQueryResponse]{@link google.firestore.v1beta1.RunQueryResponse} on 'data' event.
* An object stream which emits {@link google.firestore.v1beta1.RunQueryResponse | RunQueryResponse} on 'data' event.
* Please see the

@@ -559,4 +559,4 @@ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming)

* An object stream which is both readable and writable. It accepts objects
* representing [WriteRequest]{@link google.firestore.v1beta1.WriteRequest} for write() method, and
* will emit objects representing [WriteResponse]{@link google.firestore.v1beta1.WriteResponse} on 'data' event asynchronously.
* representing {@link google.firestore.v1beta1.WriteRequest | WriteRequest} for write() method, and
* will emit objects representing {@link google.firestore.v1beta1.WriteResponse | WriteResponse} on 'data' event asynchronously.
* Please see the

@@ -579,4 +579,4 @@ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#bi-directional-streaming)

* An object stream which is both readable and writable. It accepts objects
* representing [ListenRequest]{@link google.firestore.v1beta1.ListenRequest} for write() method, and
* will emit objects representing [ListenResponse]{@link google.firestore.v1beta1.ListenResponse} on 'data' event asynchronously.
* representing {@link google.firestore.v1beta1.ListenRequest | ListenRequest} for write() method, and
* will emit objects representing {@link google.firestore.v1beta1.ListenResponse | ListenResponse} on 'data' event asynchronously.
* Please see the

@@ -655,3 +655,3 @@ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#bi-directional-streaming)

* @returns {Stream}
* An object stream which emits an object representing [Document]{@link google.firestore.v1beta1.Document} on 'data' event.
* An object stream which emits an object representing {@link google.firestore.v1beta1.Document | Document} on 'data' event.
* The client library will perform auto-pagination by default: it will call the API as many

@@ -726,3 +726,3 @@ * times as needed. Note that it can affect your quota.

* When you iterate the returned iterable, each element will be an object representing
* [Document]{@link google.firestore.v1beta1.Document}. The API will be called under the hood as needed, once per the page,
* {@link google.firestore.v1beta1.Document | Document}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.

@@ -820,3 +820,3 @@ * Please see the

* @returns {Stream}
* An object stream which emits an object representing [Cursor]{@link google.firestore.v1beta1.Cursor} on 'data' event.
* An object stream which emits an object representing {@link google.firestore.v1beta1.Cursor | Cursor} on 'data' event.
* The client library will perform auto-pagination by default: it will call the API as many

@@ -897,3 +897,3 @@ * times as needed. Note that it can affect your quota.

* When you iterate the returned iterable, each element will be an object representing
* [Cursor]{@link google.firestore.v1beta1.Cursor}. The API will be called under the hood as needed, once per the page,
* {@link google.firestore.v1beta1.Cursor | Cursor}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.

@@ -900,0 +900,0 @@ * Please see the

6

package.json
{
"name": "@google-cloud/firestore",
"description": "Firestore Client Library for Node.js",
"version": "6.4.2",
"version": "6.4.3",
"license": "Apache-2.0",

@@ -35,2 +35,4 @@ "author": "Google Inc.",

"system-test:grpc": "mocha build/system-test --timeout 600000",
"system-test:rest:emulator": "USE_REST_FALLBACK=YES FIRESTORE_EMULATOR_HOST=localhost:8080 mocha build/system-test --timeout 600000",
"system-test:grpc:emulator": "FIRESTORE_EMULATOR_HOST=localhost:8080 mocha build/system-test --timeout 600000",
"system-test": "npm run system-test:grpc && npm run system-test:rest",

@@ -58,3 +60,3 @@ "presystem-test": "npm run compile",

"functional-red-black-tree": "^1.0.1",
"google-gax": "^3.5.2",
"google-gax": "^3.5.3",
"protobufjs": "^7.0.0"

@@ -61,0 +63,0 @@ },

build/protos/google/api/client.proto

Sorry, the diff of this file is not supported yet

build/protos/google/firestore/v1/aggregation_result.proto

Sorry, the diff of this file is not supported yet

build/protos/google/firestore/v1/common.proto

Sorry, the diff of this file is not supported yet

build/protos/google/firestore/v1/firestore.proto

Sorry, the diff of this file is not supported yet

build/protos/google/firestore/v1/query.proto

Sorry, the diff of this file is not supported yet

build/protos/google/firestore/v1/write.proto

Sorry, the diff of this file is not supported yet

build/protos/google/protobuf/any.proto

Sorry, the diff of this file is not supported yet

build/protos/google/protobuf/descriptor.proto

Sorry, the diff of this file is not supported yet

build/protos/google/protobuf/empty.proto

Sorry, the diff of this file is not supported yet

build/protos/google/protobuf/field_mask.proto

Sorry, the diff of this file is not supported yet

build/protos/google/protobuf/struct.proto

Sorry, the diff of this file is not supported yet

build/protos/google/protobuf/timestamp.proto

Sorry, the diff of this file is not supported yet

build/protos/google/protobuf/wrappers.proto

Sorry, the diff of this file is not supported yet

build/protos/google/rpc/status.proto

Sorry, the diff of this file is not supported yet

build/src/v1/firestore_client.d.ts

Sorry, the diff of this file is too big to display

CHANGELOG.md

Sorry, the diff of this file is too big to display

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc