@cool-ai/beach-format-email

Email-channel entry point for Beach's Composer primitive. Re-exports EmailHtmlComposer and EmailPlainComposer from @cool-ai/beach-format so consumers can import { EmailHtmlComposer } from '@cool-ai/beach-format-email' when the email path is what they want.

Home: cool-ai.org · Documentation: cool-ai.org/docs

Install

npm install @cool-ai/beach-format-email

Usage

import { EmailHtmlComposer } from '@cool-ai/beach-format-email';
import { annotateRecord } from '@cool-ai/beach-core';

const composer = new EmailHtmlComposer({
  llmRender: async ({ section, narrative, envelope }) => {
    // your AI SDK call — returns the prose-rendered HTML for the section
  },
});

const result = await composer.compose({
  sections: [{ sectionId: 'reply', data: dataRecords }],
  narrative: orchestratorNarrative,
  envelope: {
    channelClass: 'email-html',
    from: '[email protected]',
    to: ['[email protected]'],
    inboundSubject: inbound.subject,
    inReplyToMessageId: inbound.origin.messageId,
    references: inbound.references,
  },
});

if (result.status === 'rendered') {
  await emailChannel.send(result.artifact);
}

The behaviour, the types, the architectural constraints — all in @cool-ai/beach-format. This package is the email-shaped entry point.

What changed at CR-157

The legacy EmailFormatter was removed at CR-157 Phase 4 (no backwards-compat wrapper). The new surface is the parametric Composer<E extends ChannelEnvelope, A> shipped by @cool-ai/beach-format, with EmailHtmlComposer and EmailPlainComposer as the email-specific subclasses. Migration walkthrough: documentation/migrations/cr-157.md.

Related

• beach-format README — the parametric Composer primitive, the seven canonical channel formats, anchored object rendering, the matrix rule set, the validator, and the budget enforcement.
• beach-channel-email README — the outbound edge that sends the EmailHtmlArtifact via SMTP.
• Migration: CR-157 — full migration walkthrough.