@upstash/redis 0.0.0-ci.b1e842dc-20220903 → 0.0.0-ci.b8efaf97-20230119

package/script/platforms/cloudflare.js

@@ -26,6 +26,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Redis = void 0;
 const core = __importStar(require("../pkg/redis.js"));
 const http_js_1 = require("../pkg/http.js");
+const version_js_1 = require("../version.js");
 /**
  * Serverless redis client for upstash.
  */
@@ -41,7 +42,7 @@ class Redis extends core.Redis {
      * });
      * ```
      */
-    constructor(config) {
+    constructor(config, env) {
         if (config.url.startsWith(" ") ||
             config.url.endsWith(" ") ||
             /\r|\n/.test(config.url)) {
@@ -52,10 +53,17 @@ class Redis extends core.Redis {
             /\r|\n/.test(config.token)) {
             console.warn("The redis token contains whitespace or newline, which can cause errors!");
         }
+        const telemetry = {};
+        if (!env?.UPSTASH_DISABLE_TELEMETRY) {
+            telemetry.platform = "cloudflare";
+            telemetry.sdk = `@upstash/redis@${version_js_1.VERSION}`;
+        }
         const client = new http_js_1.HttpClient({
             retry: config.retry,
             baseUrl: config.url,
             headers: { authorization: `Bearer ${config.token}` },
+            responseEncoding: config.responseEncoding,
+            telemetry,
         });
         super(client, {
             automaticDeserialization: config.automaticDeserialization,
@@ -83,7 +91,7 @@ class Redis extends core.Redis {
         if (!token) {
             throw new Error("Unable to find environment variable: `UPSTASH_REDIS_REST_TOKEN`. Please add it via `wrangler secret put UPSTASH_REDIS_REST_TOKEN`");
         }
-        return new Redis({ ...opts, url, token });
+        return new Redis({ ...opts, url, token }, env);
     }
 }
 exports.Redis = Redis;

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

@@ -27,7 +27,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Redis = void 0;
 const core = __importStar(require("../pkg/redis.js"));
 const http_js_1 = require("../pkg/http.js");
+const version_js_1 = require("../version.js");
 require("isomorphic-fetch");
+// @ts-ignore Deno can't compile
+// import https from "https";
+// @ts-ignore Deno can't compile
+// import http from "http";
+// import "isomorphic-fetch";
+/**
+ * Workaround for nodejs 14, where atob is not included in the standardlib
+ */
+if (typeof atob === "undefined") {
+    global.atob = function (b64) {
+        return Buffer.from(b64, "base64").toString("utf-8");
+    };
+}
 /**
  * Serverless redis client for upstash.
  */
@@ -47,11 +61,23 @@ class Redis extends core.Redis {
             /\r|\n/.test(configOrRequester.token)) {
             console.warn("The redis token contains whitespace or newline, which can cause errors!");
         }
+        const telemetry = {};
+        if (!process.env.UPSTASH_DISABLE_TELEMETRY) {
+            telemetry.runtime = `node@${process.version}`;
+            telemetry.platform = process.env.VERCEL
+                ? "vercel"
+                : process.env.AWS_REGION
+                    ? "aws"
+                    : "unknown";
+            telemetry.sdk = `@upstash/redis@${version_js_1.VERSION}`;
+        }
         const client = new http_js_1.HttpClient({
             baseUrl: configOrRequester.url,
             retry: configOrRequester.retry,
             headers: { authorization: `Bearer ${configOrRequester.token}` },
-            // agent: configOrRequester.agent,
+            //  agent: configOrRequester.agent,
+            responseEncoding: configOrRequester.responseEncoding,
+            telemetry,
         });
         super(client, {
             automaticDeserialization: configOrRequester.automaticDeserialization,

package/script/platforms/nodejs.js

@@ -27,6 +27,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Redis = void 0;
 const core = __importStar(require("../pkg/redis.js"));
 const http_js_1 = require("../pkg/http.js");
+const version_js_1 = require("../version.js");
+/**
+ * Workaround for nodejs 14, where atob is not included in the standardlib
+ */
+if (typeof atob === "undefined") {
+    global.atob = function (b64) {
+        return Buffer.from(b64, "base64").toString("utf-8");
+    };
+}
 /**
  * Serverless redis client for upstash.
  */
@@ -46,11 +55,23 @@ class Redis extends core.Redis {
             /\r|\n/.test(configOrRequester.token)) {
             console.warn("The redis token contains whitespace or newline, which can cause errors!");
         }
+        const telemetry = {};
+        if (!process.env.UPSTASH_DISABLE_TELEMETRY) {
+            telemetry.runtime = `node@${process.version}`;
+            telemetry.platform = process.env.VERCEL
+                ? "vercel"
+                : process.env.AWS_REGION
+                    ? "aws"
+                    : "unknown";
+            telemetry.sdk = `@upstash/redis@${version_js_1.VERSION}`;
+        }
         const client = new http_js_1.HttpClient({
             baseUrl: configOrRequester.url,
             retry: configOrRequester.retry,
             headers: { authorization: `Bearer ${configOrRequester.token}` },
-            // agent: configOrRequester.agent,
+            agent: configOrRequester.agent,
+            responseEncoding: configOrRequester.responseEncoding,
+            telemetry,
         });
         super(client, {
             automaticDeserialization: configOrRequester.automaticDeserialization,

package/script/version.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VERSION = void 0;
+exports.VERSION = "v0.0.0-ci.b8efaf97-20230119";

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/hrandfield.d.ts

@@ -0,0 +1,9 @@
+import { Command, CommandOptions } from "./command.js";
+/**
+ * @see https://redis.io/commands/hrandfield
+ */
+export declare class HRandFieldCommand<TData extends string | string[] | Record<string, unknown>> extends Command<string | string[], TData> {
+    constructor(cmd: [key: string], opts?: CommandOptions<string, string>);
+    constructor(cmd: [key: string, count: number], opts?: CommandOptions<string[], string[]>);
+    constructor(cmd: [key: string, count: number, withValues: boolean], opts?: CommandOptions<string[], Partial<TData>>);
+}

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

@@ -0,0 +1,12 @@
+import { Command, CommandOptions } from "./command.js";
+/**
+ * @see https://redis.io/commands/lmove
+ */
+export declare class LMoveCommand<TData = string> extends Command<TData, TData> {
+    constructor(cmd: [
+        source: string,
+        destination: string,
+        whereFrom: "left" | "right",
+        whereTo: "left" | "right"
+    ], opts?: CommandOptions<TData, TData>);
+}

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

@@ -17,11 +17,13 @@ export * from "./flushall.js";
 export * from "./flushdb.js";
 export * from "./get.js";
 export * from "./getbit.js";
+export * from "./getdel.js";
 export * from "./getrange.js";
 export * from "./getset.js";
 export * from "./hdel.js";
 export * from "./hexists.js";
 export * from "./hget.js";
+export * from "./smismember.js";
 export * from "./hgetall.js";
 export * from "./hincrby.js";
 export * from "./hincrbyfloat.js";
@@ -29,6 +31,7 @@ export * from "./hkeys.js";
 export * from "./hlen.js";
 export * from "./hmget.js";
 export * from "./hmset.js";
+export * from "./hrandfield.js";
 export * from "./hscan.js";
 export * from "./hset.js";
 export * from "./hsetnx.js";
@@ -41,6 +44,7 @@ export * from "./keys.js";
 export * from "./lindex.js";
 export * from "./linsert.js";
 export * from "./llen.js";
+export * from "./lmove.js";
 export * from "./lpop.js";
 export * from "./lpos.js";
 export * from "./lpush.js";

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

@@ -2,6 +2,6 @@ import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/smembers
  */
-export declare class SMembersCommand<TData = string> extends Command<unknown[], TData[]> {
-    constructor(cmd: [key: string], opts?: CommandOptions<unknown[], TData[]>);
+export declare class SMembersCommand<TData extends unknown[] = string[]> extends Command<unknown[], TData> {
+    constructor(cmd: [key: string], opts?: CommandOptions<unknown[], TData>);
 }

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

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

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

@@ -0,0 +1,7 @@
+import { Command, CommandOptions } from "./command.js";
+/**
+ * @see https://redis.io/commands/zdiffstore
+ */
+export declare class ZDiffStoreCommand extends Command<number, number> {
+    constructor(cmd: [destination: string, numkeys: number, ...keys: string[]], opts?: CommandOptions<number, number>);
+}

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

@@ -1,6 +1,6 @@
 import { Command, CommandOptions } from "./command.js";
 /**
- * @see https://redis.io/commands/zscore
+ * @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

@@ -1,3 +1,4 @@
+import { Telemetry } from "./types.js";
 export declare type UpstashRequest = {
     path?: string[];
     /**
@@ -29,26 +30,59 @@ 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;
+    telemetry?: Telemetry;
+} & 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;
         backoff: (retryCount: number) => number;
     };
     constructor(config: HttpClientConfig);
+    mergeTelemetry(telemetry: Telemetry): void;
     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.
      *
@@ -80,6 +85,10 @@ export declare class Pipeline {
      * @see https://redis.io/commands/bitpos
      */
     bitpos: (key: string, bit: 0 | 1, start?: number | undefined, end?: number | undefined) => this;
+    /**
+     * @see https://redis.io/commands/zdiffstore
+     */
+    zdiffstore: (destination: string, numkeys: number, ...keys: string[]) => this;
     /**
      * @see https://redis.io/commands/dbsize
      */
@@ -138,6 +147,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
      */
@@ -188,6 +201,10 @@ export declare class Pipeline {
     hmset: <TData>(key: string, kv: {
         [field: string]: TData;
     }) => this;
+    /**
+     * @see https://redis.io/commands/hrandfield
+     */
+    hrandfield: <TData extends string | string[] | Record<string, unknown>>(key: string, count?: number, withValues?: boolean) => this;
     /**
      * @see https://redis.io/commands/hscan
      */
@@ -238,6 +255,10 @@ export declare class Pipeline {
      * @see https://redis.io/commands/llen
      */
     llen: (key: string) => this;
+    /**
+     * @see https://redis.io/commands/lmove
+     */
+    lmove: <TData = string>(source: string, destination: string, whereFrom: "left" | "right", whereTo: "left" | "right") => this;
     /**
      * @see https://redis.io/commands/lpop
      */
@@ -406,7 +427,11 @@ export declare class Pipeline {
     /**
      * @see https://redis.io/commands/smembers
      */
-    smembers: (key: string) => this;
+    smembers: <TData extends unknown[] = string[]>(key: string) => this;
+    /**
+     * @see https://redis.io/commands/smismember
+     */
+    smismember: <TMembers extends unknown[]>(key: string, members: TMembers) => this;
     /**
      * @see https://redis.io/commands/smove
      */

package/types/pkg/redis.d.ts

@@ -33,6 +33,10 @@ export declare class Redis {
      * Wrap a new middleware around the HTTP client.
      */
     use: <TResult = unknown>(middleware: (r: UpstashRequest, next: <TResult_1 = unknown>(req: UpstashRequest) => Promise<UpstashResponse<TResult_1>>) => Promise<UpstashResponse<TResult>>) => void;
+    /**
+     * Technically this is not private, we can hide it from intellisense by doing this
+     */
+    private addTelemetry;
     createScript(script: string): Script;
     /**
      * Create a new pipeline that allows you to send requests in bulk.
@@ -40,6 +44,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 +131,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
      */
@@ -167,6 +185,14 @@ export declare class Redis {
     hmset: <TData>(key: string, kv: {
         [field: string]: TData;
     }) => Promise<"OK">;
+    /**
+     * @see https://redis.io/commands/hrandfield
+     */
+    hrandfield: {
+        (key: string): Promise<string>;
+        (key: string, count: number): Promise<string[]>;
+        <TData extends Record<string, unknown>>(key: string, count: number, withValues: boolean): Promise<Partial<TData>>;
+    };
     /**
      * @see https://redis.io/commands/hscan
      */
@@ -217,6 +243,10 @@ export declare class Redis {
      * @see https://redis.io/commands/llen
      */
     llen: (key: string) => Promise<number>;
+    /**
+     * @see https://redis.io/commands/lmove
+     */
+    lmove: <TData = string>(source: string, destination: string, whereFrom: "left" | "right", whereTo: "left" | "right") => Promise<TData>;
     /**
      * @see https://redis.io/commands/lpop
      */
@@ -385,10 +415,14 @@ export declare class Redis {
      * @see https://redis.io/commands/sismember
      */
     sismember: <TData>(key: string, member: TData) => Promise<0 | 1>;
+    /**
+     * @see https://redis.io/commands/smismember
+     */
+    smismember: <TMembers extends unknown[]>(key: string, members: TMembers) => Promise<(0 | 1)[]>;
     /**
      * @see https://redis.io/commands/smembers
      */
-    smembers: (key: string) => Promise<string[]>;
+    smembers: <TData extends unknown[] = string[]>(key: string) => Promise<TData>;
     /**
      * @see https://redis.io/commands/smove
      */
@@ -453,6 +487,10 @@ export declare class Redis {
      * @see https://redis.io/commands/zcount
      */
     zcount: (key: string, min: string | number, max: string | number) => Promise<number>;
+    /**
+     * @see https://redis.io/commands/zdiffstore
+     */
+    zdiffstore: (destination: string, numkeys: number, ...keys: string[]) => Promise<number>;
     /**
      * @see https://redis.io/commands/zincrby
      */

package/types/pkg/types.d.ts

@@ -1 +1,18 @@
 export declare type CommandArgs<TCommand extends new (...args: any) => any> = ConstructorParameters<TCommand>[0];
+export declare type Telemetry = {
+    /**
+     * Upstash-Telemetry-Sdk
+     * @example @upstash/redis@v1.1.1
+     */
+    sdk?: string;
+    /**
+     * Upstash-Telemetry-Platform
+     * @example cloudflare
+     */
+    platform?: string;
+    /**
+     * Upstash-Telemetry-Runtime
+     * @example node@v18
+     */
+    runtime?: string;
+};

package/types/platforms/cloudflare.d.ts

@@ -1,5 +1,9 @@
 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";
+declare type Env = {
+    UPSTASH_DISABLE_TELEMETRY?: string;
+};
 export type { Requester, UpstashRequest, UpstashResponse };
 /**
  * Connection credentials for upstash redis.
@@ -14,11 +18,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 & Env;
 /**
  * Serverless redis client for upstash.
  */
@@ -34,9 +34,10 @@ export declare class Redis extends core.Redis {
      * });
      * ```
      */
-    constructor(config: RedisConfigCloudflare);
+    constructor(config: RedisConfigCloudflare, env?: Env);
     static fromEnv(env?: {
         UPSTASH_REDIS_REST_URL: string;
         UPSTASH_REDIS_REST_TOKEN: string;
+        UPSTASH_DISABLE_TELEMETRY?: string;
     }, opts?: Omit<RedisConfigCloudflare, "url" | "token">): Redis;
 }

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/types/version.d.ts

@@ -0,0 +1 @@
+export declare const VERSION = "v0.0.0-ci.b8efaf97-20230119";