@upstash/redis 1.16.1 → 1.18.0

package/README.md

@@ -100,3 +100,19 @@ the url and token
 ```sh
 UPSTASH_REDIS_REST_URL=".." UPSTASH_REDIS_REST_TOKEN=".." deno test -A
 ```
+
+### Telemetry
+
+This library sends anonymous telemetry data to help us improve your experience.
+We collect the following:
+
+- SDK version
+- Platform (Deno, Cloudflare, Vercel)
+- Runtime version (node@18.x)
+
+You can opt out by setting the `UPSTASH_DISABLE_TELEMETRY` environment variable
+to any truthy value.
+
+```sh
+UPSTASH_DISABLE_TELEMETRY=1
+```

package/esm/pkg/commands/hgetall.js

@@ -1,8 +1,4 @@
 import { Command } from "./command.js";
-/**
- * @param result De
- * @returns
- */
 function deserialize(result) {
     if (result.length === 0) {
         return null;

package/esm/pkg/commands/hrandfield.js

@@ -0,0 +1,39 @@
+import { Command } from "./command.js";
+function deserialize(result) {
+    if (result.length === 0) {
+        return null;
+    }
+    const obj = {};
+    while (result.length >= 2) {
+        const key = result.shift();
+        const value = result.shift();
+        try {
+            obj[key] = JSON.parse(value);
+        }
+        catch {
+            obj[key] = value;
+        }
+    }
+    return obj;
+}
+/**
+ * @see https://redis.io/commands/hrandfield
+ */
+export class HRandFieldCommand extends Command {
+    constructor(cmd, opts) {
+        const command = ["hrandfield", cmd[0]];
+        if (typeof cmd[1] === "number") {
+            command.push(cmd[1]);
+        }
+        if (cmd[2]) {
+            command.push("WITHVALUES");
+        }
+        super(command, {
+            // @ts-ignore TODO:
+            deserialize: cmd[2]
+                ? (result) => deserialize(result)
+                : opts?.deserialize,
+            ...opts,
+        });
+    }
+}

package/esm/pkg/commands/mod.js

@@ -17,9 +17,9 @@ 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 "./getdel.js";
 export * from "./hdel.js";
 export * from "./hexists.js";
 export * from "./hget.js";
@@ -30,6 +30,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";

package/esm/pkg/http.js

@@ -35,6 +35,15 @@ export class HttpClient {
             "Content-Type": "application/json",
             ...config.headers,
         };
+        if (config.telemetry?.runtime) {
+            this.headers["Upstash-Telemetry-Runtime"] = config.telemetry.runtime;
+        }
+        if (config.telemetry?.platform) {
+            this.headers["Upstash-Telemetry-Platform"] = config.telemetry.platform;
+        }
+        if (config.telemetry?.sdk) {
+            this.headers["Upstash-Telemetry-Sdk"] = config.telemetry.sdk;
+        }
         if (this.options.responseEncoding === "base64") {
             this.headers["Upstash-Encoding"] = "base64";
         }

package/esm/pkg/pipeline.js

@@ -1,6 +1,7 @@
 import { AppendCommand, BitCountCommand, BitOpCommand, BitPosCommand, DBSizeCommand, DecrByCommand, DecrCommand, DelCommand, EchoCommand, EvalCommand, EvalshaCommand, ExistsCommand, ExpireAtCommand, ExpireCommand, FlushAllCommand, FlushDBCommand, GetBitCommand, GetCommand, GetDelCommand, GetRangeCommand, GetSetCommand, HDelCommand, HExistsCommand, HGetAllCommand, HGetCommand, HIncrByCommand, HIncrByFloatCommand, HKeysCommand, HLenCommand, HMGetCommand, HMSetCommand, HScanCommand, HSetCommand, HSetNXCommand, HStrLenCommand, HValsCommand, IncrByCommand, IncrByFloatCommand, IncrCommand, KeysCommand, LIndexCommand, LInsertCommand, LLenCommand, LPopCommand, LPosCommand, LPushCommand, LPushXCommand, LRangeCommand, LRemCommand, LSetCommand, LTrimCommand, MGetCommand, MSetCommand, MSetNXCommand, PersistCommand, PExpireAtCommand, PExpireCommand, PingCommand, PSetEXCommand, PTtlCommand, PublishCommand, RandomKeyCommand, RenameCommand, RenameNXCommand, RPopCommand, RPushCommand, RPushXCommand, SAddCommand, ScanCommand, SCardCommand, ScriptExistsCommand, ScriptFlushCommand, ScriptLoadCommand, SDiffCommand, SDiffStoreCommand, SetBitCommand, SetCommand, SetExCommand, SetNxCommand, SetRangeCommand, SInterCommand, SInterStoreCommand, SIsMemberCommand, SMembersCommand, SMoveCommand, SPopCommand, SRandMemberCommand, SRemCommand, SScanCommand, StrLenCommand, SUnionCommand, SUnionStoreCommand, TimeCommand, TouchCommand, TtlCommand, TypeCommand, UnlinkCommand, ZAddCommand, ZCardCommand, ZCountCommand, ZIncrByCommand, ZInterStoreCommand, ZLexCountCommand, ZPopMaxCommand, ZPopMinCommand, ZRangeCommand, ZRankCommand, ZRemCommand, ZRemRangeByLexCommand, ZRemRangeByRankCommand, ZRemRangeByScoreCommand, ZRevRankCommand, ZScanCommand, ZScoreCommand, ZUnionStoreCommand, } from "./commands/mod.js";
 import { UpstashError } from "./error.js";
 import { ZMScoreCommand } from "./commands/zmscore.js";
+import { HRandFieldCommand } from "./commands/hrandfield.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.
@@ -375,6 +376,15 @@ export class Pipeline {
             writable: true,
             value: (key, kv) => this.chain(new HMSetCommand([key, kv], this.commandOptions))
         });
+        /**
+         * @see https://redis.io/commands/hrandfield
+         */
+        Object.defineProperty(this, "hrandfield", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (key, count, withValues) => this.chain(new HRandFieldCommand([key, count, withValues], this.commandOptions))
+        });
         /**
          * @see https://redis.io/commands/hscan
          */

package/esm/pkg/redis.js

@@ -1,4 +1,4 @@
-import { AppendCommand, BitCountCommand, BitOpCommand, BitPosCommand, DBSizeCommand, DecrByCommand, DecrCommand, DelCommand, EchoCommand, EvalCommand, EvalshaCommand, ExistsCommand, ExpireAtCommand, ExpireCommand, FlushAllCommand, FlushDBCommand, GetBitCommand, GetCommand, GetDelCommand, GetRangeCommand, GetSetCommand, HDelCommand, HExistsCommand, HGetAllCommand, HGetCommand, HIncrByCommand, HIncrByFloatCommand, HKeysCommand, HLenCommand, HMGetCommand, HMSetCommand, HScanCommand, HSetCommand, HSetNXCommand, HStrLenCommand, HValsCommand, IncrByCommand, IncrByFloatCommand, IncrCommand, KeysCommand, LIndexCommand, LInsertCommand, LLenCommand, LPopCommand, LPosCommand, LPushCommand, LPushXCommand, LRangeCommand, LRemCommand, LSetCommand, LTrimCommand, MGetCommand, MSetCommand, MSetNXCommand, PersistCommand, PExpireAtCommand, PExpireCommand, PingCommand, PSetEXCommand, PTtlCommand, PublishCommand, RandomKeyCommand, RenameCommand, RenameNXCommand, RPopCommand, RPushCommand, RPushXCommand, SAddCommand, ScanCommand, SCardCommand, ScriptExistsCommand, ScriptFlushCommand, ScriptLoadCommand, SDiffCommand, SDiffStoreCommand, SetBitCommand, SetCommand, SetExCommand, SetNxCommand, SetRangeCommand, SInterCommand, SInterStoreCommand, SIsMemberCommand, SMembersCommand, SMoveCommand, SPopCommand, SRandMemberCommand, SRemCommand, SScanCommand, StrLenCommand, SUnionCommand, SUnionStoreCommand, TimeCommand, TouchCommand, TtlCommand, TypeCommand, UnlinkCommand, ZAddCommand, ZCardCommand, ZCountCommand, ZIncrByCommand, ZInterStoreCommand, ZLexCountCommand, ZPopMaxCommand, ZPopMinCommand, ZRangeCommand, ZRankCommand, ZRemCommand, ZRemRangeByLexCommand, ZRemRangeByRankCommand, ZRemRangeByScoreCommand, ZRevRankCommand, ZScanCommand, ZScoreCommand, ZUnionStoreCommand, } from "./commands/mod.js";
+import { AppendCommand, BitCountCommand, BitOpCommand, BitPosCommand, DBSizeCommand, DecrByCommand, DecrCommand, DelCommand, EchoCommand, EvalCommand, EvalshaCommand, ExistsCommand, ExpireAtCommand, ExpireCommand, FlushAllCommand, FlushDBCommand, GetBitCommand, GetCommand, GetDelCommand, GetRangeCommand, GetSetCommand, HDelCommand, HExistsCommand, HGetAllCommand, HGetCommand, HIncrByCommand, HIncrByFloatCommand, HKeysCommand, HLenCommand, HMGetCommand, HMSetCommand, HRandFieldCommand, HScanCommand, HSetCommand, HSetNXCommand, HStrLenCommand, HValsCommand, IncrByCommand, IncrByFloatCommand, IncrCommand, KeysCommand, LIndexCommand, LInsertCommand, LLenCommand, LPopCommand, LPosCommand, LPushCommand, LPushXCommand, LRangeCommand, LRemCommand, LSetCommand, LTrimCommand, MGetCommand, MSetCommand, MSetNXCommand, PersistCommand, PExpireAtCommand, PExpireCommand, PingCommand, PSetEXCommand, PTtlCommand, PublishCommand, RandomKeyCommand, RenameCommand, RenameNXCommand, RPopCommand, RPushCommand, RPushXCommand, SAddCommand, ScanCommand, SCardCommand, ScriptExistsCommand, ScriptFlushCommand, ScriptLoadCommand, SDiffCommand, SDiffStoreCommand, SetBitCommand, SetCommand, SetExCommand, SetNxCommand, SetRangeCommand, SInterCommand, SInterStoreCommand, SIsMemberCommand, SMembersCommand, SMoveCommand, SPopCommand, SRandMemberCommand, SRemCommand, SScanCommand, StrLenCommand, SUnionCommand, SUnionStoreCommand, TimeCommand, TouchCommand, TtlCommand, TypeCommand, UnlinkCommand, ZAddCommand, ZCardCommand, ZCountCommand, ZIncrByCommand, ZInterStoreCommand, ZLexCountCommand, ZPopMaxCommand, ZPopMinCommand, ZRangeCommand, ZRankCommand, ZRemCommand, ZRemRangeByLexCommand, ZRemRangeByRankCommand, ZRemRangeByScoreCommand, ZRevRankCommand, ZScanCommand, ZScoreCommand, ZUnionStoreCommand, } from "./commands/mod.js";
 import { Pipeline } from "./pipeline.js";
 import { Script } from "./script.js";
 import { ZMScoreCommand } from "./commands/zmscore.js";
@@ -355,6 +355,16 @@ export class Redis {
             writable: true,
             value: (key, kv) => new HMSetCommand([key, kv], this.opts).exec(this.client)
         });
+        /**
+         * @see https://redis.io/commands/hrandfield
+         */
+        Object.defineProperty(this, "hrandfield", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (key, count, withValues) => new HRandFieldCommand([key, count, withValues], this.opts)
+                .exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/hscan
          */

package/esm/platforms/cloudflare.js

@@ -1,5 +1,6 @@
 import * as core from "../pkg/redis.js";
 import { HttpClient } from "../pkg/http.js";
+import { VERSION } from "../version.js";
 /**
  * Serverless redis client for upstash.
  */
@@ -15,7 +16,7 @@ export class Redis extends core.Redis {
      * });
      * ```
      */
-    constructor(config) {
+    constructor(config, env) {
         if (config.url.startsWith(" ") ||
             config.url.endsWith(" ") ||
             /\r|\n/.test(config.url)) {
@@ -26,11 +27,17 @@ export 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}`;
+        }
         const client = new HttpClient({
             retry: config.retry,
             baseUrl: config.url,
             headers: { authorization: `Bearer ${config.token}` },
             responseEncoding: config.responseEncoding,
+            telemetry,
         });
         super(client, {
             automaticDeserialization: config.automaticDeserialization,
@@ -58,6 +65,6 @@ export 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);
     }
 }

package/esm/platforms/node_with_fetch.js

@@ -1,6 +1,7 @@
 // deno-lint-ignore-file
 import * as core from "../pkg/redis.js";
 import { HttpClient, } from "../pkg/http.js";
+import { VERSION } from "../version.js";
 import "isomorphic-fetch";
 /**
  * Serverless redis client for upstash.
@@ -21,12 +22,23 @@ export 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}`;
+        }
         const client = new HttpClient({
             baseUrl: configOrRequester.url,
             retry: configOrRequester.retry,
             headers: { authorization: `Bearer ${configOrRequester.token}` },
             //  agent: configOrRequester.agent,
             responseEncoding: configOrRequester.responseEncoding,
+            telemetry,
         });
         super(client, {
             automaticDeserialization: configOrRequester.automaticDeserialization,

package/esm/platforms/nodejs.js

@@ -1,6 +1,7 @@
 // deno-lint-ignore-file
 import * as core from "../pkg/redis.js";
 import { HttpClient, } from "../pkg/http.js";
+import { VERSION } from "../version.js";
 /**
  * Serverless redis client for upstash.
  */
@@ -20,12 +21,23 @@ export 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}`;
+        }
         const client = new HttpClient({
             baseUrl: configOrRequester.url,
             retry: configOrRequester.retry,
             headers: { authorization: `Bearer ${configOrRequester.token}` },
             agent: configOrRequester.agent,
             responseEncoding: configOrRequester.responseEncoding,
+            telemetry,
         });
         super(client, {
             automaticDeserialization: configOrRequester.automaticDeserialization,

package/esm/version.js

@@ -0,0 +1 @@
+export const VERSION = "v1.18.0";

package/package.json

@@ -3,7 +3,7 @@
   "main": "./script/platforms/nodejs.js",
   "types": "./types/platforms/nodejs.d.ts",
   "name": "@upstash/redis",
-  "version": "v1.16.1",
+  "version": "v1.18.0",
   "description": "An HTTP/REST based Redis client built on top of Upstash REST API.",
   "repository": {
     "type": "git",

package/script/pkg/commands/hgetall.js

@@ -2,10 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HGetAllCommand = void 0;
 const command_js_1 = require("./command.js");
-/**
- * @param result De
- * @returns
- */
 function deserialize(result) {
     if (result.length === 0) {
         return null;

package/script/pkg/commands/hrandfield.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HRandFieldCommand = void 0;
+const command_js_1 = require("./command.js");
+function deserialize(result) {
+    if (result.length === 0) {
+        return null;
+    }
+    const obj = {};
+    while (result.length >= 2) {
+        const key = result.shift();
+        const value = result.shift();
+        try {
+            obj[key] = JSON.parse(value);
+        }
+        catch {
+            obj[key] = value;
+        }
+    }
+    return obj;
+}
+/**
+ * @see https://redis.io/commands/hrandfield
+ */
+class HRandFieldCommand extends command_js_1.Command {
+    constructor(cmd, opts) {
+        const command = ["hrandfield", cmd[0]];
+        if (typeof cmd[1] === "number") {
+            command.push(cmd[1]);
+        }
+        if (cmd[2]) {
+            command.push("WITHVALUES");
+        }
+        super(command, {
+            // @ts-ignore TODO:
+            deserialize: cmd[2]
+                ? (result) => deserialize(result)
+                : opts?.deserialize,
+            ...opts,
+        });
+    }
+}
+exports.HRandFieldCommand = HRandFieldCommand;

package/script/pkg/commands/mod.js

@@ -33,9 +33,9 @@ __exportStar(require("./flushall.js"), exports);
 __exportStar(require("./flushdb.js"), exports);
 __exportStar(require("./get.js"), exports);
 __exportStar(require("./getbit.js"), exports);
+__exportStar(require("./getdel.js"), exports);
 __exportStar(require("./getrange.js"), exports);
 __exportStar(require("./getset.js"), exports);
-__exportStar(require("./getdel.js"), exports);
 __exportStar(require("./hdel.js"), exports);
 __exportStar(require("./hexists.js"), exports);
 __exportStar(require("./hget.js"), exports);
@@ -46,6 +46,7 @@ __exportStar(require("./hkeys.js"), exports);
 __exportStar(require("./hlen.js"), exports);
 __exportStar(require("./hmget.js"), exports);
 __exportStar(require("./hmset.js"), exports);
+__exportStar(require("./hrandfield.js"), exports);
 __exportStar(require("./hscan.js"), exports);
 __exportStar(require("./hset.js"), exports);
 __exportStar(require("./hsetnx.js"), exports);

package/script/pkg/http.js

@@ -38,6 +38,15 @@ class HttpClient {
             "Content-Type": "application/json",
             ...config.headers,
         };
+        if (config.telemetry?.runtime) {
+            this.headers["Upstash-Telemetry-Runtime"] = config.telemetry.runtime;
+        }
+        if (config.telemetry?.platform) {
+            this.headers["Upstash-Telemetry-Platform"] = config.telemetry.platform;
+        }
+        if (config.telemetry?.sdk) {
+            this.headers["Upstash-Telemetry-Sdk"] = config.telemetry.sdk;
+        }
         if (this.options.responseEncoding === "base64") {
             this.headers["Upstash-Encoding"] = "base64";
         }

package/script/pkg/pipeline.js

@@ -4,6 +4,7 @@ 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");
+const hrandfield_js_1 = require("./commands/hrandfield.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.
@@ -378,6 +379,15 @@ class Pipeline {
             writable: true,
             value: (key, kv) => this.chain(new mod_js_1.HMSetCommand([key, kv], this.commandOptions))
         });
+        /**
+         * @see https://redis.io/commands/hrandfield
+         */
+        Object.defineProperty(this, "hrandfield", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (key, count, withValues) => this.chain(new hrandfield_js_1.HRandFieldCommand([key, count, withValues], this.commandOptions))
+        });
         /**
          * @see https://redis.io/commands/hscan
          */

package/script/pkg/redis.js

@@ -358,6 +358,16 @@ class Redis {
             writable: true,
             value: (key, kv) => new mod_js_1.HMSetCommand([key, kv], this.opts).exec(this.client)
         });
+        /**
+         * @see https://redis.io/commands/hrandfield
+         */
+        Object.defineProperty(this, "hrandfield", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (key, count, withValues) => new mod_js_1.HRandFieldCommand([key, count, withValues], this.opts)
+                .exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/hscan
          */

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,11 +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,
@@ -84,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/node_with_fetch.js

@@ -27,6 +27,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");
 require("isomorphic-fetch");
 /**
  * Serverless redis client for upstash.
@@ -47,12 +48,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,
             responseEncoding: configOrRequester.responseEncoding,
+            telemetry,
         });
         super(client, {
             automaticDeserialization: configOrRequester.automaticDeserialization,

package/script/platforms/nodejs.js

@@ -27,6 +27,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.
  */
@@ -46,12 +47,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,
             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 = "v1.18.0";

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

@@ -17,9 +17,9 @@ 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 "./getdel.js";
 export * from "./hdel.js";
 export * from "./hexists.js";
 export * from "./hget.js";
@@ -30,6 +30,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";

package/types/pkg/http.d.ts

@@ -67,6 +67,23 @@ export declare type HttpClientConfig = {
     options?: Options;
     retry?: RetryConfig;
     agent?: any;
+    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;
+    };
 } & RequesterConfig;
 export declare class HttpClient implements Requester {
     baseUrl: string;

package/types/pkg/pipeline.d.ts

@@ -197,6 +197,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
      */

package/types/pkg/redis.d.ts

@@ -181,6 +181,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
      */

package/types/platforms/cloudflare.d.ts

@@ -1,6 +1,9 @@
 import * as core from "../pkg/redis.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.
@@ -15,7 +18,7 @@ export declare type RedisConfigCloudflare = {
      * UPSTASH_REDIS_REST_TOKEN
      */
     token: string;
-} & core.RedisOptions & RequesterConfig;
+} & core.RedisOptions & RequesterConfig & Env;
 /**
  * Serverless redis client for upstash.
  */
@@ -31,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/version.d.ts

@@ -0,0 +1 @@
+export declare const VERSION = "v1.18.0";