Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions internal/event-builders/README.md
Original file line number Diff line number Diff line change
@@ -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.
14 changes: 14 additions & 0 deletions internal/event-builders/jest.config.ts
Original file line number Diff line number Diff line change
@@ -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", {}],
},
};
19 changes: 19 additions & 0 deletions internal/event-builders/package.json
Original file line number Diff line number Diff line change
@@ -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"
}
Original file line number Diff line number Diff line change
@@ -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 () => {
Expand Down
2 changes: 2 additions & 0 deletions internal/event-builders/src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
// Export event builder utilities
export * from "./letter-mapper";
Original file line number Diff line number Diff line change
@@ -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(
Expand Down
14 changes: 14 additions & 0 deletions internal/event-builders/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"compilerOptions": {
"declaration": true
},
"exclude": [
"node_modules",
"dist"
],
"extends": "../../tsconfig.base.json",
"include": [
"src/**/*",
"jest.config.ts"
]
}
3 changes: 1 addition & 2 deletions internal/events/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"dependencies": {
"@asyncapi/bundler": "^0.6.4",
"@internal/datastore": "*",
"zod": "^4.1.11"
},
"description": "Schemas for NHS Notify Supplier API events",
Expand Down Expand Up @@ -37,5 +36,5 @@
"typecheck": "tsc --noEmit"
},
"types": "dist/index.d.ts",
"version": "1.0.16"
"version": "1.0.17"
}
1 change: 0 additions & 1 deletion internal/events/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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";
1 change: 1 addition & 0 deletions internal/helpers/package.json
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
1 change: 1 addition & 0 deletions lambdas/api-handler/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
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";
Expand Down Expand Up @@ -120,7 +120,7 @@
TopicArn: mockedDeps.env.SNS_TOPIC_ARN,
Message: JSON.stringify(
mapLetterToCloudEvent(
updateLetterCommands[i] as Letter,

Check warning on line 123 in lambdas/api-handler/src/handlers/__tests__/amendment-event-transformer.test.ts

View workflow job for this annotation

GitHub Actions / Test stage / Linting

Generic Object Injection Sink
mockedDeps.env.EVENT_SOURCE,
),
),
Expand Down
Original file line number Diff line number Diff line change
@@ -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,
Expand Down
1 change: 1 addition & 0 deletions lambdas/letter-updates-transformer/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
18 changes: 16 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading