@agentshouse/mdruntime 0.1.0-c315a76f079f0 → 0.1.0-c34cec0d00579

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