@agentshouse/mdruntime-adapter 0.1.0-ceda7e87cc6e8 → 0.1.0-cedab65f24a09

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