@agentshouse/mdruntime-adapter 0.1.0-c9f1e531ad7c8 → 0.1.0-ca218e62303fd
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 +196 -97
- package/README.md +3 -3
- package/dist/actions.d.ts +63 -2
- package/dist/actions.d.ts.map +1 -1
- package/dist/actions.js +154 -138
- package/dist/adapter.d.ts.map +1 -1
- package/dist/adapter.js +317 -158
- package/dist/discovery.d.ts +15 -27
- package/dist/discovery.d.ts.map +1 -1
- package/dist/discovery.js +57 -102
- 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 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/model.d.ts +7 -18
- package/dist/model.d.ts.map +1 -1
- package/dist/model.js +60 -39
- package/dist/read.d.ts +35 -11
- package/dist/read.d.ts.map +1 -1
- package/dist/read.js +156 -106
- 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 +5 -7
- package/dist/refusal.d.ts.map +1 -1
- package/dist/refusal.js +31 -31
- package/dist/site.d.ts.map +1 -1
- package/dist/site.js +185 -108
- package/dist/stream.d.ts +10 -4
- package/dist/stream.d.ts.map +1 -1
- package/dist/stream.js +398 -81
- package/dist/transport.d.ts +78 -23
- package/dist/transport.d.ts.map +1 -1
- package/dist/transport.js +3 -2
- package/dist/version.d.ts +2 -0
- package/dist/version.d.ts.map +1 -1
- package/dist/version.js +10 -1
- package/dist/write.d.ts +4 -5
- package/dist/write.d.ts.map +1 -1
- package/dist/write.js +101 -25
- package/package.json +3 -4
- package/dist/links.d.ts +0 -12
- package/dist/links.d.ts.map +0 -1
- package/dist/links.js +0 -66
package/AGENTS.md
CHANGED
|
@@ -1,15 +1,24 @@
|
|
|
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
8
|
App code reaches the MD Runtime through the remote client. The surfaces are
|
|
10
|
-
Rooms,
|
|
11
|
-
|
|
12
|
-
|
|
9
|
+
Rooms, Query, Search, Observe, Types, Room Draft, Save, History, the binary file
|
|
10
|
+
reads, Call, Reached, Log, the reported persistence answer, reauthorization,
|
|
11
|
+
conversation, the chat draft, and Presentation State. Sync Status, the Service
|
|
12
|
+
Mode, the storage-loss statement, the deployment facts and the signed-in member
|
|
13
|
+
are observations only.
|
|
14
|
+
|
|
15
|
+
The host attaches each port with its reach, and every member and observation
|
|
16
|
+
answers within it: a Room outside it answers as one the replica does not hold,
|
|
17
|
+
Rooms lists only the Rooms reached whole, a Room reached for single Documents
|
|
18
|
+
shows only those Documents and the Types of the models that govern them, and
|
|
19
|
+
without conversations the conversation members, the chat draft and the
|
|
20
|
+
conversation observation hold none. A change of the reach reaches every open
|
|
21
|
+
observation as its new value, a query keeping unchanged Documents the same objects.
|
|
13
22
|
|
|
14
23
|
Every `observe` resolves, once its first value has arrived, to a handle:
|
|
15
24
|
`current()` is the latest complete value, `subscribe(listener)` hears each later
|
|
@@ -17,109 +26,149 @@ value whole and returns its unsubscribe, and `close()` ends the observation.
|
|
|
17
26
|
Closing the port ends every handle and rejects every pending call and
|
|
18
27
|
observation; a client that reconnects observes again.
|
|
19
28
|
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
state
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
each with
|
|
39
|
-
`
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
29
|
+
`observe('agents')` answers every Agent a new conversation can go to, each
|
|
30
|
+
`{ identity, name }`, whether or not it has a conversation yet. Each conversation
|
|
31
|
+
the Provider's conversation list names is held complete in the browser.
|
|
32
|
+
`conversation.list()` and `observe('conversations')` answer each with its Agent's
|
|
33
|
+
identity and name, its name, created and finished times, last outcome and live
|
|
34
|
+
`state`: `asking` while a question waits, `working` while a turn runs, else
|
|
35
|
+
`idle`, and `started`, when the running turn began, or `null`. Observe one with
|
|
36
|
+
`observe('conversation', id, { limit })`: the view holds a window of its latest
|
|
37
|
+
`limit` messages, or all of them, oldest first, its chat draft, and what the Provider
|
|
38
|
+
streams for it whether or not anything views it: the running `turn` with its
|
|
39
|
+
message parts and its context in use and window, the open questions, the process
|
|
40
|
+
state, and the CLI's commands and options. These live only in memory: the
|
|
41
|
+
message accepted under the turn's id replaces the running turn, and none of them
|
|
42
|
+
is stored or searchable. `chatDraft.write` and `chatDraft.discard` keep what the
|
|
43
|
+
App Creator composes; sending it is a Provider Action that needs the Provider
|
|
44
|
+
reachable and is never queued.
|
|
45
|
+
|
|
46
|
+
A binary file at a Path is a binary Path entry. Query lists it by `path`, and
|
|
47
|
+
History each of its revisions, with its `binaryFile` record and never its bytes:
|
|
48
|
+
`{ state: 'accepted', revision, path, fileRef, byteLength, mediaType, sha256 }`,
|
|
49
|
+
or, from a Save until the Provider accepts it, `{ state: 'pending', localId,
|
|
50
|
+
path, byteLength, mediaType, sha256 }`. Write one with a Room Draft whose only
|
|
51
|
+
part is `file: { blob }`, the `Blob`'s `type` its media type: Save keeps the
|
|
52
|
+
bytes in its Pending Change, offline too, and acceptance gives the record the
|
|
53
|
+
Provider's revision. Move or remove one as a Document, a pending one before or
|
|
54
|
+
after Save too, its bytes following; once its Pending Change has gone to the
|
|
55
|
+
Provider, Save refuses that as `unknown-revision` until it is accepted.
|
|
56
|
+
`binaryFile.read(room, path, revision?)` answers a pending record's saved bytes,
|
|
57
|
+
or asks the Provider again on every read of an accepted one or of a History
|
|
58
|
+
revision, a removed file's last included, keeping nothing. Text, a Record
|
|
59
|
+
attachment or a conversation message may name a file by its `fileRef`; read it
|
|
60
|
+
with `binaryFile.readReference({ fileRef, referrer })`, the referrer being the
|
|
61
|
+
`referrer` the Provider gave beside it, or `{ room, path }` of the document whose
|
|
62
|
+
text names it. Both answer `{ kind: 'binary', blob }` or a refusal or failure.
|
|
63
|
+
|
|
64
|
+
Rooms, Query, Search, Observe, Types, Room Draft, Save, and Reached never
|
|
65
|
+
touch the network. History, the binary file reads and Call go to the Provider
|
|
66
|
+
through the Adapter. Call takes the Action names the Adapter declares; any other
|
|
67
|
+
name answers `undeclared` without reaching the Provider. A Call result whose
|
|
45
68
|
effect the Provider places in a Room carries `at`, that Room and Room Version;
|
|
46
69
|
`reached(room, roomVersion)` answers whether the Room's confirmed state has
|
|
47
70
|
reached it, and the MD Runtime keeps refreshing that Room until it has;
|
|
48
71
|
`reached(room, roomVersion, path)` answers whether the held confirmed copy of
|
|
49
72
|
that document was written at a later Room Version. Each History revision
|
|
50
|
-
names its author, `{ kind: 'user', id }` or `{ kind: 'site', id, name }`.
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
73
|
+
names its author, `{ kind: 'user', id }` or `{ kind: 'site', id, name }`.
|
|
74
|
+
History of a Path no current document holds answers the removed document's
|
|
75
|
+
revisions with `deleted: true`, newest first; that revision is what a link to
|
|
76
|
+
the Path opens. Every member of the client is asynchronous. Results are
|
|
77
|
+
detached snapshots. Nothing in this surface returns the authorization, performs
|
|
78
|
+
a request the App's code composes, or exposes the browser store.
|
|
55
79
|
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
80
|
+
Every refusal and failure carries `code` and `retryable`: each Call and History
|
|
81
|
+
answer other than its result, a refused Save or Room Draft write, a returned Room
|
|
82
|
+
Draft's reason, a Room's refusal and the Connection Refusal, and every error a
|
|
83
|
+
member rejects with, beside its message. A Provider refusal carries the
|
|
84
|
+
Provider's own `retryable`. Every code and every value the API answers is open:
|
|
85
|
+
handle one you do not know by its `code` and `retryable`.
|
|
59
86
|
|
|
60
|
-
|
|
61
|
-
|
|
87
|
+
Read the deployment facts with `observe('deployment-facts')`, an opaque value
|
|
88
|
+
the host's contract interprets. `observe('member')` answers who uses the App:
|
|
89
|
+
the User the Provider signed in, `{ kind: 'user', id, name }` in the shape of a
|
|
90
|
+
change's `author`, so a Document whose `change.author.id` equals its `id` is that
|
|
91
|
+
User's own. It is `null` until the Provider first names one, and where it names
|
|
92
|
+
none, such as a Site. The MD Runtime keeps it with the Local Replicas, so it
|
|
93
|
+
answers offline once known, and every port hears the next member the Provider
|
|
94
|
+
names; signing out answers `null`, then ends the observation with the
|
|
95
|
+
authorization. It is the only way App code learns who uses it.
|
|
62
96
|
|
|
63
97
|
## Local Query rules
|
|
64
98
|
|
|
65
99
|
`query(q)` answers once from local state; `observe('query', q)` holds the whole
|
|
66
100
|
result and hears it again only when it changes, keeping every unchanged Document
|
|
67
|
-
the same object, so a component can tell what changed by identity.
|
|
68
|
-
|
|
101
|
+
the same object, so a component can tell what changed by identity. An answer is
|
|
102
|
+
complete or pending: `{ documents, coverage }` or `{ groups, coverage }` is
|
|
103
|
+
complete for the Rooms its `coverage` names, and `{ pending }` names each Room
|
|
104
|
+
not yet acquired or prepared, `[{ room, awaits }]`. Never read a pending answer as
|
|
105
|
+
empty: draw it as loading, and observe the query to hear the complete one. A
|
|
106
|
+
query is data:
|
|
69
107
|
|
|
70
108
|
- **Filter.** `rooms` names Room locators and defaults to every Room. `types`
|
|
71
109
|
names MD Types, and `any` names untyped Markdown Documents. `pathPrefix` is a
|
|
72
110
|
directory: `notes` keeps `notes/a.md` and not `notes2/a.md`.
|
|
73
|
-
- **Fields.**
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
111
|
+
- **Fields.** Every frontmatter value is named by JSON Pointer: `/status`,
|
|
112
|
+
`/shipping/city`, `~1` for a `/` and `~0` for a `~` in a key. A segment that
|
|
113
|
+
meets a list applies to every item and a number names one item. `where` names
|
|
114
|
+
pointers, ANDs them, and nests `$and` and `$or`; a pointer through a list holds
|
|
115
|
+
when any item satisfies it. A bare value is equality; the operators are `$eq`,
|
|
116
|
+
`$ne`, `$in`, `$nin`, `$gt`, `$gte`, `$lt`, `$lte`, `$all`, `$size` and
|
|
117
|
+
`$exists`. Equality on a list asks whether it contains the value. Missing,
|
|
118
|
+
null and empty differ: `$exists: false` keeps a missing field, `null` an
|
|
119
|
+
explicit null, `''` empty text and `$size: 0` an empty list. A date compares
|
|
120
|
+
in calendar order and never with a date-time. A reference compares by the Room
|
|
121
|
+
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.
|
|
82
123
|
- **Relations.** `hop: { field, types, where, pathPrefix }` keeps Documents whose
|
|
83
|
-
reference `field
|
|
84
|
-
`backlinks: { field, types, where, pathPrefix }` keeps Documents that a
|
|
124
|
+
reference at pointer `field`, at any depth, points to a matching Document of the
|
|
125
|
+
same Room. `backlinks: { field, types, where, pathPrefix }` keeps Documents that a
|
|
85
126
|
matching Document of the same Room references. Each keeps a Document once.
|
|
86
127
|
- **Parts.** A Document query must `select`: `'all'`, or `fields`, `sections`,
|
|
87
|
-
`preamble`, `markdown`, `backlinks` and `change`, where `fields`
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
128
|
+
`preamble`, `markdown`, `backlinks` and `change`, where `fields` is `'all'` or a
|
|
129
|
+
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
|
|
131
|
+
the referring Path, MD Type and the pointer it came from as `field`. Room and Path always return; a Markdown
|
|
132
|
+
Document also returns its MD Type. A non-Markdown Document returns only Room
|
|
133
|
+
and Path, and a binary Path entry Room, Path and its `binaryFile` record,
|
|
134
|
+
whatever is selected. An unselected part is absent. Select only
|
|
91
135
|
what a screen shows: a list that selects the Markdown hears every edit of it.
|
|
92
136
|
- **Change.** `change` is `{ author, time }` of the Document's head revision as
|
|
93
137
|
the Provider last delivered it: `author` is `{ kind: 'user' | 'site', id, name }`
|
|
94
138
|
or `null` for a write the Provider made itself, and `time` is the Provider's
|
|
95
139
|
ISO 8601 change time. It is `null` where the Provider delivered no time, as at
|
|
96
140
|
a Site. An unsent edit or move keeps it, an unsent creation has none, and a
|
|
97
|
-
saved write takes the Provider's own once it is Accepted
|
|
141
|
+
saved write takes the Provider's own once it is Accepted. A
|
|
98
142
|
Room's last change is its Document with the latest `time`.
|
|
99
143
|
- **Order and groups.** `orderBy` sorts by `room`, `path`, `type` or `{ field }`
|
|
100
144
|
with TanStack DB's own options, and ties end with Room, then Path. `groupBy` by
|
|
101
145
|
`room`, `type` or `{ field }` answers `{ groups: [{ key, count }] }`, counted
|
|
102
|
-
over every match and ordered by `count` or a key.
|
|
103
|
-
or the groups.
|
|
146
|
+
over every match and ordered by `count` or a key. A sort or group takes only a
|
|
147
|
+
pointer that holds one value. `limit` bounds the Documents or the groups.
|
|
104
148
|
- **Results and errors.** A result carries no Room Version: read freshness from
|
|
105
|
-
Rooms and Sync Status.
|
|
106
|
-
|
|
107
|
-
|
|
149
|
+
Rooms and Sync Status. `coverage` names each Room read as `{ room, generation,
|
|
150
|
+
current }`, `current` false while a newer copy of that Room is being fetched,
|
|
151
|
+
and the queued changes it includes as `overlay`; a Save in a Room changes the
|
|
152
|
+
`overlay` of every query over it. An invalid query fails with the `code`
|
|
153
|
+
`invalid-query`, `unknown-type`, `unknown-field` or `wrong-kind`, naming where,
|
|
154
|
+
and never answers an empty result in its place.
|
|
108
155
|
|
|
109
156
|
## Local Search rules
|
|
110
157
|
|
|
111
158
|
`search({ text, documents, conversations, limit })` answers once, by words, from
|
|
112
|
-
local state, with MiniSearch
|
|
113
|
-
search.
|
|
159
|
+
local state, with MiniSearch's defaults. There is no observed search.
|
|
114
160
|
|
|
115
161
|
- **What is found.** A Document by its field values, its sections' headings and
|
|
116
162
|
text, its preamble and its Path; a message by its text. Frontmatter keys, Room
|
|
117
|
-
Drafts, chat drafts and
|
|
163
|
+
Drafts, chat drafts and a running turn's parts are never found. There are no phrases,
|
|
118
164
|
word forms, typo tolerance or prefix matching.
|
|
119
165
|
- **Narrowing.** `documents` is a Local Query filter: `rooms`, `types`, `where`,
|
|
120
166
|
`pathPrefix`, `hop` and `backlinks`. `conversations` names conversations. Both
|
|
121
167
|
apply before `limit`, which bounds each list; without it every hit returns.
|
|
122
|
-
- **Results.** `{ documents, messages }`,
|
|
168
|
+
- **Results.** `{ documents, messages, coverage }`, or `{ pending }` naming each
|
|
169
|
+
Room or conversation the search waits for while its index is prepared: ask
|
|
170
|
+
again, and never read pending as no hits. `coverage` names the Rooms and
|
|
171
|
+
conversations searched. Each list is ranked by `score`, which compares
|
|
123
172
|
hits of one list of one search. A Document hit names its `room`, `path` and
|
|
124
173
|
`type`, a message hit its `conversation` and `identity`, and `matches` maps each
|
|
125
174
|
matched word to the parts it matched in: `fields`, `sections`, `preamble` or
|
|
@@ -128,47 +177,52 @@ search.
|
|
|
128
177
|
|
|
129
178
|
## Room Draft, Save, and outcome rules
|
|
130
179
|
|
|
131
|
-
The MD Runtime owns one Room Draft per Room and Path, shared by every App and
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
base. A
|
|
140
|
-
`
|
|
141
|
-
the current Room Draft; read it and write again.
|
|
180
|
+
The MD Runtime owns one Room Draft per Room and Path, shared by every App and tab.
|
|
181
|
+
It is durable: it survives reload and navigation. A Room that Discovery stops
|
|
182
|
+
listing takes its Room Drafts and its queue with it. Write a Room Draft with
|
|
183
|
+
`roomDraft.write(room, path, revision, parts)`, naming the revision you read, or
|
|
184
|
+
`null` when there was none, and every part it should now change: fields, sections
|
|
185
|
+
and the preamble, or the whole Markdown, a creation, a move, or a removal. A part
|
|
186
|
+
new to the Room Draft names its base, the value you showed when it was opened; the
|
|
187
|
+
MD Runtime keeps a part's first base; a binary Path entry's move or removal takes
|
|
188
|
+
`null` as its base. A write or a discard from an older revision is refused as
|
|
189
|
+
`stale` with the current Room Draft; read it and write again.
|
|
142
190
|
|
|
143
191
|
Save takes one Room and the Room Drafts of it to save, each with its revision,
|
|
144
192
|
validates locally, and on success appends one Change Batch to that Room's
|
|
145
|
-
queue and removes those Room Drafts. It is refused
|
|
193
|
+
queue and removes those Room Drafts. It is refused with the `code` `stale`,
|
|
146
194
|
`changed-underneath` naming each part whose base no longer matches the visible
|
|
147
|
-
state, or
|
|
195
|
+
state, or a local validation rule, and then creates nothing and leaves every
|
|
148
196
|
Room Draft in place. A directory move or removal is a move or removal part on
|
|
149
|
-
each Document and binary
|
|
197
|
+
each Document and binary Path entry beneath it, saved together.
|
|
150
198
|
|
|
151
199
|
Outcomes follow the Provider's answer. An Accepted Change Batch stays in the
|
|
152
200
|
queue, drawn over the confirmed layer, until the confirmed layer reaches the
|
|
153
|
-
Room Version it was accepted at, and then leaves it. Conflicted and Rejected, an expired
|
|
201
|
+
Room Version it was accepted at, and then leaves it. Conflicted and Rejected, an expired operation, and a change that no
|
|
154
202
|
longer applies over the Room each leave the queue and return as Room Drafts on
|
|
155
203
|
the Documents they changed, marked with why: the Provider's structured refusal
|
|
156
204
|
code and fields as returned, not known to have applied, or withdrawn locally.
|
|
157
205
|
The rest of the queue keeps synchronizing, and Sync Status requires attention
|
|
158
|
-
until each returned Room Draft is saved again or discarded.
|
|
159
|
-
|
|
206
|
+
until each returned Room Draft is saved again or discarded. A Change Batch
|
|
207
|
+
keeps no outcome once it leaves the queue; `observe('queue', room)` shows each
|
|
208
|
+
Pending one, and a returned Room Draft says why it returned. Transport
|
|
160
209
|
failure and Provider unavailability keep work Pending and do not infer a
|
|
161
210
|
rejection. A refusal the Provider marks retryable stays Pending until the reset
|
|
162
211
|
it names; the MD Runtime retries the same Change Batch identity and payload and
|
|
163
212
|
never infers an outcome from transport uncertainty. The MD Runtime never
|
|
164
213
|
combines, reorders, or rebases.
|
|
165
214
|
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
215
|
+
On a Site, every Save stays in the visitor's browser. Write grants and revisions
|
|
216
|
+
do not refuse it, and its Pending Change shows in every query and across reloads
|
|
217
|
+
until the browser's storage is cleared. It is never sent: `observe('queue', room)`
|
|
218
|
+
shows it `local`, and Sync Status never waits on it. Once the Room changes so that
|
|
219
|
+
it no longer applies, it leaves the queue and returns no Room Draft.
|
|
220
|
+
|
|
221
|
+
`observe('service-mode')` answers the Provider's Service Mode, `open` or
|
|
222
|
+
`write-halted`. While writes are halted, Save still succeeds, its Change Batch
|
|
223
|
+
waits unsent, and the queue is submitted in order once the Provider reopens
|
|
224
|
+
writes. An Action is never held: a write the Provider refuses for the halt returns
|
|
225
|
+
that refusal to its caller. Show the Provider as read-only instead of retrying.
|
|
172
226
|
|
|
173
227
|
## The neutrality rule
|
|
174
228
|
|
|
@@ -196,13 +250,58 @@ an App's override respected. What an App Creator's agent adds carries none
|
|
|
196
250
|
of these promises by itself. Reading, querying and searching never wait for
|
|
197
251
|
the network. Data lives only in the App Creator's browser and with the Provider.
|
|
198
252
|
|
|
199
|
-
## App code
|
|
253
|
+
## App code takes the client its host hands it and never constructs a Runtime
|
|
254
|
+
|
|
255
|
+
App code takes the client its host hands it: in House, `houseBridge().runtime`
|
|
256
|
+
from `@agentshouse/app-bridge` resolves to the client House built into the page.
|
|
257
|
+
It imports only types from `@agentshouse/mdruntime/client`, never calls
|
|
258
|
+
`connectMdRuntime` or `serveMdRuntime`, and never imports the package main, the
|
|
259
|
+
host entry or the Adapter package, which hosts and tests use. The in-memory
|
|
260
|
+
Adapter at `@agentshouse/mdruntime/memory` is for tests and ships in no bundle.
|
|
261
|
+
A Site's page fills its Entry Data Contract's `{"$param": name}` arguments with
|
|
262
|
+
`boundQuery` from `@agentshouse/mdruntime/entry`, as House did for its HTML.
|
|
263
|
+
|
|
264
|
+
A React App may observe and save through `@agentshouse/mdruntime/react`, which
|
|
265
|
+
names React as a peer dependency. `useObserve(client, topic, ...input)` takes
|
|
266
|
+
the arguments of `observe` and returns `{ state: 'loading' }` until the topic's
|
|
267
|
+
first value arrives, then `{ state: 'ready', value }`, re-rendering on each
|
|
268
|
+
change; a `null` client observes nothing and stays loading. `useSave(client)`
|
|
269
|
+
returns `busy`, the last `outcome` or `failure`, and `save(room, roomDrafts)`,
|
|
270
|
+
which writes each Path's parts onto the Room Draft already there, keeping the
|
|
271
|
+
bases its parts have, or onto a new one, and saves them together. A refused
|
|
272
|
+
Save leaves the Room Drafts for the App to save again or discard; a failure is
|
|
273
|
+
recorded and rejects. `saveRoomDrafts(client, room, roomDrafts)` is that save
|
|
274
|
+
outside a component. A react-admin or Refine App reads and writes its Rooms
|
|
275
|
+
through the data providers of `@agentshouse/mdruntime-families`.
|
|
276
|
+
|
|
277
|
+
## The Chat
|
|
278
|
+
|
|
279
|
+
`@agentshouse/mdruntime/chat` holds the Chat, one data layer for every App; add
|
|
280
|
+
React as a dependency in any App, with React DOM and `@assistant-ui/react`.
|
|
281
|
+
|
|
282
|
+
Place the ready chat with `<Chat client={runtime} conversation={id}
|
|
283
|
+
agent={agent} width="1/3" showChats />`: `conversation` opens one, `null` for a
|
|
284
|
+
new chat, `agent` is the Agent a new chat goes to, `onOpen` hears each one it
|
|
285
|
+
opens, and `width` is `full` (the place you give it), or `3/4`, `1/2` or `1/3`
|
|
286
|
+
of the window docked at its right edge, whole on a narrow window. `showChats`
|
|
287
|
+
adds its conversation list; or draw your own inside a `ChatProvider` around a
|
|
288
|
+
`<Chat />` with no `client`. It carries its own styles; theme it with CSS custom
|
|
289
|
+
properties on it or an ancestor: `--chat-background`, `--chat-surface`,
|
|
290
|
+
`--chat-text`, `--chat-text-muted`, `--chat-accent`, `--chat-line`,
|
|
291
|
+
`--chat-attention`, `--chat-danger`, `--chat-font`, `--chat-font-mono`,
|
|
292
|
+
`--chat-font-size`, `--chat-radius` and `--chat-density` (a factor for spacing);
|
|
293
|
+
an unset one keeps House's light or dark look. `mountChat(element, { client })`
|
|
294
|
+
places it outside React and returns `update(props)` and `unmount()`.
|
|
200
295
|
|
|
201
|
-
|
|
202
|
-
`
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
296
|
+
Mix `ChatMessageList` (`components` takes your `UserMessage` and
|
|
297
|
+
`AssistantMessage`), `ChatInput` and `ChatQuestionCard` with your own design
|
|
298
|
+
inside a `ChatProvider`, or compose assistant-ui's primitives there; `useChat()`
|
|
299
|
+
gives `send`, the conversations, the Agents, questions to `answer`, `options`
|
|
300
|
+
to `choose`, `commands`, the queue to `edit` or `unqueue`, `stop`, `kill` and
|
|
301
|
+
outcomes; never replace its messages, sending or store. A secret question is
|
|
302
|
+
never answered here; typed answers live in Presentation State's `typed` key:
|
|
303
|
+
keep it, and change Presentation State only inside `inTurn(client, work)` from
|
|
304
|
+
`@agentshouse/mdruntime/client`. `Markdown` draws Markdown safely.
|
|
206
305
|
|
|
207
306
|
## What an agent must never do
|
|
208
307
|
|
package/README.md
CHANGED
|
@@ -19,12 +19,12 @@ import { serveMdRuntime } from '@agentshouse/mdruntime/host';
|
|
|
19
19
|
import { createAgentsHouseAdapter } from '@agentshouse/mdruntime-adapter';
|
|
20
20
|
|
|
21
21
|
const adapter = createAgentsHouseAdapter({ transport, authorize });
|
|
22
|
-
const host = serveMdRuntime({ adapter, shell
|
|
22
|
+
const host = serveMdRuntime({ adapter, shell });
|
|
23
23
|
host.attach(port, 'my-app');
|
|
24
24
|
```
|
|
25
25
|
|
|
26
|
-
App code never imports this package; it reaches the Runtime only through
|
|
27
|
-
|
|
26
|
+
App code never imports this package; it reaches the Runtime only through the
|
|
27
|
+
client its host hands it. The rules an App's agent follows are in the
|
|
28
28
|
package's `AGENTS.md`.
|
|
29
29
|
|
|
30
30
|
## License
|
package/dist/actions.d.ts
CHANGED
|
@@ -1,8 +1,69 @@
|
|
|
1
|
-
import { type AcceptedMessage, type ActionDeclaration, type ActionRequest, type ActionResult, type
|
|
1
|
+
import { type AcceptedMessage, type ActionDeclaration, type ActionRequest, type ActionResult, type ConversationAgents, type ConversationHistories, type ConversationHistoryRequest, type FileDeclaration } from '@agentshouse/mdruntime';
|
|
2
2
|
import type { HouseDoorAnswer, HouseTransport } from './transport.js';
|
|
3
|
-
|
|
3
|
+
type Operated = {
|
|
4
|
+
readonly operation_id?: string;
|
|
5
|
+
};
|
|
6
|
+
type ConversationControl = Operated & {
|
|
7
|
+
readonly conversation: string;
|
|
8
|
+
};
|
|
9
|
+
type SentFile = FileDeclaration & {
|
|
10
|
+
readonly blob: Blob;
|
|
11
|
+
};
|
|
12
|
+
export type AppInputs = {
|
|
13
|
+
readonly 'conversation.answer': ConversationControl & {
|
|
14
|
+
readonly answer: {
|
|
15
|
+
readonly interaction_id: string;
|
|
16
|
+
readonly response: unknown;
|
|
17
|
+
};
|
|
18
|
+
};
|
|
19
|
+
readonly 'conversation.create': Operated & {
|
|
20
|
+
readonly agent_id: string;
|
|
21
|
+
};
|
|
22
|
+
readonly 'conversation.delete': ConversationControl;
|
|
23
|
+
readonly 'conversation.history': ConversationHistoryRequest;
|
|
24
|
+
readonly 'conversation.interrupt': ConversationControl;
|
|
25
|
+
readonly 'conversation.kill': ConversationControl;
|
|
26
|
+
readonly 'conversation.send': ConversationControl & {
|
|
27
|
+
readonly operation_id: string;
|
|
28
|
+
readonly text?: string;
|
|
29
|
+
readonly files?: readonly SentFile[];
|
|
30
|
+
};
|
|
31
|
+
};
|
|
32
|
+
export type AppAnswers = {
|
|
33
|
+
readonly 'conversation.history': ConversationHistories;
|
|
34
|
+
};
|
|
35
|
+
export type AppAnswerAdditions = {
|
|
36
|
+
readonly 'conversation.create': {
|
|
37
|
+
readonly conversation: string;
|
|
38
|
+
};
|
|
39
|
+
readonly 'conversation.send': {
|
|
40
|
+
readonly turn: string;
|
|
41
|
+
};
|
|
42
|
+
readonly 'record.list': {
|
|
43
|
+
readonly attachments: readonly {
|
|
44
|
+
readonly referrer: {
|
|
45
|
+
readonly room_ref: string;
|
|
46
|
+
readonly record: string;
|
|
47
|
+
};
|
|
48
|
+
}[];
|
|
49
|
+
readonly records: readonly {
|
|
50
|
+
readonly attachments: readonly {
|
|
51
|
+
readonly referrer: {
|
|
52
|
+
readonly room_ref: string;
|
|
53
|
+
readonly record: string;
|
|
54
|
+
};
|
|
55
|
+
}[];
|
|
56
|
+
}[];
|
|
57
|
+
};
|
|
58
|
+
};
|
|
59
|
+
export declare const HOUSE_APP_ACTS: Readonly<Record<string, string>>;
|
|
60
|
+
export declare const SITE_SUBMIT = "submit";
|
|
61
|
+
export declare const HOUSE_SITE_ACTS: Readonly<Record<string, string>>;
|
|
62
|
+
export declare const HOUSE_APP_BATCHES: Readonly<Partial<Record<string, readonly string[]>>>;
|
|
63
|
+
export declare function houseConversationAgents(locator: string): ConversationAgents;
|
|
4
64
|
export declare function declaredActions(routes: readonly string[]): readonly ActionDeclaration[];
|
|
5
65
|
export declare function houseAction(transport: HouseTransport, request: ActionRequest): Promise<ActionResult>;
|
|
6
66
|
export declare function actionOutcome(answer: HouseDoorAnswer, name: string): ActionResult;
|
|
7
67
|
export declare function acceptedMessage(entry: unknown): AcceptedMessage | null;
|
|
68
|
+
export {};
|
|
8
69
|
//# sourceMappingURL=actions.d.ts.map
|
package/dist/actions.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../src/actions.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,
|
|
1
|
+
{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../src/actions.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAE1B,KAAK,0BAA0B,EAC/B,KAAK,eAAe,EACrB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAQtE,KAAK,QAAQ,GAAG;IAAE,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEnD,KAAK,mBAAmB,GAAG,QAAQ,GAAG;IAAE,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;CAAE,CAAC;AAExE,KAAK,QAAQ,GAAG,eAAe,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAA;CAAE,CAAC;AAE1D,MAAM,MAAM,SAAS,GAAG;IACtB,QAAQ,CAAC,qBAAqB,EAAE,mBAAmB,GAAG;QACpD,QAAQ,CAAC,MAAM,EAAE;YAAE,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;YAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAA;SAAE,CAAC;KAClF,CAAC;IACF,QAAQ,CAAC,qBAAqB,EAAE,QAAQ,GAAG;QAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC;IACzE,QAAQ,CAAC,qBAAqB,EAAE,mBAAmB,CAAC;IACpD,QAAQ,CAAC,sBAAsB,EAAE,0BAA0B,CAAC;IAC5D,QAAQ,CAAC,wBAAwB,EAAE,mBAAmB,CAAC;IACvD,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;IAClD,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,GAAG;QAClD,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;QAC9B,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QACvB,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,QAAQ,EAAE,CAAC;KACtC,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,QAAQ,CAAC,sBAAsB,EAAE,qBAAqB,CAAC;CACxD,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,QAAQ,CAAC,qBAAqB,EAAE;QAAE,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;KAAE,CAAC;IAClE,QAAQ,CAAC,mBAAmB,EAAE;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IACxD,QAAQ,CAAC,aAAa,EAAE;QACtB,QAAQ,CAAC,WAAW,EAAE,SAAS;YAC7B,QAAQ,CAAC,QAAQ,EAAE;gBAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;gBAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;aAAE,CAAC;SAC3E,EAAE,CAAC;QACJ,QAAQ,CAAC,OAAO,EAAE,SAAS;YACzB,QAAQ,CAAC,WAAW,EAAE,SAAS;gBAC7B,QAAQ,CAAC,QAAQ,EAAE;oBAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;oBAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;iBAAE,CAAC;aAC3E,EAAE,CAAC;SACL,EAAE,CAAC;KACL,CAAC;CACH,CAAC;AAwEF,eAAO,MAAM,cAAc,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAE3D,CAAC;AAEF,eAAO,MAAM,WAAW,WAAW,CAAC;AAEpC,eAAO,MAAM,eAAe,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAE5D,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC,CAAC,CAKhF,CAAC;AAMJ,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,MAAM,GAAG,kBAAkB,CAE3E;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,iBAAiB,EAAE,CAMvF;AAED,wBAAgB,WAAW,CACzB,SAAS,EAAE,cAAc,EACzB,OAAO,EAAE,aAAa,GACrB,OAAO,CAAC,YAAY,CAAC,CAQvB;AA6ED,wBAAgB,aAAa,CAAC,MAAM,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM,GAAG,YAAY,CAOjF;AAuKD,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,eAAe,GAAG,IAAI,CAiBtE"}
|