fix: tuples type generation support (#1011) (#1082)

openapi-ts · Apr 25, 2023 · c2c186e · c2c186e
1 parent aa963bb
commit c2c186e
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 4 deletions.
diff --git a/src/transform/schema-object.ts b/src/transform/schema-object.ts
@@ -126,9 +126,19 @@ export function defaultSchemaObjectTransform(
     // "type": "array"
     if (schemaObject.type === "array") {
       indentLv++;
-      let itemType = schemaObject.items
-        ? transformSchemaObject(schemaObject.items, { path, ctx: { ...ctx, indentLv } })
-        : "unknown";
+      let itemType = "unknown";
+      if (schemaObject.items) {
+        if (Array.isArray(schemaObject.items)) {
+          // tuple type support
+          const result: string[] = [];
+          schemaObject.items.forEach((item) => {
+            result.push(transformSchemaObject(item, { path, ctx: { ...ctx, indentLv } }));
+          });
+          itemType = `[${result.join(",")}]`;
+        } else {
+          itemType = transformSchemaObject(schemaObject.items, { path, ctx: { ...ctx, indentLv } });
+        }
+      }
       const minItems: number =
         typeof schemaObject.minItems === "number" && schemaObject.minItems >= 0 ? schemaObject.minItems : 0;
       const maxItems: number | undefined =

diff --git a/src/types.ts b/src/types.ts
@@ -439,7 +439,7 @@ export type SchemaObject = {
   | {
       type: "array";
       prefixItems?: SchemaObject | ReferenceObject;
-      items?: SchemaObject | ReferenceObject;
+      items?: SchemaObject | ReferenceObject | (SchemaObject | ReferenceObject)[];
       minItems?: number;
       maxItems?: number;
     }

diff --git a/test/schema-object.test.ts b/test/schema-object.test.ts
@@ -109,6 +109,12 @@ describe("Schema Object", () => {
         expect(generated).toBe("(string)[]");
       });
 
+      test("tuple array", () => {
+        const schema: SchemaObject = { type: "array", items: [{ type: "string" },{"type": "number"}],minItems:2,maxItems:2 };
+        const generated = transformSchemaObject(schema, options);
+        expect(generated).toBe("([string,number])[]");
+      });
+
       test("ref", () => {
         const schema: SchemaObject = { type: "array", items: { $ref: 'components["schemas"]["ArrayItem"]' } };
         const generated = transformSchemaObject(schema, options);