@vendure-io/docs-provider 0.3.0 → 0.5.0

package/README.md

@@ -23,7 +23,69 @@ bun add @vendure-io/docs-provider
 
 ### Defining a Documentation Package Manifest
 
-Documentation packages export a manifest that describes their structure. **Important**: File paths must be absolute paths. Use a helper pattern to resolve paths relative to your package root:
+Documentation packages export a manifest that describes their structure. **Important**: File paths must be absolute paths. Use a helper pattern to resolve paths relative to your package root.
+
+#### Quick Start (Minimal Config)
+
+```typescript
+import { resolveManifest, type DocsPackageManifestInput } from '@vendure-io/docs-provider'
+import { dirname, join } from 'path'
+import { fileURLToPath } from 'url'
+
+const packageRoot = dirname(dirname(fileURLToPath(import.meta.url)))
+const file = (relativePath: string) => join(packageRoot, relativePath)
+
+// Minimal: title/slug auto-derived from files
+const manifestInput: DocsPackageManifestInput = {
+  id: 'my-plugin',
+  name: 'My Plugin',
+  version: '1.0.0',
+  vendureVersion: 'v3',
+  basePath: packageRoot,
+  navigation: [
+    { file: file('docs/getting-started.mdx') },
+    { file: file('docs/installation.mdx') },
+    { file: file('docs/configuration.mdx') },
+  ],
+}
+
+export const manifest = resolveManifest(manifestInput)
+```
+
+#### Using Folder Discovery
+
+```typescript
+import {
+  createNavigationFromFolder,
+  resolveManifest,
+  type DocsPackageManifestInput,
+} from '@vendure-io/docs-provider'
+import { dirname, join } from 'path'
+import { fileURLToPath } from 'url'
+
+const packageRoot = dirname(dirname(fileURLToPath(import.meta.url)))
+const file = (relativePath: string) => join(packageRoot, relativePath)
+
+const manifestInput: DocsPackageManifestInput = {
+  id: 'my-plugin',
+  name: 'My Plugin',
+  version: '1.0.0',
+  vendureVersion: 'v3',
+  basePath: packageRoot,
+  navigation: [
+    { file: file('docs/getting-started.mdx') },
+    {
+      title: 'Guides',
+      slug: 'guides',
+      children: createNavigationFromFolder(join(packageRoot, 'docs/guides')),
+    },
+  ],
+}
+
+export const manifest = resolveManifest(manifestInput)
+```
+
+#### Explicit Navigation (Full Control)
 
 ```typescript
 import type { DocsPackageManifest } from '@vendure-io/docs-provider'
@@ -129,6 +191,43 @@ const pages = getLeafNodes(manifest)
 const { prev, next } = getPrevNextNodes(manifest, 'getting-started/installation')
 ```
 
+### Hidden Pages
+
+You can hide pages from the sidebar navigation while keeping them accessible via direct URL:
+
+```typescript
+const manifest: DocsPackageManifest = {
+  // ...
+  navigation: [
+    {
+      title: 'Public Page',
+      slug: 'public',
+      file: file('docs/public.mdx'),
+    },
+    {
+      title: 'Hidden Page',
+      slug: 'hidden',
+      file: file('docs/hidden.mdx'),
+      hidden: true, // Won't appear in sidebar, but /docs/hidden still works
+    },
+  ],
+}
+```
+
+### Browser Entry Point
+
+For client-side React components (with `'use client'`), use the `/browser` entry point to avoid bundling Node.js modules:
+
+```typescript
+// In client components
+import { filterVisibleNavigation, type NavigationNode } from '@vendure-io/docs-provider/browser'
+
+// Filter hidden pages before rendering sidebar
+const visibleNavigation = filterVisibleNavigation(manifest.navigation)
+```
+
+The main entry point includes Node.js-only utilities (`resolveManifest`, `createNavigationFromFolder`) that require `fs` access and cannot be used in browser contexts.
+
 ### Parsing MDX Frontmatter
 
 ```typescript
@@ -158,19 +257,22 @@ if (hasFrontmatter(mdxContent)) {
 
 ### Types
 
-| Type                  | Description                                           |
-| --------------------- | ----------------------------------------------------- |
-| `DocsPackageManifest` | Main manifest describing a documentation package      |
-| `NavigationNode`      | A node in the navigation tree                         |
-| `DocPage`             | A loaded documentation page with metadata and content |
-| `DocPageMeta`         | Frontmatter metadata for a page                       |
-| `ParsedFrontmatter`   | Result of parsing frontmatter (meta + content)        |
-| `SearchConfig`        | Search indexing configuration                         |
-| `VendureVersion`      | Supported Vendure versions (`'v1' \| 'v2' \| 'v3'`)   |
-| `FlatNavigationNode`  | Flattened navigation node with path info              |
-| `BreadcrumbItem`      | Breadcrumb navigation item                            |
-| `LoadedDocsPackage`   | Result of loading a docs package                      |
-| `GitHubConfig`        | GitHub repository configuration for edit links        |
+| Type                       | Description                                            |
+| -------------------------- | ------------------------------------------------------ |
+| `DocsPackageManifest`      | Main manifest describing a documentation package       |
+| `DocsPackageManifestInput` | Manifest input with optional title/slug in navigation  |
+| `NavigationNode`           | A node in the navigation tree                          |
+| `NavigationNodeInput`      | Navigation node input with optional title/slug         |
+| `DocPage`                  | A loaded documentation page with metadata and content  |
+| `DocPageMeta`              | Frontmatter metadata for a page                        |
+| `ParsedFrontmatter`        | Result of parsing frontmatter (meta + content)         |
+| `SearchConfig`             | Search indexing configuration                          |
+| `VendureVersion`           | Supported Vendure versions (`'v1' \| 'v2' \| 'v3'`)    |
+| `FlatNavigationNode`       | Flattened navigation node with path info               |
+| `BreadcrumbItem`           | Breadcrumb navigation item                             |
+| `LoadedDocsPackage`        | Result of loading a docs package                       |
+| `GitHubConfig`             | GitHub repository configuration for edit links         |
+| `FileInfo`                 | Information about a discovered file (for folder utils) |
 
 ### MDX Component Props
 
@@ -181,6 +283,7 @@ if (hasFrontmatter(mdxContent)) {
 | `MemberDescriptionProps`   | Props for MemberDescription component   |
 | `CustomFieldPropertyProps` | Props for CustomFieldProperty component |
 | `StackblitzProps`          | Props for Stackblitz component          |
+| `DocsLinkProps`            | Props for DocsLink component            |
 | `MdxComponentProps`        | Union type of all MDX component props   |
 
 ### Schemas (Zod)
@@ -188,7 +291,9 @@ if (hasFrontmatter(mdxContent)) {
 All types have corresponding Zod schemas for runtime validation:
 
 - `DocsPackageManifestSchema`
+- `DocsPackageManifestInputSchema`
 - `NavigationNodeSchema`
+- `NavigationNodeInputSchema`
 - `DocPageSchema`
 - `DocPageMetaSchema`
 - `SearchConfigSchema`
@@ -205,6 +310,8 @@ All types have corresponding Zod schemas for runtime validation:
 | Function                                 | Description                               |
 | ---------------------------------------- | ----------------------------------------- |
 | `validateManifest(data)`                 | Validate raw data against manifest schema |
+| `resolveManifest(input, options?)`       | Resolve manifest input to full manifest   |
+| `manifestNeedsResolution(input)`         | Check if manifest input needs resolution  |
 | `findNavigationNode(manifest, slugPath)` | Find a node by slug path                  |
 | `flattenNavigation(manifest)`            | Flatten navigation tree to array          |
 | `buildBreadcrumbs(manifest, slugPath)`   | Build breadcrumb trail                    |
@@ -215,9 +322,20 @@ All types have corresponding Zod schemas for runtime validation:
 
 #### Navigation Utilities
 
-| Function                    | Description                      |
-| --------------------------- | -------------------------------- |
-| `getAllFilePaths(manifest)` | Get all file paths from manifest |
+| Function                                        | Description                             |
+| ----------------------------------------------- | --------------------------------------- |
+| `getAllFilePaths(manifest)`                     | Get all file paths from manifest        |
+| `filterVisibleNavigation(nodes)`                | Filter out hidden nodes from navigation |
+| `createNavigationFromFolder(path, options?)`    | Create navigation from folder contents  |
+| `createNestedNavigationFromFolder(path, opts?)` | Create nested navigation from folders   |
+
+#### Slug Utilities
+
+| Function                  | Description                     |
+| ------------------------- | ------------------------------- |
+| `toSlug(text)`            | Convert text to kebab-case slug |
+| `slugFromFilename(file)`  | Extract slug from filename      |
+| `titleFromFilename(file)` | Generate title from filename    |
 
 #### Frontmatter Utilities
 
@@ -233,6 +351,7 @@ All types have corresponding Zod schemas for runtime validation:
 | Class                     | Description                           |
 | ------------------------- | ------------------------------------- |
 | `ManifestValidationError` | Thrown when manifest validation fails |
+| `ManifestResolutionError` | Thrown when manifest resolution fails |
 | `FrontmatterParseError`   | Thrown when frontmatter parsing fails |
 
 ## Development

package/dist/browser.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./manifest-D8kEDc9X.cjs"),a=require("./slug-utils-DUQgikEz.cjs");exports.BreadcrumbItemSchema=e.BreadcrumbItemSchema;exports.DocPageMetaSchema=e.DocPageMetaSchema;exports.DocPageSchema=e.DocPageSchema;exports.DocsPackageManifestInputSchema=e.DocsPackageManifestInputSchema;exports.DocsPackageManifestSchema=e.DocsPackageManifestSchema;exports.FlatNavigationNodeSchema=e.FlatNavigationNodeSchema;exports.GitHubConfigSchema=e.GitHubConfigSchema;exports.LoadedDocsPackageSchema=e.LoadedDocsPackageSchema;exports.ManifestValidationError=e.ManifestValidationError;exports.NavigationNodeInputSchema=e.NavigationNodeInputSchema;exports.NavigationNodeSchema=e.NavigationNodeSchema;exports.SearchConfigSchema=e.SearchConfigSchema;exports.VendureVersionSchema=e.VendureVersionSchema;exports.buildBreadcrumbs=e.buildBreadcrumbs;exports.findNavigationNode=e.findNavigationNode;exports.flattenNavigation=e.flattenNavigation;exports.getLeafNodes=e.getLeafNodes;exports.getNodesAtDepth=e.getNodesAtDepth;exports.getPrevNextNodes=e.getPrevNextNodes;exports.isNodeActive=e.isNodeActive;exports.validateManifest=e.validateManifest;exports.filterVisibleNavigation=a.filterVisibleNavigation;exports.getAllFilePaths=a.getAllFilePaths;exports.slugFromFilename=a.slugFromFilename;exports.titleFromFilename=a.titleFromFilename;exports.toSlug=a.toSlug;

package/dist/browser.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Browser-safe exports from docs-provider.
+ * These utilities can be safely used in client components without bundling Node.js modules.
+ */
+export type { BreadcrumbItem, DocPage, DocPageMeta, DocsPackageManifest, DocsPackageManifestInput, FlatNavigationNode, GitHubConfig, LoadedDocsPackage, NavigationNode, NavigationNodeInput, SearchConfig, VendureVersion, } from './types';
+export { BreadcrumbItemSchema, DocPageMetaSchema, DocPageSchema, DocsPackageManifestInputSchema, DocsPackageManifestSchema, FlatNavigationNodeSchema, GitHubConfigSchema, LoadedDocsPackageSchema, NavigationNodeInputSchema, NavigationNodeSchema, SearchConfigSchema, VendureVersionSchema, } from './schema';
+export { ManifestValidationError, buildBreadcrumbs, findNavigationNode, flattenNavigation, getLeafNodes, getNodesAtDepth, getPrevNextNodes, isNodeActive, validateManifest, } from './manifest';
+export { filterVisibleNavigation, getAllFilePaths } from './navigation-utils';
+export { slugFromFilename, titleFromFilename, toSlug } from './slug-utils';
+//# sourceMappingURL=browser.d.ts.map

package/dist/browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,YAAY,EACV,cAAc,EACd,OAAO,EACP,WAAW,EACX,mBAAmB,EACnB,wBAAwB,EACxB,kBAAkB,EAClB,YAAY,EACZ,iBAAiB,EACjB,cAAc,EACd,mBAAmB,EACnB,YAAY,EACZ,cAAc,GACf,MAAM,SAAS,CAAA;AAGhB,OAAO,EACL,oBAAoB,EACpB,iBAAiB,EACjB,aAAa,EACb,8BAA8B,EAC9B,yBAAyB,EACzB,wBAAwB,EACxB,kBAAkB,EAClB,uBAAuB,EACvB,yBAAyB,EACzB,oBAAoB,EACpB,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,UAAU,CAAA;AAGjB,OAAO,EACL,uBAAuB,EACvB,gBAAgB,EAChB,kBAAkB,EAClB,iBAAiB,EACjB,YAAY,EACZ,eAAe,EACf,gBAAgB,EAChB,YAAY,EACZ,gBAAgB,GACjB,MAAM,YAAY,CAAA;AAGnB,OAAO,EAAE,uBAAuB,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AAG7E,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA"}

package/dist/browser.js

@@ -0,0 +1,30 @@
+import { B as s, D as t, a as i, b as o, c, F as g, G as m, L as n, M as d, N as r, d as h, S as N, V as l, e as S, f, g as v, h as u, i as D, j as F, k as P, v as b } from "./manifest-B_cvT6F9.js";
+import { f as p, g as V, s as k, t as x, a as A } from "./slug-utils-DVKYe9h8.js";
+export {
+  s as BreadcrumbItemSchema,
+  t as DocPageMetaSchema,
+  i as DocPageSchema,
+  o as DocsPackageManifestInputSchema,
+  c as DocsPackageManifestSchema,
+  g as FlatNavigationNodeSchema,
+  m as GitHubConfigSchema,
+  n as LoadedDocsPackageSchema,
+  d as ManifestValidationError,
+  r as NavigationNodeInputSchema,
+  h as NavigationNodeSchema,
+  N as SearchConfigSchema,
+  l as VendureVersionSchema,
+  S as buildBreadcrumbs,
+  p as filterVisibleNavigation,
+  f as findNavigationNode,
+  v as flattenNavigation,
+  V as getAllFilePaths,
+  u as getLeafNodes,
+  D as getNodesAtDepth,
+  F as getPrevNextNodes,
+  P as isNodeActive,
+  k as slugFromFilename,
+  x as titleFromFilename,
+  A as toSlug,
+  b as validateManifest
+};

package/dist/folder-utils.d.ts

@@ -0,0 +1,136 @@
+import { NavigationNodeInput } from './types';
+/**
+ * Information about a discovered file for sorting and filtering
+ */
+export interface FileInfo {
+    /** Absolute path to the file */
+    path: string;
+    /** Filename without path */
+    filename: string;
+    /** File extension (e.g., '.mdx') */
+    extension: string;
+    /** Parsed frontmatter data (may be empty if no frontmatter) */
+    frontmatter: Record<string, unknown>;
+    /** Order number from frontmatter (defaults to Infinity for sorting) */
+    order: number;
+    /** Title from frontmatter or derived from filename */
+    title: string;
+    /** Slug derived from filename */
+    slug: string;
+}
+/**
+ * Options for createNavigationFromFolder
+ */
+export interface CreateNavigationFromFolderOptions {
+    /**
+     * File extensions to include
+     * @default ['.mdx', '.md']
+     */
+    extensions?: string[];
+    /**
+     * Filter function to exclude files
+     * Return false to exclude a file
+     * @default undefined (include all files)
+     */
+    filter?: (info: FileInfo) => boolean;
+    /**
+     * Sort function for ordering files
+     * @default Sort by frontmatter `order`, then alphabetically by title
+     */
+    sort?: (a: FileInfo, b: FileInfo) => number;
+}
+/**
+ * Options for createNestedNavigationFromFolder
+ */
+export interface CreateNestedNavigationFromFolderOptions extends CreateNavigationFromFolderOptions {
+    /**
+     * Maximum depth to recurse into subfolders
+     * @default Infinity (no limit)
+     */
+    maxDepth?: number;
+    /**
+     * Filter function to exclude folders
+     * Return false to exclude a folder
+     * @default undefined (include all folders)
+     */
+    folderFilter?: (folderName: string, folderPath: string) => boolean;
+}
+/**
+ * Create navigation nodes by discovering MDX files in a folder.
+ *
+ * This function scans a folder for MDX/MD files and creates navigation nodes
+ * with titles and slugs automatically derived from frontmatter and filenames.
+ *
+ * @param folderPath - Absolute path to the folder to scan
+ * @param options - Discovery and sorting options
+ * @returns Array of NavigationNodeInput objects
+ *
+ * @example
+ * ```typescript
+ * // Basic usage - scan a folder
+ * const guides = createNavigationFromFolder(join(packageRoot, 'docs/guides'))
+ *
+ * // With filtering
+ * const guides = createNavigationFromFolder(join(packageRoot, 'docs/guides'), {
+ *   filter: (info) => info.frontmatter.hidden !== true,
+ * })
+ *
+ * // Custom sorting
+ * const guides = createNavigationFromFolder(join(packageRoot, 'docs/guides'), {
+ *   sort: (a, b) => a.filename.localeCompare(b.filename),
+ * })
+ * ```
+ */
+export declare function createNavigationFromFolder(folderPath: string, options?: CreateNavigationFromFolderOptions): NavigationNodeInput[];
+/**
+ * Create nested navigation by recursively scanning a folder and its subfolders.
+ *
+ * Each subfolder becomes a navigation section, and files within become pages.
+ * The folder structure is preserved in the navigation hierarchy.
+ *
+ * @param folderPath - Absolute path to the folder to scan
+ * @param options - Discovery, sorting, and recursion options
+ * @returns Array of NavigationNodeInput objects with nested children
+ *
+ * @example
+ * ```typescript
+ * // Given folder structure:
+ * // docs/
+ * //   getting-started/
+ * //     introduction.mdx
+ * //     installation.mdx
+ * //   guides/
+ * //     basic-usage.mdx
+ * //     advanced/
+ * //       custom-plugins.mdx
+ *
+ * const nav = createNestedNavigationFromFolder(join(packageRoot, 'docs'))
+ * // Returns:
+ * // [
+ * //   {
+ * //     title: 'Getting Started',
+ * //     slug: 'getting-started',
+ * //     children: [
+ * //       { title: 'Introduction', slug: 'introduction', file: '...' },
+ * //       { title: 'Installation', slug: 'installation', file: '...' },
+ * //     ],
+ * //   },
+ * //   {
+ * //     title: 'Guides',
+ * //     slug: 'guides',
+ * //     children: [
+ * //       { title: 'Basic Usage', slug: 'basic-usage', file: '...' },
+ * //       {
+ * //         title: 'Advanced',
+ * //         slug: 'advanced',
+ * //         children: [
+ * //           { title: 'Custom Plugins', slug: 'custom-plugins', file: '...' },
+ * //         ],
+ * //       },
+ * //     ],
+ * //   },
+ * // ]
+ * ```
+ */
+export declare function createNestedNavigationFromFolder(folderPath: string, options?: CreateNestedNavigationFromFolderOptions): NavigationNodeInput[];
+//# sourceMappingURL=folder-utils.d.ts.map

package/dist/folder-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"folder-utils.d.ts","sourceRoot":"","sources":["../src/folder-utils.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAElD;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,4BAA4B;IAC5B,QAAQ,EAAE,MAAM,CAAA;IAChB,oCAAoC;IACpC,SAAS,EAAE,MAAM,CAAA;IACjB,+DAA+D;IAC/D,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACpC,uEAAuE;IACvE,KAAK,EAAE,MAAM,CAAA;IACb,sDAAsD;IACtD,KAAK,EAAE,MAAM,CAAA;IACb,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;IAErB;;;;OAIG;IACH,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,OAAO,CAAA;IAEpC;;;OAGG;IACH,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,KAAK,MAAM,CAAA;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,uCAAwC,SAAQ,iCAAiC;IAChG;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;;OAIG;IACH,YAAY,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,KAAK,OAAO,CAAA;CACnE;AAcD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,iCAAsC,GAC9C,mBAAmB,EAAE,CAYvB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,wBAAgB,gCAAgC,CAC9C,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,uCAA4C,GACpD,mBAAmB,EAAE,CAEvB"}

package/dist/frontmatter-8Bwpoi8r.js

@@ -0,0 +1,56 @@
+var c = Object.defineProperty;
+var m = (a, t, r) => t in a ? c(a, t, { enumerable: !0, configurable: !0, writable: !0, value: r }) : a[t] = r;
+var o = (a, t, r) => m(a, typeof t != "symbol" ? t + "" : t, r);
+import i from "gray-matter";
+import { D as u } from "./manifest-B_cvT6F9.js";
+class s extends Error {
+  constructor(r, e, n) {
+    super(r);
+    o(this, "filePath");
+    o(this, "originalError");
+    this.name = "FrontmatterParseError", this.filePath = e, this.originalError = n;
+  }
+}
+function F(a, t) {
+  try {
+    const { data: r, content: e } = i(a);
+    return {
+      meta: d(r, t),
+      content: e.trim()
+    };
+  } catch (r) {
+    throw r instanceof s ? r : new s(
+      `Failed to parse frontmatter${t ? ` in ${t}` : ""}`,
+      t,
+      r
+    );
+  }
+}
+function d(a, t) {
+  const r = u.safeParse(a);
+  if (!r.success) {
+    const e = r.error.issues.map((n) => `  - ${n.path.join(".")}: ${n.message}`).join(`
+`);
+    throw new s(
+      `Invalid frontmatter${t ? ` in ${t}` : ""}:
+${e}`,
+      t,
+      r.error
+    );
+  }
+  return r.data;
+}
+function $(a) {
+  return a.trimStart().startsWith("---");
+}
+function l(a) {
+  const { data: t } = i(a);
+  return t;
+}
+export {
+  s as F,
+  l as e,
+  $ as h,
+  F as p,
+  d as v
+};

package/dist/frontmatter-_wRoVeyd.cjs

@@ -0,0 +1,3 @@
+"use strict";var m=Object.defineProperty;var u=(a,t,r)=>t in a?m(a,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):a[t]=r;var s=(a,t,r)=>u(a,typeof t!="symbol"?t+"":t,r);const i=require("gray-matter"),d=require("./manifest-D8kEDc9X.cjs");class o extends Error{constructor(r,e,n){super(r);s(this,"filePath");s(this,"originalError");this.name="FrontmatterParseError",this.filePath=e,this.originalError=n}}function F(a,t){try{const{data:r,content:e}=i(a);return{meta:c(r,t),content:e.trim()}}catch(r){throw r instanceof o?r:new o(`Failed to parse frontmatter${t?` in ${t}`:""}`,t,r)}}function c(a,t){const r=d.DocPageMetaSchema.safeParse(a);if(!r.success){const e=r.error.issues.map(n=>`  - ${n.path.join(".")}: ${n.message}`).join(`
+`);throw new o(`Invalid frontmatter${t?` in ${t}`:""}:
+${e}`,t,r.error)}return r.data}function h(a){return a.trimStart().startsWith("---")}function f(a){const{data:t}=i(a);return t}exports.FrontmatterParseError=o;exports.extractFrontmatterData=f;exports.hasFrontmatter=h;exports.parseFrontmatter=F;exports.validateFrontmatter=c;

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./manifest-CNnJGNwK.cjs");function i(o){const a=[];return r(o.navigation,a),a}function r(o,a){for(const t of o)t.file&&a.push(t.file),t.children&&r(t.children,a)}exports.BreadcrumbItemSchema=e.BreadcrumbItemSchema;exports.DocPageMetaSchema=e.DocPageMetaSchema;exports.DocPageSchema=e.DocPageSchema;exports.DocsPackageManifestSchema=e.DocsPackageManifestSchema;exports.FlatNavigationNodeSchema=e.FlatNavigationNodeSchema;exports.FrontmatterParseError=e.FrontmatterParseError;exports.GitHubConfigSchema=e.GitHubConfigSchema;exports.LoadedDocsPackageSchema=e.LoadedDocsPackageSchema;exports.ManifestValidationError=e.ManifestValidationError;exports.NavigationNodeSchema=e.NavigationNodeSchema;exports.SearchConfigSchema=e.SearchConfigSchema;exports.VendureVersionSchema=e.VendureVersionSchema;exports.buildBreadcrumbs=e.buildBreadcrumbs;exports.extractFrontmatterData=e.extractFrontmatterData;exports.findNavigationNode=e.findNavigationNode;exports.flattenNavigation=e.flattenNavigation;exports.getLeafNodes=e.getLeafNodes;exports.getNodesAtDepth=e.getNodesAtDepth;exports.getPrevNextNodes=e.getPrevNextNodes;exports.hasFrontmatter=e.hasFrontmatter;exports.isNodeActive=e.isNodeActive;exports.parseFrontmatter=e.parseFrontmatter;exports.validateFrontmatter=e.validateFrontmatter;exports.validateManifest=e.validateManifest;exports.getAllFilePaths=i;
+"use strict";var L=Object.defineProperty;var R=(e,t,r)=>t in e?L(e,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[t]=r;var S=(e,t,r)=>R(e,typeof t!="symbol"?t+"":t,r);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const a=require("./manifest-D8kEDc9X.cjs"),g=require("./frontmatter-_wRoVeyd.cjs"),l=require("./slug-utils-DUQgikEz.cjs"),N=require("fs"),y=require("path"),I=(e,t)=>e.order!==t.order?e.order-t.order:e.title.localeCompare(t.title);function j(e,t={}){const{extensions:r=[".mdx",".md"],filter:i,sort:o=I}=t,n=C(e,r);return(i?n.filter(i):n).sort(o).map(m=>({title:m.title,slug:m.slug,file:m.path}))}function q(e,t={}){return V(e,t,0)}function V(e,t,r){const{extensions:i=[".mdx",".md"],filter:o,sort:n=I,maxDepth:c=1/0,folderFilter:u}=t,m=N.readdirSync(e,{withFileTypes:!0}),h=[],$=C(e,i),D=(o?$.filter(o):$).sort(n);for(const f of D)h.push({title:f.title,slug:f.slug,file:f.path});if(r<c){const f=m.filter(d=>d.isDirectory());for(const d of f){if(u){const s=y.join(e,d.name);if(!u(d.name,s))continue}const F=y.join(e,d.name),v=V(F,t,r+1);if(v.length>0){const s=B(F,i);h.push({title:(s==null?void 0:s.title)||l.titleFromFilename(d.name),slug:l.slugFromFilename(d.name),file:s==null?void 0:s.path,children:v.filter(P=>!(s&&P.file===s.path))})}}}return h.sort((f,d)=>{var E,w;const F=D.find(M=>M.slug===f.slug),v=D.find(M=>M.slug===d.slug);if(F&&v)return n(F,v);const s=!!f.file&&!((E=f.children)!=null&&E.length),P=!!d.file&&!((w=d.children)!=null&&w.length);return s!==P?s?-1:1:(f.title||"").localeCompare(d.title||"")})}function C(e,t){try{const r=N.readdirSync(e,{withFileTypes:!0}),i=[];for(const o of r){if(!o.isFile())continue;const n=t.find(h=>o.name.toLowerCase().endsWith(h));if(!n||o.name.slice(0,-n.length).toLowerCase()==="index")continue;const u=y.join(e,o.name),m=k(u,o.name,n);i.push(m)}return i}catch{return[]}}function k(e,t,r){let i={},o=l.titleFromFilename(t),n=1/0;try{const c=N.readFileSync(e,"utf-8");i=g.extractFrontmatterData(c),i.title&&typeof i.title=="string"&&(o=i.title),typeof i.order=="number"&&(n=i.order)}catch{}return{path:e,filename:t,extension:r,frontmatter:i,order:n,title:o,slug:l.slugFromFilename(t)}}function B(e,t){for(const r of t){const i=y.join(e,`index${r}`);try{if(N.statSync(i).isFile())return k(i,`index${r}`,r)}catch{}}}class b extends Error{constructor(r,i,o,n){super(r);S(this,"nodePath");S(this,"filePath");S(this,"originalError");this.name="ManifestResolutionError",this.nodePath=i,this.filePath=o,this.originalError=n}}function T(e,t={}){const{strict:r=!0}=t,i=x(e.navigation,"",r);return{id:e.id,name:e.name,version:e.version,vendureVersion:e.vendureVersion,navigation:i,search:e.search,github:e.github,basePath:e.basePath}}function x(e,t,r){return e.map((i,o)=>U(i,t,o,r))}function U(e,t,r,i){const o=t?`${t}[${r}]`:`navigation[${r}]`;if(e.title&&e.slug)return{title:e.title,slug:e.slug,file:e.file,children:e.children?x(e.children,`${o}.children`,i):void 0,badge:e.badge,hidden:e.hidden};let n=e.title,c=e.slug;if(e.file&&(c||(c=l.slugFromFilename(e.file)),n||(n=W(e.file,o,i))),!n){if(i)throw new b(`Navigation node at ${o} is missing title and has no file to derive it from`,o,e.file);n=c||`Unknown (${r})`}if(!c){if(i)throw new b(`Navigation node at ${o} is missing slug and has no file to derive it from`,o,e.file);c=n?l.slugFromFilename(n):`node-${r}`}return{title:n,slug:c,file:e.file,children:e.children?x(e.children,`${o}.children`,i):void 0,badge:e.badge,hidden:e.hidden}}function W(e,t,r){try{const i=N.readFileSync(e,"utf-8"),o=g.extractFrontmatterData(i);return o.title&&typeof o.title=="string"?o.title:l.titleFromFilename(e)}catch(i){if(r)throw new b(`Failed to read file for title derivation at ${t}: ${e}`,t,e,i);return l.titleFromFilename(e)}}function G(e){return A(e.navigation)}function A(e){for(const t of e)if(!t.title||!t.slug||t.children&&A(t.children))return!0;return!1}exports.BreadcrumbItemSchema=a.BreadcrumbItemSchema;exports.DocPageMetaSchema=a.DocPageMetaSchema;exports.DocPageSchema=a.DocPageSchema;exports.DocsPackageManifestInputSchema=a.DocsPackageManifestInputSchema;exports.DocsPackageManifestSchema=a.DocsPackageManifestSchema;exports.FlatNavigationNodeSchema=a.FlatNavigationNodeSchema;exports.GitHubConfigSchema=a.GitHubConfigSchema;exports.LoadedDocsPackageSchema=a.LoadedDocsPackageSchema;exports.ManifestValidationError=a.ManifestValidationError;exports.NavigationNodeInputSchema=a.NavigationNodeInputSchema;exports.NavigationNodeSchema=a.NavigationNodeSchema;exports.SearchConfigSchema=a.SearchConfigSchema;exports.VendureVersionSchema=a.VendureVersionSchema;exports.buildBreadcrumbs=a.buildBreadcrumbs;exports.findNavigationNode=a.findNavigationNode;exports.flattenNavigation=a.flattenNavigation;exports.getLeafNodes=a.getLeafNodes;exports.getNodesAtDepth=a.getNodesAtDepth;exports.getPrevNextNodes=a.getPrevNextNodes;exports.isNodeActive=a.isNodeActive;exports.validateManifest=a.validateManifest;exports.FrontmatterParseError=g.FrontmatterParseError;exports.extractFrontmatterData=g.extractFrontmatterData;exports.hasFrontmatter=g.hasFrontmatter;exports.parseFrontmatter=g.parseFrontmatter;exports.validateFrontmatter=g.validateFrontmatter;exports.filterVisibleNavigation=l.filterVisibleNavigation;exports.getAllFilePaths=l.getAllFilePaths;exports.slugFromFilename=l.slugFromFilename;exports.titleFromFilename=l.titleFromFilename;exports.toSlug=l.toSlug;exports.ManifestResolutionError=b;exports.createNavigationFromFolder=j;exports.createNestedNavigationFromFolder=q;exports.manifestNeedsResolution=G;exports.resolveManifest=T;

package/dist/index.d.ts

@@ -1,8 +1,13 @@
-export type { BreadcrumbItem, DocPage, DocPageMeta, DocsPackageManifest, FlatNavigationNode, GitHubConfig, LoadedDocsPackage, NavigationNode, SearchConfig, VendureVersion, } from './types';
-export { BreadcrumbItemSchema, DocPageMetaSchema, DocPageSchema, DocsPackageManifestSchema, FlatNavigationNodeSchema, GitHubConfigSchema, LoadedDocsPackageSchema, NavigationNodeSchema, SearchConfigSchema, VendureVersionSchema, } from './schema';
+export type { BreadcrumbItem, DocPage, DocPageMeta, DocsPackageManifest, DocsPackageManifestInput, FlatNavigationNode, GitHubConfig, LoadedDocsPackage, NavigationNode, NavigationNodeInput, SearchConfig, VendureVersion, } from './types';
+export { BreadcrumbItemSchema, DocPageMetaSchema, DocPageSchema, DocsPackageManifestInputSchema, DocsPackageManifestSchema, FlatNavigationNodeSchema, GitHubConfigSchema, LoadedDocsPackageSchema, NavigationNodeInputSchema, NavigationNodeSchema, SearchConfigSchema, VendureVersionSchema, } from './schema';
 export { FrontmatterParseError, extractFrontmatterData, hasFrontmatter, parseFrontmatter, validateFrontmatter, } from './frontmatter';
 export type { ParsedFrontmatter } from './frontmatter';
 export { ManifestValidationError, buildBreadcrumbs, findNavigationNode, flattenNavigation, getLeafNodes, getNodesAtDepth, getPrevNextNodes, isNodeActive, validateManifest, } from './manifest';
-export { getAllFilePaths } from './navigation-utils';
-export type { CustomFieldPropertyProps, GenerationInfoProps, GraphQLDocProps, MdxComponentProps, MemberDescriptionProps, MemberInfoProps, StackblitzProps, } from './mdx-components';
+export { filterVisibleNavigation, getAllFilePaths } from './navigation-utils';
+export type { CustomFieldPropertyProps, GenerationInfoProps, GraphQLDocProps, LinkCardProps, MdxComponentProps, MemberDescriptionProps, MemberInfoProps, StackblitzProps, } from './mdx-components';
+export { slugFromFilename, titleFromFilename, toSlug } from './slug-utils';
+export { createNavigationFromFolder, createNestedNavigationFromFolder } from './folder-utils';
+export type { CreateNavigationFromFolderOptions, CreateNestedNavigationFromFolderOptions, FileInfo, } from './folder-utils';
+export { ManifestResolutionError, manifestNeedsResolution, resolveManifest, } from './manifest-resolver';
+export type { ResolveManifestOptions } from './manifest-resolver';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,YAAY,EACV,cAAc,EACd,OAAO,EACP,WAAW,EACX,mBAAmB,EACnB,kBAAkB,EAClB,YAAY,EACZ,iBAAiB,EACjB,cAAc,EACd,YAAY,EACZ,cAAc,GACf,MAAM,SAAS,CAAA;AAGhB,OAAO,EACL,oBAAoB,EACpB,iBAAiB,EACjB,aAAa,EACb,yBAAyB,EACzB,wBAAwB,EACxB,kBAAkB,EAClB,uBAAuB,EACvB,oBAAoB,EACpB,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,UAAU,CAAA;AAGjB,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACtB,cAAc,EACd,gBAAgB,EAChB,mBAAmB,GACpB,MAAM,eAAe,CAAA;AACtB,YAAY,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAA;AAGtD,OAAO,EACL,uBAAuB,EACvB,gBAAgB,EAChB,kBAAkB,EAClB,iBAAiB,EACjB,YAAY,EACZ,eAAe,EACf,gBAAgB,EAChB,YAAY,EACZ,gBAAgB,GACjB,MAAM,YAAY,CAAA;AAGnB,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AAGpD,YAAY,EACV,wBAAwB,EACxB,mBAAmB,EACnB,eAAe,EACf,iBAAiB,EACjB,sBAAsB,EACtB,eAAe,EACf,eAAe,GAChB,MAAM,kBAAkB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,YAAY,EACV,cAAc,EACd,OAAO,EACP,WAAW,EACX,mBAAmB,EACnB,wBAAwB,EACxB,kBAAkB,EAClB,YAAY,EACZ,iBAAiB,EACjB,cAAc,EACd,mBAAmB,EACnB,YAAY,EACZ,cAAc,GACf,MAAM,SAAS,CAAA;AAGhB,OAAO,EACL,oBAAoB,EACpB,iBAAiB,EACjB,aAAa,EACb,8BAA8B,EAC9B,yBAAyB,EACzB,wBAAwB,EACxB,kBAAkB,EAClB,uBAAuB,EACvB,yBAAyB,EACzB,oBAAoB,EACpB,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,UAAU,CAAA;AAGjB,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACtB,cAAc,EACd,gBAAgB,EAChB,mBAAmB,GACpB,MAAM,eAAe,CAAA;AACtB,YAAY,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAA;AAGtD,OAAO,EACL,uBAAuB,EACvB,gBAAgB,EAChB,kBAAkB,EAClB,iBAAiB,EACjB,YAAY,EACZ,eAAe,EACf,gBAAgB,EAChB,YAAY,EACZ,gBAAgB,GACjB,MAAM,YAAY,CAAA;AAGnB,OAAO,EAAE,uBAAuB,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AAG7E,YAAY,EACV,wBAAwB,EACxB,mBAAmB,EACnB,eAAe,EACf,aAAa,EACb,iBAAiB,EACjB,sBAAsB,EACtB,eAAe,EACf,eAAe,GAChB,MAAM,kBAAkB,CAAA;AAGzB,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAG1E,OAAO,EAAE,0BAA0B,EAAE,gCAAgC,EAAE,MAAM,gBAAgB,CAAA;AAC7F,YAAY,EACV,iCAAiC,EACjC,uCAAuC,EACvC,QAAQ,GACT,MAAM,gBAAgB,CAAA;AAGvB,OAAO,EACL,uBAAuB,EACvB,uBAAuB,EACvB,eAAe,GAChB,MAAM,qBAAqB,CAAA;AAC5B,YAAY,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAA"}