@planning-inspectorate/data-model 2.50.0 → 2.51.1

package/pins_data_model/models/model_application_update.py

@@ -3,12 +3,12 @@
 
 from __future__ import annotations
 
-from enum import Enum
+from enum import StrEnum
 
 from pydantic import AwareDatetime, BaseModel, ConfigDict, Field
 
 
-class ApplicationUpdateStatus(Enum):
+class ApplicationUpdateStatus(StrEnum):
     """
     Application Update Status. Name displayed to users, e.g. Draft
     """

package/pins_data_model/models/model_applications_application.py

@@ -3,12 +3,12 @@
 
 from __future__ import annotations
 
-from enum import Enum
+from enum import Enum, StrEnum
 
 from pydantic import AwareDatetime, BaseModel, ConfigDict, Field
 
 
-class Type(Enum):
+class Type(StrEnum):
     """
     Type of application. Name displayed to users
     """
@@ -35,7 +35,7 @@ class SubType(Enum):
     Listed_building_consent__LBC_ = "Listed building consent (LBC)"
 
 
-class ApplicationStatus(Enum):
+class ApplicationStatus(StrEnum):
     """
     Current status of the case (enum)
     """
@@ -128,7 +128,7 @@ class Procedure(Enum):
     Inquiry = "Inquiry"
 
 
-class RoleType(Enum):
+class RoleType(StrEnum):
     """
     Agent or Applicant details
     """

package/pins_data_model/models/model_applications_application_update.py

@@ -3,12 +3,12 @@
 
 from __future__ import annotations
 
-from enum import Enum
+from enum import StrEnum
 
 from pydantic import AwareDatetime, BaseModel, ConfigDict, Field
 
 
-class ApplicationUpdateStatus(Enum):
+class ApplicationUpdateStatus(StrEnum):
     """
     Application Update Status. Name displayed to users, e.g. Draft
     """

package/pins_data_model/models/model_applications_notify_email.py

@@ -3,12 +3,12 @@
 
 from __future__ import annotations
 
-from enum import Enum
+from enum import Enum, StrEnum
 
 from pydantic import AwareDatetime, BaseModel, ConfigDict, EmailStr, Field
 
 
-class EmailStatus(Enum):
+class EmailStatus(StrEnum):
     """
     Outcome of the email (status)
     """

package/pins_data_model/models/model_applications_representation.py

@@ -3,19 +3,19 @@
 
 from __future__ import annotations
 
-from enum import Enum
+from enum import Enum, StrEnum
 
 from pydantic import AwareDatetime, BaseModel, ConfigDict, Field
 
 
-class RepresentationStatus(Enum):
+class RepresentationStatus(StrEnum):
     Awaiting_review = "Awaiting review"
     Accepted = "Accepted"
     Rejected = "Rejected"
     Withdrawn = "Withdrawn"
 
 
-class SubmittedFor(Enum):
+class SubmittedFor(StrEnum):
     Myself = "Myself"
     On_behalf_of_another_person_or_an_organisation = (
         "On behalf of another person or an organisation"
@@ -79,7 +79,7 @@ class Contact(BaseModel):
     writtenRepJobTitleorRole: str | None = None
 
 
-class Status(Enum):
+class Status(StrEnum):
     """
     The status of the document
     """

package/pins_data_model/models/model_dart_response.py

@@ -14,7 +14,7 @@ class NeighbouringSiteAddress(BaseModel):
     """
     First line of address of the neighbouring site
     """
-    neighbouringSiteAddressLine2: str | None = None
+    neighbouringSiteAddressLine2: str | None
     """
     Second line of address of the neighbouring site
     """

package/pins_data_model/models/model_folder.py

@@ -44,12 +44,12 @@ class Folder(BaseModel):
     """
     Folder display name in English.
     """
-    displayNameWelsh: str | None = None
+    displayNameWelsh: str | None
     """
     Folder display name in Welsh.
     """
-    parentFolderId: int | None = None
+    parentFolderId: int | None
     """
     Optional parent folder ID.
     """
-    caseStage: CaseStage
+    caseStage: CaseStage | None

package/pins_data_model/models/model_nsip_document.py

@@ -147,24 +147,24 @@ class NsipDocument(BaseModel):
             "EN010011/2. Post-Submission/Application Documents/Application Form/Letter.PDF"
         ],
     )
-    virusCheckStatus: VirusCheckStatus
+    virusCheckStatus: VirusCheckStatus | None
     fileMD5: str | None = Field(..., examples=["b1946ac92492d2347c6235b4d2611184"])
     dateCreated: AwareDatetime = Field(..., examples=["2023-07-27T20:30:00.000Z"])
     lastModified: AwareDatetime | None = Field(
         ..., examples=["2023-07-27T20:30:00.000Z"]
     )
-    caseType: CaseType
-    redactedStatus: RedactedStatus
-    publishedStatus: PublishedStatus
+    caseType: CaseType | None
+    redactedStatus: RedactedStatus | None
+    publishedStatus: PublishedStatus | None
     datePublished: AwareDatetime | None = Field(
         ..., examples=["2023-07-27T20:30:00.000Z"]
     )
     documentType: str | None = Field(..., examples=["Rule 8 letter"])
-    securityClassification: SecurityClassification
-    sourceSystem: SourceSystem
-    origin: Origin
-    owner: str | None = None
-    author: str | None = None
+    securityClassification: SecurityClassification | None
+    sourceSystem: SourceSystem | None
+    origin: Origin | None
+    owner: str | None
+    author: str | None
     """
     Name of person who authored document
     """
@@ -183,7 +183,7 @@ class NsipDocument(BaseModel):
         ],
     )
     descriptionWelsh: str | None = None
-    documentCaseStage: DocumentCaseStage
+    documentCaseStage: DocumentCaseStage | None
     filter1: str | None = Field(..., examples=["Deadline 2"])
     """
     Filter field to provide additional filtering
@@ -196,11 +196,11 @@ class NsipDocument(BaseModel):
     """
     Filter field to provide additional filtering
     """
-    horizonFolderId: str | None = None
+    horizonFolderId: str | None
     """
     The folder where the document exists
     """
-    transcriptId: str | None = None
+    transcriptId: str | None
     """
     The GUID of the transcript document (if one was provided).
     """

package/pins_data_model/models/model_nsip_exam_timetable.py

@@ -3,12 +3,12 @@
 
 from __future__ import annotations
 
-from enum import Enum
+from enum import StrEnum
 
 from pydantic import AwareDatetime, BaseModel, ConfigDict, Field
 
 
-class Type(Enum):
+class Type(StrEnum):
     """
     Compulsory Acquisition Hearing/Deadline/Issue Specific Hearing etc
     """
@@ -25,6 +25,7 @@ class Type(Enum):
     Procedural_Deadline__Pre_Examination_ = "Procedural Deadline (Pre-Examination)"
     Procedural_Decision = "Procedural Decision"
     Publication_Of = "Publication Of"
+    Unaccompanied_Site_Inspection = "Unaccompanied Site Inspection"
 
 
 class LineItem(BaseModel):

package/pins_data_model/models/model_nsip_invoice.py

@@ -3,12 +3,12 @@
 
 from __future__ import annotations
 
-from enum import Enum
+from enum import StrEnum
 
 from pydantic import AwareDatetime, BaseModel, ConfigDict, Field
 
 
-class InvoiceStage(Enum):
+class InvoiceStage(StrEnum):
     """
     Invoice stage
     """

package/pins_data_model/models/model_nsip_project.py

@@ -3,7 +3,7 @@
 
 from __future__ import annotations
 
-from enum import Enum
+from enum import Enum, StrEnum
 from typing import Any
 
 from pydantic import AwareDatetime, BaseModel, ConfigDict, Field
@@ -85,7 +85,7 @@ class ProjectType(Enum):
     NoneType_None = None
 
 
-class SourceSystem(Enum):
+class SourceSystem(StrEnum):
     back_office_applications = "back-office-applications"
     horizon = "horizon"
 
@@ -107,7 +107,7 @@ class Stage(Enum):
     NoneType_None = None
 
 
-class Region(Enum):
+class Region(StrEnum):
     """
     Geographical region of UK. Applications can cover multiple regions.
     """
@@ -340,7 +340,7 @@ class Meeting(BaseModel):
     """
 
 
-class InvoiceStage(Enum):
+class InvoiceStage(StrEnum):
     """
     Invoice stage
     """
@@ -436,21 +436,21 @@ class NsipProject(BaseModel):
         ],
     )
     projectDescriptionWelsh: str | None = None
-    decision: Decision
+    decision: Decision | None
     """
     Decision outcome: approved/refused/split-decision/granted/partially_consented/quashed/redetermination/withdrawn
     """
-    publishStatus: PublishStatus
-    sector: Sector
+    publishStatus: PublishStatus | None
+    sector: Sector | None
     """
     {Sector Abbreviation} - {Sector Display Name}
     """
-    projectType: ProjectType
+    projectType: ProjectType | None
     """
     {SubSector Abbreviation} - {SubSector Display Name}
     """
     sourceSystem: SourceSystem
-    stage: Stage
+    stage: Stage | None
     """
     Process stage identifier
     """
@@ -490,11 +490,11 @@ class NsipProject(BaseModel):
     """
     Welsh Language translation required.
     """
-    mapZoomLevel: MapZoomLevel
+    mapZoomLevel: MapZoomLevel | None
     """
     Resolution of pinned map. Set when co-ordinates are created.
     """
-    secretaryOfState: str | None = None
+    secretaryOfState: str | None
     """
     Relevant Government Department. [TODO]
     """
@@ -705,38 +705,38 @@ class NsipProject(BaseModel):
     """
     DateProjectWithdrawn by applicant
     """
-    operationsLeadId: str | None = None
+    operationsLeadId: str | None
     """
     Maps to [Employee].[EmployeeID].
     """
-    operationsManagerId: str | None = None
+    operationsManagerId: str | None
     """
     New NSIP role, Maps to [Employee].[EmployeeID]
     """
-    caseManagerId: str | None = None
+    caseManagerId: str | None
     """
     Maps to [Employee].[EmployeeID]
     """
     nsipOfficerIds: list[str]
     nsipAdministrationOfficerIds: list[str]
-    leadInspectorId: str | None = None
+    leadInspectorId: str | None
     """
     Maps to [Employee].[EmployeeID]
     """
     inspectorIds: list[str]
-    environmentalServicesOfficerId: str | None = None
+    environmentalServicesOfficerId: str | None
     """
     Maps to [Employee].[EmployeeID]
     """
-    legalOfficerId: str | None = None
+    legalOfficerId: str | None
     """
     Maps to [Employee].[EmployeeID]
     """
-    applicantId: str | None = None
+    applicantId: str | None
     """
     Maps to [ServiceUser].[id] where the serviceUserType is Applicant
     """
-    migrationStatus: bool | None = None
+    migrationStatus: bool | None
     """
     Has this case been migrated from the legacy system? True if so.
     """

package/pins_data_model/models/model_nsip_project_update.py

@@ -3,12 +3,12 @@
 
 from __future__ import annotations
 
-from enum import Enum
+from enum import StrEnum
 
 from pydantic import AwareDatetime, BaseModel, ConfigDict
 
 
-class UpdateStatus(Enum):
+class UpdateStatus(StrEnum):
     """
     The current status of this update
     """
@@ -37,11 +37,11 @@ class NsipProjectUpdate(BaseModel):
     """
     the case reference this update relates to
     """
-    updateDate: AwareDatetime | None = None
+    updateDate: AwareDatetime | None
     """
     The date the update was published
     """
-    updateName: str | None = None
+    updateName: str | None
     """
     Internal title or name of the update
     """
@@ -49,7 +49,7 @@ class NsipProjectUpdate(BaseModel):
     """
     HTML content of the update in English. Can only include `<a> <b> <ul> <li>` tags.
     """
-    updateContentWelsh: str | None = None
+    updateContentWelsh: str | None
     """
     HTML content of the update in Welsh. Can only include `<a> <b> <ul> <li>` tags.
     """

package/pins_data_model/models/model_nsip_representation.py

@@ -62,22 +62,22 @@ class Representation(BaseModel):
     """
     The unique identifier within the Back Office. This is not the same as the case reference
     """
-    status: Status
+    status: Status | None
     originalRepresentation: str
-    redacted: bool | None = None
-    redactedRepresentation: str | None = None
+    redacted: bool | None
+    redactedRepresentation: str | None
     redactedBy: str | None = Field(..., examples=["Joe Blogs"])
     redactedNotes: str | None = Field(..., examples=["Removed names of family members"])
-    representationFrom: RepresentationFrom
+    representationFrom: RepresentationFrom | None
     representedId: str
     """
     ServiceUser Id of the person or organisation being represented
     """
-    representativeId: str | None = None
+    representativeId: str | None
     """
     ServiceUser Id of the person or organisation submitting representation in the case of Agent representationFrom
     """
-    registerFor: RegisterFor
-    representationType: RepresentationType
+    registerFor: RegisterFor | None
+    representationType: RepresentationType | None
     dateReceived: AwareDatetime = Field(..., examples=["2023-07-27T20:30:00.000Z"])
     attachmentIds: list[str]

package/pins_data_model/models/model_nsip_subscription.py

@@ -3,12 +3,12 @@
 
 from __future__ import annotations
 
-from enum import Enum
+from enum import Enum, StrEnum
 
 from pydantic import AwareDatetime, BaseModel, ConfigDict, EmailStr, Field
 
 
-class SubscriptionType(Enum):
+class SubscriptionType(StrEnum):
     """
     which update does the subscriber want to get notified of. For multiple types, use multiple messages.
     """
@@ -33,7 +33,7 @@ class NsipSubscription(BaseModel):
     model_config = ConfigDict(
         extra="allow",
     )
-    subscriptionId: int | None = None
+    subscriptionId: int | None
     """
     The unique identifier within the Back Office. Ignored as part of register-nsip-subscription.
     """
@@ -48,12 +48,12 @@ class NsipSubscription(BaseModel):
     """
     which update does the subscriber want to get notified of. For multiple types, use multiple messages.
     """
-    startDate: AwareDatetime | None = None
+    startDate: AwareDatetime | None
     """
     The date to start getting updates
     """
-    endDate: AwareDatetime | None = None
+    endDate: AwareDatetime | None
     """
     The date to stop getting updates
     """
-    language: Language
+    language: Language | None

package/pins_data_model/models/model_pins_inspector.py

@@ -10,11 +10,11 @@ class Address(BaseModel):
     model_config = ConfigDict(
         extra="allow",
     )
-    addressLine1: str | None = None
-    addressLine2: str | None = None
-    townCity: str | None = None
-    county: str | None = None
-    postcode: str | None = None
+    addressLine1: str | None
+    addressLine2: str | None
+    townCity: str | None
+    county: str | None
+    postcode: str | None
 
 
 class Specialism(BaseModel):

package/pins_data_model/models/model_s51_advice.py

@@ -65,11 +65,11 @@ class S51Advice(BaseModel):
     """
     Who the enquiry is from
     """
-    agent: str | None = None
+    agent: str | None
     """
     Who the enquiry is on behalf of
     """
-    method: Method
+    method: Method | None
     """
     How the enquiry was made
     """
@@ -79,7 +79,7 @@ class S51Advice(BaseModel):
     """
     Date the enquiry was made
     """
-    enquiryDetails: str | None = None
+    enquiryDetails: str | None
     """
     Details of the enquiry
     """
@@ -87,7 +87,7 @@ class S51Advice(BaseModel):
     """
     Details of the enquiry in Welsh
     """
-    adviceGivenBy: str | None = None
+    adviceGivenBy: str | None
     """
     Who issued the advice
     """
@@ -95,7 +95,7 @@ class S51Advice(BaseModel):
     """
     Date the advice was given
     """
-    adviceDetails: str | None = None
+    adviceDetails: str | None
     """
     Details of the advice
     """
@@ -103,6 +103,6 @@ class S51Advice(BaseModel):
     """
     Details of the advice in Welsh
     """
-    status: Status
-    redactionStatus: RedactionStatus
+    status: Status | None
+    redactionStatus: RedactionStatus | None
     attachmentIds: list[str]

package/pins_data_model/models/model_service_user.py

@@ -3,12 +3,12 @@
 
 from __future__ import annotations
 
-from enum import Enum
+from enum import StrEnum
 
 from pydantic import BaseModel, ConfigDict, Field
 
 
-class ServiceUserType(Enum):
+class ServiceUserType(StrEnum):
     """
     Type or category of the service user.
     """

package/prettier.config.js

@@ -0,0 +1,13 @@
+import { prettierConfig } from '@planning-inspectorate/coding-standards';
+
+export default {
+	...prettierConfig,
+	overrides: [
+		{
+			files: '*.json',
+			options: {
+				useTabs: false
+			}
+		}
+	]
+};

package/requirements.txt

@@ -1,2 +1,2 @@
-datamodel-code-generator==0.25.2
+datamodel-code-generator==0.64.0
 jsonc-parser==1.1.0

package/schemas/address.schema.json

@@ -75,7 +75,7 @@
     "UPRN": {
       "type": ["string", "null"],
       "example": 100023336956,
-      "description": "The Unique Property Reference Number (UPRN) is a unique number (a geocode) for every addressable location—e.g., a building, a bus stop, a post box, a feature in the landscape, or a defibrillator—in Great Britain."
+      "description": "The Unique Property Reference Number (UPRN) is a unique number (a geocode) for every addressable location - e.g., a building, a bus stop, a post box, a feature in the landscape, or a defibrillator - in Great Britain."
     },
     "dependentRequired": {
       "easting": ["northing"],

package/schemas/nsip-exam-timetable.schema.json

@@ -47,7 +47,8 @@
             "Preliminary Meeting",
             "Procedural Deadline (Pre-Examination)",
             "Procedural Decision",
-            "Publication Of"
+            "Publication Of",
+            "Unaccompanied Site Inspection"
           ]
         },
         "eventTitle": {

package/src/index.cjs

@@ -2,8 +2,8 @@
 
 var path = require('path');
 var url = require('url');
-var promises = require('fs/promises');
 var fs = require('fs');
+var promises = require('fs/promises');
 var jsoncParser = require('jsonc-parser');
 
 var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;

package/src/lib/gen-docs.js

@@ -1,6 +1,6 @@
 import { jsonschema2md } from '@adobe/jsonschema2md';
-import { loadAllSchemas } from '../index.js';
 import fs from 'fs/promises';
+import { loadAllSchemas } from '../index.js';
 
 /**
  * @typedef {import('@adobe/jsonschema2md').SchemaFiles} SchemaFiles

package/src/lib/gen-enum-impl.test.js

@@ -1,6 +1,6 @@
+import assert from 'node:assert';
 import { describe, it } from 'node:test';
 import { collectEnumProps, generateConstants, generateEnumMap } from './gen-enum-impl.js';
-import assert from 'node:assert';
 
 describe('gen-enum-impl', () => {
 	describe('generateConstants', () => {

package/src/lib/gen-enums.js

@@ -1,8 +1,8 @@
 import fs from 'fs/promises';
 import path from 'path';
 import { loadAllSchemas } from '../index.js';
-import { loadSchema } from './load.js';
 import { collectEnumProps, generateConstants, generateEnumMap } from './gen-enum-impl.js';
+import { loadSchema } from './load.js';
 
 const __dirname = import.meta.dirname;
 

package/src/lib/gen-types.js

@@ -1,9 +1,9 @@
 import fs from 'fs/promises';
+import { compile } from 'json-schema-to-typescript';
+import { generateName } from 'json-schema-to-typescript/dist/src/utils.js';
 import path from 'path';
 import url from 'url';
 import { commandsPath, loadAllSchemas, schemasPath } from '../index.js';
-import { compile } from 'json-schema-to-typescript';
-import { generateName } from 'json-schema-to-typescript/dist/src/utils.js';
 
 const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
 

package/src/lib/load.js

@@ -1,5 +1,5 @@
-import { readFile, readdir } from 'fs/promises';
 import { readFileSync, readdirSync } from 'fs';
+import { readFile, readdir } from 'fs/promises';
 import { parse } from 'jsonc-parser';
 import path from 'path';