@readme/markdown 11.7.7 → 11.8.0

package/dist/processor/plugin/mdxish-components.d.ts

@@ -0,0 +1,19 @@
+import type { CustomComponents } from '../../types';
+import type { Root } from 'hast';
+import type { Transformer } from 'unified';
+interface Options {
+    components: CustomComponents;
+    processMarkdown: (markdownContent: string) => Root;
+}
+/**
+ * Identifies custom MDX components and recursively parses markdown children.
+ * Replaces tagName with PascalCase component name for React component resolution.
+ *
+ * @see {@link https://github.com/readmeio/rmdx/blob/main/docs/mdxish-flow.md}
+ * @param {Options} options - Configuration options
+ * @param {CustomComponents} options.components - Available custom components
+ * @param {Function} options.processMarkdown - Function to process markdown content
+ * @returns {Transformer<Root, Root>} The transformer function
+ */
+export declare const rehypeMdxishComponents: ({ components, processMarkdown }: Options) => Transformer<Root, Root>;
+export {};

package/dist/processor/plugin/mdxish-handlers.d.ts

@@ -0,0 +1,2 @@
+import type { Handlers } from 'mdast-util-to-hast';
+export declare const mdxComponentHandlers: Handlers;

package/dist/processor/plugin/toc.d.ts

@@ -1,9 +1,15 @@
-import type { CustomComponents, IndexableElements, RMDXModule } from '../../types';
+import type { CustomComponents, HastHeading, IndexableElements, RMDXModule, TocList } from '../../types';
 import type { Root } from 'hast';
 import type { Transformer } from 'unified';
 interface Options {
     components?: CustomComponents;
 }
+/** Extract all heading elements (h1-h6) from a HAST tree, excluding those inside custom components
+ * Used to generate toc for mdxish
+ */
+export declare function extractToc(tree: Root, components?: CustomComponents): HastHeading[];
+/** A rehype plugin to generate a flat list of top-level headings or jsx flow elements. */
 export declare const rehypeToc: ({ components }: Options) => Transformer<Root, Root>;
+export declare const tocToHast: (headings?: HastHeading[]) => TocList;
 export declare const tocHastToMdx: (toc: IndexableElements[] | undefined, components: Record<string, RMDXModule["toc"]>) => string;
 export {};

package/dist/processor/transform/images.d.ts

@@ -1,3 +1,5 @@
 import type { Node } from 'mdast';
-declare const imageTransformer: () => (tree: Node) => Node;
+declare const imageTransformer: ({ isMdxish }?: {
+    isMdxish?: boolean;
+}) => (tree: Node) => Node;
 export default imageTransformer;

package/dist/processor/transform/index.d.ts

@@ -3,6 +3,7 @@ import divTransformer from './div';
 import handleMissingComponents from './handle-missing-components';
 import injectComponents from './inject-components';
 import mdxToHast from './mdx-to-hast';
+import mdxishTables from './mdxish/mdxish-tables';
 import mermaidTransformer from './mermaid';
 import readmeComponentsTransformer from './readme-components';
 import readmeToMdx from './readme-to-mdx';
@@ -10,17 +11,26 @@ import tablesToJsx from './tables-to-jsx';
 import tailwindTransformer from './tailwind';
 import validateMCPIntro from './validate-mcpintro';
 import variablesTransformer from './variables';
-export { compatabilityTransfomer, divTransformer, injectComponents, mdxToHast, mermaidTransformer, readmeComponentsTransformer, readmeToMdx, tablesToJsx, tailwindTransformer, handleMissingComponents, validateMCPIntro, variablesTransformer, };
+export { compatabilityTransfomer, divTransformer, injectComponents, mdxToHast, mdxishTables, mermaidTransformer, readmeComponentsTransformer, readmeToMdx, tablesToJsx, tailwindTransformer, handleMissingComponents, validateMCPIntro, variablesTransformer, };
 export declare const defaultTransforms: {
     calloutTransformer: () => (tree: import("mdast").Root) => void;
     codeTabsTransformer: ({ copyButtons }?: {
         copyButtons?: boolean;
     }) => (tree: import("mdast").Node) => import("mdast").Node;
     embedTransformer: () => (tree: import("mdast").Node) => void;
-    imageTransformer: () => (tree: import("mdast").Node) => import("mdast").Node;
+    imageTransformer: ({ isMdxish }?: {
+        isMdxish?: boolean;
+    }) => (tree: import("mdast").Node) => import("mdast").Node;
     gemojiTransformer: () => (tree: import("mdast").Root) => import("mdast").Root;
 };
+export declare const mdxishTransformers: ((() => (tree: import("mdast").Root) => void) | (({ copyButtons }?: {
+    copyButtons?: boolean;
+}) => (tree: import("mdast").Node) => import("mdast").Node) | (({ isMdxish }?: {
+    isMdxish?: boolean;
+}) => (tree: import("mdast").Node) => import("mdast").Node))[];
 declare const _default: ((() => (tree: import("mdast").Root) => void) | (({ copyButtons }?: {
     copyButtons?: boolean;
-}) => (tree: import("mdast").Node) => import("mdast").Node) | (() => (tree: import("mdast").Node) => void) | (() => (tree: import("mdast").Root) => import("mdast").Root) | (() => (tree: import("mdast").Node) => import("mdast").Node))[];
+}) => (tree: import("mdast").Node) => import("mdast").Node) | (() => (tree: import("mdast").Node) => void) | (() => (tree: import("mdast").Root) => import("mdast").Root) | (({ isMdxish }?: {
+    isMdxish?: boolean;
+}) => (tree: import("mdast").Node) => import("mdast").Node))[];
 export default _default;

package/dist/processor/transform/mdxish/evaluate-expressions.d.ts

@@ -0,0 +1,11 @@
+import type { JSXContext } from './preprocess-jsx-expressions';
+import type { Root } from 'mdast';
+import type { Plugin } from 'unified';
+/**
+ * AST transformer to evaluate MDX expressions using the provided context.
+ * Replaces mdxFlowExpression and mdxTextExpression nodes with their evaluated values.
+ */
+declare const evaluateExpressions: Plugin<[{
+    context?: JSXContext;
+}], Root>;
+export default evaluateExpressions;

package/dist/processor/transform/mdxish/mdxish-component-blocks.d.ts

@@ -0,0 +1,6 @@
+import type { Parent } from 'mdast';
+import type { MdxJsxAttribute } from 'mdast-util-mdx-jsx';
+import type { Plugin } from 'unified';
+export declare const parseAttributes: (raw: string) => MdxJsxAttribute[];
+declare const mdxishComponentBlocks: Plugin<[], Parent>;
+export default mdxishComponentBlocks;

package/dist/processor/transform/mdxish/mdxish-html-blocks.d.ts

@@ -0,0 +1,6 @@
+import type { Transform } from 'mdast-util-from-markdown';
+/**
+ * Transforms HTMLBlock MDX JSX to html-block nodes. Handles <HTMLBlock>{`...`}</HTMLBlock> syntax.
+ */
+declare const mdxishHtmlBlocks: () => Transform;
+export default mdxishHtmlBlocks;

package/dist/processor/transform/mdxish/mdxish-magic-blocks.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Legacy magic block parser for RDMD compatibility.
+ * Parses `[block:TYPE]JSON[/block]` syntax and returns MDAST nodes.
+ * Taken from the v6 branch with some modifications to be more type safe
+ * and adapted with the mdxish flow.
+ */
+import type { BlockHit } from '../../../lib/utils/extractMagicBlocks';
+import type { Root as MdastRoot } from 'mdast';
+import type { Plugin } from 'unified';
+export interface ParseMagicBlockOptions {
+    alwaysThrow?: boolean;
+    compatibilityMode?: boolean;
+    safeMode?: boolean;
+}
+/**
+ * Unified plugin that restores magic blocks from placeholder tokens.
+ *
+ * During preprocessing, extractMagicBlocks replaces [block:TYPE]...[/block]
+ * with inline code tokens like `__MAGIC_BLOCK_0__`. This plugin finds those
+ * tokens in the parsed MDAST and replaces them with the parsed block content.
+ */
+declare const magicBlockRestorer: Plugin<[{
+    blocks: BlockHit[];
+}], MdastRoot>;
+export default magicBlockRestorer;

package/dist/processor/transform/mdxish/mdxish-tables.d.ts

@@ -0,0 +1,9 @@
+import type { Transform } from 'mdast-util-from-markdown';
+/**
+ * Converts JSX Table elements to markdown table nodes and re-parses markdown in cells.
+ *
+ * Since mdxish doesn't use remarkMdx, we manually parse cell contents through
+ * remarkParse and remarkGfm to convert markdown to MDAST nodes.
+ */
+declare const mdxishTables: () => Transform;
+export default mdxishTables;

package/dist/processor/transform/mdxish/preprocess-jsx-expressions.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Pre-processes JSX-like expressions before markdown parsing.
+ * Converts href={'value'} to href="value", evaluates {expressions}, etc.
+ */
+export type JSXContext = Record<string, unknown>;
+export declare function base64Decode(str: string): string;
+export declare const HTML_BLOCK_CONTENT_START = "<!--RDMX_HTMLBLOCK:";
+export declare const HTML_BLOCK_CONTENT_END = ":RDMX_HTMLBLOCK-->";
+/**
+ * Preprocesses JSX-like expressions in markdown before parsing.
+ * Inline expressions are handled separately; attribute expressions are processed here.
+ *
+ * @param content
+ * @param context
+ * @returns Preprocessed content ready for markdown parsing
+ */
+export declare function preprocessJSXExpressions(content: string, context?: JSXContext): string;

package/dist/processor/transform/mdxish/variables-text.d.ts

@@ -0,0 +1,9 @@
+import type { Plugin } from 'unified';
+/**
+ * A remark plugin that parses {user.<field>} patterns from text nodes
+ * without requiring remarkMdx. Creates Variable nodes for runtime resolution.
+ *
+ * Supports any user field: name, email, email_verified, exp, iat, etc.
+ */
+declare const variablesTextTransformer: Plugin;
+export default variablesTextTransformer;

package/dist/processor/utils.d.ts

@@ -67,6 +67,14 @@ export declare const isMDXElement: (node: Node) => node is MdxJsxFlowElement | M
  * @returns {boolean}
  */
 export declare const isMDXEsm: (node: Node) => node is MdxjsEsm;
+/**
+ * Takes an HTML string and formats it for display in the editor. Removes leading/trailing newlines
+ * and unindents the HTML.
+ *
+ * @param {string} html - HTML content from template literal
+ * @returns {string} processed HTML
+ */
+export declare function formatHtmlForMdxish(html: string): string;
 /**
  * Takes an HTML string and formats it for display in the editor. Removes leading/trailing newlines
  * and unindents the HTML.

package/dist/utils/common-html-words.d.ts

@@ -0,0 +1,23 @@
+/**
+ * React HTML element props word boundaries (e.g., "on", "data", "aria", "accept", "auto")
+ * Extracted from react-html-attributes package
+ */
+export declare const REACT_HTML_PROP_BOUNDARIES: string[];
+/**
+ * CSS style property word boundaries (e.g., "border", "margin", "padding", "flex", "align")
+ * Extracted from react-native-known-styling-properties package
+ */
+export declare const CSS_STYLE_PROP_BOUNDARIES: string[];
+/**
+ * Custom component prop word boundaries not in React HTML or CSS boundaries.
+ */
+export declare const CUSTOM_PROP_BOUNDARIES: string[];
+/**
+ * Tags that should be passed through and handled at runtime (not by the mdxish plugin)
+ */
+export declare const RUNTIME_COMPONENT_TAGS: Set<string>;
+/**
+ * Standard HTML tags that should never be treated as custom components.
+ * Uses the html-tags package, converted to a Set<string> for efficient lookups.
+ */
+export declare const STANDARD_HTML_TAGS: Set<string>;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@readme/markdown",
   "description": "ReadMe's React-based Markdown parser",
   "author": "Rafe Goldberg <rafe@readme.io>",
-  "version": "11.7.7",
+  "version": "11.8.0",
   "main": "dist/main.node.js",
   "types": "dist/index.d.ts",
   "browser": "dist/main.js",
@@ -37,19 +37,26 @@
     "hast-util-from-html": "^2.0.1",
     "hast-util-sanitize": "^4.0.0",
     "hastscript": "^9.0.0",
+    "html-tags": "^5.1.0",
     "lodash.escape": "^4.0.1",
     "lodash.kebabcase": "^4.1.1",
     "mdast-util-find-and-replace": "^3.0.1",
+    "mdast-util-mdx-expression": "^2.0.1",
     "mdast-util-phrasing": "^4.1.0",
     "mdast-util-to-markdown": "^2.1.2",
+    "micromark-extension-mdx-expression": "^3.0.1",
     "path-browserify": "^1.0.1",
     "postcss": "^8.5.1",
     "postcss-prefix-selector": "^2.1.0",
     "process": "^0.11.10",
+    "react-html-attributes": "^1.4.6",
+    "react-native-known-styling-properties": "^1.3.0",
     "rehype-raw": "^7.0.0",
+    "rehype-react": "^6.2.1",
     "rehype-remark": "^10.0.0",
     "rehype-sanitize": "^6.0.0",
     "rehype-slug": "^6.0.0",
+    "rehype-stringify": "^10.0.1",
     "remark": "^15.0.1",
     "remark-frontmatter": "^5.0.0",
     "remark-gfm": "^4.0.0",
@@ -149,7 +156,7 @@
       },
       {
         "path": "dist/main.node.js",
-        "maxSize": "750KB"
+        "maxSize": "780KB"
       }
     ]
   },