@planning-inspectorate/data-model 2.51.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/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.51.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/models/model_address.py

@@ -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/prettier.config.js

@@ -0,0 +1,13 @@
+import { prettierConfig } from '@planning-inspectorate/coding-standards';
+
+export default {
+	...prettierConfig,
+	overrides: [
+		{
+			files: '*.json',
+			options: {
+				useTabs: false
+			}
+		}
+	]
+};

package/schemas/address.schema.json

@@ -75,7 +75,7 @@
     "UPRN": {
       "type": ["string", "null"],
       "example": 100023336956,
-      "description": "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."
+      "description": "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": {
       "easting": ["northing"],

package/src/index.cjs

@@ -2,8 +2,8 @@
 
 var path = require('path');
 var url = require('url');
-var promises = require('fs/promises');
 var fs = require('fs');
+var promises = require('fs/promises');
 var jsoncParser = require('jsonc-parser');
 
 var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;

package/src/lib/gen-docs.js

@@ -1,6 +1,6 @@
 import { jsonschema2md } from '@adobe/jsonschema2md';
-import { loadAllSchemas } from '../index.js';
 import fs from 'fs/promises';
+import { loadAllSchemas } from '../index.js';
 
 /**
  * @typedef {import('@adobe/jsonschema2md').SchemaFiles} SchemaFiles

package/src/lib/gen-enum-impl.test.js

@@ -1,6 +1,6 @@
+import assert from 'node:assert';
 import { describe, it } from 'node:test';
 import { collectEnumProps, generateConstants, generateEnumMap } from './gen-enum-impl.js';
-import assert from 'node:assert';
 
 describe('gen-enum-impl', () => {
 	describe('generateConstants', () => {

package/src/lib/gen-enums.js

@@ -1,8 +1,8 @@
 import fs from 'fs/promises';
 import path from 'path';
 import { loadAllSchemas } from '../index.js';
-import { loadSchema } from './load.js';
 import { collectEnumProps, generateConstants, generateEnumMap } from './gen-enum-impl.js';
+import { loadSchema } from './load.js';
 
 const __dirname = import.meta.dirname;
 

package/src/lib/gen-types.js

@@ -1,9 +1,9 @@
 import fs from 'fs/promises';
+import { compile } from 'json-schema-to-typescript';
+import { generateName } from 'json-schema-to-typescript/dist/src/utils.js';
 import path from 'path';
 import url from 'url';
 import { commandsPath, loadAllSchemas, schemasPath } from '../index.js';
-import { compile } from 'json-schema-to-typescript';
-import { generateName } from 'json-schema-to-typescript/dist/src/utils.js';
 
 const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
 

package/src/lib/load.js

@@ -1,5 +1,5 @@
-import { readFile, readdir } from 'fs/promises';
 import { readFileSync, readdirSync } from 'fs';
+import { readFile, readdir } from 'fs/promises';
 import { parse } from 'jsonc-parser';
 import path from 'path';
 

package/src/schemas.d.ts

@@ -44,7 +44,7 @@ export interface PINSAddressSchema {
   latitudeWGS84?: number | null;
   longitudeWGS84?: number | null;
   /**
-   * 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?: string | null;
   dependentRequired?: {
@@ -3290,6 +3290,9 @@ export interface NSIPProject {
    * PINS Project email address pubished on website
    */
   projectEmailAddress: string | null;
+  /**
+   * Items: Geographical region of UK. Applications can cover multiple regions.
+   */
   regions: (
     | 'east_midlands'
     | 'eastern'
@@ -3475,12 +3478,21 @@ export interface NSIPProject {
    * Maps to [Employee].[EmployeeID]
    */
   caseManagerId: string | null;
+  /**
+   * Items: Maps to [Employee].[EmployeeID].
+   */
   nsipOfficerIds: string[];
+  /**
+   * Items: Maps to [Employee].[EmployeeID].
+   */
   nsipAdministrationOfficerIds: string[];
   /**
    * Maps to [Employee].[EmployeeID]
    */
   leadInspectorId: string | null;
+  /**
+   * Items: Maps to [Employee].[EmployeeID]
+   */
   inspectorIds: string[];
   /**
    * Maps to [Employee].[EmployeeID]
@@ -3696,26 +3708,38 @@ export interface NSIPProject {
   estimatedPrelimMeetingDate?: string | null;
   /**
    * Maps to [Employee].[EmployeeID].
+   *
+   * Items: Maps to [Employee].[EmployeeID].
    */
   operationsLeadIds?: string[];
   /**
    * New NSIP role, Maps to [Employee].[EmployeeID]
+   *
+   * Items: Maps to [Employee].[EmployeeID].
    */
   operationsManagerIds?: string[];
   /**
    * Maps to [Employee].[EmployeeID].
+   *
+   * Items: Maps to [Employee].[EmployeeID].
    */
   caseManagerIds?: string[];
   /**
    * Maps to [Employee].[EmployeeID].
+   *
+   * Items: Maps to [Employee].[EmployeeID].
    */
   leadInspectorIds?: string[];
   /**
    * Maps to [Employee].[EmployeeID].
+   *
+   * Items: Maps to [Employee].[EmployeeID].
    */
   environmentalServicesOfficerIds?: string[];
   /**
    * Maps to [Employee].[EmployeeID].
+   *
+   * Items: Maps to [Employee].[EmployeeID].
    */
   legalOfficerIds?: string[];
   /**
@@ -4098,6 +4122,9 @@ export interface S51Advice {
   adviceDetailsWelsh?: string | null;
   status: 'checked' | 'unchecked' | 'readytopublish' | 'published' | 'donotpublish' | null;
   redactionStatus: 'unredacted' | 'redacted' | null;
+  /**
+   * Items: Collection of document IDs which are related to the S51 Advice
+   */
   attachmentIds: string[];
   [k: string]: unknown;
 }

package/tests/appeals/appeal-event.test.js

@@ -1,7 +1,7 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert';
 import Ajv from 'ajv';
 import addFormats from 'ajv-formats';
+import assert from 'node:assert';
+import { describe, it } from 'node:test';
 import { loadAllSchemasSync } from '../../src/index.js';
 
 const schema = 'appeal-event.schema.json';

package/tests/appeals/appeal-has.test.js

@@ -1,7 +1,7 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert';
 import Ajv from 'ajv';
 import addFormats from 'ajv-formats';
+import assert from 'node:assert';
+import { describe, it } from 'node:test';
 import { loadAllSchemasSync } from '../../src/index.js';
 
 const schema = 'appeal-has.schema.json';

package/tests/appeals/appeal-s78.test.js

@@ -1,7 +1,7 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert';
 import Ajv from 'ajv';
 import addFormats from 'ajv-formats';
+import assert from 'node:assert';
+import { describe, it } from 'node:test';
 import { loadAllSchemasSync } from '../../src/index.js';
 
 const schema = 'appeal-s78.schema.json';

package/tests/appeals/commands/adverts-questionnaire.test.js

@@ -1,7 +1,7 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert';
 import Ajv from 'ajv';
 import addFormats from 'ajv-formats';
+import assert from 'node:assert';
+import { describe, it } from 'node:test';
 import { loadAllSchemasSync } from '../../../src/index.js';
 
 const schema = 'lpa-questionnaire.schema.json';

package/tests/appeals/commands/adverts-submission.test.js

@@ -1,7 +1,7 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert';
 import Ajv from 'ajv';
 import addFormats from 'ajv-formats';
+import assert from 'node:assert';
+import { describe, it } from 'node:test';
 import { loadAllSchemasSync } from '../../../src/index.js';
 
 const schema = 'appellant-submission.schema.json';

package/tests/appeals/commands/appeal-representation-submission.test.js

@@ -1,7 +1,7 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert';
 import Ajv from 'ajv';
 import addFormats from 'ajv-formats';
+import assert from 'node:assert';
+import { describe, it } from 'node:test';
 import { loadAllSchemasSync } from '../../../src/index.js';
 
 const schema = 'commands/appeal-representation-submission.schema.json';

package/tests/appeals/commands/cas-adverts-questionnaire.test.js

@@ -1,7 +1,7 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert';
 import Ajv from 'ajv';
 import addFormats from 'ajv-formats';
+import assert from 'node:assert';
+import { describe, it } from 'node:test';
 import { loadAllSchemasSync } from '../../../src/index.js';
 
 const schema = 'lpa-questionnaire.schema.json';

package/tests/appeals/commands/cas-adverts-submission.test.js

@@ -1,7 +1,7 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert';
 import Ajv from 'ajv';
 import addFormats from 'ajv-formats';
+import assert from 'node:assert';
+import { describe, it } from 'node:test';
 import { loadAllSchemasSync } from '../../../src/index.js';
 
 const schema = 'appellant-submission.schema.json';

package/tests/appeals/commands/enforcement-listed-questionnaire.test.js

@@ -1,7 +1,7 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert';
 import Ajv from 'ajv';
 import addFormats from 'ajv-formats';
+import assert from 'node:assert';
+import { describe, it } from 'node:test';
 import { loadAllSchemasSync } from '../../../src/index.js';
 
 const schema = 'lpa-questionnaire.schema.json';

package/tests/appeals/commands/enforcement-listed-submission.test.js

@@ -1,7 +1,7 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert';
 import Ajv from 'ajv';
 import addFormats from 'ajv-formats';
+import assert from 'node:assert';
+import { describe, it } from 'node:test';
 import { loadAllSchemasSync } from '../../../src/index.js';
 
 const schema = 'appellant-submission.schema.json';

package/tests/appeals/commands/enforcement-notice-submission.test.js

@@ -1,7 +1,7 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert';
 import Ajv from 'ajv';
 import addFormats from 'ajv-formats';
+import assert from 'node:assert';
+import { describe, it } from 'node:test';
 import { loadAllSchemasSync } from '../../../src/index.js';
 
 const schema = 'appellant-submission.schema.json';

package/tests/appeals/commands/enforcement-questionnaire.test.js

@@ -1,7 +1,7 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert';
 import Ajv from 'ajv';
 import addFormats from 'ajv-formats';
+import assert from 'node:assert';
+import { describe, it } from 'node:test';
 import { loadAllSchemasSync } from '../../../src/index.js';
 
 const schema = 'lpa-questionnaire.schema.json';

package/tests/appeals/commands/has-questionnaire.test.js

@@ -1,7 +1,7 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert';
 import Ajv from 'ajv';
 import addFormats from 'ajv-formats';
+import assert from 'node:assert';
+import { describe, it } from 'node:test';
 import { loadAllSchemasSync } from '../../../src/index.js';
 
 const schema = 'lpa-questionnaire.schema.json';

package/tests/appeals/commands/has-submission.test.js

@@ -1,7 +1,7 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert';
 import Ajv from 'ajv';
 import addFormats from 'ajv-formats';
+import assert from 'node:assert';
+import { describe, it } from 'node:test';
 import { loadAllSchemasSync } from '../../../src/index.js';
 
 const schema = 'appellant-submission.schema.json';

package/tests/appeals/commands/ldc-questionnaire.test.js

@@ -1,7 +1,7 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert';
 import Ajv from 'ajv';
 import addFormats from 'ajv-formats';
+import assert from 'node:assert';
+import { describe, it } from 'node:test';
 import { loadAllSchemasSync } from '../../../src/index.js';
 
 const schema = 'lpa-questionnaire.schema.json';

package/tests/appeals/commands/ldc-submission.test.js

@@ -1,7 +1,7 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert';
 import Ajv from 'ajv';
 import addFormats from 'ajv-formats';
+import assert from 'node:assert';
+import { describe, it } from 'node:test';
 import { loadAllSchemasSync } from '../../../src/index.js';
 
 const schema = 'appellant-submission.schema.json';

package/tests/appeals/commands/s20-questionnaire.test.js

@@ -1,7 +1,7 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert';
 import Ajv from 'ajv';
 import addFormats from 'ajv-formats';
+import assert from 'node:assert';
+import { describe, it } from 'node:test';
 import { loadAllSchemasSync } from '../../../src/index.js';
 
 const schema = 'lpa-questionnaire.schema.json';

package/tests/appeals/commands/s78-questionnaire.test.js

@@ -1,7 +1,7 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert';
 import Ajv from 'ajv';
 import addFormats from 'ajv-formats';
+import assert from 'node:assert';
+import { describe, it } from 'node:test';
 import { loadAllSchemasSync } from '../../../src/index.js';
 
 const schema = 'lpa-questionnaire.schema.json';

package/tests/appeals/commands/s78-submission.test.js

@@ -1,7 +1,7 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert';
 import Ajv from 'ajv';
 import addFormats from 'ajv-formats';
+import assert from 'node:assert';
+import { describe, it } from 'node:test';
 import { loadAllSchemasSync } from '../../../src/index.js';
 
 const schema = 'appellant-submission.schema.json';

package/tests/appeals/expedited-appeals.test.js

@@ -1,7 +1,7 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert';
 import Ajv from 'ajv';
 import addFormats from 'ajv-formats';
+import assert from 'node:assert';
+import { describe, it } from 'node:test';
 import { loadAllSchemasSync } from '../../src/index.js';
 
 const schema = 'appeal-s78.schema.json';

package/tests/schemas.test.js

@@ -1,6 +1,6 @@
-import { describe, it } from 'node:test';
 import Ajv from 'ajv';
 import addFormats from 'ajv-formats';
+import { describe, it } from 'node:test';
 import { loadAllSchemasSync } from '../src/index.js';
 
 describe('schemas', () => {

package/.prettierrc

@@ -1,19 +0,0 @@
-{
-	"printWidth": 120,
-	"tabWidth": 2,
-	"singleQuote": true,
-	"useTabs": true,
-	"semi": true,
-	"trailingComma": "none",
-	"bracketSpacing": true,
-	"arrowParens": "always",
-	"plugins": [],
-	"overrides": [
-		{
-			"files": "*.json",
-			"options": {
-				"useTabs": false
-			}
-		}
-	]
-}