@agentshouse/mdruntime-adapter 0.1.0-cc39535833e8f → 0.1.0-cc411939c09d5

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