@upstash/redis 1.11.0 → 1.12.0-rc.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (28) hide show
  1. package/esm/deps/deno.land/x/base64@v0.2.1/base.js +100 -0
  2. package/esm/deps/deno.land/x/base64@v0.2.1/base64url.js +9 -0
  3. package/esm/deps/deno.land/x/base64@v0.2.1/mod.js +13 -0
  4. package/esm/deps/denopkg.com/chiefbiiko/sha1@master/deps.js +1 -0
  5. package/esm/deps/denopkg.com/chiefbiiko/sha1@master/mod.js +191 -0
  6. package/esm/deps/denopkg.com/chiefbiiko/std-encoding@v1.1.1/mod.js +54 -0
  7. package/esm/pkg/commands/scan.js +3 -0
  8. package/esm/pkg/redis.js +4 -0
  9. package/esm/pkg/script.js +77 -0
  10. package/package.json +1 -39
  11. package/script/deps/deno.land/x/base64@v0.2.1/base.js +104 -0
  12. package/script/deps/deno.land/x/base64@v0.2.1/base64url.js +13 -0
  13. package/script/deps/deno.land/x/base64@v0.2.1/mod.js +17 -0
  14. package/script/deps/denopkg.com/chiefbiiko/sha1@master/deps.js +6 -0
  15. package/script/deps/denopkg.com/chiefbiiko/sha1@master/mod.js +196 -0
  16. package/script/deps/denopkg.com/chiefbiiko/std-encoding@v1.1.1/mod.js +82 -0
  17. package/script/pkg/commands/scan.js +3 -0
  18. package/script/pkg/redis.js +4 -0
  19. package/script/pkg/script.js +81 -0
  20. package/types/deps/deno.land/x/base64@v0.2.1/base.d.ts +5 -0
  21. package/types/deps/deno.land/x/base64@v0.2.1/base64url.d.ts +1 -0
  22. package/types/deps/deno.land/x/base64@v0.2.1/mod.d.ts +1 -0
  23. package/types/deps/denopkg.com/chiefbiiko/sha1@master/deps.d.ts +1 -0
  24. package/types/deps/denopkg.com/chiefbiiko/sha1@master/mod.d.ts +26 -0
  25. package/types/deps/denopkg.com/chiefbiiko/std-encoding@v1.1.1/mod.d.ts +3 -0
  26. package/types/pkg/commands/scan.d.ts +1 -0
  27. package/types/pkg/redis.d.ts +2 -0
  28. package/types/pkg/script.d.ts +42 -0
@@ -0,0 +1,100 @@
1
+ function getLengths(b64) {
2
+ const len = b64.length;
3
+ // if (len % 4 > 0) {
4
+ // throw new TypeError("Invalid string. Length must be a multiple of 4");
5
+ // }
6
+ // Trim off extra bytes after placeholder bytes are found
7
+ // See: https://github.com/beatgammit/base64-js/issues/42
8
+ let validLen = b64.indexOf("=");
9
+ if (validLen === -1) {
10
+ validLen = len;
11
+ }
12
+ const placeHoldersLen = validLen === len ? 0 : 4 - (validLen % 4);
13
+ return [validLen, placeHoldersLen];
14
+ }
15
+ export function init(lookup, revLookup, urlsafe = false) {
16
+ function _byteLength(validLen, placeHoldersLen) {
17
+ return Math.floor(((validLen + placeHoldersLen) * 3) / 4 - placeHoldersLen);
18
+ }
19
+ function tripletToBase64(num) {
20
+ return (lookup[(num >> 18) & 0x3f] +
21
+ lookup[(num >> 12) & 0x3f] +
22
+ lookup[(num >> 6) & 0x3f] +
23
+ lookup[num & 0x3f]);
24
+ }
25
+ function encodeChunk(buf, start, end) {
26
+ const out = new Array((end - start) / 3);
27
+ for (let i = start, curTriplet = 0; i < end; i += 3) {
28
+ out[curTriplet++] = tripletToBase64((buf[i] << 16) + (buf[i + 1] << 8) + buf[i + 2]);
29
+ }
30
+ return out.join("");
31
+ }
32
+ return {
33
+ // base64 is 4/3 + up to two characters of the original data
34
+ byteLength(b64) {
35
+ return _byteLength.apply(null, getLengths(b64));
36
+ },
37
+ toUint8Array(b64) {
38
+ const [validLen, placeHoldersLen] = getLengths(b64);
39
+ const buf = new Uint8Array(_byteLength(validLen, placeHoldersLen));
40
+ // If there are placeholders, only get up to the last complete 4 chars
41
+ const len = placeHoldersLen ? validLen - 4 : validLen;
42
+ let tmp;
43
+ let curByte = 0;
44
+ let i;
45
+ for (i = 0; i < len; i += 4) {
46
+ tmp = (revLookup[b64.charCodeAt(i)] << 18) |
47
+ (revLookup[b64.charCodeAt(i + 1)] << 12) |
48
+ (revLookup[b64.charCodeAt(i + 2)] << 6) |
49
+ revLookup[b64.charCodeAt(i + 3)];
50
+ buf[curByte++] = (tmp >> 16) & 0xff;
51
+ buf[curByte++] = (tmp >> 8) & 0xff;
52
+ buf[curByte++] = tmp & 0xff;
53
+ }
54
+ if (placeHoldersLen === 2) {
55
+ tmp = (revLookup[b64.charCodeAt(i)] << 2) |
56
+ (revLookup[b64.charCodeAt(i + 1)] >> 4);
57
+ buf[curByte++] = tmp & 0xff;
58
+ }
59
+ else if (placeHoldersLen === 1) {
60
+ tmp = (revLookup[b64.charCodeAt(i)] << 10) |
61
+ (revLookup[b64.charCodeAt(i + 1)] << 4) |
62
+ (revLookup[b64.charCodeAt(i + 2)] >> 2);
63
+ buf[curByte++] = (tmp >> 8) & 0xff;
64
+ buf[curByte++] = tmp & 0xff;
65
+ }
66
+ return buf;
67
+ },
68
+ fromUint8Array(buf) {
69
+ const maxChunkLength = 16383; // Must be multiple of 3
70
+ const len = buf.length;
71
+ const extraBytes = len % 3; // If we have 1 byte left, pad 2 bytes
72
+ const len2 = len - extraBytes;
73
+ const parts = new Array(Math.ceil(len2 / maxChunkLength) + (extraBytes ? 1 : 0));
74
+ let curChunk = 0;
75
+ let chunkEnd;
76
+ // Go through the array every three bytes, we'll deal with trailing stuff later
77
+ for (let i = 0; i < len2; i += maxChunkLength) {
78
+ chunkEnd = i + maxChunkLength;
79
+ parts[curChunk++] = encodeChunk(buf, i, chunkEnd > len2 ? len2 : chunkEnd);
80
+ }
81
+ let tmp;
82
+ // Pad the end with zeros, but make sure to not forget the extra bytes
83
+ if (extraBytes === 1) {
84
+ tmp = buf[len2];
85
+ parts[curChunk] = lookup[tmp >> 2] + lookup[(tmp << 4) & 0x3f];
86
+ if (!urlsafe)
87
+ parts[curChunk] += "==";
88
+ }
89
+ else if (extraBytes === 2) {
90
+ tmp = (buf[len2] << 8) | (buf[len2 + 1] & 0xff);
91
+ parts[curChunk] = lookup[tmp >> 10] +
92
+ lookup[(tmp >> 4) & 0x3f] +
93
+ lookup[(tmp << 2) & 0x3f];
94
+ if (!urlsafe)
95
+ parts[curChunk] += "=";
96
+ }
97
+ return parts.join("");
98
+ },
99
+ };
100
+ }
@@ -0,0 +1,9 @@
1
+ import { init } from "./base.js";
2
+ const lookup = [];
3
+ const revLookup = [];
4
+ const code = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_";
5
+ for (let i = 0, l = code.length; i < l; ++i) {
6
+ lookup[i] = code[i];
7
+ revLookup[code.charCodeAt(i)] = i;
8
+ }
9
+ export const { byteLength, toUint8Array, fromUint8Array } = init(lookup, revLookup, true);
@@ -0,0 +1,13 @@
1
+ import { init } from "./base.js";
2
+ const lookup = [];
3
+ const revLookup = [];
4
+ const code = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
5
+ for (let i = 0, l = code.length; i < l; ++i) {
6
+ lookup[i] = code[i];
7
+ revLookup[code.charCodeAt(i)] = i;
8
+ }
9
+ // Support decoding URL-safe base64 strings, as Node.js does.
10
+ // See: https://en.wikipedia.org/wiki/Base64#URL_applications
11
+ revLookup["-".charCodeAt(0)] = 62;
12
+ revLookup["_".charCodeAt(0)] = 63;
13
+ export const { byteLength, toUint8Array, fromUint8Array } = init(lookup, revLookup);
@@ -0,0 +1 @@
1
+ export { encode, decode } from "../std-encoding@v1.1.1/mod.js";
@@ -0,0 +1,191 @@
1
+ import { encode, decode } from "./deps.js";
2
+ function rotl(x, n) {
3
+ return (x << n) | (x >>> (32 - n));
4
+ }
5
+ /** Byte length of a SHA1 digest. */
6
+ export const BYTES = 20;
7
+ /** A class representation of the SHA1 algorithm. */
8
+ export class SHA1 {
9
+ /** Creates a SHA1 instance. */
10
+ constructor() {
11
+ Object.defineProperty(this, "hashSize", {
12
+ enumerable: true,
13
+ configurable: true,
14
+ writable: true,
15
+ value: BYTES
16
+ });
17
+ Object.defineProperty(this, "_buf", {
18
+ enumerable: true,
19
+ configurable: true,
20
+ writable: true,
21
+ value: new Uint8Array(64)
22
+ });
23
+ Object.defineProperty(this, "_bufIdx", {
24
+ enumerable: true,
25
+ configurable: true,
26
+ writable: true,
27
+ value: void 0
28
+ });
29
+ Object.defineProperty(this, "_count", {
30
+ enumerable: true,
31
+ configurable: true,
32
+ writable: true,
33
+ value: void 0
34
+ });
35
+ Object.defineProperty(this, "_K", {
36
+ enumerable: true,
37
+ configurable: true,
38
+ writable: true,
39
+ value: new Uint32Array([0x5a827999, 0x6ed9eba1, 0x8f1bbcdc, 0xca62c1d6])
40
+ });
41
+ Object.defineProperty(this, "_H", {
42
+ enumerable: true,
43
+ configurable: true,
44
+ writable: true,
45
+ value: void 0
46
+ });
47
+ Object.defineProperty(this, "_finalized", {
48
+ enumerable: true,
49
+ configurable: true,
50
+ writable: true,
51
+ value: void 0
52
+ });
53
+ this.init();
54
+ }
55
+ /** Reduces the four input numbers to a single one. */
56
+ static F(t, b, c, d) {
57
+ if (t <= 19) {
58
+ return (b & c) | (~b & d);
59
+ }
60
+ else if (t <= 39) {
61
+ return b ^ c ^ d;
62
+ }
63
+ else if (t <= 59) {
64
+ return (b & c) | (b & d) | (c & d);
65
+ }
66
+ else {
67
+ return b ^ c ^ d;
68
+ }
69
+ }
70
+ /** Initializes a hash instance. */
71
+ init() {
72
+ // prettier-ignore
73
+ this._H = new Uint32Array([
74
+ 0x67452301, 0xEFCDAB89, 0x98BADCFE, 0x10325476, 0xC3D2E1F0
75
+ ]);
76
+ this._bufIdx = 0;
77
+ this._count = new Uint32Array(2);
78
+ this._buf.fill(0);
79
+ this._finalized = false;
80
+ return this;
81
+ }
82
+ /** Updates a hash with additional message data. */
83
+ update(msg, inputEncoding) {
84
+ if (msg === null) {
85
+ throw new TypeError("msg must be a string or Uint8Array.");
86
+ }
87
+ else if (typeof msg === "string") {
88
+ msg = encode(msg, inputEncoding);
89
+ }
90
+ // process the msg as many times as possible, the rest is stored in the buffer
91
+ // message is processed in 512 bit (64 byte chunks)
92
+ for (let i = 0; i < msg.length; i++) {
93
+ this._buf[this._bufIdx++] = msg[i];
94
+ if (this._bufIdx === 64) {
95
+ this.transform();
96
+ this._bufIdx = 0;
97
+ }
98
+ }
99
+ // counter update (number of message bits)
100
+ const c = this._count;
101
+ if ((c[0] += msg.length << 3) < msg.length << 3) {
102
+ c[1]++;
103
+ }
104
+ c[1] += msg.length >>> 29;
105
+ return this;
106
+ }
107
+ /** Finalizes a hash with additional message data. */
108
+ digest(outputEncoding) {
109
+ if (this._finalized) {
110
+ throw new Error("digest has already been called.");
111
+ }
112
+ this._finalized = true;
113
+ // append '1'
114
+ const b = this._buf;
115
+ let idx = this._bufIdx;
116
+ b[idx++] = 0x80;
117
+ // zeropad up to byte pos 56
118
+ while (idx !== 56) {
119
+ if (idx === 64) {
120
+ this.transform();
121
+ idx = 0;
122
+ }
123
+ b[idx++] = 0;
124
+ }
125
+ // append length in bits
126
+ const c = this._count;
127
+ b[56] = (c[1] >>> 24) & 0xff;
128
+ b[57] = (c[1] >>> 16) & 0xff;
129
+ b[58] = (c[1] >>> 8) & 0xff;
130
+ b[59] = (c[1] >>> 0) & 0xff;
131
+ b[60] = (c[0] >>> 24) & 0xff;
132
+ b[61] = (c[0] >>> 16) & 0xff;
133
+ b[62] = (c[0] >>> 8) & 0xff;
134
+ b[63] = (c[0] >>> 0) & 0xff;
135
+ this.transform();
136
+ // return the hash as byte array (20 bytes)
137
+ const hash = new Uint8Array(BYTES);
138
+ for (let i = 0; i < 5; i++) {
139
+ hash[(i << 2) + 0] = (this._H[i] >>> 24) & 0xff;
140
+ hash[(i << 2) + 1] = (this._H[i] >>> 16) & 0xff;
141
+ hash[(i << 2) + 2] = (this._H[i] >>> 8) & 0xff;
142
+ hash[(i << 2) + 3] = (this._H[i] >>> 0) & 0xff;
143
+ }
144
+ // clear internal states and prepare for new hash
145
+ this.init();
146
+ return outputEncoding ? decode(hash, outputEncoding) : hash;
147
+ }
148
+ /** Performs one transformation cycle. */
149
+ transform() {
150
+ const h = this._H;
151
+ let a = h[0];
152
+ let b = h[1];
153
+ let c = h[2];
154
+ let d = h[3];
155
+ let e = h[4];
156
+ // convert byte buffer to words
157
+ const w = new Uint32Array(80);
158
+ for (let i = 0; i < 16; i++) {
159
+ w[i] =
160
+ this._buf[(i << 2) + 3] |
161
+ (this._buf[(i << 2) + 2] << 8) |
162
+ (this._buf[(i << 2) + 1] << 16) |
163
+ (this._buf[i << 2] << 24);
164
+ }
165
+ for (let t = 0; t < 80; t++) {
166
+ if (t >= 16) {
167
+ w[t] = rotl(w[t - 3] ^ w[t - 8] ^ w[t - 14] ^ w[t - 16], 1);
168
+ }
169
+ const tmp = (rotl(a, 5) +
170
+ SHA1.F(t, b, c, d) +
171
+ e +
172
+ w[t] +
173
+ this._K[Math.floor(t / 20)]) |
174
+ 0;
175
+ e = d;
176
+ d = c;
177
+ c = rotl(b, 30);
178
+ b = a;
179
+ a = tmp;
180
+ }
181
+ h[0] = (h[0] + a) | 0;
182
+ h[1] = (h[1] + b) | 0;
183
+ h[2] = (h[2] + c) | 0;
184
+ h[3] = (h[3] + d) | 0;
185
+ h[4] = (h[4] + e) | 0;
186
+ }
187
+ }
188
+ /** Generates a SHA1 hash of the input data. */
189
+ export function sha1(msg, inputEncoding, outputEncoding) {
190
+ return new SHA1().update(msg, inputEncoding).digest(outputEncoding);
191
+ }
@@ -0,0 +1,54 @@
1
+ import * as base64 from "../../../deno.land/x/base64@v0.2.1/mod.js";
2
+ import * as base64url from "../../../deno.land/x/base64@v0.2.1/base64url.js";
3
+ const decoder = new TextDecoder();
4
+ const encoder = new TextEncoder();
5
+ /** Serializes a Uint8Array to a hexadecimal string. */
6
+ function toHexString(buf) {
7
+ return buf.reduce((hex, byte) => `${hex}${byte < 16 ? "0" : ""}${byte.toString(16)}`, "");
8
+ }
9
+ /** Deserializes a Uint8Array from a hexadecimal string. */
10
+ function fromHexString(hex) {
11
+ const len = hex.length;
12
+ if (len % 2 || !/^[0-9a-fA-F]+$/.test(hex)) {
13
+ throw new TypeError("Invalid hex string.");
14
+ }
15
+ hex = hex.toLowerCase();
16
+ const buf = new Uint8Array(Math.floor(len / 2));
17
+ const end = len / 2;
18
+ for (let i = 0; i < end; ++i) {
19
+ buf[i] = parseInt(hex.substr(i * 2, 2), 16);
20
+ }
21
+ return buf;
22
+ }
23
+ /** Decodes a Uint8Array to utf8-, base64-, or hex-encoded string. */
24
+ export function decode(buf, encoding = "utf8") {
25
+ if (/^utf-?8$/i.test(encoding)) {
26
+ return decoder.decode(buf);
27
+ }
28
+ else if (/^base64$/i.test(encoding)) {
29
+ return base64.fromUint8Array(buf);
30
+ }
31
+ else if (/^base64url$/i.test(encoding)) {
32
+ return base64url.fromUint8Array(buf);
33
+ }
34
+ else if (/^hex(?:adecimal)?$/i.test(encoding)) {
35
+ return toHexString(buf);
36
+ }
37
+ else {
38
+ throw new TypeError("Unsupported string encoding.");
39
+ }
40
+ }
41
+ export function encode(str, encoding = "utf8") {
42
+ if (/^utf-?8$/i.test(encoding)) {
43
+ return encoder.encode(str);
44
+ }
45
+ else if (/^base64(?:url)?$/i.test(encoding)) {
46
+ return base64.toUint8Array(str);
47
+ }
48
+ else if (/^hex(?:adecimal)?$/i.test(encoding)) {
49
+ return fromHexString(str);
50
+ }
51
+ else {
52
+ throw new TypeError("Unsupported string encoding.");
53
+ }
54
+ }
@@ -11,6 +11,9 @@ export class ScanCommand extends Command {
11
11
  if (typeof opts?.count === "number") {
12
12
  command.push("count", opts.count);
13
13
  }
14
+ if (opts?.type && opts.type.length > 0) {
15
+ command.push("type", opts.type);
16
+ }
14
17
  super(command, cmdOpts);
15
18
  }
16
19
  }
package/esm/pkg/redis.js CHANGED
@@ -1,5 +1,6 @@
1
1
  import { AppendCommand, BitCountCommand, BitOpCommand, BitPosCommand, DBSizeCommand, DecrByCommand, DecrCommand, DelCommand, EchoCommand, EvalCommand, EvalshaCommand, ExistsCommand, ExpireAtCommand, ExpireCommand, FlushAllCommand, FlushDBCommand, GetBitCommand, GetCommand, GetRangeCommand, GetSetCommand, HDelCommand, HExistsCommand, HGetAllCommand, HGetCommand, HIncrByCommand, HIncrByFloatCommand, HKeysCommand, HLenCommand, HMGetCommand, HMSetCommand, HScanCommand, HSetCommand, HSetNXCommand, HStrLenCommand, HValsCommand, IncrByCommand, IncrByFloatCommand, IncrCommand, KeysCommand, LIndexCommand, LInsertCommand, LLenCommand, LPopCommand, LPosCommand, LPushCommand, LPushXCommand, LRangeCommand, LRemCommand, LSetCommand, LTrimCommand, MGetCommand, MSetCommand, MSetNXCommand, PersistCommand, PExpireAtCommand, PExpireCommand, PingCommand, PSetEXCommand, PTtlCommand, PublishCommand, RandomKeyCommand, RenameCommand, RenameNXCommand, RPopCommand, RPushCommand, RPushXCommand, SAddCommand, ScanCommand, SCardCommand, ScriptExistsCommand, ScriptFlushCommand, ScriptLoadCommand, SDiffCommand, SDiffStoreCommand, SetBitCommand, SetCommand, SetExCommand, SetNxCommand, SetRangeCommand, SInterCommand, SInterStoreCommand, SIsMemberCommand, SMembersCommand, SMoveCommand, SPopCommand, SRandMemberCommand, SRemCommand, SScanCommand, StrLenCommand, SUnionCommand, SUnionStoreCommand, TimeCommand, TouchCommand, TtlCommand, TypeCommand, UnlinkCommand, ZAddCommand, ZCardCommand, ZCountCommand, ZIncrByCommand, ZInterStoreCommand, ZLexCountCommand, ZPopMaxCommand, ZPopMinCommand, ZRangeCommand, ZRankCommand, ZRemCommand, ZRemRangeByLexCommand, ZRemRangeByRankCommand, ZRemRangeByScoreCommand, ZRevRankCommand, ZScanCommand, ZScoreCommand, ZUnionStoreCommand, } from "./commands/mod.js";
2
2
  import { Pipeline } from "./pipeline.js";
3
+ import { Script } from "./script.js";
3
4
  /**
4
5
  * Serverless redis client for upstash.
5
6
  */
@@ -1085,4 +1086,7 @@ export class Redis {
1085
1086
  this.client = client;
1086
1087
  this.opts = opts;
1087
1088
  }
1089
+ createScript(script) {
1090
+ return new Script(this, script);
1091
+ }
1088
1092
  }
@@ -0,0 +1,77 @@
1
+ import { sha1 as digest } from "../deps/denopkg.com/chiefbiiko/sha1@master/mod.js";
2
+ /**
3
+ * Creates a new script.
4
+ *
5
+ * Scripts offer the ability to optimistically try to execute a script without having to send the
6
+ * entire script to the server. If the script is loaded on the server, it tries again by sending
7
+ * the entire script. Afterwards, the script is cached on the server.
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * const redis = new Redis({...})
12
+ *
13
+ * const script = redis.createScript<string>("return ARGV[1];")
14
+ * const arg1 = await script.eval([], ["Hello World"])
15
+ * assertEquals(arg1, "Hello World")
16
+ * ```
17
+ */
18
+ export class Script {
19
+ constructor(redis, script) {
20
+ Object.defineProperty(this, "script", {
21
+ enumerable: true,
22
+ configurable: true,
23
+ writable: true,
24
+ value: void 0
25
+ });
26
+ Object.defineProperty(this, "sha1", {
27
+ enumerable: true,
28
+ configurable: true,
29
+ writable: true,
30
+ value: void 0
31
+ });
32
+ Object.defineProperty(this, "redis", {
33
+ enumerable: true,
34
+ configurable: true,
35
+ writable: true,
36
+ value: void 0
37
+ });
38
+ this.redis = redis;
39
+ this.sha1 = this.digest(script);
40
+ this.script = script;
41
+ }
42
+ /**
43
+ * Send an `EVAL` command to redis.
44
+ */
45
+ async eval(keys, args) {
46
+ return await this.redis.eval(this.script, keys, args);
47
+ }
48
+ /**
49
+ * Calculates the sha1 hash of the script and then calls `EVALSHA`.
50
+ */
51
+ async evalsha(keys, args) {
52
+ return await this.redis.evalsha(this.sha1, keys, args);
53
+ }
54
+ /**
55
+ * Optimistically try to run `EVALSHA` first.
56
+ * If the script is not loaded in redis, it will fall back and try again with `EVAL`.
57
+ *
58
+ * Following calls will be able to use the cached script
59
+ */
60
+ async exec(keys, args) {
61
+ const res = await this.redis.evalsha(this.sha1, keys, args).catch(async (err) => {
62
+ if (err instanceof Error &&
63
+ err.message.toLowerCase().includes("noscript")) {
64
+ return await this.redis.eval(this.script, keys, args);
65
+ }
66
+ throw err;
67
+ });
68
+ return res;
69
+ }
70
+ /**
71
+ * Compute the sha1 hash of the script and return its hex representation.
72
+ */
73
+ digest(s) {
74
+ const hash = digest(s, "utf8", "hex");
75
+ return typeof hash === "string" ? hash : new TextDecoder().decode(hash);
76
+ }
77
+ }
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "main": "./script/platforms/nodejs.js",
4
4
  "types": "./types/platforms/nodejs.d.ts",
5
5
  "name": "@upstash/redis",
6
- "version": "v1.11.0",
6
+ "version": "v1.12.0-rc.1",
7
7
  "description": "An HTTP/REST based Redis client built on top of Upstash REST API.",
8
8
  "repository": {
9
9
  "type": "git",
@@ -22,10 +22,6 @@
22
22
  "url": "https://github.com/upstash/upstash-redis/issues"
23
23
  },
24
24
  "homepage": "https://github.com/upstash/upstash-redis#readme",
25
- "devDependencies": {
26
- "@size-limit/preset-small-lib": "latest",
27
- "size-limit": "latest"
28
- },
29
25
  "dependencies": {
30
26
  "isomorphic-fetch": "^3.0.0"
31
27
  },
@@ -37,40 +33,6 @@
37
33
  "with-fetch": "./types/platforms/node_with_fetch.d.ts"
38
34
  }
39
35
  },
40
- "size-limit": [
41
- {
42
- "path": "esm/platforms/nodejs.js",
43
- "limit": "6 KB"
44
- },
45
- {
46
- "path": "esm/platforms/fastly.js",
47
- "limit": "6 KB"
48
- },
49
- {
50
- "path": "esm/platforms/cloudflare.js",
51
- "limit": "6 KB"
52
- },
53
- {
54
- "path": "esm/platforms/node_with_fetch.js",
55
- "limit": "15 KB"
56
- },
57
- {
58
- "path": "script/platforms/nodejs.js",
59
- "limit": "10 KB"
60
- },
61
- {
62
- "path": "script/platforms/fastly.js",
63
- "limit": "10 KB"
64
- },
65
- {
66
- "path": "script/platforms/cloudflare.js",
67
- "limit": "10 KB"
68
- },
69
- {
70
- "path": "script/platforms/node_with_fetch.js",
71
- "limit": "15 KB"
72
- }
73
- ],
74
36
  "exports": {
75
37
  ".": {
76
38
  "import": "./esm/platforms/nodejs.js",
@@ -0,0 +1,104 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.init = void 0;
4
+ function getLengths(b64) {
5
+ const len = b64.length;
6
+ // if (len % 4 > 0) {
7
+ // throw new TypeError("Invalid string. Length must be a multiple of 4");
8
+ // }
9
+ // Trim off extra bytes after placeholder bytes are found
10
+ // See: https://github.com/beatgammit/base64-js/issues/42
11
+ let validLen = b64.indexOf("=");
12
+ if (validLen === -1) {
13
+ validLen = len;
14
+ }
15
+ const placeHoldersLen = validLen === len ? 0 : 4 - (validLen % 4);
16
+ return [validLen, placeHoldersLen];
17
+ }
18
+ function init(lookup, revLookup, urlsafe = false) {
19
+ function _byteLength(validLen, placeHoldersLen) {
20
+ return Math.floor(((validLen + placeHoldersLen) * 3) / 4 - placeHoldersLen);
21
+ }
22
+ function tripletToBase64(num) {
23
+ return (lookup[(num >> 18) & 0x3f] +
24
+ lookup[(num >> 12) & 0x3f] +
25
+ lookup[(num >> 6) & 0x3f] +
26
+ lookup[num & 0x3f]);
27
+ }
28
+ function encodeChunk(buf, start, end) {
29
+ const out = new Array((end - start) / 3);
30
+ for (let i = start, curTriplet = 0; i < end; i += 3) {
31
+ out[curTriplet++] = tripletToBase64((buf[i] << 16) + (buf[i + 1] << 8) + buf[i + 2]);
32
+ }
33
+ return out.join("");
34
+ }
35
+ return {
36
+ // base64 is 4/3 + up to two characters of the original data
37
+ byteLength(b64) {
38
+ return _byteLength.apply(null, getLengths(b64));
39
+ },
40
+ toUint8Array(b64) {
41
+ const [validLen, placeHoldersLen] = getLengths(b64);
42
+ const buf = new Uint8Array(_byteLength(validLen, placeHoldersLen));
43
+ // If there are placeholders, only get up to the last complete 4 chars
44
+ const len = placeHoldersLen ? validLen - 4 : validLen;
45
+ let tmp;
46
+ let curByte = 0;
47
+ let i;
48
+ for (i = 0; i < len; i += 4) {
49
+ tmp = (revLookup[b64.charCodeAt(i)] << 18) |
50
+ (revLookup[b64.charCodeAt(i + 1)] << 12) |
51
+ (revLookup[b64.charCodeAt(i + 2)] << 6) |
52
+ revLookup[b64.charCodeAt(i + 3)];
53
+ buf[curByte++] = (tmp >> 16) & 0xff;
54
+ buf[curByte++] = (tmp >> 8) & 0xff;
55
+ buf[curByte++] = tmp & 0xff;
56
+ }
57
+ if (placeHoldersLen === 2) {
58
+ tmp = (revLookup[b64.charCodeAt(i)] << 2) |
59
+ (revLookup[b64.charCodeAt(i + 1)] >> 4);
60
+ buf[curByte++] = tmp & 0xff;
61
+ }
62
+ else if (placeHoldersLen === 1) {
63
+ tmp = (revLookup[b64.charCodeAt(i)] << 10) |
64
+ (revLookup[b64.charCodeAt(i + 1)] << 4) |
65
+ (revLookup[b64.charCodeAt(i + 2)] >> 2);
66
+ buf[curByte++] = (tmp >> 8) & 0xff;
67
+ buf[curByte++] = tmp & 0xff;
68
+ }
69
+ return buf;
70
+ },
71
+ fromUint8Array(buf) {
72
+ const maxChunkLength = 16383; // Must be multiple of 3
73
+ const len = buf.length;
74
+ const extraBytes = len % 3; // If we have 1 byte left, pad 2 bytes
75
+ const len2 = len - extraBytes;
76
+ const parts = new Array(Math.ceil(len2 / maxChunkLength) + (extraBytes ? 1 : 0));
77
+ let curChunk = 0;
78
+ let chunkEnd;
79
+ // Go through the array every three bytes, we'll deal with trailing stuff later
80
+ for (let i = 0; i < len2; i += maxChunkLength) {
81
+ chunkEnd = i + maxChunkLength;
82
+ parts[curChunk++] = encodeChunk(buf, i, chunkEnd > len2 ? len2 : chunkEnd);
83
+ }
84
+ let tmp;
85
+ // Pad the end with zeros, but make sure to not forget the extra bytes
86
+ if (extraBytes === 1) {
87
+ tmp = buf[len2];
88
+ parts[curChunk] = lookup[tmp >> 2] + lookup[(tmp << 4) & 0x3f];
89
+ if (!urlsafe)
90
+ parts[curChunk] += "==";
91
+ }
92
+ else if (extraBytes === 2) {
93
+ tmp = (buf[len2] << 8) | (buf[len2 + 1] & 0xff);
94
+ parts[curChunk] = lookup[tmp >> 10] +
95
+ lookup[(tmp >> 4) & 0x3f] +
96
+ lookup[(tmp << 2) & 0x3f];
97
+ if (!urlsafe)
98
+ parts[curChunk] += "=";
99
+ }
100
+ return parts.join("");
101
+ },
102
+ };
103
+ }
104
+ exports.init = init;
@@ -0,0 +1,13 @@
1
+ "use strict";
2
+ var _a;
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.fromUint8Array = exports.toUint8Array = exports.byteLength = void 0;
5
+ const base_js_1 = require("./base.js");
6
+ const lookup = [];
7
+ const revLookup = [];
8
+ const code = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_";
9
+ for (let i = 0, l = code.length; i < l; ++i) {
10
+ lookup[i] = code[i];
11
+ revLookup[code.charCodeAt(i)] = i;
12
+ }
13
+ _a = (0, base_js_1.init)(lookup, revLookup, true), exports.byteLength = _a.byteLength, exports.toUint8Array = _a.toUint8Array, exports.fromUint8Array = _a.fromUint8Array;
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ var _a;
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.fromUint8Array = exports.toUint8Array = exports.byteLength = void 0;
5
+ const base_js_1 = require("./base.js");
6
+ const lookup = [];
7
+ const revLookup = [];
8
+ const code = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
9
+ for (let i = 0, l = code.length; i < l; ++i) {
10
+ lookup[i] = code[i];
11
+ revLookup[code.charCodeAt(i)] = i;
12
+ }
13
+ // Support decoding URL-safe base64 strings, as Node.js does.
14
+ // See: https://en.wikipedia.org/wiki/Base64#URL_applications
15
+ revLookup["-".charCodeAt(0)] = 62;
16
+ revLookup["_".charCodeAt(0)] = 63;
17
+ _a = (0, base_js_1.init)(lookup, revLookup), exports.byteLength = _a.byteLength, exports.toUint8Array = _a.toUint8Array, exports.fromUint8Array = _a.fromUint8Array;
@@ -0,0 +1,6 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.decode = exports.encode = void 0;
4
+ var mod_js_1 = require("../std-encoding@v1.1.1/mod.js");
5
+ Object.defineProperty(exports, "encode", { enumerable: true, get: function () { return mod_js_1.encode; } });
6
+ Object.defineProperty(exports, "decode", { enumerable: true, get: function () { return mod_js_1.decode; } });
@@ -0,0 +1,196 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.sha1 = exports.SHA1 = exports.BYTES = void 0;
4
+ const deps_js_1 = require("./deps.js");
5
+ function rotl(x, n) {
6
+ return (x << n) | (x >>> (32 - n));
7
+ }
8
+ /** Byte length of a SHA1 digest. */
9
+ exports.BYTES = 20;
10
+ /** A class representation of the SHA1 algorithm. */
11
+ class SHA1 {
12
+ /** Creates a SHA1 instance. */
13
+ constructor() {
14
+ Object.defineProperty(this, "hashSize", {
15
+ enumerable: true,
16
+ configurable: true,
17
+ writable: true,
18
+ value: exports.BYTES
19
+ });
20
+ Object.defineProperty(this, "_buf", {
21
+ enumerable: true,
22
+ configurable: true,
23
+ writable: true,
24
+ value: new Uint8Array(64)
25
+ });
26
+ Object.defineProperty(this, "_bufIdx", {
27
+ enumerable: true,
28
+ configurable: true,
29
+ writable: true,
30
+ value: void 0
31
+ });
32
+ Object.defineProperty(this, "_count", {
33
+ enumerable: true,
34
+ configurable: true,
35
+ writable: true,
36
+ value: void 0
37
+ });
38
+ Object.defineProperty(this, "_K", {
39
+ enumerable: true,
40
+ configurable: true,
41
+ writable: true,
42
+ value: new Uint32Array([0x5a827999, 0x6ed9eba1, 0x8f1bbcdc, 0xca62c1d6])
43
+ });
44
+ Object.defineProperty(this, "_H", {
45
+ enumerable: true,
46
+ configurable: true,
47
+ writable: true,
48
+ value: void 0
49
+ });
50
+ Object.defineProperty(this, "_finalized", {
51
+ enumerable: true,
52
+ configurable: true,
53
+ writable: true,
54
+ value: void 0
55
+ });
56
+ this.init();
57
+ }
58
+ /** Reduces the four input numbers to a single one. */
59
+ static F(t, b, c, d) {
60
+ if (t <= 19) {
61
+ return (b & c) | (~b & d);
62
+ }
63
+ else if (t <= 39) {
64
+ return b ^ c ^ d;
65
+ }
66
+ else if (t <= 59) {
67
+ return (b & c) | (b & d) | (c & d);
68
+ }
69
+ else {
70
+ return b ^ c ^ d;
71
+ }
72
+ }
73
+ /** Initializes a hash instance. */
74
+ init() {
75
+ // prettier-ignore
76
+ this._H = new Uint32Array([
77
+ 0x67452301, 0xEFCDAB89, 0x98BADCFE, 0x10325476, 0xC3D2E1F0
78
+ ]);
79
+ this._bufIdx = 0;
80
+ this._count = new Uint32Array(2);
81
+ this._buf.fill(0);
82
+ this._finalized = false;
83
+ return this;
84
+ }
85
+ /** Updates a hash with additional message data. */
86
+ update(msg, inputEncoding) {
87
+ if (msg === null) {
88
+ throw new TypeError("msg must be a string or Uint8Array.");
89
+ }
90
+ else if (typeof msg === "string") {
91
+ msg = (0, deps_js_1.encode)(msg, inputEncoding);
92
+ }
93
+ // process the msg as many times as possible, the rest is stored in the buffer
94
+ // message is processed in 512 bit (64 byte chunks)
95
+ for (let i = 0; i < msg.length; i++) {
96
+ this._buf[this._bufIdx++] = msg[i];
97
+ if (this._bufIdx === 64) {
98
+ this.transform();
99
+ this._bufIdx = 0;
100
+ }
101
+ }
102
+ // counter update (number of message bits)
103
+ const c = this._count;
104
+ if ((c[0] += msg.length << 3) < msg.length << 3) {
105
+ c[1]++;
106
+ }
107
+ c[1] += msg.length >>> 29;
108
+ return this;
109
+ }
110
+ /** Finalizes a hash with additional message data. */
111
+ digest(outputEncoding) {
112
+ if (this._finalized) {
113
+ throw new Error("digest has already been called.");
114
+ }
115
+ this._finalized = true;
116
+ // append '1'
117
+ const b = this._buf;
118
+ let idx = this._bufIdx;
119
+ b[idx++] = 0x80;
120
+ // zeropad up to byte pos 56
121
+ while (idx !== 56) {
122
+ if (idx === 64) {
123
+ this.transform();
124
+ idx = 0;
125
+ }
126
+ b[idx++] = 0;
127
+ }
128
+ // append length in bits
129
+ const c = this._count;
130
+ b[56] = (c[1] >>> 24) & 0xff;
131
+ b[57] = (c[1] >>> 16) & 0xff;
132
+ b[58] = (c[1] >>> 8) & 0xff;
133
+ b[59] = (c[1] >>> 0) & 0xff;
134
+ b[60] = (c[0] >>> 24) & 0xff;
135
+ b[61] = (c[0] >>> 16) & 0xff;
136
+ b[62] = (c[0] >>> 8) & 0xff;
137
+ b[63] = (c[0] >>> 0) & 0xff;
138
+ this.transform();
139
+ // return the hash as byte array (20 bytes)
140
+ const hash = new Uint8Array(exports.BYTES);
141
+ for (let i = 0; i < 5; i++) {
142
+ hash[(i << 2) + 0] = (this._H[i] >>> 24) & 0xff;
143
+ hash[(i << 2) + 1] = (this._H[i] >>> 16) & 0xff;
144
+ hash[(i << 2) + 2] = (this._H[i] >>> 8) & 0xff;
145
+ hash[(i << 2) + 3] = (this._H[i] >>> 0) & 0xff;
146
+ }
147
+ // clear internal states and prepare for new hash
148
+ this.init();
149
+ return outputEncoding ? (0, deps_js_1.decode)(hash, outputEncoding) : hash;
150
+ }
151
+ /** Performs one transformation cycle. */
152
+ transform() {
153
+ const h = this._H;
154
+ let a = h[0];
155
+ let b = h[1];
156
+ let c = h[2];
157
+ let d = h[3];
158
+ let e = h[4];
159
+ // convert byte buffer to words
160
+ const w = new Uint32Array(80);
161
+ for (let i = 0; i < 16; i++) {
162
+ w[i] =
163
+ this._buf[(i << 2) + 3] |
164
+ (this._buf[(i << 2) + 2] << 8) |
165
+ (this._buf[(i << 2) + 1] << 16) |
166
+ (this._buf[i << 2] << 24);
167
+ }
168
+ for (let t = 0; t < 80; t++) {
169
+ if (t >= 16) {
170
+ w[t] = rotl(w[t - 3] ^ w[t - 8] ^ w[t - 14] ^ w[t - 16], 1);
171
+ }
172
+ const tmp = (rotl(a, 5) +
173
+ SHA1.F(t, b, c, d) +
174
+ e +
175
+ w[t] +
176
+ this._K[Math.floor(t / 20)]) |
177
+ 0;
178
+ e = d;
179
+ d = c;
180
+ c = rotl(b, 30);
181
+ b = a;
182
+ a = tmp;
183
+ }
184
+ h[0] = (h[0] + a) | 0;
185
+ h[1] = (h[1] + b) | 0;
186
+ h[2] = (h[2] + c) | 0;
187
+ h[3] = (h[3] + d) | 0;
188
+ h[4] = (h[4] + e) | 0;
189
+ }
190
+ }
191
+ exports.SHA1 = SHA1;
192
+ /** Generates a SHA1 hash of the input data. */
193
+ function sha1(msg, inputEncoding, outputEncoding) {
194
+ return new SHA1().update(msg, inputEncoding).digest(outputEncoding);
195
+ }
196
+ exports.sha1 = sha1;
@@ -0,0 +1,82 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
15
+ }) : function(o, v) {
16
+ o["default"] = v;
17
+ });
18
+ var __importStar = (this && this.__importStar) || function (mod) {
19
+ if (mod && mod.__esModule) return mod;
20
+ var result = {};
21
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
+ __setModuleDefault(result, mod);
23
+ return result;
24
+ };
25
+ Object.defineProperty(exports, "__esModule", { value: true });
26
+ exports.encode = exports.decode = void 0;
27
+ const base64 = __importStar(require("../../../deno.land/x/base64@v0.2.1/mod.js"));
28
+ const base64url = __importStar(require("../../../deno.land/x/base64@v0.2.1/base64url.js"));
29
+ const decoder = new TextDecoder();
30
+ const encoder = new TextEncoder();
31
+ /** Serializes a Uint8Array to a hexadecimal string. */
32
+ function toHexString(buf) {
33
+ return buf.reduce((hex, byte) => `${hex}${byte < 16 ? "0" : ""}${byte.toString(16)}`, "");
34
+ }
35
+ /** Deserializes a Uint8Array from a hexadecimal string. */
36
+ function fromHexString(hex) {
37
+ const len = hex.length;
38
+ if (len % 2 || !/^[0-9a-fA-F]+$/.test(hex)) {
39
+ throw new TypeError("Invalid hex string.");
40
+ }
41
+ hex = hex.toLowerCase();
42
+ const buf = new Uint8Array(Math.floor(len / 2));
43
+ const end = len / 2;
44
+ for (let i = 0; i < end; ++i) {
45
+ buf[i] = parseInt(hex.substr(i * 2, 2), 16);
46
+ }
47
+ return buf;
48
+ }
49
+ /** Decodes a Uint8Array to utf8-, base64-, or hex-encoded string. */
50
+ function decode(buf, encoding = "utf8") {
51
+ if (/^utf-?8$/i.test(encoding)) {
52
+ return decoder.decode(buf);
53
+ }
54
+ else if (/^base64$/i.test(encoding)) {
55
+ return base64.fromUint8Array(buf);
56
+ }
57
+ else if (/^base64url$/i.test(encoding)) {
58
+ return base64url.fromUint8Array(buf);
59
+ }
60
+ else if (/^hex(?:adecimal)?$/i.test(encoding)) {
61
+ return toHexString(buf);
62
+ }
63
+ else {
64
+ throw new TypeError("Unsupported string encoding.");
65
+ }
66
+ }
67
+ exports.decode = decode;
68
+ function encode(str, encoding = "utf8") {
69
+ if (/^utf-?8$/i.test(encoding)) {
70
+ return encoder.encode(str);
71
+ }
72
+ else if (/^base64(?:url)?$/i.test(encoding)) {
73
+ return base64.toUint8Array(str);
74
+ }
75
+ else if (/^hex(?:adecimal)?$/i.test(encoding)) {
76
+ return fromHexString(str);
77
+ }
78
+ else {
79
+ throw new TypeError("Unsupported string encoding.");
80
+ }
81
+ }
82
+ exports.encode = encode;
@@ -14,6 +14,9 @@ class ScanCommand extends command_js_1.Command {
14
14
  if (typeof opts?.count === "number") {
15
15
  command.push("count", opts.count);
16
16
  }
17
+ if (opts?.type && opts.type.length > 0) {
18
+ command.push("type", opts.type);
19
+ }
17
20
  super(command, cmdOpts);
18
21
  }
19
22
  }
@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.Redis = void 0;
4
4
  const mod_js_1 = require("./commands/mod.js");
5
5
  const pipeline_js_1 = require("./pipeline.js");
6
+ const script_js_1 = require("./script.js");
6
7
  /**
7
8
  * Serverless redis client for upstash.
8
9
  */
@@ -1088,5 +1089,8 @@ class Redis {
1088
1089
  this.client = client;
1089
1090
  this.opts = opts;
1090
1091
  }
1092
+ createScript(script) {
1093
+ return new script_js_1.Script(this, script);
1094
+ }
1091
1095
  }
1092
1096
  exports.Redis = Redis;
@@ -0,0 +1,81 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.Script = void 0;
4
+ const mod_js_1 = require("../deps/denopkg.com/chiefbiiko/sha1@master/mod.js");
5
+ /**
6
+ * Creates a new script.
7
+ *
8
+ * Scripts offer the ability to optimistically try to execute a script without having to send the
9
+ * entire script to the server. If the script is loaded on the server, it tries again by sending
10
+ * the entire script. Afterwards, the script is cached on the server.
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const redis = new Redis({...})
15
+ *
16
+ * const script = redis.createScript<string>("return ARGV[1];")
17
+ * const arg1 = await script.eval([], ["Hello World"])
18
+ * assertEquals(arg1, "Hello World")
19
+ * ```
20
+ */
21
+ class Script {
22
+ constructor(redis, script) {
23
+ Object.defineProperty(this, "script", {
24
+ enumerable: true,
25
+ configurable: true,
26
+ writable: true,
27
+ value: void 0
28
+ });
29
+ Object.defineProperty(this, "sha1", {
30
+ enumerable: true,
31
+ configurable: true,
32
+ writable: true,
33
+ value: void 0
34
+ });
35
+ Object.defineProperty(this, "redis", {
36
+ enumerable: true,
37
+ configurable: true,
38
+ writable: true,
39
+ value: void 0
40
+ });
41
+ this.redis = redis;
42
+ this.sha1 = this.digest(script);
43
+ this.script = script;
44
+ }
45
+ /**
46
+ * Send an `EVAL` command to redis.
47
+ */
48
+ async eval(keys, args) {
49
+ return await this.redis.eval(this.script, keys, args);
50
+ }
51
+ /**
52
+ * Calculates the sha1 hash of the script and then calls `EVALSHA`.
53
+ */
54
+ async evalsha(keys, args) {
55
+ return await this.redis.evalsha(this.sha1, keys, args);
56
+ }
57
+ /**
58
+ * Optimistically try to run `EVALSHA` first.
59
+ * If the script is not loaded in redis, it will fall back and try again with `EVAL`.
60
+ *
61
+ * Following calls will be able to use the cached script
62
+ */
63
+ async exec(keys, args) {
64
+ const res = await this.redis.evalsha(this.sha1, keys, args).catch(async (err) => {
65
+ if (err instanceof Error &&
66
+ err.message.toLowerCase().includes("noscript")) {
67
+ return await this.redis.eval(this.script, keys, args);
68
+ }
69
+ throw err;
70
+ });
71
+ return res;
72
+ }
73
+ /**
74
+ * Compute the sha1 hash of the script and return its hex representation.
75
+ */
76
+ digest(s) {
77
+ const hash = (0, mod_js_1.sha1)(s, "utf8", "hex");
78
+ return typeof hash === "string" ? hash : new TextDecoder().decode(hash);
79
+ }
80
+ }
81
+ exports.Script = Script;
@@ -0,0 +1,5 @@
1
+ export declare function init(lookup: string[], revLookup: number[], urlsafe?: boolean): {
2
+ byteLength(b64: string): number;
3
+ toUint8Array(b64: string): Uint8Array;
4
+ fromUint8Array(buf: Uint8Array): string;
5
+ };
@@ -0,0 +1 @@
1
+ export declare const byteLength: (b64: string) => number, toUint8Array: (b64: string) => Uint8Array, fromUint8Array: (buf: Uint8Array) => string;
@@ -0,0 +1 @@
1
+ export declare const byteLength: (b64: string) => number, toUint8Array: (b64: string) => Uint8Array, fromUint8Array: (buf: Uint8Array) => string;
@@ -0,0 +1 @@
1
+ export { encode, decode } from "../std-encoding@v1.1.1/mod.js";
@@ -0,0 +1,26 @@
1
+ /** Byte length of a SHA1 digest. */
2
+ export declare const BYTES: number;
3
+ /** A class representation of the SHA1 algorithm. */
4
+ export declare class SHA1 {
5
+ readonly hashSize: number;
6
+ private _buf;
7
+ private _bufIdx;
8
+ private _count;
9
+ private _K;
10
+ private _H;
11
+ private _finalized;
12
+ /** Creates a SHA1 instance. */
13
+ constructor();
14
+ /** Reduces the four input numbers to a single one. */
15
+ protected static F(t: number, b: number, c: number, d: number): number;
16
+ /** Initializes a hash instance. */
17
+ init(): SHA1;
18
+ /** Updates a hash with additional message data. */
19
+ update(msg: string | Uint8Array, inputEncoding?: string): SHA1;
20
+ /** Finalizes a hash with additional message data. */
21
+ digest(outputEncoding?: string): string | Uint8Array;
22
+ /** Performs one transformation cycle. */
23
+ private transform;
24
+ }
25
+ /** Generates a SHA1 hash of the input data. */
26
+ export declare function sha1(msg: string | Uint8Array, inputEncoding?: string, outputEncoding?: string): string | Uint8Array;
@@ -0,0 +1,3 @@
1
+ /** Decodes a Uint8Array to utf8-, base64-, or hex-encoded string. */
2
+ export declare function decode(buf: Uint8Array, encoding?: string): string;
3
+ export declare function encode(str: string, encoding?: string): Uint8Array;
@@ -2,6 +2,7 @@ import { Command, CommandOptions } from "./command.js";
2
2
  export declare type ScanCommandOptions = {
3
3
  match?: string;
4
4
  count?: number;
5
+ type?: string;
5
6
  };
6
7
  /**
7
8
  * @see https://redis.io/commands/scan
@@ -2,6 +2,7 @@ import { CommandOptions, DelCommand, ExistsCommand, FlushAllCommand, MGetCommand
2
2
  import { Requester, UpstashRequest, UpstashResponse } from "./http.js";
3
3
  import { Pipeline } from "./pipeline.js";
4
4
  import type { CommandArgs } from "./types.js";
5
+ import { Script } from "./script.js";
5
6
  export declare type RedisOptions = {
6
7
  /**
7
8
  * Automatically try to deserialize the returned data from upstash using `JSON.deserialize`
@@ -32,6 +33,7 @@ export declare class Redis {
32
33
  * Wrap a new middleware around the HTTP client.
33
34
  */
34
35
  use: <TResult = unknown>(middleware: (r: UpstashRequest, next: <TResult_1 = unknown>(req: UpstashRequest) => Promise<UpstashResponse<TResult_1>>) => Promise<UpstashResponse<TResult>>) => void;
36
+ createScript(script: string): Script;
35
37
  /**
36
38
  * Create a new pipeline that allows you to send requests in bulk.
37
39
  *
@@ -0,0 +1,42 @@
1
+ import { Redis } from "./redis.js";
2
+ /**
3
+ * Creates a new script.
4
+ *
5
+ * Scripts offer the ability to optimistically try to execute a script without having to send the
6
+ * entire script to the server. If the script is loaded on the server, it tries again by sending
7
+ * the entire script. Afterwards, the script is cached on the server.
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * const redis = new Redis({...})
12
+ *
13
+ * const script = redis.createScript<string>("return ARGV[1];")
14
+ * const arg1 = await script.eval([], ["Hello World"])
15
+ * assertEquals(arg1, "Hello World")
16
+ * ```
17
+ */
18
+ export declare class Script<TResult = unknown> {
19
+ readonly script: string;
20
+ readonly sha1: string;
21
+ private readonly redis;
22
+ constructor(redis: Redis, script: string);
23
+ /**
24
+ * Send an `EVAL` command to redis.
25
+ */
26
+ eval(keys: string[], args: string[]): Promise<TResult>;
27
+ /**
28
+ * Calculates the sha1 hash of the script and then calls `EVALSHA`.
29
+ */
30
+ evalsha(keys: string[], args: string[]): Promise<TResult>;
31
+ /**
32
+ * Optimistically try to run `EVALSHA` first.
33
+ * If the script is not loaded in redis, it will fall back and try again with `EVAL`.
34
+ *
35
+ * Following calls will be able to use the cached script
36
+ */
37
+ exec(keys: string[], args: string[]): Promise<TResult>;
38
+ /**
39
+ * Compute the sha1 hash of the script and return its hex representation.
40
+ */
41
+ private digest;
42
+ }