fix(spop): include string[] in return type (#231)

* fix(spop): include string[] in return type

* _doesn't_

Author: mmkal

README.md

@@ -113,6 +113,10 @@ Note: `multi` results are strongly-typed only when using typescript 4.0 and abov
 
 The client no longer has an `execMulti` function. Use the `.exec()` method on the multi instance.
 
+## Wrong types? Raise an issue!
+
+Since the types are autogenerated from [redis-doc](https://github.com/redis/redis-doc), which doesn't adhere to a formal schema, they might be incomplete, or in some cases, wrong. The errors are easy enough to fix, but not easy to find, so if you think you've come across a case like this, please [raise an issue](https://github.com/mmkal/handy-redis/issues).
+
 ___
 
 ## Development

codegen/patches/schema.ts

@@ -7,6 +7,7 @@ export const fixupSchema = (schema: Record<string, JsonSchemaCommand>) => {
 
     fixSetEnum(clone);
     fixArrayRepliesManually(clone);
+    fixBulkStringRepliesManually(clone);
 
     return clone;
 };
@@ -40,6 +41,9 @@ function fixSetEnum(schema: Record<string, JsonSchemaCommand>) {
  * types to a few of the @array-reply commands, which often end up as `unknown`.
  */
 function fixArrayRepliesManually(schema: Record<string, JsonSchemaCommand>) {
+    /**
+     * Dictionary of manual "array" schemas. Will likely be added/edited to over time.
+     */
     const manuallyFixedUp: Record<string, jsonSchema.JSONSchema7 & { type: "array" }> = {
         GEOHASH: { type: "array", items: { type: "string" } },
         KEYS: { type: "array", items: { type: "string" } },
@@ -70,3 +74,19 @@ function fixArrayRepliesManually(schema: Record<string, JsonSchemaCommand>) {
         }
     });
 }
+
+function fixBulkStringRepliesManually(schema: Record<string, JsonSchemaCommand>) {
+    /**
+     * Catch-all bucket for patches to the generated schema. A lot of commands specify their return type
+     * as `@bulk-string-reply` so a few fixes for those might end up here.
+     */
+    const manuallyFixedUp: Record<string, jsonSchema.JSONSchema7> = {
+        SPOP: { anyOf: [{ type: "null" }, { type: "string" }, { type: "array", items: { type: "string" } }] },
+    };
+
+    Object.entries(schema).forEach(([name, command]) => {
+        if (name in manuallyFixedUp) {
+            command.return = manuallyFixedUp[name] || command.return;
+        }
+    });
+}

codegen/schema.json

@@ -4853,11 +4853,17 @@
         "group": "set",
         "return": {
             "anyOf": [
+                {
+                    "type": "null"
+                },
                 {
                     "type": "string"
                 },
                 {
-                    "type": "null"
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
                 }
             ]
         }

src/generated/interface.ts

@@ -6547,7 +6547,7 @@ export interface Commands {
      *
      * [Full docs](https://redis.io/commands/spop)
      */
-    spop(key: string, count?: number): Promise<string | null>;
+    spop(key: string, count?: number): Promise<null | string | Array<string>>;
 
     /**
      * Get one or multiple random members from a set

test/types.test.ts

@@ -27,4 +27,6 @@ test("client has promisified redis methods", () => {
     expectTypeOf(client.quit).returns.resolves.toBeString();
 
     expectTypeOf(client.end).returns.toEqualTypeOf<void>();
+
+    expectTypeOf(client.spop).returns.resolves.toEqualTypeOf<null | string | string[]>();
 });