import type { UseFormOptions, UseFormReturns } from "../use-form/index.cjs";
import type { UseMultiSelectReturnsActions, UseMultiSelectReturnsState } from "../use-multi-select/index.cjs";
import type { UsePaginationOptions, UsePaginationReturnsActions, UsePaginationReturnsState } from "../use-pagination/index.cjs";
import type { UseQueryOptions, UseQueryReturns } from "../use-query/index.cjs";
import type { ReactSetState } from "../use-safe-state/index.cjs";
export interface UsePagingListOptions<Item, FormState extends object> {
    /**
     * fetcher function that will be called when the query is triggered
     */
    fetcher?: UsePagingListFetcher<Item, FormState>;
    /**
     * options for `useForm`, see `useForm` for more details
     *
     * @defaultValue undefined
     */
    form?: UseFormOptions<FormState>;
    /**
     * options for `useQuery`, see `useQuery` for more details
     *
     * @defaultValue undefined
     */
    query?: Omit<UseQueryOptions<UsePagingListFetcher<Item, FormState>>, 'initialParams' | 'initialData' | 'cacheKey' | 'cacheExpirationTime' | 'provider'>;
    /**
     * options for `usePagination`, see `usePagination` for more details
     *
     * @defaultValue undefined
     */
    pagination?: UsePaginationOptions<Item[]>;
    /**
     * keys of form state that will trigger a new query when changed
     *
     * @defaultValue []
     */
    immediateQueryKeys?: (keyof FormState)[];
    /**
     * strategy to handle page number when page size changes
     *
     * - 'reset' - reset to page 1
     * - 'preserve' - preserve the current position by keeping the first item visible on the new page
     *
     * @since 1.14.0
     *
     * @defaultValue 'reset'
     */
    pageStrategy?: 'reset' | 'preserve';
}
export interface UsePagingListFetcherParams<Item, FormState extends object> {
    /**
     * previous data
     */
    previousData: Item[] | undefined;
    /**
     * current page
     */
    page: number;
    /**
     * page size
     */
    pageSize: number;
    /**
     * form state
     */
    form: FormState;
    /**
     * set total count
     */
    setTotal: ReactSetState<number>;
}
export type UsePagingListFetcher<Item, FormState extends object> = (params: UsePagingListFetcherParams<Item, FormState>) => Promise<Item[]>;
export interface UsePagingListReturns<Item, FormState extends object> extends Pick<UseQueryReturns<any, any>, 'loading' | 'params' | 'error' | 'initializing' | 'refreshing' | 'loadingSlow'> {
    /**
     * list data
     */
    list: Item[];
    /**
     * form state
     */
    form: UseFormReturns<FormState>;
    /**
     * refresh query
     */
    refresh: () => void;
    /**
     * selection state
     */
    selection: UseMultiSelectReturnsState<Item> & UseMultiSelectReturnsActions<Item>;
    /**
     * pagination state
     */
    pagination: UsePaginationReturnsState<Item[]> & UsePaginationReturnsActions;
}
/**
 * A hook for handling paging lists that integrates the functionalities of `useQuery`, `useForm`, `useMultiSelect`, and `usePagination`.
 *
 * @since 1.7.0
 */
export declare function usePagingList<Item, FormState extends object = object>(options?: UsePagingListOptions<Item, FormState>): UsePagingListReturns<Item, FormState>;