@upstash/redis 1.40.0 → 1.41.0

package/src/pkg/commands/zpopmin.ts

@@ -0,0 +1,18 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+/**
+ * @see https://redis.io/commands/zpopmin
+ * @see node_modules/@upstash/redis/docs/commands/zset/zpopmin.mdx
+ */
+export class ZPopMinCommand<TData> extends Command<string[], TData[]> {
+  constructor(
+    [key, count]: [key: string, count?: number],
+    opts?: CommandOptions<string[], TData[]>
+  ) {
+    const command: unknown[] = ["zpopmin", key];
+    if (typeof count === "number") {
+      command.push(count);
+    }
+    super(command, opts);
+  }
+}

package/src/pkg/commands/zrange.ts

@@ -0,0 +1,72 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+
+export type ZRangeCommandOptions = {
+  withScores?: boolean;
+  rev?: boolean;
+} & (
+  | { byScore: true; byLex?: never }
+  | { byScore?: never; byLex: true }
+  | { byScore?: never; byLex?: never }
+) &
+  ({ offset: number; count: number } | { offset?: never; count?: never });
+/**
+ * @see https://redis.io/commands/zrange
+ * @see node_modules/@upstash/redis/docs/commands/zset/zrange.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 ZRangeCommand<TData extends unknown[]> extends Command<string[], TData> {
+  constructor(
+    cmd: [key: string, min: number, max: number, opts?: ZRangeCommandOptions],
+    cmdOpts?: CommandOptions<string[], TData>
+  );
+  constructor(
+    cmd: [
+      key: string,
+      min: `(${string}` | `[${string}` | "-" | "+",
+      max: `(${string}` | `[${string}` | "-" | "+",
+      opts: { byLex: true } & ZRangeCommandOptions,
+    ],
+    cmdOpts?: CommandOptions<string[], TData>
+  );
+  constructor(
+    cmd: [
+      key: string,
+      min: number | `(${number}` | "-inf" | "+inf",
+      max: number | `(${number}` | "-inf" | "+inf",
+      opts: { byScore: true } & ZRangeCommandOptions,
+    ],
+    cmdOpts?: CommandOptions<string[], TData>
+  );
+  constructor(
+    [key, min, max, opts]: [
+      key: string,
+      min: number | string,
+      max: number | string,
+      opts?: ZRangeCommandOptions,
+    ],
+    cmdOpts?: CommandOptions<string[], TData>
+  ) {
+    const command: unknown[] = ["zrange", key, min, max];
+
+    // Either byScore or byLex is allowed
+    if (opts?.byScore) {
+      command.push("byscore");
+    }
+    if (opts?.byLex) {
+      command.push("bylex");
+    }
+    if (opts?.rev) {
+      command.push("rev");
+    }
+    if (opts?.count !== undefined && opts.offset !== undefined) {
+      command.push("limit", opts.offset, opts.count);
+    }
+    if (opts?.withScores) {
+      command.push("withscores");
+    }
+    super(command, cmdOpts);
+  }
+}

package/src/pkg/commands/zrank.ts

@@ -0,0 +1,14 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+/**
+ *  @see https://redis.io/commands/zrank
+ */
+
+export class ZRankCommand<TData> extends Command<number | null, number | null> {
+  constructor(
+    cmd: [key: string, member: TData],
+    opts?: CommandOptions<number | null, number | null>
+  ) {
+    super(["zrank", ...cmd], opts);
+  }
+}

package/src/pkg/commands/zrem.ts

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

package/src/pkg/commands/zremrangebylex.ts

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

package/src/pkg/commands/zremrangebyrank.ts

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

package/src/pkg/commands/zremrangebyscore.ts

@@ -0,0 +1,18 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+/**
+ * @see https://redis.io/commands/zremrangebyscore
+ * @see node_modules/@upstash/redis/docs/commands/zset/zremrangebyscore.mdx
+ */
+export class ZRemRangeByScoreCommand extends Command<number, number> {
+  constructor(
+    cmd: [
+      key: string,
+      min: number | `(${number}` | "-inf" | "+inf",
+      max: number | `(${number}` | "-inf" | "+inf",
+    ],
+    opts?: CommandOptions<number, number>
+  ) {
+    super(["zremrangebyscore", ...cmd], opts);
+  }
+}

package/src/pkg/commands/zrevrank.ts

@@ -0,0 +1,14 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+/**
+ *  @see https://redis.io/commands/zrevrank
+ */
+
+export class ZRevRankCommand<TData> extends Command<number | null, number | null> {
+  constructor(
+    cmd: [key: string, member: TData],
+    opts?: CommandOptions<number | null, number | null>
+  ) {
+    super(["zrevrank", ...cmd], opts);
+  }
+}

package/src/pkg/commands/zscan.ts

@@ -0,0 +1,31 @@
+import { deserializeScanResponse } from "../util";
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+import type { ScanCommandOptions } from "./scan";
+
+/**
+ * @see https://redis.io/commands/zscan
+ * @see node_modules/@upstash/redis/docs/commands/zset/zscan.mdx
+ */
+export class ZScanCommand extends Command<
+  [string, (string | number)[]],
+  [string, (string | number)[]]
+> {
+  constructor(
+    [key, cursor, opts]: [key: string, cursor: string | number, opts?: ScanCommandOptions],
+    cmdOpts?: CommandOptions<[string, (string | number)[]], [string, (string | number)[]]>
+  ) {
+    const command: (number | string)[] = ["zscan", key, cursor];
+    if (opts?.match) {
+      command.push("match", opts.match);
+    }
+    if (typeof opts?.count === "number") {
+      command.push("count", opts.count);
+    }
+
+    super(command, {
+      deserialize: deserializeScanResponse,
+      ...cmdOpts,
+    });
+  }
+}

package/src/pkg/commands/zscore.ts

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

package/src/pkg/commands/zunion.ts

@@ -0,0 +1,54 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+
+export type ZUnionCommandOptions = {
+  withScores?: boolean;
+  aggregate?: "sum" | "min" | "max";
+} & (
+  | { weight: number; weights?: never }
+  | { weight?: never; weights: number[] }
+  | { weight?: never; weights?: never }
+);
+
+/**
+ * @see https://redis.io/commands/zunion
+ */
+export class ZUnionCommand<TData extends unknown[]> extends Command<string[], TData> {
+  constructor(
+    cmd: [numKeys: 1, key: string, opts?: ZUnionCommandOptions],
+    cmdOpts?: CommandOptions<string[], TData>
+  );
+  constructor(
+    cmd: [numKeys: number, keys: string[], opts?: ZUnionCommandOptions],
+    cmdOpts?: CommandOptions<string[], TData>
+  );
+  constructor(
+    [numKeys, keyOrKeys, opts]: [
+      numKeys: number,
+      keyOrKeys: string | string[],
+      opts?: ZUnionCommandOptions,
+    ],
+    cmdOpts?: CommandOptions<string[], TData>
+  ) {
+    const command: unknown[] = ["zunion", numKeys];
+    if (Array.isArray(keyOrKeys)) {
+      command.push(...keyOrKeys);
+    } else {
+      command.push(keyOrKeys);
+    }
+    if (opts) {
+      if ("weights" in opts && opts.weights) {
+        command.push("weights", ...opts.weights);
+      } else if ("weight" in opts && typeof opts.weight === "number") {
+        command.push("weights", opts.weight);
+      }
+      if ("aggregate" in opts) {
+        command.push("aggregate", opts.aggregate);
+      }
+      if (opts.withScores) {
+        command.push("withscores");
+      }
+    }
+    super(command, cmdOpts);
+  }
+}

package/src/pkg/commands/zunionstore.ts

@@ -0,0 +1,52 @@
+import type { CommandOptions } from "./command";
+import { Command } from "./command";
+
+export type ZUnionStoreCommandOptions = {
+  aggregate?: "sum" | "min" | "max";
+} & (
+  | { weight: number; weights?: never }
+  | { weight?: never; weights: number[] }
+  | { weight?: never; weights?: never }
+);
+
+/**
+ * @see https://redis.io/commands/zunionstore
+ * @see node_modules/@upstash/redis/docs/commands/zset/zunionstore.mdx
+ */
+export class ZUnionStoreCommand extends Command<number, number> {
+  constructor(
+    cmd: [destination: string, numKeys: 1, key: string, opts?: ZUnionStoreCommandOptions],
+    cmdOpts?: CommandOptions<number, number>
+  );
+  constructor(
+    cmd: [destination: string, numKeys: number, keys: string[], opts?: ZUnionStoreCommandOptions],
+    cmdOpts?: CommandOptions<number, number>
+  );
+  constructor(
+    [destination, numKeys, keyOrKeys, opts]: [
+      destination: string,
+      numKeys: number,
+      keyOrKeys: string | string[],
+      opts?: ZUnionStoreCommandOptions,
+    ],
+    cmdOpts?: CommandOptions<number, number>
+  ) {
+    const command: unknown[] = ["zunionstore", destination, numKeys];
+    if (Array.isArray(keyOrKeys)) {
+      command.push(...keyOrKeys);
+    } else {
+      command.push(keyOrKeys);
+    }
+    if (opts) {
+      if ("weights" in opts && opts.weights) {
+        command.push("weights", ...opts.weights);
+      } else if ("weight" in opts && typeof opts.weight === "number") {
+        command.push("weights", opts.weight);
+      }
+      if ("aggregate" in opts) {
+        command.push("aggregate", opts.aggregate);
+      }
+    }
+    super(command, cmdOpts);
+  }
+}

package/src/pkg/error.ts

@@ -0,0 +1,28 @@
+type UpstashErrorOptions = Pick<NonNullable<ConstructorParameters<typeof Error>[1]>, "cause">;
+
+/**
+ * Result of a bad request to upstash
+ */
+export class UpstashError extends Error {
+  constructor(message: string, options?: ErrorOptions) {
+    super(message, options);
+    this.name = "UpstashError";
+  }
+}
+
+export class UrlError extends Error {
+  constructor(url: string) {
+    super(
+      `Upstash Redis client was passed an invalid URL. You should pass a URL starting with https. Received: "${url}". `
+    );
+    this.name = "UrlError";
+  }
+}
+
+export class UpstashJSONParseError extends UpstashError {
+  constructor(body: string, options?: UpstashErrorOptions) {
+    const truncatedBody = body.length > 200 ? body.slice(0, 200) + "..." : body;
+    super(`Unable to parse response body: ${truncatedBody}`, options);
+    this.name = "UpstashJSONParseError";
+  }
+}