@inkbar/vue 0.5.0 → 0.6.0

package/README.md

@@ -126,11 +126,29 @@ The highlight tool leaves `contents` free for the comment. `doc.text(page)` retu
 
 `InkSignatureMenu` lists saved signatures, picks one for the `signature` tool, removes them, and opens `InkSignatureDialog` to draw, type or upload a new one. These are marks on the page, not cryptographic signatures. Pass `signatures` to `InkRoot` to keep them somewhere: `createLocalSignatureStore(key)` from `@inkbar/core` uses `localStorage`, and without it they last until reload. `signatureFonts` lists the handwriting fonts the Type tab offers; load them with `@font-face`. A placed signature keeps its aspect ratio when resized.
 
+## Plugins
+
+A plugin from `definePlugin` (in `@inkbar/core/dom`) adds commands, tools, decorations, page layers and its own record stores. Pass plugins to `InkRoot` once: the prop is read when the root is created. Nothing a plugin registers shows until you place it:
+
+```vue
+<InkRoot :src="src" :assets="assets" :plugins="[suggestions]">
+  <InkToolbar>
+    <InkCommand id="sandbox.suggest" />
+    <InkToolButton tool="sandbox.stamp" />
+  </InkToolbar>
+  <InkViewport />
+</InkRoot>
+```
+
+`InkCommand` is a button named by the command's label, disabled while the command is, and its status in a live region beside it. While the command runs, the button keeps focus and has `aria-busy` and `aria-disabled`, and pressing it does nothing. It shows the command's icon, or its label as text when the command has no icon. To build your own, `useCommand(id)` returns `run`, `enabled`, `busy`, `status`, `label` and `icon`. Plugins are set up once `InkRoot` has mounted in the browser, never on the server. Until then the command is disabled and has no label, and `InkCommand` keeps its button out of the accessibility tree (`aria-hidden`). `label` and `icon` are refs, like `enabled`, so they fill in then. An id no plugin registered stays that way: `InkCommand` and `useCommand` log an `InkError('UnknownCommand')` to the console once, naming the id and the registered ones, and nothing throws. A plugin whose `setup` throws is reported the same way, and the document still opens. `InkToolButton` takes a plugin tool's own label and icon.
+
+Plugin stores undo with annotations. In controlled mode with `:history="true"`, each undo step also snapshots the plugin stores, so accepting something and undoing it restores both.
+
 ## Custom rendering
 
 Slots let you render parts yourself. `InkViewport` has `loading`, `empty`, `error`, `annotation` and `page-error` slots. `InkThreadPopover` has a scoped default slot that receives the popover's props, and the default slot of `InkToolButton` receives `{ active, label }`. The props are typed as `AnnotationSlotProps` and `ThreadPopoverSlotProps`, the same types the React and Svelte packages export.
 
-`InkRoot`, `InkToolbar`, `InkToolButton`, `InkUndo`, `InkRedo`, `InkPrevPage`, `InkNextPage`, `InkZoomIn` and `InkZoomOut` take `as-child` to render your own element in place of theirs, such as a button from your design system. Put that element in the default slot. The control keeps its behaviour and accessible name.
+`InkRoot`, `InkToolbar`, `InkToolButton`, `InkCommand`, `InkUndo`, `InkRedo`, `InkPrevPage`, `InkNextPage`, `InkZoomIn` and `InkZoomOut` take `as-child` to render your own element in place of theirs, such as a button from your design system. Put that element in the default slot. The control keeps its behaviour and accessible name.
 
 ## Keyboard
 
@@ -156,7 +174,7 @@ Components carry state on data attributes, for example `[data-annotation][data-s
 
 ## Composables
 
-`useDocument`, `useAnnotations`, `useTool`, `useSelection`, `useZoom`, `usePage`, `useHistory` and `useEmbedded` read the state of the nearest `InkRoot`. Build your own toolbar or side panel from them. Tool options, such as the shape kind, last as long as `InkRoot`. The tool style that `useToolStyle` reads and sets (colours, line style, text style) belongs to the document: opening another one starts again from the theme's defaults.
+`useDocument`, `useAnnotations`, `useTool`, `useSelection`, `useZoom`, `usePage`, `useHistory`, `useEmbedded` and `useCommand` read the state of the nearest `InkRoot`. Build your own toolbar or side panel from them. Tool options, such as the shape kind, last as long as `InkRoot`. The tool style that `useToolStyle` reads and sets (colours, line style, text style) belongs to the document: opening another one starts again from the theme's defaults.
 
 ## Licence
 

package/dist/components/InkCommand.js

@@ -0,0 +1,7 @@
+import e from "./InkCommand.vue_vue_type_script_setup_true_lang.js";
+//#region src/components/InkCommand.vue
+var t = e;
+//#endregion
+export { t as default };
+
+//# sourceMappingURL=InkCommand.js.map

package/dist/components/InkCommand.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InkCommand.js","names":["_sfc_main","InkCommand_vue_vue_type_script_setup_true_lang_default","InkCommand_default"],"sources":["../../src/components/InkCommand.vue"],"sourcesContent":["<script setup lang=\"ts\">\n/*\n * A plugin command as a toolbar button with its status beside it: the markup of core's\n * `createCommandButton`, so the theme styles both alike. The button is named by the command's\n * label and disabled while the command is, except while it runs: then it keeps focus, with\n * `aria-busy` and `aria-disabled`, and a press does nothing. The status is a live region. A command without an icon shows its label as the button's text. Until the plugins\n * are set up (once InkRoot has mounted; never on the server) the button is disabled and\n * `aria-hidden`. An id no plugin registered stays that way and logs `InkError('UnknownCommand')`\n * to the console once.\n */\nimport { ToolbarButton } from 'reka-ui'\nimport { computed } from 'vue'\n\nimport { useCommand } from '../composables/useCommand'\n\nimport InkIcon from './InkIcon.vue'\n\nconst props = withDefaults(defineProps<{ id: string; asChild?: boolean }>(), {\n  asChild: false,\n})\n\n// The id is read once, as `useCommand` does: a different command is a different component.\nconst command = useCommand(props.id)\nconst { enabled, busy, status, label, icon } = command\n// Reka's typed props stop at its own; ARIA and listeners go through a bound object.\nconst attrs = computed(() => ({\n  type: 'button',\n  // No label until the plugins are set up: the disabled button stays out of the\n  // accessibility tree rather than go unnamed.\n  'aria-label': label.value || undefined,\n  title: label.value || undefined,\n  'aria-hidden': label.value ? undefined : 'true',\n  'aria-busy': String(busy.value),\n  // Disabled while it runs, but not `disabled`, so the button keeps focus.\n  'aria-disabled': busy.value ? 'true' : undefined,\n  onClick: () => void command.run(),\n}))\n</script>\n\n<template>\n  <div class=\"ink-command\">\n    <ToolbarButton\n      :as-child=\"asChild\"\n      :disabled=\"!enabled && !busy\"\n      :data-command=\"id\"\n      v-bind=\"attrs\"\n    >\n      <slot :label=\"label\" :busy=\"busy\">\n        <InkIcon v-if=\"icon\" :icon=\"icon\" />\n        <template v-else>{{ label }}</template>\n      </slot>\n    </ToolbarButton>\n    <span class=\"ink-command-status\" role=\"status\">{{ status }}</span>\n  </div>\n</template>\n"],"mappings":""}

package/dist/components/InkCommand.vue.d.ts

@@ -0,0 +1,23 @@
+type __VLS_Props = {
+    id: string;
+    asChild?: boolean;
+};
+declare var __VLS_7: {
+    label: string;
+    busy: boolean;
+};
+type __VLS_Slots = {} & {
+    default?: (props: typeof __VLS_7) => any;
+};
+declare const __VLS_base: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    asChild: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+//# sourceMappingURL=InkCommand.vue.d.ts.map

package/dist/components/InkCommand.vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"InkCommand.vue.d.ts","sourceRoot":"","sources":["../../src/components/InkCommand.vue"],"names":[],"mappings":"AA0EA,KAAK,WAAW,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC;AA2FrD,QAAA,IAAI,OAAO;;;CAAW,CAAC;AACvB,KAAK,WAAW,GAAG,EAAE,GACnB;IAAE,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,OAAO,KAAK,GAAG,CAAA;CAAE,CAAC;AAG/C,QAAA,MAAM,UAAU;;6EAGd,CAAC;AACH,QAAA,MAAM,YAAY,EAAS,eAAe,CAAC,OAAO,UAAU,EAAE,WAAW,CAAC,CAAC;wBACtD,OAAO,YAAY;AAAxC,wBAAyC;AAWzC,KAAK,eAAe,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAChC,QAAO;QACN,MAAM,EAAE,CAAC,CAAC;KACV,CAAA;CACD,CAAC"}

package/dist/components/InkCommand.vue_vue_type_script_setup_true_lang.js

@@ -0,0 +1,51 @@
+import { useCommand as e } from "../composables/useCommand.js";
+import t from "./InkIcon.js";
+import { Fragment as n, computed as r, createBlock as i, createElementBlock as a, createElementVNode as o, createTextVNode as s, createVNode as c, defineComponent as l, mergeProps as u, openBlock as d, renderSlot as f, toDisplayString as p, unref as m, withCtx as h } from "vue";
+import { ToolbarButton as g } from "reka-ui";
+//#region src/components/InkCommand.vue?vue&type=script&setup=true&lang.ts
+var _ = { class: "ink-command" }, v = {
+	class: "ink-command-status",
+	role: "status"
+}, y = /*@__PURE__*/ l({
+	__name: "InkCommand",
+	props: {
+		id: {},
+		asChild: {
+			type: Boolean,
+			default: !1
+		}
+	},
+	setup(l) {
+		let y = e(l.id), { enabled: b, busy: x, status: S, label: C, icon: w } = y, T = r(() => ({
+			type: "button",
+			"aria-label": C.value || void 0,
+			title: C.value || void 0,
+			"aria-hidden": C.value ? void 0 : "true",
+			"aria-busy": String(x.value),
+			"aria-disabled": x.value ? "true" : void 0,
+			onClick: () => void y.run()
+		}));
+		return (e, r) => (d(), a("div", _, [c(m(g), u({
+			"as-child": l.asChild,
+			disabled: !m(b) && !m(x),
+			"data-command": l.id
+		}, T.value), {
+			default: h(() => [f(e.$slots, "default", {
+				label: m(C),
+				busy: m(x)
+			}, () => [m(w) ? (d(), i(t, {
+				key: 0,
+				icon: m(w)
+			}, null, 8, ["icon"])) : (d(), a(n, { key: 1 }, [s(p(m(C)), 1)], 64))])]),
+			_: 3
+		}, 16, [
+			"as-child",
+			"disabled",
+			"data-command"
+		]), o("span", v, p(m(S)), 1)]));
+	}
+});
+//#endregion
+export { y as default };
+
+//# sourceMappingURL=InkCommand.vue_vue_type_script_setup_true_lang.js.map

package/dist/components/InkCommand.vue_vue_type_script_setup_true_lang.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InkCommand.vue_vue_type_script_setup_true_lang.js","names":["props","_openBlock","_createElementBlock","_createVNode","_unref","_mergeProps","_withCtx","_renderSlot","_createBlock","InkIcon","_Fragment","_createTextVNode","_toDisplayString","_createElementVNode","InkIcon_default","_hoisted_1","_hoisted_2","InkCommand_vue_vue_type_script_setup_true_lang_default","command","useCommand","__props","attrs","computed","label","busy","openBlock","createElementBlock","createVNode","unref","ToolbarButton","mergeProps","enabled","withCtx","renderSlot","_ctx","icon","createBlock","Fragment","createTextVNode","toDisplayString","createElementVNode","status"],"sources":["../../src/components/InkCommand.vue"],"sourcesContent":["<script setup lang=\"ts\">\n/*\n * A plugin command as a toolbar button with its status beside it: the markup of core's\n * `createCommandButton`, so the theme styles both alike. The button is named by the command's\n * label and disabled while the command is, except while it runs: then it keeps focus, with\n * `aria-busy` and `aria-disabled`, and a press does nothing. The status is a live region. A command without an icon shows its label as the button's text. Until the plugins\n * are set up (once InkRoot has mounted; never on the server) the button is disabled and\n * `aria-hidden`. An id no plugin registered stays that way and logs `InkError('UnknownCommand')`\n * to the console once.\n */\nimport { ToolbarButton } from 'reka-ui'\nimport { computed } from 'vue'\n\nimport { useCommand } from '../composables/useCommand'\n\nimport InkIcon from './InkIcon.vue'\n\nconst props = withDefaults(defineProps<{ id: string; asChild?: boolean }>(), {\n  asChild: false,\n})\n\n// The id is read once, as `useCommand` does: a different command is a different component.\nconst command = useCommand(props.id)\nconst { enabled, busy, status, label, icon } = command\n// Reka's typed props stop at its own; ARIA and listeners go through a bound object.\nconst attrs = computed(() => ({\n  type: 'button',\n  // No label until the plugins are set up: the disabled button stays out of the\n  // accessibility tree rather than go unnamed.\n  'aria-label': label.value || undefined,\n  title: label.value || undefined,\n  'aria-hidden': label.value ? undefined : 'true',\n  'aria-busy': String(busy.value),\n  // Disabled while it runs, but not `disabled`, so the button keeps focus.\n  'aria-disabled': busy.value ? 'true' : undefined,\n  onClick: () => void command.run(),\n}))\n</script>\n\n<template>\n  <div class=\"ink-command\">\n    <ToolbarButton\n      :as-child=\"asChild\"\n      :disabled=\"!enabled && !busy\"\n      :data-command=\"id\"\n      v-bind=\"attrs\"\n    >\n      <slot :label=\"label\" :busy=\"busy\">\n        <InkIcon v-if=\"icon\" :icon=\"icon\" />\n        <template v-else>{{ label }}</template>\n      </slot>\n    </ToolbarButton>\n    <span class=\"ink-command-status\" role=\"status\">{{ status }}</span>\n  </div>\n</template>\n"],"mappings":";;;;;;;;;;;;;;;;;;EAsBA,IAAMkB,IAAUC,EAAWnB,EAAM,EAAE,GAC7B,EAAE,YAAS,SAAM,WAAQ,UAAO,YAASkB,GAEzCG,IAAQC,SAAgB;GAC5B,MAAM;GAGN,cAAcC,EAAM,SAAS,KAAA;GAC7B,OAAOA,EAAM,SAAS,KAAA;GACtB,eAAeA,EAAM,QAAQ,KAAA,IAAY;GACzC,aAAa,OAAOC,EAAK,KAAK;GAE9B,iBAAiBA,EAAK,QAAQ,SAAS,KAAA;GACvC,eAAe,KAAKN,EAAQ,IAAI;EAClC,EAAE;oBAIAjB,EAAA,GAAAC,EAaM,OAbNa,GAaM,CAZJZ,EAUgBC,EAAAyB,CAAA,GAVhBxB,EAUgB;GATb,YAAUe,EAAA;GACV,UAAQ,CAAGhB,EAAA2B,CAAA,KAAO,CAAK3B,EAAAoB,CAAA;GACvB,gBAAcJ,EAAA;EACP,GAAAC,EAAA,KAAK,GAAA;GAEb,SAAAf,QAGO,CAHPC,EAGO2B,EAAA,QAAA,WAAA;IAHA,OAAO9B,EAAAmB,CAAA;IAAQ,MAAMnB,EAAAoB,CAAA;GAA5B,SAGO,CAFUpB,EAAA+B,CAAA,KAAflC,EAAA,GAAAO,EAAoCC,GAAA;;IAAd,MAAML,EAAA+B,CAAA;GAC5BlC,GAAAA,MAAAA,GAAAA,CAAAA,MAAAA,CAAAA,MAAAA,EAAA,GAAAC,EAAuCQ,GAAA,EAAA,KAAA,EAAA,GAAA,CAAnBC,EAAAC,EAAAR,EAAAmB,CAAA,CAAK,GAAA,CAAA,CAAA,GAAA,EAAA,EAAA,CAAA,CAAA,CAAA;;;;;;EAG7BV,CAAAA,GAAAA,EAAkE,QAAlEG,GAAkEJ,EAAhBR,EAAAqC,CAAA,CAAM,GAAA,CAAA,CAAA,CAAA"}

package/dist/components/InkPageInput.js.map

@@ -1 +1 @@
-{"version":3,"file":"InkPageInput.js","names":["_sfc_main","InkPageInput_vue_vue_type_script_setup_true_lang_default","InkPageInput_default"],"sources":["../../src/components/InkPageInput.vue"],"sourcesContent":["<script setup lang=\"ts\">\nimport { ref, watch } from 'vue'\n\nimport { usePage } from '../composables/usePage'\n\nconst { current, count, goTo } = usePage()\n// `v-model` on a number input hands back a number once the user types.\nconst draft = ref<string | number>(String(current.value + 1))\nwatch(current, (c) => (draft.value = String(c + 1)))\n\n/** 1-based in the input, 0-based in the viewport. Out of range resets to the current page. */\nfunction commit(): void {\n  const n = Number(draft.value)\n  if (Number.isInteger(n) && n >= 1 && n <= count.value) goTo(n - 1)\n  else draft.value = String(current.value + 1)\n}\n</script>\n\n<template>\n  <input\n    v-model=\"draft\"\n    class=\"ink-page-input\"\n    data-ink-page-input\n    type=\"number\"\n    inputmode=\"numeric\"\n    aria-label=\"Page\"\n    :min=\"1\"\n    :max=\"count\"\n    @change=\"commit\"\n    @keydown.enter.prevent=\"commit\"\n  />\n</template>\n"],"mappings":""}
+{"version":3,"file":"InkPageInput.js","names":["_sfc_main","InkPageInput_vue_vue_type_script_setup_true_lang_default","InkPageInput_default"],"sources":["../../src/components/InkPageInput.vue"],"sourcesContent":["<script setup lang=\"ts\">\nimport { ref, watch } from 'vue'\n\nimport { usePage } from '../composables/usePage'\n\nconst { current, count, goTo } = usePage()\n// `v-model` on a number input hands back a number once the user types.\nconst draft = ref<string | number>(String(current.value + 1))\nwatch(current, (c) => (draft.value = String(c + 1)))\n\n/**\n * 1-based in the input, 0-based in the viewport. Out of range resets to the current page. The\n * page on show is left alone, so the `change` that a blur fires never scrolls back to its top.\n */\nfunction commit(): void {\n  const n = Number(draft.value)\n  if (Number.isInteger(n) && n >= 1 && n <= count.value) {\n    if (n - 1 !== current.value) goTo(n - 1)\n  } else draft.value = String(current.value + 1)\n}\n</script>\n\n<template>\n  <input\n    v-model=\"draft\"\n    class=\"ink-page-input\"\n    data-ink-page-input\n    type=\"number\"\n    inputmode=\"numeric\"\n    aria-label=\"Page\"\n    :min=\"1\"\n    :max=\"count\"\n    @change=\"commit\"\n    @keydown.enter.prevent=\"commit\"\n  />\n</template>\n"],"mappings":""}

package/dist/components/InkPageInput.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"InkPageInput.vue.d.ts","sourceRoot":"","sources":["../../src/components/InkPageInput.vue"],"names":[],"mappings":"AAuEA,QAAA,MAAM,YAAY,+QAChB,CAAC;wBACkB,OAAO,YAAY;AAAxC,wBAAyC"}
+{"version":3,"file":"InkPageInput.vue.d.ts","sourceRoot":"","sources":["../../src/components/InkPageInput.vue"],"names":[],"mappings":"AA+EA,QAAA,MAAM,YAAY,+QAChB,CAAC;wBACkB,OAAO,YAAY;AAAxC,wBAAyC"}

package/dist/components/InkPageInput.vue_vue_type_script_setup_true_lang.js

@@ -8,7 +8,7 @@ var d = ["max", "onKeydown"], f = /*@__PURE__*/ n({
 		s(f, (e) => h.value = String(e + 1));
 		function g() {
 			let e = Number(h.value);
-			Number.isInteger(e) && e >= 1 && e <= p.value ? m(e - 1) : h.value = String(f.value + 1);
+			Number.isInteger(e) && e >= 1 && e <= p.value ? e - 1 !== f.value && m(e - 1) : h.value = String(f.value + 1);
 		}
 		return (e, n) => c((r(), t("input", {
 			"onUpdate:modelValue": n[0] ||= (e) => h.value = e,

package/dist/components/InkPageInput.vue_vue_type_script_setup_true_lang.js.map

@@ -1 +1 @@
-{"version":3,"file":"InkPageInput.vue_vue_type_script_setup_true_lang.js","names":["_withDirectives","_openBlock","_createElementBlock","_unref","_withKeys","_withModifiers","_vModelText","_hoisted_1","InkPageInput_vue_vue_type_script_setup_true_lang_default","usePage","draft","ref","current","c","commit","n","count","goTo","withDirectives","openBlock","createElementBlock","_cache","$event","unref","withKeys","withModifiers","vModelText"],"sources":["../../src/components/InkPageInput.vue"],"sourcesContent":["<script setup lang=\"ts\">\nimport { ref, watch } from 'vue'\n\nimport { usePage } from '../composables/usePage'\n\nconst { current, count, goTo } = usePage()\n// `v-model` on a number input hands back a number once the user types.\nconst draft = ref<string | number>(String(current.value + 1))\nwatch(current, (c) => (draft.value = String(c + 1)))\n\n/** 1-based in the input, 0-based in the viewport. Out of range resets to the current page. */\nfunction commit(): void {\n  const n = Number(draft.value)\n  if (Number.isInteger(n) && n >= 1 && n <= count.value) goTo(n - 1)\n  else draft.value = String(current.value + 1)\n}\n</script>\n\n<template>\n  <input\n    v-model=\"draft\"\n    class=\"ink-page-input\"\n    data-ink-page-input\n    type=\"number\"\n    inputmode=\"numeric\"\n    aria-label=\"Page\"\n    :min=\"1\"\n    :max=\"count\"\n    @change=\"commit\"\n    @keydown.enter.prevent=\"commit\"\n  />\n</template>\n"],"mappings":";;;;;;EAKA,IAAM,EAAE,YAAS,UAAO,YAASS,EAAQ,GAEnCC,IAAQC,EAAqB,OAAOC,EAAQ,QAAQ,CAAC,CAAC;EAC5D,EAAMA,IAAU,MAAO,EAAM,QAAQ,OAAOC,IAAI,CAAC,CAAE;EAGnD,SAASC,IAAe;GACtB,IAAMC,IAAI,OAAOL,EAAM,KAAK;GAC5B,AAAI,OAAO,UAAUK,CAAC,KAAKA,KAAK,KAAKA,KAAKC,EAAM,QAAOC,EAAKF,IAAI,CAAC,IAC5D,EAAM,QAAQ,OAAOH,EAAQ,QAAQ,CAAC;EAC7C;mBAIEZ,GAAAC,EAAA,GAAAC,EAWE,SAAA;GAVS,uBAAA,AAAAmB,EAAA,QAAA,MAAA,EAAK,QAAAC;GACd,OAAM;GACN,uBAAA;GACA,MAAK;GACL,WAAU;GACV,cAAW;GACV,KAAK;GACL,KAAKnB,EAAAa,CAAA;GACL,UAAQF;GACR,WAAOV,EAAAC,EAAgBS,GAAM,CAAA,SAAA,CAAA,GAAA,CAAA,OAAA,CAAA;EATrB,GAAA,MAAA,IAAAP,CAAA,IAAA,CAAA,CAAAD,GAAAI,EAAA,KAAK,CAAA,CAAA"}
+{"version":3,"file":"InkPageInput.vue_vue_type_script_setup_true_lang.js","names":["_withDirectives","_openBlock","_createElementBlock","_unref","_withKeys","_withModifiers","_vModelText","_hoisted_1","InkPageInput_vue_vue_type_script_setup_true_lang_default","usePage","draft","ref","current","c","commit","n","count","goTo","withDirectives","openBlock","createElementBlock","_cache","$event","unref","withKeys","withModifiers","vModelText"],"sources":["../../src/components/InkPageInput.vue"],"sourcesContent":["<script setup lang=\"ts\">\nimport { ref, watch } from 'vue'\n\nimport { usePage } from '../composables/usePage'\n\nconst { current, count, goTo } = usePage()\n// `v-model` on a number input hands back a number once the user types.\nconst draft = ref<string | number>(String(current.value + 1))\nwatch(current, (c) => (draft.value = String(c + 1)))\n\n/**\n * 1-based in the input, 0-based in the viewport. Out of range resets to the current page. The\n * page on show is left alone, so the `change` that a blur fires never scrolls back to its top.\n */\nfunction commit(): void {\n  const n = Number(draft.value)\n  if (Number.isInteger(n) && n >= 1 && n <= count.value) {\n    if (n - 1 !== current.value) goTo(n - 1)\n  } else draft.value = String(current.value + 1)\n}\n</script>\n\n<template>\n  <input\n    v-model=\"draft\"\n    class=\"ink-page-input\"\n    data-ink-page-input\n    type=\"number\"\n    inputmode=\"numeric\"\n    aria-label=\"Page\"\n    :min=\"1\"\n    :max=\"count\"\n    @change=\"commit\"\n    @keydown.enter.prevent=\"commit\"\n  />\n</template>\n"],"mappings":";;;;;;EAKA,IAAM,EAAE,YAAS,UAAO,YAASS,EAAQ,GAEnCC,IAAQC,EAAqB,OAAOC,EAAQ,QAAQ,CAAC,CAAC;EAC5D,EAAMA,IAAU,MAAO,EAAM,QAAQ,OAAOC,IAAI,CAAC,CAAE;EAMnD,SAASC,IAAe;GACtB,IAAMC,IAAI,OAAOL,EAAM,KAAK;GAC5B,AAAI,OAAO,UAAUK,CAAC,KAAKA,KAAK,KAAKA,KAAKC,EAAM,QAC1CD,IAAI,MAAMH,EAAQ,SAAOK,EAAKF,IAAI,CAAC,IAClC,EAAM,QAAQ,OAAOH,EAAQ,QAAQ,CAAC;EAC/C;mBAIEZ,GAAAC,EAAA,GAAAC,EAWE,SAAA;GAVS,uBAAA,AAAAmB,EAAA,QAAA,MAAA,EAAK,QAAAC;GACd,OAAM;GACN,uBAAA;GACA,MAAK;GACL,WAAU;GACV,cAAW;GACV,KAAK;GACL,KAAKnB,EAAAa,CAAA;GACL,UAAQF;GACR,WAAOV,EAAAC,EAAgBS,GAAM,CAAA,SAAA,CAAA,GAAA,CAAA,OAAA,CAAA;EATrB,GAAA,MAAA,IAAAP,CAAA,IAAA,CAAA,CAAAD,GAAAI,EAAA,KAAK,CAAA,CAAA"}

package/dist/components/InkRoot.js.map

@@ -1 +1 @@
-{"version":3,"file":"InkRoot.js","names":["_sfc_main","InkRoot_vue_vue_type_script_setup_true_lang_default","InkRoot_default"],"sources":["../../src/components/InkRoot.vue"],"sourcesContent":["<script setup lang=\"ts\">\nimport {\n  createMemorySignatureStore,\n  createSignatureLibrary,\n  InkError,\n  openDocument,\n} from '@inkbar/core'\nimport {\n  createToolOptions,\n  cssVariableDefaults,\n  FONT_FAMILIES,\n  SIGNATURE_FONTS,\n  trackToolStyle,\n} from '@inkbar/core/dom'\nimport { Primitive } from 'reka-ui'\nimport {\n  computed,\n  onBeforeUnmount,\n  onMounted,\n  onUpdated,\n  ref,\n  shallowRef,\n  useTemplateRef,\n  watch,\n} from 'vue'\n\nimport { provideInkContext, type InkHistory, type InkStatus } from '../context'\nimport { createRefHistory } from '../ref-history'\nimport { useReadable } from '../use-readable'\n\nimport type {\n  Annotation,\n  AnnotationChange,\n  AnnotationDefaults,\n  DocumentSource,\n  InkDocument,\n  PdfAssets,\n  SignatureStore,\n} from '@inkbar/core'\nimport type {\n  DecorateAnnotation,\n  Tool,\n  ToolController,\n  ToolId,\n  ToolStyle,\n  Viewport,\n  ZoomValue,\n} from '@inkbar/core/dom'\n\nconst props = withDefaults(\n  defineProps<{\n    src: DocumentSource | null\n    assets: PdfAssets\n    password?: string | undefined\n    /** Colour defaults. Without it, the theme's CSS variables on the root element apply. */\n    defaults?: AnnotationDefaults | undefined\n    /**\n     * Pass (with v-model) to put annotations under the host's control. The mode is fixed when a\n     * document opens: passing or dropping this prop later takes effect on the next open.\n     */\n    annotations?: Annotation[] | undefined\n    tool?: ToolId | undefined\n    /**\n     * Host tools, added to the built-ins; one with a built-in's id replaces it. Read when a\n     * document opens.\n     */\n    tools?: Tool[] | undefined\n    /**\n     * Adds `data-*` attributes, classes and a screen-reader description to each annotation's\n     * element (see `DecorateAnnotation`). Decorations re-apply whenever the annotations change\n     * and when this prop changes, without rebuilding the viewer. Pass a new function when its\n     * output would change for any other reason.\n     */\n    decorateAnnotation?: DecorateAnnotation | undefined\n    /**\n     * The font families text boxes offer, replacing the PDF standard families\n     * (`FONT_FAMILIES`). Fonts beyond those are the PDF writer's to embed.\n     */\n    fonts?: string[] | undefined\n    /**\n     * Where saved signatures live. Default: memory, gone on reload.\n     * `createLocalSignatureStore` keeps them in the browser; a host can keep them anywhere.\n     * A new store takes effect at once, for the menus and the `signature` tool alike.\n     */\n    signatures?: SignatureStore | undefined\n    /** The handwriting fonts a typed signature offers; the host loads them. */\n    signatureFonts?: string[] | undefined\n    page?: number | undefined\n    zoom?: ZoomValue | undefined\n    /** Undo history. Defaults to on for uncontrolled, off for controlled. */\n    history?: boolean | undefined\n    asChild?: boolean\n  }>(),\n  {\n    password: undefined,\n    defaults: undefined,\n    annotations: undefined,\n    tool: undefined,\n    tools: undefined,\n    decorateAnnotation: undefined,\n    fonts: undefined,\n    signatures: undefined,\n    signatureFonts: undefined,\n    page: undefined,\n    zoom: undefined,\n    history: undefined,\n    asChild: false,\n  }\n)\n\nconst emit = defineEmits<{\n  'update:annotations': [next: Annotation[]]\n  change: [change: AnnotationChange]\n  'update:tool': [tool: ToolId]\n  'update:page': [page: number]\n  'update:zoom': [zoom: ZoomValue]\n  ready: [doc: InkDocument]\n  error: [error: InkError]\n  activate: [id: string]\n}>()\n\ntype TestHookElement = HTMLElement & { __inkDocument?: InkDocument | undefined }\n\n// A template ref on Primitive is a component instance; the context needs its element.\nconst primitive = useTemplateRef<{ $el: unknown }>('primitive')\nconst rootEl = shallowRef<HTMLElement | null>(null)\nfunction syncRootEl(): void {\n  const el = primitive.value?.$el\n  rootEl.value = el instanceof HTMLElement ? el : null\n}\n\nconst document = shallowRef<InkDocument | null>(null)\n/** Overrides the document's status while opening, and when opening itself failed. */\nconst override = shallowRef<InkStatus | null>(null)\nconst idle: InkStatus = { state: 'idle' }\nconst documentStatus = useReadable<InkStatus>(() => document.value?.status ?? null, idle)\nconst status = computed<InkStatus>(() => override.value ?? documentStatus.value)\nconst annotationList = useReadable<readonly Annotation[]>(\n  () => document.value?.annotations.list ?? null,\n  []\n)\nconst selection = useReadable<readonly string[]>(\n  () => document.value?.annotations.selection ?? null,\n  []\n)\nconst viewport = shallowRef<Viewport | null>(null)\nconst toolController = shallowRef<ToolController | null>(null)\nconst internalTool = ref<ToolId>(props.tool ?? 'select-text')\nconst activated = ref<string | null>(null)\n\nconst controlled = computed(() => props.annotations !== undefined)\n\n/** Signed URLs change; the key does not. Bytes and Blobs are their own identity. */\nfunction identity(src: DocumentSource | null): unknown {\n  if (src === null) return null\n  if (typeof src === 'string') return src\n  if ('key' in src) return src.key\n  return src\n}\n\nfunction setTestHook(doc: InkDocument | undefined): void {\n  if (import.meta.env.DEV && rootEl.value)\n    (rootEl.value as TestHookElement).__inkDocument = doc\n}\n\nlet generation = 0\nfunction release(): void {\n  document.value?.destroy()\n  document.value = null\n  setTestHook(undefined)\n}\n\nasync function open(): Promise<void> {\n  const gen = ++generation\n  const src = props.src\n  release()\n  refHistory.clear()\n  if (src === null) {\n    override.value = null\n    return\n  }\n  override.value = { state: 'loading' }\n  syncRootEl()\n  let doc: InkDocument\n  try {\n    doc = await openDocument(src, {\n      assets: props.assets,\n      password: props.password,\n      defaults:\n        props.defaults ?? (rootEl.value ? cssVariableDefaults(rootEl.value) : undefined),\n      // Controlled hosts get the ref history below; core's own stack stays off.\n      history: controlled.value ? false : (props.history ?? true),\n      annotations: controlled.value\n        ? {\n            mode: 'controlled',\n            initial: props.annotations ?? [],\n            onChange: (next, change) => {\n              emit('update:annotations', next)\n              emit('change', change)\n            },\n          }\n        : { mode: 'uncontrolled' },\n    })\n  } catch (cause) {\n    if (gen !== generation) return\n    const error =\n      cause instanceof InkError\n        ? cause\n        : new InkError(\n            'InvalidPdf',\n            cause instanceof Error ? cause.message : String(cause),\n            {},\n            cause\n          )\n    override.value = { state: 'error', error }\n    emit('error', error)\n    return\n  }\n  if (gen !== generation) {\n    doc.destroy()\n    return\n  }\n  // The prop may have changed while the file loaded, when there was no store to apply it to.\n  if (doc.annotations.mode === 'controlled' && props.annotations !== undefined)\n    doc.annotations.setControlledValue(props.annotations)\n  document.value = doc\n  override.value = null\n  setTestHook(doc)\n  const s = doc.status.get()\n  if (s.state === 'ready') emit('ready', doc)\n  else if (s.state === 'error') emit('error', s.error)\n}\n\nconst refHistory = createRefHistory({\n  source: () => props.annotations,\n  apply: (list) => document.value?.annotations.replaceAll(list, 'history'),\n  enabled: computed(() => controlled.value && props.history === true),\n})\nconst coreCanUndo = useReadable(() => document.value?.history.canUndo ?? null, false)\nconst coreCanRedo = useReadable(() => document.value?.history.canRedo ?? null, false)\nconst inkHistory: InkHistory = {\n  canUndo: computed(() =>\n    controlled.value ? refHistory.canUndo.value : coreCanUndo.value\n  ),\n  canRedo: computed(() =>\n    controlled.value ? refHistory.canRedo.value : coreCanRedo.value\n  ),\n  undo: () => (controlled.value ? refHistory.undo() : document.value?.history.undo()),\n  redo: () => (controlled.value ? refHistory.redo() : document.value?.history.redo()),\n  clear: () => (controlled.value ? refHistory.clear() : document.value?.history.clear()),\n  batch: (fn) => {\n    if (controlled.value) refHistory.batch(fn)\n    else if (document.value) document.value.history.batch(fn)\n    else fn()\n  },\n}\n\n/** The document's tool style; it batches through `inkHistory`, whichever mode is on. */\nconst toolStyle = shallowRef<ToolStyle | null>(null)\nlet setStyleTool: ((id: ToolId) => void) | undefined\nwatch(\n  document,\n  (doc) => {\n    if (!doc) {\n      toolStyle.value = null\n      setStyleTool = undefined\n      return\n    }\n    const tracker = trackToolStyle({\n      store: doc.annotations,\n      history: { batch: (fn) => inkHistory.batch(fn) },\n      tools: props.tools,\n      tool: internalTool.value,\n    })\n    setStyleTool = (id) => tracker.setTool(id)\n    toolStyle.value = tracker.toolStyle\n  },\n  // Sync: the style is in place before InkViewport's watcher mounts the engine with it.\n  { immediate: true, flush: 'sync' }\n)\nwatch(internalTool, (id) => setStyleTool?.(id))\n\n// Open on the client only: on the server InkRoot renders its empty slot.\nonMounted(() => {\n  syncRootEl()\n  void open()\n})\nonUpdated(syncRootEl)\n\n// Separate sources, so a new `{ url, key }` object with the same key compares equal.\nwatch([() => identity(props.src), () => props.password], () => void open())\n\nwatch(\n  () => props.annotations,\n  (next) => {\n    if (next && document.value?.annotations.mode === 'controlled')\n      document.value.annotations.setControlledValue(next)\n  }\n)\n\nwatch(\n  () => props.tool,\n  (t) => {\n    if (t) internalTool.value = t\n  }\n)\n\nfunction setTool(id: ToolId): void {\n  // Picking the active tool again starts it afresh, as after a one-shot tool's use.\n  const tc = toolController.value\n  if (internalTool.value === id && tc?.active.get() === id) tc.set(id)\n  internalTool.value = id\n  emit('update:tool', id)\n}\n\nonBeforeUnmount(() => {\n  generation++\n  release()\n})\n\nconst signatures = computed(() =>\n  createSignatureLibrary(props.signatures ?? createMemorySignatureStore())\n)\nwatch(signatures, (lib) => void lib.refresh(), { immediate: true })\n/** Tool options last as long as the root; the tool style is per document. */\nconst toolOptions = createToolOptions()\n\nprovideInkContext({\n  assets: computed(() => props.assets),\n  document,\n  status,\n  annotations: annotationList,\n  selection,\n  viewport,\n  tools: toolController,\n  tool: internalTool,\n  setTool,\n  hostTools: computed(() => props.tools),\n  decorateAnnotation: computed(() => props.decorateAnnotation),\n  fonts: computed(() => props.fonts ?? FONT_FAMILIES),\n  toolOptions,\n  signatures,\n  signatureFonts: computed(() => props.signatureFonts ?? SIGNATURE_FONTS),\n  toolStyle,\n  zoomModel: computed(() => props.zoom),\n  pageModel: computed(() => props.page),\n  reportZoom: (z) => emit('update:zoom', z),\n  reportPage: (p) => emit('update:page', p),\n  activated,\n  setActivated(id) {\n    activated.value = id\n    if (id) emit('activate', id)\n  },\n  history: inkHistory,\n  rootEl,\n})\n\n// `history` is what `useHistory()` returns inside the root, for hosts that hold a template ref:\n// a controlled host calls `history.clear()` after loading its saved list.\ndefineExpose({ document, status, rootEl, history: inkHistory })\n</script>\n\n<template>\n  <Primitive\n    ref=\"primitive\"\n    :as-child=\"props.asChild\"\n    as=\"div\"\n    data-ink-root\n    :data-state=\"status.state\"\n  >\n    <slot :status=\"status\" :document=\"document\" />\n  </Primitive>\n</template>\n"],"mappings":""}
+{"version":3,"file":"InkRoot.js","names":["_sfc_main","InkRoot_vue_vue_type_script_setup_true_lang_default","InkRoot_default"],"sources":["../../src/components/InkRoot.vue"],"sourcesContent":["<script setup lang=\"ts\">\nimport {\n  createMemorySignatureStore,\n  createSignatureLibrary,\n  InkError,\n  openDocument,\n  readonly,\n  writable,\n} from '@inkbar/core'\nimport {\n  createPluginHost,\n  createToolOptions,\n  cssVariableDefaults,\n  FONT_FAMILIES,\n  SIGNATURE_FONTS,\n  trackToolStyle,\n} from '@inkbar/core/dom'\nimport { Primitive } from 'reka-ui'\nimport {\n  computed,\n  onBeforeUnmount,\n  onUnmounted,\n  onMounted,\n  onUpdated,\n  ref,\n  shallowRef,\n  useTemplateRef,\n  watch,\n} from 'vue'\n\nimport { provideInkContext, type InkHistory, type InkStatus } from '../context'\nimport { createRefHistory } from '../ref-history'\nimport { useReadable } from '../use-readable'\n\nimport type {\n  Annotation,\n  AnnotationChange,\n  AnnotationDefaults,\n  DocumentSource,\n  InkDocument,\n  PdfAssets,\n  SignatureStore,\n} from '@inkbar/core'\nimport type {\n  DecorateAnnotation,\n  InkPlugin,\n  PluginHost,\n  Tool,\n  ToolController,\n  ToolId,\n  ToolStyle,\n  Viewport,\n  ZoomValue,\n} from '@inkbar/core/dom'\n\nconst props = withDefaults(\n  defineProps<{\n    src: DocumentSource | null\n    assets: PdfAssets\n    password?: string | undefined\n    /** Colour defaults. Without it, the theme's CSS variables on the root element apply. */\n    defaults?: AnnotationDefaults | undefined\n    /**\n     * Pass (with v-model) to put annotations under the host's control. The mode is fixed when a\n     * document opens: passing or dropping this prop later takes effect on the next open.\n     */\n    annotations?: Annotation[] | undefined\n    tool?: ToolId | undefined\n    /**\n     * Host tools, added to the built-ins; one with a built-in's id replaces it. Read when a\n     * document opens.\n     */\n    tools?: Tool[] | undefined\n    /**\n     * Plugins, set up once when the root is created; a later change to this prop is not\n     * applied. Their tools join `tools`, their decoration and page layers apply to every\n     * document, and their commands are placed with `InkCommand` or `useCommand`.\n     */\n    plugins?: InkPlugin[] | undefined\n    /**\n     * Adds `data-*` attributes, classes and a screen-reader description to each annotation's\n     * element (see `DecorateAnnotation`). Decorations re-apply whenever the annotations change\n     * and when this prop changes, without rebuilding the viewer. Pass a new function when its\n     * output would change for any other reason.\n     */\n    decorateAnnotation?: DecorateAnnotation | undefined\n    /**\n     * The font families text boxes offer, replacing the PDF standard families\n     * (`FONT_FAMILIES`). Fonts beyond those are the PDF writer's to embed.\n     */\n    fonts?: string[] | undefined\n    /**\n     * Where saved signatures live. Default: memory, gone on reload.\n     * `createLocalSignatureStore` keeps them in the browser; a host can keep them anywhere.\n     * A new store takes effect at once, for the menus and the `signature` tool alike.\n     */\n    signatures?: SignatureStore | undefined\n    /** The handwriting fonts a typed signature offers; the host loads them. */\n    signatureFonts?: string[] | undefined\n    page?: number | undefined\n    zoom?: ZoomValue | undefined\n    /** Undo history. Defaults to on for uncontrolled, off for controlled. */\n    history?: boolean | undefined\n    asChild?: boolean\n  }>(),\n  {\n    password: undefined,\n    defaults: undefined,\n    annotations: undefined,\n    tool: undefined,\n    tools: undefined,\n    plugins: undefined,\n    decorateAnnotation: undefined,\n    fonts: undefined,\n    signatures: undefined,\n    signatureFonts: undefined,\n    page: undefined,\n    zoom: undefined,\n    history: undefined,\n    asChild: false,\n  }\n)\n\nconst emit = defineEmits<{\n  'update:annotations': [next: Annotation[]]\n  change: [change: AnnotationChange]\n  'update:tool': [tool: ToolId]\n  'update:page': [page: number]\n  'update:zoom': [zoom: ZoomValue]\n  ready: [doc: InkDocument]\n  error: [error: InkError]\n  activate: [id: string]\n}>()\n\ntype TestHookElement = HTMLElement & { __inkDocument?: InkDocument | undefined }\n\n// A template ref on Primitive is a component instance; the context needs its element.\nconst primitive = useTemplateRef<{ $el: unknown }>('primitive')\nconst rootEl = shallowRef<HTMLElement | null>(null)\nfunction syncRootEl(): void {\n  const el = primitive.value?.$el\n  rootEl.value = el instanceof HTMLElement ? el : null\n}\n\nconst document = shallowRef<InkDocument | null>(null)\n/** Overrides the document's status while opening, and when opening itself failed. */\nconst override = shallowRef<InkStatus | null>(null)\nconst idle: InkStatus = { state: 'idle' }\nconst documentStatus = useReadable<InkStatus>(() => document.value?.status ?? null, idle)\nconst status = computed<InkStatus>(() => override.value ?? documentStatus.value)\nconst annotationList = useReadable<readonly Annotation[]>(\n  () => document.value?.annotations.list ?? null,\n  []\n)\nconst selection = useReadable<readonly string[]>(\n  () => document.value?.annotations.selection ?? null,\n  []\n)\nconst viewport = shallowRef<Viewport | null>(null)\nconst toolController = shallowRef<ToolController | null>(null)\nconst internalTool = ref<ToolId>(props.tool ?? 'select-text')\nconst activated = ref<string | null>(null)\n\nconst controlled = computed(() => props.annotations !== undefined)\n\nfunction setActivated(id: string | null): void {\n  activated.value = id\n  if (id) emit('activate', id)\n}\n\nconst noop = () => {}\n\n/** Signed URLs change; the key does not. Bytes and Blobs are their own identity. */\nfunction identity(src: DocumentSource | null): unknown {\n  if (src === null) return null\n  if (typeof src === 'string') return src\n  if ('key' in src) return src.key\n  return src\n}\n\nfunction setTestHook(doc: InkDocument | undefined): void {\n  if (import.meta.env.DEV && rootEl.value)\n    (rootEl.value as TestHookElement).__inkDocument = doc\n}\n\nlet generation = 0\nfunction release(): void {\n  // Cleared first, so the plugins close their stores while the document is still alive.\n  const doc = document.value\n  document.value = null\n  doc?.destroy()\n  setTestHook(undefined)\n}\n\nasync function open(): Promise<void> {\n  const gen = ++generation\n  const src = props.src\n  release()\n  refHistory.clear()\n  if (src === null) {\n    override.value = null\n    return\n  }\n  override.value = { state: 'loading' }\n  syncRootEl()\n  let doc: InkDocument\n  try {\n    doc = await openDocument(src, {\n      assets: props.assets,\n      password: props.password,\n      defaults:\n        props.defaults ?? (rootEl.value ? cssVariableDefaults(rootEl.value) : undefined),\n      // Controlled hosts get the ref history below; core's own stack stays off.\n      history: controlled.value ? false : (props.history ?? true),\n      annotations: controlled.value\n        ? {\n            mode: 'controlled',\n            initial: props.annotations ?? [],\n            onChange: (next, change) => {\n              emit('update:annotations', next)\n              emit('change', change)\n            },\n          }\n        : { mode: 'uncontrolled' },\n    })\n  } catch (cause) {\n    if (gen !== generation) return\n    const error =\n      cause instanceof InkError\n        ? cause\n        : new InkError(\n            'InvalidPdf',\n            cause instanceof Error ? cause.message : String(cause),\n            {},\n            cause\n          )\n    override.value = { state: 'error', error }\n    emit('error', error)\n    return\n  }\n  if (gen !== generation) {\n    doc.destroy()\n    return\n  }\n  // The prop may have changed while the file loaded, when there was no store to apply it to.\n  if (doc.annotations.mode === 'controlled' && props.annotations !== undefined)\n    doc.annotations.setControlledValue(props.annotations)\n  document.value = doc\n  override.value = null\n  setTestHook(doc)\n  const s = doc.status.get()\n  if (s.state === 'ready') emit('ready', doc)\n  else if (s.state === 'error') emit('error', s.error)\n}\n\nconst refHistory = createRefHistory({\n  source: () => props.annotations,\n  apply: (list) => document.value?.annotations.replaceAll(list, 'history'),\n  enabled: computed(() => controlled.value && props.history === true),\n  store: () =>\n    document.value?.annotations.mode === 'controlled' ? document.value.annotations : null,\n})\nconst coreCanUndo = useReadable(() => document.value?.history.canUndo ?? null, false)\nconst coreCanRedo = useReadable(() => document.value?.history.canRedo ?? null, false)\nconst inkHistory: InkHistory = {\n  canUndo: computed(() =>\n    controlled.value ? refHistory.canUndo.value : coreCanUndo.value\n  ),\n  canRedo: computed(() =>\n    controlled.value ? refHistory.canRedo.value : coreCanRedo.value\n  ),\n  undo: () => (controlled.value ? refHistory.undo() : document.value?.history.undo()),\n  redo: () => (controlled.value ? refHistory.redo() : document.value?.history.redo()),\n  clear: () => (controlled.value ? refHistory.clear() : document.value?.history.clear()),\n  batch: (fn) => {\n    if (controlled.value) refHistory.batch(fn)\n    else if (document.value) document.value.history.batch(fn)\n    else fn()\n  },\n  track: (store) =>\n    controlled.value\n      ? refHistory.track(store)\n      : (document.value?.history.track(store) ?? noop),\n  react: (fn) =>\n    controlled.value ? refHistory.react(fn) : (document.value?.history.react(fn) ?? noop),\n}\n\n/*\n * One plugin host for the root's life, built once mounted so that no `setup` runs on the\n * server, where nothing would clean it up. Until then `pluginHost` is null, and InkCommand\n * renders its command disabled. The host follows `hostDocument`, which is set after `document`\n * (a sync watch): when the host reads `inkHistory` for a new document, it is that document's\n * history.\n */\nconst hostDocument = writable<InkDocument | null>(null)\nwatch(document, (doc) => hostDocument.set(doc), { flush: 'sync' })\nconst viewportEl = shallowRef<HTMLElement | null>(null)\nconst hostRoot = writable<HTMLElement | null>(null)\nwatch(viewportEl, (el) => hostRoot.set(el), { flush: 'sync' })\nconst hostActivated = writable<string | null>(null)\nwatch(activated, (id) => hostActivated.set(id), { flush: 'sync' })\nconst pluginHost = shallowRef<PluginHost | null>(null)\nfunction setUpPlugins(): void {\n  pluginHost.value = createPluginHost({\n    plugins: props.plugins ?? [],\n    document: readonly(hostDocument),\n    history: () => inkHistory,\n    activated: readonly(hostActivated),\n    // As in `createViewer`: an id not in the open document is ignored.\n    setActivated: (id) => {\n      if (id === null || document.value?.annotations.get(id)) setActivated(id)\n    },\n    root: readonly(hostRoot),\n    decorate: () => props.decorateAnnotation,\n    viewport: () => viewport.value,\n  })\n}\n\n/** The document's tool style; it batches through `inkHistory`, whichever mode is on. */\nconst toolStyle = shallowRef<ToolStyle | null>(null)\nlet setStyleTool: ((id: ToolId) => void) | undefined\nwatch(\n  document,\n  (doc) => {\n    if (!doc) {\n      toolStyle.value = null\n      setStyleTool = undefined\n      return\n    }\n    const tracker = trackToolStyle({\n      store: doc.annotations,\n      history: { batch: (fn) => inkHistory.batch(fn) },\n      // The plugins' tools too, so a plugin tool's style group applies (the host is set by now:\n      // it is built on mount, before the first document opens).\n      tools: [...(props.tools ?? []), ...(pluginHost.value?.tools ?? [])],\n      tool: internalTool.value,\n    })\n    setStyleTool = (id) => tracker.setTool(id)\n    toolStyle.value = tracker.toolStyle\n  },\n  // Sync: the style is in place before InkViewport's watcher mounts the engine with it.\n  { immediate: true, flush: 'sync' }\n)\nwatch(internalTool, (id) => setStyleTool?.(id))\n\n// Plugins and the document on the client only: on the server InkRoot renders its empty slot.\n// The plugins first, so the first document opens with their stores and reactions.\nonMounted(() => {\n  syncRootEl()\n  // A plugin whose setup throws still leaves the document to open; the error then goes to\n  // Vue's error handling (`onErrorCaptured`, `app.config.errorHandler`).\n  try {\n    setUpPlugins()\n  } finally {\n    void open()\n  }\n})\nonUpdated(syncRootEl)\n\n// Separate sources, so a new `{ url, key }` object with the same key compares equal.\nwatch([() => identity(props.src), () => props.password], () => void open())\n\nwatch(\n  () => props.annotations,\n  (next) => {\n    if (next && document.value?.annotations.mode === 'controlled')\n      document.value.annotations.setControlledValue(next)\n  }\n)\n\nwatch(\n  () => props.tool,\n  (t) => {\n    if (t) internalTool.value = t\n  }\n)\n\nfunction setTool(id: ToolId): void {\n  // Picking the active tool again starts it afresh, as after a one-shot tool's use.\n  const tc = toolController.value\n  if (internalTool.value === id && tc?.active.get() === id) tc.set(id)\n  internalTool.value = id\n  emit('update:tool', id)\n}\n\nonBeforeUnmount(() => {\n  generation++\n  release()\n})\n\n// After the children: InkViewport's engine, and the plugin layers with it, are gone by now, as\n// in `createViewer`, so no layer `destroy` runs after the plugins' cleanups.\nonUnmounted(() => {\n  pluginHost.value?.destroy()\n  pluginHost.value = null\n})\n\nconst signatures = computed(() =>\n  createSignatureLibrary(props.signatures ?? createMemorySignatureStore())\n)\nwatch(signatures, (lib) => void lib.refresh(), { immediate: true })\n/** Tool options last as long as the root; the tool style is per document. */\nconst toolOptions = createToolOptions()\n\nprovideInkContext({\n  assets: computed(() => props.assets),\n  document,\n  status,\n  annotations: annotationList,\n  selection,\n  viewport,\n  tools: toolController,\n  tool: internalTool,\n  setTool,\n  hostTools: computed(() => props.tools),\n  decorateAnnotation: computed(() => props.decorateAnnotation),\n  fonts: computed(() => props.fonts ?? FONT_FAMILIES),\n  toolOptions,\n  signatures,\n  signatureFonts: computed(() => props.signatureFonts ?? SIGNATURE_FONTS),\n  toolStyle,\n  zoomModel: computed(() => props.zoom),\n  pageModel: computed(() => props.page),\n  reportZoom: (z) => emit('update:zoom', z),\n  reportPage: (p) => emit('update:page', p),\n  activated,\n  setActivated,\n  pluginHost,\n  viewportEl,\n  history: inkHistory,\n  rootEl,\n})\n\n// `history` is what `useHistory()` returns inside the root, for hosts that hold a template ref:\n// a controlled host calls `history.clear()` after loading its saved list.\ndefineExpose({ document, status, rootEl, history: inkHistory })\n</script>\n\n<template>\n  <Primitive\n    ref=\"primitive\"\n    :as-child=\"props.asChild\"\n    as=\"div\"\n    data-ink-root\n    :data-state=\"status.state\"\n  >\n    <slot :status=\"status\" :document=\"document\" />\n  </Primitive>\n</template>\n"],"mappings":""}

package/dist/components/InkRoot.vue.d.ts

@@ -1,6 +1,6 @@
 import { InkError, Annotation, AnnotationChange, AnnotationDefaults, DocumentSource, InkDocument, PdfAssets, SignatureStore } from '@inkbar/core';
 import { InkHistory, InkStatus } from '../context';
-import { DecorateAnnotation, Tool, ToolId, ZoomValue } from '@inkbar/core/dom';
+import { DecorateAnnotation, InkPlugin, Tool, ToolId, ZoomValue } from '@inkbar/core/dom';
 type __VLS_Props = {
     src: DocumentSource | null;
     assets: PdfAssets;
@@ -18,6 +18,12 @@ type __VLS_Props = {
      * document opens.
      */
     tools?: Tool[] | undefined;
+    /**
+     * Plugins, set up once when the root is created; a later change to this prop is not
+     * applied. Their tools join `tools`, their decoration and page layers apply to every
+     * document, and their commands are placed with `InkCommand` or `useCommand`.
+     */
+    plugins?: InkPlugin[] | undefined;
     /**
      * Adds `data-*` attributes, classes and a screen-reader description to each annotation's
      * element (see `DecorateAnnotation`). Decorations re-apply whenever the annotations change
@@ -1293,6 +1299,7 @@ declare const __VLS_base: import('vue').DefineComponent<__VLS_Props, {
     })[] | undefined;
     tool: ToolId | undefined;
     tools: Tool<object>[] | undefined;
+    plugins: InkPlugin[] | undefined;
     decorateAnnotation: DecorateAnnotation | undefined;
     fonts: string[] | undefined;
     signatures: SignatureStore | undefined;

package/dist/components/InkRoot.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"InkRoot.vue.d.ts","sourceRoot":"","sources":["../../src/components/InkRoot.vue"],"names":[],"mappings":"AAuXA,OAAO,EAGL,QAAQ,EAET,MAAM,cAAc,CAAA;AAoBrB,OAAO,EAAqB,KAAK,UAAU,EAAE,KAAK,SAAS,EAAE,MAAM,YAAY,CAAA;AAI/E,OAAO,KAAK,EACV,UAAU,EACV,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,WAAW,EACX,SAAS,EACT,cAAc,EACf,MAAM,cAAc,CAAA;AACrB,OAAO,KAAK,EACV,kBAAkB,EAClB,IAAI,EAEJ,MAAM,EAGN,SAAS,EACV,MAAM,kBAAkB,CAAA;AAGzB,KAAK,WAAW,GAAG;IACf,GAAG,EAAE,cAAc,GAAG,IAAI,CAAA;IAC1B,MAAM,EAAE,SAAS,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC7B,wFAAwF;IACxF,QAAQ,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAA;IACzC;;;OAGG;IACH,WAAW,CAAC,EAAE,UAAU,EAAE,GAAG,SAAS,CAAA;IACtC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB;;;OAGG;IACH,KAAK,CAAC,EAAE,IAAI,EAAE,GAAG,SAAS,CAAA;IAC1B;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAA;IACnD;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAC5B;;;;OAIG;IACH,UAAU,CAAC,EAAE,cAAc,GAAG,SAAS,CAAA;IACvC,2EAA2E;IAC3E,cAAc,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IACrC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB,IAAI,CAAC,EAAE,SAAS,GAAG,SAAS,CAAA;IAC5B,yEAAyE;IACzE,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC7B,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAC;AAwUJ,QAAA,IAAI,OAAO;;;CAAW,CAAC;AACvB,KAAK,WAAW,GAAG,EAAE,GACnB;IAAE,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,OAAO,KAAK,GAAG,CAAA;CAAE,CAAC;AAG/C,QAAA,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;6EAKd,CAAC;AACH,QAAA,MAAM,YAAY,EAAS,eAAe,CAAC,OAAO,UAAU,EAAE,WAAW,CAAC,CAAC;wBACtD,OAAO,YAAY;AAAxC,wBAAyC;AAWzC,KAAK,eAAe,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAChC,QAAO;QACN,MAAM,EAAE,CAAC,CAAC;KACV,CAAA;CACD,CAAC"}
+{"version":3,"file":"InkRoot.vue.d.ts","sourceRoot":"","sources":["../../src/components/InkRoot.vue"],"names":[],"mappings":"AAmcA,OAAO,EAGL,QAAQ,EAIT,MAAM,cAAc,CAAA;AAsBrB,OAAO,EAAqB,KAAK,UAAU,EAAE,KAAK,SAAS,EAAE,MAAM,YAAY,CAAA;AAI/E,OAAO,KAAK,EACV,UAAU,EACV,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,WAAW,EACX,SAAS,EACT,cAAc,EACf,MAAM,cAAc,CAAA;AACrB,OAAO,KAAK,EACV,kBAAkB,EAClB,SAAS,EAET,IAAI,EAEJ,MAAM,EAGN,SAAS,EACV,MAAM,kBAAkB,CAAA;AAGzB,KAAK,WAAW,GAAG;IACf,GAAG,EAAE,cAAc,GAAG,IAAI,CAAA;IAC1B,MAAM,EAAE,SAAS,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC7B,wFAAwF;IACxF,QAAQ,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAA;IACzC;;;OAGG;IACH,WAAW,CAAC,EAAE,UAAU,EAAE,GAAG,SAAS,CAAA;IACtC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB;;;OAGG;IACH,KAAK,CAAC,EAAE,IAAI,EAAE,GAAG,SAAS,CAAA;IAC1B;;;;OAIG;IACH,OAAO,CAAC,EAAE,SAAS,EAAE,GAAG,SAAS,CAAA;IACjC;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAA;IACnD;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAC5B;;;;OAIG;IACH,UAAU,CAAC,EAAE,cAAc,GAAG,SAAS,CAAA;IACvC,2EAA2E;IAC3E,cAAc,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IACrC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB,IAAI,CAAC,EAAE,SAAS,GAAG,SAAS,CAAA;IAC5B,yEAAyE;IACzE,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC7B,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAC;AAyYJ,QAAA,IAAI,OAAO;;;CAAW,CAAC;AACvB,KAAK,WAAW,GAAG,EAAE,GACnB;IAAE,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,OAAO,KAAK,GAAG,CAAA;CAAE,CAAC;AAG/C,QAAA,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;6EAKd,CAAC;AACH,QAAA,MAAM,YAAY,EAAS,eAAe,CAAC,OAAO,UAAU,EAAE,WAAW,CAAC,CAAC;wBACtD,OAAO,YAAY;AAAxC,wBAAyC;AAWzC,KAAK,eAAe,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAChC,QAAO;QACN,MAAM,EAAE,CAAC,CAAC;KACV,CAAA;CACD,CAAC"}