@codee-sh/medusa-plugin-automations 1.0.0

package/.medusa/server/src/workflows/notifications/steps/send-email.js

@@ -0,0 +1,119 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendEmailStep = exports.sendEmailStepId = void 0;
+const workflows_sdk_1 = require("@medusajs/framework/workflows-sdk");
+const utils_1 = require("@medusajs/framework/utils");
+const emails_1 = require("@codee-sh/medusa-plugin-notification-emails/templates/emails");
+const plugins_1 = require("@codee-sh/medusa-plugin-automations/utils/plugins");
+exports.sendEmailStepId = "send-email";
+/**
+ * Universal step that sends an email notification.
+ *
+ * This step can be used independently or as part of automation workflows.
+ *
+ * Configuration:
+ * - templateName: Required - Name of the email template to use
+ * - to: Required - Recipient email address
+ * - locale: Optional - Locale for translations (default: "pl")
+ * - customTemplate: Optional - Path to custom template function
+ * - subject: Optional - Custom subject (otherwise uses template default)
+ * - template: Optional - Template identifier for notification (defaults to templateName)
+ * - resourceId: Optional - Resource ID for notification tracking
+ * - resourceType: Optional - Resource type for notification tracking
+ *
+ * @example
+ * ```typescript
+ * // Standalone usage
+ * const result = await sendEmailStep({
+ *   settings: {
+ *     templateName: "inventory-level",
+ *     to: "admin@example.com",
+ *     locale: "pl"
+ *   },
+ *   templateData: {
+ *     inventory_level: { ... }
+ *   }
+ * })
+ * ```
+ */
+exports.sendEmailStep = (0, workflows_sdk_1.createStep)(exports.sendEmailStepId, async (input, { container }) => {
+    const { settings, templateData, eventName } = input;
+    // Validate required config
+    if (!settings.templateName) {
+        return new workflows_sdk_1.StepResponse({
+            success: false,
+            error: "templateName is required in config",
+        });
+    }
+    if (!settings.to) {
+        return new workflows_sdk_1.StepResponse({
+            success: false,
+            error: "to (recipient email) is required in config",
+        });
+    }
+    try {
+        const notificationModuleService = container.resolve(utils_1.Modules.NOTIFICATION);
+        const pluginOptions = (0, plugins_1.getPluginOptions)(container, "@codee-sh/medusa-plugin-notification-emails");
+        const templateName = settings.templateName;
+        const to = settings.to;
+        const locale = settings.locale || "pl";
+        const customSubject = settings.subject;
+        const resourceId = settings.resourceId || 'unknown';
+        const resourceType = settings.resourceType || "email.notification";
+        const channel = settings.channel || "email";
+        const triggerType = settings.triggerType || "system";
+        // Prepare render options
+        const renderOptions = {
+            locale,
+            theme: pluginOptions?.theme,
+            customTranslations: pluginOptions?.customTranslations?.[templateName],
+        };
+        // Load custom template function if specified
+        let customTemplateFunction;
+        if (settings.customTemplate) {
+            try {
+                // Dynamic import of custom template
+                // config.customTemplate should be a relative path like "../emails/pos-email-inventory"
+                // or absolute path from project root like "src/emails/pos-email-inventory"
+                const customTemplateModule = await import(settings.customTemplate);
+                customTemplateFunction = customTemplateModule.default || customTemplateModule.createCustomTemplate || customTemplateModule.createTemplate;
+                if (!customTemplateFunction) {
+                    console.warn(`Custom template module from ${settings.customTemplate} does not export a default function or createCustomTemplate/createTemplate`);
+                }
+            }
+            catch (error) {
+                console.warn(`Failed to load custom template from ${settings.customTemplate}:`, error);
+                // Continue with default template
+            }
+        }
+        // Render email template
+        const { html, text, subject } = await (0, emails_1.renderTemplate)(templateName, templateData, renderOptions, customTemplateFunction);
+        // Send notification
+        const notificationResult = await notificationModuleService.createNotifications({
+            to: to,
+            channel: channel,
+            template: settings.template || templateName,
+            trigger_type: triggerType,
+            resource_id: resourceId,
+            resource_type: resourceType,
+            data: templateData,
+            content: {
+                subject: customSubject || subject,
+                html: html,
+                text: text,
+            },
+        });
+        return new workflows_sdk_1.StepResponse({
+            success: true,
+            notificationId: notificationResult?.id,
+        });
+    }
+    catch (error) {
+        console.error(`Failed to send email:`, error);
+        return new workflows_sdk_1.StepResponse({
+            success: false,
+            error: error?.message || "Unknown error occurred",
+        });
+    }
+});
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VuZC1lbWFpbC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uLy4uL3NyYy93b3JrZmxvd3Mvbm90aWZpY2F0aW9ucy9zdGVwcy9zZW5kLWVtYWlsLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUNBLHFFQUE0RTtBQUM1RSxxREFBbUQ7QUFDbkQseUZBQTZGO0FBQzdGLCtFQUFvRjtBQTZCdkUsUUFBQSxlQUFlLEdBQUcsWUFBWSxDQUFBO0FBRTNDOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQTZCRztBQUNVLFFBQUEsYUFBYSxHQUFHLElBQUEsMEJBQVUsRUFDckMsdUJBQWUsRUFDZixLQUFLLEVBQ0gsS0FBeUIsRUFDekIsRUFBRSxTQUFTLEVBQUUsRUFDK0IsRUFBRTtJQUM5QyxNQUFNLEVBQUUsUUFBUSxFQUFFLFlBQVksRUFBRSxTQUFTLEVBQUUsR0FBRyxLQUFLLENBQUE7SUFFbkQsMkJBQTJCO0lBQzNCLElBQUksQ0FBQyxRQUFRLENBQUMsWUFBWSxFQUFFLENBQUM7UUFDM0IsT0FBTyxJQUFJLDRCQUFZLENBQUM7WUFDdEIsT0FBTyxFQUFFLEtBQUs7WUFDZCxLQUFLLEVBQUUsb0NBQW9DO1NBQzVDLENBQUMsQ0FBQTtJQUNKLENBQUM7SUFFRCxJQUFJLENBQUMsUUFBUSxDQUFDLEVBQUUsRUFBRSxDQUFDO1FBQ2pCLE9BQU8sSUFBSSw0QkFBWSxDQUFDO1lBQ3RCLE9BQU8sRUFBRSxLQUFLO1lBQ2QsS0FBSyxFQUFFLDRDQUE0QztTQUNwRCxDQUFDLENBQUE7SUFDSixDQUFDO0lBRUQsSUFBSSxDQUFDO1FBQ0gsTUFBTSx5QkFBeUIsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDLGVBQU8sQ0FBQyxZQUFZLENBQUMsQ0FBQTtRQUN6RSxNQUFNLGFBQWEsR0FBRyxJQUFBLDBCQUFnQixFQUFDLFNBQVMsRUFBRSw2Q0FBNkMsQ0FBQyxDQUFBO1FBRWhHLE1BQU0sWUFBWSxHQUFHLFFBQVEsQ0FBQyxZQUFZLENBQUE7UUFDMUMsTUFBTSxFQUFFLEdBQUcsUUFBUSxDQUFDLEVBQUUsQ0FBQTtRQUN0QixNQUFNLE1BQU0sR0FBRyxRQUFRLENBQUMsTUFBTSxJQUFJLElBQUksQ0FBQTtRQUN0QyxNQUFNLGFBQWEsR0FBRyxRQUFRLENBQUMsT0FBTyxDQUFBO1FBQ3RDLE1BQU0sVUFBVSxHQUFHLFFBQVEsQ0FBQyxVQUFVLElBQUksU0FBUyxDQUFBO1FBQ25ELE1BQU0sWUFBWSxHQUFHLFFBQVEsQ0FBQyxZQUFZLElBQUksb0JBQW9CLENBQUE7UUFDbEUsTUFBTSxPQUFPLEdBQUcsUUFBUSxDQUFDLE9BQU8sSUFBSSxPQUFPLENBQUE7UUFDM0MsTUFBTSxXQUFXLEdBQUcsUUFBUSxDQUFDLFdBQVcsSUFBSSxRQUFRLENBQUE7UUFFcEQseUJBQXlCO1FBQ3pCLE1BQU0sYUFBYSxHQUF3QjtZQUN6QyxNQUFNO1lBQ04sS0FBSyxFQUFFLGFBQWEsRUFBRSxLQUFLO1lBQzNCLGtCQUFrQixFQUFFLGFBQWEsRUFBRSxrQkFBa0IsRUFBRSxDQUFDLFlBQVksQ0FBQztTQUN0RSxDQUFBO1FBRUQsNkNBQTZDO1FBQzdDLElBQUksc0JBQW1ILENBQUE7UUFFdkgsSUFBSSxRQUFRLENBQUMsY0FBYyxFQUFFLENBQUM7WUFDNUIsSUFBSSxDQUFDO2dCQUNILG9DQUFvQztnQkFDcEMsdUZBQXVGO2dCQUN2RiwyRUFBMkU7Z0JBQzNFLE1BQU0sb0JBQW9CLEdBQUcsTUFBTSxNQUFNLENBQUMsUUFBUSxDQUFDLGNBQWMsQ0FBQyxDQUFBO2dCQUNsRSxzQkFBc0IsR0FBRyxvQkFBb0IsQ0FBQyxPQUFPLElBQUksb0JBQW9CLENBQUMsb0JBQW9CLElBQUksb0JBQW9CLENBQUMsY0FBYyxDQUFBO2dCQUV6SSxJQUFJLENBQUMsc0JBQXNCLEVBQUUsQ0FBQztvQkFDNUIsT0FBTyxDQUFDLElBQUksQ0FBQywrQkFBK0IsUUFBUSxDQUFDLGNBQWMsNEVBQTRFLENBQUMsQ0FBQTtnQkFDbEosQ0FBQztZQUNILENBQUM7WUFBQyxPQUFPLEtBQUssRUFBRSxDQUFDO2dCQUNmLE9BQU8sQ0FBQyxJQUFJLENBQUMsdUNBQXVDLFFBQVEsQ0FBQyxjQUFjLEdBQUcsRUFBRSxLQUFLLENBQUMsQ0FBQTtnQkFDdEYsaUNBQWlDO1lBQ25DLENBQUM7UUFDSCxDQUFDO1FBRUQsd0JBQXdCO1FBQ3hCLE1BQU0sRUFBRSxJQUFJLEVBQUUsSUFBSSxFQUFFLE9BQU8sRUFBRSxHQUFHLE1BQU0sSUFBQSx1QkFBYyxFQUNsRCxZQUFZLEVBQ1osWUFBWSxFQUNaLGFBQWEsRUFDYixzQkFBc0IsQ0FDdkIsQ0FBQTtRQUVELG9CQUFvQjtRQUNwQixNQUFNLGtCQUFrQixHQUFHLE1BQU0seUJBQXlCLENBQUMsbUJBQW1CLENBQUM7WUFDN0UsRUFBRSxFQUFFLEVBQUU7WUFDTixPQUFPLEVBQUUsT0FBTztZQUNoQixRQUFRLEVBQUUsUUFBUSxDQUFDLFFBQVEsSUFBSSxZQUFZO1lBQzNDLFlBQVksRUFBRSxXQUFXO1lBQ3pCLFdBQVcsRUFBRSxVQUFVO1lBQ3ZCLGFBQWEsRUFBRSxZQUFZO1lBQzNCLElBQUksRUFBRSxZQUFZO1lBQ2xCLE9BQU8sRUFBRTtnQkFDUCxPQUFPLEVBQUUsYUFBYSxJQUFJLE9BQU87Z0JBQ2pDLElBQUksRUFBRSxJQUFJO2dCQUNWLElBQUksRUFBRSxJQUFJO2FBQ1g7U0FDRixDQUFDLENBQUE7UUFFRixPQUFPLElBQUksNEJBQVksQ0FBQztZQUN0QixPQUFPLEVBQUUsSUFBSTtZQUNiLGNBQWMsRUFBRSxrQkFBa0IsRUFBRSxFQUFFO1NBQ3ZDLENBQUMsQ0FBQTtJQUNKLENBQUM7SUFBQyxPQUFPLEtBQVUsRUFBRSxDQUFDO1FBQ3BCLE9BQU8sQ0FBQyxLQUFLLENBQUMsdUJBQXVCLEVBQUUsS0FBSyxDQUFDLENBQUE7UUFDN0MsT0FBTyxJQUFJLDRCQUFZLENBQUM7WUFDdEIsT0FBTyxFQUFFLEtBQUs7WUFDZCxLQUFLLEVBQUUsS0FBSyxFQUFFLE9BQU8sSUFBSSx3QkFBd0I7U0FDbEQsQ0FBQyxDQUFBO0lBQ0osQ0FBQztBQUNILENBQUMsQ0FDRixDQUFBIn0=

package/.medusa/server/src/workflows/steps/log-step.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logStep = void 0;
+const workflows_sdk_1 = require("@medusajs/framework/workflows-sdk");
+const logStep = (0, workflows_sdk_1.createStep)({
+    name: "log-step",
+}, function (input) {
+    console.log("log-step", JSON.stringify(input, null, 2));
+    return new workflows_sdk_1.StepResponse({
+        status: "success",
+        message: "Requested",
+        input: input,
+    });
+});
+exports.logStep = logStep;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibG9nLXN0ZXAuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi8uLi9zcmMvd29ya2Zsb3dzL3N0ZXBzL2xvZy1zdGVwLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBLHFFQUE2RTtBQUU3RSxNQUFNLE9BQU8sR0FBRyxJQUFBLDBCQUFVLEVBQ3hCO0lBQ0UsSUFBSSxFQUFFLFVBQVU7Q0FDakIsRUFDRCxVQUFVLEtBQVU7SUFDbEIsT0FBTyxDQUFDLEdBQUcsQ0FBQyxVQUFVLEVBQUUsSUFBSSxDQUFDLFNBQVMsQ0FBQyxLQUFLLEVBQUUsSUFBSSxFQUFFLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFFeEQsT0FBTyxJQUFJLDRCQUFZLENBQUM7UUFDdEIsTUFBTSxFQUFFLFNBQVM7UUFDakIsT0FBTyxFQUFFLFdBQVc7UUFDcEIsS0FBSyxFQUFFLEtBQUs7S0FDYixDQUFDLENBQUM7QUFDTCxDQUFDLENBQ0YsQ0FBQztBQUVPLDBCQUFPIn0=

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Codee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,104 @@
+# 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.
+
+## Features
+
+- **Automation Triggers**: Create notification automations triggered by events, schedules, or manual actions
+- **Rule-Based Conditions**: Define complex conditions using rule attributes (e.g., inventory levels, order status)
+- **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.)
+- **Type-Safe**: Full TypeScript support with exported types and workflows
+- **Extensible**: Add custom rule attributes and extend functionality via plugin options
+
+## Compatibility
+
+- **Medusa Version**: `>= 2.8.8`
+- **Node Version**: `>= 20`
+
+## Installation
+
+```bash
+npm install @codee-sh/medusa-plugin-automations
+# or
+yarn add @codee-sh/medusa-plugin-automations
+```
+
+## Quick Start
+
+### 1. Register the Plugin
+
+Add to your `medusa-config.ts`:
+
+```typescript
+module.exports = defineConfig({
+  plugins: [
+    "@codee-sh/medusa-plugin-automations"
+  ]
+})
+```
+
+### 2. Run Migrations
+
+The plugin includes database migrations for automation models. Run migrations to set up the required tables:
+
+```bash
+medusa migrations run
+```
+
+### 3. Access Admin Panel
+
+Navigate to **Notifications > Automations** in your Medusa Admin dashboard, or directly access:
+
+```
+/app/notifications/automations
+```
+
+## How It Works
+
+### Automation Triggers
+
+Automations are triggered by:
+- **Events**: Medusa events (e.g., `inventory.inventory-level.updated`, `order.placed`)
+- **Schedule**: Time-based triggers with configurable intervals
+- **Manual**: Triggered manually from the admin panel
+
+### Rules and Conditions
+
+Each automation can have multiple rules that define when notifications should be sent:
+
+- **Rule Attributes**: Available attributes for conditions (e.g., `inventory_level.available_quantity`, `inventory_item.sku`)
+- **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.
+
+## Admin Panel
+
+Access the automations management interface in Medusa Admin at `/app/notifications/automations`. See [Admin Panel Documentation](./docs/admin.md) for details.
+
+## Documentation
+
+- [Configuration](./docs/configuration.md) - Plugin configuration options and extending functionality
+- [Admin Panel](./docs/admin.md) - Admin interface usage and automation management
+
+## Exports
+
+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
+
+## Related Plugins
+
+For email templates and rendering functionality, see [@codee-sh/medusa-plugin-notification-emails](https://github.com/codee-sh/medusa-plugin-notification-emails).
+
+## License
+
+MIT
+
+## Author
+
+Codee Team - [https://codee.dev](https://codee.dev)

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@codee-sh/medusa-plugin-automations",
+  "version": "1.0.0",
+  "description": "Medusa plugin for automations.",
+  "author": "Codee (https://codee.dev)",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    ".medusa/server"
+  ],
+  "exports": {
+    "./package.json": "./package.json",
+    "./workflows": "./.medusa/server/src/workflows/index.js",
+    "./.medusa/server/src/modules/*": "./.medusa/server/src/modules/*/index.js",
+    "./modules/*": "./.medusa/server/src/modules/*/index.js",
+    "./providers/*": "./.medusa/server/src/providers/*/index.js",
+    "./utils": "./.medusa/server/src/utils/index.js",
+    "./utils/types": "./.medusa/server/src/types/index.js",
+    "./*": "./.medusa/server/src/*.js",
+    "./admin": {
+      "import": "./.medusa/server/src/admin/index.mjs",
+      "require": "./.medusa/server/src/admin/index.js",
+      "default": "./.medusa/server/src/admin/index.js"
+    }
+  },
+  "keywords": [
+    "medusa",
+    "plugin",
+    "medusa-plugin-automations",
+    "medusa-plugin",
+    "medusa-v2"
+  ],
+  "scripts": {
+    "build": "medusa plugin:build",
+    "dev": "medusa plugin:develop",
+    "prepublishOnly": "medusa plugin:build",
+    "publish-local": "npx medusa plugin:publish",
+    "publish-package": "dotenv npm publish --access public"
+  },
+  "devDependencies": {
+    "@medusajs/admin-sdk": "2.8.8",
+    "@medusajs/cli": "2.8.8",
+    "@medusajs/framework": "2.8.8",
+    "@medusajs/icons": "2.8.8",
+    "@medusajs/medusa": "2.8.8",
+    "@medusajs/test-utils": "2.8.8",
+    "@medusajs/ui": "^4.0.9",
+    "@mikro-orm/core": "6.4.3",
+    "@mikro-orm/knex": "6.4.3",
+    "@mikro-orm/migrations": "6.4.3",
+    "@mikro-orm/postgresql": "6.4.3",
+    "@swc/core": "1.5.7",
+    "@types/node": "^20.0.0",
+    "@types/react": "^18.3.2",
+    "@types/react-dom": "^18.2.25",
+    "awilix": "^8.0.1",
+    "dotenv": "^17.2.3",
+    "prop-types": "^15.8.1",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.6.2",
+    "vite": "^5.2.11",
+    "yalc": "^1.0.0-pre.53"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "packageManager": "yarn@3.2.3+sha512.f26f951f67de0c6a33ee381e5ff364709c87e70eb5e65c694e4facde3512f1fa80b8679e6ba31ce7d340fbb46f08dd683af9457e240f25a204be7427940d767e"
+}