@vendure-io/docs-provider 0.1.0

package/dist/manifest-B1CxKK1i.js

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

package/dist/manifest-D2yANQB-.cjs

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

package/dist/manifest.d.ts

@@ -0,0 +1,127 @@
+import { BreadcrumbItem, DocsPackageManifest, FlatNavigationNode, NavigationNode } from './types';
+/**
+ * Error thrown when manifest validation fails
+ */
+export declare class ManifestValidationError extends Error {
+    readonly issues: string[];
+    constructor(message: string, issues: string[]);
+}
+/**
+ * Validate a manifest against the DocsPackageManifest schema
+ *
+ * @param manifest - Raw manifest data to validate
+ * @returns Validated DocsPackageManifest
+ * @throws {ManifestValidationError} If validation fails
+ *
+ * @example
+ * ```typescript
+ * const manifest = validateManifest({
+ *   id: 'core',
+ *   name: 'Vendure Core',
+ *   version: '3.0.0',
+ *   vendureVersion: 'v3',
+ *   navigation: [...]
+ * })
+ * ```
+ */
+export declare function validateManifest(manifest: unknown): DocsPackageManifest;
+/**
+ * Find a navigation node by its slug path
+ *
+ * @param manifest - The docs package manifest
+ * @param slugPath - Slash-separated path (e.g., "getting-started/installation")
+ * @returns The found navigation node or undefined
+ *
+ * @example
+ * ```typescript
+ * const node = findNavigationNode(manifest, 'getting-started/installation')
+ * if (node) {
+ *   console.log(node.title) // "Installation"
+ * }
+ * ```
+ */
+export declare function findNavigationNode(manifest: DocsPackageManifest, slugPath: string): NavigationNode | undefined;
+/**
+ * Flatten the navigation tree into a flat array with path information
+ *
+ * @param manifest - The docs package manifest
+ * @returns Array of flattened navigation nodes with full paths
+ *
+ * @example
+ * ```typescript
+ * const flatNodes = flattenNavigation(manifest)
+ * flatNodes.forEach(node => {
+ *   console.log(`${node.path}: ${node.title}`)
+ * })
+ * ```
+ */
+export declare function flattenNavigation(manifest: DocsPackageManifest): FlatNavigationNode[];
+/**
+ * Build breadcrumb trail for a given slug path
+ *
+ * @param manifest - The docs package manifest
+ * @param slugPath - Slash-separated path (e.g., "getting-started/installation")
+ * @returns Array of breadcrumb items from root to current
+ *
+ * @example
+ * ```typescript
+ * const breadcrumbs = buildBreadcrumbs(manifest, 'getting-started/installation')
+ * // [
+ * //   { title: 'Getting Started', slug: 'getting-started', path: 'getting-started' },
+ * //   { title: 'Installation', slug: 'installation', path: 'getting-started/installation' }
+ * // ]
+ * ```
+ */
+export declare function buildBreadcrumbs(manifest: DocsPackageManifest, slugPath: string): BreadcrumbItem[];
+/**
+ * Get all leaf nodes (pages with files) from the navigation tree
+ *
+ * @param manifest - The docs package manifest
+ * @returns Array of navigation nodes that have file paths
+ *
+ * @example
+ * ```typescript
+ * const pages = getLeafNodes(manifest)
+ * pages.forEach(page => {
+ *   console.log(`${page.title}: ${page.file}`)
+ * })
+ * ```
+ */
+export declare function getLeafNodes(manifest: DocsPackageManifest): FlatNavigationNode[];
+/**
+ * Get the previous and next navigation nodes relative to a given path
+ * Useful for prev/next navigation at the bottom of docs pages
+ *
+ * @param manifest - The docs package manifest
+ * @param slugPath - Current page's slug path
+ * @returns Object with prev and next nodes (either may be undefined)
+ *
+ * @example
+ * ```typescript
+ * const { prev, next } = getPrevNextNodes(manifest, 'getting-started/installation')
+ * if (prev) console.log('Previous:', prev.title)
+ * if (next) console.log('Next:', next.title)
+ * ```
+ */
+export declare function getPrevNextNodes(manifest: DocsPackageManifest, slugPath: string): {
+    prev?: FlatNavigationNode;
+    next?: FlatNavigationNode;
+};
+/**
+ * Check if a navigation node or any of its children matches a path
+ * Useful for determining if a nav section should be expanded
+ *
+ * @param node - Navigation node to check
+ * @param currentPath - Current page path
+ * @returns True if node or any descendant matches the path
+ */
+export declare function isNodeActive(node: NavigationNode, currentPath: string): boolean;
+/**
+ * Get all navigation nodes at a specific depth level
+ *
+ * @param manifest - The docs package manifest
+ * @param depth - Depth level (0 = root level)
+ * @returns Array of nodes at the specified depth
+ */
+export declare function getNodesAtDepth(manifest: DocsPackageManifest, depth: number): FlatNavigationNode[];
+//# sourceMappingURL=manifest.d.ts.map

package/dist/manifest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifest.d.ts","sourceRoot":"","sources":["../src/manifest.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,cAAc,EACd,mBAAmB,EACnB,kBAAkB,EAClB,cAAc,EACf,MAAM,SAAS,CAAA;AAEhB;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,KAAK;IAChD,SAAgB,MAAM,EAAE,MAAM,EAAE,CAAA;gBAEpB,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE;CAK9C;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,OAAO,GAAG,mBAAmB,CAWvE;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,mBAAmB,EAC7B,QAAQ,EAAE,MAAM,GACf,cAAc,GAAG,SAAS,CAG5B;AAqBD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,mBAAmB,GAAG,kBAAkB,EAAE,CAIrF;AA4BD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,mBAAmB,EAC7B,QAAQ,EAAE,MAAM,GACf,cAAc,EAAE,CAqBlB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,mBAAmB,GAAG,kBAAkB,EAAE,CAEhF;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,mBAAmB,EAC7B,QAAQ,EAAE,MAAM,GACf;IAAE,IAAI,CAAC,EAAE,kBAAkB,CAAC;IAAC,IAAI,CAAC,EAAE,kBAAkB,CAAA;CAAE,CAY1D;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAc/E;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC7B,QAAQ,EAAE,mBAAmB,EAC7B,KAAK,EAAE,MAAM,GACZ,kBAAkB,EAAE,CAEtB"}

package/dist/navigation-utils.d.ts

@@ -0,0 +1,15 @@
+import { DocsPackageManifest } from './types';
+/**
+ * Get all file paths from a manifest's navigation tree
+ *
+ * @param manifest - The docs package manifest
+ * @returns Array of all file paths in the navigation
+ *
+ * @example
+ * ```typescript
+ * const files = getAllFilePaths(manifest)
+ * // ['docs/getting-started/installation.mdx', 'docs/getting-started/configuration.mdx', ...]
+ * ```
+ */
+export declare function getAllFilePaths(manifest: DocsPackageManifest): string[];
+//# sourceMappingURL=navigation-utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"navigation-utils.d.ts","sourceRoot":"","sources":["../src/navigation-utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAkB,MAAM,SAAS,CAAA;AAElE;;;;;;;;;;;GAWG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,mBAAmB,GAAG,MAAM,EAAE,CAIvE"}