@planning-inspectorate/data-model 2.38.1 → 2.39.0

package/docs/README.md

@@ -14,6 +14,8 @@
 
 * [Appeal S78 Case](./appeal-s78.md "Group B - Schema defining the metadata for an appeal") – `appeal-s78.schema.json`
 
+* [Application Update Schema](./application-update.md "Application Update for Casework Project") – `application-update.schema.json`
+
 * [DaRT API response](./dart-response.md "Schema defining the data returned by the DaRT API") – `dart-response.schema.json`
 
 * [Entra ID User Objects](./entraid.md "A list of users from EntraID") – `entraid.schema.json`

package/docs/application-update.md

@@ -0,0 +1,206 @@
+## Application Update Schema Type
+
+`object` ([Application Update Schema](application-update.md))
+
+# Application Update Schema Properties
+
+| Property                                            | Type     | Required | Nullable       | Defined by                                                                                                                                                 |
+| :-------------------------------------------------- | :------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [id](#id)                                           | `string` | Required | cannot be null | [Application Update Schema](application-update-properties-id.md "application-update.schema.json#/properties/id")                                           |
+| [caseReference](#casereference)                     | `string` | Required | cannot be null | [Application Update Schema](application-update-properties-casereference.md "application-update.schema.json#/properties/caseReference")                     |
+| [caseId](#caseid)                                   | `string` | Required | cannot be null | [Application Update Schema](application-update-properties-caseid.md "application-update.schema.json#/properties/caseId")                                   |
+| [caseType](#casetype)                               | `string` | Required | cannot be null | [Application Update Schema](application-update-properties-casetype.md "application-update.schema.json#/properties/caseType")                               |
+| [applicationUpdateStatus](#applicationupdatestatus) | `string` | Required | cannot be null | [Application Update Schema](application-update-properties-applicationupdatestatus.md "application-update.schema.json#/properties/applicationUpdateStatus") |
+| [details](#details)                                 | `string` | Required | cannot be null | [Application Update Schema](application-update-properties-details.md "application-update.schema.json#/properties/details")                                 |
+| [firstPublished](#firstpublished)                   | `string` | Optional | can be null    | [Application Update Schema](application-update-properties-firstpublished.md "application-update.schema.json#/properties/firstPublished")                   |
+| [unpublishedDate](#unpublisheddate)                 | `string` | Optional | can be null    | [Application Update Schema](application-update-properties-unpublisheddate.md "application-update.schema.json#/properties/unpublishedDate")                 |
+| [lastEdited](#lastedited)                           | `string` | Optional | can be null    | [Application Update Schema](application-update-properties-lastedited.md "application-update.schema.json#/properties/lastEdited")                           |
+| Additional Properties                               | Any      | Optional | can be null    |                                                                                                                                                            |
+
+## id
+
+Primary key
+
+`id`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Application Update Schema](application-update-properties-id.md "application-update.schema.json#/properties/id")
+
+### id Type
+
+`string`
+
+## caseReference
+
+Business Key for the related case
+
+`caseReference`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Application Update Schema](application-update-properties-casereference.md "application-update.schema.json#/properties/caseReference")
+
+### caseReference Type
+
+`string`
+
+## caseId
+
+The unique ID for the case this Application Update belongs to.
+
+`caseId`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Application Update Schema](application-update-properties-caseid.md "application-update.schema.json#/properties/caseId")
+
+### caseId Type
+
+`string`
+
+## caseType
+
+The type of case this Application Update is for.
+
+`caseType`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Application Update Schema](application-update-properties-casetype.md "application-update.schema.json#/properties/caseType")
+
+### caseType Type
+
+`string`
+
+## applicationUpdateStatus
+
+Application Update Status. Name displayed to users, e.g. Draft
+
+`applicationUpdateStatus`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Application Update Schema](application-update-properties-applicationupdatestatus.md "application-update.schema.json#/properties/applicationUpdateStatus")
+
+### applicationUpdateStatus Type
+
+`string`
+
+### applicationUpdateStatus Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value           | Explanation |
+| :-------------- | :---------- |
+| `"Draft"`       |             |
+| `"Published"`   |             |
+| `"Unpublished"` |             |
+
+## details
+
+Application Update text description.
+
+`details`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Application Update Schema](application-update-properties-details.md "application-update.schema.json#/properties/details")
+
+### details Type
+
+`string`
+
+## firstPublished
+
+
+
+`firstPublished`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Application Update Schema](application-update-properties-firstpublished.md "application-update.schema.json#/properties/firstPublished")
+
+### firstPublished Type
+
+`string`
+
+### firstPublished Constraints
+
+**date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
+
+## unpublishedDate
+
+
+
+`unpublishedDate`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Application Update Schema](application-update-properties-unpublisheddate.md "application-update.schema.json#/properties/unpublishedDate")
+
+### unpublishedDate Type
+
+`string`
+
+### unpublishedDate Constraints
+
+**date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
+
+## lastEdited
+
+
+
+`lastEdited`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Application Update Schema](application-update-properties-lastedited.md "application-update.schema.json#/properties/lastEdited")
+
+### lastEdited Type
+
+`string`
+
+### lastEdited Constraints
+
+**date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
+
+## Additional Properties
+
+Additional properties are allowed and do not have to follow a specific schema

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planning-inspectorate/data-model",
-  "version": "2.38.1",
+  "version": "2.39.0",
   "description": "JSON Schemas for the Planning Inspectorate's Data Model",
   "main": "src/index.js",
   "type": "module",
@@ -30,8 +30,8 @@
   },
   "devDependencies": {
     "@adobe/jsonschema2md": "^8.0.3",
-    "@commitlint/cli": "^20.1.0",
-    "@commitlint/config-conventional": "^20.0.0",
+    "@commitlint/cli": "^21.0.0",
+    "@commitlint/config-conventional": "^21.0.0",
     "@eslint/js": "^10.0.1",
     "ajv": "^8.17.1",
     "ajv-formats": "^3.0.1",
@@ -41,7 +41,7 @@
     "globals": "^17.3.0",
     "husky": "^9.1.7",
     "json-schema-to-typescript": "^15.0.4",
-    "lint-staged": "^16.1.2",
+    "lint-staged": "^17.0.4",
     "lodash.snakecase": "^4.1.1",
     "prettier": "^3.6.2",
     "rollup": "^4.44.2",

package/pins_data_model/models/model_application_update.py

@@ -0,0 +1,55 @@
+# generated by datamodel-codegen:
+#   filename:  application-update.schema.json
+
+from __future__ import annotations
+
+from enum import Enum
+
+from pydantic import AwareDatetime, BaseModel, ConfigDict, Field
+
+
+class ApplicationUpdateStatus(Enum):
+    """
+    Application Update Status. Name displayed to users, e.g. Draft
+    """
+
+    Draft = "Draft"
+    Published = "Published"
+    Unpublished = "Unpublished"
+
+
+class ApplicationUpdateSchema(BaseModel):
+    """
+    Application Update for Casework Project
+    """
+
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    id: str = Field(..., examples=["AAAAAAAA-1234-1234-1234-AAAAAAAAAAAA"])
+    """
+    Primary key
+    """
+    caseReference: str = Field(..., examples=["CROWN/2025/12345"])
+    """
+    Business Key for the related case
+    """
+    caseId: str = Field(..., examples=["AAAAAAAA-1234-1234-1234-AAAAAAAAAAAA"])
+    """
+    The unique ID for the case this Application Update belongs to.
+    """
+    caseType: str = Field(..., examples=["Crown Development Application"])
+    """
+    The type of case this Application Update is for.
+    """
+    applicationUpdateStatus: ApplicationUpdateStatus
+    """
+    Application Update Status. Name displayed to users, e.g. Draft
+    """
+    details: str
+    """
+    Application Update text description.
+    """
+    firstPublished: AwareDatetime | None = None
+    unpublishedDate: AwareDatetime | None = None
+    lastEdited: AwareDatetime | None = None

package/schemas/application-update.schema.json

@@ -0,0 +1,52 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "application-update.schema.json",
+  "title": "Application Update Schema",
+  "description": "Application Update for Casework Project",
+  "type": "object",
+  "additionalProperties": true,
+  "required": ["id", "caseReference", "caseId", "caseType", "applicationUpdateStatus", "details"],
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "Primary key",
+      "example": "AAAAAAAA-1234-1234-1234-AAAAAAAAAAAA"
+    },
+    "caseReference": {
+      "type": "string",
+      "description": "Business Key for the related case",
+      "example": "CROWN/2025/12345"
+    },
+    "caseId": {
+      "type": "string",
+      "description": "The unique ID for the case this Application Update belongs to.",
+      "example": "AAAAAAAA-1234-1234-1234-AAAAAAAAAAAA"
+    },
+    "caseType": {
+      "type": "string",
+      "description": "The type of case this Application Update is for.",
+      "example": "Crown Development Application"
+    },
+    "applicationUpdateStatus": {
+      "type": "string",
+      "description": "Application Update Status. Name displayed to users, e.g. Draft",
+      "enum": ["Draft", "Published", "Unpublished"]
+    },
+    "details": {
+      "type": "string",
+      "description": "Application Update text description."
+    },
+    "firstPublished": {
+      "type": ["string", "null"],
+      "format": "date-time"
+    },
+    "unpublishedDate": {
+      "type": ["string", "null"],
+      "format": "date-time"
+    },
+    "lastEdited": {
+      "type": ["string", "null"],
+      "format": "date-time"
+    }
+  }
+}

package/src/enums.cjs

@@ -436,6 +436,12 @@ const APPEAL_VIRUS_CHECK_STATUS = Object.freeze({
   SCANNED: 'scanned',
 });
 
+const APPLICATION_UPDATE_STATUS = Object.freeze({
+  DRAFT: 'Draft',
+  PUBLISHED: 'Published',
+  UNPUBLISHED: 'Unpublished',
+});
+
 const CASE_STAGE = Object.freeze({
   0: '0',
   ACCEPTANCE: 'acceptance',
@@ -852,6 +858,7 @@ exports.APPEAL_SOURCE = APPEAL_SOURCE;
 exports.APPEAL_SOURCE_SYSTEM = APPEAL_SOURCE_SYSTEM;
 exports.APPEAL_TYPE_OF_PLANNING_APPLICATION = APPEAL_TYPE_OF_PLANNING_APPLICATION;
 exports.APPEAL_VIRUS_CHECK_STATUS = APPEAL_VIRUS_CHECK_STATUS;
+exports.APPLICATION_UPDATE_STATUS = APPLICATION_UPDATE_STATUS;
 exports.CASE_STAGE = CASE_STAGE;
 exports.MESSAGE_EVENT_TYPE = MESSAGE_EVENT_TYPE;
 exports.METHOD = METHOD;

package/src/enums.d.ts

@@ -434,6 +434,12 @@ export const APPEAL_VIRUS_CHECK_STATUS = {
   SCANNED: 'scanned',
 } as const;
 
+export const APPLICATION_UPDATE_STATUS = {
+  DRAFT: 'Draft',
+  PUBLISHED: 'Published',
+  UNPUBLISHED: 'Unpublished',
+} as const;
+
 export const CASE_STAGE = {
   0: '0',
   ACCEPTANCE: 'acceptance',

package/src/enums.js

@@ -434,6 +434,12 @@ export const APPEAL_VIRUS_CHECK_STATUS = Object.freeze({
   SCANNED: 'scanned',
 });
 
+export const APPLICATION_UPDATE_STATUS = Object.freeze({
+  DRAFT: 'Draft',
+  PUBLISHED: 'Published',
+  UNPUBLISHED: 'Unpublished',
+});
+
 export const CASE_STAGE = Object.freeze({
   0: '0',
   ACCEPTANCE: 'acceptance',

package/src/index.cjs

@@ -517,6 +517,12 @@ const APPEAL_VIRUS_CHECK_STATUS = Object.freeze({
   SCANNED: 'scanned',
 });
 
+const APPLICATION_UPDATE_STATUS = Object.freeze({
+  DRAFT: 'Draft',
+  PUBLISHED: 'Published',
+  UNPUBLISHED: 'Unpublished',
+});
+
 const CASE_STAGE = Object.freeze({
   0: '0',
   ACCEPTANCE: 'acceptance',
@@ -965,6 +971,7 @@ exports.APPEAL_SOURCE = APPEAL_SOURCE;
 exports.APPEAL_SOURCE_SYSTEM = APPEAL_SOURCE_SYSTEM;
 exports.APPEAL_TYPE_OF_PLANNING_APPLICATION = APPEAL_TYPE_OF_PLANNING_APPLICATION;
 exports.APPEAL_VIRUS_CHECK_STATUS = APPEAL_VIRUS_CHECK_STATUS;
+exports.APPLICATION_UPDATE_STATUS = APPLICATION_UPDATE_STATUS;
 exports.CASE_STAGE = CASE_STAGE;
 exports.MESSAGE_EVENT_TYPE = MESSAGE_EVENT_TYPE;
 exports.METHOD = METHOD;

package/src/schemas.d.ts

@@ -1750,6 +1750,40 @@ export interface SiteAddress {
   siteAddressPostcode: string;
 }
 
+/**
+ * Application Update for Casework Project
+ */
+export interface ApplicationUpdateSchema {
+  /**
+   * Primary key
+   */
+  id: string;
+  /**
+   * Business Key for the related case
+   */
+  caseReference: string;
+  /**
+   * The unique ID for the case this Application Update belongs to.
+   */
+  caseId: string;
+  /**
+   * The type of case this Application Update is for.
+   */
+  caseType: string;
+  /**
+   * Application Update Status. Name displayed to users, e.g. Draft
+   */
+  applicationUpdateStatus: 'Draft' | 'Published' | 'Unpublished';
+  /**
+   * Application Update text description.
+   */
+  details: string;
+  firstPublished?: string | null;
+  unpublishedDate?: string | null;
+  lastEdited?: string | null;
+  [k: string]: unknown;
+}
+
 /**
  * Schema defining the data returned by the DaRT API
  */
@@ -5131,6 +5165,7 @@ export type SchemaMap = {
     'appeal-has.schema.json': AppealHASCase;
     'appeal-representation.schema.json': AppealRepresentation;
     'appeal-s78.schema.json': AppealS78Case;
+    'application-update.schema.json': ApplicationUpdateSchema;
     'dart-response.schema.json': DaRTAPIResponse;
     'entraid.schema.json': EntraIDUserObjects;
     'folder.schema.json': Folder;