@planning-inspectorate/data-model 2.26.0 → 2.27.0

package/docs/nsip-document.md

@@ -516,15 +516,17 @@ The location of the published document. Only applicable to documents which are p
 
 **enum**: the value of this property must be equal to one of the following values:
 
-| Value                            | Explanation |
-| :------------------------------- | :---------- |
-| `"not_redacted"`                 |             |
-| `"redacted"`                     |             |
-| `"awaiting_ai_redaction"`        |             |
-| `"ai_redaction_review_required"` |             |
-| `"ai_redaction_failed"`          |             |
-| `"no_redaction_required"`        |             |
-| `null`                           |             |
+| Value                              | Explanation |
+| :--------------------------------- | :---------- |
+| `"not_redacted"`                   |             |
+| `"redacted"`                       |             |
+| `"awaiting_ai_redaction"`          |             |
+| `"awaiting_ai_suggestions"`        |             |
+| `"ai_suggestions_reviewed"`        |             |
+| `"ai_suggestions_review_required"` |             |
+| `"ai_redaction_failed"`            |             |
+| `"no_redaction_required"`          |             |
+| `null`                             |             |
 
 ## publishedStatus
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planning-inspectorate/data-model",
-  "version": "2.26.0",
+  "version": "2.27.0",
   "description": "JSON Schemas for the Planning Inspectorate's Data Model",
   "main": "src/index.js",
   "type": "module",

package/pins_data_model/models/model_appeal_document.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-document.schema.json
-#   timestamp: 2026-02-20T13:48:33+00:00
+#   timestamp: 2026-03-02T10:53:29+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: 2026-02-20T13:48:32+00:00
+#   timestamp: 2026-03-02T10:53:30+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: 2026-02-20T13:48:32+00:00
+#   timestamp: 2026-03-02T10:53:30+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: 2026-02-20T13:48:33+00:00
+#   timestamp: 2026-03-02T10:53:30+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: 2026-02-20T13:48:33+00:00
+#   timestamp: 2026-03-02T10:53:30+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: 2026-02-20T13:48:33+00:00
+#   timestamp: 2026-03-02T10:53:30+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_dart_response.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  dart-response.schema.json
-#   timestamp: 2026-02-20T13:48:32+00:00
+#   timestamp: 2026-03-02T10:53:30+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: 2026-02-20T13:48:32+00:00
+#   timestamp: 2026-03-02T10:53:30+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: 2026-02-20T13:48:32+00:00
+#   timestamp: 2026-03-02T10:53:30+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: 2026-02-20T13:48:32+00:00
+#   timestamp: 2026-03-02T10:53:30+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: 2026-02-20T13:48:33+00:00
+#   timestamp: 2026-03-02T10:53:30+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: 2026-02-20T13:48:33+00:00
+#   timestamp: 2026-03-02T10:53:30+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: 2026-02-20T13:48:32+00:00
+#   timestamp: 2026-03-02T10:53:30+00:00
 
 from __future__ import annotations
 
@@ -26,7 +26,9 @@ class RedactedStatus(Enum):
     not_redacted = "not_redacted"
     redacted = "redacted"
     awaiting_ai_redaction = "awaiting_ai_redaction"
-    ai_redaction_review_required = "ai_redaction_review_required"
+    awaiting_ai_suggestions = "awaiting_ai_suggestions"
+    ai_suggestions_reviewed = "ai_suggestions_reviewed"
+    ai_suggestions_review_required = "ai_suggestions_review_required"
     ai_redaction_failed = "ai_redaction_failed"
     no_redaction_required = "no_redaction_required"
     NoneType_None = None

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: 2026-02-20T13:48:33+00:00
+#   timestamp: 2026-03-02T10:53:30+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_invoice.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-invoice.schema.json
-#   timestamp: 2026-02-20T13:48:32+00:00
+#   timestamp: 2026-03-02T10:53:30+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_meeting.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-meeting.schema.json
-#   timestamp: 2026-02-20T13:48:33+00:00
+#   timestamp: 2026-03-02T10:53:31+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: 2026-02-20T13:48:33+00:00
+#   timestamp: 2026-03-02T10:53:31+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: 2026-02-20T13:48:32+00:00
+#   timestamp: 2026-03-02T10:53:31+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: 2026-02-20T13:48:33+00:00
+#   timestamp: 2026-03-02T10:53:31+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: 2026-02-20T13:48:32+00:00
+#   timestamp: 2026-03-02T10:53:31+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: 2026-02-20T13:48:32+00:00
+#   timestamp: 2026-03-02T10:53:31+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: 2026-02-20T13:48:32+00:00
+#   timestamp: 2026-03-02T10:53:31+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: 2026-02-20T13:48:32+00:00
+#   timestamp: 2026-03-02T10:53:31+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: 2026-02-20T13:48:32+00:00
+#   timestamp: 2026-03-02T10:53:31+00:00
 
 from __future__ import annotations
 

package/schemas/nsip-document.schema.json

@@ -133,7 +133,9 @@
         "not_redacted",
         "redacted",
         "awaiting_ai_redaction",
-        "ai_redaction_review_required",
+        "awaiting_ai_suggestions",
+        "ai_suggestions_reviewed",
+        "ai_suggestions_review_required",
         "ai_redaction_failed",
         "no_redaction_required",
         null

package/src/enums.cjs

@@ -630,8 +630,10 @@ const NSIP_RECOMMENDATION = Object.freeze({
 
 const NSIP_REDACTED_STATUS = Object.freeze({
   AI_REDACTION_FAILED: 'ai_redaction_failed',
-  AI_REDACTION_REVIEW_REQUIRED: 'ai_redaction_review_required',
+  AI_SUGGESTIONS_REVIEW_REQUIRED: 'ai_suggestions_review_required',
+  AI_SUGGESTIONS_REVIEWED: 'ai_suggestions_reviewed',
   AWAITING_AI_REDACTION: 'awaiting_ai_redaction',
+  AWAITING_AI_SUGGESTIONS: 'awaiting_ai_suggestions',
   NO_REDACTION_REQUIRED: 'no_redaction_required',
   NOT_REDACTED: 'not_redacted',
   REDACTED: 'redacted',

package/src/enums.d.ts

@@ -628,8 +628,10 @@ export const NSIP_RECOMMENDATION = {
 
 export const NSIP_REDACTED_STATUS = {
   AI_REDACTION_FAILED: 'ai_redaction_failed',
-  AI_REDACTION_REVIEW_REQUIRED: 'ai_redaction_review_required',
+  AI_SUGGESTIONS_REVIEW_REQUIRED: 'ai_suggestions_review_required',
+  AI_SUGGESTIONS_REVIEWED: 'ai_suggestions_reviewed',
   AWAITING_AI_REDACTION: 'awaiting_ai_redaction',
+  AWAITING_AI_SUGGESTIONS: 'awaiting_ai_suggestions',
   NO_REDACTION_REQUIRED: 'no_redaction_required',
   NOT_REDACTED: 'not_redacted',
   REDACTED: 'redacted',

package/src/enums.js

@@ -628,8 +628,10 @@ export const NSIP_RECOMMENDATION = Object.freeze({
 
 export const NSIP_REDACTED_STATUS = Object.freeze({
   AI_REDACTION_FAILED: 'ai_redaction_failed',
-  AI_REDACTION_REVIEW_REQUIRED: 'ai_redaction_review_required',
+  AI_SUGGESTIONS_REVIEW_REQUIRED: 'ai_suggestions_review_required',
+  AI_SUGGESTIONS_REVIEWED: 'ai_suggestions_reviewed',
   AWAITING_AI_REDACTION: 'awaiting_ai_redaction',
+  AWAITING_AI_SUGGESTIONS: 'awaiting_ai_suggestions',
   NO_REDACTION_REQUIRED: 'no_redaction_required',
   NOT_REDACTED: 'not_redacted',
   REDACTED: 'redacted',

package/src/index.cjs

@@ -711,8 +711,10 @@ const NSIP_RECOMMENDATION = Object.freeze({
 
 const NSIP_REDACTED_STATUS = Object.freeze({
   AI_REDACTION_FAILED: 'ai_redaction_failed',
-  AI_REDACTION_REVIEW_REQUIRED: 'ai_redaction_review_required',
+  AI_SUGGESTIONS_REVIEW_REQUIRED: 'ai_suggestions_review_required',
+  AI_SUGGESTIONS_REVIEWED: 'ai_suggestions_reviewed',
   AWAITING_AI_REDACTION: 'awaiting_ai_redaction',
+  AWAITING_AI_SUGGESTIONS: 'awaiting_ai_suggestions',
   NO_REDACTION_REQUIRED: 'no_redaction_required',
   NOT_REDACTED: 'not_redacted',
   REDACTED: 'redacted',

package/src/index.d.ts

@@ -1,17 +1,7 @@
 import * as Schemas from './schemas.js';
 export * from './enums.js';
 
-export interface LoadedSchemas {
-	schemas: {
-		[name: string]: any;
-	};
-	commands: {
-		[name: string]: any;
-	};
-	appealsComponents: {
-		[name: string]: any;
-	};
-}
+export type LoadedSchemas = Schemas.SchemaMap;
 
 export const schemasPath: string;
 export const commandsPath: string;

package/src/lib/gen-types.js

@@ -1,55 +1,101 @@
 import fs from 'fs/promises';
 import path from 'path';
 import url from 'url';
-import { loadAllSchemas } from '../index.js';
+import { commandsPath, loadAllSchemas, schemasPath } from '../index.js';
 import { compile } from 'json-schema-to-typescript';
-import { schemasPath, commandsPath } from '../index.js';
+import { generateName } from 'json-schema-to-typescript/dist/src/utils.js';
 
 const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
 
 export const typesPath = path.join(__dirname, '..', 'schemas.d.ts');
 
+const schemaTypeNames = new Map();
+
 /**
  * Load all schemas and generate TypeScript definitions
  */
 async function run() {
 	const s = await loadAllSchemas();
+	const schemaKeys = Object.keys(s.schemas).sort();
+	const commandKeys = Object.keys(s.commands).sort();
+	const appealsComponentKeys = Object.keys(s.appealsComponents).sort();
 
-	let types = '';
-	let first = true;
+	/** @type {string[]} */
+	const typeDefinitions = [];
+	const typesMap = {
+		schemas: {},
+		commands: {},
+		appealsComponents: {}
+	};
 
-	for (const schemaName of Object.keys(s.schemas).sort()) {
-		const schema = s.schemas[schemaName];
-		types += await compile(schema, schema['$id'], options(first));
-		types += '\n';
-		first = false;
+	for (let i = 0; i < schemaKeys.length; i++) {
+		const schemaKey = schemaKeys[i];
+		const schema = s.schemas[schemaKey];
+		typeDefinitions.push(await compile(schema, schema['$id'], options(i === 0)));
+		typesMap.schemas[schemaKey] = schemaTypeName(schema, typeDefinitions);
 	}
 
-	for (const commandName of Object.keys(s.commands).sort()) {
-		const schema = s.commands[commandName];
+	for (const schemaKey of commandKeys) {
+		const schema = s.commands[schemaKey];
+		typeDefinitions.push(await commandSchemaToTypeString(schema, schemaKey));
+		typesMap.commands[schemaKey] = schemaTypeName(schema, typeDefinitions);
+	}
 
-		if (
-			commandName.startsWith('appeal') ||
-			commandName.startsWith('appellant') ||
-			commandName.startsWith('lpa-questionnaire')
-		) {
-			// hack to allow nested $ref links to function in tests and gen types,
-			// can we leverage a better means to resolve $refs that aligns with how tests/appeals references this
-			types += await compile(schema, schema['$id'], options(first, commandsPath));
-		} else {
-			types += await compile(schema, schema['$id'], options(first));
-		}
+	for (const schemaKey of appealsComponentKeys) {
+		const schema = s.appealsComponents[schemaKey];
+		// no need to generate types, will be included by the schemas and commands
+		typesMap.appealsComponents[schemaKey] = schemaTypeName(schema, typeDefinitions);
+	}
 
-		types += '\n';
-		first = false;
+	let types = typeDefinitions.join('\n');
+	types += `\nexport type SchemaMap = {`;
+	for (const [k, map] of Object.entries(typesMap)) {
+		types += `\n  ${k}: {\n    `;
+		types += Object.entries(map)
+			.map(([a, b]) => `'${a}': ${b};`)
+			.join('\n    ');
+		types += `\n  }`;
 	}
+	types += `\n};\n`;
 
 	await fs.writeFile(typesPath, types);
 }
 
+function commandSchemaToTypeString(schema, name) {
+	let refPath;
+	// hack to allow nested $ref links to function in tests and gen types,
+	// can we leverage a better means to resolve $refs that aligns with how tests/appeals references this
+	if (['appeal', 'appellant', 'lpa-questionnaire'].some((prefix) => name.startsWith(prefix))) {
+		refPath = commandsPath;
+	}
+	return compile(schema, schema['$id'], options(false, refPath));
+}
+
+/**
+ * @param {any} schema
+ * @param {string[]} types
+ * @returns {string}
+ */
+function schemaTypeName(schema, types) {
+	const name = generateName(schema.title || schema['$id'], new Set());
+	if (schemaTypeNames.has(name)) {
+		throw new Error(
+			`Schema with type name ${name} already exists (schemas ${schema['$id']}, ${schemaTypeNames.get(name)})\nEnsure schema title fields are unique and match the ID`
+		);
+	}
+	// check the type name is in the generated types
+	if (
+		types.some((typeStr) => typeStr.includes(`export interface ${name}`) || typeStr.includes(`export type ${name}`))
+	) {
+		schemaTypeNames.set(name, schema['$id']);
+		return name;
+	}
+	throw new Error(`${name} not found in type definition`);
+}
+
 /**
- *
  * @param {boolean} first
+ * @param {string} [refPath]
  * @returns {Partial<import('json-schema-to-typescript').Options>}
  */
 function options(first, refPath = schemasPath) {

package/src/schemas.d.ts

@@ -2153,7 +2153,9 @@ export interface NSIPDocument {
     | 'not_redacted'
     | 'redacted'
     | 'awaiting_ai_redaction'
-    | 'ai_redaction_review_required'
+    | 'awaiting_ai_suggestions'
+    | 'ai_suggestions_reviewed'
+    | 'ai_suggestions_review_required'
     | 'ai_redaction_failed'
     | 'no_redaction_required'
     | null;
@@ -5057,3 +5059,68 @@ export interface InterestedParty1 {
   [k: string]: unknown;
 }
 
+export type SchemaMap = {
+  schemas: {
+    'appeal-document.schema.json': AppealDocument;
+    'appeal-event-estimate.schema.json': AppealEventEstimate;
+    'appeal-event.schema.json': AppealEvent;
+    'appeal-has.schema.json': AppealHASCase;
+    'appeal-representation.schema.json': AppealRepresentation;
+    'appeal-s78.schema.json': AppealS78Case;
+    'dart-response.schema.json': DaRTAPIResponse;
+    'entraid.schema.json': EntraIDUserObjects;
+    'folder.schema.json': Folder;
+    'gettimesheets-response.schema.json': GetTimesheetsAPIResponse;
+    'listed-building.schema.json': ListedBuilding;
+    'listed-buildings.schema.json': ListedBuildings;
+    'nsip-document.schema.json': NSIPDocument;
+    'nsip-exam-timetable.schema.json': ExaminationTimetable;
+    'nsip-invoice.schema.json': NSIPInvoice;
+    'nsip-meeting.schema.json': NSIPMeeting;
+    'nsip-project-update.schema.json': NSIPProjectUpdate;
+    'nsip-project.schema.json': NSIPProject;
+    'nsip-representation.schema.json': Representation;
+    'nsip-subscription.schema.json': NsipSubscription;
+    'pins-inspector.schema.json': PINSInspector;
+    'pins-lpa.schema.json': PINSLPA;
+    's51-advice.schema.json': S51Advice;
+    'service-user.schema.json': ServiceUser;
+  }
+  commands: {
+    'appeal-representation-submission.schema.json': AppealRepresentationSubmission;
+    'appellant-submission.schema.json': AppellantSubmissionCommand;
+    'interested-party.schema.json': InterestedParty;
+    'lpa-questionnaire.schema.json': LPAQuestionnaireCommand;
+    'new-deadline-submission.schema.json': NewDeadlineSubmission;
+    'nsip-exam-timetable-submission.schema.json': NsipExamTimetableSubmission;
+    'register-nsip-subscription.schema.json': RegisterNsipSubscription;
+    'register-representation.schema.json': RegisterRepresentation;
+  }
+  appealsComponents: {
+    'appeal-advert.submission.schema.json': AdvertSpecificProperties;
+    'appeal-common-planning.schema.json': AppellantCommonPlanningProperties;
+    'appeal-common-submission.schema.json': AppellantCommonSubmissionProperties;
+    'appeal-enforcement-common-submission.schema.json': AppellantEnforcementCommonSubmissionProperties;
+    'appeal-enforcement-listed-submission.schema.json': AppellantEnforcementListedBuildingSubmissionProperties;
+    'appeal-enforcement-notice-submission.schema.json': AppellantEnforcementNoticeSpecificSubmissionProperties;
+    'appeal-land-ownership.schema.json': AppealLandOwnershipProperties;
+    'appeal-ldc.submission.schema.json': LDCSpecificProperties;
+    'appeal-planning-obligation.submission.schema.json': PlanningObligationSpecificProperties;
+    'appeal-s78-submission.schema.json': AppellantS78SubmissionProperties;
+    'appeal-site-area.schema.json': SiteAreaProperties;
+    'appellant-procedure-preference.schema.json': AppellantProcedurePreferenceProperties;
+    'changed-listed-building-number.schema.json': ChangedListedBuildingNumbersProperties;
+    'environmental-impact-assessment.schema.json': EnvironmentalImpactAssessmentProperties;
+    'infrastructure-levy.schema.json': InfrastructureLevyProperties;
+    'lpa-procedure-preference.schema.json': LPAProcedurePreferenceProperties;
+    'lpa-questionnaire-advert.schema.json': LPAQCasAdvertSubmissionProperties;
+    'lpa-questionnaire-common.schema.json': LPAQCommonSubmissionProperties;
+    'lpa-questionnaire-enforcement-common.schema.json': LPAQEnforcementCommonSubmissionProperties;
+    'lpa-questionnaire-enforcement.schema.json': LPAQEnforcementSubmissionProperties;
+    'lpa-questionnaire-has.schema.json': LPAQHASSubmissionProperties;
+    'lpa-questionnaire-ldc.schema.json': LPAQLDCSubmissionProperties;
+    'lpa-questionnaire-listed-building.schema.json': LPAQListedBuildingSubmissionProperties;
+    'lpa-questionnaire-s78.schema.json': LPAQS78SubmissionProperties;
+    'site-designations-protection.schema.json': SiteDesignationsAndProtectionSpecificProperties;
+  }
+};