@prosekit/svelte 0.2.0 → 0.2.1

package/dist/build/components/prosekit.d.ts

@@ -3,5 +3,10 @@ import type { SvelteComponent } from 'svelte';
 export interface ProseKitProps {
     editor: Editor;
 }
+/**
+ * The root component for a ProseKit editor.
+ *
+ * @public
+ */
 export declare const ProseKit: typeof SvelteComponent<ProseKitProps>;
 //# sourceMappingURL=prosekit.d.ts.map

package/dist/build/components/prosekit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"prosekit.d.ts","sourceRoot":"","sources":["../../../../src/components/prosekit.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAA;AAI7C,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAA;CACf;AAED,eAAO,MAAM,QAAQ,EACiC,uBAAuB,aAAa,CAAC,CAAA"}
+{"version":3,"file":"prosekit.d.ts","sourceRoot":"","sources":["../../../../src/components/prosekit.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAA;AAI7C,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;;;GAIG;AACH,eAAO,MAAM,QAAQ,EACiC,uBAAuB,aAAa,CAAC,CAAA"}

package/dist/build/components/prosekit.js

@@ -1,2 +1,7 @@
 import ProseKitComponent from './prosekit.svelte';
+/**
+ * The root component for a ProseKit editor.
+ *
+ * @public
+ */
 export const ProseKit = ProseKitComponent;

package/dist/build/contexts/editor-context.d.ts

@@ -1,7 +1,10 @@
-import { type Editor } from '@prosekit/core';
-export interface EditorContext {
-    editor: Editor;
-}
+import { type Editor, type Extension } from '@prosekit/core';
+/**
+ * @internal
+ */
 export declare function setEditorContext(editor: Editor): void;
-export declare function getEditorContext(): EditorContext;
+/**
+ * @internal
+ */
+export declare function useEditorContext<E extends Extension>(): Editor<E> | null;
 //# sourceMappingURL=editor-context.d.ts.map

package/dist/build/contexts/editor-context.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"editor-context.d.ts","sourceRoot":"","sources":["../../../../src/contexts/editor-context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,KAAK,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAG3D,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAA;CACf;AAID,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAMrD;AAED,wBAAgB,gBAAgB,IAAI,aAAa,CAOhD"}
+{"version":3,"file":"editor-context.d.ts","sourceRoot":"","sources":["../../../../src/contexts/editor-context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,KAAK,MAAM,EAAE,KAAK,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAK3E;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAKrD;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,SAAS,KAAK,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAKxE"}

package/dist/build/contexts/editor-context.js

@@ -1,16 +1,21 @@
 import { ProseKitError } from '@prosekit/core';
 import { getContext, hasContext, setContext } from 'svelte';
 const key = 'prosekit-svelte-editor-context';
+/**
+ * @internal
+ */
 export function setEditorContext(editor) {
     if (!editor) {
         throw new ProseKitError('editor should not be empty');
     }
-    const context = { editor };
-    setContext(key, context);
+    setContext(key, editor);
 }
-export function getEditorContext() {
+/**
+ * @internal
+ */
+export function useEditorContext() {
     if (!hasContext(key)) {
-        throw new ProseKitError('Editor context not found. You must call this function inside the ProseKit component');
+        return null;
     }
     return getContext(key);
 }

package/dist/build/hooks/use-editor-extension.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="svelte" />
+import { Editor, type Extension } from '@prosekit/core';
+import { type Readable } from 'svelte/store';
+/**
+ * @internal
+ */
+export declare function useEditorExtension(maybeEditor: Editor | null | undefined, extensionStore: Readable<Extension | null>): void;
+//# sourceMappingURL=use-editor-extension.d.ts.map

package/dist/build/hooks/use-editor-extension.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-editor-extension.d.ts","sourceRoot":"","sources":["../../../../src/hooks/use-editor-extension.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,MAAM,EAAuB,KAAK,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE5E,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,cAAc,CAAA;AAI5C;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,WAAW,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EACtC,cAAc,EAAE,QAAQ,CAAC,SAAS,GAAG,IAAI,CAAC,QAyB3C"}

package/dist/build/hooks/use-editor-extension.js

@@ -0,0 +1,27 @@
+import { Editor, EditorNotFoundError } from '@prosekit/core';
+import { onDestroy } from 'svelte';
+import {} from 'svelte/store';
+import { useEditorContext } from '../contexts/editor-context';
+/**
+ * @internal
+ */
+export function useEditorExtension(maybeEditor, extensionStore) {
+    const editorContext = useEditorContext();
+    let cleanup;
+    const unsubscribe = extensionStore.subscribe((extension) => {
+        cleanup === null || cleanup === void 0 ? void 0 : cleanup();
+        cleanup = undefined;
+        const editor = maybeEditor || editorContext;
+        if (!editor) {
+            throw new EditorNotFoundError();
+        }
+        if (extension) {
+            cleanup = editor.use(extension);
+        }
+    });
+    onDestroy(() => {
+        cleanup === null || cleanup === void 0 ? void 0 : cleanup();
+        cleanup = undefined;
+        unsubscribe();
+    });
+}

package/dist/build/hooks/use-editor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-editor.d.ts","sourceRoot":"","sources":["../../../../src/hooks/use-editor.ts"],"names":[],"mappings":";AAAA,OAAO,EAIL,KAAK,MAAM,EACX,KAAK,SAAS,EACf,MAAM,gBAAgB,CAAA;AAEvB,OAAO,EAAsB,KAAK,QAAQ,EAAE,MAAM,cAAc,CAAA;AAIhE;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,SAAS,GAAG,GAAG,EAAE,OAAO,CAAC,EAAE;IAC7D;;;;;OAKG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAqBtB"}
+{"version":3,"file":"use-editor.d.ts","sourceRoot":"","sources":["../../../../src/hooks/use-editor.ts"],"names":[],"mappings":";AAAA,OAAO,EAIL,KAAK,MAAM,EACX,KAAK,SAAS,EAEf,MAAM,gBAAgB,CAAA;AAEvB,OAAO,EAAsB,KAAK,QAAQ,EAAE,MAAM,cAAc,CAAA;AAIhE;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,SAAS,GAAG,GAAG,EAAE,OAAO,CAAC,EAAE;IAC7D;;;;;OAKG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CA2BtB"}

package/dist/build/hooks/use-editor.js

@@ -1,7 +1,7 @@
-import { defineMountHandler, defineUpdateHandler, union, } from '@prosekit/core';
+import { defineMountHandler, defineUpdateHandler, union, ProseKitError, } from '@prosekit/core';
 import { onDestroy, onMount } from 'svelte';
 import { readonly, writable } from 'svelte/store';
-import { getEditorContext } from '../contexts/editor-context';
+import { useEditorContext } from '../contexts/editor-context';
 /**
  * Retrieves the editor instance from the nearest ProseKit component.
  *
@@ -10,7 +10,10 @@ import { getEditorContext } from '../contexts/editor-context';
 export function useEditor(options) {
     var _a;
     const update = (_a = options === null || options === void 0 ? void 0 : options.update) !== null && _a !== void 0 ? _a : false;
-    const editor = getEditorContext().editor;
+    const editor = useEditorContext();
+    if (!editor) {
+        throw new ProseKitError('useEditor must be used within the ProseKit component');
+    }
     const editorStore = writable(editor);
     if (update) {
         onMount(() => {

package/dist/build/hooks/use-extension.d.ts

@@ -1,12 +1,24 @@
 /// <reference types="svelte" />
-import { type Extension } from '@prosekit/core';
+import { Editor, Priority, type Extension } from '@prosekit/core';
 import { type Readable } from 'svelte/store';
+export interface UseExtensionOptions {
+    /**
+     * The editor to add the extension to. If not provided, it will use the
+     * editor from the nearest `ProseKit` component.
+     */
+    editor?: Editor;
+    /**
+     * Optional priority to add the extension with.
+     */
+    priority?: Priority;
+}
 /**
  * Add an extension to the editor.
- *
- * It accepts a store to an optional extension. If the extension is changed, the
- * previous extension will be removed and the new one (if not null) will be
- * added.
  */
-export declare function useExtension<T extends Extension = Extension>(extensionStore: Readable<T | null>): void;
+export declare function useExtension<T extends Extension = Extension>(
+/**
+ * The store to an extension to add to the editor. If it changes, the previous
+ * extension will be removed and the new one (if not null) will be added.
+ */
+extension: Readable<T | null>, options?: UseExtensionOptions): void;
 //# sourceMappingURL=use-extension.d.ts.map

package/dist/build/hooks/use-extension.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-extension.d.ts","sourceRoot":"","sources":["../../../../src/hooks/use-extension.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAW,KAAK,QAAQ,EAAE,MAAM,cAAc,CAAA;AAIrD;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,EAC1D,cAAc,EAAE,QAAQ,CAAC,CAAC,GAAG,IAAI,CAAC,GACjC,IAAI,CAWN"}
+{"version":3,"file":"use-extension.d.ts","sourceRoot":"","sources":["../../../../src/hooks/use-extension.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,SAAS,EAAE,MAAM,gBAAgB,CAAA;AACjE,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,cAAc,CAAA;AAK5C,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAA;CACpB;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS;AAC1D;;;GAGG;AACH,SAAS,EAAE,QAAQ,CAAC,CAAC,GAAG,IAAI,CAAC,EAC7B,OAAO,CAAC,EAAE,mBAAmB,GAC5B,IAAI,CAKN"}

package/dist/build/hooks/use-extension.js

@@ -1,22 +1,15 @@
-import {} from '@prosekit/core';
-import { derived } from 'svelte/store';
-import { useEditor } from './use-editor';
+import { Editor, Priority } from '@prosekit/core';
+import {} from 'svelte/store';
+import { useEditorExtension } from './use-editor-extension';
+import { usePriorityExtension } from './use-priority-extension';
 /**
  * Add an extension to the editor.
- *
- * It accepts a store to an optional extension. If the extension is changed, the
- * previous extension will be removed and the new one (if not null) will be
- * added.
  */
-export function useExtension(extensionStore) {
-    const editorStore = useEditor();
-    const store = derived([editorStore, extensionStore], (values) => values);
-    let cleanup = null;
-    store.subscribe(([editor, extension]) => {
-        cleanup === null || cleanup === void 0 ? void 0 : cleanup();
-        cleanup = null;
-        if (extension) {
-            cleanup = editor.use(extension);
-        }
-    });
+export function useExtension(
+/**
+ * The store to an extension to add to the editor. If it changes, the previous
+ * extension will be removed and the new one (if not null) will be added.
+ */
+extension, options) {
+    useEditorExtension(options === null || options === void 0 ? void 0 : options.editor, usePriorityExtension(extension, options === null || options === void 0 ? void 0 : options.priority));
 }

package/dist/build/hooks/use-keymap.d.ts

@@ -1,7 +1,6 @@
 /// <reference types="svelte" />
-import { Priority, type Keymap } from '@prosekit/core';
+import { type Keymap } from '@prosekit/core';
 import { type Readable } from 'svelte/store';
-export declare function useKeymap(keymapStore: Readable<Keymap>, options?: {
-    priority?: Priority;
-}): void;
+import { type UseExtensionOptions } from './use-extension';
+export declare function useKeymap(keymapStore: Readable<Keymap>, options?: UseExtensionOptions): void;
 //# sourceMappingURL=use-keymap.d.ts.map

package/dist/build/hooks/use-keymap.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-keymap.d.ts","sourceRoot":"","sources":["../../../../src/hooks/use-keymap.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,QAAQ,EAAgB,KAAK,MAAM,EAAE,MAAM,gBAAgB,CAAA;AACpE,OAAO,EAAW,KAAK,QAAQ,EAAE,MAAM,cAAc,CAAA;AAIrD,wBAAgB,SAAS,CACvB,WAAW,EAAE,QAAQ,CAAC,MAAM,CAAC,EAC7B,OAAO,CAAC,EAAE;IAAE,QAAQ,CAAC,EAAE,QAAQ,CAAA;CAAE,GAChC,IAAI,CAGN"}
+{"version":3,"file":"use-keymap.d.ts","sourceRoot":"","sources":["../../../../src/hooks/use-keymap.ts"],"names":[],"mappings":";AAAA,OAAO,EAAgB,KAAK,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAC1D,OAAO,EAAW,KAAK,QAAQ,EAAE,MAAM,cAAc,CAAA;AAErD,OAAO,EAAgB,KAAK,mBAAmB,EAAE,MAAM,iBAAiB,CAAA;AAExE,wBAAgB,SAAS,CACvB,WAAW,EAAE,QAAQ,CAAC,MAAM,CAAC,EAC7B,OAAO,CAAC,EAAE,mBAAmB,GAC5B,IAAI,CAGN"}

package/dist/build/hooks/use-keymap.js

@@ -1,7 +1,7 @@
-import { Priority, defineKeymap } from '@prosekit/core';
+import { defineKeymap } from '@prosekit/core';
 import { derived } from 'svelte/store';
-import { usePriorityExtension } from './use-priority-extension';
+import { useExtension } from './use-extension';
 export function useKeymap(keymapStore, options) {
     const extension = derived(keymapStore, (keymap) => defineKeymap(keymap));
-    usePriorityExtension(extension, options === null || options === void 0 ? void 0 : options.priority);
+    return useExtension(extension, options);
 }

package/dist/build/hooks/use-priority-extension.d.ts

@@ -1,5 +1,8 @@
 /// <reference types="svelte" />
 import { Priority, type Extension } from '@prosekit/core';
 import { type Readable } from 'svelte/store';
-export declare function usePriorityExtension<T extends Extension = Extension>(extensionStore: Readable<T | null>, priority?: Priority | null): void;
+/**
+ * @internal
+ */
+export declare function usePriorityExtension<T extends Extension = Extension>(extensionStore: Readable<T | null>, priority?: Priority | null): Readable<T | null>;
 //# sourceMappingURL=use-priority-extension.d.ts.map

package/dist/build/hooks/use-priority-extension.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-priority-extension.d.ts","sourceRoot":"","sources":["../../../../src/hooks/use-priority-extension.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,QAAQ,EAAgB,KAAK,SAAS,EAAE,MAAM,gBAAgB,CAAA;AACvE,OAAO,EAAW,KAAK,QAAQ,EAAE,MAAM,cAAc,CAAA;AAIrD,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,EAClE,cAAc,EAAE,QAAQ,CAAC,CAAC,GAAG,IAAI,CAAC,EAClC,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI,GACzB,IAAI,CAKN"}
+{"version":3,"file":"use-priority-extension.d.ts","sourceRoot":"","sources":["../../../../src/hooks/use-priority-extension.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,QAAQ,EAAgB,KAAK,SAAS,EAAE,MAAM,gBAAgB,CAAA;AACvE,OAAO,EAAW,KAAK,QAAQ,EAAE,MAAM,cAAc,CAAA;AAErD;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,EAClE,cAAc,EAAE,QAAQ,CAAC,CAAC,GAAG,IAAI,CAAC,EAClC,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI,GACzB,QAAQ,CAAC,CAAC,GAAG,IAAI,CAAC,CAIpB"}

package/dist/build/hooks/use-priority-extension.js

@@ -1,9 +1,10 @@
 import { Priority, withPriority } from '@prosekit/core';
 import { derived } from 'svelte/store';
-import { useExtension } from './use-extension';
+/**
+ * @internal
+ */
 export function usePriorityExtension(extensionStore, priority) {
-    const extensionWithPriorityStore = derived(extensionStore, (extension) => {
+    return derived(extensionStore, (extension) => {
         return extension && priority ? withPriority(extension, priority) : extension;
     });
-    return useExtension(extensionWithPriorityStore);
 }

package/dist/build/index.d.ts

@@ -1,6 +1,6 @@
 export { ProseKit } from './components/prosekit';
 export { useEditor } from './hooks/use-editor';
-export { useExtension } from './hooks/use-extension';
+export { useExtension, type UseExtensionOptions } from './hooks/use-extension';
 export { useKeymap } from './hooks/use-keymap';
 export type { PropsWithClass } from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAC9C,YAAY,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAC9C,OAAO,EAAE,YAAY,EAAE,KAAK,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAC9E,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAC9C,YAAY,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@prosekit/svelte",
   "type": "module",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "private": false,
   "author": {
     "name": "ocavue",
@@ -107,8 +107,8 @@
     "dist"
   ],
   "dependencies": {
-    "@prosekit/core": "^0.2.5",
-    "@prosekit/lit": "^0.2.0"
+    "@prosekit/core": "^0.2.7",
+    "@prosekit/lit": "^0.2.1"
   },
   "peerDependencies": {
     "svelte": ">= 3.0.0"
@@ -120,14 +120,14 @@
   },
   "devDependencies": {
     "@prosekit/dev": "*",
-    "@sveltejs/package": "^2.2.5",
-    "@types/node": "^20.11.0",
+    "@sveltejs/package": "^2.2.6",
+    "@types/node": "^20.11.7",
     "read-pkg": "^9.0.1",
-    "svelte": "^4.2.8",
+    "svelte": "^4.2.9",
     "svelte-check": "^3.6.3",
     "tsx": "^4.7.0",
     "typescript": "^5.3.3",
-    "vitest": "^1.2.0"
+    "vitest": "^1.2.1"
   },
   "scripts": {
     "build": "svelte-package -i src -o dist/build && tsx scripts/re-export.ts"

package/src/index.ts

@@ -1,5 +0,0 @@
-export { ProseKit } from './components/prosekit'
-export { useEditor } from './hooks/use-editor'
-export { useExtension } from './hooks/use-extension'
-export { useKeymap } from './hooks/use-keymap'
-export type { PropsWithClass } from './types'