@agentshouse/mdruntime 0.1.0-c009335e08279 → 0.1.0-c02c3f1090329

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