Repository navigation
docs(mutator-framework): Add JSDoc for graph lifecycle and callbacks [skip chg] - #12216
Closed
Timothee Guerin (timotheeguerin) wants to merge 3 commits into
Closed
Timothee Guerin (timotheeguerin) wants to merge 3 commits into
Timothee Guerin (timotheeguerin) wants to merge 3 commits into
Conversation
commit: |
Contributor
|
All changed packages have been documented.
Show changes
|
Timothee Guerin (timotheeguerin)
changed the title
Timothee Guerin (timotheeguerin)
changed the title
29 of 30 tasks
|
You can try these changes here
|
Timothee Guerin (timotheeguerin)
marked this pull request as ready for review
October 16, 2026 13:45
Timothee Guerin (timotheeguerin)
requested review from
catalinaperalta,
iscai-msft,
Laurent Mazuel (lmazuel) and
Mark Cowlishaw (markcowl)
as code owners
October 16, 2026 13:45
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The documentation-only changes have no unresolved findings and leave runtime behavior and API signatures unchanged.
0 open findings
What changed in this PR
Documents the mutator framework’s graph lifecycle and callback contracts as part of the public API JSDoc improvements tracked in #12228. No runtime behavior or API signatures change.
Changes:
- Clarifies node identity, lifecycle state, and callback timing.
- Explains edge direction, replacement ownership, and uncached factory construction.
- Adds an internal changelog entry.
| File | Description |
|---|---|
| packages/mutator-framework/src/mutation-node/mutation-node.ts | Documents node identity, state, and lifecycle methods. |
| packages/mutator-framework/src/mutation-node/mutation-edge.ts | Documents edge callbacks and reconnection responsibilities. |
| packages/mutator-framework/src/mutation-node/factory.ts | Clarifies fresh-node construction and type mapping. |
| .chronus/changes/docs-jsdoc-mutator-graph-2026-9-15-11-59-53.md | Records the documentation update. |
🧠 Review effort: Balanced
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Member
Author
Timothee Guerin (timotheeguerin)
added a commit
that referenced
this pull request
Oct 16, 2026
Mutation authors need to distinguish registered graph state, replacement results, traversal callbacks, and concrete mutation helpers without inferring their lifecycle from implementation. Document the public mutation framework together, from engine and graph contracts through model/operation, scalar/enum/union, value, and tuple mutations. Clarify ownership and replacement semantics without changing mutation behavior. Consolidates [12216](#12216), [12219](#12219), [12222](#12222). Tracked in #12228.
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.
Graph transformations depend on when types are cloned and who reconnects references after replacement. Document node identity and state, callback timing, edge direction, and replacement ownership so consumers can build custom connections without assuming mutation callbacks replay or edges retarget themselves. Distinguish fresh factory nodes from engine-cached nodes. No runtime or API changes.
Tracked in #12228.