@mdxeditor/editor 4.0.0 → 4.0.1

package/dist/index.d.ts

@@ -599,7 +599,8 @@ export declare const codeBlockPlugin: (params?: {
      */
     codeBlockEditorDescriptors?: CodeBlockEditorDescriptor[];
     /**
-     * The default language to use when creating a new code block if no language is passed.
+     * The default code block language. Used when inserting a new code block, and as a fallback at import time for
+     * fences whose language has no matching descriptor.
      */
     defaultCodeBlockLanguage?: string;
 } | undefined) => RealmPlugin;
@@ -846,7 +847,8 @@ export declare const debouncedIndexer$: NodeRef<TextNodeIndex>;
 export declare const DEFAULT_FORMAT: 0;
 
 /**
- * Contains the default language to use when creating a new code block if no language is passed.
+ * The default code block language. Used both when inserting a new code block without an explicit language, and as a
+ * fallback at import time when a fence's own language doesn't match any registered descriptor.
  * @group Code Block
  */
 export declare const defaultCodeBlockLanguage$: NodeRef<string>;
@@ -899,12 +901,16 @@ export declare const defaultSvgIcons: {
 };
 
 /**
- * The registered descriptors for composite nodes (jsx, directives, code blocks).
+ * Per-plugin import context passed to {@link MdastImportVisitor} functions.
  */
 export declare interface Descriptors {
     jsxComponentDescriptors: JsxComponentDescriptor[];
     directiveDescriptors: DirectiveDescriptor[];
     codeBlockEditorDescriptors: CodeBlockEditorDescriptor[];
+    /**
+     * The fallback language used to select a code block editor when a fenced code block's own language has no matching descriptor.
+     */
+    defaultCodeBlockLanguage?: string;
 }
 
 /**
@@ -2146,7 +2152,7 @@ export declare interface MdastImportVisitor<UN extends Mdast.Nodes> {
     /**
      * The test function that determines if this visitor should be used for the given node.
      * As a convenience, you can also pass a string here, which will be compared to the node's type.
-     * @param descriptors - the registered descriptors for composite nodes (jsx, directives, code blocks).
+     * @param descriptors - the registered descriptors and fallback values for composite nodes.
      */
     testNode: ((mdastNode: Mdast.Nodes, descriptors: Descriptors) => boolean) | string;
     visitNode(params: {

package/dist/index.js

@@ -4,7 +4,7 @@ import { MDXEditor } from "./MDXEditor.js";
 import { defaultSvgIcons } from "./defaultSvgIcons.js";
 import { MarkdownParseError, UnrecognizedMarkdownConstructError, importMarkdownToLexical, importMdastTreeToLexical } from "./importMarkdownToLexical.js";
 import { exportLexicalTreeToMdast, exportMarkdownFromLexical } from "./exportMarkdownFromLexical.js";
-import { Appender, NESTED_EDITOR_UPDATED_COMMAND, activeEditor$, activeEditorSubscriptions$, activePlugins$, addActivePlugin$, addBottomAreaChild$, addComposerChild$, addEditorWrapper$, addExportVisitor$, addImportVisitor$, addLexicalNode$, addMdastExtension$, addNestedEditorChild$, addSyntaxExtension$, addTableCellEditorChild$, addToMarkdownExtension$, addTopAreaChild$, applyBlockType$, applyFormat$, autoFocus$, bottomAreaChildren$, codeBlockEditorDescriptors$, composerChildren$, contentEditableClassName$, contentEditableRef$, contentEditableWrapperElement$, convertSelectionToNode$, corePlugin, createActiveEditorSubscription$, createRootEditorSubscription$, currentBlockType$, currentFormat$, currentSelection$, directiveDescriptors$, editorInFocus$, editorInTable$, editorRootElementRef$, editorWrapperElementRef$, editorWrappers$, exportVisitors$, historyState$, iconComponentFor$, importVisitors$, inFocus$, initialMarkdown$, initialMarkdownNormalize$, insertDecoratorNode$, insertMarkdown$, jsxComponentDescriptors$, jsxIsAvailable$, lexicalTheme$, markdown$, markdownErrorSignal$, markdownProcessingError$, markdownSourceEditorValue$, mdastExtensions$, muteChange$, nestedEditorChildren$, onBlur$, placeholder$, readOnly$, rootEditor$, rootEditorSubscriptions$, setMarkdown$, spellCheck$, syntaxExtensions$, tableCellEditorChildren$, toMarkdownExtensions$, toMarkdownOptions$, topAreaChildren$, translation$, useTranslation, usedLexicalNodes$, viewMode$ } from "./plugins/core/index.js";
+import { Appender, NESTED_EDITOR_UPDATED_COMMAND, activeEditor$, activeEditorSubscriptions$, activePlugins$, addActivePlugin$, addBottomAreaChild$, addComposerChild$, addEditorWrapper$, addExportVisitor$, addImportVisitor$, addLexicalNode$, addMdastExtension$, addNestedEditorChild$, addSyntaxExtension$, addTableCellEditorChild$, addToMarkdownExtension$, addTopAreaChild$, applyBlockType$, applyFormat$, autoFocus$, bottomAreaChildren$, codeBlockEditorDescriptors$, composerChildren$, contentEditableClassName$, contentEditableRef$, contentEditableWrapperElement$, convertSelectionToNode$, corePlugin, createActiveEditorSubscription$, createRootEditorSubscription$, currentBlockType$, currentFormat$, currentSelection$, defaultCodeBlockLanguage$, directiveDescriptors$, editorInFocus$, editorInTable$, editorRootElementRef$, editorWrapperElementRef$, editorWrappers$, exportVisitors$, historyState$, iconComponentFor$, importVisitors$, inFocus$, initialMarkdown$, initialMarkdownNormalize$, insertDecoratorNode$, insertMarkdown$, jsxComponentDescriptors$, jsxIsAvailable$, lexicalTheme$, markdown$, markdownErrorSignal$, markdownProcessingError$, markdownSourceEditorValue$, mdastExtensions$, muteChange$, nestedEditorChildren$, onBlur$, placeholder$, readOnly$, rootEditor$, rootEditorSubscriptions$, setMarkdown$, spellCheck$, syntaxExtensions$, tableCellEditorChildren$, toMarkdownExtensions$, toMarkdownOptions$, topAreaChildren$, translation$, useTranslation, usedLexicalNodes$, viewMode$ } from "./plugins/core/index.js";
 import { ALL_HEADING_LEVELS, allowedHeadingLevels$, headingsPlugin } from "./plugins/headings/index.js";
 import { insertThematicBreak$, thematicBreakPlugin } from "./plugins/thematic-break/index.js";
 import { applyListType$, currentListType$, listsPlugin } from "./plugins/lists/index.js";
@@ -18,7 +18,7 @@ import { insertJsx$, isMdastJsxNode, jsxPlugin } from "./plugins/jsx/index.js";
 import { GenericJsxEditor } from "./jsx-editors/GenericJsxEditor.js";
 import { EMPTY_VALUE, codeBlockLanguages$, codeMirrorAutoLoadLanguageSupport$, codeMirrorExtensions$, codeMirrorPlugin, getCodeBlockLanguageSelectData, insertCodeMirror$, normalizeCodeBlockLanguages } from "./plugins/codemirror/index.js";
 import { COMMON_STATE_CONFIG_EXTENSIONS, CodeMirrorEditor } from "./plugins/codemirror/CodeMirrorEditor.js";
-import { appendCodeBlockEditorDescriptor$, codeBlockPlugin, defaultCodeBlockLanguage$, insertCodeBlock$ } from "./plugins/codeblock/index.js";
+import { appendCodeBlockEditorDescriptor$, codeBlockPlugin, insertCodeBlock$ } from "./plugins/codeblock/index.js";
 import { directivesPlugin, insertDirective$ } from "./plugins/directives/index.js";
 import { ADMONITION_TYPES, AdmonitionDirectiveDescriptor } from "./directive-editors/AdmonitionDirectiveDescriptor.js";
 import { GenericDirectiveEditor } from "./directive-editors/GenericDirectiveEditor.js";

package/dist/plugins/codeblock/CodeBlockNode.js

@@ -7,9 +7,10 @@ var __publicField = (obj, key, value) => {
 import { useCellValue } from "@mdxeditor/gurx";
 import { DecoratorNode } from "lexical";
 import React__default from "react";
-import { defaultCodeBlockLanguage$ } from "./index.js";
+import "./index.js";
 import { voidEmitter } from "../../utils/voidEmitter.js";
-import { codeBlockEditorDescriptors$, NESTED_EDITOR_UPDATED_COMMAND } from "../core/index.js";
+import { codeBlockEditorDescriptors$, defaultCodeBlockLanguage$, NESTED_EDITOR_UPDATED_COMMAND } from "../core/index.js";
+import { findCodeBlockDescriptor } from "./findCodeBlockDescriptor.js";
 class CodeBlockNode extends DecoratorNode {
   constructor(code, language, meta, key) {
     super(key);
@@ -151,8 +152,7 @@ function useCodeBlockEditorContext() {
 const CodeBlockEditorContainer = (props) => {
   const codeBlockEditorDescriptors = useCellValue(codeBlockEditorDescriptors$);
   const defaultCodeBlockLanguage = useCellValue(defaultCodeBlockLanguage$);
-  let descriptor = codeBlockEditorDescriptors.sort((a, b) => b.priority - a.priority).find((descriptor2) => descriptor2.match(props.language || "", props.meta || ""));
-  descriptor ?? (descriptor = codeBlockEditorDescriptors.find((descriptor2) => descriptor2.match(defaultCodeBlockLanguage || "", props.meta || "")));
+  const descriptor = findCodeBlockDescriptor(codeBlockEditorDescriptors, props.language, props.meta, defaultCodeBlockLanguage);
   if (!descriptor) {
     throw new Error(`No CodeBlockEditor registered for language=${props.language} meta=${props.meta}`);
   }

package/dist/plugins/codeblock/MdastCodeVisitor.js

@@ -1,8 +1,9 @@
 import { $createCodeBlockNode } from "./CodeBlockNode.js";
+import { findCodeBlockDescriptor } from "./findCodeBlockDescriptor.js";
 const MdastCodeVisitor = {
-  testNode: (node, { codeBlockEditorDescriptors }) => {
+  testNode: (node, { codeBlockEditorDescriptors, defaultCodeBlockLanguage }) => {
     if (node.type === "code") {
-      const descriptor = codeBlockEditorDescriptors.find((descriptor2) => descriptor2.match(node.lang, node.meta));
+      const descriptor = findCodeBlockDescriptor(codeBlockEditorDescriptors, node.lang, node.meta, defaultCodeBlockLanguage);
       return descriptor !== void 0;
     }
     return false;

package/dist/plugins/codeblock/findCodeBlockDescriptor.js

@@ -0,0 +1,8 @@
+function findCodeBlockDescriptor(descriptors, language, meta, defaultLanguage) {
+  const sortedDescriptors = [...descriptors].sort((a, b) => b.priority - a.priority);
+  const resolvedMeta = meta ?? "";
+  return sortedDescriptors.find((descriptor) => descriptor.match(language ?? "", resolvedMeta)) ?? sortedDescriptors.find((descriptor) => descriptor.match(defaultLanguage ?? "", resolvedMeta));
+}
+export {
+  findCodeBlockDescriptor
+};

package/dist/plugins/codeblock/index.js

@@ -1,11 +1,10 @@
 import { CodeBlockVisitor } from "./CodeBlockVisitor.js";
 import { MdastCodeVisitor } from "./MdastCodeVisitor.js";
-import { Appender, insertDecoratorNode$, codeBlockEditorDescriptors$, addExportVisitor$, addLexicalNode$, addImportVisitor$, addActivePlugin$ } from "../core/index.js";
+import { Appender, defaultCodeBlockLanguage$, insertDecoratorNode$, codeBlockEditorDescriptors$, addExportVisitor$, addLexicalNode$, addImportVisitor$, addActivePlugin$ } from "../core/index.js";
 import { $createCodeBlockNode, CodeBlockNode } from "./CodeBlockNode.js";
 import { $convertPreElement, $isCodeBlockNode, useCodeBlockEditorContext } from "./CodeBlockNode.js";
-import { Cell, Signal, withLatestFrom, map } from "@mdxeditor/gurx";
+import { Signal, withLatestFrom, map } from "@mdxeditor/gurx";
 import { realmPlugin } from "../../RealmWithPlugins.js";
-const defaultCodeBlockLanguage$ = Cell("");
 const insertCodeBlock$ = Signal((r) => {
   r.link(
     r.pipe(
@@ -26,6 +25,7 @@ const codeBlockPlugin = realmPlugin({
   init(realm, params) {
     realm.pubIn({
       [addActivePlugin$]: "codeblock",
+      [defaultCodeBlockLanguage$]: (params == null ? void 0 : params.defaultCodeBlockLanguage) ?? "",
       [codeBlockEditorDescriptors$]: (params == null ? void 0 : params.codeBlockEditorDescriptors) ?? [],
       [addImportVisitor$]: MdastCodeVisitor,
       [addLexicalNode$]: CodeBlockNode,

package/dist/plugins/core/NestedLexicalEditor.js

@@ -1,6 +1,6 @@
 import { $addUpdateTag, $getNodeByKey, createEditor, $getRoot, FOCUS_COMMAND, COMMAND_PRIORITY_LOW, BLUR_COMMAND, COMMAND_PRIORITY_EDITOR, SELECTION_CHANGE_COMMAND, COMMAND_PRIORITY_HIGH, KEY_BACKSPACE_COMMAND, COMMAND_PRIORITY_CRITICAL } from "lexical";
 import React__default from "react";
-import { NESTED_EDITOR_UPDATED_COMMAND, rootEditor$, importVisitors$, exportVisitors$, usedLexicalNodes$, jsxComponentDescriptors$, directiveDescriptors$, codeBlockEditorDescriptors$, jsxIsAvailable$, nestedEditorChildren$, lexicalTheme$, editorInFocus$ } from "./index.js";
+import { NESTED_EDITOR_UPDATED_COMMAND, rootEditor$, importVisitors$, exportVisitors$, usedLexicalNodes$, jsxComponentDescriptors$, directiveDescriptors$, codeBlockEditorDescriptors$, defaultCodeBlockLanguage$, jsxIsAvailable$, nestedEditorChildren$, lexicalTheme$, editorInFocus$ } from "./index.js";
 import { ContentEditable } from "@lexical/react/LexicalContentEditable";
 import { LexicalErrorBoundary } from "@lexical/react/LexicalErrorBoundary";
 import { LexicalNestedComposer } from "@lexical/react/LexicalNestedComposer";
@@ -62,6 +62,7 @@ const NestedLexicalEditor = function(props) {
     jsxComponentDescriptors,
     directiveDescriptors,
     codeBlockEditorDescriptors,
+    defaultCodeBlockLanguage,
     jsxIsAvailable,
     nestedEditorChildren,
     lexicalTheme
@@ -73,6 +74,7 @@ const NestedLexicalEditor = function(props) {
     jsxComponentDescriptors$,
     directiveDescriptors$,
     codeBlockEditorDescriptors$,
+    defaultCodeBlockLanguage$,
     jsxIsAvailable$,
     nestedEditorChildren$,
     lexicalTheme$
@@ -111,6 +113,7 @@ const NestedLexicalEditor = function(props) {
         visitors: importVisitors,
         directiveDescriptors,
         codeBlockEditorDescriptors,
+        defaultCodeBlockLanguage,
         jsxComponentDescriptors
       });
     });

package/dist/plugins/core/index.js

@@ -113,6 +113,7 @@ const jsxIsAvailable$ = Cell(false);
 const jsxComponentDescriptors$ = Cell([]);
 const directiveDescriptors$ = Cell([]);
 const codeBlockEditorDescriptors$ = Cell([]);
+const defaultCodeBlockLanguage$ = Cell("");
 const editorRootElementRef$ = Cell(null);
 const editorWrapperElementRef$ = Cell(null);
 const contentEditableRef$ = Cell(null);
@@ -375,7 +376,8 @@ function tryImportingMarkdown(r, node, markdownValue) {
       syntaxExtensions: r.getValue(syntaxExtensions$),
       jsxComponentDescriptors: r.getValue(jsxComponentDescriptors$),
       directiveDescriptors: r.getValue(directiveDescriptors$),
-      codeBlockEditorDescriptors: r.getValue(codeBlockEditorDescriptors$)
+      codeBlockEditorDescriptors: r.getValue(codeBlockEditorDescriptors$),
+      defaultCodeBlockLanguage: r.getValue(defaultCodeBlockLanguage$)
     });
     r.pub(markdownProcessingError$, null);
   } catch (e) {
@@ -647,6 +649,7 @@ export {
   currentBlockType$,
   currentFormat$,
   currentSelection$,
+  defaultCodeBlockLanguage$,
   directiveDescriptors$,
   editorInFocus$,
   editorInTable$,

package/dist/plugins/table/TableEditor.js

@@ -15,7 +15,7 @@ import classNames from "classnames";
 import styles from "../../styles/ui.module.css.js";
 import { isPartOftheEditorUI } from "../../utils/isPartOftheEditorUI.js";
 import { uuidv4 } from "../../utils/uuid4.js";
-import { iconComponentFor$, readOnly$, useTranslation, editorRootElementRef$, importVisitors$, exportVisitors$, usedLexicalNodes$, jsxComponentDescriptors$, directiveDescriptors$, codeBlockEditorDescriptors$, jsxIsAvailable$, rootEditor$, tableCellEditorChildren$, NESTED_EDITOR_UPDATED_COMMAND } from "../core/index.js";
+import { iconComponentFor$, readOnly$, useTranslation, editorRootElementRef$, importVisitors$, exportVisitors$, usedLexicalNodes$, jsxComponentDescriptors$, directiveDescriptors$, codeBlockEditorDescriptors$, defaultCodeBlockLanguage$, jsxIsAvailable$, rootEditor$, tableCellEditorChildren$, NESTED_EDITOR_UPDATED_COMMAND } from "../core/index.js";
 import { useCellValues } from "@mdxeditor/gurx";
 const getCellType = (rowIndex) => {
   if (rowIndex === 0) {
@@ -215,6 +215,7 @@ const CellEditor = ({ focus, setActiveCell, parentEditor, lexicalTable, contents
     jsxComponentDescriptors,
     directiveDescriptors,
     codeBlockEditorDescriptors,
+    defaultCodeBlockLanguage,
     jsxIsAvailable,
     rootEditor,
     tableCellEditorChildren
@@ -225,6 +226,7 @@ const CellEditor = ({ focus, setActiveCell, parentEditor, lexicalTable, contents
     jsxComponentDescriptors$,
     directiveDescriptors$,
     codeBlockEditorDescriptors$,
+    defaultCodeBlockLanguage$,
     jsxIsAvailable$,
     rootEditor$,
     tableCellEditorChildren$
@@ -242,7 +244,8 @@ const CellEditor = ({ focus, setActiveCell, parentEditor, lexicalTable, contents
         visitors: importVisitors,
         jsxComponentDescriptors,
         directiveDescriptors,
-        codeBlockEditorDescriptors
+        codeBlockEditorDescriptors,
+        defaultCodeBlockLanguage
       });
     });
     return editor2;

package/package.json

@@ -11,7 +11,7 @@
     "*.css"
   ],
   "type": "module",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "description": "React component for rich text markdown editing",
   "scripts": {
     "build": "vite build",