@planning-inspectorate/data-model 2.48.1 → 2.50.0

package/src/enums.js

@@ -1,3 +1,10 @@
+export const ADDRESS_TYPE = Object.freeze({
+  CONTACT: 'contact',
+  NEIGHBOURING: 'neighbouring',
+  ORGANISATION: 'organisation',
+  SITE: 'site',
+});
+
 export const APPEAL_HAS_CASE_DECISION_OUTCOME = Object.freeze({
   ALLOWED: 'allowed',
   DISMISSED: 'dismissed',
@@ -5,12 +12,6 @@ export const APPEAL_HAS_CASE_DECISION_OUTCOME = Object.freeze({
   SPLIT_DECISION: 'split_decision',
 });
 
-export const APPEAL_HAS_CASE_PROCEDURE = Object.freeze({
-  HEARING: 'hearing',
-  INQUIRY: 'inquiry',
-  WRITTEN: 'written',
-});
-
 export const APPEAL_HAS_CASE_STATUS = Object.freeze({
   ASSIGN_CASE_OFFICER: 'assign_case_officer',
   AWAITING_EVENT: 'awaiting_event',
@@ -441,12 +442,136 @@ export const APPEAL_VIRUS_CHECK_STATUS = Object.freeze({
   SCANNED: 'scanned',
 });
 
+export const APPLICATION_STAGE = Object.freeze({
+  ACCEPTED: 'Accepted',
+  CONSULTATION: 'Consultation',
+  FINAL_DECISION: 'Final decision',
+  HEARING_INQUIRY_DATE_SET: 'Hearing/Inquiry date set',
+  INQUIRY: 'Inquiry',
+  PROCEDURE_CHOICE: 'Procedure choice',
+  WRITTEN_REPRESENTATIONS: 'Written representations',
+});
+
+export const APPLICATION_STATUS = Object.freeze({
+  ACCEPTED: 'Accepted',
+  APPLICATION_ON_HOLD_AWAITING_FURTHER_INFORMATION: 'Application on hold awaiting further information',
+  CLOSED_INVALID: 'Closed - invalid',
+  CLOSED_OPENED_IN_ERROR: 'Closed - opened in error',
+  CONSULTATION_PERIOD_OPEN: 'Consultation period open',
+  DECIDED: 'Decided',
+  DECISION_AWAITED: 'Decision awaited',
+  DECLINED_TO_DETERMINE: 'Declined to determine',
+  HEARING_INQUIRY_DATE_SET: 'Hearing/Inquiry date set',
+  INVALID: 'Invalid',
+  NEW: 'New',
+  REPORT_AWAITED: 'Report awaited',
+  REPORT_SENT_TO_DECISION_BRANCH: 'Report sent to Decision Branch',
+  WITHDRAWN: 'Withdrawn',
+});
+
 export const APPLICATION_UPDATE_STATUS = Object.freeze({
   DRAFT: 'Draft',
   PUBLISHED: 'Published',
   UNPUBLISHED: 'Unpublished',
 });
 
+export const APPLICATION_CATEGORY = Object.freeze({
+  BUILDINGS_LESS_THAN_1000_SQUARE_METRES: 'Buildings less than 1000 square metres',
+  BUILDINGS_OVER_1000_SQUARE_METRES: 'Buildings over 1000 square metres',
+  CHANGE_OF_USE: 'Change of use',
+  DEVELOPMENT_OF_A_SITE_ABOVE_1_HECTARE: 'Development of a site above 1 hectare',
+  DEVELOPMENT_OF_A_SITE_LESS_THAN_1_HECTARE: 'Development of a site less than 1 hectare',
+  DWELLINGS_NUMBERING_10_OR_MORE: 'Dwellings numbering 10 or more',
+  DWELLINGS_NUMBERING_BETWEEN_1_AND_9: 'Dwellings numbering between 1 and 9',
+  DWELLINGS_OF_0_5_HECTARE_OR_MORE: 'Dwellings of 0.5 hectare or more',
+  DWELLINGS_OF_LESS_THAN_0_5_HECTARE: 'Dwellings of less than 0.5 hectare',
+  LISTED_BUILDING_CONSENT_TO_ALTER_EXTEND: 'Listed building consent to alter/extend',
+  LISTED_BUILDING_CONSENT_TO_DEMOLISH: 'Listed building consent to demolish',
+  MAJOR_DEVELOPMENT: 'Major Development',
+  MINERALS: 'Minerals',
+  NON_MAJOR_DEVELOPMENT: 'Non-Major Development',
+  OTHER: 'Other',
+  RELEVANT_DEMOLITION: 'Relevant demolition',
+  WASTE: 'Waste',
+});
+
+export const APPLICATION_DECISION_OUTCOME = Object.freeze({
+  APPROVED: 'Approved',
+  APPROVED_WITH_CONDITIONS: 'Approved with conditions',
+  REFUSED: 'Refused',
+  WITHDRAWN: 'Withdrawn',
+});
+
+export const APPLICATION_EIA_SCREENING_OUTCOME = Object.freeze({
+  NOT_REQUIRED: 'not required',
+  REQUIRED: 'required',
+});
+
+export const APPLICATION_EMAIL_STATUS = Object.freeze({
+  DELIVERED: 'Delivered',
+  PERMANENT_FAILURE: 'Permanent failure',
+  SENDING: 'Sending',
+  TECHNICAL_FAILURE: 'Technical failure',
+  TEMPORARY_FAILURE: 'Temporary failure',
+});
+
+export const APPLICATION_PROCEDURE = Object.freeze({
+  HEARING: 'Hearing',
+  INQUIRY: 'Inquiry',
+  WRITTEN_REPRESENTATIONS: 'Written Representations',
+});
+
+export const APPLICATION_REPRESENTATION_STATUS = Object.freeze({
+  ACCEPTED: 'Accepted',
+  AWAITING_REVIEW: 'Awaiting review',
+  REJECTED: 'Rejected',
+  WITHDRAWN: 'Withdrawn',
+});
+
+export const APPLICATION_REPRESENTED_CATEGORY = Object.freeze({
+  CONSULTEES: 'Consultees',
+  INTERESTED_PARTY: 'Interested party',
+});
+
+export const APPLICATION_REPRESENTED_TYPE = Object.freeze({
+  A_PERSON: 'A person',
+  AN_ORGANISATION_OR_CHARITY_I_DO_NOT_WORK_OR_VOLUNTEER_FOR: 'An organisation or charity I do not work or volunteer for',
+  AN_ORGANISATION_OR_CHARITY_I_WORK_OR_VOLUNTEER_FOR: 'An organisation or charity I work or volunteer for',
+});
+
+export const APPLICATION_SUB_TYPE = Object.freeze({
+  LISTED_BUILDING_CONSENT_LBC: 'Listed building consent (LBC)',
+  PLANNING_PERMISSION: 'Planning permission',
+});
+
+export const APPLICATION_SUBMITTED_FOR = Object.freeze({
+  MYSELF: 'Myself',
+  ON_BEHALF_OF_ANOTHER_PERSON_OR_AN_ORGANISATION: 'On behalf of another person or an organisation',
+});
+
+export const APPLICATION_SUBMITTED_RECEIVED_METHOD = Object.freeze({
+  EMAIL: 'Email',
+  IN_PERSON: 'In person',
+  ONLINE: 'Online',
+  PHONE: 'Phone',
+  POST: 'Post',
+});
+
+export const APPLICATION_TYPE = Object.freeze({
+  APPROVAL_OF_RESERVED_MATTERS_FOLLOWING_OUTLINE_APPROVAL: 'Approval of reserved matters following outline approval',
+  OUTLINE_PLANNING_PERMISSION_WITH_ALL_MATTERS_RESERVED: 'Outline planning permission with all matters reserved',
+  OUTLINE_PLANNING_PERMISSION_WITH_SOME_MATTERS_RESERVED: 'Outline planning permission with some matters reserved',
+  PLANNING_PERMISSION: 'Planning permission',
+  PLANNING_PERMISSION_AND_LISTED_BUILDING_CONSENT_LBC_FOR_ALTERATIONS_EXTENSION_OR_DEMOLITION_OF_A_LISTED_BUILDING: 'Planning permission and listed building consent (LBC) for alterations, extension or demolition of a listed building',
+});
+
+export const APPLICATION_WITHDRAWAL_REASON = Object.freeze({
+  CHANGE_OF_OPINION: 'Change of opinion',
+  MISTAKEN_SUBMISSION: 'Mistaken Submission',
+  MISUNDERSTANDING: 'Misunderstanding',
+  PERSONAL_REASONS: 'Personal Reasons',
+});
+
 export const CASE_STAGE = Object.freeze({
   0: '0',
   ACCEPTANCE: 'acceptance',

package/src/index.cjs

@@ -81,6 +81,13 @@ function loadSchemaSync(filePath) {
 	return jsoncParser.parse(content.toString());
 }
 
+const ADDRESS_TYPE = Object.freeze({
+  CONTACT: 'contact',
+  NEIGHBOURING: 'neighbouring',
+  ORGANISATION: 'organisation',
+  SITE: 'site',
+});
+
 const APPEAL_HAS_CASE_DECISION_OUTCOME = Object.freeze({
   ALLOWED: 'allowed',
   DISMISSED: 'dismissed',
@@ -88,12 +95,6 @@ const APPEAL_HAS_CASE_DECISION_OUTCOME = Object.freeze({
   SPLIT_DECISION: 'split_decision',
 });
 
-const APPEAL_HAS_CASE_PROCEDURE = Object.freeze({
-  HEARING: 'hearing',
-  INQUIRY: 'inquiry',
-  WRITTEN: 'written',
-});
-
 const APPEAL_HAS_CASE_STATUS = Object.freeze({
   ASSIGN_CASE_OFFICER: 'assign_case_officer',
   AWAITING_EVENT: 'awaiting_event',
@@ -524,12 +525,136 @@ const APPEAL_VIRUS_CHECK_STATUS = Object.freeze({
   SCANNED: 'scanned',
 });
 
+const APPLICATION_STAGE = Object.freeze({
+  ACCEPTED: 'Accepted',
+  CONSULTATION: 'Consultation',
+  FINAL_DECISION: 'Final decision',
+  HEARING_INQUIRY_DATE_SET: 'Hearing/Inquiry date set',
+  INQUIRY: 'Inquiry',
+  PROCEDURE_CHOICE: 'Procedure choice',
+  WRITTEN_REPRESENTATIONS: 'Written representations',
+});
+
+const APPLICATION_STATUS = Object.freeze({
+  ACCEPTED: 'Accepted',
+  APPLICATION_ON_HOLD_AWAITING_FURTHER_INFORMATION: 'Application on hold awaiting further information',
+  CLOSED_INVALID: 'Closed - invalid',
+  CLOSED_OPENED_IN_ERROR: 'Closed - opened in error',
+  CONSULTATION_PERIOD_OPEN: 'Consultation period open',
+  DECIDED: 'Decided',
+  DECISION_AWAITED: 'Decision awaited',
+  DECLINED_TO_DETERMINE: 'Declined to determine',
+  HEARING_INQUIRY_DATE_SET: 'Hearing/Inquiry date set',
+  INVALID: 'Invalid',
+  NEW: 'New',
+  REPORT_AWAITED: 'Report awaited',
+  REPORT_SENT_TO_DECISION_BRANCH: 'Report sent to Decision Branch',
+  WITHDRAWN: 'Withdrawn',
+});
+
 const APPLICATION_UPDATE_STATUS = Object.freeze({
   DRAFT: 'Draft',
   PUBLISHED: 'Published',
   UNPUBLISHED: 'Unpublished',
 });
 
+const APPLICATION_CATEGORY = Object.freeze({
+  BUILDINGS_LESS_THAN_1000_SQUARE_METRES: 'Buildings less than 1000 square metres',
+  BUILDINGS_OVER_1000_SQUARE_METRES: 'Buildings over 1000 square metres',
+  CHANGE_OF_USE: 'Change of use',
+  DEVELOPMENT_OF_A_SITE_ABOVE_1_HECTARE: 'Development of a site above 1 hectare',
+  DEVELOPMENT_OF_A_SITE_LESS_THAN_1_HECTARE: 'Development of a site less than 1 hectare',
+  DWELLINGS_NUMBERING_10_OR_MORE: 'Dwellings numbering 10 or more',
+  DWELLINGS_NUMBERING_BETWEEN_1_AND_9: 'Dwellings numbering between 1 and 9',
+  DWELLINGS_OF_0_5_HECTARE_OR_MORE: 'Dwellings of 0.5 hectare or more',
+  DWELLINGS_OF_LESS_THAN_0_5_HECTARE: 'Dwellings of less than 0.5 hectare',
+  LISTED_BUILDING_CONSENT_TO_ALTER_EXTEND: 'Listed building consent to alter/extend',
+  LISTED_BUILDING_CONSENT_TO_DEMOLISH: 'Listed building consent to demolish',
+  MAJOR_DEVELOPMENT: 'Major Development',
+  MINERALS: 'Minerals',
+  NON_MAJOR_DEVELOPMENT: 'Non-Major Development',
+  OTHER: 'Other',
+  RELEVANT_DEMOLITION: 'Relevant demolition',
+  WASTE: 'Waste',
+});
+
+const APPLICATION_DECISION_OUTCOME = Object.freeze({
+  APPROVED: 'Approved',
+  APPROVED_WITH_CONDITIONS: 'Approved with conditions',
+  REFUSED: 'Refused',
+  WITHDRAWN: 'Withdrawn',
+});
+
+const APPLICATION_EIA_SCREENING_OUTCOME = Object.freeze({
+  NOT_REQUIRED: 'not required',
+  REQUIRED: 'required',
+});
+
+const APPLICATION_EMAIL_STATUS = Object.freeze({
+  DELIVERED: 'Delivered',
+  PERMANENT_FAILURE: 'Permanent failure',
+  SENDING: 'Sending',
+  TECHNICAL_FAILURE: 'Technical failure',
+  TEMPORARY_FAILURE: 'Temporary failure',
+});
+
+const APPLICATION_PROCEDURE = Object.freeze({
+  HEARING: 'Hearing',
+  INQUIRY: 'Inquiry',
+  WRITTEN_REPRESENTATIONS: 'Written Representations',
+});
+
+const APPLICATION_REPRESENTATION_STATUS = Object.freeze({
+  ACCEPTED: 'Accepted',
+  AWAITING_REVIEW: 'Awaiting review',
+  REJECTED: 'Rejected',
+  WITHDRAWN: 'Withdrawn',
+});
+
+const APPLICATION_REPRESENTED_CATEGORY = Object.freeze({
+  CONSULTEES: 'Consultees',
+  INTERESTED_PARTY: 'Interested party',
+});
+
+const APPLICATION_REPRESENTED_TYPE = Object.freeze({
+  A_PERSON: 'A person',
+  AN_ORGANISATION_OR_CHARITY_I_DO_NOT_WORK_OR_VOLUNTEER_FOR: 'An organisation or charity I do not work or volunteer for',
+  AN_ORGANISATION_OR_CHARITY_I_WORK_OR_VOLUNTEER_FOR: 'An organisation or charity I work or volunteer for',
+});
+
+const APPLICATION_SUB_TYPE = Object.freeze({
+  LISTED_BUILDING_CONSENT_LBC: 'Listed building consent (LBC)',
+  PLANNING_PERMISSION: 'Planning permission',
+});
+
+const APPLICATION_SUBMITTED_FOR = Object.freeze({
+  MYSELF: 'Myself',
+  ON_BEHALF_OF_ANOTHER_PERSON_OR_AN_ORGANISATION: 'On behalf of another person or an organisation',
+});
+
+const APPLICATION_SUBMITTED_RECEIVED_METHOD = Object.freeze({
+  EMAIL: 'Email',
+  IN_PERSON: 'In person',
+  ONLINE: 'Online',
+  PHONE: 'Phone',
+  POST: 'Post',
+});
+
+const APPLICATION_TYPE = Object.freeze({
+  APPROVAL_OF_RESERVED_MATTERS_FOLLOWING_OUTLINE_APPROVAL: 'Approval of reserved matters following outline approval',
+  OUTLINE_PLANNING_PERMISSION_WITH_ALL_MATTERS_RESERVED: 'Outline planning permission with all matters reserved',
+  OUTLINE_PLANNING_PERMISSION_WITH_SOME_MATTERS_RESERVED: 'Outline planning permission with some matters reserved',
+  PLANNING_PERMISSION: 'Planning permission',
+  PLANNING_PERMISSION_AND_LISTED_BUILDING_CONSENT_LBC_FOR_ALTERATIONS_EXTENSION_OR_DEMOLITION_OF_A_LISTED_BUILDING: 'Planning permission and listed building consent (LBC) for alterations, extension or demolition of a listed building',
+});
+
+const APPLICATION_WITHDRAWAL_REASON = Object.freeze({
+  CHANGE_OF_OPINION: 'Change of opinion',
+  MISTAKEN_SUBMISSION: 'Mistaken Submission',
+  MISUNDERSTANDING: 'Misunderstanding',
+  PERSONAL_REASONS: 'Personal Reasons',
+});
+
 const CASE_STAGE = Object.freeze({
   0: '0',
   ACCEPTANCE: 'acceptance',
@@ -947,6 +1072,7 @@ function loadAllSchemasSync() {
 	};
 }
 
+exports.ADDRESS_TYPE = ADDRESS_TYPE;
 exports.APPEAL_ALLOCATION_LEVEL = APPEAL_ALLOCATION_LEVEL;
 exports.APPEAL_APPEAL_UNDER_ACT_SECTION = APPEAL_APPEAL_UNDER_ACT_SECTION;
 exports.APPEAL_APPELLANT_PROCEDURE_PREFERENCE = APPEAL_APPELLANT_PROCEDURE_PREFERENCE;
@@ -967,7 +1093,6 @@ exports.APPEAL_EIA_ENVIRONMENTAL_IMPACT_SCHEDULE = APPEAL_EIA_ENVIRONMENTAL_IMPA
 exports.APPEAL_EVENT_STATUS = APPEAL_EVENT_STATUS;
 exports.APPEAL_EVENT_TYPE = APPEAL_EVENT_TYPE;
 exports.APPEAL_HAS_CASE_DECISION_OUTCOME = APPEAL_HAS_CASE_DECISION_OUTCOME;
-exports.APPEAL_HAS_CASE_PROCEDURE = APPEAL_HAS_CASE_PROCEDURE;
 exports.APPEAL_HAS_CASE_STATUS = APPEAL_HAS_CASE_STATUS;
 exports.APPEAL_HAS_TYPE_OF_PLANNING_APPLICATION = APPEAL_HAS_TYPE_OF_PLANNING_APPLICATION;
 exports.APPEAL_INVALID_OR_INCOMPLETE_DETAILS = APPEAL_INVALID_OR_INCOMPLETE_DETAILS;
@@ -986,7 +1111,22 @@ exports.APPEAL_SOURCE_SYSTEM = APPEAL_SOURCE_SYSTEM;
 exports.APPEAL_TYPE_OF_PLANNING_APPLICATION = APPEAL_TYPE_OF_PLANNING_APPLICATION;
 exports.APPEAL_UNDER_ACT_SECTION = APPEAL_UNDER_ACT_SECTION;
 exports.APPEAL_VIRUS_CHECK_STATUS = APPEAL_VIRUS_CHECK_STATUS;
+exports.APPLICATION_CATEGORY = APPLICATION_CATEGORY;
+exports.APPLICATION_DECISION_OUTCOME = APPLICATION_DECISION_OUTCOME;
+exports.APPLICATION_EIA_SCREENING_OUTCOME = APPLICATION_EIA_SCREENING_OUTCOME;
+exports.APPLICATION_EMAIL_STATUS = APPLICATION_EMAIL_STATUS;
+exports.APPLICATION_PROCEDURE = APPLICATION_PROCEDURE;
+exports.APPLICATION_REPRESENTATION_STATUS = APPLICATION_REPRESENTATION_STATUS;
+exports.APPLICATION_REPRESENTED_CATEGORY = APPLICATION_REPRESENTED_CATEGORY;
+exports.APPLICATION_REPRESENTED_TYPE = APPLICATION_REPRESENTED_TYPE;
+exports.APPLICATION_STAGE = APPLICATION_STAGE;
+exports.APPLICATION_STATUS = APPLICATION_STATUS;
+exports.APPLICATION_SUBMITTED_FOR = APPLICATION_SUBMITTED_FOR;
+exports.APPLICATION_SUBMITTED_RECEIVED_METHOD = APPLICATION_SUBMITTED_RECEIVED_METHOD;
+exports.APPLICATION_SUB_TYPE = APPLICATION_SUB_TYPE;
+exports.APPLICATION_TYPE = APPLICATION_TYPE;
 exports.APPLICATION_UPDATE_STATUS = APPLICATION_UPDATE_STATUS;
+exports.APPLICATION_WITHDRAWAL_REASON = APPLICATION_WITHDRAWAL_REASON;
 exports.CASE_STAGE = CASE_STAGE;
 exports.MESSAGE_EVENT_TYPE = MESSAGE_EVENT_TYPE;
 exports.METHOD = METHOD;