@divvydiary/divvydiary-json-schemas 0.7.1

package/.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm test
+npx pretty-quick --staged

package/.prettierrc

@@ -0,0 +1,3 @@
+{
+  "tabWidth": 2
+}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 DivvyDiary
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/index.js

@@ -0,0 +1,15 @@
+const article = require("./src/schemas/article.json");
+const defs = require("./src/schemas/defs.json");
+const dividend = require("./src/schemas/dividend.json");
+const split = require("./src/schemas/split.json");
+const symbol = require("./src/schemas/symbol.json");
+const user = require("./src/schemas/user.json");
+
+module.exports = {
+  article,
+  defs,
+  dividend,
+  split,
+  symbol,
+  user,
+};

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@divvydiary/divvydiary-json-schemas",
+  "version": "0.7.1",
+  "description": "JSON Schemas for DivvyDiary.com",
+  "main": "index.js",
+  "scripts": {
+    "docs": "jsonschema2md -d src/schemas -o docs -e json -x -",
+    "preversion": "npm test",
+    "version": "npm run docs && git add -A docs",
+    "postversion": "git push && git push --tags",
+    "test": "node test.js",
+    "prepare": "husky install"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/DivvyDiary/divvydiary-json-schemas.git"
+  },
+  "author": "DivvyDiary <info@divvydiary.com> (https://divvydiary.com)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/DivvyDiary/divvydiary-json-schemas/issues"
+  },
+  "homepage": "https://github.com/DivvyDiary/divvydiary-json-schemas#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@adobe/jsonschema2md": "^6.1.1",
+    "ajv": "^8.6.2",
+    "ajv-formats": "^2.1.1",
+    "glob": "^7.1.7",
+    "husky": "^7.0.1",
+    "prettier": "^2.3.2",
+    "pretty-quick": "^3.1.1"
+  }
+}

package/src/schemas/article.json

@@ -0,0 +1,30 @@
+{
+  "$id": "https://divvydiary.com/schemas/article.json",
+  "type": "object",
+  "title": "Article",
+  "properties": {
+    "id": {
+      "type": "number",
+      "minimum": 1,
+      "maximum": 4294967295
+    },
+    "date": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "title": {
+      "type": "string",
+      "minLength": 3,
+      "maxLength": 255
+    },
+    "abstract": {
+      "type": "string",
+      "minLength": 3
+    },
+    "fulltext": {
+      "type": "string",
+      "minLength": 3
+    }
+  },
+  "required": ["abstract", "date", "fulltext", "id", "title"]
+}

package/src/schemas/defs.json

@@ -0,0 +1,284 @@
+{
+  "$id": "https://divvydiary.com/schemas/defs.json",
+  "title": "Definitions",
+  "definitions": {
+    "currency": {
+      "type": "string",
+      "enum": [
+        "AED",
+        "AFN",
+        "ALL",
+        "AMD",
+        "ANG",
+        "AOA",
+        "ARS",
+        "AUD",
+        "AWG",
+        "AZN",
+        "BAM",
+        "BBD",
+        "BDT",
+        "BGN",
+        "BHD",
+        "BIF",
+        "BMD",
+        "BND",
+        "BOB",
+        "BRL",
+        "BSD",
+        "BTC",
+        "BTN",
+        "BWP",
+        "BYN",
+        "BYR",
+        "BZD",
+        "CAD",
+        "CDF",
+        "CHF",
+        "CLF",
+        "CLP",
+        "CNY",
+        "COP",
+        "CRC",
+        "CUC",
+        "CUP",
+        "CVE",
+        "CZK",
+        "DJF",
+        "DKK",
+        "DOP",
+        "DZD",
+        "EGP",
+        "ERN",
+        "ETB",
+        "EUR",
+        "FJD",
+        "FKP",
+        "GBP",
+        "GEL",
+        "GGP",
+        "GHS",
+        "GIP",
+        "GMD",
+        "GNF",
+        "GTQ",
+        "GYD",
+        "HKD",
+        "HNL",
+        "HRK",
+        "HTG",
+        "HUF",
+        "IDR",
+        "ILS",
+        "IMP",
+        "INR",
+        "IQD",
+        "IRR",
+        "ISK",
+        "JEP",
+        "JMD",
+        "JOD",
+        "JPY",
+        "KES",
+        "KGS",
+        "KHR",
+        "KMF",
+        "KPW",
+        "KRW",
+        "KWD",
+        "KYD",
+        "KZT",
+        "LAK",
+        "LBP",
+        "LKR",
+        "LRD",
+        "LSL",
+        "LTL",
+        "LVL",
+        "LYD",
+        "MAD",
+        "MDL",
+        "MGA",
+        "MKD",
+        "MMK",
+        "MNT",
+        "MOP",
+        "MRO",
+        "MUR",
+        "MVR",
+        "MWK",
+        "MXN",
+        "MYR",
+        "MZN",
+        "NAD",
+        "NGN",
+        "NIO",
+        "NOK",
+        "NPR",
+        "NZD",
+        "OMR",
+        "PAB",
+        "PEN",
+        "PGK",
+        "PHP",
+        "PKR",
+        "PLN",
+        "PYG",
+        "QAR",
+        "RON",
+        "RSD",
+        "RUB",
+        "RWF",
+        "SAR",
+        "SBD",
+        "SCR",
+        "SDG",
+        "SEK",
+        "SGD",
+        "SHP",
+        "SLL",
+        "SOS",
+        "SRD",
+        "STD",
+        "SVC",
+        "SYP",
+        "SZL",
+        "THB",
+        "TJS",
+        "TMT",
+        "TND",
+        "TOP",
+        "TRY",
+        "TTD",
+        "TWD",
+        "TZS",
+        "UAH",
+        "UGX",
+        "USD",
+        "UYU",
+        "UZS",
+        "VEF",
+        "VND",
+        "VUV",
+        "WST",
+        "XAF",
+        "XAG",
+        "XAU",
+        "XCD",
+        "XDR",
+        "XOF",
+        "XPF",
+        "YER",
+        "ZAR",
+        "ZMK",
+        "ZMW",
+        "ZWL"
+      ]
+    },
+    "exchange": {
+      "type": "string",
+      "enum": [
+        "BATS",
+        "BVCA",
+        "BVMF",
+        "DSMD",
+        "LTS",
+        "MISX",
+        "NEOE",
+        "OTC",
+        "ROCO",
+        "XAMS",
+        "XASX",
+        "XBER",
+        "XBKK",
+        "XBRN",
+        "XBRU",
+        "XBUD",
+        "XBUE",
+        "XCBO",
+        "XCNQ",
+        "XCSE",
+        "XDUB",
+        "XDUS",
+        "XETR",
+        "XFKA",
+        "XFRA",
+        "XHAM",
+        "XHAN",
+        "XHEL",
+        "XHKG",
+        "XICE",
+        "XIDX",
+        "XIST",
+        "XJSE",
+        "XKLS",
+        "XKRX",
+        "XLIS",
+        "XLIT",
+        "XLON",
+        "XMAD",
+        "XMEX",
+        "XMIL",
+        "XMOS",
+        "XMUN",
+        "XNAS",
+        "XNSE",
+        "XNXC",
+        "XNYS",
+        "XNZE",
+        "XOSL",
+        "XPAR",
+        "XPRA",
+        "XRIS",
+        "XSAP",
+        "XSAU",
+        "XSES",
+        "XSGO",
+        "XSHE",
+        "XSHG",
+        "XSTO",
+        "XSTU",
+        "XSWX",
+        "XTAE",
+        "XTAI",
+        "XTAL",
+        "XTKS",
+        "XTSE",
+        "XTSX",
+        "XWAR",
+        "XWBO"
+      ]
+    },
+    "isin": {
+      "type": "string",
+      "minLength": 12,
+      "maxLength": 12,
+      "pattern": "^[A-Z]{2}[A-Z0-9]{9}[0-9]{1}$"
+    },
+    "password": {
+      "type": "string",
+      "minLength": 6
+    },
+    "uuid": {
+      "type": "string",
+      "minLength": 36,
+      "maxLength": 36,
+      "format": "uuid"
+    },
+    "wkn": {
+      "type": "string",
+      "minLength": 6,
+      "maxLength": 6,
+      "pattern": "^[A-Z0-9]{6}$"
+    },
+    "dividendFrequency": {
+      "type": "string",
+      "enum": ["none", "any", "monthly", "quarterly", "biannually", "annually"]
+    },
+    "taxRate": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 1
+    }
+  }
+}

package/src/schemas/dividend.json

@@ -0,0 +1,57 @@
+{
+  "$id": "https://divvydiary.com/schemas/dividend.json",
+  "type": "object",
+  "title": "Dividend",
+  "properties": {
+    "id": {
+      "type": "integer",
+      "minimum": 1
+    },
+    "exDate": {
+      "type": "string",
+      "format": "date"
+    },
+    "payDate": {
+      "type": "string",
+      "format": "date"
+    },
+    "name": {
+      "type": "string",
+      "maxLength": 255
+    },
+    "symbol": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 6
+    },
+    "amount": {
+      "type": "number",
+      "minimum": 0,
+      "multipleOf": 0.000001
+    },
+    "quantity": {
+      "type": "number",
+      "minimum": 0.000001,
+      "multipleOf": 0.000001
+    },
+    "exchangeRate": {
+      "type": "number",
+      "minimum": 0
+    },
+    "taxRate": {
+      "$ref": "https://divvydiary.com/schemas/defs.json#/definitions/taxRate"
+    },
+    "isin": {
+      "$ref": "https://divvydiary.com/schemas/defs.json#/definitions/isin"
+    },
+    "wkn": {
+      "oneOf": [
+        { "$ref": "https://divvydiary.com/schemas/defs.json#/definitions/wkn" },
+        { "type": "null" }
+      ]
+    },
+    "currency": {
+      "$ref": "https://divvydiary.com/schemas/defs.json#/definitions/currency"
+    }
+  }
+}

package/src/schemas/split.json

@@ -0,0 +1,26 @@
+{
+  "$id": "https://divvydiary.com/schemas/split.json",
+  "type": "object",
+  "title": "Stock Split",
+  "properties": {
+    "id": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 4294967295
+    },
+    "date": {
+      "type": "string",
+      "format": "date"
+    },
+    "ratioFrom": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 4294967295
+    },
+    "ratioTo": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 4294967295
+    }
+  }
+}

package/src/schemas/symbol.json

@@ -0,0 +1,68 @@
+{
+  "$id": "https://divvydiary.com/schemas/symbol.json",
+  "type": "object",
+  "title": "Symbol",
+  "properties": {
+    "name": {
+      "type": "string",
+      "maxLength": 255
+    },
+    "symbol": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 6
+    },
+    "isin": {
+      "$ref": "https://divvydiary.com/schemas/defs.json#/definitions/isin"
+    },
+    "wkn": {
+      "oneOf": [
+        { "$ref": "https://divvydiary.com/schemas/defs.json#/definitions/wkn" },
+        { "type": "null" }
+      ]
+    },
+    "exchange": {
+      "$ref": "https://divvydiary.com/schemas/defs.json#/definitions/exchange"
+    },
+    "dividendFrequency": {
+      "$ref": "https://divvydiary.com/schemas/defs.json#/definitions/dividendFrequency"
+    },
+    "taxRate": {
+      "$ref": "https://divvydiary.com/schemas/defs.json#/definitions/taxRate"
+    },
+    "payoutRatio": {
+      "type": ["number", "null"],
+      "minimum": 0,
+      "description": "Payout Ratio *aristocrats only*",
+      "nullable": true
+    },
+    "dividendRate": {
+      "type": ["number", "null"],
+      "minimum": 0,
+      "description": "Forward Annual Payout (FWD) *aristocrats only*",
+      "nullable": true
+    },
+    "dividendYield": {
+      "type": ["number", "null"],
+      "minimum": 0,
+      "description": "Forward Dividend Yield (FWD) *aristocrats only*",
+      "nullable": true
+    },
+    "dividendCagr": {
+      "type": "object",
+      "description": "Dividend Growth Rate (CAGR) *aristocrats only*",
+      "properties": {
+        "1Y": { "type": ["number", "null"] },
+        "2Y": { "type": ["number", "null"] },
+        "3Y": { "type": ["number", "null"] },
+        "4Y": { "type": ["number", "null"] },
+        "5Y": { "type": ["number", "null"] },
+        "6Y": { "type": ["number", "null"] },
+        "7Y": { "type": ["number", "null"] },
+        "8Y": { "type": ["number", "null"] },
+        "9Y": { "type": ["number", "null"] },
+        "10Y": { "type": ["number", "null"] }
+      }
+    }
+  }
+}

package/src/schemas/user.json

@@ -0,0 +1,60 @@
+{
+  "$id": "https://divvydiary.com/schemas/user.json",
+  "type": "object",
+  "title": "User",
+  "properties": {
+    "id": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 4294967295
+    },
+    "email": {
+      "type": "string",
+      "format": "email",
+      "maxLength": 255
+    },
+    "forename": { "type": "string", "maxLength": 255 },
+    "newsletter": { "type": "boolean" },
+    "emailConfirmed": { "type": "boolean" },
+    "currency": {
+      "oneOf": [
+        {
+          "$ref": "https://divvydiary.com/schemas/defs.json#/definitions/currency"
+        },
+        { "type": "null" }
+      ]
+    },
+    "apiKey": {
+      "oneOf": [
+        {
+          "$ref": "https://divvydiary.com/schemas/defs.json#/definitions/uuid"
+        },
+        { "type": "null" }
+      ]
+    },
+    "calendarToken": {
+      "oneOf": [
+        {
+          "$ref": "https://divvydiary.com/schemas/defs.json#/definitions/uuid"
+        },
+        { "type": "null" }
+      ]
+    },
+    "emailNotificationDaily": { "type": "boolean" },
+    "emailNotificationWeekly": { "type": "boolean" },
+    "emailNotificationMonthly": { "type": "boolean" },
+    "pushNotificationDaily": { "type": "boolean" },
+    "shared": { "type": "boolean" },
+    "supporter": { "type": "boolean" },
+    "stripeId": {
+      "type": ["string", "null"],
+      "maxLength": 255
+    },
+    "plan": { "type": "string", "enum": ["free", "monthly", "yearly"] },
+    "taxes": { "type": "boolean" },
+    "defaultTaxRate": {
+      "$ref": "https://divvydiary.com/schemas/defs.json#/definitions/taxRate"
+    },
+    "taxesType": { "type": "string", "enum": ["homo", "hetero"] }
+  }
+}

package/test.js

@@ -0,0 +1,20 @@
+const Ajv = require("ajv").default;
+const addFormats = require("ajv-formats").default;
+
+const glob = require("glob");
+const path = require("path");
+
+var ajv = new Ajv({
+  removeAdditional: true,
+  useDefaults: true,
+  coerceTypes: true,
+});
+addFormats(ajv);
+
+glob.sync(`${__dirname}/src/schemas/*.json`).forEach((file) => {
+  console.log(file);
+
+  const schema = require(path.resolve(file));
+
+  ajv.compile(schema);
+});