@wix/auto-patterns 1.29.0 → 1.31.0

package/dist/types/types/EntityPageConfig.d.ts

@@ -2,45 +2,123 @@ import { FieldValues, UseFormReturn } from '@wix/patterns/form';
 import { EntityPageMoreActions, EntityPagePrimaryActions, EntityPageSecondaryActions } from './actions/entityPageActions';
 import { BaseCollectionConfig } from './types';
 export type EntityPageBaseConfig = {
+    /**
+     * Route configuration for the entity page.
+     */
     route: {
+        /**
+         * Route path (e.g. '/products/:id').
+         */
         path: string;
+        /**
+         * Mapping for dynamic params used in the path.
+         * `id` must match the placeholder used in `path`.
+         */
         params: {
             id: string;
         };
     };
+    /**
+     * Title configuration.
+     */
     title?: {
+        /**
+         * Title text.
+         */
         text: string;
+        /**
+         * Badges slot identifier for dynamic overrides.
+         */
         badges?: {
             id: string;
         };
     };
+    /**
+     * Subtitle configuration.
+     */
     subtitle?: {
+        /**
+         * Subtitle text.
+         */
         text?: string;
+        /**
+         * Subtitle slot identifier for dynamic overrides.
+         */
         id?: string;
+        /**
+         * "Learn more" link near the subtitle.
+         */
         learnMore?: {
+            /**
+             * Where the link should navigate to.
+             */
             url: string;
+            /**
+             * The label of the link button.
+             */
             label?: string;
         };
     };
+    /**
+     * Parent collection page id for navigation breadcrumbs/back behavior.
+     */
     parentPageId?: string;
+    /**
+     * Page layout: main content cards and optional sidebar cards.
+     */
     layout?: {
+        /**
+         * Main column card layout.
+         */
         main: CardLayout[];
+        /**
+         * Sidebar column card layout.
+         */
         sidebar?: CardLayout[];
     };
 } & BaseCollectionConfig;
 export type EditEntityPageConfig = EntityPageBaseConfig & {
+    /**
+     * Page mode.
+     * @default 'edit'
+     */
     mode?: 'edit';
+    /**
+     * Page actions.
+     *
+     * Edit mode supports only `moreActions`.
+     */
     actions?: {
         primaryActions?: never;
         secondaryActions?: never;
+        /**
+         * Contextual actions (e.g., custom actions).
+         */
         moreActions?: EntityPageMoreActions;
     };
 };
 export type ViewEntityPageConfig = EntityPageBaseConfig & {
+    /**
+     * Page mode.
+     */
     mode: 'view';
+    /**
+     * Page actions.
+     *
+     * View mode supports `primaryActions`, `secondaryActions`, and `moreActions`.
+     */
     actions?: {
+        /**
+         * Primary actions (e.g., Create).
+         */
         primaryActions?: EntityPagePrimaryActions;
+        /**
+         * Secondary actions (e.g., menu with secondary items).
+         */
         secondaryActions?: EntityPageSecondaryActions;
+        /**
+         * Additional context menu actions.
+         */
         moreActions?: EntityPageMoreActions;
     };
 };
@@ -48,12 +126,21 @@ export type EntityPageConfig = EditEntityPageConfig | ViewEntityPageConfig;
 export interface CardLayout {
     type: 'card';
     card: {
+        /**
+         * Card header title.
+         */
         title: {
             text: string;
         };
+        /**
+         * Optional card subtitle.
+         */
         subtitle?: {
             text: string;
         };
+        /**
+         * Card content items (fields, containers, or custom components).
+         */
         children: LayoutContent[];
     };
 }
@@ -61,26 +148,50 @@ export type LayoutContent = FieldContent | ContainerContent | ComponentItemConte
 interface FieldContent {
     type: 'field';
     field: {
+        /**
+         * Number of columns (out of 12) that this field should span in the layout grid.
+         */
         span?: number;
+        /**
+         * FieldId from the schema to render in this position.
+         */
         fieldId: string;
     };
 }
 interface ContainerContent {
     type: 'container';
     container: {
+        /**
+         * Number of columns (out of 12) that this container should span in the layout grid.
+         */
         span?: number;
+        /**
+         * Nested layout items inside the container.
+         */
         children: LayoutContent[];
     };
 }
 interface ComponentItemContent {
     type: 'component';
     component: {
+        /**
+         * Number of columns (out of 12) that this component should span in the layout grid.
+         */
         span?: number;
+        /**
+         * Identifier mapping to a custom component provided via overrides.
+         */
         componentId: string;
     };
 }
 export interface CustomComponentProps {
+    /**
+     * Current entity data.
+     */
     entity?: Record<string, any>;
+    /**
+     * Form APIs when in edit mode.
+     */
     form?: UseFormReturn<FieldValues, any, undefined>;
 }
 export {};

package/dist/types/types/EntityPageConfig.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EntityPageConfig.d.ts","sourceRoot":"","sources":["../../../src/types/EntityPageConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,EACL,qBAAqB,EACrB,wBAAwB,EACxB,0BAA0B,EAC3B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAE/C,MAAM,MAAM,oBAAoB,GAAG;IACjC,KAAK,EAAE;QACL,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE;YACN,EAAE,EAAE,MAAM,CAAC;SACZ,CAAC;KACH,CAAC;IACF,KAAK,CAAC,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,CAAC,EAAE;YACP,EAAE,EAAE,MAAM,CAAC;SACZ,CAAC;KACH,CAAC;IACF,QAAQ,CAAC,EAAE;QACT,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,SAAS,CAAC,EAAE;YACV,GAAG,EAAE,MAAM,CAAC;YACZ,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;KACH,CAAC;IACF,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE;QACP,IAAI,EAAE,UAAU,EAAE,CAAC;QACnB,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;KACxB,CAAC;CACH,GAAG,oBAAoB,CAAC;AAEzB,MAAM,MAAM,oBAAoB,GAAG,oBAAoB,GAAG;IACxD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE;QACR,cAAc,CAAC,EAAE,KAAK,CAAC;QACvB,gBAAgB,CAAC,EAAE,KAAK,CAAC;QACzB,WAAW,CAAC,EAAE,qBAAqB,CAAC;KACrC,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,oBAAoB,GAAG;IACxD,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE;QACR,cAAc,CAAC,EAAE,wBAAwB,CAAC;QAC1C,gBAAgB,CAAC,EAAE,0BAA0B,CAAC;QAC9C,WAAW,CAAC,EAAE,qBAAqB,CAAC;KACrC,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,GAAG,oBAAoB,CAAC;AAE3E,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE;QACJ,KAAK,EAAE;YACL,IAAI,EAAE,MAAM,CAAC;SACd,CAAC;QACF,QAAQ,CAAC,EAAE;YACT,IAAI,EAAE,MAAM,CAAC;SACd,CAAC;QACF,QAAQ,EAAE,aAAa,EAAE,CAAC;KAC3B,CAAC;CACH;AAED,MAAM,MAAM,aAAa,GACrB,YAAY,GACZ,gBAAgB,GAChB,oBAAoB,CAAC;AAEzB,UAAU,YAAY;IACpB,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE;QACL,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH;AAED,UAAU,gBAAgB;IACxB,IAAI,EAAE,WAAW,CAAC;IAClB,SAAS,EAAE;QACT,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,QAAQ,EAAE,aAAa,EAAE,CAAC;KAC3B,CAAC;CACH;AAED,UAAU,oBAAoB;IAC5B,IAAI,EAAE,WAAW,CAAC;IAClB,SAAS,EAAE;QACT,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;CACH;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC7B,IAAI,CAAC,EAAE,aAAa,CAAC,WAAW,EAAE,GAAG,EAAE,SAAS,CAAC,CAAC;CACnD"}
+{"version":3,"file":"EntityPageConfig.d.ts","sourceRoot":"","sources":["../../../src/types/EntityPageConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,EACL,qBAAqB,EACrB,wBAAwB,EACxB,0BAA0B,EAC3B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAE/C,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,KAAK,EAAE;QACL;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QACb;;;WAGG;QACH,MAAM,EAAE;YACN,EAAE,EAAE,MAAM,CAAC;SACZ,CAAC;KACH,CAAC;IACF;;OAEG;IACH,KAAK,CAAC,EAAE;QACN;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QACb;;WAEG;QACH,MAAM,CAAC,EAAE;YACP,EAAE,EAAE,MAAM,CAAC;SACZ,CAAC;KACH,CAAC;IACF;;OAEG;IACH,QAAQ,CAAC,EAAE;QACT;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QACd;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ;;WAEG;QACH,SAAS,CAAC,EAAE;YACV;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;YACZ;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;KACH,CAAC;IACF;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,MAAM,CAAC,EAAE;QACP;;WAEG;QACH,IAAI,EAAE,UAAU,EAAE,CAAC;QACnB;;WAEG;QACH,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;KACxB,CAAC;CACH,GAAG,oBAAoB,CAAC;AAEzB,MAAM,MAAM,oBAAoB,GAAG,oBAAoB,GAAG;IACxD;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,OAAO,CAAC,EAAE;QACR,cAAc,CAAC,EAAE,KAAK,CAAC;QACvB,gBAAgB,CAAC,EAAE,KAAK,CAAC;QACzB;;WAEG;QACH,WAAW,CAAC,EAAE,qBAAqB,CAAC;KACrC,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,oBAAoB,GAAG;IACxD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,OAAO,CAAC,EAAE;QACR;;WAEG;QACH,cAAc,CAAC,EAAE,wBAAwB,CAAC;QAC1C;;WAEG;QACH,gBAAgB,CAAC,EAAE,0BAA0B,CAAC;QAC9C;;WAEG;QACH,WAAW,CAAC,EAAE,qBAAqB,CAAC;KACrC,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,GAAG,oBAAoB,CAAC;AAE3E,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE;QACJ;;WAEG;QACH,KAAK,EAAE;YACL,IAAI,EAAE,MAAM,CAAC;SACd,CAAC;QACF;;WAEG;QACH,QAAQ,CAAC,EAAE;YACT,IAAI,EAAE,MAAM,CAAC;SACd,CAAC;QACF;;WAEG;QACH,QAAQ,EAAE,aAAa,EAAE,CAAC;KAC3B,CAAC;CACH;AAED,MAAM,MAAM,aAAa,GACrB,YAAY,GACZ,gBAAgB,GAChB,oBAAoB,CAAC;AAEzB,UAAU,YAAY;IACpB,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE;QACL;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QACd;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH;AAED,UAAU,gBAAgB;IACxB,IAAI,EAAE,WAAW,CAAC;IAClB,SAAS,EAAE;QACT;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QACd;;WAEG;QACH,QAAQ,EAAE,aAAa,EAAE,CAAC;KAC3B,CAAC;CACH;AAED,UAAU,oBAAoB;IAC5B,IAAI,EAAE,WAAW,CAAC;IAClB,SAAS,EAAE;QACT;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QACd;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;CACH;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC7B;;OAEG;IACH,IAAI,CAAC,EAAE,aAAa,CAAC,WAAW,EAAE,GAAG,EAAE,SAAS,CAAC,CAAC;CACnD"}

package/dist/types/types/actions/actionCell.d.ts

@@ -3,29 +3,70 @@ import { CustomActionConfig, DeleteActionConfig, UpdateActionConfig, DividerActi
 import { IconElement } from '@wix/design-system';
 export type ActionCellItemConfig = UpdateActionConfig | CustomActionConfig | DeleteActionConfig;
 export interface ActionCellPrimaryAction {
+    /**
+     * The action item configuration.
+     */
     item: ActionCellItemConfig;
+    /**
+     * Whether the primary action should always be visible.
+     * If true, the action is always visible; if false, it is visible only when hovering the row.
+     * @default false
+     */
     alwaysVisible?: boolean;
 }
 export interface ActionCellSecondaryActions {
+    /**
+     * Array of action items and dividers for the secondary actions menu.
+     */
     items: (ActionCellItemConfig | DividerActionConfig)[];
+    /**
+     * Number of secondary actions to show inline before moving to overflow menu.
+     * Remaining actions appear in a "more actions" dropdown.
+     * @default 0 (all actions in dropdown)
+     */
     inlineCount?: number;
+    /**
+     * Whether inline secondary actions should always be visible.
+     * If true, the inline actions are always visible; if false, they are visible only when hovering the row.
+     * @default false
+     */
     inlineAlwaysVisible?: boolean;
 }
 export interface ActionCellConfig {
+    /**
+     * Primary action configuration.
+     * Shown as the main action button in each row.
+     */
     primaryAction?: ActionCellPrimaryAction;
+    /**
+     * Secondary actions configuration.
+     * Shown as additional actions in dropdown or inline.
+     */
     secondaryActions?: ActionCellSecondaryActions;
 }
 export interface ResolvedActionCellPrimaryAction extends Omit<ResolvedAction, 'icon'> {
+    /**
+     * Icon displayed before the action label.
+     */
     prefixIcon?: IconElement;
+    /**
+     * Icon displayed after the action label.
+     */
     suffixIcon?: IconElement;
 }
 export interface ActionCellActionParams {
+    /**
+     * The data item (row) that the action is being performed on.
+     */
     item: any;
 }
 export type CustomActionCellActionParams = CustomActionParams<ActionCellActionParams>;
 export type CustomActionCellPrimaryActionResolver = (params: CustomActionCellActionParams) => ResolvedActionCellPrimaryAction;
 export type CustomActionCellSecondaryActionResolver = (params: CustomActionCellActionParams) => ResolvedAction;
 export interface CustomActionCellActionModalProps extends CustomActionModalProps {
+    /**
+     * Action parameters including the row item context.
+     */
     actionParams: ActionCellActionParams;
 }
 //# sourceMappingURL=actionCell.d.ts.map

package/dist/types/types/actions/actionCell.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"actionCell.d.ts","sourceRoot":"","sources":["../../../../src/types/actions/actionCell.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,kBAAkB,EAClB,cAAc,EACf,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,EACpB,MAAM,QAAQ,CAAC;AAChB,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,MAAM,MAAM,oBAAoB,GAC5B,kBAAkB,GAClB,kBAAkB,GAClB,kBAAkB,CAAC;AAEvB,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,oBAAoB,CAAC;IAC3B,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,0BAA0B;IACzC,KAAK,EAAE,CAAC,oBAAoB,GAAG,mBAAmB,CAAC,EAAE,CAAC;IACtD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED,MAAM,WAAW,gBAAgB;IAC/B,aAAa,CAAC,EAAE,uBAAuB,CAAC;IACxC,gBAAgB,CAAC,EAAE,0BAA0B,CAAC;CAC/C;AAED,MAAM,WAAW,+BACf,SAAQ,IAAI,CAAC,cAAc,EAAE,MAAM,CAAC;IACpC,UAAU,CAAC,EAAE,WAAW,CAAC;IACzB,UAAU,CAAC,EAAE,WAAW,CAAC;CAC1B;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,GAAG,CAAC;CACX;AAED,MAAM,MAAM,4BAA4B,GACtC,kBAAkB,CAAC,sBAAsB,CAAC,CAAC;AAE7C,MAAM,MAAM,qCAAqC,GAAG,CAClD,MAAM,EAAE,4BAA4B,KACjC,+BAA+B,CAAC;AAErC,MAAM,MAAM,uCAAuC,GAAG,CACpD,MAAM,EAAE,4BAA4B,KACjC,cAAc,CAAC;AAEpB,MAAM,WAAW,gCACf,SAAQ,sBAAsB;IAC9B,YAAY,EAAE,sBAAsB,CAAC;CACtC"}
+{"version":3,"file":"actionCell.d.ts","sourceRoot":"","sources":["../../../../src/types/actions/actionCell.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,kBAAkB,EAClB,cAAc,EACf,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,EACpB,MAAM,QAAQ,CAAC;AAChB,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,MAAM,MAAM,oBAAoB,GAC5B,kBAAkB,GAClB,kBAAkB,GAClB,kBAAkB,CAAC;AAEvB,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,EAAE,oBAAoB,CAAC;IAC3B;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,KAAK,EAAE,CAAC,oBAAoB,GAAG,mBAAmB,CAAC,EAAE,CAAC;IACtD;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,aAAa,CAAC,EAAE,uBAAuB,CAAC;IACxC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,0BAA0B,CAAC;CAC/C;AAED,MAAM,WAAW,+BACf,SAAQ,IAAI,CAAC,cAAc,EAAE,MAAM,CAAC;IACpC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC;IACzB;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC;CAC1B;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,EAAE,GAAG,CAAC;CACX;AAED,MAAM,MAAM,4BAA4B,GACtC,kBAAkB,CAAC,sBAAsB,CAAC,CAAC;AAE7C,MAAM,MAAM,qCAAqC,GAAG,CAClD,MAAM,EAAE,4BAA4B,KACjC,+BAA+B,CAAC;AAErC,MAAM,MAAM,uCAAuC,GAAG,CACpD,MAAM,EAAE,4BAA4B,KACjC,cAAc,CAAC;AAEpB,MAAM,WAAW,gCACf,SAAQ,sBAAsB;IAC9B;;OAEG;IACH,YAAY,EAAE,sBAAsB,CAAC;CACtC"}

package/dist/types/types/actions/base.d.ts

@@ -2,38 +2,80 @@ export type DividerActionConfig = {
     type: 'divider';
 };
 export type BaseActionItemConfig = {
+    /**
+     * Unique identifier for the action.
+     */
     id: string;
+    /**
+     * Display text for the action button/menu item.
+     */
     label?: string;
+    /**
+     * Visual appearance of the action button (e.g., 'standard', 'destructive', 'primary').
+     */
     skin?: string;
+    /**
+     * BI tracking name.
+     */
     biName?: string;
 };
 export interface Feedback {
+    /**
+     * Success message displayed in a toast notification.
+     */
     successToast?: {
         text: string;
     };
+    /**
+     * Error message displayed in a toast notification.
+     */
     errorToast?: {
         text: string;
     };
 }
 export interface BaseActionModal {
+    /**
+     * Modal header title.
+     */
     title?: {
         text: string;
     };
+    /**
+     * Modal action buttons configuration.
+     */
     actions?: {
+        /**
+         * Submit/confirm button text.
+         */
         submit?: {
             text: string;
         };
+        /**
+         * Cancel button text.
+         */
         cancel?: {
             text: string;
         };
     };
+    /**
+     * Toast notifications for action completion.
+     */
     feedback?: Feedback;
 }
 export interface ActionModalField {
+    /**
+     * Field identifier.
+     */
     id: string;
+    /**
+     * Field display label.
+     */
     label?: string;
 }
 export interface DeleteActionModal extends BaseActionModal {
+    /**
+     * Optional description text explaining the delete operation.
+     */
     description?: {
         text: string;
     };
@@ -48,13 +90,22 @@ export type BulkDeleteAction = {
     modal?: never;
 };
 export type DeleteAction = {
+    /**
+     * Show a confirmation modal.
+     */
     mode: 'modal';
     modal: DeleteActionModal;
 };
 export interface BaseActionPage {
+    /**
+     * Unique identifier.
+     */
     id: string;
 }
 export interface ActionModalWithFields extends BaseActionModal {
+    /**
+     * Form fields to display in the modal.
+     */
     fields: ActionModalField[];
 }
 export interface UpdateActionModal extends ActionModalWithFields {
@@ -66,30 +117,63 @@ export interface UpdateActionPage extends BaseActionPage {
 export interface CreateActionPage extends BaseActionPage {
 }
 export type UpdateAction = {
+    /**
+     * Navigate to a page for the update operation.
+     */
     mode: 'page';
     page: UpdateActionPage;
 };
 export type CreateAction = {
+    /**
+     * Navigate to a page for the create operation.
+     */
     mode: 'page';
     page: CreateActionPage;
 };
 export type CreateActionConfig = BaseActionItemConfig & {
+    /**
+     * Action type discriminator.
+     */
     type: 'create';
+    /**
+     * Create action implementation configuration.
+     */
     create: CreateAction;
 };
 export type UpdateActionConfig = BaseActionItemConfig & {
+    /**
+     * Action type discriminator.
+     */
     type: 'update';
+    /**
+     * Update action implementation configuration.
+     */
     update: UpdateAction;
 };
 export type DeleteActionConfig = BaseActionItemConfig & {
+    /**
+     * Action type discriminator.
+     */
     type: 'delete';
+    /**
+     * Delete action implementation configuration.
+     */
     delete: DeleteAction;
 };
 export type BulkDeleteActionConfig = BaseActionItemConfig & {
+    /**
+     * Action type discriminator.
+     */
     type: 'bulkDelete';
+    /**
+     * Bulk delete action implementation configuration.
+     */
     bulkDelete: BulkDeleteAction;
 };
 export type CustomActionConfig = BaseActionItemConfig & {
+    /**
+     * Action type discriminator.
+     */
     type: 'custom';
 };
 //# sourceMappingURL=base.d.ts.map

package/dist/types/types/actions/base.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../../src/types/actions/base.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,mBAAmB,GAAG;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,CAAC;AAEtD,MAAM,MAAM,oBAAoB,GAAG;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,WAAW,QAAQ;IACvB,YAAY,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAChC,UAAU,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CAC/B;AAED,MAAM,WAAW,eAAe;IAC9B,KAAK,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IACzB,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,EAAE;YAAE,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC;QAC1B,MAAM,CAAC,EAAE;YAAE,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC;KAC3B,CAAC;IACF,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,iBAAkB,SAAQ,eAAe;IACxD,WAAW,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CAChC;AAED,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB;CAAG;AAEnE,MAAM,MAAM,gBAAgB,GACxB;IACE,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,qBAAqB,CAAC;CAC9B,GACD;IACE,IAAI,EAAE,QAAQ,CAAC;IACf,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,CAAC;AAEN,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,iBAAiB,CAAC;CAC1B,CAAC;AAEF,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC5D,MAAM,EAAE,gBAAgB,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,iBAAkB,SAAQ,qBAAqB;CAAG;AAEnE,MAAM,WAAW,iBAAkB,SAAQ,qBAAqB;CAAG;AAEnE,MAAM,WAAW,gBAAiB,SAAQ,cAAc;CAAG;AAE3D,MAAM,WAAW,gBAAiB,SAAQ,cAAc;CAAG;AAE3D,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,gBAAgB,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,gBAAgB,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,GAAG;IACtD,IAAI,EAAE,QAAQ,CAAC;IACf,MAAM,EAAE,YAAY,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,GAAG;IACtD,IAAI,EAAE,QAAQ,CAAC;IACf,MAAM,EAAE,YAAY,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,GAAG;IACtD,IAAI,EAAE,QAAQ,CAAC;IACf,MAAM,EAAE,YAAY,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,oBAAoB,GAAG;IAC1D,IAAI,EAAE,YAAY,CAAC;IACnB,UAAU,EAAE,gBAAgB,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,GAAG;IACtD,IAAI,EAAE,QAAQ,CAAC;CAChB,CAAC"}
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../../src/types/actions/base.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,mBAAmB,GAAG;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,CAAC;AAEtD,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,YAAY,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CAC/B;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IACzB;;OAEG;IACH,OAAO,CAAC,EAAE;QACR;;WAEG;QACH,MAAM,CAAC,EAAE;YAAE,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC;QAC1B;;WAEG;QACH,MAAM,CAAC,EAAE;YAAE,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC;KAC3B,CAAC;IACF;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,iBAAkB,SAAQ,eAAe;IACxD;;OAEG;IACH,WAAW,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CAChC;AAED,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB;CAAG;AAEnE,MAAM,MAAM,gBAAgB,GACxB;IACE,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,qBAAqB,CAAC;CAC9B,GACD;IACE,IAAI,EAAE,QAAQ,CAAC;IACf,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,CAAC;AAEN,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,iBAAiB,CAAC;CAC1B,CAAC;AAEF,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC5D;;OAEG;IACH,MAAM,EAAE,gBAAgB,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,iBAAkB,SAAQ,qBAAqB;CAAG;AAEnE,MAAM,WAAW,iBAAkB,SAAQ,qBAAqB;CAAG;AAEnE,MAAM,WAAW,gBAAiB,SAAQ,cAAc;CAAG;AAE3D,MAAM,WAAW,gBAAiB,SAAQ,cAAc;CAAG;AAE3D,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,gBAAgB,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,gBAAgB,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,GAAG;IACtD;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IACf;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,GAAG;IACtD;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IACf;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,GAAG;IACtD;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IACf;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,oBAAoB,GAAG;IAC1D;;OAEG;IACH,IAAI,EAAE,YAAY,CAAC;IACnB;;OAEG;IACH,UAAU,EAAE,gBAAgB,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,GAAG;IACtD;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;CAChB,CAAC"}

package/dist/types/types/actions/bulkActions.d.ts

@@ -2,33 +2,73 @@ import { BaseActionParams, CustomActionModalProps, ResolvedAction } from '../../
 import { BulkDeleteActionConfig, CustomActionConfig, DividerActionConfig } from './base';
 export type BulkActionItemConfig = BulkDeleteActionConfig | CustomActionConfig;
 type BulkActionItem = {
+    /**
+     * Layout type discriminator.
+     */
     type: 'action';
+    /**
+     * Single bulk action configuration.
+     */
     action: {
         item: BulkActionItemConfig;
     };
     menu?: never;
 };
 type BulkActionMenu = {
+    /**
+     * Layout type discriminator.
+     */
     type: 'menu';
+    /**
+     * Menu configuration with multiple bulk actions.
+     */
     menu: {
+        /**
+         * Menu group label displayed in the bulk actions toolbar.
+         */
         label: string;
+        /**
+         * List of bulk actions and dividers in the menu.
+         */
         items: (BulkActionItemConfig | DividerActionConfig)[];
     };
     action?: never;
 };
 export interface BulkActionsConfig {
+    /**
+     * Primary bulk actions configuration.
+     * Array of actions or menus shown prominently in the bulk actions toolbar.
+     * Can include both single actions and grouped menu actions.
+     */
     primaryActions?: (BulkActionItem | BulkActionMenu)[];
+    /**
+     * Secondary bulk actions configuration.
+     * Array of individual actions and dividers shown in secondary position.
+     * Typically displayed as individual buttons or in an overflow menu.
+     */
     secondaryActions?: (BulkActionItemConfig | DividerActionConfig)[];
 }
 export interface BulkActionsActionParams {
+    /**
+     * Array of selected item values to perform the bulk action on.
+     */
     selectedValues: any[];
+    /**
+     * Total number of selected items.
+     */
     total: number;
 }
 export interface CustomBulkActionsActionParams extends BaseActionParams {
+    /**
+     * Bulk action parameters.
+     */
     actionParams: BulkActionsActionParams;
 }
 export type CustomBulkActionsActionResolver = (params: CustomBulkActionsActionParams) => ResolvedAction;
 export interface CustomBulkActionsActionModalProps extends CustomActionModalProps {
+    /**
+     * Bulk action parameters.
+     */
     actionParams: BulkActionsActionParams;
 }
 export {};

package/dist/types/types/actions/bulkActions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bulkActions.d.ts","sourceRoot":"","sources":["../../../../src/types/actions/bulkActions.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,sBAAsB,EACtB,cAAc,EACf,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,sBAAsB,EACtB,kBAAkB,EAClB,mBAAmB,EACpB,MAAM,QAAQ,CAAC;AAEhB,MAAM,MAAM,oBAAoB,GAAG,sBAAsB,GAAG,kBAAkB,CAAC;AAE/E,KAAK,cAAc,GAAG;IACpB,IAAI,EAAE,QAAQ,CAAC;IACf,MAAM,EAAE;QACN,IAAI,EAAE,oBAAoB,CAAC;KAC5B,CAAC;IACF,IAAI,CAAC,EAAE,KAAK,CAAC;CACd,CAAC;AAEF,KAAK,cAAc,GAAG;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,CAAC,oBAAoB,GAAG,mBAAmB,CAAC,EAAE,CAAC;KACvD,CAAC;IACF,MAAM,CAAC,EAAE,KAAK,CAAC;CAChB,CAAC;AAEF,MAAM,WAAW,iBAAiB;IAChC,cAAc,CAAC,EAAE,CAAC,cAAc,GAAG,cAAc,CAAC,EAAE,CAAC;IACrD,gBAAgB,CAAC,EAAE,CAAC,oBAAoB,GAAG,mBAAmB,CAAC,EAAE,CAAC;CACnE;AAED,MAAM,WAAW,uBAAuB;IACtC,cAAc,EAAE,GAAG,EAAE,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,6BAA8B,SAAQ,gBAAgB;IACrE,YAAY,EAAE,uBAAuB,CAAC;CACvC;AACD,MAAM,MAAM,+BAA+B,GAAG,CAC5C,MAAM,EAAE,6BAA6B,KAClC,cAAc,CAAC;AAEpB,MAAM,WAAW,iCACf,SAAQ,sBAAsB;IAC9B,YAAY,EAAE,uBAAuB,CAAC;CACvC"}
+{"version":3,"file":"bulkActions.d.ts","sourceRoot":"","sources":["../../../../src/types/actions/bulkActions.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,sBAAsB,EACtB,cAAc,EACf,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,sBAAsB,EACtB,kBAAkB,EAClB,mBAAmB,EACpB,MAAM,QAAQ,CAAC;AAEhB,MAAM,MAAM,oBAAoB,GAAG,sBAAsB,GAAG,kBAAkB,CAAC;AAE/E,KAAK,cAAc,GAAG;IACpB;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IACf;;OAEG;IACH,MAAM,EAAE;QACN,IAAI,EAAE,oBAAoB,CAAC;KAC5B,CAAC;IACF,IAAI,CAAC,EAAE,KAAK,CAAC;CACd,CAAC;AAEF,KAAK,cAAc,GAAG;IACpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,EAAE;QACJ;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QACd;;WAEG;QACH,KAAK,EAAE,CAAC,oBAAoB,GAAG,mBAAmB,CAAC,EAAE,CAAC;KACvD,CAAC;IACF,MAAM,CAAC,EAAE,KAAK,CAAC;CAChB,CAAC;AAEF,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,cAAc,CAAC,EAAE,CAAC,cAAc,GAAG,cAAc,CAAC,EAAE,CAAC;IACrD;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,CAAC,oBAAoB,GAAG,mBAAmB,CAAC,EAAE,CAAC;CACnE;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,cAAc,EAAE,GAAG,EAAE,CAAC;IACtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,6BAA8B,SAAQ,gBAAgB;IACrE;;OAEG;IACH,YAAY,EAAE,uBAAuB,CAAC;CACvC;AAED,MAAM,MAAM,+BAA+B,GAAG,CAC5C,MAAM,EAAE,6BAA6B,KAClC,cAAc,CAAC;AAEpB,MAAM,WAAW,iCACf,SAAQ,sBAAsB;IAC9B;;OAEG;IACH,YAAY,EAAE,uBAAuB,CAAC;CACvC"}

package/dist/types/types/actions/collectionPageActions.d.ts

@@ -14,16 +14,34 @@ export type CollectionPageActionConfig = (CreateActionConfig | CustomActionConfi
     };
 };
 type CollectionPageAction = {
+    /**
+     * Layout type discriminator.
+     */
     type: 'action';
+    /**
+     * Single action configuration.
+     */
     action: {
         item: CollectionPageActionConfig;
     };
     menu?: never;
 };
 type CollectionPageMenu = {
+    /**
+     * Layout type discriminator.
+     */
     type: 'menu';
+    /**
+     * Menu configuration with multiple actions.
+     */
     menu: {
+        /**
+         * Menu group label displayed in the UI.
+         */
         label: string;
+        /**
+         * List of actions and dividers in the menu.
+         */
         items: (CollectionPageActionConfig | DividerActionConfig)[];
     };
     action?: never;
@@ -31,17 +49,29 @@ type CollectionPageMenu = {
 export type CollectionPagePrimaryActions = CollectionPageAction | CollectionPageMenu;
 export type CollectionPageSecondaryActions = CollectionPageAction | CollectionPageMenu;
 export interface CollectionPageActionParams {
+    /**
+     * The collection ID that the action is operating on.
+     */
     collectionId: string;
 }
 export type CustomActionCollectionPageActionParams = CustomActionParams<CollectionPageActionParams>;
 export type CustomActionCollectionPageActionResolver = (params: CustomActionCollectionPageActionParams) => ResolvedAction;
 export interface CustomActionCollectionPageActionModalProps extends CustomActionModalProps {
+    /**
+     * Collection-specific action parameters.
+     */
     actionParams: CollectionPageActionParams;
 }
 export type CollectionPageOnRowClickActionConfig = CustomActionConfig & {
+    /**
+     * The data item that was clicked (row/card data).
+     */
     item: any;
 };
 export interface CollectionPageActionOnRowClickParams {
+    /**
+     * The data item that was clicked (row/card data).
+     */
     item: any;
 }
 export type CustomActionCollectionPageActionOnRowClickParams = CustomActionParams<CollectionPageActionOnRowClickParams>;

package/dist/types/types/actions/collectionPageActions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"collectionPageActions.d.ts","sourceRoot":"","sources":["../../../../src/types/actions/collectionPageActions.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,kBAAkB,EAClB,cAAc,EACf,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,EACpB,MAAM,QAAQ,CAAC;AAEhB,MAAM,MAAM,0BAA0B,GAAG,CACrC,kBAAkB,GAClB,kBAAkB,CACrB,GAAG;IACF,UAAU,EACN;QACE,YAAY,EAAE,MAAM,CAAC;QACrB,gBAAgB,EAAE,KAAK,CAAC;QACxB,MAAM,CAAC,EAAE,KAAK,CAAC;KAChB,GACD;QACE,YAAY,EAAE,MAAM,CAAC;QACrB,gBAAgB,EAAE,QAAQ,CAAC;QAC3B,MAAM,EAAE;YACN,EAAE,EAAE,MAAM,CAAC;SACZ,CAAC;KACH,CAAC;CACP,CAAC;AAEF,KAAK,oBAAoB,GAAG;IAC1B,IAAI,EAAE,QAAQ,CAAC;IACf,MAAM,EAAE;QACN,IAAI,EAAE,0BAA0B,CAAC;KAClC,CAAC;IACF,IAAI,CAAC,EAAE,KAAK,CAAC;CACd,CAAC;AAEF,KAAK,kBAAkB,GAAG;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,CAAC,0BAA0B,GAAG,mBAAmB,CAAC,EAAE,CAAC;KAC7D,CAAC;IACF,MAAM,CAAC,EAAE,KAAK,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GACpC,oBAAoB,GACpB,kBAAkB,CAAC;AAEvB,MAAM,MAAM,8BAA8B,GACtC,oBAAoB,GACpB,kBAAkB,CAAC;AAEvB,MAAM,WAAW,0BAA0B;IACzC,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,MAAM,sCAAsC,GAChD,kBAAkB,CAAC,0BAA0B,CAAC,CAAC;AAEjD,MAAM,MAAM,wCAAwC,GAAG,CACrD,MAAM,EAAE,sCAAsC,KAC3C,cAAc,CAAC;AAEpB,MAAM,WAAW,0CACf,SAAQ,sBAAsB;IAC9B,YAAY,EAAE,0BAA0B,CAAC;CAC1C;AAED,MAAM,MAAM,oCAAoC,GAAG,kBAAkB,GAAG;IACtE,IAAI,EAAE,GAAG,CAAC;CACX,CAAC;AAEF,MAAM,WAAW,oCAAoC;IACnD,IAAI,EAAE,GAAG,CAAC;CACX;AAED,MAAM,MAAM,gDAAgD,GAC1D,kBAAkB,CAAC,oCAAoC,CAAC,CAAC;AAE3D,MAAM,MAAM,kDAAkD,GAAG,CAC/D,MAAM,EAAE,gDAAgD,KACrD,cAAc,CAAC"}
+{"version":3,"file":"collectionPageActions.d.ts","sourceRoot":"","sources":["../../../../src/types/actions/collectionPageActions.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,kBAAkB,EAClB,cAAc,EACf,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,EACpB,MAAM,QAAQ,CAAC;AAEhB,MAAM,MAAM,0BAA0B,GAAG,CACrC,kBAAkB,GAClB,kBAAkB,CACrB,GAAG;IACF,UAAU,EACN;QACE,YAAY,EAAE,MAAM,CAAC;QACrB,gBAAgB,EAAE,KAAK,CAAC;QACxB,MAAM,CAAC,EAAE,KAAK,CAAC;KAChB,GACD;QACE,YAAY,EAAE,MAAM,CAAC;QACrB,gBAAgB,EAAE,QAAQ,CAAC;QAC3B,MAAM,EAAE;YACN,EAAE,EAAE,MAAM,CAAC;SACZ,CAAC;KACH,CAAC;CACP,CAAC;AAEF,KAAK,oBAAoB,GAAG;IAC1B;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IACf;;OAEG;IACH,MAAM,EAAE;QACN,IAAI,EAAE,0BAA0B,CAAC;KAClC,CAAC;IACF,IAAI,CAAC,EAAE,KAAK,CAAC;CACd,CAAC;AAEF,KAAK,kBAAkB,GAAG;IACxB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,EAAE;QACJ;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QACd;;WAEG;QACH,KAAK,EAAE,CAAC,0BAA0B,GAAG,mBAAmB,CAAC,EAAE,CAAC;KAC7D,CAAC;IACF,MAAM,CAAC,EAAE,KAAK,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GACpC,oBAAoB,GACpB,kBAAkB,CAAC;AAEvB,MAAM,MAAM,8BAA8B,GACtC,oBAAoB,GACpB,kBAAkB,CAAC;AAEvB,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,MAAM,sCAAsC,GAChD,kBAAkB,CAAC,0BAA0B,CAAC,CAAC;AAEjD,MAAM,MAAM,wCAAwC,GAAG,CACrD,MAAM,EAAE,sCAAsC,KAC3C,cAAc,CAAC;AAEpB,MAAM,WAAW,0CACf,SAAQ,sBAAsB;IAC9B;;OAEG;IACH,YAAY,EAAE,0BAA0B,CAAC;CAC1C;AAED,MAAM,MAAM,oCAAoC,GAAG,kBAAkB,GAAG;IACtE;;OAEG;IACH,IAAI,EAAE,GAAG,CAAC;CACX,CAAC;AAEF,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,IAAI,EAAE,GAAG,CAAC;CACX;AAED,MAAM,MAAM,gDAAgD,GAC1D,kBAAkB,CAAC,oCAAoC,CAAC,CAAC;AAE3D,MAAM,MAAM,kDAAkD,GAAG,CAC/D,MAAM,EAAE,gDAAgD,KACrD,cAAc,CAAC"}

package/dist/types/types/actions/entityPageActions.d.ts

@@ -4,16 +4,34 @@ import { CreateActionConfig, CustomActionConfig, DividerActionConfig } from './b
 export type EntityPageMoreActions = (CustomActionConfig | DividerActionConfig)[];
 export type EntityPageActionConfig = CreateActionConfig | CustomActionConfig;
 type EntityPageAction = {
+    /**
+     * Layout type discriminator.
+     */
     type: 'action';
+    /**
+     * Single action configuration.
+     */
     action: {
         item: EntityPageActionConfig;
     };
     menu?: never;
 };
 type EntityPageMenu = {
+    /**
+     * Layout type discriminator.
+     */
     type: 'menu';
+    /**
+     * Menu configuration with multiple actions.
+     */
     menu: {
+        /**
+         * Menu group label displayed in the UI.
+         */
         label: string;
+        /**
+         * List of actions and dividers in the menu.
+         */
         items: (EntityPageActionConfig | DividerActionConfig)[];
     };
     action?: never;
@@ -21,7 +39,14 @@ type EntityPageMenu = {
 export type EntityPagePrimaryActions = EntityPageAction | EntityPageMenu;
 export type EntityPageSecondaryActions = EntityPageAction | EntityPageMenu;
 export interface EntityPageActionParams {
+    /**
+     * The current entity data being viewed/edited.
+     */
     entity: any;
+    /**
+     * Form APIs available when in edit mode.
+     * Undefined in view mode.
+     */
     form?: UseFormReturn<FieldValues, any, undefined>;
 }
 export type CustomEntityPageActionParams = CustomActionParams<EntityPageActionParams>;