Vaster Email

Shared, typed transactional email templates for Vaster applications. Templates are built with React Email and render to both HTML and plain text. Applications remain responsible for recipients, authorization, business triggers, attachments, and delivery through AWS SES.

Development

bun install
bun run dev

The React Email preview server runs at http://localhost:3001 and includes sample data for every template.

Verification

bun run check
bun test
bun run build

Template catalog

| Template | Intended use | | --- | --- | | MagicLinkEmail | Passwordless authentication | | InvitationEmail | Product, organization, or workspace invitations | | WelcomeEmail | First-use and onboarding messages | | ApprovalRequestEmail | Requests requiring review or approval | | CommentNotificationEmail | New discussion comments | | RequestUpdatedEmail | Material changes to an existing request | | RequestApprovedEmail | Explicit approved outcome | | RequestRejectedEmail | Explicit rejected outcome | | RequestCompletedEmail | Explicit completed outcome | | WorkflowHandoffEmail | Moving work from one team or stage to another | | ProcessingCompletedEmail | Successful asynchronous jobs and document processing | | ProcessingFailedEmail | Failed jobs that may require retry or support | | FeedbackReceivedEmail | Internal product feedback reports | | ApplicationSharedEmail | Private-loan application sharing | | ApplicationStartedEmail | New private-loan application alert |

Each template has a matching render...Email helper. Renderers return { subject, html, text }, and subjects are stripped of newline characters before delivery.

Layouts

Operational notifications use InternalNotificationLayout, a compact, image-free layout intended for internal apps and team workflows. This includes approvals, comments, request status changes, workflow handoffs, processing results, feedback reports, and new-application alerts.

Account and customer-facing templates use the more prominent branded NotificationLayout. This includes magic links, invitations, welcome messages, and shared loan applications.

Both layouts are exported for app-specific templates.

Usage

import { renderMagicLinkEmail } from '@vastermortgage/email'

const message = await renderMagicLinkEmail({
  url: 'https://app.vaster.com/auth/magic-link',
  productName: 'Vaster',
  email: '[email protected]',
})

await sendEmail({
  to: '[email protected]',
  ...message,
})

Custom templates

The package also exports the branded layout and content primitives for app-specific templates:

import {
  EmailAction,
  EmailHeading,
  EmailParagraph,
  NotificationLayout,
  renderEmail,
} from '@vastermortgage/email'

function CustomEmail() {
  return (
    <NotificationLayout preview="A custom Vaster notification">
      <EmailHeading>Custom notification</EmailHeading>
      <EmailParagraph>App-specific content can still use the shared visual system.</EmailParagraph>
      <EmailAction href="https://example.com">Open item</EmailAction>
    </NotificationLayout>
  )
}

const message = await renderEmail('Custom notification', <CustomEmail />)

The package intentionally does not contain an email transport.