Track HiveGrid Cloud planning reference

This commit is contained in:
david committed 2026-06-26 20:48:01 +02:00
1 parent b3d5ea6764
commit e341c5938a
5784 files changed
+1104929 -3

No files matched your search

@@ -0,0 +1,49 @@
import { useLoaderData } from "react-router";
import { useTranslation } from "react-i18next";
import { Colors } from "~/application/enums/shared/Colors";
import ColorBadge from "~/components/ui/badges/ColorBadge";
import { useLocaleFormatters } from "~/locale/format";
import { EmailMarketing_Summary } from "../routes/EmailMarketing_Summary";
export default function EmailMarketingSummaryRoute() {
const { t } = useTranslation();
const formatters = useLocaleFormatters();
const data = useLoaderData<EmailMarketing_Summary.LoaderData>();
return (
<div className="mx-auto mb-12 max-w-5xl space-y-5 px-4 py-4 sm:px-6 lg:px-8 xl:max-w-7xl">
<div className="border-border border-b pb-5">
<h3 className="text-foreground text-lg leading-6 font-medium">{t("shared.overview")}</h3>
</div>
<dl className="grid gap-2 sm:grid-cols-3">
<div className="bg-card border-border overflow-hidden rounded-lg border px-4 py-3 shadow-xs">
<dt className="text-muted-foreground truncate text-xs font-medium uppercase">
<div>{t("emailMarketing:overview.avgOpenRate")}</div>
</dt>
<dd className="text-foreground mt-1 truncate text-2xl font-semibold">
{formatters.percent(data.summary.avgOpenRate / 100, { minimumFractionDigits: 2, maximumFractionDigits: 2 })}
</dd>
</div>
<div className="bg-card border-border overflow-hidden rounded-lg border px-4 py-3 shadow-xs">
<dt className="text-muted-foreground truncate text-xs font-medium uppercase">
<div>{t("emailMarketing:overview.avgClickRate")}</div>
</dt>
<dd className="text-foreground mt-1 truncate text-2xl font-semibold">
{formatters.percent(data.summary.avgClickRate / 100, { minimumFractionDigits: 2, maximumFractionDigits: 2 })}
</dd>
</div>
<div className="bg-card border-border overflow-hidden rounded-lg border px-4 py-3 shadow-xs">
<dt className="text-muted-foreground flex items-center space-x-2 truncate text-xs font-medium uppercase">
<ColorBadge color={Colors.GREEN} />
<div>{t("emailMarketing:overview.totalSent")}</div>
</dt>
<dd className="text-foreground mt-1 flex items-baseline space-x-1 truncate text-2xl font-semibold">
<div>
{formatters.number(data.summary.outboundEmails.delivered)}/{formatters.number(data.summary.outboundEmails.sent)}
</div>
<div className="text-muted-foreground text-xs font-normal lowercase">{t("emails.delivered")}</div>
</dd>
</div>
</dl>
</div>
);
}
@@ -0,0 +1,48 @@
import { useState } from "react";
import { useTranslation } from "react-i18next";
import FormGroup from "~/components/ui/forms/FormGroup";
import InputSelect from "~/components/ui/input/InputSelect";
import InputText from "~/components/ui/input/InputText";
import { useRootData } from "~/utils/data/useRootData";
import { EmailSenderWithoutApiKey } from "~/modules/emailMarketing/db/emailSender";
interface Props {
item?: EmailSenderWithoutApiKey;
}
export default function EmailSenderForm({ item }: Props) {
const { t } = useTranslation();
const rootData = useRootData();
const [provider, setProvider] = useState<string>(item?.provider ?? "mailjet");
const [stream, setStream] = useState<string>(item?.stream ?? "default");
const [apiKey, setApiKey] = useState<string>("*******************");
const [secretKey, setSecretKey] = useState<string>("*******************");
const [fromEmail, setFromEmail] = useState<string>(item?.fromEmail ?? "marketing@" + rootData.appConfiguration.app.domain);
// const [fromName, setFromName] = useState<string>(item?.fromName ?? "");
// const [replyToEmail, setReplyToEmail] = useState<string>(item?.replyToEmail ?? "");
return (
<FormGroup id={item?.id} editing={true}>
{/* <input type="hidden" name="order" value={order} hidden readOnly /> */}
<InputSelect
name="provider"
title={t("emailMarketing:senders.provider")}
value={provider}
setValue={(e) => setProvider(e?.toString() ?? "")}
options={[
{
name: "Mailjet",
value: "mailjet",
},
]}
required
/>
<InputText name="stream" title={t("emailMarketing:senders.stream") + " / Domain ID"} value={stream} setValue={setStream} required />
<InputText type="password" name="apiKey" title={t("emailMarketing:senders.apiKey")} value={apiKey} setValue={setApiKey} required disabled={!!item} />
<InputText type="password" name="secretKey" title={t("emailMarketing:senders.secretKey")} value={secretKey} setValue={setSecretKey} required disabled={!!item} />
<InputText name="fromEmail" title={t("emailMarketing:senders.fromEmail")} value={fromEmail} setValue={setFromEmail} required />
{/* <InputText name="fromName" title={t("emailMarketing:senders.fromName")} value={fromName} setValue={setFromName} />
<InputText name="replyToEmail" title={t("emailMarketing:senders.replyToEmail")} value={replyToEmail} setValue={setReplyToEmail} /> */}
</FormGroup>
);
}
@@ -0,0 +1,233 @@
import { Link, useParams } from "react-router";
import clsx from "clsx";
import { useEffect, useMemo, useState } from "react";
import { useTranslation } from "react-i18next";
import { PaginationDto } from "~/application/dtos/data/PaginationDto";
import { RowHeaderDisplayDto } from "~/application/dtos/data/RowHeaderDisplayDto";
import { Colors } from "~/application/enums/shared/Colors";
import { OutboundEmailWithDetails } from "~/modules/emailMarketing/db/outboundEmails.db.server";
import { EntityWithDetails } from "~/utils/db/entities/entities.db.server";
import RowHelper from "~/utils/helpers/RowHelper";
import SimpleBadge from "~/components/ui/badges/SimpleBadge";
import CheckIcon from "~/components/ui/icons/CheckIcon";
import XIcon from "~/components/ui/icons/XIcon";
import Modal from "~/components/ui/modals/Modal";
import TableSimple from "~/components/ui/tables/TableSimple";
import { adminPath, appPath } from "~/utils/app/CanonicalUrlUtils";
import { createLocaleFormatters, useLocaleFormatters } from "~/locale/format";
export default function OutboundEmailsTable({
items,
pagination,
withCampaign,
allEntities,
}: {
items: OutboundEmailWithDetails[];
pagination?: PaginationDto;
withCampaign?: boolean;
allEntities: EntityWithDetails[];
}) {
const { t, i18n } = useTranslation();
const formatters = useMemo(() => createLocaleFormatters(i18n.language), [i18n.language]);
const params = useParams();
const [headers, setHeaders] = useState<RowHeaderDisplayDto<OutboundEmailWithDetails>[]>([]);
const [contactEntity, setContactEntity] = useState<EntityWithDetails>();
const [selectedEmail, setSelectedEmail] = useState<OutboundEmailWithDetails>();
useEffect(() => {
setContactEntity(allEntities.find((e) => e.name === "contact"));
}, [allEntities]);
useEffect(() => {
let headers: RowHeaderDisplayDto<OutboundEmailWithDetails>[] = [
{
name: "email",
title: t("emails.to"),
value: (i) => (
<div className="flex flex-col">
<div>
{i.contactRow && contactEntity ? (
<div>{RowHelper.getTextDescription({ entity: contactEntity, item: i.contactRow, t })}</div>
) : (
<div className="text-muted-foreground text-xs italic">
<div>{i.email}</div>
</div>
)}
</div>
</div>
),
},
{
name: "sentAt",
title: t("emails.sentAt"),
value: (i) => (
<div className="flex justify-center">{i.sentAt ? <OutboundEmailDateFormat date={i.sentAt} /> : <XIcon className="h-4 w-4 text-red-500" />}</div>
),
},
{
name: "delivered",
title: t("emails.delivered"),
value: (i) => (
<div className="flex justify-center">
{i.deliveredAt ? <CheckIcon className="h-4 w-4 text-teal-500" /> : <XIcon className="h-4 w-4 text-red-500" />}
</div>
),
},
{
name: "activity",
title: t("emailMarketing:activity"),
value: (i) => (
<div className="flex flex-col justify-start space-y-1 text-left">
<button
type="button"
disabled={i.opens.length === 0}
onClick={() => setSelectedEmail(i)}
className={clsx(
i.opens.length === 0 ? "text-muted-foreground cursor-not-allowed text-left" : "text-blue-600 underline",
"text-muted-foreground lowercase"
)}
>
{formatters.number(i.opens.length)} {t("emails.opens")}
</button>
<button
type="button"
disabled={i.clicks.length === 0}
onClick={() => setSelectedEmail(i)}
className={clsx(
i.clicks.length === 0 ? "text-muted-foreground cursor-not-allowed text-left" : "text-blue-600 underline",
"text-muted-foreground lowercase"
)}
>
{formatters.number(i.clicks.length)} {t("emails.clicks")}
</button>
</div>
),
},
{
name: "error",
title: t("shared.error"),
value: (i) => <div className="text-red-500">{i.error}</div>,
},
{
name: "unsubscribedAt",
title: t("emails.unsubscribedAt"),
value: (i) => <OutboundEmailDateFormat date={i.unsubscribedAt} />,
},
{
name: "bouncedAt",
title: t("emails.bouncedAt"),
value: (i) => <OutboundEmailDateFormat date={i.bouncedAt} />,
},
{
name: "spamComplainedAt",
title: t("emails.spamComplainedAt"),
value: (i) => <OutboundEmailDateFormat date={i.spamComplainedAt} />,
},
];
if (withCampaign) {
headers = [
{
name: "campaignId",
title: t("emailMarketing:campaign"),
value: (item) => (
<div>
{item.campaignId ? (
<Link
to={
params.tenant
? appPath({ tenantSlug: params.tenant, path: `email-marketing/campaigns/${item.campaignId}`, mode: "host-aware" })
: adminPath(`email-marketing/campaigns/${item.campaignId}`, { mode: "host-aware" })
}
className="focus:bg-secondary/90 hover:border-border rounded-md border-b border-dashed border-transparent"
>
{item.campaign?.name}
</Link>
) : (
<div>{item.isPreview ? <SimpleBadge title={t("shared.preview")} color={Colors.GRAY} /> : <div>-</div>}</div>
)}
</div>
),
},
...headers,
];
}
setHeaders(headers);
}, [contactEntity, formatters, params.tenant, t, withCampaign]);
return (
<div>
<TableSimple headers={headers} items={items} pagination={pagination} />
<Modal className="sm:max-w-md" open={!!selectedEmail} setOpen={() => setSelectedEmail(undefined)}>
<div className="space-y-2">
<div>
<h3 className="text-foreground text-lg font-medium leading-6">{t("emails.emailActivity")}</h3>
</div>
<div className="border-border overflow-hidden rounded-md border-2 border-dashed">
<div className="h-64 overflow-y-auto">{selectedEmail && <OutboundEmailActivity email={selectedEmail} />}</div>
</div>
</div>
</Modal>
</div>
);
}
function OutboundEmailDateFormat({ date }: { date: Date | null }) {
const formatters = useLocaleFormatters();
return (
<>
{date && (
<div title={formatters.dateTime(date, { timeStyle: "medium" })} className="flex flex-col">
<div>{formatters.date(date, { dateStyle: "medium" })}</div>
<div className="text-xs">{formatters.relativeDate(date)}</div>
</div>
)}
</>
);
}
function OutboundEmailActivity({ email }: { email: OutboundEmailWithDetails }) {
const { t } = useTranslation();
const formatters = useLocaleFormatters();
const [items, setItems] = useState<{ type: "click" | "open"; createdAt: Date; description: string }[]>([]);
useEffect(() => {
const items: { type: "click" | "open"; createdAt: Date; description: string }[] = [];
email.opens.forEach((o) => {
items.push({
type: "open",
createdAt: o.createdAt,
description: o.firstOpen ? t("emailMarketing:activityLog.firstOpen") : "",
});
});
email.clicks.forEach((c) => {
items.push({
type: "click",
createdAt: c.createdAt,
description: c.link,
});
});
setItems(items.sort((a, b) => (b.createdAt > a.createdAt ? -1 : 1)));
}, [email, t]);
return (
<TableSimple
items={items}
headers={[
{
name: "createdAt",
title: t("emailMarketing:activityLog.date"),
value: (i) => <div className="text-muted-foreground">{formatters.dateTime(i.createdAt, { timeStyle: "medium" })}</div>,
},
{
name: "type",
title: t("emailMarketing:activityLog.type"),
value: (i) => (i.type === "open" ? t("emailMarketing:activityLog.open") : t("emailMarketing:activityLog.click")),
},
{
name: "description",
title: t("shared.description"),
value: (i) => i.description,
className: "w-full",
},
]}
/>
);
}
@@ -0,0 +1,324 @@
import { useParams, useSubmit, Form, useActionData, useNavigation, useLoaderData } from "react-router";
import clsx from "clsx";
import { useState, useRef, useEffect, FormEvent } from "react";
import { useTranslation } from "react-i18next";
import { Colors } from "~/application/enums/shared/Colors";
import ButtonPrimary from "~/components/ui/buttons/ButtonPrimary";
import ButtonSecondary from "~/components/ui/buttons/ButtonSecondary";
import ButtonTertiary from "~/components/ui/buttons/ButtonTertiary";
import InputSearch from "~/components/ui/input/InputSearch";
import InputSelector from "~/components/ui/input/InputSelector";
import InputText from "~/components/ui/input/InputText";
import EditPageLayout from "~/components/ui/layouts/EditPageLayout";
import ConfirmModal, { RefConfirmModal } from "~/components/ui/modals/ConfirmModal";
import { useAppOrAdminData } from "~/utils/data/useAppOrAdminData";
import { RowWithDetails } from "~/utils/db/entities/rows.db.server";
import { Campaigns_Edit } from "../../routes/Campaigns_Edit";
import OutboundEmailsTable from "../OutboundEmailsTable";
import toast from "react-hot-toast";
import InputContent from "~/components/ui/input/InputContent";
import UrlUtils from "~/utils/app/UrlUtils";
import { useLocaleFormatters } from "~/locale/format";
export default function CampaignsEditRoute() {
const { t } = useTranslation();
const formatters = useLocaleFormatters();
const appOrAdminData = useAppOrAdminData();
const params = useParams();
const data = useLoaderData<Campaigns_Edit.LoaderData>();
const actionData = useActionData<Campaigns_Edit.ActionData>();
const navigation = useNavigation();
const submit = useSubmit();
const confirmDelete = useRef<RefConfirmModal>(null);
const [searchInput, setSearchInput] = useState("");
const [maxDisplayedEmails, setMaxDisplayedEmails] = useState(1000000);
const [name, setName] = useState(data.item.name);
const [subject, setSubject] = useState(data.item.subject);
const [senderId, setSenderId] = useState<string | number | undefined>(data.item.emailSenderId);
const [contentType, setContentType] = useState<"wysiwyg" | "markdown">("wysiwyg");
const [htmlBody, setHtmlBody] = useState(data.item.htmlBody);
const recipientCount = data.item.recipients.length;
const formattedRecipientCount = formatters.number(recipientCount);
const modalConfirm = useRef<RefConfirmModal>(null);
useEffect(() => {
if (actionData?.success) {
toast.success(actionData.success);
} else if (actionData?.error) {
toast.error(actionData.error);
}
}, [actionData]);
function handleSubmit(e: FormEvent<HTMLFormElement>) {
e.stopPropagation();
e.preventDefault();
const formData = new FormData(e.currentTarget);
submit(formData, {
method: "post",
});
}
function sendTest(i?: RowWithDetails) {
const email = window.prompt(t("emails.object"), appOrAdminData.user?.email);
if (!email || email.trim() === "") {
return;
}
const form = new FormData();
form.set("action", "send-preview");
form.set("email", email);
submit(form, {
method: "post",
});
}
function send() {
modalConfirm.current?.show(
t("emailMarketing:confirmSend"),
t("shared.send"),
t("shared.back"),
t("emailMarketing:sendingToContacts", { count: recipientCount, formattedCount: formattedRecipientCount })
);
}
function onConfirmSend() {
const form = new FormData();
form.set("action", "send");
submit(form, {
method: "post",
});
}
function onDelete() {
confirmDelete.current?.show(t("shared.delete"), t("shared.delete"), t("shared.cancel"), t("shared.warningCannotUndo"));
}
function onDeleteConfirm() {
const form = new FormData();
form.set("action", "delete");
submit(form, {
method: "post",
});
}
// function saveEmail() {
// const form = new FormData();
// form.set("action", "update");
// form.set("htmlBody", htmlBody);
// submit(form, {
// method: "post",
// });
// }
function canUpdate() {
if (data.item.status !== "draft") {
return false;
}
if (
name.trim() === "" ||
name !== data.item.name ||
subject.trim() === "" ||
subject !== data.item.subject ||
senderId !== data.item.emailSenderId ||
htmlBody.trim() !== data.item.htmlBody.trim()
) {
return true;
}
return false;
}
function filteredRecipients() {
let emails = data.item.recipients;
// if (maxDisplayedEmails === 10) {
// emails = emails.slice(0, 10);
// }
if (!searchInput.trim()) {
return emails;
}
return emails.filter((f) => f.email?.toString().toUpperCase().includes(searchInput.toUpperCase()));
}
return (
<EditPageLayout
title={t("emailMarketing:campaignDetails")}
menu={[
{
title: t("emailMarketing:campaigns"),
routePath: UrlUtils.getModulePath(params, "email-marketing/campaigns"),
},
{
title: t("shared.edit"),
routePath: UrlUtils.getModulePath(params, `email-marketing/campaigns/${params.id}`),
},
]}
>
<Form onSubmit={handleSubmit} className="pb-20">
{/* <input type="hidden" name="action" value="create" hidden readOnly /> */}
<input type="hidden" name="action" value="update" hidden readOnly />
<div className="relative space-y-4">
<div className="flex flex-col space-y-4">
{/* <InputGroup title="Email" className="bg-secondary"> */}
<div className="space-y-4">
<div className="grid gap-2 sm:grid-cols-3">
<InputSelector
name="status"
title={t("shared.status")}
value={data.item.status}
withColors={true}
disabled={true}
options={[
{
value: "draft",
name: t("emailMarketing:campaignList.status.draft"),
color: Colors.YELLOW,
},
{
value: "sending",
name: t("emailMarketing:campaignList.status.sending"),
color: Colors.ORANGE,
},
{
value: "incomplete",
name: t("emailMarketing:campaignList.status.incomplete"),
color: Colors.RED,
},
{
value: "completed",
name: t("emailMarketing:campaignList.status.completed"),
color: Colors.GREEN,
},
].map((i) => {
return {
value: i.value,
name: i.name,
color: i.color,
};
})}
/>
<InputText
name="name"
title={t("shared.name")}
value={name}
setValue={setName}
placeholder={t("emailMarketing:campaignList.form.namePlaceholder")}
required
disabled={data.item.status !== "draft"}
/>
<InputSelector
name="senderId"
title={t("emails.sender")}
value={senderId}
setValue={setSenderId}
disabled={data.item.status !== "draft"}
withSearch={false}
options={data.emailSenders.map((s) => {
return {
name: s.fromEmail,
value: s.id,
};
})}
required
/>
<InputText
className="sm:col-span-3"
name="subject"
title={t("emails.subject")}
value={subject}
setValue={setSubject}
required
disabled={data.item.status !== "draft"}
/>
<div className="sm:col-span-3">
<div className="w-full space-y-2">
{/* <Tabs
asLinks={false}
onSelected={(selected) => {
setEmailBodyTab(selected === 0 ? "html" : "text");
}}
className="w-full sm:w-auto"
tabs={[{ name: "HTML" }, { name: "Preview" }]}
/> */}
<div>
{data.item.status === "draft" && <input type="hidden" name="htmlBody" value={htmlBody} hidden readOnly />}
{/* {emailBodyTab === "html" && ( */}
<div className={clsx(data.item.status === "draft" ? "bg-background" : "bg-secondary/90")}>
<InputContent
name="htmlBody"
value={htmlBody}
onChangeValue={setHtmlBody}
contentType={contentType}
onChangeContentType={setContentType}
disabled={data.item.status === "completed"}
/>
</div>
{data.item.status === "draft" && (
<div className="mt-2 flex justify-end">
<ButtonSecondary type="submit" disabled={!canUpdate()}>
{t("shared.saveChanges")}
</ButtonSecondary>
</div>
)}
{/* )} */}
</div>
</div>
</div>
</div>
</div>
{/* </InputGroup> */}
<div className="">
<div className="space-y-2">
<div className="flex justify-between">
<div className="text-foreground text-sm font-medium">
{t("emails.recipientsCount", { count: recipientCount, formattedCount: formattedRecipientCount })}
</div>
</div>
<InputSearch value={searchInput} setValue={setSearchInput} />
<div className="bg-background max-h-96 overflow-auto rounded-md shadow-md">
<OutboundEmailsTable allEntities={data.allEntities} items={filteredRecipients()} />
</div>
<div className="flex justify-end">
{maxDisplayedEmails === 10 && (
<ButtonTertiary onClick={() => setMaxDisplayedEmails(100000)}>
{t("emailMarketing:campaignList.actions.showRecipients", { count: recipientCount, formattedCount: formattedRecipientCount })}
</ButtonTertiary>
)}
</div>
</div>
</div>
{data.item.status === "draft" && (
<div className="flex items-center justify-between">
<div>
{data.item.status === "draft" && (
<ButtonSecondary
destructive
onClick={onDelete}
disabled={data.item.status !== "draft" || navigation.state === "submitting"}
className="truncate"
>
{t("shared.delete")}
</ButtonSecondary>
)}
</div>
<div className="flex justify-between space-x-2">
<ButtonSecondary disabled={navigation.state === "submitting"} onClick={() => sendTest()} className="truncate">
{t("emailMarketing:sendPreview")}
</ButtonSecondary>
<ButtonPrimary disabled={navigation.state === "submitting"} onClick={send} className="truncate">
{t("emailMarketing:sendCampaignToContacts", { count: recipientCount, formattedCount: formattedRecipientCount })}
</ButtonPrimary>
</div>
</div>
)}
</div>
</div>
</Form>
<ConfirmModal ref={modalConfirm} onYes={onConfirmSend} />
<ConfirmModal ref={confirmDelete} onYes={onDeleteConfirm} destructive />
</EditPageLayout>
);
}
@@ -0,0 +1,207 @@
import { useParams, useLoaderData, useSearchParams } from "react-router";
import { useTranslation } from "react-i18next";
import { Colors } from "~/application/enums/shared/Colors";
import SimpleBadge from "~/components/ui/badges/SimpleBadge";
import WarningBanner from "~/components/ui/banners/WarningBanner";
import ButtonPrimary from "~/components/ui/buttons/ButtonPrimary";
import SentIconFilled from "~/components/ui/icons/emails/SentIconFilled";
import TableSimple from "~/components/ui/tables/TableSimple";
import TabsWithIcons from "~/components/ui/tabs/TabsWithIcons";
import UrlUtils from "~/utils/app/UrlUtils";
import { Campaigns_List } from "../../routes/Campaigns_List";
import { useLocaleFormatters } from "~/locale/format";
export default function CampaignsListRoute() {
const { t } = useTranslation();
const formatters = useLocaleFormatters();
const data = useLoaderData<Campaigns_List.LoaderData>();
const params = useParams();
const [searchParams] = useSearchParams();
function countStatus(status?: string) {
if (!status) {
let total = 0;
data.groupByStatus.forEach((item) => {
total += item.count;
});
return total;
}
const item = data.groupByStatus.find((item) => item.status === status);
return item ? item.count : 0;
}
function tabLabel(key: "all" | "draft" | "sending" | "incomplete" | "completed", count: number) {
return t(`emailMarketing:campaignList.tabs.${key}`, { count, formattedCount: formatters.number(count) });
}
return (
<div className="mx-auto mb-12 max-w-5xl space-y-5 px-4 py-4 sm:px-6 lg:px-8 xl:max-w-7xl">
<div className="flex items-center justify-between space-x-2">
<div className="flex-grow">
<TabsWithIcons
tabs={[
{
name: tabLabel("all", countStatus()),
href: "?",
current: !searchParams.get("status") || searchParams.get("status") === "all",
},
{
name: tabLabel("draft", countStatus("draft")),
href: "?status=draft",
current: searchParams.get("status") === "draft",
},
{
name: tabLabel("sending", countStatus("sending")),
href: "?status=sending",
current: searchParams.get("status") === "sending",
},
{
name: tabLabel("incomplete", countStatus("incomplete")),
href: "?status=incomplete",
current: searchParams.get("status") === "incomplete",
},
{
name: tabLabel("completed", countStatus("completed")),
href: "?status=completed",
current: searchParams.get("status") === "completed",
},
]}
/>
</div>
<div>
<ButtonPrimary to="new">
<div>{t("shared.new")}</div>
<SentIconFilled className="h-5 w-5" />
</ButtonPrimary>
</div>
</div>
{data.emailSenders.length === 0 && (
<WarningBanner
title={t("shared.warning")}
text={t("emailMarketing:senders.requiredForCampaign")}
redirect={UrlUtils.getModulePath(params, "email-marketing/senders")}
/>
)}
<TableSimple
items={data.items}
actions={[
{
title: t("shared.overview"),
onClickRoute: (_, i) => `${i.id}`,
},
]}
headers={[
{
name: "campaign",
title: t("emailMarketing:campaign"),
value: (i) => (
<div className="flex flex-col">
<div className="flex items-center space-x-2">
<div className="text-base font-bold">{i.name}</div>
<div>
<CampaignStatusBadge status={i.status} />
</div>
{i.sentAt ? (
<>
<div>•</div>
<div className="text-muted-foreground text-sm">
<span>{formatters.date(i.sentAt, { dateStyle: "medium" })}</span>
</div>
</>
) : null}
</div>
<div className="flex items-center space-x-2">
{(() => {
const recipientCount = i.recipients.length;
const deliveredCount = i.recipients.filter((f) => f.deliveredAt).length;
const openedCount = i.recipients.filter((f) => f.opens.length > 0).length;
const clickedCount = i.recipients.filter((f) => f.clicks.length > 0).length;
const unsubscribedCount = i.recipients.filter((f) => f.unsubscribedAt).length;
return (
<>
<div>
{t("emailMarketing:campaignList.metrics.recipients", {
count: recipientCount,
formattedCount: formatters.number(recipientCount),
})}
</div>
{i.track && (
<>
<div>•</div>
<div className="text-muted-foreground text-sm">
{formatters.number(deliveredCount)}/{formatters.number(recipientCount)} {t("emails.delivered")}
</div>
</>
)}
{i.track && (
<>
<div>•</div>
<div className="text-muted-foreground text-sm">
{formatters.percent(recipientCount > 0 ? openedCount / recipientCount : 0, {
minimumFractionDigits: 2,
maximumFractionDigits: 2,
})}{" "}
{t("emailMarketing:campaignList.metrics.openRate")}
</div>
</>
)}
{i.track && (
<>
<div>•</div>
<div className="text-muted-foreground text-sm">
{formatters.percent(recipientCount > 0 ? clickedCount / recipientCount : 0, {
minimumFractionDigits: 2,
maximumFractionDigits: 2,
})}{" "}
{t("emailMarketing:campaignList.metrics.clickRate")}
</div>
<div>•</div>
<div className="text-muted-foreground text-sm">
{t("emailMarketing:campaignList.metrics.clicks", {
count: clickedCount,
formattedCount: formatters.number(clickedCount),
})}
</div>
</>
)}
{i.track && (
<>
<div>•</div>
<div className="text-muted-foreground text-sm">
{t("emailMarketing:campaignList.metrics.unsubscribers", {
count: unsubscribedCount,
formattedCount: formatters.number(unsubscribedCount),
})}
</div>
</>
)}
</>
);
})()}
</div>
</div>
),
},
]}
noRecords={
<div className="p-12 text-center">
<h3 className="mt-1 text-sm font-medium text-gray-900">{t("emailMarketing:campaignList.empty.title")}</h3>
<p className="text-muted-foreground mt-1 text-sm">{t("emailMarketing:campaignList.empty.description")}</p>
</div>
}
/>
</div>
);
}
function CampaignStatusBadge({ status }: { status: string }) {
const { t } = useTranslation();
return (
<>
{status === "draft" && <SimpleBadge title={t("emailMarketing:campaignList.status.draft")} color={Colors.YELLOW} />}
{status === "sending" && <SimpleBadge title={t("emailMarketing:campaignList.status.sending")} color={Colors.ORANGE} />}
{status === "incomplete" && <SimpleBadge title={t("emailMarketing:campaignList.status.incomplete")} color={Colors.RED} />}
{status === "completed" && <SimpleBadge title={t("emailMarketing:campaignList.status.completed")} color={Colors.GREEN} />}
</>
);
}
@@ -0,0 +1,160 @@
import { useParams, useSubmit, Form, Link, useActionData, useLoaderData } from "react-router";
import { useState, useEffect, FormEvent } from "react";
import { useTranslation } from "react-i18next";
import ButtonPrimary from "~/components/ui/buttons/ButtonPrimary";
import ButtonSecondary from "~/components/ui/buttons/ButtonSecondary";
import InputGroup from "~/components/ui/forms/InputGroup";
import InputSelector from "~/components/ui/input/InputSelector";
import InputText from "~/components/ui/input/InputText";
import { EntityViewsApi } from "~/utils/api/.server/EntityViewsApi";
import { useAppOrAdminData } from "~/utils/data/useAppOrAdminData";
import { RowWithDetails } from "~/utils/db/entities/rows.db.server";
import { Campaigns_New } from "../../routes/Campaigns_New";
import EditPageLayout from "~/components/ui/layouts/EditPageLayout";
import toast from "react-hot-toast";
import InputContent from "~/components/ui/input/InputContent";
import { adminPath, appPath } from "~/utils/app/CanonicalUrlUtils";
import UrlUtils from "~/utils/app/UrlUtils";
import { getDefaultCampaignHtmlBody } from "./campaignDefaults";
export default function CampaignsNewRoute() {
const { t } = useTranslation();
const appOrAdminData = useAppOrAdminData();
const data = useLoaderData<Campaigns_New.LoaderData>();
const actionData = useActionData<Campaigns_New.ActionData>();
const params = useParams();
const submit = useSubmit();
const [name, setName] = useState(() => t("emailMarketing:defaults.campaignName"));
const [subject, setSubject] = useState(() => t("emailMarketing:defaults.subject"));
const [senderId, setSenderId] = useState<string | number | undefined>(data.emailSenders.length > 0 ? data.emailSenders[0].id : "");
const [contentType, setContentType] = useState<"wysiwyg" | "markdown">("wysiwyg");
const [htmlBody, setHtmlBody] = useState(() => getDefaultCampaignHtmlBody(t));
const [selectedContactsViewId, setSelectedContactsViewId] = useState<string>(data.contactsViews.length > 0 ? (data.contactsViews[0].view?.id ?? "") : "");
const [, setSelectedContactsView] = useState<EntityViewsApi.GetEntityViewsWithRows>();
useEffect(() => {
if (actionData?.success) {
toast.success(actionData.success);
} else if (actionData?.error) {
toast.error(actionData.error);
}
}, [actionData]);
useEffect(() => {
setSelectedContactsView(data.contactsViews.find((v) => v.view?.id === selectedContactsViewId));
}, [data.contactsViews, selectedContactsViewId]);
function handleSubmit(e: FormEvent<HTMLFormElement>) {
e.stopPropagation();
e.preventDefault();
const formData = new FormData(e.currentTarget);
submit(formData, {
method: "post",
});
}
function sendTest(i?: RowWithDetails) {
const email = window.prompt(t("emails.object"), appOrAdminData.user?.email);
if (!email || email.trim() === "") {
return;
}
const form = new FormData();
form.set("action", i ? "send-contact-preview" : "send-preview");
form.set("senderId", senderId?.toString() ?? "");
form.set("contactRowId", i?.id.toString() ?? "");
form.set("email", email);
form.set("subject", subject);
form.set("htmlBody", htmlBody);
form.set("textBody", "");
submit(form, {
method: "post",
});
}
return (
<EditPageLayout
title={t("emailMarketing:newCampaign")}
menu={[
{
title: t("emailMarketing:campaigns"),
routePath: UrlUtils.getModulePath(params, "email-marketing/campaigns"),
},
{ title: t("shared.new") },
]}
>
<Form onSubmit={handleSubmit} className="pb-10">
<input type="hidden" name="action" value="create" hidden readOnly />
<div className="relative space-y-4">
<div className="sticky top-0 right-0 left-0 z-10">
<div className="border-border bg-background rounded-lg border border-dashed p-4">
<div className="space-y-2 lg:flex lg:justify-between lg:space-y-0 lg:space-x-2">
<div className="grow">
<InputText name="name" title={t("shared.name")} value={name} setValue={setName} withLabel={false} placeholder={t("emailMarketing:campaignList.form.namePlaceholder")} required />
</div>
<div className="flex justify-between space-x-2">
<ButtonSecondary onClick={() => sendTest()}>{t("emailMarketing:sendPreview")}</ButtonSecondary>
<ButtonPrimary type="submit">{t("emailMarketing:saveDraft")}</ButtonPrimary>
</div>
</div>
</div>
</div>
<div className="flex flex-col space-y-4">
<div className="">
<InputGroup title={t("emails.object")}>
<div className="grid gap-2 sm:grid-cols-2">
<InputSelector
name="senderId"
title={t("emails.sender")}
value={senderId}
setValue={setSenderId}
withSearch={false}
hint={
data.emailSenders.length === 0 ? (
<>
<Link to={params.tenant ? appPath({ tenantSlug: params.tenant, path: "email-marketing/senders", mode: "host-aware" }) : adminPath(`email-marketing/senders`, { mode: "host-aware" })}>
<span className="text-xs hover:underline">{t("emailMarketing:senders.manage")}</span>
</Link>
</>
) : null
}
options={data.emailSenders.map((s) => {
return {
name: s.fromEmail,
value: s.id,
};
})}
required
/>
<InputSelector
required
name="contactViewId"
title={t("emails.recipientList")}
value={selectedContactsViewId}
setValue={(e) => setSelectedContactsViewId(e?.toString() ?? "")}
options={data.contactsViews.map((v) => {
return {
value: v.view?.id,
name: (v.view ? t(v.view.title) : t("shared.default")) + " (" + v.rowsCount + ")",
};
})}
/>
<div className="sm:col-span-2">
<InputText name="subject" title={t("emails.subject")} value={subject} setValue={setSubject} required placeholder={t("emails.subject")} />
</div>
<div className="sm:col-span-2">
{/* <input type="hidden" name="htmlBody" value={htmlBody} hidden readOnly /> */}
<InputContent name="htmlBody" value={htmlBody} onChangeValue={setHtmlBody} contentType={contentType} onChangeContentType={setContentType} />
</div>
</div>
</InputGroup>
</div>
</div>
</div>
</Form>
</EditPageLayout>
);
}
@@ -0,0 +1,39 @@
import type { TFunction } from "i18next";
import { describe, expect, it } from "vitest";
import { getDefaultCampaignHtmlBody } from "./campaignDefaults";
const defaultCopy: Record<string, string> = {
"emailMarketing:defaults.body.testEmail": "This is a test email.",
"emailMarketing:defaults.body.richTextIntro": "It includes",
"emailMarketing:defaults.body.bold": "bold",
"emailMarketing:defaults.body.italics": "italics",
"emailMarketing:defaults.body.combinedFormatting": "and combined formatting with",
"emailMarketing:defaults.body.strikethroughIntro": "It also includes",
"emailMarketing:defaults.body.strikethrough": "strikethrough",
"emailMarketing:defaults.body.exampleLink": "A link",
"emailMarketing:defaults.body.end": "The end.",
"emailMarketing:defaults.body.managePreferences": "Manage preferences",
};
function createT(copy: Record<string, string> = defaultCopy) {
return ((key: string) => copy[key] ?? key) as TFunction;
}
describe("campaign defaults", () => {
it("builds translated campaign HTML without leaking i18n expressions", () => {
const html = getDefaultCampaignHtmlBody(createT());
expect(html).toContain("<p>This is a test email.</p>");
expect(html).toContain(">A link</a");
expect(html).toContain(">Manage preferences</a");
expect(html).not.toContain("i18nT(");
expect(html).not.toContain("ui.autogenerated");
});
it("escapes translated text before injecting it into the default HTML", () => {
const html = getDefaultCampaignHtmlBody(createT({ ...defaultCopy, "emailMarketing:defaults.body.testEmail": "<script>alert('x')</script>" }));
expect(html).toContain("&lt;script&gt;alert(&#39;x&#39;)&lt;/script&gt;");
expect(html).not.toContain("<script>");
});
});
@@ -0,0 +1,31 @@
import type { TFunction } from "i18next";
export function getDefaultCampaignHtmlBody(t: TFunction) {
return `<p>${escapeHtml(t("emailMarketing:defaults.body.testEmail"))}</p>
<p>${escapeHtml(t("emailMarketing:defaults.body.richTextIntro"))} <strong>${escapeHtml(t("emailMarketing:defaults.body.bold"))}</strong>, <em>${escapeHtml(t("emailMarketing:defaults.body.italics"))}</em>, ${escapeHtml(t("emailMarketing:defaults.body.combinedFormatting"))} <strong><em>${escapeHtml(t("emailMarketing:defaults.body.bold"))}</em></strong
>. ${escapeHtml(t("emailMarketing:defaults.body.strikethroughIntro"))} <s>${escapeHtml(t("emailMarketing:defaults.body.strikethrough"))}</s>.
<a
target="_blank"
rel="noopener noreferrer"
class="underline text-blue-500"
href="https://www.example.com"
>${escapeHtml(t("emailMarketing:defaults.body.exampleLink"))}</a
>.
</p>
<p>-</p>
<p>${escapeHtml(t("emailMarketing:defaults.body.end"))}</p>
<p>
<a
target="_blank"
rel="noopener noreferrer"
class="underline text-blue-500"
href="https://www.example.com/preferences"
>${escapeHtml(t("emailMarketing:defaults.body.managePreferences"))}</a
>
</p>
`;
}
function escapeHtml(value: string) {
return value.replaceAll("&", "&amp;").replaceAll("<", "&lt;").replaceAll(">", "&gt;").replaceAll('"', "&quot;").replaceAll("'", "&#39;");
}
@@ -0,0 +1,64 @@
import fs from "node:fs";
import path from "node:path";
import { describe, expect, it } from "vitest";
const repoRoot = process.cwd();
function read(relativePath: string) {
return fs.readFileSync(path.resolve(repoRoot, relativePath), "utf8");
}
describe("email marketing i18n", () => {
const files = [
"apps/web/app/modules/emailMarketing/components/campaigns/CampaignsNewRoute.tsx",
"apps/web/app/modules/emailMarketing/components/campaigns/CampaignsEditRoute.tsx",
"apps/web/app/modules/emailMarketing/components/campaigns/CampaignsListRoute.tsx",
"apps/web/app/modules/emailMarketing/components/senders/SendersListRoute.tsx",
"apps/web/app/modules/emailMarketing/components/EmailMarketingSummaryRoute.tsx",
"apps/web/app/modules/emailMarketing/components/OutboundEmailsTable.tsx",
"apps/web/app/modules/emailMarketing/routes/Campaigns_List.ts",
"apps/web/app/modules/emailMarketing/routes/Campaigns_New.ts",
"apps/web/app/modules/emailMarketing/routes/OutboundEmails_List.ts",
"apps/web/app/modules/emailMarketing/routes/Senders_List.ts",
"apps/web/app/modules/emailMarketing/services/EmailMarketingService.ts",
];
it("keeps campaign and activity UI copy behind emailMarketing keys", () => {
const source = files.map(read).join("\n");
expect(source).toContain("emailMarketing:campaignList.status.draft");
expect(source).toContain("emailMarketing:campaignList.metrics.openRate");
expect(source).toContain("emailMarketing:senders.requiredForCampaign");
expect(source).toContain("emailMarketing:senders.setup.mailjetWebhookRequired");
expect(source).toContain("emailMarketing:senders.testEmail.subject");
expect(source).toContain("emailMarketing:campaignPreview.testSubject");
expect(source).toContain("emailMarketing:activityFilters.sender");
expect(source).toContain("emailMarketing:activityFilters.campaign");
expect(source).toContain("emailMarketing:activityFilters.preview");
expect(source).toContain("emailMarketing:activityLog.firstOpen");
expect(source).toContain("useLocaleFormatters");
expect(source).toContain("formatters.number(deliveredCount)");
expect(source).toContain("formatters.number(recipientCount)");
expect(source).toContain("formatters.number(i.opens.length)");
expect(source).toContain("formatters.number(i.clicks.length)");
expect(source).toContain("emails.recipientsCount");
expect(source).toContain("emailMarketing:campaignList.actions.showRecipients");
expect(source).toContain("formattedRecipientCount");
expect(source).not.toContain("ui.autogenerated");
expect(source).not.toContain('from "~/utils/shared/NumberUtils"');
expect(source).not.toContain('from "~/utils/shared/DateUtils"');
expect(source).not.toContain('window.prompt("Email"');
expect(source).not.toContain('"Draft"');
expect(source).not.toContain('"No campaigns"');
expect(source).not.toContain("open rate");
expect(source).not.toContain("First open");
expect(source).not.toContain("{i.opens.length} {t(\"emails.opens\")}");
expect(source).not.toContain("{i.clicks.length} {t(\"emails.clicks\")}");
expect(source).not.toContain("{ 0:");
expect(source).not.toContain("{{0}}");
expect(source).not.toContain("sendCampaignPreviewToContact");
expect(source).not.toContain("sendCampaignPreviewToContacts");
expect(source).not.toMatch(/sendCampaignToContact["')]/);
expect(source).not.toContain("{data.item.recipients.length}");
});
});
@@ -0,0 +1,25 @@
import { useTranslation } from "react-i18next";
import InputFilters from "~/components/ui/input/InputFilters";
import { OutboundEmails_List } from "../../routes/OutboundEmails_List";
import OutboundEmailsTable from "../OutboundEmailsTable";
import { useLoaderData } from "react-router";
export default function OutboundEmailsListRoute() {
const { t } = useTranslation();
const data = useLoaderData<OutboundEmails_List.LoaderData>();
return (
<div className="mx-auto w-full max-w-5xl space-y-3 px-4 py-2 pb-6 sm:px-6 sm:pt-3 lg:px-8 xl:max-w-full">
<div className="md:border-border md:border-b md:py-2">
<div className="flex items-center justify-between">
<h3 className="text-foreground text-lg font-medium leading-6">{t("emailMarketing:activity")}</h3>
<div className="flex items-center space-x-2">
<InputFilters withSearch={false} filters={data.filterableProperties} />
</div>
</div>
</div>
<OutboundEmailsTable allEntities={data.allEntities} items={data.items} pagination={data.pagination} withCampaign={true} />
</div>
);
}
@@ -0,0 +1,19 @@
import { useLoaderData, useNavigate, useParams } from "react-router";
import OpenModal from "~/components/ui/modals/OpenModal";
import { Senders_Edit } from "../../routes/Senders_Edit";
import EmailSenderForm from "../EmailSenderForm";
import { adminPath, appPath } from "~/utils/app/CanonicalUrlUtils";
export default function SendersEditRoute() {
const data = useLoaderData<Senders_Edit.LoaderData>();
const params = useParams();
const navigate = useNavigate();
function close() {
navigate(params.tenant ? appPath({ tenantSlug: params.tenant, path: "email-marketing/senders", mode: "host-aware" }) : adminPath("email-marketing/senders", { mode: "host-aware" }));
}
return (
<OpenModal className="sm:max-w-sm" onClose={close}>
<EmailSenderForm item={data.item} />
</OpenModal>
);
}
@@ -0,0 +1,112 @@
import { useSubmit, Outlet, useLoaderData, useActionData } from "react-router";
import { useEffect } from "react";
import { useTranslation } from "react-i18next";
import InfoBanner from "~/components/ui/banners/InfoBanner";
import WarningBanner from "~/components/ui/banners/WarningBanner";
import ButtonPrimary from "~/components/ui/buttons/ButtonPrimary";
import TableSimple from "~/components/ui/tables/TableSimple";
import { useAppOrAdminData } from "~/utils/data/useAppOrAdminData";
import { EmailSenderWithoutApiKey } from "../../db/emailSender";
import { Senders_List } from "../../routes/Senders_List";
import toast from "react-hot-toast";
export default function SendersListRoute() {
const data = useLoaderData<Senders_List.LoaderData>();
const { t } = useTranslation();
const appOrAdminData = useAppOrAdminData();
const submit = useSubmit();
const actionData = useActionData<Senders_List.ActionData>();
const hasMailjetSenders = data.items.some((item) => item.provider === "mailjet");
useEffect(() => {
if (actionData?.success) {
toast.success(actionData.success);
} else if (actionData?.error) {
toast.error(actionData.error);
}
}, [actionData]);
function sendTest(item: EmailSenderWithoutApiKey) {
const email = window.prompt(t("emailMarketing:senders.testEmail.prompt"), appOrAdminData.user?.email);
if (!email || email.trim() === "") {
return;
}
const form = new FormData();
form.set("action", "send-test");
form.set("senderId", item.id);
form.set("email", email);
submit(form, {
method: "post",
});
}
return (
<>
<div className="mx-auto w-full max-w-5xl space-y-3 px-4 py-2 pb-6 sm:px-6 sm:pt-3 lg:px-8 xl:max-w-full">
<div className="md:border-border md:border-b md:py-2">
<div className="flex items-center justify-between">
<h3 className="text-foreground text-lg leading-6 font-medium">{t("emailMarketing:senders.plural")}</h3>
<div className="flex items-center space-x-2">
<ButtonPrimary to="new">{t("shared.new")}</ButtonPrimary>
</div>
</div>
</div>
{data.items.length === 0 ? (
<InfoBanner title={t("shared.note")} text="">
{t("emailMarketing:senders.setup.mailjetApiTokenPrefix")}{" "}
<a className="underline" target="_blank" rel="noreferrer" href="https://app.mailjet.com/account/apikeys">
{t("emailMarketing:senders.setup.apiTokensLink")}
</a>
{t("emailMarketing:senders.setup.mailjetApiTokenSuffix")}
</InfoBanner>
) : !data.hasSetWebhooks && hasMailjetSenders ? (
<WarningBanner title={t("shared.warning")} text="">
{t("emailMarketing:senders.setup.mailjetWebhookRequired")}
</WarningBanner>
) : null}
<TableSimple
headers={[
{
name: "provider",
title: t("emailMarketing:senders.provider"),
value: (item) => item.provider,
},
{
name: "stream",
title: t("emailMarketing:senders.stream"),
value: (item) => item.stream,
},
{
name: "fromEmail",
title: t("emailMarketing:senders.fromEmail"),
value: (item) => item.fromEmail,
},
{
name: "fromName",
title: t("emailMarketing:senders.fromName"),
value: (item) => item.fromName,
},
{
name: "replyToEmail",
title: t("emailMarketing:senders.replyToEmail"),
value: (item) => item.replyToEmail,
},
]}
items={data.items}
actions={[
{
title: t("admin.emails.sendTest"),
onClick: (_, item) => sendTest(item),
},
{
title: t("shared.edit"),
onClickRoute: (_, item) => item.id,
},
]}
></TableSimple>
</div>
<Outlet />
</>
);
}
@@ -0,0 +1,17 @@
import { useParams, useNavigate } from "react-router";
import OpenModal from "~/components/ui/modals/OpenModal";
import EmailSenderForm from "../EmailSenderForm";
import { adminPath, appPath } from "~/utils/app/CanonicalUrlUtils";
export default function SendersNewRoute() {
const params = useParams();
const navigate = useNavigate();
function close() {
navigate(params.tenant ? appPath({ tenantSlug: params.tenant, path: "email-marketing/senders", mode: "host-aware" }) : adminPath("email-marketing/senders", { mode: "host-aware" }));
}
return (
<OpenModal className="sm:max-w-sm" onClose={close}>
<EmailSenderForm />
</OpenModal>
);
}