@supabase/storage-js 2.81.1 → 2.81.2-canary.1
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.
- package/dist/main/StorageClient.d.ts +15 -0
- package/dist/main/StorageClient.d.ts.map +1 -1
- package/dist/main/StorageClient.js +15 -0
- package/dist/main/StorageClient.js.map +1 -1
- package/dist/main/lib/vectors/StorageVectorsClient.d.ts +49 -0
- package/dist/main/lib/vectors/StorageVectorsClient.d.ts.map +1 -1
- package/dist/main/lib/vectors/StorageVectorsClient.js +47 -0
- package/dist/main/lib/vectors/StorageVectorsClient.js.map +1 -1
- package/dist/main/lib/vectors/VectorBucketApi.d.ts +19 -0
- package/dist/main/lib/vectors/VectorBucketApi.d.ts.map +1 -1
- package/dist/main/lib/vectors/VectorBucketApi.js +19 -0
- package/dist/main/lib/vectors/VectorBucketApi.js.map +1 -1
- package/dist/main/lib/vectors/VectorDataApi.d.ts +23 -0
- package/dist/main/lib/vectors/VectorDataApi.d.ts.map +1 -1
- package/dist/main/lib/vectors/VectorDataApi.js +23 -0
- package/dist/main/lib/vectors/VectorDataApi.js.map +1 -1
- package/dist/main/lib/vectors/VectorIndexApi.d.ts +23 -0
- package/dist/main/lib/vectors/VectorIndexApi.d.ts.map +1 -1
- package/dist/main/lib/vectors/VectorIndexApi.js +21 -0
- package/dist/main/lib/vectors/VectorIndexApi.js.map +1 -1
- package/dist/main/lib/version.d.ts +1 -1
- package/dist/main/lib/version.d.ts.map +1 -1
- package/dist/main/lib/version.js +1 -1
- package/dist/main/lib/version.js.map +1 -1
- package/dist/module/StorageClient.d.ts +15 -0
- package/dist/module/StorageClient.d.ts.map +1 -1
- package/dist/module/StorageClient.js +15 -0
- package/dist/module/StorageClient.js.map +1 -1
- package/dist/module/lib/vectors/StorageVectorsClient.d.ts +49 -0
- package/dist/module/lib/vectors/StorageVectorsClient.d.ts.map +1 -1
- package/dist/module/lib/vectors/StorageVectorsClient.js +47 -0
- package/dist/module/lib/vectors/StorageVectorsClient.js.map +1 -1
- package/dist/module/lib/vectors/VectorBucketApi.d.ts +19 -0
- package/dist/module/lib/vectors/VectorBucketApi.d.ts.map +1 -1
- package/dist/module/lib/vectors/VectorBucketApi.js +19 -0
- package/dist/module/lib/vectors/VectorBucketApi.js.map +1 -1
- package/dist/module/lib/vectors/VectorDataApi.d.ts +23 -0
- package/dist/module/lib/vectors/VectorDataApi.d.ts.map +1 -1
- package/dist/module/lib/vectors/VectorDataApi.js +23 -0
- package/dist/module/lib/vectors/VectorDataApi.js.map +1 -1
- package/dist/module/lib/vectors/VectorIndexApi.d.ts +23 -0
- package/dist/module/lib/vectors/VectorIndexApi.d.ts.map +1 -1
- package/dist/module/lib/vectors/VectorIndexApi.js +21 -0
- package/dist/module/lib/vectors/VectorIndexApi.js.map +1 -1
- package/dist/module/lib/version.d.ts +1 -1
- package/dist/module/lib/version.d.ts.map +1 -1
- package/dist/module/lib/version.js +1 -1
- package/dist/module/lib/version.js.map +1 -1
- package/dist/tsconfig.module.tsbuildinfo +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/dist/umd/supabase.js +1 -1
- package/package.json +1 -1
- package/src/StorageClient.ts +15 -0
- package/src/lib/vectors/StorageVectorsClient.ts +49 -0
- package/src/lib/vectors/VectorBucketApi.ts +20 -3
- package/src/lib/vectors/VectorDataApi.ts +23 -0
- package/src/lib/vectors/VectorIndexApi.ts +23 -0
- package/src/lib/version.ts +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"VectorDataApi.d.ts","sourceRoot":"","sources":["../../../../src/lib/vectors/VectorDataApi.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAQ,MAAM,SAAS,CAAA;AAErC,OAAO,EACL,WAAW,EACX,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,mBAAmB,EACnB,oBAAoB,EACrB,MAAM,SAAS,CAAA;AAEhB
|
|
1
|
+
{"version":3,"file":"VectorDataApi.d.ts","sourceRoot":"","sources":["../../../../src/lib/vectors/VectorDataApi.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAQ,MAAM,SAAS,CAAA;AAErC,OAAO,EACL,WAAW,EACX,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,mBAAmB,EACnB,oBAAoB,EACrB,MAAM,SAAS,CAAA;AAEhB;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,aAAa;IAChC,SAAS,CAAC,GAAG,EAAE,MAAM,CAAA;IACrB,SAAS,CAAC,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IAC5C,SAAS,CAAC,KAAK,EAAE,KAAK,CAAA;IACtB,SAAS,CAAC,kBAAkB,UAAQ;IAEpC;;;;;;;;OAQG;gBACS,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAO,EAAE,KAAK,CAAC,EAAE,KAAK;IAM/E;;;;;;;;;;;;;OAaG;IACI,YAAY,IAAI,IAAI;IAK3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACG,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IAsB7E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC;IAiBtF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoDG;IACG,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,mBAAmB,CAAC,CAAC;IA6BzF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACG,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC;IAiB5F;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;CAqBpF"}
|
|
@@ -8,8 +8,19 @@ const helpers_1 = require("./helpers");
|
|
|
8
8
|
/**
|
|
9
9
|
* API class for managing Vector Data within Vector Indexes
|
|
10
10
|
* Provides methods for inserting, querying, listing, and deleting vector embeddings
|
|
11
|
+
*
|
|
12
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
11
13
|
*/
|
|
12
14
|
class VectorDataApi {
|
|
15
|
+
/**
|
|
16
|
+
* Creates a VectorDataApi bound to a Storage Vectors deployment.
|
|
17
|
+
*
|
|
18
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
19
|
+
*
|
|
20
|
+
* @param url - Base URL for the Storage Vectors API.
|
|
21
|
+
* @param headers - Default headers (for example authentication tokens).
|
|
22
|
+
* @param fetch - Optional custom `fetch` implementation for non-browser runtimes.
|
|
23
|
+
*/
|
|
13
24
|
constructor(url, headers = {}, fetch) {
|
|
14
25
|
this.shouldThrowOnError = false;
|
|
15
26
|
this.url = url.replace(/\/$/, '');
|
|
@@ -20,6 +31,8 @@ class VectorDataApi {
|
|
|
20
31
|
* Enable throwing errors instead of returning them in the response
|
|
21
32
|
* When enabled, failed operations will throw instead of returning { data: null, error }
|
|
22
33
|
*
|
|
34
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
35
|
+
*
|
|
23
36
|
* @returns This instance for method chaining
|
|
24
37
|
* @example
|
|
25
38
|
* ```typescript
|
|
@@ -36,6 +49,8 @@ class VectorDataApi {
|
|
|
36
49
|
* Inserts or updates vectors in batch (upsert operation)
|
|
37
50
|
* Accepts 1-500 vectors per request. Larger batches should be split
|
|
38
51
|
*
|
|
52
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
53
|
+
*
|
|
39
54
|
* @param options - Vector insertion options
|
|
40
55
|
* @param options.vectorBucketName - Name of the parent vector bucket
|
|
41
56
|
* @param options.indexName - Name of the target index
|
|
@@ -95,6 +110,8 @@ class VectorDataApi {
|
|
|
95
110
|
* Optionally includes vector data and/or metadata in response
|
|
96
111
|
* Additional permissions required when returning data or metadata
|
|
97
112
|
*
|
|
113
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
114
|
+
*
|
|
98
115
|
* @param options - Vector retrieval options
|
|
99
116
|
* @param options.vectorBucketName - Name of the parent vector bucket
|
|
100
117
|
* @param options.indexName - Name of the index
|
|
@@ -145,6 +162,8 @@ class VectorDataApi {
|
|
|
145
162
|
* Supports parallel scanning via segment configuration for high-throughput scenarios
|
|
146
163
|
* Additional permissions required when returning data or metadata
|
|
147
164
|
*
|
|
165
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
166
|
+
*
|
|
148
167
|
* @param options - Vector listing options
|
|
149
168
|
* @param options.vectorBucketName - Name of the parent vector bucket
|
|
150
169
|
* @param options.indexName - Name of the index
|
|
@@ -226,6 +245,8 @@ class VectorDataApi {
|
|
|
226
245
|
* Returns top-K most similar vectors based on the configured distance metric
|
|
227
246
|
* Supports optional metadata filtering (requires GetVectors permission)
|
|
228
247
|
*
|
|
248
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
249
|
+
*
|
|
229
250
|
* @param options - Query options
|
|
230
251
|
* @param options.vectorBucketName - Name of the parent vector bucket
|
|
231
252
|
* @param options.indexName - Name of the index
|
|
@@ -286,6 +307,8 @@ class VectorDataApi {
|
|
|
286
307
|
* Deletes vectors by their keys in batch
|
|
287
308
|
* Accepts 1-500 keys per request
|
|
288
309
|
*
|
|
310
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
311
|
+
*
|
|
289
312
|
* @param options - Vector deletion options
|
|
290
313
|
* @param options.vectorBucketName - Name of the parent vector bucket
|
|
291
314
|
* @param options.indexName - Name of the index
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"VectorDataApi.js","sourceRoot":"","sources":["../../../../src/lib/vectors/VectorDataApi.ts"],"names":[],"mappings":";;;AAAA,2CAA6C;AAC7C,qCAAgD;AAChD,mCAAqC;AACrC,uCAAwC;AAaxC
|
|
1
|
+
{"version":3,"file":"VectorDataApi.js","sourceRoot":"","sources":["../../../../src/lib/vectors/VectorDataApi.ts"],"names":[],"mappings":";;;AAAA,2CAA6C;AAC7C,qCAAgD;AAChD,mCAAqC;AACrC,uCAAwC;AAaxC;;;;;GAKG;AACH,MAAqB,aAAa;IAMhC;;;;;;;;OAQG;IACH,YAAY,GAAW,EAAE,UAAqC,EAAE,EAAE,KAAa;QAXrE,uBAAkB,GAAG,KAAK,CAAA;QAYlC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QACjC,IAAI,CAAC,OAAO,mCAAQ,2BAAe,GAAK,OAAO,CAAE,CAAA;QACjD,IAAI,CAAC,KAAK,GAAG,IAAA,sBAAY,EAAC,KAAK,CAAC,CAAA;IAClC,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,YAAY;QACjB,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAA;QAC9B,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACG,UAAU,CAAC,OAA0B;;YACzC,IAAI,CAAC;gBACH,sBAAsB;gBACtB,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;oBAC/D,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAA;gBACtE,CAAC;gBAED,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,aAAa,EAAE,OAAO,EAAE;oBACrE,OAAO,EAAE,IAAI,CAAC,OAAO;iBACtB,CAAC,CAAA;gBACF,OAAO,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;YAC1C,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC5B,MAAM,KAAK,CAAA;gBACb,CAAC;gBACD,IAAI,IAAA,8BAAqB,EAAC,KAAK,CAAC,EAAE,CAAC;oBACjC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;gBAC9B,CAAC;gBACD,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,UAAU,CAAC,OAA0B;;YACzC,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,aAAa,EAAE,OAAO,EAAE;oBACrE,OAAO,EAAE,IAAI,CAAC,OAAO;iBACtB,CAAC,CAAA;gBACF,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;YAC9B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC5B,MAAM,KAAK,CAAA;gBACb,CAAC;gBACD,IAAI,IAAA,8BAAqB,EAAC,KAAK,CAAC,EAAE,CAAC;oBACjC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;gBAC9B,CAAC;gBACD,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoDG;IACG,WAAW,CAAC,OAA2B;;YAC3C,IAAI,CAAC;gBACH,iCAAiC;gBACjC,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;oBACvC,IAAI,OAAO,CAAC,YAAY,GAAG,CAAC,IAAI,OAAO,CAAC,YAAY,GAAG,EAAE,EAAE,CAAC;wBAC1D,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;oBAC1D,CAAC;oBACD,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;wBACvC,IAAI,OAAO,CAAC,YAAY,GAAG,CAAC,IAAI,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;4BAC7E,MAAM,IAAI,KAAK,CAAC,sCAAsC,OAAO,CAAC,YAAY,GAAG,CAAC,EAAE,CAAC,CAAA;wBACnF,CAAC;oBACH,CAAC;gBACH,CAAC;gBAED,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,cAAc,EAAE,OAAO,EAAE;oBACtE,OAAO,EAAE,IAAI,CAAC,OAAO;iBACtB,CAAC,CAAA;gBACF,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;YAC9B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC5B,MAAM,KAAK,CAAA;gBACb,CAAC;gBACD,IAAI,IAAA,8BAAqB,EAAC,KAAK,CAAC,EAAE,CAAC;oBACjC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;gBAC9B,CAAC;gBACD,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACG,YAAY,CAAC,OAA4B;;YAC7C,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,eAAe,EAAE,OAAO,EAAE;oBACvE,OAAO,EAAE,IAAI,CAAC,OAAO;iBACtB,CAAC,CAAA;gBACF,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;YAC9B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC5B,MAAM,KAAK,CAAA;gBACb,CAAC;gBACD,IAAI,IAAA,8BAAqB,EAAC,KAAK,CAAC,EAAE,CAAC;oBACjC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;gBAC9B,CAAC;gBACD,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,aAAa,CAAC,OAA6B;;YAC/C,IAAI,CAAC;gBACH,sBAAsB;gBACtB,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;oBACzD,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;gBACpE,CAAC;gBAED,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,gBAAgB,EAAE,OAAO,EAAE;oBACxE,OAAO,EAAE,IAAI,CAAC,OAAO;iBACtB,CAAC,CAAA;gBACF,OAAO,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;YAC1C,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC5B,MAAM,KAAK,CAAA;gBACb,CAAC;gBACD,IAAI,IAAA,8BAAqB,EAAC,KAAK,CAAC,EAAE,CAAC;oBACjC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;gBAC9B,CAAC;gBACD,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;KAAA;CACF;AArVD,gCAqVC"}
|
|
@@ -2,6 +2,8 @@ import { Fetch } from './fetch';
|
|
|
2
2
|
import { ApiResponse, VectorIndex, ListIndexesOptions, ListIndexesResponse, VectorDataType, DistanceMetric, MetadataConfiguration } from './types';
|
|
3
3
|
/**
|
|
4
4
|
* Options for creating a vector index
|
|
5
|
+
*
|
|
6
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
5
7
|
*/
|
|
6
8
|
export interface CreateIndexOptions {
|
|
7
9
|
vectorBucketName: string;
|
|
@@ -14,6 +16,8 @@ export interface CreateIndexOptions {
|
|
|
14
16
|
/**
|
|
15
17
|
* API class for managing Vector Indexes within Vector Buckets
|
|
16
18
|
* Provides methods for creating, reading, listing, and deleting vector indexes
|
|
19
|
+
*
|
|
20
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
17
21
|
*/
|
|
18
22
|
export default class VectorIndexApi {
|
|
19
23
|
protected url: string;
|
|
@@ -22,6 +26,15 @@ export default class VectorIndexApi {
|
|
|
22
26
|
};
|
|
23
27
|
protected fetch: Fetch;
|
|
24
28
|
protected shouldThrowOnError: boolean;
|
|
29
|
+
/**
|
|
30
|
+
* Creates an API client for managing vector indexes.
|
|
31
|
+
*
|
|
32
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
33
|
+
*
|
|
34
|
+
* @param url - Base URL for the Storage Vectors API.
|
|
35
|
+
* @param headers - Default headers sent with each request.
|
|
36
|
+
* @param fetch - Optional custom `fetch` implementation for non-browser runtimes.
|
|
37
|
+
*/
|
|
25
38
|
constructor(url: string, headers?: {
|
|
26
39
|
[key: string]: string;
|
|
27
40
|
}, fetch?: Fetch);
|
|
@@ -29,6 +42,8 @@ export default class VectorIndexApi {
|
|
|
29
42
|
* Enable throwing errors instead of returning them in the response
|
|
30
43
|
* When enabled, failed operations will throw instead of returning { data: null, error }
|
|
31
44
|
*
|
|
45
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
46
|
+
*
|
|
32
47
|
* @returns This instance for method chaining
|
|
33
48
|
* @example
|
|
34
49
|
* ```typescript
|
|
@@ -42,6 +57,8 @@ export default class VectorIndexApi {
|
|
|
42
57
|
* Creates a new vector index within a bucket
|
|
43
58
|
* Defines the schema for vectors including dimensionality, distance metric, and metadata config
|
|
44
59
|
*
|
|
60
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
61
|
+
*
|
|
45
62
|
* @param options - Index configuration
|
|
46
63
|
* @param options.vectorBucketName - Name of the parent vector bucket
|
|
47
64
|
* @param options.indexName - Unique name for the index within the bucket
|
|
@@ -76,6 +93,8 @@ export default class VectorIndexApi {
|
|
|
76
93
|
* Retrieves metadata for a specific vector index
|
|
77
94
|
* Returns index configuration including dimension, distance metric, and metadata settings
|
|
78
95
|
*
|
|
96
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
97
|
+
*
|
|
79
98
|
* @param vectorBucketName - Name of the parent vector bucket
|
|
80
99
|
* @param indexName - Name of the index to retrieve
|
|
81
100
|
* @returns Promise with index metadata or error
|
|
@@ -100,6 +119,8 @@ export default class VectorIndexApi {
|
|
|
100
119
|
* Lists vector indexes within a bucket with optional filtering and pagination
|
|
101
120
|
* Supports prefix-based filtering and paginated results
|
|
102
121
|
*
|
|
122
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
123
|
+
*
|
|
103
124
|
* @param options - Listing options
|
|
104
125
|
* @param options.vectorBucketName - Name of the parent vector bucket
|
|
105
126
|
* @param options.prefix - Filter indexes by name prefix
|
|
@@ -135,6 +156,8 @@ export default class VectorIndexApi {
|
|
|
135
156
|
* Deletes a vector index and all its data
|
|
136
157
|
* This operation removes the index schema and all vectors stored in the index
|
|
137
158
|
*
|
|
159
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
160
|
+
*
|
|
138
161
|
* @param vectorBucketName - Name of the parent vector bucket
|
|
139
162
|
* @param indexName - Name of the index to delete
|
|
140
163
|
* @returns Promise with empty response on success or error
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"VectorIndexApi.d.ts","sourceRoot":"","sources":["../../../../src/lib/vectors/VectorIndexApi.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAQ,MAAM,SAAS,CAAA;AAErC,OAAO,EACL,WAAW,EACX,WAAW,EACX,kBAAkB,EAClB,mBAAmB,EACnB,cAAc,EACd,cAAc,EACd,qBAAqB,EACtB,MAAM,SAAS,CAAA;AAEhB
|
|
1
|
+
{"version":3,"file":"VectorIndexApi.d.ts","sourceRoot":"","sources":["../../../../src/lib/vectors/VectorIndexApi.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAQ,MAAM,SAAS,CAAA;AAErC,OAAO,EACL,WAAW,EACX,WAAW,EACX,kBAAkB,EAClB,mBAAmB,EACnB,cAAc,EACd,cAAc,EACd,qBAAqB,EACtB,MAAM,SAAS,CAAA;AAEhB;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,gBAAgB,EAAE,MAAM,CAAA;IACxB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,cAAc,CAAA;IACxB,SAAS,EAAE,MAAM,CAAA;IACjB,cAAc,EAAE,cAAc,CAAA;IAC9B,qBAAqB,CAAC,EAAE,qBAAqB,CAAA;CAC9C;AAED;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,cAAc;IACjC,SAAS,CAAC,GAAG,EAAE,MAAM,CAAA;IACrB,SAAS,CAAC,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IAC5C,SAAS,CAAC,KAAK,EAAE,KAAK,CAAA;IACtB,SAAS,CAAC,kBAAkB,UAAQ;IAEpC;;;;;;;;OAQG;gBACS,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAO,EAAE,KAAK,CAAC,EAAE,KAAK;IAM/E;;;;;;;;;;;;;OAaG;IACI,YAAY,IAAI,IAAI;IAK3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IAiB/E;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,QAAQ,CACZ,gBAAgB,EAAE,MAAM,EACxB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,WAAW,CAAC;QAAE,KAAK,EAAE,WAAW,CAAA;KAAE,CAAC,CAAC;IAoB/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACG,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,mBAAmB,CAAC,CAAC;IAiBzF;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,WAAW,CAAC,gBAAgB,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;CAmBhG"}
|
|
@@ -8,8 +8,19 @@ const helpers_1 = require("./helpers");
|
|
|
8
8
|
/**
|
|
9
9
|
* API class for managing Vector Indexes within Vector Buckets
|
|
10
10
|
* Provides methods for creating, reading, listing, and deleting vector indexes
|
|
11
|
+
*
|
|
12
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
11
13
|
*/
|
|
12
14
|
class VectorIndexApi {
|
|
15
|
+
/**
|
|
16
|
+
* Creates an API client for managing vector indexes.
|
|
17
|
+
*
|
|
18
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
19
|
+
*
|
|
20
|
+
* @param url - Base URL for the Storage Vectors API.
|
|
21
|
+
* @param headers - Default headers sent with each request.
|
|
22
|
+
* @param fetch - Optional custom `fetch` implementation for non-browser runtimes.
|
|
23
|
+
*/
|
|
13
24
|
constructor(url, headers = {}, fetch) {
|
|
14
25
|
this.shouldThrowOnError = false;
|
|
15
26
|
this.url = url.replace(/\/$/, '');
|
|
@@ -20,6 +31,8 @@ class VectorIndexApi {
|
|
|
20
31
|
* Enable throwing errors instead of returning them in the response
|
|
21
32
|
* When enabled, failed operations will throw instead of returning { data: null, error }
|
|
22
33
|
*
|
|
34
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
35
|
+
*
|
|
23
36
|
* @returns This instance for method chaining
|
|
24
37
|
* @example
|
|
25
38
|
* ```typescript
|
|
@@ -36,6 +49,8 @@ class VectorIndexApi {
|
|
|
36
49
|
* Creates a new vector index within a bucket
|
|
37
50
|
* Defines the schema for vectors including dimensionality, distance metric, and metadata config
|
|
38
51
|
*
|
|
52
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
53
|
+
*
|
|
39
54
|
* @param options - Index configuration
|
|
40
55
|
* @param options.vectorBucketName - Name of the parent vector bucket
|
|
41
56
|
* @param options.indexName - Unique name for the index within the bucket
|
|
@@ -88,6 +103,8 @@ class VectorIndexApi {
|
|
|
88
103
|
* Retrieves metadata for a specific vector index
|
|
89
104
|
* Returns index configuration including dimension, distance metric, and metadata settings
|
|
90
105
|
*
|
|
106
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
107
|
+
*
|
|
91
108
|
* @param vectorBucketName - Name of the parent vector bucket
|
|
92
109
|
* @param indexName - Name of the index to retrieve
|
|
93
110
|
* @returns Promise with index metadata or error
|
|
@@ -126,6 +143,8 @@ class VectorIndexApi {
|
|
|
126
143
|
* Lists vector indexes within a bucket with optional filtering and pagination
|
|
127
144
|
* Supports prefix-based filtering and paginated results
|
|
128
145
|
*
|
|
146
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
147
|
+
*
|
|
129
148
|
* @param options - Listing options
|
|
130
149
|
* @param options.vectorBucketName - Name of the parent vector bucket
|
|
131
150
|
* @param options.prefix - Filter indexes by name prefix
|
|
@@ -179,6 +198,8 @@ class VectorIndexApi {
|
|
|
179
198
|
* Deletes a vector index and all its data
|
|
180
199
|
* This operation removes the index schema and all vectors stored in the index
|
|
181
200
|
*
|
|
201
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
202
|
+
*
|
|
182
203
|
* @param vectorBucketName - Name of the parent vector bucket
|
|
183
204
|
* @param indexName - Name of the index to delete
|
|
184
205
|
* @returns Promise with empty response on success or error
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"VectorIndexApi.js","sourceRoot":"","sources":["../../../../src/lib/vectors/VectorIndexApi.ts"],"names":[],"mappings":";;;AAAA,2CAA6C;AAC7C,qCAAgD;AAChD,mCAAqC;AACrC,uCAAwC;
|
|
1
|
+
{"version":3,"file":"VectorIndexApi.js","sourceRoot":"","sources":["../../../../src/lib/vectors/VectorIndexApi.ts"],"names":[],"mappings":";;;AAAA,2CAA6C;AAC7C,qCAAgD;AAChD,mCAAqC;AACrC,uCAAwC;AAyBxC;;;;;GAKG;AACH,MAAqB,cAAc;IAMjC;;;;;;;;OAQG;IACH,YAAY,GAAW,EAAE,UAAqC,EAAE,EAAE,KAAa;QAXrE,uBAAkB,GAAG,KAAK,CAAA;QAYlC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QACjC,IAAI,CAAC,OAAO,mCAAQ,2BAAe,GAAK,OAAO,CAAE,CAAA;QACjD,IAAI,CAAC,KAAK,GAAG,IAAA,sBAAY,EAAC,KAAK,CAAC,CAAA;IAClC,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,YAAY;QACjB,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAA;QAC9B,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,WAAW,CAAC,OAA2B;;YAC3C,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,cAAc,EAAE,OAAO,EAAE;oBACtE,OAAO,EAAE,IAAI,CAAC,OAAO;iBACtB,CAAC,CAAA;gBACF,OAAO,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;YAC1C,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC5B,MAAM,KAAK,CAAA;gBACb,CAAC;gBACD,IAAI,IAAA,8BAAqB,EAAC,KAAK,CAAC,EAAE,CAAC;oBACjC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;gBAC9B,CAAC;gBACD,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,QAAQ,CACZ,gBAAwB,EACxB,SAAiB;;YAEjB,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EACrB,IAAI,CAAC,KAAK,EACV,GAAG,IAAI,CAAC,GAAG,WAAW,EACtB,EAAE,gBAAgB,EAAE,SAAS,EAAE,EAC/B,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAC1B,CAAA;gBACD,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;YAC9B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC5B,MAAM,KAAK,CAAA;gBACb,CAAC;gBACD,IAAI,IAAA,8BAAqB,EAAC,KAAK,CAAC,EAAE,CAAC;oBACjC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;gBAC9B,CAAC;gBACD,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACG,WAAW,CAAC,OAA2B;;YAC3C,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,cAAc,EAAE,OAAO,EAAE;oBACtE,OAAO,EAAE,IAAI,CAAC,OAAO;iBACtB,CAAC,CAAA;gBACF,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;YAC9B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC5B,MAAM,KAAK,CAAA;gBACb,CAAC;gBACD,IAAI,IAAA,8BAAqB,EAAC,KAAK,CAAC,EAAE,CAAC;oBACjC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;gBAC9B,CAAC;gBACD,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,WAAW,CAAC,gBAAwB,EAAE,SAAiB;;YAC3D,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EACrB,IAAI,CAAC,KAAK,EACV,GAAG,IAAI,CAAC,GAAG,cAAc,EACzB,EAAE,gBAAgB,EAAE,SAAS,EAAE,EAC/B,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAC1B,CAAA;gBACD,OAAO,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;YAC1C,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC5B,MAAM,KAAK,CAAA;gBACb,CAAC;gBACD,IAAI,IAAA,8BAAqB,EAAC,KAAK,CAAC,EAAE,CAAC;oBACjC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;gBAC9B,CAAC;gBACD,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;KAAA;CACF;AAzOD,iCAyOC"}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const version = "2.81.1";
|
|
1
|
+
export declare const version = "2.81.2-canary.1";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../../src/lib/version.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,OAAO,
|
|
1
|
+
{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../../src/lib/version.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,OAAO,oBAAoB,CAAA"}
|
package/dist/main/lib/version.js
CHANGED
|
@@ -7,5 +7,5 @@ exports.version = void 0;
|
|
|
7
7
|
// - Debugging and support (identifying which version is running)
|
|
8
8
|
// - Telemetry and logging (version reporting in errors/analytics)
|
|
9
9
|
// - Ensuring build artifacts match the published package version
|
|
10
|
-
exports.version = '2.81.1';
|
|
10
|
+
exports.version = '2.81.2-canary.1';
|
|
11
11
|
//# sourceMappingURL=version.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"version.js","sourceRoot":"","sources":["../../../src/lib/version.ts"],"names":[],"mappings":";;;AAAA,6EAA6E;AAC7E,gEAAgE;AAChE,uEAAuE;AACvE,iEAAiE;AACjE,kEAAkE;AAClE,iEAAiE;AACpD,QAAA,OAAO,GAAG,
|
|
1
|
+
{"version":3,"file":"version.js","sourceRoot":"","sources":["../../../src/lib/version.ts"],"names":[],"mappings":";;;AAAA,6EAA6E;AAC7E,gEAAgE;AAChE,uEAAuE;AACvE,iEAAiE;AACjE,kEAAkE;AAClE,iEAAiE;AACpD,QAAA,OAAO,GAAG,iBAAiB,CAAA"}
|
|
@@ -7,6 +7,19 @@ export interface StorageClientOptions {
|
|
|
7
7
|
useNewHostname?: boolean;
|
|
8
8
|
}
|
|
9
9
|
export declare class StorageClient extends StorageBucketApi {
|
|
10
|
+
/**
|
|
11
|
+
* Creates a client for Storage buckets, files, analytics, and vectors.
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```ts
|
|
15
|
+
* import { StorageClient } from '@supabase/storage-js'
|
|
16
|
+
*
|
|
17
|
+
* const storage = new StorageClient('https://xyzcompany.supabase.co/storage/v1', {
|
|
18
|
+
* apikey: 'public-anon-key',
|
|
19
|
+
* })
|
|
20
|
+
* const avatars = storage.from('avatars')
|
|
21
|
+
* ```
|
|
22
|
+
*/
|
|
10
23
|
constructor(url: string, headers?: {
|
|
11
24
|
[key: string]: string;
|
|
12
25
|
}, fetch?: Fetch, opts?: StorageClientOptions);
|
|
@@ -19,6 +32,8 @@ export declare class StorageClient extends StorageBucketApi {
|
|
|
19
32
|
/**
|
|
20
33
|
* Access vector storage operations.
|
|
21
34
|
*
|
|
35
|
+
* **Private alpha:** This API is part of a private alpha release and may change or be removed without notice.
|
|
36
|
+
*
|
|
22
37
|
* @returns A StorageVectorsClient instance configured with the current storage settings.
|
|
23
38
|
*/
|
|
24
39
|
get vectors(): StorageVectorsClient;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"StorageClient.d.ts","sourceRoot":"","sources":["../../src/StorageClient.ts"],"names":[],"mappings":"AAAA,OAAO,cAAc,MAAM,2BAA2B,CAAA;AACtD,OAAO,gBAAgB,MAAM,6BAA6B,CAAA;AAC1D,OAAO,mBAAmB,MAAM,gCAAgC,CAAA;AAChE,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AACnC,OAAO,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAA;AAEpD,MAAM,WAAW,oBAAoB;IACnC,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAED,qBAAa,aAAc,SAAQ,gBAAgB;
|
|
1
|
+
{"version":3,"file":"StorageClient.d.ts","sourceRoot":"","sources":["../../src/StorageClient.ts"],"names":[],"mappings":"AAAA,OAAO,cAAc,MAAM,2BAA2B,CAAA;AACtD,OAAO,gBAAgB,MAAM,6BAA6B,CAAA;AAC1D,OAAO,mBAAmB,MAAM,gCAAgC,CAAA;AAChE,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AACnC,OAAO,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAA;AAEpD,MAAM,WAAW,oBAAoB;IACnC,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAED,qBAAa,aAAc,SAAQ,gBAAgB;IACjD;;;;;;;;;;;;OAYG;gBAED,GAAG,EAAE,MAAM,EACX,OAAO,GAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAO,EACvC,KAAK,CAAC,EAAE,KAAK,EACb,IAAI,CAAC,EAAE,oBAAoB;IAK7B;;;;OAIG;IACH,IAAI,CAAC,EAAE,EAAE,MAAM,GAAG,cAAc;IAIhC;;;;;;OAMG;IACH,IAAI,OAAO,IAAI,oBAAoB,CAKlC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,SAAS,IAAI,mBAAmB,CAEnC;CACF"}
|
|
@@ -3,6 +3,19 @@ import StorageBucketApi from './packages/StorageBucketApi';
|
|
|
3
3
|
import StorageAnalyticsApi from './packages/StorageAnalyticsApi';
|
|
4
4
|
import { StorageVectorsClient } from './lib/vectors';
|
|
5
5
|
export class StorageClient extends StorageBucketApi {
|
|
6
|
+
/**
|
|
7
|
+
* Creates a client for Storage buckets, files, analytics, and vectors.
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* ```ts
|
|
11
|
+
* import { StorageClient } from '@supabase/storage-js'
|
|
12
|
+
*
|
|
13
|
+
* const storage = new StorageClient('https://xyzcompany.supabase.co/storage/v1', {
|
|
14
|
+
* apikey: 'public-anon-key',
|
|
15
|
+
* })
|
|
16
|
+
* const avatars = storage.from('avatars')
|
|
17
|
+
* ```
|
|
18
|
+
*/
|
|
6
19
|
constructor(url, headers = {}, fetch, opts) {
|
|
7
20
|
super(url, headers, fetch, opts);
|
|
8
21
|
}
|
|
@@ -17,6 +30,8 @@ export class StorageClient extends StorageBucketApi {
|
|
|
17
30
|
/**
|
|
18
31
|
* Access vector storage operations.
|
|
19
32
|
*
|
|
33
|
+
* **Private alpha:** This API is part of a private alpha release and may change or be removed without notice.
|
|
34
|
+
*
|
|
20
35
|
* @returns A StorageVectorsClient instance configured with the current storage settings.
|
|
21
36
|
*/
|
|
22
37
|
get vectors() {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"StorageClient.js","sourceRoot":"","sources":["../../src/StorageClient.ts"],"names":[],"mappings":"AAAA,OAAO,cAAc,MAAM,2BAA2B,CAAA;AACtD,OAAO,gBAAgB,MAAM,6BAA6B,CAAA;AAC1D,OAAO,mBAAmB,MAAM,gCAAgC,CAAA;AAEhE,OAAO,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAA;AAMpD,MAAM,OAAO,aAAc,SAAQ,gBAAgB;IACjD,YACE,GAAW,EACX,UAAqC,EAAE,EACvC,KAAa,EACb,IAA2B;QAE3B,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;IAClC,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC,EAAU;QACb,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,EAAE,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;IACnE,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"StorageClient.js","sourceRoot":"","sources":["../../src/StorageClient.ts"],"names":[],"mappings":"AAAA,OAAO,cAAc,MAAM,2BAA2B,CAAA;AACtD,OAAO,gBAAgB,MAAM,6BAA6B,CAAA;AAC1D,OAAO,mBAAmB,MAAM,gCAAgC,CAAA;AAEhE,OAAO,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAA;AAMpD,MAAM,OAAO,aAAc,SAAQ,gBAAgB;IACjD;;;;;;;;;;;;OAYG;IACH,YACE,GAAW,EACX,UAAqC,EAAE,EACvC,KAAa,EACb,IAA2B;QAE3B,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;IAClC,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC,EAAU;QACb,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,EAAE,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;IACnE,CAAC;IAED;;;;;;OAMG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,oBAAoB,CAAC,IAAI,CAAC,GAAG,GAAG,SAAS,EAAE;YACpD,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,KAAK,EAAE,IAAI,CAAC,KAAK;SAClB,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,mBAAmB,CAAC,IAAI,CAAC,GAAG,GAAG,UAAU,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;IACjF,CAAC;CACF"}
|
|
@@ -5,6 +5,8 @@ import VectorBucketApi from './VectorBucketApi';
|
|
|
5
5
|
import { DeleteVectorsOptions, GetVectorsOptions, ListIndexesOptions, ListVectorsOptions, PutVectorsOptions, QueryVectorsOptions } from './types';
|
|
6
6
|
/**
|
|
7
7
|
* Configuration options for the Storage Vectors client
|
|
8
|
+
*
|
|
9
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
8
10
|
*/
|
|
9
11
|
export interface StorageVectorsClientOptions {
|
|
10
12
|
/**
|
|
@@ -23,6 +25,8 @@ export interface StorageVectorsClientOptions {
|
|
|
23
25
|
* Main client for interacting with S3 Vectors API
|
|
24
26
|
* Provides access to bucket, index, and vector data operations
|
|
25
27
|
*
|
|
28
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
29
|
+
*
|
|
26
30
|
* **Usage Patterns:**
|
|
27
31
|
*
|
|
28
32
|
* 1. **Via StorageClient (recommended for most use cases):**
|
|
@@ -75,11 +79,22 @@ export interface StorageVectorsClientOptions {
|
|
|
75
79
|
* ```
|
|
76
80
|
*/
|
|
77
81
|
export declare class StorageVectorsClient extends VectorBucketApi {
|
|
82
|
+
/**
|
|
83
|
+
* Creates a StorageVectorsClient that can manage buckets, indexes, and vectors.
|
|
84
|
+
*
|
|
85
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
86
|
+
*
|
|
87
|
+
* @param url - Base URL of the Storage Vectors REST API.
|
|
88
|
+
* @param options.headers - Optional headers (for example `Authorization`) applied to every request.
|
|
89
|
+
* @param options.fetch - Optional custom `fetch` implementation for non-browser runtimes.
|
|
90
|
+
*/
|
|
78
91
|
constructor(url: string, options?: StorageVectorsClientOptions);
|
|
79
92
|
/**
|
|
80
93
|
* Access operations for a specific vector bucket
|
|
81
94
|
* Returns a scoped client for index and vector operations within the bucket
|
|
82
95
|
*
|
|
96
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
97
|
+
*
|
|
83
98
|
* @param vectorBucketName - Name of the vector bucket
|
|
84
99
|
* @returns Bucket-scoped client with index and vector operations
|
|
85
100
|
*
|
|
@@ -104,9 +119,16 @@ export declare class StorageVectorsClient extends VectorBucketApi {
|
|
|
104
119
|
/**
|
|
105
120
|
* Scoped client for operations within a specific vector bucket
|
|
106
121
|
* Provides index management and access to vector operations
|
|
122
|
+
*
|
|
123
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
107
124
|
*/
|
|
108
125
|
export declare class VectorBucketScope extends VectorIndexApi {
|
|
109
126
|
private vectorBucketName;
|
|
127
|
+
/**
|
|
128
|
+
* Creates a helper that automatically scopes all index operations to the provided bucket.
|
|
129
|
+
*
|
|
130
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
131
|
+
*/
|
|
110
132
|
constructor(url: string, headers: {
|
|
111
133
|
[key: string]: string;
|
|
112
134
|
}, vectorBucketName: string, fetch?: Fetch);
|
|
@@ -114,6 +136,8 @@ export declare class VectorBucketScope extends VectorIndexApi {
|
|
|
114
136
|
* Creates a new vector index in this bucket
|
|
115
137
|
* Convenience method that automatically includes the bucket name
|
|
116
138
|
*
|
|
139
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
140
|
+
*
|
|
117
141
|
* @param options - Index configuration (vectorBucketName is automatically set)
|
|
118
142
|
* @returns Promise with empty response on success or error
|
|
119
143
|
*
|
|
@@ -136,6 +160,8 @@ export declare class VectorBucketScope extends VectorIndexApi {
|
|
|
136
160
|
* Lists indexes in this bucket
|
|
137
161
|
* Convenience method that automatically includes the bucket name
|
|
138
162
|
*
|
|
163
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
164
|
+
*
|
|
139
165
|
* @param options - Listing options (vectorBucketName is automatically set)
|
|
140
166
|
* @returns Promise with list of indexes or error
|
|
141
167
|
*
|
|
@@ -150,6 +176,8 @@ export declare class VectorBucketScope extends VectorIndexApi {
|
|
|
150
176
|
* Retrieves metadata for a specific index in this bucket
|
|
151
177
|
* Convenience method that automatically includes the bucket name
|
|
152
178
|
*
|
|
179
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
180
|
+
*
|
|
153
181
|
* @param indexName - Name of the index to retrieve
|
|
154
182
|
* @returns Promise with index metadata or error
|
|
155
183
|
*
|
|
@@ -167,6 +195,8 @@ export declare class VectorBucketScope extends VectorIndexApi {
|
|
|
167
195
|
* Deletes an index from this bucket
|
|
168
196
|
* Convenience method that automatically includes the bucket name
|
|
169
197
|
*
|
|
198
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
199
|
+
*
|
|
170
200
|
* @param indexName - Name of the index to delete
|
|
171
201
|
* @returns Promise with empty response on success or error
|
|
172
202
|
*
|
|
@@ -181,6 +211,8 @@ export declare class VectorBucketScope extends VectorIndexApi {
|
|
|
181
211
|
* Access operations for a specific index within this bucket
|
|
182
212
|
* Returns a scoped client for vector data operations
|
|
183
213
|
*
|
|
214
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
215
|
+
*
|
|
184
216
|
* @param indexName - Name of the index
|
|
185
217
|
* @returns Index-scoped client with vector data operations
|
|
186
218
|
*
|
|
@@ -207,10 +239,17 @@ export declare class VectorBucketScope extends VectorIndexApi {
|
|
|
207
239
|
/**
|
|
208
240
|
* Scoped client for operations within a specific vector index
|
|
209
241
|
* Provides vector data operations (put, get, list, query, delete)
|
|
242
|
+
*
|
|
243
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
210
244
|
*/
|
|
211
245
|
export declare class VectorIndexScope extends VectorDataApi {
|
|
212
246
|
private vectorBucketName;
|
|
213
247
|
private indexName;
|
|
248
|
+
/**
|
|
249
|
+
* Creates a helper that automatically scopes all vector operations to the provided bucket/index names.
|
|
250
|
+
*
|
|
251
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
252
|
+
*/
|
|
214
253
|
constructor(url: string, headers: {
|
|
215
254
|
[key: string]: string;
|
|
216
255
|
}, vectorBucketName: string, indexName: string, fetch?: Fetch);
|
|
@@ -218,6 +257,8 @@ export declare class VectorIndexScope extends VectorDataApi {
|
|
|
218
257
|
* Inserts or updates vectors in this index
|
|
219
258
|
* Convenience method that automatically includes bucket and index names
|
|
220
259
|
*
|
|
260
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
261
|
+
*
|
|
221
262
|
* @param options - Vector insertion options (bucket and index names automatically set)
|
|
222
263
|
* @returns Promise with empty response on success or error
|
|
223
264
|
*
|
|
@@ -240,6 +281,8 @@ export declare class VectorIndexScope extends VectorDataApi {
|
|
|
240
281
|
* Retrieves vectors by keys from this index
|
|
241
282
|
* Convenience method that automatically includes bucket and index names
|
|
242
283
|
*
|
|
284
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
285
|
+
*
|
|
243
286
|
* @param options - Vector retrieval options (bucket and index names automatically set)
|
|
244
287
|
* @returns Promise with array of vectors or error
|
|
245
288
|
*
|
|
@@ -257,6 +300,8 @@ export declare class VectorIndexScope extends VectorDataApi {
|
|
|
257
300
|
* Lists vectors in this index with pagination
|
|
258
301
|
* Convenience method that automatically includes bucket and index names
|
|
259
302
|
*
|
|
303
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
304
|
+
*
|
|
260
305
|
* @param options - Listing options (bucket and index names automatically set)
|
|
261
306
|
* @returns Promise with array of vectors and pagination token
|
|
262
307
|
*
|
|
@@ -274,6 +319,8 @@ export declare class VectorIndexScope extends VectorDataApi {
|
|
|
274
319
|
* Queries for similar vectors in this index
|
|
275
320
|
* Convenience method that automatically includes bucket and index names
|
|
276
321
|
*
|
|
322
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
323
|
+
*
|
|
277
324
|
* @param options - Query options (bucket and index names automatically set)
|
|
278
325
|
* @returns Promise with array of similar vectors ordered by distance
|
|
279
326
|
*
|
|
@@ -294,6 +341,8 @@ export declare class VectorIndexScope extends VectorDataApi {
|
|
|
294
341
|
* Deletes vectors by keys from this index
|
|
295
342
|
* Convenience method that automatically includes bucket and index names
|
|
296
343
|
*
|
|
344
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
345
|
+
*
|
|
297
346
|
* @param options - Deletion options (bucket and index names automatically set)
|
|
298
347
|
* @returns Promise with empty response on success or error
|
|
299
348
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"StorageVectorsClient.d.ts","sourceRoot":"","sources":["../../../../src/lib/vectors/StorageVectorsClient.ts"],"names":[],"mappings":"AAAA,OAAO,cAAc,EAAE,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAA;AACrE,OAAO,aAAa,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAC/B,OAAO,eAAe,MAAM,mBAAmB,CAAA;AAC/C,OAAO,EACL,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,mBAAmB,EACpB,MAAM,SAAS,CAAA;AAEhB
|
|
1
|
+
{"version":3,"file":"StorageVectorsClient.d.ts","sourceRoot":"","sources":["../../../../src/lib/vectors/StorageVectorsClient.ts"],"names":[],"mappings":"AAAA,OAAO,cAAc,EAAE,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAA;AACrE,OAAO,aAAa,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAC/B,OAAO,eAAe,MAAM,mBAAmB,CAAA;AAC/C,OAAO,EACL,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,mBAAmB,EACpB,MAAM,SAAS,CAAA;AAEhB;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IACnC;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAA;CACd;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,qBAAa,oBAAqB,SAAQ,eAAe;IACvD;;;;;;;;OAQG;gBACS,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,2BAAgC;IAIlE;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,IAAI,CAAC,gBAAgB,EAAE,MAAM,GAAG,iBAAiB;CAGlD;AAED;;;;;GAKG;AACH,qBAAa,iBAAkB,SAAQ,cAAc;IACnD,OAAO,CAAC,gBAAgB,CAAQ;IAEhC;;;;OAIG;gBAED,GAAG,EAAE,MAAM,EACX,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,EAClC,gBAAgB,EAAE,MAAM,EACxB,KAAK,CAAC,EAAE,KAAK;IAMf;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACY,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;IAOhF;;;;;;;;;;;;;;OAcG;IACY,WAAW,CAAC,OAAO,GAAE,IAAI,CAAC,kBAAkB,EAAE,kBAAkB,CAAM;IAOrF;;;;;;;;;;;;;;;OAeG;IACY,QAAQ,CAAC,SAAS,EAAE,MAAM;;;IAIzC;;;;;;;;;;;;;;OAcG;IACY,WAAW,CAAC,SAAS,EAAE,MAAM;IAI5C;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,KAAK,CAAC,SAAS,EAAE,MAAM,GAAG,gBAAgB;CAS3C;AAED;;;;;GAKG;AACH,qBAAa,gBAAiB,SAAQ,aAAa;IACjD,OAAO,CAAC,gBAAgB,CAAQ;IAChC,OAAO,CAAC,SAAS,CAAQ;IAEzB;;;;OAIG;gBAED,GAAG,EAAE,MAAM,EACX,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,EAClC,gBAAgB,EAAE,MAAM,EACxB,SAAS,EAAE,MAAM,EACjB,KAAK,CAAC,EAAE,KAAK;IAOf;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACY,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,iBAAiB,EAAE,kBAAkB,GAAG,WAAW,CAAC;IAQ5F;;;;;;;;;;;;;;;;;OAiBG;IACY,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,iBAAiB,EAAE,kBAAkB,GAAG,WAAW,CAAC;IAQ5F;;;;;;;;;;;;;;;;;OAiBG;IACY,WAAW,CACxB,OAAO,GAAE,IAAI,CAAC,kBAAkB,EAAE,kBAAkB,GAAG,WAAW,CAAM;IAS1E;;;;;;;;;;;;;;;;;;;;OAoBG;IACY,YAAY,CACzB,OAAO,EAAE,IAAI,CAAC,mBAAmB,EAAE,kBAAkB,GAAG,WAAW,CAAC;IAStE;;;;;;;;;;;;;;;;OAgBG;IACY,aAAa,CAC1B,OAAO,EAAE,IAAI,CAAC,oBAAoB,EAAE,kBAAkB,GAAG,WAAW,CAAC;CAQxE"}
|