@agentshouse/mdruntime 0.1.0-cde2b99d2fcbc → 0.1.0-ce131cb435f8b
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 +271 -290
- package/README.md +8 -8
- package/dist/adapter.d.ts +52 -10
- package/dist/adapter.d.ts.map +1 -1
- package/dist/attempt.d.ts.map +1 -1
- package/dist/attempt.js +14 -1
- package/dist/bootstrap.d.ts +3 -2
- package/dist/bootstrap.d.ts.map +1 -1
- package/dist/bootstrap.js +33 -7
- package/dist/change-set.d.ts +2 -0
- package/dist/change-set.d.ts.map +1 -1
- package/dist/change-set.js +36 -10
- package/dist/chat/acts.d.ts +3 -4
- package/dist/chat/acts.d.ts.map +1 -1
- package/dist/chat/acts.js +10 -10
- package/dist/chat/earlier.d.ts +10 -0
- package/dist/chat/earlier.d.ts.map +1 -0
- package/dist/chat/earlier.js +54 -0
- package/dist/chat/kit.d.ts +2 -1
- package/dist/chat/kit.d.ts.map +1 -1
- package/dist/chat/kit.js +3 -3
- package/dist/chat/list.d.ts +8 -1
- package/dist/chat/list.d.ts.map +1 -1
- package/dist/chat/list.js +48 -8
- package/dist/chat/markdown.d.ts +2 -1
- package/dist/chat/markdown.d.ts.map +1 -1
- package/dist/chat/markdown.js +7 -6
- package/dist/chat/message.d.ts.map +1 -1
- package/dist/chat/message.js +2 -2
- package/dist/chat/messages.d.ts +1 -0
- package/dist/chat/messages.d.ts.map +1 -1
- package/dist/chat/messages.js +4 -0
- package/dist/chat/provider.d.ts +1 -1
- package/dist/chat/provider.d.ts.map +1 -1
- package/dist/chat/provider.js +62 -79
- package/dist/chat/question.d.ts +1 -1
- package/dist/chat/question.d.ts.map +1 -1
- package/dist/chat/question.js +7 -18
- package/dist/chat/ready.d.ts +1 -0
- package/dist/chat/ready.d.ts.map +1 -1
- package/dist/chat/ready.js +4 -4
- package/dist/chat/style.js +5 -5
- package/dist/client.d.ts +17 -9
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +19 -6
- package/dist/collection.d.ts +20 -5
- package/dist/collection.d.ts.map +1 -1
- package/dist/collection.js +309 -33
- package/dist/connection.d.ts +31 -9
- package/dist/connection.d.ts.map +1 -1
- package/dist/connection.js +1620 -397
- package/dist/conversation.d.ts +20 -7
- package/dist/conversation.d.ts.map +1 -1
- package/dist/conversation.js +474 -163
- package/dist/durability.d.ts +7 -1
- package/dist/durability.d.ts.map +1 -1
- package/dist/entry.d.ts +17 -0
- package/dist/entry.d.ts.map +1 -0
- package/dist/entry.js +157 -0
- package/dist/fence.d.ts +6 -0
- package/dist/fence.d.ts.map +1 -0
- package/dist/fence.js +10 -0
- package/dist/host.d.ts +15 -3
- package/dist/host.d.ts.map +1 -1
- package/dist/host.js +94 -12
- package/dist/identity.d.ts +2 -0
- package/dist/identity.d.ts.map +1 -1
- package/dist/identity.js +6 -0
- package/dist/index.d.ts +10 -7
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -0
- package/dist/memory.d.ts +8 -2
- package/dist/memory.d.ts.map +1 -1
- package/dist/memory.js +33 -6
- package/dist/model.d.ts +4 -2
- package/dist/model.d.ts.map +1 -1
- package/dist/model.js +10 -1
- package/dist/observation.d.ts +7 -2
- package/dist/observation.d.ts.map +1 -1
- package/dist/observation.js +29 -12
- package/dist/outcome.d.ts +12 -2
- package/dist/outcome.d.ts.map +1 -1
- package/dist/outcome.js +4 -0
- package/dist/overlay.d.ts +3 -0
- package/dist/overlay.d.ts.map +1 -1
- package/dist/overlay.js +62 -55
- package/dist/query.d.ts +56 -4
- package/dist/query.d.ts.map +1 -1
- package/dist/query.js +36 -7
- package/dist/reach.d.ts +6 -3
- package/dist/reach.d.ts.map +1 -1
- package/dist/reach.js +30 -5
- package/dist/react.d.ts +8 -6
- package/dist/react.d.ts.map +1 -1
- package/dist/react.js +7 -17
- package/dist/read-side.d.ts +16 -7
- package/dist/read-side.d.ts.map +1 -1
- package/dist/read-side.js +484 -100
- package/dist/readiness.d.ts +53 -0
- package/dist/readiness.d.ts.map +1 -0
- package/dist/readiness.js +33 -0
- package/dist/reads.d.ts +11 -0
- package/dist/reads.d.ts.map +1 -0
- package/dist/reads.js +98 -0
- package/dist/recovery.d.ts +25 -0
- package/dist/recovery.d.ts.map +1 -0
- package/dist/recovery.js +197 -0
- package/dist/refresh.d.ts +4 -4
- package/dist/refresh.d.ts.map +1 -1
- package/dist/refresh.js +18 -11
- package/dist/replica.d.ts +10 -5
- package/dist/replica.d.ts.map +1 -1
- package/dist/replica.js +96 -44
- package/dist/room-draft.d.ts +13 -1
- package/dist/room-draft.d.ts.map +1 -1
- package/dist/room-draft.js +2 -2
- package/dist/rows.d.ts +6 -13
- package/dist/rows.d.ts.map +1 -1
- package/dist/rows.js +10 -13
- package/dist/save.d.ts +9 -3
- package/dist/save.d.ts.map +1 -1
- package/dist/save.js +68 -22
- package/dist/search.d.ts +49 -6
- package/dist/search.d.ts.map +1 -1
- package/dist/search.js +192 -47
- package/dist/seed.d.ts +16 -0
- package/dist/seed.d.ts.map +1 -0
- package/dist/seed.js +75 -0
- package/dist/shared.d.ts +14 -0
- package/dist/shared.d.ts.map +1 -0
- package/dist/shared.js +394 -0
- package/dist/status.d.ts +4 -0
- package/dist/status.d.ts.map +1 -1
- package/dist/store.d.ts +64 -16
- package/dist/store.d.ts.map +1 -1
- package/dist/store.js +447 -178
- package/dist/turn.d.ts +9 -0
- package/dist/turn.d.ts.map +1 -0
- package/dist/turn.js +64 -0
- package/dist/windows.d.ts +26 -0
- package/dist/windows.d.ts.map +1 -0
- package/dist/windows.js +93 -0
- package/dist/wire.d.ts +152 -32
- package/dist/wire.d.ts.map +1 -1
- package/dist/wire.js +52 -31
- package/package.json +12 -8
package/AGENTS.md
CHANGED
|
@@ -1,318 +1,299 @@
|
|
|
1
1
|
# Instructions for the App Creator's agent
|
|
2
2
|
|
|
3
|
-
These instructions address an agent in an environment with Git
|
|
4
|
-
|
|
3
|
+
These instructions address an agent in an environment with Git: obtain the App Repository,
|
|
4
|
+
change it, build, and push. They are documentation, not enforcement.
|
|
5
5
|
|
|
6
6
|
## The MD Runtime API
|
|
7
7
|
|
|
8
|
-
App code reaches the MD Runtime through the remote client. The surfaces are
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
and Presentation State. Sync Status, the Service Mode, the storage-loss
|
|
8
|
+
App code reaches the MD Runtime through the remote client. The surfaces are Rooms,
|
|
9
|
+
Query, Search, Observe, Types, Room Draft, Save, History, the binary file reads, Call,
|
|
10
|
+
Reached, Log, the reported persistence answer, reauthorization, conversation, the chat
|
|
11
|
+
draft, and Presentation State. Sync Status, readiness, the Service Mode, the storage-loss
|
|
13
12
|
statement, the deployment facts and the signed-in member are observations only.
|
|
14
13
|
|
|
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
|
-
`
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
and
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
`
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
`
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
Save
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
`
|
|
67
|
-
document whose text names it. Both answer
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
`
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
names its author, `{ kind: 'user', id }` or `{ kind: 'site', id, name }`.
|
|
82
|
-
History of a Path no current document holds answers the removed document's
|
|
83
|
-
revisions with `deleted: true`, newest first; that revision is what a link to
|
|
84
|
-
the Path opens. Every
|
|
85
|
-
member of the
|
|
86
|
-
client is asynchronous. Results are detached snapshots. Nothing in this
|
|
87
|
-
surface returns the authorization, performs a request the App's code
|
|
14
|
+
The host attaches each port with its reach, and every member and observation answers
|
|
15
|
+
within it: a Room outside it answers as one the replica does not hold, Rooms lists only
|
|
16
|
+
the Rooms reached whole, a Room reached for single Documents shows only them and their
|
|
17
|
+
models' Types, and without conversations the conversation members, chat draft and
|
|
18
|
+
observation hold none. A changed reach reaches every open observation as its new value.
|
|
19
|
+
|
|
20
|
+
Every `observe` resolves, once its first value arrived, to a handle: `current()` is the
|
|
21
|
+
latest complete value, `subscribe(listener)` hears each later value whole and returns its
|
|
22
|
+
unsubscribe, and `close()` ends it. Closing the port ends every handle and rejects every
|
|
23
|
+
pending call and observation; a reconnected client observes again.
|
|
24
|
+
|
|
25
|
+
`observe('agents')` answers every Agent a new conversation can go to, each `{ identity,
|
|
26
|
+
name }`, with a conversation yet or not. Each conversation the Provider lists is held
|
|
27
|
+
complete in the browser. `conversation.list()` and `observe('conversations')` answer each
|
|
28
|
+
with its Agent's identity and name, its name, created and finished times, last outcome,
|
|
29
|
+
live `state` (`asking` while a question waits, `working` while a turn runs, else `idle`)
|
|
30
|
+
and `started`, when the running turn began, or `null`. `observe('conversation', id, {
|
|
31
|
+
limit, total: true })` holds its latest `limit` messages, at most 1,000, oldest first,
|
|
32
|
+
`total` their count, and `next` while older ones exist, which `after` takes, there or in
|
|
33
|
+
`conversation.read(id, { limit, after })`, for the window before; its chat draft; and,
|
|
34
|
+
only in memory, what the Provider streams whether or not anything views it: the running
|
|
35
|
+
`turn` with its parts and its context in use and window, which the message accepted under
|
|
36
|
+
the turn's id replaces, the open questions, the process state, and the CLI's commands and
|
|
37
|
+
options, none stored or searchable. `chatDraft.write` and `chatDraft.discard` keep what
|
|
38
|
+
the App Creator composes, and `chatDraft.prepend(conversation, draft)` puts a 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
|
|
41
|
+
identity>`: no conversation list removes it, a retired Agent's goes, and the first answer
|
|
42
|
+
to `conversation.create({ agent_id, operation_id })` moves it to the created conversation,
|
|
43
|
+
where `conversation.send(conversation)` sends it; a replay of that create moves nothing.
|
|
44
|
+
|
|
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.
|
|
68
|
+
|
|
69
|
+
Rooms, Query, Search, Observe, Types, Room Draft, Save, and Reached never touch the
|
|
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
|
|
88
80
|
composes, or exposes the browser store.
|
|
89
81
|
|
|
90
82
|
Every refusal and failure carries `code` and `retryable`: each Call and History answer
|
|
91
|
-
other than its result, a refused Save or Room Draft write, a returned Room Draft's
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
`
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
opaque value
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
`
|
|
102
|
-
|
|
103
|
-
the
|
|
104
|
-
|
|
105
|
-
and every port hears the next member the Provider names; signing out answers
|
|
106
|
-
`null`, then ends the observation with the authorization. It is the only way App code learns who
|
|
107
|
-
uses it.
|
|
108
|
-
|
|
109
|
-
The in-memory Adapter at `@agentshouse/mdruntime/memory` is for tests and
|
|
110
|
-
ships in no bundle.
|
|
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`.
|
|
89
|
+
|
|
90
|
+
Read the deployment facts with `observe('deployment-facts')`, an opaque value the host's
|
|
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.
|
|
111
97
|
|
|
112
98
|
## Local Query rules
|
|
113
99
|
|
|
114
|
-
`query(q)` answers once from local state; `observe('query', q)` holds the whole
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
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:
|
|
106
|
+
|
|
107
|
+
- **Filter.** `rooms` names Room locators and defaults to every Room. `types` names 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.
|
|
122
111
|
- **Fields.** Every frontmatter value is named by JSON Pointer: `/status`,
|
|
123
|
-
`/shipping/city`, `~1` for a `/` and `~0` for a `~` in a key. A segment that
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
`$
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
values. There is no text containment or regular
|
|
134
|
-
expression.
|
|
112
|
+
`/shipping/city`, `~1` for a `/` and `~0` for a `~` in a key. A segment that meets a
|
|
113
|
+
list applies to every item and a number names one item. `where` names pointers, ANDs
|
|
114
|
+
them, and nests `$and` and `$or`; a pointer through a list holds if any item satisfies
|
|
115
|
+
it. A bare value is equality; the operators are `$eq`, `$ne`, `$in`, `$nin`, `$gt`,
|
|
116
|
+
`$gte`, `$lt`, `$lte`, `$all`, `$size` and `$exists`. Equality on a list asks if it
|
|
117
|
+
contains the value. Missing, null and empty differ: `$exists: false` keeps a missing
|
|
118
|
+
field, `null` an explicit null, `''` empty text and `$size: 0` an empty list. A date
|
|
119
|
+
compares in calendar order and never with a date-time. A reference compares by the
|
|
120
|
+
Room Path it resolves to. Untyped frontmatter, and a value under `oneOf` or a
|
|
121
|
+
conditional, is plain values. There is no text containment or regular expression.
|
|
135
122
|
- **Relations.** `hop: { field, types, where, pathPrefix }` keeps Documents whose
|
|
136
|
-
reference at pointer `field`, at any depth, points to a matching Document of the
|
|
137
|
-
|
|
138
|
-
|
|
123
|
+
reference at pointer `field`, at any depth, points to a matching Document of the same
|
|
124
|
+
Room. `backlinks: { field, types, where, pathPrefix }` keeps Documents that a matching
|
|
125
|
+
Document of the same Room references. Each keeps a Document once.
|
|
139
126
|
- **Parts.** A Document query must `select`: `'all'`, or `fields`, `sections`,
|
|
140
|
-
`preamble`, `markdown`, `backlinks` and `
|
|
141
|
-
list of pointers and `sections` `'all'` or a list of names. Selected pointers
|
|
142
|
-
return the frontmatter holding only them, nested as written. A backlink names
|
|
143
|
-
|
|
144
|
-
Document also returns its MD Type
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
`
|
|
163
|
-
|
|
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.
|
|
164
157
|
|
|
165
158
|
## Local Search rules
|
|
166
159
|
|
|
167
|
-
`search({ text, documents, conversations, limit })` answers
|
|
168
|
-
local state, with MiniSearch
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
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
|
|
177
|
+
read pending as no hits. `coverage` names the Rooms and conversations searched. Each
|
|
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.
|
|
184
183
|
|
|
185
184
|
## Room Draft, Save, and outcome rules
|
|
186
185
|
|
|
187
|
-
The MD Runtime owns one Room Draft per Room and Path, shared by every App and
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
it
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
`
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
Rendered Markdown never executes scripts, renders raw HTML only for the
|
|
249
|
-
details and summary elements, and loads images and other resources only from
|
|
250
|
-
origins the Provider's policy allows.
|
|
251
|
-
|
|
252
|
-
## Launch promises MD UI keeps
|
|
253
|
-
|
|
254
|
-
MD UI uses semantic HTML, is fully operable from a keyboard with visible
|
|
255
|
-
focus and labelled controls, and lays out from a 360 pixel wide viewport to
|
|
256
|
-
a desktop. Its strings are English only, dates and numbers follow the
|
|
257
|
-
browser locale, and content is never translated. Light and dark themes come
|
|
258
|
-
from CSS custom properties with the browser's preference as the default and
|
|
259
|
-
an App's override respected. What an App Creator's agent adds carries none
|
|
260
|
-
of these promises by itself. Reading, querying and searching never wait for
|
|
261
|
-
the network. Data lives only in the App Creator's browser and with the Provider.
|
|
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.
|
|
194
|
+
|
|
195
|
+
Save takes one Room and the Room Drafts of it to save, each with its revision, validates
|
|
196
|
+
locally, and on success appends one Change Batch to that Room's queue and removes those
|
|
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
|
|
218
|
+
refuse it, and its Pending Change shows in every query and across reloads until the
|
|
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.
|
|
222
|
+
|
|
223
|
+
`observe('service-mode')` answers the Provider's Service Mode, `open` or `write-halted`.
|
|
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.
|
|
227
|
+
`observe('readiness')` tells whether the App's code and bound Rooms are held locally
|
|
228
|
+
(`ready`), each Room's state, each refused Room's file and rule, the persistence answer
|
|
229
|
+
and a paused preparation's `capacity` cause; `retry()` resumes a paused preparation.
|
|
230
|
+
|
|
231
|
+
## Content safety and launch promises
|
|
232
|
+
|
|
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.
|
|
240
|
+
|
|
241
|
+
MD UI uses semantic HTML, is fully operable from a keyboard with visible focus and
|
|
242
|
+
labelled controls, and lays out from a 360 pixel wide viewport to a desktop. Its strings
|
|
243
|
+
are English only, dates and numbers follow the browser locale, and content is never
|
|
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.
|
|
262
247
|
|
|
263
248
|
## App code takes the client its host hands it and never constructs a Runtime
|
|
264
249
|
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
`@agentshouse/mdruntime/client`,
|
|
269
|
-
`serveMdRuntime`, and
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
the
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
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`.
|
|
284
274
|
|
|
285
275
|
## The Chat
|
|
286
276
|
|
|
287
|
-
`@agentshouse/mdruntime/chat` holds the Chat, one data layer for every App
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
outcomes; never replace its messages, sending or store. A secret question is
|
|
311
|
-
never answered here; typed answers live in Presentation State's `typed` key:
|
|
312
|
-
keep it, and change Presentation State only inside `inTurn(client, work)` from
|
|
313
|
-
`@agentshouse/mdruntime/client`. `Markdown` draws Markdown safely.
|
|
314
|
-
|
|
315
|
-
## What an agent must never do
|
|
316
|
-
|
|
317
|
-
An agent must never read the authorization, load code from a Room, call the
|
|
318
|
-
Provider directly, or rebase a refused Change Batch.
|
|
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()`.
|
|
290
|
+
|
|
291
|
+
Mix `ChatMessageList` (`components` takes your `UserMessage` and `AssistantMessage`),
|
|
292
|
+
`ChatInput` and `ChatQuestionCard` with your own design inside a `ChatProvider`, or
|
|
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.
|