@readme/markdown 11.10.1 → 11.12.0

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

@@ -1,6 +1,6 @@
-import type { JSXContext } from './preprocess-jsx-expressions';
 import type { Root } from 'mdast';
 import type { Plugin } from 'unified';
+import { type JSXContext } from './preprocess-jsx-expressions';
 /**
  * AST transformer to evaluate MDX expressions using the provided context.
  * Replaces mdxFlowExpression and mdxTextExpression nodes with their evaluated values.

package/dist/processor/transform/mdxish/mdxish-snake-case-components.d.ts

@@ -0,0 +1,16 @@
+export type SnakeCaseMapping = Record<string, string>;
+export interface SnakeCasePreprocessResult {
+    content: string;
+    mapping: SnakeCaseMapping;
+}
+/**
+ * Replaces snake_case component names with valid HTML placeholders.
+ * Required because remark-parse rejects tags with underscores.
+ * Example: `<Snake_case />` → `<MDXishSnakeCase0 />`
+ */
+export declare function processSnakeCaseComponent(content: string): SnakeCasePreprocessResult;
+/**
+ * Restores placeholder name to original snake_case name.
+ * Uses case-insensitive matching since HTML parsers normalize to lowercase.
+ */
+export declare function restoreSnakeCase(placeholderName: string, mapping: SnakeCaseMapping): string;

package/dist/processor/transform/mdxish/normalize-malformed-md-syntax.d.ts

@@ -0,0 +1,15 @@
+import type { Plugin } from 'unified';
+/**
+ * A remark plugin that normalizes malformed bold and italic markers in text nodes.
+ * Detects patterns like `** bold**`, `Hello** Wrong Bold**`, `__ bold__`, `Hello__ Wrong Bold__`,
+ * `* italic*`, `Hello* Wrong Italic*`, `_ italic_`, or `Hello_ Wrong Italic_`
+ * and converts them to proper strong/emphasis nodes, matching the behavior of the legacy rdmd engine.
+ *
+ * Supports both asterisk (`**bold**`, `*italic*`) and underscore (`__bold__`, `_italic_`) syntax.
+ * Also supports snake_case content like `** some_snake_case**`.
+ *
+ * This runs after remark-parse, which (in v11+) is strict and doesn't parse
+ * malformed emphasis syntax. This plugin post-processes the AST to handle these cases.
+ */
+declare const normalizeEmphasisAST: Plugin;
+export default normalizeEmphasisAST;

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

@@ -1,11 +1,25 @@
+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-->";
 /**
  * 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-->";
+/**
+ * Evaluates a JavaScript expression using context variables.
+ *
+ * @param expression
+ * @param context
+ * @returns The evaluated result
+ * @example
+ * ```typescript
+ * const context = { baseUrl: 'https://example.com', path: '/api' };
+ * evaluateExpression('baseUrl + path', context)
+ * // Returns: 'https://example.com/api'
+ * ```
+ */
+export declare function evaluateExpression(expression: string, context: JSXContext): any;
 /**
  * Preprocesses JSX-like expressions in markdown before parsing.
  * Inline expressions are handled separately; attribute expressions are processed here.

package/dist/processor/transform/mdxish/restore-snake-case-component-name.d.ts

@@ -0,0 +1,12 @@
+import type { SnakeCaseMapping } from './mdxish-snake-case-components';
+import type { Parent } from 'mdast';
+import type { Plugin } from 'unified';
+interface Options {
+    mapping: SnakeCaseMapping;
+}
+/**
+ * Restores snake_case component names from placeholders after parsing.
+ * Runs after mdxishComponentBlocks converts HTML nodes to mdxJsxFlowElement.
+ */
+declare const restoreSnakeCaseComponentNames: Plugin<[Options], Parent>;
+export default restoreSnakeCaseComponentNames;

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.10.1",
+  "version": "11.12.0",
   "main": "dist/main.node.js",
   "types": "dist/index.d.ts",
   "browser": "dist/main.js",