@upstash/redis 0.0.0-ci.d6b2e753-20220903 → 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.
Files changed (123) hide show
  1. package/README.md +20 -18
  2. package/esm/pkg/commands/command.js +12 -3
  3. package/esm/pkg/commands/getdel.js +9 -0
  4. package/esm/pkg/commands/hgetall.js +0 -4
  5. package/esm/pkg/commands/hrandfield.js +39 -0
  6. package/esm/pkg/commands/json_arrappend.js +9 -0
  7. package/esm/pkg/commands/json_arrindex.js +9 -0
  8. package/esm/pkg/commands/json_arrinsert.js +9 -0
  9. package/esm/pkg/commands/json_arrlen.js +9 -0
  10. package/esm/pkg/commands/json_arrpop.js +9 -0
  11. package/esm/pkg/commands/json_arrtrim.js +12 -0
  12. package/esm/pkg/commands/json_clear.js +9 -0
  13. package/esm/pkg/commands/json_del.js +9 -0
  14. package/esm/pkg/commands/json_forget.js +9 -0
  15. package/esm/pkg/commands/json_get.js +30 -0
  16. package/esm/pkg/commands/json_mget.js +9 -0
  17. package/esm/pkg/commands/json_numincrby.js +9 -0
  18. package/esm/pkg/commands/json_nummultby.js +9 -0
  19. package/esm/pkg/commands/json_objkeys.js +9 -0
  20. package/esm/pkg/commands/json_objlen.js +9 -0
  21. package/esm/pkg/commands/json_resp.js +9 -0
  22. package/esm/pkg/commands/json_set.js +18 -0
  23. package/esm/pkg/commands/json_strappend.js +9 -0
  24. package/esm/pkg/commands/json_strlen.js +9 -0
  25. package/esm/pkg/commands/json_toggle.js +9 -0
  26. package/esm/pkg/commands/json_type.js +9 -0
  27. package/esm/pkg/commands/lmove.js +9 -0
  28. package/esm/pkg/commands/mod.js +25 -0
  29. package/esm/pkg/commands/smismember.js +9 -0
  30. package/esm/pkg/commands/zdiffstore.js +9 -0
  31. package/esm/pkg/http.js +92 -2
  32. package/esm/pkg/pipeline.js +160 -12
  33. package/esm/pkg/redis.js +188 -2
  34. package/esm/platforms/cloudflare.js +10 -2
  35. package/esm/platforms/fastly.js +6 -0
  36. package/esm/platforms/node_with_fetch.js +26 -1
  37. package/esm/platforms/nodejs.js +24 -1
  38. package/esm/version.js +1 -0
  39. package/package.json +41 -16
  40. package/script/pkg/commands/command.js +12 -3
  41. package/script/pkg/commands/getdel.js +13 -0
  42. package/script/pkg/commands/hgetall.js +0 -4
  43. package/script/pkg/commands/hrandfield.js +43 -0
  44. package/script/pkg/commands/json_arrappend.js +13 -0
  45. package/script/pkg/commands/json_arrindex.js +13 -0
  46. package/script/pkg/commands/json_arrinsert.js +13 -0
  47. package/script/pkg/commands/json_arrlen.js +13 -0
  48. package/script/pkg/commands/json_arrpop.js +13 -0
  49. package/script/pkg/commands/json_arrtrim.js +16 -0
  50. package/script/pkg/commands/json_clear.js +13 -0
  51. package/script/pkg/commands/json_del.js +13 -0
  52. package/script/pkg/commands/json_forget.js +13 -0
  53. package/script/pkg/commands/json_get.js +34 -0
  54. package/script/pkg/commands/json_mget.js +13 -0
  55. package/script/pkg/commands/json_numincrby.js +13 -0
  56. package/script/pkg/commands/json_nummultby.js +13 -0
  57. package/script/pkg/commands/json_objkeys.js +13 -0
  58. package/script/pkg/commands/json_objlen.js +13 -0
  59. package/script/pkg/commands/json_resp.js +13 -0
  60. package/script/pkg/commands/json_set.js +22 -0
  61. package/script/pkg/commands/json_strappend.js +13 -0
  62. package/script/pkg/commands/json_strlen.js +13 -0
  63. package/script/pkg/commands/json_toggle.js +13 -0
  64. package/script/pkg/commands/json_type.js +13 -0
  65. package/script/pkg/commands/lmove.js +13 -0
  66. package/script/pkg/commands/mod.js +25 -0
  67. package/script/pkg/commands/smismember.js +13 -0
  68. package/script/pkg/commands/zdiffstore.js +13 -0
  69. package/script/pkg/http.js +92 -2
  70. package/script/pkg/pipeline.js +159 -11
  71. package/script/pkg/redis.js +187 -1
  72. package/script/platforms/cloudflare.js +10 -2
  73. package/script/platforms/fastly.js +6 -0
  74. package/script/platforms/node_with_fetch.js +26 -1
  75. package/script/platforms/nodejs.js +24 -1
  76. package/script/version.js +4 -0
  77. package/types/pkg/commands/command.d.ts +5 -5
  78. package/types/pkg/commands/getdel.d.ts +7 -0
  79. package/types/pkg/commands/hdel.d.ts +1 -1
  80. package/types/pkg/commands/hrandfield.d.ts +9 -0
  81. package/types/pkg/commands/json_arrappend.d.ts +7 -0
  82. package/types/pkg/commands/json_arrindex.d.ts +13 -0
  83. package/types/pkg/commands/json_arrinsert.d.ts +7 -0
  84. package/types/pkg/commands/json_arrlen.d.ts +7 -0
  85. package/types/pkg/commands/json_arrpop.d.ts +7 -0
  86. package/types/pkg/commands/json_arrtrim.d.ts +7 -0
  87. package/types/pkg/commands/json_clear.d.ts +7 -0
  88. package/types/pkg/commands/json_del.d.ts +7 -0
  89. package/types/pkg/commands/json_forget.d.ts +7 -0
  90. package/types/pkg/commands/json_get.d.ts +15 -0
  91. package/types/pkg/commands/json_mget.d.ts +7 -0
  92. package/types/pkg/commands/json_numincrby.d.ts +7 -0
  93. package/types/pkg/commands/json_nummultby.d.ts +7 -0
  94. package/types/pkg/commands/json_objkeys.d.ts +7 -0
  95. package/types/pkg/commands/json_objlen.d.ts +7 -0
  96. package/types/pkg/commands/json_resp.d.ts +7 -0
  97. package/types/pkg/commands/json_set.d.ts +18 -0
  98. package/types/pkg/commands/json_strappend.d.ts +7 -0
  99. package/types/pkg/commands/json_strlen.d.ts +7 -0
  100. package/types/pkg/commands/json_toggle.d.ts +7 -0
  101. package/types/pkg/commands/json_type.d.ts +7 -0
  102. package/types/pkg/commands/lmove.d.ts +12 -0
  103. package/types/pkg/commands/mod.d.ts +25 -0
  104. package/types/pkg/commands/scan.d.ts +1 -1
  105. package/types/pkg/commands/script_flush.d.ts +1 -1
  106. package/types/pkg/commands/set.d.ts +3 -3
  107. package/types/pkg/commands/smembers.d.ts +2 -2
  108. package/types/pkg/commands/smismember.d.ts +7 -0
  109. package/types/pkg/commands/type.d.ts +1 -1
  110. package/types/pkg/commands/zadd.d.ts +3 -3
  111. package/types/pkg/commands/zdiffstore.d.ts +7 -0
  112. package/types/pkg/commands/zinterstore.d.ts +1 -1
  113. package/types/pkg/commands/zrange.d.ts +1 -1
  114. package/types/pkg/commands/zunionstore.d.ts +1 -1
  115. package/types/pkg/http.d.ts +44 -7
  116. package/types/pkg/pipeline.d.ts +252 -126
  117. package/types/pkg/redis.d.ts +137 -12
  118. package/types/pkg/types.d.ts +27 -1
  119. package/types/platforms/cloudflare.d.ts +9 -8
  120. package/types/platforms/fastly.d.ts +3 -7
  121. package/types/platforms/node_with_fetch.d.ts +3 -22
  122. package/types/platforms/nodejs.d.ts +4 -7
  123. package/types/version.d.ts +1 -0
@@ -1,6 +1,8 @@
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";
1
+ import { AppendCommand, BitCountCommand, BitOpCommand, BitPosCommand, DBSizeCommand, DecrByCommand, DecrCommand, DelCommand, EchoCommand, EvalCommand, EvalshaCommand, ExistsCommand, ExpireAtCommand, ExpireCommand, FlushAllCommand, FlushDBCommand, GetBitCommand, GetCommand, GetDelCommand, GetRangeCommand, GetSetCommand, HDelCommand, HExistsCommand, HGetAllCommand, HGetCommand, HIncrByCommand, HIncrByFloatCommand, HKeysCommand, HLenCommand, HMGetCommand, HMSetCommand, HScanCommand, HSetCommand, HSetNXCommand, HStrLenCommand, HValsCommand, IncrByCommand, IncrByFloatCommand, IncrCommand, JsonArrAppendCommand, JsonArrIndexCommand, JsonArrInsertCommand, JsonArrLenCommand, JsonArrPopCommand, JsonArrTrimCommand, JsonClearCommand, JsonDelCommand, JsonForgetCommand, JsonGetCommand, JsonMGetCommand, JsonNumIncrByCommand, JsonNumMultByCommand, JsonObjKeysCommand, JsonObjLenCommand, JsonRespCommand, JsonSetCommand, JsonStrAppendCommand, JsonStrLenCommand, JsonToggleCommand, JsonTypeCommand, KeysCommand, LIndexCommand, LInsertCommand, LLenCommand, LMoveCommand, 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, SMIsMemberCommand, 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 { UpstashError } from "./error.js";
3
3
  import { ZMScoreCommand } from "./commands/zmscore.js";
4
+ import { HRandFieldCommand } from "./commands/hrandfield.js";
5
+ import { ZDiffStoreCommand } from "./commands/zdiffstore.js";
4
6
  /**
5
7
  * Upstash REST API supports command pipelining to send multiple commands in
6
8
  * batch, instead of sending each command one by one and waiting for a response.
@@ -17,7 +19,7 @@ import { ZMScoreCommand } from "./commands/zmscore.js";
17
19
  * **Examples:**
18
20
  *
19
21
  * ```ts
20
- * const p = redis.pipeline()
22
+ * const p = redis.pipeline() // or redis.multi()
21
23
  * p.set("key","value")
22
24
  * p.get("key")
23
25
  * const res = await p.exec()
@@ -29,7 +31,7 @@ import { ZMScoreCommand } from "./commands/zmscore.js";
29
31
  * const res = await p.set("key","value").get("key").exec()
30
32
  * ```
31
33
  *
32
- * It's not possible to infer correct types with a dynamic pipeline, so you can
34
+ * Return types are inferred if all commands are chained, but you can still
33
35
  * override the response type manually:
34
36
  * ```ts
35
37
  * redis.pipeline()
@@ -40,7 +42,7 @@ import { ZMScoreCommand } from "./commands/zmscore.js";
40
42
  * ```
41
43
  */
42
44
  export class Pipeline {
43
- constructor(client, commandOptions) {
45
+ constructor(opts) {
44
46
  Object.defineProperty(this, "client", {
45
47
  enumerable: true,
46
48
  configurable: true,
@@ -59,14 +61,22 @@ export class Pipeline {
59
61
  writable: true,
60
62
  value: void 0
61
63
  });
64
+ Object.defineProperty(this, "multiExec", {
65
+ enumerable: true,
66
+ configurable: true,
67
+ writable: true,
68
+ value: void 0
69
+ });
62
70
  /**
63
71
  * Send the pipeline request to upstash.
64
72
  *
65
73
  * Returns an array with the results of all pipelined commands.
66
74
  *
67
- * You can define a return type manually to make working in typescript easier
75
+ * If all commands are statically chained from start to finish, types are inferred. You can still define a return type manually if necessary though:
68
76
  * ```ts
69
- * redis.pipeline().get("key").exec<[{ greeting: string }]>()
77
+ * const p = redis.pipeline()
78
+ * p.get("key")
79
+ * const result = p.exec<[{ greeting: string }]>()
70
80
  * ```
71
81
  */
72
82
  Object.defineProperty(this, "exec", {
@@ -77,8 +87,9 @@ export class Pipeline {
77
87
  if (this.commands.length === 0) {
78
88
  throw new Error("Pipeline is empty");
79
89
  }
90
+ const path = this.multiExec ? ["multi-exec"] : ["pipeline"];
80
91
  const res = (await this.client.request({
81
- path: ["pipeline"],
92
+ path,
82
93
  body: Object.values(this.commands).map((c) => c.command),
83
94
  }));
84
95
  return res.map(({ error, result }, i) => {
@@ -125,6 +136,15 @@ export class Pipeline {
125
136
  writable: true,
126
137
  value: (...args) => this.chain(new BitPosCommand(args, this.commandOptions))
127
138
  });
139
+ /**
140
+ * @see https://redis.io/commands/zdiffstore
141
+ */
142
+ Object.defineProperty(this, "zdiffstore", {
143
+ enumerable: true,
144
+ configurable: true,
145
+ writable: true,
146
+ value: (...args) => this.chain(new ZDiffStoreCommand(args, this.commandOptions))
147
+ });
128
148
  /**
129
149
  * @see https://redis.io/commands/dbsize
130
150
  */
@@ -251,6 +271,15 @@ export class Pipeline {
251
271
  writable: true,
252
272
  value: (...args) => this.chain(new GetBitCommand(args, this.commandOptions))
253
273
  });
274
+ /**
275
+ * @see https://redis.io/commands/getdel
276
+ */
277
+ Object.defineProperty(this, "getdel", {
278
+ enumerable: true,
279
+ configurable: true,
280
+ writable: true,
281
+ value: (...args) => this.chain(new GetDelCommand(args, this.commandOptions))
282
+ });
254
283
  /**
255
284
  * @see https://redis.io/commands/getrange
256
285
  */
@@ -359,6 +388,15 @@ export class Pipeline {
359
388
  writable: true,
360
389
  value: (key, kv) => this.chain(new HMSetCommand([key, kv], this.commandOptions))
361
390
  });
391
+ /**
392
+ * @see https://redis.io/commands/hrandfield
393
+ */
394
+ Object.defineProperty(this, "hrandfield", {
395
+ enumerable: true,
396
+ configurable: true,
397
+ writable: true,
398
+ value: (key, count, withValues) => this.chain(new HRandFieldCommand([key, count, withValues], this.commandOptions))
399
+ });
362
400
  /**
363
401
  * @see https://redis.io/commands/hscan
364
402
  */
@@ -467,6 +505,15 @@ export class Pipeline {
467
505
  writable: true,
468
506
  value: (...args) => this.chain(new LLenCommand(args, this.commandOptions))
469
507
  });
508
+ /**
509
+ * @see https://redis.io/commands/lmove
510
+ */
511
+ Object.defineProperty(this, "lmove", {
512
+ enumerable: true,
513
+ configurable: true,
514
+ writable: true,
515
+ value: (...args) => this.chain(new LMoveCommand(args, this.commandOptions))
516
+ });
470
517
  /**
471
518
  * @see https://redis.io/commands/lpop
472
519
  */
@@ -836,6 +883,15 @@ export class Pipeline {
836
883
  writable: true,
837
884
  value: (...args) => this.chain(new SMembersCommand(args, this.commandOptions))
838
885
  });
886
+ /**
887
+ * @see https://redis.io/commands/smismember
888
+ */
889
+ Object.defineProperty(this, "smismember", {
890
+ enumerable: true,
891
+ configurable: true,
892
+ writable: true,
893
+ value: (key, members) => this.chain(new SMIsMemberCommand([key, members], this.commandOptions))
894
+ });
839
895
  /**
840
896
  * @see https://redis.io/commands/smove
841
897
  */
@@ -1129,16 +1185,108 @@ export class Pipeline {
1129
1185
  writable: true,
1130
1186
  value: (...args) => this.chain(new ZUnionStoreCommand(args, this.commandOptions))
1131
1187
  });
1132
- this.client = client;
1133
- this.commands = [];
1134
- this.commandOptions = commandOptions;
1188
+ this.client = opts.client;
1189
+ 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
1190
+ this.commandOptions = opts.commandOptions;
1191
+ this.multiExec = opts.multiExec ?? false;
1135
1192
  }
1136
1193
  /**
1137
- * Pushes a command into the pipelien and returns a chainable instance of the
1194
+ * Pushes a command into the pipeline and returns a chainable instance of the
1138
1195
  * pipeline
1139
1196
  */
1140
1197
  chain(command) {
1141
1198
  this.commands.push(command);
1142
- return this;
1199
+ return this; // TS thinks we're returning Pipeline<[]> here, because we're not creating a new instance of the class, hence the cast
1200
+ }
1201
+ /**
1202
+ * @see https://redis.io/commands/?group=json
1203
+ */
1204
+ get json() {
1205
+ return {
1206
+ /**
1207
+ * @see https://redis.io/commands/json.arrappend
1208
+ */
1209
+ arrappend: (...args) => this.chain(new JsonArrAppendCommand(args, this.commandOptions)),
1210
+ /**
1211
+ * @see https://redis.io/commands/json.arrindex
1212
+ */
1213
+ arrindex: (...args) => this.chain(new JsonArrIndexCommand(args, this.commandOptions)),
1214
+ /**
1215
+ * @see https://redis.io/commands/json.arrinsert
1216
+ */
1217
+ arrinsert: (...args) => this.chain(new JsonArrInsertCommand(args, this.commandOptions)),
1218
+ /**
1219
+ * @see https://redis.io/commands/json.arrlen
1220
+ */
1221
+ arrlen: (...args) => this.chain(new JsonArrLenCommand(args, this.commandOptions)),
1222
+ /**
1223
+ * @see https://redis.io/commands/json.arrpop
1224
+ */
1225
+ arrpop: (...args) => this.chain(new JsonArrPopCommand(args, this.commandOptions)),
1226
+ /**
1227
+ * @see https://redis.io/commands/json.arrtrim
1228
+ */
1229
+ arrtrim: (...args) => this.chain(new JsonArrTrimCommand(args, this.commandOptions)),
1230
+ /**
1231
+ * @see https://redis.io/commands/json.clear
1232
+ */
1233
+ clear: (...args) => this.chain(new JsonClearCommand(args, this.commandOptions)),
1234
+ /**
1235
+ * @see https://redis.io/commands/json.del
1236
+ */
1237
+ del: (...args) => this.chain(new JsonDelCommand(args, this.commandOptions)),
1238
+ /**
1239
+ * @see https://redis.io/commands/json.forget
1240
+ */
1241
+ forget: (...args) => this.chain(new JsonForgetCommand(args, this.commandOptions)),
1242
+ /**
1243
+ * @see https://redis.io/commands/json.get
1244
+ */
1245
+ get: (...args) => this.chain(new JsonGetCommand(args, this.commandOptions)),
1246
+ /**
1247
+ * @see https://redis.io/commands/json.mget
1248
+ */
1249
+ mget: (...args) => this.chain(new JsonMGetCommand(args, this.commandOptions)),
1250
+ /**
1251
+ * @see https://redis.io/commands/json.numincrby
1252
+ */
1253
+ numincrby: (...args) => this.chain(new JsonNumIncrByCommand(args, this.commandOptions)),
1254
+ /**
1255
+ * @see https://redis.io/commands/json.nummultby
1256
+ */
1257
+ nummultby: (...args) => this.chain(new JsonNumMultByCommand(args, this.commandOptions)),
1258
+ /**
1259
+ * @see https://redis.io/commands/json.objkeys
1260
+ */
1261
+ objkeys: (...args) => this.chain(new JsonObjKeysCommand(args, this.commandOptions)),
1262
+ /**
1263
+ * @see https://redis.io/commands/json.objlen
1264
+ */
1265
+ objlen: (...args) => this.chain(new JsonObjLenCommand(args, this.commandOptions)),
1266
+ /**
1267
+ * @see https://redis.io/commands/json.resp
1268
+ */
1269
+ resp: (...args) => this.chain(new JsonRespCommand(args, this.commandOptions)),
1270
+ /**
1271
+ * @see https://redis.io/commands/json.set
1272
+ */
1273
+ set: (...args) => this.chain(new JsonSetCommand(args, this.commandOptions)),
1274
+ /**
1275
+ * @see https://redis.io/commands/json.strappend
1276
+ */
1277
+ strappend: (...args) => this.chain(new JsonStrAppendCommand(args, this.commandOptions)),
1278
+ /**
1279
+ * @see https://redis.io/commands/json.strlen
1280
+ */
1281
+ strlen: (...args) => this.chain(new JsonStrLenCommand(args, this.commandOptions)),
1282
+ /**
1283
+ * @see https://redis.io/commands/json.toggle
1284
+ */
1285
+ toggle: (...args) => this.chain(new JsonToggleCommand(args, this.commandOptions)),
1286
+ /**
1287
+ * @see https://redis.io/commands/json.type
1288
+ */
1289
+ type: (...args) => this.chain(new JsonTypeCommand(args, this.commandOptions)),
1290
+ };
1143
1291
  }
1144
1292
  }
package/esm/pkg/redis.js CHANGED
@@ -1,7 +1,8 @@
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";
1
+ import { AppendCommand, BitCountCommand, BitOpCommand, BitPosCommand, DBSizeCommand, DecrByCommand, DecrCommand, DelCommand, EchoCommand, EvalCommand, EvalshaCommand, ExistsCommand, ExpireAtCommand, ExpireCommand, FlushAllCommand, FlushDBCommand, GetBitCommand, GetCommand, GetDelCommand, GetRangeCommand, GetSetCommand, HDelCommand, HExistsCommand, HGetAllCommand, HGetCommand, HIncrByCommand, HIncrByFloatCommand, HKeysCommand, HLenCommand, HMGetCommand, HMSetCommand, HRandFieldCommand, HScanCommand, HSetCommand, HSetNXCommand, HStrLenCommand, HValsCommand, IncrByCommand, IncrByFloatCommand, IncrCommand, JsonArrAppendCommand, JsonArrIndexCommand, JsonArrInsertCommand, JsonArrLenCommand, JsonArrPopCommand, JsonArrTrimCommand, JsonClearCommand, JsonDelCommand, JsonForgetCommand, JsonGetCommand, JsonMGetCommand, JsonNumIncrByCommand, JsonNumMultByCommand, JsonObjKeysCommand, JsonObjLenCommand, JsonRespCommand, JsonSetCommand, JsonStrAppendCommand, JsonStrLenCommand, JsonToggleCommand, JsonTypeCommand, KeysCommand, LIndexCommand, LInsertCommand, LLenCommand, LMoveCommand, 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, SMIsMemberCommand, 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
3
  import { Script } from "./script.js";
4
4
  import { ZMScoreCommand } from "./commands/zmscore.js";
5
+ import { ZDiffStoreCommand } from "./commands/zdiffstore.js";
5
6
  /**
6
7
  * Serverless redis client for upstash.
7
8
  */
@@ -30,6 +31,12 @@ export class Redis {
30
31
  writable: true,
31
32
  value: void 0
32
33
  });
34
+ Object.defineProperty(this, "enableTelemetry", {
35
+ enumerable: true,
36
+ configurable: true,
37
+ writable: true,
38
+ value: void 0
39
+ });
33
40
  /**
34
41
  * Wrap a new middleware around the HTTP client.
35
42
  */
@@ -42,6 +49,27 @@ export class Redis {
42
49
  this.client.request = (req) => middleware(req, makeRequest);
43
50
  }
44
51
  });
52
+ /**
53
+ * Technically this is not private, we can hide it from intellisense by doing this
54
+ */
55
+ Object.defineProperty(this, "addTelemetry", {
56
+ enumerable: true,
57
+ configurable: true,
58
+ writable: true,
59
+ value: (telemetry) => {
60
+ if (!this.enableTelemetry) {
61
+ return;
62
+ }
63
+ try {
64
+ // @ts-ignore - The `Requester` interface does not know about this method but it will be there
65
+ // as long as the user uses the standard HttpClient
66
+ this.client.mergeTelemetry(telemetry);
67
+ }
68
+ catch {
69
+ // ignore
70
+ }
71
+ }
72
+ });
45
73
  /**
46
74
  * Create a new pipeline that allows you to send requests in bulk.
47
75
  *
@@ -51,7 +79,30 @@ export class Redis {
51
79
  enumerable: true,
52
80
  configurable: true,
53
81
  writable: true,
54
- value: () => new Pipeline(this.client, this.opts)
82
+ value: () => new Pipeline({
83
+ client: this.client,
84
+ commandOptions: this.opts,
85
+ multiExec: false,
86
+ })
87
+ });
88
+ /**
89
+ * Create a new transaction to allow executing multiple steps atomically.
90
+ *
91
+ * All the commands in a transaction are serialized and executed sequentially. A request sent by
92
+ * another client will never be served in the middle of the execution of a Redis Transaction. This
93
+ * guarantees that the commands are executed as a single isolated operation.
94
+ *
95
+ * @see {@link Pipeline}
96
+ */
97
+ Object.defineProperty(this, "multi", {
98
+ enumerable: true,
99
+ configurable: true,
100
+ writable: true,
101
+ value: () => new Pipeline({
102
+ client: this.client,
103
+ commandOptions: this.opts,
104
+ multiExec: true,
105
+ })
55
106
  });
56
107
  /**
57
108
  * @see https://redis.io/commands/append
@@ -215,6 +266,15 @@ export class Redis {
215
266
  writable: true,
216
267
  value: (...args) => new GetBitCommand(args, this.opts).exec(this.client)
217
268
  });
269
+ /**
270
+ * @see https://redis.io/commands/getdel
271
+ */
272
+ Object.defineProperty(this, "getdel", {
273
+ enumerable: true,
274
+ configurable: true,
275
+ writable: true,
276
+ value: (...args) => new GetDelCommand(args, this.opts).exec(this.client)
277
+ });
218
278
  /**
219
279
  * @see https://redis.io/commands/getrange
220
280
  */
@@ -323,6 +383,16 @@ export class Redis {
323
383
  writable: true,
324
384
  value: (key, kv) => new HMSetCommand([key, kv], this.opts).exec(this.client)
325
385
  });
386
+ /**
387
+ * @see https://redis.io/commands/hrandfield
388
+ */
389
+ Object.defineProperty(this, "hrandfield", {
390
+ enumerable: true,
391
+ configurable: true,
392
+ writable: true,
393
+ value: (key, count, withValues) => new HRandFieldCommand([key, count, withValues], this.opts)
394
+ .exec(this.client)
395
+ });
326
396
  /**
327
397
  * @see https://redis.io/commands/hscan
328
398
  */
@@ -431,6 +501,15 @@ export class Redis {
431
501
  writable: true,
432
502
  value: (...args) => new LLenCommand(args, this.opts).exec(this.client)
433
503
  });
504
+ /**
505
+ * @see https://redis.io/commands/lmove
506
+ */
507
+ Object.defineProperty(this, "lmove", {
508
+ enumerable: true,
509
+ configurable: true,
510
+ writable: true,
511
+ value: (...args) => new LMoveCommand(args, this.opts).exec(this.client)
512
+ });
434
513
  /**
435
514
  * @see https://redis.io/commands/lpop
436
515
  */
@@ -791,6 +870,15 @@ export class Redis {
791
870
  writable: true,
792
871
  value: (key, member) => new SIsMemberCommand([key, member], this.opts).exec(this.client)
793
872
  });
873
+ /**
874
+ * @see https://redis.io/commands/smismember
875
+ */
876
+ Object.defineProperty(this, "smismember", {
877
+ enumerable: true,
878
+ configurable: true,
879
+ writable: true,
880
+ value: (key, members) => new SMIsMemberCommand([key, members], this.opts).exec(this.client)
881
+ });
794
882
  /**
795
883
  * @see https://redis.io/commands/smembers
796
884
  */
@@ -949,6 +1037,15 @@ export class Redis {
949
1037
  writable: true,
950
1038
  value: (...args) => new ZCountCommand(args, this.opts).exec(this.client)
951
1039
  });
1040
+ /**
1041
+ * @see https://redis.io/commands/zdiffstore
1042
+ */
1043
+ Object.defineProperty(this, "zdiffstore", {
1044
+ enumerable: true,
1045
+ configurable: true,
1046
+ writable: true,
1047
+ value: (...args) => new ZDiffStoreCommand(args, this.opts).exec(this.client)
1048
+ });
952
1049
  /**
953
1050
  * @see https://redis.io/commands/zincrby
954
1051
  */
@@ -1095,6 +1192,95 @@ export class Redis {
1095
1192
  });
1096
1193
  this.client = client;
1097
1194
  this.opts = opts;
1195
+ this.enableTelemetry = opts?.enableTelemetry ?? true;
1196
+ }
1197
+ get json() {
1198
+ return {
1199
+ /**
1200
+ * @see https://redis.io/commands/json.arrappend
1201
+ */
1202
+ arrappend: (...args) => new JsonArrAppendCommand(args, this.opts).exec(this.client),
1203
+ /**
1204
+ * @see https://redis.io/commands/json.arrindex
1205
+ */
1206
+ arrindex: (...args) => new JsonArrIndexCommand(args, this.opts).exec(this.client),
1207
+ /**
1208
+ * @see https://redis.io/commands/json.arrinsert
1209
+ */
1210
+ arrinsert: (...args) => new JsonArrInsertCommand(args, this.opts).exec(this.client),
1211
+ /**
1212
+ * @see https://redis.io/commands/json.arrlen
1213
+ */
1214
+ arrlen: (...args) => new JsonArrLenCommand(args, this.opts).exec(this.client),
1215
+ /**
1216
+ * @see https://redis.io/commands/json.arrpop
1217
+ */
1218
+ arrpop: (...args) => new JsonArrPopCommand(args, this.opts).exec(this.client),
1219
+ /**
1220
+ * @see https://redis.io/commands/json.arrtrim
1221
+ */
1222
+ arrtrim: (...args) => new JsonArrTrimCommand(args, this.opts).exec(this.client),
1223
+ /**
1224
+ * @see https://redis.io/commands/json.clear
1225
+ */
1226
+ clear: (...args) => new JsonClearCommand(args, this.opts).exec(this.client),
1227
+ /**
1228
+ * @see https://redis.io/commands/json.del
1229
+ */
1230
+ del: (...args) => new JsonDelCommand(args, this.opts).exec(this.client),
1231
+ /**
1232
+ * @see https://redis.io/commands/json.forget
1233
+ */
1234
+ forget: (...args) => new JsonForgetCommand(args, this.opts).exec(this.client),
1235
+ /**
1236
+ * @see https://redis.io/commands/json.get
1237
+ */
1238
+ get: (...args) => new JsonGetCommand(args, this.opts).exec(this.client),
1239
+ /**
1240
+ * @see https://redis.io/commands/json.mget
1241
+ */
1242
+ mget: (...args) => new JsonMGetCommand(args, this.opts).exec(this.client),
1243
+ /**
1244
+ * @see https://redis.io/commands/json.numincrby
1245
+ */
1246
+ numincrby: (...args) => new JsonNumIncrByCommand(args, this.opts).exec(this.client),
1247
+ /**
1248
+ * @see https://redis.io/commands/json.nummultby
1249
+ */
1250
+ nummultby: (...args) => new JsonNumMultByCommand(args, this.opts).exec(this.client),
1251
+ /**
1252
+ * @see https://redis.io/commands/json.objkeys
1253
+ */
1254
+ objkeys: (...args) => new JsonObjKeysCommand(args, this.opts).exec(this.client),
1255
+ /**
1256
+ * @see https://redis.io/commands/json.objlen
1257
+ */
1258
+ objlen: (...args) => new JsonObjLenCommand(args, this.opts).exec(this.client),
1259
+ /**
1260
+ * @see https://redis.io/commands/json.resp
1261
+ */
1262
+ resp: (...args) => new JsonRespCommand(args, this.opts).exec(this.client),
1263
+ /**
1264
+ * @see https://redis.io/commands/json.set
1265
+ */
1266
+ set: (...args) => new JsonSetCommand(args, this.opts).exec(this.client),
1267
+ /**
1268
+ * @see https://redis.io/commands/json.strappend
1269
+ */
1270
+ strappend: (...args) => new JsonStrAppendCommand(args, this.opts).exec(this.client),
1271
+ /**
1272
+ * @see https://redis.io/commands/json.strlen
1273
+ */
1274
+ strlen: (...args) => new JsonStrLenCommand(args, this.opts).exec(this.client),
1275
+ /**
1276
+ * @see https://redis.io/commands/json.toggle
1277
+ */
1278
+ toggle: (...args) => new JsonToggleCommand(args, this.opts).exec(this.client),
1279
+ /**
1280
+ * @see https://redis.io/commands/json.type
1281
+ */
1282
+ type: (...args) => new JsonTypeCommand(args, this.opts).exec(this.client),
1283
+ };
1098
1284
  }
1099
1285
  createScript(script) {
1100
1286
  return new Script(this, script);
@@ -1,5 +1,6 @@
1
1
  import * as core from "../pkg/redis.js";
2
2
  import { HttpClient } from "../pkg/http.js";
3
+ import { VERSION } from "../version.js";
3
4
  /**
4
5
  * Serverless redis client for upstash.
5
6
  */
@@ -15,7 +16,7 @@ export class Redis extends core.Redis {
15
16
  * });
16
17
  * ```
17
18
  */
18
- constructor(config) {
19
+ constructor(config, env) {
19
20
  if (config.url.startsWith(" ") ||
20
21
  config.url.endsWith(" ") ||
21
22
  /\r|\n/.test(config.url)) {
@@ -30,10 +31,17 @@ export class Redis extends core.Redis {
30
31
  retry: config.retry,
31
32
  baseUrl: config.url,
32
33
  headers: { authorization: `Bearer ${config.token}` },
34
+ responseEncoding: config.responseEncoding,
33
35
  });
34
36
  super(client, {
37
+ enableTelemetry: !env?.UPSTASH_DISABLE_TELEMETRY,
35
38
  automaticDeserialization: config.automaticDeserialization,
36
39
  });
40
+ // This is only added of the user has not disabled telemetry
41
+ this.addTelemetry({
42
+ platform: "cloudflare",
43
+ sdk: `@upstash/redis@${VERSION}`,
44
+ });
37
45
  }
38
46
  /*
39
47
  * Create a new Upstash Redis instance from environment variables on cloudflare.
@@ -57,6 +65,6 @@ export class Redis extends core.Redis {
57
65
  if (!token) {
58
66
  throw new Error("Unable to find environment variable: `UPSTASH_REDIS_REST_TOKEN`. Please add it via `wrangler secret put UPSTASH_REDIS_REST_TOKEN`");
59
67
  }
60
- return new Redis({ ...opts, url, token });
68
+ return new Redis({ ...opts, url, token }, env);
61
69
  }
62
70
  }
@@ -1,5 +1,6 @@
1
1
  import * as core from "../pkg/redis.js";
2
2
  import { HttpClient } from "../pkg/http.js";
3
+ import { VERSION } from "../version.js";
3
4
  /**
4
5
  * Serverless redis client for upstash.
5
6
  */
@@ -32,9 +33,14 @@ export class Redis extends core.Redis {
32
33
  retry: config.retry,
33
34
  headers: { authorization: `Bearer ${config.token}` },
34
35
  options: { backend: config.backend },
36
+ responseEncoding: config.responseEncoding,
35
37
  });
36
38
  super(client, {
37
39
  automaticDeserialization: config.automaticDeserialization,
38
40
  });
41
+ this.addTelemetry({
42
+ sdk: `@upstash/redis@${VERSION}`,
43
+ platform: "fastly",
44
+ });
39
45
  }
40
46
  }
@@ -1,7 +1,21 @@
1
1
  // deno-lint-ignore-file
2
2
  import * as core from "../pkg/redis.js";
3
3
  import { HttpClient, } from "../pkg/http.js";
4
+ import { VERSION } from "../version.js";
4
5
  import "isomorphic-fetch";
6
+ // @ts-ignore Deno can't compile
7
+ // import https from "https";
8
+ // @ts-ignore Deno can't compile
9
+ // import http from "http";
10
+ // import "isomorphic-fetch";
11
+ /**
12
+ * Workaround for nodejs 14, where atob is not included in the standardlib
13
+ */
14
+ if (typeof atob === "undefined") {
15
+ global.atob = function (b64) {
16
+ return Buffer.from(b64, "base64").toString("utf-8");
17
+ };
18
+ }
5
19
  /**
6
20
  * Serverless redis client for upstash.
7
21
  */
@@ -25,10 +39,21 @@ export class Redis extends core.Redis {
25
39
  baseUrl: configOrRequester.url,
26
40
  retry: configOrRequester.retry,
27
41
  headers: { authorization: `Bearer ${configOrRequester.token}` },
28
- // agent: configOrRequester.agent,
42
+ // agent: configOrRequester.agent,
43
+ responseEncoding: configOrRequester.responseEncoding,
29
44
  });
30
45
  super(client, {
31
46
  automaticDeserialization: configOrRequester.automaticDeserialization,
47
+ enableTelemetry: !process.env.UPSTASH_DISABLE_TELEMETRY,
48
+ });
49
+ this.addTelemetry({
50
+ runtime: `node@${process.version}`,
51
+ platform: process.env.VERCEL
52
+ ? "vercel"
53
+ : process.env.AWS_REGION
54
+ ? "aws"
55
+ : "unknown",
56
+ sdk: `@upstash/redis@${VERSION}`,
32
57
  });
33
58
  }
34
59
  /**