@wix/patterns 1.461.0 → 1.463.0

package/dist/dts-bundle/index.json

@@ -4,7 +4,7 @@
     "category": "Base Components/Providers",
     "importPath": "@wix/patterns/provider",
     "file": "components/WixPatternsProvider.d.ts",
-    "bytes": 320,
+    "bytes": 552,
     "status": null,
     "statusMessage": null
   },
@@ -13,7 +13,7 @@
     "category": "Base Components/Providers",
     "importPath": "@wix/patterns/essentials",
     "file": "components/WixPatternsBaseProvider.d.ts",
-    "bytes": 10354,
+    "bytes": 10566,
     "status": null,
     "statusMessage": null
   },
@@ -22,7 +22,7 @@
     "category": "Base Components/Providers",
     "importPath": "@wix/patterns/bm",
     "file": "components/WixPatternsBMProvider.d.ts",
-    "bytes": 10013,
+    "bytes": 10236,
     "status": null,
     "statusMessage": null
   },
@@ -31,7 +31,7 @@
     "category": "Base Components/Providers",
     "importPath": "@wix/patterns/giza",
     "file": "components/WixPatternsGizaProvider.d.ts",
-    "bytes": 10035,
+    "bytes": 10247,
     "status": null,
     "statusMessage": null
   },
@@ -40,7 +40,7 @@
     "category": "Base Components/Providers",
     "importPath": "@wix/patterns/essentials",
     "file": "components/WixPatternsEssentialsProvider.d.ts",
-    "bytes": 10028,
+    "bytes": 10251,
     "status": null,
     "statusMessage": null
   },
@@ -49,7 +49,7 @@
     "category": "Base Components/Pages/Collection Page",
     "importPath": "@wix/patterns",
     "file": "components/CollectionPage.d.ts",
-    "bytes": 1355,
+    "bytes": 8163,
     "status": null,
     "statusMessage": null
   },
@@ -85,7 +85,7 @@
     "category": "Base Components/Collections/Table/Table",
     "importPath": "@wix/patterns",
     "file": "components/Table.d.ts",
-    "bytes": 5187,
+    "bytes": 5277,
     "status": null,
     "statusMessage": null
   },
@@ -94,7 +94,7 @@
     "category": "Base Components/Collections/Grid/Grid",
     "importPath": "@wix/patterns",
     "file": "components/Grid.d.ts",
-    "bytes": 16007,
+    "bytes": 16118,
     "status": null,
     "statusMessage": null
   },
@@ -103,7 +103,7 @@
     "category": "Base Components/Collections/TableGridSwitch/TableGridSwitch",
     "importPath": "@wix/patterns",
     "file": "components/TableGridSwitch.d.ts",
-    "bytes": 22523,
+    "bytes": 22655,
     "status": null,
     "statusMessage": null
   },
@@ -112,7 +112,7 @@
     "category": "Base Components/Collections/TableFolders/TableFolders",
     "importPath": "@wix/patterns",
     "file": "components/TableFolders.d.ts",
-    "bytes": 9497,
+    "bytes": 14368,
     "status": null,
     "statusMessage": null
   },
@@ -143,6 +143,15 @@
     "status": null,
     "statusMessage": null
   },
+  "withDashboard": {
+    "kind": "function",
+    "category": null,
+    "importPath": "@wix/patterns",
+    "file": "functions/withDashboard.d.ts",
+    "bytes": 336,
+    "status": null,
+    "statusMessage": null
+  },
   "SummaryBar": {
     "kind": "component",
     "category": "Features/Display/Toolbar",
@@ -311,8 +320,8 @@
     "importPath": "@wix/patterns",
     "file": "components/PrimaryPageButton.d.ts",
     "bytes": 796,
-    "status": null,
-    "statusMessage": null
+    "status": "deprecated",
+    "statusMessage": "Use `PrimaryActions` component instead."
   },
   "PrimaryActionButton": {
     "kind": "component",
@@ -400,7 +409,7 @@
     "category": "Base Components/Collections/Picker",
     "importPath": "@wix/patterns",
     "file": "components/PickerModal.d.ts",
-    "bytes": 1888,
+    "bytes": 1965,
     "status": null,
     "statusMessage": null
   },
@@ -409,7 +418,7 @@
     "category": "Base Components/Collections/Table/useTableCollection",
     "importPath": "@wix/patterns",
     "file": "hooks/useTableCollection.d.ts",
-    "bytes": 1775,
+    "bytes": 12306,
     "status": null,
     "statusMessage": null
   },
@@ -418,7 +427,7 @@
     "category": "Base Components/Collections/Grid/useGridCollection",
     "importPath": "@wix/patterns",
     "file": "hooks/useGridCollection.d.ts",
-    "bytes": 933,
+    "bytes": 11464,
     "status": null,
     "statusMessage": null
   },
@@ -427,7 +436,7 @@
     "category": "Base Components/Collections/TableGridSwitch/useTableGridSwitchCollection",
     "importPath": "@wix/patterns",
     "file": "hooks/useTableGridSwitchCollection.d.ts",
-    "bytes": 986,
+    "bytes": 11517,
     "status": null,
     "statusMessage": null
   },
@@ -454,7 +463,7 @@
     "category": "Common/Hooks",
     "importPath": "@wix/patterns",
     "file": "hooks/useCreateCollection.d.ts",
-    "bytes": 12611,
+    "bytes": 11961,
     "status": null,
     "statusMessage": null
   },
@@ -463,7 +472,7 @@
     "category": "Features/Filter/Hooks",
     "importPath": "@wix/patterns",
     "file": "hooks/useFilterCollection.d.ts",
-    "bytes": 1749,
+    "bytes": 11179,
     "status": null,
     "statusMessage": null
   },
@@ -499,7 +508,25 @@
     "category": "Base Components/Pages/Entity Page/Hooks/useEntityPage",
     "importPath": "@wix/patterns",
     "file": "hooks/useEntityPage.d.ts",
-    "bytes": 683,
+    "bytes": 37181,
+    "status": null,
+    "statusMessage": null
+  },
+  "useEntityPageContext": {
+    "kind": "hook",
+    "category": "Base Components/Pages/Entity Page/Hooks/useEntityPageContext",
+    "importPath": "@wix/patterns",
+    "file": "hooks/useEntityPageContext.d.ts",
+    "bytes": 778,
+    "status": null,
+    "statusMessage": null
+  },
+  "useEntity": {
+    "kind": "hook",
+    "category": "Base Components/Pages/Entity Page/Hooks/useEntity",
+    "importPath": "@wix/patterns",
+    "file": "hooks/useEntity.d.ts",
+    "bytes": 401,
     "status": null,
     "statusMessage": null
   },
@@ -508,7 +535,7 @@
     "category": "Base Components/Collections/Picker/Hooks",
     "importPath": "@wix/patterns",
     "file": "hooks/usePickerModal.d.ts",
-    "bytes": 26048,
+    "bytes": 26304,
     "status": null,
     "statusMessage": null
   },
@@ -670,7 +697,7 @@
     "category": null,
     "importPath": "@wix/patterns/core",
     "file": "types/OnSaveParams.d.ts",
-    "bytes": 747,
+    "bytes": 36753,
     "status": null,
     "statusMessage": null
   },
@@ -679,7 +706,7 @@
     "category": null,
     "importPath": "@wix/patterns",
     "file": "types/UseEntityPageParams.d.ts",
-    "bytes": 997,
+    "bytes": 37053,
     "status": null,
     "statusMessage": null
   },
@@ -688,7 +715,7 @@
     "category": null,
     "importPath": "@wix/patterns",
     "file": "types/EntityPageStateParams.d.ts",
-    "bytes": 36657,
+    "bytes": 36719,
     "status": null,
     "statusMessage": null
   },
@@ -697,7 +724,7 @@
     "category": null,
     "importPath": "@wix/patterns",
     "file": "types/Column.d.ts",
-    "bytes": 11572,
+    "bytes": 11590,
     "status": null,
     "statusMessage": null
   },
@@ -760,7 +787,7 @@
     "category": null,
     "importPath": "@wix/patterns",
     "file": "types/TagsProps.d.ts",
-    "bytes": 4361,
+    "bytes": 9440,
     "status": null,
     "statusMessage": null
   },
@@ -780,7 +807,7 @@
     "file": "types/ToolbarCollectionBaseProps.d.ts",
     "bytes": 36933,
     "status": "unreachable",
-    "statusMessage": "Bundled, but not actually re-exported from any @wix/patterns entry point — likely a manifest or upstream export gap. Do not recommend importing this."
+    "statusMessage": "Read this file for the props it declares — they are real props of the components that extend it. The name itself is bundled deliberately and is exported from no @wix/patterns entry point, so never write an import for it; import the component instead."
   },
   "ToolbarBaseProps": {
     "kind": "type",
@@ -789,16 +816,16 @@
     "file": "types/ToolbarBaseProps.d.ts",
     "bytes": 4011,
     "status": "unreachable",
-    "statusMessage": "Bundled, but not actually re-exported from any @wix/patterns entry point — likely a manifest or upstream export gap. Do not recommend importing this."
+    "statusMessage": "Read this file for the props it declares — they are real props of the components that extend it. The name itself is bundled deliberately and is exported from no @wix/patterns entry point, so never write an import for it; import the component instead."
   },
   "CollectionTableBaseProps": {
     "kind": "type",
     "category": null,
     "importPath": null,
     "file": "types/CollectionTableBaseProps.d.ts",
-    "bytes": 15806,
+    "bytes": 20677,
     "status": "unreachable",
-    "statusMessage": "Bundled, but not actually re-exported from any @wix/patterns entry point — likely a manifest or upstream export gap. Do not recommend importing this."
+    "statusMessage": "Read this file for the props it declares — they are real props of the components that extend it. The name itself is bundled deliberately and is exported from no @wix/patterns entry point, so never write an import for it; import the component instead."
   },
   "CollectionViewsDropdownBaseProps": {
     "kind": "type",
@@ -807,7 +834,7 @@
     "file": "types/CollectionViewsDropdownBaseProps.d.ts",
     "bytes": 6403,
     "status": "unreachable",
-    "statusMessage": "Bundled, but not actually re-exported from any @wix/patterns entry point — likely a manifest or upstream export gap. Do not recommend importing this."
+    "statusMessage": "Read this file for the props it declares — they are real props of the components that extend it. The name itself is bundled deliberately and is exported from no @wix/patterns entry point, so never write an import for it; import the component instead."
   },
   "BulkActionModalRenderPropParams": {
     "kind": "type",
@@ -816,7 +843,7 @@
     "file": "types/BulkActionModalRenderPropParams.d.ts",
     "bytes": 2109,
     "status": "unreachable",
-    "statusMessage": "Bundled, but not actually re-exported from any @wix/patterns entry point — likely a manifest or upstream export gap. Do not recommend importing this."
+    "statusMessage": "Read this file for the props it declares — they are real props of the components that extend it. The name itself is bundled deliberately and is exported from no @wix/patterns entry point, so never write an import for it; import the component instead."
   },
   "RangeItem": {
     "kind": "type",
@@ -841,7 +868,25 @@
     "category": null,
     "importPath": "@wix/patterns",
     "file": "types/CursorQuery.d.ts",
-    "bytes": 2507,
+    "bytes": 1848,
+    "status": null,
+    "statusMessage": null
+  },
+  "OffsetQuery": {
+    "kind": "type",
+    "category": null,
+    "importPath": "@wix/patterns",
+    "file": "types/OffsetQuery.d.ts",
+    "bytes": 1848,
+    "status": null,
+    "statusMessage": null
+  },
+  "DataResultRaw": {
+    "kind": "type",
+    "category": "Common/Types",
+    "importPath": "@wix/patterns/core",
+    "file": "types/DataResultRaw.d.ts",
+    "bytes": 994,
     "status": null,
     "statusMessage": null
   }

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

@@ -1,5 +1,5 @@
-import React$1, { ReactElement, ReactNode, ComponentType, ForwardRefExoticComponent } from 'react';
-import { MessageModalLayoutProps, TableProps } from '@wix/design-system';
+import React$1, { ReactElement, ReactNode, ComponentType, ForwardRefExoticComponent, CSSProperties } from 'react';
+import { MessageModalLayoutProps, TableProps, TableColumn as TableColumn$2 } from '@wix/design-system';
 import { TableColumn as TableColumn$1 } from '@wix/design-system/dist/types/Table';
 import { TableDragAndDrop } from '@wix/wix-style-react-incubator/drag-and-drop';
 
@@ -11,6 +11,34 @@ 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;
+};
+
 /**
  * `WixPatternsContainer` — you receive this, you don't construct it.
  * Produced by `useWixPatternsContainer()` (also `buildWixPatternsContainer()`, `useCustomFieldsViewWidget()`).
@@ -66,6 +94,14 @@ type FiltersMap = {
     [key: string]: Filter<any> | undefined;
 };
 
+type SortOrder = 'asc' | 'desc';
+type SortOrderWithNone = SortOrder | undefined;
+/**
+ * @deprecated always option is deprecated
+ */
+type SortModeDeprecated = 'always';
+type SortMode = SortModeDeprecated | SortOrderWithNone[];
+
 /**
  * `ComputedQuery` — cut here because it has its own bundle.
  * Look `ComputedQuery` up in the bundle index for its full shape.
@@ -83,6 +119,13 @@ interface KeyedItem<T> {
     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';
+
 interface ActionCellAPI$1<T, F extends FiltersMap> {
     openConfirmModal: (props?: Partial<MessageModalLayoutProps>) => void;
     openConfirmDeleteModal: (props?: Partial<MessageModalLayoutProps>) => void;
@@ -289,11 +332,120 @@ declare const DataExtension: React.FC<DataExtensionProps> & DataExtensionObjectT
 type DataExtensionElement = ReactElement<DataExtensionProps, typeof DataExtension>;
 type DataExtensionType = typeof DataExtension;
 
+type TableColumnBase<T = any> = Omit<TableColumn$2<T>, 'sortDescending' | 'sortable' | 'infoTooltipProps' | 'style' | 'titleSuffix'> & {
+    style?: CSSProperties | ((column: TableColumn$2, rowData: KeyedItem<T>, rowNum: number) => CSSProperties);
+    reorderDisabled?: boolean;
+    defaultSortOrder?: SortOrder;
+    sortMode?: SortMode;
+    searchable?: boolean;
+    infoTooltipProps?: TableColumn$2['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 = any> = Record<string, unknown>;
+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';
+};
 
 interface CollectionTableBaseProps<T, F extends FiltersMap> extends Omit<CollectionTableWSRTableBaseProps<T, T, F>, 'resizable'>, CollectionTableActionCellProps<T, F> {
     /**

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

@@ -198,7 +198,7 @@ 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 = any> = Record<string, unknown>;
+type TableColumn<T = any> = CustomColumnConfig<T> & SortableConfig<T>;
 type ColumnMobileConfig = {
     /**
      * Which mobile column to display in.

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

@@ -20,37 +20,19 @@ interface ComputedQuery<F = any> {
     [key: string]: unknown;
 }
 
-interface DataResultRaw<T> {
-    /**
-     * Array of items returned from the server.
-     * @external
-     */
-    items: T[];
-    /**
-     * Total items available in the server, *after* applying filters. If not provided, offset pagination will not work correctly.
-     * If you are using a cursor and did not include `total` in your query request, you can use the `fetchTotal` function to extract it asynchronously.
-     * @default `items.length`
-     * @external
-     */
-    total?: number | null;
-    /**
-     * Total items available in the server, *before* applying filters.
-     * @external
-     */
-    available?: number;
-    /**
-     * In case of cursor pagination, this will be the value that will be sent in the query on the next page request.
-     * @external
-     */
-    cursor?: string | undefined | null;
-    /**
-     * Indicates whether there are more items available after the current page.
-     * @external
-     */
-    hasNext?: boolean | null;
+/**
+ * `DataResultRaw` — cut here because it has its own bundle.
+ * Look `DataResultRaw` up in the bundle index for its full shape.
+ */
+interface DataResultRaw<T = any> {
+    [key: string]: unknown;
 }
 
-type OffsetQuery<F extends FiltersMap = OptionalFiltersMap> = Omit<ComputedQuery<F>, 'cursor'>;
+/**
+ * `OffsetQuery` — cut here because it has its own bundle.
+ * Look `OffsetQuery` up in the bundle index for its full shape.
+ */
+type OffsetQuery<F = any> = Omit<ComputedQuery<F>, 'cursor'>;
 type OffsetQueryResult<T> = Omit<DataResultRaw<T>, 'cursor'>;
 type OffsetFetchDataFn<T, F extends FiltersMap> = (query: OffsetQuery<F>) => Promise<OffsetQueryResult<T>>;
 type CursorQueryResult<T> = Omit<DataResultRaw<T>, 'cursor'> & {

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

@@ -0,0 +1,31 @@
+interface DataResultRaw<T> {
+    /**
+     * Array of items returned from the server.
+     * @external
+     */
+    items: T[];
+    /**
+     * Total items available in the server, *after* applying filters. If not provided, offset pagination will not work correctly.
+     * If you are using a cursor and did not include `total` in your query request, you can use the `fetchTotal` function to extract it asynchronously.
+     * @default `items.length`
+     * @external
+     */
+    total?: number | null;
+    /**
+     * Total items available in the server, *before* applying filters.
+     * @external
+     */
+    available?: number;
+    /**
+     * In case of cursor pagination, this will be the value that will be sent in the query on the next page request.
+     * @external
+     */
+    cursor?: string | undefined | null;
+    /**
+     * Indicates whether there are more items available after the current page.
+     * @external
+     */
+    hasNext?: boolean | null;
+}
+
+export type { DataResultRaw };