Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(api): add type definitions to package.json exports #9486

Merged
merged 3 commits into from
Apr 22, 2024

Conversation

ankoh
Copy link
Contributor

@ankoh ankoh commented Apr 17, 2024

This commit includes the typescript type definitions in the package exports of @tauri-apps/api.

This commit includes the typescript type definitions in the package exports of @tauri-apps/api.
@ankoh ankoh requested a review from a team as a code owner April 17, 2024 08:23
@ankoh
Copy link
Contributor Author

ankoh commented Apr 17, 2024

Without this commit, tsc will just fail to resolve the type definitions in some cases (for me it occurred with NodeNext module resolution through ts-jest)

lucasfernog
lucasfernog previously approved these changes Apr 21, 2024
@lucasfernog lucasfernog requested a review from amrbashir April 21, 2024 14:31
Copy link

🚨 Potential security issues detected. Learn more about Socket for GitHub ↗︎

To accept the risk, merge this PR and you will not be notified again.

Alert Package NoteSource
Install scripts npm/svelte-preprocess@4.10.7
  • Install script: postinstall
  • Source: echo "[svelte-preprocess] Don't forget to install the preprocessors packages that will be used: node-sass/sass, stylus, less, postcss & postcss-load-config, coffeescript, pug, etc..."

View full report↗︎

Next steps

What is an install script?

Install scripts are run when the package is installed. The majority of malware in npm is hidden in install scripts.

Packages should not be running non-essential scripts during install and there are often solutions to problems people solve with install scripts that can be run at publish time instead.

Take a deeper look at the dependency

Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev.

Remove the package

If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.

Mark a package as acceptable risk

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of ecosystem/package-name@version specifiers. e.g. @SocketSecurity ignore npm/foo@1.0.0 or ignore all packages with @SocketSecurity ignore-all

  • @SocketSecurity ignore npm/svelte-preprocess@4.10.7

@amrbashir amrbashir changed the title Add type definitions to @tauri-apps/api package exports fix(api): add type definitions to package.json exports Apr 22, 2024
@amrbashir amrbashir merged commit be7eab2 into tauri-apps:dev Apr 22, 2024
6 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants