@planning-inspectorate/data-model 2.51.1 → 2.53.0

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
    */
@@ -2320,7 +2345,7 @@ export interface EmailNotificationRecordSchema {
   /**
    * Outcome of the email (status)
    */
-  emailStatus?: 'Sending' | 'Delivered' | 'Permanent failure' | 'Temporary failure' | 'Technical failure';
+  emailStatus: 'Sending' | 'Delivered' | 'Permanent failure' | 'Temporary failure' | 'Technical failure';
   /**
    * The id of the template sent in Notify
    */
@@ -2379,10 +2404,10 @@ export interface CaseworkRepresentationSchema {
    * The type of case this representation is for.
    */
   caseType: string;
-  representationStatus?: 'Awaiting review' | 'Accepted' | 'Rejected' | 'Withdrawn';
+  representationStatus: 'Awaiting review' | 'Accepted' | 'Rejected' | 'Withdrawn';
   submittedFor: 'Myself' | 'On behalf of another person or an organisation';
   submittedByContact?: Contact[] | null;
-  submittedByAgentFlag?: boolean | null;
+  submittedByAgent?: boolean | null;
   submittedByAgentOrgName?: string | null;
   submittedDate: string;
   /**

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');
+		});
+	});
 });