@knotx/decorators 0.2.14 → 0.3.0

package/dist/index.cjs

@@ -619,7 +619,7 @@ function register(property) {
   };
 }
 
-function tool(description, params) {
+function tool(description, parameters) {
   return function(_, context) {
     if (context.static) {
       return;
@@ -628,7 +628,7 @@ function tool(description, params) {
       subscribeEngine.call(this, (engine) => {
         engine.registerPluginTool(this.name, context.name, {
           description,
-          params,
+          parameters,
           func: this[context.name].bind(this)
         });
       });

package/dist/index.d.cts

@@ -191,7 +191,7 @@ interface InjectDecoratorCallableMethodType {
      * @example
      * ```
      * @inject('getNode')
-     * getNode!: (id: string) => Node | undefined
+     * getNode!: (params: { id: string }) => Node | undefined
      *
      * @inject('dispatchNodeOperation')
      * dispatchNodeOperation!: (operation: NodeOperation) => void
@@ -470,20 +470,20 @@ type InferSchemaType<T> = T extends Schema ? InferParamsFromSchema<T> : any;
  * 用于装饰插件中的工具函数，使其能被 engine 和其他 plugin 调用
  *
  * @param description 工具函数描述
- * @param params 工具函数参数
+ * @param parameters 工具函数参数
  * @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;
+ *   calculateDistance(parameters: { x1: number, y1: number, x2: number, y2: number }): number {
+ *     const dx = parameters.x2 - parameters.x1;
+ *     const dy = parameters.y2 - parameters.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;
+declare function tool<TN extends keyof PluginTools, TP extends keyof PluginTools[TN], TS extends Schema>(description: string, parameters: TS): (_: any, context: CMDC<Extract<TP, string>, PluginTools[TN][TP], TN>) => void;
 
 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 SubscribeDataKey, type SubscribeDecorator, type SubscribeDecoratorCallableDataType, type SubscribeDecoratorCallablePluginDataType, type SubscribeDecoratorSelectableDataType, type SubscribeDecoratorSelectablePluginDataType, type ToolParams, config, createPanelWrapper, edgeOperator, edgePipe, edgeType, inject, layer, nodeOperator, nodePipe, nodeType, observable, panel, register, subscribe, tool };

package/dist/index.d.mts

@@ -191,7 +191,7 @@ interface InjectDecoratorCallableMethodType {
      * @example
      * ```
      * @inject('getNode')
-     * getNode!: (id: string) => Node | undefined
+     * getNode!: (params: { id: string }) => Node | undefined
      *
      * @inject('dispatchNodeOperation')
      * dispatchNodeOperation!: (operation: NodeOperation) => void
@@ -470,20 +470,20 @@ type InferSchemaType<T> = T extends Schema ? InferParamsFromSchema<T> : any;
  * 用于装饰插件中的工具函数，使其能被 engine 和其他 plugin 调用
  *
  * @param description 工具函数描述
- * @param params 工具函数参数
+ * @param parameters 工具函数参数
  * @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;
+ *   calculateDistance(parameters: { x1: number, y1: number, x2: number, y2: number }): number {
+ *     const dx = parameters.x2 - parameters.x1;
+ *     const dy = parameters.y2 - parameters.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;
+declare function tool<TN extends keyof PluginTools, TP extends keyof PluginTools[TN], TS extends Schema>(description: string, parameters: TS): (_: any, context: CMDC<Extract<TP, string>, PluginTools[TN][TP], TN>) => void;
 
 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 SubscribeDataKey, type SubscribeDecorator, type SubscribeDecoratorCallableDataType, type SubscribeDecoratorCallablePluginDataType, type SubscribeDecoratorSelectableDataType, type SubscribeDecoratorSelectablePluginDataType, type ToolParams, config, createPanelWrapper, edgeOperator, edgePipe, edgeType, inject, layer, nodeOperator, nodePipe, nodeType, observable, panel, register, subscribe, tool };

package/dist/index.d.ts

@@ -191,7 +191,7 @@ interface InjectDecoratorCallableMethodType {
      * @example
      * ```
      * @inject('getNode')
-     * getNode!: (id: string) => Node | undefined
+     * getNode!: (params: { id: string }) => Node | undefined
      *
      * @inject('dispatchNodeOperation')
      * dispatchNodeOperation!: (operation: NodeOperation) => void
@@ -470,20 +470,20 @@ type InferSchemaType<T> = T extends Schema ? InferParamsFromSchema<T> : any;
  * 用于装饰插件中的工具函数，使其能被 engine 和其他 plugin 调用
  *
  * @param description 工具函数描述
- * @param params 工具函数参数
+ * @param parameters 工具函数参数
  * @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;
+ *   calculateDistance(parameters: { x1: number, y1: number, x2: number, y2: number }): number {
+ *     const dx = parameters.x2 - parameters.x1;
+ *     const dy = parameters.y2 - parameters.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;
+declare function tool<TN extends keyof PluginTools, TP extends keyof PluginTools[TN], TS extends Schema>(description: string, parameters: TS): (_: any, context: CMDC<Extract<TP, string>, PluginTools[TN][TP], TN>) => void;
 
 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 SubscribeDataKey, type SubscribeDecorator, type SubscribeDecoratorCallableDataType, type SubscribeDecoratorCallablePluginDataType, type SubscribeDecoratorSelectableDataType, type SubscribeDecoratorSelectablePluginDataType, type ToolParams, config, createPanelWrapper, edgeOperator, edgePipe, edgeType, inject, layer, nodeOperator, nodePipe, nodeType, observable, panel, register, subscribe, tool };

package/dist/index.js

@@ -617,7 +617,7 @@ function register(property) {
   };
 }
 
-function tool(description, params) {
+function tool(description, parameters) {
   return function(_, context) {
     if (context.static) {
       return;
@@ -626,7 +626,7 @@ function tool(description, params) {
       subscribeEngine.call(this, (engine) => {
         engine.registerPluginTool(this.name, context.name, {
           description,
-          params,
+          parameters,
           func: this[context.name].bind(this)
         });
       });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knotx/decorators",
-  "version": "0.2.14",
+  "version": "0.3.0",
   "description": "Decorators for Knotx",
   "author": "boenfu",
   "license": "MIT",
@@ -28,20 +28,20 @@
     "dist"
   ],
   "peerDependencies": {
-    "@knotx/jsx": "0.2.12"
+    "@knotx/jsx": "0.3.0"
   },
   "dependencies": {
     "jsonschema": "^1.5.0",
     "lodash-es": "^4.17.21",
     "rxjs": "^7.8.1",
-    "@knotx/core": "0.2.13"
+    "@knotx/core": "0.3.0"
   },
   "devDependencies": {
     "@types/lodash-es": "^4.14.12",
-    "@knotx/build-config": "0.2.12",
-    "@knotx/eslint-config": "0.2.12",
-    "@knotx/jsx": "0.2.12",
-    "@knotx/typescript-config": "0.2.12"
+    "@knotx/build-config": "0.3.0",
+    "@knotx/eslint-config": "0.3.0",
+    "@knotx/jsx": "0.3.0",
+    "@knotx/typescript-config": "0.3.0"
   },
   "scripts": {
     "build": "unbuild",