@skroz/profile-api 1.0.7 → 1.0.8

package/src/services/ProfileEmailService.ts

@@ -2,157 +2,157 @@ import AwsSes from '@os-team/aws-ses';
 import pug from 'pug';
 import path from 'path';
 import {
-  AuthUser,
-  EmailConfig,
-  ProfileEmailTemplate,
-  ProfileLocales,
+    AuthUser,
+    EmailConfig,
+    ProfileEmailTemplate,
+    ProfileLocales,
 } from '../types';
 
 export type EmailType = 'auth' | 'activity' | 'info' | 'admin' | 'other';
 
 export class ProfileEmailService {
-  private ses: AwsSes;
-
-  private config: EmailConfig;
-
-  private locales: ProfileLocales;
-
-  constructor(config: EmailConfig, locales: ProfileLocales) {
-    this.ses = new AwsSes({ region: 'eu-west-1' });
-    this.config = config;
-    this.locales = locales;
-  }
-
-  private getWebsiteUrl() {
-    return this.config.websiteUrl || `https://${this.config.domain}`;
-  }
-
-  private render(templateName: string, vars: any) {
-    const templatePath = path.resolve(
-      this.config.templateDir,
-      `${templateName}.pug`
-    );
-    return pug.renderFile(templatePath, {
-      domain: this.config.domain,
-      websiteUrl: this.getWebsiteUrl(),
-      primaryBrandColor: this.config.primaryBrandColor,
-      logoUrl: this.config.logoUrl || '',
-      ...vars,
-    });
-  }
-
-  private getFrom(type: EmailType) {
-    const { domain } = this.config;
-    const username = this.config.fromEmailUsername;
-
-    switch (type) {
-      case 'auth':
-        return `${domain} <${username}@auth.${domain}>`;
-      case 'activity':
-        return `${domain} <${username}@a.${domain}>`;
-      case 'info':
-        return `${domain} <${username}@i.${domain}>`;
-      case 'admin':
-        return `${domain} <${username}@admin.${domain}>`;
-      default:
-        return `${domain} <${username}@o.${domain}>`;
+    private ses: AwsSes;
+
+    private config: EmailConfig;
+
+    private locales: ProfileLocales;
+
+    constructor(config: EmailConfig, locales: ProfileLocales) {
+        this.ses = new AwsSes({ region: 'eu-west-1' });
+        this.config = config;
+        this.locales = locales;
+    }
+
+    private getWebsiteUrl() {
+        return this.config.websiteUrl || `https://${this.config.domain}`;
+    }
+
+    private render(templateName: string, vars: any) {
+        const templatePath = path.resolve(
+            this.config.templateDir || path.resolve(__dirname, '../email-templates'),
+            `${templateName}.pug`
+        );
+        return pug.renderFile(templatePath, {
+            domain: this.config.domain,
+            websiteUrl: this.getWebsiteUrl(),
+            primaryBrandColor: this.config.primaryBrandColor,
+            logoUrl: this.config.logoUrl || '',
+            link: vars.linkHref ? { href: vars.linkHref, label: vars.linkTitle } : undefined,
+            ...vars,
+        });
+    }
+
+    private getFrom(type: EmailType) {
+        const { domain } = this.config;
+        const username = this.config.fromEmailUsername;
+
+        switch (type) {
+            case 'auth':
+                return `${domain} <${username}@auth.${domain}>`;
+            case 'activity':
+                return `${domain} <${username}@a.${domain}>`;
+            case 'info':
+                return `${domain} <${username}@i.${domain}>`;
+            case 'admin':
+                return `${domain} <${username}@admin.${domain}>`;
+            default:
+                return `${domain} <${username}@o.${domain}>`;
+        }
+    }
+
+    async send(
+        to: string,
+        subject: string,
+        template: string,
+        vars: any,
+        type: EmailType = 'other'
+    ) {
+        const html = this.render(template, vars);
+        const from = this.getFrom(type);
+
+        return this.ses.send({
+            Destination: { ToAddresses: [to] },
+            Message: {
+                Subject: { Data: subject, Charset: 'UTF-8' },
+                Body: { Html: { Data: html, Charset: 'UTF-8' } },
+            },
+            Source: from,
+        });
+    }
+
+    async sendToken(
+        user: AuthUser,
+        type: 'confirmation' | 'recovery',
+        token: string
+    ) {
+        if (!user.email) return false;
+
+        const isConfirm = type === 'confirmation';
+        const emailLocales = isConfirm
+            ? this.locales.email.confirmEmail
+            : this.locales.email.forgotPassword;
+
+        const template = isConfirm
+            ? ProfileEmailTemplate.CONFIRM_EMAIL
+            : ProfileEmailTemplate.FORGOT_PASSWORD;
+
+        return this.send(
+            user.email,
+            emailLocales.subject,
+            template,
+            {
+                header: emailLocales.header,
+                text: emailLocales.text,
+                linkTitle: emailLocales.linkTitle,
+                linkHref: `${this.getWebsiteUrl()}/${type}?token=${token}&email=${user.email
+                    }`,
+                confirmationToken: token,
+            },
+            'auth'
+        );
+    }
+
+    async sendTemporaryPassword(user: AuthUser, tempPassword: string) {
+        if (!user.email) return false;
+
+        const emailLocales = this.locales.email.tempPassword;
+
+        return this.send(
+            user.email,
+            emailLocales.subject,
+            ProfileEmailTemplate.TEMP_PASSWORD,
+            {
+                header: emailLocales.header.replace('{{tempPassword}}', tempPassword),
+                text: emailLocales.text,
+                linkTitle: emailLocales.linkTitle,
+                linkHref: this.getWebsiteUrl(),
+            },
+            'auth'
+        );
+    }
+
+    /* Generic method for any custom project emails */
+    async sendGenericEmail(
+        user: AuthUser,
+        subject: string,
+        text: string,
+        type: EmailType = 'info',
+        vars: any = {}
+    ) {
+        if (!user.email) return false;
+
+        return this.send(
+            user.email,
+            subject,
+            ProfileEmailTemplate.GENERIC_NOTIFICATION,
+            {
+                header: subject,
+                text,
+                linkTitle: 'Go to Website',
+                linkHref: this.getWebsiteUrl(),
+                ...vars,
+            },
+            type
+        );
     }
-  }
-
-  async send(
-    to: string,
-    subject: string,
-    template: string,
-    vars: any,
-    type: EmailType = 'other'
-  ) {
-    const html = this.render(template, vars);
-    const from = this.getFrom(type);
-
-    return this.ses.send({
-      Destination: { ToAddresses: [to] },
-      Message: {
-        Subject: { Data: subject, Charset: 'UTF-8' },
-        Body: { Html: { Data: html, Charset: 'UTF-8' } },
-      },
-      Source: from,
-    });
-  }
-
-  async sendToken(
-    user: AuthUser,
-    type: 'confirmation' | 'recovery',
-    token: string
-  ) {
-    if (!user.email) return false;
-
-    const isConfirm = type === 'confirmation';
-    const emailLocales = isConfirm
-      ? this.locales.email.confirmEmail
-      : this.locales.email.forgotPassword;
-
-    const template = isConfirm
-      ? ProfileEmailTemplate.CONFIRM_EMAIL
-      : ProfileEmailTemplate.FORGOT_PASSWORD;
-
-    return this.send(
-      user.email,
-      emailLocales.subject,
-      template,
-      {
-        header: emailLocales.header,
-        text: emailLocales.text,
-        linkTitle: emailLocales.linkTitle,
-        linkHref: `${this.getWebsiteUrl()}/${type}?token=${token}&email=${
-          user.email
-        }`,
-        confirmationToken: token,
-      },
-      'auth'
-    );
-  }
-
-  async sendTemporaryPassword(user: AuthUser, tempPassword: string) {
-    if (!user.email) return false;
-
-    const emailLocales = this.locales.email.tempPassword;
-
-    return this.send(
-      user.email,
-      emailLocales.subject,
-      ProfileEmailTemplate.TEMP_PASSWORD,
-      {
-        header: emailLocales.header.replace('{{tempPassword}}', tempPassword),
-        text: emailLocales.text,
-        linkTitle: emailLocales.linkTitle,
-        linkHref: this.getWebsiteUrl(),
-      },
-      'auth'
-    );
-  }
-
-  /* Generic method for any custom project emails */
-  async sendGenericEmail(
-    user: AuthUser,
-    subject: string,
-    text: string,
-    type: EmailType = 'info',
-    vars: any = {}
-  ) {
-    if (!user.email) return false;
-
-    return this.send(
-      user.email,
-      subject,
-      ProfileEmailTemplate.GENERIC_NOTIFICATION,
-      {
-        header: subject,
-        text,
-        linkTitle: 'Go to Website',
-        linkHref: this.getWebsiteUrl(),
-        ...vars,
-      },
-      type
-    );
-  }
 }

package/src/types/index.ts

@@ -35,7 +35,7 @@ export interface EmailConfig extends ProfileAuthConfig {
     primaryBrandColor: string;
     logoUrl?: string;
     fromEmailUsername?: string; // e.g. "support" or "info"
-    templateDir: string;
+    templateDir?: string;
     isOnlineSeconds: number;
     isOnlineRecentlySeconds: number;
 }