@vendure-io/docs-provider 0.1.0

package/README.md

@@ -0,0 +1,245 @@
+# @vendure-io/docs-provider
+
+Contract types and utilities for Vendure documentation packages. This package defines the shared interface between the docs application (`apps/docs`) and external documentation packages (`@vendure/docs-core`, `@vendure/docs-plugins`, `@vendure/docs-enterprise`).
+
+## Documentation
+
+- [Getting Started](./docs/getting-started.md) - Quick introduction and overview
+- [Creating a Docs Package](./docs/creating-a-docs-package.md) - Step-by-step guide to building a documentation package
+- [Manifest Reference](./docs/manifest-reference.md) - Complete API documentation for manifest types and utilities
+- [Frontmatter Reference](./docs/frontmatter-reference.md) - All available MDX frontmatter options
+- [Publishing](./docs/publishing.md) - How to publish and integrate with vendure.io
+
+## Installation
+
+```bash
+npm install @vendure-io/docs-provider
+# or
+bun add @vendure-io/docs-provider
+```
+
+## Usage
+
+### Defining a Documentation Package Manifest
+
+Documentation packages export a manifest that describes their structure:
+
+```typescript
+import type { DocsPackageManifest } from '@vendure-io/docs-provider'
+
+export const manifest: DocsPackageManifest = {
+  id: 'core',
+  name: 'Vendure Core',
+  version: '3.0.0',
+  vendureVersion: 'v3',
+  navigation: [
+    {
+      title: 'Getting Started',
+      slug: 'getting-started',
+      children: [
+        {
+          title: 'Installation',
+          slug: 'installation',
+          file: 'docs/getting-started/installation.mdx',
+        },
+        {
+          title: 'Configuration',
+          slug: 'configuration',
+          file: 'docs/getting-started/configuration.mdx',
+        },
+      ],
+    },
+  ],
+  search: {
+    indexFields: ['title', 'description', 'content', 'keywords'],
+    boosts: { title: 2, keywords: 1.5 },
+  },
+}
+```
+
+### Loading Documentation Packages
+
+```typescript
+import { loadDocsPackage, loadDocPageBySlug } from '@vendure-io/docs-provider'
+
+// Load a docs package
+const { manifest, basePath } = await loadDocsPackage('@vendure/docs-core')
+
+// Load a specific page by slug
+const page = await loadDocPageBySlug(loadedPackage, 'getting-started/installation')
+if (page) {
+  console.log(page.meta.title) // "Installation"
+  console.log(page.content) // MDX content
+}
+```
+
+### Validating Manifests
+
+```typescript
+import { validateManifest, ManifestValidationError } from '@vendure-io/docs-provider'
+
+try {
+  const manifest = validateManifest(rawManifestData)
+} catch (error) {
+  if (error instanceof ManifestValidationError) {
+    console.error('Validation issues:', error.issues)
+  }
+}
+```
+
+### Navigation Utilities
+
+```typescript
+import {
+  findNavigationNode,
+  flattenNavigation,
+  buildBreadcrumbs,
+  getLeafNodes,
+  getPrevNextNodes,
+} from '@vendure-io/docs-provider'
+
+// Find a node by slug path
+const node = findNavigationNode(manifest, 'getting-started/installation')
+
+// Flatten navigation tree
+const flatNodes = flattenNavigation(manifest)
+
+// Build breadcrumb trail
+const breadcrumbs = buildBreadcrumbs(manifest, 'getting-started/installation')
+// [
+//   { title: 'Getting Started', slug: 'getting-started', path: 'getting-started' },
+//   { title: 'Installation', slug: 'installation', path: 'getting-started/installation' }
+// ]
+
+// Get all pages (nodes with files)
+const pages = getLeafNodes(manifest)
+
+// Get previous/next pages for navigation
+const { prev, next } = getPrevNextNodes(manifest, 'getting-started/installation')
+```
+
+### Parsing MDX Frontmatter
+
+```typescript
+import { parseFrontmatter, hasFrontmatter } from '@vendure-io/docs-provider'
+
+const mdxContent = `---
+title: Installation Guide
+description: Learn how to install Vendure
+keywords:
+  - install
+  - setup
+---
+
+# Installation
+
+Follow these steps to install Vendure...
+`
+
+if (hasFrontmatter(mdxContent)) {
+  const { meta, content } = parseFrontmatter(mdxContent)
+  console.log(meta.title) // "Installation Guide"
+  console.log(content) // "# Installation\n\nFollow these steps..."
+}
+```
+
+## API Reference
+
+### 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                       |
+| `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        |
+
+### Schemas (Zod)
+
+All types have corresponding Zod schemas for runtime validation:
+
+- `DocsPackageManifestSchema`
+- `NavigationNodeSchema`
+- `DocPageSchema`
+- `DocPageMetaSchema`
+- `SearchConfigSchema`
+- `GitHubConfigSchema`
+- `VendureVersionSchema`
+- `FlatNavigationNodeSchema`
+- `BreadcrumbItemSchema`
+- `LoadedDocsPackageSchema`
+
+### Functions
+
+#### Manifest Utilities
+
+| Function                                 | Description                               |
+| ---------------------------------------- | ----------------------------------------- |
+| `validateManifest(data)`                 | Validate raw data against manifest schema |
+| `findNavigationNode(manifest, slugPath)` | Find a node by slug path                  |
+| `flattenNavigation(manifest)`            | Flatten navigation tree to array          |
+| `buildBreadcrumbs(manifest, slugPath)`   | Build breadcrumb trail                    |
+| `getLeafNodes(manifest)`                 | Get all nodes with files                  |
+| `getPrevNextNodes(manifest, slugPath)`   | Get adjacent pages                        |
+| `isNodeActive(node, currentPath)`        | Check if node matches path                |
+| `getNodesAtDepth(manifest, depth)`       | Get nodes at specific depth               |
+
+#### Loader Utilities
+
+| Function                               | Description                      |
+| -------------------------------------- | -------------------------------- |
+| `loadDocsPackage(packageName)`         | Load and validate a docs package |
+| `loadDocPage(package, filePath)`       | Load a page by file path         |
+| `loadDocPageBySlug(package, slugPath)` | Load a page by slug path         |
+| `resolveFilePath(package, node)`       | Resolve full file path           |
+| `isDocsPackageInstalled(packageName)`  | Check if package is installed    |
+| `getAllFilePaths(manifest)`            | Get all file paths from manifest |
+
+#### Frontmatter Utilities
+
+| Function                               | Description                           |
+| -------------------------------------- | ------------------------------------- |
+| `parseFrontmatter(content, filePath?)` | Parse and validate frontmatter        |
+| `validateFrontmatter(data, filePath?)` | Validate frontmatter data             |
+| `hasFrontmatter(content)`              | Check if content has frontmatter      |
+| `extractFrontmatterData(content)`      | Extract raw frontmatter (unvalidated) |
+
+### Error Classes
+
+| Class                     | Description                           |
+| ------------------------- | ------------------------------------- |
+| `ManifestValidationError` | Thrown when manifest validation fails |
+| `FrontmatterParseError`   | Thrown when frontmatter parsing fails |
+| `DocsPackageLoadError`    | Thrown when package loading fails     |
+
+## Development
+
+```bash
+# Install dependencies
+bun install
+
+# Build the package
+bun run build
+
+# Run tests
+bun run test
+
+# Run tests in watch mode
+bun run test:watch
+
+# Type check
+bun run type-check
+
+# Lint
+bun run lint
+```
+
+## License
+
+MIT

package/dist/frontmatter.d.ts

@@ -0,0 +1,89 @@
+import { DocPageMeta } from './types';
+/**
+ * Result of parsing MDX frontmatter
+ */
+export interface ParsedFrontmatter {
+    /** Parsed and validated metadata */
+    meta: DocPageMeta;
+    /** MDX content without frontmatter */
+    content: string;
+}
+/**
+ * Error thrown when frontmatter parsing fails
+ */
+export declare class FrontmatterParseError extends Error {
+    readonly filePath?: string;
+    readonly originalError?: unknown;
+    constructor(message: string, filePath?: string, originalError?: unknown);
+}
+/**
+ * Parse MDX content and extract frontmatter
+ *
+ * @param rawContent - Raw MDX file content including frontmatter
+ * @param filePath - Optional file path for error messages
+ * @returns Parsed frontmatter and content
+ * @throws {FrontmatterParseError} If parsing fails
+ *
+ * @example
+ * ```typescript
+ * const { meta, content } = parseFrontmatter(`---
+ * title: Getting Started
+ * description: Learn how to get started with Vendure
+ * ---
+ *
+ * # Getting Started
+ *
+ * Welcome to Vendure!
+ * `)
+ *
+ * console.log(meta.title) // "Getting Started"
+ * console.log(content) // "# Getting Started\n\nWelcome to Vendure!"
+ * ```
+ */
+export declare function parseFrontmatter(rawContent: string, filePath?: string): ParsedFrontmatter;
+/**
+ * Validate frontmatter data against the DocPageMeta schema
+ *
+ * @param data - Raw frontmatter data object
+ * @param filePath - Optional file path for error messages
+ * @returns Validated DocPageMeta
+ * @throws {FrontmatterParseError} If validation fails
+ *
+ * @example
+ * ```typescript
+ * const meta = validateFrontmatter({
+ *   title: 'Installation',
+ *   description: 'How to install Vendure',
+ *   keywords: ['install', 'setup']
+ * })
+ * ```
+ */
+export declare function validateFrontmatter(data: unknown, filePath?: string): DocPageMeta;
+/**
+ * Check if a string contains frontmatter
+ *
+ * @param content - String to check
+ * @returns True if content starts with frontmatter delimiter
+ *
+ * @example
+ * ```typescript
+ * hasFrontmatter('---\ntitle: Test\n---\n# Content') // true
+ * hasFrontmatter('# Just Content') // false
+ * ```
+ */
+export declare function hasFrontmatter(content: string): boolean;
+/**
+ * Extract just the frontmatter data without parsing the full content
+ * Useful for quick metadata extraction without full parsing overhead
+ *
+ * @param rawContent - Raw MDX content
+ * @returns Raw frontmatter data object (unvalidated)
+ *
+ * @example
+ * ```typescript
+ * const data = extractFrontmatterData('---\ntitle: Test\n---\n# Content')
+ * console.log(data.title) // "Test"
+ * ```
+ */
+export declare function extractFrontmatterData(rawContent: string): Record<string, unknown>;
+//# sourceMappingURL=frontmatter.d.ts.map

package/dist/frontmatter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"frontmatter.d.ts","sourceRoot":"","sources":["../src/frontmatter.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAE1C;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,oCAAoC;IACpC,IAAI,EAAE,WAAW,CAAA;IACjB,sCAAsC;IACtC,OAAO,EAAE,MAAM,CAAA;CAChB;AAED;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,KAAK;IAC9C,SAAgB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjC,SAAgB,aAAa,CAAC,EAAE,OAAO,CAAA;gBAE3B,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO;CAMxE;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAoBzF;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,WAAW,CAgBjF;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAEvD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,sBAAsB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAGlF"}

package/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./manifest-D2yANQB-.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;

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+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 { 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';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +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"}

package/dist/index.js

@@ -0,0 +1,36 @@
+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-B1CxKK1i.js";
+function o(t) {
+  const a = [];
+  return s(t.navigation, a), a;
+}
+function s(t, a) {
+  for (const e of t)
+    e.file && a.push(e.file), e.children && s(e.children, a);
+}
+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
+};

package/dist/loader.cjs

@@ -0,0 +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-D2yANQB-.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;

package/dist/loader.d.ts

@@ -0,0 +1,99 @@
+import { DocPage, LoadedDocsPackage, NavigationNode } from './types';
+/**
+ * Error thrown when loading a docs package fails
+ */
+export declare class DocsPackageLoadError extends Error {
+    readonly packageName?: string;
+    constructor(message: string, packageName?: string);
+}
+/**
+ * Options for loading a docs package
+ */
+export interface LoadDocsPackageOptions {
+    /**
+     * Custom resolver for the package path
+     * Useful for testing or custom package locations
+     */
+    resolver?: (packageName: string) => Promise<string>;
+}
+/**
+ * Load and validate a docs package manifest from an npm package
+ *
+ * This function resolves the package location and loads its manifest.
+ * The manifest is validated against the DocsPackageManifest schema.
+ *
+ * @param packageName - Name of the npm package (e.g., "@vendure/docs-core")
+ * @param options - Optional loading options
+ * @returns Loaded and validated docs package with manifest and base path
+ * @throws {DocsPackageLoadError} If the package cannot be loaded or validated
+ *
+ * @example
+ * ```typescript
+ * const { manifest, basePath } = await loadDocsPackage('@vendure/docs-core')
+ * console.log(manifest.name) // "Vendure Core"
+ * console.log(basePath) // "/path/to/node_modules/@vendure/docs-core"
+ * ```
+ */
+export declare function loadDocsPackage(packageName: string, options?: LoadDocsPackageOptions): Promise<LoadedDocsPackage>;
+/**
+ * Load a documentation page from a docs package
+ *
+ * @param loadedPackage - The loaded docs package
+ * @param filePath - Path to the MDX file relative to package root
+ * @returns Loaded and parsed documentation page
+ * @throws {DocsPackageLoadError} If the page cannot be loaded
+ *
+ * @example
+ * ```typescript
+ * const package = await loadDocsPackage('@vendure/docs-core')
+ * const page = await loadDocPage(package, 'docs/getting-started/installation.mdx')
+ * console.log(page.meta.title) // "Installation"
+ * ```
+ */
+export declare function loadDocPage(loadedPackage: LoadedDocsPackage, filePath: string): Promise<DocPage>;
+/**
+ * Load a documentation page by its slug path
+ *
+ * @param loadedPackage - The loaded docs package
+ * @param slugPath - Slug path (e.g., "getting-started/installation")
+ * @returns Loaded documentation page or undefined if not found
+ *
+ * @example
+ * ```typescript
+ * const package = await loadDocsPackage('@vendure/docs-core')
+ * const page = await loadDocPageBySlug(package, 'getting-started/installation')
+ * if (page) {
+ *   console.log(page.meta.title)
+ * }
+ * ```
+ */
+export declare function loadDocPageBySlug(loadedPackage: LoadedDocsPackage, slugPath: string): Promise<DocPage | undefined>;
+/**
+ * Resolve the full file path for a navigation node
+ *
+ * @param loadedPackage - The loaded docs package
+ * @param node - Navigation node with a file path
+ * @returns Full resolved file path
+ *
+ * @example
+ * ```typescript
+ * const fullPath = resolveFilePath(package, node)
+ * // "/path/to/node_modules/@vendure/docs-core/docs/getting-started/installation.mdx"
+ * ```
+ */
+export declare function resolveFilePath(loadedPackage: LoadedDocsPackage, node: NavigationNode): string | undefined;
+/**
+ * Check if a docs package is installed and loadable
+ *
+ * @param packageName - Name of the npm package
+ * @returns True if the package can be loaded
+ *
+ * @example
+ * ```typescript
+ * if (await isDocsPackageInstalled('@vendure/docs-enterprise')) {
+ *   const enterprise = await loadDocsPackage('@vendure/docs-enterprise')
+ * }
+ * ```
+ */
+export declare function isDocsPackageInstalled(packageName: string): boolean;
+//# sourceMappingURL=loader.d.ts.map

package/dist/loader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loader.d.ts","sourceRoot":"","sources":["../src/loader.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAEzE;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,KAAK;IAC7C,SAAgB,WAAW,CAAC,EAAE,MAAM,CAAA;gBAExB,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM;CAKlD;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,QAAQ,CAAC,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAA;CACpD;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,eAAe,CACnC,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE,sBAA2B,GACnC,OAAO,CAAC,iBAAiB,CAAC,CAiC5B;AAqBD;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,WAAW,CAC/B,aAAa,EAAE,iBAAiB,EAChC,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,OAAO,CAAC,CAiBlB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,iBAAiB,CACrC,aAAa,EAAE,iBAAiB,EAChC,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,CAQ9B;AAqBD;;;;;;;;;;;;GAYG;AACH,wBAAgB,eAAe,CAC7B,aAAa,EAAE,iBAAiB,EAChC,IAAI,EAAE,cAAc,GACnB,MAAM,GAAG,SAAS,CAGpB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,sBAAsB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAOnE"}

package/dist/loader.js

@@ -0,0 +1,90 @@
+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 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-B1CxKK1i.js";
+class a extends Error {
+  constructor(r, n) {
+    super(r);
+    i(this, "packageName");
+    this.name = "DocsPackageLoadError", this.packageName = n;
+  }
+}
+async function y(t, e = {}) {
+  try {
+    const r = e.resolver ? await e.resolver(t) : c(t), n = await import(t);
+    if (!n.manifest)
+      throw new a(
+        `Package "${t}" does not export a manifest`,
+        t
+      );
+    return {
+      manifest: g(n.manifest),
+      basePath: r
+    };
+  } catch (r) {
+    throw r instanceof a ? r : new a(
+      `Failed to load docs package "${t}": ${r instanceof Error ? r.message : String(r)}`,
+      t
+    );
+  }
+}
+function c(t) {
+  try {
+    return h(import.meta.url).resolve(`${t}/package.json`).replace(/\/package\.json$/, "");
+  } catch {
+    throw new a(
+      `Cannot resolve package "${t}". Make sure it is installed.`,
+      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);
+    return {
+      meta: o,
+      content: s,
+      filePath: e
+    };
+  } catch (r) {
+    throw new a(
+      `Failed to load doc page "${e}": ${r instanceof Error ? r.message : String(r)}`,
+      t.manifest.id
+    );
+  }
+}
+async function k(t, e) {
+  const r = u(t.manifest.navigation, e.split("/"));
+  if (r != null && r.file)
+    return p(t, r.file);
+}
+function u(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);
+  }
+}
+function D(t, e) {
+  if (e.file)
+    return `${t.basePath}/${e.file}`;
+}
+function E(t) {
+  try {
+    return c(t), !0;
+  } catch {
+    return !1;
+  }
+}
+export {
+  a as DocsPackageLoadError,
+  E as isDocsPackageInstalled,
+  p as loadDocPage,
+  k as loadDocPageBySlug,
+  y as loadDocsPackage,
+  D as resolveFilePath
+};