wysimark-lite 0.27.0 → 0.27.2

package/dist/index.d.mts

@@ -1,5 +1,5 @@
-import * as react from 'react';
-import react__default from 'react';
+import * as React$1 from 'react';
+import React__default, { ReactNode } from 'react';
 import * as slate from 'slate';
 import { Descendant, Editor, Element as Element$1, BaseEditor, NodeEntry, BaseRange, Location, Path, Text, BaseText } from 'slate';
 import { HistoryEditor } from 'slate-history';
@@ -9,6 +9,8 @@ import { EditableProps as EditableProps$1, RenderElementProps, RenderLeafProps,
 
 type OnImageChangeHandler = (file: File) => Promise<string>;
 type OnFileSelectHandler = () => Promise<string | null>;
+type RenderInternalLinkPreview = (target: string) => ReactNode;
+type RenderInternalEmbed = (spec: string) => ReactNode;
 type ImageDialogState = {
     url: string;
     alt: string;
@@ -53,6 +55,18 @@ type WysimarkEditor = {
          * Whether highlight mark is disabled
          */
         disableHighlight?: boolean;
+        /**
+         * Whether Obsidian-style internal links are enabled
+         */
+        enableInternalLinks?: boolean;
+        /**
+         * Render preview content for an internal link target.
+         */
+        renderInternalLinkPreview?: RenderInternalLinkPreview;
+        /**
+         * Render inline content for an internal embed (`![[spec]]`).
+         */
+        renderInternalEmbed?: RenderInternalEmbed;
     };
     /**
      * Public methods for the wysimark editor.
@@ -88,8 +102,16 @@ type UseEditorOptions = {
      * Defaults to true (highlight is disabled by default).
      */
     disableHighlight?: boolean;
+    /**
+     * Enable Obsidian-style internal links and embeds.
+     * When true, [[Page]] and ![[file.png]] are parsed and serialized as
+     * internal links. Defaults to false.
+     */
+    enableInternalLinks?: boolean;
+    renderInternalLinkPreview?: RenderInternalLinkPreview;
+    renderInternalEmbed?: RenderInternalEmbed;
 };
-declare function useEditor({ authToken, height, minHeight, maxHeight, disableRawMode, disableTaskList, disableCodeBlock, disableHighlight, }?: UseEditorOptions): Editor & ReactEditor & WysimarkEditor;
+declare function useEditor({ authToken, height, minHeight, maxHeight, disableRawMode, disableTaskList, disableCodeBlock, disableHighlight, enableInternalLinks, renderInternalLinkPreview, renderInternalEmbed, }?: UseEditorOptions): Editor & ReactEditor & WysimarkEditor;
 
 /**
  * SinkEditor just adds a `sink` object where we drop all of our sink
@@ -201,9 +223,9 @@ type VoidActionReturn = boolean | (() => void);
 
 type RenderEditableProps = {
     attributes: EditableProps$1;
-    Editable: react__default.ComponentType<EditableProps$1>;
+    Editable: React__default.ComponentType<EditableProps$1>;
 };
-type RenderEditable = (props: RenderEditableProps) => react__default.ReactElement;
+type RenderEditable = (props: RenderEditableProps) => React__default.ReactElement;
 /**
  * The return type of the BasePluginFn which specifies how the Plugin is
  * supposed to behave.
@@ -228,9 +250,9 @@ type BasePluginPolicy = {
     renderEditable?: RenderEditable;
     editableProps?: {
         decorate?: ((entry: NodeEntry) => BaseRange[]) | undefined;
-        renderElement?: (props: RenderElementProps) => react__default.ReactElement | undefined;
-        renderLeaf?: (props: RenderLeafProps) => react__default.ReactElement | undefined;
-        renderPlaceholder?: (props: RenderPlaceholderProps) => react__default.ReactElement;
+        renderElement?: (props: RenderElementProps) => React__default.ReactElement | undefined;
+        renderLeaf?: (props: RenderLeafProps) => React__default.ReactElement | undefined;
+        renderPlaceholder?: (props: RenderPlaceholderProps) => React__default.ReactElement;
         onKeyDown?: EditableVoidToBooleanHandlerType<"onKeyDown">;
         onKeyUp?: EditableVoidToBooleanHandlerType<"onKeyDown">;
         onPaste?: EditableVoidToBooleanHandlerType<"onPaste">;
@@ -577,7 +599,7 @@ declare function createListMethods(editor: Editor): {
     convertTaskList: (allowToggle: boolean) => void;
     insertBreak: () => boolean;
     toggleTaskListItem: (args_0?: {
-        at?: BetterAt | undefined;
+        at?: BetterAt;
     } | undefined) => boolean;
     getListDepth: () => number;
     canIncreaseDepth: () => boolean;
@@ -725,85 +747,66 @@ type TableInfo = {
     cellCount: number;
 };
 
-declare function createAnchorMethods(editor: Editor): {
-    insertLink: (args_0: string, args_1?: string | undefined, args_2?: {
-        select?: boolean | undefined;
-        title?: string | undefined;
-    } | undefined) => void;
-    removeLink: (args_0: {
-        at?: BetterAt | undefined;
-    }) => boolean;
-    editLink: (args_0: {
-        href: string;
-        title?: string | undefined;
-        text?: string | undefined;
-    }, args_1: {
-        at?: BetterAt | undefined;
+declare function createTableMethods(editor: Editor): {
+    getTableInfo: (args_0?: {
+        at?: slate.Location | slate.Element | null;
+    } | undefined) => TableInfo | undefined;
+    insertTable: (columnCount: number, rowCount: number, args_2?: {
+        at?: slate.Location | null;
+    } | undefined) => boolean;
+    insertColumn: (args_0?: {
+        offset?: 0 | 1;
+        at?: BetterAt;
+    } | undefined) => boolean;
+    insertRow: (args_0?: {
+        at?: BetterAt;
+        offset?: 0 | 1;
+    } | undefined) => boolean;
+    removeTable: () => boolean;
+    removeColumn: (args_0?: {
+        at?: BetterAt;
+    } | undefined) => boolean | undefined;
+    removeRow: (args_0?: {
+        at?: BetterAt;
+    } | undefined) => boolean;
+    tabForward: () => boolean;
+    tabBackward: () => boolean | undefined;
+    shiftEnterForward: () => boolean;
+    selectCell: (args_0?: {
+        at?: BetterAt;
+    } | undefined) => boolean;
+    down: () => boolean;
+    up: () => boolean;
+    setTableColumnAlign: (options: {
+        align: "left" | "center" | "right";
     }) => boolean;
 };
 
-type AnchorMethods = ReturnType<typeof createAnchorMethods>;
-type AnchorEditor = {
-    anchor: AnchorMethods;
-};
-type AnchorElement = {
-    type: "anchor";
-    href: string;
-    target?: string;
-    title?: string;
-    children: Descendant[];
-};
-type AnchorPluginCustomTypes = {
-    Name: "anchor";
-    Editor: AnchorEditor;
-    Element: AnchorElement;
+type TableEditor = {
+    supportsTable: true;
+    tablePlugin: ReturnType<typeof createTableMethods>;
 };
-
-declare function createHeadingMethods(editor: Editor): {
-    convertHeading: (level: 1 | 2 | 3 | 4 | 5 | 6, allowToggle: boolean) => void;
-    isHeadingActive: (level: 1 | 2 | 3 | 4 | 5 | 6) => boolean;
+type TablePluginCustomTypes = {
+    Name: "table";
+    Editor: TableEditor;
+    Element: TableElement | TableRowElement | TableCellElement | TableContentElement;
 };
 
-type HeadingEditor = {
-    heading: ReturnType<typeof createHeadingMethods>;
-};
-type HeadingElement = {
-    type: "heading";
+/**
+ * HTML block element for preserving raw HTML content
+ */
+type HtmlBlockElement = {
+    type: "html-block";
     /**
-     * NOTE:
-     *
-     * Don't extract these into a new type. It's easier to just repeat this and
-     * there's less indirection.
+     * The raw HTML content
      */
-    level: 1 | 2 | 3 | 4 | 5 | 6;
-    children: Descendant[];
-};
-type HeadingPluginCustomTypes = {
-    Name: "heading";
-    Editor: HeadingEditor;
-    Element: HeadingElement;
-};
-
-type BlockQuoteEditor = {
-    supportsBlockQuote: true;
-    blockQuotePlugin: {
-        indent: () => void;
-        outdent: () => void;
-        isActive: () => boolean;
-        increaseDepth: () => void;
-        decreaseDepth: () => void;
-        canIncreaseDepth: () => boolean;
-        canDecreaseDepth: () => boolean;
-    };
-};
-type BlockQuoteElement = {
-    type: "block-quote";
-    children: Descendant[];
+    html: string;
+    children: Text[];
 };
-type BlockQuotePluginCustomTypes = {
-    Name: "block-quote";
-    Editor: BlockQuoteEditor;
-    Element: BlockQuoteElement;
+type HtmlBlockPluginCustomTypes = {
+    Name: "html-block";
+    Editor: Record<string, never>;
+    Element: HtmlBlockElement;
 };
 
 declare function createCodeBlockMethods(editor: Editor): {
@@ -811,7 +814,7 @@ declare function createCodeBlockMethods(editor: Editor): {
         language: BuiltInLanguage;
     }) => void;
     setCodeBlockLanguage: (language: BuiltInLanguage, options?: {
-        at?: BetterAt | undefined;
+        at?: BetterAt;
     } | undefined) => boolean;
 };
 
@@ -847,66 +850,26 @@ type CodeBlockPluginCustomTypes = {
     };
 };
 
-/**
- * HTML block element for preserving raw HTML content
- */
-type HtmlBlockElement = {
-    type: "html-block";
-    /**
-     * The raw HTML content
-     */
-    html: string;
-    children: Text[];
-};
-type HtmlBlockPluginCustomTypes = {
-    Name: "html-block";
-    Editor: Record<string, never>;
-    Element: HtmlBlockElement;
-};
-
-declare function createTableMethods(editor: Editor): {
-    getTableInfo: (args_0?: {
-        at?: ImageBlockElement | ImageInlineElement | ParagraphElement | OrderedListItemElement | UnorderedListItemElement | TaskListItemElement | HorizontalRuleElement | TableElement | TableRowElement | TableCellElement | TableContentElement | HtmlBlockElement | CodeBlockElement | CodeBlockLineElement | BlockQuoteElement | HeadingElement | AnchorElement | slate.Location | null | undefined;
-    } | undefined) => TableInfo | undefined;
-    insertTable: (args_0: number, args_1: number, args_2?: {
-        at?: slate.Location | null | undefined;
-    } | undefined) => boolean;
-    insertColumn: (args_0?: {
-        offset?: 0 | 1 | undefined;
-        at?: BetterAt | undefined;
-    } | undefined) => boolean;
-    insertRow: (args_0?: {
-        at?: BetterAt | undefined;
-        offset?: 0 | 1 | undefined;
-    } | undefined) => boolean;
-    removeTable: () => boolean;
-    removeColumn: (args_0?: {
-        at?: BetterAt | undefined;
-    } | undefined) => boolean | undefined;
-    removeRow: (args_0?: {
-        at?: BetterAt | undefined;
-    } | undefined) => boolean;
-    tabForward: () => boolean;
-    tabBackward: () => boolean | undefined;
-    shiftEnterForward: () => boolean;
-    selectCell: (args_0?: {
-        at?: BetterAt | undefined;
-    } | undefined) => boolean;
-    down: () => boolean;
-    up: () => boolean;
-    setTableColumnAlign: (options: {
-        align: "center" | "left" | "right";
-    }) => boolean;
+type BlockQuoteEditor = {
+    supportsBlockQuote: true;
+    blockQuotePlugin: {
+        indent: () => void;
+        outdent: () => void;
+        isActive: () => boolean;
+        increaseDepth: () => void;
+        decreaseDepth: () => void;
+        canIncreaseDepth: () => boolean;
+        canDecreaseDepth: () => boolean;
+    };
 };
-
-type TableEditor = {
-    supportsTable: true;
-    tablePlugin: ReturnType<typeof createTableMethods>;
+type BlockQuoteElement = {
+    type: "block-quote";
+    children: Descendant[];
 };
-type TablePluginCustomTypes = {
-    Name: "table";
-    Editor: TableEditor;
-    Element: TableElement | TableRowElement | TableCellElement | TableContentElement;
+type BlockQuotePluginCustomTypes = {
+    Name: "block-quote";
+    Editor: BlockQuoteEditor;
+    Element: BlockQuoteElement;
 };
 
 type InlineCodeEditor = {
@@ -926,10 +889,10 @@ type InlineCodePluginCustomTypes = {
 
 declare function createMarksMethods(editor: Editor): {
     removeMarks: (args_0?: {
-        at?: slate.Location | null | undefined;
+        at?: slate.Location | null;
     } | undefined) => void;
-    toggleMark: (args_0: "bold" | "strike" | "text" | "prismToken" | "code" | "italic" | "underline" | "highlight", args_1?: "bold" | "strike" | "text" | "prismToken" | "code" | "italic" | "underline" | "highlight" | undefined, args_2?: {
-        at?: slate.Location | null | undefined;
+    toggleMark: (markKey: "bold" | "strike" | "text" | "prismToken" | "code" | "italic" | "underline" | "highlight", unsetKey?: "bold" | "strike" | "text" | "prismToken" | "code" | "italic" | "underline" | "highlight" | undefined, args_2?: {
+        at?: slate.Location | null;
     } | undefined) => void;
     toggleBold: () => void;
     toggleItalic: () => void;
@@ -968,6 +931,68 @@ type MarksPluginCustomTypes = {
     Text: MarksText;
 };
 
+declare function createHeadingMethods(editor: Editor): {
+    convertHeading: (level: 1 | 2 | 3 | 4 | 5 | 6, allowToggle: boolean) => void;
+    isHeadingActive: (level: 1 | 2 | 3 | 4 | 5 | 6) => boolean;
+};
+
+type HeadingEditor = {
+    heading: ReturnType<typeof createHeadingMethods>;
+};
+type HeadingElement = {
+    type: "heading";
+    /**
+     * NOTE:
+     *
+     * Don't extract these into a new type. It's easier to just repeat this and
+     * there's less indirection.
+     */
+    level: 1 | 2 | 3 | 4 | 5 | 6;
+    children: Descendant[];
+};
+type HeadingPluginCustomTypes = {
+    Name: "heading";
+    Editor: HeadingEditor;
+    Element: HeadingElement;
+};
+
+declare function createAnchorMethods(editor: Editor): {
+    insertLink: (href: string, text?: string | undefined, args_2?: {
+        select?: boolean;
+        title?: string;
+    } | undefined) => void;
+    removeLink: (args_0: {
+        at?: BetterAt;
+    }) => boolean;
+    editLink: (args_0: {
+        href: string;
+        title?: string;
+        text?: string;
+    }, args_1: {
+        at?: BetterAt;
+    }) => boolean;
+    convertToEmbed: (spec: string, args_1: {
+        at?: BetterAt;
+    }) => boolean;
+};
+
+type AnchorMethods = ReturnType<typeof createAnchorMethods>;
+type AnchorEditor = {
+    anchor: AnchorMethods;
+};
+type AnchorElement = {
+    type: "anchor";
+    href: string;
+    target?: string;
+    title?: string;
+    children: Descendant[];
+};
+type AnchorPluginCustomTypes = {
+    Name: "anchor";
+    Editor: AnchorEditor;
+    Element: AnchorElement;
+};
+
 /**
  * A type with generic for `convertElements` (below) to be used with the curry
  * method. TypeScript, unfortunately, cannot automatically curry generics for
@@ -1032,7 +1057,7 @@ type EditableProps = {
     onImageChange?: OnImageChangeHandler;
     onFileSelect?: OnFileSelectHandler;
 };
-declare function Editable({ editor, value, onChange, throttleInMs, placeholder, className, style, onImageChange, onFileSelect, }: EditableProps): react.JSX.Element;
+declare function Editable({ editor, value, onChange, throttleInMs, placeholder, className, style, onImageChange, onFileSelect, }: EditableProps): React$1.JSX.Element;
 
 /**
  * Remove inline escape backslashes added by the serializer's escapeText.