@commercetools/nimbus-docs-build 0.0.0-canary-20251107124701

package/dist/schemas/mdx-document.d.ts

@@ -0,0 +1,233 @@
+/**
+ * Zod schemas for MDX document validation
+ */
+import { z } from "zod";
+export declare const TocItemSchema: z.ZodObject<{
+    value: z.ZodString;
+    href: z.ZodString;
+    depth: z.ZodNumber;
+    numbering: z.ZodArray<z.ZodNumber>;
+    parent: z.ZodString;
+}, z.core.$strip>;
+/** Available layout types for MDX documents */
+export declare const layoutTypes: readonly ["app-frame", "no-sidebar"];
+/** Schema for tab metadata describing available views for a document */
+export declare const TabMetadataSchema: z.ZodObject<{
+    key: z.ZodString;
+    title: z.ZodString;
+    order: z.ZodNumber;
+}, z.core.$strip>;
+/** the schema that is being generated from the mdx-file parser and
+ * needed by the app to properly render the document
+ */
+export declare const mdxDocumentSchema: z.ZodObject<{
+    meta: z.ZodObject<{
+        id: z.ZodString;
+        title: z.ZodString;
+        description: z.ZodString;
+        lifecycleState: z.ZodOptional<z.ZodEnum<{
+            Experimental: "Experimental";
+            Alpha: "Alpha";
+            Beta: "Beta";
+            Stable: "Stable";
+            Deprecated: "Deprecated";
+            EOL: "EOL";
+        }>>;
+        order: z.ZodNumber;
+        repoPath: z.ZodString;
+        menu: z.ZodArray<z.ZodString>;
+        route: z.ZodString;
+        tags: z.ZodArray<z.ZodString>;
+        toc: z.ZodArray<z.ZodObject<{
+            value: z.ZodString;
+            href: z.ZodString;
+            depth: z.ZodNumber;
+            numbering: z.ZodArray<z.ZodNumber>;
+            parent: z.ZodString;
+        }, z.core.$strip>>;
+        icon: z.ZodOptional<z.ZodString>;
+        figmaLink: z.ZodOptional<z.ZodString>;
+        layout: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
+            "app-frame": "app-frame";
+            "no-sidebar": "no-sidebar";
+        }>>>;
+        tabs: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            key: z.ZodString;
+            title: z.ZodString;
+            order: z.ZodNumber;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>;
+    mdx: z.ZodString;
+    views: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodObject<{
+        mdx: z.ZodString;
+        toc: z.ZodArray<z.ZodObject<{
+            value: z.ZodString;
+            href: z.ZodString;
+            depth: z.ZodNumber;
+            numbering: z.ZodArray<z.ZodNumber>;
+            parent: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+/** the schema for validating a payload to generate or modify a file */
+export declare const mdxDocumentPayloadSchema: z.ZodObject<{
+    mdx: z.ZodString;
+    views: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodObject<{
+        mdx: z.ZodString;
+        toc: z.ZodArray<z.ZodObject<{
+            value: z.ZodString;
+            href: z.ZodString;
+            depth: z.ZodNumber;
+            numbering: z.ZodArray<z.ZodNumber>;
+            parent: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>>;
+    meta: z.ZodObject<{
+        title: z.ZodString;
+        order: z.ZodNumber;
+        id: z.ZodString;
+        description: z.ZodString;
+        lifecycleState: z.ZodOptional<z.ZodEnum<{
+            Experimental: "Experimental";
+            Alpha: "Alpha";
+            Beta: "Beta";
+            Stable: "Stable";
+            Deprecated: "Deprecated";
+            EOL: "EOL";
+        }>>;
+        menu: z.ZodArray<z.ZodString>;
+        tags: z.ZodArray<z.ZodString>;
+        icon: z.ZodOptional<z.ZodString>;
+        figmaLink: z.ZodOptional<z.ZodString>;
+        layout: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
+            "app-frame": "app-frame";
+            "no-sidebar": "no-sidebar";
+        }>>>;
+        tabs: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            key: z.ZodString;
+            title: z.ZodString;
+            order: z.ZodNumber;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export declare const routeInfoSchema: z.ZodObject<{
+    path: z.ZodString;
+    id: z.ZodString;
+    title: z.ZodString;
+    description: z.ZodString;
+    lifecycleState: z.ZodOptional<z.ZodEnum<{
+        Experimental: "Experimental";
+        Alpha: "Alpha";
+        Beta: "Beta";
+        Stable: "Stable";
+        Deprecated: "Deprecated";
+        EOL: "EOL";
+    }>>;
+    category: z.ZodString;
+    tags: z.ZodArray<z.ZodString>;
+    menu: z.ZodArray<z.ZodString>;
+    order: z.ZodNumber;
+    chunkName: z.ZodString;
+    icon: z.ZodOptional<z.ZodString>;
+    tabs: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        title: z.ZodString;
+        order: z.ZodNumber;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export declare const categoryInfoSchema: z.ZodObject<{
+    id: z.ZodString;
+    label: z.ZodString;
+    order: z.ZodNumber;
+    items: z.ZodArray<z.ZodObject<{
+        path: z.ZodString;
+        id: z.ZodString;
+        title: z.ZodString;
+        description: z.ZodString;
+        lifecycleState: z.ZodOptional<z.ZodEnum<{
+            Experimental: "Experimental";
+            Alpha: "Alpha";
+            Beta: "Beta";
+            Stable: "Stable";
+            Deprecated: "Deprecated";
+            EOL: "EOL";
+        }>>;
+        category: z.ZodString;
+        tags: z.ZodArray<z.ZodString>;
+        menu: z.ZodArray<z.ZodString>;
+        order: z.ZodNumber;
+        chunkName: z.ZodString;
+        icon: z.ZodOptional<z.ZodString>;
+        tabs: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            key: z.ZodString;
+            title: z.ZodString;
+            order: z.ZodNumber;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const routeManifestSchema: z.ZodObject<{
+    routes: z.ZodArray<z.ZodObject<{
+        path: z.ZodString;
+        id: z.ZodString;
+        title: z.ZodString;
+        description: z.ZodString;
+        lifecycleState: z.ZodOptional<z.ZodEnum<{
+            Experimental: "Experimental";
+            Alpha: "Alpha";
+            Beta: "Beta";
+            Stable: "Stable";
+            Deprecated: "Deprecated";
+            EOL: "EOL";
+        }>>;
+        category: z.ZodString;
+        tags: z.ZodArray<z.ZodString>;
+        menu: z.ZodArray<z.ZodString>;
+        order: z.ZodNumber;
+        chunkName: z.ZodString;
+        icon: z.ZodOptional<z.ZodString>;
+        tabs: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            key: z.ZodString;
+            title: z.ZodString;
+            order: z.ZodNumber;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+    categories: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        label: z.ZodString;
+        order: z.ZodNumber;
+        items: z.ZodArray<z.ZodObject<{
+            path: z.ZodString;
+            id: z.ZodString;
+            title: z.ZodString;
+            description: z.ZodString;
+            lifecycleState: z.ZodOptional<z.ZodEnum<{
+                Experimental: "Experimental";
+                Alpha: "Alpha";
+                Beta: "Beta";
+                Stable: "Stable";
+                Deprecated: "Deprecated";
+                EOL: "EOL";
+            }>>;
+            category: z.ZodString;
+            tags: z.ZodArray<z.ZodString>;
+            menu: z.ZodArray<z.ZodString>;
+            order: z.ZodNumber;
+            chunkName: z.ZodString;
+            icon: z.ZodOptional<z.ZodString>;
+            tabs: z.ZodDefault<z.ZodArray<z.ZodObject<{
+                key: z.ZodString;
+                title: z.ZodString;
+                order: z.ZodNumber;
+            }, z.core.$strip>>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    navigation: z.ZodRecord<z.ZodString, z.ZodObject<{
+        label: z.ZodString;
+        items: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            title: z.ZodString;
+            path: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+//# sourceMappingURL=mdx-document.d.ts.map

package/dist/schemas/mdx-document.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mdx-document.d.ts","sourceRoot":"","sources":["../../src/schemas/mdx-document.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,eAAO,MAAM,aAAa;;;;;;iBAMxB,CAAC;AAEH,+CAA+C;AAC/C,eAAO,MAAM,WAAW,sCAAuC,CAAC;AAEhE,wEAAwE;AACxE,eAAO,MAAM,iBAAiB;;;;iBAO5B,CAAC;AAUH;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAsC5B,CAAC;AAWH,uEAAuE;AACvE,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAEnC,CAAC;AAEH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;iBAa1B,CAAC;AAEH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAK7B,CAAC;AAaH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAI9B,CAAC"}

package/dist/schemas/mdx-document.js

@@ -0,0 +1,118 @@
+/**
+ * Zod schemas for MDX document validation
+ */
+import { z } from "zod";
+import { lifecycleStates } from "./lifecycle-states.js";
+export const TocItemSchema = z.object({
+    value: z.string(),
+    href: z.string(),
+    depth: z.number(),
+    numbering: z.array(z.number()),
+    parent: z.string(),
+});
+/** Available layout types for MDX documents */
+export const layoutTypes = ["app-frame", "no-sidebar"];
+/** Schema for tab metadata describing available views for a document */
+export const TabMetadataSchema = z.object({
+    /** Unique key for the view (e.g., "overview", "api", "examples") */
+    key: z.string(),
+    /** Display title for the tab */
+    title: z.string(),
+    /** Sort order for tabs (ascending) */
+    order: z.number(),
+});
+/** Schema for a single view (e.g., overview, api, dev) containing MDX content and TOC */
+const viewSchema = z.object({
+    /** the mdx content as a single string */
+    mdx: z.string(),
+    /** table of contents of the document */
+    toc: z.array(TocItemSchema),
+});
+/** the schema that is being generated from the mdx-file parser and
+ * needed by the app to properly render the document
+ */
+export const mdxDocumentSchema = z.object({
+    meta: z.object({
+        /** a unique identifier for this document */
+        id: z.string(),
+        /** the title of the document*/
+        title: z.string(),
+        /** a one sentence description of the file-contents */
+        description: z.string(),
+        /** the lifecycle state of the component/feature */
+        lifecycleState: z.enum(lifecycleStates).optional(),
+        /** menu display order */
+        order: z.number(),
+        /** the path to the file within the repo, from the repo-root */
+        repoPath: z.string(),
+        /**
+         * Array of menu labels
+         * e.g. ["Getting Started", "API Reference"]
+         */
+        menu: z.array(z.string()),
+        /** unique, browser-route, generated from the menu array */
+        route: z.string(),
+        /** tags one might use to search for this page */
+        tags: z.array(z.string()),
+        /** table of contents of the document */
+        toc: z.array(TocItemSchema),
+        /** icon associated with this document */
+        icon: z.string().optional(),
+        /** a link to a figma-design or -node */
+        figmaLink: z.string().url().optional(),
+        /** layout type - defaults to 'app-frame' if not specified */
+        layout: z.enum(layoutTypes).optional().default("app-frame"),
+        /** array of available tabs/views for this document */
+        tabs: z.array(TabMetadataSchema).default([]),
+    }),
+    /** the mdx content as a single string (main/default view) */
+    mdx: z.string(),
+    /** map of view key to view content (e.g., { "overview": {...}, "api": {...} }) */
+    views: z.record(z.string(), viewSchema).default({}),
+});
+const metaSchemaWithoutGeneratedMeta = mdxDocumentSchema.shape.meta.omit({
+    /** generated, based on the file-path starting from the repo-root */
+    repoPath: true,
+    /** generated, based on the menu-array value*/
+    route: true,
+    /** generated, parsed from the heading structure of the markdown content */
+    toc: true,
+});
+/** the schema for validating a payload to generate or modify a file */
+export const mdxDocumentPayloadSchema = mdxDocumentSchema.extend({
+    meta: metaSchemaWithoutGeneratedMeta,
+});
+export const routeInfoSchema = z.object({
+    path: z.string(),
+    id: z.string(),
+    title: z.string(),
+    description: z.string(),
+    lifecycleState: z.enum(lifecycleStates).optional(),
+    category: z.string(),
+    tags: z.array(z.string()),
+    menu: z.array(z.string()),
+    order: z.number(),
+    chunkName: z.string(),
+    icon: z.string().optional(),
+    tabs: z.array(TabMetadataSchema).default([]),
+});
+export const categoryInfoSchema = z.object({
+    id: z.string(),
+    label: z.string(),
+    order: z.number(),
+    items: z.array(routeInfoSchema),
+});
+const navigationItemSchema = z.object({
+    label: z.string(),
+    items: z.array(z.object({
+        id: z.string(),
+        title: z.string(),
+        path: z.string(),
+    })),
+});
+export const routeManifestSchema = z.object({
+    routes: z.array(routeInfoSchema),
+    categories: z.array(categoryInfoSchema),
+    navigation: z.record(z.string(), navigationItemSchema),
+});
+//# sourceMappingURL=mdx-document.js.map

package/dist/schemas/mdx-document.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mdx-document.js","sourceRoot":"","sources":["../../src/schemas/mdx-document.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC9B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;CACnB,CAAC,CAAC;AAEH,+CAA+C;AAC/C,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,WAAW,EAAE,YAAY,CAAU,CAAC;AAEhE,wEAAwE;AACxE,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,oEAAoE;IACpE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,gCAAgC;IAChC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,sCAAsC;IACtC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;CAClB,CAAC,CAAC;AAEH,yFAAyF;AACzF,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1B,yCAAyC;IACzC,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,wCAAwC;IACxC,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC;CAC5B,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;QACb,4CAA4C;QAC5C,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;QACd,+BAA+B;QAC/B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;QACjB,sDAAsD;QACtD,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;QACvB,mDAAmD;QACnD,cAAc,EAAE,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,QAAQ,EAAE;QAClD,yBAAyB;QACzB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;QACjB,+DAA+D;QAC/D,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;QACpB;;;WAGG;QACH,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;QACzB,2DAA2D;QAC3D,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;QACjB,iDAAiD;QACjD,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;QACzB,wCAAwC;QACxC,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC;QAC3B,yCAAyC;QACzC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC3B,wCAAwC;QACxC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;QACtC,6DAA6D;QAC7D,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC;QAC3D,sDAAsD;QACtD,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;KAC7C,CAAC;IACF,6DAA6D;IAC7D,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,kFAAkF;IAClF,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,UAAU,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;CACpD,CAAC,CAAC;AAEH,MAAM,8BAA8B,GAAG,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;IACvE,oEAAoE;IACpE,QAAQ,EAAE,IAAI;IACd,8CAA8C;IAC9C,KAAK,EAAE,IAAI;IACX,2EAA2E;IAC3E,GAAG,EAAE,IAAI;CACV,CAAC,CAAC;AAEH,uEAAuE;AACvE,MAAM,CAAC,MAAM,wBAAwB,GAAG,iBAAiB,CAAC,MAAM,CAAC;IAC/D,IAAI,EAAE,8BAA8B;CACrC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,cAAc,EAAE,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,QAAQ,EAAE;IAClD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACzB,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACzB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;CAC7C,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC;CAChC,CAAC,CAAC;AAEH,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,KAAK,EAAE,CAAC,CAAC,KAAK,CACZ,CAAC,CAAC,MAAM,CAAC;QACP,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;QACd,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;QACjB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;KACjB,CAAC,CACH;CACF,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC;IAChC,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC;IACvC,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,oBAAoB,CAAC;CACvD,CAAC,CAAC"}

package/dist/types/config.d.ts

@@ -0,0 +1,106 @@
+/**
+ * Configuration types for the documentation build system
+ */
+import type { PropItem } from "react-docgen-typescript";
+export interface DocsBuilderConfig {
+    /**
+     * Source configuration - where to find content
+     */
+    sources: {
+        /** Root directory containing packages to scan for MDX files */
+        packagesDir: string;
+        /** Path to component index file for type extraction */
+        componentIndexPath?: string;
+    };
+    /**
+     * Output configuration - where to write generated files
+     */
+    output: {
+        /** Directory for per-route JSON files */
+        routesDir: string;
+        /** Path for route manifest JSON file */
+        manifestPath: string;
+        /** Path for search index JSON file */
+        searchIndexPath: string;
+        /** Directory for component type JSON files */
+        typesDir: string;
+        /** Directory for optimized assets (optional) */
+        assetsDir?: string;
+        /** Path for robots.txt file (optional) */
+        robotsPath?: string;
+        /** Path for sitemap.xml file (optional) */
+        sitemapPath?: string;
+    };
+    /**
+     * Build cache configuration
+     */
+    cache?: {
+        /** Enable incremental builds with caching */
+        enabled: boolean;
+        /** Custom cache directory (optional, defaults to .cache) */
+        cacheDir?: string;
+    };
+    /**
+     * SEO file generation
+     */
+    seo?: {
+        /** Base URL for sitemap generation */
+        baseUrl: string;
+        /** Generate robots.txt */
+        generateRobots?: boolean;
+        /** Generate sitemap.xml */
+        generateSitemap?: boolean;
+    };
+    /**
+     * Custom prop filtering function
+     * Return true to keep the prop, false to filter it out
+     */
+    propFilter?: (prop: PropItem) => boolean;
+    /**
+     * Content validation options
+     */
+    validation?: {
+        /** Enable content validation */
+        enabled: boolean;
+        /** Strict mode - fail on warnings */
+        strict?: boolean;
+    };
+    /**
+     * Asset optimization options
+     */
+    assets?: {
+        /** Enable asset optimization */
+        enabled: boolean;
+        /** Image extensions to process */
+        imageExtensions?: string[];
+    };
+}
+export interface BuildResult {
+    /** Number of routes generated */
+    routeCount: number;
+    /** Number of components with types extracted */
+    componentCount: number;
+    /** Build duration in milliseconds */
+    duration: number;
+    /** Whether cache was used */
+    cacheUsed: boolean;
+    /** Number of files rebuilt */
+    filesRebuilt: number;
+    /** Number of files served from cache */
+    filesCached: number;
+}
+export interface ValidationError {
+    file: string;
+    message: string;
+    severity: "error" | "warning";
+}
+export interface CacheEntry {
+    hash: string;
+    timestamp: number;
+    outputPath: string;
+}
+export interface BuildCache {
+    version: string;
+    files: Map<string, CacheEntry>;
+}
+//# sourceMappingURL=config.d.ts.map

package/dist/types/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/types/config.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AAExD,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,OAAO,EAAE;QACP,+DAA+D;QAC/D,WAAW,EAAE,MAAM,CAAC;QACpB,uDAAuD;QACvD,kBAAkB,CAAC,EAAE,MAAM,CAAC;KAC7B,CAAC;IAEF;;OAEG;IACH,MAAM,EAAE;QACN,yCAAyC;QACzC,SAAS,EAAE,MAAM,CAAC;QAClB,wCAAwC;QACxC,YAAY,EAAE,MAAM,CAAC;QACrB,sCAAsC;QACtC,eAAe,EAAE,MAAM,CAAC;QACxB,8CAA8C;QAC9C,QAAQ,EAAE,MAAM,CAAC;QACjB,gDAAgD;QAChD,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,0CAA0C;QAC1C,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,2CAA2C;QAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;IAEF;;OAEG;IACH,KAAK,CAAC,EAAE;QACN,6CAA6C;QAC7C,OAAO,EAAE,OAAO,CAAC;QACjB,4DAA4D;QAC5D,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IAEF;;OAEG;IACH,GAAG,CAAC,EAAE;QACJ,sCAAsC;QACtC,OAAO,EAAE,MAAM,CAAC;QAChB,0BAA0B;QAC1B,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB,2BAA2B;QAC3B,eAAe,CAAC,EAAE,OAAO,CAAC;KAC3B,CAAC;IAEF;;;OAGG;IACH,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,OAAO,CAAC;IAEzC;;OAEG;IACH,UAAU,CAAC,EAAE;QACX,gCAAgC;QAChC,OAAO,EAAE,OAAO,CAAC;QACjB,qCAAqC;QACrC,MAAM,CAAC,EAAE,OAAO,CAAC;KAClB,CAAC;IAEF;;OAEG;IACH,MAAM,CAAC,EAAE;QACP,gCAAgC;QAChC,OAAO,EAAE,OAAO,CAAC;QACjB,kCAAkC;QAClC,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;KAC5B,CAAC;CACH;AAED,MAAM,WAAW,WAAW;IAC1B,iCAAiC;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,gDAAgD;IAChD,cAAc,EAAE,MAAM,CAAC;IACvB,qCAAqC;IACrC,QAAQ,EAAE,MAAM,CAAC;IACjB,6BAA6B;IAC7B,SAAS,EAAE,OAAO,CAAC;IACnB,8BAA8B;IAC9B,YAAY,EAAE,MAAM,CAAC;IACrB,wCAAwC;IACxC,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAC;CAC/B;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;CAChC"}

package/dist/types/config.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=config.js.map

package/dist/types/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/types/config.ts"],"names":[],"mappings":""}

package/dist/types/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Type exports for documentation build system
+ */
+export * from "./mdx.js";
+export * from "./config.js";
+export type { LifecycleState } from "../schemas/lifecycle-states.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,YAAY,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC"}

package/dist/types/index.js

@@ -0,0 +1,6 @@
+/**
+ * Type exports for documentation build system
+ */
+export * from "./mdx.js";
+export * from "./config.js";
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC"}

package/dist/types/mdx.d.ts

@@ -0,0 +1,16 @@
+/**
+ * TypeScript type definitions for MDX documents
+ */
+import { z } from "zod";
+import { mdxDocumentSchema, mdxDocumentPayloadSchema, TocItemSchema, TabMetadataSchema, layoutTypes, routeInfoSchema, categoryInfoSchema, routeManifestSchema } from "../schemas/mdx-document.js";
+export type MdxDocument = z.infer<typeof mdxDocumentSchema>;
+export type MdxDocumentPayload = z.infer<typeof mdxDocumentPayloadSchema>;
+export type TocItem = z.infer<typeof TocItemSchema>;
+export type TabMetadata = z.infer<typeof TabMetadataSchema>;
+export type LayoutType = (typeof layoutTypes)[number];
+export type RouteInfo = z.infer<typeof routeInfoSchema>;
+export type CategoryInfo = z.infer<typeof categoryInfoSchema>;
+export type RouteManifest = z.infer<typeof routeManifestSchema>;
+export type MdxFileMeta = MdxDocument["meta"];
+export type MdxViews = MdxDocument["views"];
+//# sourceMappingURL=mdx.d.ts.map

package/dist/types/mdx.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mdx.d.ts","sourceRoot":"","sources":["../../src/types/mdx.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACL,iBAAiB,EACjB,wBAAwB,EACxB,aAAa,EACb,iBAAiB,EACjB,WAAW,EACX,eAAe,EACf,kBAAkB,EAClB,mBAAmB,EACpB,MAAM,4BAA4B,CAAC;AAEpC,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAC5D,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAC1E,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AACpD,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAC5D,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC;AAEtD,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AACxD,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAC9D,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAGhE,MAAM,MAAM,WAAW,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;AAC9C,MAAM,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC"}

package/dist/types/mdx.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=mdx.js.map

package/dist/types/mdx.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mdx.js","sourceRoot":"","sources":["../../src/types/mdx.ts"],"names":[],"mappings":""}

package/dist/utils/file-utils.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Recursively find the monorepo root by checking for "workspaces" in package.json.
+ * @param dir The starting directory to search from.
+ * @returns The absolute path to the monorepo root or null if not found.
+ */
+export declare function findMonorepoRoot(dir: string): Promise<string | null>;
+/**
+ * Get the relative path from the monorepo root to the specified file path.
+ * @param filePath The file path to calculate the relative path for.
+ * @returns The relative path from the monorepo root to the file path.
+ * @throws If the monorepo root cannot be found.
+ */
+export declare function getPathFromMonorepoRoot(filePath: string): Promise<string>;
+/**
+ * Find all files with a specific extension recursively
+ * @param dir Directory to search
+ * @param extension File extension to match (e.g., ".mdx")
+ * @returns Array of file paths
+ */
+export declare function findFiles(dir: string, extension: string): Promise<string[]>;
+/**
+ * Find all files matching multiple extensions
+ * @param dir Directory to search
+ * @param extensions Array of extensions to match
+ * @returns Array of file paths
+ */
+export declare function findFilesByExtensions(dir: string, extensions: string[]): Promise<string[]>;
+//# sourceMappingURL=file-utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"file-utils.d.ts","sourceRoot":"","sources":["../../src/utils/file-utils.ts"],"names":[],"mappings":"AAMA;;;;GAIG;AACH,wBAAsB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAqB1E;AAED;;;;;GAKG;AACH,wBAAsB,uBAAuB,CAC3C,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,MAAM,CAAC,CAYjB;AAED;;;;;GAKG;AACH,wBAAsB,SAAS,CAC7B,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,MAAM,EAAE,CAAC,CA8BnB;AAED;;;;;GAKG;AACH,wBAAsB,qBAAqB,CACzC,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,MAAM,EAAE,GACnB,OAAO,CAAC,MAAM,EAAE,CAAC,CA8BnB"}