97 lines
4.4 KiB
TypeScript
97 lines
4.4 KiB
TypeScript
/**
|
|
* Public entry-point for React-Email transactional templates.
|
|
*
|
|
* Dispatches a template-name plus props to the matching React component
|
|
* and renders `{ html, text }` deterministically via react-dom/server.
|
|
* The canonical entry-point for transactional mail rendering. Called
|
|
* directly from the host application's mail wrapper (see
|
|
* `apps/web/app/modules/emails/utils/EmailTemplates.ts`).
|
|
*
|
|
* Each entry intentionally accepts a small, explicit prop shape — we
|
|
* do not pipe arbitrary objects into the templates, so a malicious
|
|
* caller cannot inject extra React props.
|
|
*/
|
|
import { createElement, type ReactElement } from "react";
|
|
import { renderReactEmail } from "./render-helpers.js";
|
|
import { withBrandDefaults, type MailBrand } from "./_layout/theme.js";
|
|
import { WelcomeEmail, type WelcomeEmailProps } from "./transactional/Welcome.js";
|
|
import { MagicLinkEmail, type MagicLinkEmailProps } from "./transactional/MagicLink.js";
|
|
import { PasswordResetEmail, type PasswordResetEmailProps } from "./transactional/PasswordReset.js";
|
|
import { InvitationEmail, type InvitationEmailProps } from "./transactional/Invitation.js";
|
|
import { SubscriptionSuccessEmail, type SubscriptionSuccessEmailProps } from "./transactional/SubscriptionSuccess.js";
|
|
import { SubscriptionFailedEmail, type SubscriptionFailedEmailProps } from "./transactional/SubscriptionFailed.js";
|
|
import { InvoiceSentEmail, type InvoiceSentEmailProps } from "./transactional/InvoiceSent.js";
|
|
import { TenantNotificationEmail, type TenantNotificationEmailProps } from "./transactional/TenantNotification.js";
|
|
import { SystemMessageEmail, type SystemMessageEmailProps } from "./transactional/SystemMessage.js";
|
|
import type { BrandTokens } from "@hivegrid/brand";
|
|
import { mailBrandFromTokens } from "./_layout/theme.js";
|
|
|
|
export type ReactTransactionalTemplateName =
|
|
| "welcome"
|
|
| "magic-link"
|
|
| "password-reset"
|
|
| "invitation"
|
|
| "subscription-success"
|
|
| "subscription-failed"
|
|
| "invoice-sent"
|
|
| "system-message"
|
|
| "tenant-notification";
|
|
|
|
export type ReactTemplatePropsMap = {
|
|
welcome: WelcomeEmailProps;
|
|
"magic-link": MagicLinkEmailProps;
|
|
"password-reset": PasswordResetEmailProps;
|
|
invitation: InvitationEmailProps;
|
|
"subscription-success": SubscriptionSuccessEmailProps;
|
|
"subscription-failed": SubscriptionFailedEmailProps;
|
|
"invoice-sent": InvoiceSentEmailProps;
|
|
"system-message": SystemMessageEmailProps;
|
|
"tenant-notification": TenantNotificationEmailProps;
|
|
};
|
|
|
|
export interface RenderedReactEmail {
|
|
readonly html: string;
|
|
readonly text: string;
|
|
}
|
|
|
|
type AnyTemplateProps = ReactTemplatePropsMap[ReactTransactionalTemplateName];
|
|
|
|
const COMPONENTS: { [K in ReactTransactionalTemplateName]: (props: ReactTemplatePropsMap[K]) => ReactElement } = {
|
|
welcome: WelcomeEmail,
|
|
"magic-link": MagicLinkEmail,
|
|
"password-reset": PasswordResetEmail,
|
|
invitation: InvitationEmail,
|
|
"subscription-success": SubscriptionSuccessEmail,
|
|
"subscription-failed": SubscriptionFailedEmail,
|
|
"invoice-sent": InvoiceSentEmail,
|
|
"system-message": SystemMessageEmail,
|
|
"tenant-notification": TenantNotificationEmail,
|
|
};
|
|
|
|
export function renderTransactionalEmail<K extends ReactTransactionalTemplateName>(template: K, props: ReactTemplatePropsMap[K]): RenderedReactEmail {
|
|
const component = COMPONENTS[template] as (p: AnyTemplateProps) => ReactElement;
|
|
if (!component) {
|
|
throw new Error(`Unknown React transactional template: ${template}`);
|
|
}
|
|
const element = createElement<AnyTemplateProps>(component as (p: AnyTemplateProps) => ReactElement, props as AnyTemplateProps);
|
|
return renderReactEmail(element);
|
|
}
|
|
|
|
export function reactTransactionalTemplateNames(): readonly ReactTransactionalTemplateName[] {
|
|
return Object.keys(COMPONENTS) as ReactTransactionalTemplateName[];
|
|
}
|
|
|
|
function isBrandTokens(value: Partial<MailBrand> | BrandTokens): value is BrandTokens {
|
|
return "mail" in value && "assets" in value && "legal" in value;
|
|
}
|
|
|
|
export function buildBrand(override?: Partial<MailBrand> | BrandTokens): MailBrand {
|
|
if (!override) return withBrandDefaults();
|
|
return isBrandTokens(override) ? mailBrandFromTokens(override) : withBrandDefaults(override);
|
|
}
|
|
|
|
export { withBrandDefaults, defaultMailBrand, hiveGridMailLinks, mailBrandFromTokens } from "./_layout/theme.js";
|
|
export type { MailBrand } from "./_layout/theme.js";
|
|
export type { MailFooterCopy, MailLanguage } from "./_layout/Footer.js";
|
|
export type { SystemMessageDetail, SystemMessageEmailProps } from "./transactional/SystemMessage.js";
|