@vendure-io/docs-provider 0.4.0 → 0.5.0

package/README.md

@@ -191,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
@@ -246,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)
@@ -284,11 +322,12 @@ All types have corresponding Zod schemas for runtime validation:
 
 #### Navigation Utilities
 
-| Function                                        | Description                            |
-| ----------------------------------------------- | -------------------------------------- |
-| `getAllFilePaths(manifest)`                     | Get all file paths from manifest       |
-| `createNavigationFromFolder(path, options?)`    | Create navigation from folder contents |
-| `createNestedNavigationFromFolder(path, opts?)` | Create nested navigation from folders  |
+| 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
 

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

@@ -3,7 +3,7 @@ export { BreadcrumbItemSchema, DocPageMetaSchema, DocPageSchema, DocsPackageMani
 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 { 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';

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,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,eAAe,EAAE,MAAM,oBAAoB,CAAA;AAGpD,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"}
+{"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"}

package/dist/index.js

@@ -1,245 +1,233 @@
-var R = Object.defineProperty;
-var A = (e, t, r) => t in e ? R(e, t, { enumerable: !0, configurable: !0, writable: !0, value: r }) : e[t] = r;
-var g = (e, t, r) => A(e, typeof t != "symbol" ? t + "" : t, r);
-import { e as P } from "./manifest-CVIfw0ha.js";
-import { B as te, D as ie, a as re, b as ne, c as oe, F as se, f as ae, G as le, L as ce, M as fe, N as de, d as ue, S as me, V as he, g as ge, i as ve, j as Fe, k as Ne, l as xe, m as pe, h as Se, n as we, p as be, v as ye, o as $e } from "./manifest-CVIfw0ha.js";
-import { readdirSync as C, readFileSync as D, statSync as B } from "fs";
-import { join as v } from "path";
-function K(e) {
-  const t = [];
-  return M(e.navigation, t), t;
-}
-function M(e, t) {
-  for (const r of e)
-    r.file && t.push(r.file), r.children && M(r.children, t);
-}
-function T(e) {
-  return e.toLowerCase().trim().replace(/[^\w\s-]/g, "").replace(/\s+/g, "-").replace(/-+/g, "-").replace(/^-|-$/g, "");
-}
-function F(e) {
-  const i = (e.split("/").pop() || e).replace(/\.(mdx?|md)$/i, "").replace(/^\d+-/, "");
-  return T(i);
-}
-function N(e) {
-  return (e.split("/").pop() || e).replace(/\.(mdx?|md)$/i, "").replace(/^\d+-/, "").replace(/[-_]+/g, " ").toLowerCase().replace(/\b\w/g, (n) => n.toUpperCase()).trim();
-}
-const I = (e, t) => e.order !== t.order ? e.order - t.order : e.title.localeCompare(t.title);
-function O(e, t = {}) {
-  const { extensions: r = [".mdx", ".md"], filter: i, sort: n = I } = t, o = W(e, r);
-  return (i ? o.filter(i) : o).sort(n).map((f) => ({
+var A = Object.defineProperty;
+var B = (e, t, i) => t in e ? A(e, t, { enumerable: !0, configurable: !0, writable: !0, value: i }) : e[t] = i;
+var m = (e, t, i) => B(e, typeof t != "symbol" ? t + "" : t, i);
+import { B as _, D as ee, a as te, b as re, c as ie, F as oe, G as ne, L as se, M as ae, N as le, d as ce, S as fe, V as de, e as he, f as ue, g as ge, h as me, i as ve, j as Fe, k as Ne, v as Se } from "./manifest-B_cvT6F9.js";
+import { e as M } from "./frontmatter-8Bwpoi8r.js";
+import { F as xe, h as be, p as $e, v as we } from "./frontmatter-8Bwpoi8r.js";
+import { s as v, t as F } from "./slug-utils-DVKYe9h8.js";
+import { f as Ee, g as Me, a as Ie } from "./slug-utils-DVKYe9h8.js";
+import { readdirSync as I, readFileSync as P, statSync as T } from "fs";
+import { join as N } from "path";
+const V = (e, t) => e.order !== t.order ? e.order - t.order : e.title.localeCompare(t.title);
+function K(e, t = {}) {
+  const { extensions: i = [".mdx", ".md"], filter: r, sort: o = V } = t, n = k(e, i);
+  return (r ? n.filter(r) : n).sort(o).map((f) => ({
     title: f.title,
     slug: f.slug,
     file: f.path
   }));
 }
-function Q(e, t = {}) {
-  return L(e, t, 0);
+function O(e, t = {}) {
+  return C(e, t, 0);
 }
-function L(e, t, r) {
+function C(e, t, i) {
   const {
-    extensions: i = [".mdx", ".md"],
-    filter: n,
-    sort: o = I,
+    extensions: r = [".mdx", ".md"],
+    filter: o,
+    sort: n = V,
     maxDepth: a = 1 / 0,
     folderFilter: d
-  } = t, f = C(e, { withFileTypes: !0 }), u = [], y = W(e, i), x = (n ? y.filter(n) : y).sort(o);
-  for (const c of x)
-    u.push({
+  } = t, f = I(e, { withFileTypes: !0 }), h = [], w = k(e, r), S = (o ? w.filter(o) : w).sort(n);
+  for (const c of S)
+    h.push({
       title: c.title,
       slug: c.slug,
       file: c.path
     });
-  if (r < a) {
+  if (i < a) {
     const c = f.filter((l) => l.isDirectory());
     for (const l of c) {
       if (d) {
-        const s = v(e, l.name);
+        const s = N(e, l.name);
         if (!d(l.name, s))
           continue;
       }
-      const m = v(e, l.name), h = L(m, t, r + 1);
-      if (h.length > 0) {
-        const s = U(m, i);
-        u.push({
-          title: (s == null ? void 0 : s.title) || N(l.name),
-          slug: F(l.name),
+      const u = N(e, l.name), g = C(u, t, i + 1);
+      if (g.length > 0) {
+        const s = W(u, r);
+        h.push({
+          title: (s == null ? void 0 : s.title) || F(l.name),
+          slug: v(l.name),
           file: s == null ? void 0 : s.path,
-          children: h.filter((p) => !(s && p.file === s.path))
+          children: g.filter((y) => !(s && y.file === s.path))
         });
       }
     }
   }
-  return u.sort((c, l) => {
-    var $, E;
-    const m = x.find((S) => S.slug === c.slug), h = x.find((S) => S.slug === l.slug);
-    if (m && h)
-      return o(m, h);
-    const s = !!c.file && !(($ = c.children) != null && $.length), p = !!l.file && !((E = l.children) != null && E.length);
-    return s !== p ? s ? -1 : 1 : (c.title || "").localeCompare(l.title || "");
+  return h.sort((c, l) => {
+    var D, E;
+    const u = S.find((x) => x.slug === c.slug), g = S.find((x) => x.slug === l.slug);
+    if (u && g)
+      return n(u, g);
+    const s = !!c.file && !((D = c.children) != null && D.length), y = !!l.file && !((E = l.children) != null && E.length);
+    return s !== y ? s ? -1 : 1 : (c.title || "").localeCompare(l.title || "");
   });
 }
-function W(e, t) {
+function k(e, t) {
   try {
-    const r = C(e, { withFileTypes: !0 }), i = [];
-    for (const n of r) {
-      if (!n.isFile()) continue;
-      const o = t.find((u) => n.name.toLowerCase().endsWith(u));
-      if (!o || n.name.slice(0, -o.length).toLowerCase() === "index") continue;
-      const d = v(e, n.name), f = V(d, n.name, o);
-      i.push(f);
+    const i = I(e, { withFileTypes: !0 }), r = [];
+    for (const o of i) {
+      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 d = N(e, o.name), f = L(d, o.name, n);
+      r.push(f);
     }
-    return i;
+    return r;
   } catch {
     return [];
   }
 }
-function V(e, t, r) {
-  let i = {}, n = N(t), o = 1 / 0;
+function L(e, t, i) {
+  let r = {}, o = F(t), n = 1 / 0;
   try {
-    const a = D(e, "utf-8");
-    i = P(a), i.title && typeof i.title == "string" && (n = i.title), typeof i.order == "number" && (o = i.order);
+    const a = P(e, "utf-8");
+    r = M(a), r.title && typeof r.title == "string" && (o = r.title), typeof r.order == "number" && (n = r.order);
   } catch {
   }
   return {
     path: e,
     filename: t,
-    extension: r,
-    frontmatter: i,
-    order: o,
-    title: n,
-    slug: F(t)
+    extension: i,
+    frontmatter: r,
+    order: n,
+    title: o,
+    slug: v(t)
   };
 }
-function U(e, t) {
-  for (const r of t) {
-    const i = v(e, `index${r}`);
+function W(e, t) {
+  for (const i of t) {
+    const r = N(e, `index${i}`);
     try {
-      if (B(i).isFile())
-        return V(i, `index${r}`, r);
+      if (T(r).isFile())
+        return L(r, `index${i}`, i);
     } catch {
     }
   }
 }
-class w extends Error {
-  constructor(r, i, n, o) {
-    super(r);
-    g(this, "nodePath");
-    g(this, "filePath");
-    g(this, "originalError");
-    this.name = "ManifestResolutionError", this.nodePath = i, this.filePath = n, this.originalError = o;
+class b extends Error {
+  constructor(i, r, o, n) {
+    super(i);
+    m(this, "nodePath");
+    m(this, "filePath");
+    m(this, "originalError");
+    this.name = "ManifestResolutionError", this.nodePath = r, this.filePath = o, this.originalError = n;
   }
 }
-function X(e, t = {}) {
-  const { strict: r = !0 } = t, i = b(e.navigation, "", r);
+function Q(e, t = {}) {
+  const { strict: i = !0 } = t, r = $(e.navigation, "", i);
   return {
     id: e.id,
     name: e.name,
     version: e.version,
     vendureVersion: e.vendureVersion,
-    navigation: i,
+    navigation: r,
     search: e.search,
     github: e.github,
     basePath: e.basePath
   };
 }
-function b(e, t, r) {
-  return e.map((i, n) => j(i, t, n, r));
+function $(e, t, i) {
+  return e.map((r, o) => j(r, t, o, i));
 }
-function j(e, t, r, i) {
-  const n = t ? `${t}[${r}]` : `navigation[${r}]`;
+function j(e, t, i, r) {
+  const o = t ? `${t}[${i}]` : `navigation[${i}]`;
   if (e.title && e.slug)
     return {
       title: e.title,
       slug: e.slug,
       file: e.file,
-      children: e.children ? b(e.children, `${n}.children`, i) : void 0,
-      badge: e.badge
+      children: e.children ? $(e.children, `${o}.children`, r) : void 0,
+      badge: e.badge,
+      hidden: e.hidden
     };
-  let o = e.title, a = e.slug;
-  if (e.file && (a || (a = F(e.file)), o || (o = G(e.file, n, i))), !o) {
-    if (i)
-      throw new w(
-        `Navigation node at ${n} is missing title and has no file to derive it from`,
-        n,
+  let n = e.title, a = e.slug;
+  if (e.file && (a || (a = v(e.file)), n || (n = p(e.file, o, r))), !n) {
+    if (r)
+      throw new b(
+        `Navigation node at ${o} is missing title and has no file to derive it from`,
+        o,
         e.file
       );
-    o = a || `Unknown (${r})`;
+    n = a || `Unknown (${i})`;
   }
   if (!a) {
-    if (i)
-      throw new w(
-        `Navigation node at ${n} is missing slug and has no file to derive it from`,
-        n,
+    if (r)
+      throw new b(
+        `Navigation node at ${o} is missing slug and has no file to derive it from`,
+        o,
         e.file
       );
-    a = o ? F(o) : `node-${r}`;
+    a = n ? v(n) : `node-${i}`;
   }
   return {
-    title: o,
+    title: n,
     slug: a,
     file: e.file,
-    children: e.children ? b(e.children, `${n}.children`, i) : void 0,
-    badge: e.badge
+    children: e.children ? $(e.children, `${o}.children`, r) : void 0,
+    badge: e.badge,
+    hidden: e.hidden
   };
 }
-function G(e, t, r) {
+function p(e, t, i) {
   try {
-    const i = D(e, "utf-8"), n = P(i);
-    return n.title && typeof n.title == "string" ? n.title : N(e);
-  } catch (i) {
-    if (r)
-      throw new w(
+    const r = P(e, "utf-8"), o = M(r);
+    return o.title && typeof o.title == "string" ? o.title : F(e);
+  } catch (r) {
+    if (i)
+      throw new b(
         `Failed to read file for title derivation at ${t}: ${e}`,
         t,
         e,
-        i
+        r
       );
-    return N(e);
+    return F(e);
   }
 }
-function Y(e) {
-  return k(e.navigation);
+function X(e) {
+  return R(e.navigation);
 }
-function k(e) {
+function R(e) {
   for (const t of e)
-    if (!t.title || !t.slug || t.children && k(t.children))
+    if (!t.title || !t.slug || t.children && R(t.children))
       return !0;
   return !1;
 }
 export {
-  te as BreadcrumbItemSchema,
-  ie as DocPageMetaSchema,
-  re as DocPageSchema,
-  ne as DocsPackageManifestInputSchema,
-  oe as DocsPackageManifestSchema,
-  se as FlatNavigationNodeSchema,
-  ae as FrontmatterParseError,
-  le as GitHubConfigSchema,
-  ce as LoadedDocsPackageSchema,
-  w as ManifestResolutionError,
-  fe as ManifestValidationError,
-  de as NavigationNodeInputSchema,
-  ue as NavigationNodeSchema,
-  me as SearchConfigSchema,
-  he as VendureVersionSchema,
-  ge as buildBreadcrumbs,
-  O as createNavigationFromFolder,
-  Q as createNestedNavigationFromFolder,
-  P as extractFrontmatterData,
-  ve as findNavigationNode,
-  Fe as flattenNavigation,
-  K as getAllFilePaths,
-  Ne as getLeafNodes,
-  xe as getNodesAtDepth,
-  pe as getPrevNextNodes,
-  Se as hasFrontmatter,
-  we as isNodeActive,
-  Y as manifestNeedsResolution,
-  be as parseFrontmatter,
-  X as resolveManifest,
-  F as slugFromFilename,
-  N as titleFromFilename,
-  T as toSlug,
-  ye as validateFrontmatter,
-  $e as validateManifest
+  _ as BreadcrumbItemSchema,
+  ee as DocPageMetaSchema,
+  te as DocPageSchema,
+  re as DocsPackageManifestInputSchema,
+  ie as DocsPackageManifestSchema,
+  oe as FlatNavigationNodeSchema,
+  xe as FrontmatterParseError,
+  ne as GitHubConfigSchema,
+  se as LoadedDocsPackageSchema,
+  b as ManifestResolutionError,
+  ae as ManifestValidationError,
+  le as NavigationNodeInputSchema,
+  ce as NavigationNodeSchema,
+  fe as SearchConfigSchema,
+  de as VendureVersionSchema,
+  he as buildBreadcrumbs,
+  K as createNavigationFromFolder,
+  O as createNestedNavigationFromFolder,
+  M as extractFrontmatterData,
+  Ee as filterVisibleNavigation,
+  ue as findNavigationNode,
+  ge as flattenNavigation,
+  Me as getAllFilePaths,
+  me as getLeafNodes,
+  ve as getNodesAtDepth,
+  Fe as getPrevNextNodes,
+  be as hasFrontmatter,
+  Ne as isNodeActive,
+  X as manifestNeedsResolution,
+  $e as parseFrontmatter,
+  Q as resolveManifest,
+  v as slugFromFilename,
+  F as titleFromFilename,
+  Ie as toSlug,
+  we as validateFrontmatter,
+  Se as validateManifest
 };