init

Author: luluhoc

.babelrc

@@ -0,0 +1,13 @@
+{
+  "plugins": [
+    "@babel/plugin-proposal-class-properties",
+    "@babel/plugin-transform-instanceof",
+    "@babel/plugin-transform-classes"
+  ],
+  "presets": ["@babel/preset-env", "@babel/preset-typescript"],
+  "env": {
+    "test": {
+      "plugins": ["@babel/plugin-transform-runtime"]
+    }
+  }
+}

.gitignore

@@ -0,0 +1,15 @@
+/lib
+node_modules
+.DS_store
+.env*
+/*.js
+!index.js
+!jest.config.js
+
+/dist
+
+/api
+/services
+/models
+/subscribers
+

.npmignore

@@ -0,0 +1,9 @@
+.DS_store
+src
+dist
+yarn.lock
+.babelrc
+jest.config.js
+
+.turbo
+.yarn

CHANGELOG.md

@@ -0,0 +1,84 @@
+# SendGrid
+
+Handle sending emails to customers related to orders, restock notifications, users, or custom events.
+
+[SendGrid Plugin Documentation](https://docs.medusajs.com/plugins/notifications/sendgrid) | [Medusa Website](https://medusajs.com) | [Medusa Repository](https://github.com/medusajs/medusa)
+
+## Features
+
+- Send emails when an event related to orders, restock notifications, or users is triggered.
+- Use dynamic templates in SendGrid to build the emails to be sent.
+- Send emails with SendGrid for custom events.
+
+---
+
+## Prerequisites
+
+- [Medusa backend](https://docs.medusajs.com/development/backend/install)
+- [SendGrid account](https://signup.sendgrid.com/)
+
+---
+
+## How to Install
+
+1\. Run the following command in the directory of the Medusa backend:
+
+  ```bash
+  npm install medusa-plugin-sendgrid
+  ```
+
+  ```bash
+  yarn add medusa-plugin-sendgrid
+  ```
+
+2\. Set the following environment variable in `.env`:
+
+  ```bash
+  SENDGRID_API_KEY=<API_KEY>
+  SENDGRID_FROM=<SEND_FROM_EMAIL>
+  # IDs for different email templates
+  SENDGRID_ORDER_PLACED_ID=<ORDER_PLACED_TEMPLATE_ID> # example
+  ```
+
+3\. In `medusa-config.js` add the following at the end of the `plugins` array:
+
+  ```ts
+  const plugins = [
+    // ...,
+    {
+      resolve: `medusa-plugin-sendgrid`,
+      /** @type {import('medusa-plugin-sendgrid').PluginOptions} */
+      options: {
+        api_key: process.env.SENDGRID_API_KEY,
+        from: process.env.SENDGRID_FROM,
+        templates: {
+          order_placed_template: process.env.SENDGRID_ORDER_PLACED_ID,
+        },
+        localization: {
+          "de-DE": { // locale key
+            order_placed_template:
+              process.env.SENDGRID_ORDER_PLACED_ID_LOCALIZED,
+          },
+        },
+      },
+    },
+  ]
+  ```
+
+---
+
+## Test the Plugin
+
+1\. Run the following command in the directory of the Medusa backend to run the backend:
+
+  ```bash
+  npm run start
+  ```
+
+2\. Place an order using a storefront or the [Store APIs](https://docs.medusajs.com/api/store). You should receive a confirmation email.
+
+---
+
+## Additional Resources
+
+- [SendGrid Plugin Documentation](https://docs.medusajs.com/plugins/notifications/sendgrid)

README.md

@@ -0,0 +1 @@
+// noop

index.js

@@ -0,0 +1,3 @@
+module.exports = {
+  testEnvironment: "node",
+}

jest.config.js

@@ -0,0 +1,53 @@
+{
+  "name": "medusa-plugin-sendgrid-typescript",
+  "version": "2.0.0",
+  "description": "SendGrid transactional emails typescript",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/medusajs/medusa",
+    "directory": "packages/medusa-plugin-sendgrid"
+  },
+  "engines": {
+    "node": ">=16"
+  },
+  "types": "dist/types.d.ts",
+  "files": [
+    "dist"
+  ],
+  "author": "Oliver Juhl | Lucjan Grzesik",
+  "license": "MIT",
+  "devDependencies": {
+    "@medusajs/medusa": "^1.20.1",
+    "@medusajs/types": "^1.11.9",
+    "@types/express": "^4.17.21",
+    "client-sessions": "^0.8.0",
+    "cross-env": "^7.0.3",
+    "jest": "^29.7.0",
+    "medusa-interfaces": "^1.3.7",
+    "medusa-test-utils": "^1.1.41",
+    "rimraf": "^5.0.5",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.3.3"
+  },
+  "scripts": {
+    "prepublishOnly": "cross-env NODE_ENV=production tsc --build",
+    "test": "jest --passWithNoTests src",
+    "build": "rimraf dist && tsc",
+    "watch": "tsc --watch"
+  },
+  "peerDependencies": {
+    "@medusajs/medusa": "^1.19.0",
+    "medusa-interfaces": "^1.3.7",
+    "typeorm": "^0.3.16"
+  },
+  "dependencies": {
+    "@medusajs/utils": "^1.11.2",
+    "@sendgrid/mail": "^8.1.0",
+    "medusa-core-utils": "^1.2.0"
+  },
+  "gitHead": "3bbd1e8507e00bc471de6ae3c30207999a4a4011",
+  "keywords": [
+    "medusa-plugin",
+    "medusa-plugin-notification"
+  ]
+}

package.json

@@ -0,0 +1,18 @@
+import type {
+  MedusaRequest,
+  MedusaResponse
+} from "@medusajs/medusa";
+import SendGridService from "../../../services/sendgrid";
+
+
+export async function POST(req: MedusaRequest, res: MedusaResponse) {
+  const sendgridService: SendGridService = req.scope.resolve("sendgridService")
+  
+  await sendgridService.sendEmail({
+    templateId: req.body.template_id,
+    from: req.body.from,
+    to: req.body.to,
+    dynamicTemplateData: req.body.data || {}
+  })
+  res.sendStatus(200)
+}

src/api/store/send-email/route.ts

@@ -0,0 +1,25 @@
+import { 
+  MedusaContainer, 
+  NotificationService,
+} from "@medusajs/medusa"
+
+export default async (
+  container: MedusaContainer
+): Promise<void> => {
+  const notificationService = container.resolve<NotificationService>(
+    "notificationService"
+  )
+
+  notificationService.subscribe("order.shipment_created", "sendgrid")
+  notificationService.subscribe("order.gift_card_created", "sendgrid")
+  notificationService.subscribe("gift_card.created", "sendgrid")
+  notificationService.subscribe("order.placed", "sendgrid")
+  notificationService.subscribe("order.canceled", "sendgrid")
+  notificationService.subscribe("customer.password_reset", "sendgrid")
+  notificationService.subscribe("claim.shipment_created", "sendgrid")
+  notificationService.subscribe("swap.shipment_created", "sendgrid")
+  notificationService.subscribe("swap.created", "sendgrid")
+  notificationService.subscribe("order.items_returned", "sendgrid")
+  notificationService.subscribe("order.return_requested", "sendgrid")
+  notificationService.subscribe("order.refund_created", "sendgrid")
+}