@supabase/storage-js 2.75.1 → 2.75.2-canary.1

package/dist/module/lib/vectors/StorageVectorsClient.js

@@ -0,0 +1,360 @@
+import { __awaiter } from "tslib";
+import VectorIndexApi from './VectorIndexApi';
+import VectorDataApi from './VectorDataApi';
+import VectorBucketApi from './VectorBucketApi';
+/**
+ * Main client for interacting with S3 Vectors API
+ * Provides access to bucket, index, and vector data operations
+ *
+ * **Usage Patterns:**
+ *
+ * 1. **Via StorageClient (recommended for most use cases):**
+ * ```typescript
+ * import { StorageClient } from '@supabase/storage-js'
+ *
+ * const storageClient = new StorageClient(url, headers)
+ * const vectors = storageClient.vectors
+ *
+ * // Use vector operations
+ * await vectors.createBucket('embeddings-prod')
+ * const bucket = vectors.from('embeddings-prod')
+ * await bucket.createIndex({ ... })
+ * ```
+ *
+ * 2. **Standalone (for vector-only applications):**
+ * ```typescript
+ * import { StorageVectorsClient } from '@supabase/storage-js'
+ *
+ * const vectorsClient = new StorageVectorsClient('https://api.example.com', {
+ *   headers: { 'Authorization': 'Bearer token' }
+ * })
+ *
+ * // Access bucket operations
+ * await vectorsClient.createBucket('embeddings-prod')
+ *
+ * // Access index operations via buckets
+ * const bucket = vectorsClient.from('embeddings-prod')
+ * await bucket.createIndex({
+ *   indexName: 'documents',
+ *   dataType: 'float32',
+ *   dimension: 1536,
+ *   distanceMetric: 'cosine'
+ * })
+ *
+ * // Access vector operations via index
+ * const index = bucket.index('documents')
+ * await index.putVectors({
+ *   vectors: [
+ *     { key: 'doc-1', data: { float32: [...] }, metadata: { title: 'Intro' } }
+ *   ]
+ * })
+ *
+ * // Query similar vectors
+ * const { data } = await index.queryVectors({
+ *   queryVector: { float32: [...] },
+ *   topK: 5,
+ *   returnDistance: true
+ * })
+ * ```
+ */
+export class StorageVectorsClient extends VectorBucketApi {
+    constructor(url, options = {}) {
+        super(url, options.headers || {}, options.fetch);
+    }
+    /**
+     * Access operations for a specific vector bucket
+     * Returns a scoped client for index and vector operations within the bucket
+     *
+     * @param vectorBucketName - Name of the vector bucket
+     * @returns Bucket-scoped client with index and vector operations
+     *
+     * @example
+     * ```typescript
+     * const bucket = client.bucket('embeddings-prod')
+     *
+     * // Create an index in this bucket
+     * await bucket.createIndex({
+     *   indexName: 'documents-openai',
+     *   dataType: 'float32',
+     *   dimension: 1536,
+     *   distanceMetric: 'cosine'
+     * })
+     *
+     * // List indexes in this bucket
+     * const { data } = await bucket.listIndexes()
+     * ```
+     */
+    from(vectorBucketName) {
+        return new VectorBucketScope(this.url, this.headers, vectorBucketName, this.fetch);
+    }
+}
+/**
+ * Scoped client for operations within a specific vector bucket
+ * Provides index management and access to vector operations
+ */
+export class VectorBucketScope extends VectorIndexApi {
+    constructor(url, headers, vectorBucketName, fetch) {
+        super(url, headers, fetch);
+        this.vectorBucketName = vectorBucketName;
+    }
+    /**
+     * Creates a new vector index in this bucket
+     * Convenience method that automatically includes the bucket name
+     *
+     * @param options - Index configuration (vectorBucketName is automatically set)
+     * @returns Promise with empty response on success or error
+     *
+     * @example
+     * ```typescript
+     * const bucket = client.bucket('embeddings-prod')
+     * await bucket.createIndex({
+     *   indexName: 'documents-openai',
+     *   dataType: 'float32',
+     *   dimension: 1536,
+     *   distanceMetric: 'cosine',
+     *   metadataConfiguration: {
+     *     nonFilterableMetadataKeys: ['raw_text']
+     *   }
+     * })
+     * ```
+     */
+    createIndex(options) {
+        const _super = Object.create(null, {
+            createIndex: { get: () => super.createIndex }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            return _super.createIndex.call(this, Object.assign(Object.assign({}, options), { vectorBucketName: this.vectorBucketName }));
+        });
+    }
+    /**
+     * Lists indexes in this bucket
+     * Convenience method that automatically includes the bucket name
+     *
+     * @param options - Listing options (vectorBucketName is automatically set)
+     * @returns Promise with list of indexes or error
+     *
+     * @example
+     * ```typescript
+     * const bucket = client.bucket('embeddings-prod')
+     * const { data } = await bucket.listIndexes({ prefix: 'documents-' })
+     * ```
+     */
+    listIndexes() {
+        const _super = Object.create(null, {
+            listIndexes: { get: () => super.listIndexes }
+        });
+        return __awaiter(this, arguments, void 0, function* (options = {}) {
+            return _super.listIndexes.call(this, Object.assign(Object.assign({}, options), { vectorBucketName: this.vectorBucketName }));
+        });
+    }
+    /**
+     * Retrieves metadata for a specific index in this bucket
+     * Convenience method that automatically includes the bucket name
+     *
+     * @param indexName - Name of the index to retrieve
+     * @returns Promise with index metadata or error
+     *
+     * @example
+     * ```typescript
+     * const bucket = client.bucket('embeddings-prod')
+     * const { data } = await bucket.getIndex('documents-openai')
+     * console.log('Dimension:', data?.index.dimension)
+     * ```
+     */
+    getIndex(indexName) {
+        const _super = Object.create(null, {
+            getIndex: { get: () => super.getIndex }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            return _super.getIndex.call(this, this.vectorBucketName, indexName);
+        });
+    }
+    /**
+     * Deletes an index from this bucket
+     * Convenience method that automatically includes the bucket name
+     *
+     * @param indexName - Name of the index to delete
+     * @returns Promise with empty response on success or error
+     *
+     * @example
+     * ```typescript
+     * const bucket = client.bucket('embeddings-prod')
+     * await bucket.deleteIndex('old-index')
+     * ```
+     */
+    deleteIndex(indexName) {
+        const _super = Object.create(null, {
+            deleteIndex: { get: () => super.deleteIndex }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            return _super.deleteIndex.call(this, this.vectorBucketName, indexName);
+        });
+    }
+    /**
+     * Access operations for a specific index within this bucket
+     * Returns a scoped client for vector data operations
+     *
+     * @param indexName - Name of the index
+     * @returns Index-scoped client with vector data operations
+     *
+     * @example
+     * ```typescript
+     * const index = client.bucket('embeddings-prod').index('documents-openai')
+     *
+     * // Insert vectors
+     * await index.putVectors({
+     *   vectors: [
+     *     { key: 'doc-1', data: { float32: [...] }, metadata: { title: 'Intro' } }
+     *   ]
+     * })
+     *
+     * // Query similar vectors
+     * const { data } = await index.queryVectors({
+     *   queryVector: { float32: [...] },
+     *   topK: 5
+     * })
+     * ```
+     */
+    index(indexName) {
+        return new VectorIndexScope(this.url, this.headers, this.vectorBucketName, indexName, this.fetch);
+    }
+}
+/**
+ * Scoped client for operations within a specific vector index
+ * Provides vector data operations (put, get, list, query, delete)
+ */
+export class VectorIndexScope extends VectorDataApi {
+    constructor(url, headers, vectorBucketName, indexName, fetch) {
+        super(url, headers, fetch);
+        this.vectorBucketName = vectorBucketName;
+        this.indexName = indexName;
+    }
+    /**
+     * Inserts or updates vectors in this index
+     * Convenience method that automatically includes bucket and index names
+     *
+     * @param options - Vector insertion options (bucket and index names automatically set)
+     * @returns Promise with empty response on success or error
+     *
+     * @example
+     * ```typescript
+     * const index = client.bucket('embeddings-prod').index('documents-openai')
+     * await index.putVectors({
+     *   vectors: [
+     *     {
+     *       key: 'doc-1',
+     *       data: { float32: [0.1, 0.2, ...] },
+     *       metadata: { title: 'Introduction', page: 1 }
+     *     }
+     *   ]
+     * })
+     * ```
+     */
+    putVectors(options) {
+        const _super = Object.create(null, {
+            putVectors: { get: () => super.putVectors }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            return _super.putVectors.call(this, Object.assign(Object.assign({}, options), { vectorBucketName: this.vectorBucketName, indexName: this.indexName }));
+        });
+    }
+    /**
+     * Retrieves vectors by keys from this index
+     * Convenience method that automatically includes bucket and index names
+     *
+     * @param options - Vector retrieval options (bucket and index names automatically set)
+     * @returns Promise with array of vectors or error
+     *
+     * @example
+     * ```typescript
+     * const index = client.bucket('embeddings-prod').index('documents-openai')
+     * const { data } = await index.getVectors({
+     *   keys: ['doc-1', 'doc-2'],
+     *   returnMetadata: true
+     * })
+     * ```
+     */
+    getVectors(options) {
+        const _super = Object.create(null, {
+            getVectors: { get: () => super.getVectors }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            return _super.getVectors.call(this, Object.assign(Object.assign({}, options), { vectorBucketName: this.vectorBucketName, indexName: this.indexName }));
+        });
+    }
+    /**
+     * Lists vectors in this index with pagination
+     * Convenience method that automatically includes bucket and index names
+     *
+     * @param options - Listing options (bucket and index names automatically set)
+     * @returns Promise with array of vectors and pagination token
+     *
+     * @example
+     * ```typescript
+     * const index = client.bucket('embeddings-prod').index('documents-openai')
+     * const { data } = await index.listVectors({
+     *   maxResults: 500,
+     *   returnMetadata: true
+     * })
+     * ```
+     */
+    listVectors() {
+        const _super = Object.create(null, {
+            listVectors: { get: () => super.listVectors }
+        });
+        return __awaiter(this, arguments, void 0, function* (options = {}) {
+            return _super.listVectors.call(this, Object.assign(Object.assign({}, options), { vectorBucketName: this.vectorBucketName, indexName: this.indexName }));
+        });
+    }
+    /**
+     * Queries for similar vectors in this index
+     * Convenience method that automatically includes bucket and index names
+     *
+     * @param options - Query options (bucket and index names automatically set)
+     * @returns Promise with array of similar vectors ordered by distance
+     *
+     * @example
+     * ```typescript
+     * const index = client.bucket('embeddings-prod').index('documents-openai')
+     * const { data } = await index.queryVectors({
+     *   queryVector: { float32: [0.1, 0.2, ...] },
+     *   topK: 5,
+     *   filter: { category: 'technical' },
+     *   returnDistance: true,
+     *   returnMetadata: true
+     * })
+     * ```
+     */
+    queryVectors(options) {
+        const _super = Object.create(null, {
+            queryVectors: { get: () => super.queryVectors }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            return _super.queryVectors.call(this, Object.assign(Object.assign({}, options), { vectorBucketName: this.vectorBucketName, indexName: this.indexName }));
+        });
+    }
+    /**
+     * Deletes vectors by keys from this index
+     * Convenience method that automatically includes bucket and index names
+     *
+     * @param options - Deletion options (bucket and index names automatically set)
+     * @returns Promise with empty response on success or error
+     *
+     * @example
+     * ```typescript
+     * const index = client.bucket('embeddings-prod').index('documents-openai')
+     * await index.deleteVectors({
+     *   keys: ['doc-1', 'doc-2', 'doc-3']
+     * })
+     * ```
+     */
+    deleteVectors(options) {
+        const _super = Object.create(null, {
+            deleteVectors: { get: () => super.deleteVectors }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            return _super.deleteVectors.call(this, Object.assign(Object.assign({}, options), { vectorBucketName: this.vectorBucketName, indexName: this.indexName }));
+        });
+    }
+}
+//# sourceMappingURL=StorageVectorsClient.js.map

package/dist/module/lib/vectors/StorageVectorsClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StorageVectorsClient.js","sourceRoot":"","sources":["../../../../src/lib/vectors/StorageVectorsClient.ts"],"names":[],"mappings":";AAAA,OAAO,cAAsC,MAAM,kBAAkB,CAAA;AACrE,OAAO,aAAa,MAAM,iBAAiB,CAAA;AAE3C,OAAO,eAAe,MAAM,mBAAmB,CAAA;AAyB/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AACH,MAAM,OAAO,oBAAqB,SAAQ,eAAe;IACvD,YAAY,GAAW,EAAE,UAAuC,EAAE;QAChE,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE,EAAE,OAAO,CAAC,KAAK,CAAC,CAAA;IAClD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;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;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,iBAAkB,SAAQ,cAAc;IAGnD,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;;;;;;;;;;;;;;;;;;;;OAoBG;IACY,WAAW,CAAC,OAAqD;;;;;YAC9E,OAAO,OAAM,WAAW,4CACnB,OAAO,KACV,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,KACvC;QACJ,CAAC;KAAA;IAED;;;;;;;;;;;;OAYG;IACY,WAAW;;;;6DAAC,UAAwD,EAAE;YACnF,OAAO,OAAM,WAAW,4CACnB,OAAO,KACV,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,KACvC;QACJ,CAAC;KAAA;IAED;;;;;;;;;;;;;OAaG;IACY,QAAQ,CAAC,SAAiB;;;;;YACvC,OAAO,OAAM,QAAQ,YAAC,IAAI,CAAC,gBAAgB,EAAE,SAAS,EAAC;QACzD,CAAC;KAAA;IAED;;;;;;;;;;;;OAYG;IACY,WAAW,CAAC,SAAiB;;;;;YAC1C,OAAO,OAAM,WAAW,YAAC,IAAI,CAAC,gBAAgB,EAAE,SAAS,EAAC;QAC5D,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;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;AAED;;;GAGG;AACH,MAAM,OAAO,gBAAiB,SAAQ,aAAa;IAIjD,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;;;;;;;;;;;;;;;;;;;;OAoBG;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;;;;;;;;;;;;;;;OAeG;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;;;;;;;;;;;;;;;OAeG;IACY,WAAW;;;;6DACxB,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;;;;;;;;;;;;;;;;;;OAkBG;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;;;;;;;;;;;;;;OAcG;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"}

package/dist/module/lib/vectors/VectorBucketApi.d.ts

@@ -0,0 +1,129 @@
+import { Fetch } from './fetch';
+import { ApiResponse, VectorBucket, ListVectorBucketsOptions, ListVectorBucketsResponse } from './types';
+/**
+ * API class for managing Vector Buckets
+ * Provides methods for creating, reading, listing, and deleting vector buckets
+ */
+export default class VectorBucketApi {
+    protected url: string;
+    protected headers: {
+        [key: string]: string;
+    };
+    protected fetch: Fetch;
+    protected shouldThrowOnError: boolean;
+    /**
+     * Creates a new VectorBucketApi instance
+     * @param url - The base URL for the storage vectors API
+     * @param headers - HTTP headers to include in requests
+     * @param fetch - Optional custom fetch implementation
+     */
+    constructor(url: string, headers?: {
+        [key: string]: string;
+    }, fetch?: Fetch);
+    /**
+     * Enable throwing errors instead of returning them in the response
+     * When enabled, failed operations will throw instead of returning { data: null, error }
+     *
+     * @returns This instance for method chaining
+     * @example
+     * ```typescript
+     * const client = new VectorBucketApi(url, headers)
+     * client.throwOnError()
+     * const { data } = await client.createBucket('my-bucket') // throws on error
+     * ```
+     */
+    throwOnError(): this;
+    /**
+     * Creates a new vector bucket
+     * Vector buckets are containers for vector indexes and their data
+     *
+     * @param vectorBucketName - Unique name for the vector bucket
+     * @returns Promise with empty response on success or error
+     *
+     * @throws {StorageVectorsApiError} With code:
+     * - `S3VectorConflictException` if bucket already exists (HTTP 409)
+     * - `S3VectorMaxBucketsExceeded` if quota exceeded (HTTP 400)
+     * - `InternalError` for server errors (HTTP 500)
+     *
+     * @example
+     * ```typescript
+     * const { data, error } = await client.createBucket('embeddings-prod')
+     * if (error) {
+     *   console.error('Failed to create bucket:', error.message)
+     * }
+     * ```
+     */
+    createBucket(vectorBucketName: string): Promise<ApiResponse<undefined>>;
+    /**
+     * Retrieves metadata for a specific vector bucket
+     * Returns bucket configuration including encryption settings and creation time
+     *
+     * @param vectorBucketName - Name of the vector bucket to retrieve
+     * @returns Promise with bucket metadata or error
+     *
+     * @throws {StorageVectorsApiError} With code:
+     * - `S3VectorNotFoundException` if bucket doesn't exist (HTTP 404)
+     * - `InternalError` for server errors (HTTP 500)
+     *
+     * @example
+     * ```typescript
+     * const { data, error } = await client.getBucket('embeddings-prod')
+     * if (data) {
+     *   console.log('Bucket created at:', new Date(data.vectorBucket.creationTime! * 1000))
+     * }
+     * ```
+     */
+    getBucket(vectorBucketName: string): Promise<ApiResponse<{
+        vectorBucket: VectorBucket;
+    }>>;
+    /**
+     * Lists vector buckets with optional filtering and pagination
+     * Supports prefix-based filtering and paginated results
+     *
+     * @param options - Listing options
+     * @param options.prefix - Filter buckets by name prefix
+     * @param options.maxResults - Maximum results per page (default: 100)
+     * @param options.nextToken - Pagination token from previous response
+     * @returns Promise with list of buckets and pagination token
+     *
+     * @throws {StorageVectorsApiError} With code:
+     * - `InternalError` for server errors (HTTP 500)
+     *
+     * @example
+     * ```typescript
+     * // List all buckets with prefix 'prod-'
+     * const { data, error } = await client.listBuckets({ prefix: 'prod-' })
+     * if (data) {
+     *   console.log('Found buckets:', data.buckets.length)
+     *   // Fetch next page if available
+     *   if (data.nextToken) {
+     *     const next = await client.listBuckets({ nextToken: data.nextToken })
+     *   }
+     * }
+     * ```
+     */
+    listBuckets(options?: ListVectorBucketsOptions): Promise<ApiResponse<ListVectorBucketsResponse>>;
+    /**
+     * Deletes a vector bucket
+     * Bucket must be empty before deletion (all indexes must be removed first)
+     *
+     * @param vectorBucketName - Name of the vector bucket to delete
+     * @returns Promise with empty response on success or error
+     *
+     * @throws {StorageVectorsApiError} With code:
+     * - `S3VectorBucketNotEmpty` if bucket contains indexes (HTTP 400)
+     * - `S3VectorNotFoundException` if bucket doesn't exist (HTTP 404)
+     * - `InternalError` for server errors (HTTP 500)
+     *
+     * @example
+     * ```typescript
+     * // Delete all indexes first, then delete bucket
+     * const { error } = await client.deleteBucket('old-bucket')
+     * if (error?.statusCode === 'S3VectorBucketNotEmpty') {
+     *   console.error('Must delete all indexes first')
+     * }
+     * ```
+     */
+    deleteBucket(vectorBucketName: string): Promise<ApiResponse<undefined>>;
+}
+//# sourceMappingURL=VectorBucketApi.d.ts.map

package/dist/module/lib/vectors/VectorBucketApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"VectorBucketApi.d.ts","sourceRoot":"","sources":["../../../../src/lib/vectors/VectorBucketApi.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAQ,MAAM,SAAS,CAAA;AAErC,OAAO,EACL,WAAW,EACX,YAAY,EACZ,wBAAwB,EACxB,yBAAyB,EAC1B,MAAM,SAAS,CAAA;AAEhB;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,eAAe;IAClC,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;;;;;OAKG;gBACS,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAO,EAAE,KAAK,CAAC,EAAE,KAAK;IAM/E;;;;;;;;;;;OAWG;IACI,YAAY,IAAI,IAAI;IAK3B;;;;;;;;;;;;;;;;;;;OAmBG;IACG,YAAY,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IAoB7E;;;;;;;;;;;;;;;;;;OAkBG;IACG,SAAS,CACb,gBAAgB,EAAE,MAAM,GACvB,OAAO,CAAC,WAAW,CAAC;QAAE,YAAY,EAAE,YAAY,CAAA;KAAE,CAAC,CAAC;IAoBvD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,WAAW,CACf,OAAO,GAAE,wBAA6B,GACrC,OAAO,CAAC,WAAW,CAAC,yBAAyB,CAAC,CAAC;IAiBlD;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,YAAY,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;CAmB9E"}

package/dist/module/lib/vectors/VectorBucketApi.js

@@ -0,0 +1,196 @@
+import { __awaiter } from "tslib";
+import { DEFAULT_HEADERS } from './constants';
+import { isStorageVectorsError } from './errors';
+import { post } from './fetch';
+import { resolveFetch } from './helpers';
+/**
+ * API class for managing Vector Buckets
+ * Provides methods for creating, reading, listing, and deleting vector buckets
+ */
+export default class VectorBucketApi {
+    /**
+     * Creates a new VectorBucketApi instance
+     * @param url - The base URL for the storage vectors API
+     * @param headers - HTTP headers to include in requests
+     * @param fetch - Optional custom fetch implementation
+     */
+    constructor(url, headers = {}, fetch) {
+        this.shouldThrowOnError = false;
+        this.url = url.replace(/\/$/, '');
+        this.headers = Object.assign(Object.assign({}, DEFAULT_HEADERS), headers);
+        this.fetch = resolveFetch(fetch);
+    }
+    /**
+     * Enable throwing errors instead of returning them in the response
+     * When enabled, failed operations will throw instead of returning { data: null, error }
+     *
+     * @returns This instance for method chaining
+     * @example
+     * ```typescript
+     * const client = new VectorBucketApi(url, headers)
+     * client.throwOnError()
+     * const { data } = await client.createBucket('my-bucket') // throws on error
+     * ```
+     */
+    throwOnError() {
+        this.shouldThrowOnError = true;
+        return this;
+    }
+    /**
+     * Creates a new vector bucket
+     * Vector buckets are containers for vector indexes and their data
+     *
+     * @param vectorBucketName - Unique name for the vector bucket
+     * @returns Promise with empty response on success or error
+     *
+     * @throws {StorageVectorsApiError} With code:
+     * - `S3VectorConflictException` if bucket already exists (HTTP 409)
+     * - `S3VectorMaxBucketsExceeded` if quota exceeded (HTTP 400)
+     * - `InternalError` for server errors (HTTP 500)
+     *
+     * @example
+     * ```typescript
+     * const { data, error } = await client.createBucket('embeddings-prod')
+     * if (error) {
+     *   console.error('Failed to create bucket:', error.message)
+     * }
+     * ```
+     */
+    createBucket(vectorBucketName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const data = yield post(this.fetch, `${this.url}/CreateVectorBucket`, { vectorBucketName }, { headers: this.headers });
+                return { data: data || {}, error: null };
+            }
+            catch (error) {
+                if (this.shouldThrowOnError) {
+                    throw error;
+                }
+                if (isStorageVectorsError(error)) {
+                    return { data: null, error };
+                }
+                throw error;
+            }
+        });
+    }
+    /**
+     * Retrieves metadata for a specific vector bucket
+     * Returns bucket configuration including encryption settings and creation time
+     *
+     * @param vectorBucketName - Name of the vector bucket to retrieve
+     * @returns Promise with bucket metadata or error
+     *
+     * @throws {StorageVectorsApiError} With code:
+     * - `S3VectorNotFoundException` if bucket doesn't exist (HTTP 404)
+     * - `InternalError` for server errors (HTTP 500)
+     *
+     * @example
+     * ```typescript
+     * const { data, error } = await client.getBucket('embeddings-prod')
+     * if (data) {
+     *   console.log('Bucket created at:', new Date(data.vectorBucket.creationTime! * 1000))
+     * }
+     * ```
+     */
+    getBucket(vectorBucketName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const data = yield post(this.fetch, `${this.url}/GetVectorBucket`, { vectorBucketName }, { headers: this.headers });
+                return { data, error: null };
+            }
+            catch (error) {
+                if (this.shouldThrowOnError) {
+                    throw error;
+                }
+                if (isStorageVectorsError(error)) {
+                    return { data: null, error };
+                }
+                throw error;
+            }
+        });
+    }
+    /**
+     * Lists vector buckets with optional filtering and pagination
+     * Supports prefix-based filtering and paginated results
+     *
+     * @param options - Listing options
+     * @param options.prefix - Filter buckets by name prefix
+     * @param options.maxResults - Maximum results per page (default: 100)
+     * @param options.nextToken - Pagination token from previous response
+     * @returns Promise with list of buckets and pagination token
+     *
+     * @throws {StorageVectorsApiError} With code:
+     * - `InternalError` for server errors (HTTP 500)
+     *
+     * @example
+     * ```typescript
+     * // List all buckets with prefix 'prod-'
+     * const { data, error } = await client.listBuckets({ prefix: 'prod-' })
+     * if (data) {
+     *   console.log('Found buckets:', data.buckets.length)
+     *   // Fetch next page if available
+     *   if (data.nextToken) {
+     *     const next = await client.listBuckets({ nextToken: data.nextToken })
+     *   }
+     * }
+     * ```
+     */
+    listBuckets() {
+        return __awaiter(this, arguments, void 0, function* (options = {}) {
+            try {
+                const data = yield post(this.fetch, `${this.url}/ListVectorBuckets`, options, {
+                    headers: this.headers,
+                });
+                return { data, error: null };
+            }
+            catch (error) {
+                if (this.shouldThrowOnError) {
+                    throw error;
+                }
+                if (isStorageVectorsError(error)) {
+                    return { data: null, error };
+                }
+                throw error;
+            }
+        });
+    }
+    /**
+     * Deletes a vector bucket
+     * Bucket must be empty before deletion (all indexes must be removed first)
+     *
+     * @param vectorBucketName - Name of the vector bucket to delete
+     * @returns Promise with empty response on success or error
+     *
+     * @throws {StorageVectorsApiError} With code:
+     * - `S3VectorBucketNotEmpty` if bucket contains indexes (HTTP 400)
+     * - `S3VectorNotFoundException` if bucket doesn't exist (HTTP 404)
+     * - `InternalError` for server errors (HTTP 500)
+     *
+     * @example
+     * ```typescript
+     * // Delete all indexes first, then delete bucket
+     * const { error } = await client.deleteBucket('old-bucket')
+     * if (error?.statusCode === 'S3VectorBucketNotEmpty') {
+     *   console.error('Must delete all indexes first')
+     * }
+     * ```
+     */
+    deleteBucket(vectorBucketName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const data = yield post(this.fetch, `${this.url}/DeleteVectorBucket`, { vectorBucketName }, { headers: this.headers });
+                return { data: data || {}, error: null };
+            }
+            catch (error) {
+                if (this.shouldThrowOnError) {
+                    throw error;
+                }
+                if (isStorageVectorsError(error)) {
+                    return { data: null, error };
+                }
+                throw error;
+            }
+        });
+    }
+}
+//# sourceMappingURL=VectorBucketApi.js.map