@illusions-lab/mdi 2.0.3

package/README.md

@@ -0,0 +1,83 @@
+# `@illusions-lab/mdi`
+
+The JavaScript interface to the Rust-authoritative MDI engine. Give it a
+complete `.mdi` source document and it returns the versioned document IR and
+diagnostics produced by `mdi-core`.
+
+```ts
+import { parse } from "@illusions-lab/mdi";
+
+const result = parse(`---
+title: 短篇
+---
+
+# 第一章
+
+第^12^話に[[em:傍点]]を付ける。`);
+
+console.log(result.document);
+console.log(result.diagnostics);
+```
+
+## What the binding does
+
+The package has deliberately narrow responsibilities:
+
+1. accept JavaScript strings, byte arrays, and options;
+2. call `mdi-core` through the generated Rust binding;
+3. check the returned IR schema version;
+4. expose typed JavaScript objects, diagnostics, and renderer results.
+
+It does not tokenize Markdown or MDI, repair malformed syntax, reinterpret
+source spans, or maintain a JavaScript copy of the grammar. CommonMark, GFM,
+front matter, MDI extensions, escapes, nesting, literal fallback, and all
+syntax validation are decided by Rust.
+
+```text
+complete source
+      ↓
+JavaScript binding
+      ↓
+mdi-core parser
+      ↓
+versioned document IR + diagnostics
+```
+
+## Parse result
+
+Every result carries the syntax version and IR schema version alongside the
+document. Source-backed nodes use half-open UTF-8 byte spans. Recoverable
+problems are returned as ordered diagnostics with stable codes, severity,
+messages, and source spans.
+
+Applications should treat the IR version as a wire-protocol version. They
+must not infer grammar rules from object shapes or silently accept an
+unsupported version.
+
+## Rendering
+
+Rendering starts from the same Rust IR. Canonical MDI, plain text, HTML, EPUB,
+and DOCX renderers execute in Rust and are exposed through this package. PDF
+uses Rust HTML as its input to a host layout adapter such as
+`@illusions-lab/mdi-to-pdf`; the adapter may control Chromium, but it never
+parses MDI or produces semantic HTML.
+
+Browser WebAssembly cannot start Chromium. Browser code sends Rust-rendered
+HTML to a server or desktop host when it needs PDF output.
+
+## Remark compatibility
+
+Remark support is an optional adapter between Rust IR and mdast. It exists for
+applications that need unified plugins:
+
+```text
+source → mdi-core → Rust IR ⇄ mdast → unified plugins
+```
+
+The adapter contains no tokenizer, grammar, or syntax fallback. When an mdast
+pipeline needs MDI output, it is converted back to Rust IR and Rust performs
+validation and serialization.
+
+The normative human-readable syntax is defined in
+[`SYNTAX.md`](https://github.com/illusions-lab/MDI/blob/main/SYNTAX.md). The
+executable syntax authority is `mdi-core`.

package/dist/index.cjs

@@ -0,0 +1,85 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  MDI_IR_VERSION: () => MDI_IR_VERSION,
+  MDI_SPEC_VERSION: () => MDI_SPEC_VERSION,
+  parse: () => parse,
+  parseMdiSyntax: () => parseMdiSyntax,
+  renderDocx: () => renderDocx,
+  renderEpub: () => renderEpub,
+  renderHtml: () => renderHtml,
+  renderText: () => renderText,
+  renderTextFormat: () => renderTextFormat,
+  serializeMdi: () => serializeMdi
+});
+module.exports = __toCommonJS(index_exports);
+var import_mdi_core = require("@illusions-lab/mdi-core");
+var MDI_SPEC_VERSION = "2.0";
+var MDI_IR_VERSION = "1.0";
+function parse(source) {
+  if (typeof source !== "string") throw new TypeError("source must be a string");
+  const result = JSON.parse((0, import_mdi_core.parseMdiSyntaxJson)(source));
+  if (result.irVersion !== MDI_IR_VERSION) {
+    throw new Error(`Unsupported MDI IR version: ${String(result.irVersion)}`);
+  }
+  return result;
+}
+function renderHtml(source) {
+  if (typeof source !== "string") throw new TypeError("source must be a string");
+  return (0, import_mdi_core.renderHtml)(source);
+}
+function renderEpub(source) {
+  if (typeof source !== "string") throw new TypeError("source must be a string");
+  return (0, import_mdi_core.renderEpub)(source);
+}
+function renderDocx(source) {
+  if (typeof source !== "string") throw new TypeError("source must be a string");
+  return (0, import_mdi_core.renderDocx)(source);
+}
+function serializeMdi(source) {
+  if (typeof source !== "string") throw new TypeError("source must be a string");
+  return (0, import_mdi_core.serializeMdi)(source);
+}
+function renderText(source) {
+  if (typeof source !== "string") throw new TypeError("source must be a string");
+  return (0, import_mdi_core.renderText)(source);
+}
+function renderTextFormat(source, format, indentPrefix = "") {
+  if (typeof source !== "string" || typeof indentPrefix !== "string") {
+    throw new TypeError("source and indentPrefix must be strings");
+  }
+  return (0, import_mdi_core.renderTextFormat)(source, format, indentPrefix);
+}
+var parseMdiSyntax = parse;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  MDI_IR_VERSION,
+  MDI_SPEC_VERSION,
+  parse,
+  parseMdiSyntax,
+  renderDocx,
+  renderEpub,
+  renderHtml,
+  renderText,
+  renderTextFormat,
+  serializeMdi
+});

package/dist/index.d.cts

@@ -0,0 +1,87 @@
+/** MDI specification version implemented by this binding. */
+declare const MDI_SPEC_VERSION: "2.0";
+/** Version of the complete Rust-owned document IR. */
+declare const MDI_IR_VERSION: "1.0";
+interface MdiParserCapabilities {
+    mdi: boolean;
+    commonMark: boolean;
+    gfm: boolean;
+    frontMatter: boolean;
+    sourceSpans: boolean;
+}
+interface MdiSourceSpan {
+    /** Inclusive UTF-8 byte offset. */
+    startByte: number;
+    /** Exclusive UTF-8 byte offset. */
+    endByte: number;
+}
+interface MdiDiagnostic {
+    severity: "warning" | "error";
+    code: string;
+    message: string;
+    span?: MdiSourceSpan;
+}
+type MdiRubyReading = {
+    type: "group";
+    value: string;
+} | {
+    type: "split";
+    value: string[];
+};
+/** A tagged CommonMark, GFM, or MDI node produced by Rust. */
+interface MdiNode {
+    type: string;
+    span?: MdiSourceSpan;
+    children?: MdiNode[];
+    [key: string]: unknown;
+}
+interface MdiFrontmatter {
+    span: MdiSourceSpan;
+    raw: string;
+    entries: Array<{
+        key: string;
+        value: unknown;
+    }>;
+}
+interface MdiDocument {
+    span: MdiSourceSpan;
+    frontmatter?: MdiFrontmatter;
+    children: MdiNode[];
+}
+/**
+ * Versioned result returned by the Rust parser.
+ *
+ * Capability flags describe the grammar and source information included in
+ * this complete Rust-owned document tree.
+ */
+interface MdiSyntaxParseResult {
+    irVersion: typeof MDI_IR_VERSION;
+    syntaxVersion: typeof MDI_SPEC_VERSION;
+    capabilities: MdiParserCapabilities;
+    document: MdiDocument;
+    diagnostics: MdiDiagnostic[];
+}
+/** @deprecated Use {@link MdiDocument}. */
+type MdiSyntaxDocument = MdiDocument;
+/**
+ * Parse the complete `.mdi` source in Rust and return the versioned
+ * language-neutral document IR. JavaScript performs no grammar work.
+ */
+declare function parse(source: string): MdiSyntaxParseResult;
+/** Render complete `.mdi` source to standalone HTML in Rust. */
+declare function renderHtml(source: string): string;
+/** Build a baseline EPUB 3 archive from complete source in Rust. */
+declare function renderEpub(source: string): Uint8Array;
+/** Build a baseline DOCX archive from complete source in Rust. */
+declare function renderDocx(source: string): Uint8Array;
+/** Parse and normalize complete `.mdi` source with Rust's serializer. */
+declare function serializeMdi(source: string): string;
+/** Render complete `.mdi` source to deterministic plain text in Rust. */
+declare function renderText(source: string): string;
+type MdiTextFormat = "txt" | "txt-ruby" | "narou" | "kakuyomu" | "aozora";
+/** Render a named publication-text convention through Rust. */
+declare function renderTextFormat(source: string, format: MdiTextFormat, indentPrefix?: string): string;
+/** @deprecated Use {@link parse}; it now parses the complete document. */
+declare const parseMdiSyntax: typeof parse;
+
+export { MDI_IR_VERSION, MDI_SPEC_VERSION, type MdiDiagnostic, type MdiDocument, type MdiFrontmatter, type MdiNode, type MdiParserCapabilities, type MdiRubyReading, type MdiSourceSpan, type MdiSyntaxDocument, type MdiSyntaxParseResult, type MdiTextFormat, parse, parseMdiSyntax, renderDocx, renderEpub, renderHtml, renderText, renderTextFormat, serializeMdi };

package/dist/index.d.ts

@@ -0,0 +1,87 @@
+/** MDI specification version implemented by this binding. */
+declare const MDI_SPEC_VERSION: "2.0";
+/** Version of the complete Rust-owned document IR. */
+declare const MDI_IR_VERSION: "1.0";
+interface MdiParserCapabilities {
+    mdi: boolean;
+    commonMark: boolean;
+    gfm: boolean;
+    frontMatter: boolean;
+    sourceSpans: boolean;
+}
+interface MdiSourceSpan {
+    /** Inclusive UTF-8 byte offset. */
+    startByte: number;
+    /** Exclusive UTF-8 byte offset. */
+    endByte: number;
+}
+interface MdiDiagnostic {
+    severity: "warning" | "error";
+    code: string;
+    message: string;
+    span?: MdiSourceSpan;
+}
+type MdiRubyReading = {
+    type: "group";
+    value: string;
+} | {
+    type: "split";
+    value: string[];
+};
+/** A tagged CommonMark, GFM, or MDI node produced by Rust. */
+interface MdiNode {
+    type: string;
+    span?: MdiSourceSpan;
+    children?: MdiNode[];
+    [key: string]: unknown;
+}
+interface MdiFrontmatter {
+    span: MdiSourceSpan;
+    raw: string;
+    entries: Array<{
+        key: string;
+        value: unknown;
+    }>;
+}
+interface MdiDocument {
+    span: MdiSourceSpan;
+    frontmatter?: MdiFrontmatter;
+    children: MdiNode[];
+}
+/**
+ * Versioned result returned by the Rust parser.
+ *
+ * Capability flags describe the grammar and source information included in
+ * this complete Rust-owned document tree.
+ */
+interface MdiSyntaxParseResult {
+    irVersion: typeof MDI_IR_VERSION;
+    syntaxVersion: typeof MDI_SPEC_VERSION;
+    capabilities: MdiParserCapabilities;
+    document: MdiDocument;
+    diagnostics: MdiDiagnostic[];
+}
+/** @deprecated Use {@link MdiDocument}. */
+type MdiSyntaxDocument = MdiDocument;
+/**
+ * Parse the complete `.mdi` source in Rust and return the versioned
+ * language-neutral document IR. JavaScript performs no grammar work.
+ */
+declare function parse(source: string): MdiSyntaxParseResult;
+/** Render complete `.mdi` source to standalone HTML in Rust. */
+declare function renderHtml(source: string): string;
+/** Build a baseline EPUB 3 archive from complete source in Rust. */
+declare function renderEpub(source: string): Uint8Array;
+/** Build a baseline DOCX archive from complete source in Rust. */
+declare function renderDocx(source: string): Uint8Array;
+/** Parse and normalize complete `.mdi` source with Rust's serializer. */
+declare function serializeMdi(source: string): string;
+/** Render complete `.mdi` source to deterministic plain text in Rust. */
+declare function renderText(source: string): string;
+type MdiTextFormat = "txt" | "txt-ruby" | "narou" | "kakuyomu" | "aozora";
+/** Render a named publication-text convention through Rust. */
+declare function renderTextFormat(source: string, format: MdiTextFormat, indentPrefix?: string): string;
+/** @deprecated Use {@link parse}; it now parses the complete document. */
+declare const parseMdiSyntax: typeof parse;
+
+export { MDI_IR_VERSION, MDI_SPEC_VERSION, type MdiDiagnostic, type MdiDocument, type MdiFrontmatter, type MdiNode, type MdiParserCapabilities, type MdiRubyReading, type MdiSourceSpan, type MdiSyntaxDocument, type MdiSyntaxParseResult, type MdiTextFormat, parse, parseMdiSyntax, renderDocx, renderEpub, renderHtml, renderText, renderTextFormat, serializeMdi };

package/dist/index.js

@@ -0,0 +1,59 @@
+// src/index.ts
+import {
+  parseMdiSyntaxJson,
+  renderHtml as renderHtmlFromRust,
+  renderEpub as renderEpubFromRust,
+  renderDocx as renderDocxFromRust,
+  renderText as renderTextFromRust,
+  renderTextFormat as renderTextFormatFromRust,
+  serializeMdi as serializeMdiFromRust
+} from "@illusions-lab/mdi-core";
+var MDI_SPEC_VERSION = "2.0";
+var MDI_IR_VERSION = "1.0";
+function parse(source) {
+  if (typeof source !== "string") throw new TypeError("source must be a string");
+  const result = JSON.parse(parseMdiSyntaxJson(source));
+  if (result.irVersion !== MDI_IR_VERSION) {
+    throw new Error(`Unsupported MDI IR version: ${String(result.irVersion)}`);
+  }
+  return result;
+}
+function renderHtml(source) {
+  if (typeof source !== "string") throw new TypeError("source must be a string");
+  return renderHtmlFromRust(source);
+}
+function renderEpub(source) {
+  if (typeof source !== "string") throw new TypeError("source must be a string");
+  return renderEpubFromRust(source);
+}
+function renderDocx(source) {
+  if (typeof source !== "string") throw new TypeError("source must be a string");
+  return renderDocxFromRust(source);
+}
+function serializeMdi(source) {
+  if (typeof source !== "string") throw new TypeError("source must be a string");
+  return serializeMdiFromRust(source);
+}
+function renderText(source) {
+  if (typeof source !== "string") throw new TypeError("source must be a string");
+  return renderTextFromRust(source);
+}
+function renderTextFormat(source, format, indentPrefix = "") {
+  if (typeof source !== "string" || typeof indentPrefix !== "string") {
+    throw new TypeError("source and indentPrefix must be strings");
+  }
+  return renderTextFormatFromRust(source, format, indentPrefix);
+}
+var parseMdiSyntax = parse;
+export {
+  MDI_IR_VERSION,
+  MDI_SPEC_VERSION,
+  parse,
+  parseMdiSyntax,
+  renderDocx,
+  renderEpub,
+  renderHtml,
+  renderText,
+  renderTextFormat,
+  serializeMdi
+};

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@illusions-lab/mdi",
+  "version": "2.0.3",
+  "description": "Thin JavaScript binding for the Rust-authoritative MDI parser",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/illusions-lab/MDI.git",
+    "directory": "nodejs/packages/mdi"
+  },
+  "homepage": "https://mdi.illusions.app/",
+  "bugs": "https://github.com/illusions-lab/MDI/issues",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@illusions-lab/mdi-core": "2.0.3"
+  },
+  "devDependencies": {
+    "tsup": "^8.3.0",
+    "typescript": "^5.6.0",
+    "vitest": "^2.1.0"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts",
+    "test": "vitest run --passWithNoTests",
+    "typecheck": "tsc --noEmit"
+  }
+}