Add Strong types

Author: Pl217

src/domain-services/flows/flow-service.ts

@@ -96,7 +96,7 @@ export class FlowService {
     const refDirection = orderBy.direction ?? 'source';
 
     let entityIDsSorted: number[] = [];
-
+    let entityCondKeyFlowObjectType: FlowObjectType;
     switch (entity) {
       case 'emergency': {
         columns = getTableColumns(database.emergency);
@@ -119,6 +119,7 @@ export class FlowService {
         });
 
         entityIDsSorted = emergencies.map((emergency) => emergency.id);
+        entityCondKeyFlowObjectType = 'emergency' satisfies FlowObjectType;
         break;
       }
       case 'globalCluster': {
@@ -143,6 +144,8 @@ export class FlowService {
         entityIDsSorted = globalClusters.map(
           (globalCluster) => globalCluster.id
         );
+        entityCondKeyFlowObjectType = 'globalCluster' satisfies FlowObjectType;
+
         break;
       }
       case 'governingEntity': {
@@ -167,6 +170,9 @@ export class FlowService {
         entityIDsSorted = governingEntities.map(
           (governingEntity) => governingEntity.id
         );
+        entityCondKeyFlowObjectType =
+          'governingEntity' satisfies FlowObjectType;
+
         break;
       }
       case 'location': {
@@ -189,6 +195,8 @@ export class FlowService {
         });
 
         entityIDsSorted = locations.map((location) => location.id);
+        entityCondKeyFlowObjectType = 'location' satisfies FlowObjectType;
+
         break;
       }
       case 'organization': {
@@ -211,6 +219,8 @@ export class FlowService {
         });
 
         entityIDsSorted = organizations.map((organization) => organization.id);
+        entityCondKeyFlowObjectType = 'organization' satisfies FlowObjectType;
+
         break;
       }
       case 'plan': {
@@ -233,6 +243,8 @@ export class FlowService {
         });
 
         entityIDsSorted = plans.map((plan) => plan.id);
+        entityCondKeyFlowObjectType = 'plan' satisfies FlowObjectType;
+
         break;
       }
       case 'project': {
@@ -255,6 +267,8 @@ export class FlowService {
         });
 
         entityIDsSorted = projects.map((project) => project.id);
+        entityCondKeyFlowObjectType = 'project' satisfies FlowObjectType;
+
         break;
       }
       case 'usageYear': {
@@ -277,6 +291,8 @@ export class FlowService {
         });
 
         entityIDsSorted = usageYears.map((usageYear) => usageYear.id);
+        entityCondKeyFlowObjectType = 'usageYear' satisfies FlowObjectType;
+
         break;
       }
       case 'planVersion': {
@@ -304,6 +320,8 @@ export class FlowService {
         });
 
         entityIDsSorted = planVersions.map((planVersion) => planVersion.planId);
+        entityCondKeyFlowObjectType = 'plan' satisfies FlowObjectType;
+
         break;
       }
       default: {
@@ -313,8 +331,6 @@ export class FlowService {
 
     // After getting the sorted entityID list
     // we can now get the flowObjects
-    const entityCondKey = orderBy.entity as unknown;
-    const entityCondKeyFlowObjectType = entityCondKey as FlowObjectType;
 
     // Order map
     const orderMap = new Map<number, number>();

src/domain-services/flows/graphql/types.ts

@@ -8,6 +8,7 @@ import { Organization } from '../../organizations/graphql/types';
 import { BasePlan } from '../../plans/graphql/types';
 import { ReportDetail } from '../../report-details/graphql/types';
 import { UsageYear } from '../../usage-years/graphql/types';
+import { FlowKeys } from '../model';
 
 @ObjectType()
 export class FlowExternalReference {
@@ -176,26 +177,6 @@ export class FlowSearchResultNonPaginated {
   flowsCount: number;
 }
 
-export type FlowSortField =
-  | 'flow.id'
-  | 'flow.versionID'
-  | 'flow.amountUSD'
-  | 'flow.updatedAt'
-  | 'flow.activeStatus'
-  | 'flow.restricted'
-  | 'flow.newMoney'
-  | 'flow.flowDate'
-  | 'flow.decisionDate'
-  | 'flow.firstReportedDate'
-  | 'flow.budgetYear'
-  | 'flow.origAmount'
-  | 'flow.origCurrency'
-  | 'flow.exchangeRate'
-  | 'flow.description'
-  | 'flow.notes'
-  | 'flow.versionStartDate'
-  | 'flow.versionEndDate'
-  | 'flow.createdAt'
-  | 'flow.deletedAt';
+export type FlowSortField = `flow.${FlowKeys}`
 
 export type FlowStatusFilter = 'new' | 'updated' | undefined;

src/domain-services/flows/model.ts

@@ -8,22 +8,35 @@ import type {
 } from '@unocha/hpc-api-core/src/db/util/types';
 import { type SortOrder } from '../../utils/graphql/pagination';
 import { type EntityDirection } from '../base-types';
+import { type FlowObjectType } from '../flow-object/model';
+import { Flow } from './graphql/types';
 
 export type FlowModel = Database['flow'];
 export type FlowInstance = InstanceOfModel<FlowModel>;
 export type FlowWhere = Condition<FlowInstance>;
 export type FlowFieldsDefinition = FieldsOfModel<FlowModel>;
+export type FlowKeys = Extract<keyof FlowInstance, string>;
 export type FlowOrderByCond = OrderByCond<FlowFieldsDefinition>; // Can this be simplified somehow?
 export type UniqueFlowEntity = {
   id: FlowId;
   versionID: number | null;
 };
 
 export type FlowOrderByWithSubEntity = {
-  column: keyof FlowInstance | string;
+  column:
+    | keyof FlowInstance
+    | keyof InstanceOfModel<Database['emergency']>
+    | keyof InstanceOfModel<Database['globalCluster']>
+    | keyof InstanceOfModel<Database['governingEntity']>
+    | keyof InstanceOfModel<Database['location']>
+    | keyof InstanceOfModel<Database['plan']>
+    | keyof InstanceOfModel<Database['planVersion']>
+    | keyof InstanceOfModel<Database['project']>
+    | keyof InstanceOfModel<Database['organization']>
+    | keyof InstanceOfModel<Database['usageYear']>;
   order: SortOrder;
-  entity: string;
-  subEntity?: string;
+  entity: 'flow' | 'externalReference';
+  subEntity?: FlowObjectType | 'planVersion';
   direction?: EntityDirection;
 };