react-select-async-paginate/packages/react-select-fetch/src/types.ts at d4488d08df58c2017aff5a5f20964d311a9d4886 · vtaits/react-select-async-paginate · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
import type { ReactElement } from "react";
import type {
	GroupBase,
	OptionsOrGroups,
	Props as SelectProps,
} from "react-select";
import type {
	ComponentProps,
	Response,
	UseAsyncPaginateBaseParams,
	UseAsyncPaginateParams,
} from "react-select-async-paginate";

export type Additional = {
	page: number;
};

export type MapResponsePayload<
	OptionType,
	Group extends GroupBase<OptionType>,
> = {
	search: string;
	prevPage: number;
	prevOptions: OptionsOrGroups<OptionType, Group>;
};

export type MapResponse<OptionType, Group extends GroupBase<OptionType>> = (
	responseRaw: unknown,
	payload: MapResponsePayload<OptionType, Group>,
) => Response<OptionType, Group, Additional>;

export type Get = <Response>(
	url: string|undefined,
	params: {
		[key: string]: unknown;
	},
) => Promise<Response>;

export type UseSelectFetchMapParams<
	OptionType,
	Group extends GroupBase<OptionType>,
> = {
	url?: string;
	queryParams?: {
		[key: string]: unknown;
	};
	searchParamName?: string | null;
	pageParamName?: string | null;
	offsetParamName?: string | null;
	mapResponse?: MapResponse<OptionType, Group>;
	get?: Get;
	initialPage?: number;
	defaultInitialPage?: number;
};

export type UseSelectFetchParams<
	OptionType,
	Group extends GroupBase<OptionType>,
> = UseSelectFetchMapParams<OptionType, Group> &
	Partial<UseAsyncPaginateParams<OptionType, Group, Additional>>;

export type UseSelectFetchBaseParams<
	OptionType,
	Group extends GroupBase<OptionType>,
> = UseSelectFetchParams<OptionType, Group> &
	Partial<UseAsyncPaginateBaseParams<OptionType, Group, Additional>> & {
		inputValue: string;
		menuIsOpen: boolean;
	};

export type SelectFetchProps<
	OptionType,
	Group extends GroupBase<OptionType>,
	IsMulti extends boolean,
> = SelectProps<OptionType, IsMulti, Group> &
	UseSelectFetchParams<OptionType, Group> &
	ComponentProps<OptionType, Group, IsMulti>;

export type SelectFetchType = <
	OptionType,
	Group extends GroupBase<OptionType>,
	IsMulti extends boolean = false,
>(
	props: SelectFetchProps<OptionType, Group, IsMulti>,
) => ReactElement;