@readme/markdown 14.2.5 → 14.3.0

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

@@ -0,0 +1,27 @@
+import type { Root } from 'mdast';
+import type { Plugin } from 'unified';
+export type MdxishScope = Record<string, unknown>;
+declare module 'vfile' {
+    interface DataMap {
+        mdxishScope?: MdxishScope;
+    }
+}
+declare module 'hast' {
+    interface RootData {
+        mdxishScope?: MdxishScope;
+    }
+}
+/**
+ * Evaluate `export const/function` declarations introduced by mdxjsEsm nodes.
+ *
+ * Walks each mdxjsEsm node's estree to gather all export declarations while
+ * stripping the `export` statements. All declarations are then evaluated in a
+ * single sandboxed Function so that they can reference one another regardless
+ * of source order. Every resulting binding lands in a flat scope record —
+ * components, helpers, and plain values share the same map.
+ *
+ * Any evaluation error is consumed and logged. We don't throw because it's
+ * against the spirit of this engine to be less permissive than MDX needs.
+ */
+declare const evaluateExports: Plugin<[], Root>;
+export default evaluateExports;

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

@@ -3,9 +3,10 @@ import type { Plugin } from 'unified';
 /**
  * AST transformer to evaluate MDX expressions.
  * Replaces mdxFlowExpression and mdxTextExpression nodes with their evaluated values.
- * Runs with no scope, so only self-contained expressions resolve
- * (e.g. `{1+1}`, `{"hi".toUpperCase()}`); anything that references an external
- * identifier falls through to the error branch and is kept as literal `{...}` text.
+ * Self-contained expressions resolve directly (e.g. `{1+1}`); expressions that
+ * reference identifiers can resolve if those identifiers were introduced by an
+ * earlier `export const/function` (collected onto `file.data.mdxishScope`).
+ * Anything else falls through to the error branch and is kept as literal `{...}` text.
  */
 declare const evaluateExpressions: Plugin<[], Root>;
 export default evaluateExpressions;

package/dist/processor/utils.d.ts

@@ -2,11 +2,19 @@ import type { Root as HastRoot } from 'hast';
 import type { Node, Root as MdastRoot, Root } from 'mdast';
 import type { MdxJsxFlowElement, MdxJsxTextElement, MdxjsEsm } from 'mdast-util-mdx';
 import type { MdxJsxAttribute } from 'mdast-util-mdx-jsx';
+import { Parser } from 'acorn';
+/**
+ * Single instance of acorn parser extended with `acorn-jsx`
+ * to parse expressions containing JSX.
+ */
+export declare const jsxAcornParser: typeof Parser;
 /**
  * Evaluate a JavaScript expression source and return its value.
  *
  * Wrapping in parens lets object literals (`{color: 'red'}`) parse as
- * expressions. Runs with no scope, so only self-contained literals resolve.
+ * expressions. Pass `scope` to expose named bindings (e.g. values introduced
+ * by an `export const`) to the expression; without it, only self-contained
+ * literals resolve.
  *
  * > ☢️ **Danger**: this `eval`s JavaScript. Only call when safeMode is off —
  * > safeMode's contract is that expression syntax is never evaluated, and the
@@ -15,7 +23,7 @@ import type { MdxJsxAttribute } from 'mdast-util-mdx-jsx';
  *
  * Throws on parse/runtime error; callers decide the fallback.
  */
-export declare function evaluate(source: string): any;
+export declare function evaluate(source: string, scope?: Record<string, unknown>): any;
 /**
  * Formats the hProperties of a node as a string, so they can be compiled back into JSX/MDX.
  * This currently sets all the values to a string since we process/compile the MDX on the fly

package/package.json

@@ -2,7 +2,7 @@
   "name": "@readme/markdown",
   "description": "ReadMe's React-based Markdown parser",
   "author": "Rafe Goldberg <rafe@readme.io>",
-  "version": "14.2.5",
+  "version": "14.3.0",
   "main": "dist/main.node.js",
   "types": "dist/index.d.ts",
   "browser": "dist/main.js",
@@ -35,6 +35,8 @@
     "deepmerge": "^4.3.1",
     "emoji-regex": "^10.2.1",
     "entities": "^4.5.0",
+    "estree-util-build-jsx": "^3.0.1",
+    "estree-util-to-js": "^2.0.0",
     "estree-util-value-to-estree": "^3.1.1",
     "gemoji": "^8.1.0",
     "github-slugger": "^2.0.0",
@@ -50,11 +52,13 @@
     "mdast-util-gfm-strikethrough": "^2.0.0",
     "mdast-util-mdx": "^3.0.0",
     "mdast-util-mdx-expression": "2.0.0",
+    "mdast-util-mdxjs-esm": "^2.0.1",
     "mdast-util-phrasing": "^4.1.0",
     "mdast-util-to-markdown": "^2.1.2",
     "micromark-extension-gfm-strikethrough": "^2.1.0",
     "micromark-extension-mdx-expression": "^3.0.1",
     "micromark-extension-mdxjs": "^3.0.0",
+    "micromark-extension-mdxjs-esm": "^3.0.0",
     "micromark-util-character": "^2.1.1",
     "micromark-util-html-tag-name": "^2.0.1",
     "micromark-util-symbol": "^2.0.1",
@@ -91,6 +95,7 @@
     "@mdx-js/react": "^3.0.0",
     "@tippyjs/react": "^4.1.0",
     "acorn": "v8.13.0",
+    "acorn-jsx": "^5.3.2",
     "react": "18.x",
     "react-dom": "18.x"
   },
@@ -172,7 +177,7 @@
       },
       {
         "path": "dist/main.node.js",
-        "maxSize": "920KB"
+        "maxSize": "945KB"
       }
     ]
   },