@wix/patterns 1.457.0 → 1.459.0

package/dist/dts-bundle/types/FieldValues.d.ts

@@ -0,0 +1,33 @@
+import { IsFlatObject, Noop } from './utils';
+import { RegisterOptions } from './validator';
+
+type InternalFieldName = string;
+type FieldName<TFieldValues extends FieldValues> = IsFlatObject<TFieldValues> extends true ? Extract<keyof TFieldValues, string> : string;
+type CustomElement<TFieldValues extends FieldValues> = Partial<HTMLElement> & {
+    name: FieldName<TFieldValues>;
+    type?: string;
+    value?: any;
+    disabled?: boolean;
+    checked?: boolean;
+    options?: HTMLOptionsCollection;
+    files?: FileList | null;
+    focus?: Noop;
+};
+type FieldValue<TFieldValues extends FieldValues> = TFieldValues[InternalFieldName];
+type FieldValues = Record<string, any>;
+type NativeFieldValue = string | number | boolean | null | undefined | unknown[];
+type FieldElement<TFieldValues extends FieldValues = FieldValues> = HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement | CustomElement<TFieldValues>;
+type Ref = FieldElement;
+type Field = {
+    _f: {
+        ref: Ref;
+        name: InternalFieldName;
+        refs?: HTMLInputElement[];
+        mount?: boolean;
+    } & RegisterOptions;
+};
+type FieldRefs = Partial<{
+    [key: InternalFieldName]: Field | FieldRefs;
+}>;
+
+export type { CustomElement, Field, FieldElement, FieldName, FieldRefs, FieldValue, FieldValues, InternalFieldName, NativeFieldValue, Ref };

package/dist/dts-bundle/types/Filter.d.ts

@@ -0,0 +1,103 @@
+import { EventEmitter } from 'events';
+
+type Arguments<T> = [T] extends [(...args: infer U) => any] ? U : [T] extends [void] ? [] : [T];
+interface TypedEventEmitter<Events> {
+    addListener<E extends keyof Events>(event: E, listener: Events[E]): this;
+    on<E extends keyof Events>(event: E, listener: Events[E]): this;
+    once<E extends keyof Events>(event: E, listener: Events[E]): this;
+    off<E extends keyof Events>(event: E, listener: Events[E]): this;
+    removeAllListeners<E extends keyof Events>(event?: E): this;
+    removeListener<E extends keyof Events>(event: E, listener: Events[E]): this;
+    emit<E extends keyof Events>(event: E, ...args: Arguments<Events[E]>): boolean;
+    listeners<E extends keyof Events>(event: E): Events[E][];
+}
+type TypedEmitter<Events> = Omit<EventEmitter, keyof TypedEventEmitter<Events>> & TypedEventEmitter<Events>;
+
+type FilterEvent = 'change' | 'refresh' | 'scheduleRefresh' | 'beforeRefresh';
+interface ChangeValueOptions {
+    emitEvents?: FilterEvent[];
+    clearResult?: boolean;
+    actionType?: 'add' | 'remove';
+    clickedValueKey?: string;
+}
+type FilterItem<T> = T extends (infer V)[] ? V : T;
+interface FilterEventOptions {
+    clearResult?: boolean;
+    actionType?: 'add' | 'remove';
+    clickedValueKey?: string;
+}
+interface FilterEventsSchema {
+    refresh: (opt: FilterEventOptions | undefined) => unknown;
+    beforeRefresh: (opt: FilterEventOptions | undefined) => unknown;
+    change: (opt?: FilterEventOptions) => unknown;
+    scheduleRefresh: (opt?: FilterEventOptions) => unknown;
+}
+type FilterEvents = TypedEmitter<FilterEventsSchema>;
+interface Filter<T> {
+    events: TypedEmitter<FilterEventsSchema>;
+    name: string;
+    persistent?: boolean;
+    readonly value: T;
+    readonly toArray: FilterItem<T>[];
+    readonly _toArray: (value: T) => FilterItem<T>[];
+    readonly isEmpty: boolean;
+    readonly toQueryString: string;
+    readonly decode: (value: unknown) => T;
+    readonly encode: (value: T) => unknown;
+    readonly size: number;
+    readonly itemKey: (item: FilterItem<T>) => string;
+    readonly itemName: (item: FilterItem<T>) => string;
+    readonly matches: (item: FilterItem<T>, value: T) => boolean;
+    readonly equals?: (item1: FilterItem<T>, item2: FilterItem<T>) => boolean;
+    readonly isCustomField?: boolean;
+    applyFromQueryString(str: string): void;
+    setValue(value: T, options?: ChangeValueOptions): void;
+    changeValue(value: T, options?: ChangeValueOptions): void;
+    refresh(value: T, options?: ChangeValueOptions): void;
+    scheduleRefresh(value: T): void;
+    reset(options?: ChangeValueOptions): void;
+    remove(items: FilterItem<T>[], options?: ChangeValueOptions): void;
+    clone(...args: any[]): Filter<T>;
+    hasDiff(items: T): boolean;
+    _hideFromToolbar?: boolean;
+}
+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;
+}
+type FiltersMap = {
+    [key: string]: Filter<any> | undefined;
+};
+type OptionalFiltersMap = {
+    [key: string]: undefined;
+};
+
+export type { ChangeValueOptions, Filter, FilterEventOptions, FilterEvents, FilterItem, FilterStateBaseParams, FiltersMap, OptionalFiltersMap };

package/dist/dts-bundle/types/FilterProps.d.ts

@@ -0,0 +1,97 @@
+import { ReactNode } from 'react';
+import { AccordionProps, PopoverCommonProps, TagListProps } from '@wix/design-system';
+
+type FilterItem<T> = T extends (infer V)[] ? V : T;
+/**
+ * `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;
+}
+
+/**
+ * Canonical field type keys (UPPER_SNAKE_CASE).
+ * The map is keyed by these values; incoming camelCase strings
+ * are normalised before lookup.
+ */
+type FieldType = 'SHORT_TEXT' | 'LONG_TEXT' | 'NUMBER' | 'BOOLEAN' | 'DATE' | 'DATE_TIME' | 'DATETIME' | 'TIME' | 'URL' | 'EMAIL' | 'IMAGE' | 'MEDIA_GALLERY' | 'AUDIO' | 'DOCUMENT' | 'MULTI_DOCUMENT' | 'RICH_TEXT' | 'RICH_CONTENT' | 'REFERENCE' | 'MULTI_REFERENCE' | 'OBJECT' | 'ARRAY' | 'ADDRESS' | 'COLOR' | 'INTEGER' | 'DECIMAL' | 'CHECKBOX' | 'DROPDOWN' | 'FILES' | 'MULTI_SELECT';
+
+interface FilterProps<V> {
+    /**
+     * A filter state object such as [ArrayFilter](./?path=/story/features-filter-factories--arrayfilter)
+     * @external
+     */
+    filter: Filter<V>;
+    /**
+     * The field type string used to resolve a prefix icon for the filter.
+     * Cairo maps this to the appropriate icon internally.
+     * @external
+     */
+    fieldType?: FieldType;
+    /**
+     * Padding settings. If this prop it omitted, padding will exist on the sides of the filter.<br> <br>
+     * Supported values: <br>
+     * - `"button"`: Removes padding from the sides of the filter.
+     * @external
+     */
+    layout?: 'button';
+    /**
+     * Customizes the filter in the toolbar.<br> <br>
+     * Supported properties: <br>
+     * - `label`: [string] Prefix for the filter element.
+     * @external
+     */
+    toolbarItemProps?: {
+        label?: ReactNode;
+    };
+    /**
+     * Customizes the filter tag in the toolbar.<br> <br>
+     * Supported properties: <br>
+     * - `label`: [string] Overrides the default filter name when filtered tag is shown.
+     * @external
+     */
+    toolbarTagProps?: {
+        label?: string;
+    };
+    /**
+     * Indicates whether the filter should be visible by default in the filters panel
+     * @external
+     */
+    initiallyOpen?: boolean;
+    /**
+     * Customizes the filter [accordion](https://www.docs.wixdesignsystem.com/?path=/story/components-lists--accordion).<br> <br>
+     * Supported properties: <br>
+     * - `label`: [string] Accordion item title. You can also use `AccordionProps['items'][number].title` for more flexibility. <br>
+     * - Extends [AccordionProps['items'[number]](https://www.docs.wixdesignsystem.com/?path=/story/components-lists--accordion).
+     * @external
+     */
+    accordionItemProps?: Required<AccordionProps>['items'][number] & {
+        label?: string;
+    };
+    /**
+     * @deprecated
+     */
+    popoverProps?: PopoverCommonProps;
+    /**
+     * Callback that's run when a filter is removed by a visitor from the sub-toolbar.
+     * @param item
+     * @external
+     */
+    onAppliedFilterTagRemove?: (item: FilterItem<V>) => unknown;
+    /**
+     * Customizes how the tag list in the sub-toolbar is rendered.
+     * <br><br>
+     * Extends [`TagListProps['tags'][number]`](https://www.docs.wixdesignsystem.com/?path=/story/components-lists-table--taglist).
+     * @external
+     */
+    renderToolbarTag?: (item: FilterItem<V>) => Partial<TagListProps['tags'][number]>;
+    explodeTags?: boolean;
+    /**
+     * Title for the section in the accordion.
+     * @external
+     */
+    sectionTitle?: string;
+}
+
+export type { FilterProps };

package/dist/dts-bundle/types/GridFoldersState.d.ts

@@ -0,0 +1,165 @@
+/**
+ * `TaskState` — you receive this, you don't construct it.
+ * An internal state object — reached through another state object, never built directly.
+ */
+declare class TaskState<T = 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;
+}
+
+/**
+ * `WixPatternsContainer` — you receive this, you don't construct it.
+ * Produced by `useWixPatternsContainer()` (also `buildWixPatternsContainer()`, `useCustomFieldsViewWidget()`).
+ */
+declare class WixPatternsContainer {
+    [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 QueryStatusValue = 'idle' | 'loading' | 'error' | 'success';
+interface QueryStatusBase {
+    status: QueryStatusValue;
+}
+interface QueryStatusError extends QueryStatusBase {
+    isError: true;
+    isIdle: false;
+    isLoading: false;
+    isSuccess: false;
+    status: 'error';
+}
+
+interface DataResultKeyed<T> {
+    items: T[];
+    total?: number | null;
+    available: number | null;
+    cursor: string | null;
+    hasNext?: boolean | null;
+}
+
+interface QueryResultStatusBase<T, E> {
+    data?: T;
+    error?: E | null;
+    isFetching?: boolean;
+}
+interface QueryResultStatusError<T, E> extends QueryResultStatusBase<T, E>, QueryStatusError {
+    error: E;
+}
+
+type ToolbarFeatureInitializer = (state: ToolbarCollectionState<any, any>) => {
+    init: () => void | (() => void);
+    initTask: TaskState<unknown> | null;
+};
+
+type PartialAllFilters<F1 extends FiltersMap, F2 extends FiltersMap> = Partial<F1 & F2>;
+interface FoldersAndItemsCollectionsStateInitParams extends ToolbarCollectionStateParamsInitParams {
+}
+/**
+ * `FoldersAndItemsCollectionsState` — you receive this, you don't construct it.
+ * An internal state object — reached through another state object, never built directly.
+ */
+declare class FoldersAndItemsCollectionsState<T1 = any, F1 = any, T2 = any, F2 = any> {
+    [key: string]: unknown;
+}
+
+interface ICollectionComponentState {
+    toolbar: ToolbarCollectionState<any, any>;
+}
+
+type Preset = 'full' | 'footer' | 'title' | 'empty';
+
+type FooterHeights = Record<Preset, Record<'draggable' | 'none', Record<'small' | 'medium', number>>>;
+interface GridSizePreset {
+    footerHeights: FooterHeights;
+    aspectRatio: number;
+    imagePlacement: 'side' | 'top';
+}
+
+interface ToolbarCollectionStateParamsInitParams {
+    featuresInitializers: (ToolbarFeatureInitializer | undefined)[];
+    hasMultiLevelSorting?: boolean;
+    skipFilterListeners?: boolean;
+}
+/**
+ * `ToolbarCollectionState` — you receive this, you don't construct it.
+ * Produced by `useToolbarCollectionContext()` (also `useTableCollectionSyncProps()`, `useKanbanCollectionSyncProps()`, `useToolbarCollectionSyncProps()`).
+ */
+declare class ToolbarCollectionState<T = any, F = any> {
+    [key: string]: unknown;
+}
+
+/**
+ * `GridBaseState` — you receive this, you don't construct it.
+ * An internal state object — reached through another state object, never built directly.
+ */
+declare class GridBaseState<T = any, F = any> {
+    [key: string]: unknown;
+}
+
+/**
+ * `GridFoldersBIReporter` — you receive this, you don't construct it.
+ * An internal state object — reached through another state object, never built directly.
+ */
+declare class GridFoldersBIReporter<T1 = any, F1 = any, T2 = any, F2 = any> {
+    [key: string]: unknown;
+}
+
+interface GridFoldersStateParams<T1, F1 extends FiltersMap, T2, F2 extends FiltersMap> {
+    readonly items: CollectionState<T1, F1>;
+    readonly folders: CollectionState<T2, F2>;
+    readonly container: WixPatternsContainer;
+    readonly toolbar?: ToolbarCollectionState<T1, PartialAllFilters<F1, F2>>;
+    readonly collections?: FoldersAndItemsCollectionsState<T1, F1, T2, F2>;
+}
+interface GridFoldersStateInitParams extends FoldersAndItemsCollectionsStateInitParams {
+}
+declare class GridFoldersState<T1, F1 extends FiltersMap, T2, F2 extends FiltersMap> implements ICollectionComponentState {
+    readonly container: WixPatternsContainer;
+    readonly toolbar: ToolbarCollectionState<T1, Partial<F1 & F2>>;
+    readonly items: GridBaseState<any, any>;
+    readonly folders: GridBaseState<any, any>;
+    readonly collections: FoldersAndItemsCollectionsState<T1, F1, T2, F2>;
+    readonly bi: GridFoldersBIReporter<T1, F1, T2, F2>;
+    readonly _subGrids: GridBaseState<any, any>[];
+    readonly _sizePreset: undefined | GridSizePreset;
+    showAllFolders: boolean;
+    constructor(params: GridFoldersStateParams<T1, F1, T2, F2>);
+    toggleShowAllFolders: () => void;
+    get foldersLocalLimit(): number;
+    get effectiveFoldersLocalLimit(): number | null;
+    get showToggleShowAllLessButton(): boolean;
+    get showFoldersSectionHeader(): boolean;
+    get showItemsSection(): boolean;
+    get initTask(): TaskState<unknown>;
+    get showErrorState(): boolean;
+    get errorStatus(): QueryResultStatusError<DataResultKeyed<unknown>, Partial<F1 & F2>> | undefined;
+    retryErrorState: () => void;
+    get showLoadingState(): boolean;
+    get showEmptyState(): boolean;
+    get hasAvailableItems(): boolean;
+    get resultOriginQuerySearch(): string | undefined;
+    get hasNonPersistentActiveFilters(): boolean;
+    get showItemsSectionHeader(): boolean;
+    get showFoldersSection(): boolean;
+    get showLoadingSection(): boolean;
+    init(params: GridFoldersStateInitParams): () => void;
+}
+
+export { GridFoldersState };
+export type { GridFoldersStateParams };

package/dist/dts-bundle/types/GridState.d.ts

@@ -0,0 +1,121 @@
+/**
+ * `TaskState` — you receive this, you don't construct it.
+ * An internal state object — reached through another state object, never built directly.
+ */
+declare class TaskState<T = 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;
+}
+
+/**
+ * `WixPatternsContainer` — you receive this, you don't construct it.
+ * Produced by `useWixPatternsContainer()` (also `buildWixPatternsContainer()`, `useCustomFieldsViewWidget()`).
+ */
+declare class WixPatternsContainer {
+    [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 ToolbarFeatureInitializer = (state: ToolbarCollectionState<any, any>) => {
+    init: () => void | (() => void);
+    initTask: TaskState<unknown> | null;
+};
+
+type Preset = 'full' | 'footer' | 'title' | 'empty';
+
+type FooterHeights = Record<Preset, Record<'draggable' | 'none', Record<'small' | 'medium', number>>>;
+interface GridSizePreset {
+    footerHeights: FooterHeights;
+    aspectRatio: number;
+    imagePlacement: 'side' | 'top';
+}
+
+/**
+ * `GridBaseState` — you receive this, you don't construct it.
+ * An internal state object — reached through another state object, never built directly.
+ */
+declare class GridBaseState<T = any, F = any> {
+    [key: string]: unknown;
+}
+
+interface ICollectionComponentState {
+    toolbar: ToolbarCollectionState<any, any>;
+}
+
+interface ToolbarCollectionStateParamsInitParams {
+    featuresInitializers: (ToolbarFeatureInitializer | undefined)[];
+    hasMultiLevelSorting?: boolean;
+    skipFilterListeners?: boolean;
+}
+/**
+ * `ToolbarCollectionState` — you receive this, you don't construct it.
+ * Produced by `useToolbarCollectionContext()` (also `useTableCollectionSyncProps()`, `useKanbanCollectionSyncProps()`, `useToolbarCollectionSyncProps()`).
+ */
+declare class ToolbarCollectionState<T = any, F = any> {
+    [key: string]: unknown;
+}
+
+/**
+ * `GridSectionsState` — you receive this, you don't construct it.
+ * An internal state object — reached through another state object, never built directly.
+ */
+declare class GridSectionsState<T = any, F = any> {
+    [key: string]: unknown;
+}
+
+interface GridStateParams<T, F extends FiltersMap> {
+    readonly collection: CollectionState<T, F>;
+    readonly container: WixPatternsContainer;
+    readonly toolbar?: ToolbarCollectionState<T, F>;
+}
+interface GridStateInitParams extends ToolbarCollectionStateParamsInitParams {
+}
+interface GridStatePublicAPI<T, F extends FiltersMap> {
+    /**
+     * Underlying [CollectionState](./?path=/story/common-state--collectionstate) instance
+     * @external
+     */
+    readonly collection: CollectionState<T, F>;
+    /**
+     * Underlying [ToolbarCollectionState](./?path=/story/common-state--toolbarcollectionstate) instance
+     * @external
+     */
+    readonly toolbar: ToolbarCollectionState<T, F>;
+    /**
+     * Reset active filters & sorting and adds new items to the collection.
+     * @param items - new items to add to the collection
+     * @external
+     */
+    onAddItemActionComplete(items: T[]): void;
+}
+declare class GridState<T, F extends FiltersMap> implements GridStatePublicAPI<T, F>, ICollectionComponentState {
+    readonly toolbar: ToolbarCollectionState<T, F>;
+    readonly container: WixPatternsContainer;
+    readonly collection: CollectionState<T, F>;
+    readonly _subGrids: GridBaseState<T, F>[];
+    _sizePreset: GridSizePreset | undefined;
+    _sections?: GridSectionsState<T, F>;
+    constructor(params: GridStateParams<T, F>);
+    init(params: GridStateInitParams): () => void;
+    onAddItemActionComplete: (items: T[]) => Promise<void>;
+}
+
+export { GridState };
+export type { GridStateInitParams, GridStateParams, GridStatePublicAPI };

package/dist/dts-bundle/types/MoreActionsItem.d.ts

@@ -0,0 +1,55 @@
+import { PopoverMenuItemProps } from '@wix/design-system';
+import React from 'react';
+
+interface MoreActionsItem extends Omit<PopoverMenuItemProps, 'text' | 'prefixIcon' | 'onClick'> {
+    /**
+     * The text label of the action item. This property is required.
+     * @external
+     */
+    text: string;
+    /**
+     * The functionality for when the user clicks the action item. This property is required.
+     * @external
+     */
+    onClick: (params?: Record<string, any>) => unknown;
+    /**
+     * An icon to display before the text.
+     * @external
+     */
+    prefixIcon?: React.ReactNode;
+    /**
+     * An icon displayed after the text.
+     * @external
+     */
+    suffixIcon?: React.ReactNode;
+    /**
+     * The visual style of the action item. Options are 'dark' for the standard appearance or 'destructive' for a red text and red hover effect.
+     * @external
+     */
+    skin?: 'dark' | 'destructive';
+    /**
+     * A data hook for testing purposes. This optional property can be used to identify the element in tests.
+     * @external
+     */
+    dataHook?: string;
+    /**
+     * This property can be used to disable the action item both visually and functionally.
+     * @external
+     */
+    disabled?: boolean;
+    /**
+     * A subtitle displayed under the text.
+     * @external
+     */
+    subtitle?: string;
+    /**
+     * The name of the CTA for BI event.
+     */
+    biName?: string;
+    /**
+     * Additional info for CTAClick BI event.
+     */
+    biAdditionalInfo?: string;
+}
+
+export type { MoreActionsItem };

package/dist/dts-bundle/types/MultiLevelSorting.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+
+declare const MultiLevelSorting: {
+    (): React.JSX.Element;
+    displayName: string;
+};
+
+export { MultiLevelSorting };

package/dist/dts-bundle/types/OnSaveParams.d.ts

@@ -0,0 +1,24 @@
+/**
+ * `EntityPageStateParams` — cut here because it has its own bundle.
+ * Look `EntityPageStateParams` up in the bundle index for its full shape.
+ */
+type EntityPageStateParams<T = any, V = any> = Record<string, unknown>;
+interface EntityPageStateInterface {
+}
+interface EntityPageWidgetState {
+    validate: () => Promise<{
+        isValid: boolean;
+        values?: any;
+    }>;
+    isDirty: 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;
+}
+
+export { EntityPageState };
+export type { EntityPageStateInterface, EntityPageStateParams, EntityPageWidgetState };