@upstash/redis 1.40.0 → 1.41.0

package/src/pkg/commands/json_mset.ts

@@ -0,0 +1,27 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+
+/**
+ * @see https://redis.io/commands/json.mset
+ * @see node_modules/@upstash/redis/docs/commands/json/mset.mdx
+ */
+export class JsonMSetCommand<
+  TData extends
+    | number
+    | string
+    | boolean
+    | Record<string, unknown>
+    | (number | string | boolean | Record<string, unknown>)[],
+> extends Command<"OK" | null, "OK" | null> {
+  constructor(
+    cmd: { key: string; path: string; value: TData }[],
+    opts?: CommandOptions<"OK" | null, "OK" | null>
+  ) {
+    const command: unknown[] = ["JSON.MSET"];
+
+    for (const c of cmd) {
+      command.push(c.key, c.path, c.value);
+    }
+    super(command, opts);
+  }
+}

package/src/pkg/commands/json_numincrby.ts

@@ -0,0 +1,15 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+
+/**
+ * @see https://redis.io/commands/json.numincrby
+ * @see node_modules/@upstash/redis/docs/commands/json/numincrby.mdx
+ */
+export class JsonNumIncrByCommand extends Command<(null | string)[], (null | number)[]> {
+  constructor(
+    cmd: [key: string, path: string, value: number],
+    opts?: CommandOptions<(null | string)[], (null | number)[]>
+  ) {
+    super(["JSON.NUMINCRBY", ...cmd], opts);
+  }
+}

package/src/pkg/commands/json_nummultby.ts

@@ -0,0 +1,15 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+
+/**
+ * @see https://redis.io/commands/json.nummultby
+ * @see node_modules/@upstash/redis/docs/commands/json/nummultby.mdx
+ */
+export class JsonNumMultByCommand extends Command<(null | string)[], (null | number)[]> {
+  constructor(
+    cmd: [key: string, path: string, value: number],
+    opts?: CommandOptions<(null | string)[], (null | number)[]>
+  ) {
+    super(["JSON.NUMMULTBY", ...cmd], opts);
+  }
+}

package/src/pkg/commands/json_objkeys.ts

@@ -0,0 +1,15 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+
+/**
+ * @see https://redis.io/commands/json.objkeys
+ * @see node_modules/@upstash/redis/docs/commands/json/objkeys.mdx
+ */
+export class JsonObjKeysCommand extends Command<(string[] | null)[], (string[] | null)[]> {
+  constructor(
+    cmd: [key: string, path?: string],
+    opts?: CommandOptions<(string[] | null)[], (string[] | null)[]>
+  ) {
+    super(["JSON.OBJKEYS", ...cmd], opts);
+  }
+}

package/src/pkg/commands/json_objlen.ts

@@ -0,0 +1,15 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+
+/**
+ * @see https://redis.io/commands/json.objlen
+ * @see node_modules/@upstash/redis/docs/commands/json/objlen.mdx
+ */
+export class JsonObjLenCommand extends Command<(number | null)[], (number | null)[]> {
+  constructor(
+    cmd: [key: string, path?: string],
+    opts?: CommandOptions<(number | null)[], (number | null)[]>
+  ) {
+    super(["JSON.OBJLEN", ...cmd], opts);
+  }
+}

package/src/pkg/commands/json_resp.ts

@@ -0,0 +1,11 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+
+/**
+ * @see https://redis.io/commands/json.resp
+ */
+export class JsonRespCommand<TData extends unknown[]> extends Command<TData, TData> {
+  constructor(cmd: [key: string, path?: string], opts?: CommandOptions<TData, TData>) {
+    super(["JSON.RESP", ...cmd], opts);
+  }
+}

package/src/pkg/commands/json_set.ts

@@ -0,0 +1,35 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+
+/**
+ * @see https://redis.io/commands/json.set
+ * @see node_modules/@upstash/redis/docs/commands/json/set.mdx
+ */
+export class JsonSetCommand<
+  TData extends
+    | number
+    | string
+    | boolean
+    | Record<string, unknown>
+    | (number | string | boolean | Record<string, unknown>)[],
+> extends Command<"OK" | null, "OK" | null> {
+  constructor(
+    cmd: [
+      key: string,
+      path: string,
+      value: TData,
+      opts?: { nx: true; xx?: never } | { nx?: never; xx: true },
+    ],
+    opts?: CommandOptions<"OK" | null, "OK" | null>
+  ) {
+    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/src/pkg/commands/json_strappend.ts

@@ -0,0 +1,15 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+
+/**
+ * @see https://redis.io/commands/json.strappend
+ * @see node_modules/@upstash/redis/docs/commands/json/strappend.mdx
+ */
+export class JsonStrAppendCommand extends Command<(null | string)[], (null | number)[]> {
+  constructor(
+    cmd: [key: string, path: string, value: string],
+    opts?: CommandOptions<(null | string)[], (null | number)[]>
+  ) {
+    super(["JSON.STRAPPEND", ...cmd], opts);
+  }
+}

package/src/pkg/commands/json_strlen.ts

@@ -0,0 +1,15 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+
+/**
+ * @see https://redis.io/commands/json.strlen
+ * @see node_modules/@upstash/redis/docs/commands/json/strlen.mdx
+ */
+export class JsonStrLenCommand extends Command<(number | null)[], (number | null)[]> {
+  constructor(
+    cmd: [key: string, path?: string],
+    opts?: CommandOptions<(number | null)[], (number | null)[]>
+  ) {
+    super(["JSON.STRLEN", ...cmd], opts);
+  }
+}

package/src/pkg/commands/json_toggle.ts

@@ -0,0 +1,12 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+
+/**
+ * @see https://redis.io/commands/json.toggle
+ * @see node_modules/@upstash/redis/docs/commands/json/toggle.mdx
+ */
+export class JsonToggleCommand extends Command<number[], number[]> {
+  constructor(cmd: [key: string, path: string], opts?: CommandOptions<number[], number[]>) {
+    super(["JSON.TOGGLE", ...cmd], opts);
+  }
+}

package/src/pkg/commands/json_type.ts

@@ -0,0 +1,12 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+
+/**
+ * @see https://redis.io/commands/json.type
+ * @see node_modules/@upstash/redis/docs/commands/json/type.mdx
+ */
+export class JsonTypeCommand extends Command<string[], string[]> {
+  constructor(cmd: [key: string, path?: string], opts?: CommandOptions<string[], string[]>) {
+    super(["JSON.TYPE", ...cmd], opts);
+  }
+}

package/src/pkg/commands/keys.ts

@@ -0,0 +1,12 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+
+/**
+ * @see https://redis.io/commands/keys
+ * @see node_modules/@upstash/redis/docs/commands/generic/keys.mdx
+ */
+export class KeysCommand extends Command<string[], string[]> {
+  constructor(cmd: [pattern: string], opts?: CommandOptions<string[], string[]>) {
+    super(["keys", ...cmd], opts);
+  }
+}

package/src/pkg/commands/lindex.ts

@@ -0,0 +1,11 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+
+export class LIndexCommand<TData = string> extends Command<unknown | null, TData | null> {
+  constructor(
+    cmd: [key: string, index: number],
+    opts?: CommandOptions<unknown | null, TData | null>
+  ) {
+    super(["lindex", ...cmd], opts);
+  }
+}

package/src/pkg/commands/linsert.ts

@@ -0,0 +1,10 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+export class LInsertCommand<TData = string> extends Command<number, number> {
+  constructor(
+    cmd: [key: string, direction: "before" | "after", pivot: TData, value: TData],
+    opts?: CommandOptions<number, number>
+  ) {
+    super(["linsert", ...cmd], opts);
+  }
+}

package/src/pkg/commands/llen.ts

@@ -0,0 +1,12 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+
+/**
+ * @see https://redis.io/commands/llen
+ * @see node_modules/@upstash/redis/docs/commands/list/llen.mdx
+ */
+export class LLenCommand extends Command<number, number> {
+  constructor(cmd: [key: string], opts?: CommandOptions<number, number>) {
+    super(["llen", ...cmd], opts);
+  }
+}

package/src/pkg/commands/lmove.ts

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

package/src/pkg/commands/lmpop.ts

@@ -0,0 +1,19 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+
+/**
+ * @see https://redis.io/commands/lmpop
+ */
+export class LmPopCommand<TValues> extends Command<
+  [string, TValues[]] | null,
+  [string, TValues[]] | null
+> {
+  constructor(
+    cmd: [numkeys: number, keys: string[], "LEFT" | "RIGHT", count?: number],
+    opts?: CommandOptions<[string, TValues[]] | null, [string, TValues[]] | null>
+  ) {
+    const [numkeys, keys, direction, count] = cmd;
+
+    super(["LMPOP", numkeys, ...keys, direction, ...(count ? ["COUNT", count] : [])], opts);
+  }
+}

package/src/pkg/commands/lpop.ts

@@ -0,0 +1,18 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+
+/**
+ * @see https://redis.io/commands/lpop
+ * @see node_modules/@upstash/redis/docs/commands/list/lpop.mdx
+ * Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
+ * true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
+ * to receive raw strings.
+ */
+export class LPopCommand<TData = string> extends Command<unknown | null, TData | null> {
+  constructor(
+    cmd: [key: string, count?: number],
+    opts?: CommandOptions<unknown | null, TData | null>
+  ) {
+    super(["lpop", ...cmd], opts);
+  }
+}

package/src/pkg/commands/lpos.ts

@@ -0,0 +1,26 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+
+/**
+ * @see https://redis.io/commands/lpos
+ * @see node_modules/@upstash/redis/docs/commands/list/lpos.mdx
+ */
+export class LPosCommand<TData = number> extends Command<TData, TData> {
+  constructor(
+    cmd: [key: string, element: unknown, opts?: { rank?: number; count?: number; maxLen?: number }],
+    opts?: CommandOptions<TData, TData>
+  ) {
+    const args = ["lpos", cmd[0], cmd[1]];
+
+    if (typeof cmd[2]?.rank === "number") {
+      args.push("rank", cmd[2].rank);
+    }
+    if (typeof cmd[2]?.count === "number") {
+      args.push("count", cmd[2].count);
+    }
+    if (typeof cmd[2]?.maxLen === "number") {
+      args.push("maxLen", cmd[2].maxLen);
+    }
+    super(args, opts);
+  }
+}

package/src/pkg/commands/lpush.ts

@@ -0,0 +1,12 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+
+/**
+ * @see https://redis.io/commands/lpush
+ * @see node_modules/@upstash/redis/docs/commands/list/lpush.mdx
+ */
+export class LPushCommand<TData = string> extends Command<number, number> {
+  constructor(cmd: [key: string, ...elements: TData[]], opts?: CommandOptions<number, number>) {
+    super(["lpush", ...cmd], opts);
+  }
+}

package/src/pkg/commands/lpushx.ts

@@ -0,0 +1,12 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+
+/**
+ * @see https://redis.io/commands/lpushx
+ * @see node_modules/@upstash/redis/docs/commands/list/lpushx.mdx
+ */
+export class LPushXCommand<TData> extends Command<number, number> {
+  constructor(cmd: [key: string, ...elements: TData[]], opts?: CommandOptions<number, number>) {
+    super(["lpushx", ...cmd], opts);
+  }
+}

package/src/pkg/commands/lrange.ts

@@ -0,0 +1,11 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+
+export class LRangeCommand<TData = string> extends Command<unknown[], TData[]> {
+  constructor(
+    cmd: [key: string, start: number, end: number],
+    opts?: CommandOptions<unknown[], TData[]>
+  ) {
+    super(["lrange", ...cmd], opts);
+  }
+}

package/src/pkg/commands/lrem.ts

@@ -0,0 +1,10 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+export class LRemCommand<TData> extends Command<number, number> {
+  constructor(
+    cmd: [key: string, count: number, value: TData],
+    opts?: CommandOptions<number, number>
+  ) {
+    super(["lrem", ...cmd], opts);
+  }
+}

package/src/pkg/commands/lset.ts

@@ -0,0 +1,8 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+
+export class LSetCommand<TData = string> extends Command<"OK", "OK"> {
+  constructor(cmd: [key: string, index: number, data: TData], opts?: CommandOptions<"OK", "OK">) {
+    super(["lset", ...cmd], opts);
+  }
+}

package/src/pkg/commands/ltrim.ts

@@ -0,0 +1,8 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+
+export class LTrimCommand extends Command<"OK", "OK"> {
+  constructor(cmd: [key: string, start: number, end: number], opts?: CommandOptions<"OK", "OK">) {
+    super(["ltrim", ...cmd], opts);
+  }
+}

package/src/pkg/commands/mget.ts

@@ -0,0 +1,15 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+/**
+ * @see https://redis.io/commands/mget
+ * @see node_modules/@upstash/redis/docs/commands/string/mget.mdx
+ * Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
+ * true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
+ * to receive raw strings.
+ */
+export class MGetCommand<TData extends unknown[]> extends Command<(string | null)[], TData> {
+  constructor(cmd: [string[]] | [...string[]], opts?: CommandOptions<(string | null)[], TData>) {
+    const keys = Array.isArray(cmd[0]) ? cmd[0] : (cmd as string[]);
+    super(["mget", ...keys], opts);
+  }
+}

package/src/pkg/commands/mod.ts

@@ -0,0 +1,222 @@
+export * from "./append";
+export * from "./arcount";
+export * from "./ardel";
+export * from "./ardelrange";
+export * from "./arget";
+export * from "./argetrange";
+export * from "./argrep";
+export * from "./arinfo";
+export * from "./arinsert";
+export * from "./arlastitems";
+export * from "./arlen";
+export * from "./armget";
+export * from "./armset";
+export * from "./arnext";
+export * from "./arop";
+export * from "./arring";
+export * from "./arscan";
+export * from "./arseek";
+export * from "./arset";
+export * from "./bitcount";
+export * from "./bitfield";
+export * from "./bitop";
+export * from "./bitpos";
+export * from "./client_setinfo";
+export * from "./command";
+export * from "./copy";
+export * from "./dbsize";
+export * from "./decr";
+export * from "./decrby";
+export * from "./del";
+export * from "./echo";
+export * from "./evalRo";
+export * from "./eval";
+export * from "./evalshaRo";
+export * from "./evalsha";
+export * from "./exec";
+export * from "./exists";
+export * from "./expire";
+export * from "./expireat";
+export * from "./fcall";
+export * from "./fcall_ro";
+export * from "./flushall";
+export * from "./flushdb";
+export * from "./function_delete";
+export * from "./function_flush";
+export * from "./function_list";
+export * from "./function_load";
+export * from "./function_stats";
+export * from "./geo_add";
+export * from "./geo_dist";
+export * from "./geo_hash";
+export * from "./geo_pos";
+export * from "./geo_search";
+export * from "./geo_search_store";
+export * from "./get";
+export * from "./getbit";
+export * from "./getdel";
+export * from "./getex";
+export * from "./getrange";
+export * from "./getset";
+export * from "./hdel";
+export * from "./hexists";
+export * from "./hexpire";
+export * from "./hexpireat";
+export * from "./hexpiretime";
+export * from "./hpersist";
+export * from "./hpexpire";
+export * from "./hpexpireat";
+export * from "./hpexpiretime";
+export * from "./hpttl";
+export * from "./hget";
+export * from "./hgetall";
+export * from "./hgetdel";
+export * from "./hgetex";
+export * from "./hincrby";
+export * from "./hincrbyfloat";
+export * from "./hkeys";
+export * from "./hlen";
+export * from "./hmget";
+export * from "./hmset";
+export * from "./hrandfield";
+export * from "./hscan";
+export * from "./hset";
+export * from "./hsetex";
+export * from "./hsetnx";
+export * from "./hstrlen";
+export * from "./httl";
+export * from "./hvals";
+export * from "./incr";
+export * from "./incrby";
+export * from "./incrbyfloat";
+export * from "./json_arrappend";
+export * from "./json_arrindex";
+export * from "./json_arrinsert";
+export * from "./json_arrlen";
+export * from "./json_arrpop";
+export * from "./json_arrtrim";
+export * from "./json_clear";
+export * from "./json_del";
+export * from "./json_forget";
+export * from "./json_get";
+export * from "./json_merge";
+export * from "./json_mget";
+export * from "./json_mset";
+export * from "./json_numincrby";
+export * from "./json_nummultby";
+export * from "./json_objkeys";
+export * from "./json_objlen";
+export * from "./json_resp";
+export * from "./json_set";
+export * from "./json_strappend";
+export * from "./json_strlen";
+export * from "./json_toggle";
+export * from "./json_type";
+export * from "./keys";
+export * from "./lindex";
+export * from "./linsert";
+export * from "./llen";
+export * from "./lmove";
+export * from "./lmpop";
+export * from "./lpop";
+export * from "./lpos";
+export * from "./lpush";
+export * from "./lpushx";
+export * from "./lrange";
+export * from "./lrem";
+export * from "./lset";
+export * from "./ltrim";
+export * from "./mget";
+export * from "./mset";
+export * from "./msetnx";
+export * from "./persist";
+export * from "./pexpire";
+export * from "./pexpireat";
+export * from "./pfadd";
+export * from "./pfcount";
+export * from "./pfmerge";
+export * from "./ping";
+export * from "./psetex";
+export * from "./pttl";
+export * from "./publish";
+export * from "./randomkey";
+export * from "./rename";
+export * from "./renamenx";
+export * from "./rpop";
+export * from "./rpush";
+export * from "./rpushx";
+export * from "./sadd";
+export * from "./scan";
+export * from "./scard";
+export * from "./script_exists";
+export * from "./script_flush";
+export * from "./script_load";
+export * from "./sdiff";
+export * from "./sdiffstore";
+export * from "./set";
+export * from "./setbit";
+export * from "./setex";
+export * from "./setnx";
+export * from "./setrange";
+export * from "./sinter";
+export * from "./sintercard";
+export * from "./sinterstore";
+export * from "./sismember";
+export * from "./smembers";
+export * from "./smismember";
+export * from "./smove";
+export * from "./spop";
+export * from "./srandmember";
+export * from "./srem";
+export * from "./sscan";
+export * from "./strlen";
+export * from "./sunion";
+export * from "./sunionstore";
+export * from "./time";
+export * from "./touch";
+export * from "./ttl";
+export * from "./type";
+export * from "./unlink";
+export * from "./vector_add";
+export * from "./vector_count";
+export * from "./vector_create";
+export * from "./vector_del";
+export * from "./vector_drop";
+export * from "./vector_get";
+export * from "./vector_info";
+export * from "./vector_query";
+export * from "./xack";
+export * from "./xackdel";
+export * from "./xadd";
+export * from "./xautoclaim";
+export * from "./xclaim";
+export * from "./xdel";
+export * from "./xdelex";
+export * from "./xgroup";
+export * from "./xinfo";
+export * from "./xlen";
+export * from "./xpending";
+export * from "./xrange";
+export * from "./xread";
+export * from "./xreadgroup";
+export * from "./xrevrange";
+export * from "./xtrim";
+export * from "./zadd";
+export * from "./zcard";
+export * from "./zcount";
+export * from "./zincrby";
+export * from "./zinterstore";
+export * from "./zlexcount";
+export * from "./zpopmax";
+export * from "./zpopmin";
+export * from "./zrange";
+export * from "./zrank";
+export * from "./zrem";
+export * from "./zremrangebylex";
+export * from "./zremrangebyrank";
+export * from "./zremrangebyscore";
+export * from "./zrevrank";
+export * from "./zscan";
+export * from "./zscore";
+export * from "./zunion";
+export * from "./zunionstore";

package/src/pkg/commands/mset.ts

@@ -0,0 +1,12 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+
+/**
+ * @see https://redis.io/commands/mset
+ * @see node_modules/@upstash/redis/docs/commands/string/mset.mdx
+ */
+export class MSetCommand<TData> extends Command<"OK", "OK"> {
+  constructor([kv]: [kv: Record<string, TData>], opts?: CommandOptions<"OK", "OK">) {
+    super(["mset", ...Object.entries(kv).flatMap(([key, value]) => [key, value])], opts);
+  }
+}