Medusa ПлагиныApprise

Apprise

A flexible notification plugin for MedusaJS using Apprise, enabling multichannel notifications with ease.

Нужна доработка этого плагина?

Связаться с нами

npm install @vymalo/medusa-apprise

Категория

notification

Создано

Community

Версия

1.0.2

Последнее обновление

7 месяцев назад

Ежемесячные загрузки

Звезды на Github

NPM Github

Medusa ПлагиныApprise

MedusaJS Apprise Notification Plugin

A flexible notification plugin for MedusaJS using Apprise, enabling multichannel notifications with ease.

🌟 Features

Support for multiple notification channels (email, SMS, etc.)
Configurable via MedusaJS modules
Leverages Apprise's powerful notification routing
Flexible axios-based client configuration

📦 Installation

Install the package using npm:


npm install @vymalo/medusa-apprise

Or using yarn:


yarn add @vymalo/medusa-apprise

🚀 Usage

Configuration

Add the plugin to the section of your MedusaJS configuration:


modules: [
  {
    resolve: "@medusajs/medusa/notification",
    options: {
      providers: [
        {
          resolve: `@vymalo/medusa-apprise`,
          id: "apprise",
          options: {
            client: {
              baseURL: 'http://localhost:8000/notify', // Apprise API service URL
              headers: {
                "Content-Type": "application/json"
              }
            },
            handlers: {
              email: (notification: ProviderSendNotificationDTO) => [
                {
                  urls: [
                    `mailgun:///noreply@example.com/4b4f2918fd-dk5f-8f91f/${notification.to}`,
                    `ses://test@test.com/<access-key>/<secret-key>/<aws-region>/admin@email.com`,
                  ],
                  body: `[${notification.template}] ${JSON.stringify(notification.data, null, 4)}`
                }
              ],
              // More channel handlers...
            },
          },
        },
      ],
    },
  },
  // Other modules...
]

🔧 Configuration Options

Client Configuration

The option uses axios configuration, allowing full customization of the HTTP client.

Handlers

Define custom handlers for different notification channels:

: Email notification handler
: SMS notification handler
Add more as needed

Notification Payload


type AppriseNotificationPayload = {
  urls: string[];          // Notification destination URLs
  body: string;            // Notification body
  title?: string;          // Optional notification title
  type?: 'info' | 'warning' | 'failure';  // Notification type
  format?: 'text' | 'markdown' | 'html';  // Notification format
  tag?: string;            // Optional tag for notification
}