@planning-inspectorate/data-model 1.11.0

package/docs/service-user.md

@@ -0,0 +1,575 @@
+## Service User Type
+
+`object` ([Service User](service-user.md))
+
+# Service User Properties
+
+| Property                              | Type     | Required | Nullable       | Defined by                                                                                                          |
+| :------------------------------------ | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------ |
+| [id](#id)                             | `string` | Required | cannot be null | [Service User](service-user-properties-id.md "service-user.schema.json#/properties/id")                             |
+| [salutation](#salutation)             | `string` | Required | can be null    | [Service User](service-user-properties-salutation.md "service-user.schema.json#/properties/salutation")             |
+| [firstName](#firstname)               | `string` | Required | can be null    | [Service User](service-user-properties-firstname.md "service-user.schema.json#/properties/firstName")               |
+| [lastName](#lastname)                 | `string` | Required | can be null    | [Service User](service-user-properties-lastname.md "service-user.schema.json#/properties/lastName")                 |
+| [addressLine1](#addressline1)         | `string` | Required | can be null    | [Service User](service-user-properties-addressline1.md "service-user.schema.json#/properties/addressLine1")         |
+| [addressLine2](#addressline2)         | `string` | Required | can be null    | [Service User](service-user-properties-addressline2.md "service-user.schema.json#/properties/addressLine2")         |
+| [addressTown](#addresstown)           | `string` | Required | can be null    | [Service User](service-user-properties-addresstown.md "service-user.schema.json#/properties/addressTown")           |
+| [addressCounty](#addresscounty)       | `string` | Required | can be null    | [Service User](service-user-properties-addresscounty.md "service-user.schema.json#/properties/addressCounty")       |
+| [postcode](#postcode)                 | `string` | Required | can be null    | [Service User](service-user-properties-postcode.md "service-user.schema.json#/properties/postcode")                 |
+| [addressCountry](#addresscountry)     | `string` | Required | can be null    | [Service User](service-user-properties-addresscountry.md "service-user.schema.json#/properties/addressCountry")     |
+| [organisation](#organisation)         | `string` | Required | can be null    | [Service User](service-user-properties-organisation.md "service-user.schema.json#/properties/organisation")         |
+| [organisationType](#organisationtype) | `string` | Required | can be null    | [Service User](service-user-properties-organisationtype.md "service-user.schema.json#/properties/organisationType") |
+| [role](#role)                         | `string` | Required | can be null    | [Service User](service-user-properties-role.md "service-user.schema.json#/properties/role")                         |
+| [telephoneNumber](#telephonenumber)   | `string` | Required | can be null    | [Service User](service-user-properties-telephonenumber.md "service-user.schema.json#/properties/telephoneNumber")   |
+| [otherPhoneNumber](#otherphonenumber) | `string` | Required | can be null    | [Service User](service-user-properties-otherphonenumber.md "service-user.schema.json#/properties/otherPhoneNumber") |
+| [faxNumber](#faxnumber)               | `string` | Required | can be null    | [Service User](service-user-properties-faxnumber.md "service-user.schema.json#/properties/faxNumber")               |
+| [emailAddress](#emailaddress)         | `string` | Required | can be null    | [Service User](service-user-properties-emailaddress.md "service-user.schema.json#/properties/emailAddress")         |
+| [webAddress](#webaddress)             | `string` | Required | can be null    | [Service User](service-user-properties-webaddress.md "service-user.schema.json#/properties/webAddress")             |
+| [serviceUserType](#serviceusertype)   | `string` | Required | cannot be null | [Service User](service-user-properties-serviceusertype.md "service-user.schema.json#/properties/serviceUserType")   |
+| [caseReference](#casereference)       | `string` | Required | cannot be null | [Service User](service-user-properties-casereference.md "service-user.schema.json#/properties/caseReference")       |
+| [sourceSystem](#sourcesystem)         | `string` | Required | cannot be null | [Service User](service-user-properties-sourcesystem.md "service-user.schema.json#/properties/sourceSystem")         |
+| [sourceSuid](#sourcesuid)             | `string` | Required | cannot be null | [Service User](service-user-properties-sourcesuid.md "service-user.schema.json#/properties/sourceSuid")             |
+| Additional Properties                 | Any      | Optional | can be null    |                                                                                                                     |
+
+## id
+
+A unique identifier for the entity.
+
+`id`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Service User](service-user-properties-id.md "service-user.schema.json#/properties/id")
+
+### id Type
+
+`string`
+
+### id Examples
+
+```json
+"12345"
+```
+
+## salutation
+
+A formal greeting, e.g., Mr, Mrs, Ms.
+
+`salutation`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Service User](service-user-properties-salutation.md "service-user.schema.json#/properties/salutation")
+
+### salutation Type
+
+`string`
+
+### salutation Examples
+
+```json
+"Mr"
+```
+
+## firstName
+
+The first name of the individual.
+
+`firstName`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Service User](service-user-properties-firstname.md "service-user.schema.json#/properties/firstName")
+
+### firstName Type
+
+`string`
+
+### firstName Examples
+
+```json
+"John"
+```
+
+## lastName
+
+The last name of the individual.
+
+`lastName`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Service User](service-user-properties-lastname.md "service-user.schema.json#/properties/lastName")
+
+### lastName Type
+
+`string`
+
+### lastName Examples
+
+```json
+"Doe"
+```
+
+## addressLine1
+
+The first line of the address.
+
+`addressLine1`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Service User](service-user-properties-addressline1.md "service-user.schema.json#/properties/addressLine1")
+
+### addressLine1 Type
+
+`string`
+
+### addressLine1 Examples
+
+```json
+"123 Elm Street"
+```
+
+## addressLine2
+
+The second line of the address, usually includes suite or apartment number.
+
+`addressLine2`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Service User](service-user-properties-addressline2.md "service-user.schema.json#/properties/addressLine2")
+
+### addressLine2 Type
+
+`string`
+
+### addressLine2 Examples
+
+```json
+"Apt 4B"
+```
+
+## addressTown
+
+The town or city of the address.
+
+`addressTown`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Service User](service-user-properties-addresstown.md "service-user.schema.json#/properties/addressTown")
+
+### addressTown Type
+
+`string`
+
+### addressTown Examples
+
+```json
+"Springfield"
+```
+
+## addressCounty
+
+The county in which the town or city is located.
+
+`addressCounty`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Service User](service-user-properties-addresscounty.md "service-user.schema.json#/properties/addressCounty")
+
+### addressCounty Type
+
+`string`
+
+### addressCounty Examples
+
+```json
+"Hampshire"
+```
+
+## postcode
+
+The postal code for the address.
+
+`postcode`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Service User](service-user-properties-postcode.md "service-user.schema.json#/properties/postcode")
+
+### postcode Type
+
+`string`
+
+### postcode Examples
+
+```json
+"M12 4AF"
+```
+
+## addressCountry
+
+The country of the address.
+
+`addressCountry`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Service User](service-user-properties-addresscountry.md "service-user.schema.json#/properties/addressCountry")
+
+### addressCountry Type
+
+`string`
+
+### addressCountry Examples
+
+```json
+"United Kingdom"
+```
+
+## organisation
+
+The name of the organisation associated with the individual.
+
+`organisation`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Service User](service-user-properties-organisation.md "service-user.schema.json#/properties/organisation")
+
+### organisation Type
+
+`string`
+
+### organisation Examples
+
+```json
+"Tech Corp"
+```
+
+## organisationType
+
+The type or nature of the organisation.
+
+`organisationType`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Service User](service-user-properties-organisationtype.md "service-user.schema.json#/properties/organisationType")
+
+### organisationType Type
+
+`string`
+
+### organisationType Examples
+
+```json
+"Private Company"
+```
+
+## role
+
+The individual's role or position within the organisation.
+
+`role`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Service User](service-user-properties-role.md "service-user.schema.json#/properties/role")
+
+### role Type
+
+`string`
+
+### role Examples
+
+```json
+"Agent"
+```
+
+## telephoneNumber
+
+The primary telephone contact number.
+
+`telephoneNumber`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Service User](service-user-properties-telephonenumber.md "service-user.schema.json#/properties/telephoneNumber")
+
+### telephoneNumber Type
+
+`string`
+
+### telephoneNumber Examples
+
+```json
+"+447123456789"
+```
+
+## otherPhoneNumber
+
+An alternate or secondary phone number.
+
+`otherPhoneNumber`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Service User](service-user-properties-otherphonenumber.md "service-user.schema.json#/properties/otherPhoneNumber")
+
+### otherPhoneNumber Type
+
+`string`
+
+### otherPhoneNumber Examples
+
+```json
+"+447123456789"
+```
+
+## faxNumber
+
+A fax contact number.
+
+`faxNumber`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Service User](service-user-properties-faxnumber.md "service-user.schema.json#/properties/faxNumber")
+
+### faxNumber Type
+
+`string`
+
+### faxNumber Examples
+
+```json
+"+447123456789"
+```
+
+## emailAddress
+
+The primary email address for contact.
+
+`emailAddress`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Service User](service-user-properties-emailaddress.md "service-user.schema.json#/properties/emailAddress")
+
+### emailAddress Type
+
+`string`
+
+### emailAddress Examples
+
+```json
+"john.doe@example.com"
+```
+
+## webAddress
+
+Website address or URL.
+
+`webAddress`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Service User](service-user-properties-webaddress.md "service-user.schema.json#/properties/webAddress")
+
+### webAddress Type
+
+`string`
+
+### webAddress Examples
+
+```json
+"https://www.example.com"
+```
+
+## serviceUserType
+
+Type or category of the service user.
+
+`serviceUserType`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Service User](service-user-properties-serviceusertype.md "service-user.schema.json#/properties/serviceUserType")
+
+### serviceUserType Type
+
+`string`
+
+### serviceUserType Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value                     | Explanation |
+| :------------------------ | :---------- |
+| `"Applicant"`             |             |
+| `"Appellant"`             |             |
+| `"Agent"`                 |             |
+| `"Rule6Party"`            |             |
+| `"InterestedParty"`       |             |
+| `"RepresentationContact"` |             |
+| `"Subscriber"`            |             |
+
+## caseReference
+
+Reference number for a particular case or incident.
+
+`caseReference`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Service User](service-user-properties-casereference.md "service-user.schema.json#/properties/caseReference")
+
+### caseReference Type
+
+`string`
+
+### caseReference Examples
+
+```json
+"BC0510001"
+```
+
+## sourceSystem
+
+The originating system from where the data was sourced.
+
+`sourceSystem`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Service User](service-user-properties-sourcesystem.md "service-user.schema.json#/properties/sourceSystem")
+
+### sourceSystem Type
+
+`string`
+
+### sourceSystem Examples
+
+```json
+"ODT"
+```
+
+```json
+"Horizon"
+```
+
+## sourceSuid
+
+Unique identifier from the source system.
+
+`sourceSuid`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Service User](service-user-properties-sourcesuid.md "service-user.schema.json#/properties/sourceSuid")
+
+### sourceSuid Type
+
+`string`
+
+### sourceSuid Examples
+
+```json
+"12345"
+```
+
+## Additional Properties
+
+Additional properties are allowed and do not have to follow a specific schema

package/eslint.config.js

@@ -0,0 +1,21 @@
+import js from '@eslint/js';
+import eslintConfigPrettier from 'eslint-config-prettier';
+import globals from 'globals';
+
+export default [
+	{
+		...js.configs.recommended,
+		ignores: ['**/*.cjs', 'node_modules/**']
+	},
+	{
+		ignores: ['node_modules/**', '**/*.cjs'],
+		languageOptions: {
+			ecmaVersion: 2025,
+			sourceType: 'module',
+			globals: {
+				...globals.node
+			}
+		}
+	},
+	eslintConfigPrettier
+];

package/jsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "allowSyntheticDefaultImports": true,
+    "checkJs": true,
+    "esModuleInterop": true,
+    "moduleResolution": "node",
+    "target": "esnext",
+    "module": "es2022",
+    "strict": true
+  }
+}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@planning-inspectorate/data-model",
+  "version": "1.11.0",
+  "description": "JSON Schemas for the Planning Inspectorate's Data Model",
+  "main": "src/index.js",
+  "type": "module",
+  "exports": {
+    "import": "./src/index.js",
+    "require": "./src/index.cjs"
+  },
+  "scripts": {
+    "commitlint": "commitlint --from=$(git cherry origin/main | head -n 1 | cut -c 3-)",
+    "gen": "npm run gen-docs && npm run gen-enums && npm run gen-types && npm run gen-cjs",
+    "gen-docs": "node src/gen-docs.js",
+    "gen-enums": "node src/gen-enums.js",
+    "gen-types": "node src/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 .",
+    "format": "prettier --write .",
+    "format-check": "prettier --check .",
+    "prepare": "node .husky/install.mjs"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Planning-Inspectorate/data-model.git"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "jsonc-parser": "^3.3.1"
+  },
+  "devDependencies": {
+    "@adobe/jsonschema2md": "^8.0.3",
+    "@commitlint/cli": "^19.8.1",
+    "@commitlint/config-conventional": "^19.8.1",
+    "ajv": "^8.17.1",
+    "ajv-formats": "^3.0.1",
+    "eslint": "^9.30.1",
+    "eslint-config-prettier": "^10.1.5",
+    "husky": "^9.1.7",
+    "json-schema-to-typescript": "^15.0.4",
+    "lint-staged": "^16.1.2",
+    "lodash.snakecase": "^4.1.1",
+    "prettier": "^3.6.2",
+    "rollup": "^4.44.2",
+    "semantic-release": "^24.2.6"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "lint-staged": {
+    "*.js": [
+      "eslint --fix"
+    ]
+  }
+}

package/pins_data_model/gen_models.py

@@ -0,0 +1,51 @@
+"""
+Module to generate pydantic models from json schemas
+"""
+
+import json
+from os import path
+from pathlib import Path
+from datamodel_code_generator import InputFileType, PythonVersion, generate
+from datamodel_code_generator import DataModelType
+
+from load_schemas import load_all_schemas
+
+modelsDir = path.join(path.dirname(path.realpath(__file__)), "models")
+
+
+def gen_models() -> None:
+    """
+    Function to generate pydantic models from json schemas.
+    It loops through a list of schemas, generates a file path and
+    generates a pydantic v2 base model.
+    """
+
+    loaded = load_all_schemas()
+    schemas = loaded["schemas"]
+
+    for name in schemas:
+        schema = schemas[name]
+        json_schema = json.dumps(schema)
+        filename = (
+            "model_"
+            + name.replace("-", "_")
+            .replace(".schema.jsonc", "")
+            .replace(".schema.json", "")
+            + ".py"
+        )
+        generate(
+            json_schema,
+            input_file_type=InputFileType.JsonSchema,
+            input_filename=name,
+            output=Path(path.join(modelsDir, filename)),
+            output_model_type=DataModelType.PydanticV2BaseModel,
+            use_double_quotes=True,
+            use_standard_collections=True,
+            use_union_operator=True,
+            use_field_description=True,
+            target_python_version=PythonVersion.PY_311,
+            use_schema_description=True,
+        )
+
+
+gen_models()