@jam-overture/loom 0.1.0 → 0.2.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/cli/templates.js +19 -0
- package/dist/data/plan.js +0 -0
- package/dist/data/resolution.d.ts +23 -1
- package/dist/data/resolve.d.ts +30 -3
- 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/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/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/index.d.ts +2 -0
- package/dist/render/index.js +2 -0
- package/dist/render/reads.d.ts +11 -0
- package/dist/render/reads.js +12 -1
- package/dist/render/render.js +102 -7
- 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/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 +22 -0
- package/dist/runtime/index.d.ts +3 -0
- package/dist/runtime/index.js +3 -0
- package/dist/runtime/irreversibility.d.ts +64 -0
- package/dist/runtime/irreversibility.js +45 -0
- 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 +299 -0
- package/dist/runtime/policy-log.d.ts +406 -0
- package/dist/runtime/policy-log.js +285 -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 +65 -0
- package/dist/sdk/definition.js +22 -0
- package/dist/sdk/registry.d.ts +29 -2
- package/dist/sdk/registry.js +63 -1
- 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/applied-window.contract.d.ts +23 -0
- package/dist/signals/applied-window.contract.js +160 -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 +8 -2
- package/dist/signals/broadcast.js +58 -8
- package/dist/signals/change.d.ts +378 -0
- package/dist/signals/change.js +327 -0
- package/dist/signals/collect.d.ts +41 -0
- package/dist/signals/collect.js +88 -7
- 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/counters.d.ts +46 -0
- package/dist/signals/counters.js +102 -0
- package/dist/signals/deliver.d.ts +23 -4
- package/dist/signals/deliver.js +34 -6
- package/dist/signals/deployment-change.d.ts +371 -0
- package/dist/signals/deployment-change.js +268 -0
- package/dist/signals/deployment.d.ts +265 -0
- package/dist/signals/deployment.js +152 -0
- package/dist/signals/door.d.ts +92 -0
- package/dist/signals/door.js +53 -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/funnel-change.d.ts +548 -0
- package/dist/signals/funnel-change.js +361 -0
- package/dist/signals/funnel.d.ts +532 -0
- package/dist/signals/funnel.js +216 -0
- package/dist/signals/health.d.ts +497 -0
- package/dist/signals/health.js +361 -0
- package/dist/signals/index.d.ts +41 -0
- package/dist/signals/index.js +41 -0
- package/dist/signals/ingest.d.ts +56 -1
- package/dist/signals/ingest.js +91 -1
- package/dist/signals/journal.d.ts +11 -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-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 +636 -0
- package/dist/signals/library-reach-change.js +534 -0
- package/dist/signals/library-reach.d.ts +377 -0
- package/dist/signals/library-reach.js +227 -0
- package/dist/signals/library-word-reach-change.d.ts +567 -0
- package/dist/signals/library-word-reach-change.js +568 -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 +105 -14
- package/dist/signals/migrate.d.ts +17 -2
- package/dist/signals/migrate.js +122 -5
- package/dist/signals/notice.d.ts +334 -0
- package/dist/signals/notice.js +228 -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/parts.d.ts +344 -0
- package/dist/signals/parts.js +273 -0
- package/dist/signals/postgres.d.ts +16 -2
- package/dist/signals/postgres.js +390 -87
- 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 +141 -0
- package/dist/signals/retention.js +58 -0
- package/dist/signals/rollup.d.ts +67 -3
- package/dist/signals/rollup.js +0 -0
- package/dist/signals/schema.d.ts +432 -1
- package/dist/signals/schema.js +157 -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 +848 -0
- package/dist/signals/silences.js +753 -0
- package/dist/signals/tally.d.ts +140 -11
- package/dist/signals/window-figures.d.ts +148 -0
- package/dist/signals/window-figures.js +42 -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/index.d.ts +19 -0
- package/dist/store/index.js +19 -0
- package/dist/store/memory.d.ts +2 -1
- package/dist/store/memory.js +48 -12
- package/dist/store/migrate.d.ts +80 -0
- package/dist/store/migrate.js +259 -7
- package/dist/store/postgres-applications.d.ts +4 -0
- package/dist/store/postgres-applications.js +197 -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 +16 -1
- package/dist/store/postgres.js +59 -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 +450 -2
- package/dist/store/schema.js +141 -5
- package/dist/store/store.d.ts +29 -6
- 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 +1 -0
- package/dist/telemetry/index.js +1 -0
- package/dist/telemetry/journal.d.ts +72 -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 +23 -0
- package/dist/telemetry/migrate.js +22 -1
- package/dist/telemetry/postgres.d.ts +10 -1
- package/dist/telemetry/postgres.js +172 -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/testing/application-contract.d.ts +14 -0
- package/dist/testing/application-contract.js +270 -0
- package/dist/testing/contracts.d.ts +12 -7
- package/dist/testing/contracts.js +12 -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 +140 -2
- 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/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/compare.d.ts +9 -0
- package/dist/tree/compare.js +18 -0
- 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 +98 -19
package/dist/signals/schema.js
CHANGED
|
@@ -1,13 +1,26 @@
|
|
|
1
1
|
import { sql } from "drizzle-orm";
|
|
2
2
|
import { bigint, bigserial, index, integer, jsonb, pgTable, primaryKey, text, timestamp, } from "drizzle-orm/pg-core";
|
|
3
3
|
/**
|
|
4
|
-
*
|
|
4
|
+
* Five tables: the buffer batches wait in, and the four counters that outlive
|
|
5
5
|
* them.
|
|
6
6
|
*
|
|
7
7
|
* The split is 0146's — raw signals are short-lived and aggregates are durable
|
|
8
8
|
* — and it is in the schema rather than in a policy because a single table
|
|
9
9
|
* would make the retention rule a `DELETE` somebody has to remember to write
|
|
10
10
|
* correctly forever.
|
|
11
|
+
*
|
|
12
|
+
* All five carry `application_id` (0269), led by it in every key and every
|
|
13
|
+
* index, on the same terms as the store's four: a reader is filed against the
|
|
14
|
+
* application whose page they read, and no reading here spans two.
|
|
15
|
+
*
|
|
16
|
+
* All five then carry `audience_id` immediately after it
|
|
17
|
+
* ([0284](../../decisions/0284-a-signal-names-the-audience-it-was-collected-under-and-the-predicate-stays-in-the-control-plane.md)),
|
|
18
|
+
* which is the second of the two migrations
|
|
19
|
+
* [0273](../../decisions/0273-the-reader-tables-take-the-application-now-and-the-audience-when-it-is-ratified.md)
|
|
20
|
+
* chose to take rather than wait for. The two dimensions differ in kind, and
|
|
21
|
+
* the difference is why one is a handle's scope and the other is a column: no
|
|
22
|
+
* reading spans two applications, where comparing two audiences is the whole
|
|
23
|
+
* point of serving two.
|
|
11
24
|
*/
|
|
12
25
|
/**
|
|
13
26
|
* The buffer.
|
|
@@ -24,6 +37,32 @@ import { bigint, bigserial, index, integer, jsonb, pgTable, primaryKey, text, ti
|
|
|
24
37
|
*/
|
|
25
38
|
export const loomReaderSignals = pgTable("loom_reader_signals", {
|
|
26
39
|
seq: bigserial("seq", { mode: "number" }).primaryKey(),
|
|
40
|
+
/**
|
|
41
|
+
* The application the reading belongs to (0269). First in the key and in
|
|
42
|
+
* every index, as it is on the store's tables, because every read of this
|
|
43
|
+
* table is already inside one application.
|
|
44
|
+
*
|
|
45
|
+
* Defaulted so a database written before applications existed keeps
|
|
46
|
+
* answering, and so that every rollup, door and screen that names no
|
|
47
|
+
* application goes on meaning what it meant. `DEFAULT_APPLICATION_ID` is
|
|
48
|
+
* the value, spelled out because DDL cannot import it — `scoped.test.ts`
|
|
49
|
+
* holds the two together.
|
|
50
|
+
*/
|
|
51
|
+
applicationId: text("application_id").notNull().default("app_default"),
|
|
52
|
+
/**
|
|
53
|
+
* The audience this batch's reader was served under (0284). Second in the
|
|
54
|
+
* key and in every index, immediately after the application.
|
|
55
|
+
*
|
|
56
|
+
* Defaulted for the same reason the application is, and to the same effect:
|
|
57
|
+
* a batch that names no audience, and every row written before the
|
|
58
|
+
* dimension existed, reads as `aud_everyone` — the audience that matches
|
|
59
|
+
* every reader. `DEFAULT_AUDIENCE_ID` is the value, spelled out because DDL
|
|
60
|
+
* cannot import it; `scoped.test.ts` holds the two together.
|
|
61
|
+
*
|
|
62
|
+
* Opaque. What an `aud_` means is the control plane's to say, and no column
|
|
63
|
+
* here holds the predicate that selected it.
|
|
64
|
+
*/
|
|
65
|
+
audienceId: text("audience_id").notNull().default("aud_everyone"),
|
|
27
66
|
treeId: text("tree_id").notNull(),
|
|
28
67
|
revision: integer("revision").notNull(),
|
|
29
68
|
/** What the page said the time was, which is a number a page said. */
|
|
@@ -33,7 +72,20 @@ export const loomReaderSignals = pgTable("loom_reader_signals", {
|
|
|
33
72
|
receivedAt: timestamp("received_at", { withTimezone: true })
|
|
34
73
|
.notNull()
|
|
35
74
|
.default(sql `now()`),
|
|
36
|
-
}, (table) => [
|
|
75
|
+
}, (table) => [
|
|
76
|
+
/**
|
|
77
|
+
* Unchanged by the audience dimension, which is not the shape the
|
|
78
|
+
* application took (0284).
|
|
79
|
+
*
|
|
80
|
+
* The index was widened to lead with the application because every read of
|
|
81
|
+
* the buffer is inside one (0273), so it belongs in the prefix. Nothing reads the
|
|
82
|
+
* buffer by audience: a rollup folds a whole window and groups by the
|
|
83
|
+
* column, so putting the audience second here would displace `tree_id` and
|
|
84
|
+
* `seq` from the prefix and make every read that exists scan wider, to
|
|
85
|
+
* serve a filter no caller expresses.
|
|
86
|
+
*/
|
|
87
|
+
index("loom_reader_signals_tree_seq_idx").on(table.applicationId, table.treeId, table.seq),
|
|
88
|
+
]);
|
|
37
89
|
/**
|
|
38
90
|
* One node at one revision, summed.
|
|
39
91
|
*
|
|
@@ -42,6 +94,10 @@ export const loomReaderSignals = pgTable("loom_reader_signals", {
|
|
|
42
94
|
* surrogate id would mean a lookup before every one of those.
|
|
43
95
|
*/
|
|
44
96
|
export const loomReaderTallies = pgTable("loom_reader_tallies", {
|
|
97
|
+
/** See `loomReaderSignals.applicationId`. */
|
|
98
|
+
applicationId: text("application_id").notNull().default("app_default"),
|
|
99
|
+
/** See `loomReaderSignals.audienceId`. In the key here, unlike the buffer's. */
|
|
100
|
+
audienceId: text("audience_id").notNull().default("aud_everyone"),
|
|
45
101
|
treeId: text("tree_id").notNull(),
|
|
46
102
|
revision: integer("revision").notNull(),
|
|
47
103
|
nodeId: text("node_id").notNull(),
|
|
@@ -58,8 +114,24 @@ export const loomReaderTallies = pgTable("loom_reader_tallies", {
|
|
|
58
114
|
activations: bigint("activations", { mode: "number" }).notNull(),
|
|
59
115
|
opens: bigint("opens", { mode: "number" }).notNull(),
|
|
60
116
|
closes: bigint("closes", { mode: "number" }).notNull(),
|
|
117
|
+
/**
|
|
118
|
+
* Added with the fifth kind, and defaulted for the same reason `engaged`
|
|
119
|
+
* is: a deployment whose table predates the question has rows for which
|
|
120
|
+
* `0` is the true answer, not a missing one.
|
|
121
|
+
*/
|
|
122
|
+
completions: bigint("completions", { mode: "number" }).notNull().default(0),
|
|
61
123
|
updatedAt: timestamp("updated_at", { withTimezone: true }).notNull(),
|
|
62
|
-
}, (table) => [
|
|
124
|
+
}, (table) => [
|
|
125
|
+
primaryKey({
|
|
126
|
+
columns: [
|
|
127
|
+
table.applicationId,
|
|
128
|
+
table.audienceId,
|
|
129
|
+
table.treeId,
|
|
130
|
+
table.revision,
|
|
131
|
+
table.nodeId,
|
|
132
|
+
],
|
|
133
|
+
}),
|
|
134
|
+
]);
|
|
63
135
|
/**
|
|
64
136
|
* One funnel pair at one revision.
|
|
65
137
|
*
|
|
@@ -68,6 +140,10 @@ export const loomReaderTallies = pgTable("loom_reader_tallies", {
|
|
|
68
140
|
* has instead of orphaning them.
|
|
69
141
|
*/
|
|
70
142
|
export const loomReaderFunnels = pgTable("loom_reader_funnels", {
|
|
143
|
+
/** See `loomReaderSignals.applicationId`. */
|
|
144
|
+
applicationId: text("application_id").notNull().default("app_default"),
|
|
145
|
+
/** See `loomReaderSignals.audienceId`. In the key here, unlike the buffer's. */
|
|
146
|
+
audienceId: text("audience_id").notNull().default("aud_everyone"),
|
|
71
147
|
treeId: text("tree_id").notNull(),
|
|
72
148
|
revision: integer("revision").notNull(),
|
|
73
149
|
fromNodeId: text("from_node_id").notNull(),
|
|
@@ -80,6 +156,8 @@ export const loomReaderFunnels = pgTable("loom_reader_funnels", {
|
|
|
80
156
|
}, (table) => [
|
|
81
157
|
primaryKey({
|
|
82
158
|
columns: [
|
|
159
|
+
table.applicationId,
|
|
160
|
+
table.audienceId,
|
|
83
161
|
table.treeId,
|
|
84
162
|
table.revision,
|
|
85
163
|
table.fromNodeId,
|
|
@@ -89,4 +167,80 @@ export const loomReaderFunnels = pgTable("loom_reader_funnels", {
|
|
|
89
167
|
],
|
|
90
168
|
}),
|
|
91
169
|
]);
|
|
170
|
+
/**
|
|
171
|
+
* One region at one revision, as page views that began there.
|
|
172
|
+
*
|
|
173
|
+
* The narrowest table in the subsystem, and the narrowness is the point: a tree,
|
|
174
|
+
* a revision, a country and a number. There is no view key, no address, no
|
|
175
|
+
* digest of one and no per-arrival row, so there is nothing here to join against
|
|
176
|
+
* — which is what makes a region safe to keep for as long as the counters it
|
|
177
|
+
* sits beside.
|
|
178
|
+
*
|
|
179
|
+
* Written on the request path rather than by a rollup, because the request is
|
|
180
|
+
* the only place the region was ever knowable, and `views` counts openings so
|
|
181
|
+
* that a long visit is not a large number.
|
|
182
|
+
*/
|
|
183
|
+
export const loomReaderRegions = pgTable("loom_reader_regions", {
|
|
184
|
+
/** See `loomReaderSignals.applicationId`. */
|
|
185
|
+
applicationId: text("application_id").notNull().default("app_default"),
|
|
186
|
+
/** See `loomReaderSignals.audienceId`. In the key here, unlike the buffer's. */
|
|
187
|
+
audienceId: text("audience_id").notNull().default("aud_everyone"),
|
|
188
|
+
treeId: text("tree_id").notNull(),
|
|
189
|
+
revision: integer("revision").notNull(),
|
|
190
|
+
/** A country code, or the word for not knowing. A closed set, so this column cannot be written freely. */
|
|
191
|
+
region: text("region").notNull(),
|
|
192
|
+
views: bigint("views", { mode: "number" }).notNull(),
|
|
193
|
+
updatedAt: timestamp("updated_at", { withTimezone: true }).notNull(),
|
|
194
|
+
}, (table) => [primaryKey({
|
|
195
|
+
columns: [table.applicationId, table.audienceId, table.treeId, table.revision, table.region],
|
|
196
|
+
})]);
|
|
197
|
+
/**
|
|
198
|
+
* One revision's page views, counted from both ends.
|
|
199
|
+
*
|
|
200
|
+
* Two columns rather than two tables, because they are two counts of the same
|
|
201
|
+
* page views and the only question anybody asks of them is their difference:
|
|
202
|
+
* `opened` is written at the door, once per page view that began, and
|
|
203
|
+
* `appearances` by each rollup that saw that page view in its window. Keeping
|
|
204
|
+
* them in one row makes the subtraction a column expression instead of a join,
|
|
205
|
+
* and makes it impossible for a reading to find one and not the other.
|
|
206
|
+
*
|
|
207
|
+
* Both default to nought because either side may create the row, and nought is
|
|
208
|
+
* the true answer for the column that has not been written yet rather than a
|
|
209
|
+
* missing one.
|
|
210
|
+
*
|
|
211
|
+
* As narrow as the regions table and for the same reason: a tree, a revision
|
|
212
|
+
* and two numbers. No view key, no region, nothing per arrival, nothing to join.
|
|
213
|
+
*/
|
|
214
|
+
export const loomReaderPageViews = pgTable("loom_reader_page_views", {
|
|
215
|
+
/** See `loomReaderSignals.applicationId`. */
|
|
216
|
+
applicationId: text("application_id").notNull().default("app_default"),
|
|
217
|
+
/** See `loomReaderSignals.audienceId`. In the key here, unlike the buffer's. */
|
|
218
|
+
audienceId: text("audience_id").notNull().default("aud_everyone"),
|
|
219
|
+
treeId: text("tree_id").notNull(),
|
|
220
|
+
revision: integer("revision").notNull(),
|
|
221
|
+
/** Page views that began. Counted once, at the door, never recounted. */
|
|
222
|
+
opened: bigint("opened", { mode: "number" }).notNull().default(0),
|
|
223
|
+
/** The same page views, once per rollup window each appeared in (0147). */
|
|
224
|
+
appearances: bigint("appearances", { mode: "number" }).notNull().default(0),
|
|
225
|
+
updatedAt: timestamp("updated_at", { withTimezone: true }).notNull(),
|
|
226
|
+
/**
|
|
227
|
+
* When a rollup last folded a window holding page views of this revision.
|
|
228
|
+
*
|
|
229
|
+
* The one column in this subsystem written by exactly one of a row's two
|
|
230
|
+
* writers, and that is its whole purpose: `updated_at` moves on every
|
|
231
|
+
* delivery the door counts *and* on every fold, so a deployment whose
|
|
232
|
+
* rollup has stopped keeps a fresh timestamp on a row whose appearances
|
|
233
|
+
* never move again. This one moves only when something folded.
|
|
234
|
+
*
|
|
235
|
+
* Nullable and undefaulted, which is the honest value for a row nothing
|
|
236
|
+
* has folded yet and for a row written before this column existed — those
|
|
237
|
+
* two are the same state, *nothing attests a fold*, and no fault is raised
|
|
238
|
+
* from it.
|
|
239
|
+
*/
|
|
240
|
+
foldedAt: timestamp("folded_at", { withTimezone: true }),
|
|
241
|
+
}, (table) => [
|
|
242
|
+
primaryKey({
|
|
243
|
+
columns: [table.applicationId, table.audienceId, table.treeId, table.revision],
|
|
244
|
+
}),
|
|
245
|
+
]);
|
|
92
246
|
//# sourceMappingURL=schema.js.map
|
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
|
*
|