@agentshouse/mdruntime 0.1.0-cfb2ae0107054 → 0.1.0-cfcbb238a5fa0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (124) hide show
  1. package/AGENTS.md +262 -262
  2. package/dist/acquisition.d.ts +14 -0
  3. package/dist/acquisition.d.ts.map +1 -0
  4. package/dist/acquisition.js +24 -0
  5. package/dist/adapter.d.ts +14 -7
  6. package/dist/adapter.d.ts.map +1 -1
  7. package/dist/bootstrap.d.ts +2 -1
  8. package/dist/bootstrap.d.ts.map +1 -1
  9. package/dist/bootstrap.js +4 -0
  10. package/dist/change-set.d.ts +2 -0
  11. package/dist/change-set.d.ts.map +1 -1
  12. package/dist/change-set.js +36 -10
  13. package/dist/chat/kit.d.ts +2 -1
  14. package/dist/chat/kit.d.ts.map +1 -1
  15. package/dist/chat/kit.js +3 -3
  16. package/dist/chat/list.d.ts +2 -1
  17. package/dist/chat/list.d.ts.map +1 -1
  18. package/dist/chat/list.js +4 -3
  19. package/dist/chat/message.d.ts.map +1 -1
  20. package/dist/chat/message.js +2 -2
  21. package/dist/chat/messages.d.ts +1 -0
  22. package/dist/chat/messages.d.ts.map +1 -1
  23. package/dist/chat/messages.js +4 -0
  24. package/dist/chat/provider.d.ts +1 -1
  25. package/dist/chat/provider.d.ts.map +1 -1
  26. package/dist/chat/provider.js +26 -17
  27. package/dist/chat/ready.d.ts +1 -0
  28. package/dist/chat/ready.d.ts.map +1 -1
  29. package/dist/chat/ready.js +2 -2
  30. package/dist/client.d.ts +10 -6
  31. package/dist/client.d.ts.map +1 -1
  32. package/dist/client.js +11 -2
  33. package/dist/collection.d.ts +17 -3
  34. package/dist/collection.d.ts.map +1 -1
  35. package/dist/collection.js +230 -19
  36. package/dist/connection.d.ts +23 -7
  37. package/dist/connection.d.ts.map +1 -1
  38. package/dist/connection.js +1065 -192
  39. package/dist/conversation.d.ts +11 -5
  40. package/dist/conversation.d.ts.map +1 -1
  41. package/dist/conversation.js +241 -100
  42. package/dist/durability.d.ts +7 -1
  43. package/dist/durability.d.ts.map +1 -1
  44. package/dist/entry.d.ts +2 -2
  45. package/dist/entry.d.ts.map +1 -1
  46. package/dist/entry.js +3 -3
  47. package/dist/host.d.ts +16 -2
  48. package/dist/host.d.ts.map +1 -1
  49. package/dist/host.js +82 -8
  50. package/dist/identity.d.ts +2 -0
  51. package/dist/identity.d.ts.map +1 -1
  52. package/dist/identity.js +6 -0
  53. package/dist/index.d.ts +8 -5
  54. package/dist/index.d.ts.map +1 -1
  55. package/dist/index.js +2 -0
  56. package/dist/memory.d.ts +7 -2
  57. package/dist/memory.d.ts.map +1 -1
  58. package/dist/memory.js +20 -7
  59. package/dist/model.d.ts +4 -2
  60. package/dist/model.d.ts.map +1 -1
  61. package/dist/model.js +10 -1
  62. package/dist/observation.d.ts +5 -2
  63. package/dist/observation.d.ts.map +1 -1
  64. package/dist/observation.js +22 -11
  65. package/dist/overlay.d.ts +2 -0
  66. package/dist/overlay.d.ts.map +1 -1
  67. package/dist/overlay.js +58 -55
  68. package/dist/query.d.ts +35 -3
  69. package/dist/query.d.ts.map +1 -1
  70. package/dist/query.js +8 -2
  71. package/dist/reach.d.ts +6 -3
  72. package/dist/reach.d.ts.map +1 -1
  73. package/dist/reach.js +16 -4
  74. package/dist/react.d.ts +7 -4
  75. package/dist/react.d.ts.map +1 -1
  76. package/dist/react.js +6 -4
  77. package/dist/read-side.d.ts +13 -6
  78. package/dist/read-side.d.ts.map +1 -1
  79. package/dist/read-side.js +285 -83
  80. package/dist/readiness.d.ts +53 -0
  81. package/dist/readiness.d.ts.map +1 -0
  82. package/dist/readiness.js +33 -0
  83. package/dist/reads.d.ts +11 -0
  84. package/dist/reads.d.ts.map +1 -0
  85. package/dist/reads.js +98 -0
  86. package/dist/recovery.d.ts +25 -0
  87. package/dist/recovery.d.ts.map +1 -0
  88. package/dist/recovery.js +197 -0
  89. package/dist/refresh.d.ts +4 -4
  90. package/dist/refresh.d.ts.map +1 -1
  91. package/dist/refresh.js +17 -10
  92. package/dist/replica.d.ts +1 -1
  93. package/dist/replica.d.ts.map +1 -1
  94. package/dist/replica.js +57 -20
  95. package/dist/room-draft.d.ts +13 -1
  96. package/dist/room-draft.d.ts.map +1 -1
  97. package/dist/room-draft.js +2 -2
  98. package/dist/rows.d.ts +5 -13
  99. package/dist/rows.d.ts.map +1 -1
  100. package/dist/rows.js +5 -13
  101. package/dist/save.d.ts +5 -0
  102. package/dist/save.d.ts.map +1 -1
  103. package/dist/save.js +36 -13
  104. package/dist/search.d.ts +36 -6
  105. package/dist/search.d.ts.map +1 -1
  106. package/dist/search.js +132 -46
  107. package/dist/seed.d.ts +16 -0
  108. package/dist/seed.d.ts.map +1 -0
  109. package/dist/seed.js +61 -0
  110. package/dist/shared.d.ts +11 -0
  111. package/dist/shared.d.ts.map +1 -0
  112. package/dist/shared.js +368 -0
  113. package/dist/status.d.ts +4 -0
  114. package/dist/status.d.ts.map +1 -1
  115. package/dist/store.d.ts +21 -5
  116. package/dist/store.d.ts.map +1 -1
  117. package/dist/store.js +157 -53
  118. package/dist/turn.d.ts +7 -0
  119. package/dist/turn.d.ts.map +1 -0
  120. package/dist/turn.js +45 -0
  121. package/dist/wire.d.ts +136 -32
  122. package/dist/wire.d.ts.map +1 -1
  123. package/dist/wire.js +48 -31
  124. package/package.json +2 -2
package/AGENTS.md CHANGED
@@ -5,295 +5,295 @@ Repository, change it, build, and push. They are documentation, not enforcement.
5
5
 
6
6
  ## The MD Runtime API
7
7
 
8
- App code reaches the MD Runtime through the remote client. The surfaces are
9
- Rooms, Query, Search, Observe, Types, Room Draft, Save, History, the binary file
10
- reads, Call, Reached, Log, the reported persistence answer, reauthorization,
11
- conversation, the chat draft, and Presentation State. Sync Status, the Service
12
- Mode, the storage-loss statement, the deployment facts and the signed-in member
13
- are observations only.
14
-
15
- The host attaches each port with its reach, and every member and observation
16
- answers within it: a Room outside it answers as one the replica does not hold,
17
- Rooms lists only the Rooms reached whole, a Room reached for single Documents
18
- shows only those Documents and the Types of the models that govern them, and
19
- without conversations the conversation members, the chat draft and the
20
- conversation observation hold none. A change of the reach reaches every open
21
- observation as its new value, a query keeping unchanged Documents the same objects.
22
-
23
- Every `observe` resolves, once its first value has arrived, to a handle:
24
- `current()` is the latest complete value, `subscribe(listener)` hears each later
25
- value whole and returns its unsubscribe, and `close()` ends the observation.
26
- Closing the port ends every handle and rejects every pending call and
27
- observation; a client that reconnects observes again.
28
-
29
- `observe('agents')` answers every Agent a new conversation can go to, each
30
- `{ identity, name }`, whether or not it has a conversation yet. Each conversation
31
- the Provider's conversation list names is held complete in the browser.
32
- `conversation.list()` and `observe('conversations')` answer each with its Agent's
33
- identity and name, its name, created and finished times, last outcome and live
34
- `state`: `asking` while a question waits, `working` while a turn runs, else
35
- `idle`, and `started`, when the running turn began, or `null`. Observe one with
36
- `observe('conversation', id, { limit })`: the view holds its latest `limit`
37
- messages, or all of them, oldest first, its chat draft, and what the Provider
38
- streams for it whether or not anything views it: the running `turn` with its
39
- message parts and its context in use and window, the open questions, the process
40
- state, and the CLI's commands and options. These live only in memory: the
41
- message accepted under the turn's id replaces the running turn, and none of them
42
- is stored or searchable. `chatDraft.write` and `chatDraft.discard` keep what the
43
- App Creator composes; sending it is a Provider Action that needs the Provider
44
- reachable and is never queued.
45
-
46
- A binary file at a Path is a binary Path entry. Query lists it by `path`, and
47
- History each of its revisions, with its `binaryFile` record and never its bytes:
48
- `{ state: 'accepted', revision, path, fileRef, byteLength, mediaType, sha256 }`,
49
- or, from a Save until the Provider accepts it, `{ state: 'pending', localId,
50
- path, byteLength, mediaType, sha256 }`. Write one with a Room Draft whose only
51
- part is `file: { blob }`, the `Blob`'s `type` its media type: Save keeps the
52
- bytes in its Pending Change, offline too, and acceptance gives the record the
53
- Provider's revision. Move or remove one as a Document, a pending one before or
54
- after Save too, its bytes following; once its Pending Change has gone to the
55
- Provider, Save refuses that as `unknown-revision` until it is accepted.
56
- `binaryFile.read(room, path, revision?)` answers a pending record's saved bytes,
57
- or asks the Provider again on every read of an accepted one or of a History
58
- revision, a removed file's last included, keeping nothing. Text, a Record
59
- attachment or a conversation message may name a file by its `fileRef`; read it
60
- with `binaryFile.readReference({ fileRef, referrer })`, the referrer being the
61
- `referrer` the Provider gave beside it, or `{ room, path }` of the document whose
62
- text names it. Both answer `{ kind: 'binary', blob }` or a refusal or failure.
63
-
64
- Rooms, Query, Search, Observe, Types, Room Draft, Save, and Reached never
65
- touch the network. History, the binary file reads and Call go to the Provider
66
- through the Adapter. Call takes the Action names the Adapter declares; any other
67
- name answers `undeclared` without reaching the Provider. A Call result whose
68
- effect the Provider places in a Room carries `at`, that Room and Room Version;
69
- `reached(room, roomVersion)` answers whether the Room's confirmed state has
70
- reached it, and the MD Runtime keeps refreshing that Room until it has;
71
- `reached(room, roomVersion, path)` answers whether the held confirmed copy of
72
- that document was written at a later Room Version. Each History revision
73
- names its author, `{ kind: 'user', id }` or `{ kind: 'site', id, name }`.
74
- History of a Path no current document holds answers the removed document's
75
- revisions with `deleted: true`, newest first; that revision is what a link to
76
- the Path opens. Every member of the client is asynchronous. Results are
77
- detached snapshots. Nothing in this surface returns the authorization, performs
78
- a request the App's code composes, or exposes the browser store.
79
-
80
- Every refusal and failure carries `code` and `retryable`: each Call and History
81
- answer other than its result, a refused Save or Room Draft write, a returned Room
82
- Draft's reason, a Room's refusal and the Connection Refusal, and every error a
83
- member rejects with, beside its message. A Provider refusal carries the
84
- Provider's own `retryable`. Every code and every value the API answers is open:
85
- handle one you do not know by its `code` and `retryable`.
86
-
87
- Read the deployment facts with `observe('deployment-facts')`, an opaque value
88
- the host's contract interprets. `observe('member')` answers who uses the App:
89
- the User the Provider signed in, `{ kind: 'user', id, name }` in the shape of a
90
- change's `author`, so a Document whose `change.author.id` equals its `id` is that
91
- User's own. It is `null` until the Provider first names one, and where it names
92
- none, such as a Site. The MD Runtime keeps it with the Local Replicas, so it
93
- answers offline once known, and every port hears the next member the Provider
94
- names; signing out answers `null`, then ends the observation with the
95
- authorization. It is the only way App code learns who uses it.
8
+ App code reaches the MD Runtime through the remote client. The surfaces are Rooms,
9
+ Query, Search, Observe, Types, Room Draft, Save, History, the binary file reads, Call,
10
+ Reached, Log, the reported persistence answer, reauthorization, conversation, the chat
11
+ draft, and Presentation State. Sync Status, readiness, the Service Mode, the storage-loss
12
+ statement, the deployment facts and the signed-in member are observations only.
13
+
14
+ The host attaches each port with its reach, and every member and observation answers
15
+ within it: a Room outside it answers as one the replica does not hold, Rooms lists only
16
+ the Rooms reached whole, a Room reached for single Documents shows only them and the Types
17
+ of their models, and without conversations the conversation members, chat draft and
18
+ observation hold none. A changed reach reaches every open observation as its new value.
19
+
20
+ Every `observe` resolves, once its first value has arrived, to a handle: `current()` is
21
+ the latest complete value, `subscribe(listener)` hears each later value whole and returns
22
+ its unsubscribe, and `close()` ends the observation. Closing the port ends every handle
23
+ and rejects every pending call and observation; a client that reconnects observes again.
24
+
25
+ `observe('agents')` answers every Agent a new conversation can go to, each `{ identity,
26
+ name }`, whether or not it has a conversation yet. Each conversation the Provider's
27
+ conversation list names is held complete in the browser. `conversation.list()` and
28
+ `observe('conversations')` answer each with its Agent's identity and name, its name,
29
+ created and finished times, last outcome and live `state`: `asking` while a question
30
+ waits, `working` while a turn runs, else `idle`, and `started`, when the running turn
31
+ began, or `null`. Observe one with `observe('conversation', id, { limit })`: the view
32
+ holds a window of its latest `limit` messages, or all of them, oldest first, its chat
33
+ draft, and what the Provider streams for it whether or not anything views it: the
34
+ running `turn` with its message parts and its context in use and window, the open
35
+ questions, the process state, and the CLI's commands and options. These live only in
36
+ memory: the message accepted under the turn's id replaces the running turn, and none of
37
+ them is stored or searchable. `chatDraft.write` and `chatDraft.discard` keep what the
38
+ App Creator composes; sending it is a Provider Action that needs the Provider reachable
39
+ and is never queued. A new conversation's chat draft is the one keyed `new:<Agent
40
+ identity>`: no conversation list removes it, a retired Agent's goes, and the first answer
41
+ to `conversation.create({ agent_id, operation_id })` moves it to the created conversation,
42
+ where `conversation.send(conversation)` sends it; a replay of that create moves nothing.
43
+
44
+ A binary file at a Path is a binary Path entry. Query lists it by `path`, and History
45
+ each of its revisions, with its `binaryFile` record and never its bytes: `{ state:
46
+ 'accepted', revision, path, fileRef, byteLength, mediaType, sha256 }`, or, from a Save
47
+ until the Provider accepts it, `{ state: 'pending', localId, path, byteLength, mediaType,
48
+ sha256 }`. Write one with a Room Draft whose only part is `file: { blob }`, the `Blob`'s
49
+ `type` its media type: Save keeps the bytes in its Pending Change, offline too, and
50
+ acceptance gives the record the Provider's revision. Move or remove one as a Document, a
51
+ pending one before or after Save too, its bytes following; once its Pending Change has
52
+ gone to the Provider, Save refuses that as `unknown-revision` until it is accepted.
53
+ `binaryFile.read(room, path, revision?)` answers a pending record's saved bytes, or asks
54
+ the Provider on every read of an accepted one or a History revision, a removed file's
55
+ last included, keeping nothing. Text, a Record attachment or a conversation message may
56
+ name a file by its `fileRef`; read it with `binaryFile.readReference({ fileRef, referrer
57
+ })`, the `referrer` the Provider gave beside it, or `{ room, path }` of the document
58
+ whose text names it. Both answer `{ kind: 'binary', blob }` or a refusal or failure.
59
+
60
+ Rooms, Query, Search, Observe, Types, Room Draft, Save, and Reached never touch the
61
+ network. History, the binary file reads and Call go to the Provider through the Adapter.
62
+ Call takes the Action names the Adapter declares; any other name answers `undeclared`
63
+ without reaching the Provider. A Call result whose effect the Provider places in a Room
64
+ carries `at`, that Room and Room Version; `reached(room, roomVersion)` answers whether
65
+ the Room's confirmed state has reached it, and the MD Runtime keeps refreshing that Room
66
+ until it has; `reached(room, roomVersion, path)` answers whether the held confirmed copy
67
+ of that document was written at a later Room Version. Each History revision names its
68
+ author, `{ kind: 'user', id }` or `{ kind: 'site', id, name }`. History of a Path no
69
+ current document holds answers the removed document's revisions with `deleted: true`,
70
+ newest first; that revision is what a link to the Path opens. Every member of the client
71
+ is asynchronous. Results are detached snapshots. Nothing in this surface returns the
72
+ authorization, performs a request the App's code composes, or exposes the browser store.
73
+
74
+ Every refusal and failure carries `code` and `retryable`: each Call and History answer
75
+ other than its result, a refused Save or Room Draft write, a returned Room Draft's
76
+ reason, a Room's refusal and the Connection Refusal, and every error a member rejects
77
+ with, beside its message. A Provider refusal carries the Provider's own `retryable`.
78
+ Every code and every value the API answers is open: handle one you do not know by its
79
+ `code` and `retryable`. Only a tag telling which fields a value carries, such as an
80
+ answer's `kind`, is closed so it narrows: keep a branch for a tag you do not know. A
81
+ model with no usable types answers `types: null`, whatever its `status`.
82
+
83
+ Read the deployment facts with `observe('deployment-facts')`, an opaque value the host's
84
+ contract interprets. `observe('member')` answers who uses the App: the User the Provider
85
+ signed in, `{ kind: 'user', id, name }` in the shape of a change's `author`, so a
86
+ Document whose `change.author.id` equals its `id` is that User's own. It is `null` until
87
+ the Provider first names one, and where it names none, such as a Site. The MD Runtime
88
+ keeps it with the Local Replicas, so it answers offline once known, and every port hears
89
+ the next member the Provider names; signing out answers `null`, then ends the
90
+ observation with the authorization. It is the only way App code learns who uses it.
96
91
 
97
92
  ## Local Query rules
98
93
 
99
- `query(q)` answers once from local state; `observe('query', q)` holds the whole
100
- result and hears it again only when it changes, keeping every unchanged Document
101
- the same object, so a component can tell what changed by identity. A query is
102
- data:
103
-
104
- - **Filter.** `rooms` names Room locators and defaults to every Room. `types`
105
- names MD Types, and `any` names untyped Markdown Documents. `pathPrefix` is a
106
- directory: `notes` keeps `notes/a.md` and not `notes2/a.md`.
94
+ `query(q)` answers once from local state; `observe('query', q)` holds the whole result
95
+ and hears it again only when it changes, keeping every unchanged Document the same
96
+ object, so a component can tell what changed by identity. An answer is complete or
97
+ pending: `{ documents, coverage }` or `{ groups, coverage }` is complete for the Rooms
98
+ its `coverage` names, and `{ pending }` names each Room not yet acquired or prepared,
99
+ `[{ room, awaits }]`. Never read a pending answer as empty: draw it as loading, and
100
+ observe the query to hear the complete one. A query is data:
101
+
102
+ - **Filter.** `rooms` names Room locators and defaults to every Room. `types` names MD
103
+ Types, and `any` names untyped Markdown Documents. `pathPrefix` is a directory:
104
+ `notes` keeps `notes/a.md` and not `notes2/a.md`.
107
105
  - **Fields.** Every frontmatter value is named by JSON Pointer: `/status`,
108
- `/shipping/city`, `~1` for a `/` and `~0` for a `~` in a key. A segment that
109
- meets a list applies to every item and a number names one item. `where` names
110
- pointers, ANDs them, and nests `$and` and `$or`; a pointer through a list holds
111
- when any item satisfies it. A bare value is equality; the operators are `$eq`,
112
- `$ne`, `$in`, `$nin`, `$gt`, `$gte`, `$lt`, `$lte`, `$all`, `$size` and
113
- `$exists`. Equality on a list asks whether it contains the value. Missing,
114
- null and empty differ: `$exists: false` keeps a missing field, `null` an
115
- explicit null, `''` empty text and `$size: 0` an empty list. A date compares
116
- in calendar order and never with a date-time. A reference compares by the Room
117
- Path it resolves to. Untyped frontmatter, and a value under `oneOf` or a
106
+ `/shipping/city`, `~1` for a `/` and `~0` for a `~` in a key. A segment that meets a
107
+ list applies to every item and a number names one item. `where` names pointers, ANDs
108
+ them, and nests `$and` and `$or`; a pointer through a list holds if any item satisfies
109
+ it. A bare value is equality; the operators are `$eq`, `$ne`, `$in`, `$nin`, `$gt`,
110
+ `$gte`, `$lt`, `$lte`, `$all`, `$size` and `$exists`. Equality on a list asks if it
111
+ contains the value. Missing, null and empty differ: `$exists: false` keeps a missing
112
+ field, `null` an explicit null, `''` empty text and `$size: 0` an empty list. A date
113
+ compares in calendar order and never with a date-time. A reference compares by the
114
+ Room Path it resolves to. Untyped frontmatter, and a value under `oneOf` or a
118
115
  conditional, is plain values. There is no text containment or regular expression.
119
116
  - **Relations.** `hop: { field, types, where, pathPrefix }` keeps Documents whose
120
- reference at pointer `field`, at any depth, points to a matching Document of the
121
- same Room. `backlinks: { field, types, where, pathPrefix }` keeps Documents that a
122
- matching Document of the same Room references. Each keeps a Document once.
117
+ reference at pointer `field`, at any depth, points to a matching Document of the same
118
+ Room. `backlinks: { field, types, where, pathPrefix }` keeps Documents that a matching
119
+ Document of the same Room references. Each keeps a Document once.
123
120
  - **Parts.** A Document query must `select`: `'all'`, or `fields`, `sections`,
124
- `preamble`, `markdown`, `backlinks` and `change`, where `fields` is `'all'` or a
125
- list of pointers and `sections` `'all'` or a list of names. Selected pointers
126
- return the frontmatter holding only them, nested as written. A backlink names
127
- the referring Path, MD Type and the pointer it came from as `field`. Room and Path always return; a Markdown
128
- Document also returns its MD Type. A non-Markdown Document returns only Room
129
- and Path, and a binary Path entry Room, Path and its `binaryFile` record,
130
- whatever is selected. An unselected part is absent. Select only
131
- what a screen shows: a list that selects the Markdown hears every edit of it.
132
- - **Change.** `change` is `{ author, time }` of the Document's head revision as
133
- the Provider last delivered it: `author` is `{ kind: 'user' | 'site', id, name }`
134
- or `null` for a write the Provider made itself, and `time` is the Provider's
135
- ISO 8601 change time. It is `null` where the Provider delivered no time, as at
136
- a Site. An unsent edit or move keeps it, an unsent creation has none, and a
137
- saved write takes the Provider's own once it is Accepted. A
138
- Room's last change is its Document with the latest `time`.
139
- - **Order and groups.** `orderBy` sorts by `room`, `path`, `type` or `{ field }`
140
- with TanStack DB's own options, and ties end with Room, then Path. `groupBy` by
141
- `room`, `type` or `{ field }` answers `{ groups: [{ key, count }] }`, counted
142
- over every match and ordered by `count` or a key. A sort or group takes only a
143
- pointer that holds one value. `limit` bounds the Documents or the groups.
144
- - **Results and errors.** A result carries no Room Version: read freshness from
145
- Rooms and Sync Status. An invalid query fails with the `code`
146
- `invalid-query`, `unknown-type`, `unknown-field` or `wrong-kind`, naming where,
147
- and never answers an empty result in its place.
121
+ `preamble`, `markdown`, `backlinks`, `change` and `fileId`, where `fields` is `'all'`
122
+ or a list of pointers and `sections` `'all'` or a list of names. Selected pointers
123
+ return the frontmatter holding only them, nested as written. A backlink names the
124
+ referring Path, MD Type and the pointer it came from as `field`. Room and Path always
125
+ return; a Markdown Document also returns its MD Type. A non-Markdown Document returns
126
+ only Room, Path and a selected `fileId`, and a binary Path entry its `binaryFile`
127
+ record too. An unselected part is absent. Select only what a screen shows: a list that
128
+ selects the Markdown hears every edit of it.
129
+ - **Change.** `change` is `{ author, time }` of the Document's head revision as the
130
+ Provider last delivered it: `author` is `{ kind: 'user' | 'site', id, name }` or `null`
131
+ for a write the Provider made itself, and `time` is the Provider's ISO 8601 change
132
+ time. It is `null` where the Provider delivered no time, as at a Site. An unsent edit
133
+ or move keeps it, an unsent creation has none, and a saved write takes the Provider's
134
+ own once it is Accepted. A Room's last change is its Document with the latest `time`.
135
+ - **File ID.** `fileId` is the Provider's Stable File ID of the file at the Path, or
136
+ `null` where the Provider supplies none. An unsent edit keeps it, an unsent move
137
+ carries it to the new Path, and an unsent creation has none until it is Accepted, so a
138
+ file ID that leaves one Path for another is the same file moved.
139
+ - **Order and groups.** `orderBy` sorts by `room`, `path`, `type` or `{ field }` with
140
+ TanStack DB's own options, and ties end with Room, then Path. `groupBy` by `room`,
141
+ `type` or `{ field }` answers `{ groups: [{ key, count }] }`, counted over every match
142
+ and ordered by `count` or a key. A sort or group takes only a pointer that holds one
143
+ value. `limit` bounds the Documents or the groups.
144
+ - **Results and errors.** A result carries no Room Version: read freshness from Rooms
145
+ and Sync Status. `coverage` names each Room read as `{ room, generation, current }`,
146
+ `current` false while a newer copy of that Room is being fetched, and the queued
147
+ changes it includes as `overlay`; a Save in a Room changes the `overlay` of every
148
+ query over it. An invalid query fails with the `code` `invalid-query`, `unknown-type`,
149
+ `unknown-field` or `wrong-kind`, naming where, and never answers empty in its place.
148
150
 
149
151
  ## Local Search rules
150
152
 
151
- `search({ text, documents, conversations, limit })` answers once, by words, from
152
- local state, with MiniSearch's defaults. There is no observed search.
153
-
154
- - **What is found.** A Document by its field values, its sections' headings and
155
- text, its preamble and its Path; a message by its text. Frontmatter keys, Room
156
- Drafts, chat drafts and a running turn's parts are never found. There are no phrases,
157
- word forms, typo tolerance or prefix matching.
158
- - **Narrowing.** `documents` is a Local Query filter: `rooms`, `types`, `where`,
159
- `pathPrefix`, `hop` and `backlinks`. `conversations` names conversations. Both
153
+ `search({ text, documents, collection, conversations, limit })` answers once, by words,
154
+ from local state, with MiniSearch's defaults. There is no observed search.
155
+
156
+ - **Declaration.** Only an App whose release declares Local Search searches, its first
157
+ readiness waiting for its index; any other App's `search` answers the never retryable
158
+ `undeclared` refusal `search-undeclared`, its `fields` naming `local_search`.
159
+ - **What is found.** A Document by its field values, its sections' headings and text,
160
+ its preamble and its Path; a message by its text. Frontmatter keys, Room Drafts, chat
161
+ drafts and a running turn's parts are never found. There are no phrases, word forms,
162
+ typo tolerance or prefix matching.
163
+ - **Narrowing.** `documents` is a Local Query filter, and `collection: true` leaves out
164
+ what each Room's `typedSelection` roots hold; `conversations` names conversations. All
160
165
  apply before `limit`, which bounds each list; without it every hit returns.
161
- - **Results.** `{ documents, messages }`, each ranked by `score`, which compares
162
- hits of one list of one search. A Document hit names its `room`, `path` and
163
- `type`, a message hit its `conversation` and `identity`, and `matches` maps each
164
- matched word to the parts it matched in: `fields`, `sections`, `preamble` or
165
- `path`, or `text`. A hit carries no position; mark the words in the text you
166
- show. An invalid filter fails with its Local Query error.
166
+ - **Results.** `{ documents, messages, coverage }`, or the same with `pending` naming each
167
+ Room or conversation the search still waits for: show its hits, ask again, and never
168
+ read pending as no hits. `coverage` names the Rooms and conversations searched. Each
169
+ list is ranked by `score`, comparable only within it; tied Documents come by `room`,
170
+ then `path`. A Document hit names its `room`, `path` and `type`, a message hit its
171
+ `conversation` and `identity`; `matches` maps each matched word to the parts it matched
172
+ in: `fields`, `sections`, `preamble`, `path` or `text`. A hit carries no position: mark
173
+ the words in the text you show. An invalid filter fails with its Local Query error.
167
174
 
168
175
  ## Room Draft, Save, and outcome rules
169
176
 
170
- The MD Runtime owns one Room Draft per Room and Path, shared by every App and tab.
171
- It is durable: it survives reload and navigation. A Room that Discovery stops
172
- listing takes its Room Drafts and its queue with it. Write a Room Draft with
173
- `roomDraft.write(room, path, revision, parts)`, naming the revision you read, or
174
- `null` when there was none, and every part it should now change: fields, sections
175
- and the preamble, or the whole Markdown, a creation, a move, or a removal. A part
176
- new to the Room Draft names its base, the value you showed when it was opened; the
177
- MD Runtime keeps a part's first base; a binary Path entry's move or removal takes
178
- `null` as its base. A write or a discard from an older revision is refused as
179
- `stale` with the current Room Draft; read it and write again.
180
-
181
- Save takes one Room and the Room Drafts of it to save, each with its revision,
182
- validates locally, and on success appends one Change Batch to that Room's
183
- queue and removes those Room Drafts. It is refused with the `code` `stale`,
184
- `changed-underneath` naming each part whose base no longer matches the visible
185
- state, or a local validation rule, and then creates nothing and leaves every
186
- Room Draft in place. A directory move or removal is a move or removal part on
187
- each Document and binary Path entry beneath it, saved together.
188
-
189
- Outcomes follow the Provider's answer. An Accepted Change Batch stays in the
190
- queue, drawn over the confirmed layer, until the confirmed layer reaches the
191
- Room Version it was accepted at, and then leaves it. Conflicted and Rejected, an expired operation, and a change that no
192
- longer applies over the Room each leave the queue and return as Room Drafts on
193
- the Documents they changed, marked with why: the Provider's structured refusal
194
- code and fields as returned, not known to have applied, or withdrawn locally.
195
- The rest of the queue keeps synchronizing, and Sync Status requires attention
196
- until each returned Room Draft is saved again or discarded. A Change Batch
197
- keeps no outcome once it leaves the queue; `observe('queue', room)` shows each
198
- Pending one, and a returned Room Draft says why it returned. Transport
199
- failure and Provider unavailability keep work Pending and do not infer a
200
- rejection. A refusal the Provider marks retryable stays Pending until the reset
201
- it names; the MD Runtime retries the same Change Batch identity and payload and
202
- never infers an outcome from transport uncertainty. The MD Runtime never
203
- combines, reorders, or rebases.
204
-
205
- On a Site, every Save stays in the visitor's browser. Write grants and revisions
206
- do not refuse it, and its Pending Change shows in every query and across reloads
207
- until the browser's storage is cleared. It is never sent: `observe('queue', room)`
208
- shows it `local`, and Sync Status never waits on it. Once the Room changes so that
209
- it no longer applies, it leaves the queue and returns no Room Draft.
210
-
211
- `observe('service-mode')` answers the Provider's Service Mode, `open` or
212
- `write-halted`. While writes are halted, Save still succeeds, its Change Batch
213
- waits unsent, and the queue is submitted in order once the Provider reopens
214
- writes. An Action is never held: a write the Provider refuses for the halt returns
215
- that refusal to its caller. Show the Provider as read-only instead of retrying.
216
-
217
- ## The neutrality rule
218
-
219
- No module outside an Adapter package imports, names, or special-cases a
220
- Provider. MD UI and every App reach data only through the client entry.
177
+ The MD Runtime owns one Room Draft per Room and Path, shared by every App and tab. It is
178
+ durable: it survives reload and navigation. A Room the Provider reports lost takes its
179
+ Room Drafts and its queue with it. Write a Room Draft with `roomDraft.write(room, path,
180
+ revision, parts)`, naming the revision you read, or `null` when there was none, and every
181
+ part it should now change: fields, sections and the preamble, or the whole Markdown, a
182
+ creation, a move, or a removal. A part new to the Room Draft names its base, the value
183
+ you showed when it was opened; the MD Runtime keeps a part's first base; a binary Path
184
+ entry's move or removal takes `null` as its base. A write or a discard from an older
185
+ revision is refused as `stale` with the current Room Draft; read it and write again.
186
+
187
+ Save takes one Room and the Room Drafts of it to save, each with its revision, validates
188
+ locally, and on success appends one Change Batch to that Room's queue and removes those
189
+ Room Drafts. It is refused with the `code` `stale`, `changed-underneath` naming each
190
+ part whose base no longer matches the visible state, or a local validation rule, and
191
+ then creates nothing and leaves every Room Draft in place. A directory move or removal
192
+ is that part on each Document and binary Path entry beneath it, saved together.
193
+
194
+ Outcomes follow the Provider's answer. An Accepted Change Batch stays in the queue, drawn
195
+ over the confirmed layer, until that layer reaches the Room Version it was accepted at,
196
+ then leaves it. Conflicted and Rejected, an expired operation, and a change that no
197
+ longer applies over the Room each leave the queue and return as Room Drafts on their
198
+ Documents, marked with why: the Provider's structured refusal code and fields as
199
+ returned, not known to have applied, or withdrawn locally. The rest of the queue keeps
200
+ synchronizing, and Sync Status requires attention until each returned Room Draft is saved
201
+ or discarded. A Change Batch keeps no outcome once it leaves the queue; `observe('queue',
202
+ room)` shows each Pending one. Transport failure and Provider unavailability keep work
203
+ Pending, as does a refusal the Provider marks retryable until the reset it names; the MD
204
+ Runtime retries the same Change Batch identity and payload, never infers an outcome from
205
+ transport uncertainty, and never combines, reorders, or rebases.
206
+
207
+ On a Site, every Save stays in the visitor's browser. Write grants and revisions do not
208
+ refuse it, and its Pending Change shows in every query and across reloads until the
209
+ browser's storage is cleared. It is never sent: `observe('queue', room)` shows it
210
+ `local`, and Sync Status never waits on it. Once the Room changes so that it no longer
211
+ applies, it leaves the queue and returns no Room Draft.
212
+
213
+ `observe('service-mode')` answers the Provider's Service Mode, `open` or `write-halted`.
214
+ While writes are halted, Save still succeeds, its Change Batch waits unsent, and the queue
215
+ is submitted in order once writes reopen. An Action is never held: one the halt refuses
216
+ returns that refusal to its caller. Show the Provider as read-only instead of retrying.
217
+ `observe('readiness')` tells whether the App's code and bound Rooms are held locally
218
+ (`ready`), each Room's state, each refused Room's file and rule, the persistence answer
219
+ and a paused preparation's `capacity` cause; `retry()` resumes a paused preparation.
221
220
 
222
221
  ## Content-safety rules
223
222
 
224
- The Provider authorization belongs to the Runtime host and is never readable
225
- by the App's code. The App's code reaches the network only at the external
226
- origins its manifest declares, empty by default, and the Provider enforces
227
- that set. Every request to the Provider itself goes through the MD Runtime.
228
- Rendered Markdown never executes scripts, renders raw HTML only for the
229
- details and summary elements, and loads images and other resources only from
230
- origins the Provider's policy allows.
223
+ The Provider authorization belongs to the Runtime host and is never readable by the App's
224
+ code. The App's code reaches the network only at the external origins its manifest
225
+ declares, empty by default, and the Provider enforces that set. Rendered Markdown never
226
+ executes scripts, renders raw HTML only for the details and summary elements, and loads
227
+ images and other resources only from origins the Provider's policy allows.
231
228
 
232
229
  ## Launch promises MD UI keeps
233
230
 
234
- MD UI uses semantic HTML, is fully operable from a keyboard with visible
235
- focus and labelled controls, and lays out from a 360 pixel wide viewport to
236
- a desktop. Its strings are English only, dates and numbers follow the
237
- browser locale, and content is never translated. Light and dark themes come
238
- from CSS custom properties with the browser's preference as the default and
239
- an App's override respected. What an App Creator's agent adds carries none
240
- of these promises by itself. Reading, querying and searching never wait for
241
- the network. Data lives only in the App Creator's browser and with the Provider.
231
+ MD UI uses semantic HTML, is fully operable from a keyboard with visible focus and
232
+ labelled controls, and lays out from a 360 pixel wide viewport to a desktop. Its strings
233
+ are English only, dates and numbers follow the browser locale, and content is never
234
+ translated. Light and dark themes come from CSS custom properties, defaulting to the
235
+ browser's preference and respecting an App's override. What an agent adds carries none of
236
+ these promises by itself. Data lives only in the App Creator's browser and the Provider.
242
237
 
243
238
  ## App code takes the client its host hands it and never constructs a Runtime
244
239
 
245
- App code takes the client its host hands it: in House, `houseBridge().runtime`
246
- from `@agentshouse/app-bridge` resolves to the client House built into the page.
247
- It imports only types from `@agentshouse/mdruntime/client`, never calls
248
- `connectMdRuntime` or `serveMdRuntime`, and never imports the package main, the
249
- host entry or the Adapter package, which hosts and tests use. The in-memory
250
- Adapter at `@agentshouse/mdruntime/memory` is for tests and ships in no bundle.
251
- A Site's page fills its Entry Data Contract's `{"$param": name}` arguments with
252
- `boundQuery` from `@agentshouse/mdruntime/entry`, as House did for its HTML.
253
-
254
- A React App may observe and save through `@agentshouse/mdruntime/react`, which
255
- names React as a peer dependency. `useObserve(client, topic, ...input)` takes
256
- the arguments of `observe` and returns `{ state: 'loading' }` until the topic's
257
- first value arrives, then `{ state: 'ready', value }`, re-rendering on each
258
- change; a `null` client observes nothing and stays loading. `useSave(client)`
259
- returns `busy`, the last `outcome` or `failure`, and `save(room, roomDrafts)`,
260
- which writes each Path's parts onto the Room Draft already there, keeping the
261
- bases its parts have, or onto a new one, and saves them together. A refused
262
- Save leaves the Room Drafts for the App to save again or discard; a failure is
263
- recorded and rejects. `saveRoomDrafts(client, room, roomDrafts)` is that save
264
- outside a component. A react-admin or Refine App reads and writes its Rooms
265
- through the data providers of `@agentshouse/mdruntime-families`.
240
+ No module outside an Adapter package imports, names, or special-cases a Provider, and
241
+ every App and MD UI reach data only through the client entry. In House,
242
+ `houseBridge().runtime` from `@agentshouse/app-bridge` resolves to the client House built
243
+ into the page. App code imports only types from `@agentshouse/mdruntime/client`, never
244
+ calls `connectMdRuntime` or `serveMdRuntime`, and never imports the package main, the host
245
+ entry or the Adapter package, which hosts and tests use. The in-memory Adapter at
246
+ `@agentshouse/mdruntime/memory` is for tests and ships in no bundle. A Site's page fills
247
+ its Entry Data Contract's `{"$param": name}` arguments with `boundQuery` from
248
+ `@agentshouse/mdruntime/entry`, as House did for its HTML. While the Site prepares, each
249
+ query a route's `interaction` names answers from the entry's result when the page observes
250
+ that same descriptor, and every other stays pending. House replaces its HTML with the page
251
+ once its document changed after those answers, or readiness is `ready`, and then held
252
+ still for two animation frames, unless the visitor uses the HTML: draw the route from them
253
+ at once, never behind a placeholder. Before readiness is `ready`, `push` loads a new page.
254
+
255
+ A React App may observe and save through `@agentshouse/mdruntime/react`, which names
256
+ React as a peer dependency. `useObserve(client, topic, ...input)` takes the arguments of
257
+ `observe` and returns `{ state: 'loading' }` until the topic's first value arrives, then
258
+ `{ state: 'ready', value }`, re-rendering on each change; a `null` client observes
259
+ nothing and stays loading. `useSave(client)` returns `busy`, the last `outcome` or
260
+ `failure`, and `save(room, roomDrafts)`, which writes each Path's parts onto the Room
261
+ Draft already there, keeping the bases its parts have, or onto a new one, and saves them
262
+ together. A refused Save leaves the Room Drafts for the App to save again or discard; a
263
+ failure is recorded and rejects. `saveRoomDrafts(client, room, roomDrafts)` is that save
264
+ outside a component. An App that writes its Room Drafts itself saves them with
265
+ `saveWritten(room, roomDrafts)`, each named with the revision its last write returned: one
266
+ another tab wrote since is refused as `stale`, and nothing is saved. A react-admin or
267
+ Refine App uses the data providers of `@agentshouse/mdruntime-families`.
266
268
 
267
269
  ## The Chat
268
270
 
269
- `@agentshouse/mdruntime/chat` holds the Chat, one data layer for every App; add
270
- React as a dependency in any App, with React DOM and `@assistant-ui/react`.
271
-
272
- Place the ready chat with `<Chat client={runtime} conversation={id}
273
- agent={agent} width="1/3" showChats />`: `conversation` opens one, `null` for a
274
- new chat, `agent` is the Agent a new chat goes to, `onOpen` hears each one it
275
- opens, and `width` is `full` (the place you give it), or `3/4`, `1/2` or `1/3`
276
- of the window docked at its right edge, whole on a narrow window. `showChats`
277
- adds its conversation list; or draw your own inside a `ChatProvider` around a
278
- `<Chat />` with no `client`. It carries its own styles; theme it with CSS custom
279
- properties on it or an ancestor: `--chat-background`, `--chat-surface`,
280
- `--chat-text`, `--chat-text-muted`, `--chat-accent`, `--chat-line`,
271
+ `@agentshouse/mdruntime/chat` holds the Chat, one data layer for every App; add React as
272
+ a dependency in any App, with React DOM and `@assistant-ui/react`.
273
+
274
+ Place the ready chat with `<Chat client={runtime} conversation={id} agent={agent}
275
+ width="1/3" showChats />`: `conversation` opens one, `null` for a new chat, `agent` is
276
+ the Agent a new chat goes to, `onOpen` hears each one it opens, and `width` is `full`
277
+ (the place you give it), or `3/4`, `1/2` or `1/3` of the window docked at its right
278
+ edge, whole on a narrow window. `showChats` adds its conversation list; or draw your own
279
+ inside a `ChatProvider` around a `<Chat />` with no `client`. It carries its own styles;
280
+ theme it with CSS custom properties on it or an ancestor: `--chat-background`,
281
+ `--chat-surface`, `--chat-text`, `--chat-text-muted`, `--chat-accent`, `--chat-line`,
281
282
  `--chat-attention`, `--chat-danger`, `--chat-font`, `--chat-font-mono`,
282
- `--chat-font-size`, `--chat-radius` and `--chat-density` (a factor for spacing);
283
- an unset one keeps House's light or dark look. `mountChat(element, { client })`
284
- places it outside React and returns `update(props)` and `unmount()`.
285
-
286
- Mix `ChatMessageList` (`components` takes your `UserMessage` and
287
- `AssistantMessage`), `ChatInput` and `ChatQuestionCard` with your own design
288
- inside a `ChatProvider`, or compose assistant-ui's primitives there; `useChat()`
289
- gives `send`, the conversations, the Agents, questions to `answer`, `options`
290
- to `choose`, `commands`, the queue to `edit` or `unqueue`, `stop`, `kill` and
291
- outcomes; never replace its messages, sending or store. A secret question is
292
- never answered here; typed answers live in Presentation State's `typed` key:
293
- keep it, and change Presentation State only inside `inTurn(client, work)` from
294
- `@agentshouse/mdruntime/client`. `Markdown` draws Markdown safely.
283
+ `--chat-font-size`, `--chat-radius` and `--chat-density` (a factor for spacing); an
284
+ unset one keeps House's light or dark look. `mountChat(element, { client })` places it
285
+ outside React and returns `update(props)` and `unmount()`.
286
+
287
+ Mix `ChatMessageList` (`components` takes your `UserMessage` and `AssistantMessage`),
288
+ `ChatInput` and `ChatQuestionCard` with your own design inside a `ChatProvider`, or
289
+ compose assistant-ui's primitives there; `useChat()` gives `send`, the conversations,
290
+ the Agents, questions to `answer`, `options` to `choose`, `commands`, the queue to
291
+ `edit` or `unqueue`, `stop`, `kill` and outcomes; never replace its messages, sending or
292
+ store. A secret question is never answered here; typed answers live in Presentation
293
+ State's `typed` key: keep it, and change Presentation State only inside `inTurn(client,
294
+ work)` from `@agentshouse/mdruntime/client`. `Markdown` draws Markdown safely.
295
295
 
296
296
  ## What an agent must never do
297
297
 
298
- An agent must never read the authorization, load code from a Room, call the
299
- Provider directly, or rebase a refused Change Batch.
298
+ An agent must never read the authorization, load code from a Room, call the Provider
299
+ directly, or rebase a refused Change Batch.