tweak(types): RN-1418: Update EntityType type

packages/datatrak-web-server/src/__tests__/processSurveyResponse.test.ts

@@ -2,7 +2,7 @@
  * Tupaia
  *  Copyright (c) 2017 - 2023 Beyond Essential Systems Pty Ltd
  */
-import { EntityType, QuestionType } from '@tupaia/types';
+import { QuestionType } from '@tupaia/types';
 import { getUniqueSurveyQuestionFileName } from '@tupaia/utils';
 import { generateId } from '@tupaia/database';
 import { processSurveyResponse } from '../routes/SubmitSurveyReponse/processSurveyResponse';
@@ -12,7 +12,7 @@ const mockFindEntityById = async (id: string) => ({
   id: 'theEntityId',
   code: 'theEntityCode',
   name: 'The Entity Name',
-  type: 'facility' as EntityType,
+  type: 'facility',
 });
 
 const optionSetId = 'optionSetId';

packages/datatrak-web-server/src/routes/EntityDescendantsRoute.ts

@@ -4,7 +4,7 @@
  */
 
 import { Route } from '@tupaia/server-boilerplate';
-import { DatatrakWebEntityDescendantsRequest, EntityType, UserAccount } from '@tupaia/types';
+import { DatatrakWebEntityDescendantsRequest, UserAccount } from '@tupaia/types';
 import { TupaiaApiClient } from '@tupaia/api-client';
 import { Request } from 'express';
 import camelcaseKeys from 'camelcase-keys';
@@ -45,7 +45,7 @@ const getRecentEntities = (
 
   const entityTypes = type.split(',');
   const recentEntitiesOfTypes = entityTypes
-    .map(entityType => userRecentEntities[countryCode][entityType as EntityType] ?? [])
+    .map(entityType => userRecentEntities[countryCode][entityType] ?? [])
     .flat();
 
   return recentEntitiesOfTypes;

packages/datatrak-web/src/__tests__/features/Questions/EntityQuestion.test.tsx

@@ -6,7 +6,7 @@ import React, { Ref } from 'react';
 import { rest } from 'msw';
 import { setupServer } from 'msw/node';
 import { screen } from '@testing-library/react';
-import { EntityType } from '@tupaia/types';
+import { EntityTypeEnum } from '@tupaia/types';
 import { spyOnMockRequest } from '../../helpers/spyOnMockRequest';
 import { renderComponent } from '../../helpers/render';
 import { EntityQuestion } from '../../../features/Questions';
@@ -124,7 +124,7 @@ describe('Entity Question', () => {
         config={{
           entity: {
             filter: {
-              type: EntityType.facility,
+              type: EntityTypeEnum.facility,
               parentId: {
                 questionId: 'theParentQuestionId',
               },

packages/entity-server/src/routes/hierarchy/middleware/attachEntityContext.ts

@@ -5,7 +5,7 @@
 import { Request, NextFunction, Response } from 'express';
 import { PermissionsError } from '@tupaia/utils';
 import { ajvValidate, isNotNullish } from '@tupaia/tsutils';
-import { EntityType } from '@tupaia/types';
+import { EntityTypeEnum } from '@tupaia/types';
 import { EntityRecord, EntityFilter } from '@tupaia/server-boilerplate';
 import { MultiEntityRequestBody, MultiEntityRequestBodySchema } from '../types';
 import { extractFilterFromQuery } from './filter';
@@ -30,7 +30,7 @@ const validateEntitiesAndBuildContext = async (
   const { hierarchyName } = req.params;
   // Root type shouldn't be locked into being a project entity, see: https://github.com/beyondessential/tupaia-backlog/issues/2570
   const rootEntity = await req.models.entity.findOne({
-    type: EntityType.project,
+    type: EntityTypeEnum.project,
     code: hierarchyName,
   });
   if (!rootEntity) {
@@ -161,7 +161,7 @@ export const attachEntityFilterContext = async (
   next: NextFunction,
 ) => {
   const rootEntity = await req.models.entity.findOne({
-    type: EntityType.project,
+    type: EntityTypeEnum.project,
     code: req.params.hierarchyName,
   });
 

packages/types/config/models/config.json

@@ -37,7 +37,8 @@
       "MapOverlayConfig": "./models-extra",
       "EntityAttributes": "./models-extra",
       "UserAccountPreferences": "./models-extra",
-      "ProjectConfig": "./models-extra"
+      "ProjectConfig": "./models-extra",
+      "EntityType": "./models-extra"
     }
   }
 }

packages/types/config/models/template.handlebars

@@ -27,7 +27,7 @@ export enum {{convertedName}} {
 {{/inline}}
 /*
  * Tupaia
- * Copyright (c) 2017 - 2020 Beyond Essential Systems Pty Ltd
+ * Copyright (c) 2017 - 2024 Beyond Essential Systems Pty Ltd
  *
  */
 /*

packages/types/generate-models.ts

@@ -71,12 +71,28 @@ const removeUnwantedColumns = (tables: Table[]) =>
     columns: columns.filter(({ name }) => !name.includes('m_row$')), // Remove mvrefresh columns
   }));
 
+/**
+ * @description There is currently no way to rename just one enum definition in the sql-ts library, so we have to do it manually. This is so that we can set columns of type entity_type to be EntityTypeEnum + string
+ */
+const renameEntityTypeEnumDefinition = (enums: any) => {
+  return enums.map((enumDef: any) => {
+    if (enumDef.name === 'entity_type') {
+      return {
+        ...enumDef,
+        convertedName: 'EntityTypeEnum',
+      };
+    }
+    return enumDef;
+  });
+};
 const run = async () => {
   const failOnChanges = process.argv[2] === '--failOnChanges';
 
   // @ts-ignore
   const definitions = await sqlts.toObject(config, db);
 
+  const enums = renameEntityTypeEnumDefinition(definitions.enums);
+
   // Base Model tables should mark columns with defaultValues as non-optional since the default value will be present
   const baseTables = makeDefaultColumnsRequired(definitions.tables);
 
@@ -88,7 +104,7 @@ const run = async () => {
 
   const allTables = removeUnwantedColumns(combineTables(baseTables, createTables, updateTables));
 
-  const tsString = sqlts.fromObject({ ...definitions, tables: allTables }, config);
+  const tsString = sqlts.fromObject({ ...definitions, enums, tables: allTables }, config);
 
   if (failOnChanges) {
     const currentTsString = fs.readFileSync(config.filename, { encoding: 'utf8' });