@agentshouse/app-bridge 0.1.0-ccf413b4e709d → 0.1.0-cd2d3edbf9805

package/dist/test-host.d.ts

@@ -1,11 +1,17 @@
-import type { MdRuntimeClient } from '@agentshouse/mdruntime/client';
-import type { HouseAnalyticsChoice, HouseAppMessage, HouseExternalAnswer, HouseExternalRequest, HouseNavigationMode, HouseRefusal, HouseSourceDownload, HouseSourceTop, HouseStatus, HouseTab } from './index.js';
+import type { MdRuntimeClient } from './mdruntime/client.js';
+import type { HouseAnalyticsChoice, HouseAppMessage, HouseChatOptions, HouseExternalAnswer, HouseExternalRequest, HouseNavigationMode, HouseRefusal, HouseSourceDownload, HouseSourceTop, HouseStatus, HouseTab } from './index.js';
 export interface HouseBridgeNavigation {
     readonly mode: HouseNavigationMode;
     readonly address: string;
 }
+export interface HouseBridgeChat {
+    readonly element: object;
+    readonly options: HouseChatOptions;
+    readonly mounted: boolean;
+}
 export interface HouseBridgeTestHost {
     readonly navigations: readonly HouseBridgeNavigation[];
+    readonly chats: readonly HouseBridgeChat[];
     readonly ceremonies: readonly string[];
     readonly consents: readonly HouseAnalyticsChoice[];
     readonly tabs: readonly HouseTab[];

package/dist/test-host.js

@@ -1,5 +1,5 @@
 const HOST_ORIGIN = 'https://house.invalid';
-const ADDRESS_MAX_CHARS = 1000;
+const ADDRESS_MAX_CHARS = 64 * 1024;
 function sameOriginPath(value) {
     if (typeof value !== 'string')
         return null;
@@ -29,12 +29,28 @@ function navigationRefused(address) {
         address,
     });
 }
+function followHeld(listeners, listener, held) {
+    let following = true;
+    queueMicrotask(() => {
+        if (!following)
+            return;
+        listeners.add(listener);
+        const value = held();
+        if (value !== null)
+            listener(value);
+    });
+    return () => {
+        following = false;
+        listeners.delete(listener);
+    };
+}
 export function createHouseBridgeTestHost(options = {}) {
     const navigations = [];
     const ceremonies = [];
     const consents = [];
     const tabs = [];
     const externalCalls = [];
+    const chats = [];
     const addressListeners = new Set();
     const statusListeners = new Set();
     const messageListeners = new Set();
@@ -63,7 +79,17 @@ export function createHouseBridgeTestHost(options = {}) {
         });
     }
     function navigate(mode, asked) {
-        const target = sameOriginPath(asked);
+        let path = asked;
+        if (/^https?:\/\//i.test(asked)) {
+            try {
+                const target = new URL(asked);
+                path = target.origin === HOST_ORIGIN ? target.pathname + target.search + target.hash : '';
+            }
+            catch {
+                path = '';
+            }
+        }
+        const target = sameOriginPath(path);
         if (target === null)
             return Promise.reject(navigationRefused(asked));
         navigations.push({ mode, address: target });
@@ -73,13 +99,24 @@ export function createHouseBridgeTestHost(options = {}) {
         });
     }
     const bridge = {
-        runtime,
+        runtime: runtime,
+        chat: {
+            mount(element, options = {}) {
+                const chat = { element, options, mounted: true };
+                chats.push(chat);
+                return Promise.resolve({
+                    update(next) {
+                        chat.options = next;
+                    },
+                    unmount() {
+                        chat.mounted = false;
+                    },
+                });
+            },
+        },
         address: () => shown,
         onAddress(listener) {
-            addressListeners.add(listener);
-            return () => {
-                addressListeners.delete(listener);
-            };
+            return followHeld(addressListeners, listener, () => shown);
         },
         push: (asked) => navigate('push', asked),
         replace: (asked) => navigate('replace', asked),
@@ -106,10 +143,7 @@ export function createHouseBridgeTestHost(options = {}) {
         readSiteScreenshot: (site) => Promise.resolve(options.siteScreenshots?.[site] ?? null),
         status: () => seen,
         onStatus(listener) {
-            statusListeners.add(listener);
-            return () => {
-                statusListeners.delete(listener);
-            };
+            return followHeld(statusListeners, listener, () => seen);
         },
         messages(listener) {
             messageListeners.add(listener);
@@ -125,6 +159,7 @@ export function createHouseBridgeTestHost(options = {}) {
             consents.push(choice);
             publish({ ...published, analytics: { measures: true, choice } });
         },
+        cooperate: () => () => { },
     };
     Object.defineProperty(globalThis, 'houseBridge', { value: bridge, configurable: true });
     if (published !== null)
@@ -132,6 +167,7 @@ export function createHouseBridgeTestHost(options = {}) {
     arrive(current);
     return {
         navigations,
+        chats,
         ceremonies,
         consents,
         tabs,

package/docs/families.md

@@ -12,7 +12,8 @@
   purpose-bound authenticated pages. The shell navigates only to a same-origin
   absolute path, carries its current address as the return target, and the page
   returns there when it completes. An App names an address House gave it in a
-  reading and composes none.
+  reading and composes one only for `/bind/<app_ref>`, where the User binds
+  its Rooms, with `?slot=<name>` to open at one slot.
 - **Installation** - `install()` offers the page as a Home-screen app. Where the
   browser has an install prompt ready the shell shows it and the call resolves
   `'accepted'` or `'dismissed'` with the User's choice, spending that prompt;
@@ -39,12 +40,27 @@
   whether the page measures and the visitor's stored analytics choice, and
   `serviceMode`: `open`, `write-halted` while House refuses writes, so the
   App can stop retrying them, or `null` while the runtime holds no House
-  connection. Every status field is camelCase.
+  connection. Every status field is camelCase. `onStatus(listener)` and
+  `onAddress(listener)` hand a listener the status and the address the bridge
+  already holds, then each change.
   The App reports the visitor's choice with `analyticsConsent('accept')` or
   `analyticsConsent('decline')`; the shell hands it to House's analytics loader, and
   the choice never reaches House.
-- **Site image read** - given a Published Room and an original attachment
-  reference, it answers the web copy's path and metadata, or `null` when no
+- **Releases and builds** - an open App keeps the release it loaded: a newer
+  release, or a newer House build, takes effect at the App's next load, offline
+  too once the browser stored it. When one tab loads a newer House build, the
+  other House tabs reload into it; Room Drafts, chat drafts and unsent changes
+  survive the reload.
+- **A runtime that ends** - when the browser ends House's runtime under an open
+  App, the App keeps running, its `runtime` client and observations included:
+  each observation goes on with the next runtime's values, and the status and
+  the address arrive again. A runtime that ended before answering has its reads
+  answered by the next one; since it may have applied any other call, an act on
+  House is answered the outcome `transport-uncertainty`, and every other call,
+  a Save or a draft write among them, fails with the retryable code
+  `transport-uncertainty`.
+- **Site image read** - given a Published Room and the Path of one of its
+  binary entries, it answers the web copy's path and metadata, or `null` when no
   copy exists. The original bytes never cross this bridge at a Site.
 - **App release code** - `sourceTop(app, release)` answers the top level of
   the latest successful release of an App the User may use: its folders, its
@@ -56,21 +72,21 @@
   refusal is House's `{ error: { code, retryable } }`, `app_release_not_found` for an
   App with no release; a read House does not answer, or one that outlived
   the browser's signed-in User, is `null`.
-- **External calls** - `callExternal({ url, method, headers, body, slot })`
+- **External calls** - `callExternal({ url, method, headers, body, room_ref })`
   has House's server send an HTTPS request to one of the release's declared
   external origins and resolves with the service's `status`, `headers` and its
   body as `body` text or `body_base64`, or a refusal as House's
   `{ error: { code, retryable } }`, or `null` when House does not answer. House fills in the
-  App and its running release; naming an account slot places the key of the
-  account the User connected to it, which the App never sees, and naming none
-  sends no key. A Site's call names no slot, and the House panel names an
-  `account` instead. `body_base64` replaces `body` for bytes.
+  App and its running release. A `room_ref` names a Room the signed-in User binds to the App
+  in a `write` slot, and House adds that Room's Service key for the URL's origin, which App
+  code never sees; a call naming no Room carries no key, and a Site's call names no Room.
+  `body_base64` replaces `body` for bytes.
 - **App messages** - `messages(listener)` hands the listener each message
   another holder of this App sends to this User's running copies, as `from`,
   the sender's User id, and `body`, the JSON value they sent, until the
   function it returns is called. App code sends one through the Runtime's
   `call('message.send', { to, body })` with the recipient's User id and
-  a body of at most 32 KiB of JSON; House fills in the App and relays it only
+  a body of at most 32 kB of JSON; House fills in the App and relays it only
   to copies running now, storing nothing. The panel sends none.
 - **App screenshot read** - given an App reference, `readScreenshot(app)`
   answers the image this browser captured of that App's screen the first time
@@ -82,6 +98,30 @@
   after its latest release, as a JPEG `Blob`, or `null` when House holds none
   or does not answer. A Site's own renderer reads none.
 
+- **Chat** - `chat.mount(element, options)` places House's Chat, the one chat
+  in which the User's Agent conversations show, in `element` over the page's
+  `runtime` client, and resolves to a handle: `update(options)` replaces its
+  options and `unmount()` removes it. House serves the Chat with the page and
+  keeps it current, so the App installs and bundles nothing for it. The
+  options: `conversation` opens one, `null` for a new chat, `agent` is the
+  Agent a new chat goes to, `showChats` adds its conversation list, `width` is
+  `full`, the element, or `3/4`, `1/2` or `1/3` of the window docked at its
+  right edge, `onOpen` hears each conversation it opens as
+  `{ conversation, agent }`, and `onLink` takes a link without a scheme in
+  place of the browser. CSS custom properties named `--chat-*` on the element
+  or an ancestor set its look. It shows conversations only to a release that
+  declares them. A Site and the House panel have none: their call rejects with
+  an error named and coded `NotSupportedError`, with `retryable` false.
+
+- **First place** - `cooperate({ placed })` tells House when the page has
+  drawn the place it opened on; the function it returns withdraws it. Register
+  it in the entry script, before the first draw. `placed()` resolves once the
+  page has drawn that place with what it shows: House keeps its
+  first-preparation surface over a page registered by its first draw until
+  then, and lifts it at the first draw of a page that registered none, so the
+  User goes from the surface to a drawn place in one change. House asks the
+  page for nothing else.
+
 ## The test host
 
 `createHouseBridgeTestHost(options)` plays House in one page: it installs a
@@ -102,6 +142,9 @@ records in `tabs` each `setTab`, answers a release code read from the
 by App reference and `readSiteScreenshot` from the `siteScreenshots` it was
 given by Site identifier, answers every `install()` `'manual'`, as a browser
 with no install prompt does, answers every `notifications()` `'unavailable'`,
-as a browser without push does, settles every `setBadge`, delivers each App
+as a browser without push does, settles every `setBadge`, records in `chats`
+each Chat `chat.mount` places, with its `element`, the `options` it was last
+given and whether it is still `mounted`, drawing nothing, delivers each App
 message `message({ from, body })` plays, and hands `bridge.runtime` the MD
-Runtime client `attachRuntime(client)` gives it.
+Runtime client `attachRuntime(client)` gives it. It takes a `cooperate` and
+never calls `placed()`.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@agentshouse/app-bridge",
-  "version": "0.1.0-ccf413b4e709d",
-  "description": "Types of the agents.house App bridge House hands every App: navigation, the tab title and icon, ceremonies, installation, notifications and the icon badge, status, Site image reads, App release code, App and Site screenshot reads, and App messages, with an accessor and an in-page test host.",
+  "version": "0.1.0-cd2d3edbf9805",
+  "description": "Types of the agents.house App bridge House hands every App: navigation, the tab title and icon, ceremonies, installation, notifications and the icon badge, status, Site image reads, App release code, App and Site screenshot reads, App messages and the Chat, with an accessor and an in-page test host.",
   "license": "MIT",
   "type": "module",
   "sideEffects": false,
@@ -18,13 +18,15 @@
       "default": "./dist/test-host.js"
     }
   },
-  "dependencies": {
-    "@agentshouse/mdruntime": "0.1.0-c2aaa9c0e3ca4"
-  },
   "files": [
     "dist",
     "docs",
     "README.md",
     "LICENSE"
-  ]
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/agentshouse/core.git",
+    "directory": "client"
+  }
 }