270 feature add description field to forminstance and formtemplate

apps/server/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;

apps/server/prisma/schema.prisma

@@ -90,6 +90,7 @@ model FormTemplate {
   formDocLink String   @db.VarChar(255)
   createdAt   DateTime @default(now())
   updatedAt   DateTime @updatedAt
+  description String?   @db.Text()
 
   fieldGroups   FieldGroup[]
   formInstances FormInstance[]
@@ -144,6 +145,7 @@ model FormInstance {
   markedCompleted   Boolean   @default(false)
   createdAt         DateTime  @default(now())
   updatedAt         DateTime  @updatedAt
+  description       String?    @db.Text()
   completedAt       DateTime?
   markedCompletedAt DateTime?
 

apps/server/prisma/seed.ts

@@ -162,10 +162,12 @@ const formTemplates: FormTemplateData[] = [
         ],
       },
     ],
+    description: 'IT exit form description',
   },
   {
     id: STAFFING_REQUISITION_UUID,
     name: 'Staffing Requisition',
+    description: 'Staffing Requisition description',
     formDocLink: DEV_FORM_DOC_LINK,
     fieldGroups: [
       {
@@ -199,6 +201,7 @@ const formTemplates: FormTemplateData[] = [
   {
     id: NETWORK_ADD_CHANGE_UUID,
     name: 'Network Add Change',
+    description: 'Network Add Change description',
     formDocLink: DEV_FORM_DOC_LINK,
     fieldGroups: [
       {
@@ -219,6 +222,7 @@ const formTemplates: FormTemplateData[] = [
   {
     id: MFA_ORACLE_LOGON_REQUEST_UUID,
     name: 'MFA Oracle Logon Request',
+    description: 'MFA Oracle Logon Request description',
     formDocLink: DEV_FORM_DOC_LINK,
     fieldGroups: [
       {
@@ -252,6 +256,7 @@ const formTemplates: FormTemplateData[] = [
   {
     id: HYBRID_AND_REMOTE_WORK_AGREEMENT_UUID,
     name: 'Hybrid and Remote Work Agreement',
+    description: 'Hybrid and Remote Work Agreement description',
     formDocLink: DEV_FORM_DOC_LINK,
     fieldGroups: [
       {
@@ -272,6 +277,7 @@ const formTemplates: FormTemplateData[] = [
   {
     id: VPN_REQUEST_UUID,
     name: 'VPN Request',
+    description: 'VPN Request description',
     formDocLink: DEV_FORM_DOC_LINK,
     fieldGroups: [
       {
@@ -292,6 +298,7 @@ const formTemplates: FormTemplateData[] = [
   {
     id: DIGITAL_MFA_ID_BADGE_REQUEST_UUID,
     name: 'Digital MFA ID Badge Request',
+    description: 'Digital MFA ID Badge Request description',
     formDocLink: DEV_FORM_DOC_LINK,
     fieldGroups: [
       {
@@ -312,6 +319,7 @@ const formTemplates: FormTemplateData[] = [
   {
     id: TRAVEL_AUTHORIZATION_UUID,
     name: 'Travel Authorization',
+    description: 'Travel Authorization description',
     formDocLink: DEV_FORM_DOC_LINK,
     fieldGroups: [
       {
@@ -335,6 +343,7 @@ const formInstances: FormInstanceData[] = [
   {
     id: uuidv4(),
     name: 'IT Exit Form Instance',
+    description: 'IT Exit Form Instance description',
     formDocLink: DEV_FORM_DOC_LINK,
     originatorId: KAI_ZHENG_UUID,
     formTemplateId: IT_EXIT_FORM_UUID,
@@ -363,6 +372,7 @@ const formInstances: FormInstanceData[] = [
   {
     id: uuidv4(),
     name: 'Staffing Requisition Form Instance',
+    description: 'Staffing Requisition Form Instance description',
     formDocLink: DEV_FORM_DOC_LINK,
     originatorId: IRIS_ZHANG_UUID,
     formTemplateId: STAFFING_REQUISITION_UUID,
@@ -391,6 +401,7 @@ const formInstances: FormInstanceData[] = [
   {
     id: uuidv4(),
     name: 'Network Add Change Form Instance',
+    description: 'Network Add Change Form Instance description',
     formDocLink: DEV_FORM_DOC_LINK,
     originatorId: ANSHUL_SHIRUDE_UUID,
     formTemplateId: NETWORK_ADD_CHANGE_UUID,
@@ -407,6 +418,7 @@ const formInstances: FormInstanceData[] = [
   {
     id: uuidv4(),
     name: 'MFA Oracle Logon Request Form Instance',
+    description: 'MFA Oracle Logon Request Form Instance description',
     formDocLink: DEV_FORM_DOC_LINK,
     originatorId: ANGELA_WEIGL_UUID,
     formTemplateId: MFA_ORACLE_LOGON_REQUEST_UUID,
@@ -430,6 +442,7 @@ const formInstances: FormInstanceData[] = [
   {
     id: uuidv4(),
     name: 'Hybrid and Remote Work Agreement Form Instance',
+    description: 'Hybrid and Remote Work Agreement Form Instance description',
     formDocLink: DEV_FORM_DOC_LINK,
     originatorId: ANSHUL_SHIRUDE_UUID,
     formTemplateId: HYBRID_AND_REMOTE_WORK_AGREEMENT_UUID,
@@ -446,6 +459,7 @@ const formInstances: FormInstanceData[] = [
   {
     id: uuidv4(),
     name: 'VPN Request Form Instance',
+    description: 'VPN Request Form Instance description',
     formDocLink: DEV_FORM_DOC_LINK,
     originatorId: IRIS_ZHANG_UUID,
     formTemplateId: VPN_REQUEST_UUID,
@@ -462,6 +476,7 @@ const formInstances: FormInstanceData[] = [
   {
     id: uuidv4(),
     name: 'Digital MFA ID Badge Request Form Instance',
+    description: 'Digital MFA ID Badge Request Form Instance description',
     formDocLink: DEV_FORM_DOC_LINK,
     originatorId: KAI_ZHENG_UUID,
     formTemplateId: DIGITAL_MFA_ID_BADGE_REQUEST_UUID,
@@ -478,6 +493,7 @@ const formInstances: FormInstanceData[] = [
   {
     id: uuidv4(),
     name: 'Travel Authorization Form Instance',
+    description: 'Travel Authorization Form Instance description',
     formDocLink: DEV_FORM_DOC_LINK,
     originatorId: ANGELA_WEIGL_UUID,
     formTemplateId: TRAVEL_AUTHORIZATION_UUID,

apps/server/prisma/seed.types.ts

@@ -45,6 +45,7 @@ export type FormTemplateData = {
   name: string;
   formDocLink: string;
   fieldGroups: FieldGroupData[];
+  description?: string;
 };
 
 export type AssignedGroupData = {
@@ -65,4 +66,5 @@ export type FormInstanceData = {
   originatorId: string;
   formTemplateId: string;
   assignedGroups: AssignedGroupData[];
+  description?: string;
 };

apps/server/prisma/seeder.ts

@@ -180,7 +180,7 @@ export class Seeder {
   }
 
   private async upsertFormTemplate(data: FormTemplateData) {
-    const { id, name, formDocLink, fieldGroups } = data;
+    const { id, name, formDocLink, description, fieldGroups } = data;
 
     await this.prisma.formTemplate.upsert({
       where: { id },
@@ -189,6 +189,7 @@ export class Seeder {
         id,
         name,
         formDocLink,
+        description,
         fieldGroups: {
           create: fieldGroups.map((fieldGroup) => {
             return {
@@ -236,6 +237,7 @@ export class Seeder {
         id: data.id,
         name: data.name,
         formDocLink: data.formDocLink,
+        description: data.description,
         originatorId: data.originatorId,
         formTemplateId: data.formTemplateId,
         assignedGroups: {

apps/server/src/assigned-group/entities/assigned-group.entity.ts

@@ -1,4 +1,4 @@
-import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+import { ApiProperty } from '@nestjs/swagger';
 import { AssignedGroup, SignerType } from '@prisma/client';
 import { IsDate, IsOptional, IsString } from 'class-validator';
 import { EmployeeBaseEntity } from '../../employees/entities/employee.entity';
@@ -21,7 +21,7 @@ export class AssignedGroupBaseEntity implements AssignedGroup {
 
   @IsString()
   @IsOptional()
-  @ApiPropertyOptional()
+  @ApiProperty()
   signedDocLink: string | null;
 
   @IsDate()
@@ -34,22 +34,22 @@ export class AssignedGroupBaseEntity implements AssignedGroup {
 
   @IsString()
   @IsOptional()
-  @ApiPropertyOptional()
+  @ApiProperty()
   signerPositionId: string | null;
 
   @IsString()
   @IsOptional()
-  @ApiPropertyOptional()
+  @ApiProperty()
   signerDepartmentId: string | null;
 
   @IsString()
   @IsOptional()
-  @ApiPropertyOptional()
+  @ApiProperty()
   signerEmployeeId: string | null;
 
   @IsString()
   @IsOptional()
-  @ApiPropertyOptional()
+  @ApiProperty()
   signingEmployeeId: string | null;
 
   @ApiProperty({ enum: SignerType })
@@ -69,23 +69,23 @@ export class AssignedGroupEntity extends AssignedGroupBaseEntity {
   fieldGroup: FieldGroupBaseEntity;
 
   @IsOptional()
-  @ApiPropertyOptional()
+  @ApiProperty()
   signingEmployee: EmployeeBaseEntity | null;
 
   @IsOptional()
-  @ApiPropertyOptional()
+  @ApiProperty()
   signerPosition: PositionBaseEntity | null;
 
   @IsOptional()
-  @ApiPropertyOptional()
+  @ApiProperty()
   signerDepartment: DepartmentEntity | null;
 
   @IsOptional()
-  @ApiPropertyOptional()
+  @ApiProperty()
   signerEmployee: EmployeeBaseEntity | null;
 
   @IsOptional()
-  @ApiPropertyOptional({
+  @ApiProperty({
     type: EmployeeBaseEntity,
     isArray: true,
   })

apps/server/src/form-instances/dto/create-form-instance.dto.ts

@@ -1,5 +1,11 @@
 import { ApiProperty } from '@nestjs/swagger';
-import { ArrayMinSize, IsArray, IsNotEmpty, IsString } from 'class-validator';
+import {
+  ArrayMinSize,
+  IsArray,
+  IsNotEmpty,
+  IsOptional,
+  IsString,
+} from 'class-validator';
 import { CreateAssignedGroupDto } from '../../assigned-group/dto/create-assigned-group.dto';
 
 export class CreateFormInstanceDto {
@@ -8,6 +14,11 @@ export class CreateFormInstanceDto {
   @ApiProperty()
   name: string;
 
+  @IsString()
+  @ApiProperty()
+  @IsOptional()
+  description: string;
+
   @IsArray()
   @ArrayMinSize(1)
   @ApiProperty({

apps/server/src/form-instances/entities/form-instance.entity.ts

@@ -4,6 +4,7 @@ import { FormTemplateBaseEntity } from '../../form-templates/entities/form-templ
 import { Exclude } from 'class-transformer';
 import { EmployeeEntity } from '../../employees/entities/employee.entity';
 import { AssignedGroupEntity } from '../../assigned-group/entities/assigned-group.entity';
+import { IsOptional } from 'class-validator';
 
 export class FormInstanceBaseEntity implements FormInstance {
   @ApiProperty()
@@ -12,6 +13,10 @@ export class FormInstanceBaseEntity implements FormInstance {
   @ApiProperty()
   name: string;
 
+  @IsOptional()
+  @ApiProperty()
+  description: string | null;
+
   @Exclude()
   formDocLink: string;
 
@@ -60,6 +65,9 @@ export class FormInstanceEntity implements FormInstance {
   @ApiProperty()
   name: string;
 
+  @ApiProperty()
+  description: string | null;
+
   @ApiProperty()
   formDocLink: string;
 

apps/server/src/form-instances/form-instances.service.spec.ts

@@ -86,6 +86,7 @@ const formTemplate = {
   id: formTemplateId,
   name: 'Form-Template-1',
   formDocLink: 'mfa.org/form1',
+  description: 'description',
   signatureFields: [
     {
       id: '086885ca-ecc8-4614-8103-9a99fa0bdf6d',
@@ -132,6 +133,7 @@ const formInstancesArray = [
   {
     id: formInstance1Id,
     name: formInstance1Name,
+    description: 'forminstance1 description',
     formDocLink: '',
     completed: false,
     createdAt: new Date(1672531200),
@@ -172,6 +174,7 @@ const formInstancesArray = [
   {
     id: formInstance2Id,
     name: formInstance2Name,
+    description: 'forminstance2 description',
     formDocLink: '',
     completed: false,
     createdAt: new Date(1672531200),
@@ -199,6 +202,7 @@ const formInstancesArray = [
   {
     id: formInstance3Id,
     name: formInstance3Name,
+    description: 'forminstance3 description',
     formDocLink: '',
     completed: false,
     createdAt: new Date(1672531200),
@@ -325,6 +329,7 @@ describe('FormInstancesService', () => {
         originatorId: 'originator-id',
         formTemplateId: 'form-template-id',
         formDocLink: 'form-doc-link',
+        description: 'description',
       };
 
       jest
@@ -357,6 +362,7 @@ describe('FormInstancesService', () => {
         originatorId: 'originator-id',
         formTemplateId: 'form-template-id',
         formDocLink: 'form-doc-link',
+        description: 'description',
       };
 
       jest
@@ -382,6 +388,7 @@ describe('FormInstancesService', () => {
         originatorId: 'originator-id',
         formTemplateId: 'form-template-id',
         formDocLink: 'form-doc-link',
+        description: 'description',
       };
 
       expect(service.create(createFormInstanceDto)).rejects.toThrowError(
@@ -408,6 +415,7 @@ describe('FormInstancesService', () => {
         originatorId: 'originator-id',
         formTemplateId: 'form-template-id',
         formDocLink: 'form-doc-link',
+        description: 'description',
       };
 
       jest
@@ -438,6 +446,7 @@ describe('FormInstancesService', () => {
         originatorId: 'originator-id',
         formTemplateId: 'form-template-id',
         formDocLink: 'form-doc-link',
+        description: 'description',
       };
 
       jest
@@ -468,6 +477,7 @@ describe('FormInstancesService', () => {
         originatorId: 'originator-id',
         formTemplateId: 'form-template-id',
         formDocLink: 'form-doc-link',
+        description: 'description',
       };
 
       jest
@@ -498,6 +508,7 @@ describe('FormInstancesService', () => {
         originatorId: 'originator-id',
         formTemplateId: 'form-template-id',
         formDocLink: 'form-doc-link',
+        description: 'description',
       };
 
       jest