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

package/dist/module/lib/types.d.ts

@@ -1,4 +1,9 @@
 import { StorageError } from './errors';
+/**
+ * Type of storage bucket
+ * - STANDARD: Regular file storage buckets
+ * - ANALYTICS: Iceberg table-based buckets for analytical workloads
+ */
 export type BucketType = 'STANDARD' | 'ANALYTICS';
 export interface Bucket {
     id: string;
@@ -11,6 +16,29 @@ export interface Bucket {
     updated_at: string;
     public: boolean;
 }
+export interface ListBucketOptions {
+    limit?: number;
+    offset?: number;
+    sortColumn?: 'id' | 'name' | 'created_at' | 'updated_at';
+    sortOrder?: 'asc' | 'desc';
+    search?: string;
+}
+/**
+ * Represents an Analytics Bucket using Apache Iceberg table format.
+ * Analytics buckets are optimized for analytical queries and data processing.
+ */
+export interface AnalyticBucket {
+    /** Unique identifier for the bucket */
+    id: string;
+    /** Bucket type - always 'ANALYTICS' for analytics buckets */
+    type: 'ANALYTICS';
+    /** Storage format used (e.g., 'iceberg') */
+    format: string;
+    /** ISO 8601 timestamp of bucket creation */
+    created_at: string;
+    /** ISO 8601 timestamp of last update */
+    updated_at: string;
+}
 export interface FileObject {
     name: string;
     bucket_id: string;
@@ -18,6 +46,7 @@ export interface FileObject {
     id: string;
     updated_at: string;
     created_at: string;
+    /** @deprecated */
     last_accessed_at: string;
     metadata: Record<string, any>;
     buckets: Bucket;
@@ -29,6 +58,7 @@ export interface FileObjectV2 {
     bucket_id: string;
     updated_at: string;
     created_at: string;
+    /** @deprecated */
     last_accessed_at: string;
     size?: number;
     cache_control?: string;
@@ -89,18 +119,58 @@ export interface SearchOptions {
      */
     search?: string;
 }
+export interface SortByV2 {
+    column: 'name' | 'updated_at' | 'created_at';
+    order?: 'asc' | 'desc';
+}
 export interface SearchV2Options {
+    /**
+     * The number of files you want to be returned.
+     * @default 1000
+     */
     limit?: number;
+    /**
+     * The prefix search string to filter files by.
+     */
     prefix?: string;
+    /**
+     * The cursor used for pagination. Pass the value received from nextCursor of the previous request.
+     */
     cursor?: string;
+    /**
+     * Whether to emulate a hierarchical listing of objects using delimiters.
+     *
+     * - When `false` (default), all objects are listed as flat key/value pairs.
+     * - When `true`, the response groups objects by delimiter, making it appear
+     *   like a file/folder hierarchy.
+     *
+     * @default false
+     */
     with_delimiter?: boolean;
+    /**
+     * The column and order to sort by
+     * @default 'name asc'
+     */
+    sortBy?: SortByV2;
+}
+export interface SearchV2Object {
+    id: string;
+    key: string;
+    name: string;
+    updated_at: string;
+    created_at: string;
+    metadata: Record<string, any>;
+    /**
+     * @deprecated
+     */
+    last_accessed_at: string;
 }
+export type SearchV2Folder = Omit<SearchV2Object, 'id' | 'metadata' | 'last_accessed_at'>;
 export interface SearchV2Result {
     hasNext: boolean;
-    folders: {
-        name: string;
-    }[];
-    objects: FileObject[];
+    folders: SearchV2Folder[];
+    objects: SearchV2Object[];
+    nextCursor?: string;
 }
 export interface FetchParameters {
     /**

package/dist/module/lib/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/lib/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAEvC,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG,WAAW,CAAA;AAEjD,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,CAAC,EAAE,UAAU,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC7B,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,OAAO,CAAA;CAChB;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,gBAAgB,EAAE,MAAM,CAAA;IACxB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC7B,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,gBAAgB,EAAE,MAAM,CAAA;IACxB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,MAAM;IACrB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAE9B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,kBAAkB;IACjC,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC3B;AAED,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,eAAe;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IAC3B,OAAO,EAAE,UAAU,EAAE,CAAA;CACtB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAA;CACrB;AAGD,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;;;OAKG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,CAAA;IACrC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,QAAQ,CAAA;CAClB;AAED,KAAK,SAAS,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,GAAG,MAAM,EAAE,IAAI,MAAM,EAAE,GAAG,MAAM,EAAE,EAAE,GAC7E,GAAG,SAAS,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,EAAE,CAAC,EAAE,GAClD,CAAC,CAAA;AAEL,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI;KACvB,CAAC,IAAI,MAAM,CAAC,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACtD,CAAA;AAED,MAAM,MAAM,cAAc,CAAC,CAAC,IACxB;IACE,IAAI,EAAE,CAAC,CAAA;IACP,KAAK,EAAE,IAAI,CAAA;CACZ,GACD;IACE,IAAI,EAAE,IAAI,CAAA;IACV,KAAK,EAAE,YAAY,CAAA;CACpB,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/lib/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAEvC;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG,WAAW,CAAA;AAEjD,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,CAAC,EAAE,UAAU,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC7B,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,OAAO,CAAA;CAChB;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,UAAU,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,YAAY,GAAG,YAAY,CAAA;IACxD,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,CAAA;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,uCAAuC;IACvC,EAAE,EAAE,MAAM,CAAA;IACV,6DAA6D;IAC7D,IAAI,EAAE,WAAW,CAAA;IACjB,4CAA4C;IAC5C,MAAM,EAAE,MAAM,CAAA;IACd,4CAA4C;IAC5C,UAAU,EAAE,MAAM,CAAA;IAClB,wCAAwC;IACxC,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,kBAAkB;IAClB,gBAAgB,EAAE,MAAM,CAAA;IACxB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC7B,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,kBAAkB;IAClB,gBAAgB,EAAE,MAAM,CAAA;IACxB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,MAAM;IACrB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAE9B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,kBAAkB;IACjC,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC3B;AAED,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,MAAM,GAAG,YAAY,GAAG,YAAY,CAAA;IAC5C,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;;;;;;;OAQG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IAExB;;;OAGG;IACH,MAAM,CAAC,EAAE,QAAQ,CAAA;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAA;IACV,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC7B;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAA;CACzB;AAED,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,EAAE,IAAI,GAAG,UAAU,GAAG,kBAAkB,CAAC,CAAA;AAEzF,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,EAAE,cAAc,EAAE,CAAA;IACzB,OAAO,EAAE,cAAc,EAAE,CAAA;IACzB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAA;CACrB;AAGD,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;;;OAKG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,CAAA;IACrC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,QAAQ,CAAA;CAClB;AAED,KAAK,SAAS,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,GAAG,MAAM,EAAE,IAAI,MAAM,EAAE,GAAG,MAAM,EAAE,EAAE,GAC7E,GAAG,SAAS,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,EAAE,CAAC,EAAE,GAClD,CAAC,CAAA;AAEL,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI;KACvB,CAAC,IAAI,MAAM,CAAC,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACtD,CAAA;AAED,MAAM,MAAM,cAAc,CAAC,CAAC,IACxB;IACE,IAAI,EAAE,CAAC,CAAA;IACP,KAAK,EAAE,IAAI,CAAA;CACZ,GACD;IACE,IAAI,EAAE,IAAI,CAAA;IACV,KAAK,EAAE,YAAY,CAAA;CACpB,CAAA"}

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

@@ -0,0 +1,310 @@
+import VectorIndexApi, { CreateIndexOptions } from './VectorIndexApi';
+import VectorDataApi from './VectorDataApi';
+import { Fetch } from './fetch';
+import VectorBucketApi from './VectorBucketApi';
+import { DeleteVectorsOptions, GetVectorsOptions, ListIndexesOptions, ListVectorsOptions, PutVectorsOptions, QueryVectorsOptions } from './types';
+/**
+ * Configuration options for the Storage Vectors client
+ */
+export interface StorageVectorsClientOptions {
+    /**
+     * Custom headers to include in all requests
+     */
+    headers?: {
+        [key: string]: string;
+    };
+    /**
+     * Custom fetch implementation (optional)
+     * Useful for testing or custom request handling
+     */
+    fetch?: Fetch;
+}
+/**
+ * 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 declare class StorageVectorsClient extends VectorBucketApi {
+    constructor(url: string, options?: StorageVectorsClientOptions);
+    /**
+     * 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: string): VectorBucketScope;
+}
+/**
+ * Scoped client for operations within a specific vector bucket
+ * Provides index management and access to vector operations
+ */
+export declare class VectorBucketScope extends VectorIndexApi {
+    private vectorBucketName;
+    constructor(url: string, headers: {
+        [key: string]: string;
+    }, vectorBucketName: string, fetch?: Fetch);
+    /**
+     * 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: Omit<CreateIndexOptions, 'vectorBucketName'>): Promise<import("./types").ApiResponse<undefined>>;
+    /**
+     * 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(options?: Omit<ListIndexesOptions, 'vectorBucketName'>): Promise<import("./types").ApiResponse<import("./types").ListIndexesResponse>>;
+    /**
+     * 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: string): Promise<import("./types").ApiResponse<{
+        index: import("./types").VectorIndex;
+    }>>;
+    /**
+     * 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: string): Promise<import("./types").ApiResponse<undefined>>;
+    /**
+     * 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: string): VectorIndexScope;
+}
+/**
+ * Scoped client for operations within a specific vector index
+ * Provides vector data operations (put, get, list, query, delete)
+ */
+export declare class VectorIndexScope extends VectorDataApi {
+    private vectorBucketName;
+    private indexName;
+    constructor(url: string, headers: {
+        [key: string]: string;
+    }, vectorBucketName: string, indexName: string, fetch?: Fetch);
+    /**
+     * 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: Omit<PutVectorsOptions, 'vectorBucketName' | 'indexName'>): Promise<import("./types").ApiResponse<undefined>>;
+    /**
+     * 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: Omit<GetVectorsOptions, 'vectorBucketName' | 'indexName'>): Promise<import("./types").ApiResponse<import("./types").GetVectorsResponse>>;
+    /**
+     * 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(options?: Omit<ListVectorsOptions, 'vectorBucketName' | 'indexName'>): Promise<import("./types").ApiResponse<import("./types").ListVectorsResponse>>;
+    /**
+     * 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: Omit<QueryVectorsOptions, 'vectorBucketName' | 'indexName'>): Promise<import("./types").ApiResponse<import("./types").QueryVectorsResponse>>;
+    /**
+     * 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: Omit<DeleteVectorsOptions, 'vectorBucketName' | 'indexName'>): Promise<import("./types").ApiResponse<undefined>>;
+}
+//# sourceMappingURL=StorageVectorsClient.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"StorageVectorsClient.d.ts","sourceRoot":"","sources":["../../../../src/lib/vectors/StorageVectorsClient.ts"],"names":[],"mappings":"AAAA,OAAO,cAAc,EAAE,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAA;AACrE,OAAO,aAAa,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAC/B,OAAO,eAAe,MAAM,mBAAmB,CAAA;AAC/C,OAAO,EACL,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,mBAAmB,EACpB,MAAM,SAAS,CAAA;AAEhB;;GAEG;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AACH,qBAAa,oBAAqB,SAAQ,eAAe;gBAC3C,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,2BAAgC;IAIlE;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,IAAI,CAAC,gBAAgB,EAAE,MAAM,GAAG,iBAAiB;CAGlD;AAED;;;GAGG;AACH,qBAAa,iBAAkB,SAAQ,cAAc;IACnD,OAAO,CAAC,gBAAgB,CAAQ;gBAG9B,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;;;;;;;;;;;;;;;;;;;;OAoBG;IACY,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;IAOhF;;;;;;;;;;;;OAYG;IACY,WAAW,CAAC,OAAO,GAAE,IAAI,CAAC,kBAAkB,EAAE,kBAAkB,CAAM;IAOrF;;;;;;;;;;;;;OAaG;IACY,QAAQ,CAAC,SAAS,EAAE,MAAM;;;IAIzC;;;;;;;;;;;;OAYG;IACY,WAAW,CAAC,SAAS,EAAE,MAAM;IAI5C;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,KAAK,CAAC,SAAS,EAAE,MAAM,GAAG,gBAAgB;CAS3C;AAED;;;GAGG;AACH,qBAAa,gBAAiB,SAAQ,aAAa;IACjD,OAAO,CAAC,gBAAgB,CAAQ;IAChC,OAAO,CAAC,SAAS,CAAQ;gBAGvB,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;;;;;;;;;;;;;;;;;;;;OAoBG;IACY,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,iBAAiB,EAAE,kBAAkB,GAAG,WAAW,CAAC;IAQ5F;;;;;;;;;;;;;;;OAeG;IACY,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,iBAAiB,EAAE,kBAAkB,GAAG,WAAW,CAAC;IAQ5F;;;;;;;;;;;;;;;OAeG;IACY,WAAW,CACxB,OAAO,GAAE,IAAI,CAAC,kBAAkB,EAAE,kBAAkB,GAAG,WAAW,CAAM;IAS1E;;;;;;;;;;;;;;;;;;OAkBG;IACY,YAAY,CACzB,OAAO,EAAE,IAAI,CAAC,mBAAmB,EAAE,kBAAkB,GAAG,WAAW,CAAC;IAStE;;;;;;;;;;;;;;OAcG;IACY,aAAa,CAC1B,OAAO,EAAE,IAAI,CAAC,oBAAoB,EAAE,kBAAkB,GAAG,WAAW,CAAC;CAQxE"}