@vrplatform/email 1.0.2-6564 → 1.0.2-736

package/src/components/EmailContainer.tsx

@@ -12,7 +12,7 @@ import type { EmailBaseProps } from '../types';
 type Props = {
   children: React.ReactNode;
   title: string;
-  tenant: Omit<EmailBaseProps['tenant'], 'name'>;
+  tenant: Omit<EmailBaseProps['tenant'], 'name'> & { name?: string };
   mode: EmailBaseProps['mode'];
   shortDescription?: string;
 };
@@ -68,7 +68,11 @@ export const EmailContainer = (props: Props) => {
   );
 };
 
-const Content = ({ children, tenant: { logo: tenantLogo }, mode }: Props) => {
+const Content = ({
+  children,
+  tenant: { logo: tenantLogo, name, showPlatformBranding = true },
+  mode,
+}: Props) => {
   return (
     <>
       {tenantLogo ? (
@@ -86,6 +90,8 @@ const Content = ({ children, tenant: { logo: tenantLogo }, mode }: Props) => {
         >
           <Img src={tenantLogo} alt={'Logo'} width={70} />
         </div>
+      ) : !showPlatformBranding ? (
+        <Text>{name}</Text>
       ) : mode === 'send' ? (
         <Img
           src={'https://staging.portal.vrplatform.app/logo.png'}
@@ -105,7 +111,7 @@ const Content = ({ children, tenant: { logo: tenantLogo }, mode }: Props) => {
 
       {children}
 
-      <Footer />
+      {showPlatformBranding ? <Footer /> : <Text>{name}</Text>}
     </>
   );
 };
@@ -124,7 +130,7 @@ const Footer = () => (
         color: '#737373',
       }}
     >
-      © {day().year()} VRPlatform Ventures Ltd. All rights reserved.
+      © {day().year()} VR Technologies. All rights reserved.
     </Text>
     <Text
       style={{

package/src/templates/InviteOwnerEmailTemplate.tsx

@@ -16,17 +16,30 @@ export const getDefaultInviteOwnerEmailData = (
     mode === 'tag' ? EMAIL_ACTION_LINK_COMPONENT : args.signInLink;
 
   return {
-    bodyOne: `<p>You are invited to join us on ${args.appName}.</p><p>To start using ${args.appName}, accept the invitation and verify your email address.</p>`,
+    bodyOne: `<p>You are invited to access your Owner Portal on ${args.appName}.</p><p>Accept the invitation below to set up your access.</p>`,
     bodyTwo: `<p>If you have any trouble with the button, you can copy and paste the link below into your browser: ${signInLink}</p>`,
     buttonText: 'Accept Invitation',
-    header: 'Welcome to the team!',
-    shortDescription:
-      'You have been invited to join the team. To start using VRPlatform, verify your email address at link below.',
+    header: 'Welcome to your Owner Portal!',
+    shortDescription: 'Set up your Owner Portal access using your invitation.',
     href: args.signInLink,
-    subject: `You are invited to join your team on ${args.appName}`,
+    subject: `Your invitation to the ${args.appName} Owner Portal`,
   };
 };
 
-export const InviteOwnerEmailTemplate = (props: ActionEmailTemplateProps) => {
-  return <ActionEmailTemplate {...props} />;
+export const InviteOwnerEmailTemplate = ({
+  ownerAccessRole = 'admin',
+  ...props
+}: ActionEmailTemplateProps & {
+  ownerAccessRole?: 'admin' | 'viewer';
+}) => {
+  return (
+    <ActionEmailTemplate
+      {...props}
+      data={{
+        ...props.data,
+        // Add guidance at render time so saved custom templates receive it too.
+        bodyTwo: `${props.data.bodyTwo}<hr style="width:100%;border:none;border-top:1px solid #eaeaea;margin:24px 0" /><p>This invitation link is for one-time setup of your Owner Portal access and expires after 7 days. Sign up using the exact email address this invitation was sent to.</p><p>If your invitation expires before setup is complete, contact your property manager for a new invitation.</p><p>For questions about ${ownerAccessRole === 'viewer' ? 'portal access' : 'your statements or portal access'}, contact your property manager.</p>`,
+      }}
+    />
+  );
 };

package/src/templates/InvitePmEmailTemplate.tsx

@@ -18,12 +18,11 @@ export const getDefaultInvitePropertyManagerEmailData = (
       : `<a href='${args.signInLink}' target='_blank'>${args.signInLink}</a>`;
 
   return {
-    bodyOne: `<p>You are invited to join us on ${args.appName}.</p><p>To start using ${args.appName}, accept the invitation and verify your email address.</p>`,
+    bodyOne: `<p>You are invited to join us on ${args.appName}.</p><p>Accept the invitation below to set up your team access.</p>`,
     bodyTwo: `<p>If you have any trouble with the button, you can use the following link below: ${signInLink}</p>`,
     buttonText: 'Accept Invitation',
     header: 'Welcome to the team!',
-    shortDescription:
-      'You have been invited to join the team. To start using VRPlatform, verify your email address at link below.',
+    shortDescription: `Accept your invitation to join your team on ${args.appName}.`,
     href: args.signInLink,
     subject: `You are invited to join your team on ${args.appName}`,
   };
@@ -33,6 +32,11 @@ export const InvitePmEmailTemplate = (props: ActionEmailTemplateProps) => {
   return (
     <ActionEmailTemplate
       {...props}
+      data={{
+        ...props.data,
+        // Add guidance at render time so saved custom templates receive it too.
+        bodyTwo: `${props.data.bodyTwo}<hr style="width:100%;border:none;border-top:1px solid #eaeaea;margin:24px 0" /><p>This invitation link is for one-time setup of your team access and expires after 7 days. Sign up using the exact email address this invitation was sent to.</p><p>If your invitation expires before setup is complete, contact your team administrator for a new invitation.</p><p>For questions about team access, contact your team administrator.</p>`,
+      }}
       tenant={{
         logo: undefined,
         name: props.tenant.name,

package/src/types.ts

@@ -2,6 +2,7 @@ export type EmailBaseProps = {
   mode: 'edit' | 'preview' | 'send';
   tenant: {
     name: string;
+    showPlatformBranding?: boolean;
     logo: string | undefined | null;
   };
   listing: string | undefined;

package/src/utils/find-postmark-email.ts

@@ -0,0 +1,80 @@
+import { day } from '@vrplatform/utils';
+import { z } from 'zod';
+import { EmailDeliveryError } from './send-email';
+
+const postmarkMessagesResponseSchema = z.object({
+  TotalCount: z.number().int().nonnegative(),
+  Messages: z.array(
+    z.object({
+      MessageID: z.string().min(1),
+      ReceivedAt: z.string().refine((value) => day(value).isValid()),
+      Metadata: z.object({ deliveryId: z.string() }).passthrough(),
+    })
+  ),
+});
+
+export async function findPostmarkEmail(
+  deliveryId: string,
+  options: {
+    fetch?: (
+      input: string | URL | Request,
+      init?: RequestInit
+    ) => Promise<Response>;
+    postmarkToken?: string;
+  }
+) {
+  if (!options.postmarkToken) {
+    throw new EmailDeliveryError(
+      'Postmark is not configured',
+      undefined,
+      false,
+      false
+    );
+  }
+
+  const url = new URL('https://api.postmarkapp.com/messages/outbound');
+  url.searchParams.set('count', '1');
+  url.searchParams.set('offset', '0');
+  url.searchParams.set('messagestream', 'outbound');
+  url.searchParams.set('metadata_deliveryId', deliveryId);
+  const response = await (options.fetch ?? fetch)(url, {
+    method: 'GET',
+    headers: {
+      Accept: 'application/json',
+      'X-Postmark-Server-Token': options.postmarkToken,
+    },
+  });
+  const providerResponse: unknown = await response.json().catch(() => ({}));
+
+  if (!response.ok) {
+    throw new EmailDeliveryError(
+      'Postmark message lookup failed',
+      {
+        provider: 'postmark',
+        providerCategory: 'rejected',
+        httpStatus: response.status,
+      },
+      false,
+      response.status === 429 || response.status >= 500
+    );
+  }
+
+  const result = postmarkMessagesResponseSchema.safeParse(providerResponse);
+  if (!result.success) {
+    throw new EmailDeliveryError('Postmark returned an invalid response');
+  }
+  if (result.data.TotalCount === 0) return undefined;
+
+  const message = result.data.Messages.find(
+    ({ Metadata }) => Metadata.deliveryId === deliveryId
+  );
+  if (!message) {
+    throw new EmailDeliveryError('Postmark returned an invalid response');
+  }
+
+  return {
+    httpStatus: response.status,
+    messageId: message.MessageID,
+    submittedAt: message.ReceivedAt,
+  };
+}

package/src/utils/index.ts

@@ -1 +1,2 @@
+export * from './find-postmark-email';
 export * from './send-email';

package/src/utils/send-email.ts

@@ -1,14 +1,65 @@
+import { day } from '@vrplatform/utils';
+import { z } from 'zod';
+
+const postmarkErrorCodeSchema = z.number().int().nonnegative();
+const postmarkResponseErrorCodeSchema = z
+  .object({ ErrorCode: postmarkErrorCodeSchema })
+  .transform(({ ErrorCode }) => ErrorCode);
+const postmarkHeaderErrorCodeSchema = z
+  .string()
+  .regex(/^\d+$/)
+  .transform(Number)
+  .pipe(postmarkErrorCodeSchema);
+const postmarkSuccessResponseSchema = z.object({
+  ErrorCode: z.literal(0),
+  MessageID: z.string().min(1),
+  SubmittedAt: z.string().refine((value) => day(value).isValid()),
+});
+
+function parseOptional<T>(schema: z.ZodType<T>, value: unknown) {
+  const result = schema.safeParse(value);
+  if (result.success) return result.data;
+}
+
+type EmailDeliveryFailureDetails = {
+  httpStatus: number;
+  postmarkErrorCode?: number;
+  provider: 'postmark';
+  providerCategory: 'inactiveRecipient' | 'rejected';
+};
+
+type EmailDeliveryErrorDetails =
+  | EmailDeliveryFailureDetails
+  | {
+      failureCount: number;
+      failures: EmailDeliveryFailureDetails[];
+    };
+
 export class EmailDeliveryError extends Error {
   constructor(
     message: string,
-    public readonly details?: Record<string, unknown>,
-    public readonly expected = false
+    public readonly details?: EmailDeliveryErrorDetails,
+    public readonly expected = false,
+    public readonly retryable = true
   ) {
     super(message);
     this.name = 'EmailDeliveryError';
   }
 }
 
+/**
+ * Formats a verified sender address with a display name for the From header.
+ * Registrations store bare addresses; recipients should still see the company
+ * name the way they see `VRPlatform <notifications@vrplatform.app>`.
+ */
+export function formatSenderIdentity(
+  name: string | null | undefined,
+  address: string
+) {
+  const display = (name ?? '').replace(/[\r\n"<>]/g, '').trim();
+  return display ? `"${display}" <${address}>` : address;
+}
+
 export async function sendEmail(
   data: {
     to: string;
@@ -16,6 +67,9 @@ export async function sendEmail(
     text: string;
     html: string;
     replyTo?: string;
+    tag?: string;
+    metadata?: Record<string, string>;
+    from?: string;
   },
   options: {
     fetch?: (
@@ -26,7 +80,12 @@ export async function sendEmail(
   }
 ) {
   if (!options.postmarkToken) {
-    throw new EmailDeliveryError('Postmark is not configured');
+    throw new EmailDeliveryError(
+      'Postmark is not configured',
+      undefined,
+      false,
+      false
+    );
   }
 
   const response = await (options.fetch ?? fetch)(
@@ -39,48 +98,138 @@ export async function sendEmail(
         'X-Postmark-Server-Token': options.postmarkToken,
       },
       body: JSON.stringify({
-        From: 'VRPlatform <notifications@vrplatform.app>',
+        From: data.from ?? 'VRPlatform <notifications@vrplatform.app>',
         To: data.to,
         Subject: data.subject,
         ReplyTo: data.replyTo,
         TextBody: data.text,
         HtmlBody: data.html,
         MessageStream: 'outbound',
+        Tag: data.tag,
+        Metadata: data.metadata,
       }),
     }
   );
 
   const providerResponse: unknown = await response.json().catch(() => ({}));
-  const providerMessage =
-    providerResponse !== null &&
-    typeof providerResponse === 'object' &&
-    'Message' in providerResponse &&
-    typeof providerResponse.Message === 'string'
-      ? providerResponse.Message
-      : undefined;
-
-  if (!response.ok) {
-    if (
-      response.status === 422 &&
-      providerMessage?.includes('marked as inactive')
-    ) {
+  const postmarkErrorCode =
+    parseOptional(postmarkResponseErrorCodeSchema, providerResponse) ??
+    parseOptional(
+      postmarkHeaderErrorCodeSchema,
+      response.headers.get('X-PM-ApiErrorCode')
+    );
+
+  if (
+    !response.ok ||
+    (postmarkErrorCode !== undefined && postmarkErrorCode !== 0)
+  ) {
+    const inactiveRecipient =
+      response.status === 422 && postmarkErrorCode === 406;
+    const details: EmailDeliveryFailureDetails = {
+      provider: 'postmark',
+      providerCategory: inactiveRecipient ? 'inactiveRecipient' : 'rejected',
+      httpStatus: response.status,
+      ...(postmarkErrorCode !== undefined ? { postmarkErrorCode } : {}),
+    };
+
+    if (inactiveRecipient) {
       throw new EmailDeliveryError(
         'Postmark recipient is inactive',
-        {
-          providerMessage,
-          status: response.status,
-          statusText: response.statusText,
-        },
-        true
+        details,
+        true,
+        false
       );
     }
 
-    throw new EmailDeliveryError('Postmark rejected the email', {
-      providerResponse,
-      status: response.status,
-      statusText: response.statusText,
+    throw new EmailDeliveryError(
+      'Postmark rejected the email',
+      details,
+      false,
+      response.status === 429 || response.status >= 500
+    );
+  }
+
+  const result = postmarkSuccessResponseSchema.safeParse(providerResponse);
+  if (!result.success) {
+    throw new EmailDeliveryError('Postmark returned an invalid response', {
+      provider: 'postmark',
+      providerCategory: 'rejected',
+      httpStatus: response.status,
+      ...(postmarkErrorCode !== undefined ? { postmarkErrorCode } : {}),
     });
   }
 
-  return { status: response.status };
+  return {
+    httpStatus: response.status,
+    messageId: result.data.MessageID,
+    submittedAt: result.data.SubmittedAt,
+  };
+}
+
+export async function settleEmailDeliveries(deliveries: Promise<unknown>[]) {
+  const failures = (await Promise.allSettled(deliveries)).filter(
+    (result) => result.status === 'rejected'
+  );
+  if (failures.length === 0) return;
+
+  const unexpectedDeliveryError = failures.find(
+    (failure) =>
+      failure.reason instanceof EmailDeliveryError && !failure.reason.expected
+  )?.reason;
+  const allExpected = failures.every(
+    (failure) =>
+      failure.reason instanceof EmailDeliveryError && failure.reason.expected
+  );
+  const firstDeliveryError = failures.find(
+    (failure) => failure.reason instanceof EmailDeliveryError
+  )?.reason;
+  const failureDetails = failures.flatMap((failure) => {
+    if (
+      !(failure.reason instanceof EmailDeliveryError) ||
+      !failure.reason.details ||
+      !('provider' in failure.reason.details)
+    ) {
+      return [];
+    }
+    const { httpStatus, postmarkErrorCode, provider, providerCategory } =
+      failure.reason.details;
+    return [
+      {
+        httpStatus,
+        provider,
+        providerCategory,
+        ...(postmarkErrorCode !== undefined ? { postmarkErrorCode } : {}),
+      },
+    ];
+  });
+
+  const details: EmailDeliveryErrorDetails = {
+    failureCount: failures.length,
+    failures: failureDetails,
+  };
+  if (unexpectedDeliveryError instanceof EmailDeliveryError) {
+    if (unexpectedDeliveryError.message === 'Postmark is not configured') {
+      throw new EmailDeliveryError(
+        'Postmark is not configured',
+        details,
+        false,
+        false
+      );
+    }
+    throw new EmailDeliveryError(
+      'Postmark rejected the email',
+      details,
+      false,
+      unexpectedDeliveryError.retryable
+    );
+  }
+  if (allExpected && firstDeliveryError instanceof EmailDeliveryError) {
+    throw new EmailDeliveryError(
+      'Postmark recipient is inactive',
+      details,
+      true,
+      false
+    );
+  }
+  throw new EmailDeliveryError('Email delivery failed', details);
 }