@lupinum/board-history 0.1.0 → 1.0.0-beta.2

package/dist/vue.d.ts

@@ -0,0 +1,14 @@
+import { type PropType } from 'vue';
+import type { HistoryApi } from './index.js';
+/** Renderless undo/redo shortcuts scoped to the enclosing BoardRoot. */
+export declare const BoardHistoryShortcuts: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    history: {
+        type: PropType<HistoryApi>;
+        required: true;
+    };
+}>, () => null, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    history: {
+        type: PropType<HistoryApi>;
+        required: true;
+    };
+}>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

package/dist/vue.js

@@ -0,0 +1,59 @@
+// src/vue.ts
+import { defineComponent, toRaw, watch } from "vue";
+import { useBoardEngine } from "@lupinum/vue-board";
+import {
+  isBoardInteractiveEventTarget,
+  isEventOwnedByBoardRoot
+} from "@lupinum/board-core/internal";
+var BoardHistoryShortcuts = defineComponent({
+  name: "BoardHistoryShortcuts",
+  props: {
+    history: {
+      type: Object,
+      required: true
+    }
+  },
+  setup(props) {
+    const context = useBoardEngine();
+    function getOwnedHistory() {
+      const plugins = context.engine.plugins;
+      if (!("history" in plugins) || toRaw(plugins.history) !== toRaw(props.history)) {
+        throw new Error(
+          "BoardHistoryShortcuts history must belong to its enclosing BoardRoot engine."
+        );
+      }
+      return props.history;
+    }
+    getOwnedHistory();
+    watch(() => props.history, getOwnedHistory);
+    watch(
+      () => context.rootElement.value,
+      (root, _previous, onCleanup) => {
+        if (!root) return;
+        const onKeyDown = (event) => {
+          if (event.defaultPrevented || isBoardInteractiveEventTarget(event.target))
+            return;
+          if (!isEventOwnedByBoardRoot(event.target, root)) return;
+          if (!event.metaKey && !event.ctrlKey) return;
+          const key = event.key.toLowerCase();
+          const history = getOwnedHistory();
+          if (key === "z") {
+            event.preventDefault();
+            if (event.shiftKey) history.redo();
+            else history.undo();
+          } else if (key === "y") {
+            event.preventDefault();
+            history.redo();
+          }
+        };
+        root.addEventListener("keydown", onKeyDown);
+        onCleanup(() => root.removeEventListener("keydown", onKeyDown));
+      },
+      { immediate: true }
+    );
+    return () => null;
+  }
+});
+export {
+  BoardHistoryShortcuts
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lupinum/board-history",
-  "version": "0.1.0",
+  "version": "1.0.0-beta.2",
   "description": "Undo and redo plugin for @lupinum/board-core.",
   "license": "MIT",
   "author": "Lupinum OG <info@lupinum.com> (https://lupinum.com)",
@@ -18,6 +18,10 @@
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
+    },
+    "./vue": {
+      "types": "./dist/vue.d.ts",
+      "import": "./dist/vue.js"
     }
   },
   "repository": {
@@ -39,9 +43,24 @@
     "access": "public"
   },
   "peerDependencies": {
-    "@lupinum/board-core": "0.1.0"
+    "vue": "^3.5.0",
+    "@lupinum/board-core": "1.0.0-beta.2",
+    "@lupinum/vue-board": "1.0.0-beta.2"
+  },
+  "peerDependenciesMeta": {
+    "@lupinum/vue-board": {
+      "optional": true
+    },
+    "vue": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "vue": "^3.5.0",
+    "@lupinum/board-core": "1.0.0-beta.2",
+    "@lupinum/vue-board": "1.0.0-beta.2"
   },
   "scripts": {
-    "build": "tsup src/index.ts --format esm --clean && tsc -p tsconfig.build.json"
+    "build": "tsup src/index.ts src/vue.ts --format esm --clean && tsc -p tsconfig.build.json"
   }
 }