@planning-inspectorate/data-model 2.39.0 → 2.41.0

package/pins_data_model/models/model_appeal_has.py

@@ -265,6 +265,39 @@ class AdvertDetail(BaseModel):
     """
 
 
+class AdvertDetail1(BaseModel):
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    advertType: AdvertType
+    isAdvertInPosition: bool | None = None
+    """
+    Is the advertisement in position?
+    """
+    isSiteOnHighwayLand: bool | None = None
+    """
+    Is the site on highway land?
+    """
+
+
+class SignificantChangesAffectingApplication(Enum):
+    adopted_a_new_local_plan = "adopted-a-new-local-plan"
+    national_policy_change = "national-policy-change"
+    court_judgement = "court-judgement"
+    other = "other"
+    NoneType_None = None
+
+
+class SignificantChangesAffectingApplicationAppellantItem(BaseModel):
+    value: SignificantChangesAffectingApplication
+    comment: str | None = None
+
+
+class SignificantChangesAffectingApplicationLpaItem(BaseModel):
+    value: SignificantChangesAffectingApplication
+    comment: str | None = None
+
+
 class AppealHasCase1(BaseModel):
     """
     Group A - Schema defining the metadata for an appeal
@@ -753,20 +786,21 @@ class AppealHasCase1(BaseModel):
     """
     padsSapId for PADS inspectors
     """
-
-
-class AdvertDetail1(BaseModel):
-    model_config = ConfigDict(
-        extra="allow",
-    )
-    advertType: AdvertType
-    isAdvertInPosition: bool | None = None
+    reasonForAppealAppellant: str | None = None
     """
-    Is the advertisement in position?
+    Reason for appeal as provided by the appellant
     """
-    isSiteOnHighwayLand: bool | None = None
+    significantChangesAffectingApplicationAppellant: (
+        list[SignificantChangesAffectingApplicationAppellantItem] | None
+    ) = None
     """
-    Is the site on highway land?
+    Significant changes affecting the application as reported by the appellant
+    """
+    significantChangesAffectingApplicationLpa: (
+        list[SignificantChangesAffectingApplicationLpaItem] | None
+    ) = None
+    """
+    Significant changes affecting the application as reported by the LPA
     """
 
 
@@ -1258,6 +1292,22 @@ class AppealHasCase2(BaseModel):
     """
     padsSapId for PADS inspectors
     """
+    reasonForAppealAppellant: str | None = None
+    """
+    Reason for appeal as provided by the appellant
+    """
+    significantChangesAffectingApplicationAppellant: (
+        list[SignificantChangesAffectingApplicationAppellantItem] | None
+    ) = None
+    """
+    Significant changes affecting the application as reported by the appellant
+    """
+    significantChangesAffectingApplicationLpa: (
+        list[SignificantChangesAffectingApplicationLpaItem] | None
+    ) = None
+    """
+    Significant changes affecting the application as reported by the LPA
+    """
 
 
 class AppealHasCase(RootModel[AppealHasCase1 | AppealHasCase2]):

package/schemas/appeal-has.schema.json

@@ -776,6 +776,50 @@
     "padsSapId": {
       "type": ["string", "null"],
       "description": "padsSapId for PADS inspectors"
+    },
+    "reasonForAppealAppellant": {
+      "type": ["string", "null"],
+      "description": "Reason for appeal as provided by the appellant"
+    },
+    "significantChangesAffectingApplicationAppellant": {
+      "type": ["array", "null"],
+      "items": {
+        "type": "object",
+        "properties": {
+          "value": {
+            "$ref": "#/definitions/SignificantChangesAffectingApplication",
+            "type": ["string", "null"]
+          },
+          "comment": {
+            "type": ["string", "null"]
+          }
+        },
+        "required": ["value"]
+      },
+      "description": "Significant changes affecting the application as reported by the appellant"
+    },
+    "significantChangesAffectingApplicationLpa": {
+      "type": ["array", "null"],
+      "items": {
+        "type": "object",
+        "properties": {
+          "value": {
+            "$ref": "#/definitions/SignificantChangesAffectingApplication",
+            "type": ["string", "null"]
+          },
+          "comment": {
+            "type": ["string", "null"]
+          }
+        },
+        "required": ["value"]
+      },
+      "description": "Significant changes affecting the application as reported by the LPA"
+    }
+  },
+  "definitions": {
+    "SignificantChangesAffectingApplication": {
+      "type": ["string", "null"],
+      "enum": ["adopted-a-new-local-plan", "national-policy-change", "court-judgement", "other", null]
     }
   }
 }

package/schemas/commands/appeals-components/lpa-questionnaire-has.schema.json

@@ -56,6 +56,23 @@
           "type": ["string", "null"],
           "examples": ["We refused the application because of ..."],
           "description": "A statement provided by the LPA, unused?"
+        },
+        "significantChangesAffectingApplicationLpa": {
+          "type": ["array", "null"],
+          "items": {
+            "type": "object",
+            "properties": {
+              "value": {
+                "type": ["string", "null"],
+                "enum": ["adopted-a-new-local-plan", "national-policy-change", "court-judgement", "other", null]
+              },
+              "comment": {
+                "type": ["string", "null"]
+              }
+            },
+            "required": ["value"]
+          },
+          "description": "Significant changes affecting the application as reported by the LPA"
         }
       }
     }

package/src/schemas.d.ts

@@ -834,6 +834,28 @@ export type AppealHASCase = (GridReference | SiteAddress) & {
    * padsSapId for PADS inspectors
    */
   padsSapId?: string | null;
+  /**
+   * Reason for appeal as provided by the appellant
+   */
+  reasonForAppealAppellant?: string | null;
+  /**
+   * Significant changes affecting the application as reported by the appellant
+   */
+  significantChangesAffectingApplicationAppellant?:
+    | {
+        value: 'adopted-a-new-local-plan' | 'national-policy-change' | 'court-judgement' | 'other' | null;
+        comment?: string | null;
+      }[]
+    | null;
+  /**
+   * Significant changes affecting the application as reported by the LPA
+   */
+  significantChangesAffectingApplicationLpa?:
+    | {
+        value: 'adopted-a-new-local-plan' | 'national-policy-change' | 'court-judgement' | 'other' | null;
+        comment?: string | null;
+      }[]
+    | null;
   [k: string]: unknown;
 };
 
@@ -4481,6 +4503,15 @@ export type LPAQHASSubmissionProperties = {
    * A statement provided by the LPA, unused?
    */
   lpaStatement?: string | null;
+  /**
+   * Significant changes affecting the application as reported by the LPA
+   */
+  significantChangesAffectingApplicationLpa?:
+    | {
+        value: 'adopted-a-new-local-plan' | 'national-policy-change' | 'court-judgement' | 'other' | null;
+        comment?: string | null;
+      }[]
+    | null;
 };
 /**
  * Schema defining any S78 specific properties for LPAQ submissions

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

@@ -174,7 +174,13 @@ const appealHas = {
 			advertType: 'Other'
 		}
 	],
-	padsSapId: null
+	padsSapId: null,
+	reasonForAppealAppellant: 'This is my reason for appeal',
+	significantChangesAffectingApplicationAppellant: [
+		{ value: 'adopted-a-new-local-plan', comment: 'Plan adopted last month' },
+		{ value: 'other', comment: 'General policy shift' }
+	],
+	significantChangesAffectingApplicationLpa: null
 };
 
 describe(schema, () => {
@@ -267,4 +273,37 @@ describe(schema, () => {
 		const validationResult = ajv.validate(schema, test);
 		assert.strictEqual(validationResult, false);
 	});
+
+	it('should allow null for new attributes', () => {
+		const test = structuredClone(appealHas);
+		test.reasonForAppealAppellant = null;
+		test.significantChangesAffectingApplicationAppellant = null;
+		test.significantChangesAffectingApplicationLpa = null;
+		const validationResult = ajv.validate(schema, test);
+		if (!validationResult) {
+			console.error(ajv.errors);
+		}
+		assert.strictEqual(validationResult, true);
+	});
+
+	it('should enforce enum for significantChangesAffectingApplication', () => {
+		const test = structuredClone(appealHas);
+		test.significantChangesAffectingApplicationAppellant = [{ value: 'invalid-enum-value', comment: 'some comment' }];
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, false);
+	});
+
+	it('should enforce required value for significantChangesAffectingApplication entries', () => {
+		const test = structuredClone(appealHas);
+		test.significantChangesAffectingApplicationAppellant = [{ comment: 'some comment' }];
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, false);
+	});
+
+	it('should allow missing/null comment for significantChangesAffectingApplication entries', () => {
+		const test = structuredClone(appealHas);
+		test.significantChangesAffectingApplicationAppellant = [{ value: 'adopted-a-new-local-plan' }];
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, true);
+	});
 });