@upstash/redis 0.0.0-ci.fb6b986f-20221006 → 0.0.0

package/README.md

@@ -27,7 +27,7 @@ supported.
 
 ### Install
 
-#### npm
+#### Node.js
 
 ```bash
 npm install @upstash/redis
@@ -81,23 +81,12 @@ data  = await redis.spop('animals', 1)
 console.log(data)
 ```
 
-### Upgrading to v1.4.0 **(ReferenceError: fetch is not defined)**
+## Troubleshooting
 
-If you are running on nodejs v17 and earlier, `fetch` will not be natively
-supported. Platforms like Vercel, Netlify, Deno, Fastly etc. provide a polyfill
-for you. But if you are running on bare node, you need to either specify a
-polyfill yourself or change the import path to:
-
-```typescript
-import { Redis } from "@upstash/redis/with-fetch";
-```
-
-### Upgrading from v0.2.0?
-
-Please read the
-[migration guide](https://docs.upstash.com/redis/sdks/javascriptsdk/migration).
-For further explanation we wrote a
-[blog post](https://blog.upstash.com/upstash-redis-sdk-v1).
+We have a
+[dedicated page](https://docs.upstash.com/redis/sdks/javascriptsdk/troubleshooting)
+for common problems. If you can't find a solution, please
+[open an issue](https://github.com/upstash/upstash-redis/issues/new).
 
 ## Docs
 
@@ -119,5 +108,18 @@ the url and token
 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/command.js

@@ -1,6 +1,15 @@
 import { UpstashError } from "../error.js";
 import { parseResponse } from "../util.js";
-const defaultSerializer = (c) => typeof c === "string" ? c : JSON.stringify(c);
+const defaultSerializer = (c) => {
+    switch (typeof c) {
+        case "string":
+        case "number":
+        case "boolean":
+            return c;
+        default:
+            return JSON.stringify(c);
+    }
+};
 /**
  * Command offers default (de)serialization and the exec method to all commands.
  *
@@ -37,7 +46,7 @@ export class Command {
             opts.automaticDeserialization
             ? opts?.deserialize ?? parseResponse
             : (x) => x;
-        this.command = command.map(this.serialize);
+        this.command = command.map((c) => this.serialize(c));
     }
     /**
      * Execute the command using a client.
@@ -50,7 +59,7 @@ export class Command {
             throw new UpstashError(error);
         }
         if (typeof result === "undefined") {
-            throw new Error(`Request did not return a result`);
+            throw new Error("Request did not return a result");
         }
         return this.deserialize(result);
     }

package/esm/pkg/commands/getdel.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/getdel
+ */
+export class GetDelCommand extends Command {
+    constructor(cmd, opts) {
+        super(["getdel", ...cmd], opts);
+    }
+}

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/json_arrappend.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.arrappend
+ */
+export class JsonArrAppendCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.ARRAPPEND", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/json_arrindex.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.arrindex
+ */
+export class JsonArrIndexCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.ARRINDEX", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/json_arrinsert.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.arrinsert
+ */
+export class JsonArrInsertCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.ARRINSERT", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/json_arrlen.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.arrlen
+ */
+export class JsonArrLenCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.ARRLEN", cmd[0], cmd[1] ?? "$"], opts);
+    }
+}

package/esm/pkg/commands/json_arrpop.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.arrpop
+ */
+export class JsonArrPopCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.ARRPOP", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/json_arrtrim.js

@@ -0,0 +1,12 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.arrtrim
+ */
+export class JsonArrTrimCommand extends Command {
+    constructor(cmd, opts) {
+        const path = cmd[1] ?? "$";
+        const start = cmd[2] ?? 0;
+        const stop = cmd[3] ?? 0;
+        super(["JSON.ARRTRIM", cmd[0], path, start, stop], opts);
+    }
+}

package/esm/pkg/commands/json_clear.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.clear
+ */
+export class JsonClearCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.CLEAR", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/json_del.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.del
+ */
+export class JsonDelCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.DEL", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/json_forget.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.forget
+ */
+export class JsonForgetCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.FORGET", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/json_get.js

@@ -0,0 +1,30 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.get
+ */
+export class JsonGetCommand extends Command {
+    constructor(cmd, opts) {
+        const command = ["JSON.GET"];
+        if (typeof cmd[1] === "string") {
+            // @ts-ignore - we know this is a string
+            command.push(...cmd);
+        }
+        else {
+            command.push(cmd[0]);
+            if (cmd[1]) {
+                if (cmd[1].indent) {
+                    command.push("INDENT", cmd[1].indent);
+                }
+                if (cmd[1].newline) {
+                    command.push("NEWLINE", cmd[1].newline);
+                }
+                if (cmd[1].space) {
+                    command.push("SPACE", cmd[1].space);
+                }
+            }
+            // @ts-ignore - we know this is a string
+            command.push(...cmd.slice(2));
+        }
+        super(command, opts);
+    }
+}

package/esm/pkg/commands/json_mget.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.mget
+ */
+export class JsonMGetCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.MGET", ...cmd[0], cmd[1]], opts);
+    }
+}

package/esm/pkg/commands/json_numincrby.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.numincrby
+ */
+export class JsonNumIncrByCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.NUMINCRBY", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/json_nummultby.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.nummultby
+ */
+export class JsonNumMultByCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.NUMMULTBY", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/json_objkeys.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.objkeys
+ */
+export class JsonObjKeysCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.OBJKEYS", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/json_objlen.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.objlen
+ */
+export class JsonObjLenCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.OBJLEN", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/json_resp.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.resp
+ */
+export class JsonRespCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.RESP", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/json_set.js

@@ -0,0 +1,18 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.set
+ */
+export class JsonSetCommand extends Command {
+    constructor(cmd, opts) {
+        const command = ["JSON.SET", cmd[0], cmd[1], cmd[2]];
+        if (cmd[3]) {
+            if (cmd[3].nx) {
+                command.push("NX");
+            }
+            else if (cmd[3].xx) {
+                command.push("XX");
+            }
+        }
+        super(command, opts);
+    }
+}

package/esm/pkg/commands/json_strappend.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.strappend
+ */
+export class JsonStrAppendCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.STRAPPEND", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/json_strlen.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.strlen
+ */
+export class JsonStrLenCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.STRLEN", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/json_toggle.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.toggle
+ */
+export class JsonToggleCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.TOGGLE", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/json_type.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.type
+ */
+export class JsonTypeCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.TYPE", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/lmove.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/lmove
+ */
+export class LMoveCommand extends Command {
+    constructor(cmd, opts) {
+        super(["lmove", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/mod.js

@@ -17,6 +17,7 @@ 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";
@@ -29,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";
@@ -37,10 +39,32 @@ export * from "./hvals.js";
 export * from "./incr.js";
 export * from "./incrby.js";
 export * from "./incrbyfloat.js";
+export * from "./json_arrappend.js";
+export * from "./json_arrindex.js";
+export * from "./json_arrinsert.js";
+export * from "./json_arrlen.js";
+export * from "./json_arrpop.js";
+export * from "./json_arrtrim.js";
+export * from "./json_clear.js";
+export * from "./json_del.js";
+export * from "./json_forget.js";
+export * from "./json_get.js";
+export * from "./json_mget.js";
+export * from "./json_numincrby.js";
+export * from "./json_nummultby.js";
+export * from "./json_objkeys.js";
+export * from "./json_objlen.js";
+export * from "./json_resp.js";
+export * from "./json_set.js";
+export * from "./json_strappend.js";
+export * from "./json_strlen.js";
+export * from "./json_toggle.js";
+export * from "./json_type.js";
 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";
@@ -82,6 +106,7 @@ export * from "./sinter.js";
 export * from "./sinterstore.js";
 export * from "./sismember.js";
 export * from "./smembers.js";
+export * from "./smismember.js";
 export * from "./smove.js";
 export * from "./spop.js";
 export * from "./srandmember.js";
@@ -95,6 +120,7 @@ export * from "./touch.js";
 export * from "./ttl.js";
 export * from "./type.js";
 export * from "./unlink.js";
+export * from "./xadd.js";
 export * from "./zadd.js";
 export * from "./zcard.js";
 export * from "./zcount.js";

package/esm/pkg/commands/set.js

@@ -28,7 +28,7 @@ export class SetCommand extends Command {
                 command.push("pxat", opts.pxat);
             }
             else if ("keepTtl" in opts && opts.keepTtl) {
-                command.push("keepTtl", opts.keepTtl);
+                command.push("keepTtl");
             }
         }
         super(command, cmdOpts);

package/esm/pkg/commands/smismember.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/smismember
+ */
+export class SMIsMemberCommand extends Command {
+    constructor(cmd, opts) {
+        super(["smismember", cmd[0], ...cmd[1]], opts);
+    }
+}

package/esm/pkg/commands/xadd.js

@@ -0,0 +1,26 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/xadd
+ */
+export class XAddCommand extends Command {
+    constructor([key, id, entries, opts], commandOptions) {
+        const command = ["XADD", key];
+        if (opts) {
+            if (opts.nomkStream) {
+                command.push("NOMKSTREAM");
+            }
+            if (opts.trim) {
+                command.push(opts.trim.type, opts.trim.comparison, opts.trim.threshold);
+                if (typeof opts.trim.limit !== "undefined") {
+                    command.push("LIMIT", opts.trim.limit);
+                }
+            }
+        }
+        command.push(id);
+        // entries
+        Object.entries(entries).forEach(([k, v]) => {
+            command.push(k, v);
+        });
+        super(command, commandOptions);
+    }
+}

package/esm/pkg/commands/zdiffstore.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/zdiffstore
+ */
+export class ZDiffStoreCommand extends Command {
+    constructor(cmd, opts) {
+        super(["zdiffstore", ...cmd], opts);
+    }
+}