@upstash/redis 0.0.0-ci.d5601844-20220803 → 0.0.0-ci.d93ae2f1-20230531
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.
- package/README.md +20 -18
- package/esm/deps/deno.land/x/base64@v0.2.1/base.js +100 -0
- package/esm/deps/deno.land/x/base64@v0.2.1/base64url.js +9 -0
- package/esm/deps/deno.land/x/sha1@v1.0.3/deps.js +1 -0
- package/esm/deps/deno.land/x/sha1@v1.0.3/mod.js +191 -0
- package/esm/deps/denopkg.com/chiefbiiko/std-encoding@v1.0.0/mod.js +50 -0
- package/esm/pkg/commands/command.js +12 -3
- package/esm/pkg/commands/getdel.js +9 -0
- package/esm/pkg/commands/hgetall.js +0 -4
- package/esm/pkg/commands/hrandfield.js +39 -0
- package/esm/pkg/commands/json_arrappend.js +9 -0
- package/esm/pkg/commands/json_arrindex.js +9 -0
- package/esm/pkg/commands/json_arrinsert.js +9 -0
- package/esm/pkg/commands/json_arrlen.js +9 -0
- package/esm/pkg/commands/json_arrpop.js +9 -0
- package/esm/pkg/commands/json_arrtrim.js +12 -0
- package/esm/pkg/commands/json_clear.js +9 -0
- package/esm/pkg/commands/json_del.js +9 -0
- package/esm/pkg/commands/json_forget.js +9 -0
- package/esm/pkg/commands/json_get.js +30 -0
- package/esm/pkg/commands/json_mget.js +9 -0
- package/esm/pkg/commands/json_numincrby.js +9 -0
- package/esm/pkg/commands/json_nummultby.js +9 -0
- package/esm/pkg/commands/json_objkeys.js +9 -0
- package/esm/pkg/commands/json_objlen.js +9 -0
- package/esm/pkg/commands/json_resp.js +9 -0
- package/esm/pkg/commands/json_set.js +18 -0
- package/esm/pkg/commands/json_strappend.js +9 -0
- package/esm/pkg/commands/json_strlen.js +9 -0
- package/esm/pkg/commands/json_toggle.js +9 -0
- package/esm/pkg/commands/json_type.js +9 -0
- package/esm/pkg/commands/lmove.js +9 -0
- package/esm/pkg/commands/mod.js +25 -0
- package/esm/pkg/commands/scan.js +3 -0
- package/esm/pkg/commands/smismember.js +9 -0
- package/esm/pkg/commands/zdiffstore.js +9 -0
- package/esm/pkg/commands/zmscore.js +10 -0
- package/esm/pkg/http.js +92 -2
- package/esm/pkg/pipeline.js +170 -12
- package/esm/pkg/redis.js +202 -2
- package/esm/pkg/script.js +77 -0
- package/esm/platforms/cloudflare.js +10 -2
- package/esm/platforms/fastly.js +6 -0
- package/esm/platforms/node_with_fetch.js +26 -1
- package/esm/platforms/nodejs.js +24 -1
- package/esm/version.js +1 -0
- package/package.json +41 -54
- package/script/deps/deno.land/x/base64@v0.2.1/base.js +104 -0
- package/script/deps/deno.land/x/base64@v0.2.1/base64url.js +13 -0
- package/script/deps/deno.land/x/sha1@v1.0.3/deps.js +6 -0
- package/script/deps/deno.land/x/sha1@v1.0.3/mod.js +196 -0
- package/script/deps/denopkg.com/chiefbiiko/std-encoding@v1.0.0/mod.js +55 -0
- package/script/pkg/commands/command.js +12 -3
- package/script/pkg/commands/getdel.js +13 -0
- package/script/pkg/commands/hgetall.js +0 -4
- package/script/pkg/commands/hrandfield.js +43 -0
- package/script/pkg/commands/json_arrappend.js +13 -0
- package/script/pkg/commands/json_arrindex.js +13 -0
- package/script/pkg/commands/json_arrinsert.js +13 -0
- package/script/pkg/commands/json_arrlen.js +13 -0
- package/script/pkg/commands/json_arrpop.js +13 -0
- package/script/pkg/commands/json_arrtrim.js +16 -0
- package/script/pkg/commands/json_clear.js +13 -0
- package/script/pkg/commands/json_del.js +13 -0
- package/script/pkg/commands/json_forget.js +13 -0
- package/script/pkg/commands/json_get.js +34 -0
- package/script/pkg/commands/json_mget.js +13 -0
- package/script/pkg/commands/json_numincrby.js +13 -0
- package/script/pkg/commands/json_nummultby.js +13 -0
- package/script/pkg/commands/json_objkeys.js +13 -0
- package/script/pkg/commands/json_objlen.js +13 -0
- package/script/pkg/commands/json_resp.js +13 -0
- package/script/pkg/commands/json_set.js +22 -0
- package/script/pkg/commands/json_strappend.js +13 -0
- package/script/pkg/commands/json_strlen.js +13 -0
- package/script/pkg/commands/json_toggle.js +13 -0
- package/script/pkg/commands/json_type.js +13 -0
- package/script/pkg/commands/lmove.js +13 -0
- package/script/pkg/commands/mod.js +25 -0
- package/script/pkg/commands/scan.js +3 -0
- package/script/pkg/commands/smismember.js +13 -0
- package/script/pkg/commands/zdiffstore.js +13 -0
- package/script/pkg/commands/zmscore.js +14 -0
- package/script/pkg/http.js +92 -2
- package/script/pkg/pipeline.js +169 -11
- package/script/pkg/redis.js +201 -1
- package/script/pkg/script.js +81 -0
- package/script/platforms/cloudflare.js +10 -2
- package/script/platforms/fastly.js +6 -0
- package/script/platforms/node_with_fetch.js +26 -1
- package/script/platforms/nodejs.js +24 -1
- package/script/version.js +4 -0
- package/types/deps/deno.land/x/base64@v0.2.1/base.d.ts +5 -0
- package/types/deps/deno.land/x/base64@v0.2.1/base64url.d.ts +1 -0
- package/types/deps/deno.land/x/sha1@v1.0.3/deps.d.ts +1 -0
- package/types/deps/deno.land/x/sha1@v1.0.3/mod.d.ts +26 -0
- package/types/deps/denopkg.com/chiefbiiko/std-encoding@v1.0.0/mod.d.ts +3 -0
- package/types/pkg/commands/command.d.ts +5 -5
- package/types/pkg/commands/getdel.d.ts +7 -0
- package/types/pkg/commands/hdel.d.ts +1 -1
- package/types/pkg/commands/hrandfield.d.ts +9 -0
- package/types/pkg/commands/json_arrappend.d.ts +7 -0
- package/types/pkg/commands/json_arrindex.d.ts +13 -0
- package/types/pkg/commands/json_arrinsert.d.ts +7 -0
- package/types/pkg/commands/json_arrlen.d.ts +7 -0
- package/types/pkg/commands/json_arrpop.d.ts +7 -0
- package/types/pkg/commands/json_arrtrim.d.ts +7 -0
- package/types/pkg/commands/json_clear.d.ts +7 -0
- package/types/pkg/commands/json_del.d.ts +7 -0
- package/types/pkg/commands/json_forget.d.ts +7 -0
- package/types/pkg/commands/json_get.d.ts +15 -0
- package/types/pkg/commands/json_mget.d.ts +7 -0
- package/types/pkg/commands/json_numincrby.d.ts +7 -0
- package/types/pkg/commands/json_nummultby.d.ts +7 -0
- package/types/pkg/commands/json_objkeys.d.ts +7 -0
- package/types/pkg/commands/json_objlen.d.ts +7 -0
- package/types/pkg/commands/json_resp.d.ts +7 -0
- package/types/pkg/commands/json_set.d.ts +18 -0
- package/types/pkg/commands/json_strappend.d.ts +7 -0
- package/types/pkg/commands/json_strlen.d.ts +7 -0
- package/types/pkg/commands/json_toggle.d.ts +7 -0
- package/types/pkg/commands/json_type.d.ts +7 -0
- package/types/pkg/commands/lmove.d.ts +12 -0
- package/types/pkg/commands/mod.d.ts +25 -0
- package/types/pkg/commands/scan.d.ts +2 -1
- package/types/pkg/commands/script_flush.d.ts +1 -1
- package/types/pkg/commands/set.d.ts +3 -3
- package/types/pkg/commands/smembers.d.ts +2 -2
- package/types/pkg/commands/smismember.d.ts +7 -0
- package/types/pkg/commands/type.d.ts +1 -1
- package/types/pkg/commands/zadd.d.ts +3 -3
- package/types/pkg/commands/zdiffstore.d.ts +7 -0
- package/types/pkg/commands/zinterstore.d.ts +1 -1
- package/types/pkg/commands/zmscore.d.ts +7 -0
- package/types/pkg/commands/zrange.d.ts +1 -1
- package/types/pkg/commands/zunionstore.d.ts +1 -1
- package/types/pkg/http.d.ts +44 -7
- package/types/pkg/pipeline.d.ts +255 -125
- package/types/pkg/redis.d.ts +144 -13
- package/types/pkg/script.d.ts +42 -0
- package/types/pkg/types.d.ts +27 -1
- package/types/platforms/cloudflare.d.ts +9 -8
- package/types/platforms/fastly.d.ts +3 -7
- package/types/platforms/node_with_fetch.d.ts +3 -22
- package/types/platforms/nodejs.d.ts +4 -7
- package/types/version.d.ts +1 -0
package/script/pkg/pipeline.js
CHANGED
|
@@ -3,6 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.Pipeline = void 0;
|
|
4
4
|
const mod_js_1 = require("./commands/mod.js");
|
|
5
5
|
const error_js_1 = require("./error.js");
|
|
6
|
+
const zmscore_js_1 = require("./commands/zmscore.js");
|
|
7
|
+
const hrandfield_js_1 = require("./commands/hrandfield.js");
|
|
8
|
+
const zdiffstore_js_1 = require("./commands/zdiffstore.js");
|
|
6
9
|
/**
|
|
7
10
|
* Upstash REST API supports command pipelining to send multiple commands in
|
|
8
11
|
* batch, instead of sending each command one by one and waiting for a response.
|
|
@@ -19,7 +22,7 @@ const error_js_1 = require("./error.js");
|
|
|
19
22
|
* **Examples:**
|
|
20
23
|
*
|
|
21
24
|
* ```ts
|
|
22
|
-
* const p = redis.pipeline()
|
|
25
|
+
* const p = redis.pipeline() // or redis.multi()
|
|
23
26
|
* p.set("key","value")
|
|
24
27
|
* p.get("key")
|
|
25
28
|
* const res = await p.exec()
|
|
@@ -31,7 +34,7 @@ const error_js_1 = require("./error.js");
|
|
|
31
34
|
* const res = await p.set("key","value").get("key").exec()
|
|
32
35
|
* ```
|
|
33
36
|
*
|
|
34
|
-
*
|
|
37
|
+
* Return types are inferred if all commands are chained, but you can still
|
|
35
38
|
* override the response type manually:
|
|
36
39
|
* ```ts
|
|
37
40
|
* redis.pipeline()
|
|
@@ -42,7 +45,7 @@ const error_js_1 = require("./error.js");
|
|
|
42
45
|
* ```
|
|
43
46
|
*/
|
|
44
47
|
class Pipeline {
|
|
45
|
-
constructor(
|
|
48
|
+
constructor(opts) {
|
|
46
49
|
Object.defineProperty(this, "client", {
|
|
47
50
|
enumerable: true,
|
|
48
51
|
configurable: true,
|
|
@@ -61,14 +64,22 @@ class Pipeline {
|
|
|
61
64
|
writable: true,
|
|
62
65
|
value: void 0
|
|
63
66
|
});
|
|
67
|
+
Object.defineProperty(this, "multiExec", {
|
|
68
|
+
enumerable: true,
|
|
69
|
+
configurable: true,
|
|
70
|
+
writable: true,
|
|
71
|
+
value: void 0
|
|
72
|
+
});
|
|
64
73
|
/**
|
|
65
74
|
* Send the pipeline request to upstash.
|
|
66
75
|
*
|
|
67
76
|
* Returns an array with the results of all pipelined commands.
|
|
68
77
|
*
|
|
69
|
-
* You can define a return type manually
|
|
78
|
+
* If all commands are statically chained from start to finish, types are inferred. You can still define a return type manually if necessary though:
|
|
70
79
|
* ```ts
|
|
71
|
-
* redis.pipeline()
|
|
80
|
+
* const p = redis.pipeline()
|
|
81
|
+
* p.get("key")
|
|
82
|
+
* const result = p.exec<[{ greeting: string }]>()
|
|
72
83
|
* ```
|
|
73
84
|
*/
|
|
74
85
|
Object.defineProperty(this, "exec", {
|
|
@@ -79,8 +90,9 @@ class Pipeline {
|
|
|
79
90
|
if (this.commands.length === 0) {
|
|
80
91
|
throw new Error("Pipeline is empty");
|
|
81
92
|
}
|
|
93
|
+
const path = this.multiExec ? ["multi-exec"] : ["pipeline"];
|
|
82
94
|
const res = (await this.client.request({
|
|
83
|
-
path
|
|
95
|
+
path,
|
|
84
96
|
body: Object.values(this.commands).map((c) => c.command),
|
|
85
97
|
}));
|
|
86
98
|
return res.map(({ error, result }, i) => {
|
|
@@ -127,6 +139,15 @@ class Pipeline {
|
|
|
127
139
|
writable: true,
|
|
128
140
|
value: (...args) => this.chain(new mod_js_1.BitPosCommand(args, this.commandOptions))
|
|
129
141
|
});
|
|
142
|
+
/**
|
|
143
|
+
* @see https://redis.io/commands/zdiffstore
|
|
144
|
+
*/
|
|
145
|
+
Object.defineProperty(this, "zdiffstore", {
|
|
146
|
+
enumerable: true,
|
|
147
|
+
configurable: true,
|
|
148
|
+
writable: true,
|
|
149
|
+
value: (...args) => this.chain(new zdiffstore_js_1.ZDiffStoreCommand(args, this.commandOptions))
|
|
150
|
+
});
|
|
130
151
|
/**
|
|
131
152
|
* @see https://redis.io/commands/dbsize
|
|
132
153
|
*/
|
|
@@ -253,6 +274,15 @@ class Pipeline {
|
|
|
253
274
|
writable: true,
|
|
254
275
|
value: (...args) => this.chain(new mod_js_1.GetBitCommand(args, this.commandOptions))
|
|
255
276
|
});
|
|
277
|
+
/**
|
|
278
|
+
* @see https://redis.io/commands/getdel
|
|
279
|
+
*/
|
|
280
|
+
Object.defineProperty(this, "getdel", {
|
|
281
|
+
enumerable: true,
|
|
282
|
+
configurable: true,
|
|
283
|
+
writable: true,
|
|
284
|
+
value: (...args) => this.chain(new mod_js_1.GetDelCommand(args, this.commandOptions))
|
|
285
|
+
});
|
|
256
286
|
/**
|
|
257
287
|
* @see https://redis.io/commands/getrange
|
|
258
288
|
*/
|
|
@@ -361,6 +391,15 @@ class Pipeline {
|
|
|
361
391
|
writable: true,
|
|
362
392
|
value: (key, kv) => this.chain(new mod_js_1.HMSetCommand([key, kv], this.commandOptions))
|
|
363
393
|
});
|
|
394
|
+
/**
|
|
395
|
+
* @see https://redis.io/commands/hrandfield
|
|
396
|
+
*/
|
|
397
|
+
Object.defineProperty(this, "hrandfield", {
|
|
398
|
+
enumerable: true,
|
|
399
|
+
configurable: true,
|
|
400
|
+
writable: true,
|
|
401
|
+
value: (key, count, withValues) => this.chain(new hrandfield_js_1.HRandFieldCommand([key, count, withValues], this.commandOptions))
|
|
402
|
+
});
|
|
364
403
|
/**
|
|
365
404
|
* @see https://redis.io/commands/hscan
|
|
366
405
|
*/
|
|
@@ -469,6 +508,15 @@ class Pipeline {
|
|
|
469
508
|
writable: true,
|
|
470
509
|
value: (...args) => this.chain(new mod_js_1.LLenCommand(args, this.commandOptions))
|
|
471
510
|
});
|
|
511
|
+
/**
|
|
512
|
+
* @see https://redis.io/commands/lmove
|
|
513
|
+
*/
|
|
514
|
+
Object.defineProperty(this, "lmove", {
|
|
515
|
+
enumerable: true,
|
|
516
|
+
configurable: true,
|
|
517
|
+
writable: true,
|
|
518
|
+
value: (...args) => this.chain(new mod_js_1.LMoveCommand(args, this.commandOptions))
|
|
519
|
+
});
|
|
472
520
|
/**
|
|
473
521
|
* @see https://redis.io/commands/lpop
|
|
474
522
|
*/
|
|
@@ -838,6 +886,15 @@ class Pipeline {
|
|
|
838
886
|
writable: true,
|
|
839
887
|
value: (...args) => this.chain(new mod_js_1.SMembersCommand(args, this.commandOptions))
|
|
840
888
|
});
|
|
889
|
+
/**
|
|
890
|
+
* @see https://redis.io/commands/smismember
|
|
891
|
+
*/
|
|
892
|
+
Object.defineProperty(this, "smismember", {
|
|
893
|
+
enumerable: true,
|
|
894
|
+
configurable: true,
|
|
895
|
+
writable: true,
|
|
896
|
+
value: (key, members) => this.chain(new mod_js_1.SMIsMemberCommand([key, members], this.commandOptions))
|
|
897
|
+
});
|
|
841
898
|
/**
|
|
842
899
|
* @see https://redis.io/commands/smove
|
|
843
900
|
*/
|
|
@@ -1014,6 +1071,15 @@ class Pipeline {
|
|
|
1014
1071
|
writable: true,
|
|
1015
1072
|
value: (...args) => this.chain(new mod_js_1.ZLexCountCommand(args, this.commandOptions))
|
|
1016
1073
|
});
|
|
1074
|
+
/**
|
|
1075
|
+
* @see https://redis.io/commands/zmscore
|
|
1076
|
+
*/
|
|
1077
|
+
Object.defineProperty(this, "zmscore", {
|
|
1078
|
+
enumerable: true,
|
|
1079
|
+
configurable: true,
|
|
1080
|
+
writable: true,
|
|
1081
|
+
value: (...args) => this.chain(new zmscore_js_1.ZMScoreCommand(args, this.commandOptions))
|
|
1082
|
+
});
|
|
1017
1083
|
/**
|
|
1018
1084
|
* @see https://redis.io/commands/zpopmax
|
|
1019
1085
|
*/
|
|
@@ -1122,17 +1188,109 @@ class Pipeline {
|
|
|
1122
1188
|
writable: true,
|
|
1123
1189
|
value: (...args) => this.chain(new mod_js_1.ZUnionStoreCommand(args, this.commandOptions))
|
|
1124
1190
|
});
|
|
1125
|
-
this.client = client;
|
|
1126
|
-
this.commands = [];
|
|
1127
|
-
this.commandOptions = commandOptions;
|
|
1191
|
+
this.client = opts.client;
|
|
1192
|
+
this.commands = []; // the TCommands generic in the class definition is only used for carrying through chained command types and should never be explicitly set when instantiating the class
|
|
1193
|
+
this.commandOptions = opts.commandOptions;
|
|
1194
|
+
this.multiExec = opts.multiExec ?? false;
|
|
1128
1195
|
}
|
|
1129
1196
|
/**
|
|
1130
|
-
* Pushes a command into the
|
|
1197
|
+
* Pushes a command into the pipeline and returns a chainable instance of the
|
|
1131
1198
|
* pipeline
|
|
1132
1199
|
*/
|
|
1133
1200
|
chain(command) {
|
|
1134
1201
|
this.commands.push(command);
|
|
1135
|
-
return this;
|
|
1202
|
+
return this; // TS thinks we're returning Pipeline<[]> here, because we're not creating a new instance of the class, hence the cast
|
|
1203
|
+
}
|
|
1204
|
+
/**
|
|
1205
|
+
* @see https://redis.io/commands/?group=json
|
|
1206
|
+
*/
|
|
1207
|
+
get json() {
|
|
1208
|
+
return {
|
|
1209
|
+
/**
|
|
1210
|
+
* @see https://redis.io/commands/json.arrappend
|
|
1211
|
+
*/
|
|
1212
|
+
arrappend: (...args) => this.chain(new mod_js_1.JsonArrAppendCommand(args, this.commandOptions)),
|
|
1213
|
+
/**
|
|
1214
|
+
* @see https://redis.io/commands/json.arrindex
|
|
1215
|
+
*/
|
|
1216
|
+
arrindex: (...args) => this.chain(new mod_js_1.JsonArrIndexCommand(args, this.commandOptions)),
|
|
1217
|
+
/**
|
|
1218
|
+
* @see https://redis.io/commands/json.arrinsert
|
|
1219
|
+
*/
|
|
1220
|
+
arrinsert: (...args) => this.chain(new mod_js_1.JsonArrInsertCommand(args, this.commandOptions)),
|
|
1221
|
+
/**
|
|
1222
|
+
* @see https://redis.io/commands/json.arrlen
|
|
1223
|
+
*/
|
|
1224
|
+
arrlen: (...args) => this.chain(new mod_js_1.JsonArrLenCommand(args, this.commandOptions)),
|
|
1225
|
+
/**
|
|
1226
|
+
* @see https://redis.io/commands/json.arrpop
|
|
1227
|
+
*/
|
|
1228
|
+
arrpop: (...args) => this.chain(new mod_js_1.JsonArrPopCommand(args, this.commandOptions)),
|
|
1229
|
+
/**
|
|
1230
|
+
* @see https://redis.io/commands/json.arrtrim
|
|
1231
|
+
*/
|
|
1232
|
+
arrtrim: (...args) => this.chain(new mod_js_1.JsonArrTrimCommand(args, this.commandOptions)),
|
|
1233
|
+
/**
|
|
1234
|
+
* @see https://redis.io/commands/json.clear
|
|
1235
|
+
*/
|
|
1236
|
+
clear: (...args) => this.chain(new mod_js_1.JsonClearCommand(args, this.commandOptions)),
|
|
1237
|
+
/**
|
|
1238
|
+
* @see https://redis.io/commands/json.del
|
|
1239
|
+
*/
|
|
1240
|
+
del: (...args) => this.chain(new mod_js_1.JsonDelCommand(args, this.commandOptions)),
|
|
1241
|
+
/**
|
|
1242
|
+
* @see https://redis.io/commands/json.forget
|
|
1243
|
+
*/
|
|
1244
|
+
forget: (...args) => this.chain(new mod_js_1.JsonForgetCommand(args, this.commandOptions)),
|
|
1245
|
+
/**
|
|
1246
|
+
* @see https://redis.io/commands/json.get
|
|
1247
|
+
*/
|
|
1248
|
+
get: (...args) => this.chain(new mod_js_1.JsonGetCommand(args, this.commandOptions)),
|
|
1249
|
+
/**
|
|
1250
|
+
* @see https://redis.io/commands/json.mget
|
|
1251
|
+
*/
|
|
1252
|
+
mget: (...args) => this.chain(new mod_js_1.JsonMGetCommand(args, this.commandOptions)),
|
|
1253
|
+
/**
|
|
1254
|
+
* @see https://redis.io/commands/json.numincrby
|
|
1255
|
+
*/
|
|
1256
|
+
numincrby: (...args) => this.chain(new mod_js_1.JsonNumIncrByCommand(args, this.commandOptions)),
|
|
1257
|
+
/**
|
|
1258
|
+
* @see https://redis.io/commands/json.nummultby
|
|
1259
|
+
*/
|
|
1260
|
+
nummultby: (...args) => this.chain(new mod_js_1.JsonNumMultByCommand(args, this.commandOptions)),
|
|
1261
|
+
/**
|
|
1262
|
+
* @see https://redis.io/commands/json.objkeys
|
|
1263
|
+
*/
|
|
1264
|
+
objkeys: (...args) => this.chain(new mod_js_1.JsonObjKeysCommand(args, this.commandOptions)),
|
|
1265
|
+
/**
|
|
1266
|
+
* @see https://redis.io/commands/json.objlen
|
|
1267
|
+
*/
|
|
1268
|
+
objlen: (...args) => this.chain(new mod_js_1.JsonObjLenCommand(args, this.commandOptions)),
|
|
1269
|
+
/**
|
|
1270
|
+
* @see https://redis.io/commands/json.resp
|
|
1271
|
+
*/
|
|
1272
|
+
resp: (...args) => this.chain(new mod_js_1.JsonRespCommand(args, this.commandOptions)),
|
|
1273
|
+
/**
|
|
1274
|
+
* @see https://redis.io/commands/json.set
|
|
1275
|
+
*/
|
|
1276
|
+
set: (...args) => this.chain(new mod_js_1.JsonSetCommand(args, this.commandOptions)),
|
|
1277
|
+
/**
|
|
1278
|
+
* @see https://redis.io/commands/json.strappend
|
|
1279
|
+
*/
|
|
1280
|
+
strappend: (...args) => this.chain(new mod_js_1.JsonStrAppendCommand(args, this.commandOptions)),
|
|
1281
|
+
/**
|
|
1282
|
+
* @see https://redis.io/commands/json.strlen
|
|
1283
|
+
*/
|
|
1284
|
+
strlen: (...args) => this.chain(new mod_js_1.JsonStrLenCommand(args, this.commandOptions)),
|
|
1285
|
+
/**
|
|
1286
|
+
* @see https://redis.io/commands/json.toggle
|
|
1287
|
+
*/
|
|
1288
|
+
toggle: (...args) => this.chain(new mod_js_1.JsonToggleCommand(args, this.commandOptions)),
|
|
1289
|
+
/**
|
|
1290
|
+
* @see https://redis.io/commands/json.type
|
|
1291
|
+
*/
|
|
1292
|
+
type: (...args) => this.chain(new mod_js_1.JsonTypeCommand(args, this.commandOptions)),
|
|
1293
|
+
};
|
|
1136
1294
|
}
|
|
1137
1295
|
}
|
|
1138
1296
|
exports.Pipeline = Pipeline;
|
package/script/pkg/redis.js
CHANGED
|
@@ -3,6 +3,9 @@ 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");
|
|
7
|
+
const zmscore_js_1 = require("./commands/zmscore.js");
|
|
8
|
+
const zdiffstore_js_1 = require("./commands/zdiffstore.js");
|
|
6
9
|
/**
|
|
7
10
|
* Serverless redis client for upstash.
|
|
8
11
|
*/
|
|
@@ -31,6 +34,12 @@ class Redis {
|
|
|
31
34
|
writable: true,
|
|
32
35
|
value: void 0
|
|
33
36
|
});
|
|
37
|
+
Object.defineProperty(this, "enableTelemetry", {
|
|
38
|
+
enumerable: true,
|
|
39
|
+
configurable: true,
|
|
40
|
+
writable: true,
|
|
41
|
+
value: void 0
|
|
42
|
+
});
|
|
34
43
|
/**
|
|
35
44
|
* Wrap a new middleware around the HTTP client.
|
|
36
45
|
*/
|
|
@@ -43,6 +52,27 @@ class Redis {
|
|
|
43
52
|
this.client.request = (req) => middleware(req, makeRequest);
|
|
44
53
|
}
|
|
45
54
|
});
|
|
55
|
+
/**
|
|
56
|
+
* Technically this is not private, we can hide it from intellisense by doing this
|
|
57
|
+
*/
|
|
58
|
+
Object.defineProperty(this, "addTelemetry", {
|
|
59
|
+
enumerable: true,
|
|
60
|
+
configurable: true,
|
|
61
|
+
writable: true,
|
|
62
|
+
value: (telemetry) => {
|
|
63
|
+
if (!this.enableTelemetry) {
|
|
64
|
+
return;
|
|
65
|
+
}
|
|
66
|
+
try {
|
|
67
|
+
// @ts-ignore - The `Requester` interface does not know about this method but it will be there
|
|
68
|
+
// as long as the user uses the standard HttpClient
|
|
69
|
+
this.client.mergeTelemetry(telemetry);
|
|
70
|
+
}
|
|
71
|
+
catch {
|
|
72
|
+
// ignore
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
});
|
|
46
76
|
/**
|
|
47
77
|
* Create a new pipeline that allows you to send requests in bulk.
|
|
48
78
|
*
|
|
@@ -52,7 +82,30 @@ class Redis {
|
|
|
52
82
|
enumerable: true,
|
|
53
83
|
configurable: true,
|
|
54
84
|
writable: true,
|
|
55
|
-
value: () => new pipeline_js_1.Pipeline(
|
|
85
|
+
value: () => new pipeline_js_1.Pipeline({
|
|
86
|
+
client: this.client,
|
|
87
|
+
commandOptions: this.opts,
|
|
88
|
+
multiExec: false,
|
|
89
|
+
})
|
|
90
|
+
});
|
|
91
|
+
/**
|
|
92
|
+
* Create a new transaction to allow executing multiple steps atomically.
|
|
93
|
+
*
|
|
94
|
+
* All the commands in a transaction are serialized and executed sequentially. A request sent by
|
|
95
|
+
* another client will never be served in the middle of the execution of a Redis Transaction. This
|
|
96
|
+
* guarantees that the commands are executed as a single isolated operation.
|
|
97
|
+
*
|
|
98
|
+
* @see {@link Pipeline}
|
|
99
|
+
*/
|
|
100
|
+
Object.defineProperty(this, "multi", {
|
|
101
|
+
enumerable: true,
|
|
102
|
+
configurable: true,
|
|
103
|
+
writable: true,
|
|
104
|
+
value: () => new pipeline_js_1.Pipeline({
|
|
105
|
+
client: this.client,
|
|
106
|
+
commandOptions: this.opts,
|
|
107
|
+
multiExec: true,
|
|
108
|
+
})
|
|
56
109
|
});
|
|
57
110
|
/**
|
|
58
111
|
* @see https://redis.io/commands/append
|
|
@@ -216,6 +269,15 @@ class Redis {
|
|
|
216
269
|
writable: true,
|
|
217
270
|
value: (...args) => new mod_js_1.GetBitCommand(args, this.opts).exec(this.client)
|
|
218
271
|
});
|
|
272
|
+
/**
|
|
273
|
+
* @see https://redis.io/commands/getdel
|
|
274
|
+
*/
|
|
275
|
+
Object.defineProperty(this, "getdel", {
|
|
276
|
+
enumerable: true,
|
|
277
|
+
configurable: true,
|
|
278
|
+
writable: true,
|
|
279
|
+
value: (...args) => new mod_js_1.GetDelCommand(args, this.opts).exec(this.client)
|
|
280
|
+
});
|
|
219
281
|
/**
|
|
220
282
|
* @see https://redis.io/commands/getrange
|
|
221
283
|
*/
|
|
@@ -324,6 +386,16 @@ class Redis {
|
|
|
324
386
|
writable: true,
|
|
325
387
|
value: (key, kv) => new mod_js_1.HMSetCommand([key, kv], this.opts).exec(this.client)
|
|
326
388
|
});
|
|
389
|
+
/**
|
|
390
|
+
* @see https://redis.io/commands/hrandfield
|
|
391
|
+
*/
|
|
392
|
+
Object.defineProperty(this, "hrandfield", {
|
|
393
|
+
enumerable: true,
|
|
394
|
+
configurable: true,
|
|
395
|
+
writable: true,
|
|
396
|
+
value: (key, count, withValues) => new mod_js_1.HRandFieldCommand([key, count, withValues], this.opts)
|
|
397
|
+
.exec(this.client)
|
|
398
|
+
});
|
|
327
399
|
/**
|
|
328
400
|
* @see https://redis.io/commands/hscan
|
|
329
401
|
*/
|
|
@@ -432,6 +504,15 @@ class Redis {
|
|
|
432
504
|
writable: true,
|
|
433
505
|
value: (...args) => new mod_js_1.LLenCommand(args, this.opts).exec(this.client)
|
|
434
506
|
});
|
|
507
|
+
/**
|
|
508
|
+
* @see https://redis.io/commands/lmove
|
|
509
|
+
*/
|
|
510
|
+
Object.defineProperty(this, "lmove", {
|
|
511
|
+
enumerable: true,
|
|
512
|
+
configurable: true,
|
|
513
|
+
writable: true,
|
|
514
|
+
value: (...args) => new mod_js_1.LMoveCommand(args, this.opts).exec(this.client)
|
|
515
|
+
});
|
|
435
516
|
/**
|
|
436
517
|
* @see https://redis.io/commands/lpop
|
|
437
518
|
*/
|
|
@@ -792,6 +873,15 @@ class Redis {
|
|
|
792
873
|
writable: true,
|
|
793
874
|
value: (key, member) => new mod_js_1.SIsMemberCommand([key, member], this.opts).exec(this.client)
|
|
794
875
|
});
|
|
876
|
+
/**
|
|
877
|
+
* @see https://redis.io/commands/smismember
|
|
878
|
+
*/
|
|
879
|
+
Object.defineProperty(this, "smismember", {
|
|
880
|
+
enumerable: true,
|
|
881
|
+
configurable: true,
|
|
882
|
+
writable: true,
|
|
883
|
+
value: (key, members) => new mod_js_1.SMIsMemberCommand([key, members], this.opts).exec(this.client)
|
|
884
|
+
});
|
|
795
885
|
/**
|
|
796
886
|
* @see https://redis.io/commands/smembers
|
|
797
887
|
*/
|
|
@@ -950,6 +1040,15 @@ class Redis {
|
|
|
950
1040
|
writable: true,
|
|
951
1041
|
value: (...args) => new mod_js_1.ZCountCommand(args, this.opts).exec(this.client)
|
|
952
1042
|
});
|
|
1043
|
+
/**
|
|
1044
|
+
* @see https://redis.io/commands/zdiffstore
|
|
1045
|
+
*/
|
|
1046
|
+
Object.defineProperty(this, "zdiffstore", {
|
|
1047
|
+
enumerable: true,
|
|
1048
|
+
configurable: true,
|
|
1049
|
+
writable: true,
|
|
1050
|
+
value: (...args) => new zdiffstore_js_1.ZDiffStoreCommand(args, this.opts).exec(this.client)
|
|
1051
|
+
});
|
|
953
1052
|
/**
|
|
954
1053
|
* @see https://redis.io/commands/zincrby
|
|
955
1054
|
*/
|
|
@@ -977,6 +1076,15 @@ class Redis {
|
|
|
977
1076
|
writable: true,
|
|
978
1077
|
value: (...args) => new mod_js_1.ZLexCountCommand(args, this.opts).exec(this.client)
|
|
979
1078
|
});
|
|
1079
|
+
/**
|
|
1080
|
+
* @see https://redis.io/commands/zmscore
|
|
1081
|
+
*/
|
|
1082
|
+
Object.defineProperty(this, "zmscore", {
|
|
1083
|
+
enumerable: true,
|
|
1084
|
+
configurable: true,
|
|
1085
|
+
writable: true,
|
|
1086
|
+
value: (...args) => new zmscore_js_1.ZMScoreCommand(args, this.opts).exec(this.client)
|
|
1087
|
+
});
|
|
980
1088
|
/**
|
|
981
1089
|
* @see https://redis.io/commands/zpopmax
|
|
982
1090
|
*/
|
|
@@ -1087,6 +1195,98 @@ class Redis {
|
|
|
1087
1195
|
});
|
|
1088
1196
|
this.client = client;
|
|
1089
1197
|
this.opts = opts;
|
|
1198
|
+
this.enableTelemetry = opts?.enableTelemetry ?? true;
|
|
1199
|
+
}
|
|
1200
|
+
get json() {
|
|
1201
|
+
return {
|
|
1202
|
+
/**
|
|
1203
|
+
* @see https://redis.io/commands/json.arrappend
|
|
1204
|
+
*/
|
|
1205
|
+
arrappend: (...args) => new mod_js_1.JsonArrAppendCommand(args, this.opts).exec(this.client),
|
|
1206
|
+
/**
|
|
1207
|
+
* @see https://redis.io/commands/json.arrindex
|
|
1208
|
+
*/
|
|
1209
|
+
arrindex: (...args) => new mod_js_1.JsonArrIndexCommand(args, this.opts).exec(this.client),
|
|
1210
|
+
/**
|
|
1211
|
+
* @see https://redis.io/commands/json.arrinsert
|
|
1212
|
+
*/
|
|
1213
|
+
arrinsert: (...args) => new mod_js_1.JsonArrInsertCommand(args, this.opts).exec(this.client),
|
|
1214
|
+
/**
|
|
1215
|
+
* @see https://redis.io/commands/json.arrlen
|
|
1216
|
+
*/
|
|
1217
|
+
arrlen: (...args) => new mod_js_1.JsonArrLenCommand(args, this.opts).exec(this.client),
|
|
1218
|
+
/**
|
|
1219
|
+
* @see https://redis.io/commands/json.arrpop
|
|
1220
|
+
*/
|
|
1221
|
+
arrpop: (...args) => new mod_js_1.JsonArrPopCommand(args, this.opts).exec(this.client),
|
|
1222
|
+
/**
|
|
1223
|
+
* @see https://redis.io/commands/json.arrtrim
|
|
1224
|
+
*/
|
|
1225
|
+
arrtrim: (...args) => new mod_js_1.JsonArrTrimCommand(args, this.opts).exec(this.client),
|
|
1226
|
+
/**
|
|
1227
|
+
* @see https://redis.io/commands/json.clear
|
|
1228
|
+
*/
|
|
1229
|
+
clear: (...args) => new mod_js_1.JsonClearCommand(args, this.opts).exec(this.client),
|
|
1230
|
+
/**
|
|
1231
|
+
* @see https://redis.io/commands/json.del
|
|
1232
|
+
*/
|
|
1233
|
+
del: (...args) => new mod_js_1.JsonDelCommand(args, this.opts).exec(this.client),
|
|
1234
|
+
/**
|
|
1235
|
+
* @see https://redis.io/commands/json.forget
|
|
1236
|
+
*/
|
|
1237
|
+
forget: (...args) => new mod_js_1.JsonForgetCommand(args, this.opts).exec(this.client),
|
|
1238
|
+
/**
|
|
1239
|
+
* @see https://redis.io/commands/json.get
|
|
1240
|
+
*/
|
|
1241
|
+
get: (...args) => new mod_js_1.JsonGetCommand(args, this.opts).exec(this.client),
|
|
1242
|
+
/**
|
|
1243
|
+
* @see https://redis.io/commands/json.mget
|
|
1244
|
+
*/
|
|
1245
|
+
mget: (...args) => new mod_js_1.JsonMGetCommand(args, this.opts).exec(this.client),
|
|
1246
|
+
/**
|
|
1247
|
+
* @see https://redis.io/commands/json.numincrby
|
|
1248
|
+
*/
|
|
1249
|
+
numincrby: (...args) => new mod_js_1.JsonNumIncrByCommand(args, this.opts).exec(this.client),
|
|
1250
|
+
/**
|
|
1251
|
+
* @see https://redis.io/commands/json.nummultby
|
|
1252
|
+
*/
|
|
1253
|
+
nummultby: (...args) => new mod_js_1.JsonNumMultByCommand(args, this.opts).exec(this.client),
|
|
1254
|
+
/**
|
|
1255
|
+
* @see https://redis.io/commands/json.objkeys
|
|
1256
|
+
*/
|
|
1257
|
+
objkeys: (...args) => new mod_js_1.JsonObjKeysCommand(args, this.opts).exec(this.client),
|
|
1258
|
+
/**
|
|
1259
|
+
* @see https://redis.io/commands/json.objlen
|
|
1260
|
+
*/
|
|
1261
|
+
objlen: (...args) => new mod_js_1.JsonObjLenCommand(args, this.opts).exec(this.client),
|
|
1262
|
+
/**
|
|
1263
|
+
* @see https://redis.io/commands/json.resp
|
|
1264
|
+
*/
|
|
1265
|
+
resp: (...args) => new mod_js_1.JsonRespCommand(args, this.opts).exec(this.client),
|
|
1266
|
+
/**
|
|
1267
|
+
* @see https://redis.io/commands/json.set
|
|
1268
|
+
*/
|
|
1269
|
+
set: (...args) => new mod_js_1.JsonSetCommand(args, this.opts).exec(this.client),
|
|
1270
|
+
/**
|
|
1271
|
+
* @see https://redis.io/commands/json.strappend
|
|
1272
|
+
*/
|
|
1273
|
+
strappend: (...args) => new mod_js_1.JsonStrAppendCommand(args, this.opts).exec(this.client),
|
|
1274
|
+
/**
|
|
1275
|
+
* @see https://redis.io/commands/json.strlen
|
|
1276
|
+
*/
|
|
1277
|
+
strlen: (...args) => new mod_js_1.JsonStrLenCommand(args, this.opts).exec(this.client),
|
|
1278
|
+
/**
|
|
1279
|
+
* @see https://redis.io/commands/json.toggle
|
|
1280
|
+
*/
|
|
1281
|
+
toggle: (...args) => new mod_js_1.JsonToggleCommand(args, this.opts).exec(this.client),
|
|
1282
|
+
/**
|
|
1283
|
+
* @see https://redis.io/commands/json.type
|
|
1284
|
+
*/
|
|
1285
|
+
type: (...args) => new mod_js_1.JsonTypeCommand(args, this.opts).exec(this.client),
|
|
1286
|
+
};
|
|
1287
|
+
}
|
|
1288
|
+
createScript(script) {
|
|
1289
|
+
return new script_js_1.Script(this, script);
|
|
1090
1290
|
}
|
|
1091
1291
|
}
|
|
1092
1292
|
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/deno.land/x/sha1@v1.0.3/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;
|
|
@@ -26,6 +26,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
26
26
|
exports.Redis = void 0;
|
|
27
27
|
const core = __importStar(require("../pkg/redis.js"));
|
|
28
28
|
const http_js_1 = require("../pkg/http.js");
|
|
29
|
+
const version_js_1 = require("../version.js");
|
|
29
30
|
/**
|
|
30
31
|
* Serverless redis client for upstash.
|
|
31
32
|
*/
|
|
@@ -41,7 +42,7 @@ class Redis extends core.Redis {
|
|
|
41
42
|
* });
|
|
42
43
|
* ```
|
|
43
44
|
*/
|
|
44
|
-
constructor(config) {
|
|
45
|
+
constructor(config, env) {
|
|
45
46
|
if (config.url.startsWith(" ") ||
|
|
46
47
|
config.url.endsWith(" ") ||
|
|
47
48
|
/\r|\n/.test(config.url)) {
|
|
@@ -56,10 +57,17 @@ class Redis extends core.Redis {
|
|
|
56
57
|
retry: config.retry,
|
|
57
58
|
baseUrl: config.url,
|
|
58
59
|
headers: { authorization: `Bearer ${config.token}` },
|
|
60
|
+
responseEncoding: config.responseEncoding,
|
|
59
61
|
});
|
|
60
62
|
super(client, {
|
|
63
|
+
enableTelemetry: !env?.UPSTASH_DISABLE_TELEMETRY,
|
|
61
64
|
automaticDeserialization: config.automaticDeserialization,
|
|
62
65
|
});
|
|
66
|
+
// This is only added of the user has not disabled telemetry
|
|
67
|
+
this.addTelemetry({
|
|
68
|
+
platform: "cloudflare",
|
|
69
|
+
sdk: `@upstash/redis@${version_js_1.VERSION}`,
|
|
70
|
+
});
|
|
63
71
|
}
|
|
64
72
|
/*
|
|
65
73
|
* Create a new Upstash Redis instance from environment variables on cloudflare.
|
|
@@ -83,7 +91,7 @@ class Redis extends core.Redis {
|
|
|
83
91
|
if (!token) {
|
|
84
92
|
throw new Error("Unable to find environment variable: `UPSTASH_REDIS_REST_TOKEN`. Please add it via `wrangler secret put UPSTASH_REDIS_REST_TOKEN`");
|
|
85
93
|
}
|
|
86
|
-
return new Redis({ ...opts, url, token });
|
|
94
|
+
return new Redis({ ...opts, url, token }, env);
|
|
87
95
|
}
|
|
88
96
|
}
|
|
89
97
|
exports.Redis = Redis;
|