@planning-inspectorate/data-model 2.48.1 → 2.49.0

package/docs/appeal-has.md

@@ -17,7 +17,7 @@ any of
 | [submissionId](#submissionid)                                                                       | `string`  | Optional | can be null    | [Appeal HAS Case](appeal-has-properties-submissionid.md "appeal-has.schema.json#/properties/submissionId")                                                                       |
 | [caseStatus](#casestatus)                                                                           | `string`  | Required | cannot be null | [Appeal HAS Case](appeal-has-properties-casestatus.md "appeal-has.schema.json#/properties/caseStatus")                                                                           |
 | [caseType](#casetype)                                                                               | `string`  | Required | cannot be null | [Appeal HAS Case](appeal-has-properties-casetype.md "appeal-has.schema.json#/properties/caseType")                                                                               |
-| [caseProcedure](#caseprocedure)                                                                     | `string`  | Required | cannot be null | [Appeal HAS Case](appeal-has-properties-caseprocedure.md "appeal-has.schema.json#/properties/caseProcedure")                                                                     |
+| [caseProcedure](#caseprocedure)                                                                     | `string`  | Required | can be null    | [Appeal HAS Case](appeal-has-properties-caseprocedure.md "appeal-has.schema.json#/properties/caseProcedure")                                                                     |
 | [lpaCode](#lpacode)                                                                                 | `string`  | Required | cannot be null | [Appeal HAS Case](appeal-has-properties-lpacode.md "appeal-has.schema.json#/properties/lpaCode")                                                                                 |
 | [caseOfficerId](#caseofficerid)                                                                     | `string`  | Required | can be null    | [Appeal HAS Case](appeal-has-properties-caseofficerid.md "appeal-has.schema.json#/properties/caseOfficerId")                                                                     |
 | [inspectorId](#inspectorid)                                                                         | `string`  | Required | can be null    | [Appeal HAS Case](appeal-has-properties-inspectorid.md "appeal-has.schema.json#/properties/inspectorId")                                                                         |
@@ -287,7 +287,7 @@ The type of procedure for the appeal
 
 * Type: `string`
 
-* cannot be null
+* can be null
 
 * defined in: [Appeal HAS Case](appeal-has-properties-caseprocedure.md "appeal-has.schema.json#/properties/caseProcedure")
 
@@ -299,11 +299,14 @@ The type of procedure for the appeal
 
 **enum**: the value of this property must be equal to one of the following values:
 
-| Value       | Explanation |
-| :---------- | :---------- |
-| `"written"` |             |
-| `"hearing"` |             |
-| `"inquiry"` |             |
+| Value            | Explanation |
+| :--------------- | :---------- |
+| `"written"`      |             |
+| `"hearing"`      |             |
+| `"inquiry"`      |             |
+| `"writtenPart1"` |             |
+| `"writtenPart2"` |             |
+| `null`           |             |
 
 ## lpaCode
 

package/package.json

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

package/pins_data_model/models/model_appeal_has.py

@@ -59,6 +59,9 @@ class CaseProcedure(Enum):
     written = "written"
     hearing = "hearing"
     inquiry = "inquiry"
+    writtenPart1 = "writtenPart1"
+    writtenPart2 = "writtenPart2"
+    NoneType_None = None
 
 
 class AllocationLevel(Enum):

package/schemas/appeal-has.schema.json

@@ -135,8 +135,8 @@
       "description": "The internal code for an appeal type, e.g. D (Householder)"
     },
     "caseProcedure": {
-      "type": "string",
-      "enum": ["written", "hearing", "inquiry"],
+      "type": ["string", "null"],
+      "enum": ["written", "hearing", "inquiry", "writtenPart1", "writtenPart2", null],
       "description": "The type of procedure for the appeal"
     },
     "lpaCode": {

package/src/enums.cjs

@@ -7,12 +7,6 @@ const APPEAL_HAS_CASE_DECISION_OUTCOME = Object.freeze({
   SPLIT_DECISION: 'split_decision',
 });
 
-const APPEAL_HAS_CASE_PROCEDURE = Object.freeze({
-  HEARING: 'hearing',
-  INQUIRY: 'inquiry',
-  WRITTEN: 'written',
-});
-
 const APPEAL_HAS_CASE_STATUS = Object.freeze({
   ASSIGN_CASE_OFFICER: 'assign_case_officer',
   AWAITING_EVENT: 'awaiting_event',
@@ -854,7 +848,6 @@ exports.APPEAL_EIA_ENVIRONMENTAL_IMPACT_SCHEDULE = APPEAL_EIA_ENVIRONMENTAL_IMPA
 exports.APPEAL_EVENT_STATUS = APPEAL_EVENT_STATUS;
 exports.APPEAL_EVENT_TYPE = APPEAL_EVENT_TYPE;
 exports.APPEAL_HAS_CASE_DECISION_OUTCOME = APPEAL_HAS_CASE_DECISION_OUTCOME;
-exports.APPEAL_HAS_CASE_PROCEDURE = APPEAL_HAS_CASE_PROCEDURE;
 exports.APPEAL_HAS_CASE_STATUS = APPEAL_HAS_CASE_STATUS;
 exports.APPEAL_HAS_TYPE_OF_PLANNING_APPLICATION = APPEAL_HAS_TYPE_OF_PLANNING_APPLICATION;
 exports.APPEAL_INVALID_OR_INCOMPLETE_DETAILS = APPEAL_INVALID_OR_INCOMPLETE_DETAILS;

package/src/enums.d.ts

@@ -5,12 +5,6 @@ export const APPEAL_HAS_CASE_DECISION_OUTCOME = {
   SPLIT_DECISION: 'split_decision',
 } as const;
 
-export const APPEAL_HAS_CASE_PROCEDURE = {
-  HEARING: 'hearing',
-  INQUIRY: 'inquiry',
-  WRITTEN: 'written',
-} as const;
-
 export const APPEAL_HAS_CASE_STATUS = {
   ASSIGN_CASE_OFFICER: 'assign_case_officer',
   AWAITING_EVENT: 'awaiting_event',

package/src/enums.js

@@ -5,12 +5,6 @@ export const APPEAL_HAS_CASE_DECISION_OUTCOME = Object.freeze({
   SPLIT_DECISION: 'split_decision',
 });
 
-export const APPEAL_HAS_CASE_PROCEDURE = Object.freeze({
-  HEARING: 'hearing',
-  INQUIRY: 'inquiry',
-  WRITTEN: 'written',
-});
-
 export const APPEAL_HAS_CASE_STATUS = Object.freeze({
   ASSIGN_CASE_OFFICER: 'assign_case_officer',
   AWAITING_EVENT: 'awaiting_event',

package/src/index.cjs

@@ -88,12 +88,6 @@ const APPEAL_HAS_CASE_DECISION_OUTCOME = Object.freeze({
   SPLIT_DECISION: 'split_decision',
 });
 
-const APPEAL_HAS_CASE_PROCEDURE = Object.freeze({
-  HEARING: 'hearing',
-  INQUIRY: 'inquiry',
-  WRITTEN: 'written',
-});
-
 const APPEAL_HAS_CASE_STATUS = Object.freeze({
   ASSIGN_CASE_OFFICER: 'assign_case_officer',
   AWAITING_EVENT: 'awaiting_event',
@@ -967,7 +961,6 @@ exports.APPEAL_EIA_ENVIRONMENTAL_IMPACT_SCHEDULE = APPEAL_EIA_ENVIRONMENTAL_IMPA
 exports.APPEAL_EVENT_STATUS = APPEAL_EVENT_STATUS;
 exports.APPEAL_EVENT_TYPE = APPEAL_EVENT_TYPE;
 exports.APPEAL_HAS_CASE_DECISION_OUTCOME = APPEAL_HAS_CASE_DECISION_OUTCOME;
-exports.APPEAL_HAS_CASE_PROCEDURE = APPEAL_HAS_CASE_PROCEDURE;
 exports.APPEAL_HAS_CASE_STATUS = APPEAL_HAS_CASE_STATUS;
 exports.APPEAL_HAS_TYPE_OF_PLANNING_APPLICATION = APPEAL_HAS_TYPE_OF_PLANNING_APPLICATION;
 exports.APPEAL_INVALID_OR_INCOMPLETE_DETAILS = APPEAL_INVALID_OR_INCOMPLETE_DETAILS;

package/src/schemas.d.ts

@@ -381,7 +381,7 @@ export type AppealHASCase = (GridReference | SiteAddress) & {
   /**
    * The type of procedure for the appeal
    */
-  caseProcedure: 'written' | 'hearing' | 'inquiry';
+  caseProcedure: 'written' | 'hearing' | 'inquiry' | 'writtenPart1' | 'writtenPart2' | null;
   /**
    * A unique identifier for the Local Planning Authority
    */

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

@@ -329,4 +329,38 @@ describe(schema, () => {
 		const validationResult = ajv.validate(schema, test);
 		assert.strictEqual(validationResult, true);
 	});
+
+	describe('caseProcedure schema validation (Group A - HAS)', () => {
+		it('should accept existing values: written, hearing, inquiry', () => {
+			for (const proc of ['written', 'hearing', 'inquiry']) {
+				const test = structuredClone(appealHas);
+				test.caseProcedure = proc;
+				const validationResult = ajv.validate(schema, test);
+				assert.strictEqual(validationResult, true, `Expected caseProcedure "${proc}" to be valid`);
+			}
+		});
+
+		it('should accept new expedited appeal values: writtenPart1, writtenPart2', () => {
+			for (const proc of ['writtenPart1', 'writtenPart2']) {
+				const test = structuredClone(appealHas);
+				test.caseProcedure = proc;
+				const validationResult = ajv.validate(schema, test);
+				assert.strictEqual(validationResult, true, `Expected caseProcedure "${proc}" to be valid`);
+			}
+		});
+
+		it('should accept null value for caseProcedure', () => {
+			const test = structuredClone(appealHas);
+			test.caseProcedure = null;
+			const validationResult = ajv.validate(schema, test);
+			assert.strictEqual(validationResult, true, 'Expected caseProcedure null to be valid');
+		});
+
+		it('should reject invalid caseProcedure values', () => {
+			const test = structuredClone(appealHas);
+			test.caseProcedure = 'invalidProcedure';
+			const validationResult = ajv.validate(schema, test);
+			assert.strictEqual(validationResult, false, 'Expected invalid caseProcedure value to fail validation');
+		});
+	});
 });