@defra/forms-model 3.0.431 → 3.0.432

package/schemas/form-editor-input-check-answers-setting-schema.json

@@ -0,0 +1,18 @@
+{
+  "type": "object",
+  "description": "Configuration for the check-answers page",
+  "properties": {
+    "declarationText": {
+      "type": "string",
+      "description": "Brief description of the question for internal use",
+      "title": "Declaration Text"
+    }
+  },
+  "required": [
+    "declarationText"
+  ],
+  "additionalProperties": false,
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Form Editor Input Check Answers Setting Schema",
+  "$id": "@defra/forms-model/schemas/form-editor-input-check-answers-setting-schema.json"
+}

package/schemas/form-editor-input-page-schema.json

@@ -0,0 +1,41 @@
+{
+  "type": "object",
+  "description": "Input schema for creating a new page in the form editor",
+  "properties": {
+    "pageType": {
+      "type": "string",
+      "description": "Type of page - either a question page or guidance page",
+      "enum": [
+        "question",
+        "guidance"
+      ],
+      "title": "Page Type"
+    },
+    "questionType": {
+      "type": "string",
+      "description": "The high-level type of question, including grouped types",
+      "enum": [
+        "writtenAnswerSub",
+        "dateSub",
+        "UkAddressField",
+        "TelephoneNumberField",
+        "FileUploadField",
+        "EmailAddressField",
+        "listSub",
+        "YesNoField",
+        "CheckboxesField",
+        "RadiosField",
+        "AutocompleteField"
+      ],
+      "title": "Question Type"
+    }
+  },
+  "required": [
+    "pageType",
+    "questionType"
+  ],
+  "additionalProperties": false,
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Form Editor Input Page Schema",
+  "$id": "@defra/forms-model/schemas/form-editor-input-page-schema.json"
+}

package/schemas/form-editor-input-page-settings-schema.json

@@ -0,0 +1,28 @@
+{
+  "type": "object",
+  "description": "Settings for page content and display in the form editor",
+  "properties": {
+    "pageHeadingAndGuidance": {
+      "type": "string",
+      "description": "Combined heading and guidance for the page",
+      "title": "Page Heading And Guidance"
+    },
+    "pageHeading": {
+      "type": "string",
+      "description": "Main heading displayed at the top of the page",
+      "title": "Page Heading"
+    },
+    "guidanceText": {
+      "type": "string",
+      "description": "Guidance text to assist users in completing the page",
+      "title": "Guidance Text"
+    }
+  },
+  "required": [
+    "pageHeading"
+  ],
+  "additionalProperties": false,
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Form Editor Input Page Settings Schema",
+  "$id": "@defra/forms-model/schemas/form-editor-input-page-settings-schema.json"
+}

package/schemas/form-editor-input-question-schema.json

@@ -0,0 +1,38 @@
+{
+  "type": "object",
+  "description": "Input schema for creating or updating a question in the form editor",
+  "properties": {
+    "question": {
+      "type": "string",
+      "description": "The question text displayed to the user",
+      "title": "Question"
+    },
+    "shortDescription": {
+      "type": "string",
+      "description": "Brief description of the question for internal use",
+      "title": "Short Description"
+    },
+    "hintText": {
+      "type": "string",
+      "description": "Optional guidance text displayed below the question",
+      "title": "Hint Text"
+    },
+    "questionOptional": {
+      "type": "string",
+      "description": "Indicates whether a question is optional. Empty string or \"true\" values are accepted.",
+      "enum": [
+        "",
+        "true"
+      ],
+      "title": "Question Optional"
+    }
+  },
+  "required": [
+    "question",
+    "shortDescription"
+  ],
+  "additionalProperties": false,
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Form Editor Input Question Schema",
+  "$id": "@defra/forms-model/schemas/form-editor-input-question-schema.json"
+}

package/schemas/form-metadata-author-schema.json

@@ -0,0 +1,24 @@
+{
+  "type": "object",
+  "description": "Information about the author of a form or form change",
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "Unique identifier for the author",
+      "title": "Id"
+    },
+    "displayName": {
+      "type": "string",
+      "description": "Human-readable name of the author",
+      "title": "Display Name"
+    }
+  },
+  "required": [
+    "id",
+    "displayName"
+  ],
+  "additionalProperties": false,
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Form Metadata Author Schema",
+  "$id": "@defra/forms-model/schemas/form-metadata-author-schema.json"
+}

package/schemas/form-metadata-contact-schema.json

@@ -0,0 +1,61 @@
+{
+  "type": "object",
+  "description": "Complete contact information for form-related inquiries",
+  "properties": {
+    "phone": {
+      "type": "string",
+      "description": "Phone number for form-related inquiries",
+      "title": "Phone"
+    },
+    "email": {
+      "type": "object",
+      "description": "Email contact details including response expectations",
+      "properties": {
+        "address": {
+          "type": "string",
+          "description": "Email address for form-related inquiries",
+          "format": "email",
+          "title": "Address"
+        },
+        "responseTime": {
+          "type": "string",
+          "description": "Expected response time for email inquiries",
+          "title": "Response Time"
+        }
+      },
+      "required": [
+        "address",
+        "responseTime"
+      ],
+      "additionalProperties": false,
+      "title": "Email"
+    },
+    "online": {
+      "type": "object",
+      "description": "Online contact details with URL and descriptive text",
+      "properties": {
+        "url": {
+          "type": "string",
+          "description": "URL for online contact method",
+          "format": "uri",
+          "title": "Url"
+        },
+        "text": {
+          "type": "string",
+          "description": "Descriptive text for the online contact link",
+          "title": "Text"
+        }
+      },
+      "required": [
+        "url",
+        "text"
+      ],
+      "additionalProperties": false,
+      "title": "Online"
+    }
+  },
+  "additionalProperties": false,
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Form Metadata Contact Schema",
+  "$id": "@defra/forms-model/schemas/form-metadata-contact-schema.json"
+}

package/schemas/form-metadata-email-schema.json

@@ -0,0 +1,25 @@
+{
+  "type": "object",
+  "description": "Email contact details including response expectations",
+  "properties": {
+    "address": {
+      "type": "string",
+      "description": "Email address for form-related inquiries",
+      "format": "email",
+      "title": "Address"
+    },
+    "responseTime": {
+      "type": "string",
+      "description": "Expected response time for email inquiries",
+      "title": "Response Time"
+    }
+  },
+  "required": [
+    "address",
+    "responseTime"
+  ],
+  "additionalProperties": false,
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Form Metadata Email Schema",
+  "$id": "@defra/forms-model/schemas/form-metadata-email-schema.json"
+}

package/schemas/form-metadata-input-schema.json

@@ -0,0 +1,127 @@
+{
+  "type": "object",
+  "description": "Input data for creating or updating form metadata",
+  "properties": {
+    "title": {
+      "type": "string",
+      "description": "Title of the form, displayed to users",
+      "maxLength": 250,
+      "title": "Title"
+    },
+    "organisation": {
+      "type": "string",
+      "description": "Defra organisation responsible for the form",
+      "enum": [
+        "Animal and Plant Health Agency – APHA",
+        "Centre for Environment, Fisheries and Aquaculture Science – Cefas",
+        "Defra",
+        "Environment Agency",
+        "Forestry Commission",
+        "Marine Management Organisation – MMO",
+        "Natural England",
+        "Rural Payments Agency – RPA",
+        "Veterinary Medicines Directorate – VMD"
+      ],
+      "title": "Organisation"
+    },
+    "teamName": {
+      "type": "string",
+      "description": "Name of the team responsible for the form",
+      "maxLength": 100,
+      "title": "Team Name"
+    },
+    "teamEmail": {
+      "type": "string",
+      "description": "Contact email for the team responsible for the form",
+      "format": "email",
+      "title": "Team Email"
+    },
+    "contact": {
+      "type": "object",
+      "description": "Complete contact information for form-related inquiries",
+      "properties": {
+        "phone": {
+          "type": "string",
+          "description": "Phone number for form-related inquiries",
+          "title": "Phone"
+        },
+        "email": {
+          "type": "object",
+          "description": "Email contact details including response expectations",
+          "properties": {
+            "address": {
+              "type": "string",
+              "description": "Email address for form-related inquiries",
+              "format": "email",
+              "title": "Address"
+            },
+            "responseTime": {
+              "type": "string",
+              "description": "Expected response time for email inquiries",
+              "title": "Response Time"
+            }
+          },
+          "required": [
+            "address",
+            "responseTime"
+          ],
+          "additionalProperties": false,
+          "title": "Email"
+        },
+        "online": {
+          "type": "object",
+          "description": "Online contact details with URL and descriptive text",
+          "properties": {
+            "url": {
+              "type": "string",
+              "description": "URL for online contact method",
+              "format": "uri",
+              "title": "Url"
+            },
+            "text": {
+              "type": "string",
+              "description": "Descriptive text for the online contact link",
+              "title": "Text"
+            }
+          },
+          "required": [
+            "url",
+            "text"
+          ],
+          "additionalProperties": false,
+          "title": "Online"
+        }
+      },
+      "additionalProperties": false,
+      "title": "Contact"
+    },
+    "submissionGuidance": {
+      "type": "string",
+      "description": "Guidance text shown to users when submitting the form",
+      "title": "Submission Guidance"
+    },
+    "privacyNoticeUrl": {
+      "type": "string",
+      "description": "URL to the privacy notice for this form",
+      "format": "uri",
+      "title": "Privacy Notice Url"
+    },
+    "notificationEmail": {
+      "type": "string",
+      "description": "Email address to receive form submission notifications, must be a .gov.uk or .org.uk address",
+      "format": "email",
+      "pattern": "\\.gov\\.uk$|\\.org\\.uk$",
+      "title": "Notification Email"
+    }
+  },
+  "required": [
+    "title",
+    "organisation",
+    "teamName",
+    "teamEmail"
+  ],
+  "additionalProperties": false,
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Form Metadata Input Schema",
+  "$id": "@defra/forms-model/schemas/form-metadata-input-schema.json"
+}

package/schemas/form-metadata-online-schema.json

@@ -0,0 +1,25 @@
+{
+  "type": "object",
+  "description": "Online contact details with URL and descriptive text",
+  "properties": {
+    "url": {
+      "type": "string",
+      "description": "URL for online contact method",
+      "format": "uri",
+      "title": "Url"
+    },
+    "text": {
+      "type": "string",
+      "description": "Descriptive text for the online contact link",
+      "title": "Text"
+    }
+  },
+  "required": [
+    "url",
+    "text"
+  ],
+  "additionalProperties": false,
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Form Metadata Online Schema",
+  "$id": "@defra/forms-model/schemas/form-metadata-online-schema.json"
+}