Fix/internal event datastore dep (#484)

masl2 · web-flow · commit 2ab5462f87ad · 2026-03-27T10:44:11.000Z
* move the letter mapper out of event package

* increment event package version

* event builder readme
diff --git a/internal/event-builders/README.md b/internal/event-builders/README.md
@@ -0,0 +1,7 @@
+# @internal/event-builders
+
+Helper utilities to produce supplier api event types.
+
+This package contains functions for constructing CloudEvent-compliant event payloads and related helpers.
+
+Independent package to allow for type imports across the project without circular dependencies.
diff --git a/internal/event-builders/jest.config.ts b/internal/event-builders/jest.config.ts
@@ -0,0 +1,14 @@
+export default {
+  preset: "ts-jest",
+  testEnvironment: "node",
+  testMatch: [
+    "**/src/__tests__/**/*.ts?(x)",
+    "**/src/?(*.)+(spec|test).ts?(x)",
+  ],
+  collectCoverageFrom: ["src/**/*.ts"],
+  coveragePathIgnorePatterns: ["/node_modules/", "__tests__"],
+  testPathIgnorePatterns: ["/node_modules/", "/dist/"],
+  transform: {
+    "^.+\\.tsx?$": ["ts-jest", {}],
+  },
+};
diff --git a/internal/event-builders/package.json b/internal/event-builders/package.json
@@ -0,0 +1,19 @@
+{
+  "dependencies": {
+    "@internal/datastore": "*",
+    "@nhsdigital/nhs-notify-event-schemas-supplier-api": "*"
+  },
+  "devDependencies": {},
+  "main": "dist/index.js",
+  "name": "@internal/event-builders",
+  "private": true,
+  "scripts": {
+    "build": "tsc",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "test:unit": "jest",
+    "typecheck": "tsc --noEmit"
+  },
+  "types": "dist/index.d.ts",
+  "version": "1.0.0"
+}
diff --git a/internal/event-builders/src/__tests__/letter-mapper.test.ts b/internal/event-builders/src/__tests__/letter-mapper.test.ts
@@ -1,6 +1,6 @@
 import { $LetterEvent } from "@nhsdigital/nhs-notify-event-schemas-supplier-api/src";
 import { Letter } from "@internal/datastore";
-import { mapLetterToCloudEvent } from "@nhsdigital/nhs-notify-event-schemas-supplier-api/src/events/letter-mapper";
+import { mapLetterToCloudEvent } from "../letter-mapper";
 
 describe("letter-mapper", () => {
   it("maps a letter to a letter event", async () => {
diff --git a/internal/event-builders/src/index.ts b/internal/event-builders/src/index.ts
@@ -0,0 +1,2 @@
+// Export event builder utilities
+export * from "./letter-mapper";
diff --git a/internal/event-builders/src/letter-mapper.ts b/internal/event-builders/src/letter-mapper.ts
@@ -1,7 +1,7 @@
 import { randomBytes, randomUUID } from "node:crypto";
 import eventSchemaPackage from "@nhsdigital/nhs-notify-event-schemas-supplier-api/package.json";
 import { Letter } from "@internal/datastore";
-import { LetterEvent } from "./letter-events";
+import { LetterEvent } from "@nhsdigital/nhs-notify-event-schemas-supplier-api/src/events/letter-events";
 
 // eslint-disable-next-line import-x/prefer-default-export
 export function mapLetterToCloudEvent(
diff --git a/internal/event-builders/tsconfig.json b/internal/event-builders/tsconfig.json
@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "declaration": true
+  },
+  "exclude": [
+    "node_modules",
+    "dist"
+  ],
+  "extends": "../../tsconfig.base.json",
+  "include": [
+    "src/**/*",
+    "jest.config.ts"
+  ]
+}
diff --git a/internal/events/package.json b/internal/events/package.json
@@ -1,7 +1,6 @@
 {
   "dependencies": {
     "@asyncapi/bundler": "^0.6.4",
-    "@internal/datastore": "*",
     "zod": "^4.1.11"
   },
   "description": "Schemas for NHS Notify Supplier API events",
@@ -37,5 +36,5 @@
     "typecheck": "tsc --noEmit"
   },
   "types": "dist/index.d.ts",
-  "version": "1.0.16"
+  "version": "1.0.17"
 }
diff --git a/internal/events/src/index.ts b/internal/events/src/index.ts
@@ -4,5 +4,4 @@ export { default as DomainBase } from "./domain/domain-base";
 export * from "./events/event-envelope";
 export * from "./events/letter-events";
 export * from "./events/mi-events";
-export * from "./events/letter-mapper";
 export * from "./version";
diff --git a/internal/helpers/package.json b/internal/helpers/package.json
@@ -1,5 +1,6 @@
 {
   "dependencies": {
+    "@nhsdigital/nhs-notify-event-schemas-supplier-api": "*",
     "aws-embedded-metrics": "^4.2.1",
     "pino": "^10.3.0",
     "zod": "^4.1.11"
diff --git a/lambdas/api-handler/package.json b/lambdas/api-handler/package.json
@@ -7,6 +7,7 @@
     "@aws-sdk/lib-dynamodb": "^3.1008.0",
     "@aws-sdk/s3-request-presigner": "^3.925.0",
     "@internal/datastore": "*",
+    "@internal/event-builders": "*",
     "@internal/helpers": "*",
     "@nhsdigital/nhs-notify-event-schemas-supplier-api": "*",
     "aws-embedded-metrics": "^4.2.1",
diff --git a/lambdas/api-handler/src/handlers/__tests__/amendment-event-transformer.test.ts b/lambdas/api-handler/src/handlers/__tests__/amendment-event-transformer.test.ts
@@ -2,7 +2,7 @@ import { Context, SQSEvent, SQSRecord } from "aws-lambda";
 import { mockDeep } from "jest-mock-extended";
 import pino from "pino";
 import { SNSClient } from "@aws-sdk/client-sns";
-import { mapLetterToCloudEvent } from "@nhsdigital/nhs-notify-event-schemas-supplier-api/src/events/letter-mapper";
+import { mapLetterToCloudEvent } from "@internal/event-builders/src";
 import { Letter, LetterRepository } from "@internal/datastore/src";
 import { UpdateLetterCommand } from "../../contracts/letters";
 import { EnvVars } from "../../config/env";
diff --git a/lambdas/api-handler/src/handlers/amendment-event-transformer.ts b/lambdas/api-handler/src/handlers/amendment-event-transformer.ts
@@ -1,10 +1,10 @@
 import { SQSBatchItemFailure, SQSEvent, SQSHandler } from "aws-lambda";
 import { PublishCommand } from "@aws-sdk/client-sns";
 import { LetterEvent } from "@nhsdigital/nhs-notify-event-schemas-supplier-api/src/events/letter-events";
-import { mapLetterToCloudEvent } from "@nhsdigital/nhs-notify-event-schemas-supplier-api/src/events/letter-mapper";
+import { MetricEntry, MetricStatus, buildEMFObject } from "@internal/helpers";
+import { mapLetterToCloudEvent } from "@internal/event-builders/src";
 import { Unit } from "aws-embedded-metrics";
 import pino from "pino";
-import { MetricEntry, MetricStatus, buildEMFObject } from "@internal/helpers";
 import {
   UpdateLetterCommand,
   UpdateLetterCommandSchema,
diff --git a/lambdas/letter-updates-transformer/package.json b/lambdas/letter-updates-transformer/package.json
@@ -3,6 +3,7 @@
     "@aws-sdk/client-sns": "^3.943.0",
     "@aws-sdk/util-dynamodb": "^3.943.0",
     "@internal/datastore": "^0.1.0",
+    "@internal/event-builders": "*",
     "@internal/helpers": "^0.1.0",
     "@nhsdigital/nhs-notify-event-schemas-supplier-api": "*",
     "aws-embedded-metrics": "^4.2.1",
diff --git a/lambdas/letter-updates-transformer/src/__tests__/letter-updates-transformer.test.ts b/lambdas/letter-updates-transformer/src/__tests__/letter-updates-transformer.test.ts
@@ -8,7 +8,7 @@ import {
 } from "aws-lambda";
 import { mockDeep } from "jest-mock-extended";
 import { Letter } from "@internal/datastore";
-import { mapLetterToCloudEvent } from "@nhsdigital/nhs-notify-event-schemas-supplier-api/src/events/letter-mapper";
+import { mapLetterToCloudEvent } from "@internal/event-builders/src";
 import createHandler from "../letter-updates-transformer";
 import { Deps } from "../deps";
 import { EnvVars } from "../env";
diff --git a/lambdas/letter-updates-transformer/src/letter-updates-transformer.ts b/lambdas/letter-updates-transformer/src/letter-updates-transformer.ts
@@ -10,11 +10,11 @@ import {
   PublishBatchRequestEntry,
 } from "@aws-sdk/client-sns";
 import { LetterEvent } from "@nhsdigital/nhs-notify-event-schemas-supplier-api/src";
-import { mapLetterToCloudEvent } from "@nhsdigital/nhs-notify-event-schemas-supplier-api/src/events/letter-mapper";
+import { MetricEntry, buildEMFObject } from "@internal/helpers";
 import { Letter, LetterSchema } from "@internal/datastore";
+import { mapLetterToCloudEvent } from "@internal/event-builders/src";
 import { Unit } from "aws-embedded-metrics";
 import pino from "pino";
-import { MetricEntry, buildEMFObject } from "@internal/helpers";
 import { Deps } from "./deps";
 
 // SNS PublishBatchCommand supports up to 10 messages per batch
diff --git a/package-lock.json b/package-lock.json

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+// Export event builder utilities`
	`2`	`+export * from "./letter-mapper";`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"dependencies": {`
`3`	`3`	`"@asyncapi/bundler": "^0.6.4",`
`4`		`- "@internal/datastore": "*",`
`5`	`4`	`"zod": "^4.1.11"`
`6`	`5`	`},`
`7`	`6`	`"description": "Schemas for NHS Notify Supplier API events",`
`@@ -37,5 +36,5 @@`
`37`	`36`	`"typecheck": "tsc --noEmit"`
`38`	`37`	`},`
`39`	`38`	`"types": "dist/index.d.ts",`
`40`		`- "version": "1.0.16"`
	`39`	`+ "version": "1.0.17"`
`41`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"dependencies": {`
	`3`	`+ "@nhsdigital/nhs-notify-event-schemas-supplier-api": "*",`
`3`	`4`	`"aws-embedded-metrics": "^4.2.1",`
`4`	`5`	`"pino": "^10.3.0",`
`5`	`6`	`"zod": "^4.1.11"`