@upstash/redis 0.0.0-ci.c4f9e888-20220808 → 0.0.0-ci.c586e271-20221116

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

@@ -4,6 +4,7 @@ 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.
  */
@@ -53,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
@@ -217,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
          */
@@ -978,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
          */

package/script/pkg/script.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Script = void 0;
-const mod_js_1 = require("../deps/denopkg.com/chiefbiiko/sha1@master/mod.js");
+const mod_js_1 = require("../deps/deno.land/x/sha1@v1.0.3/mod.js");
 /**
  * Creates a new 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/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/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/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 {};

package/types/pkg/pipeline.d.ts

@@ -18,7 +18,7 @@ import { CommandArgs } from "./types.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()
@@ -44,7 +44,12 @@ export declare class Pipeline {
     private client;
     private commands;
     private commandOptions?;
-    constructor(client: Requester, commandOptions?: CommandOptions<any, any>);
+    private multiExec;
+    constructor(opts: {
+        client: Requester;
+        commandOptions?: CommandOptions<any, any>;
+        multiExec?: boolean;
+    });
     /**
      * Send the pipeline request to upstash.
      *
@@ -138,6 +143,10 @@ export declare class Pipeline {
      * @see https://redis.io/commands/getbit
      */
     getbit: (key: string, offset: number) => this;
+    /**
+     * @see https://redis.io/commands/getdel
+     */
+    getdel: <TData>(key: string) => this;
     /**
      * @see https://redis.io/commands/getrange
      */
@@ -374,7 +383,7 @@ export declare class Pipeline {
     /**
      * @see https://redis.io/commands/set
      */
-    set: <TData>(key: string, value: TData, opts?: SetCommandOptions | undefined) => this;
+    set: <TData>(key: string, value: TData, opts?: SetCommandOptions) => this;
     /**
      * @see https://redis.io/commands/setbit
      */
@@ -483,6 +492,10 @@ export declare class Pipeline {
      * @see https://redis.io/commands/zlexcount
      */
     zlexcount: (key: string, min: string, max: string) => this;
+    /**
+     * @see https://redis.io/commands/zmscore
+     */
+    zmscore: (key: string, members: unknown[]) => this;
     /**
      * @see https://redis.io/commands/zpopmax
      */

package/types/pkg/redis.d.ts

@@ -40,6 +40,16 @@ export declare class Redis {
      * @see {@link Pipeline}
      */
     pipeline: () => Pipeline;
+    /**
+     * 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}
+     */
+    multi: () => Pipeline;
     /**
      * @see https://redis.io/commands/append
      */
@@ -117,6 +127,10 @@ export declare class Redis {
      * @see https://redis.io/commands/getbit
      */
     getbit: (key: string, offset: number) => Promise<0 | 1>;
+    /**
+     * @see https://redis.io/commands/getdel
+     */
+    getdel: <TData>(key: string) => Promise<TData | null>;
     /**
      * @see https://redis.io/commands/getrange
      */
@@ -356,7 +370,7 @@ export declare class Redis {
     /**
      * @see https://redis.io/commands/set
      */
-    set: <TData>(key: string, value: TData, opts?: SetCommandOptions | undefined) => Promise<"OK" | TData | null>;
+    set: <TData>(key: string, value: TData, opts?: SetCommandOptions) => Promise<"OK" | TData | null>;
     /**
      * @see https://redis.io/commands/setbit
      */
@@ -465,6 +479,10 @@ export declare class Redis {
      * @see https://redis.io/commands/zlexcount
      */
     zlexcount: (key: string, min: string, max: string) => Promise<number>;
+    /**
+     * @see https://redis.io/commands/zmscore
+     */
+    zmscore: (key: string, members: unknown[]) => Promise<number[] | null>;
     /**
      * @see https://redis.io/commands/zpopmax
      */

package/types/platforms/cloudflare.d.ts

@@ -1,5 +1,6 @@
 import * as core from "../pkg/redis.js";
-import type { Requester, RetryConfig, UpstashRequest, UpstashResponse } from "../pkg/http.js";
+import type { Requester, UpstashRequest, UpstashResponse } from "../pkg/http.js";
+import { RequesterConfig } from "../pkg/http.js";
 export type { Requester, UpstashRequest, UpstashResponse };
 /**
  * Connection credentials for upstash redis.
@@ -14,11 +15,7 @@ export declare type RedisConfigCloudflare = {
      * UPSTASH_REDIS_REST_TOKEN
      */
     token: string;
-    /**
-     * Configure the retry behaviour in case of network errors
-     */
-    retry?: RetryConfig;
-} & core.RedisOptions;
+} & core.RedisOptions & RequesterConfig;
 /**
  * Serverless redis client for upstash.
  */

package/types/platforms/fastly.d.ts

@@ -1,5 +1,5 @@
 import * as core from "../pkg/redis.js";
-import type { Requester, RetryConfig, UpstashRequest, UpstashResponse } from "../pkg/http.js";
+import type { Requester, RequesterConfig, UpstashRequest, UpstashResponse } from "../pkg/http.js";
 export type { Requester, UpstashRequest, UpstashResponse };
 /**
  * Connection credentials for upstash redis.
@@ -20,11 +20,7 @@ export declare type RedisConfigFastly = {
      * referenced by name.
      */
     backend: string;
-    /**
-     * Configure the retry behaviour in case of network errors
-     */
-    retry?: RetryConfig;
-} & core.RedisOptions;
+} & core.RedisOptions & RequesterConfig;
 /**
  * Serverless redis client for upstash.
  */

package/types/platforms/node_with_fetch.d.ts

@@ -1,5 +1,5 @@
 import * as core from "../pkg/redis.js";
-import { Requester, RetryConfig, UpstashRequest, UpstashResponse } from "../pkg/http.js";
+import { Requester, RequesterConfig, UpstashRequest, UpstashResponse } from "../pkg/http.js";
 import "isomorphic-fetch";
 export type { Requester, UpstashRequest, UpstashResponse };
 /**
@@ -15,26 +15,7 @@ export declare type RedisConfigNodejs = {
      * UPSTASH_REDIS_REST_TOKEN
      */
     token: string;
-    /**
-     * An agent allows you to reuse connections to reduce latency for multiple sequential requests.
-     *
-     * This is a node specific implementation and is not supported in various runtimes like Vercel
-     * edge functions.
-     *
-     * @example
-     * ```ts
-     * import https from "https"
-     *
-     * const options: RedisConfigNodejs = {
-     *  agent: new https.Agent({ keepAlive: true })
-     * }
-     * ```
-     */
-    /**
-     * Configure the retry behaviour in case of network errors
-     */
-    retry?: RetryConfig;
-} & core.RedisOptions;
+} & core.RedisOptions & RequesterConfig;
 /**
  * Serverless redis client for upstash.
  */

package/types/platforms/nodejs.d.ts

@@ -1,5 +1,5 @@
 import * as core from "../pkg/redis.js";
-import { Requester, RetryConfig, UpstashRequest, UpstashResponse } from "../pkg/http.js";
+import { Requester, RequesterConfig, UpstashRequest, UpstashResponse } from "../pkg/http.js";
 export type { Requester, UpstashRequest, UpstashResponse };
 /**
  * Connection credentials for upstash redis.
@@ -29,11 +29,8 @@ export declare type RedisConfigNodejs = {
      * }
      * ```
      */
-    /**
-     * Configure the retry behaviour in case of network errors
-     */
-    retry?: RetryConfig;
-} & core.RedisOptions;
+    agent?: any;
+} & core.RedisOptions & RequesterConfig;
 /**
  * Serverless redis client for upstash.
  */

package/esm/deps/deno.land/x/base64@v0.2.1/mod.js

@@ -1,13 +0,0 @@
-import { init } from "./base.js";
-const lookup = [];
-const revLookup = [];
-const code = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
-for (let i = 0, l = code.length; i < l; ++i) {
-    lookup[i] = code[i];
-    revLookup[code.charCodeAt(i)] = i;
-}
-// Support decoding URL-safe base64 strings, as Node.js does.
-// See: https://en.wikipedia.org/wiki/Base64#URL_applications
-revLookup["-".charCodeAt(0)] = 62;
-revLookup["_".charCodeAt(0)] = 63;
-export const { byteLength, toUint8Array, fromUint8Array } = init(lookup, revLookup);

package/esm/deps/denopkg.com/chiefbiiko/sha1@master/deps.js

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

package/script/deps/deno.land/x/base64@v0.2.1/mod.js

@@ -1,17 +0,0 @@
-"use strict";
-var _a;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fromUint8Array = exports.toUint8Array = exports.byteLength = void 0;
-const base_js_1 = require("./base.js");
-const lookup = [];
-const revLookup = [];
-const code = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
-for (let i = 0, l = code.length; i < l; ++i) {
-    lookup[i] = code[i];
-    revLookup[code.charCodeAt(i)] = i;
-}
-// Support decoding URL-safe base64 strings, as Node.js does.
-// See: https://en.wikipedia.org/wiki/Base64#URL_applications
-revLookup["-".charCodeAt(0)] = 62;
-revLookup["_".charCodeAt(0)] = 63;
-_a = (0, base_js_1.init)(lookup, revLookup), exports.byteLength = _a.byteLength, exports.toUint8Array = _a.toUint8Array, exports.fromUint8Array = _a.fromUint8Array;

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

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

package/types/deps/denopkg.com/chiefbiiko/sha1@master/deps.d.ts

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