turbot-runner-morph 0.0.1

data/schema/schemas/includes/unknown_entity_type.json

@@ -0,0 +1,58 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "description": "An entity of unknown type - potentially a company, a person, government entity, or some unincorporated organisation",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "Name of the entity",
+      "minLength": 1
+    },
+    "jurisdiction": {
+      "type": "string",
+      "description": "Name of the jurisdiction in which the entity is incorporated/domiciled"
+    },
+    "website": {
+      "type": "string",
+      "minLength": 5
+    },
+    "telephone_number": {
+      "type": "string",
+      "minLength": 4
+    },
+    "fax_number": {
+      "type": "string",
+      "minLength": 4
+    },
+    "registered_address": {
+      "$ref": "address.json"
+    },
+    "headquarters_address": {
+      "$ref": "address.json"
+    },
+    "mailing_address": {
+      "$ref": "address.json"
+    },
+    "industry_codes": {
+      "type": "array",
+      "items": {
+        "$ref": "industry_code.json"
+      }
+    },
+    "previous_names": {
+      "type": "array",
+      "items": {
+        "$ref": "previous_name.json"
+      }
+    },
+    "alternative_names": {
+      "type": "array",
+      "items": {
+        "$ref": "alternative_name.json"
+      }
+    }
+  },
+  "required": [
+    "name"
+  ]
+}

data/schema/schemas/licence-schema.json

@@ -0,0 +1,105 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "description": "A Licence is a permission for an entity to do something that would otherwise not be permitted. Note that such permissions are recorded in multiple different ways and to different granularity. In addition categories cross over, for example a pawnborker may be regulated as a retail establishment by a city, but also as a financial institution by a national or regional financial regulator. Sometimes the licence is a simple statement – the government of Rwanda has given a banking licence to a certain bank -- other times it is fine-grained and highly complex (e.g. an extractives licence or the UK FCA licencing scheme). This schema tries to make it easy to submit the former, while not losing granularity of the latter. The object has the name of Rich Licence to distinguish it from Simple Licence, which it is expected to ultimately replace.",
+  "properties": {
+    "licence_holder": {
+      "$ref": "includes/entity.json"
+    },
+    "licence_issuer": {
+      "oneOf": [
+        {
+          "type": [
+            "string",
+            "null"
+          ],
+          "minLength": 2
+        },
+        {
+          "$ref": "includes/organisation.json"
+        }
+      ]
+    },
+    "licenced_location": {
+      "$ref": "includes/address.json"
+    },
+    "licence_number": {
+      "type": "string"
+    },
+    "start_date": {
+      "description": "The issue date of the licence",
+      "type": "string",
+      "format": "date"
+    },
+    "end_date": {
+      "description": "The expiry date of the licence",
+      "type": "string",
+      "format": "date"
+    },
+    "source_url": {
+      "description": "Place where this fact can be verified",
+      "type": "string",
+      "minLength": 1
+    },
+    "confidence": {
+      "description": "Confidence in accuracy of data",
+      "type": "string",
+      "enum": [
+        "HIGH",
+        "MEDIUM",
+        "LOW"
+      ]
+    },
+    "renewal_date": {
+      "type": "string",
+      "format": "date"
+    },
+    "sample_date": {
+      "description": "Date on which we know this to be true (usually date this information was retrieved from the source)",
+      "type": "string",
+      "format": "date"
+    },
+    "licence_url": {
+      "type": "string",
+      "description": "A public URL for the licence"
+    },
+    "jurisdiction_of_licence": {
+      "type": "string",
+      "description": "The area in which this licence is valid"
+    },
+    "status": {
+      "type": "string",
+      "description": "The status of the licence. If the licence is made up of a number of permissions, each of which has a status, store the status in the permissions field instead/as well"
+    },
+    "category": {
+      "description": "Category of licence",
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": [
+          "Financial",
+          "Business",
+          "Extractive"
+        ]
+      }
+    },
+    "permissions": {
+      "type": "array",
+      "items": {
+        "$ref": "includes/permission.json"
+      }
+    },
+    "other_attributes": {
+      "description": "Use for other licence attributes for which we don't yet have curated schema attributes",
+      "type": "object"
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "source_url",
+    "sample_date",
+    "licence_holder",
+    "permissions",
+    "licence_issuer",
+    "jurisdiction_of_licence"
+  ]
+}

data/schema/schemas/primary-data-schema.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "source_url": {
+      "description": "Place where this fact can be verified",
+      "type": "string"
+    },
+    "sample_date": {
+      "description": "Date on which this fact was known to be true",
+      "type": "string",
+      "format": "date"
+    }
+  },
+  "required": [
+    "source_url",
+    "sample_date"
+  ],
+  "additionalProperties": true
+}

data/schema/schemas/share-parcel-schema.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "allOf": [
+    {
+      "$ref": "includes/base-statement.json"
+    },
+    {
+      "properties": {
+        "data": {
+          "items": {
+            "allOf": [
+              {
+                "$ref": "includes/share-parcel-data.json"
+              }
+            ]
+          }
+        }
+      }
+    }
+  ]
+}

data/schema/schemas/simple-financial-payment-schema.json

@@ -0,0 +1,122 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "description": "A Financial Payment is a payment from government to a recipient",
+  "type": "object",
+  "properties": {
+    "source_url": {
+      "description": "Place where this fact can be verified",
+      "type": "string"
+    },
+    "sample_date": {
+      "description": "Date on which this fact was known to be true",
+      "type": "string",
+      "format": "date"
+    },
+    "confidence": {
+      "description": "Confidence in accuracy of data",
+      "type": "string",
+      "enum": [
+        "HIGH",
+        "MEDIUM",
+        "LOW"
+      ]
+    },
+    "company_name": {
+      "description": "Name of the company that received the money",
+      "type": "string"
+    },
+    "company_jurisdiction": {
+      "description": "Jurisdiction where company is based",
+      "type": "string"
+    },
+    "value": {
+      "description": "The amount transacted (e.g. 19.95)",
+      "type": "string"
+    },
+    "payee_name": {
+      "description": "The name of the payee (the entity that received the money)",
+      "type": "string"
+    },
+    "currency": {
+      "description": "The currency of the payment (three letter symbol, e.g. USD, GBP, EUR)",
+      "type": "string"
+    },
+    "date": {
+      "description": "The date on which the payment was made",
+      "type": "date"
+    },
+    "transaction_number": {
+      "description": "The unique identifier for the transaction, scoped to this bot",
+      "type": "string"
+    },
+    "jurisdiction": {
+      "description": "The jurisdiction of the body that made the payment, eg. UK, France, Delaware, Manchester",
+      "type": "string"
+    },
+    "more_details_url": {
+      "description": "A url from which more details can be seen (may be the same as the source_url)",
+      "type": [
+        "string",
+        null
+      ]
+    },
+    "description": {
+      "description": "The description of the transaction as given in the raw data",
+      "type": [
+        "string",
+        null
+      ]
+    },
+    "expense_type": {
+      "description": "The type of expense -- can be either capital, revenue (i.e. current expenditure) or null",
+      "enum": [
+        "capital",
+        "revenue",
+        null
+      ]
+    },
+    "expense_area": {
+      "description": "category (in words) of the expenditure",
+      "type": [
+        "string",
+        null
+      ]
+    },
+    "entity_name": {
+      "description": "The name of the government entity that made the payment, e.g. Environment Agency",
+      "type": "string"
+    },
+    "entity_uri": {
+      "description": "A unique URL (ideally a dereferencable URI) for the government entity",
+      "type": [
+        "string",
+        null
+      ]
+    },
+    "department_name": {
+      "description": "The name of the government department which the entity belongs to (if relevant), e.g. Department of Health",
+      "type": [
+        "string",
+        null
+      ]
+    },
+    "csv_line_number": {
+      "description": "If the source for the data is a CSV file, you can optionally include the line number of the CSV from which this data was retrieved",
+      "type": [
+        "string",
+        null
+      ]
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "source_url",
+    "sample_date",
+    "company_name",
+    "company_jurisdiction",
+    "value",
+    "payee_name",
+    "date",
+    "currency"
+  ]
+}

data/schema/schemas/simple-licence-schema.json

@@ -0,0 +1,82 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "source_url": {
+      "description": "Place where this fact can be verified",
+      "type": "string",
+      "minLength": 1
+    },
+    "sample_date": {
+      "description": "Date on which this fact was known to be true",
+      "type": "string",
+      "format": "date"
+    },
+    "start_date": {
+      "type": "string",
+      "format": "date"
+    },
+    "end_date": {
+      "type": "string",
+      "format": "date"
+    },
+    "confidence": {
+      "description": "Confidence in accuracy of data",
+      "type": "string",
+      "enum": [
+        "HIGH",
+        "MEDIUM",
+        "LOW"
+      ]
+    },
+    "company_name": {
+      "description": "Name of the company holding the licence",
+      "type": "string",
+      "minLength": 1
+    },
+    "company_jurisdiction": {
+      "description": "Jurisdiction where company is based",
+      "type": "string",
+      "minLength": 1
+    },
+    "licence_number": {
+      "description": "Licence number or code",
+      "type": "string"
+    },
+    "jurisdiction_classification": {
+      "description": "Description of how regulator classifies licence",
+      "type": [
+        "string",
+        "array"
+      ]
+    },
+    "regulator": {
+      "description": "The regulating body that issued the licence",
+      "type": "string"
+    },
+    "licence_jurisdiction": {
+      "description": "Jurisdiction for which licence is issued",
+      "type": "string",
+      "minLength": 1
+    },
+    "status": {
+      "description": "Status of the licence",
+      "type": "string"
+    },
+    "category": {
+      "description": "Category of licence",
+      "type": "string",
+      "enum": [
+        "Financial",
+        "Business"
+      ]
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "source_url",
+    "sample_date",
+    "company_name",
+    "company_jurisdiction"
+  ]
+}

data/schema/schemas/simple-subsidiary-schema.json

@@ -0,0 +1,85 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "source_url": {
+      "description": "Place where this fact can be verified",
+      "type": "string",
+      "minLength": 1
+    },
+    "sample_date": {
+      "description": "Date on which this fact was known to be true",
+      "type": "string",
+      "format": "date"
+    },
+    "start_date": {
+      "description": "Earliest known date this was known to be a subsidiary",
+      "type": "string",
+      "format": "date"
+    },
+    "end_date": {
+      "description": "Latest known date this was known to be a subsidiary",
+      "type": "string",
+      "format": "date"
+    },
+    "confidence": {
+      "description": "Confidence in accuracy of data",
+      "type": "string",
+      "enum": [
+        "HIGH",
+        "MEDIUM",
+        "LOW"
+      ]
+    },
+    "parent_name": {
+      "description": "Name of the controlling company",
+      "type": "string",
+      "minLength": 1
+    },
+    "parent_jurisdiction": {
+      "description": "Jurisdiction where controlling company is based",
+      "type": "string",
+      "minLength": 1
+    },
+    "parent_identifier": {
+      "description": "Any unique ID for the controlling company",
+      "type": "string"
+    },
+    "direct": {
+      "description": "Is the control relationship direct or indirect (if unknown, leave blank)?",
+      "type": "boolean"
+    },
+    "percentage_controlled": {
+      "description": "Percentage of the subsidiary that is controlled (if known), either directly or indirectly",
+      "type": "string",
+      "pattern": "^[0-9]{1,2}0?[.]?[0-9]{0,2}$"
+    },
+    "subsidiary_name": {
+      "description": "The name of the subsidiary",
+      "type": "string",
+      "minLength": 1
+    },
+    "subsidiary_jurisdiction": {
+      "description": "Jurisdiction of the subsidiary",
+      "type": "string",
+      "minLength": 1
+    },
+    "subsidiary_identifier": {
+      "description": "Any unique id for the subsidiary that might be provided in the source",
+      "type": "string"
+    }
+  },
+  "other_attributes": {
+    "description": "Use for other attributes for which we don't yet have curated schema attributes",
+    "type": "object"
+  },
+  "additionalProperties": false,
+  "required": [
+    "source_url",
+    "sample_date",
+    "parent_name",
+    "parent_jurisdiction",
+    "subsidiary_name",
+    "subsidiary_jurisdiction"
+  ]
+}