@takaro/email 0.0.0-next.0da151e

package/dist/config.d.ts

@@ -0,0 +1,57 @@
+import { Config, IBaseConfig } from '@takaro/config';
+export interface IMailConfig extends IBaseConfig {
+    mail: {
+        postmarkApiKey: string;
+        host: string;
+        port: number;
+        secure: boolean;
+        auth: {
+            user: string;
+            pass: string;
+        };
+    };
+}
+export declare const configSchema: {
+    mail: {
+        postmarkApiKey: {
+            doc: string;
+            format: StringConstructor;
+            default: string;
+            env: string;
+        };
+        host: {
+            doc: string;
+            format: StringConstructor;
+            default: string;
+            env: string;
+        };
+        port: {
+            doc: string;
+            format: NumberConstructor;
+            default: number;
+            env: string;
+        };
+        secure: {
+            doc: string;
+            format: BooleanConstructor;
+            default: boolean;
+            env: string;
+        };
+        auth: {
+            user: {
+                doc: string;
+                format: StringConstructor;
+                default: string;
+                env: string;
+            };
+            pass: {
+                doc: string;
+                format: StringConstructor;
+                default: string;
+                env: string;
+            };
+        };
+    };
+};
+export declare const config: Config<IMailConfig>;
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAErD,MAAM,WAAW,WAAY,SAAQ,WAAW;IAC9C,IAAI,EAAE;QACJ,cAAc,EAAE,MAAM,CAAC;QACvB,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,OAAO,CAAC;QAChB,IAAI,EAAE;YACJ,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,EAAE,MAAM,CAAC;SACd,CAAC;KACH,CAAC;CACH;AAED,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyCxB,CAAC;AAEF,eAAO,MAAM,MAAM,qBAA0C,CAAC"}

package/dist/config.js

@@ -0,0 +1,45 @@
+import { Config } from '@takaro/config';
+export const configSchema = {
+    mail: {
+        postmarkApiKey: {
+            doc: 'The API key for the Postmark mail service.',
+            format: String,
+            default: '',
+            env: 'MAIL_POSTMARK_API_KEY',
+        },
+        host: {
+            doc: 'The host of the mail server.',
+            format: String,
+            default: 'mailhog',
+            env: 'MAIL_HOST',
+        },
+        port: {
+            doc: 'The port of the mail server.',
+            format: Number,
+            default: 1025,
+            env: 'MAIL_PORT',
+        },
+        secure: {
+            doc: 'Whether to use TLS or not.',
+            format: Boolean,
+            default: false,
+            env: 'MAIL_SECURE',
+        },
+        auth: {
+            user: {
+                doc: 'The username to use for authentication.',
+                format: String,
+                default: 'test',
+                env: 'MAIL_USER',
+            },
+            pass: {
+                doc: 'The password to use for authentication.',
+                format: String,
+                default: 'test',
+                env: 'MAIL_PASS',
+            },
+        },
+    },
+};
+export const config = new Config([configSchema]);
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAe,MAAM,gBAAgB,CAAC;AAerD,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,IAAI,EAAE;QACJ,cAAc,EAAE;YACd,GAAG,EAAE,4CAA4C;YACjD,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE;YACX,GAAG,EAAE,uBAAuB;SAC7B;QACD,IAAI,EAAE;YACJ,GAAG,EAAE,8BAA8B;YACnC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,SAAS;YAClB,GAAG,EAAE,WAAW;SACjB;QACD,IAAI,EAAE;YACJ,GAAG,EAAE,8BAA8B;YACnC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,IAAI;YACb,GAAG,EAAE,WAAW;SACjB;QACD,MAAM,EAAE;YACN,GAAG,EAAE,4BAA4B;YACjC,MAAM,EAAE,OAAO;YACf,OAAO,EAAE,KAAK;YACd,GAAG,EAAE,aAAa;SACnB;QACD,IAAI,EAAE;YACJ,IAAI,EAAE;gBACJ,GAAG,EAAE,yCAAyC;gBAC9C,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE,MAAM;gBACf,GAAG,EAAE,WAAW;aACjB;YACD,IAAI,EAAE;gBACJ,GAAG,EAAE,yCAAyC;gBAC9C,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE,MAAM;gBACf,GAAG,EAAE,WAAW;aACjB;SACF;KACF;CACF,CAAC;AAEF,MAAM,CAAC,MAAM,MAAM,GAAG,IAAI,MAAM,CAAc,CAAC,YAAY,CAAC,CAAC,CAAC"}

package/dist/main.d.ts

@@ -0,0 +1,3 @@
+export { send } from './send.js';
+export { EMAIL_TEMPLATES } from './templates.js';
+//# sourceMappingURL=main.d.ts.map

package/dist/main.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/main.js

@@ -0,0 +1,3 @@
+export { send } from './send.js';
+export { EMAIL_TEMPLATES } from './templates.js';
+//# sourceMappingURL=main.js.map

package/dist/main.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/send.d.ts

@@ -0,0 +1,8 @@
+import { EMAIL_TEMPLATES } from './templates.js';
+export interface ISendOptions {
+    address: string;
+    template: keyof typeof EMAIL_TEMPLATES;
+    data: Record<string, unknown>;
+}
+export declare function send(opts: ISendOptions): Promise<any>;
+//# sourceMappingURL=send.d.ts.map

package/dist/send.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"send.d.ts","sourceRoot":"","sources":["../src/send.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAKjD,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,OAAO,eAAe,CAAC;IACvC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/B;AAmBD,wBAAsB,IAAI,CAAC,IAAI,EAAE,YAAY,gBAmB5C"}

package/dist/send.js

@@ -0,0 +1,36 @@
+import { errors, logger } from '@takaro/util';
+import { createTransport } from 'nodemailer';
+import { EMAIL_TEMPLATES } from './templates.js';
+import { PostmarkTransport } from 'nodemailer-postmark-transport';
+import { config } from './config.js';
+const log = logger('email:send');
+let transporter;
+if (config.get('mail.postmarkApiKey')) {
+    log.info('Using Postmark as mail transport');
+    transporter = createTransport(new PostmarkTransport({
+        auth: {
+            apiKey: config.get('mail.postmarkApiKey'),
+        },
+    }));
+}
+else {
+    log.info('Using SMTP as mail transport');
+    transporter = createTransport(config.get('mail'));
+}
+export async function send(opts) {
+    const template = EMAIL_TEMPLATES[opts.template];
+    if (!template) {
+        log.error(`Template ${opts.template} does not exist`);
+        throw new errors.InternalServerError();
+    }
+    const html = template.body(opts.data);
+    const result = await transporter.sendMail({
+        from: '"noreply@takaro.io" <noreply@takaro.io>',
+        to: opts.address,
+        subject: template.subject,
+        html,
+    });
+    log.info('Sent an email', { ...opts });
+    return result;
+}
+//# sourceMappingURL=send.js.map

package/dist/send.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"send.js","sourceRoot":"","sources":["../src/send.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAe,MAAM,YAAY,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAElE,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAQrC,MAAM,GAAG,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC;AAEjC,IAAI,WAAwB,CAAC;AAC7B,IAAI,MAAM,CAAC,GAAG,CAAC,qBAAqB,CAAC,EAAE,CAAC;IACtC,GAAG,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;IAC7C,WAAW,GAAG,eAAe,CAC3B,IAAI,iBAAiB,CAAC;QACpB,IAAI,EAAE;YACJ,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,qBAAqB,CAAC;SAC1C;KACF,CAAC,CACH,CAAC;AACJ,CAAC;KAAM,CAAC;IACN,GAAG,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;IACzC,WAAW,GAAG,eAAe,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;AACpD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,IAAkB;IAC3C,MAAM,QAAQ,GAAG,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAEhD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,GAAG,CAAC,KAAK,CAAC,YAAY,IAAI,CAAC,QAAQ,iBAAiB,CAAC,CAAC;QACtD,MAAM,IAAI,MAAM,CAAC,mBAAmB,EAAE,CAAC;IACzC,CAAC;IAED,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEtC,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,QAAQ,CAAC;QACxC,IAAI,EAAE,yCAAyC;QAC/C,EAAE,EAAE,IAAI,CAAC,OAAO;QAChB,OAAO,EAAE,QAAQ,CAAC,OAAO;QACzB,IAAI;KACL,CAAC,CAAC;IAEH,GAAG,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACvC,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/templates.d.ts

@@ -0,0 +1,8 @@
+import ejs from 'ejs';
+export declare const EMAIL_TEMPLATES: {
+    invite: {
+        subject: string;
+        body: ejs.TemplateFunction;
+    };
+};
+//# sourceMappingURL=templates.d.ts.map

package/dist/templates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../src/templates.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAC;AAEtB,eAAO,MAAM,eAAe;;;;;CAS3B,CAAC"}

package/dist/templates.js

@@ -0,0 +1,12 @@
+import ejs from 'ejs';
+export const EMAIL_TEMPLATES = {
+    invite: {
+        subject: 'You have been invited to Takaro',
+        body: ejs.compile(`
+      <h1>You have been invited to Takaro.</h1>
+      
+      <p>Click <a href="<%= inviteLink %>">here</a> to sign up.</p>
+      `),
+    },
+};
+//# sourceMappingURL=templates.js.map

package/dist/templates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.js","sourceRoot":"","sources":["../src/templates.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAC;AAEtB,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,MAAM,EAAE;QACN,OAAO,EAAE,iCAAiC;QAC1C,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC;;;;OAIf,CAAC;KACL;CACF,CAAC"}

package/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "@takaro/email",
+  "version": "0.0.0-next.0da151e",
+  "description": "",
+  "main": "dist/main.js",
+  "types": "dist/main.d.ts",
+  "type": "module",
+  "scripts": {
+    "start:dev": "tsc --watch --preserveWatchOutput -p ./tsconfig.build.json",
+    "build": "tsc -p ./tsconfig.build.json"
+  },
+  "author": "",
+  "license": "ISC"
+}

package/src/config.ts

@@ -0,0 +1,59 @@
+import { Config, IBaseConfig } from '@takaro/config';
+
+export interface IMailConfig extends IBaseConfig {
+  mail: {
+    postmarkApiKey: string;
+    host: string;
+    port: number;
+    secure: boolean;
+    auth: {
+      user: string;
+      pass: string;
+    };
+  };
+}
+
+export const configSchema = {
+  mail: {
+    postmarkApiKey: {
+      doc: 'The API key for the Postmark mail service.',
+      format: String,
+      default: '',
+      env: 'MAIL_POSTMARK_API_KEY',
+    },
+    host: {
+      doc: 'The host of the mail server.',
+      format: String,
+      default: 'mailhog',
+      env: 'MAIL_HOST',
+    },
+    port: {
+      doc: 'The port of the mail server.',
+      format: Number,
+      default: 1025,
+      env: 'MAIL_PORT',
+    },
+    secure: {
+      doc: 'Whether to use TLS or not.',
+      format: Boolean,
+      default: false,
+      env: 'MAIL_SECURE',
+    },
+    auth: {
+      user: {
+        doc: 'The username to use for authentication.',
+        format: String,
+        default: 'test',
+        env: 'MAIL_USER',
+      },
+      pass: {
+        doc: 'The password to use for authentication.',
+        format: String,
+        default: 'test',
+        env: 'MAIL_PASS',
+      },
+    },
+  },
+};
+
+export const config = new Config<IMailConfig>([configSchema]);

package/src/main.ts

@@ -0,0 +1,3 @@
+export { send } from './send.js';
+
+export { EMAIL_TEMPLATES } from './templates.js';

package/src/send.ts

@@ -0,0 +1,50 @@
+import { errors, logger } from '@takaro/util';
+import { createTransport, Transporter } from 'nodemailer';
+import { EMAIL_TEMPLATES } from './templates.js';
+import { PostmarkTransport } from 'nodemailer-postmark-transport';
+
+import { config } from './config.js';
+
+export interface ISendOptions {
+  address: string;
+  template: keyof typeof EMAIL_TEMPLATES;
+  data: Record<string, unknown>;
+}
+
+const log = logger('email:send');
+
+let transporter: Transporter;
+if (config.get('mail.postmarkApiKey')) {
+  log.info('Using Postmark as mail transport');
+  transporter = createTransport(
+    new PostmarkTransport({
+      auth: {
+        apiKey: config.get('mail.postmarkApiKey'),
+      },
+    }),
+  );
+} else {
+  log.info('Using SMTP as mail transport');
+  transporter = createTransport(config.get('mail'));
+}
+
+export async function send(opts: ISendOptions) {
+  const template = EMAIL_TEMPLATES[opts.template];
+
+  if (!template) {
+    log.error(`Template ${opts.template} does not exist`);
+    throw new errors.InternalServerError();
+  }
+
+  const html = template.body(opts.data);
+
+  const result = await transporter.sendMail({
+    from: '"noreply@takaro.io" <noreply@takaro.io>',
+    to: opts.address,
+    subject: template.subject,
+    html,
+  });
+
+  log.info('Sent an email', { ...opts });
+  return result;
+}

package/src/templates.ts

@@ -0,0 +1,12 @@
+import ejs from 'ejs';
+
+export const EMAIL_TEMPLATES = {
+  invite: {
+    subject: 'You have been invited to Takaro',
+    body: ejs.compile(`
+      <h1>You have been invited to Takaro.</h1>
+      
+      <p>Click <a href="<%= inviteLink %>">here</a> to sign up.</p>
+      `),
+  },
+};

package/tsconfig.build.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "dist"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["src/**/*.test.ts"]
+}

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist"
+  },
+  "include": ["src/**/*"]
+}

package/typedoc.json

@@ -0,0 +1,3 @@
+{
+  "entryPoints": ["src/main.ts"]
+}