@planning-inspectorate/data-model 2.54.0 → 2.55.0

package/docs/nsip-project.md

@@ -13,6 +13,7 @@
 | [projectDescription](#projectdescription)                                                               | `string`      | Required | can be null    | [NSIP Project](nsip-project-properties-projectdescription.md "nsip-project.schema.json#/properties/projectDescription")                                                               |
 | [projectDescriptionWelsh](#projectdescriptionwelsh)                                                     | `string`      | Optional | can be null    | [NSIP Project](nsip-project-properties-projectdescriptionwelsh.md "nsip-project.schema.json#/properties/projectDescriptionWelsh")                                                     |
 | [decision](#decision)                                                                                   | `string`      | Required | can be null    | [NSIP Project](nsip-project-properties-decision.md "nsip-project.schema.json#/properties/decision")                                                                                   |
+| [dcoStatus](#dcostatus)                                                                                 | `string`      | Optional | can be null    | [NSIP Project](nsip-project-properties-dcostatus.md "nsip-project.schema.json#/properties/dcoStatus")                                                                                 |
 | [publishStatus](#publishstatus)                                                                         | `string`      | Required | can be null    | [NSIP Project](nsip-project-properties-publishstatus.md "nsip-project.schema.json#/properties/publishStatus")                                                                         |
 | [sector](#sector)                                                                                       | `string`      | Required | can be null    | [NSIP Project](nsip-project-properties-sector.md "nsip-project.schema.json#/properties/sector")                                                                                       |
 | [projectType](#projecttype)                                                                             | `string`      | Required | can be null    | [NSIP Project](nsip-project-properties-projecttype.md "nsip-project.schema.json#/properties/projectType")                                                                             |
@@ -305,6 +306,41 @@ Decision outcome: approved/refused/split-decision/granted/partially\_consented/q
 | `"withdrawn"`           |             |
 | `null`                  |             |
 
+## dcoStatus
+
+Decision outcome: approved/refused/split-decision/granted/partially\_consented/quashed/redetermination/withdrawn/revoked
+
+`dcoStatus`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Project](nsip-project-properties-dcostatus.md "nsip-project.schema.json#/properties/dcoStatus")
+
+### dcoStatus Type
+
+`string`
+
+### dcoStatus Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value                   | Explanation |
+| :---------------------- | :---------- |
+| `"approved"`            |             |
+| `"refused"`             |             |
+| `"split-decision"`      |             |
+| `"granted"`             |             |
+| `"partially_consented"` |             |
+| `"quashed"`             |             |
+| `"redetermination"`     |             |
+| `"withdrawn"`           |             |
+| `"revoked"`             |             |
+| `null`                  |             |
+
 ## publishStatus
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planning-inspectorate/data-model",
-  "version": "2.54.0",
+  "version": "2.55.0",
   "description": "JSON Schemas for the Planning Inspectorate's Data Model",
   "main": "src/index.js",
   "type": "module",

package/pins_data_model/models/model_nsip_project.py

@@ -25,6 +25,23 @@ class Decision(Enum):
     NoneType_None = None
 
 
+class DcoStatus(Enum):
+    """
+    Decision outcome: approved/refused/split-decision/granted/partially_consented/quashed/redetermination/withdrawn/revoked
+    """
+
+    approved = "approved"
+    refused = "refused"
+    split_decision = "split-decision"
+    granted = "granted"
+    partially_consented = "partially_consented"
+    quashed = "quashed"
+    redetermination = "redetermination"
+    withdrawn = "withdrawn"
+    revoked = "revoked"
+    NoneType_None = None
+
+
 class PublishStatus(Enum):
     published = "published"
     unpublished = "unpublished"
@@ -440,6 +457,10 @@ class NsipProject(BaseModel):
     """
     Decision outcome: approved/refused/split-decision/granted/partially_consented/quashed/redetermination/withdrawn
     """
+    dcoStatus: DcoStatus | None = None
+    """
+    Decision outcome: approved/refused/split-decision/granted/partially_consented/quashed/redetermination/withdrawn/revoked
+    """
     publishStatus: PublishStatus | None
     sector: Sector | None
     """

package/schemas/nsip-project.schema.json

@@ -118,6 +118,22 @@
         null
       ]
     },
+    "dcoStatus": {
+      "type": ["string", "null"],
+      "description": "Decision outcome: approved/refused/split-decision/granted/partially_consented/quashed/redetermination/withdrawn/revoked",
+      "enum": [
+        "approved",
+        "refused",
+        "split-decision",
+        "granted",
+        "partially_consented",
+        "quashed",
+        "redetermination",
+        "withdrawn",
+        "revoked",
+        null
+      ]
+    },
     "publishStatus": {
       "type": ["string", "null"],
       "enum": ["published", "unpublished", null]

package/src/enums.cjs

@@ -626,6 +626,18 @@ const NSIP_CASE_TYPE = Object.freeze({
   NSIP: 'nsip',
 });
 
+const NSIP_DCO_STATUS = Object.freeze({
+  APPROVED: 'approved',
+  GRANTED: 'granted',
+  PARTIALLY_CONSENTED: 'partially_consented',
+  QUASHED: 'quashed',
+  REDETERMINATION: 'redetermination',
+  REFUSED: 'refused',
+  REVOKED: 'revoked',
+  SPLIT_DECISION: 'split-decision',
+  WITHDRAWN: 'withdrawn',
+});
+
 const NSIP_DECISION = Object.freeze({
   APPROVED: 'approved',
   GRANTED: 'granted',
@@ -1024,6 +1036,7 @@ exports.MESSAGE_EVENT_TYPE = MESSAGE_EVENT_TYPE;
 exports.METHOD = METHOD;
 exports.NSIP_CASE_TYPE = NSIP_CASE_TYPE;
 exports.NSIP_CA_AND_TP_EVIDENCE = NSIP_CA_AND_TP_EVIDENCE;
+exports.NSIP_DCO_STATUS = NSIP_DCO_STATUS;
 exports.NSIP_DECISION = NSIP_DECISION;
 exports.NSIP_DESIGN_APPROACH_DOCUMENT = NSIP_DESIGN_APPROACH_DOCUMENT;
 exports.NSIP_DOCUMENT_CASE_STAGE = NSIP_DOCUMENT_CASE_STAGE;

package/src/enums.d.ts

@@ -624,6 +624,18 @@ export const NSIP_CASE_TYPE = {
   NSIP: 'nsip',
 } as const;
 
+export const NSIP_DCO_STATUS = {
+  APPROVED: 'approved',
+  GRANTED: 'granted',
+  PARTIALLY_CONSENTED: 'partially_consented',
+  QUASHED: 'quashed',
+  REDETERMINATION: 'redetermination',
+  REFUSED: 'refused',
+  REVOKED: 'revoked',
+  SPLIT_DECISION: 'split-decision',
+  WITHDRAWN: 'withdrawn',
+} as const;
+
 export const NSIP_DECISION = {
   APPROVED: 'approved',
   GRANTED: 'granted',

package/src/enums.js

@@ -624,6 +624,18 @@ export const NSIP_CASE_TYPE = Object.freeze({
   NSIP: 'nsip',
 });
 
+export const NSIP_DCO_STATUS = Object.freeze({
+  APPROVED: 'approved',
+  GRANTED: 'granted',
+  PARTIALLY_CONSENTED: 'partially_consented',
+  QUASHED: 'quashed',
+  REDETERMINATION: 'redetermination',
+  REFUSED: 'refused',
+  REVOKED: 'revoked',
+  SPLIT_DECISION: 'split-decision',
+  WITHDRAWN: 'withdrawn',
+});
+
 export const NSIP_DECISION = Object.freeze({
   APPROVED: 'approved',
   GRANTED: 'granted',

package/src/index.cjs

@@ -707,6 +707,18 @@ const NSIP_CASE_TYPE = Object.freeze({
   NSIP: 'nsip',
 });
 
+const NSIP_DCO_STATUS = Object.freeze({
+  APPROVED: 'approved',
+  GRANTED: 'granted',
+  PARTIALLY_CONSENTED: 'partially_consented',
+  QUASHED: 'quashed',
+  REDETERMINATION: 'redetermination',
+  REFUSED: 'refused',
+  REVOKED: 'revoked',
+  SPLIT_DECISION: 'split-decision',
+  WITHDRAWN: 'withdrawn',
+});
+
 const NSIP_DECISION = Object.freeze({
   APPROVED: 'approved',
   GRANTED: 'granted',
@@ -1137,6 +1149,7 @@ exports.MESSAGE_EVENT_TYPE = MESSAGE_EVENT_TYPE;
 exports.METHOD = METHOD;
 exports.NSIP_CASE_TYPE = NSIP_CASE_TYPE;
 exports.NSIP_CA_AND_TP_EVIDENCE = NSIP_CA_AND_TP_EVIDENCE;
+exports.NSIP_DCO_STATUS = NSIP_DCO_STATUS;
 exports.NSIP_DECISION = NSIP_DECISION;
 exports.NSIP_DESIGN_APPROACH_DOCUMENT = NSIP_DESIGN_APPROACH_DOCUMENT;
 exports.NSIP_DOCUMENT_CASE_STAGE = NSIP_DOCUMENT_CASE_STAGE;

package/src/schemas.d.ts

@@ -3239,6 +3239,20 @@ export interface NSIPProject {
     | 'redetermination'
     | 'withdrawn'
     | null;
+  /**
+   * Decision outcome: approved/refused/split-decision/granted/partially_consented/quashed/redetermination/withdrawn/revoked
+   */
+  dcoStatus?:
+    | 'approved'
+    | 'refused'
+    | 'split-decision'
+    | 'granted'
+    | 'partially_consented'
+    | 'quashed'
+    | 'redetermination'
+    | 'withdrawn'
+    | 'revoked'
+    | null;
   publishStatus: 'published' | 'unpublished' | null;
   /**
    * {Sector Abbreviation} - {Sector Display Name}