@aglyn/plugins-marketing 1.0.0-beta.221 → 1.0.0-beta.222

package/src/lib/model/campaign-container.d.ts

@@ -0,0 +1,503 @@
+/**
+ * @license
+ * Copyright 2026 Aglyn LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * A CAMPAIGN IS A CONTAINER; A SEND IS ONE MESSAGE INSIDE IT.
+ *
+ * ## Both belong to the ORGANIZATION (AGL-3273)
+ *
+ * `orgs/{orgId}/emailCampaigns/{campaignId}` holds a CONTAINER: a name, a
+ * window, the lists it aims at. `orgs/{orgId}/campaigns/{sendId}` holds a
+ * SEND: one subject, one body, one audience, one set of counters.
+ *
+ * They lived under one site (`hosts/{hostId}/…`) until the audience side —
+ * contacts, lists, topics, sending domains — had long since become the
+ * org's. An organization's outbound sequences then had to be filed under a
+ * campaign that belonged to its marketing site, and the org-level Leads page
+ * could not name a campaign at all. Moving both up is what lets one campaign
+ * coordinate a push across every site, a sequence and the leads it produced.
+ *
+ * ## What stays a SITE fact, and where it is recorded
+ *
+ * A campaign's reach is {@link EmailCampaign.visibleTo}, the same scope
+ * tokens every org-owned resource carries: `['org']` is every site, and
+ * `['host:{id}', …]` is the sites it is placed on. It decides which sites'
+ * pickers offer the campaign and which scoped collaborators can read it —
+ * nothing else, because membership stays a field on the member.
+ *
+ * A send, by contrast, is always sent AS one site: that site's sender, the
+ * consent the person gave that site, the site's unsubscribe signature and
+ * its designs. {@link CAMPAIGN_SEND_HOST_FIELD} records which, and the
+ * send's `visibleTo` is that one site's token.
+ *
+ * ## Ids did not change, and that is load-bearing
+ *
+ * Every unsubscribe link that has ever gone out carries `hostId` and
+ * `cid={sendId}`, both inside the link's HMAC, and those emails sit in
+ * inboxes forever. So the move copied every document under its existing id,
+ * and every reader that starts from a link resolves the send through the
+ * site's org (`resolveCampaignSendRef` in the Marketing plugin), with the
+ * old site path as the fallback for a document the migration has not reached.
+ * A member's `campaignIds` names container ids, which likewise never moved.
+ *
+ * A send written before containers existed carries no
+ * {@link CAMPAIGN_SEND_CONTAINER_FIELD}, and {@link campaignListRows}
+ * presents it as a container of one rather than hiding it.
+ *
+ * ## Why the arithmetic is here
+ *
+ * The same reason `campaign-report.ts` gives for the per-send rates: a
+ * denominator chosen in JSX is a denominator nobody tests. Aggregating across
+ * sends adds one problem the single-send report does not have — some sends
+ * recorded a field and others never did — and summing those into one number
+ * silently reports a partial total as a complete one. Every aggregate here
+ * therefore reports how many sends it could measure.
+ */
+import { type ListUnsubscribeForcedReason } from '@aglyn/shared-util-email/list-unsubscribe';
+import { type SendRate, type SendStats } from '@aglyn/shared-ui-email-campaigns/model/send-report';
+/** The org collection holding campaign CONTAINERS. */
+export declare const EMAIL_CAMPAIGNS_COLLECTION = "emailCampaigns";
+/** The org collection holding SENDS — one document per email. */
+export declare const CAMPAIGN_SENDS_COLLECTION = "campaigns";
+/** `orgs/{orgId}/emailCampaigns`, as path segments. */
+export declare function orgEmailCampaignsPath(orgId: string): [string, string, string];
+/** `orgs/{orgId}/campaigns`, as path segments. */
+export declare function orgCampaignSendsPath(orgId: string): [string, string, string];
+/** `orgs/{orgId}/campaignSequenceReports`, as path segments. */
+export declare function orgCampaignSequenceReportsPath(orgId: string): [string, string, string];
+/**
+ * The field on a SEND naming the site it is sent AS.
+ *
+ * Required on every send written since AGL-3273. The sender, the consent
+ * group, the unsubscribe signature, the designs and the experiments all
+ * belong to that site, so a send with no site cannot be delivered.
+ */
+export declare const CAMPAIGN_SEND_HOST_FIELD = "hostId";
+/** The scope token naming every site in the org, as `scope-tokens.ts` spells it. */
+export declare const CAMPAIGN_ORG_SCOPE = "org";
+/** `host:{hostId}`, the scope token naming one site. */
+export declare function campaignHostScope(hostId: string): string;
+/**
+ * The `visibleTo` a send is stamped with: the one site it sends as.
+ *
+ * Not `['org']`. An org-wide member reads every send regardless, and a
+ * collaborator invited to a sibling site has no business reading who this
+ * site mailed.
+ */
+export declare function campaignSendVisibleTo(hostId: string): string[];
+/**
+ * The sites a container is placed on, or `null` when it is on every site.
+ *
+ * An absent or empty `visibleTo` reads as NO sites, for the reason
+ * `visibleToHost` in `scope-tokens.ts` gives: a document nobody scoped is
+ * not the same fact as one scoped to everyone, and hiding is the
+ * recoverable direction.
+ */
+export declare function campaignSiteIds(campaign: Pick<EmailCampaign, 'visibleTo'> | null | undefined): string[] | null;
+/** Whether a container is offered on this site. */
+export declare function campaignPlacedOnHost(campaign: Pick<EmailCampaign, 'visibleTo'> | null | undefined, hostId: string): boolean;
+/**
+ * The `visibleTo` a container is stamped with, from a site selection.
+ *
+ * `null` (or an empty selection) is every site. A selection is deduped and
+ * capped at thirty, the ceiling `array-contains-any` and the rules' `hasAny`
+ * both impose.
+ */
+export declare function campaignVisibleTo(siteIds: readonly string[] | null): string[];
+/**
+ * The field on a SEND naming the campaign it belongs to.
+ *
+ * Not `campaignId`: on a send document that name already means the send's own
+ * id — it is what `cid` carries and what the report route addresses — and one
+ * word meaning both would be read into the other on the first edit.
+ */
+export declare const CAMPAIGN_SEND_CONTAINER_FIELD = "emailCampaignId";
+/**
+ * A campaign: the container, not a message.
+ *
+ * Stored at `orgs/{orgId}/emailCampaigns/{campaignId}`.
+ */
+export interface EmailCampaign {
+    $id: string;
+    /** What the merchant called it. */
+    name: string;
+    /** When the campaign window opens. Null for a campaign with no dates. */
+    startAtMs?: number | null;
+    /** When it closes. Null for an open-ended campaign. */
+    endAtMs?: number | null;
+    /** Org email lists this campaign is aimed at, by list id. */
+    listIds?: string[];
+    /**
+     * The stream this campaign's emails open on.
+     *
+     * A DEFAULT, not a constraint. The topic decides who a send skips, what the
+     * preference page linked from the footer highlights, and which stream a
+     * resulting opt-out is recorded against — all facts about one MESSAGE, and
+     * one campaign may legitimately carry a newsletter and a promotion. So the
+     * composer's picker is what the send records; this is what the picker opens
+     * on, which is what stops a "Sales" campaign quietly mailing under
+     * `marketing`.
+     */
+    topicId?: string;
+    /**
+     * The sites the campaign is placed on, as scope tokens: `['org']` for
+     * every site, `['host:{id}', …]` for a set. See {@link campaignSiteIds}.
+     */
+    visibleTo?: string[];
+    /**
+     * Whether its emails carry `List-Unsubscribe` and `List-Unsubscribe-Post`
+     * (RFC 8058), the header mail clients draw their own Unsubscribe button
+     * from (AGL-3307). ON unless stored `false` — absent on every campaign
+     * written before the setting existed, which read as on because that is
+     * what they always did. Read it through {@link campaignListUnsubscribe}.
+     *
+     * Off is overridden per send by the bulk guard; see
+     * {@link CampaignListUnsubscribeRecord}. The footer's unsubscribe link is
+     * in every email either way.
+     */
+    listUnsubscribe?: boolean;
+    createdAtMs?: number;
+    createdBy?: string;
+    deletedAt?: unknown;
+}
+/**
+ * Whether a campaign's emails carry the mail-client unsubscribe button:
+ * the shared reader sequences use, with a campaign's default of ON.
+ */
+export declare function campaignListUnsubscribe(campaign: Pick<EmailCampaign, 'listUnsubscribe'> | null | undefined): boolean;
+/**
+ * What one SEND did with the List-Unsubscribe header, written by the
+ * campaign sender on every batch (AGL-3307).
+ */
+export interface CampaignListUnsubscribeRecord {
+    /** The campaign's setting when it went out. */
+    requested?: boolean;
+    /** Whether the header was on the messages. */
+    on?: boolean;
+    /** True when the setting said off and the bulk guard turned it back on. */
+    forced?: boolean;
+    reason?: ListUnsubscribeForcedReason;
+    /** One sentence saying why, for the campaign page. */
+    detail?: string;
+    /** Campaign messages in the day, this email included, it was judged on. */
+    volume?: number;
+    /** The threshold it was judged against. */
+    threshold?: number;
+    atMs?: number;
+}
+/** The sends among these whose header the bulk guard forced back on. */
+export declare function campaignForcedListUnsubscribeSends<T extends Pick<CampaignSend, 'listUnsubscribe'>>(sends: readonly T[] | null | undefined): T[];
+/** One send, as much of it as a list or a rollup needs. */
+export interface CampaignSend {
+    $id: string;
+    subject?: string;
+    /** The audience KIND: `'leads'`, `'members'`, `'segment'`, `'list'`. */
+    audience?: string;
+    /** The list this send addressed, when the kind is `'list'`. */
+    listId?: string;
+    /** The segment this send addressed, when the kind is `'segment'`. */
+    segmentId?: string;
+    /** Which container it belongs to, absent on a send written before them. */
+    emailCampaignId?: string;
+    /** The site it is sent as. See {@link CAMPAIGN_SEND_HOST_FIELD}. */
+    hostId?: string;
+    status?: string;
+    sentAt?: {
+        seconds?: number;
+    } | null;
+    sendAtMs?: number;
+    /**
+     * When the record was minted, stamped by every writer that creates one.
+     *
+     * Absent on a send written before the stamp existed. The lists that draw
+     * drafts beside sends order on it through `emailListTimeMs`, which is why
+     * it is here rather than only on the loose record shape: a draft carries
+     * neither `sentAt` nor `sendAtMs`, so this is the only time it has.
+     */
+    createdAtMs?: number;
+    stats?: SendStats;
+    /** How far a send that goes out over several batches has got. */
+    resume?: CampaignResume;
+    /** What it did with the List-Unsubscribe header. Absent before AGL-3307. */
+    listUnsubscribe?: CampaignListUnsubscribeRecord;
+    /**
+     * Staff review of a send the outbound phishing screen held (AGL-3356).
+     * Written by the send core, decided only by staff. See
+     * {@link campaignSendHeldForReview}.
+     */
+    staffReview?: CampaignStaffReview;
+}
+/** A held send's review, as the send core and the staff decision write it. */
+export interface CampaignStaffReview {
+    /** `held` until staff decide; then `released` or `rejected`. */
+    state?: string;
+    /** `HS-…`, the reference the merchant quotes to support. */
+    reference?: string;
+    reviewId?: string;
+    heldAtMs?: number;
+}
+/**
+ * Is this send waiting on a staff review (AGL-3356)?
+ *
+ * A held send is STORED as `scheduled`, parked at a send time no processor
+ * run reaches, so the review can put it back on the clock without a second
+ * record. Every surface that read the status alone therefore called it
+ * "Scheduled" and showed a due date in the year 9999 — and offered "Send
+ * now", "Reschedule" and the composer, none of which a merchant may use to
+ * release it. This is the one test, so no surface restates it.
+ */
+export declare function campaignSendHeldForReview(send: Pick<CampaignSend, 'status' | 'staffReview'> | null | undefined): boolean;
+/**
+ * What a held send's surfaces tell the merchant: that it is held, why in
+ * general terms, that they cannot release it, and what happens next. One
+ * sentence set, so the list, the page and the composer agree.
+ */
+export declare function campaignHeldForReviewNotice(send: Pick<CampaignSend, 'staffReview'> | null | undefined): string;
+/**
+ * The batch state the sender writes on an email that is still going out.
+ *
+ * Absent on every send that finished in one batch, and on every send that
+ * predates batching — which is why {@link campaignSendProgress} treats a
+ * missing record as "this is not a batched send" rather than as zero.
+ */
+export interface CampaignResume {
+    /** People the email has resolved and not yet addressed. */
+    remaining?: number;
+    /** Batches it has run. */
+    batch?: number;
+    /** When the next batch may go, ms. Zero when there is not going to be one. */
+    nextAtMs?: number;
+    /** Why it stopped short, when it did. */
+    stop?: string;
+}
+/**
+ * WHAT A SEND IS ACTUALLY DOING, for a row that would otherwise lie.
+ *
+ * An email larger than one send may carry is delivered over several batches,
+ * and between them it is stored as `scheduled` — the state the processor
+ * claims, and the only one that resumes it without a second index and a
+ * second query. Read literally, that is a row saying "not sent yet" about an
+ * email that has already put five hundred messages in five hundred inboxes.
+ *
+ * So the stored fields are not the sentence. This is: it takes the status,
+ * the delivered count and the batch record, and answers what a person needs
+ * to see. Derived at read time and never persisted, exactly as
+ * `campaignWindowState` beside it is, because it is a description of stored
+ * facts and not a fact of its own.
+ *
+ * ## The four states, and which stored shape each one is
+ *
+ * - `pending` — `scheduled`, nothing delivered. A campaign waiting for its
+ *   time. This is what `scheduled` meant before batching and still does.
+ * - `sending` — `scheduled` or `sending` with something delivered and more to
+ *   come. The state this function exists for.
+ * - `sent` — finished, whether in one batch or six.
+ * - `stopped` — finished with people it never addressed: canceled mid-flight,
+ *   failed mid-flight, or stopped by the batch guard. The count is what makes
+ *   this legible rather than alarming — an email that reached 2,400 of 3,000
+ *   and stopped is a different conversation from one that reached nobody.
+ */
+export type CampaignSendProgressState = 'pending' | 'sending' | 'sent' | 'stopped';
+export interface CampaignSendProgress {
+    state: CampaignSendProgressState;
+    /** Messages this email has delivered. */
+    reached: number;
+    /**
+     * The audience it is working through, when one was recorded. Null when the
+     * send never recorded an audience size, which is every send that predates
+     * the figure — reported as null rather than as `reached` so a surface does
+     * not present a floor as a total.
+     */
+    audience: number | null;
+    /** People it has resolved and not yet addressed. */
+    remaining: number;
+    /** Batches it has run. Zero for a send that never batched. */
+    batch: number;
+    /** When the next batch may go, ms. Zero unless {@link state} is `sending`. */
+    nextAtMs: number;
+    /** One line a surface may show verbatim. */
+    label: string;
+}
+export declare function campaignSendProgress(send: CampaignSend | null | undefined): CampaignSendProgress;
+/**
+ * What a ROW says about one email, in one word and one line.
+ *
+ * {@link campaignSendProgress} answers what a send is DOING, and a draft is
+ * not doing anything: it has no status the progress states cover, and — since
+ * an absent status reads as `sent` and a draft has no counters — asking it
+ * about one answers "Sent to 0", which is the worst available sentence about
+ * an email nobody has written yet. So the draft is settled here and
+ * everything else is deferred, unchanged, to the derivation that owns it.
+ *
+ * One helper rather than the same two-line branch on four surfaces. The
+ * campaigns table, the emails list, an email's own page and a campaign's
+ * emails table all draw this, and four copies is how three of them come to
+ * say "Scheduled" about a campaign that has delivered five hundred messages.
+ */
+export type CampaignSendDisplayState = 'draft' | 'held' | CampaignSendProgressState;
+export interface CampaignSendDisplay {
+    state: CampaignSendDisplayState;
+    /** One line a surface may show verbatim. */
+    label: string;
+    /** The progress underneath, for a surface that wants the figures. */
+    progress: CampaignSendProgress;
+}
+export declare function campaignSendDisplay(send: CampaignSend | null | undefined): CampaignSendDisplay;
+/**
+ * Whether this email is between batches, with more of its audience to reach.
+ *
+ * The one question two controls on an email's page turn on. It is stored as
+ * `scheduled` — the state the processor claims — so a surface reading the
+ * status alone offers "Send now" on a campaign that is already going out, and
+ * `sendNow` re-resolves the WHOLE audience rather than continuing: everyone
+ * already reached would receive a second copy under the same `cid`.
+ */
+export declare function campaignSendIsMidFlight(send: CampaignSend | null | undefined): boolean;
+/**
+ * The lists ONE SEND addressed — which can be narrower than the lists its
+ * campaign is aimed at.
+ *
+ * A campaign holds the lists a merchant plans to reach; each send inside it
+ * picks one audience, and that audience may be a segment or the site's leads
+ * rather than any of them. Answering from the send is therefore the only
+ * honest answer for a send's own detail page.
+ *
+ * An array for a document that stores one id, deliberately: the question
+ * "which lists did this reach" has a plural answer everywhere it is asked,
+ * and a caller that unwraps a single id today is a caller to revisit if a
+ * send ever addresses two.
+ */
+export declare function campaignSendListIds(send: CampaignSend): string[];
+/**
+ * A number summed across sends, with how much of the campaign it covers.
+ *
+ * `value` is `null` when NO send recorded the field — which is not zero, for
+ * the reason `campaign-report.ts` gives at length: an unrecorded delivery
+ * count and a delivery count of zero lead a merchant to opposite conclusions
+ * about their sending domain.
+ *
+ * `recorded` below `sends` means the total is a floor. A campaign whose
+ * older sends predate the delivery webhook has a real number that describes
+ * part of itself, and saying which part is the difference between a total and
+ * a guess.
+ */
+export interface CampaignAggregate {
+    value: number | null;
+    /** Sends that recorded this field. */
+    recorded: number;
+    /** Sends in the campaign. */
+    sends: number;
+}
+/** Every rolled-up figure for one campaign. */
+export interface CampaignRollup {
+    /** Sends that have actually gone out. */
+    sends: number;
+    /** Sends still waiting for their send time, having delivered nothing. */
+    scheduled: number;
+    /**
+     * Sends part way through an audience larger than one batch.
+     *
+     * Counted apart from `scheduled` and from `sends`, because it is neither:
+     * mail has gone out, and more is going to. Both of those are facts a
+     * merchant reading a campaign row needs, and the stored status carries
+     * only the first.
+     */
+    sending: number;
+    /**
+     * Emails that have been created and not yet written or sent.
+     *
+     * Counted apart from `sends` and from `scheduled`, because a draft is
+     * neither: it has mailed nobody, and it is not on the clock to.
+     */
+    drafts: number;
+    addressed: CampaignAggregate;
+    sent: CampaignAggregate;
+    delivered: CampaignAggregate;
+    opens: CampaignAggregate;
+    uniqueOpens: CampaignAggregate;
+    clicks: CampaignAggregate;
+    uniqueClicks: CampaignAggregate;
+    bounced: CampaignAggregate;
+    complained: CampaignAggregate;
+    unsubscribes: CampaignAggregate;
+    /** Distinct openers over delivered, across every send that recorded both. */
+    openRate: SendRate | null;
+    /** Distinct clickers over delivered. */
+    clickRate: SendRate | null;
+    /** Unsubscribes over delivered. */
+    unsubscribeRate: SendRate | null;
+    /** The most recent send time in the campaign, for ordering a list. */
+    lastSentAtMs: number | null;
+}
+/** When a send happened, in epoch milliseconds, or null. */
+export declare function campaignSendAtMs(send: CampaignSend): number | null;
+/**
+ * Rolls a campaign's sends into one set of figures.
+ *
+ * Rates are taken over the sends that recorded BOTH sides, so a campaign
+ * whose first send predates the delivery webhook reports the open rate of the
+ * sends that can be measured rather than one deflated by a send with no
+ * denominator.
+ */
+export declare function campaignRollup(sends: CampaignSend[]): CampaignRollup;
+/**
+ * Where a campaign stands against its own window.
+ *
+ * Derived at read time and never persisted — the `status` values on a SEND
+ * (`sent`, `scheduled`, `canceled`, `failed`) are stored strings that a
+ * processor branches on, and a display state sharing those spellings would
+ * eventually be written back.
+ */
+export type CampaignWindowState = 'undated' | 'upcoming' | 'running' | 'ended';
+export declare function campaignWindowState(campaign: Pick<EmailCampaign, 'startAtMs' | 'endAtMs'>, nowMs: number): CampaignWindowState;
+/** One row of the campaigns table. */
+export interface CampaignListRow {
+    /** The id the detail route resolves — a container id, or a send id. */
+    id: string;
+    name: string;
+    /**
+     * True when this row IS a send with no container.
+     *
+     * A campaign sent before containers existed is shown as a campaign of one
+     * rather than dropped from the list, and the detail route falls back to the
+     * send's own report for it. Nothing about that send is rewritten.
+     */
+    legacy: boolean;
+    startAtMs: number | null;
+    endAtMs: number | null;
+    listIds: string[];
+    sends: CampaignSend[];
+    rollup: CampaignRollup;
+    windowState: CampaignWindowState;
+    /** For ordering: the campaign's start, else its most recent send. */
+    atMs: number | null;
+}
+/**
+ * The campaigns table's rows: every container, plus every send that belongs
+ * to none.
+ *
+ * The second half is what makes the container additive. A merchant's history
+ * is the sends they already have; a list that showed only containers would
+ * read as an empty product on the day this shipped, and a backfill that
+ * adopted each old send into a container of one would rewrite documents whose
+ * ids are cited by mail already delivered. Adopting them AT READ TIME costs a
+ * pass over a list already in memory and rewrites nothing.
+ *
+ * Newest first, on the start date where there is one and the last send
+ * otherwise. Rows with no date at all sort last: they are campaigns nobody
+ * has scheduled or sent, and dating them from nothing would be an invention.
+ */
+export declare function campaignListRows(campaigns: EmailCampaign[], sends: CampaignSend[], nowMs: number): CampaignListRow[];