@upstash/redis 0.0.0-ci.ba39ba1e → 0.0.0-ci.baae64ab-20231010

package/script/pkg/pipeline.js

@@ -3,6 +3,9 @@ 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");
+const hrandfield_js_1 = require("./commands/hrandfield.js");
+const zdiffstore_js_1 = require("./commands/zdiffstore.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 +22,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()
@@ -31,7 +34,7 @@ const error_js_1 = require("./error.js");
  * const res = await p.set("key","value").get("key").exec()
  * ```
  *
- * It's not possible to infer correct types with a dynamic pipeline, so you can
+ * Return types are inferred if all commands are chained, but you can still
  * override the response type manually:
  * ```ts
  *  redis.pipeline()
@@ -42,7 +45,7 @@ const error_js_1 = require("./error.js");
  * ```
  */
 class Pipeline {
-    constructor(client, commandOptions) {
+    constructor(opts) {
         Object.defineProperty(this, "client", {
             enumerable: true,
             configurable: true,
@@ -61,14 +64,22 @@ 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.
          *
          * Returns an array with the results of all pipelined commands.
          *
-         * You can define a return type manually to make working in typescript easier
+         * If all commands are statically chained from start to finish, types are inferred. You can still define a return type manually if necessary though:
          * ```ts
-         * redis.pipeline().get("key").exec<[{ greeting: string }]>()
+         * const p = redis.pipeline()
+         * p.get("key")
+         * const result = p.exec<[{ greeting: string }]>()
          * ```
          */
         Object.defineProperty(this, "exec", {
@@ -79,10 +90,12 @@ 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),
                 }));
+                console.log("after req", { res });
                 return res.map(({ error, result }, i) => {
                     if (error) {
                         throw new error_js_1.UpstashError(`Command ${i + 1} [ ${this.commands[i].command[0]} ] failed: ${error}`);
@@ -127,6 +140,15 @@ class Pipeline {
             writable: true,
             value: (...args) => this.chain(new mod_js_1.BitPosCommand(args, this.commandOptions))
         });
+        /**
+         * @see https://redis.io/commands/zdiffstore
+         */
+        Object.defineProperty(this, "zdiffstore", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => this.chain(new zdiffstore_js_1.ZDiffStoreCommand(args, this.commandOptions))
+        });
         /**
          * @see https://redis.io/commands/dbsize
          */
@@ -253,6 +275,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
          */
@@ -361,6 +392,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
          */
@@ -469,6 +509,15 @@ class Pipeline {
             writable: true,
             value: (...args) => this.chain(new mod_js_1.LLenCommand(args, this.commandOptions))
         });
+        /**
+         * @see https://redis.io/commands/lmove
+         */
+        Object.defineProperty(this, "lmove", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => this.chain(new mod_js_1.LMoveCommand(args, this.commandOptions))
+        });
         /**
          * @see https://redis.io/commands/lpop
          */
@@ -478,6 +527,15 @@ class Pipeline {
             writable: true,
             value: (...args) => this.chain(new mod_js_1.LPopCommand(args, this.commandOptions))
         });
+        /**
+         * @see https://redis.io/commands/lpos
+         */
+        Object.defineProperty(this, "lpos", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => this.chain(new mod_js_1.LPosCommand(args, this.commandOptions))
+        });
         /**
          * @see https://redis.io/commands/lpush
          */
@@ -829,6 +887,15 @@ class Pipeline {
             writable: true,
             value: (...args) => this.chain(new mod_js_1.SMembersCommand(args, this.commandOptions))
         });
+        /**
+         * @see https://redis.io/commands/smismember
+         */
+        Object.defineProperty(this, "smismember", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (key, members) => this.chain(new mod_js_1.SMIsMemberCommand([key, members], this.commandOptions))
+        });
         /**
          * @see https://redis.io/commands/smove
          */
@@ -1005,6 +1072,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
          */
@@ -1113,17 +1189,109 @@ class Pipeline {
             writable: true,
             value: (...args) => this.chain(new mod_js_1.ZUnionStoreCommand(args, this.commandOptions))
         });
-        this.client = client;
-        this.commands = [];
-        this.commandOptions = commandOptions;
+        this.client = opts.client;
+        this.commands = []; // the TCommands generic in the class definition is only used for carrying through chained command types and should never be explicitly set when instantiating the class
+        this.commandOptions = opts.commandOptions;
+        this.multiExec = opts.multiExec ?? false;
     }
     /**
-     * Pushes a command into the pipelien and returns a chainable instance of the
+     * Pushes a command into the pipeline and returns a chainable instance of the
      * pipeline
      */
     chain(command) {
         this.commands.push(command);
-        return this;
+        return this; // TS thinks we're returning Pipeline<[]> here, because we're not creating a new instance of the class, hence the cast
+    }
+    /**
+     * @see https://redis.io/commands/?group=json
+     */
+    get json() {
+        return {
+            /**
+             * @see https://redis.io/commands/json.arrappend
+             */
+            arrappend: (...args) => this.chain(new mod_js_1.JsonArrAppendCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.arrindex
+             */
+            arrindex: (...args) => this.chain(new mod_js_1.JsonArrIndexCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.arrinsert
+             */
+            arrinsert: (...args) => this.chain(new mod_js_1.JsonArrInsertCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.arrlen
+             */
+            arrlen: (...args) => this.chain(new mod_js_1.JsonArrLenCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.arrpop
+             */
+            arrpop: (...args) => this.chain(new mod_js_1.JsonArrPopCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.arrtrim
+             */
+            arrtrim: (...args) => this.chain(new mod_js_1.JsonArrTrimCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.clear
+             */
+            clear: (...args) => this.chain(new mod_js_1.JsonClearCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.del
+             */
+            del: (...args) => this.chain(new mod_js_1.JsonDelCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.forget
+             */
+            forget: (...args) => this.chain(new mod_js_1.JsonForgetCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.get
+             */
+            get: (...args) => this.chain(new mod_js_1.JsonGetCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.mget
+             */
+            mget: (...args) => this.chain(new mod_js_1.JsonMGetCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.numincrby
+             */
+            numincrby: (...args) => this.chain(new mod_js_1.JsonNumIncrByCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.nummultby
+             */
+            nummultby: (...args) => this.chain(new mod_js_1.JsonNumMultByCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.objkeys
+             */
+            objkeys: (...args) => this.chain(new mod_js_1.JsonObjKeysCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.objlen
+             */
+            objlen: (...args) => this.chain(new mod_js_1.JsonObjLenCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.resp
+             */
+            resp: (...args) => this.chain(new mod_js_1.JsonRespCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.set
+             */
+            set: (...args) => this.chain(new mod_js_1.JsonSetCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.strappend
+             */
+            strappend: (...args) => this.chain(new mod_js_1.JsonStrAppendCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.strlen
+             */
+            strlen: (...args) => this.chain(new mod_js_1.JsonStrLenCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.toggle
+             */
+            toggle: (...args) => this.chain(new mod_js_1.JsonToggleCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.type
+             */
+            type: (...args) => this.chain(new mod_js_1.JsonTypeCommand(args, this.commandOptions)),
+        };
     }
 }
 exports.Pipeline = Pipeline;

package/script/pkg/redis.js

@@ -3,6 +3,9 @@ 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");
+const zdiffstore_js_1 = require("./commands/zdiffstore.js");
 /**
  * Serverless redis client for upstash.
  */
@@ -31,6 +34,45 @@ class Redis {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "enableTelemetry", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * Wrap a new middleware around the HTTP client.
+         */
+        Object.defineProperty(this, "use", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (middleware) => {
+                const makeRequest = this.client.request.bind(this.client);
+                this.client.request = (req) => middleware(req, makeRequest);
+            }
+        });
+        /**
+         * Technically this is not private, we can hide it from intellisense by doing this
+         */
+        Object.defineProperty(this, "addTelemetry", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (telemetry) => {
+                if (!this.enableTelemetry) {
+                    return;
+                }
+                try {
+                    // @ts-ignore - The `Requester` interface does not know about this method but it will be there
+                    // as long as the user uses the standard HttpClient
+                    this.client.mergeTelemetry(telemetry);
+                }
+                catch {
+                    // ignore
+                }
+            }
+        });
         /**
          * Create a new pipeline that allows you to send requests in bulk.
          *
@@ -40,7 +82,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
@@ -204,6 +269,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
          */
@@ -312,6 +386,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
          */
@@ -420,6 +504,15 @@ class Redis {
             writable: true,
             value: (...args) => new mod_js_1.LLenCommand(args, this.opts).exec(this.client)
         });
+        /**
+         * @see https://redis.io/commands/lmove
+         */
+        Object.defineProperty(this, "lmove", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => new mod_js_1.LMoveCommand(args, this.opts).exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/lpop
          */
@@ -429,6 +522,15 @@ class Redis {
             writable: true,
             value: (...args) => new mod_js_1.LPopCommand(args, this.opts).exec(this.client)
         });
+        /**
+         * @see https://redis.io/commands/lpos
+         */
+        Object.defineProperty(this, "lpos", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => new mod_js_1.LPosCommand(args, this.opts).exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/lpush
          */
@@ -771,6 +873,15 @@ class Redis {
             writable: true,
             value: (key, member) => new mod_js_1.SIsMemberCommand([key, member], this.opts).exec(this.client)
         });
+        /**
+         * @see https://redis.io/commands/smismember
+         */
+        Object.defineProperty(this, "smismember", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (key, members) => new mod_js_1.SMIsMemberCommand([key, members], this.opts).exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/smembers
          */
@@ -897,6 +1008,24 @@ class Redis {
             writable: true,
             value: (...args) => new mod_js_1.UnlinkCommand(args, this.opts).exec(this.client)
         });
+        /**
+         * @see https://redis.io/commands/xadd
+         */
+        Object.defineProperty(this, "xadd", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => new mod_js_1.XAddCommand(args, this.opts).exec(this.client)
+        });
+        /**
+         * @see https://redis.io/commands/xrange
+         */
+        Object.defineProperty(this, "xrange", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => new mod_js_1.XRangeCommand(args, this.opts).exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/zadd
          */
@@ -929,6 +1058,15 @@ class Redis {
             writable: true,
             value: (...args) => new mod_js_1.ZCountCommand(args, this.opts).exec(this.client)
         });
+        /**
+         * @see https://redis.io/commands/zdiffstore
+         */
+        Object.defineProperty(this, "zdiffstore", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => new zdiffstore_js_1.ZDiffStoreCommand(args, this.opts).exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/zincrby
          */
@@ -956,6 +1094,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
          */
@@ -1066,6 +1213,98 @@ class Redis {
         });
         this.client = client;
         this.opts = opts;
+        this.enableTelemetry = opts?.enableTelemetry ?? true;
+    }
+    get json() {
+        return {
+            /**
+             * @see https://redis.io/commands/json.arrappend
+             */
+            arrappend: (...args) => new mod_js_1.JsonArrAppendCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.arrindex
+             */
+            arrindex: (...args) => new mod_js_1.JsonArrIndexCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.arrinsert
+             */
+            arrinsert: (...args) => new mod_js_1.JsonArrInsertCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.arrlen
+             */
+            arrlen: (...args) => new mod_js_1.JsonArrLenCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.arrpop
+             */
+            arrpop: (...args) => new mod_js_1.JsonArrPopCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.arrtrim
+             */
+            arrtrim: (...args) => new mod_js_1.JsonArrTrimCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.clear
+             */
+            clear: (...args) => new mod_js_1.JsonClearCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.del
+             */
+            del: (...args) => new mod_js_1.JsonDelCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.forget
+             */
+            forget: (...args) => new mod_js_1.JsonForgetCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.get
+             */
+            get: (...args) => new mod_js_1.JsonGetCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.mget
+             */
+            mget: (...args) => new mod_js_1.JsonMGetCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.numincrby
+             */
+            numincrby: (...args) => new mod_js_1.JsonNumIncrByCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.nummultby
+             */
+            nummultby: (...args) => new mod_js_1.JsonNumMultByCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.objkeys
+             */
+            objkeys: (...args) => new mod_js_1.JsonObjKeysCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.objlen
+             */
+            objlen: (...args) => new mod_js_1.JsonObjLenCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.resp
+             */
+            resp: (...args) => new mod_js_1.JsonRespCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.set
+             */
+            set: (...args) => new mod_js_1.JsonSetCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.strappend
+             */
+            strappend: (...args) => new mod_js_1.JsonStrAppendCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.strlen
+             */
+            strlen: (...args) => new mod_js_1.JsonStrLenCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.toggle
+             */
+            toggle: (...args) => new mod_js_1.JsonToggleCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.type
+             */
+            type: (...args) => new mod_js_1.JsonTypeCommand(args, this.opts).exec(this.client),
+        };
+    }
+    createScript(script) {
+        return new script_js_1.Script(this, script);
     }
 }
 exports.Redis = Redis;