@maxim_mazurok/gapi.client.firestore-v1 0.2.20260310 → 0.2.20260529

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: 20260310
+// Revision: 20260529
 
 /// <reference types="gapi.client" />
 
@@ -426,7 +426,7 @@ declare namespace gapi.client {
         | 'DISABLED';
       /** Optional. Presence indicates CMEK is enabled for this database. */
       cmekConfig?: GoogleFirestoreAdminV1CmekConfig;
-      /** The concurrency control mode to use for this database. If unspecified in a CreateDatabase request, this will default based on the database edition: Optimistic for Enterprise and Pessimistic for all other databases. */
+      /** The default concurrency control mode to use for this database. If unspecified in a CreateDatabase request, this will default based on the database edition: Optimistic for Enterprise and Pessimistic for all other databases. While transactions can explicitly specify their own concurrency mode, this setting defines the default behavior when left unspecified. Important: This database-level setting is not respected for Firestore with MongoDB compatibility. All transactions through the MongoDB compatibility layer will use optimistic concurrency control, regardless of this setting. */
       concurrencyMode?:
         | 'CONCURRENCY_MODE_UNSPECIFIED'
         | 'OPTIMISTIC'
@@ -636,6 +636,8 @@ declare namespace gapi.client {
         | 'COLLECTION'
         | 'COLLECTION_GROUP'
         | 'COLLECTION_RECURSIVE';
+      /** Optional. Options for search indexes that are at the index definition level. This field is only currently supported for indexes with MONGODB_COMPATIBLE_API ApiScope. */
+      searchIndexOptions?: GoogleFirestoreAdminV1SearchIndexOptions;
       /** Optional. The number of shards for the index. */
       shardCount?: number;
       /** Output only. The serving state of the index. */
@@ -666,6 +668,8 @@ declare namespace gapi.client {
       fieldPath?: string;
       /** Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=. */
       order?: 'ORDER_UNSPECIFIED' | 'ASCENDING' | 'DESCENDING';
+      /** Indicates that this field supports search operations. */
+      searchConfig?: GoogleFirestoreAdminV1SearchConfig;
       /** Indicates that this field supports nearest neighbor and distance operations on vector. */
       vectorConfig?: GoogleFirestoreAdminV1VectorConfig;
     }
@@ -775,6 +779,32 @@ declare namespace gapi.client {
       /** Optional. Immutable. Tags to be bound to the restored database. The tags should be provided in the format of `tagKeys/{tag_key_id} -> tagValues/{tag_value_id}`. */
       tags?: {[P in string]: string};
     }
+    interface GoogleFirestoreAdminV1SearchConfig {
+      /** Optional. The specification for building a geo search index for a field. */
+      geoSpec?: GoogleFirestoreAdminV1SearchGeoSpec;
+      /** Optional. The specification for building a text search index for a field. */
+      textSpec?: GoogleFirestoreAdminV1SearchTextSpec;
+    }
+    interface GoogleFirestoreAdminV1SearchGeoSpec {
+      /** Optional. Disables geoJSON indexing for the field. By default, geoJSON points are indexed. */
+      geoJsonIndexingDisabled?: boolean;
+    }
+    interface GoogleFirestoreAdminV1SearchIndexOptions {
+      /** Optional. The language to use for text search indexes. Used as the default language if not overridden at the document level by specifying the `text_language_override_field`. The language is specified as a BCP 47 language code. For indexes with MONGODB_COMPATIBLE_API ApiScope: If unspecified, the default language is English. For indexes with `ANY_API` ApiScope: If unspecified, the default behavior is autodetect. */
+      textLanguage?: string;
+      /** Optional. The field in the document that specifies which language to use for that specific document. For indexes with MONGODB_COMPATIBLE_API ApiScope: if unspecified, the language is taken from the "language" field if it exists or from `text_language` if it does not. */
+      textLanguageOverrideFieldPath?: string;
+    }
+    interface GoogleFirestoreAdminV1SearchTextIndexSpec {
+      /** Required. How to index the text field value. */
+      indexType?: 'TEXT_INDEX_TYPE_UNSPECIFIED' | 'TOKENIZED';
+      /** Required. How to match the text field value. */
+      matchType?: 'TEXT_MATCH_TYPE_UNSPECIFIED' | 'MATCH_GLOBALLY';
+    }
+    interface GoogleFirestoreAdminV1SearchTextSpec {
+      /** Required. Specifications for how the field should be indexed. Repeated so that the field can be indexed in multiple ways. */
+      indexSpecs?: GoogleFirestoreAdminV1SearchTextIndexSpec[];
+    }
     interface GoogleFirestoreAdminV1SourceEncryptionOptions {}
     interface GoogleFirestoreAdminV1SourceInfo {
       /** If set, this database was restored from the specified backup (or a snapshot thereof). */
@@ -791,12 +821,16 @@ declare namespace gapi.client {
       sizeBytes?: string;
     }
     interface GoogleFirestoreAdminV1TtlConfig {
+      /** Optional. The offset, relative to the timestamp value from the TTL-enabled field, used to determine the document's expiration time. `expiration_offset.seconds` must be between 0 and 2,147,483,647 inclusive. Values more precise than seconds are rejected. If unset, defaults to 0, in which case the expiration time is the same as the timestamp value from the TTL-enabled field. */
+      expirationOffset?: string;
       /** Output only. The state of the TTL configuration. */
       state?: 'STATE_UNSPECIFIED' | 'CREATING' | 'ACTIVE' | 'NEEDS_REPAIR';
     }
     interface GoogleFirestoreAdminV1TtlConfigDelta {
       /** Specifies how the TTL configuration is changing. */
       changeType?: 'CHANGE_TYPE_UNSPECIFIED' | 'ADD' | 'REMOVE';
+      /** The offset, relative to the timestamp value in the TTL-enabled field, used determine the document's expiration time. */
+      expirationOffset?: string;
     }
     interface GoogleFirestoreAdminV1UpdateDatabaseMetadata {}
     interface GoogleFirestoreAdminV1UserCreds {
@@ -950,7 +984,7 @@ declare namespace gapi.client {
     }
     interface PlanSummary {
       /** The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, __name__ ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, __name__ ASC)"} ] */
-      indexesUsed?: Array<{[P in string]: any}>;
+      indexesUsed?: {[P in string]: any}[];
     }
     interface Precondition {
       /** When set to `true`, the target document must exist. When set to `false`, the target document must not exist. */
@@ -973,6 +1007,11 @@ declare namespace gapi.client {
       readTime?: string;
     }
     interface ReadWrite {
+      /** Optional. The concurrency control mode to use for this transaction. A database is able to use different concurrency modes for different transactions simultaneously. 3rd party auth requests are only allowed to create optimistic read-write transactions and must specify that here even if the database-level setting is already configured to optimistic. */
+      concurrencyMode?:
+        | 'CONCURRENCY_MODE_UNSPECIFIED'
+        | 'OPTIMISTIC'
+        | 'PESSIMISTIC';
       /** An optional transaction to retry. */
       retryTransaction?: string;
     }
@@ -1040,7 +1079,7 @@ declare namespace gapi.client {
       /** The status code, which should be an enum value of google.rpc.Code. */
       code?: number;
       /** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
-      details?: Array<{[P in string]: any}>;
+      details?: {[P in string]: any}[];
       /** A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */
       message?: string;
     }
@@ -2159,7 +2198,7 @@ declare namespace gapi.client {
         key?: string;
         /** OAuth 2.0 token for the current user. */
         oauth_token?: string;
-        /** Required. The parent document. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` */
+        /** Required. The parent document. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` Use `projects/{project_id}/databases/{database_id}/documents` to list top-level collections. */
         parent: string;
         /** Returns response with indentations and line breaks. */
         prettyPrint?: boolean;
@@ -2188,7 +2227,7 @@ declare namespace gapi.client {
           key?: string;
           /** OAuth 2.0 token for the current user. */
           oauth_token?: string;
-          /** Required. The parent document. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` */
+          /** Required. The parent document. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` Use `projects/{project_id}/databases/{database_id}/documents` to list top-level collections. */
           parent: string;
           /** Returns response with indentations and line breaks. */
           prettyPrint?: boolean;
@@ -3754,7 +3793,7 @@ declare namespace gapi.client {
         /** Legacy upload protocol for media (e.g. "media", "multipart"). */
         uploadType?: string;
       }): Request<Location>;
-      /** Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project. */
+      /** Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. */
       list(request?: {
         /** V1 error format. */
         '$.xgafv'?: '1' | '2';
@@ -3764,7 +3803,7 @@ declare namespace gapi.client {
         alt?: 'json' | 'media' | 'proto';
         /** JSONP */
         callback?: string;
-        /** Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */
+        /** Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */
         extraLocationTypes?: string | string[];
         /** Selector specifying which fields to include in a partial response. */
         fields?: string;

package/package.json

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

package/readme.md

@@ -11,6 +11,18 @@ Install typings for Cloud Firestore API:
 npm install @types/gapi.client.firestore-v1 --save-dev
 ```
 
+## TypeScript 6.0+
+
+TypeScript 6.0 changed `types` to default to `[]`. You must now explicitly list type packages in `tsconfig.json`:
+
+```json
+{
+  "compilerOptions": {
+    "types": ["gapi", "gapi.auth2", "gapi.client", "gapi.client.firestore-v1"]
+  }
+}
+```
+
 ## Usage
 
 You need to initialize Google API client in your code: