@easy-editor/core 0.0.15 → 1.0.0

package/dist/types/setter.d.ts

@@ -0,0 +1,26 @@
+import type { SettingField, SettingPropEntry } from '../designer';
+import type { Component } from './component';
+export type SetterType = SetterConfig | string;
+export type DynamicSetterProps = (target: SettingField) => Record<string, unknown>;
+export interface SetterConfig {
+    /**
+     * the name of the setter
+     */
+    componentName: string;
+    /**
+     * the props pass to Setter Component
+     */
+    props?: Record<string, unknown> | DynamicSetterProps;
+    /**
+     * is required
+     */
+    isRequired?: boolean;
+    /**
+     * Setter initial value
+     */
+    /**
+     * Setter default value
+     */
+    defaultValue?: any;
+}
+export type DynamicSetter = (target: SettingPropEntry) => string | SetterConfig | Component;

package/dist/utils/event-bus.d.ts

@@ -1,28 +1,22 @@
-type EventType = string | symbol;
-type Events = Record<EventType, unknown>;
-type Handler = (event: Events[keyof Events]) => void;
-declare class EventEmitter {
-    all: Map<EventType, Handler[]>;
-    on<Key extends keyof Events>(type: Key, handler: Handler): void;
-    off<Key extends keyof Events>(type: Key, handler?: Handler): void;
-    emit<Key extends keyof Events>(type: Key, evt?: Events[Key]): void;
-}
+import EventEmitter from 'events';
+import type { Disposable } from './hotkey';
 export declare class EventBus {
     private readonly eventEmitter;
     private readonly name?;
-    private logger;
     /**
      * 内核触发的事件名
      */
     readonly names: never[];
     constructor(emitter: EventEmitter, name?: string);
     private getMsgPrefix;
+    private getLogger;
     /**
      * 监听事件
      * @param event 事件名称
      * @param listener 事件回调
      */
-    on(event: string, listener: (...args: any[]) => void): () => void;
+    on(event: string, listener: (...args: any[]) => void): Disposable;
+    prependListener(event: string, listener: (...args: any[]) => void): () => void;
     /**
      * 取消监听事件
      * @param event 事件名称
@@ -36,10 +30,14 @@ export declare class EventBus {
      * @returns
      */
     emit(event: string, ...args: any[]): void;
+    removeListener(event: string | symbol, listener: (...args: any[]) => void): EventEmitter<[never]>;
+    addListener(event: string | symbol, listener: (...args: any[]) => void): EventEmitter<[never]>;
+    setMaxListeners(n: number): EventEmitter<[never]>;
+    removeAllListeners(event?: string | symbol): EventEmitter<[never]>;
 }
 /**
  * 创建一个独立模块事件总线
  * @param name 模块名称
  */
-export declare const createEventBus: (name: string) => EventBus;
-export {};
+export declare const createEventBus: (name: string, maxListeners?: number) => EventBus;
+export declare const commonEvent: EventBus;

package/dist/utils/event.d.ts

@@ -0,0 +1,39 @@
+import type { Editor } from '../types';
+import type { EventBus } from './event-bus';
+import type { Disposable } from './hotkey';
+interface EventOptions {
+    prefix: string;
+}
+export declare class Event {
+    readonly eventBus: EventBus;
+    workspaceMode: boolean;
+    private readonly options;
+    constructor(eventBus: EventBus, options: EventOptions, workspaceMode?: boolean);
+    /**
+     * 监听事件
+     * @param event 事件名称
+     * @param listener 事件回调
+     */
+    on(event: string, listener: (...args: any[]) => void): Disposable;
+    /**
+     * 监听事件，会在其他回调函数之前执行
+     * @param event 事件名称
+     * @param listener 事件回调
+     */
+    prependListener(event: string, listener: (...args: any[]) => void): Disposable;
+    /**
+     * 取消监听事件
+     * @param event 事件名称
+     * @param listener 事件回调
+     */
+    off(event: string, listener: (...args: any[]) => void): void;
+    /**
+     * 触发事件
+     * @param event 事件名称
+     * @param args 事件参数
+     * @returns
+     */
+    emit(event: string, ...args: any[]): void;
+}
+export declare const getEvent: (editor: Editor, options?: any) => Event;
+export {};

package/dist/utils/hotkey.d.ts

@@ -35,11 +35,7 @@ export interface HotkeyConfig {
 }
 export declare class Hotkey {
     readonly viewName: string;
-    logger: {
-        log: (message?: any, ...optionalParams: any[]) => void;
-        error: (message?: any, ...optionalParams: any[]) => void;
-        warn: (message?: any, ...optionalParams: any[]) => void;
-    };
+    logger: import("./logger").Logger;
     /**
      * 当前快捷键配置
      */

package/dist/utils/index.d.ts

@@ -1,4 +1,5 @@
 export * from './common';
+export * from './event';
 export * from './event-bus';
 export * from './hotkey';
 export * from './is';

package/dist/utils/is.d.ts

@@ -1,2 +1,18 @@
+import type { Viewport } from '../simulator/viewport';
+import type { ComponentMap, LowCodeComponent, ProCodeComponent, SetterConfig } from '../types';
 export declare const isObject: (value: any) => value is Record<string, unknown>;
 export declare const isPlainObject: (value: any) => value is any;
+export declare const isTextNode: (node: any) => node is Text;
+export declare const isElementNode: (node: any) => node is Element;
+export declare const isDocumentNode: (node: any) => node is Document;
+/**
+ * 判断节点是否在 viewport 内，判断依据：只要节点有一部分在 viewport 内，都算 true，其余情况 false
+ * @param domNode 待检测的节点
+ * @param viewport 画布 viewport
+ * @returns 是否在 viewport 内
+ */
+export declare function isDOMNodeVisible(domNode: Element, viewport: Viewport): boolean;
+export declare const isProCodeComponentType: (desc: ComponentMap) => desc is ProCodeComponent;
+export declare const isLowCodeComponentType: (desc: ComponentMap) => desc is LowCodeComponent;
+export declare const isSetterConfig: (obj: any) => obj is SetterConfig;
+export declare const isPluginEventName: (eventName: string) => boolean;

package/dist/utils/logger.d.ts

@@ -1,18 +1,38 @@
-export interface Logger {
-    log: (...args: Parameters<(typeof console)['log']>) => void;
-    error: (...args: Parameters<(typeof console)['error']>) => void;
-    warn: (...args: Parameters<(typeof console)['warn']>) => void;
+export type Level = 'debug' | 'log' | 'info' | 'warn' | 'error';
+interface Options {
+    /**
+     * 日志级别
+     * @default 'warn'
+     */
+    level: Level;
+    /**
+     * 业务名称
+     * @default '*'
+     */
+    bizName: string;
 }
-export declare const createLogger: (title: string) => {
-    log: (message?: any, ...optionalParams: any[]) => void;
-    error: (message?: any, ...optionalParams: any[]) => void;
-    warn: (message?: any, ...optionalParams: any[]) => void;
-};
-/**
- * internal global logger
- */
-export declare const logger: {
-    log: (message?: any, ...optionalParams: any[]) => void;
-    error: (message?: any, ...optionalParams: any[]) => void;
-    warn: (message?: any, ...optionalParams: any[]) => void;
-};
+export declare class Logger {
+    /**
+     * 业务名称
+     */
+    bizName: string;
+    /**
+     * 目标日志的bizName
+     */
+    targetBizName: string;
+    /**
+     * 目标日志的level
+     */
+    targetLevel: string;
+    constructor(_options: Partial<Options>);
+    debug(...args: any[]): any;
+    log(...args: any[]): any;
+    info(...args: any[]): any;
+    warn(...args: any[]): any;
+    error(...args: any[]): any;
+}
+export declare const createLogger: (config: string | {
+    level: Level;
+    bizName: string;
+}) => Logger;
+export {};

package/package.json

@@ -1,11 +1,20 @@
 {
   "name": "@easy-editor/core",
-  "version": "0.0.15",
-  "description": "A cross-framework low-code engine with scale-out design.",
+  "version": "1.0.0",
+  "description": "A cross-framework low-code engine with scale-out design",
   "type": "module",
   "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
   "files": [
     "dist",
+    "engine/dist",
     "LICENSE",
     "README.md"
   ],
@@ -40,27 +49,23 @@
     "mobx": "^6.13.5"
   },
   "dependencies": {
+    "events": "^3.3.0",
     "nanoid": "^5.0.7"
   },
+  "devDependencies": {
+    "@rollup/plugin-alias": "^5.1.1"
+  },
   "scripts": {
     "dev": "deno run --watch ./src/index.ts",
     "format": "biome format --write .",
     "lint": "biome check .",
     "build": "npm-run-all -nl build:*",
-    "build:clean": "rimraf dist/",
+    "build:clean": "rimraf dist/ engine/dist/",
     "build:js": "rollup -c",
     "types": "npm-run-all -nl types:*",
     "types:src": "tsc --project tsconfig.build.json",
     "test-types": "tsc --project tsconfig.test.json"
   },
-  "types": "dist/index.d.ts",
-  "typings": "dist/index.d.ts",
   "module": "dist/index.js",
-  "exports": {
-    ".": {
-      "import": "./dist/index.js",
-      "require": "./dist/cjs/index.js",
-      "default": "./dist/index.js"
-    }
-  }
+  "unpkg": "dist/index.js"
 }