@ox-content/napi 2.6.0 → 2.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +22 -0
  2. package/package.json +6 -6
package/index.d.ts CHANGED
@@ -43,6 +43,9 @@ export declare function generateOgImageSvg(data: JsOgImageData, config?: JsOgIma
43
43
  /** Generates SSG HTML page with navigation and search. */
44
44
  export declare function generateSsgHtml(pageData: JsSsgPageData, navGroups: Array<JsSsgNavGroup>, config: JsSsgConfig): string
45
45
 
46
+ /** Returns the last git commit timestamp for a file in milliseconds. */
47
+ export declare function getGitLastUpdated(filePath: string, root?: string | undefined | null): number | null
48
+
46
49
  /** Result of i18n checking. */
47
50
  export interface I18NCheckResult {
48
51
  /** All diagnostics. */
@@ -314,6 +317,20 @@ export interface JsSocialLinks {
314
317
  twitter?: string
315
318
  /** Discord URL. */
316
319
  discord?: string
320
+ /** Custom social links. */
321
+ links?: Array<JsSocialLink>
322
+ }
323
+
324
+ /** Custom social link for JavaScript. */
325
+ export interface JsSocialLink {
326
+ /** Icon label. */
327
+ icon?: string
328
+ /** Inline SVG icon. */
329
+ iconSvg?: string
330
+ /** Link URL. */
331
+ link: string
332
+ /** Accessible label. */
333
+ ariaLabel?: string
317
334
  }
318
335
 
319
336
  /** Source documentation item extracted from a JS/TS file. */
@@ -369,6 +386,7 @@ export interface JsSsgNavGroup {
369
386
  title: string
370
387
  /** Navigation items. */
371
388
  items: Array<JsSsgNavItem>
389
+ collapsed?: boolean
372
390
  }
373
391
 
374
392
  /** Navigation item for SSG. */
@@ -379,6 +397,8 @@ export interface JsSsgNavItem {
379
397
  path: string
380
398
  /** Full href. */
381
399
  href: string
400
+ children?: Array<JsSsgNavItem>
401
+ collapsed?: boolean
382
402
  }
383
403
 
384
404
  /** Page data for SSG. */
@@ -391,6 +411,8 @@ export interface JsSsgPageData {
391
411
  content: string
392
412
  /** Table of contents entries. */
393
413
  toc: Array<TocEntry>
414
+ /** Last updated timestamp in milliseconds since the Unix epoch. */
415
+ lastUpdated?: number
394
416
  /** URL path. */
395
417
  path: string
396
418
  /** Entry page configuration (if layout: entry). */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ox-content/napi",
3
- "version": "2.6.0",
3
+ "version": "2.7.0",
4
4
  "description": "Node.js bindings for Ox Content - High-performance Markdown parser",
5
5
  "keywords": [
6
6
  "markdown",
@@ -45,10 +45,10 @@
45
45
  ]
46
46
  },
47
47
  "optionalDependencies": {
48
- "@ox-content/binding-darwin-x64": "2.6.0",
49
- "@ox-content/binding-darwin-arm64": "2.6.0",
50
- "@ox-content/binding-linux-x64-gnu": "2.6.0",
51
- "@ox-content/binding-linux-arm64-gnu": "2.6.0",
52
- "@ox-content/binding-win32-x64-msvc": "2.6.0"
48
+ "@ox-content/binding-darwin-x64": "2.7.0",
49
+ "@ox-content/binding-darwin-arm64": "2.7.0",
50
+ "@ox-content/binding-linux-x64-gnu": "2.7.0",
51
+ "@ox-content/binding-linux-arm64-gnu": "2.7.0",
52
+ "@ox-content/binding-win32-x64-msvc": "2.7.0"
53
53
  }
54
54
  }