@wix/patterns 1.457.0 → 1.459.0

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

@@ -0,0 +1,52 @@
+import React from 'react';
+import { DatePickerProps } from '@wix/design-system';
+
+/**
+ * `RangeItem` — cut here because it has its own bundle.
+ * Look `RangeItem` up in the bundle index for its full shape.
+ */
+interface RangeItem<T = any> {
+    [key: string]: unknown;
+}
+
+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[];
+
+/**
+ * `FilterProps` — cut here because it has its own bundle.
+ * Look `FilterProps` up in the bundle index for its full shape.
+ */
+interface FilterProps<V = any> {
+    [key: string]: unknown;
+}
+
+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;
+}
+/**
+ * Also carries `renderPresetToolbarTag` as a static — an optional escape hatch.
+ * Cairo passes it what it needs; look the name up only if you are overriding behaviour.
+ */
+declare function DateRangeFilter(props: DateRangeFilterProps): React.JSX.Element;
+
+export { DateRangeFilter };
+export type { DateRangeFilterProps };

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

@@ -0,0 +1,304 @@
+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 {
+    [key: string]: unknown;
+}
+
+/**
+ * `CollectionPageState` — you receive this, you don't construct it.
+ * Produced by `useCollectionPageState()` (also `useCollectionPageContext()`).
+ */
+declare class CollectionPageState {
+    [key: string]: unknown;
+}
+
+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 {
+    [key: string]: unknown;
+}
+
+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 = any, V = any> {
+    [key: string]: unknown;
+}
+
+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 };

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

@@ -0,0 +1,155 @@
+import React, { ReactElement } from 'react';
+import { ExportQueryV2, ApplicationError, CreateExportAsyncJobRequest, ArrayFieldDelimiter, QueryFieldNumber, MethodSpec } from '@wix/bex-utils/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/types';
+import { CustomModalLayoutProps } from '@wix/design-system';
+
+interface ExportPublicState<T, F extends FiltersMap> {
+    platformizedQuery: ExportQueryV2;
+    wixPatternsQuery: ComputedQueryFull<F>;
+    selectedItems?: string[];
+    isSelectAll: boolean;
+    uncheckedValues?: T[];
+}
+type CustomTotalFn<T, F extends FiltersMap> = (params: ExportPublicState<T, F> & {
+    collectionTotalPromise: number | null | Promise<number | null | undefined>;
+}) => number | null | undefined | Promise<number | null | undefined>;
+type TransformQuery<T, F extends FiltersMap> = (params: ExportPublicState<T, F>) => ExportQueryV2 | Promise<ExportQueryV2>;
+type SaveAsFn<T, F extends FiltersMap> = (params: ExportPublicState<T, F>) => string;
+/**
+ * `ExportState` — you receive this, you don't construct it.
+ * Produced by `useCreateExport()`.
+ */
+declare class ExportState<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 FiltersKey<F extends FiltersMap> = Partial<{
+    [P in keyof F]: string[] | undefined | null;
+}>;
+/**
+ * `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 ComputedQueryFull<F extends FiltersMap = OptionalFiltersMap> extends ComputedQuery<F> {
+    filtersKey: FiltersKey<F>;
+    nonPersistentFiltersKey: FiltersKey<F>;
+}
+
+type RenderModalError = (data: ApplicationError['data']) => undefined | Partial<CustomModalLayoutProps & {
+    children?: ReactElement;
+}>;
+
+interface GetExportModalStepProps<T, F extends FiltersMap> {
+    state: ExportState<T, F>;
+    renderError?: RenderModalError;
+    exportModalFooter?: {
+        text: string;
+    };
+    exportModalTitle?: string;
+    onProgressModalTitle?: string;
+    exportToCSVMessage?: string;
+}
+
+type ExportButtonToolbarType = 'default' | 'bulkActionToolbar';
+interface ExportButtonParams<T, F extends FiltersMap> {
+    renderError?: GetExportModalStepProps<T, F>['renderError'];
+    /**
+     *  A function to transform the cairo query to a QueryV2 object (which will be used to fetch data from the server):
+     * - `platformizedQuery`: QueryV2
+     * - `wixPatternsQuery`: ComputedQueryFull<F>
+     * - `selectedItems?`: string[]
+     * - `uncheckedValues?`: T[]
+     * - `isSelectAll`: boolean
+     * The function should return a QueryV2 instance or a promise of QueryV2
+     */
+    transformPlatformizedQuery?: TransformQuery<T, F>;
+    /**
+     * When set to `true`, the export progress will not show total / out of items.
+     */
+    differentQueryEndpointThanCollection?: boolean;
+    /**
+     * A function that returns the number of total items in the export, to show in the progress bar. Use this option when the export has a different total than the collection itself. For example: table is showing products, but the export includes also variants.
+     * The function accepts the same arguments as `transformPlatformizedQuery`, with the following modifications:
+     * - `platformizedQuery` is already the transformed QueryV2 returned from `transformPlatformizedQuery`
+     * - `collectionTotalPromise` - A promise that resolves to the `total` of the underlying table collection.
+     */
+    customTotal?: CustomTotalFn<T, F>;
+    /**
+     * The target endpoint to query data from. This endpoint must be verified to be compatible with export-service first, see [server side docs](https://dev.wix.com/docs/rest/business-management/export/export-async-job-v1/integration)
+     * - `artifact: string`
+     * - `service: string`
+     * - `method: string`
+     */
+    methodMetadata: CreateExportAsyncJobRequest['methodMetadata'];
+    /**
+     * The delimiter to use for array fields
+     * @default SEMICOLON
+     */
+    arrayFieldDelimiter?: keyof typeof ArrayFieldDelimiter;
+    /**
+     * Additional endpoint possible variations
+     * `requestQueryFieldNumber?: number` - The field number of the request query field. The default is field number = 1
+     * `responseRepeatedFieldName: string | null` - The name of the response repeated field, i.e items/contacts/products etc. (required)
+     * `responsePagingMetadataFieldName?: string | null` - The name of the response PagingMetadata field (default=paging_metadata)
+     */
+    methodSpec?: {
+        requestQueryFieldNumber?: keyof typeof QueryFieldNumber;
+        responsePagingMetadataFieldName?: MethodSpec['responsePagingMetadataFieldName'];
+        responseRepeatedFieldName?: MethodSpec['responseRepeatedFieldName'];
+    };
+    /**
+     * Translated CSV headers
+     * - `id?`: string; The path to the field out of the query response items. You can ask your BED team to create a list of available paths by running this [Scala script](https://bo.wix.com/wix-docs/rest/drafts/exportservice/integration#drafts_exportservice_integration_fields).
+     * - `header?`: string; How to present the filed in the CSV headers (translated).
+     */
+    fields: CreateExportAsyncJobRequest['fields'];
+    /**
+     *  Optional function to configure the download file name:
+     * - `platformizedQuery`: QueryV2
+     * - `wixPatternsQuery`: ComputedQueryFull<F>
+     * - `selectedItems?`: string[]
+     * - `uncheckedValues?`: T[]
+     * The function should return a string
+     */
+    saveAs?: SaveAsFn<T, F>;
+    /**
+     * Optional footer for export modal
+     * `text`: string
+     */
+    exportModalFooter?: GetExportModalStepProps<T, F>['exportModalFooter'];
+    /**
+     * Optional custom title for the items to export
+     */
+    exportModalTitle?: GetExportModalStepProps<T, F>['exportModalTitle'];
+    /**
+     * Optional custom title during the export process
+     */
+    onProgressModalTitle?: GetExportModalStepProps<T, F>['onProgressModalTitle'];
+    /**
+     * Optional custom message for the items that will be exported to CSV
+     */
+    exportToCSVMessage?: GetExportModalStepProps<T, F>['exportToCSVMessage'];
+}
+type ExportButtonProps<T, F extends FiltersMap> = ExportButtonParams<T, F> & {
+    toolbarType?: ExportButtonToolbarType;
+};
+
+declare function ExportButton<T, F extends FiltersMap>(props: ExportButtonProps<T, F>): React.JSX.Element;
+
+export { ExportButton };