@defra/grants-reporting-publisher 0.1.2 → 0.3.0

package/.github/workflows/release.yml

@@ -54,7 +54,7 @@ jobs:
 
       - name: Create Release Pull Request or Release
         id: changesets
-        uses: changesets/action@8488615a623b1b9c987934bb89eae8af6a946ac1 #v2.1.1
+        uses: changesets/action@ae32849d5ba541f9ae29e40e22a623bc13562f51 #v2.1.2
         with:
           publish-script: npm run github:release
           commit-message: 'Create new config version'

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @defra/grants-reporting-publisher
 
+## 0.3.0
+
+### Minor Changes
+
+- 37b65ca: Add new parcels element (mandatory on agreement created)
+
+## 0.2.0
+
+### Minor Changes
+
+- 4a25189: Allow options to be sent with a status change messgae
+
 ## 0.1.2
 
 ### Patch Changes

package/EXAMPLES.md

@@ -44,6 +44,7 @@ const agreementCreatedEvent = {
     agreementEndDate: "2031-12-31",
     agreementValue: 50000.0,
     sbi: "200000001",
+    parcels: ["SD8545-9935"],
     options: [
       {
         parcelReference: "SD8545-9935",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/grants-reporting-publisher",
-  "version": "0.1.2",
+  "version": "0.3.0",
   "description": "NPM module for publishing grants reporting events",
   "engines": {
     "node": ">=24",
@@ -48,14 +48,14 @@
     "@babel/preset-env": "8.0.2",
     "@changesets/changelog-github": "1.0.0",
     "@changesets/cli": "3.0.1",
-    "@vitest/coverage-v8": "4.1.10",
+    "@vitest/coverage-v8": "5.0.0",
     "eslint": "10.7.0",
     "eslint-config-prettier": "10.1.1",
     "husky": "9.1.7",
-    "lint-staged": "17.3.0",
+    "lint-staged": "17.4.1",
     "neostandard": "0.13.0",
     "prettier": "3.9.6",
-    "vitest": "4.1.10",
+    "vitest": "5.0.0",
     "vitest-fetch-mock": "0.4.5"
   },
   "overrides": {

package/src/publish.test.js

@@ -176,6 +176,7 @@ describe("publishAuditEvent", () => {
           agreementType: "WOODLAND",
           agreementStatus: "ACCEPTED",
           sbi: "200000001",
+          parcels: ["SD8545-9935"],
           options: [
             {
               parcelReference: "SD8545-9935",

package/src/schema.js

@@ -8,6 +8,21 @@ const accountId = Joi.alternatives()
   .try(Joi.string().max(MAX_50), Joi.number())
   .custom(String);
 
+const parcelsSchema = Joi.array().items(Joi.string());
+
+const optionsSchema = 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().optional(),
+    optionEndDate: Joi.date().iso().optional(),
+    optionQuantity: Joi.number().required(),
+    optionValue: Joi.number().required(),
+  }),
+);
+
 export const eventSchema = Joi.object({
   correlationId: Joi.string().max(MAX_50).required(),
   datetime: Joi.date().iso().required(),
@@ -28,20 +43,8 @@ export const eventSchema = Joi.object({
         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().optional(),
-              optionEndDate: Joi.date().iso().optional(),
-              optionQuantity: Joi.number().required(),
-              optionValue: Joi.number().required(),
-            }),
-          )
-          .required(),
+        parcels: parcelsSchema.required(),
+        options: optionsSchema.required(),
       }),
     })
     .when(Joi.object({ eventType: AGREEMENT_STATUS_CHANGED }).unknown(), {
@@ -53,6 +56,8 @@ export const eventSchema = Joi.object({
         agreementEndDate: Joi.date().iso().optional(),
         agreementValue: Joi.number().optional(),
         userId: Joi.string().optional(),
+        parcels: parcelsSchema.optional(),
+        options: optionsSchema.optional(),
       }),
     })
     .unknown()

package/src/validate.test.js

@@ -139,6 +139,7 @@ describe("validateReportingEvent", () => {
           agreementEndDate: "2029-08-31",
           agreementValue: 1575.0,
           sbi: "200000001",
+          parcels: [],
           options: [],
         },
       });
@@ -154,6 +155,7 @@ describe("validateReportingEvent", () => {
           agreementType: "WOODLAND",
           agreementStatus: "ACCEPTED",
           sbi: "200000001",
+          parcels: ["SD8545-9935"],
           options: [
             {
               parcelReference: "SD8545-9935",
@@ -180,6 +182,7 @@ describe("validateReportingEvent", () => {
           agreementType: "WOODLAND",
           agreementStatus: "ACCEPTED",
           sbi: "200000001",
+          parcels: [],
           options: [],
         },
       });
@@ -195,6 +198,7 @@ describe("validateReportingEvent", () => {
           agreementType: "WOODLAND",
           agreementStatus: "ACCEPTED",
           sbi: "200000001",
+          parcels: ["SD8545-9935"],
           options: [
             {
               parcelReference: "SD8545-9935",
@@ -217,6 +221,7 @@ describe("validateReportingEvent", () => {
           agreementType: "WOODLAND",
           agreementStatus: "ACCEPTED",
           sbi: "200000001",
+          parcels: ["SD8545-9935"],
           options: [
             {
               parcelReference: "SD8545-9935",
@@ -240,6 +245,7 @@ describe("validateReportingEvent", () => {
           agreementType: "WOODLAND",
           agreementStatus: "ACCEPTED",
           sbi: "200000001",
+          parcels: ["SD8545-9935"],
           options: [
             {
               parcelReference: "SD8545-9935",
@@ -263,6 +269,7 @@ describe("validateReportingEvent", () => {
           agreementType: "WOODLAND",
           agreementStatus: "ACCEPTED",
           sbi: "200000001",
+          parcels: ["SD8545-9935"],
           options: [
             {
               parcelReference: "SD8545-9935",
@@ -289,6 +296,7 @@ describe("validateReportingEvent", () => {
           agreementType: "WOODLAND",
           agreementStatus: "ACCEPTED",
           sbi: "200000001",
+          parcels: ["SD8545-9935"],
           options: [
             {
               parcelReference: "SD8545-9935",
@@ -320,9 +328,62 @@ describe("validateReportingEvent", () => {
         '"eventData.agreementStatus" is required',
       );
       expect(result.errors).toContain('"eventData.sbi" is required');
+      expect(result.errors).toContain('"eventData.parcels" is required');
       expect(result.errors).toContain('"eventData.options" is required');
     });
 
+    test("rejects Agreement created event if parcels is missing", () => {
+      const result = validateReportingEvent({
+        ...validBase,
+        eventData: {
+          eventType: AGREEMENT_CREATED,
+          agreementId: "WMP123456789",
+          agreementType: "WOODLAND",
+          agreementStatus: "ACCEPTED",
+          sbi: "200000001",
+          options: [],
+        },
+      });
+      expect(result.valid).toBe(false);
+      expect(result.errors).toContain('"eventData.parcels" is required');
+    });
+
+    test("rejects Agreement created event if parcels is not an array", () => {
+      const result = validateReportingEvent({
+        ...validBase,
+        eventData: {
+          eventType: AGREEMENT_CREATED,
+          agreementId: "WMP123456789",
+          agreementType: "WOODLAND",
+          agreementStatus: "ACCEPTED",
+          sbi: "200000001",
+          parcels: "SD8545-9935",
+          options: [],
+        },
+      });
+      expect(result.valid).toBe(false);
+      expect(result.errors).toContain('"eventData.parcels" must be an array');
+    });
+
+    test("rejects Agreement created event if parcels contains non-string items", () => {
+      const result = validateReportingEvent({
+        ...validBase,
+        eventData: {
+          eventType: AGREEMENT_CREATED,
+          agreementId: "WMP123456789",
+          agreementType: "WOODLAND",
+          agreementStatus: "ACCEPTED",
+          sbi: "200000001",
+          parcels: [123],
+          options: [],
+        },
+      });
+      expect(result.valid).toBe(false);
+      expect(result.errors).toContain(
+        '"eventData.parcels[0]" must be a string',
+      );
+    });
+
     test("rejects Agreement created event if options contain invalid data", () => {
       const result = validateReportingEvent({
         ...validBase,
@@ -332,6 +393,7 @@ describe("validateReportingEvent", () => {
           agreementType: "WOODLAND",
           agreementStatus: "ACCEPTED",
           sbi: "200000001",
+          parcels: ["SD8545-9935"],
           options: [
             {
               agreementId: "WMP123456789",
@@ -394,6 +456,109 @@ describe("validateReportingEvent", () => {
       expect(result.valid).toBe(true);
     });
 
+    test("accepts a valid Agreement status changed event with options", () => {
+      const result = validateReportingEvent({
+        ...validBase,
+        eventData: {
+          eventType: AGREEMENT_STATUS_CHANGED,
+          agreementId: "WMP123456789",
+          agreementStatus: "ACCEPTED",
+          statusDate: "2026-09-02T10:00:00Z",
+          options: [
+            {
+              parcelReference: "SD8545-9935",
+              optionCode: "WMP1",
+              optionQuantity: 15.75,
+              optionValue: 1575.0,
+            },
+          ],
+        },
+      });
+      expect(result.valid).toBe(true);
+    });
+
+    test("accepts a valid Agreement status changed event with empty parcels array", () => {
+      const result = validateReportingEvent({
+        ...validBase,
+        eventData: {
+          eventType: AGREEMENT_STATUS_CHANGED,
+          agreementId: "WMP123456789",
+          agreementStatus: "ACCEPTED",
+          statusDate: "2026-09-02T10:00:00Z",
+          parcels: [],
+        },
+      });
+      expect(result.valid).toBe(true);
+    });
+
+    test("accepts a valid Agreement status changed event with parcels", () => {
+      const result = validateReportingEvent({
+        ...validBase,
+        eventData: {
+          eventType: AGREEMENT_STATUS_CHANGED,
+          agreementId: "WMP123456789",
+          agreementStatus: "ACCEPTED",
+          statusDate: "2026-09-02T10:00:00Z",
+          parcels: ["SD8545-9935", "SD8545-9936"],
+        },
+      });
+      expect(result.valid).toBe(true);
+    });
+
+    test("rejects Agreement status changed event if parcels is not an array", () => {
+      const result = validateReportingEvent({
+        ...validBase,
+        eventData: {
+          eventType: AGREEMENT_STATUS_CHANGED,
+          agreementId: "WMP123456789",
+          agreementStatus: "ACCEPTED",
+          statusDate: "2026-09-02T10:00:00Z",
+          parcels: "SD8545-9935",
+        },
+      });
+      expect(result.valid).toBe(false);
+      expect(result.errors).toContain('"eventData.parcels" must be an array');
+    });
+
+    test("rejects Agreement status changed event if parcels contains non-string items", () => {
+      const result = validateReportingEvent({
+        ...validBase,
+        eventData: {
+          eventType: AGREEMENT_STATUS_CHANGED,
+          agreementId: "WMP123456789",
+          agreementStatus: "ACCEPTED",
+          statusDate: "2026-09-02T10:00:00Z",
+          parcels: [123],
+        },
+      });
+      expect(result.valid).toBe(false);
+      expect(result.errors).toContain(
+        '"eventData.parcels[0]" must be a string',
+      );
+    });
+
+    test("rejects Agreement status changed event if options contain invalid data", () => {
+      const result = validateReportingEvent({
+        ...validBase,
+        eventData: {
+          eventType: AGREEMENT_STATUS_CHANGED,
+          agreementId: "WMP123456789",
+          agreementStatus: "ACCEPTED",
+          statusDate: "2026-09-02T10:00:00Z",
+          options: [
+            {
+              parcelReference: "SD8545-9935",
+              // missing mandatory option fields like optionCode
+            },
+          ],
+        },
+      });
+      expect(result.valid).toBe(false);
+      expect(result.errors).toContain(
+        '"eventData.options[0].optionCode" is required',
+      );
+    });
+
     test("rejects Agreement status changed event if required fields are missing", () => {
       const result = validateReportingEvent({
         ...validBase,