najm-auth 4.0.3 → 4.0.4

package/README.md

@@ -139,7 +139,14 @@ auth({
   bcryptRounds?: number                    // Default: 10 (valid: 4-31)
 
   // Frontend
-  frontendUrl?: string                     // Password reset link base URL
+  frontendUrl?: string                     // Password reset link base URL
+  appName?: string                         // Security email brand (default: 'Your app')
+  accountInviteLogo?: {                    // Optional CID-backed inline mark
+    alt?: string
+    contentBase64: string
+    contentType: string
+    filename: string
+  }
 
   // Login identifier normalization (see "Identity presets")
   identity?: {
@@ -1142,6 +1149,17 @@ activates the account when its status is `pending`. An ordinary password reset
 changes neither verification nor lifecycle status, and an explicitly inactive
 invited account remains inactive.
 
+Set `appName` on `auth()` to brand the invitation subject and email card. The
+provisioned role is presented as the account type, so a sponsor invitation can
+say “Activate your sponsor account” without application-owned HTML. The shared
+template uses inline critical styles for Gmail and keeps the raw token URL out
+of visible fallback copy.
+
+For a branded mark that works in email clients without a public asset URL, set
+`accountInviteLogo` to base64 content plus its MIME type and filename. Najm
+attaches it inline and points the shared template at a stable CID; when omitted,
+the template renders `appName` as text.
+
 The built-in memory and Redis drivers implement the required atomic primitive.
 A custom cache driver may omit `compareAndDelete()` for compatibility with
 unrelated cache usage, but reset and invite consumption then fails closed. Do

package/dist/index.d.ts

@@ -198,6 +198,15 @@ interface AuthConfig {
     defaultRole: string | null;
     /** Frontend URL for password reset links (default: 'http://localhost:3000') */
     frontendUrl: string;
+    /** Product name used in security email subjects and templates. */
+    appName: string;
+    /** Optional inline logo embedded in account invitation emails. */
+    accountInviteLogo?: {
+        alt?: string;
+        contentBase64: string;
+        contentType: string;
+        filename: string;
+    };
     /** Registration mode: 'active' auto-activates, 'pending' requires admin approval (default: 'active') */
     registrationMode: 'active' | 'pending';
     /** Whether the unauthenticated POST /auth/register route is mounted. */
@@ -265,6 +274,15 @@ type AuthPluginConfig = {
     defaultRole?: string | null;
     /** Frontend URL for password reset links. Falls back to FRONTEND_URL env var, then 'http://localhost:3000' */
     frontendUrl?: string;
+    /** Product name used in account invitation emails (default: 'Your app'). */
+    appName?: string;
+    /** Optional inline logo embedded in account invitation emails. */
+    accountInviteLogo?: {
+        alt?: string;
+        contentBase64: string;
+        contentType: string;
+        filename: string;
+    };
     /** Registration mode: 'active' auto-activates new users, 'pending' requires admin approval (default: 'active') */
     registrationMode?: 'active' | 'pending';
     /**
@@ -432,7 +450,7 @@ var auth = {
 			subject: "Reset your password"
 		},
 		accountInvite: {
-			subject: "You've been invited — set up your account"
+			subject: "{{appName}}: activate your {{accountLabel}}"
 		}
 	}
 };

package/dist/index.js

@@ -3488,13 +3488,36 @@ var AuthService = class AuthService2 {
     });
     const { token } = await this.tokenService.generateInviteToken(user.id);
     const inviteLink = `${this.config.frontendUrl}/reset-password?token=${token}`;
+    const accountType = body.role?.trim().toLowerCase();
+    const accountLabel = accountType ? `${accountType} account` : "account";
     let emailSent = false;
     try {
-      await this.emailService.sendHtml(body.email, this.t("emails.accountInvite.subject"), accountInviteTemplate({
-        inviteLink,
-        userName: user.name || body.email
-      }));
-      emailSent = true;
+      const logo = this.config.accountInviteLogo;
+      const logoCid = logo ? "najm-account-invite-logo" : void 0;
+      const result = await this.emailService.send({
+        to: body.email,
+        subject: this.t("emails.accountInvite.subject", {
+          accountLabel,
+          appName: this.config.appName
+        }),
+        html: accountInviteTemplate({
+          accountType,
+          appName: this.config.appName,
+          inviteLink,
+          logoAlt: logo?.alt,
+          logoSrc: logoCid ? `cid:${logoCid}` : void 0,
+          userName: user.name || body.email
+        }),
+        attachments: logo ? [{
+          filename: logo.filename,
+          content: logo.contentBase64,
+          contentType: logo.contentType,
+          cid: logoCid,
+          disposition: "inline",
+          encoding: "base64"
+        }] : void 0
+      });
+      emailSent = result.success;
     } catch (error) {
       this.logger.warn("Account invite email failed", { email: body.email, error });
     }
@@ -6346,7 +6369,7 @@ var en_default = {
         subject: "Reset your password"
       },
       accountInvite: {
-        subject: "You've been invited \u2014 set up your account"
+        subject: "{{appName}}: activate your {{accountLabel}}"
       }
     }
   },
@@ -7478,6 +7501,13 @@ var validateCallbackUrl = /* @__PURE__ */ __name((value, name) => {
   }
   return callback.toString();
 }, "validateCallbackUrl");
+var resolveAppName = /* @__PURE__ */ __name((value) => {
+  const appName = value?.trim() || "Your app";
+  if (appName.length > 80 || /[\u0000-\u001f\u007f]/.test(appName)) {
+    throw new Error("auth.appName must be at most 80 characters without control characters");
+  }
+  return appName;
+}, "resolveAppName");
 var resolveGoogleConfig = /* @__PURE__ */ __name((config) => {
   const configuredGoogle = config?.oauth?.google;
   if (!configuredGoogle)
@@ -7554,6 +7584,8 @@ var resolveAuthConfig = /* @__PURE__ */ __name((config) => {
     blacklistPrefix: config?.blacklistPrefix ?? "auth:blacklist:",
     defaultRole: config?.defaultRole ?? null,
     frontendUrl: config?.frontendUrl ?? process.env.FRONTEND_URL ?? "http://localhost:3000",
+    appName: resolveAppName(config?.appName),
+    accountInviteLogo: config?.accountInviteLogo,
     registrationMode: config?.registrationMode ?? "active",
     publicRegistration: config?.publicRegistration ?? true,
     requireVerifiedEmail: config?.requireVerifiedEmail ?? false,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "najm-auth",
-  "version": "4.0.3",
+  "version": "4.0.4",
   "description": "Authentication and authorization library for najm framework",
   "type": "module",
   "files": [
@@ -97,7 +97,7 @@
     "najm-guard": "^2.0.2",
     "najm-i18n": "^2.1.2",
     "najm-cache": "^2.2.0",
-    "najm-email": "^2.0.3",
+    "najm-email": "^2.0.4",
     "najm-rate": "^2.1.1",
     "najm-validation": "^2.0.2",
     "jsonwebtoken": "^9.0.3",