@wix/auto-patterns 1.22.0 → 1.24.0

package/dist/cjs/types/actions/base.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["../../../../src/types/actions/base.ts"],"sourcesContent":["export type DividerActionConfig = { type: 'divider' };\n\nexport type BaseActionItemConfig = {\n  id: string;\n  label?: string;\n  skin?: string;\n};\n\nexport interface Feedback {\n  successToast?: { text: string };\n  errorToast?: { text: string };\n}\n\nexport interface BaseActionModal {\n  title?: { text: string };\n  actions?: {\n    submit?: { text: string };\n    cancel?: { text: string };\n  };\n  feedback?: Feedback;\n}\n\nexport interface ActionModalField {\n  id: string;\n  label?: string;\n}\n\nexport interface DeleteActionModal extends BaseActionModal {\n  description?: { text: string };\n}\n\nexport interface BulkDeleteActionModal extends DeleteActionModal {}\n\nexport type BulkDeleteAction =\n  | {\n      mode: 'modal';\n      modal: BulkDeleteActionModal;\n      custom?: never;\n    }\n  | {\n      mode: 'custom';\n      custom: CustomAction;\n      modal?: never;\n    };\n\nexport type DeleteAction = {\n  mode: 'modal';\n  modal: DeleteActionModal;\n};\n\nexport interface BaseActionPage {\n  id: string;\n}\n\nexport type CustomAction = {};\n\nexport interface ActionModalWithFields extends BaseActionModal {\n  fields: ActionModalField[];\n}\n\nexport interface UpdateActionModal extends ActionModalWithFields {}\n\nexport interface CreateActionModal extends ActionModalWithFields {}\n\nexport interface UpdateActionPage extends BaseActionPage {}\n\nexport interface CreateActionPage extends BaseActionPage {}\n\nexport type UpdateAction = {\n  mode: 'page';\n  page: UpdateActionPage;\n};\n\nexport type CreateAction = {\n  mode: 'page';\n  page: CreateActionPage;\n};\n\nexport type CreateActionConfig = BaseActionItemConfig & {\n  type: 'create';\n  create: CreateAction;\n};\n\nexport type UpdateActionConfig = BaseActionItemConfig & {\n  type: 'update';\n  update: UpdateAction;\n};\n\nexport type DeleteActionConfig = BaseActionItemConfig & {\n  type: 'delete';\n  delete: DeleteAction;\n};\n\nexport type BulkDeleteActionConfig = BaseActionItemConfig & {\n  type: 'bulkDelete';\n  bulkDelete: BulkDeleteAction;\n};\n\nexport type CustomActionConfig = BaseActionItemConfig & {\n  type: 'custom';\n  custom: CustomAction;\n};\n"],"mappings":"","ignoreList":[]}
+{"version":3,"names":[],"sources":["../../../../src/types/actions/base.ts"],"sourcesContent":["export type DividerActionConfig = { type: 'divider' };\n\nexport type BaseActionItemConfig = {\n  id: string;\n  label?: string;\n  skin?: string;\n};\n\nexport interface Feedback {\n  successToast?: { text: string };\n  errorToast?: { text: string };\n}\n\nexport interface BaseActionModal {\n  title?: { text: string };\n  actions?: {\n    submit?: { text: string };\n    cancel?: { text: string };\n  };\n  feedback?: Feedback;\n}\n\nexport interface ActionModalField {\n  id: string;\n  label?: string;\n}\n\nexport interface DeleteActionModal extends BaseActionModal {\n  description?: { text: string };\n}\n\nexport interface BulkDeleteActionModal extends DeleteActionModal {}\n\nexport type BulkDeleteAction =\n  | {\n      mode: 'modal';\n      modal: BulkDeleteActionModal;\n    }\n  | {\n      mode: 'custom';\n      modal?: never;\n    };\n\nexport type DeleteAction = {\n  mode: 'modal';\n  modal: DeleteActionModal;\n};\n\nexport interface BaseActionPage {\n  id: string;\n}\n\nexport interface ActionModalWithFields extends BaseActionModal {\n  fields: ActionModalField[];\n}\n\nexport interface UpdateActionModal extends ActionModalWithFields {}\n\nexport interface CreateActionModal extends ActionModalWithFields {}\n\nexport interface UpdateActionPage extends BaseActionPage {}\n\nexport interface CreateActionPage extends BaseActionPage {}\n\nexport type UpdateAction = {\n  mode: 'page';\n  page: UpdateActionPage;\n};\n\nexport type CreateAction = {\n  mode: 'page';\n  page: CreateActionPage;\n};\n\nexport type CreateActionConfig = BaseActionItemConfig & {\n  type: 'create';\n  create: CreateAction;\n};\n\nexport type UpdateActionConfig = BaseActionItemConfig & {\n  type: 'update';\n  update: UpdateAction;\n};\n\nexport type DeleteActionConfig = BaseActionItemConfig & {\n  type: 'delete';\n  delete: DeleteAction;\n};\n\nexport type BulkDeleteActionConfig = BaseActionItemConfig & {\n  type: 'bulkDelete';\n  bulkDelete: BulkDeleteAction;\n};\n\nexport type CustomActionConfig = BaseActionItemConfig & {\n  type: 'custom';\n};\n"],"mappings":"","ignoreList":[]}

package/dist/cjs/types/actions/entityPageActions.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["../../../../src/types/actions/entityPageActions.ts"],"sourcesContent":["import { FieldValues, UseFormReturn } from '@wix/patterns/form';\nimport { CustomActionParams, ResolvedAction } from '../..';\nimport { CustomActionConfig, DividerActionConfig } from './base';\n\nexport type EntityPageMoreActions = (\n  | CustomActionConfig\n  | DividerActionConfig\n)[];\n\nexport interface EntityPageMoreActionsActionParams {\n  entity: any;\n  form: UseFormReturn<FieldValues, any, undefined>;\n}\n\nexport type CustomEntityPageMoreActionsActionParams =\n  CustomActionParams<EntityPageMoreActionsActionParams>;\n\nexport type CustomEntityPageMoreActionsActionResolver = (\n  params: CustomEntityPageMoreActionsActionParams,\n) => ResolvedAction;\n"],"mappings":"","ignoreList":[]}
+{"version":3,"names":[],"sources":["../../../../src/types/actions/entityPageActions.ts"],"sourcesContent":["import { FieldValues, UseFormReturn } from '@wix/patterns/form';\nimport { CustomActionParams, ResolvedAction } from '../..';\nimport {\n  CreateActionConfig,\n  CustomActionConfig,\n  DividerActionConfig,\n} from './base';\n\nexport type EntityPageMoreActions = (\n  | CustomActionConfig\n  | DividerActionConfig\n)[];\n\nexport type EntityPageActionConfig = CreateActionConfig | CustomActionConfig;\n\ntype EntityPageAction = {\n  type: 'action';\n  action: {\n    item: EntityPageActionConfig;\n  };\n  menu?: never;\n};\n\ntype EntityPageMenu = {\n  type: 'menu';\n  menu: {\n    label: string;\n    items: (EntityPageActionConfig | DividerActionConfig)[];\n  };\n  action?: never;\n};\n\nexport type EntityPagePrimaryActions = EntityPageAction | EntityPageMenu;\nexport type EntityPageSecondaryActions = EntityPageAction | EntityPageMenu;\n\nexport interface EntityPageActionParams {\n  entity: any;\n  form?: UseFormReturn<FieldValues, any, undefined>;\n}\n\nexport type CustomEntityPageActionParams =\n  CustomActionParams<EntityPageActionParams>;\n\nexport type CustomEntityPageActionResolver = (\n  params: CustomEntityPageActionParams,\n) => ResolvedAction;\n"],"mappings":"","ignoreList":[]}

package/dist/cjs/utils/actions/types.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["../../../../src/utils/actions/types.ts"],"sourcesContent":["import { ActionCellAPI, CollectionOptimisticActions } from '@wix/patterns';\nimport {\n  UpdateActionConfig,\n  CustomActionConfig,\n  SchemaConfig,\n  BulkDeleteActionConfig,\n  DeleteActionConfig,\n  CreateActionConfig,\n  BaseSDK,\n} from '../../types';\nimport { IconElement } from '@wix/design-system';\n\nexport interface ResolvedAction {\n  label: string;\n  icon: IconElement;\n  onClick: () => void;\n  disabled?: boolean;\n  tooltip?: string;\n  skin?: string;\n}\n\nexport interface BaseContextParams {\n  schema: SchemaConfig;\n}\n\nexport interface ActionsSDK extends BaseSDK {\n  getSchema: (collectionId: string) => SchemaConfig | undefined;\n  collectionId: string; // TODO: Why collectionId is needed here? getSchema with internal collectionId is enough\n  getOptimisticActions: (\n    collectionId: string,\n  ) => CollectionOptimisticActions<any, any>;\n}\n\nexport interface BaseActionParams<T = Record<string, any>> {\n  sdk: ActionsSDK;\n  actionParams: T;\n}\n\nexport interface ActionCellBaseParams extends BaseActionParams {\n  actionParams: {\n    item: any;\n    index: number;\n    api: ActionCellAPI<any, any>;\n  };\n}\n\nexport interface BulkDeleteActionParams extends BaseActionParams {\n  action: BulkDeleteActionConfig;\n  actionParams: {\n    selectedValues: any[];\n    total: number;\n  };\n}\n\nexport interface DeleteActionParams extends ActionCellBaseParams {\n  action: DeleteActionConfig;\n}\n\nexport interface UpdateActionParams extends ActionCellBaseParams {\n  action: UpdateActionConfig;\n}\n\nexport interface CreateActionParams extends BaseActionParams {\n  action: CreateActionConfig;\n}\n\nexport interface CustomActionParams<T> extends BaseActionParams<T> {\n  action: CustomActionConfig;\n}\n\nexport interface ActionModalProps {\n  modalParams: Record<string, any>;\n  actionParams: Record<string, any>;\n  sdk: ActionsSDK;\n}\n\nexport interface CustomActionModalProps extends ActionModalProps {\n  modalParams: { id: string };\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"names":[],"sources":["../../../../src/utils/actions/types.ts"],"sourcesContent":["import { ActionCellAPI, CollectionOptimisticActions } from '@wix/patterns';\nimport {\n  UpdateActionConfig,\n  CustomActionConfig,\n  SchemaConfig,\n  BulkDeleteActionConfig,\n  DeleteActionConfig,\n  CreateActionConfig,\n  BaseSDK,\n} from '../../types';\nimport { IconElement } from '@wix/design-system';\n\nexport interface ResolvedAction {\n  label: string;\n  icon: IconElement;\n  onClick: () => void;\n  disabled?: boolean;\n  tooltip?: string;\n  skin?: string;\n}\n\nexport interface BaseContextParams {\n  schema: SchemaConfig;\n}\n\nexport interface ActionsSDK extends BaseSDK {\n  getSchema: (collectionId: string) => SchemaConfig | undefined;\n  collectionId: string; // TODO: Why collectionId is needed here? getSchema with internal collectionId is enough\n  getOptimisticActions: (\n    collectionId: string,\n  ) => CollectionOptimisticActions<any, any>;\n}\n\nexport interface BaseActionParams<T = Record<string, any>> {\n  sdk: ActionsSDK;\n  actionParams: T;\n}\n\nexport interface ActionCellBaseParams extends BaseActionParams {\n  actionParams: {\n    item: any;\n    index: number;\n    api: ActionCellAPI<any, any>;\n  };\n}\n\nexport interface BulkDeleteActionParams extends BaseActionParams {\n  action: BulkDeleteActionConfig;\n  actionParams: {\n    selectedValues: any[];\n    total: number;\n  };\n}\n\nexport interface DeleteActionParams extends ActionCellBaseParams {\n  action: DeleteActionConfig;\n}\n\nexport interface UpdateActionParams extends BaseActionParams {\n  action: UpdateActionConfig;\n}\n\nexport interface CreateActionParams extends BaseActionParams {\n  action: CreateActionConfig;\n}\n\nexport interface CustomActionParams<T> extends BaseActionParams<T> {\n  action: CustomActionConfig;\n}\n\nexport interface ActionModalProps {\n  modalParams: Record<string, any>;\n  actionParams: Record<string, any>;\n  sdk: ActionsSDK;\n}\n\nexport interface CustomActionModalProps extends ActionModalProps {\n  modalParams: { id: string };\n}\n"],"mappings":"","ignoreList":[]}

package/dist/docs/action_cell.md

@@ -131,11 +131,15 @@ Custom actions execute JavaScript code that you define. These actions receive pa
          optimisticActions.updateOne(updatedItem, {
            submit: async (items) => {
              // Your download logic here + update server
-             return await schema.actions.update(items[0]);
+             // Handle potential undefined schema
+             if (schema) {
+               return await schema.actions.update(items[0]);
+             }
+             return items[0]; // fallback when schema is unavailable
            },
            successToast: 'Pet details downloaded',
            errorToast: (err, {retry}) => ({
-             text: 'Download failed',
+             message: 'Download failed',
              action: { text: 'Retry', onClick: retry }
            })
          });

package/dist/docs/app_config_structure.md

@@ -17,6 +17,13 @@
 - Not designating exactly one page as `appMainPage: true`
 - Missing or inconsistent page relationships (parentPageId/entityPageId)
 - Setting `stickyColumns` to invalid values (negative, zero, or exceeding column count)
+- **Missing custom property**: When `entityTypeSource: 'custom'`, forgetting to include the required `custom: { id: "..." }` property will cause TypeScript errors
+- **Using incorrect field types**: Mismatching page type with configuration object (e.g., `type: 'entityPage'` with `collectionPage` field)
+- **Including fields from wrong page type**: Adding both `collectionPage` and `entityPage` fields in the same page configuration
+- **Missing action layout properties**: Not including `action` property when `type: 'action'` or `menu` property when `type: 'menu'`
+- **Missing action type properties**: Not including `create`, `update`, `delete`, or `bulkDelete` properties when required by the action type
+- **Including wrong action properties**: Adding properties from different action types in the same action configuration
+- **Action type mismatches**: Using action cell types in collection actions, or bulk action types in regular actions
 
 ```ts
 export interface AppConfig {
@@ -46,8 +53,8 @@ export interface AppConfig {
               collection: {
                 collectionId: string; // ID of the Wix Data collection
                 entityTypeSource: 'cms' | 'custom'; // Data source type.
-                custom?: {
-                  id: string;
+                custom?: { // REQUIRED when entityTypeSource is 'custom'
+                  id: string; // ID matching your custom data source identifier
                 };
               };
               create?: { // Required when type is 'create'
@@ -76,8 +83,8 @@ export interface AppConfig {
           collection: {
             collectionId: string; // ID of the Wix Data collection
             entityTypeSource: 'cms' | 'custom'; // Data source type.
-            custom?: {
-              id: string;
+            custom?: { // REQUIRED when entityTypeSource is 'custom'
+              id: string; // ID matching your custom data source identifier
             };
             reflectQueryInUrl?: boolean; // Reflects query state (search, filters, sorting) in the browser URL. Default: false
             selectAllScope?: 'page' | 'all'; // Controls "Select All" scope. 'all' selects entire collection, 'page' selects only visible items. Default: 'all'
@@ -298,6 +305,7 @@ export interface AppConfig {
       ]; // End of components array
     };
     entityPage?: {
+      mode?: 'edit' | 'view'; // Entity page mode. Default: 'edit'
       route: {
         path: string; // Route path for the entity page (e.g., '/product/:entityId')
         params: {
@@ -310,6 +318,40 @@ export interface AppConfig {
       subtitle?: {
         text: string; // Entity page subtitle
       };
+      actions?: { // Action configuration varies by mode
+        // Edit mode: only moreActions supported
+        // View mode: primaryActions, secondaryActions, and moreActions supported
+        primaryActions?: { // View mode only
+          type: 'action' | 'menu';
+          action?: {
+            item: {
+              id: string;
+              type: 'create' | 'custom';
+              label?: string;
+              create?: { // Required when type is 'create'
+                mode: 'page';
+                page: {
+                  id: string; // Entity page ID to navigate to
+                };
+              };
+            };
+          };
+          menu?: {
+            label: string;
+            items: {}[]; // Array of action configurations, same structure as action.item, can include dividers
+          };
+        };
+        secondaryActions?: { // View mode only - same structure as primaryActions
+          type: 'action' | 'menu';
+          action?: {}; // Same structure as primaryActions.action
+          menu?: {}; // Same structure as primaryActions.menu
+        };
+        moreActions?: { // Both modes
+          id: string;
+          type: 'custom';
+          label?: string;
+        }[];
+      };
       parentPageId?: string; // ID of the parent collection page
       layout?: {
         // Main layout section
@@ -341,8 +383,8 @@ export interface AppConfig {
       };
       collectionId: string; // Related collection ID
       entityTypeSource: 'cms' | 'custom'; // Data source type.
-      custom?: {
-        id: string;
+      custom?: { // REQUIRED when entityTypeSource is 'custom'
+        id: string; // ID matching your custom data source identifier
       };
     };
   }[];