{"_id":"medusa-plugin-sendgrid-custom","_rev":"123-36b1dc8255d74d44d5c3c5b9a29b216c","name":"medusa-plugin-sendgrid-custom","dist-tags":{"latest":"1.3.13"},"versions":{"1.3.12":{"name":"medusa-plugin-sendgrid-custom","version":"1.3.12","keywords":["medusa-plugin","medusa-plugin-notification"],"author":{"name":"Oliver Juhl"},"license":"MIT","_id":"medusa-plugin-sendgrid-custom@1.3.12","maintainers":[{"name":"hieunguyenzzz","email":"bzaikia@gmail.com"}],"homepage":"https://github.com/medusajs/medusa#readme","bugs":{"url":"https://github.com/medusajs/medusa/issues"},"dist":{"shasum":"315a32621c4ea3d2f17c003fca36c167d8e2bc36","tarball":"https://registry.npmjs.org/medusa-plugin-sendgrid-custom/-/medusa-plugin-sendgrid-custom-1.3.12.tgz","fileCount":13,"integrity":"sha512-NCWSMH38IcXMg3459NIHeCIdKIVMZkdrP3J5I+JgHG5f2oG4A0hyVcI9Pe65jrv8qjJYEcaMifagGhIdTnpR9A==","signatures":[{"sig":"MEUCIHeNDobb76xQvQjeIpohkI3glx/AZtq6rm6Glw4gp65sAiEA8MLHkU1G8cYiU8N/1p4v966wuGmuoThLK034ceMUhBI=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":145697},"main":"index.js","engines":{"node":">=16"},"gitHead":"3bbd1e8507e00bc471de6ae3c30207999a4a4011","scripts":{"test":"jest --passWithNoTests src","build":"babel src --out-dir . --ignore '**/__tests__','**/__mocks__'","watch":"babel -w src --out-dir . --ignore '**/__tests__','**/__mocks__'","prepare":"cross-env NODE_ENV=production yarn run build"},"_npmUser":{"name":"hieunguyenzzz","email":"bzaikia@gmail.com"},"repository":{"url":"git+https://github.com/medusajs/medusa.git","type":"git","directory":"packages/medusa-plugin-sendgrid"},"_npmVersion":"10.2.4","description":"SendGrid transactional emails","directories":{},"_nodeVersion":"20.11.1","dependencies":{"express":"^4.17.1","body-parser":"^1.19.0","@sendgrid/mail":"^7.1.1","medusa-core-utils":"^1.2.0","@babel/plugin-transform-classes":"^7.9.5"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^25.5.4","typeorm":"^0.3.16","cross-env":"^5.2.1","@babel/cli":"^7.7.5","@babel/core":"^7.7.5","@babel/node":"^7.7.4","@babel/runtime":"^7.9.6","@babel/register":"^7.7.4","client-sessions":"^0.8.0","@babel/preset-env":"^7.7.5","medusa-interfaces":"^1.3.7","medusa-test-utils":"^1.1.40","@babel/plugin-transform-runtime":"^7.7.6","@babel/plugin-transform-instanceof":"^7.8.3","@babel/plugin-proposal-class-properties":"^7.7.4"},"peerDependencies":{"typeorm":"^0.3.16","medusa-interfaces":"^1.3.7"},"_npmOperationalInternal":{"tmp":"tmp/medusa-plugin-sendgrid-custom_1.3.12_1735718988832_0.9787850702734937","host":"s3://npm-registry-packages-npm-production"}},"1.3.13":{"name":"medusa-plugin-sendgrid-custom","version":"1.3.13","description":"SendGrid transactional emails","main":"index.js","repository":{"type":"git","url":"git+https://github.com/medusajs/medusa.git","directory":"packages/medusa-plugin-sendgrid"},"engines":{"node":">=16"},"author":{"name":"Oliver Juhl"},"license":"MIT","devDependencies":{"@babel/cli":"^7.7.5","@babel/core":"^7.7.5","@babel/node":"^7.7.4","@babel/plugin-proposal-class-properties":"^7.7.4","@babel/plugin-transform-instanceof":"^7.8.3","@babel/plugin-transform-runtime":"^7.7.6","@babel/preset-env":"^7.7.5","@babel/register":"^7.7.4","@babel/runtime":"^7.9.6","client-sessions":"^0.8.0","cross-env":"^5.2.1","jest":"^25.5.4","medusa-interfaces":"^1.3.7","medusa-test-utils":"^1.1.40","typeorm":"^0.3.16"},"scripts":{"prepare":"cross-env NODE_ENV=production yarn run build","test":"jest --passWithNoTests src","build":"babel src --out-dir . --ignore '**/__tests__','**/__mocks__'","watch":"babel -w src --out-dir . --ignore '**/__tests__','**/__mocks__'"},"peerDependencies":{"medusa-interfaces":"^1.3.7","typeorm":"^0.3.16"},"dependencies":{"@babel/plugin-transform-classes":"^7.9.5","@sendgrid/mail":"^7.1.1","body-parser":"^1.19.0","express":"^4.17.1","medusa-core-utils":"^1.2.0"},"gitHead":"3bbd1e8507e00bc471de6ae3c30207999a4a4011","keywords":["medusa-plugin","medusa-plugin-notification"],"_id":"medusa-plugin-sendgrid-custom@1.3.13","bugs":{"url":"https://github.com/medusajs/medusa/issues"},"homepage":"https://github.com/medusajs/medusa#readme","_nodeVersion":"20.11.1","_npmVersion":"10.2.4","dist":{"integrity":"sha512-+ozQxm4/ithJewxv4aBNxVHRZaxJuNHMYZ0HttXp0YWLFLeweYEZTwb0LPh27T9f3JjAXgR1mYUx+STzMZhhFQ==","shasum":"64ae6d49b82525cf5885485993605a22a5948f70","tarball":"https://registry.npmjs.org/medusa-plugin-sendgrid-custom/-/medusa-plugin-sendgrid-custom-1.3.13.tgz","fileCount":13,"unpackedSize":145966,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBwa2A5GYE0cz7tLDJ2fVagDnhQfSeDdcp6shRs2k+SxAiBRheoD6WH2DypxDhK0oKK+ZomI2r9WZX6q/XgDKcx4aA=="}]},"_npmUser":{"name":"hieunguyenzzz","email":"bzaikia@gmail.com"},"directories":{},"maintainers":[{"name":"hieunguyenzzz","email":"bzaikia@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/medusa-plugin-sendgrid-custom_1.3.13_1735720400847_0.18936216983582854"},"_hasShrinkwrap":false}},"time":{"created":"2025-01-01T08:09:48.832Z","modified":"2025-01-01T08:33:21.220Z","0.0.1":"2023-07-10T11:05:00.406Z","0.0.2":"2023-07-12T10:05:35.647Z","0.0.3":"2023-07-12T12:28:10.523Z","0.0.4":"2023-07-12T12:54:24.028Z","0.0.5":"2023-07-13T13:37:24.857Z","0.0.6":"2023-07-13T15:17:04.060Z","0.0.7":"2023-07-13T15:41:10.937Z","0.0.8":"2023-07-13T15:57:18.873Z","0.0.9":"2023-07-13T16:21:51.065Z","0.0.10":"2023-07-19T16:03:26.746Z","0.0.11":"2023-07-20T08:17:48.607Z","0.0.12":"2023-07-24T12:09:22.965Z","0.0.13":"2023-07-24T13:20:48.403Z","0.0.14":"2023-07-24T15:29:25.462Z","0.0.15":"2023-07-25T08:30:32.251Z","0.0.16":"2023-07-25T08:37:03.664Z","0.0.17":"2023-07-25T09:15:23.571Z","0.0.18":"2023-07-25T09:17:34.681Z","0.0.19":"2023-07-25T09:27:42.274Z","0.0.20":"2023-07-25T09:35:31.580Z","0.0.21":"2023-07-25T09:46:53.388Z","0.0.22":"2023-07-25T10:12:09.946Z","0.0.23":"2023-07-25T10:23:11.418Z","0.0.24":"2023-07-25T10:39:31.712Z","0.0.25":"2023-07-25T11:34:47.733Z","0.0.26":"2023-07-25T11:36:52.964Z","0.0.27":"2023-07-25T12:02:05.336Z","0.0.28":"2023-07-25T12:14:47.640Z","0.0.29":"2023-07-25T12:28:17.495Z","0.0.30":"2023-07-25T12:39:43.315Z","0.0.31":"2023-07-25T12:57:27.912Z","0.0.32":"2023-07-25T13:21:23.419Z","0.0.33":"2023-07-25T14:04:38.546Z","0.1.0":"2023-07-25T14:54:08.279Z","0.1.1":"2023-07-28T14:54:37.920Z","0.1.2":"2023-07-29T09:56:02.154Z","0.1.3":"2023-08-01T09:37:56.857Z","0.1.4":"2023-08-01T11:47:14.922Z","0.1.5":"2023-08-01T12:37:00.186Z","0.1.6":"2023-08-01T14:34:31.450Z","0.1.7":"2023-08-02T14:39:07.482Z","0.1.8":"2023-08-03T08:47:59.813Z","0.1.9":"2023-08-03T09:12:01.701Z","0.1.10":"2023-08-03T12:57:21.878Z","0.1.11":"2023-08-03T13:53:38.605Z","0.1.12":"2023-08-03T14:04:41.606Z","0.1.13":"2023-08-08T14:52:34.887Z","0.1.14":"2023-08-09T08:54:45.932Z","0.1.15":"2023-08-09T11:18:14.116Z","0.1.16":"2023-08-09T12:05:10.390Z","0.1.17":"2023-08-09T16:28:50.272Z","0.1.18":"2023-08-09T16:45:36.391Z","0.1.19":"2023-08-09T17:15:05.611Z","0.1.20":"2023-08-10T11:27:53.256Z","0.1.21":"2023-08-10T13:32:44.092Z","0.1.22":"2023-08-10T14:33:10.220Z","0.1.23":"2023-08-10T16:45:45.466Z","0.1.24":"2023-08-10T16:50:12.299Z","0.1.25":"2023-08-10T17:01:12.012Z","0.1.26":"2023-08-11T07:48:10.138Z","0.1.27":"2023-08-11T14:31:23.484Z","0.1.28":"2023-08-11T14:55:28.902Z","0.1.28-1":"2023-08-11T14:57:17.989Z","0.1.28-2":"2023-08-11T15:30:46.441Z","0.1.28-3":"2023-08-11T15:43:49.793Z","0.1.29":"2023-08-11T16:06:32.940Z","0.1.29-1":"2023-08-11T16:12:37.321Z","0.1.29-2":"2023-08-11T16:26:43.123Z","0.1.30":"2023-08-16T09:28:32.877Z","0.1.31":"2023-08-16T11:49:25.813Z","0.1.32":"2023-08-16T12:14:34.319Z","0.1.33":"2023-08-16T12:30:28.414Z","0.2.0":"2023-09-05T14:11:02.005Z","0.2.1":"2023-09-05T16:55:26.545Z","0.2.2":"2023-09-06T08:42:43.956Z","0.2.3":"2023-09-06T10:00:33.844Z","0.2.4":"2023-09-06T10:56:44.164Z","0.2.5":"2023-09-06T11:12:41.253Z","0.2.6":"2023-09-06T11:22:27.179Z","0.2.7":"2023-09-06T12:09:35.725Z","0.2.8":"2023-09-06T12:29:53.943Z","0.2.9":"2023-09-06T13:24:50.729Z","0.2.10":"2023-09-06T13:25:56.043Z","0.2.11":"2023-09-06T13:37:15.569Z","0.2.12":"2023-09-06T13:46:57.480Z","0.2.13":"2023-09-06T13:59:47.415Z","0.2.14":"2023-09-06T14:13:35.416Z","0.2.15":"2023-09-06T14:15:24.270Z","0.2.16":"2023-09-06T14:29:40.645Z","0.2.17":"2023-09-06T14:57:43.544Z","0.2.18":"2023-09-06T15:09:48.713Z","0.2.19":"2023-09-06T15:24:48.456Z","0.2.20":"2023-09-07T09:12:30.050Z","0.2.21":"2023-09-07T09:32:30.949Z","0.2.22":"2023-09-07T09:43:57.202Z","0.2.23":"2023-09-07T10:02:27.959Z","0.2.24":"2023-09-07T10:27:14.532Z","0.2.25":"2023-09-07T10:38:51.015Z","0.2.26":"2023-09-07T11:13:07.576Z","0.2.27":"2023-09-07T11:44:51.903Z","0.2.28":"2023-09-07T12:04:42.520Z","0.2.29":"2023-09-07T13:24:35.257Z","0.2.30":"2023-09-07T13:56:33.479Z","0.2.31":"2023-09-07T14:22:47.931Z","0.2.32":"2023-09-07T14:44:41.312Z","0.2.33":"2023-09-07T16:22:22.376Z","0.2.34":"2023-09-15T16:19:12.284Z","0.2.35":"2023-09-15T17:20:35.765Z","0.2.36":"2023-09-26T10:55:21.551Z","0.2.37":"2023-09-26T12:31:50.829Z","0.2.38":"2023-09-26T13:23:00.645Z","0.2.39":"2023-09-26T14:02:48.734Z","0.2.42":"2023-09-28T07:41:01.311Z","0.2.43":"2023-09-28T07:56:19.773Z","0.2.44":"2023-09-28T08:10:10.951Z","0.2.45":"2023-09-28T08:12:18.369Z","0.2.46":"2023-09-28T08:31:27.513Z","0.2.47":"2023-09-28T08:48:12.234Z","0.2.48":"2023-09-28T08:49:54.174Z","0.2.49":"2023-09-28T09:22:56.072Z","1.3.12":"2025-01-01T08:09:49.029Z","1.3.13":"2025-01-01T08:33:21.039Z"},"bugs":{"url":"https://github.com/medusajs/medusa/issues"},"author":{"name":"Oliver Juhl"},"license":"MIT","homepage":"https://github.com/medusajs/medusa#readme","keywords":["medusa-plugin","medusa-plugin-notification"],"repository":{"type":"git","url":"git+https://github.com/medusajs/medusa.git","directory":"packages/medusa-plugin-sendgrid"},"description":"SendGrid transactional emails","maintainers":[{"name":"hieunguyenzzz","email":"bzaikia@gmail.com"}],"readme":"# SendGrid\n\nHandle sending emails to customers related to orders, restock notifications, users, or custom events.\n\n[SendGrid Plugin Documentation](https://docs.medusajs.com/plugins/notifications/sendgrid) | [Medusa Website](https://medusajs.com) | [Medusa Repository](https://github.com/medusajs/medusa)\n\n## Features\n\n- Send emails when an event related to orders, restock notifications, or users is triggered.\n- Use dynamic templates in SendGrid to build the emails to be sent.\n- Send emails with SendGrid for custom events.\n\n---\n\n## Prerequisites\n\n- [Medusa backend](https://docs.medusajs.com/development/backend/install)\n- [SendGrid account](https://signup.sendgrid.com/)\n\n---\n\n## How to Install\n\n1\\. Run the following command in the directory of the Medusa backend:\n\n  ```bash\n  npm install medusa-plugin-sendgrid\n  ```\n\n2\\. Set the following environment variable in `.env`:\n\n  ```bash\n  SENDGRID_API_KEY=<API_KEY>\n  SENDGRID_FROM=<SEND_FROM_EMAIL>\n  # IDs for different email templates\n  SENDGRID_ORDER_PLACED_ID=<ORDER_PLACED_TEMPLATE_ID> # example\n  ```\n\n3\\. In `medusa-config.js` add the following at the end of the `plugins` array:\n\n  ```js\n  const plugins = [\n    // ...,\n    {\n      resolve: `medusa-plugin-sendgrid`,\n      options: {\n        api_key: process.env.SENDGRID_API_KEY,\n        from: process.env.SENDGRID_FROM,\n        order_placed_template: \n          process.env.SENDGRID_ORDER_PLACED_ID,\n        localization: {\n          \"de-DE\": { // locale key\n            order_placed_template:\n              process.env.SENDGRID_ORDER_PLACED_ID_LOCALIZED,\n          },\n        },\n      },\n    },\n  ]\n  ```\n\n---\n\n## Test the Plugin\n\n1\\. Run the following command in the directory of the Medusa backend to run the backend:\n\n  ```bash\n  npm run start\n  ```\n\n2\\. Place an order using a storefront or the [Store APIs](https://docs.medusajs.com/api/store). You should receive a confirmation email.\n\n---\n\n## Additional Resources\n\n- [SendGrid Plugin Documentation](https://docs.medusajs.com/plugins/notifications/sendgrid)\n","readmeFilename":"README.md"}