@easy-editor/core 0.0.1

package/dist/utils/hotkey.d.ts

@@ -0,0 +1,87 @@
+export interface HotkeyCallbackConfig {
+    callback: HotkeyCallback;
+    modifiers: string[];
+    action: string;
+    seq?: string;
+    level?: number;
+    combo?: string;
+}
+export type Disposable = () => void;
+export type HotkeyCallback = (e: KeyboardEvent, combo?: string) => any | false;
+export interface HotkeyCallbacks {
+    [key: string]: HotkeyCallbackConfig[];
+}
+export interface ApiHotkey {
+    /**
+     * 获取当前快捷键配置
+     *
+     * @experimental
+     * @since v1.1.0
+     */
+    get callbacks(): HotkeyCallbacks;
+    /**
+     * 绑定快捷键
+     * bind hotkey/hotkeys,
+     * @param combos 快捷键，格式如：['command + s'] 、['ctrl + shift + s'] 等
+     * @param callback 回调函数
+     * @param action
+     */
+    bind(combos: string[] | string, callback: HotkeyCallback, action?: string): Disposable;
+}
+export interface HotkeyConfig {
+    combos: string | string[];
+    callback: HotkeyCallback;
+    action?: string;
+}
+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;
+    };
+    /**
+     * 当前快捷键配置
+     */
+    callBacks: HotkeyCallbacks;
+    private directMap;
+    private sequenceLevels;
+    private resetTimer;
+    private ignoreNextKeyup;
+    private ignoreNextKeypress;
+    private nextExpectedAction;
+    private isActivate;
+    constructor(viewName?: string);
+    activate(activate: boolean): void;
+    mount(window: Window): () => void;
+    /**
+     * 绑定快捷键
+     * @param combos 快捷键，格式如：['command + s'] 、['ctrl + shift + s'] 等
+     * @param callback 回调函数
+     * @param action
+     */
+    bind(combos: string[] | string, callback: HotkeyCallback, action?: string): Hotkey;
+    batchBind(hotkeys: HotkeyConfig[]): Hotkey;
+    /**
+     * 解绑快捷键
+     * @param combos 快捷键，格式如：['command + s'] 、['ctrl + shift + s'] 等
+     * @param callback 回调函数
+     * @param action
+     */
+    unbind(combos: string[] | string, callback: HotkeyCallback, action?: string): void;
+    /**
+     * resets all sequence counters except for the ones passed in
+     */
+    private resetSequences;
+    /**
+     * finds all callbacks that match based on the keycode, modifiers,
+     * and action
+     */
+    private getMatches;
+    private handleKey;
+    private handleKeyEvent;
+    private resetSequenceTimer;
+    private bindSequence;
+    private bindSingle;
+    private bindMultiple;
+}

package/dist/utils/index.d.ts

@@ -0,0 +1,6 @@
+export * from './common';
+export * from './event-bus';
+export * from './hotkey';
+export * from './is';
+export * from './logger';
+export * from './unique-id';

package/dist/utils/is.d.ts

@@ -0,0 +1,2 @@
+export declare const isObject: (value: any) => value is Record<string, unknown>;
+export declare const isPlainObject: (value: any) => value is any;

package/dist/utils/logger.d.ts

@@ -0,0 +1,18 @@
+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 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;
+};

package/dist/utils/unique-id.d.ts

@@ -0,0 +1,5 @@
+/**
+ * generate a unique id
+ * @param prefix a identifier prefix
+ */
+export declare const uniqueId: (prefix?: string) => string;

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@easy-editor/core",
+  "version": "0.0.1",
+  "description": "A cross-framework low-code engine with scale-out design",
+  "type": "module",
+  "source": "src/index.ts",
+  "main": "dist/index.js",
+  "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"
+    }
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "CHANGELOG.md",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "homepage": "https://github.com/Easy-Editor/EasyEditor",
+  "license": "MIT",
+  "author": "JinSo <kimjinso@qq.com>",
+  "contributors": [
+    {
+      "name": "NoahCodeGG",
+      "email": "noahcodegg@gmail.com",
+      "url": "https://github.com/NoahCodeGG"
+    }
+  ],
+  "keywords": [
+    "@easy-editor",
+    "easyeditor",
+    "low-code",
+    "editor",
+    "engine"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Easy-Editor/EasyEditor"
+  },
+  "bugs": {
+    "url": "https://github.com/Easy-Editor/EasyEditor/issues"
+  },
+  "dependencies": {
+    "mobx": "^6.13.5",
+    "nanoid": "^5.0.7"
+  },
+  "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:js": "rollup -c",
+    "types": "npm-run-all -nl types:*",
+    "types:clean": "rimraf types/",
+    "types:src": "tsc --project tsconfig.build.json",
+    "test-types": "tsc --project tsconfig.test.json"
+  }
+}