Fix TypeScript ts-declarations #67
Draft
Conversation
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
raith-nvm
commented
Sep 2, 2025
raith-nvm
commented
- Fix issues with types.js, especially JSdoc markup, to allow generation of correct types.d.ts
- Needs additional test coverage, or removal of AudioDevice class from types.js
- Currently can only commit by overriding commit-hook (--no-verify)
- Whilst these JSdoc changes suit the emitted ts-declarations I cannot vouch for their suitability for generating the docs!
We believe this should be 'ALWAYS_EXCEPT_WHEN_ON_HOLD'
But beware that this might break SF actual use of JSDoc :(
* revisit an earlier fix - Constants.AGENT_STATUS is wrong for setAgentStatus, but so is string! Make it simply AGENT_STATUS (which resolves to string anyway) but is a marker to fix it properly in phase 2 * regenerate types
Fix TS types phase 1 - Freeze Constants so that TS can generate suitable constants - Add missing AudioDevice type to types.js (although it may be a redundant type in types.ts) - Fix incorrect REMOVE_PARTICIPANT_VARIANT constant - Fix incorrect JSdoc param / return definitions - Standardize formatting - Regenerate TS types (npm run tsd)
Fix TS types phase 2 - Fix JSdoc for publishEvent eventType values - Fix JSdoc for Constant-typed params - Regenerate TS types (npm run tsd)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.