@planning-inspectorate/data-model 2.57.0 → 2.58.0

package/docs/appeal-document.md

@@ -465,24 +465,29 @@ The internal code for an appeal type, e.g. Householder (D)
 
 **enum**: the value of this property must be equal to one of the following values:
 
-| Value  | Explanation |
-| :----- | :---------- |
-| `"C"`  |             |
-| `"D"`  |             |
-| `"F"`  |             |
-| `"G"`  |             |
-| `"H"`  |             |
-| `"L"`  |             |
-| `"Q"`  |             |
-| `"S"`  |             |
-| `"V"`  |             |
-| `"W"`  |             |
-| `"X"`  |             |
-| `"Y"`  |             |
-| `"Z"`  |             |
-| `"ZA"` |             |
-| `"ZP"` |             |
-| `null` |             |
+| Value   | Explanation |
+| :------ | :---------- |
+| `"C"`   |             |
+| `"D"`   |             |
+| `"F"`   |             |
+| `"G"`   |             |
+| `"H"`   |             |
+| `"L"`   |             |
+| `"Q"`   |             |
+| `"S"`   |             |
+| `"V"`   |             |
+| `"W"`   |             |
+| `"X"`   |             |
+| `"Y"`   |             |
+| `"Z"`   |             |
+| `"ZA"`  |             |
+| `"ZP"`  |             |
+| `"TPO"` |             |
+| `"TRN"` |             |
+| `"HH"`  |             |
+| `"HR"`  |             |
+| `"ENV"` |             |
+| `null`  |             |
 
 ## redactedStatus
 

package/docs/appeal-group-c.md

@@ -116,7 +116,7 @@ External case identifier for Group C appeals (7 digit number starting in 6)
 
 ## caseType
 
-The internal letter code for an appeal type, e.g. W (Environmental)
+Internal letter code for appeal types
 
 `caseType`
 
@@ -136,23 +136,28 @@ The internal letter code for an appeal type, e.g. W (Environmental)
 
 **enum**: the value of this property must be equal to one of the following values:
 
-| Value  | Explanation |
-| :----- | :---------- |
-| `"C"`  |             |
-| `"D"`  |             |
-| `"F"`  |             |
-| `"G"`  |             |
-| `"H"`  |             |
-| `"L"`  |             |
-| `"Q"`  |             |
-| `"S"`  |             |
-| `"V"`  |             |
-| `"W"`  |             |
-| `"X"`  |             |
-| `"Y"`  |             |
-| `"Z"`  |             |
-| `"ZA"` |             |
-| `"ZP"` |             |
+| Value   | Explanation |
+| :------ | :---------- |
+| `"C"`   |             |
+| `"D"`   |             |
+| `"F"`   |             |
+| `"G"`   |             |
+| `"H"`   |             |
+| `"L"`   |             |
+| `"Q"`   |             |
+| `"S"`   |             |
+| `"V"`   |             |
+| `"W"`   |             |
+| `"X"`   |             |
+| `"Y"`   |             |
+| `"Z"`   |             |
+| `"ZA"`  |             |
+| `"ZP"`  |             |
+| `"TPO"` |             |
+| `"TRN"` |             |
+| `"HH"`  |             |
+| `"HR"`  |             |
+| `"ENV"` |             |
 
 ## caseStatus
 

package/docs/appeal-has.md

@@ -261,23 +261,28 @@ The internal code for an appeal type, e.g. D (Householder)
 
 **enum**: the value of this property must be equal to one of the following values:
 
-| Value  | Explanation |
-| :----- | :---------- |
-| `"C"`  |             |
-| `"D"`  |             |
-| `"F"`  |             |
-| `"G"`  |             |
-| `"H"`  |             |
-| `"L"`  |             |
-| `"Q"`  |             |
-| `"S"`  |             |
-| `"V"`  |             |
-| `"W"`  |             |
-| `"X"`  |             |
-| `"Y"`  |             |
-| `"Z"`  |             |
-| `"ZA"` |             |
-| `"ZP"` |             |
+| Value   | Explanation |
+| :------ | :---------- |
+| `"C"`   |             |
+| `"D"`   |             |
+| `"F"`   |             |
+| `"G"`   |             |
+| `"H"`   |             |
+| `"L"`   |             |
+| `"Q"`   |             |
+| `"S"`   |             |
+| `"V"`   |             |
+| `"W"`   |             |
+| `"X"`   |             |
+| `"Y"`   |             |
+| `"Z"`   |             |
+| `"ZA"`  |             |
+| `"ZP"`  |             |
+| `"TPO"` |             |
+| `"TRN"` |             |
+| `"HH"`  |             |
+| `"HR"`  |             |
+| `"ENV"` |             |
 
 ## caseProcedure
 

package/docs/appeal-s78.md

@@ -364,23 +364,28 @@ The internal code for an appeal type, e.g. D (Householder)
 
 **enum**: the value of this property must be equal to one of the following values:
 
-| Value  | Explanation |
-| :----- | :---------- |
-| `"C"`  |             |
-| `"D"`  |             |
-| `"F"`  |             |
-| `"G"`  |             |
-| `"H"`  |             |
-| `"L"`  |             |
-| `"Q"`  |             |
-| `"S"`  |             |
-| `"V"`  |             |
-| `"W"`  |             |
-| `"X"`  |             |
-| `"Y"`  |             |
-| `"Z"`  |             |
-| `"ZA"` |             |
-| `"ZP"` |             |
+| Value   | Explanation |
+| :------ | :---------- |
+| `"C"`   |             |
+| `"D"`   |             |
+| `"F"`   |             |
+| `"G"`   |             |
+| `"H"`   |             |
+| `"L"`   |             |
+| `"Q"`   |             |
+| `"S"`   |             |
+| `"V"`   |             |
+| `"W"`   |             |
+| `"X"`   |             |
+| `"Y"`   |             |
+| `"Z"`   |             |
+| `"ZA"`  |             |
+| `"ZP"`  |             |
+| `"TPO"` |             |
+| `"TRN"` |             |
+| `"HH"`  |             |
+| `"HR"`  |             |
+| `"ENV"` |             |
 
 ## caseProcedure
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planning-inspectorate/data-model",
-  "version": "2.57.0",
+  "version": "2.58.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

@@ -39,6 +39,11 @@ class CaseType(Enum):
     Z = "Z"
     ZA = "ZA"
     ZP = "ZP"
+    TPO = "TPO"
+    TRN = "TRN"
+    HH = "HH"
+    HR = "HR"
+    ENV = "ENV"
     NoneType_None = None
 
 

package/pins_data_model/models/model_appeal_group_c.py

@@ -10,7 +10,7 @@ from pydantic import AwareDatetime, BaseModel, ConfigDict, Field, constr
 
 class CaseType(StrEnum):
     """
-    The internal letter code for an appeal type, e.g. W (Environmental)
+    Internal letter code for appeal types
     """
 
     C = "C"
@@ -28,6 +28,11 @@ class CaseType(StrEnum):
     Z = "Z"
     ZA = "ZA"
     ZP = "ZP"
+    TPO = "TPO"
+    TRN = "TRN"
+    HH = "HH"
+    HR = "HR"
+    ENV = "ENV"
 
 
 class CaseStatus(StrEnum):
@@ -229,7 +234,7 @@ class AppealGroupCCase(BaseModel):
     """
     caseType: CaseType
     """
-    The internal letter code for an appeal type, e.g. W (Environmental)
+    Internal letter code for appeal types
     """
     caseStatus: CaseStatus
     """

package/pins_data_model/models/model_appeal_has.py

@@ -51,6 +51,11 @@ class CaseType(StrEnum):
     Z = "Z"
     ZA = "ZA"
     ZP = "ZP"
+    TPO = "TPO"
+    TRN = "TRN"
+    HH = "HH"
+    HR = "HR"
+    ENV = "ENV"
 
 
 class CaseProcedure(Enum):

package/pins_data_model/models/model_appeal_s78.py

@@ -55,6 +55,11 @@ class CaseType(StrEnum):
     Z = "Z"
     ZA = "ZA"
     ZP = "ZP"
+    TPO = "TPO"
+    TRN = "TRN"
+    HH = "HH"
+    HR = "HR"
+    ENV = "ENV"
 
 
 class CaseProcedure(Enum):

package/schemas/appeal-document.schema.json

@@ -126,7 +126,29 @@
     },
     "caseType": {
       "type": ["string", "null"],
-      "enum": ["C", "D", "F", "G", "H", "L", "Q", "S", "V", "W", "X", "Y", "Z", "ZA", "ZP", null],
+      "enum": [
+        "C",
+        "D",
+        "F",
+        "G",
+        "H",
+        "L",
+        "Q",
+        "S",
+        "V",
+        "W",
+        "X",
+        "Y",
+        "Z",
+        "ZA",
+        "ZP",
+        "TPO",
+        "TRN",
+        "HH",
+        "HR",
+        "ENV",
+        null
+      ],
       "description": "The internal code for an appeal type, e.g. Householder (D)"
     },
     "redactedStatus": {

package/schemas/appeal-group-c.schema.json

@@ -55,8 +55,29 @@
     },
     "caseType": {
       "type": "string",
-      "enum": ["C", "D", "F", "G", "H", "L", "Q", "S", "V", "W", "X", "Y", "Z", "ZA", "ZP"],
-      "description": "The internal letter code for an appeal type, e.g. W (Environmental)"
+      "enum": [
+        "C",
+        "D",
+        "F",
+        "G",
+        "H",
+        "L",
+        "Q",
+        "S",
+        "V",
+        "W",
+        "X",
+        "Y",
+        "Z",
+        "ZA",
+        "ZP",
+        "TPO",
+        "TRN",
+        "HH",
+        "HR",
+        "ENV"
+      ],
+      "description": "Internal letter code for appeal types"
     },
     "caseStatus": {
       "type": "string",

package/schemas/appeal-has.schema.json

@@ -133,7 +133,28 @@
     },
     "caseType": {
       "type": "string",
-      "enum": ["C", "D", "F", "G", "H", "L", "Q", "S", "V", "W", "X", "Y", "Z", "ZA", "ZP"],
+      "enum": [
+        "C",
+        "D",
+        "F",
+        "G",
+        "H",
+        "L",
+        "Q",
+        "S",
+        "V",
+        "W",
+        "X",
+        "Y",
+        "Z",
+        "ZA",
+        "ZP",
+        "TPO",
+        "TRN",
+        "HH",
+        "HR",
+        "ENV"
+      ],
       "description": "The internal code for an appeal type, e.g. D (Householder)"
     },
     "caseProcedure": {

package/schemas/appeal-s78.schema.json

@@ -205,7 +205,28 @@
     },
     "caseType": {
       "type": "string",
-      "enum": ["C", "D", "F", "G", "H", "L", "Q", "S", "V", "W", "X", "Y", "Z", "ZA", "ZP"],
+      "enum": [
+        "C",
+        "D",
+        "F",
+        "G",
+        "H",
+        "L",
+        "Q",
+        "S",
+        "V",
+        "W",
+        "X",
+        "Y",
+        "Z",
+        "ZA",
+        "ZP",
+        "TPO",
+        "TRN",
+        "HH",
+        "HR",
+        "ENV"
+      ],
       "description": "The internal code for an appeal type, e.g. D (Householder)",
       "$comment": "Also available on HAS cases"
     },

package/src/enums.cjs

@@ -159,12 +159,17 @@ const APPEAL_CASE_SUB_TYPE = Object.freeze({
 const APPEAL_CASE_TYPE = Object.freeze({
   C: 'C',
   D: 'D',
+  ENV: 'ENV',
   F: 'F',
   G: 'G',
   H: 'H',
+  HH: 'HH',
+  HR: 'HR',
   L: 'L',
   Q: 'Q',
   S: 'S',
+  TPO: 'TPO',
+  TRN: 'TRN',
   V: 'V',
   W: 'W',
   X: 'X',

package/src/enums.d.ts

@@ -157,12 +157,17 @@ export const APPEAL_CASE_SUB_TYPE = {
 export const APPEAL_CASE_TYPE = {
   C: 'C',
   D: 'D',
+  ENV: 'ENV',
   F: 'F',
   G: 'G',
   H: 'H',
+  HH: 'HH',
+  HR: 'HR',
   L: 'L',
   Q: 'Q',
   S: 'S',
+  TPO: 'TPO',
+  TRN: 'TRN',
   V: 'V',
   W: 'W',
   X: 'X',

package/src/enums.js

@@ -157,12 +157,17 @@ export const APPEAL_CASE_SUB_TYPE = Object.freeze({
 export const APPEAL_CASE_TYPE = Object.freeze({
   C: 'C',
   D: 'D',
+  ENV: 'ENV',
   F: 'F',
   G: 'G',
   H: 'H',
+  HH: 'HH',
+  HR: 'HR',
   L: 'L',
   Q: 'Q',
   S: 'S',
+  TPO: 'TPO',
+  TRN: 'TRN',
   V: 'V',
   W: 'W',
   X: 'X',

package/src/index.cjs

@@ -240,12 +240,17 @@ const APPEAL_CASE_SUB_TYPE = Object.freeze({
 const APPEAL_CASE_TYPE = Object.freeze({
   C: 'C',
   D: 'D',
+  ENV: 'ENV',
   F: 'F',
   G: 'G',
   H: 'H',
+  HH: 'HH',
+  HR: 'HR',
   L: 'L',
   Q: 'Q',
   S: 'S',
+  TPO: 'TPO',
+  TRN: 'TRN',
   V: 'V',
   W: 'W',
   X: 'X',

package/src/schemas.d.ts

@@ -128,7 +128,28 @@ export interface AppealDocument {
   /**
    * The internal code for an appeal type, e.g. Householder (D)
    */
-  caseType: 'C' | 'D' | 'F' | 'G' | 'H' | 'L' | 'Q' | 'S' | 'V' | 'W' | 'X' | 'Y' | 'Z' | 'ZA' | 'ZP' | null;
+  caseType:
+    | 'C'
+    | 'D'
+    | 'F'
+    | 'G'
+    | 'H'
+    | 'L'
+    | 'Q'
+    | 'S'
+    | 'V'
+    | 'W'
+    | 'X'
+    | 'Y'
+    | 'Z'
+    | 'ZA'
+    | 'ZP'
+    | 'TPO'
+    | 'TRN'
+    | 'HH'
+    | 'HR'
+    | 'ENV'
+    | null;
   /**
    * Indicates the redaction status for the document
    */
@@ -409,9 +430,29 @@ export interface AppealGroupCCase {
    */
   caseReference: string;
   /**
-   * The internal letter code for an appeal type, e.g. W (Environmental)
-   */
-  caseType: 'C' | 'D' | 'F' | 'G' | 'H' | 'L' | 'Q' | 'S' | 'V' | 'W' | 'X' | 'Y' | 'Z' | 'ZA' | 'ZP';
+   * Internal letter code for appeal types
+   */
+  caseType:
+    | 'C'
+    | 'D'
+    | 'F'
+    | 'G'
+    | 'H'
+    | 'L'
+    | 'Q'
+    | 'S'
+    | 'V'
+    | 'W'
+    | 'X'
+    | 'Y'
+    | 'Z'
+    | 'ZA'
+    | 'ZP'
+    | 'TPO'
+    | 'TRN'
+    | 'HH'
+    | 'HR'
+    | 'ENV';
   /**
    * The processing status for the appeal
    */
@@ -706,7 +747,27 @@ export type AppealHASCase = (GridReference | SiteAddress) & {
   /**
    * The internal code for an appeal type, e.g. D (Householder)
    */
-  caseType: 'C' | 'D' | 'F' | 'G' | 'H' | 'L' | 'Q' | 'S' | 'V' | 'W' | 'X' | 'Y' | 'Z' | 'ZA' | 'ZP';
+  caseType:
+    | 'C'
+    | 'D'
+    | 'F'
+    | 'G'
+    | 'H'
+    | 'L'
+    | 'Q'
+    | 'S'
+    | 'V'
+    | 'W'
+    | 'X'
+    | 'Y'
+    | 'Z'
+    | 'ZA'
+    | 'ZP'
+    | 'TPO'
+    | 'TRN'
+    | 'HH'
+    | 'HR'
+    | 'ENV';
   /**
    * The type of procedure for the appeal
    */
@@ -1336,7 +1397,27 @@ export type AppealS78Case = (GridReference | SiteAddress) & {
   /**
    * The internal code for an appeal type, e.g. D (Householder)
    */
-  caseType: 'C' | 'D' | 'F' | 'G' | 'H' | 'L' | 'Q' | 'S' | 'V' | 'W' | 'X' | 'Y' | 'Z' | 'ZA' | 'ZP';
+  caseType:
+    | 'C'
+    | 'D'
+    | 'F'
+    | 'G'
+    | 'H'
+    | 'L'
+    | 'Q'
+    | 'S'
+    | 'V'
+    | 'W'
+    | 'X'
+    | 'Y'
+    | 'Z'
+    | 'ZA'
+    | 'ZP'
+    | 'TPO'
+    | 'TRN'
+    | 'HH'
+    | 'HR'
+    | 'ENV';
   /**
    * The type of procedure for the appeal
    */

package/tests/appeals/appeal-group-c.test.js

@@ -339,4 +339,40 @@ describe('appeal-group-c.schema.json', () => {
 		baseDoc.documentType = 'lpaQuestionnaire';
 		assert.strictEqual(ajv.validate(docSchema, baseDoc), true, JSON.stringify(ajv.errors));
 	});
+
+	it('should validate caseType enums including new letter codes', () => {
+		const ajv = setupAjv();
+		const testCase = structuredClone(baseAppealGroupC);
+
+		const validCaseTypes = [
+			'C',
+			'D',
+			'F',
+			'G',
+			'H',
+			'L',
+			'Q',
+			'S',
+			'V',
+			'W',
+			'X',
+			'Y',
+			'Z',
+			'ZA',
+			'ZP',
+			'TPO',
+			'TRN',
+			'HH',
+			'HR',
+			'ENV'
+		];
+
+		for (const caseType of validCaseTypes) {
+			testCase.caseType = caseType;
+			assert.strictEqual(ajv.validate(schema, testCase), true, `caseType ${caseType} should be valid`);
+		}
+
+		testCase.caseType = 'INVALID_CODE';
+		assert.strictEqual(ajv.validate(schema, testCase), false);
+	});
 });