test: add test for generating Reply interface

Author: thomasthiebaud

src/index.spec.ts

@@ -0,0 +1,71 @@
+import { generateReplyInterfaces } from ".";
+
+describe("#generateReplyInterfaces", () => {
+  it("should generate the reply interface with an empty schema", async () => {
+    expect(await generateReplyInterfaces("")).toEqual("type Reply = {}");
+    expect(await generateReplyInterfaces("XXX")).toEqual("type XXXReply = {}");
+  });
+
+  it("should generate the reply interface with a single schema", async () => {
+    const schema = {
+      "2xx": {
+        additionalProperties: false,
+        properties: {
+          guid: {
+            type: "string",
+          },
+        },
+        type: "object",
+      },
+    };
+    const genertatedInterface = `\
+export interface Reply2XX {
+  guid?: string;
+}
+
+type Reply = Reply2XX\
+`;
+
+    expect(await generateReplyInterfaces("", schema)).toEqual(
+      genertatedInterface
+    );
+  });
+
+  it("should generate the reply interface with a multiple schema", async () => {
+    const schema = {
+      "2xx": {
+        additionalProperties: false,
+        properties: {
+          guid: {
+            type: "string",
+          },
+        },
+        type: "object",
+      },
+      "4xx": {
+        additionalProperties: false,
+        properties: {
+          status: {
+            type: "number",
+          },
+        },
+        type: "object",
+      },
+    };
+    const genertatedInterface = `\
+export interface Reply2XX {
+  guid?: string;
+}
+
+export interface Reply4XX {
+  status?: number;
+}
+
+type Reply = Reply2XX | Reply4XX\
+`;
+
+    expect(await generateReplyInterfaces("", schema)).toEqual(
+      genertatedInterface
+    );
+  });
+});

src/index.ts

@@ -6,10 +6,13 @@ import { compile } from "json-schema-to-typescript";
 const opts = { bannerComment: "" };
 const defaultSchema = { type: "object", additionalProperties: false };
 
-async function generateReplyInterfaces(prefix: string, replies = {}) {
+export async function generateReplyInterfaces(
+  prefix: string,
+  replies: Record<any, any> = {}
+) {
   const generatedInterfaces = [];
   const generatedReplyNames = [];
-  for (const [replyCode, replySchema] of Object.entries<any>(replies)) {
+  for (const [replyCode, replySchema] of Object.entries(replies)) {
     generatedReplyNames.push(prefix + "Reply" + replyCode.toUpperCase());
     generatedInterfaces.push(
       await compile(
@@ -22,9 +25,8 @@ async function generateReplyInterfaces(prefix: string, replies = {}) {
 
   return `
 ${generatedInterfaces.join("\n")}
-
-type ${prefix}Reply = ${generatedReplyNames.join(" | ")}
-`;
+type ${prefix}Reply = ${generatedReplyNames.join(" | ") || "{}"}
+`.trim();
 }
 
 async function writeFile(