@supabase/storage-js 2.79.1-canary.1 → 2.80.0

package/dist/main/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/main/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/main/lib/vectors/VectorBucketApi.js

@@ -0,0 +1,199 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const constants_1 = require("./constants");
+const errors_1 = require("./errors");
+const fetch_1 = require("./fetch");
+const helpers_1 = require("./helpers");
+/**
+ * API class for managing Vector Buckets
+ * Provides methods for creating, reading, listing, and deleting vector buckets
+ */
+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({}, constants_1.DEFAULT_HEADERS), headers);
+        this.fetch = (0, helpers_1.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 tslib_1.__awaiter(this, void 0, void 0, function* () {
+            try {
+                const data = yield (0, fetch_1.post)(this.fetch, `${this.url}/CreateVectorBucket`, { vectorBucketName }, { headers: this.headers });
+                return { data: data || {}, error: null };
+            }
+            catch (error) {
+                if (this.shouldThrowOnError) {
+                    throw error;
+                }
+                if ((0, errors_1.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 tslib_1.__awaiter(this, void 0, void 0, function* () {
+            try {
+                const data = yield (0, fetch_1.post)(this.fetch, `${this.url}/GetVectorBucket`, { vectorBucketName }, { headers: this.headers });
+                return { data, error: null };
+            }
+            catch (error) {
+                if (this.shouldThrowOnError) {
+                    throw error;
+                }
+                if ((0, errors_1.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 tslib_1.__awaiter(this, arguments, void 0, function* (options = {}) {
+            try {
+                const data = yield (0, fetch_1.post)(this.fetch, `${this.url}/ListVectorBuckets`, options, {
+                    headers: this.headers,
+                });
+                return { data, error: null };
+            }
+            catch (error) {
+                if (this.shouldThrowOnError) {
+                    throw error;
+                }
+                if ((0, errors_1.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 tslib_1.__awaiter(this, void 0, void 0, function* () {
+            try {
+                const data = yield (0, fetch_1.post)(this.fetch, `${this.url}/DeleteVectorBucket`, { vectorBucketName }, { headers: this.headers });
+                return { data: data || {}, error: null };
+            }
+            catch (error) {
+                if (this.shouldThrowOnError) {
+                    throw error;
+                }
+                if ((0, errors_1.isStorageVectorsError)(error)) {
+                    return { data: null, error };
+                }
+                throw error;
+            }
+        });
+    }
+}
+exports.default = VectorBucketApi;
+//# sourceMappingURL=VectorBucketApi.js.map

package/dist/main/lib/vectors/VectorBucketApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"VectorBucketApi.js","sourceRoot":"","sources":["../../../../src/lib/vectors/VectorBucketApi.ts"],"names":[],"mappings":";;;AAAA,2CAA6C;AAC7C,qCAAgD;AAChD,mCAAqC;AACrC,uCAAwC;AAQxC;;;GAGG;AACH,MAAqB,eAAe;IAMlC;;;;;OAKG;IACH,YAAY,GAAW,EAAE,UAAqC,EAAE,EAAE,KAAa;QARrE,uBAAkB,GAAG,KAAK,CAAA;QASlC,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;;;;;;;;;;;OAWG;IACI,YAAY;QACjB,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAA;QAC9B,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACG,YAAY,CAAC,gBAAwB;;YACzC,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EACrB,IAAI,CAAC,KAAK,EACV,GAAG,IAAI,CAAC,GAAG,qBAAqB,EAChC,EAAE,gBAAgB,EAAE,EACpB,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;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,SAAS,CACb,gBAAwB;;YAExB,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EACrB,IAAI,CAAC,KAAK,EACV,GAAG,IAAI,CAAC,GAAG,kBAAkB,EAC7B,EAAE,gBAAgB,EAAE,EACpB,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;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,WAAW;qEACf,UAAoC,EAAE;YAEtC,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,oBAAoB,EAAE,OAAO,EAAE;oBAC5E,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;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,YAAY,CAAC,gBAAwB;;YACzC,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EACrB,IAAI,CAAC,KAAK,EACV,GAAG,IAAI,CAAC,GAAG,qBAAqB,EAChC,EAAE,gBAAgB,EAAE,EACpB,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;AAzMD,kCAyMC"}

package/dist/main/lib/vectors/VectorDataApi.d.ts

@@ -0,0 +1,221 @@
+import { Fetch } from './fetch';
+import { ApiResponse, PutVectorsOptions, GetVectorsOptions, GetVectorsResponse, DeleteVectorsOptions, ListVectorsOptions, ListVectorsResponse, QueryVectorsOptions, QueryVectorsResponse } from './types';
+/**
+ * API class for managing Vector Data within Vector Indexes
+ * Provides methods for inserting, querying, listing, and deleting vector embeddings
+ */
+export default class VectorDataApi {
+    protected url: string;
+    protected headers: {
+        [key: string]: string;
+    };
+    protected fetch: Fetch;
+    protected shouldThrowOnError: boolean;
+    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 VectorDataApi(url, headers)
+     * client.throwOnError()
+     * const { data } = await client.putVectors(options) // throws on error
+     * ```
+     */
+    throwOnError(): this;
+    /**
+     * Inserts or updates vectors in batch (upsert operation)
+     * Accepts 1-500 vectors per request. Larger batches should be split
+     *
+     * @param options - Vector insertion options
+     * @param options.vectorBucketName - Name of the parent vector bucket
+     * @param options.indexName - Name of the target index
+     * @param options.vectors - Array of vectors to insert/update (1-500 items)
+     * @returns Promise with empty response on success or error
+     *
+     * @throws {StorageVectorsApiError} With code:
+     * - `S3VectorConflictException` if duplicate key conflict occurs (HTTP 409)
+     * - `S3VectorNotFoundException` if bucket or index doesn't exist (HTTP 404)
+     * - `InternalError` for server errors (HTTP 500)
+     *
+     * @example
+     * ```typescript
+     * const { data, error } = await client.putVectors({
+     *   vectorBucketName: 'embeddings-prod',
+     *   indexName: 'documents-openai-small',
+     *   vectors: [
+     *     {
+     *       key: 'doc-1',
+     *       data: { float32: [0.1, 0.2, 0.3, ...] }, // 1536 dimensions
+     *       metadata: { title: 'Introduction', page: 1 }
+     *     },
+     *     {
+     *       key: 'doc-2',
+     *       data: { float32: [0.4, 0.5, 0.6, ...] },
+     *       metadata: { title: 'Conclusion', page: 42 }
+     *     }
+     *   ]
+     * })
+     * ```
+     */
+    putVectors(options: PutVectorsOptions): Promise<ApiResponse<undefined>>;
+    /**
+     * Retrieves vectors by their keys in batch
+     * Optionally includes vector data and/or metadata in response
+     * Additional permissions required when returning data or metadata
+     *
+     * @param options - Vector retrieval options
+     * @param options.vectorBucketName - Name of the parent vector bucket
+     * @param options.indexName - Name of the index
+     * @param options.keys - Array of vector keys to retrieve
+     * @param options.returnData - Whether to include vector embeddings (requires permission)
+     * @param options.returnMetadata - Whether to include metadata (requires permission)
+     * @returns Promise with array of vectors or error
+     *
+     * @throws {StorageVectorsApiError} With code:
+     * - `S3VectorNotFoundException` if bucket or index doesn't exist (HTTP 404)
+     * - `InternalError` for server errors (HTTP 500)
+     *
+     * @example
+     * ```typescript
+     * const { data, error } = await client.getVectors({
+     *   vectorBucketName: 'embeddings-prod',
+     *   indexName: 'documents-openai-small',
+     *   keys: ['doc-1', 'doc-2', 'doc-3'],
+     *   returnData: false,     // Don't return embeddings
+     *   returnMetadata: true   // Return metadata only
+     * })
+     * if (data) {
+     *   data.vectors.forEach(v => console.log(v.key, v.metadata))
+     * }
+     * ```
+     */
+    getVectors(options: GetVectorsOptions): Promise<ApiResponse<GetVectorsResponse>>;
+    /**
+     * Lists/scans vectors in an index with pagination
+     * Supports parallel scanning via segment configuration for high-throughput scenarios
+     * Additional permissions required when returning data or metadata
+     *
+     * @param options - Vector listing options
+     * @param options.vectorBucketName - Name of the parent vector bucket
+     * @param options.indexName - Name of the index
+     * @param options.maxResults - Maximum results per page (default: 500, max: 1000)
+     * @param options.nextToken - Pagination token from previous response
+     * @param options.returnData - Whether to include vector embeddings (requires permission)
+     * @param options.returnMetadata - Whether to include metadata (requires permission)
+     * @param options.segmentCount - Total parallel segments (1-16) for distributed scanning
+     * @param options.segmentIndex - Zero-based segment index (0 to segmentCount-1)
+     * @returns Promise with array of vectors, pagination token, or error
+     *
+     * @throws {StorageVectorsApiError} With code:
+     * - `S3VectorNotFoundException` if bucket or index doesn't exist (HTTP 404)
+     * - `InternalError` for server errors (HTTP 500)
+     *
+     * @example
+     * ```typescript
+     * // Simple pagination
+     * let nextToken: string | undefined
+     * do {
+     *   const { data, error } = await client.listVectors({
+     *     vectorBucketName: 'embeddings-prod',
+     *     indexName: 'documents-openai-small',
+     *     maxResults: 500,
+     *     nextToken,
+     *     returnMetadata: true
+     *   })
+     *   if (error) break
+     *   console.log('Batch:', data.vectors.length)
+     *   nextToken = data.nextToken
+     * } while (nextToken)
+     *
+     * // Parallel scanning (4 concurrent workers)
+     * const workers = [0, 1, 2, 3].map(async (segmentIndex) => {
+     *   const { data } = await client.listVectors({
+     *     vectorBucketName: 'embeddings-prod',
+     *     indexName: 'documents-openai-small',
+     *     segmentCount: 4,
+     *     segmentIndex,
+     *     returnMetadata: true
+     *   })
+     *   return data?.vectors || []
+     * })
+     * const results = await Promise.all(workers)
+     * ```
+     */
+    listVectors(options: ListVectorsOptions): Promise<ApiResponse<ListVectorsResponse>>;
+    /**
+     * Queries for similar vectors using approximate nearest neighbor (ANN) search
+     * Returns top-K most similar vectors based on the configured distance metric
+     * Supports optional metadata filtering (requires GetVectors permission)
+     *
+     * @param options - Query options
+     * @param options.vectorBucketName - Name of the parent vector bucket
+     * @param options.indexName - Name of the index
+     * @param options.queryVector - Query embedding to find similar vectors
+     * @param options.topK - Number of nearest neighbors to return (default: 10)
+     * @param options.filter - Optional JSON filter for metadata (requires GetVectors permission)
+     * @param options.returnDistance - Whether to include similarity distances
+     * @param options.returnMetadata - Whether to include metadata (requires GetVectors permission)
+     * @returns Promise with array of similar vectors ordered by distance
+     *
+     * @throws {StorageVectorsApiError} With code:
+     * - `S3VectorNotFoundException` if bucket or index doesn't exist (HTTP 404)
+     * - `InternalError` for server errors (HTTP 500)
+     *
+     * @example
+     * ```typescript
+     * // Semantic search with filtering
+     * const { data, error } = await client.queryVectors({
+     *   vectorBucketName: 'embeddings-prod',
+     *   indexName: 'documents-openai-small',
+     *   queryVector: { float32: [0.1, 0.2, 0.3, ...] }, // 1536 dimensions
+     *   topK: 5,
+     *   filter: {
+     *     category: 'technical',
+     *     published: true
+     *   },
+     *   returnDistance: true,
+     *   returnMetadata: true
+     * })
+     * if (data) {
+     *   data.matches.forEach(match => {
+     *     console.log(`${match.key}: distance=${match.distance}`)
+     *     console.log('Metadata:', match.metadata)
+     *   })
+     * }
+     * ```
+     */
+    queryVectors(options: QueryVectorsOptions): Promise<ApiResponse<QueryVectorsResponse>>;
+    /**
+     * Deletes vectors by their keys in batch
+     * Accepts 1-500 keys per request
+     *
+     * @param options - Vector deletion options
+     * @param options.vectorBucketName - Name of the parent vector bucket
+     * @param options.indexName - Name of the index
+     * @param options.keys - Array of vector keys to delete (1-500 items)
+     * @returns Promise with empty response on success or error
+     *
+     * @throws {StorageVectorsApiError} With code:
+     * - `S3VectorNotFoundException` if bucket or index doesn't exist (HTTP 404)
+     * - `InternalError` for server errors (HTTP 500)
+     *
+     * @example
+     * ```typescript
+     * const { error } = await client.deleteVectors({
+     *   vectorBucketName: 'embeddings-prod',
+     *   indexName: 'documents-openai-small',
+     *   keys: ['doc-1', 'doc-2', 'doc-3']
+     * })
+     * if (!error) {
+     *   console.log('Vectors deleted successfully')
+     * }
+     * ```
+     */
+    deleteVectors(options: DeleteVectorsOptions): Promise<ApiResponse<undefined>>;
+}
+//# sourceMappingURL=VectorDataApi.d.ts.map

package/dist/main/lib/vectors/VectorDataApi.d.ts.map

@@ -0,0 +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;;;GAGG;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;gBAExB,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IAsB7E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC;IAiBtF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACG,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,mBAAmB,CAAC,CAAC;IA6BzF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACG,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC;IAiB5F;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;CAqBpF"}