@readme/markdown 14.8.0 → 14.9.0

package/dist/processor/transform/mdxish/resolve-deferred-attribute-expression-props.d.ts

@@ -0,0 +1,16 @@
+import type { Root } from 'hast';
+import type { Plugin } from 'unified';
+/**
+ * Resolve attribute expressions that `mdxJsxElementHandler` deferred.
+ *
+ * The handler stashed each attribute expression's source in `node.data.deferredExpressions`
+ * (keyed by prop name) instead of evaluating eagerly, because an eager result can be a React
+ * element or function that rehypeRaw's `structuredClone` passthrough rejects. Now that we're
+ * past the clone, evaluate each source with a scope of `{ React, ...mdxishScope }` and write
+ * the real value into `properties` (e.g. an array of objects whose fields are React elements).
+ *
+ * Must run after `rehypeRaw` (past the clone) but before `normalizeMdxJsxNodes` rewrites these
+ * `mdx-jsx` nodes into plain elements. Skipped in safeMode, which keeps expressions literal.
+ */
+declare const resolveDeferredAttributeExpressionProps: Plugin<[], Root>;
+export default resolveDeferredAttributeExpressionProps;

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

package/types.d.ts

@@ -27,8 +27,17 @@ import type { Position } from 'unist';
  * attribute expressions evaluate to real JS values (objects, arrays, numbers)
  * which don't fit hast's HTML-attribute-oriented `PropertyValue` union.
  */
+export interface MdxJsxData {
+  /**
+   * Attribute expressions deferred by `mdxJsxElementHandler` (keyed by prop name) for
+   * `resolveDeferredAttributeExpressionProps` to evaluate past rehypeRaw's clone.
+   */
+  deferredExpressions?: Record<string, string>;
+}
+
 export interface MdxJsx {
   children: ElementContent[];
+  data?: MdxJsxData;
   position?: Position;
   properties: Properties;
   tagName: string;