@lofcz/platejs-markdown 52.3.5 → 52.3.8

package/dist/index.d.ts

@@ -1,109 +1,15 @@
-import { Descendant as Descendant$1, NodeKey, Nullable, OmitFirst, PluginConfig, SlateEditor, TElement, TListElement, TNodeMap, TText, Value } from "platejs";
+import * as platejs2 from "platejs";
+import { Descendant, NodeKey, Nullable, OmitFirst, PluginConfig, SlateEditor, TElement, TListElement, TNodeMap, TText, Value } from "platejs";
 import { MdxJsxFlowElement, MdxJsxFlowElement as MdMdxJsxFlowElement, MdxJsxTextElement, MdxJsxTextElement as MdMdxJsxTextElement } from "mdast-util-mdx";
 import { Options } from "remark-stringify";
 import { Plugin } from "unified";
 import { Token } from "marked";
 import baseRemarkMdx from "remark-mdx";
-import * as unistLib from "unist";
-import { StrictExtract } from "ts-essentials";
 import { Blockquote as MdBlockquote, Break as MdBreak, Code as MdCode, Content as MdContent, Definition as MdDefinition, Delete as MdDelete, Emphasis as MdEmphasis, FootnoteDefinition as MdFootnoteDefinition, FootnoteReference as MdFootnoteReference, Heading as MdHeading, Html as MdHtml, Image as MdImage, ImageReference as MdImageReference, InlineCode as MdInlineCode, Link as MdLink, LinkReference as MdLinkReference, List as MdList, ListItem as MdListItem, Paragraph as MdParagraph, PhrasingContent as MDPhrasingContent, Root, Root as MdRoot, RootContent as MdRootContent, Strong as MdStrong, Table as MdTable, TableCell as MdTableCell, TableRow as MdTableRow, Text as MdText, ThematicBreak as MdThematicBreak, Yaml as MdYaml } from "mdast";
 import { InlineMath as MdInlineMath, Math as MdMath } from "mdast-util-math";
+import * as unistLib from "unist";
+import { StrictExtract } from "ts-essentials";
 
-//#region src/lib/deserializer/utils/customMdxDeserialize.d.ts
-declare const customMdxDeserialize: (mdastNode: MdxJsxFlowElement | MdxJsxTextElement, deco: MdDecoration, options: DeserializeMdOptions) => any;
-//#endregion
-//#region src/lib/deserializer/utils/deserializeInlineMd.d.ts
-declare const deserializeInlineMd: (editor: SlateEditor, text: string, options?: DeserializeMdOptions) => Descendant[];
-//#endregion
-//#region src/lib/deserializer/utils/getDeserializerByKey.d.ts
-declare const getDeserializerByKey: (key: string, options: DeserializeMdOptions) => any;
-//#endregion
-//#region src/lib/deserializer/utils/getMergedOptionsDeserialize.d.ts
-/**
- * Merges Markdown configurations, following the principle that options take
- * precedence
- *
- * @param editor Editor instance used to get plugin default configurations
- * @param options User-provided options (higher priority)
- * @returns The final merged configuration
- */
-declare const getMergedOptionsDeserialize: (editor: SlateEditor, options?: DeserializeMdOptions) => DeserializeMdOptions;
-//#endregion
-//#region src/lib/deserializer/utils/getStyleValue.d.ts
-declare const getStyleValue: (mdastNode: MdMdxJsxTextElement, styleName: string) => string | undefined;
-//#endregion
-//#region src/lib/deserializer/utils/htmlToJsx.d.ts
-declare const htmlToJsx: (html: string) => string;
-//#endregion
-//#region src/lib/deserializer/utils/markdownToSlateNodesSafely.d.ts
-declare const markdownToSlateNodesSafely: (editor: SlateEditor, data: string, options?: Omit<DeserializeMdOptions, "editor">) => Descendant[];
-//#endregion
-//#region src/lib/deserializer/utils/parseMarkdownBlocks.d.ts
-type ParseMarkdownBlocksOptions = {
-  /**
-   * Token types to exclude from the output.
-   *
-   * @default ['space']
-   */
-  exclude?: string[];
-  /**
-   * Whether to trim the content.
-   *
-   * @default true
-   */
-  trim?: boolean;
-};
-declare const parseMarkdownBlocks: (content: string, {
-  exclude,
-  trim
-}?: ParseMarkdownBlocksOptions) => Token[];
-//#endregion
-//#region src/lib/deserializer/utils/splitIncompleteMdx.d.ts
-declare const splitIncompleteMdx: (data: string) => string[] | string;
-//#endregion
-//#region src/lib/deserializer/utils/stripMarkdown.d.ts
-declare const stripMarkdownBlocks: (text: string) => string;
-declare const stripMarkdownInline: (text: string) => string;
-declare const stripMarkdown: (text: string) => string;
-//#endregion
-//#region src/lib/deserializer/deserializeMd.d.ts
-type DeserializeMdOptions = {
-  allowedNodes?: PlateType[] | null;
-  allowNode?: AllowNodeConfig;
-  disallowedNodes?: PlateType[] | null;
-  editor?: SlateEditor;
-  memoize?: boolean;
-  parser?: ParseMarkdownBlocksOptions;
-  preserveEmptyParagraphs?: boolean;
-  remarkPlugins?: Plugin[];
-  rules?: MdRules | null;
-  splitLineBreaks?: boolean;
-  withoutMdx?: boolean;
-  onError?: (error: Error) => void;
-};
-declare const markdownToAstProcessor: (editor: SlateEditor, data: string, options?: DeserializeMdOptions) => Root;
-declare const markdownToSlateNodes: (editor: SlateEditor, data: string, options?: Omit<DeserializeMdOptions, "editor">) => Descendant$1[];
-declare const deserializeMd: (editor: SlateEditor, data: string, options?: Omit<DeserializeMdOptions, "editor">) => Value;
-declare module 'unified' {
-  interface CompileResultMap {
-    remarkToSlateNode: Descendant$1[];
-  }
-}
-//# sourceMappingURL=deserializeMd.d.ts.map
-//#endregion
-//#region src/lib/deserializer/convertChildrenDeserialize.d.ts
-declare const convertChildrenDeserialize: (children: MdRootContent[], deco: MdDecoration, options: DeserializeMdOptions) => Descendant$1[];
-//#endregion
-//#region src/lib/deserializer/convertNodesDeserialize.d.ts
-declare const convertNodesDeserialize: (nodes: MdRootContent[], deco: MdDecoration, options: DeserializeMdOptions) => Descendant$1[];
-declare const buildSlateNode: (mdastNode: MdRootContent, deco: MdDecoration, options: DeserializeMdOptions) => Descendant$1[];
-//#endregion
-//#region src/lib/deserializer/convertTextsDeserialize.d.ts
-declare const convertTextsDeserialize: (mdastNode: MdDelete | MdEmphasis | MdStrong, deco: MdDecoration, options: DeserializeMdOptions) => any;
-//#endregion
-//#region src/lib/deserializer/mdastToSlate.d.ts
-declare const mdastToSlate: (node: Root, options: DeserializeMdOptions) => Descendant$1[];
-//#endregion
 //#region src/lib/serializer/serializeMd.d.ts
 type SerializeMdOptions = {
   allowedNodes?: PlateType[] | null;
@@ -117,14 +23,14 @@ type SerializeMdOptions = {
   remarkStringifyOptions?: Options | null;
   rules?: MdRules;
   spread?: boolean;
-  value?: Descendant$1[];
+  value?: Descendant[];
   withBlockId?: boolean;
 };
 /** Serialize the editor value to Markdown. */
 declare const serializeMd: (editor: SlateEditor, options?: Omit<SerializeMdOptions, "editor">) => string;
 //#endregion
 //#region src/lib/serializer/convertNodesSerialize.d.ts
-declare const convertNodesSerialize: (nodes: Descendant$1[], options: SerializeMdOptions, isBlock?: boolean) => unistLib.Node[];
+declare const convertNodesSerialize: (nodes: Descendant[], options: SerializeMdOptions, isBlock?: boolean) => unistLib.Node[];
 declare const buildMdastNode: (node: any, options: SerializeMdOptions, isBlock?: boolean) => any;
 //#endregion
 //#region src/lib/serializer/convertTextsSerialize.d.ts
@@ -137,6 +43,26 @@ declare function listToMdastTree(nodes: TListElement[], options: SerializeMdOpti
 //#region src/lib/serializer/serializeInlineMd.d.ts
 declare const serializeInlineMd: (editor: SlateEditor, options?: SerializeMdOptions) => string;
 //#endregion
+//#region src/lib/serializer/serializeMdWithSourceMap.d.ts
+type SelectionPath = number[];
+type MarkdownSourceMapKind = 'block' | 'blockquote' | 'code_block' | 'heading' | 'list_item' | 'media' | 'paragraph' | 'table_cell';
+type MarkdownSourceMapSegment = {
+  containsMdx: boolean;
+  endLine: number;
+  kind: MarkdownSourceMapKind;
+  markdown: string;
+  nodeId?: string;
+  path: SelectionPath;
+  pathKey: string;
+  startLine: number;
+  text: string;
+};
+type SerializeMdSourceMapResult = {
+  markdown: string;
+  segments: MarkdownSourceMapSegment[];
+};
+declare const serializeMdWithSourceMap: (editor: SlateEditor, options?: Omit<SerializeMdOptions, "editor">) => SerializeMdSourceMapResult;
+//#endregion
 //#region src/lib/serializer/wrapWithBlockId.d.ts
 /**
  * Wraps an mdast node with a block element containing an ID attribute. Used for
@@ -254,12 +180,12 @@ type MdNodeMap = {
  * Get plate node type from mdast node type if the mdast is mdast only return
  * the mdast type itself.
  */
-declare const mdastToPlate: <T extends StrictMdType>(editor: SlateEditor, mdastType: T) => any;
+declare const mdastToPlate: <T extends StrictMdType>(editor: SlateEditor, mdastType: T) => string;
 /**
  * Get mdast node type from plate element type if the plateType is plate only
  * return the plateType itself.
  */
-declare const plateToMdast: <T extends StrictPlateType>(plateType: T) => T | NonNullable<{
+declare const plateToMdast: <T extends StrictPlateType>(plateType: T) => {
   readonly a: "link";
   readonly blockquote: "blockquote";
   readonly bold: "strong";
@@ -293,7 +219,108 @@ declare const plateToMdast: <T extends StrictPlateType>(plateType: T) => T | Non
   readonly toggle: "toggle";
   readonly tr: "tableRow";
   readonly underline: "u";
-}[T]>;
+}[T];
+//#endregion
+//#region src/lib/deserializer/utils/customMdxDeserialize.d.ts
+declare const customMdxDeserialize: (mdastNode: MdxJsxFlowElement | MdxJsxTextElement, deco: MdDecoration, options: DeserializeMdOptions) => any;
+//#endregion
+//#region src/lib/deserializer/utils/deserializeInlineMd.d.ts
+declare const deserializeInlineMd: (editor: SlateEditor, text: string, options?: DeserializeMdOptions) => Descendant[] | {
+  text: string;
+}[];
+//#endregion
+//#region src/lib/deserializer/utils/getDeserializerByKey.d.ts
+declare const getDeserializerByKey: (key: string, options: DeserializeMdOptions) => any;
+//#endregion
+//#region src/lib/deserializer/utils/getMergedOptionsDeserialize.d.ts
+/**
+ * Merges Markdown configurations, following the principle that options take
+ * precedence
+ *
+ * @param editor Editor instance used to get plugin default configurations
+ * @param options User-provided options (higher priority)
+ * @returns The final merged configuration
+ */
+declare const getMergedOptionsDeserialize: (editor: SlateEditor, options?: DeserializeMdOptions) => DeserializeMdOptions;
+//#endregion
+//#region src/lib/deserializer/utils/getStyleValue.d.ts
+declare const getStyleValue: (mdastNode: MdMdxJsxTextElement, styleName: string) => string | undefined;
+//#endregion
+//#region src/lib/deserializer/utils/htmlToJsx.d.ts
+declare const htmlToJsx: (html: string) => string;
+//#endregion
+//#region src/lib/deserializer/utils/markdownToSlateNodesSafely.d.ts
+declare const markdownToSlateNodesSafely: (editor: SlateEditor, data: string, options?: Omit<DeserializeMdOptions, "editor">) => (platejs2.TText | {
+  children: platejs2.Descendant[] | {
+    text: string;
+  }[];
+  type: string;
+})[];
+//#endregion
+//#region src/lib/deserializer/utils/parseMarkdownBlocks.d.ts
+type ParseMarkdownBlocksOptions = {
+  /**
+   * Token types to exclude from the output.
+   *
+   * @default ['space']
+   */
+  exclude?: string[];
+  /**
+   * Whether to trim the content.
+   *
+   * @default true
+   */
+  trim?: boolean;
+};
+declare const parseMarkdownBlocks: (content: string, {
+  exclude,
+  trim
+}?: ParseMarkdownBlocksOptions) => Token[];
+//#endregion
+//#region src/lib/deserializer/utils/splitIncompleteMdx.d.ts
+declare const splitIncompleteMdx: (data: string) => string[] | string;
+//#endregion
+//#region src/lib/deserializer/utils/stripMarkdown.d.ts
+declare const stripMarkdownBlocks: (text: string) => string;
+declare const stripMarkdownInline: (text: string) => string;
+declare const stripMarkdown: (text: string) => string;
+//#endregion
+//#region src/lib/deserializer/deserializeMd.d.ts
+type DeserializeMdOptions = {
+  allowedNodes?: PlateType[] | null;
+  allowNode?: AllowNodeConfig;
+  disallowedNodes?: PlateType[] | null;
+  editor?: SlateEditor;
+  memoize?: boolean;
+  parser?: ParseMarkdownBlocksOptions;
+  preserveEmptyParagraphs?: boolean;
+  remarkPlugins?: Plugin[];
+  rules?: MdRules | null;
+  splitLineBreaks?: boolean;
+  withoutMdx?: boolean;
+  onError?: (error: Error) => void;
+};
+declare const markdownToAstProcessor: (editor: SlateEditor, data: string, options?: DeserializeMdOptions) => Root;
+declare const markdownToSlateNodes: (editor: SlateEditor, data: string, options?: Omit<DeserializeMdOptions, "editor">) => Descendant[];
+declare const deserializeMd: (editor: SlateEditor, data: string, options?: Omit<DeserializeMdOptions, "editor">) => Value;
+declare module 'unified' {
+  interface CompileResultMap {
+    remarkToSlateNode: Descendant[];
+  }
+}
+//#endregion
+//#region src/lib/deserializer/convertChildrenDeserialize.d.ts
+declare const convertChildrenDeserialize: (children: MdRootContent[], deco: MdDecoration, options: DeserializeMdOptions) => Descendant[];
+//#endregion
+//#region src/lib/deserializer/convertNodesDeserialize.d.ts
+declare const convertNodesDeserialize: (nodes: MdRootContent[], deco: MdDecoration, options: DeserializeMdOptions) => Descendant[];
+declare const buildSlateNode: (mdastNode: MdRootContent, deco: MdDecoration, options: DeserializeMdOptions) => Descendant[];
+//#endregion
+//#region src/lib/deserializer/convertTextsDeserialize.d.ts
+declare const convertTextsDeserialize: (mdastNode: MdDelete | MdEmphasis | MdStrong, deco: MdDecoration, options: DeserializeMdOptions) => any;
+//#endregion
+//#region src/lib/deserializer/mdastToSlate.d.ts
+declare const mdastToSlate: (node: Root, options: DeserializeMdOptions) => Descendant[];
 //#endregion
 //#region src/lib/MarkdownPlugin.d.ts
 type AllowNodeConfig = {
@@ -363,7 +390,73 @@ type MarkdownConfig = PluginConfig<'markdown', {
     serialize: OmitFirst<typeof serializeMd>;
   };
 }>;
-declare const MarkdownPlugin: any;
+declare const MarkdownPlugin: platejs2.SlatePlugin<PluginConfig<"markdown", {
+  /**
+   * Configuration for allowed node types. Cannot be combined with
+   * disallowedNodes.
+   */
+  allowedNodes: PlateType[] | null;
+  /**
+   * Configuration for disallowed node types. Cannot be combined with
+   * allowedNodes.
+   *
+   * @default null
+   */
+  disallowedNodes: PlateType[] | null;
+  /**
+   * Array of remark plugins to extend Markdown parsing and serialization
+   * functionality. For example, you can add remark-gfm to support GFM syntax,
+   * remark-math to support mathematical formulas, etc. These plugins will be
+   * used during the parsing and generation of Markdown text.
+   *
+   * @default undefined
+   */
+  remarkPlugins: Plugin[];
+  /**
+   * Custom options passed to remark-stringify.
+   *
+   * @default null
+   */
+  remarkStringifyOptions: Options | null;
+  /**
+   * Rules that define how to convert Markdown syntax elements to Slate editor
+   * elements. Or rules that how to convert Slate editor elements to Markdown
+   * syntax elements. Includes conversion rules for elements such as
+   * paragraphs, headings, lists, links, images, etc.
+   *
+   * You can pass null disable default node parser.
+   *
+   * NOTE: don't forget pass `mark:true` when you custom inline nodes.
+   *
+   * @default null
+   */
+  rules: MdRules | null;
+  /**
+   * Custom filter function for nodes during deserialization and
+   * serialization.
+   *
+   * @default null
+   */
+  allowNode?: AllowNodeConfig;
+  /**
+   * Marks to treat as plain text without applying markdown formatting.
+   *
+   * @default null
+   */
+  plainMarks?: PlateType[] | null;
+}, {
+  markdown: {
+    deserialize: OmitFirst<typeof deserializeMd>;
+    deserializeInline: OmitFirst<typeof deserializeInlineMd>;
+    serialize: OmitFirst<typeof serializeMd>;
+  };
+} & Record<"markdown", {
+  deserialize: (data: string, options?: Omit<DeserializeMdOptions, "editor"> | undefined) => platejs2.Value;
+  deserializeInline: (text: string, options?: DeserializeMdOptions | undefined) => platejs2.Descendant[] | {
+    text: string;
+  }[];
+  serialize: (options?: Omit<SerializeMdOptions, "editor"> | undefined) => string;
+}>, {}, {}>>;
 //#endregion
 //#region src/lib/plugins/remarkMdx.d.ts
 declare const remarkMdx: typeof baseRemarkMdx;
@@ -421,5 +514,4 @@ declare const tagRemarkPlugin: (pluginFn: any, tag: string) => {
 };
 declare const getRemarkPluginsWithoutMdx: (plugins: Plugin[]) => Plugin[];
 //#endregion
-export { AllowNodeConfig, DeserializeMdOptions, type MDPhrasingContent, MarkdownConfig, MarkdownPlugin, type MdBlockquote, type MdBreak, type MdCode, type MdContent, MdDecoration, type MdDefinition, type MdDelete, type MdEmphasis, type MdFootnoteDefinition, type MdFootnoteReference, type MdHeading, type MdHtml, type MdImage, type MdImageReference, type MdInlineCode, type MdInlineMath, type MdLink, type MdLinkReference, type MdList, type MdListItem, MdMark, type MdMath, type MdMdxJsxFlowElement, type MdMdxJsxTextElement, MdNodeParser, type MdParagraph, type MdRoot, type MdRootContent, MdRules, type MdStrong, type MdTable, type MdTableCell, type MdTableRow, type MdText, type MdThematicBreak, MdType, type MdYaml, MentionNode, ParseMarkdownBlocksOptions, PlateType, REMARK_MDX_TAG, SerializeMdOptions, StrictPlateType, basicMarkdownMarks, buildMdastNode, buildRules, buildSlateNode, columnRules, convertChildrenDeserialize, convertNodesDeserialize, convertNodesSerialize, convertTextsDeserialize, convertTextsSerialize, customMdxDeserialize, defaultRules, deserializeInlineMd, deserializeMd, fontRules, getCustomMark, getDeserializerByKey, getMergedOptionsDeserialize, getMergedOptionsSerialize, getRemarkPluginsWithoutMdx, getSerializerByKey, getStyleValue, htmlToJsx, listToMdastTree, markdownToAstProcessor, markdownToSlateNodes, markdownToSlateNodesSafely, mdastToPlate, mdastToSlate, mediaRules, parseAttributes, parseMarkdownBlocks, plateToMdast, propsToAttributes, remarkMdx, remarkMention, serializeInlineMd, serializeMd, splitIncompleteMdx, stripMarkdown, stripMarkdownBlocks, stripMarkdownInline, tagRemarkPlugin, type unistLib, unreachable, wrapWithBlockId };
-//# sourceMappingURL=index.d.ts.map
+export { AllowNodeConfig, DeserializeMdOptions, type MDPhrasingContent, MarkdownConfig, MarkdownPlugin, MarkdownSourceMapKind, MarkdownSourceMapSegment, type MdBlockquote, type MdBreak, type MdCode, type MdContent, MdDecoration, type MdDefinition, type MdDelete, type MdEmphasis, type MdFootnoteDefinition, type MdFootnoteReference, type MdHeading, type MdHtml, type MdImage, type MdImageReference, type MdInlineCode, type MdInlineMath, type MdLink, type MdLinkReference, type MdList, type MdListItem, MdMark, type MdMath, type MdMdxJsxFlowElement, type MdMdxJsxTextElement, MdNodeParser, type MdParagraph, type MdRoot, type MdRootContent, MdRules, type MdStrong, type MdTable, type MdTableCell, type MdTableRow, type MdText, type MdThematicBreak, MdType, type MdYaml, MentionNode, ParseMarkdownBlocksOptions, PlateType, REMARK_MDX_TAG, SerializeMdOptions, SerializeMdSourceMapResult, StrictPlateType, basicMarkdownMarks, buildMdastNode, buildRules, buildSlateNode, columnRules, convertChildrenDeserialize, convertNodesDeserialize, convertNodesSerialize, convertTextsDeserialize, convertTextsSerialize, customMdxDeserialize, defaultRules, deserializeInlineMd, deserializeMd, fontRules, getCustomMark, getDeserializerByKey, getMergedOptionsDeserialize, getMergedOptionsSerialize, getRemarkPluginsWithoutMdx, getSerializerByKey, getStyleValue, htmlToJsx, listToMdastTree, markdownToAstProcessor, markdownToSlateNodes, markdownToSlateNodesSafely, mdastToPlate, mdastToSlate, mediaRules, parseAttributes, parseMarkdownBlocks, plateToMdast, propsToAttributes, remarkMdx, remarkMention, serializeInlineMd, serializeMd, serializeMdWithSourceMap, splitIncompleteMdx, stripMarkdown, stripMarkdownBlocks, stripMarkdownInline, tagRemarkPlugin, type unistLib, unreachable, wrapWithBlockId };