@vendure-io/docs-provider 0.3.0 → 0.5.0

package/dist/index.js

@@ -1,36 +1,233 @@
-import { B as n, D as c, a as d, b as m, F as h, c as f, G as l, L as g, M as N, N as S, S as v, V as u, d as F, e as P, f as D, g as p, i as b, j as M, k as x, h as V, l as k, p as A, v as B, m as L } from "./manifest-BJ3t6hu2.js";
-function o(t) {
-  const a = [];
-  return s(t.navigation, a), a;
+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 s(t, a) {
-  for (const e of t)
-    e.file && a.push(e.file), e.children && s(e.children, a);
+function O(e, t = {}) {
+  return C(e, t, 0);
+}
+function C(e, t, i) {
+  const {
+    extensions: r = [".mdx", ".md"],
+    filter: o,
+    sort: n = V,
+    maxDepth: a = 1 / 0,
+    folderFilter: d
+  } = 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 (i < a) {
+    const c = f.filter((l) => l.isDirectory());
+    for (const l of c) {
+      if (d) {
+        const s = N(e, l.name);
+        if (!d(l.name, s))
+          continue;
+      }
+      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: g.filter((y) => !(s && y.file === s.path))
+        });
+      }
+    }
+  }
+  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 k(e, t) {
+  try {
+    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 r;
+  } catch {
+    return [];
+  }
+}
+function L(e, t, i) {
+  let r = {}, o = F(t), n = 1 / 0;
+  try {
+    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: i,
+    frontmatter: r,
+    order: n,
+    title: o,
+    slug: v(t)
+  };
+}
+function W(e, t) {
+  for (const i of t) {
+    const r = N(e, `index${i}`);
+    try {
+      if (T(r).isFile())
+        return L(r, `index${i}`, i);
+    } catch {
+    }
+  }
+}
+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 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: r,
+    search: e.search,
+    github: e.github,
+    basePath: e.basePath
+  };
+}
+function $(e, t, i) {
+  return e.map((r, o) => j(r, t, o, i));
+}
+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 ? $(e.children, `${o}.children`, r) : void 0,
+      badge: e.badge,
+      hidden: e.hidden
+    };
+  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
+      );
+    n = a || `Unknown (${i})`;
+  }
+  if (!a) {
+    if (r)
+      throw new b(
+        `Navigation node at ${o} is missing slug and has no file to derive it from`,
+        o,
+        e.file
+      );
+    a = n ? v(n) : `node-${i}`;
+  }
+  return {
+    title: n,
+    slug: a,
+    file: e.file,
+    children: e.children ? $(e.children, `${o}.children`, r) : void 0,
+    badge: e.badge,
+    hidden: e.hidden
+  };
+}
+function p(e, t, i) {
+  try {
+    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,
+        r
+      );
+    return F(e);
+  }
+}
+function X(e) {
+  return R(e.navigation);
+}
+function R(e) {
+  for (const t of e)
+    if (!t.title || !t.slug || t.children && R(t.children))
+      return !0;
+  return !1;
 }
 export {
-  n as BreadcrumbItemSchema,
-  c as DocPageMetaSchema,
-  d as DocPageSchema,
-  m as DocsPackageManifestSchema,
-  h as FlatNavigationNodeSchema,
-  f as FrontmatterParseError,
-  l as GitHubConfigSchema,
-  g as LoadedDocsPackageSchema,
-  N as ManifestValidationError,
-  S as NavigationNodeSchema,
-  v as SearchConfigSchema,
-  u as VendureVersionSchema,
-  F as buildBreadcrumbs,
-  P as extractFrontmatterData,
-  D as findNavigationNode,
-  p as flattenNavigation,
-  o as getAllFilePaths,
-  b as getLeafNodes,
-  M as getNodesAtDepth,
-  x as getPrevNextNodes,
-  V as hasFrontmatter,
-  k as isNodeActive,
-  A as parseFrontmatter,
-  B as validateFrontmatter,
-  L 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
 };

package/dist/loader.cjs

@@ -1 +1 @@
-"use strict";var g=Object.defineProperty;var h=(e,r,t)=>r in e?g(e,r,{enumerable:!0,configurable:!0,writable:!0,value:t}):e[r]=t;var i=(e,r,t)=>h(e,typeof r!="symbol"?r+"":r,t);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const P=require("fs/promises"),m=require("module"),u=require("./manifest-CNnJGNwK.cjs");var c=typeof document<"u"?document.currentScript:null;class a extends Error{constructor(t,n){super(t);i(this,"packageName");this.name="DocsPackageLoadError",this.packageName=n}}async function p(e,r={}){try{const t=r.resolver?await r.resolver(e):l(e),n=await import(e);if(!n.manifest)throw new a(`Package "${e}" does not export a manifest`,e);return{manifest:u.validateManifest(n.manifest),basePath:t}}catch(t){throw t instanceof a?t:new a(`Failed to load docs package "${e}": ${t instanceof Error?t.message:String(t)}`,e)}}function l(e){try{return m.createRequire(typeof document>"u"?require("url").pathToFileURL(__filename).href:c&&c.tagName.toUpperCase()==="SCRIPT"&&c.src||new URL("loader.cjs",document.baseURI).href).resolve(`${e}/package.json`).replace(/\/package\.json$/,"")}catch{throw new a(`Cannot resolve package "${e}". Make sure it is installed.`,e)}}async function d(e,r){try{const t=`${e.basePath}/${r}`,n=await P.readFile(t,"utf-8"),{meta:o,content:s}=u.parseFrontmatter(n,r);return{meta:o,content:s,filePath:r}}catch(t){throw new a(`Failed to load doc page "${r}": ${t instanceof Error?t.message:String(t)}`,e.manifest.id)}}async function $(e,r){const t=f(e.manifest.navigation,r.split("/"));if(t!=null&&t.file)return d(e,t.file)}function f(e,r){if(r.length===0)return;const[t,...n]=r,o=e.find(s=>s.slug===t);if(o){if(n.length===0)return o;if(o.children)return f(o.children,n)}}function v(e,r){if(r.file)return`${e.basePath}/${r.file}`}function y(e){try{return l(e),!0}catch{return!1}}exports.DocsPackageLoadError=a;exports.isDocsPackageInstalled=y;exports.loadDocPage=d;exports.loadDocPageBySlug=$;exports.loadDocsPackage=p;exports.resolveFilePath=v;
+"use strict";var f=Object.defineProperty;var g=(e,r,t)=>r in e?f(e,r,{enumerable:!0,configurable:!0,writable:!0,value:t}):e[r]=t;var i=(e,r,t)=>g(e,typeof r!="symbol"?r+"":r,t);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const h=require("fs/promises"),P=require("module"),m=require("./frontmatter-_wRoVeyd.cjs"),p=require("./manifest-D8kEDc9X.cjs");var c=typeof document<"u"?document.currentScript:null;class a extends Error{constructor(t,n){super(t);i(this,"packageName");this.name="DocsPackageLoadError",this.packageName=n}}async function $(e,r={}){try{const t=r.resolver?await r.resolver(e):u(e),n=await import(e);if(!n.manifest)throw new a(`Package "${e}" does not export a manifest`,e);return{manifest:p.validateManifest(n.manifest),basePath:t}}catch(t){throw t instanceof a?t:new a(`Failed to load docs package "${e}": ${t instanceof Error?t.message:String(t)}`,e)}}function u(e){try{return P.createRequire(typeof document>"u"?require("url").pathToFileURL(__filename).href:c&&c.tagName.toUpperCase()==="SCRIPT"&&c.src||new URL("loader.cjs",document.baseURI).href).resolve(`${e}/package.json`).replace(/\/package\.json$/,"")}catch{throw new a(`Cannot resolve package "${e}". Make sure it is installed.`,e)}}async function l(e,r){try{const t=`${e.basePath}/${r}`,n=await h.readFile(t,"utf-8"),{meta:o,content:s}=m.parseFrontmatter(n,r);return{meta:o,content:s,filePath:r}}catch(t){throw new a(`Failed to load doc page "${r}": ${t instanceof Error?t.message:String(t)}`,e.manifest.id)}}async function v(e,r){const t=d(e.manifest.navigation,r.split("/"));if(t!=null&&t.file)return l(e,t.file)}function d(e,r){if(r.length===0)return;const[t,...n]=r,o=e.find(s=>s.slug===t);if(o){if(n.length===0)return o;if(o.children)return d(o.children,n)}}function y(e,r){if(r.file)return`${e.basePath}/${r.file}`}function w(e){try{return u(e),!0}catch{return!1}}exports.DocsPackageLoadError=a;exports.isDocsPackageInstalled=w;exports.loadDocPage=l;exports.loadDocPageBySlug=v;exports.loadDocsPackage=$;exports.resolveFilePath=y;

package/dist/loader.js

@@ -1,9 +1,10 @@
-var f = Object.defineProperty;
-var l = (t, e, r) => e in t ? f(t, e, { enumerable: !0, configurable: !0, writable: !0, value: r }) : t[e] = r;
+var u = Object.defineProperty;
+var l = (t, e, r) => e in t ? u(t, e, { enumerable: !0, configurable: !0, writable: !0, value: r }) : t[e] = r;
 var i = (t, e, r) => l(t, typeof e != "symbol" ? e + "" : e, r);
 import { readFile as d } from "fs/promises";
 import { createRequire as h } from "module";
-import { m as g, p as m } from "./manifest-BJ3t6hu2.js";
+import { p as g } from "./frontmatter-8Bwpoi8r.js";
+import { v as m } from "./manifest-B_cvT6F9.js";
 class a extends Error {
   constructor(r, n) {
     super(r);
@@ -11,7 +12,7 @@ class a extends Error {
     this.name = "DocsPackageLoadError", this.packageName = n;
   }
 }
-async function y(t, e = {}) {
+async function k(t, e = {}) {
   try {
     const r = e.resolver ? await e.resolver(t) : c(t), n = await import(t);
     if (!n.manifest)
@@ -20,7 +21,7 @@ async function y(t, e = {}) {
         t
       );
     return {
-      manifest: g(n.manifest),
+      manifest: m(n.manifest),
       basePath: r
     };
   } catch (r) {
@@ -42,7 +43,7 @@ function c(t) {
 }
 async function p(t, e) {
   try {
-    const r = `${t.basePath}/${e}`, n = await d(r, "utf-8"), { meta: o, content: s } = m(n, e);
+    const r = `${t.basePath}/${e}`, n = await d(r, "utf-8"), { meta: o, content: s } = g(n, e);
     return {
       meta: o,
       content: s,
@@ -55,25 +56,25 @@ async function p(t, e) {
     );
   }
 }
-async function k(t, e) {
-  const r = u(t.manifest.navigation, e.split("/"));
+async function D(t, e) {
+  const r = f(t.manifest.navigation, e.split("/"));
   if (r != null && r.file)
     return p(t, r.file);
 }
-function u(t, e) {
+function f(t, e) {
   if (e.length === 0) return;
   const [r, ...n] = e, o = t.find((s) => s.slug === r);
   if (o) {
     if (n.length === 0) return o;
     if (o.children)
-      return u(o.children, n);
+      return f(o.children, n);
   }
 }
-function D(t, e) {
+function E(t, e) {
   if (e.file)
     return `${t.basePath}/${e.file}`;
 }
-function E(t) {
+function F(t) {
   try {
     return c(t), !0;
   } catch {
@@ -82,9 +83,9 @@ function E(t) {
 }
 export {
   a as DocsPackageLoadError,
-  E as isDocsPackageInstalled,
+  F as isDocsPackageInstalled,
   p as loadDocPage,
-  k as loadDocPageBySlug,
-  y as loadDocsPackage,
-  D as resolveFilePath
+  D as loadDocPageBySlug,
+  k as loadDocsPackage,
+  E as resolveFilePath
 };

package/dist/manifest-B_cvT6F9.js

@@ -0,0 +1,181 @@
+var P = Object.defineProperty;
+var S = (i, t, e) => t in i ? P(i, t, { enumerable: !0, configurable: !0, writable: !0, value: e }) : i[t] = e;
+var g = (i, t, e) => S(i, typeof t != "symbol" ? t + "" : t, e);
+import { z as n } from "zod";
+const d = n.enum(["v1", "v2", "v3"]), u = n.object({
+  indexFields: n.array(n.enum(["title", "description", "content", "keywords"])),
+  boosts: n.record(n.string(), n.number()).optional()
+}), h = n.object({
+  repository: n.string().regex(/^[^/]+\/[^/]+$/, 'Repository must be in format "owner/repo"'),
+  branch: n.string().optional(),
+  docsPath: n.string().optional()
+}), c = n.lazy(
+  () => n.object({
+    title: n.string().min(1, "Navigation title is required"),
+    slug: n.string().min(1, "Navigation slug is required"),
+    file: n.string().optional(),
+    children: n.array(c).optional(),
+    badge: n.string().optional(),
+    hidden: n.boolean().optional()
+  })
+), f = n.object({
+  id: n.string().min(1, "Package ID is required"),
+  name: n.string().min(1, "Package name is required"),
+  version: n.string().regex(/^\d+\.\d+\.\d+/, "Version must be valid semver"),
+  vendureVersion: d,
+  navigation: n.array(c),
+  search: u.optional(),
+  github: h.optional(),
+  basePath: n.string().optional()
+}), y = n.object({
+  title: n.string().min(1, "Page title is required"),
+  description: n.string().optional(),
+  keywords: n.array(n.string()).optional(),
+  sidebarLabel: n.string().optional(),
+  hidden: n.boolean().optional(),
+  order: n.number().int().optional()
+}), I = n.object({
+  meta: y,
+  content: n.string(),
+  filePath: n.string()
+}), q = n.object({
+  manifest: f,
+  basePath: n.string()
+}), B = n.object({
+  title: n.string(),
+  slug: n.string(),
+  path: n.string()
+}), M = n.object({
+  title: n.string(),
+  slug: n.string(),
+  file: n.string().optional(),
+  children: n.array(n.lazy(() => c)).optional(),
+  badge: n.string().optional(),
+  hidden: n.boolean().optional(),
+  path: n.string(),
+  depth: n.number().int().min(0),
+  parentPath: n.string().optional()
+}), m = n.lazy(
+  () => n.object({
+    title: n.string().min(1).optional(),
+    slug: n.string().min(1).optional(),
+    file: n.string().optional(),
+    children: n.array(m).optional(),
+    badge: n.string().optional(),
+    hidden: n.boolean().optional()
+  })
+), $ = n.object({
+  id: n.string().min(1, "Package ID is required"),
+  name: n.string().min(1, "Package name is required"),
+  version: n.string().regex(/^\d+\.\d+\.\d+/, "Version must be valid semver"),
+  vendureVersion: d,
+  navigation: n.array(m),
+  search: u.optional(),
+  github: h.optional(),
+  basePath: n.string().optional()
+});
+class j extends Error {
+  constructor(e, o) {
+    super(e);
+    g(this, "issues");
+    this.name = "ManifestValidationError", this.issues = o;
+  }
+}
+function w(i) {
+  const t = f.safeParse(i);
+  if (!t.success) {
+    const e = t.error.issues.map((o) => `${o.path.join(".")}: ${o.message}`);
+    throw new j("Invalid manifest", e);
+  }
+  return t.data;
+}
+function z(i, t) {
+  const e = t.split("/").filter(Boolean);
+  return p(i.navigation, e);
+}
+function p(i, t) {
+  if (t.length === 0) return;
+  const [e, ...o] = t, a = i.find((r) => r.slug === e);
+  if (a) {
+    if (o.length === 0) return a;
+    if (a.children)
+      return p(a.children, o);
+  }
+}
+function b(i) {
+  const t = [];
+  return v(i.navigation, "", 0, void 0, t), t;
+}
+function v(i, t, e, o, a) {
+  for (const r of i) {
+    const s = t ? `${t}/${r.slug}` : r.slug;
+    a.push({
+      ...r,
+      path: s,
+      depth: e,
+      parentPath: o
+    }), r.children && r.children.length > 0 && v(r.children, s, e + 1, s, a);
+  }
+}
+function L(i, t) {
+  const e = t.split("/").filter(Boolean), o = [];
+  let a = i.navigation, r = "";
+  for (const s of e) {
+    const l = a.find((N) => N.slug === s);
+    if (!l) break;
+    r = r ? `${r}/${s}` : s, o.push({
+      title: l.title,
+      slug: l.slug,
+      path: r
+    }), a = l.children ?? [];
+  }
+  return o;
+}
+function k(i) {
+  return b(i).filter((t) => t.file !== void 0);
+}
+function E(i, t) {
+  const e = k(i), o = e.findIndex((a) => a.path === t);
+  return o === -1 ? {} : {
+    prev: o > 0 ? e[o - 1] : void 0,
+    next: o < e.length - 1 ? e[o + 1] : void 0
+  };
+}
+function x(i, t) {
+  const e = t.split("/").filter(Boolean);
+  if (e.length === 0) return !1;
+  if (i.slug === e[0]) {
+    if (e.length === 1) return !0;
+    if (i.children) {
+      const o = e.slice(1).join("/");
+      return i.children.some((a) => x(a, o));
+    }
+  }
+  return !1;
+}
+function F(i, t) {
+  return b(i).filter((e) => e.depth === t);
+}
+export {
+  B,
+  y as D,
+  M as F,
+  h as G,
+  q as L,
+  j as M,
+  m as N,
+  u as S,
+  d as V,
+  I as a,
+  $ as b,
+  f as c,
+  c as d,
+  L as e,
+  z as f,
+  b as g,
+  k as h,
+  F as i,
+  E as j,
+  x as k,
+  w as v
+};

package/dist/manifest-D8kEDc9X.cjs

@@ -0,0 +1 @@
+"use strict";var D=Object.defineProperty;var j=(i,t,n)=>t in i?D(i,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):i[t]=n;var f=(i,t,n)=>j(i,typeof t!="symbol"?t+"":t,n);const e=require("zod"),g=e.z.enum(["v1","v2","v3"]),d=e.z.object({indexFields:e.z.array(e.z.enum(["title","description","content","keywords"])),boosts:e.z.record(e.z.string(),e.z.number()).optional()}),u=e.z.object({repository:e.z.string().regex(/^[^/]+\/[^/]+$/,'Repository must be in format "owner/repo"'),branch:e.z.string().optional(),docsPath:e.z.string().optional()}),l=e.z.lazy(()=>e.z.object({title:e.z.string().min(1,"Navigation title is required"),slug:e.z.string().min(1,"Navigation slug is required"),file:e.z.string().optional(),children:e.z.array(l).optional(),badge:e.z.string().optional(),hidden:e.z.boolean().optional()})),h=e.z.object({id:e.z.string().min(1,"Package ID is required"),name:e.z.string().min(1,"Package name is required"),version:e.z.string().regex(/^\d+\.\d+\.\d+/,"Version must be valid semver"),vendureVersion:g,navigation:e.z.array(l),search:d.optional(),github:u.optional(),basePath:e.z.string().optional()}),p=e.z.object({title:e.z.string().min(1,"Page title is required"),description:e.z.string().optional(),keywords:e.z.array(e.z.string()).optional(),sidebarLabel:e.z.string().optional(),hidden:e.z.boolean().optional(),order:e.z.number().int().optional()}),k=e.z.object({meta:p,content:e.z.string(),filePath:e.z.string()}),I=e.z.object({manifest:h,basePath:e.z.string()}),M=e.z.object({title:e.z.string(),slug:e.z.string(),path:e.z.string()}),V=e.z.object({title:e.z.string(),slug:e.z.string(),file:e.z.string().optional(),children:e.z.array(e.z.lazy(()=>l)).optional(),badge:e.z.string().optional(),hidden:e.z.boolean().optional(),path:e.z.string(),depth:e.z.number().int().min(0),parentPath:e.z.string().optional()}),z=e.z.lazy(()=>e.z.object({title:e.z.string().min(1).optional(),slug:e.z.string().min(1).optional(),file:e.z.string().optional(),children:e.z.array(z).optional(),badge:e.z.string().optional(),hidden:e.z.boolean().optional()})),x=e.z.object({id:e.z.string().min(1,"Package ID is required"),name:e.z.string().min(1,"Package name is required"),version:e.z.string().regex(/^\d+\.\d+\.\d+/,"Version must be valid semver"),vendureVersion:g,navigation:e.z.array(z),search:d.optional(),github:u.optional(),basePath:e.z.string().optional()});class b extends Error{constructor(n,o){super(n);f(this,"issues");this.name="ManifestValidationError",this.issues=o}}function q(i){const t=h.safeParse(i);if(!t.success){const n=t.error.issues.map(o=>`${o.path.join(".")}: ${o.message}`);throw new b("Invalid manifest",n)}return t.data}function B(i,t){const n=t.split("/").filter(Boolean);return v(i.navigation,n)}function v(i,t){if(t.length===0)return;const[n,...o]=t,a=i.find(r=>r.slug===n);if(a){if(o.length===0)return a;if(a.children)return v(a.children,o)}}function m(i){const t=[];return N(i.navigation,"",0,void 0,t),t}function N(i,t,n,o,a){for(const r of i){const s=t?`${t}/${r.slug}`:r.slug;a.push({...r,path:s,depth:n,parentPath:o}),r.children&&r.children.length>0&&N(r.children,s,n+1,s,a)}}function $(i,t){const n=t.split("/").filter(Boolean),o=[];let a=i.navigation,r="";for(const s of n){const c=a.find(y=>y.slug===s);if(!c)break;r=r?`${r}/${s}`:s,o.push({title:c.title,slug:c.slug,path:r}),a=c.children??[]}return o}function S(i){return m(i).filter(t=>t.file!==void 0)}function w(i,t){const n=S(i),o=n.findIndex(a=>a.path===t);return o===-1?{}:{prev:o>0?n[o-1]:void 0,next:o<n.length-1?n[o+1]:void 0}}function P(i,t){const n=t.split("/").filter(Boolean);if(n.length===0)return!1;if(i.slug===n[0]){if(n.length===1)return!0;if(i.children){const o=n.slice(1).join("/");return i.children.some(a=>P(a,o))}}return!1}function L(i,t){return m(i).filter(n=>n.depth===t)}exports.BreadcrumbItemSchema=M;exports.DocPageMetaSchema=p;exports.DocPageSchema=k;exports.DocsPackageManifestInputSchema=x;exports.DocsPackageManifestSchema=h;exports.FlatNavigationNodeSchema=V;exports.GitHubConfigSchema=u;exports.LoadedDocsPackageSchema=I;exports.ManifestValidationError=b;exports.NavigationNodeInputSchema=z;exports.NavigationNodeSchema=l;exports.SearchConfigSchema=d;exports.VendureVersionSchema=g;exports.buildBreadcrumbs=$;exports.findNavigationNode=B;exports.flattenNavigation=m;exports.getLeafNodes=S;exports.getNodesAtDepth=L;exports.getPrevNextNodes=w;exports.isNodeActive=P;exports.validateManifest=q;

package/dist/manifest-resolver.d.ts

@@ -0,0 +1,59 @@
+import { DocsPackageManifest, DocsPackageManifestInput } from './types';
+/**
+ * Error thrown when manifest resolution fails
+ */
+export declare class ManifestResolutionError extends Error {
+    readonly nodePath?: string;
+    readonly filePath?: string;
+    readonly originalError?: unknown;
+    constructor(message: string, nodePath?: string, filePath?: string, originalError?: unknown);
+}
+/**
+ * Options for manifest resolution
+ */
+export interface ResolveManifestOptions {
+    /**
+     * Whether to throw an error if a file cannot be read.
+     * If false, nodes without valid files will use filename-derived values.
+     * @default true
+     */
+    strict?: boolean;
+}
+/**
+ * Resolve a manifest input by deriving missing title/slug values from files.
+ *
+ * For navigation nodes:
+ * - If `title` is missing, reads from frontmatter `title` or derives from filename
+ * - If `slug` is missing, derives from filename
+ *
+ * @param input - The manifest input with optional title/slug
+ * @param options - Resolution options
+ * @returns Fully resolved DocsPackageManifest
+ * @throws {ManifestResolutionError} If resolution fails (in strict mode)
+ *
+ * @example
+ * ```typescript
+ * const input: DocsPackageManifestInput = {
+ *   id: 'my-docs',
+ *   name: 'My Docs',
+ *   version: '1.0.0',
+ *   vendureVersion: 'v3',
+ *   navigation: [
+ *     { file: file('docs/getting-started.mdx') }, // title & slug derived
+ *     { title: 'Custom Title', file: file('docs/intro.mdx') }, // only slug derived
+ *   ],
+ * }
+ *
+ * const manifest = resolveManifest(input)
+ * ```
+ */
+export declare function resolveManifest(input: DocsPackageManifestInput, options?: ResolveManifestOptions): DocsPackageManifest;
+/**
+ * Check if a manifest input needs resolution
+ * (i.e., has any navigation nodes with missing title or slug)
+ *
+ * @param input - The manifest input to check
+ * @returns True if resolution is needed
+ */
+export declare function manifestNeedsResolution(input: DocsPackageManifestInput): boolean;
+//# sourceMappingURL=manifest-resolver.d.ts.map

package/dist/manifest-resolver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifest-resolver.d.ts","sourceRoot":"","sources":["../src/manifest-resolver.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,mBAAmB,EACnB,wBAAwB,EAGzB,MAAM,SAAS,CAAA;AAEhB;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,KAAK;IAChD,SAAgB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjC,SAAgB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjC,SAAgB,aAAa,CAAC,EAAE,OAAO,CAAA;gBAE3B,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO;CAO3F;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,eAAe,CAC7B,KAAK,EAAE,wBAAwB,EAC/B,OAAO,GAAE,sBAA2B,GACnC,mBAAmB,CAerB;AAwHD;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,wBAAwB,GAAG,OAAO,CAEhF"}

package/dist/mdx-components.d.ts

@@ -51,8 +51,8 @@ export interface GenerationInfoProps {
  * ```
  */
 export interface MemberInfoProps {
-    /** Member kind: method, property, getter, setter, constructor */
-    kind: 'method' | 'property' | 'getter' | 'setter' | 'constructor';
+    /** Member kind: method, property, getter, setter, constructor, parameter */
+    kind: 'method' | 'property' | 'getter' | 'setter' | 'constructor' | 'parameter';
     /** TypeScript type signature (accepts JSX with links) */
     type: unknown;
     /** Version when this member was introduced */
@@ -153,8 +153,56 @@ export interface GraphQLDocProps {
     /** GraphQL SDL content */
     children: unknown;
 }
+/**
+ * LinkCard Component
+ *
+ * A card-style link that provides more visual prominence than a standard link.
+ * Displays a title, optional subtitle, and an arrow indicator.
+ *
+ * @example
+ * ```mdx
+ * <LinkCard
+ *   href="/guides/getting-started"
+ *   title="Getting Started"
+ *   subtitle="Learn how to set up your first project"
+ * />
+ * ```
+ */
+export interface LinkCardProps {
+    /** URL to navigate to (internal or external) */
+    href: string;
+    /** Primary text displayed on the card */
+    title: string;
+    /** Secondary text displayed below the title */
+    subtitle?: string;
+    /** Additional content (alternative to subtitle for richer content) */
+    children?: unknown;
+}
+/**
+ * DocsLink Component
+ *
+ * An inline link component that automatically prefixes relative URLs with the
+ * current documentation version and package ID. This is the recommended way to
+ * create cross-references in generated documentation.
+ *
+ * Key features:
+ * - Relative paths (starting with `/`) are automatically prefixed with `/{version}/{packageId}`
+ * - Uses Next.js Link for client-side navigation (no full page reload)
+ * - External links open in a new tab
+ *
+ * @example
+ * ```mdx
+ * See the <DocsLink href="/reference/typescript-api/request/request-context">RequestContext</DocsLink> docs.
+ * ```
+ */
+export interface DocsLinkProps {
+    /** URL to navigate to (relative paths will be prefixed with version/packageId) */
+    href: string;
+    /** Link text content */
+    children: unknown;
+}
 /**
  * Union type of all MDX component props for type checking
  */
-export type MdxComponentProps = GenerationInfoProps | MemberInfoProps | MemberDescriptionProps | CustomFieldPropertyProps | StackblitzProps | GraphQLDocProps;
+export type MdxComponentProps = GenerationInfoProps | MemberInfoProps | MemberDescriptionProps | CustomFieldPropertyProps | StackblitzProps | GraphQLDocProps | LinkCardProps | DocsLinkProps;
 //# sourceMappingURL=mdx-components.d.ts.map