@defra/grants-reporting-publisher 0.0.3 → 0.1.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @defra/grants-reporting-publisher
 
+## 0.1.1
+
+### Patch Changes
+
+- f8be355: Update readme with examples
+
+## 0.1.0
+
+### Minor Changes
+
+- 94ffa84: Add the schema definition for input events
+
 ## 0.0.3
 
 ### Patch Changes

package/EXAMPLES.md

@@ -0,0 +1,127 @@
+# Usage Examples
+
+This page provides examples of how to use the `@defra/grants-reporting-publisher` library to publish reporting events.
+
+## Configuration
+
+To publish events, you need to provide a configuration object that includes an AWS SNS client and the target topic ARN.
+
+```javascript
+import { SNSClient } from "@aws-sdk/client-sns";
+import {
+  publishReportingEvent,
+  AGREEMENT_CREATED,
+  AGREEMENT_STATUS_CHANGED,
+} from "@defra/grants-reporting-publisher";
+
+const snsClient = new SNSClient({ region: "eu-west-2" });
+
+const config = {
+  snsClient,
+  sns: {
+    topicArn: "arn:aws:sns:eu-west-2:123456789012:your-topic-name",
+  },
+  application: "YOUR_APPLICATION_CODE", // e.g., "GAS or grants-payments-service"
+  service: "your-service-name", // optional, defaults to "grants", just omit this for now
+  generateCorrelationId: true, // automatically generate a UUID for each event
+};
+```
+
+## Event Types
+
+### Agreement Created (`AGREEMENT_CREATED`)
+
+Use this event type when a new agreement is created.
+
+```javascript
+const agreementCreatedEvent = {
+  eventData: {
+    eventType: AGREEMENT_CREATED,
+    agreementId: "AG-123456",
+    agreementType: "WOODLAND",
+    agreementStatus: "ACCEPTED",
+    agreementStartDate: "2026-01-01",
+    agreementEndDate: "2031-12-31",
+    agreementValue: 50000.0,
+    sbi: "200000001",
+    options: [
+      {
+        parcelReference: "SD8545-9935",
+        parcelSizeUnderAgreement: 10.5,
+        optionCode: "WD1",
+        optionYear: 1,
+        optionStartDate: "2026-01-01",
+        optionEndDate: "2026-12-31",
+        optionQuantity: 10.5,
+        optionValue: 10500.0,
+      },
+    ],
+  },
+};
+
+try {
+  const { messageId } = await publishReportingEvent(
+    agreementCreatedEvent,
+    config,
+  );
+  console.log(`Event published with Message ID: ${messageId}`);
+} catch (error) {
+  console.error("Failed to publish event:", error.message);
+}
+```
+
+### Agreement Status Changed (`AGREEMENT_STATUS_CHANGED`)
+
+Use this event type when the status of an existing agreement changes.
+
+```javascript
+const statusChangedEvent = {
+  eventData: {
+    eventType: AGREEMENT_STATUS_CHANGED,
+    agreementId: "AG-123456",
+    agreementStatus: "COMPLETED",
+    statusDate: new Date().toISOString(),
+    agreementStartDate: "2026-01-01",
+    agreementEndDate: "2031-12-31",
+    agreementValue: 50000.0,
+    userId: "user-uuid-123", // optional
+  },
+};
+
+try {
+  const { messageId } = await publishReportingEvent(statusChangedEvent, config);
+  console.log(`Event published with Message ID: ${messageId}`);
+} catch (error) {
+  console.error("Failed to publish event:", error.message);
+}
+```
+
+## Validation Only
+
+If you only want to validate an event without publishing it:
+
+```javascript
+import { validateReportingEvent } from "@defra/grants-reporting-publisher";
+
+const event = {
+  correlationId: "your-correlation-id",
+  datetime: new Date().toISOString(),
+  version: "1.0.0",
+  application: "FCP",
+  service: "grants",
+  eventData: {
+    eventType: AGREEMENT_STATUS_CHANGED,
+    agreementId: "AG-123",
+    agreementStatus: "ACTIVE",
+    statusDate: new Date().toISOString(),
+  },
+};
+
+const { valid, errors, value } = validateReportingEvent(event);
+
+if (!valid) {
+  console.error("Validation errors:", errors);
+} else {
+  console.log("Event is valid:", value);
+}
+```

package/README.md

@@ -4,6 +4,8 @@ NPM module for providing validation and publishing capability for grants reporti
 
 ## Usage
 
+Refer to the [Usage Examples](EXAMPLES.md) for detailed examples of how to publish reporting events.
+
 ### Installation
 
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/grants-reporting-publisher",
-  "version": "0.0.3",
+  "version": "0.1.1",
   "description": "NPM module for publishing grants reporting events",
   "engines": {
     "node": ">=24",
@@ -32,7 +32,8 @@
     ".": "./src/index.js",
     "./publish": "./src/publish.js",
     "./validate": "./src/validate.js",
-    "./schema": "./src/schema.js"
+    "./schema": "./src/schema.js",
+    "./constants": "./src/constants.js"
   },
   "license": "OGL-UK-3.0",
   "bugs": {

package/src/constants.js

@@ -0,0 +1,2 @@
+export const AGREEMENT_CREATED = "AGREEMENT_CREATED";
+export const AGREEMENT_STATUS_CHANGED = "AGREEMENT_STATUS_CHANGED";

package/src/index.js

@@ -1 +1,2 @@
 export { validateReportingEvent } from "./validate.js";
+export * from "./constants.js";

package/src/publish.test.js

@@ -1,4 +1,5 @@
 import { publishReportingEvent } from "./publish.js";
+import { AGREEMENT_STATUS_CHANGED } from "./constants.js";
 
 const mockSend = vi.hoisted(() =>
   vi.fn().mockResolvedValue({ MessageId: "msg-001" }),
@@ -22,8 +23,12 @@ const validEvent = {
   datetime: "2025-12-01T12:51:41.381Z",
   version: "1.0.0",
   application: "FCP001",
+  service: "grants",
   eventData: {
-    status: "created",
+    eventType: AGREEMENT_STATUS_CHANGED,
+    agreementId: "WMP123456789",
+    agreementStatus: "created",
+    statusDate: "2025-12-01T12:51:41.381Z",
   },
 };
 

package/src/schema.js

@@ -1,28 +1,62 @@
 import Joi from "joi";
+import { AGREEMENT_CREATED, AGREEMENT_STATUS_CHANGED } from "./constants.js";
 
 const MAX_30 = 30;
 const MAX_50 = 50;
-const MAX_120 = 120;
 
 const accountId = Joi.alternatives()
   .try(Joi.string().max(MAX_50), Joi.number())
   .custom(String);
 
 export const eventSchema = Joi.object({
-  user: Joi.string().max(MAX_50).allow(""),
-  sessionId: Joi.string().max(MAX_50).allow(""),
   correlationId: Joi.string().max(MAX_50).required(),
   datetime: Joi.date().iso().required(),
   version: Joi.string().max(10).required(),
   application: Joi.string().max(MAX_30).required(),
   service: Joi.string().max(MAX_30).required(),
   eventData: Joi.object({
-    accounts: Joi.object({
-      sbi: accountId,
-    }).default({}),
-    status: Joi.string().max(MAX_120).allow(""),
-    details: Joi.object().default({}),
-  }).required(),
+    eventType: Joi.string()
+      .valid(AGREEMENT_CREATED, AGREEMENT_STATUS_CHANGED)
+      .required(),
+  })
+    .when(Joi.object({ eventType: AGREEMENT_CREATED }).unknown(), {
+      then: Joi.object({
+        agreementId: Joi.string().required(),
+        agreementType: Joi.string().required(),
+        agreementStatus: Joi.string().required(),
+        agreementStartDate: Joi.date().iso().optional(),
+        agreementEndDate: Joi.date().iso().optional(),
+        agreementValue: Joi.number().optional(),
+        sbi: accountId.required(),
+        options: Joi.array()
+          .items(
+            Joi.object({
+              parcelReference: Joi.string().allow("").required(),
+              parcelSizeUnderAgreement: Joi.number().optional(),
+              optionCode: Joi.string().required(),
+              optionYear: Joi.number().integer().optional(),
+              optionStartDate: Joi.date().iso().required(),
+              optionEndDate: Joi.date().iso().required(),
+              optionQuantity: Joi.number().required(),
+              optionValue: Joi.number().required(),
+            }),
+          )
+          .required(),
+      }),
+    })
+    .when(Joi.object({ eventType: AGREEMENT_STATUS_CHANGED }).unknown(), {
+      then: Joi.object({
+        agreementId: Joi.string().required(),
+        agreementStatus: Joi.string().required(),
+        statusDate: Joi.date().iso().required(),
+        agreementStartDate: Joi.date().iso().optional(),
+        agreementEndDate: Joi.date().iso().optional(),
+        agreementValue: Joi.number().optional(),
+        userId: Joi.string().optional(),
+      }),
+    })
+    .unknown()
+    .required(),
 }).required();
 
 export const configSchema = Joi.object({

package/src/validate.test.js

@@ -1,4 +1,5 @@
 import { validateReportingEvent } from "./validate.js";
+import { AGREEMENT_CREATED, AGREEMENT_STATUS_CHANGED } from "./constants.js";
 
 const validBase = {
   correlationId: "abc-123",
@@ -9,9 +10,11 @@ const validBase = {
 };
 
 const eventDataPayload = {
-  accounts: {
-    sbi: "abc123",
-  },
+  eventType: AGREEMENT_STATUS_CHANGED,
+  agreementId: "WMP123456789",
+  agreementStatus: "ACCEPTED",
+  statusDate: "2025-12-01T12:51:41.381Z",
+  sbi: "abc123",
 };
 
 describe("validateReportingEvent", () => {
@@ -25,24 +28,27 @@ describe("validateReportingEvent", () => {
       expect(result.value).toBeDefined();
     });
 
-    test("accepts optional status and details fields", () => {
+    test("accepts optional agreementStatus and details fields", () => {
       const result = validateReportingEvent({
         ...validBase,
         eventData: {
-          status: "created",
+          eventType: AGREEMENT_STATUS_CHANGED,
+          agreementId: "WMP123456789",
+          agreementStatus: "created",
+          statusDate: "2025-12-01T12:51:41.381Z",
           details: { agreementId: "agreement_456" },
         },
       });
       expect(result.valid).toBe(true);
     });
 
-    test("normalises the validated value (applies joi defaults)", () => {
+    test("normalises the validated value (converts datetime to Date object)", () => {
       const result = validateReportingEvent({
         ...validBase,
         eventData: eventDataPayload,
       });
       expect(result.valid).toBe(true);
-      expect(result.value.eventData.details).toEqual({});
+      expect(result.value.datetime).toBeInstanceOf(Date);
     });
   });
 
@@ -99,10 +105,212 @@ describe("validateReportingEvent", () => {
       expect(result.errors.some((e) => e.includes("version"))).toBe(true);
     });
 
+    test("returns valid:false when eventType is invalid", () => {
+      const result = validateReportingEvent({
+        ...validBase,
+        eventData: {
+          ...eventDataPayload,
+          eventType: "INVALID_EVENT_TYPE",
+        },
+      });
+      expect(result.valid).toBe(false);
+      expect(result.errors).toContain(
+        '"eventData.eventType" must be one of [AGREEMENT_CREATED, AGREEMENT_STATUS_CHANGED]',
+      );
+    });
+
     test("returns multiple errors with abortEarly:false", () => {
       const result = validateReportingEvent({ eventData: eventDataPayload });
       expect(result.valid).toBe(false);
       expect(result.errors.length).toBeGreaterThan(1);
     });
   });
+
+  describe("Agreement created events", () => {
+    test("accepts a valid Agreement created event", () => {
+      const result = validateReportingEvent({
+        ...validBase,
+        eventData: {
+          eventType: AGREEMENT_CREATED,
+          agreementId: "WMP123456789",
+          agreementType: "WOODLAND",
+          agreementStatus: "ACCEPTED",
+          agreementStartDate: "2026-09-01",
+          agreementEndDate: "2029-08-31",
+          agreementValue: 1575.0,
+          sbi: "200000001",
+          options: [],
+        },
+      });
+      expect(result.valid).toBe(true);
+    });
+
+    test("accepts Agreement created event with options", () => {
+      const result = validateReportingEvent({
+        ...validBase,
+        eventData: {
+          eventType: AGREEMENT_CREATED,
+          agreementId: "WMP123456789",
+          agreementType: "WOODLAND",
+          agreementStatus: "ACCEPTED",
+          sbi: "200000001",
+          options: [
+            {
+              parcelReference: "SD8545-9935",
+              parcelSizeUnderAgreement: 15.75,
+              optionCode: "WMP1",
+              optionYear: 1,
+              optionStartDate: "2026-09-01",
+              optionEndDate: "2029-08-31",
+              optionQuantity: 15.75,
+              optionValue: 1575.0,
+            },
+          ],
+        },
+      });
+      expect(result.valid).toBe(true);
+    });
+
+    test("accepts Agreement created event without optional fields", () => {
+      const result = validateReportingEvent({
+        ...validBase,
+        eventData: {
+          eventType: AGREEMENT_CREATED,
+          agreementId: "WMP123456789",
+          agreementType: "WOODLAND",
+          agreementStatus: "ACCEPTED",
+          sbi: "200000001",
+          options: [],
+        },
+      });
+      expect(result.valid).toBe(true);
+    });
+
+    test("accepts Agreement created event with minimal options", () => {
+      const result = validateReportingEvent({
+        ...validBase,
+        eventData: {
+          eventType: AGREEMENT_CREATED,
+          agreementId: "WMP123456789",
+          agreementType: "WOODLAND",
+          agreementStatus: "ACCEPTED",
+          sbi: "200000001",
+          options: [
+            {
+              parcelReference: "SD8545-9935",
+              optionCode: "WMP1",
+              optionStartDate: "2026-09-01",
+              optionEndDate: "2029-08-31",
+              optionQuantity: 15.75,
+              optionValue: 1575.0,
+            },
+          ],
+        },
+      });
+      expect(result.valid).toBe(true);
+    });
+
+    test("rejects Agreement created event if required fields are missing", () => {
+      const result = validateReportingEvent({
+        ...validBase,
+        eventData: {
+          eventType: AGREEMENT_CREATED,
+          agreementId: "WMP123456789",
+        },
+      });
+      expect(result.valid).toBe(false);
+      expect(result.errors).toContain('"eventData.agreementType" is required');
+      expect(result.errors).toContain(
+        '"eventData.agreementStatus" is required',
+      );
+      expect(result.errors).toContain('"eventData.sbi" is required');
+      expect(result.errors).toContain('"eventData.options" is required');
+    });
+
+    test("rejects Agreement created event if options contain invalid data", () => {
+      const result = validateReportingEvent({
+        ...validBase,
+        eventData: {
+          eventType: AGREEMENT_CREATED,
+          agreementId: "WMP123456789",
+          agreementType: "WOODLAND",
+          agreementStatus: "ACCEPTED",
+          sbi: "200000001",
+          options: [
+            {
+              agreementId: "WMP123456789",
+              // missing mandatory option fields
+            },
+          ],
+        },
+      });
+      expect(result.valid).toBe(false);
+      expect(result.errors).toContain(
+        '"eventData.options[0].parcelReference" is required',
+      );
+    });
+  });
+
+  describe("Agreement status changed events", () => {
+    test("accepts a valid Agreement status changed event with all fields", () => {
+      const result = validateReportingEvent({
+        ...validBase,
+        eventData: {
+          eventType: AGREEMENT_STATUS_CHANGED,
+          agreementId: "WMP123456789",
+          agreementStatus: "ACCEPTED",
+          agreementStartDate: "2026-09-01",
+          agreementEndDate: "2029-08-31",
+          statusDate: "2026-09-02T10:00:00Z",
+          agreementValue: 1575.0,
+        },
+      });
+      expect(result.valid).toBe(true);
+    });
+
+    test("accepts a valid Agreement status changed event with all fields including userId", () => {
+      const result = validateReportingEvent({
+        ...validBase,
+        eventData: {
+          eventType: AGREEMENT_STATUS_CHANGED,
+          agreementId: "WMP123456789",
+          agreementStatus: "ACCEPTED",
+          agreementStartDate: "2026-09-01",
+          agreementEndDate: "2029-08-31",
+          statusDate: "2026-09-02T10:00:00Z",
+          agreementValue: 1575.0,
+          userId: "user-123",
+        },
+      });
+      expect(result.valid).toBe(true);
+    });
+
+    test("accepts a valid Agreement status changed event with only mandatory fields", () => {
+      const result = validateReportingEvent({
+        ...validBase,
+        eventData: {
+          eventType: AGREEMENT_STATUS_CHANGED,
+          agreementId: "WMP123456789",
+          agreementStatus: "ACCEPTED",
+          statusDate: "2026-09-02T10:00:00Z",
+        },
+      });
+      expect(result.valid).toBe(true);
+    });
+
+    test("rejects Agreement status changed event if required fields are missing", () => {
+      const result = validateReportingEvent({
+        ...validBase,
+        eventData: {
+          eventType: AGREEMENT_STATUS_CHANGED,
+          agreementId: "WMP123456789",
+        },
+      });
+      expect(result.valid).toBe(false);
+      expect(result.errors).toContain(
+        '"eventData.agreementStatus" is required',
+      );
+      expect(result.errors).toContain('"eventData.statusDate" is required');
+    });
+  });
 });