@wix/patterns 1.486.0 → 1.487.0

package/dist/cjs/version.js

@@ -2,5 +2,5 @@
 
 exports.__esModule = true;
 exports.version = void 0;
-const version = exports.version = 'patterns@1.486.0';
+const version = exports.version = 'patterns@1.487.0';
 //# sourceMappingURL=version.js.map

package/dist/cjs/version.js.map

@@ -1 +1 @@
-{"version":3,"names":["version","exports"],"sources":["../../src/version.ts"],"sourcesContent":["export const version = 'patterns@1.486.0';\n"],"mappings":";;;;AAAO,MAAMA,OAAO,GAAAC,OAAA,CAAAD,OAAA,GAAG,kBAAkB","ignoreList":[]}
+{"version":3,"names":["version","exports"],"sources":["../../src/version.ts"],"sourcesContent":["export const version = 'patterns@1.487.0';\n"],"mappings":";;;;AAAO,MAAMA,OAAO,GAAAC,OAAA,CAAAD,OAAA,GAAG,kBAAkB","ignoreList":[]}

package/dist/docs/ToolbarFilters.md

@@ -61,6 +61,12 @@ If there are more than 2 filters, the filters are displayed in a side panel.
 
 Example code: read `dist/examples/ToolbarFilters/more-than-2-filters.tsx`
 
+### Minimized filters button
+
+Set `minimized` to show the filters button as an icon with a tooltip. When filters are applied, their count is shown as a badge on the icon.
+
+Example code: read `dist/examples/ToolbarFilters/minimized-filters-button.tsx`
+
 ### Apply changes
 
 This example adds an apply filters button. If you want to get a reference to the filter that is about to be applied, use [getPendingFilter](./?path=%2Fstory%2Fcommon-state--toolbarcollectionstate).

package/dist/docs/index.json

@@ -181,6 +181,7 @@
       "ToolbarFilters/2-filters-with-a-title.tsx",
       "ToolbarFilters/custom-label-for-tags.tsx",
       "ToolbarFilters/more-than-2-filters.tsx",
+      "ToolbarFilters/minimized-filters-button.tsx",
       "ToolbarFilters/apply-changes.tsx",
       "ToolbarFilters/postpone-collection-filter-initial-fetch.tsx",
       "ToolbarFilters/customize-filter-display-tags.tsx",
@@ -1483,6 +1484,11 @@
     "propsTotal": 10,
     "propsTypeName": "ArrayFilterStateParams"
   },
+  "isCreateItemDisabled": {
+    "file": "isCreateItemDisabled.md",
+    "category": "Common/Types",
+    "summary": "`isCreateItemDisabled` is an optional callback on `ItemPermissions` that dynamically disables item creation. It returns `{ disabled: boolean; reason?: ReactNode }` — when `disabled` is true, the EditableTable's \"Add item\" row and the ImportButton are disabled, and the optional `reason` is shown in a tooltip."
+  },
   "stringFilter": {
     "file": "stringFilter.md",
     "category": "Features/Filter/Factories",

package/dist/docs/isCreateItemDisabled.md

@@ -0,0 +1,173 @@
+# isCreateItemDisabled
+
+**Category:** Common/Types
+
+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
+
+`isCreateItemDisabled` is an optional callback on `ItemPermissions` that dynamically disables item creation. It returns `{ disabled: boolean; reason?: ReactNode }` — when `disabled` is true, the EditableTable's "Add item" row and the ImportButton are disabled, and the optional `reason` is shown in a tooltip.
+
+Use this to enforce collection-level limits (e.g. a maximum number of items) while still allowing the user to see why the action is unavailable.
+
+Unlike the static `createItem: false` flag, `isCreateItemDisabled` is evaluated reactively — MobX observables it reads are tracked, so changes re-evaluate the condition automatically.
+
+
+```tsx
+import type { ItemPermissions, CreateItemDisabledResult } from '@wix/patterns/core';
+```
+
+### Enforcing an items limit
+
+This example uses `isCreateItemDisabled` on `ItemPermissions` to disable the "Add item" row when the collection reaches 5 items. Delete a row to re-enable adding.
+
+```tsx
+import React from 'react';
+import { CollectionPage } from '@wix/patterns/page';
+import { EditableTable } from '@wix/patterns';
+import type { EditableColumn } from '@wix/patterns';
+import {
+  useSchemaSource,
+  useEditableTableCollection,
+} from '@wix/patterns/schema';
+import type { CreateItemDisabledResult } from '@wix/patterns/core';
+import type {
+  CollectionBackend,
+  LoadedSchema,
+  Schema,
+} from '@wix/patterns/schema';
+
+type Contact = { _id: string; name: string; email: string };
+
+function isCreateItemDisabledExample() {
+  const MAX_ITEMS = 5;
+
+  const [store] = React.useState<{ contacts: Contact[]; nextId: number }>(
+    () => ({
+      nextId: 6,
+      contacts: [
+        { _id: '1', name: 'Alice', email: 'alice@example.com' },
+        { _id: '2', name: 'Bob', email: 'bob@example.com' },
+        { _id: '3', name: 'Charlie', email: 'charlie@example.com' },
+        { _id: '4', name: 'Dana', email: 'dana@example.com' },
+        { _id: '5', name: 'Eve', email: 'eve@example.com' },
+      ],
+    }),
+  );
+
+  const isCreateDisabled = (): CreateItemDisabledResult => ({
+    disabled: store.contacts.length >= MAX_ITEMS,
+    reason:
+      store.contacts.length >= MAX_ITEMS
+        ? `This collection is limited to ${MAX_ITEMS} items. Delete an existing item to add a new one.`
+        : undefined,
+  });
+
+  const schema: Schema = {
+    id: 'docs-is-create-item-disabled',
+    fields: {
+      _id: { id: '_id', displayName: 'ID', type: 'SHORT_TEXT' },
+      name: { id: 'name', displayName: 'Name', type: 'SHORT_TEXT' },
+      email: { id: 'email', displayName: 'Email', type: 'SHORT_TEXT' },
+    },
+    displayField: 'name',
+    idField: '_id',
+    itemPermissions: {
+      createItem: true,
+      updateItem: true,
+      deleteItem: true,
+      isCreateItemDisabled: isCreateDisabled,
+    },
+  };
+
+  const backend: CollectionBackend<Contact> = {
+    find: async ({ search = '', sort = [] }) => {
+      const found = store.contacts.filter(
+        (c) =>
+          c.name.toLowerCase().includes(search.toLowerCase()) ||
+          c.email.toLowerCase().includes(search.toLowerCase()),
+      );
+      if (sort.length) {
+        const [{ fieldName, order }] = sort;
+        found.sort((a, b) => {
+          const left = a[fieldName as keyof Contact] ?? '';
+          const right = b[fieldName as keyof Contact] ?? '';
+          const diff = left < right ? -1 : left > right ? 1 : 0;
+          return order === 'asc' ? diff : -diff;
+        });
+      }
+      return { items: found, total: found.length };
+    },
+    create: async (entity) => {
+      const created = {
+        _id: `contact-${store.nextId++}`,
+        name: '',
+        email: '',
+        ...entity,
+      };
+      store.contacts = [...store.contacts, created];
+      return created;
+    },
+    update: async (entity) => {
+      store.contacts = store.contacts.map((c) =>
+        c._id === entity._id ? entity : c,
+      );
+      return entity;
+    },
+    bulkDelete: async (ids) => {
+      store.contacts = store.contacts.filter((c) => !ids.includes(c._id));
+    },
+  };
+
+  const loadSchema = async (): Promise<LoadedSchema<Contact>> => ({
+    schema,
+    backend,
+  });
+
+  const columns: EditableColumn<Contact>[] = [
+    {
+      id: 'name',
+      title: 'Name',
+      cellType: 'text',
+      getValue: (c) => c.name,
+      setValue: (c, value) => ({ ...c, name: value }),
+      width: 200,
+    },
+    {
+      id: 'email',
+      title: 'Email',
+      cellType: 'text',
+      getValue: (c) => c.email,
+      setValue: (c, value) => ({ ...c, email: value }),
+      width: 250,
+    },
+  ];
+
+  const source = useSchemaSource<Contact>({
+    collectionId: 'docs-is-create-item-disabled',
+    loadSchema,
+  });
+  const state = useEditableTableCollection<Contact>(source);
+
+  return (
+    <CollectionPage height="400px">
+      <CollectionPage.Header title={{ text: 'Contacts (limit: 5)' }} />
+      <CollectionPage.Content>
+        <EditableTable state={state} columns={columns} />
+      </CollectionPage.Content>
+    </CollectionPage>
+  );
+}
+```
+
+## API
+
+### Props
+
+| Prop | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `bulkDeleteItems` | `boolean` | No | - | Deleting several items in one operation. Absent = follows `deleteItem`. |
+| `isRemoveItemDisabled` | `((item: T) => RemoveItemDisabledResult)` | No | - | Per-item refinement of `deleteItem`: disables deleting an item even though `deleteItem` is true, optionally with a reason. Must be pure and synchronous. Absent = all items deletable. |
+

package/dist/docs/useEntityPage.md

@@ -25,6 +25,7 @@ import { useForm } from '@wix/patterns/form';
 
 interface Shift {
   id?: string;
+  revision?: string;
   name?: string;
 }
 
@@ -34,9 +35,13 @@ interface ShiftFormFields {
 
 const api = {
   getShift: (id: string): Promise<Shift> =>
-    Promise.resolve({ id, name: 'Morning' }),
-  updateShift: (id: string, values: Partial<Shift>): Promise<Shift> =>
-    Promise.resolve({ id, ...values }),
+    Promise.resolve({ id, revision: '1', name: 'Morning' }),
+  updateShift: (
+    id: string,
+    revision: string | undefined,
+    values: Partial<Shift>,
+  ): Promise<Shift> =>
+    Promise.resolve({ id, revision: String(Number(revision) + 1), ...values }),
 };
 
 function EditShift({ shiftId }: { shiftId: string }) {
@@ -50,10 +55,15 @@ function EditShift({ shiftId }: { shiftId: string }) {
     form,
     fetch: () => api.getShift(shiftId).then((entity) => ({ entity })),
     // `onSave` receives `widgetsFormData` — what the widget fields
-    // contributed. The values the user typed come from the form itself.
-    onSave: ({ widgetsFormData }) =>
+    // contributed — and `entity`, the record `fetch` loaded. The values the
+    // user typed come from the form itself; what the update needs but the
+    // form does not hold, such as the revision, comes from `entity`.
+    onSave: ({ widgetsFormData, entity }) =>
       api
-        .updateShift(shiftId, { ...form.getValues(), ...widgetsFormData })
+        .updateShift(shiftId, entity?.revision, {
+          ...form.getValues(),
+          ...widgetsFormData,
+        })
         .then((updatedEntity) => ({ updatedEntity })),
   });
 

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

@@ -37,6 +37,13 @@ interface CollectionToolbarFiltersProps {
     onSearchAppliedFilterTagRemove?: (item: string) => unknown;
     onSubToolbarClearButtonClicked?: () => unknown;
     hideAppliedFiltersTagList?: boolean;
+    /**
+     * Shows the filters button as an icon with a tooltip instead of a labeled button.
+     * When filters are applied, their count is shown as a badge on the icon.
+     * @default false
+     * @external
+     */
+    minimized?: boolean;
 }
 /**
  * Filters that need the side panel rather than an inline slot — they are too

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

@@ -100,7 +100,7 @@ type EntityPageDeleteAction<T> = boolean | EntityPageDeleteActionConfig<T>;
  * `OnSaveParams` — cut here because it has its own bundle.
  * Full shape: `types/OnSaveParams.d.ts`.
  */
-type OnSaveParams = Record<string, unknown>;
+type OnSaveParams<T = any> = Record<string, unknown>;
 interface EntityPageStateParamsBase<T, V extends FieldValues = FieldValues> {
     /**
      * A function that fetches the entity data.
@@ -113,7 +113,7 @@ interface EntityPageStateParamsBase<T, V extends FieldValues = FieldValues> {
      * A function to handle the save action.
      * @returns promise that resolves to an object that contains a 'updatedEntity' object.
      */
-    onSave: (params: OnSaveParams) => Promise<{
+    onSave: (params: OnSaveParams<T>) => Promise<{
         updatedEntity: T;
     }>;
     /**

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

@@ -100,7 +100,7 @@ type EntityPageDeleteAction<T> = boolean | EntityPageDeleteActionConfig<T>;
  * `OnSaveParams` — cut here because it has its own bundle.
  * Full shape: `types/OnSaveParams.d.ts`.
  */
-type OnSaveParams = Record<string, unknown>;
+type OnSaveParams<T = any> = Record<string, unknown>;
 interface EntityPageStateParamsBase<T, V extends FieldValues = FieldValues> {
     /**
      * A function that fetches the entity data.
@@ -113,7 +113,7 @@ interface EntityPageStateParamsBase<T, V extends FieldValues = FieldValues> {
      * A function to handle the save action.
      * @returns promise that resolves to an object that contains a 'updatedEntity' object.
      */
-    onSave: (params: OnSaveParams) => Promise<{
+    onSave: (params: OnSaveParams<T>) => Promise<{
         updatedEntity: T;
     }>;
     /**

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

@@ -301,6 +301,9 @@ type Translate = {
     (key: 'cairo.tags.bulkItemUpdate.toast.error', params: {
         total: number;
     }): string;
+    (key: 'cairo.editableTable.paste.success.toast', params: {
+        count: number;
+    }): string;
     (key: 'cairo.dragAndDrop.button-role-label.sr', params: {
         itemName: string;
     }): string;

package/dist/dts-bundle/index.json

@@ -74,7 +74,7 @@
       "types/EntityPageState.d.ts",
       "types/MoreActionsItem.d.ts"
     ],
-    "readWithBytes": 25179,
+    "readWithBytes": 25191,
     "variants": [
       {
         "importPath": "@wix/patterns/schema",
@@ -85,7 +85,7 @@
           "types/EntityPageState.d.ts",
           "types/MoreActionsItem.d.ts"
         ],
-        "readWithBytes": 25179
+        "readWithBytes": 25191
       }
     ]
   },
@@ -161,7 +161,7 @@
       "types/GridState.d.ts",
       "types/ToolbarCollectionBaseProps.d.ts"
     ],
-    "readWithBytes": 56591,
+    "readWithBytes": 56836,
     "variants": [
       {
         "importPath": "@wix/patterns/schema",
@@ -176,7 +176,7 @@
           "types/GridState.d.ts",
           "types/ToolbarCollectionBaseProps.d.ts"
         ],
-        "readWithBytes": 56591
+        "readWithBytes": 56836
       }
     ]
   },
@@ -196,7 +196,7 @@
       "types/TableColumn.d.ts",
       "types/TableState.d.ts"
     ],
-    "readWithBytes": 72867
+    "readWithBytes": 72969
   },
   "LayoutSwitch": {
     "kind": "component",
@@ -218,7 +218,7 @@
       "types/TableState.d.ts",
       "types/ToolbarCollectionBaseProps.d.ts"
     ],
-    "readWithBytes": 121839
+    "readWithBytes": 122186
   },
   "TableGridSwitch": {
     "kind": "component",
@@ -241,7 +241,7 @@
       "types/TableState.d.ts",
       "types/ToolbarCollectionBaseProps.d.ts"
     ],
-    "readWithBytes": 102006
+    "readWithBytes": 102251
   },
   "TableFolders": {
     "kind": "component",
@@ -261,7 +261,7 @@
       "types/TableFoldersState.d.ts",
       "types/ToolbarCollectionBaseProps.d.ts"
     ],
-    "readWithBytes": 60991
+    "readWithBytes": 61236
   },
   "GridFolders": {
     "kind": "component",
@@ -280,7 +280,7 @@
       "types/GridFoldersState.d.ts",
       "types/ToolbarCollectionBaseProps.d.ts"
     ],
-    "readWithBytes": 54788
+    "readWithBytes": 55033
   },
   "PatternsReactRouter": {
     "kind": "component",
@@ -336,7 +336,7 @@
     "category": "Features/Filter/Components",
     "importPath": "@wix/patterns",
     "file": "components/CollectionToolbarFilters.d.ts",
-    "bytes": 2145,
+    "bytes": 2390,
     "status": null,
     "statusMessage": null,
     "readWith": [
@@ -819,7 +819,7 @@
       "types/OffsetQuery.d.ts",
       "types/SchemaSource.d.ts"
     ],
-    "readWithBytes": 79919
+    "readWithBytes": 80021
   },
   "useLayoutSwitchCollection": {
     "kind": "hook",
@@ -962,7 +962,7 @@
     "category": "Base Components/Pages/Entity Page/Hooks/useEntityPage",
     "importPath": "@wix/patterns",
     "file": "hooks/useEntityPage.d.ts",
-    "bytes": 7987,
+    "bytes": 7999,
     "status": null,
     "statusMessage": null,
     "readWith": [
@@ -972,12 +972,12 @@
       "types/SchemaSource.d.ts",
       "types/UseEntityPageParams.d.ts"
     ],
-    "readWithBytes": 81230,
+    "readWithBytes": 81478,
     "variants": [
       {
         "importPath": "@wix/patterns/schema",
         "file": "hooks/schema/useEntityPage.d.ts",
-        "bytes": 9105,
+        "bytes": 9117,
         "doc": "useSchemaSource.md",
         "readWith": [
           "types/EntityPageState.d.ts",
@@ -986,7 +986,7 @@
           "types/SchemaSource.d.ts",
           "types/UseEntityPageParams.d.ts"
         ],
-        "readWithBytes": 81230
+        "readWithBytes": 81478
       }
     ]
   },
@@ -1001,7 +1001,7 @@
     "readWith": [
       "types/EntityPageState.d.ts"
     ],
-    "readWithBytes": 23638
+    "readWithBytes": 23650
   },
   "useEntity": {
     "kind": "hook",
@@ -1014,14 +1014,14 @@
     "readWith": [
       "types/EntityPageState.d.ts"
     ],
-    "readWithBytes": 23638
+    "readWithBytes": 23650
   },
   "usePickerModal": {
     "kind": "hook",
     "category": "Base Components/Collections/Picker/Hooks",
     "importPath": "@wix/patterns/bm",
     "file": "hooks/usePickerModal.d.ts",
-    "bytes": 28230,
+    "bytes": 28332,
     "status": null,
     "statusMessage": null,
     "readWith": [
@@ -1242,7 +1242,7 @@
     "category": null,
     "importPath": "@wix/patterns/core",
     "file": "types/OnSaveParams.d.ts",
-    "bytes": 7607,
+    "bytes": 7819,
     "status": null,
     "statusMessage": null,
     "readWith": [
@@ -1250,14 +1250,14 @@
       "types/EntityPageStateParams.d.ts",
       "types/SchemaSource.d.ts"
     ],
-    "readWithBytes": 65740
+    "readWithBytes": 65764
   },
   "UseEntityPageParams": {
     "kind": "type",
     "category": null,
     "importPath": "@wix/patterns",
     "file": "types/UseEntityPageParams.d.ts",
-    "bytes": 7883,
+    "bytes": 7895,
     "status": null,
     "statusMessage": null,
     "readWith": [
@@ -1266,14 +1266,14 @@
       "types/OnSaveParams.d.ts",
       "types/SchemaSource.d.ts"
     ],
-    "readWithBytes": 73347
+    "readWithBytes": 73583
   },
   "EntityPageStateParams": {
     "kind": "type",
     "category": null,
     "importPath": "@wix/patterns",
     "file": "types/EntityPageStateParams.d.ts",
-    "bytes": 7573,
+    "bytes": 7585,
     "status": null,
     "statusMessage": null,
     "readWith": [
@@ -1281,14 +1281,14 @@
       "types/OnSaveParams.d.ts",
       "types/SchemaSource.d.ts"
     ],
-    "readWithBytes": 65774
+    "readWithBytes": 65998
   },
   "EntityPageState": {
     "kind": "type",
     "category": "Base Components/Pages/Entity Page/State",
     "importPath": "@wix/patterns",
     "file": "types/EntityPageState.d.ts",
-    "bytes": 23638,
+    "bytes": 23650,
     "status": null,
     "statusMessage": null,
     "readWith": [
@@ -1301,7 +1301,7 @@
       "types/OnSaveParams.d.ts",
       "types/SchemaSource.d.ts"
     ],
-    "readWithBytes": 62940
+    "readWithBytes": 63164
   },
   "Column": {
     "kind": "type",
@@ -1334,7 +1334,7 @@
     "category": null,
     "importPath": "@wix/patterns",
     "file": "types/CellType.d.ts",
-    "bytes": 32159,
+    "bytes": 32261,
     "status": null,
     "statusMessage": null,
     "readWith": [
@@ -1449,7 +1449,7 @@
     "category": null,
     "importPath": null,
     "file": "types/ToolbarCollectionBaseProps.d.ts",
-    "bytes": 36727,
+    "bytes": 36972,
     "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.",
     "unexported": true,
@@ -1482,7 +1482,7 @@
       "types/ToolbarCollectionBaseProps.d.ts",
       "types/ToolbarTitleProps.d.ts"
     ],
-    "readWithBytes": 46007
+    "readWithBytes": 46252
   },
   "CollectionTableBaseProps": {
     "kind": "type",
@@ -1505,7 +1505,7 @@
       "types/TagsProps.d.ts",
       "types/ToolbarCollectionBaseProps.d.ts"
     ],
-    "readWithBytes": 77682
+    "readWithBytes": 77927
   },
   "CollectionViewsDropdownBaseProps": {
     "kind": "type",
@@ -1659,7 +1659,7 @@
     "category": null,
     "importPath": "@wix/patterns-cms",
     "package": "@wix/patterns-cms",
-    "packageVersion": "1.70.0",
+    "packageVersion": "1.71.0",
     "doc": "useSchemaSource.md",
     "file": "hooks/useCmsSchemaSource.d.ts",
     "bytes": 17020,
@@ -1677,7 +1677,7 @@
     "category": null,
     "importPath": "@wix/patterns-cms",
     "package": "@wix/patterns-cms",
-    "packageVersion": "1.70.0",
+    "packageVersion": "1.71.0",
     "doc": "useSchemaSource.md",
     "file": "types/UseCmsSchemaSourceDeps.d.ts",
     "bytes": 38286,
@@ -1695,7 +1695,7 @@
     "category": null,
     "importPath": "@wix/patterns-cms",
     "package": "@wix/patterns-cms",
-    "packageVersion": "1.70.0",
+    "packageVersion": "1.71.0",
     "file": "functions/listCmsCollections.d.ts",
     "bytes": 401,
     "status": null,
@@ -1710,7 +1710,7 @@
     "category": null,
     "importPath": "@wix/patterns-cms",
     "package": "@wix/patterns-cms",
-    "packageVersion": "1.70.0",
+    "packageVersion": "1.71.0",
     "file": "types/CmsCollectionSummary.d.ts",
     "bytes": 286,
     "status": null,