Skip to content

Commit 06c2178

Browse files
committed
chore(storage): update names
1 parent 17a0dd5 commit 06c2178

File tree

7 files changed

+80
-74
lines changed

7 files changed

+80
-74
lines changed

packages/core/storage-js/README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ Specialized buckets for storing and querying high-dimensional vector embeddings.
123123

124124
```js
125125
// Create vector bucket
126-
await storageClient.vectors.createVectorBucket('embeddings-prod')
126+
await storageClient.vectors.createBucket('embeddings-prod')
127127

128128
// Create index and insert vectors
129129
const bucket = storageClient.vectors.from('embeddings-prod')
@@ -638,7 +638,7 @@ const supabase = createClient(
638638
const vectors = supabase.storage.vectors
639639

640640
// Create a vector bucket
641-
await vectors.createVectorBucket('embeddings-prod')
641+
await vectors.createBucket('embeddings-prod')
642642

643643
// Create an index
644644
const bucket = vectors.from('embeddings-prod')
@@ -693,7 +693,7 @@ const storageClient = new StorageClient('https://your-project.supabase.co/storag
693693
const vectors = storageClient.vectors
694694

695695
// Use the same API as shown in Option 1
696-
await vectors.createVectorBucket('embeddings-prod')
696+
await vectors.createBucket('embeddings-prod')
697697
const bucket = vectors.from('embeddings-prod')
698698
// ... rest of operations
699699
```
@@ -711,7 +711,7 @@ const vectorClient = new StorageVectorsClient('https://your-project.supabase.co/
711711
})
712712

713713
// Use the same API as shown in Option 1
714-
await vectorClient.createVectorBucket('embeddings-prod')
714+
await vectorClient.createBucket('embeddings-prod')
715715
const bucket = vectorClient.from('embeddings-prod')
716716
// ... rest of operations
717717
```
@@ -742,35 +742,35 @@ Vector buckets are top-level containers for organizing vector indexes.
742742
##### Create Bucket
743743
744744
```typescript
745-
const { data, error } = await vectorClient.createVectorBucket('my-bucket')
745+
const { data, error } = await vectorClient.createBucket('my-bucket')
746746
```
747747
748748
##### Get Bucket
749749
750750
```typescript
751-
const { data, error } = await vectorClient.getVectorBucket('my-bucket')
751+
const { data, error } = await vectorClient.getBucket('my-bucket')
752752
console.log('Created at:', new Date(data.vectorBucket.creationTime! * 1000))
753753
```
754754
755755
##### List Buckets
756756
757757
```typescript
758-
const { data, error } = await vectorClient.listVectorBuckets({
758+
const { data, error } = await vectorClient.listBuckets({
759759
prefix: 'prod-',
760760
maxResults: 100,
761761
})
762762

763763
// Pagination
764764
if (data?.nextToken) {
765-
const next = await vectorClient.listVectorBuckets({ nextToken: data.nextToken })
765+
const next = await vectorClient.listBuckets({ nextToken: data.nextToken })
766766
}
767767
```
768768
769769
##### Delete Bucket
770770
771771
```typescript
772772
// Bucket must be empty (all indexes deleted first)
773-
const { error } = await vectorClient.deleteVectorBucket('my-bucket')
773+
const { error } = await vectorClient.deleteBucket('my-bucket')
774774
```
775775
776776
#### Vector Indexes
@@ -947,7 +947,7 @@ await index.deleteVectors({
947947
The library uses a consistent error handling pattern:
948948
949949
```typescript
950-
const { data, error } = await vectorClient.createVectorBucket('my-bucket')
950+
const { data, error } = await vectorClient.createBucket('my-bucket')
951951

952952
if (error) {
953953
console.error('Error:', error.message)
@@ -976,7 +976,7 @@ const vectorClient = new StorageVectorsClient(url, options)
976976
vectorClient.throwOnError()
977977

978978
try {
979-
const { data } = await vectorClient.createVectorBucket('my-bucket')
979+
const { data } = await vectorClient.createBucket('my-bucket')
980980
// data is guaranteed to be present
981981
} catch (error) {
982982
if (error instanceof StorageVectorsApiError) {

packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ export interface StorageVectorsClientOptions {
4040
* const vectors = storageClient.vectors
4141
*
4242
* // Use vector operations
43-
* await vectors.createVectorBucket('embeddings-prod')
43+
* await vectors.createBucket('embeddings-prod')
4444
* const bucket = vectors.from('embeddings-prod')
4545
* await bucket.createIndex({ ... })
4646
* ```
@@ -49,15 +49,15 @@ export interface StorageVectorsClientOptions {
4949
* ```typescript
5050
* import { StorageVectorsClient } from '@supabase/storage-js'
5151
*
52-
* const client = new StorageVectorsClient('https://api.example.com', {
52+
* const vectorsClient = new StorageVectorsClient('https://api.example.com', {
5353
* headers: { 'Authorization': 'Bearer token' }
5454
* })
5555
*
5656
* // Access bucket operations
57-
* await client.createVectorBucket('embeddings-prod')
57+
* await vectorsClient.createBucket('embeddings-prod')
5858
*
5959
* // Access index operations via buckets
60-
* const bucket = client.from('embeddings-prod')
60+
* const bucket = vectorsClient.from('embeddings-prod')
6161
* await bucket.createIndex({
6262
* indexName: 'documents',
6363
* dataType: 'float32',

packages/core/storage-js/src/lib/vectors/VectorBucketApi.ts

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,12 @@ export default class VectorBucketApi {
1919
protected fetch: Fetch
2020
protected shouldThrowOnError = false
2121

22+
/**
23+
* Creates a new VectorBucketApi instance
24+
* @param url - The base URL for the storage vectors API
25+
* @param headers - HTTP headers to include in requests
26+
* @param fetch - Optional custom fetch implementation
27+
*/
2228
constructor(url: string, headers: { [key: string]: string } = {}, fetch?: Fetch) {
2329
this.url = url.replace(/\/$/, '')
2430
this.headers = { ...DEFAULT_HEADERS, ...headers }
@@ -34,7 +40,7 @@ export default class VectorBucketApi {
3440
* ```typescript
3541
* const client = new VectorBucketApi(url, headers)
3642
* client.throwOnError()
37-
* const { data } = await client.createVectorBucket('my-bucket') // throws on error
43+
* const { data } = await client.createBucket('my-bucket') // throws on error
3844
* ```
3945
*/
4046
public throwOnError(): this {
@@ -56,13 +62,13 @@ export default class VectorBucketApi {
5662
*
5763
* @example
5864
* ```typescript
59-
* const { data, error } = await client.createVectorBucket('embeddings-prod')
65+
* const { data, error } = await client.createBucket('embeddings-prod')
6066
* if (error) {
6167
* console.error('Failed to create bucket:', error.message)
6268
* }
6369
* ```
6470
*/
65-
async createVectorBucket(vectorBucketName: string): Promise<ApiResponse<undefined>> {
71+
async createBucket(vectorBucketName: string): Promise<ApiResponse<undefined>> {
6672
try {
6773
const data = await post(
6874
this.fetch,
@@ -95,13 +101,13 @@ export default class VectorBucketApi {
95101
*
96102
* @example
97103
* ```typescript
98-
* const { data, error } = await client.getVectorBucket('embeddings-prod')
104+
* const { data, error } = await client.getBucket('embeddings-prod')
99105
* if (data) {
100106
* console.log('Bucket created at:', new Date(data.vectorBucket.creationTime! * 1000))
101107
* }
102108
* ```
103109
*/
104-
async getVectorBucket(
110+
async getBucket(
105111
vectorBucketName: string
106112
): Promise<ApiResponse<{ vectorBucket: VectorBucket }>> {
107113
try {
@@ -139,17 +145,17 @@ export default class VectorBucketApi {
139145
* @example
140146
* ```typescript
141147
* // List all buckets with prefix 'prod-'
142-
* const { data, error } = await client.listVectorBuckets({ prefix: 'prod-' })
148+
* const { data, error } = await client.listBuckets({ prefix: 'prod-' })
143149
* if (data) {
144150
* console.log('Found buckets:', data.buckets.length)
145151
* // Fetch next page if available
146152
* if (data.nextToken) {
147-
* const next = await client.listVectorBuckets({ nextToken: data.nextToken })
153+
* const next = await client.listBuckets({ nextToken: data.nextToken })
148154
* }
149155
* }
150156
* ```
151157
*/
152-
async listVectorBuckets(
158+
async listBuckets(
153159
options: ListVectorBucketsOptions = {}
154160
): Promise<ApiResponse<ListVectorBucketsResponse>> {
155161
try {
@@ -183,13 +189,13 @@ export default class VectorBucketApi {
183189
* @example
184190
* ```typescript
185191
* // Delete all indexes first, then delete bucket
186-
* const { error } = await client.deleteVectorBucket('old-bucket')
192+
* const { error } = await client.deleteBucket('old-bucket')
187193
* if (error?.statusCode === 'S3VectorBucketNotEmpty') {
188194
* console.error('Must delete all indexes first')
189195
* }
190196
* ```
191197
*/
192-
async deleteVectorBucket(vectorBucketName: string): Promise<ApiResponse<undefined>> {
198+
async deleteBucket(vectorBucketName: string): Promise<ApiResponse<undefined>> {
193199
try {
194200
const data = await post(
195201
this.fetch,

0 commit comments

Comments
 (0)