@supabase/storage-js 2.84.1-canary.1 → 2.85.1-canary.0
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/README.md +74 -7
- package/dist/main/lib/helpers.d.ts +16 -0
- package/dist/main/lib/helpers.d.ts.map +1 -1
- package/dist/main/lib/helpers.js +41 -1
- package/dist/main/lib/helpers.js.map +1 -1
- package/dist/main/lib/vectors/StorageVectorsClient.d.ts +108 -14
- package/dist/main/lib/vectors/StorageVectorsClient.d.ts.map +1 -1
- package/dist/main/lib/vectors/StorageVectorsClient.js +124 -4
- package/dist/main/lib/vectors/StorageVectorsClient.js.map +1 -1
- package/dist/main/lib/version.d.ts +1 -1
- package/dist/main/lib/version.js +1 -1
- package/dist/main/packages/StorageAnalyticsClient.d.ts +142 -5
- package/dist/main/packages/StorageAnalyticsClient.d.ts.map +1 -1
- package/dist/main/packages/StorageAnalyticsClient.js +160 -4
- package/dist/main/packages/StorageAnalyticsClient.js.map +1 -1
- package/dist/main/packages/StorageBucketApi.d.ts +4 -4
- package/dist/main/packages/StorageBucketApi.js +4 -4
- package/dist/main/packages/StorageFileApi.d.ts +12 -12
- package/dist/main/packages/StorageFileApi.js +12 -12
- package/dist/module/lib/helpers.d.ts +16 -0
- package/dist/module/lib/helpers.d.ts.map +1 -1
- package/dist/module/lib/helpers.js +39 -0
- package/dist/module/lib/helpers.js.map +1 -1
- package/dist/module/lib/vectors/StorageVectorsClient.d.ts +108 -14
- package/dist/module/lib/vectors/StorageVectorsClient.d.ts.map +1 -1
- package/dist/module/lib/vectors/StorageVectorsClient.js +124 -4
- package/dist/module/lib/vectors/StorageVectorsClient.js.map +1 -1
- package/dist/module/lib/version.d.ts +1 -1
- package/dist/module/lib/version.js +1 -1
- package/dist/module/packages/StorageAnalyticsClient.d.ts +142 -5
- package/dist/module/packages/StorageAnalyticsClient.d.ts.map +1 -1
- package/dist/module/packages/StorageAnalyticsClient.js +162 -6
- package/dist/module/packages/StorageAnalyticsClient.js.map +1 -1
- package/dist/module/packages/StorageBucketApi.d.ts +4 -4
- package/dist/module/packages/StorageBucketApi.js +4 -4
- package/dist/module/packages/StorageFileApi.d.ts +12 -12
- package/dist/module/packages/StorageFileApi.js +12 -12
- package/dist/tsconfig.module.tsbuildinfo +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/dist/umd/supabase.js +1 -1
- package/package.json +2 -1
- package/src/lib/helpers.ts +44 -0
- package/src/lib/vectors/StorageVectorsClient.ts +114 -4
- package/src/lib/version.ts +1 -1
- package/src/packages/StorageAnalyticsClient.ts +166 -6
- package/src/packages/StorageBucketApi.ts +4 -4
- package/src/packages/StorageFileApi.ts +12 -12
package/README.md
CHANGED
|
@@ -67,7 +67,8 @@ If you're already using `@supabase/supabase-js`, access storage through the clie
|
|
|
67
67
|
```js
|
|
68
68
|
import { createClient } from '@supabase/supabase-js'
|
|
69
69
|
|
|
70
|
-
|
|
70
|
+
// Use publishable/anon key for frontend applications
|
|
71
|
+
const supabase = createClient('https://<project_ref>.supabase.co', '<your-publishable-key>')
|
|
71
72
|
|
|
72
73
|
// Access storage
|
|
73
74
|
const storage = supabase.storage
|
|
@@ -80,13 +81,13 @@ const analyticsBucket = storage.analytics // Analytics API
|
|
|
80
81
|
|
|
81
82
|
#### Option 2: Standalone StorageClient
|
|
82
83
|
|
|
83
|
-
For applications
|
|
84
|
+
For backend applications or when you need to bypass Row Level Security:
|
|
84
85
|
|
|
85
86
|
```js
|
|
86
87
|
import { StorageClient } from '@supabase/storage-js'
|
|
87
88
|
|
|
88
89
|
const STORAGE_URL = 'https://<project_ref>.supabase.co/storage/v1'
|
|
89
|
-
const SERVICE_KEY = '<
|
|
90
|
+
const SERVICE_KEY = '<your-secret-key>' // Use secret key for backend operations
|
|
90
91
|
|
|
91
92
|
const storageClient = new StorageClient(STORAGE_URL, {
|
|
92
93
|
apikey: SERVICE_KEY,
|
|
@@ -101,8 +102,10 @@ const analyticsBucket = storageClient.analytics // Analytics API
|
|
|
101
102
|
|
|
102
103
|
> **When to use each approach:**
|
|
103
104
|
>
|
|
104
|
-
> - Use `supabase.storage` when working with other Supabase features (auth, database, etc.)
|
|
105
|
-
> - Use `new StorageClient()` for
|
|
105
|
+
> - Use `supabase.storage` when working with other Supabase features (auth, database, etc.) in frontend applications
|
|
106
|
+
> - Use `new StorageClient()` for backend applications, Edge Functions, or when you need to bypass RLS policies
|
|
107
|
+
|
|
108
|
+
> **Note:** Refer to the [Storage Access Control guide](https://supabase.com/docs/guides/storage/access-control) for detailed information on creating RLS policies.
|
|
106
109
|
|
|
107
110
|
### Understanding Bucket Types
|
|
108
111
|
|
|
@@ -340,7 +343,7 @@ You can access analytics functionality through the `analytics` property on your
|
|
|
340
343
|
```typescript
|
|
341
344
|
import { createClient } from '@supabase/supabase-js'
|
|
342
345
|
|
|
343
|
-
const supabase = createClient('https://your-project.supabase.co', 'your-
|
|
346
|
+
const supabase = createClient('https://your-project.supabase.co', 'your-publishable-key')
|
|
344
347
|
|
|
345
348
|
// Access analytics operations
|
|
346
349
|
const analytics = supabase.storage.analytics
|
|
@@ -485,6 +488,70 @@ if (error) {
|
|
|
485
488
|
|
|
486
489
|
> **Note:** A bucket cannot be deleted if it contains data. You must empty the bucket first.
|
|
487
490
|
|
|
491
|
+
#### Get Iceberg Catalog for Advanced Operations
|
|
492
|
+
|
|
493
|
+
For advanced operations like creating tables, namespaces, and querying Iceberg metadata, use the `from()` method to get a configured [iceberg-js](https://github.com/supabase/iceberg-js) client:
|
|
494
|
+
|
|
495
|
+
```typescript
|
|
496
|
+
// Get an Iceberg REST Catalog client for your analytics bucket
|
|
497
|
+
const catalog = analytics.from('analytics-data')
|
|
498
|
+
|
|
499
|
+
// Create a namespace
|
|
500
|
+
await catalog.createNamespace({ namespace: ['default'] }, { properties: { owner: 'data-team' } })
|
|
501
|
+
|
|
502
|
+
// Create a table with schema
|
|
503
|
+
await catalog.createTable(
|
|
504
|
+
{ namespace: ['default'] },
|
|
505
|
+
{
|
|
506
|
+
name: 'events',
|
|
507
|
+
schema: {
|
|
508
|
+
type: 'struct',
|
|
509
|
+
fields: [
|
|
510
|
+
{ id: 1, name: 'id', type: 'long', required: true },
|
|
511
|
+
{ id: 2, name: 'timestamp', type: 'timestamp', required: true },
|
|
512
|
+
{ id: 3, name: 'user_id', type: 'string', required: false },
|
|
513
|
+
],
|
|
514
|
+
'schema-id': 0,
|
|
515
|
+
'identifier-field-ids': [1],
|
|
516
|
+
},
|
|
517
|
+
'partition-spec': {
|
|
518
|
+
'spec-id': 0,
|
|
519
|
+
fields: [],
|
|
520
|
+
},
|
|
521
|
+
'write-order': {
|
|
522
|
+
'order-id': 0,
|
|
523
|
+
fields: [],
|
|
524
|
+
},
|
|
525
|
+
properties: {
|
|
526
|
+
'write.format.default': 'parquet',
|
|
527
|
+
},
|
|
528
|
+
}
|
|
529
|
+
)
|
|
530
|
+
|
|
531
|
+
// List tables in namespace
|
|
532
|
+
const tables = await catalog.listTables({ namespace: ['default'] })
|
|
533
|
+
console.log(tables) // [{ namespace: ['default'], name: 'events' }]
|
|
534
|
+
|
|
535
|
+
// Load table metadata
|
|
536
|
+
const table = await catalog.loadTable({ namespace: ['default'], name: 'events' })
|
|
537
|
+
|
|
538
|
+
// Update table properties
|
|
539
|
+
await catalog.updateTable(
|
|
540
|
+
{ namespace: ['default'], name: 'events' },
|
|
541
|
+
{ properties: { 'read.split.target-size': '134217728' } }
|
|
542
|
+
)
|
|
543
|
+
|
|
544
|
+
// Drop table
|
|
545
|
+
await catalog.dropTable({ namespace: ['default'], name: 'events' })
|
|
546
|
+
|
|
547
|
+
// Drop namespace
|
|
548
|
+
await catalog.dropNamespace({ namespace: ['default'] })
|
|
549
|
+
```
|
|
550
|
+
|
|
551
|
+
**Returns:** `IcebergRestCatalog` instance from [iceberg-js](https://github.com/supabase/iceberg-js)
|
|
552
|
+
|
|
553
|
+
> **Note:** The `from()` method returns an Iceberg REST Catalog client that provides full access to the Apache Iceberg REST API. For complete documentation of available operations, see the [iceberg-js documentation](https://supabase.github.io/iceberg-js/).
|
|
554
|
+
|
|
488
555
|
### Error Handling
|
|
489
556
|
|
|
490
557
|
Analytics buckets use the same error handling pattern as the rest of the Storage SDK:
|
|
@@ -646,7 +713,7 @@ If you're using the full Supabase client:
|
|
|
646
713
|
```typescript
|
|
647
714
|
import { createClient } from '@supabase/supabase-js'
|
|
648
715
|
|
|
649
|
-
const supabase = createClient('https://your-project.supabase.co', 'your-
|
|
716
|
+
const supabase = createClient('https://your-project.supabase.co', 'your-publishable-key')
|
|
650
717
|
|
|
651
718
|
// Access vector operations through storage
|
|
652
719
|
const vectors = supabase.storage.vectors
|
|
@@ -8,5 +8,21 @@ export declare const recursiveToCamel: (item: Record<string, any>) => unknown;
|
|
|
8
8
|
* source: https://github.com/sindresorhus/is-plain-obj
|
|
9
9
|
*/
|
|
10
10
|
export declare const isPlainObject: (value: object) => boolean;
|
|
11
|
+
/**
|
|
12
|
+
* Validates if a given bucket name is valid according to Supabase Storage API rules
|
|
13
|
+
* Mirrors backend validation from: storage/src/storage/limits.ts:isValidBucketName()
|
|
14
|
+
*
|
|
15
|
+
* Rules:
|
|
16
|
+
* - Length: 1-100 characters
|
|
17
|
+
* - Allowed characters: alphanumeric (a-z, A-Z, 0-9), underscore (_), and safe special characters
|
|
18
|
+
* - Safe special characters: ! - . * ' ( ) space & $ @ = ; : + , ?
|
|
19
|
+
* - Forbidden: path separators (/, \), path traversal (..), leading/trailing whitespace
|
|
20
|
+
*
|
|
21
|
+
* AWS S3 Reference: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html
|
|
22
|
+
*
|
|
23
|
+
* @param bucketName - The bucket name to validate
|
|
24
|
+
* @returns true if valid, false otherwise
|
|
25
|
+
*/
|
|
26
|
+
export declare const isValidBucketName: (bucketName: string) => boolean;
|
|
11
27
|
export {};
|
|
12
28
|
//# sourceMappingURL=helpers.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../src/lib/helpers.ts"],"names":[],"mappings":"AAAA,KAAK,KAAK,GAAG,OAAO,KAAK,CAAA;AAEzB,eAAO,MAAM,YAAY,GAAI,cAAc,KAAK,KAAG,KAKlD,CAAA;AAED,eAAO,MAAM,eAAe,QAAO,OAAO,QAEzC,CAAA;AAED,eAAO,MAAM,gBAAgB,GAAI,MAAM,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAG,OAc5D,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,aAAa,GAAI,OAAO,MAAM,KAAG,OAa7C,CAAA"}
|
|
1
|
+
{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../src/lib/helpers.ts"],"names":[],"mappings":"AAAA,KAAK,KAAK,GAAG,OAAO,KAAK,CAAA;AAEzB,eAAO,MAAM,YAAY,GAAI,cAAc,KAAK,KAAG,KAKlD,CAAA;AAED,eAAO,MAAM,eAAe,QAAO,OAAO,QAEzC,CAAA;AAED,eAAO,MAAM,gBAAgB,GAAI,MAAM,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAG,OAc5D,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,aAAa,GAAI,OAAO,MAAM,KAAG,OAa7C,CAAA;AAED;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,iBAAiB,GAAI,YAAY,MAAM,KAAG,OA2BtD,CAAA"}
|
package/dist/main/lib/helpers.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.isPlainObject = exports.recursiveToCamel = exports.resolveResponse = exports.resolveFetch = void 0;
|
|
3
|
+
exports.isValidBucketName = exports.isPlainObject = exports.recursiveToCamel = exports.resolveResponse = exports.resolveFetch = void 0;
|
|
4
4
|
const resolveFetch = (customFetch) => {
|
|
5
5
|
if (customFetch) {
|
|
6
6
|
return (...args) => customFetch(...args);
|
|
@@ -44,4 +44,44 @@ const isPlainObject = (value) => {
|
|
|
44
44
|
!(Symbol.iterator in value));
|
|
45
45
|
};
|
|
46
46
|
exports.isPlainObject = isPlainObject;
|
|
47
|
+
/**
|
|
48
|
+
* Validates if a given bucket name is valid according to Supabase Storage API rules
|
|
49
|
+
* Mirrors backend validation from: storage/src/storage/limits.ts:isValidBucketName()
|
|
50
|
+
*
|
|
51
|
+
* Rules:
|
|
52
|
+
* - Length: 1-100 characters
|
|
53
|
+
* - Allowed characters: alphanumeric (a-z, A-Z, 0-9), underscore (_), and safe special characters
|
|
54
|
+
* - Safe special characters: ! - . * ' ( ) space & $ @ = ; : + , ?
|
|
55
|
+
* - Forbidden: path separators (/, \), path traversal (..), leading/trailing whitespace
|
|
56
|
+
*
|
|
57
|
+
* AWS S3 Reference: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html
|
|
58
|
+
*
|
|
59
|
+
* @param bucketName - The bucket name to validate
|
|
60
|
+
* @returns true if valid, false otherwise
|
|
61
|
+
*/
|
|
62
|
+
const isValidBucketName = (bucketName) => {
|
|
63
|
+
if (!bucketName || typeof bucketName !== 'string') {
|
|
64
|
+
return false;
|
|
65
|
+
}
|
|
66
|
+
// Check length constraints (1-100 characters)
|
|
67
|
+
if (bucketName.length === 0 || bucketName.length > 100) {
|
|
68
|
+
return false;
|
|
69
|
+
}
|
|
70
|
+
// Check for leading/trailing whitespace
|
|
71
|
+
if (bucketName.trim() !== bucketName) {
|
|
72
|
+
return false;
|
|
73
|
+
}
|
|
74
|
+
// Explicitly reject path separators (security)
|
|
75
|
+
// Note: Consecutive periods (..) are allowed by backend - the AWS restriction
|
|
76
|
+
// on relative paths applies to object keys, not bucket names
|
|
77
|
+
if (bucketName.includes('/') || bucketName.includes('\\')) {
|
|
78
|
+
return false;
|
|
79
|
+
}
|
|
80
|
+
// Validate against allowed character set
|
|
81
|
+
// Pattern matches backend regex: /^(\w|!|-|\.|\*|'|\(|\)| |&|\$|@|=|;|:|\+|,|\?)*$/
|
|
82
|
+
// This explicitly excludes path separators (/, \) and other problematic characters
|
|
83
|
+
const bucketNameRegex = /^[\w!.\*'() &$@=;:+,?-]+$/;
|
|
84
|
+
return bucketNameRegex.test(bucketName);
|
|
85
|
+
};
|
|
86
|
+
exports.isValidBucketName = isValidBucketName;
|
|
47
87
|
//# sourceMappingURL=helpers.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../../src/lib/helpers.ts"],"names":[],"mappings":";;;AAEO,MAAM,YAAY,GAAG,CAAC,WAAmB,EAAS,EAAE;IACzD,IAAI,WAAW,EAAE,CAAC;QAChB,OAAO,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAA;IAC1C,CAAC;IACD,OAAO,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAA;AACpC,CAAC,CAAA;AALY,QAAA,YAAY,gBAKxB;AAEM,MAAM,eAAe,GAAG,GAAoB,EAAE;IACnD,OAAO,QAAQ,CAAA;AACjB,CAAC,CAAA;AAFY,QAAA,eAAe,mBAE3B;AAEM,MAAM,gBAAgB,GAAG,CAAC,IAAyB,EAAW,EAAE;IACrE,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAA,wBAAgB,EAAC,EAAE,CAAC,CAAC,CAAA;IAC/C,CAAC;SAAM,IAAI,OAAO,IAAI,KAAK,UAAU,IAAI,IAAI,KAAK,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/D,OAAO,IAAI,CAAA;IACb,CAAC;IAED,MAAM,MAAM,GAAwB,EAAE,CAAA;IACtC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAC5C,MAAM,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAA;QACxF,MAAM,CAAC,MAAM,CAAC,GAAG,IAAA,wBAAgB,EAAC,KAAK,CAAC,CAAA;IAC1C,CAAC,CAAC,CAAA;IAEF,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAdY,QAAA,gBAAgB,oBAc5B;AAED;;;;GAIG;AACI,MAAM,aAAa,GAAG,CAAC,KAAa,EAAW,EAAE;IACtD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAChD,OAAO,KAAK,CAAA;IACd,CAAC;IAED,MAAM,SAAS,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAA;IAC9C,OAAO,CACL,CAAC,SAAS,KAAK,IAAI;QACjB,SAAS,KAAK,MAAM,CAAC,SAAS;QAC9B,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,KAAK,IAAI,CAAC;QAC5C,CAAC,CAAC,MAAM,CAAC,WAAW,IAAI,KAAK,CAAC;QAC9B,CAAC,CAAC,MAAM,CAAC,QAAQ,IAAI,KAAK,CAAC,CAC5B,CAAA;AACH,CAAC,CAAA;AAbY,QAAA,aAAa,iBAazB"}
|
|
1
|
+
{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../../src/lib/helpers.ts"],"names":[],"mappings":";;;AAEO,MAAM,YAAY,GAAG,CAAC,WAAmB,EAAS,EAAE;IACzD,IAAI,WAAW,EAAE,CAAC;QAChB,OAAO,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAA;IAC1C,CAAC;IACD,OAAO,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAA;AACpC,CAAC,CAAA;AALY,QAAA,YAAY,gBAKxB;AAEM,MAAM,eAAe,GAAG,GAAoB,EAAE;IACnD,OAAO,QAAQ,CAAA;AACjB,CAAC,CAAA;AAFY,QAAA,eAAe,mBAE3B;AAEM,MAAM,gBAAgB,GAAG,CAAC,IAAyB,EAAW,EAAE;IACrE,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAA,wBAAgB,EAAC,EAAE,CAAC,CAAC,CAAA;IAC/C,CAAC;SAAM,IAAI,OAAO,IAAI,KAAK,UAAU,IAAI,IAAI,KAAK,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/D,OAAO,IAAI,CAAA;IACb,CAAC;IAED,MAAM,MAAM,GAAwB,EAAE,CAAA;IACtC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAC5C,MAAM,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAA;QACxF,MAAM,CAAC,MAAM,CAAC,GAAG,IAAA,wBAAgB,EAAC,KAAK,CAAC,CAAA;IAC1C,CAAC,CAAC,CAAA;IAEF,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAdY,QAAA,gBAAgB,oBAc5B;AAED;;;;GAIG;AACI,MAAM,aAAa,GAAG,CAAC,KAAa,EAAW,EAAE;IACtD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAChD,OAAO,KAAK,CAAA;IACd,CAAC;IAED,MAAM,SAAS,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAA;IAC9C,OAAO,CACL,CAAC,SAAS,KAAK,IAAI;QACjB,SAAS,KAAK,MAAM,CAAC,SAAS;QAC9B,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,KAAK,IAAI,CAAC;QAC5C,CAAC,CAAC,MAAM,CAAC,WAAW,IAAI,KAAK,CAAC;QAC9B,CAAC,CAAC,MAAM,CAAC,QAAQ,IAAI,KAAK,CAAC,CAC5B,CAAA;AACH,CAAC,CAAA;AAbY,QAAA,aAAa,iBAazB;AAED;;;;;;;;;;;;;;GAcG;AACI,MAAM,iBAAiB,GAAG,CAAC,UAAkB,EAAW,EAAE;IAC/D,IAAI,CAAC,UAAU,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;QAClD,OAAO,KAAK,CAAA;IACd,CAAC;IAED,8CAA8C;IAC9C,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,IAAI,UAAU,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;QACvD,OAAO,KAAK,CAAA;IACd,CAAC;IAED,wCAAwC;IACxC,IAAI,UAAU,CAAC,IAAI,EAAE,KAAK,UAAU,EAAE,CAAC;QACrC,OAAO,KAAK,CAAA;IACd,CAAC;IAED,+CAA+C;IAC/C,8EAA8E;IAC9E,6DAA6D;IAC7D,IAAI,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1D,OAAO,KAAK,CAAA;IACd,CAAC;IAED,yCAAyC;IACzC,oFAAoF;IACpF,mFAAmF;IACnF,MAAM,eAAe,GAAG,2BAA2B,CAAA;IACnD,OAAO,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;AACzC,CAAC,CAAA;AA3BY,QAAA,iBAAiB,qBA2B7B"}
|
|
@@ -2,7 +2,7 @@ import VectorIndexApi, { CreateIndexOptions } from './VectorIndexApi';
|
|
|
2
2
|
import VectorDataApi from './VectorDataApi';
|
|
3
3
|
import { Fetch } from './fetch';
|
|
4
4
|
import VectorBucketApi from './VectorBucketApi';
|
|
5
|
-
import { DeleteVectorsOptions, GetVectorsOptions, ListIndexesOptions, ListVectorsOptions, PutVectorsOptions, QueryVectorsOptions } from './types';
|
|
5
|
+
import { ApiResponse, DeleteVectorsOptions, GetVectorsOptions, ListIndexesOptions, ListVectorsOptions, ListVectorBucketsOptions, ListVectorBucketsResponse, PutVectorsOptions, QueryVectorsOptions, VectorBucket } from './types';
|
|
6
6
|
/**
|
|
7
7
|
*
|
|
8
8
|
* @alpha
|
|
@@ -104,6 +104,100 @@ export declare class StorageVectorsClient extends VectorBucketApi {
|
|
|
104
104
|
* ```
|
|
105
105
|
*/
|
|
106
106
|
from(vectorBucketName: string): VectorBucketScope;
|
|
107
|
+
/**
|
|
108
|
+
*
|
|
109
|
+
* @alpha
|
|
110
|
+
*
|
|
111
|
+
* Creates a new vector bucket
|
|
112
|
+
* Vector buckets are containers for vector indexes and their data
|
|
113
|
+
*
|
|
114
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
115
|
+
*
|
|
116
|
+
* @category Vector Buckets
|
|
117
|
+
* @param vectorBucketName - Unique name for the vector bucket
|
|
118
|
+
* @returns Promise with empty response on success or error
|
|
119
|
+
*
|
|
120
|
+
* @example
|
|
121
|
+
* ```typescript
|
|
122
|
+
* const { data, error } = await supabase
|
|
123
|
+
* .storage
|
|
124
|
+
* .vectors
|
|
125
|
+
* .createBucket('embeddings-prod')
|
|
126
|
+
* ```
|
|
127
|
+
*/
|
|
128
|
+
createBucket(vectorBucketName: string): Promise<ApiResponse<undefined>>;
|
|
129
|
+
/**
|
|
130
|
+
*
|
|
131
|
+
* @alpha
|
|
132
|
+
*
|
|
133
|
+
* Retrieves metadata for a specific vector bucket
|
|
134
|
+
*
|
|
135
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
136
|
+
*
|
|
137
|
+
* @category Vector Buckets
|
|
138
|
+
* @param vectorBucketName - Name of the vector bucket
|
|
139
|
+
* @returns Promise with bucket metadata or error
|
|
140
|
+
*
|
|
141
|
+
* @example
|
|
142
|
+
* ```typescript
|
|
143
|
+
* const { data, error } = await supabase
|
|
144
|
+
* .storage
|
|
145
|
+
* .vectors
|
|
146
|
+
* .getBucket('embeddings-prod')
|
|
147
|
+
*
|
|
148
|
+
* console.log('Bucket created:', data?.vectorBucket.creationTime)
|
|
149
|
+
* ```
|
|
150
|
+
*/
|
|
151
|
+
getBucket(vectorBucketName: string): Promise<ApiResponse<{
|
|
152
|
+
vectorBucket: VectorBucket;
|
|
153
|
+
}>>;
|
|
154
|
+
/**
|
|
155
|
+
*
|
|
156
|
+
* @alpha
|
|
157
|
+
*
|
|
158
|
+
* Lists all vector buckets with optional filtering and pagination
|
|
159
|
+
*
|
|
160
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
161
|
+
*
|
|
162
|
+
* @category Vector Buckets
|
|
163
|
+
* @param options - Optional filters (prefix, maxResults, nextToken)
|
|
164
|
+
* @returns Promise with list of buckets or error
|
|
165
|
+
*
|
|
166
|
+
* @example
|
|
167
|
+
* ```typescript
|
|
168
|
+
* const { data, error } = await supabase
|
|
169
|
+
* .storage
|
|
170
|
+
* .vectors
|
|
171
|
+
* .listBuckets({ prefix: 'embeddings-' })
|
|
172
|
+
*
|
|
173
|
+
* data?.vectorBuckets.forEach(bucket => {
|
|
174
|
+
* console.log(bucket.vectorBucketName)
|
|
175
|
+
* })
|
|
176
|
+
* ```
|
|
177
|
+
*/
|
|
178
|
+
listBuckets(options?: ListVectorBucketsOptions): Promise<ApiResponse<ListVectorBucketsResponse>>;
|
|
179
|
+
/**
|
|
180
|
+
*
|
|
181
|
+
* @alpha
|
|
182
|
+
*
|
|
183
|
+
* Deletes a vector bucket (bucket must be empty)
|
|
184
|
+
* All indexes must be deleted before deleting the bucket
|
|
185
|
+
*
|
|
186
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
187
|
+
*
|
|
188
|
+
* @category Vector Buckets
|
|
189
|
+
* @param vectorBucketName - Name of the vector bucket to delete
|
|
190
|
+
* @returns Promise with empty response on success or error
|
|
191
|
+
*
|
|
192
|
+
* @example
|
|
193
|
+
* ```typescript
|
|
194
|
+
* const { data, error } = await supabase
|
|
195
|
+
* .storage
|
|
196
|
+
* .vectors
|
|
197
|
+
* .deleteBucket('embeddings-old')
|
|
198
|
+
* ```
|
|
199
|
+
*/
|
|
200
|
+
deleteBucket(vectorBucketName: string): Promise<ApiResponse<undefined>>;
|
|
107
201
|
}
|
|
108
202
|
/**
|
|
109
203
|
*
|
|
@@ -159,7 +253,7 @@ export declare class VectorBucketScope extends VectorIndexApi {
|
|
|
159
253
|
* })
|
|
160
254
|
* ```
|
|
161
255
|
*/
|
|
162
|
-
createIndex(options: Omit<CreateIndexOptions, 'vectorBucketName'>): Promise<
|
|
256
|
+
createIndex(options: Omit<CreateIndexOptions, 'vectorBucketName'>): Promise<ApiResponse<undefined>>;
|
|
163
257
|
/**
|
|
164
258
|
*
|
|
165
259
|
* @alpha
|
|
@@ -171,7 +265,7 @@ export declare class VectorBucketScope extends VectorIndexApi {
|
|
|
171
265
|
*
|
|
172
266
|
* @category Vector Buckets
|
|
173
267
|
* @param options - Listing options (vectorBucketName is automatically set)
|
|
174
|
-
* @returns Promise with
|
|
268
|
+
* @returns Promise with response containing indexes array and pagination token or error
|
|
175
269
|
*
|
|
176
270
|
* @example
|
|
177
271
|
* ```typescript
|
|
@@ -179,7 +273,7 @@ export declare class VectorBucketScope extends VectorIndexApi {
|
|
|
179
273
|
* const { data } = await bucket.listIndexes({ prefix: 'documents-' })
|
|
180
274
|
* ```
|
|
181
275
|
*/
|
|
182
|
-
listIndexes(options?: Omit<ListIndexesOptions, 'vectorBucketName'>): Promise<
|
|
276
|
+
listIndexes(options?: Omit<ListIndexesOptions, 'vectorBucketName'>): Promise<ApiResponse<import("./types").ListIndexesResponse>>;
|
|
183
277
|
/**
|
|
184
278
|
*
|
|
185
279
|
* @alpha
|
|
@@ -200,7 +294,7 @@ export declare class VectorBucketScope extends VectorIndexApi {
|
|
|
200
294
|
* console.log('Dimension:', data?.index.dimension)
|
|
201
295
|
* ```
|
|
202
296
|
*/
|
|
203
|
-
getIndex(indexName: string): Promise<
|
|
297
|
+
getIndex(indexName: string): Promise<ApiResponse<{
|
|
204
298
|
index: import("./types").VectorIndex;
|
|
205
299
|
}>>;
|
|
206
300
|
/**
|
|
@@ -222,7 +316,7 @@ export declare class VectorBucketScope extends VectorIndexApi {
|
|
|
222
316
|
* await bucket.deleteIndex('old-index')
|
|
223
317
|
* ```
|
|
224
318
|
*/
|
|
225
|
-
deleteIndex(indexName: string): Promise<
|
|
319
|
+
deleteIndex(indexName: string): Promise<ApiResponse<undefined>>;
|
|
226
320
|
/**
|
|
227
321
|
*
|
|
228
322
|
* @alpha
|
|
@@ -312,7 +406,7 @@ export declare class VectorIndexScope extends VectorDataApi {
|
|
|
312
406
|
* })
|
|
313
407
|
* ```
|
|
314
408
|
*/
|
|
315
|
-
putVectors(options: Omit<PutVectorsOptions, 'vectorBucketName' | 'indexName'>): Promise<
|
|
409
|
+
putVectors(options: Omit<PutVectorsOptions, 'vectorBucketName' | 'indexName'>): Promise<ApiResponse<undefined>>;
|
|
316
410
|
/**
|
|
317
411
|
*
|
|
318
412
|
* @alpha
|
|
@@ -324,7 +418,7 @@ export declare class VectorIndexScope extends VectorDataApi {
|
|
|
324
418
|
*
|
|
325
419
|
* @category Vector Buckets
|
|
326
420
|
* @param options - Vector retrieval options (bucket and index names automatically set)
|
|
327
|
-
* @returns Promise with
|
|
421
|
+
* @returns Promise with response containing vectors array or error
|
|
328
422
|
*
|
|
329
423
|
* @example
|
|
330
424
|
* ```typescript
|
|
@@ -335,7 +429,7 @@ export declare class VectorIndexScope extends VectorDataApi {
|
|
|
335
429
|
* })
|
|
336
430
|
* ```
|
|
337
431
|
*/
|
|
338
|
-
getVectors(options: Omit<GetVectorsOptions, 'vectorBucketName' | 'indexName'>): Promise<
|
|
432
|
+
getVectors(options: Omit<GetVectorsOptions, 'vectorBucketName' | 'indexName'>): Promise<ApiResponse<import("./types").GetVectorsResponse>>;
|
|
339
433
|
/**
|
|
340
434
|
*
|
|
341
435
|
* @alpha
|
|
@@ -347,7 +441,7 @@ export declare class VectorIndexScope extends VectorDataApi {
|
|
|
347
441
|
*
|
|
348
442
|
* @category Vector Buckets
|
|
349
443
|
* @param options - Listing options (bucket and index names automatically set)
|
|
350
|
-
* @returns Promise with
|
|
444
|
+
* @returns Promise with response containing vectors array and pagination token or error
|
|
351
445
|
*
|
|
352
446
|
* @example
|
|
353
447
|
* ```typescript
|
|
@@ -358,7 +452,7 @@ export declare class VectorIndexScope extends VectorDataApi {
|
|
|
358
452
|
* })
|
|
359
453
|
* ```
|
|
360
454
|
*/
|
|
361
|
-
listVectors(options?: Omit<ListVectorsOptions, 'vectorBucketName' | 'indexName'>): Promise<
|
|
455
|
+
listVectors(options?: Omit<ListVectorsOptions, 'vectorBucketName' | 'indexName'>): Promise<ApiResponse<import("./types").ListVectorsResponse>>;
|
|
362
456
|
/**
|
|
363
457
|
*
|
|
364
458
|
* @alpha
|
|
@@ -370,7 +464,7 @@ export declare class VectorIndexScope extends VectorDataApi {
|
|
|
370
464
|
*
|
|
371
465
|
* @category Vector Buckets
|
|
372
466
|
* @param options - Query options (bucket and index names automatically set)
|
|
373
|
-
* @returns Promise with array of similar vectors ordered by distance
|
|
467
|
+
* @returns Promise with response containing matches array of similar vectors ordered by distance or error
|
|
374
468
|
*
|
|
375
469
|
* @example
|
|
376
470
|
* ```typescript
|
|
@@ -384,7 +478,7 @@ export declare class VectorIndexScope extends VectorDataApi {
|
|
|
384
478
|
* })
|
|
385
479
|
* ```
|
|
386
480
|
*/
|
|
387
|
-
queryVectors(options: Omit<QueryVectorsOptions, 'vectorBucketName' | 'indexName'>): Promise<
|
|
481
|
+
queryVectors(options: Omit<QueryVectorsOptions, 'vectorBucketName' | 'indexName'>): Promise<ApiResponse<import("./types").QueryVectorsResponse>>;
|
|
388
482
|
/**
|
|
389
483
|
*
|
|
390
484
|
* @alpha
|
|
@@ -406,6 +500,6 @@ export declare class VectorIndexScope extends VectorDataApi {
|
|
|
406
500
|
* })
|
|
407
501
|
* ```
|
|
408
502
|
*/
|
|
409
|
-
deleteVectors(options: Omit<DeleteVectorsOptions, 'vectorBucketName' | 'indexName'>): Promise<
|
|
503
|
+
deleteVectors(options: Omit<DeleteVectorsOptions, 'vectorBucketName' | 'indexName'>): Promise<ApiResponse<undefined>>;
|
|
410
504
|
}
|
|
411
505
|
//# sourceMappingURL=StorageVectorsClient.d.ts.map
|
|
@@ -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,
|
|
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,WAAW,EACX,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,wBAAwB,EACxB,yBAAyB,EACzB,iBAAiB,EACjB,mBAAmB,EACnB,YAAY,EACb,MAAM,SAAS,CAAA;AAEhB;;;;;;;GAOG;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,qBAAa,oBAAqB,SAAQ,eAAe;IACvD;;;;;;;;;;;;;;;;OAgBG;gBACS,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,2BAAgC;IAIlE;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CAAC,gBAAgB,EAAE,MAAM,GAAG,iBAAiB;IAIjD;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,YAAY,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IAI7E;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,SAAS,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;QAAE,YAAY,EAAE,YAAY,CAAA;KAAE,CAAC,CAAC;IAI/F;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,WAAW,CACf,OAAO,GAAE,wBAA6B,GACrC,OAAO,CAAC,WAAW,CAAC,yBAAyB,CAAC,CAAC;IAIlD;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,YAAY,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;CAG9E;AAED;;;;;;;;GAQG;AACH,qBAAa,iBAAkB,SAAQ,cAAc;IACnD,OAAO,CAAC,gBAAgB,CAAQ;IAEhC;;;;;;;;;;;;OAYG;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;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACY,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;IAOhF;;;;;;;;;;;;;;;;;;OAkBG;IACY,WAAW,CAAC,OAAO,GAAE,IAAI,CAAC,kBAAkB,EAAE,kBAAkB,CAAM;IAOrF;;;;;;;;;;;;;;;;;;;OAmBG;IACY,QAAQ,CAAC,SAAS,EAAE,MAAM;;;IAIzC;;;;;;;;;;;;;;;;;;OAkBG;IACY,WAAW,CAAC,SAAS,EAAE,MAAM;IAI5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,KAAK,CAAC,SAAS,EAAE,MAAM,GAAG,gBAAgB;CAS3C;AAED;;;;;;;;GAQG;AACH,qBAAa,gBAAiB,SAAQ,aAAa;IACjD,OAAO,CAAC,gBAAgB,CAAQ;IAChC,OAAO,CAAC,SAAS,CAAQ;IAEzB;;;;;;;;;;;;;OAaG;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;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACY,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,iBAAiB,EAAE,kBAAkB,GAAG,WAAW,CAAC;IAQ5F;;;;;;;;;;;;;;;;;;;;;OAqBG;IACY,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,iBAAiB,EAAE,kBAAkB,GAAG,WAAW,CAAC;IAQ5F;;;;;;;;;;;;;;;;;;;;;OAqBG;IACY,WAAW,CACxB,OAAO,GAAE,IAAI,CAAC,kBAAkB,EAAE,kBAAkB,GAAG,WAAW,CAAM;IAS1E;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACY,YAAY,CACzB,OAAO,EAAE,IAAI,CAAC,mBAAmB,EAAE,kBAAkB,GAAG,WAAW,CAAC;IAStE;;;;;;;;;;;;;;;;;;;;OAoBG;IACY,aAAa,CAC1B,OAAO,EAAE,IAAI,CAAC,oBAAoB,EAAE,kBAAkB,GAAG,WAAW,CAAC;CAQxE"}
|
|
@@ -89,6 +89,126 @@ class StorageVectorsClient extends VectorBucketApi_1.default {
|
|
|
89
89
|
from(vectorBucketName) {
|
|
90
90
|
return new VectorBucketScope(this.url, this.headers, vectorBucketName, this.fetch);
|
|
91
91
|
}
|
|
92
|
+
/**
|
|
93
|
+
*
|
|
94
|
+
* @alpha
|
|
95
|
+
*
|
|
96
|
+
* Creates a new vector bucket
|
|
97
|
+
* Vector buckets are containers for vector indexes and their data
|
|
98
|
+
*
|
|
99
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
100
|
+
*
|
|
101
|
+
* @category Vector Buckets
|
|
102
|
+
* @param vectorBucketName - Unique name for the vector bucket
|
|
103
|
+
* @returns Promise with empty response on success or error
|
|
104
|
+
*
|
|
105
|
+
* @example
|
|
106
|
+
* ```typescript
|
|
107
|
+
* const { data, error } = await supabase
|
|
108
|
+
* .storage
|
|
109
|
+
* .vectors
|
|
110
|
+
* .createBucket('embeddings-prod')
|
|
111
|
+
* ```
|
|
112
|
+
*/
|
|
113
|
+
createBucket(vectorBucketName) {
|
|
114
|
+
const _super = Object.create(null, {
|
|
115
|
+
createBucket: { get: () => super.createBucket }
|
|
116
|
+
});
|
|
117
|
+
return tslib_1.__awaiter(this, void 0, void 0, function* () {
|
|
118
|
+
return _super.createBucket.call(this, vectorBucketName);
|
|
119
|
+
});
|
|
120
|
+
}
|
|
121
|
+
/**
|
|
122
|
+
*
|
|
123
|
+
* @alpha
|
|
124
|
+
*
|
|
125
|
+
* Retrieves metadata for a specific vector bucket
|
|
126
|
+
*
|
|
127
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
128
|
+
*
|
|
129
|
+
* @category Vector Buckets
|
|
130
|
+
* @param vectorBucketName - Name of the vector bucket
|
|
131
|
+
* @returns Promise with bucket metadata or error
|
|
132
|
+
*
|
|
133
|
+
* @example
|
|
134
|
+
* ```typescript
|
|
135
|
+
* const { data, error } = await supabase
|
|
136
|
+
* .storage
|
|
137
|
+
* .vectors
|
|
138
|
+
* .getBucket('embeddings-prod')
|
|
139
|
+
*
|
|
140
|
+
* console.log('Bucket created:', data?.vectorBucket.creationTime)
|
|
141
|
+
* ```
|
|
142
|
+
*/
|
|
143
|
+
getBucket(vectorBucketName) {
|
|
144
|
+
const _super = Object.create(null, {
|
|
145
|
+
getBucket: { get: () => super.getBucket }
|
|
146
|
+
});
|
|
147
|
+
return tslib_1.__awaiter(this, void 0, void 0, function* () {
|
|
148
|
+
return _super.getBucket.call(this, vectorBucketName);
|
|
149
|
+
});
|
|
150
|
+
}
|
|
151
|
+
/**
|
|
152
|
+
*
|
|
153
|
+
* @alpha
|
|
154
|
+
*
|
|
155
|
+
* Lists all vector buckets with optional filtering and pagination
|
|
156
|
+
*
|
|
157
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
158
|
+
*
|
|
159
|
+
* @category Vector Buckets
|
|
160
|
+
* @param options - Optional filters (prefix, maxResults, nextToken)
|
|
161
|
+
* @returns Promise with list of buckets or error
|
|
162
|
+
*
|
|
163
|
+
* @example
|
|
164
|
+
* ```typescript
|
|
165
|
+
* const { data, error } = await supabase
|
|
166
|
+
* .storage
|
|
167
|
+
* .vectors
|
|
168
|
+
* .listBuckets({ prefix: 'embeddings-' })
|
|
169
|
+
*
|
|
170
|
+
* data?.vectorBuckets.forEach(bucket => {
|
|
171
|
+
* console.log(bucket.vectorBucketName)
|
|
172
|
+
* })
|
|
173
|
+
* ```
|
|
174
|
+
*/
|
|
175
|
+
listBuckets() {
|
|
176
|
+
const _super = Object.create(null, {
|
|
177
|
+
listBuckets: { get: () => super.listBuckets }
|
|
178
|
+
});
|
|
179
|
+
return tslib_1.__awaiter(this, arguments, void 0, function* (options = {}) {
|
|
180
|
+
return _super.listBuckets.call(this, options);
|
|
181
|
+
});
|
|
182
|
+
}
|
|
183
|
+
/**
|
|
184
|
+
*
|
|
185
|
+
* @alpha
|
|
186
|
+
*
|
|
187
|
+
* Deletes a vector bucket (bucket must be empty)
|
|
188
|
+
* All indexes must be deleted before deleting the bucket
|
|
189
|
+
*
|
|
190
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
191
|
+
*
|
|
192
|
+
* @category Vector Buckets
|
|
193
|
+
* @param vectorBucketName - Name of the vector bucket to delete
|
|
194
|
+
* @returns Promise with empty response on success or error
|
|
195
|
+
*
|
|
196
|
+
* @example
|
|
197
|
+
* ```typescript
|
|
198
|
+
* const { data, error } = await supabase
|
|
199
|
+
* .storage
|
|
200
|
+
* .vectors
|
|
201
|
+
* .deleteBucket('embeddings-old')
|
|
202
|
+
* ```
|
|
203
|
+
*/
|
|
204
|
+
deleteBucket(vectorBucketName) {
|
|
205
|
+
const _super = Object.create(null, {
|
|
206
|
+
deleteBucket: { get: () => super.deleteBucket }
|
|
207
|
+
});
|
|
208
|
+
return tslib_1.__awaiter(this, void 0, void 0, function* () {
|
|
209
|
+
return _super.deleteBucket.call(this, vectorBucketName);
|
|
210
|
+
});
|
|
211
|
+
}
|
|
92
212
|
}
|
|
93
213
|
exports.StorageVectorsClient = StorageVectorsClient;
|
|
94
214
|
/**
|
|
@@ -164,7 +284,7 @@ class VectorBucketScope extends VectorIndexApi_1.default {
|
|
|
164
284
|
*
|
|
165
285
|
* @category Vector Buckets
|
|
166
286
|
* @param options - Listing options (vectorBucketName is automatically set)
|
|
167
|
-
* @returns Promise with
|
|
287
|
+
* @returns Promise with response containing indexes array and pagination token or error
|
|
168
288
|
*
|
|
169
289
|
* @example
|
|
170
290
|
* ```typescript
|
|
@@ -346,7 +466,7 @@ class VectorIndexScope extends VectorDataApi_1.default {
|
|
|
346
466
|
*
|
|
347
467
|
* @category Vector Buckets
|
|
348
468
|
* @param options - Vector retrieval options (bucket and index names automatically set)
|
|
349
|
-
* @returns Promise with
|
|
469
|
+
* @returns Promise with response containing vectors array or error
|
|
350
470
|
*
|
|
351
471
|
* @example
|
|
352
472
|
* ```typescript
|
|
@@ -376,7 +496,7 @@ class VectorIndexScope extends VectorDataApi_1.default {
|
|
|
376
496
|
*
|
|
377
497
|
* @category Vector Buckets
|
|
378
498
|
* @param options - Listing options (bucket and index names automatically set)
|
|
379
|
-
* @returns Promise with
|
|
499
|
+
* @returns Promise with response containing vectors array and pagination token or error
|
|
380
500
|
*
|
|
381
501
|
* @example
|
|
382
502
|
* ```typescript
|
|
@@ -406,7 +526,7 @@ class VectorIndexScope extends VectorDataApi_1.default {
|
|
|
406
526
|
*
|
|
407
527
|
* @category Vector Buckets
|
|
408
528
|
* @param options - Query options (bucket and index names automatically set)
|
|
409
|
-
* @returns Promise with array of similar vectors ordered by distance
|
|
529
|
+
* @returns Promise with response containing matches array of similar vectors ordered by distance or error
|
|
410
530
|
*
|
|
411
531
|
* @example
|
|
412
532
|
* ```typescript
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"StorageVectorsClient.js","sourceRoot":"","sources":["../../../../src/lib/vectors/StorageVectorsClient.ts"],"names":[],"mappings":";;;;AAAA,8EAAqE;AACrE,4EAA2C;AAE3C,gFAA+C;
|
|
1
|
+
{"version":3,"file":"StorageVectorsClient.js","sourceRoot":"","sources":["../../../../src/lib/vectors/StorageVectorsClient.ts"],"names":[],"mappings":";;;;AAAA,8EAAqE;AACrE,4EAA2C;AAE3C,gFAA+C;AAkC/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,MAAa,oBAAqB,SAAQ,yBAAe;IACvD;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,GAAW,EAAE,UAAuC,EAAE;QAChE,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE,EAAE,OAAO,CAAC,KAAK,CAAC,CAAA;IAClD,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CAAC,gBAAwB;QAC3B,OAAO,IAAI,iBAAiB,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,EAAE,gBAAgB,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;IACpF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,YAAY,CAAC,gBAAwB;;;;;YACzC,OAAO,OAAM,YAAY,YAAC,gBAAgB,EAAC;QAC7C,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,SAAS,CAAC,gBAAwB;;;;;YACtC,OAAO,OAAM,SAAS,YAAC,gBAAgB,EAAC;QAC1C,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,WAAW;;;;qEACf,UAAoC,EAAE;YAEtC,OAAO,OAAM,WAAW,YAAC,OAAO,EAAC;QACnC,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,YAAY,CAAC,gBAAwB;;;;;YACzC,OAAO,OAAM,YAAY,YAAC,gBAAgB,EAAC;QAC7C,CAAC;KAAA;CACF;AArJD,oDAqJC;AAED;;;;;;;;GAQG;AACH,MAAa,iBAAkB,SAAQ,wBAAc;IAGnD;;;;;;;;;;;;OAYG;IACH,YACE,GAAW,EACX,OAAkC,EAClC,gBAAwB,EACxB,KAAa;QAEb,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;QAC1B,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAA;IAC1C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACY,WAAW,CAAC,OAAqD;;;;;YAC9E,OAAO,OAAM,WAAW,4CACnB,OAAO,KACV,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,KACvC;QACJ,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACY,WAAW;;;;qEAAC,UAAwD,EAAE;YACnF,OAAO,OAAM,WAAW,4CACnB,OAAO,KACV,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,KACvC;QACJ,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACY,QAAQ,CAAC,SAAiB;;;;;YACvC,OAAO,OAAM,QAAQ,YAAC,IAAI,CAAC,gBAAgB,EAAE,SAAS,EAAC;QACzD,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACY,WAAW,CAAC,SAAiB;;;;;YAC1C,OAAO,OAAM,WAAW,YAAC,IAAI,CAAC,gBAAgB,EAAE,SAAS,EAAC;QAC5D,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,KAAK,CAAC,SAAiB;QACrB,OAAO,IAAI,gBAAgB,CACzB,IAAI,CAAC,GAAG,EACR,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,gBAAgB,EACrB,SAAS,EACT,IAAI,CAAC,KAAK,CACX,CAAA;IACH,CAAC;CACF;AA7KD,8CA6KC;AAED;;;;;;;;GAQG;AACH,MAAa,gBAAiB,SAAQ,uBAAa;IAIjD;;;;;;;;;;;;;OAaG;IACH,YACE,GAAW,EACX,OAAkC,EAClC,gBAAwB,EACxB,SAAiB,EACjB,KAAa;QAEb,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;QAC1B,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAA;QACxC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACY,UAAU,CAAC,OAAkE;;;;;YAC1F,OAAO,OAAM,UAAU,4CAClB,OAAO,KACV,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,EACvC,SAAS,EAAE,IAAI,CAAC,SAAS,KACzB;QACJ,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACY,UAAU,CAAC,OAAkE;;;;;YAC1F,OAAO,OAAM,UAAU,4CAClB,OAAO,KACV,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,EACvC,SAAS,EAAE,IAAI,CAAC,SAAS,KACzB;QACJ,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACY,WAAW;;;;qEACxB,UAAsE,EAAE;YAExE,OAAO,OAAM,WAAW,4CACnB,OAAO,KACV,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,EACvC,SAAS,EAAE,IAAI,CAAC,SAAS,KACzB;QACJ,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACY,YAAY,CACzB,OAAoE;;;;;YAEpE,OAAO,OAAM,YAAY,4CACpB,OAAO,KACV,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,EACvC,SAAS,EAAE,IAAI,CAAC,SAAS,KACzB;QACJ,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACY,aAAa,CAC1B,OAAqE;;;;;YAErE,OAAO,OAAM,aAAa,4CACrB,OAAO,KACV,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,EACvC,SAAS,EAAE,IAAI,CAAC,SAAS,KACzB;QACJ,CAAC;KAAA;CACF;AAhMD,4CAgMC"}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const version = "2.
|
|
1
|
+
export declare const version = "2.85.1-canary.0";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
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.
|
|
10
|
+
exports.version = '2.85.1-canary.0';
|
|
11
11
|
//# sourceMappingURL=version.js.map
|