Recipe Index¶
This directory provides the minimal, copy-paste-runnable approach for common architecture requirements. Each recipe follows a fixed nine-section structure: scenario and non-scenario, architecture choice and capability ID, preconditions and trust boundary, minimal code or command, expected output and evidence, safety/failure negative case, copy-paste verification command, business logic the caller continues to own, and upgrade/rollback notes.
Selection Rules¶
- Requirement contains domain semantics / state machine / audit oracle → keep with the consumer; do not look for a Foundation capability here.
- Need structure or protocol validation → see
domain-schema-validation. - Need safe file access or atomic write → see
safe-filesystem-and-atomic-write. - Need a deterministic human report → see
deterministic-human-report. - Need durable events and derived snapshots → see
durable-local-state. - Need an existing-repository adoption inventory → see
adopt-existing-repository. - Need a text-resource closure or host access → see
adapter-text-closure/host-profile-integration. - Need to trial Quickstart Profile v2 → pin the 0.3.0 candidate subpaths of all three packages exactly; remain on exactly 0.2.1 when v1 is still required.
Common Verification Conventions¶
- All examples run in a new system temp directory, leaving no personal paths or credentials.
- Examples contain no enterprise identifiers, private Profiles, real business data, or personal paths.
- Each recipe gives at least one positive case and one negative case; the negative case must produce a stable failure code or refusal.
- Verification commands can be copied and run directly; when a package is needed, first
npm installthe corresponding@0.3.0.
Capability ID Overview¶
| Recipe | Preferred capability ID |
|---|---|
| adopt-existing-repository | foundation.kit.adopt-plan |
| safe-filesystem-and-atomic-write | foundation.harness.path-containment, foundation.harness.atomic-write |
| domain-schema-validation | foundation.contracts.object-validation |
| adapter-text-closure | foundation.harness.resource-closure, foundation.harness.host-adapter |
| deterministic-human-report | foundation.harness.report, foundation.kit.report |
| durable-local-state | foundation.harness.state-store |
| host-profile-integration | foundation.kit.host, foundation.profile.extension-spi |