@ox-content/napi 3.0.0-alpha.1 → 3.0.0-alpha.3

package/index.d.ts

@@ -198,6 +198,9 @@ 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
 
+/** 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>
+
 /** Returns the last git commit timestamp for a file in milliseconds. */
 export declare function getGitLastUpdated(filePath: string, root?: string | undefined | null): number | null
 
@@ -872,6 +875,26 @@ export interface JsFileTreeOptions {
    * Default: `false`.
    */
   enabled?: boolean
+  /**
+   * Open directory `<details>` by default.
+   *
+   * Default: `true`.
+   */
+  defaultOpen?: boolean
+  /**
+   * Render folder and file icons.
+   *
+   * Default: `true`.
+   */
+  icons?: boolean
+  /** Trusted SVG markup or class tokens for collapsed folders. */
+  iconFolder?: string
+  /** Trusted SVG markup or class tokens for open folders. */
+  iconFolderOpen?: string
+  /** Trusted SVG markup or class tokens for files. */
+  iconFile?: string
+  /** Trusted SVG markup or class tokens keyed by file extension. */
+  iconFiles?: Record<string, string>
 }
 
 export interface JsFrameworkComponentIsland {
@@ -881,6 +904,16 @@ export interface JsFrameworkComponentIsland {
   content?: string
 }
 
+/** One unique git author returned by `getGitContributors`. */
+export interface JsGitContributor {
+  /** Author name from `%an`. */
+  name: string
+  /** Author email from `%ae`. Never rendered into `href`. */
+  email?: string
+  /** Number of commits attributed to this author on the file. */
+  commits?: number
+}
+
 /** Export graph resolution options. */
 export interface JsGraphOptions {
   root?: string
@@ -1039,6 +1072,24 @@ export interface JsIncrementalRenderOptions {
   completeInline?: boolean
 }
 
+/** Opt-in JSON-LD structured data. Presence of the object enables the feature. */
+export interface JsJsonLd {
+  /** When false, omit BreadcrumbList even if a visible trail exists. */
+  breadcrumbs?: boolean
+  /** Optional publisher. Missing fields are not invented. */
+  publisher?: JsJsonLdPublisher
+  /** Site origin used for `@id` / `url`. */
+  siteUrl?: string
+}
+
+/** Optional JSON-LD publisher. Only configured fields are emitted. */
+export interface JsJsonLdPublisher {
+  /** Organization name. */
+  name?: string
+  /** Organization URL. Unsafe schemes are dropped. */
+  url?: string
+}
+
 /** Locale information for the locale switcher. */
 export interface JsLocaleInfo {
   /** BCP 47 locale tag. */
@@ -1425,6 +1476,16 @@ export interface JsSearchRuntimeOptions {
   hotkey: string
 }
 
+/** One child link on a generated section index. */
+export interface JsSectionIndexItem {
+  /** Visible title. Escaped in HTML. */
+  title: string
+  /** Destination. `javascript:` and other schemes are rejected. */
+  href: string
+  /** Optional card description. Escaped in HTML. */
+  description?: string
+}
+
 /** Custom social link for JavaScript. */
 export interface JsSocialLink {
   /** Icon label. */
@@ -1569,6 +1630,16 @@ export interface JsSsgConfig {
   team?: JsTeamOptions
   /** When true, honor per-page frontmatter chrome flags. */
   pageChrome?: boolean
+  /** Opt-in JSON-LD structured data. Presence enables the feature. */
+  jsonLd?: JsJsonLd
+}
+
+/** One rendered git author on an SSG page. */
+export interface JsSsgContributor {
+  /** Display name. Escaped in HTML. */
+  name: string
+  /** Optional `https:` avatar URL. Emails are never accepted here. */
+  avatar?: string
 }
 
 /** Result of SSG shared asset extraction. */
@@ -1637,6 +1708,8 @@ export interface JsSsgPageData {
   toc: Array<TocEntry>
   /** Last updated timestamp in milliseconds since the Unix epoch. */
   lastUpdated?: number
+  /** Unique git authors for this page. Empty unless the site opted in. */
+  contributors?: Array<JsSsgContributor>
   /** URL path. */
   path: string
   /** Entry page configuration (if layout: entry). */
@@ -2186,6 +2259,24 @@ export declare function loadDictionariesFlat(dir: string): Record<string, Record
 /** Returns true when a document belongs to at least one requested search scope. */
 export declare function matchesSearchScopes(id: string, url: string, scopes: Array<string>): boolean
 
+/** One `import` statement collected from MDX ESM. */
+export interface MdxImport {
+  /** Module specifier string. */
+  source: string
+  /** Bindings created by the import. */
+  specifiers: Array<MdxImportSpecifier>
+}
+
+/** How a specifier was imported. */
+export interface MdxImportSpecifier {
+  /** Imported name (`default`, `*`, or the named export). */
+  imported: string
+  /** Local binding name. */
+  local: string
+  /** `default`, `named`, or `namespace`. */
+  kind: 'default' | 'named' | 'namespace'
+}
+
 /** Restores code block metadata after JavaScript-side syntax highlighting. */
 export declare function mergeHighlightedCodeBlocks(originalHtml: string, highlightedHtml: string): string
 
@@ -2288,6 +2379,9 @@ export interface RenderResult {
   errors: Array<string>
 }
 
+/** Renders escaped section-index listing HTML. Hostile hrefs are dropped. */
+export declare function renderSsgSectionIndex(title: string, items: Array<JsSectionIndexItem>, style: string): string
+
 /** Resolves manual SSG navigation groups. */
 export declare function resolveSsgNavigationGroups(navigation: Array<JsSsgNavigationGroup>, base: string, extension: string): Array<JsSsgNavGroup>
 
@@ -2354,7 +2448,7 @@ export declare function transformMermaid(html: string, mmdcPath: string): Mermai
  */
 export declare function transformPmEmbeds(html: string, startGroup: number, options?: JsPmOptions | undefined | null): JsPmTransformResult
 
-/** Transform result containing HTML, frontmatter, and TOC. */
+/** Transform result containing HTML, frontmatter, TOC, and MDX metadata. */
 export interface TransformResult {
   /** The rendered HTML. */
   html: string
@@ -2364,6 +2458,12 @@ export interface TransformResult {
   toc: Array<TocEntry>
   /** Parse/render errors, if any. */
   errors: Array<string>
+  /** MDX `import` statements (empty when MDX is off or no ESM nodes). */
+  imports: Array<MdxImport>
+  /** Export names from MDX ESM (empty when MDX is off or no exports). */
+  exports: Array<string>
+  /** Unique JSX component names in document order (empty when none). */
+  components: Array<string>
 }
 
 /**

package/index.js

@@ -218,6 +218,7 @@ module.exports.supportsHighlightLanguage = binding.supportsHighlightLanguage;
 module.exports.nativeHighlightLanguages = binding.nativeHighlightLanguages;
 module.exports.generateSsgBarePage = binding.generateSsgBarePage;
 module.exports.getGitLastUpdated = binding.getGitLastUpdated;
+module.exports.getGitContributors = binding.getGitContributors;
 module.exports.resolveSsgRoutePaths = binding.resolveSsgRoutePaths;
 module.exports.getSsgOutputPath = binding.getSsgOutputPath;
 module.exports.getSsgUrlPath = binding.getSsgUrlPath;
@@ -239,4 +240,5 @@ module.exports.checkI18n = binding.checkI18n;
 module.exports.checkI18nProject = binding.checkI18nProject;
 module.exports.extractTranslationKeys = binding.extractTranslationKeys;
 module.exports.renderFrameworkComponentCode = binding.renderFrameworkComponentCode;
+module.exports.renderSsgSectionIndex = binding.renderSsgSectionIndex;
 module.exports.escapeSvelteMarkup = binding.escapeSvelteMarkup;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ox-content/napi",
-  "version": "3.0.0-alpha.1",
+  "version": "3.0.0-alpha.3",
   "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.1",
-    "@ox-content/binding-darwin-arm64": "3.0.0-alpha.1",
-    "@ox-content/binding-linux-x64-gnu": "3.0.0-alpha.1",
-    "@ox-content/binding-linux-x64-musl": "3.0.0-alpha.1",
-    "@ox-content/binding-linux-arm64-gnu": "3.0.0-alpha.1",
-    "@ox-content/binding-linux-arm64-musl": "3.0.0-alpha.1",
-    "@ox-content/binding-win32-x64-msvc": "3.0.0-alpha.1"
+    "@ox-content/binding-darwin-x64": "3.0.0-alpha.3",
+    "@ox-content/binding-darwin-arm64": "3.0.0-alpha.3",
+    "@ox-content/binding-linux-x64-gnu": "3.0.0-alpha.3",
+    "@ox-content/binding-linux-x64-musl": "3.0.0-alpha.3",
+    "@ox-content/binding-linux-arm64-gnu": "3.0.0-alpha.3",
+    "@ox-content/binding-linux-arm64-musl": "3.0.0-alpha.3",
+    "@ox-content/binding-win32-x64-msvc": "3.0.0-alpha.3"
   }
 }