Added Engagement.milestoneReached (#3338)

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

dbschema/engagement.esdl

@@ -80,6 +80,10 @@ module default {
     historicGoal: str {
       annotation deprecated := "Legacy data";
     }
+
+    milestoneReached: Language::Milestone {
+      default := Language::Milestone.Unknown;
+    };
 
     # I want ceremony to be automatically created when engagement is created.
     # Using computed & trigger to do this, because properties with default expressions

dbschema/language.esdl

@@ -101,6 +101,16 @@ module default {
     constraint expression on (__subject__ >= 0);
   }
 }
+
+module Language {
+  scalar type Milestone extending enum<
+    Unknown,
+    None,
+    OldTestament,
+    NewTestament,
+    FullBible,
+  >;
+}
 
 module Ethnologue {
   type Language extending Project::ContextAware {

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

@@ -6,6 +6,7 @@ import { keys as keysOf } from 'ts-transformer-keys';
 import { CalendarDate, DateField, ID, IdField } from '~/common';
 import { ChangesetIdField } from '../../changeset';
 import { CreateDefinedFileVersionInput } from '../../file/dto';
+import { LanguageMilestone } from '../../language/dto';
 import { ProductMethodology } from '../../product/dto';
 import { InternshipEngagement, LanguageEngagement } from './engagement.dto';
 import { InternshipPosition } from './intern-position.enum';
@@ -70,6 +71,9 @@ export abstract class CreateLanguageEngagement extends CreateEngagement {
 
   @Field({ nullable: true })
   readonly historicGoal?: string;
+
+  @Field(() => LanguageMilestone, { nullable: true })
+  readonly milestoneReached?: LanguageMilestone;
 }
 
 @InputType()

src/components/engagement/dto/engagement.dto.ts

@@ -28,6 +28,7 @@ import { e } from '~/core/edgedb';
 import { LinkTo, RegisterResource } from '~/core/resources';
 import { ChangesetAware } from '../../changeset/dto';
 import { Commentable } from '../../comments/dto';
+import { SecuredLanguageMilestone } from '../../language/dto';
 import { Product, SecuredMethodologies } from '../../product/dto';
 import {
   InternshipProject,
@@ -189,6 +190,9 @@ export class LanguageEngagement extends Engagement {
 
   @Field()
   readonly historicGoal: SecuredStringNullable;
+
+  @Field(() => SecuredLanguageMilestone)
+  readonly milestoneReached: SecuredLanguageMilestone;
 }
 
 @RegisterResource({ db: e.InternshipEngagement })

src/components/engagement/dto/update-engagement.dto.ts

@@ -12,6 +12,7 @@ import {
 } from '~/common';
 import { ChangesetIdField } from '../../changeset';
 import { CreateDefinedFileVersionInput } from '../../file/dto';
+import { LanguageMilestone } from '../../language/dto';
 import { ProductMethodology } from '../../product/dto';
 import { InternshipEngagement, LanguageEngagement } from './engagement.dto';
 import { InternshipPosition } from './intern-position.enum';
@@ -76,6 +77,9 @@ export abstract class UpdateLanguageEngagement extends UpdateEngagement {
 
   @Field({ nullable: true })
   readonly historicGoal?: string;
+
+  @Field(() => LanguageMilestone, { nullable: true })
+  readonly milestoneReached?: LanguageMilestone;
 }
 
 @InputType()

src/components/engagement/engagement.edgedb.repository.ts

@@ -45,6 +45,7 @@ const languageExtraHydrate = {
   paratextRegistryId: true,
   pnp: true,
   historicGoal: true,
+  milestoneReached: true,
 } as const;
 
 const internshipExtraHydrate = {

src/components/engagement/engagement.module.ts

@@ -18,6 +18,7 @@ import * as handlers from './handlers';
 import { InternshipEngagementResolver } from './internship-engagement.resolver';
 import { InternshipPositionResolver } from './internship-position.resolver';
 import { LanguageEngagementResolver } from './language-engagement.resolver';
+import { AddMilestoneReachedMigration } from './migrations/add-milestone-reached.migration';
 import { FixNullMethodologiesMigration } from './migrations/fix-null-methodologies.migration';
 import { EngagementProductConnectionResolver } from './product-connection.resolver';
 
@@ -44,6 +45,7 @@ import { EngagementProductConnectionResolver } from './product-connection.resolv
     EngagementLoader,
     ...Object.values(handlers),
     FixNullMethodologiesMigration,
+    AddMilestoneReachedMigration,
   ],
   exports: [EngagementService, EngagementRepository],
 })

src/components/engagement/migrations/add-milestone-reached.migration.ts

@@ -0,0 +1,9 @@
+import { BaseMigration, Migration } from '~/core/database';
+import { LanguageEngagement } from '../dto';
+
+@Migration('2024-12-12T10:00:00')
+export class AddMilestoneReachedMigration extends BaseMigration {
+  async up() {
+    await this.addProperty(LanguageEngagement, 'milestoneReached', 'Unknown');
+  }
+}

src/components/language/dto/index.ts

@@ -4,3 +4,4 @@ export * from './language.dto';
 export * from './update-language.dto';
 export * from './delete-language.dto';
 export * from './first-scripture.dto';
+export * from './language-milestone.enum';

src/components/language/dto/language-milestone.enum.ts

@@ -0,0 +1,15 @@
+import { ObjectType } from '@nestjs/graphql';
+import { EnumType, makeEnum, SecuredEnum } from '~/common';
+
+export type LanguageMilestone = EnumType<typeof LanguageMilestone>;
+export const LanguageMilestone = makeEnum({
+  name: 'LanguageMilestone',
+  values: ['Unknown', 'None', 'OldTestament', 'NewTestament', 'FullBible'],
+});
+
+@ObjectType({
+  description: SecuredEnum.descriptionFor('a language milestone'),
+})
+export class SecuredLanguageMilestone extends SecuredEnum(LanguageMilestone, {
+  nullable: true,
+}) {}