@jam-overture/loom 0.1.0 → 0.2.0

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 (290) hide show
  1. package/README.md +3 -1
  2. package/dist/application/application.d.ts +109 -0
  3. package/dist/application/application.js +97 -0
  4. package/dist/application/memory.d.ts +20 -0
  5. package/dist/application/memory.js +79 -0
  6. package/dist/application/store.d.ts +101 -0
  7. package/dist/application/store.js +25 -0
  8. package/dist/audience/audience.d.ts +36 -0
  9. package/dist/audience/audience.js +41 -0
  10. package/dist/cli/templates.js +19 -0
  11. package/dist/data/plan.js +0 -0
  12. package/dist/data/resolution.d.ts +23 -1
  13. package/dist/data/resolve.d.ts +30 -3
  14. package/dist/data/resolve.js +11 -3
  15. package/dist/ids.d.ts +10 -0
  16. package/dist/ids.js +11 -1
  17. package/dist/index.d.ts +1 -0
  18. package/dist/index.js +1 -0
  19. package/dist/patch.d.ts +54 -0
  20. package/dist/patch.js +44 -0
  21. package/dist/project/closing.d.ts +51 -0
  22. package/dist/project/closing.js +53 -0
  23. package/dist/project/memory.d.ts +20 -0
  24. package/dist/project/memory.js +97 -0
  25. package/dist/project/project.d.ts +90 -0
  26. package/dist/project/project.js +91 -0
  27. package/dist/project/store.d.ts +135 -0
  28. package/dist/project/store.js +41 -0
  29. package/dist/registered.d.ts +64 -0
  30. package/dist/registered.js +118 -0
  31. package/dist/render/behaviour-adjust.d.ts +11 -19
  32. package/dist/render/behaviour-adjust.js +75 -21
  33. package/dist/render/behaviour-present.d.ts +8 -0
  34. package/dist/render/behaviour-present.js +57 -6
  35. package/dist/render/behaviour.d.ts +98 -17
  36. package/dist/render/behaviour.js +91 -26
  37. package/dist/render/control-name.d.ts +68 -0
  38. package/dist/render/control-name.js +37 -0
  39. package/dist/render/diagnostics.d.ts +72 -0
  40. package/dist/render/diagnostics.js +7 -0
  41. package/dist/render/index.d.ts +2 -0
  42. package/dist/render/index.js +2 -0
  43. package/dist/render/reads.d.ts +11 -0
  44. package/dist/render/reads.js +12 -1
  45. package/dist/render/render.js +102 -7
  46. package/dist/render/slots.d.ts +52 -0
  47. package/dist/render/slots.js +24 -0
  48. package/dist/render/theme.d.ts +54 -1
  49. package/dist/render/theme.js +23 -1
  50. package/dist/render/unshown.d.ts +152 -0
  51. package/dist/render/unshown.js +80 -0
  52. package/dist/runtime/analysis.d.ts +94 -9
  53. package/dist/runtime/analysis.js +54 -9
  54. package/dist/runtime/assessment.d.ts +36 -2
  55. package/dist/runtime/assessment.js +27 -2
  56. package/dist/runtime/checks.d.ts +148 -0
  57. package/dist/runtime/checks.js +112 -0
  58. package/dist/runtime/disposition.d.ts +96 -0
  59. package/dist/runtime/disposition.js +46 -0
  60. package/dist/runtime/gate.js +22 -0
  61. package/dist/runtime/index.d.ts +3 -0
  62. package/dist/runtime/index.js +3 -0
  63. package/dist/runtime/irreversibility.d.ts +64 -0
  64. package/dist/runtime/irreversibility.js +45 -0
  65. package/dist/runtime/pipeline.d.ts +43 -0
  66. package/dist/runtime/pipeline.js +10 -2
  67. package/dist/runtime/policy-change.d.ts +93 -0
  68. package/dist/runtime/policy-change.js +299 -0
  69. package/dist/runtime/policy-log.d.ts +406 -0
  70. package/dist/runtime/policy-log.js +285 -0
  71. package/dist/runtime/reversibility.d.ts +11 -9
  72. package/dist/runtime/stakes.d.ts +129 -1
  73. package/dist/runtime/stakes.js +240 -26
  74. package/dist/runtime/vocabulary.d.ts +164 -7
  75. package/dist/runtime/vocabulary.js +181 -8
  76. package/dist/sdk/audit.d.ts +174 -3
  77. package/dist/sdk/audit.js +176 -17
  78. package/dist/sdk/catalogue.d.ts +9 -1
  79. package/dist/sdk/conformance.d.ts +37 -3
  80. package/dist/sdk/conformance.js +25 -4
  81. package/dist/sdk/definition.d.ts +65 -0
  82. package/dist/sdk/definition.js +22 -0
  83. package/dist/sdk/registry.d.ts +29 -2
  84. package/dist/sdk/registry.js +63 -1
  85. package/dist/signals/action-change.d.ts +507 -0
  86. package/dist/signals/action-change.js +265 -0
  87. package/dist/signals/action.d.ts +331 -0
  88. package/dist/signals/action.js +182 -0
  89. package/dist/signals/applied-window.contract.d.ts +23 -0
  90. package/dist/signals/applied-window.contract.js +160 -0
  91. package/dist/signals/arriving.d.ts +210 -0
  92. package/dist/signals/arriving.js +133 -0
  93. package/dist/signals/audiences.d.ts +528 -0
  94. package/dist/signals/audiences.js +255 -0
  95. package/dist/signals/broadcast.d.ts +8 -2
  96. package/dist/signals/broadcast.js +58 -8
  97. package/dist/signals/change.d.ts +378 -0
  98. package/dist/signals/change.js +327 -0
  99. package/dist/signals/collect.d.ts +41 -0
  100. package/dist/signals/collect.js +88 -7
  101. package/dist/signals/copy-change.d.ts +553 -0
  102. package/dist/signals/copy-change.js +377 -0
  103. package/dist/signals/copy.d.ts +337 -0
  104. package/dist/signals/copy.js +211 -0
  105. package/dist/signals/counters.d.ts +46 -0
  106. package/dist/signals/counters.js +102 -0
  107. package/dist/signals/deliver.d.ts +23 -4
  108. package/dist/signals/deliver.js +34 -6
  109. package/dist/signals/deployment-change.d.ts +371 -0
  110. package/dist/signals/deployment-change.js +268 -0
  111. package/dist/signals/deployment.d.ts +265 -0
  112. package/dist/signals/deployment.js +152 -0
  113. package/dist/signals/door.d.ts +92 -0
  114. package/dist/signals/door.js +53 -0
  115. package/dist/signals/fold.d.ts +10 -0
  116. package/dist/signals/fold.js +5 -1
  117. package/dist/signals/form-action.d.ts +302 -0
  118. package/dist/signals/form-action.js +169 -0
  119. package/dist/signals/form-copy.d.ts +523 -0
  120. package/dist/signals/form-copy.js +346 -0
  121. package/dist/signals/forms.d.ts +247 -0
  122. package/dist/signals/forms.js +147 -0
  123. package/dist/signals/funnel-change.d.ts +548 -0
  124. package/dist/signals/funnel-change.js +361 -0
  125. package/dist/signals/funnel.d.ts +532 -0
  126. package/dist/signals/funnel.js +216 -0
  127. package/dist/signals/health.d.ts +497 -0
  128. package/dist/signals/health.js +361 -0
  129. package/dist/signals/index.d.ts +41 -0
  130. package/dist/signals/index.js +41 -0
  131. package/dist/signals/ingest.d.ts +56 -1
  132. package/dist/signals/ingest.js +91 -1
  133. package/dist/signals/journal.d.ts +11 -0
  134. package/dist/signals/kinds.d.ts +8 -6
  135. package/dist/signals/kinds.js +14 -6
  136. package/dist/signals/library-action.d.ts +430 -0
  137. package/dist/signals/library-action.js +336 -0
  138. package/dist/signals/library-change.d.ts +477 -0
  139. package/dist/signals/library-change.js +335 -0
  140. package/dist/signals/library-copy-change.d.ts +498 -0
  141. package/dist/signals/library-copy-change.js +476 -0
  142. package/dist/signals/library-pace.d.ts +319 -0
  143. package/dist/signals/library-pace.js +305 -0
  144. package/dist/signals/library-reach-change.d.ts +636 -0
  145. package/dist/signals/library-reach-change.js +534 -0
  146. package/dist/signals/library-reach.d.ts +377 -0
  147. package/dist/signals/library-reach.js +227 -0
  148. package/dist/signals/library-word-reach-change.d.ts +567 -0
  149. package/dist/signals/library-word-reach-change.js +568 -0
  150. package/dist/signals/library.d.ts +306 -0
  151. package/dist/signals/library.js +178 -0
  152. package/dist/signals/memory.d.ts +9 -0
  153. package/dist/signals/memory.js +105 -14
  154. package/dist/signals/migrate.d.ts +17 -2
  155. package/dist/signals/migrate.js +122 -5
  156. package/dist/signals/notice.d.ts +334 -0
  157. package/dist/signals/notice.js +228 -0
  158. package/dist/signals/pace-change.d.ts +501 -0
  159. package/dist/signals/pace-change.js +310 -0
  160. package/dist/signals/pace.d.ts +296 -0
  161. package/dist/signals/pace.js +291 -0
  162. package/dist/signals/page-views.d.ts +365 -0
  163. package/dist/signals/page-views.js +218 -0
  164. package/dist/signals/parts.d.ts +344 -0
  165. package/dist/signals/parts.js +273 -0
  166. package/dist/signals/postgres.d.ts +16 -2
  167. package/dist/signals/postgres.js +390 -87
  168. package/dist/signals/progress.d.ts +212 -0
  169. package/dist/signals/progress.js +150 -0
  170. package/dist/signals/ratios.d.ts +108 -0
  171. package/dist/signals/ratios.js +40 -0
  172. package/dist/signals/reach.d.ts +309 -0
  173. package/dist/signals/reach.js +93 -0
  174. package/dist/signals/readable.d.ts +34 -0
  175. package/dist/signals/readable.js +34 -0
  176. package/dist/signals/readership.d.ts +381 -0
  177. package/dist/signals/readership.js +308 -0
  178. package/dist/signals/region-pages.d.ts +173 -0
  179. package/dist/signals/region-pages.js +62 -0
  180. package/dist/signals/region.d.ts +287 -0
  181. package/dist/signals/region.js +198 -0
  182. package/dist/signals/retention.d.ts +141 -0
  183. package/dist/signals/retention.js +58 -0
  184. package/dist/signals/rollup.d.ts +67 -3
  185. package/dist/signals/rollup.js +0 -0
  186. package/dist/signals/schema.d.ts +432 -1
  187. package/dist/signals/schema.js +157 -3
  188. package/dist/signals/signal.d.ts +237 -11
  189. package/dist/signals/signal.js +70 -10
  190. package/dist/signals/silence-census.d.ts +205 -0
  191. package/dist/signals/silence-census.js +87 -0
  192. package/dist/signals/silences.d.ts +848 -0
  193. package/dist/signals/silences.js +753 -0
  194. package/dist/signals/tally.d.ts +140 -11
  195. package/dist/signals/window-figures.d.ts +148 -0
  196. package/dist/signals/window-figures.js +42 -0
  197. package/dist/signals/window.d.ts +866 -0
  198. package/dist/signals/window.js +693 -0
  199. package/dist/signals/words.d.ts +24 -0
  200. package/dist/signals/words.js +24 -0
  201. package/dist/store/index.d.ts +19 -0
  202. package/dist/store/index.js +19 -0
  203. package/dist/store/memory.d.ts +2 -1
  204. package/dist/store/memory.js +48 -12
  205. package/dist/store/migrate.d.ts +80 -0
  206. package/dist/store/migrate.js +259 -7
  207. package/dist/store/postgres-applications.d.ts +4 -0
  208. package/dist/store/postgres-applications.js +197 -0
  209. package/dist/store/postgres-holds.d.ts +10 -1
  210. package/dist/store/postgres-holds.js +116 -101
  211. package/dist/store/postgres-policy-log.d.ts +14 -0
  212. package/dist/store/postgres-policy-log.js +240 -0
  213. package/dist/store/postgres-projects.d.ts +4 -0
  214. package/dist/store/postgres-projects.js +217 -0
  215. package/dist/store/postgres.d.ts +16 -1
  216. package/dist/store/postgres.js +59 -9
  217. package/dist/store/replay.d.ts +102 -1
  218. package/dist/store/replay.js +190 -19
  219. package/dist/store/reseed.d.ts +238 -0
  220. package/dist/store/reseed.js +308 -0
  221. package/dist/store/schema.d.ts +450 -2
  222. package/dist/store/schema.js +141 -5
  223. package/dist/store/store.d.ts +29 -6
  224. package/dist/submit/resolve.js +2 -1
  225. package/dist/telemetry/calibration.d.ts +25 -0
  226. package/dist/telemetry/calibration.js +27 -1
  227. package/dist/telemetry/event.d.ts +391 -33
  228. package/dist/telemetry/event.js +84 -20
  229. package/dist/telemetry/index.d.ts +1 -0
  230. package/dist/telemetry/index.js +1 -0
  231. package/dist/telemetry/journal.d.ts +72 -3
  232. package/dist/telemetry/journal.js +9 -0
  233. package/dist/telemetry/lookup.d.ts +27 -0
  234. package/dist/telemetry/lookup.js +18 -0
  235. package/dist/telemetry/memory.js +23 -0
  236. package/dist/telemetry/migrate.js +22 -1
  237. package/dist/telemetry/postgres.d.ts +10 -1
  238. package/dist/telemetry/postgres.js +172 -90
  239. package/dist/telemetry/remeasure.d.ts +78 -0
  240. package/dist/telemetry/remeasure.js +83 -0
  241. package/dist/telemetry/retention.d.ts +2 -2
  242. package/dist/telemetry/schema.d.ts +17 -0
  243. package/dist/telemetry/schema.js +27 -1
  244. package/dist/telemetry/sink.d.ts +2 -2
  245. package/dist/testing/application-contract.d.ts +14 -0
  246. package/dist/testing/application-contract.js +270 -0
  247. package/dist/testing/contracts.d.ts +12 -7
  248. package/dist/testing/contracts.js +12 -7
  249. package/dist/testing/definitions.d.ts +78 -0
  250. package/dist/testing/definitions.js +134 -9
  251. package/dist/testing/doubles.d.ts +103 -0
  252. package/dist/testing/doubles.js +143 -0
  253. package/dist/testing/index.d.ts +2 -2
  254. package/dist/testing/index.js +2 -2
  255. package/dist/testing/journal-contract.js +140 -2
  256. package/dist/testing/model-contract.d.ts +110 -0
  257. package/dist/testing/model-contract.js +150 -0
  258. package/dist/testing/policy-log-contract.d.ts +26 -0
  259. package/dist/testing/policy-log-contract.js +344 -0
  260. package/dist/testing/project-contract.d.ts +14 -0
  261. package/dist/testing/project-contract.js +266 -0
  262. package/dist/testing/reader-signal-contract.d.ts +27 -2
  263. package/dist/testing/reader-signal-contract.js +475 -5
  264. package/dist/testing/store-contract.d.ts +7 -1
  265. package/dist/testing/store-contract.js +84 -3
  266. package/dist/theme/apply.d.ts +20 -1
  267. package/dist/theme/apply.js +5 -3
  268. package/dist/theme/derive.d.ts +22 -0
  269. package/dist/theme/derive.js +54 -1
  270. package/dist/theme/library.js +1 -1
  271. package/dist/theme/measure.d.ts +34 -0
  272. package/dist/theme/measure.js +30 -1
  273. package/dist/theme/palettes.js +7 -7
  274. package/dist/theme/ramp.d.ts +64 -0
  275. package/dist/theme/ramp.js +114 -0
  276. package/dist/theme/registry.d.ts +9 -0
  277. package/dist/theme/registry.js +11 -1
  278. package/dist/theme/separation.d.ts +97 -3
  279. package/dist/theme/separation.js +75 -0
  280. package/dist/tree/compare.d.ts +9 -0
  281. package/dist/tree/compare.js +18 -0
  282. package/dist/write/computed.d.ts +60 -0
  283. package/dist/write/computed.js +61 -0
  284. package/dist/write/held.d.ts +59 -0
  285. package/dist/write/index.d.ts +5 -2
  286. package/dist/write/index.js +5 -2
  287. package/dist/write/reseed.d.ts +151 -0
  288. package/dist/write/reseed.js +184 -0
  289. package/dist/write/revert.js +2 -16
  290. package/package.json +98 -19
@@ -0,0 +1,102 @@
1
+ /**
2
+ * What identifies a counter row, and the addition that folds two of them.
3
+ *
4
+ * Internal to the stores and deliberately not re-exported from
5
+ * `@jam-overture/loom/signals`: it exists so that the two implementations
6
+ * cannot drift on either half, not because a deployment has a question it
7
+ * answers.
8
+ *
9
+ * ## Why a fold in front of the driver
10
+ *
11
+ * `ON CONFLICT … DO UPDATE` **refuses to affect one row twice in a single
12
+ * command** — Postgres raises rather than applying the second value. The memory
13
+ * store writes through a `Map` and so adds a duplicate key without noticing. So
14
+ * two counts of the same row inside one call behaved differently in the two
15
+ * implementations: the memory store added them and Postgres refused the whole
16
+ * write. That is a disagreement between implementations rather than a limit of
17
+ * either, and what it would have cost depended entirely on which counter it
18
+ * reached — an `apply` that fails is loud and forgets nothing, a bucket at the
19
+ * door that silently did not move is reported in a delivery's outcome and
20
+ * nowhere else.
21
+ *
22
+ * The contract suite found it on the page views, which is the one counter a
23
+ * caller composes by hand rather than reads off a rollup's map. Every other
24
+ * producer in the repository keys its output by map first and so cannot emit a
25
+ * duplicate — which is a property of today's callers and not of the interface
26
+ * they are writing to. So the addition happens once, in front of the driver,
27
+ * for all four counters.
28
+ *
29
+ * **The keys are here rather than beside each store** because the guarantee is
30
+ * that the two stores agree about what one row is. Two spellings of a key that
31
+ * are the same today are the shape this subsystem has already been bitten by.
32
+ */
33
+ /** A revision, which is the two columns every counter here shares. */
34
+ const revisionKey = (row) => `${row.treeId} ${row.revision}`;
35
+ export const pageViewKey = (count) => revisionKey(count);
36
+ export const tallyKey = (tally) => `${revisionKey(tally)} ${tally.nodeId}`;
37
+ const endOf = (end) => `${end.nodeId}:${end.kind}`;
38
+ export const funnelKey = (answer) => `${revisionKey(answer)} ${endOf(answer.pair.from)} ${endOf(answer.pair.to)}`;
39
+ export const regionKey = (count) => `${revisionKey(count)} ${count.region}`;
40
+ /**
41
+ * The same counter, in one audience (0284).
42
+ *
43
+ * The four keys above identify a counter *within* one audience, which is all a
44
+ * fold in front of the driver needs: `apply` and `count` are handed one
45
+ * audience's rows per call, so two entries sharing a key in one call are the
46
+ * same row however many audiences the window held.
47
+ *
48
+ * A store that keeps its rows across calls needs more than that, and only the
49
+ * memory one does — Postgres has the audience in the primary key, so the
50
+ * database is already holding two audiences apart. This is the memory store's
51
+ * half of that same identity, and it is **here rather than beside it** for the
52
+ * reason the rest of this file is: two spellings of a key that agree today are
53
+ * the shape this subsystem has already been bitten by.
54
+ */
55
+ export const inAudience = (audience, key) => `${audience} ${key}`;
56
+ /**
57
+ * Rows that name the same counter, added together, in the order they arrived.
58
+ *
59
+ * Stable in two ways that matter: a row's first appearance fixes its position,
60
+ * so a fold never reorders a caller's list, and `add` is handed the standing row
61
+ * first — so a non-additive column written by `add` keeps the same winner as the
62
+ * `excluded.*` the upsert would have applied.
63
+ */
64
+ export const foldedBy = (rows, key, add) => {
65
+ const by = new Map();
66
+ for (const row of rows) {
67
+ const at = key(row);
68
+ const standing = by.get(at);
69
+ by.set(at, standing === undefined ? row : add(standing, row));
70
+ }
71
+ return [...by.values()];
72
+ };
73
+ /** The two numbers a page-view count carries, which is one. */
74
+ export const addPageViewCounts = (standing, next) => ({
75
+ ...next,
76
+ views: standing.views + next.views,
77
+ });
78
+ /**
79
+ * Every counter on a tally, added.
80
+ *
81
+ * `type` is the one column that is not a number, and the later row wins it —
82
+ * which is what `SET type = excluded.type` does and what the memory store's
83
+ * spread does, so the fold does not become a third answer.
84
+ */
85
+ export const addTallies = (standing, next) => ({
86
+ ...next,
87
+ views: standing.views + next.views,
88
+ reached: standing.reached + next.reached,
89
+ engaged: standing.engaged + next.engaged,
90
+ dwellMs: standing.dwellMs + next.dwellMs,
91
+ activations: standing.activations + next.activations,
92
+ opens: standing.opens + next.opens,
93
+ closes: standing.closes + next.closes,
94
+ completions: standing.completions + next.completions,
95
+ });
96
+ export const addFunnelAnswers = (standing, next) => ({
97
+ ...next,
98
+ reached: standing.reached + next.reached,
99
+ converted: standing.converted + next.converted,
100
+ });
101
+ export const addRegionCounts = (standing, next) => ({ ...next, views: standing.views + next.views });
102
+ //# sourceMappingURL=counters.js.map
@@ -25,16 +25,35 @@ import type { ReaderSignalBatch } from "./signal.js";
25
25
  * Where a delivery goes when the host has no opinion.
26
26
  *
27
27
  * A path rather than a URL, and relative, so it is same-origin by construction.
28
- * That is not only tidiness: `sendBeacon` cannot preflight, so a cross-origin
29
- * beacon carrying `application/json` is refused by the browser before it is
30
- * sent. A deployment that wants to collect signals on another origin has to
31
- * serve CORS from it and will find out here.
28
+ * A host whose pages are served from somewhere other than the deployment that
29
+ * counts them names that deployment's full address instead, and
30
+ * {@link BATCH_CONTENT_TYPE} is why that works without the deployment serving
31
+ * CORS.
32
32
  *
33
33
  * It is a default and not a constant the receiver shares. The endpoint's
34
34
  * address is a deployment's choice — a host may serve it anywhere, and this is
35
35
  * what the host who does not care gets.
36
36
  */
37
37
  export declare const DEFAULT_READER_SIGNAL_PATH = "/api/reader-signals";
38
+ /**
39
+ * What a batch is labelled as on the wire: **plain text, which happens to be
40
+ * JSON**.
41
+ *
42
+ * The label is the whole of what decides whether a delivery can leave a page
43
+ * for another origin. A browser sends a cross-origin `POST` without asking
44
+ * first only when its body is one of three CORS-safelisted types, and
45
+ * `text/plain` is the one of them a JSON document fits. Labelled
46
+ * `application/json` it is not safelisted: a `fetch` has to be preflighted by
47
+ * an `OPTIONS` request the deployment must answer, and a beacon, which cannot
48
+ * preflight at all, is refused by the browser before it is sent. The beacon
49
+ * carries the last batch of every page view, so a label that cost it would
50
+ * cost the batch that matters most, on every customer's site.
51
+ *
52
+ * Nothing receiving a batch reads the label. The door parses the body it is
53
+ * given and refuses what does not parse, so a batch is exactly as checked under
54
+ * this label as under the other one, and same-origin delivery is unchanged.
55
+ */
56
+ export declare const BATCH_CONTENT_TYPE = "text/plain;charset=UTF-8";
38
57
  /** `navigator.sendBeacon`, narrowed to what this uses. `false` means it would not take it. */
39
58
  export type SendBeacon = (url: string, body: Blob) => boolean;
40
59
  /** The fallback. Called only when a beacon was unavailable or refused the batch. */
@@ -24,16 +24,35 @@
24
24
  * Where a delivery goes when the host has no opinion.
25
25
  *
26
26
  * A path rather than a URL, and relative, so it is same-origin by construction.
27
- * That is not only tidiness: `sendBeacon` cannot preflight, so a cross-origin
28
- * beacon carrying `application/json` is refused by the browser before it is
29
- * sent. A deployment that wants to collect signals on another origin has to
30
- * serve CORS from it and will find out here.
27
+ * A host whose pages are served from somewhere other than the deployment that
28
+ * counts them names that deployment's full address instead, and
29
+ * {@link BATCH_CONTENT_TYPE} is why that works without the deployment serving
30
+ * CORS.
31
31
  *
32
32
  * It is a default and not a constant the receiver shares. The endpoint's
33
33
  * address is a deployment's choice — a host may serve it anywhere, and this is
34
34
  * what the host who does not care gets.
35
35
  */
36
36
  export const DEFAULT_READER_SIGNAL_PATH = "/api/reader-signals";
37
+ /**
38
+ * What a batch is labelled as on the wire: **plain text, which happens to be
39
+ * JSON**.
40
+ *
41
+ * The label is the whole of what decides whether a delivery can leave a page
42
+ * for another origin. A browser sends a cross-origin `POST` without asking
43
+ * first only when its body is one of three CORS-safelisted types, and
44
+ * `text/plain` is the one of them a JSON document fits. Labelled
45
+ * `application/json` it is not safelisted: a `fetch` has to be preflighted by
46
+ * an `OPTIONS` request the deployment must answer, and a beacon, which cannot
47
+ * preflight at all, is refused by the browser before it is sent. The beacon
48
+ * carries the last batch of every page view, so a label that cost it would
49
+ * cost the batch that matters most, on every customer's site.
50
+ *
51
+ * Nothing receiving a batch reads the label. The door parses the body it is
52
+ * given and refuses what does not parse, so a batch is exactly as checked under
53
+ * this label as under the other one, and same-origin delivery is unchanged.
54
+ */
55
+ export const BATCH_CONTENT_TYPE = "text/plain;charset=UTF-8";
37
56
  const browserBeacon = () => {
38
57
  const sender = globalThis.navigator;
39
58
  return typeof sender?.sendBeacon === "function" ? (url, body) => sender.sendBeacon(url, body) : null;
@@ -42,13 +61,22 @@ const browserBeacon = () => {
42
61
  * `keepalive` is what makes this survive the page it was sent from. Rejections
43
62
  * are swallowed here rather than left to the broadcaster's containment, so that
44
63
  * a host calling this directly gets the same promise the broadcaster does.
64
+ *
65
+ * **`no-cors`, because nothing here reads the answer.** Across origins a
66
+ * `cors` request still arrives — its label is safelisted, so nothing is
67
+ * preflighted — but a deployment that sends no CORS headers makes the browser
68
+ * reject the response, and every customer's console would carry an error per
69
+ * batch for a reply this function was going to ignore. `no-cors` asks for an
70
+ * opaque response, which is what ignoring one already was. It permits only
71
+ * safelisted headers, and {@link BATCH_CONTENT_TYPE} is the only one sent.
45
72
  */
46
73
  const fetchPost = (url, body) => {
47
74
  void globalThis
48
75
  .fetch(url, {
49
76
  method: "POST",
77
+ mode: "no-cors",
50
78
  keepalive: true,
51
- headers: { "content-type": "application/json" },
79
+ headers: { "content-type": BATCH_CONTENT_TYPE },
52
80
  body,
53
81
  })
54
82
  .catch(() => undefined);
@@ -73,7 +101,7 @@ export const deliverReaderSignals = (options = {}) => {
73
101
  const body = JSON.stringify(batch);
74
102
  try {
75
103
  const beacon = options.beacon === undefined ? browserBeacon() : options.beacon;
76
- if (beacon !== null && beacon(url, new Blob([body], { type: "application/json" })))
104
+ if (beacon !== null && beacon(url, new Blob([body], { type: BATCH_CONTENT_TYPE })))
77
105
  return;
78
106
  post(url, body);
79
107
  }
@@ -0,0 +1,371 @@
1
+ import type { AudienceId } from "../audience/audience.js";
2
+ import type { TreeId } from "../ids.js";
3
+ import type { ChangeSilence, ComparedStop, ReadingChange } from "./change.js";
4
+ import { type StoredPageViews } from "./page-views.js";
5
+ /**
6
+ * Which of a deployment's pages a change helped, and which it hurt.
7
+ *
8
+ * A deployment ships a change and then has forty pages and one question:
9
+ * *where did it land?* Every comparison in this subsystem answers that about
10
+ * **one** page — where its reading stops now, how much of it gets read now,
11
+ * whether its readers had time for it now — and a deployment-wide order existed
12
+ * only for one window at a time, so *which page is worst* could be asked and
13
+ * *which page got worse* could not.
14
+ *
15
+ * This is that order, taken off the comparisons a deployment already holds and
16
+ * nothing else: no payload, no browser change, no counter that does not exist,
17
+ * no column and no byte on any wire. Two windows of readings go in, already
18
+ * compared page by page, and the pages come back in the order somebody should
19
+ * look at them.
20
+ *
21
+ * ## A movement is comparable across two pages only once the door has scaled it
22
+ *
23
+ * A before-and-after reading compares *shares* and never counts, because the
24
+ * counts on either side of a change are two windows of two trees with two sets
25
+ * of readers and nothing divides out
26
+ * ([0224](../../decisions/0224-a-before-and-after-reading-compares-two-shares-and-a-pair-the-change-dissolved-is-an-answer.md)).
27
+ * The share movement it publishes is sound, and so is the figure it ranks one
28
+ * page's own stops by: the movement times the readers that reached the stop in
29
+ * the later window.
30
+ *
31
+ * **That figure is not comparable with another page's**, and the reason is the
32
+ * one an order over a single window already had to answer
33
+ * ([0250](../../decisions/0250-a-deployment-is-ordered-by-readers-lost-at-the-doors-scale-and-a-page-the-door-cannot-scale-is-out-of-the-order.md)):
34
+ * a distinct view count is generous by every page view that straddled a rollup
35
+ * window, and the straddle rate is each page's own. A page readers linger on
36
+ * for twenty minutes against a rollup window of five has every count against it
37
+ * inflated roughly fourfold; a page read in ninety seconds does not. The share
38
+ * movement has no straddle in it — both of its sides are ratios off their own
39
+ * rows — and then it is multiplied by a count that does, so the straddle walks
40
+ * straight back into the ranking key at the last step.
41
+ *
42
+ * So the key here is that figure put **on the scale the door counts in**:
43
+ * `readers ÷ (1 + inflation)`, where the inflation is the later window's own
44
+ * `drift ÷ opened` off that revision's own door row, picked out with the rule
45
+ * published beside the counter rather than written again
46
+ * ([0219](../../decisions/0219-a-page-view-is-counted-once-at-the-door-and-the-over-count-in-the-node-counters-is-a-measurement.md)).
47
+ * What comes out is not a count of people and is deliberately not rounded into
48
+ * one.
49
+ *
50
+ * **Only the later window's door is asked for, and that is not an omission.**
51
+ * The figure being scaled is the later window's own — a share movement at the
52
+ * volume the page has *now* — so the earlier window's row would be scaling a
53
+ * number it is not the denominator of. A caller holding both windows hands over
54
+ * the later one.
55
+ *
56
+ * ## A page has no net movement, so there are two orders and not one
57
+ *
58
+ * The obvious shape is one signed order: most readers lost at the top, most
59
+ * kept at the bottom. It would imply a thing that does not exist. **There is no
60
+ * page-level total of readers a change moved** — a reader who got past the
61
+ * second band and then the third is in both stops' figures, so adding them
62
+ * counts one reader twice, which is the trap written down for views
63
+ * ([0147](../../decisions/0147-a-rollup-is-added-to-what-is-stored-and-a-distinct-view-count-is-therefore-approximate.md))
64
+ * and for presses
65
+ * ([0167](../../decisions/0167-a-delegated-signal-names-the-regions-it-happened-inside.md))
66
+ * and refused again where it would look most like a headline. A page's harm and
67
+ * a page's help are two different stops, and a real change usually does both:
68
+ * the band it rewrote reads better and the one it pushed below the fold reads
69
+ * worse.
70
+ *
71
+ * So a page is ordered twice, by its own worst stop and by its own best one,
72
+ * and it stands in both orders when it earned both places. Nothing is added
73
+ * anywhere, and the two orders are the only artefact.
74
+ *
75
+ * ## A page the door cannot scale, and a page nothing moved
76
+ *
77
+ * The same refusal an order over one window makes, for the same reason: a page
78
+ * whose comparison is sound and whose door row is missing has no place in an
79
+ * order against pages that have one, and there is no safe direction to guess in.
80
+ * It is reported out of the orders with the standing saying why.
81
+ *
82
+ * **A page nothing moved is an answer and not a silence.** A comparison gates
83
+ * its own stops on whether the movement is worth at least one reader on the
84
+ * coarser side, which is what keeps a page three people read off the top of a
85
+ * screen; a page with no stop past that gate is `unmoved`, and the two windows'
86
+ * view floors travel with the row so a quiet window can be told from a steady
87
+ * page.
88
+ *
89
+ * Pure, linear in the comparisons times the rows, and reaches no store, clock
90
+ * or DOM.
91
+ */
92
+ /** A reason a page is in neither order. */
93
+ export type DeploymentChangeSilence =
94
+ /**
95
+ * One of the two windows reported no view of its revision, so there was
96
+ * nothing to compare.
97
+ *
98
+ * The comparison's own reason, carried through on the row rather than
99
+ * restated: a surface that wants to say which window was quiet reads the
100
+ * floors beside it.
101
+ *
102
+ * **It covers two comparison silences and the sentence above is true of only
103
+ * one of them.** `nothing-measured` is this; `different-audiences` is a pair
104
+ * of windows that both reported plenty and are of two populations (0301),
105
+ * and it arrives here with a door row and two view floors that all
106
+ * contradict the sentence. The cause is on {@link MovedPage.silence} and a
107
+ * surface printing one sentence should print that one. Giving the second a
108
+ * standing of its own is proposed, in a record of its own that is awaiting
109
+ * review, and is deliberately not taken here.
110
+ */
111
+ "unread"
112
+ /**
113
+ * The two readings are of two different pages, so the comparison is not a
114
+ * movement of anything.
115
+ *
116
+ * A caller's pairing fault and never a state of a deployment's readers. It is
117
+ * in the standings rather than dropped, because an order that silently shed a
118
+ * mispaired comparison would answer *your deployment has thirty-nine pages*.
119
+ */
120
+ | "mispaired"
121
+ /**
122
+ * There is no page-view row at the door for the later revision, so this
123
+ * page's movement cannot be put on the same scale as another's.
124
+ *
125
+ * Not a page that was not measured. Its comparison is as good as any other's
126
+ * and every share in it stands; what is missing is the one number that makes
127
+ * two pages' movements the same kind of figure.
128
+ */
129
+ | "unscaled"
130
+ /**
131
+ * The later window's door row is there and nothing in it says a page view
132
+ * ever began.
133
+ *
134
+ * Either nobody read the new revision, or the senders are not marking their
135
+ * openings — and the page-view reading publishes both numbers, so the
136
+ * diagnosis is a subtraction a surface can make.
137
+ */
138
+ | "unopened"
139
+ /**
140
+ * A stop reports more readers in the later window than the door has ever seen
141
+ * appear, which no rollup produces.
142
+ *
143
+ * A reading assembled by hand or by a sender that is not one. The share
144
+ * movements are published and the scaled figures are withheld, because they
145
+ * are the ones the disagreement makes absurd.
146
+ */
147
+ | "inconsistent"
148
+ /**
149
+ * One of the two windows holds two forms of the page and named neither, so
150
+ * that side was read as neither population.
151
+ *
152
+ * The comparison's own `audiences-mixed` (0301), named here rather than
153
+ * folded into `unread` for the reason that record exists: a refused reading
154
+ * publishes a view floor of nought, so *one of the two windows reported no
155
+ * view of its revision* was printed about a window holding every reader of
156
+ * both forms. A caller reads the cause off {@link MovedPage.silence} either
157
+ * way; the standing is what a screen groups by, and grouping a fault in the
158
+ * asking under a fact about readers is what sends a deployment to look for a
159
+ * broken sender.
160
+ *
161
+ * It is the one standing here a caller fixes by asking again:
162
+ * split both windows by audience (`byAudience`) and compare each form.
163
+ */
164
+ | "unsplit";
165
+ export declare const DEPLOYMENT_CHANGE_SILENCES: readonly DeploymentChangeSilence[];
166
+ /** Where one page stands in the two orders, or why it is in neither. */
167
+ export type MovementStanding =
168
+ /** In at least one of the orders, with a movement and a scale for it. */
169
+ "ranked"
170
+ /**
171
+ * Compared, scalable, and no stop moved by as much as one reader.
172
+ *
173
+ * The answer a change that landed on nothing gives, and the answer a window
174
+ * too thin to show a movement gives as well. The two view floors on the row
175
+ * are what tell them apart.
176
+ */
177
+ | "unmoved" | DeploymentChangeSilence;
178
+ export declare const MOVEMENT_STANDINGS: readonly MovementStanding[];
179
+ /** One line per standing, for a surface naming why a page is where it is. */
180
+ export declare const describeMovementStanding: (standing: MovementStanding) => string;
181
+ /** One page's sharpest movement in one direction. */
182
+ export type PageMovement = {
183
+ /**
184
+ * The pair of siblings it happened at, carried through from the comparison
185
+ * unchanged.
186
+ *
187
+ * Both of its sides are there, so a surface naming the band can also print
188
+ * what each window measured without a second lookup.
189
+ */
190
+ readonly at: ComparedStop;
191
+ /**
192
+ * How much of the page's readers moved, as a share, with the direction in the
193
+ * name rather than in the sign.
194
+ *
195
+ * The magnitude of the comparison's own share movement (0224), which is sound
196
+ * on its own: each side is a fall off its own rows, so each window's straddle
197
+ * divided out before the two met. Published even where the scaled figure is
198
+ * withheld.
199
+ */
200
+ readonly share: number;
201
+ /**
202
+ * The same movement as readers, at the later window's door scale, or `null`
203
+ * where this page has no scale.
204
+ *
205
+ * The key the orders are on. A magnitude and not a count of people: it is a
206
+ * share times a count of views, restated at the scale the door counts in, and
207
+ * it is deliberately not rounded. **Never added across pages or across the
208
+ * two orders** — one reader is in every stop they walked past.
209
+ */
210
+ readonly readers: number | null;
211
+ };
212
+ /** One page of a deployment, as a change left it. */
213
+ export type MovedPage = {
214
+ /** The page, which is the earlier reading's tree. */
215
+ readonly treeId: TreeId;
216
+ /** The two revisions compared, which may be the same one read in two windows. */
217
+ readonly revisions: {
218
+ readonly was: number;
219
+ readonly now: number;
220
+ };
221
+ /**
222
+ * The audience the later window was collected under, or `null` where the
223
+ * reading named none.
224
+ *
225
+ * Taken from the later side for the reason only the later window's rows are
226
+ * asked for: the figure being scaled is that window's own. Two forms of one
227
+ * page are two rows here, as they are in every other order this subsystem
228
+ * publishes (0290), and nothing is summed across them — a reader of one form
229
+ * is not a reader of the other.
230
+ */
231
+ readonly audienceId: AudienceId | null;
232
+ readonly standing: MovementStanding;
233
+ /**
234
+ * Each window's view floor, carried through from its own reading unchanged.
235
+ *
236
+ * Floors and not counts, which is why neither is the denominator of anything
237
+ * here. They are what tells a steady page from a window too quiet to have
238
+ * shown a movement.
239
+ */
240
+ readonly views: {
241
+ readonly was: number;
242
+ readonly now: number;
243
+ };
244
+ /**
245
+ * Page views counted at the later door, exact, or `null` where that revision
246
+ * has no row.
247
+ *
248
+ * The weight behind the row: *of the eleven hundred readers this revision
249
+ * had*, where the figures beside it are stated at this number's scale.
250
+ */
251
+ readonly opened: number | null;
252
+ /** The later window's own straddle rate, which is what scales the movements. */
253
+ readonly inflation: number | null;
254
+ /**
255
+ * The comparison's own reason for saying nothing, where it gave one.
256
+ *
257
+ * Carried rather than translated, because a standing says what this order
258
+ * does with the page and the comparison's silence says what the comparison
259
+ * found. A surface printing one sentence prints this one.
260
+ */
261
+ readonly silence: ChangeSilence | null;
262
+ /** The stop the change costs most readers at, where it worsened one. */
263
+ readonly worsened: PageMovement | null;
264
+ /** The stop it keeps most readers at, where it improved one. */
265
+ readonly improved: PageMovement | null;
266
+ };
267
+ /** A deployment's pages, as a change left them. */
268
+ export type DeploymentChange = {
269
+ /**
270
+ * Every page the change cost readers, worst first.
271
+ *
272
+ * Most readers lost at the door's scale, then the larger share, then by tree
273
+ * id and newest later revision first — so two pages the change cost the same
274
+ * do not reorder on a refresh.
275
+ */
276
+ readonly harmed: readonly MovedPage[];
277
+ /** Every page it kept readers on, best first, by the same rule. */
278
+ readonly helped: readonly MovedPage[];
279
+ /**
280
+ * Every page in neither order, by tree id and newest later revision first.
281
+ *
282
+ * A page in neither is not a page nothing is known about: `unmoved` is an
283
+ * answer, and the four silences each name something a surface can act on.
284
+ */
285
+ readonly unranked: readonly MovedPage[];
286
+ /** The head of the harm order, which is the page to look at first. `null` where nothing worsened. */
287
+ readonly worst: MovedPage | null;
288
+ /** The head of the help order. `null` where nothing improved. */
289
+ readonly best: MovedPage | null;
290
+ /**
291
+ * How many pages stand in each state, counting a page once however many
292
+ * orders it is in.
293
+ *
294
+ * A page the change both helped and hurt is one `ranked` page and not two,
295
+ * which is the one place these two orders could have been made to look like
296
+ * more pages than a deployment has.
297
+ */
298
+ readonly standings: Readonly<Record<MovementStanding, number>>;
299
+ /**
300
+ * Comparisons read, which is pages: one comparison stands per page.
301
+ *
302
+ * Not the comparisons handed in. The duplicated and the ambiguous are not in
303
+ * it, and the two numbers beside it say how many of each there were.
304
+ */
305
+ readonly compared: number;
306
+ /**
307
+ * Page views counted at the later door across the pages read, added once per
308
+ * revision.
309
+ *
310
+ * Exact and addable, for the reason no other figure here is: a page view
311
+ * began on one revision of one tree and was counted once. It is a weight
312
+ * rather than a deployment total — this sees the pages its caller compared,
313
+ * not the deployment's.
314
+ *
315
+ * Once per revision and not once per row, because two comparisons can name
316
+ * one later revision while being two rows: a mispaired comparison is filed
317
+ * under the earlier reading's page and scaled at the later one's door, so a
318
+ * caller that handed in both would otherwise have that revision's openings
319
+ * counted twice.
320
+ */
321
+ readonly arrivals: number;
322
+ /**
323
+ * Comparisons of a page beyond the first that compared the same two
324
+ * revisions, which were dropped.
325
+ *
326
+ * A caller that concatenated two reads holds one page's movement twice, and a
327
+ * page twice in an order is the one way an order can lie about how much there
328
+ * is to fix. The first stands and the rest are counted here.
329
+ */
330
+ readonly duplicated: number;
331
+ /**
332
+ * Door rows for the later revision beyond the first, which were ignored.
333
+ *
334
+ * A store keeps one row per revision, so this is a caller's two reads again —
335
+ * and adding them would double a page's arrivals and halve every movement
336
+ * scaled by them.
337
+ */
338
+ readonly duplicatedRows: number;
339
+ /**
340
+ * Pages one of whose **forms** was handed in with two different comparisons,
341
+ * of which neither was read.
342
+ *
343
+ * A tree live at two revisions is two live versions of one page, and both
344
+ * belong in an order over one window; a comparison pairs by form, so such a
345
+ * form has two movements and no single one that is its own. Picking either
346
+ * would publish a number nobody could account for, so the page is named here
347
+ * and that form is in no order, in no standing and in no total.
348
+ *
349
+ * **Two forms of one page are not this** (0290). A deployment serving two
350
+ * audiences hands in one comparison per form, which is two movements that
351
+ * are each somebody's; both are read and both stand. Before the audience was
352
+ * part of the pairing, that deployment's page landed here and lost both.
353
+ */
354
+ readonly ambiguous: readonly TreeId[];
355
+ };
356
+ /**
357
+ * What a change did across a deployment's pages, as two orders.
358
+ *
359
+ * Takes the comparisons rather than the counters, for the reason every derived
360
+ * reading in this subsystem does: the movements and the gates are what this is
361
+ * made of, and deriving them twice is how two screens come to disagree. A caller
362
+ * with two windows of counters reads each page's parts, then its progress, then
363
+ * its comparison, then this.
364
+ *
365
+ * The rows are the **later** window's page-view rows — the whole window a
366
+ * deployment holds, not one page's — because the figure being scaled is the
367
+ * later window's own. Each page's row is picked out by the published rule, so no
368
+ * caller writes the matching itself.
369
+ */
370
+ export declare const deploymentChangeOf: (changes: readonly ReadingChange[], rows: readonly StoredPageViews[]) => DeploymentChange;
371
+ //# sourceMappingURL=deployment-change.d.ts.map