Repository navigation
Conversation
2 tasks done
PaulHax
force-pushed
the
typescript-types-sync
branch
from
October 19, 2026 20:43
31f7fc3 to
a32dfd4
Compare
PaulHax
added this pull request to stack #3695
October 19, 2026 20:46
PaulHax
removed this pull request from stack #3695
October 19, 2026 21:01
PaulHax
added this pull request to stack #3696
October 19, 2026 21:01
PaulHax
force-pushed
the
typescript-types-sync
branch
from
October 22, 2026 16:09
a32dfd4 to
3bcb493
Compare
The hand-maintained .d.ts files have accumulated gaps and inaccuracies. Some downstream projects carry local declaration shims to cover missing entry points. Add declarations for previously untyped modules and correct known issues in existing declarations. The changes were derived from macro definitions, implementation exports, and the built ESM output. BREAKING CHANGE: TypeScript builds that compiled against the previous declarations may now fail. Runtime behavior is unchanged. Consumers should remove overlapping local declaration shims. Code may need updates for corrected return types, nullability, exports, and constants.
BREAKING CHANGE: Listener and proxy operations now declare void returns. CellPicker and WebXR setters declare boolean returns, and box intersections and view rotations require numeric inputs. MatrixBuilder factories return transformation instances without construct signatures.
PaulHax
force-pushed
the
typescript-types-sync
branch
from
October 22, 2026 16:28
3bcb493 to
2ca8378
Compare
This branch has not been deployed
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.
Context
Bring the published TypeScript declarations into sync with the JavaScript implementation. Downstream projects currently need local declarations for missing modules and corrections for inaccurate signatures.
Results
Declarations cover hundreds more modules and describe their runtime exports, accessors, factory options, and static APIs more accurately. Consumers can remove overlapping local
declare module '@kitware/vtk.js/...'shims. Corrected signatures can require call-site updates for nullability, typed arrays, and renderer-specific view APIs.This PR changes declaration files, their validation configs, and migration documentation. Runtime behavior is unchanged.
Downstream
@kitware/vtk.jsdeclarations.vtk-types-compattypes custom render-pass locals and removes aninvokeEventsuppression.Changes
newInstanceoptions, and static exports.liblist should addES2020.BigInt; theirtargetcan stay unchanged.setXFromand setters without a return value asvoid, and includenullorundefinedwhere accessors can return them.DesiredOutputPrecision,VtkDataTypes,BoundaryCondition, andPolygonWithPointIntersectionStatefrom their module'sConstantsentry point.vtkPolygon.PolygonIntersectionStatea type alias ofPolygonWithPointIntersectionState; the old enum values did not match the runtime constants. Use the constants module for runtime values.PR Checklist
Testing
No runtime tests are added because runtime behavior is unchanged. The companion declaration conformance work covers declaration and consumer contracts separately; runtime fixes remain outside this PR.
Supersedes #3617. This branch lives in Kitware/vtk-js so dependent PRs can target it.