docs: document mock API module boundaries and consumer contract (Clos… - #394
Merged
Lakes41 merged 1 commit intoAug 19, 2026
Merged
Conversation
Adamantine-guild#390) Add docs/mock-api-boundaries.md describing: - Module structure and responsibilities (index.ts, mock-boundary.ts, mock.ts, mock-storage.ts, types.ts) - Clear distinction between fixtures (static data) and behavior (simulation logic) - Public application entry point (lib/api/index.ts) and stable boundary (mock-boundary.ts) - Developer control functions (resetMockData, applyMockScenario, replayMockEvent, etc.) - Fixture maintenance and behavior implementation rules - Data flow tracing and migration guidance for refactoring This explicitly clarifies that components import only from @/lib/api and never from internal modules, preventing unintended coupling to implementation details. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012fDJWYcNXhWgWNb4xrjvkz
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.
Document mock API module boundaries and consumer contract
Summary
Add comprehensive documentation (
docs/mock-api-boundaries.md) for the in-memory mock API module architecture, explicitly defining module responsibilities, public boundaries, and consumer contracts.Changes
docs/mock-api-boundaries.mdwith:lib/api/index.ts,mock-boundary.ts,mock.ts,mock-storage.ts,types.ts,live.ts)@/lib/apionlymock-boundary.tsand re-exported fromindex.tsAcceptance Criteria ✅
lib/api/index.tsand internal mock modulesTesting
No code changes; documentation-only PR. Verify that docs/mock-api-boundaries.md:
Closes #390