@upstash/redis 0.0.0-ci.e3757170 → 0.0.0-ci.e4fa3be6-20231018

package/types/pkg/redis.d.ts

@@ -1,21 +1,17 @@
-import { CommandOptions, DelCommand, ExistsCommand, FlushAllCommand, PingCommand, ScoreMember, ScriptExistsCommand, SetCommandOptions, TouchCommand, UnlinkCommand, ZAddCommandOptions, ZAddCommandOptionsWithIncr, ZRangeCommandOptions } from "./commands/mod.js";
-import { Requester } from "./http.js";
+import { CommandOptions, DelCommand, ExistsCommand, FlushAllCommand, JsonGetCommand, PingCommand, ScoreMember, ScriptExistsCommand, SetCommandOptions, TouchCommand, UnlinkCommand, ZAddCommandOptions, ZAddCommandOptionsWithIncr, ZRangeCommandOptions } from "./commands/mod.js";
+import { Requester, UpstashRequest, UpstashResponse } from "./http.js";
 import { Pipeline } from "./pipeline.js";
 import type { CommandArgs } from "./types.js";
-export declare type RedisOptions = {
-    /**
-     * Automatically try to deserialize the returned data from upstash using `JSON.deserialize`
-     *
-     * @default true
-     */
-    automaticDeserialization?: boolean;
-};
+import { Script } from "./script.js";
+import type { RedisOptions, Telemetry } from "./types.js";
+export type { RedisOptions } from "./types.js";
 /**
  * Serverless redis client for upstash.
  */
 export declare class Redis {
-    protected readonly client: Requester;
+    protected client: Requester;
     protected opts?: CommandOptions<any, any>;
+    protected enableTelemetry: boolean;
     /**
      * Create a new redis client
      *
@@ -28,12 +24,127 @@ export declare class Redis {
      * ```
      */
     constructor(client: Requester, opts?: RedisOptions);
+    get json(): {
+        /**
+         * @see https://redis.io/commands/json.arrappend
+         */
+        arrappend: (key: string, path: string, ...values: unknown[]) => Promise<(number | null)[]>;
+        /**
+         * @see https://redis.io/commands/json.arrindex
+         */
+        arrindex: (key: string, path: string, value: unknown, start?: number | undefined, stop?: number | undefined) => Promise<(number | null)[]>;
+        /**
+         * @see https://redis.io/commands/json.arrinsert
+         */
+        arrinsert: (key: string, path: string, index: number, ...values: unknown[]) => Promise<(number | null)[]>;
+        /**
+         * @see https://redis.io/commands/json.arrlen
+         */
+        arrlen: (key: string, path?: string | undefined) => Promise<(number | null)[]>;
+        /**
+         * @see https://redis.io/commands/json.arrpop
+         */
+        arrpop: (key: string, path?: string | undefined, index?: number | undefined) => Promise<unknown[]>;
+        /**
+         * @see https://redis.io/commands/json.arrtrim
+         */
+        arrtrim: (key: string, path?: string | undefined, start?: number | undefined, stop?: number | undefined) => Promise<(number | null)[]>;
+        /**
+         * @see https://redis.io/commands/json.clear
+         */
+        clear: (key: string, path?: string | undefined) => Promise<number>;
+        /**
+         * @see https://redis.io/commands/json.del
+         */
+        del: (key: string, path?: string | undefined) => Promise<number>;
+        /**
+         * @see https://redis.io/commands/json.forget
+         */
+        forget: (key: string, path?: string | undefined) => Promise<number>;
+        /**
+         * @see https://redis.io/commands/geoadd
+         */
+        geoadd: (args_0: string, args_1: import("./commands/geo_add.js").GeoAddCommandOptions | import("./commands/geo_add.js").GeoMember<unknown>, ...args_2: import("./commands/geo_add.js").GeoMember<unknown>[]) => Promise<number | null>;
+        /**
+         * @see https://redis.io/commands/json.get
+         */
+        get: (...args: CommandArgs<typeof JsonGetCommand>) => Promise<any>;
+        /**
+         * @see https://redis.io/commands/json.mget
+         */
+        mget: (keys: string[], path: string) => Promise<any>;
+        /**
+         * @see https://redis.io/commands/json.numincrby
+         */
+        numincrby: (key: string, path: string, value: number) => Promise<(number | null)[]>;
+        /**
+         * @see https://redis.io/commands/json.nummultby
+         */
+        nummultby: (key: string, path: string, value: number) => Promise<(number | null)[]>;
+        /**
+         * @see https://redis.io/commands/json.objkeys
+         */
+        objkeys: (key: string, path?: string | undefined) => Promise<(string[] | null)[]>;
+        /**
+         * @see https://redis.io/commands/json.objlen
+         */
+        objlen: (key: string, path?: string | undefined) => Promise<(number | null)[]>;
+        /**
+         * @see https://redis.io/commands/json.resp
+         */
+        resp: (key: string, path?: string | undefined) => Promise<any>;
+        /**
+         * @see https://redis.io/commands/json.set
+         */
+        set: (key: string, path: string, value: string | number | boolean | Record<string, unknown> | (string | number | boolean | Record<string, unknown>)[], opts?: {
+            nx: true;
+            xx?: undefined;
+        } | {
+            nx?: undefined;
+            xx: true;
+        } | undefined) => Promise<"OK" | null>;
+        /**
+         * @see https://redis.io/commands/json.strappend
+         */
+        strappend: (key: string, path: string, value: string) => Promise<(number | null)[]>;
+        /**
+         * @see https://redis.io/commands/json.strlen
+         */
+        strlen: (key: string, path?: string | undefined) => Promise<(number | null)[]>;
+        /**
+         * @see https://redis.io/commands/json.toggle
+         */
+        toggle: (key: string, path: string) => Promise<number[]>;
+        /**
+         * @see https://redis.io/commands/json.type
+         */
+        type: (key: string, path?: string | undefined) => Promise<string[]>;
+    };
+    /**
+     * Wrap a new middleware around the HTTP client.
+     */
+    use: <TResult = unknown>(middleware: (r: UpstashRequest, next: <TResult_1 = unknown>(req: UpstashRequest) => Promise<UpstashResponse<TResult_1>>) => Promise<UpstashResponse<TResult>>) => void;
+    /**
+     * Technically this is not private, we can hide it from intellisense by doing this
+     */
+    protected addTelemetry: (telemetry: Telemetry) => void;
+    createScript(script: string): Script;
     /**
      * Create a new pipeline that allows you to send requests in bulk.
      *
      * @see {@link Pipeline}
      */
-    pipeline: () => Pipeline;
+    pipeline: () => Pipeline<[]>;
+    /**
+     * 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}
+     */
+    multi: () => Pipeline<[]>;
     /**
      * @see https://redis.io/commands/append
      */
@@ -52,7 +163,7 @@ export declare class Redis {
     /**
      * @see https://redis.io/commands/bitpos
      */
-    bitpos: (key: string, start: number, end: number) => Promise<number>;
+    bitpos: (key: string, bit: 0 | 1, start?: number | undefined, end?: number | undefined) => Promise<number>;
     /**
      * @see https://redis.io/commands/dbsize
      */
@@ -111,6 +222,10 @@ export declare class Redis {
      * @see https://redis.io/commands/getbit
      */
     getbit: (key: string, offset: number) => Promise<0 | 1>;
+    /**
+     * @see https://redis.io/commands/getdel
+     */
+    getdel: <TData>(key: string) => Promise<TData | null>;
     /**
      * @see https://redis.io/commands/getrange
      */
@@ -122,7 +237,7 @@ export declare class Redis {
     /**
      * @see https://redis.io/commands/hdel
      */
-    hdel: (key: string, field: string) => Promise<0 | 1>;
+    hdel: (key: string, ...fields: string[]) => Promise<0 | 1>;
     /**
      * @see https://redis.io/commands/hexists
      */
@@ -161,6 +276,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
      */
@@ -211,10 +334,22 @@ export declare class Redis {
      * @see https://redis.io/commands/llen
      */
     llen: (key: string) => Promise<number>;
+    /**
+     * @see https://redis.io/commands/lmove
+     */
+    lmove: <TData = string>(source: string, destination: string, whereFrom: "left" | "right", whereTo: "left" | "right") => Promise<TData>;
     /**
      * @see https://redis.io/commands/lpop
      */
-    lpop: <TData>(key: string) => Promise<TData | null>;
+    lpop: <TData>(key: string, count?: number | undefined) => Promise<TData | null>;
+    /**
+     * @see https://redis.io/commands/lpos
+     */
+    lpos: <TData = number>(key: string, element: unknown, opts?: {
+        rank?: number | undefined;
+        count?: number | undefined;
+        maxLen?: number | undefined;
+    } | undefined) => Promise<TData>;
     /**
      * @see https://redis.io/commands/lpush
      */
@@ -242,7 +377,7 @@ export declare class Redis {
     /**
      * @see https://redis.io/commands/mget
      */
-    mget: <TData extends unknown[]>(args_0: string, ...args_1: string[]) => Promise<TData>;
+    mget: <TData extends unknown[]>(...args: (string | string[])[]) => Promise<TData>;
     /**
      * @see https://redis.io/commands/mset
      */
@@ -298,7 +433,7 @@ export declare class Redis {
     /**
      * @see https://redis.io/commands/rpop
      */
-    rpop: <TData = string>(key: string) => Promise<TData | null>;
+    rpop: <TData = string>(key: string, count?: number | undefined) => Promise<TData | null>;
     /**
      * @see https://redis.io/commands/rpush
      */
@@ -342,7 +477,7 @@ export declare class Redis {
     /**
      * @see https://redis.io/commands/set
      */
-    set: <TData>(key: string, value: TData, opts?: SetCommandOptions | undefined) => Promise<TData>;
+    set: <TData>(key: string, value: TData, opts?: SetCommandOptions) => Promise<"OK" | TData | null>;
     /**
      * @see https://redis.io/commands/setbit
      */
@@ -371,10 +506,14 @@ export declare class Redis {
      * @see https://redis.io/commands/sismember
      */
     sismember: <TData>(key: string, member: TData) => Promise<0 | 1>;
+    /**
+     * @see https://redis.io/commands/smismember
+     */
+    smismember: <TMembers extends unknown[]>(key: string, members: TMembers) => Promise<(0 | 1)[]>;
     /**
      * @see https://redis.io/commands/smembers
      */
-    smembers: (key: string) => Promise<string[]>;
+    smembers: <TData extends unknown[] = string[]>(key: string) => Promise<TData>;
     /**
      * @see https://redis.io/commands/smove
      */
@@ -427,6 +566,31 @@ export declare class Redis {
      * @see https://redis.io/commands/unlink
      */
     unlink: (...args: CommandArgs<typeof UnlinkCommand>) => Promise<number>;
+    /**
+     * @see https://redis.io/commands/xadd
+     */
+    xadd: (key: string, id: string, entries: {
+        [field: string]: unknown;
+    }, opts?: {
+        nomkStream?: boolean | undefined;
+        trim?: (({
+            type: "MAXLEN" | "maxlen";
+            threshold: number;
+        } | {
+            type: "MINID" | "minid";
+            threshold: string;
+        }) & ({
+            comparison: "~";
+            limit?: number | undefined;
+        } | {
+            comparison: "=";
+            limit?: undefined;
+        })) | undefined;
+    } | undefined) => Promise<string>;
+    /**
+     * @see https://redis.io/commands/xrange
+     */
+    xrange: (key: string, start: string, end: string, count?: number | undefined) => Promise<Record<string, Record<string, unknown>>>;
     /**
      * @see https://redis.io/commands/zadd
      */
@@ -439,6 +603,10 @@ export declare class Redis {
      * @see https://redis.io/commands/zcount
      */
     zcount: (key: string, min: string | number, max: string | number) => Promise<number>;
+    /**
+     * @see https://redis.io/commands/zdiffstore
+     */
+    zdiffstore: (destination: string, numkeys: number, ...keys: string[]) => Promise<number>;
     /**
      * @see https://redis.io/commands/zincrby
      */
@@ -451,6 +619,10 @@ export declare class Redis {
      * @see https://redis.io/commands/zlexcount
      */
     zlexcount: (key: string, min: string, max: string) => Promise<number>;
+    /**
+     * @see https://redis.io/commands/zmscore
+     */
+    zmscore: (key: string, members: unknown[]) => Promise<number[] | null>;
     /**
      * @see https://redis.io/commands/zpopmax
      */
@@ -509,6 +681,10 @@ export declare class Redis {
      * @see https://redis.io/commands/zscore
      */
     zscore: <TData>(key: string, member: TData) => Promise<number | null>;
+    /**
+     * @see https://redis.io/commands/zunion
+     */
+    zunion: (numKeys: number, keys: string[], opts?: import("./commands/zunion.js").ZUnionCommandOptions | undefined) => Promise<any>;
     /**
      * @see https://redis.io/commands/zunionstore
      */

package/types/pkg/script.d.ts

@@ -0,0 +1,42 @@
+import { Redis } from "./redis.js";
+/**
+ * Creates a new script.
+ *
+ * Scripts offer the ability to optimistically try to execute a script without having to send the
+ * entire script to the server. If the script is loaded on the server, it tries again by sending
+ * the entire script. Afterwards, the script is cached on the server.
+ *
+ * @example
+ * ```ts
+ * const redis = new Redis({...})
+ *
+ * const script = redis.createScript<string>("return ARGV[1];")
+ * const arg1 = await script.eval([], ["Hello World"])
+ * assertEquals(arg1, "Hello World")
+ * ```
+ */
+export declare class Script<TResult = unknown> {
+    readonly script: string;
+    readonly sha1: string;
+    private readonly redis;
+    constructor(redis: Redis, script: string);
+    /**
+     * Send an `EVAL` command to redis.
+     */
+    eval(keys: string[], args: string[]): Promise<TResult>;
+    /**
+     * Calculates the sha1 hash of the script and then calls `EVALSHA`.
+     */
+    evalsha(keys: string[], args: string[]): Promise<TResult>;
+    /**
+     * Optimistically try to run `EVALSHA` first.
+     * If the script is not loaded in redis, it will fall back and try again with `EVAL`.
+     *
+     * Following calls will be able to use the cached script
+     */
+    exec(keys: string[], args: string[]): Promise<TResult>;
+    /**
+     * Compute the sha1 hash of the script and return its hex representation.
+     */
+    private digest;
+}

package/types/pkg/types.d.ts

@@ -1 +1,27 @@
-export declare type CommandArgs<TCommand extends new (...args: any) => any> = ConstructorParameters<TCommand>[0];
+export type CommandArgs<TCommand extends new (...args: any) => any> = ConstructorParameters<TCommand>[0];
+export type 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;
+};
+export type RedisOptions = {
+    /**
+     * Automatically try to deserialize the returned data from upstash using `JSON.deserialize`
+     *
+     * @default true
+     */
+    automaticDeserialization?: boolean;
+    enableTelemetry?: boolean;
+};

package/types/platforms/cloudflare.d.ts

@@ -1,11 +1,15 @@
 import * as core from "../pkg/redis.js";
-import type { Requester, RetryConfig, UpstashRequest, UpstashResponse } from "../pkg/http.js";
+import type { Requester, UpstashRequest, UpstashResponse } from "../pkg/http.js";
+import { RequesterConfig } from "../pkg/http.js";
+type Env = {
+    UPSTASH_DISABLE_TELEMETRY?: string;
+};
 export type { Requester, UpstashRequest, UpstashResponse };
 /**
  * Connection credentials for upstash redis.
  * Get them from https://console.upstash.com/redis/<uuid>
  */
-export declare type RedisConfigCloudflare = {
+export type RedisConfigCloudflare = {
     /**
      * UPSTASH_REDIS_REST_URL
      */
@@ -14,11 +18,7 @@ export declare type RedisConfigCloudflare = {
      * UPSTASH_REDIS_REST_TOKEN
      */
     token: string;
-    /**
-     * Configure the retry behaviour in case of network errors
-     */
-    retry?: RetryConfig;
-} & core.RedisOptions;
+} & core.RedisOptions & RequesterConfig & Env;
 /**
  * Serverless redis client for upstash.
  */
@@ -34,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/platforms/fastly.d.ts

@@ -1,11 +1,11 @@
 import * as core from "../pkg/redis.js";
-import type { Requester, RetryConfig, UpstashRequest, UpstashResponse } from "../pkg/http.js";
+import type { Requester, RequesterConfig, UpstashRequest, UpstashResponse } from "../pkg/http.js";
 export type { Requester, UpstashRequest, UpstashResponse };
 /**
  * Connection credentials for upstash redis.
  * Get them from https://console.upstash.com/redis/<uuid>
  */
-export declare type RedisConfigFastly = {
+export type RedisConfigFastly = {
     /**
      * UPSTASH_REDIS_REST_URL
      */
@@ -20,11 +20,7 @@ export declare type RedisConfigFastly = {
      * referenced by name.
      */
     backend: string;
-    /**
-     * Configure the retry behaviour in case of network errors
-     */
-    retry?: RetryConfig;
-} & core.RedisOptions;
+} & core.RedisOptions & RequesterConfig;
 /**
  * Serverless redis client for upstash.
  */

package/types/platforms/node_with_fetch.d.ts

@@ -1,12 +1,12 @@
 import * as core from "../pkg/redis.js";
-import { Requester, RetryConfig, UpstashRequest, UpstashResponse } from "../pkg/http.js";
+import { Requester, RequesterConfig, UpstashRequest, UpstashResponse } from "../pkg/http.js";
 import "isomorphic-fetch";
 export type { Requester, UpstashRequest, UpstashResponse };
 /**
  * Connection credentials for upstash redis.
  * Get them from https://console.upstash.com/redis/<uuid>
  */
-export declare type RedisConfigNodejs = {
+export type RedisConfigNodejs = {
     /**
      * UPSTASH_REDIS_REST_URL
      */
@@ -15,26 +15,7 @@ export declare type RedisConfigNodejs = {
      * UPSTASH_REDIS_REST_TOKEN
      */
     token: string;
-    /**
-     * An agent allows you to reuse connections to reduce latency for multiple sequential requests.
-     *
-     * This is a node specific implementation and is not supported in various runtimes like Vercel
-     * edge functions.
-     *
-     * @example
-     * ```ts
-     * import https from "https"
-     *
-     * const options: RedisConfigNodejs = {
-     *  agent: new https.Agent({ keepAlive: true })
-     * }
-     * ```
-     */
-    /**
-     * Configure the retry behaviour in case of network errors
-     */
-    retry?: RetryConfig;
-} & core.RedisOptions;
+} & core.RedisOptions & RequesterConfig;
 /**
  * Serverless redis client for upstash.
  */

package/types/platforms/nodejs.d.ts

@@ -1,11 +1,11 @@
 import * as core from "../pkg/redis.js";
-import { Requester, RetryConfig, UpstashRequest, UpstashResponse } from "../pkg/http.js";
+import { Requester, RequesterConfig, UpstashRequest, UpstashResponse } from "../pkg/http.js";
 export type { Requester, UpstashRequest, UpstashResponse };
 /**
  * Connection credentials for upstash redis.
  * Get them from https://console.upstash.com/redis/<uuid>
  */
-export declare type RedisConfigNodejs = {
+export type RedisConfigNodejs = {
     /**
      * UPSTASH_REDIS_REST_URL
      */
@@ -29,11 +29,8 @@ export declare type RedisConfigNodejs = {
      * }
      * ```
      */
-    /**
-     * Configure the retry behaviour in case of network errors
-     */
-    retry?: RetryConfig;
-} & core.RedisOptions;
+    agent?: any;
+} & core.RedisOptions & RequesterConfig;
 /**
  * Serverless redis client for upstash.
  */

package/types/version.d.ts

@@ -0,0 +1 @@
+export declare const VERSION = "v0.0.0-ci.e4fa3be6-20231018";