Migrate remaining enums to makeEnum (#2904)

Co-authored-by: Wes Cutting <[email protected]>
Co-authored-by: Carson Full <[email protected]>

src/common/sensitivity.enum.ts

@@ -1,18 +1,15 @@
 import { applyDecorators } from '@nestjs/common';
-import { Field, FieldOptions, registerEnumType } from '@nestjs/graphql';
+import { Field, FieldOptions } from '@nestjs/graphql';
 import { Transform } from 'class-transformer';
 import { uniq } from 'lodash';
 import { rankSens } from '../core/database/query';
 import { DbSort } from './db-sort.decorator';
+import { EnumType, makeEnum } from './make-enum';
 
-export enum Sensitivity {
-  Low = 'Low',
-  Medium = 'Medium',
-  High = 'High',
-}
-
-registerEnumType(Sensitivity, {
+export type Sensitivity = EnumType<typeof Sensitivity>;
+export const Sensitivity = makeEnum({
   name: 'Sensitivity',
+  values: ['Low', 'Medium', 'High'],
 });
 
 export const SensitivityField = (options: FieldOptions = {}) =>

src/components/admin/admin.service.ts

@@ -1,12 +1,12 @@
 import { Injectable, OnApplicationBootstrap } from '@nestjs/common';
 import { DateTime } from 'luxon';
-import { ID, ServerException } from '~/common';
+import { ID, Role, ServerException } from '~/common';
 import { ConfigService } from '~/core/config/config.service';
 import { Transactional } from '~/core/database';
 import { ILogger, Logger } from '~/core/logger';
 import { AuthenticationService } from '../authentication';
 import { CryptoService } from '../authentication/crypto.service';
-import { Powers, Role } from '../authorization/dto';
+import { Power } from '../authorization/dto';
 import { AdminRepository } from './admin.repository';
 
 @Injectable()
@@ -84,8 +84,7 @@ export class AdminService implements OnApplicationBootstrap {
       });
 
       // set root user label & give all powers
-      const powers = Object.keys(Powers);
-      await this.repo.setUserLabel(powers, id);
+      await this.repo.setUserLabel([...Power.values], id);
     }
 
     // TODO do this a different way. Using a global like this can cause race conditions.

src/components/authentication/login.resolver.ts

@@ -9,7 +9,7 @@ import {
 import { stripIndent } from 'common-tags';
 import { AnonSession, GqlContextType, Session } from '../../common';
 import { Loader, LoaderOf } from '../../core';
-import { Powers as Power, Privileges } from '../authorization';
+import { Power, Privileges } from '../authorization';
 import { User, UserLoader } from '../user';
 import { AuthenticationService } from './authentication.service';
 import { LoginInput, LoginOutput, LogoutOutput } from './dto';

src/components/authentication/register.resolver.ts

@@ -9,7 +9,7 @@ import {
 import { stripIndent } from 'common-tags';
 import { AnonSession, GqlContextType, Session } from '../../common';
 import { Loader, LoaderOf } from '../../core';
-import { Powers as Power, Privileges } from '../authorization';
+import { Power, Privileges } from '../authorization';
 import { User, UserLoader } from '../user';
 import { AuthenticationService } from './authentication.service';
 import { RegisterInput, RegisterOutput } from './dto';

src/components/authentication/session.resolver.ts

@@ -13,7 +13,7 @@ import {
   UnauthenticatedException,
 } from '../../common';
 import { ConfigService, ILogger, Loader, LoaderOf, Logger } from '../../core';
-import { Powers as Power, Privileges } from '../authorization';
+import { Power, Privileges } from '../authorization';
 import { User, UserLoader } from '../user';
 import { AuthenticationService } from './authentication.service';
 import { SessionOutput } from './dto';

src/components/authorization/authorization.resolver.ts

@@ -1,6 +1,6 @@
 import { Query, Resolver } from '@nestjs/graphql';
 import { AnonSession, Session } from '~/common';
-import { Powers as Power } from './dto';
+import { Power } from './dto';
 import { Privileges } from './policy';
 
 @Resolver()

src/components/authorization/dto/index.ts

@@ -1,2 +1,2 @@
 export * from './role.dto';
-export * from './powers';
+export * from './power.enum';

src/components/authorization/dto/power.enum.ts

@@ -0,0 +1,111 @@
+import { EnumType, makeEnum } from '~/common';
+
+export type Power = EnumType<typeof Power>;
+export const Power = makeEnum({
+  name: 'Power',
+  values: [
+    'BetaFeatures',
+    'CreateEthnoArt',
+    'CreateFieldRegion',
+    'CreateFieldZone',
+    'CreateFilm',
+    'CreateFundingAccount',
+    'CreateLanguage',
+    'CreateLiteracyMaterial',
+    'CreateLocation',
+    'CreateOrganization',
+    'CreatePartner',
+    'CreateProject',
+    'CreateSong',
+    'CreateStory',
+    'CreateUser',
+    {
+      value: 'CreateBudget',
+      deprecationReason: 'Use `Project.budget` instead',
+    },
+    {
+      value: 'CreateBudgetRecord',
+      deprecationReason: 'Use `Project.budget` instead',
+    },
+    {
+      value: 'CreateCeremony',
+      deprecationReason: 'Use `Engagement.ceremony` instead',
+    },
+    {
+      value: 'CreateChangeRequest',
+      deprecationReason: 'Use `Project.changeRequests` instead',
+    },
+    {
+      value: 'CreateDirectory',
+      deprecationReason: 'Use something else instead',
+    },
+    {
+      value: 'CreateEducation',
+      deprecationReason: 'Use `User.education` instead',
+    },
+    {
+      value: 'CreateEthnologueLanguage',
+      deprecationReason:
+        'Just check `CreateLanguage` instead. This is a sub-object ',
+    },
+    { value: 'CreateFile', deprecationReason: 'Use something else instead' },
+    {
+      value: 'CreateFileVersion',
+      deprecationReason: 'Use something else instead',
+    },
+    {
+      value: 'CreateInternshipEngagement',
+      deprecationReason: 'Use `Project.engagements` instead',
+    },
+    {
+      value: 'CreateLanguageEngagement',
+      deprecationReason: 'Use `Project.engagements` instead',
+    },
+    {
+      value: 'CreatePartnership',
+      deprecationReason: 'Use `Project.partnerships` instead ',
+    },
+    { value: 'CreatePost', deprecationReason: 'Use `X.posts` instead' },
+    {
+      value: 'CreateProduct',
+      deprecationReason: 'Use `Engagement.products` instead',
+    },
+    {
+      value: 'CreateProjectEngagement',
+      deprecationReason: 'Use `Project.engagements` instead',
+    },
+    {
+      value: 'CreateProjectMember',
+      deprecationReason: 'Use `Project.team` instead',
+    },
+    {
+      value: 'CreateTranslationEngagement',
+      deprecationReason: 'Use `Project.engagements` instead',
+    },
+    {
+      value: 'CreateUnavailability',
+      deprecationReason: 'Use `User.unavailabilities` instead',
+    },
+    {
+      value: 'GrantInternRole',
+      deprecationReason: 'Use `AuthorizedRoles.Intern` instead',
+    },
+    {
+      value: 'GrantLiaisonRole',
+      deprecationReason: 'Use `AuthorizedRoles.Liaison` instead',
+    },
+    {
+      value: 'GrantMentorRole',
+      deprecationReason: 'Use `AuthorizedRoles.Mentor` instead',
+    },
+    {
+      value: 'GrantRegionalCommunicationsCoordinatorRole',
+      deprecationReason:
+        'Use `AuthorizedRoles.RegionalCommunicationsCoordinator` instead',
+    },
+    {
+      value: 'GrantTranslatorRole',
+      deprecationReason: 'Use `AuthorizedRoles.Translator` instead',
+    },
+  ],
+});

src/components/authorization/missing-power.exception.ts

@@ -1,9 +1,9 @@
-import { UnauthorizedException } from '../../common/exceptions';
-import { Powers } from './dto/powers';
+import { UnauthorizedException } from '~/common';
+import { Power } from './dto';
 
 export class MissingPowerException extends UnauthorizedException {
   constructor(
-    readonly power: Powers,
+    readonly power: Power,
     message = `Missing required power: ${power}`,
     previous?: Error,
   ) {

src/components/authorization/policy/executor/user-privileges.ts

@@ -6,7 +6,7 @@ import {
   SecuredPropsPlusExtraKey,
   Session,
 } from '~/common';
-import { Powers as Power } from '../../dto/powers';
+import { Power } from '../../dto';
 import { MissingPowerException } from '../../missing-power.exception';
 import { ChildListAction, ChildSingleAction, PropAction } from '../actions';
 import { ResourceObjectContext } from '../object.type';

src/components/authorization/policy/policy.factory.ts

@@ -6,10 +6,9 @@ import { Injectable, OnModuleInit } from '@nestjs/common';
 import { pick, startCase } from 'lodash';
 import { DeepWritable, Writable } from 'ts-essentials';
 import { keys as keysOf } from 'ts-transformer-keys';
-import { EnhancedResource, many, mapFromList } from '~/common';
+import { EnhancedResource, many, mapFromList, Role } from '~/common';
 import { ResourcesHost } from '~/core/resources';
-import { Powers as Power } from '../dto/powers';
-import { Role } from '../dto/role.dto';
+import { Power } from '../dto';
 import { ChildListAction, ChildSingleAction } from './actions';
 import { extract, Permission, Permissions } from './builder/perm-granter';
 import {

src/components/budget/dto/budget-status.enum.ts

@@ -1,10 +1,7 @@
-import { registerEnumType } from '@nestjs/graphql';
+import { EnumType, makeEnum } from '~/common';
 
-export enum BudgetStatus {
-  Pending = 'Pending',
-  Current = 'Current',
-  Superceded = 'Superceded',
-  Rejected = 'Rejected',
-}
-
-registerEnumType(BudgetStatus, { name: 'BudgetStatus' });
+export type BudgetStatus = EnumType<typeof BudgetStatus>;
+export const BudgetStatus = makeEnum({
+  name: 'BudgetStatus',
+  values: ['Pending', 'Current', 'Superceded', 'Rejected'],
+});

src/components/budget/handlers/update-project-current-budget-status.handler.ts

@@ -15,7 +15,7 @@ export class UpdateProjectBudgetStatusHandler
     if (!updates.step) {
       return;
     }
-    let budgetStatus = BudgetStatus.Current;
+    let budgetStatus: BudgetStatus = BudgetStatus.Current;
     if (
       stepToStatus(updates.step) !== ProjectStatus.Active ||
       previous.status === ProjectStatus.Active

src/components/ceremony/dto/ceremony-type.enum.ts

@@ -0,0 +1,12 @@
+import { EnumType, makeEnum } from '~/common';
+
+export type CeremonyType = EnumType<typeof CeremonyType>;
+export const CeremonyType = makeEnum({
+  name: 'CeremonyType',
+  values: [
+    // Language Engagements can have dedications
+    'Dedication',
+    // Internship Engagements can have certifications
+    'Certification',
+  ],
+});

src/components/ceremony/dto/ceremony.dto.ts

@@ -11,7 +11,7 @@ import {
   Sensitivity,
   SensitivityField,
 } from '../../../common';
-import { CeremonyType } from './type.enum';
+import { CeremonyType } from './ceremony-type.enum';
 
 @RegisterResource()
 @Calculated()

src/components/ceremony/dto/create-ceremony.dto.ts

@@ -1,6 +1,6 @@
 import { Field, InputType } from '@nestjs/graphql';
 import { CalendarDate, DateField } from '../../../common';
-import { CeremonyType } from './type.enum';
+import { CeremonyType } from './ceremony-type.enum';
 
 @InputType()
 export abstract class CreateCeremony {

src/components/ceremony/dto/index.ts

@@ -1,4 +1,5 @@
 export * from './create-ceremony.dto';
 export * from './list-ceremony.dto';
 export * from './ceremony.dto';
+export * from './ceremony-type.enum';
 export * from './update-ceremony.dto';

src/components/ceremony/dto/list-ceremony.dto.ts

@@ -1,7 +1,7 @@
 import { Field, InputType, ObjectType } from '@nestjs/graphql';
 import { FilterField, PaginatedList, SortablePaginationInput } from '~/common';
+import { CeremonyType } from './ceremony-type.enum';
 import { Ceremony } from './ceremony.dto';
-import { CeremonyType } from './type.enum';
 
 @InputType()
 export abstract class CeremonyFilters {