@maxim_mazurok/gapi.client.firestore-v1 0.0.20230921 → 0.0.20231009

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/index.d.ts +24 -5
  2. package/package.json +1 -1
  3. package/tests.ts +11 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://firestore.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20230921
12
+ // Revision: 20231009
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -524,8 +524,9 @@ declare namespace gapi.client {
524
524
  outputUriPrefix?:
525
525
  string;
526
526
  /**
527
- * The timestamp that corresponds to the version of the database to be exported. The timestamp must be rounded to the minute, in the past, and not older than 1 hour. If specified, then
528
- * the exported documents will represent a consistent view of the database at the provided time. Otherwise, there are no guarantees about the consistency of the exported documents.
527
+ * The timestamp that corresponds to the version of the database to be exported. The timestamp must be rounded to the minute, in the past, and not older than 5 days. Please choose a
528
+ * reasonable timestamp based on prior knowledge on how long exports take as data at provided snapshot timestamp can expire during export. If specified, then the exported documents
529
+ * will represent a consistent view of the database at the provided time. Otherwise, there are no guarantees about the consistency of the exported documents.
529
530
  */
530
531
  snapshotTime?:
531
532
  string;
@@ -584,6 +585,9 @@ declare namespace gapi.client {
584
585
  ttlConfigDelta?:
585
586
  GoogleFirestoreAdminV1TtlConfigDelta;
586
587
  }
588
+ // tslint:disable-next-line:no-empty-interface
589
+ interface GoogleFirestoreAdminV1FlatIndex {
590
+ }
587
591
  interface GoogleFirestoreAdminV1ImportDocumentsMetadata {
588
592
  /** Which collection ids are being imported. */
589
593
  collectionIds?:
@@ -697,6 +701,9 @@ declare namespace gapi.client {
697
701
  /** Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=. */
698
702
  order?:
699
703
  string;
704
+ /** Indicates that this field supports nearest neighbors and distance operations on vector. */
705
+ vectorConfig?:
706
+ GoogleFirestoreAdminV1VectorConfig;
700
707
  }
701
708
  interface GoogleFirestoreAdminV1IndexOperationMetadata {
702
709
  /** The time this operation completed. Will be unset if operation still in progress. */
@@ -787,7 +794,7 @@ declare namespace gapi.client {
787
794
  string;
788
795
  }
789
796
  interface GoogleFirestoreAdminV1RestoreDatabaseRequest {
790
- /** Required. Backup to restore from. Must be from the same project as the parent. Format is: `projects/{project_id}/locations/{location}/backups/{backup}` */
797
+ /** Backup to restore from. Must be from the same project as the parent. Format is: `projects/{project_id}/locations/{location}/backups/{backup}` */
791
798
  backup?:
792
799
  string;
793
800
  /**
@@ -822,6 +829,17 @@ declare namespace gapi.client {
822
829
  // tslint:disable-next-line:no-empty-interface
823
830
  interface GoogleFirestoreAdminV1UpdateDatabaseMetadata {
824
831
  }
832
+ interface GoogleFirestoreAdminV1VectorConfig {
833
+ /**
834
+ * Required. The vector dimension this configuration applies to. The resulting index will only include vectors of this dimension, and can be used for vector search with the same
835
+ * dimension.
836
+ */
837
+ dimension?:
838
+ number;
839
+ /** Indicates the vector index is a flat index. */
840
+ flat?:
841
+ any;
842
+ }
825
843
  interface GoogleFirestoreAdminV1WeeklyRecurrence {
826
844
  /** The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. */
827
845
  day?:
@@ -1022,7 +1040,8 @@ declare namespace gapi.client {
1022
1040
  * Partition results. Each partition is a split point that can be used by RunQuery as a starting or end point for the query results. The RunQuery requests must be made with the same
1023
1041
  * query supplied to this PartitionQuery request. The partition cursors will be ordered according to same ordering as the results of the query supplied to PartitionQuery. For example,
1024
1042
  * if a PartitionQuery request returns partition cursors A and B, running the following three queries will return the entire result set of the original query: * query, end_at A *
1025
- * query, start_at A, end_at B * query, start_at B An empty result may indicate that the query has too few results to be partitioned.
1043
+ * query, start_at A, end_at B * query, start_at B An empty result may indicate that the query has too few results to be partitioned, or that the query is not yet supported for
1044
+ * partitioning.
1026
1045
  */
1027
1046
  partitions?:
1028
1047
  Cursor[];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.firestore-v1",
3
- "version": "0.0.20230921",
3
+ "version": "0.0.20231009",
4
4
  "description": "TypeScript typings for Cloud Firestore API v1",
5
5
  "license": "MIT",
6
6
  "author": {
package/tests.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
4
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
5
 
6
- // Revision: 20230921
6
+ // Revision: 20231009
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -207,6 +207,11 @@ gapi.load('client', async () => {
207
207
  arrayConfig: "Test string",
208
208
  fieldPath: "Test string",
209
209
  order: "Test string",
210
+ vectorConfig: {
211
+ dimension: 42,
212
+ flat: {
213
+ },
214
+ },
210
215
  }
211
216
  ],
212
217
  name: "Test string",
@@ -235,6 +240,11 @@ gapi.load('client', async () => {
235
240
  arrayConfig: "Test string",
236
241
  fieldPath: "Test string",
237
242
  order: "Test string",
243
+ vectorConfig: {
244
+ dimension: 42,
245
+ flat: {
246
+ },
247
+ },
238
248
  }
239
249
  ],
240
250
  name: "Test string",