@contractspec/bundle.library 3.8.9 → 3.8.11

package/dist/components/docs/guides/GuideCIDiffGatingPage.js

@@ -1,198 +1,4 @@
 // @bun
-// 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/GuideCIDiffGatingPage.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 GuideCIDiffGatingPage() {
-  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: "CI gating with deterministic diffs"
-          }),
-          /* @__PURE__ */ jsx2("p", {
-            className: "text-lg text-muted-foreground",
-            children: "Add ContractSpec CI checks that validate specs, detect drift, and gate breaking changes before merge."
-          })
-        ]
-      }),
-      /* @__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: "CI workflow running ContractSpec validation and drift checks."
-              }),
-              /* @__PURE__ */ jsx2("li", {
-                children: "Machine-readable output for PR annotations."
-              }),
-              /* @__PURE__ */ jsx2("li", {
-                children: "Deterministic contract diffs in review."
-              })
-            ]
-          })
-        ]
-      }),
-      /* @__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) Add the CI workflow"
-              }),
-              /* @__PURE__ */ jsx2("p", {
-                className: "text-muted-foreground text-sm",
-                children: "Copy the template from the CLI package."
-              }),
-              /* @__PURE__ */ jsx2(CodeBlock, {
-                language: "bash",
-                filename: "ci-copy",
-                code: `cp node_modules/@contractspec/app.cli-contractspec/templates/github-action.yml .github/workflows/contractspec.yml`
-              }),
-              /* @__PURE__ */ jsxs2("p", {
-                className: "text-muted-foreground text-sm",
-                children: [
-                  "Expected output: new workflow file in ",
-                  /* @__PURE__ */ jsx2("code", {
-                    children: ".github/workflows"
-                  }),
-                  "."
-                ]
-              })
-            ]
-          }),
-          /* @__PURE__ */ jsxs2("div", {
-            className: "space-y-3",
-            children: [
-              /* @__PURE__ */ jsx2("h2", {
-                className: "font-bold text-2xl",
-                children: "2) Run CI locally"
-              }),
-              /* @__PURE__ */ jsx2(CodeBlock, {
-                language: "bash",
-                filename: "ci-local",
-                code: `contractspec ci --format json --check-drift`
-              }),
-              /* @__PURE__ */ jsx2("p", {
-                className: "text-muted-foreground text-sm",
-                children: "Expected output: JSON summary including pass/fail counts and drift status (if configured)."
-              })
-            ]
-          }),
-          /* @__PURE__ */ jsxs2("div", {
-            className: "space-y-3",
-            children: [
-              /* @__PURE__ */ jsx2("h2", {
-                className: "font-bold text-2xl",
-                children: "3) Add a diff check"
-              }),
-              /* @__PURE__ */ jsx2("p", {
-                className: "text-muted-foreground text-sm",
-                children: "Use the diff command to inspect breaking changes in PRs."
-              }),
-              /* @__PURE__ */ jsx2(CodeBlock, {
-                language: "bash",
-                filename: "ci-diff",
-                code: `contractspec diff src/contracts/spec-v1.ts src/contracts/spec-v2.ts --breaking`
-              }),
-              /* @__PURE__ */ jsx2("p", {
-                className: "text-muted-foreground text-sm",
-                children: "Expected output: deterministic diff with breaking change hints."
-              })
-            ]
-          }),
-          /* @__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 CRM pipeline example is already wired in the quickstart smoke test. Use it as a CI-ready template."
-              }),
-              /* @__PURE__ */ jsx2(CodeBlock, {
-                language: "bash",
-                filename: "crm-ci",
-                code: `cd packages/examples/crm-pipeline
+import l from"@contractspec/lib.ui-link";import{jsx as i,jsxs as p}from"react/jsx-runtime";function o({title:d="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:r="https://www.contractspec.studio/docs"}){return p("div",{className:"card-subtle space-y-3 p-6",children:[i("h3",{className:"font-semibold text-lg",children:d}),i("p",{className:"text-muted-foreground text-sm",children:n}),i(l,{href:r,className:"btn-primary",children:s})]})}import{CodeBlock as a}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 k(){return t("div",{className:"space-y-8",children:[t("div",{className:"space-y-3",children:[e("h1",{className:"font-bold text-4xl",children:"CI gating with deterministic diffs"}),e("p",{className:"text-lg text-muted-foreground",children:"Add ContractSpec CI checks that validate specs, detect drift, and gate breaking changes before merge."})]}),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:"CI workflow running ContractSpec validation and drift checks."}),e("li",{children:"Machine-readable output for PR annotations."}),e("li",{children:"Deterministic contract diffs in review."})]})]}),t("div",{className:"space-y-6",children:[t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"1) Add the CI workflow"}),e("p",{className:"text-muted-foreground text-sm",children:"Copy the template from the CLI package."}),e(a,{language:"bash",filename:"ci-copy",code:"cp node_modules/@contractspec/app.cli-contractspec/templates/github-action.yml .github/workflows/contractspec.yml"}),t("p",{className:"text-muted-foreground text-sm",children:["Expected output: new workflow file in ",e("code",{children:".github/workflows"}),"."]})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"2) Run CI locally"}),e(a,{language:"bash",filename:"ci-local",code:"contractspec ci --format json --check-drift"}),e("p",{className:"text-muted-foreground text-sm",children:"Expected output: JSON summary including pass/fail counts and drift status (if configured)."})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"3) Add a diff check"}),e("p",{className:"text-muted-foreground text-sm",children:"Use the diff command to inspect breaking changes in PRs."}),e(a,{language:"bash",filename:"ci-diff",code:"contractspec diff src/contracts/spec-v1.ts src/contracts/spec-v2.ts --breaking"}),e("p",{className:"text-muted-foreground text-sm",children:"Expected output: deterministic diff with breaking change hints."})]}),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 CRM pipeline example is already wired in the quickstart smoke test. Use it as a CI-ready template."}),e(a,{language:"bash",filename:"crm-ci",code:`cd packages/examples/crm-pipeline
 bun run build
-bun run validate`
-              })
-            ]
-          }),
-          /* @__PURE__ */ jsx2(StudioPrompt, {
-            title: "Need continuous checks tied to outcomes?",
-            body: "Studio closes the loop with post-change verification and learning dividends that improve future decisions."
-          })
-        ]
-      }),
-      /* @__PURE__ */ jsxs2("div", {
-        className: "flex items-center gap-4 pt-4",
-        children: [
-          /* @__PURE__ */ jsxs2(Link2, {
-            href: "/docs/guides",
-            className: "btn-primary",
-            children: [
-              "Back to guides ",
-              /* @__PURE__ */ jsx2(ChevronRight, {
-                size: 16
-              })
-            ]
-          }),
-          /* @__PURE__ */ jsx2(Link2, {
-            href: "/docs",
-            className: "btn-ghost",
-            children: "Docs home"
-          })
-        ]
-      })
-    ]
-  });
-}
-export {
-  GuideCIDiffGatingPage
-};
+bun run validate`})]}),e(o,{title:"Need continuous checks tied to outcomes?",body:"Studio closes the loop with post-change verification and learning dividends that improve future decisions."})]}),t("div",{className:"flex items-center gap-4 pt-4",children:[t(c,{href:"/docs/guides",className:"btn-primary",children:["Back to guides ",e(m,{size:16})]}),e(c,{href:"/docs",className:"btn-ghost",children:"Docs home"})]})]})}export{k as GuideCIDiffGatingPage};

package/dist/components/docs/guides/GuideConnectInRepoPage.d.ts

@@ -0,0 +1 @@
+export declare function GuideConnectInRepoPage(): import("react/jsx-runtime").JSX.Element;

package/dist/components/docs/guides/GuideConnectInRepoPage.js

@@ -0,0 +1,44 @@
+// @bun
+import{CodeBlock as c}from"@contractspec/lib.design-system";import a from"@contractspec/lib.ui-link";import{ChevronRight as o}from"lucide-react";import{jsx as e,jsxs as t}from"react/jsx-runtime";var s=[".contractspec/connect/context-pack.json",".contractspec/connect/plan-packet.json",".contractspec/connect/patch-verdict.json",".contractspec/connect/audit.ndjson",".contractspec/connect/decisions/<decisionId>/"];function d(){return t("div",{className:"space-y-8",children:[t("div",{className:"space-y-3",children:[e("h1",{className:"font-bold text-4xl",children:"Use Connect in a repo"}),e("p",{className:"text-lg text-muted-foreground",children:"Put coding-agent edits and shell commands behind task-scoped context, plan compilation, verification, and local review evidence without introducing a second control plane."})]}),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-level Connect config in `.contractsrc.json`."}),e("li",{children:"A context and plan flow for one task."}),e("li",{children:"Verified file and shell mutations with local review/replay evidence."})]})]}),t("div",{className:"space-y-6",children:[t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"1) Enable Connect"}),e("p",{className:"text-muted-foreground text-sm",children:"Start by making the safety policy explicit. Protected paths, generated paths, review thresholds, and command rules live in the workspace config, not in editor-specific hooks."}),e(c,{language:"json",filename:".contractsrc.json",code:`{
+  "connect": {
+    "enabled": true,
+    "storage": {
+      "root": ".contractspec/connect",
+      "contextPack": ".contractspec/connect/context-pack.json",
+      "planPacket": ".contractspec/connect/plan-packet.json",
+      "patchVerdict": ".contractspec/connect/patch-verdict.json",
+      "auditFile": ".contractspec/connect/audit.ndjson",
+      "reviewPacketsDir": ".contractspec/connect/review-packets"
+    },
+    "policy": {
+      "protectedPaths": ["packages/libs/contracts-spec/**"],
+      "generatedPaths": ["generated/**"],
+      "smokeChecks": ["bun run typecheck"],
+      "reviewThresholds": {
+        "protectedPathWrite": "require_review",
+        "breakingChange": "require_review",
+        "destructiveCommand": "deny"
+      }
+    },
+    "commands": {
+      "allow": ["bun run typecheck"],
+      "review": ["git push"],
+      "deny": ["git reset --hard", "git push --force", "rm -rf"]
+    }
+  }
+}`}),e("p",{className:"text-muted-foreground text-sm",children:"Expected output: Connect has enough policy to classify writes, commands, drift, and review thresholds deterministically."})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"2) Initialize storage"}),e(c,{language:"bash",filename:"connect-init",code:"contractspec connect init --scope workspace"}),e("p",{className:"text-muted-foreground text-sm",children:"Expected output: `.contractsrc.json` is updated if needed and `.contractspec/connect/` is created."})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"3) Project context and compile a plan"}),e("p",{className:"text-muted-foreground text-sm",children:"Use the task id as the thread that connects context, plan, verdict, and replay artifacts."}),e(c,{language:"bash",filename:"connect-plan",code:`contractspec connect context \\
+  --task docs-connect \\
+  --paths packages/libs/contracts-spec/src/control-plane/contracts.ts \\
+  --json
+
+printf '{"objective":"Document the control-plane contract surface","commands":["bun run typecheck"]}' | \\
+  contractspec connect plan --task docs-connect --stdin --json`}),e("p",{className:"text-muted-foreground text-sm",children:"Expected output: a `ContextPack` and `PlanPacket` that point back to `controlPlane.intent.submit`, `controlPlane.plan.compile`, and `controlPlane.plan.verify`."})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"4) Verify file and shell mutations"}),e(c,{language:"bash",filename:"connect-verify",code:`printf '{"operation":"edit","path":"packages/libs/contracts-spec/src/control-plane/contracts.ts"}' | \\
+  contractspec connect verify --task docs-connect --tool acp.fs.access --stdin --json
+
+printf 'bun run typecheck' | \\
+  contractspec connect verify --task docs-connect --tool acp.terminal.exec --stdin --json`}),e("p",{className:"text-muted-foreground text-sm",children:"Expected output: a `PatchVerdict` with `permit`, `rewrite`, `require_review`, or `deny`, plus a runtime-linked control-plane state when that linkage is available."})]}),t("div",{className:"card-subtle space-y-3 p-6",children:[e("h3",{className:"font-semibold text-lg",children:"Artifacts to inspect"}),e("ul",{className:"space-y-2 text-muted-foreground text-sm",children:s.map((n)=>e("li",{children:e("code",{children:n})},n))})]}),t("div",{className:"space-y-3",children:[e("h2",{className:"font-bold text-2xl",children:"5) Review, replay, and optional Studio sync"}),e(c,{language:"bash",filename:"connect-review-replay",code:`contractspec connect review list --json
+contractspec connect replay <decisionId> --json
+contractspec connect eval <decisionId> --registry ./harness-registry.ts --scenario connect.safe-refactor --json
+
+# Optional when Studio review-bridge mode is enabled
+contractspec connect review sync --decision <decisionId> --json`}),e("p",{className:"text-muted-foreground text-sm",children:"Local review packets remain authoritative. Studio sync is an operator convenience layer, not a requirement for baseline OSS safety."})]})]}),t("div",{className:"flex items-center gap-4 pt-4",children:[t(a,{href:"/docs/specs/connect",className:"btn-primary",children:["Back to Connect spec ",e(o,{size:16})]}),e(a,{href:"/docs/architecture/control-plane",className:"btn-ghost",children:"Control-plane runtime"})]})]})}export{d as GuideConnectInRepoPage};