@wix/patterns 1.475.0 → 1.477.0

package/dist/dts-bundle/components/schema/Table.d.ts

@@ -0,0 +1,360 @@
+import React, { ReactNode, CSSProperties, ComponentType } from 'react';
+import { IconElement, TableColumn as TableColumn$1 } from '@wix/design-system';
+
+/**
+ * `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 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;
+};
+
+/**
+ * `Filter` — cut here because it has its own bundle.
+ * Full shape: `types/Filter.d.ts`.
+ */
+interface Filter<T = any> {
+    [key: string]: unknown;
+}
+type FiltersMap = {
+    [key: string]: Filter<any> | undefined;
+};
+type OptionalFiltersMap = {
+    [key: string]: undefined;
+};
+
+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';
+
+/**
+ * `TableState` — you receive this, you don't construct it.
+ * Produced by `useTableCollection()` (also `useAmbassadorTable()`, `useTableContext()`). Its own API is in `types/TableState.d.ts`.
+ */
+declare class TableState<T = any, F = any> {
+    [key: string]: unknown;
+}
+
+interface CtaBaseProps {
+    /**
+     * A unique identifier for the CTA.
+     * @external
+     */
+    id: string;
+    /**
+     * A callback that runs each time the button is clicked.
+     * @external
+     */
+    onClick?: () => void;
+    /**
+     * Button label.
+     * @external
+     */
+    label?: string;
+    /**
+     * An optional Icon prefix.
+     * @external
+     */
+    prefixIcon?: IconElement;
+}
+
+interface SectionBadgeConfig {
+    visible: boolean;
+    skin?: 'light' | 'danger' | 'neutralLight';
+}
+/**
+ * A summary item to display in the section header.
+ * @external
+ */
+interface SectionSummaryItem {
+    /**
+     * An icon to display before the text.
+     * @external
+     */
+    icon: ReactNode;
+    /**
+     * A label for the summary item.
+     * @external
+     */
+    text: string;
+    /**
+     * A count value for the summary item.
+     * @external
+     */
+    count: number;
+}
+interface Section {
+    /**
+     * A title for the section.
+     * @external
+     */
+    title: string;
+    /**
+     * A primary call to action for the section.
+     * @overrideType [CtaBaseProps](./?path=/story/common-types--ctabaseprops)
+     * @external
+     */
+    primaryAction?: CtaBaseProps;
+    /**
+     * A badge for the section. Configuration object for showing item count.
+     * @external
+     */
+    badge?: SectionBadgeConfig;
+    /**
+     * Summary items to display in the section header.
+     * Each item can have an icon, text label, and count.
+     * @external
+     */
+    summary?: SectionSummaryItem[];
+    /**
+     * Whether the section is collapsed.
+     * When true, the section items are hidden.
+     * @external
+     */
+    collapsed?: boolean;
+}
+/**
+ * A function that extracts the grouping key from an item.
+ * @external
+ */
+type GroupBy<T> = (item: T) => string;
+/**
+ * A function that renders section configuration given the section ID and all items in the section.
+ * @external
+ */
+type RenderSection<T> = (sectionId: string, items: T[]) => Section;
+/**
+ * Event callbacks for section interactions.
+ * @external
+ */
+interface SectionEvents {
+    /**
+     * Called when a section is toggled (collapsed/expanded).
+     * @param sectionId - The ID of the section being toggled
+     * @param isCollapsed - Whether the section is now collapsed
+     * @external
+     */
+    onToggle?: (sectionId: string, isCollapsed: boolean) => void;
+}
+
+interface TableSectionsProps<T, F extends FiltersMap> extends CollectionTableBaseProps<T, F> {
+    groupBy: GroupBy<T>;
+    renderSection: RenderSection<T>;
+    table: TableState<T, F>;
+    collapsible?: boolean;
+    events?: SectionEvents;
+}
+declare const TableSections: (<T, F extends FiltersMap>({ groupBy, renderSection, table, columns, rowDetails, collapsible, events, ...collectionTableProps }: TableSectionsProps<T, F>) => React.JSX.Element) & {
+    displayName: string;
+};
+type TableSectionsProp<T> = {
+    TableSections: typeof TableSections;
+    groupBy: GroupBy<T>;
+    renderSection: RenderSection<T>;
+    collapsible?: boolean;
+    events?: SectionEvents;
+};
+
+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.
+ * Full shape: `types/TableColumn.d.ts`.
+ */
+type TableColumn<T = any> = 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';
+};
+
+/**
+ * `CollectionTableBaseProps` — cut here because it has its own bundle.
+ * Full shape: `types/CollectionTableBaseProps.d.ts`.
+ */
+interface CollectionTableBaseProps<T = any, F = any> {
+    [key: string]: unknown;
+}
+
+interface TableProps<T, F extends FiltersMap = OptionalFiltersMap> extends CollectionTableBaseProps<T, F> {
+    rowHeight?: number | ((item: T, index: number) => number);
+    estimatedRowHeight?: number;
+    /**
+     * A state instance created using the [`useTableCollection()`](./?path=/story/base-components-collections-table-usetablecollection--usetablecollection) hook, responsible for managing the data displayed in the table.
+     * @overrideType [TableState](./?path=/story/base-components-collections-table-tablestate--tablestate)
+     * @external
+     */
+    state: CollectionState<T, F> | TableState<T, F>;
+    isVirtual?: boolean;
+    /**
+     * Configuration for rendering table sections. When provided, the table will render with section headers
+     * that group related rows together
+     * @external
+     */
+    sections?: TableSectionsProp<T>;
+}
+
+/** Table props for a source-driven table: the source supplies the field
+ *  columns and attaches its own fields management. `columns` is optional
+ *  (extras only); the fields-management props are always on and not
+ *  configurable, and there is no `fieldsSource`/`dataExtension`. */
+type SchemaTableProps<T, F extends FiltersMap> = Omit<TableProps<T, F>, 'state' | 'columns' | 'fieldsSource' | 'dataExtension' | 'showFieldTypeIcons' | 'showAddFieldButton'> & {
+    state: TableState<T, F>;
+    /** Columns beyond the source's fields (e.g. an action column). Default: none. */
+    columns?: TableColumn<T>[];
+};
+declare function _Table<T, F extends FiltersMap>(props: SchemaTableProps<T, F>): React.JSX.Element;
+declare const Table: typeof _Table;
+
+export { Table };
+export type { SchemaTableProps };

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

@@ -7,6 +7,7 @@ export type { OffsetQuery } from '../types/OffsetQuery';
 export type { OnSaveParams } from '../types/OnSaveParams';
 export type { RangeItem } from '../types/RangeItem';
 export type { SchemaSource } from '../types/SchemaSource';
+export type { SchemaSourceInput } from '../types/SchemaSourceInput';
 export { arrayFilter } from '../functions/arrayFilter';
 export { customFilter } from '../functions/customFilter';
 export { dateRangeFilter } from '../functions/dateRangeFilter';

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

@@ -1,3 +1,2 @@
 export { WixPatternsBaseProvider } from '../components/WixPatternsBaseProvider';
 export { WixPatternsEssentialsProvider } from '../components/WixPatternsEssentialsProvider';
-export { usePickerModal } from '../hooks/usePickerModal';

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

@@ -1,2 +1 @@
 export { WixPatternsGizaProvider } from '../components/WixPatternsGizaProvider';
-export { usePickerModal } from '../hooks/usePickerModal';

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

@@ -2,10 +2,10 @@ export type { ActionCell } from '../types/ActionCell';
 export type { ActionCellProps } from '../types/ActionCellProps';
 export type { ActionSubitem } from '../types/ActionSubitem';
 export { AutoCompleteFilter } from '../components/AutoCompleteFilter';
+export type { CellType } from '../types/CellType';
 export { CollectionEmptyState } from '../components/CollectionEmptyState';
 export { CollectionNoResultsState } from '../components/CollectionNoResultsState';
 export { CollectionOptimisticActions } from '../components/CollectionOptimisticActions';
-export { CollectionPage } from '../components/CollectionPage';
 export { CollectionPremiumEmptyState } from '../components/CollectionPremiumEmptyState';
 export { CollectionSearch } from '../components/CollectionSearch';
 export { CollectionToolbarFilters } from '../components/CollectionToolbarFilters';
@@ -74,7 +74,6 @@ export { useFilterCollection } from '../hooks/useFilterCollection';
 export { useGridCollection } from '../hooks/useGridCollection';
 export { useGridFolders } from '../hooks/useGridFolders';
 export { useOptimisticActions } from '../hooks/useOptimisticActions';
-export { usePickerModal } from '../hooks/usePickerModal';
 export { useStaticListFilterCollection } from '../hooks/useStaticListFilterCollection';
 export { useTableCollection } from '../hooks/useTableCollection';
 export { useTableFolders } from '../hooks/useTableFolders';

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

@@ -1,8 +1,15 @@
-export { EntityPage } from '../components/EntityPage';
-export { Grid } from '../components/Grid';
+export { EditableTable } from '../components/EditableTable';
+export { EntityPage } from '../components/schema/EntityPage';
+export { EntityPageFieldsCard } from '../components/EntityPageFieldsCard';
+export { Grid } from '../components/schema/Grid';
+export { LayoutSwitch } from '../components/LayoutSwitch';
 export type { SchemaSource } from '../types/SchemaSource';
-export { Table } from '../components/Table';
-export { useCollection } from '../hooks/useCollection';
-export { useEntityPage } from '../hooks/useEntityPage';
-export { useGridCollection } from '../hooks/useGridCollection';
-export { useTableCollection } from '../hooks/useTableCollection';
+export type { SchemaSourceInput } from '../types/SchemaSourceInput';
+export { Table } from '../components/schema/Table';
+export { useCollection } from '../hooks/schema/useCollection';
+export { useEditableTableCollection } from '../hooks/useEditableTableCollection';
+export { useEntityPage } from '../hooks/schema/useEntityPage';
+export { useGridCollection } from '../hooks/schema/useGridCollection';
+export { useLayoutSwitchCollection } from '../hooks/useLayoutSwitchCollection';
+export { useSchemaSource } from '../hooks/useSchemaSource';
+export { useTableCollection } from '../hooks/schema/useTableCollection';

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

@@ -0,0 +1,12 @@
+/**
+ * `CmsCollectionSummary` — cut here because it has its own bundle.
+ * Full shape: `types/CmsCollectionSummary.d.ts`.
+ */
+interface CmsCollectionSummary {
+    [key: string]: unknown;
+}
+/** Lists the site's CMS collections — for collection pickers. */
+declare function listCmsCollections(): Promise<CmsCollectionSummary[]>;
+
+export { listCmsCollections };
+export type { CmsCollectionSummary };