API Generator: Generate better API for Many-to-one-relations with orphanRemoval activated where the reverse side has its own API generated

.changeset/giant-apples-cheer.md

@@ -0,0 +1,8 @@
+---
+"@comet/cms-api": minor
+---
+
+API Generator: Generate better API for Many-to-one-relations with `orphanRemoval` activated where the reverse side has its own API generated
+
+- Add `id` as argument to create mutation
+- Add `id` as argument to list query

demo/admin/src/products/ProductForm.tsx

@@ -104,7 +104,6 @@ function ProductForm({ id }: FormProps): React.ReactElement {
             type: formValues.type as GQLProductType,
             category: formValues.category?.id,
             tags: formValues.tags.map((i) => i.id),
-            variants: [],
             articleNumbers: [],
             discounts: [],
             statistics: { views: 0 },

demo/admin/src/products/ProductsGrid.tsx

@@ -159,10 +159,7 @@ function ProductsGrid() {
                                             type: input.type,
                                             category: input.category?.id,
                                             tags: input.tags.map((tag) => tag.id),
-                                            variants: input.variants.map((variant) => ({
-                                                name: variant.name,
-                                                image: DamImageBlock.state2Output(DamImageBlock.input2State(variant.image)),
-                                            })),
+                                            colors: input.colors,
                                             articleNumbers: input.articleNumbers,
                                             discounts: input.discounts,
                                             statistics: { views: 0 },
@@ -235,9 +232,12 @@ const productsFragment = gql`
             id
             title
         }
-        variants {
-            image
+        colors {
             name
+            hexCode
+        }
+        variants {
+            id
         }
         articleNumbers
         discounts {

demo/admin/src/products/categories/ProductCategoriesTable.tsx

@@ -74,7 +74,12 @@ const columns: GridColDef<GQLProductsCategoriesListFragment>[] = [
                         onPaste={async ({ input, client }) => {
                             await client.mutate<GQLCreateProductCategoryMutation, GQLCreateProductCategoryMutationVariables>({
                                 mutation: createProductMutation,
-                                variables: { input: { ...input, products: [] } },
+                                variables: {
+                                    input: {
+                                        title: input.title,
+                                        slug: input.slug,
+                                    },
+                                },
                             });
                         }}
                         onDelete={async ({ client }) => {

demo/api/schema.gql

@@ -460,6 +460,14 @@ type ProductCategory implements DocumentInterface {
   products: [Product!]!
 }
 
+type ProductColor implements DocumentInterface {
+  id: ID!
+  updatedAt: DateTime!
+  name: String!
+  hexCode: String!
+  createdAt: DateTime!
+}
+
 type ProductStatistics {
   id: ID!
   views: Float!
@@ -481,6 +489,7 @@ type ProductVariant implements DocumentInterface {
   name: String!
   image: DamImageBlockData!
   createdAt: DateTime!
+  product: Product!
 }
 
 type ProductDiscounts {
@@ -514,6 +523,7 @@ type Product implements DocumentInterface {
   createdAt: DateTime!
   category: ProductCategory
   manufacturer: Manufacturer
+  colors: [ProductColor!]!
   variants: [ProductVariant!]!
   tags: [ProductTag!]!
 }
@@ -539,6 +549,11 @@ type PaginatedProductTags {
   totalCount: Int!
 }
 
+type PaginatedProductVariants {
+  nodes: [ProductVariant!]!
+  totalCount: Int!
+}
+
 type RedirectScope {
   domain: String!
 }
@@ -721,6 +736,8 @@ type Query {
   productCategories(offset: Int! = 0, limit: Int! = 25, search: String, filter: ProductCategoryFilter, sort: [ProductCategorySort!]): PaginatedProductCategories!
   productTag(id: ID!): ProductTag!
   productTags(offset: Int! = 0, limit: Int! = 25, search: String, filter: ProductTagFilter, sort: [ProductTagSort!]): PaginatedProductTags!
+  productVariant(id: ID!): ProductVariant!
+  productVariants(offset: Int! = 0, limit: Int! = 25, product: ID!, search: String, filter: ProductVariantFilter, sort: [ProductVariantSort!]): PaginatedProductVariants!
   manufacturer(id: ID!): Manufacturer!
   manufacturers(offset: Int! = 0, limit: Int! = 25, search: String, filter: ManufacturerFilter, sort: [ManufacturerSort!]): PaginatedManufacturers!
 }
@@ -978,6 +995,26 @@ enum ProductTagSortField {
   updatedAt
 }
 
+input ProductVariantFilter {
+  name: StringFilter
+  createdAt: DateFilter
+  updatedAt: DateFilter
+  and: [ProductVariantFilter!]
+  or: [ProductVariantFilter!]
+}
+
+input ProductVariantSort {
+  field: ProductVariantSortField!
+  direction: SortDirection! = ASC
+}
+
+enum ProductVariantSortField {
+  name
+  product
+  createdAt
+  updatedAt
+}
+
 input ManufacturerFilter {
   addressAsEmbeddable_street: StringFilter
   addressAsEmbeddable_streetNumber: NumberFilter
@@ -1065,6 +1102,9 @@ type Mutation {
   createProductTag(input: ProductTagInput!): ProductTag!
   updateProductTag(id: ID!, input: ProductTagUpdateInput!, lastUpdatedAt: DateTime): ProductTag!
   deleteProductTag(id: ID!): Boolean!
+  createProductVariant(product: ID!, input: ProductVariantInput!): ProductVariant!
+  updateProductVariant(id: ID!, input: ProductVariantUpdateInput!, lastUpdatedAt: DateTime): ProductVariant!
+  deleteProductVariant(id: ID!): Boolean!
   createManufacturer(input: ManufacturerInput!): Manufacturer!
   updateManufacturer(id: ID!, input: ManufacturerUpdateInput!, lastUpdatedAt: DateTime): Manufacturer!
   deleteManufacturer(id: ID!): Boolean!
@@ -1256,7 +1296,7 @@ input ProductInput {
   articleNumbers: [String!]! = []
   dimensions: ProductDimensionsInput
   statistics: ProductStatisticsInput
-  variants: [ProductVariantInput!]! = []
+  colors: [ProductColorInput!]! = []
   category: ID = null
   tags: [ID!]! = []
   manufacturer: ID
@@ -1266,9 +1306,9 @@ input ProductStatisticsInput {
   views: Float!
 }
 
-input ProductVariantInput {
+input ProductColorInput {
   name: String!
-  image: DamImageBlockInput!
+  hexCode: String!
 }
 
 input ProductUpdateInput {
@@ -1284,7 +1324,7 @@ input ProductUpdateInput {
   articleNumbers: [String!]
   dimensions: ProductDimensionsInput
   statistics: ProductStatisticsInput
-  variants: [ProductVariantInput!]
+  colors: [ProductColorInput!]
   category: ID
   tags: [ID!]
   manufacturer: ID
@@ -1293,13 +1333,11 @@ input ProductUpdateInput {
 input ProductCategoryInput {
   title: String!
   slug: String!
-  products: [ID!]! = []
 }
 
 input ProductCategoryUpdateInput {
   title: String
   slug: String
-  products: [ID!]
 }
 
 input ProductTagInput {
@@ -1312,6 +1350,16 @@ input ProductTagUpdateInput {
   products: [ID!]
 }
 
+input ProductVariantInput {
+  name: String!
+  image: DamImageBlockInput!
+}
+
+input ProductVariantUpdateInput {
+  name: String
+  image: DamImageBlockInput
+}
+
 input ManufacturerInput {
   address: AddressInput
   addressAsEmbeddable: AddressAsEmbeddableInput!

demo/api/src/db/migrations/Migration20231204165948.ts

@@ -0,0 +1,15 @@
+import { Migration } from '@mikro-orm/migrations';
+
+export class Migration20231204165948 extends Migration {
+
+  async up(): Promise<void> {
+    this.addSql('create table "ProductColor" ("id" uuid not null, "name" varchar(255) not null, "hexCode" varchar(255) not null, "product" uuid not null, "createdAt" timestamptz(0) not null, "updatedAt" timestamptz(0) not null, constraint "ProductColor_pkey" primary key ("id"));');
+
+    this.addSql('alter table "ProductColor" add constraint "ProductColor_product_foreign" foreign key ("product") references "Product" ("id") on update cascade;');
+  }
+
+  async down(): Promise<void> {
+    this.addSql('drop table if exists "ProductColor" cascade;');
+  }
+
+}

demo/api/src/products/entities/product-category.entity.ts

@@ -30,7 +30,7 @@ export class ProductCategory extends BaseEntity<ProductCategory, "id"> implement
         //search: true, //not implemented
         //filter: true, //not implemented
         //sort: true, //not implemented
-        input: true, //default is true
+        input: false, //default is true
     })
     @OneToMany(() => Product, (products) => products.category)
     products = new Collection<Product>(this);

demo/api/src/products/entities/product-color.entity.ts

@@ -0,0 +1,44 @@
+import { CrudField, DocumentInterface } from "@comet/cms-api";
+import { BaseEntity, Entity, ManyToOne, OptionalProps, PrimaryKey, Property, Ref } from "@mikro-orm/core";
+import { Field, ID, ObjectType } from "@nestjs/graphql";
+import { v4 as uuid } from "uuid";
+
+import { Product } from "./product.entity";
+
+@ObjectType({
+    implements: () => [DocumentInterface],
+})
+@Entity()
+export class ProductColor extends BaseEntity<ProductColor, "id"> implements DocumentInterface {
+    [OptionalProps]?: "createdAt" | "updatedAt";
+
+    @PrimaryKey({ type: "uuid" })
+    @Field(() => ID)
+    id: string = uuid();
+
+    @Property()
+    @Field()
+    name: string;
+
+    @Property()
+    @Field()
+    hexCode: string;
+
+    @ManyToOne(() => Product, { ref: true })
+    @CrudField({
+        resolveField: true, // default is true
+        // search: true, // not yet supported for nested
+        // filter: true, // not yet supported for nested
+        // sort: true, // not yet supported for nested
+        // input: true, // not supported for nested, doesn't make sense
+    })
+    product: Ref<Product>;
+
+    @Property()
+    @Field()
+    createdAt: Date = new Date();
+
+    @Property({ onUpdate: () => new Date() })
+    @Field()
+    updatedAt: Date = new Date();
+}

demo/api/src/products/entities/product-variant.entity.ts

@@ -1,5 +1,5 @@
 import { BlockDataInterface, RootBlock, RootBlockEntity } from "@comet/blocks-api";
-import { CrudField, DamImageBlock, DocumentInterface, RootBlockDataScalar, RootBlockType } from "@comet/cms-api";
+import { CrudField, CrudGenerator, DamImageBlock, DocumentInterface, RootBlockDataScalar, RootBlockType } from "@comet/cms-api";
 import { BaseEntity, Entity, ManyToOne, OptionalProps, PrimaryKey, Property, Ref } from "@mikro-orm/core";
 import { Field, ID, ObjectType } from "@nestjs/graphql";
 import { v4 as uuid } from "uuid";
@@ -11,6 +11,7 @@ import { Product } from "./product.entity";
 })
 @Entity()
 @RootBlockEntity()
+@CrudGenerator({ targetDirectory: `${__dirname}/../generated/`, requiredPermission: "products" })
 export class ProductVariant extends BaseEntity<ProductVariant, "id"> implements DocumentInterface {
     [OptionalProps]?: "createdAt" | "updatedAt";
 
@@ -33,7 +34,7 @@ export class ProductVariant extends BaseEntity<ProductVariant, "id"> implements
         // search: true, // not yet supported for nested
         // filter: true, // not yet supported for nested
         // sort: true, // not yet supported for nested
-        // input: true, // not supported for nested, doesn't make sense
+        input: false, // default is true, but usually not needed if it's a rootArg
     })
     product: Ref<Product>;
 

demo/api/src/products/entities/product.entity.ts

@@ -21,6 +21,7 @@ import { IsNumber } from "class-validator";
 import { v4 as uuid } from "uuid";
 
 import { ProductCategory } from "./product-category.entity";
+import { ProductColor } from "./product-color.entity";
 import { ProductStatistics } from "./product-statistics.entity";
 import { ProductTag } from "./product-tag.entity";
 import { ProductType } from "./product-type.enum";
@@ -134,14 +135,24 @@ export class Product extends BaseEntity<Product, "id"> implements DocumentInterf
     @Field(() => ProductStatistics, { nullable: true })
     statistics?: Ref<ProductStatistics> = undefined;
 
-    @OneToMany(() => ProductVariant, (variant) => variant.product, { orphanRemoval: true })
+    @OneToMany(() => ProductColor, (variant) => variant.product, { orphanRemoval: true })
     @CrudField({
         resolveField: true, //default is true
         //search: true, //not yet implemented
         //filter: true, //not yet implemented
         //sort: true, //not yet implemented
         input: true, //default is true
     })
+    colors = new Collection<ProductColor>(this);
+
+    @OneToMany(() => ProductVariant, (variant) => variant.product, { orphanRemoval: true })
+    @CrudField({
+        resolveField: true, //default is true
+        //search: true, //not yet implemented
+        //filter: true, //not yet implemented
+        //sort: true, //not yet implemented
+        input: false, //default is true, disabled here because it is edited using it's own crud api
+    })
     variants = new Collection<ProductVariant>(this);
 
     @ManyToOne(() => ProductCategory, { nullable: true, ref: true })

demo/api/src/products/generated/dto/paginated-product-variants.ts

@@ -0,0 +1,9 @@
+// This file has been generated by comet api-generator.
+// You may choose to use this file as scaffold by moving this file out of generated folder and removing this comment.
+import { PaginatedResponseFactory } from "@comet/cms-api";
+import { ObjectType } from "@nestjs/graphql";
+
+import { ProductVariant } from "../../entities/product-variant.entity";
+
+@ObjectType()
+export class PaginatedProductVariants extends PaginatedResponseFactory.create(ProductVariant) {}

demo/api/src/products/generated/dto/product-category.input.ts

@@ -1,8 +1,8 @@
 // This file has been generated by comet api-generator.
 // You may choose to use this file as scaffold by moving this file out of generated folder and removing this comment.
 import { IsSlug, PartialType } from "@comet/cms-api";
-import { Field, ID, InputType } from "@nestjs/graphql";
-import { IsArray, IsNotEmpty, IsString, IsUUID } from "class-validator";
+import { Field, InputType } from "@nestjs/graphql";
+import { IsNotEmpty, IsString } from "class-validator";
 
 @InputType()
 export class ProductCategoryInput {
@@ -16,11 +16,6 @@ export class ProductCategoryInput {
     @IsSlug()
     @Field()
     slug: string;
-
-    @Field(() => [ID], { defaultValue: [] })
-    @IsArray()
-    @IsUUID(undefined, { each: true })
-    products: string[];
 }
 
 @InputType()

demo/api/src/products/generated/dto/product-color.nested.input.ts

@@ -0,0 +1,17 @@
+// This file has been generated by comet api-generator.
+// You may choose to use this file as scaffold by moving this file out of generated folder and removing this comment.
+import { Field, InputType } from "@nestjs/graphql";
+import { IsNotEmpty, IsString } from "class-validator";
+
+@InputType()
+export class ProductColorInput {
+    @IsNotEmpty()
+    @IsString()
+    @Field()
+    name: string;
+
+    @IsNotEmpty()
+    @IsString()
+    @Field()
+    hexCode: string;
+}