@toaq-oss/omni-mdx 1.1.1 → 1.1.2

package/README.md

@@ -1,41 +1,69 @@
 # @toaq-oss/omni-mdx
 
+[![Build][build-badge]][build]
+[![Coverage][coverage-badge]][coverage]
+[![Downloads][downloads-badge]][downloads]
+[![Size][size-badge]][size]
+[![Chat][chat-badge]][chat]
+
 **The high-performance MDX engine.** A unified React & Next.js rendering layer powered by a dual Rust backend (Native Node.js + WebAssembly).
 
-[![GitHub](https://img.shields.io/badge/GitHub-TOAQ--oss-181717?logo=github)](https://github.com/toaq-oss)
-[![Documentation](https://img.shields.io/badge/Docs-omni--core.org-blue)](https://omni-core.org/mdx)
+---
+
+## Contents
+
+* [What is this?](#what-is-this)
+* [Why Omni-MDX?](#why-omni-mdx)
+* [Install](#install)
+* [Use](#use)
+  * [Server-Side Rendering (RSC)](#server-side-rendering-rsc)
+  * [Live Client Editor (WASM)](#live-client-editor-wasm)
+* [Monorepo Structure](#monorepo-structure)
+* [Next.js Configuration](#nextjs-configuration)
+* [Contributing](#contributing)
+* [License](#license)
 
 ---
 
-## ⚡ Why Omni-MDX?
+## What is this?
 
-Traditional MDX pipelines can be slow and often require heavy client-side hydration. `omni-mdx` offloads the heavy lifting to Rust while providing a **seamless bridge to the JS ecosystem**.
+`omni-mdx` is an ecosystem designed to overcome the performance bottlenecks of traditional MDX pipelines. Instead of relying on heavy JavaScript regular expressions, it utilizes a core written in **Rust** to transform MDX into a structured Abstract Syntax Tree (AST) nearly instantaneously.
 
-* 🚀 **Extreme Performance:** Parsing is done in native Rust (Server) or WASM (Client), up to 10x faster than pure JS alternatives.
+Whether you are building for the Web (Next.js, React), or the Server (Node.js), Omni-MDX provides a unified interface for smooth and precise rendering.
 
-* 🔌 **Unified/Rehype Bridge:** Native Rust core with full support for standard **Rehype plugins** (Highlighting, Slugs, Autolink, etc.).
+---
 
-* 📐 **Built-in Features:** GFM Tables, KaTeX math, and JSX components are handled natively—no extra configuration required.
+## Why Omni-MDX?
 
-* ⚛️ ***RSC Optimized:*** Built for Next.js App Router and Server Components with zero-hydration math rendering.
+* 🚀 **Extreme Performance:** Parsing is offloaded to Rust, performing up to 10x faster than pure JS alternatives.
+* 🔌 **Unified/Rehype Bridge:** Native Rust core with full support for standard **Rehype plugins** (Highlighting, Slugs, Autolink, etc.).
+* 📐 **Built-in Features:** GFM Tables, KaTeX math, and JSX components handled natively—no extra configuration required.
+* ⚛️ **RSC Optimized:** Built for Next.js App Router and Server Components with zero-hydration math rendering.
 * 🧵 **Non-Blocking:** Offloads parsing from the Node.js main thread, keeping your server responsive.
 
 ---
 
-## 🚀 Usage
-### 1. Server-Side Rendering (RSC) with Plugins
-Recommended for documentation, blogs, and research papers.
+## Install
+
+This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c). In Node.js, install with [npm]:
+
+```bash
+npm install @toaq-oss/omni-mdx
+# Required for math styles
+npm install katex
+```
 
-*Plugins are optional. Omni-Core lets you choose whether to use plugins or not !*
+---
+
+## Use
 
-> Full example available here :
-> * Basic setup: [TOAQ-oss/omni-core-sandox](https://github.com/TOAQ-oss/omni-mdx-sandbox/tree/main/next/basic-setup)
-> * Advanced rendering : [TOAQ-oss/omni-core-sandox](https://github.com/TOAQ-oss/omni-mdx-sandbox/tree/main/next/advanced-rendering)
+### Server-Side Rendering (RSC)
+
+Recommended for documentation, blogs, and research papers.
 
 ```tsx
 import { parseMdx, MDXServerRenderer } from "@toaq-oss/omni-mdx/server";
 import rehypeHighlight from "rehype-highlight";
-import { MyComponent } from "@/components/mdx";
 
 export default async function Page({ content }) {
   // 1. Parse via Native Rust Addon (.node)
@@ -52,10 +80,9 @@ export default async function Page({ content }) {
 }
 ```
 
-###  2. Live Client Editor (WASM)
-Perfect for real-time previews or CMS interfaces.
+### Live Client Editor (WASM)
 
-> Full example available here : [TOAQ-oss/omni-core-sandox](https://github.com/TOAQ-oss/omni-mdx-sandbox/tree/main/next/client-rendering)
+Perfect for real-time previews or CMS interfaces.
 
 ```tsx
 "use client";
@@ -80,16 +107,23 @@ export default function Editor() {
 }
 ```
 
-## 📦 Installation
+---
 
-```bash
-npm install @toaq-oss/omni-mdx
-# Required for math styles
-npm install katex
-```
+## Monorepo Structure
+
+This repository houses the various components of the ecosystem:
+
+| Package | Language | Description |
+| :--- | :---: | :--- |
+| [**`core-parser`**](./packages/core-parser) | ![Rust] | The high-performance parsing core. |
+| [**`mdx-next`**](./packages/mdx-next) | ![TypeScript] | React/Next.js layer (Native + WASM). |
+
+---
 
 ## Next.js Configuration
+
 To enable the WebAssembly engine for client-side rendering, update your `next.config.js`:
+
 ```typescript
 /** @type {import('next').NextConfig} */
 const nextConfig = {
@@ -108,34 +142,41 @@ export default nextConfig;
 
 ---
 
-## 🧩 Features
-### 🔌 Extensibility (Rehype Support)
-Omni-MDX uses a unique "Bridge" architecture. It parses Markdown to a high-performance AST in Rust, then optionally passes it through the Unified/Rehype pipeline in JS for transformations.
-* **Support:** `rehype-slug`, `rehype-highlight`, `rehype-autolink-headings`, etc.
-* **Performance:** Plugins only run on the final tree, keeping the heavy parsing phase in Rust.
+## Contributing
 
-### 📐 Native Professional Math
-Math is handled via KaTeX. Include the CSS in your `layout.tsx`:
-`import "katex/dist/katex.min.css";`
-* **Inline:** `$E=mc^2$`
-* **Block:** `$$\zeta(s) = \sum_{1}^{\infty} n^{-s}$$`
+We enthusiastically welcome contributions! Omni-MDX is a sophisticated project blending Rust, C++, TypeScript, and Python.
 
-### 🎨 Hybrid Components
-Mix standard HTML tags with custom React components. Omni-MDX preserves props and nested children perfectly between the Rust parser and your React tree.
+1. **Clone the repository:**
+   ```bash
+   git clone https://github.com/TOAQ-oss/omni-mdx-core.git
+   ```
+2. **Check the contribution guide:** [CONTRIBUTING.md](./CONTRIBUTING.md) to learn how to set up your local development environment.
 
 ---
-## 📖 Documentation & Support
 
-Full guides and API references: **[omni-core.org/mdx](https://omni-core.org/mdx)**
+## License
 
-|Environment|Backend|Entry Point|
-|:---|:---|:---|
-|**Server** (Node.js)|Native Addon (`.node`)|`@toaq-oss/omni-mdx/server`|
-|**Client** (Browser)|WebAssembly (`.wasm`)|`@toaq-oss/omni-mdx/client`|
-|**Edge** (Vercel)|Native Addon (`.wasm`)|`@toaq-oss/omni-mdx/client`|
+[MIT][license] © [TOAQ-oss][author-url]
 
 ---
-## 🤝 Contributing
-This package is part of the TOAQ open-source ecosystem.
-* **Core Parser (Rust):** [TOAQ-oss/omni-mdx-core](https://github.com/TOAQ-oss/omni-mdx-core)
-* **Reporting Issues:** Please use the GitHub issue tracker for bugs or feature requests.
+
+[build-badge]: https://github.com/TOAQ-oss/omni-mdx-core/actions/workflows/publish-next.yml/badge.svg
+[build]: https://github.com/TOAQ-oss/omni-mdx-core/actions
+
+[coverage-badge]: https://img.shields.io/codecov/c/github/TOAQ-oss/omni-mdx-core/main.svg?flag=npm&logo=codecov
+[coverage]: https://codecov.io/github/TOAQ-oss/omni-mdx-core
+
+[downloads-badge]: https://img.shields.io/npm/dm/@toaq-oss/omni-mdx.svg?style=flat-square&color=blue
+[downloads]: https://www.npmjs.com/package/@toaq-oss/omni-mdx
+
+[size-badge]: https://img.shields.io/bundlejs/size/@toaq-oss/omni-mdx?color=brightgreen
+[size]: https://bundlejs.com/?q=@toaq-oss/omni-mdx
+
+[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg?logo=github
+[chat]: https://github.com/TOAQ-oss/omni-mdx-core/discussions
+
+[license]: https://github.com/TOAQ-oss/omni-mdx-core/blob/main/LICENSE
+[author-url]: https://github.com/toaq-oss
+
+[Rust]: https://img.shields.io/badge/rust-000000?logo=rust
+[TypeScript]: https://img.shields.io/badge/typescript-3178C6?logo=typescript

package/dist/client.cjs

@@ -109,7 +109,7 @@ function parse_to_binary(mdx_input) {
 function __wbg_get_imports() {
   const import0 = {
     __proto__: null,
-    __wbg_Error_83742b46f01ce22d: function(arg0, arg1) {
+    __wbg_Error_960c155d3d49e4c2: function(arg0, arg1) {
       const ret = Error(getStringFromWasm0(arg0, arg1));
       return ret;
     },
@@ -310,6 +310,7 @@ module.exports = __toCommonJS(client_exports);
 // src/MDXClientRenderer.tsx
 var import_react2 = __toESM(require("react"), 1);
 var import_katex = __toESM(require("katex"), 1);
+var import_json5 = __toESM(require("json5"), 1);
 
 // src/MDXErrorBoundary.tsx
 var import_react = require("react");
@@ -384,7 +385,7 @@ var BASIC_STYLES = {
   table: (props) => /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("div", { className: "overflow-x-auto mb-6", children: /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("table", { className: "w-full text-sm text-left border-collapse", ...props }) }),
   th: (props) => /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("th", { className: "border-b border-white/10 p-2 font-semibold text-neutral-200", ...props }),
   td: (props) => /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("td", { className: "border-b border-white/5 p-2 text-neutral-400", ...props }),
-  img: (props) => /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("img", { className: "rounded-xl border border-white/10 my-8 mx-auto max-w-full h-auto", ...props }),
+  img: ({ children, ...props }) => /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("img", { className: "rounded-xl border border-white/10 my-8 mx-auto max-w-full h-auto", ...props }),
   a: (props) => /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("a", { className: "text-blue-400 hover:text-blue-300 underline underline-offset-4 decoration-blue-500/30 transition-colors", ...props })
 };
 
@@ -403,7 +404,7 @@ function resolveAttr(attr, components) {
       } catch {
       }
       try {
-        return new Function(`return (${raw})`)();
+        return import_json5.default.parse(raw);
       } catch {
       }
       return raw;
@@ -488,27 +489,77 @@ function renderNode(node, index, components) {
   if (node.node_type === "fragment") {
     return /* @__PURE__ */ (0, import_jsx_runtime3.jsx)(import_react2.default.Fragment, { children: node.children?.map((c, i) => renderNode(c, i, components)) }, key);
   }
+  const getMathFormula = (node2) => {
+    let formula = "";
+    if (node2.attributes) {
+      const attrs = typeof node2.attributes === "string" ? JSON.parse(node2.attributes) : node2.attributes;
+      const mathData = attrs?.["data-math"];
+      if (mathData && mathData.value) {
+        formula = String(mathData.value);
+      }
+    }
+    if (!formula) {
+      formula = extractText(node2);
+    }
+    return formula;
+  };
   if (node.node_type === "InlineMath") {
-    const formula = extractText(node);
+    const formula = getMathFormula(node);
     try {
-      const html = import_katex.default.renderToString(formula, { displayMode: false, throwOnError: false, output: "html" });
-      return /* @__PURE__ */ (0, import_jsx_runtime3.jsx)("span", { className: "math math-inline", dangerouslySetInnerHTML: { __html: html } }, key);
+      const html = import_katex.default.renderToString(formula, {
+        displayMode: false,
+        throwOnError: false,
+        output: "html"
+      });
+      return /* @__PURE__ */ (0, import_jsx_runtime3.jsx)(
+        "span",
+        {
+          className: "math math-inline",
+          dangerouslySetInnerHTML: { __html: html }
+        },
+        key
+      );
     } catch {
       return /* @__PURE__ */ (0, import_jsx_runtime3.jsx)("span", { className: "math math-inline", children: formula }, key);
     }
   }
-  if (node.node_type === "BlockMath") {
-    const formula = extractText(node);
+  if (node.node_type === "BlockMath" || node.node_type === "math") {
+    const formula = getMathFormula(node);
     try {
-      const html = import_katex.default.renderToString(formula, { displayMode: true, throwOnError: false, output: "html" });
-      return /* @__PURE__ */ (0, import_jsx_runtime3.jsx)("div", { className: "math math-display", dangerouslySetInnerHTML: { __html: html } }, key);
+      const html = import_katex.default.renderToString(formula, {
+        displayMode: true,
+        throwOnError: false,
+        output: "html"
+      });
+      return /* @__PURE__ */ (0, import_jsx_runtime3.jsx)(
+        "div",
+        {
+          className: "math math-display",
+          dangerouslySetInnerHTML: { __html: html }
+        },
+        key
+      );
     } catch {
       return /* @__PURE__ */ (0, import_jsx_runtime3.jsx)("div", { className: "math math-display", children: formula }, key);
     }
   }
   const resolvedProps = {};
   if (node.attributes) {
-    const attrs = typeof node.attributes === "string" ? JSON.parse(node.attributes) : node.attributes;
+    let attrs = {};
+    if (typeof node.attributes === "string") {
+      try {
+        attrs = JSON.parse(node.attributes);
+      } catch (error) {
+        if (true) {
+          console.warn(
+            `[toaq-oss/omni-mdx] Failed to parse attributes JSON for <${node.node_type}>`,
+            error
+          );
+        }
+      }
+    } else {
+      attrs = node.attributes;
+    }
     for (const [k, v] of Object.entries(attrs)) {
       resolvedProps[k] = resolveAttr(v, components);
     }
@@ -537,7 +588,6 @@ function MDXClientRenderer({
   ast,
   components = {}
 }) {
-  const rootRef = (0, import_react2.useRef)(null);
   if (!ast || !Array.isArray(ast)) return null;
   const finalComponents = {
     ...BASIC_STYLES,
@@ -670,6 +720,9 @@ var MdxBinaryDecoder = class {
    */
   readStringU16() {
     const len = this.readU16();
+    if (this.offset + len > this.buffer.byteLength) {
+      throw new Error(`Binary corruption: string (u16) out of bounds at offset ${this.offset}`);
+    }
     const str = this.decoder.decode(this.buffer.subarray(this.offset, this.offset + len));
     this.offset += len;
     let cached = this.stringCache.get(str);
@@ -684,6 +737,9 @@ var MdxBinaryDecoder = class {
    */
   readStringU32() {
     const len = this.readU32();
+    if (this.offset + len > this.buffer.byteLength) {
+      throw new Error(`Binary corruption: string (u32) out of bounds at offset ${this.offset}`);
+    }
     const str = this.decoder.decode(this.buffer.subarray(this.offset, this.offset + len));
     this.offset += len;
     return str;
@@ -818,7 +874,7 @@ function getClientParser() {
       const wasm2 = await Promise.resolve().then(() => (init_omni_mdx_core(), omni_mdx_core_exports));
       if (typeof wasm2.default === "function") {
         const wasmUrl = new URL("./omni_mdx_core_bg.wasm", import_meta2.url);
-        await wasm2.default(wasmUrl);
+        await wasm2.default({ module_or_path: wasmUrl });
       }
       return (mdx) => wasm2.parse_to_binary(mdx);
     })();