@rytass/bpm-core-nestjs-module 0.4.0 → 0.5.0

package/src/lib/form/form-definition-version.entity.ts

@@ -0,0 +1,66 @@
+import { FormDefinitionSchema, FormUiSchema } from '@rytass/bpm-core-shared/form';
+import { Field, ID, Int, ObjectType } from '@nestjs/graphql';
+import {
+  Column,
+  CreateDateColumn,
+  Entity,
+  PrimaryGeneratedColumn,
+  UpdateDateColumn,
+} from 'typeorm';
+import { FormDefinitionVersionStatusEnum } from './form.enums';
+
+@Entity('form_definition_versions')
+@ObjectType('FormDefinitionVersion')
+export class FormDefinitionVersionEntity {
+  @PrimaryGeneratedColumn('uuid')
+  @Field(() => ID)
+  id!: string;
+
+  @Column('uuid', { name: 'form_definition_id' })
+  @Field(() => ID)
+  formDefinitionId!: string;
+
+  @Column('int')
+  @Field(() => Int)
+  version!: number;
+
+  @Column('text')
+  @Field(() => FormDefinitionVersionStatusEnum)
+  status!: FormDefinitionVersionStatusEnum;
+
+  @Column('jsonb')
+  schema!: FormDefinitionSchema;
+
+  @Column('jsonb', { name: 'ui_schema' })
+  uiSchema!: FormUiSchema;
+
+  @Column('timestamptz', { name: 'published_at', nullable: true })
+  @Field(() => Date, { nullable: true })
+  publishedAt!: Date | null;
+
+  @Column('text', { name: 'published_by_member_id', nullable: true })
+  @Field(() => String, { nullable: true })
+  publishedByMemberId!: string | null;
+
+  @Column('timestamptz', { name: 'archived_at', nullable: true })
+  @Field(() => Date, { nullable: true })
+  archivedAt!: Date | null;
+
+  @CreateDateColumn({ name: 'created_at', type: 'timestamptz' })
+  @Field()
+  createdAt!: Date;
+
+  @UpdateDateColumn({ name: 'updated_at', type: 'timestamptz' })
+  @Field()
+  updatedAt!: Date;
+
+  @Field(() => String)
+  get schemaJson(): string {
+    return JSON.stringify(this.schema);
+  }
+
+  @Field(() => String)
+  get uiSchemaJson(): string {
+    return JSON.stringify(this.uiSchema);
+  }
+}

package/src/lib/form/form-definition.entity.ts

@@ -0,0 +1,54 @@
+import { Field, ID, Int, ObjectType } from '@nestjs/graphql';
+import {
+  Column,
+  CreateDateColumn,
+  DeleteDateColumn,
+  Entity,
+  PrimaryGeneratedColumn,
+  UpdateDateColumn,
+} from 'typeorm';
+
+@Entity('form_definitions')
+@ObjectType('FormDefinition')
+export class FormDefinitionEntity {
+  @PrimaryGeneratedColumn('uuid')
+  @Field(() => ID)
+  id!: string;
+
+  @Column('text')
+  @Field()
+  name!: string;
+
+  @Column('text', { nullable: true })
+  @Field(() => String, { nullable: true })
+  description!: string | null;
+
+  @Column('uuid', { name: 'current_version_id', nullable: true })
+  @Field(() => ID, { nullable: true })
+  currentVersionId!: string | null;
+
+  @Field(() => Int, { nullable: true })
+  currentVersionNumber?: number | null;
+
+  @Field(() => Date, { nullable: true })
+  currentVersionCreatedAt?: Date | null;
+
+  @Field(() => Date, { nullable: true })
+  currentVersionPublishedAt?: Date | null;
+
+  @DeleteDateColumn({ name: 'deleted_at', type: 'timestamptz' })
+  @Field(() => Date, { nullable: true })
+  deletedAt!: Date | null;
+
+  @CreateDateColumn({ name: 'created_at', type: 'timestamptz' })
+  @Field()
+  createdAt!: Date;
+
+  @UpdateDateColumn({ name: 'updated_at', type: 'timestamptz' })
+  @Field()
+  updatedAt!: Date;
+
+  @Column('text', { name: 'created_by_member_id', nullable: true })
+  @Field(() => String, { nullable: true })
+  createdByMemberId!: string | null;
+}

package/src/lib/form/form-schema-lint.object.ts

@@ -0,0 +1,10 @@
+import { Field, ObjectType } from '@nestjs/graphql';
+
+@ObjectType('FormSchemaLintResult')
+export class FormSchemaLintResultObject {
+  @Field()
+  valid!: boolean;
+
+  @Field(() => [String])
+  errors!: readonly string[];
+}

package/src/lib/form/form-schema.validator.spec.ts

@@ -0,0 +1,180 @@
+import { lintFormSchemaJson } from './form-schema.validator';
+
+describe('form schema validator', () => {
+  it('accepts supported fields and matching layout entries', (): void => {
+    const result = lintFormSchemaJson(
+      JSON.stringify({
+        fields: [
+          {
+            defaultValue: 'A-001',
+            fieldKey: 'amount',
+            label: 'Amount',
+            maxLength: 20,
+            minLength: 1,
+            placeholder: 'Enter amount',
+            required: true,
+            type: 'text',
+            visibleWhen: "form.kind == 'general'",
+          },
+          {
+            defaultValue: 100,
+            fieldKey: 'total',
+            label: 'Total',
+            maximum: 1000,
+            minimum: 0,
+            required: false,
+            type: 'money',
+          },
+          {
+            defaultValue: true,
+            fieldKey: 'enabled',
+            label: 'Enabled',
+            required: false,
+            type: 'boolean',
+          },
+          {
+            acceptedMimeTypes: ['application/pdf'],
+            defaultValue: ['attachment-id'],
+            fieldKey: 'receipt',
+            label: 'Receipt',
+            maxFiles: 3,
+            required: false,
+            type: 'file_upload',
+          },
+          {
+            fieldKey: 'kind',
+            label: 'Kind',
+            options: [{ label: 'General', value: 'general' }],
+            required: false,
+            type: 'select',
+          },
+        ],
+        schemaVersion: 1,
+      }),
+      JSON.stringify({
+        layout: [
+          { fieldKey: 'amount', width: 'HALF' },
+          { fieldKey: 'total', width: 'HALF' },
+          { fieldKey: 'enabled', width: 'HALF' },
+          { fieldKey: 'receipt', width: 'FULL' },
+          { fieldKey: 'kind', width: 'HALF' },
+        ],
+        schemaVersion: 1,
+      }),
+    );
+
+    expect(result).toEqual({ errors: [], valid: true });
+  });
+
+  it('rejects duplicated field keys and stale layout references', (): void => {
+    const result = lintFormSchemaJson(
+      JSON.stringify({
+        fields: [
+          {
+            fieldKey: 'amount',
+            label: 'Amount',
+            required: true,
+            type: 'text',
+          },
+          {
+            fieldKey: 'amount',
+            label: 'Amount 2',
+            required: false,
+            type: 'textarea',
+          },
+        ],
+        schemaVersion: 1,
+      }),
+      JSON.stringify({
+        layout: [{ fieldKey: 'missing', width: 'FULL' }],
+        schemaVersion: 1,
+      }),
+    );
+
+    expect(result.valid).toBe(false);
+    expect(result.errors).toContain('schema.fields fieldKey is duplicated: amount');
+    expect(result.errors).toContain(
+      'uiSchema.layout[0].fieldKey does not match a schema field',
+    );
+  });
+
+  it('rejects invalid type-specific field settings', (): void => {
+    const result = lintFormSchemaJson(
+      JSON.stringify({
+        fields: [
+          {
+            defaultValue: 12,
+            fieldKey: 'title',
+            label: 'Title',
+            maxLength: 1,
+            minLength: 10,
+            placeholder: 123,
+            required: true,
+            type: 'text',
+          },
+          {
+            defaultValue: '100',
+            fieldKey: 'amount',
+            label: 'Amount',
+            maximum: 1,
+            minimum: 10,
+            required: true,
+            type: 'number',
+          },
+          {
+            fieldKey: 'kind',
+            label: 'Kind',
+            options: [
+              { label: 'General', value: 'general' },
+              { label: 'General copy', value: 'general' },
+            ],
+            required: false,
+            type: 'select',
+          },
+          {
+            acceptedMimeTypes: [''],
+            fieldKey: 'receipt',
+            label: 'Receipt',
+            maxFiles: 0,
+            required: false,
+            type: 'file_upload',
+          },
+        ],
+        schemaVersion: 1,
+      }),
+      JSON.stringify({
+        layout: [
+          { fieldKey: 'title', width: 'HALF' },
+          { fieldKey: 'amount', width: 'HALF' },
+          { fieldKey: 'kind', width: 'HALF' },
+          { fieldKey: 'receipt', width: 'FULL' },
+        ],
+        schemaVersion: 1,
+      }),
+    );
+
+    expect(result.valid).toBe(false);
+    expect(result.errors).toContain(
+      'schema.fields[0].minLength must be less than or equal to schema.fields[0].maxLength',
+    );
+    expect(result.errors).toContain('schema.fields[0].placeholder must be a string');
+    expect(result.errors).toContain(
+      'schema.fields[0].defaultValue has invalid type for field type',
+    );
+    expect(result.errors).toContain(
+      'schema.fields[1].minimum must be less than or equal to schema.fields[1].maximum',
+    );
+    expect(result.errors).toContain(
+      'schema.fields[1].defaultValue has invalid type for field type',
+    );
+    expect(result.errors).toContain(
+      'schema.fields[2].options.value is duplicated: general',
+    );
+    expect(result.errors).toContain(
+      'schema.fields[3].maxFiles must be an integer greater than or equal to 1',
+    );
+    expect(result.errors).toContain(
+      'schema.fields[3].acceptedMimeTypes must be an array of non-empty strings',
+    );
+  });
+});