@planning-inspectorate/data-model 2.52.0 → 2.53.0

package/.azure/ci.yml

@@ -35,7 +35,7 @@ extends:
             displayName: Cache NPM
           - template: ../steps/node_script.yml
             parameters:
-              nodeVersion: 22
+              nodeVersion: 24
               script: npm ci
               environmentVariables:
                 npm_config_cache: $(pipeline.workspace)/.npm
@@ -43,23 +43,23 @@ extends:
             parameters:
               # only run commitlint on branches, not main
               condition: ne(variables['Build.SourceBranchName'], 'main')
-              nodeVersion: 22
+              nodeVersion: 24
               script: npm run commitlint
           - template: ../steps/node_script.yml
             parameters:
-              nodeVersion: 22
+              nodeVersion: 24
               script: npm run lint
           - template: ../steps/node_script.yml
             parameters:
-              nodeVersion: 22
+              nodeVersion: 24
               script: npm run format-check
           - template: ../steps/node_script.yml
             parameters:
-              nodeVersion: 22
+              nodeVersion: 24
               script: npm run gen
           - template: ../steps/node_script.yml
             parameters:
-              nodeVersion: 22
+              nodeVersion: 24
               script: node --test
           - script: |
               set -e

package/.azure/release.yml

@@ -44,11 +44,11 @@ jobs:
             - checkout: self
             - template: steps/node_script.yml@templates
               parameters:
-                nodeVersion: 22
+                nodeVersion: 24
                 script: npm ci
             - template: steps/node_script.yml@templates
               parameters:
-                nodeVersion: 22
+                nodeVersion: 24
                 script: npx semantic-release --branches main --tag-format '${version}' ${{ variables.dryRunFlag }}
                 environmentVariables:
                   GH_TOKEN: $(GITHUB_TOKEN)

package/docs/README.md

@@ -80,6 +80,10 @@
 
 * [Untitled object in Appeal S78 Case](./appeal-s78-properties-applicationelbappealgroundsdetails-items.md) – `appeal-s78.schema.json#/properties/applicationElbAppealGroundsDetails/items`
 
+* [Untitled object in Appeal S78 Case](./appeal-s78-properties-enforcementcasegroundsofappeal-items.md) – `appeal-s78.schema.json#/properties/enforcementCaseGroundsOfAppeal/items`
+
+* [Untitled object in Appeal S78 Case](./appeal-s78-properties-elbcasegroundsofappeal-items.md) – `appeal-s78.schema.json#/properties/elbCaseGroundsOfAppeal/items`
+
 * [Untitled object in Appeal S78 Case](./appeal-s78-properties-significantchangesaffectingapplicationappellant-items.md) – `appeal-s78.schema.json#/properties/significantChangesAffectingApplicationAppellant/items`
 
 * [Untitled object in Appeal S78 Case](./appeal-s78-properties-significantchangesaffectingapplicationlpa-items.md) – `appeal-s78.schema.json#/properties/significantChangesAffectingApplicationLpa/items`

package/docs/appeal-document.md

@@ -636,6 +636,7 @@ The type of document, used for exchange, migrations and consumption from the app
 | `"hearingProcess"`                     |             |
 | `"inquiryCore"`                        |             |
 | `"inquiryPostEvent"`                   |             |
+| `"noticeWithdrawal"`                   |             |
 | `null`                                 |             |
 
 ## sourceSystem

package/docs/appeal-has.md

@@ -221,21 +221,23 @@ The processing status for the appeal
 
 **enum**: the value of this property must be equal to one of the following values:
 
-| Value                   | Explanation |
-| :---------------------- | :---------- |
-| `"assign_case_officer"` |             |
-| `"validation"`          |             |
-| `"ready_to_start"`      |             |
-| `"lpa_questionnaire"`   |             |
-| `"issue_determination"` |             |
-| `"complete"`            |             |
-| `"invalid"`             |             |
-| `"closed"`              |             |
-| `"withdrawn"`           |             |
-| `"awaiting_transfer"`   |             |
-| `"transferred"`         |             |
-| `"event"`               |             |
-| `"awaiting_event"`      |             |
+| Value                      | Explanation |
+| :------------------------- | :---------- |
+| `"assign_case_officer"`    |             |
+| `"validation"`             |             |
+| `"ready_to_start"`         |             |
+| `"lpa_questionnaire"`      |             |
+| `"issue_determination"`    |             |
+| `"complete"`               |             |
+| `"invalid"`                |             |
+| `"closed"`                 |             |
+| `"withdrawn"`              |             |
+| `"awaiting_transfer"`      |             |
+| `"transferred"`            |             |
+| `"event"`                  |             |
+| `"awaiting_event"`         |             |
+| `"notice_withdrawn"`       |             |
+| `"closed_opened_in_error"` |             |
 
 ## caseType
 

package/docs/appeal-s78.md

@@ -167,6 +167,8 @@ any of
 | [occupancyConditionsMet](#occupancyconditionsmet)                                                   | `boolean` | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-occupancyconditionsmet.md "appeal-s78.schema.json#/properties/occupancyConditionsMet")                                                   |
 | [enforcementAppealGroundsDetails](#enforcementappealgroundsdetails)                                 | `array`   | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-enforcementappealgroundsdetails.md "appeal-s78.schema.json#/properties/enforcementAppealGroundsDetails")                                 |
 | [applicationElbAppealGroundsDetails](#applicationelbappealgroundsdetails)                           | `array`   | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-applicationelbappealgroundsdetails.md "appeal-s78.schema.json#/properties/applicationElbAppealGroundsDetails")                           |
+| [enforcementCaseGroundsOfAppeal](#enforcementcasegroundsofappeal)                                   | `array`   | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-enforcementcasegroundsofappeal.md "appeal-s78.schema.json#/properties/enforcementCaseGroundsOfAppeal")                                   |
+| [elbCaseGroundsOfAppeal](#elbcasegroundsofappeal)                                                   | `array`   | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-elbcasegroundsofappeal.md "appeal-s78.schema.json#/properties/elbCaseGroundsOfAppeal")                                                   |
 | [applicationMadeAndFeePaid](#applicationmadeandfeepaid)                                             | `boolean` | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-applicationmadeandfeepaid.md "appeal-s78.schema.json#/properties/applicationMadeAndFeePaid")                                             |
 | [noticeRelatesToBuildingEngineeringMiningOther](#noticerelatestobuildingengineeringminingother)     | `boolean` | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-noticerelatestobuildingengineeringminingother.md "appeal-s78.schema.json#/properties/noticeRelatesToBuildingEngineeringMiningOther")     |
 | [changeOfUseRefuseOrWaste](#changeofuserefuseorwaste)                                               | `boolean` | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-changeofuserefuseorwaste.md "appeal-s78.schema.json#/properties/changeOfUseRefuseOrWaste")                                               |
@@ -316,25 +318,27 @@ The processing status for the appeal
 
 **enum**: the value of this property must be equal to one of the following values:
 
-| Value                   | Explanation |
-| :---------------------- | :---------- |
-| `"assign_case_officer"` |             |
-| `"validation"`          |             |
-| `"ready_to_start"`      |             |
-| `"lpa_questionnaire"`   |             |
-| `"issue_determination"` |             |
-| `"statements"`          |             |
-| `"evidence"`            |             |
-| `"witnesses"`           |             |
-| `"final_comments"`      |             |
-| `"complete"`            |             |
-| `"invalid"`             |             |
-| `"closed"`              |             |
-| `"withdrawn"`           |             |
-| `"awaiting_transfer"`   |             |
-| `"transferred"`         |             |
-| `"event"`               |             |
-| `"awaiting_event"`      |             |
+| Value                      | Explanation |
+| :------------------------- | :---------- |
+| `"assign_case_officer"`    |             |
+| `"validation"`             |             |
+| `"ready_to_start"`         |             |
+| `"lpa_questionnaire"`      |             |
+| `"issue_determination"`    |             |
+| `"statements"`             |             |
+| `"evidence"`               |             |
+| `"witnesses"`              |             |
+| `"final_comments"`         |             |
+| `"complete"`               |             |
+| `"invalid"`                |             |
+| `"closed"`                 |             |
+| `"withdrawn"`              |             |
+| `"awaiting_transfer"`      |             |
+| `"transferred"`            |             |
+| `"event"`                  |             |
+| `"awaiting_event"`         |             |
+| `"notice_withdrawn"`       |             |
+| `"closed_opened_in_error"` |             |
 
 ## caseType
 
@@ -4070,6 +4074,46 @@ A list of grounds for the appeal, supporting facts & start dates. Enforcement ca
 
 `object[]` ([Details](appeal-s78-properties-applicationelbappealgroundsdetails-items.md))
 
+## enforcementCaseGroundsOfAppeal
+
+Case Officer list of grounds for the appeal & start dates. Enforcement cases (C) can have grounds (a) to (g)
+
+> Enforcement Listed Building cases (F) have a separate list of grounds (a) to (k)
+
+`enforcementCaseGroundsOfAppeal`
+
+* is optional
+
+* Type: `object[]` ([Details](appeal-s78-properties-enforcementcasegroundsofappeal-items.md))
+
+* can be null
+
+* defined in: [Appeal S78 Case](appeal-s78-properties-enforcementcasegroundsofappeal.md "appeal-s78.schema.json#/properties/enforcementCaseGroundsOfAppeal")
+
+### enforcementCaseGroundsOfAppeal Type
+
+`object[]` ([Details](appeal-s78-properties-enforcementcasegroundsofappeal-items.md))
+
+## elbCaseGroundsOfAppeal
+
+Case Officer list of grounds for the appeal & start dates. Enforcement cases (C) can have grounds (a) to (g)
+
+> Enforcement Listed Building cases (F) have a separate list of grounds (a) to (k)
+
+`elbCaseGroundsOfAppeal`
+
+* is optional
+
+* Type: `object[]` ([Details](appeal-s78-properties-elbcasegroundsofappeal-items.md))
+
+* can be null
+
+* defined in: [Appeal S78 Case](appeal-s78-properties-elbcasegroundsofappeal.md "appeal-s78.schema.json#/properties/elbCaseGroundsOfAppeal")
+
+### elbCaseGroundsOfAppeal Type
+
+`object[]` ([Details](appeal-s78-properties-elbcasegroundsofappeal-items.md))
+
 ## applicationMadeAndFeePaid
 
 Was an application made and paid for

package/package.json

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

@@ -157,6 +157,7 @@ class DocumentType(Enum):
     hearingProcess = "hearingProcess"
     inquiryCore = "inquiryCore"
     inquiryPostEvent = "inquiryPostEvent"
+    noticeWithdrawal = "noticeWithdrawal"
     NoneType_None = None
 
 

package/pins_data_model/models/model_appeal_has.py

@@ -27,6 +27,8 @@ class CaseStatus(StrEnum):
     transferred = "transferred"
     event = "event"
     awaiting_event = "awaiting_event"
+    notice_withdrawn = "notice_withdrawn"
+    closed_opened_in_error = "closed_opened_in_error"
 
 
 class CaseType(StrEnum):

package/pins_data_model/models/model_appeal_s78.py

@@ -31,6 +31,8 @@ class CaseStatus(StrEnum):
     transferred = "transferred"
     event = "event"
     awaiting_event = "awaiting_event"
+    notice_withdrawn = "notice_withdrawn"
+    closed_opened_in_error = "closed_opened_in_error"
 
 
 class CaseType(StrEnum):
@@ -394,6 +396,52 @@ class ApplicationElbAppealGroundsDetail(BaseModel):
     """
 
 
+class AppealGroundLetter2(Enum):
+    a = "a"
+    b = "b"
+    c = "c"
+    d = "d"
+    e = "e"
+    f = "f"
+    g = "g"
+    NoneType_None = None
+
+
+class EnforcementCaseGroundsOfAppealItem(BaseModel):
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    appealGroundLetter: AppealGroundLetter2 | None = None
+    groundForAppealStartDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+
+
+class AppealGroundLetter3(Enum):
+    a = "a"
+    b = "b"
+    c = "c"
+    d = "d"
+    e = "e"
+    f = "f"
+    g = "g"
+    h = "h"
+    i = "i"
+    j = "j"
+    k = "k"
+    NoneType_None = None
+
+
+class ElbCaseGroundsOfAppealItem(BaseModel):
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    appealGroundLetter: AppealGroundLetter3 | None = None
+    groundForAppealStartDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+
+
 class ApplicationPartOrWholeDevelopment(Enum):
     """
     Did the application relate to all or part of the development
@@ -1099,6 +1147,16 @@ class AppealS78Case1(BaseModel):
     """
     A list of grounds for the appeal, supporting facts & start dates. Enforcement cases (C) can have grounds (a) to (g)
     """
+    enforcementCaseGroundsOfAppeal: list[EnforcementCaseGroundsOfAppealItem] | None = (
+        None
+    )
+    """
+    Case Officer list of grounds for the appeal & start dates. Enforcement cases (C) can have grounds (a) to (g)
+    """
+    elbCaseGroundsOfAppeal: list[ElbCaseGroundsOfAppealItem] | None = None
+    """
+    Case Officer list of grounds for the appeal & start dates. Enforcement cases (C) can have grounds (a) to (g)
+    """
     applicationMadeAndFeePaid: bool | None = None
     """
     Was an application made and paid for
@@ -1223,7 +1281,7 @@ class AdvertDetail1(BaseModel):
     """
 
 
-class AppealGroundLetter2(Enum):
+class AppealGroundLetter4(Enum):
     a = "a"
     b = "b"
     c = "c"
@@ -1238,7 +1296,7 @@ class EnforcementAppealGroundsDetail1(BaseModel):
     model_config = ConfigDict(
         extra="allow",
     )
-    appealGroundLetter: AppealGroundLetter2 | None = None
+    appealGroundLetter: AppealGroundLetter4 | None = None
     groundForAppealStartDate: AwareDatetime | None = Field(
         None, examples=["2023-07-27T20:30:00.000Z"]
     )
@@ -1248,7 +1306,7 @@ class EnforcementAppealGroundsDetail1(BaseModel):
     """
 
 
-class AppealGroundLetter3(Enum):
+class AppealGroundLetter5(Enum):
     a = "a"
     b = "b"
     c = "c"
@@ -1267,7 +1325,7 @@ class ApplicationElbAppealGroundsDetail1(BaseModel):
     model_config = ConfigDict(
         extra="allow",
     )
-    appealGroundLetter: AppealGroundLetter3 | None = None
+    appealGroundLetter: AppealGroundLetter5 | None = None
     groundForAppealStartDate: AwareDatetime | None = Field(
         None, examples=["2023-07-27T20:30:00.000Z"]
     )
@@ -1277,6 +1335,52 @@ class ApplicationElbAppealGroundsDetail1(BaseModel):
     """
 
 
+class AppealGroundLetter6(Enum):
+    a = "a"
+    b = "b"
+    c = "c"
+    d = "d"
+    e = "e"
+    f = "f"
+    g = "g"
+    NoneType_None = None
+
+
+class EnforcementCaseGroundsOfAppealItem1(BaseModel):
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    appealGroundLetter: AppealGroundLetter6 | None = None
+    groundForAppealStartDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+
+
+class AppealGroundLetter7(Enum):
+    a = "a"
+    b = "b"
+    c = "c"
+    d = "d"
+    e = "e"
+    f = "f"
+    g = "g"
+    h = "h"
+    i = "i"
+    j = "j"
+    k = "k"
+    NoneType_None = None
+
+
+class ElbCaseGroundsOfAppealItem1(BaseModel):
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    appealGroundLetter: AppealGroundLetter7 | None = None
+    groundForAppealStartDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+
+
 class SignificantChangesAffectingApplicationAppellantItem1(BaseModel):
     value: Value | None
     comment: str | None = None
@@ -1941,6 +2045,16 @@ class AppealS78Case2(BaseModel):
     """
     A list of grounds for the appeal, supporting facts & start dates. Enforcement cases (C) can have grounds (a) to (g)
     """
+    enforcementCaseGroundsOfAppeal: list[EnforcementCaseGroundsOfAppealItem1] | None = (
+        None
+    )
+    """
+    Case Officer list of grounds for the appeal & start dates. Enforcement cases (C) can have grounds (a) to (g)
+    """
+    elbCaseGroundsOfAppeal: list[ElbCaseGroundsOfAppealItem1] | None = None
+    """
+    Case Officer list of grounds for the appeal & start dates. Enforcement cases (C) can have grounds (a) to (g)
+    """
     applicationMadeAndFeePaid: bool | None = None
     """
     Was an application made and paid for

package/schemas/appeal-document.schema.json

@@ -236,6 +236,7 @@
         "hearingProcess",
         "inquiryCore",
         "inquiryPostEvent",
+        "noticeWithdrawal",
         null
       ],
       "description": "The type of document, used for exchange, migrations and consumption from the appeal back-office system"

package/schemas/appeal-has.schema.json

@@ -125,7 +125,9 @@
         "awaiting_transfer",
         "transferred",
         "event",
-        "awaiting_event"
+        "awaiting_event",
+        "notice_withdrawn",
+        "closed_opened_in_error"
       ],
       "description": "The processing status for the appeal"
     },

package/schemas/appeal-s78.schema.json

@@ -196,7 +196,9 @@
         "awaiting_transfer",
         "transferred",
         "event",
-        "awaiting_event"
+        "awaiting_event",
+        "notice_withdrawn",
+        "closed_opened_in_error"
       ],
       "description": "The processing status for the appeal",
       "$comment": "Also available on HAS cases"
@@ -1214,6 +1216,46 @@
       "description": "A list of grounds for the appeal, supporting facts & start dates. Enforcement cases (C) can have grounds (a) to (g)",
       "$comment": "Enforcement Listed Building cases (F) have a separate list of grounds (a) to (k)"
     },
+    "enforcementCaseGroundsOfAppeal": {
+      "type": ["array", "null"],
+      "items": {
+        "type": "object",
+        "additionalProperties": true,
+        "properties": {
+          "appealGroundLetter": {
+            "type": ["string", "null"],
+            "enum": ["a", "b", "c", "d", "e", "f", "g", null]
+          },
+          "groundForAppealStartDate": {
+            "type": ["string", "null"],
+            "format": "date-time",
+            "examples": ["2023-07-27T20:30:00.000Z"]
+          }
+        }
+      },
+      "description": "Case Officer list of grounds for the appeal & start dates. Enforcement cases (C) can have grounds (a) to (g)",
+      "$comment": "Enforcement Listed Building cases (F) have a separate list of grounds (a) to (k)"
+    },
+    "elbCaseGroundsOfAppeal": {
+      "type": ["array", "null"],
+      "items": {
+        "type": "object",
+        "additionalProperties": true,
+        "properties": {
+          "appealGroundLetter": {
+            "type": ["string", "null"],
+            "enum": ["a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", null]
+          },
+          "groundForAppealStartDate": {
+            "type": ["string", "null"],
+            "format": "date-time",
+            "examples": ["2023-07-27T20:30:00.000Z"]
+          }
+        }
+      },
+      "description": "Case Officer list of grounds for the appeal & start dates. Enforcement cases (C) can have grounds (a) to (g)",
+      "$comment": "Enforcement Listed Building cases (F) have a separate list of grounds (a) to (k)"
+    },
     "applicationMadeAndFeePaid": {
       "type": ["boolean", "null"],
       "description": "Was an application made and paid for"

package/src/enums.cjs

@@ -19,11 +19,13 @@ const APPEAL_HAS_CASE_STATUS = Object.freeze({
   AWAITING_EVENT: 'awaiting_event',
   AWAITING_TRANSFER: 'awaiting_transfer',
   CLOSED: 'closed',
+  CLOSED_OPENED_IN_ERROR: 'closed_opened_in_error',
   COMPLETE: 'complete',
   EVENT: 'event',
   INVALID: 'invalid',
   ISSUE_DETERMINATION: 'issue_determination',
   LPA_QUESTIONNAIRE: 'lpa_questionnaire',
+  NOTICE_WITHDRAWN: 'notice_withdrawn',
   READY_TO_START: 'ready_to_start',
   TRANSFERRED: 'transferred',
   VALIDATION: 'validation',
@@ -122,6 +124,7 @@ const APPEAL_CASE_STATUS = Object.freeze({
   AWAITING_EVENT: 'awaiting_event',
   AWAITING_TRANSFER: 'awaiting_transfer',
   CLOSED: 'closed',
+  CLOSED_OPENED_IN_ERROR: 'closed_opened_in_error',
   COMPLETE: 'complete',
   EVENT: 'event',
   EVIDENCE: 'evidence',
@@ -129,6 +132,7 @@ const APPEAL_CASE_STATUS = Object.freeze({
   INVALID: 'invalid',
   ISSUE_DETERMINATION: 'issue_determination',
   LPA_QUESTIONNAIRE: 'lpa_questionnaire',
+  NOTICE_WITHDRAWN: 'notice_withdrawn',
   READY_TO_START: 'ready_to_start',
   STATEMENTS: 'statements',
   TRANSFERRED: 'transferred',
@@ -258,6 +262,7 @@ const APPEAL_DOCUMENT_TYPE = Object.freeze({
   LPA_WITNESSES_EVIDENCE: 'lpaWitnessesEvidence',
   MAIN_PARTY_CORRESPONDENCE: 'mainPartyCorrespondence',
   NEW_PLANS_DRAWINGS: 'newPlansDrawings',
+  NOTICE_WITHDRAWAL: 'noticeWithdrawal',
   ORIGINAL_APPLICATION_FORM: 'originalApplicationForm',
   OTHER_NEW_DOCUMENTS: 'otherNewDocuments',
   OTHER_PARTY_REPRESENTATIONS: 'otherPartyRepresentations',

package/src/enums.d.ts

@@ -17,11 +17,13 @@ export const APPEAL_HAS_CASE_STATUS = {
   AWAITING_EVENT: 'awaiting_event',
   AWAITING_TRANSFER: 'awaiting_transfer',
   CLOSED: 'closed',
+  CLOSED_OPENED_IN_ERROR: 'closed_opened_in_error',
   COMPLETE: 'complete',
   EVENT: 'event',
   INVALID: 'invalid',
   ISSUE_DETERMINATION: 'issue_determination',
   LPA_QUESTIONNAIRE: 'lpa_questionnaire',
+  NOTICE_WITHDRAWN: 'notice_withdrawn',
   READY_TO_START: 'ready_to_start',
   TRANSFERRED: 'transferred',
   VALIDATION: 'validation',
@@ -120,6 +122,7 @@ export const APPEAL_CASE_STATUS = {
   AWAITING_EVENT: 'awaiting_event',
   AWAITING_TRANSFER: 'awaiting_transfer',
   CLOSED: 'closed',
+  CLOSED_OPENED_IN_ERROR: 'closed_opened_in_error',
   COMPLETE: 'complete',
   EVENT: 'event',
   EVIDENCE: 'evidence',
@@ -127,6 +130,7 @@ export const APPEAL_CASE_STATUS = {
   INVALID: 'invalid',
   ISSUE_DETERMINATION: 'issue_determination',
   LPA_QUESTIONNAIRE: 'lpa_questionnaire',
+  NOTICE_WITHDRAWN: 'notice_withdrawn',
   READY_TO_START: 'ready_to_start',
   STATEMENTS: 'statements',
   TRANSFERRED: 'transferred',
@@ -256,6 +260,7 @@ export const APPEAL_DOCUMENT_TYPE = {
   LPA_WITNESSES_EVIDENCE: 'lpaWitnessesEvidence',
   MAIN_PARTY_CORRESPONDENCE: 'mainPartyCorrespondence',
   NEW_PLANS_DRAWINGS: 'newPlansDrawings',
+  NOTICE_WITHDRAWAL: 'noticeWithdrawal',
   ORIGINAL_APPLICATION_FORM: 'originalApplicationForm',
   OTHER_NEW_DOCUMENTS: 'otherNewDocuments',
   OTHER_PARTY_REPRESENTATIONS: 'otherPartyRepresentations',

package/src/enums.js

@@ -17,11 +17,13 @@ export const APPEAL_HAS_CASE_STATUS = Object.freeze({
   AWAITING_EVENT: 'awaiting_event',
   AWAITING_TRANSFER: 'awaiting_transfer',
   CLOSED: 'closed',
+  CLOSED_OPENED_IN_ERROR: 'closed_opened_in_error',
   COMPLETE: 'complete',
   EVENT: 'event',
   INVALID: 'invalid',
   ISSUE_DETERMINATION: 'issue_determination',
   LPA_QUESTIONNAIRE: 'lpa_questionnaire',
+  NOTICE_WITHDRAWN: 'notice_withdrawn',
   READY_TO_START: 'ready_to_start',
   TRANSFERRED: 'transferred',
   VALIDATION: 'validation',
@@ -120,6 +122,7 @@ export const APPEAL_CASE_STATUS = Object.freeze({
   AWAITING_EVENT: 'awaiting_event',
   AWAITING_TRANSFER: 'awaiting_transfer',
   CLOSED: 'closed',
+  CLOSED_OPENED_IN_ERROR: 'closed_opened_in_error',
   COMPLETE: 'complete',
   EVENT: 'event',
   EVIDENCE: 'evidence',
@@ -127,6 +130,7 @@ export const APPEAL_CASE_STATUS = Object.freeze({
   INVALID: 'invalid',
   ISSUE_DETERMINATION: 'issue_determination',
   LPA_QUESTIONNAIRE: 'lpa_questionnaire',
+  NOTICE_WITHDRAWN: 'notice_withdrawn',
   READY_TO_START: 'ready_to_start',
   STATEMENTS: 'statements',
   TRANSFERRED: 'transferred',
@@ -256,6 +260,7 @@ export const APPEAL_DOCUMENT_TYPE = Object.freeze({
   LPA_WITNESSES_EVIDENCE: 'lpaWitnessesEvidence',
   MAIN_PARTY_CORRESPONDENCE: 'mainPartyCorrespondence',
   NEW_PLANS_DRAWINGS: 'newPlansDrawings',
+  NOTICE_WITHDRAWAL: 'noticeWithdrawal',
   ORIGINAL_APPLICATION_FORM: 'originalApplicationForm',
   OTHER_NEW_DOCUMENTS: 'otherNewDocuments',
   OTHER_PARTY_REPRESENTATIONS: 'otherPartyRepresentations',

package/src/index.cjs

@@ -100,11 +100,13 @@ const APPEAL_HAS_CASE_STATUS = Object.freeze({
   AWAITING_EVENT: 'awaiting_event',
   AWAITING_TRANSFER: 'awaiting_transfer',
   CLOSED: 'closed',
+  CLOSED_OPENED_IN_ERROR: 'closed_opened_in_error',
   COMPLETE: 'complete',
   EVENT: 'event',
   INVALID: 'invalid',
   ISSUE_DETERMINATION: 'issue_determination',
   LPA_QUESTIONNAIRE: 'lpa_questionnaire',
+  NOTICE_WITHDRAWN: 'notice_withdrawn',
   READY_TO_START: 'ready_to_start',
   TRANSFERRED: 'transferred',
   VALIDATION: 'validation',
@@ -203,6 +205,7 @@ const APPEAL_CASE_STATUS = Object.freeze({
   AWAITING_EVENT: 'awaiting_event',
   AWAITING_TRANSFER: 'awaiting_transfer',
   CLOSED: 'closed',
+  CLOSED_OPENED_IN_ERROR: 'closed_opened_in_error',
   COMPLETE: 'complete',
   EVENT: 'event',
   EVIDENCE: 'evidence',
@@ -210,6 +213,7 @@ const APPEAL_CASE_STATUS = Object.freeze({
   INVALID: 'invalid',
   ISSUE_DETERMINATION: 'issue_determination',
   LPA_QUESTIONNAIRE: 'lpa_questionnaire',
+  NOTICE_WITHDRAWN: 'notice_withdrawn',
   READY_TO_START: 'ready_to_start',
   STATEMENTS: 'statements',
   TRANSFERRED: 'transferred',
@@ -339,6 +343,7 @@ const APPEAL_DOCUMENT_TYPE = Object.freeze({
   LPA_WITNESSES_EVIDENCE: 'lpaWitnessesEvidence',
   MAIN_PARTY_CORRESPONDENCE: 'mainPartyCorrespondence',
   NEW_PLANS_DRAWINGS: 'newPlansDrawings',
+  NOTICE_WITHDRAWAL: 'noticeWithdrawal',
   ORIGINAL_APPLICATION_FORM: 'originalApplicationForm',
   OTHER_NEW_DOCUMENTS: 'otherNewDocuments',
   OTHER_PARTY_REPRESENTATIONS: 'otherPartyRepresentations',

package/src/schemas.d.ts

@@ -232,6 +232,7 @@ export interface AppealDocument {
     | 'hearingProcess'
     | 'inquiryCore'
     | 'inquiryPostEvent'
+    | 'noticeWithdrawal'
     | null;
   /**
    * The system mastering the metadata for the current document
@@ -421,7 +422,9 @@ export type AppealHASCase = (GridReference | SiteAddress) & {
     | 'awaiting_transfer'
     | 'transferred'
     | 'event'
-    | 'awaiting_event';
+    | 'awaiting_event'
+    | 'notice_withdrawn'
+    | 'closed_opened_in_error';
   /**
    * The internal code for an appeal type, e.g. D (Householder)
    */
@@ -1049,7 +1052,9 @@ export type AppealS78Case = (GridReference | SiteAddress) & {
     | 'awaiting_transfer'
     | 'transferred'
     | 'event'
-    | 'awaiting_event';
+    | 'awaiting_event'
+    | 'notice_withdrawn'
+    | 'closed_opened_in_error';
   /**
    * The internal code for an appeal type, e.g. D (Householder)
    */
@@ -1701,6 +1706,26 @@ export type AppealS78Case = (GridReference | SiteAddress) & {
         [k: string]: unknown;
       }[]
     | null;
+  /**
+   * Case Officer list of grounds for the appeal & start dates. Enforcement cases (C) can have grounds (a) to (g)
+   */
+  enforcementCaseGroundsOfAppeal?:
+    | {
+        appealGroundLetter?: 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | null;
+        groundForAppealStartDate?: string | null;
+        [k: string]: unknown;
+      }[]
+    | null;
+  /**
+   * Case Officer list of grounds for the appeal & start dates. Enforcement cases (C) can have grounds (a) to (g)
+   */
+  elbCaseGroundsOfAppeal?:
+    | {
+        appealGroundLetter?: 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | null;
+        groundForAppealStartDate?: string | null;
+        [k: string]: unknown;
+      }[]
+    | null;
   /**
    * Was an application made and paid for
    */

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

@@ -363,4 +363,45 @@ describe(schema, () => {
 			assert.strictEqual(validationResult, false, 'Expected invalid caseProcedure value to fail validation');
 		});
 	});
+
+	describe('caseStatus schema validation (Group A - HAS)', () => {
+		it('should accept caseStatus values', () => {
+			for (const status of [
+				'assign_case_officer',
+				'validation',
+				'ready_to_start',
+				'lpa_questionnaire',
+				'issue_determination',
+				'complete',
+				'invalid',
+				'closed',
+				'withdrawn',
+				'awaiting_transfer',
+				'transferred',
+				'event',
+				'awaiting_event',
+				'notice_withdrawn',
+				'closed_opened_in_error'
+			]) {
+				const test = structuredClone(appealHas);
+				test.caseStatus = status;
+				const validationResult = ajv.validate(schema, test);
+				assert.strictEqual(validationResult, true, `Expected caseStatus "${status}" to be valid`);
+			}
+		});
+
+		it('should not accept null value for caseStatus', () => {
+			const test = structuredClone(appealHas);
+			test.caseStatus = null;
+			const validationResult = ajv.validate(schema, test);
+			assert.strictEqual(validationResult, false, 'Expected caseStatus null not to be valid');
+		});
+
+		it('should reject invalid caseStatus values', () => {
+			const test = structuredClone(appealHas);
+			test.caseStatus = 'invalid_status';
+			const validationResult = ajv.validate(schema, test);
+			assert.strictEqual(validationResult, false, 'Expected invalid caseStatus value to fail validation');
+		});
+	});
 });

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

@@ -283,4 +283,45 @@ describe(schema, () => {
 		const validationResult = ajv.validate(schema, test);
 		assert.strictEqual(validationResult, true);
 	});
+
+	describe('caseStatus schema validation (Group B)', () => {
+		it('should accept caseStatus values', () => {
+			for (const status of [
+				'assign_case_officer',
+				'validation',
+				'ready_to_start',
+				'lpa_questionnaire',
+				'issue_determination',
+				'complete',
+				'invalid',
+				'closed',
+				'withdrawn',
+				'awaiting_transfer',
+				'transferred',
+				'event',
+				'awaiting_event',
+				'notice_withdrawn',
+				'closed_opened_in_error'
+			]) {
+				const test = structuredClone(appealS78);
+				test.caseStatus = status;
+				const validationResult = ajv.validate(schema, test);
+				assert.strictEqual(validationResult, true, `Expected caseStatus "${status}" to be valid`);
+			}
+		});
+
+		it('should not accept null value for caseStatus', () => {
+			const test = structuredClone(appealS78);
+			test.caseStatus = null;
+			const validationResult = ajv.validate(schema, test);
+			assert.strictEqual(validationResult, false, 'Expected caseStatus null not to be valid');
+		});
+
+		it('should reject invalid caseStatus values', () => {
+			const test = structuredClone(appealS78);
+			test.caseStatus = 'invalid_status';
+			const validationResult = ajv.validate(schema, test);
+			assert.strictEqual(validationResult, false, 'Expected invalid caseStatus value to fail validation');
+		});
+	});
 });