@agentshouse/mdruntime-adapter 0.1.0-c48608d854acb → 0.1.0-c49a8ff59baf3
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.
- package/AGENTS.md +261 -209
- package/dist/actions.d.ts +62 -1
- package/dist/actions.d.ts.map +1 -1
- package/dist/actions.js +153 -133
- package/dist/adapter.d.ts +1 -0
- package/dist/adapter.d.ts.map +1 -1
- package/dist/adapter.js +276 -89
- package/dist/discovery.d.ts +3 -1
- package/dist/discovery.d.ts.map +1 -1
- package/dist/discovery.js +18 -3
- package/dist/gather.d.ts +1 -0
- package/dist/gather.d.ts.map +1 -1
- package/dist/gather.js +11 -6
- package/dist/handed.d.ts +15 -0
- package/dist/handed.d.ts.map +1 -0
- package/dist/handed.js +38 -0
- package/dist/index.d.ts +2 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -0
- package/dist/model.d.ts +1 -1
- package/dist/model.d.ts.map +1 -1
- package/dist/model.js +6 -2
- package/dist/read.d.ts +31 -7
- package/dist/read.d.ts.map +1 -1
- package/dist/read.js +146 -77
- package/dist/referrer.d.ts +7 -0
- package/dist/referrer.d.ts.map +1 -0
- package/dist/referrer.js +35 -0
- package/dist/refusal.d.ts +2 -5
- package/dist/refusal.d.ts.map +1 -1
- package/dist/refusal.js +6 -9
- package/dist/site.d.ts +1 -1
- package/dist/site.d.ts.map +1 -1
- package/dist/site.js +165 -49
- package/dist/stream.d.ts +3 -2
- package/dist/stream.d.ts.map +1 -1
- package/dist/stream.js +299 -13
- package/dist/transport.d.ts +43 -9
- package/dist/transport.d.ts.map +1 -1
- package/dist/transport.js +3 -0
- package/dist/version.d.ts +1 -0
- package/dist/version.d.ts.map +1 -1
- package/dist/version.js +1 -1
- package/dist/write.d.ts +3 -9
- package/dist/write.d.ts.map +1 -1
- package/dist/write.js +90 -13
- package/package.json +3 -4
- package/dist/links.d.ts +0 -20
- package/dist/links.d.ts.map +0 -1
- package/dist/links.js +0 -104
package/AGENTS.md
CHANGED
|
@@ -1,244 +1,296 @@
|
|
|
1
1
|
# Instructions for the App Creator's agent
|
|
2
2
|
|
|
3
|
-
These instructions address an agent in an environment with Git. Obtain the
|
|
4
|
-
|
|
5
|
-
enforcement.
|
|
3
|
+
These instructions address an agent in an environment with Git. Obtain the App
|
|
4
|
+
Repository, change it, build, and push. They are documentation, not enforcement.
|
|
6
5
|
|
|
7
6
|
## The MD Runtime API
|
|
8
7
|
|
|
9
|
-
App code reaches the MD Runtime through the remote client. The surfaces are
|
|
10
|
-
|
|
11
|
-
the reported persistence answer, reauthorization, conversation, the chat
|
|
12
|
-
and Presentation State. Sync Status, the Service Mode, the storage-loss
|
|
13
|
-
statement
|
|
14
|
-
|
|
15
|
-
The host attaches each port with its reach, and every member and observation
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
`
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
browser. `conversation.list()` and
|
|
32
|
-
Agent's identity and name, its name,
|
|
33
|
-
`state`: `asking` while a question
|
|
34
|
-
and `started`, when the running turn
|
|
35
|
-
Observe one with `observe('conversation', id, { limit })`: the view
|
|
36
|
-
holds its latest `limit` messages, or all of them, oldest first, its chat
|
|
37
|
-
draft, and what the Provider streams for it whether or not anything views it:
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
`
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
the
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
8
|
+
App code reaches the MD Runtime through the remote client. The surfaces are Rooms,
|
|
9
|
+
Query, Search, Observe, Types, Room Draft, Save, History, the binary file reads, Call,
|
|
10
|
+
Reached, Log, the reported persistence answer, reauthorization, conversation, the chat
|
|
11
|
+
draft, and Presentation State. Sync Status, the Service Mode, the storage-loss
|
|
12
|
+
statement, the deployment facts and the signed-in member are observations only.
|
|
13
|
+
|
|
14
|
+
The host attaches each port with its reach, and every member and observation answers
|
|
15
|
+
within it: a Room outside it answers as one the replica does not hold, Rooms lists only
|
|
16
|
+
the Rooms reached whole, a Room reached for single Documents shows only those Documents
|
|
17
|
+
and the Types of the models that govern them, and without conversations the conversation
|
|
18
|
+
members, the chat draft and the conversation observation hold none. A change of the
|
|
19
|
+
reach reaches every open observation as its new value, a query keeping unchanged
|
|
20
|
+
Documents the same objects.
|
|
21
|
+
|
|
22
|
+
Every `observe` resolves, once its first value has arrived, to a handle: `current()` is
|
|
23
|
+
the latest complete value, `subscribe(listener)` hears each later value whole and
|
|
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.
|
|
27
|
+
|
|
28
|
+
`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.
|
|
60
|
+
|
|
61
|
+
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.
|
|
74
|
+
|
|
75
|
+
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`.
|
|
81
|
+
|
|
82
|
+
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.
|
|
74
90
|
|
|
75
91
|
## Local Query rules
|
|
76
92
|
|
|
77
|
-
`query(q)` answers once from local state; `observe('query', q)` holds the whole
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
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:
|
|
100
|
+
|
|
101
|
+
- **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`.
|
|
85
104
|
- **Fields.** Every frontmatter value is named by JSON Pointer: `/status`,
|
|
86
|
-
`/shipping/city`, `~1` for a `/` and `~0` for a `~` in a key. A segment that
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
`$
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
values. There is no text containment or regular
|
|
105
|
+
`/shipping/city`, `~1` for a `/` and `~0` for a `~` in a key. A segment that meets a
|
|
106
|
+
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
|
|
97
115
|
expression.
|
|
98
116
|
- **Relations.** `hop: { field, types, where, pathPrefix }` keeps Documents whose
|
|
99
|
-
reference at pointer `field`, at any depth, points to a matching Document of the
|
|
100
|
-
|
|
101
|
-
|
|
117
|
+
reference at pointer `field`, at any depth, points to a matching Document of the same
|
|
118
|
+
Room. `backlinks: { field, types, where, pathPrefix }` keeps Documents that a matching
|
|
119
|
+
Document of the same Room references. Each keeps a Document once.
|
|
102
120
|
- **Parts.** A Document query must `select`: `'all'`, or `fields`, `sections`,
|
|
103
|
-
`preamble`, `markdown`, `backlinks` and `change`, where `fields` is `'all'` or a
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
Document also returns its MD Type. A non-Markdown Document
|
|
108
|
-
|
|
109
|
-
what a screen shows: a list that
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
Room's last change is its Document with the
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
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.
|
|
126
148
|
|
|
127
149
|
## Local Search rules
|
|
128
150
|
|
|
129
|
-
`search({ text, documents, conversations, limit })` answers once, by words, from
|
|
130
|
-
|
|
131
|
-
search.
|
|
151
|
+
`search({ text, documents, conversations, limit })` answers once, by words, from local
|
|
152
|
+
state, with MiniSearch's defaults. There is no observed search.
|
|
132
153
|
|
|
133
|
-
- **What is found.** A Document by its field values, its sections' headings and
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
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.
|
|
137
158
|
- **Narrowing.** `documents` is a Local Query filter: `rooms`, `types`, `where`,
|
|
138
|
-
`pathPrefix`, `hop` and `backlinks`. `conversations` names conversations. Both
|
|
139
|
-
|
|
140
|
-
- **Results.** `{ documents, messages }`,
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
`
|
|
145
|
-
|
|
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
|
|
163
|
+
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.
|
|
146
169
|
|
|
147
170
|
## Room Draft, Save, and outcome rules
|
|
148
171
|
|
|
149
|
-
The MD Runtime owns one Room Draft per Room and Path, shared by every App and
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
`observe('
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
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.
|
|
182
|
+
|
|
183
|
+
Save takes one Room and the Room Drafts of it to save, each with its revision, validates
|
|
184
|
+
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,
|
|
204
|
+
reorders, or rebases.
|
|
205
|
+
|
|
206
|
+
On a Site, every Save stays in the visitor's browser. Write grants and revisions do not
|
|
207
|
+
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.
|
|
211
|
+
|
|
212
|
+
`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.
|
|
191
217
|
|
|
192
218
|
## The neutrality rule
|
|
193
219
|
|
|
194
|
-
No module outside an Adapter package imports, names, or special-cases a
|
|
195
|
-
|
|
220
|
+
No module outside an Adapter package imports, names, or special-cases a Provider. MD UI
|
|
221
|
+
and every App reach data only through the client entry.
|
|
196
222
|
|
|
197
223
|
## Content-safety rules
|
|
198
224
|
|
|
199
|
-
The Provider authorization belongs to the Runtime host and is never readable
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
origins the Provider's policy allows.
|
|
225
|
+
The Provider authorization belongs to the Runtime host and is never readable by the
|
|
226
|
+
App's code. The App's code reaches the network only at the external origins its manifest
|
|
227
|
+
declares, empty by default, and the Provider enforces that set. Every request to the
|
|
228
|
+
Provider itself goes through the MD Runtime. Rendered Markdown never executes scripts,
|
|
229
|
+
renders raw HTML only for the details and summary elements, and loads images and other
|
|
230
|
+
resources only from origins the Provider's policy allows.
|
|
206
231
|
|
|
207
232
|
## Launch promises MD UI keeps
|
|
208
233
|
|
|
209
|
-
MD UI uses semantic HTML, is fully operable from a keyboard with visible
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
234
|
+
MD UI uses semantic HTML, is fully operable from a keyboard with visible focus and
|
|
235
|
+
labelled controls, and lays out from a 360 pixel wide viewport to a desktop. Its strings
|
|
236
|
+
are English only, dates and numbers follow the browser locale, and content is never
|
|
237
|
+
translated. Light and dark themes come from CSS custom properties with the browser's
|
|
238
|
+
preference as the default and an App's override respected. What an App Creator's agent
|
|
239
|
+
adds carries none of these promises by itself. Reading, querying and searching never
|
|
240
|
+
wait for the network. Data lives only in the App Creator's browser and with the
|
|
241
|
+
Provider.
|
|
217
242
|
|
|
218
243
|
## App code takes the client its host hands it and never constructs a Runtime
|
|
219
244
|
|
|
220
|
-
App code takes the client its host hands it: in House,
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
reads and writes its Rooms through the
|
|
239
|
-
`@agentshouse/mdruntime-families`.
|
|
245
|
+
App code takes the client its host hands it: in House, `houseBridge().runtime` from
|
|
246
|
+
`@agentshouse/app-bridge` resolves to the client House built into the page. It imports
|
|
247
|
+
only types from `@agentshouse/mdruntime/client`, never calls `connectMdRuntime` or
|
|
248
|
+
`serveMdRuntime`, and never imports the package main, the host entry or the Adapter
|
|
249
|
+
package, which hosts and tests use. The in-memory Adapter at
|
|
250
|
+
`@agentshouse/mdruntime/memory` is for tests and ships in no bundle. A Site's page fills
|
|
251
|
+
its Entry Data Contract's `{"$param": name}` arguments with `boundQuery` from
|
|
252
|
+
`@agentshouse/mdruntime/entry`, as House did for its HTML.
|
|
253
|
+
|
|
254
|
+
A React App may observe and save through `@agentshouse/mdruntime/react`, which names
|
|
255
|
+
React as a peer dependency. `useObserve(client, topic, ...input)` takes the arguments of
|
|
256
|
+
`observe` and returns `{ state: 'loading' }` until the topic's first value arrives, then
|
|
257
|
+
`{ state: 'ready', value }`, re-rendering on each change; a `null` client observes
|
|
258
|
+
nothing and stays loading. `useSave(client)` returns `busy`, the last `outcome` or
|
|
259
|
+
`failure`, and `save(room, roomDrafts)`, which writes each Path's parts onto the Room
|
|
260
|
+
Draft already there, keeping the bases its parts have, or onto a new one, and saves them
|
|
261
|
+
together. A refused Save leaves the Room Drafts for the App to save again or discard; a
|
|
262
|
+
failure is recorded and rejects. `saveRoomDrafts(client, room, roomDrafts)` is that save
|
|
263
|
+
outside a component. A react-admin or Refine App reads and writes its Rooms through the
|
|
264
|
+
data providers of `@agentshouse/mdruntime-families`.
|
|
265
|
+
|
|
266
|
+
## The Chat
|
|
267
|
+
|
|
268
|
+
`@agentshouse/mdruntime/chat` holds the Chat, one data layer for every App; add React as
|
|
269
|
+
a dependency in any App, with React DOM and `@assistant-ui/react`.
|
|
270
|
+
|
|
271
|
+
Place the ready chat with `<Chat client={runtime} conversation={id} agent={agent}
|
|
272
|
+
width="1/3" showChats />`: `conversation` opens one, `null` for a new chat, `agent` is
|
|
273
|
+
the Agent a new chat goes to, `onOpen` hears each one it opens, and `width` is `full`
|
|
274
|
+
(the place you give it), or `3/4`, `1/2` or `1/3` of the window docked at its right
|
|
275
|
+
edge, whole on a narrow window. `showChats` adds its conversation list; or draw your own
|
|
276
|
+
inside a `ChatProvider` around a `<Chat />` with no `client`. It carries its own styles;
|
|
277
|
+
theme it with CSS custom properties on it or an ancestor: `--chat-background`,
|
|
278
|
+
`--chat-surface`, `--chat-text`, `--chat-text-muted`, `--chat-accent`, `--chat-line`,
|
|
279
|
+
`--chat-attention`, `--chat-danger`, `--chat-font`, `--chat-font-mono`,
|
|
280
|
+
`--chat-font-size`, `--chat-radius` and `--chat-density` (a factor for spacing); an
|
|
281
|
+
unset one keeps House's light or dark look. `mountChat(element, { client })` places it
|
|
282
|
+
outside React and returns `update(props)` and `unmount()`.
|
|
283
|
+
|
|
284
|
+
Mix `ChatMessageList` (`components` takes your `UserMessage` and `AssistantMessage`),
|
|
285
|
+
`ChatInput` and `ChatQuestionCard` with your own design inside a `ChatProvider`, or
|
|
286
|
+
compose assistant-ui's primitives there; `useChat()` gives `send`, the conversations,
|
|
287
|
+
the Agents, questions to `answer`, `options` to `choose`, `commands`, the queue to
|
|
288
|
+
`edit` or `unqueue`, `stop`, `kill` and outcomes; never replace its messages, sending or
|
|
289
|
+
store. A secret question is never answered here; typed answers live in Presentation
|
|
290
|
+
State's `typed` key: keep it, and change Presentation State only inside `inTurn(client,
|
|
291
|
+
work)` from `@agentshouse/mdruntime/client`. `Markdown` draws Markdown safely.
|
|
240
292
|
|
|
241
293
|
## What an agent must never do
|
|
242
294
|
|
|
243
|
-
An agent must never read the authorization, load code from a Room, call the
|
|
244
|
-
|
|
295
|
+
An agent must never read the authorization, load code from a Room, call the Provider
|
|
296
|
+
directly, or rebase a refused Change Batch.
|