rendx-history-plugin 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-present wei.liang (https://github.com/weiliang0121)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/main.cjs

@@ -0,0 +1,126 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __typeError = (msg) => {
+  throw TypeError(msg);
+};
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __accessCheck = (obj, member, msg) => member.has(obj) || __typeError("Cannot " + msg);
+var __privateGet = (obj, member, getter) => (__accessCheck(obj, member, "read from private field"), getter ? getter.call(obj) : member.get(obj));
+var __privateAdd = (obj, member, value) => member.has(obj) ? __typeError("Cannot add the same private member more than once") : member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+var __privateSet = (obj, member, value, setter) => (__accessCheck(obj, member, "write to private field"), setter ? setter.call(obj, value) : member.set(obj, value), value);
+
+// src/main.ts
+var main_exports = {};
+__export(main_exports, {
+  historyPlugin: () => historyPlugin
+});
+module.exports = __toCommonJS(main_exports);
+
+// src/history.ts
+var DEFAULTS = {
+  maxSteps: 50
+};
+var _app, _undoStack, _redoStack, _options;
+var HistoryPlugin = class {
+  constructor(options = {}) {
+    this.name = "history";
+    __privateAdd(this, _app, null);
+    __privateAdd(this, _undoStack, []);
+    __privateAdd(this, _redoStack, []);
+    __privateAdd(this, _options);
+    __privateSet(this, _options, { ...DEFAULTS, ...options });
+  }
+  install(app) {
+    __privateSet(this, _app, app);
+  }
+  /**
+   * 保存当前场景快照到撤销栈。
+   * 在每次用户操作完成后调用（如拖拽结束、属性修改等）。
+   */
+  push() {
+    const app = __privateGet(this, _app);
+    if (!app) return;
+    __privateGet(this, _undoStack).push(app.toJSON());
+    __privateSet(this, _redoStack, []);
+    if (__privateGet(this, _undoStack).length > __privateGet(this, _options).maxSteps) {
+      __privateGet(this, _undoStack).shift();
+    }
+  }
+  /**
+   * 撤销：恢复到上一步快照。
+   * @returns 是否成功执行撤销
+   */
+  undo() {
+    const app = __privateGet(this, _app);
+    if (!app || __privateGet(this, _undoStack).length === 0) return false;
+    __privateGet(this, _redoStack).push(app.toJSON());
+    const snapshot = __privateGet(this, _undoStack).pop();
+    app.restoreFromJSON(snapshot);
+    app.render();
+    return true;
+  }
+  /**
+   * 重做：恢复到最近一次被撤销的快照。
+   * @returns 是否成功执行重做
+   */
+  redo() {
+    const app = __privateGet(this, _app);
+    if (!app || __privateGet(this, _redoStack).length === 0) return false;
+    __privateGet(this, _undoStack).push(app.toJSON());
+    const snapshot = __privateGet(this, _redoStack).pop();
+    app.restoreFromJSON(snapshot);
+    app.render();
+    return true;
+  }
+  /** 是否可撤销 */
+  get canUndo() {
+    return __privateGet(this, _undoStack).length > 0;
+  }
+  /** 是否可重做 */
+  get canRedo() {
+    return __privateGet(this, _redoStack).length > 0;
+  }
+  /** 撤销栈长度 */
+  get undoCount() {
+    return __privateGet(this, _undoStack).length;
+  }
+  /** 重做栈长度 */
+  get redoCount() {
+    return __privateGet(this, _redoStack).length;
+  }
+  /** 清空所有历史记录 */
+  reset() {
+    __privateSet(this, _undoStack, []);
+    __privateSet(this, _redoStack, []);
+  }
+  dispose() {
+    this.reset();
+    __privateSet(this, _app, null);
+  }
+};
+_app = new WeakMap();
+_undoStack = new WeakMap();
+_redoStack = new WeakMap();
+_options = new WeakMap();
+function historyPlugin(options) {
+  return new HistoryPlugin(options);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  historyPlugin
+});

package/dist/main.d.cts

@@ -0,0 +1,75 @@
+import { Plugin, App } from 'rendx-engine';
+
+interface HistoryPluginOptions {
+    /** 最大历史步数，默认 50 */
+    maxSteps?: number;
+}
+declare class HistoryPlugin implements Plugin {
+    #private;
+    name: string;
+    constructor(options?: HistoryPluginOptions);
+    install(app: App): void;
+    /**
+     * 保存当前场景快照到撤销栈。
+     * 在每次用户操作完成后调用（如拖拽结束、属性修改等）。
+     */
+    push(): void;
+    /**
+     * 撤销：恢复到上一步快照。
+     * @returns 是否成功执行撤销
+     */
+    undo(): boolean;
+    /**
+     * 重做：恢复到最近一次被撤销的快照。
+     * @returns 是否成功执行重做
+     */
+    redo(): boolean;
+    /** 是否可撤销 */
+    get canUndo(): boolean;
+    /** 是否可重做 */
+    get canRedo(): boolean;
+    /** 撤销栈长度 */
+    get undoCount(): number;
+    /** 重做栈长度 */
+    get redoCount(): number;
+    /** 清空所有历史记录 */
+    reset(): void;
+    dispose(): void;
+}
+/**
+ * 创建历史记录插件（Undo / Redo）
+ *
+ * 基于场景快照实现，每次调用 `push()` 保存当前状态，
+ * `undo()` / `redo()` 在快照间来回切换。
+ *
+ * @example
+ * ```ts
+ * import {historyPlugin} from 'rendx-history-plugin';
+ *
+ * const app = new App({width: 800, height: 600});
+ * app.mount(container);
+ *
+ * const history = historyPlugin({maxSteps: 100});
+ * app.use(history);
+ *
+ * // 用户操作前保存快照
+ * history.push();
+ * // ... 用户执行操作（添加节点、修改属性等）
+ *
+ * // 撤销
+ * history.undo();  // → 恢复到上一步
+ *
+ * // 重做
+ * history.redo();  // → 恢复到撤销前
+ *
+ * // 快捷键绑定
+ * document.addEventListener('keydown', (e) => {
+ *   if (e.metaKey && e.key === 'z') {
+ *     e.shiftKey ? history.redo() : history.undo();
+ *   }
+ * });
+ * ```
+ */
+declare function historyPlugin(options?: HistoryPluginOptions): HistoryPlugin;
+
+export { type HistoryPluginOptions, historyPlugin };

package/dist/main.d.ts

@@ -0,0 +1,75 @@
+import { Plugin, App } from 'rendx-engine';
+
+interface HistoryPluginOptions {
+    /** 最大历史步数，默认 50 */
+    maxSteps?: number;
+}
+declare class HistoryPlugin implements Plugin {
+    #private;
+    name: string;
+    constructor(options?: HistoryPluginOptions);
+    install(app: App): void;
+    /**
+     * 保存当前场景快照到撤销栈。
+     * 在每次用户操作完成后调用（如拖拽结束、属性修改等）。
+     */
+    push(): void;
+    /**
+     * 撤销：恢复到上一步快照。
+     * @returns 是否成功执行撤销
+     */
+    undo(): boolean;
+    /**
+     * 重做：恢复到最近一次被撤销的快照。
+     * @returns 是否成功执行重做
+     */
+    redo(): boolean;
+    /** 是否可撤销 */
+    get canUndo(): boolean;
+    /** 是否可重做 */
+    get canRedo(): boolean;
+    /** 撤销栈长度 */
+    get undoCount(): number;
+    /** 重做栈长度 */
+    get redoCount(): number;
+    /** 清空所有历史记录 */
+    reset(): void;
+    dispose(): void;
+}
+/**
+ * 创建历史记录插件（Undo / Redo）
+ *
+ * 基于场景快照实现，每次调用 `push()` 保存当前状态，
+ * `undo()` / `redo()` 在快照间来回切换。
+ *
+ * @example
+ * ```ts
+ * import {historyPlugin} from 'rendx-history-plugin';
+ *
+ * const app = new App({width: 800, height: 600});
+ * app.mount(container);
+ *
+ * const history = historyPlugin({maxSteps: 100});
+ * app.use(history);
+ *
+ * // 用户操作前保存快照
+ * history.push();
+ * // ... 用户执行操作（添加节点、修改属性等）
+ *
+ * // 撤销
+ * history.undo();  // → 恢复到上一步
+ *
+ * // 重做
+ * history.redo();  // → 恢复到撤销前
+ *
+ * // 快捷键绑定
+ * document.addEventListener('keydown', (e) => {
+ *   if (e.metaKey && e.key === 'z') {
+ *     e.shiftKey ? history.redo() : history.undo();
+ *   }
+ * });
+ * ```
+ */
+declare function historyPlugin(options?: HistoryPluginOptions): HistoryPlugin;
+
+export { type HistoryPluginOptions, historyPlugin };

package/dist/main.js

@@ -0,0 +1,100 @@
+var __typeError = (msg) => {
+  throw TypeError(msg);
+};
+var __accessCheck = (obj, member, msg) => member.has(obj) || __typeError("Cannot " + msg);
+var __privateGet = (obj, member, getter) => (__accessCheck(obj, member, "read from private field"), getter ? getter.call(obj) : member.get(obj));
+var __privateAdd = (obj, member, value) => member.has(obj) ? __typeError("Cannot add the same private member more than once") : member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+var __privateSet = (obj, member, value, setter) => (__accessCheck(obj, member, "write to private field"), setter ? setter.call(obj, value) : member.set(obj, value), value);
+
+// src/history.ts
+var DEFAULTS = {
+  maxSteps: 50
+};
+var _app, _undoStack, _redoStack, _options;
+var HistoryPlugin = class {
+  constructor(options = {}) {
+    this.name = "history";
+    __privateAdd(this, _app, null);
+    __privateAdd(this, _undoStack, []);
+    __privateAdd(this, _redoStack, []);
+    __privateAdd(this, _options);
+    __privateSet(this, _options, { ...DEFAULTS, ...options });
+  }
+  install(app) {
+    __privateSet(this, _app, app);
+  }
+  /**
+   * 保存当前场景快照到撤销栈。
+   * 在每次用户操作完成后调用（如拖拽结束、属性修改等）。
+   */
+  push() {
+    const app = __privateGet(this, _app);
+    if (!app) return;
+    __privateGet(this, _undoStack).push(app.toJSON());
+    __privateSet(this, _redoStack, []);
+    if (__privateGet(this, _undoStack).length > __privateGet(this, _options).maxSteps) {
+      __privateGet(this, _undoStack).shift();
+    }
+  }
+  /**
+   * 撤销：恢复到上一步快照。
+   * @returns 是否成功执行撤销
+   */
+  undo() {
+    const app = __privateGet(this, _app);
+    if (!app || __privateGet(this, _undoStack).length === 0) return false;
+    __privateGet(this, _redoStack).push(app.toJSON());
+    const snapshot = __privateGet(this, _undoStack).pop();
+    app.restoreFromJSON(snapshot);
+    app.render();
+    return true;
+  }
+  /**
+   * 重做：恢复到最近一次被撤销的快照。
+   * @returns 是否成功执行重做
+   */
+  redo() {
+    const app = __privateGet(this, _app);
+    if (!app || __privateGet(this, _redoStack).length === 0) return false;
+    __privateGet(this, _undoStack).push(app.toJSON());
+    const snapshot = __privateGet(this, _redoStack).pop();
+    app.restoreFromJSON(snapshot);
+    app.render();
+    return true;
+  }
+  /** 是否可撤销 */
+  get canUndo() {
+    return __privateGet(this, _undoStack).length > 0;
+  }
+  /** 是否可重做 */
+  get canRedo() {
+    return __privateGet(this, _redoStack).length > 0;
+  }
+  /** 撤销栈长度 */
+  get undoCount() {
+    return __privateGet(this, _undoStack).length;
+  }
+  /** 重做栈长度 */
+  get redoCount() {
+    return __privateGet(this, _redoStack).length;
+  }
+  /** 清空所有历史记录 */
+  reset() {
+    __privateSet(this, _undoStack, []);
+    __privateSet(this, _redoStack, []);
+  }
+  dispose() {
+    this.reset();
+    __privateSet(this, _app, null);
+  }
+};
+_app = new WeakMap();
+_undoStack = new WeakMap();
+_redoStack = new WeakMap();
+_options = new WeakMap();
+function historyPlugin(options) {
+  return new HistoryPlugin(options);
+}
+export {
+  historyPlugin
+};

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "rendx-history-plugin",
+  "version": "0.1.0",
+  "description": "Undo/redo history plugin for Rendx engine",
+  "license": "MIT",
+  "author": "wei.liang (https://github.com/weiliang0121)",
+  "type": "module",
+  "keywords": [
+    "rendx",
+    "2d",
+    "canvas",
+    "rendering",
+    "visualization",
+    "scene-graph"
+  ],
+  "homepage": "https://weiliang0121.github.io/rendx/",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/weiliang0121/rendx.git",
+    "directory": "packages/history-plugin"
+  },
+  "main": "dist/main.cjs",
+  "module": "dist/main.js",
+  "types": "dist/main.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/main.d.ts",
+      "import": "./dist/main.js",
+      "require": "./dist/main.cjs"
+    }
+  },
+  "dependencies": {
+    "rendx-engine": "^0.2.0"
+  },
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch"
+  }
+}