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

package/script/version.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VERSION = void 0;
+exports.VERSION = "v0.0.0";

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

@@ -1,7 +1,7 @@
 import { Requester } from "../http.js";
-declare type Serialize = (data: unknown) => string;
-declare type Deserialize<TResult, TData> = (result: TResult) => TData;
-export declare type CommandOptions<TResult, TData> = {
+type Serialize = (data: unknown) => string | number | boolean;
+type Deserialize<TResult, TData> = (result: TResult) => TData;
+export type CommandOptions<TResult, TData> = {
     /**
      * Custom deserializer
      */
@@ -20,7 +20,7 @@ export declare type CommandOptions<TResult, TData> = {
  * TResult is the raw data returned from upstash, which may need to be transformed or parsed.
  */
 export declare class Command<TResult, TData> {
-    readonly command: string[];
+    readonly command: (string | number | boolean)[];
     readonly serialize: Serialize;
     readonly deserialize: Deserialize<TResult, TData>;
     /**
@@ -28,7 +28,7 @@ export declare class Command<TResult, TData> {
      *
      * You can define a custom `deserialize` function. By default we try to deserialize as json.
      */
-    constructor(command: (string | unknown)[], opts?: CommandOptions<TResult, TData>);
+    constructor(command: (string | boolean | number | unknown)[], opts?: CommandOptions<TResult, TData>);
     /**
      * Execute the command using a client.
      */

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

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

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

@@ -3,5 +3,5 @@ import { Command, CommandOptions } from "./command.js";
  * @see https://redis.io/commands/hdel
  */
 export declare class HDelCommand extends Command<"0" | "1", 0 | 1> {
-    constructor(cmd: [key: string, field: string], opts?: CommandOptions<"0" | "1", 0 | 1>);
+    constructor(cmd: [key: string, ...fields: string[]], opts?: CommandOptions<"0" | "1", 0 | 1>);
 }

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

@@ -0,0 +1,9 @@
+import { Command, CommandOptions } from "./command.js";
+/**
+ * @see https://redis.io/commands/hrandfield
+ */
+export declare class HRandFieldCommand<TData extends string | string[] | Record<string, unknown>> extends Command<string | string[], TData> {
+    constructor(cmd: [key: string], opts?: CommandOptions<string, string>);
+    constructor(cmd: [key: string, count: number], opts?: CommandOptions<string[], string[]>);
+    constructor(cmd: [key: string, count: number, withValues: boolean], opts?: CommandOptions<string[], Partial<TData>>);
+}

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

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

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

@@ -0,0 +1,13 @@
+import { Command, CommandOptions } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.arrindex
+ */
+export declare class JsonArrIndexCommand<TValue extends unknown> extends Command<(null | string)[], (null | number)[]> {
+    constructor(cmd: [
+        key: string,
+        path: string,
+        value: TValue,
+        start?: number,
+        stop?: number
+    ], opts?: CommandOptions<(null | string)[], (null | number)[]>);
+}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,15 @@
+import { Command, CommandOptions } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.get
+ */
+export declare class JsonGetCommand<TData extends (unknown | Record<string, unknown>) | (unknown | Record<string, unknown>)[]> extends Command<TData | null, TData | null> {
+    constructor(cmd: [
+        key: string,
+        opts?: {
+            indent?: string;
+            newline?: string;
+            space?: string;
+        },
+        ...path: string[]
+    ] | [key: string, ...path: string[]], opts?: CommandOptions<TData | null, TData | null>);
+}

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

@@ -0,0 +1,7 @@
+import { Command, CommandOptions } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.mget
+ */
+export declare class JsonMGetCommand<TData extends (unknown | Record<string, unknown>)[]> extends Command<TData, TData> {
+    constructor(cmd: [keys: string[], path: string], opts?: CommandOptions<TData, TData>);
+}

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,18 @@
+import { Command, CommandOptions } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.set
+ */
+export declare 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>);
+}

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

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

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

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

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

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

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

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

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

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

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,10 +39,32 @@ 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";
@@ -82,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";
@@ -95,6 +120,7 @@ export * from "./touch.js";
 export * from "./ttl.js";
 export * from "./type.js";
 export * from "./unlink.js";
+export * from "./xadd.js";
 export * from "./zadd.js";
 export * from "./zcard.js";
 export * from "./zcount.js";

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

@@ -1,5 +1,5 @@
 import { Command, CommandOptions } from "./command.js";
-export declare type ScanCommandOptions = {
+export type ScanCommandOptions = {
     match?: string;
     count?: number;
     type?: string;

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

@@ -1,7 +1,7 @@
 import { Command, CommandOptions } from "./command.js";
-export declare type SetCommandOptions = {
-    get: boolean;
-} | ({
+export type SetCommandOptions = {
+    get?: boolean;
+} & ({
     ex: number;
     px?: never;
     exat?: never;

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

@@ -0,0 +1,31 @@
+import { Command, CommandOptions } from "./command.js";
+type XAddCommandOptions = {
+    nomkStream?: boolean;
+    trim?: ({
+        type: "MAXLEN" | "maxlen";
+        threshold: number;
+    } | {
+        type: "MINID" | "minid";
+        threshold: string;
+    }) & ({
+        comparison: "~";
+        limit?: number;
+    } | {
+        comparison: "=";
+        limit?: never;
+    });
+};
+/**
+ * @see https://redis.io/commands/xadd
+ */
+export declare class XAddCommand extends Command<string, string> {
+    constructor([key, id, entries, opts]: [
+        key: string,
+        id: "*" | string,
+        entries: {
+            [field: string]: unknown;
+        },
+        opts?: XAddCommandOptions
+    ], commandOptions?: CommandOptions<string, string>);
+}
+export {};

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;
 };

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

@@ -1,5 +1,5 @@
 import { Command, CommandOptions } from "./command.js";
-export declare type ZRangeCommandOptions = {
+export type ZRangeCommandOptions = {
     withScores?: boolean;
     rev?: boolean;
 } & ({

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,65 @@ 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";
+    /**
+     * Configure the cache behaviour
+     * @default "no-store"
+     */
+    cache?: CacheSetting;
+};
+export type HttpClientConfig = {
     headers?: Record<string, string>;
     baseUrl: string;
     options?: Options;
     retry?: RetryConfig;
-};
+    agent?: any;
+} & 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 {};