@upstash/vector 1.0.1 → 1.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Upstash
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,273 +1,131 @@
-# Upstash Vector Node.js Client
+# Upstash Vector Node.js Client · ![license](https://img.shields.io/npm/l/%40upstash%2Fvector) [![Tests](https://github.com/upstash/vector-js/actions/workflows/tests.yaml/badge.svg)](https://github.com/upstash/vector-js/actions/workflows/tests.yaml) ![npm (scoped)](https://img.shields.io/npm/v/@upstash/vector) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@upstash/vector) ![npm weekly download](https://img.shields.io/npm/dw/%40upstash%2Fvector)
 
-This is the official Node.js client for [Upstash](https://upstash.com/), written in TypeScript.
+`@upstash/vector` is an HTTP/REST based client for Typescript, built on top of [Upstash REST API](https://upstash.com/docs/vector/api/endpoints/).
 
-## Documentation
+It is the only connectionless (HTTP based) Vector client and designed for:
 
-- [**Reference Documentation**](https://upstash.com/docs/vector/overall/getstarted)
+- Serverless functions (AWS Lambda ...)
+- Cloudflare Workers
+- Next.js, Jamstack ...
+- Client side web/mobile applications
+- WebAssembly
+- and other environments where HTTP is preferred over TCP.
 
-## Installation
+See [the list of APIs](https://upstash.com/docs/vector/api/endpoints) supported.
 
-```
-npm install @upstash/vector
-pnpm add @upstash/vector
-```
-
-## Usage
-
-### Initializing the client
+## Quick Start
 
-There are two pieces of configuration required to use the Upstash vector client: an REST token and REST URL. These values can be passed using environment variables or in code through a configuration object. Find your configuration values in the console dashboard at [https://console.upstash.com/](https://console.upstash.com/).
+### Install
 
-#### Using environment variables
-
-The environment variables used to configure the client are the following:
+#### Node.js
 
 ```bash
-UPSTASH_VECTOR_REST_URL="your_rest_url"
-UPSTASH_VECTOR_REST_TOKEN="your_rest_token"
+npm install @upstash/vector
 ```
 
-When these environment variables are set, the client constructor does not require any additional arguments.
+### Create Index
 
-```typescript
-import { Index } from "@upstash/vector";
-
-const index = new Index();
-```
+Create a new index on [Upstash](https://console.upstash.com/vector)
 
-#### Using a configuration object
+## Basic Usage:
 
-If you prefer to pass configuration in code, the constructor accepts a config object containing the `url` and `token` values. This
-could be useful if your application needs to interact with multiple projects, each with a different configuration.
-
-```typescript
+```ts
 import { Index } from "@upstash/vector";
 
-const index = new Index({
-  url: "<UPSTASH_VECTOR_REST_URL>",
-  token: "<UPSTASH_VECTOR_REST_TOKEN>",
-});
-```
-
-## Index operations
-
-Upstash vector indexes support operations for working with vector data using operations such as upsert, query, fetch, and delete.
-
-### Accessing an index
-
-To perform data operations on an index, access it using the `index` method.
-
-```typescript
-// Now perform index operations
-await index.fetch([1, 2, 3], { includeMetadata: true, includeVectors: true });
-```
-
-### Accesing an index, with metadata typing
-
-If you are storing metadata alongside your vector values, you can pass a type parameter to `index()` in order to get proper TypeScript typechecking.
-
-```typescript
 type Metadata = {
   title: string,
   genre: 'sci-fi' | 'fantasy' | 'horror' | 'action'
+  category: "classic" | "modern"
 }
 
+const index = new Index<Metadata>({
+  url: "<UPSTASH_VECTOR_REST_URL>",
+  token: "<UPSTASH_VECTOR_REST_TOKEN>",
+});
+
+//Upsert Data
 await index.upsert([{
-  id: '1234',
+  id: 'upstash-rocks',
   vector: [
     .... // embedding values
   ],
   metadata: {
     title: 'Lord of The Rings',
-    genre: 'drama',
+    genre: 'fantasy',
     category: 'classic'
   }
 }])
 
+//Query Data
 const results = await index.query<Metadata>({
   vector: [
     ... // query embedding
   ],
   includeVectors: true,
+  includeMetadata: true
   topK: 1,
 })
 
-if (results[0].metadata) {
-  // Since we passed the Metadata type parameter above,
-  // we can interact with metadata fields without having to
-  // do any typecasting.
-  const { title, genre, category } = results[0].metadata;
-  console.log(`The best match in fantasy was ${title}`)
-}
-```
-
-### Upsert records
-
-Upstash vector expects records inserted into indexes to have the following form:
-
-```typescript
-type UpstashRecord = {
-  id: number | string;
-  vector: number[];
-  metadata?: Record<string, unknown>;
-};
-```
-
-#### Upsert many
-
-To upsert some records, you can use the client like so:
-
-```typescript
-// Prepare your data. The length of each array
-// of vector values must match the dimension of
-// the index where you plan to store them.
-const records = [
-  {
-    id: "1",
-    vector: [0.236, 0.971, 0.559],
-  },
-  {
-    id: "2",
-    vector: [0.685, 0.111, 0.857],
-  },
-];
-
-// Upsert the data into your index
-await index.upsert(records);
-```
-
-#### Upsert one
-
-```typescript
-// Prepare your data. The length of each array
-// of vector values must match the dimension of
-// the index where you plan to store them.
-const record = {
-  id: "1",
-  vector: [0.236, 0.971, 0.559],
-};
-// Upsert the data into your index
-await index.upsert(record);
-```
-
-### Querying
-
-#### Querying with vector values
-
-The query method accepts a large number of options. The dimension of the query vector must match the dimension of your index.
-
-```typescript
-type QueryOptions = {
-  vector: number[];
-  topK: number;
-  includeVectors?: boolean;
-  includeMetadata?: boolean;
-};
-```
-
-For example, to query by vector values you would pass the `vector` param in the options configuration. For brevity sake this example query vector is tiny (dimension 2), but in a more realistic use case this query vector would be an embedding outputted by a model. Look at the [Example code](#example-code) to see more realistic examples of how to use `query`.
-
-```typescript
-> await index.query({ topK: 3, vector: [ 0.22, 0.66 ]})
-{
-  matches: [
-    {
-      id: '6345',
-      score: 1.00000012,
-      vector: [],
-      metadata: undefined
-    },
-    {
-      id: '1233',
-      score: 1.00000012,
-      vector: [],
-      metadata: undefined
-    },
-    {
-      id: '4142',
-      score: 1.00000012,
-      vector: [],
-      metadata: undefined
-    }
-  ],
-  namespace: ''
-}
-```
-
-You include options to `includeMetadata: true` or `includeVectors: true` if you need this information. By default these are not returned to keep the response payload small.
-
-### Update a record
-
-You may want to update vector `vector` or `metadata`. Specify the id and the attribute value you want to update.
-
-```typescript
+//Update Data
 await index.upsert({
-  id: "18593",
-  metadata: { genre: "romance" },
+  id: "upstash-rocks",
+  metadata: {
+    title: 'Star Wars',
+    genre: 'sci-fi',
+    category: 'classic'
+  }
 });
-```
 
-### Fetch records by their IDs
+//Delete record
+await index.delete("upstash-rocks");
 
-```typescript
-const fetchResult = await index.fetch(["id-1", "id-2"]);
-```
-
-### Delete records
+//Delete many by id
+await index.delete(["id-1", "id-2", "id-3"]);
 
-For convenience there are several delete-related options. You can verify the results of a delete operation by trying to `fetch()` a record.
+//Fetch records by their IDs
+await index.fetch(["id-1", "id-2"]);
 
-#### Delete one
+//Fetch records with range
+await index.range({
+      cursor: 0,
+      limit: 5,
+      includeVectors: true,
+});
 
-```typescript
-await index.delete("id-to-delete");
-```
+//Reset index
+await index.reset();
 
-#### Delete many by id
+//Info about index
+await index.info();
 
-```typescript
-await index.delete(["id-1", "id-2", "id-3"]);
+//Random vector based on stored vectors
+await index.random();
 ```
 
-### Info
-
-To get statistics of your index, you can use the client like so:
-
-```typescript
-await index.info(["id-1", "id-2", "id-3"]);
-```
+## Troubleshooting
 
-### Reset
+We have a [Discord](upstash.com/discord) for common problems. If you can't find a solution, please [open an issue](https://github.com/upstash/vector-js/issues/new).
 
-To delete everything related with that index:
+## Docs
 
-```typescript
-await index.reset();
-```
+See [the documentation](https://upstash.com/docs/oss/sdks/ts/vector/overview) for details.
 
 ## Contributing
 
-## Preparing the environment
+### [Install Bun](https://bun.sh/docs/installation)
 
-This project uses [Bun](https://bun.sh/) for packaging and dependency management. Make sure you have the relevant dependencies.
+### Vector Database
 
-You will also need a vector database on [Upstash](https://console.upstash.com/).
+Create a new index on [Upstash](https://console.upstash.com/vector) and copy the url and token.
 
-```commandline
-curl -fsSL https://bun.sh/install | bash
-```
+### Running tests
 
-## Code Formatting
-
-```bash
-bun run fmt
+```sh
+bun run test
 ```
 
-## Running tests
-
-To run all the tests, make sure you have the relevant environment variables.
+### Building
 
-```bash
-bun run test
+```sh
+bun run build
 ```

package/dist/index.d.mts

@@ -87,15 +87,6 @@ declare class QueryCommand<TMetadata> extends Command<QueryResult<TMetadata>[]>
     constructor(payload: QueryCommandPayload);
 }
 
-type UpsertCommandPayload = {
-    id: number | string;
-    vector: number[];
-    metadata?: Record<string, unknown>;
-};
-declare class UpsertCommand extends Command<string> {
-    constructor(payload: UpsertCommandPayload | UpsertCommandPayload[]);
-}
-
 type RangeCommandPayload = {
     cursor: number | string;
     limit: number;
@@ -122,7 +113,7 @@ type CommandArgs<TCommand extends new (_args: any) => any> = ConstructorParamete
 /**
  * Serverless vector client for upstash vector db.
  */
-declare class Index$1 {
+declare class Index$1<TIndexMetadata extends Record<string, unknown> = Record<string, unknown>> {
     protected client: Requester;
     /**
      * Create a new vector db client
@@ -168,7 +159,7 @@ declare class Index$1 {
      *
      * @returns A promise that resolves with an array of query result objects when the request to query the index is completed.
      */
-    query: <TMetadata>(args: CommandArgs<typeof QueryCommand>) => Promise<QueryResult<TMetadata>[]>;
+    query: <TMetadata extends Record<string, unknown> = TIndexMetadata>(args: CommandArgs<typeof QueryCommand>) => 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.
@@ -191,7 +182,15 @@ declare class Index$1 {
      *
      * @returns {string} A promise that resolves with the result of the upsert operation after the command is executed.
      */
-    upsert: (args: CommandArgs<typeof UpsertCommand>) => Promise<string>;
+    upsert: <TMetadata extends Record<string, unknown> = TIndexMetadata>(args: {
+        id: string | number;
+        vector: number[];
+        metadata?: (TMetadata extends infer U ? U : never) | undefined;
+    } | {
+        id: string | number;
+        vector: number[];
+        metadata?: (TMetadata extends infer U ? U : never) | undefined;
+    }[]) => Promise<string>;
     /**
      * It's used for retrieving specific items from the index, optionally including
      * their metadata and feature vectors.
@@ -212,10 +211,10 @@ declare class Index$1 {
      *
      * @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>(ids: string[] | number[], opts: {
+    fetch: <TMetadata extends Record<string, unknown> = TIndexMetadata>(ids: number[] | string[], opts?: {
         includeMetadata?: boolean | undefined;
         includeVectors?: boolean | undefined;
-    }) => Promise<FetchResult<TMetadata>[]>;
+    } | undefined) => Promise<FetchResult<TMetadata>[]>;
     /**
      * It's used for wiping an entire index.
      *
@@ -251,7 +250,7 @@ declare class Index$1 {
      *
      * @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>(args: CommandArgs<typeof RangeCommand>) => Promise<RangeResult<TMetadata>>;
+    range: <TMetadata extends Record<string, unknown> = TIndexMetadata>(args: CommandArgs<typeof RangeCommand>) => Promise<RangeResult<TMetadata>>;
     /**
      * Retrieves info from the index.
      *
@@ -288,7 +287,7 @@ type IndexConfig = {
 /**
  * Serverless vector client for upstash.
  */
-declare class Index extends Index$1 {
+declare class Index<TIndexMetadata extends Record<string, unknown> = Record<string, unknown>> extends Index$1<TIndexMetadata> {
     /**
      * Create a new vector client by providing the url and token
      *

package/dist/index.d.ts

@@ -87,15 +87,6 @@ declare class QueryCommand<TMetadata> extends Command<QueryResult<TMetadata>[]>
     constructor(payload: QueryCommandPayload);
 }
 
-type UpsertCommandPayload = {
-    id: number | string;
-    vector: number[];
-    metadata?: Record<string, unknown>;
-};
-declare class UpsertCommand extends Command<string> {
-    constructor(payload: UpsertCommandPayload | UpsertCommandPayload[]);
-}
-
 type RangeCommandPayload = {
     cursor: number | string;
     limit: number;
@@ -122,7 +113,7 @@ type CommandArgs<TCommand extends new (_args: any) => any> = ConstructorParamete
 /**
  * Serverless vector client for upstash vector db.
  */
-declare class Index$1 {
+declare class Index$1<TIndexMetadata extends Record<string, unknown> = Record<string, unknown>> {
     protected client: Requester;
     /**
      * Create a new vector db client
@@ -168,7 +159,7 @@ declare class Index$1 {
      *
      * @returns A promise that resolves with an array of query result objects when the request to query the index is completed.
      */
-    query: <TMetadata>(args: CommandArgs<typeof QueryCommand>) => Promise<QueryResult<TMetadata>[]>;
+    query: <TMetadata extends Record<string, unknown> = TIndexMetadata>(args: CommandArgs<typeof QueryCommand>) => 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.
@@ -191,7 +182,15 @@ declare class Index$1 {
      *
      * @returns {string} A promise that resolves with the result of the upsert operation after the command is executed.
      */
-    upsert: (args: CommandArgs<typeof UpsertCommand>) => Promise<string>;
+    upsert: <TMetadata extends Record<string, unknown> = TIndexMetadata>(args: {
+        id: string | number;
+        vector: number[];
+        metadata?: (TMetadata extends infer U ? U : never) | undefined;
+    } | {
+        id: string | number;
+        vector: number[];
+        metadata?: (TMetadata extends infer U ? U : never) | undefined;
+    }[]) => Promise<string>;
     /**
      * It's used for retrieving specific items from the index, optionally including
      * their metadata and feature vectors.
@@ -212,10 +211,10 @@ declare class Index$1 {
      *
      * @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>(ids: string[] | number[], opts: {
+    fetch: <TMetadata extends Record<string, unknown> = TIndexMetadata>(ids: number[] | string[], opts?: {
         includeMetadata?: boolean | undefined;
         includeVectors?: boolean | undefined;
-    }) => Promise<FetchResult<TMetadata>[]>;
+    } | undefined) => Promise<FetchResult<TMetadata>[]>;
     /**
      * It's used for wiping an entire index.
      *
@@ -251,7 +250,7 @@ declare class Index$1 {
      *
      * @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>(args: CommandArgs<typeof RangeCommand>) => Promise<RangeResult<TMetadata>>;
+    range: <TMetadata extends Record<string, unknown> = TIndexMetadata>(args: CommandArgs<typeof RangeCommand>) => Promise<RangeResult<TMetadata>>;
     /**
      * Retrieves info from the index.
      *
@@ -288,7 +287,7 @@ type IndexConfig = {
 /**
  * Serverless vector client for upstash.
  */
-declare class Index extends Index$1 {
+declare class Index<TIndexMetadata extends Record<string, unknown> = Record<string, unknown>> extends Index$1<TIndexMetadata> {
     /**
      * Create a new vector client by providing the url and token
      *

package/dist/index.js

@@ -1 +1 @@
-"use strict";var b=Object.defineProperty;var w=Object.getOwnPropertyDescriptor;var E=Object.getOwnPropertyNames;var S=Object.prototype.hasOwnProperty;var U=(r,e)=>{for(var t in e)b(r,t,{get:e[t],enumerable:!0})},_=(r,e,t,o)=>{if(e&&typeof e=="object"||typeof e=="function")for(let s of E(e))!S.call(r,s)&&s!==t&&b(r,s,{get:()=>e[s],enumerable:!(o=w(e,s))||o.enumerable});return r};var P=r=>_(b({},"__esModule",{value:!0}),r);var A={};U(A,{Index:()=>C});module.exports=P(A);var a=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},o=null,s=null;for(let R=0;R<=this.retry.attempts;R++)try{o=await fetch([this.baseUrl,...e.path??[]].join("/"),t);break}catch(x){if(this.options.signal?.aborted){let T=new Blob([JSON.stringify({result:this.options.signal.reason??"Aborted"})]),g={status:200,statusText:this.options.signal.reason??"Aborted"};o=new Response(T,g);break}s=x,await new Promise(T=>setTimeout(T,this.retry.backoff(R)))}if(!o)throw s??new Error("Exhausted all retries");let y=await o.json();if(!o.ok)throw new a(`${y.error}, command was: ${JSON.stringify(e.body)}`);return{result:y.result,error:y.error}}};var n=class{payload;endpoint;constructor(e,t){this.payload=e,this.endpoint=t}async exec(e){let{result:t,error:o}=await e.request({body:this.payload,path:[this.endpoint]});if(o)throw new a(o);if(typeof t>"u")throw new Error("Request did not return a result");return t}};var p=class extends n{constructor(e){let t=[];Array.isArray(e)?t.push(...e):t.push(e),super(t,"delete")}};var c=class extends n{constructor(e){super(e,"query")}};var u=class extends n{constructor(e){super(e,"upsert")}};var m=class extends n{constructor([e,t]){super({ids:e,...t},"fetch")}};var l=class extends n{constructor(e){super(e,"range")}};var d=class extends n{constructor(){super([],"reset")}};var h=class extends n{constructor(){super([],"info")}};var f=class{client;constructor(e){this.client=e}delete=e=>new p(e).exec(this.client);query=e=>new c(e).exec(this.client);upsert=e=>new u(e).exec(this.client);fetch=(...e)=>new m(e).exec(this.client);reset=()=>new d().exec(this.client);range=e=>new l(e).exec(this.client);info=()=>new h().exec(this.client)};var C=class r extends f{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,o=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(!o)throw new Error("UPSTASH_VECTOR_REST_URL is missing!");(o.startsWith(" ")||o.endsWith(" ")||/\r|\n/.test(o))&&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 i({baseUrl:o,retry:e?.retry,headers:{authorization:`Bearer ${t}`},cache: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 o=process?.env.UPSTASH_VECTOR_REST_TOKEN;if(!o)throw new Error("Unable to find environment variable: `UPSTASH_VECTOR_REST_TOKEN`");return new r({...e,url:t,token:o})}};0&&(module.exports={Index});
+"use strict";var x=Object.defineProperty;var w=Object.getOwnPropertyDescriptor;var E=Object.getOwnPropertyNames;var U=Object.prototype.hasOwnProperty;var S=(r,e)=>{for(var t in e)x(r,t,{get:e[t],enumerable:!0})},M=(r,e,t,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let s of E(e))!U.call(r,s)&&s!==t&&x(r,s,{get:()=>e[s],enumerable:!(n=w(e,s))||n.enumerable});return r};var _=r=>M(x({},"__esModule",{value:!0}),r);var P={};S(P,{Index:()=>b});module.exports=_(P);var a=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},n=null,s=null;for(let y=0;y<=this.retry.attempts;y++)try{n=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"})]),C={status:200,statusText:this.options.signal.reason??"Aborted"};n=new Response(R,C);break}s=g,await new Promise(R=>setTimeout(R,this.retry.backoff(y)))}if(!n)throw s??new Error("Exhausted all retries");let T=await n.json();if(!n.ok)throw new a(`${T.error}, command was: ${JSON.stringify(e.body)}`);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:n}=await e.request({body:this.payload,path:[this.endpoint]});if(n)throw new a(n);if(typeof t>"u")throw new Error("Request did not return a result");return t}};var p=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){super(e,"query")}};var d=class extends o{constructor(e){super(e,"upsert")}};var u=class extends o{constructor([e,t]){super({ids:e,...t},"fetch")}};var m=class extends o{constructor(e){super(e,"range")}};var l=class extends o{constructor(){super([],"reset")}};var h=class extends o{constructor(){super([],"info")}};var f=class{client;constructor(e){this.client=e}delete=e=>new p(e).exec(this.client);query=e=>new c(e).exec(this.client);upsert=e=>new d(e).exec(this.client);fetch=(...e)=>new u(e).exec(this.client);reset=()=>new l().exec(this.client);range=e=>new m(e).exec(this.client);info=()=>new h().exec(this.client)};var b=class r extends f{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,n=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(!n)throw new Error("UPSTASH_VECTOR_REST_URL is missing!");(n.startsWith(" ")||n.endsWith(" ")||/\r|\n/.test(n))&&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 i({baseUrl:n,retry:e?.retry,headers:{authorization:`Bearer ${t}`},cache: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 n=process?.env.UPSTASH_VECTOR_REST_TOKEN;if(!n)throw new Error("Unable to find environment variable: `UPSTASH_VECTOR_REST_TOKEN`");return new r({...e,url:t,token:n})}};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,a=null;for(let R=0;R<=this.retry.attempts;R++)try{r=await fetch([this.baseUrl,...e.path??[]].join("/"),t);break}catch(C){if(this.options.signal?.aborted){let T=new Blob([JSON.stringify({result:this.options.signal.reason??"Aborted"})]),x={status:200,statusText:this.options.signal.reason??"Aborted"};r=new Response(T,x);break}a=C,await new Promise(T=>setTimeout(T,this.retry.backoff(R)))}if(!r)throw a??new Error("Exhausted all retries");let y=await r.json();if(!r.ok)throw new s(`${y.error}, command was: ${JSON.stringify(e.body)}`);return{result:y.result,error:y.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 p=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){super(e,"query")}};var u=class extends o{constructor(e){super(e,"upsert")}};var m=class extends o{constructor([e,t]){super({ids:e,...t},"fetch")}};var l=class extends o{constructor(e){super(e,"range")}};var d=class extends o{constructor(){super([],"reset")}};var h=class extends o{constructor(){super([],"info")}};var f=class{client;constructor(e){this.client=e}delete=e=>new p(e).exec(this.client);query=e=>new c(e).exec(this.client);upsert=e=>new u(e).exec(this.client);fetch=(...e)=>new m(e).exec(this.client);reset=()=>new d().exec(this.client);range=e=>new l(e).exec(this.client);info=()=>new h().exec(this.client)};var b=class n extends f{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 a=new i({baseUrl:r,retry:e?.retry,headers:{authorization:`Bearer ${t}`},cache:e?.cache||"no-store",signal:e?.signal});super(a)}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{b as Index};
+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,a=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"})]),g={status:200,statusText:this.options.signal.reason??"Aborted"};r=new Response(R,g);break}a=b,await new Promise(R=>setTimeout(R,this.retry.backoff(y)))}if(!r)throw a??new Error("Exhausted all retries");let T=await r.json();if(!r.ok)throw new s(`${T.error}, command was: ${JSON.stringify(e.body)}`);return{result:T.result,error:T.error}}};var n=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 p=class extends n{constructor(e){let t=[];Array.isArray(e)?t.push(...e):t.push(e),super(t,"delete")}};var c=class extends n{constructor(e){super(e,"query")}};var d=class extends n{constructor(e){super(e,"upsert")}};var u=class extends n{constructor([e,t]){super({ids:e,...t},"fetch")}};var m=class extends n{constructor(e){super(e,"range")}};var l=class extends n{constructor(){super([],"reset")}};var h=class extends n{constructor(){super([],"info")}};var f=class{client;constructor(e){this.client=e}delete=e=>new p(e).exec(this.client);query=e=>new c(e).exec(this.client);upsert=e=>new d(e).exec(this.client);fetch=(...e)=>new u(e).exec(this.client);reset=()=>new l().exec(this.client);range=e=>new m(e).exec(this.client);info=()=>new h().exec(this.client)};var x=class o extends f{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 a=new i({baseUrl:r,retry:e?.retry,headers:{authorization:`Bearer ${t}`},cache:e?.cache||"no-store",signal:e?.signal});super(a)}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 o({...e,url:t,token:r})}};export{x as Index};

package/package.json

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