@wix/auto-patterns 1.18.0 → 1.20.0

package/dist/docs/bulk_actions.md

@@ -59,7 +59,7 @@ Custom bulk actions execute JavaScript code that you define for bulk operations.
    ├── page.tsx
    └── components/
        └── actions/
-           ├── index.tsx                    // Exports all actions
+           ├── index.tsx                    // Exports useActions hook
            └── bulkExportPets.tsx          // Your custom bulk action
    ```
 
@@ -121,10 +121,17 @@ Custom bulk actions execute JavaScript code that you define for bulk operations.
 
 3. Export your action in `actions/index.tsx`:
    ```typescript
-   export * from './bulkExportPets';
+   import { bulkExportPets } from './bulkExportPets';
+
+   export const useActions = () => {
+     // You can access React context and other hooks here
+     return {
+       bulkExportPets
+     };
+   };
    ```
 
-4. Configure the action in your JSON configuration:
+4. Configure the action in your TypeScript configuration:
    ```json
    {
      "id": "bulkExportPets",        // MUST match the function name exactly
@@ -135,11 +142,17 @@ Custom bulk actions execute JavaScript code that you define for bulk operations.
 
 5. Register your action in the `PatternsWizardOverridesProvider`:
    ```typescript
-   import * as actions from './components/actions';
+   import { useActions } from '../components/actions';
+
+   export default function YourPage() {
+     const actions = useActions();
 
-   <PatternsWizardOverridesProvider value={{ actions }}>
-     <AutoPatternsApp configuration={config as AppConfig} />
-   </PatternsWizardOverridesProvider>
+     return (
+       <PatternsWizardOverridesProvider value={{ actions }}>
+         <AutoPatternsApp configuration={config} />
+       </PatternsWizardOverridesProvider>
+     );
+   }
    ```
 
 ### Key Points for Custom Bulk Actions:

package/dist/docs/collection_page_actions.md

@@ -56,7 +56,7 @@ Custom collection page actions execute JavaScript code that you define for colle
    ├── page.tsx
    └── components/
        └── actions/
-           ├── index.tsx                    // Exports all actions
+           ├── index.tsx                    // Exports useActions hook
            └── exportCollection.tsx        // Your custom collection action
    ```
 
@@ -103,10 +103,17 @@ Custom collection page actions execute JavaScript code that you define for colle
 
 3. Export your action in `actions/index.tsx`:
    ```typescript
-   export * from './exportCollection';
+   import { exportCollection } from './exportCollection';
+
+   export const useActions = () => {
+     // You can access React context and other hooks here
+     return {
+       exportCollection
+     };
+   };
    ```
 
-4. Configure the action in your JSON configuration:
+4. Configure the action in your TypeScript configuration:
    ```json
    {
      "id": "exportCollection",        // MUST match the function name exactly
@@ -121,11 +128,17 @@ Custom collection page actions execute JavaScript code that you define for colle
 
 5. Register your action in the `PatternsWizardOverridesProvider`:
    ```typescript
-   import * as actions from './components/actions';
+   import { useActions } from '../components/actions';
 
-   <PatternsWizardOverridesProvider value={{ actions }}>
-     <AutoPatternsApp configuration={config as AppConfig} />
-   </PatternsWizardOverridesProvider>
+   export default function YourPage() {
+     const actions = useActions();
+
+     return (
+       <PatternsWizardOverridesProvider value={{ actions }}>
+         <AutoPatternsApp configuration={config} />
+       </PatternsWizardOverridesProvider>
+     );
+   }
    ```
 
 ## Key Points for Custom Collection Page Actions:
@@ -165,7 +178,7 @@ Row click actions are configured at the table level using the `onRowClick` prope
 
 ### Implementation Requirements
 
-⚠️ **CRITICAL**: When you configure `onRowClick` in your JSON, you MUST provide a complete working implementation. The Auto Patterns framework cannot function without it.
+⚠️ **CRITICAL**: When you configure `onRowClick` in your TypeScript configuration, you MUST provide a complete working implementation. The Auto Patterns framework cannot function without it.
 
 Custom row click actions use the `CustomActionCollectionPageActionOnRowClickResolver` type and MUST return a `ResolvedAction` object with all required properties:
 
@@ -243,7 +256,18 @@ export const openSidePanel: CustomActionCollectionPageActionOnRowClickResolver =
 };
 ```
 
-**Step 2: Configure in JSON**:
+**Step 2: Export your action in `actions/index.tsx`**:
+```typescript
+import { openSidePanel } from './openSidePanel';
+
+export const useActions = () => {
+  return {
+    openSidePanel
+  };
+};
+```
+
+**Step 3: Configure in TypeScript**:
 ```json
 {
   "type": "Table",
@@ -257,17 +281,19 @@ export const openSidePanel: CustomActionCollectionPageActionOnRowClickResolver =
 }
 ```
 
-**Step 3: Export and Register**:
+**Step 4: Register in `PatternsWizardOverridesProvider`**:
 ```typescript
-// components/actions/index.tsx
-export * from './openSidePanel';
+import { useActions } from '../components/actions';
 
-// page.tsx
-import * as actions from './components/actions';
+export default function YourPage() {
+  const actions = useActions();
 
-<PatternsWizardOverridesProvider value={{ actions }}>
-  <AutoPatternsApp configuration={config as AppConfig} />
-</PatternsWizardOverridesProvider>
+  return (
+    <PatternsWizardOverridesProvider value={{ actions }}>
+      <AutoPatternsApp configuration={config} />
+    </PatternsWizardOverridesProvider>
+  );
+}
 ```
 
 #### 2. Direct Data Manipulation
@@ -314,7 +340,7 @@ export const quickToggle: CustomActionCollectionPageActionOnRowClickResolver = (
 - You can still navigate to the entity page programmatically if needed using the SDK navigation utilities
 
 ### Key Points for Custom Row Click Actions:
-- **MANDATORY IMPLEMENTATION**: If you configure `onRowClick` in JSON, you MUST provide a complete working implementation - the framework cannot function without it
+- **MANDATORY IMPLEMENTATION**: If you configure `onRowClick` in TypeScript configuration, you MUST provide a complete working implementation - the framework cannot function without it
 - The action `id` in the configuration MUST exactly match the function name exported from your actions folder
 - The implementation must use the `CustomActionCollectionPageActionOnRowClickResolver` type
 - **Required Return Object**: Must return an object with `label`, `icon`, and `onClick` properties - all are required
@@ -330,7 +356,7 @@ export const quickToggle: CustomActionCollectionPageActionOnRowClickResolver = (
 ✓ `primaryActions` and `secondaryActions` (if defined) have a valid `type` ("action" or "menu").
 ✓ If `type: "action"`, `action.item` is a valid action item configuration.
 ✓ If `type: "menu"`, `menu.items` is an array of valid action item configurations that can include dividers.
-✓ Each action item contains a unique `id`, and the full `collection` object (`collectionId`, `entityTypeSource: 'cms'`).
+✓ Each action item contains a unique `id`, and the full `collection` object (`collectionId`, `entityTypeSource`).
 ✓ Each action item has a supported `type` (`create`, `custom`) and its corresponding configuration block (e.g., `create` block for `type: "create"`).
 ✓ `create` actions specify a `create.page.id` that matches an existing `entityPage` ID in the configuration.
 ✓ `custom` actions (identified by their main `id`) correspond to an action resolver function name registered in the `actions` override.