@codee-sh/medusa-plugin-notification-emails 1.0.0 → 1.0.2

package/README.md

@@ -1,26 +1,21 @@
-# Medusa plugin notification emails
+# Medusa plugin notification
 
-A comprehensive notification plugin for Medusa v2 that provides a flexible, block-based template system for multiple channels (Email and Slack) with internationalization support, custom translations, and seamless integration with Medusa's notification module.
+Medusa v2 plugin for building and sending transactional notifications from one place.
+It provides a template system, admin builder, and rendering workflows for email and Slack.
 
 ## Features
 
-- **Multi-Channel Templates**: Pre-built templates for Email and Slack channels
-- **Block-Based System**: Templates are built using a flexible block system that can be stored in a database for future builder functionality
-- **Email Templates**: Customizable email templates built with [React Email](https://react.email) for common use cases
-- **Slack Templates**: Slack Block Kit compatible templates for Slack notifications
-- **Template Service Architecture**: Unified `AbstractTemplateService` with channel-specific implementations (`EmailTemplateService`, `SlackTemplateService`)
-- **Automatic Interpolation**: Smart variable interpolation system that processes `{{data.*}}` and `{{translations.*}}` placeholders recursively
-- **Internationalization**: Built-in support for multiple locales (Polish, English)
-- **Customizable**: Override translations and customize templates without modifying core files
-- **Integration**: Integrates with Medusa's notification module
-- **Admin Panel**: Preview and test templates directly from Medusa Admin
-- **Type-Safe**: Full TypeScript support with exported types
-- **HTML & Plain Text**: Automatically generates both HTML and plain text versions of emails
+- Build and manage notification templates for two channels: email and Slack
+- Use three template sources: built-in (`system`), database-managed (`db`), and code-registered (`external`)
+- Build templates quickly with a reusable block system instead of writing full markup from scratch
+- Edit `db` templates in Medusa Admin using a block-based builder
+- Render notifications through dedicated workflows and pass output to Medusa notification providers
+- Customize translations and register external templates without changing core plugin code
 
 ## Compatibility
 
-- **Medusa Version**: `>= 2.8.8`
-- **Node Version**: `>= 20`
+- Medusa: `>= 2.8.8`
+- Node.js: `>= 20`
 
 ## Installation
 
@@ -30,110 +25,52 @@ npm install @codee-sh/medusa-plugin-notification-emails
 yarn add @codee-sh/medusa-plugin-notification-emails
 ```
 
-## Quick Start
+## Basic setup
 
-### 1. Register the Plugin
-
-Add to your `medusa-config.ts`:
+Register plugin in `medusa-config.ts`:
 
 ```typescript
 module.exports = defineConfig({
   plugins: [
-    "@codee-sh/medusa-plugin-notification-emails"
-  ]
+    {
+      resolve: "@codee-sh/medusa-plugin-notification-emails",
+      options: {
+        customTranslations: {},
+        extend: {
+          services: [],
+        },
+      },
+    },
+  ],
 })
 ```
 
-### 2. Configure Notification Provider
-
-Set up a notification provider - see [Configuration Documentation](./docs/configuration.md) for details.
-
-### 3. Use Templates
-
-The plugin includes built-in subscribers that automatically send email notifications for various events. You can also use templates directly in your code:
-
-#### Email Templates
-
-```typescript
-import { emailService, TEMPLATES_NAMES } from "@codee-sh/medusa-plugin-notification-emails/templates/emails"
-
-const { html, text, subject } = await emailService.render({
-  templateName: TEMPLATES_NAMES.ORDER_PLACED,
-  data: templateData,
-  options: { locale: "pl" }
-})
-```
-
-#### Slack Templates
-
-```typescript
-import { slackService, TEMPLATES_NAMES } from "@codee-sh/medusa-plugin-notification-emails/templates/slack"
-
-const { blocks } = await slackService.render({
-  templateName: TEMPLATES_NAMES.INVENTORY_LEVEL,
-  data: templateData,
-  options: { locale: "en" }
-})
-```
-
-**Note**: Templates use a block-based system where each template is defined as an array of blocks. The system automatically interpolates variables like `{{data.order.id}}` and `{{translations.headerTitle}}` throughout the blocks.
-
-See [Templates Documentation](./docs/templates.md) for detailed usage examples.
-
-## Available Templates
-
-### Email Templates
-
-- **[Order Placed](./docs/templates/order-placed.md)** (`order-placed`) - Order confirmation email template
-- **Order Completed** (`order-completed`) - Order completion notification template
-- **[Contact Form](./docs/templates/contact-form.md)** (`contact-form`) - Contact form submission email template
-- **Order Updated** (`order-updated`) - Order update notification template
-- **Inventory Level** (`inventory-level`) - Inventory level notification template
-
-### Slack Templates
-
-- **Inventory Level** (`inventory-level`) - Inventory level notification for Slack
-- **Product** (`product`) - Product notification for Slack
-- **Product Variant** (`product-variant`) - Product variant notification for Slack
-
-See [Templates Documentation](./docs/templates.md) for general template information and [Blocks Documentation](./docs/blocks.md) for details on the block system.
-
-## Built-in Subscribers
-
-The plugin includes automatic email notifications for the following events:
-
-- **`order.placed`** - Sends order confirmation email when an order is placed
-- **`order.completed`** - Sends order completion notification when an order is completed
-
-These subscribers automatically:
-- Fetch order data from Medusa
-- Render email templates using React Email
-- Send notifications via Medusa's notification module
-- Respect custom translations configured in plugin options
-
-See [Configuration Documentation](./docs/configuration.md) for details on customizing subscriber behavior.
+Then continue with configuration and usage guides in `docs/`.
 
-## Admin Panel
+Template IDs are resolved by prefix:
 
-Access the template preview in Medusa Admin at `/app/notifications/render`. See [Admin Panel Documentation](./docs/admin.md) for details.
+- IDs starting with `system` or `external` are rendered from the in-memory registry (no DB lookup).
+- Other IDs are treated as DB templates and must exist in `mpn_builder_template`.
 
 ## Documentation
 
-- [Templates](./docs/templates.md) - Using templates and creating custom subscribers
-- [Blocks System](./docs/blocks.md) - Understanding the block-based template system
-- [Translations](./docs/translations.md) - Internationalization and custom translations
-- [Configuration](./docs/configuration.md) - Plugin configuration options
-- [Admin Panel](./docs/admin.md) - Admin interface usage
-- [Creating Custom Templates](./docs/contributing/creating-templates.md) - Guide for creating new templates
+- [Configuration](./docs/configuration.md)
+- [Templates](./docs/templates.md)
+- [Blocks](./docs/blocks.md)
+- [Translations](./docs/translations.md)
+- [Admin](./docs/admin.md)
+- [Tests](./docs/tests.md)
+- [Creating Templates](./docs/contributing/creating-templates.md)
 
 ## Exports
 
-The plugin exports the following:
+Public entrypoints:
 
-- `@codee-sh/medusa-plugin-notification-emails/templates/emails` - Email template service and types
-- `@codee-sh/medusa-plugin-notification-emails/templates/slack` - Slack template service and types
-- `@codee-sh/medusa-plugin-notification-emails/templates/shared` - Shared template utilities
-- `@codee-sh/medusa-plugin-notification-emails/utils` - Utility functions
+- `@codee-sh/medusa-plugin-notification-emails/workflows`
+- `@codee-sh/medusa-plugin-notification-emails/modules/*`
+- `@codee-sh/medusa-plugin-notification-emails/providers/*`
+- `@codee-sh/medusa-plugin-notification-emails/utils`
+- `@codee-sh/medusa-plugin-notification-emails/admin`
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codee-sh/medusa-plugin-notification-emails",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Medusa plugin for notifications emails.",
   "author": "Codee Team (https://codee.dev)",
   "license": "MIT",
@@ -38,13 +38,19 @@
     "publish-local": "npx medusa plugin:publish",
     "publish-package": "dotenv npm publish --access public",
     "email:dev": "email dev --dir emails-previews",
+    "test:unit": "TEST_TYPE=unit NODE_OPTIONS=--experimental-vm-modules jest --silent",
+    "test:integration:http": "TEST_TYPE=integration:http NODE_OPTIONS=--experimental-vm-modules jest --silent --runInBand --forceExit",
+    "test:integration:modules": "TEST_TYPE=integration:modules NODE_OPTIONS=--experimental-vm-modules jest --silent --runInBand --forceExit",
+    "test:db:up": "docker compose -f docker-compose.test.yml up -d",
+    "test:db:down": "docker compose -f docker-compose.test.yml down -v",
     "format": "prettier --write \"src/**/*.{ts,tsx}\"",
     "format:check": "prettier --check \"src/**/*.{ts,tsx}\"",
     "changeset": "changeset",
     "version": "changeset version",
     "release": "changeset publish",
     "release:manual": "npm publish --access public",
-    "prepare-release": "bash scripts/prepare-release.sh"
+    "prepare-release": "bash scripts/prepare-release.sh",
+    "pr:create": "bash scripts/create-pr.sh"
   },
   "dependencies": {
     "@dnd-kit/core": "^6.3.1",
@@ -76,11 +82,15 @@
     "@react-email/preview-server": "^4.3.1",
     "@react-email/render": "^1.4.0",
     "@swc/core": "1.5.7",
+    "@swc/jest": "^0.2.36",
+    "@types/jest": "^29.5.14",
+    "@types/lodash": "^4.17.23",
     "@types/node": "^20.0.0",
     "@types/react": "^18.3.2",
     "@types/react-dom": "^18.2.25",
     "awilix": "^8.0.1",
     "dotenv": "^17.2.3",
+    "jest": "^29.7.0",
     "prettier": "^3.0.0",
     "prop-types": "^15.8.1",
     "react": "^18.2.0",
@@ -90,8 +100,7 @@
     "ts-node": "^10.9.2",
     "typescript": "^5.6.2",
     "vite": "^5.2.11",
-    "yalc": "^1.0.0-pre.53",
-    "@types/lodash": "^4.17.23"
+    "yalc": "^1.0.0-pre.53"
   },
   "engines": {
     "node": ">=20"