feat: add command typings for Redis 7.0.2. Also fix a typing issue for hgetallBuffer. (#1611)

Author: luin

bin/index.js

@@ -1,9 +1,18 @@
 const returnTypes = require("./returnTypes");
 const argumentTypes = require("./argumentTypes");
+const sortArguments = require("./sortArguments");
 const typeMaps = require("./typeMaps");
 const overrides = require("./overrides");
 const { getCommanderInterface } = require("@ioredis/interface-generator");
 
+const HEADER = `/**
+ * This file is generated by @ioredis/interface-generator.
+ * Don't edit it manually. Instead, run \`npm run generate\` to update
+ * this file.
+ */
+
+`;
+
 const ignoredCommands = ["monitor", "multi"];
 const commands = require("@ioredis/commands")
   .list.filter((name) => !ignoredCommands.includes(name))
@@ -24,6 +33,7 @@ async function main() {
     overrides,
     returnTypes,
     argumentTypes,
+    sortArguments,
     typeMaps: typeMaps,
     ignoredBufferVariant: [
       "incrbyfloat",
@@ -39,7 +49,7 @@ async function main() {
 
   fs.writeFileSync(
     path.join(__dirname, "..", "lib/utils/RedisCommander.ts"),
-    template.replace("////", () => interface)
+    HEADER + template.replace("////", () => interface)
   );
 }
 

bin/overrides.js

@@ -11,7 +11,7 @@ module.exports = {
     overwrite: true,
     defs: [
       "$1(key: RedisKey, callback?: Callback<Record<string, string>>): Result<Record<string, string>, Context>",
-      "$1Buffer(key: RedisKey, callback?: Callback<[field: Buffer, value: Buffer][]>): Result<[field: Buffer, value: Buffer][], Context>",
+      "$1Buffer(key: RedisKey, callback?: Callback<Record<string, Buffer>>): Result<Record<string, Buffer>, Context>",
     ],
   },
   mset: msetOverrides,

bin/sortArguments.js

@@ -0,0 +1,17 @@
+module.exports = {
+  set: (args) => {
+    const sorted = args.sort((a, b) => {
+      const order = ["key", "value", "expiration", "condition", "get"];
+      const indexA = order.indexOf(a.name);
+      const indexB = order.indexOf(b.name);
+      if (indexA === -1) {
+        throw new Error('Invalid argument name: "' + a.name + '"');
+      }
+      if (indexB === -1) {
+        throw new Error('Invalid argument name: "' + b.name + '"');
+      }
+      return indexA - indexB;
+    });
+    return sorted;
+  },
+};

bin/template.ts

@@ -11,7 +11,8 @@ export interface ResultTypes<Result, Context> {
   pipeline: ChainableCommander;
 }
 
-export interface ChainableCommander extends RedisCommander<{ type: "pipeline" }> {
+export interface ChainableCommander
+  extends RedisCommander<{ type: "pipeline" }> {
   length: number;
 }