@wix/patterns 1.457.0 → 1.459.0

package/dist/dts-bundle/types/RangeItem.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 RangeItem<T> {
+    from: T | null;
+    to: T | null;
+    preset?: string;
+}
+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/types/TableColumn.d.ts

@@ -0,0 +1,174 @@
+import { TableColumn as TableColumn$1 } from '@wix/design-system';
+import { CSSProperties, ReactNode, ComponentType } from 'react';
+
+type ValidationRule = {
+    type: 'required';
+    message: string;
+} | {
+    type: 'min' | 'max';
+    value: number;
+    message: string;
+} | {
+    type: 'minLength' | 'maxLength';
+    value: number;
+    message: string;
+} | {
+    type: 'pattern';
+    value: RegExp;
+    message: string;
+} | {
+    type: 'custom';
+    validate: (value: unknown) => boolean;
+    message: string;
+} | {
+    type: 'specificValues';
+    values: {
+        id: string;
+        value: string;
+    }[];
+    message: string;
+};
+
+type SortOrder = 'asc' | 'desc';
+type SortOrderWithNone = SortOrder | undefined;
+/**
+ * @deprecated always option is deprecated
+ */
+type SortModeDeprecated = 'always';
+type SortMode = SortModeDeprecated | SortOrderWithNone[];
+
+interface KeyedItem<T> {
+    item: T;
+    key: string;
+    id: string;
+    pageIndex: number;
+    indexWithinPage: number;
+    index: number;
+}
+
+/**
+ * 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';
+
+type TableColumnBase<T = any> = Omit<TableColumn$1<T>, 'sortDescending' | 'sortable' | 'infoTooltipProps' | 'style' | 'titleSuffix'> & {
+    style?: CSSProperties | ((column: TableColumn$1, rowData: KeyedItem<T>, rowNum: number) => CSSProperties);
+    reorderDisabled?: boolean;
+    defaultSortOrder?: SortOrder;
+    sortMode?: SortMode;
+    searchable?: boolean;
+    infoTooltipProps?: TableColumn$1['infoTooltipProps'] & {
+        panelContent?: ReactNode;
+    };
+    mobile?: ColumnMobileConfig;
+    /**
+     * The field type string used to resolve a prefix icon for the column.
+     * Cairo maps this to the appropriate icon internally.
+     * @external
+     */
+    fieldType?: FieldType;
+    /**
+     * Explicit prefix icons for the column (e.g. a custom field type's
+     * `display.icons`). When present, used instead of the `fieldType` mapping.
+     * @external
+     */
+    fieldTypeIcons?: {
+        Small: ComponentType;
+        Medium: ComponentType;
+    };
+    /**
+     * Whether the field contains personally identifiable information.
+     * @external
+     */
+    isPii?: boolean;
+    /**
+     * only for cms. Whether this is a system-managed field.
+     * @external
+     */
+    isSystem?: boolean;
+    /**
+     * Whether this is the primary display field.
+     * @external
+     */
+    isPrimary?: boolean;
+    /**
+     * Column-level validation rules. When a `required` rule is present, a required indicator is shown in the custom columns panel.
+     * @external
+     */
+    validation?: ValidationRule[];
+};
+interface TableColumnOptional<T> extends TableColumnBase<T> {
+    id?: string;
+    name?: string;
+    hiddenFromCustomColumnsSelection?: undefined | true;
+    hideable?: undefined;
+    defaultHidden?: undefined;
+}
+interface TableColumnCustom<T> extends TableColumnBase<T> {
+    id: string;
+    name: string;
+    hiddenFromCustomColumnsSelection?: false;
+    hideable?: true;
+    defaultHidden?: boolean;
+}
+interface TableColumnCustomOptionalName<T> extends TableColumnBase<T> {
+    id: string;
+    name?: string;
+    title: TableColumnBase['title'];
+    hiddenFromCustomColumnsSelection?: false;
+    hideable?: true;
+    defaultHidden?: boolean;
+}
+interface TableColumnCustomDefaultHidden<T> extends TableColumnBase<T> {
+    id: string;
+    name?: string;
+    title: TableColumnBase['title'];
+    hiddenFromCustomColumnsSelection?: false;
+    hideable: false;
+    defaultHidden?: undefined | false;
+}
+type CustomColumnConfig<T> = TableColumnOptional<T> | TableColumnCustom<T> | TableColumnCustomDefaultHidden<T> | TableColumnCustomOptionalName<T>;
+interface SortableColumnConfig<T> extends TableColumnBase<T> {
+    id: string;
+    sortable: true;
+}
+interface NotSortableColumnConfig<T> extends TableColumnBase<T> {
+    id?: string;
+    sortable?: false;
+}
+type SortableConfig<T> = SortableColumnConfig<T> | NotSortableColumnConfig<T>;
+type TableColumn<T> = CustomColumnConfig<T> & SortableConfig<T>;
+type ColumnMobileConfig = {
+    /**
+     * Which mobile column to display in.
+     * - 'first': Stacks vertically with other 'first' columns
+     * - 'second': Displays as standalone second column
+     * - undefined: Hidden on mobile
+     */
+    column: 'first';
+    /**
+     * Sort order within 'first' column (lower appears higher).
+     * Only relevant when column is 'first'.
+     * @default Infinity
+     */
+    order?: number;
+} | {
+    /**
+     * Which mobile column to display in.
+     * - 'first': Stacks vertically with other 'first' columns
+     * - 'second': Displays as standalone second column
+     * - undefined: Hidden on mobile
+     */
+    column?: 'second';
+};
+/**
+ * `Column` — cut here because it has its own bundle.
+ * Look `Column` up in the bundle index for its full shape.
+ */
+interface Column {
+    [key: string]: unknown;
+}
+
+export type { Column, ColumnMobileConfig, CustomColumnConfig, NotSortableColumnConfig, SortableColumnConfig, SortableConfig, TableColumn };

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

@@ -0,0 +1,184 @@
+/**
+ * `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;
+};
+
+interface KeyedItem<T> {
+    item: T;
+    key: string;
+    id: string;
+    pageIndex: number;
+    indexWithinPage: number;
+    index: number;
+}
+
+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>;
+}
+
+/**
+ * `TableVirtualState` — you receive this, you don't construct it.
+ * An internal state object — reached through another state object, never built directly.
+ */
+declare class TableVirtualState<K = any, T = any, F = any> {
+    [key: string]: unknown;
+}
+
+/**
+ * `TableState` — you receive this, you don't construct it.
+ * Produced by `useTableCollection()` (also `useAmbassadorTable()`, `useTableContext()`). Look `TableState` up in the bundle index for its own API.
+ */
+declare class TableState<T = any, F = any> {
+    [key: string]: unknown;
+}
+
+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;
+}
+
+interface TableFoldersStateParams<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>>;
+}
+interface Item<T1> {
+    _tag: 'item';
+    originalKeyedItem: KeyedItem<T1>;
+}
+interface Folder<T2> {
+    _tag: 'folder';
+    originalKeyedItem: KeyedItem<T2>;
+}
+type RowItem<T1, T2> = Item<T1> | Folder<T2>;
+type RowKeyedItem<T1, T2> = KeyedItem<RowItem<T1, T2>>;
+declare function isItemKeyedItem<T1, T2>(keyedItem: RowKeyedItem<T1, T2>): keyedItem is KeyedItem<Item<T1>>;
+declare function isFolderKeyedItem<T1, T2>(keyedItem: RowKeyedItem<T1, T2>): keyedItem is KeyedItem<Folder<T2>>;
+interface TableFoldersStateInitParams extends FoldersAndItemsCollectionsStateInitParams {
+}
+interface TableFoldersStatePublicAPI<T1, F1 extends FiltersMap, T2, F2 extends FiltersMap> {
+    /**
+     * Underlying [ToolbarCollectionState](./?path=/story/common-state--toolbarcollectionstate) instance
+     */
+    readonly toolbar: ToolbarCollectionState<T1, {}>;
+    /**
+     * Underlying [TableState](./?path=/story/base-components-collections-table-tablestate--tablestate) instance
+     */
+    readonly tableState: TableState<T1, {}>;
+    /**
+     * Underlying [CollectionState](./?path=/story/common-state--collectionstate) instances for folders and items
+     */
+    readonly collections: {
+        readonly folders: CollectionState<T2, F2>;
+        readonly items: CollectionState<T1, F1>;
+    };
+}
+declare class TableFoldersState<T1, F1 extends FiltersMap, T2, F2 extends FiltersMap> implements ICollectionComponentState, TableFoldersStatePublicAPI<T1, F1, T2, F2> {
+    readonly container: WixPatternsContainer;
+    readonly table: TableState<T1, {}>;
+    readonly toolbar: ToolbarCollectionState<T1, Partial<F1 & F2>>;
+    readonly virtual: TableVirtualState<RowKeyedItem<T1, T2>, T1, Partial<F1 & F2>>;
+    readonly collections: FoldersAndItemsCollectionsState<T1, F1, T2, F2>;
+    constructor(params: TableFoldersStateParams<T1, F1, T2, F2>);
+    get showItemsSection(): boolean;
+    get showFoldersSection(): boolean;
+    get tableState(): TableState<T1, {}>;
+    get showEmptyState(): boolean;
+    get hasAvailableItems(): boolean;
+    get resultOriginQuerySearch(): string | undefined;
+    get hasNonPersistentActiveFilters(): boolean;
+    get showErrorState(): boolean;
+    get errorStatus(): QueryResultStatusError<DataResultKeyed<unknown>, Partial<F1 & F2>> | undefined;
+    get showLoadingState(): boolean;
+    get initTask(): TaskState<unknown>;
+    retryErrorState: () => void;
+    get keyedItems(): RowKeyedItem<T1, T2>[];
+    init(params: TableFoldersStateInitParams): () => void;
+}
+
+export { TableFoldersState, isFolderKeyedItem, isItemKeyedItem };
+export type { RowItem, RowKeyedItem, TableFoldersStateParams, TableFoldersStatePublicAPI };