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

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../../../libs/plugins/marketing/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 '@aglyn/shared-ui-email-campaigns/model/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/**\n * Which channel the credited touch arrived through.\n *\n * `sequence` (AGL-3254) is a one-to-one email a rep's sequence sent: the\n * touch names the CAMPAIGN the sequence is in, like an email touch names\n * the campaign whose mail was clicked, plus the sequence and the enrollment\n * it came through, so a record can say which rep's outreach it credits.\n */\nexport type CampaignTouchChannel = 'email' | 'web' | 'sequence'\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  /**\n   * The campaign document, when the touch was a click on our own mail — or,\n   * for a `sequence` touch, the campaign container the sequence is in.\n   */\n  campaignId?: string\n  /** The sequence, when the touch was a sequence email (AGL-3254). */\n  sequenceId?: string\n  /** The enrollment the sequence email went out under (AGL-3254). */\n  enrollmentId?: 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 * and so does a sequence touch: the campaign the sequence is in is a\n * container with a page. The web channel names a label the marketer typed,\n * which is text and never a 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' || record.channel === 'sequence') {\n    return String(record.campaignId ?? '')\n  }\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;AA4BV,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;AAqDD;;;;;;;;;;;;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;;;;;;;;;;;;CAYC,GACD,OAAO,SAASsB,mBACdC,MAAmD;IAEnD,IAAI,CAACA,QAAQ,OAAO;IACpB,IAAIA,OAAOC,OAAO,KAAK,WAAWD,OAAOC,OAAO,KAAK,YAAY;YACjDD;QAAd,OAAOtC,QAAOsC,qBAAAA,OAAOE,UAAU,YAAjBF,qBAAqB;IACrC;IACA,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"}
+{"version":3,"sources":["../../../../../../../libs/plugins/marketing/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/**\n * Which channel the credited touch arrived through.\n *\n * `sequence` (AGL-3254) is a one-to-one email a rep's sequence sent: the\n * touch names the CAMPAIGN the sequence is in, like an email touch names\n * the campaign whose mail was clicked, plus the sequence and the enrollment\n * it came through, so a record can say which rep's outreach it credits.\n */\nexport type CampaignTouchChannel = 'email' | 'web' | 'sequence'\n\n/**\n * The record each conversion kind credits, as its owner publishes the kind\n * (`plugin-record-counts`, `plugin-record-lists`): a credited form names the\n * SUBMISSION it credits, the rest the record of their own name. The owners\n * count and read those records; this plugin only names the kind.\n */\nexport const CAMPAIGN_CONVERSION_RECORD_KINDS: Readonly<\n  Record<CampaignConversionKind, string>\n> = {\n  form: 'formSubmission',\n  lead: 'lead',\n  contact: 'contact',\n  booking: 'booking',\n}\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  /**\n   * The campaign document, when the touch was a click on our own mail — or,\n   * for a `sequence` touch, the campaign container the sequence is in.\n   */\n  campaignId?: string\n  /** The sequence, when the touch was a sequence email (AGL-3254). */\n  sequenceId?: string\n  /** The enrollment the sequence email went out under (AGL-3254). */\n  enrollmentId?: 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 * and so does a sequence touch: the campaign the sequence is in is a\n * container with a page. The web channel names a label the marketer typed,\n * which is text and never a 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' || record.channel === 'sequence') {\n    return String(record.campaignId ?? '')\n  }\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_RECORD_KINDS","form","lead","contact","booking","CAMPAIGN_CONVERSION_KIND_COPY","label","note","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;AAeV;;;;;CAKC,GACD,OAAO,MAAMC,mCAET;IACFC,MAAM;IACNC,MAAM;IACNC,SAAS;IACTC,SAAS;AACX,EAAC;AAeD,OAAO,MAAMC,gCAET;IACFJ,MAAM;QACJK,OAAO;QACPC,MAAM;IACR;IACAL,MAAM;QAAEI,OAAO;QAASC,MAAM;IAAsC;IACpEJ,SAAS;QACPG,OAAO;QACPC,MAAM;IACR;IACAH,SAAS;QAAEE,OAAO;QAAYC,MAAM;IAAqC;AAC3E,EAAC;AAqDD;;;;;;;;;;;;CAYC,GACD,OAAO,SAASC,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,AAACd,0BAAgDe,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,QAAwC7B,0BAA0B8B,GAAG,CACzE,CAACpB;QACC,MAAMO,MAAMS,MAAM,CAAChB,KAAK;QACxB,MAAMqB,OAAOzB,6BAA6B,CAACI,KAAK;QAChD,OAAO;YACLA;YACAH,OAAOwB,KAAKxB,KAAK;YACjB,oEAAoE;YACpE,kEAAkE;YAClE,sEAAsE;YACtEW,OAAOD,QAAQe,aAAahB,MAAMC,SAAS,IAAI,OAAOD,MAAMC;YAC5DT,MAAMuB,KAAKvB,IAAI;QACjB;IACF;IAGF,MAAMyB,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,oBAAI1C;QAC/B2C,YAAYzB,MAAMS,0BAAAA,OAAQgB,UAAU,KAAK1C;QACzC6B;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;;;;;;;;;;;;CAYC,GACD,OAAO,SAASsB,mBACdC,MAAmD;IAEnD,IAAI,CAACA,QAAQ,OAAO;IACpB,IAAIA,OAAOC,OAAO,KAAK,WAAWD,OAAOC,OAAO,KAAK,YAAY;YACjDD;QAAd,OAAOtC,QAAOsC,qBAAAA,OAAOE,UAAU,YAAjBF,qBAAqB;IACrC;IACA,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"}

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

@@ -0,0 +1,158 @@
+/**
+ * @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.
+ */
+/**
+ * WHAT ONE CAMPAIGN SEND DID, AND WHAT ITS SEQUENCES PRODUCED.
+ *
+ * The rate math and the link rollup every bulk sender divides by are the mail
+ * model's (`@aglyn/shared-ui-email-campaigns/model/send-report`); this is the
+ * campaign's reading of them — which population each rate is over, the
+ * caveats that qualify a figure, and the funnel a campaign's sequences report
+ * into. It keeps the rule that module states: a rate names its denominator,
+ * or it is not reported.
+ */
+import { type SendRate, type SendStats } from '@aglyn/shared-ui-email-campaigns/model/send-report';
+/** Why a number the report would otherwise show is being withheld. */
+export interface CampaignCaveat {
+    /** Stable id, so a spec can assert on the caveat rather than its prose. */
+    id: 'delivery-unrecorded' | 'click-tracking-unrecorded' | 'audience-truncated' | 'send-deferred' | 'revenue-denominator-unrecorded' | 'revenue-multi-currency' | 'revenue-mid-flight' | 'revenue-mixed-model' | 'conversions-kinds-overlap' | 'conversions-web-not-rolled-up' | 'conversions-unattributed-is-a-ceiling' | 'conversions-total-crosses-hosts' | 'sequences-funnel-not-summed';
+    message: string;
+}
+/** One population the send measured, for the audience breakdown. */
+export interface CampaignPopulation {
+    id: string;
+    label: string;
+    count: number;
+    /** What this count is a part OF, named. */
+    ofLabel: string;
+    of: number;
+}
+/** Everything the report screen renders, decided here rather than in JSX. */
+export interface CampaignReport {
+    sent: number;
+    recipients: number;
+    delivered: number | null;
+    opens: number;
+    clicks: number;
+    uniqueOpens: number | null;
+    uniqueClicks: number | null;
+    bounced: number;
+    complained: number;
+    unsubscribes: number;
+    /** Rates, each `null` when its denominator is zero or unrecorded. */
+    rates: {
+        /** Accepted by the receiving server, over what the provider accepted. */
+        delivery: SendRate | null;
+        /** Distinct readers who opened, over delivered. */
+        open: SendRate | null;
+        /** Distinct readers who clicked, over delivered. */
+        click: SendRate | null;
+        /**
+         * Distinct clickers over distinct OPENERS — a different question from
+         * `click`, and the one the two get confused for. It answers "of the
+         * people who read it, how many acted", not "of the people who received
+         * it". Reported separately and labelled separately, never as "click
+         * rate".
+         */
+        clickToOpen: SendRate | null;
+        /** Bounced over what the provider accepted. */
+        bounce: SendRate | null;
+        /** Complaints over delivered — the number mailbox providers judge on. */
+        complaint: SendRate | null;
+        /** Unsubscribes through this campaign's link, over delivered. */
+        unsubscribe: SendRate | null;
+    };
+    populations: CampaignPopulation[];
+    caveats: CampaignCaveat[];
+}
+/**
+ * Turns a stored `stats` map into the report.
+ *
+ * ## The denominator decisions, in one place
+ *
+ * - **`delivered`** carries the engagement rates — open, click, complaint,
+ *   unsubscribe. Mail that bounced was never in front of a human, so
+ *   including it in the denominator of an open rate depresses a number that
+ *   describes the audience with a fact about the address list. This is also
+ *   the convention every other tool reports, which matters: a merchant
+ *   comparing our figure with their previous ESP's must be comparing the same
+ *   quantity.
+ * - **`sent`** carries the delivery and bounce rates, because those describe
+ *   what happened to what we handed the provider, and `delivered` is the
+ *   numerator of one of them — a rate cannot be over itself.
+ * - **`uniqueOpens`** is the open-rate numerator, not `opens`. Open EVENTS
+ *   over recipients can exceed 100% the moment one person opens twice, and a
+ *   percentage above 100 is how a reader learns the number means something
+ *   other than what it says. Both are shown; only the distinct count is
+ *   divided.
+ *
+ * ## `delivered` unknown vs. zero
+ *
+ * A campaign predating the delivery webhook records no `delivered` at all.
+ * That is reported as `null` and every rate over it is withheld, with a
+ * caveat naming the reason — rather than substituting `sent`, which would
+ * silently publish the flattered number this module exists to refuse.
+ */
+export declare function campaignReport(stats: SendStats | undefined): CampaignReport;
+/**
+ * The outcomes the runtime credits, in funnel order. An array first, because
+ * the ORDER is the reading order and a second list is a second chance to
+ * leave one out; the union is derived from it.
+ */
+export declare const CAMPAIGN_SEQUENCE_OUTCOMES: readonly ["enrolled", "sent", "replied", "meetings", "converted"];
+export type CampaignSequenceOutcome = (typeof CAMPAIGN_SEQUENCE_OUTCOMES)[number];
+/**
+ * The org collection holding one document per campaign container,
+ * `orgs/{orgId}/campaignSequenceReports/{campaignId}`.
+ */
+export declare const CAMPAIGN_SEQUENCE_REPORTS_COLLECTION = "campaignSequenceReports";
+/** What a reader calls each outcome, and what the count means. */
+export declare const CAMPAIGN_SEQUENCE_OUTCOME_COPY: Readonly<Record<CampaignSequenceOutcome, {
+    label: string;
+    note: string;
+}>>;
+/**
+ * The stored shape of `campaignSequenceReports/{campaignId}`.
+ *
+ * Read-side only, every field optional: another plugin's runtime wrote it,
+ * and a reader that assumed a field was present would throw on the first
+ * document written before the field existed.
+ */
+export interface CampaignSequencesRollup {
+    byOutcome?: Partial<Record<CampaignSequenceOutcome, number>>;
+    /** When the runtime last credited anything, epoch ms. */
+    updatedAtMs?: number;
+}
+/** One outcome's figure on screen. */
+export interface CampaignSequenceFigure {
+    outcome: CampaignSequenceOutcome;
+    label: string;
+    /** The count, or `null` when the rollup holds no entry for the outcome. */
+    value: number | null;
+    note: string;
+}
+/** Everything the Sequences section renders. */
+export interface CampaignSequencesReport {
+    /** Always all five, always in {@link CAMPAIGN_SEQUENCE_OUTCOMES} order. */
+    figures: CampaignSequenceFigure[];
+    /** Whether the rollup document exists at all — see the block header. */
+    recorded: boolean;
+    /** At least one outcome holds a figure. */
+    any: boolean;
+    caveats: CampaignCaveat[];
+}
+/** Turns the stored rollup into the Sequences section. */
+export declare function campaignSequencesReport(rollup: CampaignSequencesRollup | undefined): CampaignSequencesReport;

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

@@ -0,0 +1,268 @@
+/**
+ * @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.
+ */ /**
+ * WHAT ONE CAMPAIGN SEND DID, AND WHAT ITS SEQUENCES PRODUCED.
+ *
+ * The rate math and the link rollup every bulk sender divides by are the mail
+ * model's (`@aglyn/shared-ui-email-campaigns/model/send-report`); this is the
+ * campaign's reading of them — which population each rate is over, the
+ * caveats that qualify a figure, and the funnel a campaign's sequences report
+ * into. It keeps the rule that module states: a rate names its denominator,
+ * or it is not reported.
+ */ import { sendRate } from "@aglyn/shared-ui-email-campaigns/model/send-report";
+/**
+ * Turns a stored `stats` map into the report.
+ *
+ * ## The denominator decisions, in one place
+ *
+ * - **`delivered`** carries the engagement rates — open, click, complaint,
+ *   unsubscribe. Mail that bounced was never in front of a human, so
+ *   including it in the denominator of an open rate depresses a number that
+ *   describes the audience with a fact about the address list. This is also
+ *   the convention every other tool reports, which matters: a merchant
+ *   comparing our figure with their previous ESP's must be comparing the same
+ *   quantity.
+ * - **`sent`** carries the delivery and bounce rates, because those describe
+ *   what happened to what we handed the provider, and `delivered` is the
+ *   numerator of one of them — a rate cannot be over itself.
+ * - **`uniqueOpens`** is the open-rate numerator, not `opens`. Open EVENTS
+ *   over recipients can exceed 100% the moment one person opens twice, and a
+ *   percentage above 100 is how a reader learns the number means something
+ *   other than what it says. Both are shown; only the distinct count is
+ *   divided.
+ *
+ * ## `delivered` unknown vs. zero
+ *
+ * A campaign predating the delivery webhook records no `delivered` at all.
+ * That is reported as `null` and every rate over it is withheld, with a
+ * caveat naming the reason — rather than substituting `sent`, which would
+ * silently publish the flattered number this module exists to refuse.
+ */ export function campaignReport(stats) {
+    var _source_sent, _source_recipients, _source_opens, _source_clicks, _source_bounced, _source_complained, _source_unsubscribes, _source_audienceSize, _source_deferred;
+    const source = stats != null ? stats : {};
+    const sent = Number((_source_sent = source.sent) != null ? _source_sent : 0);
+    const recipients = Number((_source_recipients = source.recipients) != null ? _source_recipients : 0);
+    const opens = Number((_source_opens = source.opens) != null ? _source_opens : 0);
+    const clicks = Number((_source_clicks = source.clicks) != null ? _source_clicks : 0);
+    const bounced = Number((_source_bounced = source.bounced) != null ? _source_bounced : 0);
+    const complained = Number((_source_complained = source.complained) != null ? _source_complained : 0);
+    const unsubscribes = Number((_source_unsubscribes = source.unsubscribes) != null ? _source_unsubscribes : 0);
+    /*
+   * ABSENT, not zero. `stats.delivered` is written only by the delivery
+   * webhook, so `undefined` means "no delivery event has ever been recorded
+   * for this campaign" — which for an old campaign means the webhook was not
+   * connected, and for a campaign sent thirty seconds ago means the events
+   * are still in flight. Neither is "nothing was delivered", and both are
+   * ruined by `?? 0`, which would turn the unknown into a hard zero and make
+   * every rate over it `null` for the RIGHT answer by the WRONG reasoning —
+   * and would render "0 delivered" on screen beside "500 sent".
+   */ const delivered = source.delivered === undefined ? null : Number(source.delivered);
+    const uniqueOpens = source.uniqueOpens === undefined ? null : Number(source.uniqueOpens);
+    const uniqueClicks = source.uniqueClicks === undefined ? null : Number(source.uniqueClicks);
+    /*
+   * The click rate is withheld for a campaign that never recorded carrying an
+   * HTML part, even when clicks are non-zero and `delivered` is known. See
+   * the structural-zero note in the module header: for those sends 0 is the
+   * only value the number could ever have taken, so a rate computed from it
+   * measures our sending code rather than the recipients.
+   */ const clickTrackable = source.clickTracked === true;
+    const rates = {
+        /*
+     * `null` when `delivered` is UNRECORDED, and this is the one rate where
+     * the numerator can be unknown rather than zero.
+     *
+     * Everywhere else an absent numerator is a genuine nought — a campaign
+     * with delivery events and no opens really does have a 0% open rate, and
+     * that is worth showing. Here the numerator IS the unrecorded quantity,
+     * so `sendRate(undefined, 1000, 'sent')` would divide a missing
+     * measurement by a real one and publish "0.0% delivery rate — 0 of 1,000
+     * sent" for a campaign whose delivery events were merely never recorded.
+     * That is the flattering-substitution failure this module exists to
+     * refuse, running in the other direction: not a rate that reads too high,
+     * but a campaign that reads as a total delivery failure.
+     */ delivery: delivered === null ? null : sendRate(delivered, sent, 'sent'),
+        open: sendRate(uniqueOpens != null ? uniqueOpens : undefined, delivered != null ? delivered : undefined, 'delivered'),
+        click: clickTrackable ? sendRate(uniqueClicks != null ? uniqueClicks : undefined, delivered != null ? delivered : undefined, 'delivered') : null,
+        clickToOpen: clickTrackable ? sendRate(uniqueClicks != null ? uniqueClicks : undefined, uniqueOpens != null ? uniqueOpens : undefined, 'unique openers') : null,
+        bounce: sendRate(bounced, sent, 'sent'),
+        complaint: sendRate(complained, delivered != null ? delivered : undefined, 'delivered'),
+        unsubscribe: sendRate(unsubscribes, delivered != null ? delivered : undefined, 'delivered')
+    };
+    /*
+   * The populations the SEND measured, reported as parts of a named whole
+   * rather than as bare counts. "412 withheld" invites the question "out of
+   * what"; the answer is the audience, and it is a different whole from the
+   * one `suppressed` is measured against — consent is decided over the whole
+   * audience and suppression over the capped recipient list, because that is
+   * where each check runs. Netting them into one column would present two
+   * different denominators as one.
+   */ const audienceSize = Number((_source_audienceSize = source.audienceSize) != null ? _source_audienceSize : 0);
+    const populations = [];
+    const addPopulation = (id, label, count, ofLabel, of)=>{
+        if (count === undefined) return;
+        populations.push({
+            id,
+            label,
+            count: Number(count),
+            ofLabel,
+            of
+        });
+    };
+    addPopulation('consented', 'Had a consent basis', source.consented, 'audience', audienceSize);
+    addPopulation('consentedByOperator', 'Consent asserted by an operator', source.consentedByOperator, 'audience', audienceSize);
+    addPopulation('grandfathered', 'Reachable only because consent is not enforced retroactively', source.grandfathered, 'audience', audienceSize);
+    addPopulation('consentWithheld', 'Withheld by the consent rule', source.consentWithheld, 'audience', audienceSize);
+    addPopulation('suppressed', 'Already suppressed', source.suppressed, 'addressed', recipients);
+    addPopulation('cadenceHeld', 'Asked for mail less often than this', source.cadenceHeld, 'addressed', recipients);
+    addPopulation('noMailServer', 'Excluded: no mail server', source.noMailServer, 'addressed', recipients);
+    addPopulation('gatewayHeld', 'Excluded: behind a gateway that refused this sender', source.gatewayHeld, 'addressed', recipients);
+    const caveats = [];
+    if (delivered === null) {
+        caveats.push({
+            id: 'delivery-unrecorded',
+            message: 'No delivery events have been recorded for this campaign, so open, ' + 'click, complaint and unsubscribe rates cannot be computed — every ' + 'one of them is taken over delivered. Counts below are still real.'
+        });
+    }
+    if (!clickTrackable) {
+        caveats.push({
+            id: 'click-tracking-unrecorded',
+            message: 'This send did not record carrying an HTML part. Click tracking ' + 'rewrites links in the HTML, so a send without one reports zero ' + 'clicks whatever recipients did. The click count is shown; no click ' + 'rate is computed from it.'
+        });
+    }
+    if (source.audienceSizeTruncated) {
+        caveats.push({
+            id: 'audience-truncated',
+            message: 'Audience resolution stopped at its read ceiling, so the audience ' + 'size is a floor — the real audience is at least this large, and ' + 'every share taken over it is at most the figure shown.'
+        });
+    }
+    if (Number((_source_deferred = source.deferred) != null ? _source_deferred : 0) > 0) {
+        caveats.push({
+            id: 'send-deferred',
+            message: `${Number(source.deferred)} recipients were held back by the hourly ` + 'send governor and never received this campaign. They are counted in ' + 'addressed, not in sent.'
+        });
+    }
+    return {
+        sent,
+        recipients,
+        delivered,
+        opens,
+        clicks,
+        uniqueOpens,
+        uniqueClicks,
+        bounced,
+        complained,
+        unsubscribes,
+        rates,
+        populations,
+        caveats
+    };
+}
+/*==========================================
+ * WHAT THE CAMPAIGN'S SEQUENCES PRODUCED (AGL-3254).
+ *
+ * A sequence joins a campaign the way a form does — `campaignIds` on its own
+ * document — and its outcomes are then the campaign's to report: every
+ * person enrolled, the first email each one was sent, the replies, the
+ * meetings booked from a sequence link, and the enrolled leads that
+ * converted. The Outreach runtime credits each outcome once per enrollment
+ * to every campaign the sequence was in when the person was enrolled, into
+ * `hosts/{hostId}/campaignSequenceReports/{campaignId}` — one document per
+ * campaign, beside the conversions rollup and never inside the campaign
+ * document, which the history list and the glance widget read.
+ *
+ * ## The five figures are a funnel, not a sum
+ *
+ * Each figure counts ENROLLMENTS at a stage: 40 enrolled, 38 sent, 6
+ * replied, 2 meetings, 1 converted. They are read across, never added — a
+ * person is in every stage they reached — and the model keeps them as an
+ * ordered list rather than a total for the reason the conversion kinds are
+ * kept apart.
+ *
+ * ## Absent is not zero
+ *
+ * A campaign no sequence was ever in has no document, and a stage nobody
+ * reached has no field. Both are `null` here, so the screen can say
+ * "nothing recorded" for the first and draw a dash for the second, rather
+ * than printing a measured 0 replies for a campaign whose sequence went
+ * out yesterday.
+ *=========================================*/ /**
+ * The outcomes the runtime credits, in funnel order. An array first, because
+ * the ORDER is the reading order and a second list is a second chance to
+ * leave one out; the union is derived from it.
+ */ export const CAMPAIGN_SEQUENCE_OUTCOMES = [
+    'enrolled',
+    'sent',
+    'replied',
+    'meetings',
+    'converted'
+];
+/**
+ * The org collection holding one document per campaign container,
+ * `orgs/{orgId}/campaignSequenceReports/{campaignId}`.
+ */ export const CAMPAIGN_SEQUENCE_REPORTS_COLLECTION = 'campaignSequenceReports';
+/** What a reader calls each outcome, and what the count means. */ export const CAMPAIGN_SEQUENCE_OUTCOME_COPY = {
+    enrolled: {
+        label: 'Enrolled',
+        note: 'people enrolled in a sequence in this campaign'
+    },
+    sent: {
+        label: 'Sent',
+        note: 'of them, sent their first sequence email'
+    },
+    replied: {
+        label: 'Replied',
+        note: 'of them, who wrote back'
+    },
+    meetings: {
+        label: 'Meetings',
+        note: 'bookings made from a sequence link'
+    },
+    converted: {
+        label: 'Converted',
+        note: 'enrolled leads that became contacts'
+    }
+};
+/** Turns the stored rollup into the Sequences section. */ export function campaignSequencesReport(rollup) {
+    var _ref;
+    const stored = (_ref = rollup == null ? void 0 : rollup.byOutcome) != null ? _ref : {};
+    const figures = CAMPAIGN_SEQUENCE_OUTCOMES.map((outcome)=>{
+        const raw = stored[outcome];
+        const value = Math.floor(Number(raw != null ? raw : 0));
+        return {
+            outcome,
+            label: CAMPAIGN_SEQUENCE_OUTCOME_COPY[outcome].label,
+            // Unrecorded, negative and non-numeric all read as "no figure": the
+            // runtime only ever increments, so a stored 0 is not a count either.
+            value: raw === undefined || !Number.isFinite(value) || value <= 0 ? null : value,
+            note: CAMPAIGN_SEQUENCE_OUTCOME_COPY[outcome].note
+        };
+    });
+    const any = figures.some((figure)=>figure.value !== null);
+    const caveats = any ? [
+        {
+            id: 'sequences-funnel-not-summed',
+            message: 'Each figure counts the people who reached that stage, so a person ' + 'who replied is counted under Enrolled and Sent as well. Read them ' + 'across; they are deliberately not added together.'
+        }
+    ] : [];
+    return {
+        figures,
+        recorded: rollup !== undefined,
+        any,
+        caveats
+    };
+}
+
+//# sourceMappingURL=campaign-report.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../../libs/plugins/marketing/src/lib/model/campaign-report.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 * WHAT ONE CAMPAIGN SEND DID, AND WHAT ITS SEQUENCES PRODUCED.\n *\n * The rate math and the link rollup every bulk sender divides by are the mail\n * model's (`@aglyn/shared-ui-email-campaigns/model/send-report`); this is the\n * campaign's reading of them — which population each rate is over, the\n * caveats that qualify a figure, and the funnel a campaign's sequences report\n * into. It keeps the rule that module states: a rate names its denominator,\n * or it is not reported.\n */\n\nimport {\n  sendRate,\n  type SendRate,\n  type SendStats,\n} from '@aglyn/shared-ui-email-campaigns/model/send-report'\n\n/** Why a number the report would otherwise show is being withheld. */\nexport interface CampaignCaveat {\n  /** Stable id, so a spec can assert on the caveat rather than its prose. */\n  id:\n    | 'delivery-unrecorded'\n    | 'click-tracking-unrecorded'\n    | 'audience-truncated'\n    | 'send-deferred'\n    /* Raised by `campaign-revenue.ts`, which reports through this shape so\n     * the screen has one way of saying \"a number is being withheld and here\n     * is why\" rather than one per section. */\n    | 'revenue-denominator-unrecorded'\n    | 'revenue-multi-currency'\n    | 'revenue-mid-flight'\n    | 'revenue-mixed-model'\n    /* Raised by `campaign-conversions.ts`, through this shape for the same\n     * reason: one way of saying \"a number is being withheld, or must not be\n     * read the obvious way, and here is why\". The first two are the reasons\n     * the four conversion kinds stand apart instead of totalling; the last\n     * two qualify the uncredited figure rather than withholding it. */\n    | 'conversions-kinds-overlap'\n    | 'conversions-web-not-rolled-up'\n    | 'conversions-unattributed-is-a-ceiling'\n    | 'conversions-total-crosses-hosts'\n    /* Raised by the Sequences block below (AGL-3254): the five figures are\n     * a funnel read across, never a sum. */\n    | 'sequences-funnel-not-summed'\n  message: string\n}\n\n/** One population the send measured, for the audience breakdown. */\nexport interface CampaignPopulation {\n  id: string\n  label: string\n  count: number\n  /** What this count is a part OF, named. */\n  ofLabel: string\n  of: number\n}\n\n/** Everything the report screen renders, decided here rather than in JSX. */\nexport interface CampaignReport {\n  sent: number\n  recipients: number\n  delivered: number | null\n  opens: number\n  clicks: number\n  uniqueOpens: number | null\n  uniqueClicks: number | null\n  bounced: number\n  complained: number\n  unsubscribes: number\n  /** Rates, each `null` when its denominator is zero or unrecorded. */\n  rates: {\n    /** Accepted by the receiving server, over what the provider accepted. */\n    delivery: SendRate | null\n    /** Distinct readers who opened, over delivered. */\n    open: SendRate | null\n    /** Distinct readers who clicked, over delivered. */\n    click: SendRate | null\n    /**\n     * Distinct clickers over distinct OPENERS — a different question from\n     * `click`, and the one the two get confused for. It answers \"of the\n     * people who read it, how many acted\", not \"of the people who received\n     * it\". Reported separately and labelled separately, never as \"click\n     * rate\".\n     */\n    clickToOpen: SendRate | null\n    /** Bounced over what the provider accepted. */\n    bounce: SendRate | null\n    /** Complaints over delivered — the number mailbox providers judge on. */\n    complaint: SendRate | null\n    /** Unsubscribes through this campaign's link, over delivered. */\n    unsubscribe: SendRate | null\n  }\n  populations: CampaignPopulation[]\n  caveats: CampaignCaveat[]\n}\n\n/**\n * Turns a stored `stats` map into the report.\n *\n * ## The denominator decisions, in one place\n *\n * - **`delivered`** carries the engagement rates — open, click, complaint,\n *   unsubscribe. Mail that bounced was never in front of a human, so\n *   including it in the denominator of an open rate depresses a number that\n *   describes the audience with a fact about the address list. This is also\n *   the convention every other tool reports, which matters: a merchant\n *   comparing our figure with their previous ESP's must be comparing the same\n *   quantity.\n * - **`sent`** carries the delivery and bounce rates, because those describe\n *   what happened to what we handed the provider, and `delivered` is the\n *   numerator of one of them — a rate cannot be over itself.\n * - **`uniqueOpens`** is the open-rate numerator, not `opens`. Open EVENTS\n *   over recipients can exceed 100% the moment one person opens twice, and a\n *   percentage above 100 is how a reader learns the number means something\n *   other than what it says. Both are shown; only the distinct count is\n *   divided.\n *\n * ## `delivered` unknown vs. zero\n *\n * A campaign predating the delivery webhook records no `delivered` at all.\n * That is reported as `null` and every rate over it is withheld, with a\n * caveat naming the reason — rather than substituting `sent`, which would\n * silently publish the flattered number this module exists to refuse.\n */\nexport function campaignReport(stats: SendStats | undefined): CampaignReport {\n  const source = stats ?? {}\n  const sent = Number(source.sent ?? 0)\n  const recipients = Number(source.recipients ?? 0)\n  const opens = Number(source.opens ?? 0)\n  const clicks = Number(source.clicks ?? 0)\n  const bounced = Number(source.bounced ?? 0)\n  const complained = Number(source.complained ?? 0)\n  const unsubscribes = Number(source.unsubscribes ?? 0)\n\n  /*\n   * ABSENT, not zero. `stats.delivered` is written only by the delivery\n   * webhook, so `undefined` means \"no delivery event has ever been recorded\n   * for this campaign\" — which for an old campaign means the webhook was not\n   * connected, and for a campaign sent thirty seconds ago means the events\n   * are still in flight. Neither is \"nothing was delivered\", and both are\n   * ruined by `?? 0`, which would turn the unknown into a hard zero and make\n   * every rate over it `null` for the RIGHT answer by the WRONG reasoning —\n   * and would render \"0 delivered\" on screen beside \"500 sent\".\n   */\n  const delivered =\n    source.delivered === undefined ? null : Number(source.delivered)\n  const uniqueOpens =\n    source.uniqueOpens === undefined ? null : Number(source.uniqueOpens)\n  const uniqueClicks =\n    source.uniqueClicks === undefined ? null : Number(source.uniqueClicks)\n\n  /*\n   * The click rate is withheld for a campaign that never recorded carrying an\n   * HTML part, even when clicks are non-zero and `delivered` is known. See\n   * the structural-zero note in the module header: for those sends 0 is the\n   * only value the number could ever have taken, so a rate computed from it\n   * measures our sending code rather than the recipients.\n   */\n  const clickTrackable = source.clickTracked === true\n\n  const rates: CampaignReport['rates'] = {\n    /*\n     * `null` when `delivered` is UNRECORDED, and this is the one rate where\n     * the numerator can be unknown rather than zero.\n     *\n     * Everywhere else an absent numerator is a genuine nought — a campaign\n     * with delivery events and no opens really does have a 0% open rate, and\n     * that is worth showing. Here the numerator IS the unrecorded quantity,\n     * so `sendRate(undefined, 1000, 'sent')` would divide a missing\n     * measurement by a real one and publish \"0.0% delivery rate — 0 of 1,000\n     * sent\" for a campaign whose delivery events were merely never recorded.\n     * That is the flattering-substitution failure this module exists to\n     * refuse, running in the other direction: not a rate that reads too high,\n     * but a campaign that reads as a total delivery failure.\n     */\n    delivery:\n      delivered === null ? null : sendRate(delivered, sent, 'sent'),\n    open: sendRate(uniqueOpens ?? undefined, delivered ?? undefined, 'delivered'),\n    click: clickTrackable\n      ? sendRate(uniqueClicks ?? undefined, delivered ?? undefined, 'delivered')\n      : null,\n    clickToOpen: clickTrackable\n      ? sendRate(uniqueClicks ?? undefined, uniqueOpens ?? undefined, 'unique openers')\n      : null,\n    bounce: sendRate(bounced, sent, 'sent'),\n    complaint: sendRate(complained, delivered ?? undefined, 'delivered'),\n    unsubscribe: sendRate(unsubscribes, delivered ?? undefined, 'delivered'),\n  }\n\n  /*\n   * The populations the SEND measured, reported as parts of a named whole\n   * rather than as bare counts. \"412 withheld\" invites the question \"out of\n   * what\"; the answer is the audience, and it is a different whole from the\n   * one `suppressed` is measured against — consent is decided over the whole\n   * audience and suppression over the capped recipient list, because that is\n   * where each check runs. Netting them into one column would present two\n   * different denominators as one.\n   */\n  const audienceSize = Number(source.audienceSize ?? 0)\n  const populations: CampaignPopulation[] = []\n  const addPopulation = (\n    id: string,\n    label: string,\n    count: number | undefined,\n    ofLabel: string,\n    of: number,\n  ) => {\n    if (count === undefined) return\n    populations.push({ id, label, count: Number(count), ofLabel, of })\n  }\n  addPopulation(\n    'consented',\n    'Had a consent basis',\n    source.consented,\n    'audience',\n    audienceSize,\n  )\n  addPopulation(\n    'consentedByOperator',\n    'Consent asserted by an operator',\n    source.consentedByOperator,\n    'audience',\n    audienceSize,\n  )\n  addPopulation(\n    'grandfathered',\n    'Reachable only because consent is not enforced retroactively',\n    source.grandfathered,\n    'audience',\n    audienceSize,\n  )\n  addPopulation(\n    'consentWithheld',\n    'Withheld by the consent rule',\n    source.consentWithheld,\n    'audience',\n    audienceSize,\n  )\n  addPopulation(\n    'suppressed',\n    'Already suppressed',\n    source.suppressed,\n    'addressed',\n    recipients,\n  )\n  addPopulation(\n    'cadenceHeld',\n    'Asked for mail less often than this',\n    source.cadenceHeld,\n    'addressed',\n    recipients,\n  )\n  addPopulation(\n    'noMailServer',\n    'Excluded: no mail server',\n    source.noMailServer,\n    'addressed',\n    recipients,\n  )\n  addPopulation(\n    'gatewayHeld',\n    'Excluded: behind a gateway that refused this sender',\n    source.gatewayHeld,\n    'addressed',\n    recipients,\n  )\n\n  const caveats: CampaignCaveat[] = []\n  if (delivered === null) {\n    caveats.push({\n      id: 'delivery-unrecorded',\n      message:\n        'No delivery events have been recorded for this campaign, so open, ' +\n        'click, complaint and unsubscribe rates cannot be computed — every ' +\n        'one of them is taken over delivered. Counts below are still real.',\n    })\n  }\n  if (!clickTrackable) {\n    caveats.push({\n      id: 'click-tracking-unrecorded',\n      message:\n        'This send did not record carrying an HTML part. Click tracking ' +\n        'rewrites links in the HTML, so a send without one reports zero ' +\n        'clicks whatever recipients did. The click count is shown; no click ' +\n        'rate is computed from it.',\n    })\n  }\n  if (source.audienceSizeTruncated) {\n    caveats.push({\n      id: 'audience-truncated',\n      message:\n        'Audience resolution stopped at its read ceiling, so the audience ' +\n        'size is a floor — the real audience is at least this large, and ' +\n        'every share taken over it is at most the figure shown.',\n    })\n  }\n  if (Number(source.deferred ?? 0) > 0) {\n    caveats.push({\n      id: 'send-deferred',\n      message:\n        `${Number(source.deferred)} recipients were held back by the hourly ` +\n        'send governor and never received this campaign. They are counted in ' +\n        'addressed, not in sent.',\n    })\n  }\n\n  return {\n    sent,\n    recipients,\n    delivered,\n    opens,\n    clicks,\n    uniqueOpens,\n    uniqueClicks,\n    bounced,\n    complained,\n    unsubscribes,\n    rates,\n    populations,\n    caveats,\n  }\n}\n\n/*==========================================\n * WHAT THE CAMPAIGN'S SEQUENCES PRODUCED (AGL-3254).\n *\n * A sequence joins a campaign the way a form does — `campaignIds` on its own\n * document — and its outcomes are then the campaign's to report: every\n * person enrolled, the first email each one was sent, the replies, the\n * meetings booked from a sequence link, and the enrolled leads that\n * converted. The Outreach runtime credits each outcome once per enrollment\n * to every campaign the sequence was in when the person was enrolled, into\n * `hosts/{hostId}/campaignSequenceReports/{campaignId}` — one document per\n * campaign, beside the conversions rollup and never inside the campaign\n * document, which the history list and the glance widget read.\n *\n * ## The five figures are a funnel, not a sum\n *\n * Each figure counts ENROLLMENTS at a stage: 40 enrolled, 38 sent, 6\n * replied, 2 meetings, 1 converted. They are read across, never added — a\n * person is in every stage they reached — and the model keeps them as an\n * ordered list rather than a total for the reason the conversion kinds are\n * kept apart.\n *\n * ## Absent is not zero\n *\n * A campaign no sequence was ever in has no document, and a stage nobody\n * reached has no field. Both are `null` here, so the screen can say\n * \"nothing recorded\" for the first and draw a dash for the second, rather\n * than printing a measured 0 replies for a campaign whose sequence went\n * out yesterday.\n *=========================================*/\n\n/**\n * The outcomes the runtime credits, in funnel order. An array first, because\n * the ORDER is the reading order and a second list is a second chance to\n * leave one out; the union is derived from it.\n */\nexport const CAMPAIGN_SEQUENCE_OUTCOMES = [\n  'enrolled',\n  'sent',\n  'replied',\n  'meetings',\n  'converted',\n] as const\n\nexport type CampaignSequenceOutcome = (typeof CAMPAIGN_SEQUENCE_OUTCOMES)[number]\n\n/**\n * The org collection holding one document per campaign container,\n * `orgs/{orgId}/campaignSequenceReports/{campaignId}`.\n */\nexport const CAMPAIGN_SEQUENCE_REPORTS_COLLECTION = 'campaignSequenceReports'\n\n/** What a reader calls each outcome, and what the count means. */\nexport const CAMPAIGN_SEQUENCE_OUTCOME_COPY: Readonly<\n  Record<CampaignSequenceOutcome, { label: string; note: string }>\n> = {\n  enrolled: { label: 'Enrolled', note: 'people enrolled in a sequence in this campaign' },\n  sent: { label: 'Sent', note: 'of them, sent their first sequence email' },\n  replied: { label: 'Replied', note: 'of them, who wrote back' },\n  meetings: { label: 'Meetings', note: 'bookings made from a sequence link' },\n  converted: { label: 'Converted', note: 'enrolled leads that became contacts' },\n}\n\n/**\n * The stored shape of `campaignSequenceReports/{campaignId}`.\n *\n * Read-side only, every field optional: another plugin's runtime wrote it,\n * and a reader that assumed a field was present would throw on the first\n * document written before the field existed.\n */\nexport interface CampaignSequencesRollup {\n  byOutcome?: Partial<Record<CampaignSequenceOutcome, number>>\n  /** When the runtime last credited anything, epoch ms. */\n  updatedAtMs?: number\n}\n\n/** One outcome's figure on screen. */\nexport interface CampaignSequenceFigure {\n  outcome: CampaignSequenceOutcome\n  label: string\n  /** The count, or `null` when the rollup holds no entry for the outcome. */\n  value: number | null\n  note: string\n}\n\n/** Everything the Sequences section renders. */\nexport interface CampaignSequencesReport {\n  /** Always all five, always in {@link CAMPAIGN_SEQUENCE_OUTCOMES} order. */\n  figures: CampaignSequenceFigure[]\n  /** Whether the rollup document exists at all — see the block header. */\n  recorded: boolean\n  /** At least one outcome holds a figure. */\n  any: boolean\n  caveats: CampaignCaveat[]\n}\n\n/** Turns the stored rollup into the Sequences section. */\nexport function campaignSequencesReport(\n  rollup: CampaignSequencesRollup | undefined,\n): CampaignSequencesReport {\n  const stored = rollup?.byOutcome ?? {}\n  const figures: CampaignSequenceFigure[] = CAMPAIGN_SEQUENCE_OUTCOMES.map((outcome) => {\n    const raw = stored[outcome]\n    const value = Math.floor(Number(raw ?? 0))\n    return {\n      outcome,\n      label: CAMPAIGN_SEQUENCE_OUTCOME_COPY[outcome].label,\n      // Unrecorded, negative and non-numeric all read as \"no figure\": the\n      // runtime only ever increments, so a stored 0 is not a count either.\n      value: raw === undefined || !Number.isFinite(value) || value <= 0 ? null : value,\n      note: CAMPAIGN_SEQUENCE_OUTCOME_COPY[outcome].note,\n    }\n  })\n  const any = figures.some((figure) => figure.value !== null)\n  const caveats: CampaignCaveat[] = any\n    ? [\n        {\n          id: 'sequences-funnel-not-summed',\n          message:\n            'Each figure counts the people who reached that stage, so a person ' +\n            'who replied is counted under Enrolled and Sent as well. Read them ' +\n            'across; they are deliberately not added together.',\n        },\n      ]\n    : []\n  return { figures, recorded: rollup !== undefined, any, caveats }\n}\n"],"names":["sendRate","campaignReport","stats","source","sent","Number","recipients","opens","clicks","bounced","complained","unsubscribes","delivered","undefined","uniqueOpens","uniqueClicks","clickTrackable","clickTracked","rates","delivery","open","click","clickToOpen","bounce","complaint","unsubscribe","audienceSize","populations","addPopulation","id","label","count","ofLabel","of","push","consented","consentedByOperator","grandfathered","consentWithheld","suppressed","cadenceHeld","noMailServer","gatewayHeld","caveats","message","audienceSizeTruncated","deferred","CAMPAIGN_SEQUENCE_OUTCOMES","CAMPAIGN_SEQUENCE_REPORTS_COLLECTION","CAMPAIGN_SEQUENCE_OUTCOME_COPY","enrolled","note","replied","meetings","converted","campaignSequencesReport","rollup","stored","byOutcome","figures","map","outcome","raw","value","Math","floor","isFinite","any","some","figure","recorded"],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAED;;;;;;;;;CASC,GAED,SACEA,QAAQ,QAGH,qDAAoD;AAiF3D;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2BC,GACD,OAAO,SAASC,eAAeC,KAA4B;QAErCC,cACMA,oBACLA,eACCA,gBACCA,iBACGA,oBACEA,sBAkEAA,sBAkGjBA;IA3KX,MAAMA,SAASD,gBAAAA,QAAS,CAAC;IACzB,MAAME,OAAOC,QAAOF,eAAAA,OAAOC,IAAI,YAAXD,eAAe;IACnC,MAAMG,aAAaD,QAAOF,qBAAAA,OAAOG,UAAU,YAAjBH,qBAAqB;IAC/C,MAAMI,QAAQF,QAAOF,gBAAAA,OAAOI,KAAK,YAAZJ,gBAAgB;IACrC,MAAMK,SAASH,QAAOF,iBAAAA,OAAOK,MAAM,YAAbL,iBAAiB;IACvC,MAAMM,UAAUJ,QAAOF,kBAAAA,OAAOM,OAAO,YAAdN,kBAAkB;IACzC,MAAMO,aAAaL,QAAOF,qBAAAA,OAAOO,UAAU,YAAjBP,qBAAqB;IAC/C,MAAMQ,eAAeN,QAAOF,uBAAAA,OAAOQ,YAAY,YAAnBR,uBAAuB;IAEnD;;;;;;;;;GASC,GACD,MAAMS,YACJT,OAAOS,SAAS,KAAKC,YAAY,OAAOR,OAAOF,OAAOS,SAAS;IACjE,MAAME,cACJX,OAAOW,WAAW,KAAKD,YAAY,OAAOR,OAAOF,OAAOW,WAAW;IACrE,MAAMC,eACJZ,OAAOY,YAAY,KAAKF,YAAY,OAAOR,OAAOF,OAAOY,YAAY;IAEvE;;;;;;GAMC,GACD,MAAMC,iBAAiBb,OAAOc,YAAY,KAAK;IAE/C,MAAMC,QAAiC;QACrC;;;;;;;;;;;;;KAaC,GACDC,UACEP,cAAc,OAAO,OAAOZ,SAASY,WAAWR,MAAM;QACxDgB,MAAMpB,SAASc,sBAAAA,cAAeD,WAAWD,oBAAAA,YAAaC,WAAW;QACjEQ,OAAOL,iBACHhB,SAASe,uBAAAA,eAAgBF,WAAWD,oBAAAA,YAAaC,WAAW,eAC5D;QACJS,aAAaN,iBACThB,SAASe,uBAAAA,eAAgBF,WAAWC,sBAAAA,cAAeD,WAAW,oBAC9D;QACJU,QAAQvB,SAASS,SAASL,MAAM;QAChCoB,WAAWxB,SAASU,YAAYE,oBAAAA,YAAaC,WAAW;QACxDY,aAAazB,SAASW,cAAcC,oBAAAA,YAAaC,WAAW;IAC9D;IAEA;;;;;;;;GAQC,GACD,MAAMa,eAAerB,QAAOF,uBAAAA,OAAOuB,YAAY,YAAnBvB,uBAAuB;IACnD,MAAMwB,cAAoC,EAAE;IAC5C,MAAMC,gBAAgB,CACpBC,IACAC,OACAC,OACAC,SACAC;QAEA,IAAIF,UAAUlB,WAAW;QACzBc,YAAYO,IAAI,CAAC;YAAEL;YAAIC;YAAOC,OAAO1B,OAAO0B;YAAQC;YAASC;QAAG;IAClE;IACAL,cACE,aACA,uBACAzB,OAAOgC,SAAS,EAChB,YACAT;IAEFE,cACE,uBACA,mCACAzB,OAAOiC,mBAAmB,EAC1B,YACAV;IAEFE,cACE,iBACA,gEACAzB,OAAOkC,aAAa,EACpB,YACAX;IAEFE,cACE,mBACA,gCACAzB,OAAOmC,eAAe,EACtB,YACAZ;IAEFE,cACE,cACA,sBACAzB,OAAOoC,UAAU,EACjB,aACAjC;IAEFsB,cACE,eACA,uCACAzB,OAAOqC,WAAW,EAClB,aACAlC;IAEFsB,cACE,gBACA,4BACAzB,OAAOsC,YAAY,EACnB,aACAnC;IAEFsB,cACE,eACA,uDACAzB,OAAOuC,WAAW,EAClB,aACApC;IAGF,MAAMqC,UAA4B,EAAE;IACpC,IAAI/B,cAAc,MAAM;QACtB+B,QAAQT,IAAI,CAAC;YACXL,IAAI;YACJe,SACE,uEACA,uEACA;QACJ;IACF;IACA,IAAI,CAAC5B,gBAAgB;QACnB2B,QAAQT,IAAI,CAAC;YACXL,IAAI;YACJe,SACE,oEACA,oEACA,wEACA;QACJ;IACF;IACA,IAAIzC,OAAO0C,qBAAqB,EAAE;QAChCF,QAAQT,IAAI,CAAC;YACXL,IAAI;YACJe,SACE,sEACA,qEACA;QACJ;IACF;IACA,IAAIvC,QAAOF,mBAAAA,OAAO2C,QAAQ,YAAf3C,mBAAmB,KAAK,GAAG;QACpCwC,QAAQT,IAAI,CAAC;YACXL,IAAI;YACJe,SACE,GAAGvC,OAAOF,OAAO2C,QAAQ,EAAE,yCAAyC,CAAC,GACrE,yEACA;QACJ;IACF;IAEA,OAAO;QACL1C;QACAE;QACAM;QACAL;QACAC;QACAM;QACAC;QACAN;QACAC;QACAC;QACAO;QACAS;QACAgB;IACF;AACF;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;2CA4B2C,GAE3C;;;;CAIC,GACD,OAAO,MAAMI,6BAA6B;IACxC;IACA;IACA;IACA;IACA;CACD,CAAS;AAIV;;;CAGC,GACD,OAAO,MAAMC,uCAAuC,0BAAyB;AAE7E,gEAAgE,GAChE,OAAO,MAAMC,iCAET;IACFC,UAAU;QAAEpB,OAAO;QAAYqB,MAAM;IAAiD;IACtF/C,MAAM;QAAE0B,OAAO;QAAQqB,MAAM;IAA2C;IACxEC,SAAS;QAAEtB,OAAO;QAAWqB,MAAM;IAA0B;IAC7DE,UAAU;QAAEvB,OAAO;QAAYqB,MAAM;IAAqC;IAC1EG,WAAW;QAAExB,OAAO;QAAaqB,MAAM;IAAsC;AAC/E,EAAC;AAmCD,wDAAwD,GACxD,OAAO,SAASI,wBACdC,MAA2C;;IAE3C,MAAMC,iBAASD,0BAAAA,OAAQE,SAAS,mBAAI,CAAC;IACrC,MAAMC,UAAoCZ,2BAA2Ba,GAAG,CAAC,CAACC;QACxE,MAAMC,MAAML,MAAM,CAACI,QAAQ;QAC3B,MAAME,QAAQC,KAAKC,KAAK,CAAC5D,OAAOyD,cAAAA,MAAO;QACvC,OAAO;YACLD;YACA/B,OAAOmB,8BAA8B,CAACY,QAAQ,CAAC/B,KAAK;YACpD,oEAAoE;YACpE,qEAAqE;YACrEiC,OAAOD,QAAQjD,aAAa,CAACR,OAAO6D,QAAQ,CAACH,UAAUA,SAAS,IAAI,OAAOA;YAC3EZ,MAAMF,8BAA8B,CAACY,QAAQ,CAACV,IAAI;QACpD;IACF;IACA,MAAMgB,MAAMR,QAAQS,IAAI,CAAC,CAACC,SAAWA,OAAON,KAAK,KAAK;IACtD,MAAMpB,UAA4BwB,MAC9B;QACE;YACEtC,IAAI;YACJe,SACE,uEACA,uEACA;QACJ;KACD,GACD,EAAE;IACN,OAAO;QAAEe;QAASW,UAAUd,WAAW3C;QAAWsD;QAAKxB;IAAQ;AACjE"}

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

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { type CampaignCaveat } from '@aglyn/shared-ui-email-campaigns/model/campaign-report';
+import { type CampaignCaveat } from './campaign-report';
 /**
  * WHAT A CAMPAIGN EARNED — the read half of the commerce↔email join.
  *
@@ -138,7 +138,7 @@ export interface CampaignRevenueRollup {
     windowDays?: number;
 }
 /**
- * Money over a population, with the population named — {@link CampaignRate}'s
+ * Money over a population, with the population named — {@link SendRate}'s
  * rule applied to an average instead of a share.
  *
  * A percentage and an average go wrong the same way, so they carry the same
@@ -214,7 +214,7 @@ export declare const REVENUE_MULTI_CURRENCY_MESSAGE: string;
 /**
  * Money per message, or `null` when the division cannot honestly be taken.
  *
- * The three refusals are {@link campaignRate}'s, and this defers to it rather
+ * The three refusals are {@link sendRate}'s, and this defers to it rather
  * than restating them: a zero denominator, an unrecorded denominator, and a
  * non-finite input all answer `null` there, so a second implementation of
  * "when may we divide" cannot drift from the first.