@ox-content/napi 0.0.1-alpha.0 → 0.3.0-alpha.11

package/index.d.ts

@@ -1,100 +1,88 @@
-/* tslint:disable */
+/* auto-generated by NAPI-RS */
 /* eslint-disable */
+/**
+ * Builds a search index from documents.
+ *
+ * Takes an array of documents and returns a serialized search index as JSON.
+ */
+export declare function buildSearchIndex(documents: Array<JsSearchDocument>): string
 
-/* auto-generated by NAPI-RS */
+/**
+ * Extracts searchable content from Markdown source.
+ *
+ * Parses the Markdown and extracts title, body text, headings, and code.
+ */
+export declare function extractSearchContent(source: string, id: string, url: string, options?: JsParserOptions | undefined | null): JsSearchDocument
 
-/** Parse result containing the AST as JSON. */
-export interface ParseResult {
-  /** The AST as a JSON string. */
-  ast: string
-  /** Parse errors, if any. */
-  errors: Array<string>
+/**
+ * Generates an OG image as SVG.
+ *
+ * This function generates an SVG representation of an OG image
+ * that can be used for social media previews.
+ */
+export declare function generateOgImageSvg(data: JsOgImageData, config?: JsOgImageConfig | undefined | null): string
+
+/** Generates SSG HTML page with navigation and search. */
+export declare function generateSsgHtml(pageData: JsSsgPageData, navGroups: Array<JsSsgNavGroup>, config: JsSsgConfig): string
+
+/** Entry page configuration. */
+export interface JsEntryPageConfig {
+  /** Hero section. */
+  hero?: JsHeroConfig
+  /** Feature cards. */
+  features?: Array<JsFeatureConfig>
 }
-/** Render result containing the HTML output. */
-export interface RenderResult {
-  /** The rendered HTML. */
-  html: string
-  /** Render errors, if any. */
-  errors: Array<string>
+
+/** Feature card for entry page. */
+export interface JsFeatureConfig {
+  /** Icon - supports: "mdi:icon-name" (Iconify), image URL, or emoji. */
+  icon?: string
+  /** Feature title. */
+  title: string
+  /** Feature description. */
+  details?: string
+  /** Optional link. */
+  link?: string
+  /** Link text. */
+  linkText?: string
 }
-/** Table of contents entry. */
-export interface TocEntry {
-  /** Heading depth (1-6). */
-  depth: number
-  /** Heading text. */
+
+/** Hero action for entry page. */
+export interface JsHeroAction {
+  /** Button theme: "brand" or "alt". */
+  theme?: string
+  /** Button text. */
   text: string
-  /** URL-friendly slug. */
-  slug: string
+  /** Link URL. */
+  link: string
 }
-/** Transform result containing HTML, frontmatter, and TOC. */
-export interface TransformResult {
-  /** The rendered HTML. */
-  html: string
-  /** Parsed frontmatter as JSON string. */
-  frontmatter: string
-  /** Table of contents entries. */
-  toc: Array<TocEntry>
-  /** Parse/render errors, if any. */
-  errors: Array<string>
-}
-/** Transform options for JavaScript. */
-export interface JsTransformOptions {
-  /** Enable GFM extensions. */
-  gfm?: boolean
-  /** Enable footnotes. */
-  footnotes?: boolean
-  /** Enable task lists. */
-  taskLists?: boolean
-  /** Enable tables. */
-  tables?: boolean
-  /** Enable strikethrough. */
-  strikethrough?: boolean
-  /** Enable autolinks. */
-  autolinks?: boolean
-  /** Maximum TOC depth (1-6). */
-  tocMaxDepth?: number
-  /** Convert `.md` links to `.html` links for SSG output. */
-  convertMdLinks?: boolean
-  /** Base URL for absolute link conversion (e.g., "/" or "/docs/"). */
-  baseUrl?: string
+
+/** Hero section configuration for entry page. */
+export interface JsHeroConfig {
+  /** Main title (large, gradient text). */
+  name?: string
+  /** Secondary text. */
+  text?: string
+  /** Tagline. */
+  tagline?: string
+  /** Hero image. */
+  image?: JsHeroImage
+  /** Action buttons. */
+  actions?: Array<JsHeroAction>
 }
-/** Parser options for JavaScript. */
-export interface JsParserOptions {
-  /** Enable GFM extensions. */
-  gfm?: boolean
-  /** Enable footnotes. */
-  footnotes?: boolean
-  /** Enable task lists. */
-  taskLists?: boolean
-  /** Enable tables. */
-  tables?: boolean
-  /** Enable strikethrough. */
-  strikethrough?: boolean
-  /** Enable autolinks. */
-  autolinks?: boolean
+
+/** Hero image for entry page. */
+export interface JsHeroImage {
+  /** Image source URL. */
+  src: string
+  /** Alt text. */
+  alt?: string
+  /** Image width. */
+  width?: number
+  /** Image height. */
+  height?: number
 }
-/**
- * Parses Markdown source into an AST.
- *
- * Returns the AST as a JSON string for zero-copy transfer to JavaScript.
- */
-export declare function parse(source: string, options?: JsParserOptions | undefined | null): ParseResult
-/** Parses Markdown and renders to HTML. */
-export declare function parseAndRender(source: string, options?: JsParserOptions | undefined | null): RenderResult
-/** Renders an AST (provided as JSON) to HTML. */
-export declare function render(astJson: string): RenderResult
-/** Returns the version of ox_content_napi. */
-export declare function version(): string
-/**
- * Transforms Markdown source into HTML, frontmatter, and TOC.
- *
- * This is the main entry point for unplugin-ox-content.
- */
-export declare function transform(source: string, options?: JsTransformOptions | undefined | null): TransformResult
-/** Parses Markdown and renders to HTML asynchronously (runs on worker thread). */
-export declare function parseAndRenderAsync(source: string, options?: JsParserOptions | undefined | null): Promise<unknown>
-/** Transforms Markdown source asynchronously (runs on worker thread). */
-export declare function transformAsync(source: string, options?: JsTransformOptions | undefined | null): Promise<unknown>
+
 /** OG image configuration for JavaScript. */
 export interface JsOgImageConfig {
   /** Image width in pixels. */
@@ -110,6 +98,7 @@ export interface JsOgImageConfig {
   /** Description font size. */
   descriptionFontSize?: number
 }
+
 /** OG image data for JavaScript. */
 export interface JsOgImageData {
   /** Page title. */
@@ -121,13 +110,23 @@ export interface JsOgImageData {
   /** Author name. */
   author?: string
 }
-/**
- * Generates an OG image as SVG.
- *
- * This function generates an SVG representation of an OG image
- * that can be used for social media previews.
- */
-export declare function generateOgImageSvg(data: JsOgImageData, config?: JsOgImageConfig | undefined | null): string
+
+/** Parser options for JavaScript. */
+export interface JsParserOptions {
+  /** Enable GFM extensions. */
+  gfm?: boolean
+  /** Enable footnotes. */
+  footnotes?: boolean
+  /** Enable task lists. */
+  taskLists?: boolean
+  /** Enable tables. */
+  tables?: boolean
+  /** Enable strikethrough. */
+  strikethrough?: boolean
+  /** Enable autolinks. */
+  autolinks?: boolean
+}
+
 /** Search document for JavaScript. */
 export interface JsSearchDocument {
   /** Unique document identifier. */
@@ -143,6 +142,19 @@ export interface JsSearchDocument {
   /** Code snippets. */
   code: Array<string>
 }
+
+/** Search options for JavaScript. */
+export interface JsSearchOptions {
+  /** Maximum number of results. */
+  limit?: number
+  /** Enable prefix matching. */
+  prefix?: boolean
+  /** Enable fuzzy matching. */
+  fuzzy?: boolean
+  /** Minimum score threshold. */
+  threshold?: number
+}
+
 /** Search result for JavaScript. */
 export interface JsSearchResult {
   /** Document ID. */
@@ -158,30 +170,37 @@ export interface JsSearchResult {
   /** Content snippet. */
   snippet: string
 }
-/** Search options for JavaScript. */
-export interface JsSearchOptions {
-  /** Maximum number of results. */
-  limit?: number
-  /** Enable prefix matching. */
-  prefix?: boolean
-  /** Enable fuzzy matching. */
-  fuzzy?: boolean
-  /** Minimum score threshold. */
-  threshold?: number
+
+/** Social links for JavaScript. */
+export interface JsSocialLinks {
+  /** GitHub URL. */
+  github?: string
+  /** Twitter/X URL. */
+  twitter?: string
+  /** Discord URL. */
+  discord?: string
 }
-/**
- * Builds a search index from documents.
- *
- * Takes an array of documents and returns a serialized search index as JSON.
- */
-export declare function buildSearchIndex(documents: Array<JsSearchDocument>): string
-/**
- * Searches a serialized index.
- *
- * Takes a JSON-serialized index, query string, and options.
- * Returns an array of search results.
- */
-export declare function searchIndex(indexJson: string, query: string, options?: JsSearchOptions | undefined | null): Array<JsSearchResult>
+
+/** SSG configuration. */
+export interface JsSsgConfig {
+  /** Site name. */
+  siteName: string
+  /** Base URL path. */
+  base: string
+  /** OG image URL. */
+  ogImage?: string
+  /** Theme configuration. */
+  theme?: JsThemeConfig
+}
+
+/** Navigation group for SSG. */
+export interface JsSsgNavGroup {
+  /** Group title. */
+  title: string
+  /** Navigation items. */
+  items: Array<JsSsgNavItem>
+}
+
 /** Navigation item for SSG. */
 export interface JsSsgNavItem {
   /** Display title. */
@@ -191,13 +210,7 @@ export interface JsSsgNavItem {
   /** Full href. */
   href: string
 }
-/** Navigation group for SSG. */
-export interface JsSsgNavGroup {
-  /** Group title. */
-  title: string
-  /** Navigation items. */
-  items: Array<JsSsgNavItem>
-}
+
 /** Page data for SSG. */
 export interface JsSsgPageData {
   /** Page title. */
@@ -210,21 +223,226 @@ export interface JsSsgPageData {
   toc: Array<TocEntry>
   /** URL path. */
   path: string
+  /** Entry page configuration (if layout: entry). */
+  entryPage?: JsEntryPageConfig
 }
-/** SSG configuration. */
-export interface JsSsgConfig {
-  /** Site name. */
-  siteName: string
-  /** Base URL path. */
-  base: string
-  /** OG image URL. */
-  ogImage?: string
+
+/** Theme colors for JavaScript. */
+export interface JsThemeColors {
+  /** Primary accent color. */
+  primary?: string
+  /** Primary color on hover. */
+  primaryHover?: string
+  /** Background color. */
+  background?: string
+  /** Alternative background color. */
+  backgroundAlt?: string
+  /** Main text color. */
+  text?: string
+  /** Muted text color. */
+  textMuted?: string
+  /** Border color. */
+  border?: string
+  /** Code block background color. */
+  codeBackground?: string
+  /** Code block text color. */
+  codeText?: string
 }
-/** Generates SSG HTML page with navigation and search. */
-export declare function generateSsgHtml(pageData: JsSsgPageData, navGroups: Array<JsSsgNavGroup>, config: JsSsgConfig): string
+
+/** Theme configuration for JavaScript. */
+export interface JsThemeConfig {
+  /** Light mode colors. */
+  colors?: JsThemeColors
+  /** Dark mode colors. */
+  darkColors?: JsThemeColors
+  /** Font configuration. */
+  fonts?: JsThemeFonts
+  /** Layout configuration. */
+  layout?: JsThemeLayout
+  /** Header configuration. */
+  header?: JsThemeHeader
+  /** Footer configuration. */
+  footer?: JsThemeFooter
+  /** Social links configuration. */
+  socialLinks?: JsSocialLinks
+  /** Embedded HTML content at specific positions. */
+  embed?: JsThemeEmbed
+  /** Additional custom CSS. */
+  css?: string
+  /** Additional custom JavaScript. */
+  js?: string
+}
+
+/** Embedded HTML content for specific positions. */
+export interface JsThemeEmbed {
+  /** Content to embed into `<head>`. */
+  head?: string
+  /** Content before header. */
+  headerBefore?: string
+  /** Content after header. */
+  headerAfter?: string
+  /** Content before sidebar navigation. */
+  sidebarBefore?: string
+  /** Content after sidebar navigation. */
+  sidebarAfter?: string
+  /** Content before main content. */
+  contentBefore?: string
+  /** Content after main content. */
+  contentAfter?: string
+  /** Content before footer. */
+  footerBefore?: string
+  /** Custom footer content. */
+  footer?: string
+}
+
+/** Theme fonts for JavaScript. */
+export interface JsThemeFonts {
+  /** Sans-serif font stack. */
+  sans?: string
+  /** Monospace font stack. */
+  mono?: string
+}
+
+/** Theme footer for JavaScript. */
+export interface JsThemeFooter {
+  /** Footer message (supports HTML). */
+  message?: string
+  /** Copyright text (supports HTML). */
+  copyright?: string
+}
+
+/** Theme header for JavaScript. */
+export interface JsThemeHeader {
+  /** Logo image URL. */
+  logo?: string
+  /** Logo width in pixels. */
+  logoWidth?: number
+  /** Logo height in pixels. */
+  logoHeight?: number
+}
+
+/** Theme layout for JavaScript. */
+export interface JsThemeLayout {
+  /** Sidebar width (CSS value). */
+  sidebarWidth?: string
+  /** Header height (CSS value). */
+  headerHeight?: string
+  /** Maximum content width (CSS value). */
+  maxContentWidth?: string
+}
+
+/** Transform options for JavaScript. */
+export interface JsTransformOptions {
+  /** Enable GFM extensions. */
+  gfm?: boolean
+  /** Enable footnotes. */
+  footnotes?: boolean
+  /** Enable task lists. */
+  taskLists?: boolean
+  /** Enable tables. */
+  tables?: boolean
+  /** Enable strikethrough. */
+  strikethrough?: boolean
+  /** Enable autolinks. */
+  autolinks?: boolean
+  /** Maximum TOC depth (1-6). */
+  tocMaxDepth?: number
+  /** Convert `.md` links to `.html` links for SSG output. */
+  convertMdLinks?: boolean
+  /** Base URL for absolute link conversion (e.g., "/" or "/docs/"). */
+  baseUrl?: string
+  /** Source file path for relative link resolution. */
+  sourcePath?: string
+}
+
+/** Mermaid transform result. */
+export interface MermaidTransformResult {
+  /** The transformed HTML with mermaid code blocks replaced by rendered SVGs. */
+  html: string
+  /** Non-fatal errors encountered during rendering (per-diagram). */
+  errors: Array<string>
+}
+
 /**
- * Extracts searchable content from Markdown source.
+ * Parses Markdown source into an AST.
  *
- * Parses the Markdown and extracts title, body text, headings, and code.
+ * Returns the AST as a JSON string for zero-copy transfer to JavaScript.
  */
-export declare function extractSearchContent(source: string, id: string, url: string, options?: JsParserOptions | undefined | null): JsSearchDocument
+export declare function parse(source: string, options?: JsParserOptions | undefined | null): ParseResult
+
+/** Parses Markdown and renders to HTML. */
+export declare function parseAndRender(source: string, options?: JsParserOptions | undefined | null): RenderResult
+
+/** Parses Markdown and renders to HTML asynchronously (runs on worker thread). */
+export declare function parseAndRenderAsync(source: string, options?: JsParserOptions | undefined | null): Promise<unknown>
+
+/** Parse result containing the AST as JSON. */
+export interface ParseResult {
+  /** The AST as a JSON string. */
+  ast: string
+  /** Parse errors, if any. */
+  errors: Array<string>
+}
+
+/** Renders an AST (provided as JSON) to HTML. */
+export declare function render(astJson: string): RenderResult
+
+/** Render result containing the HTML output. */
+export interface RenderResult {
+  /** The rendered HTML. */
+  html: string
+  /** Render errors, if any. */
+  errors: Array<string>
+}
+
+/**
+ * Searches a serialized index.
+ *
+ * Takes a JSON-serialized index, query string, and options.
+ * Returns an array of search results.
+ */
+export declare function searchIndex(indexJson: string, query: string, options?: JsSearchOptions | undefined | null): Array<JsSearchResult>
+
+/** Table of contents entry. */
+export interface TocEntry {
+  /** Heading depth (1-6). */
+  depth: number
+  /** Heading text. */
+  text: string
+  /** URL-friendly slug. */
+  slug: string
+}
+
+/**
+ * Transforms Markdown source into HTML, frontmatter, and TOC.
+ *
+ * This is the main entry point for unplugin-ox-content.
+ */
+export declare function transform(source: string, options?: JsTransformOptions | undefined | null): TransformResult
+
+/** Transforms Markdown source asynchronously (runs on worker thread). */
+export declare function transformAsync(source: string, options?: JsTransformOptions | undefined | null): Promise<unknown>
+
+/**
+ * Transforms mermaid code blocks in HTML to rendered SVG diagrams.
+ *
+ * Extracts `<pre><code class="language-mermaid">...</code></pre>` blocks,
+ * renders each in parallel using the mmdc CLI, and replaces them with
+ * `<div class="ox-mermaid">...</div>`.
+ */
+export declare function transformMermaid(html: string, mmdcPath: string): MermaidTransformResult
+
+/** Transform result containing HTML, frontmatter, and TOC. */
+export interface TransformResult {
+  /** The rendered HTML. */
+  html: string
+  /** Parsed frontmatter as JSON string. */
+  frontmatter: string
+  /** Table of contents entries. */
+  toc: Array<TocEntry>
+  /** Parse/render errors, if any. */
+  errors: Array<string>
+}
+
+/** Returns the version of ox_content_napi. */
+export declare function version(): string

package/index.js

@@ -1,61 +1,84 @@
-const { existsSync } = require('fs');
-const { join } = require('path');
+const { existsSync } = require("fs")
+const path = require("path")
 
 function loadBinding() {
-  // Try loading the local development binary first (index.node)
-  const localBinary = join(__dirname, 'index.node');
+  // 1. Try loading the local binary (napi build output)
+  const napiOutput = path.join(__dirname, "ox-content.node")
+  if (existsSync(napiOutput)) {
+    return require(napiOutput)
+  }
+
+  // 1b. Legacy: index.node (napi-rs v2)
+  const localBinary = path.join(__dirname, "index.node")
   if (existsSync(localBinary)) {
-    return require(localBinary);
+    return require(localBinary)
   }
 
-  // Try platform-specific binary
-  const platform = process.platform;
-  const arch = process.arch;
+  // 2. Try platform-specific binary in same directory (CI build artifact)
+  const platform = process.platform
+  const arch = process.arch
 
   const platforms = {
-    'darwin-arm64': 'ox-content.darwin-arm64.node',
-    'darwin-x64': 'ox-content.darwin-x64.node',
-    'linux-x64-gnu': 'ox-content.linux-x64-gnu.node',
-    'linux-arm64-gnu': 'ox-content.linux-arm64-gnu.node',
-    'win32-x64-msvc': 'ox-content.win32-x64-msvc.node',
-  };
-
-  let key;
-  if (platform === 'darwin') {
-    key = `darwin-${arch}`;
-  } else if (platform === 'linux') {
-    key = `linux-${arch}-gnu`;
-  } else if (platform === 'win32') {
-    key = `win32-${arch}-msvc`;
+    "darwin-arm64": "ox-content.darwin-arm64.node",
+    "darwin-x64": "ox-content.darwin-x64.node",
+    "linux-x64-gnu": "ox-content.linux-x64-gnu.node",
+    "linux-arm64-gnu": "ox-content.linux-arm64-gnu.node",
+    "win32-x64-msvc": "ox-content.win32-x64-msvc.node",
+  }
+
+  let key
+  if (platform === "darwin") {
+    key = `darwin-${arch}`
+  } else if (platform === "linux") {
+    key = `linux-${arch}-gnu`
+  } else if (platform === "win32") {
+    key = `win32-${arch}-msvc`
   }
 
-  const binaryName = platforms[key];
+  const binaryName = platforms[key]
   if (binaryName) {
-    const binaryPath = join(__dirname, binaryName);
+    const binaryPath = path.join(__dirname, binaryName)
     if (existsSync(binaryPath)) {
-      return require(binaryPath);
+      return require(binaryPath)
     }
   }
 
+  // 3. Try npm sub-packages (@ox-content/binding-darwin-arm64 etc.)
+  const subPackages = {
+    "darwin-arm64": "@ox-content/binding-darwin-arm64",
+    "darwin-x64": "@ox-content/binding-darwin-x64",
+    "linux-x64-gnu": "@ox-content/binding-linux-x64-gnu",
+    "linux-arm64-gnu": "@ox-content/binding-linux-arm64-gnu",
+    "win32-x64-msvc": "@ox-content/binding-win32-x64-msvc",
+  }
+
+  const subPackage = subPackages[key]
+  if (subPackage) {
+    try {
+      return require(subPackage)
+    } catch {}
+  }
+
   throw new Error(
     `@ox-content/napi: No compatible binary found for ${platform}-${arch}. ` +
-    `Please run 'pnpm build' in crates/ox_content_napi.`
-  );
+      `Please run 'pnpm build' in crates/ox_content_napi.`,
+  )
 }
 
-const binding = loadBinding();
+const binding = loadBinding()
 
 // Export individual functions for ESM compatibility
-module.exports = binding;
-module.exports.parse = binding.parse;
-module.exports.parseAndRender = binding.parseAndRender;
-module.exports.parseAndRenderAsync = binding.parseAndRenderAsync;
-module.exports.render = binding.render;
-module.exports.transform = binding.transform;
-module.exports.transformAsync = binding.transformAsync;
-module.exports.version = binding.version;
-module.exports.generateOgImageSvg = binding.generateOgImageSvg;
-module.exports.buildSearchIndex = binding.buildSearchIndex;
-module.exports.searchIndex = binding.searchIndex;
-module.exports.extractSearchContent = binding.extractSearchContent;
-module.exports.generateSsgHtml = binding.generateSsgHtml;
+module.exports = binding
+module.exports.parse = binding.parse
+module.exports.parseAndRender = binding.parseAndRender
+module.exports.parseAndRenderAsync = binding.parseAndRenderAsync
+module.exports.render = binding.render
+module.exports.transform = binding.transform
+module.exports.transformAsync = binding.transformAsync
+module.exports.version = binding.version
+module.exports.generateOgImageSvg = binding.generateOgImageSvg
+module.exports.buildSearchIndex = binding.buildSearchIndex
+module.exports.searchIndex = binding.searchIndex
+module.exports.extractSearchContent = binding.extractSearchContent
+module.exports.generateSsgHtml = binding.generateSsgHtml
+module.exports.transformMermaid = binding.transformMermaid

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@ox-content/napi",
-  "version": "0.0.1-alpha.0",
+  "version": "0.3.0-alpha.11",
   "description": "Node.js bindings for Ox Content - High-performance Markdown parser",
   "main": "index.js",
   "types": "index.d.ts",
   "files": [
     "index.js",
-    "index.d.ts",
-    "*.node"
+    "index.d.ts"
   ],
   "napi": {
     "binaryName": "ox-content",
+    "packageName": "@ox-content/binding",
     "targets": [
       "x86_64-apple-darwin",
       "aarch64-apple-darwin",
@@ -24,7 +24,7 @@
     "build:debug": "napi build"
   },
   "devDependencies": {
-    "@napi-rs/cli": "^2.18.0"
+    "@napi-rs/cli": "^3.0.0"
   },
   "repository": {
     "type": "git",
@@ -32,6 +32,7 @@
     "directory": "crates/ox_content_napi"
   },
   "publishConfig": {
+    "provenance": true,
     "access": "public"
   },
   "keywords": [
@@ -42,5 +43,12 @@
     "oxc"
   ],
   "author": "ubugeeei",
-  "license": "MIT"
-}
+  "license": "MIT",
+  "optionalDependencies": {
+    "@ox-content/binding-darwin-x64": "0.3.0-alpha.11",
+    "@ox-content/binding-darwin-arm64": "0.3.0-alpha.11",
+    "@ox-content/binding-linux-x64-gnu": "0.3.0-alpha.11",
+    "@ox-content/binding-linux-arm64-gnu": "0.3.0-alpha.11",
+    "@ox-content/binding-win32-x64-msvc": "0.3.0-alpha.11"
+  }
+}