@aglyn/shared-ui-email-campaigns 1.0.0-beta.219 → 1.0.0-beta.221

package/README.md

@@ -1,7 +1,6 @@
 # @aglyn/shared-ui-email-campaigns
 
-The email-campaign document model and the figures that render it, owned by
-neither of the two plugins that read it.
+The email-campaign document model, owned by none of the plugins that read it.
 
 > Beta. Published from the Aglyn monorepo under the `beta` dist-tag; APIs can change between beta releases.
 
@@ -33,7 +32,7 @@ The boundary is enforced in
 Marketing re-acquires an import of anything this library owns from
 `@aglyn/plugins-email`.
 
-## Two entry points, deliberately
+## The model only
 
 ```typescript
 // Pure. No React, no MUI — safe in a /server handler.
@@ -41,19 +40,12 @@ import {
   campaignReport,
   CAMPAIGN_SEND_CONTAINER_FIELD,
 } from '@aglyn/shared-ui-email-campaigns/model'
-
-// Renders MUI. Console surfaces only.
-import {
-  Figure,
-  RateRow,
-  Section,
-} from '@aglyn/shared-ui-email-campaigns/components/report-figures'
 ```
 
-The package barrel (`@aglyn/shared-ui-email-campaigns`) re-exports the model
-and nothing else, so a webhook handler that needs one stored field name does
-not pull a component graph in behind it. `report-figures` is reachable by
-subpath only — the same barrel discipline `@aglyn/shared-ui-jsx` runs under.
+The library renders nothing. The figure renderers live in
+`@aglyn/shared-ui-jsx`, and the control that files a record under a campaign
+is the core's generic `ContainerPicker` (`@aglyn/tenant-feature-instance`),
+handed the `campaign` kind the Marketing plugin declares.
 
 ## What is here
 
@@ -61,16 +53,15 @@ subpath only — the same barrel discipline `@aglyn/shared-ui-jsx` runs under.
 | --------------------------- | --------------------------------------------------------------------------------- |
 | `model/campaign-container`  | The campaign's window, its lists, its sends, and the rollup across them           |
 | `model/campaign-report`     | The rate math, the population each rate describes, and the link rollup            |
-| `model/campaign-revenue`    | What a campaign earned, per currency, gross and refunded                          |
 | `model/email-record`        | One message: its state, its audience, and when it went out                        |
-| `components/report-figures` | The renderers those figures print through, so a rate always shows its denominator |
-
-`model/campaign-revenue` re-exports the attribution window and model name from
-`@aglyn/shared-util-email`, which is where the writer in `tenant-data-admin`
-takes them from — one definition of the window on both sides of the join.
 
 ## What is not here
 
+What a campaign caused and earned — the conversions it is credited with and
+its revenue per currency. Only the Marketing plugin reads them, so they are
+its model (`libs/plugins/marketing/src/lib/model/`), not a shape two plugins
+share.
+
 Sending. The send loop, the composer, the topic subscriptions and the
 send-time API all stay in `@aglyn/plugins-email`: they are behavior that the
 Email plugin's switch is supposed to govern, not shapes that two plugins share.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aglyn/shared-ui-email-campaigns",
-  "version": "1.0.0-beta.219",
+  "version": "1.0.0-beta.221",
   "license": "Apache-2.0",
   "homepage": "https://aglyn.com",
   "repository": {
@@ -29,8 +29,8 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@aglyn/shared-ui-jsx": "1.0.0-beta.219",
-    "@aglyn/shared-util-email": "1.0.0-beta.219",
+    "@aglyn/shared-ui-jsx": "1.0.0-beta.221",
+    "@aglyn/shared-util-email": "1.0.0-beta.221",
     "@swc/helpers": "0.5.23"
   },
   "peerDependencies": {

package/src/lib/model/index.d.ts

@@ -29,13 +29,6 @@
  * rather than chosen in JSX.
  */
 export * from './campaign-report';
-/**
- * What a campaign EARNED: the last-click window, the gross/refunded pair and
- * the per-currency buckets that are never added together. Separate from the
- * rate math because it reads a different document and answers the merchant's
- * second question rather than their first.
- */
-export * from './campaign-revenue';
 /** Reading one message record — its state, and when it went out. */
 export * from './email-record';
 /**
@@ -43,10 +36,3 @@ export * from './email-record';
  * rolls its sends into one set of figures.
  */
 export * from './campaign-container';
-/**
- * What a campaign CAUSED: the four identify moments, kept apart because one
- * visitor action writes several of them. Separate from the revenue module
- * because it reads a different document and answers what happened to people
- * who were anonymous until the moment being counted.
- */
-export * from './campaign-conversions';

package/src/lib/model/index.js

@@ -26,22 +26,10 @@
  * the link rollup — pure, so every denominator is named once and provable
  * rather than chosen in JSX.
  */ export * from "./campaign-report.js";
-/**
- * What a campaign EARNED: the last-click window, the gross/refunded pair and
- * the per-currency buckets that are never added together. Separate from the
- * rate math because it reads a different document and answers the merchant's
- * second question rather than their first.
- */ export * from "./campaign-revenue.js";
 /** Reading one message record — its state, and when it went out. */ export * from "./email-record.js";
 /**
  * The campaign CONTAINER — its window, its lists, and the arithmetic that
  * rolls its sends into one set of figures.
  */ export * from "./campaign-container.js";
-/**
- * What a campaign CAUSED: the four identify moments, kept apart because one
- * visitor action writes several of them. Separate from the revenue module
- * because it reads a different document and answers what happened to people
- * who were anonymous until the moment being counted.
- */ export * from "./campaign-conversions.js";
 
 //# sourceMappingURL=index.js.map

package/src/lib/model/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../../../../libs/shared/ui/email-campaigns/src/lib/model/index.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 email-campaign document model: the stored shapes and the pure\n * arithmetic over them.\n *\n * Nothing here imports React or MUI, so a server handler that needs a field\n * name or a rate can take this barrel without dragging a component graph\n * into its bundle. The renderers live one directory over, behind\n * `@aglyn/shared-ui-jsx/components/measured-figures.component`.\n */\n\n/**\n * Campaign reporting: the rate math, the populations the send recorded, and\n * the link rollup — pure, so every denominator is named once and provable\n * rather than chosen in JSX.\n */\nexport * from './campaign-report'\n\n/**\n * What a campaign EARNED: the last-click window, the gross/refunded pair and\n * the per-currency buckets that are never added together. Separate from the\n * rate math because it reads a different document and answers the merchant's\n * second question rather than their first.\n */\nexport * from './campaign-revenue'\n\n/** Reading one message record — its state, and when it went out. */\nexport * from './email-record'\n\n/**\n * The campaign CONTAINER — its window, its lists, and the arithmetic that\n * rolls its sends into one set of figures.\n */\nexport * from './campaign-container'\n\n/**\n * What a campaign CAUSED: the four identify moments, kept apart because one\n * visitor action writes several of them. Separate from the revenue module\n * because it reads a different document and answers what happened to people\n * who were anonymous until the moment being counted.\n */\nexport * from './campaign-conversions'\n"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAED;;;;;;;;CAQC,GAED;;;;CAIC,GACD,cAAc,uBAAmB;AAEjC;;;;;CAKC,GACD,cAAc,wBAAoB;AAElC,kEAAkE,GAClE,cAAc,oBAAgB;AAE9B;;;CAGC,GACD,cAAc,0BAAsB;AAEpC;;;;;CAKC,GACD,cAAc,4BAAwB"}
+{"version":3,"sources":["../../../../../../../../libs/shared/ui/email-campaigns/src/lib/model/index.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 email-campaign document model: the stored shapes and the pure\n * arithmetic over them.\n *\n * Nothing here imports React or MUI, so a server handler that needs a field\n * name or a rate can take this barrel without dragging a component graph\n * into its bundle. The renderers live one directory over, behind\n * `@aglyn/shared-ui-jsx/components/measured-figures.component`.\n */\n\n/**\n * Campaign reporting: the rate math, the populations the send recorded, and\n * the link rollup — pure, so every denominator is named once and provable\n * rather than chosen in JSX.\n */\nexport * from './campaign-report'\n\n/** Reading one message record — its state, and when it went out. */\nexport * from './email-record'\n\n/**\n * The campaign CONTAINER — its window, its lists, and the arithmetic that\n * rolls its sends into one set of figures.\n */\nexport * from './campaign-container'\n"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAED;;;;;;;;CAQC,GAED;;;;CAIC,GACD,cAAc,uBAAmB;AAEjC,kEAAkE,GAClE,cAAc,oBAAgB;AAE9B;;;CAGC,GACD,cAAc,0BAAsB"}

package/src/lib/components/campaign-picker.component.d.ts

@@ -1,54 +0,0 @@
-/** One campaign a resource may be put in. */
-export interface CampaignPickerOption {
-    value: string;
-    label: string;
-}
-export interface CampaignPickerProps {
-    /** The campaigns this site has, newest window first is the caller's job. */
-    options: readonly CampaignPickerOption[];
-    /** The campaign ids currently selected. */
-    value: readonly string[];
-    onChange: (next: string[]) => void;
-    /** Overrides the default label — a contact says "filed under", not "in". */
-    label?: string;
-    /** Overrides the default helper line. */
-    helperText?: string;
-    disabled?: boolean;
-    /**
-     * The site has no campaigns at all, so the picker has nothing to offer.
-     *
-     * Distinct from "still loading": an empty select with no explanation reads
-     * as a control that is broken, and the two states look identical.
-     */
-    empty?: boolean;
-    /** What to say in place of the picker when {@link empty}. */
-    emptyText?: string;
-}
-/**
- * WHICH CAMPAIGNS THIS RECORD IS PART OF.
- *
- * The one control behind every campaign assignment in the console — a form's
- * page, a screen's page and a contact's drawer — so that three surfaces
- * editing one stored field cannot come to present it three ways.
- *
- * ## It renders ids as NAMES and stores ids
- *
- * The chips read the label out of {@link CampaignPickerProps.options}, and an
- * id with no option left falls back to the id itself rather than
- * disappearing. A campaign that has been deleted is exactly that case, and
- * a chip that vanished would tell a merchant the assignment was gone when the
- * document still carries it.
- *
- * ## Presentational, deliberately
- *
- * It reads no campaign collection of its own. The three callers already hold
- * a site scope and their own read budget — a screen's page is in the console
- * app, which may not import a feature plugin at all — and a control that
- * opened a listener per placement is the unrequested read on mount this
- * console refuses.
- */
-export declare function CampaignPicker(props: CampaignPickerProps): import("react").JSX.Element;
-export declare namespace CampaignPicker {
-    var displayName: string;
-}
-export default CampaignPicker;

package/src/lib/components/campaign-picker.component.js

@@ -1,121 +0,0 @@
-/**
- * @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.
- */ 'use client';
-import { jsx as _jsx } from "react/jsx-runtime";
-import { Chip, MenuItem, Stack, TextField, Typography } from "@mui/material";
-/**
- * WHICH CAMPAIGNS THIS RECORD IS PART OF.
- *
- * The one control behind every campaign assignment in the console — a form's
- * page, a screen's page and a contact's drawer — so that three surfaces
- * editing one stored field cannot come to present it three ways.
- *
- * ## It renders ids as NAMES and stores ids
- *
- * The chips read the label out of {@link CampaignPickerProps.options}, and an
- * id with no option left falls back to the id itself rather than
- * disappearing. A campaign that has been deleted is exactly that case, and
- * a chip that vanished would tell a merchant the assignment was gone when the
- * document still carries it.
- *
- * ## Presentational, deliberately
- *
- * It reads no campaign collection of its own. The three callers already hold
- * a site scope and their own read budget — a screen's page is in the console
- * app, which may not import a feature plugin at all — and a control that
- * opened a listener per placement is the unrequested read on mount this
- * console refuses.
- */ export function CampaignPicker(props) {
-    const { options, value, onChange, label = 'Campaigns', helperText = 'The campaigns this belongs to. Clearing them all takes it out of every campaign.', disabled, empty, emptyText = 'This site has no campaigns yet. Create one from Marketing to file records under it.' } = props;
-    if (empty) {
-        return /*#__PURE__*/ _jsx(Typography, {
-            variant: "body2",
-            color: "text.secondary",
-            children: emptyText
-        });
-    }
-    const labels = new Map(options.map((option)=>[
-            option.value,
-            option.label
-        ]));
-    return /*#__PURE__*/ _jsx(TextField, {
-        select: true,
-        size: "small",
-        label: label,
-        value: value,
-        disabled: disabled,
-        onChange: (event)=>onChange(// A multiple select hands back an array; the change event's typing
-            // does not know that.
-            event.target.value.map(String)),
-        helperText: helperText,
-        fullWidth: true,
-        slotProps: {
-            /*
-         * `shrink`, because `displayEmpty` below draws "No campaign" in the
-         * closed box while the value is still empty (AGL-2486's pairing).
-         *
-         * MUI shrinks a label when the input reports itself filled, and an
-         * empty multiple select reports the opposite — so the label sat at
-         * full size, inside the box, on top of the placeholder it had just
-         * drawn: two lines of text one on the other, on every screen, form,
-         * contact and dynamic-list page that renders this picker. Both halves
-         * have to be said together; `displayEmpty` alone IS the overlap.
-         *
-         * Nothing sets `notched` here on purpose: `TextField` derives it from
-         * this `shrink` for the outlined variant, so the outline's gap and the
-         * label can never disagree.
-         */ inputLabel: {
-                shrink: true
-            },
-            select: {
-                multiple: true,
-                displayEmpty: true,
-                renderValue: (selected)=>{
-                    const ids = selected != null ? selected : [];
-                    if (!ids.length) {
-                        return /*#__PURE__*/ _jsx(Typography, {
-                            variant: "body2",
-                            color: "text.secondary",
-                            children: 'No campaign'
-                        });
-                    }
-                    return /*#__PURE__*/ _jsx(Stack, {
-                        direction: "row",
-                        spacing: 0.5,
-                        sx: {
-                            flexWrap: 'wrap'
-                        },
-                        children: ids.map((id)=>{
-                            var _labels_get;
-                            return /*#__PURE__*/ _jsx(Chip, {
-                                size: "small",
-                                label: (_labels_get = labels.get(id)) != null ? _labels_get : id
-                            }, id);
-                        })
-                    });
-                }
-            }
-        },
-        children: options.map((option)=>/*#__PURE__*/ _jsx(MenuItem, {
-                value: option.value,
-                children: option.label
-            }, option.value))
-    });
-}
-CampaignPicker.displayName = 'CampaignPicker';
-export default CampaignPicker;
-
-//# sourceMappingURL=campaign-picker.component.js.map

package/src/lib/components/campaign-picker.component.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../../../../../../libs/shared/ui/email-campaigns/src/lib/components/campaign-picker.component.tsx"],"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'use client'\n\nimport { Chip, MenuItem, Stack, TextField, Typography } from '@mui/material'\n\n/** One campaign a resource may be put in. */\nexport interface CampaignPickerOption {\n  value: string\n  label: string\n}\n\nexport interface CampaignPickerProps {\n  /** The campaigns this site has, newest window first is the caller's job. */\n  options: readonly CampaignPickerOption[]\n  /** The campaign ids currently selected. */\n  value: readonly string[]\n  onChange: (next: string[]) => void\n  /** Overrides the default label — a contact says \"filed under\", not \"in\". */\n  label?: string\n  /** Overrides the default helper line. */\n  helperText?: string\n  disabled?: boolean\n  /**\n   * The site has no campaigns at all, so the picker has nothing to offer.\n   *\n   * Distinct from \"still loading\": an empty select with no explanation reads\n   * as a control that is broken, and the two states look identical.\n   */\n  empty?: boolean\n  /** What to say in place of the picker when {@link empty}. */\n  emptyText?: string\n}\n\n/**\n * WHICH CAMPAIGNS THIS RECORD IS PART OF.\n *\n * The one control behind every campaign assignment in the console — a form's\n * page, a screen's page and a contact's drawer — so that three surfaces\n * editing one stored field cannot come to present it three ways.\n *\n * ## It renders ids as NAMES and stores ids\n *\n * The chips read the label out of {@link CampaignPickerProps.options}, and an\n * id with no option left falls back to the id itself rather than\n * disappearing. A campaign that has been deleted is exactly that case, and\n * a chip that vanished would tell a merchant the assignment was gone when the\n * document still carries it.\n *\n * ## Presentational, deliberately\n *\n * It reads no campaign collection of its own. The three callers already hold\n * a site scope and their own read budget — a screen's page is in the console\n * app, which may not import a feature plugin at all — and a control that\n * opened a listener per placement is the unrequested read on mount this\n * console refuses.\n */\nexport function CampaignPicker(props: CampaignPickerProps) {\n  const {\n    options,\n    value,\n    onChange,\n    label = 'Campaigns',\n    helperText = 'The campaigns this belongs to. Clearing them all takes it out of every campaign.',\n    disabled,\n    empty,\n    emptyText = 'This site has no campaigns yet. Create one from Marketing to file records under it.',\n  } = props\n\n  if (empty) {\n    return (\n      <Typography variant=\"body2\" color=\"text.secondary\">\n        {emptyText}\n      </Typography>\n    )\n  }\n\n  const labels = new Map(options.map((option) => [option.value, option.label]))\n\n  return (\n    <TextField\n      select\n      size=\"small\"\n      label={label}\n      value={value as string[]}\n      disabled={disabled}\n      onChange={(event) =>\n        onChange(\n          // A multiple select hands back an array; the change event's typing\n          // does not know that.\n          (event.target.value as unknown as string[]).map(String),\n        )\n      }\n      helperText={helperText}\n      fullWidth\n      slotProps={{\n        /*\n         * `shrink`, because `displayEmpty` below draws \"No campaign\" in the\n         * closed box while the value is still empty (AGL-2486's pairing).\n         *\n         * MUI shrinks a label when the input reports itself filled, and an\n         * empty multiple select reports the opposite — so the label sat at\n         * full size, inside the box, on top of the placeholder it had just\n         * drawn: two lines of text one on the other, on every screen, form,\n         * contact and dynamic-list page that renders this picker. Both halves\n         * have to be said together; `displayEmpty` alone IS the overlap.\n         *\n         * Nothing sets `notched` here on purpose: `TextField` derives it from\n         * this `shrink` for the outlined variant, so the outline's gap and the\n         * label can never disagree.\n         */\n        inputLabel: { shrink: true },\n        select: {\n          multiple: true,\n          displayEmpty: true,\n          renderValue: (selected: unknown) => {\n            const ids = (selected as string[]) ?? []\n            if (!ids.length) {\n              return (\n                <Typography variant=\"body2\" color=\"text.secondary\">\n                  {'No campaign'}\n                </Typography>\n              )\n            }\n            return (\n              <Stack direction=\"row\" spacing={0.5} sx={{ flexWrap: 'wrap' }}>\n                {ids.map((id) => (\n                  <Chip key={id} size=\"small\" label={labels.get(id) ?? id} />\n                ))}\n              </Stack>\n            )\n          },\n        },\n      }}\n    >\n      {options.map((option) => (\n        <MenuItem key={option.value} value={option.value}>\n          {option.label}\n        </MenuItem>\n      ))}\n    </TextField>\n  )\n}\nCampaignPicker.displayName = 'CampaignPicker'\n\nexport default CampaignPicker\n"],"names":["Chip","MenuItem","Stack","TextField","Typography","CampaignPicker","props","options","value","onChange","label","helperText","disabled","empty","emptyText","variant","color","labels","Map","map","option","select","size","event","target","String","fullWidth","slotProps","inputLabel","shrink","multiple","displayEmpty","renderValue","selected","ids","length","direction","spacing","sx","flexWrap","id","get","displayName"],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GACD;;AAEA,SAASA,IAAI,EAAEC,QAAQ,EAAEC,KAAK,EAAEC,SAAS,EAAEC,UAAU,QAAQ,gBAAe;AA8B5E;;;;;;;;;;;;;;;;;;;;;;CAsBC,GACD,OAAO,SAASC,eAAeC,KAA0B;IACvD,MAAM,EACJC,OAAO,EACPC,KAAK,EACLC,QAAQ,EACRC,QAAQ,WAAW,EACnBC,aAAa,kFAAkF,EAC/FC,QAAQ,EACRC,KAAK,EACLC,YAAY,qFAAqF,EAClG,GAAGR;IAEJ,IAAIO,OAAO;QACT,qBACE,KAACT;YAAWW,SAAQ;YAAQC,OAAM;sBAC/BF;;IAGP;IAEA,MAAMG,SAAS,IAAIC,IAAIX,QAAQY,GAAG,CAAC,CAACC,SAAW;YAACA,OAAOZ,KAAK;YAAEY,OAAOV,KAAK;SAAC;IAE3E,qBACE,KAACP;QACCkB,MAAM;QACNC,MAAK;QACLZ,OAAOA;QACPF,OAAOA;QACPI,UAAUA;QACVH,UAAU,CAACc,QACTd,SAGE,AAFA,mEAAmE;YACnE,sBAAsB;YACrBc,MAAMC,MAAM,CAAChB,KAAK,CAAyBW,GAAG,CAACM;QAGpDd,YAAYA;QACZe,SAAS;QACTC,WAAW;YACT;;;;;;;;;;;;;;SAcC,GACDC,YAAY;gBAAEC,QAAQ;YAAK;YAC3BR,QAAQ;gBACNS,UAAU;gBACVC,cAAc;gBACdC,aAAa,CAACC;oBACZ,MAAMC,MAAOD,mBAAAA,WAAyB,EAAE;oBACxC,IAAI,CAACC,IAAIC,MAAM,EAAE;wBACf,qBACE,KAAC/B;4BAAWW,SAAQ;4BAAQC,OAAM;sCAC/B;;oBAGP;oBACA,qBACE,KAACd;wBAAMkC,WAAU;wBAAMC,SAAS;wBAAKC,IAAI;4BAAEC,UAAU;wBAAO;kCACzDL,IAAIf,GAAG,CAAC,CAACqB;gCAC2BvB;iDAAnC,KAACjB;gCAAcsB,MAAK;gCAAQZ,KAAK,GAAEO,cAAAA,OAAOwB,GAAG,CAACD,eAAXvB,cAAkBuB;+BAA1CA;;;gBAInB;YACF;QACF;kBAECjC,QAAQY,GAAG,CAAC,CAACC,uBACZ,KAACnB;gBAA4BO,OAAOY,OAAOZ,KAAK;0BAC7CY,OAAOV,KAAK;eADAU,OAAOZ,KAAK;;AAMnC;AACAH,eAAeqC,WAAW,GAAG;AAE7B,eAAerC,eAAc"}

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

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