@aglyn/shared-ui-email-campaigns 1.0.0-beta.143

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

@@ -0,0 +1,286 @@
+/**
+ * @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.
+ */
+import type { CampaignCaveat } from './campaign-report';
+/**
+ * WHAT A CAMPAIGN CAUSED — the read half of the identify-moment join.
+ *
+ * `campaign-revenue.ts` answers what a campaign EARNED, from orders that name
+ * their buyer. This answers what it CAUSED among people who were anonymous
+ * until the moment they became somebody: they arrive from a campaign link,
+ * browse, and only become identifiable when they submit a form, sign up, book
+ * or check out. Same window, same last-click rule, same `model`/`windowDays`
+ * stamped on every record, so the two figures on one screen are two readings
+ * of one rule rather than two rules that happen to agree.
+ *
+ * ## THE KINDS ARE NEVER SUMMED, and this module makes that structural
+ *
+ * One form submission by a new person writes a submission record, a contact
+ * and a lead — three true statements about one visitor action. Adding them
+ * would treble every campaign's conversions, and the reader would have no way
+ * to see it had happened, because the sum looks like a bigger version of a
+ * real number.
+ *
+ * So {@link CampaignConversionsReport} carries no total, no `all`, no
+ * `conversions` scalar, and there is no function here that reduces the kinds.
+ * A screen that wanted one would have to write the addition itself. The
+ * report also raises {@link CampaignCaveat} `conversions-kinds-overlap` so
+ * the reader is told WHY the four figures stand apart, rather than being left
+ * to assume the product forgot to add them up.
+ *
+ * ## THE WEB CHANNEL HAS NO ROLLUP, and cannot be given one
+ *
+ * A conversion is credited to one of two touches. An EMAIL touch names a
+ * campaign document — a real entity with a real id — so its conversions roll
+ * up under it beside the revenue the same join credits it with. A WEB touch
+ * is a `utm_` label a marketer typed into a URL: no document, no id, and no
+ * bound on how many distinct values exist, because anybody who can vary a
+ * query string can mint another one.
+ *
+ * A rollup keyed on that label is a map a stranger can grow, which is the
+ * same unbounded key space the analytics collector caps its per-day label map
+ * against. So the writer increments the rollup for the email channel ONLY,
+ * this reader states that where the figure is drawn, and web-channel records
+ * are read as records — see {@link campaignConversionsCoverage}.
+ *
+ * ## A CONVERSION WITH NO TOUCH IS NOT IN HERE AT ALL
+ *
+ * Direct traffic writes no record. There is deliberately no
+ * `utm_source=direct` placeholder, no referrer inference and no "most recent
+ * campaign on this site" fallback: a conversion nobody can be credited with
+ * is a conversion nobody is credited with.
+ *
+ * That makes the absence of a record load-bearing, and it makes a screen
+ * showing only attributed conversions a lie by omission — it renders "we
+ * credited three of these" as "three of these happened".
+ * {@link campaignConversionsCoverage} exists so the unattributed count is a
+ * figure on the page rather than an inference nobody makes.
+ */
+/**
+ * Which identify moment a record credits.
+ *
+ * An array first, because the ORDER is the reading order on every screen and
+ * a second list of these is a second chance to leave one out. The union is
+ * derived from it rather than written twice.
+ */
+export declare const CAMPAIGN_CONVERSION_KINDS: readonly ["form", "lead", "contact", "booking"];
+/** One identify moment. Mirrors the writer's `CampaignConversionKind`. */
+export type CampaignConversionKind = (typeof CAMPAIGN_CONVERSION_KINDS)[number];
+/** Which channel the credited touch arrived through. */
+export type CampaignTouchChannel = 'email' | 'web';
+/**
+ * What a reader calls one kind, and what the count means.
+ *
+ * The note is the half that stops the addition. Each one names a DIFFERENT
+ * population of the same visitors, and saying so under every figure is what
+ * makes four numbers standing apart read as deliberate rather than as a
+ * missing total.
+ */
+export interface CampaignConversionKindCopy {
+    label: string;
+    note: string;
+}
+export declare const CAMPAIGN_CONVERSION_KIND_COPY: Readonly<Record<CampaignConversionKind, CampaignConversionKindCopy>>;
+/**
+ * The stored shape of `campaigns/{campaignId}/reports/conversions`.
+ *
+ * Its own document beside `reports/revenue`, for the reason that one is: the
+ * campaign document is read by the history list, the glance widget and the
+ * send path, and a map that grows with what the campaign caused would enlarge
+ * every one of those reads.
+ */
+export interface CampaignConversionsRollup {
+    byKind?: Partial<Record<CampaignConversionKind, number>>;
+    /** The model these conversions were credited under. */
+    model?: string;
+    /** The window, in days, they were credited inside. */
+    windowDays?: number;
+}
+/**
+ * The stored shape of `hosts/{hostId}/campaignAttributions/{kind}:{refId}`.
+ *
+ * Read-side only, and every field optional: this is a document somebody
+ * else's writer produced, and a reader that assumed a field was present would
+ * throw on the first record written by an older version of it.
+ */
+export interface CampaignConversionRecord {
+    kind?: CampaignConversionKind;
+    /** The submission, lead, contact or booking this credits. */
+    refId?: string;
+    channel?: CampaignTouchChannel;
+    /** The campaign document, when the touch was a click on our own mail. */
+    campaignId?: string;
+    /** `utm_source`, when the touch was a link on the web. */
+    source?: string;
+    /** `utm_medium`, when the touch was a link on the web. */
+    medium?: string;
+    /** `utm_campaign`, when the touch was a link on the web. */
+    campaign?: string;
+    /** When the visitor followed the campaign link, epoch ms. */
+    touchedAtMs?: number;
+    /** When the visitor became identifiable, epoch ms. */
+    convertedAtMs?: number;
+    model?: string;
+    windowDays?: number;
+}
+/**
+ * The document id for one conversion — `{kind}:{refId}`.
+ *
+ * The reader's half of the writer's `campaignConversionId`. It is restated
+ * here rather than imported because the writer lives in `tenant-data-admin`,
+ * which a UI library may not import, and it is one line whose shape is
+ * asserted in this module's spec.
+ *
+ * Answers `null` for an unusable pair rather than building `form:undefined`,
+ * which would be a valid document path pointing at a record that can never
+ * exist — a keyed read that silently reports "not attributed" for every
+ * record on the screen.
+ */
+export declare function campaignConversionId(kind: string | null | undefined, refId: string | null | undefined): string | null;
+/** One kind's figure on screen. Independent of every other kind's. */
+export interface CampaignConversionKindReport {
+    kind: CampaignConversionKind;
+    label: string;
+    /**
+     * Conversions of this kind, or `null` when the rollup holds no entry.
+     *
+     * `null` rather than 0 for {@link CampaignConversionsReport.recorded}'s
+     * reason, applied per kind: a site with no booking form has never written a
+     * booking conversion, and rendering that as a measured zero invites the
+     * reader to conclude the campaign failed at something it never attempted.
+     */
+    value: number | null;
+    note: string;
+}
+/** Everything the conversions section renders. */
+export interface CampaignConversionsReport {
+    /**
+     * One entry per kind, always all four and always in
+     * {@link CAMPAIGN_CONVERSION_KINDS} order.
+     *
+     * There is deliberately NO total beside this array, and no field anywhere
+     * on this report that holds one. See the module docblock.
+     */
+    kinds: CampaignConversionKindReport[];
+    /**
+     * Whether the rollup document exists at all.
+     *
+     * `false` is NOT "this campaign caused nothing" — it is also every campaign
+     * sent before the join existed, and every campaign whose conversions all
+     * arrived through the web channel, which writes no rollup. The screen
+     * renders the difference rather than printing a zero for all three.
+     */
+    recorded: boolean;
+    /** At least one kind holds a figure. */
+    any: boolean;
+    /** The model these figures were credited under, as stored. */
+    model: string;
+    /** The window they were credited inside, as stored. */
+    windowDays: number;
+    caveats: CampaignCaveat[];
+}
+/**
+ * Turns the stored rollup into the conversions section.
+ *
+ * Takes the rollup and nothing else. Unlike the revenue report there is no
+ * denominator to hand in: a conversion RATE over delivered messages would be
+ * the same defect the revenue section refuses for orders — one visitor can
+ * submit two forms, so the quotient passes 100% without anything being wrong
+ * — and counting distinct people would need a document per person per
+ * campaign, the per-recipient read this whole surface exists to refuse.
+ */
+export declare function campaignConversionsReport(options: {
+    rollup: CampaignConversionsRollup | undefined;
+}): CampaignConversionsReport;
+/**
+ * How much of one kind was credited to anything at all.
+ *
+ * ## Why this figure has to exist
+ *
+ * The join writes nothing for a conversion it cannot credit, so a list of
+ * attribution records is a list of the SUCCESSES. Rendering only that turns
+ * "we credited four of these" into "four of these happened", and the reader
+ * draws a conclusion about their campaigns from a number that is mostly a
+ * fact about how many visitors arrived without a campaign link.
+ *
+ * So the screen shows both halves and this computes the second. `attributed`
+ * is counted over the attribution records; `total` over the records the
+ * conversions themselves live in.
+ *
+ * ## Why the difference is a CEILING and says so
+ *
+ * The two counts come from different collections with different histories,
+ * and the gap between them holds three things that are not the same:
+ *
+ *  - conversions by visitors who arrived directly, which is what the figure
+ *    is meant to describe;
+ *  - conversions from before the join existed, which were never eligible; and
+ *  - for contacts, conversions on the org's OTHER sites, because contacts are
+ *    shared across an org while attributions are per host.
+ *
+ * None of those can be separated from the others without a field nobody
+ * writes, so `unattributed` is reported as an upper bound and
+ * {@link CampaignConversionsCoverage.exact} is `false` whenever the reasons
+ * apply. A figure presented as exact when it is not is the failure this
+ * whole surface is built to avoid.
+ */
+export interface CampaignConversionsCoverage {
+    kind: CampaignConversionKind;
+    /** Conversions of this kind credited to some campaign or label. */
+    attributed: number;
+    /** Conversions of this kind that exist, credited or not. */
+    total: number;
+    /** `total - attributed`, clamped at zero. An upper bound, not a count. */
+    unattributed: number;
+    /**
+     * Whether `unattributed` may be read as "arrived directly".
+     *
+     * Always `false` today — the three reasons in the docblock all apply to
+     * every host — and kept as a field rather than hardcoded in the copy so a
+     * screen asks the model rather than restating its conclusion.
+     */
+    exact: boolean;
+    caveats: CampaignCaveat[];
+}
+/**
+ * The attributed/unattributed split for one kind.
+ *
+ * `total` is `null` when it could not be counted — the aggregation failed, or
+ * the collection is not readable from this surface — and the split is then
+ * withheld entirely rather than defaulting `total` to `attributed`, which
+ * would render every conversion as attributed and is the single most
+ * flattering wrong answer available here.
+ */
+export declare function campaignConversionsCoverage(options: {
+    kind: CampaignConversionKind;
+    attributed: number | null | undefined;
+    total: number | null | undefined;
+    /** The kind's records live outside this host, so `total` over-counts. */
+    crossHostTotal?: boolean;
+}): CampaignConversionsCoverage | null;
+/**
+ * How a record names the thing it was credited to.
+ *
+ * The email channel names a campaign document, so the screen can link to it.
+ * The web channel names a label the marketer typed, which is text and never a
+ * link — there is nothing at the other end of it.
+ *
+ * The `utm_` triple is joined in the order a marketer set it, with the parts
+ * that are absent left out rather than filled with a placeholder.
+ * `google / cpc` and `google / cpc / (none)` describe the same link, and only
+ * one of them invites the reader to look for a campaign called "(none)".
+ */
+export declare function campaignTouchLabel(record: CampaignConversionRecord | null | undefined): string;

package/src/lib/model/campaign-conversions.js

@@ -0,0 +1,249 @@
+/**
+ * @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.
+ */ /*
+ * The window and the model name come from `@aglyn/shared-util-email`, for the
+ * reason `campaign-revenue.ts` gives: the writer is in `tenant-data-admin`,
+ * which may not import a feature plugin, and a rule defined on both sides of
+ * the join drifts into a figure credited under one and printed under another.
+ */ import { EMAIL_ATTRIBUTION_MODEL, EMAIL_ATTRIBUTION_WINDOW_DAYS } from "@aglyn/shared-util-email";
+/**
+ * WHAT A CAMPAIGN CAUSED — the read half of the identify-moment join.
+ *
+ * `campaign-revenue.ts` answers what a campaign EARNED, from orders that name
+ * their buyer. This answers what it CAUSED among people who were anonymous
+ * until the moment they became somebody: they arrive from a campaign link,
+ * browse, and only become identifiable when they submit a form, sign up, book
+ * or check out. Same window, same last-click rule, same `model`/`windowDays`
+ * stamped on every record, so the two figures on one screen are two readings
+ * of one rule rather than two rules that happen to agree.
+ *
+ * ## THE KINDS ARE NEVER SUMMED, and this module makes that structural
+ *
+ * One form submission by a new person writes a submission record, a contact
+ * and a lead — three true statements about one visitor action. Adding them
+ * would treble every campaign's conversions, and the reader would have no way
+ * to see it had happened, because the sum looks like a bigger version of a
+ * real number.
+ *
+ * So {@link CampaignConversionsReport} carries no total, no `all`, no
+ * `conversions` scalar, and there is no function here that reduces the kinds.
+ * A screen that wanted one would have to write the addition itself. The
+ * report also raises {@link CampaignCaveat} `conversions-kinds-overlap` so
+ * the reader is told WHY the four figures stand apart, rather than being left
+ * to assume the product forgot to add them up.
+ *
+ * ## THE WEB CHANNEL HAS NO ROLLUP, and cannot be given one
+ *
+ * A conversion is credited to one of two touches. An EMAIL touch names a
+ * campaign document — a real entity with a real id — so its conversions roll
+ * up under it beside the revenue the same join credits it with. A WEB touch
+ * is a `utm_` label a marketer typed into a URL: no document, no id, and no
+ * bound on how many distinct values exist, because anybody who can vary a
+ * query string can mint another one.
+ *
+ * A rollup keyed on that label is a map a stranger can grow, which is the
+ * same unbounded key space the analytics collector caps its per-day label map
+ * against. So the writer increments the rollup for the email channel ONLY,
+ * this reader states that where the figure is drawn, and web-channel records
+ * are read as records — see {@link campaignConversionsCoverage}.
+ *
+ * ## A CONVERSION WITH NO TOUCH IS NOT IN HERE AT ALL
+ *
+ * Direct traffic writes no record. There is deliberately no
+ * `utm_source=direct` placeholder, no referrer inference and no "most recent
+ * campaign on this site" fallback: a conversion nobody can be credited with
+ * is a conversion nobody is credited with.
+ *
+ * That makes the absence of a record load-bearing, and it makes a screen
+ * showing only attributed conversions a lie by omission — it renders "we
+ * credited three of these" as "three of these happened".
+ * {@link campaignConversionsCoverage} exists so the unattributed count is a
+ * figure on the page rather than an inference nobody makes.
+ */ /*
+ * The constants are NOT re-exported here, though `campaign-revenue.ts`
+ * re-exports the same two. Both modules sit behind one barrel, and a name
+ * exported twice through it is a name a bundler has to disambiguate. Every
+ * screen reads the rule off `model`/`windowDays` on the report anyway, which
+ * is the stored value rather than today's constant — a campaign credited
+ * under an older window has to print the window it was credited under.
+ */ /**
+ * Which identify moment a record credits.
+ *
+ * An array first, because the ORDER is the reading order on every screen and
+ * a second list of these is a second chance to leave one out. The union is
+ * derived from it rather than written twice.
+ */ export const CAMPAIGN_CONVERSION_KINDS = [
+    'form',
+    'lead',
+    'contact',
+    'booking'
+];
+export const CAMPAIGN_CONVERSION_KIND_COPY = {
+    form: {
+        label: 'Form submissions',
+        note: 'submissions credited to this campaign'
+    },
+    lead: {
+        label: 'Leads',
+        note: 'new leads credited to this campaign'
+    },
+    contact: {
+        label: 'Contacts',
+        note: 'new contacts credited to this campaign'
+    },
+    booking: {
+        label: 'Bookings',
+        note: 'bookings credited to this campaign'
+    }
+};
+/**
+ * The document id for one conversion — `{kind}:{refId}`.
+ *
+ * The reader's half of the writer's `campaignConversionId`. It is restated
+ * here rather than imported because the writer lives in `tenant-data-admin`,
+ * which a UI library may not import, and it is one line whose shape is
+ * asserted in this module's spec.
+ *
+ * Answers `null` for an unusable pair rather than building `form:undefined`,
+ * which would be a valid document path pointing at a record that can never
+ * exist — a keyed read that silently reports "not attributed" for every
+ * record on the screen.
+ */ export function campaignConversionId(kind, refId) {
+    const k = String(kind != null ? kind : '');
+    const ref = String(refId != null ? refId : '');
+    if (!k || !ref) return null;
+    if (!CAMPAIGN_CONVERSION_KINDS.includes(k)) return null;
+    // A slash would leave the collection; the id scheme already spends the
+    // colon, and a ref carrying one would make the pair ambiguous.
+    if (ref.includes('/') || ref.includes(':')) return null;
+    return `${k}:${ref}`;
+}
+/** A stored count as a non-negative integer. */ function count(raw) {
+    const value = Math.floor(Number(raw != null ? raw : 0));
+    return Number.isFinite(value) && value > 0 ? value : 0;
+}
+/**
+ * Turns the stored rollup into the conversions section.
+ *
+ * Takes the rollup and nothing else. Unlike the revenue report there is no
+ * denominator to hand in: a conversion RATE over delivered messages would be
+ * the same defect the revenue section refuses for orders — one visitor can
+ * submit two forms, so the quotient passes 100% without anything being wrong
+ * — and counting distinct people would need a document per person per
+ * campaign, the per-recipient read this whole surface exists to refuse.
+ */ export function campaignConversionsReport(options) {
+    var _ref, _ref1;
+    const { rollup } = options;
+    const stored = (_ref = rollup == null ? void 0 : rollup.byKind) != null ? _ref : {};
+    const caveats = [];
+    const kinds = CAMPAIGN_CONVERSION_KINDS.map((kind)=>{
+        const raw = stored[kind];
+        const copy = CAMPAIGN_CONVERSION_KIND_COPY[kind];
+        return {
+            kind,
+            label: copy.label,
+            // `undefined` means the rollup has no entry for this kind, which is
+            // not a measured zero. A stored 0 is impossible — the writer only
+            // ever increments — but it is read as unrecorded for the same reason.
+            value: raw === undefined || count(raw) === 0 ? null : count(raw),
+            note: copy.note
+        };
+    });
+    const any = kinds.some((entry)=>entry.value !== null);
+    if (any) {
+        caveats.push({
+            id: 'conversions-kinds-overlap',
+            message: 'These figures count different things about the same visits and are ' + 'deliberately not added together. One person filling in one form can ' + 'appear as a submission, a contact and a lead, so a total would ' + 'count that visit three times.'
+        });
+        caveats.push({
+            id: 'conversions-web-not-rolled-up',
+            message: 'Campaign emails only. A conversion credited to a link tagged with ' + 'utm_ parameters is recorded against that label rather than against ' + 'a campaign, so it is not in the figures above — those conversions ' + 'are listed under Conversions in the marketing console.'
+        });
+    }
+    return {
+        kinds,
+        recorded: rollup !== undefined,
+        any,
+        model: String((_ref1 = rollup == null ? void 0 : rollup.model) != null ? _ref1 : EMAIL_ATTRIBUTION_MODEL),
+        windowDays: count(rollup == null ? void 0 : rollup.windowDays) || EMAIL_ATTRIBUTION_WINDOW_DAYS,
+        caveats
+    };
+}
+/**
+ * The attributed/unattributed split for one kind.
+ *
+ * `total` is `null` when it could not be counted — the aggregation failed, or
+ * the collection is not readable from this surface — and the split is then
+ * withheld entirely rather than defaulting `total` to `attributed`, which
+ * would render every conversion as attributed and is the single most
+ * flattering wrong answer available here.
+ */ export function campaignConversionsCoverage(options) {
+    const { kind, crossHostTotal } = options;
+    if (options.total == null || options.attributed == null) return null;
+    const attributed = count(options.attributed);
+    const total = count(options.total);
+    const caveats = [];
+    /*
+   * CLAMPED, and only here at the point of display. The two counts are taken
+   * from two collections a moment apart, so a conversion recorded between
+   * them makes `attributed` briefly exceed `total`; a negative count of
+   * things that did not happen is not a sentence anybody can act on.
+   */ const unattributed = Math.max(0, total - attributed);
+    caveats.push({
+        id: 'conversions-unattributed-is-a-ceiling',
+        message: `${unattributed.toLocaleString()} of these are not credited to any ` + 'campaign. Most arrived without following a campaign link and are ' + 'recorded as direct — nothing is guessed from a referrer, and no ' + 'campaign is credited for being the most recent one to run. The rest ' + 'are records from before campaign attribution was recorded at all, so ' + 'read this as an upper bound rather than a count of direct arrivals.'
+    });
+    if (crossHostTotal) {
+        caveats.push({
+            id: 'conversions-total-crosses-hosts',
+            message: 'Contacts are shared across every site in this organization, while ' + 'attributions belong to one site. The uncredited figure therefore ' + 'includes contacts that were created on another site and could ' + 'never have been credited here.'
+        });
+    }
+    return {
+        kind,
+        attributed,
+        total,
+        unattributed,
+        // Never true while the reasons above stand. The field exists so a screen
+        // reads the model rather than restating its conclusion in JSX.
+        exact: false,
+        caveats
+    };
+}
+/**
+ * How a record names the thing it was credited to.
+ *
+ * The email channel names a campaign document, so the screen can link to it.
+ * The web channel names a label the marketer typed, which is text and never a
+ * link — there is nothing at the other end of it.
+ *
+ * The `utm_` triple is joined in the order a marketer set it, with the parts
+ * that are absent left out rather than filled with a placeholder.
+ * `google / cpc` and `google / cpc / (none)` describe the same link, and only
+ * one of them invites the reader to look for a campaign called "(none)".
+ */ export function campaignTouchLabel(record) {
+    var _record_campaignId;
+    if (!record) return '';
+    if (record.channel === 'email') return String((_record_campaignId = record.campaignId) != null ? _record_campaignId : '');
+    const parts = [
+        record.source,
+        record.medium,
+        record.campaign
+    ].map((part)=>String(part != null ? part : '').trim()).filter(Boolean);
+    return parts.join(' / ');
+}
+
+//# sourceMappingURL=campaign-conversions.js.map

package/src/lib/model/campaign-conversions.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../../../libs/shared/ui/email-campaigns/src/lib/model/campaign-conversions.ts"],"sourcesContent":["/**\n * @license\n * Copyright 2026 Aglyn LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *   http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/*\n * The window and the model name come from `@aglyn/shared-util-email`, for the\n * reason `campaign-revenue.ts` gives: the writer is in `tenant-data-admin`,\n * which may not import a feature plugin, and a rule defined on both sides of\n * the join drifts into a figure credited under one and printed under another.\n */\nimport {\n  EMAIL_ATTRIBUTION_MODEL,\n  EMAIL_ATTRIBUTION_WINDOW_DAYS,\n} from '@aglyn/shared-util-email'\nimport type { CampaignCaveat } from './campaign-report'\n\n/**\n * WHAT A CAMPAIGN CAUSED — the read half of the identify-moment join.\n *\n * `campaign-revenue.ts` answers what a campaign EARNED, from orders that name\n * their buyer. This answers what it CAUSED among people who were anonymous\n * until the moment they became somebody: they arrive from a campaign link,\n * browse, and only become identifiable when they submit a form, sign up, book\n * or check out. Same window, same last-click rule, same `model`/`windowDays`\n * stamped on every record, so the two figures on one screen are two readings\n * of one rule rather than two rules that happen to agree.\n *\n * ## THE KINDS ARE NEVER SUMMED, and this module makes that structural\n *\n * One form submission by a new person writes a submission record, a contact\n * and a lead — three true statements about one visitor action. Adding them\n * would treble every campaign's conversions, and the reader would have no way\n * to see it had happened, because the sum looks like a bigger version of a\n * real number.\n *\n * So {@link CampaignConversionsReport} carries no total, no `all`, no\n * `conversions` scalar, and there is no function here that reduces the kinds.\n * A screen that wanted one would have to write the addition itself. The\n * report also raises {@link CampaignCaveat} `conversions-kinds-overlap` so\n * the reader is told WHY the four figures stand apart, rather than being left\n * to assume the product forgot to add them up.\n *\n * ## THE WEB CHANNEL HAS NO ROLLUP, and cannot be given one\n *\n * A conversion is credited to one of two touches. An EMAIL touch names a\n * campaign document — a real entity with a real id — so its conversions roll\n * up under it beside the revenue the same join credits it with. A WEB touch\n * is a `utm_` label a marketer typed into a URL: no document, no id, and no\n * bound on how many distinct values exist, because anybody who can vary a\n * query string can mint another one.\n *\n * A rollup keyed on that label is a map a stranger can grow, which is the\n * same unbounded key space the analytics collector caps its per-day label map\n * against. So the writer increments the rollup for the email channel ONLY,\n * this reader states that where the figure is drawn, and web-channel records\n * are read as records — see {@link campaignConversionsCoverage}.\n *\n * ## A CONVERSION WITH NO TOUCH IS NOT IN HERE AT ALL\n *\n * Direct traffic writes no record. There is deliberately no\n * `utm_source=direct` placeholder, no referrer inference and no \"most recent\n * campaign on this site\" fallback: a conversion nobody can be credited with\n * is a conversion nobody is credited with.\n *\n * That makes the absence of a record load-bearing, and it makes a screen\n * showing only attributed conversions a lie by omission — it renders \"we\n * credited three of these\" as \"three of these happened\".\n * {@link campaignConversionsCoverage} exists so the unattributed count is a\n * figure on the page rather than an inference nobody makes.\n */\n\n/*\n * The constants are NOT re-exported here, though `campaign-revenue.ts`\n * re-exports the same two. Both modules sit behind one barrel, and a name\n * exported twice through it is a name a bundler has to disambiguate. Every\n * screen reads the rule off `model`/`windowDays` on the report anyway, which\n * is the stored value rather than today's constant — a campaign credited\n * under an older window has to print the window it was credited under.\n */\n\n/**\n * Which identify moment a record credits.\n *\n * An array first, because the ORDER is the reading order on every screen and\n * a second list of these is a second chance to leave one out. The union is\n * derived from it rather than written twice.\n */\nexport const CAMPAIGN_CONVERSION_KINDS = [\n  'form',\n  'lead',\n  'contact',\n  'booking',\n] as const\n\n/** One identify moment. Mirrors the writer's `CampaignConversionKind`. */\nexport type CampaignConversionKind = (typeof CAMPAIGN_CONVERSION_KINDS)[number]\n\n/** Which channel the credited touch arrived through. */\nexport type CampaignTouchChannel = 'email' | 'web'\n\n/**\n * What a reader calls one kind, and what the count means.\n *\n * The note is the half that stops the addition. Each one names a DIFFERENT\n * population of the same visitors, and saying so under every figure is what\n * makes four numbers standing apart read as deliberate rather than as a\n * missing total.\n */\nexport interface CampaignConversionKindCopy {\n  label: string\n  note: string\n}\n\nexport const CAMPAIGN_CONVERSION_KIND_COPY: Readonly<\n  Record<CampaignConversionKind, CampaignConversionKindCopy>\n> = {\n  form: {\n    label: 'Form submissions',\n    note: 'submissions credited to this campaign',\n  },\n  lead: { label: 'Leads', note: 'new leads credited to this campaign' },\n  contact: {\n    label: 'Contacts',\n    note: 'new contacts credited to this campaign',\n  },\n  booking: { label: 'Bookings', note: 'bookings credited to this campaign' },\n}\n\n/**\n * The stored shape of `campaigns/{campaignId}/reports/conversions`.\n *\n * Its own document beside `reports/revenue`, for the reason that one is: the\n * campaign document is read by the history list, the glance widget and the\n * send path, and a map that grows with what the campaign caused would enlarge\n * every one of those reads.\n */\nexport interface CampaignConversionsRollup {\n  byKind?: Partial<Record<CampaignConversionKind, number>>\n  /** The model these conversions were credited under. */\n  model?: string\n  /** The window, in days, they were credited inside. */\n  windowDays?: number\n}\n\n/**\n * The stored shape of `hosts/{hostId}/campaignAttributions/{kind}:{refId}`.\n *\n * Read-side only, and every field optional: this is a document somebody\n * else's writer produced, and a reader that assumed a field was present would\n * throw on the first record written by an older version of it.\n */\nexport interface CampaignConversionRecord {\n  kind?: CampaignConversionKind\n  /** The submission, lead, contact or booking this credits. */\n  refId?: string\n  channel?: CampaignTouchChannel\n  /** The campaign document, when the touch was a click on our own mail. */\n  campaignId?: string\n  /** `utm_source`, when the touch was a link on the web. */\n  source?: string\n  /** `utm_medium`, when the touch was a link on the web. */\n  medium?: string\n  /** `utm_campaign`, when the touch was a link on the web. */\n  campaign?: string\n  /** When the visitor followed the campaign link, epoch ms. */\n  touchedAtMs?: number\n  /** When the visitor became identifiable, epoch ms. */\n  convertedAtMs?: number\n  model?: string\n  windowDays?: number\n}\n\n/**\n * The document id for one conversion — `{kind}:{refId}`.\n *\n * The reader's half of the writer's `campaignConversionId`. It is restated\n * here rather than imported because the writer lives in `tenant-data-admin`,\n * which a UI library may not import, and it is one line whose shape is\n * asserted in this module's spec.\n *\n * Answers `null` for an unusable pair rather than building `form:undefined`,\n * which would be a valid document path pointing at a record that can never\n * exist — a keyed read that silently reports \"not attributed\" for every\n * record on the screen.\n */\nexport function campaignConversionId(\n  kind: string | null | undefined,\n  refId: string | null | undefined,\n): string | null {\n  const k = String(kind ?? '')\n  const ref = String(refId ?? '')\n  if (!k || !ref) return null\n  if (!(CAMPAIGN_CONVERSION_KINDS as readonly string[]).includes(k)) return null\n  // A slash would leave the collection; the id scheme already spends the\n  // colon, and a ref carrying one would make the pair ambiguous.\n  if (ref.includes('/') || ref.includes(':')) return null\n  return `${k}:${ref}`\n}\n\n/** A stored count as a non-negative integer. */\nfunction count(raw: unknown): number {\n  const value = Math.floor(Number(raw ?? 0))\n  return Number.isFinite(value) && value > 0 ? value : 0\n}\n\n/** One kind's figure on screen. Independent of every other kind's. */\nexport interface CampaignConversionKindReport {\n  kind: CampaignConversionKind\n  label: string\n  /**\n   * Conversions of this kind, or `null` when the rollup holds no entry.\n   *\n   * `null` rather than 0 for {@link CampaignConversionsReport.recorded}'s\n   * reason, applied per kind: a site with no booking form has never written a\n   * booking conversion, and rendering that as a measured zero invites the\n   * reader to conclude the campaign failed at something it never attempted.\n   */\n  value: number | null\n  note: string\n}\n\n/** Everything the conversions section renders. */\nexport interface CampaignConversionsReport {\n  /**\n   * One entry per kind, always all four and always in\n   * {@link CAMPAIGN_CONVERSION_KINDS} order.\n   *\n   * There is deliberately NO total beside this array, and no field anywhere\n   * on this report that holds one. See the module docblock.\n   */\n  kinds: CampaignConversionKindReport[]\n  /**\n   * Whether the rollup document exists at all.\n   *\n   * `false` is NOT \"this campaign caused nothing\" — it is also every campaign\n   * sent before the join existed, and every campaign whose conversions all\n   * arrived through the web channel, which writes no rollup. The screen\n   * renders the difference rather than printing a zero for all three.\n   */\n  recorded: boolean\n  /** At least one kind holds a figure. */\n  any: boolean\n  /** The model these figures were credited under, as stored. */\n  model: string\n  /** The window they were credited inside, as stored. */\n  windowDays: number\n  caveats: CampaignCaveat[]\n}\n\n/**\n * Turns the stored rollup into the conversions section.\n *\n * Takes the rollup and nothing else. Unlike the revenue report there is no\n * denominator to hand in: a conversion RATE over delivered messages would be\n * the same defect the revenue section refuses for orders — one visitor can\n * submit two forms, so the quotient passes 100% without anything being wrong\n * — and counting distinct people would need a document per person per\n * campaign, the per-recipient read this whole surface exists to refuse.\n */\nexport function campaignConversionsReport(options: {\n  rollup: CampaignConversionsRollup | undefined\n}): CampaignConversionsReport {\n  const { rollup } = options\n  const stored = rollup?.byKind ?? {}\n  const caveats: CampaignCaveat[] = []\n\n  const kinds: CampaignConversionKindReport[] = CAMPAIGN_CONVERSION_KINDS.map(\n    (kind) => {\n      const raw = stored[kind]\n      const copy = CAMPAIGN_CONVERSION_KIND_COPY[kind]\n      return {\n        kind,\n        label: copy.label,\n        // `undefined` means the rollup has no entry for this kind, which is\n        // not a measured zero. A stored 0 is impossible — the writer only\n        // ever increments — but it is read as unrecorded for the same reason.\n        value: raw === undefined || count(raw) === 0 ? null : count(raw),\n        note: copy.note,\n      }\n    },\n  )\n\n  const any = kinds.some((entry) => entry.value !== null)\n\n  if (any) {\n    caveats.push({\n      id: 'conversions-kinds-overlap',\n      message:\n        'These figures count different things about the same visits and are ' +\n        'deliberately not added together. One person filling in one form can ' +\n        'appear as a submission, a contact and a lead, so a total would ' +\n        'count that visit three times.',\n    })\n    caveats.push({\n      id: 'conversions-web-not-rolled-up',\n      message:\n        'Campaign emails only. A conversion credited to a link tagged with ' +\n        'utm_ parameters is recorded against that label rather than against ' +\n        'a campaign, so it is not in the figures above — those conversions ' +\n        'are listed under Conversions in the marketing console.',\n    })\n  }\n\n  return {\n    kinds,\n    recorded: rollup !== undefined,\n    any,\n    model: String(rollup?.model ?? EMAIL_ATTRIBUTION_MODEL),\n    windowDays: count(rollup?.windowDays) || EMAIL_ATTRIBUTION_WINDOW_DAYS,\n    caveats,\n  }\n}\n\n/**\n * How much of one kind was credited to anything at all.\n *\n * ## Why this figure has to exist\n *\n * The join writes nothing for a conversion it cannot credit, so a list of\n * attribution records is a list of the SUCCESSES. Rendering only that turns\n * \"we credited four of these\" into \"four of these happened\", and the reader\n * draws a conclusion about their campaigns from a number that is mostly a\n * fact about how many visitors arrived without a campaign link.\n *\n * So the screen shows both halves and this computes the second. `attributed`\n * is counted over the attribution records; `total` over the records the\n * conversions themselves live in.\n *\n * ## Why the difference is a CEILING and says so\n *\n * The two counts come from different collections with different histories,\n * and the gap between them holds three things that are not the same:\n *\n *  - conversions by visitors who arrived directly, which is what the figure\n *    is meant to describe;\n *  - conversions from before the join existed, which were never eligible; and\n *  - for contacts, conversions on the org's OTHER sites, because contacts are\n *    shared across an org while attributions are per host.\n *\n * None of those can be separated from the others without a field nobody\n * writes, so `unattributed` is reported as an upper bound and\n * {@link CampaignConversionsCoverage.exact} is `false` whenever the reasons\n * apply. A figure presented as exact when it is not is the failure this\n * whole surface is built to avoid.\n */\nexport interface CampaignConversionsCoverage {\n  kind: CampaignConversionKind\n  /** Conversions of this kind credited to some campaign or label. */\n  attributed: number\n  /** Conversions of this kind that exist, credited or not. */\n  total: number\n  /** `total - attributed`, clamped at zero. An upper bound, not a count. */\n  unattributed: number\n  /**\n   * Whether `unattributed` may be read as \"arrived directly\".\n   *\n   * Always `false` today — the three reasons in the docblock all apply to\n   * every host — and kept as a field rather than hardcoded in the copy so a\n   * screen asks the model rather than restating its conclusion.\n   */\n  exact: boolean\n  caveats: CampaignCaveat[]\n}\n\n/**\n * The attributed/unattributed split for one kind.\n *\n * `total` is `null` when it could not be counted — the aggregation failed, or\n * the collection is not readable from this surface — and the split is then\n * withheld entirely rather than defaulting `total` to `attributed`, which\n * would render every conversion as attributed and is the single most\n * flattering wrong answer available here.\n */\nexport function campaignConversionsCoverage(options: {\n  kind: CampaignConversionKind\n  attributed: number | null | undefined\n  total: number | null | undefined\n  /** The kind's records live outside this host, so `total` over-counts. */\n  crossHostTotal?: boolean\n}): CampaignConversionsCoverage | null {\n  const { kind, crossHostTotal } = options\n  if (options.total == null || options.attributed == null) return null\n  const attributed = count(options.attributed)\n  const total = count(options.total)\n  const caveats: CampaignCaveat[] = []\n\n  /*\n   * CLAMPED, and only here at the point of display. The two counts are taken\n   * from two collections a moment apart, so a conversion recorded between\n   * them makes `attributed` briefly exceed `total`; a negative count of\n   * things that did not happen is not a sentence anybody can act on.\n   */\n  const unattributed = Math.max(0, total - attributed)\n\n  caveats.push({\n    id: 'conversions-unattributed-is-a-ceiling',\n    message:\n      `${unattributed.toLocaleString()} of these are not credited to any ` +\n      'campaign. Most arrived without following a campaign link and are ' +\n      'recorded as direct — nothing is guessed from a referrer, and no ' +\n      'campaign is credited for being the most recent one to run. The rest ' +\n      'are records from before campaign attribution was recorded at all, so ' +\n      'read this as an upper bound rather than a count of direct arrivals.',\n  })\n  if (crossHostTotal) {\n    caveats.push({\n      id: 'conversions-total-crosses-hosts',\n      message:\n        'Contacts are shared across every site in this organization, while ' +\n        'attributions belong to one site. The uncredited figure therefore ' +\n        'includes contacts that were created on another site and could ' +\n        'never have been credited here.',\n    })\n  }\n\n  return {\n    kind,\n    attributed,\n    total,\n    unattributed,\n    // Never true while the reasons above stand. The field exists so a screen\n    // reads the model rather than restating its conclusion in JSX.\n    exact: false,\n    caveats,\n  }\n}\n\n/**\n * How a record names the thing it was credited to.\n *\n * The email channel names a campaign document, so the screen can link to it.\n * The web channel names a label the marketer typed, which is text and never a\n * link — there is nothing at the other end of it.\n *\n * The `utm_` triple is joined in the order a marketer set it, with the parts\n * that are absent left out rather than filled with a placeholder.\n * `google / cpc` and `google / cpc / (none)` describe the same link, and only\n * one of them invites the reader to look for a campaign called \"(none)\".\n */\nexport function campaignTouchLabel(\n  record: CampaignConversionRecord | null | undefined,\n): string {\n  if (!record) return ''\n  if (record.channel === 'email') return String(record.campaignId ?? '')\n  const parts = [record.source, record.medium, record.campaign]\n    .map((part) => String(part ?? '').trim())\n    .filter(Boolean)\n  return parts.join(' / ')\n}\n"],"names":["EMAIL_ATTRIBUTION_MODEL","EMAIL_ATTRIBUTION_WINDOW_DAYS","CAMPAIGN_CONVERSION_KINDS","CAMPAIGN_CONVERSION_KIND_COPY","form","label","note","lead","contact","booking","campaignConversionId","kind","refId","k","String","ref","includes","count","raw","value","Math","floor","Number","isFinite","campaignConversionsReport","options","rollup","stored","byKind","caveats","kinds","map","copy","undefined","any","some","entry","push","id","message","recorded","model","windowDays","campaignConversionsCoverage","crossHostTotal","total","attributed","unattributed","max","toLocaleString","exact","campaignTouchLabel","record","channel","campaignId","parts","source","medium","campaign","part","trim","filter","Boolean","join"],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAED;;;;;CAKC,GACD,SACEA,uBAAuB,EACvBC,6BAA6B,QACxB,2BAA0B;AAGjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqDC,GAED;;;;;;;CAOC,GAED;;;;;;CAMC,GACD,OAAO,MAAMC,4BAA4B;IACvC;IACA;IACA;IACA;CACD,CAAS;AAqBV,OAAO,MAAMC,gCAET;IACFC,MAAM;QACJC,OAAO;QACPC,MAAM;IACR;IACAC,MAAM;QAAEF,OAAO;QAASC,MAAM;IAAsC;IACpEE,SAAS;QACPH,OAAO;QACPC,MAAM;IACR;IACAG,SAAS;QAAEJ,OAAO;QAAYC,MAAM;IAAqC;AAC3E,EAAC;AA8CD;;;;;;;;;;;;CAYC,GACD,OAAO,SAASI,qBACdC,IAA+B,EAC/BC,KAAgC;IAEhC,MAAMC,IAAIC,OAAOH,eAAAA,OAAQ;IACzB,MAAMI,MAAMD,OAAOF,gBAAAA,QAAS;IAC5B,IAAI,CAACC,KAAK,CAACE,KAAK,OAAO;IACvB,IAAI,CAAC,AAACb,0BAAgDc,QAAQ,CAACH,IAAI,OAAO;IAC1E,uEAAuE;IACvE,+DAA+D;IAC/D,IAAIE,IAAIC,QAAQ,CAAC,QAAQD,IAAIC,QAAQ,CAAC,MAAM,OAAO;IACnD,OAAO,GAAGH,EAAE,CAAC,EAAEE,KAAK;AACtB;AAEA,8CAA8C,GAC9C,SAASE,MAAMC,GAAY;IACzB,MAAMC,QAAQC,KAAKC,KAAK,CAACC,OAAOJ,cAAAA,MAAO;IACvC,OAAOI,OAAOC,QAAQ,CAACJ,UAAUA,QAAQ,IAAIA,QAAQ;AACvD;AA8CA;;;;;;;;;CASC,GACD,OAAO,SAASK,0BAA0BC,OAEzC;;IACC,MAAM,EAAEC,MAAM,EAAE,GAAGD;IACnB,MAAME,iBAASD,0BAAAA,OAAQE,MAAM,mBAAI,CAAC;IAClC,MAAMC,UAA4B,EAAE;IAEpC,MAAMC,QAAwC5B,0BAA0B6B,GAAG,CACzE,CAACpB;QACC,MAAMO,MAAMS,MAAM,CAAChB,KAAK;QACxB,MAAMqB,OAAO7B,6BAA6B,CAACQ,KAAK;QAChD,OAAO;YACLA;YACAN,OAAO2B,KAAK3B,KAAK;YACjB,oEAAoE;YACpE,kEAAkE;YAClE,sEAAsE;YACtEc,OAAOD,QAAQe,aAAahB,MAAMC,SAAS,IAAI,OAAOD,MAAMC;YAC5DZ,MAAM0B,KAAK1B,IAAI;QACjB;IACF;IAGF,MAAM4B,MAAMJ,MAAMK,IAAI,CAAC,CAACC,QAAUA,MAAMjB,KAAK,KAAK;IAElD,IAAIe,KAAK;QACPL,QAAQQ,IAAI,CAAC;YACXC,IAAI;YACJC,SACE,wEACA,yEACA,oEACA;QACJ;QACAV,QAAQQ,IAAI,CAAC;YACXC,IAAI;YACJC,SACE,uEACA,wEACA,uEACA;QACJ;IACF;IAEA,OAAO;QACLT;QACAU,UAAUd,WAAWO;QACrBC;QACAO,OAAO3B,gBAAOY,0BAAAA,OAAQe,KAAK,oBAAIzC;QAC/B0C,YAAYzB,MAAMS,0BAAAA,OAAQgB,UAAU,KAAKzC;QACzC4B;IACF;AACF;AAqDA;;;;;;;;CAQC,GACD,OAAO,SAASc,4BAA4BlB,OAM3C;IACC,MAAM,EAAEd,IAAI,EAAEiC,cAAc,EAAE,GAAGnB;IACjC,IAAIA,QAAQoB,KAAK,IAAI,QAAQpB,QAAQqB,UAAU,IAAI,MAAM,OAAO;IAChE,MAAMA,aAAa7B,MAAMQ,QAAQqB,UAAU;IAC3C,MAAMD,QAAQ5B,MAAMQ,QAAQoB,KAAK;IACjC,MAAMhB,UAA4B,EAAE;IAEpC;;;;;GAKC,GACD,MAAMkB,eAAe3B,KAAK4B,GAAG,CAAC,GAAGH,QAAQC;IAEzCjB,QAAQQ,IAAI,CAAC;QACXC,IAAI;QACJC,SACE,GAAGQ,aAAaE,cAAc,GAAG,kCAAkC,CAAC,GACpE,sEACA,qEACA,yEACA,0EACA;IACJ;IACA,IAAIL,gBAAgB;QAClBf,QAAQQ,IAAI,CAAC;YACXC,IAAI;YACJC,SACE,uEACA,sEACA,mEACA;QACJ;IACF;IAEA,OAAO;QACL5B;QACAmC;QACAD;QACAE;QACA,yEAAyE;QACzE,+DAA+D;QAC/DG,OAAO;QACPrB;IACF;AACF;AAEA;;;;;;;;;;;CAWC,GACD,OAAO,SAASsB,mBACdC,MAAmD;QAGLA;IAD9C,IAAI,CAACA,QAAQ,OAAO;IACpB,IAAIA,OAAOC,OAAO,KAAK,SAAS,OAAOvC,QAAOsC,qBAAAA,OAAOE,UAAU,YAAjBF,qBAAqB;IACnE,MAAMG,QAAQ;QAACH,OAAOI,MAAM;QAAEJ,OAAOK,MAAM;QAAEL,OAAOM,QAAQ;KAAC,CAC1D3B,GAAG,CAAC,CAAC4B,OAAS7C,OAAO6C,eAAAA,OAAQ,IAAIC,IAAI,IACrCC,MAAM,CAACC;IACV,OAAOP,MAAMQ,IAAI,CAAC;AACpB"}