@knotx/core 0.2.4 → 0.2.6

package/dist/shared/core.BUBec6Va.d.mts

@@ -0,0 +1,145 @@
+import { Schema } from 'jsonschema';
+import { SubscriptionLike, BehaviorSubject } from 'rxjs';
+import { DataOperationPipe, DataOperation } from '@knotx/data';
+
+declare abstract class BasePlugin<TPluginName extends string = string, TPluginConfig extends Record<string, any> | undefined = undefined, TRenderType extends RenderType = RenderType> implements IPlugin<TPluginName, TPluginConfig, TRenderType> {
+    abstract name: TPluginName;
+    constructor(__: TPluginConfig);
+    private static _instanceId;
+    private _instanceId;
+    get pluginId(): string;
+    /**
+     * 插件生命周期中的订阅回调
+     * 可随时存入，销毁时会自动执行
+     */
+    protected subscriptions: (SubscriptionLike | (() => void))[];
+    onDestroy(): void;
+}
+
+type HorizontalAlignment = 'left' | 'right';
+type VerticalAlignment = 'top' | 'bottom';
+interface NodePosition {
+    x: number;
+    y: number;
+}
+interface NodeMeasured {
+    width: number;
+    height: number;
+}
+interface NodeData<TData = any> {
+    id: string;
+    type?: string;
+    position: NodePosition;
+    measured?: NodeMeasured;
+    data: TData;
+}
+interface NodeProps<T = any> {
+    node: NodeData<T>;
+}
+interface EdgeData<TData = any> {
+    id: string;
+    source: string;
+    target: string;
+    type?: string;
+    data?: TData;
+}
+interface EdgeProps<T = any> {
+    edge: EdgeData<T>;
+    sourceX: number;
+    sourceY: number;
+    targetX: number;
+    targetY: number;
+}
+interface Container {
+    width: number;
+    height: number;
+}
+type Position = 'top' | 'right' | 'bottom' | 'left';
+type RenderType = (...args: any[]) => any;
+type NodeRenderType<TD extends Record<string, any> = any, TR = any> = (props: NodeProps<TD>) => TR;
+type EdgeRenderType<TD extends Record<string, any> = any, TR = any> = (props: EdgeProps<TD>) => TR;
+declare enum Layer {
+    Canvas = 0,
+    Background = 4,
+    Edges = 16,
+    Nodes = 64,
+    Foreground = 256
+}
+interface LayerComponent<TRenderType> {
+    plugin: string;
+    name: string;
+    layer: Layer;
+    render: TRenderType;
+    /**
+     * 层级偏移量
+     * @default 0
+     * (layer >> 1, layer << 1]
+     */
+    offset?: number;
+}
+interface IPlugin<TPluginName extends string = string, TPluginConfig extends Record<string, any> | undefined = any, TRenderType extends RenderType = RenderType> {
+    name: TPluginName;
+    pluginId: string;
+    description?: string;
+    onInit?: (config: TPluginConfig) => void;
+    onConfigChange?: (config: TPluginConfig) => void;
+    onDestroy?: () => void;
+    render?: (...args: Parameters<TRenderType>) => ReturnType<TRenderType>;
+}
+type Plugin<TName extends string = string, TConfig extends Record<string, any> | undefined = any, TRenderType extends RenderType = RenderType> = new (__: TConfig) => BasePlugin<TName, TConfig, TRenderType>;
+type PluginConfigs<TPlugins extends Plugin[]> = ((TPlugins[number] extends Plugin<infer T> ? {
+    [TName in T as Extract<TPlugins[number], Plugin<TName>> extends Plugin<TName, undefined> ? never : TName]: Extract<TPlugins[number], Plugin<TName>> extends infer T ? T extends Plugin<TName, infer TConfig> ? TConfig : never : never;
+} : {}));
+/**
+ * plugin data host
+ * @example
+ * `declare module '@knotx/core' {
+ *   interface PluginData {
+ *     pluginName: {
+ *       property: any
+ *     }
+ *   }
+ * }`
+ */
+interface PluginData {
+}
+/**
+ * plugin tools host
+ * @example
+ * `declare module '@knotx/core' {
+ *   interface PluginTools {
+ *     pluginName: {
+ *       toolName: (params: any) => any
+ *     }
+ *   }
+ * }`
+ */
+interface PluginTools {
+}
+interface IPluginInfo {
+    name: string;
+    description?: string;
+}
+interface IPluginToolInfo {
+    type: 'function';
+    name: string;
+    description: string;
+    parameters: Schema;
+}
+type NodeOperationPipe<T = any> = DataOperationPipe<NodeData<T>>;
+type EdgeOperationPipe<T = any> = DataOperationPipe<EdgeData<T>>;
+type NodeOperation<T = any> = DataOperation<NodeData<T>>;
+type EdgeOperation<T = any> = DataOperation<EdgeData<T>>;
+type NodeOperatorFunction<T = any, Args extends any[] = any[]> = (...args: Args) => NodeOperation<T>[];
+type EdgeOperatorFunction<T = any, Args extends any[] = any[]> = (...args: Args) => EdgeOperation<T>[];
+interface IEngineRuntime {
+    render?: {
+        getValue: <T, R = T>(value: BehaviorSubject<T> | T, options: {
+            paths: string[];
+            selector?: (value: T, context?: any) => R;
+            context?: any;
+        }) => T | R;
+    };
+}
+
+export { BasePlugin as B, type Container as C, type EdgeData as E, type HorizontalAlignment as H, type IEngineRuntime as I, type LayerComponent as L, type NodeData as N, type Plugin as P, type RenderType as R, type VerticalAlignment as V, type IPlugin as a, Layer as b, type NodeRenderType as c, type EdgeRenderType as d, type PluginData as e, type PluginTools as f, type IPluginInfo as g, type IPluginToolInfo as h, type NodePosition as i, type NodeMeasured as j, type NodeProps as k, type EdgeProps as l, type Position as m, type PluginConfigs as n, type NodeOperationPipe as o, type EdgeOperationPipe as p, type NodeOperation as q, type EdgeOperation as r, type NodeOperatorFunction as s, type EdgeOperatorFunction as t };

package/dist/shared/core.BUBec6Va.d.ts

@@ -0,0 +1,145 @@
+import { Schema } from 'jsonschema';
+import { SubscriptionLike, BehaviorSubject } from 'rxjs';
+import { DataOperationPipe, DataOperation } from '@knotx/data';
+
+declare abstract class BasePlugin<TPluginName extends string = string, TPluginConfig extends Record<string, any> | undefined = undefined, TRenderType extends RenderType = RenderType> implements IPlugin<TPluginName, TPluginConfig, TRenderType> {
+    abstract name: TPluginName;
+    constructor(__: TPluginConfig);
+    private static _instanceId;
+    private _instanceId;
+    get pluginId(): string;
+    /**
+     * 插件生命周期中的订阅回调
+     * 可随时存入，销毁时会自动执行
+     */
+    protected subscriptions: (SubscriptionLike | (() => void))[];
+    onDestroy(): void;
+}
+
+type HorizontalAlignment = 'left' | 'right';
+type VerticalAlignment = 'top' | 'bottom';
+interface NodePosition {
+    x: number;
+    y: number;
+}
+interface NodeMeasured {
+    width: number;
+    height: number;
+}
+interface NodeData<TData = any> {
+    id: string;
+    type?: string;
+    position: NodePosition;
+    measured?: NodeMeasured;
+    data: TData;
+}
+interface NodeProps<T = any> {
+    node: NodeData<T>;
+}
+interface EdgeData<TData = any> {
+    id: string;
+    source: string;
+    target: string;
+    type?: string;
+    data?: TData;
+}
+interface EdgeProps<T = any> {
+    edge: EdgeData<T>;
+    sourceX: number;
+    sourceY: number;
+    targetX: number;
+    targetY: number;
+}
+interface Container {
+    width: number;
+    height: number;
+}
+type Position = 'top' | 'right' | 'bottom' | 'left';
+type RenderType = (...args: any[]) => any;
+type NodeRenderType<TD extends Record<string, any> = any, TR = any> = (props: NodeProps<TD>) => TR;
+type EdgeRenderType<TD extends Record<string, any> = any, TR = any> = (props: EdgeProps<TD>) => TR;
+declare enum Layer {
+    Canvas = 0,
+    Background = 4,
+    Edges = 16,
+    Nodes = 64,
+    Foreground = 256
+}
+interface LayerComponent<TRenderType> {
+    plugin: string;
+    name: string;
+    layer: Layer;
+    render: TRenderType;
+    /**
+     * 层级偏移量
+     * @default 0
+     * (layer >> 1, layer << 1]
+     */
+    offset?: number;
+}
+interface IPlugin<TPluginName extends string = string, TPluginConfig extends Record<string, any> | undefined = any, TRenderType extends RenderType = RenderType> {
+    name: TPluginName;
+    pluginId: string;
+    description?: string;
+    onInit?: (config: TPluginConfig) => void;
+    onConfigChange?: (config: TPluginConfig) => void;
+    onDestroy?: () => void;
+    render?: (...args: Parameters<TRenderType>) => ReturnType<TRenderType>;
+}
+type Plugin<TName extends string = string, TConfig extends Record<string, any> | undefined = any, TRenderType extends RenderType = RenderType> = new (__: TConfig) => BasePlugin<TName, TConfig, TRenderType>;
+type PluginConfigs<TPlugins extends Plugin[]> = ((TPlugins[number] extends Plugin<infer T> ? {
+    [TName in T as Extract<TPlugins[number], Plugin<TName>> extends Plugin<TName, undefined> ? never : TName]: Extract<TPlugins[number], Plugin<TName>> extends infer T ? T extends Plugin<TName, infer TConfig> ? TConfig : never : never;
+} : {}));
+/**
+ * plugin data host
+ * @example
+ * `declare module '@knotx/core' {
+ *   interface PluginData {
+ *     pluginName: {
+ *       property: any
+ *     }
+ *   }
+ * }`
+ */
+interface PluginData {
+}
+/**
+ * plugin tools host
+ * @example
+ * `declare module '@knotx/core' {
+ *   interface PluginTools {
+ *     pluginName: {
+ *       toolName: (params: any) => any
+ *     }
+ *   }
+ * }`
+ */
+interface PluginTools {
+}
+interface IPluginInfo {
+    name: string;
+    description?: string;
+}
+interface IPluginToolInfo {
+    type: 'function';
+    name: string;
+    description: string;
+    parameters: Schema;
+}
+type NodeOperationPipe<T = any> = DataOperationPipe<NodeData<T>>;
+type EdgeOperationPipe<T = any> = DataOperationPipe<EdgeData<T>>;
+type NodeOperation<T = any> = DataOperation<NodeData<T>>;
+type EdgeOperation<T = any> = DataOperation<EdgeData<T>>;
+type NodeOperatorFunction<T = any, Args extends any[] = any[]> = (...args: Args) => NodeOperation<T>[];
+type EdgeOperatorFunction<T = any, Args extends any[] = any[]> = (...args: Args) => EdgeOperation<T>[];
+interface IEngineRuntime {
+    render?: {
+        getValue: <T, R = T>(value: BehaviorSubject<T> | T, options: {
+            paths: string[];
+            selector?: (value: T, context?: any) => R;
+            context?: any;
+        }) => T | R;
+    };
+}
+
+export { BasePlugin as B, type Container as C, type EdgeData as E, type HorizontalAlignment as H, type IEngineRuntime as I, type LayerComponent as L, type NodeData as N, type Plugin as P, type RenderType as R, type VerticalAlignment as V, type IPlugin as a, Layer as b, type NodeRenderType as c, type EdgeRenderType as d, type PluginData as e, type PluginTools as f, type IPluginInfo as g, type IPluginToolInfo as h, type NodePosition as i, type NodeMeasured as j, type NodeProps as k, type EdgeProps as l, type Position as m, type PluginConfigs as n, type NodeOperationPipe as o, type EdgeOperationPipe as p, type NodeOperation as q, type EdgeOperation as r, type NodeOperatorFunction as s, type EdgeOperatorFunction as t };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knotx/core",
-  "version": "0.2.4",
+  "version": "0.2.6",
   "description": "Core for Knotx",
   "author": "boenfu",
   "license": "MIT",
@@ -43,16 +43,17 @@
     "dist"
   ],
   "dependencies": {
+    "jsonschema": "^1.5.0",
     "lodash-es": "^4.17.21",
     "rxjs": "^7.8.1",
-    "@knotx/data": "0.2.4",
-    "@knotx/utils": "0.2.4"
+    "@knotx/data": "0.2.6",
+    "@knotx/utils": "0.2.6"
   },
   "devDependencies": {
     "@types/lodash-es": "^4.17.12",
-    "@knotx/build-config": "0.2.4",
-    "@knotx/eslint-config": "0.2.4",
-    "@knotx/typescript-config": "0.2.4"
+    "@knotx/build-config": "0.2.6",
+    "@knotx/eslint-config": "0.2.6",
+    "@knotx/typescript-config": "0.2.6"
   },
   "scripts": {
     "build": "unbuild",