fix: rename Result to PreAssessment

examples/data/ldcE.ts

@@ -322,7 +322,7 @@ export const validLDCE: Schema = {
       date: {},
     },
   },
-  result: [
+  preAssessment: [
     {
       value: 'Planning permission / Immune',
       description:

examples/data/ldcP.ts

@@ -242,7 +242,7 @@ export const validLDCP: Schema = {
       },
     },
   },
-  result: [
+  preAssessment: [
     {
       value: 'Planning permission / Permitted development',
       description:

examples/data/planningPermission.ts

@@ -405,7 +405,7 @@ export const validPlanningPermission: Schema = {
       },
     },
   },
-  result: [],
+  preAssessment: [],
   responses: [
     {
       question: 'Is the property in Lambeth?',

examples/data/priorApproval.ts

@@ -263,7 +263,7 @@ export const validPriorApproval: Schema = {
       },
     },
   },
-  result: [
+  preAssessment: [
     {
       value: 'Planning permission / Prior approval',
       description:

schema/schema.json

@@ -5362,6 +5362,14 @@
       ],
       "type": "object"
     },
+    "PreAssessment": {
+      "$id": "#PreAssessment",
+      "description": "The result of the application based on information provided by the applicant, prior to assessment by a planning officer. Results are determined by flags corresponding to responses; each application can have up to one result per flagset",
+      "items": {
+        "$ref": "#/definitions/ResultFlag"
+      },
+      "type": "array"
+    },
     "ProjectType": {
       "$id": "#ProjectType",
       "anyOf": [
@@ -17571,14 +17579,6 @@
       },
       "type": "array"
     },
-    "Result": {
-      "$id": "#Result",
-      "description": "The result of the application. Results are determined by flags corresponding to responses; each application can have up to one result per flagset",
-      "items": {
-        "$ref": "#/definitions/ResultFlag"
-      },
-      "type": "array"
-    },
     "ResultFlag": {
       "$id": "#ResultFlag",
       "anyOf": [
@@ -18827,19 +18827,18 @@
     "metadata": {
       "$ref": "#/definitions/Metadata"
     },
+    "preAssessment": {
+      "$ref": "#/definitions/PreAssessment"
+    },
     "responses": {
       "$ref": "#/definitions/Responses"
-    },
-    "result": {
-      "$ref": "#/definitions/Result"
     }
   },
   "required": [
     "data",
-    "result",
-    "metadata",
     "responses",
-    "files"
+    "files",
+    "metadata"
   ],
   "title": "Digital Planning Application",
   "type": "object"

types/Schema.ts

@@ -1,12 +1,12 @@
-import {Result} from './schema/Result';
+import {File} from './schema/File';
 import {Metadata} from './schema/Metadata';
+import {PreAssessment} from './schema/PreAssessment';
 import {Responses} from './schema/Responses';
 import {Applicant} from './schema/data/Applicant';
 import {Application} from './schema/data/Application';
 import {Property} from './schema/data/Property';
 import {Proposal} from './schema/data/Proposal';
 import {User} from './schema/data/User';
-import {File} from './schema/File';
 
 /**
  * @title Digital Planning Application
@@ -20,8 +20,8 @@ export interface Schema {
     property: Property;
     proposal: Proposal;
   };
-  result: Result;
-  metadata: Metadata;
+  preAssessment?: PreAssessment;
   responses: Responses;
   files: File[];
+  metadata: Metadata;
 }

types/schema/PreAssessment.ts

@@ -0,0 +1,24 @@
+import {Flags} from '../enums/Flags';
+
+/**
+ * @id #PreAssessment
+ * @description The result of the application based on information provided by the applicant, prior to assessment by a planning officer. Results are determined by flags corresponding to responses; each application can have up to one result per flagset
+ */
+export type PreAssessment = ResultFlag[]; // @todo validate/restrict array to one result per flagset
+
+type FlagKeys = keyof typeof Flags;
+
+type GenericFlag<TKey extends FlagKeys> = {
+  value: TKey;
+  description: (typeof Flags)[TKey];
+};
+
+type FlagMap = {
+  [K in FlagKeys]: GenericFlag<K>;
+};
+
+/**
+ * @id #ResultFlag
+ * @description The result of a single flagset
+ */
+export type ResultFlag = FlagMap[keyof FlagMap];