@agentshouse/app-bridge 0.1.0-ce3c71da46f00 → 0.1.0-cf2e2ca943fbc

package/dist/client/src/bridge.d.ts

@@ -1,5 +1,6 @@
 import type { MdRuntimeClient } from '@agentshouse/mdruntime/client';
-import type { HouseAppMessage, HouseExternalAnswer, HouseExternalRequest, HouseBridgePort, HouseGaChoice, HouseRefusal, HouseSourceDownload, HouseSourceTop, HouseStatus, HouseTab } from './wire.js';
+import type { HouseAppMessage, HouseExternalAnswer, HouseExternalRequest, HouseBridgePort, HouseGaChoice, HouseImageCopy, HouseInstallation, HouseNotifications, HouseRefusal, HouseSourceDownload, HouseSourceTop, HouseStatus, HouseTab } from './wire.js';
+export type { HouseImageCopy } from './wire.js';
 export declare class HouseCeremonyRefused extends Error {
     readonly path: string | null;
     constructor(path: string | null);
@@ -8,14 +9,6 @@ export declare class HouseNavigationRefused extends Error {
     readonly address: string | null;
     constructor(address: string | null);
 }
-export interface HouseImageCopy {
-    readonly attachment: string;
-    readonly copy: string;
-    readonly name: string;
-    readonly media_type: string;
-}
-type HouseInstallation = 'accepted' | 'dismissed' | 'manual';
-type HouseNotifications = 'on' | 'off' | 'blocked' | 'unavailable';
 export interface HouseBridgeSource {
     readonly port: Promise<HouseBridgePort>;
     readonly runtime: Promise<MdRuntimeClient>;
@@ -43,4 +36,3 @@ export interface HouseBridge {
     gaConsent(choice: HouseGaChoice): void;
 }
 export declare function connectHouseBridge(source?: HouseBridgeSource): HouseBridge;
-export {};

package/dist/client/src/bridge.js

@@ -14,19 +14,45 @@ export class HouseNavigationRefused extends Error {
         this.address = address;
     }
 }
-function answered(pending, answer, value) {
-    if (typeof answer.id !== 'number')
-        return;
+function pendingAnswer(pending, answer) {
     const asked = pending.get(answer.id);
     if (asked === undefined)
-        return;
+        return null;
     pending.delete(answer.id);
-    if (answer.refused === true)
+    if (answer.refused === true) {
         asked.reject(new HouseCeremonyRefused(null));
-    else if (answer.refusal !== undefined)
+        return null;
+    }
+    if (answer.refusal !== undefined) {
         asked.reject(new DOMException(answer.refusal.message, answer.refusal.name));
-    else
-        asked.resolve(value);
+        return null;
+    }
+    return asked;
+}
+const FRAME_HOUSES = [
+    'runtime',
+    'status',
+    'screenshot',
+    'address',
+    'ceremony-refused',
+    'navigate-refused',
+    'attachment',
+    'source',
+    'external-call',
+    'install',
+    'notifications',
+    'badge',
+    'app-message',
+];
+function frameMessage(value) {
+    if (value === null || typeof value !== 'object')
+        return null;
+    const message = value;
+    if (typeof message.house !== 'string')
+        return null;
+    if (!FRAME_HOUSES.includes(message.house))
+        return null;
+    return value;
 }
 function settled() {
     let settle = null;
@@ -72,8 +98,8 @@ export function connectHouseBridge(source = heldBridge()) {
             held.postMessage(message);
     }
     function receive(event) {
-        const data = event.data;
-        if (data === null || typeof data !== 'object')
+        const data = frameMessage(event.data);
+        if (data === null)
             return;
         if (data.house === 'status') {
             status = data.status;
@@ -104,61 +130,59 @@ export function connectHouseBridge(source = heldBridge()) {
             return;
         }
         if (data.house === 'attachment') {
-            const answer = data;
-            if (typeof answer.id !== 'number')
+            if (typeof data.id !== 'number')
                 return;
-            const pending = attachments.get(answer.id);
+            const pending = attachments.get(data.id);
             if (pending === undefined)
                 return;
-            attachments.delete(answer.id);
-            pending.resolve(answer.image ?? null);
+            attachments.delete(data.id);
+            pending.resolve(data.image ?? null);
             return;
         }
         if (data.house === 'install') {
-            const answer = data;
-            answered(installations, answer, answer.outcome);
+            const pending = pendingAnswer(installations, data);
+            if (pending !== null && 'outcome' in data)
+                pending.resolve(data.outcome);
             return;
         }
         if (data.house === 'notifications') {
-            const answer = data;
-            answered(notifications, answer, answer.state);
+            const pending = pendingAnswer(notifications, data);
+            if (pending !== null && 'state' in data)
+                pending.resolve(data.state);
             return;
         }
         if (data.house === 'badge') {
-            answered(badges, data, undefined);
+            pendingAnswer(badges, data)?.resolve();
             return;
         }
         if (data.house === 'source') {
-            const answer = data;
-            if (typeof answer.id !== 'number')
+            if (typeof data.id !== 'number')
                 return;
-            const pending = sources.get(answer.id);
+            const pending = sources.get(data.id);
             if (pending === undefined)
                 return;
-            sources.delete(answer.id);
-            pending.resolve(answer.answer ?? null);
+            sources.delete(data.id);
+            pending.resolve(data.answer ?? null);
             return;
         }
         if (data.house === 'external-call') {
-            const answer = data;
-            if (typeof answer.id !== 'number')
+            if (typeof data.id !== 'number')
                 return;
-            const pending = externals.get(answer.id);
+            const pending = externals.get(data.id);
             if (pending === undefined)
                 return;
-            externals.delete(answer.id);
-            pending.resolve(answer.answer ?? null);
+            externals.delete(data.id);
+            pending.resolve(data.answer ?? null);
             return;
         }
         if (data.house === 'screenshot') {
-            const answer = data;
-            if (typeof answer.id !== 'number')
+            if (typeof data.id !== 'number')
                 return;
-            const pending = screenshots.get(answer.id);
+            const pending = screenshots.get(data.id);
             if (pending === undefined)
                 return;
-            screenshots.delete(answer.id);
-            pending.resolve(answer.image ?? null);
+            screenshots.delete(data.id);
+            pending.resolve(data.image ?? null);
             return;
         }
         if (data.house === 'ceremony-refused') {
@@ -189,7 +213,10 @@ export function connectHouseBridge(source = heldBridge()) {
         const pending = settled();
         const id = ++nextScreenshot;
         screenshots.set(id, pending.settle);
-        send({ house, id, ...asked });
+        if (house === 'screenshot-read' && 'app' in asked)
+            send({ house, id, app: asked.app });
+        if (house === 'site-screenshot-read' && 'site' in asked)
+            send({ house, id, site: asked.site });
         return pending.promise;
     }
     function navigate(mode, asked) {

package/dist/client/src/wire.d.ts

@@ -3,7 +3,7 @@ export interface HouseBridgeEvent {
     readonly data: unknown;
 }
 export interface HouseBridgePort {
-    postMessage(message: unknown): void;
+    postMessage(message: HouseFrameRequest): void;
     addEventListener(type: 'message', listener: (event: HouseBridgeEvent) => void): void;
     start(): void;
 }
@@ -21,7 +21,11 @@ export interface HouseGa {
     readonly choice: HouseGaChoice | null;
 }
 export interface HouseStatus {
-    readonly app: string;
+    readonly app: string | null;
+    readonly preferences: {
+        readonly room_ref: string;
+        readonly path: string;
+    } | null;
     readonly runtime: string;
     readonly credential: HouseCredentialState;
     readonly sync: HouseSyncState | null;
@@ -31,6 +35,7 @@ export interface HouseStatus {
     readonly loss: string | null;
     readonly ga: HouseGa;
     readonly service_mode: 'open' | 'write-halted' | null;
+    readonly offline: boolean;
 }
 export type HouseNavigationMode = 'push' | 'replace';
 interface HouseRelease {
@@ -83,5 +88,128 @@ export interface HouseAppMessage {
     readonly from: string;
     readonly body: unknown;
 }
+export type HouseInstallation = 'accepted' | 'dismissed' | 'manual';
+export type HouseNotifications = 'on' | 'off' | 'blocked' | 'unavailable';
+export interface HouseImageCopy {
+    readonly attachment: string;
+    readonly copy: string;
+    readonly name: string;
+    readonly media_type: string;
+}
+export interface HouseFrameRefusal {
+    readonly name: string;
+    readonly message: string;
+}
+export type HouseFrameRequest = {
+    readonly house: 'navigate';
+    readonly mode: HouseNavigationMode;
+    readonly address: string;
+} | ({
+    readonly house: 'tab';
+} & HouseTab) | {
+    readonly house: 'ceremony';
+    readonly path: string;
+} | {
+    readonly house: 'install';
+    readonly id: number;
+} | {
+    readonly house: 'notifications';
+    readonly id: number;
+    readonly on?: boolean;
+} | {
+    readonly house: 'badge';
+    readonly id: number;
+    readonly unread: readonly string[];
+} | {
+    readonly house: 'attachment-read';
+    readonly id: number;
+    readonly room: string;
+    readonly attachment: string;
+} | {
+    readonly house: 'source-top' | 'source-download';
+    readonly id: number;
+    readonly app: string;
+    readonly release?: string;
+} | {
+    readonly house: 'external-call';
+    readonly id: number;
+    readonly request: HouseExternalRequest;
+} | {
+    readonly house: 'screenshot-read';
+    readonly id: number;
+    readonly app: string;
+} | {
+    readonly house: 'site-screenshot-read';
+    readonly id: number;
+    readonly site: string;
+} | {
+    readonly house: 'ga/consent';
+    readonly choice: HouseGaChoice;
+};
+export type HouseInstallAnswer = {
+    readonly outcome: HouseInstallation;
+} | {
+    readonly refusal: HouseFrameRefusal;
+};
+export type HouseNotificationAnswer = {
+    readonly refused: true;
+} | {
+    readonly refusal: HouseFrameRefusal;
+} | {
+    readonly state: HouseNotifications;
+};
+export type HouseBadgeAnswer = {
+    readonly refused: true;
+} | {
+    readonly refusal: HouseFrameRefusal;
+} | {
+    readonly refused?: never;
+    readonly refusal?: never;
+};
+export type HouseFrameMessage = {
+    readonly house: 'runtime';
+} | {
+    readonly house: 'status';
+    readonly status: HouseStatus;
+} | {
+    readonly house: 'screenshot';
+    readonly id: number;
+    readonly image: Blob | null;
+} | {
+    readonly house: 'address';
+    readonly address: string;
+    readonly navigated: boolean;
+} | {
+    readonly house: 'ceremony-refused';
+    readonly path: string | null;
+} | {
+    readonly house: 'navigate-refused';
+    readonly address: string | null;
+} | {
+    readonly house: 'attachment';
+    readonly id: number;
+    readonly image: HouseImageCopy | null;
+} | {
+    readonly house: 'source';
+    readonly id: number;
+    readonly answer: HouseSourceTop | HouseSourceDownload | HouseRefusal | null;
+} | {
+    readonly house: 'external-call';
+    readonly id: number;
+    readonly answer: HouseExternalAnswer | HouseRefusal | null;
+} | ({
+    readonly house: 'install';
+    readonly id: number;
+} & HouseInstallAnswer) | ({
+    readonly house: 'notifications';
+    readonly id: number;
+} & HouseNotificationAnswer) | ({
+    readonly house: 'badge';
+    readonly id: number;
+} & HouseBadgeAnswer) | {
+    readonly house: 'app-message';
+    readonly from: string;
+    readonly body: unknown;
+};
 export declare const HOUSE_ADDRESS_MAX_CHARS = 1000;
 export {};

package/docs/families.md

@@ -32,7 +32,9 @@
   click. `setBadge(unread)` takes the identifiers of the Human Notifications
   unread in this storage and sets the icon's badge to their number, or clears
   it at none, where the browser shows one.
-- **Status** - the App reference the runtime client is attached under, sync
+- **Status** - the App reference the runtime client is attached under,
+  `preferences`: the `room_ref` and Path of the App's own preferences document,
+  or `null` until the runtime holds that Room, sync
   state, credential state and observed failure, `ga`:
   whether the page measures and the visitor's stored analytics choice, and
   `service_mode`: `open`, `write-halted` while House refuses writes, so the

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agentshouse/app-bridge",
-  "version": "0.1.0-ce3c71da46f00",
+  "version": "0.1.0-cf2e2ca943fbc",
   "description": "Renderer-side client of the agents.house App bridge: 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 in-page test host.",
   "license": "MIT",
   "type": "module",
@@ -19,7 +19,7 @@
     }
   },
   "dependencies": {
-    "@agentshouse/mdruntime": "0.1.0-c30ed2b8e04d5"
+    "@agentshouse/mdruntime": "0.1.0-cacb4c3f6734e"
   },
   "files": [
     "dist",