CCM-12869: Rename Specification to Pack and SpecificationGroup to Specification

Author: m-houston

packages/events/src/__tests__/events/specification-examples.ts

@@ -1,135 +1,136 @@
 import {
   EnvelopeId,
-  SpecificaitonGroupId,
+  Pack,
+  PackId,
+  SpecificaitonId,
   Specification,
-  SpecificationGroup,
-  SpecificationId,
 } from "@nhsdigital/nhs-notify-schemas-supplier-config/src/domain/specification";
 import { Version } from "@nhsdigital/nhs-notify-schemas-supplier-config/src/domain/common";
 
-const bauStandardC5: Specification = {
-  id: SpecificationId("bau-standard-c5"),
+const bauStandardC5: Pack = {
+  id: PackId("bau-standard-c5"),
   name: "BAU Standard Letter C5",
   status: "PUBLISHED",
   version: Version("1.0.0"),
   createdAt: new Date("2023-01-01T00:00:00Z"),
   updatedAt: new Date("2023-01-01T00:00:00Z"),
-  specificationType: "LETTER_STANDARD",
-  pack: {
+  assembly: {
     envelopeId: EnvelopeId("envelope-nhs-c5-economy"),
   },
 };
 
-const bauStandardC4: Specification = {
-  id: SpecificationId("bau-standard-c4"),
+const bauStandardC4: Pack = {
+  id: PackId("bau-standard-c4"),
   name: "BAU Standard Letter C4",
   status: "PUBLISHED",
   version: Version("1.0.0"),
   createdAt: new Date("2023-01-01T00:00:00Z"),
   updatedAt: new Date("2023-01-01T00:00:00Z"),
-  specificationType: "LETTER_STANDARD",
-  pack: {
+  assembly: {
     envelopeId: EnvelopeId("envelope-nhs-c4-economy"),
   },
 };
 
-const braille: Specification = {
-  id: SpecificationId("braille"),
+const braille: Pack = {
+  id: PackId("braille"),
   name: "Braille Letter",
   status: "PUBLISHED",
   version: Version("1.0.0"),
   createdAt: new Date("2023-01-01T00:00:00Z"),
   updatedAt: new Date("2023-01-01T00:00:00Z"),
-  specificationType: "LETTER_BRAILLE",
+  assembly: {
+    features: ["BRAILLE"],
+  },
 };
 
-const audio: Specification = {
-  id: SpecificationId("audio"),
+const audio: Pack = {
+  id: PackId("audio"),
   name: "Audio Letter",
   status: "PUBLISHED",
   version: Version("1.0.0"),
   createdAt: new Date("2023-01-01T00:00:00Z"),
   updatedAt: new Date("2023-01-01T00:00:00Z"),
-  specificationType: "LETTER_AUDIO",
+  assembly: {
+    features: ["AUDIO"],
+  },
 };
 
-const sameDay: Specification = {
-  id: SpecificationId("same-day"),
+const sameDay: Pack = {
+  id: PackId("same-day"),
   name: "Same Day Letter",
   status: "PUBLISHED",
   version: Version("1.0.0"),
   createdAt: new Date("2023-01-01T00:00:00Z"),
   updatedAt: new Date("2023-01-01T00:00:00Z"),
-  specificationType: "LETTER_SAME_DAY",
-  pack: {
+  assembly: {
     envelopeId: EnvelopeId("envelope-nhs-c4-same-day"),
   },
 };
 
-const digitrials1: Specification = {
-  id: SpecificationId("digitrials1"),
+const digitrials1: Pack = {
+  id: PackId("digitrials1"),
   name: "Digitrials Letter Pack 1",
   status: "PUBLISHED",
   version: Version("1.0.0"),
   createdAt: new Date("2023-01-01T00:00:00Z"),
   updatedAt: new Date("2023-01-01T00:00:00Z"),
-  specificationType: "LETTER_STANDARD",
-  pack: {
+  assembly: {
     envelopeId: EnvelopeId("digitrials-envelope1-c5"),
+    features: ["ADMAIL"],
   },
 };
 
-const specifications = {
+const packs = {
   bauStandardC5,
   bauStandardC4,
   braille,
   audio,
   sameDay,
 };
 
-const specificationGroups: Record<string, SpecificationGroup> = {
+const specifications: Record<string, Specification> = {
   bauStandard: {
-    id: SpecificaitonGroupId("bau-standard"),
+    id: SpecificaitonId("bau-standard"),
     name: "BAU Standard Letter",
     description: "BAU Standard Letter",
-    specificationIds: [bauStandardC5.id, bauStandardC4.id],
+    packIds: [bauStandardC5.id, bauStandardC4.id],
     specificationType: "LETTER_STANDARD",
     status: "PUBLISHED",
   },
   braille: {
-    id: SpecificaitonGroupId("braille"),
+    id: SpecificaitonId("braille"),
     name: "Braille Letter",
     description: "Braille Letter",
-    specificationIds: [braille.id],
+    packIds: [braille.id],
     specificationType: "LETTER_BRAILLE",
     status: "PUBLISHED",
   },
   audio: {
-    id: SpecificaitonGroupId("audio"),
+    id: SpecificaitonId("audio"),
     name: "Audio Letter",
     description: "Audio Letter",
-    specificationIds: [audio.id],
+    packIds: [audio.id],
     specificationType: "LETTER_AUDIO",
     status: "PUBLISHED",
   },
   sameDay: {
-    id: SpecificaitonGroupId("same-day"),
+    id: SpecificaitonId("same-day"),
     name: "Same Day Letter",
     description: "Same Day Letter",
-    specificationIds: [sameDay.id],
+    packIds: [sameDay.id],
     specificationType: "LETTER_SAME_DAY",
     status: "PUBLISHED",
   },
   digitrials1: {
-    id: SpecificaitonGroupId("digitrials1"),
-    name: "Digitrials Letter Pack 1",
+    id: SpecificaitonId("digitrials1"),
+    name: "Digitrials Letter Specification 1",
     description: "Digitrials Letter Pack 1",
-    specificationIds: [digitrials1.id],
+    packIds: [digitrials1.id],
     specificationType: "LETTER_STANDARD",
     status: "PUBLISHED",
     clientId: "digitrials",
     campaignIds: ["digitrials-campaign-1"],
   },
 };
 
-console.log(JSON.stringify({ specifications, specificationGroups }, null, 2));
+console.log(JSON.stringify(specifications, null, 2));

packages/events/src/domain/__tests__/specification-supplier.test.ts

@@ -1,11 +1,11 @@
 import { $Version } from '../common';
 import { $SpecificationSupplier, SpecificationSupplier } from '../specification-supplier';
-import { EnvelopeId, Specification } from '../specification';
+import { EnvelopeId, Pack } from '../pack';
 import { LayoutId } from '../layout';
 
 describe('SpecificationSupplier schema validation', () => {
 
-  const standardLetterSpecification: Specification = {
+  const standardLetterSpecification: Pack = {
     id: 'standard-letter' as any,
     name: 'Standard Economy-class Letter',
     status: 'PUBLISHED',

packages/events/src/domain/__tests__/specification.test.ts

@@ -1,11 +1,11 @@
-import { $Specification, EnvelopeId, Specification, SpecificationId } from '../specification';
+import { $Pack, EnvelopeId, Pack, PackId } from '../pack';
 import { $Version } from '../common';
 import { LayoutId } from '../layout';
 
 describe('Specification schema validation', () => {
 
-  const standardLetterSpecification: Specification = {
-    id: 'standard-letter' as SpecificationId,
+  const standardLetterSpecification: Pack = {
+    id: 'standard-letter' as PackId,
     name: 'Standard Economy-class Letter',
     status: 'PUBLISHED',
     createdAt: new Date(),
@@ -26,11 +26,11 @@ describe('Specification schema validation', () => {
   };
 
   it('should validate a standard letter specification', () => {
-    expect(() => $Specification.strict().parse(standardLetterSpecification)).not.toThrow();
+    expect(() => $Pack.strict().parse(standardLetterSpecification)).not.toThrow();
   });
 
   it('should accept a letter specification with unrecognised fields', () => {
-    expect(() => $Specification.parse({
+    expect(() => $Pack.parse({
       ...standardLetterSpecification,
       additionalField: { some: 'data' }
     })).not.toThrow();

packages/events/src/domain/specification-supplier.ts

@@ -1,12 +1,12 @@
 import { z } from "zod";
 import idRef from "@nhsdigital/nhs-notify-schemas-supplier-config/src/helpers/id-ref";
 import { $ChannelSupplier } from "@nhsdigital/nhs-notify-schemas-supplier-config/src/domain/channel-supplier";
-import { $Specification } from "@nhsdigital/nhs-notify-schemas-supplier-config/src/domain/specification";
+import { $PackSpecification } from "src/domain/packSpecification";
 import { ConfigBase } from "@nhsdigital/nhs-notify-schemas-supplier-config/src/domain/common";
 
 export const $SpecificationSupplier = ConfigBase("SpecificationSupplier")
   .extend({
-    specificationId: idRef($Specification),
+    specificationId: idRef($PackSpecification),
     supplierId: idRef($ChannelSupplier),
   })
   .describe("SpecificationSupplier");

packages/events/src/domain/specification.ts

@@ -11,7 +11,7 @@ export const $SpecificationType = z.enum([
   "LETTER_AUDIO",
   "LETTER_SAME_DAY",
 ]);
-export const $SpecificationFeature = z.enum(["MAILMARK"]);
+export const $PackFeature = z.enum(["MAILMARK", "BRAILLE", "AUDIO", "ADMAIL"]);
 export const $EnvelopeFeature = z.enum([
   "WHITEMAIL",
   "NHS_BRANDING",
@@ -40,11 +40,10 @@ export const $Insert = ConfigBase("Insert")
 export type Insert = z.infer<typeof $Insert>;
 export type InsertId = Insert["id"];
 
-export const $Specification = ConfigBase("Specification")
+export const $Pack = ConfigBase("Specification")
   .extend({
     name: z.string(),
     status: $SpecificationStatus,
-    specificationType: $SpecificationType,
     createdAt: z.date(),
     updatedAt: z.date(),
     version: $Version,
@@ -66,32 +65,32 @@ export const $Specification = ConfigBase("Specification")
       })
       .partial()
       .optional(),
-    pack: z
+    assembly: z
       .object({
         envelopeId: idRef($Envelope),
         printColour: z.enum(["BLACK", "COLOUR"]),
         paperColour: z.string().optional(),
         insert: idRef($Insert).optional(),
-        features: z.array($SpecificationFeature).optional(),
+        features: z.array($PackFeature).optional(),
         additional: z.record(z.string(), z.string()).optional(),
       })
       .partial()
       .optional(),
   })
   .describe("Specification");
-export type Specification = z.infer<typeof $Specification>;
-export const SpecificationId = $Specification.shape.id.parse;
+export type Pack = z.infer<typeof $Pack>;
+export const PackId = $Pack.shape.id.parse;
 
-export const $SpecificationGroup = ConfigBase("SpecificationGroup")
+export const $Specification = ConfigBase("Specification")
   .extend({
     name: z.string(),
     description: z.string().optional(),
     specificationType: $SpecificationType,
     status: $SpecificationStatus,
     clientId: z.string().optional(),
     campaignIds: z.array(z.string()).optional(),
-    specificationIds: z.array(idRef($Specification)).nonempty(),
+    packIds: z.array(idRef($Pack)).nonempty(),
   })
-  .describe("SpecificationGroup");
-export type SpecificationGroup = z.infer<typeof $SpecificationGroup>;
-export const SpecificaitonGroupId = $SpecificationGroup.shape.id.parse;
+  .describe("Specification");
+export type Specification = z.infer<typeof $Specification>;
+export const SpecificaitonId = $Specification.shape.id.parse;