@baron1996/kline-scene-schema 0.1.0

package/schema/chart-scene.schema.json

@@ -0,0 +1,198 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://baron.dev/kline-scene/chart-scene.schema.json",
+  "title": "ChartScene",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "schema",
+    "version",
+    "runtime",
+    "symbol",
+    "period",
+    "data",
+    "chart",
+    "panes",
+    "overlays",
+    "viewport",
+    "render",
+    "metadata"
+  ],
+  "properties": {
+    "schema": {
+      "const": "@baron1996/kline-scene"
+    },
+    "version": {
+      "const": 1
+    },
+    "runtime": {
+      "$ref": "https://baron.dev/kline-scene/runtime.schema.json"
+    },
+    "symbol": {
+      "$ref": "#/$defs/symbol"
+    },
+    "period": {
+      "$ref": "#/$defs/period"
+    },
+    "data": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 1000000,
+      "items": {
+        "$ref": "https://baron.dev/kline-scene/market-data.schema.json"
+      }
+    },
+    "chart": {
+      "$ref": "https://baron.dev/kline-scene/chart-config.schema.json"
+    },
+    "panes": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 32,
+      "items": {
+        "$ref": "https://baron.dev/kline-scene/pane.schema.json"
+      }
+    },
+    "overlays": {
+      "type": "array",
+      "maxItems": 10000,
+      "items": {
+        "$ref": "https://baron.dev/kline-scene/overlay.schema.json"
+      }
+    },
+    "viewport": {
+      "$ref": "#/$defs/viewport"
+    },
+    "render": {
+      "$ref": "#/$defs/render"
+    },
+    "metadata": {
+      "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/metadata"
+    }
+  },
+  "$defs": {
+    "symbol": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "ticker",
+        "pricePrecision",
+        "volumePrecision"
+      ],
+      "properties": {
+        "ticker": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "pricePrecision": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 16
+        },
+        "volumePrecision": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 16
+        }
+      }
+    },
+    "period": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "span",
+        "type"
+      ],
+      "properties": {
+        "span": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 100000
+        },
+        "type": {
+          "enum": [
+            "second",
+            "minute",
+            "hour",
+            "day",
+            "week",
+            "month",
+            "year"
+          ]
+        }
+      }
+    },
+    "viewport": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "barSpace",
+        "rightOffsetDistance",
+        "anchorTimestamp"
+      ],
+      "properties": {
+        "barSpace": {
+          "type": "number",
+          "minimum": 1,
+          "maximum": 100
+        },
+        "rightOffsetDistance": {
+          "type": "number",
+          "minimum": 0,
+          "maximum": 10000
+        },
+        "anchorTimestamp": {
+          "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/safeInteger"
+        }
+      }
+    },
+    "render": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "width",
+        "height",
+        "deviceScaleFactor",
+        "background",
+        "fontFamily",
+        "timeoutMs"
+      ],
+      "properties": {
+        "width": {
+          "type": "integer",
+          "minimum": 320,
+          "maximum": 8192
+        },
+        "height": {
+          "type": "integer",
+          "minimum": 240,
+          "maximum": 8192
+        },
+        "deviceScaleFactor": {
+          "type": "number",
+          "minimum": 0.5,
+          "maximum": 4
+        },
+        "background": {
+          "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/rgbaColor"
+        },
+        "fontFamily": {
+          "enum": [
+            "Baron Sans"
+          ]
+        },
+        "timeoutMs": {
+          "type": "integer",
+          "minimum": 100,
+          "maximum": 120000
+        }
+      }
+    }
+  }
+}

package/schema/common.schema.json

@@ -0,0 +1,156 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://baron.dev/kline-scene/common.schema.json",
+  "title": "ChartScene Common Types",
+  "$defs": {
+    "stableId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "pattern": "^[A-Za-z][A-Za-z0-9._:-]*$"
+    },
+    "finiteNumber": {
+      "type": "number",
+      "minimum": -1.7976931348623157e+308,
+      "maximum": 1.7976931348623157e+308
+    },
+    "safeInteger": {
+      "type": "integer",
+      "minimum": -9007199254740991,
+      "maximum": 9007199254740991
+    },
+    "nonNegativeNumber": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 1.7976931348623157e+308
+    },
+    "rgbaColor": {
+      "type": "string",
+      "pattern": "^rgba\\(\\s*[0-9]{1,3}\\s*,\\s*[0-9]{1,3}\\s*,\\s*[0-9]{1,3}\\s*,\\s*(?:0(?:\\.[0-9]+)?|1(?:\\.0+)?)\\s*\\)$"
+    },
+    "lineStyle": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "color",
+        "size",
+        "style"
+      ],
+      "properties": {
+        "color": {
+          "$ref": "#/$defs/rgbaColor"
+        },
+        "size": {
+          "type": "number",
+          "exclusiveMinimum": 0,
+          "maximum": 20
+        },
+        "style": {
+          "enum": [
+            "solid",
+            "dashed",
+            "dotted"
+          ]
+        }
+      }
+    },
+    "fillStyle": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "color"
+      ],
+      "properties": {
+        "color": {
+          "$ref": "#/$defs/rgbaColor"
+        }
+      }
+    },
+    "textStyle": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "color",
+        "size",
+        "family",
+        "weight",
+        "backgroundColor",
+        "borderColor"
+      ],
+      "properties": {
+        "color": {
+          "$ref": "#/$defs/rgbaColor"
+        },
+        "size": {
+          "type": "number",
+          "minimum": 8,
+          "maximum": 72
+        },
+        "family": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128
+        },
+        "weight": {
+          "oneOf": [
+            {
+              "type": "integer",
+              "minimum": 100,
+              "maximum": 900,
+              "multipleOf": 100
+            },
+            {
+              "enum": [
+                "normal",
+                "bold"
+              ]
+            }
+          ]
+        },
+        "backgroundColor": {
+          "$ref": "#/$defs/rgbaColor"
+        },
+        "borderColor": {
+          "$ref": "#/$defs/rgbaColor"
+        }
+      }
+    },
+    "jsonValue": {
+      "oneOf": [
+        {
+          "type": "null"
+        },
+        {
+          "type": "boolean"
+        },
+        {
+          "$ref": "#/$defs/finiteNumber"
+        },
+        {
+          "type": "string"
+        },
+        {
+          "type": "array",
+          "maxItems": 1000,
+          "items": {
+            "$ref": "#/$defs/jsonValue"
+          }
+        },
+        {
+          "type": "object",
+          "maxProperties": 1000,
+          "additionalProperties": {
+            "$ref": "#/$defs/jsonValue"
+          }
+        }
+      ]
+    },
+    "metadata": {
+      "type": "object",
+      "maxProperties": 1000,
+      "additionalProperties": {
+        "$ref": "#/$defs/jsonValue"
+      }
+    }
+  }
+}

package/schema/indicator.schema.json

@@ -0,0 +1,146 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://baron.dev/kline-scene/indicator.schema.json",
+  "title": "SceneIndicator",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "id",
+    "name",
+    "paneId",
+    "yAxisId",
+    "calcParams",
+    "precision",
+    "visible",
+    "zLevel",
+    "styles"
+  ],
+  "properties": {
+    "id": {
+      "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/stableId"
+    },
+    "name": {
+      "enum": [
+        "MA",
+        "EMA",
+        "SMA",
+        "BBI",
+        "VOL",
+        "MACD",
+        "BOLL",
+        "KDJ",
+        "RSI",
+        "BIAS",
+        "BRAR",
+        "CCI",
+        "DMI",
+        "CR",
+        "PSY",
+        "DMA",
+        "TRIX",
+        "OBV",
+        "VR",
+        "WR",
+        "MTM",
+        "EMV",
+        "SAR",
+        "AO",
+        "ROC",
+        "PVT",
+        "AVP"
+      ]
+    },
+    "paneId": {
+      "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/stableId"
+    },
+    "yAxisId": {
+      "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/stableId"
+    },
+    "calcParams": {
+      "type": "array",
+      "maxItems": 8,
+      "items": {
+        "type": "number",
+        "exclusiveMinimum": 0,
+        "maximum": 100000
+      }
+    },
+    "precision": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 16
+    },
+    "visible": {
+      "type": "boolean"
+    },
+    "zLevel": {
+      "type": "integer",
+      "minimum": -1000,
+      "maximum": 1000
+    },
+    "styles": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "lines",
+        "bars",
+        "circles"
+      ],
+      "properties": {
+        "lines": {
+          "type": "array",
+          "maxItems": 16,
+          "items": {
+            "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/lineStyle"
+          }
+        },
+        "bars": {
+          "type": "array",
+          "maxItems": 16,
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "upColor",
+              "downColor",
+              "noChangeColor"
+            ],
+            "properties": {
+              "upColor": {
+                "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/rgbaColor"
+              },
+              "downColor": {
+                "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/rgbaColor"
+              },
+              "noChangeColor": {
+                "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/rgbaColor"
+              }
+            }
+          }
+        },
+        "circles": {
+          "type": "array",
+          "maxItems": 16,
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "color",
+              "radius"
+            ],
+            "properties": {
+              "color": {
+                "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/rgbaColor"
+              },
+              "radius": {
+                "type": "number",
+                "exclusiveMinimum": 0,
+                "maximum": 20
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/schema/market-data.schema.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://baron.dev/kline-scene/market-data.schema.json",
+  "title": "MarketData",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "timestamp",
+    "open",
+    "high",
+    "low",
+    "close"
+  ],
+  "properties": {
+    "timestamp": {
+      "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/safeInteger"
+    },
+    "open": {
+      "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/finiteNumber"
+    },
+    "high": {
+      "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/finiteNumber"
+    },
+    "low": {
+      "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/finiteNumber"
+    },
+    "close": {
+      "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/finiteNumber"
+    },
+    "volume": {
+      "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/nonNegativeNumber"
+    },
+    "turnover": {
+      "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/nonNegativeNumber"
+    }
+  }
+}