This repository was archived by the owner on Jul 11, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 46
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(types): support algoliasearch v5 (#910)
* feat(types): support algoliasearch v5 * update package.json * simplification and correction when not in v5 * add file * real future v5 * export multiple queries too * fake file to allow it to be resolved even if it's just a .d.ts * other file * v3: don't use lite * add missing keys * add other missing thing * closer to what we actually want * import from right spot for v5 * fix comments
- Loading branch information
Showing
4 changed files
with
173 additions
and
49 deletions.
There are no files selected for viewing
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 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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,148 @@ | ||
| // Note: Below, we will be importing all algoliasearch v3,4,5 types. | ||
| // The goal is being able to export the algoliasearch-helper types using | ||
| // the version of the client installed by the developer. | ||
|
|
||
| // @ts-ignore | ||
| import type algoliasearch from 'algoliasearch/lite'; | ||
| // @ts-ignore | ||
| import type * as AlgoliaSearchLite from 'algoliasearch/lite'; | ||
| // @ts-ignore | ||
| import type * as AlgoliaSearch from 'algoliasearch'; | ||
| // @ts-ignore | ||
| import type * as ClientSearch from '@algolia/client-search'; | ||
|
|
||
| // turns any to unknown, so it can be used as a conditional | ||
| type AnyToUnknown<T> = (any extends T ? true : false) extends true | ||
| ? unknown | ||
| : T; | ||
|
|
||
| type SearchClientV4Shape = { | ||
| transporter: unknown; | ||
| }; | ||
|
|
||
| type SearchClientShape = { | ||
| search: unknown; | ||
| }; | ||
|
|
||
| // @ts-ignore | ||
| type ClientV3_4 = ReturnType<typeof algoliasearch>; | ||
|
|
||
| type ClientLiteV5 = AnyToUnknown< | ||
| // @ts-ignore | ||
| ReturnType<typeof AlgoliaSearchLite.liteClient> | ||
| >; | ||
| type ClientFullV5 = AnyToUnknown< | ||
| // @ts-ignore | ||
| ReturnType<typeof AlgoliaSearch.algoliasearch> | ||
| >; | ||
| type ClientSearchV5 = AnyToUnknown< | ||
| // @ts-ignore | ||
| ReturnType<typeof ClientSearch.searchClient> | ||
| >; | ||
| type ClientV5 = ClientLiteV5 extends SearchClientShape | ||
| ? ClientLiteV5 | ||
| : ClientSearchV5 extends SearchClientShape | ||
| ? ClientSearchV5 | ||
| : ClientFullV5 extends SearchClientShape | ||
| ? ClientFullV5 | ||
| : unknown; | ||
|
|
||
| type PickForClient< | ||
| T extends { | ||
| v3: unknown; | ||
| v4: unknown; | ||
| v5: unknown; | ||
| } | ||
| > = ClientV5 extends SearchClientShape | ||
| ? T['v5'] | ||
| : // @ts-ignore | ||
| ClientV3_4 extends SearchClientV4Shape | ||
| ? T['v4'] | ||
| : T['v3']; | ||
|
|
||
| type DefaultSearchClient = PickForClient<{ | ||
| v3: ClientV3_4; | ||
| v4: ClientV3_4; | ||
| v5: ClientV5; | ||
| }>; | ||
|
|
||
| export type SearchOptions = PickForClient<{ | ||
| // @ts-ignore | ||
| v3: AlgoliaSearch.QueryParameters; | ||
| // @ts-ignore | ||
| v4: ClientSearch.SearchOptions; | ||
| v5: NonNullable< | ||
| // @ts-ignore | ||
| AlgoliaSearch.LegacySearchMethodProps[number]['params'] | ||
| >; | ||
| }>; | ||
|
|
||
| export type SearchResponse<T> = PickForClient<{ | ||
| // @ts-ignore | ||
| v3: AlgoliaSearch.Response<T> & { | ||
| appliedRelevancyStrictness?: number; | ||
| nbSortedHits?: number; | ||
| renderingContent?: { | ||
| facetOrdering?: { | ||
| facets?: { | ||
| order?: string[]; | ||
| }; | ||
| values?: { | ||
| [facet: string]: { | ||
| order?: string[]; | ||
| sortRemainingBy?: 'count' | 'alpha' | 'hidden'; | ||
| }; | ||
| }; | ||
| }; | ||
| }; | ||
| }; | ||
| // @ts-ignore | ||
| v4: ClientSearch.SearchResponse<T>; | ||
| // @ts-ignore | ||
| v5: AlgoliaSearch.SearchResponse; // TODO: should be generic | ||
| }>; | ||
|
|
||
| export type SearchResponses<T> = PickForClient<{ | ||
| // @ts-ignore | ||
| v3: AlgoliaSearch.MultiResponse<T>; | ||
| // @ts-ignore | ||
| v4: ClientSearch.MultipleQueriesResponse<T>; | ||
| // @ts-ignore | ||
| v5: AlgoliaSearch.SearchResponses; // TODO: should be generic | ||
| }>; | ||
|
|
||
| export type SearchForFacetValuesResponse = PickForClient<{ | ||
| // @ts-ignore | ||
| v3: AlgoliaSearch.SearchForFacetValues.Response; | ||
| // @ts-ignore | ||
| v4: ClientSearch.SearchForFacetValuesResponse; | ||
| // @ts-ignore | ||
| v5: AlgoliaSearch.SearchForFacetValuesResponse; | ||
| }>; | ||
|
|
||
| export type FindAnswersOptions = PickForClient<{ | ||
| v3: any; | ||
| // @ts-ignore | ||
| v4: ClientSearch.FindAnswersOptions; | ||
| v5: any; | ||
| }>; | ||
|
|
||
| export type FindAnswersResponse<T> = PickForClient<{ | ||
| v3: any; | ||
| // @ts-ignore | ||
| v4: ClientSearch.FindAnswersResponse<T>; | ||
| v5: any; | ||
| }>; | ||
|
|
||
| export interface SearchClient { | ||
| search: DefaultSearchClient['search']; | ||
| searchForFacetValues?: DefaultSearchClient extends { | ||
| searchForFacetValues: unknown; | ||
| } | ||
| ? DefaultSearchClient['searchForFacetValues'] | ||
| : never; | ||
| initIndex?: DefaultSearchClient extends { initIndex: unknown } | ||
| ? DefaultSearchClient['initIndex'] | ||
| : never; | ||
| addAlgoliaAgent?: DefaultSearchClient['addAlgoliaAgent']; | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| // fake file to allow `export * from 'algoliasearch-helper/types/algoliasearch'` |