Skip to content

docs(service): declare the two sibling-facing seams - #28

Merged
PerryLink merged 1 commit into
mainfrom
fix/meta-seam-contract
Nov 13, 2026
Merged

PerryLink merged 1 commit into
mainfrom
fix/meta-seam-contract

Conversation

@PerryLink

Copy link
Copy Markdown
Owner

A sibling-plugin author (Review Outbox) asked which seam is contractual: the frozen assemble() → AssembleReportResult.reportDir, or the tool/result.meta.{reportFile, manifestFile} projection. The asymmetry mattered because the convenient surface was the undeclared one, so a rename there would break an out-of-tree consumer with no CI signal on either side.

This PR declares both seams instead of picking one:

  • in-process — ctx.researchReport.assemble() returns the frozen result; reportDir is the sealed directory and report.md / manifest.json are its fixed entry files.
  • event-driven — tool/result.meta.{reportFile, manifestFile} for name === 'research_report' carries absolute, resolved paths of the same two artifacts, present only when the result is sealed (kind === 'sealed'). Fields are additive-only and the pair is never renamed.

test/meta-contract.spec.ts pins the projection's shape so the guarantee is visible in CI. No behavior change; the frozen block is untouched (verify:frozen-contract passes).

Closes #27

A sibling consumer asked which seam is contractual: the frozen
`assemble()` → `reportDir` result, or the `tool/result.meta.{reportFile,
manifestFile}` projection. Both are now declared, with the split spelled out:
in-process consumers use `reportDir` (report.md + manifest.json), event-driven
consumers join `tool/call` → `tool/result` and read the absolute meta pair,
which is durable, additive-only and never renamed.

Pins the projection shape with `test/meta-contract.spec.ts`.

Closes #27
@PerryLink
PerryLink merged commit 6f0924e into main Nov 13, 2026
9 of 10 checks passed
@PerryLink
PerryLink deleted the fix/meta-seam-contract branch November 13, 2026 11:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Which seam is contractual for sibling consumers: assemble's reportDir or tool/result.meta.reportFile?

1 participant