make description optional

sandboxnu · Feb 14, 2025 · 26f5374 · 26f5374
1 parent 2506b19
commit 26f5374
Show file tree

Hide file tree

Showing 14 changed files with 65 additions and 34 deletions.
diff --git a/...sma/migrations/20250209213228_add_description_forminstance_and_formtemplate/migration.sql b/...sma/migrations/20250209213228_add_description_forminstance_and_formtemplate/migration.sql
diff --git a/...er/prisma/migrations/20250214033458_add_template_instance_description_field/migration.sql b/...er/prisma/migrations/20250214033458_add_template_instance_description_field/migration.sql
@@ -0,0 +1,5 @@
+-- AlterTable
+ALTER TABLE "FormInstance" ADD COLUMN     "description" TEXT;
+
+-- AlterTable
+ALTER TABLE "FormTemplate" ADD COLUMN     "description" TEXT;
diff --git a/apps/server/prisma/schema.prisma b/apps/server/prisma/schema.prisma
@@ -88,9 +88,9 @@ model FormTemplate {
   id          String   @id @default(uuid()) @db.Uuid
   name        String   @db.VarChar(255)
   formDocLink String   @db.VarChar(255)
-  description String   @db.VarChar(255) @default("No description")
   createdAt   DateTime @default(now())
   updatedAt   DateTime @updatedAt
+  description String?   @db.Text()
 
   fieldGroups   FieldGroup[]
   formInstances FormInstance[]
@@ -141,11 +141,11 @@ model FormInstance {
   id                String    @id @default(uuid()) @db.Uuid
   name              String    @db.VarChar(255)
   formDocLink       String    @db.VarChar(255)
-  description       String    @db.VarChar(255) @default("No description")
   completed         Boolean   @default(false)
   markedCompleted   Boolean   @default(false)
   createdAt         DateTime  @default(now())
   updatedAt         DateTime  @updatedAt
+  description       String?    @db.Text()
   completedAt       DateTime?
   markedCompletedAt DateTime?
 

diff --git a/apps/server/prisma/seed.types.ts b/apps/server/prisma/seed.types.ts
@@ -45,7 +45,7 @@ export type FormTemplateData = {
   name: string;
   formDocLink: string;
   fieldGroups: FieldGroupData[];
-  description: string;
+  description?: string;
 };
 
 export type AssignedGroupData = {
@@ -66,5 +66,5 @@ export type FormInstanceData = {
   originatorId: string;
   formTemplateId: string;
   assignedGroups: AssignedGroupData[];
-  description: string;
+  description?: string;
 };
diff --git a/apps/server/src/form-instances/dto/create-form-instance.dto.ts b/apps/server/src/form-instances/dto/create-form-instance.dto.ts
@@ -10,7 +10,7 @@ export class CreateFormInstanceDto {
 
   @IsString()
   @ApiProperty()
-  description: string;
+  description: string | null;
 
   @IsArray()
   @ArrayMinSize(1)

diff --git a/apps/server/src/form-instances/entities/form-instance.entity.ts b/apps/server/src/form-instances/entities/form-instance.entity.ts
@@ -12,6 +12,9 @@ export class FormInstanceBaseEntity implements FormInstance {
   @ApiProperty()
   name: string;
 
+  @ApiProperty()
+  description: string | null;
+
   @Exclude()
   formDocLink: string;
 
@@ -51,9 +54,6 @@ export class FormInstanceBaseEntity implements FormInstance {
   constructor(partial: Partial<FormInstanceEntity>) {
     Object.assign(this, partial);
   }
-
-  @ApiProperty()
-  description: string;
 }
 
 export class FormInstanceEntity implements FormInstance {
@@ -64,7 +64,7 @@ export class FormInstanceEntity implements FormInstance {
   name: string;
 
   @ApiProperty()
-  description: string;
+  description: string | null;
 
   @ApiProperty()
   formDocLink: string;

diff --git a/apps/server/src/form-templates/dto/create-form-template.dto.ts b/apps/server/src/form-templates/dto/create-form-template.dto.ts
@@ -14,9 +14,8 @@ export class CreateFormTemplateDto {
   formDocLink: string;
 
   @IsString()
-  @IsNotEmpty()
   @ApiProperty()
-  description: string;
+  description: string | null;
 
   @IsArray()
   @ArrayMinSize(1)

diff --git a/apps/server/src/form-templates/entities/form-template.entity.ts b/apps/server/src/form-templates/entities/form-template.entity.ts
@@ -15,7 +15,7 @@ export class FormTemplateBaseEntity implements FormTemplate {
   formDocLink: string;
 
   @ApiProperty()
-  description: string;
+  description: string | null;
 
   @Exclude()
   createdAt: Date;

diff --git a/apps/web/openapi-ts-error-1739504125051.log b/apps/web/openapi-ts-error-1739504125051.log
@@ -0,0 +1,11 @@
+Error requesting http://localhost:8080/api-json 
+fetch failed
+ResolverError: Error requesting http://localhost:8080/api-json 
+fetch failed
+    at Object.sendRequest (/Users/laurenbrissette/Documents/GitHub (laurenbrissette)/mfa-form-automator/node_modules/@hey-api/json-schema-ref-parser/dist/lib/resolvers/url.js:44:15)
+    at process.processTicksAndRejections (node:internal/process/task_queues:105:5)
+    at async Gs (/Users/laurenbrissette/Documents/GitHub (laurenbrissette)/mfa-form-automator/apps/web/node_modules/@hey-api/openapi-ts/dist/index.cjs:12:908)
+    at async mo (/Users/laurenbrissette/Documents/GitHub (laurenbrissette)/mfa-form-automator/apps/web/node_modules/@hey-api/openapi-ts/dist/index.cjs:14:88219)
+    at async Promise.all (index 0)
+    at async Uv (/Users/laurenbrissette/Documents/GitHub (laurenbrissette)/mfa-form-automator/apps/web/node_modules/@hey-api/openapi-ts/dist/index.cjs:1311:4468)
+    at async start (/Users/laurenbrissette/Documents/GitHub (laurenbrissette)/mfa-form-automator/apps/web/node_modules/@hey-api/openapi-ts/bin/index.cjs:120:21)
diff --git a/apps/web/openapi-ts-error-1739504146115.log b/apps/web/openapi-ts-error-1739504146115.log
@@ -0,0 +1,11 @@
+Error requesting http://localhost:8080/api-json 
+fetch failed
+ResolverError: Error requesting http://localhost:8080/api-json 
+fetch failed
+    at Object.sendRequest (/Users/laurenbrissette/Documents/GitHub (laurenbrissette)/mfa-form-automator/node_modules/@hey-api/json-schema-ref-parser/dist/lib/resolvers/url.js:44:15)
+    at process.processTicksAndRejections (node:internal/process/task_queues:105:5)
+    at async Gs (/Users/laurenbrissette/Documents/GitHub (laurenbrissette)/mfa-form-automator/apps/web/node_modules/@hey-api/openapi-ts/dist/index.cjs:12:908)
+    at async mo (/Users/laurenbrissette/Documents/GitHub (laurenbrissette)/mfa-form-automator/apps/web/node_modules/@hey-api/openapi-ts/dist/index.cjs:14:88219)
+    at async Promise.all (index 0)
+    at async Uv (/Users/laurenbrissette/Documents/GitHub (laurenbrissette)/mfa-form-automator/apps/web/node_modules/@hey-api/openapi-ts/dist/index.cjs:1311:4468)
+    at async start (/Users/laurenbrissette/Documents/GitHub (laurenbrissette)/mfa-form-automator/apps/web/node_modules/@hey-api/openapi-ts/bin/index.cjs:120:21)
diff --git a/apps/web/openapi-ts-error-1739504908576.log b/apps/web/openapi-ts-error-1739504908576.log
@@ -0,0 +1,11 @@
+Error requesting http://localhost:8080/api-json 
+fetch failed
+ResolverError: Error requesting http://localhost:8080/api-json 
+fetch failed
+    at Object.sendRequest (/Users/laurenbrissette/Documents/GitHub (laurenbrissette)/mfa-form-automator/node_modules/@hey-api/json-schema-ref-parser/dist/lib/resolvers/url.js:44:15)
+    at process.processTicksAndRejections (node:internal/process/task_queues:105:5)
+    at async Gs (/Users/laurenbrissette/Documents/GitHub (laurenbrissette)/mfa-form-automator/apps/web/node_modules/@hey-api/openapi-ts/dist/index.cjs:12:908)
+    at async mo (/Users/laurenbrissette/Documents/GitHub (laurenbrissette)/mfa-form-automator/apps/web/node_modules/@hey-api/openapi-ts/dist/index.cjs:14:88219)
+    at async Promise.all (index 0)
+    at async Uv (/Users/laurenbrissette/Documents/GitHub (laurenbrissette)/mfa-form-automator/apps/web/node_modules/@hey-api/openapi-ts/dist/index.cjs:1311:4468)
+    at async start (/Users/laurenbrissette/Documents/GitHub (laurenbrissette)/mfa-form-automator/apps/web/node_modules/@hey-api/openapi-ts/bin/index.cjs:120:21)
diff --git a/apps/web/src/client/schemas.gen.ts b/apps/web/src/client/schemas.gen.ts
@@ -450,6 +450,7 @@ export const CreateFormTemplateDtoSchema = {
     },
     description: {
       type: 'string',
+      nullable: true,
     },
     fieldGroups: {
       type: 'array',
@@ -555,6 +556,7 @@ export const FormTemplateBaseEntitySchema = {
     },
     description: {
       type: 'string',
+      nullable: true,
     },
     createdAt: {
       format: 'date-time',
@@ -565,14 +567,7 @@ export const FormTemplateBaseEntitySchema = {
       type: 'string',
     },
   },
-  required: [
-    'id',
-    'name',
-    'formDocLink',
-    'description',
-    'createdAt',
-    'updatedAt',
-  ],
+  required: ['id', 'name', 'formDocLink', 'createdAt', 'updatedAt'],
 } as const;
 
 export const AssignedGroupEntitySchema = {
@@ -692,6 +687,7 @@ export const FormInstanceEntitySchema = {
     },
     description: {
       type: 'string',
+      nullable: true,
     },
     formDocLink: {
       type: 'string',
@@ -770,6 +766,7 @@ export const FormTemplateEntitySchema = {
     },
     description: {
       type: 'string',
+      nullable: true,
     },
     fieldGroups: {
       type: 'array',
@@ -796,7 +793,6 @@ export const FormTemplateEntitySchema = {
     'id',
     'name',
     'formDocLink',
-    'description',
     'fieldGroups',
     'formInstances',
     'createdAt',
@@ -815,6 +811,7 @@ export const UpdateFormTemplateDtoSchema = {
     },
     description: {
       type: 'string',
+      nullable: true,
     },
   },
 } as const;
@@ -878,6 +875,7 @@ export const CreateFormInstanceDtoSchema = {
     },
     description: {
       type: 'string',
+      nullable: true,
     },
     assignedGroups: {
       type: 'array',
@@ -913,6 +911,7 @@ export const UpdateFormInstanceDtoSchema = {
     },
     description: {
       type: 'string',
+      nullable: true,
     },
     formDocLink: {
       type: 'string',

diff --git a/apps/web/src/client/types.gen.ts b/apps/web/src/client/types.gen.ts
@@ -147,7 +147,7 @@ export type CreateFieldGroupDto = {
 export type CreateFormTemplateDto = {
   name: string;
   formDocLink: string;
-  description: string;
+  description: string | null;
   fieldGroups: Array<CreateFieldGroupDto>;
 };
 
@@ -175,7 +175,7 @@ export type FormTemplateBaseEntity = {
   id: string;
   name: string;
   formDocLink: string;
-  description: string;
+  description?: string | null;
   createdAt: string;
   updatedAt: string;
 };
@@ -205,7 +205,7 @@ export type AssignedGroupEntity = {
 export type FormInstanceEntity = {
   id: string;
   name: string;
-  description: string;
+  description: string | null;
   formDocLink: string;
   completed: boolean;
   markedCompleted: boolean;
@@ -224,7 +224,7 @@ export type FormTemplateEntity = {
   id: string;
   name: string;
   formDocLink: string;
-  description: string;
+  description?: string | null;
   fieldGroups: Array<FieldGroupBaseEntity>;
   formInstances: Array<FormInstanceEntity>;
   createdAt: string;
@@ -234,7 +234,7 @@ export type FormTemplateEntity = {
 export type UpdateFormTemplateDto = {
   name?: string;
   formDocLink?: string;
-  description?: string;
+  description?: string | null;
 };
 
 export type CreateDepartmentDto = {
@@ -257,7 +257,7 @@ export type CreateAssignedGroupDto = {
 
 export type CreateFormInstanceDto = {
   name: string;
-  description: string;
+  description: string | null;
   assignedGroups: Array<CreateAssignedGroupDto>;
   originatorId: string;
   formTemplateId: string;
@@ -266,7 +266,7 @@ export type CreateFormInstanceDto = {
 
 export type UpdateFormInstanceDto = {
   name?: string;
-  description?: string;
+  description?: string | null;
   formDocLink?: string;
 };
 

diff --git a/apps/web/src/components/createFormInstance/CreateFormInstanceModal.tsx b/apps/web/src/components/createFormInstance/CreateFormInstanceModal.tsx
@@ -112,7 +112,7 @@ const CreateFormInstanceModal: React.FC<CreateFormInstanceModalProps> = ({
           originatorId: user?.id!,
           formTemplateId: selectedFormTemplate?.id!,
           formDocLink: selectedFormTemplate?.formDocLink!,
-          description: selectedFormTemplate?.description!,
+          description: selectedFormTemplate?.description ? selectedFormTemplate?.description : null,
         },
       })
       .then((response) => {