VIA-629 SB & EO Add CAMPAIGNS object to config object, along with converter.

Author: acerathereinspirative-nhs-nvir

src/services/content-api/types.ts

@@ -220,3 +220,10 @@ export type ContentApiVaccinationsResponse = {
   ];
   webpage: string;
 };
+
+export interface Campaign {
+  start: Date;
+  end: Date;
+}
+
+export type Campaigns = Record<string, Campaign[]>;

src/utils/config.test.ts

@@ -86,6 +86,33 @@ describe("lazyConfig", () => {
     expect(actual).toBe(99);
   });
 
+  it("should convert CAMPAIGNS to a Campaigns ", async () => {
+    setupTestEnvVars("test/");
+    process.env.CAMPAIGNS = JSON.stringify({
+      covid: [
+        { start: "20251112", end: "20260301" },
+        { start: "20260901", end: "20270301" },
+      ],
+      flu: [
+        { start: "20251112", end: "20260301" },
+        { start: "20260901", end: "20270301" },
+      ],
+    });
+
+    const actual = await config.CAMPAIGNS;
+
+    expect(actual).toStrictEqual({
+      covid: [
+        { start: new Date("2025-11-12"), end: new Date("2026-03-01") },
+        { start: new Date("2026-09-01"), end: new Date("2027-03-01") },
+      ],
+      flu: [
+        { start: new Date("2025-11-12"), end: new Date("2026-03-01") },
+        { start: new Date("2026-09-01"), end: new Date("2027-03-01") },
+      ],
+    });
+  });
+
   it("should throw for invalid URL", async () => {
     setupTestEnvVars("test/");
     process.env.APIM_AUTH_URL = "not-a-url";
@@ -104,6 +131,26 @@ describe("lazyConfig", () => {
     }).rejects.toThrow(ConfigError);
   });
 
+  it("should throw for invalid CAMPAIGNS", async () => {
+    setupTestEnvVars("test/");
+    process.env.CAMPAIGNS = "Sausages";
+
+    await expect(async () => {
+      await config.CAMPAIGNS;
+    }).rejects.toThrow(ConfigError);
+  });
+
+  it("should throw for CAMPAIGNS with invalid date", async () => {
+    setupTestEnvVars("test/");
+    process.env.CAMPAIGNS = JSON.stringify({
+      covid: [{ start: "20251312", end: "20260301" }],
+    });
+
+    await expect(async () => {
+      await config.CAMPAIGNS;
+    }).rejects.toThrow(ConfigError);
+  });
+
   it("should reuse config values between subsequent calls", async () => {
     setupTestEnvVars("test/");
     const mockGetSSMParam = (getSecret as jest.Mock).mockImplementation(() => randomString(5));

src/utils/config.ts

@@ -1,12 +1,14 @@
+import { Campaigns } from "@src/services/content-api/types";
 import { EligibilityApiError } from "@src/services/eligibility-api/gateway/exceptions";
+import { UtcDateFromStringSchema } from "@src/utils/date";
 import getSecret from "@src/utils/get-secret";
 import { logger } from "@src/utils/logger";
 import { retry } from "es-toolkit";
 import { Logger } from "pino";
 
 const log: Logger = logger.child({ module: "lazy-config" });
 
-export type ConfigValue = string | number | boolean | URL | undefined;
+export type ConfigValue = string | number | boolean | URL | Campaigns | undefined;
 
 export interface AppConfig {
   // SecretsManager secrets stored as SecureStrings
@@ -32,6 +34,7 @@ export interface AppConfig {
   IS_APIM_AUTH_ENABLED: boolean;
   APIM_AUTH_URL: URL;
   APIM_KEY_ID: string;
+  CAMPAIGNS: Campaigns;
 }
 
 /**
@@ -86,6 +89,29 @@ class Config {
     if (lower === "false") return false;
     return undefined;
   };
+  private static readonly toCampaigns = (rawValue: string): Campaigns | undefined => {
+    try {
+      interface RawCampaign {
+        start: string;
+        end: string;
+      }
+
+      const rawObj: Record<string, RawCampaign[]> = JSON.parse(rawValue);
+
+      const parsedSchedule: Campaigns = {};
+
+      for (const [vaccineName, campaigns] of Object.entries(rawObj)) {
+        parsedSchedule[vaccineName] = campaigns.map((c) => ({
+          start: UtcDateFromStringSchema.parse(c.start),
+          end: UtcDateFromStringSchema.parse(c.end),
+        }));
+      }
+
+      return parsedSchedule;
+    } catch {
+      return undefined;
+    }
+  };
   static readonly converters: Record<string, (value: string) => ConfigValue> = {
     APIM_AUTH_URL: Config.toUrl,
     CONTENT_API_ENDPOINT: Config.toUrl,
@@ -97,6 +123,7 @@ class Config {
     NHS_APP_REDIRECT_LOGIN_URL: Config.toUrl,
     IS_APIM_AUTH_ENABLED: Config.toBoolean,
     MAX_SESSION_AGE_MINUTES: Config.toNumber,
+    CAMPAIGNS: Config.toCampaigns,
   };
 
   /**

src/utils/date.test.ts

@@ -0,0 +1,31 @@
+import { UtcDateFromStringSchema } from "@src/utils/date";
+
+describe("UtcDateFromStringSchema", () => {
+  it("should parse winter date", () => {
+    const actual = UtcDateFromStringSchema.parse("20260101");
+
+    expect(actual).toEqual(new Date("2026-01-01"));
+  });
+
+  it("should parse summer date", () => {
+    const actual = UtcDateFromStringSchema.parse("20260601");
+
+    expect(actual).toEqual(new Date("2026-06-01"));
+  });
+
+  it("should throw on invalid date", () => {
+    const given = "20261301";
+
+    expect(() => {
+      UtcDateFromStringSchema.parse(given);
+    }).toThrow();
+  });
+
+  it("should throw on badly formed date", () => {
+    const given = "Sausages";
+
+    expect(() => {
+      UtcDateFromStringSchema.parse(given);
+    }).toThrow();
+  });
+});

src/utils/date.ts

@@ -0,0 +1,17 @@
+import { z } from "zod";
+
+export const UtcDateFromStringSchema = z
+  .string()
+  .regex(/^\d{8}$/, "Date must be in YYYYMMDD format")
+  .transform((str, ctx) => {
+    const year = parseInt(str.slice(0, 4));
+    const month = parseInt(str.slice(4, 6)); // 1-indexed (01 = Jan)
+    const day = parseInt(str.slice(6, 8));
+    const utcTimestamp = Date.UTC(year, month - 1, day);
+    const date = new Date(utcTimestamp);
+    if (date.getUTCFullYear() !== year || date.getUTCMonth() !== month - 1 || date.getUTCDate() !== day) {
+      ctx.addIssue("invalid_value");
+      return z.NEVER;
+    }
+    return date;
+  });