@upstash/vector 1.0.7 → 1.0.8-canary

package/dist/index.d.mts

@@ -42,15 +42,23 @@ type RequesterConfig = {
     cache?: CacheSetting;
 };
 
-declare const ENDPOINTS: readonly ["upsert", "query", "delete", "fetch", "reset", "range", "info", "upsert-data", "query-data"];
-type EndpointVariants = (typeof ENDPOINTS)[number];
+type Vector<TMetadata = Dict> = {
+    id: string;
+    vector: number[];
+    metadata?: TMetadata;
+};
+type NAMESPACE = string;
+type Dict = Record<string, unknown>;
+
+declare const ENDPOINTS: readonly ["upsert", "query", "delete", "fetch", "reset", "range", "info", "upsert-data", "query-data", "list-namespaces", "delete-namespace"];
+type EndpointVariants = (typeof ENDPOINTS)[number] | `${(typeof ENDPOINTS)[number]}/${NAMESPACE}`;
 /**
  * TResult is the raw data returned from upstash, which may need to be transformed or parsed.
  */
 declare class Command<TResult> {
-    readonly payload: Record<string, unknown> | unknown[];
+    readonly payload: Dict | unknown[];
     readonly endpoint: EndpointVariants;
-    constructor(command: Record<string, unknown> | unknown[], endpoint: EndpointVariants);
+    constructor(command: Dict | unknown[], endpoint: EndpointVariants);
     /**
      * Execute the command using a client.
      */
@@ -60,17 +68,11 @@ declare class Command<TResult> {
 declare class DeleteCommand extends Command<{
     deleted: number;
 }> {
-    constructor(id: (number[] | string[]) | number | string);
+    constructor(id: (number[] | string[]) | number | string, options?: {
+        namespace?: string;
+    });
 }
 
-type Vector<TMetadata = Record<string, unknown>> = {
-    id: string;
-    vector: number[];
-    metadata?: TMetadata;
-};
-
-type FetchResult<TMetadata = Record<string, unknown>> = Vector<TMetadata> | null;
-
 type QueryCommandPayload = {
     topK: number;
     filter?: string;
@@ -83,43 +85,237 @@ type QueryCommandPayload = {
     data: string;
     vector?: never;
 });
-type QueryResult<TMetadata = Record<string, unknown>> = {
+type QueryResult<TMetadata = Dict> = {
     id: number | string;
     score: number;
     vector: number[];
     metadata?: TMetadata;
 };
+type QueryCommandOptions = {
+    namespace?: string;
+};
 declare class QueryCommand<TMetadata> extends Command<QueryResult<TMetadata>[]> {
-    constructor(payload: QueryCommandPayload);
+    constructor(payload: QueryCommandPayload, options?: QueryCommandOptions);
 }
 
+type FetchResult<TMetadata = Dict> = Vector<TMetadata> | null;
+
 type RangeCommandPayload = {
     cursor: number | string;
     limit: number;
     includeVectors?: boolean;
     includeMetadata?: boolean;
 };
-type RangeResult<TMetadata = Record<string, unknown>> = {
+type RangeCommandOptions = {
+    namespace?: string;
+};
+type RangeResult<TMetadata = Dict> = {
     nextCursor: string;
     vectors: Vector<TMetadata>[];
 };
 declare class RangeCommand<TMetadata> extends Command<RangeResult<TMetadata>> {
-    constructor(payload: RangeCommandPayload);
+    constructor(payload: RangeCommandPayload, options?: RangeCommandOptions);
 }
 
+type NamespaceTitle = string;
+type NamespaceInfo = {
+    vectorCount: number;
+    pendingVectorCount: number;
+};
 type InfoResult = {
     vectorCount: number;
     pendingVectorCount: number;
     indexSize: number;
     dimension: number;
     similarityFunction: "COSINE" | "EUCLIDEAN" | "DOT_PRODUCT";
+    namespaces: Record<NamespaceTitle, NamespaceInfo>;
 };
 
+declare class Namespace<TIndexMetadata extends Dict = Dict> {
+    protected client: Requester;
+    protected namespace: string;
+    /**
+     * Create a new index namespace client
+     *
+     * @example
+     * ```typescript
+     * const index = new Index({
+     *  url: "<UPSTASH_VECTOR_REST_URL>",
+     *  token: "<UPSTASH_VECTOR_REST_TOKEN>",
+     * });
+     *
+     * const namespace = index.namespace("ns");
+     * ```
+     */
+    constructor(client: Requester, namespace: string);
+    /**
+     * Queries an index namespace with specified parameters.
+     * This method creates and executes a query command on an index based on the provided arguments.
+     *
+     * @example
+     * ```js
+     * await index.namespace("ns").query({
+     *  topK: 3,
+     *  vector: [ 0.22, 0.66 ],
+     *  filter: "age >= 23 and (type = \'turtle\' OR type = \'cat\')"
+     * });
+     * ```
+     *
+     * @param {Object} args - The arguments for the query command.
+     * @param {number[]} args.vector - An array of numbers representing the feature vector for the query.
+     *                                This vector is utilized to find the most relevant items in the index.
+     * @param {number} args.topK - The desired number of top results to be returned, based on relevance or similarity to the query vector.
+     * @param {string} [args.filter] - An optional filter string to be used in the query. The filter string is used to narrow down the query results.
+     * @param {boolean} [args.includeVectors=false] - When set to true, includes the feature vectors of the returned items in the response.
+     * @param {boolean} [args.includeMetadata=false] - When set to true, includes additional metadata of the returned items in the response.
+     *
+     * @returns A promise that resolves with an array of query result objects when the request to query the index is completed.
+     */
+    upsert: <TMetadata extends Dict = TIndexMetadata>(args: ({
+        id: string | number;
+    } & ({
+        metadata: TMetadata extends infer U ? U : never;
+        data: string;
+        vector?: undefined;
+    } | {
+        metadata?: (TMetadata extends infer U ? U : never) | undefined;
+        data: string;
+        vector?: undefined;
+    })) | ({
+        id: string | number;
+    } & ({
+        metadata: TMetadata extends infer U ? U : never;
+        vector?: number[] | undefined;
+        data?: undefined;
+    } | {
+        metadata?: (TMetadata extends infer U ? U : never) | undefined;
+        vector: number[];
+        data?: undefined;
+    })) | ({
+        id: string | number;
+    } & ({
+        metadata: TMetadata extends infer U ? U : never;
+        data: string;
+        vector?: undefined;
+    } | {
+        metadata?: (TMetadata extends infer U ? U : never) | undefined;
+        data: string;
+        vector?: undefined;
+    }))[] | ({
+        id: string | number;
+    } & ({
+        metadata: TMetadata extends infer U ? U : never;
+        vector?: number[] | undefined;
+        data?: undefined;
+    } | {
+        metadata?: (TMetadata extends infer U ? U : never) | undefined;
+        vector: number[];
+        data?: undefined;
+    }))[]) => Promise<string>;
+    /**
+     * Upserts (Updates and Inserts) specific items into the index namespace.
+     * It's used for adding new items to the index namespace or updating existing ones.
+     *
+     * @example
+     * ```js
+     * const upsertArgs = {
+     *   id: '123',
+     *   vector: [0.42, 0.87, ...],
+     *   metadata: { property1: 'value1', property2: 'value2' }
+     * };
+     * const upsertResult = await index.namespace("ns").upsert(upsertArgs);
+     * console.log(upsertResult); // Outputs the result of the upsert operation
+     * ```
+     *
+     * @param {CommandArgs<typeof UpsertCommand>} args - The arguments for the upsert command.
+     * @param {number|string} args.id - The unique identifier for the item being upserted.
+     * @param {number[]} args.vector - The feature vector associated with the item.
+     * @param {Dict} [args.metadata] - Optional metadata to be associated with the item.
+     *
+     * @returns {string} A promise that resolves with the result of the upsert operation after the command is executed.
+     */
+    fetch: <TMetadata extends Dict = TIndexMetadata>(ids: number[] | string[], opts?: {
+        includeMetadata?: boolean | undefined;
+        includeVectors?: boolean | undefined;
+    } | undefined) => Promise<FetchResult<TMetadata>[]>;
+    /**
+     * It's used for retrieving specific items from the index namespace, optionally including
+     * their metadata and feature vectors.
+     *
+     * @example
+     * ```js
+     * const fetchIds = ['123', '456'];
+     * const fetchOptions = { includeMetadata: true, includeVectors: false };
+     * const fetchResults = await index.namespace("ns").fetch(fetchIds, fetchOptions);
+     * console.log(fetchResults); // Outputs the fetched items
+     * ```
+     *
+     * @param {...CommandArgs<typeof FetchCommand>} args - The arguments for the fetch command.
+     * @param {(number[]|string[])} args[0] - An array of IDs of the items to be fetched.
+     * @param {FetchCommandOptions} args[1] - Options for the fetch operation.
+     * @param {boolean} [args[1].includeMetadata=false] - Optionally include metadata of the fetched items.
+     * @param {boolean} [args[1].includeVectors=false] - Optionally include feature vectors of the fetched items.
+     *
+     * @returns {Promise<FetchReturnResponse<TMetadata>[]>} A promise that resolves with an array of fetched items or null if not found, after the command is executed.
+     */
+    query: <TMetadata extends Dict = TIndexMetadata>(args: CommandArgs<typeof QueryCommand>) => Promise<QueryResult<TMetadata>[]>;
+    /**
+     * Deletes a specific item or items from the index namespace by their ID(s).   *
+     *
+     * @example
+     * ```js
+     * await index.namespace("ns").delete('test-id')
+     * ```
+     *
+     * @param id - List of ids or single id
+     * @returns A promise that resolves when the request to delete the index is completed.
+     */
+    delete: (args: CommandArgs<typeof DeleteCommand>) => Promise<{
+        deleted: number;
+    }>;
+    /**
+     * Retrieves a range of items from the index.
+     *
+     * @example
+     * ```js
+     * const rangeArgs = {
+     *   cursor: 0,
+     *   limit: 10,
+     *   includeVectors: true,
+     *   includeMetadata: false
+     * };
+     * const rangeResults = await index.namespace("ns").range(rangeArgs);
+     * console.log(rangeResults); // Outputs the result of the range operation
+     * ```
+     *
+     * @param {CommandArgs<typeof RangeCommand>} args - The arguments for the range command.
+     * @param {number|string} args.cursor - The starting point (cursor) for the range query.
+     * @param {number} args.limit - The maximum number of items to return in this range.
+     * @param {boolean} [args.includeVectors=false] - Optionally include the feature vectors of the items in the response.
+     * @param {boolean} [args.includeMetadata=false] - Optionally include additional metadata of the items in the response.
+     *
+     * @returns {Promise<RangeReturnResponse<TMetadata>>} A promise that resolves with the response containing the next cursor and an array of vectors, after the command is executed.
+     */
+    range: <TMetadata extends Dict = TIndexMetadata>(args: CommandArgs<typeof RangeCommand>) => Promise<RangeResult<TMetadata>>;
+    /**
+     * It's used for wiping all the vectors in a index namespace.
+     *
+     * @example
+     * ```js
+     * await index.namespace("ns").reset();
+     * console.log('Index namespace has been reset');
+     * ```
+     *
+     * @returns {Promise<string>} A promise that resolves with the result of the reset operation after the command is executed.
+     */
+    reset: () => Promise<string>;
+}
+
 type CommandArgs<TCommand extends new (_args: any) => any> = ConstructorParameters<TCommand>[0];
 /**
  * Serverless vector client for upstash vector db.
  */
-declare class Index$1<TIndexMetadata extends Record<string, unknown> = Record<string, unknown>> {
+declare class Index$1<TIndexMetadata extends Dict = Dict> {
     protected client: Requester;
     /**
      * Create a new vector db client
@@ -133,6 +329,7 @@ declare class Index$1<TIndexMetadata extends Record<string, unknown> = Record<st
      * ```
      */
     constructor(client: Requester);
+    namespace: (namespace: string) => Namespace<TIndexMetadata>;
     /**
      * Deletes a specific item or items from the index by their ID(s).   *
      *
@@ -144,7 +341,9 @@ declare class Index$1<TIndexMetadata extends Record<string, unknown> = Record<st
      * @param id - List of ids or single id
      * @returns A promise that resolves when the request to delete the index is completed.
      */
-    delete: (args: CommandArgs<typeof DeleteCommand>) => Promise<{
+    delete: (args: CommandArgs<typeof DeleteCommand>, options?: {
+        namespace?: string;
+    }) => Promise<{
         deleted: number;
     }>;
     /**
@@ -170,7 +369,9 @@ declare class Index$1<TIndexMetadata extends Record<string, unknown> = Record<st
      *
      * @returns A promise that resolves with an array of query result objects when the request to query the index is completed.
      */
-    query: <TMetadata extends Record<string, unknown> = TIndexMetadata>(args: CommandArgs<typeof QueryCommand>) => Promise<QueryResult<TMetadata>[]>;
+    query: <TMetadata extends Dict = TIndexMetadata>(args: CommandArgs<typeof QueryCommand>, options?: {
+        namespace?: string;
+    }) => Promise<QueryResult<TMetadata>[]>;
     /**
      * Upserts (Updates and Inserts) specific items into the index.
      * It's used for adding new items to the index or updating existing ones.
@@ -193,23 +394,49 @@ declare class Index$1<TIndexMetadata extends Record<string, unknown> = Record<st
      *
      * @returns {string} A promise that resolves with the result of the upsert operation after the command is executed.
      */
-    upsert: <TMetadata extends Record<string, unknown> = TIndexMetadata>(args: {
-        id: string | number;
-        vector: number[];
-        metadata?: (TMetadata extends infer U ? U : never) | undefined;
-    } | {
+    upsert: <TMetadata extends Dict = TIndexMetadata>(args: ({
         id: string | number;
+    } & ({
+        metadata: TMetadata extends infer U ? U : never;
         data: string;
+        vector?: undefined;
+    } | {
         metadata?: (TMetadata extends infer U ? U : never) | undefined;
-    } | ({
+        data: string;
+        vector?: undefined;
+    })) | ({
         id: string | number;
-        vector: number[];
+    } & ({
+        metadata: TMetadata extends infer U ? U : never;
+        vector?: number[] | undefined;
+        data?: undefined;
+    } | {
         metadata?: (TMetadata extends infer U ? U : never) | undefined;
-    }[] | {
+        vector: number[];
+        data?: undefined;
+    })) | ({
         id: string | number;
+    } & ({
+        metadata: TMetadata extends infer U ? U : never;
+        data: string;
+        vector?: undefined;
+    } | {
+        metadata?: (TMetadata extends infer U ? U : never) | undefined;
         data: string;
+        vector?: undefined;
+    }))[] | ({
+        id: string | number;
+    } & ({
+        metadata: TMetadata extends infer U ? U : never;
+        vector?: number[] | undefined;
+        data?: undefined;
+    } | {
         metadata?: (TMetadata extends infer U ? U : never) | undefined;
-    }[])) => Promise<string>;
+        vector: number[];
+        data?: undefined;
+    }))[], options?: {
+        namespace?: string;
+    }) => Promise<string>;
     /**
      * It's used for retrieving specific items from the index, optionally including
      * their metadata and feature vectors.
@@ -230,7 +457,7 @@ declare class Index$1<TIndexMetadata extends Record<string, unknown> = Record<st
      *
      * @returns {Promise<FetchReturnResponse<TMetadata>[]>} A promise that resolves with an array of fetched items or null if not found, after the command is executed.
      */
-    fetch: <TMetadata extends Record<string, unknown> = TIndexMetadata>(ids: number[] | string[], opts?: {
+    fetch: <TMetadata extends Dict = TIndexMetadata>(ids: number[] | string[], opts?: {
         includeMetadata?: boolean | undefined;
         includeVectors?: boolean | undefined;
     } | undefined) => Promise<FetchResult<TMetadata>[]>;
@@ -245,7 +472,9 @@ declare class Index$1<TIndexMetadata extends Record<string, unknown> = Record<st
      *
      * @returns {Promise<string>} A promise that resolves with the result of the reset operation after the command is executed.
      */
-    reset: () => Promise<string>;
+    reset: (options?: {
+        namespace?: string;
+    }) => Promise<string>;
     /**
      * Retrieves a range of items from the index.
      *
@@ -269,7 +498,9 @@ declare class Index$1<TIndexMetadata extends Record<string, unknown> = Record<st
      *
      * @returns {Promise<RangeReturnResponse<TMetadata>>} A promise that resolves with the response containing the next cursor and an array of vectors, after the command is executed.
      */
-    range: <TMetadata extends Record<string, unknown> = TIndexMetadata>(args: CommandArgs<typeof RangeCommand>) => Promise<RangeResult<TMetadata>>;
+    range: <TMetadata extends Dict = TIndexMetadata>(args: CommandArgs<typeof RangeCommand>, options?: {
+        namespace?: string;
+    }) => Promise<RangeResult<TMetadata>>;
     /**
      * Retrieves info from the index.
      *
@@ -282,6 +513,31 @@ declare class Index$1<TIndexMetadata extends Record<string, unknown> = Record<st
      * @returns {Promise<InfoResult>} A promise that resolves with the response containing the vectorCount, pendingVectorCount, indexSize, dimension count and similarity algorithm after the command is executed.
      */
     info: () => Promise<InfoResult>;
+    /**
+     * List all namespaces in the vector database.
+     *
+     * @example
+     * ```js
+     * const namespaces = await index.listNamespaces();
+     * console.log(namespaces); // Outputs the list of namespaces
+     * ```
+     *
+     * @returns {Promise<string[]>} A promise that resolves with an array of namespaces after the command is executed.
+     */
+    listNamespaces: () => Promise<string[]>;
+    /**
+     * Deletes a namespace from the vector database.
+     *
+     * @example
+     * ```js
+     * await index.deleteNamespace('namespace');
+     * console.log('Namespace has been deleted');
+     * ```
+     *
+     * @param {string} namespace - The name of the namespace to be deleted.
+     * @returns {Promise<string>} A promise that resolves with the result of the delete operation after the command is executed.
+     */
+    deleteNamespace: (namespace: string) => Promise<string>;
 }
 
 /**
@@ -306,7 +562,7 @@ type IndexConfig = {
 /**
  * Serverless vector client for upstash.
  */
-declare class Index<TIndexMetadata extends Record<string, unknown> = Record<string, unknown>> extends Index$1<TIndexMetadata> {
+declare class Index<TIndexMetadata extends Dict = Dict> extends Index$1<TIndexMetadata> {
     /**
      * Create a new vector client by providing the url and token
      *

package/dist/index.d.ts

@@ -42,15 +42,23 @@ type RequesterConfig = {
     cache?: CacheSetting;
 };
 
-declare const ENDPOINTS: readonly ["upsert", "query", "delete", "fetch", "reset", "range", "info", "upsert-data", "query-data"];
-type EndpointVariants = (typeof ENDPOINTS)[number];
+type Vector<TMetadata = Dict> = {
+    id: string;
+    vector: number[];
+    metadata?: TMetadata;
+};
+type NAMESPACE = string;
+type Dict = Record<string, unknown>;
+
+declare const ENDPOINTS: readonly ["upsert", "query", "delete", "fetch", "reset", "range", "info", "upsert-data", "query-data", "list-namespaces", "delete-namespace"];
+type EndpointVariants = (typeof ENDPOINTS)[number] | `${(typeof ENDPOINTS)[number]}/${NAMESPACE}`;
 /**
  * TResult is the raw data returned from upstash, which may need to be transformed or parsed.
  */
 declare class Command<TResult> {
-    readonly payload: Record<string, unknown> | unknown[];
+    readonly payload: Dict | unknown[];
     readonly endpoint: EndpointVariants;
-    constructor(command: Record<string, unknown> | unknown[], endpoint: EndpointVariants);
+    constructor(command: Dict | unknown[], endpoint: EndpointVariants);
     /**
      * Execute the command using a client.
      */
@@ -60,17 +68,11 @@ declare class Command<TResult> {
 declare class DeleteCommand extends Command<{
     deleted: number;
 }> {
-    constructor(id: (number[] | string[]) | number | string);
+    constructor(id: (number[] | string[]) | number | string, options?: {
+        namespace?: string;
+    });
 }
 
-type Vector<TMetadata = Record<string, unknown>> = {
-    id: string;
-    vector: number[];
-    metadata?: TMetadata;
-};
-
-type FetchResult<TMetadata = Record<string, unknown>> = Vector<TMetadata> | null;
-
 type QueryCommandPayload = {
     topK: number;
     filter?: string;
@@ -83,43 +85,237 @@ type QueryCommandPayload = {
     data: string;
     vector?: never;
 });
-type QueryResult<TMetadata = Record<string, unknown>> = {
+type QueryResult<TMetadata = Dict> = {
     id: number | string;
     score: number;
     vector: number[];
     metadata?: TMetadata;
 };
+type QueryCommandOptions = {
+    namespace?: string;
+};
 declare class QueryCommand<TMetadata> extends Command<QueryResult<TMetadata>[]> {
-    constructor(payload: QueryCommandPayload);
+    constructor(payload: QueryCommandPayload, options?: QueryCommandOptions);
 }
 
+type FetchResult<TMetadata = Dict> = Vector<TMetadata> | null;
+
 type RangeCommandPayload = {
     cursor: number | string;
     limit: number;
     includeVectors?: boolean;
     includeMetadata?: boolean;
 };
-type RangeResult<TMetadata = Record<string, unknown>> = {
+type RangeCommandOptions = {
+    namespace?: string;
+};
+type RangeResult<TMetadata = Dict> = {
     nextCursor: string;
     vectors: Vector<TMetadata>[];
 };
 declare class RangeCommand<TMetadata> extends Command<RangeResult<TMetadata>> {
-    constructor(payload: RangeCommandPayload);
+    constructor(payload: RangeCommandPayload, options?: RangeCommandOptions);
 }
 
+type NamespaceTitle = string;
+type NamespaceInfo = {
+    vectorCount: number;
+    pendingVectorCount: number;
+};
 type InfoResult = {
     vectorCount: number;
     pendingVectorCount: number;
     indexSize: number;
     dimension: number;
     similarityFunction: "COSINE" | "EUCLIDEAN" | "DOT_PRODUCT";
+    namespaces: Record<NamespaceTitle, NamespaceInfo>;
 };
 
+declare class Namespace<TIndexMetadata extends Dict = Dict> {
+    protected client: Requester;
+    protected namespace: string;
+    /**
+     * Create a new index namespace client
+     *
+     * @example
+     * ```typescript
+     * const index = new Index({
+     *  url: "<UPSTASH_VECTOR_REST_URL>",
+     *  token: "<UPSTASH_VECTOR_REST_TOKEN>",
+     * });
+     *
+     * const namespace = index.namespace("ns");
+     * ```
+     */
+    constructor(client: Requester, namespace: string);
+    /**
+     * Queries an index namespace with specified parameters.
+     * This method creates and executes a query command on an index based on the provided arguments.
+     *
+     * @example
+     * ```js
+     * await index.namespace("ns").query({
+     *  topK: 3,
+     *  vector: [ 0.22, 0.66 ],
+     *  filter: "age >= 23 and (type = \'turtle\' OR type = \'cat\')"
+     * });
+     * ```
+     *
+     * @param {Object} args - The arguments for the query command.
+     * @param {number[]} args.vector - An array of numbers representing the feature vector for the query.
+     *                                This vector is utilized to find the most relevant items in the index.
+     * @param {number} args.topK - The desired number of top results to be returned, based on relevance or similarity to the query vector.
+     * @param {string} [args.filter] - An optional filter string to be used in the query. The filter string is used to narrow down the query results.
+     * @param {boolean} [args.includeVectors=false] - When set to true, includes the feature vectors of the returned items in the response.
+     * @param {boolean} [args.includeMetadata=false] - When set to true, includes additional metadata of the returned items in the response.
+     *
+     * @returns A promise that resolves with an array of query result objects when the request to query the index is completed.
+     */
+    upsert: <TMetadata extends Dict = TIndexMetadata>(args: ({
+        id: string | number;
+    } & ({
+        metadata: TMetadata extends infer U ? U : never;
+        data: string;
+        vector?: undefined;
+    } | {
+        metadata?: (TMetadata extends infer U ? U : never) | undefined;
+        data: string;
+        vector?: undefined;
+    })) | ({
+        id: string | number;
+    } & ({
+        metadata: TMetadata extends infer U ? U : never;
+        vector?: number[] | undefined;
+        data?: undefined;
+    } | {
+        metadata?: (TMetadata extends infer U ? U : never) | undefined;
+        vector: number[];
+        data?: undefined;
+    })) | ({
+        id: string | number;
+    } & ({
+        metadata: TMetadata extends infer U ? U : never;
+        data: string;
+        vector?: undefined;
+    } | {
+        metadata?: (TMetadata extends infer U ? U : never) | undefined;
+        data: string;
+        vector?: undefined;
+    }))[] | ({
+        id: string | number;
+    } & ({
+        metadata: TMetadata extends infer U ? U : never;
+        vector?: number[] | undefined;
+        data?: undefined;
+    } | {
+        metadata?: (TMetadata extends infer U ? U : never) | undefined;
+        vector: number[];
+        data?: undefined;
+    }))[]) => Promise<string>;
+    /**
+     * Upserts (Updates and Inserts) specific items into the index namespace.
+     * It's used for adding new items to the index namespace or updating existing ones.
+     *
+     * @example
+     * ```js
+     * const upsertArgs = {
+     *   id: '123',
+     *   vector: [0.42, 0.87, ...],
+     *   metadata: { property1: 'value1', property2: 'value2' }
+     * };
+     * const upsertResult = await index.namespace("ns").upsert(upsertArgs);
+     * console.log(upsertResult); // Outputs the result of the upsert operation
+     * ```
+     *
+     * @param {CommandArgs<typeof UpsertCommand>} args - The arguments for the upsert command.
+     * @param {number|string} args.id - The unique identifier for the item being upserted.
+     * @param {number[]} args.vector - The feature vector associated with the item.
+     * @param {Dict} [args.metadata] - Optional metadata to be associated with the item.
+     *
+     * @returns {string} A promise that resolves with the result of the upsert operation after the command is executed.
+     */
+    fetch: <TMetadata extends Dict = TIndexMetadata>(ids: number[] | string[], opts?: {
+        includeMetadata?: boolean | undefined;
+        includeVectors?: boolean | undefined;
+    } | undefined) => Promise<FetchResult<TMetadata>[]>;
+    /**
+     * It's used for retrieving specific items from the index namespace, optionally including
+     * their metadata and feature vectors.
+     *
+     * @example
+     * ```js
+     * const fetchIds = ['123', '456'];
+     * const fetchOptions = { includeMetadata: true, includeVectors: false };
+     * const fetchResults = await index.namespace("ns").fetch(fetchIds, fetchOptions);
+     * console.log(fetchResults); // Outputs the fetched items
+     * ```
+     *
+     * @param {...CommandArgs<typeof FetchCommand>} args - The arguments for the fetch command.
+     * @param {(number[]|string[])} args[0] - An array of IDs of the items to be fetched.
+     * @param {FetchCommandOptions} args[1] - Options for the fetch operation.
+     * @param {boolean} [args[1].includeMetadata=false] - Optionally include metadata of the fetched items.
+     * @param {boolean} [args[1].includeVectors=false] - Optionally include feature vectors of the fetched items.
+     *
+     * @returns {Promise<FetchReturnResponse<TMetadata>[]>} A promise that resolves with an array of fetched items or null if not found, after the command is executed.
+     */
+    query: <TMetadata extends Dict = TIndexMetadata>(args: CommandArgs<typeof QueryCommand>) => Promise<QueryResult<TMetadata>[]>;
+    /**
+     * Deletes a specific item or items from the index namespace by their ID(s).   *
+     *
+     * @example
+     * ```js
+     * await index.namespace("ns").delete('test-id')
+     * ```
+     *
+     * @param id - List of ids or single id
+     * @returns A promise that resolves when the request to delete the index is completed.
+     */
+    delete: (args: CommandArgs<typeof DeleteCommand>) => Promise<{
+        deleted: number;
+    }>;
+    /**
+     * Retrieves a range of items from the index.
+     *
+     * @example
+     * ```js
+     * const rangeArgs = {
+     *   cursor: 0,
+     *   limit: 10,
+     *   includeVectors: true,
+     *   includeMetadata: false
+     * };
+     * const rangeResults = await index.namespace("ns").range(rangeArgs);
+     * console.log(rangeResults); // Outputs the result of the range operation
+     * ```
+     *
+     * @param {CommandArgs<typeof RangeCommand>} args - The arguments for the range command.
+     * @param {number|string} args.cursor - The starting point (cursor) for the range query.
+     * @param {number} args.limit - The maximum number of items to return in this range.
+     * @param {boolean} [args.includeVectors=false] - Optionally include the feature vectors of the items in the response.
+     * @param {boolean} [args.includeMetadata=false] - Optionally include additional metadata of the items in the response.
+     *
+     * @returns {Promise<RangeReturnResponse<TMetadata>>} A promise that resolves with the response containing the next cursor and an array of vectors, after the command is executed.
+     */
+    range: <TMetadata extends Dict = TIndexMetadata>(args: CommandArgs<typeof RangeCommand>) => Promise<RangeResult<TMetadata>>;
+    /**
+     * It's used for wiping all the vectors in a index namespace.
+     *
+     * @example
+     * ```js
+     * await index.namespace("ns").reset();
+     * console.log('Index namespace has been reset');
+     * ```
+     *
+     * @returns {Promise<string>} A promise that resolves with the result of the reset operation after the command is executed.
+     */
+    reset: () => Promise<string>;
+}
+
 type CommandArgs<TCommand extends new (_args: any) => any> = ConstructorParameters<TCommand>[0];
 /**
  * Serverless vector client for upstash vector db.
  */
-declare class Index$1<TIndexMetadata extends Record<string, unknown> = Record<string, unknown>> {
+declare class Index$1<TIndexMetadata extends Dict = Dict> {
     protected client: Requester;
     /**
      * Create a new vector db client
@@ -133,6 +329,7 @@ declare class Index$1<TIndexMetadata extends Record<string, unknown> = Record<st
      * ```
      */
     constructor(client: Requester);
+    namespace: (namespace: string) => Namespace<TIndexMetadata>;
     /**
      * Deletes a specific item or items from the index by their ID(s).   *
      *
@@ -144,7 +341,9 @@ declare class Index$1<TIndexMetadata extends Record<string, unknown> = Record<st
      * @param id - List of ids or single id
      * @returns A promise that resolves when the request to delete the index is completed.
      */
-    delete: (args: CommandArgs<typeof DeleteCommand>) => Promise<{
+    delete: (args: CommandArgs<typeof DeleteCommand>, options?: {
+        namespace?: string;
+    }) => Promise<{
         deleted: number;
     }>;
     /**
@@ -170,7 +369,9 @@ declare class Index$1<TIndexMetadata extends Record<string, unknown> = Record<st
      *
      * @returns A promise that resolves with an array of query result objects when the request to query the index is completed.
      */
-    query: <TMetadata extends Record<string, unknown> = TIndexMetadata>(args: CommandArgs<typeof QueryCommand>) => Promise<QueryResult<TMetadata>[]>;
+    query: <TMetadata extends Dict = TIndexMetadata>(args: CommandArgs<typeof QueryCommand>, options?: {
+        namespace?: string;
+    }) => Promise<QueryResult<TMetadata>[]>;
     /**
      * Upserts (Updates and Inserts) specific items into the index.
      * It's used for adding new items to the index or updating existing ones.
@@ -193,23 +394,49 @@ declare class Index$1<TIndexMetadata extends Record<string, unknown> = Record<st
      *
      * @returns {string} A promise that resolves with the result of the upsert operation after the command is executed.
      */
-    upsert: <TMetadata extends Record<string, unknown> = TIndexMetadata>(args: {
-        id: string | number;
-        vector: number[];
-        metadata?: (TMetadata extends infer U ? U : never) | undefined;
-    } | {
+    upsert: <TMetadata extends Dict = TIndexMetadata>(args: ({
         id: string | number;
+    } & ({
+        metadata: TMetadata extends infer U ? U : never;
         data: string;
+        vector?: undefined;
+    } | {
         metadata?: (TMetadata extends infer U ? U : never) | undefined;
-    } | ({
+        data: string;
+        vector?: undefined;
+    })) | ({
         id: string | number;
-        vector: number[];
+    } & ({
+        metadata: TMetadata extends infer U ? U : never;
+        vector?: number[] | undefined;
+        data?: undefined;
+    } | {
         metadata?: (TMetadata extends infer U ? U : never) | undefined;
-    }[] | {
+        vector: number[];
+        data?: undefined;
+    })) | ({
         id: string | number;
+    } & ({
+        metadata: TMetadata extends infer U ? U : never;
+        data: string;
+        vector?: undefined;
+    } | {
+        metadata?: (TMetadata extends infer U ? U : never) | undefined;
         data: string;
+        vector?: undefined;
+    }))[] | ({
+        id: string | number;
+    } & ({
+        metadata: TMetadata extends infer U ? U : never;
+        vector?: number[] | undefined;
+        data?: undefined;
+    } | {
         metadata?: (TMetadata extends infer U ? U : never) | undefined;
-    }[])) => Promise<string>;
+        vector: number[];
+        data?: undefined;
+    }))[], options?: {
+        namespace?: string;
+    }) => Promise<string>;
     /**
      * It's used for retrieving specific items from the index, optionally including
      * their metadata and feature vectors.
@@ -230,7 +457,7 @@ declare class Index$1<TIndexMetadata extends Record<string, unknown> = Record<st
      *
      * @returns {Promise<FetchReturnResponse<TMetadata>[]>} A promise that resolves with an array of fetched items or null if not found, after the command is executed.
      */
-    fetch: <TMetadata extends Record<string, unknown> = TIndexMetadata>(ids: number[] | string[], opts?: {
+    fetch: <TMetadata extends Dict = TIndexMetadata>(ids: number[] | string[], opts?: {
         includeMetadata?: boolean | undefined;
         includeVectors?: boolean | undefined;
     } | undefined) => Promise<FetchResult<TMetadata>[]>;
@@ -245,7 +472,9 @@ declare class Index$1<TIndexMetadata extends Record<string, unknown> = Record<st
      *
      * @returns {Promise<string>} A promise that resolves with the result of the reset operation after the command is executed.
      */
-    reset: () => Promise<string>;
+    reset: (options?: {
+        namespace?: string;
+    }) => Promise<string>;
     /**
      * Retrieves a range of items from the index.
      *
@@ -269,7 +498,9 @@ declare class Index$1<TIndexMetadata extends Record<string, unknown> = Record<st
      *
      * @returns {Promise<RangeReturnResponse<TMetadata>>} A promise that resolves with the response containing the next cursor and an array of vectors, after the command is executed.
      */
-    range: <TMetadata extends Record<string, unknown> = TIndexMetadata>(args: CommandArgs<typeof RangeCommand>) => Promise<RangeResult<TMetadata>>;
+    range: <TMetadata extends Dict = TIndexMetadata>(args: CommandArgs<typeof RangeCommand>, options?: {
+        namespace?: string;
+    }) => Promise<RangeResult<TMetadata>>;
     /**
      * Retrieves info from the index.
      *
@@ -282,6 +513,31 @@ declare class Index$1<TIndexMetadata extends Record<string, unknown> = Record<st
      * @returns {Promise<InfoResult>} A promise that resolves with the response containing the vectorCount, pendingVectorCount, indexSize, dimension count and similarity algorithm after the command is executed.
      */
     info: () => Promise<InfoResult>;
+    /**
+     * List all namespaces in the vector database.
+     *
+     * @example
+     * ```js
+     * const namespaces = await index.listNamespaces();
+     * console.log(namespaces); // Outputs the list of namespaces
+     * ```
+     *
+     * @returns {Promise<string[]>} A promise that resolves with an array of namespaces after the command is executed.
+     */
+    listNamespaces: () => Promise<string[]>;
+    /**
+     * Deletes a namespace from the vector database.
+     *
+     * @example
+     * ```js
+     * await index.deleteNamespace('namespace');
+     * console.log('Namespace has been deleted');
+     * ```
+     *
+     * @param {string} namespace - The name of the namespace to be deleted.
+     * @returns {Promise<string>} A promise that resolves with the result of the delete operation after the command is executed.
+     */
+    deleteNamespace: (namespace: string) => Promise<string>;
 }
 
 /**
@@ -306,7 +562,7 @@ type IndexConfig = {
 /**
  * Serverless vector client for upstash.
  */
-declare class Index<TIndexMetadata extends Record<string, unknown> = Record<string, unknown>> extends Index$1<TIndexMetadata> {
+declare class Index<TIndexMetadata extends Dict = Dict> extends Index$1<TIndexMetadata> {
     /**
      * Create a new vector client by providing the url and token
      *

package/dist/index.js

@@ -1 +1 @@
-"use strict";var x=Object.defineProperty;var w=Object.getOwnPropertyDescriptor;var E=Object.getOwnPropertyNames;var M=Object.prototype.hasOwnProperty;var S=(a,e)=>{for(var t in e)x(a,t,{get:e[t],enumerable:!0})},U=(a,e,t,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let n of E(e))!M.call(a,n)&&n!==t&&x(a,n,{get:()=>e[n],enumerable:!(r=w(e,n))||r.enumerable});return a};var _=a=>U(x({},"__esModule",{value:!0}),a);var P={};S(P,{Index:()=>g});module.exports=_(P);var s=class extends Error{constructor(e){super(e),this.name="UpstashError"}};var i=class{baseUrl;headers;options;retry;constructor(e){this.options={cache:e.cache,signal:e.signal},this.baseUrl=e.baseUrl.replace(/\/$/,""),this.headers={"Content-Type":"application/json",...e.headers},typeof e?.retry=="boolean"&&e?.retry===!1?this.retry={attempts:1,backoff:()=>0}:this.retry={attempts:e?.retry?.retries??5,backoff:e?.retry?.backoff??(t=>Math.exp(t)*50)}}async request(e){let t={cache:this.options.cache,method:"POST",headers:this.headers,body:JSON.stringify(e.body),keepalive:!0,signal:this.options.signal},r=null,n=null;for(let y=0;y<=this.retry.attempts;y++)try{r=await fetch([this.baseUrl,...e.path??[]].join("/"),t);break}catch(b){if(this.options.signal?.aborted){let R=new Blob([JSON.stringify({result:this.options.signal.reason??"Aborted"})]),C={status:200,statusText:this.options.signal.reason??"Aborted"};r=new Response(R,C);break}n=b,await new Promise(R=>setTimeout(R,this.retry.backoff(y)))}if(!r)throw n??new Error("Exhausted all retries");let T=await r.json();if(!r.ok)throw new s(`${T.error}`);return{result:T.result,error:T.error}}};var o=class{payload;endpoint;constructor(e,t){this.payload=e,this.endpoint=t}async exec(e){let{result:t,error:r}=await e.request({body:this.payload,path:[this.endpoint]});if(r)throw new s(r);if(typeof t>"u")throw new Error("Request did not return a result");return t}};var d=class extends o{constructor(e){let t=[];Array.isArray(e)?t.push(...e):t.push(e),super(t,"delete")}};var c=class extends o{constructor(e){let t="query";"data"in e&&(t="query-data"),super(e,t)}};var p=class extends o{constructor(e){let t="upsert";if(Array.isArray(e)){if(e.some(n=>"data"in n&&n.data)){t="upsert-data";for(let n of e)!("metadata"in n)&&"data"in n&&(n.metadata={data:n.data})}}else"data"in e&&(t="upsert-data","metadata"in e||(e.metadata={data:e.data}));super(e,t)}};var u=class extends o{constructor([e,t]){super({ids:e,...t},"fetch")}};var l=class extends o{constructor(e){super(e,"range")}};var m=class extends o{constructor(){super([],"reset")}};var f=class extends o{constructor(){super([],"info")}};var h=class{client;constructor(e){this.client=e}delete=e=>new d(e).exec(this.client);query=e=>new c(e).exec(this.client);upsert=e=>new p(e).exec(this.client);fetch=(...e)=>new u(e).exec(this.client);reset=()=>new m().exec(this.client);range=e=>new l(e).exec(this.client);info=()=>new f().exec(this.client)};var g=class a extends h{constructor(e){if(typeof e<"u"&&"request"in e){super(e);return}let t=e?.token??process.env.NEXT_PUBLIC_UPSTASH_VECTOR_REST_TOKEN??process.env.UPSTASH_VECTOR_REST_TOKEN,r=e?.url??process.env.NEXT_PUBLIC_UPSTASH_VECTOR_REST_URL??process.env.UPSTASH_VECTOR_REST_URL;if(!t)throw new Error("UPSTASH_VECTOR_REST_TOKEN is missing!");if(!r)throw new Error("UPSTASH_VECTOR_REST_URL is missing!");(r.startsWith(" ")||r.endsWith(" ")||/\r|\n/.test(r))&&console.warn("The vector url contains whitespace or newline, which can cause errors!"),(t.startsWith(" ")||t.endsWith(" ")||/\r|\n/.test(t))&&console.warn("The vector token contains whitespace or newline, which can cause errors!");let n=new i({baseUrl:r,retry:e?.retry,headers:{authorization:`Bearer ${t}`},cache:e?.cache===!1?void 0:e?.cache||"no-store",signal:e?.signal});super(n)}static fromEnv(e){let t=process?.env.UPSTASH_VECTOR_REST_URL;if(!t)throw new Error("Unable to find environment variable: `UPSTASH_VECTOR_REST_URL`");let r=process?.env.UPSTASH_VECTOR_REST_TOKEN;if(!r)throw new Error("Unable to find environment variable: `UPSTASH_VECTOR_REST_TOKEN`");return new a({...e,url:t,token:r})}};0&&(module.exports={Index});
+"use strict";var R=Object.defineProperty;var S=Object.getOwnPropertyDescriptor;var P=Object.getOwnPropertyNames;var w=Object.prototype.hasOwnProperty;var N=(n,e)=>{for(var t in e)R(n,t,{get:e[t],enumerable:!0})},U=(n,e,t,a)=>{if(e&&typeof e=="object"||typeof e=="function")for(let s of P(e))!w.call(n,s)&&s!==t&&R(n,s,{get:()=>e[s],enumerable:!(a=S(e,s))||a.enumerable});return n};var D=n=>U(R({},"__esModule",{value:!0}),n);var I={};N(I,{Index:()=>M});module.exports=D(I);var i=class extends Error{constructor(e){super(e),this.name="UpstashError"}};var f=class{baseUrl;headers;options;retry;constructor(e){this.options={cache:e.cache,signal:e.signal},this.baseUrl=e.baseUrl.replace(/\/$/,""),this.headers={"Content-Type":"application/json",...e.headers},typeof e?.retry=="boolean"&&e?.retry===!1?this.retry={attempts:1,backoff:()=>0}:this.retry={attempts:e?.retry?.retries??5,backoff:e?.retry?.backoff??(t=>Math.exp(t)*50)}}async request(e){let t={cache:this.options.cache,method:"POST",headers:this.headers,body:JSON.stringify(e.body),keepalive:!0,signal:this.options.signal},a=null,s=null;for(let x=0;x<=this.retry.attempts;x++)try{a=await fetch([this.baseUrl,...e.path??[]].join("/"),t);break}catch(b){if(this.options.signal?.aborted){let g=new Blob([JSON.stringify({result:this.options.signal.reason??"Aborted"})]),A={status:200,statusText:this.options.signal.reason??"Aborted"};a=new Response(g,A);break}s=b,await new Promise(g=>setTimeout(g,this.retry.backoff(x)))}if(!a)throw s??new Error("Exhausted all retries");let o=await a.json();if(!a.ok)throw new i(`${o.error}`);return{result:o.result,error:o.error}}};var r=class{payload;endpoint;constructor(e,t){this.payload=e,this.endpoint=t}async exec(e){let{result:t,error:a}=await e.request({body:this.payload,path:[this.endpoint]});if(a)throw new i(a);if(typeof t>"u")throw new Error("Request did not return a result");return t}};var p=class extends r{constructor(e,t){let a="delete";t?.namespace&&(a=`${a}/${t.namespace}`);let s=[];Array.isArray(e)?s.push(...e):s.push(e),super(s,a)}};var d=class extends r{constructor(e,t){let a="query";"data"in e&&(a="query-data"),t?.namespace&&(a=`${a}/${t.namespace}`),super(e,a)}};var m=class extends r{constructor(e,t){let a="upsert";if(Array.isArray(e)){if(e.some(o=>"data"in o&&o.data)){a="upsert-data";for(let o of e)!("metadata"in o)&&"data"in o&&(o.metadata={data:o.data})}}else"data"in e&&(a="upsert-data","metadata"in e||(e.metadata={data:e.data}));t?.namespace&&(a=`${a}/${t.namespace}`),super(e,a)}};var c=class extends r{constructor([e,t],a){let s="fetch";a?.namespace&&(s=`${s}/${a.namespace}`),super({ids:e,...t},s)}};var l=class extends r{constructor(e,t){let a="range";t?.namespace&&(a=`${a}/${t.namespace}`),super(e,a)}};var u=class extends r{constructor(e){let t="reset";e?.namespace&&(t=`${t}/${e.namespace}`),super([],t)}};var y=class extends r{constructor(){super([],"info")}};var h=class{client;namespace;constructor(e,t){this.client=e,this.namespace=t}upsert=e=>new m(e,{namespace:this.namespace}).exec(this.client);fetch=(...e)=>new c(e,{namespace:this.namespace}).exec(this.client);query=e=>new d(e,{namespace:this.namespace}).exec(this.client);delete=e=>new p(e,{namespace:this.namespace}).exec(this.client);range=e=>new l(e,{namespace:this.namespace}).exec(this.client);reset=()=>new u({namespace:this.namespace}).exec(this.client)};var T=class extends r{constructor(){super([],"list-namespaces")}};var C=class extends r{constructor(e){let t=`delete-namespace/${e}`;super([],t)}};var E=class{client;constructor(e){this.client=e}namespace=e=>new h(this.client,e);delete=(e,t)=>new p(e,t).exec(this.client);query=(e,t)=>new d(e,t).exec(this.client);upsert=(e,t)=>new m(e,t).exec(this.client);fetch=(...e)=>new c(e).exec(this.client);reset=e=>new u(e).exec(this.client);range=(e,t)=>new l(e,t).exec(this.client);info=()=>new y().exec(this.client);listNamespaces=()=>new T().exec(this.client);deleteNamespace=e=>new C(e).exec(this.client)};var M=class n extends E{constructor(e){if(typeof e<"u"&&"request"in e){super(e);return}let t=e?.token??process.env.NEXT_PUBLIC_UPSTASH_VECTOR_REST_TOKEN??process.env.UPSTASH_VECTOR_REST_TOKEN,a=e?.url??process.env.NEXT_PUBLIC_UPSTASH_VECTOR_REST_URL??process.env.UPSTASH_VECTOR_REST_URL;if(!t)throw new Error("UPSTASH_VECTOR_REST_TOKEN is missing!");if(!a)throw new Error("UPSTASH_VECTOR_REST_URL is missing!");(a.startsWith(" ")||a.endsWith(" ")||/\r|\n/.test(a))&&console.warn("The vector url contains whitespace or newline, which can cause errors!"),(t.startsWith(" ")||t.endsWith(" ")||/\r|\n/.test(t))&&console.warn("The vector token contains whitespace or newline, which can cause errors!");let s=new f({baseUrl:a,retry:e?.retry,headers:{authorization:`Bearer ${t}`},cache:e?.cache===!1?void 0:e?.cache||"no-store",signal:e?.signal});super(s)}static fromEnv(e){let t=process?.env.UPSTASH_VECTOR_REST_URL;if(!t)throw new Error("Unable to find environment variable: `UPSTASH_VECTOR_REST_URL`");let a=process?.env.UPSTASH_VECTOR_REST_TOKEN;if(!a)throw new Error("Unable to find environment variable: `UPSTASH_VECTOR_REST_TOKEN`");return new n({...e,url:t,token:a})}};0&&(module.exports={Index});

package/dist/index.mjs

@@ -1 +1 @@
-var s=class extends Error{constructor(e){super(e),this.name="UpstashError"}};var i=class{baseUrl;headers;options;retry;constructor(e){this.options={cache:e.cache,signal:e.signal},this.baseUrl=e.baseUrl.replace(/\/$/,""),this.headers={"Content-Type":"application/json",...e.headers},typeof e?.retry=="boolean"&&e?.retry===!1?this.retry={attempts:1,backoff:()=>0}:this.retry={attempts:e?.retry?.retries??5,backoff:e?.retry?.backoff??(t=>Math.exp(t)*50)}}async request(e){let t={cache:this.options.cache,method:"POST",headers:this.headers,body:JSON.stringify(e.body),keepalive:!0,signal:this.options.signal},r=null,o=null;for(let y=0;y<=this.retry.attempts;y++)try{r=await fetch([this.baseUrl,...e.path??[]].join("/"),t);break}catch(g){if(this.options.signal?.aborted){let R=new Blob([JSON.stringify({result:this.options.signal.reason??"Aborted"})]),b={status:200,statusText:this.options.signal.reason??"Aborted"};r=new Response(R,b);break}o=g,await new Promise(R=>setTimeout(R,this.retry.backoff(y)))}if(!r)throw o??new Error("Exhausted all retries");let T=await r.json();if(!r.ok)throw new s(`${T.error}`);return{result:T.result,error:T.error}}};var a=class{payload;endpoint;constructor(e,t){this.payload=e,this.endpoint=t}async exec(e){let{result:t,error:r}=await e.request({body:this.payload,path:[this.endpoint]});if(r)throw new s(r);if(typeof t>"u")throw new Error("Request did not return a result");return t}};var d=class extends a{constructor(e){let t=[];Array.isArray(e)?t.push(...e):t.push(e),super(t,"delete")}};var c=class extends a{constructor(e){let t="query";"data"in e&&(t="query-data"),super(e,t)}};var p=class extends a{constructor(e){let t="upsert";if(Array.isArray(e)){if(e.some(o=>"data"in o&&o.data)){t="upsert-data";for(let o of e)!("metadata"in o)&&"data"in o&&(o.metadata={data:o.data})}}else"data"in e&&(t="upsert-data","metadata"in e||(e.metadata={data:e.data}));super(e,t)}};var u=class extends a{constructor([e,t]){super({ids:e,...t},"fetch")}};var l=class extends a{constructor(e){super(e,"range")}};var m=class extends a{constructor(){super([],"reset")}};var f=class extends a{constructor(){super([],"info")}};var h=class{client;constructor(e){this.client=e}delete=e=>new d(e).exec(this.client);query=e=>new c(e).exec(this.client);upsert=e=>new p(e).exec(this.client);fetch=(...e)=>new u(e).exec(this.client);reset=()=>new m().exec(this.client);range=e=>new l(e).exec(this.client);info=()=>new f().exec(this.client)};var x=class n extends h{constructor(e){if(typeof e<"u"&&"request"in e){super(e);return}let t=e?.token??process.env.NEXT_PUBLIC_UPSTASH_VECTOR_REST_TOKEN??process.env.UPSTASH_VECTOR_REST_TOKEN,r=e?.url??process.env.NEXT_PUBLIC_UPSTASH_VECTOR_REST_URL??process.env.UPSTASH_VECTOR_REST_URL;if(!t)throw new Error("UPSTASH_VECTOR_REST_TOKEN is missing!");if(!r)throw new Error("UPSTASH_VECTOR_REST_URL is missing!");(r.startsWith(" ")||r.endsWith(" ")||/\r|\n/.test(r))&&console.warn("The vector url contains whitespace or newline, which can cause errors!"),(t.startsWith(" ")||t.endsWith(" ")||/\r|\n/.test(t))&&console.warn("The vector token contains whitespace or newline, which can cause errors!");let o=new i({baseUrl:r,retry:e?.retry,headers:{authorization:`Bearer ${t}`},cache:e?.cache===!1?void 0:e?.cache||"no-store",signal:e?.signal});super(o)}static fromEnv(e){let t=process?.env.UPSTASH_VECTOR_REST_URL;if(!t)throw new Error("Unable to find environment variable: `UPSTASH_VECTOR_REST_URL`");let r=process?.env.UPSTASH_VECTOR_REST_TOKEN;if(!r)throw new Error("Unable to find environment variable: `UPSTASH_VECTOR_REST_TOKEN`");return new n({...e,url:t,token:r})}};export{x as Index};
+var i=class extends Error{constructor(e){super(e),this.name="UpstashError"}};var f=class{baseUrl;headers;options;retry;constructor(e){this.options={cache:e.cache,signal:e.signal},this.baseUrl=e.baseUrl.replace(/\/$/,""),this.headers={"Content-Type":"application/json",...e.headers},typeof e?.retry=="boolean"&&e?.retry===!1?this.retry={attempts:1,backoff:()=>0}:this.retry={attempts:e?.retry?.retries??5,backoff:e?.retry?.backoff??(t=>Math.exp(t)*50)}}async request(e){let t={cache:this.options.cache,method:"POST",headers:this.headers,body:JSON.stringify(e.body),keepalive:!0,signal:this.options.signal},a=null,s=null;for(let x=0;x<=this.retry.attempts;x++)try{a=await fetch([this.baseUrl,...e.path??[]].join("/"),t);break}catch(M){if(this.options.signal?.aborted){let g=new Blob([JSON.stringify({result:this.options.signal.reason??"Aborted"})]),b={status:200,statusText:this.options.signal.reason??"Aborted"};a=new Response(g,b);break}s=M,await new Promise(g=>setTimeout(g,this.retry.backoff(x)))}if(!a)throw s??new Error("Exhausted all retries");let o=await a.json();if(!a.ok)throw new i(`${o.error}`);return{result:o.result,error:o.error}}};var n=class{payload;endpoint;constructor(e,t){this.payload=e,this.endpoint=t}async exec(e){let{result:t,error:a}=await e.request({body:this.payload,path:[this.endpoint]});if(a)throw new i(a);if(typeof t>"u")throw new Error("Request did not return a result");return t}};var p=class extends n{constructor(e,t){let a="delete";t?.namespace&&(a=`${a}/${t.namespace}`);let s=[];Array.isArray(e)?s.push(...e):s.push(e),super(s,a)}};var d=class extends n{constructor(e,t){let a="query";"data"in e&&(a="query-data"),t?.namespace&&(a=`${a}/${t.namespace}`),super(e,a)}};var m=class extends n{constructor(e,t){let a="upsert";if(Array.isArray(e)){if(e.some(o=>"data"in o&&o.data)){a="upsert-data";for(let o of e)!("metadata"in o)&&"data"in o&&(o.metadata={data:o.data})}}else"data"in e&&(a="upsert-data","metadata"in e||(e.metadata={data:e.data}));t?.namespace&&(a=`${a}/${t.namespace}`),super(e,a)}};var c=class extends n{constructor([e,t],a){let s="fetch";a?.namespace&&(s=`${s}/${a.namespace}`),super({ids:e,...t},s)}};var l=class extends n{constructor(e,t){let a="range";t?.namespace&&(a=`${a}/${t.namespace}`),super(e,a)}};var u=class extends n{constructor(e){let t="reset";e?.namespace&&(t=`${t}/${e.namespace}`),super([],t)}};var y=class extends n{constructor(){super([],"info")}};var h=class{client;namespace;constructor(e,t){this.client=e,this.namespace=t}upsert=e=>new m(e,{namespace:this.namespace}).exec(this.client);fetch=(...e)=>new c(e,{namespace:this.namespace}).exec(this.client);query=e=>new d(e,{namespace:this.namespace}).exec(this.client);delete=e=>new p(e,{namespace:this.namespace}).exec(this.client);range=e=>new l(e,{namespace:this.namespace}).exec(this.client);reset=()=>new u({namespace:this.namespace}).exec(this.client)};var T=class extends n{constructor(){super([],"list-namespaces")}};var C=class extends n{constructor(e){let t=`delete-namespace/${e}`;super([],t)}};var E=class{client;constructor(e){this.client=e}namespace=e=>new h(this.client,e);delete=(e,t)=>new p(e,t).exec(this.client);query=(e,t)=>new d(e,t).exec(this.client);upsert=(e,t)=>new m(e,t).exec(this.client);fetch=(...e)=>new c(e).exec(this.client);reset=e=>new u(e).exec(this.client);range=(e,t)=>new l(e,t).exec(this.client);info=()=>new y().exec(this.client);listNamespaces=()=>new T().exec(this.client);deleteNamespace=e=>new C(e).exec(this.client)};var R=class r extends E{constructor(e){if(typeof e<"u"&&"request"in e){super(e);return}let t=e?.token??process.env.NEXT_PUBLIC_UPSTASH_VECTOR_REST_TOKEN??process.env.UPSTASH_VECTOR_REST_TOKEN,a=e?.url??process.env.NEXT_PUBLIC_UPSTASH_VECTOR_REST_URL??process.env.UPSTASH_VECTOR_REST_URL;if(!t)throw new Error("UPSTASH_VECTOR_REST_TOKEN is missing!");if(!a)throw new Error("UPSTASH_VECTOR_REST_URL is missing!");(a.startsWith(" ")||a.endsWith(" ")||/\r|\n/.test(a))&&console.warn("The vector url contains whitespace or newline, which can cause errors!"),(t.startsWith(" ")||t.endsWith(" ")||/\r|\n/.test(t))&&console.warn("The vector token contains whitespace or newline, which can cause errors!");let s=new f({baseUrl:a,retry:e?.retry,headers:{authorization:`Bearer ${t}`},cache:e?.cache===!1?void 0:e?.cache||"no-store",signal:e?.signal});super(s)}static fromEnv(e){let t=process?.env.UPSTASH_VECTOR_REST_URL;if(!t)throw new Error("Unable to find environment variable: `UPSTASH_VECTOR_REST_URL`");let a=process?.env.UPSTASH_VECTOR_REST_TOKEN;if(!a)throw new Error("Unable to find environment variable: `UPSTASH_VECTOR_REST_TOKEN`");return new r({...e,url:t,token:a})}};export{R as Index};

package/package.json

@@ -1 +1 @@
-{ "name": "@upstash/vector", "version": "v1.0.7", "author": "Oguzhan Olguncu <oguzhan@upstash.com>", "repository": { "type": "git", "url": "https://github.com/upstash/vector-js" }, "main": "./dist/index.js", "module": "./dist/index.mjs", "devDependencies": { "@biomejs/biome": "^1.4.1", "@commitlint/cli": "^18.6.0", "@commitlint/config-conventional": "^18.6.0", "bun-types": "latest", "husky": "^8.0.3", "tsup": "latest", "typescript": "^5.0.0", "vitest": "^1.2.2" }, "bugs": { "url": "https://github.com/upstash/vector/issues" }, "description": "An HTTP/REST based Vector DB client built on top of Upstash REST API.", "files": [ "dist" ], "homepage": "https://upstash.com/vector", "keywords": [ "vector", "upstash", "db" ], "license": "MIT", "scripts": { "test": "bun test src --coverage --bail --coverageSkipTestFiles=[test-utils.ts] --timeout 20000 && vitest run --typecheck", "fmt": "bunx biome check --apply ./src", "build": "tsup", "prepare": "husky install" }, "types": "./dist/index.d.ts" }
+{ "name": "@upstash/vector", "version": "v1.0.8-canary", "author": "Oguzhan Olguncu <oguzhan@upstash.com>", "repository": { "type": "git", "url": "https://github.com/upstash/vector-js" }, "main": "./dist/index.js", "module": "./dist/index.mjs", "devDependencies": { "@biomejs/biome": "^1.4.1", "@commitlint/cli": "^18.6.0", "@commitlint/config-conventional": "^18.6.0", "bun-types": "latest", "husky": "^8.0.3", "tsup": "latest", "typescript": "^5.0.0", "vitest": "^1.2.2" }, "bugs": { "url": "https://github.com/upstash/vector/issues" }, "description": "An HTTP/REST based Vector DB client built on top of Upstash REST API.", "files": [ "dist" ], "homepage": "https://upstash.com/vector", "keywords": [ "vector", "upstash", "db" ], "license": "MIT", "scripts": { "test": "bun test src --coverage --bail --coverageSkipTestFiles=[test-utils.ts] --timeout 20000 && vitest run --typecheck", "fmt": "bunx biome check --apply ./src", "build": "tsup", "prepare": "husky install" }, "types": "./dist/index.d.ts" }