@knotx/decorators 0.2.4 → 0.2.6

package/dist/index.d.ts

@@ -1,14 +1,19 @@
-import { RenderType, IPlugin, EdgeOperatorFunction, EdgeOperationPipe, EdgeRenderType, Engine, PluginData, Layer, VerticalAlignment, HorizontalAlignment, Container, NodeOperatorFunction, NodeOperationPipe, NodeRenderType } from '@knotx/core';
+import { BasePlugin, RenderType, IPlugin, EdgeOperatorFunction, EdgeOperationPipe, EdgeRenderType, Engine, PluginData, Layer, VerticalAlignment, HorizontalAlignment, Container, NodeOperatorFunction, NodeOperationPipe, NodeRenderType, PluginTools } from '@knotx/core';
+import { Schema } from 'jsonschema';
 
 interface IInternalPlugin<TPluginName extends string = string, TRenderType extends RenderType = RenderType> extends IPlugin<TPluginName, any, TRenderType> {
 }
+type CMDC<TK extends string, TM extends (...args: any[]) => any, TN extends string = string, TC extends Record<string, any> | undefined = any> = ClassMethodDecoratorContext<{
+    [key in TK]: TM;
+} & BasePlugin<TN, TC, RenderType> & IPlugin<TN, TC, RenderType>, TM> & {
+    name: TK;
+};
+type CFDC<TK extends string, TV, TN extends string = string, TC extends Record<string, any> | undefined = any> = ClassFieldDecoratorContext<{
+    [key in TK]: TV;
+} & BasePlugin<TN, TC, RenderType> & IPlugin<TN, TC, RenderType>, TV> & {
+    name: TK;
+};
 
-declare const edgeOperatorSymbol: unique symbol;
-declare module '../internal' {
-    interface IInternalPlugin {
-        [edgeOperatorSymbol]?: Record<string | symbol, EdgeOperatorFunction>;
-    }
-}
 /**
  * 边操作装饰器
  * 用于声明一个方法作为边操作函数
@@ -30,14 +35,8 @@ declare module '../internal' {
  * }
  * ```
  */
-declare function edgeOperator(): <TRenderType extends RenderType, Args extends any[]>(_target: any, { name, static: isStatic, private: isPrivate, addInitializer }: ClassMethodDecoratorContext<IInternalPlugin<string, TRenderType>, EdgeOperatorFunction<any, Args>>) => void;
+declare function edgeOperator<K extends string, V extends EdgeOperatorFunction>(): (_: any, context: CMDC<K, V> | CFDC<K, V>) => void;
 
-declare const edgePipeSymbol: unique symbol;
-declare module '../internal' {
-    interface IInternalPlugin {
-        [edgePipeSymbol]?: Record<string | symbol, EdgeOperationPipe<any>>;
-    }
-}
 /**
  * 边操作管道装饰器
  * 用于声明一个方法作为边操作管道，在边操作执行前后进行处理
@@ -62,15 +61,23 @@ declare module '../internal' {
  * }
  * ```
  */
-declare function edgePipe(): <TRenderType extends RenderType, T = any>(_target: any, { name, static: isStatic, private: isPrivate, addInitializer }: ClassMethodDecoratorContext<IInternalPlugin<string, TRenderType>, () => EdgeOperationPipe<T>>) => void;
+declare function edgePipe<K extends string>(): <T, V extends (...args: any[]) => EdgeOperationPipe<T>>(_: any, context: CMDC<K, V> | CFDC<K, V>) => void;
 
-declare const edgeRendererSymbol: unique symbol;
-declare module '../internal' {
-    interface IInternalPlugin {
-        [edgeRendererSymbol]?: Record<string, EdgeRenderType>;
-    }
-}
-declare function edgeType(type: string): <TRenderType extends RenderType>(_target: any, { name, static: isStatic, private: isPrivate, addInitializer }: ClassMethodDecoratorContext<IInternalPlugin<string, TRenderType>, EdgeRenderType> | ClassFieldDecoratorContext<IInternalPlugin<string, TRenderType>, EdgeRenderType>) => void;
+/**
+ * 连线渲染器装饰器
+ * 用于声明一个方法作为连线渲染器
+ *
+ * @example
+ * ```typescript
+ * class MyPlugin extends BasePlugin {
+ *   @edgeType('my-edge')
+ *   renderEdge() {
+ *     return <div>My Edge</div>
+ *   }
+ * }
+ * ```
+ */
+declare function edgeType<K extends string, T extends string, V extends EdgeRenderType>(type: T): (_: any, context: CMDC<K, V> | CFDC<K, V>) => void;
 
 type InjectableDataKey = keyof {
     [K in keyof Engine as Engine[K] extends (...args: any[]) => any ? never : K]: Engine[K];
@@ -225,30 +232,7 @@ type InjectDecorator = InjectDecoratorInjectableDataType & InjectDecoratorInject
  */
 declare const inject: InjectDecorator;
 
-/**
- * 注册插件属性装饰器
- *
- * 用于将插件的属性注册到引擎中，使其他插件可以通过 inject 访问该属性
- * 支持装饰字段和 getter，当装饰字段时，属性值变化会自动通知订阅者
- *
- * @param property 要注册的属性名
- * @returns 类字段或 getter 装饰器函数
- * @example
- * ```
- * // 注册普通字段
- * @register('canUndo')
- * canUndo = false
- *
- * // 注册计算属性
- * @register('ref')
- * get ref() {
- *   return this
- * }
- * ```
- */
-declare function register<T extends keyof PluginData, TP extends keyof PluginData[T]>(property: TP): <TRenderType extends RenderType>(_: any, context: ClassFieldDecoratorContext<IInternalPlugin<T, TRenderType>, PluginData[T][TP]> | ClassGetterDecoratorContext<IInternalPlugin<T, TRenderType>, PluginData[T][TP]>) => void;
-
-declare function layer<This extends IPlugin>(layer: Layer, offset?: number): (_target: any, { name, kind, static: isStatic, private: isPrivate, addInitializer }: ClassMethodDecoratorContext<This>) => void;
+declare function layer<K extends string>(layer: Layer, offset?: number): (_: any, context: CMDC<K, () => void>) => void;
 
 /**
  * 面板位置
@@ -283,14 +267,8 @@ declare function createPanelWrapper(position: PanelPosition, offset?: PanelOffse
  * @param position 面板位置
  * @param offset 面板偏移
  */
-declare function panel<This extends IPlugin>(position: PanelPosition, offset?: PanelOffset): (_target: any, { name, kind, static: isStatic, private: isPrivate, addInitializer }: ClassMethodDecoratorContext<This>) => void;
+declare function panel<K extends string>(position: PanelPosition, offset?: PanelOffset): (_: any, context: CMDC<K, () => any>) => void;
 
-declare const nodeOperatorSymbol: unique symbol;
-declare module '../internal' {
-    interface IInternalPlugin {
-        [nodeOperatorSymbol]?: Record<string | symbol, NodeOperatorFunction>;
-    }
-}
 /**
  * 节点操作装饰器
  * 用于声明一个方法作为节点操作函数
@@ -312,14 +290,8 @@ declare module '../internal' {
  * }
  * ```
  */
-declare function nodeOperator(): <TRenderType extends RenderType, Args extends any[]>(_target: any, { name, static: isStatic, private: isPrivate, addInitializer }: ClassMethodDecoratorContext<IInternalPlugin<string, TRenderType>, NodeOperatorFunction<any, Args>>) => void;
+declare function nodeOperator<K extends string, V extends NodeOperatorFunction>(): (_: any, context: CMDC<K, V> | CFDC<K, V>) => void;
 
-declare const nodePipeSymbol: unique symbol;
-declare module '../internal' {
-    interface IInternalPlugin {
-        [nodePipeSymbol]?: Record<string | symbol, NodeOperationPipe<any>>;
-    }
-}
 /**
  * 节点操作管道装饰器
  * 用于声明一个方法作为节点操作管道，在节点操作执行前后进行处理
@@ -344,32 +316,121 @@ declare module '../internal' {
  * }
  * ```
  */
-declare function nodePipe(): <TRenderType extends RenderType, T = any>(_target: any, { name, static: isStatic, private: isPrivate, addInitializer }: ClassMethodDecoratorContext<IInternalPlugin<string, TRenderType>, () => NodeOperationPipe<T>>) => void;
+declare function nodePipe<K extends string>(): <T, V extends (...args: any[]) => NodeOperationPipe<T>>(_: any, context: CMDC<K, V> | CFDC<K, V>) => void;
 
-declare const nodeRendererSymbol: unique symbol;
-declare module '../internal' {
-    interface IInternalPlugin {
-        [nodeRendererSymbol]?: Record<string, NodeRenderType>;
-    }
-}
-declare function nodeType(type: string): <TRenderType extends RenderType>(_target: any, { name, static: isStatic, private: isPrivate, addInitializer }: ClassMethodDecoratorContext<IInternalPlugin<string, TRenderType>, NodeRenderType> | ClassFieldDecoratorContext<IInternalPlugin<string, TRenderType>, NodeRenderType>) => void;
+/**
+ * 节点类型装饰器
+ * 用于声明一个方法作为节点类型
+ *
+ * @example
+ * ```typescript
+ * class MyPlugin extends BasePlugin {
+ *   @nodeType('my-node')
+ *   renderNode() {
+ *     return <div>My Node</div>
+ *   }
+ * }
+ * ```
+ */
+declare function nodeType<K extends string, T extends string, V extends NodeRenderType>(type: T): (_: any, context: CMDC<K, V> | CFDC<K, V>) => void;
+
+/**
+ * 配置装饰器
+ * 自动绑定 OnInit 和 OnConfigChange 生命周期函数 和 observable 装饰器
+ */
+declare function config<K extends string, V extends Record<string, any>>(): (_: any, context: CFDC<K, V, string, V>) => void;
 
 /**
  * 生命周期装饰器
  * 在插件初始化时调用
  */
-declare function OnInit<TPluginConfig extends Record<string, any> | undefined, This extends IPlugin<string, TPluginConfig>>(originalMethod: (this: This, config: TPluginConfig) => void, context: ClassMethodDecoratorContext<This>): void;
+declare function OnInit<K extends string, TPluginConfig extends Record<string, any> | undefined>(_: any, context: CMDC<K, (config: TPluginConfig) => void, string, TPluginConfig> | CFDC<K, (config: TPluginConfig) => void, string, TPluginConfig>): void;
 /**
  * 销毁装饰器
  * 在插件销毁时调用
  */
-declare function OnDestroy<This extends IPlugin>(originalMethod: (this: This) => void, context: ClassMethodDecoratorContext<This>): void;
+declare function OnDestroy<K extends string>(_: any, context: CMDC<K, () => void> | CFDC<K, () => void>): void;
 /**
  * 配置变更装饰器
  * 在插件配置变更时调用
  */
-declare function OnConfigChange<TPluginConfig extends Record<string, any> | undefined, This extends IPlugin<string, TPluginConfig>>(originalMethod: (this: This, config: TPluginConfig) => void, context: ClassMethodDecoratorContext<This>): void;
+declare function OnConfigChange<K extends string, TPluginConfig extends Record<string, any> | undefined>(_: any, context: CMDC<K, (config: TPluginConfig) => void, string, TPluginConfig> | CFDC<K, (config: TPluginConfig) => void, string, TPluginConfig>): void;
+
+declare function observable<K extends string, T>(): (_: any, context: CFDC<K, T>) => void;
 
-declare function observable<T>(): (_: any, context: ClassFieldDecoratorContext<IPlugin, T>) => void;
+/**
+ * 注册插件属性装饰器
+ *
+ * 用于将插件的属性注册到引擎中，使其他插件可以通过 inject 访问该属性
+ * 支持装饰字段和 getter，当装饰字段时，属性值变化会自动通知订阅者
+ *
+ * @param property 要注册的属性名
+ * @returns 类字段或 getter 装饰器函数
+ * @example
+ * ```
+ * // 注册字段
+ * @register('canUndo')
+ * canUndo = false
+ * ```
+ */
+declare function register<K extends string, TN extends keyof PluginData, TP extends keyof PluginData[TN]>(property: TP): (_: any, context: CFDC<K, PluginData[TN][TP], TN>) => void;
+
+/**
+ * 工具函数参数定义
+ */
+interface ToolParams {
+    description: string;
+    params: Schema;
+}
+/**
+ * 从JSONSchema推断参数类型的辅助类型
+ */
+type InferParamsFromSchema<T extends Schema> = T extends {
+    type: 'object';
+    properties: infer P;
+    required?: infer R;
+} ? {
+    [K in keyof P as K extends Extract<R extends string[] ? R[number] : never, string> ? K : never]: InferSchemaType<P[K]>;
+} & {
+    [K in keyof P as K extends Extract<R extends string[] ? R[number] : never, string> ? never : K]?: InferSchemaType<P[K]>;
+} : T extends {
+    type: 'array';
+    items: infer I;
+} ? Array<InferSchemaType<I>> : T extends {
+    type: 'string';
+} ? string : T extends {
+    type: 'number';
+} ? number : T extends {
+    type: 'boolean';
+} ? boolean : T extends {
+    type: 'null';
+} ? null : T extends {
+    type: 'integer';
+} ? number : any;
+/**
+ * 从 JSONSchema 推断类型的辅助类型
+ */
+type InferSchemaType<T> = T extends Schema ? InferParamsFromSchema<T> : any;
+/**
+ * 工具函数装饰器
+ *
+ * 用于装饰插件中的工具函数，使其能被 engine 和其他 plugin 调用
+ *
+ * @param description 工具函数描述
+ * @param params 工具函数参数
+ * @returns 方法装饰器函数
+ * @example
+ * ```
+ * class MyPlugin extends BasePlugin {
+ *   @tool('calculateDistance')
+ *   calculateDistance(params: { x1: number, y1: number, x2: number, y2: number }): number {
+ *     const dx = params.x2 - params.x1;
+ *     const dy = params.y2 - params.y1;
+ *     return Math.sqrt(dx * dx + dy * dy);
+ *   }
+ * }
+ * ```
+ */
+declare function tool<TN extends keyof PluginTools, TP extends keyof PluginTools[TN], TS extends Schema>(description: string, params: TS): (_: any, context: CMDC<Extract<TP, string>, PluginTools[TN][TP], TN>) => void;
 
-export { type InjectDecorator, type InjectDecoratorCallableDataType, type InjectDecoratorCallableMethodType, type InjectDecoratorCallablePluginDataType, type InjectDecoratorInjectableDataType, type InjectDecoratorInjectableMethodType, type InjectDecoratorInjectablePluginDataType, type InjectDecoratorInjectableType, type InjectWithContext, type Injectable, type InjectableDataKey, type InjectableMethodKey, OnConfigChange, OnDestroy, OnInit, type PanelOffset, type PanelPosition, createPanelWrapper, edgeOperator, edgePipe, edgeType, inject, layer, nodeOperator, nodePipe, nodeType, observable, panel, register };
+export { type InferParamsFromSchema, type InferSchemaType, type InjectDecorator, type InjectDecoratorCallableDataType, type InjectDecoratorCallableMethodType, type InjectDecoratorCallablePluginDataType, type InjectDecoratorInjectableDataType, type InjectDecoratorInjectableMethodType, type InjectDecoratorInjectablePluginDataType, type InjectDecoratorInjectableType, type InjectWithContext, type Injectable, type InjectableDataKey, type InjectableMethodKey, OnConfigChange, OnDestroy, OnInit, type PanelOffset, type PanelPosition, type ToolParams, config, createPanelWrapper, edgeOperator, edgePipe, edgeType, inject, layer, nodeOperator, nodePipe, nodeType, observable, panel, register, tool };