@fonderie/auth 5.0.3 → 5.1.0

package/brain/signatures.md

@@ -94,6 +94,8 @@ const MESSAGE_KEYS: { readonly emailRegistration: "email-registration"; readonly
 
 type AuthMessageKey = (typeof MESSAGE_KEYS)[keyof typeof MESSAGE_KEYS];
 
+const DEFAULT_TEMPLATES: { "email-registration": { subject: string; html: string; text: string; }; "email-verification": { subject: string; html: string; text: string; }; "password-reset": { subject: string; html: string; text: string; }; "phone-otp": { text: string; }; "mfa-enabled": { subject: string; html: string; text: string; }; "mfa-disabled": { subject: string; html: string; text: string; }; "mfa-backup-codes-regenerated": { subject: string; html: string; text: string; }; "email-changed": { subject: string; html: string; text: string; }; "phone-changed": { subject: string; html: string; text: string; }; }
+
 interface IUserDTO {
     id: string;
     email: string;

package/dist/index.cjs

@@ -70,6 +70,7 @@ var index_exports = {};
 __export(index_exports, {
   AUTH_CONFIG_KEYS: () => AUTH_CONFIG_KEYS,
   AuthModule: () => AuthModule,
+  DEFAULT_TEMPLATES: () => DEFAULT_TEMPLATES,
   MESSAGE_KEYS: () => MESSAGE_KEYS,
   buildAuthAccountLimiter: () => buildAuthAccountLimiter,
   buildAuthIpLimiter: () => buildAuthIpLimiter,
@@ -2296,6 +2297,122 @@ var AuthModule = class {
   }
 };
 
+// src/templates.ts
+var DEFAULT_TEMPLATES = {
+  [MESSAGE_KEYS.emailRegistration]: {
+    subject: "Confirm your account",
+    html: `<h1>Welcome aboard</h1>
+<p>Hi {{firstName}},</p>
+<p>Thanks for signing up. Confirm your account with this code:</p>
+<p><span class="pin-code">{{pin}}</span></p>
+<p class="muted">This code expires in 24 hours. If you didn&rsquo;t create an account, you can safely ignore this email.</p>`,
+    text: `Welcome aboard
+
+Hi {{firstName}},
+
+Thanks for signing up. Confirm your account with this code: {{pin}}
+
+This code expires in 24 hours. If you didn't create an account, you can safely ignore this email.`
+  },
+  [MESSAGE_KEYS.emailVerification]: {
+    subject: "Your verification code",
+    html: `<h1>Verify your email</h1>
+<p>Hi {{firstName}},</p>
+<p>Use this code to finish setting up your account:</p>
+<p><span class="pin-code">{{pin}}</span></p>
+<p class="muted">This code expires in 24 hours. If you didn&rsquo;t create an account, you can safely ignore this email.</p>`,
+    text: `Verify your email
+
+Hi {{firstName}},
+
+Use this code to finish setting up your account: {{pin}}
+
+This code expires in 24 hours. If you didn't create an account, you can safely ignore this email.`
+  },
+  [MESSAGE_KEYS.passwordReset]: {
+    subject: "Reset your password",
+    html: `<h1>Reset your password</h1>
+<p>We received a request to reset your password. Use this code to continue:</p>
+<p><span class="pin-code">{{pin}}</span></p>
+<p class="muted">This code expires soon. If you didn&rsquo;t request a reset, no action is needed &mdash; your password stays the same.</p>`,
+    text: `Reset your password
+
+We received a request to reset your password. Use this code to continue: {{pin}}
+
+This code expires soon. If you didn't request a reset, no action is needed \u2014 your password stays the same.`
+  },
+  // SMS — text only, no subject/html.
+  [MESSAGE_KEYS.phoneOtp]: {
+    text: "{{otp}} is your verification code. It expires in 10 minutes."
+  },
+  [MESSAGE_KEYS.mfaEnabled]: {
+    subject: "Two-factor authentication is on",
+    html: `<h1>Two-factor authentication enabled</h1>
+<p>Two-factor authentication was just turned on for your account. From now on you&rsquo;ll enter a code from your authenticator app when you sign in.</p>
+<p class="muted">If you didn&rsquo;t do this, contact support right away &mdash; someone may have access to your account.</p>`,
+    text: `Two-factor authentication enabled
+
+Two-factor authentication was just turned on for your account. From now on you'll enter a code from your authenticator app when you sign in.
+
+If you didn't do this, contact support right away \u2014 someone may have access to your account.`
+  },
+  [MESSAGE_KEYS.mfaDisabled]: {
+    subject: "Two-factor authentication is off",
+    html: `<h1>Two-factor authentication disabled</h1>
+<p>Two-factor authentication was just turned off for your account. Your account is now protected by your password alone.</p>
+<p class="muted">If you didn&rsquo;t do this, contact support right away and re-enable two-factor authentication &mdash; someone may have access to your account.</p>`,
+    text: `Two-factor authentication disabled
+
+Two-factor authentication was just turned off for your account. Your account is now protected by your password alone.
+
+If you didn't do this, contact support right away and re-enable two-factor authentication \u2014 someone may have access to your account.`
+  },
+  [MESSAGE_KEYS.mfaBackupCodesRegenerated]: {
+    subject: "Your backup codes were regenerated",
+    html: `<h1>New backup codes generated</h1>
+<p>A new set of two-factor backup codes was just generated for your account. Your previous backup codes no longer work.</p>
+<p class="muted">If you didn&rsquo;t do this, contact support right away &mdash; someone may have access to your account.</p>`,
+    text: `New backup codes generated
+
+A new set of two-factor backup codes was just generated for your account. Your previous backup codes no longer work.
+
+If you didn't do this, contact support right away \u2014 someone may have access to your account.`
+  },
+  [MESSAGE_KEYS.emailChanged]: {
+    subject: "Your email address was changed",
+    html: `<h1>Your email was changed</h1>
+<p>The email address on your account was just changed to <strong>{{newEmail}}</strong>.</p>
+<p class="muted">If you made this change, you&rsquo;re all set. If not, contact support right away &mdash; someone may have access to your account.</p>`,
+    text: `Your email was changed
+
+The email address on your account was just changed to {{newEmail}}.
+
+If you made this change, you're all set. If not, contact support right away \u2014 someone may have access to your account.`
+  },
+  [MESSAGE_KEYS.phoneChanged]: {
+    subject: "Your phone number was changed",
+    html: `<h1>Your phone number was changed</h1>
+<p>The phone number on your account was just updated.</p>
+<p class="muted">If you made this change, you&rsquo;re all set. If not, contact support right away &mdash; someone may have access to your account.</p>`,
+    text: `Your phone number was changed
+
+The phone number on your account was just updated.
+
+If you made this change, you're all set. If not, contact support right away \u2014 someone may have access to your account.`
+  }
+};
+var SAMPLE_PAYLOADS = {
+  [MESSAGE_KEYS.emailRegistration]: { firstName: "", pin: "123456" },
+  [MESSAGE_KEYS.emailVerification]: { firstName: "Ada", pin: "123456" },
+  [MESSAGE_KEYS.passwordReset]: { pin: "123456" },
+  [MESSAGE_KEYS.phoneOtp]: { otp: "123456" },
+  [MESSAGE_KEYS.mfaEnabled]: {},
+  [MESSAGE_KEYS.mfaDisabled]: {},
+  [MESSAGE_KEYS.mfaBackupCodesRegenerated]: {},
+  [MESSAGE_KEYS.emailChanged]: { newEmail: "new@example.com" },
+  [MESSAGE_KEYS.phoneChanged]: {}
+};
+
 // src/middlewares/require-auth.ts
 var import_middlewares3 = require("@fonderie/core/middlewares");
 
@@ -2369,6 +2486,7 @@ function startUserRetention(store, options) {
 0 && (module.exports = {
   AUTH_CONFIG_KEYS,
   AuthModule,
+  DEFAULT_TEMPLATES,
   MESSAGE_KEYS,
   buildAuthAccountLimiter,
   buildAuthIpLimiter,