@aglyn/plugins-email 1.0.0-beta.143

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (144) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +7 -0
  3. package/package.json +58 -0
  4. package/src/index.d.ts +35 -0
  5. package/src/index.js +35 -0
  6. package/src/index.js.map +1 -0
  7. package/src/lib/components/campaign-design-create-widget.d.ts +21 -0
  8. package/src/lib/components/campaign-design-create-widget.js +61 -0
  9. package/src/lib/components/campaign-design-create-widget.js.map +1 -0
  10. package/src/lib/components/campaign-sender-editor-widget.d.ts +18 -0
  11. package/src/lib/components/campaign-sender-editor-widget.js +39 -0
  12. package/src/lib/components/campaign-sender-editor-widget.js.map +1 -0
  13. package/src/lib/components/campaign-topic-options-widget.d.ts +19 -0
  14. package/src/lib/components/campaign-topic-options-widget.js +48 -0
  15. package/src/lib/components/campaign-topic-options-widget.js.map +1 -0
  16. package/src/lib/components/campaign-topic-select.d.ts +32 -0
  17. package/src/lib/components/campaign-topic-select.js +87 -0
  18. package/src/lib/components/campaign-topic-select.js.map +1 -0
  19. package/src/lib/components/dynamic-list-rule-fields.d.ts +173 -0
  20. package/src/lib/components/dynamic-list-rule-fields.js +1473 -0
  21. package/src/lib/components/dynamic-list-rule-fields.js.map +1 -0
  22. package/src/lib/components/email-blocks.d.ts +111 -0
  23. package/src/lib/components/email-blocks.js +875 -0
  24. package/src/lib/components/email-blocks.js.map +1 -0
  25. package/src/lib/components/email-design-preview.d.ts +62 -0
  26. package/src/lib/components/email-design-preview.js +174 -0
  27. package/src/lib/components/email-design-preview.js.map +1 -0
  28. package/src/lib/components/email-screens-card.d.ts +42 -0
  29. package/src/lib/components/email-screens-card.js +277 -0
  30. package/src/lib/components/email-screens-card.js.map +1 -0
  31. package/src/lib/components/email-template-detail.d.ts +48 -0
  32. package/src/lib/components/email-template-detail.js +681 -0
  33. package/src/lib/components/email-template-detail.js.map +1 -0
  34. package/src/lib/components/email-topic-detail.d.ts +32 -0
  35. package/src/lib/components/email-topic-detail.js +293 -0
  36. package/src/lib/components/email-topic-detail.js.map +1 -0
  37. package/src/lib/components/email-topics-card.d.ts +46 -0
  38. package/src/lib/components/email-topics-card.js +327 -0
  39. package/src/lib/components/email-topics-card.js.map +1 -0
  40. package/src/lib/components/email-zones.d.ts +28 -0
  41. package/src/lib/components/email-zones.js +20 -0
  42. package/src/lib/components/email-zones.js.map +1 -0
  43. package/src/lib/components/emails-console-page.d.ts +32 -0
  44. package/src/lib/components/emails-console-page.js +229 -0
  45. package/src/lib/components/emails-console-page.js.map +1 -0
  46. package/src/lib/components/emails-console-sections.d.ts +36 -0
  47. package/src/lib/components/emails-console-sections.js +108 -0
  48. package/src/lib/components/emails-console-sections.js.map +1 -0
  49. package/src/lib/components/list-detail-card.d.ts +47 -0
  50. package/src/lib/components/list-detail-card.js +273 -0
  51. package/src/lib/components/list-detail-card.js.map +1 -0
  52. package/src/lib/components/list-edit-card.d.ts +11 -0
  53. package/src/lib/components/list-edit-card.js +287 -0
  54. package/src/lib/components/list-edit-card.js.map +1 -0
  55. package/src/lib/components/list-import-drawer.d.ts +22 -0
  56. package/src/lib/components/list-import-drawer.js +662 -0
  57. package/src/lib/components/list-import-drawer.js.map +1 -0
  58. package/src/lib/components/list-members-panel.d.ts +94 -0
  59. package/src/lib/components/list-members-panel.js +686 -0
  60. package/src/lib/components/list-members-panel.js.map +1 -0
  61. package/src/lib/components/lists-card.d.ts +28 -0
  62. package/src/lib/components/lists-card.js +377 -0
  63. package/src/lib/components/lists-card.js.map +1 -0
  64. package/src/lib/components/sending-domain-detail.d.ts +26 -0
  65. package/src/lib/components/sending-domain-detail.js +496 -0
  66. package/src/lib/components/sending-domain-detail.js.map +1 -0
  67. package/src/lib/components/sending-domains-card.d.ts +33 -0
  68. package/src/lib/components/sending-domains-card.js +962 -0
  69. package/src/lib/components/sending-domains-card.js.map +1 -0
  70. package/src/lib/components/sending-sender-drawer.d.ts +94 -0
  71. package/src/lib/components/sending-sender-drawer.js +543 -0
  72. package/src/lib/components/sending-sender-drawer.js.map +1 -0
  73. package/src/lib/components/suppressions-card.d.ts +49 -0
  74. package/src/lib/components/suppressions-card.js +639 -0
  75. package/src/lib/components/suppressions-card.js.map +1 -0
  76. package/src/lib/components/use-org-email-topics.d.ts +79 -0
  77. package/src/lib/components/use-org-email-topics.js +111 -0
  78. package/src/lib/components/use-org-email-topics.js.map +1 -0
  79. package/src/lib/constants/bundle-common.d.ts +18 -0
  80. package/src/lib/constants/bundle-common.js +18 -0
  81. package/src/lib/constants/bundle-common.js.map +1 -0
  82. package/src/lib/hooks/use-org-company-options.d.ts +20 -0
  83. package/src/lib/hooks/use-org-company-options.js +138 -0
  84. package/src/lib/hooks/use-org-company-options.js.map +1 -0
  85. package/src/lib/hooks/use-org-contact-fields.d.ts +40 -0
  86. package/src/lib/hooks/use-org-contact-fields.js +91 -0
  87. package/src/lib/hooks/use-org-contact-fields.js.map +1 -0
  88. package/src/lib/hooks/use-org-contact-segments.d.ts +16 -0
  89. package/src/lib/hooks/use-org-contact-segments.js +55 -0
  90. package/src/lib/hooks/use-org-contact-segments.js.map +1 -0
  91. package/src/lib/hooks/use-org-crm-views.d.ts +8 -0
  92. package/src/lib/hooks/use-org-crm-views.js +74 -0
  93. package/src/lib/hooks/use-org-crm-views.js.map +1 -0
  94. package/src/lib/hooks/use-org-lists.d.ts +8 -0
  95. package/src/lib/hooks/use-org-lists.js +47 -0
  96. package/src/lib/hooks/use-org-lists.js.map +1 -0
  97. package/src/lib/model/email-design-document.d.ts +52 -0
  98. package/src/lib/model/email-design-document.js +62 -0
  99. package/src/lib/model/email-design-document.js.map +1 -0
  100. package/src/lib/model/index.d.ts +64 -0
  101. package/src/lib/model/index.js +71 -0
  102. package/src/lib/model/index.js.map +1 -0
  103. package/src/lib/model/sending-domain-status.d.ts +99 -0
  104. package/src/lib/model/sending-domain-status.js +196 -0
  105. package/src/lib/model/sending-domain-status.js.map +1 -0
  106. package/src/lib/model/template-provenance.d.ts +113 -0
  107. package/src/lib/model/template-provenance.js +107 -0
  108. package/src/lib/model/template-provenance.js.map +1 -0
  109. package/src/lib/model/template-report.d.ts +158 -0
  110. package/src/lib/model/template-report.js +249 -0
  111. package/src/lib/model/template-report.js.map +1 -0
  112. package/src/lib/plugin.d.ts +27 -0
  113. package/src/lib/plugin.js +163 -0
  114. package/src/lib/plugin.js.map +1 -0
  115. package/src/lib/server-console.d.ts +116 -0
  116. package/src/lib/server-console.js +422 -0
  117. package/src/lib/server-console.js.map +1 -0
  118. package/src/lib/server-email-drafts.d.ts +104 -0
  119. package/src/lib/server-email-drafts.js +381 -0
  120. package/src/lib/server-email-drafts.js.map +1 -0
  121. package/src/lib/server-list-gate.d.ts +183 -0
  122. package/src/lib/server-list-gate.js +365 -0
  123. package/src/lib/server-list-gate.js.map +1 -0
  124. package/src/lib/server-list-import.d.ts +199 -0
  125. package/src/lib/server-list-import.js +632 -0
  126. package/src/lib/server-list-import.js.map +1 -0
  127. package/src/lib/server-suppressions.d.ts +135 -0
  128. package/src/lib/server-suppressions.js +295 -0
  129. package/src/lib/server-suppressions.js.map +1 -0
  130. package/src/lib/server.d.ts +19 -0
  131. package/src/lib/server.js +834 -0
  132. package/src/lib/server.js.map +1 -0
  133. package/src/lib/site.d.ts +26 -0
  134. package/src/lib/site.js +81 -0
  135. package/src/lib/site.js.map +1 -0
  136. package/src/lib/unsubscribe-link.d.ts +311 -0
  137. package/src/lib/unsubscribe-link.js +398 -0
  138. package/src/lib/unsubscribe-link.js.map +1 -0
  139. package/src/lib/utils/create-email-screen.d.ts +59 -0
  140. package/src/lib/utils/create-email-screen.js +59 -0
  141. package/src/lib/utils/create-email-screen.js.map +1 -0
  142. package/src/lib/utils/generate-preset-id.d.ts +19 -0
  143. package/src/lib/utils/generate-preset-id.js +25 -0
  144. package/src/lib/utils/generate-preset-id.js.map +1 -0
@@ -0,0 +1,158 @@
1
+ /**
2
+ * @license
3
+ * Copyright 2026 Aglyn LLC
4
+ *
5
+ * Licensed under the Apache License, Version 2.0 (the "License");
6
+ * you may not use this file except in compliance with the License.
7
+ * You may obtain a copy of the License at
8
+ *
9
+ * http://www.apache.org/licenses/LICENSE-2.0
10
+ *
11
+ * Unless required by applicable law or agreed to in writing, software
12
+ * distributed under the License is distributed on an "AS IS" BASIS,
13
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ * See the License for the specific language governing permissions and
15
+ * limitations under the License.
16
+ */
17
+ /**
18
+ * ONE DESIGN, MEASURED ACROSS EVERY CAMPAIGN THAT USED IT.
19
+ *
20
+ * ## What this adds to `campaign-report.ts`
21
+ *
22
+ * A campaign report divides two numbers that were recorded by the same send.
23
+ * A design report divides two SUMS, and a sum has a membership: which
24
+ * campaigns went into it. That is the whole difficulty, and it is a new way
25
+ * for the repo's rule — every rate names its denominator — to be broken.
26
+ *
27
+ * ## The rule, restated for a sum
28
+ *
29
+ * **A rate's numerator and its denominator are summed over the SAME set of
30
+ * campaigns, and the screen is told how large that set is.**
31
+ *
32
+ * `delivered` is written only by the delivery webhook, so a design used by
33
+ * five campaigns may have three that recorded it and two that never did.
34
+ * Summing `uniqueOpens` over all five and dividing by `delivered` summed over
35
+ * three produces an open rate that can exceed 100% and is, in every case,
36
+ * the flattering substitution `campaign-report.ts` exists to refuse — carried
37
+ * out by addition instead of by picking the wrong field.
38
+ *
39
+ * So each rate here is built from a FILTERED subset, and
40
+ * {@link TemplateRate.denominatorLabel} names the subset as well as the
41
+ * quantity: `delivered across 3 of 5 campaigns`. A reader comparing this
42
+ * design's open rate with another's can see the two were taken over different
43
+ * populations without being told separately.
44
+ *
45
+ * ## Counts are over everything; rates are over what can be divided
46
+ *
47
+ * The COUNTS — opens, clicks, unsubscribes — are summed over every campaign,
48
+ * because a count is true whatever else was recorded. Only the rates narrow.
49
+ * The two are labelled differently on screen for that reason, and the caveats
50
+ * say how many campaigns each rate left out.
51
+ *
52
+ * ## Why this is a pure module
53
+ *
54
+ * Same reason as `campaign-report.ts`: a division written in JSX is a
55
+ * denominator chosen by whoever writes the next card. Here it is worse — the
56
+ * subset is invisible in the output unless something carries it — so the
57
+ * subset is data, computed once, and the screen renders it.
58
+ */
59
+ import { type CampaignRate, type CampaignStats } from '@aglyn/shared-ui-email-campaigns/model/campaign-report';
60
+ /** A rate over a sum, carrying how many campaigns the sum covers. */
61
+ export type TemplateRate = CampaignRate;
62
+ /**
63
+ * One campaign that used the design, as the report reads it.
64
+ *
65
+ * `sentAtMs` is nullable because a campaign document can exist without ever
66
+ * having been sent — a scheduled campaign holds `sendAtMs` and no `sentAt`.
67
+ * Those carry no engagement and the reader is shown their status rather than
68
+ * a row of zeroes.
69
+ */
70
+ export interface TemplateCampaign {
71
+ campaignId: string;
72
+ subject: string;
73
+ /** Epoch ms, or null for a campaign that has not been sent. */
74
+ sentAtMs: number | null;
75
+ /** `'sent'`, `'scheduled'`, `'canceled'`. A persisted value; not relabeled. */
76
+ status: string;
77
+ /** The audience KIND — `'leads'`, `'members'`, `'segment'`, `'list'`. */
78
+ audience: string;
79
+ /** Set when `audience` is `'list'`. */
80
+ listId?: string;
81
+ /** The list's name AS IT WAS at send time, when the send recorded one. */
82
+ listName?: string;
83
+ stats: CampaignStats | undefined;
84
+ }
85
+ /**
86
+ * One audience the design was sent to.
87
+ *
88
+ * A LIST is named by the name the send recorded, not by the name the list
89
+ * carries today: a renamed or deleted list would otherwise rewrite the
90
+ * history of a campaign that went out months ago, and a deleted one would
91
+ * erase it. The same reasoning as the campaign report's populations.
92
+ */
93
+ export interface TemplateAudience {
94
+ /** Stable key — the list id, or the audience kind for the built-ins. */
95
+ id: string;
96
+ label: string;
97
+ /** How many campaigns using this design went to this audience. */
98
+ campaigns: number;
99
+ /** Addresses those campaigns ADDRESSED, summed. */
100
+ addressed: number;
101
+ /**
102
+ * The named list has since been deleted or renamed out of reach.
103
+ *
104
+ * Only ever true for a `list` audience, and only when the send recorded no
105
+ * name — an older send, before the name was stored. The screen says "list
106
+ * no longer named" rather than printing a raw document id as if it were
107
+ * something a merchant would recognise.
108
+ */
109
+ unnamed?: boolean;
110
+ }
111
+ /** Why a number the design report would otherwise show is being withheld. */
112
+ export interface TemplateCaveat {
113
+ id: 'no-campaigns' | 'delivery-partial' | 'click-tracking-partial' | 'campaigns-truncated' | 'audience-truncated';
114
+ message: string;
115
+ }
116
+ /** Everything the design report screen renders. */
117
+ export interface TemplateReport {
118
+ /** Campaigns that used this design AND were sent. */
119
+ sentCampaigns: number;
120
+ /** Campaigns that used this design, sent or not. */
121
+ totalCampaigns: number;
122
+ /** Epoch ms of the most recent send, or null. */
123
+ lastSentAtMs: number | null;
124
+ recipients: number;
125
+ sent: number;
126
+ /** Summed over the campaigns that recorded it; null when none did. */
127
+ delivered: number | null;
128
+ opens: number;
129
+ clicks: number;
130
+ uniqueOpens: number | null;
131
+ uniqueClicks: number | null;
132
+ bounced: number;
133
+ complained: number;
134
+ unsubscribes: number;
135
+ /** Rates, each `null` when its denominator is zero or unrecorded. */
136
+ rates: {
137
+ delivery: TemplateRate | null;
138
+ open: TemplateRate | null;
139
+ click: TemplateRate | null;
140
+ clickToOpen: TemplateRate | null;
141
+ bounce: TemplateRate | null;
142
+ complaint: TemplateRate | null;
143
+ unsubscribe: TemplateRate | null;
144
+ };
145
+ audiences: TemplateAudience[];
146
+ caveats: TemplateCaveat[];
147
+ }
148
+ /**
149
+ * Aggregates every campaign that used one design.
150
+ *
151
+ * @param campaigns every campaign document naming this design, sent or not.
152
+ * @param truncated the query that produced `campaigns` stopped at its read
153
+ * ceiling, so every total here is a FLOOR. Reported as a caveat rather
154
+ * than hidden, on the same reasoning as `audienceSizeTruncated`: a
155
+ * figure that is at least this large is useful, and a figure presented
156
+ * as complete when it is not is worse than none.
157
+ */
158
+ export declare function templateReport(campaigns: readonly TemplateCampaign[], truncated?: boolean): TemplateReport;
@@ -0,0 +1,249 @@
1
+ import { _ as _extends } from "@swc/helpers/_/_extends";
2
+ /**
3
+ * @license
4
+ * Copyright 2026 Aglyn LLC
5
+ *
6
+ * Licensed under the Apache License, Version 2.0 (the "License");
7
+ * you may not use this file except in compliance with the License.
8
+ * You may obtain a copy of the License at
9
+ *
10
+ * http://www.apache.org/licenses/LICENSE-2.0
11
+ *
12
+ * Unless required by applicable law or agreed to in writing, software
13
+ * distributed under the License is distributed on an "AS IS" BASIS,
14
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ * See the License for the specific language governing permissions and
16
+ * limitations under the License.
17
+ */ /**
18
+ * ONE DESIGN, MEASURED ACROSS EVERY CAMPAIGN THAT USED IT.
19
+ *
20
+ * ## What this adds to `campaign-report.ts`
21
+ *
22
+ * A campaign report divides two numbers that were recorded by the same send.
23
+ * A design report divides two SUMS, and a sum has a membership: which
24
+ * campaigns went into it. That is the whole difficulty, and it is a new way
25
+ * for the repo's rule — every rate names its denominator — to be broken.
26
+ *
27
+ * ## The rule, restated for a sum
28
+ *
29
+ * **A rate's numerator and its denominator are summed over the SAME set of
30
+ * campaigns, and the screen is told how large that set is.**
31
+ *
32
+ * `delivered` is written only by the delivery webhook, so a design used by
33
+ * five campaigns may have three that recorded it and two that never did.
34
+ * Summing `uniqueOpens` over all five and dividing by `delivered` summed over
35
+ * three produces an open rate that can exceed 100% and is, in every case,
36
+ * the flattering substitution `campaign-report.ts` exists to refuse — carried
37
+ * out by addition instead of by picking the wrong field.
38
+ *
39
+ * So each rate here is built from a FILTERED subset, and
40
+ * {@link TemplateRate.denominatorLabel} names the subset as well as the
41
+ * quantity: `delivered across 3 of 5 campaigns`. A reader comparing this
42
+ * design's open rate with another's can see the two were taken over different
43
+ * populations without being told separately.
44
+ *
45
+ * ## Counts are over everything; rates are over what can be divided
46
+ *
47
+ * The COUNTS — opens, clicks, unsubscribes — are summed over every campaign,
48
+ * because a count is true whatever else was recorded. Only the rates narrow.
49
+ * The two are labelled differently on screen for that reason, and the caveats
50
+ * say how many campaigns each rate left out.
51
+ *
52
+ * ## Why this is a pure module
53
+ *
54
+ * Same reason as `campaign-report.ts`: a division written in JSX is a
55
+ * denominator chosen by whoever writes the next card. Here it is worse — the
56
+ * subset is invisible in the output unless something carries it — so the
57
+ * subset is data, computed once, and the screen renders it.
58
+ */ import { campaignRate } from "@aglyn/shared-ui-email-campaigns/model/campaign-report";
59
+ import { emailAudienceLabel } from "@aglyn/shared-ui-email-campaigns/model/email-record";
60
+ /** A campaign that actually went out. The only kind engagement can describe. */ function wasSent(campaign) {
61
+ return campaign.sentAtMs !== null;
62
+ }
63
+ /** Sums one stats field over a set of campaigns, defaulting absent to zero. */ function total(campaigns, field) {
64
+ return campaigns.reduce((running, campaign)=>{
65
+ var _ref;
66
+ var _campaign_stats;
67
+ return running + Number((_ref = (_campaign_stats = campaign.stats) == null ? void 0 : _campaign_stats[field]) != null ? _ref : 0);
68
+ }, 0);
69
+ }
70
+ /**
71
+ * `${quantity} across N of M campaigns` — the denominator label for a sum.
72
+ *
73
+ * The `of M` half is what makes a narrowed rate readable. `delivered across 3
74
+ * campaigns` is true and still invites the reader to assume the design has
75
+ * three; `across 3 of 5` says on its face that two are missing from this
76
+ * number and not from the counts above it.
77
+ */ function acrossLabel(quantity, covered, all) {
78
+ return covered === all ? `${quantity} across ${covered} ${covered === 1 ? 'campaign' : 'campaigns'}` : `${quantity} across ${covered} of ${all} campaigns`;
79
+ }
80
+ /**
81
+ * Aggregates every campaign that used one design.
82
+ *
83
+ * @param campaigns every campaign document naming this design, sent or not.
84
+ * @param truncated the query that produced `campaigns` stopped at its read
85
+ * ceiling, so every total here is a FLOOR. Reported as a caveat rather
86
+ * than hidden, on the same reasoning as `audienceSizeTruncated`: a
87
+ * figure that is at least this large is useful, and a figure presented
88
+ * as complete when it is not is worse than none.
89
+ */ export function templateReport(campaigns, truncated = false) {
90
+ const sentCampaigns = campaigns.filter(wasSent);
91
+ const all = sentCampaigns.length;
92
+ /*
93
+ * THE SUBSETS. Each rate divides sums taken over one of these and nothing
94
+ * else, which is what makes the numerator and denominator describe the same
95
+ * population — see this module's header.
96
+ */ const withDelivery = sentCampaigns.filter((campaign)=>{
97
+ var _campaign_stats;
98
+ return ((_campaign_stats = campaign.stats) == null ? void 0 : _campaign_stats.delivered) !== undefined;
99
+ });
100
+ const withUniqueOpens = withDelivery.filter((campaign)=>{
101
+ var _campaign_stats;
102
+ return ((_campaign_stats = campaign.stats) == null ? void 0 : _campaign_stats.uniqueOpens) !== undefined;
103
+ });
104
+ /*
105
+ * Click rates need BOTH a delivery denominator and the record that the send
106
+ * carried an HTML part. A send with no HTML part reports zero clicks
107
+ * whatever recipients did, so including it in a click rate's denominator
108
+ * drags the rate down by however many untrackable sends this design has —
109
+ * a measurement of our own sending code presented as a measurement of the
110
+ * audience. `campaign-report.ts` refuses the same substitution for one
111
+ * campaign; a sum must refuse it per campaign, not for the design as a
112
+ * whole, or one old send would withhold the design's whole click rate.
113
+ */ const withClickTracking = withDelivery.filter((campaign)=>{
114
+ var _campaign_stats, _campaign_stats1;
115
+ return ((_campaign_stats = campaign.stats) == null ? void 0 : _campaign_stats.clickTracked) === true && ((_campaign_stats1 = campaign.stats) == null ? void 0 : _campaign_stats1.uniqueClicks) !== undefined;
116
+ });
117
+ const withOpenersAndClicks = withClickTracking.filter((campaign)=>{
118
+ var _campaign_stats;
119
+ return ((_campaign_stats = campaign.stats) == null ? void 0 : _campaign_stats.uniqueOpens) !== undefined;
120
+ });
121
+ const sent = total(sentCampaigns, 'sent');
122
+ const delivered = withDelivery.length ? total(withDelivery, 'delivered') : null;
123
+ const uniqueOpens = withUniqueOpens.length ? total(withUniqueOpens, 'uniqueOpens') : null;
124
+ const uniqueClicks = withClickTracking.length ? total(withClickTracking, 'uniqueClicks') : null;
125
+ const rates = {
126
+ /*
127
+ * Over the campaigns that recorded a delivery, and `sent` summed over
128
+ * those SAME campaigns rather than over all of them. The alternative —
129
+ * delivered over the design's whole `sent` — reads as a delivery failure
130
+ * proportional to how many of this design's sends predate the webhook.
131
+ */ delivery: delivered === null ? null : campaignRate(delivered, total(withDelivery, 'sent'), acrossLabel('sent', withDelivery.length, all)),
132
+ open: campaignRate(uniqueOpens != null ? uniqueOpens : undefined, withUniqueOpens.length ? total(withUniqueOpens, 'delivered') : undefined, acrossLabel('delivered', withUniqueOpens.length, all)),
133
+ click: campaignRate(uniqueClicks != null ? uniqueClicks : undefined, withClickTracking.length ? total(withClickTracking, 'delivered') : undefined, acrossLabel('delivered', withClickTracking.length, all)),
134
+ clickToOpen: campaignRate(withOpenersAndClicks.length ? total(withOpenersAndClicks, 'uniqueClicks') : undefined, withOpenersAndClicks.length ? total(withOpenersAndClicks, 'uniqueOpens') : undefined, acrossLabel('unique openers', withOpenersAndClicks.length, all)),
135
+ /*
136
+ * Bounces and their rate are over every sent campaign, because both
137
+ * halves are recorded for all of them: `sent` by the send itself and
138
+ * `bounced` by a webhook whose absence is a genuine zero — no bounce
139
+ * event means nothing bounced, unlike `delivered`, whose absence means
140
+ * nothing was measured.
141
+ */ bounce: campaignRate(total(sentCampaigns, 'bounced'), sent, acrossLabel('sent', all, all)),
142
+ complaint: campaignRate(withDelivery.length ? total(withDelivery, 'complained') : undefined, delivered != null ? delivered : undefined, acrossLabel('delivered', withDelivery.length, all)),
143
+ unsubscribe: campaignRate(withDelivery.length ? total(withDelivery, 'unsubscribes') : undefined, delivered != null ? delivered : undefined, acrossLabel('delivered', withDelivery.length, all))
144
+ };
145
+ const caveats = [];
146
+ if (!all) {
147
+ caveats.push({
148
+ id: 'no-campaigns',
149
+ message: campaigns.length ? 'No campaign using this design has been sent yet, so there is ' + 'nothing to measure. The campaigns below are scheduled or were ' + 'canceled before they went out.' : 'This design has never been sent, so there is nothing to measure.'
150
+ });
151
+ } else if (withDelivery.length < all) {
152
+ caveats.push({
153
+ id: 'delivery-partial',
154
+ message: `${all - withDelivery.length} of ${all} campaigns using this design ` + 'recorded no delivery events, so they are left out of every rate ' + 'taken over delivered — open, click, complaint and unsubscribe. ' + 'Their counts are still included above.'
155
+ });
156
+ }
157
+ if (all && withClickTracking.length < withDelivery.length) {
158
+ caveats.push({
159
+ id: 'click-tracking-partial',
160
+ message: `${withDelivery.length - withClickTracking.length} of these campaigns ` + 'did not record carrying an HTML part. Click tracking rewrites links ' + 'in the HTML, so those sends report zero clicks whatever recipients ' + 'did, and they are left out of the click rates rather than counted ' + 'as sends nobody clicked.'
161
+ });
162
+ }
163
+ if (truncated) {
164
+ caveats.push({
165
+ id: 'campaigns-truncated',
166
+ message: 'This design has been used by more campaigns than one read returns, ' + 'so every total here is a floor — the real figures are at least ' + 'this large.'
167
+ });
168
+ }
169
+ if (sentCampaigns.some((campaign)=>{
170
+ var _campaign_stats;
171
+ return (_campaign_stats = campaign.stats) == null ? void 0 : _campaign_stats.audienceSizeTruncated;
172
+ })) {
173
+ caveats.push({
174
+ id: 'audience-truncated',
175
+ message: 'At least one of these sends stopped audience resolution at its read ' + 'ceiling, so the audience figures it contributed are floors.'
176
+ });
177
+ }
178
+ return {
179
+ sentCampaigns: all,
180
+ totalCampaigns: campaigns.length,
181
+ lastSentAtMs: sentCampaigns.reduce((latest, campaign)=>{
182
+ var _campaign_sentAtMs;
183
+ return latest === null || ((_campaign_sentAtMs = campaign.sentAtMs) != null ? _campaign_sentAtMs : 0) > latest ? campaign.sentAtMs : latest;
184
+ }, null),
185
+ recipients: total(sentCampaigns, 'recipients'),
186
+ sent,
187
+ delivered,
188
+ opens: total(sentCampaigns, 'opens'),
189
+ clicks: total(sentCampaigns, 'clicks'),
190
+ uniqueOpens,
191
+ uniqueClicks,
192
+ bounced: total(sentCampaigns, 'bounced'),
193
+ complained: total(sentCampaigns, 'complained'),
194
+ unsubscribes: total(sentCampaigns, 'unsubscribes'),
195
+ rates,
196
+ audiences: templateAudiences(sentCampaigns),
197
+ caveats
198
+ };
199
+ }
200
+ /**
201
+ * The audiences the design actually went to, largest first.
202
+ *
203
+ * Keyed on the LIST ID for a list send and on the audience kind otherwise, so
204
+ * two campaigns to the same list are one row and two campaigns to "all leads"
205
+ * are one row — but a list send and a segment send are never merged, because
206
+ * they are different questions about who received this design.
207
+ *
208
+ * A list send whose campaign recorded no list id at all is dropped rather
209
+ * than filed under a generic "List" heading: a row that cannot name which
210
+ * list is a row that answers the question wrongly.
211
+ */ function templateAudiences(campaigns) {
212
+ const rows = new Map();
213
+ for (const campaign of campaigns){
214
+ var _ref;
215
+ var _campaign_stats;
216
+ const isList = campaign.audience === 'list';
217
+ if (isList && !campaign.listId) continue;
218
+ const id = isList ? `list:${campaign.listId}` : campaign.audience;
219
+ const existing = rows.get(id);
220
+ const addressed = Number((_ref = (_campaign_stats = campaign.stats) == null ? void 0 : _campaign_stats.recipients) != null ? _ref : 0);
221
+ if (existing) {
222
+ existing.campaigns += 1;
223
+ existing.addressed += addressed;
224
+ // A later send that DID record the name fills one that did not, so a
225
+ // list mailed twice is named whenever any of those sends named it.
226
+ if (existing.unnamed && campaign.listName) {
227
+ existing.label = campaign.listName;
228
+ delete existing.unnamed;
229
+ }
230
+ continue;
231
+ }
232
+ rows.set(id, _extends({
233
+ id,
234
+ // Named once, in `email-record.ts`, so a list row on this table and
235
+ // the same list on a message's own page cannot disagree about what to
236
+ // call it.
237
+ label: emailAudienceLabel(campaign),
238
+ campaigns: 1,
239
+ addressed
240
+ }, isList && !campaign.listName ? {
241
+ unnamed: true
242
+ } : {}));
243
+ }
244
+ return [
245
+ ...rows.values()
246
+ ].sort((a, b)=>b.addressed - a.addressed || a.label.localeCompare(b.label));
247
+ }
248
+
249
+ //# sourceMappingURL=template-report.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../../../../../../libs/plugins/email/src/lib/model/template-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 * ONE DESIGN, MEASURED ACROSS EVERY CAMPAIGN THAT USED IT.\n *\n * ## What this adds to `campaign-report.ts`\n *\n * A campaign report divides two numbers that were recorded by the same send.\n * A design report divides two SUMS, and a sum has a membership: which\n * campaigns went into it. That is the whole difficulty, and it is a new way\n * for the repo's rule — every rate names its denominator — to be broken.\n *\n * ## The rule, restated for a sum\n *\n * **A rate's numerator and its denominator are summed over the SAME set of\n * campaigns, and the screen is told how large that set is.**\n *\n * `delivered` is written only by the delivery webhook, so a design used by\n * five campaigns may have three that recorded it and two that never did.\n * Summing `uniqueOpens` over all five and dividing by `delivered` summed over\n * three produces an open rate that can exceed 100% and is, in every case,\n * the flattering substitution `campaign-report.ts` exists to refuse — carried\n * out by addition instead of by picking the wrong field.\n *\n * So each rate here is built from a FILTERED subset, and\n * {@link TemplateRate.denominatorLabel} names the subset as well as the\n * quantity: `delivered across 3 of 5 campaigns`. A reader comparing this\n * design's open rate with another's can see the two were taken over different\n * populations without being told separately.\n *\n * ## Counts are over everything; rates are over what can be divided\n *\n * The COUNTS — opens, clicks, unsubscribes — are summed over every campaign,\n * because a count is true whatever else was recorded. Only the rates narrow.\n * The two are labelled differently on screen for that reason, and the caveats\n * say how many campaigns each rate left out.\n *\n * ## Why this is a pure module\n *\n * Same reason as `campaign-report.ts`: a division written in JSX is a\n * denominator chosen by whoever writes the next card. Here it is worse — the\n * subset is invisible in the output unless something carries it — so the\n * subset is data, computed once, and the screen renders it.\n */\n\nimport {\n campaignRate,\n type CampaignRate,\n type CampaignStats,\n} from '@aglyn/shared-ui-email-campaigns/model/campaign-report'\nimport {\n emailAudienceLabel,\n} from '@aglyn/shared-ui-email-campaigns/model/email-record'\n\n/** A rate over a sum, carrying how many campaigns the sum covers. */\nexport type TemplateRate = CampaignRate\n\n/**\n * One campaign that used the design, as the report reads it.\n *\n * `sentAtMs` is nullable because a campaign document can exist without ever\n * having been sent — a scheduled campaign holds `sendAtMs` and no `sentAt`.\n * Those carry no engagement and the reader is shown their status rather than\n * a row of zeroes.\n */\nexport interface TemplateCampaign {\n campaignId: string\n subject: string\n /** Epoch ms, or null for a campaign that has not been sent. */\n sentAtMs: number | null\n /** `'sent'`, `'scheduled'`, `'canceled'`. A persisted value; not relabeled. */\n status: string\n /** The audience KIND — `'leads'`, `'members'`, `'segment'`, `'list'`. */\n audience: string\n /** Set when `audience` is `'list'`. */\n listId?: string\n /** The list's name AS IT WAS at send time, when the send recorded one. */\n listName?: string\n stats: CampaignStats | undefined\n}\n\n/**\n * One audience the design was sent to.\n *\n * A LIST is named by the name the send recorded, not by the name the list\n * carries today: a renamed or deleted list would otherwise rewrite the\n * history of a campaign that went out months ago, and a deleted one would\n * erase it. The same reasoning as the campaign report's populations.\n */\nexport interface TemplateAudience {\n /** Stable key — the list id, or the audience kind for the built-ins. */\n id: string\n label: string\n /** How many campaigns using this design went to this audience. */\n campaigns: number\n /** Addresses those campaigns ADDRESSED, summed. */\n addressed: number\n /**\n * The named list has since been deleted or renamed out of reach.\n *\n * Only ever true for a `list` audience, and only when the send recorded no\n * name — an older send, before the name was stored. The screen says \"list\n * no longer named\" rather than printing a raw document id as if it were\n * something a merchant would recognise.\n */\n unnamed?: boolean\n}\n\n/** Why a number the design report would otherwise show is being withheld. */\nexport interface TemplateCaveat {\n id:\n | 'no-campaigns'\n | 'delivery-partial'\n | 'click-tracking-partial'\n | 'campaigns-truncated'\n | 'audience-truncated'\n message: string\n}\n\n/** Everything the design report screen renders. */\nexport interface TemplateReport {\n /** Campaigns that used this design AND were sent. */\n sentCampaigns: number\n /** Campaigns that used this design, sent or not. */\n totalCampaigns: number\n /** Epoch ms of the most recent send, or null. */\n lastSentAtMs: number | null\n\n /*========================================\n * COUNTS — over every sent campaign.\n *=======================================*/\n recipients: number\n sent: number\n /** Summed over the campaigns that recorded it; null when none did. */\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\n /** Rates, each `null` when its denominator is zero or unrecorded. */\n rates: {\n delivery: TemplateRate | null\n open: TemplateRate | null\n click: TemplateRate | null\n clickToOpen: TemplateRate | null\n bounce: TemplateRate | null\n complaint: TemplateRate | null\n unsubscribe: TemplateRate | null\n }\n\n audiences: TemplateAudience[]\n caveats: TemplateCaveat[]\n}\n\n/** A campaign that actually went out. The only kind engagement can describe. */\nfunction wasSent(campaign: TemplateCampaign): boolean {\n return campaign.sentAtMs !== null\n}\n\n/** Sums one stats field over a set of campaigns, defaulting absent to zero. */\nfunction total(\n campaigns: readonly TemplateCampaign[],\n field: keyof CampaignStats,\n): number {\n return campaigns.reduce(\n (running, campaign) => running + Number(campaign.stats?.[field] ?? 0),\n 0,\n )\n}\n\n/**\n * `${quantity} across N of M campaigns` — the denominator label for a sum.\n *\n * The `of M` half is what makes a narrowed rate readable. `delivered across 3\n * campaigns` is true and still invites the reader to assume the design has\n * three; `across 3 of 5` says on its face that two are missing from this\n * number and not from the counts above it.\n */\nfunction acrossLabel(quantity: string, covered: number, all: number): string {\n return covered === all\n ? `${quantity} across ${covered} ${covered === 1 ? 'campaign' : 'campaigns'}`\n : `${quantity} across ${covered} of ${all} campaigns`\n}\n\n/**\n * Aggregates every campaign that used one design.\n *\n * @param campaigns every campaign document naming this design, sent or not.\n * @param truncated the query that produced `campaigns` stopped at its read\n * ceiling, so every total here is a FLOOR. Reported as a caveat rather\n * than hidden, on the same reasoning as `audienceSizeTruncated`: a\n * figure that is at least this large is useful, and a figure presented\n * as complete when it is not is worse than none.\n */\nexport function templateReport(\n campaigns: readonly TemplateCampaign[],\n truncated = false,\n): TemplateReport {\n const sentCampaigns = campaigns.filter(wasSent)\n const all = sentCampaigns.length\n\n /*\n * THE SUBSETS. Each rate divides sums taken over one of these and nothing\n * else, which is what makes the numerator and denominator describe the same\n * population — see this module's header.\n */\n const withDelivery = sentCampaigns.filter(\n (campaign) => campaign.stats?.delivered !== undefined,\n )\n const withUniqueOpens = withDelivery.filter(\n (campaign) => campaign.stats?.uniqueOpens !== undefined,\n )\n /*\n * Click rates need BOTH a delivery denominator and the record that the send\n * carried an HTML part. A send with no HTML part reports zero clicks\n * whatever recipients did, so including it in a click rate's denominator\n * drags the rate down by however many untrackable sends this design has —\n * a measurement of our own sending code presented as a measurement of the\n * audience. `campaign-report.ts` refuses the same substitution for one\n * campaign; a sum must refuse it per campaign, not for the design as a\n * whole, or one old send would withhold the design's whole click rate.\n */\n const withClickTracking = withDelivery.filter(\n (campaign) =>\n campaign.stats?.clickTracked === true &&\n campaign.stats?.uniqueClicks !== undefined,\n )\n const withOpenersAndClicks = withClickTracking.filter(\n (campaign) => campaign.stats?.uniqueOpens !== undefined,\n )\n\n const sent = total(sentCampaigns, 'sent')\n const delivered = withDelivery.length\n ? total(withDelivery, 'delivered')\n : null\n const uniqueOpens = withUniqueOpens.length\n ? total(withUniqueOpens, 'uniqueOpens')\n : null\n const uniqueClicks = withClickTracking.length\n ? total(withClickTracking, 'uniqueClicks')\n : null\n\n const rates: TemplateReport['rates'] = {\n /*\n * Over the campaigns that recorded a delivery, and `sent` summed over\n * those SAME campaigns rather than over all of them. The alternative —\n * delivered over the design's whole `sent` — reads as a delivery failure\n * proportional to how many of this design's sends predate the webhook.\n */\n delivery: delivered === null\n ? null\n : campaignRate(\n delivered,\n total(withDelivery, 'sent'),\n acrossLabel('sent', withDelivery.length, all),\n ),\n open: campaignRate(\n uniqueOpens ?? undefined,\n withUniqueOpens.length ? total(withUniqueOpens, 'delivered') : undefined,\n acrossLabel('delivered', withUniqueOpens.length, all),\n ),\n click: campaignRate(\n uniqueClicks ?? undefined,\n withClickTracking.length\n ? total(withClickTracking, 'delivered')\n : undefined,\n acrossLabel('delivered', withClickTracking.length, all),\n ),\n clickToOpen: campaignRate(\n withOpenersAndClicks.length\n ? total(withOpenersAndClicks, 'uniqueClicks')\n : undefined,\n withOpenersAndClicks.length\n ? total(withOpenersAndClicks, 'uniqueOpens')\n : undefined,\n acrossLabel('unique openers', withOpenersAndClicks.length, all),\n ),\n /*\n * Bounces and their rate are over every sent campaign, because both\n * halves are recorded for all of them: `sent` by the send itself and\n * `bounced` by a webhook whose absence is a genuine zero — no bounce\n * event means nothing bounced, unlike `delivered`, whose absence means\n * nothing was measured.\n */\n bounce: campaignRate(\n total(sentCampaigns, 'bounced'),\n sent,\n acrossLabel('sent', all, all),\n ),\n complaint: campaignRate(\n withDelivery.length ? total(withDelivery, 'complained') : undefined,\n delivered ?? undefined,\n acrossLabel('delivered', withDelivery.length, all),\n ),\n unsubscribe: campaignRate(\n withDelivery.length ? total(withDelivery, 'unsubscribes') : undefined,\n delivered ?? undefined,\n acrossLabel('delivered', withDelivery.length, all),\n ),\n }\n\n const caveats: TemplateCaveat[] = []\n if (!all) {\n caveats.push({\n id: 'no-campaigns',\n message: campaigns.length\n ? 'No campaign using this design has been sent yet, so there is ' +\n 'nothing to measure. The campaigns below are scheduled or were ' +\n 'canceled before they went out.'\n : 'This design has never been sent, so there is nothing to measure.',\n })\n } else if (withDelivery.length < all) {\n caveats.push({\n id: 'delivery-partial',\n message:\n `${all - withDelivery.length} of ${all} campaigns using this design ` +\n 'recorded no delivery events, so they are left out of every rate ' +\n 'taken over delivered — open, click, complaint and unsubscribe. ' +\n 'Their counts are still included above.',\n })\n }\n if (all && withClickTracking.length < withDelivery.length) {\n caveats.push({\n id: 'click-tracking-partial',\n message:\n `${withDelivery.length - withClickTracking.length} of these campaigns ` +\n 'did not record carrying an HTML part. Click tracking rewrites links ' +\n 'in the HTML, so those sends report zero clicks whatever recipients ' +\n 'did, and they are left out of the click rates rather than counted ' +\n 'as sends nobody clicked.',\n })\n }\n if (truncated) {\n caveats.push({\n id: 'campaigns-truncated',\n message:\n 'This design has been used by more campaigns than one read returns, ' +\n 'so every total here is a floor — the real figures are at least ' +\n 'this large.',\n })\n }\n if (sentCampaigns.some((campaign) => campaign.stats?.audienceSizeTruncated)) {\n caveats.push({\n id: 'audience-truncated',\n message:\n 'At least one of these sends stopped audience resolution at its read ' +\n 'ceiling, so the audience figures it contributed are floors.',\n })\n }\n\n return {\n sentCampaigns: all,\n totalCampaigns: campaigns.length,\n lastSentAtMs: sentCampaigns.reduce<number | null>(\n (latest, campaign) =>\n latest === null || (campaign.sentAtMs ?? 0) > latest\n ? campaign.sentAtMs\n : latest,\n null,\n ),\n recipients: total(sentCampaigns, 'recipients'),\n sent,\n delivered,\n opens: total(sentCampaigns, 'opens'),\n clicks: total(sentCampaigns, 'clicks'),\n uniqueOpens,\n uniqueClicks,\n bounced: total(sentCampaigns, 'bounced'),\n complained: total(sentCampaigns, 'complained'),\n unsubscribes: total(sentCampaigns, 'unsubscribes'),\n rates,\n audiences: templateAudiences(sentCampaigns),\n caveats,\n }\n}\n\n/**\n * The audiences the design actually went to, largest first.\n *\n * Keyed on the LIST ID for a list send and on the audience kind otherwise, so\n * two campaigns to the same list are one row and two campaigns to \"all leads\"\n * are one row — but a list send and a segment send are never merged, because\n * they are different questions about who received this design.\n *\n * A list send whose campaign recorded no list id at all is dropped rather\n * than filed under a generic \"List\" heading: a row that cannot name which\n * list is a row that answers the question wrongly.\n */\nfunction templateAudiences(\n campaigns: readonly TemplateCampaign[],\n): TemplateAudience[] {\n const rows = new Map<string, TemplateAudience>()\n for (const campaign of campaigns) {\n const isList = campaign.audience === 'list'\n if (isList && !campaign.listId) continue\n const id = isList ? `list:${campaign.listId}` : campaign.audience\n const existing = rows.get(id)\n const addressed = Number(campaign.stats?.recipients ?? 0)\n if (existing) {\n existing.campaigns += 1\n existing.addressed += addressed\n // A later send that DID record the name fills one that did not, so a\n // list mailed twice is named whenever any of those sends named it.\n if (existing.unnamed && campaign.listName) {\n existing.label = campaign.listName\n delete existing.unnamed\n }\n continue\n }\n rows.set(id, {\n id,\n // Named once, in `email-record.ts`, so a list row on this table and\n // the same list on a message's own page cannot disagree about what to\n // call it.\n label: emailAudienceLabel(campaign),\n campaigns: 1,\n addressed,\n ...(isList && !campaign.listName ? { unnamed: true as const } : {}),\n })\n }\n return [...rows.values()].sort(\n (a, b) => b.addressed - a.addressed || a.label.localeCompare(b.label),\n )\n}\n"],"names":["campaignRate","emailAudienceLabel","wasSent","campaign","sentAtMs","total","campaigns","field","reduce","running","Number","stats","acrossLabel","quantity","covered","all","templateReport","truncated","sentCampaigns","filter","length","withDelivery","delivered","undefined","withUniqueOpens","uniqueOpens","withClickTracking","clickTracked","uniqueClicks","withOpenersAndClicks","sent","rates","delivery","open","click","clickToOpen","bounce","complaint","unsubscribe","caveats","push","id","message","some","audienceSizeTruncated","totalCampaigns","lastSentAtMs","latest","recipients","opens","clicks","bounced","complained","unsubscribes","audiences","templateAudiences","rows","Map","isList","audience","listId","existing","get","addressed","unnamed","listName","label","set","values","sort","a","b","localeCompare"],"mappings":";AAAA;;;;;;;;;;;;;;;CAeC,GAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyCC,GAED,SACEA,YAAY,QAGP,yDAAwD;AAC/D,SACEC,kBAAkB,QACb,sDAAqD;AA0G5D,8EAA8E,GAC9E,SAASC,QAAQC,QAA0B;IACzC,OAAOA,SAASC,QAAQ,KAAK;AAC/B;AAEA,6EAA6E,GAC7E,SAASC,MACPC,SAAsC,EACtCC,KAA0B;IAE1B,OAAOD,UAAUE,MAAM,CACrB,CAACC,SAASN;;YAA8BA;eAAjBM,UAAUC,gBAAOP,kBAAAA,SAASQ,KAAK,qBAAdR,eAAgB,CAACI,MAAM,mBAAI;OACnE;AAEJ;AAEA;;;;;;;CAOC,GACD,SAASK,YAAYC,QAAgB,EAAEC,OAAe,EAAEC,GAAW;IACjE,OAAOD,YAAYC,MACf,GAAGF,SAAS,QAAQ,EAAEC,QAAQ,CAAC,EAAEA,YAAY,IAAI,aAAa,aAAa,GAC3E,GAAGD,SAAS,QAAQ,EAAEC,QAAQ,IAAI,EAAEC,IAAI,UAAU,CAAC;AACzD;AAEA;;;;;;;;;CASC,GACD,OAAO,SAASC,eACdV,SAAsC,EACtCW,YAAY,KAAK;IAEjB,MAAMC,gBAAgBZ,UAAUa,MAAM,CAACjB;IACvC,MAAMa,MAAMG,cAAcE,MAAM;IAEhC;;;;GAIC,GACD,MAAMC,eAAeH,cAAcC,MAAM,CACvC,CAAChB;YAAaA;eAAAA,EAAAA,kBAAAA,SAASQ,KAAK,qBAAdR,gBAAgBmB,SAAS,MAAKC;;IAE9C,MAAMC,kBAAkBH,aAAaF,MAAM,CACzC,CAAChB;YAAaA;eAAAA,EAAAA,kBAAAA,SAASQ,KAAK,qBAAdR,gBAAgBsB,WAAW,MAAKF;;IAEhD;;;;;;;;;GASC,GACD,MAAMG,oBAAoBL,aAAaF,MAAM,CAC3C,CAAChB;YACCA,iBACAA;eADAA,EAAAA,kBAAAA,SAASQ,KAAK,qBAAdR,gBAAgBwB,YAAY,MAAK,QACjCxB,EAAAA,mBAAAA,SAASQ,KAAK,qBAAdR,iBAAgByB,YAAY,MAAKL;;IAErC,MAAMM,uBAAuBH,kBAAkBP,MAAM,CACnD,CAAChB;YAAaA;eAAAA,EAAAA,kBAAAA,SAASQ,KAAK,qBAAdR,gBAAgBsB,WAAW,MAAKF;;IAGhD,MAAMO,OAAOzB,MAAMa,eAAe;IAClC,MAAMI,YAAYD,aAAaD,MAAM,GACjCf,MAAMgB,cAAc,eACpB;IACJ,MAAMI,cAAcD,gBAAgBJ,MAAM,GACtCf,MAAMmB,iBAAiB,iBACvB;IACJ,MAAMI,eAAeF,kBAAkBN,MAAM,GACzCf,MAAMqB,mBAAmB,kBACzB;IAEJ,MAAMK,QAAiC;QACrC;;;;;KAKC,GACDC,UAAUV,cAAc,OACpB,OACAtB,aACEsB,WACAjB,MAAMgB,cAAc,SACpBT,YAAY,QAAQS,aAAaD,MAAM,EAAEL;QAE/CkB,MAAMjC,aACJyB,sBAAAA,cAAeF,WACfC,gBAAgBJ,MAAM,GAAGf,MAAMmB,iBAAiB,eAAeD,WAC/DX,YAAY,aAAaY,gBAAgBJ,MAAM,EAAEL;QAEnDmB,OAAOlC,aACL4B,uBAAAA,eAAgBL,WAChBG,kBAAkBN,MAAM,GACpBf,MAAMqB,mBAAmB,eACzBH,WACJX,YAAY,aAAac,kBAAkBN,MAAM,EAAEL;QAErDoB,aAAanC,aACX6B,qBAAqBT,MAAM,GACvBf,MAAMwB,sBAAsB,kBAC5BN,WACJM,qBAAqBT,MAAM,GACvBf,MAAMwB,sBAAsB,iBAC5BN,WACJX,YAAY,kBAAkBiB,qBAAqBT,MAAM,EAAEL;QAE7D;;;;;;KAMC,GACDqB,QAAQpC,aACNK,MAAMa,eAAe,YACrBY,MACAlB,YAAY,QAAQG,KAAKA;QAE3BsB,WAAWrC,aACTqB,aAAaD,MAAM,GAAGf,MAAMgB,cAAc,gBAAgBE,WAC1DD,oBAAAA,YAAaC,WACbX,YAAY,aAAaS,aAAaD,MAAM,EAAEL;QAEhDuB,aAAatC,aACXqB,aAAaD,MAAM,GAAGf,MAAMgB,cAAc,kBAAkBE,WAC5DD,oBAAAA,YAAaC,WACbX,YAAY,aAAaS,aAAaD,MAAM,EAAEL;IAElD;IAEA,MAAMwB,UAA4B,EAAE;IACpC,IAAI,CAACxB,KAAK;QACRwB,QAAQC,IAAI,CAAC;YACXC,IAAI;YACJC,SAASpC,UAAUc,MAAM,GACrB,kEACA,mEACA,mCACA;QACN;IACF,OAAO,IAAIC,aAAaD,MAAM,GAAGL,KAAK;QACpCwB,QAAQC,IAAI,CAAC;YACXC,IAAI;YACJC,SACE,GAAG3B,MAAMM,aAAaD,MAAM,CAAC,IAAI,EAAEL,IAAI,6BAA6B,CAAC,GACrE,qEACA,oEACA;QACJ;IACF;IACA,IAAIA,OAAOW,kBAAkBN,MAAM,GAAGC,aAAaD,MAAM,EAAE;QACzDmB,QAAQC,IAAI,CAAC;YACXC,IAAI;YACJC,SACE,GAAGrB,aAAaD,MAAM,GAAGM,kBAAkBN,MAAM,CAAC,oBAAoB,CAAC,GACvE,yEACA,wEACA,uEACA;QACJ;IACF;IACA,IAAIH,WAAW;QACbsB,QAAQC,IAAI,CAAC;YACXC,IAAI;YACJC,SACE,wEACA,oEACA;QACJ;IACF;IACA,IAAIxB,cAAcyB,IAAI,CAAC,CAACxC;YAAaA;gBAAAA,kBAAAA,SAASQ,KAAK,qBAAdR,gBAAgByC,qBAAqB;QAAG;QAC3EL,QAAQC,IAAI,CAAC;YACXC,IAAI;YACJC,SACE,yEACA;QACJ;IACF;IAEA,OAAO;QACLxB,eAAeH;QACf8B,gBAAgBvC,UAAUc,MAAM;QAChC0B,cAAc5B,cAAcV,MAAM,CAChC,CAACuC,QAAQ5C;gBACaA;mBAApB4C,WAAW,QAAQ,EAAC5C,qBAAAA,SAASC,QAAQ,YAAjBD,qBAAqB,KAAK4C,SAC1C5C,SAASC,QAAQ,GACjB2C;WACN;QAEFC,YAAY3C,MAAMa,eAAe;QACjCY;QACAR;QACA2B,OAAO5C,MAAMa,eAAe;QAC5BgC,QAAQ7C,MAAMa,eAAe;QAC7BO;QACAG;QACAuB,SAAS9C,MAAMa,eAAe;QAC9BkC,YAAY/C,MAAMa,eAAe;QACjCmC,cAAchD,MAAMa,eAAe;QACnCa;QACAuB,WAAWC,kBAAkBrC;QAC7BqB;IACF;AACF;AAEA;;;;;;;;;;;CAWC,GACD,SAASgB,kBACPjD,SAAsC;IAEtC,MAAMkD,OAAO,IAAIC;IACjB,KAAK,MAAMtD,YAAYG,UAAW;;YAKPH;QAJzB,MAAMuD,SAASvD,SAASwD,QAAQ,KAAK;QACrC,IAAID,UAAU,CAACvD,SAASyD,MAAM,EAAE;QAChC,MAAMnB,KAAKiB,SAAS,CAAC,KAAK,EAAEvD,SAASyD,MAAM,EAAE,GAAGzD,SAASwD,QAAQ;QACjE,MAAME,WAAWL,KAAKM,GAAG,CAACrB;QAC1B,MAAMsB,YAAYrD,gBAAOP,kBAAAA,SAASQ,KAAK,qBAAdR,gBAAgB6C,UAAU,mBAAI;QACvD,IAAIa,UAAU;YACZA,SAASvD,SAAS,IAAI;YACtBuD,SAASE,SAAS,IAAIA;YACtB,qEAAqE;YACrE,mEAAmE;YACnE,IAAIF,SAASG,OAAO,IAAI7D,SAAS8D,QAAQ,EAAE;gBACzCJ,SAASK,KAAK,GAAG/D,SAAS8D,QAAQ;gBAClC,OAAOJ,SAASG,OAAO;YACzB;YACA;QACF;QACAR,KAAKW,GAAG,CAAC1B,IAAI;YACXA;YACA,oEAAoE;YACpE,sEAAsE;YACtE,WAAW;YACXyB,OAAOjE,mBAAmBE;YAC1BG,WAAW;YACXyD;WACIL,UAAU,CAACvD,SAAS8D,QAAQ,GAAG;YAAED,SAAS;QAAc,IAAI,CAAC;IAErE;IACA,OAAO;WAAIR,KAAKY,MAAM;KAAG,CAACC,IAAI,CAC5B,CAACC,GAAGC,IAAMA,EAAER,SAAS,GAAGO,EAAEP,SAAS,IAAIO,EAAEJ,KAAK,CAACM,aAAa,CAACD,EAAEL,KAAK;AAExE"}
@@ -0,0 +1,27 @@
1
+ /**
2
+ * @license
3
+ * Copyright 2026 Aglyn LLC
4
+ *
5
+ * Licensed under the Apache License, Version 2.0 (the "License");
6
+ * you may not use this file except in compliance with the License.
7
+ * You may obtain a copy of the License at
8
+ *
9
+ * http://www.apache.org/licenses/LICENSE-2.0
10
+ *
11
+ * Unless required by applicable law or agreed to in writing, software
12
+ * distributed under the License is distributed on an "AS IS" BASIS,
13
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ * See the License for the specific language governing permissions and
15
+ * limitations under the License.
16
+ */
17
+ /**
18
+ * Console half (AGL-395): registers the Emails nav item + page in the
19
+ * ConsoleExtension registry. Safe to call at console app load — the page is
20
+ * lazy, so no besigner/canvas code loads. The shell renders the Emails nav
21
+ * item and, via its generic plugin route, the page (the messages and their
22
+ * composer, the templates, the audience lists, the topic catalog, the sending
23
+ * identities and the suppression list) — with no edit to the console's own
24
+ * nav or page files.
25
+ */
26
+ export declare function registerEmailConsole(): void;
27
+ export * from './site';
@@ -0,0 +1,163 @@
1
+ /**
2
+ * @license
3
+ * Copyright 2026 Aglyn LLC
4
+ *
5
+ * Licensed under the Apache License, Version 2.0 (the "License");
6
+ * you may not use this file except in compliance with the License.
7
+ * You may obtain a copy of the License at
8
+ *
9
+ * http://www.apache.org/licenses/LICENSE-2.0
10
+ *
11
+ * Unless required by applicable law or agreed to in writing, software
12
+ * distributed under the License is distributed on an "AS IS" BASIS,
13
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ * See the License for the specific language governing permissions and
15
+ * limitations under the License.
16
+ */ import * as Aglyn from "@aglyn/aglyn";
17
+ import { registerPluginZone } from "@aglyn/aglyn/plugin-manager/plugin-zones";
18
+ import { mdiEmailOutline } from "@aglyn/shared-data-mdi";
19
+ import { lazy } from "react";
20
+ import { EMAIL_MESSAGES_ZONE, EMAIL_TEMPLATE_RECIPIENTS_ZONE } from "./components/email-zones.js";
21
+ import { EMAILS_CONSOLE_SECTIONS } from "./components/emails-console-sections.js";
22
+ import { BUNDLE_ID } from "./constants/bundle-common.js";
23
+ /** Code-split: the Emails console page only loads when opened. */ const EmailsConsolePage = lazy(()=>import("./components/emails-console-page.js"));
24
+ /*
25
+ * What this plugin draws inside a campaign's own pages, each loaded only where
26
+ * the campaign owner's zone is on screen.
27
+ */ const CampaignTopicSelect = lazy(()=>import("./components/campaign-topic-select.js"));
28
+ const CampaignTopicOptionsWidget = lazy(()=>import("./components/campaign-topic-options-widget.js"));
29
+ const CampaignSenderEditorWidget = lazy(()=>import("./components/campaign-sender-editor-widget.js"));
30
+ const CampaignDesignCreateWidget = lazy(()=>import("./components/campaign-design-create-widget.js"));
31
+ const EmailDesignPreview = lazy(()=>import("./components/email-design-preview.js"));
32
+ /**
33
+ * Console half (AGL-395): registers the Emails nav item + page in the
34
+ * ConsoleExtension registry. Safe to call at console app load — the page is
35
+ * lazy, so no besigner/canvas code loads. The shell renders the Emails nav
36
+ * item and, via its generic plugin route, the page (the messages and their
37
+ * composer, the templates, the audience lists, the topic catalog, the sending
38
+ * identities and the suppression list) — with no edit to the console's own
39
+ * nav or page files.
40
+ */ export function registerEmailConsole() {
41
+ /*
42
+ * The two places this plugin's pages hand over to whichever plugin owns
43
+ * campaigns. A message is one send of a campaign and every action on it is
44
+ * that plugin's route, so the Messages section is a zone this page hosts
45
+ * rather than pages this plugin imports; the same holds for the recipients
46
+ * table under a template's report. Named, because a spec calls this
47
+ * registrar without the loader.
48
+ */ registerPluginZone({
49
+ zone: EMAIL_MESSAGES_ZONE,
50
+ label: 'The Emails page’s Messages section',
51
+ surface: 'console',
52
+ layout: 'bare',
53
+ description: 'The whole body of `/emails/messages` and the routes under it. A widget here is handed the site, the Emails page’s base path and the segments under `messages`, and draws the list, one message’s report or its composer.'
54
+ }, {
55
+ pluginId: BUNDLE_ID
56
+ });
57
+ registerPluginZone({
58
+ zone: EMAIL_TEMPLATE_RECIPIENTS_ZONE,
59
+ label: 'Who received a template’s emails',
60
+ surface: 'console',
61
+ description: 'On one template’s page, under its report. A widget here lists the recipients of every send built from that template; it is handed the site and the template’s screen id.'
62
+ }, {
63
+ pluginId: BUNDLE_ID
64
+ });
65
+ Aglyn.registerConsoleExtension({
66
+ pluginId: BUNDLE_ID,
67
+ displayName: 'Email',
68
+ /*
69
+ * WHO may open the email console, declared so the shell enforces it.
70
+ *
71
+ * The audiences section reads `orgs/{orgId}/lists/{listId}/members`, and
72
+ * those members are enrolled CONTACTS — an address, a name, and the
73
+ * consent basis recording why the person may be mailed. That is the same
74
+ * org-shared people data the CRM holds, reached from a different page.
75
+ *
76
+ * The rules gate those reads on `isOrgWideMember()` ALONE, with no role
77
+ * condition, so org-wide membership of any role is enough to list every
78
+ * audience the organization has and everybody on it. An org VIEWER — the
79
+ * role that exists to read and change nothing — therefore reads the whole
80
+ * marketing audience today. `data.manage` is what closes that: it
81
+ * defaults to owner, admin and editor, so the population it admits is
82
+ * exactly the one `server-list-gate.ts` accepts a list write from, and
83
+ * the viewer it excludes is the reader the rules never excluded.
84
+ *
85
+ * `data.manage` rather than a key of this plugin's own for the reason the
86
+ * catalog gives for refusing a `marketing.manage`: campaigns are written
87
+ * client-direct against rules that gate on the HOST role, so a new
88
+ * org-level key would name an action with no org-level boundary under it.
89
+ * `data.manage` is not in that position — it already governs the
90
+ * org-shared data this surface exposes, and the list gate already reads
91
+ * the roles it defaults to.
92
+ *
93
+ * A SITE COLLABORATOR holding it opens the page, and the answer is NOT
94
+ * the one Contacts reached. There the listener is scoped and the rules
95
+ * prove the same predicate per document; here the audiences read demands
96
+ * `isOrgWideMember()`, which a collaborator is not, so the org-shared
97
+ * half is already refused beneath the console and the half that remains —
98
+ * this site's own messages, templates and sending identities — is theirs.
99
+ * Refusing the surface outright would take that away to close nothing.
100
+ */ permission: 'data.manage',
101
+ /*
102
+ * The mail a campaign rides on is this plugin's — the topic catalog, the
103
+ * sending identities, the design document and its renderer — so each is
104
+ * drawn here, in a zone the campaign owner's composer and message page
105
+ * host. Every one reports through a callback; none writes a campaign.
106
+ */ widgets: [
107
+ {
108
+ slot: 'campaignTopicSelect',
109
+ widgetId: 'email-campaign-topic-select',
110
+ title: 'Topic',
111
+ Component: CampaignTopicSelect
112
+ },
113
+ {
114
+ slot: 'campaignTopicOptions',
115
+ widgetId: 'email-campaign-topic-options',
116
+ title: 'Topics',
117
+ Component: CampaignTopicOptionsWidget
118
+ },
119
+ {
120
+ slot: 'campaignSenderEditor',
121
+ widgetId: 'email-campaign-sender-editor',
122
+ title: 'Add a sender',
123
+ Component: CampaignSenderEditorWidget
124
+ },
125
+ {
126
+ slot: 'campaignDesignCreate',
127
+ widgetId: 'email-campaign-design-create',
128
+ title: 'Design this email',
129
+ Component: CampaignDesignCreateWidget
130
+ },
131
+ {
132
+ slot: 'campaignDesignPreview',
133
+ widgetId: 'email-campaign-design-preview',
134
+ title: 'Preview',
135
+ Component: EmailDesignPreview
136
+ }
137
+ ],
138
+ navItems: [
139
+ {
140
+ label: 'Emails',
141
+ href: '/emails',
142
+ icon: {
143
+ path: mdiEmailOutline.path
144
+ },
145
+ // Sections as ROUTES (AGL-2501): `/emails/messages` and friends are
146
+ // real URLs the shell resolves and gates, so the page mounts the one
147
+ // being read instead of subscribing all six.
148
+ sections: EMAILS_CONSOLE_SECTIONS,
149
+ header: {
150
+ title: 'Emails',
151
+ icon: {
152
+ path: mdiEmailOutline.path
153
+ },
154
+ docsTopic: 'emailCampaigns'
155
+ },
156
+ Component: EmailsConsolePage
157
+ }
158
+ ]
159
+ });
160
+ }
161
+ export * from "./site.js";
162
+
163
+ //# sourceMappingURL=plugin.js.map