@agentshouse/mdruntime 0.1.0-c97456d63baba → 0.1.0-c9b1e59e5baeb

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