@wix/patterns 1.467.0 → 1.469.0

package/dist/docs/operatorFilter.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## Design
 
 ### Usage

package/dist/docs/stringFilter.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## Design
 
 ### Usage

package/dist/docs/stringsArrayFilter.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## Design
 
 ### Usage

package/dist/docs/useAmbassadorCollection.md

@@ -2,6 +2,10 @@
 
 **Category:** Common/Hooks
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
+Some of that scaffolding is environment-scoped and is **not** needed to use this component: `@wix/ambassador-ecom-v1-order/crud/http`. Those resolve only against a Wix build environment (a Yoshi flow's runtime, a generated service client, an internal sibling package) — substitute your own data source and http client rather than installing them.
+
 ## API
 
 ### Overview

package/dist/docs/useCollection.md

@@ -2,6 +2,10 @@
 
 **Category:** Common/Hooks
 
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## API
 
 ### Overview
@@ -55,23 +59,5 @@ export default ItemCount;
 
 ### Props
 
-| Prop | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `paginationMode` | `"cursor" \| "offset"` | No | `offset` | Pagination type supported by `fetchData`. <br> <br> Supported values: <br> - `"offset"`: Server accepts `query.offset`. <br> - `"cursor"`: Server returns a cursor when `fetchData` is called. |
-| `fetchData` | `(query: ComputedQuery<F>) => Promise<DataResultRaw<T>>` | Yes | - | Function that fetches the collection data.<br> <br> Supported parameters: <br> - `query`: [object] [ComputedQuery](./com?path=/story/common-models--computedquery) instance. <br> <br> Must return a [DataResultRaw](./?path=/story/common-models--dataresultraw) Promise. |
-| `fetchTotal` | `FetchTotalFn` | No | - | A function that fetches the total number of items in the collection.<br> <br> Supported parameters: <br> - `query`: [object] [ComputedQuery](./com?path=/story/common-models--computedquery) of type `CursorQuery`. <br> <br> Must return a number Promise. |
-| `filters` | `FiltersMap` | Yes | - | Defines the filters that the collection supports. <br> <br> Either an [arrayFilter](./?path=/story/features-filter-factories--arrayfilter) or a [customFilter](./?path=/story/features-filter-factories--customfilter). |
-| `itemName` | `(item: T) => string` | Yes | - | Used to identify the item in many messages from Wix Patterns. <br> <br> For example, '{entity} "{itemName}" was deleted successfully' may become 'Contact "Johnny Doe" was deleted successfully'. <br> <br> If your data has an ID, then `itemKey` will default to this ID. |
-| `itemKey` | `(item: T) => string` | Yes | - | Unique key within the collection. The item's ID is often used for its key. <br> <br> If your data has an ID, then `itemKey` will default to this ID. |
-| `limit` | `number` | No | - | Maximum number of items fetched per page. |
-| `disableAutoSelectAllCount` | `boolean` | No | - | Whether to disable "Select All" server simulation for bulk selection. |
-| `useNewSelectAllLogic` | `boolean` | No | - | Whether to enable new "Select All" logic. <br> <br> If `true`: <br> - Unchecking items after checking "Select All" does not fallback to specific selection logic and values. This means in `<bulkActionToolbar />` and `<MultiBulkActionToolbar />`, "Total Selected" will show `total - unchecked items` and `isSelectAll` will be true. <br> - You will receive a list of unchecked IDs. |
-| `queryName` | `string` | Yes | - | Unique value for each API endpoint consumed in `fetchData`. |
-| `fqdn` | `string` | No | - | Entity fqdn. |
-| `toExtendedFields` | `((item: T) => ExtendedFields \| null)` | No | - | The `ExtendedFields` object used to render custom field values Optional in case your data complies to the type `{ extendedFields: ExtendedFields }` |
-| `fetchErrorMessage` | `((params: { err: unknown; isOnline: boolean; }) => string \| null)` | No | - | Message shown in a toast when fetching from the server fails. <br> <br> If the function returns a nullish value, no toast is shown. @deprecated Instead of using `fetchErrorMessage`, use `errorState` prop in the component, which will show the error message in the card. |
-| `persistQueryToUrl` | `boolean` | No | `false` | Persist the selected filters, search & sort in the query parameters of the URL.<br/> For improved readability, sort & columns are formatted in CSV-like formatting, i.e "?sort=name+desc,price+asc". Do not use commas and/or spaces for your columns IDs.<br> Note: The filters from the selected view will be persist, but the actual view will not be selected |
-| `refreshOnColumnsChange` | `boolean` | No | `false` | Whether the collection refreshes when different columns are selected. <br> <br> Selected columns are passed in `fetchData(query.columns)`. |
-| `selectionConsistencyMode` | `"clear" \| "preserve"` | No | `preserve` | Preserve or clear selection after applying a new search or filter. |
-| `events` | `CollectionEvents<F>` | No | - | Optional callbacks for various events of the collection state lifecycle - `onInitialPageFetched` - when the first page of items is ready - `onSearch` - when fetching new items as a result new search - `onSearchResults` - when the result of a search is ready - `onNewPageStart` - when starting to load the next page of items - `onNewPageAdded` - when the result of the next page is ready - `onError` - When `fetchData` throws an error. Return `true` from this function if the error was reported and shouldn't be reported again internally. |
+Read `dist/dts-bundle/hooks/useCollection.d.ts` for `useCollection`'s props.
 

package/dist/docs/useEntity.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## API
 
 ### Overview

package/dist/docs/useEntityPage.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## API
 
 ### Overview
@@ -109,7 +111,7 @@ page, panel, or outer route you reached it through — a router mounted on a pag
 named "shifts" still roots itself at `path="/"`. Repeating "shifts" in the path
 below is the single most common way this example gets copied wrong. See [Patterns
 Router Overview → Paths are relative to where the router is
-mounted](./?path=/story/base-components-pages-routing--routingoverview).
+mounted](./?path=/story/base-components-pages-router--overview).
 
 
 ```tsx
@@ -236,6 +238,44 @@ want when each route mounts its own page. Pass the getter form —
 page survives the route change instead.
 
 
+### After a save
+
+`onSave` resolving is not the end of the flow. The page then acts on its own, and the
+question this answers — *does the collection I came from now know about this?* — has a
+definite yes, so nothing here is for you to wire.
+
+1. **The success toast**, from `saveSuccessToast`; none if you passed none.
+2. **It navigates back to the parent** — `parentPath` under Patterns Router, `parentPageId`
+   otherwise. There is no navigate call for you to make on success.
+3. **It hands the saved entity to that parent** in router state, under `_createdEntity` or
+   `_updatedEntity`. Which one is `isNewEntity`'s doing, falling back to whether `fetch`
+   loaded an entity — the [Create route](./?path=/story/base-components-pages-entity-page-hooks-useentitypage--useentitypage)
+   section covers why that matters. `transformEntityToCollectionItem` shapes what is handed
+   over, and defaults to passing the entity through; give it a function when the collection's
+   row type is not the entity type.
+4. **The collection applies it with no refetch.** Every collection hook is built on the same
+   cached-state layer, and that layer listens for both keys: a create is added to the
+   collection, an update replaces the row in place. A collection page you navigated from is
+   already wired for this.
+
+So a saved record shows up in the list on its own. Adding a refetch on return, or reaching
+for `clearResultAndMoveToStart`, re-runs the query this is designed to avoid — and on a
+create it also re-sorts the row you just added away from where the user is looking.
+
+## It will not let the list lie
+
+Applying the change to a collection and the change actually belonging in that collection are
+different things: a new record can fail the filters in force, and an edited one can sort
+somewhere else. So about three seconds after applying it, the collection re-queries and
+checks. For a create it asks whether the new item really is the first row the current query
+returns; for an update, whether the row is still at the index it occupied. If the answer is
+no, the user gets a "view updated" toast offering a reload, instead of a list quietly
+showing a row in a place the query would never have put it.
+
+A created row appearing at the top and *then* being offered a reload is therefore both
+halves working — not a double-render to suppress.
+
+
 ### Props
 
 Read `dist/dts-bundle/hooks/useEntityPage.d.ts` for `useEntityPage`'s props.

package/dist/docs/useEntityPageContext.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## API
 
 ### Overview

package/dist/docs/useFilterCollection.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## Design
 
 ### Overview

package/dist/docs/useGridCollection.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## API
 
 ### Description

package/dist/docs/useGridFolders.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## API
 
 ### Description

package/dist/docs/useItemsSelectionFilter.md

@@ -2,6 +2,8 @@
 
 **Category:** Common/hooks
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## Design
 
 ### Description

package/dist/docs/useNestedTable.md

@@ -2,6 +2,10 @@
 
 **Category:** Base Components/Collections/NestedTable
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
+Some of that scaffolding is environment-scoped and is **not** needed to use this component: `@wix/ambassador-contacts-v4-contact/http`, `@wix/ambassador-contacts-v4-contact/types`, `@wix/yoshi-flow-bm`. Those resolve only against a Wix build environment (a Yoshi flow's runtime, a generated service client, an internal sibling package) — substitute your own data source and http client rather than installing them.
+
 ## API
 
 ### Description

package/dist/docs/useOptimisticActions.md

@@ -4,6 +4,10 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
+Some of that scaffolding is environment-scoped and is **not** needed to use this component: `@wix/ambassador-contacts-v4-contact/http`, `@wix/ambassador-contacts-v4-contact/types`, `@wix/yoshi-flow-bm`. Those resolve only against a Wix build environment (a Yoshi flow's runtime, a generated service client, an internal sibling package) — substitute your own data source and http client rather than installing them.
+
 ## Design
 
 ### Description
@@ -85,46 +89,46 @@ import { useOptimisticActions } from '@wix/patterns';
 
 Default behaviour of create, update and delete.
 
-Example code: read `dist/docs/useOptimisticActions/default-behaviour.tsx`
+Example code: read `dist/examples/useOptimisticActions/default-behaviour.tsx`
 
 ### Success toast with undo
 
 You have the option to postpone the server request, giving the user a few seconds to regret using "Undo" button. 
  You can also show a toast after the undo action with `showUndoSuccessToast`
 
-Example code: read `dist/docs/useOptimisticActions/success-toast-with-undo.tsx`
+Example code: read `dist/examples/useOptimisticActions/success-toast-with-undo.tsx`
 
 ### Error handling and retries
 
 In case of an error from the server, you can define what to show the user and what to do during it. 
  Additionally, you can allow the user the option to try to execute the action again
 
-Example code: read `dist/docs/useOptimisticActions/error-handling-and-retries.tsx`
+Example code: read `dist/examples/useOptimisticActions/error-handling-and-retries.tsx`
 
 ### Items orders
 
 You can decide the orders of the item with `OrdeyBy`
 
-Example code: read `dist/docs/useOptimisticActions/items-orders.tsx`
+Example code: read `dist/examples/useOptimisticActions/items-orders.tsx`
 
 ### Update with query
 
 When you update the data when query exists (filters, search) you need to define `predicate` and `orderBy` in order to update the relevant items.
  In this example, try to update the filtered items, remove the filters and see that only the filtered items were updated.
 
-Example code: read `dist/docs/useOptimisticActions/update-with-query.tsx`
+Example code: read `dist/examples/useOptimisticActions/update-with-query.tsx`
 
 ### Revision handling
 
 In case your server works with revision, you can need to update the revision by yourself
 
-Example code: read `dist/docs/useOptimisticActions/revision-handling.tsx`
+Example code: read `dist/examples/useOptimisticActions/revision-handling.tsx`
 
 ### Custom error handling
 
 You can define your own error handling wirh errorToast prop
 
-Example code: read `dist/docs/useOptimisticActions/custom-error-handling.tsx`
+Example code: read `dist/examples/useOptimisticActions/custom-error-handling.tsx`
 
 ## API
 

package/dist/docs/usePatternsNavigate.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## Design
 
 ### Description
@@ -13,7 +15,7 @@ The `usePatternsNavigate` hook provides functions to navigate between pages in a
 > **`path` is relative to the router's own mount point**, not to whatever host
 > page, panel, or outer route you reached it through. Never re-prefix it with
 > that outer name; see [Patterns Router Overview → Paths are relative to where
-> the router is mounted](./?path=/story/base-components-pages-routing--routingoverview).
+> the router is mounted](./?path=/story/base-components-pages-router--overview).
 
 ### Usage
 
@@ -58,7 +60,7 @@ It takes the path of the entity page, and the entity as arguments:
               path: `/${item.id}`,
               entity: item,
             }),
-          icon: <Edit />,
+          prefixIcon: <Edit />,
         }
       }
    }}

package/dist/docs/usePickerContent.md

@@ -2,6 +2,8 @@
 
 **Category:** Base Components/Collections/Picker/Hooks
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## API
 
 ### Description

package/dist/docs/usePickerModal.md

@@ -4,6 +4,10 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
+Some of that scaffolding is environment-scoped and is **not** needed to use this component: `@wix/ambassador-contacts-v4-contact/http`, `@wix/ambassador-contacts-v4-contact/types`, `@wix/fe-essentials/react`. Those resolve only against a Wix build environment (a Yoshi flow's runtime, a generated service client, an internal sibling package) — substitute your own data source and http client rather than installing them.
+
 ## API
 
 ### Description

package/dist/docs/usePickerStandalone.md

@@ -2,6 +2,10 @@
 
 **Category:** Base Components/Collections/Picker/Hooks
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
+Some of that scaffolding is environment-scoped and is **not** needed to use this component: `@wix/ambassador-contacts-v4-contact/http`, `@wix/fe-essentials/react`. Those resolve only against a Wix build environment (a Yoshi flow's runtime, a generated service client, an internal sibling package) — substitute your own data source and http client rather than installing them.
+
 ## API
 
 ### Description

package/dist/docs/useSelector.md

@@ -2,6 +2,8 @@
 
 **Category:** Common/Hooks
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## Design
 
 ### Description

package/dist/docs/useSettingsPage.md

@@ -2,6 +2,8 @@
 
 **Category:** Base Components/Pages/Settings Page/Hooks/useSettingsPage
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## API
 
 ### Overview

package/dist/docs/useSettingsPageContext.md

@@ -2,6 +2,8 @@
 
 **Category:** Base Components/Pages/Settings Page/Hooks/useSettingsPageContext
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## API
 
 ### Overview

package/dist/docs/useStaticListFilterCollection.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## Design
 
 ### Overview

package/dist/docs/useTableCollection.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## API
 
 ### Description

package/dist/docs/useTableFolders.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## API
 
 ### Description

package/dist/docs/useTableGridSwitchCollection.md

@@ -4,6 +4,10 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
+Some of that scaffolding is environment-scoped and is **not** needed to use this component: `@wix/ambassador-contacts-v4-contact/types`. Those resolve only against a Wix build environment (a Yoshi flow's runtime, a generated service client, an internal sibling package) — substitute your own data source and http client rather than installing them.
+
 ## API
 
 ### Description

package/dist/docs/useTableGridSwitchFolders.md

@@ -2,6 +2,8 @@
 
 **Category:** Base Components/Collections/TableGridSwitchFolders/useTableGridSwitchFolders
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## API
 
 ### Description

package/dist/docs/useWidgetsFormContext.md

@@ -2,6 +2,8 @@
 
 **Category:** Common/Hooks
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## API
 
 ### Overview

package/dist/docs/withDashboard.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## Design
 
 ### Description

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

@@ -12,7 +12,7 @@ declare class CollectionState<T = any, F = any> {
 
 /**
  * `Filter` — cut here because it has its own bundle.
- * Look `Filter` up in the bundle index for its full shape.
+ * Full shape: `types/Filter.d.ts`.
  */
 interface Filter<T = any> {
     [key: string]: unknown;
@@ -63,7 +63,7 @@ interface SingleSelectFilterBaseProps<V> extends Omit<Partial<DropdownPropsContr
 
 /**
  * `FilterProps` — cut here because it has its own bundle.
- * Look `FilterProps` up in the bundle index for its full shape.
+ * Full shape: `types/FilterProps.d.ts`.
  */
 interface FilterProps<V = any> {
     [key: string]: unknown;

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

@@ -227,7 +227,7 @@ interface Order<T> {
 
 /**
  * `Filter` — cut here because it has its own bundle.
- * Look `Filter` up in the bundle index for its full shape.
+ * Full shape: `types/Filter.d.ts`.
  */
 interface Filter<T = any> {
     [key: string]: unknown;
@@ -244,7 +244,7 @@ type FiltersKey<F extends FiltersMap> = Partial<{
 }>;
 /**
  * `ComputedQuery` — cut here because it has its own bundle.
- * Look `ComputedQuery` up in the bundle index for its full shape.
+ * Full shape: `types/ComputedQuery.d.ts`.
  */
 interface ComputedQuery<F = any> {
     [key: string]: unknown;

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

@@ -35,7 +35,7 @@ interface ExploreAppsModalProps {
 
 /**
  * `MoreActionsItem` — cut here because it has its own bundle.
- * Look `MoreActionsItem` up in the bundle index for its full shape.
+ * Full shape: `types/MoreActionsItem.d.ts`.
  */
 interface MoreActionsItem {
     [key: string]: unknown;
@@ -115,7 +115,7 @@ interface PageSubTitleProps {
 
 /**
  * `ActionSubitem` — cut here because it has its own bundle.
- * Look `ActionSubitem` up in the bundle index for its full shape.
+ * Full shape: `types/ActionSubitem.d.ts`.
  */
 type ActionSubitem = Record<string, unknown>;
 

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

@@ -3,7 +3,7 @@ import React, { CSSProperties } from 'react';
 
 /**
  * `Filter` — cut here because it has its own bundle.
- * Look `Filter` up in the bundle index for its full shape.
+ * Full shape: `types/Filter.d.ts`.
  */
 interface Filter<T = any> {
     [key: string]: unknown;

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

@@ -2,7 +2,7 @@ import React, { ReactElement, JSXElementConstructor, ReactNode } from 'react';
 
 /**
  * `FilterProps` — cut here because it has its own bundle.
- * Look `FilterProps` up in the bundle index for its full shape.
+ * Full shape: `types/FilterProps.d.ts`.
  */
 interface FilterProps<V = any> {
     [key: string]: unknown;

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

@@ -0,0 +1,48 @@
+import * as react from 'react';
+import { FieldValues, FieldPath, ControllerProps } from './types';
+
+/**
+ * Component based on `useController` hook to work with controlled component.
+ *
+ * @remarks
+ * [API](https://react-hook-form.com/docs/usecontroller/controller) • [Demo](https://codesandbox.io/s/react-hook-form-v6-controller-ts-jwyzw) • [Video](https://www.youtube.com/watch?v=N2UNk_UCVyA)
+ *
+ * @param props - the path name to the form field value, and validation rules.
+ *
+ * @returns provide field handler functions, field and form state.
+ *
+ * @example
+ * ```tsx
+ * function App() {
+ *   const { control } = useForm<FormValues>({
+ *     defaultValues: {
+ *       test: ""
+ *     }
+ *   });
+ *
+ *   return (
+ *     <form>
+ *       <Controller
+ *         control={control}
+ *         name="test"
+ *         render={({ field: { onChange, onBlur, value, ref }, formState, fieldState }) => (
+ *           <>
+ *             <input
+ *               onChange={onChange} // send value to hook form
+ *               onBlur={onBlur} // notify when input is touched
+ *               value={value} // return updated value
+ *               ref={ref} // set ref for focus management
+ *             />
+ *             <p>{formState.isSubmitted ? "submitted" : ""}</p>
+ *             <p>{fieldState.isTouched ? "touched" : ""}</p>
+ *           </>
+ *         )}
+ *       />
+ *     </form>
+ *   );
+ * }
+ * ```
+ */
+declare const Controller: <TFieldValues extends FieldValues = FieldValues, TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>, TTransformedValues = TFieldValues>(props: ControllerProps<TFieldValues, TName, TTransformedValues>) => react.ReactElement<unknown, string | react.JSXElementConstructor<any>>;
+
+export { Controller };

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

@@ -3,7 +3,7 @@ import { DatePickerProps } from '@wix/design-system';
 
 /**
  * `RangeItem` — cut here because it has its own bundle.
- * Look `RangeItem` up in the bundle index for its full shape.
+ * Full shape: `types/RangeItem.d.ts`.
  */
 interface RangeItem<T = any> {
     [key: string]: unknown;
@@ -15,7 +15,7 @@ type DateRangeOptions = DateRangePredefinedPresetOptions[];
 
 /**
  * `FilterProps` — cut here because it has its own bundle.
- * Look `FilterProps` up in the bundle index for its full shape.
+ * Full shape: `types/FilterProps.d.ts`.
  */
 interface FilterProps<V = any> {
     [key: string]: unknown;

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

@@ -109,7 +109,7 @@ interface ActionsBarConfig {
 
 /**
  * `MoreActionsItem` — cut here because it has its own bundle.
- * Look `MoreActionsItem` up in the bundle index for its full shape.
+ * Full shape: `types/MoreActionsItem.d.ts`.
  */
 interface MoreActionsItem {
     [key: string]: unknown;
@@ -223,7 +223,7 @@ interface FormPageAdditionalContentProps {
 
 /**
  * `EntityPageState` — you receive this, you don't construct it.
- * Produced by `useEntityPage()` (also `useEntityPageContext()`). Look `EntityPageState` up in the bundle index for its own API.
+ * Produced by `useEntityPage()` (also `useEntityPageContext()`). Its own API is in `types/EntityPageState.d.ts`.
  */
 declare class EntityPageState<T = any, V = any> {
     [key: string]: unknown;

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

@@ -24,7 +24,7 @@ declare class ExportState<T = any, F = any> {
 
 /**
  * `Filter` — cut here because it has its own bundle.
- * Look `Filter` up in the bundle index for its full shape.
+ * Full shape: `types/Filter.d.ts`.
  */
 interface Filter<T = any> {
     [key: string]: unknown;
@@ -41,7 +41,7 @@ type FiltersKey<F extends FiltersMap> = Partial<{
 }>;
 /**
  * `ComputedQuery` — cut here because it has its own bundle.
- * Look `ComputedQuery` up in the bundle index for its full shape.
+ * Full shape: `types/ComputedQuery.d.ts`.
  */
 interface ComputedQuery<F = any> {
     [key: string]: unknown;