@agentshouse/mdruntime 0.1.0-c2682496ef6d0 → 0.1.0-c2c52158b7381

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 (176) hide show
  1. package/AGENTS.md +210 -201
  2. package/README.md +9 -8
  3. package/dist/adapter.d.ts +49 -19
  4. package/dist/adapter.d.ts.map +1 -1
  5. package/dist/attached-model.d.ts +4 -1
  6. package/dist/attached-model.d.ts.map +1 -1
  7. package/dist/attached-model.js +13 -3
  8. package/dist/bootstrap.d.ts.map +1 -1
  9. package/dist/bootstrap.js +61 -30
  10. package/dist/change-set.d.ts +5 -2
  11. package/dist/change-set.d.ts.map +1 -1
  12. package/dist/change-set.js +8 -7
  13. package/dist/change.d.ts +31 -1
  14. package/dist/change.d.ts.map +1 -1
  15. package/dist/change.js +10 -1
  16. package/dist/chat/earlier.d.ts +10 -0
  17. package/dist/chat/earlier.d.ts.map +1 -0
  18. package/dist/chat/earlier.js +54 -0
  19. package/dist/chat/house.d.ts +25 -0
  20. package/dist/chat/house.d.ts.map +1 -0
  21. package/dist/chat/house.js +38 -0
  22. package/dist/chat/input.d.ts +3 -1
  23. package/dist/chat/input.d.ts.map +1 -1
  24. package/dist/chat/input.js +11 -18
  25. package/dist/chat/list.d.ts +2 -1
  26. package/dist/chat/list.d.ts.map +1 -1
  27. package/dist/chat/list.js +45 -5
  28. package/dist/chat/markdown.d.ts +1 -0
  29. package/dist/chat/markdown.d.ts.map +1 -1
  30. package/dist/chat/markdown.js +78 -20
  31. package/dist/chat/message.d.ts +1 -0
  32. package/dist/chat/message.d.ts.map +1 -1
  33. package/dist/chat/message.js +55 -10
  34. package/dist/chat/messages.d.ts +8 -1
  35. package/dist/chat/messages.d.ts.map +1 -1
  36. package/dist/chat/messages.js +64 -29
  37. package/dist/chat/name.d.ts +1 -0
  38. package/dist/chat/name.d.ts.map +1 -1
  39. package/dist/chat/name.js +1 -1
  40. package/dist/chat/opened.d.ts +1 -0
  41. package/dist/chat/opened.d.ts.map +1 -1
  42. package/dist/chat/opened.js +2 -0
  43. package/dist/chat/overlay.d.ts +1 -0
  44. package/dist/chat/overlay.d.ts.map +1 -1
  45. package/dist/chat/overlay.js +11 -5
  46. package/dist/chat/parts.d.ts +1 -0
  47. package/dist/chat/parts.d.ts.map +1 -1
  48. package/dist/chat/parts.js +3 -2
  49. package/dist/chat/pieces.d.ts +62 -0
  50. package/dist/chat/pieces.d.ts.map +1 -0
  51. package/dist/chat/pieces.js +1110 -0
  52. package/dist/chat/provider.d.ts +6 -1
  53. package/dist/chat/provider.d.ts.map +1 -1
  54. package/dist/chat/provider.js +81 -91
  55. package/dist/chat/question.d.ts +1 -1
  56. package/dist/chat/question.d.ts.map +1 -1
  57. package/dist/chat/question.js +7 -18
  58. package/dist/chat/ready.d.ts +5 -2
  59. package/dist/chat/ready.d.ts.map +1 -1
  60. package/dist/chat/ready.js +7 -5
  61. package/dist/chat/room-file.d.ts +8 -0
  62. package/dist/chat/room-file.d.ts.map +1 -0
  63. package/dist/chat/room-file.js +72 -0
  64. package/dist/chat/steady.d.ts +3 -0
  65. package/dist/chat/steady.d.ts.map +1 -0
  66. package/dist/chat/steady.js +26 -0
  67. package/dist/chat/style.d.ts.map +1 -1
  68. package/dist/chat/style.js +5 -1
  69. package/dist/chat.d.ts +3 -2
  70. package/dist/chat.d.ts.map +1 -1
  71. package/dist/chat.js +2 -2
  72. package/dist/client.d.ts +10 -2
  73. package/dist/client.d.ts.map +1 -1
  74. package/dist/client.js +35 -5
  75. package/dist/collection.d.ts +6 -5
  76. package/dist/collection.d.ts.map +1 -1
  77. package/dist/collection.js +166 -85
  78. package/dist/connection.d.ts +17 -6
  79. package/dist/connection.d.ts.map +1 -1
  80. package/dist/connection.js +1066 -324
  81. package/dist/conversation.d.ts +13 -2
  82. package/dist/conversation.d.ts.map +1 -1
  83. package/dist/conversation.js +167 -58
  84. package/dist/digest.d.ts +7 -0
  85. package/dist/digest.d.ts.map +1 -0
  86. package/dist/digest.js +113 -0
  87. package/dist/durability.d.ts +2 -1
  88. package/dist/durability.d.ts.map +1 -1
  89. package/dist/entry.d.ts +2 -1
  90. package/dist/entry.d.ts.map +1 -1
  91. package/dist/entry.js +4 -3
  92. package/dist/file.d.ts +2 -10
  93. package/dist/file.d.ts.map +1 -1
  94. package/dist/file.js +3 -120
  95. package/dist/host.d.ts +1 -4
  96. package/dist/host.d.ts.map +1 -1
  97. package/dist/host.js +19 -6
  98. package/dist/index.d.ts +8 -5
  99. package/dist/index.d.ts.map +1 -1
  100. package/dist/index.js +3 -0
  101. package/dist/memory.d.ts +2 -2
  102. package/dist/memory.d.ts.map +1 -1
  103. package/dist/memory.js +21 -12
  104. package/dist/name.d.ts +4 -0
  105. package/dist/name.d.ts.map +1 -0
  106. package/dist/name.js +122 -0
  107. package/dist/observation.d.ts +2 -0
  108. package/dist/observation.d.ts.map +1 -1
  109. package/dist/observation.js +9 -3
  110. package/dist/opened.d.ts +22 -0
  111. package/dist/opened.d.ts.map +1 -0
  112. package/dist/opened.js +107 -0
  113. package/dist/outcome.d.ts +35 -4
  114. package/dist/outcome.d.ts.map +1 -1
  115. package/dist/outcome.js +28 -0
  116. package/dist/overlay.d.ts +5 -5
  117. package/dist/overlay.d.ts.map +1 -1
  118. package/dist/overlay.js +207 -142
  119. package/dist/query.d.ts +23 -2
  120. package/dist/query.d.ts.map +1 -1
  121. package/dist/query.js +29 -5
  122. package/dist/reach.d.ts +5 -1
  123. package/dist/reach.d.ts.map +1 -1
  124. package/dist/reach.js +177 -38
  125. package/dist/react.d.ts +1 -2
  126. package/dist/react.d.ts.map +1 -1
  127. package/dist/react.js +2 -14
  128. package/dist/read-side.d.ts +6 -4
  129. package/dist/read-side.d.ts.map +1 -1
  130. package/dist/read-side.js +752 -215
  131. package/dist/readiness.d.ts +1 -1
  132. package/dist/readiness.d.ts.map +1 -1
  133. package/dist/recovery.d.ts +2 -2
  134. package/dist/recovery.d.ts.map +1 -1
  135. package/dist/recovery.js +8 -7
  136. package/dist/refresh.d.ts.map +1 -1
  137. package/dist/refresh.js +37 -18
  138. package/dist/replica.d.ts +12 -7
  139. package/dist/replica.d.ts.map +1 -1
  140. package/dist/replica.js +130 -80
  141. package/dist/room-draft.d.ts +3 -1
  142. package/dist/room-draft.d.ts.map +1 -1
  143. package/dist/room-draft.js +29 -22
  144. package/dist/rows.d.ts +1 -0
  145. package/dist/rows.d.ts.map +1 -1
  146. package/dist/rows.js +5 -0
  147. package/dist/save.d.ts +47 -9
  148. package/dist/save.d.ts.map +1 -1
  149. package/dist/save.js +501 -165
  150. package/dist/search.d.ts +16 -3
  151. package/dist/search.d.ts.map +1 -1
  152. package/dist/search.js +137 -27
  153. package/dist/seed.d.ts.map +1 -1
  154. package/dist/seed.js +18 -4
  155. package/dist/shared.d.ts +9 -1
  156. package/dist/shared.d.ts.map +1 -1
  157. package/dist/shared.js +134 -41
  158. package/dist/store.d.ts +25 -14
  159. package/dist/store.d.ts.map +1 -1
  160. package/dist/store.js +463 -422
  161. package/dist/tables.d.ts +242 -0
  162. package/dist/tables.d.ts.map +1 -0
  163. package/dist/tables.js +406 -0
  164. package/dist/turn.d.ts +5 -3
  165. package/dist/turn.d.ts.map +1 -1
  166. package/dist/turn.js +35 -13
  167. package/dist/windows.d.ts +21 -0
  168. package/dist/windows.d.ts.map +1 -0
  169. package/dist/windows.js +84 -0
  170. package/dist/wire.d.ts +32 -0
  171. package/dist/wire.d.ts.map +1 -1
  172. package/dist/wire.js +8 -0
  173. package/package.json +6 -2
  174. package/dist/acquisition.d.ts +0 -14
  175. package/dist/acquisition.d.ts.map +0 -1
  176. package/dist/acquisition.js +0 -24
package/AGENTS.md CHANGED
@@ -1,107 +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 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 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
40
41
  identity>`: no conversation list removes it, a retired Agent's goes, and the first answer
41
42
  to `conversation.create({ agent_id, operation_id })` moves it to the created conversation,
42
43
  where `conversation.send(conversation)` sends it; a replay of that create moves nothing.
43
44
 
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.
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`.
59
71
 
60
72
  Rooms, Query, Search, Observe, Types, Room Draft, Save, and Reached never touch the
61
- network. History, the binary file reads and Call go to the Provider through the Adapter.
62
- Call takes the Action names the Adapter declares; any other name answers `undeclared`
63
- without reaching the Provider. A Call result whose effect the Provider places in a Room
64
- carries `at`, that Room and Room Version; `reached(room, roomVersion)` answers whether
65
- the Room's confirmed state has reached it, and the MD Runtime keeps refreshing that Room
66
- until it has; `reached(room, roomVersion, path)` answers whether the held confirmed copy
67
- of that document was written at a later Room Version. Each History revision names its
68
- author, `{ kind: 'user', id }` or `{ kind: 'site', id, name }`. History of a Path no
69
- current document holds answers the removed document's revisions with `deleted: true`,
70
- newest first; that revision is what a link to the Path opens. Every member of the client
71
- is asynchronous. Results are detached snapshots. Nothing in this surface returns the
72
- authorization, performs a request the App's code composes, or exposes the browser store.
73
+ 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.
73
85
 
74
86
  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`.
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`.
82
93
 
83
94
  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.
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.
91
101
 
92
102
  ## Local Query rules
93
103
 
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:
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:
101
110
 
102
111
  - **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`.
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.
105
115
  - **Fields.** Every frontmatter value is named by JSON Pointer: `/status`,
106
116
  `/shipping/city`, `~1` for a `/` and `~0` for a `~` in a key. A segment that meets a
107
117
  list applies to every item and a number names one item. `where` names pointers, ANDs
@@ -113,120 +123,129 @@ observe the query to hear the complete one. A query is data:
113
123
  compares in calendar order and never with a date-time. A reference compares by the
114
124
  Room Path it resolves to. Untyped frontmatter, and a value under `oneOf` or a
115
125
  conditional, is plain values. There is no text containment or regular expression.
116
- - **Relations.** `hop: { field, types, where, pathPrefix }` keeps Documents whose
117
- reference at pointer `field`, at any depth, points to a matching Document of the same
118
- Room. `backlinks: { field, types, where, pathPrefix }` keeps Documents that a matching
119
- Document of the same Room references. Each keeps a Document once.
126
+ - **Relations.** Within one Room, `hop: { field, types, where, pathPrefix }` keeps Documents
127
+ whose reference at pointer `field`, at any depth, points to a matching Document, and
128
+ `backlinks` with the same keys those a matching Document references, each once. A body
129
+ link, or a reference declaring `cross_room`, may name another Room's
130
+ `/rooms/<handle>/<path>`: `resolve(room, path, destination)` answers its `document`, the
131
+ `deleted` one's last `revision`, or `unreadable` where the App does not bind it or it is
132
+ locked.
120
133
  - **Parts.** A Document query must `select`: `'all'`, or `fields`, `sections`,
121
134
  `preamble`, `markdown`, `backlinks`, `change` and `fileId`, where `fields` is `'all'`
122
135
  or a list of pointers and `sections` `'all'` or a list of names. Selected pointers
123
136
  return the frontmatter holding only them, nested as written. A backlink names the
124
137
  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.
138
+ return; a Markdown Document also returns its MD Type, and at most its first 1,000
139
+ backlinks: a query on the referring field reads the rest. A non-Markdown Document
140
+ returns only Room, Path and a selected `fileId`, and a binary Path entry its
141
+ `binaryFile` record too. An unselected part is absent. Select only what a screen shows:
142
+ a list 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 }`
152
+ with TanStack DB's own options; ties end with Room, then Path. `groupBy` by `room`,
153
+ `type`, `folder` or `{ field }` answers `{ groups: [{ key, count }] }`, counted over every
154
+ match and ordered by `count` or a key. A sort or group takes only a single-value pointer.
155
+ `limit`, at most 1,000 whatever a query names, bounds the Documents or the groups, and a
156
+ result it cuts short names `next`: the same query with it as `after` reads the next
157
+ window, in the same order, ties included. `total: true` adds `total`, every match's
158
+ count. An observed window hears rows entering, leaving or changing, and `next`, `total`.
159
+ - **Results and errors.** A result carries no Room Version: read freshness from Rooms and
160
+ Sync Status. `coverage` names each Room read as `{ room, generation, current }`,
161
+ `current` false while a newer copy of that Room is being fetched, and the queued changes
162
+ it includes as `overlay`, which a Save in the Room changes. An invalid query fails with
163
+ `invalid-query`, `unknown-type`, `unknown-field` or `wrong-kind`, never an empty answer.
150
164
 
151
165
  ## Local Search rules
152
166
 
153
- `search({ text, documents, collection, conversations, limit })` answers once, by words,
154
- from local state, with MiniSearch's defaults. There is no observed search.
167
+ `search({ text, documents, collection, conversations, limit, after, total })` answers
168
+ once, by words, from local state, with MiniSearch's defaults. There is no observed search.
155
169
 
156
170
  - **Declaration.** Only an App whose release declares Local Search searches, its first
157
171
  readiness waiting for its index; any other App's `search` answers the never retryable
158
172
  `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.
173
+ - **What is found.** A Document by its field values, its sections' headings and text, its
174
+ preamble and its Path, and a message by its text, never a frontmatter key, a Room Draft,
175
+ a chat draft or a running turn's parts, with no phrases, word forms, typo tolerance or
176
+ prefix matching.
163
177
  - **Narrowing.** `documents` is a Local Query filter, and `collection: true` leaves out
164
178
  what each Room's `typedSelection` roots hold; `conversations` names conversations. All
165
- apply before `limit`, which bounds each list; without it every hit returns.
179
+ apply before `limit`, which bounds each list, at most 1,000 whatever a search names. A
180
+ complete answer it cuts short names `next`, which `after` takes for the next window of
181
+ both lists. `total: true` adds `total`, each list's count.
166
182
  - **Results.** `{ documents, messages, coverage }`, or the same with `pending` naming each
167
183
  Room or conversation the search still waits for: show its hits, ask again, and never
168
184
  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.
185
+ list is ranked by `score`, comparable only within it; ties come by `room`, then `path`,
186
+ or by `conversation`, then `identity`. A Document hit names its `room`, `path` and
187
+ `type`, a message hit its `conversation` and `identity`; `matches` maps each matched
188
+ word to the parts it matched in: `fields`, `sections`, `preamble`, `path` or `text`. A
189
+ hit carries no position: mark the words you show. A bad filter fails as a query does.
174
190
 
175
191
  ## Room Draft, Save, and outcome rules
176
192
 
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.
193
+ The MD Runtime owns one durable Room Draft per Room and Path, shared by every App and tab
194
+ across reloads; a Room the Provider reports lost takes its Room Drafts and queue with it.
195
+ Write one with `roomDraft.write(room, path, revision, parts)`, naming the revision you read
196
+ or `null`, and every part it now changes: fields, sections and the preamble, or the whole
197
+ Markdown, a creation, a move, into another Room when it names `room`, or a removal. A new
198
+ part names its base, the value you showed when it was opened, a field's as `{ value }` or
199
+ `null` for no such field, and keeps its first base; a binary Path entry's move or removal
200
+ takes `null`. A write or discard from an older revision is refused as `stale` with the
201
+ current Room Draft.
186
202
 
187
203
  Save takes one Room and the Room Drafts of it to save, each with its revision, validates
188
- locally, and on success appends one Change Batch to that Room's queue and removes those
189
- Room Drafts. It is refused with the `code` `stale`, `changed-underneath` naming each
190
- part whose base no longer matches the visible state, or a local validation rule, and
191
- then creates nothing and leaves every Room Draft in place. A directory move or removal
192
- is that part on each Document and binary Path entry beneath it, saved together.
204
+ locally, and on success appends one Change Batch to that Room's queue and removes those Room
205
+ Drafts. Refused as `stale`, `changed-underneath` naming each part whose base no longer
206
+ matches the visible state, or a local validation rule, it creates nothing and leaves every
207
+ Room Draft. A directory move or removal is that part on each Document and binary Path entry
208
+ beneath it, saved together; moves into another Room, saved alone, are one Change Batch in
209
+ both Rooms' queues. `saveParts(room, [{ path, parts }])` saves parts, each Path once and
210
+ each new part with its base, the same way but writes no Room Draft: one held at a saved Path
211
+ stays, one at a moved Path moves with it to a destination that holds none. Never save by
212
+ writing back a Room Draft read before.
193
213
 
194
214
  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
215
+ over the confirmed layer, until that layer reaches the Room Version it was accepted at.
216
+ Conflicted and Rejected, an expired operation, and a change that no longer applies each
217
+ leave the queue and return as Room Drafts on their Documents, marked with why: the
218
+ Provider's structured refusal code and fields as returned, not known to have applied, or
219
+ withdrawn locally. The rest of the queue keeps synchronizing, and Sync Status requires
220
+ attention until each returned Room Draft is saved or discarded. `observe('queue', room)`
221
+ shows each Pending Change Batch, which keeps no outcome once it leaves. Transport failure,
222
+ Provider unavailability and a refusal marked retryable, until the reset it names, keep
223
+ work Pending; the MD Runtime retries the same Change Batch identity and payload, never
224
+ infers an outcome from transport uncertainty, and never combines, reorders, or rebases.
225
+
226
+ On a Site, every Save stays in the visitor's browser: write grants and revisions do not
208
227
  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.
228
+ browser's storage is cleared. It is never sent: `observe('queue', room)` shows it `local`,
229
+ Sync Status never waits on it, and once the Room no longer lets it apply it leaves the
230
+ queue and returns no Room Draft.
212
231
 
213
232
  `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.
233
+ While writes are halted, Save succeeds, its Change Batch waits unsent and the queue is
234
+ submitted in order once writes reopen; an Action is never held, and one the halt refuses
235
+ returns that refusal: show the Provider as read-only instead of retrying.
217
236
  `observe('readiness')` tells whether the App's code and bound Rooms are held locally
218
237
  (`ready`), each Room's state, each refused Room's file and rule, the persistence answer
219
238
  and a paused preparation's `capacity` cause; `retry()` resumes a paused preparation.
220
239
 
221
- ## Content-safety rules
240
+ ## Content safety and launch promises
222
241
 
223
242
  The Provider authorization belongs to the Runtime host and is never readable by the App's
224
243
  code. The App's code reaches the network only at the external origins its manifest
225
244
  declares, empty by default, and the Provider enforces that set. Rendered Markdown never
226
245
  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
246
+ images and other resources only from origins the Provider's policy allows. An agent must
247
+ never read the authorization, load code from a Room, call the Provider directly, or rebase
248
+ a refused Change Batch.
230
249
 
231
250
  MD UI uses semantic HTML, is fully operable from a keyboard with visible focus and
232
251
  labelled controls, and lays out from a 360 pixel wide viewport to a desktop. Its strings
@@ -242,58 +261,48 @@ every App and MD UI reach data only through the client entry. In House,
242
261
  `houseBridge().runtime` from `@agentshouse/app-bridge` resolves to the client House built
243
262
  into the page. App code imports only types from `@agentshouse/mdruntime/client`, never
244
263
  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`.
264
+ entry or the Adapter package; the in-memory Adapter at `@agentshouse/mdruntime/memory` is
265
+ for tests and ships in no bundle. A Site's page fills its Entry Data Contract's
266
+ `{"$param": name}` arguments with `boundQuery` from `@agentshouse/mdruntime/entry`, as
267
+ House did for its HTML. While the Site prepares, a query a route's `interaction` names
268
+ answers from the entry's result when the page observes that descriptor, and every other
269
+ stays pending. House replaces its HTML with the page once its document changed after those
270
+ answers, or readiness is `ready`, and then held still for two animation frames, unless the
271
+ visitor uses the HTML: draw the route at once, never behind a placeholder. Before
272
+ readiness is `ready`, `push` loads a new page.
273
+
274
+ A React App may observe and save through `@agentshouse/mdruntime/react`, with React as a
275
+ peer dependency. `useObserve(client, topic, ...input)` takes the arguments of `observe`
276
+ and returns `{ state: 'loading' }` until the topic's first value arrives, then `{ state:
277
+ 'ready', value }`, re-rendering on each change; a `null` client stays loading.
278
+ `useSave(client)` returns `busy`, the last `outcome` or `failure`, and `save(room,
279
+ parts)`, which saves through `saveParts` and rejects with a recorded failure.
280
+ `saveWritten(room, roomDrafts)` saves Room Drafts the App wrote, each named with the
281
+ revision its last write returned: one another tab wrote since is refused as `stale`, and
282
+ nothing is saved. React-admin and Refine Apps use `@agentshouse/mdruntime-families`.
268
283
 
269
284
  ## The Chat
270
285
 
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()`.
286
+ `@agentshouse/mdruntime/chat` holds the Chat, one data layer for every App; add React as a
287
+ dependency in any App, with React DOM and `@assistant-ui/react`. Place the ready chat with
288
+ `<Chat client={runtime} conversation={id} agent={agent} width="1/3" showChats />`:
289
+ `conversation` opens one, `null` for a new chat, `agent` is the Agent a new chat goes to,
290
+ `onOpen` hears each one it opens, and `width` is `full` (the place you give it), or `3/4`,
291
+ `1/2` or `1/3` of the window docked at its right edge, whole on a narrow window.
292
+ `showChats` adds its conversation list; or draw your own inside a `ChatProvider` around a
293
+ `<Chat />` with no `client`. Theme its own styles with CSS custom properties on it or an
294
+ ancestor: `--chat-background`, `--chat-surface`, `--chat-text`, `--chat-text-muted`,
295
+ `--chat-accent`, `--chat-line`, `--chat-attention`, `--chat-danger`, `--chat-font`,
296
+ `--chat-font-mono`, `--chat-font-size`, `--chat-radius` and `--chat-density` (a factor for
297
+ spacing); an unset one keeps House's light or dark look. `mountChat(element, { client })`
298
+ places it outside React, with `update(props)` and `unmount()`.
286
299
 
287
300
  Mix `ChatMessageList` (`components` takes your `UserMessage` and `AssistantMessage`),
288
301
  `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.
302
+ compose assistant-ui's primitives there; `useChat()` gives `send`, the conversations, the
303
+ Agents, questions to `answer`, `options` to `choose`, `commands`, the queue to `edit` or
304
+ `unqueue`, `stop`, `kill` and outcomes; never replace its messages, sending or store. It
305
+ shows a conversation's latest 50 messages, and assistant-ui's `loadEarlier()` the 50
306
+ before, which `ChatMessageList` calls as the reader scrolls back. A secret question is
307
+ never answered here; typed answers live in the Presentation State members named `typed:…`:
308
+ leave them. `Markdown` draws Markdown safely.
package/README.md CHANGED
@@ -12,14 +12,15 @@ 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/tables` | The host's database: the Authored store's and opened files' tables, `answerRuntime` |
22
+ | `@agentshouse/mdruntime/react` | React over the client: `useObserve`, `useSave` |
23
+ | `@agentshouse/mdruntime/chat` | The Chat: `Chat`, `mountChat`, its parts and `ChatProvider` |
23
24
 
24
25
  ## Usage
25
26