@upstash/redis 0.0.0-ci.c37cc01e → 0.0.0-ci.c586e271-20221116

package/script/pkg/commands/set.js

@@ -9,17 +9,29 @@ class SetCommand extends command_js_1.Command {
     constructor([key, value, opts], cmdOpts) {
         const command = ["set", key, value];
         if (opts) {
+            if ("nx" in opts && opts.nx) {
+                command.push("nx");
+            }
+            else if ("xx" in opts && opts.xx) {
+                command.push("xx");
+            }
+            if ("get" in opts && opts.get) {
+                command.push("get");
+            }
             if ("ex" in opts && typeof opts.ex === "number") {
                 command.push("ex", opts.ex);
             }
             else if ("px" in opts && typeof opts.px === "number") {
                 command.push("px", opts.px);
             }
-            if ("nx" in opts && opts.nx) {
-                command.push("nx");
+            else if ("exat" in opts && typeof opts.exat === "number") {
+                command.push("exat", opts.exat);
             }
-            else if ("xx" in opts && opts.xx) {
-                command.push("xx");
+            else if ("pxat" in opts && typeof opts.pxat === "number") {
+                command.push("pxat", opts.pxat);
+            }
+            else if ("keepTtl" in opts && opts.keepTtl) {
+                command.push("keepTtl", opts.keepTtl);
             }
         }
         super(command, cmdOpts);

package/script/pkg/commands/zmscore.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZMScoreCommand = void 0;
+const command_js_1 = require("./command.js");
+/**
+ * @see https://redis.io/commands/zmscore
+ */
+class ZMScoreCommand extends command_js_1.Command {
+    constructor(cmd, opts) {
+        const [key, members] = cmd;
+        super(["zmscore", key, ...members], opts);
+    }
+}
+exports.ZMScoreCommand = ZMScoreCommand;

package/script/pkg/http.js

@@ -28,9 +28,19 @@ class HttpClient {
             writable: true,
             value: void 0
         });
+        this.options = {
+            backend: config.options?.backend,
+            agent: config.agent,
+            responseEncoding: config.responseEncoding ?? "base64", // default to base64
+        };
         this.baseUrl = config.baseUrl.replace(/\/$/, "");
-        this.headers = { "Content-Type": "application/json", ...config.headers };
-        this.options = { backend: config.options?.backend };
+        this.headers = {
+            "Content-Type": "application/json",
+            ...config.headers,
+        };
+        if (this.options.responseEncoding === "base64") {
+            this.headers["Upstash-Encoding"] = "base64";
+        }
         if (typeof config?.retry === "boolean" && config?.retry === false) {
             this.retry = {
                 attempts: 1,
@@ -51,6 +61,7 @@ class HttpClient {
             headers: this.headers,
             body: JSON.stringify(req.body),
             keepalive: true,
+            agent: this.options?.agent,
             /**
              * Fastly specific
              */
@@ -75,7 +86,67 @@ class HttpClient {
         if (!res.ok) {
             throw new error_js_1.UpstashError(body.error);
         }
+        if (this.options?.responseEncoding === "base64") {
+            return Array.isArray(body) ? body.map(decode) : decode(body);
+        }
         return body;
     }
 }
 exports.HttpClient = HttpClient;
+function base64decode(b64) {
+    let dec = "";
+    try {
+        /**
+         * Using only atob() is not enough because it doesn't work with unicode characters
+         */
+        const binString = atob(b64);
+        const size = binString.length;
+        const bytes = new Uint8Array(size);
+        for (let i = 0; i < size; i++) {
+            bytes[i] = binString.charCodeAt(i);
+        }
+        dec = new TextDecoder().decode(bytes);
+    }
+    catch {
+        dec = b64;
+    }
+    try {
+        return decodeURIComponent(dec);
+    }
+    catch {
+        return dec;
+    }
+}
+function decode(raw) {
+    let result = undefined;
+    switch (typeof raw.result) {
+        case "undefined":
+            return raw;
+        case "number": {
+            result = raw.result;
+            break;
+        }
+        case "object": {
+            if (Array.isArray(raw.result)) {
+                result = raw.result.map((v) => typeof v === "string"
+                    ? base64decode(v)
+                    : Array.isArray(v)
+                        ? v.map(base64decode)
+                        : v);
+            }
+            else {
+                // If it's not an array it must be null
+                // Apparently null is an object in javascript
+                result = null;
+            }
+            break;
+        }
+        case "string": {
+            result = raw.result === "OK" ? "OK" : base64decode(raw.result);
+            break;
+        }
+        default:
+            break;
+    }
+    return { result, error: raw.error };
+}

package/script/pkg/pipeline.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Pipeline = void 0;
 const mod_js_1 = require("./commands/mod.js");
 const error_js_1 = require("./error.js");
+const zmscore_js_1 = require("./commands/zmscore.js");
 /**
  * Upstash REST API supports command pipelining to send multiple commands in
  * batch, instead of sending each command one by one and waiting for a response.
@@ -19,7 +20,7 @@ const error_js_1 = require("./error.js");
  * **Examples:**
  *
  * ```ts
- *  const p = redis.pipeline()
+ *  const p = redis.pipeline() // or redis.multi()
  * p.set("key","value")
  * p.get("key")
  * const res = await p.exec()
@@ -42,7 +43,7 @@ const error_js_1 = require("./error.js");
  * ```
  */
 class Pipeline {
-    constructor(client, commandOptions) {
+    constructor(opts) {
         Object.defineProperty(this, "client", {
             enumerable: true,
             configurable: true,
@@ -61,6 +62,12 @@ class Pipeline {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "multiExec", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         /**
          * Send the pipeline request to upstash.
          *
@@ -79,8 +86,9 @@ class Pipeline {
                 if (this.commands.length === 0) {
                     throw new Error("Pipeline is empty");
                 }
+                const path = this.multiExec ? ["multi-exec"] : ["pipeline"];
                 const res = (await this.client.request({
-                    path: ["pipeline"],
+                    path,
                     body: Object.values(this.commands).map((c) => c.command),
                 }));
                 return res.map(({ error, result }, i) => {
@@ -253,6 +261,15 @@ class Pipeline {
             writable: true,
             value: (...args) => this.chain(new mod_js_1.GetBitCommand(args, this.commandOptions))
         });
+        /**
+         * @see https://redis.io/commands/getdel
+         */
+        Object.defineProperty(this, "getdel", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => this.chain(new mod_js_1.GetDelCommand(args, this.commandOptions))
+        });
         /**
          * @see https://redis.io/commands/getrange
          */
@@ -1014,6 +1031,15 @@ class Pipeline {
             writable: true,
             value: (...args) => this.chain(new mod_js_1.ZLexCountCommand(args, this.commandOptions))
         });
+        /**
+         * @see https://redis.io/commands/zmscore
+         */
+        Object.defineProperty(this, "zmscore", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => this.chain(new zmscore_js_1.ZMScoreCommand(args, this.commandOptions))
+        });
         /**
          * @see https://redis.io/commands/zpopmax
          */
@@ -1122,9 +1148,10 @@ class Pipeline {
             writable: true,
             value: (...args) => this.chain(new mod_js_1.ZUnionStoreCommand(args, this.commandOptions))
         });
-        this.client = client;
+        this.client = opts.client;
         this.commands = [];
-        this.commandOptions = commandOptions;
+        this.commandOptions = opts.commandOptions;
+        this.multiExec = opts.multiExec ?? false;
     }
     /**
      * Pushes a command into the pipelien and returns a chainable instance of the

package/script/pkg/redis.js

@@ -3,6 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Redis = void 0;
 const mod_js_1 = require("./commands/mod.js");
 const pipeline_js_1 = require("./pipeline.js");
+const script_js_1 = require("./script.js");
+const zmscore_js_1 = require("./commands/zmscore.js");
 /**
  * Serverless redis client for upstash.
  */
@@ -52,7 +54,30 @@ class Redis {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: () => new pipeline_js_1.Pipeline(this.client, this.opts)
+            value: () => new pipeline_js_1.Pipeline({
+                client: this.client,
+                commandOptions: this.opts,
+                multiExec: false,
+            })
+        });
+        /**
+         * Create a new transaction to allow executing multiple steps atomically.
+         *
+         * All the commands in a transaction are serialized and executed sequentially. A request sent by
+         * another client will never be served in the middle of the execution of a Redis Transaction. This
+         * guarantees that the commands are executed as a single isolated operation.
+         *
+         * @see {@link Pipeline}
+         */
+        Object.defineProperty(this, "multi", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: () => new pipeline_js_1.Pipeline({
+                client: this.client,
+                commandOptions: this.opts,
+                multiExec: true,
+            })
         });
         /**
          * @see https://redis.io/commands/append
@@ -216,6 +241,15 @@ class Redis {
             writable: true,
             value: (...args) => new mod_js_1.GetBitCommand(args, this.opts).exec(this.client)
         });
+        /**
+         * @see https://redis.io/commands/getdel
+         */
+        Object.defineProperty(this, "getdel", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => new mod_js_1.GetDelCommand(args, this.opts).exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/getrange
          */
@@ -977,6 +1011,15 @@ class Redis {
             writable: true,
             value: (...args) => new mod_js_1.ZLexCountCommand(args, this.opts).exec(this.client)
         });
+        /**
+         * @see https://redis.io/commands/zmscore
+         */
+        Object.defineProperty(this, "zmscore", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => new zmscore_js_1.ZMScoreCommand(args, this.opts).exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/zpopmax
          */
@@ -1088,5 +1131,8 @@ class Redis {
         this.client = client;
         this.opts = opts;
     }
+    createScript(script) {
+        return new script_js_1.Script(this, script);
+    }
 }
 exports.Redis = Redis;

package/script/pkg/script.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Script = void 0;
+const mod_js_1 = require("../deps/deno.land/x/sha1@v1.0.3/mod.js");
+/**
+ * Creates a new script.
+ *
+ * Scripts offer the ability to optimistically try to execute a script without having to send the
+ * entire script to the server. If the script is loaded on the server, it tries again by sending
+ * the entire script. Afterwards, the script is cached on the server.
+ *
+ * @example
+ * ```ts
+ * const redis = new Redis({...})
+ *
+ * const script = redis.createScript<string>("return ARGV[1];")
+ * const arg1 = await script.eval([], ["Hello World"])
+ * assertEquals(arg1, "Hello World")
+ * ```
+ */
+class Script {
+    constructor(redis, script) {
+        Object.defineProperty(this, "script", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "sha1", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "redis", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.redis = redis;
+        this.sha1 = this.digest(script);
+        this.script = script;
+    }
+    /**
+     * Send an `EVAL` command to redis.
+     */
+    async eval(keys, args) {
+        return await this.redis.eval(this.script, keys, args);
+    }
+    /**
+     * Calculates the sha1 hash of the script and then calls `EVALSHA`.
+     */
+    async evalsha(keys, args) {
+        return await this.redis.evalsha(this.sha1, keys, args);
+    }
+    /**
+     * Optimistically try to run `EVALSHA` first.
+     * If the script is not loaded in redis, it will fall back and try again with `EVAL`.
+     *
+     * Following calls will be able to use the cached script
+     */
+    async exec(keys, args) {
+        const res = await this.redis.evalsha(this.sha1, keys, args).catch(async (err) => {
+            if (err instanceof Error &&
+                err.message.toLowerCase().includes("noscript")) {
+                return await this.redis.eval(this.script, keys, args);
+            }
+            throw err;
+        });
+        return res;
+    }
+    /**
+     * Compute the sha1 hash of the script and return its hex representation.
+     */
+    digest(s) {
+        const hash = (0, mod_js_1.sha1)(s, "utf8", "hex");
+        return typeof hash === "string" ? hash : new TextDecoder().decode(hash);
+    }
+}
+exports.Script = Script;

package/script/platforms/cloudflare.js

@@ -56,6 +56,7 @@ class Redis extends core.Redis {
             retry: config.retry,
             baseUrl: config.url,
             headers: { authorization: `Bearer ${config.token}` },
+            responseEncoding: config.responseEncoding,
         });
         super(client, {
             automaticDeserialization: config.automaticDeserialization,

package/script/platforms/fastly.js

@@ -58,6 +58,7 @@ class Redis extends core.Redis {
             retry: config.retry,
             headers: { authorization: `Bearer ${config.token}` },
             options: { backend: config.backend },
+            responseEncoding: config.responseEncoding,
         });
         super(client, {
             automaticDeserialization: config.automaticDeserialization,

package/script/platforms/node_with_fetch.js

@@ -51,7 +51,8 @@ class Redis extends core.Redis {
             baseUrl: configOrRequester.url,
             retry: configOrRequester.retry,
             headers: { authorization: `Bearer ${configOrRequester.token}` },
-            // agent: configOrRequester.agent,
+            //  agent: configOrRequester.agent,
+            responseEncoding: configOrRequester.responseEncoding,
         });
         super(client, {
             automaticDeserialization: configOrRequester.automaticDeserialization,

package/script/platforms/nodejs.js

@@ -50,7 +50,8 @@ class Redis extends core.Redis {
             baseUrl: configOrRequester.url,
             retry: configOrRequester.retry,
             headers: { authorization: `Bearer ${configOrRequester.token}` },
-            // agent: configOrRequester.agent,
+            agent: configOrRequester.agent,
+            responseEncoding: configOrRequester.responseEncoding,
         });
         super(client, {
             automaticDeserialization: configOrRequester.automaticDeserialization,

package/types/deps/deno.land/x/base64@v0.2.1/base.d.ts

@@ -0,0 +1,5 @@
+export declare function init(lookup: string[], revLookup: number[], urlsafe?: boolean): {
+    byteLength(b64: string): number;
+    toUint8Array(b64: string): Uint8Array;
+    fromUint8Array(buf: Uint8Array): string;
+};

package/types/deps/deno.land/x/base64@v0.2.1/base64url.d.ts

@@ -0,0 +1 @@
+export declare const byteLength: (b64: string) => number, toUint8Array: (b64: string) => Uint8Array, fromUint8Array: (buf: Uint8Array) => string;

package/types/deps/deno.land/x/sha1@v1.0.3/deps.d.ts

@@ -0,0 +1 @@
+export { encode, decode } from "../../../denopkg.com/chiefbiiko/std-encoding@v1.0.0/mod.js";

package/types/deps/deno.land/x/sha1@v1.0.3/mod.d.ts

@@ -0,0 +1,26 @@
+/** Byte length of a SHA1 digest. */
+export declare const BYTES: number;
+/**  A class representation of the SHA1 algorithm. */
+export declare class SHA1 {
+    readonly hashSize: number;
+    private _buf;
+    private _bufIdx;
+    private _count;
+    private _K;
+    private _H;
+    private _finalized;
+    /** Creates a SHA1 instance. */
+    constructor();
+    /** Reduces the four input numbers to a single one. */
+    protected static F(t: number, b: number, c: number, d: number): number;
+    /** Initializes a hash instance. */
+    init(): SHA1;
+    /** Updates a hash with additional message data. */
+    update(msg: string | Uint8Array, inputEncoding?: string): SHA1;
+    /** Finalizes a hash with additional message data. */
+    digest(outputEncoding?: string): string | Uint8Array;
+    /** Performs one transformation cycle. */
+    private transform;
+}
+/** Generates a SHA1 hash of the input data. */
+export declare function sha1(msg: string | Uint8Array, inputEncoding?: string, outputEncoding?: string): string | Uint8Array;

package/types/deps/denopkg.com/chiefbiiko/std-encoding@v1.0.0/mod.d.ts

@@ -0,0 +1,3 @@
+/** Decodes a Uint8Array to utf8-, base64-, or hex-encoded string. */
+export declare function decode(buf: Uint8Array, encoding?: string): string;
+export declare function encode(str: string, encoding?: string): Uint8Array;

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

@@ -0,0 +1,7 @@
+import { Command, CommandOptions } from "./command.js";
+/**
+ * @see https://redis.io/commands/getdel
+ */
+export declare class GetDelCommand<TData = string> extends Command<unknown | null, TData | null> {
+    constructor(cmd: [key: string], opts?: CommandOptions<unknown | null, TData | null>);
+}

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

@@ -19,6 +19,7 @@ export * from "./get.js";
 export * from "./getbit.js";
 export * from "./getrange.js";
 export * from "./getset.js";
+export * from "./getdel.js";
 export * from "./hdel.js";
 export * from "./hexists.js";
 export * from "./hget.js";

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

@@ -2,6 +2,7 @@ import { Command, CommandOptions } from "./command.js";
 export declare type ScanCommandOptions = {
     match?: string;
     count?: number;
+    type?: string;
 };
 /**
  * @see https://redis.io/commands/scan

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

@@ -1,13 +1,42 @@
 import { Command, CommandOptions } from "./command.js";
-export declare type SetCommandOptions = ({
+export declare type SetCommandOptions = {
+    get: boolean;
+} | ({
     ex: number;
     px?: never;
+    exat?: never;
+    pxat?: never;
+    keepTtl?: never;
 } | {
     ex?: never;
     px: number;
+    exat?: never;
+    pxat?: never;
+    keepTtl?: never;
 } | {
     ex?: never;
     px?: never;
+    exat: number;
+    pxat?: never;
+    keepTtl?: never;
+} | {
+    ex?: never;
+    px?: never;
+    exat?: never;
+    pxat: number;
+    keepTtl?: never;
+} | {
+    ex?: never;
+    px?: never;
+    exat?: never;
+    pxat?: never;
+    keepTtl: true;
+} | {
+    ex?: never;
+    px?: never;
+    exat?: never;
+    pxat?: never;
+    keepTtl?: never;
 }) & ({
     nx: true;
     xx?: never;
@@ -21,6 +50,6 @@ export declare type SetCommandOptions = ({
 /**
  * @see https://redis.io/commands/set
  */
-export declare class SetCommand<TData, TResult = "OK"> extends Command<TResult, TData> {
+export declare class SetCommand<TData, TResult = TData | "OK" | null> extends Command<TResult, TData | "OK" | null> {
     constructor([key, value, opts]: [key: string, value: TData, opts?: SetCommandOptions], cmdOpts?: CommandOptions<TResult, TData>);
 }

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

@@ -0,0 +1,7 @@
+import { Command, CommandOptions } from "./command.js";
+/**
+ * @see https://redis.io/commands/zmscore
+ */
+export declare class ZMScoreCommand<TData> extends Command<string[] | null, number[] | null> {
+    constructor(cmd: [key: string, members: TData[]], opts?: CommandOptions<string[] | null, number[] | null>);
+}

package/types/pkg/http.d.ts

@@ -29,20 +29,52 @@ export declare type RetryConfig = false | {
      */
     backoff?: (retryCount: number) => number;
 };
-declare type Options = {
+export declare type Options = {
     backend?: string;
 };
+export declare type RequesterConfig = {
+    /**
+     * Configure the retry behaviour in case of network errors
+     */
+    retry?: RetryConfig;
+    /**
+     * Due to the nature of dynamic and custom data, it is possible to write data to redis that is not
+     * valid json and will therefore cause errors when deserializing. This used to happen very
+     * frequently with non-utf8 data, such as emojis.
+     *
+     * By default we will therefore encode the data as base64 on the server, before sending it to the
+     * client. The client will then decode the base64 data and parse it as utf8.
+     *
+     * For very large entries, this can add a few milliseconds, so if you are sure that your data is
+     * valid utf8, you can disable this behaviour by setting this option to false.
+     *
+     * Here's what the response body looks like:
+     *
+     * ```json
+     * {
+     *  result?: "base64-encoded",
+     *  error?: string
+     * }
+     * ```
+     *
+     * @default "base64"
+     */
+    responseEncoding?: false | "base64";
+};
 export declare type HttpClientConfig = {
     headers?: Record<string, string>;
     baseUrl: string;
     options?: Options;
     retry?: RetryConfig;
-};
+    agent?: any;
+} & RequesterConfig;
 export declare class HttpClient implements Requester {
     baseUrl: string;
     headers: Record<string, string>;
-    readonly options?: {
+    readonly options: {
         backend?: string;
+        agent: any;
+        responseEncoding?: false | "base64";
     };
     readonly retry: {
         attempts: number;
@@ -51,4 +83,3 @@ export declare class HttpClient implements Requester {
     constructor(config: HttpClientConfig);
     request<TResult>(req: UpstashRequest): Promise<UpstashResponse<TResult>>;
 }
-export {};