Add ActivityMetadata to Campaign entity (safe-global#1546)

Adds ActivityMetadata entity and validation schema.
Adds activities array to the Campaign entity.

Author: hectorgomezv

src/domain/locking/entities/__tests__/activity-metadata.builder.ts

@@ -0,0 +1,11 @@
+import { Builder, IBuilder } from '@/__tests__/builder';
+import { ActivityMetadata } from '@/domain/locking/entities/activity-metadata.entity';
+import { faker } from '@faker-js/faker';
+
+export function activityMetadataBuilder(): IBuilder<ActivityMetadata> {
+  return new Builder<ActivityMetadata>()
+    .with('campaignId', faker.string.uuid())
+    .with('name', faker.word.words())
+    .with('description', faker.lorem.sentence())
+    .with('maxPoints', faker.string.numeric());
+}

src/domain/locking/entities/activity-metadata.entity.ts

@@ -0,0 +1,11 @@
+import { NumericStringSchema } from '@/validation/entities/schemas/numeric-string.schema';
+import { z } from 'zod';
+
+export type ActivityMetadata = z.infer<typeof ActivityMetadataSchema>;
+
+export const ActivityMetadataSchema = z.object({
+  campaignId: z.string(),
+  name: z.string(),
+  description: z.string(),
+  maxPoints: NumericStringSchema,
+});

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

@@ -1,3 +1,4 @@
+import { ActivityMetadataSchema } from '@/domain/locking/entities/activity-metadata.entity';
 import { z } from 'zod';
 
 export type Campaign = z.infer<typeof CampaignSchema>;
@@ -9,5 +10,5 @@ export const CampaignSchema = z.object({
   periodStart: z.coerce.date(),
   periodEnd: z.coerce.date(),
   lastUpdated: z.coerce.date(),
-  // TODO: include 'activities' field once the structure is defined.
+  activities: z.array(ActivityMetadataSchema).nullish().default(null),
 });

src/domain/locking/entities/schemas/__tests__/activity-metadata.schema.spec.ts

@@ -0,0 +1,71 @@
+import { activityMetadataBuilder } from '@/domain/locking/entities/__tests__/activity-metadata.builder';
+import { ActivityMetadataSchema } from '@/domain/locking/entities/activity-metadata.entity';
+import { faker } from '@faker-js/faker';
+import { ZodError } from 'zod';
+
+describe('ActivityMetadataSchema', () => {
+  it('should validate a valid activity metadata', () => {
+    const activityMetadata = activityMetadataBuilder().build();
+
+    const result = ActivityMetadataSchema.safeParse(activityMetadata);
+
+    expect(result.success).toBe(true);
+  });
+
+  it('should not allow a non-numeric string for maxPoints', () => {
+    const activityMetadata = activityMetadataBuilder()
+      .with('maxPoints', faker.string.alpha())
+      .build();
+
+    const result = ActivityMetadataSchema.safeParse(activityMetadata);
+
+    expect(!result.success && result.error).toStrictEqual(
+      new ZodError([
+        {
+          code: 'custom',
+          message: 'Invalid base-10 numeric string',
+          path: ['maxPoints'],
+        },
+      ]),
+    );
+  });
+
+  it('should not validate an invalid activity metadata', () => {
+    const activityMetadata = { invalid: 'activity metadata' };
+
+    const result = ActivityMetadataSchema.safeParse(activityMetadata);
+
+    expect(!result.success && result.error).toStrictEqual(
+      new ZodError([
+        {
+          code: 'invalid_type',
+          expected: 'string',
+          received: 'undefined',
+          path: ['campaignId'],
+          message: 'Required',
+        },
+        {
+          code: 'invalid_type',
+          expected: 'string',
+          received: 'undefined',
+          path: ['name'],
+          message: 'Required',
+        },
+        {
+          code: 'invalid_type',
+          expected: 'string',
+          received: 'undefined',
+          path: ['description'],
+          message: 'Required',
+        },
+        {
+          code: 'invalid_type',
+          expected: 'string',
+          received: 'undefined',
+          path: ['maxPoints'],
+          message: 'Required',
+        },
+      ]),
+    );
+  });
+});

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

@@ -0,0 +1,12 @@
+import { ActivityMetadataSchema } from '@/domain/locking/entities/activity-metadata.entity';
+import { z } from 'zod';
+
+export const CampaignSchema = z.object({
+  campaignId: z.string(),
+  name: z.string(),
+  description: z.string(),
+  periodStart: z.coerce.date(),
+  periodEnd: z.coerce.date(),
+  lastUpdated: z.coerce.date(),
+  activities: z.array(ActivityMetadataSchema).nullish().default(null),
+});