@agentshouse/mdruntime-adapter 0.1.0-alpha.9 → 0.1.0-c506c7d6e6199

package/AGENTS.md

@@ -7,37 +7,166 @@ enforcement.
 ## The MD Runtime API
 
 App code reaches the MD Runtime through the remote client. The surfaces are
-Rooms, Query, Observe, Types, Draft, Save, Queue, History, Call, Log,
-storage loss, the reported persistence answer, Sync Status, reauthorization,
-conversation, the unsent instruction, and Presentation State.
-
-Rooms, Query, Observe, Types, Draft, and Save never touch the network.
-History and Call go to the Provider through the Adapter. Every member of the
+Rooms, Query, Search, Observe, Types, Room Draft, Save, History, Call, Reached, Log,
+the reported persistence answer, reauthorization, conversation, the chat draft,
+and Presentation State. Sync Status, the Service Mode, the storage-loss
+statement and the deployment facts are observations only.
+
+Every `observe` resolves, once its first value has arrived, to a handle:
+`current()` is the latest complete value, `subscribe(listener)` hears each later
+value whole and returns its unsubscribe, and `close()` ends the observation.
+Closing the port ends every handle and rejects every pending call and
+observation; a client that reconnects observes again.
+
+Each conversation a Provider card names is held complete in the browser.
+Observe one with `observe('conversation', id, { limit })`: the view
+holds its latest `limit` messages, or all of them, oldest first, its chat
+draft, and what the Provider streams for it whether or not anything views it:
+the growing text and plan of the running turn, the open questions, the process
+state, the CLI's commands and options, and the latest `workingNote`. These live
+only in memory: the turn's accepted message replaces its growing text and plan,
+a working note is never part of a message, and none of them is stored or
+searchable.
+`chatDraft.write` and `chatDraft.discard` keep what the App Creator composes;
+sending it is a Provider Action that needs the Provider reachable and is never
+queued.
+
+Each Room in Rooms lists its `attachments`, the files the Provider holds for it
+that its Documents link by the Provider's reference, ordered by `reference`,
+each with `name`, `byteLength`, `mediaType` and the Provider's own entry as
+`entry`. They are as the Provider last declared them and hold no bytes;
+open one through the Provider Action that serves it.
+
+Rooms, Query, Search, Observe, Types, Room Draft, Save, and Reached never
+touch the network.
+History and Call go to the Provider through the Adapter. A Call result whose
+effect the Provider places in a Room carries `at`, that Room and Room Version;
+`reached(room, roomVersion)` answers whether the Room's confirmed state has
+reached it, and the MD Runtime keeps refreshing that Room until it has;
+`reached(room, roomVersion, path)` answers whether the held confirmed copy of
+that document was written at a later Room Version. Each History revision
+names its author, `{ kind: 'user', id }` or `{ kind: 'site', id, name }`. Every
+member of the
 client is asynchronous. Results are detached snapshots. Nothing in this
 surface returns the authorization, performs a request the App's code
 composes, or exposes the browser store.
 
+Read the deployment facts with `observe('deployment-facts')`. Interpret the
+opaque value using the host's contract.
+
 The in-memory Adapter at `@agentshouse/mdruntime/memory` is for tests and
 ships in no bundle.
 
-## Draft, Save, and outcome rules
-
-A Draft is durable: it survives reload and navigation. A Room that Discovery
-stops listing takes its Drafts, its queue and their outcomes with it. Save takes structured
-changes, validates locally, and on success appends one Change Batch to that
-Room's queue. A local validation failure leaves the Draft and creates
-nothing.
-
-Outcomes follow the Provider's answer. Accepted advances the confirmed
-layer. Conflicted and Rejected leave the head in place, carry the affected
-current state and the Provider's structured refusal code and fields as
-returned, and block that Room's queue. The App's code resolves a head by
-discarding it or by saving a corrected Change Batch that replaces it in
-place. Transport failure and Provider unavailability keep work Pending and
-do not infer a rejection. A refusal the Provider marks retryable stays
-Pending until the reset it names; the MD Runtime retries the same Change
-Batch identity and payload and never infers an outcome from transport
-uncertainty. The MD Runtime never combines, reorders, or rebases.
+## Local Query rules
+
+`query(q)` answers once from local state; `observe('query', q)` holds the whole
+result and hears it again only when it changes, keeping every unchanged Document
+the same object, so a component can tell what changed by identity. A query is
+data:
+
+- **Filter.** `rooms` names Room locators and defaults to every Room. `types`
+  names MD Types, and `any` names untyped Markdown Documents. `pathPrefix` is a
+  directory: `notes` keeps `notes/a.md` and not `notes2/a.md`.
+- **Fields.** `where` names frontmatter fields, ANDs them, and nests `$and` and
+  `$or`. A bare value is equality; the operators are `$eq`, `$ne`, `$in`, `$nin`,
+  `$gt`, `$gte`, `$lt`, `$lte`, `$all`, `$size` and `$exists`. Equality on a list
+  asks whether it contains the value. Missing, null and empty differ:
+  `$exists: false` keeps a missing field, `null` an explicit null, `''` empty
+  text and `$size: 0` an empty list. A date compares in calendar order and never
+  with a date-time. A reference compares by the Room Path it resolves to.
+  Untyped frontmatter is plain values. There is no text containment or regular
+  expression.
+- **Relations.** `hop: { field, types, where, pathPrefix }` keeps Documents whose
+  reference `field` points to a matching Document of the same Room.
+  `backlinks: { field, types, where, pathPrefix }` keeps Documents that a
+  matching Document of the same Room references. Each keeps a Document once.
+- **Parts.** A Document query must `select`: `'all'`, or `fields`, `sections`,
+  `preamble`, `markdown`, `backlinks` and `change`, where `fields` and `sections`
+  are `'all'` or a list of names. Room and Path always return; a Markdown
+  Document also returns its MD Type. A non-Markdown Document or binary link
+  target returns only Room and Path. An unselected part is absent. Select only
+  what a screen shows: a list that selects the Markdown hears every edit of it.
+- **Change.** `change` is `{ author, time }` of the Document's head revision as
+  the Provider last delivered it: `author` is `{ kind: 'user' | 'site', id, name }`
+  or `null` for a write the Provider made itself, and `time` is the Provider's
+  ISO 8601 change time. It is `null` where the Provider delivered no time, as at
+  a Site. An unsent edit or move keeps it, an unsent creation has none, and a
+  saved write takes the Provider's own once it is Accepted and refreshed. A
+  Room's last change is its Document with the latest `time`.
+- **Order and groups.** `orderBy` sorts by `room`, `path`, `type` or `{ field }`
+  with TanStack DB's own options, and ties end with Room, then Path. `groupBy` by
+  `room`, `type` or `{ field }` answers `{ groups: [{ key, count }] }`, counted
+  over every match and ordered by `count` or a key. `limit` bounds the Documents
+  or the groups.
+- **Results and errors.** A result carries no Room Version: read freshness from
+  Rooms and Sync Status. An invalid query fails with `invalid-query`,
+  `unknown-type`, `unknown-field` or `wrong-kind`, naming where, and never
+  answers an empty result in its place.
+
+## Local Search rules
+
+`search({ text, documents, conversations, limit })` answers once, by words, from
+local state, with MiniSearch at its default configuration. There is no observed
+search.
+
+- **What is found.** A Document by its field values, its sections' headings and
+  text, its preamble and its Path; a message by its text. Frontmatter keys, Room
+  Drafts, chat drafts and growing text are never found. There are no phrases,
+  word forms, typo tolerance or prefix matching.
+- **Narrowing.** `documents` is a Local Query filter: `rooms`, `types`, `where`,
+  `pathPrefix`, `hop` and `backlinks`. `conversations` names conversations. Both
+  apply before `limit`, which bounds each list; without it every hit returns.
+- **Results.** `{ documents, messages }`, each ranked by `score`, which compares
+  hits of one list of one search. A Document hit names its `room`, `path` and
+  `type`, a message hit its `conversation` and `identity`, and `matches` maps each
+  matched word to the parts it matched in: `fields`, `sections`, `preamble` or
+  `path`, or `text`. A hit carries no position; mark the words in the text you
+  show. An invalid filter fails with its Local Query error.
+
+## Room Draft, Save, and outcome rules
+
+The MD Runtime owns one Room Draft per Room and Path, shared by every App and
+tab. It is durable: it survives reload and navigation. A Room that Discovery
+stops listing takes its Room Drafts and its queue with it.
+Write a Room Draft with `roomDraft.write(room, path, revision, parts)`, naming
+the revision you read, or `null` when there was none, and every part it should
+now change: fields, sections and the preamble, or the whole Markdown, a
+creation, a move, or a removal. A part new to the Room Draft names its base,
+the value you showed when it was opened; the MD Runtime keeps a part's first
+base. A binary link target has a Room Draft too, for a move or a removal, with
+`null` as its base. A write or a discard from an older revision is refused as `stale` with
+the current Room Draft; read it and write again.
+
+Save takes one Room and the Room Drafts of it to save, each with its revision,
+validates locally, and on success appends one Change Batch to that Room's
+queue and removes those Room Drafts. It is refused as `stale`, as
+`changed-underneath` naming each part whose base no longer matches the visible
+state, or by a local validation rule, and then creates nothing and leaves every
+Room Draft in place. A directory move or removal is a move or removal part on
+each Document and binary link target beneath it, saved together.
+
+Outcomes follow the Provider's answer. An Accepted Change Batch stays in the
+queue, drawn over the confirmed layer, until the confirmed layer reaches the
+Room Version it was accepted at, and then leaves it. Conflicted and Rejected, an expired operation, and a change that no
+longer applies over the Room each leave the queue and return as Room Drafts on
+the Documents they changed, marked with why: the Provider's structured refusal
+code and fields as returned, not known to have applied, or withdrawn locally.
+The rest of the queue keeps synchronizing, and Sync Status requires attention
+until each returned Room Draft is saved again or discarded. A Change Batch
+keeps no outcome once it leaves the queue; `observe('queue', room)` shows each
+Pending one, and a returned Room Draft says why it returned. Transport
+failure and Provider unavailability keep work Pending and do not infer a
+rejection. A refusal the Provider marks retryable stays Pending until the reset
+it names; the MD Runtime retries the same Change Batch identity and payload and
+never infers an outcome from transport uncertainty. The MD Runtime never
+combines, reorders, or rebases.
+
+`observe('service-mode')` answers the Provider's Service
+Mode, `open` or `write-halted`. While writes are halted, Save still succeeds,
+its Change Batch waits unsent, and the queue is submitted in order once the
+Provider reopens writes. An Action is never held: a write the Provider refuses
+for the halt returns that refusal to its caller. Show the Provider as read-only
+instead of retrying.
 
 ## The neutrality rule
 
@@ -62,15 +191,15 @@ a desktop. Its strings are English only, dates and numbers follow the
 browser locale, and content is never translated. Light and dark themes come
 from CSS custom properties with the browser's preference as the default and
 an App's override respected. What an App Creator's agent adds carries none
-of these promises by itself. Reading and querying never wait for the
-network. Data lives only in the App Creator's browser and with the Provider.
+of these promises by itself. Reading, querying and searching never wait for
+the network. Data lives only in the App Creator's browser and with the Provider.
 
 ## App code imports only the client entry and never constructs a Runtime
 
 App code imports only `@agentshouse/mdruntime/client` and calls
 `connectMdRuntime` on the port the host hands it. It never constructs a
 Runtime. It does not import the package main, the host entry, or the Adapter
-package, and it does not call `createMdRuntime` or `serveMdRuntime`. Hosts
+package, and it does not call `serveMdRuntime`. Hosts
 and tests use those entries; the served App does not.
 
 ## What an agent must never do

package/README.md

@@ -0,0 +1,32 @@
+# `@agentshouse/mdruntime-adapter`
+
+The [Agents House](https://agents.house) Adapter for
+[`@agentshouse/mdruntime`](https://www.npmjs.com/package/@agentshouse/mdruntime):
+it connects a Runtime host to Agents House as its Provider.
+
+## Install
+
+```sh
+npm install @agentshouse/mdruntime-adapter @agentshouse/mdruntime
+```
+
+## Usage
+
+A Runtime host creates the Adapter and passes it to the Runtime:
+
+```ts
+import { serveMdRuntime } from '@agentshouse/mdruntime/host';
+import { createAgentsHouseAdapter } from '@agentshouse/mdruntime-adapter';
+
+const adapter = createAgentsHouseAdapter({ transport, authorize });
+const host = serveMdRuntime({ adapter, shell, requiredGuarantees: [] });
+host.attach(port, 'my-app');
+```
+
+App code never imports this package; it reaches the Runtime only through
+`@agentshouse/mdruntime/client`. The rules an App's agent follows are in the
+package's `AGENTS.md`.
+
+## License
+
+MIT

package/dist/actions.d.ts

@@ -1,16 +1,8 @@
-import { type ActionDeclaration, type ActionRequest, type ActionResult, type ConversationCards } from '@agentshouse/mdruntime';
-import type { HouseDoor, HouseDoorAnswer, HouseTransport } from './transport.js';
-export declare const CONVERSATION_ACTIONS: readonly ['conversation.create', 'conversation.send', 'conversation.answer', 'conversation.interrupt', 'conversation.kill', 'conversation.cancel', 'conversation.delete', 'conversation.history'];
-export declare const HOUSE_ACTS: readonly ['conversations/interaction/read', 'conversations/originals/read', 'apps/read', 'apps/customize', 'rooms/read', 'rooms/access/read', 'rooms/access/invitations', 'rooms/access/entries', 'rooms/access/invite', 'rooms/access/invitation-cancel', 'rooms/access/revoke', 'rooms/access/leave', 'rooms/roles/define', 'rooms/roles/remove', 'rooms/roles/assign', 'rooms/roles/unassign', 'rooms/settings/processing/read', 'rooms/settings/processing/write', 'profiles/create', 'profiles/read', 'profiles/edit', 'profiles/duplicate', 'profiles/delegate', 'agents/create', 'agents/read', 'routines/requests', 'routines/access', 'routines/owned', 'routines/granted', 'routines/grant', 'routines/send', 'routines/cancel', 'routines/start', 'routines/schedules', 'routines/schedules/create', 'routines/schedules/enabled', 'account/security/read', 'storage/inventory', 'storage/usage', 'usage/statement', 'storage/blob-store', 'storage/blob-store/select', 'storage/connections', 'storage/archive', 'storage/archive/status', 'environments/read', 'environments/create', 'environments/start', 'environments/stop', 'environments/delete', 'environments/renewals/read', 'environments/work/read', 'nodes/read'];
-export declare const HOUSE_PROVIDER_ACTIONS: readonly ["conversation.create", "conversation.send", "conversation.answer", "conversation.interrupt", "conversation.kill", "conversation.cancel", "conversation.delete", "conversation.history", "conversations/interaction/read", "conversations/originals/read", "apps/read", "apps/customize", "rooms/read", "rooms/access/read", "rooms/access/invitations", "rooms/access/entries", "rooms/access/invite", "rooms/access/invitation-cancel", "rooms/access/revoke", "rooms/access/leave", "rooms/roles/define", "rooms/roles/remove", "rooms/roles/assign", "rooms/roles/unassign", "rooms/settings/processing/read", "rooms/settings/processing/write", "profiles/create", "profiles/read", "profiles/edit", "profiles/duplicate", "profiles/delegate", "agents/create", "agents/read", "routines/requests", "routines/access", "routines/owned", "routines/granted", "routines/grant", "routines/send", "routines/cancel", "routines/start", "routines/schedules", "routines/schedules/create", "routines/schedules/enabled", "account/security/read", "storage/inventory", "storage/usage", "usage/statement", "storage/blob-store", "storage/blob-store/select", "storage/connections", "storage/archive", "storage/archive/status", "environments/read", "environments/create", "environments/start", "environments/stop", "environments/delete", "environments/renewals/read", "environments/work/read", "nodes/read"];
-export declare const HISTORY_PAGE = 100;
+import { type AcceptedMessage, type ActionDeclaration, type ActionRequest, type ActionResult, type ConversationCards } from '@agentshouse/mdruntime';
+import type { HouseDoorAnswer, HouseTransport } from './transport.js';
 export declare const HOUSE_CONVERSATION_CARDS: ConversationCards;
-export declare function declaredActions(): readonly ActionDeclaration[];
+export declare function declaredActions(routes: readonly string[]): readonly ActionDeclaration[];
 export declare function houseAction(transport: HouseTransport, request: ActionRequest): Promise<ActionResult>;
 export declare function actionOutcome(answer: HouseDoorAnswer, name: string): ActionResult;
-export declare function readConversationHistory(transport: HouseDoor, conversationId: string): Promise<{
-    messages: unknown[];
-} | {
-    outcome: ActionResult;
-}>;
+export declare function acceptedMessage(entry: unknown): AcceptedMessage | null;
 //# sourceMappingURL=actions.d.ts.map

package/dist/actions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../src/actions.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,KAAK,iBAAiB,EACtB,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,iBAAiB,EACvB,MAAM,wBAAwB,CAAC;AAGhC,OAAO,KAAK,EAAE,SAAS,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAEjF,eAAO,MAAM,oBAAoB,YAC/B,qBAAqB,EACrB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,EACxB,mBAAmB,EACnB,qBAAqB,EACrB,qBAAqB,EACrB,sBAAsB,CACd,CAAC;AAEX,eAAO,MAAM,UAAU,YACrB,gCAAgC,EAChC,8BAA8B,EAC9B,WAAW,EACX,gBAAgB,EAChB,YAAY,EACZ,mBAAmB,EACnB,0BAA0B,EAC1B,sBAAsB,EACtB,qBAAqB,EACrB,gCAAgC,EAChC,qBAAqB,EACrB,oBAAoB,EACpB,oBAAoB,EACpB,oBAAoB,EACpB,oBAAoB,EACpB,sBAAsB,EACtB,gCAAgC,EAChC,iCAAiC,EACjC,iBAAiB,EACjB,eAAe,EACf,eAAe,EACf,oBAAoB,EACpB,mBAAmB,EACnB,eAAe,EACf,aAAa,EACb,mBAAmB,EACnB,iBAAiB,EACjB,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,EAChB,eAAe,EACf,iBAAiB,EACjB,gBAAgB,EAChB,oBAAoB,EACpB,2BAA2B,EAC3B,4BAA4B,EAC5B,uBAAuB,EACvB,mBAAmB,EACnB,eAAe,EACf,iBAAiB,EACjB,oBAAoB,EACpB,2BAA2B,EAC3B,qBAAqB,EACrB,iBAAiB,EACjB,wBAAwB,EACxB,mBAAmB,EACnB,qBAAqB,EACrB,oBAAoB,EACpB,mBAAmB,EACnB,qBAAqB,EACrB,4BAA4B,EAC5B,wBAAwB,EACxB,YAAY,CACJ,CAAC;AAEX,eAAO,MAAM,sBAAsB,o2CAAoD,CAAC;AAIxF,eAAO,MAAM,YAAY,MAAM,CAAC;AAiBhC,eAAO,MAAM,wBAAwB,EAAE,iBAKtC,CAAC;AAEF,wBAAgB,eAAe,IAAI,SAAS,iBAAiB,EAAE,CAM9D;AAED,wBAAgB,WAAW,CACzB,SAAS,EAAE,cAAc,EACzB,OAAO,EAAE,aAAa,GACrB,OAAO,CAAC,YAAY,CAAC,CAWvB;AA4DD,wBAAgB,aAAa,CAAC,MAAM,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM,GAAG,YAAY,CASjF;AA6ID,wBAAsB,uBAAuB,CAC3C,SAAS,EAAE,SAAS,EACpB,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC;IAAE,QAAQ,EAAE,OAAO,EAAE,CAAA;CAAE,GAAG;IAAE,OAAO,EAAE,YAAY,CAAA;CAAE,CAAC,CA4B9D"}
+{"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,iBAAiB,EAGvB,MAAM,wBAAwB,CAAC;AAGhC,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAkBtE,eAAO,MAAM,wBAAwB,EAAE,iBAKtC,CAAC;AAEF,wBAAgB,eAAe,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,iBAAiB,EAAE,CASvF;AAED,wBAAgB,WAAW,CACzB,SAAS,EAAE,cAAc,EACzB,OAAO,EAAE,aAAa,GACrB,OAAO,CAAC,YAAY,CAAC,CAQvB;AA4DD,wBAAgB,aAAa,CAAC,MAAM,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM,GAAG,YAAY,CAWjF;AAuLD,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,eAAe,GAAG,IAAI,CAUtE"}