@agentshouse/mdruntime-adapter 0.1.0-cc710a8825617 → 0.1.0-cca0c0fa62278

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