Repository navigation
docs(service): declare the two sibling-facing seams - #28
Merged
Merged
Conversation
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A sibling-plugin author (Review Outbox) asked which seam is contractual: the frozen
assemble()→AssembleReportResult.reportDir, or thetool/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:
ctx.researchReport.assemble()returns the frozen result;reportDiris the sealed directory andreport.md/manifest.jsonare its fixed entry files.tool/result.meta.{reportFile, manifestFile}forname === '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.tspins the projection's shape so the guarantee is visible in CI. No behavior change; the frozen block is untouched (verify:frozen-contractpasses).Closes #27