@nest-boot/mailer 7.0.2 → 7.1.0

package/dist/mailer-module-options.interface.d.ts

@@ -3,4 +3,5 @@ import type SendmailTransport from "nodemailer/lib/sendmail-transport";
 import type SESTransport from "nodemailer/lib/ses-transport";
 import type SMTPTransport from "nodemailer/lib/smtp-transport";
 import type StreamTransport from "nodemailer/lib/stream-transport";
+/** Configuration options for the mailer module (nodemailer transport options). */
 export type MailerModuleOptions = JSONTransport.Options | SESTransport.Options | SMTPTransport.Options | SendmailTransport.Options | StreamTransport.Options;

package/dist/mailer.module.d.ts

@@ -1,3 +1,23 @@
-import { ConfigurableModuleClass } from "./mailer.module-definition";
+import { type DynamicModule } from "@nestjs/common";
+import { ASYNC_OPTIONS_TYPE, ConfigurableModuleClass, OPTIONS_TYPE } from "./mailer.module-definition";
+/**
+ * Email sending module powered by Nodemailer.
+ *
+ * @remarks
+ * Provides a configured Nodemailer transport instance for sending emails.
+ * Accepts standard Nodemailer transport options for SMTP configuration.
+ */
 export declare class MailerModule extends ConfigurableModuleClass {
+    /**
+     * Registers the MailerModule with the given options.
+     * @param options - Nodemailer transport configuration options
+     * @returns Dynamic module configuration
+     */
+    static register(options: typeof OPTIONS_TYPE): DynamicModule;
+    /**
+     * Registers the MailerModule asynchronously with factory functions.
+     * @param options - Async configuration options
+     * @returns Dynamic module configuration
+     */
+    static registerAsync(options: typeof ASYNC_OPTIONS_TYPE): DynamicModule;
 }

package/dist/mailer.module.js

@@ -19,7 +19,30 @@ const mailerProvider = {
     inject: [mailer_module_definition_1.MODULE_OPTIONS_TOKEN],
     useFactory: (options) => (0, nodemailer_1.createTransport)(options),
 };
+/**
+ * Email sending module powered by Nodemailer.
+ *
+ * @remarks
+ * Provides a configured Nodemailer transport instance for sending emails.
+ * Accepts standard Nodemailer transport options for SMTP configuration.
+ */
 let MailerModule = class MailerModule extends mailer_module_definition_1.ConfigurableModuleClass {
+    /**
+     * Registers the MailerModule with the given options.
+     * @param options - Nodemailer transport configuration options
+     * @returns Dynamic module configuration
+     */
+    static register(options) {
+        return super.register(options);
+    }
+    /**
+     * Registers the MailerModule asynchronously with factory functions.
+     * @param options - Async configuration options
+     * @returns Dynamic module configuration
+     */
+    static registerAsync(options) {
+        return super.registerAsync(options);
+    }
 };
 exports.MailerModule = MailerModule;
 exports.MailerModule = MailerModule = __decorate([

package/dist/mailer.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"mailer.module.js","sourceRoot":"","sources":["../src/mailer.module.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAAuD;AACvD,2CAA6C;AAC7C,mEAA2C;AAE3C,yEAGoC;AAGpC,MAAM,cAAc,GAAqB;IACvC,OAAO,EAAE,gBAAM;IACf,MAAM,EAAE,CAAC,+CAAoB,CAAC;IAC9B,UAAU,EAAE,CAAC,OAA4B,EAAE,EAAE,CAAC,IAAA,4BAAe,EAAC,OAAO,CAAC;CACvE,CAAC;AAGK,IAAM,YAAY,GAAlB,MAAM,YAAa,SAAQ,kDAAuB;CAAG,CAAA;AAA/C,oCAAY;uBAAZ,YAAY;IADxB,IAAA,eAAM,EAAC,EAAE,SAAS,EAAE,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,CAAC,cAAc,CAAC,EAAE,CAAC;GACtD,YAAY,CAAmC"}
+{"version":3,"file":"mailer.module.js","sourceRoot":"","sources":["../src/mailer.module.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA2E;AAC3E,2CAA6C;AAC7C,mEAA2C;AAE3C,yEAKoC;AAGpC,MAAM,cAAc,GAAqB;IACvC,OAAO,EAAE,gBAAM;IACf,MAAM,EAAE,CAAC,+CAAoB,CAAC;IAC9B,UAAU,EAAE,CAAC,OAA4B,EAAE,EAAE,CAAC,IAAA,4BAAe,EAAC,OAAO,CAAC;CACvE,CAAC;AAEF;;;;;;GAMG;AAEI,IAAM,YAAY,GAAlB,MAAM,YAAa,SAAQ,kDAAuB;IACvD;;;;OAIG;IACH,MAAM,CAAU,QAAQ,CAAC,OAA4B;QACnD,OAAO,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAU,aAAa,CAC3B,OAAkC;QAElC,OAAO,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;CACF,CAAA;AApBY,oCAAY;uBAAZ,YAAY;IADxB,IAAA,eAAM,EAAC,EAAE,SAAS,EAAE,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,CAAC,cAAc,CAAC,EAAE,CAAC;GACtD,YAAY,CAoBxB"}