@forinda/kickjs-mailer 1.3.2 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,28 @@
1
+ import { type AppAdapter, type Container } from '@forinda/kickjs-core';
2
+ import type { MailerOptions } from './types';
3
+ /**
4
+ * Mailer adapter — registers MailerService in the DI container.
5
+ *
6
+ * @example
7
+ * ```ts
8
+ * import { MailerAdapter, SmtpProvider } from '@forinda/kickjs-mailer'
9
+ *
10
+ * bootstrap({
11
+ * adapters: [
12
+ * new MailerAdapter({
13
+ * provider: new SmtpProvider({ host: 'smtp.gmail.com', port: 587, auth: { ... } }),
14
+ * defaultFrom: { name: 'My App', address: 'noreply@myapp.com' },
15
+ * }),
16
+ * ],
17
+ * })
18
+ * ```
19
+ */
20
+ export declare class MailerAdapter implements AppAdapter {
21
+ private options;
22
+ name: string;
23
+ private mailer;
24
+ constructor(options: MailerOptions);
25
+ afterStart(_server: any, container: Container): void;
26
+ shutdown(): Promise<void>;
27
+ }
28
+ //# sourceMappingURL=adapter.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,KAAK,UAAU,EAAE,KAAK,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAE9E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAI5C;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,aAAc,YAAW,UAAU;IAIlC,OAAO,CAAC,OAAO;IAH3B,IAAI,SAAkB;IACtB,OAAO,CAAC,MAAM,CAAe;gBAET,OAAO,EAAE,aAAa;IAI1C,UAAU,CAAC,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,GAAG,IAAI;IAO9C,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;CAIhC"}
package/dist/index.d.ts CHANGED
@@ -1,273 +1,6 @@
1
- import { AppAdapter, Container } from '@forinda/kickjs-core';
2
-
3
- interface MailAddress {
4
- name?: string;
5
- address: string;
6
- }
7
- type MailRecipient = string | MailAddress;
8
- interface MailAttachment {
9
- filename: string;
10
- content?: string | Buffer;
11
- path?: string;
12
- contentType?: string;
13
- encoding?: string;
14
- }
15
- interface MailMessage {
16
- /** Sender address */
17
- from?: MailRecipient;
18
- /** Recipient(s) */
19
- to: MailRecipient | MailRecipient[];
20
- /** CC recipient(s) */
21
- cc?: MailRecipient | MailRecipient[];
22
- /** BCC recipient(s) */
23
- bcc?: MailRecipient | MailRecipient[];
24
- /** Reply-to address */
25
- replyTo?: MailRecipient;
26
- /** Email subject */
27
- subject: string;
28
- /** Plain text body */
29
- text?: string;
30
- /** HTML body */
31
- html?: string;
32
- /** File attachments */
33
- attachments?: MailAttachment[];
34
- /** Custom headers */
35
- headers?: Record<string, string>;
36
- /** Provider-specific options (e.g. Resend tags, SES configuration set) */
37
- metadata?: Record<string, any>;
38
- }
39
- interface MailResult {
40
- /** Provider-assigned message ID */
41
- messageId: string;
42
- /** Whether the send was accepted (does not guarantee delivery) */
43
- accepted: boolean;
44
- /** Raw response from the provider */
45
- raw?: any;
46
- }
47
- /**
48
- * Template engine for rendering email bodies.
49
- * Implement this to use EJS, Handlebars, Pug, or any template system.
50
- *
51
- * @example
52
- * ```ts
53
- * import Handlebars from 'handlebars'
54
- *
55
- * class HandlebarsEngine implements MailTemplateEngine {
56
- * private templates = new Map<string, HandlebarsTemplateDelegate>()
57
- *
58
- * register(name: string, source: string) {
59
- * this.templates.set(name, Handlebars.compile(source))
60
- * }
61
- *
62
- * async render(template: string, data: any) {
63
- * const fn = this.templates.get(template)
64
- * if (!fn) throw new Error(`Template "${template}" not found`)
65
- * return fn(data)
66
- * }
67
- * }
68
- * ```
69
- */
70
- interface MailTemplateEngine {
71
- /** Render a named template with data. Returns HTML string. */
72
- render(template: string, data: Record<string, any>): Promise<string> | string;
73
- }
74
- /**
75
- * Abstract mail provider. Implement this to use any email service:
76
- * SMTP (nodemailer), Resend, AWS SES, SendGrid, Postmark, Mailgun, etc.
77
- *
78
- * @example
79
- * ```ts
80
- * class ResendProvider implements MailProvider {
81
- * name = 'resend'
82
- * private client: Resend
83
- *
84
- * constructor(apiKey: string) {
85
- * this.client = new Resend(apiKey)
86
- * }
87
- *
88
- * async send(message: MailMessage): Promise<MailResult> {
89
- * const { data, error } = await this.client.emails.send({
90
- * from: formatAddress(message.from),
91
- * to: formatRecipients(message.to),
92
- * subject: message.subject,
93
- * html: message.html,
94
- * text: message.text,
95
- * })
96
- * if (error) throw error
97
- * return { messageId: data.id, accepted: true, raw: data }
98
- * }
99
- * }
100
- * ```
101
- */
102
- interface MailProvider {
103
- /** Provider name for logging */
104
- name: string;
105
- /** Send an email message */
106
- send(message: MailMessage): Promise<MailResult>;
107
- /** Optional cleanup (close connections, etc.) */
108
- shutdown?(): Promise<void>;
109
- }
110
- interface MailerOptions {
111
- /** Mail provider to use */
112
- provider: MailProvider;
113
- /** Default "from" address for all emails */
114
- defaultFrom?: MailRecipient;
115
- /** Optional template engine for rendering HTML from templates */
116
- templateEngine?: MailTemplateEngine;
117
- /** Enable/disable sending (useful for testing — logs instead of sending) */
118
- enabled?: boolean;
119
- }
120
-
121
- /** DI token for resolving MailerService from the container */
122
- declare const MAILER: unique symbol;
123
- /**
124
- * Central mail service — send emails through any provider.
125
- *
126
- * @example
127
- * ```ts
128
- * @Service()
129
- * class UserService {
130
- * constructor(@Inject(MAILER) private mailer: MailerService) {}
131
- *
132
- * async sendWelcome(user: User) {
133
- * await this.mailer.send({
134
- * to: user.email,
135
- * subject: 'Welcome!',
136
- * html: '<h1>Welcome to our app</h1>',
137
- * })
138
- * }
139
- *
140
- * // Or with templates:
141
- * async sendInvoice(user: User, invoice: Invoice) {
142
- * await this.mailer.sendTemplate('invoice', {
143
- * to: user.email,
144
- * subject: `Invoice #${invoice.number}`,
145
- * }, { user, invoice })
146
- * }
147
- * }
148
- * ```
149
- */
150
- declare class MailerService {
151
- private provider;
152
- private defaultFrom?;
153
- private templateEngine?;
154
- private enabled;
155
- constructor(options: MailerOptions);
156
- /**
157
- * Send an email message.
158
- * Applies defaultFrom if no from address is set.
159
- */
160
- send(message: MailMessage): Promise<MailResult>;
161
- /**
162
- * Render a template and send the resulting HTML as an email.
163
- * Requires a templateEngine to be configured.
164
- *
165
- * @param template - Template name (resolved by the engine)
166
- * @param message - Mail message (html will be overwritten by the rendered template)
167
- * @param data - Template variables
168
- */
169
- sendTemplate(template: string, message: Omit<MailMessage, 'html'>, data: Record<string, any>): Promise<MailResult>;
170
- /** Get the underlying provider (for advanced use) */
171
- getProvider(): MailProvider;
172
- /** Shutdown the provider */
173
- shutdown(): Promise<void>;
174
- }
175
-
176
- /**
177
- * Mailer adapter — registers MailerService in the DI container.
178
- *
179
- * @example
180
- * ```ts
181
- * import { MailerAdapter, SmtpProvider } from '@forinda/kickjs-mailer'
182
- *
183
- * bootstrap({
184
- * adapters: [
185
- * new MailerAdapter({
186
- * provider: new SmtpProvider({ host: 'smtp.gmail.com', port: 587, auth: { ... } }),
187
- * defaultFrom: { name: 'My App', address: 'noreply@myapp.com' },
188
- * }),
189
- * ],
190
- * })
191
- * ```
192
- */
193
- declare class MailerAdapter implements AppAdapter {
194
- private options;
195
- name: string;
196
- private mailer;
197
- constructor(options: MailerOptions);
198
- afterStart(_server: any, container: Container): void;
199
- shutdown(): Promise<void>;
200
- }
201
-
202
- interface SmtpOptions {
203
- /** SMTP host (e.g. 'smtp.gmail.com', 'smtp.resend.com') */
204
- host: string;
205
- /** SMTP port (default: 587) */
206
- port?: number;
207
- /** Use TLS (default: true for port 465, false otherwise) */
208
- secure?: boolean;
209
- /** Authentication credentials */
210
- auth?: {
211
- user: string;
212
- pass: string;
213
- };
214
- /** Connection timeout in ms (default: 10000) */
215
- connectionTimeout?: number;
216
- }
217
- /**
218
- * SMTP mail provider using nodemailer.
219
- *
220
- * Requires `nodemailer` as a peer dependency:
221
- * ```bash
222
- * pnpm add nodemailer @types/nodemailer
223
- * ```
224
- *
225
- * @example
226
- * ```ts
227
- * // Gmail
228
- * new SmtpProvider({
229
- * host: 'smtp.gmail.com',
230
- * port: 587,
231
- * auth: { user: 'you@gmail.com', pass: 'app-password' },
232
- * })
233
- *
234
- * // Resend via SMTP
235
- * new SmtpProvider({
236
- * host: 'smtp.resend.com',
237
- * port: 465,
238
- * secure: true,
239
- * auth: { user: 'resend', pass: process.env.RESEND_API_KEY! },
240
- * })
241
- *
242
- * // Mailpit (local dev)
243
- * new SmtpProvider({ host: 'localhost', port: 1025 })
244
- * ```
245
- */
246
- declare class SmtpProvider implements MailProvider {
247
- private options;
248
- name: string;
249
- private transporter;
250
- constructor(options: SmtpOptions);
251
- private ensureTransporter;
252
- send(message: MailMessage): Promise<MailResult>;
253
- shutdown(): Promise<void>;
254
- }
255
-
256
- /**
257
- * Console mail provider — logs emails instead of sending them.
258
- * Perfect for development and testing.
259
- *
260
- * @example
261
- * ```ts
262
- * new MailerAdapter({
263
- * provider: new ConsoleProvider(),
264
- * defaultFrom: 'dev@localhost',
265
- * })
266
- * ```
267
- */
268
- declare class ConsoleProvider implements MailProvider {
269
- name: string;
270
- send(message: MailMessage): Promise<MailResult>;
271
- }
272
-
273
- export { ConsoleProvider, MAILER, type MailAddress, type MailAttachment, type MailMessage, type MailProvider, type MailRecipient, type MailResult, type MailTemplateEngine, MailerAdapter, type MailerOptions, MailerService, type SmtpOptions, SmtpProvider };
1
+ import 'reflect-metadata';
2
+ export { type MailProvider, type MailMessage, type MailResult, type MailAddress, type MailRecipient, type MailAttachment, type MailTemplateEngine, type MailerOptions, } from './types';
3
+ export { MailerService, MAILER } from './mailer.service';
4
+ export { MailerAdapter } from './adapter';
5
+ export { SmtpProvider, ConsoleProvider, type SmtpOptions } from './providers';
6
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAA;AAGzB,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,WAAW,EAChB,KAAK,UAAU,EACf,KAAK,WAAW,EAChB,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,kBAAkB,EACvB,KAAK,aAAa,GACnB,MAAM,SAAS,CAAA;AAGhB,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAA;AAGxD,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AAGzC,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,KAAK,WAAW,EAAE,MAAM,aAAa,CAAA"}
package/dist/index.js CHANGED
@@ -1 +1,126 @@
1
- var w=Object.defineProperty;var o=(r,t)=>w(r,"name",{value:t,configurable:!0});import"reflect-metadata";import{Logger as b}from"@forinda/kickjs-core";var u=b.for("Mailer"),d=Symbol("MailerService"),a=class{static{o(this,"MailerService")}provider;defaultFrom;templateEngine;enabled;constructor(t){this.provider=t.provider,this.defaultFrom=t.defaultFrom,this.templateEngine=t.templateEngine,this.enabled=t.enabled??!0}async send(t){let e={...t};if(!e.from&&this.defaultFrom&&(e.from=this.defaultFrom),!this.enabled)return u.info(`[dry-run] \u2192 ${h(e.to)} | ${e.subject}`),{messageId:"dry-run",accepted:!0};try{let i=await this.provider.send(e);return u.info(`Sent \u2192 ${h(e.to)} | ${e.subject} [${i.messageId}]`),i}catch(i){throw u.error({err:i},`Failed \u2192 ${h(e.to)} | ${e.subject}`),i}}async sendTemplate(t,e,i){if(!this.templateEngine)throw new Error("MailerService: templateEngine is required for sendTemplate(). Pass one in MailerOptions or use send() with raw HTML.");let s=await this.templateEngine.render(t,i);return this.send({...e,html:s})}getProvider(){return this.provider}async shutdown(){this.provider.shutdown&&await this.provider.shutdown()}};function h(r){return Array.isArray(r)?r.map(t=>typeof t=="string"?t:t.address).join(", "):typeof r=="string"?r:r.address}o(h,"formatRecipient");import{Logger as v}from"@forinda/kickjs-core";var $=v.for("MailerAdapter"),m=class{static{o(this,"MailerAdapter")}options;name="MailerAdapter";mailer;constructor(t){this.options=t,this.mailer=new a(t)}afterStart(t,e){e.registerInstance(d,this.mailer),$.info(`Mail provider: ${this.options.provider.name}${this.options.enabled===!1?" (disabled)":""}`)}async shutdown(){await this.mailer.shutdown(),$.info("Mailer shut down")}};var c=class{static{o(this,"SmtpProvider")}options;name="smtp";transporter;constructor(t){this.options=t}async ensureTransporter(){if(!this.transporter)try{let t=await import("nodemailer"),e=t.createTransport??t.default?.createTransport;this.transporter=e({host:this.options.host,port:this.options.port??587,secure:this.options.secure??this.options.port===465,auth:this.options.auth,connectionTimeout:this.options.connectionTimeout??1e4})}catch{throw new Error('SmtpProvider requires "nodemailer" package. Install: pnpm add nodemailer')}}async send(t){await this.ensureTransporter();let e=await this.transporter.sendMail({from:f(t.from),to:y(t.to),cc:t.cc?y(t.cc):void 0,bcc:t.bcc?y(t.bcc):void 0,replyTo:t.replyTo?f(t.replyTo):void 0,subject:t.subject,text:t.text,html:t.html,attachments:t.attachments,headers:t.headers});return{messageId:e.messageId,accepted:(e.accepted?.length??0)>0,raw:e}}async shutdown(){this.transporter&&this.transporter.close()}};function f(r){if(r)return typeof r=="string"?r:r.name?`"${r.name}" <${r.address}>`:r.address}o(f,"formatAddress");function y(r){return r?typeof r=="string"?r:Array.isArray(r)?r.map(t=>f(t)).join(", "):f(r)??"":""}o(y,"formatRecipients");import{Logger as x}from"@forinda/kickjs-core";var n=x.for("ConsoleMail"),A=0,l=class{static{o(this,"ConsoleProvider")}name="console";async send(t){let e=`console-${++A}`,i=Array.isArray(t.to)?t.to.map(s=>typeof s=="string"?s:s.address).join(", "):typeof t.to=="string"?t.to:t.to.address;return n.info("\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500"),n.info(`From: ${p(t.from)}`),n.info(`To: ${i}`),t.cc&&n.info(`CC: ${p(t.cc)}`),t.bcc&&n.info(`BCC: ${p(t.bcc)}`),n.info(`Subject: ${t.subject}`),t.text&&n.info(`Text: ${t.text.slice(0,200)}${t.text.length>200?"...":""}`),t.html&&n.info(`HTML: ${t.html.slice(0,200)}${t.html.length>200?"...":""}`),t.attachments?.length&&n.info(`Attach: ${t.attachments.map(s=>s.filename).join(", ")}`),n.info(`ID: ${e}`),n.info("\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500"),{messageId:e,accepted:!0}}};function p(r){return r?typeof r=="string"?r:Array.isArray(r)?r.map(p).join(", "):r.name?`"${r.name}" <${r.address}>`:r.address:"(none)"}o(p,"formatAddr");export{l as ConsoleProvider,d as MAILER,m as MailerAdapter,a as MailerService,c as SmtpProvider};
1
+ import "reflect-metadata";
2
+ import { Logger as f } from "@forinda/kickjs-core";
3
+ var s = f.for("Mailer"), p = /* @__PURE__ */ Symbol("MailerService"), u = class {
4
+ provider;
5
+ defaultFrom;
6
+ templateEngine;
7
+ enabled;
8
+ constructor(t) {
9
+ this.provider = t.provider, this.defaultFrom = t.defaultFrom, this.templateEngine = t.templateEngine, this.enabled = t.enabled ?? !0;
10
+ }
11
+ async send(t) {
12
+ const r = { ...t };
13
+ if (!r.from && this.defaultFrom && (r.from = this.defaultFrom), !this.enabled)
14
+ return s.info(`[dry-run] → ${c(r.to)} | ${r.subject}`), {
15
+ messageId: "dry-run",
16
+ accepted: !0
17
+ };
18
+ try {
19
+ const n = await this.provider.send(r);
20
+ return s.info(`Sent → ${c(r.to)} | ${r.subject} [${n.messageId}]`), n;
21
+ } catch (n) {
22
+ throw s.error({ err: n }, `Failed → ${c(r.to)} | ${r.subject}`), n;
23
+ }
24
+ }
25
+ async sendTemplate(t, r, n) {
26
+ if (!this.templateEngine) throw new Error("MailerService: templateEngine is required for sendTemplate(). Pass one in MailerOptions or use send() with raw HTML.");
27
+ const o = await this.templateEngine.render(t, n);
28
+ return this.send({
29
+ ...r,
30
+ html: o
31
+ });
32
+ }
33
+ getProvider() {
34
+ return this.provider;
35
+ }
36
+ async shutdown() {
37
+ this.provider.shutdown && await this.provider.shutdown();
38
+ }
39
+ };
40
+ function c(t) {
41
+ return Array.isArray(t) ? t.map((r) => typeof r == "string" ? r : r.address).join(", ") : typeof t == "string" ? t : t.address;
42
+ }
43
+ var h = f.for("MailerAdapter"), v = class {
44
+ name = "MailerAdapter";
45
+ mailer;
46
+ constructor(t) {
47
+ this.options = t, this.mailer = new u(t);
48
+ }
49
+ afterStart(t, r) {
50
+ r.registerInstance(p, this.mailer), h.info(`Mail provider: ${this.options.provider.name}${this.options.enabled === !1 ? " (disabled)" : ""}`);
51
+ }
52
+ async shutdown() {
53
+ await this.mailer.shutdown(), h.info("Mailer shut down");
54
+ }
55
+ }, $ = class {
56
+ name = "smtp";
57
+ transporter;
58
+ constructor(t) {
59
+ this.options = t;
60
+ }
61
+ async ensureTransporter() {
62
+ if (!this.transporter)
63
+ try {
64
+ const t = await import("nodemailer");
65
+ this.transporter = (t.createTransport ?? t.default?.createTransport)({
66
+ host: this.options.host,
67
+ port: this.options.port ?? 587,
68
+ secure: this.options.secure ?? this.options.port === 465,
69
+ auth: this.options.auth,
70
+ connectionTimeout: this.options.connectionTimeout ?? 1e4
71
+ });
72
+ } catch {
73
+ throw new Error('SmtpProvider requires "nodemailer" package. Install: pnpm add nodemailer');
74
+ }
75
+ }
76
+ async send(t) {
77
+ await this.ensureTransporter();
78
+ const r = await this.transporter.sendMail({
79
+ from: a(t.from),
80
+ to: l(t.to),
81
+ cc: t.cc ? l(t.cc) : void 0,
82
+ bcc: t.bcc ? l(t.bcc) : void 0,
83
+ replyTo: t.replyTo ? a(t.replyTo) : void 0,
84
+ subject: t.subject,
85
+ text: t.text,
86
+ html: t.html,
87
+ attachments: t.attachments,
88
+ headers: t.headers
89
+ });
90
+ return {
91
+ messageId: r.messageId,
92
+ accepted: (r.accepted?.length ?? 0) > 0,
93
+ raw: r
94
+ };
95
+ }
96
+ async shutdown() {
97
+ this.transporter && this.transporter.close();
98
+ }
99
+ };
100
+ function a(t) {
101
+ if (t)
102
+ return typeof t == "string" ? t : t.name ? `"${t.name}" <${t.address}>` : t.address;
103
+ }
104
+ function l(t) {
105
+ return t ? typeof t == "string" ? t : Array.isArray(t) ? t.map((r) => a(r)).join(", ") : a(t) ?? "" : "";
106
+ }
107
+ var e = f.for("ConsoleMail"), d = 0, w = class {
108
+ name = "console";
109
+ async send(t) {
110
+ const r = `console-${++d}`, n = Array.isArray(t.to) ? t.to.map((o) => typeof o == "string" ? o : o.address).join(", ") : typeof t.to == "string" ? t.to : t.to.address;
111
+ return e.info("────────────────────────────────────────"), e.info(`From: ${i(t.from)}`), e.info(`To: ${n}`), t.cc && e.info(`CC: ${i(t.cc)}`), t.bcc && e.info(`BCC: ${i(t.bcc)}`), e.info(`Subject: ${t.subject}`), t.text && e.info(`Text: ${t.text.slice(0, 200)}${t.text.length > 200 ? "..." : ""}`), t.html && e.info(`HTML: ${t.html.slice(0, 200)}${t.html.length > 200 ? "..." : ""}`), t.attachments?.length && e.info(`Attach: ${t.attachments.map((o) => o.filename).join(", ")}`), e.info(`ID: ${r}`), e.info("────────────────────────────────────────"), {
112
+ messageId: r,
113
+ accepted: !0
114
+ };
115
+ }
116
+ };
117
+ function i(t) {
118
+ return t ? typeof t == "string" ? t : Array.isArray(t) ? t.map(i).join(", ") : t.name ? `"${t.name}" <${t.address}>` : t.address : "(none)";
119
+ }
120
+ export {
121
+ w as ConsoleProvider,
122
+ p as MAILER,
123
+ v as MailerAdapter,
124
+ u as MailerService,
125
+ $ as SmtpProvider
126
+ };
@@ -0,0 +1,56 @@
1
+ import type { MailProvider, MailMessage, MailResult, MailerOptions } from './types';
2
+ /** DI token for resolving MailerService from the container */
3
+ export declare const MAILER: unique symbol;
4
+ /**
5
+ * Central mail service — send emails through any provider.
6
+ *
7
+ * @example
8
+ * ```ts
9
+ * @Service()
10
+ * class UserService {
11
+ * constructor(@Inject(MAILER) private mailer: MailerService) {}
12
+ *
13
+ * async sendWelcome(user: User) {
14
+ * await this.mailer.send({
15
+ * to: user.email,
16
+ * subject: 'Welcome!',
17
+ * html: '<h1>Welcome to our app</h1>',
18
+ * })
19
+ * }
20
+ *
21
+ * // Or with templates:
22
+ * async sendInvoice(user: User, invoice: Invoice) {
23
+ * await this.mailer.sendTemplate('invoice', {
24
+ * to: user.email,
25
+ * subject: `Invoice #${invoice.number}`,
26
+ * }, { user, invoice })
27
+ * }
28
+ * }
29
+ * ```
30
+ */
31
+ export declare class MailerService {
32
+ private provider;
33
+ private defaultFrom?;
34
+ private templateEngine?;
35
+ private enabled;
36
+ constructor(options: MailerOptions);
37
+ /**
38
+ * Send an email message.
39
+ * Applies defaultFrom if no from address is set.
40
+ */
41
+ send(message: MailMessage): Promise<MailResult>;
42
+ /**
43
+ * Render a template and send the resulting HTML as an email.
44
+ * Requires a templateEngine to be configured.
45
+ *
46
+ * @param template - Template name (resolved by the engine)
47
+ * @param message - Mail message (html will be overwritten by the rendered template)
48
+ * @param data - Template variables
49
+ */
50
+ sendTemplate(template: string, message: Omit<MailMessage, 'html'>, data: Record<string, any>): Promise<MailResult>;
51
+ /** Get the underlying provider (for advanced use) */
52
+ getProvider(): MailProvider;
53
+ /** Shutdown the provider */
54
+ shutdown(): Promise<void>;
55
+ }
56
+ //# sourceMappingURL=mailer.service.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"mailer.service.d.ts","sourceRoot":"","sources":["../src/mailer.service.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,YAAY,EACZ,WAAW,EACX,UAAU,EAGV,aAAa,EACd,MAAM,SAAS,CAAA;AAIhB,8DAA8D;AAC9D,eAAO,MAAM,MAAM,eAA0B,CAAA;AAE7C;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAc;IAC9B,OAAO,CAAC,WAAW,CAAC,CAAe;IACnC,OAAO,CAAC,cAAc,CAAC,CAAoB;IAC3C,OAAO,CAAC,OAAO,CAAS;gBAEZ,OAAO,EAAE,aAAa;IAOlC;;;OAGG;IACG,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC;IAuBrD;;;;;;;OAOG;IACG,YAAY,CAChB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,EAClC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACxB,OAAO,CAAC,UAAU,CAAC;IAYtB,qDAAqD;IACrD,WAAW,IAAI,YAAY;IAI3B,4BAA4B;IACtB,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;CAKhC"}
@@ -0,0 +1,18 @@
1
+ import type { MailProvider, MailMessage, MailResult } from '../types';
2
+ /**
3
+ * Console mail provider — logs emails instead of sending them.
4
+ * Perfect for development and testing.
5
+ *
6
+ * @example
7
+ * ```ts
8
+ * new MailerAdapter({
9
+ * provider: new ConsoleProvider(),
10
+ * defaultFrom: 'dev@localhost',
11
+ * })
12
+ * ```
13
+ */
14
+ export declare class ConsoleProvider implements MailProvider {
15
+ name: string;
16
+ send(message: MailMessage): Promise<MailResult>;
17
+ }
18
+ //# sourceMappingURL=console.provider.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"console.provider.d.ts","sourceRoot":"","sources":["../../src/providers/console.provider.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAMrE;;;;;;;;;;;GAWG;AACH,qBAAa,eAAgB,YAAW,YAAY;IAClD,IAAI,SAAY;IAEV,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC;CA0BtD"}
@@ -0,0 +1,3 @@
1
+ export { SmtpProvider, type SmtpOptions } from './smtp.provider';
2
+ export { ConsoleProvider } from './console.provider';
3
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/providers/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,KAAK,WAAW,EAAE,MAAM,iBAAiB,CAAA;AAChE,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA"}
@@ -0,0 +1,55 @@
1
+ import type { MailProvider, MailMessage, MailResult } from '../types';
2
+ export interface SmtpOptions {
3
+ /** SMTP host (e.g. 'smtp.gmail.com', 'smtp.resend.com') */
4
+ host: string;
5
+ /** SMTP port (default: 587) */
6
+ port?: number;
7
+ /** Use TLS (default: true for port 465, false otherwise) */
8
+ secure?: boolean;
9
+ /** Authentication credentials */
10
+ auth?: {
11
+ user: string;
12
+ pass: string;
13
+ };
14
+ /** Connection timeout in ms (default: 10000) */
15
+ connectionTimeout?: number;
16
+ }
17
+ /**
18
+ * SMTP mail provider using nodemailer.
19
+ *
20
+ * Requires `nodemailer` as a peer dependency:
21
+ * ```bash
22
+ * pnpm add nodemailer @types/nodemailer
23
+ * ```
24
+ *
25
+ * @example
26
+ * ```ts
27
+ * // Gmail
28
+ * new SmtpProvider({
29
+ * host: 'smtp.gmail.com',
30
+ * port: 587,
31
+ * auth: { user: 'you@gmail.com', pass: 'app-password' },
32
+ * })
33
+ *
34
+ * // Resend via SMTP
35
+ * new SmtpProvider({
36
+ * host: 'smtp.resend.com',
37
+ * port: 465,
38
+ * secure: true,
39
+ * auth: { user: 'resend', pass: process.env.RESEND_API_KEY! },
40
+ * })
41
+ *
42
+ * // Mailpit (local dev)
43
+ * new SmtpProvider({ host: 'localhost', port: 1025 })
44
+ * ```
45
+ */
46
+ export declare class SmtpProvider implements MailProvider {
47
+ private options;
48
+ name: string;
49
+ private transporter;
50
+ constructor(options: SmtpOptions);
51
+ private ensureTransporter;
52
+ send(message: MailMessage): Promise<MailResult>;
53
+ shutdown(): Promise<void>;
54
+ }
55
+ //# sourceMappingURL=smtp.provider.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"smtp.provider.d.ts","sourceRoot":"","sources":["../../src/providers/smtp.provider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAErE,MAAM,WAAW,WAAW;IAC1B,2DAA2D;IAC3D,IAAI,EAAE,MAAM,CAAA;IACZ,+BAA+B;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,4DAA4D;IAC5D,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,iCAAiC;IACjC,IAAI,CAAC,EAAE;QACL,IAAI,EAAE,MAAM,CAAA;QACZ,IAAI,EAAE,MAAM,CAAA;KACb,CAAA;IACD,gDAAgD;IAChD,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC3B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,qBAAa,YAAa,YAAW,YAAY;IAInC,OAAO,CAAC,OAAO;IAH3B,IAAI,SAAS;IACb,OAAO,CAAC,WAAW,CAAK;gBAEJ,OAAO,EAAE,WAAW;YAE1B,iBAAiB;IAiBzB,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC;IAuB/C,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;CAKhC"}
@@ -0,0 +1,118 @@
1
+ export interface MailAddress {
2
+ name?: string;
3
+ address: string;
4
+ }
5
+ export type MailRecipient = string | MailAddress;
6
+ export interface MailAttachment {
7
+ filename: string;
8
+ content?: string | Buffer;
9
+ path?: string;
10
+ contentType?: string;
11
+ encoding?: string;
12
+ }
13
+ export interface MailMessage {
14
+ /** Sender address */
15
+ from?: MailRecipient;
16
+ /** Recipient(s) */
17
+ to: MailRecipient | MailRecipient[];
18
+ /** CC recipient(s) */
19
+ cc?: MailRecipient | MailRecipient[];
20
+ /** BCC recipient(s) */
21
+ bcc?: MailRecipient | MailRecipient[];
22
+ /** Reply-to address */
23
+ replyTo?: MailRecipient;
24
+ /** Email subject */
25
+ subject: string;
26
+ /** Plain text body */
27
+ text?: string;
28
+ /** HTML body */
29
+ html?: string;
30
+ /** File attachments */
31
+ attachments?: MailAttachment[];
32
+ /** Custom headers */
33
+ headers?: Record<string, string>;
34
+ /** Provider-specific options (e.g. Resend tags, SES configuration set) */
35
+ metadata?: Record<string, any>;
36
+ }
37
+ export interface MailResult {
38
+ /** Provider-assigned message ID */
39
+ messageId: string;
40
+ /** Whether the send was accepted (does not guarantee delivery) */
41
+ accepted: boolean;
42
+ /** Raw response from the provider */
43
+ raw?: any;
44
+ }
45
+ /**
46
+ * Template engine for rendering email bodies.
47
+ * Implement this to use EJS, Handlebars, Pug, or any template system.
48
+ *
49
+ * @example
50
+ * ```ts
51
+ * import Handlebars from 'handlebars'
52
+ *
53
+ * class HandlebarsEngine implements MailTemplateEngine {
54
+ * private templates = new Map<string, HandlebarsTemplateDelegate>()
55
+ *
56
+ * register(name: string, source: string) {
57
+ * this.templates.set(name, Handlebars.compile(source))
58
+ * }
59
+ *
60
+ * async render(template: string, data: any) {
61
+ * const fn = this.templates.get(template)
62
+ * if (!fn) throw new Error(`Template "${template}" not found`)
63
+ * return fn(data)
64
+ * }
65
+ * }
66
+ * ```
67
+ */
68
+ export interface MailTemplateEngine {
69
+ /** Render a named template with data. Returns HTML string. */
70
+ render(template: string, data: Record<string, any>): Promise<string> | string;
71
+ }
72
+ /**
73
+ * Abstract mail provider. Implement this to use any email service:
74
+ * SMTP (nodemailer), Resend, AWS SES, SendGrid, Postmark, Mailgun, etc.
75
+ *
76
+ * @example
77
+ * ```ts
78
+ * class ResendProvider implements MailProvider {
79
+ * name = 'resend'
80
+ * private client: Resend
81
+ *
82
+ * constructor(apiKey: string) {
83
+ * this.client = new Resend(apiKey)
84
+ * }
85
+ *
86
+ * async send(message: MailMessage): Promise<MailResult> {
87
+ * const { data, error } = await this.client.emails.send({
88
+ * from: formatAddress(message.from),
89
+ * to: formatRecipients(message.to),
90
+ * subject: message.subject,
91
+ * html: message.html,
92
+ * text: message.text,
93
+ * })
94
+ * if (error) throw error
95
+ * return { messageId: data.id, accepted: true, raw: data }
96
+ * }
97
+ * }
98
+ * ```
99
+ */
100
+ export interface MailProvider {
101
+ /** Provider name for logging */
102
+ name: string;
103
+ /** Send an email message */
104
+ send(message: MailMessage): Promise<MailResult>;
105
+ /** Optional cleanup (close connections, etc.) */
106
+ shutdown?(): Promise<void>;
107
+ }
108
+ export interface MailerOptions {
109
+ /** Mail provider to use */
110
+ provider: MailProvider;
111
+ /** Default "from" address for all emails */
112
+ defaultFrom?: MailRecipient;
113
+ /** Optional template engine for rendering HTML from templates */
114
+ templateEngine?: MailTemplateEngine;
115
+ /** Enable/disable sending (useful for testing — logs instead of sending) */
116
+ enabled?: boolean;
117
+ }
118
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,WAAW;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,WAAW,CAAA;AAEhD,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACzB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,WAAW;IAC1B,qBAAqB;IACrB,IAAI,CAAC,EAAE,aAAa,CAAA;IACpB,mBAAmB;IACnB,EAAE,EAAE,aAAa,GAAG,aAAa,EAAE,CAAA;IACnC,sBAAsB;IACtB,EAAE,CAAC,EAAE,aAAa,GAAG,aAAa,EAAE,CAAA;IACpC,uBAAuB;IACvB,GAAG,CAAC,EAAE,aAAa,GAAG,aAAa,EAAE,CAAA;IACrC,uBAAuB;IACvB,OAAO,CAAC,EAAE,aAAa,CAAA;IACvB,oBAAoB;IACpB,OAAO,EAAE,MAAM,CAAA;IACf,sBAAsB;IACtB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,gBAAgB;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,uBAAuB;IACvB,WAAW,CAAC,EAAE,cAAc,EAAE,CAAA;IAC9B,qBAAqB;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,0EAA0E;IAC1E,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,UAAU;IACzB,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAA;IACjB,kEAAkE;IAClE,QAAQ,EAAE,OAAO,CAAA;IACjB,qCAAqC;IACrC,GAAG,CAAC,EAAE,GAAG,CAAA;CACV;AAID;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,kBAAkB;IACjC,8DAA8D;IAC9D,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAA;CAC9E;AAID;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,WAAW,YAAY;IAC3B,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAA;IAEZ,4BAA4B;IAC5B,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAE/C,iDAAiD;IACjD,QAAQ,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CAC3B;AAID,MAAM,WAAW,aAAa;IAC5B,2BAA2B;IAC3B,QAAQ,EAAE,YAAY,CAAA;IAEtB,4CAA4C;IAC5C,WAAW,CAAC,EAAE,aAAa,CAAA;IAE3B,iEAAiE;IACjE,cAAc,CAAC,EAAE,kBAAkB,CAAA;IAEnC,4EAA4E;IAC5E,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@forinda/kickjs-mailer",
3
- "version": "1.3.2",
3
+ "version": "1.4.0",
4
4
  "description": "Pluggable email sending for KickJS — nodemailer, Resend, SES, and custom providers",
5
5
  "keywords": [
6
6
  "kickjs",
@@ -35,7 +35,8 @@
35
35
  "@forinda/kickjs-queue",
36
36
  "@forinda/kickjs-multi-tenant",
37
37
  "@forinda/kickjs-devtools",
38
- "@forinda/kickjs-notifications"
38
+ "@forinda/kickjs-notifications",
39
+ "vite"
39
40
  ],
40
41
  "type": "module",
41
42
  "main": "dist/index.js",
@@ -51,7 +52,7 @@
51
52
  ],
52
53
  "dependencies": {
53
54
  "reflect-metadata": "^0.2.2",
54
- "@forinda/kickjs-core": "1.3.2"
55
+ "@forinda/kickjs-core": "1.4.0"
55
56
  },
56
57
  "peerDependencies": {
57
58
  "nodemailer": ">=7.0.11"
@@ -64,8 +65,7 @@
64
65
  "devDependencies": {
65
66
  "@types/node": "^24.5.2",
66
67
  "@types/nodemailer": "^7.0.11",
67
- "nodemailer": "^8.0.3",
68
- "tsup": "^8.5.0",
68
+ "nodemailer": "^8.0.4",
69
69
  "typescript": "^5.9.2",
70
70
  "vitest": "^3.2.4"
71
71
  },
@@ -87,8 +87,9 @@
87
87
  "url": "https://github.com/forinda/kick-js/issues"
88
88
  },
89
89
  "scripts": {
90
- "build": "tsup",
91
- "dev": "tsup --watch",
90
+ "build": "vite build && pnpm build:types",
91
+ "build:types": "tsc -p tsconfig.build.json",
92
+ "dev": "vite build --watch",
92
93
  "test": "vitest run",
93
94
  "typecheck": "tsc --noEmit",
94
95
  "clean": "rm -rf dist .turbo"