@planning-inspectorate/data-model 1.13.0 → 1.15.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/docs/appeal-s78.md

@@ -141,6 +141,8 @@
 | [siteWithinSSSI](#sitewithinsssi)                                                     | `boolean` | Required | can be null    | [Appeal S78 Case](appeal-s78-properties-sitewithinsssi.md "appeal-s78.schema.json#/properties/siteWithinSSSI")                                                     |
 | [typeOfPlanningApplication](#typeofplanningapplication)                               | `string`  | Required | can be null    | [Appeal S78 Case](appeal-s78-properties-typeofplanningapplication.md "appeal-s78.schema.json#/properties/typeOfPlanningApplication")                               |
 | [developmentType](#developmenttype)                                                   | `string`  | Required | can be null    | [Appeal S78 Case](appeal-s78-properties-developmenttype.md "appeal-s78.schema.json#/properties/developmentType")                                                   |
+| [statementOfCommonGroundDueDate](#statementofcommongroundduedate)                     | `string`  | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-statementofcommongroundduedate.md "appeal-s78.schema.json#/properties/statementOfCommonGroundDueDate")                     |
+| [planningObligationDueDate](#planningobligationduedate)                               | `string`  | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-planningobligationduedate.md "appeal-s78.schema.json#/properties/planningObligationDueDate")                               |
 | Additional Properties                                                                 | Any       | Optional | can be null    |                                                                                                                                                                    |
 
 ## caseId
@@ -3602,6 +3604,66 @@ The net gain in residences of the proposed development
 | `"other-minor"`             |             |
 | `null`                      |             |
 
+## statementOfCommonGroundDueDate
+
+
+
+> Only available in S78 cases
+
+`statementOfCommonGroundDueDate`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Appeal S78 Case](appeal-s78-properties-statementofcommongroundduedate.md "appeal-s78.schema.json#/properties/statementOfCommonGroundDueDate")
+
+### statementOfCommonGroundDueDate Type
+
+`string`
+
+### statementOfCommonGroundDueDate Constraints
+
+**date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
+
+### statementOfCommonGroundDueDate Examples
+
+```json
+"2023-07-27T20:30:00.000Z"
+```
+
+## planningObligationDueDate
+
+
+
+> Only available in S78 cases
+
+`planningObligationDueDate`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Appeal S78 Case](appeal-s78-properties-planningobligationduedate.md "appeal-s78.schema.json#/properties/planningObligationDueDate")
+
+### planningObligationDueDate Type
+
+`string`
+
+### planningObligationDueDate Constraints
+
+**date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
+
+### planningObligationDueDate Examples
+
+```json
+"2023-07-27T20:30:00.000Z"
+```
+
 ## Additional Properties
 
 Additional properties are allowed and do not have to follow a specific schema

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planning-inspectorate/data-model",
-  "version": "1.13.0",
+  "version": "1.15.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/pins_data_model/models/model_appeal_document.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-document.schema.json
-#   timestamp: 2025-07-16T14:06:10+00:00
+#   timestamp: 2025-08-27T11:15:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_appeal_event.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-event.schema.json
-#   timestamp: 2025-07-16T14:06:09+00:00
+#   timestamp: 2025-08-27T11:15:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_appeal_event_estimate.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-event-estimate.schema.json
-#   timestamp: 2025-07-16T14:06:09+00:00
+#   timestamp: 2025-08-27T11:15:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_appeal_has.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-has.schema.json
-#   timestamp: 2025-07-16T14:06:09+00:00
+#   timestamp: 2025-08-27T11:15:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_appeal_representation.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-representation.schema.json
-#   timestamp: 2025-07-16T14:06:09+00:00
+#   timestamp: 2025-08-27T11:15:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_appeal_s78.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-s78.schema.json
-#   timestamp: 2025-07-16T14:06:09+00:00
+#   timestamp: 2025-08-27T11:15:00+00:00
 
 from __future__ import annotations
 
@@ -862,3 +862,9 @@ class AppealS78Case(BaseModel):
     siteWithinSSSI: bool | None = None
     typeOfPlanningApplication: TypeOfPlanningApplication
     developmentType: DevelopmentType
+    statementOfCommonGroundDueDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    planningObligationDueDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )

package/pins_data_model/models/model_dart_response.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  dart-response.schema.json
-#   timestamp: 2025-07-16T14:06:10+00:00
+#   timestamp: 2025-08-27T11:15:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_entraid.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  entraid.schema.json
-#   timestamp: 2025-07-16T14:06:09+00:00
+#   timestamp: 2025-08-27T11:15:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_folder.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  folder.schema.json
-#   timestamp: 2025-07-16T14:06:10+00:00
+#   timestamp: 2025-08-27T11:15:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_gettimesheets_response.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  gettimesheets-response.schema.json
-#   timestamp: 2025-07-16T14:06:09+00:00
+#   timestamp: 2025-08-27T11:15:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_listed_building.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  listed-building.schema.json
-#   timestamp: 2025-07-16T14:06:09+00:00
+#   timestamp: 2025-08-27T11:15:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_listed_buildings.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  listed-buildings.schema.json
-#   timestamp: 2025-07-16T14:06:09+00:00
+#   timestamp: 2025-08-27T11:15:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_document.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-document.schema.json
-#   timestamp: 2025-07-16T14:06:10+00:00
+#   timestamp: 2025-08-27T11:15:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_exam_timetable.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-exam-timetable.schema.json
-#   timestamp: 2025-07-16T14:06:09+00:00
+#   timestamp: 2025-08-27T11:15:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_project.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-project.schema.json
-#   timestamp: 2025-07-16T14:06:09+00:00
+#   timestamp: 2025-08-27T11:15:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_project_update.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-project-update.schema.json
-#   timestamp: 2025-07-16T14:06:09+00:00
+#   timestamp: 2025-08-27T11:15:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_representation.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-representation.schema.json
-#   timestamp: 2025-07-16T14:06:09+00:00
+#   timestamp: 2025-08-27T11:15:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_subscription.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-subscription.schema.json
-#   timestamp: 2025-07-16T14:06:10+00:00
+#   timestamp: 2025-08-27T11:15:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_pins_inspector.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  pins-inspector.schema.json
-#   timestamp: 2025-07-16T14:06:09+00:00
+#   timestamp: 2025-08-27T11:15:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_pins_lpa.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  pins-lpa.schema.json
-#   timestamp: 2025-07-16T14:06:10+00:00
+#   timestamp: 2025-08-27T11:15:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_s51_advice.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  s51-advice.schema.json
-#   timestamp: 2025-07-16T14:06:09+00:00
+#   timestamp: 2025-08-27T11:15:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_service_user.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  service-user.schema.json
-#   timestamp: 2025-07-16T14:06:10+00:00
+#   timestamp: 2025-08-27T11:15:00+00:00
 
 from __future__ import annotations
 

package/schemas/appeal-s78.schema.json

@@ -1055,6 +1055,18 @@
         "other-minor",
         null
       ]
+    },
+    "statementOfCommonGroundDueDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "examples": ["2023-07-27T20:30:00.000Z"],
+      "$comment": "Only available in S78 cases"
+    },
+    "planningObligationDueDate": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "examples": ["2023-07-27T20:30:00.000Z"],
+      "$comment": "Only available in S78 cases"
     }
   }
 }

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

@@ -1301,6 +1301,8 @@ export interface AppealS78Case {
     | 'other-major'
     | 'other-minor'
     | null;
+  statementOfCommonGroundDueDate?: string | null;
+  planningObligationDueDate?: string | null;
   [k: string]: unknown;
 }