@codee-sh/medusa-plugin-automations 1.0.10 → 1.0.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +22 -12
- package/package.json +4 -3
package/README.md
CHANGED
|
@@ -1,16 +1,17 @@
|
|
|
1
1
|
# Medusa plugin automations
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Automation plugin for Medusa v2 with rule-based
|
|
4
|
+
triggers and actions for notifications and workflows.
|
|
4
5
|
|
|
5
6
|
## Features
|
|
6
7
|
|
|
7
|
-
- **Automation Triggers**:
|
|
8
|
-
- **Rule-Based Conditions**:
|
|
9
|
-
- **Rich Attribute Support**:
|
|
10
|
-
- **Multiple Action Types**:
|
|
11
|
-
- **Event Subscribers**: Built-in subscribers for common Medusa events ([see available events](./docs/
|
|
8
|
+
- **Automation Triggers**: Events, schedules, or manual actions ([see details](#automation-triggers))
|
|
9
|
+
- **Rule-Based Conditions**: Arrays, relations, and multiple data types ([see details](#rules-and-conditions))
|
|
10
|
+
- **Rich Attribute Support**: Products, Variants, Tags, Categories, Inventory ([see available attributes](./docs/attributes.md))
|
|
11
|
+
- **Multiple Action Types**: Email, Slack, and custom actions ([see details](#actions))
|
|
12
|
+
- **Event Subscribers**: Built-in subscribers for common Medusa events ([see available events](./docs/available-subscribers.md))
|
|
12
13
|
- **Admin Panel**: Manage automations directly from Medusa Admin ([see details](#admin-panel))
|
|
13
|
-
- **Extensible**: Add custom action handlers
|
|
14
|
+
- **Extensible**: Add custom action handlers
|
|
14
15
|
- **Type-Safe**: Full TypeScript support with exported types and workflows
|
|
15
16
|
|
|
16
17
|
## Compatibility
|
|
@@ -64,19 +65,20 @@ Navigate to **Notifications > Automations** in your Medusa Admin dashboard, or d
|
|
|
64
65
|
|
|
65
66
|
Automations are triggered by:
|
|
66
67
|
- **Events**: Medusa events (e.g., `inventory.inventory-level.updated`, `product.updated`)
|
|
67
|
-
- **Schedule**: Time-based triggers with configurable intervals
|
|
68
|
+
- **Schedule**: Time-based triggers with configurable intervals
|
|
68
69
|
- **Manual**: Triggered manually from the admin panel
|
|
69
70
|
|
|
70
|
-
See [Available Subscribers](./docs/
|
|
71
|
+
See [Available Subscribers](./docs/available-subscribers.md) for a complete list of supported events.
|
|
71
72
|
|
|
72
73
|
### Rules and Conditions
|
|
73
74
|
|
|
74
75
|
Each automation can have multiple rules that define when actions should be executed. Rules support primitive fields, relations (arrays), nested objects, and various operators for complex conditions.
|
|
75
76
|
|
|
76
77
|
For detailed information, see:
|
|
77
|
-
- [Available Attributes Reference](./docs/
|
|
78
|
-
- [Rule Operators](./docs/
|
|
78
|
+
- [Available Attributes Reference](./docs/attributes.md) - Complete list of attributes for each event type
|
|
79
|
+
- [Rule Operators](./docs/rule-operators.md) - All supported operators with examples
|
|
79
80
|
- [Rule Values](./docs/configuration.md#rule-values) - Supported data types and usage
|
|
81
|
+
- [Custom Action Handlers](./docs/custom-action-handlers.md) - Extend actions with custom handlers
|
|
80
82
|
|
|
81
83
|
### Actions
|
|
82
84
|
|
|
@@ -88,6 +90,9 @@ When automation rules pass, actions are executed. Supported action types include
|
|
|
88
90
|
|
|
89
91
|
See [Actions](./docs/configuration.md#actions) and [Slack Notification Provider](./docs/configuration.md#slack-notification-provider) in the configuration documentation for details on configuring and extending actions.
|
|
90
92
|
|
|
93
|
+
Email and Slack templates are rendered by
|
|
94
|
+
`@codee-sh/medusa-plugin-notification-emails`.
|
|
95
|
+
|
|
91
96
|
## Admin Panel
|
|
92
97
|
|
|
93
98
|
Access the automations management interface in Medusa Admin at `/app/notifications/automations`. See [Admin Panel Documentation](./docs/admin.md) for details.
|
|
@@ -114,7 +119,7 @@ The plugin exports the following:
|
|
|
114
119
|
|
|
115
120
|
## Related Plugins
|
|
116
121
|
|
|
117
|
-
For email
|
|
122
|
+
For email and Slack template rendering, see [@codee-sh/medusa-plugin-notification-emails](https://github.com/codee-sh/medusa-plugin-notification-emails).
|
|
118
123
|
|
|
119
124
|
## License
|
|
120
125
|
|
|
@@ -123,3 +128,8 @@ MIT
|
|
|
123
128
|
## Author
|
|
124
129
|
|
|
125
130
|
Codee Team - [https://codee.dev](https://codee.dev)
|
|
131
|
+
|
|
132
|
+
## See Also
|
|
133
|
+
|
|
134
|
+
- [Configuration](./docs/configuration.md)
|
|
135
|
+
- [Admin Panel](./docs/admin.md)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@codee-sh/medusa-plugin-automations",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.11",
|
|
4
4
|
"description": "Medusa plugin for automations.",
|
|
5
5
|
"author": "Codee (https://codee.dev)",
|
|
6
6
|
"license": "MIT",
|
|
@@ -50,11 +50,12 @@
|
|
|
50
50
|
"version": "changeset version",
|
|
51
51
|
"release": "changeset publish",
|
|
52
52
|
"release:manual": "npm run build && npm publish --access public",
|
|
53
|
-
"prepare-release": "bash scripts/prepare-release.sh"
|
|
53
|
+
"prepare-release": "bash scripts/prepare-release.sh",
|
|
54
|
+
"pr:create": "bash scripts/create-pr.sh"
|
|
54
55
|
},
|
|
55
56
|
"devDependencies": {
|
|
56
57
|
"@changesets/cli": "^2.29.8",
|
|
57
|
-
"@codee-sh/medusa-plugin-notification-emails": "1.0.
|
|
58
|
+
"@codee-sh/medusa-plugin-notification-emails": "1.0.2",
|
|
58
59
|
"@medusajs/admin-sdk": "2.8.8",
|
|
59
60
|
"@medusajs/cli": "2.8.8",
|
|
60
61
|
"@medusajs/framework": "2.8.8",
|