@rapidmx/crm-plugin 0.1.0

package/dist/apps/shared/crmApi.js

@@ -0,0 +1,240 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2026 Jean-Philippe Steinmetz
+// SPDX-License-Identifier: MPL-2.0
+///////////////////////////////////////////////////////////////////////////////
+/**
+ * Typed wrappers over this plugin's API (`/api/mail/crm/...`). The shapes mirror the server's (`src/models/types.ts`), with dates as
+ * ISO strings the way JSON carries them.
+ */
+import { ApiRequestError, apiFetch, apiUrl, withCsrfHeader } from "@rapidmx/web-client/lib/util/api.js";
+const enc = encodeURIComponent;
+const json = (method, body) => ({ method, ...(body === undefined ? {} : { body: JSON.stringify(body) }) });
+/** The API path of one kind of record: `contacts` or `companies`. */
+export function recordPath(objectType) {
+    return objectType === "contact" ? "contacts" : "companies";
+}
+// Workspaces
+export const listWorkspaces = () => apiFetch("/mail/crm/workspaces");
+export const getWorkspace = (uid) => apiFetch(`/mail/crm/workspaces/${enc(uid)}`);
+export const createWorkspace = (input) => apiFetch("/mail/crm/workspaces", json("POST", input));
+export const updateWorkspace = (uid, input) => apiFetch(`/mail/crm/workspaces/${enc(uid)}`, json("PUT", input));
+export const deleteWorkspace = (uid) => apiFetch(`/mail/crm/workspaces/${enc(uid)}`, json("DELETE"));
+export const listMembers = (uid) => apiFetch(`/mail/crm/workspaces/${enc(uid)}/members`);
+export const addMember = (uid, input) => apiFetch(`/mail/crm/workspaces/${enc(uid)}/members`, json("POST", input));
+export const updateMember = (uid, userUid, role) => apiFetch(`/mail/crm/workspaces/${enc(uid)}/members/${enc(userUid)}`, json("PUT", { role }));
+export const removeMember = (uid, userUid) => apiFetch(`/mail/crm/workspaces/${enc(uid)}/members/${enc(userUid)}`, json("DELETE"));
+export const listSenders = (uid) => apiFetch(`/mail/crm/workspaces/${enc(uid)}/senders`);
+export const updateSender = (uid, senderUid, input) => apiFetch(`/mail/crm/workspaces/${enc(uid)}/senders/${enc(senderUid)}`, json("PUT", input));
+export const addSender = (uid, input) => apiFetch(`/mail/crm/workspaces/${enc(uid)}/senders`, json("POST", input));
+export const removeSender = (uid, senderUid) => apiFetch(`/mail/crm/workspaces/${enc(uid)}/senders/${enc(senderUid)}`, json("DELETE"));
+// Contacts and companies
+export function searchRecords(objectType, workspaceUid, request) {
+    return apiFetch(`/mail/crm/${recordPath(objectType)}/${enc(workspaceUid)}/search`, json("POST", request));
+}
+export function getRecord(objectType, workspaceUid, uid) {
+    return apiFetch(`/mail/crm/${recordPath(objectType)}/${enc(workspaceUid)}/${enc(uid)}`);
+}
+export function createRecord(objectType, workspaceUid, input) {
+    return apiFetch(`/mail/crm/${recordPath(objectType)}/${enc(workspaceUid)}`, json("POST", input));
+}
+export function updateRecord(objectType, workspaceUid, uid, input) {
+    return apiFetch(`/mail/crm/${recordPath(objectType)}/${enc(workspaceUid)}/${enc(uid)}`, json("PUT", input));
+}
+export function deleteRecord(objectType, workspaceUid, uid) {
+    return apiFetch(`/mail/crm/${recordPath(objectType)}/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
+}
+export function bulkRecords(objectType, workspaceUid, input) {
+    return apiFetch(`/mail/crm/${recordPath(objectType)}/${enc(workspaceUid)}/bulk`, json("POST", input));
+}
+/** Downloads the records matching `request` as a CSV file. Browser only. */
+export async function exportRecords(objectType, workspaceUid, request) {
+    const response = await fetch(apiUrl(`/mail/crm/${recordPath(objectType)}/${enc(workspaceUid)}/export`), {
+        method: "POST",
+        credentials: "include",
+        headers: withCsrfHeader({ "Content-Type": "application/json" }),
+        body: JSON.stringify(request),
+    });
+    if (!response.ok) {
+        throw await responseError(response);
+    }
+    const link = document.createElement("a");
+    link.href = URL.createObjectURL(await response.blob());
+    link.download = `${recordPath(objectType)}.csv`;
+    link.click();
+    URL.revokeObjectURL(link.href);
+}
+// Properties, notes, tasks, timeline
+export const listProperties = (workspaceUid, objectType) => apiFetch(`/mail/crm/properties/${enc(workspaceUid)}?limit=200${objectType ? `&objectType=${objectType}` : ""}`);
+export const createProperty = (workspaceUid, input) => apiFetch(`/mail/crm/properties/${enc(workspaceUid)}`, json("POST", input));
+export const deleteProperty = (workspaceUid, uid) => apiFetch(`/mail/crm/properties/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
+export const listNotes = (workspaceUid, subjectUid) => apiFetch(`/mail/crm/notes/${enc(workspaceUid)}?limit=200&subjectUid=${enc(subjectUid)}`);
+export const createNote = (workspaceUid, input) => apiFetch(`/mail/crm/notes/${enc(workspaceUid)}`, json("POST", input));
+export const deleteNote = (workspaceUid, uid) => apiFetch(`/mail/crm/notes/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
+export function listTasks(workspaceUid, query = {}) {
+    const params = Object.entries(query)
+        .filter(([, value]) => value)
+        .map(([key, value]) => `&${key}=${enc(value)}`)
+        .join("");
+    return apiFetch(`/mail/crm/tasks/${enc(workspaceUid)}?limit=200${params}`);
+}
+export const createTask = (workspaceUid, input) => apiFetch(`/mail/crm/tasks/${enc(workspaceUid)}`, json("POST", input));
+export const updateTask = (workspaceUid, uid, input) => apiFetch(`/mail/crm/tasks/${enc(workspaceUid)}/${enc(uid)}`, json("PUT", input));
+export const deleteTask = (workspaceUid, uid) => apiFetch(`/mail/crm/tasks/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
+export const listTimeline = (workspaceUid, subjectType, subjectUid) => apiFetch(`/mail/crm/timeline/${enc(workspaceUid)}/${subjectType}/${enc(subjectUid)}?limit=100`);
+export const listLists = (workspaceUid) => apiFetch(`/mail/crm/lists/${enc(workspaceUid)}?limit=200`);
+export const createList = (workspaceUid, input) => apiFetch(`/mail/crm/lists/${enc(workspaceUid)}`, json("POST", input));
+export const updateList = (workspaceUid, uid, input) => apiFetch(`/mail/crm/lists/${enc(workspaceUid)}/${enc(uid)}`, json("PUT", input));
+export const deleteList = (workspaceUid, uid) => apiFetch(`/mail/crm/lists/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
+export const listSubscriptions = (workspaceUid, contactUid) => apiFetch(`/mail/crm/subscriptions/${enc(workspaceUid)}?limit=500&contactUid=${enc(contactUid)}`);
+export const setSubscriptions = (workspaceUid, input) => apiFetch(`/mail/crm/subscriptions/${enc(workspaceUid)}`, json("POST", input));
+export const listSuppressions = (workspaceUid) => apiFetch(`/mail/crm/suppressions/${enc(workspaceUid)}?limit=200`);
+export const createSuppression = (workspaceUid, input) => apiFetch(`/mail/crm/suppressions/${enc(workspaceUid)}`, json("POST", input));
+export const deleteSuppression = (workspaceUid, uid) => apiFetch(`/mail/crm/suppressions/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
+export const listForms = (workspaceUid) => apiFetch(`/mail/crm/forms/${enc(workspaceUid)}?limit=200`);
+export const createForm = (workspaceUid, input) => apiFetch(`/mail/crm/forms/${enc(workspaceUid)}`, json("POST", input));
+export const updateForm = (workspaceUid, uid, input) => apiFetch(`/mail/crm/forms/${enc(workspaceUid)}/${enc(uid)}`, json("PUT", input));
+export const deleteForm = (workspaceUid, uid) => apiFetch(`/mail/crm/forms/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
+// Imports
+export const listImports = (workspaceUid) => apiFetch(`/mail/crm/imports/${enc(workspaceUid)}?limit=50`);
+export const getImport = (workspaceUid, uid) => apiFetch(`/mail/crm/imports/${enc(workspaceUid)}/${enc(uid)}`);
+export const startImport = (workspaceUid, uid, input) => apiFetch(`/mail/crm/imports/${enc(workspaceUid)}/${enc(uid)}/start`, json("POST", input));
+export const deleteImport = (workspaceUid, uid) => apiFetch(`/mail/crm/imports/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
+/** Uploads a CSV file for import. */
+export async function uploadImport(workspaceUid, objectType, file) {
+    const response = await fetch(apiUrl(`/mail/crm/imports/${enc(workspaceUid)}?objectType=${objectType}&fileName=${enc(file.name)}`), {
+        method: "POST",
+        credentials: "include",
+        headers: withCsrfHeader({ "Content-Type": "text/csv" }),
+        body: file,
+    });
+    if (!response.ok) {
+        throw await responseError(response);
+    }
+    return (await response.json());
+}
+/** An `ApiRequestError` from a failed raw `fetch()`, with the server's message when it sent one. */
+async function responseError(response) {
+    let message = `Request failed (${response.status}).`;
+    try {
+        const body = await response.json();
+        message = typeof body?.message === "string" ? body.message : message;
+    }
+    catch {
+        // Not JSON: keep the generic message.
+    }
+    return new ApiRequestError(message, response.status);
+}
+/** A readable message for a failed call. */
+export function errorMessage(err, fallback) {
+    return err instanceof ApiRequestError ? err.message : fallback;
+}
+/** A page of the workspace's templates, by name. */
+export const searchTemplates = (workspaceUid, page, limit = 100) => apiFetch(`/mail/crm/templates/${enc(workspaceUid)}/search`, json("POST", { sort: { field: "name", direction: "asc" }, limit, page }));
+export const getTemplate = (workspaceUid, uid) => apiFetch(`/mail/crm/templates/${enc(workspaceUid)}/${enc(uid)}`);
+export const createTemplate = (workspaceUid, input) => apiFetch(`/mail/crm/templates/${enc(workspaceUid)}`, json("POST", input));
+export const updateTemplate = (workspaceUid, uid, input) => apiFetch(`/mail/crm/templates/${enc(workspaceUid)}/${enc(uid)}`, json("PUT", input));
+export const deleteTemplate = (workspaceUid, uid) => apiFetch(`/mail/crm/templates/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
+export const duplicateTemplate = (workspaceUid, uid) => apiFetch(`/mail/crm/templates/${enc(workspaceUid)}/${enc(uid)}/duplicate`, json("POST", {}));
+export const renderTemplate = (workspaceUid, input) => apiFetch(`/mail/crm/templates/${enc(workspaceUid)}/render`, json("POST", input));
+export const sendTestTemplate = (workspaceUid, uid, input) => apiFetch(`/mail/crm/templates/${enc(workspaceUid)}/${enc(uid)}/test`, json("POST", input));
+export const listMergeTags = (workspaceUid) => apiFetch(`/mail/crm/templates/${enc(workspaceUid)}/merge-tags`);
+export const listSavedBlocks = (workspaceUid) => apiFetch(`/mail/crm/saved-blocks/${enc(workspaceUid)}?limit=200`);
+export const createSavedBlock = (workspaceUid, input) => apiFetch(`/mail/crm/saved-blocks/${enc(workspaceUid)}`, json("POST", input));
+export const deleteSavedBlock = (workspaceUid, uid) => apiFetch(`/mail/crm/saved-blocks/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
+const campaignPath = (workspaceUid, suffix = "") => `/mail/crm/campaigns/${enc(workspaceUid)}${suffix}`;
+/** A page of the workspace's campaigns, newest first. */
+export const searchCampaigns = (workspaceUid, page, limit = 50) => apiFetch(campaignPath(workspaceUid, "/search"), json("POST", { limit, page }));
+export const getCampaign = (workspaceUid, uid) => apiFetch(campaignPath(workspaceUid, `/${enc(uid)}`));
+export const createCampaign = (workspaceUid, input) => apiFetch(campaignPath(workspaceUid), json("POST", input));
+export const updateCampaign = (workspaceUid, uid, input) => apiFetch(campaignPath(workspaceUid, `/${enc(uid)}`), json("PUT", input));
+export const deleteCampaign = (workspaceUid, uid) => apiFetch(campaignPath(workspaceUid, `/${enc(uid)}`), json("DELETE"));
+export const duplicateCampaign = (workspaceUid, uid) => apiFetch(campaignPath(workspaceUid, `/${enc(uid)}/duplicate`), json("POST", {}));
+export const campaignChecklist = (workspaceUid, uid) => apiFetch(campaignPath(workspaceUid, `/${enc(uid)}/checklist`));
+export const scheduleCampaign = (workspaceUid, uid, sendAt) => apiFetch(campaignPath(workspaceUid, `/${enc(uid)}/schedule`), json("POST", sendAt ? { sendAt } : {}));
+/** Moves a campaign along: back to a draft, paused, resumed or cancelled. */
+export const changeCampaign = (workspaceUid, uid, action) => apiFetch(campaignPath(workspaceUid, `/${enc(uid)}/${action}`), json("POST", {}));
+export const campaignAudience = (workspaceUid, input) => apiFetch(campaignPath(workspaceUid, "/audience"), json("POST", input));
+export const campaignReport = (workspaceUid, uid) => apiFetch(campaignPath(workspaceUid, `/${enc(uid)}/report`));
+export const campaignRecipients = (workspaceUid, uid, query) => apiFetch(campaignPath(workspaceUid, `/${enc(uid)}/recipients`), json("POST", query));
+export const listSegments = (workspaceUid) => apiFetch(`/mail/crm/segments/${enc(workspaceUid)}?limit=200`);
+export const createSegment = (workspaceUid, input) => apiFetch(`/mail/crm/segments/${enc(workspaceUid)}`, json("POST", input));
+export const updateSegment = (workspaceUid, uid, input) => apiFetch(`/mail/crm/segments/${enc(workspaceUid)}/${enc(uid)}`, json("PUT", input));
+export const deleteSegment = (workspaceUid, uid) => apiFetch(`/mail/crm/segments/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
+export const refreshSegment = (workspaceUid, uid) => apiFetch(`/mail/crm/segments/${enc(workspaceUid)}/${enc(uid)}/refresh`, json("POST", {}));
+export const previewSegment = (workspaceUid, filter) => apiFetch(`/mail/crm/segments/${enc(workspaceUid)}/preview`, json("POST", { filter }));
+export const listScoringRules = (workspaceUid) => apiFetch(`/mail/crm/scoring-rules/${enc(workspaceUid)}?limit=50`);
+export const createScoringRule = (workspaceUid, input) => apiFetch(`/mail/crm/scoring-rules/${enc(workspaceUid)}`, json("POST", input));
+export const updateScoringRule = (workspaceUid, uid, input) => apiFetch(`/mail/crm/scoring-rules/${enc(workspaceUid)}/${enc(uid)}`, json("PUT", input));
+export const deleteScoringRule = (workspaceUid, uid) => apiFetch(`/mail/crm/scoring-rules/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
+export const recalculateScores = (workspaceUid) => apiFetch(`/mail/crm/scoring-rules/${enc(workspaceUid)}/recalculate`, json("POST", {}));
+const automationPath = (workspaceUid, suffix = "") => `/mail/crm/automations/${enc(workspaceUid)}${suffix}`;
+export const listAutomations = (workspaceUid) => apiFetch(automationPath(workspaceUid, "?limit=200"));
+export const getAutomation = (workspaceUid, uid) => apiFetch(automationPath(workspaceUid, `/${enc(uid)}`));
+export const createAutomation = (workspaceUid, input) => apiFetch(automationPath(workspaceUid), json("POST", input));
+export const updateAutomation = (workspaceUid, uid, input) => apiFetch(automationPath(workspaceUid, `/${enc(uid)}`), json("PUT", input));
+export const deleteAutomation = (workspaceUid, uid) => apiFetch(automationPath(workspaceUid, `/${enc(uid)}`), json("DELETE"));
+/** Publishes, pauses or resumes an automation. */
+export const changeAutomation = (workspaceUid, uid, action) => apiFetch(automationPath(workspaceUid, `/${enc(uid)}/${action}`), json("POST", {}));
+export const enrollInAutomation = (workspaceUid, uid, contactUids) => apiFetch(automationPath(workspaceUid, `/${enc(uid)}/enroll`), json("POST", { contactUids }));
+export const automationReport = (workspaceUid, uid) => apiFetch(automationPath(workspaceUid, `/${enc(uid)}/report`));
+export const listEnrollments = (workspaceUid, uid, query) => apiFetch(automationPath(workspaceUid, `/${enc(uid)}/enrollments`), json("POST", query));
+export const exitEnrollment = (workspaceUid, uid, enrollmentUid) => apiFetch(automationPath(workspaceUid, `/${enc(uid)}/enrollments/${enc(enrollmentUid)}/exit`), json("POST", {}));
+export const listPipelines = (workspaceUid) => apiFetch(`/mail/crm/pipelines/${enc(workspaceUid)}?limit=50`);
+export const createPipeline = (workspaceUid, input) => apiFetch(`/mail/crm/pipelines/${enc(workspaceUid)}`, json("POST", input));
+export const updatePipeline = (workspaceUid, uid, input) => apiFetch(`/mail/crm/pipelines/${enc(workspaceUid)}/${enc(uid)}`, json("PUT", input));
+export const deletePipeline = (workspaceUid, uid) => apiFetch(`/mail/crm/pipelines/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
+/** A pipeline's deals, or a contact's (`contactUid`). */
+export function listDeals(workspaceUid, query = {}) {
+    const params = new URLSearchParams({ limit: "200" });
+    for (const [key, value] of Object.entries(query)) {
+        if (value) {
+            params.set(key, value);
+        }
+    }
+    return apiFetch(`/mail/crm/deals/${enc(workspaceUid)}?${params.toString()}`);
+}
+export const getDeal = (workspaceUid, uid) => apiFetch(`/mail/crm/deals/${enc(workspaceUid)}/${enc(uid)}`);
+export const createDeal = (workspaceUid, input) => apiFetch(`/mail/crm/deals/${enc(workspaceUid)}`, json("POST", input));
+export const updateDeal = (workspaceUid, uid, input) => apiFetch(`/mail/crm/deals/${enc(workspaceUid)}/${enc(uid)}`, json("PUT", input));
+export const deleteDeal = (workspaceUid, uid) => apiFetch(`/mail/crm/deals/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
+export const dealForecast = (workspaceUid, pipelineUid, days = 90) => apiFetch(`/mail/crm/deals/${enc(workspaceUid)}/forecast?pipelineUid=${enc(pipelineUid)}&days=${days}`);
+export const emailReport = (workspaceUid, days) => apiFetch(`/mail/crm/analytics/${enc(workspaceUid)}/email?days=${days}`);
+export const growthReport = (workspaceUid, days) => apiFetch(`/mail/crm/analytics/${enc(workspaceUid)}/growth?days=${days}`);
+export const salesReport = (workspaceUid, days, pipelineUid) => apiFetch(`/mail/crm/analytics/${enc(workspaceUid)}/sales?days=${days}${pipelineUid ? `&pipelineUid=${enc(pipelineUid)}` : ""}`);
+/** The event types an endpoint can take (besides `*`, all of them). */
+export const WEBHOOK_EVENTS = [
+    "contact.created",
+    "contact.updated",
+    "list.subscribed",
+    "list.unsubscribed",
+    "form.submitted",
+    "segment.entered",
+    "segment.left",
+    "email.sent",
+    "email.opened",
+    "email.clicked",
+    "email.replied",
+    "email.bounced",
+    "email.unsubscribed",
+    "deal.created",
+    "deal.stage_changed",
+    "deal.won",
+    "deal.lost",
+    "custom",
+    "automation.webhook",
+];
+export const listWebhooks = (workspaceUid) => apiFetch(`/mail/crm/webhooks/${enc(workspaceUid)}?limit=50`);
+export const createWebhook = (workspaceUid, input) => apiFetch(`/mail/crm/webhooks/${enc(workspaceUid)}`, json("POST", input));
+export const updateWebhook = (workspaceUid, uid, input) => apiFetch(`/mail/crm/webhooks/${enc(workspaceUid)}/${enc(uid)}`, json("PUT", input));
+export const deleteWebhook = (workspaceUid, uid) => apiFetch(`/mail/crm/webhooks/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
+export const rotateWebhookSecret = (workspaceUid, uid) => apiFetch(`/mail/crm/webhooks/${enc(workspaceUid)}/${enc(uid)}/secret`, json("POST"));
+export const testWebhook = (workspaceUid, uid) => apiFetch(`/mail/crm/webhooks/${enc(workspaceUid)}/${enc(uid)}/test`, json("POST"));
+export const webhookDeliveries = (workspaceUid, uid) => apiFetch(`/mail/crm/webhooks/${enc(workspaceUid)}/${enc(uid)}/deliveries`);
+export const API_KEY_SCOPES = ["contacts", "subscriptions", "events"];
+export const listApiKeys = (workspaceUid) => apiFetch(`/mail/crm/api-keys/${enc(workspaceUid)}?limit=50`);
+export const createApiKey = (workspaceUid, input) => apiFetch(`/mail/crm/api-keys/${enc(workspaceUid)}`, json("POST", input));
+export const updateApiKey = (workspaceUid, uid, input) => apiFetch(`/mail/crm/api-keys/${enc(workspaceUid)}/${enc(uid)}`, json("PUT", input));
+export const deleteApiKey = (workspaceUid, uid) => apiFetch(`/mail/crm/api-keys/${enc(workspaceUid)}/${enc(uid)}`, json("DELETE"));
+export const adminStats = () => apiFetch("/mail/crm/admin/stats");
+export const adminWorkspaces = (page, limit = 50) => apiFetch(`/mail/crm/admin/workspaces?limit=${limit}&page=${page}`);
+export const setWorkspaceSending = (uid, sendingDisabled) => apiFetch(`/mail/crm/admin/workspaces/${enc(uid)}`, json("PUT", { sendingDisabled }));

package/dist/apps/shared/fields.d.ts

@@ -0,0 +1,45 @@
+import { CrmObjectType, MailingList, PropertyDefinition, Segment } from "./crmApi.js";
+/** How a field's value is entered and compared. */
+export type FieldKind = "text" | "number" | "date" | "boolean" | "select" | "multi";
+/** A field the list pages show, edit and filter on. */
+export interface FieldInfo {
+    /** The API name: a record field, `tags`, or `properties.<key>`. */
+    name: string;
+    label: string;
+    kind: FieldKind;
+    options?: {
+        value: string;
+        label: string;
+    }[];
+    /** A custom property rather than one of the record's own fields. */
+    custom?: boolean;
+}
+/** Where a contact is in the customer journey, in order. */
+export declare const LIFECYCLE_STAGES: {
+    value: string;
+    label: string;
+}[];
+export declare const EMAIL_STATUSES: {
+    value: string;
+    label: string;
+}[];
+/** A contact's own fields. */
+export declare const CONTACT_FIELDS: FieldInfo[];
+/** A company's own fields. */
+export declare const COMPANY_FIELDS: FieldInfo[];
+/** The kind of a custom property's field. */
+export declare function propertyKind(definition: PropertyDefinition): FieldKind;
+/**
+ * Every field of `objectType` records: their own, `tags`, a contact's `lists` and `segments` (those given; none when `segments` is
+ * `null`, for a segment's own filter), and the workspace's custom properties for them.
+ */
+export declare function recordFields(objectType: CrmObjectType, definitions: PropertyDefinition[], lists?: MailingList[], segments?: Segment[] | null): FieldInfo[];
+/** The comparisons offered for each kind of field, with their labels. */
+export declare const OPERATORS: Record<FieldKind, {
+    op: string;
+    label: string;
+}[]>;
+/** A property value as a table cell shows it. */
+export declare function formatValue(value: unknown, field?: FieldInfo): string;
+/** A record's value of `field`: its own field, its tags, or one of its custom properties. */
+export declare function fieldValue(record: Record<string, any>, field: FieldInfo): unknown;

package/dist/apps/shared/fields.js

@@ -0,0 +1,146 @@
+const option = (value, label) => ({ value, label });
+/** Where a contact is in the customer journey, in order. */
+export const LIFECYCLE_STAGES = [
+    option("subscriber", "Subscriber"),
+    option("lead", "Lead"),
+    option("marketing_qualified", "Marketing qualified lead"),
+    option("sales_qualified", "Sales qualified lead"),
+    option("opportunity", "Opportunity"),
+    option("customer", "Customer"),
+    option("evangelist", "Evangelist"),
+    option("other", "Other"),
+];
+export const EMAIL_STATUSES = [option("active", "Active"), option("unsubscribed", "Unsubscribed"), option("bounced", "Bounced"), option("complained", "Complained")];
+/** A contact's own fields. */
+export const CONTACT_FIELDS = [
+    { name: "email", label: "Email", kind: "text" },
+    { name: "firstName", label: "First name", kind: "text" },
+    { name: "lastName", label: "Last name", kind: "text" },
+    { name: "phone", label: "Phone", kind: "text" },
+    { name: "jobTitle", label: "Job title", kind: "text" },
+    { name: "lifecycleStage", label: "Lifecycle stage", kind: "select", options: LIFECYCLE_STAGES },
+    { name: "leadStatus", label: "Lead status", kind: "text" },
+    { name: "score", label: "Score", kind: "number" },
+    { name: "source", label: "Source", kind: "text" },
+    { name: "emailStatus", label: "Email status", kind: "select", options: EMAIL_STATUSES },
+    { name: "lastEngagedAt", label: "Last engaged", kind: "date" },
+    { name: "dateCreated", label: "Created", kind: "date" },
+];
+/** A company's own fields. */
+export const COMPANY_FIELDS = [
+    { name: "name", label: "Name", kind: "text" },
+    { name: "domain", label: "Domain", kind: "text" },
+    { name: "industry", label: "Industry", kind: "text" },
+    { name: "employeeCount", label: "Employees", kind: "number" },
+    { name: "phone", label: "Phone", kind: "text" },
+    { name: "website", label: "Website", kind: "text" },
+    { name: "city", label: "City", kind: "text" },
+    { name: "country", label: "Country", kind: "text" },
+    { name: "dateCreated", label: "Created", kind: "date" },
+];
+/** The kind of a custom property's field. */
+export function propertyKind(definition) {
+    switch (definition.type) {
+        case "number":
+        case "date":
+        case "boolean":
+        case "select":
+            return definition.type;
+        case "multi_select":
+            return "multi";
+        default:
+            return "text";
+    }
+}
+/**
+ * Every field of `objectType` records: their own, `tags`, a contact's `lists` and `segments` (those given; none when `segments` is
+ * `null`, for a segment's own filter), and the workspace's custom properties for them.
+ */
+export function recordFields(objectType, definitions, lists = [], segments = []) {
+    return [
+        ...(objectType === "contact" ? CONTACT_FIELDS : COMPANY_FIELDS),
+        { name: "tags", label: "Tags", kind: "multi" },
+        ...(objectType === "contact"
+            ? [{ name: "lists", label: "Lists", kind: "multi", options: lists.map((list) => ({ value: list.uid, label: list.name })) }]
+            : []),
+        ...(objectType === "contact" && segments !== null
+            ? [{ name: "segments", label: "Segments", kind: "multi", options: segments.map((segment) => ({ value: segment.uid, label: segment.name })) }]
+            : []),
+        ...definitions
+            .filter((definition) => definition.objectType === objectType)
+            .map((definition) => ({
+            name: `properties.${definition.key}`,
+            label: definition.label,
+            kind: propertyKind(definition),
+            options: definition.options,
+            custom: true,
+        })),
+    ];
+}
+/** The comparisons offered for each kind of field, with their labels. */
+export const OPERATORS = {
+    text: [
+        { op: "contains", label: "contains" },
+        { op: "notContains", label: "doesn't contain" },
+        { op: "eq", label: "is" },
+        { op: "ne", label: "is not" },
+        { op: "startsWith", label: "starts with" },
+        { op: "isSet", label: "is known" },
+        { op: "isNotSet", label: "is unknown" },
+    ],
+    "number": [
+        { op: "eq", label: "=" },
+        { op: "ne", label: "≠" },
+        { op: "gt", label: ">" },
+        { op: "gte", label: "≥" },
+        { op: "lt", label: "<" },
+        { op: "lte", label: "≤" },
+        { op: "isSet", label: "is known" },
+        { op: "isNotSet", label: "is unknown" },
+    ],
+    date: [
+        { op: "gt", label: "is after" },
+        { op: "lt", label: "is before" },
+        { op: "isSet", label: "is known" },
+        { op: "isNotSet", label: "is unknown" },
+    ],
+    "boolean": [
+        { op: "eq", label: "is" },
+        { op: "isSet", label: "is known" },
+        { op: "isNotSet", label: "is unknown" },
+    ],
+    select: [
+        { op: "eq", label: "is" },
+        { op: "ne", label: "is not" },
+        { op: "isSet", label: "is known" },
+        { op: "isNotSet", label: "is unknown" },
+    ],
+    multi: [
+        { op: "eq", label: "includes" },
+        { op: "ne", label: "doesn't include" },
+        { op: "isSet", label: "has any" },
+        { op: "isNotSet", label: "has none" },
+    ],
+};
+/** A property value as a table cell shows it. */
+export function formatValue(value, field) {
+    if (value === undefined || value === null || value === "") {
+        return "";
+    }
+    if (Array.isArray(value)) {
+        return value.map((entry) => formatValue(entry, field)).join(", ");
+    }
+    if (typeof value === "boolean") {
+        return value ? "Yes" : "No";
+    }
+    if (field?.kind === "date" && typeof value === "string") {
+        const date = new Date(value);
+        return Number.isNaN(date.getTime()) ? value : date.toLocaleDateString();
+    }
+    const label = field?.options?.find((entry) => entry.value === value)?.label;
+    return label ?? String(value);
+}
+/** A record's value of `field`: its own field, its tags, or one of its custom properties. */
+export function fieldValue(record, field) {
+    return field.name.startsWith("properties.") ? record.properties?.[field.name.slice("properties.".length)] : record[field.name];
+}

package/dist/apps/shared/publicApi.d.ts

@@ -0,0 +1,48 @@
+export interface PublicFormField {
+    target: string;
+    label: string;
+    required: boolean;
+    type: "email" | "text" | "number" | "date" | "boolean" | "select" | "multi_select";
+    options?: {
+        value: string;
+        label: string;
+    }[];
+}
+export interface PublicForm {
+    uid: string;
+    title: string;
+    description?: string;
+    fields: PublicFormField[];
+}
+export interface FormResult {
+    result: "confirm" | "subscribed";
+    message: string;
+    redirectUrl?: string;
+}
+export interface Preferences {
+    workspaceName: string;
+    email: string;
+    unsubscribedAll: boolean;
+    lists: {
+        uid: string;
+        name: string;
+        description?: string;
+        subscribed: boolean;
+    }[];
+}
+export declare const getPublicForm: (formUid: string) => Promise<PublicForm>;
+export declare const submitForm: (formUid: string, values: Record<string, unknown>, website: string) => Promise<FormResult>;
+export declare const confirmSubscription: (token: string) => Promise<{
+    workspaceName: string;
+    lists: string[];
+}>;
+export declare const getPreferences: (token: string) => Promise<Preferences>;
+export declare const savePreferences: (token: string, input: {
+    lists?: Record<string, boolean>;
+    unsubscribeAll?: boolean;
+}) => Promise<Preferences>;
+export declare const unsubscribe: (token: string) => Promise<{
+    workspaceName: string;
+    list?: string;
+    preferencesToken: string;
+}>;

package/dist/apps/shared/publicApi.js

@@ -0,0 +1,17 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2026 Jean-Philippe Steinmetz
+// SPDX-License-Identifier: MPL-2.0
+///////////////////////////////////////////////////////////////////////////////
+/**
+ * Typed wrappers over the CRM's anonymous API (`/api/mail/crm/public/...`), for the public pages: signup forms, the preference
+ * center, double opt-in confirmation and one-click unsubscribe. No sign-in is sent or needed; tokens come from the links in emails.
+ */
+import { apiFetch } from "@rapidmx/web-client/lib/util/api.js";
+const enc = encodeURIComponent;
+const post = (body) => ({ method: "POST", body: JSON.stringify(body ?? {}) });
+export const getPublicForm = (formUid) => apiFetch(`/mail/crm/public/forms/${enc(formUid)}`);
+export const submitForm = (formUid, values, website) => apiFetch(`/mail/crm/public/forms/${enc(formUid)}`, post({ values, website }));
+export const confirmSubscription = (token) => apiFetch(`/mail/crm/public/confirm/${enc(token)}`, post());
+export const getPreferences = (token) => apiFetch(`/mail/crm/public/preferences/${enc(token)}`);
+export const savePreferences = (token, input) => apiFetch(`/mail/crm/public/preferences/${enc(token)}`, post(input));
+export const unsubscribe = (token) => apiFetch(`/mail/crm/public/unsubscribe/${enc(token)}`, post());

package/dist/apps/subscriptions/[token].d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+/** The preference center, from the link in every CRM email (`/subscriptions/<token>`). */
+export default function PreferencesPage({ params }: {
+    params: {
+        token: string;
+    };
+}): React.JSX.Element;

package/dist/apps/subscriptions/[token].js

@@ -0,0 +1,6 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { PreferenceCenterPage } from "../shared/components/public/PublicPages.js";
+/** The preference center, from the link in every CRM email (`/subscriptions/<token>`). */
+export default function PreferencesPage({ params }) {
+    return _jsx(PreferenceCenterPage, { token: params.token });
+}

package/dist/apps/subscriptions/_layout.d.ts

@@ -0,0 +1,8 @@
+import React, { PropsWithChildren } from "react";
+import { Branding } from "@rapidmx/web-client/lib/branding/brandingApi.js";
+export interface LayoutProps {
+    /** Supplied by the server's public page route, which every `public` plugin app's route extends - see
+     * `crm/_layout.tsx`'s `LayoutProps` doc comment for the mechanism. */
+    branding?: Branding;
+}
+export default function Layout({ children, branding }: PropsWithChildren<LayoutProps>): React.JSX.Element;

package/dist/apps/subscriptions/_layout.js

@@ -0,0 +1,8 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { CUSTOM_STYLESHEET_LINK_ID } from "@rapidmx/web-client/lib/branding/useBranding.js";
+export default function Layout({ children, branding }) {
+    const title = branding?.title || branding?.companyName ? `${branding?.title || branding?.companyName}: Email preferences` : "RapidMX: Email preferences";
+    const iconHref = branding?.iconUrl || branding?.logoUrl || "/images/logo.svg";
+    const stylesheetHref = branding?.stylesheetUrl;
+    return (_jsxs("html", { lang: "en", children: [_jsxs("head", { children: [_jsx("meta", { charSet: "utf-8" }), _jsx("meta", { name: "viewport", content: "width=device-width, initial-scale=1" }), _jsx("title", { children: title }), _jsx("link", { rel: "icon", type: "image/svg+xml", href: iconHref }), _jsx("link", { rel: "alternate icon", href: "/favicon.ico" }), stylesheetHref && _jsx("link", { rel: "stylesheet", href: stylesheetHref, id: CUSTOM_STYLESHEET_LINK_ID })] }), _jsx("body", { children: children })] }));
+}

package/dist/apps/subscriptions/confirm/[token].d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+/** Double opt-in confirmation, from the link in a confirmation email (`/subscriptions/confirm/<token>`). */
+export default function ConfirmSubscriptionPage({ params }: {
+    params: {
+        token: string;
+    };
+}): React.JSX.Element;

package/dist/apps/subscriptions/confirm/[token].js

@@ -0,0 +1,6 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { ConfirmPage } from "../../shared/components/public/PublicPages.js";
+/** Double opt-in confirmation, from the link in a confirmation email (`/subscriptions/confirm/<token>`). */
+export default function ConfirmSubscriptionPage({ params }) {
+    return _jsx(ConfirmPage, { token: params.token });
+}

package/dist/apps/subscriptions/index.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+/** `/subscriptions` without a token: nothing to show but a pointer to the emails' links. */
+export default function SubscriptionsIndexPage(): React.JSX.Element;

package/dist/apps/subscriptions/index.js

@@ -0,0 +1,6 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { MissingLinkPage } from "../shared/components/public/PublicPages.js";
+/** `/subscriptions` without a token: nothing to show but a pointer to the emails' links. */
+export default function SubscriptionsIndexPage() {
+    return _jsx(MissingLinkPage, { title: "Email preferences" });
+}

package/dist/apps/subscriptions/unsubscribe/[token].d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+/** An unsubscribe link's landing page (`/subscriptions/unsubscribe/<token>`). */
+export default function UnsubscribeLinkPage({ params }: {
+    params: {
+        token: string;
+    };
+}): React.JSX.Element;

package/dist/apps/subscriptions/unsubscribe/[token].js

@@ -0,0 +1,6 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { UnsubscribePage } from "../../shared/components/public/PublicPages.js";
+/** An unsubscribe link's landing page (`/subscriptions/unsubscribe/<token>`). */
+export default function UnsubscribeLinkPage({ params }) {
+    return _jsx(UnsubscribePage, { token: params.token });
+}