@planning-inspectorate/data-model 2.50.0 → 2.51.1

package/commitlint.config.js

@@ -1,8 +1,3 @@
-export default {
-	extends: ['@commitlint/config-conventional'],
-	// ignore commits from dependabot
-	ignores: [
-		(commit) =>
-			(commit.startsWith('chore(deps)') || commit.startsWith('chore(deps-dev)')) && commit.includes('dependabot')
-	]
-};
+import { commitlintConfig } from '@planning-inspectorate/coding-standards';
+
+export default commitlintConfig;

package/docs/address.md

@@ -327,7 +327,7 @@ Some sites may have a postcode, but do not have postal addresses.
 
 ## UPRN
 
-The Unique Property Reference Number (UPRN) is a unique number (a geocode) for every addressable location—e.g., a building, a bus stop, a post box, a feature in the landscape, or a defibrillator—in Great Britain.
+The Unique Property Reference Number (UPRN) is a unique number (a geocode) for every addressable location - e.g., a building, a bus stop, a post box, a feature in the landscape, or a defibrillator - in Great Britain.
 
 `UPRN`
 

package/docs/nsip-exam-timetable-defs-event.md

@@ -71,6 +71,7 @@ Compulsory Acquisition Hearing/Deadline/Issue Specific Hearing etc
 | `"Procedural Deadline (Pre-Examination)"` |             |
 | `"Procedural Decision"`                   |             |
 | `"Publication Of"`                        |             |
+| `"Unaccompanied Site Inspection"`         |             |
 
 ## eventTitle
 

package/docs/nsip-exam-timetable.md

@@ -146,6 +146,7 @@ Compulsory Acquisition Hearing/Deadline/Issue Specific Hearing etc
 | `"Procedural Deadline (Pre-Examination)"` |             |
 | `"Procedural Decision"`                   |             |
 | `"Publication Of"`                        |             |
+| `"Unaccompanied Site Inspection"`         |             |
 
 ### eventTitle
 

package/eslint.config.js

@@ -1,21 +1,4 @@
-import js from '@eslint/js';
-import eslintConfigPrettier from 'eslint-config-prettier';
-import globals from 'globals';
+import { eslintConfig } from '@planning-inspectorate/coding-standards';
+import { defineConfig } from 'eslint/config';
 
-export default [
-	{
-		...js.configs.recommended,
-		ignores: ['**/*.cjs', 'node_modules/**']
-	},
-	{
-		ignores: ['node_modules/**', '**/*.cjs'],
-		languageOptions: {
-			ecmaVersion: 2025,
-			sourceType: 'module',
-			globals: {
-				...globals.node
-			}
-		}
-	},
-	eslintConfigPrettier
-];
+export default defineConfig(eslintConfig);

package/load-test/appeals/generate-appeals-messages.js

@@ -1,6 +1,6 @@
-import crypto from 'node:crypto';
 import Ajv from 'ajv';
 import addFormats from 'ajv-formats';
+import crypto from 'node:crypto';
 import { loadAllSchemasSync } from '../../src/index.js';
 
 const HAS_SCHEMA = 'appeal-has.schema.json';

package/load-test/appeals/run-load-script.js

@@ -1,6 +1,6 @@
-import { generateAppealsLoadTestMessages } from './generate-appeals-messages.js';
-import { ServiceBusEventClient } from '../service-bus-client.js';
 import { MESSAGE_EVENT_TYPE } from '../../src/enums.js';
+import { ServiceBusEventClient } from '../service-bus-client.js';
+import { generateAppealsLoadTestMessages } from './generate-appeals-messages.js';
 
 /** @type {'HAS'|'S78'} */ //@ts-ignore
 const caseType = process.env.APPEALS_LOAD_TEST_CASE_TYPE || 'HAS'; // 'HAS' or 'S78'

package/load-test/service-bus-client.js

@@ -1,5 +1,5 @@
-import { ServiceBusClient } from '@azure/service-bus';
 import { DefaultAzureCredential } from '@azure/identity';
+import { ServiceBusClient } from '@azure/service-bus';
 
 /**
  * @typedef {object} ServiceBusEventClientOptions

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planning-inspectorate/data-model",
-  "version": "2.50.0",
+  "version": "2.51.1",
   "description": "JSON Schemas for the Planning Inspectorate's Data Model",
   "main": "src/index.js",
   "type": "module",
@@ -36,6 +36,7 @@
     "@commitlint/cli": "^21.0.0",
     "@commitlint/config-conventional": "^21.0.0",
     "@eslint/js": "^10.0.1",
+    "@planning-inspectorate/coding-standards": "^1.1.1",
     "ajv": "^8.17.1",
     "ajv-formats": "^3.0.1",
     "conventional-changelog-conventionalcommits": "^10.2.0",
@@ -43,10 +44,12 @@
     "eslint-config-prettier": "^10.1.5",
     "globals": "^17.3.0",
     "husky": "^9.1.7",
-    "json-schema-to-typescript": "^15.0.4",
+    "json-schema-to-typescript": "^16.0.0",
     "lint-staged": "^17.0.4",
     "lodash.snakecase": "^4.1.1",
     "prettier": "^3.6.2",
+    "prettier-plugin-organize-imports": "^4.3.0",
+    "prettier-plugin-prisma": "^5.0.0",
     "rollup": "^4.44.2",
     "semantic-release": "^25.0.1"
   },

package/pins_data_model/gen_models.py

@@ -6,7 +6,7 @@ import json
 from os import path
 from pathlib import Path
 from datamodel_code_generator import InputFileType, PythonVersion, generate
-from datamodel_code_generator import DataModelType
+from datamodel_code_generator import DataModelType, Formatter
 
 from load_schemas import load_all_schemas
 
@@ -46,6 +46,7 @@ def gen_models() -> None:
             target_python_version=PythonVersion.PY_311,
             use_schema_description=True,
             disable_timestamp=True,
+            formatters=[Formatter.BLACK, Formatter.ISORT]
         )
 
 

package/pins_data_model/models/model_address.py

@@ -3,13 +3,13 @@
 
 from __future__ import annotations
 
-from enum import Enum
+from enum import StrEnum
 from typing import Any
 
 from pydantic import BaseModel, ConfigDict, Field
 
 
-class AddressType(Enum):
+class AddressType(StrEnum):
     """
     The type of thing this address is for.
     """
@@ -64,6 +64,6 @@ class PinsAddressSchema(BaseModel):
     longitudeWGS84: float | None = Field(None, examples=[-2.6019821])
     UPRN: str | None = Field(None, examples=[100023336956])
     """
-    The Unique Property Reference Number (UPRN) is a unique number (a geocode) for every addressable location—e.g., a building, a bus stop, a post box, a feature in the landscape, or a defibrillator—in Great Britain.
+    The Unique Property Reference Number (UPRN) is a unique number (a geocode) for every addressable location - e.g., a building, a bus stop, a post box, a feature in the landscape, or a defibrillator - in Great Britain.
     """
     dependentRequired: Any | None = None

package/pins_data_model/models/model_appeal_document.py

@@ -261,7 +261,7 @@ class AppealDocument(BaseModel):
     """
     The location of the published document, will be null if the datePublished is not set
     """
-    virusCheckStatus: VirusCheckStatus
+    virusCheckStatus: VirusCheckStatus | None
     """
     Indicates the virus check status for the current document
     """
@@ -291,43 +291,43 @@ class AppealDocument(BaseModel):
     """
     The last update date for the document
     """
-    caseType: CaseType
+    caseType: CaseType | None
     """
     The internal code for an appeal type, e.g. Householder (D)
     """
-    redactedStatus: RedactedStatus
+    redactedStatus: RedactedStatus | None
     """
     Indicates the redaction status for the document
     """
-    documentType: DocumentType
+    documentType: DocumentType | None
     """
     The type of document, used for exchange, migrations and consumption from the appeal back-office system
     """
-    sourceSystem: SourceSystem
+    sourceSystem: SourceSystem | None
     """
     The system mastering the metadata for the current document
     """
-    origin: Origin
+    origin: Origin | None
     """
     Indicates where the documents originates from
     """
-    owner: str | None = None
+    owner: str | None
     """
     Owner of the current document
     """
-    author: str | None = None
+    author: str | None
     """
     Name of person who authored document
     """
-    description: str | None = None
+    description: str | None
     """
     A custom description for the document
     """
-    caseStage: CaseStage
+    caseStage: CaseStage | None
     """
     The stage in the appeal process that has created the document
     """
-    horizonFolderId: str | None = None
+    horizonFolderId: str | None
     """
     The folder ID containing the document in Horizon
     """

package/pins_data_model/models/model_appeal_event.py

@@ -3,12 +3,12 @@
 
 from __future__ import annotations
 
-from enum import Enum
+from enum import StrEnum
 
 from pydantic import AwareDatetime, BaseModel, ConfigDict, Field
 
 
-class EventType(Enum):
+class EventType(StrEnum):
     """
     The type of event
     """
@@ -25,7 +25,7 @@ class EventType(Enum):
     pre_inquiry_virtual = "pre_inquiry_virtual"
 
 
-class EventStatus(Enum):
+class EventStatus(StrEnum):
     """
     Status of the event
     """
@@ -73,7 +73,7 @@ class AppealEvent(BaseModel):
     """
     Indicates if the event is urgent
     """
-    eventPublished: bool | None = None
+    eventPublished: bool | None
     """
     Indicates if the event has been published
     """

package/pins_data_model/models/model_appeal_event_estimate.py

@@ -22,15 +22,15 @@ class AppealEventEstimate(BaseModel):
     """
     The case reference the event estimate belongs to.
     """
-    preparationTime: float | None = None
+    preparationTime: float | None
     """
     Estimated inspector time (days) to prepare for event.
     """
-    sittingTime: float | None = None
+    sittingTime: float | None
     """
     Estimated inspector time (days) for event.
     """
-    reportingTime: float | None = None
+    reportingTime: float | None
     """
     Estimated inspector time (days) for event reporting.
     """