@agentshouse/mdruntime 0.1.0-c0d767f8f799a → 0.1.0-c104334047dfe

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