metadata_presenter 0.1.0 → 0.1.5

data/lib/metadata_presenter/version.rb

@@ -1,3 +1,3 @@
 module MetadataPresenter
-  VERSION = '0.1.0'
+  VERSION = '0.1.5'
 end

data/schemas/condition/condition.json

@@ -0,0 +1,48 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/condition",
+  "_name": "condition",
+  "title": "Condition",
+  "type": "object",
+  "allOf": [
+    {
+      "properties": {
+        "_id": {
+          "title": "Condition ID",
+          "type": "string"
+        },
+        "_type": {
+          "title": "Type",
+          "type": "string",
+          "const": "condition"
+        },
+        "description": {
+          "title": "Description",
+          "type": "string"
+        },
+        "negated": {
+          "title": "Negated",
+          "type": "boolean"
+        }
+      }
+    },
+    {
+      "oneOf": [
+        {
+          "$ref": "definition.condition.expression"
+        },
+        {
+          "$ref": "definition.conditions.all"
+        },
+        {
+          "$ref": "definition.conditions.any"
+        },
+        {
+          "$ref": "definition.conditions.exactly"
+        }
+      ]
+    }
+  ],
+  "category": [
+    "definition"
+  ]
+}

data/schemas/config/meta.json

@@ -0,0 +1,27 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/config/meta",
+  "_name": "config.meta",
+  "title": "Form meta links",
+  "description": "List of links to display in GOVUK footer",
+  "usage": "Use the config.meta component to provide a list of links in the footer",
+  "type": "object",
+  "allOf": [
+    {
+      "$ref": "definition.link_list"
+    }
+  ],
+  "properties": {
+    "_id": {
+      "const": "config.meta"
+    },
+    "_type": {
+      "const": "config.meta"
+    },
+    "title": {
+      "type": "null"
+    }
+  },
+  "category": [
+    "configuration"
+  ]
+}

data/schemas/config/service.json

@@ -0,0 +1,106 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/config/service",
+  "title": "Service configuration options",
+  "_name": "config.service",
+  "description": "Configuration options for a service",
+  "type": "object",
+  "properties": {
+    "_id": {
+      "const": "config.service"
+    },
+    "_type": {
+      "const": "config.service"
+    },
+    "homepage_url": {
+      "title": "Homepage URL",
+      "description": "The Homepage URL of the service",
+      "type": "string"
+    },
+    "service_email_address": {
+      "title": "Service Email Address",
+      "description": "The email address of the service",
+      "type": "string"
+    },
+    "service_url": {
+      "title": "Service URL",
+      "description": "The URL of the first page of the service",
+      "type": "string"
+    },
+    "phase": {
+      "title": "Form phase",
+      "type": "string",
+      "enum": [
+        "none",
+        "alpha",
+        "beta"
+      ],
+      "default": "alpha"
+    },
+    "phase_text": {
+      "title": "Form phase text",
+      "type": "string",
+      "content": true
+    },
+    "code": {
+      "title": "Form code",
+      "description": "Code used for form (eg. C100)",
+      "type": "string"
+    },
+    "pdf_heading": {
+      "title": "PDF heading",
+      "description": "Used as form’s heading when generating PDF output",
+      "type": "string"
+    },
+    "pdf_sub_heading": {
+      "title": "PDF subheading",
+      "description": "Used as form’s subheading when generating PDF output",
+      "type": "string"
+    },
+    "email_input_name_user": {
+      "title": "CC email address field",
+      "description": "Name of input used as email address to send user a copy of submission details",
+      "type": "string"
+    },
+    "attach_user_submission": {
+      "title": "Attach confirmation of submission to user email",
+      "type": "boolean",
+      "default": false
+    },
+    "email_subject_user": {
+      "title": "CC email subject",
+      "type": "string"
+    },
+    "email_template_user": {
+      "title": "CC email template",
+      "type": "string",
+      "multiline": true
+    },
+    "email_subject_team": {
+      "title": "Form team email subject",
+      "type": "string"
+    },
+    "email_template_team": {
+      "title": "Form team email template",
+      "type": "string",
+      "multiline": true
+    },
+    "session_duration": {
+      "title": "Session duration",
+      "description": "How many minutes a user’s session should last",
+      "type": "number"
+    },
+    "data_retention_duration": {
+      "title": "User data retention duration",
+      "description": "How many days a user’s data should be kept for",
+      "type": "number"
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "definition.data"
+    }
+  ],
+  "category": [
+    "configuration"
+  ]
+}

data/schemas/definition/block.json

@@ -0,0 +1,28 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/definition/block",
+  "_name": "definition.block",
+  "title": "Block definition",
+  "properties": {
+    "show": {
+      "title": "Visibility",
+      "category": [
+        "logic"
+      ],
+      "description": "Whether to show or hide the page/component",
+      "oneOf": [
+        {
+          "$ref": "definition.conditional.boolean"
+        }
+      ],
+      "default": true
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "definition.data"
+    }
+  ],
+  "category": [
+    "definition"
+  ]
+}

data/schemas/definition/component.json

@@ -0,0 +1,13 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/definition/component",
+  "_name": "definition.component",
+  "title": "Component definition",
+  "allOf": [
+    {
+      "$ref": "definition.block"
+    }
+  ],
+  "category": [
+    "component"
+  ]
+}

data/schemas/definition/components.json

@@ -0,0 +1,15 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/definition/components",
+  "_name": "definition.components",
+  "title": "Components definition",
+  "properties": {
+    "components": {
+      "title": "Components",
+      "description": "The form or content elements used on the page",
+      "type": "array",
+      "items": {
+        "$ref": "definition.component"
+      }
+    }
+  }
+}

data/schemas/definition/condition.base.json

@@ -0,0 +1,25 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/definition/condition/base",
+  "_name": "definition.condition.base",
+  "title": "Base condition properties",
+  "properties": {
+    "identifier": {
+      "title": "Identifier",
+      "type": "string"
+    },
+    "identifier_type": {
+      "title": "Identifier type",
+      "type": "string",
+      "enum": [
+        "input",
+        "feature"
+      ]
+    }
+  },
+  "required": [
+    "identifier"
+  ],
+  "category": [
+    "definition"
+  ]
+}

data/schemas/definition/condition.boolean.json

@@ -0,0 +1,25 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/definition/condition/boolean",
+  "_name": "definition.condition.boolean",
+  "title": "Boolean condition properties",
+  "allOf": [
+    {
+      "$ref": "definition.condition.base"
+    }
+  ],
+  "properties": {
+    "operator": {
+      "title": "Operator",
+      "type": "string",
+      "enum": [
+        "isTrue"
+      ]
+    }
+  },
+  "required": [
+    "operator"
+  ],
+  "category": [
+    "definition"
+  ]
+}

data/schemas/definition/condition.defined.json

@@ -0,0 +1,25 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/definition/condition/defined",
+  "_name": "definition.condition.defined",
+  "title": "Defined condition properties",
+  "allOf": [
+    {
+      "$ref": "definition.condition.base"
+    }
+  ],
+  "properties": {
+    "operator": {
+      "title": "Operator",
+      "type": "string",
+      "enum": [
+        "defined"
+      ]
+    }
+  },
+  "required": [
+    "operator"
+  ],
+  "category": [
+    "definition"
+  ]
+}

data/schemas/definition/condition.expression.json

@@ -0,0 +1,22 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/definition/condition/expression",
+  "_name": "definition.condition.expression",
+  "title": "Single expression condition properties",
+  "oneOf": [
+    {
+      "$ref": "definition.condition.defined"
+    },
+    {
+      "$ref": "definition.condition.text"
+    },
+    {
+      "$ref": "definition.condition.number"
+    },
+    {
+      "$ref": "definition.condition.boolean"
+    }
+  ],
+  "category": [
+    "definition"
+  ]
+}

data/schemas/definition/condition.number.json

@@ -0,0 +1,49 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/definition/condition/number",
+  "_name": "definition.condition.number",
+  "title": "Number condition properties",
+  "allOf": [
+    {
+      "$ref": "definition.condition.base"
+    }
+  ],
+  "properties": {
+    "operator": {
+      "title": "Operator",
+      "type": "string",
+      "enum": [
+        "equals",
+        "greater_than",
+        "greater_than_or_equal_to",
+        "less_than",
+        "less_than_or_equal_to",
+        "multiple_of"
+      ]
+    },
+    "value": {
+      "title": "Value"
+    }
+  },
+  "if": {
+    "required": [
+      "value_type"
+    ]
+  },
+  "then": {
+    "$ref": "definition.condition.value_type"
+  },
+  "else": {
+    "properties": {
+      "value": {
+        "type": "number"
+      }
+    }
+  },
+  "required": [
+    "operator",
+    "value"
+  ],
+  "category": [
+    "definition"
+  ]
+}

data/schemas/definition/condition.text.json

@@ -0,0 +1,48 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/definition/condition/text",
+  "_name": "definition.condition.text",
+  "title": "Text condition properties",
+  "allOf": [
+    {
+      "$ref": "definition.condition.base"
+    }
+  ],
+  "properties": {
+    "operator": {
+      "title": "Operator",
+      "type": "string",
+      "enum": [
+        "is",
+        "starts_with",
+        "ends_with",
+        "includes",
+        "match"
+      ]
+    },
+    "value": {
+      "title": "Value"
+    }
+  },
+  "if": {
+    "required": [
+      "value_type"
+    ]
+  },
+  "then": {
+    "$ref": "definition.condition.value_type"
+  },
+  "else": {
+    "properties": {
+      "value": {
+        "type": "string"
+      }
+    }
+  },
+  "required": [
+    "operator",
+    "value"
+  ],
+  "category": [
+    "definition"
+  ]
+}