@nebutra/email 0.1.1 → 0.1.2

package/README.md

@@ -1,12 +1,14 @@
 # @nebutra/email
 
-> Transactional email service powered by Resend with branded HTML templates.
+Multi-provider transactional email for Nebutra products.
+
+The package auto-detects Resend, Nodemailer SMTP, or a console development
+provider, then sends branded HTML templates through a single API.
 
 ## Installation
 
 ```bash
-# Internal monorepo dependency
-pnpm add @nebutra/email@workspace:*
+pnpm add @nebutra/email
 ```
 
 ## Usage
@@ -53,5 +55,20 @@ await sendApiKeyCreatedEmail({
 
 | Environment Variable | Description |
 |---------------------|-------------|
+| `EMAIL_PROVIDER` | Optional explicit provider: `resend`, `nodemailer`, or `console` |
 | `RESEND_API_KEY` | Resend API key from https://resend.com/api-keys |
-| `EMAIL_FROM` | Verified sender address (default: `Nebutra <noreply@nebutra.ai>`) |
+| `SMTP_HOST` | Enables Nodemailer SMTP provider when Resend is not configured |
+| `SMTP_PORT` / `SMTP_USER` / `SMTP_PASS` / `SMTP_SECURE` | SMTP provider settings |
+| `EMAIL_FROM` | Verified sender address (default: `Nebutra <noreply@nebutra.com>`) |
+
+## Providers
+
+| Provider | Selection |
+| --- | --- |
+| `resend` | `EMAIL_PROVIDER=resend` or `RESEND_API_KEY` present |
+| `nodemailer` | `EMAIL_PROVIDER=nodemailer` or `SMTP_HOST` present |
+| `console` | Explicit `EMAIL_PROVIDER=console` or development/test fallback |
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -251,7 +251,7 @@ declare const REACT_EMAIL_TEMPLATES: {
  *
  * Environment variables:
  *   EMAIL_PROVIDER  — explicit provider override (optional)
- *   EMAIL_FROM      — verified sender (e.g. "Nebutra <noreply@nebutra.ai>")
+ *   EMAIL_FROM      — verified sender (e.g. getBrandMailFrom() example)
  *   RESEND_API_KEY  — for Resend provider
  *   SMTP_HOST       — for Nodemailer provider (+ SMTP_PORT, SMTP_USER, SMTP_PASS, SMTP_SECURE)
  */
@@ -281,6 +281,12 @@ declare const EMAIL_TEMPLATE_CATALOG: readonly [{
     readonly description: "Passwordless sign-in link";
     readonly sendHelper: "sendMagicLinkEmail";
     readonly fileName: "magic-link-email.html";
+}, {
+    readonly id: "email-change";
+    readonly label: "Email Change";
+    readonly description: "Confirm a new account email address";
+    readonly sendHelper: "sendEmailChangeEmail";
+    readonly fileName: "email-change-email.html";
 }, {
     readonly id: "contact-form-received";
     readonly label: "Contact Form Received";
@@ -333,7 +339,12 @@ declare function sendWelcomeEmail(opts: {
 declare function sendOrderConfirmationEmail(opts: {
     to: string;
     orderId: string;
+    /** Order total in minor units (integer cents). */
     totalAmount: number;
+    /** ISO 4217 currency code (default "USD"). */
+    currency?: string;
+    /** BCP 47 locale tag (default "en-US"). */
+    locale?: string;
     items: Array<{
         productId: string;
         quantity: number | string;
@@ -346,6 +357,16 @@ declare function sendMagicLinkEmail(opts: {
     to: string;
     magicLinkUrl: string;
 }): Promise<SendResult>;
+/**
+ * Email-change verification sent to the *new* address (TODO #126).
+ * Confirming the link flips the account email.
+ */
+declare function sendEmailChangeEmail(opts: {
+    to: string;
+    confirmUrl: string;
+    /** Optional display name for the new address (defaults to `to`). */
+    newEmail?: string;
+}): Promise<SendResult>;
 /**
  * Contact Form Receipt (Sent to the User)
  */
@@ -391,4 +412,4 @@ declare function sendReceiptEmail(opts: {
     to: string;
 } & ReceiptEmailProps): Promise<SendResult>;
 
-export { ConsoleEmailProvider, EMAIL_TEMPLATE_CATALOG, type EmailProvider, type EmailProviderType, type EmailTemplateCatalogEntry, type InvitationEmailProps, NodemailerEmailProvider, type PasswordResetEmailProps, REACT_EMAIL_TEMPLATES, type ReactEmailTemplate, type ReceiptEmailProps, type RenderedEmail, ResendEmailProvider, type SendOptions, type SendResult, type WelcomeEmailProps, getEmailProvider, invitationEmail, passwordResetEmail, receiptEmail, render$2 as renderInvitationEmail, render$1 as renderPasswordResetEmail, render$3 as renderReceiptEmail, render as renderWelcomeEmail, resetEmailProvider, sendContactFormReceivedEmail, sendInvitationEmail, sendLicenseCreatedEmail, sendMagicLinkEmail, sendOrderConfirmationEmail, sendPasswordResetEmail, sendReceiptEmail, sendWelcomeEmail, sendWelcomeReactEmail, welcomeEmail };
+export { ConsoleEmailProvider, EMAIL_TEMPLATE_CATALOG, type EmailProvider, type EmailProviderType, type EmailTemplateCatalogEntry, type InvitationEmailProps, NodemailerEmailProvider, type PasswordResetEmailProps, REACT_EMAIL_TEMPLATES, type ReactEmailTemplate, type ReceiptEmailProps, type RenderedEmail, ResendEmailProvider, type SendOptions, type SendResult, type WelcomeEmailProps, getEmailProvider, invitationEmail, passwordResetEmail, receiptEmail, render$2 as renderInvitationEmail, render$1 as renderPasswordResetEmail, render$3 as renderReceiptEmail, render as renderWelcomeEmail, resetEmailProvider, sendContactFormReceivedEmail, sendEmailChangeEmail, sendInvitationEmail, sendLicenseCreatedEmail, sendMagicLinkEmail, sendOrderConfirmationEmail, sendPasswordResetEmail, sendReceiptEmail, sendWelcomeEmail, sendWelcomeReactEmail, welcomeEmail };

package/dist/index.js

@@ -1,3 +1,7 @@
+// src/index.ts
+import { brand, colors as colors3 } from "@nebutra/brand/metadata";
+import { getBrandMailFrom, getBrandOrigin as getBrandOrigin2 } from "@nebutra/brand/metadata-helpers";
+
 // src/providers/console.ts
 var counter = 0;
 var ConsoleEmailProvider = class {
@@ -134,8 +138,13 @@ function resetEmailProvider() {
   cachedProvider = void 0;
 }
 
+// src/templates/invitation.tsx
+import { colors as colors2 } from "@nebutra/brand/metadata";
+
 // src/templates/_layout.ts
-var BRAND_GRADIENT = "linear-gradient(135deg,#0033FE,#0BF1C3)";
+import { colors } from "@nebutra/brand/metadata";
+import { getBrandOrigin } from "@nebutra/brand/metadata-helpers";
+var BRAND_HEADER = colors.primary["500"];
 var COLOR_BG = "#f8fafc";
 var COLOR_BORDER = "#e2e8f0";
 var COLOR_HEADING = "#0f172a";
@@ -155,7 +164,7 @@ function baseLayout({ brandName, preview: preview5, body }) {
   <table width="100%" cellpadding="0" cellspacing="0" role="presentation" style="background:${COLOR_BG};">
     <tr><td align="center" style="padding:40px 16px;">
       <table width="600" cellpadding="0" cellspacing="0" role="presentation" style="background:#ffffff;border-radius:12px;border:1px solid ${COLOR_BORDER};overflow:hidden;max-width:600px;width:100%;">
-        <tr><td style="background:${BRAND_GRADIENT};padding:32px 40px;">
+        <tr><td style="background:${BRAND_HEADER};padding:32px 40px;">
           <h1 style="margin:0;color:#ffffff;font-size:24px;font-weight:700;letter-spacing:-0.5px;">${escapeHtml(brandName)}</h1>
         </td></tr>
         <tr><td style="padding:40px;">
@@ -164,8 +173,8 @@ function baseLayout({ brandName, preview: preview5, body }) {
         <tr><td style="padding:24px 40px;border-top:1px solid ${COLOR_BORDER};background:${COLOR_BG};">
           <p style="margin:0;font-size:12px;color:${COLOR_MUTED};text-align:center;">
             &copy; ${(/* @__PURE__ */ new Date()).getFullYear()} ${escapeHtml(brandName)} &middot;
-            <a href="https://nebutra.ai/privacy" style="color:${COLOR_MUTED};">Privacy</a> &middot;
-            <a href="https://nebutra.ai/unsubscribe" style="color:${COLOR_MUTED};">Unsubscribe</a>
+            <a href="${getBrandOrigin("landing")}/privacy" style="color:${COLOR_MUTED};">Privacy</a> &middot;
+            <a href="${getBrandOrigin("landing")}/unsubscribe" style="color:${COLOR_MUTED};">Unsubscribe</a>
           </p>
         </td></tr>
       </table>
@@ -175,7 +184,9 @@ function baseLayout({ brandName, preview: preview5, body }) {
 </html>`;
 }
 var palette = {
-  gradient: BRAND_GRADIENT,
+  /** @deprecated alias of solid identity header — not a product skin */
+  gradient: BRAND_HEADER,
+  header: BRAND_HEADER,
   background: COLOR_BG,
   border: COLOR_BORDER,
   heading: COLOR_HEADING,
@@ -208,7 +219,7 @@ function render(props) {
     </p>
     <p style="margin:0 0 24px;font-size:14px;color:${palette.body};">
       Role:
-      <span style="display:inline-block;background:#e0f2fe;color:#0033FE;padding:4px 10px;border-radius:999px;font-size:13px;font-weight:600;margin-left:6px;">
+      <span style="display:inline-block;background:#e0f2fe;color:${colors2.primary["500"]};padding:4px 10px;border-radius:999px;font-size:13px;font-weight:600;margin-left:6px;">
         ${role}
       </span>
     </p>
@@ -386,7 +397,7 @@ var REACT_EMAIL_TEMPLATES = {
 };
 
 // src/index.ts
-var FROM = process.env.EMAIL_FROM ?? "Nebutra <noreply@nebutra.ai>";
+var FROM = process.env.EMAIL_FROM ?? getBrandMailFrom();
 var EMAIL_TEMPLATE_CATALOG = [
   {
     id: "welcome",
@@ -409,6 +420,13 @@ var EMAIL_TEMPLATE_CATALOG = [
     sendHelper: "sendMagicLinkEmail",
     fileName: "magic-link-email.html"
   },
+  {
+    id: "email-change",
+    label: "Email Change",
+    description: "Confirm a new account email address",
+    sendHelper: "sendEmailChangeEmail",
+    fileName: "email-change-email.html"
+  },
   {
     id: "contact-form-received",
     label: "Contact Form Received",
@@ -466,7 +484,7 @@ function baseLayout2(content, previewText = "") {
   <meta charset="UTF-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <meta name="x-apple-disable-message-reformatting" />
-  <title>Nebutra</title>
+  <title>${brand.name}</title>
   <!--[if mso]><noscript><xml><o:OfficeDocumentSettings><o:PixelsPerInch>96</o:PixelsPerInch></o:OfficeDocumentSettings></xml></noscript><![endif]-->
 </head>
 <body style="margin:0;padding:0;background:#f8fafc;font-family:-apple-system,BlinkMacSystemFont,'Segoe UI',Roboto,sans-serif;">
@@ -475,8 +493,8 @@ function baseLayout2(content, previewText = "") {
     <tr><td align="center" style="padding:40px 16px;">
       <table width="600" cellpadding="0" cellspacing="0" role="presentation" style="background:#ffffff;border-radius:12px;border:1px solid #e2e8f0;overflow:hidden;max-width:600px;width:100%;">
         <!-- Header -->
-        <tr><td style="background:linear-gradient(135deg,#0033FE,#0BF1C3);padding:32px 40px;">
-          <h1 style="margin:0;color:#ffffff;font-size:24px;font-weight:700;letter-spacing:-0.5px;">Nebutra</h1>
+        <tr><td style="background:${colors3.primary["500"]};padding:32px 40px;">
+          <h1 style="margin:0;color:#ffffff;font-size:24px;font-weight:700;letter-spacing:-0.5px;">${brand.name}</h1>
         </td></tr>
         <!-- Body -->
         <tr><td style="padding:40px;">
@@ -485,9 +503,9 @@ function baseLayout2(content, previewText = "") {
         <!-- Footer -->
         <tr><td style="padding:24px 40px;border-top:1px solid #e2e8f0;background:#f8fafc;">
           <p style="margin:0;font-size:12px;color:#94a3b8;text-align:center;">
-            \xA9 ${(/* @__PURE__ */ new Date()).getFullYear()} Nebutra Intelligence Inc. \xB7
-            <a href="https://nebutra.ai/privacy" style="color:#94a3b8;">Privacy</a> \xB7
-            <a href="https://nebutra.ai/unsubscribe" style="color:#94a3b8;">Unsubscribe</a>
+            \xA9 ${(/* @__PURE__ */ new Date()).getFullYear()} ${brand.nameFullEn} \xB7
+            <a href="${getBrandOrigin2("landing")}/privacy" style="color:#94a3b8;">Privacy</a> \xB7
+            <a href="${getBrandOrigin2("landing")}/unsubscribe" style="color:#94a3b8;">Unsubscribe</a>
           </p>
         </td></tr>
       </table>
@@ -497,31 +515,35 @@ function baseLayout2(content, previewText = "") {
 </html>`;
 }
 async function sendWelcomeEmail(opts) {
-  const dashboardUrl = opts.dashboardUrl ?? "https://app.nebutra.ai";
+  const dashboardUrl = opts.dashboardUrl ?? getBrandOrigin2("app");
   const html = baseLayout2(
     `
-    <h2 style="margin:0 0 16px;font-size:22px;color:#0f172a;">Welcome to Nebutra, ${opts.firstName}!</h2>
+    <h2 style="margin:0 0 16px;font-size:22px;color:#0f172a;">Welcome to ${brand.name}, ${opts.firstName}!</h2>
     <p style="margin:0 0 16px;font-size:15px;color:#475569;line-height:1.6;">
       Your workspace <strong>${opts.orgName}</strong> is ready. You can now invite team members,
-      create API keys, and start building with the Nebutra platform.
+      create API keys, and start building with the ${brand.name} platform.
     </p>
-    <a href="${dashboardUrl}" style="display:inline-block;background:linear-gradient(135deg,#0033FE,#0BF1C3);color:#ffffff;text-decoration:none;border-radius:8px;padding:12px 24px;font-size:15px;font-weight:600;margin:0 0 24px;">
+    <a href="${dashboardUrl}" style="display:inline-block;background:${colors3.primary["500"]};color:#ffffff;text-decoration:none;border-radius:8px;padding:12px 24px;font-size:15px;font-weight:600;margin:0 0 24px;">
       Open Dashboard \u2192
     </a>
     <p style="margin:0;font-size:13px;color:#94a3b8;">
-      If you have questions, reply to this email or visit our <a href="https://docs.nebutra.ai" style="color:#0033FE;">documentation</a>.
+      If you have questions, reply to this email or visit our <a href="${getBrandOrigin2("docs")}" style="color:${colors3.primary["500"]};">documentation</a>.
     </p>
     `,
-    `Welcome to Nebutra \u2014 ${opts.orgName} is ready`
+    `Welcome to ${brand.name} \u2014 ${opts.orgName} is ready`
   );
   return send({
     to: opts.to,
-    subject: `Welcome to Nebutra \u2014 ${opts.orgName} is ready`,
+    subject: `Welcome to ${brand.name} \u2014 ${opts.orgName} is ready`,
     html,
     tags: [{ name: "type", value: "welcome" }]
   });
 }
 async function sendOrderConfirmationEmail(opts) {
+  const formattedTotal = new Intl.NumberFormat(opts.locale ?? "en-US", {
+    style: "currency",
+    currency: opts.currency ?? "USD"
+  }).format(opts.totalAmount / 100);
   const itemsHtml = opts.items.map(
     (item) => `<tr>
           <td style="padding:12px 0;border-bottom:1px solid #e2e8f0;color:#0f172a;font-size:15px;">${item.productId}</td>
@@ -532,13 +554,13 @@ async function sendOrderConfirmationEmail(opts) {
     `
     <h2 style="margin:0 0 16px;font-size:22px;color:#0f172a;">Order Confirmed!</h2>
     <p style="margin:0 0 16px;font-size:15px;color:#475569;line-height:1.6;">
-      Thank you for your order <strong>#${opts.orderId}</strong>. We've received your payment of 
-      <strong>$${(opts.totalAmount / 100).toFixed(2)}</strong> and your order is now being processed.
+      Thank you for your order <strong>#${opts.orderId}</strong>. We've received your payment of
+      <strong>${formattedTotal}</strong> and your order is now being processed.
     </p>
     <table width="100%" cellpadding="0" cellspacing="0" style="margin:0 0 24px;border-collapse:collapse;">
       ${itemsHtml}
     </table>
-    <a href="https://app.nebutra.ai/orders/${opts.orderId}" style="display:inline-block;background:linear-gradient(135deg,#0033FE,#0BF1C3);color:#ffffff;text-decoration:none;border-radius:8px;padding:12px 24px;font-size:15px;font-weight:600;margin:0 0 24px;">
+    <a href="${getBrandOrigin2("app")}/orders/${opts.orderId}" style="display:inline-block;background:${colors3.primary["500"]};color:#ffffff;text-decoration:none;border-radius:8px;padding:12px 24px;font-size:15px;font-weight:600;margin:0 0 24px;">
       View Order Details \u2192
     </a>
     `,
@@ -554,11 +576,11 @@ async function sendOrderConfirmationEmail(opts) {
 async function sendMagicLinkEmail(opts) {
   const html = baseLayout2(
     `
-    <h2 style="margin:0 0 16px;font-size:22px;color:#0f172a;">Sign in to Nebutra</h2>
+    <h2 style="margin:0 0 16px;font-size:22px;color:#0f172a;">Sign in to ${brand.name}</h2>
     <p style="margin:0 0 16px;font-size:15px;color:#475569;line-height:1.6;">
       Click the button below to sign in securely. No password required.
     </p>
-    <a href="${opts.magicLinkUrl}" style="display:inline-block;background:linear-gradient(135deg,#0033FE,#0BF1C3);color:#ffffff;text-decoration:none;border-radius:8px;padding:12px 24px;font-size:16px;font-weight:600;margin:0 0 24px;text-align:center;width:100%;max-width:280px;">
+    <a href="${opts.magicLinkUrl}" style="display:inline-block;background:${colors3.primary["500"]};color:#ffffff;text-decoration:none;border-radius:8px;padding:12px 24px;font-size:16px;font-weight:600;margin:0 0 24px;text-align:center;width:100%;max-width:280px;">
       \u2728 Sign In Automatically
     </a>
     <p style="margin:0;font-size:12px;color:#94a3b8;line-height:1.4;">
@@ -566,15 +588,40 @@ async function sendMagicLinkEmail(opts) {
       This link expires in 15 minutes.
     </p>
     `,
-    "Click here to sign in to your Nebutra account"
+    `Click here to sign in to your ${brand.name} account`
   );
   return send({
     to: opts.to,
-    subject: "Sign in to Nebutra \u2728",
+    subject: `Sign in to ${brand.name} \u2728`,
     html,
     tags: [{ name: "type", value: "magic_link" }]
   });
 }
+async function sendEmailChangeEmail(opts) {
+  const recipientEmail = opts.newEmail ?? opts.to;
+  const html = baseLayout2(
+    `
+    <h2 style="margin:0 0 16px;font-size:22px;color:#0f172a;">Confirm your new email address</h2>
+    <p style="margin:0 0 16px;font-size:15px;color:#475569;line-height:1.6;">
+      We received a request to change the email on your ${brand.name} account to
+      <strong>${recipientEmail}</strong>. Click the button below to confirm. This link expires in 1 hour.
+    </p>
+    <a href="${opts.confirmUrl}" style="display:inline-block;background:${colors3.primary["500"]};color:#ffffff;text-decoration:none;border-radius:8px;padding:12px 24px;font-size:16px;font-weight:600;margin:0 0 24px;text-align:center;width:100%;max-width:280px;">
+      Confirm email change \u2192
+    </a>
+    <p style="margin:0;font-size:12px;color:#94a3b8;line-height:1.4;">
+      If you did not request this change you can safely ignore this email \u2014 your address will not be updated.
+    </p>
+    `,
+    "Confirm your new Nebutra email address"
+  );
+  return send({
+    to: opts.to,
+    subject: "Confirm your new Nebutra email address",
+    html,
+    tags: [{ name: "type", value: "email_change_verification" }]
+  });
+}
 async function sendContactFormReceivedEmail(opts) {
   const html = baseLayout2(
     `
@@ -587,14 +634,14 @@ async function sendContactFormReceivedEmail(opts) {
       We've received your request and our team will get back to you within 1-2 business days.
     </p>
     <p style="margin:0;font-size:15px;color:#475569;line-height:1.6;">
-      Best regards,<br/>The Nebutra Team
+      Best regards,<br/>The ${brand.name} Team
     </p>
     `,
     "We have received your message"
   );
   return send({
     to: opts.to,
-    subject: "We've received your message - Nebutra",
+    subject: `We've received your message - ${brand.name}`,
     html,
     tags: [{ name: "type", value: "contact_receipt" }]
   });
@@ -602,7 +649,7 @@ async function sendContactFormReceivedEmail(opts) {
 async function sendLicenseCreatedEmail(opts) {
   const html = baseLayout2(
     `
-    <h2 style="margin:0 0 16px;font-size:22px;color:#0f172a;">Welcome to Nebutra-Sailor! \u{1F680}</h2>
+    <h2 style="margin:0 0 16px;font-size:22px;color:#0f172a;">Welcome to ${brand.name}-Sailor! \u{1F680}</h2>
     <p style="margin:0 0 16px;font-size:15px;color:#475569;line-height:1.6;">
       Hi ${opts.firstName}, your <strong>${opts.tier}</strong> license has been successfully generated.
     </p>
@@ -610,23 +657,23 @@ async function sendLicenseCreatedEmail(opts) {
       Your official License Key is:
     </p>
     <div style="background:#0f172a;border-radius:8px;padding:16px 20px;margin:0 0 24px;overflow-x:auto;">
-      <code style="color:#0BF1C3;font-family:'Courier New',monospace;font-size:13px;word-break:break-all;">${opts.licenseKey}</code>
+      <code style="color:${colors3.accent["500"]};font-family:'Courier New',monospace;font-size:13px;word-break:break-all;">${opts.licenseKey}</code>
     </div>
     <p style="margin:0 0 16px;font-size:15px;color:#475569;line-height:1.6;">
-      To unlock the premium capabilities of the Nebutra CLI locally, run the following command in your terminal:
+      To unlock the premium capabilities of the ${brand.name} CLI locally, run the following command in your terminal:
     </p>
     <div style="background:#f1f5f9;border:1px solid #e2e8f0;border-radius:6px;padding:12px;margin:0 0 24px;">
       <code style="color:#334155;font-family:'Courier New',monospace;font-size:13px;">nebutra license activate ${opts.licenseKey}</code>
     </div>
     <p style="margin:0;font-size:13px;color:#94a3b8;">
-      If you have questions, reply to this email or visit our <a href="https://docs.nebutra.ai" style="color:#0033FE;">documentation</a>.
+      If you have questions, reply to this email or visit our <a href="${getBrandOrigin2("docs")}" style="color:${colors3.primary["500"]};">documentation</a>.
     </p>
     `,
-    "Your Nebutra License Key is Ready"
+    `Your ${brand.name} License Key is Ready`
   );
   return send({
     to: opts.to,
-    subject: `Your Nebutra License Key is Ready (${opts.tier})`,
+    subject: `Your ${brand.name} License Key is Ready (${opts.tier})`,
     html,
     tags: [{ name: "type", value: "license_created" }]
   });
@@ -679,6 +726,7 @@ export {
   render4 as renderWelcomeEmail,
   resetEmailProvider,
   sendContactFormReceivedEmail,
+  sendEmailChangeEmail,
   sendInvitationEmail,
   sendLicenseCreatedEmail,
   sendMagicLinkEmail,