@baron1996/kline-scene-schema 0.2.3 → 0.3.0

package/dist/generated/schemas.js

@@ -1051,3 +1051,404 @@ export const ChartSceneSchema = {
         }
     }
 };
+export const TimeSeriesRuntimeSchema = {
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://baron.dev/kline-scene/time-series-runtime.schema.json",
+    "title": "TimeSeriesRuntimeIdentity",
+    "type": "object",
+    "additionalProperties": false,
+    "required": [
+        "engine",
+        "engineVersion",
+        "runtimeVersion"
+    ],
+    "properties": {
+        "engine": {
+            "const": "klinecharts"
+        },
+        "engineVersion": {
+            "const": "10.0.0"
+        },
+        "runtimeVersion": {
+            "const": "0.1.0"
+        }
+    }
+};
+export const TimeSeriesChartConfigSchema = {
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://baron.dev/kline-scene/time-series-chart-config.schema.json",
+    "title": "TimeSeriesChartConfig",
+    "type": "object",
+    "additionalProperties": false,
+    "required": [
+        "locale",
+        "timezone",
+        "layout",
+        "grid",
+        "thousandsSeparator",
+        "decimalFold",
+        "zoomAnchor",
+        "dateFormat",
+        "largeNumberFormat"
+    ],
+    "properties": {
+        "locale": {
+            "type": "string",
+            "minLength": 2,
+            "maxLength": 64,
+            "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$"
+        },
+        "timezone": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 128,
+            "pattern": "^[A-Za-z_+-]+(?:/[A-Za-z0-9_+-]+)*$"
+        },
+        "layout": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "backgroundColor",
+                "textColor",
+                "fontFamily",
+                "fontSize"
+            ],
+            "properties": {
+                "backgroundColor": {
+                    "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/rgbaColor"
+                },
+                "textColor": {
+                    "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/rgbaColor"
+                },
+                "fontFamily": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 128
+                },
+                "fontSize": {
+                    "type": "number",
+                    "minimum": 8,
+                    "maximum": 32
+                }
+            }
+        },
+        "grid": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "horizontalColor",
+                "verticalColor"
+            ],
+            "properties": {
+                "horizontalColor": {
+                    "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/rgbaColor"
+                },
+                "verticalColor": {
+                    "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/rgbaColor"
+                }
+            }
+        },
+        "thousandsSeparator": {
+            "enum": [
+                "",
+                ",",
+                " ",
+                "_"
+            ]
+        },
+        "decimalFold": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "enabled",
+                "threshold"
+            ],
+            "properties": {
+                "enabled": {
+                    "type": "boolean"
+                },
+                "threshold": {
+                    "type": "integer",
+                    "minimum": 1,
+                    "maximum": 16
+                }
+            }
+        },
+        "zoomAnchor": {
+            "enum": [
+                "cursor",
+                "right"
+            ]
+        },
+        "dateFormat": {
+            "enum": [
+                "yyyy-MM-dd",
+                "yyyy-MM-dd HH:mm",
+                "yyyy-MM-dd HH:mm:ss"
+            ]
+        },
+        "largeNumberFormat": {
+            "enum": [
+                "western",
+                "chinese",
+                "plain"
+            ]
+        }
+    }
+};
+export const TimeSeriesSceneSchema = {
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://baron.dev/kline-scene/time-series-scene.schema.json",
+    "title": "TimeSeriesScene",
+    "type": "object",
+    "additionalProperties": false,
+    "required": [
+        "schema",
+        "version",
+        "runtime",
+        "period",
+        "series",
+        "data",
+        "chart",
+        "viewport",
+        "render",
+        "metadata"
+    ],
+    "properties": {
+        "schema": {
+            "const": "@baron1996/time-series-scene"
+        },
+        "version": {
+            "const": 1
+        },
+        "runtime": {
+            "$ref": "https://baron.dev/kline-scene/time-series-runtime.schema.json"
+        },
+        "period": {
+            "$ref": "#/$defs/timeSeriesPeriod"
+        },
+        "series": {
+            "type": "array",
+            "minItems": 1,
+            "maxItems": 64,
+            "items": {
+                "$ref": "#/$defs/timeSeriesDefinition"
+            }
+        },
+        "data": {
+            "type": "array",
+            "minItems": 1,
+            "maxItems": 1000000,
+            "items": {
+                "$ref": "#/$defs/timeSeriesPoint"
+            }
+        },
+        "chart": {
+            "$ref": "https://baron.dev/kline-scene/time-series-chart-config.schema.json"
+        },
+        "viewport": {
+            "$ref": "#/$defs/timeSeriesViewport"
+        },
+        "render": {
+            "$ref": "#/$defs/timeSeriesRender"
+        },
+        "metadata": {
+            "$ref": "#/$defs/metadata"
+        }
+    },
+    "$defs": {
+        "timeSeriesPeriod": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "span",
+                "type"
+            ],
+            "properties": {
+                "span": {
+                    "type": "integer",
+                    "minimum": 1,
+                    "maximum": 100000
+                },
+                "type": {
+                    "enum": [
+                        "second",
+                        "minute",
+                        "hour",
+                        "day",
+                        "week",
+                        "month",
+                        "year"
+                    ]
+                }
+            }
+        },
+        "timeSeriesDefinition": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "id",
+                "name",
+                "type",
+                "unit",
+                "precision",
+                "visible",
+                "style"
+            ],
+            "properties": {
+                "id": {
+                    "type": "string",
+                    "pattern": "^[A-Za-z][A-Za-z0-9_-]{0,63}$"
+                },
+                "name": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 256
+                },
+                "type": {
+                    "const": "line"
+                },
+                "unit": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 64
+                },
+                "precision": {
+                    "type": "integer",
+                    "minimum": 0,
+                    "maximum": 16
+                },
+                "visible": {
+                    "type": "boolean"
+                },
+                "style": {
+                    "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/lineStyle"
+                }
+            }
+        },
+        "timeSeriesPoint": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "timestamp",
+                "values"
+            ],
+            "properties": {
+                "timestamp": {
+                    "type": "integer",
+                    "minimum": 1,
+                    "maximum": 9007199254740991
+                },
+                "values": {
+                    "type": "object",
+                    "minProperties": 1,
+                    "maxProperties": 64,
+                    "propertyNames": {
+                        "pattern": "^[A-Za-z][A-Za-z0-9_-]{0,63}$"
+                    },
+                    "additionalProperties": {
+                        "oneOf": [
+                            {
+                                "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/finiteNumber"
+                            },
+                            {
+                                "type": "null"
+                            }
+                        ]
+                    }
+                }
+            }
+        },
+        "timeSeriesViewport": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "barSpace",
+                "rightOffsetDistance",
+                "anchorTimestamp"
+            ],
+            "properties": {
+                "barSpace": {
+                    "type": "number",
+                    "minimum": 1,
+                    "maximum": 100
+                },
+                "rightOffsetDistance": {
+                    "type": "number",
+                    "minimum": 0,
+                    "maximum": 10000
+                },
+                "anchorTimestamp": {
+                    "type": "integer",
+                    "minimum": 1,
+                    "maximum": 9007199254740991
+                }
+            }
+        },
+        "timeSeriesRender": {
+            "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": {
+                    "const": "Baron Sans"
+                },
+                "timeoutMs": {
+                    "type": "integer",
+                    "minimum": 100,
+                    "maximum": 120000
+                }
+            }
+        },
+        "metadata": {
+            "type": "object",
+            "maxProperties": 64,
+            "propertyNames": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 128
+            },
+            "additionalProperties": {
+                "oneOf": [
+                    {
+                        "type": "null"
+                    },
+                    {
+                        "type": "boolean"
+                    },
+                    {
+                        "$ref": "https://baron.dev/kline-scene/common.schema.json#/$defs/finiteNumber"
+                    },
+                    {
+                        "type": "string"
+                    }
+                ]
+            }
+        }
+    }
+};

package/dist/generated/time-series-scene.d.ts

@@ -0,0 +1,88 @@
+export interface TimeSeriesScene {
+    schema: '@baron1996/time-series-scene';
+    version: 1;
+    runtime: TimeSeriesRuntimeIdentity;
+    period: TimeSeriesPeriod;
+    /**
+     * @minItems 1
+     * @maxItems 64
+     */
+    series: [TimeSeriesDefinition, ...TimeSeriesDefinition[]];
+    /**
+     * @minItems 1
+     * @maxItems 1000000
+     */
+    data: [TimeSeriesPoint, ...TimeSeriesPoint[]];
+    chart: TimeSeriesChartConfig;
+    viewport: TimeSeriesViewport;
+    render: TimeSeriesRender;
+    metadata: TimeSeriesMetadata;
+}
+export interface TimeSeriesRuntimeIdentity {
+    engine: 'klinecharts';
+    engineVersion: '10.0.0';
+    runtimeVersion: '0.1.0';
+}
+export interface TimeSeriesPeriod {
+    span: number;
+    type: 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year';
+}
+export interface TimeSeriesDefinition {
+    id: string;
+    name: string;
+    type: 'line';
+    unit: string;
+    precision: number;
+    visible: boolean;
+    style: {
+        color: string;
+        size: number;
+        style: 'solid' | 'dashed' | 'dotted';
+    };
+}
+export interface TimeSeriesPoint {
+    timestamp: number;
+    values: {
+        [k: string]: (number | null) | undefined;
+    };
+}
+export interface TimeSeriesChartConfig {
+    locale: string;
+    timezone: string;
+    layout: {
+        backgroundColor: string;
+        textColor: string;
+        fontFamily: string;
+        fontSize: number;
+    };
+    grid: {
+        horizontalColor: string;
+        verticalColor: string;
+    };
+    thousandsSeparator: '' | ',' | ' ' | '_';
+    decimalFold: {
+        enabled: boolean;
+        threshold: number;
+    };
+    zoomAnchor: 'cursor' | 'right';
+    dateFormat: 'yyyy-MM-dd' | 'yyyy-MM-dd HH:mm' | 'yyyy-MM-dd HH:mm:ss';
+    largeNumberFormat: 'western' | 'chinese' | 'plain';
+}
+export interface TimeSeriesViewport {
+    barSpace: number;
+    rightOffsetDistance: number;
+    anchorTimestamp: number;
+}
+export interface TimeSeriesRender {
+    width: number;
+    height: number;
+    deviceScaleFactor: number;
+    background: string;
+    fontFamily: 'Baron Sans';
+    timeoutMs: number;
+}
+export type TimeSeriesMetadataValue = null | boolean | number | string;
+export interface TimeSeriesMetadata {
+    [key: string]: TimeSeriesMetadataValue | undefined;
+}
+//# sourceMappingURL=time-series-scene.d.ts.map

package/dist/generated/time-series-scene.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"time-series-scene.d.ts","sourceRoot":"","sources":["../../src/generated/time-series-scene.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,eAAe;IAC/B,MAAM,EAAE,8BAA8B,CAAC;IACvC,OAAO,EAAE,CAAC,CAAC;IACX,OAAO,EAAE,yBAAyB,CAAC;IACnC,MAAM,EAAE,gBAAgB,CAAC;IACzB;;;OAGG;IACH,MAAM,EAAE,CAAC,oBAAoB,EAAE,GAAG,oBAAoB,EAAE,CAAC,CAAC;IAC1D;;;OAGG;IACH,IAAI,EAAE,CAAC,eAAe,EAAE,GAAG,eAAe,EAAE,CAAC,CAAC;IAC9C,KAAK,EAAE,qBAAqB,CAAC;IAC7B,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,MAAM,EAAE,gBAAgB,CAAC;IACzB,QAAQ,EAAE,kBAAkB,CAAC;CAC7B;AACD,MAAM,WAAW,yBAAyB;IACzC,MAAM,EAAE,aAAa,CAAC;IACtB,aAAa,EAAE,QAAQ,CAAC;IACxB,cAAc,EAAE,OAAO,CAAC;CACxB;AACD,MAAM,WAAW,gBAAgB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;CACvE;AACD,MAAM,WAAW,oBAAoB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE;QACN,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC;KACrC,CAAC;CACF;AACD,MAAM,WAAW,eAAe;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE;QACP,CAAC,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,SAAS,CAAC;KACzC,CAAC;CACF;AACD,MAAM,WAAW,qBAAqB;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE;QACP,eAAe,EAAE,MAAM,CAAC;QACxB,SAAS,EAAE,MAAM,CAAC;QAClB,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,IAAI,EAAE;QACL,eAAe,EAAE,MAAM,CAAC;QACxB,aAAa,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,kBAAkB,EAAE,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;IACzC,WAAW,EAAE;QACZ,OAAO,EAAE,OAAO,CAAC;QACjB,SAAS,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,UAAU,EAAE,QAAQ,GAAG,OAAO,CAAC;IAC/B,UAAU,EAAE,YAAY,GAAG,kBAAkB,GAAG,qBAAqB,CAAC;IACtE,iBAAiB,EAAE,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC;CACnD;AACD,MAAM,WAAW,kBAAkB;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,eAAe,EAAE,MAAM,CAAC;CACxB;AACD,MAAM,WAAW,gBAAgB;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,iBAAiB,EAAE,MAAM,CAAC;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,YAAY,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,MAAM,uBAAuB,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;AACvE,MAAM,WAAW,kBAAkB;IAClC,CAAC,GAAG,EAAE,MAAM,GAAG,uBAAuB,GAAG,SAAS,CAAC;CACnD"}

package/dist/generated/time-series-scene.js

@@ -0,0 +1,2 @@
+/* Generated by scripts/generate.mjs. Do not edit. */
+export {};

package/dist/generated/validate-time-series-scene.d.ts

@@ -0,0 +1,15 @@
+export declare const validateTimeSeriesScene: typeof validate20;
+declare function validate20(data: any, { instancePath, parentData, parentDataProperty, rootData, dynamicAnchors }?: {
+    instancePath?: string | undefined;
+    rootData?: any;
+    dynamicAnchors?: {} | undefined;
+}): boolean;
+declare namespace validate20 {
+    var evaluated: {
+        props: boolean;
+        dynamicProps: boolean;
+        dynamicItems: boolean;
+    };
+}
+export {};
+//# sourceMappingURL=validate-time-series-scene.d.ts.map

package/dist/generated/validate-time-series-scene.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-time-series-scene.d.ts","sourceRoot":"","sources":["../../src/generated/validate-time-series-scene.ts"],"names":[],"mappings":"AACa,eAAO,MAAM,uBAAuB,mBAAa,CAAC;AAAkx1D,iBAAS,UAAU,CAAC,IAAI,KAAA,EAAE,EAAC,YAAe,EAAE,UAAU,EAAE,kBAAkB,EAAE,QAAa,EAAE,cAAiB,EAAC;;;;CAAG,WAAiykB;kBAAx4kB,UAAU"}