@cymbal/atoms-email-renderer 0.0.0

package/dist/index.d.ts

@@ -0,0 +1,527 @@
+declare const directions: readonly ["desc", "asc"];
+type Direction = (typeof directions)[number];
+
+type LookaheadUnit = "days" | "weeks" | "months";
+
+type LegoEventOrderBy = "event-start-time" | "event-published-time";
+
+type AutomationDateVariableFormat = "Mon January 1, 2024" | "January 1, 2024" | "January 1" | "January" | "Jan 1" | "Mon Jan 1" | "Mon 1/1" | "1/1" | "1.1" | "MM/DD/YY" | "Monday" | "In X days" | "Monday, January 1";
+type AutomationTimeVariableFormat = "3:04PM" | "3:04PM MST";
+
+interface DynamicDataSetting {
+    id: number;
+    contact_first_name_all_caps: boolean;
+    contact_full_name_all_caps: boolean;
+    contact_last_name_all_caps: boolean;
+    event_date_all_caps: boolean;
+    event_description_all_caps: boolean;
+    event_name_all_caps: boolean;
+    event_description_character_limit: number;
+    event_date_format: AutomationDateVariableFormat;
+    event_time_format: AutomationTimeVariableFormat;
+    event_door_open_time_format: AutomationTimeVariableFormat;
+}
+type TextEventDynamicDataType = "event-name" | "event-link" | "event-link-with-text" | "event-location-address" | "event-location-name" | "event-lowest-ticket-price" | "event-lineup";
+type DescriptionEventDynamicDataType = "event-description";
+type DateEventDynamicDataType = "event-start-date";
+type TimeEventDynamicDataType = "event-start-time" | "event-door-open-time";
+type ContactDynamicDataType = "contact-first-name" | "contact-last-name" | "contact-full-name";
+type AttributeDynamicDataType = `attribute-${number}`;
+interface BaseDynamicDataConfig {
+    uuid: string;
+    fallback_text: string;
+}
+interface BaseTextDynamicDataConfig extends BaseDynamicDataConfig {
+    all_caps: boolean;
+}
+type TextDynamicDataConfigType = TextEventDynamicDataType | ContactDynamicDataType | AttributeDynamicDataType;
+interface TextDynamicDataConfig extends BaseTextDynamicDataConfig {
+    dynamic_data_type: TextDynamicDataConfigType;
+    config_type: "text";
+}
+interface DateDynamicDataConfig extends BaseTextDynamicDataConfig {
+    dynamic_data_type: DateEventDynamicDataType;
+    date_format: AutomationDateVariableFormat;
+    config_type: "date";
+}
+interface TimeDynamicDataConfig extends BaseTextDynamicDataConfig {
+    dynamic_data_type: TimeEventDynamicDataType;
+    time_format: AutomationTimeVariableFormat;
+    config_type: "time";
+}
+interface DescriptionDynamicDataConfig extends BaseTextDynamicDataConfig {
+    dynamic_data_type: DescriptionEventDynamicDataType;
+    character_limit: number;
+    config_type: "description";
+}
+interface NumberDynamicDataConfig extends BaseDynamicDataConfig {
+    dynamic_data_type: AttributeDynamicDataType;
+    config_type: "number";
+}
+interface WriteWithAISingleEventConfig extends BaseDynamicDataConfig {
+    dynamic_data_type: "write-with-ai-single-event";
+    example_message: string;
+}
+interface WriteWithAIUpcomingEventsConfig extends BaseDynamicDataConfig {
+    dynamic_data_type: "write-with-ai-upcoming-events";
+    example_message: string;
+    event_lookahead_after_unit?: LookaheadUnit;
+    event_lookahead_after_amount?: number;
+    event_lookahead_unit: LookaheadUnit;
+    event_lookahead_amount: number;
+    event_order_by: LegoEventOrderBy;
+    event_order_by_direction: Direction;
+    max_events: number;
+    include_tag_ids: number[];
+    exclude_tag_ids: number[];
+    include_genres: string[];
+    exclude_genres: string[];
+}
+type DynamicDataConfig = WriteWithAISingleEventConfig | WriteWithAIUpcomingEventsConfig | TextDynamicDataConfig | DateDynamicDataConfig | TimeDynamicDataConfig | DescriptionDynamicDataConfig | NumberDynamicDataConfig;
+type DynamicDataConfigs = Record<string, DynamicDataConfig> | null;
+
+type VerticalAlign = "top" | "middle" | "bottom";
+/** Row container: how narrower children align in the cross-axis of a vertical stack. */
+type RowHorizontalAlign = "left" | "center" | "right";
+/**
+ * Positions the atom’s box horizontally within its parent (separate from `textStyles.align`).
+ * `inherit` follows the nearest ancestor row’s `rowsStyles.horizontalAlign` (fallback `left`).
+ */
+type LayoutHorizontalAlign = "inherit" | RowHorizontalAlign;
+interface Padding {
+    top: number;
+    right: number;
+    bottom: number;
+    left: number;
+}
+interface Margin {
+    top: number;
+    bottom: number;
+}
+interface AtomBackgroundColor {
+    type: "color";
+    color: string;
+}
+type AtomBackgroundImageSize = "cover" | "contain" | "auto";
+interface AtomBackgroundImage {
+    type: "image";
+    color: string;
+    imageUrl: string;
+    imageSize: AtomBackgroundImageSize;
+    imageRepeat: boolean;
+}
+type AtomBackground = AtomBackgroundColor | AtomBackgroundImage;
+type AtomBorderSide = "all" | "left" | "right" | "top" | "bottom";
+interface AtomBorder {
+    color: string;
+    width: number;
+    style: "solid" | "dashed" | "dotted";
+    side: AtomBorderSide;
+}
+/** Integer flex weight (default 100); minimum 1. `max: "none"` means uncapped width. */
+interface LayoutWidth {
+    basis: number;
+    max: number | "none";
+}
+interface CornerRadius {
+    topLeft: number;
+    topRight: number;
+    bottomRight: number;
+    bottomLeft: number;
+}
+interface LayoutStyles {
+    margin: Margin;
+    padding: Padding;
+    background: AtomBackground | "none";
+    border: AtomBorder | "none";
+    borderRadius: CornerRadius;
+    width: LayoutWidth;
+    horizontalAlign: LayoutHorizontalAlign;
+}
+type NullableOverride<T> = {
+    [K in keyof T]: T[K] | null;
+};
+/** On atom instances, `null` means “use this element type’s defaults” (same as the matching entry in `globalAtomStyles`). */
+type NullableLayoutStyles = NullableOverride<LayoutStyles>;
+interface AtomTextStyles {
+    color: string;
+    fontWeight: AtomFontWeight;
+    fontStyle: AtomFontStyle;
+    textTransform: AtomTextTransform;
+    textDecoration: AtomTextDecoration;
+    fontSizePx: number;
+    fontFamily: AtomFontFamily;
+    align: AtomTextAlign;
+    lineHeight: number;
+    letterSpacingEm: number;
+}
+type NullableAtomTextStyles = NullableOverride<AtomTextStyles>;
+type TextType = "title" | "subtitle" | "heading" | "subheading" | "section" | "body" | "accent" | "caption" | "promo";
+type AtomTextEventTextType = Exclude<TextType, "promo">;
+type AtomFontWeight = "100" | "200" | "300" | "400" | "500" | "600" | "700" | "800" | "900";
+type AtomFontStyle = "normal" | "italic";
+type AtomTextTransform = "none" | "uppercase" | "lowercase" | "capitalize";
+type AtomTextDecoration = "none" | "underline" | "line-through";
+type AtomTextAlign = "left" | "right" | "center" | "justify";
+type AtomFontFamily = "Consolas" | "Courier" | "Courier New" | "Lucida Console" | "Arial" | "Arial Black" | "Arial Narrow" | "Calibri" | "Franklin Gothic" | "Helvetica" | "Lucida Grande" | "Open Sans" | "Roboto" | "Tahoma" | "Trebuchet MS" | "Verdana" | "Garamond" | "Georgia" | "Times New Roman";
+interface RowsStyles {
+    gap: number;
+    horizontalAlign: RowHorizontalAlign;
+}
+/** Main-axis alignment when column children use less than the container width (e.g. max caps). Default center. */
+interface ColumnsStyles {
+    gap: number;
+    verticalAlign: VerticalAlign;
+    horizontalAlign: RowHorizontalAlign;
+    format: "default" | "table";
+}
+type ColumnsAtomSource = "horizontal-event" | "column-event";
+type RowsAtomSource = "event";
+type TextAtomSource = "event-list" | "form-disclaimer";
+type ButtonAtomSource = "form-submit";
+type ImageAtomSource = "spotify" | "soundcloud" | "youtube";
+interface TextAtom {
+    atomKey: number;
+    type: "text";
+    source: TextAtomSource | null;
+    textType: TextType;
+    text: string;
+    textConfigs: DynamicDataConfigs;
+    textStyles: NullableAtomTextStyles | null;
+    layoutStyles: NullableLayoutStyles | null;
+}
+interface ButtonAtom {
+    atomKey: number;
+    type: "button";
+    source: ButtonAtomSource | null;
+    text: string;
+    textConfigs: DynamicDataConfigs;
+    href: string;
+    hrefConfigs: DynamicDataConfigs;
+    textStyles: NullableAtomTextStyles | null;
+    innerPadding: NullableOverride<Padding> | null;
+    layoutStyles: NullableLayoutStyles | null;
+}
+interface ImageAtom {
+    atomKey: number;
+    type: "image";
+    source: ImageAtomSource | null;
+    src: string;
+    href: string;
+    layoutStyles: NullableLayoutStyles | null;
+}
+interface DividerAtom {
+    atomKey: number;
+    type: "divider";
+    dividerStyles: NullableOverride<AtomBorder> | null;
+    layoutStyles: NullableLayoutStyles | null;
+}
+interface OptionAtom {
+    atomKey: number;
+    id: number | null;
+    hasData: boolean;
+    type: "option";
+    textType: TextType;
+    text: string;
+    textConfigs: DynamicDataConfigs;
+    tags: AtomFormMetadataItem[];
+    genres: string[];
+    lists: AtomFormMetadataItem[];
+    textStyles: NullableAtomTextStyles | null;
+    layoutStyles: NullableLayoutStyles | null;
+}
+type AtomInputType = "name" | "email" | "phone" | "postal-code" | "short-answer" | "long-answer" | "birthday";
+type AtomQuestionType = "radio" | "dropdown" | "checkbox";
+type AtomContestType = "facebook" | "instagram" | "link";
+type AtomEventArrangement = "vertical" | "horizontal-left" | "horizontal-right" | "horizontal-zigzag";
+type AtomEventOrderBy = "event-start-time" | "event-published-time";
+type AtomDirection = "asc" | "desc";
+type AtomLookaheadUnit = "days" | "weeks" | "months";
+interface AtomFormMetadataItem {
+    id: number;
+    name: string;
+}
+interface InputAtom {
+    atomKey: number;
+    id: number | null;
+    hasData: boolean;
+    type: "input";
+    name: string;
+    inputType: AtomInputType;
+    required: boolean;
+    placeholder: string;
+    textStyles: NullableAtomTextStyles | null;
+    innerPadding: NullableOverride<Padding> | null;
+    layoutStyles: NullableLayoutStyles | null;
+}
+interface ContestAtom {
+    atomKey: number;
+    id: number | null;
+    hasData: boolean;
+    type: "contest";
+    contestType: AtomContestType;
+    entriesPerSubmission: number;
+    maxLinkReferrals: number;
+    identifier: string;
+    required: boolean;
+    textStyles: NullableAtomTextStyles | null;
+    innerPadding: NullableOverride<Padding> | null;
+    layoutStyles: NullableLayoutStyles | null;
+}
+interface QuestionAtom {
+    atomKey: number;
+    id: number | null;
+    hasData: boolean;
+    type: "question";
+    name: string;
+    questionType: AtomQuestionType;
+    required: boolean;
+    allowMultiple: boolean;
+    children: OptionAtom[];
+    rowsStyles: NullableOverride<RowsStyles> | null;
+    innerPadding: NullableOverride<Padding> | null;
+    layoutStyles: NullableLayoutStyles | null;
+}
+interface FormAtom {
+    atomKey: number;
+    id: number | null;
+    hasData: boolean;
+    type: "form";
+    name: string;
+    buttonText: string;
+    redirectUrl: string;
+    customHeaderHtml: string;
+    emailRecipients: string[];
+    tags: AtomFormMetadataItem[];
+    genres: string[];
+    lists: AtomFormMetadataItem[];
+    children: Atom[];
+    successChildren: Atom[] | null;
+    belowSubmitChildren: Atom[];
+    rowsStyles: NullableOverride<RowsStyles> | null;
+    layoutStyles: NullableLayoutStyles | null;
+}
+interface AutomationUpcomingEventsAtom {
+    atomKey: number;
+    type: "automation-upcoming-events";
+    eventStyle: AtomEventStyle;
+    eventArrangement: AtomEventArrangement;
+    eventOrderBy: AtomEventOrderBy;
+    eventOrderByDirection: AtomDirection;
+    eventLookaheadAfterUnit: AtomLookaheadUnit;
+    eventLookaheadAfterAmount: number;
+    eventLookaheadUnit: AtomLookaheadUnit;
+    eventLookaheadAmount: number;
+    maxEvents: number;
+    matchTriggeredEventTags: boolean;
+    tags: AtomFormMetadataItem[];
+    genres: string[];
+    excludeTags: AtomFormMetadataItem[];
+    excludeGenres: string[];
+    layoutStyles: NullableLayoutStyles | null;
+}
+interface AutomationTriggeredEventAtom {
+    atomKey: number;
+    type: "automation-triggered-event";
+    eventStyle: AtomEventStyle;
+    eventArrangement: Exclude<AtomEventArrangement, "horizontal-zigzag">;
+    layoutStyles: NullableLayoutStyles | null;
+}
+interface RowsAtom {
+    atomKey: number;
+    type: "rows";
+    source: RowsAtomSource | null;
+    children: Atom[];
+    rowsStyles: NullableOverride<RowsStyles> | null;
+    layoutStyles: NullableLayoutStyles | null;
+}
+interface ColumnsAtom {
+    atomKey: number;
+    type: "columns";
+    source: ColumnsAtomSource | null;
+    children: Atom[];
+    columnsStyles: NullableOverride<ColumnsStyles> | null;
+    layoutStyles: NullableLayoutStyles | null;
+}
+type Atom = RowsAtom | ColumnsAtom | TextAtom | ButtonAtom | ImageAtom | DividerAtom | OptionAtom | InputAtom | ContestAtom | QuestionAtom | FormAtom | AutomationUpcomingEventsAtom | AutomationTriggeredEventAtom;
+interface GlobalAtomStyles {
+    titleStyles: {
+        textStyles: AtomTextStyles;
+        layoutStyles: LayoutStyles;
+    };
+    subtitleStyles: {
+        textStyles: AtomTextStyles;
+        layoutStyles: LayoutStyles;
+    };
+    headingStyles: {
+        textStyles: AtomTextStyles;
+        layoutStyles: LayoutStyles;
+    };
+    subheadingStyles: {
+        textStyles: AtomTextStyles;
+        layoutStyles: LayoutStyles;
+    };
+    sectionStyles: {
+        textStyles: AtomTextStyles;
+        layoutStyles: LayoutStyles;
+    };
+    bodyStyles: {
+        textStyles: AtomTextStyles;
+        layoutStyles: LayoutStyles;
+    };
+    accentStyles: {
+        textStyles: AtomTextStyles;
+        layoutStyles: LayoutStyles;
+    };
+    captionStyles: {
+        textStyles: AtomTextStyles;
+        layoutStyles: LayoutStyles;
+    };
+    buttonStyles: {
+        textStyles: AtomTextStyles;
+        innerPadding: Padding;
+        layoutStyles: LayoutStyles;
+    };
+    promoStyles: {
+        textStyles: AtomTextStyles;
+        innerPadding: Padding;
+        layoutStyles: LayoutStyles;
+    };
+    imageStyles: {
+        layoutStyles: LayoutStyles;
+    };
+    dividerStyles: {
+        dividerStyles: AtomBorder;
+        layoutStyles: LayoutStyles;
+    };
+    columnsStyles: {
+        columnsStyles: ColumnsStyles;
+        layoutStyles: LayoutStyles;
+    };
+    rowsStyles: {
+        rowsStyles: RowsStyles;
+        layoutStyles: LayoutStyles;
+    };
+    inputStyles: {
+        textStyles: AtomTextStyles;
+        innerPadding: Padding;
+        layoutStyles: LayoutStyles;
+    };
+    formStyles: {
+        rowsStyles: RowsStyles;
+        layoutStyles: LayoutStyles;
+    };
+    questionStyles: {
+        rowsStyles: RowsStyles;
+        innerPadding: Padding;
+        layoutStyles: LayoutStyles;
+    };
+    optionStyles: {
+        textStyles: AtomTextStyles;
+        layoutStyles: LayoutStyles;
+    };
+    singleEventStyles: AtomEventStyle;
+    twoColumnEventStyles: AtomEventStyle;
+    threeColumnEventStyles: AtomEventStyle;
+    horizontalEventStyles: AtomEventStyle;
+    textEventStyles: AtomTextEventStyle;
+    socialStyles: AtomSocialStyle;
+}
+interface AtomDocument {
+    id: number;
+    org_id: number;
+    public_uuid: string;
+    contents: AtomDocumentContents;
+}
+interface AtomDocumentContents {
+    type: "contents";
+    rootRow: RowsAtom;
+    globalAtomStyles: GlobalAtomStyles;
+    maxWidth: number;
+    linkColor: string;
+    underlineLinks: boolean;
+    pagesMaxWidth: number;
+    canvasBackground: AtomBackground | "none";
+}
+interface AtomSocialIconOrdinals {
+    facebookOrdinal: number;
+    xOrdinal: number;
+    instagramOrdinal: number;
+    tiktokOrdinal: number;
+    youtubeOrdinal: number;
+    websiteOrdinal: number;
+    spotifyOrdinal: number;
+    discordOrdinal: number;
+    soundcloudOrdinal: number;
+    appleMusicOrdinal: number;
+    threadsOrdinal: number;
+}
+type AtomSocialIconStyle = "color" | "white" | "black";
+interface AtomSocialStyle {
+    iconStyle: AtomSocialIconStyle;
+    ordinals: AtomSocialIconOrdinals;
+    facebookUrl: string;
+    instagramUrl: string;
+    xUrl: string;
+    spotifyUrl: string;
+    tiktokUrl: string;
+    youtubeUrl: string;
+    websiteUrl: string;
+    discordUrl: string;
+    soundcloudUrl: string;
+    appleMusicUrl: string;
+    threadsUrl: string;
+}
+type AtomTimeFormat = "1/2" | "1/2, 3:04PM" | "Jan 2, 3:04PM" | "January 2" | "January 2, 3:04PM" | "Mon 1/2" | "Mon, 1/2, 3:04PM" | "Mon Jan 2" | "Mon, Jan 2, 3:04PM" | "Mon, January 2, 3:04PM" | "Monday 1/2" | "Monday Jan 2" | "Monday, January 2" | "Monday, January 2, 3:04PM";
+type AtomLocationFormat = "name, address" | "name\naddress" | "name" | "address" | "city, state" | "city" | "state";
+interface AtomEventStyleOrdinals {
+    image: number;
+    name: number;
+    datetime: number;
+    button: number;
+    location: number;
+    description: number;
+    doorOpenTime: number;
+}
+interface AtomEventStyle {
+    timeFormat: AtomTimeFormat;
+    locationFormat: AtomLocationFormat;
+    doorOpenTimeFormat: AtomTimeFormat;
+    descriptionCharacterLimit: number;
+    buttonText: string;
+    nameTextType: TextType;
+    datetimeTextType: TextType;
+    locationTextType: TextType;
+    descriptionTextType: TextType;
+    doorOpenTimeTextType: TextType;
+    ordinals: AtomEventStyleOrdinals;
+    includeImage: boolean;
+    includeName: boolean;
+    includeDatetime: boolean;
+    includeButton: boolean;
+    includeLocation: boolean;
+    includeDescription: boolean;
+    includeDoorOpenTime: boolean;
+    nameUseCaps: boolean;
+    timeFormatUseCaps: boolean;
+    buttonUseCaps: boolean;
+    locationUseCaps: boolean;
+    descriptionUseCaps: boolean;
+    doorOpenTimeUseCaps: boolean;
+    imageCropToSquare: boolean;
+    horizontalIsReversed: boolean;
+    scaleFontSizeDownInColumns: boolean;
+}
+type AtomDynamicDataSetting = Omit<DynamicDataSetting, "id">;
+interface AtomTextEventStyle {
+    text: string;
+    textConfigs: DynamicDataConfigs;
+    eventLinkText: string;
+    textType: AtomTextEventTextType;
+    dynamicDataSetting: AtomDynamicDataSetting;
+}
+
+declare function renderAtomDocumentToHtml(doc: AtomDocumentContents): Promise<string>;
+
+export { renderAtomDocumentToHtml };
+export type { Atom, AtomDocument, AutomationTriggeredEventAtom, AutomationUpcomingEventsAtom, ContestAtom, FormAtom, InputAtom, OptionAtom, QuestionAtom };