instantsearch: [Bug] - Issue with your exported types when upgrading to V7
đ Current behavior
I used the codemod and also attempted to manually solve the issue however my editor and TS itself is very confused with your types:
import {
type InstantSearchProps,
useHits,
type UseHitsProps,
usePagination,
type UsePaginationProps,
connectMenu, <-- This doesn't exist apparently
connectSearchBox, <--- This doesn't exist either
} from 'react-instantsearch'
This also failed in the terminal
I can ts-ignore this and it all works fine so you do âactually export itâ but your types are not playing ball at allâŚ
I then installed your core package and it also doesnât export those two functions đ¤ ⌠so I tried accessing the index file directly from the core package âŚ
And all good⌠so there is something up with how you export the types.
đ Steps to reproduce
Setup a new TS project
Install new V7 react-instantsearch pkg and try to use connectMenu or connectSearchBox <- These are the only two I needed, there may be more.
Live reproduction
https://codesandbox.io/s/cool-fast-lfppn7?file=/src/App.tsx
đ Expected behavior
I expect the types to be exported from the right place, and I donât expect to have to install the core library separately as your docs state that they are re-exported from the react-instantsearch pkg
Package version
7.2.0
Operating system
No response
Browser
No response
Code of Conduct
- I agree to follow this projectâs Code of Conduct
About this issue
- Original URL
- State: closed
- Created 8 months ago
- Reactions: 1
- Comments: 19 (10 by maintainers)
Sorry you may say this but it is there. So I would check the code and make sure⌠on checking react-instantsearch v7.2.0 you in-fact export everything from core, so one would expect not to have to install core at all and use
react-instantsearchonly.the below is a lot of connect functions considering they donât âexistâ for v7 these functions are also usable but fail type checking.
the below is your react-instantsearch-core types which indeed export connect* function type declarations
So I appreciate your intention is that they donât exist⌠but they very much do and make your docs a TON more confusing⌠at the least this is a bug and not expected behaviour on either my part as the consumer reading your docs and your part as you say they shouldnât exist at all in v7 đ
Hey @aymeric-giraudet thanks for getting back to me and for the suggestion. I ending up refactoring a ton of the code a couple weeks back so this issue isnât as pressing. Looking in my pnpm-lock file there were no other react-instantsearch pkg versions so not sure why it said they were there. I even screenshotted the type defs from the pkg inside 7.2.0 so not sure why there are so many differing results (maybe you are on 7.2.X and not 0).
To help you guys debug here is our lock file (had to upload as a zip) pnpm-lock.yaml.zip
The reason I donât just think itâs my IDE or something weird is because I nuked my node_mods and the cache a lot before re-installing and I still came up with the above screenshots đ¤ˇđ˝ââď¸ but yeah I dunno anymore đ
Hi @joelpierre,
First, did you run the codemod against your
.tsxfiles ? By default it seems like it doesnât pick up.tsfiles, so you should use it like so :When I do this on a file importing
connectMenufromreact-instantsearch-dom, it does get replaced touseMenufromreact-instantsearch, and it even outputs a HoC calledconnectMenualong with a TODO message :Regarding your type errors, can you show the contents of
package.jsoninreact-instantsearch-core? You can also run this command in the terminal :head node_modules/react-instantsearch-core/package.jsonYou could also link a
package-lock.json,yarn.lockorpnpmlock file if youâre using it.Thank you !
You replace connectMenu with useMenu đ @jdnichollsc