@knotx/decorators 0.0.6 → 0.2.1

package/dist/index.cjs

@@ -541,8 +541,8 @@ function OnInit(originalMethod, context) {
     return;
   }
   context.addInitializer(function() {
-    this.onInit = () => {
-      originalMethod.call(this);
+    this.onInit = (config) => {
+      originalMethod.call(this, config);
     };
   });
 }
@@ -557,6 +557,17 @@ function OnDestroy(originalMethod, context) {
     };
   });
 }
+function OnConfigChange(originalMethod, context) {
+  if (context.kind !== "method") {
+    console.warn("OnConfigChange decorator can only be applied to methods");
+    return;
+  }
+  context.addInitializer(function() {
+    this.onConfigChange = (config) => {
+      originalMethod.call(this, config);
+    };
+  });
+}
 
 function observable() {
   return function(_, context) {
@@ -585,6 +596,7 @@ function observable() {
   };
 }
 
+exports.OnConfigChange = OnConfigChange;
 exports.OnDestroy = OnDestroy;
 exports.OnInit = OnInit;
 exports.createPanelWrapper = createPanelWrapper;

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import { RenderType, IPlugin, EdgeOperatorFunction, EdgeOperationPipe, EdgeRenderType, Engine, PluginData, Layer, VerticalAlignment, HorizontalAlignment, Container, NodeOperatorFunction, NodeOperationPipe, NodeRenderType } from '@knotx/core';
 
-interface IInternalPlugin<TPluginName extends string = string, TRenderType extends RenderType = RenderType> extends IPlugin<TPluginName, TRenderType> {
+interface IInternalPlugin<TPluginName extends string = string, TRenderType extends RenderType = RenderType> extends IPlugin<TPluginName, any, TRenderType> {
 }
 
 declare const edgeOperatorSymbol: unique symbol;
@@ -358,13 +358,18 @@ declare function nodeType(type: string): <TRenderType extends RenderType>(_targe
  * 生命周期装饰器
  * 在插件初始化时调用
  */
-declare function OnInit<This extends IPlugin>(originalMethod: (this: This) => void, context: ClassMethodDecoratorContext<This>): 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 OnDestroy<This extends IPlugin>(originalMethod: (this: This) => void, context: ClassMethodDecoratorContext<This>): 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 observable<T>(): (_: any, context: ClassFieldDecoratorContext<IPlugin, T>) => 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, OnDestroy, OnInit, type PanelOffset, type PanelPosition, createPanelWrapper, edgeOperator, edgePipe, edgeType, inject, layer, nodeOperator, nodePipe, nodeType, observable, panel, register };
+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 };

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import { RenderType, IPlugin, EdgeOperatorFunction, EdgeOperationPipe, EdgeRenderType, Engine, PluginData, Layer, VerticalAlignment, HorizontalAlignment, Container, NodeOperatorFunction, NodeOperationPipe, NodeRenderType } from '@knotx/core';
 
-interface IInternalPlugin<TPluginName extends string = string, TRenderType extends RenderType = RenderType> extends IPlugin<TPluginName, TRenderType> {
+interface IInternalPlugin<TPluginName extends string = string, TRenderType extends RenderType = RenderType> extends IPlugin<TPluginName, any, TRenderType> {
 }
 
 declare const edgeOperatorSymbol: unique symbol;
@@ -358,13 +358,18 @@ declare function nodeType(type: string): <TRenderType extends RenderType>(_targe
  * 生命周期装饰器
  * 在插件初始化时调用
  */
-declare function OnInit<This extends IPlugin>(originalMethod: (this: This) => void, context: ClassMethodDecoratorContext<This>): 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 OnDestroy<This extends IPlugin>(originalMethod: (this: This) => void, context: ClassMethodDecoratorContext<This>): 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 observable<T>(): (_: any, context: ClassFieldDecoratorContext<IPlugin, T>) => 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, OnDestroy, OnInit, type PanelOffset, type PanelPosition, createPanelWrapper, edgeOperator, edgePipe, edgeType, inject, layer, nodeOperator, nodePipe, nodeType, observable, panel, register };
+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 };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { RenderType, IPlugin, EdgeOperatorFunction, EdgeOperationPipe, EdgeRenderType, Engine, PluginData, Layer, VerticalAlignment, HorizontalAlignment, Container, NodeOperatorFunction, NodeOperationPipe, NodeRenderType } from '@knotx/core';
 
-interface IInternalPlugin<TPluginName extends string = string, TRenderType extends RenderType = RenderType> extends IPlugin<TPluginName, TRenderType> {
+interface IInternalPlugin<TPluginName extends string = string, TRenderType extends RenderType = RenderType> extends IPlugin<TPluginName, any, TRenderType> {
 }
 
 declare const edgeOperatorSymbol: unique symbol;
@@ -358,13 +358,18 @@ declare function nodeType(type: string): <TRenderType extends RenderType>(_targe
  * 生命周期装饰器
  * 在插件初始化时调用
  */
-declare function OnInit<This extends IPlugin>(originalMethod: (this: This) => void, context: ClassMethodDecoratorContext<This>): 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 OnDestroy<This extends IPlugin>(originalMethod: (this: This) => void, context: ClassMethodDecoratorContext<This>): 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 observable<T>(): (_: any, context: ClassFieldDecoratorContext<IPlugin, T>) => 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, OnDestroy, OnInit, type PanelOffset, type PanelPosition, createPanelWrapper, edgeOperator, edgePipe, edgeType, inject, layer, nodeOperator, nodePipe, nodeType, observable, panel, register };
+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 };

package/dist/index.mjs

@@ -539,8 +539,8 @@ function OnInit(originalMethod, context) {
     return;
   }
   context.addInitializer(function() {
-    this.onInit = () => {
-      originalMethod.call(this);
+    this.onInit = (config) => {
+      originalMethod.call(this, config);
     };
   });
 }
@@ -555,6 +555,17 @@ function OnDestroy(originalMethod, context) {
     };
   });
 }
+function OnConfigChange(originalMethod, context) {
+  if (context.kind !== "method") {
+    console.warn("OnConfigChange decorator can only be applied to methods");
+    return;
+  }
+  context.addInitializer(function() {
+    this.onConfigChange = (config) => {
+      originalMethod.call(this, config);
+    };
+  });
+}
 
 function observable() {
   return function(_, context) {
@@ -583,4 +594,4 @@ function observable() {
   };
 }
 
-export { OnDestroy, OnInit, createPanelWrapper, edgeOperator, edgePipe, edgeType, inject, layer, nodeOperator, nodePipe, nodeType, observable, panel, register };
+export { OnConfigChange, OnDestroy, OnInit, createPanelWrapper, edgeOperator, edgePipe, edgeType, inject, layer, nodeOperator, nodePipe, nodeType, observable, panel, register };

package/package.json

@@ -1,7 +1,6 @@
 {
   "name": "@knotx/decorators",
-  "type": "module",
-  "version": "0.0.6",
+  "version": "0.2.1",
   "description": "Decorators for Knotx",
   "author": "boenfu",
   "license": "MIT",
@@ -28,17 +27,20 @@
   "files": [
     "dist"
   ],
+  "peerDependencies": {
+    "@knotx/jsx": "0.2.1"
+  },
   "dependencies": {
     "lodash-es": "^4.17.21",
     "rxjs": "^7.8.1",
-    "@knotx/core": "0.0.6"
+    "@knotx/core": "0.2.1"
   },
   "devDependencies": {
     "@types/lodash-es": "^4.14.12",
-    "@knotx/build-config": "0.0.6",
-    "@knotx/eslint-config": "0.0.6",
-    "@knotx/jsx": "0.0.6",
-    "@knotx/typescript-config": "0.0.6"
+    "@knotx/build-config": "0.2.1",
+    "@knotx/eslint-config": "0.2.1",
+    "@knotx/jsx": "0.2.1",
+    "@knotx/typescript-config": "0.2.1"
   },
   "scripts": {
     "build": "unbuild --failOnWarn=false",