@travetto/email 6.0.0-rc.1 → 6.0.0

package/README.md

@@ -13,7 +13,7 @@ npm install @travetto/email
 yarn add @travetto/email
 ```
 
-A standard API for sending and rendering emails. The mail transport must be defined to allow for mail to be sent properly.  Out of the box, the only transport available by default is the [NullTransport](https://github.com/travetto/travetto/tree/main/module/email/src/transport.ts#L15) which will just drop emails. The structure of the API is derived from  [nodemailer](https://nodemailer.com/about/), but is compatible with any library that can handle the [EmailOptions](https://github.com/travetto/travetto/tree/main/module/email/src/types.ts#L44) input. 
+A standard API for sending and rendering emails. The mail transport must be defined to allow for mail to be sent properly.  Out of the box, the only transport available by default is the [NullTransport](https://github.com/travetto/travetto/tree/main/module/email/src/transport.ts#L16) which will just drop emails. The structure of the API is derived from  [nodemailer](https://nodemailer.com/about/), but is compatible with any library that can handle the [EmailOptions](https://github.com/travetto/travetto/tree/main/module/email/src/types.ts#L45) input. 
 
 To expose the necessary email transport, the following pattern is commonly used:
 
@@ -37,4 +37,5 @@ By design, sending an email requires the sender to specify the html, text option
    *  `resources/<key>.compiled.html`
    *  `resources/<key>.compiled.text`
    *  `resources/<key>.compiled.subject`
+
 With `.html` being the only required field.  The [Email Compilation Support](https://github.com/travetto/travetto/tree/main/module/email-compiler#readme "Email compiling module") module supports this format, and will generate files accordingly. Also, note that `<key>` can include slashes, allowing for nesting folders.

package/__index__.ts

@@ -1,7 +1,7 @@
-export * from './src/service';
-export * from './src/types';
-export * from './src/config';
-export * from './src/resource';
-export * from './src/transport';
-export * from './src/util';
-export * from './src/template';
+export * from './src/service.ts';
+export * from './src/types.ts';
+export * from './src/config.ts';
+export * from './src/resource.ts';
+export * from './src/transport.ts';
+export * from './src/util.ts';
+export * from './src/template.ts';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/email",
-  "version": "6.0.0-rc.1",
+  "version": "6.0.0",
   "description": "Email transmission module.",
   "keywords": [
     "email",
@@ -23,9 +23,9 @@
     "directory": "module/email"
   },
   "dependencies": {
-    "@travetto/config": "^6.0.0-rc.1",
-    "@travetto/di": "^6.0.0-rc.1",
-    "@travetto/runtime": "^6.0.0-rc.1",
+    "@travetto/config": "^6.0.0",
+    "@travetto/di": "^6.0.0",
+    "@travetto/runtime": "^6.0.0",
     "@types/mustache": "^4.2.5",
     "mustache": "^4.2.0"
   },

package/src/service.ts

@@ -1,10 +1,10 @@
 import { Runtime, RuntimeResources } from '@travetto/runtime';
 import { Injectable } from '@travetto/di';
 
-import { EmailCompiled, EmailOptions, SentEmail } from './types';
-import { MailTransport } from './transport';
-import { MailInterpolator } from './template';
-import { MailUtil } from './util';
+import { EmailCompiled, EmailOptions, SentEmail } from './types.ts';
+import { MailTransport } from './transport.ts';
+import { MailInterpolator } from './template.ts';
+import { MailUtil } from './util.ts';
 
 type MessageWithoutBody = Omit<EmailOptions, keyof EmailCompiled>;
 

package/src/template.ts

@@ -6,7 +6,7 @@ import { RuntimeResources } from '@travetto/runtime';
 /**
  * Mail interpolation engine
  *
- * @concrete ./internal/types#MailInterpolatorTarget
+ * @concrete
  */
 export interface MailInterpolator {
   /**

package/src/transport.ts

@@ -1,9 +1,10 @@
-import { EmailOptions, SentEmail } from './types';
+import { castTo } from '@travetto/runtime';
+import { EmailOptions, SentEmail } from './types.ts';
 
 /**
  * Default mail transport
  *
- * @concrete ./internal/types#MailTransportTarget
+ * @concrete
  */
 export interface MailTransport {
   send<S extends SentEmail = SentEmail>(mail: EmailOptions): Promise<S>;
@@ -13,7 +14,7 @@ export interface MailTransport {
  * Transport that consumes messages without sending
  */
 export class NullTransport implements MailTransport {
-  async send<S extends SentEmail = SentEmail>(mail: EmailOptions): Promise<S> {
-    return undefined! ?? {};
+  async send<S extends SentEmail = SentEmail>(): Promise<S> {
+    return castTo({});
   }
 }

package/src/types.ts

@@ -40,6 +40,7 @@ export type EmailIdentityList = EmailIdentity | EmailIdentity[];
 
 /**
  * Full message options
+ * @concrete
  */
 export interface EmailOptions {
   html: string;

package/src/util.ts

@@ -1,6 +1,6 @@
 import { Runtime, BinaryUtil } from '@travetto/runtime';
 
-import { EmailAttachment, EmailIdentity, EmailIdentityList, EmailOptions } from './types';
+import { EmailAttachment, EmailIdentity, EmailIdentityList, EmailOptions } from './types.ts';
 
 /**
  * Utilities for email

package/src/internal/types.ts

@@ -1,2 +0,0 @@
-export class MailInterpolatorTarget { }
-export class MailTransportTarget { }