@planning-inspectorate/data-model 1.18.1 → 1.20.0

package/src/lib/gen-enums.js

@@ -11,7 +11,7 @@ export const constPath = path.join(__dirname, '..', 'enums.js');
 export const constTsPath = path.join(__dirname, '..', 'enums.d.ts');
 
 const SPACING = '  ';
-const NEW_LINE = '\r\n';
+const NEW_LINE = '\n';
 
 /**
  * Load all schemas and generate JS constant definitions

package/src/schemas.d.ts

@@ -2090,9 +2090,18 @@ export interface NSIPProject {
   projectDescription: string | null;
   projectDescriptionWelsh?: string | null;
   /**
-   * Decision: approved/refused/split-decision
-   */
-  decision: 'approved' | 'refused' | 'split-decision' | null;
+   * Decision outcome: approved/refused/split-decision/granted/partially_consented/quashed/redetermination/withdrawn
+   */
+  decision:
+    | 'approved'
+    | 'refused'
+    | 'split-decision'
+    | 'granted'
+    | 'partially_consented'
+    | 'quashed'
+    | 'redetermination'
+    | 'withdrawn'
+    | null;
   publishStatus: 'published' | 'unpublished' | null;
   /**
    * {Sector Abbreviation} - {Sector Display Name}
@@ -2382,6 +2391,284 @@ export interface NSIPProject {
    * Is this an application for a material change?
    */
   isMaterialChange?: boolean | null;
+  /**
+   * Date of court decision
+   */
+  courtDecisionDate?: string | null;
+  /**
+   * Court decision outcome text; values include 'upheld','partially_upheld','quashed','other:<Text>'
+   */
+  courtDecisionOutcomeText?: string | null;
+  /**
+   * Date of decision challenge submission
+   */
+  decisionChallengeSubmissionDate?: string | null;
+  /**
+   * Recommendation
+   */
+  recommendation?: 'recommend_consent' | 'recommend_partial_consent' | 'recommend_refusal' | null;
+  /**
+   * Date of inception meeting
+   */
+  inceptionMeetingDate?: string | null;
+  /**
+   * Date for submission of draft documents
+   */
+  draftDocumentSubmissionDate?: string | null;
+  /**
+   * Programme document submission date
+   */
+  programmeDocumentSubmissionDate?: string | null;
+  /**
+   * Tier
+   */
+  tier?: 'basic' | 'standard' | 'enhanced' | null;
+  /**
+   * Link to s61 summary
+   */
+  s61SummaryURI?: string | null;
+  /**
+   * Estimated scoping submission date
+   */
+  estimatedScopingSubmissionDate?: string | null;
+  /**
+   * Adequacy of Consultation Milestone
+   */
+  consultationMilestoneAdequacyDate?: string | null;
+  /**
+   * Evidence plan process
+   */
+  planProcessEvidence?: boolean | null;
+  /**
+   * Issues tracker
+   */
+  issuesTracker?: string | null;
+  /**
+   * Essential fast track components
+   */
+  essentialFastTrackComponents?: boolean | null;
+  /**
+   * Principal area disagreement summary statement (PADSS)
+   */
+  principalAreaDisagreementSummaryStmt?: 'submitted_by_applicant' | 'awaiting_submission' | 'not_applicable' | null;
+  /**
+   * Principal area disagreement summary statement (PADSS) Submitted date
+   */
+  principalAreaDisagreementSummaryStmtSubmittedDate?: string | null;
+  /**
+   * Policy compliance document (PCD)
+   */
+  policyComplianceDocument?: 'submitted_by_applicant' | 'awaiting_submission' | 'not_applicable' | null;
+  /**
+   * Policy compliance document (PCD) Submitted Date
+   */
+  policyComplianceDocumentSubmittedDate?: string | null;
+  /**
+   * Design approach document (DAD)
+   */
+  designApproachDocument?: 'submitted_by_applicant' | 'awaiting_submission' | 'not_applicable' | null;
+  /**
+   * Design approach document (DAD) Submitted Date
+   */
+  designApproachDocumentSubmittedDate?: string | null;
+  /**
+   * Mature outline control documents
+   */
+  matureOutlineControlDocument?: 'submitted_by_applicant' | 'awaiting_submission' | 'not_applicable' | null;
+  /**
+   * Mature outline control documents Submitted Date
+   */
+  matureOutlineControlDocumentSubmittedDate?: string | null;
+  /**
+   * CA and TP evidence
+   */
+  caAndTpEvidence?: 'submitted_by_applicant' | 'awaiting_submission' | 'not_applicable' | null;
+  /**
+   * CA and TP evidence Submitted Date
+   */
+  caAndTpEvidenceSubmittedDate?: string | null;
+  /**
+   * Public sector equality duty (PSED)
+   */
+  publicSectorEqualityDuty?: 'submitted_by_applicant' | 'awaiting_submission' | 'not_applicable' | null;
+  /**
+   * Public sector equality duty (PSED) Submitted Date
+   */
+  publicSectorEqualityDutySubmittedDate?: string | null;
+  /**
+   * Fast track admission document
+   */
+  fastTrackAdmissionDocument?: 'submitted_by_applicant' | 'awaiting_submission' | 'not_applicable' | null;
+  /**
+   * Fast track admission document Submitted Date
+   */
+  fastTrackAdmissionDocumentSubmittedDate?: string | null;
+  /**
+   * Multiparty application readiness gate-check (trial)
+   */
+  multipartyApplicationCheckDocument?: 'submitted_by_applicant' | 'awaiting_submission' | 'not_applicable' | null;
+  /**
+   * Multiparty application readiness gate-check Submitted Date (trial)
+   */
+  multipartyApplicationCheckDocumentSubmittedDate?: string | null;
+  /**
+   * Link to programme document
+   */
+  programmeDocumentURI?: string | null;
+  /**
+   * Date updated programme document is received
+   */
+  updatedProgrammeDocumentReceivedDate?: string | null;
+  /**
+   * Date programme document reviewed by EST
+   */
+  programmeDocumentReviewedByEstDate?: string | null;
+  /**
+   * Date case team issued comments on programme document
+   */
+  caseTeamIssuedCommentsDate?: string | null;
+  /**
+   * Project type
+   */
+  subProjectType?:
+    | 'energy_from_waste'
+    | 'gas_power_station'
+    | 'hydrogen_power_station'
+    | 'nuclear'
+    | 'offshore_wind'
+    | 'onshore_wind'
+    | 'solar'
+    | null;
+  /**
+   * New maturity
+   */
+  newMaturity?: 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | null;
+  /**
+   * Statutory consultation period end date
+   */
+  statutoryConsultationPeriodEndDate?: string | null;
+  /**
+   * Date for submission of draft documents
+   */
+  submissionOfDraftDocumentsDate?: string | null;
+  /**
+   * Number of band 2 inspectors
+   */
+  numberBand2Inspectors?: number | null;
+  /**
+   * Number of band 3 inspectors
+   */
+  numberBand3Inspectors?: number | null;
+  /**
+   * MEM (last updated)
+   */
+  memLastUpdated?: string | null;
+  /**
+   * Additional comments
+   */
+  additionalComments?: string | null;
+  /**
+   * Maps to [Employee].[EmployeeID].
+   */
+  operationsLeadIds?: string[];
+  /**
+   * New NSIP role, Maps to [Employee].[EmployeeID]
+   */
+  operationsManagerIds?: string[];
+  /**
+   * Maps to [Employee].[EmployeeID].
+   */
+  caseManagerIds?: string[];
+  /**
+   * Maps to [Employee].[EmployeeID].
+   */
+  leadInspectorIds?: string[];
+  /**
+   * Maps to [Employee].[EmployeeID].
+   */
+  environmentalServicesOfficerIds?: string[];
+  /**
+   * Maps to [Employee].[EmployeeID].
+   */
+  legalOfficerIds?: string[];
+  /**
+   * Collection of meetings associated with this project
+   */
+  meetings?: Meeting[];
+  /**
+   * Collection of invoices associated with this project
+   */
+  invoices?: Invoice[];
+  [k: string]: unknown;
+}
+/**
+ * A meeting related to the project
+ */
+export interface Meeting {
+  /**
+   * Meeting agenda
+   */
+  meetingAgenda?: string | null;
+  /**
+   * Planning Inspectorate role
+   */
+  planningInspectorateRole?: 'facilitator' | 'advisor' | 'observer' | null;
+  /**
+   * Meeting date
+   */
+  meetingDate?: string | null;
+  /**
+   * Type of Meeting
+   */
+  meetingType?: string | null;
+  [k: string]: unknown;
+}
+/**
+ * An invoice related to the project
+ */
+export interface Invoice {
+  /**
+   * Invoice stage
+   */
+  invoiceStage?:
+    | 'pre_acceptance'
+    | 'acceptance'
+    | 'pre_examination'
+    | 'initial_examination'
+    | 'final_examination'
+    | null;
+  /**
+   * Invoice number
+   */
+  invoiceNumber: string;
+  /**
+   * Amount due
+   */
+  amountDue: number;
+  /**
+   * Payment due date
+   */
+  paymentDueDate?: string | null;
+  /**
+   * Invoiced date
+   */
+  invoicedDate?: string | null;
+  /**
+   * Date of payment
+   */
+  paymentDate?: string | null;
+  /**
+   * Refund credit note number
+   */
+  refundCreditNoteNumber?: string | null;
+  /**
+   * Amount refunded
+   */
+  refundAmount?: number | null;
+  /**
+   * Refund issue date
+   */
+  refundIssueDate?: string | null;
   [k: string]: unknown;
 }
 
@@ -3597,6 +3884,64 @@ export interface Address {
   country?: string;
 }
 
+/**
+ * Schema defining any cas advert specific properties for LPAQ submissions
+ */
+export type LPAQCasAdvertSubmissionProperties = {
+  /**
+   * Indicates that a scheduled monument is affected
+   */
+  affectsScheduledMonument?: boolean | null;
+  /**
+   * Indicates the existence of protected species
+   */
+  hasProtectedSpecies?: boolean | null;
+  /**
+   * Indicates an area of outstanding beauty (National Landscape)
+   */
+  isAonbNationalLandscape?: boolean | null;
+  /**
+   * The designated site names
+   */
+  designatedSitesNames?: string[] | null;
+  /**
+   * Indicates statutory consultees
+   */
+  hasStatutoryConsultees?: boolean | null;
+  /**
+   * The details of the bodies consulted
+   */
+  consultedBodiesDetails?: string | null;
+  /**
+   * Indicates emerging plans
+   */
+  hasEmergingPlan?: boolean | null;
+  /**
+   * The procedure preference indicated by the LPA
+   */
+  lpaProcedurePreference?: 'written' | 'hearing' | 'inquiry' | null;
+  /**
+   * The procedure details preference indicated by the LPA
+   */
+  lpaProcedurePreferenceDetails?: string | null;
+  /**
+   * The duration of enquiry indicated by the LPA
+   */
+  lpaProcedurePreferenceDuration?: number | null;
+  /**
+   * Indicates if the site is in an area of special control for adverts
+   */
+  isSiteInAreaOfSpecialControlAdverts?: boolean | null;
+  /**
+   * Indicates if the application was refused because of highway or traffic public safety?
+   */
+  wasApplicationRefusedDueToHighwayOrTraffic?: boolean | null;
+  /**
+   * Indicates if the appellant submitted complete and accurate photographs and plans
+   */
+  didAppellantSubmitCompletePhotosAndPlans?: boolean | null;
+};
+
 /**
  * Schema defining any properties common across all appeal types for LPAQ submissions
  */
@@ -4010,6 +4355,63 @@ export type LPAQS78SubmissionProperties = {
    */
   lpaProcedurePreferenceDuration?: number | null;
 };
+/**
+ * Schema defining any cas advert specific properties for LPAQ submissions
+ */
+export type LPAQCasAdvertSubmissionProperties = {
+  /**
+   * Indicates that a scheduled monument is affected
+   */
+  affectsScheduledMonument?: boolean | null;
+  /**
+   * Indicates the existence of protected species
+   */
+  hasProtectedSpecies?: boolean | null;
+  /**
+   * Indicates an area of outstanding beauty (National Landscape)
+   */
+  isAonbNationalLandscape?: boolean | null;
+  /**
+   * The designated site names
+   */
+  designatedSitesNames?: string[] | null;
+  /**
+   * Indicates statutory consultees
+   */
+  hasStatutoryConsultees?: boolean | null;
+  /**
+   * The details of the bodies consulted
+   */
+  consultedBodiesDetails?: string | null;
+  /**
+   * Indicates emerging plans
+   */
+  hasEmergingPlan?: boolean | null;
+  /**
+   * The procedure preference indicated by the LPA
+   */
+  lpaProcedurePreference?: 'written' | 'hearing' | 'inquiry' | null;
+  /**
+   * The procedure details preference indicated by the LPA
+   */
+  lpaProcedurePreferenceDetails?: string | null;
+  /**
+   * The duration of enquiry indicated by the LPA
+   */
+  lpaProcedurePreferenceDuration?: number | null;
+  /**
+   * Indicates if the site is in an area of special control for adverts
+   */
+  isSiteInAreaOfSpecialControlAdverts?: boolean | null;
+  /**
+   * Indicates if the application was refused because of highway or traffic public safety?
+   */
+  wasApplicationRefusedDueToHighwayOrTraffic?: boolean | null;
+  /**
+   * Indicates if the appellant submitted complete and accurate photographs and plans
+   */
+  didAppellantSubmitCompletePhotosAndPlans?: boolean | null;
+};
 
 /**
  * Schema defining the data produced by the Front-Office when an LPA Questionnaire is submitted
@@ -4027,7 +4429,9 @@ export interface LPAQuestionnaireCommand {
         LPAQS78SubmissionProperties)
     | ({
         caseType?: 'H' | 'ZA';
-      } & LPAQCommonSubmissionProperties);
+      } & LPAQCommonSubmissionProperties &
+        LPAQHASSubmissionProperties &
+        LPAQCasAdvertSubmissionProperties);
   documents: {
     /**
      * The unique identifier for the document

package/tests/appeals/commands/adverts-questionnaire.test.js

@@ -49,12 +49,25 @@ const exampleAdvertQuestionnaireSchema = {
 			'ullamco quis',
 			'voluptate quis'
 		],
-		lpaCostsAppliedFor: null
+		lpaCostsAppliedFor: null,
+		affectsScheduledMonument: null,
+		hasProtectedSpecies: null,
+		isAonbNationalLandscape: null,
+		designatedSitesNames: null,
+		hasStatutoryConsultees: null,
+		consultedBodiesDetails: null,
+		hasEmergingPlan: null,
+		lpaProcedurePreference: null,
+		lpaProcedurePreferenceDetails: null,
+		lpaProcedurePreferenceDuration: null,
+		isSiteInAreaOfSpecialControlAdverts: null,
+		wasApplicationRefusedDueToHighwayOrTraffic: null,
+		didAppellantSubmitCompletePhotosAndPlans: null
 	},
 	documents: [document]
 };
 
-describe('HAS questionnaire command schema', () => {
+describe('Adverts questionnaire command schema', () => {
 	const schemas = loadAllSchemasSync();
 	const flatSchemas = Object.values(schemas).reduce((a, c) => ({ ...a, ...c }), {});
 	const ajv = new Ajv({ schemas: flatSchemas, allErrors: true });
@@ -65,13 +78,6 @@ describe('HAS questionnaire command schema', () => {
 		assert.strictEqual(validationResult, true);
 	});
 
-	it('should allow valid schema for CAS Advert', () => {
-		const test = structuredClone(exampleAdvertQuestionnaireSchema);
-		test.casedata.caseType = 'ZA';
-		const validationResult = ajv.validate(schema, test);
-		assert.strictEqual(validationResult, true);
-	});
-
 	it('should reject missing caseReference', () => {
 		const test = structuredClone(exampleAdvertQuestionnaireSchema);
 		delete test.casedata.caseReference;

package/tests/appeals/commands/cas-adverts-questionnaire.test.js

@@ -0,0 +1,98 @@
+import { describe, it } from 'node:test';
+import assert from 'node:assert';
+import Ajv from 'ajv';
+import addFormats from 'ajv-formats';
+import { loadAllSchemasSync } from '../../../src/index.js';
+
+const schema = 'lpa-questionnaire.schema.json';
+
+const document = {
+	documentId: 'deserunt sint aliqua adipisicing dolore',
+	filename: 'ut dolore',
+	originalFilename: 'Lorem amet fugiat adipisicing Excepteur',
+	size: -90476934,
+	mime: 'magna labore exercitation ut',
+	documentURI: 'ut reprehenderit',
+	dateCreated: '1933-04-03T03:24:38.0Z',
+	documentType: 'plansDrawings'
+};
+
+const exampleCasAdvertQuestionnaireSchema = {
+	casedata: {
+		caseType: 'ZA',
+		caseReference: 'nisi incididunt cillum',
+		lpaQuestionnaireSubmittedDate: null,
+		lpaStatement: 'consequat ex',
+		siteAccessDetails: null,
+		siteSafetyDetails: null,
+		isCorrectAppealType: null,
+		isGreenBelt: null,
+		inConservationArea: null,
+		newConditionDetails: 'anim sint ut aute',
+		notificationMethod: null,
+		nearbyCaseReferences: null,
+		neighbouringSiteAddresses: [
+			{
+				neighbouringSiteAddressLine1: 'commodo dolore incididunt',
+				neighbouringSiteAddressLine2: 'est voluptate irure aliqua elit',
+				neighbouringSiteAddressTown: 'labore aliquip ex incididunt nulla',
+				neighbouringSiteAddressCounty: 'enim ut Duis ut ex',
+				neighbouringSiteAddressPostcode: 'pariatur',
+				neighbouringSiteAccessDetails: 'aliqua irure mollit consequat nisi',
+				neighbouringSiteSafetyDetails: null
+			}
+		],
+		affectedListedBuildingNumbers: [
+			'occaecat id aliquip dolore',
+			'magna',
+			'minim laboris fugiat id aliqua',
+			'ullamco quis',
+			'voluptate quis'
+		],
+		lpaCostsAppliedFor: null,
+		affectsScheduledMonument: null,
+		hasProtectedSpecies: null,
+		isAonbNationalLandscape: null,
+		designatedSitesNames: null,
+		hasStatutoryConsultees: null,
+		consultedBodiesDetails: null,
+		hasEmergingPlan: null,
+		lpaProcedurePreference: null,
+		lpaProcedurePreferenceDetails: null,
+		lpaProcedurePreferenceDuration: null,
+		isSiteInAreaOfSpecialControlAdverts: null,
+		wasApplicationRefusedDueToHighwayOrTraffic: null,
+		didAppellantSubmitCompletePhotosAndPlans: null
+	},
+	documents: [document]
+};
+
+describe('CAS Advert questionnaire command schema', () => {
+	const schemas = loadAllSchemasSync();
+	const flatSchemas = Object.values(schemas).reduce((a, c) => ({ ...a, ...c }), {});
+	const ajv = new Ajv({ schemas: flatSchemas, allErrors: true });
+	addFormats(ajv);
+
+	it('should allow valid schema for CAS Advert', () => {
+		const validationResult = ajv.validate(schema, exampleCasAdvertQuestionnaireSchema);
+		assert.strictEqual(validationResult, true);
+	});
+
+	it('should reject missing caseReference', () => {
+		const test = structuredClone(exampleCasAdvertQuestionnaireSchema);
+		delete test.casedata.caseReference;
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, false);
+		assert.strictEqual(
+			ajv.errors.some((x) => x.message === "must have required property 'caseReference'"),
+			true
+		);
+	});
+
+	it('should allow additional props', () => {
+		const test = structuredClone(exampleCasAdvertQuestionnaireSchema);
+		test.test = 1;
+		const validationResult = ajv.validate(schema, test);
+		assert.strictEqual(validationResult, true);
+	});
+});