@maxim_mazurok/gapi.client.firestore-v1 0.0.20231221 → 0.0.20240117

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://firestore.googleapis.com/$discovery/rest?version=v1
-// Revision: 20231221
+// Revision: 20240117
 
 /// <reference types="gapi.client" />
 
@@ -137,6 +137,7 @@ declare namespace gapi.client {
     interface Document {
       /** Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. */
       createTime?: string;
+      /** The document's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The field names, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by a dot-delimited (`.`) string of segments. Each segment is either a simple field name (defined below) or a quoted field name. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `` foo.`x&y` ``. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. A quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. */
       fields?: {[P in string]: Value};
       /** The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. */
       name?: string;
@@ -608,7 +609,7 @@ declare namespace gapi.client {
     interface Order {
       /** The direction to order by. Defaults to `ASCENDING`. */
       direction?: string;
-      /** Order based on the value referenced by this field. */
+      /** The field to order by. */
       field?: FieldReference;
     }
     interface PartitionQueryRequest {
@@ -639,6 +640,10 @@ declare namespace gapi.client {
       /** The fields to return. If empty, all fields are returned. To only return the name of the document, use `['__name__']`. */
       fields?: FieldReference[];
     }
+    interface QueryPlan {
+      /** Planning phase information for the query. It will include: { "indexes_used": [ {"query_scope": "Collection", "properties": "(foo ASC, __name__ ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, __name__ ASC)"} ] } */
+      planInfo?: {[P in string]: any};
+    }
     interface QueryTarget {
       /** The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `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` */
       parent?: string;
@@ -653,11 +658,19 @@ declare namespace gapi.client {
       /** An optional transaction to retry. */
       retryTransaction?: string;
     }
+    interface ResultSetStats {
+      /** Plan for the query. */
+      queryPlan?: QueryPlan;
+      /** Aggregated statistics from the execution of the query. This will only be present when the request specifies `PROFILE` mode. For example, a query will return the statistics including: { "results_returned": "20", "documents_scanned": "20", "indexes_entries_scanned": "10050", "total_execution_time": "100.7 msecs" } */
+      queryStats?: {[P in string]: any};
+    }
     interface RollbackRequest {
       /** Required. The transaction to roll back. */
       transaction?: string;
     }
     interface RunAggregationQueryRequest {
+      /** Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to `NORMAL` mode where no additional statistics will be returned with the query results. */
+      mode?: string;
       /** Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream. */
       newTransaction?: TransactionOptions;
       /** Executes the query at the given timestamp. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. */
@@ -672,10 +685,14 @@ declare namespace gapi.client {
       readTime?: string;
       /** A single aggregation result. Not present when reporting partial progress. */
       result?: AggregationResult;
+      /** Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves. This is only present when the request specifies a mode other than `NORMAL` and is sent only once with the last response in the stream. */
+      stats?: ResultSetStats;
       /** The transaction that was started as part of this request. Only present on the first response when the request requested to start a new transaction. */
       transaction?: string;
     }
     interface RunQueryRequest {
+      /** Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to `NORMAL` mode where no additional statistics will be returned with the query results. */
+      mode?: string;
       /** Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream. */
       newTransaction?: TransactionOptions;
       /** Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. */
@@ -694,6 +711,8 @@ declare namespace gapi.client {
       readTime?: string;
       /** The number of results that have been skipped due to an offset between the last response and the current response. */
       skippedResults?: number;
+      /** Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves. This is only present when the request specifies a mode other than `NORMAL` and is sent only once with the last response in the stream. */
+      stats?: ResultSetStats;
       /** The transaction that was started as part of this request. Can only be set in the first response, and only if RunQueryRequest.new_transaction was set in the request. If set, no other fields will be set in this response. */
       transaction?: string;
     }
@@ -1068,7 +1087,7 @@ declare namespace gapi.client {
         /** Legacy upload protocol for media (e.g. "media", "multipart"). */
         uploadType?: string;
       }): Request<GoogleFirestoreAdminV1Field>;
-      /** Lists the field configuration and metadata for this database. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to `indexConfig.usesAncestorConfig:false or `ttlConfig:*`. */
+      /** Lists the field configuration and metadata for this database. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to `indexConfig.usesAncestorConfig:false` or `ttlConfig:*`. */
       list(request?: {
         /** V1 error format. */
         '$.xgafv'?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.firestore-v1",
-  "version": "0.0.20231221",
+  "version": "0.0.20240117",
   "description": "TypeScript typings for Cloud Firestore API v1",
   "repository": {
     "type": "git",