@ox-content/napi 1.0.0-alpha.0 → 2.0.0

package/index.d.ts

@@ -15,6 +15,9 @@ export declare function buildSearchIndex(documents: Array<JsSearchDocument>): st
  */
 export declare function checkI18n(dictDir: string, usedKeys: Array<string>): I18NCheckResult
 
+/** Extracts documented declarations from a JavaScript/TypeScript file using Oxc. */
+export declare function extractFileDocs(filePath: string, includePrivate?: boolean | undefined | null): Array<JsSourceDocItem>
+
 /**
  * Extracts searchable content from Markdown source.
  *
@@ -126,6 +129,8 @@ export interface JsHeroConfig {
   text?: string
   /** Tagline. */
   tagline?: string
+  /** Optional notice shown in the hero. */
+  notice?: JsHeroNotice
   /** Hero image. */
   image?: JsHeroImage
   /** Action buttons. */
@@ -136,6 +141,10 @@ export interface JsHeroConfig {
 export interface JsHeroImage {
   /** Image source URL. */
   src: string
+  /** Light mode image source URL. */
+  lightSrc?: string
+  /** Dark mode image source URL. */
+  darkSrc?: string
   /** Alt text. */
   alt?: string
   /** Image width. */
@@ -144,6 +153,14 @@ export interface JsHeroImage {
   height?: number
 }
 
+/** Hero notice for entry page. */
+export interface JsHeroNotice {
+  /** Notice title. */
+  title?: string
+  /** Notice paragraphs. */
+  body?: Array<string>
+}
+
 /** Locale information for the locale switcher. */
 export interface JsLocaleInfo {
   /** BCP 47 locale tag. */
@@ -252,6 +269,37 @@ export interface JsSocialLinks {
   discord?: string
 }
 
+/** Source documentation item extracted from a JS/TS file. */
+export interface JsSourceDocItem {
+  name: string
+  kind: string
+  doc?: string
+  jsdoc?: string
+  sourcePath: string
+  line: number
+  endLine: number
+  exported: boolean
+  signature?: string
+  params: Array<JsSourceDocParam>
+  returnType?: string
+  tags: Array<JsSourceDocTag>
+}
+
+/** Parameter documentation extracted from source code. */
+export interface JsSourceDocParam {
+  name: string
+  typeAnnotation?: string
+  optional: boolean
+  defaultValue?: string
+  description?: string
+}
+
+/** Raw JSDoc tag extracted from source code. */
+export interface JsSourceDocTag {
+  tag: string
+  value: string
+}
+
 /** SSG configuration. */
 export interface JsSsgConfig {
   /** Site name. */
@@ -332,6 +380,8 @@ export interface JsThemeConfig {
   darkColors?: JsThemeColors
   /** Font configuration. */
   fonts?: JsThemeFonts
+  /** Entry page configuration. */
+  entryPage?: JsThemeEntryPage
   /** Layout configuration. */
   layout?: JsThemeLayout
   /** Header configuration. */
@@ -370,6 +420,12 @@ export interface JsThemeEmbed {
   footer?: string
 }
 
+/** Entry page theme configuration for JavaScript. */
+export interface JsThemeEntryPage {
+  /** Landing page presentation mode. */
+  mode?: string
+}
+
 /** Theme fonts for JavaScript. */
 export interface JsThemeFonts {
   /** Sans-serif font stack. */
@@ -390,6 +446,12 @@ export interface JsThemeFooter {
 export interface JsThemeHeader {
   /** Logo image URL. */
   logo?: string
+  /** Light mode logo image URL. */
+  logoLight?: string
+  /** Dark mode logo image URL. */
+  logoDark?: string
+  /** Whether to render the site name text next to the logo. */
+  showSiteNameText?: boolean
   /** Logo width in pixels. */
   logoWidth?: number
   /** Logo height in pixels. */
@@ -428,6 +490,14 @@ export interface JsTransformOptions {
   baseUrl?: string
   /** Source file path for relative link resolution. */
   sourcePath?: string
+  /** Enable line annotations for code blocks using fence meta. */
+  codeAnnotations?: boolean
+  /** Fence meta key used to read code annotations. */
+  codeAnnotationMetaKey?: string
+  /** Code annotation syntax mode. */
+  codeAnnotationSyntax?: string
+  /** Enable line numbers for all code blocks by default. */
+  codeAnnotationDefaultLineNumbers?: boolean
 }
 
 /**
@@ -446,6 +516,9 @@ export declare function loadDictionaries(dir: string): I18NLoadResult
  */
 export declare function loadDictionariesFlat(dir: string): Record<string, Record<string, string>>
 
+/** Restores code block metadata after JavaScript-side syntax highlighting. */
+export declare function mergeHighlightedCodeBlocks(originalHtml: string, highlightedHtml: string): string
+
 /** Mermaid transform result. */
 export interface MermaidTransformResult {
   /** The transformed HTML with mermaid code blocks replaced by rendered SVGs. */

package/index.js

@@ -1,22 +1,22 @@
-const { existsSync } = require("fs")
-const path = require("path")
+const { existsSync } = require("fs");
+const path = require("path");
 
 function loadBinding() {
   // 1. Try loading the local binary (napi build output)
-  const napiOutput = path.join(__dirname, "ox-content.node")
+  const napiOutput = path.join(__dirname, "ox-content.node");
   if (existsSync(napiOutput)) {
-    return require(napiOutput)
+    return require(napiOutput);
   }
 
   // 1b. Legacy: index.node (napi-rs v2)
-  const localBinary = path.join(__dirname, "index.node")
+  const localBinary = path.join(__dirname, "index.node");
   if (existsSync(localBinary)) {
-    return require(localBinary)
+    return require(localBinary);
   }
 
   // 2. Try platform-specific binary in same directory (CI build artifact)
-  const platform = process.platform
-  const arch = process.arch
+  const platform = process.platform;
+  const arch = process.arch;
 
   const platforms = {
     "darwin-arm64": "ox-content.darwin-arm64.node",
@@ -24,22 +24,22 @@ function loadBinding() {
     "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
+  let key;
   if (platform === "darwin") {
-    key = `darwin-${arch}`
+    key = `darwin-${arch}`;
   } else if (platform === "linux") {
-    key = `linux-${arch}-gnu`
+    key = `linux-${arch}-gnu`;
   } else if (platform === "win32") {
-    key = `win32-${arch}-msvc`
+    key = `win32-${arch}-msvc`;
   }
 
-  const binaryName = platforms[key]
+  const binaryName = platforms[key];
   if (binaryName) {
-    const binaryPath = path.join(__dirname, binaryName)
+    const binaryPath = path.join(__dirname, binaryName);
     if (existsSync(binaryPath)) {
-      return require(binaryPath)
+      return require(binaryPath);
     }
   }
 
@@ -50,40 +50,41 @@ function loadBinding() {
     "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]
+  const subPackage = subPackages[key];
   if (subPackage) {
     try {
-      return require(subPackage)
+      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.`,
-  )
+      `If you're working from the repository, run 'nix develop -c vp run build:napi' from the repository root.`,
+  );
 }
 
-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.transformMermaid = binding.transformMermaid
-module.exports.loadDictionaries = binding.loadDictionaries
-module.exports.loadDictionariesFlat = binding.loadDictionariesFlat
-module.exports.validateMf2 = binding.validateMf2
-module.exports.checkI18n = binding.checkI18n
-module.exports.extractTranslationKeys = binding.extractTranslationKeys
+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.extractFileDocs = binding.extractFileDocs;
+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;
+module.exports.loadDictionaries = binding.loadDictionaries;
+module.exports.loadDictionariesFlat = binding.loadDictionariesFlat;
+module.exports.validateMf2 = binding.validateMf2;
+module.exports.checkI18n = binding.checkI18n;
+module.exports.extractTranslationKeys = binding.extractTranslationKeys;

package/package.json

@@ -1,13 +1,38 @@
 {
   "name": "@ox-content/napi",
-  "version": "1.0.0-alpha.0",
+  "version": "2.0.0",
   "description": "Node.js bindings for Ox Content - High-performance Markdown parser",
-  "main": "index.js",
-  "types": "index.d.ts",
+  "keywords": [
+    "markdown",
+    "napi",
+    "oxc",
+    "parser",
+    "rust"
+  ],
+  "license": "MIT",
+  "author": "ubugeeei",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ubugeeei/ox-content.git",
+    "directory": "crates/ox_content_napi"
+  },
   "files": [
     "index.js",
     "index.d.ts"
   ],
+  "main": "index.js",
+  "types": "index.d.ts",
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "scripts": {
+    "build": "napi build --release",
+    "build:debug": "napi build"
+  },
+  "devDependencies": {
+    "@napi-rs/cli": "^3.5.1"
+  },
   "napi": {
     "binaryName": "ox-content",
     "packageName": "@ox-content/binding",
@@ -19,36 +44,11 @@
       "x86_64-pc-windows-msvc"
     ]
   },
-  "scripts": {
-    "build": "napi build --release",
-    "build:debug": "napi build"
-  },
-  "devDependencies": {
-    "@napi-rs/cli": "^3.5.1"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/ubugeeei/ox-content.git",
-    "directory": "crates/ox_content_napi"
-  },
-  "publishConfig": {
-    "provenance": true,
-    "access": "public"
-  },
-  "keywords": [
-    "markdown",
-    "parser",
-    "napi",
-    "rust",
-    "oxc"
-  ],
-  "author": "ubugeeei",
-  "license": "MIT",
   "optionalDependencies": {
-    "@ox-content/binding-darwin-x64": "1.0.0-alpha.0",
-    "@ox-content/binding-darwin-arm64": "1.0.0-alpha.0",
-    "@ox-content/binding-linux-x64-gnu": "1.0.0-alpha.0",
-    "@ox-content/binding-linux-arm64-gnu": "1.0.0-alpha.0",
-    "@ox-content/binding-win32-x64-msvc": "1.0.0-alpha.0"
+    "@ox-content/binding-darwin-x64": "2.0.0",
+    "@ox-content/binding-darwin-arm64": "2.0.0",
+    "@ox-content/binding-linux-x64-gnu": "2.0.0",
+    "@ox-content/binding-linux-arm64-gnu": "2.0.0",
+    "@ox-content/binding-win32-x64-msvc": "2.0.0"
   }
 }