@planning-inspectorate/data-model 1.12.0 → 1.14.0

package/.husky/pre-commit

@@ -1 +1 @@
-npx lint-staged && npm run format
+npx lint-staged

package/README.md

@@ -9,6 +9,7 @@ All messages over the enterprise service bus are in Data Model compliant formats
 * Messages broadcast over the service bus must be pre-validated against the schema.
 * Each service bus topic corresponds to one schema. 
 * Each message encompasses the complete state of an entity (as defined by [ECST](https://blogs.mulesoft.com/api-integration/strategy/event-carried-state-messages/)) and does not delineate specific changes (the delta). 
+* Each message will include a message event type, which is sent as `applicationProperties.type` (see [applicationProperties](https://learn.microsoft.com/en-us/javascript/api/%40azure/service-bus/servicebusmessage?view=azure-node-latest#@azure-service-bus-servicebusmessage-applicationproperties)), and is one of the values defined by the `eventType` enum in [enums-static.schema.json](./src/lib/enums-static.schema.json)
 * Consumers must support processing related messages received through different topics regardless of the order in which they are sent.
 * Values required by the Data Model cannot be null, while optional values must be null if they have no value. 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planning-inspectorate/data-model",
-  "version": "1.12.0",
+  "version": "1.14.0",
   "description": "JSON Schemas for the Planning Inspectorate's Data Model",
   "main": "src/index.js",
   "type": "module",
@@ -11,9 +11,9 @@
   "scripts": {
     "commitlint": "commitlint --from=$(git cherry origin/main | head -n 1 | cut -c 3-)",
     "gen": "npm run gen-docs && npm run gen-enums && npm run gen-types && npm run gen-cjs",
-    "gen-docs": "node src/gen-docs.js",
-    "gen-enums": "node src/gen-enums.js",
-    "gen-types": "node src/gen-types.js",
+    "gen-docs": "node src/lib/gen-docs.js",
+    "gen-enums": "node src/lib/gen-enums.js",
+    "gen-types": "node src/lib/gen-types.js",
     "gen-cjs": "npx rollup ./src/index.js --file ./src/index.cjs --format cjs && npx rollup ./src/enums.js --file ./src/enums.cjs --format cjs",
     "lint": "npx eslint .",
     "format": "prettier --write .",
@@ -50,6 +50,9 @@
   "lint-staged": {
     "*.js": [
       "eslint --fix"
+    ],
+    "*.{js,ts,json,md,prisma,yml,yaml,scss}": [
+      "prettier --write"
     ]
   }
 }

package/schemas/commands/appellant-submission.schema.json

@@ -16,6 +16,12 @@
         {
           "allOf": [{ "properties": { "caseType": { "const": "D" } } }, { "$ref": "appeal-has-submission.schema.json" }]
         },
+        {
+          "allOf": [
+            { "properties": { "caseType": { "const": "ZP" } } },
+            { "$ref": "appeal-has-submission.schema.json" }
+          ]
+        },
         {
           "allOf": [{ "properties": { "caseType": { "const": "W" } } }, { "$ref": "appeal-s78-submission.schema.json" }]
         },

package/schemas/commands/lpa-questionnaire.schema.json

@@ -27,6 +27,12 @@
         },
         {
           "allOf": [{ "properties": { "caseType": { "const": "D" } } }, { "$ref": "lpa-questionnaire-has.schema.json" }]
+        },
+        {
+          "allOf": [
+            { "properties": { "caseType": { "const": "ZP" } } },
+            { "$ref": "lpa-questionnaire-has.schema.json" }
+          ]
         }
       ]
     },

package/src/enums.cjs

@@ -340,6 +340,14 @@ const CASE_STAGE = Object.freeze({
   WITHDRAWN: 'withdrawn',
 });
 
+const MESSAGE_EVENT_TYPE = Object.freeze({
+  CREATE: 'Create',
+  DELETE: 'Delete',
+  PUBLISH: 'Publish',
+  UNPUBLISH: 'Unpublish',
+  UPDATE: 'Update',
+});
+
 const METHOD = Object.freeze({
   EMAIL: 'email',
   FAX: 'fax',
@@ -605,6 +613,7 @@ exports.APPEAL_SOURCE_SYSTEM = APPEAL_SOURCE_SYSTEM;
 exports.APPEAL_TYPE_OF_PLANNING_APPLICATION = APPEAL_TYPE_OF_PLANNING_APPLICATION;
 exports.APPEAL_VIRUS_CHECK_STATUS = APPEAL_VIRUS_CHECK_STATUS;
 exports.CASE_STAGE = CASE_STAGE;
+exports.MESSAGE_EVENT_TYPE = MESSAGE_EVENT_TYPE;
 exports.METHOD = METHOD;
 exports.NSIP_CASE_TYPE = NSIP_CASE_TYPE;
 exports.NSIP_DECISION = NSIP_DECISION;

package/src/enums.d.ts

@@ -338,6 +338,14 @@ export const CASE_STAGE = {
   WITHDRAWN: 'withdrawn',
 };
 
+export const MESSAGE_EVENT_TYPE = {
+  CREATE: 'Create',
+  DELETE: 'Delete',
+  PUBLISH: 'Publish',
+  UNPUBLISH: 'Unpublish',
+  UPDATE: 'Update',
+};
+
 export const METHOD = {
   EMAIL: 'email',
   FAX: 'fax',

package/src/enums.js

@@ -338,6 +338,14 @@ export const CASE_STAGE = Object.freeze({
   WITHDRAWN: 'withdrawn',
 });
 
+export const MESSAGE_EVENT_TYPE = Object.freeze({
+  CREATE: 'Create',
+  DELETE: 'Delete',
+  PUBLISH: 'Publish',
+  UNPUBLISH: 'Unpublish',
+  UPDATE: 'Update',
+});
+
 export const METHOD = Object.freeze({
   EMAIL: 'email',
   FAX: 'fax',

package/src/index.cjs

@@ -421,6 +421,14 @@ const CASE_STAGE = Object.freeze({
   WITHDRAWN: 'withdrawn',
 });
 
+const MESSAGE_EVENT_TYPE = Object.freeze({
+  CREATE: 'Create',
+  DELETE: 'Delete',
+  PUBLISH: 'Publish',
+  UNPUBLISH: 'Unpublish',
+  UPDATE: 'Update',
+});
+
 const METHOD = Object.freeze({
   EMAIL: 'email',
   FAX: 'fax',
@@ -715,6 +723,7 @@ exports.APPEAL_SOURCE_SYSTEM = APPEAL_SOURCE_SYSTEM;
 exports.APPEAL_TYPE_OF_PLANNING_APPLICATION = APPEAL_TYPE_OF_PLANNING_APPLICATION;
 exports.APPEAL_VIRUS_CHECK_STATUS = APPEAL_VIRUS_CHECK_STATUS;
 exports.CASE_STAGE = CASE_STAGE;
+exports.MESSAGE_EVENT_TYPE = MESSAGE_EVENT_TYPE;
 exports.METHOD = METHOD;
 exports.NSIP_CASE_TYPE = NSIP_CASE_TYPE;
 exports.NSIP_DECISION = NSIP_DECISION;

package/src/lib/enums-static.schema.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "enums-static.schema.json",
+  "title": "Static Enums",
+  "description": "Static enums to add to generated types that are not directly references in schemas",
+  "type": "object",
+  "properties": {
+    "eventType": {
+      "type": "string",
+      "enum": ["Create", "Update", "Delete", "Publish", "Unpublish"],
+      "description": "The type of Service Bus event"
+    }
+  }
+}

package/src/{gen-docs.js → lib/gen-docs.js}

@@ -1,5 +1,5 @@
 import { jsonschema2md } from '@adobe/jsonschema2md';
-import { loadAllSchemas } from './index.js';
+import { loadAllSchemas } from '../index.js';
 import fs from 'fs/promises';
 
 /**

package/src/{gen-enums.js → lib/gen-enums.js}

@@ -1,13 +1,14 @@
 import fs from 'fs/promises';
 import path from 'path';
 import url from 'url';
-import { loadAllSchemas } from './index.js';
+import { loadAllSchemas } from '../index.js';
 import snakeCase from 'lodash.snakecase';
+import { loadSchema } from './load.js';
 
 const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
 
-export const constPath = path.join(__dirname, 'enums.js');
-export const constTsPath = path.join(__dirname, 'enums.d.ts');
+export const constPath = path.join(__dirname, '..', 'enums.js');
+export const constTsPath = path.join(__dirname, '..', 'enums.d.ts');
 
 const SPACING = '  ';
 const NEW_LINE = '\r\n';
@@ -26,6 +27,9 @@ async function run() {
 		collectEnumProps(enumProps, schema.properties, schemaPrefix(schemaName));
 	}
 
+	const staticEnums = await loadSchema(path.join(__dirname, 'enums-static.schema.json'));
+	collectEnumProps(enumProps, staticEnums.properties, 'message');
+
 	let output = '';
 	let tsOutput = '';
 

package/src/{gen-types.js → lib/gen-types.js}

@@ -1,13 +1,13 @@
 import fs from 'fs/promises';
 import path from 'path';
 import url from 'url';
-import { loadAllSchemas } from './index.js';
+import { loadAllSchemas } from '../index.js';
 import { compile } from 'json-schema-to-typescript';
-import { schemasPath, commandsPath } from './index.js';
+import { schemasPath, commandsPath } from '../index.js';
 
 const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
 
-export const typesPath = path.join(__dirname, 'schemas.d.ts');
+export const typesPath = path.join(__dirname, '..', 'schemas.d.ts');
 
 /**
  * Load all schemas and generate TypeScript definitions

package/src/lib/load.js

@@ -29,7 +29,7 @@ export async function loadSchemas(dirPath) {
  * @param {string} filePath
  * @returns {Promise<any>}
  */
-async function loadSchema(filePath) {
+export async function loadSchema(filePath) {
 	const content = await readFile(filePath);
 	return parse(content.toString());
 }

package/src/schemas.d.ts

@@ -3381,6 +3381,9 @@ export interface AppellantSubmissionCommand {
     | ({
         caseType?: 'D';
       } & AppellantHASSubmissionProperties)
+    | ({
+        caseType?: 'ZP';
+      } & AppellantHASSubmissionProperties)
     | ({
         caseType?: 'W';
       } & AppellantS78SubmissionProperties)
@@ -4262,6 +4265,9 @@ export interface LPAQuestionnaireCommand {
       } & LPAQS78SubmissionProperties)
     | ({
         caseType?: 'D';
+      } & LPAQHASSubmissionProperties)
+    | ({
+        caseType?: 'ZP';
       } & LPAQHASSubmissionProperties);
   documents: {
     /**