Skip to content

docs(events-amqp): Testing section + API reference for the FakeAmqpAdapter subpath (connectum#203)#63

Merged
intech merged 2 commits into
mainfrom
docs/events-amqp-testing-203
Jul 5, 2026
Merged

docs(events-amqp): Testing section + API reference for the FakeAmqpAdapter subpath (connectum#203)#63
intech merged 2 commits into
mainfrom
docs/events-amqp-testing-203

Conversation

@intech

@intech intech commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

Summary

Documentation companion for connectum#224 (issue connectum#203) — the final PR of the 1.3.0 events-resilience cluster:

  • en/packages/events-amqp.md: new Testing section — the @connectum/events-amqp/testing subpath with FakeAmqpAdapter: FIFO publish outcomes (incl. the deterministic AmqpPublishTimeoutError state-UNKNOWN case), the deterministic lifecycle control surface, delivery with settlement counts, the parity contract, documented divergences, a test-double selection tip, and the subpath exports table (checked against the actual exports).
  • en/packages/events.md: the #203 forward reference in the DI/testing guidance flipped to present tense with a link to the new section.
  • en/api/: regenerated API reference — adds the testing subpath module pages (FakeAmqpAdapter, FakeAmqpControl, FakeAmqpAdapterOptions, FakeAmqpAdapterInstance, FakePublishOutcome, FakePublishedRecord, FakeDeliveryResult).

Validation

  • pnpm docs:build green (no dead links).

🤖 Generated with Claude Code

https://claude.ai/code/session_015Sp8jYmRXyvUmsErDuNJvt

@github-actions github-actions Bot added the type:docs Documentation: guides, README, JSDoc label Jul 5, 2026
@intech
intech merged commit d77d06c into main Jul 5, 2026
5 checks passed
@intech
intech deleted the docs/events-amqp-testing-203 branch July 5, 2026 21:11
intech added a commit to Connectum-Framework/connectum that referenced this pull request Jul 5, 2026
…erence entry points (#203) (#225)

## Summary

Follow-up to #224: the new `@connectum/events-amqp/testing` subpath was
not listed in the package's TypeDoc `entryPoints`, so `pnpm docs:api`
silently omitted the `FakeAmqpAdapter` API pages (the docs-repo pages
were generated with this fix applied locally — without it, the next full
regen would drop them again).

- `packages/events-amqp/typedoc.json`: `entryPoints` +=
`src/testing.ts`.

## Change type

- [x] Documentation / tooling (no runtime change)
- [ ] New feature
- [ ] Breaking change

## Test plan

- `pnpm docs:api` regenerates the API reference with 8 new `testing/`
pages (`FakeAmqpAdapter`, `FakeAmqpControl`, options/result types) —
verified locally; the generated pages shipped in
Connectum-Framework/docs#63.
- CI: full pipeline green (docs-only change; no package behavior
affected).

## Parity coverage

N/A — TypeDoc configuration only; no runtime or contract surface.

## Related

- #224 (the subpath this documents), #203 (the feature issue)
- Connectum-Framework/docs#63 (the docs companion generated with this
fix)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

https://claude.ai/code/session_015Sp8jYmRXyvUmsErDuNJvt
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type:docs Documentation: guides, README, JSDoc

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant