@mdxeditor/editor 4.0.2 → 4.0.4

package/dist/index.d.ts

@@ -1,4 +1,3 @@
-import { Config } from 'mdast-util-from-markdown/lib';
 import { ContentEditable } from '@lexical/react/LexicalContentEditable';
 import { DecoratorNode } from 'lexical';
 import { default as default_2 } from 'react';
@@ -10,9 +9,11 @@ import { EditorConfig } from 'lexical';
 import { EditorState } from 'lexical';
 import { EditorThemeClasses } from 'lexical';
 import { ElementNode } from 'lexical';
-import { Extension } from 'micromark-util-types';
-import { Extension as Extension_2 } from '@codemirror/state';
+import { Extension } from 'mdast-util-from-markdown';
+import { Extension as Extension_2 } from 'micromark-util-types';
+import { Extension as Extension_3 } from '@codemirror/state';
 import { FC } from 'react';
+import { Options as FromMarkdownOptions } from 'mdast-util-from-markdown';
 import { HeadingTagType } from '@lexical/rich-text';
 import { HistoryState } from '@lexical/history';
 import { JSX } from 'react';
@@ -34,9 +35,8 @@ import { MdxJsxTextElement } from 'mdast-util-mdx-jsx';
 import { Node as Node_2 } from 'unist';
 import { NodeKey } from 'lexical';
 import { NodeRef } from '@mdxeditor/gurx';
-import { Options } from 'mdast-util-from-markdown';
-import { Options as Options_2 } from 'mdast-util-to-markdown/lib/types';
-import { Options as Options_3 } from 'mdast-util-gfm-table';
+import { Options } from 'mdast-util-to-markdown';
+import { Options as Options_2 } from 'mdast-util-gfm-table';
 import { ParseOptions } from 'micromark-util-types';
 import { PropsWithChildren } from 'react';
 import * as RadixToolbar from '@radix-ui/react-toolbar';
@@ -49,7 +49,6 @@ import { SerializedLexicalNode } from 'lexical';
 import { Spread } from 'lexical';
 import { TextFormatType } from 'lexical';
 import { TextNode } from 'lexical';
-import { Options as ToMarkdownOptions } from 'mdast-util-to-markdown';
 
 /**
  * Converts a <pre> HTML element into a CodeBlockNode.
@@ -214,7 +213,7 @@ export declare const addLexicalNode$: NodeRef<KlassConstructor<typeof LexicalNod
  * Adds a mdast extension to the markdown parser.
  * @group Markdown Processing
  */
-export declare const addMdastExtension$: NodeRef<Partial< Config> | Partial< Config>[] | (Partial< Config> | Partial< Config>[])[]>;
+export declare const addMdastExtension$: NodeRef<MdastExtension | MdastExtension[]>;
 
 /**
  * Lets you add React components as children of any registered nested editor (useful for Lexical plugins).
@@ -226,7 +225,7 @@ export declare const addNestedEditorChild$: NodeRef<default_2.ComponentType<{}>
  * Adds a syntax extension to the markdown parser.
  * @group Markdown Processing
  */
-export declare const addSyntaxExtension$: NodeRef< Extension | Extension[]>;
+export declare const addSyntaxExtension$: NodeRef< Extension_2 | Extension_2[]>;
 
 /**
  * Lets you add React components as children of table cell editors.
@@ -238,7 +237,7 @@ export declare const addTableCellEditorChild$: NodeRef<default_2.ComponentType<{
  * Adds a markdown to string extension to be used when exporting markdown from the Lexical tree.
  * @group Markdown Processing
  */
-export declare const addToMarkdownExtension$: NodeRef< Options_2 | Options_2[]>;
+export declare const addToMarkdownExtension$: NodeRef<ToMarkdownExtension | ToMarkdownExtension[]>;
 
 /**
  * Lets you add React components on top of the editor (like the toolbar).
@@ -554,7 +553,7 @@ export declare const codeBlockLanguages$: NodeRef<NormalizedCodeBlockLanguages>;
  * @group CodeMirror
  */
 export declare interface CodeBlockLanguageSupport {
-    extension: Extension_2;
+    extension: Extension_3;
 }
 
 /**
@@ -618,7 +617,7 @@ export declare const CodeMirrorEditor: ({ language, nodeKey, code, focusEmitter
  * The code mirror extensions for the coemirror code block editor.
  * @group CodeMirror
  */
-export declare const codeMirrorExtensions$: NodeRef<Extension_2[]>;
+export declare const codeMirrorExtensions$: NodeRef<Extension_3[]>;
 
 /**
  * A plugin that adds lets users edit code blocks with CodeMirror.
@@ -635,7 +634,7 @@ export declare const codeMirrorPlugin: (params?: {
     /**
      * Optional, additional CodeMirror extensions to load in the diff/source mode.
      */
-    codeMirrorExtensions?: Extension_2[];
+    codeMirrorExtensions?: Extension_3[];
     /**
      * Whether or not to try to dynamically load the code block language support.
      * Disable if you want to manually pass the supported languages.
@@ -651,7 +650,7 @@ export declare const codeMirrorPlugin: (params?: {
  */
 export declare const CodeToggle: default_2.FC;
 
-export declare const COMMON_STATE_CONFIG_EXTENSIONS: Extension_2[];
+export declare const COMMON_STATE_CONFIG_EXTENSIONS: Extension_3[];
 
 /**
  * Performs left to right composition of two functions.
@@ -967,7 +966,7 @@ export declare const diffSourcePlugin: (params?: {
     /**
      * Optional, additional CodeMirror extensions to load in the diff/source mode.
      */
-    codeMirrorExtensions?: Extension_2[];
+    codeMirrorExtensions?: Extension_3[];
     /**
      * Set the diff editor to read-only.
      * @default false
@@ -1221,13 +1220,29 @@ export declare const editorWrapperElementRef$: NodeRef<default_2.RefObject<HTMLD
 
 export declare const EmptyTextNodeIndex: TextNodeIndex;
 
-/* Excluded from this release type: ExportLexicalTreeOptions */
+export declare interface ExportLexicalTreeOptions {
+    root: RootNode;
+    visitors: LexicalVisitor[];
+    jsxComponentDescriptors: JsxComponentDescriptor[];
+    jsxIsAvailable: boolean;
+    addImportStatements?: boolean;
+}
 
 export declare function exportLexicalTreeToMdast({ root, visitors, jsxComponentDescriptors, jsxIsAvailable, addImportStatements }: ExportLexicalTreeOptions): Mdast.Root;
 
 /* Excluded from this release type: exportMarkdownFromLexical */
 
-/* Excluded from this release type: ExportMarkdownFromLexicalOptions */
+export declare interface ExportMarkdownFromLexicalOptions extends ExportLexicalTreeOptions {
+    visitors: LexicalVisitor[];
+    /**
+     * the markdown extensions to use
+     */
+    toMarkdownExtensions: ToMarkdownExtension[];
+    /**
+     * The options to pass to `toMarkdown`
+     */
+    toMarkdownOptions: ToMarkdownOptions;
+}
 
 /**
  * Contains the currently registered export visitors.
@@ -1263,6 +1278,8 @@ export declare interface FileImageParameters extends BaseImageParameters {
 
 export declare type FORMAT = typeof DEFAULT_FORMAT | typeof IS_BOLD | typeof IS_ITALIC | typeof IS_STRIKETHROUGH | typeof IS_UNDERLINE | typeof IS_CODE | typeof IS_SUBSCRIPT | typeof IS_SUPERSCRIPT | typeof IS_HIGHLIGHT;
 
+export { FromMarkdownOptions }
+
 /**
  * Fetches a value from the Lexical editor read cycle.
  * @group Utils
@@ -2131,11 +2148,11 @@ export declare interface MdastBlockHTMLNode extends MdxJsxFlowElement {
     name: (typeof htmlTags)[number];
 }
 
-/* Excluded from this release type: MdastExtension */
+export declare type MdastExtension = Extension | Extension[];
 
 /* Excluded from this release type: mdastExtensions$ */
 
-/* Excluded from this release type: MdastExtensions */
+export declare type MdastExtensions = MdastExtension[];
 
 /**
  * A HTML MDAST node.
@@ -2240,7 +2257,14 @@ export declare interface MdastInlineHTMLNode extends MdxJsxTextElement {
  */
 export declare type MdastJsx = MdxJsxTextElement | MdxJsxFlowElement;
 
-/* Excluded from this release type: MdastTreeImportOptions */
+/**
+ * The options of the tree import utility. Not meant to be used directly.
+ */
+export declare interface MdastTreeImportOptions extends Descriptors {
+    root: ImportPoint;
+    visitors: MdastImportVisitor<Mdast.RootContent>[];
+    mdastRoot: Mdast.Root;
+}
 
 export declare const MDX_FOCUS_SEARCH_NAME = "MdxFocusSearch";
 
@@ -2897,7 +2921,7 @@ export declare const switchFromPreviewToLinkEdit$: NodeRef<void>;
 
 /* Excluded from this release type: SyntaxExtension */
 
-export declare const syntaxExtensions$: NodeRef< Extension[]>;
+export declare const syntaxExtensions$: NodeRef< Extension_2[]>;
 
 /**
  * React Components registered to be rendered inside table cell editors. Use this instead of {@link addNestedEditorChild$} for components that should only appear in table cells.
@@ -2959,7 +2983,7 @@ export declare class TableNode extends DecoratorNode<JSX.Element> {
  * A plugin that adds support for tables to the editor.
  * @group Table
  */
-export declare const tablePlugin: (params?: Options_3 | undefined) => RealmPlugin;
+export declare const tablePlugin: (params?: Options_2 | undefined) => RealmPlugin;
 
 /**
  * Calls callback with the first argument, and returns it.
@@ -2987,12 +3011,15 @@ export declare function thrush<I, K>(arg: I, proc: (arg: I) => K): K;
 
 /* Excluded from this release type: ToggleSingleGroupWithItem */
 
-export declare type ToMarkdownExtension = NonNullable<ToMarkdownOptions['extensions']>[number];
+export declare interface ToMarkdownExtension extends ToMarkdownOptions {
+}
 
 /* Excluded from this release type: toMarkdownExtensions$ */
 
 /* Excluded from this release type: toMarkdownOptions$ */
-export { ToMarkdownOptions }
+
+export declare interface ToMarkdownOptions extends Options {
+}
 
 export declare const toolbarClassName$: NodeRef<string>;
 

package/package.json

@@ -11,7 +11,7 @@
     "*.css"
   ],
   "type": "module",
-  "version": "4.0.2",
+  "version": "4.0.4",
   "description": "React component for rich text markdown editing",
   "scripts": {
     "build": "vite build",
@@ -67,7 +67,7 @@
     "cm6-theme-basic-light": "^0.2.0",
     "codemirror": "^6.0.1",
     "downshift": "^7.6.0",
-    "js-yaml": "4.1.1",
+    "js-yaml": "4.2.0",
     "lexical": "^0.35.0",
     "mdast-util-directive": "^3.0.0",
     "mdast-util-from-markdown": "^2.0.0",