@contractspec/bundle.library 3.8.10 → 3.8.12

package/dist/node/components/docs/guides/GuideDocsPipelinePage.js

@@ -1,145 +1,6 @@
-// src/components/docs/shared/StudioPrompt.tsx
-import Link from "@contractspec/lib.ui-link";
-import { jsx, jsxs } from "react/jsx-runtime";
-function StudioPrompt({
-  title = "Need the operating layer on top of OSS ContractSpec?",
-  body = "ContractSpec Studio helps teams turn evidence into proposed spec changes, governed delivery loops, and execution-ready task packs while keeping the open contract system as the source of truth.",
-  ctaLabel = "See what Studio adds",
-  href = "https://www.contractspec.studio/docs"
-}) {
-  return /* @__PURE__ */ jsxs("div", {
-    className: "card-subtle space-y-3 p-6",
-    children: [
-      /* @__PURE__ */ jsx("h3", {
-        className: "font-semibold text-lg",
-        children: title
-      }),
-      /* @__PURE__ */ jsx("p", {
-        className: "text-muted-foreground text-sm",
-        children: body
-      }),
-      /* @__PURE__ */ jsx(Link, {
-        href,
-        className: "btn-primary",
-        children: ctaLabel
-      })
-    ]
-  });
-}
-
-// src/components/docs/guides/GuideDocsPipelinePage.tsx
-import { CodeBlock } from "@contractspec/lib.design-system";
-import Link2 from "@contractspec/lib.ui-link";
-import { ChevronRight } from "lucide-react";
-import { jsx as jsx2, jsxs as jsxs2 } from "react/jsx-runtime";
-function GuideDocsPipelinePage() {
-  return /* @__PURE__ */ jsxs2("div", {
-    className: "space-y-8",
-    children: [
-      /* @__PURE__ */ jsxs2("div", {
-        className: "space-y-3",
-        children: [
-          /* @__PURE__ */ jsx2("h1", {
-            className: "font-bold text-4xl",
-            children: "Build the docs pipeline"
-          }),
-          /* @__PURE__ */ jsx2("p", {
-            className: "text-lg text-muted-foreground",
-            children: "Generate reference docs, chunk the index, and wire the docs pages the same way this repo does."
-          })
-        ]
-      }),
-      /* @__PURE__ */ jsxs2("div", {
-        className: "card-subtle space-y-4 p-6",
-        children: [
-          /* @__PURE__ */ jsx2("h2", {
-            className: "font-bold text-2xl",
-            children: "What you'll build"
-          }),
-          /* @__PURE__ */ jsxs2("ul", {
-            className: "space-y-2 text-muted-foreground text-sm",
-            children: [
-              /* @__PURE__ */ jsx2("li", {
-                children: "Generated Markdown and a chunked index manifest."
-              }),
-              /* @__PURE__ */ jsx2("li", {
-                children: "Reference routes powered by the docs loader."
-              }),
-              /* @__PURE__ */ jsx2("li", {
-                children: "Versioned outputs you can publish per release."
-              })
-            ]
-          })
-        ]
-      }),
-      /* @__PURE__ */ jsxs2("div", {
-        className: "space-y-6",
-        children: [
-          /* @__PURE__ */ jsxs2("div", {
-            className: "space-y-3",
-            children: [
-              /* @__PURE__ */ jsx2("h2", {
-                className: "font-bold text-2xl",
-                children: "1) Generate contract docs"
-              }),
-              /* @__PURE__ */ jsx2(CodeBlock, {
-                language: "bash",
-                filename: "generate-contract-docs",
-                code: `contractspec generate`
-              }),
-              /* @__PURE__ */ jsxs2("p", {
-                className: "text-muted-foreground text-sm",
-                children: [
-                  "Expected output: Markdown in ",
-                  /* @__PURE__ */ jsx2("code", {
-                    children: "generated/docs"
-                  }),
-                  "."
-                ]
-              })
-            ]
-          }),
-          /* @__PURE__ */ jsxs2("div", {
-            className: "space-y-3",
-            children: [
-              /* @__PURE__ */ jsx2("h2", {
-                className: "font-bold text-2xl",
-                children: "2) Build the docs index"
-              }),
-              /* @__PURE__ */ jsx2(CodeBlock, {
-                language: "bash",
-                filename: "docs-generate",
-                code: `bun docs:generate
+import l from"@contractspec/lib.ui-link";import{jsx as o,jsxs as p}from"react/jsx-runtime";function d({title:n="Need the operating layer on top of OSS ContractSpec?",body:r="ContractSpec Studio helps teams turn evidence into proposed spec changes, governed delivery loops, and execution-ready task packs while keeping the open contract system as the source of truth.",ctaLabel:i="See what Studio adds",href:s="https://www.contractspec.studio/docs"}){return p("div",{className:"card-subtle space-y-3 p-6",children:[o("h3",{className:"font-semibold text-lg",children:n}),o("p",{className:"text-muted-foreground text-sm",children:r}),o(l,{href:s,className:"btn-primary",children:i})]})}import{CodeBlock as a}from"@contractspec/lib.design-system";import c from"@contractspec/lib.ui-link";import{ChevronRight as u}from"lucide-react";import{jsx as e,jsxs as t}from"react/jsx-runtime";function y(){return t("div",{className:"space-y-8",children:[t("div",{className:"space-y-3",children:[e("h1",{className:"font-bold text-4xl",children:"Build the docs pipeline"}),e("p",{className:"text-lg text-muted-foreground",children:"Generate reference docs, chunk the index, and wire the docs pages the same way this repo does."})]}),t("div",{className:"card-subtle space-y-4 p-6",children:[e("h2",{className:"font-bold text-2xl",children:"What you'll build"}),t("ul",{className:"space-y-2 text-muted-foreground text-sm",children:[e("li",{children:"Generated Markdown and a chunked index manifest."}),e("li",{children:"Reference routes powered by the docs loader."}),e("li",{children:"Versioned outputs you can publish per release."})]})]}),t("div",{className:"space-y-6",children:[t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"1) Generate contract docs"}),e(a,{language:"bash",filename:"generate-contract-docs",code:"contractspec generate"}),t("p",{className:"text-muted-foreground text-sm",children:["Expected output: Markdown in ",e("code",{children:"generated/docs"}),"."]})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"2) Build the docs index"}),e(a,{language:"bash",filename:"docs-generate",code:`bun docs:generate
 # versioned output
-bun docs:generate -- --version v1.0.0`
-              }),
-              /* @__PURE__ */ jsxs2("p", {
-                className: "text-muted-foreground text-sm",
-                children: [
-                  "This writes ",
-                  /* @__PURE__ */ jsx2("code", {
-                    children: "docs-index.manifest.json"
-                  }),
-                  " and chunked",
-                  /* @__PURE__ */ jsx2("code", {
-                    children: "docs-index.*.json"
-                  }),
-                  " files in the generated docs bundle."
-                ]
-              })
-            ]
-          }),
-          /* @__PURE__ */ jsxs2("div", {
-            className: "space-y-3",
-            children: [
-              /* @__PURE__ */ jsx2("h2", {
-                className: "font-bold text-2xl",
-                children: "3) Wire reference routes"
-              }),
-              /* @__PURE__ */ jsx2(CodeBlock, {
-                language: "tsx",
-                filename: "docs-reference-route",
-                code: `import { notFound } from "next/navigation";
+bun docs:generate -- --version v1.0.0`}),t("p",{className:"text-muted-foreground text-sm",children:["This writes ",e("code",{children:"docs-index.manifest.json"})," and chunked",e("code",{children:"docs-index.*.json"})," files in the generated docs bundle."]})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"3) Wire reference routes"}),e(a,{language:"tsx",filename:"docs-reference-route",code:`import { notFound } from "next/navigation";
 import {
   DocsReferenceIndexPage,
   DocsReferencePage,
@@ -157,69 +18,4 @@ export default async function Page({ params }: { params: { slug?: string[] } })
   const doc = await getGeneratedDocById(slug);
   if (!doc) notFound();
   return <DocsReferencePage entry={doc.entry} content={doc.content} />;
-}`
-              }),
-              /* @__PURE__ */ jsxs2("p", {
-                className: "text-muted-foreground text-sm",
-                children: [
-                  "Use the index page on ",
-                  /* @__PURE__ */ jsx2("code", {
-                    children: "/docs/reference"
-                  }),
-                  " to render the searchable list."
-                ]
-              })
-            ]
-          }),
-          /* @__PURE__ */ jsxs2("div", {
-            className: "card-subtle space-y-3 p-6",
-            children: [
-              /* @__PURE__ */ jsx2("h3", {
-                className: "font-semibold text-lg",
-                children: "Repo reference"
-              }),
-              /* @__PURE__ */ jsxs2("p", {
-                className: "text-muted-foreground text-sm",
-                children: [
-                  "This repo wires docs under",
-                  " ",
-                  /* @__PURE__ */ jsx2("code", {
-                    children: "packages/apps/web-landing/src/app/docs/reference"
-                  }),
-                  "."
-                ]
-              })
-            ]
-          }),
-          /* @__PURE__ */ jsx2(StudioPrompt, {
-            title: "Need decision-to-export automation?",
-            body: "Studio exports evidence-backed spec changes and task packs to Linear, Jira, Notion, and GitHub."
-          })
-        ]
-      }),
-      /* @__PURE__ */ jsxs2("div", {
-        className: "flex items-center gap-4 pt-4",
-        children: [
-          /* @__PURE__ */ jsxs2(Link2, {
-            href: "/docs/guides/ci-contract-diff-gating",
-            className: "btn-primary",
-            children: [
-              "Next: CI gating ",
-              /* @__PURE__ */ jsx2(ChevronRight, {
-                size: 16
-              })
-            ]
-          }),
-          /* @__PURE__ */ jsx2(Link2, {
-            href: "/docs/guides",
-            className: "btn-ghost",
-            children: "Back to guides"
-          })
-        ]
-      })
-    ]
-  });
-}
-export {
-  GuideDocsPipelinePage
-};
+}`}),t("p",{className:"text-muted-foreground text-sm",children:["Use the index page on ",e("code",{children:"/docs/reference"})," to render the searchable list."]})]}),t("div",{className:"card-subtle space-y-3 p-6",children:[e("h3",{className:"font-semibold text-lg",children:"Repo reference"}),t("p",{className:"text-muted-foreground text-sm",children:["This repo wires docs under"," ",e("code",{children:"packages/apps/web-landing/src/app/docs/reference"}),"."]})]}),e(d,{title:"Need decision-to-export automation?",body:"Studio exports evidence-backed spec changes and task packs to Linear, Jira, Notion, and GitHub."})]}),t("div",{className:"flex items-center gap-4 pt-4",children:[t(c,{href:"/docs/guides/ci-contract-diff-gating",className:"btn-primary",children:["Next: CI gating ",e(u,{size:16})]}),e(c,{href:"/docs/guides",className:"btn-ghost",children:"Back to guides"})]})]})}export{y as GuideDocsPipelinePage};

package/dist/node/components/docs/guides/GuideFirstModuleBundlePage.js

@@ -0,0 +1,75 @@
+import{CodeBlock as a}from"@contractspec/lib.design-system";import r from"@contractspec/lib.ui-link";import{ChevronRight as o}from"lucide-react";import{jsx as e,jsxs as t}from"react/jsx-runtime";function l(){return t("div",{className:"space-y-8",children:[t("div",{className:"space-y-3",children:[e("h1",{className:"font-bold text-4xl",children:"Build a first module bundle"}),e("p",{className:"text-lg text-muted-foreground",children:"Define one bundle spec, resolve it for a real route and preference profile, then render the resulting surface plan through the React host layer."})]}),t("div",{className:"card-subtle space-y-4 p-6",children:[e("h2",{className:"font-bold text-2xl",children:"What you'll build"}),t("ul",{className:"space-y-2 text-muted-foreground text-sm",children:[e("li",{children:"One `ModuleBundleSpec` with a route and workbench surface."}),e("li",{children:"One `ResolvedSurfacePlan` from `resolveBundle`."}),e("li",{children:"One React host using `BundleProvider` and `BundleRenderer`."})]})]}),t("div",{className:"space-y-6",children:[t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"1) Define the bundle spec"}),e("p",{className:"text-muted-foreground text-sm",children:"The bundle spec is the durable contract. It owns route selection, surface shape, layouts, data recipes, and verification coverage for all seven preference dimensions."}),e(a,{language:"typescript",filename:"src/bundles/support.workbench.bundle.ts",code:`import { defineModuleBundle } from "@contractspec/lib.surface-runtime/spec/define-module-bundle";
+
+export const SupportWorkbenchBundle = defineModuleBundle({
+  meta: {
+    key: "support.workbench",
+    version: "0.1.0",
+    title: "Support Workbench",
+  },
+  routes: [
+    {
+      routeId: "support-ticket",
+      path: "/operate/support/tickets/:ticketId",
+      defaultSurface: "ticket-workbench",
+    },
+  ],
+  surfaces: {
+    "ticket-workbench": {
+      surfaceId: "ticket-workbench",
+      kind: "workbench",
+      slots: [
+        { slotId: "primary", role: "primary", accepts: ["entity-section"], cardinality: "many" },
+        { slotId: "assistant", role: "assistant", accepts: ["assistant-panel"], cardinality: "many", mutableByAi: true, mutableByUser: true },
+      ],
+      layouts: [
+        { layoutId: "balanced", title: "Balanced", root: { type: "slot", slotId: "primary" } },
+      ],
+      data: [
+        { recipeId: "ticket-core", source: { kind: "entity", entityType: "support.ticket" }, hydrateInto: "ticket" },
+      ],
+      verification: {
+        dimensions: {
+          guidance: "Surface can reveal walkthrough or inline help states.",
+          density: "Layout supports compact and balanced detail modes.",
+          dataDepth: "Resolver can hydrate summary or detailed ticket context.",
+          control: "Advanced actions stay policy-gated.",
+          media: "Surface supports text-first and hybrid assist modes.",
+          pace: "Transitions and confirmations adapt to operator pace.",
+          narrative: "Summary and evidence ordering stay explicit.",
+        },
+      },
+    },
+  },
+});`}),e("p",{className:"text-muted-foreground text-sm",children:"Expected output: `defineModuleBundle` validates the route, surface, and verification dimensions at runtime."})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"2) Resolve the plan"}),e("p",{className:"text-muted-foreground text-sm",children:"Resolve against a real route, device, and preference profile. This is where the runtime chooses the surface, layout, bindings, and audit reasons."}),e(a,{language:"typescript",filename:"src/runtime/resolve-support-workbench.ts",code:`import { resolveBundle } from "@contractspec/lib.surface-runtime/runtime/resolve-bundle";
+
+export const supportWorkbenchPlan = await resolveBundle(
+  SupportWorkbenchBundle,
+  {
+    tenantId: "tenant_demo",
+    workspaceId: "workspace_ops",
+    actorId: "user_42",
+    route: "/operate/support/tickets/123",
+    params: { ticketId: "123" },
+    query: {},
+    device: "desktop",
+    locale: "en",
+    preferences: {
+      guidance: "hints",
+      density: "compact",
+      dataDepth: "detailed",
+      control: "advanced",
+      media: "hybrid",
+      pace: "balanced",
+      narrative: "top-down",
+    },
+    capabilities: ["tickets.read", "tickets.update"],
+  }
+);`}),e("p",{className:"text-muted-foreground text-sm",children:"Expected output: a `ResolvedSurfacePlan` with `bundleKey`, `surfaceId`, `layoutId`, `bindings`, `adaptation`, and audit reasons."})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"3) Render the plan"}),e("p",{className:"text-muted-foreground text-sm",children:"The host app renders the resolved plan, not the raw spec. That keeps layout selection, overlays, and AI proposals downstream of the declared bundle contract."}),e(a,{language:"tsx",filename:"src/app/support/SurfaceHost.tsx",code:`import { BundleProvider, BundleRenderer } from "@contractspec/lib.surface-runtime/react";
+
+export function SurfaceHost() {
+  return (
+    <BundleProvider plan={supportWorkbenchPlan}>
+      <BundleRenderer assistantSlotId="assistant" />
+    </BundleProvider>
+  );
+}`}),e("p",{className:"text-muted-foreground text-sm",children:"Expected output: the route renders according to the resolved layout root and slot plan instead of bespoke page assembly."})]}),t("div",{className:"card-subtle space-y-3 p-6",children:[e("h3",{className:"font-semibold text-lg",children:"Verification checks"}),t("ul",{className:"space-y-2 text-muted-foreground text-sm",children:[e("li",{children:"The resolved `surfaceId` matches the route you expected."}),e("li",{children:"The `layoutId` is stable for the active view and preferences."}),e("li",{children:"The plan carries audit reasons and all seven adaptation dimensions."}),e("li",{children:"Assistant or overlay work stays within declared slots."})]})]})]}),t("div",{className:"flex items-center gap-4 pt-4",children:[t(r,{href:"/docs/specs/module-bundles",className:"btn-primary",children:["Back to module bundles ",e(o,{size:16})]}),e(r,{href:"/docs/specs/overlays",className:"btn-ghost",children:"Next: overlays"})]})]})}export{l as GuideFirstModuleBundlePage};

package/dist/node/components/docs/guides/GuideGenerateDocsClientsSchemasPage.js

@@ -1,211 +1,4 @@
-// src/components/docs/shared/StudioPrompt.tsx
-import Link from "@contractspec/lib.ui-link";
-import { jsx, jsxs } from "react/jsx-runtime";
-function StudioPrompt({
-  title = "Need the operating layer on top of OSS ContractSpec?",
-  body = "ContractSpec Studio helps teams turn evidence into proposed spec changes, governed delivery loops, and execution-ready task packs while keeping the open contract system as the source of truth.",
-  ctaLabel = "See what Studio adds",
-  href = "https://www.contractspec.studio/docs"
-}) {
-  return /* @__PURE__ */ jsxs("div", {
-    className: "card-subtle space-y-3 p-6",
-    children: [
-      /* @__PURE__ */ jsx("h3", {
-        className: "font-semibold text-lg",
-        children: title
-      }),
-      /* @__PURE__ */ jsx("p", {
-        className: "text-muted-foreground text-sm",
-        children: body
-      }),
-      /* @__PURE__ */ jsx(Link, {
-        href,
-        className: "btn-primary",
-        children: ctaLabel
-      })
-    ]
-  });
-}
-
-// src/components/docs/guides/GuideGenerateDocsClientsSchemasPage.tsx
-import { CodeBlock } from "@contractspec/lib.design-system";
-import Link2 from "@contractspec/lib.ui-link";
-import { ChevronRight } from "lucide-react";
-import { jsx as jsx2, jsxs as jsxs2 } from "react/jsx-runtime";
-function GuideGenerateDocsClientsSchemasPage() {
-  return /* @__PURE__ */ jsxs2("div", {
-    className: "space-y-8",
-    children: [
-      /* @__PURE__ */ jsxs2("div", {
-        className: "space-y-3",
-        children: [
-          /* @__PURE__ */ jsx2("h1", {
-            className: "font-bold text-4xl",
-            children: "Generate docs + client schemas"
-          }),
-          /* @__PURE__ */ jsx2("p", {
-            className: "text-lg text-muted-foreground",
-            children: "Generate docs and OpenAPI output from ContractSpec operations to power SDKs, docs sites, and tooling."
-          })
-        ]
-      }),
-      /* @__PURE__ */ jsxs2("div", {
-        className: "card-subtle space-y-4 p-6",
-        children: [
-          /* @__PURE__ */ jsx2("h2", {
-            className: "font-bold text-2xl",
-            children: "What you'll build"
-          }),
-          /* @__PURE__ */ jsxs2("ul", {
-            className: "space-y-2 text-muted-foreground text-sm",
-            children: [
-              /* @__PURE__ */ jsx2("li", {
-                children: "Export docs from your specs."
-              }),
-              /* @__PURE__ */ jsx2("li", {
-                children: "Emit OpenAPI 3.1 for client SDK generation."
-              }),
-              /* @__PURE__ */ jsx2("li", {
-                children: "Keep outputs deterministic with CI validation."
-              })
-            ]
-          })
-        ]
-      }),
-      /* @__PURE__ */ jsxs2("div", {
-        className: "space-y-6",
-        children: [
-          /* @__PURE__ */ jsxs2("div", {
-            className: "space-y-3",
-            children: [
-              /* @__PURE__ */ jsx2("h2", {
-                className: "font-bold text-2xl",
-                children: "1) Generate docs"
-              }),
-              /* @__PURE__ */ jsx2("p", {
-                className: "text-muted-foreground text-sm",
-                children: "Use the generator to emit docs from your contracts."
-              }),
-              /* @__PURE__ */ jsx2(CodeBlock, {
-                language: "bash",
-                filename: "generate-docs",
-                code: `contractspec generate`
-              }),
-              /* @__PURE__ */ jsxs2("p", {
-                className: "text-muted-foreground text-sm",
-                children: [
-                  "Expected output: ",
-                  /* @__PURE__ */ jsx2("code", {
-                    children: "Generate X doc files in generated/docs"
-                  }),
-                  "."
-                ]
-              })
-            ]
-          }),
-          /* @__PURE__ */ jsxs2("div", {
-            className: "space-y-3",
-            children: [
-              /* @__PURE__ */ jsx2("h2", {
-                className: "font-bold text-2xl",
-                children: "2) Export OpenAPI"
-              }),
-              /* @__PURE__ */ jsx2("p", {
-                className: "text-muted-foreground text-sm",
-                children: "Export an OpenAPI document from your registry module."
-              }),
-              /* @__PURE__ */ jsx2(CodeBlock, {
-                language: "bash",
-                filename: "openapi-export",
-                code: `contractspec openapi export --registry ./src/contracts/registry.ts --out ./generated/openapi.json`
-              }),
-              /* @__PURE__ */ jsxs2("p", {
-                className: "text-muted-foreground text-sm",
-                children: [
-                  "Expected output:",
-                  " ",
-                  /* @__PURE__ */ jsx2("code", {
-                    children: "OpenAPI written to .../generated/openapi.json"
-                  }),
-                  "."
-                ]
-              })
-            ]
-          }),
-          /* @__PURE__ */ jsxs2("div", {
-            className: "space-y-3",
-            children: [
-              /* @__PURE__ */ jsx2("h2", {
-                className: "font-bold text-2xl",
-                children: "3) Validate specs"
-              }),
-              /* @__PURE__ */ jsx2(CodeBlock, {
-                language: "bash",
-                filename: "validate-specs",
-                code: `contractspec validate`
-              }),
-              /* @__PURE__ */ jsxs2("p", {
-                className: "text-muted-foreground text-sm",
-                children: [
-                  "Expected output: ",
-                  /* @__PURE__ */ jsx2("code", {
-                    children: "Validation passed"
-                  }),
-                  "."
-                ]
-              })
-            ]
-          }),
-          /* @__PURE__ */ jsxs2("div", {
-            className: "card-subtle space-y-3 p-6",
-            children: [
-              /* @__PURE__ */ jsx2("h3", {
-                className: "font-semibold text-lg",
-                children: "Example package"
-              }),
-              /* @__PURE__ */ jsx2("p", {
-                className: "text-muted-foreground text-sm",
-                children: "The Integration Hub example provides a full registry of operations and is a good source for OpenAPI exports."
-              }),
-              /* @__PURE__ */ jsx2(CodeBlock, {
-                language: "bash",
-                filename: "integration-hub-example",
-                code: `contractspec examples show integration-hub
+import d from"@contractspec/lib.ui-link";import{jsx as a,jsxs as l}from"react/jsx-runtime";function r({title:i="Need the operating layer on top of OSS ContractSpec?",body:n="ContractSpec Studio helps teams turn evidence into proposed spec changes, governed delivery loops, and execution-ready task packs while keeping the open contract system as the source of truth.",ctaLabel:s="See what Studio adds",href:p="https://www.contractspec.studio/docs"}){return l("div",{className:"card-subtle space-y-3 p-6",children:[a("h3",{className:"font-semibold text-lg",children:i}),a("p",{className:"text-muted-foreground text-sm",children:n}),a(d,{href:p,className:"btn-primary",children:s})]})}import{CodeBlock as o}from"@contractspec/lib.design-system";import c from"@contractspec/lib.ui-link";import{ChevronRight as m}from"lucide-react";import{jsx as e,jsxs as t}from"react/jsx-runtime";function b(){return t("div",{className:"space-y-8",children:[t("div",{className:"space-y-3",children:[e("h1",{className:"font-bold text-4xl",children:"Generate docs + client schemas"}),e("p",{className:"text-lg text-muted-foreground",children:"Generate docs and OpenAPI output from ContractSpec operations to power SDKs, docs sites, and tooling."})]}),t("div",{className:"card-subtle space-y-4 p-6",children:[e("h2",{className:"font-bold text-2xl",children:"What you'll build"}),t("ul",{className:"space-y-2 text-muted-foreground text-sm",children:[e("li",{children:"Export docs from your specs."}),e("li",{children:"Emit OpenAPI 3.1 for client SDK generation."}),e("li",{children:"Keep outputs deterministic with CI validation."})]})]}),t("div",{className:"space-y-6",children:[t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"1) Generate docs"}),e("p",{className:"text-muted-foreground text-sm",children:"Use the generator to emit docs from your contracts."}),e(o,{language:"bash",filename:"generate-docs",code:"contractspec generate"}),t("p",{className:"text-muted-foreground text-sm",children:["Expected output: ",e("code",{children:"Generate X doc files in generated/docs"}),"."]})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"2) Export OpenAPI"}),e("p",{className:"text-muted-foreground text-sm",children:"Export an OpenAPI document from your registry module."}),e(o,{language:"bash",filename:"openapi-export",code:"contractspec openapi export --registry ./src/contracts/registry.ts --out ./generated/openapi.json"}),t("p",{className:"text-muted-foreground text-sm",children:["Expected output:"," ",e("code",{children:"OpenAPI written to .../generated/openapi.json"}),"."]})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"3) Validate specs"}),e(o,{language:"bash",filename:"validate-specs",code:"contractspec validate"}),t("p",{className:"text-muted-foreground text-sm",children:["Expected output: ",e("code",{children:"Validation passed"}),"."]})]}),t("div",{className:"card-subtle space-y-3 p-6",children:[e("h3",{className:"font-semibold text-lg",children:"Example package"}),e("p",{className:"text-muted-foreground text-sm",children:"The Integration Hub example provides a full registry of operations and is a good source for OpenAPI exports."}),e(o,{language:"bash",filename:"integration-hub-example",code:`contractspec examples show integration-hub
 
 # openapi export against your registry module
-contractspec openapi export --registry ./src/contracts/registry.ts --out ./generated/openapi.json`
-              })
-            ]
-          }),
-          /* @__PURE__ */ jsx2(StudioPrompt, {
-            title: "Want exports tied to product decisions?",
-            body: "Studio compiles approved changes into deliverables and pushes them to your execution stack with full evidence context."
-          })
-        ]
-      }),
-      /* @__PURE__ */ jsxs2("div", {
-        className: "flex items-center gap-4 pt-4",
-        children: [
-          /* @__PURE__ */ jsxs2(Link2, {
-            href: "/docs/guides/docs-generation-pipeline",
-            className: "btn-primary",
-            children: [
-              "Next: Docs pipeline ",
-              /* @__PURE__ */ jsx2(ChevronRight, {
-                size: 16
-              })
-            ]
-          }),
-          /* @__PURE__ */ jsx2(Link2, {
-            href: "/docs/guides",
-            className: "btn-ghost",
-            children: "Back to guides"
-          })
-        ]
-      })
-    ]
-  });
-}
-export {
-  GuideGenerateDocsClientsSchemasPage
-};
+contractspec openapi export --registry ./src/contracts/registry.ts --out ./generated/openapi.json`})]}),e(r,{title:"Want exports tied to product decisions?",body:"Studio compiles approved changes into deliverables and pushes them to your execution stack with full evidence context."})]}),t("div",{className:"flex items-center gap-4 pt-4",children:[t(c,{href:"/docs/guides/docs-generation-pipeline",className:"btn-primary",children:["Next: Docs pipeline ",e(m,{size:16})]}),e(c,{href:"/docs/guides",className:"btn-ghost",children:"Back to guides"})]})]})}export{b as GuideGenerateDocsClientsSchemasPage};

package/dist/node/components/docs/guides/GuideHostBuilderWorkbenchPage.js

@@ -0,0 +1,69 @@
+import{CodeBlock as o}from"@contractspec/lib.design-system";import a from"@contractspec/lib.ui-link";import{ChevronRight as n}from"lucide-react";import{jsx as e,jsxs as t}from"react/jsx-runtime";var i=["builder.workspace.bootstrap","builder.channel.receiveInbound","builder.blueprint.generate","builder.plan.compile","builder.preview.create","builder.preview.runHarness","builder.export.prepare","builder.export.approve","builder.export.execute"];function c(){return t("div",{className:"space-y-8",children:[t("div",{className:"space-y-3",children:[e("h1",{className:"font-bold text-4xl",children:"Host the Builder workbench"}),e("p",{className:"text-lg text-muted-foreground",children:"Use the reusable Builder workbench as the desktop control surface for snapshot loading, guided authoring, preview, readiness, export, and mobile review handoff."})]}),t("div",{className:"card-subtle space-y-4 p-6",children:[e("h2",{className:"font-bold text-2xl",children:"What you'll build"}),t("ul",{className:"space-y-2 text-muted-foreground text-sm",children:[e("li",{children:"A workspace snapshot fetch path."}),e("li",{children:"A `BuilderWorkbench` host with action callbacks."}),e("li",{children:"Runtime-mode aware preview/export controls plus mobile review links."})]})]}),t("div",{className:"space-y-6",children:[t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"1) Fetch the workspace snapshot"}),e("p",{className:"text-muted-foreground text-sm",children:"The web shell already exposes a query path for the current Builder workspace snapshot. Your host should load it first, then refresh it after each successful command."}),e(o,{language:"typescript",filename:"builder-workbench-controller.ts",code:`export async function fetchBuilderSnapshot(workspaceId: string) {
+  const response = await fetch(
+    \`/api/operate/builder/queries/builder.workspace.snapshot?workspaceId=\${encodeURIComponent(workspaceId)}\`,
+    { cache: "no-store" }
+  );
+  if (!response.ok) {
+    throw new Error("Failed to fetch Builder workspace snapshot.");
+  }
+  const payload = await response.json() as {
+    ok: boolean;
+    result: BuilderWorkspaceSnapshot;
+  };
+  if (!payload.ok) {
+    throw new Error("Builder workspace snapshot query returned an error.");
+  }
+  return payload.result;
+}`}),e("p",{className:"text-muted-foreground text-sm",children:"Expected output: one `BuilderWorkspaceSnapshot` containing workspace, plan, providers, runtime targets, preview, export, and mobile review state."})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"2) Host the workbench and refresh on action"}),e("p",{className:"text-muted-foreground text-sm",children:"The simplest host pattern is local state plus a small action wrapper that executes one Builder command and then refreshes the snapshot."}),e(o,{language:"tsx",filename:"BuilderWorkbenchHost.tsx",code:`import {
+  BuilderWorkbench,
+  useBuilderWorkbenchState,
+} from "@contractspec/module.builder-workbench/presentation";
+
+const { snapshot, setSnapshot, promptDraft, setPromptDraft } =
+  useBuilderWorkbenchState({
+    workspace: initialSnapshot.workspace,
+    initialSnapshot,
+  });
+
+async function runAction(commandKey: string, payload?: Record<string, unknown>) {
+  await executeBuilderCommand({ commandKey, workspaceId, payload });
+  setSnapshot(await fetchBuilderSnapshot(workspaceId));
+}
+
+<BuilderWorkbench
+  snapshot={snapshot}
+  promptDraft={promptDraft}
+  onPromptDraftChange={setPromptDraft}
+  onCapturePrompt={() =>
+    runAction("builder.channel.receiveInbound", createPromptEnvelope(workspaceId, promptDraft))
+  }
+  onGenerateBlueprint={() => runAction("builder.blueprint.generate")}
+  onCompilePlan={() => runAction("builder.plan.compile")}
+  onCreatePreview={() => runAction("builder.preview.create", { runtimeMode: "hybrid" })}
+  onRunReadiness={() => runAction("builder.preview.runHarness")}
+  onPrepareExport={() => runAction("builder.export.prepare", { runtimeMode: "hybrid" })}
+  onApproveExport={() => runAction("builder.export.approve")}
+  onExecuteExport={() => runAction("builder.export.execute")}
+  selectedExportRuntimeMode="hybrid"
+/>;`}),e("p",{className:"text-muted-foreground text-sm",children:"Expected output: each successful action leaves the host with a fresh snapshot and keeps the workbench tabs aligned with current runtime state."})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"3) Bootstrap providers and routing policy explicitly"}),e("p",{className:"text-muted-foreground text-sm",children:"Builder v3 treats provider routing as policy, not heuristic. Use the workspace bootstrap command as the single managed-first setup path instead of orchestrating provider registration in the app shell."}),e(o,{language:"typescript",filename:"builder-bootstrap.ts",code:`await executeBuilderCommand({
+  commandKey: "builder.workspace.bootstrap",
+  workspaceId,
+  payload: {
+    preset: "managed_mvp",
+    includeLocalHelperProvider: true,
+  },
+});`})]}),t("div",{className:"card-subtle space-y-3 p-6",children:[e("h3",{className:"font-semibold text-lg",children:"Common command keys"}),e("ul",{className:"space-y-2 text-muted-foreground text-sm",children:i.map((r)=>e("li",{children:e("code",{children:r})},r))})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"4) Keep runtime mode explicit"}),e("p",{className:"text-muted-foreground text-sm",children:"Preview and export flows are runtime-mode aware. The host chooses between `managed`, `local`, and `hybrid` and passes that choice into preview or export commands instead of hiding it behind provider selection heuristics."}),e(o,{language:"typescript",filename:"runtime-mode",code:`const [selectedExportRuntimeMode, setSelectedExportRuntimeMode] =
+  React.useState(resolveBuilderExportRuntimeMode(initialSnapshot));
+
+await executeBuilderCommand({
+  commandKey: "builder.preview.create",
+  workspaceId,
+  payload: {
+    runtimeMode: selectedExportRuntimeMode,
+  },
+	});`})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"5) Link mobile review flows"}),e("p",{className:"text-muted-foreground text-sm",children:"When a patch proposal, approval ticket, or incident needs operator follow-up away from the desktop workbench, deep-link into the mobile review route instead of inventing a separate data model."}),e(o,{language:"typescript",filename:"mobile-review-path.ts",code:`export function buildBuilderMobileReviewPath(
+  workspaceId: string,
+  cardId: string
+) {
+  return \`/operate/builder/workspaces/\${encodeURIComponent(workspaceId)}/mobile-review/\${encodeURIComponent(cardId)}\`;
+}`}),e("p",{className:"text-muted-foreground text-sm",children:"Expected output: the same Builder workspace state stays visible from desktop workbench and mobile review surfaces."})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"6) Keep Connect adjacent, not embedded"}),e("p",{className:"text-muted-foreground text-sm",children:"Builder owns the authoring control plane. When Builder delegates into coding repositories, enable Connect in those target workspaces for context packs, mutation verification, replay, and review packets, but do not replace Builder contracts with Connect artifacts."}),e(o,{language:"bash",filename:"connect-init.sh",code:"contractspec connect init --scope workspace"})]})]}),t("div",{className:"flex items-center gap-4 pt-4",children:[t(a,{href:"/docs/specs/builder-control-plane",className:"btn-primary",children:["Back to Builder control plane ",e(n,{size:16})]}),e(a,{href:"/docs/studio",className:"btn-ghost",children:"Studio overview"})]})]})}export{c as GuideHostBuilderWorkbenchPage};