metadata_presenter 0.1.2 → 0.1.3

data/schemas/definition/link_list.json

@@ -0,0 +1,30 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/definition/link_list",
+  "_name": "definition.link_list",
+  "title": "Link list definition",
+  "type": "object",
+  "properties": {
+    "title": {
+      "title": "Title",
+      "description": "Title/heading to display",
+      "type": "string",
+      "content": true
+    },
+    "items": {
+      "title": "Items",
+      "description": "Items that make up list",
+      "type": "array",
+      "items": {
+        "$ref": "link"
+      }
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "definition.block"
+    }
+  ],
+  "category": [
+    "definition"
+  ]
+}

data/schemas/definition/name.json

@@ -0,0 +1,18 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/definition/name",
+  "_name": "definition.name",
+  "idSeed": "name",
+  "title": "Name definition",
+  "properties": {
+    "name": {
+      "title": "Input name",
+      "description": "Used by system to identify user's answer - also used as the component's HTML name property.",
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9-_]+$",
+      "processInput": true,
+      "category": [
+        "userinput"
+      ]
+    }
+  }
+}

data/schemas/definition/namespace.json

@@ -0,0 +1,28 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/definition/namespace",
+  "_name": "definition.namespace",
+  "title": "Namespace definition",
+  "type": "object",
+  "properties": {
+    "namespace": {
+      "title": "Namespace",
+      "description": "Namespace under which to store user inputs - combines with input names of child components",
+      "type": "string",
+      "category": [
+        "userinput"
+      ]
+    },
+    "namespace_protect": {
+      "title": "Namespace protection",
+      "description": "Whether to prevent the component’s namespace being overridden or appended",
+      "type": "boolean",
+      "default": false,
+      "category": [
+        "userinput"
+      ]
+    }
+  },
+  "category": [
+    "definition"
+  ]
+}

data/schemas/definition/next_page.json

@@ -0,0 +1,40 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/definition/nextpage",
+  "_name": "definition.nextpage",
+  "title": "Next page",
+  "description": "What page (or pages) to go to next, and under what conditions. Only use if what you’re trying to achieve is impossible or extremely difficult using page steps",
+  "oneOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "array",
+      "items": {
+        "oneOf": [
+          {
+            "type": "object",
+            "properties": {
+              "page": {
+                "type": "string"
+              },
+              "condition": {
+                "$ref": "definition.conditional.boolean"
+              }
+            },
+            "required": [
+              "page",
+              "condition"
+            ]
+          },
+          {
+            "type": "string"
+          }
+        ]
+      }
+    }
+  ],
+  "category": [
+    "logic",
+    "definition"
+  ]
+}

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"
+  ]
+}