Files
suaveplan/openspec/archive/2026-05-25-api-secrets/tasks.md
2026-05-27 23:29:53 +01:00

3.2 KiB

Tasks — @suaveplan/api-secrets

Every checkbox MUST reflect work actually done in this change.

0. Pre-flight (non-negotiable)

  • 0.1 Confirm clean working tree (git status reports nothing) and no in-flight worktrees with uncommitted work (git worktree list then git status in each)
  • 0.2 If any worktrees exist under .claude/worktrees/, account for each one: still-active agent, work-pending-merge, or stale-and-prune. Stale worktrees MUST be removed (git worktree remove) before opening a new one — code that has been lost twice on main is the failure mode this guards against.
  • 0.3 Confirm the package set in MANIFEST.md matches find packages -maxdepth 3 -name package.json count. Drift here means a prior change archived without regenerating the manifest.

1. Spec authoring

  • 1.1 Read design doc §3 (manifest secrets block), §5.1 (ctx.secrets), §5.2 (defineCapability shape)
  • 1.2 Read openspec/specs/api-secrets/spec.md (does not exist yet)
  • 1.3 Read openspec/AGENTS.md Sections 13, 14
  • 1.4 Draft proposal.md
  • 1.5 Source-mapping table
  • 1.6 Draft specs/api-secrets/spec.md
  • 1.7 **Verified by:** line on every requirement

2. Implementation

  • 2.1 Scaffold packages/api/api-secrets/ ("version": "0.1.0", "sideEffects": false, deps: @suaveplan/api-types, @suaveplan/error, @suaveplan/types, zod)
  • 2.2 src/secrets-like/ — SecretsLike<Names extends string>
  • 2.3 src/descriptor/ — SecretDescriptor + Zod schema (import z from "zod")
  • 2.4 src/redaction/ — redactSecret
  • 2.5 src/capability-id/ — augmentation adding "secrets" AND "secrets.bun"
  • 2.6 src/error-codes/ — SECRETS_CODES
  • 2.7 src/testing/ — runSecretsConformance(factory)
  • 2.8 src/index.ts — explicit named re-exports
  • 2.9 package.json exports per subpath

3. Tests

  • 3.1 Unit tests per feature
  • 3.2 Spec-conformance type tests (generic Names narrows return type)
  • 3.3 Property test on redaction (always returns the canonical marker)
  • 3.4 Every it(...) carries { timeout: 5000 }

4. Documentation

  • 4.1 Sibling .md for every implementation .ts
  • 4.2 README.md linking every .md
  • 4.3 No CLAUDE.md update

5. Pre-archive verification

  • 5.1 bun run check — 0/0/0
  • 5.2 bunx turbo lint typecheck test --filter=@suaveplan/api-secrets — green
  • 5.3 bunx turbo test:coverage --filter=@suaveplan/api-secrets — 100/100/100/100
  • 5.4 bun scripts/openspec-conformance.ts @suaveplan/api-secrets — exit 0
  • 5.5 bunx turbo build --filter=@suaveplan/api-secrets — green

6. Pre-archive 7-row checklist

  • 6.1 Generics on SecretsLike<Names>; expectTypeOf proves autocomplete
  • 6.2 Zod wired at descriptor boundary
  • 6.3 Every SECRETS_CODES entry thrown
  • 6.4 Required-at-start enforcement on / off tested
  • 6.5 OTel — N/A (sources emit)
  • 6.6 Lifecycle dedup — dispose idempotent; tested
  • 6.7 No retroactive tick

7. Archive

  • 7.1 Fold spec delta
  • 7.2 Move to openspec/archive/<yyyy-mm-dd>-api-secrets/
  • 7.3 Tick umbrella 1.9
  • 7.4 Refresh MANIFEST.md