@planning-inspectorate/data-model 2.40.0 → 2.42.0

package/.env.example

@@ -0,0 +1,6 @@
+LOAD_TEST_SIMULATE_SENDING=true
+LOAD_TEST_SERVICE_BUS_NAMESPACE=###.servicebus.windows.net
+APPEALS_LOAD_TEST_CASE_TYPE=S78
+APPEALS_LOAD_TEST_CASE_COUNT=1
+APPEALS_LOAD_TEST_DOCUMENTS_PER_CASE=2
+APPEALS_LOAD_TEST_BATCH_SIZE=50

package/docs/nsip-invoice.md

@@ -7,16 +7,16 @@
 | Property                                          | Type      | Required | Nullable       | Defined by                                                                                                                      |
 | :------------------------------------------------ | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------ |
 | [caseId](#caseid)                                 | `integer` | Required | cannot be null | [NSIP Invoice](nsip-invoice-properties-caseid.md "nsip-invoice.schema.json#/properties/caseId")                                 |
-| [caseReference](#casereference)                   | `string`  | Required | can be null    | [NSIP Invoice](nsip-invoice-properties-casereference.md "nsip-invoice.schema.json#/properties/caseReference")                   |
-| [invoiceStage](#invoicestage)                     | `string`  | Required | can be null    | [NSIP Invoice](nsip-invoice-properties-invoicestage.md "nsip-invoice.schema.json#/properties/invoiceStage")                     |
+| [caseReference](#casereference)                   | `string`  | Optional | can be null    | [NSIP Invoice](nsip-invoice-properties-casereference.md "nsip-invoice.schema.json#/properties/caseReference")                   |
+| [invoiceStage](#invoicestage)                     | `string`  | Required | cannot be null | [NSIP Invoice](nsip-invoice-properties-invoicestage.md "nsip-invoice.schema.json#/properties/invoiceStage")                     |
 | [invoiceNumber](#invoicenumber)                   | `string`  | Required | cannot be null | [NSIP Invoice](nsip-invoice-properties-invoicenumber.md "nsip-invoice.schema.json#/properties/invoiceNumber")                   |
-| [amountDue](#amountdue)                           | `number`  | Required | cannot be null | [NSIP Invoice](nsip-invoice-properties-amountdue.md "nsip-invoice.schema.json#/properties/amountDue")                           |
-| [paymentDueDate](#paymentduedate)                 | `string`  | Required | can be null    | [NSIP Invoice](nsip-invoice-properties-paymentduedate.md "nsip-invoice.schema.json#/properties/paymentDueDate")                 |
-| [invoicedDate](#invoiceddate)                     | `string`  | Required | can be null    | [NSIP Invoice](nsip-invoice-properties-invoiceddate.md "nsip-invoice.schema.json#/properties/invoicedDate")                     |
-| [paymentDate](#paymentdate)                       | `string`  | Required | can be null    | [NSIP Invoice](nsip-invoice-properties-paymentdate.md "nsip-invoice.schema.json#/properties/paymentDate")                       |
-| [refundCreditNoteNumber](#refundcreditnotenumber) | `string`  | Required | can be null    | [NSIP Invoice](nsip-invoice-properties-refundcreditnotenumber.md "nsip-invoice.schema.json#/properties/refundCreditNoteNumber") |
-| [refundAmount](#refundamount)                     | `number`  | Required | can be null    | [NSIP Invoice](nsip-invoice-properties-refundamount.md "nsip-invoice.schema.json#/properties/refundAmount")                     |
-| [refundIssueDate](#refundissuedate)               | `string`  | Required | can be null    | [NSIP Invoice](nsip-invoice-properties-refundissuedate.md "nsip-invoice.schema.json#/properties/refundIssueDate")               |
+| [amountDue](#amountdue)                           | `number`  | Optional | can be null    | [NSIP Invoice](nsip-invoice-properties-amountdue.md "nsip-invoice.schema.json#/properties/amountDue")                           |
+| [paymentDueDate](#paymentduedate)                 | `string`  | Optional | can be null    | [NSIP Invoice](nsip-invoice-properties-paymentduedate.md "nsip-invoice.schema.json#/properties/paymentDueDate")                 |
+| [invoicedDate](#invoiceddate)                     | `string`  | Optional | can be null    | [NSIP Invoice](nsip-invoice-properties-invoiceddate.md "nsip-invoice.schema.json#/properties/invoicedDate")                     |
+| [paymentDate](#paymentdate)                       | `string`  | Optional | can be null    | [NSIP Invoice](nsip-invoice-properties-paymentdate.md "nsip-invoice.schema.json#/properties/paymentDate")                       |
+| [refundCreditNoteNumber](#refundcreditnotenumber) | `string`  | Optional | can be null    | [NSIP Invoice](nsip-invoice-properties-refundcreditnotenumber.md "nsip-invoice.schema.json#/properties/refundCreditNoteNumber") |
+| [refundAmount](#refundamount)                     | `number`  | Optional | can be null    | [NSIP Invoice](nsip-invoice-properties-refundamount.md "nsip-invoice.schema.json#/properties/refundAmount")                     |
+| [refundIssueDate](#refundissuedate)               | `string`  | Optional | can be null    | [NSIP Invoice](nsip-invoice-properties-refundissuedate.md "nsip-invoice.schema.json#/properties/refundIssueDate")               |
 | Additional Properties                             | Any       | Optional | can be null    |                                                                                                                                 |
 
 ## caseId
@@ -49,7 +49,7 @@ The unique identifier within the Back Office. This is not the same as the case r
 
 `caseReference`
 
-* is required
+* is optional
 
 * Type: `string`
 
@@ -77,7 +77,7 @@ Invoice stage
 
 * Type: `string`
 
-* can be null
+* cannot be null
 
 * defined in: [NSIP Invoice](nsip-invoice-properties-invoicestage.md "nsip-invoice.schema.json#/properties/invoiceStage")
 
@@ -96,7 +96,6 @@ Invoice stage
 | `"pre_examination"`     |             |
 | `"initial_examination"` |             |
 | `"final_examination"`   |             |
-| `null`                  |             |
 
 ### invoiceStage Examples
 
@@ -134,11 +133,11 @@ Amount due
 
 `amountDue`
 
-* is required
+* is optional
 
 * Type: `number`
 
-* cannot be null
+* can be null
 
 * defined in: [NSIP Invoice](nsip-invoice-properties-amountdue.md "nsip-invoice.schema.json#/properties/amountDue")
 
@@ -158,7 +157,7 @@ Payment due date
 
 `paymentDueDate`
 
-* is required
+* is optional
 
 * Type: `string`
 
@@ -186,7 +185,7 @@ Invoiced date
 
 `invoicedDate`
 
-* is required
+* is optional
 
 * Type: `string`
 
@@ -214,7 +213,7 @@ Date of payment
 
 `paymentDate`
 
-* is required
+* is optional
 
 * Type: `string`
 
@@ -242,7 +241,7 @@ Refund credit note number
 
 `refundCreditNoteNumber`
 
-* is required
+* is optional
 
 * Type: `string`
 
@@ -266,7 +265,7 @@ Amount refunded
 
 `refundAmount`
 
-* is required
+* is optional
 
 * Type: `number`
 
@@ -290,7 +289,7 @@ Refund issue date
 
 `refundIssueDate`
 
-* is required
+* is optional
 
 * Type: `string`
 

package/load-test/appeals/README.md

@@ -0,0 +1,35 @@
+# Appeals Load Test Script
+
+This script is designed to allow load testing of service bus message consumers without the capacity of the sender being a limiting factor. The service bus client/strategy is hopefully resuable for other services in future
+
+`load-test-appeals` sends a specified quantity of appeal case messages with service users and documents to service bus
+
+This was written as a quick solution to provide ODW with the ability to run a load test without having to generate actual appeals within the Appeals Service, as generating them Appeals side proved too slow
+
+## Requirements
+
+- node
+- Azure VPN
+- Azure CLI interface
+- Your user has the ability to send messages manually on the given service bus topic
+- Unsure if this can be run in WSL currently as az login seems to fail
+
+## Setup
+
+`npm ci`
+
+Create an .env file in the route of the project based on the example
+
+- LOAD_TEST_SIMULATE_SENDING: (true|false) logs to console if true rather than sending, usful for checking data before sending
+- LOAD_TEST_SERVICE_BUS_NAMESPACE: the fully qualified namespace of the service bus instance
+- APPEALS_LOAD_TEST_CASE_TYPE: (HAS|S78) the case type topic to send on
+- APPEALS_LOAD_TEST_CASE_COUNT: how many appeals to generate
+- APPEALS_LOAD_TEST_DOCUMENTS_PER_CASE: how many documents to generate for each case
+- APPEALS_LOAD_TEST_BATCH_SIZE: how many appeals are sent to service bus in one go, used to improve the speed in which messages can be sent to service bus
+
+## Run
+
+- set the env vars as needed, retrieve the correct Service Bus namespace from Azure
+- connect to Azure VPN
+- `az login` - login as yourself and connect to test env subscription
+- `npm run load-test-appeals`

package/load-test/appeals/generate-appeals-messages.js

@@ -0,0 +1,456 @@
+import crypto from 'node:crypto';
+import Ajv from 'ajv';
+import addFormats from 'ajv-formats';
+import { loadAllSchemasSync } from '../../src/index.js';
+
+const HAS_SCHEMA = 'appeal-has.schema.json';
+const S78_SCHEMA = 'appeal-s78.schema.json';
+const DOCUMENT_SCHEMA = 'appeal-document.schema.json';
+const SERVICE_USER_SCHEMA = 'service-user.schema.json';
+
+const now = new Date().toISOString();
+
+const BASE_HAS_CASE = {
+	caseId: null,
+	caseReference: 'mollit dolore dolor non culpa',
+	submissionId: null,
+	caseStatus: 'ready_to_start',
+	caseType: 'ZP',
+	caseProcedure: 'inquiry',
+	lpaCode: 'nulla',
+	caseOfficerId: null,
+	inspectorId: 'mollit in ullamco Excepteur commodo',
+	allocationLevel: 'D',
+	allocationBand: 1,
+	caseSpecialisms: ['et culpa elit labore', 'minim Lorem'],
+	caseSubmittedDate: now,
+	caseCreatedDate: now,
+	caseUpdatedDate: now,
+	caseValidDate: now,
+	caseValidationDate: null,
+	caseValidationOutcome: 'invalid',
+	caseValidationInvalidDetails: null,
+	caseValidationIncompleteDetails: [
+		'occaecat dolor labore ut ipsum',
+		'eiusmod ullamco pariatur aliqua esse',
+		'eiusmod Ut officia',
+		'aute',
+		'do minim sint labore aliquip'
+	],
+	caseExtensionDate: null,
+	caseStartedDate: null,
+	casePublishedDate: null,
+	linkedCaseStatus: null,
+	leadCaseReference: null,
+	lpaQuestionnaireDueDate: null,
+	lpaQuestionnaireSubmittedDate: null,
+	lpaQuestionnaireCreatedDate: now,
+	lpaQuestionnairePublishedDate: now,
+	lpaQuestionnaireValidationOutcome: 'incomplete',
+	lpaQuestionnaireValidationOutcomeDate: now,
+	lpaQuestionnaireValidationDetails: ['dolore cillum in anim adipisicing'],
+	lpaStatement: 'Ut ipsum et',
+	caseWithdrawnDate: null,
+	caseTransferredDate: null,
+	transferredCaseClosedDate: null,
+	caseDecisionOutcomeDate: null,
+	caseDecisionPublishedDate: null,
+	caseDecisionOutcome: null,
+	caseCompletedDate: null,
+	enforcementNotice: null,
+	applicationReference: 'eu',
+	applicationDate: now,
+	applicationDecision: 'refused',
+	applicationDecisionDate: now,
+	applicationDecisionDueDate: null,
+	caseSubmissionDueDate: now,
+	siteAddressLine1: 'ullamco',
+	siteAddressLine2: null,
+	siteAddressTown: 'dolor reprehenderit ut',
+	siteAddressCounty: 'dolore eu exercitation enim',
+	siteAddressPostcode: 'est',
+	siteAccessDetails: [
+		'Ut',
+		'eiusmod magna aliqua ipsum',
+		'sit non ut amet aliqua',
+		'id consectetur cupidatat',
+		'incididunt ut Lorem eu'
+	],
+	siteSafetyDetails: null,
+	siteAreaSquareMetres: 123,
+	floorSpaceSquareMetres: null,
+	isCorrectAppealType: null,
+	isGreenBelt: true,
+	inConservationArea: null,
+	affectsScheduledMonument: true,
+	hasProtectedSpecies: true,
+	isAonbNationalLandscape: null,
+	designatedSitesNames: null,
+	hasInfrastructureLevy: false,
+	isInfrastructureLevyFormallyAdopted: false,
+	infrastructureLevyAdoptedDate: null,
+	infrastructureLevyExpectedDate: null,
+	lpaProcedurePreference: null,
+	lpaProcedurePreferenceDetails: null,
+	lpaProcedurePreferenceDuration: 1,
+	caseworkReason: 'elit reprehenderit',
+	importantInformation: null,
+	jurisdiction: null,
+	redeterminedIndicator: null,
+	dateCostsReportDespatched: null,
+	dateNotRecoveredOrDerecovered: null,
+	dateRecovered: null,
+	originalCaseDecisionDate: null,
+	targetDate: null,
+	ownsAllLand: true,
+	ownsSomeLand: null,
+	knowsOtherOwners: 'Some',
+	knowsAllOwners: null,
+	advertisedAppeal: null,
+	notificationMethod: null,
+	ownersInformed: null,
+	originalDevelopmentDescription: null,
+	changedDevelopmentDescription: null,
+	newConditionDetails: 'tempor anim adipisicing',
+	nearbyCaseReferences: null,
+	neighbouringSiteAddresses: [
+		{
+			neighbouringSiteAddressLine1: 'eu veniam',
+			neighbouringSiteAddressLine2: null,
+			neighbouringSiteAddressTown: 'pariatur dolore',
+			neighbouringSiteAddressCounty: 'fugiat minim anim aliqua aliquip',
+			neighbouringSiteAddressPostcode: 'ex anim',
+			neighbouringSiteAccessDetails: null,
+			neighbouringSiteSafetyDetails: 'veniam in sunt'
+		}
+	],
+	reasonForNeighbourVisits: null,
+	affectedListedBuildingNumbers: ['Excepteur', 'in consequat sit', 'esse sunt velit culpa', 'voluptate esse'],
+	appellantCostsAppliedFor: null,
+	lpaCostsAppliedFor: null,
+	typeOfPlanningApplication: 'householder-planning',
+	siteGridReferenceEasting: '357144',
+	siteGridReferenceNorthing: '400534',
+	hasLandownersPermission: null,
+	isSiteInAreaOfSpecialControlAdverts: false,
+	wasApplicationRefusedDueToHighwayOrTraffic: null,
+	didAppellantSubmitCompletePhotosAndPlans: null,
+	advertDetails: [
+		{
+			isAdvertInPosition: false,
+			isSiteOnHighwayLand: false,
+			advertType: 'Other'
+		}
+	],
+	padsSapId: null
+};
+
+const BASE_S78_CASE = {
+	caseId: 96989394,
+	caseReference: 'exercitation dolore',
+	submissionId: null,
+	caseStatus: 'transferred',
+	caseType: 'D',
+	caseProcedure: 'inquiry',
+	lpaCode: 'pariatur cillum non',
+	caseOfficerId: null,
+	inspectorId: 'amet magna dolor in labore',
+	allocationLevel: null,
+	allocationBand: null,
+	caseSpecialisms: ['laboris est proident minim', 'qui sunt ut', 'consectetur Lorem do sunt aliquip'],
+	caseSubmittedDate: now,
+	caseCreatedDate: now,
+	caseUpdatedDate: now,
+	caseValidDate: null,
+	caseValidationDate: null,
+	caseValidationOutcome: null,
+	caseValidationInvalidDetails: null,
+	caseValidationIncompleteDetails: null,
+	caseExtensionDate: null,
+	caseStartedDate: now,
+	casePublishedDate: null,
+	linkedCaseStatus: 'lead',
+	leadCaseReference: null,
+	lpaQuestionnaireDueDate: null,
+	lpaQuestionnaireSubmittedDate: null,
+	lpaQuestionnaireCreatedDate: null,
+	lpaQuestionnairePublishedDate: null,
+	lpaQuestionnaireValidationOutcome: null,
+	lpaQuestionnaireValidationOutcomeDate: null,
+	lpaQuestionnaireValidationDetails: ['cupidatat dolore in', 'officia in nostrud non', 'eu amet velit labore aute'],
+	lpaStatement: 'ipsum consectetur labore pariatur',
+	listOfDocumentsBeforeDecision: null,
+	caseWithdrawnDate: null,
+	caseTransferredDate: null,
+	transferredCaseClosedDate: null,
+	caseDecisionOutcomeDate: null,
+	caseDecisionPublishedDate: null,
+	caseDecisionOutcome: null,
+	caseCompletedDate: null,
+	enforcementNotice: null,
+	applicationReference: 'consequat ullamco in aute amet',
+	applicationDate: now,
+	applicationDecision: 'not_received',
+	applicationDecisionDate: null,
+	applicationDecisionDueDate: now,
+	caseSubmissionDueDate: null,
+	siteAddressLine1: 'dolore mollit',
+	siteAddressLine2: null,
+	siteAddressTown: 'in',
+	siteAddressCounty: 'ut incididunt velit in',
+	siteAddressPostcode: 'ut',
+	siteAccessDetails: ['ullamco', 'elit in', 'velit officia pariatur mollit', 'nostrud ex culpa'],
+	siteSafetyDetails: null,
+	siteAreaSquareMetres: 69381079.34849802,
+	floorSpaceSquareMetres: null,
+	isCorrectAppealType: null,
+	isGreenBelt: false,
+	inConservationArea: null,
+	ownsAllLand: null,
+	ownsSomeLand: null,
+	knowsOtherOwners: null,
+	knowsAllOwners: null,
+	advertisedAppeal: true,
+	notificationMethod: ['notice'],
+	ownersInformed: null,
+	originalDevelopmentDescription: 'est',
+	changedDevelopmentDescription: null,
+	newConditionDetails: null,
+	nearbyCaseReferences: ['veniam voluptate incididunt Excepteur'],
+	neighbouringSiteAddresses: [
+		{
+			neighbouringSiteAddressLine1: 'laborum',
+			neighbouringSiteAddressLine2: null,
+			neighbouringSiteAddressTown: 'aute ipsum dolore',
+			neighbouringSiteAddressCounty: null,
+			neighbouringSiteAddressPostcode: 'dolor ipsum anim fugiat',
+			neighbouringSiteAccessDetails: 'reprehenderit mollit Duis exercitation',
+			neighbouringSiteSafetyDetails: null
+		}
+	],
+	reasonForNeighbourVisits: null,
+	affectedListedBuildingNumbers: ['tempor adipisicing in'],
+	changedListedBuildingNumbers: null,
+	preserveGrantLoan: true,
+	consultHistoricEngland: false,
+	appellantCostsAppliedFor: null,
+	lpaCostsAppliedFor: null,
+	agriculturalHolding: null,
+	tenantAgriculturalHolding: null,
+	otherTenantsAgriculturalHolding: null,
+	informedTenantsAgriculturalHolding: true,
+	appellantProcedurePreference: 'hearing',
+	appellantProcedurePreferenceDetails: null,
+	appellantProcedurePreferenceDuration: null,
+	appellantProcedurePreferenceWitnessCount: null,
+	statusPlanningObligation: 'cillum proident fugiat ex quis',
+	affectsScheduledMonument: true,
+	hasProtectedSpecies: true,
+	isAonbNationalLandscape: null,
+	designatedSitesNames: null,
+	isGypsyOrTravellerSite: false,
+	isPublicRightOfWay: true,
+	eiaEnvironmentalImpactSchedule: 'schedule-1',
+	eiaDevelopmentDescription: 'agriculture-aquaculture',
+	eiaSensitiveAreaDetails: 'dolore non anim ut deserunt',
+	eiaColumnTwoThreshold: null,
+	eiaScreeningOpinion: true,
+	eiaRequiresEnvironmentalStatement: null,
+	eiaCompletedEnvironmentalStatement: null,
+	hasStatutoryConsultees: true,
+	consultedBodiesDetails: null,
+	hasInfrastructureLevy: null,
+	isInfrastructureLevyFormallyAdopted: null,
+	infrastructureLevyAdoptedDate: null,
+	infrastructureLevyExpectedDate: null,
+	lpaProcedurePreference: null,
+	lpaProcedurePreferenceDetails: null,
+	lpaProcedurePreferenceDuration: 12,
+	caseworkReason: 'sit ipsum',
+	importantInformation: null,
+	jurisdiction: null,
+	redeterminedIndicator: null,
+	dateCostsReportDespatched: null,
+	dateNotRecoveredOrDerecovered: null,
+	dateRecovered: null,
+	originalCaseDecisionDate: null,
+	targetDate: null,
+	appellantCommentsSubmittedDate: null,
+	appellantStatementSubmittedDate: null,
+	appellantProofsSubmittedDate: null,
+	finalCommentsDueDate: null,
+	interestedPartyRepsDueDate: null,
+	lpaCommentsSubmittedDate: null,
+	lpaProofsSubmittedDate: null,
+	lpaStatementSubmittedDate: null,
+	proofsOfEvidenceDueDate: null,
+	siteNoticesSentDate: null,
+	statementDueDate: null,
+	caseManagementConferenceDate: null,
+	numberOfResidencesNetChange: 59800248.893144846,
+	siteGridReferenceEasting: '357144',
+	siteGridReferenceNorthing: '400534',
+	siteViewableFromRoad: null,
+	siteWithinSSSI: null,
+	typeOfPlanningApplication: 'full-appeal',
+	developmentType: 'other-minor',
+	statementOfCommonGroundDueDate: null,
+	planningObligationDueDate: null,
+	advertDetails: [
+		{
+			isAdvertInPosition: false,
+			isSiteOnHighwayLand: false,
+			advertType: 'Other'
+		}
+	],
+	padsSapId: null,
+	applicationMadeUnderActSection: 'existing-development',
+	siteUseAtTimeOfApplication: 'Site use at time of application',
+	appealUnderActSection: 'proposed-use-of-a-development',
+	lpaConsiderAppealInvalid: true,
+	lpaAppealInvalidReasons: 'Reason(s) why LPA consider the appeal invalid'
+};
+
+function randomCaseReference(prefix, index) {
+	const suffix = String(index + 1).padStart(7, '0');
+	return `${prefix}${suffix}`;
+}
+
+function randomHex(length) {
+	return crypto
+		.randomBytes(Math.ceil(length / 2))
+		.toString('hex')
+		.slice(0, length);
+}
+
+function createCase(caseType, index) {
+	const template = caseType === 'HAS' ? BASE_HAS_CASE : BASE_S78_CASE;
+	const entity = structuredClone(template);
+	const referencePrefix = caseType === 'HAS' ? 'HAS' : 'S78';
+
+	entity.caseId = 500000 + index;
+	entity.caseReference = randomCaseReference(referencePrefix, index);
+	entity.caseCreatedDate = now;
+	entity.caseUpdatedDate = now;
+	entity.caseSubmittedDate = now;
+	entity.applicationReference = `LOAD-${referencePrefix}-${index + 1}`;
+	entity.lpaCode = 'LOAD';
+
+	return entity;
+}
+
+function createServiceUser(casePayload, serviceUserType, index) {
+	const typeName = serviceUserType === 'Agent' ? 'Agent' : 'Appellant';
+	return {
+		id: crypto.randomUUID(),
+		salutation: 'Ms',
+		firstName: `Load-Test`,
+		lastName: `${typeName}${index + 1}`,
+		addressLine1: '1 Test Street',
+		addressLine2: null,
+		addressTown: 'Testville',
+		addressCounty: 'Testshire',
+		postcode: 'TE1 1ST',
+		addressCountry: 'United Kingdom',
+		organisation: 'Load Test Org',
+		organisationType: 'Private Company',
+		role: typeName,
+		telephoneNumber: '+447123456789',
+		otherPhoneNumber: null,
+		faxNumber: null,
+		emailAddress: `${typeName.toLowerCase()}${index + 1}@example.com`,
+		webAddress: 'https://example.com',
+		serviceUserType: typeName,
+		caseReference: casePayload.caseReference,
+		sourceSystem: 'back-office-appeals',
+		sourceSuid: crypto.randomUUID()
+	};
+}
+
+function createDocument(casePayload, caseIndex, documentIndex) {
+	const documentId = crypto.randomUUID();
+	const filename = `LOAD-${casePayload.caseReference}-doc-${documentIndex + 1}.pdf`;
+	const caseType = typeof casePayload.caseType === 'string' ? casePayload.caseType : null;
+	const documentUri = `https://example.local/appeal/${casePayload.caseReference}/${documentId}/v1/${filename}`;
+
+	return {
+		documentId,
+		caseId: casePayload.caseId,
+		caseReference: casePayload.caseReference,
+		version: 1,
+		filename,
+		originalFilename: filename,
+		size: 1000 + documentIndex,
+		mime: 'application/pdf',
+		documentURI: documentUri,
+		publishedDocumentURI: documentUri,
+		virusCheckStatus: 'scanned',
+		fileMD5: randomHex(32),
+		dateCreated: now,
+		dateReceived: now,
+		datePublished: now,
+		lastModified: now,
+		caseType,
+		redactedStatus: 'no_redaction_required',
+		documentType: 'plansDrawings',
+		sourceSystem: 'back-office-appeals',
+		origin: 'pins',
+		owner: 'Load Test Team',
+		author: 'Load Test Team',
+		description: `Load test document ${documentIndex + 1}`,
+		caseStage: 'appellant-case',
+		horizonFolderId: null
+	};
+}
+
+function buildAjvValidator() {
+	const schemas = loadAllSchemasSync();
+	const flatSchemas = Object.values(schemas).reduce((acc, current) => ({ ...acc, ...current }), {});
+	const ajv = new Ajv({ schemas: flatSchemas, allErrors: true });
+	addFormats(ajv);
+	return ajv;
+}
+
+function validateOrThrow(ajv, schemaName, payload, label) {
+	const valid = ajv.validate(schemaName, payload);
+	if (!valid) {
+		const errors = ajv.errorsText(ajv.errors, { separator: '\n' });
+		throw new Error(`${label} failed schema ${schemaName}:\n${errors}`);
+	}
+}
+
+/**
+ * @param {'HAS'|'S78'} [caseType]
+ * @param {number} [documentsPerCase]
+ * @param {number} [caseIndex]
+ * @returns {{case: any, serviceUsers: any[], documents: any[]}}
+ */
+export const generateAppealsLoadTestMessages = (caseType = 'HAS', documentsPerCase = 2, caseIndex = 1) => {
+	const caseSchema = caseType === 'HAS' ? HAS_SCHEMA : S78_SCHEMA;
+	const ajv = buildAjvValidator();
+
+	const casePayload = createCase(caseType, caseIndex);
+	validateOrThrow(ajv, caseSchema, casePayload, `case[${caseIndex}]`);
+
+	const serviceUsers = [
+		createServiceUser(casePayload, 'Agent', caseIndex),
+		createServiceUser(casePayload, 'Appellant', caseIndex)
+	];
+
+	for (const serviceUser of serviceUsers) {
+		validateOrThrow(ajv, SERVICE_USER_SCHEMA, serviceUser, `${caseIndex} serviceUser[${serviceUser.role}]`);
+	}
+
+	const documents = [];
+	for (let docIndex = 0; docIndex < documentsPerCase; docIndex += 1) {
+		const document = createDocument(casePayload, caseIndex, docIndex);
+		validateOrThrow(ajv, DOCUMENT_SCHEMA, document, `document[${caseIndex}][${docIndex}]`);
+		documents.push(document);
+	}
+
+	return {
+		case: casePayload,
+		serviceUsers,
+		documents
+	};
+};

package/load-test/appeals/run-load-script.js

@@ -0,0 +1,58 @@
+import { generateAppealsLoadTestMessages } from './generate-appeals-messages.js';
+import { ServiceBusEventClient } from '../service-bus-client.js';
+import { MESSAGE_EVENT_TYPE } from '../../src/enums.js';
+
+/** @type {'HAS'|'S78'} */ //@ts-ignore
+const caseType = process.env.APPEALS_LOAD_TEST_CASE_TYPE || 'HAS'; // 'HAS' or 'S78'
+const caseCount = parseInt(process.env.APPEALS_LOAD_TEST_CASE_COUNT || '1', 10);
+const documentsPerCase = parseInt(process.env.APPEALS_LOAD_TEST_DOCUMENTS_PER_CASE || '2', 10);
+const batchSize = parseInt(process.env.APPEALS_LOAD_TEST_BATCH_SIZE || '50', 10);
+
+if (batchSize < 1) {
+	throw new Error('Batch size must be at least 1');
+}
+
+const caseTypeTopicMap = {
+	HAS: 'appeal-has',
+	S78: 'appeal-s78'
+};
+
+if (!caseTypeTopicMap[caseType]) {
+	throw new Error(`Unsupported case type: ${caseType}`);
+}
+
+const client = new ServiceBusEventClient();
+
+let casesCreated = 0;
+let documentsCreated = 0;
+let serviceUsersCreated = 0;
+
+try {
+	for (let batchIndex = 0; batchIndex < caseCount; batchIndex += batchSize) {
+		const batch = [];
+		const batchEnd = Math.min(batchIndex + batchSize, caseCount);
+
+		for (let index = batchIndex; index < batchEnd; index += 1) {
+			batch.push(generateAppealsLoadTestMessages(caseType, documentsPerCase, index));
+		}
+
+		const batchCases = batch.map((m) => m.case);
+		const batchServiceUsers = batch.flatMap((m) => m.serviceUsers);
+		const batchDocuments = batch.flatMap((m) => m.documents);
+
+		await Promise.all([
+			client.sendEvents(caseTypeTopicMap[caseType], batchCases, MESSAGE_EVENT_TYPE.CREATE),
+			client.sendEvents('appeal-service-user', batchServiceUsers, MESSAGE_EVENT_TYPE.CREATE),
+			client.sendEvents('appeal-document', batchDocuments, MESSAGE_EVENT_TYPE.CREATE)
+		]);
+
+		casesCreated += batch.length;
+		documentsCreated += batchDocuments.length;
+		serviceUsersCreated += batchServiceUsers.length;
+	}
+} finally {
+	await client.close();
+}
+
+console.log('Finished');
+console.log({ casesCreated, documentsCreated, serviceUsersCreated });

package/load-test/service-bus-client.js

@@ -0,0 +1,89 @@
+import { ServiceBusClient } from '@azure/service-bus';
+import { DefaultAzureCredential } from '@azure/identity';
+
+/**
+ * @typedef {object} ServiceBusEventClientOptions
+ * @property {string | undefined} [connectionString]
+ * @property {import('@azure/core-auth').TokenCredential | undefined} [credential]
+ */
+
+/**
+ * Event client used to broadcast messages to service bus topics.
+ * @class
+ */
+export class ServiceBusEventClient {
+	constructor() {
+		this.client = new ServiceBusClient(process.env.LOAD_TEST_SERVICE_BUS_NAMESPACE, new DefaultAzureCredential());
+		this.simulateSending = process.env.LOAD_TEST_SIMULATE_SENDING === 'true'; // true logs to console, false sends to service bus
+	}
+
+	/**
+	 * @param {string} topic
+	 * @returns Instance of the service bus sender from the service bus client
+	 */
+	#createSender = (topic) => {
+		return this.client.createSender(topic);
+	};
+
+	/**
+	 * Returns unix timestamp representing the trace id
+	 * @returns {number}
+	 */
+	#createTraceId = () => {
+		return Date.now();
+	};
+
+	/**
+	 * @param {object[]} events
+	 * @param {number} traceId
+	 * @param {import('../utils/event-type').EventType} type
+	 * @returns {import('@azure/service-bus').ServiceBusMessage []}
+	 */
+	#transformMessagesToSend = (events, traceId, type) => {
+		return events.map((body) => ({
+			body,
+			contentType: 'application/json',
+			applicationProperties: {
+				version: '0.1',
+				traceId,
+				type
+			}
+		}));
+	};
+
+	/**
+	 * @param {string} topic
+	 * @param {any[]} events
+	 * @param {import('../utils/event-type').EventType} eventType
+	 */
+	sendEvents = async (topic, events, eventType) => {
+		const sender = this.#createSender(topic);
+
+		try {
+			const traceId = this.#createTraceId();
+
+			console.log(`Publishing ${events.length} events to topic ${topic} with trace id ${traceId}`);
+
+			const messages = this.#transformMessagesToSend(events, traceId, eventType);
+
+			if (this.simulateSending) {
+				console.log(`Simulating sending messages: ${JSON.stringify(messages)}`);
+			} else {
+				await sender.sendMessages(messages);
+			}
+
+			return events;
+		} catch (error) {
+			console.error(`Error sending messages to topic ${topic}:`, error);
+			throw error;
+		} finally {
+			if (!sender.isClosed) {
+				await sender.close();
+			}
+		}
+	};
+
+	close = async () => {
+		await this.client.close();
+	};
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planning-inspectorate/data-model",
-  "version": "2.40.0",
+  "version": "2.42.0",
   "description": "JSON Schemas for the Planning Inspectorate's Data Model",
   "main": "src/index.js",
   "type": "module",
@@ -16,6 +16,7 @@
     "gen-types": "node src/lib/gen-types.js",
     "gen-cjs": "npx rollup ./src/index.js --file ./src/index.cjs --format cjs && npx rollup ./src/enums.js --file ./src/enums.cjs --format cjs",
     "lint": "npx eslint .",
+    "load-test-appeals": "node --env-file=.env load-test/appeals/run-load-script.js",
     "format": "prettier --write .",
     "format-check": "prettier --check .",
     "prepare": "node .husky/install.mjs"
@@ -30,6 +31,8 @@
   },
   "devDependencies": {
     "@adobe/jsonschema2md": "^8.0.3",
+    "@azure/identity": "^4.13.0",
+    "@azure/service-bus": "^7.9.1",
     "@commitlint/cli": "^21.0.0",
     "@commitlint/config-conventional": "^21.0.0",
     "@eslint/js": "^10.0.1",

package/pins_data_model/models/model_nsip_invoice.py

@@ -18,7 +18,6 @@ class InvoiceStage(Enum):
     pre_examination = "pre_examination"
     initial_examination = "initial_examination"
     final_examination = "final_examination"
-    NoneType_None = None
 
 
 class NsipInvoice(BaseModel):
@@ -33,7 +32,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"])
+    caseReference: str | None = Field(None, examples=["BC0510001"])
     invoiceStage: InvoiceStage = Field(..., examples=["pre_acceptance"])
     """
     Invoice stage
@@ -42,38 +41,38 @@ class NsipInvoice(BaseModel):
     """
     Invoice number
     """
-    amountDue: float = Field(..., examples=[500])
+    amountDue: float | None = Field(None, examples=[500])
     """
     Amount due
     """
     paymentDueDate: AwareDatetime | None = Field(
-        ..., examples=["2023-07-27T20:30:00.000Z"]
+        None, examples=["2023-07-27T20:30:00.000Z"]
     )
     """
     Payment due date
     """
     invoicedDate: AwareDatetime | None = Field(
-        ..., examples=["2023-07-27T20:30:00.000Z"]
+        None, examples=["2023-07-27T20:30:00.000Z"]
     )
     """
     Invoiced date
     """
     paymentDate: AwareDatetime | None = Field(
-        ..., examples=["2023-07-27T20:30:00.000Z"]
+        None, examples=["2023-07-27T20:30:00.000Z"]
     )
     """
     Date of payment
     """
-    refundCreditNoteNumber: str | None = Field(..., examples=["1800004419"])
+    refundCreditNoteNumber: str | None = Field(None, examples=["1800004419"])
     """
     Refund credit note number
     """
-    refundAmount: float | None = Field(..., examples=[200])
+    refundAmount: float | None = Field(None, examples=[200])
     """
     Amount refunded
     """
     refundIssueDate: AwareDatetime | None = Field(
-        ..., examples=["2023-07-27T20:30:00.000Z"]
+        None, examples=["2023-07-27T20:30:00.000Z"]
     )
     """
     Refund issue date

package/schemas/nsip-invoice.schema.json

@@ -5,19 +5,7 @@
   "description": "NSIP Standalone Invoice Schema for ODW Curated layer",
   "type": "object",
   "additionalProperties": true,
-  "required": [
-    "caseId",
-    "caseReference",
-    "invoiceStage",
-    "invoiceNumber",
-    "amountDue",
-    "paymentDueDate",
-    "invoicedDate",
-    "paymentDate",
-    "refundCreditNoteNumber",
-    "refundAmount",
-    "refundIssueDate"
-  ],
+  "required": ["caseId", "invoiceStage", "invoiceNumber"],
   "properties": {
     "caseId": {
       "type": "integer",
@@ -29,9 +17,9 @@
       "examples": ["BC0510001"]
     },
     "invoiceStage": {
-      "type": ["string", "null"],
+      "type": "string",
       "description": "Invoice stage",
-      "enum": ["pre_acceptance", "acceptance", "pre_examination", "initial_examination", "final_examination", null],
+      "enum": ["pre_acceptance", "acceptance", "pre_examination", "initial_examination", "final_examination"],
       "examples": ["pre_acceptance"]
     },
     "invoiceNumber": {
@@ -40,7 +28,7 @@
       "examples": ["1800004419"]
     },
     "amountDue": {
-      "type": "number",
+      "type": ["number", "null"],
       "description": "Amount due",
       "examples": [500]
     },

package/src/schemas.d.ts

@@ -2411,17 +2411,11 @@ export interface NSIPInvoice {
    * The unique identifier within the Back Office. This is not the same as the case reference
    */
   caseId: number;
-  caseReference: string | null;
+  caseReference?: string | null;
   /**
    * Invoice stage
    */
-  invoiceStage:
-    | 'pre_acceptance'
-    | 'acceptance'
-    | 'pre_examination'
-    | 'initial_examination'
-    | 'final_examination'
-    | null;
+  invoiceStage: 'pre_acceptance' | 'acceptance' | 'pre_examination' | 'initial_examination' | 'final_examination';
   /**
    * Invoice number
    */
@@ -2429,31 +2423,31 @@ export interface NSIPInvoice {
   /**
    * Amount due
    */
-  amountDue: number;
+  amountDue?: number | null;
   /**
    * Payment due date
    */
-  paymentDueDate: string | null;
+  paymentDueDate?: string | null;
   /**
    * Invoiced date
    */
-  invoicedDate: string | null;
+  invoicedDate?: string | null;
   /**
    * Date of payment
    */
-  paymentDate: string | null;
+  paymentDate?: string | null;
   /**
    * Refund credit note number
    */
-  refundCreditNoteNumber: string | null;
+  refundCreditNoteNumber?: string | null;
   /**
    * Amount refunded
    */
-  refundAmount: number | null;
+  refundAmount?: number | null;
   /**
    * Refund issue date
    */
-  refundIssueDate: string | null;
+  refundIssueDate?: string | null;
   [k: string]: unknown;
 }