@illusions-lab/mdi 2.0.12 → 2.0.14

package/README.md

@@ -62,11 +62,12 @@ unsupported version.
 
 ## Rendering
 
-Rendering starts from the same Rust IR. Canonical MDI, plain text, HTML, and
-the one-argument baseline EPUB/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.
+Rendering starts from the same Rust IR. Canonical MDI, plain text, HTML, EPUB,
+and DOCX—including profile-configured EPUB and DOCX—execute in Rust and are
+exposed through this package. PDF uses Rust-prepared HTML, print CSS, page
+geometry, and header/footer data as input to a host such as
+`@illusions-lab/mdi-to-pdf`. The host launches Chromium, but it never parses
+MDI or decides publication settings.
 
 Browser WebAssembly cannot start Chromium. Browser code sends Rust-rendered
 HTML to a server or desktop host when it needs PDF output.
@@ -94,25 +95,28 @@ Rust-authoritative parser rather than accepting mutable JavaScript IR. This
 keeps the source spans and error codes predictable and prevents JavaScript from
 becoming a second syntax implementation.
 
-Configuration ownership is deliberately split: Rust owns MDI parsing and
-semantic HTML; publication profiles own EPUB/DOCX metadata and typesetting;
-the host owns Chromium/Electron, paper-printer integration, and application UI
-preferences. This keeps platform-specific pagination controls out of the
-parser and lets Electron supply its own PDF adapter.
+Configuration ownership is deliberately clear: Rust validates publication
+profiles and applies EPUB/DOCX metadata, typography, page geometry, and
+numbering. For PDF, Rust also prepares the print HTML and resolved page data;
+the host owns only Chromium/Electron process control, printer integration, and
+application UI preferences. This keeps layout behavior consistent without
+putting application concerns into the parser.
 
 ### Configured EPUB and DOCX
 
 For publication output, pass an export profile to the overloads (or use the
-explicit `WithProfile` functions). These Node.js-only async paths map the
-Rust-owned IR through the publication adapters and retain configuration for
-metadata, chapter splitting, vertical writing, font selection, paper size,
-margins, and page numbers. EPUB also accepts in-memory PNG or JPEG cover art.
+explicit `WithProfile` functions). The Promise-shaped API is retained for
+compatibility, while profile validation and archive generation both run in
+Rust. It supports metadata, chapter splitting, vertical writing, font
+selection, paper size, margins, and page numbers. EPUB also accepts in-memory
+PNG or JPEG cover art.
 
 ```ts
 import { renderDocxWithProfile, renderEpubWithProfile } from "@illusions-lab/mdi";
 
 const epub = await renderEpubWithProfile(source, {
   profile: {
+    layout: { system: "japanese-publisher" },
     metadata: { title: "Book", author: "Author" },
     typesetting: { writingMode: "vertical", fontFamily: "Noto Serif JP" },
     epub: { chapterSplitLevel: "h1" },
@@ -121,6 +125,7 @@ const epub = await renderEpubWithProfile(source, {
 });
 
 const docx = await renderDocxWithProfile(source, {
+  layout: { system: "word" },
   pagination: { pageSize: "A5", margins: { top: 12, bottom: 12, left: 14, right: 14 } },
 });
 ```

package/dist/index.d.cts

@@ -45,9 +45,9 @@ type MdiDocxExportProfile = ExportProfile & {
     date?: string;
     verticalWriting?: boolean;
     fontFamily?: string;
-    /** Point size; requires a publication adapter that supports it. */
+    /** Body type size in typographic points. */
     fontSize?: number;
-    /** Line-height multiplier; requires a publication adapter that supports it. */
+    /** Baseline multiplier, for example 1.5 for one-and-a-half spacing. */
     lineSpacing?: number;
     textIndent?: number;
     pageSize?: NonNullable<ExportProfile["pagination"]>["pageSize"];
@@ -113,7 +113,7 @@ interface MdiDocument {
     frontmatter?: MdiFrontmatter;
     children: MdiNode[];
 }
-/** Resolved front matter attached to mdast publication-adapter roots. */
+/** Resolved front matter attached to mdast compatibility roots. */
 interface MdiPublicationFrontmatter {
     mdi: string;
     title?: string;
@@ -192,7 +192,7 @@ declare function prepareRender(source: string): MdiSyntaxParseResult;
 declare function renderEpub(source: string): Uint8Array;
 /**
  * Build a profile-configured EPUB 3 archive. This overload is asynchronous
- * because archive generation is performed by the Node.js publication adapter.
+ * for backward compatibility; validation and archive generation run in Rust.
  */
 declare function renderEpub(source: string, options: MdiEpubExportOptions): Promise<Uint8Array>;
 /** Build a baseline Rust EPUB while retaining diagnostics for an export UI. */
@@ -202,32 +202,27 @@ declare function renderEpubWithDiagnostics(source: string, options: MdiEpubExpor
 declare function renderDocx(source: string): Uint8Array;
 /**
  * Build a profile-configured DOCX archive. This overload is asynchronous
- * because archive generation is performed by the Node.js publication adapter.
+ * for backward compatibility; validation and OOXML generation run in Rust.
  */
 declare function renderDocx(source: string, profile: MdiDocxExportProfile): Promise<Uint8Array>;
 /** Build a baseline Rust DOCX while retaining diagnostics for an export UI. */
 declare function renderDocxWithDiagnostics(source: string): MdiRenderResult<Uint8Array>;
 declare function renderDocxWithDiagnostics(source: string, profile: MdiDocxExportProfile): Promise<MdiRenderResult<Uint8Array>>;
 /**
- * Build a configured EPUB using the same profile schema as the dedicated
- * publication adapters.  Unlike the one-argument {@link renderEpub}, this
- * returns a Promise and supports cover art, metadata, chapters and vertical
- * writing.
+ * Build a configured EPUB in Rust. Unlike the one-argument
+ * {@link renderEpub}, this returns a Promise for API compatibility and
+ * supports cover art, metadata, chapters and vertical writing.
  */
 declare function renderEpubWithProfile(source: string, options?: MdiEpubExportOptions): Promise<Uint8Array>;
 /**
- * Build a configured DOCX using the shared print profile.  The profile
+ * Build a configured DOCX in Rust using the shared print profile. The profile
  * supports metadata, writing mode, paper size, margins and page numbers.
  */
 declare function renderDocxWithProfile(source: string, profile?: MdiDocxExportProfile): Promise<Uint8Array>;
 /**
- * Map the Rust-owned IR to mdast for the publication adapters. This is a
- * structural conversion only: all grammar decisions have already been made
- * by {@link parse}, so it never reparses MDI source in JavaScript.
- */
-/**
- * Convert a Rust-owned MDI document IR into mdast for publication adapters.
- * This performs no parsing and preserves the adapter node conventions.
+ * Convert a Rust-owned MDI document IR into mdast for unified compatibility
+ * workflows. This performs no parsing and preserves the established mdast
+ * node conventions.
  */
 declare function toPublicationMdast(document: MdiDocument): MdiPublicationRoot;
 /** Parse and normalize complete `.mdi` source with Rust's serializer. */
@@ -236,7 +231,7 @@ declare function serializeMdi(source: string): string;
 declare function renderText(source: string): string;
 /** Render plain text without discarding Rust diagnostics and source spans. */
 declare function renderTextWithDiagnostics(source: string): MdiRenderResult<string>;
-type MdiTextFormat = "txt" | "txt-ruby" | "narou" | "kakuyomu" | "aozora";
+type MdiTextFormat = "txt" | "txt-ruby" | "narou" | "kakuyomu" | "aozora" | "note";
 /** Render a named publication-text convention through Rust. */
 declare function renderTextFormat(source: string, format: MdiTextFormat, indentPrefix?: string): string;
 /** Render a named text format without discarding Rust diagnostics and spans. */

package/dist/index.d.ts

@@ -45,9 +45,9 @@ type MdiDocxExportProfile = ExportProfile & {
     date?: string;
     verticalWriting?: boolean;
     fontFamily?: string;
-    /** Point size; requires a publication adapter that supports it. */
+    /** Body type size in typographic points. */
     fontSize?: number;
-    /** Line-height multiplier; requires a publication adapter that supports it. */
+    /** Baseline multiplier, for example 1.5 for one-and-a-half spacing. */
     lineSpacing?: number;
     textIndent?: number;
     pageSize?: NonNullable<ExportProfile["pagination"]>["pageSize"];
@@ -113,7 +113,7 @@ interface MdiDocument {
     frontmatter?: MdiFrontmatter;
     children: MdiNode[];
 }
-/** Resolved front matter attached to mdast publication-adapter roots. */
+/** Resolved front matter attached to mdast compatibility roots. */
 interface MdiPublicationFrontmatter {
     mdi: string;
     title?: string;
@@ -192,7 +192,7 @@ declare function prepareRender(source: string): MdiSyntaxParseResult;
 declare function renderEpub(source: string): Uint8Array;
 /**
  * Build a profile-configured EPUB 3 archive. This overload is asynchronous
- * because archive generation is performed by the Node.js publication adapter.
+ * for backward compatibility; validation and archive generation run in Rust.
  */
 declare function renderEpub(source: string, options: MdiEpubExportOptions): Promise<Uint8Array>;
 /** Build a baseline Rust EPUB while retaining diagnostics for an export UI. */
@@ -202,32 +202,27 @@ declare function renderEpubWithDiagnostics(source: string, options: MdiEpubExpor
 declare function renderDocx(source: string): Uint8Array;
 /**
  * Build a profile-configured DOCX archive. This overload is asynchronous
- * because archive generation is performed by the Node.js publication adapter.
+ * for backward compatibility; validation and OOXML generation run in Rust.
  */
 declare function renderDocx(source: string, profile: MdiDocxExportProfile): Promise<Uint8Array>;
 /** Build a baseline Rust DOCX while retaining diagnostics for an export UI. */
 declare function renderDocxWithDiagnostics(source: string): MdiRenderResult<Uint8Array>;
 declare function renderDocxWithDiagnostics(source: string, profile: MdiDocxExportProfile): Promise<MdiRenderResult<Uint8Array>>;
 /**
- * Build a configured EPUB using the same profile schema as the dedicated
- * publication adapters.  Unlike the one-argument {@link renderEpub}, this
- * returns a Promise and supports cover art, metadata, chapters and vertical
- * writing.
+ * Build a configured EPUB in Rust. Unlike the one-argument
+ * {@link renderEpub}, this returns a Promise for API compatibility and
+ * supports cover art, metadata, chapters and vertical writing.
  */
 declare function renderEpubWithProfile(source: string, options?: MdiEpubExportOptions): Promise<Uint8Array>;
 /**
- * Build a configured DOCX using the shared print profile.  The profile
+ * Build a configured DOCX in Rust using the shared print profile. The profile
  * supports metadata, writing mode, paper size, margins and page numbers.
  */
 declare function renderDocxWithProfile(source: string, profile?: MdiDocxExportProfile): Promise<Uint8Array>;
 /**
- * Map the Rust-owned IR to mdast for the publication adapters. This is a
- * structural conversion only: all grammar decisions have already been made
- * by {@link parse}, so it never reparses MDI source in JavaScript.
- */
-/**
- * Convert a Rust-owned MDI document IR into mdast for publication adapters.
- * This performs no parsing and preserves the adapter node conventions.
+ * Convert a Rust-owned MDI document IR into mdast for unified compatibility
+ * workflows. This performs no parsing and preserves the established mdast
+ * node conventions.
  */
 declare function toPublicationMdast(document: MdiDocument): MdiPublicationRoot;
 /** Parse and normalize complete `.mdi` source with Rust's serializer. */
@@ -236,7 +231,7 @@ declare function serializeMdi(source: string): string;
 declare function renderText(source: string): string;
 /** Render plain text without discarding Rust diagnostics and source spans. */
 declare function renderTextWithDiagnostics(source: string): MdiRenderResult<string>;
-type MdiTextFormat = "txt" | "txt-ruby" | "narou" | "kakuyomu" | "aozora";
+type MdiTextFormat = "txt" | "txt-ruby" | "narou" | "kakuyomu" | "aozora" | "note";
 /** Render a named publication-text convention through Rust. */
 declare function renderTextFormat(source: string, format: MdiTextFormat, indentPrefix?: string): string;
 /** Render a named text format without discarding Rust diagnostics and spans. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@illusions-lab/mdi",
-  "version": "2.0.12",
+  "version": "2.0.14",
   "description": "Thin JavaScript binding for the Rust-authoritative MDI parser",
   "license": "MIT",
   "repository": {
@@ -32,9 +32,9 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@illusions-lab/mdi-core": "^2.0.12",
-    "@illusions-lab/mdi-export-profile": "^2.0.17",
-    "@illusions-lab/mdi-to-epub": "^2.0.27",
+    "@illusions-lab/mdi-core": "^2.0.14",
+    "@illusions-lab/mdi-export-profile": "^2.0.19",
+    "@illusions-lab/mdi-to-epub": "^2.0.29",
     "@types/mdast": "^4.0.0",
     "yaml": "^2.0.0"
   },