@codee-sh/medusa-plugin-automations 1.0.0 → 1.0.2

package/README.md

@@ -1,16 +1,19 @@
 # Medusa plugin automations
 
-A comprehensive notification automation plugin for Medusa v2 that provides a flexible rule-based notification system with triggers, conditions, and actions. Create automated notifications based on events, schedules, or manual triggers with customizable rules.
+A comprehensive automation plugin for Medusa v2 that provides a flexible rule-based automation system with triggers, conditions, and actions. Create automated workflows that can send notifications (email, Slack), execute custom actions, or trigger other processes based on events, schedules, or manual triggers with customizable rules.
 
 ## Features
 
-- **Automation Triggers**: Create notification automations triggered by events, schedules, or manual actions
+- **Automation Triggers**: Create automations triggered by events, schedules, or manual actions
+- **Automation Management**: Create, edit, and delete automation triggers with automatic cleanup of related data
 - **Rule-Based Conditions**: Define complex conditions using rule attributes (e.g., inventory levels, order status)
+- **Multiple Action Types**: Execute various actions including email notifications, Slack messages, SMS, push notifications, and custom actions
 - **Event Subscribers**: Built-in subscribers for common Medusa events (inventory updates, order events, payment events)
 - **Admin Panel**: Manage automations directly from Medusa Admin
 - **Flexible Rules**: Support for multiple rule types and operators (equals, greater than, less than, contains, etc.)
+- **Slack Notifications**: Rich Slack notifications with Block Kit support including headers, action buttons, and dividers
+- **Extensible Actions**: Add custom action handlers to extend automation capabilities
 - **Type-Safe**: Full TypeScript support with exported types and workflows
-- **Extensible**: Add custom rule attributes and extend functionality via plugin options
 
 ## Compatibility
 
@@ -61,18 +64,26 @@ Navigate to **Notifications > Automations** in your Medusa Admin dashboard, or d
 
 Automations are triggered by:
 - **Events**: Medusa events (e.g., `inventory.inventory-level.updated`, `order.placed`)
-- **Schedule**: Time-based triggers with configurable intervals
+- **Schedule**: Time-based triggers with configurable intervals (In progress)
 - **Manual**: Triggered manually from the admin panel
 
 ### Rules and Conditions
 
-Each automation can have multiple rules that define when notifications should be sent:
+Each automation can have multiple rules that define when actions should be executed:
 
-- **Rule Attributes**: Available attributes for conditions (e.g., `inventory_level.available_quantity`, `inventory_item.sku`)
+- **Rule Attributes**: Available attributes for conditions
 - **Operators**: Comparison operators (equals, greater than, less than, contains, in, etc.)
 - **Rule Values**: Values to compare against
 
-See [Configuration Documentation](./docs/configuration.md) for details on built-in subscribers, available rule attributes, and extending functionality.
+### Actions
+
+When automation rules pass, actions are executed. Supported action types include:
+
+- **Email**: Send email notifications
+- **Slack**: Send Slack messages with Block Kit formatting
+- **Custom**: Extend with custom action handlers
+
+See [Configuration Documentation](./docs/configuration.md) for details on built-in subscribers, available actions, and extending functionality.
 
 ## Admin Panel
 
@@ -87,13 +98,13 @@ Access the automations management interface in Medusa Admin at `/app/notificatio
 
 The plugin exports the following:
 
-- `@codee-sh/medusa-plugin-notification/workflows` - Workflow functions for automation management
-- `@codee-sh/medusa-plugin-notification/modules/mpn-automation` - Automation module service
-- `@codee-sh/medusa-plugin-notification/utils` - Utility functions
+- `@codee-sh/medusa-plugin-automations/workflows` - Workflow functions for automation management
+- `@codee-sh/medusa-plugin-automations/modules/mpn-automation` - Automation module service
+- `@codee-sh/medusa-plugin-automations/utils` - Utility functions
 
 ## Related Plugins
 
-For email templates and rendering functionality, see [@codee-sh/medusa-plugin-notification-emails](https://github.com/codee-sh/medusa-plugin-notification-emails).
+For email templates and rendering functionality, see [@codee-sh/medusa-plugin-automations-emails](https://github.com/codee-sh/medusa-plugin-notification-emails).
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codee-sh/medusa-plugin-automations",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Medusa plugin for automations.",
   "author": "Codee (https://codee.dev)",
   "license": "MIT",
@@ -37,7 +37,9 @@
     "dev": "medusa plugin:develop",
     "prepublishOnly": "medusa plugin:build",
     "publish-local": "npx medusa plugin:publish",
-    "publish-package": "dotenv npm publish --access public"
+    "publish-package": "dotenv npm publish --access public",
+    "format": "prettier --write \"src/**/*.{ts,tsx}\"",
+    "format:check": "prettier --check \"src/**/*.{ts,tsx}\""
   },
   "devDependencies": {
     "@medusajs/admin-sdk": "2.8.8",

package/.medusa/server/src/modules/mpn-automation/types.js

@@ -1,199 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ALL_EVENTS = exports.EVENT_ORDER_TYPES = exports.EVENT_CUSTOMER_TYPES = exports.EVENT_INVENTORY_TYPES = exports.INVENTORY_LEVEL_ATTRIBUTES = exports.INVENTORY_ITEM_ATTRIBUTES = exports.ACTION_TYPES = exports.TRIGGER_TYPES = exports.OPERATOR_TYPES = exports.OperatorType = exports.ActionType = exports.TriggerType = void 0;
-var TriggerType;
-(function (TriggerType) {
-    TriggerType["EVENT"] = "event";
-    TriggerType["SCHEDULE"] = "schedule";
-    TriggerType["MANUAL"] = "manual";
-})(TriggerType || (exports.TriggerType = TriggerType = {}));
-var ActionType;
-(function (ActionType) {
-    ActionType["EMAIL"] = "email";
-    ActionType["SMS"] = "sms";
-    ActionType["PUSH"] = "push";
-    ActionType["IN_APP"] = "in_app";
-    ActionType["SLACK"] = "slack";
-    ActionType["ADMIN"] = "admin";
-})(ActionType || (exports.ActionType = ActionType = {}));
-var OperatorType;
-(function (OperatorType) {
-    OperatorType["EQUAL"] = "eq";
-    OperatorType["NOT_EQUAL"] = "neq";
-    OperatorType["GREATER_THAN"] = "gt";
-    OperatorType["LESS_THAN"] = "lt";
-    OperatorType["GREATER_THAN_OR_EQUAL"] = "gte";
-    OperatorType["LESS_THAN_OR_EQUAL"] = "lte";
-})(OperatorType || (exports.OperatorType = OperatorType = {}));
-exports.OPERATOR_TYPES = [
-    {
-        value: OperatorType.EQUAL,
-        label: "Equal"
-    },
-    {
-        value: OperatorType.NOT_EQUAL,
-        label: "Not Equal"
-    },
-    {
-        value: OperatorType.GREATER_THAN,
-        label: "Greater Than"
-    },
-    {
-        value: OperatorType.LESS_THAN,
-        label: "Less Than"
-    },
-    {
-        value: OperatorType.GREATER_THAN_OR_EQUAL,
-        label: "Greater Than or Equal"
-    },
-    {
-        value: OperatorType.LESS_THAN_OR_EQUAL,
-        label: "Less Than or Equal"
-    },
-];
-exports.TRIGGER_TYPES = [
-    {
-        value: TriggerType.EVENT,
-        label: "Event"
-    },
-    {
-        value: TriggerType.SCHEDULE,
-        label: "Schedule"
-    },
-    {
-        value: TriggerType.MANUAL,
-        label: "Manual"
-    }
-];
-exports.ACTION_TYPES = [
-    {
-        value: ActionType.EMAIL,
-        label: "Email"
-    },
-    {
-        value: ActionType.SMS,
-        label: "SMS"
-    },
-    {
-        value: ActionType.PUSH,
-        label: "Push"
-    },
-    {
-        value: ActionType.IN_APP,
-        label: "In App"
-    },
-    {
-        value: ActionType.SLACK,
-        label: "Slack"
-    },
-    {
-        value: ActionType.ADMIN,
-        label: "Admin"
-    },
-];
-exports.INVENTORY_ITEM_ATTRIBUTES = [
-    {
-        value: "inventory_item.stocked_quantity",
-        label: "Stocked Quantity"
-    },
-    {
-        value: "inventory_item.reserved_quantity",
-        label: "Reserved Quantity"
-    },
-    {
-        value: "inventory_item.available_quantity",
-        label: "Available Quantity"
-    },
-    {
-        value: "inventory_item.incoming_quantity",
-        label: "Incoming Quantity"
-    },
-    {
-        value: "inventory_item.location_id",
-        label: "Location ID"
-    },
-];
-exports.INVENTORY_LEVEL_ATTRIBUTES = [
-    {
-        value: "inventory_level.stocked_quantity",
-        label: "Stocked Quantity"
-    },
-    {
-        value: "inventory_level.reserved_quantity",
-        label: "Reserved Quantity"
-    },
-    {
-        value: "inventory_level.available_quantity",
-        label: "Available Quantity"
-    },
-    {
-        value: "inventory_level.incoming_quantity",
-        label: "Incoming Quantity"
-    },
-    {
-        value: "inventory_level.location_id",
-        label: "Location ID"
-    },
-];
-exports.EVENT_INVENTORY_TYPES = [
-    {
-        value: "inventory.inventory-level.created",
-        label: "Inventory Level Created",
-        attributes: exports.INVENTORY_LEVEL_ATTRIBUTES
-    },
-    {
-        value: "inventory.inventory-level.updated",
-        label: "Inventory Level Updated",
-        attributes: exports.INVENTORY_LEVEL_ATTRIBUTES
-    },
-    {
-        value: "inventory.inventory-level.deleted",
-        label: "Inventory Level Deleted",
-        attributes: exports.INVENTORY_LEVEL_ATTRIBUTES
-    }
-];
-exports.EVENT_CUSTOMER_TYPES = [
-    {
-        value: "customer.created",
-        label: "Customer Created"
-    },
-    {
-        value: "customer.updated",
-        label: "Customer Updated"
-    }
-];
-exports.EVENT_ORDER_TYPES = [
-    {
-        value: "order.placed",
-        label: "Order Placed"
-    },
-    {
-        value: "order.completed",
-        label: "Order Completed"
-    },
-    {
-        value: "order.shipped",
-        label: "Order Shipped"
-    }
-];
-exports.ALL_EVENTS = [
-    {
-        name: "Inventory",
-        events: [
-            ...exports.EVENT_INVENTORY_TYPES,
-        ]
-    },
-    {
-        name: "Customer",
-        events: [
-            ...exports.EVENT_CUSTOMER_TYPES,
-        ]
-    },
-    {
-        name: "Order",
-        events: [
-            ...exports.EVENT_ORDER_TYPES,
-        ]
-    }
-];
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi8uLi9zcmMvbW9kdWxlcy9tcG4tYXV0b21hdGlvbi90eXBlcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUEwQkEsSUFBWSxXQUlYO0FBSkQsV0FBWSxXQUFXO0lBQ3JCLDhCQUFlLENBQUE7SUFDZixvQ0FBcUIsQ0FBQTtJQUNyQixnQ0FBaUIsQ0FBQTtBQUNuQixDQUFDLEVBSlcsV0FBVywyQkFBWCxXQUFXLFFBSXRCO0FBRUQsSUFBWSxVQU9YO0FBUEQsV0FBWSxVQUFVO0lBQ3BCLDZCQUFlLENBQUE7SUFDZix5QkFBVyxDQUFBO0lBQ1gsMkJBQWEsQ0FBQTtJQUNiLCtCQUFpQixDQUFBO0lBQ2pCLDZCQUFlLENBQUE7SUFDZiw2QkFBZSxDQUFBO0FBQ2pCLENBQUMsRUFQVyxVQUFVLDBCQUFWLFVBQVUsUUFPckI7QUFFRCxJQUFZLFlBT1g7QUFQRCxXQUFZLFlBQVk7SUFDdEIsNEJBQVksQ0FBQTtJQUNaLGlDQUFpQixDQUFBO0lBQ2pCLG1DQUFtQixDQUFBO0lBQ25CLGdDQUFnQixDQUFBO0lBQ2hCLDZDQUE2QixDQUFBO0lBQzdCLDBDQUEwQixDQUFBO0FBQzVCLENBQUMsRUFQVyxZQUFZLDRCQUFaLFlBQVksUUFPdkI7QUFFWSxRQUFBLGNBQWMsR0FBRztJQUM1QjtRQUNFLEtBQUssRUFBRSxZQUFZLENBQUMsS0FBSztRQUN6QixLQUFLLEVBQUUsT0FBTztLQUNmO0lBQ0Q7UUFDRSxLQUFLLEVBQUUsWUFBWSxDQUFDLFNBQVM7UUFDN0IsS0FBSyxFQUFFLFdBQVc7S0FDbkI7SUFDRDtRQUNFLEtBQUssRUFBRSxZQUFZLENBQUMsWUFBWTtRQUNoQyxLQUFLLEVBQUUsY0FBYztLQUN0QjtJQUNEO1FBQ0UsS0FBSyxFQUFFLFlBQVksQ0FBQyxTQUFTO1FBQzdCLEtBQUssRUFBRSxXQUFXO0tBQ25CO0lBQ0Q7UUFDRSxLQUFLLEVBQUUsWUFBWSxDQUFDLHFCQUFxQjtRQUN6QyxLQUFLLEVBQUUsdUJBQXVCO0tBQy9CO0lBQ0Q7UUFDRSxLQUFLLEVBQUUsWUFBWSxDQUFDLGtCQUFrQjtRQUN0QyxLQUFLLEVBQUUsb0JBQW9CO0tBQzVCO0NBQ0YsQ0FBQTtBQUVZLFFBQUEsYUFBYSxHQUFHO0lBQzNCO1FBQ0UsS0FBSyxFQUFFLFdBQVcsQ0FBQyxLQUFLO1FBQ3hCLEtBQUssRUFBRSxPQUFPO0tBQ2Y7SUFDRDtRQUNFLEtBQUssRUFBRSxXQUFXLENBQUMsUUFBUTtRQUMzQixLQUFLLEVBQUUsVUFBVTtLQUNsQjtJQUNEO1FBQ0UsS0FBSyxFQUFFLFdBQVcsQ0FBQyxNQUFNO1FBQ3pCLEtBQUssRUFBRSxRQUFRO0tBQ2hCO0NBQ0YsQ0FBQTtBQUVZLFFBQUEsWUFBWSxHQUFHO0lBQzFCO1FBQ0UsS0FBSyxFQUFFLFVBQVUsQ0FBQyxLQUFLO1FBQ3ZCLEtBQUssRUFBRSxPQUFPO0tBQ2Y7SUFDRDtRQUNFLEtBQUssRUFBRSxVQUFVLENBQUMsR0FBRztRQUNyQixLQUFLLEVBQUUsS0FBSztLQUNiO0lBQ0Q7UUFDRSxLQUFLLEVBQUUsVUFBVSxDQUFDLElBQUk7UUFDdEIsS0FBSyxFQUFFLE1BQU07S0FDZDtJQUNEO1FBQ0UsS0FBSyxFQUFFLFVBQVUsQ0FBQyxNQUFNO1FBQ3hCLEtBQUssRUFBRSxRQUFRO0tBQ2hCO0lBQ0Q7UUFDRSxLQUFLLEVBQUUsVUFBVSxDQUFDLEtBQUs7UUFDdkIsS0FBSyxFQUFFLE9BQU87S0FDZjtJQUNEO1FBQ0UsS0FBSyxFQUFFLFVBQVUsQ0FBQyxLQUFLO1FBQ3ZCLEtBQUssRUFBRSxPQUFPO0tBQ2Y7Q0FDRixDQUFBO0FBRVksUUFBQSx5QkFBeUIsR0FBRztJQUN2QztRQUNFLEtBQUssRUFBRSxpQ0FBaUM7UUFDeEMsS0FBSyxFQUFFLGtCQUFrQjtLQUMxQjtJQUNEO1FBQ0UsS0FBSyxFQUFFLGtDQUFrQztRQUN6QyxLQUFLLEVBQUUsbUJBQW1CO0tBQzNCO0lBQ0Q7UUFDRSxLQUFLLEVBQUUsbUNBQW1DO1FBQzFDLEtBQUssRUFBRSxvQkFBb0I7S0FDNUI7SUFDRDtRQUNFLEtBQUssRUFBRSxrQ0FBa0M7UUFDekMsS0FBSyxFQUFFLG1CQUFtQjtLQUMzQjtJQUNEO1FBQ0UsS0FBSyxFQUFFLDRCQUE0QjtRQUNuQyxLQUFLLEVBQUUsYUFBYTtLQUNyQjtDQUNGLENBQUE7QUFFWSxRQUFBLDBCQUEwQixHQUFHO0lBQ3hDO1FBQ0UsS0FBSyxFQUFFLGtDQUFrQztRQUN6QyxLQUFLLEVBQUUsa0JBQWtCO0tBQzFCO0lBQ0Q7UUFDRSxLQUFLLEVBQUUsbUNBQW1DO1FBQzFDLEtBQUssRUFBRSxtQkFBbUI7S0FDM0I7SUFDRDtRQUNFLEtBQUssRUFBRSxvQ0FBb0M7UUFDM0MsS0FBSyxFQUFFLG9CQUFvQjtLQUM1QjtJQUNEO1FBQ0UsS0FBSyxFQUFFLG1DQUFtQztRQUMxQyxLQUFLLEVBQUUsbUJBQW1CO0tBQzNCO0lBQ0Q7UUFDRSxLQUFLLEVBQUUsNkJBQTZCO1FBQ3BDLEtBQUssRUFBRSxhQUFhO0tBQ3JCO0NBQ0YsQ0FBQTtBQUVZLFFBQUEscUJBQXFCLEdBQUc7SUFDbkM7UUFDRSxLQUFLLEVBQUUsbUNBQW1DO1FBQzFDLEtBQUssRUFBRSx5QkFBeUI7UUFDaEMsVUFBVSxFQUFFLGtDQUEwQjtLQUN2QztJQUNEO1FBQ0UsS0FBSyxFQUFFLG1DQUFtQztRQUMxQyxLQUFLLEVBQUUseUJBQXlCO1FBQ2hDLFVBQVUsRUFBRSxrQ0FBMEI7S0FDdkM7SUFDRDtRQUNFLEtBQUssRUFBRSxtQ0FBbUM7UUFDMUMsS0FBSyxFQUFFLHlCQUF5QjtRQUNoQyxVQUFVLEVBQUUsa0NBQTBCO0tBQ3ZDO0NBQ0YsQ0FBQTtBQUVZLFFBQUEsb0JBQW9CLEdBQUc7SUFDbEM7UUFDRSxLQUFLLEVBQUUsa0JBQWtCO1FBQ3pCLEtBQUssRUFBRSxrQkFBa0I7S0FDMUI7SUFDRDtRQUNFLEtBQUssRUFBRSxrQkFBa0I7UUFDekIsS0FBSyxFQUFFLGtCQUFrQjtLQUMxQjtDQUNGLENBQUE7QUFFWSxRQUFBLGlCQUFpQixHQUFHO0lBQy9CO1FBQ0UsS0FBSyxFQUFFLGNBQWM7UUFDckIsS0FBSyxFQUFFLGNBQWM7S0FDdEI7SUFDRDtRQUNFLEtBQUssRUFBRSxpQkFBaUI7UUFDeEIsS0FBSyxFQUFFLGlCQUFpQjtLQUN6QjtJQUNEO1FBQ0UsS0FBSyxFQUFFLGVBQWU7UUFDdEIsS0FBSyxFQUFFLGVBQWU7S0FDdkI7Q0FDRixDQUFBO0FBRVksUUFBQSxVQUFVLEdBQUc7SUFDeEI7UUFDRSxJQUFJLEVBQUUsV0FBVztRQUNqQixNQUFNLEVBQUU7WUFDTixHQUFHLDZCQUFxQjtTQUN6QjtLQUNGO0lBQ0Q7UUFDRSxJQUFJLEVBQUUsVUFBVTtRQUNoQixNQUFNLEVBQUU7WUFDTixHQUFHLDRCQUFvQjtTQUN4QjtLQUNGO0lBQ0Q7UUFDRSxJQUFJLEVBQUUsT0FBTztRQUNiLE1BQU0sRUFBRTtZQUNOLEdBQUcseUJBQWlCO1NBQ3JCO0tBQ0Y7Q0FDRixDQUFBIn0=