@ox-content/napi 3.0.0-alpha.4 → 3.0.0-alpha.6

package/index.d.ts

@@ -196,7 +196,7 @@ export declare function generateSsgBareHtml(content: string, title: string): str
 export declare function generateSsgBarePage(page: JsSsgBarePage): string
 
 /** Generates SSG HTML page with navigation and search. */
-export declare function generateSsgHtml(pageData: JsSsgPageData, navGroups: Array<JsSsgNavGroup>, config: JsSsgConfig): string
+export declare function generateSsgHtml(pageData: JsSsgPageData, navGroups: Array<JsSsgNavGroup>, config: JsSsgConfig): JsSsgHtmlResult
 
 /** Returns unique git authors for a file. Empty when git is missing or fails. */
 export declare function getGitContributors(filePath: string, root?: string | undefined | null): Array<JsGitContributor>
@@ -922,6 +922,12 @@ export interface JsGraphOptions {
   externalPackageSources?: Array<JsExternalPackageSource>
 }
 
+/** One page-head validation finding. */
+export interface JsHeadDiagnostic {
+  strict: boolean
+  message: string
+}
+
 /** Header nav link or dropdown. */
 export interface JsHeaderNavItem {
   /** Display label. */
@@ -1080,6 +1086,8 @@ export interface JsJsonLd {
   publisher?: JsJsonLdPublisher
   /** Site origin used for `@id` / `url`. */
   siteUrl?: string
+  pageType?: string
+  graph?: Array<string>
 }
 
 /** Optional JSON-LD publisher. Only configured fields are emitted. */
@@ -1110,6 +1118,52 @@ export interface JsLocalePath {
   root?: string
 }
 
+/** One configured magic-link alias. */
+export interface JsMagicLinkAlias {
+  /** Absolute `http:` / `https:` URL. */
+  href: string
+  /** Optional display label. Defaults to the alias key. */
+  label?: string
+  /** Optional avatar or favicon URL. */
+  image?: string
+}
+
+/** Replace the resolved image for matching hrefs. */
+export interface JsMagicLinkImageOverride {
+  /** Exact href to replace. */
+  href?: string
+  /** Href prefix to replace. */
+  prefix?: string
+  /** Replacement image URL. Must be `http:` or `https:`. */
+  image: string
+}
+
+/** Opt-in `{link:...}` rich magic links. */
+export interface JsMagicLinkOptions {
+  /**
+   * Enable `{link:@user}`, `{link:alias}`, and `{link:label|url}`.
+   *
+   * Default: `false`.
+   */
+  enabled?: boolean
+  /** Named aliases mapped to href / label / image. */
+  aliases?: Record<string, JsMagicLinkAlias>
+  /**
+   * Emit a favicon URL for explicit links that have no image.
+   *
+   * Default: `false`. No transform-time network request.
+   */
+  favicon?: boolean
+  /**
+   * Favicon URL template with a `{host}` placeholder.
+   *
+   * Default: `https://{host}/favicon.ico` when `favicon` is true.
+   */
+  faviconTemplate?: string
+  /** Image replacements applied after alias / GitHub / favicon resolution. */
+  imageOverrides?: Array<JsMagicLinkImageOverride>
+}
+
 export interface JsMarkdownLintDiagnostic {
   ruleId: string
   severity: string
@@ -1600,14 +1654,12 @@ export interface JsSsgBarePage {
 
 /** SSG configuration. */
 export interface JsSsgConfig {
-  /** Site name. */
   siteName: string
-  /** Base URL path. */
   base: string
-  /** Optional site-root href for breadcrumbs. */
   breadcrumbRootHref?: string
-  /** OG image URL. */
   ogImage?: string
+  siteUrl?: string
+  headValidation?: string
   /** Theme configuration. */
   theme?: JsThemeConfig
   /** Current locale for this page. */
@@ -1660,6 +1712,12 @@ export interface JsSsgGeneratedHtmlPage {
   html: string
 }
 
+/** Themed SSG HTML plus page-head diagnostics. */
+export interface JsSsgHtmlResult {
+  html: string
+  diagnostics: Array<JsHeadDiagnostic>
+}
+
 /** Navigation group for SSG. */
 export interface JsSsgNavGroup {
   /** Group title. */
@@ -1724,6 +1782,10 @@ export interface JsSsgPageData {
   layout?: string
   /** Per-page chrome flags. Honored only when page chrome is enabled. */
   chrome?: JsPageChromeFlags
+  /** Frontmatter `robots`. */
+  robots?: string
+  /** Frontmatter `canonical`. */
+  canonical?: string
 }
 
 /** Resolved SSG output and public route paths. */
@@ -1850,15 +1912,15 @@ export interface JsThemeConfig {
   aside?: boolean
   /** Breadcrumb trail from the site root through sidebar ancestors. */
   breadcrumbs?: boolean
+  /** Heading permalink visibility. `"hover"` or `"always"`. CSS only. */
+  headingPermalink?: string
   /** Light mode colors. */
   colors?: JsThemeColors
   /** Dark mode colors. */
   darkColors?: JsThemeColors
-  /** Font configuration. */
   fonts?: JsThemeFonts
   /** Entry page configuration. */
   entryPage?: JsThemeEntryPage
-  /** Layout configuration. */
   layout?: JsThemeLayout
   /** Header configuration. */
   header?: JsThemeHeader
@@ -1973,6 +2035,12 @@ export interface JsTransformOptions {
    * Default: `false`, or `true` when `gfm` is `true`.
    */
   footnotes?: boolean
+  /**
+   * Render footnotes as a semantic ordered section with numeric markers.
+   *
+   * Default: `false`.
+   */
+  semanticFootnotes?: boolean
   /**
    * Enable GFM task-list item markers.
    *
@@ -2072,6 +2140,12 @@ export interface JsTransformOptions {
    * Default: `true`; ignored when [`Self::autolink_urls`] is off.
    */
   autolinkTargetBlank?: boolean
+  /**
+   * Opt-in visible heading permalinks (`<a class="header-anchor" href="#id">`).
+   *
+   * Default: disabled. Existing HTML stays unchanged until this is enabled.
+   */
+  headingPermalinks?: boolean
   /**
    * Opt-in Obsidian-style wiki links.
    *
@@ -2152,6 +2226,12 @@ export interface JsTransformOptions {
    * Default: disabled.
    */
   badges?: JsBadgeOptions
+  /**
+   * Opt-in `{link:...}` rich magic links.
+   *
+   * Default: disabled.
+   */
+  magicLinks?: JsMagicLinkOptions
   /**
    * Opt-in figures, captions, and lazy images.
    *
@@ -2371,6 +2451,9 @@ export declare function render(astJson: string): RenderResult
  */
 export declare function renderFrameworkComponentCode(html: string, target: string, islands?: Array<JsFrameworkComponentIsland> | undefined | null, mode?: string | undefined | null): string
 
+/** Resolve Unhead-compatible page-head descriptors to HTML. */
+export declare function renderHead(inputJson: string): JsSsgHtmlResult
+
 /** Render result containing the HTML output. */
 export interface RenderResult {
   /** The rendered HTML. */

package/index.js

@@ -209,6 +209,7 @@ module.exports.generateSearchModuleFromOptions = binding.generateSearchModuleFro
 module.exports.collectSearchMarkdownFiles = binding.collectSearchMarkdownFiles;
 module.exports.normalizeVitePressFrontmatter = binding.normalizeVitePressFrontmatter;
 module.exports.generateSsgHtml = binding.generateSsgHtml;
+module.exports.renderHead = binding.renderHead;
 module.exports.generateSsgBareHtml = binding.generateSsgBareHtml;
 module.exports.highlightCodeBlock = binding.highlightCodeBlock;
 module.exports.applyPendingHighlights = binding.applyPendingHighlights;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ox-content/napi",
-  "version": "3.0.0-alpha.4",
+  "version": "3.0.0-alpha.6",
   "description": "Node.js bindings for Ox Content - High-performance Markdown parser",
   "keywords": [
     "markdown",
@@ -47,12 +47,12 @@
     ]
   },
   "optionalDependencies": {
-    "@ox-content/binding-darwin-x64": "3.0.0-alpha.4",
-    "@ox-content/binding-darwin-arm64": "3.0.0-alpha.4",
-    "@ox-content/binding-linux-x64-gnu": "3.0.0-alpha.4",
-    "@ox-content/binding-linux-x64-musl": "3.0.0-alpha.4",
-    "@ox-content/binding-linux-arm64-gnu": "3.0.0-alpha.4",
-    "@ox-content/binding-linux-arm64-musl": "3.0.0-alpha.4",
-    "@ox-content/binding-win32-x64-msvc": "3.0.0-alpha.4"
+    "@ox-content/binding-darwin-x64": "3.0.0-alpha.6",
+    "@ox-content/binding-darwin-arm64": "3.0.0-alpha.6",
+    "@ox-content/binding-linux-x64-gnu": "3.0.0-alpha.6",
+    "@ox-content/binding-linux-x64-musl": "3.0.0-alpha.6",
+    "@ox-content/binding-linux-arm64-gnu": "3.0.0-alpha.6",
+    "@ox-content/binding-linux-arm64-musl": "3.0.0-alpha.6",
+    "@ox-content/binding-win32-x64-msvc": "3.0.0-alpha.6"
   }
 }