@363045841yyt/klinechart-core 0.7.3 → 0.7.5-alpha.2

package/src/engine/indicators/indicatorDefinitionRegistry.ts

@@ -1,62 +1,62 @@
-import type { IndicatorMetadata, IndicatorCategory, StateKey, RendererFactory } from './indicatorMetadata'
-import type { PluginHost } from '../../plugin'
-
-export interface IndicatorDefinitionConfig {
-    name: string
-    displayName: string
-    category: IndicatorCategory
-    stateKey: StateKey
-    defaultPaneId: string
-    paneIdField?: keyof import('./workerProtocol').IndicatorConfigSnapshot
-    allowMainPane?: boolean
-    applyResult?: (host: PluginHost, state: unknown, paneId: string) => void
-}
-
-type IndicatorDefinitionClass = {
-    new(...args: never[]): unknown
-    rendererFactory?: RendererFactory
-}
-
-const indicatorDefinitions = new Map<string, IndicatorMetadata>()
-
-/**
- * 标准类装饰器：在模块加载时收集指标定义
- *
- * 使用方式：
- * @Indicator({ name: 'ma', ... })
- * class MADefinition {
- *   static rendererFactory = createMARendererPlugin
- * }
- */
-export function Indicator(config: IndicatorDefinitionConfig) {
-    return function <T extends IndicatorDefinitionClass>(value: T, context: ClassDecoratorContext<T>): T {
-        context.addInitializer(function (this: T) {
-            const rendererFactory = this.rendererFactory
-            if (typeof rendererFactory !== 'function') {
-                throw new Error(`[Indicator] '${config.name}' definition must expose static rendererFactory`)
-            }
-
-            indicatorDefinitions.set(config.name, {
-                ...config,
-                rendererFactory,
-                paneIdField: config.paneIdField,
-                allowMainPane: config.allowMainPane,
-                applyResult: config.applyResult,
-            })
-        })
-
-        return value
-    }
-}
-
-export function getRegisteredIndicatorDefinitions(): readonly IndicatorMetadata[] {
-    return Array.from(indicatorDefinitions.values())
-}
-
-export function getRegisteredIndicatorDefinition(name: string): IndicatorMetadata | undefined {
-    return indicatorDefinitions.get(name)
-}
-
-export function clearRegisteredIndicatorDefinitionsForTest(): void {
-    indicatorDefinitions.clear()
-}
+import type { IndicatorMetadata, IndicatorCategory, StateKey, RendererFactory } from './indicatorMetadata'
+import type { PluginHost } from '../../plugin'
+
+export interface IndicatorDefinitionConfig {
+    name: string
+    displayName: string
+    category: IndicatorCategory
+    stateKey: StateKey
+    defaultPaneId: string
+    paneIdField?: keyof import('./workerProtocol').IndicatorConfigSnapshot
+    allowMainPane?: boolean
+    applyResult?: (host: PluginHost, state: unknown, paneId: string) => void
+}
+
+type IndicatorDefinitionClass = {
+    new(...args: never[]): unknown
+    rendererFactory?: RendererFactory
+}
+
+const indicatorDefinitions = new Map<string, IndicatorMetadata>()
+
+/**
+ * 标准类装饰器：在模块加载时收集指标定义
+ *
+ * 使用方式：
+ * @Indicator({ name: 'ma', ... })
+ * class MADefinition {
+ *   static rendererFactory = createMARendererPlugin
+ * }
+ */
+export function Indicator(config: IndicatorDefinitionConfig) {
+    return function <T extends IndicatorDefinitionClass>(value: T, context: ClassDecoratorContext<T>): T {
+        context.addInitializer(function (this: T) {
+            const rendererFactory = this.rendererFactory
+            if (typeof rendererFactory !== 'function') {
+                throw new Error(`[Indicator] '${config.name}' definition must expose static rendererFactory`)
+            }
+
+            indicatorDefinitions.set(config.name, {
+                ...config,
+                rendererFactory,
+                paneIdField: config.paneIdField,
+                allowMainPane: config.allowMainPane,
+                applyResult: config.applyResult,
+            })
+        })
+
+        return value
+    }
+}
+
+export function getRegisteredIndicatorDefinitions(): readonly IndicatorMetadata[] {
+    return Array.from(indicatorDefinitions.values())
+}
+
+export function getRegisteredIndicatorDefinition(name: string): IndicatorMetadata | undefined {
+    return indicatorDefinitions.get(name)
+}
+
+export function clearRegisteredIndicatorDefinitionsForTest(): void {
+    indicatorDefinitions.clear()
+}

package/src/engine/indicators/indicatorMetadata.ts

@@ -1,110 +1,110 @@
-/**
- * IndicatorMetadata - 指标元数据定义
- *
- * 支持动态注册指标的核心数据结构
- * 每个指标通过 metadata 描述其状态 key、渲染器工厂等元信息
- */
-
-import type { PluginHost, RendererPluginWithHost } from '../../plugin'
-import type { IndicatorConfigSnapshot } from './workerProtocol'
-
-/**
- * 指标分类：主图/副图
- */
-export type IndicatorCategory = 'main' | 'sub' | 'oscillator' | 'volume'
-
-/**
- * State key 生成器类型
- * - 主图指标：常量字符串
- * - 副图指标：函数，接收 paneId 返回 key
- */
-export type StateKey = string | ((paneId: string) => string)
-
-/**
- * 渲染器工厂函数
- */
-export type RendererFactory = () => RendererPluginWithHost
-
-/**
- * 指标元数据接口
- */
-export interface IndicatorMetadata<T = unknown> {
-    /**
-     * 指标唯一标识
-     * 如：'ma', 'boll', 'rsi', 'customIndicator'
-     */
-    name: string
-
-    /**
-     * 显示名称（用于日志和调试）
-     */
-    displayName: string
-
-    /**
-     * 分类：主图/副图
-     */
-    category: IndicatorCategory
-
-    /**
-     * StateStore key
-     * - 主图指标：常量字符串（如 'indicator:ma:main'）
-     * - 副图指标：函数 (paneId) => string
-     */
-    stateKey: StateKey
-
-    /**
-     * 在 configSnapshot 中的 paneId 字段名
-     * 用于从配置中获取当前 pane ID
-     */
-    paneIdField?: keyof IndicatorConfigSnapshot
-
-    /**
-     * 渲染器工厂函数
-     * 调用时创建该指标的渲染器实例
-     */
-    rendererFactory: RendererFactory
-
-    /**
-     * 默认 pane ID
-     * - 主图指标：'main'
-     * - 副图指标：如 'sub_RSI'
-     */
-    defaultPaneId: string
-
-    /**
-     * 是否启用（可选条件判断）
-     * 用于副图指标根据配置决定是否参与计算
-     */
-    isEnabled?: (config: IndicatorConfigSnapshot) => boolean
-
-    /**
-     * 将指标计算结果写入 StateStore
-     * @param host - PluginHost
-     * @param state - 计算结果（由 composeRenderStates 或 composeVisibleSubIndicatorStates 产出）
-     * @param paneId - 目标 pane ID（从 configSnapshot 读取）
-     */
-    applyResult?: (host: PluginHost, state: unknown, paneId: string) => void
-
-    /**
-     * 是否允许在主图显示（部分副图指标可切换至主图）
-     * - true：指标可放置在主图（如 WMA/SAR/Pivot 等叠加类指标）
-     * - false/undefined：仅限副图显示
-     */
-    allowMainPane?: boolean
-}
-
-/**
- * 提取 stateKey 对应的实际 key 值
- * @param stateKey - 可以是字符串或函数
- * @param paneId - pane ID（副图指标需要）
- * @returns 实际的 state key 字符串
- */
-export function resolveStateKey(stateKey: StateKey, paneId?: string): string {
-    if (typeof stateKey === 'function') {
-        if (!paneId) {
-            throw new Error('[IndicatorMetadata] Pane ID required for dynamic state key')
-        }
-        return stateKey(paneId)
-    }
-    return stateKey
-}
+/**
+ * IndicatorMetadata - 指标元数据定义
+ *
+ * 支持动态注册指标的核心数据结构
+ * 每个指标通过 metadata 描述其状态 key、渲染器工厂等元信息
+ */
+
+import type { PluginHost, RendererPluginWithHost } from '../../plugin'
+import type { IndicatorConfigSnapshot } from './workerProtocol'
+
+/**
+ * 指标分类：主图/副图
+ */
+export type IndicatorCategory = 'main' | 'sub' | 'oscillator' | 'volume'
+
+/**
+ * State key 生成器类型
+ * - 主图指标：常量字符串
+ * - 副图指标：函数，接收 paneId 返回 key
+ */
+export type StateKey = string | ((paneId: string) => string)
+
+/**
+ * 渲染器工厂函数
+ */
+export type RendererFactory = () => RendererPluginWithHost
+
+/**
+ * 指标元数据接口
+ */
+export interface IndicatorMetadata<T = unknown> {
+    /**
+     * 指标唯一标识
+     * 如：'ma', 'boll', 'rsi', 'customIndicator'
+     */
+    name: string
+
+    /**
+     * 显示名称（用于日志和调试）
+     */
+    displayName: string
+
+    /**
+     * 分类：主图/副图
+     */
+    category: IndicatorCategory
+
+    /**
+     * StateStore key
+     * - 主图指标：常量字符串（如 'indicator:ma:main'）
+     * - 副图指标：函数 (paneId) => string
+     */
+    stateKey: StateKey
+
+    /**
+     * 在 configSnapshot 中的 paneId 字段名
+     * 用于从配置中获取当前 pane ID
+     */
+    paneIdField?: keyof IndicatorConfigSnapshot
+
+    /**
+     * 渲染器工厂函数
+     * 调用时创建该指标的渲染器实例
+     */
+    rendererFactory: RendererFactory
+
+    /**
+     * 默认 pane ID
+     * - 主图指标：'main'
+     * - 副图指标：如 'sub_RSI'
+     */
+    defaultPaneId: string
+
+    /**
+     * 是否启用（可选条件判断）
+     * 用于副图指标根据配置决定是否参与计算
+     */
+    isEnabled?: (config: IndicatorConfigSnapshot) => boolean
+
+    /**
+     * 将指标计算结果写入 StateStore
+     * @param host - PluginHost
+     * @param state - 计算结果（由 composeRenderStates 或 composeVisibleSubIndicatorStates 产出）
+     * @param paneId - 目标 pane ID（从 configSnapshot 读取）
+     */
+    applyResult?: (host: PluginHost, state: unknown, paneId: string) => void
+
+    /**
+     * 是否允许在主图显示（部分副图指标可切换至主图）
+     * - true：指标可放置在主图（如 WMA/SAR/Pivot 等叠加类指标）
+     * - false/undefined：仅限副图显示
+     */
+    allowMainPane?: boolean
+}
+
+/**
+ * 提取 stateKey 对应的实际 key 值
+ * @param stateKey - 可以是字符串或函数
+ * @param paneId - pane ID（副图指标需要）
+ * @returns 实际的 state key 字符串
+ */
+export function resolveStateKey(stateKey: StateKey, paneId?: string): string {
+    if (typeof stateKey === 'function') {
+        if (!paneId) {
+            throw new Error('[IndicatorMetadata] Pane ID required for dynamic state key')
+        }
+        return stateKey(paneId)
+    }
+    return stateKey
+}

package/src/engine/indicators/indicatorRegistry.ts

@@ -1,106 +1,106 @@
-import type { IndicatorMetadata } from './indicatorMetadata'
-
-/**
- * IndicatorRegistry - 指标注册表
- *
- * 管理所有已注册指标的元数据
- * 支持运行时动态注册/注销指标
- */
-export class IndicatorRegistry {
-    private indicators = new Map<string, IndicatorMetadata>()
-
-    /**
-     * 注册指标
-     * @param meta - 指标元数据
-     * @throws 如果 name 为空或元数据无效
-     */
-    register<T>(meta: IndicatorMetadata<T>): void {
-        // 验证必填字段
-        if (!meta.name || typeof meta.name !== 'string') {
-            throw new Error('[IndicatorRegistry] Indicator name is required')
-        }
-
-        if (!meta.displayName) {
-            throw new Error(`[IndicatorRegistry] displayName is required for indicator '${meta.name}'`)
-        }
-
-        if (!meta.rendererFactory || typeof meta.rendererFactory !== 'function') {
-            throw new Error(`[IndicatorRegistry] rendererFactory is required for indicator '${meta.name}'`)
-        }
-
-        // 检查重复注册
-        if (this.indicators.has(meta.name)) {
-            console.warn(`[IndicatorRegistry] Indicator '${meta.name}' already registered, overwriting`)
-        }
-
-        this.indicators.set(meta.name, meta as IndicatorMetadata)
-    }
-
-    /**
-     * 注销指标
-     * @param name - 指标名称
-     * @returns 是否成功注销
-     */
-    unregister(name: string): boolean {
-        return this.indicators.delete(name)
-    }
-
-    /**
-     * 获取指定指标的元数据
-     * @param name - 指标名称
-     * @returns 元数据或 undefined
-     */
-    get(name: string): IndicatorMetadata | undefined {
-        return this.indicators.get(name)
-    }
-
-    /**
-     * 检查指标是否已注册
-     * @param name - 指标名称
-     */
-    has(name: string): boolean {
-        return this.indicators.has(name)
-    }
-
-    /**
-     * 获取所有已注册指标
-     */
-    getAll(): readonly IndicatorMetadata[] {
-        return Array.from(this.indicators.values())
-    }
-
-    /**
-     * 获取主图指标
-     */
-    getMainIndicators(): readonly IndicatorMetadata[] {
-        return this.getAll().filter(m => m.category === 'main')
-    }
-
-    /**
-     * 获取副图指标
-     */
-    getSubIndicators(): readonly IndicatorMetadata[] {
-        return this.getAll().filter(m => m.category === 'sub')
-    }
-
-    /**
-     * 获取指标名称列表
-     */
-    getNames(): string[] {
-        return Array.from(this.indicators.keys())
-    }
-
-    /**
-     * 清空所有注册指标
-     */
-    clear(): void {
-        this.indicators.clear()
-    }
-
-    /**
-     * 获取已注册指标数量
-     */
-    get size(): number {
-        return this.indicators.size
-    }
-}
+import type { IndicatorMetadata } from './indicatorMetadata'
+
+/**
+ * IndicatorRegistry - 指标注册表
+ *
+ * 管理所有已注册指标的元数据
+ * 支持运行时动态注册/注销指标
+ */
+export class IndicatorRegistry {
+    private indicators = new Map<string, IndicatorMetadata>()
+
+    /**
+     * 注册指标
+     * @param meta - 指标元数据
+     * @throws 如果 name 为空或元数据无效
+     */
+    register<T>(meta: IndicatorMetadata<T>): void {
+        // 验证必填字段
+        if (!meta.name || typeof meta.name !== 'string') {
+            throw new Error('[IndicatorRegistry] Indicator name is required')
+        }
+
+        if (!meta.displayName) {
+            throw new Error(`[IndicatorRegistry] displayName is required for indicator '${meta.name}'`)
+        }
+
+        if (!meta.rendererFactory || typeof meta.rendererFactory !== 'function') {
+            throw new Error(`[IndicatorRegistry] rendererFactory is required for indicator '${meta.name}'`)
+        }
+
+        // 检查重复注册
+        if (this.indicators.has(meta.name)) {
+            console.warn(`[IndicatorRegistry] Indicator '${meta.name}' already registered, overwriting`)
+        }
+
+        this.indicators.set(meta.name, meta as IndicatorMetadata)
+    }
+
+    /**
+     * 注销指标
+     * @param name - 指标名称
+     * @returns 是否成功注销
+     */
+    unregister(name: string): boolean {
+        return this.indicators.delete(name)
+    }
+
+    /**
+     * 获取指定指标的元数据
+     * @param name - 指标名称
+     * @returns 元数据或 undefined
+     */
+    get(name: string): IndicatorMetadata | undefined {
+        return this.indicators.get(name)
+    }
+
+    /**
+     * 检查指标是否已注册
+     * @param name - 指标名称
+     */
+    has(name: string): boolean {
+        return this.indicators.has(name)
+    }
+
+    /**
+     * 获取所有已注册指标
+     */
+    getAll(): readonly IndicatorMetadata[] {
+        return Array.from(this.indicators.values())
+    }
+
+    /**
+     * 获取主图指标
+     */
+    getMainIndicators(): readonly IndicatorMetadata[] {
+        return this.getAll().filter(m => m.category === 'main')
+    }
+
+    /**
+     * 获取副图指标
+     */
+    getSubIndicators(): readonly IndicatorMetadata[] {
+        return this.getAll().filter(m => m.category === 'sub')
+    }
+
+    /**
+     * 获取指标名称列表
+     */
+    getNames(): string[] {
+        return Array.from(this.indicators.keys())
+    }
+
+    /**
+     * 清空所有注册指标
+     */
+    clear(): void {
+        this.indicators.clear()
+    }
+
+    /**
+     * 获取已注册指标数量
+     */
+    get size(): number {
+        return this.indicators.size
+    }
+}