@baron1996/kline-scene-schema 0.2.3 → 0.4.0

package/schema/drawing-document.schema.json

@@ -0,0 +1,811 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://baron.dev/kline-scene/drawing-document.schema.json",
+  "title": "DrawingDocument",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "schema",
+    "version",
+    "scopeKey",
+    "coordinateSystem",
+    "drawings",
+    "metadata"
+  ],
+  "properties": {
+    "schema": {
+      "const": "@baron1996/drawing-document"
+    },
+    "version": {
+      "const": 1
+    },
+    "scopeKey": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256
+    },
+    "coordinateSystem": {
+      "$ref": "#/$defs/coordinateSystem"
+    },
+    "drawings": {
+      "type": "array",
+      "maxItems": 10000,
+      "items": {
+        "$ref": "#/$defs/drawing"
+      }
+    },
+    "metadata": {
+      "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/metadata"
+    }
+  },
+  "$defs": {
+    "coordinateSystem": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "timezone",
+        "valueAxes"
+      ],
+      "properties": {
+        "timezone": {
+          "$ref": "#/$defs/timezone"
+        },
+        "valueAxes": {
+          "$ref": "#/$defs/valueAxes"
+        }
+      }
+    },
+    "timezone": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "pattern": "^[A-Za-z_+-]+(?:/[A-Za-z0-9_+-]+)*$"
+    },
+    "valueAxes": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 64,
+      "items": {
+        "$ref": "#/$defs/valueAxis"
+      }
+    },
+    "valueAxis": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "paneRole",
+        "yAxisRole",
+        "valuePrecision"
+      ],
+      "properties": {
+        "paneRole": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128
+        },
+        "yAxisRole": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128
+        },
+        "valuePrecision": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 16
+        }
+      }
+    },
+    "target": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "paneRole",
+        "yAxisRole"
+      ],
+      "properties": {
+        "paneRole": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128
+        },
+        "yAxisRole": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128
+        }
+      }
+    },
+    "drawingStyles": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "line",
+        "fill",
+        "text"
+      ],
+      "properties": {
+        "line": {
+          "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/lineStyle"
+        },
+        "fill": {
+          "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/fillStyle"
+        },
+        "text": {
+          "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/textStyle"
+        }
+      }
+    },
+    "drawingBase": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "target",
+        "visible",
+        "locked",
+        "zLevel",
+        "mode",
+        "styles"
+      ],
+      "properties": {
+        "id": {
+          "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/stableId"
+        },
+        "groupId": {
+          "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/stableId"
+        },
+        "target": {
+          "$ref": "#/$defs/target"
+        },
+        "visible": {
+          "type": "boolean"
+        },
+        "locked": {
+          "type": "boolean"
+        },
+        "zLevel": {
+          "type": "integer",
+          "minimum": -1000,
+          "maximum": 1000
+        },
+        "mode": {
+          "enum": [
+            "normal",
+            "weak_magnet",
+            "strong_magnet"
+          ]
+        },
+        "styles": {
+          "$ref": "#/$defs/drawingStyles"
+        },
+        "metadata": {
+          "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/metadata"
+        }
+      }
+    },
+    "drawingTimeAnchor": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "timestamp",
+        "granularity"
+      ],
+      "properties": {
+        "timestamp": {
+          "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/safeInteger"
+        },
+        "granularity": {
+          "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/period"
+        }
+      }
+    },
+    "timeValuePoint": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "timestamp",
+        "granularity",
+        "value"
+      ],
+      "properties": {
+        "timestamp": {
+          "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/safeInteger"
+        },
+        "granularity": {
+          "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/period"
+        },
+        "value": {
+          "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/finiteNumber"
+        }
+      }
+    },
+    "geometryValue": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "value"
+      ],
+      "properties": {
+        "value": {
+          "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/finiteNumber"
+        }
+      }
+    },
+    "geometryValueText": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "value",
+        "text"
+      ],
+      "properties": {
+        "value": {
+          "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/finiteNumber"
+        },
+        "text": {
+          "type": "string",
+          "maxLength": 4096
+        }
+      }
+    },
+    "geometryTime": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "time"
+      ],
+      "properties": {
+        "time": {
+          "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/safeInteger"
+        }
+      }
+    },
+    "geometryValueSpan": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "value",
+        "startTime",
+        "endTime"
+      ],
+      "properties": {
+        "value": {
+          "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/finiteNumber"
+        },
+        "startTime": {
+          "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/safeInteger"
+        },
+        "endTime": {
+          "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/safeInteger"
+        }
+      }
+    },
+    "geometryTimeSpan": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "time",
+        "startValue",
+        "endValue"
+      ],
+      "properties": {
+        "time": {
+          "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/safeInteger"
+        },
+        "startValue": {
+          "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/finiteNumber"
+        },
+        "endValue": {
+          "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/finiteNumber"
+        }
+      }
+    },
+    "geometryTwoPoints": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "points"
+      ],
+      "properties": {
+        "points": {
+          "type": "array",
+          "minItems": 2,
+          "maxItems": 2,
+          "items": {
+            "$ref": "#/$defs/timeValuePoint"
+          }
+        }
+      }
+    },
+    "geometryThreePoints": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "points"
+      ],
+      "properties": {
+        "points": {
+          "type": "array",
+          "minItems": 3,
+          "maxItems": 3,
+          "items": {
+            "$ref": "#/$defs/timeValuePoint"
+          }
+        }
+      }
+    },
+    "geometryBrushPoints": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "points"
+      ],
+      "properties": {
+        "points": {
+          "type": "array",
+          "minItems": 2,
+          "maxItems": 256,
+          "items": {
+            "$ref": "#/$defs/timeValuePoint"
+          }
+        }
+      }
+    },
+    "geometryPointText": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "point",
+        "text"
+      ],
+      "properties": {
+        "point": {
+          "$ref": "#/$defs/timeValuePoint"
+        },
+        "text": {
+          "type": "string",
+          "maxLength": 4096
+        }
+      }
+    },
+    "geometryPoint": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "point"
+      ],
+      "properties": {
+        "point": {
+          "$ref": "#/$defs/timeValuePoint"
+        }
+      }
+    },
+    "geometryStartEnd": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "start",
+        "end"
+      ],
+      "properties": {
+        "start": {
+          "$ref": "#/$defs/timeValuePoint"
+        },
+        "end": {
+          "$ref": "#/$defs/timeValuePoint"
+        }
+      }
+    },
+    "drawing": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "target",
+        "visible",
+        "locked",
+        "zLevel",
+        "mode",
+        "styles",
+        "type",
+        "geometry"
+      ],
+      "properties": {
+        "id": {
+          "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/stableId"
+        },
+        "groupId": {
+          "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/stableId"
+        },
+        "target": {
+          "$ref": "#/$defs/target"
+        },
+        "visible": {
+          "type": "boolean"
+        },
+        "locked": {
+          "type": "boolean"
+        },
+        "zLevel": {
+          "type": "integer",
+          "minimum": -1000,
+          "maximum": 1000
+        },
+        "mode": {
+          "enum": [
+            "normal",
+            "weak_magnet",
+            "strong_magnet"
+          ]
+        },
+        "styles": {
+          "$ref": "#/$defs/drawingStyles"
+        },
+        "metadata": {
+          "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/metadata"
+        },
+        "type": {
+          "enum": [
+            "horizontalStraightLine",
+            "priceLine",
+            "simpleTag",
+            "verticalStraightLine",
+            "horizontalRayLine",
+            "horizontalSegment",
+            "verticalRayLine",
+            "verticalSegment",
+            "rayLine",
+            "segment",
+            "straightLine",
+            "fibonacciLine",
+            "priceChannelLine",
+            "parallelStraightLine",
+            "brush",
+            "simpleAnnotation",
+            "callout",
+            "text",
+            "crossLine",
+            "rectangle",
+            "arrow",
+            "priceMeasurement"
+          ]
+        },
+        "geometry": {
+          "type": "object"
+        }
+      },
+      "oneOf": [
+        {
+          "title": "DrawingHorizontalStraightLine",
+          "properties": {
+            "type": {
+              "const": "horizontalStraightLine"
+            },
+            "geometry": {
+              "$ref": "#/$defs/geometryValue"
+            }
+          },
+          "required": [
+            "type",
+            "geometry"
+          ]
+        },
+        {
+          "title": "DrawingPriceLine",
+          "properties": {
+            "type": {
+              "const": "priceLine"
+            },
+            "geometry": {
+              "$ref": "#/$defs/geometryValue"
+            }
+          },
+          "required": [
+            "type",
+            "geometry"
+          ]
+        },
+        {
+          "title": "DrawingSimpleTag",
+          "properties": {
+            "type": {
+              "const": "simpleTag"
+            },
+            "geometry": {
+              "$ref": "#/$defs/geometryValueText"
+            }
+          },
+          "required": [
+            "type",
+            "geometry"
+          ]
+        },
+        {
+          "title": "DrawingVerticalStraightLine",
+          "properties": {
+            "type": {
+              "const": "verticalStraightLine"
+            },
+            "geometry": {
+              "$ref": "#/$defs/geometryTime"
+            }
+          },
+          "required": [
+            "type",
+            "geometry"
+          ]
+        },
+        {
+          "title": "DrawingHorizontalRayLine",
+          "properties": {
+            "type": {
+              "const": "horizontalRayLine"
+            },
+            "geometry": {
+              "$ref": "#/$defs/geometryValueSpan"
+            }
+          },
+          "required": [
+            "type",
+            "geometry"
+          ]
+        },
+        {
+          "title": "DrawingHorizontalSegment",
+          "properties": {
+            "type": {
+              "const": "horizontalSegment"
+            },
+            "geometry": {
+              "$ref": "#/$defs/geometryValueSpan"
+            }
+          },
+          "required": [
+            "type",
+            "geometry"
+          ]
+        },
+        {
+          "title": "DrawingVerticalRayLine",
+          "properties": {
+            "type": {
+              "const": "verticalRayLine"
+            },
+            "geometry": {
+              "$ref": "#/$defs/geometryTimeSpan"
+            }
+          },
+          "required": [
+            "type",
+            "geometry"
+          ]
+        },
+        {
+          "title": "DrawingVerticalSegment",
+          "properties": {
+            "type": {
+              "const": "verticalSegment"
+            },
+            "geometry": {
+              "$ref": "#/$defs/geometryTimeSpan"
+            }
+          },
+          "required": [
+            "type",
+            "geometry"
+          ]
+        },
+        {
+          "title": "DrawingRayLine",
+          "properties": {
+            "type": {
+              "const": "rayLine"
+            },
+            "geometry": {
+              "$ref": "#/$defs/geometryTwoPoints"
+            }
+          },
+          "required": [
+            "type",
+            "geometry"
+          ]
+        },
+        {
+          "title": "DrawingSegment",
+          "properties": {
+            "type": {
+              "const": "segment"
+            },
+            "geometry": {
+              "$ref": "#/$defs/geometryTwoPoints"
+            }
+          },
+          "required": [
+            "type",
+            "geometry"
+          ]
+        },
+        {
+          "title": "DrawingStraightLine",
+          "properties": {
+            "type": {
+              "const": "straightLine"
+            },
+            "geometry": {
+              "$ref": "#/$defs/geometryTwoPoints"
+            }
+          },
+          "required": [
+            "type",
+            "geometry"
+          ]
+        },
+        {
+          "title": "DrawingFibonacciLine",
+          "properties": {
+            "type": {
+              "const": "fibonacciLine"
+            },
+            "geometry": {
+              "$ref": "#/$defs/geometryTwoPoints"
+            }
+          },
+          "required": [
+            "type",
+            "geometry"
+          ]
+        },
+        {
+          "title": "DrawingPriceChannelLine",
+          "properties": {
+            "type": {
+              "const": "priceChannelLine"
+            },
+            "geometry": {
+              "$ref": "#/$defs/geometryThreePoints"
+            }
+          },
+          "required": [
+            "type",
+            "geometry"
+          ]
+        },
+        {
+          "title": "DrawingParallelStraightLine",
+          "properties": {
+            "type": {
+              "const": "parallelStraightLine"
+            },
+            "geometry": {
+              "$ref": "#/$defs/geometryThreePoints"
+            }
+          },
+          "required": [
+            "type",
+            "geometry"
+          ]
+        },
+        {
+          "title": "DrawingBrush",
+          "properties": {
+            "type": {
+              "const": "brush"
+            },
+            "geometry": {
+              "$ref": "#/$defs/geometryBrushPoints"
+            }
+          },
+          "required": [
+            "type",
+            "geometry"
+          ]
+        },
+        {
+          "title": "DrawingSimpleAnnotation",
+          "properties": {
+            "type": {
+              "const": "simpleAnnotation"
+            },
+            "geometry": {
+              "$ref": "#/$defs/geometryPointText"
+            }
+          },
+          "required": [
+            "type",
+            "geometry"
+          ]
+        },
+        {
+          "title": "DrawingCallout",
+          "properties": {
+            "type": {
+              "const": "callout"
+            },
+            "geometry": {
+              "$ref": "#/$defs/geometryPointText"
+            }
+          },
+          "required": [
+            "type",
+            "geometry"
+          ]
+        },
+        {
+          "title": "DrawingText",
+          "properties": {
+            "type": {
+              "const": "text"
+            },
+            "geometry": {
+              "$ref": "#/$defs/geometryPointText"
+            }
+          },
+          "required": [
+            "type",
+            "geometry"
+          ]
+        },
+        {
+          "title": "DrawingCrossLine",
+          "properties": {
+            "type": {
+              "const": "crossLine"
+            },
+            "geometry": {
+              "$ref": "#/$defs/geometryPoint"
+            }
+          },
+          "required": [
+            "type",
+            "geometry"
+          ]
+        },
+        {
+          "title": "DrawingRectangle",
+          "properties": {
+            "type": {
+              "const": "rectangle"
+            },
+            "geometry": {
+              "$ref": "#/$defs/geometryStartEnd"
+            }
+          },
+          "required": [
+            "type",
+            "geometry"
+          ]
+        },
+        {
+          "title": "DrawingArrow",
+          "properties": {
+            "type": {
+              "const": "arrow"
+            },
+            "geometry": {
+              "$ref": "#/$defs/geometryStartEnd"
+            }
+          },
+          "required": [
+            "type",
+            "geometry"
+          ]
+        },
+        {
+          "title": "DrawingPriceMeasurement",
+          "properties": {
+            "type": {
+              "const": "priceMeasurement"
+            },
+            "geometry": {
+              "$ref": "#/$defs/geometryStartEnd"
+            }
+          },
+          "required": [
+            "type",
+            "geometry"
+          ]
+        }
+      ]
+    }
+  }
+}