@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
@@ -0,0 +1,293 @@
1
+ import type { AudienceId } from "../audience/audience.js";
2
+ import type { TreeId } from "../ids.js";
3
+ import { type Result } from "../result.js";
4
+ import { type ArrivalRange, type ArrivalSeriesOptions } from "./arrivals.js";
5
+ import type { ReaderSignalStoreError } from "./journal.js";
6
+ import { type Ratio } from "./ratios.js";
7
+ import type { FunnelPair } from "./rollup.js";
8
+ /**
9
+ * **A funnel, by the hour the readers in it entered it.**
10
+ *
11
+ * The funnel counters have answered *of the views that did X to this part, how
12
+ * many went on to do Y to that one* since §3, and
13
+ * [0418](../../decisions/0418-a-projects-goal-funnel-is-asked-of-the-pages-both-steps-name-and-only-of-a-window-that-begins-after-it-was-set.md)
14
+ * put a project's own goal steps into collection, so *Goals* reads each step's
15
+ * share off a durable row. **That row has no clock.** It is a revision and the
16
+ * two ends, summed over every window that revision was ever folded in — which
17
+ * is exactly the question *Goals* asks and none of the question *Page history*
18
+ * asks.
19
+ *
20
+ * `Loom portal` filed that gap the morning 0418 landed:
21
+ * [0402](../../decisions/0402-goals-can-form-a-funnel-and-each-step-after-the-first-is-a-funnel-pair-counted-inside-one-page-view.md)
22
+ * clause 6 scores each later step of a change's goal over **the change's own
23
+ * two sides** — fourteen days before the page changed and fourteen after — and
24
+ * a revision served for six weeks has one row for all six. Reading the whole
25
+ * revision as the before side is a different measurement from the one the
26
+ * maintainer's rules describe, so the portal drew the per-step lines from the
27
+ * newest kept deliveries instead, which ends at the retention window (0349)
28
+ * and so could never span a comparison measured a fortnight each side.
29
+ *
30
+ * This is the eighth counter and the third with a clock in its key: the same
31
+ * answers the fold already computes, filed under an hour.
32
+ *
33
+ * ## A distinct count can be sliced by hour exactly once
34
+ *
35
+ * [0362](../../decisions/0362-what-readers-did-is-counted-under-the-hour-they-did-it-in-as-a-seventh-counter-the-fold-writes-for-the-three-delegated-kinds.md)
36
+ * clause 3 refused to put the tally's `views`, `reached` and `engaged` under an
37
+ * hour, and the reason is arithmetic rather than taste: those are counts of
38
+ * **distinct page views**, filed from every delivery that reported them, so a
39
+ * reader whose page view crosses an hour boundary is one view in each hour and
40
+ * two in their sum. An hourly table of them publishes a denominator that grows
41
+ * with how finely it is cut.
42
+ *
43
+ * `reached` and `converted` are distinct counts too, and this table holds them
44
+ * anyway — because the hazard is in the *filing* and not in the counter. **A
45
+ * view is filed under one hour: the hour it first satisfied the pair's `from`
46
+ * end in this window.** The hours of a window are a partition of that window's
47
+ * view set rather than a slice per delivery, so they sum to the window's own
48
+ * answer exactly, and the sum is an invariant rather than an approximation.
49
+ *
50
+ * **Only the fold can make that assignment**, which is why this counter is
51
+ * written where the answers are: the view key is the thing the assignment is
52
+ * over, it is consumed in `rollup.ts` and it never reaches storage (0146). A
53
+ * second pass would also make the repeat refusal twice over a different
54
+ * grouping, which is what 0362 clause 5 says it costs.
55
+ *
56
+ * ## The cohort is the hour of the first end, on both numbers
57
+ *
58
+ * A reader who reached the pricing band at 10:59 and pressed at 11:02 is
59
+ * **one** hour's row: `reached 1, converted 1`, under ten o'clock. Filing each
60
+ * end under its own hour would put `converted` in an hour whose `reached` is
61
+ * nought — a row whose rate is infinite, in a table whose whole purpose is to
62
+ * be divided — and `FunnelAnswer`'s standing promise that `converted` is never
63
+ * above `reached` would hold for the total row and fail for its slices.
64
+ *
65
+ * So an hour here means *the readers who entered this funnel in this hour, and
66
+ * what became of them*. It is a cohort and not a clock on the conversion, and
67
+ * a surface drawing it says **when the readers arrived at the first step**.
68
+ *
69
+ * ## What it inherits, and what it does not make worse
70
+ *
71
+ * A conversion split across two collection windows is **lost** rather than
72
+ * doubled (0147, and `funnel.ts` at length): the window that saw the reach
73
+ * reports `converted 0` and the window that saw the conversion never saw the
74
+ * reach. The hourly rows are cut from those same per-window answers, so they
75
+ * carry exactly that bias and no more of it — the slicing is inside a window
76
+ * and adds no boundary of its own.
77
+ *
78
+ * A row exists only where somebody reached the first end, so this table is
79
+ * bounded by what readers did rather than by how many questions a deployment
80
+ * asks — the affordability property 0362 clause 4 states for the seventh
81
+ * counter. The total row is still written at nought, because *nobody reached
82
+ * this step* is an answer a deployment asked for; an hour nobody entered the
83
+ * funnel in is a nought a reading draws rather than a row a fold stores.
84
+ *
85
+ * Pure: no store, no clock, no DOM, and nothing a reader's browser pays for.
86
+ * Nothing is added to a payload, a column of the buffer, or the vocabulary.
87
+ */
88
+ /** One funnel pair's answer for one hour of one revision. */
89
+ export type FunnelHourCount = {
90
+ readonly treeId: TreeId;
91
+ readonly revision: number;
92
+ /**
93
+ * The two ends, as a stored funnel answer carries them and with no scope
94
+ * among them: the pages a question was asked on decide which rows are
95
+ * written and never what one means (0418).
96
+ */
97
+ readonly pair: FunnelPair;
98
+ /** The hour the readers in it entered the funnel, as the instant that hour began (UTC). */
99
+ readonly hour: number;
100
+ /** Views that satisfied `from` in this hour. */
101
+ readonly reached: number;
102
+ /** Of those, the views that satisfied `to`. Never greater than {@link FunnelHourCount.reached}. */
103
+ readonly converted: number;
104
+ };
105
+ /** One hour's row as the store keeps it. See `StoredTally.audienceId` (0284). */
106
+ export type StoredFunnelHour = FunnelHourCount & {
107
+ readonly audienceId: AudienceId;
108
+ readonly updatedAt: string;
109
+ };
110
+ /**
111
+ * What a ranged read of this counter hands back, which is the shape
112
+ * `StoredArrivals` and `StoredActed` have and for the same two reasons.
113
+ */
114
+ export type StoredFunnelHours = {
115
+ /** Every row in the range, in no particular order. */
116
+ readonly hours: readonly StoredFunnelHour[];
117
+ /**
118
+ * The first hour this scope ever counted a reach in, whatever range was asked
119
+ * for.
120
+ *
121
+ * Absent means *nothing has ever been counted here*, which is a different
122
+ * sentence from *nobody entered this funnel in the range you asked about*
123
+ * (0309, 0347). It narrows with the request, so a step set this afternoon
124
+ * says it has been measurable since this afternoon rather than drawing a
125
+ * year of noughts behind it.
126
+ */
127
+ readonly begins?: number;
128
+ };
129
+ /** One hour of a range, which is one bar and one cohort. */
130
+ export type FunnelHour = {
131
+ /** The instant the hour began (UTC). */
132
+ readonly hour: number;
133
+ /** Views that entered the funnel in it. */
134
+ readonly reached: number;
135
+ /** Of those, the ones that converted — in this hour's cohort, not in this hour. */
136
+ readonly converted: number;
137
+ /**
138
+ * Whether this hour is over and inside the range.
139
+ *
140
+ * False on the hour in progress, and false where the range cuts the hour
141
+ * short, so a surface does not draw the clock as a fall.
142
+ */
143
+ readonly whole: boolean;
144
+ };
145
+ /**
146
+ * A funnel over a range, by hour, for one pair.
147
+ *
148
+ * One pair per series, and that is a correctness rule rather than a
149
+ * convenience: `reached` counts distinct page views, so two pairs sharing a
150
+ * `from` end both hold the same view in their own rows, and a series that
151
+ * summed across pairs would count that reader once per question asked about
152
+ * them. {@link funnelHourSeriesOf} therefore takes the pair it is of and
153
+ * **ignores** every other row it was handed.
154
+ */
155
+ export type FunnelHourSeries = {
156
+ readonly range: ArrivalRange;
157
+ /** The pair this series is of, as the caller named it. */
158
+ readonly pair: FunnelPair;
159
+ /**
160
+ * One entry per hour, ascending, from the later of the range's first hour and
161
+ * the hour counting began. Dense: an hour nobody entered the funnel in is
162
+ * nought in both numbers and is present.
163
+ */
164
+ readonly hours: readonly FunnelHour[];
165
+ /** Views that entered the funnel inside the range, which is the sum of the hours. */
166
+ readonly reached: number;
167
+ /** Of those, the ones that converted. Never greater than {@link FunnelHourSeries.reached}. */
168
+ readonly converted: number;
169
+ /**
170
+ * `converted ÷ reached` over the range, or `null` where nothing reached the
171
+ * first end.
172
+ *
173
+ * `null` is *the question has no answer here* rather than *the answer is
174
+ * nought*, which is the rule `PairReach.rate` already holds for the total
175
+ * row. A floor rather than an estimate wherever a conversion could have been
176
+ * split across two collection windows (0147).
177
+ */
178
+ readonly rate: number | null;
179
+ /** The first hour this scope ever counted, carried through from the store. */
180
+ readonly begins?: number;
181
+ /** Whether the range starts before counting did, so the series is shorter than asked for. */
182
+ readonly clipped: boolean;
183
+ };
184
+ /**
185
+ * The hours of a range for one pair, as the counter answers for them.
186
+ *
187
+ * Rows of **this** pair are summed into their hour, so a scope holding several
188
+ * revisions, pages or audiences adds — a page view belongs to one revision of
189
+ * one page served to one audience, so the view sets being added are disjoint
190
+ * and the distinctness holds. Rows of any other pair are ignored, for the
191
+ * reason {@link FunnelHourSeries} gives.
192
+ *
193
+ * Rows outside the range are ignored rather than refused, exactly as
194
+ * `arrivalSeriesOf` ignores them: a wider read is what
195
+ * {@link funnelHourChangeOf} narrows twice.
196
+ */
197
+ export declare const funnelHourSeriesOf: (stored: StoredFunnelHours, pair: FunnelPair, range: ArrivalRange, options?: ArrivalSeriesOptions) => FunnelHourSeries;
198
+ /**
199
+ * A funnel over a range against the same funnel over the period before it.
200
+ *
201
+ * The two sides a change is scored over (0402 clause 6), and the figure that is
202
+ * a lie if the earlier period is one the deployment was not counting through.
203
+ */
204
+ export type FunnelHourChange = {
205
+ readonly range: ArrivalRange;
206
+ /** The equal-length period before, which is `arrivalRangeBefore` (0356). */
207
+ readonly before: ArrivalRange;
208
+ readonly pair: FunnelPair;
209
+ readonly reached: number;
210
+ readonly converted: number;
211
+ /** The later side's rate, on {@link FunnelHourSeries.rate}'s terms. */
212
+ readonly rate: number | null;
213
+ /**
214
+ * What the earlier period held, or `null` where counting had not begun when
215
+ * it started.
216
+ *
217
+ * `null` is not nought, and the difference is the whole of these three
218
+ * fields: a deployment that upgraded on Tuesday had no counter before
219
+ * Tuesday and no missing readers either. All three are `null` together,
220
+ * except {@link FunnelHourChange.wasRate}, which is also `null` where nobody
221
+ * reached the first end in the earlier period.
222
+ */
223
+ readonly wasReached: number | null;
224
+ readonly wasConverted: number | null;
225
+ readonly wasRate: number | null;
226
+ /**
227
+ * The later rate over the earlier rate, or why there is none (`ratios.ts`).
228
+ *
229
+ * **Of the two rates and not of the two conversion counts**, because a change
230
+ * is scored on the share and not on the traffic: a page that converted twice
231
+ * as many readers out of three times as many is a step that got worse, and a
232
+ * quotient of counts says it improved. A surface wanting the counts compared
233
+ * has both sides in hand.
234
+ */
235
+ readonly ratio: Ratio;
236
+ };
237
+ /**
238
+ * Both sides and the quotient, from one read spanning both periods.
239
+ *
240
+ * The read has to span both, which is what {@link readReaderFunnelHours} is
241
+ * for: the obvious caller reads the range on the screen and reports an earlier
242
+ * period that is empty **because it was not read** (0356).
243
+ */
244
+ export declare const funnelHourChangeOf: (stored: StoredFunnelHours, pair: FunnelPair, range: ArrivalRange, options?: ArrivalSeriesOptions) => FunnelHourChange;
245
+ /** What a surface asks for: a range, the pair, the narrowing and the clock. */
246
+ export type FunnelHourReadingRequest = {
247
+ readonly range: ArrivalRange;
248
+ /**
249
+ * The funnel this is about.
250
+ *
251
+ * Required, unlike every other narrowing here, for the reason
252
+ * {@link FunnelHourSeries} gives: a figure summed across pairs counts one
253
+ * reader once per question asked about them. The store is narrowed to the
254
+ * pair's ends as well as the reading, so a deployment asking fifty questions
255
+ * reads the rows of one.
256
+ */
257
+ readonly pair: FunnelPair;
258
+ /** Absent reads every tree the handle can see, which is the scope rule (0020). */
259
+ readonly treeId?: TreeId;
260
+ /** Absent reads every audience (0284), whose counts then add. */
261
+ readonly audience?: AudienceId | undefined;
262
+ /** Absent reads every revision, whose counts then add — which is what a step wants. */
263
+ readonly revision?: number;
264
+ /** Now, where the caller has it, so the hour in progress is marked as one. */
265
+ readonly now?: number;
266
+ };
267
+ /** The chart and the two sides beside it, from one read. */
268
+ export type FunnelHourReading = {
269
+ readonly series: FunnelHourSeries;
270
+ readonly change: FunnelHourChange;
271
+ };
272
+ /** The one method of the counter handle a reading of this needs. */
273
+ export type FunnelHourCounterHandle = {
274
+ readonly funnelHours: (request?: {
275
+ readonly treeId?: TreeId;
276
+ readonly audience?: AudienceId | undefined;
277
+ readonly revision?: number;
278
+ readonly pair?: FunnelPair;
279
+ readonly from?: number;
280
+ readonly to?: number;
281
+ }) => Promise<Result<StoredFunnelHours, ReaderSignalStoreError>>;
282
+ };
283
+ /**
284
+ * The chart, the range's figures and the period before it, in one call against
285
+ * a counter handle.
286
+ *
287
+ * It exists for the reason `readReaderActed` does: the composition has a wrong
288
+ * version that type-checks, and it reads as *every conversion you have is new*
289
+ * on a screen whose store holds the right answer. The handle is narrowed to the
290
+ * one method, so a reading cannot reach a counter it was not asked about.
291
+ */
292
+ export declare const readReaderFunnelHours: (store: FunnelHourCounterHandle, request: FunnelHourReadingRequest) => Promise<Result<FunnelHourReading, ReaderSignalStoreError>>;
293
+ //# sourceMappingURL=funnel-hours.d.ts.map
@@ -0,0 +1,99 @@
1
+ import { ok } from "../result.js";
2
+ import { arrivalRangeBefore, hourlySeriesOf, } from "./arrivals.js";
3
+ import { funnelPairKey } from "./funnel.js";
4
+ import { ratioOf } from "./ratios.js";
5
+ const rateOf = (reached, converted) => reached === 0 ? null : converted / reached;
6
+ /**
7
+ * The hours of a range for one pair, as the counter answers for them.
8
+ *
9
+ * Rows of **this** pair are summed into their hour, so a scope holding several
10
+ * revisions, pages or audiences adds — a page view belongs to one revision of
11
+ * one page served to one audience, so the view sets being added are disjoint
12
+ * and the distinctness holds. Rows of any other pair are ignored, for the
13
+ * reason {@link FunnelHourSeries} gives.
14
+ *
15
+ * Rows outside the range are ignored rather than refused, exactly as
16
+ * `arrivalSeriesOf` ignores them: a wider read is what
17
+ * {@link funnelHourChangeOf} narrows twice.
18
+ */
19
+ export const funnelHourSeriesOf = (stored, pair, range, options = {}) => {
20
+ const asked = funnelPairKey(pair);
21
+ const mine = stored.hours.filter((row) => funnelPairKey(row.pair) === asked);
22
+ const reaching = hourlySeriesOf(mine, stored.begins, range, (row) => row.reached, options);
23
+ const converting = hourlySeriesOf(mine, stored.begins, range, (row) => row.converted, options);
24
+ return {
25
+ range,
26
+ pair,
27
+ /**
28
+ * Two fills over one row set, zipped by position: both are dense over the
29
+ * same hours in the same order, because `hourlySeriesOf` draws its buckets
30
+ * from the range and the beginning rather than from the rows. A lookup by
31
+ * hour would be the same answer and a second rule about what an hour is.
32
+ */
33
+ hours: reaching.hours.map((bucket, at) => ({
34
+ hour: bucket.hour,
35
+ reached: bucket.count,
36
+ converted: converting.hours[at]?.count ?? 0,
37
+ whole: bucket.whole,
38
+ })),
39
+ reached: reaching.total,
40
+ converted: converting.total,
41
+ rate: rateOf(reaching.total, converting.total),
42
+ ...(stored.begins === undefined ? {} : { begins: stored.begins }),
43
+ clipped: reaching.clipped,
44
+ };
45
+ };
46
+ /**
47
+ * Both sides and the quotient, from one read spanning both periods.
48
+ *
49
+ * The read has to span both, which is what {@link readReaderFunnelHours} is
50
+ * for: the obvious caller reads the range on the screen and reports an earlier
51
+ * period that is empty **because it was not read** (0356).
52
+ */
53
+ export const funnelHourChangeOf = (stored, pair, range, options = {}) => {
54
+ const before = arrivalRangeBefore(range);
55
+ const now = funnelHourSeriesOf(stored, pair, range, options);
56
+ const earlier = funnelHourSeriesOf(stored, pair, before, options);
57
+ const measured = stored.begins !== undefined && stored.begins <= before.from;
58
+ const wasReached = measured ? earlier.reached : null;
59
+ const wasConverted = measured ? earlier.converted : null;
60
+ const wasRate = measured ? earlier.rate : null;
61
+ return {
62
+ range,
63
+ before,
64
+ pair,
65
+ reached: now.reached,
66
+ converted: now.converted,
67
+ rate: now.rate,
68
+ wasReached,
69
+ wasConverted,
70
+ wasRate,
71
+ ratio: ratioOf(wasRate, now.rate),
72
+ };
73
+ };
74
+ /**
75
+ * The chart, the range's figures and the period before it, in one call against
76
+ * a counter handle.
77
+ *
78
+ * It exists for the reason `readReaderActed` does: the composition has a wrong
79
+ * version that type-checks, and it reads as *every conversion you have is new*
80
+ * on a screen whose store holds the right answer. The handle is narrowed to the
81
+ * one method, so a reading cannot reach a counter it was not asked about.
82
+ */
83
+ export const readReaderFunnelHours = async (store, request) => {
84
+ const { range, now, pair, ...narrowing } = request;
85
+ const read = await store.funnelHours({
86
+ ...narrowing,
87
+ pair,
88
+ from: arrivalRangeBefore(range).from,
89
+ to: range.to,
90
+ });
91
+ if (!read.ok)
92
+ return read;
93
+ const options = now === undefined ? {} : { now };
94
+ return ok({
95
+ series: funnelHourSeriesOf(read.value, pair, range, options),
96
+ change: funnelHourChangeOf(read.value, pair, range, options),
97
+ });
98
+ };
99
+ //# sourceMappingURL=funnel-hours.js.map