@planning-inspectorate/data-model 2.50.0 → 2.51.1

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?: {
@@ -3044,7 +3044,8 @@ export interface Event {
     | 'Preliminary Meeting'
     | 'Procedural Deadline (Pre-Examination)'
     | 'Procedural Decision'
-    | 'Publication Of';
+    | 'Publication Of'
+    | 'Unaccompanied Site Inspection';
   /**
    * Title Of Examination Timetable Event
    */
@@ -3289,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'
@@ -3474,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]
@@ -3695,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[];
   /**
@@ -4097,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
-			}
-		}
-	]
-}