@agentshouse/mdruntime 0.1.0-cec6690d5712e → 0.1.0-cedb03eaa48b6

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