@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.
- package/README.md +3 -1
- package/dist/application/application.d.ts +109 -0
- package/dist/application/application.js +97 -0
- package/dist/application/memory.d.ts +20 -0
- package/dist/application/memory.js +79 -0
- package/dist/application/store.d.ts +101 -0
- package/dist/application/store.js +25 -0
- package/dist/audience/audience.d.ts +36 -0
- package/dist/audience/audience.js +41 -0
- package/dist/audience/compose.d.ts +112 -0
- package/dist/audience/compose.js +134 -0
- package/dist/audience/memory.d.ts +14 -0
- package/dist/audience/memory.js +71 -0
- package/dist/audience/overlay-store.d.ts +343 -0
- package/dist/audience/overlay-store.js +217 -0
- package/dist/audience/rule.d.ts +121 -0
- package/dist/audience/rule.js +78 -0
- package/dist/cli/index.d.ts +3 -4
- package/dist/cli/index.js +3 -4
- package/dist/cli/templates.js +19 -0
- package/dist/data/adapter.d.ts +9 -1
- package/dist/data/adapter.js +2 -0
- package/dist/data/plan.js +0 -0
- package/dist/data/resolution.d.ts +23 -1
- package/dist/data/resolve.d.ts +31 -4
- package/dist/data/resolve.js +11 -3
- package/dist/ids.d.ts +10 -0
- package/dist/ids.js +11 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.js +1 -0
- package/dist/interpretation/anthropic.d.ts +1 -1
- package/dist/interpretation/anthropic.js +2 -22
- package/dist/interpretation/client.d.ts +1 -1
- package/dist/interpretation/materialize.js +67 -22
- package/dist/interpretation/openai-compatible.d.ts +36 -0
- package/dist/interpretation/openai-compatible.js +79 -0
- package/dist/interpretation/status.d.ts +19 -0
- package/dist/interpretation/status.js +26 -0
- package/dist/live/index.d.ts +73 -0
- package/dist/live/index.js +73 -0
- package/dist/live/pages.d.ts +187 -0
- package/dist/live/pages.js +161 -0
- package/dist/live/pull.d.ts +147 -0
- package/dist/live/pull.js +398 -0
- package/dist/live/pulling.d.ts +79 -0
- package/dist/live/pulling.js +117 -0
- package/dist/live/window.d.ts +129 -0
- package/dist/live/window.js +132 -0
- package/dist/patch.d.ts +54 -0
- package/dist/patch.js +44 -0
- package/dist/project/closing.d.ts +51 -0
- package/dist/project/closing.js +53 -0
- package/dist/project/memory.d.ts +20 -0
- package/dist/project/memory.js +97 -0
- package/dist/project/project.d.ts +90 -0
- package/dist/project/project.js +91 -0
- package/dist/project/store.d.ts +135 -0
- package/dist/project/store.js +41 -0
- package/dist/registered.d.ts +64 -0
- package/dist/registered.js +118 -0
- package/dist/render/addressed.d.ts +35 -0
- package/dist/render/addressed.js +79 -0
- package/dist/render/behaviour-adjust.d.ts +11 -19
- package/dist/render/behaviour-adjust.js +75 -21
- package/dist/render/behaviour-present.d.ts +8 -0
- package/dist/render/behaviour-present.js +57 -6
- package/dist/render/behaviour.d.ts +98 -17
- package/dist/render/behaviour.js +91 -26
- package/dist/render/control-name.d.ts +68 -0
- package/dist/render/control-name.js +37 -0
- package/dist/render/diagnostics.d.ts +72 -0
- package/dist/render/diagnostics.js +7 -0
- package/dist/render/document-theme.d.ts +70 -0
- package/dist/render/document-theme.js +139 -0
- package/dist/render/editable.d.ts +15 -1
- package/dist/render/editable.js +13 -1
- package/dist/render/expected.d.ts +98 -0
- package/dist/render/expected.js +88 -0
- package/dist/render/index.d.ts +4 -0
- package/dist/render/index.js +4 -0
- package/dist/render/reads.d.ts +11 -0
- package/dist/render/reads.js +12 -1
- package/dist/render/render.d.ts +11 -0
- package/dist/render/render.js +294 -53
- package/dist/render/request.d.ts +8 -1
- package/dist/render/request.js +1 -0
- package/dist/render/slots.d.ts +52 -0
- package/dist/render/slots.js +24 -0
- package/dist/render/theme.d.ts +54 -1
- package/dist/render/theme.js +23 -1
- package/dist/render/unshown.d.ts +152 -0
- package/dist/render/unshown.js +80 -0
- package/dist/runtime/analysis.d.ts +94 -9
- package/dist/runtime/analysis.js +54 -9
- package/dist/runtime/assessment.d.ts +36 -2
- package/dist/runtime/assessment.js +27 -2
- package/dist/runtime/auto-apply-ceiling.d.ts +54 -0
- package/dist/runtime/auto-apply-ceiling.js +66 -0
- package/dist/runtime/checks.d.ts +148 -0
- package/dist/runtime/checks.js +112 -0
- package/dist/runtime/disposition.d.ts +96 -0
- package/dist/runtime/disposition.js +46 -0
- package/dist/runtime/gate.js +91 -10
- package/dist/runtime/index.d.ts +4 -0
- package/dist/runtime/index.js +4 -0
- package/dist/runtime/irreversibility.d.ts +64 -0
- package/dist/runtime/irreversibility.js +45 -0
- package/dist/runtime/nesting.d.ts +13 -1
- package/dist/runtime/nesting.js +41 -24
- package/dist/runtime/pipeline.d.ts +43 -0
- package/dist/runtime/pipeline.js +10 -2
- package/dist/runtime/policy-change.d.ts +93 -0
- package/dist/runtime/policy-change.js +305 -0
- package/dist/runtime/policy-log.d.ts +406 -0
- package/dist/runtime/policy-log.js +285 -0
- package/dist/runtime/policy.d.ts +8 -6
- package/dist/runtime/policy.js +5 -2
- package/dist/runtime/repointing.js +0 -0
- package/dist/runtime/reversibility.d.ts +11 -9
- package/dist/runtime/stakes.d.ts +129 -1
- package/dist/runtime/stakes.js +240 -26
- package/dist/runtime/vocabulary.d.ts +164 -7
- package/dist/runtime/vocabulary.js +181 -8
- package/dist/sdk/audit.d.ts +174 -3
- package/dist/sdk/audit.js +176 -17
- package/dist/sdk/catalogue.d.ts +9 -1
- package/dist/sdk/conformance.d.ts +37 -3
- package/dist/sdk/conformance.js +25 -4
- package/dist/sdk/definition.d.ts +129 -5
- package/dist/sdk/definition.js +66 -0
- package/dist/sdk/registry.d.ts +45 -2
- package/dist/sdk/registry.js +102 -1
- package/dist/signals/acted.contract.d.ts +21 -0
- package/dist/signals/acted.contract.js +236 -0
- package/dist/signals/acted.d.ts +359 -0
- package/dist/signals/acted.js +135 -0
- package/dist/signals/action-change.d.ts +507 -0
- package/dist/signals/action-change.js +265 -0
- package/dist/signals/action.d.ts +331 -0
- package/dist/signals/action.js +182 -0
- package/dist/signals/agenda.d.ts +585 -0
- package/dist/signals/agenda.js +295 -0
- package/dist/signals/applied-window.contract.d.ts +23 -0
- package/dist/signals/applied-window.contract.js +160 -0
- package/dist/signals/arrivals.contract.d.ts +21 -0
- package/dist/signals/arrivals.contract.js +180 -0
- package/dist/signals/arrivals.d.ts +375 -0
- package/dist/signals/arrivals.js +254 -0
- package/dist/signals/arriving.d.ts +210 -0
- package/dist/signals/arriving.js +133 -0
- package/dist/signals/audiences.d.ts +528 -0
- package/dist/signals/audiences.js +255 -0
- package/dist/signals/broadcast.d.ts +33 -17
- package/dist/signals/broadcast.js +255 -32
- package/dist/signals/change.d.ts +378 -0
- package/dist/signals/change.js +327 -0
- package/dist/signals/collect.d.ts +169 -34
- package/dist/signals/collect.js +186 -38
- package/dist/signals/conversion.d.ts +348 -0
- package/dist/signals/conversion.js +235 -0
- package/dist/signals/copy-change.d.ts +553 -0
- package/dist/signals/copy-change.js +377 -0
- package/dist/signals/copy.d.ts +337 -0
- package/dist/signals/copy.js +211 -0
- package/dist/signals/correlated.contract.d.ts +24 -0
- package/dist/signals/correlated.contract.js +94 -0
- package/dist/signals/counters.d.ts +97 -0
- package/dist/signals/counters.js +160 -0
- package/dist/signals/deliver.d.ts +23 -4
- package/dist/signals/deliver.js +34 -6
- package/dist/signals/deployment-change.d.ts +395 -0
- package/dist/signals/deployment-change.js +309 -0
- package/dist/signals/deployment.d.ts +278 -0
- package/dist/signals/deployment.js +178 -0
- package/dist/signals/door.d.ts +114 -0
- package/dist/signals/door.js +77 -0
- package/dist/signals/expire.d.ts +192 -0
- package/dist/signals/expire.js +213 -0
- package/dist/signals/fold.d.ts +10 -0
- package/dist/signals/fold.js +5 -1
- package/dist/signals/form-action.d.ts +302 -0
- package/dist/signals/form-action.js +169 -0
- package/dist/signals/form-copy.d.ts +523 -0
- package/dist/signals/form-copy.js +346 -0
- package/dist/signals/forms.d.ts +247 -0
- package/dist/signals/forms.js +147 -0
- package/dist/signals/frontier.d.ts +268 -0
- package/dist/signals/frontier.js +145 -0
- package/dist/signals/funnel-change.d.ts +548 -0
- package/dist/signals/funnel-change.js +361 -0
- package/dist/signals/funnel-hours.contract.d.ts +21 -0
- package/dist/signals/funnel-hours.contract.js +221 -0
- package/dist/signals/funnel-hours.d.ts +293 -0
- package/dist/signals/funnel-hours.js +99 -0
- package/dist/signals/funnel.d.ts +592 -0
- package/dist/signals/funnel.js +231 -0
- package/dist/signals/health.d.ts +694 -0
- package/dist/signals/health.js +573 -0
- package/dist/signals/index.d.ts +60 -0
- package/dist/signals/index.js +60 -0
- package/dist/signals/ingest.d.ts +56 -1
- package/dist/signals/ingest.js +91 -1
- package/dist/signals/inside.d.ts +190 -0
- package/dist/signals/inside.js +263 -0
- package/dist/signals/join.d.ts +56 -0
- package/dist/signals/join.js +60 -0
- package/dist/signals/journal.d.ts +123 -9
- package/dist/signals/kept.contract.d.ts +22 -0
- package/dist/signals/kept.contract.js +111 -0
- package/dist/signals/kinds.d.ts +8 -6
- package/dist/signals/kinds.js +14 -6
- package/dist/signals/library-action.d.ts +430 -0
- package/dist/signals/library-action.js +336 -0
- package/dist/signals/library-agenda-change.d.ts +324 -0
- package/dist/signals/library-agenda-change.js +199 -0
- package/dist/signals/library-agenda.d.ts +258 -0
- package/dist/signals/library-agenda.js +167 -0
- package/dist/signals/library-change.d.ts +477 -0
- package/dist/signals/library-change.js +335 -0
- package/dist/signals/library-copy-change.d.ts +498 -0
- package/dist/signals/library-copy-change.js +476 -0
- package/dist/signals/library-pace.d.ts +319 -0
- package/dist/signals/library-pace.js +305 -0
- package/dist/signals/library-reach-change.d.ts +646 -0
- package/dist/signals/library-reach-change.js +542 -0
- package/dist/signals/library-reach.d.ts +377 -0
- package/dist/signals/library-reach.js +227 -0
- package/dist/signals/library-senders-change.d.ts +457 -0
- package/dist/signals/library-senders-change.js +367 -0
- package/dist/signals/library-senders-reach-change.d.ts +486 -0
- package/dist/signals/library-senders-reach-change.js +538 -0
- package/dist/signals/library-senders-reach.d.ts +340 -0
- package/dist/signals/library-senders-reach.js +252 -0
- package/dist/signals/library-senders.d.ts +271 -0
- package/dist/signals/library-senders.js +180 -0
- package/dist/signals/library-word-reach-change.d.ts +567 -0
- package/dist/signals/library-word-reach-change.js +564 -0
- package/dist/signals/library.d.ts +306 -0
- package/dist/signals/library.js +178 -0
- package/dist/signals/memory.d.ts +9 -0
- package/dist/signals/memory.js +246 -14
- package/dist/signals/migrate.d.ts +20 -4
- package/dist/signals/migrate.js +269 -8
- package/dist/signals/notice.d.ts +389 -0
- package/dist/signals/notice.js +250 -0
- package/dist/signals/pace-change.d.ts +501 -0
- package/dist/signals/pace-change.js +310 -0
- package/dist/signals/pace.d.ts +296 -0
- package/dist/signals/pace.js +291 -0
- package/dist/signals/page-views.d.ts +365 -0
- package/dist/signals/page-views.js +218 -0
- package/dist/signals/part-pace.d.ts +378 -0
- package/dist/signals/part-pace.js +333 -0
- package/dist/signals/parts.d.ts +354 -0
- package/dist/signals/parts.js +232 -0
- package/dist/signals/postgres.d.ts +16 -2
- package/dist/signals/postgres.js +753 -76
- package/dist/signals/progress.d.ts +212 -0
- package/dist/signals/progress.js +150 -0
- package/dist/signals/ratios.d.ts +108 -0
- package/dist/signals/ratios.js +40 -0
- package/dist/signals/reach.d.ts +309 -0
- package/dist/signals/reach.js +93 -0
- package/dist/signals/readable.d.ts +34 -0
- package/dist/signals/readable.js +34 -0
- package/dist/signals/readership.d.ts +381 -0
- package/dist/signals/readership.js +308 -0
- package/dist/signals/region-pages.d.ts +173 -0
- package/dist/signals/region-pages.js +62 -0
- package/dist/signals/region.d.ts +287 -0
- package/dist/signals/region.js +198 -0
- package/dist/signals/retention.d.ts +163 -0
- package/dist/signals/retention.js +75 -0
- package/dist/signals/rhythm.d.ts +302 -0
- package/dist/signals/rhythm.js +262 -0
- package/dist/signals/rollup.d.ts +194 -4
- package/dist/signals/rollup.js +0 -0
- package/dist/signals/schema.d.ts +1069 -1
- package/dist/signals/schema.js +393 -3
- package/dist/signals/signal.d.ts +237 -11
- package/dist/signals/signal.js +70 -10
- package/dist/signals/silence-census.d.ts +205 -0
- package/dist/signals/silence-census.js +87 -0
- package/dist/signals/silences.d.ts +1147 -0
- package/dist/signals/silences.js +996 -0
- package/dist/signals/subtrees.d.ts +123 -0
- package/dist/signals/subtrees.js +102 -0
- package/dist/signals/tally.d.ts +262 -12
- package/dist/signals/unread.d.ts +292 -0
- package/dist/signals/unread.js +137 -0
- package/dist/signals/window-agenda.d.ts +276 -0
- package/dist/signals/window-agenda.js +83 -0
- package/dist/signals/window-figures.d.ts +148 -0
- package/dist/signals/window-figures.js +42 -0
- package/dist/signals/window-funnels.d.ts +88 -0
- package/dist/signals/window-funnels.js +47 -0
- package/dist/signals/window.d.ts +866 -0
- package/dist/signals/window.js +693 -0
- package/dist/signals/words.d.ts +24 -0
- package/dist/signals/words.js +24 -0
- package/dist/store/cache.d.ts +101 -0
- package/dist/store/cache.js +149 -0
- package/dist/store/history.d.ts +82 -0
- package/dist/store/history.js +36 -0
- package/dist/store/index.d.ts +30 -0
- package/dist/store/index.js +30 -0
- package/dist/store/memory.d.ts +2 -1
- package/dist/store/memory.js +48 -12
- package/dist/store/migrate.d.ts +106 -0
- package/dist/store/migrate.js +323 -7
- package/dist/store/postgres-applications.d.ts +4 -0
- package/dist/store/postgres-applications.js +197 -0
- package/dist/store/postgres-audience.d.ts +14 -0
- package/dist/store/postgres-audience.js +272 -0
- package/dist/store/postgres-holds.d.ts +10 -1
- package/dist/store/postgres-holds.js +116 -101
- package/dist/store/postgres-policy-log.d.ts +14 -0
- package/dist/store/postgres-policy-log.js +240 -0
- package/dist/store/postgres-projects.d.ts +4 -0
- package/dist/store/postgres-projects.js +217 -0
- package/dist/store/postgres.d.ts +17 -1
- package/dist/store/postgres.js +60 -9
- package/dist/store/replay.d.ts +102 -1
- package/dist/store/replay.js +190 -19
- package/dist/store/reseed.d.ts +238 -0
- package/dist/store/reseed.js +308 -0
- package/dist/store/schema.d.ts +762 -2
- package/dist/store/schema.js +218 -5
- package/dist/store/source.d.ts +57 -1
- package/dist/store/source.js +65 -1
- package/dist/store/store.d.ts +29 -6
- package/dist/submit/resolve.d.ts +1 -1
- package/dist/submit/resolve.js +2 -1
- package/dist/telemetry/calibration.d.ts +25 -0
- package/dist/telemetry/calibration.js +27 -1
- package/dist/telemetry/event.d.ts +391 -33
- package/dist/telemetry/event.js +84 -20
- package/dist/telemetry/index.d.ts +2 -0
- package/dist/telemetry/index.js +2 -0
- package/dist/telemetry/journal.d.ts +104 -3
- package/dist/telemetry/journal.js +9 -0
- package/dist/telemetry/lookup.d.ts +27 -0
- package/dist/telemetry/lookup.js +18 -0
- package/dist/telemetry/memory.js +33 -1
- package/dist/telemetry/migrate.js +22 -1
- package/dist/telemetry/postgres.d.ts +10 -1
- package/dist/telemetry/postgres.js +188 -90
- package/dist/telemetry/remeasure.d.ts +78 -0
- package/dist/telemetry/remeasure.js +83 -0
- package/dist/telemetry/retention.d.ts +2 -2
- package/dist/telemetry/schema.d.ts +17 -0
- package/dist/telemetry/schema.js +27 -1
- package/dist/telemetry/sink.d.ts +2 -2
- package/dist/telemetry/window.d.ts +135 -0
- package/dist/telemetry/window.js +101 -0
- package/dist/testing/application-contract.d.ts +14 -0
- package/dist/testing/application-contract.js +270 -0
- package/dist/testing/audience-overlay-contract.d.ts +31 -0
- package/dist/testing/audience-overlay-contract.js +354 -0
- package/dist/testing/contracts.d.ts +13 -7
- package/dist/testing/contracts.js +13 -7
- package/dist/testing/definitions.d.ts +78 -0
- package/dist/testing/definitions.js +134 -9
- package/dist/testing/doubles.d.ts +103 -0
- package/dist/testing/doubles.js +143 -0
- package/dist/testing/index.d.ts +2 -2
- package/dist/testing/index.js +2 -2
- package/dist/testing/journal-contract.js +297 -6
- package/dist/testing/model-contract.d.ts +110 -0
- package/dist/testing/model-contract.js +150 -0
- package/dist/testing/policy-log-contract.d.ts +26 -0
- package/dist/testing/policy-log-contract.js +344 -0
- package/dist/testing/project-contract.d.ts +14 -0
- package/dist/testing/project-contract.js +266 -0
- package/dist/testing/reader-signal-contract.d.ts +27 -2
- package/dist/testing/reader-signal-contract.js +475 -5
- package/dist/testing/store-contract.d.ts +7 -1
- package/dist/testing/store-contract.js +84 -3
- package/dist/theme/apply.d.ts +20 -1
- package/dist/theme/apply.js +5 -3
- package/dist/theme/contrast.d.ts +19 -14
- package/dist/theme/contrast.js +181 -17
- package/dist/theme/derive.d.ts +22 -0
- package/dist/theme/derive.js +54 -1
- package/dist/theme/library.js +1 -1
- package/dist/theme/measure.d.ts +34 -0
- package/dist/theme/measure.js +30 -1
- package/dist/theme/palettes.js +7 -7
- package/dist/theme/ramp.d.ts +64 -0
- package/dist/theme/ramp.js +114 -0
- package/dist/theme/registry.d.ts +9 -0
- package/dist/theme/registry.js +11 -1
- package/dist/theme/separation.d.ts +97 -3
- package/dist/theme/separation.js +75 -0
- package/dist/tree/apply.js +13 -0
- package/dist/tree/compare.d.ts +9 -0
- package/dist/tree/compare.js +18 -0
- package/dist/tree/mutation.d.ts +18 -0
- package/dist/tree/mutation.js +24 -12
- package/dist/tree/navigation.d.ts +5 -0
- package/dist/tree/navigation.js +32 -10
- package/dist/tree/outline.d.ts +7 -0
- package/dist/tree/outline.js +9 -5
- package/dist/write/computed.d.ts +60 -0
- package/dist/write/computed.js +61 -0
- package/dist/write/held.d.ts +59 -0
- package/dist/write/index.d.ts +5 -2
- package/dist/write/index.js +5 -2
- package/dist/write/reseed.d.ts +151 -0
- package/dist/write/reseed.js +184 -0
- package/dist/write/revert.js +2 -16
- package/package.json +25 -3
- package/dist/runtime/inverse-interpreter.d.ts +0 -90
- package/dist/runtime/inverse-interpreter.js +0 -56
package/dist/signals/signal.d.ts
CHANGED
|
@@ -7,10 +7,10 @@ import { type Result } from "../result.js";
|
|
|
7
7
|
* it came into view, it stayed there this long, a reader activated a target in
|
|
8
8
|
* it, a reader opened or closed it. Nothing more, and deliberately so.
|
|
9
9
|
*
|
|
10
|
-
* **The vocabulary is closed.**
|
|
11
|
-
* a tree are four and the schemes a URL may use are a list (0053): an
|
|
12
|
-
* is proposed from these, and a stream that may carry anything is a
|
|
13
|
-
* nothing can reason about. A kind is added here or it does not exist.
|
|
10
|
+
* **The vocabulary is closed.** Five kinds, for the same reason the operations
|
|
11
|
+
* on a tree are four and the schemes a URL may use are a list (0053): an
|
|
12
|
+
* adaptation is proposed from these, and a stream that may carry anything is a
|
|
13
|
+
* stream nothing can reason about. A kind is added here or it does not exist.
|
|
14
14
|
*
|
|
15
15
|
* **A signal carries no content.** No text a node shows, no URL a link goes to,
|
|
16
16
|
* no value a reader typed, nothing that identifies the reader. The tree already
|
|
@@ -23,7 +23,7 @@ import { type Result } from "../result.js";
|
|
|
23
23
|
* means exactly one thing forever (0136).
|
|
24
24
|
*/
|
|
25
25
|
export { DELEGATED_READER_SIGNAL_KINDS, READER_SIGNAL_KINDS } from "./kinds.js";
|
|
26
|
-
export declare const readerSignalKindSchema: z.ZodEnum<["viewed", "dwelled", "activated", "disclosed"]>;
|
|
26
|
+
export declare const readerSignalKindSchema: z.ZodEnum<["viewed", "dwelled", "activated", "disclosed", "completed"]>;
|
|
27
27
|
export type ReaderSignalKind = z.infer<typeof readerSignalKindSchema>;
|
|
28
28
|
/**
|
|
29
29
|
* The key that says two batches came from the same page view, and says nothing
|
|
@@ -54,18 +54,27 @@ export declare const signalAddressSchema: z.ZodObject<{
|
|
|
54
54
|
nodeId: string;
|
|
55
55
|
}>;
|
|
56
56
|
/**
|
|
57
|
-
* The
|
|
57
|
+
* The five kinds.
|
|
58
58
|
*
|
|
59
59
|
* `viewed` fires once per node for the life of the page. `dwelled` is time on
|
|
60
60
|
* screen accumulated since the previous batch, so summing a node's `dwelled` over
|
|
61
61
|
* every batch is its total. `activated` is a reader using a link, button or field
|
|
62
62
|
* inside the node — the node named is the nearest addressed one, which in the
|
|
63
63
|
* starter library is usually the control itself. `disclosed` is a region opened
|
|
64
|
-
* or closed.
|
|
64
|
+
* or closed. `completed` is a form inside the node submitted with its
|
|
65
|
+
* constraints satisfied and nothing on the page cancelling it.
|
|
65
66
|
*
|
|
66
|
-
*
|
|
67
|
-
* a
|
|
68
|
-
*
|
|
67
|
+
* **`completed` is what a page can see, and not a word more.** It does not say
|
|
68
|
+
* a server accepted anything: the broadcaster watches the page and never the
|
|
69
|
+
* reply, so what it can attest is that the browser fired `submit` — which it
|
|
70
|
+
* does only once constraint validation has passed — and that no handler called
|
|
71
|
+
* `preventDefault`. A page that posts with `fetch` and cancels the native
|
|
72
|
+
* submit reports nothing here, which is the honest answer, because from the
|
|
73
|
+
* page's side a cancelled submit and a failed one look identical (0211).
|
|
74
|
+
*
|
|
75
|
+
* The last three are `DELEGATED_READER_SIGNAL_KINDS`: what a reader aimed at is
|
|
76
|
+
* a control or a form, and the region it sits in is a question nothing else can
|
|
77
|
+
* answer afterwards, so they carry `within` and the other two do not.
|
|
69
78
|
*/
|
|
70
79
|
export declare const readerSignalSchema: z.ZodDiscriminatedUnion<"kind", [z.ZodObject<{
|
|
71
80
|
at: z.ZodNumber;
|
|
@@ -166,6 +175,39 @@ export declare const readerSignalSchema: z.ZodDiscriminatedUnion<"kind", [z.ZodO
|
|
|
166
175
|
type: string;
|
|
167
176
|
nodeId: string;
|
|
168
177
|
}[] | undefined;
|
|
178
|
+
}>, z.ZodObject<{
|
|
179
|
+
at: z.ZodNumber;
|
|
180
|
+
within: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodObject<{
|
|
181
|
+
nodeId: z.ZodBranded<z.ZodString, "NodeId">;
|
|
182
|
+
type: z.ZodBranded<z.ZodString, "PrimitiveType">;
|
|
183
|
+
}, "strict", z.ZodTypeAny, {
|
|
184
|
+
type: string & z.BRAND<"PrimitiveType">;
|
|
185
|
+
nodeId: string & z.BRAND<"NodeId">;
|
|
186
|
+
}, {
|
|
187
|
+
type: string;
|
|
188
|
+
nodeId: string;
|
|
189
|
+
}>, "many">>>;
|
|
190
|
+
nodeId: z.ZodBranded<z.ZodString, "NodeId">;
|
|
191
|
+
type: z.ZodBranded<z.ZodString, "PrimitiveType">;
|
|
192
|
+
kind: z.ZodLiteral<"completed">;
|
|
193
|
+
}, "strict", z.ZodTypeAny, {
|
|
194
|
+
at: number;
|
|
195
|
+
type: string & z.BRAND<"PrimitiveType">;
|
|
196
|
+
kind: "completed";
|
|
197
|
+
nodeId: string & z.BRAND<"NodeId">;
|
|
198
|
+
within?: readonly {
|
|
199
|
+
type: string & z.BRAND<"PrimitiveType">;
|
|
200
|
+
nodeId: string & z.BRAND<"NodeId">;
|
|
201
|
+
}[] | undefined;
|
|
202
|
+
}, {
|
|
203
|
+
at: number;
|
|
204
|
+
type: string;
|
|
205
|
+
kind: "completed";
|
|
206
|
+
nodeId: string;
|
|
207
|
+
within?: readonly {
|
|
208
|
+
type: string;
|
|
209
|
+
nodeId: string;
|
|
210
|
+
}[] | undefined;
|
|
169
211
|
}>]>;
|
|
170
212
|
export type ReaderSignal = z.infer<typeof readerSignalSchema>;
|
|
171
213
|
/**
|
|
@@ -176,10 +218,28 @@ export type ReaderSignal = z.infer<typeof readerSignalSchema>;
|
|
|
176
218
|
* rendered page is one revision of one tree — they cannot differ inside a batch,
|
|
177
219
|
* and a shape that let them would invite a consumer to wonder whether they had.
|
|
178
220
|
*/
|
|
179
|
-
export declare const readerSignalBatchSchema: z.ZodObject<{
|
|
221
|
+
export declare const readerSignalBatchSchema: z.ZodEffects<z.ZodObject<{
|
|
180
222
|
treeId: z.ZodBranded<z.ZodString, "TreeId">;
|
|
181
223
|
revision: z.ZodNumber;
|
|
182
224
|
sentAt: z.ZodNumber;
|
|
225
|
+
/**
|
|
226
|
+
* Which audience this page was served under, when the host served one
|
|
227
|
+
* (0284).
|
|
228
|
+
*
|
|
229
|
+
* On the batch rather than on each signal for the same reason the tree and
|
|
230
|
+
* the revision are: one rendered page was one form of one revision, so they
|
|
231
|
+
* cannot differ inside a batch.
|
|
232
|
+
*
|
|
233
|
+
* **Optional, and absent means `aud_everyone`** — the audience that matches
|
|
234
|
+
* every reader. A sender that serves one form of every page has nothing to
|
|
235
|
+
* say here, and requiring it would make every existing page, fixture and
|
|
236
|
+
* worked example wrong about something it was right about.
|
|
237
|
+
*
|
|
238
|
+
* Opaque to Loom. It is a name the host chose for a predicate the host
|
|
239
|
+
* evaluated, and nothing about the reader it matched travels with it
|
|
240
|
+
* (0263).
|
|
241
|
+
*/
|
|
242
|
+
audience: z.ZodOptional<z.ZodBranded<z.ZodString, "AudienceId">>;
|
|
183
243
|
/**
|
|
184
244
|
* Which page view these signals came from, when the sender minted one.
|
|
185
245
|
*
|
|
@@ -191,6 +251,25 @@ export declare const readerSignalBatchSchema: z.ZodObject<{
|
|
|
191
251
|
* view, which would inflate every funnel denominator.
|
|
192
252
|
*/
|
|
193
253
|
view: z.ZodOptional<z.ZodBranded<z.ZodString, "ViewKey">>;
|
|
254
|
+
/**
|
|
255
|
+
* Whether this is the opening delivery of its page view.
|
|
256
|
+
*
|
|
257
|
+
* One batch of a page view carries it and the rest do not, so a receiver
|
|
258
|
+
* can count page views without remembering anything: *this is a reader
|
|
259
|
+
* arriving* is a fact only the sender has, and the server's alternative is
|
|
260
|
+
* to hold the view keys it has already seen — which is the one value
|
|
261
|
+
* nothing is allowed to keep (0146).
|
|
262
|
+
*
|
|
263
|
+
* It says nothing about the reader and nothing about the page. It is the
|
|
264
|
+
* field that lets an intake count where its readers are, once, per reader,
|
|
265
|
+
* rather than once per delivery — and a counter that moves with how long
|
|
266
|
+
* somebody stayed is a counter that makes one visitor look like a crowd.
|
|
267
|
+
*
|
|
268
|
+
* **Optional, and absent is not false.** A sender that does not mint view
|
|
269
|
+
* keys has no page views to open, and a batch replayed from a fixture is
|
|
270
|
+
* not an arrival.
|
|
271
|
+
*/
|
|
272
|
+
first: z.ZodOptional<z.ZodLiteral<true>>;
|
|
194
273
|
signals: z.ZodArray<z.ZodDiscriminatedUnion<"kind", [z.ZodObject<{
|
|
195
274
|
at: z.ZodNumber;
|
|
196
275
|
nodeId: z.ZodBranded<z.ZodString, "NodeId">;
|
|
@@ -290,6 +369,39 @@ export declare const readerSignalBatchSchema: z.ZodObject<{
|
|
|
290
369
|
type: string;
|
|
291
370
|
nodeId: string;
|
|
292
371
|
}[] | undefined;
|
|
372
|
+
}>, z.ZodObject<{
|
|
373
|
+
at: z.ZodNumber;
|
|
374
|
+
within: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodObject<{
|
|
375
|
+
nodeId: z.ZodBranded<z.ZodString, "NodeId">;
|
|
376
|
+
type: z.ZodBranded<z.ZodString, "PrimitiveType">;
|
|
377
|
+
}, "strict", z.ZodTypeAny, {
|
|
378
|
+
type: string & z.BRAND<"PrimitiveType">;
|
|
379
|
+
nodeId: string & z.BRAND<"NodeId">;
|
|
380
|
+
}, {
|
|
381
|
+
type: string;
|
|
382
|
+
nodeId: string;
|
|
383
|
+
}>, "many">>>;
|
|
384
|
+
nodeId: z.ZodBranded<z.ZodString, "NodeId">;
|
|
385
|
+
type: z.ZodBranded<z.ZodString, "PrimitiveType">;
|
|
386
|
+
kind: z.ZodLiteral<"completed">;
|
|
387
|
+
}, "strict", z.ZodTypeAny, {
|
|
388
|
+
at: number;
|
|
389
|
+
type: string & z.BRAND<"PrimitiveType">;
|
|
390
|
+
kind: "completed";
|
|
391
|
+
nodeId: string & z.BRAND<"NodeId">;
|
|
392
|
+
within?: readonly {
|
|
393
|
+
type: string & z.BRAND<"PrimitiveType">;
|
|
394
|
+
nodeId: string & z.BRAND<"NodeId">;
|
|
395
|
+
}[] | undefined;
|
|
396
|
+
}, {
|
|
397
|
+
at: number;
|
|
398
|
+
type: string;
|
|
399
|
+
kind: "completed";
|
|
400
|
+
nodeId: string;
|
|
401
|
+
within?: readonly {
|
|
402
|
+
type: string;
|
|
403
|
+
nodeId: string;
|
|
404
|
+
}[] | undefined;
|
|
293
405
|
}>]>, "many">;
|
|
294
406
|
}, "strict", z.ZodTypeAny, {
|
|
295
407
|
treeId: string & z.BRAND<"TreeId">;
|
|
@@ -324,8 +436,111 @@ export declare const readerSignalBatchSchema: z.ZodObject<{
|
|
|
324
436
|
type: string & z.BRAND<"PrimitiveType">;
|
|
325
437
|
nodeId: string & z.BRAND<"NodeId">;
|
|
326
438
|
}[] | undefined;
|
|
439
|
+
} | {
|
|
440
|
+
at: number;
|
|
441
|
+
type: string & z.BRAND<"PrimitiveType">;
|
|
442
|
+
kind: "completed";
|
|
443
|
+
nodeId: string & z.BRAND<"NodeId">;
|
|
444
|
+
within?: readonly {
|
|
445
|
+
type: string & z.BRAND<"PrimitiveType">;
|
|
446
|
+
nodeId: string & z.BRAND<"NodeId">;
|
|
447
|
+
}[] | undefined;
|
|
448
|
+
})[];
|
|
449
|
+
first?: true | undefined;
|
|
450
|
+
view?: (string & z.BRAND<"ViewKey">) | undefined;
|
|
451
|
+
audience?: (string & z.BRAND<"AudienceId">) | undefined;
|
|
452
|
+
}, {
|
|
453
|
+
treeId: string;
|
|
454
|
+
revision: number;
|
|
455
|
+
sentAt: number;
|
|
456
|
+
signals: ({
|
|
457
|
+
at: number;
|
|
458
|
+
type: string;
|
|
459
|
+
kind: "viewed";
|
|
460
|
+
nodeId: string;
|
|
461
|
+
} | {
|
|
462
|
+
type: string;
|
|
463
|
+
kind: "dwelled";
|
|
464
|
+
nodeId: string;
|
|
465
|
+
ms: number;
|
|
466
|
+
} | {
|
|
467
|
+
at: number;
|
|
468
|
+
type: string;
|
|
469
|
+
kind: "activated";
|
|
470
|
+
nodeId: string;
|
|
471
|
+
within?: readonly {
|
|
472
|
+
type: string;
|
|
473
|
+
nodeId: string;
|
|
474
|
+
}[] | undefined;
|
|
475
|
+
} | {
|
|
476
|
+
at: number;
|
|
477
|
+
type: string;
|
|
478
|
+
kind: "disclosed";
|
|
479
|
+
nodeId: string;
|
|
480
|
+
open: boolean;
|
|
481
|
+
within?: readonly {
|
|
482
|
+
type: string;
|
|
483
|
+
nodeId: string;
|
|
484
|
+
}[] | undefined;
|
|
485
|
+
} | {
|
|
486
|
+
at: number;
|
|
487
|
+
type: string;
|
|
488
|
+
kind: "completed";
|
|
489
|
+
nodeId: string;
|
|
490
|
+
within?: readonly {
|
|
491
|
+
type: string;
|
|
492
|
+
nodeId: string;
|
|
493
|
+
}[] | undefined;
|
|
494
|
+
})[];
|
|
495
|
+
first?: true | undefined;
|
|
496
|
+
view?: string | undefined;
|
|
497
|
+
audience?: string | undefined;
|
|
498
|
+
}>, {
|
|
499
|
+
treeId: string & z.BRAND<"TreeId">;
|
|
500
|
+
revision: number;
|
|
501
|
+
sentAt: number;
|
|
502
|
+
signals: ({
|
|
503
|
+
at: number;
|
|
504
|
+
type: string & z.BRAND<"PrimitiveType">;
|
|
505
|
+
kind: "viewed";
|
|
506
|
+
nodeId: string & z.BRAND<"NodeId">;
|
|
507
|
+
} | {
|
|
508
|
+
type: string & z.BRAND<"PrimitiveType">;
|
|
509
|
+
kind: "dwelled";
|
|
510
|
+
nodeId: string & z.BRAND<"NodeId">;
|
|
511
|
+
ms: number;
|
|
512
|
+
} | {
|
|
513
|
+
at: number;
|
|
514
|
+
type: string & z.BRAND<"PrimitiveType">;
|
|
515
|
+
kind: "activated";
|
|
516
|
+
nodeId: string & z.BRAND<"NodeId">;
|
|
517
|
+
within?: readonly {
|
|
518
|
+
type: string & z.BRAND<"PrimitiveType">;
|
|
519
|
+
nodeId: string & z.BRAND<"NodeId">;
|
|
520
|
+
}[] | undefined;
|
|
521
|
+
} | {
|
|
522
|
+
at: number;
|
|
523
|
+
type: string & z.BRAND<"PrimitiveType">;
|
|
524
|
+
kind: "disclosed";
|
|
525
|
+
nodeId: string & z.BRAND<"NodeId">;
|
|
526
|
+
open: boolean;
|
|
527
|
+
within?: readonly {
|
|
528
|
+
type: string & z.BRAND<"PrimitiveType">;
|
|
529
|
+
nodeId: string & z.BRAND<"NodeId">;
|
|
530
|
+
}[] | undefined;
|
|
531
|
+
} | {
|
|
532
|
+
at: number;
|
|
533
|
+
type: string & z.BRAND<"PrimitiveType">;
|
|
534
|
+
kind: "completed";
|
|
535
|
+
nodeId: string & z.BRAND<"NodeId">;
|
|
536
|
+
within?: readonly {
|
|
537
|
+
type: string & z.BRAND<"PrimitiveType">;
|
|
538
|
+
nodeId: string & z.BRAND<"NodeId">;
|
|
539
|
+
}[] | undefined;
|
|
327
540
|
})[];
|
|
541
|
+
first?: true | undefined;
|
|
328
542
|
view?: (string & z.BRAND<"ViewKey">) | undefined;
|
|
543
|
+
audience?: (string & z.BRAND<"AudienceId">) | undefined;
|
|
329
544
|
}, {
|
|
330
545
|
treeId: string;
|
|
331
546
|
revision: number;
|
|
@@ -359,8 +574,19 @@ export declare const readerSignalBatchSchema: z.ZodObject<{
|
|
|
359
574
|
type: string;
|
|
360
575
|
nodeId: string;
|
|
361
576
|
}[] | undefined;
|
|
577
|
+
} | {
|
|
578
|
+
at: number;
|
|
579
|
+
type: string;
|
|
580
|
+
kind: "completed";
|
|
581
|
+
nodeId: string;
|
|
582
|
+
within?: readonly {
|
|
583
|
+
type: string;
|
|
584
|
+
nodeId: string;
|
|
585
|
+
}[] | undefined;
|
|
362
586
|
})[];
|
|
587
|
+
first?: true | undefined;
|
|
363
588
|
view?: string | undefined;
|
|
589
|
+
audience?: string | undefined;
|
|
364
590
|
}>;
|
|
365
591
|
export type ReaderSignalBatch = z.infer<typeof readerSignalBatchSchema>;
|
|
366
592
|
export type ReaderSignalParseError = {
|
package/dist/signals/signal.js
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { z } from "zod";
|
|
2
|
+
import { audienceIdSchema } from "../audience/audience.js";
|
|
2
3
|
import { nodeIdSchema, treeIdSchema } from "../ids.js";
|
|
3
4
|
import { primitiveTypeSchema } from "../primitive-type.js";
|
|
4
5
|
import { err, ok } from "../result.js";
|
|
@@ -11,10 +12,10 @@ import { viewKeyPattern } from "./view.js";
|
|
|
11
12
|
* it came into view, it stayed there this long, a reader activated a target in
|
|
12
13
|
* it, a reader opened or closed it. Nothing more, and deliberately so.
|
|
13
14
|
*
|
|
14
|
-
* **The vocabulary is closed.**
|
|
15
|
-
* a tree are four and the schemes a URL may use are a list (0053): an
|
|
16
|
-
* is proposed from these, and a stream that may carry anything is a
|
|
17
|
-
* nothing can reason about. A kind is added here or it does not exist.
|
|
15
|
+
* **The vocabulary is closed.** Five kinds, for the same reason the operations
|
|
16
|
+
* on a tree are four and the schemes a URL may use are a list (0053): an
|
|
17
|
+
* adaptation is proposed from these, and a stream that may carry anything is a
|
|
18
|
+
* stream nothing can reason about. A kind is added here or it does not exist.
|
|
18
19
|
*
|
|
19
20
|
* **A signal carries no content.** No text a node shows, no URL a link goes to,
|
|
20
21
|
* no value a reader typed, nothing that identifies the reader. The tree already
|
|
@@ -72,18 +73,27 @@ export const signalAddressSchema = z.object(addressSchema).strict();
|
|
|
72
73
|
*/
|
|
73
74
|
const withinSchema = z.array(signalAddressSchema).readonly();
|
|
74
75
|
/**
|
|
75
|
-
* The
|
|
76
|
+
* The five kinds.
|
|
76
77
|
*
|
|
77
78
|
* `viewed` fires once per node for the life of the page. `dwelled` is time on
|
|
78
79
|
* screen accumulated since the previous batch, so summing a node's `dwelled` over
|
|
79
80
|
* every batch is its total. `activated` is a reader using a link, button or field
|
|
80
81
|
* inside the node — the node named is the nearest addressed one, which in the
|
|
81
82
|
* starter library is usually the control itself. `disclosed` is a region opened
|
|
82
|
-
* or closed.
|
|
83
|
+
* or closed. `completed` is a form inside the node submitted with its
|
|
84
|
+
* constraints satisfied and nothing on the page cancelling it.
|
|
83
85
|
*
|
|
84
|
-
*
|
|
85
|
-
* a
|
|
86
|
-
*
|
|
86
|
+
* **`completed` is what a page can see, and not a word more.** It does not say
|
|
87
|
+
* a server accepted anything: the broadcaster watches the page and never the
|
|
88
|
+
* reply, so what it can attest is that the browser fired `submit` — which it
|
|
89
|
+
* does only once constraint validation has passed — and that no handler called
|
|
90
|
+
* `preventDefault`. A page that posts with `fetch` and cancels the native
|
|
91
|
+
* submit reports nothing here, which is the honest answer, because from the
|
|
92
|
+
* page's side a cancelled submit and a failed one look identical (0211).
|
|
93
|
+
*
|
|
94
|
+
* The last three are `DELEGATED_READER_SIGNAL_KINDS`: what a reader aimed at is
|
|
95
|
+
* a control or a form, and the region it sits in is a question nothing else can
|
|
96
|
+
* answer afterwards, so they carry `within` and the other two do not.
|
|
87
97
|
*/
|
|
88
98
|
export const readerSignalSchema = z.discriminatedUnion("kind", [
|
|
89
99
|
z.object({ kind: z.literal("viewed"), ...addressSchema, at: instantSchema }).strict(),
|
|
@@ -100,6 +110,9 @@ export const readerSignalSchema = z.discriminatedUnion("kind", [
|
|
|
100
110
|
within: withinSchema.optional(),
|
|
101
111
|
})
|
|
102
112
|
.strict(),
|
|
113
|
+
z
|
|
114
|
+
.object({ kind: z.literal("completed"), ...addressSchema, at: instantSchema, within: withinSchema.optional() })
|
|
115
|
+
.strict(),
|
|
103
116
|
]);
|
|
104
117
|
/**
|
|
105
118
|
* One delivery: the signals a page gathered since the last one, all about the
|
|
@@ -114,6 +127,24 @@ export const readerSignalBatchSchema = z
|
|
|
114
127
|
treeId: treeIdSchema,
|
|
115
128
|
revision: z.number().int().nonnegative(),
|
|
116
129
|
sentAt: instantSchema,
|
|
130
|
+
/**
|
|
131
|
+
* Which audience this page was served under, when the host served one
|
|
132
|
+
* (0284).
|
|
133
|
+
*
|
|
134
|
+
* On the batch rather than on each signal for the same reason the tree and
|
|
135
|
+
* the revision are: one rendered page was one form of one revision, so they
|
|
136
|
+
* cannot differ inside a batch.
|
|
137
|
+
*
|
|
138
|
+
* **Optional, and absent means `aud_everyone`** — the audience that matches
|
|
139
|
+
* every reader. A sender that serves one form of every page has nothing to
|
|
140
|
+
* say here, and requiring it would make every existing page, fixture and
|
|
141
|
+
* worked example wrong about something it was right about.
|
|
142
|
+
*
|
|
143
|
+
* Opaque to Loom. It is a name the host chose for a predicate the host
|
|
144
|
+
* evaluated, and nothing about the reader it matched travels with it
|
|
145
|
+
* (0263).
|
|
146
|
+
*/
|
|
147
|
+
audience: audienceIdSchema.optional(),
|
|
117
148
|
/**
|
|
118
149
|
* Which page view these signals came from, when the sender minted one.
|
|
119
150
|
*
|
|
@@ -125,9 +156,38 @@ export const readerSignalBatchSchema = z
|
|
|
125
156
|
* view, which would inflate every funnel denominator.
|
|
126
157
|
*/
|
|
127
158
|
view: viewKeySchema.optional(),
|
|
159
|
+
/**
|
|
160
|
+
* Whether this is the opening delivery of its page view.
|
|
161
|
+
*
|
|
162
|
+
* One batch of a page view carries it and the rest do not, so a receiver
|
|
163
|
+
* can count page views without remembering anything: *this is a reader
|
|
164
|
+
* arriving* is a fact only the sender has, and the server's alternative is
|
|
165
|
+
* to hold the view keys it has already seen — which is the one value
|
|
166
|
+
* nothing is allowed to keep (0146).
|
|
167
|
+
*
|
|
168
|
+
* It says nothing about the reader and nothing about the page. It is the
|
|
169
|
+
* field that lets an intake count where its readers are, once, per reader,
|
|
170
|
+
* rather than once per delivery — and a counter that moves with how long
|
|
171
|
+
* somebody stayed is a counter that makes one visitor look like a crowd.
|
|
172
|
+
*
|
|
173
|
+
* **Optional, and absent is not false.** A sender that does not mint view
|
|
174
|
+
* keys has no page views to open, and a batch replayed from a fixture is
|
|
175
|
+
* not an arrival.
|
|
176
|
+
*/
|
|
177
|
+
first: z.literal(true).optional(),
|
|
128
178
|
signals: z.array(readerSignalSchema).min(1),
|
|
129
179
|
})
|
|
130
|
-
.strict()
|
|
180
|
+
.strict()
|
|
181
|
+
/**
|
|
182
|
+
* An opening with nothing to open is refused rather than ignored. The flag
|
|
183
|
+
* means *this page view began here*, so a batch that names no page view is
|
|
184
|
+
* making a claim it cannot support, and a receiver that quietly dropped it
|
|
185
|
+
* would be undercounting for a reason nobody could see.
|
|
186
|
+
*/
|
|
187
|
+
.refine((batch) => batch.first !== true || batch.view !== undefined, {
|
|
188
|
+
message: "says it opened a page view but names none",
|
|
189
|
+
path: ["first"],
|
|
190
|
+
});
|
|
131
191
|
/**
|
|
132
192
|
* Read a batch that arrived from somewhere untrusted — a request body, a queue.
|
|
133
193
|
*
|
|
@@ -0,0 +1,205 @@
|
|
|
1
|
+
import { type PageForm } from "./audiences.js";
|
|
2
|
+
import type { SilenceCondition, SilenceMeaning, SilenceSubject, SilenceVocabulary } from "./silences.js";
|
|
3
|
+
/**
|
|
4
|
+
* What a window could not answer, and what each reason cost it.
|
|
5
|
+
*
|
|
6
|
+
* [`silences.ts`](silences.ts) settled what a reading means when it says
|
|
7
|
+
* nothing: a hundred and fourteen names across twenty sets, each mapped to the
|
|
8
|
+
* condition it reports and the subject that condition is true of, so that two
|
|
9
|
+
* readings reporting one state report it once
|
|
10
|
+
* ([0240](../../decisions/0240-a-silence-is-a-condition-and-a-subject-and-the-two-names-for-one-state-were-not-synonyms.md)).
|
|
11
|
+
* It publishes `relateSilences`, which holds two reasons against each other,
|
|
12
|
+
* and `distinctSilences`, which collapses the readings of one card to the states
|
|
13
|
+
* they are actually in.
|
|
14
|
+
*
|
|
15
|
+
* **Nothing has ever called either of them.** Twenty sets, one relation and a
|
|
16
|
+
* dedup, and the only file in the repository that imports them is their own
|
|
17
|
+
* test — because the call they are shaped for is *one card*, and the thing an
|
|
18
|
+
* operator holds is a window of forty pages with nine readings over each. The
|
|
19
|
+
* vocabulary is finished and the question over it was unaskable, which is the
|
|
20
|
+
* one condition this lane treats as a counter that is not done.
|
|
21
|
+
*
|
|
22
|
+
* This is that question: hand over the silences as a surface holds them, one per
|
|
23
|
+
* reading, and get back the states the window is in, with **what each one
|
|
24
|
+
* cost**. It is one more thing taken out of what the subsystem already knows
|
|
25
|
+
* rather than collected: no payload, no browser change, no counter that does
|
|
26
|
+
* not exist, no column and no byte on any wire.
|
|
27
|
+
*
|
|
28
|
+
* ## A state is one condition about one subject, and that rule is not restated
|
|
29
|
+
*
|
|
30
|
+
* Two readings are in one state when `relateSilences` says `one-state`, which
|
|
31
|
+
* is the same condition about the same subject. Two that agree on the condition
|
|
32
|
+
* alone stay two, because *the window held no page views* said of a page and
|
|
33
|
+
* said of a comparison are not one sentence and the narrower is not evidence for
|
|
34
|
+
* the wider (0240).
|
|
35
|
+
*
|
|
36
|
+
* So the grouping key is that pair, which is the relation's own definition
|
|
37
|
+
* written as a string rather than a second opinion about it. A rule spelled
|
|
38
|
+
* twice is the thing this subsystem has been bitten by — two hand-written
|
|
39
|
+
* copies of the door's scaling rule, and two upsert keys that agreed until they
|
|
40
|
+
* did not — and the key cannot call `relateSilences` without turning a grouping
|
|
41
|
+
* into a scan per entry. So the two are **held together by a test** instead, as
|
|
42
|
+
* a DDL default and the constant it spells are: no two states of a census may
|
|
43
|
+
* be ones the relation would call `one-state`, over a window built to produce
|
|
44
|
+
* both of the ways that could go wrong.
|
|
45
|
+
*
|
|
46
|
+
* ## What a reason cost is readings and pages, and a page is counted once
|
|
47
|
+
*
|
|
48
|
+
* A state carries two counts and they answer different questions.
|
|
49
|
+
* {@link SilenceStanding.readings} is how many readings it took, which is the
|
|
50
|
+
* figure *how much of this window is dark* is asked of.
|
|
51
|
+
* {@link SilenceStanding.forms} names the pages, **each once however many of
|
|
52
|
+
* their readings report it** — the rule a fault in a deployment's collection
|
|
53
|
+
* already follows, where a page is counted once however many faults it has
|
|
54
|
+
* ([0271](../../decisions/0271-a-fault-in-a-deployments-collection-is-named-by-what-it-costs-and-a-pages-readers-are-counted-once.md)).
|
|
55
|
+
*
|
|
56
|
+
* The two are not each other. One page whose nine readings are all `unmeasured`
|
|
57
|
+
* is nine readings and one page; nine pages with one such reading each is nine
|
|
58
|
+
* and nine; and the remedies differ — the first is one door row and the second
|
|
59
|
+
* is a deployment.
|
|
60
|
+
*
|
|
61
|
+
* The page is a **form** and not a revision
|
|
62
|
+
* ([0263](../../decisions/0263-a-page-is-a-base-tree-and-the-deltas-an-audience-earns.md),
|
|
63
|
+
* [0290](../../decisions/0290-a-reading-is-of-one-audience-and-two-forms-of-a-page-are-two-readings-rather-than-one-handed-in-twice.md)),
|
|
64
|
+
* keyed by the published rule rather than by a tree id: two forms of one page
|
|
65
|
+
* are two readerships and a tree alone is not one page, which every comparison
|
|
66
|
+
* in this subsystem keys on and none of them spells out twice
|
|
67
|
+
* ([0293](../../decisions/0293-a-comparison-pairs-pages-by-form-and-the-pairing-rule-is-published-beside-the-reading-rule.md)).
|
|
68
|
+
*
|
|
69
|
+
* ## The other grouping is the same entries read the other way
|
|
70
|
+
*
|
|
71
|
+
* The states say *which reasons this window has*. A form row says *what this
|
|
72
|
+
* page answered*, which is the question after it and is the same entries
|
|
73
|
+
* transposed — the shape a region map took when it was asked which pages a
|
|
74
|
+
* place's readers read, and free for the same reason: nothing is collected, the
|
|
75
|
+
* rows are grouped the other way.
|
|
76
|
+
*
|
|
77
|
+
* It is the grouping that carries the sentence worth putting at the top of a
|
|
78
|
+
* screen, because it is the one with a denominator. *Nine of this page's nine
|
|
79
|
+
* readings are silent, for one reason* is a page to fix; one silence out of nine
|
|
80
|
+
* is a page that is working.
|
|
81
|
+
*
|
|
82
|
+
* ## What is deliberately not published
|
|
83
|
+
*
|
|
84
|
+
* **No ranking of the states.** They are not comparable in what they cost: a
|
|
85
|
+
* page's `no-view-reported` takes every reading of that page, and a library's
|
|
86
|
+
* `nothing-of-the-kind` takes one row of one census and means *you do not use
|
|
87
|
+
* this kind of part*, which is not a fault at all. The counts are published and
|
|
88
|
+
* the order is the order the readings were handed over, so a surface that means
|
|
89
|
+
* *most readings* or *most pages* sorts by the figure it means. That is the
|
|
90
|
+
* shape this lane settled for a verdict it could not take honestly: publish the
|
|
91
|
+
* figure and let the operator read it.
|
|
92
|
+
*
|
|
93
|
+
* **No total of pages across the states**, for
|
|
94
|
+
* [0158](../../decisions/0158-counting-a-window-of-reader-signals-and-forgetting-it-are-one-operation.md)'s
|
|
95
|
+
* reason one level up: one page is in as many states as it has reasons, so a
|
|
96
|
+
* sum over {@link SilenceStanding.forms} counts it once per reason. What is
|
|
97
|
+
* published instead partitions — every reading handed in is in exactly one
|
|
98
|
+
* state or in none, so {@link SilenceCensus.silent} is the sum of the states'
|
|
99
|
+
* readings, and that identity is published rather than described.
|
|
100
|
+
*
|
|
101
|
+
* **No sentence of its own.** A state is a condition and a subject, both of
|
|
102
|
+
* which `silences.ts` already prints a line for, and the only thing a third
|
|
103
|
+
* sentence would add is the counts — which is pluralisation, and belongs to
|
|
104
|
+
* whoever is drawing the screen in whatever language it is in.
|
|
105
|
+
*
|
|
106
|
+
* Pure, and linear in the readings handed over. It reaches no store, no clock
|
|
107
|
+
* and no DOM, and the arithmetic is addition — nothing here survives into a
|
|
108
|
+
* browser bundle.
|
|
109
|
+
*/
|
|
110
|
+
/** One reading's silence, with the page it was a reading of. */
|
|
111
|
+
export type ReadingSilence = {
|
|
112
|
+
/**
|
|
113
|
+
* What the reading reported, as the matching `meaningOf…Silence` gives it, or
|
|
114
|
+
* `null` where it answered.
|
|
115
|
+
*
|
|
116
|
+
* Nullable rather than the whole entry being nullable, which is the one way
|
|
117
|
+
* this differs from `distinctSilences`' argument and the reason the form
|
|
118
|
+
* grouping has a denominator at all: a reading that answered is still a
|
|
119
|
+
* reading of that page, and dropping it before the call would make *nine of
|
|
120
|
+
* nine* and *one of one* the same row.
|
|
121
|
+
*/
|
|
122
|
+
readonly meaning: SilenceMeaning | null;
|
|
123
|
+
/**
|
|
124
|
+
* The page in the form this reading was of, or absent where the reading is of
|
|
125
|
+
* no one page.
|
|
126
|
+
*
|
|
127
|
+
* A library census and an order over a deployment's pages are of something
|
|
128
|
+
* larger than a page, and their silences are about a kind and about a page
|
|
129
|
+
* respectively — a reading's subject is not its scope (0240). Those are
|
|
130
|
+
* counted in {@link SilenceCensus.wide} rather than attributed to a form that
|
|
131
|
+
* would be a guess.
|
|
132
|
+
*/
|
|
133
|
+
readonly form?: PageForm | null;
|
|
134
|
+
};
|
|
135
|
+
/** One state the window is in, and what it cost. */
|
|
136
|
+
export type SilenceStanding = {
|
|
137
|
+
readonly condition: SilenceCondition;
|
|
138
|
+
readonly subject: SilenceSubject;
|
|
139
|
+
/**
|
|
140
|
+
* The vocabulary of the **first** reading that reported it, kept so that a
|
|
141
|
+
* surface can still print that reading's own sentence.
|
|
142
|
+
*
|
|
143
|
+
* `distinctSilences`' rule, unchanged: the names are right in their own set
|
|
144
|
+
* and collapsing a state does not make one of them wrong.
|
|
145
|
+
*/
|
|
146
|
+
readonly vocabulary: SilenceVocabulary;
|
|
147
|
+
/** Every vocabulary that reported it, each once, in the order they arrived. */
|
|
148
|
+
readonly vocabularies: readonly SilenceVocabulary[];
|
|
149
|
+
/** How many readings reported it. */
|
|
150
|
+
readonly readings: number;
|
|
151
|
+
/** The pages it cost, each once however many of their readings reported it. */
|
|
152
|
+
readonly forms: readonly PageForm[];
|
|
153
|
+
/** How many of the readings that reported it were of no one page. */
|
|
154
|
+
readonly wide: number;
|
|
155
|
+
};
|
|
156
|
+
/** What one group of readings answered. */
|
|
157
|
+
export type SilenceGroup = {
|
|
158
|
+
/** Every reading handed over in this group, silent or not. */
|
|
159
|
+
readonly readings: number;
|
|
160
|
+
/** How many of them were silent. */
|
|
161
|
+
readonly silent: number;
|
|
162
|
+
/**
|
|
163
|
+
* The distinct states they are in, in the order they arrived, each keeping the
|
|
164
|
+
* first reading's vocabulary.
|
|
165
|
+
*/
|
|
166
|
+
readonly states: readonly SilenceMeaning[];
|
|
167
|
+
};
|
|
168
|
+
/** What one page in one form answered. */
|
|
169
|
+
export type FormSilences = SilenceGroup & {
|
|
170
|
+
readonly form: PageForm;
|
|
171
|
+
};
|
|
172
|
+
/** The states a window is in, and what each of them cost. */
|
|
173
|
+
export type SilenceCensus = {
|
|
174
|
+
/**
|
|
175
|
+
* Every reading handed over, silent or not, which is the denominator the
|
|
176
|
+
* caller chose by choosing what to hand in.
|
|
177
|
+
*/
|
|
178
|
+
readonly readings: number;
|
|
179
|
+
/** How many of them were silent. `readings = silent + answered`. */
|
|
180
|
+
readonly silent: number;
|
|
181
|
+
readonly answered: number;
|
|
182
|
+
/**
|
|
183
|
+
* The distinct states, in the order the readings were handed over.
|
|
184
|
+
*
|
|
185
|
+
* Their `readings` sum to {@link silent}, because every silent reading is in
|
|
186
|
+
* exactly one state. Their `forms` do **not** sum to anything.
|
|
187
|
+
*/
|
|
188
|
+
readonly states: readonly SilenceStanding[];
|
|
189
|
+
/** The same readings by page, in form order rather than arrival order. */
|
|
190
|
+
readonly byForm: readonly FormSilences[];
|
|
191
|
+
/** The readings of no one page, which no form row holds. */
|
|
192
|
+
readonly wide: SilenceGroup;
|
|
193
|
+
};
|
|
194
|
+
/**
|
|
195
|
+
* The states a window is in, out of the silences its readings published.
|
|
196
|
+
*
|
|
197
|
+
* Takes one entry per reading rather than one per silence, so that a page's
|
|
198
|
+
* readings have a denominator, and groups them twice: by the state, which is a
|
|
199
|
+
* condition and a subject, and by the page.
|
|
200
|
+
*
|
|
201
|
+
* Linear in the entries. A page's forty readings and a deployment's forty pages
|
|
202
|
+
* are sixteen hundred entries, and each one touches two maps.
|
|
203
|
+
*/
|
|
204
|
+
export declare const silenceCensusOf: (readings: readonly ReadingSilence[]) => SilenceCensus;
|
|
205
|
+
//# sourceMappingURL=silence-census.d.ts.map
|