@prosekit/core 0.7.13 → 0.7.15

package/dist/_tsup-dts-rollup.d.ts

@@ -1,9 +1,10 @@
 import { AllSelection } from '@prosekit/pm/state';
 import type { Attrs } from '@prosekit/pm/model';
+import { BaseCommandsExtension as BaseCommandsExtension_2 } from '..';
 import { Command } from '@prosekit/pm/state';
 import type { ContentMatch } from '@prosekit/pm/model';
-import { config as default_alias_1 } from '@prosekit/dev/config-vitest';
 import type { DirectEditorProps } from '@prosekit/pm/view';
+import { DocExtension as DocExtension_2 } from '..';
 import type { DOMEventMap } from '@prosekit/pm/view';
 import type { DOMOutputSpec } from '@prosekit/pm/model';
 import { DOMParser as DOMParser_2 } from '@prosekit/pm/model';
@@ -11,20 +12,24 @@ import { DOMSerializer } from '@prosekit/pm/model';
 import { EditorState } from '@prosekit/pm/state';
 import type { EditorStateConfig } from '@prosekit/pm/state';
 import { EditorView } from '@prosekit/pm/view';
+import { Facet as Facet_2 } from '../..';
 import { Fragment } from '@prosekit/pm/model';
+import { HistoryExtension as HistoryExtension_2 } from '..';
 import type { IsEqual } from 'type-fest';
 import { Mark } from '@prosekit/pm/model';
 import type { MarkSpec } from '@prosekit/pm/model';
 import type { MarkType } from '@prosekit/pm/model';
+import type { MarkViewConstructor } from '@prosekit/pm/view';
 import type { Node as Node_2 } from '@prosekit/pm/model';
+import { NodeAction as NodeAction_2 } from '..';
 import { NodeSelection } from '@prosekit/pm/state';
 import type { NodeSpec } from '@prosekit/pm/model';
 import type { NodeType } from '@prosekit/pm/model';
 import { NodeType as NodeType_2 } from 'prosemirror-model';
 import type { NodeView } from '@prosekit/pm/view';
 import type { NodeViewConstructor } from '@prosekit/pm/view';
-import { Options } from 'tsup';
 import { ParseOptions } from '@prosekit/pm/model';
+import { PlainExtension as PlainExtension_2 } from '..';
 import { Plugin as Plugin_2 } from '@prosekit/pm/state';
 import { ProseMirrorFragment } from '@prosekit/pm/model';
 import { ProseMirrorNode } from '@prosekit/pm/model';
@@ -33,10 +38,14 @@ import { Schema } from '@prosekit/pm/model';
 import { SchemaSpec } from '@prosekit/pm/model';
 import { Selection as Selection_2 } from '@prosekit/pm/state';
 import type { Simplify } from 'type-fest';
+import { SimplifyDeeper as SimplifyDeeper_2 } from '..';
 import { Slice } from '@prosekit/pm/model';
 import type { TagParseRule } from '@prosekit/pm/model';
+import { TextExtension as TextExtension_2 } from '..';
 import { TextSelection } from '@prosekit/pm/state';
+import { ToMarkAction as ToMarkAction_2 } from '..';
 import { Transaction } from '@prosekit/pm/state';
+import { Union as Union_2 } from '..';
 import type { UnionToIntersection } from 'type-fest';
 
 declare type Action = (options: {
@@ -189,7 +198,7 @@ export { BaseCommandsExtension as BaseCommandsExtension_alias_1 }
  * @internal
  */
 export declare abstract class BaseExtension<T extends ExtensionTyping = ExtensionTyping> implements Extension<T> {
-    extension: Extension | Extension[];
+    abstract extension: Extension | Extension[];
     priority?: Priority;
     _type?: T;
     private trees;
@@ -218,7 +227,7 @@ export { BaseKeymapExtension as BaseKeymapExtension_alias_1 }
 /**
  * Some basic props for custom node views.
  *
- * @public
+ * @deprecated - This is no longer needed. Use `CoreNodeViewUserOptions` from `@prosemirror-adapter/core` instead.
  */
 declare interface BaseNodeViewOptions {
     /**
@@ -263,6 +272,18 @@ declare type ClickOnHandler = (view: EditorView, pos: number, node: Node_2, node
 export { ClickOnHandler }
 export { ClickOnHandler as ClickOnHandler_alias_1 }
 
+/**
+ * @internal
+ */
+declare interface ClipboardSerializerOptions {
+    serializeFragmentWrapper?: FunctionWrapper<SerializeFragmentFunction>;
+    serializeNodeWrapper?: FunctionWrapper<SerializeNodeFunction>;
+    nodesFromSchemaWrapper?: FunctionWrapper<NodesFromSchemaFunction>;
+    marksFromSchemaWrapper?: FunctionWrapper<MarksFromSchemaFunction>;
+}
+export { ClipboardSerializerOptions }
+export { ClipboardSerializerOptions as ClipboardSerializerOptions_alias_1 }
+
 /**
  * A utility for constructing `className` strings conditionally.
  *
@@ -394,10 +415,6 @@ export { createTestEditor as createTestEditor_alias_1 }
 
 export declare function deepEquals<T>(a: T, b: T): boolean;
 
-export declare const default_alias: Options | Options[] | ((overrideOptions: Options) => Options | Options[] | Promise<Options | Options[]>);
-
-export { default_alias_1 }
-
 /**
  * @internal
  */
@@ -480,6 +497,13 @@ declare function defineClickOnHandler(handler: ClickOnHandler): PlainExtension;
 export { defineClickOnHandler }
 export { defineClickOnHandler as defineClickOnHandler_alias_1 }
 
+/**
+ * @internal
+ */
+declare function defineClipboardSerializer(options: ClipboardSerializerOptions): Extension;
+export { defineClipboardSerializer }
+export { defineClipboardSerializer as defineClipboardSerializer_alias_1 }
+
 declare function defineCommands<T extends Record<string, CommandCreator> = Record<string, CommandCreator>>(commands: T): Extension<{
     Commands: {
         [K in keyof T]: Parameters<T[K]>;
@@ -657,6 +681,24 @@ declare function defineMarkSpec<Mark extends string, Attrs extends AnyAttrs = An
 export { defineMarkSpec }
 export { defineMarkSpec as defineMarkSpec_alias_1 }
 
+declare function defineMarkView(options: MarkViewOptions): Extension;
+export { defineMarkView }
+export { defineMarkView as defineMarkView_alias_1 }
+
+/**
+ * @internal
+ */
+declare function defineMarkViewComponent<T>(options: MarkViewComponentOptions<T>): Extension;
+export { defineMarkViewComponent }
+export { defineMarkViewComponent as defineMarkViewComponent_alias_1 }
+
+/**
+ * @internal
+ */
+declare function defineMarkViewFactory<T>(options: MarkViewFactoryOptions<T>): Extension;
+export { defineMarkViewFactory }
+export { defineMarkViewFactory as defineMarkViewFactory_alias_1 }
+
 /**
  * Registers a event handler that is called when the editor view is mounted.
  *
@@ -763,11 +805,11 @@ export { defineScrollToSelectionHandler as defineScrollToSelectionHandler_alias_
 /**
  * @internal
  */
-export declare function defineTestExtension(): Union<readonly [BaseCommandsExtension, PlainExtension, DocExtension, HistoryExtension, Extension<{
+export declare function defineTestExtension(): Union_2<readonly [BaseCommandsExtension_2, PlainExtension_2, DocExtension_2, HistoryExtension_2, Extension<{
 Nodes: {
 paragraph: Attrs;
 };
-}>, TextExtension, BoldExtension, ItalicExtension, LinkExtension, HeadingExtension, CodeBlockExtension]>;
+}>, TextExtension_2, BoldExtension, ItalicExtension, LinkExtension, HeadingExtension, CodeBlockExtension]>;
 
 /**
  * @public
@@ -853,6 +895,11 @@ export declare class DOMDocumentNotFoundError extends ProseKitError {
 
 /** @public */
 declare interface DOMDocumentOptions {
+    /**
+     * The Document object to use for DOM operations. If not provided, defaults to
+     * the current browser's document object. Useful for server-side rendering or
+     * testing environments.
+     */
     document?: Document;
 }
 export { DOMDocumentOptions }
@@ -891,7 +938,9 @@ export { DOMParserOptions as DOMParserOptions_alias_1 }
 
 /** @public */
 declare interface DOMSerializerOptions {
-    DOMSerializer?: typeof DOMSerializer;
+    DOMSerializer?: {
+        fromSchema: typeof DOMSerializer.fromSchema;
+    };
 }
 export { DOMSerializerOptions }
 export { DOMSerializerOptions as DOMSerializerOptions_alias_1 }
@@ -983,6 +1032,14 @@ declare class Editor<E extends Extension = any> {
      *   - The string "end" (to set selection at the end)
      */
     setContent: (content: ProseMirrorNode | NodeJSON | string | HTMLElement, selection?: SelectionJSON | Selection_2 | "start" | "end") => void;
+    /**
+     * Return a JSON object representing the editor's current document.
+     */
+    getDocJSON: () => NodeJSON;
+    /**
+     * Return a HTML string representing the editor's current document.
+     */
+    getDocHTML: (options?: getDocHTMLOptions) => string;
     /**
      * Execute the given command. Return `true` if the command was successfully
      * executed, otherwise `false`.
@@ -1012,7 +1069,7 @@ export { Editor as Editor_alias_1 }
 /**
  * @internal
  */
-declare const editorEventFacet: Facet<EditorEventPayload, PluginPayload>;
+declare const editorEventFacet: Facet_2<EditorEventPayload, PluginPayload>;
 export { editorEventFacet }
 export { editorEventFacet as editorEventFacet_alias_1 }
 
@@ -1054,9 +1111,19 @@ export declare class EditorInstance {
     private afterMounted;
     constructor(extension: Extension);
     getState: () => EditorState;
+    private getDoc;
+    private getProp;
     updateState(state: EditorState): void;
     private dispatch;
     setContent(content: NodeJSON | string | HTMLElement | ProseMirrorNode, selection?: SelectionJSON | Selection_2 | 'start' | 'end'): void;
+    /**
+     * Return a JSON object representing the editor's current document.
+     */
+    getDocJSON: () => NodeJSON;
+    /**
+     * Return a HTML string representing the editor's current document.
+     */
+    getDocHTML: (options?: getDocHTMLOptions) => string;
     private updateExtension;
     use(extension: Extension): VoidFunction;
     mount(place: HTMLElement): void;
@@ -1413,6 +1480,8 @@ declare type FocusChangeHandler = (hasFocus: boolean) => void;
 export { FocusChangeHandler }
 export { FocusChangeHandler as FocusChangeHandler_alias_1 }
 
+declare type FunctionWrapper<T extends AnyFunction> = (fn: T) => T;
+
 export declare function getBrowserDocument(options?: {
     document?: Document;
 }): Document;
@@ -1423,6 +1492,12 @@ export declare function getBrowserWindow(options?: {
 
 export declare function getCustomSelection(state: EditorState, from?: number | null, to?: number | null): Selection_2;
 
+/**
+ * @public
+ */
+export declare interface getDocHTMLOptions extends DOMDocumentOptions {
+}
+
 export declare function getEditorContentDoc(schema: Schema, content: NodeJSON | string | HTMLElement | ProseMirrorNode): ProseMirrorNode;
 
 export declare function getEditorContentJSON(schema: Schema, content: NodeJSON | string | HTMLElement): NodeJSON;
@@ -1642,7 +1717,12 @@ declare function isAtBlockStart(state: EditorState, view?: EditorView): Resolved
 export { isAtBlockStart }
 export { isAtBlockStart as isAtBlockStart_alias_1 }
 
-export declare function isElement(el: unknown): el is Element;
+/**
+ * @internal
+ */
+declare function isElement(el: unknown): el is Element;
+export { isElement }
+export { isElement as isElement_alias_1 }
 
 /**
  * Checks if the given object is a `Fragment` instance.
@@ -1790,6 +1870,9 @@ export { jsonFromState as jsonFromState_alias_1 }
 
 /** @public */
 declare interface JSONParserOptions {
+    /**
+     * The editor schema to use.
+     */
     schema: Schema;
 }
 export { JSONParserOptions }
@@ -1894,6 +1977,8 @@ declare type MarkBuilder = MarkAction;
 export { MarkBuilder }
 export { MarkBuilder as MarkBuilder_alias_1 }
 
+declare type MarksFromSchemaFunction = typeof DOMSerializer.marksFromSchema;
+
 /**
  * @public
  */
@@ -1921,6 +2006,34 @@ declare interface MarkTyping {
 export { MarkTyping }
 export { MarkTyping as MarkTyping_alias_1 }
 
+/**
+ * @internal
+ */
+declare type MarkViewComponentOptions<T> = {
+    group: string;
+    name: string;
+    args: T;
+};
+export { MarkViewComponentOptions }
+export { MarkViewComponentOptions as MarkViewComponentOptions_alias_1 }
+
+/**
+ * @internal
+ */
+declare type MarkViewFactoryOptions<T> = {
+    group: string;
+    factory: (args: T) => MarkViewConstructor;
+};
+export { MarkViewFactoryOptions }
+export { MarkViewFactoryOptions as MarkViewFactoryOptions_alias_1 }
+
+declare interface MarkViewOptions {
+    name: string;
+    constructor: MarkViewConstructor;
+}
+export { MarkViewOptions }
+export { MarkViewOptions as MarkViewOptions_alias_1 }
+
 /**
  * @internal
  */
@@ -2074,6 +2187,8 @@ declare interface NodeJSON {
 export { NodeJSON }
 export { NodeJSON as NodeJSON_alias_1 }
 
+declare type NodesFromSchemaFunction = typeof DOMSerializer.nodesFromSchema;
+
 /**
  * @public
  */
@@ -2150,7 +2265,6 @@ export { OBJECT_REPLACEMENT_CHARACTER as OBJECT_REPLACEMENT_CHARACTER_alias_1 }
  * type MyObject = { a: 1; b: 'B' }
  * type MyEntries = ObjectEntries<MyObject>
  * //   ^ ["a", 1] | ["b", "B"]
- *
  */
 export declare type ObjectEntries<T extends Record<string, any>> = {
     [K in keyof T]: [K, T[K]];
@@ -2356,6 +2470,10 @@ declare interface SelectionJSON {
 export { SelectionJSON }
 export { SelectionJSON as SelectionJSON_alias_1 }
 
+declare type SerializeFragmentFunction = typeof DOMSerializer.prototype.serializeFragment;
+
+declare type SerializeNodeFunction = typeof DOMSerializer.prototype.serializeNode;
+
 /**
  * Returns a command that tries to set the selected textblocks to the given node
  * type with the given attributes.
@@ -2428,12 +2546,12 @@ export declare function setupEditorExtension<E extends Extension>(options: Edito
  * @internal
  */
 export declare function setupTest(): {
-    editor: TestEditor<Union<readonly [BaseCommandsExtension, PlainExtension, DocExtension, HistoryExtension, Extension<{
+    editor: TestEditor<Union_2<readonly [BaseCommandsExtension_2, PlainExtension_2, DocExtension_2, HistoryExtension_2, Extension<{
     Nodes: {
     paragraph: Attrs;
     };
-    }>, TextExtension, BoldExtension, ItalicExtension, LinkExtension, HeadingExtension, CodeBlockExtension]>>;
-    m: ToMarkAction<SimplifyDeeper<    {
+    }>, TextExtension_2, BoldExtension, ItalicExtension, LinkExtension, HeadingExtension, CodeBlockExtension]>>;
+    m: ToMarkAction_2<SimplifyDeeper_2<    {
     bold: {
     readonly [x: string]: any;
     };
@@ -2445,22 +2563,22 @@ export declare function setupTest(): {
     };
     }>>;
     n: {
-        p: NodeAction<    {
+        p: NodeAction_2<    {
         readonly [x: string]: any;
         }>;
-        doc: NodeAction<    {
+        doc: NodeAction_2<    {
         readonly [x: string]: any;
         }>;
-        paragraph: NodeAction<    {
+        paragraph: NodeAction_2<    {
         readonly [x: string]: any;
         }>;
-        text: NodeAction<    {
+        text: NodeAction_2<    {
         readonly [x: string]: any;
         }>;
-        heading: NodeAction<    {
+        heading: NodeAction_2<    {
         readonly [x: string]: any;
         }>;
-        codeBlock: NodeAction<    {
+        codeBlock: NodeAction_2<    {
         language: string;
         }>;
     };