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

package/types/pkg/commands/sdiffstore.d.ts

@@ -1,6 +1,6 @@
 import { Command, CommandOptions } from "./command.js";
 /**
- * @see https://redis.io/commands/sdiffstpre
+ * @see https://redis.io/commands/sdiffstore
  */
 export declare class SDiffStoreCommand extends Command<number, number> {
     constructor(cmd: [destination: string, ...keys: string[]], opts?: CommandOptions<number, number>);

package/types/pkg/commands/set.d.ts

@@ -1,13 +1,42 @@
 import { Command, CommandOptions } from "./command.js";
-export declare type SetCommandOptions = ({
+export declare type SetCommandOptions = {
+    get: boolean;
+} | ({
     ex: number;
     px?: never;
+    exat?: never;
+    pxat?: never;
+    keepTtl?: never;
 } | {
     ex?: never;
     px: number;
+    exat?: never;
+    pxat?: never;
+    keepTtl?: never;
 } | {
     ex?: never;
     px?: never;
+    exat: number;
+    pxat?: never;
+    keepTtl?: never;
+} | {
+    ex?: never;
+    px?: never;
+    exat?: never;
+    pxat: number;
+    keepTtl?: never;
+} | {
+    ex?: never;
+    px?: never;
+    exat?: never;
+    pxat?: never;
+    keepTtl: true;
+} | {
+    ex?: never;
+    px?: never;
+    exat?: never;
+    pxat?: never;
+    keepTtl?: never;
 }) & ({
     nx: true;
     xx?: never;
@@ -21,6 +50,6 @@ export declare type SetCommandOptions = ({
 /**
  * @see https://redis.io/commands/set
  */
-export declare class SetCommand<TData, TResult = "OK"> extends Command<TResult, TData> {
+export declare class SetCommand<TData, TResult = TData | "OK" | null> extends Command<TResult, TData | "OK" | null> {
     constructor([key, value, opts]: [key: string, value: TData, opts?: SetCommandOptions], cmdOpts?: CommandOptions<TResult, TData>);
 }

package/types/pkg/commands/sinterstore.d.ts

@@ -2,6 +2,6 @@ import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/sinterstore
  */
-export declare class SInterStoreCommand<TData = string> extends Command<unknown[], TData[]> {
-    constructor(cmd: [destination: string, key: string, ...keys: string[]], opts?: CommandOptions<unknown[], TData[]>);
+export declare class SInterStoreCommand extends Command<number, number> {
+    constructor(cmd: [destination: string, key: string, ...keys: string[]], opts?: CommandOptions<number, number>);
 }

package/types/pkg/commands/spop.d.ts

@@ -2,6 +2,6 @@ import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/spop
  */
-export declare class SPopCommand<TData = number> extends Command<string | null, TData | null> {
-    constructor([key, count]: [key: string, count?: number], opts?: CommandOptions<string | null, TData | null>);
+export declare class SPopCommand<TData> extends Command<string | string[] | null, TData | null> {
+    constructor([key, count]: [key: string, count?: number], opts?: CommandOptions<string | string[] | null, TData | null>);
 }

package/types/pkg/commands/zadd.d.ts

@@ -30,6 +30,6 @@ export declare class ZAddCommand<TData = string> extends Command<number | null,
     constructor(cmd: [
         key: string,
         opts: ZAddCommandOptions | ZAddCommandOptionsWithIncr,
-        ...scoreMemberPairs: [ScoreMember<TData>, ...ScoreMember<TData>[]]
+        ...scoreMemberPairs: ScoreMember<TData>[]
     ], opts?: CommandOptions<number | null, number | null>);
 }

package/types/pkg/commands/zmscore.d.ts

@@ -0,0 +1,7 @@
+import { Command, CommandOptions } from "./command.js";
+/**
+ * @see https://redis.io/commands/zmscore
+ */
+export declare class ZMScoreCommand<TData> extends Command<string[] | null, number[] | null> {
+    constructor(cmd: [key: string, members: TData[]], opts?: CommandOptions<string[] | null, number[] | null>);
+}

package/types/pkg/commands/zrange.d.ts

@@ -1,6 +1,7 @@
 import { Command, CommandOptions } from "./command.js";
 export declare type ZRangeCommandOptions = {
     withScores?: boolean;
+    rev?: boolean;
 } & ({
     byScore: true;
     byLex?: never;
@@ -10,6 +11,12 @@ export declare type ZRangeCommandOptions = {
 } | {
     byScore?: never;
     byLex?: never;
+}) & ({
+    offset: number;
+    count: number;
+} | {
+    offset?: never;
+    count?: never;
 });
 /**
  * @see https://redis.io/commands/zrange

package/types/pkg/http.d.ts

@@ -12,12 +12,31 @@ export declare type UpstashResponse<TResult> = {
 export interface Requester {
     request: <TResult = unknown>(req: UpstashRequest) => Promise<UpstashResponse<TResult>>;
 }
+export declare type RetryConfig = false | {
+    /**
+     * The number of retries to attempt before giving up.
+     *
+     * @default 5
+     */
+    retries?: number;
+    /**
+     * A backoff function receives the current retry cound and returns a number in milliseconds to wait before retrying.
+     *
+     * @default
+     * ```ts
+     * Math.exp(retryCount) * 50
+     * ```
+     */
+    backoff?: (retryCount: number) => number;
+};
+declare type Options = {
+    backend?: string;
+};
 export declare type HttpClientConfig = {
     headers?: Record<string, string>;
     baseUrl: string;
-    options?: {
-        backend?: string;
-    };
+    options?: Options;
+    retry?: RetryConfig;
 };
 export declare class HttpClient implements Requester {
     baseUrl: string;
@@ -25,6 +44,11 @@ export declare class HttpClient implements Requester {
     readonly options?: {
         backend?: string;
     };
+    readonly retry: {
+        attempts: number;
+        backoff: (retryCount: number) => number;
+    };
     constructor(config: HttpClientConfig);
     request<TResult>(req: UpstashRequest): Promise<UpstashResponse<TResult>>;
 }
+export {};

package/types/pkg/pipeline.d.ts

@@ -1,4 +1,4 @@
-import { DelCommand, ExistsCommand, FlushAllCommand, PingCommand, ScoreMember, SetCommandOptions, TouchCommand, UnlinkCommand, ZAddCommandOptions, ZAddCommandOptionsWithIncr, ZRangeCommandOptions } from "./commands/mod.js";
+import { DelCommand, ExistsCommand, FlushAllCommand, MGetCommand, PingCommand, ScoreMember, ScriptExistsCommand, SetCommandOptions, TouchCommand, UnlinkCommand, ZAddCommandOptions, ZAddCommandOptionsWithIncr, ZRangeCommandOptions } from "./commands/mod.js";
 import { CommandOptions } from "./commands/command.js";
 import { Requester } from "./http.js";
 import { CommandArgs } from "./types.js";
@@ -79,7 +79,7 @@ export declare class Pipeline {
     /**
      * @see https://redis.io/commands/bitpos
      */
-    bitpos: (key: string, start: number, end: number) => this;
+    bitpos: (key: string, bit: 0 | 1, start?: number | undefined, end?: number | undefined) => this;
     /**
      * @see https://redis.io/commands/dbsize
      */
@@ -241,7 +241,15 @@ export declare class Pipeline {
     /**
      * @see https://redis.io/commands/lpop
      */
-    lpop: <TData>(key: string) => this;
+    lpop: <TData>(key: string, count?: number | undefined) => this;
+    /**
+     * @see https://redis.io/commands/lpos
+     */
+    lpos: <TData>(key: string, element: unknown, opts?: {
+        rank?: number | undefined;
+        count?: number | undefined;
+        maxLen?: number | undefined;
+    } | undefined) => this;
     /**
      * @see https://redis.io/commands/lpush
      */
@@ -269,7 +277,7 @@ export declare class Pipeline {
     /**
      * @see https://redis.io/commands/mget
      */
-    mget: <TData extends unknown[]>(args_0: string, ...args_1: string[]) => this;
+    mget: <TData extends unknown[]>(...args: CommandArgs<typeof MGetCommand>) => this;
     /**
      * @see https://redis.io/commands/mset
      */
@@ -325,7 +333,7 @@ export declare class Pipeline {
     /**
      * @see https://redis.io/commands/rpop
      */
-    rpop: <TData = string>(key: string) => this;
+    rpop: <TData = string>(key: string, count?: number | undefined) => this;
     /**
      * @see https://redis.io/commands/rpush
      */
@@ -349,7 +357,7 @@ export declare class Pipeline {
     /**
      * @see https://redis.io/commands/script-exists
      */
-    scriptExists: (args_0: string, ...args_1: string[]) => this;
+    scriptExists: (...args: CommandArgs<typeof ScriptExistsCommand>) => this;
     /**
      * @see https://redis.io/commands/script-flush
      */
@@ -366,7 +374,7 @@ export declare class Pipeline {
     /**
      * @see https://redis.io/commands/set
      */
-    set: <TData>(key: string, value: TData, opts?: SetCommandOptions | undefined) => this;
+    set: <TData>(key: string, value: TData, opts?: SetCommandOptions) => this;
     /**
      * @see https://redis.io/commands/setbit
      */
@@ -475,6 +483,10 @@ export declare class Pipeline {
      * @see https://redis.io/commands/zlexcount
      */
     zlexcount: (key: string, min: string, max: string) => this;
+    /**
+     * @see https://redis.io/commands/zmscore
+     */
+    zmscore: (key: string, members: unknown[]) => this;
     /**
      * @see https://redis.io/commands/zpopmax
      */

package/types/pkg/redis.d.ts

@@ -1,7 +1,8 @@
-import { CommandOptions, DelCommand, ExistsCommand, FlushAllCommand, PingCommand, ScoreMember, SetCommandOptions, TouchCommand, UnlinkCommand, ZAddCommandOptions, ZAddCommandOptionsWithIncr, ZRangeCommandOptions } from "./commands/mod.js";
-import { Requester } from "./http.js";
+import { CommandOptions, DelCommand, ExistsCommand, FlushAllCommand, MGetCommand, 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";
+import { Script } from "./script.js";
 export declare type RedisOptions = {
     /**
      * Automatically try to deserialize the returned data from upstash using `JSON.deserialize`
@@ -14,7 +15,7 @@ export declare type RedisOptions = {
  * Serverless redis client for upstash.
  */
 export declare class Redis {
-    protected readonly client: Requester;
+    protected client: Requester;
     protected opts?: CommandOptions<any, any>;
     /**
      * Create a new redis client
@@ -28,6 +29,11 @@ export declare class Redis {
      * ```
      */
     constructor(client: Requester, opts?: RedisOptions);
+    /**
+     * 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;
+    createScript(script: string): Script;
     /**
      * Create a new pipeline that allows you to send requests in bulk.
      *
@@ -52,7 +58,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
      */
@@ -160,7 +166,7 @@ export declare class Redis {
      */
     hmset: <TData>(key: string, kv: {
         [field: string]: TData;
-    }) => Promise<number>;
+    }) => Promise<"OK">;
     /**
      * @see https://redis.io/commands/hscan
      */
@@ -214,7 +220,15 @@ export declare class Redis {
     /**
      * @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 +256,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: CommandArgs<typeof MGetCommand>) => Promise<TData>;
     /**
      * @see https://redis.io/commands/mset
      */
@@ -298,7 +312,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
      */
@@ -322,7 +336,7 @@ export declare class Redis {
     /**
      * @see https://redis.io/commands/script-exists
      */
-    scriptExists: (args_0: string, ...args_1: string[]) => Promise<[]>;
+    scriptExists: (...args: CommandArgs<typeof ScriptExistsCommand>) => Promise<number[]>;
     /**
      * @see https://redis.io/commands/script-flush
      */
@@ -342,7 +356,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
      */
@@ -366,7 +380,7 @@ export declare class Redis {
     /**
      * @see https://redis.io/commands/sinterstore
      */
-    sinterstore: (destination: string, key: string, ...keys: string[]) => Promise<string[]>;
+    sinterstore: (destination: string, key: string, ...keys: string[]) => Promise<number>;
     /**
      * @see https://redis.io/commands/sismember
      */
@@ -451,6 +465,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
      */

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/platforms/cloudflare.d.ts

@@ -1,5 +1,5 @@
 import * as core from "../pkg/redis.js";
-import type { Requester, UpstashRequest, UpstashResponse } from "../pkg/http.js";
+import type { Requester, RetryConfig, UpstashRequest, UpstashResponse } from "../pkg/http.js";
 export type { Requester, UpstashRequest, UpstashResponse };
 /**
  * Connection credentials for upstash redis.
@@ -14,6 +14,10 @@ export declare type RedisConfigCloudflare = {
      * UPSTASH_REDIS_REST_TOKEN
      */
     token: string;
+    /**
+     * Configure the retry behaviour in case of network errors
+     */
+    retry?: RetryConfig;
 } & core.RedisOptions;
 /**
  * Serverless redis client for upstash.
@@ -34,5 +38,5 @@ export declare class Redis extends core.Redis {
     static fromEnv(env?: {
         UPSTASH_REDIS_REST_URL: string;
         UPSTASH_REDIS_REST_TOKEN: string;
-    }): Redis;
+    }, opts?: Omit<RedisConfigCloudflare, "url" | "token">): Redis;
 }

package/types/platforms/fastly.d.ts

@@ -1,5 +1,5 @@
 import * as core from "../pkg/redis.js";
-import type { Requester, UpstashRequest, UpstashResponse } from "../pkg/http.js";
+import type { Requester, RetryConfig, UpstashRequest, UpstashResponse } from "../pkg/http.js";
 export type { Requester, UpstashRequest, UpstashResponse };
 /**
  * Connection credentials for upstash redis.
@@ -20,6 +20,10 @@ export declare type RedisConfigFastly = {
      * referenced by name.
      */
     backend: string;
+    /**
+     * Configure the retry behaviour in case of network errors
+     */
+    retry?: RetryConfig;
 } & core.RedisOptions;
 /**
  * Serverless redis client for upstash.

package/types/platforms/node_with_fetch.d.ts

@@ -1,5 +1,5 @@
 import * as core from "../pkg/redis.js";
-import { Requester, UpstashRequest, UpstashResponse } from "../pkg/http.js";
+import { Requester, RetryConfig, UpstashRequest, UpstashResponse } from "../pkg/http.js";
 import "isomorphic-fetch";
 export type { Requester, UpstashRequest, UpstashResponse };
 /**
@@ -15,6 +15,25 @@ 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;
 /**
  * Serverless redis client for upstash.

package/types/platforms/nodejs.d.ts

@@ -1,5 +1,5 @@
 import * as core from "../pkg/redis.js";
-import { Requester, UpstashRequest, UpstashResponse } from "../pkg/http.js";
+import { Requester, RetryConfig, UpstashRequest, UpstashResponse } from "../pkg/http.js";
 export type { Requester, UpstashRequest, UpstashResponse };
 /**
  * Connection credentials for upstash redis.
@@ -14,6 +14,25 @@ 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;
 /**
  * Serverless redis client for upstash.