@363045841yyt/klinechart 0.7.0 → 0.7.3-alpha.0

package/dist/index.d.cts

@@ -0,0 +1,124 @@
+import { App, PropType, Ref } from 'vue';
+import { Signal } from '../../core/src/reactivity/index.ts';
+import { ChartController, ChartControllerFactory, ChartMountOptions, ChartViewport, IndicatorInstance, InteractionSnapshot, KLineData } from '../../core/src';
+export type { ChartController, ChartMountOptions, ChartViewport, } from '../../core/src';
+export { DrawingStyleToolbar, IndicatorParams, IndicatorSelector, KLineChartVue, KLineTooltip, LeftToolbar, MarkerTooltip, } from './components/index';
+/**
+ * Inject the ChartController factory. Called by:
+ *   - the core package's bootstrap once `createChartController` is implemented
+ *   - tests that need a mock controller
+ */
+export declare function __setControllerFactory(factory: ChartControllerFactory | null): void;
+/**
+ * Imperative mount API. Returns a controller; caller is responsible for `dispose`.
+ *
+ * Throws if container is null/undefined (SSR-safe guard).
+ */
+export declare function createChart(opts: ChartMountOptions): ChartController;
+/**
+ * Bridge a core Signal<T> into a Vue Ref<T> backed by `shallowRef`.
+ *
+ * We use `shallowRef` (not `ref`) because:
+ *   - core signal values are treated as immutable; deep proxying is wasteful
+ *   - `Object.is` short-circuits in the core depend on referential equality,
+ *     which Vue's deep reactivity would silently break
+ *
+ * Subscription is torn down via `onScopeDispose`, so this is safe to call
+ * inside a Vue component setup, a composable, or a manually-created
+ * `effectScope`. Calling it outside any scope still returns a working ref �?
+ * the caller is then responsible for unsubscribing.
+ */
+export declare function coreSignalToVueRef<T>(signal: Signal<T>): Ref<T>;
+/**
+ * Composable. Pass a template ref to the container element.
+ *
+ * Watches `containerRef` to populate; once it does, calls `createChart`
+ * and exposes the controller via a `shallowRef`. Disposes on scope teardown.
+ */
+export declare function useChart(containerRef: Ref<HTMLElement | null>, opts: Omit<ChartMountOptions, 'container'>): {
+    chart: Ref<ChartController | null>;
+};
+/**
+ * Bridge the Chart's indicators signal into a Vue shallowRef.
+ */
+export declare function useIndicators(controller: ChartController): {
+    indicators: Ref<ReadonlyArray<IndicatorInstance>>;
+    add: ChartController['addIndicator'];
+    remove: ChartController['removeIndicator'];
+    updateParams: ChartController['updateIndicatorParams'];
+};
+/**
+ * Bridge the Chart's interactionState signal into a Vue shallowRef.
+ */
+export declare function useInteractionState(controller: ChartController): Ref<InteractionSnapshot>;
+/**
+ * Bridge the Chart's paneRatios signal into a Vue shallowRef.
+ */
+export declare function usePaneRatios(controller: ChartController): Ref<Readonly<Record<string, number>>>;
+/**
+ * Bridge the Chart's viewport signal into a Vue shallowRef.
+ */
+export declare function useViewport(controller: ChartController): Ref<ChartViewport>;
+export declare const KLineChart: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    data: {
+        type: PropType<ReadonlyArray<KLineData>>;
+        required: true;
+    };
+    initialZoomLevel: {
+        type: NumberConstructor;
+        default: number;
+    };
+    zoomLevels: {
+        type: NumberConstructor;
+        default: number;
+    };
+    theme: {
+        type: PropType<"light" | "dark">;
+        default: string;
+    };
+    /** custom class for the chart container root */
+    containerClass: {
+        type: StringConstructor;
+        default: string;
+    };
+}>, () => import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    ready: (_controller: ChartController) => true;
+    zoomLevelChange: (_level: number, _kWidth: number) => true;
+}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    data: {
+        type: PropType<ReadonlyArray<KLineData>>;
+        required: true;
+    };
+    initialZoomLevel: {
+        type: NumberConstructor;
+        default: number;
+    };
+    zoomLevels: {
+        type: NumberConstructor;
+        default: number;
+    };
+    theme: {
+        type: PropType<"light" | "dark">;
+        default: string;
+    };
+    /** custom class for the chart container root */
+    containerClass: {
+        type: StringConstructor;
+        default: string;
+    };
+}>> & Readonly<{
+    onReady?: ((_controller: ChartController) => any) | undefined;
+    onZoomLevelChange?: ((_level: number, _kWidth: number) => any) | undefined;
+}>, {
+    zoomLevels: number;
+    initialZoomLevel: number;
+    theme: "light" | "dark";
+    containerClass: string;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export declare const KMapPlugin: {
+    install(app: App): void;
+};
+export { VERSION, CORE_VERSION } from './version';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts

@@ -1,2 +1,124 @@
-export * from './src/index'
-export {}
+import { App, PropType, Ref } from 'vue';
+import { Signal } from '../../core/src/reactivity/index.ts';
+import { ChartController, ChartControllerFactory, ChartMountOptions, ChartViewport, IndicatorInstance, InteractionSnapshot, KLineData } from '../../core/src';
+export type { ChartController, ChartMountOptions, ChartViewport, } from '../../core/src';
+export { DrawingStyleToolbar, IndicatorParams, IndicatorSelector, KLineChartVue, KLineTooltip, LeftToolbar, MarkerTooltip, } from './components/index';
+/**
+ * Inject the ChartController factory. Called by:
+ *   - the core package's bootstrap once `createChartController` is implemented
+ *   - tests that need a mock controller
+ */
+export declare function __setControllerFactory(factory: ChartControllerFactory | null): void;
+/**
+ * Imperative mount API. Returns a controller; caller is responsible for `dispose`.
+ *
+ * Throws if container is null/undefined (SSR-safe guard).
+ */
+export declare function createChart(opts: ChartMountOptions): ChartController;
+/**
+ * Bridge a core Signal<T> into a Vue Ref<T> backed by `shallowRef`.
+ *
+ * We use `shallowRef` (not `ref`) because:
+ *   - core signal values are treated as immutable; deep proxying is wasteful
+ *   - `Object.is` short-circuits in the core depend on referential equality,
+ *     which Vue's deep reactivity would silently break
+ *
+ * Subscription is torn down via `onScopeDispose`, so this is safe to call
+ * inside a Vue component setup, a composable, or a manually-created
+ * `effectScope`. Calling it outside any scope still returns a working ref �?
+ * the caller is then responsible for unsubscribing.
+ */
+export declare function coreSignalToVueRef<T>(signal: Signal<T>): Ref<T>;
+/**
+ * Composable. Pass a template ref to the container element.
+ *
+ * Watches `containerRef` to populate; once it does, calls `createChart`
+ * and exposes the controller via a `shallowRef`. Disposes on scope teardown.
+ */
+export declare function useChart(containerRef: Ref<HTMLElement | null>, opts: Omit<ChartMountOptions, 'container'>): {
+    chart: Ref<ChartController | null>;
+};
+/**
+ * Bridge the Chart's indicators signal into a Vue shallowRef.
+ */
+export declare function useIndicators(controller: ChartController): {
+    indicators: Ref<ReadonlyArray<IndicatorInstance>>;
+    add: ChartController['addIndicator'];
+    remove: ChartController['removeIndicator'];
+    updateParams: ChartController['updateIndicatorParams'];
+};
+/**
+ * Bridge the Chart's interactionState signal into a Vue shallowRef.
+ */
+export declare function useInteractionState(controller: ChartController): Ref<InteractionSnapshot>;
+/**
+ * Bridge the Chart's paneRatios signal into a Vue shallowRef.
+ */
+export declare function usePaneRatios(controller: ChartController): Ref<Readonly<Record<string, number>>>;
+/**
+ * Bridge the Chart's viewport signal into a Vue shallowRef.
+ */
+export declare function useViewport(controller: ChartController): Ref<ChartViewport>;
+export declare const KLineChart: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    data: {
+        type: PropType<ReadonlyArray<KLineData>>;
+        required: true;
+    };
+    initialZoomLevel: {
+        type: NumberConstructor;
+        default: number;
+    };
+    zoomLevels: {
+        type: NumberConstructor;
+        default: number;
+    };
+    theme: {
+        type: PropType<"light" | "dark">;
+        default: string;
+    };
+    /** custom class for the chart container root */
+    containerClass: {
+        type: StringConstructor;
+        default: string;
+    };
+}>, () => import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    ready: (_controller: ChartController) => true;
+    zoomLevelChange: (_level: number, _kWidth: number) => true;
+}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    data: {
+        type: PropType<ReadonlyArray<KLineData>>;
+        required: true;
+    };
+    initialZoomLevel: {
+        type: NumberConstructor;
+        default: number;
+    };
+    zoomLevels: {
+        type: NumberConstructor;
+        default: number;
+    };
+    theme: {
+        type: PropType<"light" | "dark">;
+        default: string;
+    };
+    /** custom class for the chart container root */
+    containerClass: {
+        type: StringConstructor;
+        default: string;
+    };
+}>> & Readonly<{
+    onReady?: ((_controller: ChartController) => any) | undefined;
+    onZoomLevelChange?: ((_level: number, _kWidth: number) => any) | undefined;
+}>, {
+    zoomLevels: number;
+    initialZoomLevel: number;
+    theme: "light" | "dark";
+    containerClass: string;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export declare const KMapPlugin: {
+    install(app: App): void;
+};
+export { VERSION, CORE_VERSION } from './version';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAUH,KAAK,GAAG,EACR,KAAK,QAAQ,EACb,KAAK,GAAG,EACX,MAAM,KAAK,CAAA;AACZ,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,0CAA0C,CAAA;AACtE,OAAO,KAAK,EACR,eAAe,EACf,sBAAsB,EACtB,iBAAiB,EACjB,aAAa,EACb,iBAAiB,EACjB,mBAAmB,EACnB,SAAS,EACZ,MAAM,+BAA+B,CAAA;AAEtC,YAAY,EACR,eAAe,EACf,iBAAiB,EACjB,aAAa,GAChB,MAAM,+BAA+B,CAAA;AAMtC,OAAO,EACH,mBAAmB,EACnB,eAAe,EACf,iBAAiB,EACjB,aAAa,EACb,YAAY,EACZ,WAAW,EACX,aAAa,GAChB,MAAM,oBAAoB,CAAA;AAY3B;;;;GAIG;AACH,wBAAgB,sBAAsB,CAClC,OAAO,EAAE,sBAAsB,GAAG,IAAI,GACvC,IAAI,CAEN;AAMD;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,iBAAiB,GAAG,eAAe,CAapE;AASD;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAO/D;AAMD;;;;;GAKG;AACH,wBAAgB,QAAQ,CACpB,YAAY,EAAE,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,EACrC,IAAI,EAAE,IAAI,CAAC,iBAAiB,EAAE,WAAW,CAAC,GAC3C;IAAE,KAAK,EAAE,GAAG,CAAC,eAAe,GAAG,IAAI,CAAC,CAAA;CAAE,CAoCxC;AAMD;;GAEG;AACH,wBAAgB,aAAa,CAAC,UAAU,EAAE,eAAe,GAAG;IACxD,UAAU,EAAE,GAAG,CAAC,aAAa,CAAC,iBAAiB,CAAC,CAAC,CAAA;IACjD,GAAG,EAAE,eAAe,CAAC,cAAc,CAAC,CAAA;IACpC,MAAM,EAAE,eAAe,CAAC,iBAAiB,CAAC,CAAA;IAC1C,YAAY,EAAE,eAAe,CAAC,uBAAuB,CAAC,CAAA;CACzD,CAeA;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAC/B,UAAU,EAAE,eAAe,GAC5B,GAAG,CAAC,mBAAmB,CAAC,CAO1B;AAED;;GAEG;AACH,wBAAgB,aAAa,CACzB,UAAU,EAAE,eAAe,GAC5B,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CASvC;AAED;;GAEG;AACH,wBAAgB,WAAW,CACvB,UAAU,EAAE,eAAe,GAC5B,GAAG,CAAC,aAAa,CAAC,CAOpB;AAWD,eAAO,MAAM,UAAU;;cAII,QAAQ,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;;;;;;;;;;;;cAMjC,QAAQ,CAAC,OAAO,GAAG,MAAM,CAAC;;;IAG9C,gDAAgD;;;;;;;;yBAI3B,eAAe;8BAEV,MAAM,WAAW,MAAM;;;cAf9B,QAAQ,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;;;;;;;;;;;;cAMjC,QAAQ,CAAC,OAAO,GAAG,MAAM,CAAC;;;IAG9C,gDAAgD;;;;;;;;;;;;;4EAgGtD,CAAA;AAUF,eAAO,MAAM,UAAU;iBACN,GAAG,GAAG,IAAI;CAG1B,CAAA;AAeD,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA"}