@wix/patterns 1.464.0 → 1.466.0

package/dist/docs/withDashboard.md

@@ -0,0 +1,84 @@
+# withDashboard
+
+**Category:** Base Components/Pages/Router
+
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
+## Design
+
+### Description
+
+`withDashboard` is the higher-order component that renders bex-core's dashboard
+context around a page. Patterns components read the current page location out of
+that context, so wrapping the page is not optional for any of them that route.
+
+### Requirements
+
+`PatternsReactRouter` reads the current page location through
+`container.usePageLocation()`. That value comes from the dashboard context,
+which is rendered **only** by `withDashboard`, from its `location` prop.
+`WixPatternsProvider` does not supply it — the provider's own
+`environment.pageLocation` feeds the container's `componentId`, not this hook.
+
+Without `withDashboard` above the router, `usePageLocation()` returns
+`undefined` and the router throws:
+
+> It appears that `PatternsReactRouter` is being used incorrectly. Please refer
+> to the documentation to ensure proper implementation.
+
+Nothing catches this before runtime — type checking and bundling both pass,
+because neither renders the page.
+
+### Supplying `location`
+
+The component `withDashboard()` returns takes a `location` prop, and it is the
+host's job to pass it.
+
+Under **Yoshi BM flow** the host passes `location` to your page component, so
+`export default withDashboard(MyPage)` is enough.
+
+In a **Wix CLI app** nothing passes props to the dashboard page component, so
+you must supply `location` yourself from the dashboard SDK. Read it from
+`dashboard.observeState`, and render the wrapped page once it arrives — the
+prop is required, so there is nothing to render before the first callback:
+
+```tsx
+import { useEffect, useState } from 'react';
+import { dashboard, type PageLocation } from '@wix/dashboard';
+import { WixDesignSystemProvider } from '@wix/design-system';
+
+export default function Page() {
+  const [location, setLocation] = useState<PageLocation>();
+
+  useEffect(() => {
+    const subscription = dashboard.observeState((_pageParams, environment) => {
+      setLocation(environment.pageLocation);
+    });
+
+    return () => subscription.disconnect();
+  }, []);
+
+  return (
+    <WixDesignSystemProvider>
+      {location ? <App location={location} /> : null}
+    </WixDesignSystemProvider>
+  );
+}
+```
+
+`App` here is the wrapped page — `withDashboard(() => …)` around
+`WixPatternsProvider` and the routes. See
+[`PatternsReactRouter`](./?path=%2Fstory%2Fbase-components-pages-router--patternsreactrouter)
+for that half.
+
+
+```tsx
+import { withDashboard } from '@wix/patterns';
+```
+
+## API
+
+### Props
+
+Read `dist/dts-bundle/functions/withDashboard.d.ts` for `withDashboard`'s props.
+

package/dist/dts-bundle/components/EntityPage.d.ts

@@ -223,7 +223,7 @@ interface FormPageAdditionalContentProps {
 
 /**
  * `EntityPageState` — you receive this, you don't construct it.
- * Produced by `useEntityPage()` (also `useEntityPageContext()`).
+ * Produced by `useEntityPage()` (also `useEntityPageContext()`). Look `EntityPageState` up in the bundle index for its own API.
  */
 declare class EntityPageState<T = any, V = any> {
     [key: string]: unknown;

package/dist/dts-bundle/components/Grid.d.ts

@@ -281,7 +281,11 @@ type ActionCellAPI<T, F extends FiltersMap> = ActionCellAPI$1<T, F>;
 interface ActionCellProps {
     [key: string]: unknown;
 }
-type ActionCell<T, F extends FiltersMap> = ActionCellProps | ((item: T, index: number, api: ActionCellAPI<T, F>) => ActionCellProps);
+/**
+ * `ActionCell` — cut here because it has its own bundle.
+ * Look `ActionCell` up in the bundle index for its full shape.
+ */
+type ActionCell<T = any, F = any> = ActionCellProps | ((item: T, index: number, api: ActionCellAPI<T, F>) => ActionCellProps);
 
 type BulkActionToolbarRenderProp<T, F extends FiltersMap> = (props: {
     selectedValues: T[];

package/dist/dts-bundle/components/GridFolders.d.ts

@@ -44,7 +44,11 @@ type ActionCellAPI<T, F extends FiltersMap> = ActionCellAPI$1<T, F>;
 interface ActionCellProps {
     [key: string]: unknown;
 }
-type ActionCell<T, F extends FiltersMap> = ActionCellProps | ((item: T, index: number, api: ActionCellAPI<T, F>) => ActionCellProps);
+/**
+ * `ActionCell` — cut here because it has its own bundle.
+ * Look `ActionCell` up in the bundle index for its full shape.
+ */
+type ActionCell<T = any, F = any> = ActionCellProps | ((item: T, index: number, api: ActionCellAPI<T, F>) => ActionCellProps);
 
 /**
  * `ToolbarCollectionBaseProps` — cut here because it has its own bundle.

package/dist/dts-bundle/components/TableFolders.d.ts

@@ -88,7 +88,11 @@ type ActionCellAPI<T, F extends FiltersMap> = ActionCellAPI$1<T, F>;
 interface ActionCellProps {
     [key: string]: unknown;
 }
-type ActionCell<T, F extends FiltersMap> = ActionCellProps | ((item: T, index: number, api: ActionCellAPI<T, F>) => ActionCellProps);
+/**
+ * `ActionCell` — cut here because it has its own bundle.
+ * Look `ActionCell` up in the bundle index for its full shape.
+ */
+type ActionCell<T = any, F = any> = ActionCellProps | ((item: T, index: number, api: ActionCellAPI<T, F>) => ActionCellProps);
 
 type MultiCollectionBulkActionToolbarRenderProps = (props: {
     readonly allSelected: boolean;

package/dist/dts-bundle/components/TableGridSwitch.d.ts

@@ -222,7 +222,11 @@ type ActionCellAPI<T, F extends FiltersMap> = ActionCellAPI$1<T, F>;
 interface ActionCellProps {
     [key: string]: unknown;
 }
-type ActionCell<T, F extends FiltersMap> = ActionCellProps | ((item: T, index: number, api: ActionCellAPI<T, F>) => ActionCellProps);
+/**
+ * `ActionCell` — cut here because it has its own bundle.
+ * Look `ActionCell` up in the bundle index for its full shape.
+ */
+type ActionCell<T = any, F = any> = ActionCellProps | ((item: T, index: number, api: ActionCellAPI<T, F>) => ActionCellProps);
 
 interface CtaBaseProps {
     /**

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

@@ -1,3 +1,4 @@
+export type { ActionCell } from '../types/ActionCell';
 export type { ActionCellProps } from '../types/ActionCellProps';
 export type { ActionSubitem } from '../types/ActionSubitem';
 export { AutoCompleteFilter } from '../components/AutoCompleteFilter';
@@ -13,6 +14,7 @@ export type { ComputedQuery } from '../types/ComputedQuery';
 export type { CursorQuery } from '../types/CursorQuery';
 export { DateRangeFilter } from '../components/DateRangeFilter';
 export { EntityPage } from '../components/EntityPage';
+export type { EntityPageState } from '../types/EntityPageState';
 export type { EntityPageStateParams } from '../types/EntityPageStateParams';
 export { ExportButton } from '../components/ExportButton';
 export type { Filter } from '../types/Filter';

package/dist/dts-bundle/hooks/useEntity.d.ts

@@ -2,7 +2,7 @@ import { FieldValues } from 'react-hook-form';
 
 /**
  * `EntityPageState` — you receive this, you don't construct it.
- * Produced by `useEntityPage()` (also `useEntityPageContext()`).
+ * Produced by `useEntityPage()` (also `useEntityPageContext()`). Look `EntityPageState` up in the bundle index for its own API.
  */
 declare class EntityPageState<T = any, V = any> {
     [key: string]: unknown;

package/dist/dts-bundle/hooks/useEntityPage.d.ts

@@ -32,6 +32,9 @@ interface BaseField {
         numberRange?: NumberRange;
         stringLengthRange?: StringLengthRange;
         specificValues?: SpecificValue[];
+        /** Regular expression source the value must match. Applies to text-like
+         *  fields only; mutually exclusive with `specificValues`. */
+        pattern?: string;
         required: boolean;
     };
     capabilities?: {
@@ -909,7 +912,7 @@ interface EntityPageStateParamsBase<T, V extends FieldValues = FieldValues> {
 type EntityPageStateParams<T = any, V = any> = EntityPageStateParamsBase<T, V>;
 /**
  * `EntityPageState` — you receive this, you don't construct it.
- * Produced by `useEntityPage()` (also `useEntityPageContext()`).
+ * Produced by `useEntityPage()` (also `useEntityPageContext()`). Look `EntityPageState` up in the bundle index for its own API.
  */
 declare class EntityPageState<T = any, V = any> {
     [key: string]: unknown;

package/dist/dts-bundle/hooks/useEntityPageContext.d.ts

@@ -3,7 +3,7 @@ import { FieldValues } from 'react-hook-form';
 
 /**
  * `EntityPageState` — you receive this, you don't construct it.
- * Produced by `useEntityPage()` (also `useEntityPageContext()`).
+ * Produced by `useEntityPage()` (also `useEntityPageContext()`). Look `EntityPageState` up in the bundle index for its own API.
  */
 declare class EntityPageState<T = any, V = any> {
     [key: string]: unknown;

package/dist/dts-bundle/hooks/usePickerModal.d.ts

@@ -213,6 +213,9 @@ type Translate = {
         currentNumber: number;
         totalNumber: number;
     }): string;
+    (key: 'cairo.editableTable.field.validation.pattern', params: {
+        fieldName: string;
+    }): string;
     (key: 'cairo.import.summaryCounts', params: {
         succeeded: string;
         failed: string;

package/dist/dts-bundle/index.json

@@ -58,7 +58,7 @@
     "category": "Base Components/Pages/Entity Page",
     "importPath": "@wix/patterns",
     "file": "components/EntityPage.d.ts",
-    "bytes": 9681,
+    "bytes": 9744,
     "status": null,
     "statusMessage": null
   },
@@ -94,7 +94,7 @@
     "category": "Base Components/Collections/Grid/Grid",
     "importPath": "@wix/patterns",
     "file": "components/Grid.d.ts",
-    "bytes": 16118,
+    "bytes": 16243,
     "status": null,
     "statusMessage": null
   },
@@ -103,7 +103,7 @@
     "category": "Base Components/Collections/TableGridSwitch/TableGridSwitch",
     "importPath": "@wix/patterns",
     "file": "components/TableGridSwitch.d.ts",
-    "bytes": 22655,
+    "bytes": 22780,
     "status": null,
     "statusMessage": null
   },
@@ -112,7 +112,7 @@
     "category": "Base Components/Collections/TableFolders/TableFolders",
     "importPath": "@wix/patterns",
     "file": "components/TableFolders.d.ts",
-    "bytes": 14368,
+    "bytes": 14493,
     "status": null,
     "statusMessage": null
   },
@@ -121,7 +121,7 @@
     "category": "Base Components/Collections/GridFolders/GridFolders",
     "importPath": "@wix/patterns",
     "file": "components/GridFolders.d.ts",
-    "bytes": 7887,
+    "bytes": 8012,
     "status": null,
     "statusMessage": null
   },
@@ -145,7 +145,7 @@
   },
   "withDashboard": {
     "kind": "function",
-    "category": null,
+    "category": "Base Components/Pages/Router",
     "importPath": "@wix/patterns",
     "file": "functions/withDashboard.d.ts",
     "bytes": 336,
@@ -508,7 +508,7 @@
     "category": "Base Components/Pages/Entity Page/Hooks/useEntityPage",
     "importPath": "@wix/patterns",
     "file": "hooks/useEntityPage.d.ts",
-    "bytes": 37181,
+    "bytes": 37421,
     "status": null,
     "statusMessage": null
   },
@@ -517,7 +517,7 @@
     "category": "Base Components/Pages/Entity Page/Hooks/useEntityPageContext",
     "importPath": "@wix/patterns",
     "file": "hooks/useEntityPageContext.d.ts",
-    "bytes": 778,
+    "bytes": 841,
     "status": null,
     "statusMessage": null
   },
@@ -526,7 +526,7 @@
     "category": "Base Components/Pages/Entity Page/Hooks/useEntity",
     "importPath": "@wix/patterns",
     "file": "hooks/useEntity.d.ts",
-    "bytes": 401,
+    "bytes": 464,
     "status": null,
     "statusMessage": null
   },
@@ -535,7 +535,7 @@
     "category": "Base Components/Collections/Picker/Hooks",
     "importPath": "@wix/patterns",
     "file": "hooks/usePickerModal.d.ts",
-    "bytes": 26304,
+    "bytes": 26415,
     "status": null,
     "statusMessage": null
   },
@@ -697,7 +697,7 @@
     "category": null,
     "importPath": "@wix/patterns/core",
     "file": "types/OnSaveParams.d.ts",
-    "bytes": 36753,
+    "bytes": 36993,
     "status": null,
     "statusMessage": null
   },
@@ -706,7 +706,7 @@
     "category": null,
     "importPath": "@wix/patterns",
     "file": "types/UseEntityPageParams.d.ts",
-    "bytes": 37053,
+    "bytes": 37293,
     "status": null,
     "statusMessage": null
   },
@@ -715,7 +715,16 @@
     "category": null,
     "importPath": "@wix/patterns",
     "file": "types/EntityPageStateParams.d.ts",
-    "bytes": 36719,
+    "bytes": 36959,
+    "status": null,
+    "statusMessage": null
+  },
+  "EntityPageState": {
+    "kind": "type",
+    "category": "Base Components/Pages/Entity Page/State",
+    "importPath": "@wix/patterns",
+    "file": "types/EntityPageState.d.ts",
+    "bytes": 43043,
     "status": null,
     "statusMessage": null
   },
@@ -724,7 +733,7 @@
     "category": null,
     "importPath": "@wix/patterns",
     "file": "types/Column.d.ts",
-    "bytes": 11590,
+    "bytes": 11767,
     "status": null,
     "statusMessage": null
   },
@@ -760,7 +769,16 @@
     "category": "Features/Actions/Action Cell",
     "importPath": "@wix/patterns",
     "file": "types/ActionCellProps.d.ts",
-    "bytes": 5643,
+    "bytes": 5768,
+    "status": null,
+    "statusMessage": null
+  },
+  "ActionCell": {
+    "kind": "type",
+    "category": null,
+    "importPath": "@wix/patterns",
+    "file": "types/ActionCell.d.ts",
+    "bytes": 2241,
     "status": null,
     "statusMessage": null
   },
@@ -807,7 +825,8 @@
     "file": "types/ToolbarCollectionBaseProps.d.ts",
     "bytes": 36933,
     "status": "unreachable",
-    "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."
+    "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.",
+    "unexported": true
   },
   "ToolbarBaseProps": {
     "kind": "type",
@@ -816,16 +835,18 @@
     "file": "types/ToolbarBaseProps.d.ts",
     "bytes": 4011,
     "status": "unreachable",
-    "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."
+    "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.",
+    "unexported": true
   },
   "CollectionTableBaseProps": {
     "kind": "type",
     "category": null,
     "importPath": null,
     "file": "types/CollectionTableBaseProps.d.ts",
-    "bytes": 20677,
+    "bytes": 20802,
     "status": "unreachable",
-    "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."
+    "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.",
+    "unexported": true
   },
   "CollectionViewsDropdownBaseProps": {
     "kind": "type",
@@ -834,7 +855,8 @@
     "file": "types/CollectionViewsDropdownBaseProps.d.ts",
     "bytes": 6403,
     "status": "unreachable",
-    "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."
+    "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.",
+    "unexported": true
   },
   "BulkActionModalRenderPropParams": {
     "kind": "type",
@@ -843,7 +865,8 @@
     "file": "types/BulkActionModalRenderPropParams.d.ts",
     "bytes": 2109,
     "status": "unreachable",
-    "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."
+    "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.",
+    "unexported": true
   },
   "RangeItem": {
     "kind": "type",

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

@@ -0,0 +1,63 @@
+import { MessageModalLayoutProps, TableActionCellSecondaryAction, TableActionCellSecondaryDivider, TableActionCellMainAction as TableActionCellMainAction$1, TableActionCellPrimaryAction as TableActionCellPrimaryAction$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;
+}
+
+/**
+ * `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;
+}
+
+interface ActionCellAPI$1<T, F extends FiltersMap> {
+    openConfirmModal: (props?: Partial<MessageModalLayoutProps>) => void;
+    openConfirmDeleteModal: (props?: Partial<MessageModalLayoutProps>) => void;
+    collection: CollectionState<T, F>;
+    keyedItem: KeyedItem<T>;
+}
+
+type SecondaryActionAction = TableActionCellSecondaryAction & {
+    biName?: string;
+    componentId?: string;
+    appId?: string;
+    divider?: false;
+};
+type SecondaryAction = SecondaryActionAction | TableActionCellSecondaryDivider;
+type ActionCellAPI<T, F extends FiltersMap> = ActionCellAPI$1<T, F>;
+type TableActionCellMainAction = TableActionCellMainAction$1 & {
+    biName?: string;
+    disabledMessage?: string;
+};
+type TableActionCellPrimaryAction = TableActionCellPrimaryAction$1 & {
+    biName?: string;
+    disabledMessage?: string;
+};
+/**
+ * `ActionCellProps` — cut here because it has its own bundle.
+ * Look `ActionCellProps` up in the bundle index for its full shape.
+ */
+interface ActionCellProps {
+    [key: string]: unknown;
+}
+type ActionCell<T, F extends FiltersMap> = ActionCellProps | ((item: T, index: number, api: ActionCellAPI<T, F>) => ActionCellProps);
+
+export type { ActionCell, ActionCellAPI, ActionCellProps, SecondaryAction, SecondaryActionAction, TableActionCellMainAction, TableActionCellPrimaryAction };

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

@@ -108,6 +108,10 @@ interface ActionCellProps extends Omit<TableActionCellProps, 'primaryAction' | '
      */
     containerId?: string;
 }
-type ActionCell<T, F extends FiltersMap> = ActionCellProps | ((item: T, index: number, api: ActionCellAPI<T, F>) => ActionCellProps);
+/**
+ * `ActionCell` — cut here because it has its own bundle.
+ * Look `ActionCell` up in the bundle index for its full shape.
+ */
+type ActionCell<T = any, F = any> = ActionCellProps | ((item: T, index: number, api: ActionCellAPI<T, F>) => ActionCellProps);
 
 export type { ActionCell, ActionCellAPI, ActionCellProps, SecondaryAction, SecondaryActionAction, TableActionCellMainAction, TableActionCellPrimaryAction };

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

@@ -155,7 +155,11 @@ type ActionCellAPI<T, F extends FiltersMap> = ActionCellAPI$1<T, F>;
 interface ActionCellProps {
     [key: string]: unknown;
 }
-type ActionCell<T, F extends FiltersMap> = ActionCellProps | ((item: T, index: number, api: ActionCellAPI<T, F>) => ActionCellProps);
+/**
+ * `ActionCell` — cut here because it has its own bundle.
+ * Look `ActionCell` up in the bundle index for its full shape.
+ */
+type ActionCell<T = any, F = any> = ActionCellProps | ((item: T, index: number, api: ActionCellAPI<T, F>) => ActionCellProps);
 
 /**
  * `MoreActionsItem` — cut here because it has its own bundle.

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

@@ -31,6 +31,9 @@ interface BaseField {
         numberRange?: NumberRange;
         stringLengthRange?: StringLengthRange;
         specificValues?: SpecificValue[];
+        /** Regular expression source the value must match. Applies to text-like
+         *  fields only; mutually exclusive with `specificValues`. */
+        pattern?: string;
         required: boolean;
     };
     capabilities?: {