@planning-inspectorate/data-model 2.42.0 → 2.43.0

package/docs/appeal-has.md

@@ -45,6 +45,7 @@ any of
 | [lpaQuestionnaireValidationOutcomeDate](#lpaquestionnairevalidationoutcomedate)                     | `string`  | Required | can be null    | [Appeal HAS Case](appeal-has-properties-lpaquestionnairevalidationoutcomedate.md "appeal-has.schema.json#/properties/lpaQuestionnaireValidationOutcomeDate")                     |
 | [lpaQuestionnaireValidationDetails](#lpaquestionnairevalidationdetails)                             | `array`   | Required | can be null    | [Appeal HAS Case](appeal-has-properties-lpaquestionnairevalidationdetails.md "appeal-has.schema.json#/properties/lpaQuestionnaireValidationDetails")                             |
 | [lpaStatement](#lpastatement)                                                                       | `string`  | Required | can be null    | [Appeal HAS Case](appeal-has-properties-lpastatement.md "appeal-has.schema.json#/properties/lpaStatement")                                                                       |
+| [listOfDocumentsBeforeDecision](#listofdocumentsbeforedecision)                                     | `string`  | Optional | can be null    | [Appeal HAS Case](appeal-has-properties-listofdocumentsbeforedecision.md "appeal-has.schema.json#/properties/listOfDocumentsBeforeDecision")                                     |
 | [caseWithdrawnDate](#casewithdrawndate)                                                             | `string`  | Required | can be null    | [Appeal HAS Case](appeal-has-properties-casewithdrawndate.md "appeal-has.schema.json#/properties/caseWithdrawnDate")                                                             |
 | [caseTransferredDate](#casetransferreddate)                                                         | `string`  | Required | can be null    | [Appeal HAS Case](appeal-has-properties-casetransferreddate.md "appeal-has.schema.json#/properties/caseTransferredDate")                                                         |
 | [transferredCaseClosedDate](#transferredcasecloseddate)                                             | `string`  | Required | can be null    | [Appeal HAS Case](appeal-has-properties-transferredcasecloseddate.md "appeal-has.schema.json#/properties/transferredCaseClosedDate")                                             |
@@ -1025,6 +1026,24 @@ A statement provided by the LPA
 "We refused the application because of ..."
 ```
 
+## listOfDocumentsBeforeDecision
+
+Free text response from LPA listing documents used to drive their decision
+
+`listOfDocumentsBeforeDecision`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Appeal HAS Case](appeal-has-properties-listofdocumentsbeforedecision.md "appeal-has.schema.json#/properties/listOfDocumentsBeforeDecision")
+
+### listOfDocumentsBeforeDecision Type
+
+`string`
+
 ## caseWithdrawnDate
 
 The date the appeal was withdrawn by the appellant

package/package.json

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

@@ -464,6 +464,10 @@ class AppealHasCase1(BaseModel):
     """
     A statement provided by the LPA
     """
+    listOfDocumentsBeforeDecision: str | None = None
+    """
+    Free text response from LPA listing documents used to drive their decision
+    """
     caseWithdrawnDate: AwareDatetime | None = Field(
         ..., examples=["2023-07-27T20:30:00.000Z"]
     )
@@ -970,6 +974,10 @@ class AppealHasCase2(BaseModel):
     """
     A statement provided by the LPA
     """
+    listOfDocumentsBeforeDecision: str | None = None
+    """
+    Free text response from LPA listing documents used to drive their decision
+    """
     caseWithdrawnDate: AwareDatetime | None = Field(
         ..., examples=["2023-07-27T20:30:00.000Z"]
     )

package/schemas/appeal-has.schema.json

@@ -314,6 +314,10 @@
       "examples": ["We refused the application because of ..."],
       "description": "A statement provided by the LPA"
     },
+    "listOfDocumentsBeforeDecision": {
+      "type": ["string", "null"],
+      "description": "Free text response from LPA listing documents used to drive their decision"
+    },
     "caseWithdrawnDate": {
       "type": ["string", "null"],
       "format": "date-time",

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

@@ -57,6 +57,10 @@
           "examples": ["We refused the application because of ..."],
           "description": "A statement provided by the LPA, unused?"
         },
+        "listOfDocumentsBeforeDecision": {
+          "type": ["string", "null"],
+          "description": "Free text response from LPA listing documents used to drive their decision"
+        },
         "significantChangesAffectingApplicationLpa": {
           "type": ["array", "null"],
           "items": {

package/src/schemas.d.ts

@@ -485,6 +485,10 @@ export type AppealHASCase = (GridReference | SiteAddress) & {
    * A statement provided by the LPA
    */
   lpaStatement: string | null;
+  /**
+   * Free text response from LPA listing documents used to drive their decision
+   */
+  listOfDocumentsBeforeDecision?: string | null;
   /**
    * The date the appeal was withdrawn by the appellant
    */
@@ -4497,6 +4501,10 @@ export type LPAQHASSubmissionProperties = {
    * A statement provided by the LPA, unused?
    */
   lpaStatement?: string | null;
+  /**
+   * Free text response from LPA listing documents used to drive their decision
+   */
+  listOfDocumentsBeforeDecision?: string | null;
   /**
    * Significant changes affecting the application as reported by the LPA
    */

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

@@ -180,7 +180,8 @@ const appealHas = {
 		{ value: 'adopted-a-new-local-plan', comment: 'Plan adopted last month' },
 		{ value: 'other', comment: 'General policy shift' }
 	],
-	significantChangesAffectingApplicationLpa: null
+	significantChangesAffectingApplicationLpa: null,
+	listOfDocumentsBeforeDecision: null
 };
 
 describe(schema, () => {
@@ -279,6 +280,7 @@ describe(schema, () => {
 		test.reasonForAppealAppellant = null;
 		test.significantChangesAffectingApplicationAppellant = null;
 		test.significantChangesAffectingApplicationLpa = null;
+		test.listOfDocumentsBeforeDecision = null;
 		const validationResult = ajv.validate(schema, test);
 		if (!validationResult) {
 			console.error(ajv.errors);
@@ -286,6 +288,20 @@ describe(schema, () => {
 		assert.strictEqual(validationResult, true);
 	});
 
+	it('should allow listOfDocumentsBeforeDecision to be a string', () => {
+		const test = structuredClone(appealHas);
+		test.listOfDocumentsBeforeDecision = 'doc1, doc2, doc3';
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, true);
+	});
+
+	it('should allow listOfDocumentsBeforeDecision to be missing (optional)', () => {
+		const test = structuredClone(appealHas);
+		delete test.listOfDocumentsBeforeDecision;
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, true);
+	});
+
 	it('should enforce enum for significantChangesAffectingApplication', () => {
 		const test = structuredClone(appealHas);
 		test.significantChangesAffectingApplicationAppellant = [{ value: 'invalid-enum-value', comment: 'some comment' }];