@domternal/vue 0.6.1 → 0.7.0

package/dist/useEditor.d.ts

@@ -0,0 +1,63 @@
+import type { Ref, ShallowRef } from 'vue';
+import { Editor } from '@domternal/core';
+import type { Content, AnyExtension, FocusPosition } from '@domternal/core';
+export declare const DEFAULT_EXTENSIONS: AnyExtension[];
+export interface UseEditorOptions {
+    /** Custom extensions to add to the editor. */
+    extensions?: AnyExtension[];
+    /** Initial editor content (HTML string or JSON). */
+    content?: Content;
+    /** Whether the editor is editable. @default true */
+    editable?: boolean;
+    /** Where to autofocus on mount. @default false */
+    autofocus?: FocusPosition;
+    /** Output format for content comparison. @default 'html' */
+    outputFormat?: 'html' | 'json';
+    /**
+     * Set to true to create the editor synchronously during setup instead of
+     * waiting for onMounted. Only useful when SSR is not a concern.
+     * @default false
+     */
+    immediatelyRender?: boolean;
+    /** Called when the editor instance is created. */
+    onCreate?: (editor: Editor) => void;
+    /** Called when the document content changes. */
+    onUpdate?: (props: {
+        editor: Editor;
+    }) => void;
+    /** Called when the selection changes without content change. */
+    onSelectionChange?: (props: {
+        editor: Editor;
+    }) => void;
+    /** Called when the editor gains focus. */
+    onFocus?: (props: {
+        editor: Editor;
+        event: FocusEvent;
+    }) => void;
+    /** Called when the editor loses focus. */
+    onBlur?: (props: {
+        editor: Editor;
+        event: FocusEvent;
+    }) => void;
+    /** Called before the editor is destroyed. */
+    onDestroy?: () => void;
+}
+/**
+ * Core composable for creating and managing a Domternal editor instance.
+ *
+ * @example
+ * ```ts
+ * const { editor, editorRef } = useEditor({ extensions, content });
+ * ```
+ *
+ * @example SSR-safe (default in Vue - onMounted never runs on server)
+ * ```ts
+ * const { editor, editorRef } = useEditor({ extensions, content });
+ * // editor.value is null until onMounted
+ * ```
+ */
+export declare function useEditor(options?: UseEditorOptions): {
+    editor: ShallowRef<Editor | null>;
+    editorRef: Ref<HTMLDivElement | undefined>;
+};
+//# sourceMappingURL=useEditor.d.ts.map

package/dist/useEditor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useEditor.d.ts","sourceRoot":"","sources":["../src/useEditor.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,KAAK,CAAC;AAC3C,OAAO,EACL,MAAM,EAMP,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,aAAa,EAA0C,MAAM,iBAAiB,CAAC;AAEpH,eAAO,MAAM,kBAAkB,EAAE,YAAY,EAAqD,CAAC;AAEnG,MAAM,WAAW,gBAAgB;IAC/B,8CAA8C;IAC9C,UAAU,CAAC,EAAE,YAAY,EAAE,CAAC;IAC5B,oDAAoD;IACpD,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,oDAAoD;IACpD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,kDAAkD;IAClD,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,4DAA4D;IAC5D,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC/B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,kDAAkD;IAClD,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IACpC,gDAAgD;IAChD,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC;IAC/C,gEAAgE;IAChE,iBAAiB,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC;IACxD,0CAA0C;IAC1C,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,UAAU,CAAA;KAAE,KAAK,IAAI,CAAC;IACjE,0CAA0C;IAC1C,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,UAAU,CAAA;KAAE,KAAK,IAAI,CAAC;IAChE,6CAA6C;IAC7C,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;CACxB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,SAAS,CAAC,OAAO,GAAE,gBAAqB,GAAG;IACzD,MAAM,EAAE,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAClC,SAAS,EAAE,GAAG,CAAC,cAAc,GAAG,SAAS,CAAC,CAAC;CAC5C,CAkIA"}

package/dist/useEditorState.d.ts

@@ -0,0 +1,28 @@
+import type { ComputedRef, Ref, ShallowRef } from 'vue';
+import type { Editor, JSONContent } from '@domternal/core';
+/**
+ * Full editor state returned when no selector is provided.
+ */
+export interface EditorState {
+    htmlContent: Ref<string>;
+    jsonContent: Ref<JSONContent | null>;
+    isEmpty: Ref<boolean>;
+    isFocused: Ref<boolean>;
+    isEditable: Ref<boolean>;
+}
+/**
+ * Subscribe to editor state changes.
+ *
+ * **Overload 1 - Full state:**
+ * ```ts
+ * const { htmlContent, isEmpty } = useEditorState(editor);
+ * ```
+ *
+ * **Overload 2 - Selector (granular, avoids unnecessary re-renders):**
+ * ```ts
+ * const isBold = useEditorState(editor, (ed) => ed.isActive('bold'));
+ * ```
+ */
+export declare function useEditorState(editor: ShallowRef<Editor | null>): EditorState;
+export declare function useEditorState<T>(editor: ShallowRef<Editor | null>, selector: (editor: Editor) => T): ComputedRef<T | undefined>;
+//# sourceMappingURL=useEditorState.d.ts.map

package/dist/useEditorState.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useEditorState.d.ts","sourceRoot":"","sources":["../src/useEditorState.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,KAAK,CAAC;AACxD,OAAO,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAG3D;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,WAAW,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACzB,WAAW,EAAE,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,CAAC;IACrC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACtB,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACxB,UAAU,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;CAC1B;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,WAAW,CAAC;AAC/E,wBAAgB,cAAc,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,CAAC,GAAG,WAAW,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC"}

package/dist/utils.d.ts

@@ -0,0 +1,39 @@
+import type { AppContext, Ref } from 'vue';
+import type { Editor } from '@domternal/core';
+/**
+ * Creates a debounced ref that batches rapid updates into a single Vue re-render.
+ *
+ * The value is updated synchronously (get() always returns the latest value),
+ * but the reactive trigger is deferred via double requestAnimationFrame.
+ * Previous rAFs are cancelled on each update so only one trigger fires per
+ * double-frame window, preventing re-render storms during rapid
+ * ProseMirror transactions (e.g. while typing).
+ */
+export declare function useDebouncedRef<T>(initialValue: T): Ref<T>;
+/**
+ * Module-level store for Vue appContext per editor instance.
+ *
+ * The core Editor is framework-agnostic, so a WeakMap associates each Editor
+ * with its Vue appContext. This allows VueNodeViewRenderer to forward the
+ * provide/inject chain from the parent component tree.
+ *
+ * The `provides` property MUST be a direct reference (not spread/copied)
+ * to preserve Vue's prototype chain for inject resolution.
+ *
+ * WeakMap ensures no memory leaks when editors are garbage collected.
+ */
+export declare const appContextStore: WeakMap<Editor, AppContext>;
+/**
+ * Pending appContext for editors currently being constructed.
+ *
+ * Node view constructors fire DURING `new Editor(...)` - before the editor
+ * instance can be stored in appContextStore. To support `useCurrentEditor()`
+ * and provide/inject inside node views, `provideEditor()` stashes the
+ * appContext here. `useEditor()` reads it when creating the editor, then
+ * clears it. VueNodeViewRenderer falls back to this when the per-editor
+ * entry is not yet populated.
+ */
+export declare const pendingAppContextStore: {
+    value: AppContext | null;
+};
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC;AAC3C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAE9C;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAsB1D;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,eAAe,6BAAoC,CAAC;AAEjE;;;;;;;;;GASG;AACH,eAAO,MAAM,sBAAsB;WAAoB,UAAU,GAAG,IAAI;CAAE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@domternal/vue",
-  "version": "0.6.1",
+  "version": "0.7.0",
   "description": "Vue 3 components for Domternal editor",
   "author": "https://github.com/ThomasNowHere",
   "license": "MIT",
@@ -20,7 +20,8 @@
   ],
   "peerDependencies": {
     "vue": ">=3.3",
-    "@domternal/core": ">=0.6.1"
+    "@domternal/core": ">=0.7.0",
+    "@domternal/extension-block-menu": ">=0.7.0"
   },
   "keywords": [
     "vue",
@@ -42,6 +43,7 @@
   "scripts": {
     "build": "tsup",
     "dev": "tsup --watch",
+    "lint": "eslint src",
     "typecheck": "tsc --noEmit"
   }
 }