@contractspec/example.kb-update-pipeline 3.7.6 → 3.7.7

package/.turbo/turbo-build.log

@@ -3,7 +3,7 @@ $ bun run prebuild && bun run build:bundle && bun run build:types
 $ contractspec-bun-build prebuild
 $ contractspec-bun-build transpile
 [contractspec-bun-build] transpile target=bun root=src entries=14 noBundle=false
-Bundled 14 modules in 14ms
+Bundled 14 modules in 33ms
 
   docs/index.js                         1.49 KB   (entry point)
   ./index.js                            20.86 KB  (entry point)
@@ -21,7 +21,7 @@ Bundled 14 modules in 14ms
   handlers/memory.handlers.js           3.62 KB   (entry point)
 
 [contractspec-bun-build] transpile target=node root=src entries=14 noBundle=false
-Bundled 14 modules in 48ms
+Bundled 14 modules in 26ms
 
   docs/index.js                         1.48 KB   (entry point)
   ./index.js                            20.85 KB  (entry point)
@@ -39,7 +39,7 @@ Bundled 14 modules in 48ms
   handlers/memory.handlers.js           3.61 KB   (entry point)
 
 [contractspec-bun-build] transpile target=browser root=src entries=14 noBundle=false
-Bundled 14 modules in 44ms
+Bundled 14 modules in 27ms
 
   docs/index.js                         1.48 KB   (entry point)
   ./index.js                            20.85 KB  (entry point)

package/AGENTS.md

@@ -1,38 +1,59 @@
-# AI Agent Guide -- `@contractspec/example.kb-update-pipeline`
+# AI Agent Guide — `@contractspec/example.kb-update-pipeline`
 
 Scope: `packages/examples/kb-update-pipeline/*`
 
-Demonstrates a knowledge base update automation pipeline with human-in-the-loop review and auditability.
+Example: KB update automation pipeline with HITL review and auditability.
 
 ## Quick Context
 
-- **Layer**: example
-- **Related Packages**: `lib.contracts-spec`, `lib.schema`
-
-## What This Demonstrates
-
-- HITL (human-in-the-loop) review pipeline pattern
-- Entity models for KB articles and update proposals
-- Event-driven pipeline with typed operations
-- Feature definition with presentations and test-specs
-- In-memory handlers for demo scenarios
-
-## Public Exports
-
-- `.` -- root barrel
-- `./kb-update-pipeline.feature` -- feature definition
-- `./entities` -- KB entity models
-- `./events` -- pipeline event definitions
-- `./operations` -- pipeline operations
-- `./presentations` -- presentation definitions
-- `./handlers` -- in-memory handlers
-- `./tests/operations.test-spec` -- operation test specifications
-- `./docs` -- DocBlock documentation
-- `./example` -- runnable example entry point
+- Layer: `example`.
+- Package visibility: published package.
+- Primary consumers are example explorers, template authors, and documentation readers.
+- Related packages: `@contractspec/lib.contracts-spec`, `@contractspec/lib.schema`, `@contractspec/tool.bun`, `@contractspec/tool.typescript`.
+
+## Architecture
+
+- `src/docs/` contains docblocks and documentation-facing exports.
+- `src/entities/` contains domain entities and value objects.
+- `src/events.ts` is package-level event definitions.
+- `src/example.ts` is the runnable example entrypoint.
+- `src/handlers/` contains handlers or demo adapters wired to contract surfaces.
+- `src/index.ts` is the root public barrel and package entrypoint.
+- `src/kb-update-pipeline.feature.ts` defines a feature entrypoint.
+
+## Public Surface
+
+- Export `.` resolves through `./src/index.ts`.
+- Export `./docs` resolves through `./src/docs/index.ts`.
+- Export `./docs/kb-update-pipeline.docblock` resolves through `./src/docs/kb-update-pipeline.docblock.ts`.
+- Export `./entities` resolves through `./src/entities/index.ts`.
+- Export `./entities/models` resolves through `./src/entities/models.ts`.
+- Export `./events` resolves through `./src/events.ts`.
+- Export `./example` resolves through `./src/example.ts`.
+- Export `./handlers` resolves through `./src/handlers/index.ts`.
+- Export `./handlers/memory.handlers` resolves through `./src/handlers/memory.handlers.ts`.
+- Export `./kb-update-pipeline.feature` resolves through `./src/kb-update-pipeline.feature.ts`.
+- The package publishes 14 total export subpaths; keep docs aligned with `package.json`.
+
+## Guardrails
+
+- Keep the example package demonstrative, buildable, and aligned with the exported feature surface.
+- Do not add hidden production assumptions that are not actually implemented in the example.
+- Changes here can affect downstream packages such as `@contractspec/lib.contracts-spec`, `@contractspec/lib.schema`, `@contractspec/tool.bun`, `@contractspec/tool.typescript`.
+- Changes here can affect downstream packages such as `@contractspec/lib.contracts-spec`, `@contractspec/lib.schema`, `@contractspec/tool.bun`, `@contractspec/tool.typescript`.
 
 ## Local Commands
 
-- Build: `bun run build`
-- Dev: `bun run dev`
-- Test: `bun test`
-- Typecheck: `bun run typecheck`
+- `bun run dev` — contractspec-bun-build dev
+- `bun run build` — bun run prebuild && bun run build:bundle && bun run build:types
+- `bun run test` — bun test
+- `bun run lint` — bun lint:fix
+- `bun run lint:check` — biome check .
+- `bun run lint:fix` — biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .
+- `bun run typecheck` — tsc --noEmit
+- `bun run publish:pkg` — bun publish --tolerate-republish --ignore-scripts --verbose
+- `bun run publish:pkg:canary` — bun publish:pkg --tag canary
+- `bun run clean` — rimraf dist .turbo
+- `bun run build:bundle` — contractspec-bun-build transpile
+- `bun run build:types` — contractspec-bun-build types
+- `bun run prebuild` — contractspec-bun-build prebuild

package/README.md

@@ -1,28 +1,75 @@
-# `@contractspec/example.kb-update-pipeline`
+# @contractspec/example.kb-update-pipeline
 
-Website: https://contractspec.io/
+Website: https://contractspec.io
 
-Spec-first example for a **knowledge base update pipeline** where:
+**Example: KB update automation pipeline with HITL review and auditability.**
 
-- automation **proposes** changes (watch/diff/summarize/propose patches)\n+- humans **verify** (HITL) with role-based rules\n+- snapshots are published only when rule versions are approved\n+- notifications + audit trails provide traceability\n+
-## Contracts
+## What This Demonstrates
 
-- `kbPipeline.runWatch()`\n+- `kbPipeline.createReviewTask(changeCandidateId)`\n+- `kbPipeline.submitDecision(reviewTaskId, decision)`\n+- `kbPipeline.publishIfReady(jurisdiction)`\n+
-## Tests
+- HITL (human-in-the-loop) review pipeline pattern.
+- Entity models for KB articles and update proposals.
+- Event-driven pipeline with typed operations.
+- Feature definition with presentations and test-specs.
+- In-memory handlers for demo scenarios.
+- `src/docs/` contains docblocks and documentation-facing exports.
 
-- high-risk change cannot be approved by curator role\n+- publish fails if any included rule versions are unapproved\n+- notifications fire on review requested\n+
-## Running tests
+## Running Locally
 
-```bash
-bun test
-```
+From `packages/examples/kb-update-pipeline`:
+- `bun run dev`
+- `bun run build`
+- `bun run test`
+- `bun run typecheck`
 
+## Usage
 
+Use `@contractspec/example.kb-update-pipeline` as a reference implementation, or import its exported surfaces into a workspace that composes ContractSpec examples and bundles.
 
+## Architecture
 
+- `src/docs/` contains docblocks and documentation-facing exports.
+- `src/entities/` contains domain entities and value objects.
+- `src/events.ts` is package-level event definitions.
+- `src/example.ts` is the runnable example entrypoint.
+- `src/handlers/` contains handlers or demo adapters wired to contract surfaces.
+- `src/index.ts` is the root public barrel and package entrypoint.
+- `src/kb-update-pipeline.feature.ts` defines a feature entrypoint.
 
+## Public Entry Points
 
+- Export `.` resolves through `./src/index.ts`.
+- Export `./docs` resolves through `./src/docs/index.ts`.
+- Export `./docs/kb-update-pipeline.docblock` resolves through `./src/docs/kb-update-pipeline.docblock.ts`.
+- Export `./entities` resolves through `./src/entities/index.ts`.
+- Export `./entities/models` resolves through `./src/entities/models.ts`.
+- Export `./events` resolves through `./src/events.ts`.
+- Export `./example` resolves through `./src/example.ts`.
+- Export `./handlers` resolves through `./src/handlers/index.ts`.
+- Export `./handlers/memory.handlers` resolves through `./src/handlers/memory.handlers.ts`.
+- Export `./kb-update-pipeline.feature` resolves through `./src/kb-update-pipeline.feature.ts`.
+- The package publishes 14 total export subpaths; keep docs aligned with `package.json`.
 
+## Local Commands
 
+- `bun run dev` — contractspec-bun-build dev
+- `bun run build` — bun run prebuild && bun run build:bundle && bun run build:types
+- `bun run test` — bun test
+- `bun run lint` — bun lint:fix
+- `bun run lint:check` — biome check .
+- `bun run lint:fix` — biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .
+- `bun run typecheck` — tsc --noEmit
+- `bun run publish:pkg` — bun publish --tolerate-republish --ignore-scripts --verbose
+- `bun run publish:pkg:canary` — bun publish:pkg --tag canary
+- `bun run clean` — rimraf dist .turbo
+- `bun run build:bundle` — contractspec-bun-build transpile
+- `bun run build:types` — contractspec-bun-build types
+- `bun run prebuild` — contractspec-bun-build prebuild
 
+## Recent Updates
 
+- Replace eslint+prettier by biomejs to optimize speed.
+- Missing contract layers.
+
+## Notes
+
+- Works alongside `@contractspec/lib.contracts-spec`, `@contractspec/lib.schema`, `@contractspec/tool.bun`, `@contractspec/tool.typescript`.

package/dist/browser/entities/index.js

@@ -1,8 +1,8 @@
 // src/entities/models.ts
 import {
-  ScalarTypeEnum,
   defineEnum,
-  defineSchemaModel
+  defineSchemaModel,
+  ScalarTypeEnum
 } from "@contractspec/lib.schema";
 var ChangeRiskLevelEnum = defineEnum("ChangeRiskLevel", [
   "low",

package/dist/browser/entities/models.js

@@ -1,8 +1,8 @@
 // src/entities/models.ts
 import {
-  ScalarTypeEnum,
   defineEnum,
-  defineSchemaModel
+  defineSchemaModel,
+  ScalarTypeEnum
 } from "@contractspec/lib.schema";
 var ChangeRiskLevelEnum = defineEnum("ChangeRiskLevel", [
   "low",

package/dist/browser/events.js

@@ -1,6 +1,6 @@
 // src/events.ts
 import { defineEvent, StabilityEnum } from "@contractspec/lib.contracts-spec";
-import { ScalarTypeEnum, defineSchemaModel } from "@contractspec/lib.schema";
+import { defineSchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
 var KbChangeDetectedPayload = defineSchemaModel({
   name: "KbChangeDetectedPayload",
   description: "Emitted when a source change is detected.",

package/dist/browser/index.js

@@ -43,9 +43,9 @@ var docBlocks = [
 registerDocBlocks(docBlocks);
 // src/entities/models.ts
 import {
-  ScalarTypeEnum,
   defineEnum,
-  defineSchemaModel
+  defineSchemaModel,
+  ScalarTypeEnum
 } from "@contractspec/lib.schema";
 var ChangeRiskLevelEnum = defineEnum("ChangeRiskLevel", [
   "low",
@@ -92,7 +92,7 @@ var ReviewTaskModel = defineSchemaModel({
 });
 // src/events.ts
 import { defineEvent, StabilityEnum } from "@contractspec/lib.contracts-spec";
-import { ScalarTypeEnum as ScalarTypeEnum2, defineSchemaModel as defineSchemaModel2 } from "@contractspec/lib.schema";
+import { defineSchemaModel as defineSchemaModel2, ScalarTypeEnum as ScalarTypeEnum2 } from "@contractspec/lib.schema";
 var KbChangeDetectedPayload = defineSchemaModel2({
   name: "KbChangeDetectedPayload",
   description: "Emitted when a source change is detected.",
@@ -350,9 +350,75 @@ function createPipelineMemoryHandlers(store) {
     publishIfReady
   };
 }
+// src/kb-update-pipeline.feature.ts
+import { defineFeature } from "@contractspec/lib.contracts-spec";
+var KbUpdatePipelineFeature = defineFeature({
+  meta: {
+    key: "kb-update-pipeline",
+    version: "1.0.0",
+    title: "KB Update Pipeline (HITL)",
+    description: "Automation proposes KB patches; humans verify; publishing is blocked until approvals are complete.",
+    domain: "knowledge",
+    owners: ["@examples"],
+    tags: ["knowledge", "pipeline", "hitl", "audit", "notifications"],
+    stability: "experimental"
+  },
+  operations: [
+    { key: "kbPipeline.runWatch", version: "1.0.0" },
+    { key: "kbPipeline.createReviewTask", version: "1.0.0" },
+    { key: "kbPipeline.submitDecision", version: "1.0.0" },
+    { key: "kbPipeline.publishIfReady", version: "1.0.0" }
+  ],
+  events: [
+    { key: "kb.change.detected", version: "1.0.0" },
+    { key: "kb.change.summarized", version: "1.0.0" },
+    { key: "kb.patch.proposed", version: "1.0.0" },
+    { key: "kb.review.requested", version: "1.0.0" },
+    { key: "kb.review.decided", version: "1.0.0" }
+  ],
+  presentations: [
+    { key: "kb.dashboard", version: "1.0.0" },
+    { key: "kb.review.list", version: "1.0.0" },
+    { key: "kb.review.form", version: "1.0.0" }
+  ],
+  opToPresentation: [
+    {
+      op: { key: "kbPipeline.runWatch", version: "1.0.0" },
+      pres: { key: "kb.dashboard", version: "1.0.0" }
+    },
+    {
+      op: { key: "kbPipeline.createReviewTask", version: "1.0.0" },
+      pres: { key: "kb.review.list", version: "1.0.0" }
+    },
+    {
+      op: { key: "kbPipeline.submitDecision", version: "1.0.0" },
+      pres: { key: "kb.review.form", version: "1.0.0" }
+    }
+  ],
+  presentationsTargets: [
+    { key: "kb.dashboard", version: "1.0.0", targets: ["react", "markdown"] },
+    { key: "kb.review.list", version: "1.0.0", targets: ["react", "markdown"] },
+    { key: "kb.review.form", version: "1.0.0", targets: ["react"] }
+  ],
+  capabilities: {
+    requires: [
+      { key: "identity", version: "1.0.0" },
+      { key: "notifications", version: "1.0.0" },
+      { key: "audit-trail", version: "1.0.0" }
+    ]
+  },
+  knowledge: [{ key: "kb.knowledge.rules", version: "1.0.0" }],
+  telemetry: [{ key: "kb-pipeline.telemetry", version: "1.0.0" }],
+  jobs: [{ key: "kb-pipeline.job.watch", version: "1.0.0" }],
+  docs: [
+    "docs.examples.kb-update-pipeline.goal",
+    "docs.examples.kb-update-pipeline.reference"
+  ]
+});
+
 // src/operations/pipeline.ts
 import { defineCommand } from "@contractspec/lib.contracts-spec";
-import { ScalarTypeEnum as ScalarTypeEnum3, defineSchemaModel as defineSchemaModel3 } from "@contractspec/lib.schema";
+import { defineSchemaModel as defineSchemaModel3, ScalarTypeEnum as ScalarTypeEnum3 } from "@contractspec/lib.schema";
 var RunWatchInput = defineSchemaModel3({
   name: "KbPipelineRunWatchInput",
   description: "Trigger a watch cycle for KB sources (demo).",
@@ -493,72 +559,6 @@ var KbPipelinePublishIfReadyContract = defineCommand({
   },
   policy: { auth: "user" }
 });
-// src/kb-update-pipeline.feature.ts
-import { defineFeature } from "@contractspec/lib.contracts-spec";
-var KbUpdatePipelineFeature = defineFeature({
-  meta: {
-    key: "kb-update-pipeline",
-    version: "1.0.0",
-    title: "KB Update Pipeline (HITL)",
-    description: "Automation proposes KB patches; humans verify; publishing is blocked until approvals are complete.",
-    domain: "knowledge",
-    owners: ["@examples"],
-    tags: ["knowledge", "pipeline", "hitl", "audit", "notifications"],
-    stability: "experimental"
-  },
-  operations: [
-    { key: "kbPipeline.runWatch", version: "1.0.0" },
-    { key: "kbPipeline.createReviewTask", version: "1.0.0" },
-    { key: "kbPipeline.submitDecision", version: "1.0.0" },
-    { key: "kbPipeline.publishIfReady", version: "1.0.0" }
-  ],
-  events: [
-    { key: "kb.change.detected", version: "1.0.0" },
-    { key: "kb.change.summarized", version: "1.0.0" },
-    { key: "kb.patch.proposed", version: "1.0.0" },
-    { key: "kb.review.requested", version: "1.0.0" },
-    { key: "kb.review.decided", version: "1.0.0" }
-  ],
-  presentations: [
-    { key: "kb.dashboard", version: "1.0.0" },
-    { key: "kb.review.list", version: "1.0.0" },
-    { key: "kb.review.form", version: "1.0.0" }
-  ],
-  opToPresentation: [
-    {
-      op: { key: "kbPipeline.runWatch", version: "1.0.0" },
-      pres: { key: "kb.dashboard", version: "1.0.0" }
-    },
-    {
-      op: { key: "kbPipeline.createReviewTask", version: "1.0.0" },
-      pres: { key: "kb.review.list", version: "1.0.0" }
-    },
-    {
-      op: { key: "kbPipeline.submitDecision", version: "1.0.0" },
-      pres: { key: "kb.review.form", version: "1.0.0" }
-    }
-  ],
-  presentationsTargets: [
-    { key: "kb.dashboard", version: "1.0.0", targets: ["react", "markdown"] },
-    { key: "kb.review.list", version: "1.0.0", targets: ["react", "markdown"] },
-    { key: "kb.review.form", version: "1.0.0", targets: ["react"] }
-  ],
-  capabilities: {
-    requires: [
-      { key: "identity", version: "1.0.0" },
-      { key: "notifications", version: "1.0.0" },
-      { key: "audit-trail", version: "1.0.0" }
-    ]
-  },
-  knowledge: [{ key: "kb.knowledge.rules", version: "1.0.0" }],
-  telemetry: [{ key: "kb-pipeline.telemetry", version: "1.0.0" }],
-  jobs: [{ key: "kb-pipeline.job.watch", version: "1.0.0" }],
-  docs: [
-    "docs.examples.kb-update-pipeline.goal",
-    "docs.examples.kb-update-pipeline.reference"
-  ]
-});
-
 // src/presentations.ts
 import {
   definePresentation,

package/dist/browser/operations/index.js

@@ -1,8 +1,8 @@
 // src/entities/models.ts
 import {
-  ScalarTypeEnum,
   defineEnum,
-  defineSchemaModel
+  defineSchemaModel,
+  ScalarTypeEnum
 } from "@contractspec/lib.schema";
 var ChangeRiskLevelEnum = defineEnum("ChangeRiskLevel", [
   "low",
@@ -50,7 +50,7 @@ var ReviewTaskModel = defineSchemaModel({
 
 // src/operations/pipeline.ts
 import { defineCommand } from "@contractspec/lib.contracts-spec";
-import { ScalarTypeEnum as ScalarTypeEnum2, defineSchemaModel as defineSchemaModel2 } from "@contractspec/lib.schema";
+import { defineSchemaModel as defineSchemaModel2, ScalarTypeEnum as ScalarTypeEnum2 } from "@contractspec/lib.schema";
 var RunWatchInput = defineSchemaModel2({
   name: "KbPipelineRunWatchInput",
   description: "Trigger a watch cycle for KB sources (demo).",

package/dist/browser/operations/pipeline.js

@@ -1,8 +1,8 @@
 // src/entities/models.ts
 import {
-  ScalarTypeEnum,
   defineEnum,
-  defineSchemaModel
+  defineSchemaModel,
+  ScalarTypeEnum
 } from "@contractspec/lib.schema";
 var ChangeRiskLevelEnum = defineEnum("ChangeRiskLevel", [
   "low",
@@ -50,7 +50,7 @@ var ReviewTaskModel = defineSchemaModel({
 
 // src/operations/pipeline.ts
 import { defineCommand } from "@contractspec/lib.contracts-spec";
-import { ScalarTypeEnum as ScalarTypeEnum2, defineSchemaModel as defineSchemaModel2 } from "@contractspec/lib.schema";
+import { defineSchemaModel as defineSchemaModel2, ScalarTypeEnum as ScalarTypeEnum2 } from "@contractspec/lib.schema";
 var RunWatchInput = defineSchemaModel2({
   name: "KbPipelineRunWatchInput",
   description: "Trigger a watch cycle for KB sources (demo).",

package/dist/browser/presentations.js

@@ -1,8 +1,8 @@
 // src/entities/models.ts
 import {
-  ScalarTypeEnum,
   defineEnum,
-  defineSchemaModel
+  defineSchemaModel,
+  ScalarTypeEnum
 } from "@contractspec/lib.schema";
 var ChangeRiskLevelEnum = defineEnum("ChangeRiskLevel", [
   "low",

package/dist/entities/index.js

@@ -1,9 +1,9 @@
 // @bun
 // src/entities/models.ts
 import {
-  ScalarTypeEnum,
   defineEnum,
-  defineSchemaModel
+  defineSchemaModel,
+  ScalarTypeEnum
 } from "@contractspec/lib.schema";
 var ChangeRiskLevelEnum = defineEnum("ChangeRiskLevel", [
   "low",

package/dist/entities/models.js

@@ -1,9 +1,9 @@
 // @bun
 // src/entities/models.ts
 import {
-  ScalarTypeEnum,
   defineEnum,
-  defineSchemaModel
+  defineSchemaModel,
+  ScalarTypeEnum
 } from "@contractspec/lib.schema";
 var ChangeRiskLevelEnum = defineEnum("ChangeRiskLevel", [
   "low",

package/dist/events.js

@@ -1,7 +1,7 @@
 // @bun
 // src/events.ts
 import { defineEvent, StabilityEnum } from "@contractspec/lib.contracts-spec";
-import { ScalarTypeEnum, defineSchemaModel } from "@contractspec/lib.schema";
+import { defineSchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
 var KbChangeDetectedPayload = defineSchemaModel({
   name: "KbChangeDetectedPayload",
   description: "Emitted when a source change is detected.",

package/dist/index.d.ts

@@ -4,10 +4,10 @@
  * Automation proposes KB updates; humans verify; everything audited and notified.
  */
 export * from './entities';
-export * from './operations';
 export * from './events';
+export { default as example } from './example';
 export * from './handlers';
 export * from './kb-update-pipeline.feature';
-export { default as example } from './example';
+export * from './operations';
 export * from './presentations';
 import './docs';