@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,9 +1,11 @@
1
- import { NAMESPACED_ID_PATTERN, NODE_ID_PATTERN, TREE_ID_PATTERN } from "../grammar.js";
1
+ import { idPattern, NAMESPACED_ID_PATTERN, NODE_ID_PATTERN, TREE_ID_PATTERN } from "../grammar.js";
2
+ import { addressedRootIn } from "../render/addressed.js";
2
3
  import { DISCLOSED_ATTRIBUTE } from "../render/disclosed.js";
3
- import { LOOM_NODE_ATTRIBUTE, LOOM_REVISION_ATTRIBUTE, LOOM_TREE_ATTRIBUTE, LOOM_TYPE_ATTRIBUTE, } from "../render/editable.js";
4
+ import { LOOM_AUDIENCE_ATTRIBUTE, LOOM_NODE_ATTRIBUTE, LOOM_REVISION_ATTRIBUTE, LOOM_TREE_ATTRIBUTE, LOOM_TYPE_ATTRIBUTE, } from "../render/editable.js";
4
5
  import { err, ok } from "../result.js";
5
6
  import { createSignalLedger } from "./ledger.js";
6
7
  import { READER_SIGNAL_KINDS } from "./kinds.js";
8
+ import { READABLE_VIEWPORT_FRACTION, READABLE_VISIBLE_FRACTION } from "./readable.js";
7
9
  import { mintViewKey } from "./view.js";
8
10
  /**
9
11
  * Broadcasting reader signals from a rendered Loom page.
@@ -32,16 +34,26 @@ import { mintViewKey } from "./view.js";
32
34
  * the control rather than the band. The addressed elements above it go on the
33
35
  * signal as `within`, read off the walk this was already doing — because which
34
36
  * region a node sat in is a fact about the page at the moment of the press, and
35
- * nothing downstream can recover it afterwards.
37
+ * nothing downstream can recover it afterwards. A `completed` carries the same
38
+ * walk, for the same reason and more sharply: *which band converted* is the
39
+ * question a deployment opens the portal to ask.
40
+ *
41
+ * **A completion is a form the browser let go.** Nothing else on the page is a
42
+ * finish a reader can be said to have reached, and nothing else is observable
43
+ * without asking the network how it went (0211).
36
44
  *
37
45
  * **It keeps up with a page that changes.** Nodes that arrive after it started
38
46
  * are watched and nodes that leave stop counting, so a band behind a Suspense
39
47
  * boundary, a list that grows, and every region a proposal has just changed are
40
- * measured like the rest. What it does *not* follow is the page becoming a
41
- * different page: the tree and revision are read once, off the root, and every
42
- * batch is filed under them. **A new root, or a new revision in the same root,
43
- * is a new broadcast** — `stop()` the old one and start another, or a
44
- * client-side navigation files its signals under the revision it left.
48
+ * measured like the rest.
49
+ *
50
+ * **And with a page that becomes a different page, when it is handed the
51
+ * document.** The tree and revision are read once off a root element, so a
52
+ * broadcast pointed at an element goes on filing every batch under them — which
53
+ * is a client-side navigation's signals filed against the page it left. Pointed
54
+ * at a `Document` it follows the addressed page instead: a new identity ends one
55
+ * page view and opens another, with its own view key and its own arrival, and
56
+ * the same revision rendered again continues the one it was already observing.
45
57
  */
46
58
  /** The DOM event a batch is dispatched as, on the root element. It bubbles. */
47
59
  /**
@@ -53,7 +65,7 @@ import { mintViewKey } from "./view.js";
53
65
  * a broadcaster in a browser bundle is exactly the host who needs a `send`. One
54
66
  * import line for the two things that are always used together.
55
67
  */
56
- export { DEFAULT_READER_SIGNAL_PATH, deliverReaderSignals, } from "./deliver.js";
68
+ export { BATCH_CONTENT_TYPE, DEFAULT_READER_SIGNAL_PATH, deliverReaderSignals, } from "./deliver.js";
57
69
  export const READER_SIGNALS_EVENT = "loom:signals";
58
70
  /**
59
71
  * What a reader can aim at, as HTML defines it. `summary` is left out on
@@ -86,18 +98,19 @@ const selectionOf = (kinds, types) => {
86
98
  return (kind, type) => enabled.has(kind) && (allowed.get(kind)?.has(type) ?? true);
87
99
  };
88
100
  const DEFAULT_FLUSH_MS = 5000;
101
+ /** A page view nothing has been delivered for yet. */
102
+ const beginPageView = (random) => ({ key: mintViewKey(random), opened: false });
89
103
  /**
90
- * On screen means a reader could be reading it: at least half of the element is
91
- * visible, or it fills at least 30% of the viewport. The second clause is not
92
- * optional — the visible fraction of an element taller than the window can never
93
- * reach one half, so a long section judged by the first alone is never viewed.
104
+ * On screen means a reader could be reading it: at least
105
+ * {@link READABLE_VISIBLE_FRACTION} of the element is visible, **or** it fills
106
+ * at least {@link READABLE_VIEWPORT_FRACTION} of the viewport.
94
107
  */
95
108
  const isReadable = (entry) => {
96
109
  if (!entry.isIntersecting)
97
110
  return false;
98
111
  const viewport = entry.rootBounds?.height ?? globalThis.innerHeight ?? 0;
99
- const fills = viewport > 0 && entry.intersectionRect.height / viewport >= 0.3;
100
- return entry.intersectionRatio >= 0.5 || fills;
112
+ const fills = viewport > 0 && entry.intersectionRect.height / viewport >= READABLE_VIEWPORT_FRACTION;
113
+ return entry.intersectionRatio >= READABLE_VISIBLE_FRACTION || fills;
101
114
  };
102
115
  const intersectionVisibility = (onChange) => {
103
116
  const observer = new IntersectionObserver((entries) => onChange(entries.map((entry) => ({ target: entry.target, visible: isReadable(entry) }))), { threshold: [0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1] });
@@ -117,6 +130,9 @@ const addressOf = (element) => {
117
130
  const type = element.getAttribute(LOOM_TYPE_ATTRIBUTE);
118
131
  return isNodeId(nodeId) && isPrimitiveType(type) ? { nodeId, type } : undefined;
119
132
  };
133
+ /** The pattern `audienceIdSchema` holds, without the schema library in a reader's bundle. */
134
+ const AUDIENCE_ID_PATTERN = idPattern("aud");
135
+ const isAudienceId = (value) => AUDIENCE_ID_PATTERN.test(value);
120
136
  const pageOf = (root) => {
121
137
  const treeId = root.getAttribute(LOOM_TREE_ATTRIBUTE);
122
138
  /**
@@ -126,12 +142,27 @@ const pageOf = (root) => {
126
142
  */
127
143
  const written = root.getAttribute(LOOM_REVISION_ATTRIBUTE) ?? "";
128
144
  const revision = /^\d+$/.test(written) ? Number(written) : Number.NaN;
129
- return isTreeId(treeId) && Number.isSafeInteger(revision)
130
- ? ok({ treeId, revision })
131
- : err({
145
+ if (!isTreeId(treeId) || !Number.isSafeInteger(revision)) {
146
+ return err({
132
147
  code: "unaddressed",
133
148
  detail: `the root element carries no ${LOOM_TREE_ATTRIBUTE} and ${LOOM_REVISION_ATTRIBUTE}; render the page with addressed: true`,
134
149
  });
150
+ }
151
+ /**
152
+ * Absent is every reader (`aud_everyone`), which is what a page served to no
153
+ * segment says by saying nothing (0284). Present and unreadable is refused
154
+ * rather than ignored: ignoring it would file a segment's page views as
155
+ * everybody's, and the intake would refuse every batch that carried it.
156
+ */
157
+ const audience = root.getAttribute(LOOM_AUDIENCE_ATTRIBUTE);
158
+ if (audience === null)
159
+ return ok({ treeId, revision, audience: undefined });
160
+ return isAudienceId(audience)
161
+ ? ok({ treeId, revision, audience })
162
+ : err({
163
+ code: "unaddressed",
164
+ detail: `the root element's ${LOOM_AUDIENCE_ATTRIBUTE} is not a segment's aud_ id: ${audience}`,
165
+ });
135
166
  };
136
167
  /** The nearest addressed element at or above `element`, without leaving the page. */
137
168
  const nearestAddressed = (root, element) => {
@@ -176,7 +207,8 @@ const deliverSafely = (send, batch) => {
176
207
  }
177
208
  };
178
209
  /**
179
- * Start broadcasting reader signals from the page under `root`.
210
+ * Start broadcasting reader signals from the page under `root`, as part of
211
+ * `of`.
180
212
  *
181
213
  * Returns an error rather than broadcasting nothing when the page is not
182
214
  * addressed, because a silent broadcaster on an unaddressed page is exactly the
@@ -184,25 +216,16 @@ const deliverSafely = (send, batch) => {
184
216
  *
185
217
  * Nodes added under `root` afterwards are picked up and nodes removed stop
186
218
  * counting. The tree and revision are not: they are read once, here, and a page
187
- * that becomes a different page — a client-side navigation, a re-render at a new
188
- * revision into the same root — needs `stop()` and a new broadcast, or its
189
- * signals are filed under the revision it left.
219
+ * that becomes a different page needs another of these — which is what
220
+ * {@link followAddressedPage} does for a host that hands over a `Document`.
190
221
  */
191
- export const broadcastReaderSignals = (root, options = {}) => {
222
+ const broadcastFromRoot = (root, options, of) => {
192
223
  const page = pageOf(root);
193
224
  if (!page.ok)
194
225
  return page;
195
226
  const now = options.now ?? Date.now;
196
227
  const wants = selectionOf(options.kinds, options.types);
197
228
  const document = root.ownerDocument;
198
- /**
199
- * Minted once, here, and carried by every batch this broadcast sends — which
200
- * is what makes the batches of one page view correlatable and two page views
201
- * not (0146). A new broadcast is a new view, including the second one a
202
- * client-side navigation needs, so the key cannot outlive the page it
203
- * describes even by accident.
204
- */
205
- const view = mintViewKey(options.random);
206
229
  const ledger = createSignalLedger(document.visibilityState === "hidden");
207
230
  let stopped = false;
208
231
  const walks = options.within ?? true;
@@ -237,10 +260,13 @@ export const broadcastReaderSignals = (root, options = {}) => {
237
260
  const batch = {
238
261
  treeId: page.value.treeId,
239
262
  revision: page.value.revision,
263
+ ...(page.value.audience === undefined ? {} : { audience: page.value.audience }),
240
264
  sentAt: now(),
241
- view,
265
+ view: of.key,
266
+ ...(of.opened ? {} : { first: true }),
242
267
  signals,
243
268
  };
269
+ of.opened = true;
244
270
  root.dispatchEvent(new CustomEvent(READER_SIGNALS_EVENT, { detail: batch, bubbles: true }));
245
271
  deliverSafely(options.send, batch);
246
272
  };
@@ -374,6 +400,36 @@ export const broadcastReaderSignals = (root, options = {}) => {
374
400
  ...within,
375
401
  }))(details);
376
402
  };
403
+ /**
404
+ * A form inside the page was submitted, which is the one completion a page
405
+ * can witness on its own.
406
+ *
407
+ * **Captured rather than delegated**, like `toggle` and unlike `click`: a
408
+ * handler inside the page may call `stopPropagation`, and a submission the
409
+ * broadcaster never heard is a conversion nobody counted. The press on the
410
+ * submit control is a separate fact and is still reported as `activated`
411
+ * against the control — two kinds about two nodes, not one action counted
412
+ * twice.
413
+ *
414
+ * **`preventDefault` is read once the dispatch is over, never during it.**
415
+ * Any listener may cancel a submit, and whether this one runs before or after
416
+ * theirs is registration order — React attaches its own at a root container
417
+ * which may be this very element. A microtask queued here runs after dispatch
418
+ * has finished, so what it reads is the final answer rather than whichever
419
+ * one happened to be true halfway through. The instant is taken at the event,
420
+ * not in the microtask, because the event is when the reader finished.
421
+ */
422
+ const onSubmit = (event) => {
423
+ const form = event.target;
424
+ if (!(form instanceof HTMLFormElement) || !root.contains(form))
425
+ return;
426
+ const at = now();
427
+ queueMicrotask(() => {
428
+ if (stopped || event.defaultPrevented)
429
+ return;
430
+ record("completed", (address, within) => ({ kind: "completed", ...address, at, ...within }))(form);
431
+ });
432
+ };
377
433
  const disclosures = new MutationObserver((mutations) => {
378
434
  for (const mutation of mutations) {
379
435
  if (!(mutation.target instanceof Element))
@@ -421,6 +477,7 @@ export const broadcastReaderSignals = (root, options = {}) => {
421
477
  const onPageHide = () => flush();
422
478
  root.addEventListener("click", onClick);
423
479
  root.addEventListener("toggle", onToggle, true);
480
+ root.addEventListener("submit", onSubmit, true);
424
481
  disclosures.observe(root, {
425
482
  attributes: true,
426
483
  attributeFilter: [DISCLOSED_ATTRIBUTE],
@@ -443,9 +500,175 @@ export const broadcastReaderSignals = (root, options = {}) => {
443
500
  arrivals?.disconnect();
444
501
  root.removeEventListener("click", onClick);
445
502
  root.removeEventListener("toggle", onToggle, true);
503
+ root.removeEventListener("submit", onSubmit, true);
446
504
  document.removeEventListener("visibilitychange", onVisibility);
447
505
  document.defaultView?.removeEventListener("pagehide", onPageHide);
448
506
  };
449
507
  return ok({ flush, stop });
450
508
  };
509
+ /**
510
+ * The tree, revision and segment an element says it is, as one comparable
511
+ * value. A page served to another segment is another form of the page, and so
512
+ * another page view, as a new revision is.
513
+ *
514
+ * Read off the attributes rather than off {@link pageOf}, because what this
515
+ * compares is *whether the page changed* and not whether it is addressed well
516
+ * enough to broadcast: a root whose revision goes from `4` to something that is
517
+ * not a number has become a different page and has stopped being a page this
518
+ * can report on, and those are two answers rather than one.
519
+ */
520
+ const identityOf = (root) => [LOOM_TREE_ATTRIBUTE, LOOM_REVISION_ATTRIBUTE, LOOM_AUDIENCE_ATTRIBUTE]
521
+ .map((attribute) => root.getAttribute(attribute))
522
+ .join(" ");
523
+ /**
524
+ * Broadcast from whatever addressed page the document holds, and keep
525
+ * broadcasting from it when the host replaces it.
526
+ *
527
+ * ## Why this exists
528
+ *
529
+ * A broadcast reads its tree and revision once, off the root it was handed, and
530
+ * files every batch under them. That is right, and it is why the documented
531
+ * remedy for a page becoming a different page has been *stop and start another*
532
+ * — which asks a host to notice a client-side navigation and do something about
533
+ * it. **A host that does not is the common case, and what it gets is not
534
+ * missing data but wrong data**: a reader navigates from the pricing page to the
535
+ * sign-up page, and every signal from the second page is filed against the
536
+ * first page's nodes under the first page's revision. Nothing says so, at either
537
+ * end — the node ids are real and the batch parses.
538
+ *
539
+ * It is also an undercount at the door. One batch of a page view carries
540
+ * `first`, which is how an arrival is counted exactly once, so a reader who
541
+ * visits four pages in an app that never restarts its broadcast arrives once.
542
+ * Page views by the hour they began in (0356) read that marker, and so does
543
+ * every figure taken at the door's scale.
544
+ *
545
+ * ## What it follows, and what it does not
546
+ *
547
+ * The page's **identity** — its tree and its revision — and not the element
548
+ * carrying it. Three things follow from that, and together they are the
549
+ * counting rule:
550
+ *
551
+ * - **A re-render is not a navigation.** Nodes arriving, leaving and changing
552
+ * under the root are what the broadcast already watches; this notices them,
553
+ * finds the page unchanged, and does nothing. A page a proposal has just
554
+ * rewritten is one page view, as it was before.
555
+ * - **A new identity is a new page view.** A root replaced by a different
556
+ * tree's, or the same root re-rendered at a new revision, ends the page view
557
+ * — the old broadcast is stopped, which delivers what it gathered under the
558
+ * revision it gathered it on — and begins a fresh one, with a fresh view key
559
+ * and a fresh opening. Nothing correlates the two, which is rule 2 of
560
+ * `docs/signals.md` holding rather than being argued about: two page views of
561
+ * two pages are two keys and the reader behind them is not a column anywhere.
562
+ * - **The same identity rendered again is the same page view.** A host that
563
+ * unmounts the element it rendered into and renders the same revision again
564
+ * has not sent a reader anywhere, so the second broadcast is handed the page
565
+ * view the first one was observing: same key, no second opening, no second
566
+ * arrival. This is the case that would double-count, and it is the reason the
567
+ * page view is a value rather than a broadcast's own state.
568
+ *
569
+ * An unaddressed document is refused here exactly as an unaddressed element is
570
+ * refused by a broadcast, and for the same reason. A page that *becomes*
571
+ * unaddressed — the root goes and nothing replaces it — is not a failure: the
572
+ * broadcast is stopped, what it gathered is delivered, and the page view is
573
+ * held in case the same revision comes back.
574
+ *
575
+ * ## What it costs
576
+ *
577
+ * One `MutationObserver` on the document, watching for children and for the two
578
+ * attributes that spell a page's identity. Its callback compares three values
579
+ * it already holds and returns, so the cost of a page that churns is three
580
+ * reads per batch of mutations; the one `querySelector` it can run happens only
581
+ * when the page it was observing is no longer the page in the document. The
582
+ * broadcast itself is unchanged and runs its own observers as it always has.
583
+ */
584
+ const followAddressedPage = (page, options) => {
585
+ const found = addressedRootIn(page);
586
+ if (found === undefined) {
587
+ return err({
588
+ code: "unaddressed",
589
+ detail: `no element in this document carries ${LOOM_TREE_ATTRIBUTE}; render the page with addressed: true`,
590
+ });
591
+ }
592
+ const first = beginPageView(options.random);
593
+ const opening = broadcastFromRoot(found, options, first);
594
+ /**
595
+ * The opening failure is the host's to see, so it is returned. The same
596
+ * failure later is a page this cannot report on rather than a call that went
597
+ * wrong — a root whose revision attribute stops being a number is a page
598
+ * nothing broadcasts from, and the host is not making a call to learn it, so
599
+ * `settled` leaves it unobserved and waits for the next thing to happen.
600
+ */
601
+ if (!opening.ok)
602
+ return opening;
603
+ let observing = {
604
+ root: found,
605
+ identity: identityOf(found),
606
+ of: first,
607
+ broadcast: opening.value,
608
+ };
609
+ /** The page view the last broadcast was observing, while its page may come back. */
610
+ let ended;
611
+ let stopped = false;
612
+ /** Whether the broadcast is still observing the page the document holds. */
613
+ const standing = () => observing !== undefined && observing.root.isConnected && identityOf(observing.root) === observing.identity;
614
+ const settled = () => {
615
+ if (stopped || standing())
616
+ return;
617
+ if (observing !== undefined) {
618
+ observing.broadcast.stop();
619
+ ended = { identity: observing.identity, of: observing.of };
620
+ observing = undefined;
621
+ }
622
+ const root = addressedRootIn(page);
623
+ if (root === undefined)
624
+ return;
625
+ const identity = identityOf(root);
626
+ const of = ended !== undefined && ended.identity === identity ? ended.of : beginPageView(options.random);
627
+ const started = broadcastFromRoot(root, options, of);
628
+ if (!started.ok)
629
+ return;
630
+ observing = { root, identity: identityOf(root), of, broadcast: started.value };
631
+ ended = undefined;
632
+ };
633
+ const pages = new MutationObserver(settled);
634
+ pages.observe(page, {
635
+ childList: true,
636
+ subtree: true,
637
+ attributes: true,
638
+ attributeFilter: [LOOM_TREE_ATTRIBUTE, LOOM_REVISION_ATTRIBUTE, LOOM_AUDIENCE_ATTRIBUTE],
639
+ });
640
+ return ok({
641
+ flush: () => observing?.broadcast.flush(),
642
+ stop: () => {
643
+ stopped = true;
644
+ pages.disconnect();
645
+ observing?.broadcast.stop();
646
+ observing = undefined;
647
+ },
648
+ });
649
+ };
650
+ /** A document rather than an element, by node type — which is a number every realm agrees on (0354). */
651
+ const isDocument = (scope) => scope.nodeType === 9;
652
+ /**
653
+ * Start broadcasting reader signals from a rendered Loom page.
654
+ *
655
+ * Hand it the **root element** of the page and it broadcasts from that element:
656
+ * nodes arriving and leaving under it are followed, and the tree and revision
657
+ * are read once, so a page that becomes a different page needs `stop()` and
658
+ * another call or its signals are filed under the revision it left.
659
+ *
660
+ * Hand it the **document** and it finds the addressed page itself and follows
661
+ * it: a client-side navigation ends one page view and begins another, with its
662
+ * own view key and its own arrival, and the same revision rendered again
663
+ * continues the page view it was already observing
664
+ * ({@link followAddressedPage}). This is the argument to pass in an application
665
+ * that routes on the client, which is most of them.
666
+ *
667
+ * Either way it returns an error rather than broadcasting nothing when there is
668
+ * no addressed page to broadcast from, because a silent broadcaster is exactly
669
+ * the misconfiguration nobody would notice.
670
+ */
671
+ export const broadcastReaderSignals = (scope, options = {}) => isDocument(scope)
672
+ ? followAddressedPage(scope, options)
673
+ : broadcastFromRoot(scope, options, beginPageView(options.random));
451
674
  //# sourceMappingURL=broadcast.js.map