@upstash/vector 0.1.0-alpha-3 → 0.1.0-alpha-5

package/dist/index.d.mts

@@ -69,13 +69,13 @@ type QueryCommandPayload = {
     includeVectors?: boolean;
     includeMetadata?: boolean;
 };
-type QueryReturnResponse<TMetadata> = {
+type QueryResponse<TMetadata> = {
     id: number | string;
     score: number;
     vector: number[];
     metadata?: TMetadata;
 };
-declare class QueryCommand<TMetadata> extends Command<QueryReturnResponse<TMetadata>[]> {
+declare class QueryCommand<TMetadata> extends Command<QueryResponse<TMetadata>[]> {
     constructor(payload: QueryCommandPayload);
 }
 
@@ -94,7 +94,7 @@ type Vector<TMetadata> = {
     metadata?: TMetadata;
 };
 
-type FetchReturnResponse<TMetadata> = Vector<TMetadata> | null;
+type FetchResponse<TMetadata> = Vector<TMetadata> | null;
 
 type RangeCommandPayload = {
     cursor: number | string;
@@ -102,11 +102,11 @@ type RangeCommandPayload = {
     includeVectors?: boolean;
     includeMetadata?: boolean;
 };
-type RangeReturnResponse<TMetadata> = {
+type RangeResponse<TMetadata> = {
     nextCursor: string;
     vectors: Vector<TMetadata>[];
 };
-declare class RangeCommand<TMetadata> extends Command<RangeReturnResponse<TMetadata>> {
+declare class RangeCommand<TMetadata> extends Command<RangeResponse<TMetadata>> {
     constructor(payload: RangeCommandPayload);
 }
 
@@ -160,7 +160,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: (args: CommandArgs<typeof QueryCommand>) => Promise<QueryReturnResponse<unknown>[]>;
+    query: (args: CommandArgs<typeof QueryCommand>) => Promise<QueryResponse<unknown>[]>;
     /**
      * Upserts (Updates and Inserts) specific items into the index.
      * It's used for adding new items to the index or updating existing ones.
@@ -207,7 +207,7 @@ declare class Index$1 {
     fetch: (ids: string[] | number[], opts: {
         includeMetadata?: boolean | undefined;
         includeVectors?: boolean | undefined;
-    }) => Promise<FetchReturnResponse<unknown>[]>;
+    }) => Promise<FetchResponse<unknown>[]>;
     /**
      * It's used for wiping an entire index.
      *
@@ -243,7 +243,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: (args: CommandArgs<typeof RangeCommand>) => Promise<RangeReturnResponse<unknown>>;
+    range: (args: CommandArgs<typeof RangeCommand>) => Promise<RangeResponse<unknown>>;
 }
 
 /**
@@ -311,4 +311,4 @@ declare class Index extends Index$1 {
     static fromEnv(config?: Omit<IndexConfig, "url" | "token">): Index;
 }
 
-export { type FetchReturnResponse, Index, type IndexConfig, type QueryReturnResponse, type RangeReturnResponse, type Requester, type UpstashRequest, type UpstashResponse, type Vector };
+export { type FetchResponse as FetchReturnResponse, Index, type IndexConfig, type QueryResponse as QueryReturnResponse, type RangeResponse as RangeReturnResponse, type Requester, type UpstashRequest, type UpstashResponse, type Vector };

package/dist/index.d.ts

@@ -69,13 +69,13 @@ type QueryCommandPayload = {
     includeVectors?: boolean;
     includeMetadata?: boolean;
 };
-type QueryReturnResponse<TMetadata> = {
+type QueryResponse<TMetadata> = {
     id: number | string;
     score: number;
     vector: number[];
     metadata?: TMetadata;
 };
-declare class QueryCommand<TMetadata> extends Command<QueryReturnResponse<TMetadata>[]> {
+declare class QueryCommand<TMetadata> extends Command<QueryResponse<TMetadata>[]> {
     constructor(payload: QueryCommandPayload);
 }
 
@@ -94,7 +94,7 @@ type Vector<TMetadata> = {
     metadata?: TMetadata;
 };
 
-type FetchReturnResponse<TMetadata> = Vector<TMetadata> | null;
+type FetchResponse<TMetadata> = Vector<TMetadata> | null;
 
 type RangeCommandPayload = {
     cursor: number | string;
@@ -102,11 +102,11 @@ type RangeCommandPayload = {
     includeVectors?: boolean;
     includeMetadata?: boolean;
 };
-type RangeReturnResponse<TMetadata> = {
+type RangeResponse<TMetadata> = {
     nextCursor: string;
     vectors: Vector<TMetadata>[];
 };
-declare class RangeCommand<TMetadata> extends Command<RangeReturnResponse<TMetadata>> {
+declare class RangeCommand<TMetadata> extends Command<RangeResponse<TMetadata>> {
     constructor(payload: RangeCommandPayload);
 }
 
@@ -160,7 +160,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: (args: CommandArgs<typeof QueryCommand>) => Promise<QueryReturnResponse<unknown>[]>;
+    query: (args: CommandArgs<typeof QueryCommand>) => Promise<QueryResponse<unknown>[]>;
     /**
      * Upserts (Updates and Inserts) specific items into the index.
      * It's used for adding new items to the index or updating existing ones.
@@ -207,7 +207,7 @@ declare class Index$1 {
     fetch: (ids: string[] | number[], opts: {
         includeMetadata?: boolean | undefined;
         includeVectors?: boolean | undefined;
-    }) => Promise<FetchReturnResponse<unknown>[]>;
+    }) => Promise<FetchResponse<unknown>[]>;
     /**
      * It's used for wiping an entire index.
      *
@@ -243,7 +243,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: (args: CommandArgs<typeof RangeCommand>) => Promise<RangeReturnResponse<unknown>>;
+    range: (args: CommandArgs<typeof RangeCommand>) => Promise<RangeResponse<unknown>>;
 }
 
 /**
@@ -311,4 +311,4 @@ declare class Index extends Index$1 {
     static fromEnv(config?: Omit<IndexConfig, "url" | "token">): Index;
 }
 
-export { type FetchReturnResponse, Index, type IndexConfig, type QueryReturnResponse, type RangeReturnResponse, type Requester, type UpstashRequest, type UpstashResponse, type Vector };
+export { type FetchResponse as FetchReturnResponse, Index, type IndexConfig, type QueryResponse as QueryReturnResponse, type RangeResponse as RangeReturnResponse, type Requester, type UpstashRequest, type UpstashResponse, type Vector };

package/dist/index.js

@@ -1,5 +1,5 @@
 'use strict';
 
-var n=class extends Error{constructor(e){super(e),this.name="UpstashError";}};var a=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,f=null;for(let y=0;y<=this.retry.attempts;y++)try{o=await fetch([this.baseUrl,...e.path??[]].join("/"),t);break}catch(x){if(this.options.signal?.aborted){let b=new Blob([JSON.stringify({result:this.options.signal.reason??"Aborted"})]),g={status:200,statusText:this.options.signal.reason??"Aborted"};o=new Response(b,g);break}f=x,await new Promise(b=>setTimeout(b,this.retry.backoff(y)));}if(!o)throw f??new Error("Exhausted all retries");let h=await o.json();if(!o.ok)throw new n(`${h.error}, command was: ${JSON.stringify(e.body)}`);return {result:h.result,error:h.error}}};var r=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 n(o);if(typeof t>"u")throw new Error("Request did not return a result");return t}};var i=class extends r{constructor(e){let t=[];Array.isArray(e)?t.push(...e):t.push(e),super(t,"delete");}};var p=class extends r{constructor(e){super(e,"query");}};var c=class extends r{constructor(e){super(e,"upsert");}};var u=class extends r{constructor([e,t]){super({ids:e,...t},"fetch");}};var l=class extends r{constructor(e){super(e,"range");}};var m=class extends r{constructor(){super([],"reset");}};var d=class{client;constructor(e){this.client=e;}delete=e=>new i(e).exec(this.client);query=e=>new p(e).exec(this.client);upsert=e=>new c(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)};var R=class s extends d{constructor(e){if("request"in e){super(e);return}(e.url.startsWith(" ")||e.url.endsWith(" ")||/\r|\n/.test(e.url))&&console.warn("The vector url contains whitespace or newline, which can cause errors!"),(e.token.startsWith(" ")||e.token.endsWith(" ")||/\r|\n/.test(e.token))&&console.warn("The vector token contains whitespace or newline, which can cause errors!");let t=new a({baseUrl:e.url,retry:e.retry,headers:{authorization:`Bearer ${e.token}`},cache:e.cache||"no-store",signal:e.signal});super(t);}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 s({...e,url:t,token:o})}};
+var n=class extends Error{constructor(e){super(e),this.name="UpstashError";}};var a=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,f=null;for(let y=0;y<=this.retry.attempts;y++)try{o=await fetch([this.baseUrl,...e.path??[]].join("/"),t);break}catch(x){if(this.options.signal?.aborted){let b=new Blob([JSON.stringify({result:this.options.signal.reason??"Aborted"})]),g={status:200,statusText:this.options.signal.reason??"Aborted"};o=new Response(b,g);break}f=x,await new Promise(b=>setTimeout(b,this.retry.backoff(y)));}if(!o)throw f??new Error("Exhausted all retries");let h=await o.json();if(!o.ok)throw new n(`${h.error}, command was: ${JSON.stringify(e.body)}`);return {result:h.result,error:h.error}}};var r=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 n(o);if(typeof t>"u")throw new Error("Request did not return a result");return t}};var i=class extends r{constructor(e){let t=[];Array.isArray(e)?t.push(...e):t.push(e),super(t,"delete");}};var p=class extends r{constructor(e){super(e,"query");}};var c=class extends r{constructor(e){super(e,"upsert");}};var l=class extends r{constructor([e,t]){super({ids:e,...t},"fetch");}};var u=class extends r{constructor(e){super(e,"range");}};var m=class extends r{constructor(){super([],"reset");}};var d=class{client;constructor(e){this.client=e;}delete=e=>new i(e).exec(this.client);query=e=>new p(e).exec(this.client);upsert=e=>new c(e).exec(this.client);fetch=(...e)=>new l(e).exec(this.client);reset=()=>new m().exec(this.client);range=e=>new u(e).exec(this.client)};var R=class s extends d{constructor(e){if("request"in e){super(e);return}(e.url.startsWith(" ")||e.url.endsWith(" ")||/\r|\n/.test(e.url))&&console.warn("The vector url contains whitespace or newline, which can cause errors!"),(e.token.startsWith(" ")||e.token.endsWith(" ")||/\r|\n/.test(e.token))&&console.warn("The vector token contains whitespace or newline, which can cause errors!");let t=new a({baseUrl:e.url,retry:e.retry,headers:{authorization:`Bearer ${e.token}`},cache:e.cache||"no-store",signal:e.signal});super(t);}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 s({...e,url:t,token:o})}};
 
 exports.Index = R;

package/dist/index.mjs

@@ -1,3 +1,3 @@
-var n=class extends Error{constructor(e){super(e),this.name="UpstashError";}};var a=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,f=null;for(let y=0;y<=this.retry.attempts;y++)try{o=await fetch([this.baseUrl,...e.path??[]].join("/"),t);break}catch(x){if(this.options.signal?.aborted){let b=new Blob([JSON.stringify({result:this.options.signal.reason??"Aborted"})]),g={status:200,statusText:this.options.signal.reason??"Aborted"};o=new Response(b,g);break}f=x,await new Promise(b=>setTimeout(b,this.retry.backoff(y)));}if(!o)throw f??new Error("Exhausted all retries");let h=await o.json();if(!o.ok)throw new n(`${h.error}, command was: ${JSON.stringify(e.body)}`);return {result:h.result,error:h.error}}};var r=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 n(o);if(typeof t>"u")throw new Error("Request did not return a result");return t}};var i=class extends r{constructor(e){let t=[];Array.isArray(e)?t.push(...e):t.push(e),super(t,"delete");}};var p=class extends r{constructor(e){super(e,"query");}};var c=class extends r{constructor(e){super(e,"upsert");}};var u=class extends r{constructor([e,t]){super({ids:e,...t},"fetch");}};var l=class extends r{constructor(e){super(e,"range");}};var m=class extends r{constructor(){super([],"reset");}};var d=class{client;constructor(e){this.client=e;}delete=e=>new i(e).exec(this.client);query=e=>new p(e).exec(this.client);upsert=e=>new c(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)};var R=class s extends d{constructor(e){if("request"in e){super(e);return}(e.url.startsWith(" ")||e.url.endsWith(" ")||/\r|\n/.test(e.url))&&console.warn("The vector url contains whitespace or newline, which can cause errors!"),(e.token.startsWith(" ")||e.token.endsWith(" ")||/\r|\n/.test(e.token))&&console.warn("The vector token contains whitespace or newline, which can cause errors!");let t=new a({baseUrl:e.url,retry:e.retry,headers:{authorization:`Bearer ${e.token}`},cache:e.cache||"no-store",signal:e.signal});super(t);}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 s({...e,url:t,token:o})}};
+var n=class extends Error{constructor(e){super(e),this.name="UpstashError";}};var a=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,f=null;for(let y=0;y<=this.retry.attempts;y++)try{o=await fetch([this.baseUrl,...e.path??[]].join("/"),t);break}catch(x){if(this.options.signal?.aborted){let b=new Blob([JSON.stringify({result:this.options.signal.reason??"Aborted"})]),g={status:200,statusText:this.options.signal.reason??"Aborted"};o=new Response(b,g);break}f=x,await new Promise(b=>setTimeout(b,this.retry.backoff(y)));}if(!o)throw f??new Error("Exhausted all retries");let h=await o.json();if(!o.ok)throw new n(`${h.error}, command was: ${JSON.stringify(e.body)}`);return {result:h.result,error:h.error}}};var r=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 n(o);if(typeof t>"u")throw new Error("Request did not return a result");return t}};var i=class extends r{constructor(e){let t=[];Array.isArray(e)?t.push(...e):t.push(e),super(t,"delete");}};var p=class extends r{constructor(e){super(e,"query");}};var c=class extends r{constructor(e){super(e,"upsert");}};var l=class extends r{constructor([e,t]){super({ids:e,...t},"fetch");}};var u=class extends r{constructor(e){super(e,"range");}};var m=class extends r{constructor(){super([],"reset");}};var d=class{client;constructor(e){this.client=e;}delete=e=>new i(e).exec(this.client);query=e=>new p(e).exec(this.client);upsert=e=>new c(e).exec(this.client);fetch=(...e)=>new l(e).exec(this.client);reset=()=>new m().exec(this.client);range=e=>new u(e).exec(this.client)};var R=class s extends d{constructor(e){if("request"in e){super(e);return}(e.url.startsWith(" ")||e.url.endsWith(" ")||/\r|\n/.test(e.url))&&console.warn("The vector url contains whitespace or newline, which can cause errors!"),(e.token.startsWith(" ")||e.token.endsWith(" ")||/\r|\n/.test(e.token))&&console.warn("The vector token contains whitespace or newline, which can cause errors!");let t=new a({baseUrl:e.url,retry:e.retry,headers:{authorization:`Bearer ${e.token}`},cache:e.cache||"no-store",signal:e.signal});super(t);}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 s({...e,url:t,token:o})}};
 
 export { R as Index };

package/package.json

@@ -3,20 +3,8 @@
   "description": "An HTTP/REST based Vector DB client built on top of Upstash REST API.",
   "module": "./dist/index.mjs",
   "main": "./dist/index.js",
-  "version": "v0.1.0-alpha-3",
-  "exports": {
-    ".": {
-      "import": "./nodejs.js",
-      "require": "./nodejs.mjs"
-    },
-    "./node": {
-      "import": "./nodejs.js",
-      "require": "./nodejs.mjs"
-    },
-    "./node.js": "./node.js",
-    "./node.mjs": "./node.mjs"
-  },
-  "types": "./nodejs.d.ts",
+  "types": "./dist/index.d.ts",
+  "version": "v0.1.0-alpha-5",
   "keywords": [
     "vector",
     "upstash",