@upstash/redis 0.0.0-ci.ce266dce → 0.0.0-ci.cfa9c86e-20230504

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

@@ -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,11 +39,34 @@ 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";
 export * from "./lpushx.js";
 export * from "./lrange.js";
@@ -81,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";

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

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

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

@@ -1,7 +1,8 @@
 import { Command, CommandOptions } from "./command.js";
-export declare type ScanCommandOptions = {
+export type ScanCommandOptions = {
     match?: string;
     count?: number;
+    type?: string;
 };
 /**
  * @see https://redis.io/commands/scan

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

@@ -1,5 +1,5 @@
 import { Command, CommandOptions } from "./command.js";
-export declare type ScriptFlushCommandOptions = {
+export type ScriptFlushCommandOptions = {
     sync: true;
     async?: never;
 } | {

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

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

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

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

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

@@ -1,5 +1,5 @@
 import { Command, CommandOptions } from "./command.js";
-export declare type Type = "string" | "list" | "set" | "zset" | "hash" | "none";
+export type Type = "string" | "list" | "set" | "zset" | "hash" | "none";
 /**
  * @see https://redis.io/commands/type
  */

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

@@ -1,5 +1,5 @@
 import { Command, CommandOptions } from "./command.js";
-export declare type ZAddCommandOptions = ({
+export type ZAddCommandOptions = ({
     nx: true;
     xx?: never;
 } | {
@@ -11,10 +11,10 @@ export declare type ZAddCommandOptions = ({
 }) & {
     ch?: true;
 };
-export declare type ZAddCommandOptionsWithIncr = ZAddCommandOptions & {
+export type ZAddCommandOptionsWithIncr = ZAddCommandOptions & {
     incr: true;
 };
-export declare type ScoreMember<TData> = {
+export type ScoreMember<TData> = {
     score: number;
     member: TData;
 };
@@ -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/zdiffstore.d.ts

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

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

@@ -1,5 +1,5 @@
 import { Command, CommandOptions } from "./command.js";
-export declare type ZInterStoreCommandOptions = {
+export type ZInterStoreCommandOptions = {
     aggregate?: "sum" | "min" | "max";
 } & ({
     weight: number;

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 = {
+export 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/commands/zunionstore.d.ts

@@ -1,5 +1,5 @@
 import { Command, CommandOptions } from "./command.js";
-export declare type ZUnionStoreCommandOptions = {
+export type ZUnionStoreCommandOptions = {
     aggregate?: "sum" | "min" | "max";
 } & ({
     weight: number;

package/types/pkg/http.d.ts

@@ -1,18 +1,20 @@
-export declare type UpstashRequest = {
+import { Telemetry } from "./types.js";
+type CacheSetting = "default" | "force-cache" | "no-cache" | "no-store" | "only-if-cached" | "reload";
+export type UpstashRequest = {
     path?: string[];
     /**
      * Request body will be serialized to json
      */
     body?: unknown;
 };
-export declare type UpstashResponse<TResult> = {
+export type UpstashResponse<TResult> = {
     result?: TResult;
     error?: string;
 };
 export interface Requester {
     request: <TResult = unknown>(req: UpstashRequest) => Promise<UpstashResponse<TResult>>;
 }
-export declare type RetryConfig = false | {
+export type RetryConfig = false | {
     /**
      * The number of retries to attempt before giving up.
      *
@@ -29,26 +31,61 @@ export declare type RetryConfig = false | {
      */
     backoff?: (retryCount: number) => number;
 };
-declare type Options = {
+export type Options = {
     backend?: string;
 };
-export declare type HttpClientConfig = {
+export type RequesterConfig = {
+    /**
+     * Configure the retry behaviour in case of network errors
+     */
+    retry?: RetryConfig;
+    /**
+     * Due to the nature of dynamic and custom data, it is possible to write data to redis that is not
+     * valid json and will therefore cause errors when deserializing. This used to happen very
+     * frequently with non-utf8 data, such as emojis.
+     *
+     * By default we will therefore encode the data as base64 on the server, before sending it to the
+     * client. The client will then decode the base64 data and parse it as utf8.
+     *
+     * For very large entries, this can add a few milliseconds, so if you are sure that your data is
+     * valid utf8, you can disable this behaviour by setting this option to false.
+     *
+     * Here's what the response body looks like:
+     *
+     * ```json
+     * {
+     *  result?: "base64-encoded",
+     *  error?: string
+     * }
+     * ```
+     *
+     * @default "base64"
+     */
+    responseEncoding?: false | "base64";
+};
+export type HttpClientConfig = {
     headers?: Record<string, string>;
     baseUrl: string;
     options?: Options;
     retry?: RetryConfig;
-};
+    agent?: any;
+    cache?: CacheSetting;
+} & RequesterConfig;
 export declare class HttpClient implements Requester {
     baseUrl: string;
     headers: Record<string, string>;
-    readonly options?: {
+    readonly options: {
         backend?: string;
+        agent: any;
+        responseEncoding?: false | "base64";
+        cache?: CacheSetting;
     };
     readonly retry: {
         attempts: number;
         backoff: (retryCount: number) => number;
     };
     constructor(config: HttpClientConfig);
+    mergeTelemetry(telemetry: Telemetry): void;
     request<TResult>(req: UpstashRequest): Promise<UpstashResponse<TResult>>;
 }
 export {};

package/types/pkg/pipeline.d.ts

@@ -1,4 +1,4 @@
-import { DelCommand, ExistsCommand, FlushAllCommand, PingCommand, ScoreMember, ScriptExistsCommand, SetCommandOptions, TouchCommand, UnlinkCommand, ZAddCommandOptions, ZAddCommandOptionsWithIncr, ZRangeCommandOptions } from "./commands/mod.js";
+import { DelCommand, ExistsCommand, FlushAllCommand, JsonArrAppendCommand, JsonArrIndexCommand, JsonArrInsertCommand, JsonArrLenCommand, JsonArrPopCommand, JsonArrTrimCommand, JsonClearCommand, JsonDelCommand, JsonForgetCommand, JsonGetCommand, JsonMGetCommand, JsonNumIncrByCommand, JsonNumMultByCommand, JsonObjKeysCommand, JsonObjLenCommand, JsonRespCommand, JsonSetCommand, JsonStrAppendCommand, JsonStrLenCommand, JsonToggleCommand, JsonTypeCommand, 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";
@@ -18,7 +18,7 @@ import { CommandArgs } from "./types.js";
  * **Examples:**
  *
  * ```ts
- *  const p = redis.pipeline()
+ *  const p = redis.pipeline() // or redis.multi()
  * p.set("key","value")
  * p.get("key")
  * const res = await p.exec()
@@ -44,7 +44,12 @@ export declare class Pipeline {
     private client;
     private commands;
     private commandOptions?;
-    constructor(client: Requester, commandOptions?: CommandOptions<any, any>);
+    private multiExec;
+    constructor(opts: {
+        client: Requester;
+        commandOptions?: CommandOptions<any, any>;
+        multiExec?: boolean;
+    });
     /**
      * Send the pipeline request to upstash.
      *
@@ -79,7 +84,11 @@ 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/zdiffstore
+     */
+    zdiffstore: (destination: string, numkeys: number, ...keys: string[]) => this;
     /**
      * @see https://redis.io/commands/dbsize
      */
@@ -138,6 +147,10 @@ export declare class Pipeline {
      * @see https://redis.io/commands/getbit
      */
     getbit: (key: string, offset: number) => this;
+    /**
+     * @see https://redis.io/commands/getdel
+     */
+    getdel: <TData>(key: string) => this;
     /**
      * @see https://redis.io/commands/getrange
      */
@@ -149,7 +162,7 @@ export declare class Pipeline {
     /**
      * @see https://redis.io/commands/hdel
      */
-    hdel: (key: string, field: string) => this;
+    hdel: (key: string, ...fields: string[]) => this;
     /**
      * @see https://redis.io/commands/hexists
      */
@@ -188,6 +201,10 @@ export declare class Pipeline {
     hmset: <TData>(key: string, kv: {
         [field: string]: TData;
     }) => this;
+    /**
+     * @see https://redis.io/commands/hrandfield
+     */
+    hrandfield: <TData extends string | string[] | Record<string, unknown>>(key: string, count?: number, withValues?: boolean) => this;
     /**
      * @see https://redis.io/commands/hscan
      */
@@ -238,10 +255,22 @@ export declare class Pipeline {
      * @see https://redis.io/commands/llen
      */
     llen: (key: string) => this;
+    /**
+     * @see https://redis.io/commands/lmove
+     */
+    lmove: <TData = string>(source: string, destination: string, whereFrom: "left" | "right", whereTo: "left" | "right") => this;
     /**
      * @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 +298,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 +354,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
      */
@@ -366,7 +395,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
      */
@@ -398,7 +427,11 @@ export declare class Pipeline {
     /**
      * @see https://redis.io/commands/smembers
      */
-    smembers: (key: string) => this;
+    smembers: <TData extends unknown[] = string[]>(key: string) => this;
+    /**
+     * @see https://redis.io/commands/smismember
+     */
+    smismember: <TMembers extends unknown[]>(key: string, members: TMembers) => this;
     /**
      * @see https://redis.io/commands/smove
      */
@@ -475,6 +508,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
      */
@@ -537,4 +574,30 @@ export declare class Pipeline {
      * @see https://redis.io/commands/zunionstore
      */
     zunionstore: (destination: string, numKeys: number, keys: string[], opts?: import("./commands/zunionstore.js").ZUnionStoreCommandOptions | undefined) => this;
+    /**
+     * @see https://redis.io/commands/?group=json
+     */
+    get json(): {
+        arrappend: (...args: CommandArgs<typeof JsonArrAppendCommand>) => Pipeline;
+        arrindex: (...args: CommandArgs<typeof JsonArrIndexCommand>) => Pipeline;
+        arrinsert: (...args: CommandArgs<typeof JsonArrInsertCommand>) => Pipeline;
+        arrlen: (...args: CommandArgs<typeof JsonArrLenCommand>) => Pipeline;
+        arrpop: (...args: CommandArgs<typeof JsonArrPopCommand>) => Pipeline;
+        arrtrim: (...args: CommandArgs<typeof JsonArrTrimCommand>) => Pipeline;
+        clear: (...args: CommandArgs<typeof JsonClearCommand>) => Pipeline;
+        del: (...args: CommandArgs<typeof JsonDelCommand>) => Pipeline;
+        forget: (...args: CommandArgs<typeof JsonForgetCommand>) => Pipeline;
+        get: (...args: CommandArgs<typeof JsonGetCommand>) => Pipeline;
+        mget: (...args: CommandArgs<typeof JsonMGetCommand>) => Pipeline;
+        numincrby: (...args: CommandArgs<typeof JsonNumIncrByCommand>) => Pipeline;
+        nummultby: (...args: CommandArgs<typeof JsonNumMultByCommand>) => Pipeline;
+        objkeys: (...args: CommandArgs<typeof JsonObjKeysCommand>) => Pipeline;
+        objlen: (...args: CommandArgs<typeof JsonObjLenCommand>) => Pipeline;
+        resp: (...args: CommandArgs<typeof JsonRespCommand>) => Pipeline;
+        set: (...args: CommandArgs<typeof JsonSetCommand>) => Pipeline;
+        strappend: (...args: CommandArgs<typeof JsonStrAppendCommand>) => Pipeline;
+        strlen: (...args: CommandArgs<typeof JsonStrLenCommand>) => Pipeline;
+        toggle: (...args: CommandArgs<typeof JsonToggleCommand>) => Pipeline;
+        type: (...args: CommandArgs<typeof JsonTypeCommand>) => Pipeline;
+    };
 }