@planning-inspectorate/data-model 2.2.0 → 2.3.1

package/.azure/ci.yml

@@ -21,16 +21,28 @@ resources:
 extends:
   template: stages/wrapper_ci.yml@templates
   parameters:
+    gitFetchDepth: 0
     skipAzureAuth: true
     validationJobs:
       - name: Run Checks
         steps:
+          - task: Cache@2
+            inputs:
+              key: 'npm | "$(Agent.OS)" | package-lock.json'
+              restoreKeys: |
+                npm | "$(Agent.OS)" | package-lock.json
+              path: $(pipeline.workspace)/.npm
+            displayName: Cache NPM
           - template: ../steps/node_script.yml
             parameters:
               nodeVersion: 22
               script: npm ci
+              environmentVariables:
+                npm_config_cache: $(pipeline.workspace)/.npm
           - template: ../steps/node_script.yml
             parameters:
+              # only run commitlint on branches, not main
+              condition: ne(variables['Build.SourceBranchName'], 'main')
               nodeVersion: 22
               script: npm run commitlint
           - template: ../steps/node_script.yml

package/docs/appeal-has.md

@@ -115,6 +115,7 @@ any of
 | [didAppellantSubmitCompletePhotosAndPlans](#didappellantsubmitcompletephotosandplans)     | `boolean` | Optional | can be null    | [Appeal HAS Case](appeal-has-properties-didappellantsubmitcompletephotosandplans.md "appeal-has.schema.json#/properties/didAppellantSubmitCompletePhotosAndPlans")     |
 | [isSiteInAreaOfSpecialControlAdverts](#issiteinareaofspecialcontroladverts)               | `boolean` | Optional | can be null    | [Appeal HAS Case](appeal-has-properties-issiteinareaofspecialcontroladverts.md "appeal-has.schema.json#/properties/isSiteInAreaOfSpecialControlAdverts")               |
 | [advertDetails](#advertdetails)                                                           | `array`   | Optional | can be null    | [Appeal HAS Case](appeal-has-properties-advertdetails.md "appeal-has.schema.json#/properties/advertDetails")                                                           |
+| [padsSapId](#padssapid)                                                                   | `string`  | Required | can be null    | [Appeal HAS Case](appeal-has-properties-padssapid.md "appeal-has.schema.json#/properties/padsSapId")                                                                   |
 | Additional Properties                                                                     | Any       | Optional | can be null    |                                                                                                                                                                        |
 
 ## caseId
@@ -2623,6 +2624,24 @@ A list of advertisements for the appeal
 
 `object[]` ([Details](appeal-has-properties-advertdetails-items.md))
 
+## padsSapId
+
+padsSapId for PADS inspectors
+
+`padsSapId`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Appeal HAS Case](appeal-has-properties-padssapid.md "appeal-has.schema.json#/properties/padsSapId")
+
+### padsSapId Type
+
+`string`
+
 ## Additional Properties
 
 Additional properties are allowed and do not have to follow a specific schema

package/docs/appeal-s78.md

@@ -154,6 +154,7 @@ any of
 | [didAppellantSubmitCompletePhotosAndPlans](#didappellantsubmitcompletephotosandplans)     | `boolean` | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-didappellantsubmitcompletephotosandplans.md "appeal-s78.schema.json#/properties/didAppellantSubmitCompletePhotosAndPlans")     |
 | [isSiteInAreaOfSpecialControlAdverts](#issiteinareaofspecialcontroladverts)               | `boolean` | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-issiteinareaofspecialcontroladverts.md "appeal-s78.schema.json#/properties/isSiteInAreaOfSpecialControlAdverts")               |
 | [advertDetails](#advertdetails)                                                           | `array`   | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-advertdetails.md "appeal-s78.schema.json#/properties/advertDetails")                                                           |
+| [padsSapId](#padssapid)                                                                   | `string`  | Required | can be null    | [Appeal S78 Case](appeal-s78-properties-padssapid.md "appeal-s78.schema.json#/properties/padsSapId")                                                                   |
 | Additional Properties                                                                     | Any       | Optional | can be null    |                                                                                                                                                                        |
 
 ## caseId
@@ -3692,6 +3693,24 @@ A list of advertisements for the appeal
 
 `object[]` ([Details](appeal-s78-properties-advertdetails-items.md))
 
+## padsSapId
+
+padsSapId for PADS inspectors
+
+`padsSapId`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Appeal S78 Case](appeal-s78-properties-padssapid.md "appeal-s78.schema.json#/properties/padsSapId")
+
+### padsSapId Type
+
+`string`
+
 ## Additional Properties
 
 Additional properties are allowed and do not have to follow a specific schema

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planning-inspectorate/data-model",
-  "version": "2.2.0",
+  "version": "2.3.1",
   "description": "JSON Schemas for the Planning Inspectorate's Data Model",
   "main": "src/index.js",
   "type": "module",
@@ -9,7 +9,7 @@
     "require": "./src/index.cjs"
   },
   "scripts": {
-    "commitlint": "commitlint --from=$(git cherry origin/main | head -n 1 | cut -c 3-)",
+    "commitlint": "commitlint --from=$(git rev-parse $(git cherry origin/main | head -n 1 | cut -c 3-)^1)",
     "gen": "npm run gen-docs && npm run gen-enums && npm run gen-types && npm run gen-cjs",
     "gen-docs": "node src/lib/gen-docs.js",
     "gen-enums": "node src/lib/gen-enums.js",

package/pins_data_model/models/model_appeal_document.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-document.schema.json
-#   timestamp: 2025-11-12T14:58:30+00:00
+#   timestamp: 2025-12-02T17:41:26+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: 2025-11-12T14:58:30+00:00
+#   timestamp: 2025-12-02T17:41:26+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: 2025-11-12T14:58:30+00:00
+#   timestamp: 2025-12-02T17:41:26+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: 2025-11-12T14:58:30+00:00
+#   timestamp: 2025-12-02T17:41:26+00:00
 
 from __future__ import annotations
 
@@ -742,6 +742,10 @@ class AppealHasCase1(BaseModel):
     """
     A list of advertisements for the appeal
     """
+    padsSapId: str | None = None
+    """
+    padsSapId for PADS inspectors
+    """
 
 
 class AdvertDetail1(BaseModel):
@@ -1237,6 +1241,10 @@ class AppealHasCase2(BaseModel):
     """
     A list of advertisements for the appeal
     """
+    padsSapId: str | None = None
+    """
+    padsSapId for PADS inspectors
+    """
 
 
 class AppealHasCase(RootModel[AppealHasCase1 | AppealHasCase2]):

package/pins_data_model/models/model_appeal_representation.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-representation.schema.json
-#   timestamp: 2025-11-12T14:58:30+00:00
+#   timestamp: 2025-12-02T17:41:26+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: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+00:00
 
 from __future__ import annotations
 
@@ -916,6 +916,10 @@ class AppealS78Case1(BaseModel):
     """
     A list of advertisements for the appeal
     """
+    padsSapId: str | None = None
+    """
+    padsSapId for PADS inspectors
+    """
 
 
 class AdvertDetail1(BaseModel):
@@ -1519,6 +1523,10 @@ class AppealS78Case2(BaseModel):
     """
     A list of advertisements for the appeal
     """
+    padsSapId: str | None = None
+    """
+    padsSapId for PADS inspectors
+    """
 
 
 class AppealS78Case(RootModel[AppealS78Case1 | AppealS78Case2]):

package/pins_data_model/models/model_dart_response.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  dart-response.schema.json
-#   timestamp: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+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: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+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: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+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: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+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: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+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: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+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: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+00:00
 
 from __future__ import annotations
 

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: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+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: 2025-11-12T16:26:57+00:00
+#   timestamp: 2025-12-02T17:41:26+00:00
 
 from __future__ import annotations
 
@@ -35,7 +35,7 @@ class NsipInvoice(BaseModel):
     The unique identifier within the Back Office. This is not the same as the case reference
     """
     caseReference: str | None = Field(..., examples=["BC0510001"])
-    invoiceStage: InvoiceStage | None = Field(..., examples=["pre_acceptance"])
+    invoiceStage: InvoiceStage = Field(..., examples=["pre_acceptance"])
     """
     Invoice stage
     """

package/pins_data_model/models/model_nsip_meeting.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-meeting.schema.json
-#   timestamp: 2025-11-12T16:26:57+00:00
+#   timestamp: 2025-12-02T17:41:26+00:00
 
 from __future__ import annotations
 
@@ -41,7 +41,7 @@ class NsipMeeting(BaseModel):
     """
     Meeting agenda
     """
-    planningInspectorateRole: PlanningInspectorateRole | None = Field(
+    planningInspectorateRole: PlanningInspectorateRole = Field(
         ..., examples=["facilitator"]
     )
     """

package/pins_data_model/models/model_nsip_project.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-project.schema.json
-#   timestamp: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+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: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+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: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+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: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+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: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+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: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+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: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+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: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+00:00
 
 from __future__ import annotations
 

package/schemas/appeal-has.schema.json

@@ -72,7 +72,8 @@
     "neighbouringSiteAddresses",
     "affectedListedBuildingNumbers",
     "appellantCostsAppliedFor",
-    "lpaCostsAppliedFor"
+    "lpaCostsAppliedFor",
+    "padsSapId"
   ],
   "anyOf": [
     {
@@ -763,6 +764,10 @@
       },
       "description": "A list of advertisements for the appeal",
       "$comment": "Also available on CAS Adverts (ZA) cases"
+    },
+    "padsSapId": {
+      "type": ["string", "null"],
+      "description": "padsSapId for PADS inspectors"
     }
   }
 }

package/schemas/appeal-s78.schema.json

@@ -130,7 +130,8 @@
     "numberOfResidencesNetChange",
     "siteViewableFromRoad",
     "siteWithinSSSI",
-    "typeOfPlanningApplication"
+    "typeOfPlanningApplication",
+    "padsSapId"
   ],
   "anyOf": [
     {
@@ -1087,6 +1088,10 @@
       },
       "description": "A list of advertisements for the appeal",
       "$comment": "Also available on CAS Adverts (ZA) cases"
+    },
+    "padsSapId": {
+      "type": ["string", "null"],
+      "description": "padsSapId for PADS inspectors"
     }
   }
 }

package/src/schemas.d.ts

@@ -799,6 +799,10 @@ export type AppealHASCase = (
         [k: string]: unknown;
       }[]
     | null;
+  /**
+   * padsSapId for PADS inspectors
+   */
+  padsSapId: string | null;
   [k: string]: unknown;
 };
 
@@ -1505,6 +1509,10 @@ export type AppealS78Case = (
         [k: string]: unknown;
       }[]
     | null;
+  /**
+   * padsSapId for PADS inspectors
+   */
+  padsSapId: string | null;
   [k: string]: unknown;
 };
 

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

@@ -172,7 +172,8 @@ const appealHas = {
 			isSiteOnHighwayLand: false,
 			advertType: 'Other'
 		}
-	]
+	],
+	padsSapId: null
 };
 
 describe(schema, () => {

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

@@ -160,7 +160,8 @@ const appealS78 = {
 			isSiteOnHighwayLand: false,
 			advertType: 'Other'
 		}
-	]
+	],
+	padsSapId: null
 };
 
 describe(schema, () => {