(WIP) Fix Incorrect Declaration Directory and Update Dependencies #5
Conversation
This file contains 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
For years this library was not pointing to the right declaration files path, forcing developers to use declare locally declare library types: `declare module 'iframe-message-proxy';` This made a lot of plugins non-type safe.
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.
Description
This PR addresses a longstanding issue where the library was not correctly pointing to the declaration files' path. This forced developers to locally declare library types, compromising type safety for various plugins. Additionally, this PR updates all packages to their latest versions, thereby resolving at least 74 critical vulnerabilities previously identified with the old versions. It also adds @pietrobondioli as a contributor.
Changes
"declarationDir": "./types"fromtsconfig.json, resolving the issue where the typings were pointing to the wrong location.Impact
Correcting the type declaration path enhances type safety, as the library's own types are now correctly provided, negating the need for developers to use local type declarations like
declare module 'iframe-message-proxy';.Moreover, the dependency updates are a significant step forward in terms of security. Previously, the project had at least 74 critical vulnerabilities due to outdated dependencies. This update not only mitigates those vulnerabilities but also potentially improves performance and compatibility through the incorporation of the latest dependency features and bug fixes.
Additional Notes
Please review the changes especially concerning the dependencies, to ensure no breaking changes or functionality loss occurs due to the updates. The attention to the removal of
"declarationDir": "./types"fromtsconfig.jsonis warranted, as thepackage.jsonalready specifies the"files"and"typings"paths accurately.(WIP) The WIP tag on the title is because I still running tests to check if no functionality was broken.