@wix/patterns 1.456.0 → 1.458.0

package/dist/dts-bundle/components/CollectionPage.d.ts

@@ -0,0 +1,41 @@
+import { PageProps } from '@wix/design-system';
+import React, { ReactNode } from 'react';
+
+/**
+ * `CollectionState` — you receive this, you don't construct it.
+ * Produced by `useFilterCollection()` (also `useStaticListFilterCollection()`, `useCollection()`, `createCollection()`).
+ */
+declare class CollectionState<T, F> {
+}
+
+/**
+ * `Filter` — cut here because it has its own bundle.
+ * Look `Filter` up in the bundle index for its full shape.
+ */
+interface Filter<T> {
+}
+type FiltersMap = {
+    [key: string]: Filter<any> | undefined;
+};
+
+interface CollectionPageProps<T, F extends FiltersMap> extends PageProps {
+    /**
+     * A collection state instance created with [useCollection](./?path=/story/common-hooks--usecollection)
+     * @external
+     */
+    state: CollectionState<T, F>;
+    children?: ReactNode;
+    /**
+     * Hide total items count
+     * @external
+     */
+    hideTotal?: boolean;
+}
+/**
+ * @deprecated Use [CollectionPage](./?path=%2Fstory%2Fbase-components-pages-collection-page--collectionpage) from
+ * `@wix/patterns/page`
+ */
+declare function CollectionPage<T, F extends FiltersMap = FiltersMap>({ children, state, hideTotal, ...rest }: CollectionPageProps<T, F>): React.JSX.Element;
+
+export { CollectionPage };
+export type { CollectionPageProps };

package/dist/dts-bundle/components/CollectionPremiumEmptyState.d.ts

@@ -0,0 +1,59 @@
+import React, { ReactNode, MouseEvent as MouseEvent$1 } from 'react';
+import { EmptyStateProps } from '@wix/design-system';
+
+interface EmptyStateBaseProps extends EmptyStateBasePrivateProps, Omit<Partial<EmptyStateProps>, 'title' | 'subtitle' | 'image'> {
+    /**
+     * Overrides the default title.
+     * @external
+     */
+    title: string;
+    /**
+     * Overrides the default subtitle.
+     * @external
+     */
+    subtitle: string;
+    /**
+     * Overrides the default image.
+     * Accepts a custom `ReactElement` or boolean value.
+     * Pass `false` to hide the default image.
+     * @external
+     */
+    image?: boolean | ReactNode;
+    children?: ReactNode;
+    cta?: ReactNode;
+    /**
+     * Adds another custom call to action button.
+     * Pass a [TextButton](https://www.docs.wixdesignsystem.com/?path=/story/components-actions--textbutton) component.
+     * @external
+     */
+    customCta?: ReactNode;
+}
+interface EmptyStateBasePrivateProps {
+    title: string;
+    subtitle: string;
+    cta?: ReactNode;
+    image?: string | ReactNode;
+}
+
+interface PremiumButtonProps {
+    onClick: (e: MouseEvent$1<HTMLButtonElement, MouseEvent>) => void;
+    text?: string;
+}
+
+interface CollectionPremiumEmptyStateProps extends Omit<Partial<EmptyStateBaseProps>, 'cta'> {
+    /**
+     * Configures the default call to action button.\
+     * `onClick`: Adds a callback for when the button is clicked. <br>
+     * `text`: Text of the button.
+     *  To render the default upgrade button, you must provide the `onClick` callback.
+     * @external
+     */
+    upgradeCta: PremiumButtonProps;
+}
+declare function _CollectionPremiumEmptyState(props: CollectionPremiumEmptyStateProps): React.JSX.Element;
+declare const CollectionPremiumEmptyState: typeof _CollectionPremiumEmptyState & {
+    displayName: string;
+};
+
+export { CollectionPremiumEmptyState };
+export type { CollectionPremiumEmptyStateProps };

package/dist/dts-bundle/components/CollectionSearch.d.ts

@@ -0,0 +1,25 @@
+import { SearchProps } from '@wix/design-system';
+import React, { CSSProperties } from 'react';
+
+/**
+ * `Filter` — cut here because it has its own bundle.
+ * Look `Filter` up in the bundle index for its full shape.
+ */
+interface Filter<T> {
+}
+type FiltersMap = {
+    [key: string]: Filter<any> | undefined;
+};
+
+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;
+};
+
+export { CollectionSearch };
+export type { CollectionSearchProps };

package/dist/dts-bundle/components/CollectionToolbarFilters.d.ts

@@ -0,0 +1,56 @@
+import React, { ReactElement, JSXElementConstructor, ReactNode } from 'react';
+
+/**
+ * `FilterProps` — cut here because it has its own bundle.
+ * Look `FilterProps` up in the bundle index for its full shape.
+ */
+interface FilterProps<V> {
+}
+
+type FilterElement<V = any> = ReactElement<FilterProps<V>, JSXElementConstructor<FilterProps<V>>>;
+
+interface CollectionToolbarFiltersProps {
+    /**
+     * Number of filter controls to be rendered inside the table toolbar
+     */
+    inline?: 0 | 1 | 2 | 3;
+    /**
+     * A flag that indicates whether Patterns should use a new filters layout our not.
+     */
+    useNewFilters?: true;
+    maxInlineFilters?: number;
+    maxInlineLabels?: number;
+    /**
+     * Title of the filters panel
+     * @external
+     */
+    panelTitle?: string | ReactNode;
+    /**
+     * `React` children elements, that must accept [FilterProps](./?path=/story/features-filter-props--filterprops), such as:
+     * - [MultiSelectCheckboxFilter](./?path=/story/features-filter-components--multiselectcheckboxfilter)
+     * - [Custom Filters](./?path=/story/features-filter-factories--customfilter)
+     * @external
+     */
+    children: (FilterElement | undefined | boolean) | (FilterElement | undefined | boolean)[];
+    onPanelClearButtonClicked?: () => unknown;
+    onSearchAppliedFilterTagRemove?: (item: string) => unknown;
+    onSubToolbarClearButtonClicked?: () => unknown;
+    hideAppliedFiltersTagList?: boolean;
+}
+/**
+ * Filters that need the side panel rather than an inline slot — they are too
+ * tall or too interactive to sit in the toolbar. One of these among the inline
+ * filters forces the panel for all of them.
+ *
+ * Matched against `displayName`, so a component that wraps one of these has to
+ * declare its own name here; a wrapper with no `displayName` silently renders
+ * inline. See `ReferenceFieldFilter`.
+ */
+declare const SIDE_PANEL_FILTER_DISPLAY_NAMES: string[];
+declare function _CollectionToolbarFilters(props: CollectionToolbarFiltersProps): React.JSX.Element;
+declare const CollectionToolbarFilters: typeof _CollectionToolbarFilters & {
+    displayName: string;
+};
+
+export { CollectionToolbarFilters, SIDE_PANEL_FILTER_DISPLAY_NAMES };
+export type { CollectionToolbarFiltersProps };

package/dist/dts-bundle/components/DateRangeFilter.d.ts

@@ -0,0 +1,73 @@
+import * as React from 'react';
+import React__default from 'react';
+import { DatePickerProps } from '@wix/design-system';
+
+/**
+ * `Translate` — cut here because it has its own bundle.
+ * Look `Translate` up in the bundle index for its full shape.
+ */
+type Translate = unknown;
+
+/**
+ * `RangeItem` — cut here because it has its own bundle.
+ * Look `RangeItem` up in the bundle index for its full shape.
+ */
+interface RangeItem<T> {
+}
+
+type DateRangeFilterMode = 'ONLY_PREDEFINED' | 'ONLY_CUSTOM' | 'COMBINE';
+type DateRangePredefinedPresetOptions = 'SEVEN_DAYS' | 'FOURTEEN_DAYS' | 'MONTH' | 'TODAY' | 'TOMORROW' | 'NEXT_THREE_DAYS' | 'NEXT_SEVEN_DAYS' | 'NEXT_THIRTY_DAYS';
+type DateRangeOptions = DateRangePredefinedPresetOptions[];
+
+type FilterItem<T> = T extends (infer V)[] ? V : T;
+
+/**
+ * `FilterProps` — cut here because it has its own bundle.
+ * Look `FilterProps` up in the bundle index for its full shape.
+ */
+interface FilterProps<V> {
+}
+
+declare const renderPresetToolbarTag: (container: {
+    translate: Translate;
+    dateFormatters: {
+        medium: Intl.DateTimeFormat;
+        mediumTime: Intl.DateTimeFormat;
+    };
+}, params: {
+    filterProps: FilterProps<any>;
+}) => <V>(filter: FilterItem<V>) => {
+    children: React.FunctionComponentElement<{
+        filterProps: FilterProps<any>;
+    }>;
+};
+
+interface DateRangeFilterProps extends FilterProps<RangeItem<Date>>, Partial<DatePickerProps> {
+    /**
+     * There are 3 possible modes:
+     * - `ONLY_PREDEFINED`: show only predefined dates options
+     * - `ONLY_CUSTOM`: show only custom date pickers
+     * - `COMBINE`: default, combines both predefined and custom
+     * @external
+     */
+    mode?: DateRangeFilterMode;
+    /**
+     * An optional array of 3 possible options: `'SEVEN_DAYS', 'FOURTEEN_DAYS', 'MONTH'`.
+     * @default `['SEVEN_DAYS', 'FOURTEEN_DAYS', 'MONTH']`
+     * @external
+     */
+    dateRangeOptions?: DateRangeOptions;
+    /**
+     * If to include time resolution
+     * @external
+     */
+    filterByTime?: boolean;
+}
+declare function _DateRangeFilter(props: DateRangeFilterProps): React__default.JSX.Element;
+declare const DateRangeFilter: typeof _DateRangeFilter & {
+    displayName?: string;
+    renderPresetToolbarTag?: typeof renderPresetToolbarTag;
+};
+
+export { DateRangeFilter };
+export type { DateRangeFilterProps };

package/dist/dts-bundle/components/EntityPage.d.ts

@@ -0,0 +1,300 @@
+import * as React from 'react';
+import React__default, { ReactElement, ReactNode } from 'react';
+import { CardProps, IconElement, Breadcrumbs, BadgeProps, PageProps } from '@wix/design-system';
+import { FieldValues } from 'react-hook-form';
+import { cairoPageCtaClickedParams } from '@wix/bex-utils/@wix/bi-logger-os-data/v2/types';
+
+interface EntityPageSlotsProps {
+    /**
+     * An id of the container defined in the installed on a site application that contains TPA's actions.
+     */
+    containerId: string;
+    /**
+     * Applies a data-hook HTML attribute that can be used in tests.
+     */
+    dataHook?: string;
+    /**
+     * Props passed to Slots Widgets
+     */
+    [x: string]: any;
+}
+declare function _EntityPageSlots(props: EntityPageSlotsProps): React__default.JSX.Element;
+
+interface ErrorCardProps extends CardProps {
+    /**
+     * Title to display in the error state.
+     */
+    title?: string;
+    /**
+     * Subtitle to display in the error state.
+     */
+    subtitle?: string;
+    /**
+     * Action button to display in the error state.
+     */
+    action?: {
+        /**
+         * Action button text.
+         */
+        text: string;
+        /**
+         * Callback function to run when the action button is clicked.
+         */
+        onClick: () => void;
+        /**
+         * [Icon](https://www.docs.wixdesignsystem.com/?path=/story/foundations-icons--icons) to display on the action button before the text.
+         */
+        prefixIcon?: IconElement;
+    };
+}
+
+interface CardContainerProps extends CardProps {
+    /**
+     * Additional loading flag, if you need to show loader after the main entity is fetched.
+     * Also, if an error occurs on a side request (other than passed to `fetch`), you can use `error` to show the card error state.
+     * Alongside with `error` you also need to pass `errorState.onRetry` callback, which should change the `status` accordingly.
+     */
+    status?: 'idle' | 'loading' | 'error' | 'success';
+    /**
+     * Height of content while loading (not including paddings)
+     */
+    minHeight?: string;
+    /**
+     * Card Error State configuration
+     */
+    errorState?: ErrorCardProps;
+    /**
+     * Identifier of the card.
+     * If you want to open a page and auto-scroll and focus ont his card, pass in the the query params `anchor={yourCardId}`.
+     */
+    id?: string;
+}
+
+interface FormPageCardProps extends CardContainerProps {
+}
+
+interface EntityPageCardProps extends FormPageCardProps {
+}
+declare function _EntityPageCard(props: EntityPageCardProps): React__default.JSX.Element;
+declare namespace _EntityPageCard {
+    var displayName: string;
+}
+
+/**
+ * `WixPatternsContainer` — you receive this, you don't construct it.
+ * Produced by `useWixPatternsContainer()` (also `buildWixPatternsContainer()`, `useCustomFieldsViewWidget()`).
+ */
+declare class WixPatternsContainer {
+}
+
+/**
+ * `CollectionPageState` — you receive this, you don't construct it.
+ * Produced by `useCollectionPageState()` (also `useCollectionPageContext()`).
+ */
+declare class CollectionPageState {
+}
+
+type SaveCtaText = 'PUBLISH' | 'APPLY' | 'CONNECT' | 'ACTIVATE' | 'SAVE' | 'SUBMIT';
+interface ActionsBarConfig {
+    saveCta?: {
+        text?: SaveCtaText;
+        biAdditionalInfo?: cairoPageCtaClickedParams['additionalInfo'];
+    };
+    cancelCta?: {
+        biAdditionalInfo?: cairoPageCtaClickedParams['additionalInfo'];
+    };
+}
+
+/**
+ * `MoreActionsItem` — cut here because it has its own bundle.
+ * Look `MoreActionsItem` up in the bundle index for its full shape.
+ */
+interface MoreActionsItem {
+}
+
+interface ExploreAppsModalProps {
+    title: string;
+    subtitle: string;
+    tag: string;
+}
+
+interface MoreActionsProps {
+    /**
+     * Actions items that appear in the `MoreActions` popover menu. \
+     * Actions can be grouped by using an array of arrays. \
+     * Each sub-array represents a different group within the popover, \
+     * and a divider will be rendered after each sub-array to separate the groups.
+     * @overrideType [MoreActionsItem](./?path=/story/common-types--moreactionsitem)[] | [MoreActionsItem](./?path=/story/common-types--moreactionsitem)[][]
+     * @external
+     */
+    items?: MoreActionsPropItem[] | MoreActionsPropItem[][];
+    /**
+     * An id of the container defined in the installed on a site application that contains TPA's actions.
+     */
+    containerId?: string;
+    /**
+     * Additional properties passed to the `onClick` of the container's extensions menu items.
+     */
+    containerProps?: Record<string, any>;
+    /**
+     * Additional info for cairoPageCtaClicked BI event.
+     */
+    biAdditionalInfo?: string;
+    dataHook?: string;
+    exploreAppsModalProps?: ExploreAppsModalProps;
+}
+
+type MoreActionItemFactory = (params: {
+    pageState: CollectionPageState;
+    container: WixPatternsContainer;
+}) => MoreActionsItem;
+type MoreActionsPropItem = MoreActionsItem | MoreActionItemFactory;
+
+interface MoreActionsIconProps extends MoreActionsProps {
+}
+declare function _MoreActionsIcon(params: MoreActionsIconProps): React__default.JSX.Element;
+declare const MoreActionsIcon: typeof _MoreActionsIcon & {
+    displayName: string;
+};
+
+type MoreActionsElement = ReactElement<MoreActionsProps, typeof MoreActionsIcon>;
+
+/**
+ * Props for the PageSubTitle component.
+ * @property {string} text The subtitle text.
+ * @property {Object} [learnMore] An object with a `url` (required) for displaying a link button on the subtitle.
+ * @property {string} learnMore.url where the link should navigate to
+ * @property {string} [learnMore.label ="Learn more"] - the label of the link button. defaults to "Learn More"
+ */
+interface PageSubTitleProps {
+    text: string;
+    learnMore?: {
+        url: string;
+        label?: string;
+    };
+}
+
+interface FormPageHeaderProps {
+    /**
+     * <MoreActions />
+     */
+    moreActions?: MoreActionsElement;
+    /**
+     * Page breadcrumbs
+     */
+    breadcrumbs?: ReactElement<Breadcrumbs>;
+    /**
+     * Page title text and optional badges
+     */
+    title: {
+        text: string;
+        badges?: (Pick<BadgeProps, 'skin' | 'prefixIcon' | 'suffixIcon'> & {
+            text: string;
+        })[];
+    };
+    /**
+     * Page subtitle text
+     */
+    subtitle?: PageSubTitleProps;
+}
+
+interface FormPageMainContentProps {
+    /**
+     * Applies a data-hook HTML attribute that can be used in tests
+     */
+    dataHook?: string;
+    children?: ReactNode;
+}
+
+interface FormPageAdditionalContentProps {
+    /**
+     * Applies a data-hook HTML attribute that can be used in tests
+     */
+    dataHook?: string;
+    children?: ReactNode;
+    /**
+     * Makes the additional content sticky when scrolling
+     */
+    sticky?: boolean;
+}
+
+/**
+ * `EntityPageState` — you receive this, you don't construct it.
+ * Produced by `useEntityPage()` (also `useEntityPageContext()`).
+ */
+declare class EntityPageState<T, V> {
+}
+
+declare function useEntityPageHeader(child: EntityPageHeaderElement): React__default.JSX.Element;
+
+interface EntityPageContentProps {
+    /**
+     * <EntityPage.MainContent> and, if needed, <EntityPage.AdditionalContent> elements
+     */
+    children: ReactNode;
+}
+type EntityPageContentElement = ReactElement<EntityPageContentProps, typeof EntityPageContent>;
+declare function EntityPageContent(_props: EntityPageContentProps): null;
+declare namespace EntityPageContent {
+    var useEntityPageContent: typeof useEntityPageContent;
+    var displayName: string;
+}
+
+declare function useEntityPageContent(child: EntityPageContentElement, scrollableRef?: HTMLElement | null): React.JSX.Element;
+
+interface EntityPageHeaderProps extends FormPageHeaderProps {
+}
+type EntityPageHeaderElement = ReactElement<EntityPageHeaderProps, typeof EntityPageHeader>;
+declare function EntityPageHeader(_props: EntityPageHeaderProps): null;
+declare namespace EntityPageHeader {
+    var useEntityPageHeader: typeof useEntityPageHeader;
+    var displayName: string;
+}
+
+interface EntityPageMainContentProps extends FormPageMainContentProps {
+}
+declare function EntityPageMainContent(props: EntityPageMainContentProps): React__default.JSX.Element;
+declare namespace EntityPageMainContent {
+    var displayName: string;
+}
+
+interface EntityPageAdditionalContentProps extends FormPageAdditionalContentProps {
+}
+declare function EntityPageAdditionalContent(props: EntityPageAdditionalContentProps): React__default.JSX.Element;
+declare namespace EntityPageAdditionalContent {
+    var displayName: string;
+}
+
+interface EntityPageProps<T, V extends FieldValues = FieldValues> extends PageProps {
+    /**
+     * EntityPageState instance created with the `useEntityPage` hook
+     */
+    state: EntityPageState<T, V>;
+    /**
+     * Configuration for the actions bar
+     */
+    actionsBarConfig?: ActionsBarConfig;
+}
+declare function _EntityPage<T, V extends FieldValues = FieldValues>({ state, actionsBarConfig, ...rest }: EntityPageProps<T, V>): React__default.JSX.Element;
+declare namespace _EntityPage {
+    var Header: typeof EntityPageHeader;
+    var Content: typeof EntityPageContent;
+    var MainContent: typeof EntityPageMainContent;
+    var AdditionalContent: typeof EntityPageAdditionalContent;
+    var Card: typeof _EntityPageCard & {
+        displayName: string;
+    };
+    var Slots: typeof _EntityPageSlots & {
+        displayName: string;
+    };
+    var Extensions: typeof _EntityPageSlots & {
+        displayName: string;
+    };
+    var displayName: string;
+}
+declare const EntityPage: typeof _EntityPage & {
+    displayName: string;
+};
+
+export { EntityPage };
+export type { EntityPageProps };