@ox-content/napi 2.15.0 → 2.25.0

package/index.d.ts

@@ -54,6 +54,9 @@ export declare function collectSsgMarkdownFiles(srcDir: string, extensions: Arra
 /** Extracts shared CSS and JavaScript assets from generated SSG pages. */
 export declare function externalizeSsgAssets(pages: Array<JsSsgGeneratedHtmlPage>, outDir: string, base: string): JsSsgExternalizedAssets
 
+/** Extracts normalized documentation entries from source directories using Oxc. */
+export declare function extractDocsFromDirectories(srcDirs: Array<string>, include: Array<string>, exclude: Array<string>, includePrivate?: boolean | undefined | null, includeInternal?: boolean | undefined | null): Array<JsExtractedDocsModule>
+
 /** Extracts generated API docs grouped by public entry points. */
 export declare function extractDocsFromEntryPoints(entryPoints: Array<JsEntryPointSpec>, options?: JsEntryPointDocsOptions | undefined | null): Array<JsEntrypointDocsModule>
 
@@ -95,6 +98,14 @@ export declare function generateDocsNavCode(navItems: Array<JsDocsNavItem>, expo
 /** Generates sidebar navigation metadata from documentation file paths. */
 export declare function generateDocsNavMetadata(files: Array<string>, basePath?: string | undefined | null): Array<JsDocsNavItem>
 
+/**
+ * Generates sidebar navigation metadata from extracted documentation modules.
+ *
+ * Use this when the output `pathStrategy` is `"typedoc"` so that the navigation
+ * tree mirrors the nested module/category/symbol pages.
+ */
+export declare function generateDocsNavMetadataFromDocs(docs: Array<JsDocsMarkdownModule>, options?: JsDocsNavOptions | undefined | null): Array<JsDocsNavItem>
+
 /** Generates the `virtual:ox-content/i18n` runtime module. */
 export declare function generateI18nModule(dictDir: string, config: JsI18NRuntimeConfig): string
 
@@ -232,6 +243,16 @@ export interface JsDocReturn {
   description: string
 }
 
+/** Diagnostic for an entry point export during docs extraction. */
+export interface JsDocsDiagnostic {
+  code: string
+  entrypoint: string
+  exportName: string
+  exportKind: string
+  source: JsExportSource
+  message: string
+}
+
 /** Documentation entry used by generated API Markdown. */
 export interface JsDocsMarkdownEntry {
   name: string
@@ -259,6 +280,9 @@ export interface JsDocsMarkdownModule {
 export interface JsDocsMarkdownOptions {
   groupBy?: string
   githubUrl?: string
+  linkStyle?: 'markdown' | 'clean'
+  basePath?: string
+  pathStrategy?: 'flat' | 'typedoc'
 }
 
 /** Ordered JSDoc tag used by generated API Markdown. */
@@ -274,6 +298,21 @@ export interface JsDocsNavItem {
   children?: Array<JsDocsNavItem>
 }
 
+/** Options for generating sidebar navigation metadata from extracted docs. */
+export interface JsDocsNavOptions {
+  basePath?: string
+  pathStrategy?: 'flat' | 'typedoc'
+}
+
+/** Options for writing generated API documentation files. */
+export interface JsDocsOutputOptions {
+  generateNav?: boolean
+  groupBy?: string
+  generatedAt?: string
+  basePath?: string
+  pathStrategy?: 'flat' | 'typedoc'
+}
+
 /** Entry page configuration. */
 export interface JsEntryPageConfig {
   /** Hero section. */
@@ -289,6 +328,7 @@ export interface JsEntrypointDocsModule {
   sourcePath: string
   entries: Array<JsDocEntry>
   exports: Array<JsPublicExport>
+  diagnostics: Array<JsDocsDiagnostic>
 }
 
 /** Options for extracting docs grouped by entry point. */
@@ -297,6 +337,8 @@ export interface JsEntryPointDocsOptions {
   tsconfig?: string
   private?: boolean
   internal?: boolean
+  externalDocs?: boolean
+  externalPackageSources?: Array<JsExternalPackageSource>
 }
 
 /** Public entry point module. */
@@ -323,10 +365,23 @@ export interface JsExportSource {
   kind: string
   module?: string
   package?: string
+  specifier?: string
   originalName: string
   typeOnly: boolean
 }
 
+/** Explicit source entry for an external package. */
+export interface JsExternalPackageSource {
+  package: string
+  entry: string
+}
+
+/** Extracted docs for one source file returned to JavaScript callers. */
+export interface JsExtractedDocsModule {
+  file: string
+  entries: Array<JsDocEntry>
+}
+
 /** Feature card for entry page. */
 export interface JsFeatureConfig {
   /** Icon - supports: "mdi:icon-name" (Iconify), image URL, or emoji. */
@@ -345,6 +400,8 @@ export interface JsFeatureConfig {
 export interface JsGraphOptions {
   root?: string
   tsconfig?: string
+  externalDocs?: boolean
+  externalPackageSources?: Array<JsExternalPackageSource>
 }
 
 /** Hero action for entry page. */
@@ -943,6 +1000,22 @@ export interface JsTransformOptions {
   codeAnnotationSyntax?: string
   /** Enable line numbers for all code blocks by default. */
   codeAnnotationDefaultLineNumbers?: boolean
+  /**
+   * Auto-link bare URLs in text. When enabled, the renderer wraps any
+   * text occurrence starting with a registered pattern (default `http://`
+   * and `https://`) in an `<a>` tag.
+   */
+  autolinkUrls?: boolean
+  /**
+   * URL prefix patterns for [`Self::autolink_urls`]. Overrides the
+   * default `["http://", "https://"]` when set.
+   */
+  autolinkPatterns?: Array<string>
+  /**
+   * Add `target="_blank" rel="noopener noreferrer"` to auto-linked URLs.
+   * Defaults to true; ignored when [`Self::autolink_urls`] is off.
+   */
+  autolinkTargetBlank?: boolean
 }
 
 export declare function lintMarkdown(source: string, options?: JsMarkdownLintOptions | undefined | null): JsMarkdownLintResult
@@ -989,6 +1062,9 @@ export interface Mf2ValidateResult {
   astJson?: string
 }
 
+/** Normalizes VitePress-specific frontmatter into ox-content's entry-page shape. */
+export declare function normalizeVitePressFrontmatter(frontmatter: any): any
+
 /**
  * Parses Markdown source into an AST.
  *
@@ -1131,5 +1207,8 @@ export declare function validateMf2(message: string): Mf2ValidateResult
 /** Returns the version of ox_content_napi. */
 export declare function version(): string
 
+/** Writes generated API documentation files and native sidecars. */
+export declare function writeGeneratedDocs(docs: Record<string, string>, outDir: string, extractedDocs?: Array<JsDocsMarkdownModule> | undefined | null, options?: JsDocsOutputOptions | undefined | null): void
+
 /** Writes a serialized search index to `search-index.json` under an output directory. */
 export declare function writeSearchIndex(indexJson: string, outDir: string): void

package/index.js

@@ -86,12 +86,15 @@ module.exports.version = binding.version;
 module.exports.extractFileDocs = binding.extractFileDocs;
 module.exports.extractFileDocEntries = binding.extractFileDocEntries;
 module.exports.buildExportGraph = binding.buildExportGraph;
+module.exports.extractDocsFromDirectories = binding.extractDocsFromDirectories;
 module.exports.extractDocsFromEntryPoints = binding.extractDocsFromEntryPoints;
 module.exports.generateDocsNavMetadata = binding.generateDocsNavMetadata;
+module.exports.generateDocsNavMetadataFromDocs = binding.generateDocsNavMetadataFromDocs;
 module.exports.generateDocsNavCode = binding.generateDocsNavCode;
 module.exports.collectDocsSourceFiles = binding.collectDocsSourceFiles;
 module.exports.generateDocsDataJson = binding.generateDocsDataJson;
 module.exports.generateDocsMarkdown = binding.generateDocsMarkdown;
+module.exports.writeGeneratedDocs = binding.writeGeneratedDocs;
 module.exports.mergeHighlightedCodeBlocks = binding.mergeHighlightedCodeBlocks;
 module.exports.generateOgImageSvg = binding.generateOgImageSvg;
 module.exports.buildSearchIndex = binding.buildSearchIndex;
@@ -105,6 +108,7 @@ module.exports.matchesSearchScopes = binding.matchesSearchScopes;
 module.exports.generateSearchModule = binding.generateSearchModule;
 module.exports.generateSearchModuleFromOptions = binding.generateSearchModuleFromOptions;
 module.exports.collectSearchMarkdownFiles = binding.collectSearchMarkdownFiles;
+module.exports.normalizeVitePressFrontmatter = binding.normalizeVitePressFrontmatter;
 module.exports.generateSsgHtml = binding.generateSsgHtml;
 module.exports.generateSsgBareHtml = binding.generateSsgBareHtml;
 module.exports.getGitLastUpdated = binding.getGitLastUpdated;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ox-content/napi",
-  "version": "2.15.0",
+  "version": "2.25.0",
   "description": "Node.js bindings for Ox Content - High-performance Markdown parser",
   "keywords": [
     "markdown",
@@ -13,7 +13,7 @@
   "author": "ubugeeei",
   "repository": {
     "type": "git",
-    "url": "https://github.com/ubugeeei/ox-content.git",
+    "url": "https://github.com/ubugeeei-prod/ox-content.git",
     "directory": "crates/ox_content_napi"
   },
   "files": [
@@ -45,10 +45,10 @@
     ]
   },
   "optionalDependencies": {
-    "@ox-content/binding-darwin-x64": "2.15.0",
-    "@ox-content/binding-darwin-arm64": "2.15.0",
-    "@ox-content/binding-linux-x64-gnu": "2.15.0",
-    "@ox-content/binding-linux-arm64-gnu": "2.15.0",
-    "@ox-content/binding-win32-x64-msvc": "2.15.0"
+    "@ox-content/binding-darwin-x64": "2.25.0",
+    "@ox-content/binding-darwin-arm64": "2.25.0",
+    "@ox-content/binding-linux-x64-gnu": "2.25.0",
+    "@ox-content/binding-linux-arm64-gnu": "2.25.0",
+    "@ox-content/binding-win32-x64-msvc": "2.25.0"
   }
 }