Merge pull request #1470 from vivid-planet/apigen-arraytype

CRUD Generator: Add support for `ArrayType` fields in generated input

.changeset/old-toes-prove.md

@@ -0,0 +1,5 @@
+---
+"@comet/cms-api": minor
+---
+
+CRUD Generator: Add support for `ArrayType` fields in generated input

packages/api/cms-api/src/generator/generate-crud-input-array.spec.ts

@@ -0,0 +1,70 @@
+import { ArrayType, BaseEntity, Entity, MikroORM, PrimaryKey, Property } from "@mikro-orm/core";
+import { Field } from "@nestjs/graphql";
+import { LazyMetadataStorage } from "@nestjs/graphql/dist/schema-builder/storages/lazy-metadata.storage";
+import { v4 as uuid } from "uuid";
+
+import { generateCrudInput } from "./generate-crud-input";
+import { lintSource, parseSource } from "./utils/test-helper";
+
+@Entity()
+export class TestEntityArrayString extends BaseEntity<TestEntityArrayString, "id"> {
+    @PrimaryKey({ type: "uuid" })
+    id: string = uuid();
+
+    @Property({ columnType: "json" })
+    @Field(() => [String])
+    test1: string[];
+
+    @Property()
+    @Field(() => [String])
+    test2: string[];
+
+    @Property({ type: "array" })
+    @Field(() => [String])
+    test3: string[];
+
+    @Property({ type: ArrayType })
+    @Field(() => [String])
+    test4: string[];
+
+    @Property({ type: "json" })
+    @Field(() => [String])
+    test5: string[];
+}
+
+describe("GenerateCrudInputArray", () => {
+    it("should support all string array variants", async () => {
+        LazyMetadataStorage.load();
+        const orm = await MikroORM.init({
+            type: "postgresql",
+            dbName: "test-db",
+            entities: [TestEntityArrayString],
+        });
+
+        const out = await generateCrudInput({ targetDirectory: __dirname }, orm.em.getMetadata().get("TestEntityArrayString"));
+        const lintedOutput = await lintSource(out[0].content);
+        const source = parseSource(lintedOutput);
+
+        const classes = source.getClasses();
+        expect(classes.length).toBe(2);
+
+        {
+            const cls = classes[0];
+            const structure = cls.getStructure();
+
+            expect(structure.properties?.length).toBe(5);
+            expect(structure.properties?.[0].name).toBe("test1");
+            expect(structure.properties?.[0].type).toBe("string[]");
+            expect(structure.properties?.[1].name).toBe("test2");
+            expect(structure.properties?.[1].type).toBe("string[]");
+            expect(structure.properties?.[2].name).toBe("test3");
+            expect(structure.properties?.[2].type).toBe("string[]");
+            expect(structure.properties?.[3].name).toBe("test4");
+            expect(structure.properties?.[3].type).toBe("string[]");
+            expect(structure.properties?.[4].name).toBe("test5");
+            expect(structure.properties?.[4].type).toBe("string[]");
+        }
+
+        orm.close();
+    });
+});

packages/api/cms-api/src/generator/generate-crud-input.ts

@@ -239,7 +239,7 @@ export async function generateCrudInput(
             decorators.push(`@Type(() => ${inputName})`);
             decorators.push("@ValidateNested()");
             type = `${inputName}`;
-        } else if (prop.type == "JsonType" || prop.embeddable) {
+        } else if (prop.type == "JsonType" || prop.embeddable || prop.type == "ArrayType") {
             const tsProp = morphTsProperty(prop.name, metadata);
 
             let tsType = tsProp.getType();