@agentshouse/mdruntime 0.1.0-c95464765b116 → 0.1.0-c969b8dee6cc8

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