@wix/patterns 1.457.0 → 1.459.0

package/dist/dts-bundle/exports/mobx.d.ts

@@ -0,0 +1,4 @@
+// No curated names for "./mobx" yet — this file exists so a missing
+// file always means the installed version predates this feature, never
+// "nothing curated here."
+export {};

package/dist/dts-bundle/exports/nextjs.d.ts

@@ -0,0 +1,4 @@
+// No curated names for "./nextjs" yet — this file exists so a missing
+// file always means the installed version predates this feature, never
+// "nothing curated here."
+export {};

package/dist/dts-bundle/exports/page.d.ts

@@ -0,0 +1,2 @@
+export { CollectionPage } from '../components/CollectionPage';
+export { WidgetsFormProvider } from '../components/WidgetsFormProvider';

package/dist/dts-bundle/exports/provider/internal.d.ts

@@ -0,0 +1,4 @@
+// No curated names for "./provider/internal" yet — this file exists so a missing
+// file always means the installed version predates this feature, never
+// "nothing curated here."
+export {};

package/dist/dts-bundle/exports/provider.d.ts

@@ -0,0 +1 @@
+export { WixPatternsProvider } from '../components/WixPatternsProvider';

package/dist/dts-bundle/exports/router.d.ts

@@ -0,0 +1,3 @@
+export { PatternsReactRoute } from '../components/PatternsReactRoute';
+export { PatternsReactRouter } from '../components/PatternsReactRouter';
+export { usePatternsNavigate } from '../hooks/usePatternsNavigate';

package/dist/dts-bundle/exports/schema.d.ts

@@ -0,0 +1,6 @@
+export { EntityPage } from '../components/EntityPage';
+export { Grid } from '../components/Grid';
+export { Table } from '../components/Table';
+export { useEntityPage } from '../hooks/useEntityPage';
+export { useGridCollection } from '../hooks/useGridCollection';
+export { useTableCollection } from '../hooks/useTableCollection';

package/dist/dts-bundle/exports/testkit/backend.d.ts

@@ -0,0 +1,4 @@
+// No curated names for "./testkit/backend" yet — this file exists so a missing
+// file always means the installed version predates this feature, never
+// "nothing curated here."
+export {};

package/dist/dts-bundle/exports/testkit/bi.d.ts

@@ -0,0 +1,4 @@
+// No curated names for "./testkit/bi" yet — this file exists so a missing
+// file always means the installed version predates this feature, never
+// "nothing curated here."
+export {};

package/dist/dts-bundle/exports/testkit/bm.d.ts

@@ -0,0 +1,4 @@
+// No curated names for "./testkit/bm" yet — this file exists so a missing
+// file always means the installed version predates this feature, never
+// "nothing curated here."
+export {};

package/dist/dts-bundle/exports/testkit/enzyme.d.ts

@@ -0,0 +1,4 @@
+// No curated names for "./testkit/enzyme" yet — this file exists so a missing
+// file always means the installed version predates this feature, never
+// "nothing curated here."
+export {};

package/dist/dts-bundle/exports/testkit/internal.d.ts

@@ -0,0 +1,4 @@
+// No curated names for "./testkit/internal" yet — this file exists so a missing
+// file always means the installed version predates this feature, never
+// "nothing curated here."
+export {};

package/dist/dts-bundle/exports/testkit/jsdom.d.ts

@@ -0,0 +1,4 @@
+// No curated names for "./testkit/jsdom" yet — this file exists so a missing
+// file always means the installed version predates this feature, never
+// "nothing curated here."
+export {};

package/dist/dts-bundle/exports/testkit/playwright.d.ts

@@ -0,0 +1,4 @@
+// No curated names for "./testkit/playwright" yet — this file exists so a missing
+// file always means the installed version predates this feature, never
+// "nothing curated here."
+export {};

package/dist/dts-bundle/exports/testkit/puppeteer.d.ts

@@ -0,0 +1,4 @@
+// No curated names for "./testkit/puppeteer" yet — this file exists so a missing
+// file always means the installed version predates this feature, never
+// "nothing curated here."
+export {};

package/dist/dts-bundle/exports/testkit/unidriver.d.ts

@@ -0,0 +1,4 @@
+// No curated names for "./testkit/unidriver" yet — this file exists so a missing
+// file always means the installed version predates this feature, never
+// "nothing curated here."
+export {};

package/dist/dts-bundle/exports/testkit.d.ts

@@ -0,0 +1,4 @@
+// No curated names for "./testkit" yet — this file exists so a missing
+// file always means the installed version predates this feature, never
+// "nothing curated here."
+export {};

package/dist/dts-bundle/exports/unidriver.d.ts

@@ -0,0 +1,4 @@
+// No curated names for "./unidriver" yet — this file exists so a missing
+// file always means the installed version predates this feature, never
+// "nothing curated here."
+export {};

package/dist/dts-bundle/exports/utils/react.d.ts

@@ -0,0 +1,4 @@
+// No curated names for "./utils/react" yet — this file exists so a missing
+// file always means the installed version predates this feature, never
+// "nothing curated here."
+export {};

package/dist/dts-bundle/exports/utils.d.ts

@@ -0,0 +1,4 @@
+// No curated names for "./utils" yet — this file exists so a missing
+// file always means the installed version predates this feature, never
+// "nothing curated here."
+export {};

package/dist/dts-bundle/exports/version.d.ts

@@ -0,0 +1,4 @@
+// No curated names for "./version" yet — this file exists so a missing
+// file always means the installed version predates this feature, never
+// "nothing curated here."
+export {};

package/dist/dts-bundle/functions/arrayFilter.d.ts

@@ -0,0 +1,83 @@
+type FilterItem<T> = T extends (infer V)[] ? V : T;
+interface FilterStateBaseParams<T> {
+    name?: string;
+    /**
+     * Marks the filter as a "context" or "scope" filter. This makes the filter not be visible in the sub-toolbar tag list, not saved in views, not counted as "X filters applied".
+     * @external
+     */
+    persistent?: boolean;
+    /**
+     * The value to initialize the filter with (Optional)
+     * @external
+     */
+    initialValue?: T;
+    /**
+     * A callback function that accepts an item and returns a unique ID of it. typically `item.id`.
+     * @external
+     */
+    itemKey: (item: FilterItem<T>) => string;
+    /**
+     * A callback function that accepts an item and returns the item name which is used in many messages through cairo
+     * @external
+     */
+    itemName: (item: FilterItem<T>) => string;
+    /**
+     * A function which accepts 2 items and returns true if they are equal
+     * @external
+     */
+    equals?: (item1: FilterItem<T>, item2: FilterItem<T>) => boolean;
+    /**
+     * If the filter is a custom field
+     */
+    isCustomField?: boolean;
+}
+
+interface ArrayFilterStateParams<T> extends FilterStateBaseParams<T[]> {
+    /**
+     * The value to set the value to, when clearing the filter (Optional)
+     * @external
+     */
+    defaultValue?: T[];
+    /**
+     * Convert a unknown object to a T.<br>
+     * If the function returns null, the item will be skipped when we try to deserializate it from an array.
+     * @param value
+     * @external
+     */
+    readonly parse: (value: Record<string, unknown> | string | null | undefined) => T | null;
+    /**
+     * Return a simplified form of an item for serialization.
+     * @param value
+     * @external
+     */
+    readonly simplify?: (value: T) => Partial<T>;
+    /**
+     * Indicates whether an item matches the current value of the filter
+     * @external
+     */
+    readonly matches?: (item: T, value: T[]) => boolean;
+    readonly equals?: (item1: T, item2: T) => boolean;
+}
+/**
+ * `ArrayFilterState` — you receive this, you don't construct it.
+ * Produced by `stringsArrayFilter()` (also `arrayFilter()`, `idNameArrayFilter()`, `idArrayFilter()`).
+ */
+declare class ArrayFilterState<T = any> {
+    [key: string]: unknown;
+}
+declare const stringsArrayFilter: <T extends string>(params?: Partial<ArrayFilterStateParams<T>>) => ArrayFilterState<T>;
+declare const arrayFilter: <T>(params: ArrayFilterStateParams<T>) => ArrayFilterState<T>;
+declare const idNameArrayFilter: <T extends {
+    id: string;
+    name: string;
+}>(params?: Partial<ArrayFilterStateParams<T>>) => ArrayFilterState<T>;
+declare const idArrayFilter: <T extends {
+    id: string;
+}>(params?: Partial<ArrayFilterStateParams<T>>) => ArrayFilterState<T>;
+declare const idNameArrayFilterNum: <T extends {
+    id: number;
+    name: string;
+}>(params?: Partial<ArrayFilterStateParams<T>>) => ArrayFilterState<T>;
+
+export { ArrayFilterState, arrayFilter, idArrayFilter, idNameArrayFilter, idNameArrayFilterNum, stringsArrayFilter };
+export type { ArrayFilterStateParams };

package/dist/dts-bundle/functions/customFilter.d.ts

@@ -0,0 +1,111 @@
+type FilterItem<T> = T extends (infer V)[] ? V : T;
+interface FilterStateBaseParams<T> {
+    name?: string;
+    /**
+     * Marks the filter as a "context" or "scope" filter. This makes the filter not be visible in the sub-toolbar tag list, not saved in views, not counted as "X filters applied".
+     * @external
+     */
+    persistent?: boolean;
+    /**
+     * The value to initialize the filter with (Optional)
+     * @external
+     */
+    initialValue?: T;
+    /**
+     * A callback function that accepts an item and returns a unique ID of it. typically `item.id`.
+     * @external
+     */
+    itemKey: (item: FilterItem<T>) => string;
+    /**
+     * A callback function that accepts an item and returns the item name which is used in many messages through cairo
+     * @external
+     */
+    itemName: (item: FilterItem<T>) => string;
+    /**
+     * A function which accepts 2 items and returns true if they are equal
+     * @external
+     */
+    equals?: (item1: FilterItem<T>, item2: FilterItem<T>) => boolean;
+    /**
+     * If the filter is a custom field
+     */
+    isCustomField?: boolean;
+}
+
+interface CustomFilterStateParams<T> extends FilterStateBaseParams<T> {
+    /**
+     * The value to set the value to, when clearing the filter.
+     * @external
+     */
+    defaultValue: T;
+    /**
+     * Indicates whether nothing is selected.<br>
+     * For example, when implementing a range filter, when both minimum and maximum inputs are empty
+     * @external
+     */
+    isEmpty: (value: T) => boolean;
+    /**
+     * Indicates the number of effective filters.<br>
+     * For example, when implementing a range filter, 1 when only minimum/maximum are entered, 2 - when both entered.
+     * @default A function that 0 when `isEmpty` returns true, and 1 otherwise.
+     * @external
+     */
+    size?: (value: T) => number;
+    /**
+     * Convert the filter value to a string, to be stored in a URL.
+     * @external
+     */
+    toQueryString?: (value: T) => string;
+    /**
+     * Convert the a string value to the filter value, to be retrieved from a URL.
+     * @external
+     */
+    fromQueryString?: (str: string) => T;
+    /**
+     * Convert a unknown object to a T.<br>
+     * If the function returns null, the item will be skipped when we try to deserializate it from an array.
+     * @param value
+     * @external
+     */
+    readonly decode: (value: unknown) => T;
+    /**
+     * Return a simplified form of an item for serialization.
+     * @param value
+     * @external
+     */
+    readonly encode: (value: T) => unknown;
+    /**
+     * Flatten the correct selection to an array, to be shown in the table sub-toolbar in a tag list.
+     * Usually this will return an array with a single item, but it gives control when we want to show more than a 1 tag in the tag list.
+     * @external
+     */
+    toArray: (value: T) => FilterItem<T>[];
+    /**
+     * Remove a tag from the tag list.
+     * @default A function that returns `defaultValue`.
+     * @external
+     */
+    remove?: (item: FilterItem<T>[], value: T) => T;
+    /**
+     * Indicates whether current filter value is different than `data`
+     * @external
+     */
+    hasDiff?: (data: T) => boolean;
+    /**
+     * Indicates whether an item matches the current value of the filter
+     * @external
+     */
+    matches?: (item: FilterItem<T>, value: T) => boolean;
+    equals?: (item1: FilterItem<T>, item2: FilterItem<T>) => boolean;
+}
+/**
+ * `CustomFilterState` — you receive this, you don't construct it.
+ * Produced by `customFilter()`.
+ */
+declare class CustomFilterState<T = any> {
+    [key: string]: unknown;
+}
+declare const customFilter: <T>(params: CustomFilterStateParams<T>) => CustomFilterState<T>;
+
+export { CustomFilterState, customFilter };
+export type { CustomFilterStateParams };

package/dist/dts-bundle/functions/dateRangeFilter.d.ts

@@ -0,0 +1,85 @@
+type FilterItem<T> = T extends (infer V)[] ? V : T;
+interface FilterStateBaseParams<T> {
+    name?: string;
+    /**
+     * Marks the filter as a "context" or "scope" filter. This makes the filter not be visible in the sub-toolbar tag list, not saved in views, not counted as "X filters applied".
+     * @external
+     */
+    persistent?: boolean;
+    /**
+     * The value to initialize the filter with (Optional)
+     * @external
+     */
+    initialValue?: T;
+    /**
+     * A callback function that accepts an item and returns a unique ID of it. typically `item.id`.
+     * @external
+     */
+    itemKey: (item: FilterItem<T>) => string;
+    /**
+     * A callback function that accepts an item and returns the item name which is used in many messages through cairo
+     * @external
+     */
+    itemName: (item: FilterItem<T>) => string;
+    /**
+     * A function which accepts 2 items and returns true if they are equal
+     * @external
+     */
+    equals?: (item1: FilterItem<T>, item2: FilterItem<T>) => boolean;
+    /**
+     * If the filter is a custom field
+     */
+    isCustomField?: boolean;
+}
+
+/**
+ * `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;
+}
+interface RangeFilterStateParams<T> extends FilterStateBaseParams<RangeItem<T>> {
+    /**
+     * Convert an unknown object to a T.
+     * @param value
+     * @external
+     */
+    readonly parse: (value: unknown) => T | null;
+    /**
+     * Return a simplified form of an item for serialization.
+     * @param value
+     * @external
+     */
+    readonly simplify?: (value: T) => Partial<T>;
+    /**
+     * Indicates whether an item matches the current value of the filter
+     * @external
+     */
+    readonly matches?: (item: RangeItem<T>, value: RangeItem<T>) => boolean;
+    /**
+     * Indicates whether a preset does not exist or is empty
+     * @external
+     */
+    readonly isEmptyPreset?: (preset?: string) => boolean;
+    /**
+     * Converts a preset string to a RangeItem
+     * @param preset
+     * @external
+     */
+    readonly parsePreset?: (preset?: string) => RangeItem<T>;
+}
+/**
+ * `RangeFilterState` — you receive this, you don't construct it.
+ * Produced by `rangeFilter()` (also `dateRangeFilter()`, `numberRangeFilter()`).
+ */
+declare class RangeFilterState<T = any> {
+    [key: string]: unknown;
+}
+declare const rangeFilter: <T>(params: RangeFilterStateParams<T>) => RangeFilterState<T>;
+declare const toString: (item: RangeItem<Date>) => string;
+declare const dateRangeFilter: (params?: Partial<RangeFilterStateParams<Date>>) => RangeFilterState<Date>;
+declare const numberRangeFilter: (params?: Partial<RangeFilterStateParams<number>>) => RangeFilterState<number>;
+
+export { RangeFilterState, dateRangeFilter, numberRangeFilter, rangeFilter, toString };
+export type { RangeFilterStateParams, RangeItem };

package/dist/dts-bundle/functions/deleteSecondaryAction.d.ts

@@ -0,0 +1,160 @@
+import React from 'react';
+import { MessageModalLayoutProps } from '@wix/design-system';
+
+type EventuallyUpdated = 'submit' | number | Promise<unknown>;
+
+interface OptimisticActionBasis {
+    /**
+     * Determines whether to display an undo toast before calling the server action.
+     * @default false
+     * @external
+     */
+    showUndoToast?: boolean;
+    /**
+     * Determines whether to display a toast after clicking on undo.
+     * @default false
+     * @external
+     */
+    showUndoSuccessToast?: boolean;
+    /**
+     * Callback function triggered when the user clicks on the undo button.
+     * @external
+     */
+    onUndo?: () => void;
+    /**
+     * Function to generate error toast to show in case the server fails to perform the action.
+     * @external
+     */
+    errorToast?: (err: unknown, params: {
+        retry: () => void;
+    }) => ToastConfig | string;
+    /**
+     * Callback function triggered when an error occurs.
+     * @external
+     */
+    onError?: (err: unknown) => void;
+    /**
+     * Callback function to retry the action.
+     * @deprecated Use the prop `errorToast={(err, {retry}) => { action:{onClick: () {retry();} }}}` instead.
+     */
+    onTryAgain?: () => void | Promise<void>;
+    /**
+     * Toast message or configuration to show on successful action.
+     * @external
+     */
+    successToast?: ToastConfig | string;
+    /**
+     * Indicates when the server is eventually updated.
+     * Possible values:
+     *   - submit: Server updates immediately after the submission promise resolves.
+     *   - number: Server updates after a specified timeout (in milliseconds).
+     *   - Promise: Server updates after a forwarded promise resolves.
+     * @default submit
+     * @external
+     */
+    updateServerAfter?: EventuallyUpdated;
+}
+interface DeleteManyParams<T, R> extends OptimisticActionBasis {
+    /**
+     * Function to submit the deletion operation.
+     * @param items - The items to delete.
+     */
+    submit: (items: T[]) => Promise<R>;
+}
+
+/**
+ * `CollectionOptimisticActions` — you receive this, you don't construct it.
+ * Produced by `useOptimisticActions()` (also `createNestedOptimisticActions()`, `useCreateNestedOptimisticActions()`, `useCreateOptimisticActions()`). Look `CollectionOptimisticActions` up in the bundle index for its own API.
+ */
+declare class CollectionOptimisticActions<T = any, F = any> {
+    [key: string]: unknown;
+}
+
+/**
+ * `CollectionState` — you receive this, you don't construct it.
+ * Produced by `useFilterCollection()` (also `useStaticListFilterCollection()`, `useCollection()`, `createCollection()`).
+ */
+declare class CollectionState<T = any, F = any> {
+    [key: string]: unknown;
+}
+
+type ToastType = 'STANDARD' | 'PREMIUM' | 'SUCCESS' | 'WARNING' | 'ERROR';
+type ToastTimeout = 'NONE' | 'NORMAL';
+type ToastPriority = 'LOW' | 'NORMAL' | 'HIGH';
+type ToastActionUiType = 'BUTTON' | 'LINK';
+type ToastAction = {
+    text: string;
+    onClick?: Function;
+    removeToastOnClick?: boolean;
+    uiType?: ToastActionUiType;
+    navigationTarget?: {
+        url: string;
+        openInNewTab?: boolean;
+    };
+};
+type ErrorToastDetails = {
+    requestId: string;
+};
+type ToastConfig = {
+    message: string;
+    biName?: string;
+    timeout?: ToastTimeout;
+    priority?: ToastPriority;
+    type?: ToastType;
+    onCloseClick?: () => unknown;
+    onToastSeen?: () => unknown;
+    action?: ToastAction;
+    details?: ErrorToastDetails;
+};
+
+/**
+ * `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;
+};
+
+interface KeyedItem<T> {
+    item: T;
+    key: string;
+    id: string;
+    pageIndex: number;
+    indexWithinPage: number;
+    index: number;
+}
+
+interface ActionCellAPI<T, F extends FiltersMap> {
+    openConfirmModal: (props?: Partial<MessageModalLayoutProps>) => void;
+    openConfirmDeleteModal: (props?: Partial<MessageModalLayoutProps>) => void;
+    collection: CollectionState<T, F>;
+    keyedItem: KeyedItem<T>;
+}
+
+interface DeleteSecondaryActionProps<T, F extends FiltersMap, R> extends DeleteManyParams<T, R> {
+    /**
+     * Actions for performing optimistic updates on the collection.
+     * These updates are applied immediately for better user experience
+     * while waiting for the server response.
+     * @external
+     */
+    optimisticActions: CollectionOptimisticActions<T, F>;
+    /**
+     * API for interacting with the action cell.
+     * This API provides methods for manipulating and accessing the action cell's state.
+     * @external
+     */
+    actionCellAPI: ActionCellAPI<T, F>;
+}
+declare function deleteSecondaryAction<T, F extends FiltersMap, R>(props: DeleteSecondaryActionProps<T, F, R>): {
+    dataHook: string;
+    text: string;
+    icon: React.JSX.Element;
+    onClick: () => void;
+};
+
+export { deleteSecondaryAction };
+export type { DeleteSecondaryActionProps };

package/dist/dts-bundle/functions/idNameArrayFilter.d.ts

@@ -0,0 +1,83 @@
+type FilterItem<T> = T extends (infer V)[] ? V : T;
+interface FilterStateBaseParams<T> {
+    name?: string;
+    /**
+     * Marks the filter as a "context" or "scope" filter. This makes the filter not be visible in the sub-toolbar tag list, not saved in views, not counted as "X filters applied".
+     * @external
+     */
+    persistent?: boolean;
+    /**
+     * The value to initialize the filter with (Optional)
+     * @external
+     */
+    initialValue?: T;
+    /**
+     * A callback function that accepts an item and returns a unique ID of it. typically `item.id`.
+     * @external
+     */
+    itemKey: (item: FilterItem<T>) => string;
+    /**
+     * A callback function that accepts an item and returns the item name which is used in many messages through cairo
+     * @external
+     */
+    itemName: (item: FilterItem<T>) => string;
+    /**
+     * A function which accepts 2 items and returns true if they are equal
+     * @external
+     */
+    equals?: (item1: FilterItem<T>, item2: FilterItem<T>) => boolean;
+    /**
+     * If the filter is a custom field
+     */
+    isCustomField?: boolean;
+}
+
+interface ArrayFilterStateParams<T> extends FilterStateBaseParams<T[]> {
+    /**
+     * The value to set the value to, when clearing the filter (Optional)
+     * @external
+     */
+    defaultValue?: T[];
+    /**
+     * Convert a unknown object to a T.<br>
+     * If the function returns null, the item will be skipped when we try to deserializate it from an array.
+     * @param value
+     * @external
+     */
+    readonly parse: (value: Record<string, unknown> | string | null | undefined) => T | null;
+    /**
+     * Return a simplified form of an item for serialization.
+     * @param value
+     * @external
+     */
+    readonly simplify?: (value: T) => Partial<T>;
+    /**
+     * Indicates whether an item matches the current value of the filter
+     * @external
+     */
+    readonly matches?: (item: T, value: T[]) => boolean;
+    readonly equals?: (item1: T, item2: T) => boolean;
+}
+/**
+ * `ArrayFilterState` — you receive this, you don't construct it.
+ * Produced by `stringsArrayFilter()` (also `arrayFilter()`, `idNameArrayFilter()`, `idArrayFilter()`).
+ */
+declare class ArrayFilterState<T = any> {
+    [key: string]: unknown;
+}
+declare const stringsArrayFilter: <T extends string>(params?: Partial<ArrayFilterStateParams<T>>) => ArrayFilterState<T>;
+declare const arrayFilter: <T>(params: ArrayFilterStateParams<T>) => ArrayFilterState<T>;
+declare const idNameArrayFilter: <T extends {
+    id: string;
+    name: string;
+}>(params?: Partial<ArrayFilterStateParams<T>>) => ArrayFilterState<T>;
+declare const idArrayFilter: <T extends {
+    id: string;
+}>(params?: Partial<ArrayFilterStateParams<T>>) => ArrayFilterState<T>;
+declare const idNameArrayFilterNum: <T extends {
+    id: number;
+    name: string;
+}>(params?: Partial<ArrayFilterStateParams<T>>) => ArrayFilterState<T>;
+
+export { ArrayFilterState, arrayFilter, idArrayFilter, idNameArrayFilter, idNameArrayFilterNum, stringsArrayFilter };
+export type { ArrayFilterStateParams };