fix(types): make all usages of UiState in InstantSearch generic #5060
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
This allows someone with custom widgets to still use setUiState etc. without type errors
Haroenv
requested review from
a team,
FabienMotte and
sarahdayan
and removed request for
a team
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 8d01a07:
|
Haroenv
commented
Jun 8, 2022
| @@ -2038,7 +2038,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/instantsear | |||
|
|
|||
| test('with function form sets indices state', async () => { | |||
| const searchClient = createSearchClient(); | |||
| const search = new InstantSearch({ | |||
| const search = new InstantSearch<UiState>({ | |||
There was a problem hiding this comment.
This is needed because initialUiState seems to "fill in" the generic. That makes sense, but in this case it makes things required that aren't actually required. Not sure how to solve that though! This already was the case before the PR, but became visible due to usage of TUiState in setUiState
There was a problem hiding this comment.
#5061 fixes this, but I'll merge this as two PRs
Haroenv
added a commit
that referenced
this pull request
Jun 8, 2022
if you pass initialUiState, that should be asserted by the generic UiState, not automatically accepted. Otherwise you get use cases like the "with function form sets indices state" test where setUiState thinks query is required, just because it has the default given The way this works is by using `NoInfer` from microsoft/TypeScript#14829 (comment) which seems to be quite relied upon This is a follow-up on #5060
This was referenced Jun 8, 2022
Haroenv
added a commit
to algolia/react-instantsearch
that referenced
this pull request
Jun 8, 2022
Haroenv
added a commit
to algolia/react-instantsearch
that referenced
this pull request
Jun 9, 2022
* fix(types): allow useInstantSearch to be generic * avoid algolia/instantsearch#5060
FabienMotte
approved these changes
Jun 9, 2022
Haroenv
added a commit
that referenced
this pull request
Jun 9, 2022
* fix(types): make all usages of UiState in InstantSearch generic This allows someone with custom widgets to still use setUiState etc. without type errors * fix lint * fix(types): avoid inferring UiState type from initialUiState if you pass initialUiState, that should be asserted by the generic UiState, not automatically accepted. Otherwise you get use cases like the "with function form sets indices state" test where setUiState thinks query is required, just because it has the default given The way this works is by using `NoInfer` from microsoft/TypeScript#14829 (comment) which seems to be quite relied upon This is a follow-up on #5060
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.
Summary
This allows someone with custom widgets to still use setUiState etc. without type errors
Result
all places
UiStateis used in the InstantSearch instance are now generic and use TUiState.There are still places left in individual widgets, middleware which aren't generic, but that can be solved in a different PR
A sandbox showing the fixed problem: https://codesandbox.io/s/instantsearch-js-forked-m8nm7s?file=/src/app.ts:1152-1262