@jam-overture/loom 0.1.0 → 0.3.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 (414) 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/audience/compose.d.ts +112 -0
  11. package/dist/audience/compose.js +134 -0
  12. package/dist/audience/memory.d.ts +14 -0
  13. package/dist/audience/memory.js +71 -0
  14. package/dist/audience/overlay-store.d.ts +343 -0
  15. package/dist/audience/overlay-store.js +217 -0
  16. package/dist/audience/rule.d.ts +121 -0
  17. package/dist/audience/rule.js +78 -0
  18. package/dist/cli/index.d.ts +3 -4
  19. package/dist/cli/index.js +3 -4
  20. package/dist/cli/templates.js +19 -0
  21. package/dist/data/adapter.d.ts +9 -1
  22. package/dist/data/adapter.js +2 -0
  23. package/dist/data/plan.js +0 -0
  24. package/dist/data/resolution.d.ts +23 -1
  25. package/dist/data/resolve.d.ts +31 -4
  26. package/dist/data/resolve.js +11 -3
  27. package/dist/ids.d.ts +10 -0
  28. package/dist/ids.js +11 -1
  29. package/dist/index.d.ts +1 -0
  30. package/dist/index.js +1 -0
  31. package/dist/interpretation/anthropic.d.ts +1 -1
  32. package/dist/interpretation/anthropic.js +2 -22
  33. package/dist/interpretation/client.d.ts +1 -1
  34. package/dist/interpretation/materialize.js +67 -22
  35. package/dist/interpretation/openai-compatible.d.ts +36 -0
  36. package/dist/interpretation/openai-compatible.js +79 -0
  37. package/dist/interpretation/status.d.ts +19 -0
  38. package/dist/interpretation/status.js +26 -0
  39. package/dist/live/index.d.ts +73 -0
  40. package/dist/live/index.js +73 -0
  41. package/dist/live/pages.d.ts +187 -0
  42. package/dist/live/pages.js +161 -0
  43. package/dist/live/pull.d.ts +147 -0
  44. package/dist/live/pull.js +398 -0
  45. package/dist/live/pulling.d.ts +79 -0
  46. package/dist/live/pulling.js +117 -0
  47. package/dist/live/window.d.ts +129 -0
  48. package/dist/live/window.js +132 -0
  49. package/dist/patch.d.ts +54 -0
  50. package/dist/patch.js +44 -0
  51. package/dist/project/closing.d.ts +51 -0
  52. package/dist/project/closing.js +53 -0
  53. package/dist/project/memory.d.ts +20 -0
  54. package/dist/project/memory.js +97 -0
  55. package/dist/project/project.d.ts +90 -0
  56. package/dist/project/project.js +91 -0
  57. package/dist/project/store.d.ts +135 -0
  58. package/dist/project/store.js +41 -0
  59. package/dist/registered.d.ts +64 -0
  60. package/dist/registered.js +118 -0
  61. package/dist/render/addressed.d.ts +35 -0
  62. package/dist/render/addressed.js +79 -0
  63. package/dist/render/behaviour-adjust.d.ts +11 -19
  64. package/dist/render/behaviour-adjust.js +75 -21
  65. package/dist/render/behaviour-present.d.ts +8 -0
  66. package/dist/render/behaviour-present.js +57 -6
  67. package/dist/render/behaviour.d.ts +98 -17
  68. package/dist/render/behaviour.js +91 -26
  69. package/dist/render/control-name.d.ts +68 -0
  70. package/dist/render/control-name.js +37 -0
  71. package/dist/render/diagnostics.d.ts +72 -0
  72. package/dist/render/diagnostics.js +7 -0
  73. package/dist/render/document-theme.d.ts +70 -0
  74. package/dist/render/document-theme.js +139 -0
  75. package/dist/render/editable.d.ts +15 -1
  76. package/dist/render/editable.js +13 -1
  77. package/dist/render/expected.d.ts +98 -0
  78. package/dist/render/expected.js +88 -0
  79. package/dist/render/index.d.ts +4 -0
  80. package/dist/render/index.js +4 -0
  81. package/dist/render/reads.d.ts +11 -0
  82. package/dist/render/reads.js +12 -1
  83. package/dist/render/render.d.ts +11 -0
  84. package/dist/render/render.js +294 -53
  85. package/dist/render/request.d.ts +8 -1
  86. package/dist/render/request.js +1 -0
  87. package/dist/render/slots.d.ts +52 -0
  88. package/dist/render/slots.js +24 -0
  89. package/dist/render/theme.d.ts +54 -1
  90. package/dist/render/theme.js +23 -1
  91. package/dist/render/unshown.d.ts +152 -0
  92. package/dist/render/unshown.js +80 -0
  93. package/dist/runtime/analysis.d.ts +94 -9
  94. package/dist/runtime/analysis.js +54 -9
  95. package/dist/runtime/assessment.d.ts +36 -2
  96. package/dist/runtime/assessment.js +27 -2
  97. package/dist/runtime/auto-apply-ceiling.d.ts +54 -0
  98. package/dist/runtime/auto-apply-ceiling.js +66 -0
  99. package/dist/runtime/checks.d.ts +148 -0
  100. package/dist/runtime/checks.js +112 -0
  101. package/dist/runtime/disposition.d.ts +96 -0
  102. package/dist/runtime/disposition.js +46 -0
  103. package/dist/runtime/gate.js +91 -10
  104. package/dist/runtime/index.d.ts +4 -0
  105. package/dist/runtime/index.js +4 -0
  106. package/dist/runtime/irreversibility.d.ts +64 -0
  107. package/dist/runtime/irreversibility.js +45 -0
  108. package/dist/runtime/nesting.d.ts +13 -1
  109. package/dist/runtime/nesting.js +41 -24
  110. package/dist/runtime/pipeline.d.ts +43 -0
  111. package/dist/runtime/pipeline.js +10 -2
  112. package/dist/runtime/policy-change.d.ts +93 -0
  113. package/dist/runtime/policy-change.js +305 -0
  114. package/dist/runtime/policy-log.d.ts +406 -0
  115. package/dist/runtime/policy-log.js +285 -0
  116. package/dist/runtime/policy.d.ts +8 -6
  117. package/dist/runtime/policy.js +5 -2
  118. package/dist/runtime/repointing.js +0 -0
  119. package/dist/runtime/reversibility.d.ts +11 -9
  120. package/dist/runtime/stakes.d.ts +129 -1
  121. package/dist/runtime/stakes.js +240 -26
  122. package/dist/runtime/vocabulary.d.ts +164 -7
  123. package/dist/runtime/vocabulary.js +181 -8
  124. package/dist/sdk/audit.d.ts +174 -3
  125. package/dist/sdk/audit.js +176 -17
  126. package/dist/sdk/catalogue.d.ts +9 -1
  127. package/dist/sdk/conformance.d.ts +37 -3
  128. package/dist/sdk/conformance.js +25 -4
  129. package/dist/sdk/definition.d.ts +129 -5
  130. package/dist/sdk/definition.js +66 -0
  131. package/dist/sdk/registry.d.ts +45 -2
  132. package/dist/sdk/registry.js +102 -1
  133. package/dist/signals/acted.contract.d.ts +21 -0
  134. package/dist/signals/acted.contract.js +236 -0
  135. package/dist/signals/acted.d.ts +359 -0
  136. package/dist/signals/acted.js +135 -0
  137. package/dist/signals/action-change.d.ts +507 -0
  138. package/dist/signals/action-change.js +265 -0
  139. package/dist/signals/action.d.ts +331 -0
  140. package/dist/signals/action.js +182 -0
  141. package/dist/signals/agenda.d.ts +585 -0
  142. package/dist/signals/agenda.js +295 -0
  143. package/dist/signals/applied-window.contract.d.ts +23 -0
  144. package/dist/signals/applied-window.contract.js +160 -0
  145. package/dist/signals/arrivals.contract.d.ts +21 -0
  146. package/dist/signals/arrivals.contract.js +180 -0
  147. package/dist/signals/arrivals.d.ts +375 -0
  148. package/dist/signals/arrivals.js +254 -0
  149. package/dist/signals/arriving.d.ts +210 -0
  150. package/dist/signals/arriving.js +133 -0
  151. package/dist/signals/audiences.d.ts +528 -0
  152. package/dist/signals/audiences.js +255 -0
  153. package/dist/signals/broadcast.d.ts +33 -17
  154. package/dist/signals/broadcast.js +255 -32
  155. package/dist/signals/change.d.ts +378 -0
  156. package/dist/signals/change.js +327 -0
  157. package/dist/signals/collect.d.ts +169 -34
  158. package/dist/signals/collect.js +186 -38
  159. package/dist/signals/conversion.d.ts +348 -0
  160. package/dist/signals/conversion.js +235 -0
  161. package/dist/signals/copy-change.d.ts +553 -0
  162. package/dist/signals/copy-change.js +377 -0
  163. package/dist/signals/copy.d.ts +337 -0
  164. package/dist/signals/copy.js +211 -0
  165. package/dist/signals/correlated.contract.d.ts +24 -0
  166. package/dist/signals/correlated.contract.js +94 -0
  167. package/dist/signals/counters.d.ts +97 -0
  168. package/dist/signals/counters.js +160 -0
  169. package/dist/signals/deliver.d.ts +23 -4
  170. package/dist/signals/deliver.js +34 -6
  171. package/dist/signals/deployment-change.d.ts +395 -0
  172. package/dist/signals/deployment-change.js +309 -0
  173. package/dist/signals/deployment.d.ts +278 -0
  174. package/dist/signals/deployment.js +178 -0
  175. package/dist/signals/door.d.ts +114 -0
  176. package/dist/signals/door.js +77 -0
  177. package/dist/signals/expire.d.ts +192 -0
  178. package/dist/signals/expire.js +213 -0
  179. package/dist/signals/fold.d.ts +10 -0
  180. package/dist/signals/fold.js +5 -1
  181. package/dist/signals/form-action.d.ts +302 -0
  182. package/dist/signals/form-action.js +169 -0
  183. package/dist/signals/form-copy.d.ts +523 -0
  184. package/dist/signals/form-copy.js +346 -0
  185. package/dist/signals/forms.d.ts +247 -0
  186. package/dist/signals/forms.js +147 -0
  187. package/dist/signals/frontier.d.ts +268 -0
  188. package/dist/signals/frontier.js +145 -0
  189. package/dist/signals/funnel-change.d.ts +548 -0
  190. package/dist/signals/funnel-change.js +361 -0
  191. package/dist/signals/funnel-hours.contract.d.ts +21 -0
  192. package/dist/signals/funnel-hours.contract.js +221 -0
  193. package/dist/signals/funnel-hours.d.ts +293 -0
  194. package/dist/signals/funnel-hours.js +99 -0
  195. package/dist/signals/funnel.d.ts +592 -0
  196. package/dist/signals/funnel.js +231 -0
  197. package/dist/signals/health.d.ts +694 -0
  198. package/dist/signals/health.js +573 -0
  199. package/dist/signals/index.d.ts +60 -0
  200. package/dist/signals/index.js +60 -0
  201. package/dist/signals/ingest.d.ts +56 -1
  202. package/dist/signals/ingest.js +91 -1
  203. package/dist/signals/inside.d.ts +190 -0
  204. package/dist/signals/inside.js +263 -0
  205. package/dist/signals/join.d.ts +56 -0
  206. package/dist/signals/join.js +60 -0
  207. package/dist/signals/journal.d.ts +123 -9
  208. package/dist/signals/kept.contract.d.ts +22 -0
  209. package/dist/signals/kept.contract.js +111 -0
  210. package/dist/signals/kinds.d.ts +8 -6
  211. package/dist/signals/kinds.js +14 -6
  212. package/dist/signals/library-action.d.ts +430 -0
  213. package/dist/signals/library-action.js +336 -0
  214. package/dist/signals/library-agenda-change.d.ts +324 -0
  215. package/dist/signals/library-agenda-change.js +199 -0
  216. package/dist/signals/library-agenda.d.ts +258 -0
  217. package/dist/signals/library-agenda.js +167 -0
  218. package/dist/signals/library-change.d.ts +477 -0
  219. package/dist/signals/library-change.js +335 -0
  220. package/dist/signals/library-copy-change.d.ts +498 -0
  221. package/dist/signals/library-copy-change.js +476 -0
  222. package/dist/signals/library-pace.d.ts +319 -0
  223. package/dist/signals/library-pace.js +305 -0
  224. package/dist/signals/library-reach-change.d.ts +646 -0
  225. package/dist/signals/library-reach-change.js +542 -0
  226. package/dist/signals/library-reach.d.ts +377 -0
  227. package/dist/signals/library-reach.js +227 -0
  228. package/dist/signals/library-senders-change.d.ts +457 -0
  229. package/dist/signals/library-senders-change.js +367 -0
  230. package/dist/signals/library-senders-reach-change.d.ts +486 -0
  231. package/dist/signals/library-senders-reach-change.js +538 -0
  232. package/dist/signals/library-senders-reach.d.ts +340 -0
  233. package/dist/signals/library-senders-reach.js +252 -0
  234. package/dist/signals/library-senders.d.ts +271 -0
  235. package/dist/signals/library-senders.js +180 -0
  236. package/dist/signals/library-word-reach-change.d.ts +567 -0
  237. package/dist/signals/library-word-reach-change.js +564 -0
  238. package/dist/signals/library.d.ts +306 -0
  239. package/dist/signals/library.js +178 -0
  240. package/dist/signals/memory.d.ts +9 -0
  241. package/dist/signals/memory.js +246 -14
  242. package/dist/signals/migrate.d.ts +20 -4
  243. package/dist/signals/migrate.js +269 -8
  244. package/dist/signals/notice.d.ts +389 -0
  245. package/dist/signals/notice.js +250 -0
  246. package/dist/signals/pace-change.d.ts +501 -0
  247. package/dist/signals/pace-change.js +310 -0
  248. package/dist/signals/pace.d.ts +296 -0
  249. package/dist/signals/pace.js +291 -0
  250. package/dist/signals/page-views.d.ts +365 -0
  251. package/dist/signals/page-views.js +218 -0
  252. package/dist/signals/part-pace.d.ts +378 -0
  253. package/dist/signals/part-pace.js +333 -0
  254. package/dist/signals/parts.d.ts +354 -0
  255. package/dist/signals/parts.js +232 -0
  256. package/dist/signals/postgres.d.ts +16 -2
  257. package/dist/signals/postgres.js +753 -76
  258. package/dist/signals/progress.d.ts +212 -0
  259. package/dist/signals/progress.js +150 -0
  260. package/dist/signals/ratios.d.ts +108 -0
  261. package/dist/signals/ratios.js +40 -0
  262. package/dist/signals/reach.d.ts +309 -0
  263. package/dist/signals/reach.js +93 -0
  264. package/dist/signals/readable.d.ts +34 -0
  265. package/dist/signals/readable.js +34 -0
  266. package/dist/signals/readership.d.ts +381 -0
  267. package/dist/signals/readership.js +308 -0
  268. package/dist/signals/region-pages.d.ts +173 -0
  269. package/dist/signals/region-pages.js +62 -0
  270. package/dist/signals/region.d.ts +287 -0
  271. package/dist/signals/region.js +198 -0
  272. package/dist/signals/retention.d.ts +163 -0
  273. package/dist/signals/retention.js +75 -0
  274. package/dist/signals/rhythm.d.ts +302 -0
  275. package/dist/signals/rhythm.js +262 -0
  276. package/dist/signals/rollup.d.ts +194 -4
  277. package/dist/signals/rollup.js +0 -0
  278. package/dist/signals/schema.d.ts +1069 -1
  279. package/dist/signals/schema.js +393 -3
  280. package/dist/signals/signal.d.ts +237 -11
  281. package/dist/signals/signal.js +70 -10
  282. package/dist/signals/silence-census.d.ts +205 -0
  283. package/dist/signals/silence-census.js +87 -0
  284. package/dist/signals/silences.d.ts +1147 -0
  285. package/dist/signals/silences.js +996 -0
  286. package/dist/signals/subtrees.d.ts +123 -0
  287. package/dist/signals/subtrees.js +102 -0
  288. package/dist/signals/tally.d.ts +262 -12
  289. package/dist/signals/unread.d.ts +292 -0
  290. package/dist/signals/unread.js +137 -0
  291. package/dist/signals/window-agenda.d.ts +276 -0
  292. package/dist/signals/window-agenda.js +83 -0
  293. package/dist/signals/window-figures.d.ts +148 -0
  294. package/dist/signals/window-figures.js +42 -0
  295. package/dist/signals/window-funnels.d.ts +88 -0
  296. package/dist/signals/window-funnels.js +47 -0
  297. package/dist/signals/window.d.ts +866 -0
  298. package/dist/signals/window.js +693 -0
  299. package/dist/signals/words.d.ts +24 -0
  300. package/dist/signals/words.js +24 -0
  301. package/dist/store/cache.d.ts +101 -0
  302. package/dist/store/cache.js +149 -0
  303. package/dist/store/history.d.ts +82 -0
  304. package/dist/store/history.js +36 -0
  305. package/dist/store/index.d.ts +30 -0
  306. package/dist/store/index.js +30 -0
  307. package/dist/store/memory.d.ts +2 -1
  308. package/dist/store/memory.js +48 -12
  309. package/dist/store/migrate.d.ts +106 -0
  310. package/dist/store/migrate.js +323 -7
  311. package/dist/store/postgres-applications.d.ts +4 -0
  312. package/dist/store/postgres-applications.js +197 -0
  313. package/dist/store/postgres-audience.d.ts +14 -0
  314. package/dist/store/postgres-audience.js +272 -0
  315. package/dist/store/postgres-holds.d.ts +10 -1
  316. package/dist/store/postgres-holds.js +116 -101
  317. package/dist/store/postgres-policy-log.d.ts +14 -0
  318. package/dist/store/postgres-policy-log.js +240 -0
  319. package/dist/store/postgres-projects.d.ts +4 -0
  320. package/dist/store/postgres-projects.js +217 -0
  321. package/dist/store/postgres.d.ts +17 -1
  322. package/dist/store/postgres.js +60 -9
  323. package/dist/store/replay.d.ts +102 -1
  324. package/dist/store/replay.js +190 -19
  325. package/dist/store/reseed.d.ts +238 -0
  326. package/dist/store/reseed.js +308 -0
  327. package/dist/store/schema.d.ts +762 -2
  328. package/dist/store/schema.js +218 -5
  329. package/dist/store/source.d.ts +57 -1
  330. package/dist/store/source.js +65 -1
  331. package/dist/store/store.d.ts +29 -6
  332. package/dist/submit/resolve.d.ts +1 -1
  333. package/dist/submit/resolve.js +2 -1
  334. package/dist/telemetry/calibration.d.ts +25 -0
  335. package/dist/telemetry/calibration.js +27 -1
  336. package/dist/telemetry/event.d.ts +391 -33
  337. package/dist/telemetry/event.js +84 -20
  338. package/dist/telemetry/index.d.ts +2 -0
  339. package/dist/telemetry/index.js +2 -0
  340. package/dist/telemetry/journal.d.ts +104 -3
  341. package/dist/telemetry/journal.js +9 -0
  342. package/dist/telemetry/lookup.d.ts +27 -0
  343. package/dist/telemetry/lookup.js +18 -0
  344. package/dist/telemetry/memory.js +33 -1
  345. package/dist/telemetry/migrate.js +22 -1
  346. package/dist/telemetry/postgres.d.ts +10 -1
  347. package/dist/telemetry/postgres.js +188 -90
  348. package/dist/telemetry/remeasure.d.ts +78 -0
  349. package/dist/telemetry/remeasure.js +83 -0
  350. package/dist/telemetry/retention.d.ts +2 -2
  351. package/dist/telemetry/schema.d.ts +17 -0
  352. package/dist/telemetry/schema.js +27 -1
  353. package/dist/telemetry/sink.d.ts +2 -2
  354. package/dist/telemetry/window.d.ts +135 -0
  355. package/dist/telemetry/window.js +101 -0
  356. package/dist/testing/application-contract.d.ts +14 -0
  357. package/dist/testing/application-contract.js +270 -0
  358. package/dist/testing/audience-overlay-contract.d.ts +31 -0
  359. package/dist/testing/audience-overlay-contract.js +354 -0
  360. package/dist/testing/contracts.d.ts +13 -7
  361. package/dist/testing/contracts.js +13 -7
  362. package/dist/testing/definitions.d.ts +78 -0
  363. package/dist/testing/definitions.js +134 -9
  364. package/dist/testing/doubles.d.ts +103 -0
  365. package/dist/testing/doubles.js +143 -0
  366. package/dist/testing/index.d.ts +2 -2
  367. package/dist/testing/index.js +2 -2
  368. package/dist/testing/journal-contract.js +297 -6
  369. package/dist/testing/model-contract.d.ts +110 -0
  370. package/dist/testing/model-contract.js +150 -0
  371. package/dist/testing/policy-log-contract.d.ts +26 -0
  372. package/dist/testing/policy-log-contract.js +344 -0
  373. package/dist/testing/project-contract.d.ts +14 -0
  374. package/dist/testing/project-contract.js +266 -0
  375. package/dist/testing/reader-signal-contract.d.ts +27 -2
  376. package/dist/testing/reader-signal-contract.js +475 -5
  377. package/dist/testing/store-contract.d.ts +7 -1
  378. package/dist/testing/store-contract.js +84 -3
  379. package/dist/theme/apply.d.ts +20 -1
  380. package/dist/theme/apply.js +5 -3
  381. package/dist/theme/contrast.d.ts +19 -14
  382. package/dist/theme/contrast.js +181 -17
  383. package/dist/theme/derive.d.ts +22 -0
  384. package/dist/theme/derive.js +54 -1
  385. package/dist/theme/library.js +1 -1
  386. package/dist/theme/measure.d.ts +34 -0
  387. package/dist/theme/measure.js +30 -1
  388. package/dist/theme/palettes.js +7 -7
  389. package/dist/theme/ramp.d.ts +64 -0
  390. package/dist/theme/ramp.js +114 -0
  391. package/dist/theme/registry.d.ts +9 -0
  392. package/dist/theme/registry.js +11 -1
  393. package/dist/theme/separation.d.ts +97 -3
  394. package/dist/theme/separation.js +75 -0
  395. package/dist/tree/apply.js +13 -0
  396. package/dist/tree/compare.d.ts +9 -0
  397. package/dist/tree/compare.js +18 -0
  398. package/dist/tree/mutation.d.ts +18 -0
  399. package/dist/tree/mutation.js +24 -12
  400. package/dist/tree/navigation.d.ts +5 -0
  401. package/dist/tree/navigation.js +32 -10
  402. package/dist/tree/outline.d.ts +7 -0
  403. package/dist/tree/outline.js +9 -5
  404. package/dist/write/computed.d.ts +60 -0
  405. package/dist/write/computed.js +61 -0
  406. package/dist/write/held.d.ts +59 -0
  407. package/dist/write/index.d.ts +5 -2
  408. package/dist/write/index.js +5 -2
  409. package/dist/write/reseed.d.ts +151 -0
  410. package/dist/write/reseed.js +184 -0
  411. package/dist/write/revert.js +2 -16
  412. package/package.json +25 -3
  413. package/dist/runtime/inverse-interpreter.d.ts +0 -90
  414. package/dist/runtime/inverse-interpreter.js +0 -56
@@ -1,5 +1,8 @@
1
1
  import type { NodeId, TreeId } from "../ids.js";
2
2
  import type { PrimitiveType } from "../primitive-type.js";
3
+ import type { ActedHourCount } from "./acted.js";
4
+ import type { FunnelHourCount } from "./funnel-hours.js";
5
+ import type { RevisionViews } from "./page-views.js";
3
6
  import type { ReaderSignalBatch, ReaderSignalKind } from "./signal.js";
4
7
  /**
5
8
  * Many views, folded into the durable artefact: per-node-per-revision counters,
@@ -25,9 +28,10 @@ import type { ReaderSignalBatch, ReaderSignalKind } from "./signal.js";
25
28
  * One node at one revision, as every view of it added up.
26
29
  *
27
30
  * The counters divide into two kinds and the distinction is the whole reason
28
- * this is not just `fold.ts` over more input. `dwellMs`, `activations`, `opens`
29
- * and `closes` are **occurrences** — they sum, and one enthusiastic reader can
30
- * be most of them. `views`, `reached` and `engaged` are **views** — they count
31
+ * this is not just `fold.ts` over more input. `dwellMs`, `activations`, `opens`,
32
+ * `closes` and `completions` are **occurrences** — they sum, and one
33
+ * enthusiastic reader can be most of them. `views`, `reached` and `engaged` are
34
+ * **views** — they count
31
35
  * distinct page views, so they are the ones a rate may be taken of, and they are
32
36
  * only available because a batch carries a view key.
33
37
  *
@@ -71,10 +75,40 @@ export type ReaderTally = {
71
75
  readonly activations: number;
72
76
  readonly opens: number;
73
77
  readonly closes: number;
78
+ /**
79
+ * Times a form inside this node was submitted and the browser let it go.
80
+ *
81
+ * The conversion counter, and the only one that is about a reader finishing
82
+ * rather than a reader looking. It is an occurrence rather than a view count
83
+ * for the same reason `activations` is: a reader who submits twice did two
84
+ * things, and *how many views converted* is a `FunnelPair` ending in
85
+ * `completed`, which is one row and already answerable.
86
+ *
87
+ * Filed against the node the form is — `loom.form` is addressed, so usually
88
+ * the form itself — never the band above it. The band's number is `engaged`,
89
+ * credited from the ancestry the signal carries (0167, 0211).
90
+ */
91
+ readonly completions: number;
74
92
  };
75
93
  /** One end of a funnel: a node, and what a reader has to have done to it. */
76
94
  export type FunnelEnd = {
77
95
  readonly nodeId: NodeId;
96
+ /**
97
+ * What a reader has to have done to the node, as one of the five kinds.
98
+ *
99
+ * Four of them are the kind itself: a view satisfies this end if it reported
100
+ * a signal of this kind about this node. `disclosed` is the one kind whose
101
+ * signal reports two different things a reader did — it opened the part, or
102
+ * it shut it — and **an end of that kind is the opening** (0424).
103
+ *
104
+ * A shutting is still counted everywhere else it is counted: it is a signal
105
+ * about the part, so the part's `views` holds the page view, and it is a
106
+ * reader using something inside a region, so the region's `engaged` holds it
107
+ * too. What it is not is the thing a question about a disclosure asks about.
108
+ * *Of the views that reached the pricing band, how many opened the terms* is
109
+ * a question; *how many shut the terms they never opened* is not one anybody
110
+ * asks, and it was the difference between the two answers.
111
+ */
78
112
  readonly kind: ReaderSignalKind;
79
113
  };
80
114
  /**
@@ -94,6 +128,22 @@ export type FunnelEnd = {
94
128
  export type FunnelPair = {
95
129
  readonly from: FunnelEnd;
96
130
  readonly to: FunnelEnd;
131
+ /**
132
+ * The pages it is asked on, or absent for every page the window holds.
133
+ *
134
+ * A counter row is already per tree and revision, so this changes nothing
135
+ * about what an answer means — it decides which answers are written at all.
136
+ * Absent is the shape every pair had before a scope existed, and still the
137
+ * right one for a deployment asking about a part wherever it stands: a page
138
+ * where neither end was reported answers nought of nought, which is true.
139
+ *
140
+ * **A page named here that the pair's parts are not on is not a fault.** It
141
+ * answers nought because nothing did either end there, which is the same
142
+ * answer a page nobody opened gives. What the scope buys is the converse — a
143
+ * deployment that asked about two pages does not get a row per page in the
144
+ * window, each saying nought about a question nobody asked there.
145
+ */
146
+ readonly pages?: readonly TreeId[];
97
147
  };
98
148
  export type FunnelAnswer = {
99
149
  readonly treeId: TreeId;
@@ -107,8 +157,36 @@ export type FunnelAnswer = {
107
157
  export type Rollup = {
108
158
  readonly tallies: readonly ReaderTally[];
109
159
  readonly funnels: readonly FunnelAnswer[];
160
+ /**
161
+ * The same answers, cut into the hours the views in each of them entered the
162
+ * funnel (`funnel-hours.ts`).
163
+ *
164
+ * **A partition of each answer's reach rather than a second measurement.**
165
+ * Every view that satisfied a pair's first end is filed under exactly one
166
+ * hour — the earliest hour this window saw it do so — so these rows sum to
167
+ * the answers above, per pair, per revision, for every window folded since
168
+ * the table existed. `rollup.test.ts` asserts the sum.
169
+ *
170
+ * Short by the views only undated batches reported, which is the same
171
+ * shortfall {@link Rollup.undated} reports for the hourly part counter, and
172
+ * empty for every caller that composes batches by hand.
173
+ */
174
+ readonly funnelHours: readonly FunnelHourCount[];
110
175
  /** Distinct page views seen, across every tree and revision in the input. */
111
176
  readonly views: number;
177
+ /**
178
+ * The same page views, per tree and revision — one appearance each, in this
179
+ * window.
180
+ *
181
+ * Held apart from `views` because it is the number the durable page-view
182
+ * counter keeps, and it is only worth keeping beside the exact count of page
183
+ * views that *began*: the difference between the two is the straddle that
184
+ * makes a distinct count added across windows generous, measured rather than
185
+ * bounded (0147). A revision whose batches carried no view key is absent
186
+ * rather than nought — there is nothing to compare, and a zero row would read
187
+ * as *no readers* rather than as *nobody minted a key*.
188
+ */
189
+ readonly appearances: readonly RevisionViews[];
112
190
  /**
113
191
  * Batches that carried no view key.
114
192
  *
@@ -120,12 +198,100 @@ export type Rollup = {
120
198
  * totals, instead of showing a rate that is quietly wrong.
121
199
  */
122
200
  readonly uncorrelated: number;
201
+ /**
202
+ * Batches this fold refused as a repeat of one it had already folded.
203
+ *
204
+ * A sender may deliver the same batch twice — a host's retry queue draining
205
+ * after an outage is the case `MAX_BATCHES_PER_DELIVERY` exists to allow, and
206
+ * an edge network replaying a `POST` is the case nobody writes. What that
207
+ * costs is **asymmetric and therefore invisible**: `views`, `reached`,
208
+ * `engaged` and `appearances` are sets of view keys, so a repeat adds the key
209
+ * it already holds and moves nothing, while `dwellMs`, `activations`, `opens`,
210
+ * `closes` and `completions` are occurrences and double. Every rate this
211
+ * subsystem publishes divides the second kind by the first, so a repeat does
212
+ * not look like noise — it looks like a reader who was twice as interested,
213
+ * and the cost of it is permanent (0158).
214
+ *
215
+ * So a batch identical to one already folded in this window is folded once and
216
+ * counted here. **Only where it carries a view key**: without one, two
217
+ * identical batches are as likely to be two readers in the same millisecond as
218
+ * one batch arriving twice, and dropping a reader to avoid a repeat is the
219
+ * worse of the two mistakes.
220
+ *
221
+ * Reported rather than silent, because the number is a fact about a
222
+ * deployment's senders and not about its readers: a window with repeats in it
223
+ * every run is a retry loop somebody should find.
224
+ */
225
+ readonly redelivered: number;
226
+ /**
227
+ * The same occurrences as the tallies' three delegated kinds, filed under the
228
+ * hour the door received them in (`acted.ts`).
229
+ *
230
+ * **A slice of the tallies rather than a second measurement**, and it comes
231
+ * out of this one pass for that reason: the repeat refusal above is a
232
+ * judgement made once per batch, and a second walk grouping by hour would
233
+ * make it twice against a different grouping — so an hour's rows would stop
234
+ * summing to the tally they slice, permanently and invisibly (0158).
235
+ * `rollup.test.ts` asserts the sum.
236
+ *
237
+ * Empty where no batch carried a receive instant, which is every caller that
238
+ * composes batches by hand; {@link Rollup.undated} says how many.
239
+ */
240
+ readonly acted: readonly ActedHourCount[];
241
+ /**
242
+ * Batches that carried no instant the door received them at, so their
243
+ * occurrences are in the tallies and in no hour.
244
+ *
245
+ * The same shape of report as {@link Rollup.uncorrelated} and for the same
246
+ * reason: one counter cannot be written honestly and the number is a fact
247
+ * about the input rather than about readers. A window read from either
248
+ * journal always carries one — both stamp it on the way in — so this is
249
+ * non-nought only for batches somebody composed, and a run that reports some
250
+ * is a run whose hourly rows are short by that many batches' worth.
251
+ */
252
+ readonly undated: number;
123
253
  };
124
254
  export declare const EMPTY_ROLLUP: Rollup;
255
+ /**
256
+ * One question, and the pages it is asked on: `null` for every page the window
257
+ * holds.
258
+ *
259
+ * The `pair` here carries the two ends and **never** a scope, because a scope
260
+ * is not part of what a counter row means: `funnelKey` is the revision and the
261
+ * two ends, so the row a scoped question writes and the row an unscoped one
262
+ * writes are the same row.
263
+ */
264
+ export type FunnelQuestion = {
265
+ readonly pair: FunnelPair;
266
+ readonly pages: ReadonlySet<TreeId> | null;
267
+ };
268
+ /**
269
+ * The questions a list of pairs asks, one per pair of ends, with the scopes of
270
+ * the pairs that ask the same question unioned.
271
+ *
272
+ * **This is the defence against a double count, and it is not hypothetical.**
273
+ * A counter row is keyed by the revision and the two ends and applying is
274
+ * additive (0147), so two pairs with the same ends in one `pairs` list write
275
+ * two answers to one row and the store adds them: every figure in that funnel
276
+ * doubled, permanently, with nothing to say it happened (0158). It took a
277
+ * caller deriving its pairs from a list rather than typing them — a project
278
+ * whose goals name the same part and kind twice is enough — for that to stop
279
+ * being a thing nobody would write by hand.
280
+ *
281
+ * **An unscoped pair absorbs a scoped one**, because the two together say *ask
282
+ * this everywhere* and *ask this on page A*, and everywhere includes page A.
283
+ * The alternative — the narrower scope winning — would silently drop pages a
284
+ * deployment did ask about.
285
+ */
286
+ export declare const funnelQuestionsOf: (pairs: readonly FunnelPair[]) => readonly FunnelQuestion[];
125
287
  export type RollupOptions = {
126
288
  /**
127
289
  * The funnels this deployment asked for. Absent means none: a pair is a
128
290
  * question somebody wrote down, and a rollup does not invent questions.
291
+ *
292
+ * Two pairs asking the same question are one question here, however they
293
+ * were scoped — see {@link funnelQuestionsOf}, which is what makes a derived
294
+ * list of pairs safe to hand in.
129
295
  */
130
296
  readonly pairs?: readonly FunnelPair[];
131
297
  };
@@ -137,6 +303,30 @@ export type RollupOptions = {
137
303
  * section" means nothing once a proposal has moved it, and adding two revisions
138
304
  * of a node together is exactly the mistake that makes *before versus after a
139
305
  * change* unreadable.
306
+ *
307
+ * **A batch delivered twice is folded once**, where it carries a view key, and
308
+ * the repeats are reported as {@link Rollup.redelivered}. The guarantee is
309
+ * exactly as wide as the window: two deliveries of one batch that land either
310
+ * side of a collection boundary are two windows' input and are counted twice,
311
+ * bounded by *(retry delay ÷ window length)* — the same shape of bound already
312
+ * stated for the page views that straddle one (0147), and shrinking with the
313
+ * same setting. The one-operation rule is untouched (0158): applying one
314
+ * window's rollup twice still doubles it, because that is two runs rather than
315
+ * two batches, and nothing here can see the other run.
140
316
  */
141
- export declare const rollUp: (batches: readonly ReaderSignalBatch[], options?: RollupOptions) => Rollup;
317
+ /**
318
+ * A batch as a buffer holds it: with the instant **the door** received it.
319
+ *
320
+ * Optional, because a caller may compose a batch by hand — a backfill, a
321
+ * fixture, a test — and because it is the only field here that does not come
322
+ * off the wire. Where it is absent the batch is counted into the tallies like
323
+ * any other and into no hour, and {@link Rollup.undated} says so.
324
+ *
325
+ * It is `receivedAt` and never `sentAt`: a sender's clock is a number a page
326
+ * said, and a chart drawn from it is a chart a page can move bars on (0355).
327
+ */
328
+ export type DatedBatch = ReaderSignalBatch & {
329
+ readonly receivedAt?: string;
330
+ };
331
+ export declare const rollUp: (batches: readonly DatedBatch[], options?: RollupOptions) => Rollup;
142
332
  //# sourceMappingURL=rollup.d.ts.map
Binary file