@travetto/email 2.2.7 → 3.0.0-rc.0

package/README.md

@@ -34,52 +34,3 @@ By design, sending an email requires the sender to specify the html, text option
    *  `resources/<key>.compiled.text`
    *  `resources/<key>.compiled.subject`
 With `.html` being the only required field.  The [Email Templating](https://github.com/travetto/travetto/tree/main/module/email-template#readme "Email templating module") module supports this format, and will generate files accordingly. Also, note that `<key>` can include slashes, allowing for nesting folders.
-
-## Nodemailer - Extension
-
-Given the integration with [nodemailer](https://nodemailer.com/about/), all extensions should be usable out of the box. The primary [nodemailer](https://nodemailer.com/about/) modules are provided (assuming dependencies are installed):
-
-**Code: sendmail to send all messages via the sendmail operation**
-```typescript
-import { InjectableFactory } from '@travetto/di';
-import { NodemailerTransport } from '@travetto/email';
-
-class Config {
-  @InjectableFactory()
-  static getTransport() {
-    return new NodemailerTransport({ sendmail: true });
-  }
-}
-```
-
-**Code: smtp to send all messages via the smtp operation**
-```typescript
-import { InjectableFactory } from '@travetto/di';
-import { NodemailerTransport } from '@travetto/email';
-
-class Config {
-  @InjectableFactory()
-  static getTransport() {
-    return new NodemailerTransport({
-      service: 'smtp'
-    });
-  }
-}
-```
-
-**Code: ses to send all messages via the ses operation**
-```typescript
-import { SESClient } from '@aws-sdk/client-ses';
-
-import { InjectableFactory } from '@travetto/di';
-import { NodemailerTransport } from '@travetto/email';
-
-class Config {
-  @InjectableFactory()
-  static getTransport() {
-    return new NodemailerTransport({
-      SES: SESClient
-    });
-  }
-}
-```

package/index.ts

@@ -3,6 +3,4 @@ export * from './src/types';
 export * from './src/config';
 export * from './src/transport';
 export * from './src/util';
-export * from './src/template';
-// Named export needed for proxying
-export { NodemailerTransport } from './src/extension/nodemailer';
+export * from './src/template';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@travetto/email",
   "displayName": "Email",
-  "version": "2.2.7",
+  "version": "3.0.0-rc.0",
   "description": "Email transmission module.",
   "keywords": [
     "email",
@@ -24,19 +24,12 @@
     "directory": "module/email"
   },
   "dependencies": {
-    "@travetto/config": "^2.2.4",
-    "@travetto/di": "^2.2.4",
+    "@travetto/config": "^3.0.0-rc.0",
+    "@travetto/di": "^3.0.0-rc.0",
     "@types/mustache": "^4.2.1",
     "mustache": "^4.2.0"
   },
-  "optionalPeerDependencies": {
-    "nodemailer": "^6.7.8",
-    "@types/nodemailer": "^6.4.5"
-  },
   "publishConfig": {
     "access": "public"
-  },
-  "docDependencies": {
-    "@aws-sdk/client-ses": "^3.154.0"
   }
 }

package/src/extension/nodemailer.ts

@@ -1,9 +1,8 @@
-// @file-if nodemailer
-import * as nodemailer from 'nodemailer';
-import * as json from 'nodemailer/lib/json-transport';
-import * as smtp from 'nodemailer/lib/smtp-transport';
-import * as ses from 'nodemailer/lib/ses-transport';
-import * as sendmail from 'nodemailer/lib/sendmail-transport';
+import type * as nodemailer from 'nodemailer';
+import type * as json from 'nodemailer/lib/json-transport';
+import type * as smtp from 'nodemailer/lib/smtp-transport';
+import type * as ses from 'nodemailer/lib/ses-transport';
+import type * as sendmail from 'nodemailer/lib/sendmail-transport';
 
 import { MessageOptions, SentMessage } from '../types';
 import { MailTransport } from '../transport';
@@ -17,7 +16,15 @@ export class NodemailerTransport implements MailTransport {
   #transport: nodemailer.Transporter;
 
   constructor(transportFactory: Transport) {
-    this.#transport = nodemailer.createTransport(transportFactory);
+    try {
+      const nm = require('nodemailer');
+      this.#transport = nm.createTransport(transportFactory);
+    } catch (err) {
+      if (err instanceof Error) {
+        console.error('Please install nodemailer before use: "npm install nodemailer"');
+      }
+      throw err;
+    }
   }
 
   async send<S extends SentMessage = SentMessage>(mail: MessageOptions): Promise<S> {