@ox-content/napi 2.11.0 → 2.12.0

package/index.d.ts

@@ -7,6 +7,14 @@
  */
 export declare function buildSearchIndex(documents: Array<JsSearchDocument>): string
 
+/**
+ * Builds a search index directly from Markdown files under a source directory.
+ *
+ * File discovery, Markdown parsing, search document extraction, and index
+ * construction all run on the Rust side.
+ */
+export declare function buildSearchIndexFromDirectory(srcDir: string, base: string, extensions: Array<string>): string
+
 /** Builds SSG navigation groups from markdown files. */
 export declare function buildSsgNavItems(markdownFiles: Array<string>, srcDir: string, base: string, extension: string): Array<JsSsgNavGroup>
 
@@ -21,6 +29,25 @@ export declare function buildSsgThemeNavItems(sidebar: Array<JsSsgSidebarItem>,
  */
 export declare function checkI18n(dictDir: string, usedKeys: Array<string>): I18NCheckResult
 
+/**
+ * Runs project-level i18n checks by collecting source keys and validating dictionaries.
+ *
+ * `dict_dir` is the path to the i18n directory with locale subdirectories.
+ * `src_dirs` are source/content directories to scan recursively.
+ * `function_names` are translation call names to collect from JS/TS source.
+ * `default_locale` is used for dictionary fallback rules.
+ */
+export declare function checkI18nProject(dictDir: string, srcDirs: Array<string>, functionNames: Array<string>, defaultLocale: string): I18NCheckResult
+
+/** Collects source files for generated API documentation. */
+export declare function collectDocsSourceFiles(srcDir: string, include: Array<string>, exclude: Array<string>): Array<string>
+
+/** Collects Markdown files for search indexing from a source directory. */
+export declare function collectSearchMarkdownFiles(srcDir: string, extensions: Array<string>): Array<string>
+
+/** Collects Markdown files for SSG from a source directory. */
+export declare function collectSsgMarkdownFiles(srcDir: string, extensions: Array<string>): Array<string>
+
 /** Extracts shared CSS and JavaScript assets from generated SSG pages. */
 export declare function externalizeSsgAssets(pages: Array<JsSsgGeneratedHtmlPage>, outDir: string, base: string): JsSsgExternalizedAssets
 
@@ -50,6 +77,12 @@ export declare function extractTranslationKeys(source: string, filePath: string,
 /** Formats a file or directory segment as an SSG title. */
 export declare function formatSsgTitle(name: string): string
 
+/** Generates the machine-readable docs data JSON payload. */
+export declare function generateDocsDataJson(docs: Array<JsDocsMarkdownModule>, generatedAt: string): string
+
+/** Generates Markdown API reference pages from extracted documentation entries. */
+export declare function generateDocsMarkdown(docs: Array<JsDocsMarkdownModule>, options?: JsDocsMarkdownOptions | undefined | null): Record<string, string>
+
 /** Generates TypeScript source code for documentation navigation metadata. */
 export declare function generateDocsNavCode(navItems: Array<JsDocsNavItem>, exportName?: string | undefined | null): string
 
@@ -70,6 +103,12 @@ export declare function generateOgImageSvg(data: JsOgImageData, config?: JsOgIma
 /** Generates the client-side search runtime module. */
 export declare function generateSearchModule(optionsJson: string, indexPath: string): string
 
+/** Generates the client-side search runtime module from typed options. */
+export declare function generateSearchModuleFromOptions(options: JsSearchRuntimeOptions, indexPath: string): string
+
+/** Generates a bare SSG HTML page without navigation or styles. */
+export declare function generateSsgBareHtml(content: string, title: string): string
+
 /** Generates SSG HTML page with navigation and search. */
 export declare function generateSsgHtml(pageData: JsSsgPageData, navGroups: Array<JsSsgNavGroup>, config: JsSsgConfig): string
 
@@ -168,6 +207,40 @@ export interface JsDocReturn {
   description: string
 }
 
+/** Documentation entry used by generated API Markdown. */
+export interface JsDocsMarkdownEntry {
+  name: string
+  kind: string
+  description: string
+  params?: Array<JsDocParam>
+  returns?: JsDocReturn
+  examples?: Array<string>
+  tags?: Array<JsDocsMarkdownTag>
+  private: boolean
+  file: string
+  line: number
+  endLine: number
+  signature?: string
+}
+
+/** Extracted docs for one source file used by generated API Markdown. */
+export interface JsDocsMarkdownModule {
+  file: string
+  entries: Array<JsDocsMarkdownEntry>
+}
+
+/** Options for generated API Markdown. */
+export interface JsDocsMarkdownOptions {
+  groupBy?: string
+  githubUrl?: string
+}
+
+/** Ordered JSDoc tag used by generated API Markdown. */
+export interface JsDocsMarkdownTag {
+  tag: string
+  value: string
+}
+
 /** Navigation item emitted for generated documentation. */
 export interface JsDocsNavItem {
   title: string
@@ -420,6 +493,20 @@ export interface JsSearchResult {
   snippet: string
 }
 
+/** Resolved search runtime options for JavaScript. */
+export interface JsSearchRuntimeOptions {
+  /** Whether search is enabled. */
+  enabled: boolean
+  /** Maximum number of results. */
+  limit: number
+  /** Enable prefix matching. */
+  prefix: boolean
+  /** Search input placeholder. */
+  placeholder: string
+  /** Keyboard shortcut to focus search. */
+  hotkey: string
+}
+
 /** Custom social link for JavaScript. */
 export interface JsSocialLink {
   /** Icon label. */
@@ -481,6 +568,18 @@ export interface JsSourceOptions {
   frontmatter?: boolean
 }
 
+/** Source offset where prepared Markdown content begins in the original source. */
+export interface JsSourceOrigin {
+  /** UTF-8 byte offset. */
+  byteOffset: number
+  /** UTF-16 code-unit offset. */
+  offset: number
+  /** 1-based line number. */
+  line: number
+  /** 1-based column number. */
+  column: number
+}
+
 /** SSG configuration. */
 export interface JsSsgConfig {
   /** Site name. */
@@ -524,6 +623,19 @@ export interface JsSsgNavGroup {
   collapsed?: boolean
 }
 
+/** Manual SSG navigation group supplied by user configuration. */
+export interface JsSsgNavigationGroup {
+  title: string
+  items: Array<JsSsgNavigationItem>
+}
+
+/** Manual SSG navigation item supplied by user configuration. */
+export interface JsSsgNavigationItem {
+  title: string
+  path?: string
+  href?: string
+}
+
 /** Navigation item for SSG. */
 export interface JsSsgNavItem {
   /** Display title. */
@@ -821,6 +933,19 @@ export declare function parseScopedSearchQuery(query: string): JsScopedSearchQue
  */
 export declare function parseTransferRaw(source: string, kind: string, options?: JsParserOptions | undefined | null): Uint8Array
 
+/** Prepared Markdown source with parsed frontmatter. */
+export interface PreparedSourceResult {
+  /** Markdown content after optional frontmatter removal. */
+  content: string
+  /** Parsed frontmatter object. */
+  frontmatter: Record<string, any>
+  /** Source position where `content` starts in the original source. */
+  sourceOffset: JsSourceOrigin
+}
+
+/** Splits Markdown source into content and parsed frontmatter. */
+export declare function prepareSource(source: string, options?: JsSourceOptions | undefined | null): PreparedSourceResult
+
 /**
  * Splits Markdown source into content and frontmatter in a raw transfer buffer.
  *
@@ -840,6 +965,9 @@ export interface RenderResult {
   errors: Array<string>
 }
 
+/** Resolves manual SSG navigation groups. */
+export declare function resolveSsgNavigationGroups(navigation: Array<JsSsgNavigationGroup>, base: string, extension: string): Array<JsSsgNavGroup>
+
 /** Resolves all output and public route paths for an SSG page. */
 export declare function resolveSsgRoutePaths(inputPath: string, srcDir: string, outDir: string, base: string, extension: string, siteUrl?: string | undefined | null): JsSsgRoutePaths
 
@@ -859,6 +987,8 @@ export interface TocEntry {
   text: string
   /** URL-friendly slug. */
   slug: string
+  /** Child entries. */
+  children: Array<TocEntry>
 }
 
 /**
@@ -909,3 +1039,6 @@ export declare function validateMf2(message: string): Mf2ValidateResult
 
 /** Returns the version of ox_content_napi. */
 export declare function version(): string
+
+/** 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

@@ -74,25 +74,38 @@ module.exports.parseTransferRaw = binding.parseTransferRaw;
 module.exports.parseMdastRaw = binding.parseMdastRaw;
 module.exports.parseAndRender = binding.parseAndRender;
 module.exports.parseAndRenderAsync = binding.parseAndRenderAsync;
+module.exports.prepareSource = binding.prepareSource;
+module.exports.prepareSourceRaw = binding.prepareSourceRaw;
 module.exports.lintMarkdown = binding.lintMarkdown;
 module.exports.lintMarkdownDocuments = binding.lintMarkdownDocuments;
 module.exports.render = binding.render;
 module.exports.transform = binding.transform;
 module.exports.transformAsync = binding.transformAsync;
+module.exports.transformMdastRaw = binding.transformMdastRaw;
 module.exports.version = binding.version;
 module.exports.extractFileDocs = binding.extractFileDocs;
 module.exports.extractFileDocEntries = binding.extractFileDocEntries;
 module.exports.generateDocsNavMetadata = binding.generateDocsNavMetadata;
 module.exports.generateDocsNavCode = binding.generateDocsNavCode;
+module.exports.collectDocsSourceFiles = binding.collectDocsSourceFiles;
+module.exports.generateDocsDataJson = binding.generateDocsDataJson;
+module.exports.generateDocsMarkdown = binding.generateDocsMarkdown;
+module.exports.mergeHighlightedCodeBlocks = binding.mergeHighlightedCodeBlocks;
 module.exports.generateOgImageSvg = binding.generateOgImageSvg;
 module.exports.buildSearchIndex = binding.buildSearchIndex;
+module.exports.buildSearchIndexFromDirectory = binding.buildSearchIndexFromDirectory;
+module.exports.writeSearchIndex = binding.writeSearchIndex;
 module.exports.searchIndex = binding.searchIndex;
 module.exports.extractSearchContent = binding.extractSearchContent;
 module.exports.parseScopedSearchQuery = binding.parseScopedSearchQuery;
 module.exports.getSearchDocumentScopes = binding.getSearchDocumentScopes;
 module.exports.matchesSearchScopes = binding.matchesSearchScopes;
 module.exports.generateSearchModule = binding.generateSearchModule;
+module.exports.generateSearchModuleFromOptions = binding.generateSearchModuleFromOptions;
+module.exports.collectSearchMarkdownFiles = binding.collectSearchMarkdownFiles;
 module.exports.generateSsgHtml = binding.generateSsgHtml;
+module.exports.generateSsgBareHtml = binding.generateSsgBareHtml;
+module.exports.getGitLastUpdated = binding.getGitLastUpdated;
 module.exports.resolveSsgRoutePaths = binding.resolveSsgRoutePaths;
 module.exports.getSsgOutputPath = binding.getSsgOutputPath;
 module.exports.getSsgUrlPath = binding.getSsgUrlPath;
@@ -102,6 +115,8 @@ module.exports.extractSsgTitle = binding.extractSsgTitle;
 module.exports.formatSsgTitle = binding.formatSsgTitle;
 module.exports.buildSsgNavItems = binding.buildSsgNavItems;
 module.exports.buildSsgThemeNavItems = binding.buildSsgThemeNavItems;
+module.exports.resolveSsgNavigationGroups = binding.resolveSsgNavigationGroups;
+module.exports.collectSsgMarkdownFiles = binding.collectSsgMarkdownFiles;
 module.exports.externalizeSsgAssets = binding.externalizeSsgAssets;
 module.exports.transformMermaid = binding.transformMermaid;
 module.exports.loadDictionaries = binding.loadDictionaries;
@@ -109,4 +124,5 @@ module.exports.loadDictionariesFlat = binding.loadDictionariesFlat;
 module.exports.generateI18nModule = binding.generateI18nModule;
 module.exports.validateMf2 = binding.validateMf2;
 module.exports.checkI18n = binding.checkI18n;
+module.exports.checkI18nProject = binding.checkI18nProject;
 module.exports.extractTranslationKeys = binding.extractTranslationKeys;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ox-content/napi",
-  "version": "2.11.0",
+  "version": "2.12.0",
   "description": "Node.js bindings for Ox Content - High-performance Markdown parser",
   "keywords": [
     "markdown",
@@ -31,7 +31,7 @@
     "build:debug": "napi build"
   },
   "devDependencies": {
-    "@napi-rs/cli": "^3.5.1"
+    "@napi-rs/cli": "^3.6.2"
   },
   "napi": {
     "binaryName": "ox-content",
@@ -45,10 +45,10 @@
     ]
   },
   "optionalDependencies": {
-    "@ox-content/binding-darwin-x64": "2.11.0",
-    "@ox-content/binding-darwin-arm64": "2.11.0",
-    "@ox-content/binding-linux-x64-gnu": "2.11.0",
-    "@ox-content/binding-linux-arm64-gnu": "2.11.0",
-    "@ox-content/binding-win32-x64-msvc": "2.11.0"
+    "@ox-content/binding-darwin-x64": "2.12.0",
+    "@ox-content/binding-darwin-arm64": "2.12.0",
+    "@ox-content/binding-linux-x64-gnu": "2.12.0",
+    "@ox-content/binding-linux-arm64-gnu": "2.12.0",
+    "@ox-content/binding-win32-x64-msvc": "2.12.0"
   }
 }