@pixelplex/mail-service 0.2.7 → 0.2.8

package/.gitlab-ci.yml

@@ -2,7 +2,7 @@ stages:
   - 📦 package
 
 📦 package:
-  image: node:20.17-alpine
+  image: node:20.19.1-alpine
   stage: 📦 package
   tags:
     - docker

package/README.md

@@ -1,69 +1,50 @@
 # Mail Service
 
-Library for fast implementation of the functionality of sending email messages.
+Library for sending email messages through configured gateways.
 
-The sends messages them via email.
-
-## How to use
-
-1. create template for html, plain text and subject
-2. add `@pixelplex/mail-service` to your application
-3. Call `MailModule.forRoot` from `@pixelplex/mail-service`
-   with specified gateways and options
-4. send a message by calling `this.mailSenderService.sendEmail('test@gmail.com', { htmlPath: htmlTemplatePath, plainPath: plainTextTemplatePath, subjectPath: subjectTemplatePath }, {year: 20});` where `mailSenderService` is `MailSenderService`
-
-Currently supported gateways:
+## Supported gateways
 
 - slack
 - console
 - smtp
 - sendgrid
+- resend
 
-Didn't understand anything? Okay, let's see more details
+## Templates
 
-### Prepare templates
+The service uses Handlebars as the template engine.
 
-The service uses Handlebars as template engine. So all your email templates should be prepared as handlebars templates.
+Expected template files:
 
-For sending message your templates folder should include this files:
+- `{name}.handlebars` for HTML body
+- `{name}.subject.handlebars` for subject
+- `{name}.plain.handlebars` for plain-text body
 
-- `{name}.handlebars` - body of your email where `{name}` is just your template name for email. For example `welcome.handlebars` for the welcome use email
-- `{name}.subject.handlebars` - subject (title) of your email. You can use subject field to specify subject directly. It will override subjectPath
-- `{name}.plain.handlebars` - subject (title) of your email. You can use plain field to specify plain directly. It will override plainPath
+Example:
 
 ```handlebars
-# welcome.subject.handlebars Welcome, {{name}}! This is subject
+# welcome.subject.handlebars Welcome, {{name}}!
 ```
 
 ```handlebars
 # welcome.handlebars
-
 <html>
   <head></head>
   <body>
     <p>Welcome, {{name}}!</p>
-    <p>How are you?</p>
   </body>
 </html>
 ```
 
 ```handlebars
-# welcome.plain.handlebars
-
-<html>
-  <head></head>
-  <body>
-    <p>Welcome, {{name}}!</p>
-    <p>How are you?</p>
-  </body>
-</html>
+# welcome.plain.handlebars Welcome, {{name}}!
 ```
 
 ## Configuration
 
 | Name            | Description                                              | Example                   |
 | --------------- | -------------------------------------------------------- | ------------------------- |
-| gateways        | Array of gateways to send email                          | `['slack']`               |
+| gateways        | Array of gateways to send email                          | `['resend']`              |
 | customGateways  | Array of custom gateways classes                         | `[CustomGateway]`         |
 | smtp.host       | Mail gateway host address                                | `smtp.gmail.com`          |
 | smtp.port       | Mail gateway port number                                 | `586`                     |
@@ -71,28 +52,36 @@ For sending message your templates folder should include this files:
 | smtp.password   | Mail gateway password                                    | `qh05780c2qcm034579`      |
 | \*.sender       | Mail sender address                                      | `postmail@pixelplex.io`   |
 | slack.url       | Hook URL in case you want to duplicate messages to Slack | `https://hooks.slack.com` |
-| sendgrid.apiKey | Sendgrid api key                                         | `oiqur9823uiofhaoafoe`    |
+| sendgrid.apiKey | Sendgrid API key                                         | `oiqur9823uiofhaoafoe`    |
+| resend.apiKey   | Resend API key                                           | `re_xxxxxxxxx`            |
 
-### Trigger new message sending
+### Resend config
 
-**1. Install npm package**
+```typescript
+export const mailConfig = {
+  gateways: ['resend'],
+  resend: {
+    apiKey: process.env.RESEND_API_KEY,
+    sender: process.env.MAIL_SENDER,
+  },
+};
+```
+
+## Usage
 
 ```bash
 yarn add @pixelplex/mail-service
 ```
 
-**2. Import MailModule** in your module you'll send mail from:
-
 ```typescript
 import { Module } from '@nestjs/common';
 import { MailModule } from '@pixelplex/mail-service';
 import { AppService } from './app.service';
 
 @Module({
-  controllers: [],
   imports: [
     MailModule.forRoot({
-      gateways: ['slack', 'smtp', 'console'],
+      gateways: ['slack', 'smtp', 'console', 'resend'],
       slack: { url: 'hooks.slack.com' },
       smtp: {
         username: 'postmail@pixelplex.io',
@@ -101,6 +90,10 @@ import { AppService } from './app.service';
         port: 678,
         password: 'password',
       },
+      resend: {
+        apiKey: RESEND_API_KEY,
+        sender: MAIL_SENDER,
+      },
     }),
   ],
   providers: [AppService],
@@ -108,35 +101,40 @@ import { AppService } from './app.service';
 export class AppModule {}
 ```
 
-**3. Call sendEmail** to send your mail:
-
 ```typescript
 import { Injectable } from '@nestjs/common';
 import { MailSenderService } from '@pixelplex/mail-service';
 
 @Injectable()
 export class AppService {
-  constructor(private mailSenderService: MailSenderService) {}
+  constructor(private readonly mailSenderService: MailSenderService) {}
 
-  async onModuleInit() {
-    this.mailSenderService.sendEmail(
+  async sendWelcomeEmail() {
+    await this.mailSenderService.sendEmail(
       'test@gmail.com',
-      // additionaly you can use plain: plainText, subject: subjectText to specify plain or subject directly
-      // if so, plainPath or subjectPath will be ignored
-      { htmlPath: htmlTemplatePath, plainPath: plainTextTemplatePath, subjectPath: subjectTemplatePath },
+      {
+        htmlPath: htmlTemplatePath,
+        plainPath: plainTextTemplatePath,
+        subjectPath: subjectTemplatePath,
+      },
       { year: 20 },
     );
   }
 }
 ```
 
-`{year: 20}` is the object with data which will used as payload data during processing your handlebars template.
+`{ year: 20 }` is the Handlebars context passed into the templates.
+
+React templates are not supported at the moment. The package supports the same Handlebars-based flow as before, including for the new `resend` gateway.
 
-### Custom gateways
+## Custom gateways
 
-To add custom gateways, provide class, that extends IGateway to customGateways options
+To add a custom gateway, provide a class that implements `IGateway` in `customGateways`.
 
 ```typescript
+import { Injectable } from '@nestjs/common';
+import { Content, IGateway } from '@pixelplex/mail-service';
+
 @Injectable()
 class CustomGateway implements IGateway {
   async send(to: string, content: Content): Promise<void> {
@@ -144,5 +142,8 @@ class CustomGateway implements IGateway {
   }
 }
 
-MailModule.forRoot({ customGateways: [CustomGateway] });
+MailModule.forRoot({
+  gateways: ['console'],
+  customGateways: [CustomGateway],
+});
 ```

package/dist/constants/mail.constants.d.ts

@@ -7,5 +7,6 @@ export declare enum GATEWAY {
     SMTP = "smtp",
     SLACK = "slack",
     CONSOLE = "console",
-    SENDGRID = "sendgrid"
+    SENDGRID = "sendgrid",
+    RESEND = "resend"
 }

package/dist/constants/mail.constants.js

@@ -13,5 +13,6 @@ var GATEWAY;
     GATEWAY["SLACK"] = "slack";
     GATEWAY["CONSOLE"] = "console";
     GATEWAY["SENDGRID"] = "sendgrid";
+    GATEWAY["RESEND"] = "resend";
 })(GATEWAY || (exports.GATEWAY = GATEWAY = {}));
 //# sourceMappingURL=mail.constants.js.map

package/dist/constants/mail.constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"mail.constants.js","sourceRoot":"","sources":["../../src/constants/mail.constants.ts"],"names":[],"mappings":";;;AAAA,IAAY,qBAIX;AAJD,WAAY,qBAAqB;IAC/B,uDAA8B,CAAA;IAC9B,iEAAwC,CAAA;IACxC,mEAA0C,CAAA;AAC5C,CAAC,EAJW,qBAAqB,qCAArB,qBAAqB,QAIhC;AAED,IAAY,OAKX;AALD,WAAY,OAAO;IACjB,wBAAa,CAAA;IACb,0BAAe,CAAA;IACf,8BAAmB,CAAA;IACnB,gCAAqB,CAAA;AACvB,CAAC,EALW,OAAO,uBAAP,OAAO,QAKlB"}
+{"version":3,"file":"mail.constants.js","sourceRoot":"","sources":["../../src/constants/mail.constants.ts"],"names":[],"mappings":";;;AAAA,IAAY,qBAIX;AAJD,WAAY,qBAAqB;IAC/B,uDAA8B,CAAA;IAC9B,iEAAwC,CAAA;IACxC,mEAA0C,CAAA;AAC5C,CAAC,EAJW,qBAAqB,qCAArB,qBAAqB,QAIhC;AAED,IAAY,OAMX;AAND,WAAY,OAAO;IACjB,wBAAa,CAAA;IACb,0BAAe,CAAA;IACf,8BAAmB,CAAA;IACnB,gCAAqB,CAAA;IACrB,4BAAiB,CAAA;AACnB,CAAC,EANW,OAAO,uBAAP,OAAO,QAMlB"}

package/dist/factories/gateway.factory.js

@@ -10,6 +10,7 @@ class GatewayFactory {
             [constants_1.GATEWAY.CONSOLE]: gateways_1.ConsoleGateway,
             [constants_1.GATEWAY.SMTP]: gateways_1.SmtpGateway,
             [constants_1.GATEWAY.SENDGRID]: gateways_1.SendgridGateway,
+            [constants_1.GATEWAY.RESEND]: gateways_1.ResendGateway,
         };
         return gateways[gateway];
     }

package/dist/factories/gateway.factory.js.map

@@ -1 +1 @@
-{"version":3,"file":"gateway.factory.js","sourceRoot":"","sources":["../../src/factories/gateway.factory.ts"],"names":[],"mappings":";;;AAAA,4CAAuC;AACvC,0CAAyF;AAGzF,MAAa,cAAc;IACzB,MAAM,CAAC,UAAU,CAAC,OAAgB;QAChC,MAAM,QAAQ,GAAG;YACf,CAAC,mBAAO,CAAC,KAAK,CAAC,EAAE,uBAAY;YAC7B,CAAC,mBAAO,CAAC,OAAO,CAAC,EAAE,yBAAc;YACjC,CAAC,mBAAO,CAAC,IAAI,CAAC,EAAE,sBAAW;YAC3B,CAAC,mBAAO,CAAC,QAAQ,CAAC,EAAE,0BAAe;SACpC,CAAC;QAEF,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC;CACF;AAXD,wCAWC"}
+{"version":3,"file":"gateway.factory.js","sourceRoot":"","sources":["../../src/factories/gateway.factory.ts"],"names":[],"mappings":";;;AAAA,4CAAuC;AACvC,0CAAwG;AAGxG,MAAa,cAAc;IACzB,MAAM,CAAC,UAAU,CAAC,OAAgB;QAChC,MAAM,QAAQ,GAAG;YACf,CAAC,mBAAO,CAAC,KAAK,CAAC,EAAE,uBAAY;YAC7B,CAAC,mBAAO,CAAC,OAAO,CAAC,EAAE,yBAAc;YACjC,CAAC,mBAAO,CAAC,IAAI,CAAC,EAAE,sBAAW;YAC3B,CAAC,mBAAO,CAAC,QAAQ,CAAC,EAAE,0BAAe;YACnC,CAAC,mBAAO,CAAC,MAAM,CAAC,EAAE,wBAAa;SAChC,CAAC;QAEF,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC;CACF;AAZD,wCAYC"}

package/dist/gateways/index.d.ts

@@ -1,4 +1,5 @@
 export * from './console.gateway';
+export * from './resend.gateway';
 export * from './sendgrid.gateway';
 export * from './slack.gateway';
 export * from './smtp.gateway';

package/dist/gateways/index.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./console.gateway"), exports);
+__exportStar(require("./resend.gateway"), exports);
 __exportStar(require("./sendgrid.gateway"), exports);
 __exportStar(require("./slack.gateway"), exports);
 __exportStar(require("./smtp.gateway"), exports);

package/dist/gateways/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/gateways/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,qDAAmC;AACnC,kDAAgC;AAChC,iDAA+B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/gateways/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,mDAAiC;AACjC,qDAAmC;AACnC,kDAAgC;AAChC,iDAA+B"}

package/dist/gateways/resend.gateway.d.ts

@@ -0,0 +1,12 @@
+import { IGateway } from '../interfaces';
+import { Content, ResendOptions } from '../types';
+export declare class ResendGateway implements IGateway {
+    private readonly resendOptions;
+    private readonly logger;
+    private readonly client;
+    constructor(resendOptions: ResendOptions);
+    send(to: string, content: Content): Promise<void>;
+    private prepareAttachments;
+    private getAttachmentContent;
+    private createSendError;
+}

package/dist/gateways/resend.gateway.js

@@ -0,0 +1,66 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResendGateway = void 0;
+const common_1 = require("@nestjs/common");
+const constants_1 = require("../constants");
+const decorators_1 = require("../decorators");
+const utils_1 = require("../utils");
+const { Resend } = require('resend');
+let ResendGateway = class ResendGateway {
+    constructor(resendOptions) {
+        this.resendOptions = resendOptions;
+        this.logger = new common_1.Logger('Mail::ResendGateway');
+        if (!(resendOptions === null || resendOptions === void 0 ? void 0 : resendOptions.apiKey)) {
+            throw new Error('Resend gateway requires "resend.apiKey"');
+        }
+        if (!(resendOptions === null || resendOptions === void 0 ? void 0 : resendOptions.sender)) {
+            throw new Error('Resend gateway requires "resend.sender"');
+        }
+        this.client = new Resend(resendOptions.apiKey);
+    }
+    async send(to, content) {
+        const { error } = await this.client.emails.send(Object.assign(Object.assign({ to, from: this.resendOptions.sender, subject: content.subject, html: content.html }, (content.plain ? { text: content.plain } : {})), (content.attachments ? { attachments: this.prepareAttachments(content.attachments) } : {})));
+        if (error) {
+            throw this.createSendError(error);
+        }
+        this.logger.debug(`Message to ${to} sent with resend`);
+    }
+    prepareAttachments(attachments) {
+        return attachments.map((attachment) => ({
+            content: this.getAttachmentContent(attachment),
+            filename: attachment.filename,
+            contentType: attachment.mimeType,
+        }));
+    }
+    getAttachmentContent(attachment) {
+        if ((0, utils_1.isBuffer)(attachment.content)) {
+            return attachment.content.toString('base64');
+        }
+        return attachment.encoding === 'base64' ? attachment.content : Buffer.from(attachment.content).toString('base64');
+    }
+    createSendError(error) {
+        const sendError = new Error(`Failed to send mail with resend: ${error.message}`);
+        sendError.name = 'ResendGatewayError';
+        Object.assign(sendError, { cause: error });
+        return sendError;
+    }
+};
+exports.ResendGateway = ResendGateway;
+exports.ResendGateway = ResendGateway = __decorate([
+    (0, common_1.Injectable)(),
+    __param(0, (0, decorators_1.InjectGatewayOptions)(constants_1.GATEWAY.RESEND)),
+    __metadata("design:paramtypes", [Object])
+], ResendGateway);
+//# sourceMappingURL=resend.gateway.js.map

package/dist/gateways/resend.gateway.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resend.gateway.js","sourceRoot":"","sources":["../../src/gateways/resend.gateway.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAAoD;AAEpD,4CAAuC;AACvC,8CAAqD;AAGrD,oCAAoC;AA+BpC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,QAAQ,CAElC,CAAC;AAGK,IAAM,aAAa,GAAnB,MAAM,aAAa;IAKxB,YAAkD,aAA6C;QAA5B,kBAAa,GAAb,aAAa,CAAe;QAJ9E,WAAM,GAAG,IAAI,eAAM,CAAC,qBAAqB,CAAC,CAAC;QAK1D,IAAI,CAAC,CAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,MAAM,CAAA,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;QAC7D,CAAC;QAED,IAAI,CAAC,CAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,MAAM,CAAA,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;QAC7D,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IACjD,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,EAAU,EAAE,OAAgB;QACrC,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,+BAC7C,EAAE,EACF,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,MAAM,EAC/B,OAAO,EAAE,OAAO,CAAC,OAAO,EACxB,IAAI,EAAE,OAAO,CAAC,IAAI,IACf,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,GAC9C,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAC7F,CAAC;QAEH,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QACpC,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,cAAc,EAAE,mBAAmB,CAAC,CAAC;IACzD,CAAC;IAEO,kBAAkB,CAAC,WAAyB;QAClD,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;YACtC,OAAO,EAAE,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC;YAC9C,QAAQ,EAAE,UAAU,CAAC,QAAQ;YAC7B,WAAW,EAAE,UAAU,CAAC,QAAQ;SACjC,CAAC,CAAC,CAAC;IACN,CAAC;IAEO,oBAAoB,CAAC,UAAsB;QACjD,IAAI,IAAA,gBAAQ,EAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YACjC,OAAO,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC/C,CAAC;QAED,OAAO,UAAU,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACpH,CAAC;IAEO,eAAe,CAAC,KAAkB;QACxC,MAAM,SAAS,GAAG,IAAI,KAAK,CAAC,oCAAoC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QACjF,SAAS,CAAC,IAAI,GAAG,oBAAoB,CAAC;QACtC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;QAE3C,OAAO,SAAS,CAAC;IACnB,CAAC;CACF,CAAA;AAzDY,sCAAa;wBAAb,aAAa;IADzB,IAAA,mBAAU,GAAE;IAME,WAAA,IAAA,iCAAoB,EAAC,mBAAO,CAAC,MAAM,CAAC,CAAA;;GALtC,aAAa,CAyDzB"}