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: make web platform types compatible with native types #2091

Merged
merged 1 commit into from
Jul 22, 2023

Conversation

nderscore
Copy link
Contributor

@nderscore nderscore commented Jul 7, 2023

Summary

This PR fixes #1920

When react-native-svg is used on a web project where typescript has been configured to resolve .web.ts file exentions before .ts, it causes type errors.

This is because the types in ReactNativeSVG.web.ts don't match the types in ReactNativeSVG.ts

This PR adds the correct types for all exported components on the web platform inside ReactNativeSVG.web.ts. Those changes are:

  • Added missing prop types for all components
  • Made style, gradientTransform, and patternTransform optional in BaseProps.
  • Made styleProp argument of resolve() undefined-able, to support style being an optional prop (this also seems to follow the logic in the body of the function, which has a check for a truthy styleProp)

These changes only impact types - no functionality has been changed.

Test Plan

I'm not sure there's a clear/easy way to add tests for this update without creating an entirely new test/demo project with its own tsconfig, so I haven't added any. I'm happy to add tests if someone can offer a suggestion for a simpler way to accomplish it.

I can at least confirm that when I tested these changes in my own project, it resolved the TSC errors I was seeing; but since it's a private repo, I can't share it. :(

What's required for testing (prerequisites)?

A typescript project with compilerOptions.moduleSuffixes set to [".web", ""] in its tsconfig.json that uses react-native-svg

What are the steps to reproduce (after prerequisites)?

Run tsc --noEmit in that project.

Compatibility

OS Implemented
iOS N/A
Android N/A
Web

Checklist

  • I have tested this on a device and a simulator
  • I added documentation in README.md
  • I updated the typed files (typescript)
  • I added a test for the API in the __tests__ folder

@WoLewicki
Copy link
Member

@nderscore could you provide a simple repository with minimal needed things in order to be able to reproduce it?

@nderscore
Copy link
Contributor Author

@WoLewicki here's a repository with a minimal reproduction of the bug in a next.js app:

https://github.com/nderscore/rn-svg-web-module-suffix-repro

@WoLewicki WoLewicki merged commit 34243a5 into software-mansion:main Jul 22, 2023
renovate bot referenced this pull request in valora-inc/wallet Oct 19, 2023
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
|
[react-native-svg](https://github.com/react-native-community/react-native-svg)
| [`^13.9.0` ->
`^13.14.0`](https://renovatebot.com/diffs/npm/react-native-svg/13.9.0/13.14.0)
|
[![age](https://developer.mend.io/api/mc/badges/age/npm/react-native-svg/13.14.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/react-native-svg/13.14.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/react-native-svg/13.9.0/13.14.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/react-native-svg/13.9.0/13.14.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>react-native-community/react-native-svg
(react-native-svg)</summary>

###
[`v13.14.0`](https://github.com/software-mansion/react-native-svg/releases/tag/v13.14.0)

[Compare
Source](https://github.com/react-native-community/react-native-svg/compare/v13.13.0...v13.14.0)

PR adding improvements to the library. Thanks for all your contributions
🚀

#### What's Changed

- Create FUNDING.yml by [@&#8203;aleqsio](https://github.com/aleqsio)
in
[https://github.com/software-mansion/react-native-svg/pull/2133](https://github.com/software-mansion/react-native-svg/pull/2133)
- docs: Update deprecated expo install instructions to \`npx expo
install´ by
[@&#8203;GabrieldosSantosOliveira](https://github.com/GabrieldosSantosOliveira)
in
[https://github.com/software-mansion/react-native-svg/pull/2128](https://github.com/software-mansion/react-native-svg/pull/2128)
- \[macOS]\[Xcode 15] Avoid using dirtyRect in `drawRect:` by
[@&#8203;Saadnajmi](https://github.com/Saadnajmi) in
[https://github.com/software-mansion/react-native-svg/pull/2136](https://github.com/software-mansion/react-native-svg/pull/2136)
- fix: error for transform on web by
[@&#8203;WoLewicki](https://github.com/WoLewicki) in
[https://github.com/software-mansion/react-native-svg/pull/2139](https://github.com/software-mansion/react-native-svg/pull/2139)
- chore(deps): bump activesupport from 6.1.7.4 to 7.0.7.2 in
/TestsExample by [@&#8203;dependabot](https://github.com/dependabot)
in
[https://github.com/software-mansion/react-native-svg/pull/2122](https://github.com/software-mansion/react-native-svg/pull/2122)
- fix: web not working with reanimated in example by
[@&#8203;WoLewicki](https://github.com/WoLewicki) in
[https://github.com/software-mansion/react-native-svg/pull/2140](https://github.com/software-mansion/react-native-svg/pull/2140)

#### New Contributors

- [@&#8203;aleqsio](https://github.com/aleqsio) made their first
contribution in
[https://github.com/software-mansion/react-native-svg/pull/2133](https://github.com/software-mansion/react-native-svg/pull/2133)
-
[@&#8203;GabrieldosSantosOliveira](https://github.com/GabrieldosSantosOliveira)
made their first contribution in
[https://github.com/software-mansion/react-native-svg/pull/2128](https://github.com/software-mansion/react-native-svg/pull/2128)
- [@&#8203;Saadnajmi](https://github.com/Saadnajmi) made their first
contribution in
[https://github.com/software-mansion/react-native-svg/pull/2136](https://github.com/software-mansion/react-native-svg/pull/2136)

**Full Changelog**:
software-mansion/react-native-svg@v13.13.0...v13.14.0

###
[`v13.13.0`](https://github.com/software-mansion/react-native-svg/releases/tag/v13.13.0)

[Compare
Source](https://github.com/react-native-community/react-native-svg/compare/v13.12.0...v13.13.0)

Minor release restoring usage of
`UIGraphicsBeginImageContextWithOptions` on `macOS` since there is no
implementation for `UIGraphicsImageRendererFormat` there yet.

#### What's Changed

- feat: add macos back to Example app by
[@&#8203;WoLewicki](https://github.com/WoLewicki) in
[https://github.com/software-mansion/react-native-svg/pull/2119](https://github.com/software-mansion/react-native-svg/pull/2119)

**Full Changelog**:
software-mansion/react-native-svg@v13.12.0...v13.13.0

###
[`v13.12.0`](https://github.com/software-mansion/react-native-svg/releases/tag/v13.12.0)

[Compare
Source](https://github.com/react-native-community/react-native-svg/compare/v13.11.0...v13.12.0)

Minor release introducing the change of API used on `iOS` from
[UIGraphicsBeginImageContextWithOptions](https://developer.apple.com/documentation/uikit/1623912-uigraphicsbeginimagecontextwitho)
to
[UIGraphicsImageRenderer](https://developer.apple.com/documentation/uikit/uigraphicsimagerenderer).

#### What's Changed

- feat: remove UIGraphicsBeginImageContextWithOptions from repo by
[@&#8203;WoLewicki](https://github.com/WoLewicki) in
[https://github.com/software-mansion/react-native-svg/pull/2117](https://github.com/software-mansion/react-native-svg/pull/2117)

**Full Changelog**:
software-mansion/react-native-svg@v13.11.0...v13.12.0

###
[`v13.11.0`](https://github.com/software-mansion/react-native-svg/releases/tag/v13.11.0)

[Compare
Source](https://github.com/react-native-community/react-native-svg/compare/v13.10.0...v13.11.0)

Minor release cleaning the repository 🧹 Please submit any issues that
come up with the newest version 🐛 Thanks for your contributions 🚀

#### What's Changed

- fix: make web platform types compatible with native types by
[@&#8203;nderscore](https://github.com/nderscore) in
[https://github.com/software-mansion/react-native-svg/pull/2091](https://github.com/software-mansion/react-native-svg/pull/2091)
- docs: update usage.md for react-native 0.72 by
[@&#8203;Letty](https://github.com/Letty) in
[https://github.com/software-mansion/react-native-svg/pull/2104](https://github.com/software-mansion/react-native-svg/pull/2104)
- docs: update README.md by [@&#8203;Mhp23](https://github.com/Mhp23)
in
[https://github.com/software-mansion/react-native-svg/pull/2110](https://github.com/software-mansion/react-native-svg/pull/2110)
- fix: bump packages, eslint, tsconfig, prettier and resolve all
conflicts by [@&#8203;WoLewicki](https://github.com/WoLewicki) in
[https://github.com/software-mansion/react-native-svg/pull/2114](https://github.com/software-mansion/react-native-svg/pull/2114)

#### New Contributors

- [@&#8203;nderscore](https://github.com/nderscore) made their first
contribution in
[https://github.com/software-mansion/react-native-svg/pull/2091](https://github.com/software-mansion/react-native-svg/pull/2091)
- [@&#8203;Letty](https://github.com/Letty) made their first
contribution in
[https://github.com/software-mansion/react-native-svg/pull/2104](https://github.com/software-mansion/react-native-svg/pull/2104)
- [@&#8203;Mhp23](https://github.com/Mhp23) made their first
contribution in
[https://github.com/software-mansion/react-native-svg/pull/2110](https://github.com/software-mansion/react-native-svg/pull/2110)

**Full Changelog**:
software-mansion/react-native-svg@v13.10.0...v13.11.0

###
[`v13.10.0`](https://github.com/software-mansion/react-native-svg/releases/tag/v13.10.0)

[Compare
Source](https://github.com/react-native-community/react-native-svg/compare/v13.9.0...v13.10.0)

Minor release fixing some long-standing issues, adding new features such
as web support for `toDataURL`
([https://github.com/software-mansion/react-native-svg/pull/2072](https://github.com/software-mansion/react-native-svg/pull/2072))
and `fallback` prop for `SvgXml` and others
([https://github.com/software-mansion/react-native-svg/pull/2071](https://github.com/software-mansion/react-native-svg/pull/2071)).
It also adds support for RN 0.72 on **new architecture**, at the same
time dropping the support for RN 0.71 there. Thanks for all your
contributions 🚀

#### What's Changed

- Fix compilation errors on Windows by
[@&#8203;christophpurrer](https://github.com/christophpurrer) in
[https://github.com/software-mansion/react-native-svg/pull/2045](https://github.com/software-mansion/react-native-svg/pull/2045)
- Fix setNativeProps type by
[@&#8203;fauri13](https://github.com/fauri13) in
[https://github.com/software-mansion/react-native-svg/pull/2058](https://github.com/software-mansion/react-native-svg/pull/2058)
- fix: remove deprecated import from react-native-web by
[@&#8203;janlat](https://github.com/janlat) in
[https://github.com/software-mansion/react-native-svg/pull/2027](https://github.com/software-mansion/react-native-svg/pull/2027)
- fix: Updating iOS version
[#&#8203;2038](https://github.com/react-native-community/react-native-svg/issues/2038)
by [@&#8203;sgabriel](https://github.com/sgabriel) in
[https://github.com/software-mansion/react-native-svg/pull/2041](https://github.com/software-mansion/react-native-svg/pull/2041)
- Fix syntax error in RNSVGImageShadowNode::initialStateData by
[@&#8203;hsjoberg](https://github.com/hsjoberg) in
[https://github.com/software-mansion/react-native-svg/pull/2079](https://github.com/software-mansion/react-native-svg/pull/2079)
- Fix
[#&#8203;1345](https://github.com/react-native-community/react-native-svg/issues/1345):
opacity does not work with currentColor on Android by
[@&#8203;laptou](https://github.com/laptou) in
[https://github.com/software-mansion/react-native-svg/pull/2080](https://github.com/software-mansion/react-native-svg/pull/2080)
- chore: bump Example to 0.72 by
[@&#8203;WoLewicki](https://github.com/WoLewicki) in
[https://github.com/software-mansion/react-native-svg/pull/2084](https://github.com/software-mansion/react-native-svg/pull/2084)
- chore(deps): bump fast-xml-parser from 4.1.3 to 4.2.4 in /TestsExample
by [@&#8203;dependabot](https://github.com/dependabot) in
[https://github.com/software-mansion/react-native-svg/pull/2063](https://github.com/software-mansion/react-native-svg/pull/2063)
- chore(deps): bump vm2 from 3.9.14 to 3.9.19 by
[@&#8203;dependabot](https://github.com/dependabot) in
[https://github.com/software-mansion/react-native-svg/pull/2056](https://github.com/software-mansion/react-native-svg/pull/2056)
- chore(deps): bump fast-xml-parser from 4.2.4 to 4.2.5 in /TestsExample
by [@&#8203;dependabot](https://github.com/dependabot) in
[https://github.com/software-mansion/react-native-svg/pull/2085](https://github.com/software-mansion/react-native-svg/pull/2085)
- Add web support for toDataURL() on svg tags by
[@&#8203;chrispader](https://github.com/chrispader) in
[https://github.com/software-mansion/react-native-svg/pull/2072](https://github.com/software-mansion/react-native-svg/pull/2072)
- Prevents SvgUri crashes when uri is invalid and adds fallback prop by
[@&#8203;PiotrWszolek](https://github.com/PiotrWszolek) in
[https://github.com/software-mansion/react-native-svg/pull/2071](https://github.com/software-mansion/react-native-svg/pull/2071)
- chore: run prettier and lint by
[@&#8203;WoLewicki](https://github.com/WoLewicki) in
[https://github.com/software-mansion/react-native-svg/pull/2087](https://github.com/software-mansion/react-native-svg/pull/2087)
- chore: bump TestsExample to 0.72 by
[@&#8203;WoLewicki](https://github.com/WoLewicki) in
[https://github.com/software-mansion/react-native-svg/pull/2088](https://github.com/software-mansion/react-native-svg/pull/2088)
- feat: strokeDasharray with Animated by
[@&#8203;WoLewicki](https://github.com/WoLewicki) in
[https://github.com/software-mansion/react-native-svg/pull/2089](https://github.com/software-mansion/react-native-svg/pull/2089)

#### New Contributors

- [@&#8203;christophpurrer](https://github.com/christophpurrer) made
their first contribution in
[https://github.com/software-mansion/react-native-svg/pull/2045](https://github.com/software-mansion/react-native-svg/pull/2045)
- [@&#8203;fauri13](https://github.com/fauri13) made their first
contribution in
[https://github.com/software-mansion/react-native-svg/pull/2058](https://github.com/software-mansion/react-native-svg/pull/2058)
- [@&#8203;janlat](https://github.com/janlat) made their first
contribution in
[https://github.com/software-mansion/react-native-svg/pull/2027](https://github.com/software-mansion/react-native-svg/pull/2027)
- [@&#8203;sgabriel](https://github.com/sgabriel) made their first
contribution in
[https://github.com/software-mansion/react-native-svg/pull/2041](https://github.com/software-mansion/react-native-svg/pull/2041)
- [@&#8203;laptou](https://github.com/laptou) made their first
contribution in
[https://github.com/software-mansion/react-native-svg/pull/2080](https://github.com/software-mansion/react-native-svg/pull/2080)
- [@&#8203;chrispader](https://github.com/chrispader) made their first
contribution in
[https://github.com/software-mansion/react-native-svg/pull/2072](https://github.com/software-mansion/react-native-svg/pull/2072)
- [@&#8203;PiotrWszolek](https://github.com/PiotrWszolek) made their
first contribution in
[https://github.com/software-mansion/react-native-svg/pull/2071](https://github.com/software-mansion/react-native-svg/pull/2071)

**Full Changelog**:
software-mansion/react-native-svg@v13.9.0...v13.10.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "after 5pm,every weekend" in timezone
America/Los_Angeles, Automerge - "after 5pm,every weekend" in timezone
America/Los_Angeles.

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/valora-inc/wallet).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4xOS4yIiwidXBkYXRlZEluVmVyIjoiMzcuMTkuMiIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: valora-bot <valorabot@valoraapp.com>
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.

typescript compile fails for web since 12.4.4
2 participants