@happyvertical/smrt-marketing 0.57.35 → 0.57.37

package/dist/recipes.d.ts

@@ -0,0 +1,168 @@
+/**
+ * Declared recipes for smrt-marketing (#4409, #4437): user-facing units of
+ * functionality an app or agent can pick instead of the whole package.
+ * The scanner reads these statics into the `recipes` array of `manifest.json`
+ * and `smrt-knowledge.json`; nothing here runs at that point.
+ *
+ * @packageDocumentation
+ */
+import { SmrtRecipe } from '@happyvertical/smrt-core';
+import { Campaign } from './models/Campaign.js';
+import { CampaignChannel } from './models/CampaignChannel.js';
+import { CampaignMetricSnapshot } from './models/CampaignMetricSnapshot.js';
+/** Campaigns: Plan a campaign, choose where it runs and see what it brought in. */
+export declare class MarketingCampaignsRecipe extends SmrtRecipe {
+    static id: string;
+    static help: string;
+    static label: string;
+    static summary: string;
+    static synonyms: string[];
+    static section: {
+        id: string;
+        label: string;
+        icon: string;
+        description: string;
+    };
+    static models: (typeof Campaign | typeof CampaignChannel | typeof CampaignMetricSnapshot)[];
+    static nav: ({
+        label: string;
+        model: typeof Campaign;
+        icon: string;
+        description: string;
+        noun: string;
+    } | {
+        label: string;
+        model: typeof CampaignChannel;
+        icon: string;
+        description: string;
+        noun: string;
+    })[];
+    static options: {
+        readonly Campaign: {
+            readonly fields: {
+                readonly name: {
+                    readonly order: 1;
+                };
+                readonly objective: {
+                    readonly order: 2;
+                };
+                readonly status: {
+                    readonly order: 3;
+                };
+                readonly startAt: {
+                    readonly label: "Starts";
+                    readonly order: 4;
+                };
+                readonly endAt: {
+                    readonly label: "Ends";
+                    readonly order: 5;
+                };
+                readonly budgetCents: {
+                    readonly label: "Budget (cents)";
+                    readonly order: 6;
+                };
+                readonly currency: {
+                    readonly order: 7;
+                };
+                readonly customerId: {
+                    readonly label: "Customer";
+                    readonly visibility: "advanced";
+                };
+                readonly campaignKey: {
+                    readonly label: "Reference";
+                    readonly visibility: "advanced";
+                };
+                readonly tenantId: {
+                    readonly visibility: "hidden";
+                };
+                readonly metadata: {
+                    readonly visibility: "hidden";
+                };
+            };
+        };
+        readonly CampaignChannel: {
+            readonly fields: {
+                readonly campaignId: {
+                    readonly label: "Campaign";
+                    readonly order: 1;
+                };
+                readonly channelKind: {
+                    readonly label: "Kind";
+                    readonly order: 2;
+                };
+                readonly channelRef: {
+                    readonly label: "Name";
+                    readonly order: 3;
+                };
+                readonly allocatedBudgetCents: {
+                    readonly label: "Budget share (cents)";
+                    readonly order: 4;
+                };
+                readonly status: {
+                    readonly order: 5;
+                };
+                readonly startAt: {
+                    readonly label: "Starts";
+                    readonly order: 6;
+                };
+                readonly endAt: {
+                    readonly label: "Ends";
+                    readonly order: 7;
+                };
+                readonly tenantId: {
+                    readonly visibility: "hidden";
+                };
+            };
+        };
+        readonly CampaignMetricSnapshot: {
+            readonly fields: {
+                readonly campaignId: {
+                    readonly label: "Campaign";
+                    readonly order: 1;
+                };
+                readonly campaignChannelId: {
+                    readonly label: "Channel";
+                    readonly order: 2;
+                };
+                readonly periodStart: {
+                    readonly label: "From";
+                    readonly order: 3;
+                };
+                readonly periodEnd: {
+                    readonly label: "To";
+                    readonly order: 4;
+                };
+                readonly spendCents: {
+                    readonly label: "Spend (cents)";
+                    readonly order: 5;
+                };
+                readonly impressions: {
+                    readonly order: 6;
+                };
+                readonly clicks: {
+                    readonly order: 7;
+                };
+                readonly conversions: {
+                    readonly order: 8;
+                };
+                readonly leads: {
+                    readonly order: 9;
+                };
+                readonly revenueCents: {
+                    readonly label: "Revenue (cents)";
+                    readonly order: 10;
+                };
+                readonly source: {
+                    readonly order: 11;
+                };
+                readonly tenantId: {
+                    readonly visibility: "hidden";
+                };
+                readonly dedupeKey: {
+                    readonly visibility: "hidden";
+                };
+            };
+        };
+    };
+}
+//# sourceMappingURL=recipes.d.ts.map

package/dist/recipes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recipes.d.ts","sourceRoot":"","sources":["../src/recipes.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAE5E,mFAAmF;AACnF,qBAAa,wBAAyB,SAAQ,UAAU;IACtD,MAAM,CAAC,EAAE,SAAyB;IAClC,MAAM,CAAC,IAAI,SAA2B;IACtC,MAAM,CAAC,KAAK,SAAe;IAC3B,MAAM,CAAC,OAAO,SAC4F;IAC1G,MAAM,CAAC,QAAQ,WAOb;IACF,MAAM,CAAC,OAAO;;;;;MAKZ;IACF,MAAM,CAAC,MAAM,+EAAuD;IACpE,MAAM,CAAC,GAAG;;;;;;;;;;;;SAiBR;IACF,MAAM,CAAC,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MA6CH;CACZ"}

package/dist/smrt-knowledge.json

@@ -3,13 +3,13 @@
   "sensitiveFieldsExcluded": true,
   "generatedAt": "1970-01-01T00:00:00.000Z",
   "packageName": "@happyvertical/smrt-marketing",
-  "packageVersion": "0.57.35",
+  "packageVersion": "0.57.37",
   "sourceManifestPath": "dist/manifest.json",
   "agentDocPath": "AGENTS.md",
   "sourceHashes": {
-    "manifest": "d94c3cf925d57998e6a0d49764a6889aef2d0354a02956862eda15ec8a3451b9",
-    "packageJson": "ee2dadef120a9152f28286a474bfff9d1d7e45dcd9b3fb2bcb57f3ea197b62bf",
-    "agents": "3b81365608ec4f1929b51db17194f9c1f74d420b49886277e0f94b42238915d8"
+    "manifest": "1fb1f0edecc448a8615510f61192531e8ac410d6efd6a97c2d4e463648916070",
+    "packageJson": "13b0b2ae46d6ad7c93116001fcdd5a936daa241932c5203dcb08de52a58f89c1",
+    "agents": "65754c7b32b54e664f41ff3905773caa42b6fe730027e8340d526d583eee4012"
   },
   "exports": [
     ".",
@@ -346,61 +346,70 @@
           "type": "crossPackageRef",
           "required": false,
           "related": "@happyvertical/smrt-commerce:Customer",
-          "columnType": "UUID"
+          "columnType": "UUID",
+          "description": "The customer this campaign is run for, if any."
         },
         {
           "name": "campaignKey",
           "type": "text",
           "required": true,
           "columnType": "TEXT",
-          "default": ""
+          "default": "",
+          "description": "A short reference of your own for this campaign, kept the same once it is in use."
         },
         {
           "name": "name",
           "type": "text",
           "required": true,
           "columnType": "TEXT",
-          "default": ""
+          "default": "",
+          "description": "What the campaign is called."
         },
         {
           "name": "objective",
           "type": "text",
           "required": false,
           "columnType": "TEXT",
-          "default": ""
+          "default": "",
+          "description": "What the campaign is meant to achieve, such as awareness or new leads."
         },
         {
           "name": "status",
           "type": "text",
           "required": false,
           "columnType": "TEXT",
-          "default": "draft"
+          "default": "draft",
+          "description": "Where the campaign stands, from draft through active to completed and archived."
         },
         {
           "name": "startAt",
           "type": "datetime",
           "required": false,
-          "columnType": "TIMESTAMP"
+          "columnType": "TIMESTAMP",
+          "description": "When the campaign starts."
         },
         {
           "name": "endAt",
           "type": "datetime",
           "required": false,
-          "columnType": "TIMESTAMP"
+          "columnType": "TIMESTAMP",
+          "description": "When the campaign ends."
         },
         {
           "name": "budgetCents",
           "type": "integer",
           "required": false,
           "columnType": "INTEGER",
-          "default": 0
+          "default": 0,
+          "description": "The total you plan to spend on the campaign, in cents."
         },
         {
           "name": "currency",
           "type": "text",
           "required": false,
           "columnType": "TEXT",
-          "default": "USD"
+          "default": "USD",
+          "description": "The currency every amount on this campaign is in."
         },
         {
           "name": "metadata",
@@ -610,47 +619,54 @@
           "type": "foreignKey",
           "required": true,
           "related": "Campaign",
-          "columnType": "UUID"
+          "columnType": "UUID",
+          "description": "The campaign this channel runs for."
         },
         {
           "name": "channelKind",
           "type": "text",
           "required": true,
           "columnType": "TEXT",
-          "default": ""
+          "default": "",
+          "description": "What sort of channel this is, such as an ad group, a social post, a message, content or an event."
         },
         {
           "name": "channelRef",
           "type": "text",
           "required": true,
           "columnType": "TEXT",
-          "default": ""
+          "default": "",
+          "description": "The name or reference the channel goes by, so its results can be matched to it."
         },
         {
           "name": "allocatedBudgetCents",
           "type": "integer",
           "required": false,
           "columnType": "INTEGER",
-          "default": 0
+          "default": 0,
+          "description": "The share of the campaign budget set aside for this channel, in cents."
         },
         {
           "name": "startAt",
           "type": "datetime",
           "required": false,
-          "columnType": "TIMESTAMP"
+          "columnType": "TIMESTAMP",
+          "description": "When this channel starts, if different from the campaign."
         },
         {
           "name": "endAt",
           "type": "datetime",
           "required": false,
-          "columnType": "TIMESTAMP"
+          "columnType": "TIMESTAMP",
+          "description": "When this channel ends, if different from the campaign."
         },
         {
           "name": "status",
           "type": "text",
           "required": false,
           "columnType": "TEXT",
-          "default": "planned"
+          "default": "planned",
+          "description": "Where this channel stands, from planned through active to completed or cancelled."
         }
       ],
       "relationships": [
@@ -826,81 +842,93 @@
           "type": "foreignKey",
           "required": true,
           "related": "Campaign",
-          "columnType": "UUID"
+          "columnType": "UUID",
+          "description": "The campaign these results belong to."
         },
         {
           "name": "campaignChannelId",
           "type": "foreignKey",
           "required": false,
           "related": "CampaignChannel",
-          "columnType": "UUID"
+          "columnType": "UUID",
+          "description": "The channel these results came from. Empty when they cover the whole campaign."
         },
         {
           "name": "periodStart",
           "type": "datetime",
           "required": true,
-          "columnType": "TIMESTAMP"
+          "columnType": "TIMESTAMP",
+          "description": "The first day of the period these results cover."
         },
         {
           "name": "periodEnd",
           "type": "datetime",
           "required": true,
-          "columnType": "TIMESTAMP"
+          "columnType": "TIMESTAMP",
+          "description": "The last day of the period these results cover."
         },
         {
           "name": "spendCents",
           "type": "integer",
           "required": false,
           "columnType": "INTEGER",
-          "default": 0
+          "default": 0,
+          "description": "What was spent in the period, in cents."
         },
         {
           "name": "impressions",
           "type": "integer",
           "required": false,
           "columnType": "INTEGER",
-          "default": 0
+          "default": 0,
+          "description": "How many times the campaign was shown."
         },
         {
           "name": "clicks",
           "type": "integer",
           "required": false,
           "columnType": "INTEGER",
-          "default": 0
+          "default": 0,
+          "description": "How many times someone clicked through."
         },
         {
           "name": "conversions",
           "type": "integer",
           "required": false,
           "columnType": "INTEGER",
-          "default": 0
+          "default": 0,
+          "description": "How many people did what the campaign asked, such as buying."
         },
         {
           "name": "leads",
           "type": "integer",
           "required": false,
           "columnType": "INTEGER",
-          "default": 0
+          "default": 0,
+          "description": "How many new leads came in."
         },
         {
           "name": "revenueCents",
           "type": "integer",
           "required": false,
-          "columnType": "INTEGER"
+          "columnType": "INTEGER",
+          "description": "The sales brought in during the period, in cents, if known."
         },
         {
           "name": "source",
           "type": "text",
           "required": true,
           "columnType": "TEXT",
-          "default": ""
+          "default": "",
+          "description": "Where these results were reported from."
         },
         {
           "name": "dedupeKey",
           "type": "text",
           "required": true,
           "columnType": "TEXT",
-          "default": ""
+          "default": "",
+          "description": "The reference this result is filed under, so the same report is never counted twice."
         }
       ],
       "relationships": [
@@ -1280,7 +1308,212 @@
     "polymorphicAssociations": 0,
     "uuidColumns": 20
   },
-  "agentDoc": "# @happyvertical/smrt-marketing\n\nCross-channel campaign coordination for SMRT. This package owns Campaign\nidentity, budgets, lifecycle, execution links, immutable performance evidence,\ncomputed pacing, and props-driven Svelte surfaces. It does not execute ads,\npublish social posts, send messages, or own sales attribution.\n\n## Validation\n\nRun `pnpm --filter @happyvertical/smrt-marketing test` and\n`pnpm --filter @happyvertical/smrt-marketing typecheck`; use `test:coverage`\nto exercise the model/service and component coverage configurations.\nNatural-key changes must also run\n`pnpm --filter @happyvertical/smrt-marketing test:postgres` when\nthe disposable PostgreSQL harness is available. Use\n`pnpm --filter @happyvertical/smrt-marketing build` and `verify:pack` for\npublish-surface changes.\n\n## Models\n\n- **Campaign**: optional-tenant umbrella with stable natural key\n  `(tenant_id, campaign_key)`, open objective, integer-cent budget, currency,\n  schedule, optional native UUID reference to the canonical commerce Customer,\n  guarded metadata helpers, and lifecycle\n  `draft → scheduled → active ↔ paused → completed → archived`. Raw saves are\n  protected by an authoritative prior-status re-read; use\n  `CampaignLifecycleService` for lifecycle writes.\n- **CampaignChannel**: one generic execution link per\n  `(campaign_id, channel_kind, channel_ref)`. `channelKind`/`channelRef` are\n  intentionally plain strings so ads, social, messages, content, events, and\n  referral programs remain peer packages. Allocation and schedule overrides\n  use integer cents and dates.\n- **CampaignMetricSnapshot**: immutable period evidence with a global\n  `dedupe_key` natural key. A snapshot always carries `campaignId`; a null\n  `campaignChannelId` means campaign-level rollup evidence; when present, the\n  channel must belong to that same campaign. API/MCP/CLI expose create/list/get\n  only, and the save guard rejects hydrated edits, blind-id overwrites, and\n  natural-key overwrites. Programmatic deletion is rejected.\n\nEvery model is `@TenantScoped({ mode: 'optional' })` with nullable `tenantId`.\nAll generated surfaces are explicit; never omit `api`, `mcp`, or `cli` config.\n\n## Services\n\n- **CampaignLifecycleService** loads the current row before applying one legal\n  transition. Paused campaigns may resume; completed campaigns may only be\n  archived; archived campaigns are terminal.\n- **MetricIngestionService** validates required scope/source/period fields and\n  delegates to `getOrCreateByDedupeKey()`. A replay returns the original row\n  unchanged even if the replay payload differs.\n- **BudgetPacingService** computes campaign/channel pacing from snapshots and\n  never persists derived balances. For each exact reporting period, campaign\n  pacing prefers campaign rollups and otherwise sums channel snapshots,\n  preventing double counting without dropping channel-only periods. Status\n  uses a five-percent budget tolerance around schedule-derived expected spend.\n- **CampaignCollection** exposes bounded, tenant-and-Customer-scoped cursor\n  pages ordered by `start_at DESC, id DESC` and bounded batch summaries for\n  total count, active count, and latest start time. Its reporting-page variant\n  preserves that order/cursor and adds channel count/mix, immutable metric\n  totals, and canonical pacing with two page-wide grouped reads. Customer scope\n  is validated through runtime relationship metadata; there is no static\n  commerce import, per-campaign callback, or tenant-wide materialization.\n\n## Svelte\n\n`@happyvertical/smrt-marketing/svelte` exports `MarketingDashboard`,\n`CampaignList`, `CampaignDetail`, `ChannelMix`, and `BudgetPacing`, plus view\ninterfaces and pure helpers. Components are props-only: no fetching, no model\nimports, no providers. Use Provider-free `smrt-ui` primitives, `--smrt-*`\ntokens, named `$props()` interfaces, and integer-cent inputs formatted only at\nrender time.\n\n## Boundaries and gotchas\n\n- Runtime dependencies stay limited to `smrt-core`, `smrt-tenancy`, and\n  `smrt-ui`. Never statically import sibling domain packages.\n- `Campaign.customerId` targets `@happyvertical/smrt-commerce:Customer` through\n  `@crossPackageRef`. Saves and customer-scoped reads require exact tenant\n  agreement (including global-to-global only) and fail without revealing\n  whether a Customer is absent or belongs elsewhere. Associated saves validate\n  and persist through one transaction-bound Campaign instance; scoped reads\n  validate and query through one fresh transaction-bound collection. PostgreSQL\n  locks the validated Customer rows for the duration of each operation.\n- Lead loop-closing is conventional: CRM stores `sourceKind: 'campaign'` and a\n  campaign key in `sourceId`; marketing does not import or mutate Lead.\n- Attribution math remains in sales/referrals. Marketing stores performance\n  evidence only.\n- Campaign rollups and channel snapshots may describe the same period. The\n  pacing service deliberately chooses one evidence level instead of summing\n  both.\n- Corrections append a new metric snapshot with a new dedupe key; never edit\n  persisted evidence.\n- Table names are global: `campaigns`, `campaign_channels`, and\n  `campaign_metric_snapshots`.\n",
+  "agentDoc": "# @happyvertical/smrt-marketing\n\nCross-channel campaign coordination for SMRT. This package owns Campaign\nidentity, budgets, lifecycle, execution links, immutable performance evidence,\ncomputed pacing, and props-driven Svelte surfaces. It does not execute ads,\npublish social posts, send messages, or own sales attribution.\n\n## Validation\n\nRun `pnpm --filter @happyvertical/smrt-marketing test` and\n`pnpm --filter @happyvertical/smrt-marketing typecheck`; use `test:coverage`\nto exercise the model/service and component coverage configurations.\nNatural-key changes must also run\n`pnpm --filter @happyvertical/smrt-marketing test:postgres` when\nthe disposable PostgreSQL harness is available. Use\n`pnpm --filter @happyvertical/smrt-marketing build` and `verify:pack` for\npublish-surface changes.\n\n## Models\n\n- **Campaign**: optional-tenant umbrella with stable natural key\n  `(tenant_id, campaign_key)`, open objective, integer-cent budget, currency,\n  schedule, optional native UUID reference to the canonical commerce Customer,\n  guarded metadata helpers, and lifecycle\n  `draft → scheduled → active ↔ paused → completed → archived`. Raw saves are\n  protected by an authoritative prior-status re-read; use\n  `CampaignLifecycleService` for lifecycle writes.\n- **CampaignChannel**: one generic execution link per\n  `(campaign_id, channel_kind, channel_ref)`. `channelKind`/`channelRef` are\n  intentionally plain strings so ads, social, messages, content, events, and\n  referral programs remain peer packages. Allocation and schedule overrides\n  use integer cents and dates.\n- **CampaignMetricSnapshot**: immutable period evidence with a global\n  `dedupe_key` natural key. A snapshot always carries `campaignId`; a null\n  `campaignChannelId` means campaign-level rollup evidence; when present, the\n  channel must belong to that same campaign. API/MCP/CLI expose create/list/get\n  only, and the save guard rejects hydrated edits, blind-id overwrites, and\n  natural-key overwrites. Programmatic deletion is rejected.\n\nEvery model is `@TenantScoped({ mode: 'optional' })` with nullable `tenantId`.\nAll generated surfaces are explicit; never omit `api`, `mcp`, or `cli` config.\n\n- **Recipe `marketing.campaigns`** (`src/recipes.ts`, help in\n  `src/campaigns.recipe.md`): lists campaigns and channels for the planner and\n  other catalog hosts; results (snapshots) are a child record of the campaign,\n  not a menu entry. Results are read-only there (snapshots are\n  written by `MetricIngestionService`) and the help never tells a person to set\n  the lifecycle status by hand. Fields it shows carry `@field({ description })`\n  in plain words; keep them when editing the models.\n\n## Services\n\n- **CampaignLifecycleService** loads the current row before applying one legal\n  transition. Paused campaigns may resume; completed campaigns may only be\n  archived; archived campaigns are terminal.\n- **MetricIngestionService** validates required scope/source/period fields and\n  delegates to `getOrCreateByDedupeKey()`. A replay returns the original row\n  unchanged even if the replay payload differs.\n- **BudgetPacingService** computes campaign/channel pacing from snapshots and\n  never persists derived balances. For each exact reporting period, campaign\n  pacing prefers campaign rollups and otherwise sums channel snapshots,\n  preventing double counting without dropping channel-only periods. Status\n  uses a five-percent budget tolerance around schedule-derived expected spend.\n- **CampaignCollection** exposes bounded, tenant-and-Customer-scoped cursor\n  pages ordered by `start_at DESC, id DESC` and bounded batch summaries for\n  total count, active count, and latest start time. Its reporting-page variant\n  preserves that order/cursor and adds channel count/mix, immutable metric\n  totals, and canonical pacing with two page-wide grouped reads. Customer scope\n  is validated through runtime relationship metadata; there is no static\n  commerce import, per-campaign callback, or tenant-wide materialization.\n\n## Svelte\n\n`@happyvertical/smrt-marketing/svelte` exports `MarketingDashboard`,\n`CampaignList`, `CampaignDetail`, `ChannelMix`, and `BudgetPacing`, plus view\ninterfaces and pure helpers. Components are props-only: no fetching, no model\nimports, no providers. Use Provider-free `smrt-ui` primitives, `--smrt-*`\ntokens, named `$props()` interfaces, and integer-cent inputs formatted only at\nrender time.\n\n## Boundaries and gotchas\n\n- Runtime dependencies stay limited to `smrt-core`, `smrt-tenancy`, and\n  `smrt-ui`. Never statically import sibling domain packages.\n- `Campaign.customerId` targets `@happyvertical/smrt-commerce:Customer` through\n  `@crossPackageRef`. Saves and customer-scoped reads require exact tenant\n  agreement (including global-to-global only) and fail without revealing\n  whether a Customer is absent or belongs elsewhere. Associated saves validate\n  and persist through one transaction-bound Campaign instance; scoped reads\n  validate and query through one fresh transaction-bound collection. PostgreSQL\n  locks the validated Customer rows for the duration of each operation.\n- Lead loop-closing is conventional: CRM stores `sourceKind: 'campaign'` and a\n  campaign key in `sourceId`; marketing does not import or mutate Lead.\n- Attribution math remains in sales/referrals. Marketing stores performance\n  evidence only.\n- Campaign rollups and channel snapshots may describe the same period. The\n  pacing service deliberately chooses one evidence level instead of summing\n  both.\n- Corrections append a new metric snapshot with a new dedupe key; never edit\n  persisted evidence.\n- Table names are global: `campaigns`, `campaign_channels`, and\n  `campaign_metric_snapshots`.\n",
+  "recipes": [
+    {
+      "id": "marketing.campaigns",
+      "className": "MarketingCampaignsRecipe",
+      "label": "Campaigns",
+      "summary": "Plan a marketing campaign, set its budget and dates, choose where it runs and see what it brought in.",
+      "synonyms": [
+        "marketing",
+        "marketing campaigns",
+        "promotions",
+        "advertising",
+        "ad campaigns",
+        "campaign results"
+      ],
+      "models": [
+        "@happyvertical/smrt-marketing:Campaign",
+        "@happyvertical/smrt-marketing:CampaignChannel",
+        "@happyvertical/smrt-marketing:CampaignMetricSnapshot"
+      ],
+      "nav": [
+        {
+          "label": "Campaigns",
+          "model": "@happyvertical/smrt-marketing:Campaign",
+          "icon": "tag",
+          "description": "Every campaign, with its budget, dates and where it stands.",
+          "noun": "campaign"
+        },
+        {
+          "label": "Channels",
+          "model": "@happyvertical/smrt-marketing:CampaignChannel",
+          "icon": "layers",
+          "description": "Where each campaign runs, such as an ad group or a social post, and its share of the budget.",
+          "noun": "channel"
+        }
+      ],
+      "requires": [],
+      "section": {
+        "id": "grow",
+        "label": "Grow",
+        "icon": "tag",
+        "description": "Bring in new customers and reward the people who help."
+      },
+      "options": {
+        "@happyvertical/smrt-marketing:Campaign": {
+          "fields": {
+            "name": {
+              "order": 1
+            },
+            "objective": {
+              "order": 2
+            },
+            "status": {
+              "order": 3
+            },
+            "startAt": {
+              "label": "Starts",
+              "order": 4
+            },
+            "endAt": {
+              "label": "Ends",
+              "order": 5
+            },
+            "budgetCents": {
+              "label": "Budget (cents)",
+              "order": 6
+            },
+            "currency": {
+              "order": 7
+            },
+            "customerId": {
+              "label": "Customer",
+              "visibility": "advanced"
+            },
+            "campaignKey": {
+              "label": "Reference",
+              "visibility": "advanced"
+            },
+            "tenantId": {
+              "visibility": "hidden"
+            },
+            "metadata": {
+              "visibility": "hidden"
+            }
+          }
+        },
+        "@happyvertical/smrt-marketing:CampaignChannel": {
+          "fields": {
+            "campaignId": {
+              "label": "Campaign",
+              "order": 1
+            },
+            "channelKind": {
+              "label": "Kind",
+              "order": 2
+            },
+            "channelRef": {
+              "label": "Name",
+              "order": 3
+            },
+            "allocatedBudgetCents": {
+              "label": "Budget share (cents)",
+              "order": 4
+            },
+            "status": {
+              "order": 5
+            },
+            "startAt": {
+              "label": "Starts",
+              "order": 6
+            },
+            "endAt": {
+              "label": "Ends",
+              "order": 7
+            },
+            "tenantId": {
+              "visibility": "hidden"
+            }
+          }
+        },
+        "@happyvertical/smrt-marketing:CampaignMetricSnapshot": {
+          "fields": {
+            "campaignId": {
+              "label": "Campaign",
+              "order": 1
+            },
+            "campaignChannelId": {
+              "label": "Channel",
+              "order": 2
+            },
+            "periodStart": {
+              "label": "From",
+              "order": 3
+            },
+            "periodEnd": {
+              "label": "To",
+              "order": 4
+            },
+            "spendCents": {
+              "label": "Spend (cents)",
+              "order": 5
+            },
+            "impressions": {
+              "order": 6
+            },
+            "clicks": {
+              "order": 7
+            },
+            "conversions": {
+              "order": 8
+            },
+            "leads": {
+              "order": 9
+            },
+            "revenueCents": {
+              "label": "Revenue (cents)",
+              "order": 10
+            },
+            "source": {
+              "order": 11
+            },
+            "tenantId": {
+              "visibility": "hidden"
+            },
+            "dedupeKey": {
+              "visibility": "hidden"
+            }
+          }
+        }
+      },
+      "help": {
+        "markdown": "## Overview\n\nCampaigns is where you plan a push to bring in customers: a sale, a launch, a\nseasonal promotion. Each campaign has a budget, start and end dates and a\nstatus that shows where it stands, from draft through active to completed. A\ncampaign runs on one or more channels, such as an ad group, a social post, an\nemail or an event, each with its share of the budget. Results come back from\nthe channels' reporting, period by period, so you can see what each campaign\nand channel brought in for what it cost.\n\n## Tasks\n\n### Plan a campaign\n\n1. Open the list of campaigns and choose **New**.\n2. Type the **{field:Campaign.name}**, for example \"Spring widget sale\".\n3. Say what it is for in **{field:Campaign.objective}**, such as awareness or new leads.\n4. Set when it **{field:Campaign.startAt}** and when it **{field:Campaign.endAt}**. The end cannot be before the start.\n5. Enter the **{field:Campaign.budgetCents}** as a whole number of cents, so $500 is 50000, and check the **{field:Campaign.currency}**.\n6. Save. A new campaign starts as a draft.\n\n### See where a campaign stands\n\n1. Open the list of campaigns.\n2. The **{field:Campaign.status}** shows whether each one is still a draft, scheduled, active, paused, completed or archived. It moves forward as the campaign is scheduled, run and wrapped up; you do not set it by hand.\n3. Open a campaign to change its name, dates or budget while it is still being planned.\n\n### Add a channel to a campaign\n\n1. Open the list of channels and choose **New**.\n2. Pick the **{field:CampaignChannel.campaignId}** it belongs to.\n3. Choose the **{field:CampaignChannel.channelKind}**, such as an ad group, a social post, a message, content or an event.\n4. Type the **{field:CampaignChannel.channelRef}** the channel goes by, so its results can be matched to it later.\n5. Enter its **{field:CampaignChannel.allocatedBudgetCents}** as a whole number of cents.\n6. If the channel runs on different dates from the campaign, set when it **{field:CampaignChannel.startAt}** and **{field:CampaignChannel.endAt}**.\n7. Save. You can edit a channel later, or remove one that will not run.\n\n### Read the results\n\nResults arrive from the channels' reporting; nobody types them in. Each one\ncovers a period for one campaign, or for one channel within it. A result is\nnever changed once it is in: a correction arrives as a new result for the same\nperiod.\n\n1. Open a campaign and look at its results, listed under the campaign.\n2. Each result names the **{field:CampaignMetricSnapshot.campaignId}** it belongs to. A result with no **{field:CampaignMetricSnapshot.campaignChannelId}** covers the whole campaign.\n3. Check the period, **{field:CampaignMetricSnapshot.periodStart}** to **{field:CampaignMetricSnapshot.periodEnd}**.\n4. Compare the **{field:CampaignMetricSnapshot.spendCents}** with the **{field:CampaignMetricSnapshot.clicks}**, **{field:CampaignMetricSnapshot.leads}** and **{field:CampaignMetricSnapshot.conversions}** it brought in, and the **{field:CampaignMetricSnapshot.revenueCents}** where the channel reports it.\n5. The **{field:CampaignMetricSnapshot.source}** says which channel's reporting sent the result.\n",
+        "fieldRefs": [
+          "Campaign.budgetCents",
+          "Campaign.currency",
+          "Campaign.endAt",
+          "Campaign.name",
+          "Campaign.objective",
+          "Campaign.startAt",
+          "Campaign.status",
+          "CampaignChannel.allocatedBudgetCents",
+          "CampaignChannel.campaignId",
+          "CampaignChannel.channelKind",
+          "CampaignChannel.channelRef",
+          "CampaignChannel.endAt",
+          "CampaignChannel.startAt",
+          "CampaignMetricSnapshot.campaignChannelId",
+          "CampaignMetricSnapshot.campaignId",
+          "CampaignMetricSnapshot.clicks",
+          "CampaignMetricSnapshot.conversions",
+          "CampaignMetricSnapshot.leads",
+          "CampaignMetricSnapshot.periodEnd",
+          "CampaignMetricSnapshot.periodStart",
+          "CampaignMetricSnapshot.revenueCents",
+          "CampaignMetricSnapshot.source",
+          "CampaignMetricSnapshot.spendCents"
+        ]
+      },
+      "demo": {
+        "mode": "server",
+        "reasons": [
+          "Needs a server because its package depends on @happyvertical/smrt-tenancy, which do not build for a browser (#3624)."
+        ]
+      }
+    }
+  ],
   "browser": {
     "status": "server-only",
     "issues": [