@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,90 @@
1
+ /**
2
+ * The grouping a person puts their applications into.
3
+ *
4
+ * Three levels, settled by the maintainer on 12 October: an **account** holds
5
+ * **projects**, and a project holds **applications**. The application is the
6
+ * unit everything is stored and governed under — it owns the pages, the
7
+ * signals, the policy and the credentials — and this is the folder it sits in.
8
+ *
9
+ * **It is organisational and nothing else, deliberately.** A project owns no
10
+ * policy, no members and no credentials today; those were named as later work
11
+ * and are not anticipated here, because a level that owns nothing is cheap to
12
+ * carry and a level that owns the wrong things is expensive to correct. What it
13
+ * has is an identity and a name, which is the whole of what grouping needs.
14
+ *
15
+ * Nothing scoped by an application is also scoped by a project, for the same
16
+ * reason: the project is reachable from the application, so storing it twice
17
+ * would be two places to disagree. When a project does own something — policy
18
+ * inherited by its applications is the likeliest — the edge to travel is
19
+ * `Application.projectId`, which already exists.
20
+ */
21
+ import { z } from "zod";
22
+ export declare const projectIdSchema: z.ZodBranded<z.ZodString, "ProjectId">;
23
+ export type ProjectId = z.infer<typeof projectIdSchema>;
24
+ /** A new project's id, minted when somebody makes one. Random, as an application's is. */
25
+ export declare const newProjectId: () => ProjectId;
26
+ /**
27
+ * The project every application written before projects existed belongs to.
28
+ *
29
+ * Nothing is migrated by guessing (0260, and its successor). The applications
30
+ * that exist belong to the deployment that wrote them, so they go into one
31
+ * project named for it rather than into a distribution somebody invented.
32
+ */
33
+ export declare const DEFAULT_PROJECT_ID: ProjectId;
34
+ /**
35
+ * What a deployment knows about one of its projects, which is as little as a
36
+ * grouping can be and still be one.
37
+ */
38
+ export declare const projectSchema: z.ZodObject<{
39
+ projectId: z.ZodBranded<z.ZodString, "ProjectId">;
40
+ /** What a person calls it. Not unique, not an identifier, and editable. */
41
+ name: z.ZodString;
42
+ createdAt: z.ZodString;
43
+ /**
44
+ * The repository this project's pages live in, or absent (0292).
45
+ *
46
+ * **At most one, and a repository belongs to at most one project**, which
47
+ * is what makes the write-back expressible: the first one is a pull
48
+ * request against the customer's repository (0275), and a pull request has
49
+ * exactly one destination. The uniqueness is the store's to
50
+ * enforce, because two projects claiming one repository is a race rather
51
+ * than a typo.
52
+ *
53
+ * Absent is the ordinary first state and stays legal: a project that keeps
54
+ * its tree in a working copy or in its own database has no repository, and
55
+ * being connected for observation alone needs none at all (0275).
56
+ *
57
+ * Spelled `owner/name`. Not a URL, because the forge is not in the value —
58
+ * a URL would make `github.com/a/b` and `https://github.com/a/b/` two
59
+ * repositories, and the uniqueness above is only as good as the spelling.
60
+ * What understands it is the write-back adapter, which does not exist yet.
61
+ */
62
+ repository: z.ZodOptional<z.ZodString>;
63
+ /**
64
+ * When it was closed, or absent while it is open (0289).
65
+ *
66
+ * Closing is what this store has instead of deleting: a project's rows are
67
+ * its applications' trees, revisions, holds and policy history, and a
68
+ * delete would either orphan them or cascade through the governance record
69
+ * Loom exists to keep.
70
+ *
71
+ * **An instant rather than a flag**, because *when* is the question anybody
72
+ * asks about a closed project — did this stop before or after the thing I
73
+ * am looking at — and a boolean cannot answer it for the same storage.
74
+ */
75
+ closedAt: z.ZodOptional<z.ZodString>;
76
+ }, "strict", z.ZodTypeAny, {
77
+ name: string;
78
+ projectId: string & z.BRAND<"ProjectId">;
79
+ createdAt: string;
80
+ repository?: string | undefined;
81
+ closedAt?: string | undefined;
82
+ }, {
83
+ name: string;
84
+ projectId: string;
85
+ createdAt: string;
86
+ repository?: string | undefined;
87
+ closedAt?: string | undefined;
88
+ }>;
89
+ export type Project = z.infer<typeof projectSchema>;
90
+ //# sourceMappingURL=project.d.ts.map
@@ -0,0 +1,91 @@
1
+ /**
2
+ * The grouping a person puts their applications into.
3
+ *
4
+ * Three levels, settled by the maintainer on 12 October: an **account** holds
5
+ * **projects**, and a project holds **applications**. The application is the
6
+ * unit everything is stored and governed under — it owns the pages, the
7
+ * signals, the policy and the credentials — and this is the folder it sits in.
8
+ *
9
+ * **It is organisational and nothing else, deliberately.** A project owns no
10
+ * policy, no members and no credentials today; those were named as later work
11
+ * and are not anticipated here, because a level that owns nothing is cheap to
12
+ * carry and a level that owns the wrong things is expensive to correct. What it
13
+ * has is an identity and a name, which is the whole of what grouping needs.
14
+ *
15
+ * Nothing scoped by an application is also scoped by a project, for the same
16
+ * reason: the project is reachable from the application, so storing it twice
17
+ * would be two places to disagree. When a project does own something — policy
18
+ * inherited by its applications is the likeliest — the edge to travel is
19
+ * `Application.projectId`, which already exists.
20
+ */
21
+ import { z } from "zod";
22
+ import { idPattern } from "../grammar.js";
23
+ import { randomIdBody } from "../ids.js";
24
+ /*
25
+ * `prj`, which is the prefix an application id wore until 12 October. It moves
26
+ * here rather than being retired because it always meant *the thing with a name
27
+ * that a person organises by*, and that is what a project is now. The ids that
28
+ * were minted under it belong to applications and are migrated to `app_`;
29
+ * nothing holds both meanings at once.
30
+ */
31
+ export const projectIdSchema = z.string().regex(idPattern("prj")).brand();
32
+ /** A new project's id, minted when somebody makes one. Random, as an application's is. */
33
+ export const newProjectId = () => projectIdSchema.parse(`prj_${randomIdBody()}`);
34
+ /**
35
+ * The project every application written before projects existed belongs to.
36
+ *
37
+ * Nothing is migrated by guessing (0260, and its successor). The applications
38
+ * that exist belong to the deployment that wrote them, so they go into one
39
+ * project named for it rather than into a distribution somebody invented.
40
+ */
41
+ export const DEFAULT_PROJECT_ID = projectIdSchema.parse("prj_default");
42
+ /**
43
+ * What a deployment knows about one of its projects, which is as little as a
44
+ * grouping can be and still be one.
45
+ */
46
+ export const projectSchema = z
47
+ .object({
48
+ projectId: projectIdSchema,
49
+ /** What a person calls it. Not unique, not an identifier, and editable. */
50
+ name: z.string().min(1).max(200),
51
+ createdAt: z.string().datetime(),
52
+ /**
53
+ * The repository this project's pages live in, or absent (0292).
54
+ *
55
+ * **At most one, and a repository belongs to at most one project**, which
56
+ * is what makes the write-back expressible: the first one is a pull
57
+ * request against the customer's repository (0275), and a pull request has
58
+ * exactly one destination. The uniqueness is the store's to
59
+ * enforce, because two projects claiming one repository is a race rather
60
+ * than a typo.
61
+ *
62
+ * Absent is the ordinary first state and stays legal: a project that keeps
63
+ * its tree in a working copy or in its own database has no repository, and
64
+ * being connected for observation alone needs none at all (0275).
65
+ *
66
+ * Spelled `owner/name`. Not a URL, because the forge is not in the value —
67
+ * a URL would make `github.com/a/b` and `https://github.com/a/b/` two
68
+ * repositories, and the uniqueness above is only as good as the spelling.
69
+ * What understands it is the write-back adapter, which does not exist yet.
70
+ */
71
+ repository: z
72
+ .string()
73
+ .regex(/^[A-Za-z0-9._-]+\/[A-Za-z0-9._-]+$/)
74
+ .max(140)
75
+ .optional(),
76
+ /**
77
+ * When it was closed, or absent while it is open (0289).
78
+ *
79
+ * Closing is what this store has instead of deleting: a project's rows are
80
+ * its applications' trees, revisions, holds and policy history, and a
81
+ * delete would either orphan them or cascade through the governance record
82
+ * Loom exists to keep.
83
+ *
84
+ * **An instant rather than a flag**, because *when* is the question anybody
85
+ * asks about a closed project — did this stop before or after the thing I
86
+ * am looking at — and a boolean cannot answer it for the same storage.
87
+ */
88
+ closedAt: z.string().datetime().optional(),
89
+ })
90
+ .strict();
91
+ //# sourceMappingURL=project.js.map
@@ -0,0 +1,135 @@
1
+ import type { Result } from "../result.js";
2
+ import type { Project, ProjectId } from "./project.js";
3
+ /**
4
+ * Custody of the projects a deployment has — the grouping, not the thing
5
+ * grouped.
6
+ *
7
+ * A project holds applications and nothing else, which is what makes this the
8
+ * shorter of the two stores: there is no host, because a project is not
9
+ * deployed anywhere, and no scope type, because nothing is stored *under* a
10
+ * project — the five scoped tables name their application, and the application
11
+ * names its project.
12
+ *
13
+ * It has the same four methods and the same refusal to delete, for a reason
14
+ * that is one step removed but no weaker: deleting a project would orphan or
15
+ * cascade through every application in it, and each of those owns a governance
16
+ * record. *The project says it was closed* beats *the project is gone* here too.
17
+ */
18
+ export type ProjectStoreError =
19
+ /** No project under this id. */
20
+ {
21
+ readonly code: "not-found";
22
+ readonly projectId: ProjectId;
23
+ } | {
24
+ readonly code: "already-exists";
25
+ readonly projectId: ProjectId;
26
+ }
27
+ /**
28
+ * Another project already names this repository (0292).
29
+ *
30
+ * Its own code rather than `already-exists`, because the thing that is taken
31
+ * is not the thing the caller named: they asked for a new project and the
32
+ * collision is on a field. A screen can put this fault on the repository
33
+ * input, where `already-exists` has no input to point at.
34
+ */
35
+ | {
36
+ readonly code: "repository-taken";
37
+ readonly repository: string;
38
+ }
39
+ /** A row the current code cannot parse, which is a row an older one wrote. */
40
+ | {
41
+ readonly code: "unreadable";
42
+ readonly projectId: ProjectId;
43
+ readonly detail: string;
44
+ } | {
45
+ readonly code: "unavailable";
46
+ readonly detail: string;
47
+ };
48
+ export type ProjectStoreErrorCode = ProjectStoreError["code"];
49
+ /**
50
+ * The four codes, in the order a deployment meets them, for the same reason
51
+ * `storeErrorCodes` exists: anything that walks the taxonomy rather than
52
+ * reacting to one member otherwise keeps a copy that is silently wrong the day
53
+ * a fifth lands.
54
+ */
55
+ export declare const projectStoreErrorCodes: readonly ProjectStoreErrorCode[];
56
+ export declare const describeProjectStoreError: (error: ProjectStoreError) => string;
57
+ /**
58
+ * What a listing is asked for (0289).
59
+ *
60
+ * Absent means **open only**, which is what every caller written before closing
61
+ * existed already meant. A listing that defaulted to everything would put a
62
+ * closed row back on the screen that closed it, and a caller that genuinely
63
+ * wants the audit — everything, open or not — says so.
64
+ */
65
+ export type Listing = {
66
+ /** `true` for closed only, `false` or absent for open only, `"all"` for both. */
67
+ readonly closed?: boolean | "all";
68
+ };
69
+ /**
70
+ * Whether a row belongs in this listing, as one function both stores and both
71
+ * implementations use.
72
+ *
73
+ * Here rather than in each of the four, because *what `closed` means* is the
74
+ * kind of three-case rule that two copies agree about until somebody adds the
75
+ * third case to one of them.
76
+ */
77
+ export declare const matchesListing: (closedAt: string | undefined, listing?: Listing) => boolean;
78
+ /**
79
+ * Six methods, and still **no delete**.
80
+ *
81
+ * That is the same refusal `TreeStore` makes and for a stronger reason here: a
82
+ * project's rows are its trees, its revisions, its holds, its policy history
83
+ * and its journal, and a delete would either orphan all of them or cascade
84
+ * through the governance record this product exists to keep. *The project says
85
+ * it was closed* is a better answer than *the project is gone* — and closing is
86
+ * not built here either, because nothing can close what nothing has yet opened.
87
+ * When it is wanted it is a column and a filter, not a `DELETE`.
88
+ */
89
+ export type ProjectStore = {
90
+ /**
91
+ * Record a project. Refuses an id already taken rather than overwriting,
92
+ * because the thing under that id owns rows.
93
+ */
94
+ readonly create: (project: Project) => Promise<Result<Project, ProjectStoreError>>;
95
+ /** One project. */
96
+ readonly get: (projectId: ProjectId) => Promise<Result<Project, ProjectStoreError>>;
97
+ /**
98
+ * Every project, oldest first.
99
+ *
100
+ * Unpaginated, and that is a judgement rather than an oversight: this is the
101
+ * list a person scans on one screen, and a deployment whose project count
102
+ * needs a cursor has a different screen's problem. `TreeStore.list` takes a
103
+ * limit because pages are unbounded in a way projects are not.
104
+ */
105
+ readonly list: (listing?: Listing) => Promise<Result<readonly Project[], ProjectStoreError>>;
106
+ /** Change what a person calls it. */
107
+ readonly rename: (projectId: ProjectId, to: {
108
+ readonly name: string;
109
+ }) => Promise<Result<Project, ProjectStoreError>>;
110
+ /**
111
+ * Stop it, without losing it (0289).
112
+ *
113
+ * **This closes the project row and nothing else.** Closing a project also
114
+ * closes the applications in it, and that cascade is `closeProject` in
115
+ * `src/project/closing.ts` rather than a line in here: this store knows
116
+ * nothing about applications, and a store that reached into another one to
117
+ * finish a write would be the coupling both of them are shaped to avoid.
118
+ *
119
+ * Idempotent on a project already closed — the instant is not moved, because
120
+ * the answer to *when did this stop* must not change because somebody pressed
121
+ * the button twice.
122
+ */
123
+ readonly close: (projectId: ProjectId, at: string) => Promise<Result<Project, ProjectStoreError>>;
124
+ /**
125
+ * The inverse, and **not symmetric**: reopening a project does not reopen its
126
+ * applications.
127
+ *
128
+ * Closing is a statement about the project; reopening one of its applications
129
+ * is a decision about that application. A reopen that revived everything
130
+ * would turn *I want that one back* into *start collecting on all nine
131
+ * again*.
132
+ */
133
+ readonly reopen: (projectId: ProjectId) => Promise<Result<Project, ProjectStoreError>>;
134
+ };
135
+ //# sourceMappingURL=store.d.ts.map
@@ -0,0 +1,41 @@
1
+ /**
2
+ * The four codes, in the order a deployment meets them, for the same reason
3
+ * `storeErrorCodes` exists: anything that walks the taxonomy rather than
4
+ * reacting to one member otherwise keeps a copy that is silently wrong the day
5
+ * a fifth lands.
6
+ */
7
+ export const projectStoreErrorCodes = [
8
+ "not-found",
9
+ "already-exists",
10
+ "repository-taken",
11
+ "unreadable",
12
+ "unavailable",
13
+ ];
14
+ export const describeProjectStoreError = (error) => {
15
+ switch (error.code) {
16
+ case "not-found":
17
+ return `no project ${error.projectId}`;
18
+ case "already-exists":
19
+ return `project ${error.projectId} already exists`;
20
+ case "repository-taken":
21
+ return `another project already names ${error.repository}`;
22
+ case "unreadable":
23
+ return `project ${error.projectId} could not be read: ${error.detail}`;
24
+ case "unavailable":
25
+ return `the project store is unavailable: ${error.detail}`;
26
+ }
27
+ };
28
+ /**
29
+ * Whether a row belongs in this listing, as one function both stores and both
30
+ * implementations use.
31
+ *
32
+ * Here rather than in each of the four, because *what `closed` means* is the
33
+ * kind of three-case rule that two copies agree about until somebody adds the
34
+ * third case to one of them.
35
+ */
36
+ export const matchesListing = (closedAt, listing) => {
37
+ if (listing?.closed === "all")
38
+ return true;
39
+ return listing?.closed === true ? closedAt !== undefined : closedAt === undefined;
40
+ };
41
+ //# sourceMappingURL=store.js.map
@@ -0,0 +1,64 @@
1
+ /**
2
+ * Naming what a deployment registered, to somebody who named something else.
3
+ *
4
+ * Three seams refuse an unknown id the same way — a palette, a data source, a
5
+ * submission endpoint — and each answers by listing what it does have, so that
6
+ * whoever reads the log can see what they should have written. The instinct is
7
+ * right and the list is the wrong shape for it: its length is the deployment's
8
+ * to set rather than the runtime's, so a host with a palette per brand turns one
9
+ * diagnostic into a paragraph, in every log line and every panel that prints it.
10
+ *
11
+ * What this bounds is the sentence and nothing else. A refusal still carries
12
+ * every id it knows where a caller can read it, and a registry still publishes
13
+ * its whole catalogue, so the names past the cap are a lookup away rather than
14
+ * gone. The sentence has the narrower job: put the id the reader probably meant
15
+ * in front of them, and say how many it is standing in for.
16
+ */
17
+ /**
18
+ * How many names a refusal puts in front of a reader.
19
+ *
20
+ * Five, against a measurement: the twenty-four render diagnostics printed side
21
+ * by side came to a median of 144 characters, and the unresolved-theme sentence
22
+ * came to 284 — of which 172 were this list at twenty-one palettes. Five ids of
23
+ * ordinary length is about fifty, which keeps the clause the smaller half of a
24
+ * sentence it used to be the larger half of.
25
+ */
26
+ export declare const NEAREST_REGISTERED = 5;
27
+ /**
28
+ * The registered ids closest to the one that was asked for, nearest first.
29
+ *
30
+ * Ranking is what makes a capped list worth reading: the reason to print the
31
+ * registry at all is that the right answer is almost always one of a short
32
+ * list, and the first five in registration order bear no relation to what
33
+ * somebody meant to type.
34
+ *
35
+ * It ranks strings and claims no more than that. Nothing in `sunset` says it
36
+ * and `ember` are both warm, so nothing here will offer `ember`; a seam that
37
+ * wants meaning has to rank on something other than spelling.
38
+ */
39
+ export declare const nearestRegistered: (wanted: string, available: readonly string[], limit?: number) => readonly string[];
40
+ /**
41
+ * The clause a refusal ends on: what to write instead of what was written.
42
+ *
43
+ * Three forms, and which one appears is a fact about the deployment. An empty
44
+ * registry says so in a word. A registry that fits is printed whole. One that
45
+ * does not is printed to the cap and then says what it is standing in for —
46
+ * `(nearest 5 of 21)` rather than a trailing count alone, because five ids with
47
+ * no explanation read as the first five somebody registered, which would send a
48
+ * reader looking in the wrong place.
49
+ *
50
+ * **Fitting is one more than the cap**, and that is not an off-by-one. Hiding a
51
+ * single id costs more than showing it: `(nearest 5 of 6)` is seventeen
52
+ * characters to withhold a name that would have cost about twelve. Measured on
53
+ * a real case — the six sources a lesson registers — eliding one saved a single
54
+ * character. The cap is there to bound the clause, so it gives way where it
55
+ * would not.
56
+ *
57
+ * **A list printed whole keeps the order it was registered in**, and only a
58
+ * capped one is ranked. Ranking is how the few are *chosen*; where nothing is
59
+ * being chosen it buys nothing and costs the host its own order, and it would
60
+ * make the same registry print in a different order for every id somebody
61
+ * mistyped — output that cannot be compared between two refusals.
62
+ */
63
+ export declare const describeRegistered: (wanted: string, available: readonly string[]) => string;
64
+ //# sourceMappingURL=registered.d.ts.map
@@ -0,0 +1,118 @@
1
+ /**
2
+ * Naming what a deployment registered, to somebody who named something else.
3
+ *
4
+ * Three seams refuse an unknown id the same way — a palette, a data source, a
5
+ * submission endpoint — and each answers by listing what it does have, so that
6
+ * whoever reads the log can see what they should have written. The instinct is
7
+ * right and the list is the wrong shape for it: its length is the deployment's
8
+ * to set rather than the runtime's, so a host with a palette per brand turns one
9
+ * diagnostic into a paragraph, in every log line and every panel that prints it.
10
+ *
11
+ * What this bounds is the sentence and nothing else. A refusal still carries
12
+ * every id it knows where a caller can read it, and a registry still publishes
13
+ * its whole catalogue, so the names past the cap are a lookup away rather than
14
+ * gone. The sentence has the narrower job: put the id the reader probably meant
15
+ * in front of them, and say how many it is standing in for.
16
+ */
17
+ /**
18
+ * How many names a refusal puts in front of a reader.
19
+ *
20
+ * Five, against a measurement: the twenty-four render diagnostics printed side
21
+ * by side came to a median of 144 characters, and the unresolved-theme sentence
22
+ * came to 284 — of which 172 were this list at twenty-one palettes. Five ids of
23
+ * ordinary length is about fifty, which keeps the clause the smaller half of a
24
+ * sentence it used to be the larger half of.
25
+ */
26
+ export const NEAREST_REGISTERED = 5;
27
+ /** One row of the matrix, from the row above it and the character it is for. */
28
+ const nextRow = (fromCharacter, to, previous, rowIndex) => to.reduce((current, toCharacter, column) => current.concat(Math.min((previous[column] ?? 0) + (fromCharacter === toCharacter ? 0 : 1), (previous[column + 1] ?? 0) + 1, (current[column] ?? 0) + 1)), [rowIndex + 1]);
29
+ /**
30
+ * How many single-character edits turn one id into the other.
31
+ *
32
+ * Two rows rather than a whole matrix, because the only thing ever asked of the
33
+ * result is its size, and the row being built is the only one the next row
34
+ * needs.
35
+ */
36
+ const editDistance = (from, to) => {
37
+ if (from === to)
38
+ return 0;
39
+ const target = [...to];
40
+ const last = [...from].reduce((previous, fromCharacter, rowIndex) => nextRow(fromCharacter, target, previous, rowIndex), Array.from({ length: target.length + 1 }, (_, index) => index));
41
+ return last[target.length] ?? 0;
42
+ };
43
+ /**
44
+ * Whether one id is written inside the other, which outranks distance.
45
+ *
46
+ * The two mistakes that actually happen are not the same shape. A misspelling
47
+ * is a short edit — `sunsset` for `sunset` — and distance finds it. A half-typed
48
+ * name is a long one: `cat` is fifteen edits from `catalogue.services` and nine
49
+ * from `crm.contacts`, so distance on its own answers a truncation with the
50
+ * wrong part of the registry. Containment is checked first for that case alone.
51
+ */
52
+ const written = (sought, candidate) => sought.length > 0 && (candidate.includes(sought) || sought.includes(candidate)) ? 0 : 1;
53
+ /**
54
+ * The registered ids closest to the one that was asked for, nearest first.
55
+ *
56
+ * Ranking is what makes a capped list worth reading: the reason to print the
57
+ * registry at all is that the right answer is almost always one of a short
58
+ * list, and the first five in registration order bear no relation to what
59
+ * somebody meant to type.
60
+ *
61
+ * It ranks strings and claims no more than that. Nothing in `sunset` says it
62
+ * and `ember` are both warm, so nothing here will offer `ember`; a seam that
63
+ * wants meaning has to rank on something other than spelling.
64
+ */
65
+ export const nearestRegistered = (wanted, available, limit = NEAREST_REGISTERED) => {
66
+ const sought = wanted.toLowerCase();
67
+ const kept = Math.max(0, limit);
68
+ /** Nothing to be near. Registration order is the only non-arbitrary answer. */
69
+ if (sought.length === 0)
70
+ return available.slice(0, kept);
71
+ return available
72
+ .map((id, index) => {
73
+ const candidate = id.toLowerCase();
74
+ return {
75
+ id,
76
+ index,
77
+ written: written(sought, candidate),
78
+ distance: editDistance(sought, candidate),
79
+ };
80
+ })
81
+ .sort((left, right) => left.written - right.written ||
82
+ left.distance - right.distance ||
83
+ left.index - right.index)
84
+ .slice(0, kept)
85
+ .map((ranked) => ranked.id);
86
+ };
87
+ /**
88
+ * The clause a refusal ends on: what to write instead of what was written.
89
+ *
90
+ * Three forms, and which one appears is a fact about the deployment. An empty
91
+ * registry says so in a word. A registry that fits is printed whole. One that
92
+ * does not is printed to the cap and then says what it is standing in for —
93
+ * `(nearest 5 of 21)` rather than a trailing count alone, because five ids with
94
+ * no explanation read as the first five somebody registered, which would send a
95
+ * reader looking in the wrong place.
96
+ *
97
+ * **Fitting is one more than the cap**, and that is not an off-by-one. Hiding a
98
+ * single id costs more than showing it: `(nearest 5 of 6)` is seventeen
99
+ * characters to withhold a name that would have cost about twelve. Measured on
100
+ * a real case — the six sources a lesson registers — eliding one saved a single
101
+ * character. The cap is there to bound the clause, so it gives way where it
102
+ * would not.
103
+ *
104
+ * **A list printed whole keeps the order it was registered in**, and only a
105
+ * capped one is ranked. Ranking is how the few are *chosen*; where nothing is
106
+ * being chosen it buys nothing and costs the host its own order, and it would
107
+ * make the same registry print in a different order for every id somebody
108
+ * mistyped — output that cannot be compared between two refusals.
109
+ */
110
+ export const describeRegistered = (wanted, available) => {
111
+ if (available.length === 0)
112
+ return "none";
113
+ if (available.length <= NEAREST_REGISTERED + 1)
114
+ return available.join(", ");
115
+ const nearest = nearestRegistered(wanted, available);
116
+ return `${nearest.join(", ")} (nearest ${nearest.length} of ${available.length})`;
117
+ };
118
+ //# sourceMappingURL=registered.js.map
@@ -0,0 +1,35 @@
1
+ /**
2
+ * The root of an addressed page within `scope`, or `undefined` if there is none.
3
+ *
4
+ * The root is the one element carrying the tree it belongs to, so this is the
5
+ * element a reader-signal broadcast asks for. A host passes `document` on a
6
+ * page it serves whole, or the container it rendered a tree into when the page
7
+ * holds other things as well.
8
+ *
9
+ * **The scope counts as its own answer.** `querySelector` searches descendants
10
+ * only, so a host holding the root element and asking this for the root would
11
+ * be told there is none — the one answer that is never useful. Including the
12
+ * scope makes the function idempotent instead: feeding it its own result
13
+ * returns that result.
14
+ *
15
+ * **The first in document order when a scope holds more than one tree**, which
16
+ * is `querySelector`'s own rule rather than a new one. A host rendering two
17
+ * trees knows where it put them and should ask within each; a host that does
18
+ * not know would not be helped by a different choice here.
19
+ *
20
+ * `undefined` rather than `null` because *there is no addressed page here* is
21
+ * the absence of an answer rather than an answer, and because a caller reaching
22
+ * through an optional ref otherwise has two empty values to test for on the way
23
+ * out where one will do.
24
+ *
25
+ * The saving is on the way **out** and not on the way in: `scope` is
26
+ * `ParentNode`, so a caller guards its ref and then asks —
27
+ * `container === null ? undefined : addressedRootIn(container)`, which is what
28
+ * `reader-signals-live.tsx` writes. An earlier version of this note showed
29
+ * `addressedRootIn(frame.current)`, which does not typecheck. The narrow
30
+ * parameter is the honest type for a function whose contract is *somewhere to
31
+ * look*.
32
+ */
33
+ export declare const addressedRootIn: (scope: ParentNode) => Element | undefined;
34
+ export { LOOM_AUDIENCE_ATTRIBUTE, LOOM_NODE_ATTRIBUTE, LOOM_REVISION_ATTRIBUTE, LOOM_TREE_ATTRIBUTE, LOOM_TYPE_ATTRIBUTE, } from "./editable.js";
35
+ //# sourceMappingURL=addressed.d.ts.map
@@ -0,0 +1,79 @@
1
+ import { LOOM_TREE_ATTRIBUTE } from "./editable.js";
2
+ /**
3
+ * The names a render writes onto a published page, and how to find the page.
4
+ *
5
+ * `addressed: true` stamps a node's identity onto the markup of a live page:
6
+ * node id and type on each decorated element, tree id and revision on the root
7
+ * (0136). Those four names are the whole of the contract between a render and
8
+ * anything that reads a published page afterwards — a broadcaster gathering
9
+ * reader signals, a portal authoring an intent from the DOM, a script bringing
10
+ * a named node into view.
11
+ *
12
+ * **This module exists so that reading them costs a browser nothing.** The
13
+ * names were published only through `@jam-overture/loom/react`, which carries
14
+ * the render seam and every primitive's registration, so a browser bundle that
15
+ * imported one string from there carried all of it. That is the mistake the
16
+ * broadcaster's own entry point was split out to stop and the one `disclosed.ts`
17
+ * was pulled out of `behaviour.ts` to avoid (0136), and it is invisible in a
18
+ * diff: one import line, every test green.
19
+ *
20
+ * So the choice a host faced was a heavy import or a hand-written
21
+ * `"[data-loom-tree]"`, and the hosts that ship a browser bundle wrote the
22
+ * literal. Measured in this repository on 5 November: the spelling written out
23
+ * by hand in four files, the constant imported from the heavy door in two more,
24
+ * one of which is a client component that reaches it for a single string.
25
+ *
26
+ * Nothing here loads a package, which `addressed.weight.test.ts` holds it to by
27
+ * walking what it imports rather than by trusting this paragraph.
28
+ *
29
+ * **Reading, not writing.** `editableAttributes` builds the attributes and
30
+ * stays on the render seam, where the tree types it needs already are. A host
31
+ * does not write these names; the renderer does.
32
+ */
33
+ /**
34
+ * By node type rather than `instanceof Element`, which is false for an element
35
+ * from another realm — an iframe's document has an `Element` of its own, and a
36
+ * page inspecting a frame it rendered is a host this door is for. A node type
37
+ * is a number the DOM agrees on across realms, so the test does not have to
38
+ * know which one it is in.
39
+ */
40
+ const isElement = (node) => node.nodeType === 1;
41
+ /**
42
+ * The root of an addressed page within `scope`, or `undefined` if there is none.
43
+ *
44
+ * The root is the one element carrying the tree it belongs to, so this is the
45
+ * element a reader-signal broadcast asks for. A host passes `document` on a
46
+ * page it serves whole, or the container it rendered a tree into when the page
47
+ * holds other things as well.
48
+ *
49
+ * **The scope counts as its own answer.** `querySelector` searches descendants
50
+ * only, so a host holding the root element and asking this for the root would
51
+ * be told there is none — the one answer that is never useful. Including the
52
+ * scope makes the function idempotent instead: feeding it its own result
53
+ * returns that result.
54
+ *
55
+ * **The first in document order when a scope holds more than one tree**, which
56
+ * is `querySelector`'s own rule rather than a new one. A host rendering two
57
+ * trees knows where it put them and should ask within each; a host that does
58
+ * not know would not be helped by a different choice here.
59
+ *
60
+ * `undefined` rather than `null` because *there is no addressed page here* is
61
+ * the absence of an answer rather than an answer, and because a caller reaching
62
+ * through an optional ref otherwise has two empty values to test for on the way
63
+ * out where one will do.
64
+ *
65
+ * The saving is on the way **out** and not on the way in: `scope` is
66
+ * `ParentNode`, so a caller guards its ref and then asks —
67
+ * `container === null ? undefined : addressedRootIn(container)`, which is what
68
+ * `reader-signals-live.tsx` writes. An earlier version of this note showed
69
+ * `addressedRootIn(frame.current)`, which does not typecheck. The narrow
70
+ * parameter is the honest type for a function whose contract is *somewhere to
71
+ * look*.
72
+ */
73
+ export const addressedRootIn = (scope) => {
74
+ if (isElement(scope) && scope.hasAttribute(LOOM_TREE_ATTRIBUTE))
75
+ return scope;
76
+ return scope.querySelector(`[${LOOM_TREE_ATTRIBUTE}]`) ?? undefined;
77
+ };
78
+ export { LOOM_AUDIENCE_ATTRIBUTE, LOOM_NODE_ATTRIBUTE, LOOM_REVISION_ATTRIBUTE, LOOM_TREE_ATTRIBUTE, LOOM_TYPE_ATTRIBUTE, } from "./editable.js";
79
+ //# sourceMappingURL=addressed.js.map