@upstash/redis 0.0.0-ci.9190cbfb-20230208 → 0.0.0-ci.97cb5577-20231010

package/esm/pkg/commands/json_forget.js

@@ -4,6 +4,6 @@ import { Command } from "./command.js";
  */
 export class JsonForgetCommand extends Command {
     constructor(cmd, opts) {
-        super(["JSON.DEL", ...cmd], opts);
+        super(["JSON.FORGET", ...cmd], opts);
     }
 }

package/esm/pkg/commands/mod.js

@@ -120,6 +120,7 @@ export * from "./touch.js";
 export * from "./ttl.js";
 export * from "./type.js";
 export * from "./unlink.js";
+export * from "./xadd.js";
 export * from "./zadd.js";
 export * from "./zcard.js";
 export * from "./zcount.js";

package/esm/pkg/commands/set.js

@@ -28,7 +28,7 @@ export class SetCommand extends Command {
                 command.push("pxat", opts.pxat);
             }
             else if ("keepTtl" in opts && opts.keepTtl) {
-                command.push("keepTtl", opts.keepTtl);
+                command.push("keepTtl");
             }
         }
         super(command, cmdOpts);

package/esm/pkg/commands/xadd.js

@@ -0,0 +1,26 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/xadd
+ */
+export class XAddCommand extends Command {
+    constructor([key, id, entries, opts], commandOptions) {
+        const command = ["XADD", key];
+        if (opts) {
+            if (opts.nomkStream) {
+                command.push("NOMKSTREAM");
+            }
+            if (opts.trim) {
+                command.push(opts.trim.type, opts.trim.comparison, opts.trim.threshold);
+                if (typeof opts.trim.limit !== "undefined") {
+                    command.push("LIMIT", opts.trim.limit);
+                }
+            }
+        }
+        command.push(id);
+        // entries
+        Object.entries(entries).forEach(([k, v]) => {
+            command.push(k, v);
+        });
+        super(command, commandOptions);
+    }
+}

package/esm/pkg/http.js

@@ -28,7 +28,8 @@ export class HttpClient {
         this.options = {
             backend: config.options?.backend,
             agent: config.agent,
-            responseEncoding: config.responseEncoding ?? "base64", // default to base64
+            responseEncoding: config.responseEncoding ?? "base64",
+            cache: config.cache,
         };
         this.baseUrl = config.baseUrl.replace(/\/$/, "");
         this.headers = {
@@ -71,6 +72,7 @@ export class HttpClient {
     }
     async request(req) {
         const requestOptions = {
+            cache: this.options.cache,
             method: "POST",
             headers: this.headers,
             body: JSON.stringify(req.body),
@@ -98,10 +100,17 @@ export class HttpClient {
         }
         const body = (await res.json());
         if (!res.ok) {
-            throw new UpstashError(body.error);
+            throw new UpstashError(`${body.error}, command was: ${JSON.stringify(req.body)}`);
         }
         if (this.options?.responseEncoding === "base64") {
-            return Array.isArray(body) ? body.map(decode) : decode(body);
+            if (Array.isArray(body)) {
+                return body.map(({ result, error }) => ({
+                    result: decode(result),
+                    error,
+                }));
+            }
+            const result = decode(body.result);
+            return { result, error: body.error };
         }
         return body;
     }
@@ -132,19 +141,19 @@ function base64decode(b64) {
 }
 function decode(raw) {
     let result = undefined;
-    switch (typeof raw.result) {
+    switch (typeof raw) {
         case "undefined":
             return raw;
         case "number": {
-            result = raw.result;
+            result = raw;
             break;
         }
         case "object": {
-            if (Array.isArray(raw.result)) {
-                result = raw.result.map((v) => typeof v === "string"
+            if (Array.isArray(raw)) {
+                result = raw.map((v) => typeof v === "string"
                     ? base64decode(v)
                     : Array.isArray(v)
-                        ? v.map(base64decode)
+                        ? v.map(decode)
                         : v);
             }
             else {
@@ -155,11 +164,11 @@ function decode(raw) {
             break;
         }
         case "string": {
-            result = raw.result === "OK" ? "OK" : base64decode(raw.result);
+            result = raw === "OK" ? "OK" : base64decode(raw);
             break;
         }
         default:
             break;
     }
-    return { result, error: raw.error };
+    return result;
 }

package/esm/pkg/pipeline.js

@@ -31,7 +31,7 @@ import { ZDiffStoreCommand } from "./commands/zdiffstore.js";
  * const res = await p.set("key","value").get("key").exec()
  * ```
  *
- * It's not possible to infer correct types with a dynamic pipeline, so you can
+ * Return types are inferred if all commands are chained, but you can still
  * override the response type manually:
  * ```ts
  *  redis.pipeline()
@@ -72,9 +72,11 @@ export class Pipeline {
          *
          * Returns an array with the results of all pipelined commands.
          *
-         * You can define a return type manually to make working in typescript easier
+         * If all commands are statically chained from start to finish, types are inferred. You can still define a return type manually if necessary though:
          * ```ts
-         * redis.pipeline().get("key").exec<[{ greeting: string }]>()
+         * const p = redis.pipeline()
+         * p.get("key")
+         * const result = p.exec<[{ greeting: string }]>()
          * ```
          */
         Object.defineProperty(this, "exec", {
@@ -90,6 +92,7 @@ export class Pipeline {
                     path,
                     body: Object.values(this.commands).map((c) => c.command),
                 }));
+                console.log("after req", { res });
                 return res.map(({ error, result }, i) => {
                     if (error) {
                         throw new UpstashError(`Command ${i + 1} [ ${this.commands[i].command[0]} ] failed: ${error}`);
@@ -1184,23 +1187,22 @@ export class Pipeline {
             value: (...args) => this.chain(new ZUnionStoreCommand(args, this.commandOptions))
         });
         this.client = opts.client;
-        this.commands = [];
+        this.commands = []; // the TCommands generic in the class definition is only used for carrying through chained command types and should never be explicitly set when instantiating the class
         this.commandOptions = opts.commandOptions;
         this.multiExec = opts.multiExec ?? false;
     }
     /**
-     * Pushes a command into the pipelien and returns a chainable instance of the
+     * Pushes a command into the pipeline and returns a chainable instance of the
      * pipeline
      */
     chain(command) {
         this.commands.push(command);
-        return this;
+        return this; // TS thinks we're returning Pipeline<[]> here, because we're not creating a new instance of the class, hence the cast
     }
     /**
      * @see https://redis.io/commands/?group=json
      */
     get json() {
-        // For some reason we needed to define the types manually, otherwise Deno wouldn't build it
         return {
             /**
              * @see https://redis.io/commands/json.arrappend

package/esm/pkg/redis.js

@@ -1005,6 +1005,10 @@ export class Redis {
             writable: true,
             value: (...args) => new UnlinkCommand(args, this.opts).exec(this.client)
         });
+        // /**
+        //  * @see https://redis.io/commands/xadd
+        //  */
+        // xadd =
         /**
          * @see https://redis.io/commands/zadd
          */

package/esm/platforms/nodejs.js

@@ -35,13 +35,16 @@ export class Redis extends core.Redis {
             headers: { authorization: `Bearer ${configOrRequester.token}` },
             agent: configOrRequester.agent,
             responseEncoding: configOrRequester.responseEncoding,
+            cache: configOrRequester.cache || "no-store",
         });
         super(client, {
             automaticDeserialization: configOrRequester.automaticDeserialization,
             enableTelemetry: !process.env.UPSTASH_DISABLE_TELEMETRY,
         });
         this.addTelemetry({
-            runtime: `node@${process.version}`,
+            runtime: typeof EdgeRuntime === "string"
+                ? "edge-light"
+                : `node@${process.version}`,
             platform: process.env.VERCEL
                 ? "vercel"
                 : process.env.AWS_REGION

package/esm/version.js

@@ -1 +1 @@
-export const VERSION = "v0.0.0-ci.9190cbfb-20230208";
+export const VERSION = "v0.0.0-ci.97cb5577-20231010";

package/package.json

@@ -3,7 +3,7 @@
   "main": "./script/platforms/nodejs.js",
   "types": "./types/platforms/nodejs.d.ts",
   "name": "@upstash/redis",
-  "version": "v0.0.0-ci.9190cbfb-20230208",
+  "version": "v0.0.0-ci.97cb5577-20231010",
   "description": "An HTTP/REST based Redis client built on top of Upstash REST API.",
   "repository": {
     "type": "git",
@@ -27,10 +27,18 @@
   },
   "typesVersions": {
     "*": {
-      "nodejs": "./types/platforms/nodejs.d.ts",
-      "cloudflare": "./types/platforms/cloudflare.d.ts",
-      "fastly": "./types/platforms/fastly.d.ts",
-      "with-fetch": "./types/platforms/node_with_fetch.d.ts"
+      "nodejs": [
+        "./types/platforms/nodejs.d.ts"
+      ],
+      "cloudflare": [
+        "./types/platforms/cloudflare.d.ts"
+      ],
+      "fastly": [
+        "./types/platforms/fastly.d.ts"
+      ],
+      "with-fetch": [
+        "./types/platforms/node_with_fetch.d.ts"
+      ]
     }
   },
   "exports": {

package/script/pkg/commands/json_forget.js

@@ -7,7 +7,7 @@ const command_js_1 = require("./command.js");
  */
 class JsonForgetCommand extends command_js_1.Command {
     constructor(cmd, opts) {
-        super(["JSON.DEL", ...cmd], opts);
+        super(["JSON.FORGET", ...cmd], opts);
     }
 }
 exports.JsonForgetCommand = JsonForgetCommand;

package/script/pkg/commands/mod.js

@@ -136,6 +136,7 @@ __exportStar(require("./touch.js"), exports);
 __exportStar(require("./ttl.js"), exports);
 __exportStar(require("./type.js"), exports);
 __exportStar(require("./unlink.js"), exports);
+__exportStar(require("./xadd.js"), exports);
 __exportStar(require("./zadd.js"), exports);
 __exportStar(require("./zcard.js"), exports);
 __exportStar(require("./zcount.js"), exports);

package/script/pkg/commands/set.js

@@ -31,7 +31,7 @@ class SetCommand extends command_js_1.Command {
                 command.push("pxat", opts.pxat);
             }
             else if ("keepTtl" in opts && opts.keepTtl) {
-                command.push("keepTtl", opts.keepTtl);
+                command.push("keepTtl");
             }
         }
         super(command, cmdOpts);

package/script/pkg/commands/xadd.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.XAddCommand = void 0;
+const command_js_1 = require("./command.js");
+/**
+ * @see https://redis.io/commands/xadd
+ */
+class XAddCommand extends command_js_1.Command {
+    constructor([key, id, entries, opts], commandOptions) {
+        const command = ["XADD", key];
+        if (opts) {
+            if (opts.nomkStream) {
+                command.push("NOMKSTREAM");
+            }
+            if (opts.trim) {
+                command.push(opts.trim.type, opts.trim.comparison, opts.trim.threshold);
+                if (typeof opts.trim.limit !== "undefined") {
+                    command.push("LIMIT", opts.trim.limit);
+                }
+            }
+        }
+        command.push(id);
+        // entries
+        Object.entries(entries).forEach(([k, v]) => {
+            command.push(k, v);
+        });
+        super(command, commandOptions);
+    }
+}
+exports.XAddCommand = XAddCommand;

package/script/pkg/http.js

@@ -31,7 +31,8 @@ class HttpClient {
         this.options = {
             backend: config.options?.backend,
             agent: config.agent,
-            responseEncoding: config.responseEncoding ?? "base64", // default to base64
+            responseEncoding: config.responseEncoding ?? "base64",
+            cache: config.cache,
         };
         this.baseUrl = config.baseUrl.replace(/\/$/, "");
         this.headers = {
@@ -74,6 +75,7 @@ class HttpClient {
     }
     async request(req) {
         const requestOptions = {
+            cache: this.options.cache,
             method: "POST",
             headers: this.headers,
             body: JSON.stringify(req.body),
@@ -101,10 +103,17 @@ class HttpClient {
         }
         const body = (await res.json());
         if (!res.ok) {
-            throw new error_js_1.UpstashError(body.error);
+            throw new error_js_1.UpstashError(`${body.error}, command was: ${JSON.stringify(req.body)}`);
         }
         if (this.options?.responseEncoding === "base64") {
-            return Array.isArray(body) ? body.map(decode) : decode(body);
+            if (Array.isArray(body)) {
+                return body.map(({ result, error }) => ({
+                    result: decode(result),
+                    error,
+                }));
+            }
+            const result = decode(body.result);
+            return { result, error: body.error };
         }
         return body;
     }
@@ -136,19 +145,19 @@ function base64decode(b64) {
 }
 function decode(raw) {
     let result = undefined;
-    switch (typeof raw.result) {
+    switch (typeof raw) {
         case "undefined":
             return raw;
         case "number": {
-            result = raw.result;
+            result = raw;
             break;
         }
         case "object": {
-            if (Array.isArray(raw.result)) {
-                result = raw.result.map((v) => typeof v === "string"
+            if (Array.isArray(raw)) {
+                result = raw.map((v) => typeof v === "string"
                     ? base64decode(v)
                     : Array.isArray(v)
-                        ? v.map(base64decode)
+                        ? v.map(decode)
                         : v);
             }
             else {
@@ -159,11 +168,11 @@ function decode(raw) {
             break;
         }
         case "string": {
-            result = raw.result === "OK" ? "OK" : base64decode(raw.result);
+            result = raw === "OK" ? "OK" : base64decode(raw);
             break;
         }
         default:
             break;
     }
-    return { result, error: raw.error };
+    return result;
 }

package/script/pkg/pipeline.js

@@ -34,7 +34,7 @@ const zdiffstore_js_1 = require("./commands/zdiffstore.js");
  * const res = await p.set("key","value").get("key").exec()
  * ```
  *
- * It's not possible to infer correct types with a dynamic pipeline, so you can
+ * Return types are inferred if all commands are chained, but you can still
  * override the response type manually:
  * ```ts
  *  redis.pipeline()
@@ -75,9 +75,11 @@ class Pipeline {
          *
          * Returns an array with the results of all pipelined commands.
          *
-         * You can define a return type manually to make working in typescript easier
+         * If all commands are statically chained from start to finish, types are inferred. You can still define a return type manually if necessary though:
          * ```ts
-         * redis.pipeline().get("key").exec<[{ greeting: string }]>()
+         * const p = redis.pipeline()
+         * p.get("key")
+         * const result = p.exec<[{ greeting: string }]>()
          * ```
          */
         Object.defineProperty(this, "exec", {
@@ -93,6 +95,7 @@ class Pipeline {
                     path,
                     body: Object.values(this.commands).map((c) => c.command),
                 }));
+                console.log("after req", { res });
                 return res.map(({ error, result }, i) => {
                     if (error) {
                         throw new error_js_1.UpstashError(`Command ${i + 1} [ ${this.commands[i].command[0]} ] failed: ${error}`);
@@ -1187,23 +1190,22 @@ class Pipeline {
             value: (...args) => this.chain(new mod_js_1.ZUnionStoreCommand(args, this.commandOptions))
         });
         this.client = opts.client;
-        this.commands = [];
+        this.commands = []; // the TCommands generic in the class definition is only used for carrying through chained command types and should never be explicitly set when instantiating the class
         this.commandOptions = opts.commandOptions;
         this.multiExec = opts.multiExec ?? false;
     }
     /**
-     * Pushes a command into the pipelien and returns a chainable instance of the
+     * Pushes a command into the pipeline and returns a chainable instance of the
      * pipeline
      */
     chain(command) {
         this.commands.push(command);
-        return this;
+        return this; // TS thinks we're returning Pipeline<[]> here, because we're not creating a new instance of the class, hence the cast
     }
     /**
      * @see https://redis.io/commands/?group=json
      */
     get json() {
-        // For some reason we needed to define the types manually, otherwise Deno wouldn't build it
         return {
             /**
              * @see https://redis.io/commands/json.arrappend

package/script/pkg/redis.js

@@ -1008,6 +1008,10 @@ class Redis {
             writable: true,
             value: (...args) => new mod_js_1.UnlinkCommand(args, this.opts).exec(this.client)
         });
+        // /**
+        //  * @see https://redis.io/commands/xadd
+        //  */
+        // xadd =
         /**
          * @see https://redis.io/commands/zadd
          */

package/script/platforms/nodejs.js

@@ -61,13 +61,16 @@ class Redis extends core.Redis {
             headers: { authorization: `Bearer ${configOrRequester.token}` },
             agent: configOrRequester.agent,
             responseEncoding: configOrRequester.responseEncoding,
+            cache: configOrRequester.cache || "no-store",
         });
         super(client, {
             automaticDeserialization: configOrRequester.automaticDeserialization,
             enableTelemetry: !process.env.UPSTASH_DISABLE_TELEMETRY,
         });
         this.addTelemetry({
-            runtime: `node@${process.version}`,
+            runtime: typeof EdgeRuntime === "string"
+                ? "edge-light"
+                : `node@${process.version}`,
             platform: process.env.VERCEL
                 ? "vercel"
                 : process.env.AWS_REGION

package/script/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = "v0.0.0-ci.9190cbfb-20230208";
+exports.VERSION = "v0.0.0-ci.97cb5577-20231010";

package/types/pkg/commands/hdel.d.ts

@@ -3,5 +3,5 @@ import { Command, CommandOptions } from "./command.js";
  * @see https://redis.io/commands/hdel
  */
 export declare class HDelCommand extends Command<"0" | "1", 0 | 1> {
-    constructor(cmd: [key: string, field: string], opts?: CommandOptions<"0" | "1", 0 | 1>);
+    constructor(cmd: [key: string, ...fields: string[]], opts?: CommandOptions<"0" | "1", 0 | 1>);
 }

package/types/pkg/commands/mod.d.ts

@@ -120,6 +120,7 @@ export * from "./touch.js";
 export * from "./ttl.js";
 export * from "./type.js";
 export * from "./unlink.js";
+export * from "./xadd.js";
 export * from "./zadd.js";
 export * from "./zcard.js";
 export * from "./zcount.js";

package/types/pkg/commands/set.d.ts

@@ -1,7 +1,7 @@
 import { Command, CommandOptions } from "./command.js";
 export type SetCommandOptions = {
-    get: boolean;
-} | ({
+    get?: boolean;
+} & ({
     ex: number;
     px?: never;
     exat?: never;

package/types/pkg/commands/xadd.d.ts

@@ -0,0 +1,31 @@
+import { Command, CommandOptions } from "./command.js";
+type XAddCommandOptions = {
+    nomkStream?: boolean;
+    trim?: ({
+        type: "MAXLEN" | "maxlen";
+        threshold: number;
+    } | {
+        type: "MINID" | "minid";
+        threshold: string;
+    }) & ({
+        comparison: "~";
+        limit?: number;
+    } | {
+        comparison: "=";
+        limit?: never;
+    });
+};
+/**
+ * @see https://redis.io/commands/xadd
+ */
+export declare class XAddCommand extends Command<string, string> {
+    constructor([key, id, entries, opts]: [
+        key: string,
+        id: "*" | string,
+        entries: {
+            [field: string]: unknown;
+        },
+        opts?: XAddCommandOptions
+    ], commandOptions?: CommandOptions<string, string>);
+}
+export {};

package/types/pkg/http.d.ts

@@ -1,4 +1,5 @@
 import { Telemetry } from "./types.js";
+type CacheSetting = "default" | "force-cache" | "no-cache" | "no-store" | "only-if-cached" | "reload";
 export type UpstashRequest = {
     path?: string[];
     /**
@@ -61,6 +62,11 @@ export type RequesterConfig = {
      * @default "base64"
      */
     responseEncoding?: false | "base64";
+    /**
+     * Configure the cache behaviour
+     * @default "no-store"
+     */
+    cache?: CacheSetting;
 };
 export type HttpClientConfig = {
     headers?: Record<string, string>;
@@ -76,6 +82,7 @@ export declare class HttpClient implements Requester {
         backend?: string;
         agent: any;
         responseEncoding?: false | "base64";
+        cache?: CacheSetting;
     };
     readonly retry: {
         attempts: number;
@@ -85,3 +92,4 @@ export declare class HttpClient implements Requester {
     mergeTelemetry(telemetry: Telemetry): void;
     request<TResult>(req: UpstashRequest): Promise<UpstashResponse<TResult>>;
 }
+export {};