@wix/patterns 1.457.0 → 1.459.0

package/dist/dts-bundle/hooks/usePickerModal.d.ts

@@ -0,0 +1,684 @@
+import { PaginationModeConfig } from '@wix/bex-core/react';
+import { Essentials } from '@wix/fe-essentials/core';
+import React, { CSSProperties, ReactElement, ReactNode, ComponentType } from 'react';
+import { SearchProps, BoxProps, TableListItemProps, SelectorListItem, TableListItemColumn, CustomModalLayoutProps, IconElement, FloatingNotificationProps, FloatingNotification, SelectorListContentProps } from '@wix/design-system';
+
+interface Environment {
+    readonly language: string;
+    readonly artifactId: string;
+    readonly componentId?: string;
+    readonly componentName?: string;
+    readonly uiLibVersion?: string;
+    readonly providerType?: 'bm' | 'giza' | 'essentials';
+    readonly msid?: string;
+}
+
+interface ErrorMonitor {
+    captureException(exception: unknown): string;
+}
+
+/**
+ * `TranslationsKeys` — widened to `string`.
+ * Generated key list that is cairo's own, not something a caller writes, so it is not published as its own bundle.
+ */
+type TranslationsKeys = string;
+type Translate = {
+    (key: TranslationsKeys, params?: Record<string, string | number>): string;
+    (key: 'cairo.import.summaryUpdated', params: {
+        count: number;
+    }): string;
+    (key: 'cairo.import.missingRequiredMessage', params: {
+        fields: string;
+    }): string;
+    (key: 'cairo.tags.manageTags.modal.deleteModal.body.asLabels', params: {
+        name: string;
+    }): string;
+    (key: 'cairo.filtersPanel.numRange.maxRange.consumer.error', params: {
+        maxAmount: number;
+    }): string;
+    (key: 'cairo.bulkSelectedWithTotal', params: {
+        num: number;
+        total: number;
+    }): string;
+    (key: 'cairo.import.newFieldOption', params: {
+        column: string;
+    }): string;
+    (key: 'cairo.setupWidget.progress.label', params: {
+        completed: string;
+        total: number;
+    }): string;
+    (key: 'cairo.search.Tab.noresults.title', params: {
+        tabName: string;
+    }): string;
+    (key: 'cairo.fieldValidation.charactersLimit.outOfBounds.error', params: {
+        min: number;
+        max: number;
+    }): string;
+    (key: 'cairo.manageView.setAsDefault.error.toast', params: {
+        viewName: string;
+    }): string;
+    (key: 'cairo.deleteSuccess', params: {
+        itemName: string;
+    }): string;
+    (key: 'cairo.import.partialSuccess', params: {
+        succeeded: string;
+        failed: string;
+    }): string;
+    (key: 'cairo.saveView.Success.toast', params: {
+        viewName: string;
+    }): string;
+    (key: 'cairo.customFields.fieldType.date.invalid.value', params: {
+        dateFormat: string;
+    }): string;
+    (key: 'cairo.customFields.maxFields.tooltip', params: {
+        max: number;
+    }): string;
+    (key: 'cairo.bulkActions.max.selection', params: {
+        total: number;
+        max: number;
+    }): string;
+    (key: 'cairo.customFields.delete.modal.title', params: {
+        selectedField: string;
+    }): string;
+    (key: 'cairo.customFields.deleted.success.toast', params: {
+        selectedField: string;
+    }): string;
+    (key: 'cairo.collectionPage.nestedLimit.tooltip', params: {
+        subCatsAmount: number;
+    }): string;
+    (key: 'cairo.tags.manageTags.modal.list.create.CTA', params: {
+        tagName: string;
+    }): string;
+    (key: 'cairo.import.summaryCreated', params: {
+        count: number;
+    }): string;
+    (key: 'cairo.customFields.archive.modal.title.enabled', params: {
+        selectedField: string;
+    }): string;
+    (key: 'cairo.editableTable.contextMenu.deleteRow.CTA', params: {
+        count: number;
+    }): string;
+    (key: 'cairo.import.partialSuccessToast', params: {
+        failed: string;
+        imported: string;
+    }): string;
+    (key: 'cairo.settings.search.anchor-doesnt-exist.error', params: {
+        anchorName: string;
+    }): string;
+    (key: 'cairo.tags.creationLimitReached.error.asLabels', params: {
+        limit: string;
+        count: number;
+    }): string;
+    (key: 'cairo.editableTable.field.validation.required', params: {
+        fieldName: string;
+    }): string;
+    (key: 'cairo.emptyState.subtitle.nothingMatches', params: {
+        term: string;
+    }): string;
+    (key: 'cairo.customFields.restore.error.toast', params: {
+        selectedField: string;
+    }): string;
+    (key: 'cairo.editableTable.updateItem.success.toast', params: {
+        count: number;
+    }): string;
+    (key: 'cairo.sortableColumns.modal.title', params: {
+        columnTitle: string;
+    }): string;
+    (key: 'cairo.table.deleteViewModal.deleteBody', params: {
+        viewName: string;
+    }): string;
+    (key: 'cairo.table.summaryBar.list.item', params: {
+        title: string;
+        value: string;
+    }): string;
+    (key: 'cairo.customFields.delete.modal.description', params: {
+        selectedField: string;
+    }): string;
+    (key: 'cairo.bulkSelected', params: {
+        num: number;
+    }): string;
+    (key: 'cairo.tags.collectionPage.popover.create.CTA.asLabels', params: {
+        tagName: string;
+    }): string;
+    (key: 'cairo.tags.manageTags.modal.title.asLabels', params: {
+        EntityName: string;
+    }): string;
+    (key: 'cairo.fieldValidation.maxCharacter', params: {
+        charMax: number;
+    }): string;
+    (key: 'cairo.picker.itemsSelected', params: {
+        total: number;
+        max: number;
+    }): string;
+    (key: 'cairo.filtersPanel.numRange.minRange.consumer.error', params: {
+        minAmount: number;
+    }): string;
+    (key: 'cairo.tags.manageTags.modal.list.create.CTA.asLabels', params: {
+        tagName: string;
+    }): string;
+    (key: 'cairo.manageView.Rename.Success.toast', params: {
+        oldViewName: string;
+        newViewName: string;
+    }): string;
+    (key: 'cairo.tags.creationLimitReached.error', params: {
+        limit: string;
+        count: number;
+    }): string;
+    (key: 'cairo.fieldValidation.minCharacter', params: {
+        charMin: number;
+    }): string;
+    (key: 'cairo.appliedFilters', params: {
+        num: number;
+    }): string;
+    (key: 'cairo.tags.bulkItemUpdate.toast.error.asLabels', params: {
+        total: number;
+    }): string;
+    (key: 'cairo.fieldValidation.minNumber', params: {
+        minAmount: number;
+    }): string;
+    (key: 'cairo.setupWidget.aggregated.counter', params: {
+        completed: string;
+        total: number;
+    }): string;
+    (key: 'cairo.bulkSelected.selectUpTo', params: {
+        max: number;
+    }): string;
+    (key: 'cairo.tags.manageTags.modal.deleteModal.body', params: {
+        name: string;
+    }): string;
+    (key: 'cairo.tags.manageTags.modal.title', params: {
+        EntityName: string;
+    }): string;
+    (key: 'cairo.sortableColumns.modal.description', params: {
+        columnTitle: string;
+    }): string;
+    (key: 'cairo.deleteView.Success.toast', params: {
+        viewName: string;
+    }): string;
+    (key: 'cairo.entity.item', params: {
+        num: number;
+    }): string;
+    (key: 'cairo.import.summaryFailed', params: {
+        count: number;
+    }): string;
+    (key: 'cairo.manageView.saveChanges.Success.toast', params: {
+        viewName: string;
+    }): string;
+    (key: 'cairo.search.nothingMatches.title', params: {
+        term: string;
+    }): string;
+    (key: 'cairo.editableTable.deleteItem.success.toast', params: {
+        count: number;
+    }): string;
+    (key: 'cairo.dragAndDrop.live-region.itemDragged.sr', params: {
+        currentNumber: number;
+        totalNumber: number;
+    }): string;
+    (key: 'cairo.import.summaryCounts', params: {
+        succeeded: string;
+        failed: string;
+    }): string;
+    (key: 'cairo.import.newFieldHelper', params: {
+        typeName: string;
+    }): string;
+    (key: 'cairo.tags.manageTags.modal.list.input.validation.maxLength', params: {
+        count: number;
+    }): string;
+    (key: 'cairo.selector.modal.items.selected', params: {
+        total: number;
+    }): string;
+    (key: 'cairo.import.missingRequiredField', params: {
+        count: number;
+    }): string;
+    (key: 'cairo.tags.manageTags.modal.list.input.validation.maxLength.asLabels', params: {
+        count: number;
+    }): string;
+    (key: 'cairo.selected', params: {
+        total: number;
+    }): string;
+    (key: 'cairo.editableTable.contextMenu.clearCell.CTA', params: {
+        count: number;
+    }): string;
+    (key: 'cairo.filtersPanel.search.noResults.title', params: {
+        term: string;
+    }): string;
+    (key: 'cairo.sortableColumns.notification', params: {
+        columnTitle: string;
+    }): string;
+    (key: 'cairo.tags.popover.creationLimitReached.error.asLabels', params: {
+        limit: string;
+        count: number;
+    }): string;
+    (key: 'cairo.import.summaryErrorRow', params: {
+        row: string;
+        message: string;
+    }): string;
+    (key: 'cairo.editableTable.field.validation.specificValues', params: {
+        fieldName: string;
+    }): string;
+    (key: 'cairo.tags.popover.creationLimitReached.error', params: {
+        limit: string;
+        count: number;
+    }): string;
+    (key: 'cairo.fieldValidation.maxNumber', params: {
+        maxAmount: number;
+    }): string;
+    (key: 'cairo.customFields.archive.success.toast.enabled', params: {
+        selectedField: string;
+    }): string;
+    (key: 'cairo.customFields.restored.success.toast', params: {
+        selectedField: string;
+    }): string;
+    (key: 'cairo.appliedFilters.selected', params: {
+        num: number;
+    }): string;
+    (key: 'cairo.editableTable.contextMenu.removeRows.CTA', params: {
+        count: number;
+    }): string;
+    (key: 'cairo.customFields.delete.error.toast', params: {
+        selectedField: string;
+    }): string;
+    (key: 'cairo.tags.collectionPage.popover.create.CTA', params: {
+        tagName: string;
+    }): string;
+    (key: 'cairo.import.fileNameLabel', params: {
+        name: string;
+    }): string;
+    (key: 'cairo.tags.bulkItemUpdate.toast.error', params: {
+        total: number;
+    }): string;
+    (key: 'cairo.dragAndDrop.button-role-label.sr', params: {
+        itemName: string;
+    }): string;
+    (key: 'cairo.dropdownSearch.filters.selected', params: {
+        total: number;
+    }): string;
+    (key: 'cairo.tags.tagsWidget.options.add.CTA', params: {
+        tagName: string;
+    }): string;
+    (key: 'cairo.customFields.archive.error.toast', params: {
+        selectedField: string;
+    }): string;
+    (key: 'cairo.a11y.liveRegion.resultsFound', params: {
+        num: number;
+    }): string;
+    (key: 'cairo.dragAndDrop.live-region.itemDropped.sr', params: {
+        currentNumber: number;
+    }): string;
+    (key: 'cairo.manageView.setAsDefault.success.toast', params: {
+        viewName: string;
+    }): string;
+    (key: 'cairo.filtersPanel.appliedFilters.label', params: {
+        numberAppliedFilters: number;
+    }): string;
+    (key: 'cairo.tags.tagsWidget.options.add.CTA.asLabels', params: {
+        tagName: string;
+    }): string;
+};
+
+interface SelectionStatus {
+    id: string;
+    toggle: () => SelectionStatus;
+    start: () => SelectionStatus;
+    final: () => SelectionStatus;
+    isChecked: boolean;
+    isIndeterminate: boolean;
+}
+
+/**
+ * `PickerState` — you receive this, you don't construct it.
+ * Produced by `usePicker()`.
+ */
+declare class PickerState<T = any, F = any> {
+    [key: string]: unknown;
+}
+
+/**
+ * `Filter` — cut here because it has its own bundle.
+ * Look `Filter` up in the bundle index for its full shape.
+ */
+interface Filter<T = any> {
+    [key: string]: unknown;
+}
+type FiltersMap = {
+    [key: string]: Filter<any> | undefined;
+};
+type OptionalFiltersMap = {
+    [key: string]: undefined;
+};
+
+type ExtractFilterValue<T> = T extends Filter<infer U> ? U : undefined;
+/**
+ * `ComputedQuery` — cut here because it has its own bundle.
+ * Look `ComputedQuery` up in the bundle index for its full shape.
+ */
+interface ComputedQuery<F = any> {
+    [key: string]: unknown;
+}
+
+interface DataResultRaw<T> {
+    /**
+     * Array of items returned from the server.
+     * @external
+     */
+    items: T[];
+    /**
+     * Total items available in the server, *after* applying filters. If not provided, offset pagination will not work correctly.
+     * If you are using a cursor and did not include `total` in your query request, you can use the `fetchTotal` function to extract it asynchronously.
+     * @default `items.length`
+     * @external
+     */
+    total?: number | null;
+    /**
+     * Total items available in the server, *before* applying filters.
+     * @external
+     */
+    available?: number;
+    /**
+     * In case of cursor pagination, this will be the value that will be sent in the query on the next page request.
+     * @external
+     */
+    cursor?: string | undefined | null;
+    /**
+     * Indicates whether there are more items available after the current page.
+     * @external
+     */
+    hasNext?: boolean | null;
+}
+
+interface CollectionSearchProps extends Partial<SearchProps> {
+    onSearchChange?: (value: string) => unknown;
+    onSearchClick?: () => unknown;
+    onSearchBlur?: (value: string) => unknown;
+    visibility?: CSSProperties['visibility'];
+}
+declare const CollectionSearch: (<T, F extends FiltersMap = FiltersMap>({ onSearchChange, onSearchClick, onSearchBlur, visibility, expandable, ...rest }: CollectionSearchProps) => React.JSX.Element) & {
+    displayName: string;
+};
+
+type CollectionSearchElement = ReactElement<CollectionSearchProps, typeof CollectionSearch>;
+
+type MultipleSelection = boolean | number;
+type MaxSelectionLabelProps = {
+    dataHook?: string;
+    multiple?: MultipleSelection;
+    t: Translate;
+    customLabel?(_: {
+        num: number;
+        max: number;
+    }): string;
+    selectedCount: number;
+};
+
+interface PickerProps<T, F extends FiltersMap> {
+    dataHook?: BoxProps['dataHook'];
+    flex?: CSSProperties['flex'];
+    state: PickerState<T, F>;
+    renderError: (params: {
+        err: unknown;
+        isOnline: boolean;
+    }) => ReactElement;
+    renderEmptyState?: (params: {
+        hasAvailableItems: boolean;
+        query: ComputedQuery<F>;
+    }) => ReactElement | null | undefined;
+    hasFilterDropdown?: boolean;
+    children: ReactNode;
+}
+
+interface PickerListItemProps extends Partial<Omit<TableListItemProps, 'options'>>, SelectorListItem {
+    options: (Omit<TableListItemColumn, 'value'> & {
+        value?: ReactNode;
+        end?: boolean;
+    })[];
+}
+
+interface PickerContentBaseWrappedProps extends Partial<CustomModalLayoutProps> {
+}
+
+interface PickerContentItemsSelectionProps<T, F extends FiltersMap> extends Partial<PickerContentBaseWrappedProps> {
+    modalState: PickerModalState<T, F>;
+    customContentButtonText?: string;
+    customContentButtonPrefixIcon?: IconElement;
+    /**
+     * A callback to be called when the custom content button is clicked
+     */
+    customContentButtonOnClick?: (param: {
+        onClose: (newItems?: T[]) => void;
+    }) => void;
+    customContent?: CustomModalContent<T>;
+    /**
+     * Shows "Select All" checkbox as a side action (overrides "customContent" prop).
+     * If `multiple={number}` or `multiple={false}` are used, this prop does nothing.
+     */
+    showSelectAllCheckbox?: boolean;
+    multiple?: MultipleSelection;
+    /**
+     * Shows a SingleSelectFilter component in a picker modal to filter items;
+     */
+    filterComponent?: ReactElement;
+    /**
+     * A function that render a item row in the selector list
+     */
+    renderItem: (item: T, index: number) => Partial<PickerListItemProps>;
+    /**
+     * A render function to be rendered when there're no items to show in the table.<br>
+     * You can use the built in [`<CollectionEmptyState />`](./?path=/story/features-display-empty-states--collectionemptystate).<br>
+     * The function accepts the following parameters
+     *   * `hasAvailableItems`: Indicates whether other items might have been shown using other filtering / search
+     *   * `query`: An instance of [ComputedQuery](./?path=/story/common-types--computedquery) that represents the query that resulted with an empty state
+     */
+    renderEmptyState?: (params: {
+        hasAvailableItems: boolean;
+        query: ComputedQuery<F>;
+    }) => ReactElement<any, any> | null | undefined;
+    renderError: PickerProps<T, F>['renderError'];
+    /**
+     * When set to `true`, the modal primary button will be always enabled.
+     */
+    enablePrimaryButton?: boolean;
+    /**
+     * Displays a search input in the picker modal.
+     * Accepts a boolean or a custom CollectionSearch element as a parameter.
+     * When passing `false`, no search input is displayed.
+     * @default true
+     * @external
+     */
+    search?: boolean | CollectionSearchElement;
+    /**
+     * @deprecated Use search={false} instead
+     * Hides the search input of the picker
+     */
+    hideSearch?: boolean;
+    /**
+     * Function that returns label for multi selection like:
+     * '2 items selected (24 max)`
+     * This function accepts argument {num: number, max: number}
+     */
+    customMaxSelectionLabel?: MaxSelectionLabelProps['customLabel'];
+    /**
+     * Function that returns custom notification that will be displayed in the picker modal.
+     * Useful to describe additional information about the selection (for instance how to increase limit of selected items).
+     * @param data.selected - number of selected items
+     * @param data.total - total number of items
+     */
+    renderCustomNotification?: (data: {
+        selected?: number;
+        total?: number;
+    }) => ReactElement<FloatingNotificationProps, typeof FloatingNotification>;
+    /** Displays count of selected items in <CustomModalLayout /> `sideActions` */
+    showSelectedCount?: boolean;
+}
+
+interface PickerContentAdditionalStepProps<T> extends Partial<PickerContentBaseWrappedProps> {
+    /** When true, the picker will start directly on the additional step, skipping the first selection step. The back button will also be hidden. */
+    autoAdditionalStepOnInitialSelect?: boolean;
+    /** The additional step title */
+    additionalStepTitle?: string;
+    /** The additional step subtitle */
+    additionalStepSubtitle?: string;
+    /** Defines a function that returns a component to render in the additional step content area, if `hasAdditionalStep` returns `false` this prop is ignored. */
+    renderAdditionalStepContent?: (props: {
+        item: T;
+    }) => JSX.Element;
+    /** Indicates if selected item has additional step or not */
+    hasAdditionalStep?: (props: {
+        item: T;
+    }) => boolean;
+    /** Defines a callback function just before primaryButtonOnClick callback, returned value will be added as `additionalStepData` in onSelect payload */
+    onBeforeSelectAdditionalStep?: () => Promise<unknown>;
+    /** Defines a callback function after user clicks on the continue button to additional step content */
+    continueButtonOnClick?: (props: {
+        item: T;
+    }) => void;
+    /** Defines a callback function after user clicks on the back button in the additional step content */
+    backButtonOnClick?: (props: {
+        item: T;
+    }) => void;
+    /** Additional steps modal content overrides */
+    additionalStepOverrides?: {
+        extraNode?: React.ReactNode;
+        extraText?: string;
+        subtitle?: string;
+        image?: React.ReactNode;
+        enablePrimaryButton?: boolean;
+    };
+}
+
+interface PickerContentComponentBaseProps<T, F extends FiltersMap> extends PickerContentItemsSelectionProps<T, F>, PickerContentAdditionalStepProps<T> {
+    /**
+     * Additional props to pass to [SelectorList](https://www.docs.wixdesignsystem.com/?path=/story/components-lists--selectorlist), i.e `imageSize`, `imageShape` etc.
+     */
+    selectorListProps?: Partial<SelectorListContentProps>;
+}
+type PickerContentComponentProps<T, F extends FiltersMap = OptionalFiltersMap> = Omit<PickerContentComponentBaseProps<T, F>, 'renderItem' | 'pickerContentState' | 'renderEmptyState' | 'renderPickerContent'>;
+type PickerContentComponent<T, F extends FiltersMap = OptionalFiltersMap> = ComponentType<PickerContentComponentProps<T, F>>;
+
+type RawFiltersParams<F extends FiltersMap> = {
+    [P in keyof F]: {
+        initialValue?: ExtractFilterValue<F[P]>;
+    };
+};
+interface PickerModalEvents {
+    readonly onError?: (params: {
+        err: unknown;
+        isOnline: boolean;
+    }) => boolean | null | undefined | void;
+}
+interface OnSelectOptions<T> {
+    isSelectAll: boolean;
+    uncheckedValues: T[];
+    selectedCount: number;
+    /**
+     * @deprecated Read `values` prop instead
+     */
+    partiallySelectedIds: string[];
+    values: {
+        status: SelectionStatus;
+        value: T;
+    }[];
+    defaultStatus: SelectionStatus;
+    additionalStepData?: unknown;
+}
+interface UsePickerModalParamsBase<T, F extends FiltersMap> {
+    /** The user's environment
+     * - `language` - preferable language for the user  */
+    environment: Environment;
+    /** A `ErrorMonitor` instance `@wix/fe-essentials/error-monitor` */
+    errorMonitor: ErrorMonitor;
+    /** A `BILoggerFactory` instance `@wix/fe-essentials/bi` */
+    biLoggerFactory: Essentials['biLoggerFactory'];
+    /**
+     * Number of items to fetch on each page
+     */
+    limit?: number;
+    /**
+     * Defines the initial values and config for filters that the collection supports.
+     * For example: { premium: {initialValue: 'true'} }
+     */
+    filters?: Partial<RawFiltersParams<F>>;
+    /**
+     * Optional function that loads more dependencies required for the content of the modal to show.
+     * The modal will keep showing a loader when this promise is still pending.
+     * For example custom i18n translations.
+     */
+    fetchInitialProps?: () => Promise<unknown>;
+    minContentHeight?: string | number;
+    /**
+     * A function being called after clicking the primary button of the modal.  It accepts the following parameters:
+     * - `items` - The items that were selected in the modal's internal selector list
+     * - `options.isSelectAll` - Indicates the user toggled on the "Select All" checkbox (relevant only when `showSelectAllCheckbox` is passed to `<PickerContent />`)
+     * - `options.selectedCount` - The number of items the user selected. Subtracts from total count the items that were unchecked after toggling on the "Select All" checkbox
+     * - `options.uncheckedValues` - The items the user unchecked after toggling on the "Select All" checkbox (relevant only when `showSelectAllCheckbox` is passed to `<PickerContent />`)
+     * - `options.partiallySelectedIds` - Selected items in indeterminate status
+     */
+    onSelect: (items: T[], options: OnSelectOptions<T>) => unknown;
+    /**
+     * A function that returns a promise of dynamically imported component that renders [`<PickerContent `/>](./?path=/story/base-components-collections-picker--pickercontent) internally
+     */
+    pickerContentComponent: () => Promise<{
+        default: PickerContentComponent<T, F>;
+    }>;
+    shouldFilterNotAffectTotalCount?: (filterName: keyof F) => boolean;
+    /**
+     * Optional callbacks for various events of the picker modal lifecycle
+     * `onError` - when there's an error fetching initial data, picker content chunk or initial props.
+     */
+    events?: PickerModalEvents;
+    /**
+     * Indicates what type of pagination the `fetchData` function supports.<br>
+     * In case the server accepts the `query.offset` parameter - pass `'offset'`
+     * In case the server returns a `cursor` from `fetchData` - pass `'cursor'`
+     * @default offset
+     */
+    paginationMode?: 'offset' | 'cursor';
+    /**
+     * The query name used for cache purposes. This should be a unique value per API endpoint consumed inside the `fetchData` function.<br>
+     * It's recommended to use the [Fqdn](https://bo.wix.com/wix-docs/rnd/p13n-guidelines---aips/guidance-aips/wix-api-basics/[1009]-fqdn) of the service used in `fetchData` as `queryName`
+     */
+    queryName: string;
+    /**
+     * A function that integrates with the API to fetch the collection data from.<br>
+     * Accepts the following parameters:
+     * - `query`: A [ComputedQuery](./?path=/story/common-types--computedquery)  instance. Holds all the relevant variables to query the server API with.
+     *
+     * The function must return a promise of [DataResultRaw](./?path=/story/common-models--dataresultraw)
+     */
+    fetchData?: (query: ComputedQuery<F>) => Promise<DataResultRaw<T>>;
+    isOpenInitially?: boolean;
+    /**
+     * In the picker modal, the data is prefetched before the user opens the modal. This flag disables this behavior.
+     */
+    skipFirstPagePrefetch?: boolean;
+    /**
+     * A flag to disable default behavior when fetch data returns a single item.
+     * Instead of calling onSelect a dialog will be opened.
+     */
+    disableAutoSelectOnSingleItem?: boolean;
+}
+
+type CustomModalContent<T> = (props: {
+    isOpen: boolean;
+    close: (items?: T[]) => Promise<unknown>;
+    width?: CustomModalLayoutProps['width'];
+}) => ReactNode;
+
+/**
+ * `PickerModalState` — you receive this, you don't construct it.
+ * Produced by `usePickerModal()` (also `usePickerModalState()`).
+ */
+declare class PickerModalState<T = any, F = any> {
+    [key: string]: unknown;
+}
+
+interface UsePickerModalParamsOverrides<T, F extends FiltersMap> {
+    environment?: Partial<UsePickerModalParamsBase<T, F>['environment']>;
+}
+type UsePickerModalParamsBM<T, F extends FiltersMap> = Omit<UsePickerModalParamsBase<T, F>, 'paginationMode' | 'fetchData' | 'environment' | 'errorMonitor' | 'biLoggerFactory'>;
+type UsePickerModalParams<T, F extends FiltersMap> = UsePickerModalParamsBM<T, F> & UsePickerModalParamsOverrides<T, F> & PaginationModeConfig<T, F>;
+type PikerModalFactory = <T, F extends FiltersMap = OptionalFiltersMap>(config: UsePickerModalParams<T, F>) => PickerModalState<T, F>;
+declare function useCreatePickerModal(): PikerModalFactory;
+declare function usePickerModal<T, F extends FiltersMap = OptionalFiltersMap>(params: UsePickerModalParams<T, F>): PickerModalState<T, F>;
+
+export { useCreatePickerModal, usePickerModal };
+export type { PikerModalFactory, UsePickerModalParams };