@nauth-toolkit/email-console 0.1.14 → 0.1.17
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.
- package/dist/console-email.provider.d.ts +72 -0
- package/dist/console-email.provider.d.ts.map +1 -1
- package/dist/console-email.provider.js +75 -0
- package/dist/console-email.provider.js.map +1 -1
- package/dist/index.d.ts +6 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +6 -0
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
|
@@ -1,12 +1,84 @@
|
|
|
1
1
|
import { EmailProvider, LoggerService } from '@nauth-toolkit/core';
|
|
2
|
+
/**
|
|
3
|
+
* Console Email Provider (Platform-Agnostic)
|
|
4
|
+
*
|
|
5
|
+
* Mock email provider that logs emails to console.
|
|
6
|
+
* Perfect for development and testing without external SMTP dependencies.
|
|
7
|
+
*
|
|
8
|
+
* This simply logs email details to the console for debugging purposes.
|
|
9
|
+
* No actual emails are sent, no templates are rendered.
|
|
10
|
+
*
|
|
11
|
+
* This is a plain TypeScript class with no framework dependencies.
|
|
12
|
+
* Works with any framework (NestJS, Express, Fastify, etc.)
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```typescript
|
|
16
|
+
* // With custom logger
|
|
17
|
+
* const emailProvider = new ConsoleEmailProvider(myLogger);
|
|
18
|
+
*
|
|
19
|
+
* // With console logger (default)
|
|
20
|
+
* const emailProvider = new ConsoleEmailProvider();
|
|
21
|
+
*
|
|
22
|
+
* AuthModule.forRoot({
|
|
23
|
+
* emailProvider: new ConsoleEmailProvider(),
|
|
24
|
+
* })
|
|
25
|
+
* ```
|
|
26
|
+
*/
|
|
2
27
|
export declare class ConsoleEmailProvider implements EmailProvider {
|
|
3
28
|
private logger;
|
|
4
29
|
constructor(logger?: LoggerService);
|
|
30
|
+
/**
|
|
31
|
+
* Set logger instance (called by AuthModule to inject NAuthLogger)
|
|
32
|
+
* @param logger - Logger instance to use
|
|
33
|
+
*/
|
|
5
34
|
setLogger(logger: LoggerService): void;
|
|
35
|
+
/**
|
|
36
|
+
* Send verification email with code and/or link
|
|
37
|
+
*
|
|
38
|
+
* Logs email details to console for debugging.
|
|
39
|
+
*
|
|
40
|
+
* @param to - Recipient email address
|
|
41
|
+
* @param code - Verification code (e.g., "123456")
|
|
42
|
+
* @param link - Optional verification link (only logged if provided)
|
|
43
|
+
*/
|
|
6
44
|
sendVerificationEmail(to: string, _code: string, _link?: string): Promise<void>;
|
|
45
|
+
/**
|
|
46
|
+
* Send password reset email with token and link
|
|
47
|
+
*
|
|
48
|
+
* Logs email details to console for debugging.
|
|
49
|
+
*
|
|
50
|
+
* @param to - Recipient email address
|
|
51
|
+
* @param token - Password reset token
|
|
52
|
+
* @param link - Password reset link (e.g., "https://example.com/reset?token=xxx")
|
|
53
|
+
*/
|
|
7
54
|
sendPasswordResetEmail(to: string, _token: string, _link: string): Promise<void>;
|
|
55
|
+
/**
|
|
56
|
+
* Send welcome email to new users
|
|
57
|
+
*
|
|
58
|
+
* Logs email details to console for debugging.
|
|
59
|
+
*
|
|
60
|
+
* @param to - Recipient email address
|
|
61
|
+
* @param name - User's name
|
|
62
|
+
*/
|
|
8
63
|
sendWelcomeEmail(to: string, name: string): Promise<void>;
|
|
64
|
+
/**
|
|
65
|
+
* Send account lockout notification
|
|
66
|
+
*
|
|
67
|
+
* Logs email details to console for debugging.
|
|
68
|
+
*
|
|
69
|
+
* @param to - Recipient email address
|
|
70
|
+
* @param reason - Lockout reason
|
|
71
|
+
* @param duration - Lockout duration in seconds
|
|
72
|
+
*/
|
|
9
73
|
sendLockoutEmail(to: string, reason: string, duration: number): Promise<void>;
|
|
74
|
+
/**
|
|
75
|
+
* Send new device login notification
|
|
76
|
+
*
|
|
77
|
+
* Logs email details to console for debugging.
|
|
78
|
+
*
|
|
79
|
+
* @param to - Recipient email address
|
|
80
|
+
* @param deviceInfo - Device information (name, type, IP, location)
|
|
81
|
+
*/
|
|
10
82
|
sendNewDeviceEmail(to: string, deviceInfo: {
|
|
11
83
|
name?: string;
|
|
12
84
|
type?: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"console-email.provider.d.ts","sourceRoot":"","sources":["../src/console-email.provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;
|
|
1
|
+
{"version":3,"file":"console-email.provider.d.ts","sourceRoot":"","sources":["../src/console-email.provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEnE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,oBAAqB,YAAW,aAAa;IACxD,OAAO,CAAC,MAAM,CAAgB;gBAElB,MAAM,CAAC,EAAE,aAAa;IAIlC;;;OAGG;IACH,SAAS,CAAC,MAAM,EAAE,aAAa,GAAG,IAAI;IAItC;;;;;;;;OAQG;IACG,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IASrF;;;;;;;;OAQG;IACG,sBAAsB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQtF;;;;;;;OAOG;IACG,gBAAgB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ/D;;;;;;;;OAQG;IACG,gBAAgB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IASnF;;;;;;;OAOG;IACG,kBAAkB,CACtB,EAAE,EAAE,MAAM,EACV,UAAU,EAAE;QACV,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,GACA,OAAO,CAAC,IAAI,CAAC;CAUjB"}
|
|
@@ -1,26 +1,84 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.ConsoleEmailProvider = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* Console Email Provider (Platform-Agnostic)
|
|
6
|
+
*
|
|
7
|
+
* Mock email provider that logs emails to console.
|
|
8
|
+
* Perfect for development and testing without external SMTP dependencies.
|
|
9
|
+
*
|
|
10
|
+
* This simply logs email details to the console for debugging purposes.
|
|
11
|
+
* No actual emails are sent, no templates are rendered.
|
|
12
|
+
*
|
|
13
|
+
* This is a plain TypeScript class with no framework dependencies.
|
|
14
|
+
* Works with any framework (NestJS, Express, Fastify, etc.)
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* ```typescript
|
|
18
|
+
* // With custom logger
|
|
19
|
+
* const emailProvider = new ConsoleEmailProvider(myLogger);
|
|
20
|
+
*
|
|
21
|
+
* // With console logger (default)
|
|
22
|
+
* const emailProvider = new ConsoleEmailProvider();
|
|
23
|
+
*
|
|
24
|
+
* AuthModule.forRoot({
|
|
25
|
+
* emailProvider: new ConsoleEmailProvider(),
|
|
26
|
+
* })
|
|
27
|
+
* ```
|
|
28
|
+
*/
|
|
4
29
|
class ConsoleEmailProvider {
|
|
5
30
|
logger;
|
|
6
31
|
constructor(logger) {
|
|
7
32
|
this.logger = logger || console;
|
|
8
33
|
}
|
|
34
|
+
/**
|
|
35
|
+
* Set logger instance (called by AuthModule to inject NAuthLogger)
|
|
36
|
+
* @param logger - Logger instance to use
|
|
37
|
+
*/
|
|
9
38
|
setLogger(logger) {
|
|
10
39
|
this.logger = logger;
|
|
11
40
|
}
|
|
41
|
+
/**
|
|
42
|
+
* Send verification email with code and/or link
|
|
43
|
+
*
|
|
44
|
+
* Logs email details to console for debugging.
|
|
45
|
+
*
|
|
46
|
+
* @param to - Recipient email address
|
|
47
|
+
* @param code - Verification code (e.g., "123456")
|
|
48
|
+
* @param link - Optional verification link (only logged if provided)
|
|
49
|
+
*/
|
|
12
50
|
async sendVerificationEmail(to, _code, _link) {
|
|
51
|
+
// NOTE: Do not log secrets (codes/links) to console.
|
|
52
|
+
// In this repo, simulated codes should be viewed via test endpoints + frontend toast.
|
|
13
53
|
this.logger.log('----------------------------------------------');
|
|
14
54
|
this.logger.log('EMAIL: One-time code sent (simulated)');
|
|
15
55
|
this.logger.log(`To: ${to}`);
|
|
16
56
|
this.logger.log('----------------------------------------------');
|
|
17
57
|
}
|
|
58
|
+
/**
|
|
59
|
+
* Send password reset email with token and link
|
|
60
|
+
*
|
|
61
|
+
* Logs email details to console for debugging.
|
|
62
|
+
*
|
|
63
|
+
* @param to - Recipient email address
|
|
64
|
+
* @param token - Password reset token
|
|
65
|
+
* @param link - Password reset link (e.g., "https://example.com/reset?token=xxx")
|
|
66
|
+
*/
|
|
18
67
|
async sendPasswordResetEmail(to, _token, _link) {
|
|
68
|
+
// NOTE: Do not log secrets (tokens/links) to console.
|
|
19
69
|
this.logger.log('----------------------------------------------');
|
|
20
70
|
this.logger.log('EMAIL: Password reset email sent (simulated)');
|
|
21
71
|
this.logger.log(`To: ${to}`);
|
|
22
72
|
this.logger.log('----------------------------------------------');
|
|
23
73
|
}
|
|
74
|
+
/**
|
|
75
|
+
* Send welcome email to new users
|
|
76
|
+
*
|
|
77
|
+
* Logs email details to console for debugging.
|
|
78
|
+
*
|
|
79
|
+
* @param to - Recipient email address
|
|
80
|
+
* @param name - User's name
|
|
81
|
+
*/
|
|
24
82
|
async sendWelcomeEmail(to, name) {
|
|
25
83
|
this.logger.log('----------------------------------------------');
|
|
26
84
|
this.logger.log('EMAIL: Welcome email sent (simulated)');
|
|
@@ -28,6 +86,15 @@ class ConsoleEmailProvider {
|
|
|
28
86
|
this.logger.log(`Name: ${name}`);
|
|
29
87
|
this.logger.log('----------------------------------------------');
|
|
30
88
|
}
|
|
89
|
+
/**
|
|
90
|
+
* Send account lockout notification
|
|
91
|
+
*
|
|
92
|
+
* Logs email details to console for debugging.
|
|
93
|
+
*
|
|
94
|
+
* @param to - Recipient email address
|
|
95
|
+
* @param reason - Lockout reason
|
|
96
|
+
* @param duration - Lockout duration in seconds
|
|
97
|
+
*/
|
|
31
98
|
async sendLockoutEmail(to, reason, duration) {
|
|
32
99
|
this.logger.warn('----------------------------------------------');
|
|
33
100
|
this.logger.warn('EMAIL: Account lockout notification (simulated)');
|
|
@@ -36,6 +103,14 @@ class ConsoleEmailProvider {
|
|
|
36
103
|
this.logger.warn(`Duration: ${Math.round(duration / 60)} minutes`);
|
|
37
104
|
this.logger.warn('----------------------------------------------');
|
|
38
105
|
}
|
|
106
|
+
/**
|
|
107
|
+
* Send new device login notification
|
|
108
|
+
*
|
|
109
|
+
* Logs email details to console for debugging.
|
|
110
|
+
*
|
|
111
|
+
* @param to - Recipient email address
|
|
112
|
+
* @param deviceInfo - Device information (name, type, IP, location)
|
|
113
|
+
*/
|
|
39
114
|
async sendNewDeviceEmail(to, deviceInfo) {
|
|
40
115
|
this.logger.log('----------------------------------------------');
|
|
41
116
|
this.logger.log('EMAIL: New device login notification (simulated)');
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"console-email.provider.js","sourceRoot":"","sources":["../src/console-email.provider.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"console-email.provider.js","sourceRoot":"","sources":["../src/console-email.provider.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAa,oBAAoB;IACvB,MAAM,CAAgB;IAE9B,YAAY,MAAsB;QAChC,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,OAAO,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,MAAqB;QAC7B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,qBAAqB,CAAC,EAAU,EAAE,KAAa,EAAE,KAAc;QACnE,qDAAqD;QACrD,sFAAsF;QACtF,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,gDAAgD,CAAC,CAAC;QAClE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAC;QACzD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAC7B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,gDAAgD,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,sBAAsB,CAAC,EAAU,EAAE,MAAc,EAAE,KAAa;QACpE,sDAAsD;QACtD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,gDAAgD,CAAC,CAAC;QAClE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,8CAA8C,CAAC,CAAC;QAChE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAC7B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,gDAAgD,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,gBAAgB,CAAC,EAAU,EAAE,IAAY;QAC7C,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,gDAAgD,CAAC,CAAC;QAClE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAC;QACzD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAC7B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC;QACjC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,gDAAgD,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,gBAAgB,CAAC,EAAU,EAAE,MAAc,EAAE,QAAgB;QACjE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gDAAgD,CAAC,CAAC;QACnE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,iDAAiD,CAAC,CAAC;QACpE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAC9B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,MAAM,EAAE,CAAC,CAAC;QACtC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,EAAE,CAAC,UAAU,CAAC,CAAC;QACnE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gDAAgD,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,kBAAkB,CACtB,EAAU,EACV,UAKC;QAED,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,gDAAgD,CAAC,CAAC;QAClE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,kDAAkD,CAAC,CAAC;QACpE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAC7B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,UAAU,CAAC,IAAI,IAAI,SAAS,EAAE,CAAC,CAAC;QAC3D,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,UAAU,CAAC,IAAI,IAAI,SAAS,EAAE,CAAC,CAAC;QACzD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,UAAU,CAAC,EAAE,IAAI,SAAS,EAAE,CAAC,CAAC;QACrD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,UAAU,CAAC,QAAQ,IAAI,SAAS,EAAE,CAAC,CAAC;QACjE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,gDAAgD,CAAC,CAAC;IACpE,CAAC;CACF;AA9GD,oDA8GC"}
|
package/dist/index.d.ts
CHANGED
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -1,4 +1,10 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* @nauth-toolkit/email-console
|
|
4
|
+
*
|
|
5
|
+
* Console email provider for nauth-toolkit.
|
|
6
|
+
* Logs emails to console for development and testing.
|
|
7
|
+
*/
|
|
2
8
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
9
|
exports.ConsoleEmailProvider = void 0;
|
|
4
10
|
var console_email_provider_1 = require("./console-email.provider");
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,mEAAgE;AAAvD,8HAAA,oBAAoB,OAAA"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nauth-toolkit/email-console",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.17",
|
|
4
4
|
"description": "Console email provider for nauth-toolkit (dev/test)",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
},
|
|
28
28
|
"dependencies": {},
|
|
29
29
|
"peerDependencies": {
|
|
30
|
-
"@nauth-toolkit/core": "^0.1.
|
|
30
|
+
"@nauth-toolkit/core": "^0.1.17"
|
|
31
31
|
},
|
|
32
32
|
"devDependencies": {
|
|
33
33
|
"@types/jest": "^29.5.0",
|