@agentshouse/mdruntime 0.1.0-c436a939f2119 → 0.1.0-c454894e67f74

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