metadata_presenter 0.1.0 → 0.1.5

data/schemas/definition/page.content.json

@@ -0,0 +1,23 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/definition/page/content",
+  "_name": "definition.page.content",
+  "title": "Content page definition",
+  "properties": {
+    "components": {
+      "accepts": [
+        "content"
+      ]
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "definition.page"
+    }
+  ],
+  "required": [
+    "heading"
+  ],
+  "category": [
+    "contentPage"
+  ]
+}

data/schemas/definition/page.form.json

@@ -0,0 +1,96 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/definition/page/form",
+  "_name": "definition.page.form",
+  "title": "Form page definition",
+  "properties": {
+    "extra_components": {
+      "title": "Additional components",
+      "description": "Components following continue button",
+      "type": "array",
+      "items": {
+        "$ref": "definition.component"
+      },
+      "accepts": [
+        "content"
+      ],
+      "category": [
+        "additional"
+      ]
+    },
+    "section_heading": {
+      "title": "Section heading",
+      "description": "Name of section",
+      "type": "string",
+      "content": true,
+      "category": [
+        "content"
+      ]
+    },
+    "section_heading_summary": {
+      "title": "Section heading (Summary version)",
+      "description": "A condensed version of the section heading, for use on the 'check your answers' page",
+      "type": "string",
+      "content": true,
+      "category": [
+        "content"
+      ]
+    },
+    "heading_summary": {
+      "title": "Heading (Summary version)",
+      "description": "A condensed version of the page heading, for use on the 'check your answers' page",
+      "type": "string",
+      "content": true,
+      "category": [
+        "content"
+      ]
+    },
+    "steps_heading": {
+      "title": "Steps heading",
+      "description": "Name of section to use on step pages (if any)",
+      "type": "string",
+      "category": [
+        "content"
+      ]
+    },
+    "steps": {
+      "title": "Steps",
+      "description": "The ‘child’ pages that follow from this ‘parent’ page",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "enable_steps": {
+      "title": "Enable steps",
+      "description": "Allow current page to have steps",
+      "type": "boolean"
+    },
+    "show_steps": {
+      "title": "Steps visibility",
+      "category": [
+        "logic"
+      ],
+      "description": "Whether to show or hide the page’s steps",
+      "oneOf": [
+        {
+          "$ref": "definition.conditional.boolean"
+        }
+      ],
+      "default": true
+    },
+    "nextPage": {
+      "$ref": "definition.next_page"
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "definition.page"
+    },
+    {
+      "$ref": "definition.repeatable"
+    }
+  ],
+  "category": [
+    "form_page"
+  ]
+}

data/schemas/definition/page.json

@@ -0,0 +1,109 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/definition/page",
+  "_name": "definition.page",
+  "id_seed": "url",
+  "title": "Page definition",
+  "properties": {
+    "url": {
+      "title": "URL",
+      "description": "The page’s relative url - it must not contain any spaces",
+      "type": "string",
+      "pattern": "^[\\w\\-_\\/]+$"
+    },
+    "heading": {
+      "title": "Heading",
+      "description": "The page’s top-level heading (H1) - appears at the top of the page",
+      "type": "string",
+      "content": true
+    },
+    "title": {
+      "title": "Title",
+      "description": "The text to use as the page’s title in the document title element - uses heading value by default",
+      "type": "string",
+      "content": true,
+      "category": [
+        "content"
+      ]
+    },
+    "lede": {
+      "title": "First paragraph",
+      "description": "Introductory paragraph after the heading (it‘s also known as the ‘lede’) - use [markdown](https://www.gov.uk/guidance/how-to-publish-on-gov-uk/markdown) to format text or add hyperlinks",
+      "type": "string",
+      "content": true,
+      "category": [
+        "content"
+      ]
+    },
+    "body": {
+      "title": "Content",
+      "description": "Free-form content after the heading and first paragraph - use [markdown](https://www.gov.uk/guidance/how-to-publish-on-gov-uk/markdown) to format text or add hyperlinks",
+      "type": "string",
+      "content": true,
+      "multiline": true,
+      "category": [
+        "content"
+      ]
+    },
+    "cookie_message": {
+      "title": "Cookie message",
+      "description": "Set dynamically - exists here to enable formatting of value",
+      "type": "string",
+      "content": true,
+      "default": "[% cookie.message %]",
+      "category": [
+        "dynamic"
+      ]
+    },
+    "action_type": {
+      "title": "Primary action",
+      "description": "Text for primary action button",
+      "type": "string",
+      "enum": [
+        "continue",
+        "save_continue",
+        "save",
+        "confirm",
+        "send.email",
+        "send.sms",
+        "custom-1",
+        "custom-2",
+        "custom-3",
+        "custom-4",
+        "custom-5"
+      ],
+      "default": "continue",
+      "category": [
+        "additional"
+      ]
+    },
+    "back_link": {
+      "title": "Back link text",
+      "type": "string",
+      "default": "[% link.back %]",
+      "content": true,
+      "category": [
+        "additional"
+      ]
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "definition.block"
+    },
+    {
+      "$ref": "definition.components"
+    }
+  ],
+  "required": [
+    "url"
+  ],
+  "category": [
+    "definition",
+    "page"
+  ],
+  "transforms": {
+    "namespace": {
+      "propagation": "components[?(@.$control || @.$grouping)]"
+    }
+  }
+}

data/schemas/definition/page.singlequestion.json

@@ -0,0 +1,31 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/page/singlequestion",
+  "_name": "page.singlequestion",
+  "title": "Single question",
+  "description": "Ask users one question on a page (you can make the question repeatable for additional answers)",
+  "type": "object",
+  "properties": {
+    "_type": {
+      "const": "page.singlequestion"
+    },
+    "components": {
+      "maxItems": 1,
+      "accepts": [
+        "control"
+      ]
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "definition.page.form"
+    }
+  ],
+  "required": [
+    "components"
+  ],
+  "surplus_properties": [
+    "heading",
+    "lede",
+    "body"
+  ]
+}

data/schemas/definition/repeatable.json

@@ -0,0 +1,72 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/definition/repeatable",
+  "_name": "definition.repeatable",
+  "title": "Repeatable definition",
+  "type": "object",
+  "properties": {
+    "repeatable": {
+      "title": "Repeatable",
+      "description": "Whether the page or component lets users ‘add another’ answer",
+      "type": "boolean"
+    },
+    "repeatable_minimum": {
+      "title": "Minimum number of repeatable items",
+      "description": "For example, if users must give at least 3 answers, set this to 3 - the page will show 3 inputs when it loads",
+      "type": "number",
+      "minimum": 0,
+      "default": 1,
+      "category": [
+        "repeatable"
+      ]
+    },
+    "repeatable_maximum": {
+      "title": "Maximum number of repeatable items",
+      "description": "For example, if users can give up to 5 answers, set this to 5",
+      "type": "number",
+      "minimum": 0,
+      "category": [
+        "repeatable"
+      ]
+    },
+    "repeatable_heading": {
+      "title": "Repeatable section heading",
+      "description": "Heading for repeatable items - appears once before the components",
+      "type": "string",
+      "category": [
+        "repeatable"
+      ]
+    },
+    "repeatable_lede": {
+      "title": "Repeatable section first paragraph",
+      "description": "Introductory paragraph - follows the heading",
+      "type": "string",
+      "category": [
+        "repeatable"
+      ]
+    },
+    "repeatable_add": {
+      "title": "Text to add another answer",
+      "description": "Specify the link text for users to add another answer - defaults to ‘Add another’",
+      "type": "string",
+      "category": [
+        "repeatable"
+      ]
+    },
+    "repeatable_delete": {
+      "title": "Text to remove an answer",
+      "description": "Specify the link text for users to delete an answer - defaults to ‘Remove’",
+      "type": "string",
+      "category": [
+        "repeatable"
+      ]
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "definition.namespace"
+    }
+  ],
+  "category": [
+    "definition"
+  ]
+}

data/schemas/definition/width_class.input.json

@@ -0,0 +1,48 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/definition/width_class/input",
+  "_name": "definition.width_class.input",
+  "title": "Input width class definition",
+  "properties": {
+    "width_class_input": {
+      "title": "Input width",
+      "description": "How wide the input should be visually",
+      "type": "string",
+      "enum_map": {
+        "2": "2 characters",
+        "3": "3 characters",
+        "4": "4 characters",
+        "5": "5 characters",
+        "10": "10 characters",
+        "20": "20 characters",
+        "30": "30 characters",
+        "one-quarter": "One quarter",
+        "one-third": "One third",
+        "one-half": "One half",
+        "two-thirds": "Two thirds",
+        "three-quarters": "Three quarters",
+        "full": "Full width"
+      },
+      "enum": [
+        "2",
+        "3",
+        "4",
+        "5",
+        "10",
+        "20",
+        "30",
+        "one-quarter",
+        "one-third",
+        "one-half",
+        "two-thirds",
+        "three-quarters",
+        "full"
+      ],
+      "category": [
+        "html_attributes"
+      ]
+    }
+  },
+  "category": [
+    "definition"
+  ]
+}

data/schemas/definition/width_class.json

@@ -0,0 +1,34 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/definition/width_class",
+  "_name": "definition.width_class",
+  "title": "Width class definition",
+  "properties": {
+    "width_class": {
+      "title": "Width",
+      "description": "How wide the component should be visually",
+      "type": "string",
+      "enum_map": {
+        "one-quarter": "One quarter",
+        "one-third": "One third",
+        "one-half": "One half",
+        "two-thirds": "Two thirds",
+        "three-quarters": "Three quarters",
+        "full": "Full width"
+      },
+      "enum": [
+        "one-quarter",
+        "one-third",
+        "one-half",
+        "two-thirds",
+        "three-quarters",
+        "full"
+      ],
+      "category": [
+        "html_attributes"
+      ]
+    }
+  },
+  "category": [
+    "definition"
+  ]
+}

data/schemas/errors/errors.json

@@ -0,0 +1,139 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/errors",
+  "_name": "errors",
+  "title": "Error strings",
+  "type": "object",
+  "definitions": {
+    "error_strings": {
+      "type": "object",
+      "properties": {
+        "any": {
+          "type": "string"
+        }
+      }
+    },
+    "required": {
+      "title": "Error strings for required",
+      "allOf": [
+        {
+          "$ref": "#/definitions/error_strings"
+        }
+      ]
+    },
+    "min_length": {
+      "title": "Error strings for minimum length",
+      "allOf": [
+        {
+          "$ref": "#/definitions/error_strings"
+        }
+      ]
+    },
+    "max_length": {
+      "title": "Error strings for maximum length",
+      "allOf": [
+        {
+          "$ref": "#/definitions/error_strings"
+        }
+      ]
+    },
+    "pattern": {
+      "title": "Error strings for pattern",
+      "allOf": [
+        {
+          "$ref": "#/definitions/error_strings"
+        }
+      ]
+    },
+    "multiple_of": {
+      "title": "Error strings for multiple of",
+      "allOf": [
+        {
+          "$ref": "#/definitions/error_strings"
+        }
+      ]
+    },
+    "maximum": {
+      "title": "Error strings for maximum",
+      "allOf": [
+        {
+          "$ref": "#/definitions/error_strings"
+        }
+      ]
+    },
+    "exclusive_maximum": {
+      "title": "Error strings for exclusive maximum",
+      "allOf": [
+        {
+          "$ref": "#/definitions/error_strings"
+        }
+      ]
+    },
+    "minimum": {
+      "title": "Error strings for minimum",
+      "allOf": [
+        {
+          "$ref": "#/definitions/error_strings"
+        }
+      ]
+    },
+    "exclusive_minimum": {
+      "title": "Error strings for exclusive minimum",
+      "allOf": [
+        {
+          "$ref": "#/definitions/error_strings"
+        }
+      ]
+    },
+    "required_errors": {
+      "properties": {
+        "errors": {
+          "properties": {
+            "required": {
+              "$ref": "#/definitions/required"
+            }
+          }
+        }
+      }
+    },
+    "string_errors": {
+      "properties": {
+        "errors": {
+          "properties": {
+            "min_length": {
+              "$ref": "#/definitions/min_length"
+            },
+            "max_length": {
+              "$ref": "#/definitions/max_length"
+            },
+            "pattern": {
+              "$ref": "#/definitions/pattern"
+            }
+          }
+        }
+      }
+    },
+    "number_errors": {
+      "properties": {
+        "errors": {
+          "properties": {
+            "multiple_of": {
+              "$ref": "#/definitions/multiple_of"
+            },
+            "maximum": {
+              "$ref": "#/definitions/maximum"
+            },
+            "exclusive_maximum": {
+              "$ref": "#/definitions/exclusive_maximum"
+            },
+            "minimum": {
+              "$ref": "#/definitions/minimum"
+            },
+            "exclusive_minimum": {
+              "$ref": "#/definitions/exclusive_minimum"
+            }
+          }
+        }
+      }
+    }
+  }
+}