@defra/forms-model 3.0.431 → 3.0.433

package/schemas/form-metadata-schema.json

@@ -0,0 +1,340 @@
+{
+  "type": "object",
+  "description": "Complete metadata for a form, including version information and authoring details",
+  "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"
+    },
+    "id": {
+      "type": "string",
+      "description": "Unique identifier for the form, 24-character hexadecimal string",
+      "title": "Id"
+    },
+    "slug": {
+      "type": "string",
+      "description": "URL-friendly identifier used in form paths",
+      "pattern": "^[a-z0-9-]+$",
+      "title": "Slug"
+    },
+    "draft": {
+      "type": "object",
+      "description": "Metadata for the draft version",
+      "properties": {
+        "createdAt": {
+          "type": "string",
+          "description": "When this version was first created",
+          "format": "date-time",
+          "title": "Created At"
+        },
+        "createdBy": {
+          "type": "object",
+          "description": "Who created this version",
+          "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,
+          "title": "Created By"
+        },
+        "updatedAt": {
+          "type": "string",
+          "description": "When this version was last updated",
+          "format": "date-time",
+          "title": "Updated At"
+        },
+        "updatedBy": {
+          "type": "object",
+          "description": "Who last updated this version",
+          "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,
+          "title": "Updated By"
+        }
+      },
+      "required": [
+        "createdAt",
+        "createdBy",
+        "updatedAt",
+        "updatedBy"
+      ],
+      "additionalProperties": false,
+      "title": "Draft"
+    },
+    "live": {
+      "type": "object",
+      "description": "Metadata for the published version",
+      "properties": {
+        "createdAt": {
+          "type": "string",
+          "description": "When this version was first created",
+          "format": "date-time",
+          "title": "Created At"
+        },
+        "createdBy": {
+          "type": "object",
+          "description": "Who created this version",
+          "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,
+          "title": "Created By"
+        },
+        "updatedAt": {
+          "type": "string",
+          "description": "When this version was last updated",
+          "format": "date-time",
+          "title": "Updated At"
+        },
+        "updatedBy": {
+          "type": "object",
+          "description": "Who last updated this version",
+          "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,
+          "title": "Updated By"
+        }
+      },
+      "required": [
+        "createdAt",
+        "createdBy",
+        "updatedAt",
+        "updatedBy"
+      ],
+      "additionalProperties": false,
+      "title": "Live"
+    },
+    "createdAt": {
+      "type": "string",
+      "description": "When the form was first created",
+      "format": "date-time",
+      "title": "Created At"
+    },
+    "createdBy": {
+      "type": "object",
+      "description": "Who created the form",
+      "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,
+      "title": "Created By"
+    },
+    "updatedAt": {
+      "type": "string",
+      "description": "When the form was last updated",
+      "format": "date-time",
+      "title": "Updated At"
+    },
+    "updatedBy": {
+      "type": "object",
+      "description": "Who last updated the form",
+      "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,
+      "title": "Updated By"
+    }
+  },
+  "required": [
+    "title",
+    "organisation",
+    "teamName",
+    "teamEmail",
+    "id",
+    "slug",
+    "createdAt",
+    "createdBy",
+    "updatedAt",
+    "updatedBy"
+  ],
+  "additionalProperties": false,
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Form Metadata Schema",
+  "$id": "@defra/forms-model/schemas/form-metadata-schema.json"
+}

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

@@ -0,0 +1,72 @@
+{
+  "type": "object",
+  "description": "Metadata about a specific version state (draft or live)",
+  "properties": {
+    "createdAt": {
+      "type": "string",
+      "description": "When this version was first created",
+      "format": "date-time",
+      "title": "Created At"
+    },
+    "createdBy": {
+      "type": "object",
+      "description": "Who created this version",
+      "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,
+      "title": "Created By"
+    },
+    "updatedAt": {
+      "type": "string",
+      "description": "When this version was last updated",
+      "format": "date-time",
+      "title": "Updated At"
+    },
+    "updatedBy": {
+      "type": "object",
+      "description": "Who last updated this version",
+      "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,
+      "title": "Updated By"
+    }
+  },
+  "required": [
+    "createdAt",
+    "createdBy",
+    "updatedAt",
+    "updatedBy"
+  ],
+  "additionalProperties": false,
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Form Metadata State Schema",
+  "$id": "@defra/forms-model/schemas/form-metadata-state-schema.json"
+}

package/schemas/form-submit-payload-schema.json

@@ -0,0 +1,124 @@
+{
+  "type": "object",
+  "description": "Complete form submission payload structure with all form data",
+  "properties": {
+    "retrievalKey": {
+      "type": "string",
+      "description": "Unique key to retrieve this submission later",
+      "title": "Retrieval Key"
+    },
+    "sessionId": {
+      "type": "string",
+      "description": "User session identifier for tracking and security",
+      "title": "Session Id"
+    },
+    "main": {
+      "type": "array",
+      "description": "Main (non-repeating) field values from the form",
+      "items": {
+        "type": "object",
+        "description": "Individual field value in a form submission",
+        "properties": {
+          "name": {
+            "type": "string",
+            "description": "Field identifier matching the component name",
+            "title": "Name"
+          },
+          "title": {
+            "type": "string",
+            "description": "Human-readable label for the field",
+            "title": "Title"
+          },
+          "value": {
+            "type": "string",
+            "description": "User-submitted value for the field, may be empty",
+            "title": "Value"
+          }
+        },
+        "required": [
+          "name",
+          "title",
+          "value"
+        ],
+        "additionalProperties": false,
+        "title": "Main Item"
+      },
+      "title": "Main"
+    },
+    "repeaters": {
+      "type": "array",
+      "description": "Repeatable section values from the form",
+      "items": {
+        "type": "object",
+        "description": "Collection of repeated field values from a repeatable section",
+        "properties": {
+          "name": {
+            "type": "string",
+            "description": "Identifier for the repeatable section",
+            "title": "Name"
+          },
+          "title": {
+            "type": "string",
+            "description": "Human-readable title for the repeatable section",
+            "title": "Title"
+          },
+          "value": {
+            "type": "array",
+            "description": "Array of record arrays, each representing a repeated instance",
+            "items": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "description": "Individual field value in a form submission",
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "description": "Field identifier matching the component name",
+                    "title": "Name"
+                  },
+                  "title": {
+                    "type": "string",
+                    "description": "Human-readable label for the field",
+                    "title": "Title"
+                  },
+                  "value": {
+                    "type": "string",
+                    "description": "User-submitted value for the field, may be empty",
+                    "title": "Value"
+                  }
+                },
+                "required": [
+                  "name",
+                  "title",
+                  "value"
+                ],
+                "additionalProperties": false,
+                "title": "Value  Item Item"
+              },
+              "title": "Value Item"
+            },
+            "title": "Value"
+          }
+        },
+        "required": [
+          "name",
+          "title",
+          "value"
+        ],
+        "additionalProperties": false,
+        "title": "Repeaters Item"
+      },
+      "title": "Repeaters"
+    }
+  },
+  "required": [
+    "retrievalKey",
+    "sessionId",
+    "main",
+    "repeaters"
+  ],
+  "additionalProperties": false,
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Form Submit Payload Schema",
+  "$id": "@defra/forms-model/schemas/form-submit-payload-schema.json"
+}

package/schemas/form-submit-record-schema.json

@@ -0,0 +1,30 @@
+{
+  "type": "object",
+  "description": "Individual field value in a form submission",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "Field identifier matching the component name",
+      "title": "Name"
+    },
+    "title": {
+      "type": "string",
+      "description": "Human-readable label for the field",
+      "title": "Title"
+    },
+    "value": {
+      "type": "string",
+      "description": "User-submitted value for the field, may be empty",
+      "title": "Value"
+    }
+  },
+  "required": [
+    "name",
+    "title",
+    "value"
+  ],
+  "additionalProperties": false,
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Form Submit Record Schema",
+  "$id": "@defra/forms-model/schemas/form-submit-record-schema.json"
+}

package/schemas/form-submit-recordset-schema.json

@@ -0,0 +1,62 @@
+{
+  "type": "object",
+  "description": "Collection of repeated field values from a repeatable section",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "Identifier for the repeatable section",
+      "title": "Name"
+    },
+    "title": {
+      "type": "string",
+      "description": "Human-readable title for the repeatable section",
+      "title": "Title"
+    },
+    "value": {
+      "type": "array",
+      "description": "Array of record arrays, each representing a repeated instance",
+      "items": {
+        "type": "array",
+        "items": {
+          "type": "object",
+          "description": "Individual field value in a form submission",
+          "properties": {
+            "name": {
+              "type": "string",
+              "description": "Field identifier matching the component name",
+              "title": "Name"
+            },
+            "title": {
+              "type": "string",
+              "description": "Human-readable label for the field",
+              "title": "Title"
+            },
+            "value": {
+              "type": "string",
+              "description": "User-submitted value for the field, may be empty",
+              "title": "Value"
+            }
+          },
+          "required": [
+            "name",
+            "title",
+            "value"
+          ],
+          "additionalProperties": false,
+          "title": "Value  Item Item"
+        },
+        "title": "Value Item"
+      },
+      "title": "Value"
+    }
+  },
+  "required": [
+    "name",
+    "title",
+    "value"
+  ],
+  "additionalProperties": false,
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Form Submit Recordset Schema",
+  "$id": "@defra/forms-model/schemas/form-submit-recordset-schema.json"
+}