SIMSBIOHUB-144-2: Project Role updates

api/src/constants/roles.ts

@@ -2,7 +2,7 @@
  * System level roles.
  *
  * @export
- * @enum {number}
+ * @enum {string}
  */
 export enum SYSTEM_ROLE {
   SYSTEM_ADMIN = 'System Administrator',
@@ -14,10 +14,22 @@ export enum SYSTEM_ROLE {
  * Project level roles.
  *
  * @export
- * @enum {number}
+ * @enum {string}
  */
 export enum PROJECT_ROLE {
-  PROJECT_LEAD = 'Project Lead',
-  PROJECT_EDITOR = 'Editor',
-  PROJECT_VIEWER = 'Viewer'
+  COORDINATOR = 'Coordinator',
+  COLLABORATOR = 'Collaborator',
+  OBSERVER = 'Observer'
+}
+
+/**
+ * Role permissions.
+ *
+ * @export
+ * @enum {string}
+ */
+export enum PROJECT_PERMISSION {
+  COORDINATOR = 'Coordinator',
+  COLLABORATOR = 'Collaborator',
+  OBSERVER = 'Observer'
 }

api/src/database/db.ts

@@ -41,6 +41,15 @@ pg.types.setTypeParser(pg.types.builtins.DATE, (stringValue: string) => {
   return stringValue; // 1082 for `DATE` type
 });
 
+// Adding a TIMESTAMP type parser to keep all dates used in the system consistent
+pg.types.setTypeParser(pg.types.builtins.TIMESTAMP, (stringValue: string) => {
+  return stringValue; // 1082 for `TIMESTAMP` type
+});
+// Adding a TIMESTAMPTZ type parser to keep all dates used in the system consistent
+pg.types.setTypeParser(pg.types.builtins.TIMESTAMPTZ, (stringValue: string) => {
+  return stringValue; // 1082 for `DATE` type
+});
+
 // singleton pg pool instance used by the api
 let DBPool: pg.Pool | undefined;
 

api/src/models/project-view.test.ts

@@ -23,8 +23,8 @@ describe('ProjectData', () => {
         project_name: '',
         project_programs: [],
         project_types: [],
-        start_date: new Date('2005-01-01'),
-        end_date: new Date('2006-01-01'),
+        start_date: '2005-01-01',
+        end_date: '2006-01-01',
         comments: '',
         revision_count: 1
       };
@@ -47,11 +47,11 @@ describe('ProjectData', () => {
     });
 
     it('sets start_date', () => {
-      expect(data.start_date).to.eql(new Date('2005-01-01'));
+      expect(data.start_date).to.eql('2005-01-01');
     });
 
     it('sets end_date', () => {
-      expect(data.end_date).to.eql(new Date('2006-01-01'));
+      expect(data.end_date).to.eql('2006-01-01');
     });
   });
 
@@ -74,8 +74,8 @@ describe('ProjectData', () => {
         project_name: 'project name',
         project_programs: [1],
         project_types: [1, 2],
-        start_date: new Date('2020-04-20T07:00:00.000Z'),
-        end_date: new Date('2020-05-20T07:00:00.000Z'),
+        start_date: '2020-04-20T07:00:00.000Z',
+        end_date: '2020-05-20T07:00:00.000Z',
         comments: '',
         revision_count: 1
       };
@@ -98,16 +98,12 @@ describe('ProjectData', () => {
     });
 
     it('sets start_date', () => {
-      expect(data.start_date).to.eql(new Date('2020-04-20T07:00:00.000Z'));
+      expect(data.start_date).to.eql('2020-04-20T07:00:00.000Z');
     });
 
     it('sets end_date', () => {
-      expect(data.end_date).to.eql(new Date('2020-05-20T07:00:00.000Z'));
+      expect(data.end_date).to.eql('2020-05-20T07:00:00.000Z');
     });
-
-    // it('sets completion_status', () => {
-    //   expect(data.completion_status).to.equal(COMPLETION_STATUS.COMPLETED);
-    // });
   });
 });
 

api/src/models/project-view.ts

@@ -30,14 +30,28 @@ export const ProjectData = z.object({
   project_name: z.string(),
   project_programs: z.array(z.number()),
   project_types: z.array(z.number()),
-  start_date: z.date(),
-  end_date: z.date().nullable(),
+  start_date: z.string(),
+  end_date: z.string().nullable(),
   comments: z.string().nullable(),
   revision_count: z.number()
 });
 
 export type ProjectData = z.infer<typeof ProjectData>;
 
+export const ProjectListData = z.object({
+  project_id: z.number(),
+  uuid: z.string(),
+  project_name: z.string(),
+  coordinator_agency: z.string(),
+  project_programs: z.array(z.number()).default([]),
+  project_types: z.array(z.number()).default([]),
+  regions: z.array(z.string()).default([]),
+  start_date: z.string(),
+  end_date: z.string().nullable().optional()
+});
+
+export type ProjectListData = z.infer<typeof ProjectListData>;
+
 /**
  * Pre-processes GET /projects/{id} objectives data
  *

api/src/models/user.ts

@@ -1,33 +1,23 @@
-export class UserObject {
-  id: number;
-  user_identifier: string;
-  user_guid: string | null;
-  identity_source: string;
-  record_end_date: string;
-  role_ids: number[];
-  role_names: string[];
+import { z } from 'zod';
 
-  constructor(obj?: any) {
-    this.id = obj?.system_user_id || null;
-    this.user_identifier = obj?.user_identifier || null;
-    this.user_guid = obj?.user_guid || null;
-    this.identity_source = obj?.identity_source || null;
-    this.record_end_date = obj?.record_end_date || null;
-    this.role_ids = (obj?.role_ids?.length && obj.role_ids) || [];
-    this.role_names = (obj?.role_names?.length && obj.role_names) || [];
-  }
-}
+export const User = z.object({
+  system_user_id: z.number(),
+  user_identifier: z.string(),
+  user_guid: z.string().nullable(),
+  identity_source: z.string(),
+  record_end_date: z.string().nullable(),
+  role_ids: z.array(z.number()).default([]),
+  role_names: z.array(z.string()).default([])
+});
 
-export class ProjectUserObject {
-  project_id: number;
-  system_user_id: number;
-  project_role_ids: number[];
-  project_role_names: string[];
+export type User = z.infer<typeof User>;
 
-  constructor(obj?: any) {
-    this.project_id = obj?.project_id || null;
-    this.system_user_id = obj?.system_user_id || null;
-    this.project_role_ids = (obj?.project_role_ids?.length && obj.project_role_ids) || [];
-    this.project_role_names = (obj?.project_role_names?.length && obj.project_role_names) || [];
-  }
-}
+export const ProjectUser = z.object({
+  project_id: z.number(),
+  system_user_id: z.number(),
+  project_role_ids: z.array(z.number()),
+  project_role_names: z.array(z.string()),
+  project_role_permissions: z.array(z.string())
+});
+
+export type ProjectUser = z.infer<typeof ProjectUser>;

api/src/paths/administrative-activity.test.ts

@@ -42,7 +42,7 @@ describe('createAdministrativeActivity', () => {
     const dbConnectionObj = getMockDBConnection({ systemUserId: () => systemUserId, commit: sinon.stub() });
     sinon.stub(db, 'getAPIUserDBConnection').returns(dbConnectionObj);
 
-    const mockResponse: ICreateAdministrativeActivity = { id: 2, date: new Date() };
+    const mockResponse: ICreateAdministrativeActivity = { id: 2, date: '2023-01-01' };
 
     sinon.stub(AdministrativeActivityService.prototype, 'createPendingAccessRequest').resolves(mockResponse);
     sinon.stub(AdministrativeActivityService.prototype, 'sendAccessRequestNotificationEmailToAdmin').resolves();

api/src/paths/administrative-activity/system-access/{administrativeActivityId}/approve.test.ts

@@ -4,7 +4,7 @@ import sinon from 'sinon';
 import sinonChai from 'sinon-chai';
 import { ADMINISTRATIVE_ACTIVITY_STATUS_TYPE } from '../../../../constants/administrative-activity';
 import * as db from '../../../../database/db';
-import { UserObject } from '../../../../models/user';
+import { User } from '../../../../models/user';
 import { AdministrativeActivityService } from '../../../../services/administrative-activity-service';
 import { UserService } from '../../../../services/user-service';
 import { getMockDBConnection, getRequestHandlerMocks } from '../../../../__mocks__/db';
@@ -65,10 +65,10 @@ describe('approveAccessRequest', () => {
 
     const systemUserId = 4;
     const existingRoleIds = [1, 2];
-    const mockSystemUser: UserObject = {
-      id: systemUserId,
+    const mockSystemUser: User = {
+      system_user_id: systemUserId,
       user_identifier: '',
-      user_guid: 'aaaa',
+      user_guid: '',
       identity_source: 'idir',
       record_end_date: '',
       role_ids: existingRoleIds,

api/src/paths/administrative-activity/system-access/{administrativeActivityId}/approve.ts

@@ -144,7 +144,7 @@ export function approveAccessRequest(): RequestHandler {
 
       if (rolesIdsToAdd?.length) {
         // Add any missing roles (if any)
-        await userService.addUserSystemRoles(systemUserObject.id, rolesIdsToAdd);
+        await userService.addUserSystemRoles(systemUserObject.system_user_id, rolesIdsToAdd);
       }
 
       // Update the access request record status

api/src/paths/draft/create.test.ts

@@ -57,7 +57,7 @@ describe('paths/draft/create', () => {
         webform_draft_id: 1,
         name: 'draft object',
         data: {},
-        create_date: ('2022-10-10' as unknown) as Date,
+        create_date: '2022-10-10',
         update_date: null
       });
       const requestHandler = create.createDraft();
@@ -71,7 +71,7 @@ describe('paths/draft/create', () => {
         webform_draft_id: 1,
         name: 'draft object',
         data: {},
-        create_date: ('2022-10-10' as unknown) as Date,
+        create_date: '2022-10-10',
         update_date: null
       });
     });

api/src/paths/draft/list.test.ts

@@ -64,15 +64,15 @@ describe('paths/draft/list', () => {
           webform_draft_id: 1,
           name: 'draft object 1',
           data: {},
-          create_date: ('2022-10-10' as unknown) as Date,
+          create_date: '2022-10-10',
           update_date: null
         },
         {
           webform_draft_id: 2,
           name: 'draft object 2',
           data: {},
-          create_date: ('2022-10-10' as unknown) as Date,
-          update_date: ('2022-10-11' as unknown) as Date
+          create_date: '2022-10-10',
+          update_date: '2022-10-11'
         }
       ]);
 
@@ -85,15 +85,15 @@ describe('paths/draft/list', () => {
           webform_draft_id: 1,
           name: 'draft object 1',
           data: {},
-          create_date: ('2022-10-10' as unknown) as Date,
+          create_date: '2022-10-10',
           update_date: null
         },
         {
           webform_draft_id: 2,
           name: 'draft object 2',
           data: {},
-          create_date: ('2022-10-10' as unknown) as Date,
-          update_date: ('2022-10-11' as unknown) as Date
+          create_date: '2022-10-10',
+          update_date: '2022-10-11'
         }
       ]);
     });

api/src/paths/draft/{draftId}/get.test.ts

@@ -63,7 +63,7 @@ describe('paths/draft/{draftId}/get', () => {
         webform_draft_id: 1,
         name: 'draft object',
         data: {},
-        create_date: ('2022-10-10' as unknown) as Date,
+        create_date: '2022-10-10',
         update_date: null
       });
 
@@ -75,7 +75,7 @@ describe('paths/draft/{draftId}/get', () => {
         webform_draft_id: 1,
         name: 'draft object',
         data: {},
-        create_date: ('2022-10-10' as unknown) as Date,
+        create_date: '2022-10-10',
         update_date: null
       });
     });