@wix/patterns 1.456.0 → 1.458.0

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

@@ -0,0 +1,206 @@
+import React from 'react';
+import { InfoIconProps, DropdownProps } from '@wix/design-system';
+
+/**
+ * `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;
+};
+
+type ExtractFilterValue<T> = T extends Filter<infer U> ? U : undefined;
+type AllFilters<F extends FiltersMap> = F & {
+    search: Filter<string>;
+};
+
+type ViewType = 'table' | 'grid' | 'spreadsheet';
+type ColumnSortOrder = 'Ascending' | 'Descending';
+interface ColumnViewConfig {
+    id: string;
+    name?: string;
+    isSelected?: boolean;
+}
+interface ColumnSortConfig {
+    columnId: string;
+    direction: ColumnSortOrder;
+}
+interface BasicCategory {
+    id: string;
+    /**
+     *
+     * What the category is called in the dropdown.
+     * @external
+     */
+    name: string;
+    /**
+     * @deprecated Info icon is now automatically rendered by Cairo for all categories.
+     * [InfoIconProps](https://www.docs.wixdesignsystem.com/?path=/story/components-form--infoicon)
+     * @external
+     */
+    info?: InfoIconProps;
+}
+interface Category<F extends FiltersMap> extends BasicCategory {
+    /**
+     * Unique identifier.
+     * @external
+     */
+    id: string;
+    /**
+     * Array of [view objects](./?path=%2Fstory%2Fcommon-types--view) that appear under the category in the dropdown.
+     * @external
+     */
+    views: View<F>[];
+}
+type ViewFiltersValues<F extends FiltersMap> = {
+    [P in keyof F]: {
+        value?: ExtractFilterValue<F[P]>;
+    } | null;
+};
+interface ViewBase<F extends FiltersMap> {
+    /**
+     * Filters to apply when the view is selected.
+     * @external
+     */
+    filters?: Partial<ViewFiltersValues<AllFilters<F>>> | null;
+    orderedColumns?: ColumnViewConfig[];
+    /**
+     * Array of the selected columns for the table layout.
+     * @external
+     */
+    selectedColumns?: ColumnViewConfig[];
+    /**
+     * Array of the selected columns for the spreadsheet (EditableTable) layout.
+     * @external
+     */
+    spreadsheetSelectedColumns?: ColumnViewConfig[];
+    /**
+     * Ordered columns for the spreadsheet (EditableTable) layout.
+     * @external
+     */
+    spreadsheetOrderedColumns?: ColumnViewConfig[];
+    /**
+     * Array of sort directions.
+     * @external
+     */
+    sortDirections?: ColumnSortConfig[];
+    /**
+     * Layout type for the view ('table' or 'grid').
+     * @external
+     */
+    layout?: ViewType;
+}
+interface View<F extends FiltersMap> extends ViewBase<F> {
+    /**
+     * Unique identifier. Do not use category IDs, `saved-views`, or `predefined-views`.
+     * @external
+     */
+    id: string;
+    /**
+     * What the view is called in the dropdown.
+     * @external
+     */
+    name: string;
+    /**
+     * Whether the view is automatically applied when the table initially loads.
+     * @external
+     */
+    isDefaultView?: boolean;
+    createdAt?: string;
+    /**
+     * Extra data to be passed to the view.
+     * @external
+     */
+    extra?: string;
+}
+type AllItemsViewProps<F extends FiltersMap> = Omit<View<F>, 'id' | 'createdAt' | 'filters' | 'isDefaultView' | 'name'> & {
+    /** A label to show instead of default 'All Items' */
+    name?: string;
+    /** Hides 'All Items' view from the list, default: false. Will be ignored if no presets are passed. */
+    hidden?: boolean;
+};
+
+/**
+ * `ToolbarCollectionState` — you receive this, you don't construct it.
+ * Produced by `useToolbarCollectionContext()` (also `useTableCollectionSyncProps()`, `useKanbanCollectionSyncProps()`, `useToolbarCollectionSyncProps()`).
+ */
+declare class ToolbarCollectionState<T, F> {
+}
+
+interface CollectionViewsDropdownBaseProps<F extends FiltersMap> {
+    /**
+     * Array of view or category objects that appear as predefined views or groups of views.
+     * @override [Category]()<F>[./?path=%2Fstory%2Fcommon-types--category] | [View](./?path=%2Fstory%2Fcommon-types--view)<F>[]
+     * @external
+     */
+    presets?: Category<F>[] | Omit<View<F>, 'createdAt'>[];
+    /**
+     * Redirect URL for the **Learn More** button in the **Save View** modal.
+     * @external
+     */
+    learnMoreLink?: string;
+    /**
+     * Function that is called when a view is saved.
+     * @external
+     */
+    onSaveViewChanges?: (view: View<F>) => void | Promise<void>;
+    /**
+     * Function that is called when a new view is saved.
+     * @external
+     */
+    onSaveView?: (view: View<F>) => void | Promise<void>;
+    /**
+     * Function that is called when a view is deleted.
+     * @external
+     */
+    onDeleteView?: (view: View<F>) => void | Promise<void>;
+    /**
+     * Function that is called when a view is renamed.
+     * @external
+     */
+    onRenameView?: (view: View<F>) => void | Promise<void>;
+    /**
+     * Function that is called when a view is set as the default view.
+     * @external
+     */
+    onSetAsDefaultView?: (view: View<F>, isDefault: boolean) => void | Promise<void>;
+    /**
+     * Function that is called when a view is selected.
+     * @external
+     */
+    onSelect?: (view: View<F>) => void;
+    /**
+     * Whether to show the total count for the selected view.
+     * @default true
+     * @external
+     */
+    showTotal?: boolean;
+    /**
+     * Information about how to handle the "All Items" view.
+     * <br><br>
+     * Supported properties:<br>
+     * - `name`: [string] Display name instead of "All Items".<br>
+     * - `hidden`: [bool] Whether to hide the "All Items" view from the list. Ignored if there are no preset views. Default: `false`.<br>
+     * @external
+     */
+    allItemsViewProps?: AllItemsViewProps<F>;
+    /**
+     * Overrides the placeholder in the **Save View** modal.
+     * @external
+     */
+    viewNamePlaceholder?: string;
+    /**
+     * The toolbar state that the dropdown is connected to.
+     */
+    toolbar: ToolbarCollectionState<any, F>;
+    /**
+     * An optional popover props to apply to the dropdown. Only relevant when this component is rendered outside of the Collection component.
+     */
+    popoverProps?: DropdownProps['popoverProps'];
+}
+declare const CollectionViewsDropdownBase: <F extends FiltersMap>(props: CollectionViewsDropdownBaseProps<F>) => React.JSX.Element | null;
+
+export { CollectionViewsDropdownBase };
+export type { CollectionViewsDropdownBaseProps };

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

@@ -0,0 +1,339 @@
+import { TableColumn as TableColumn$1 } from '@wix/design-system';
+import { CSSProperties, ReactNode, ComponentType } from 'react';
+
+type PatternsFieldType = 'SHORT_TEXT' | 'LONG_TEXT' | 'NUMBER' | 'BOOLEAN' | 'DATE' | 'DATETIME' | 'TIME' | 'URL' | 'ARRAY' | 'REFERENCE' | 'MULTI_REFERENCE' | 'OBJECT' | 'IMAGE' | 'VIDEO' | 'MEDIA_GALLERY' | 'ADDRESS' | 'RICH_TEXT' | 'DOCUMENT' | 'RICH_CONTENT' | 'MULTI_DOCUMENT' | 'EMAIL' | 'AUDIO' | 'COLOR' | 'CUSTOM' | 'UNKNOWN';
+type QueryOperator = 'CONTAINS' | 'ENDS_WITH' | 'EQ' | 'EXISTS' | 'GT' | 'GTE' | 'HAS_ALL' | 'HAS_SOME' | 'LT' | 'LTE' | 'NE' | 'STARTS_WITH' | 'URLIZED';
+interface NumberRange {
+    min?: number;
+    max?: number;
+}
+interface StringLengthRange {
+    minLength?: number;
+    maxLength?: number;
+}
+interface SpecificValue {
+    id: string;
+    value: string;
+}
+interface BaseField {
+    id: string;
+    displayName: string;
+    isPii?: boolean;
+    helpText?: string;
+    /** Whether this is a system-managed field (not user-created). */
+    isSystem?: boolean;
+    /** The group this field belongs to, when the source groups its fields.
+     *  Absent ⇒ ungrouped. */
+    group?: string;
+    /** Whether this is the collection's primary display field. */
+    isPrimary?: boolean;
+    validation?: {
+        numberRange?: NumberRange;
+        stringLengthRange?: StringLengthRange;
+        specificValues?: SpecificValue[];
+        required: boolean;
+    };
+    capabilities?: {
+        supportedQueryOperators: QueryOperator[];
+        sortable: boolean;
+    };
+}
+interface BaseReferenceField extends BaseField {
+    referenceMetadata: {
+        referencedCollectionId: string;
+    };
+}
+interface ReferenceField extends BaseReferenceField {
+    type: 'REFERENCE';
+}
+interface MultiReferenceField extends BaseReferenceField {
+    type: 'MULTI_REFERENCE';
+}
+interface NonReferenceField extends BaseField {
+    type: Exclude<PatternsFieldType, 'REFERENCE' | 'MULTI_REFERENCE'>;
+    /** Present iff `type` is 'CUSTOM'; keys a field type definition registered on the source. */
+    customType?: string;
+}
+type Field = ReferenceField | MultiReferenceField | NonReferenceField;
+
+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>;
+/**
+ * `TableColumn` — cut here because it has its own bundle.
+ * Look `TableColumn` up in the bundle index for its full shape.
+ */
+type TableColumn<T> = unknown;
+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';
+};
+interface Column {
+    /**
+     * A unique identifier for the column. This value is required to enable [custom columns](./?path=/story/features-display-custom-columns--overview) or [sortable columns](./?path=/story/features-sort-sortable-columns-sortable-columns--sortable-columns).
+     * @external
+     */
+    id: string;
+    /**
+     * A name for the column. This value is shown in the [custom columns](./?path=/story/features-display-custom-columns--overview) dropdown.
+     * @external
+     */
+    name: string;
+    /**
+     * The text to be shown at the top of the column.
+     * @external
+     */
+    title: TableColumnBase['title'];
+    /**
+     * Hides the column from the custom column selection panel, making it always visible. Relevant for [custom columns](./?path=/story/features-display-custom-columns--overview).
+     * @external
+     */
+    hiddenFromCustomColumnsSelection?: boolean;
+    /**
+     * When `false`, the column is always selected and displayed. Relevant for [custom columns](./?path=/story/features-display-custom-columns--overview).
+     */
+    hideable?: boolean;
+    /**
+     * When `true`, search matches in the column's values will be highlighted. Mark a column as searchable only if iy's data is relevant for your search.
+     */
+    searchable?: boolean;
+    /**
+     * When `true`, disables drag and drop for the column.
+     * @external
+     */
+    reorderDisabled?: boolean;
+    /**
+     * When `true`, makes the column a [sortable column](./?path=/story/features-sort-sortable-columns-sortable-columns--sortable-columns).
+     * @external
+     */
+    sortable?: boolean;
+    sortDescending?: boolean;
+    sortMode?: SortMode;
+    /**
+     * Determines the default sort order for the column, either `asc` or `desc`. The column must be a [sortable column](./?path=/story/features-sort-sortable-columns-sortable-columns--sortable-columns).
+     * @external
+     */
+    defaultSortOrder?: SortOrder;
+    /**
+     * For [custom columns](./?path=/story/features-display-custom-columns--overview), when `true`, this property causes the column to be unchecked and thus not shown by default. This isn't relevant when `hideable` `=` `false`.
+     * @external
+     */
+    defaultHidden?: boolean;
+    dataExtension?: {
+        id: string;
+        editable: boolean;
+        isPii?: boolean;
+    };
+    /** The source field this column was built from; used to resolve manage actions. */
+    field?: Field;
+    /**
+     * 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[];
+    infoTooltipProps?: {
+        content?: ReactNode;
+        panelContent?: ReactNode;
+    };
+    /**
+     * A callback that is called for each row in the data to display the value of this row for the specified column.
+     * @external
+     */
+    render: TableColumn$1['render'];
+    width?: TableColumn$1['width'];
+    style?: TableColumn$1['style'];
+    /**
+     * Mobile column configuration. Determines how this column is displayed on mobile devices.
+     * - column: 'first' - Stacks vertically with other 'first' columns
+     * - column: 'second' - Displays as standalone second column
+     * - undefined - Hidden on mobile
+     * @external
+     */
+    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;
+    };
+}
+
+export type { Column, ColumnMobileConfig, CustomColumnConfig, NotSortableColumnConfig, SortableColumnConfig, SortableConfig, TableColumn };

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

@@ -0,0 +1,115 @@
+type SortOrder = 'asc' | 'desc';
+
+/**
+ * `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;
+};
+type OptionalFiltersMap = {
+    [key: string]: undefined;
+};
+
+type ExtractFilterValue<T> = T extends Filter<infer U> ? U : undefined;
+type RawFilters<F extends FiltersMap> = Partial<{
+    [P in keyof F]: ExtractFilterValue<F[P]>;
+}>;
+type FiltersKey<F extends FiltersMap> = Partial<{
+    [P in keyof F]: string[] | undefined | null;
+}>;
+type AllFilters<F extends FiltersMap> = F & {
+    search: Filter<string>;
+};
+type FiltersValues<F extends FiltersMap> = {
+    [P in keyof F]: {
+        value?: ExtractFilterValue<F[P]>;
+    };
+};
+interface Sort {
+    field: string;
+    direction: SortOrder;
+}
+interface ComputedQuery<F extends FiltersMap = OptionalFiltersMap> {
+    /**
+     * Number of items to fetch for each page
+     * @external
+     */
+    limit: number;
+    /**
+     * The index of the item to start fetching items from.<br>
+     * Relevant for APIs that support offset pagination.<br>
+     * Not available on `CursorQuery`.
+     * @external
+     */
+    offset: number;
+    page: number;
+    /**
+     * Current search term. Defaults to `undefined` for empty search.
+     * @external
+     */
+    search?: string;
+    /**
+     * Current search term. Defaults to `''` for empty search.
+     * @external
+     */
+    rawSearch: string;
+    /**
+     * The `cursor` returned from the server, to be sent back to it in the next call.<br>
+     * Relevant for APIs that support cursor pagination.<br>
+     * Not available on `OffsetQuery`.
+     * @external
+     */
+    cursor?: string | null;
+    /**
+     * Current state of the filters. Each key holds the value of the filter, according to its type, defined in [CollectionConfig](./?path=/story/common-hooks--usecollection).
+     * @external
+     */
+    filters: RawFilters<F>;
+    /**
+     * Same as `filters` but defaults to `undefined` for empty filter values.
+     * @external
+     */
+    rawFilters: RawFilters<F>;
+    /**
+     * Whether at least one filter is not empty.
+     * @external
+     */
+    hasActiveFilters: boolean;
+    /**
+     * Whether at least one filter is not empty, not including tabs.
+     * @external
+     */
+    hasNonPersistentActiveFilters: boolean;
+    /**
+     * Current sort applied to the collection.
+     * @external
+     */
+    sort?: {
+        fieldName: string;
+        order: 'asc' | 'desc';
+    }[];
+    /**
+     * @deprecated Use `fields` instead
+     */
+    columns?: string[];
+    /**
+     * Array of projected fields. A list of specific field names to fetch. Use this to optimize your server query to load only needed columns. Note that a mapping between client-side columns to server-fields is usually required.
+     * Use `refreshOnColumnsChange` of [useCollection](./?path=/story/common-hooks--usecollection) to control whether the collection should be refreshed when this value changes.
+     * @external
+     */
+    fields?: string[];
+    /**
+     * Extra data to be passed to the query.
+     * @external
+     */
+    extra?: string;
+}
+interface ComputedQueryFull<F extends FiltersMap = OptionalFiltersMap> extends ComputedQuery<F> {
+    filtersKey: FiltersKey<F>;
+    nonPersistentFiltersKey: FiltersKey<F>;
+}
+
+export type { AllFilters, ComputedQuery, ComputedQueryFull, ExtractFilterValue, FiltersKey, FiltersValues, RawFilters, Sort };