Rename campaigns date fields (safe-global#1552)

Renames periodStart as startDate.
Renames periodEnd as endDate.
Renames activities as activitiesMetadata.

Author: hectorgomezv

src/domain/locking/entities/__tests__/campaign.builder.ts

@@ -8,11 +8,11 @@ export function campaignBuilder(): IBuilder<Campaign> {
     .with('campaignId', faker.string.uuid())
     .with('name', faker.word.words())
     .with('description', faker.lorem.sentence())
-    .with('periodStart', faker.date.recent())
-    .with('periodEnd', faker.date.future())
+    .with('startDate', faker.date.recent())
+    .with('endDate', faker.date.future())
     .with('lastUpdated', faker.date.recent())
     .with(
-      'activities',
+      'activitiesMetadata',
       Array.from({ length: faker.number.int({ min: 0, max: 5 }) }, () =>
         activityMetadataBuilder().build(),
       ),

src/domain/locking/entities/campaign.entity.ts

@@ -8,10 +8,10 @@ export const CampaignSchema = z.object({
   campaignId: z.string(),
   name: z.string(),
   description: z.string(),
-  periodStart: z.coerce.date(),
-  periodEnd: z.coerce.date(),
+  startDate: z.coerce.date(),
+  endDate: z.coerce.date(),
   lastUpdated: z.coerce.date(),
-  activities: z.array(ActivityMetadataSchema).nullish().default(null),
+  activitiesMetadata: z.array(ActivityMetadataSchema).nullish().default(null),
 });
 
 export const CampaignPageSchema = buildPageSchema(CampaignSchema);

src/domain/locking/entities/schemas/__tests__/campaign.schema.spec.ts

@@ -11,19 +11,18 @@ describe('CampaignSchema', () => {
     expect(result.success).toBe(true);
   });
 
-  it.each([
-    'periodStart' as const,
-    'periodEnd' as const,
-    'lastUpdated' as const,
-  ])(`should coerce %s to a date`, (field) => {
-    const campaign = campaignBuilder().build();
+  it.each(['startDate' as const, 'endDate' as const, 'lastUpdated' as const])(
+    `should coerce %s to a date`,
+    (field) => {
+      const campaign = campaignBuilder().build();
 
-    const result = CampaignSchema.safeParse(campaign);
+      const result = CampaignSchema.safeParse(campaign);
 
-    expect(result.success && result.data[field]).toStrictEqual(
-      new Date(campaign[field]),
-    );
-  });
+      expect(result.success && result.data[field]).toStrictEqual(
+        new Date(campaign[field]),
+      );
+    },
+  );
 
   it('should not validate an invalid campaign', () => {
     const campaign = { invalid: 'campaign' };
@@ -55,12 +54,12 @@ describe('CampaignSchema', () => {
         },
         {
           code: 'invalid_date',
-          path: ['periodStart'],
+          path: ['startDate'],
           message: 'Invalid date',
         },
         {
           code: 'invalid_date',
-          path: ['periodEnd'],
+          path: ['endDate'],
           message: 'Invalid date',
         },
         {

src/domain/locking/entities/schemas/campaign.schema.ts

@@ -5,8 +5,8 @@ export const CampaignSchema = z.object({
   campaignId: z.string(),
   name: z.string(),
   description: z.string(),
-  periodStart: z.coerce.date(),
-  periodEnd: z.coerce.date(),
+  startDate: z.coerce.date(),
+  endDate: z.coerce.date(),
   lastUpdated: z.coerce.date(),
-  activities: z.array(ActivityMetadataSchema).nullish().default(null),
+  activitiesMetadata: z.array(ActivityMetadataSchema).nullish().default(null),
 });

src/routes/locking/entities/campaign.entity.ts

@@ -10,11 +10,11 @@ export class Campaign implements DomainCampaign {
   @ApiProperty()
   description!: string;
   @ApiProperty({ type: String })
-  periodStart!: Date;
+  startDate!: Date;
   @ApiProperty({ type: String })
-  periodEnd!: Date;
+  endDate!: Date;
   @ApiProperty({ type: String })
   lastUpdated!: Date;
   @ApiProperty({ type: [ActivityMetadata] })
-  activities!: ActivityMetadata[] | null;
+  activitiesMetadata!: ActivityMetadata[] | null;
 }

src/routes/locking/locking.controller.spec.ts

@@ -86,8 +86,8 @@ describe('Locking (Unit)', () => {
         .expect(200)
         .expect({
           ...campaign,
-          periodStart: campaign.periodStart.toISOString(),
-          periodEnd: campaign.periodEnd.toISOString(),
+          startDate: campaign.startDate.toISOString(),
+          endDate: campaign.endDate.toISOString(),
           lastUpdated: campaign.lastUpdated.toISOString(),
         });
     });
@@ -117,8 +117,8 @@ describe('Locking (Unit)', () => {
           previous: null,
           results: campaignsPage.results.map((campaign) => ({
             ...campaign,
-            periodStart: campaign.periodStart.toISOString(),
-            periodEnd: campaign.periodEnd.toISOString(),
+            startDate: campaign.startDate.toISOString(),
+            endDate: campaign.endDate.toISOString(),
             lastUpdated: campaign.lastUpdated.toISOString(),
           })),
         });
@@ -179,8 +179,8 @@ describe('Locking (Unit)', () => {
           previous: null,
           results: campaignsPage.results.map((campaign) => ({
             ...campaign,
-            periodStart: campaign.periodStart.toISOString(),
-            periodEnd: campaign.periodEnd.toISOString(),
+            startDate: campaign.startDate.toISOString(),
+            endDate: campaign.endDate.toISOString(),
             lastUpdated: campaign.lastUpdated.toISOString(),
           })),
         });