@agentshouse/app-bridge 0.1.0-ca4ec913df08d → 0.1.0-ca559eade7c19

package/README.md

@@ -41,7 +41,9 @@ async function manageSecurity(securityPath) {
 ```
 
 `bridge.runtime` resolves to the `MdRuntimeClient` of
-`@agentshouse/mdruntime/client`, whose README describes its members.
+`@agentshouse/mdruntime/client`, whose README describes its members. Its
+`call(name, input)` reaches House: `HouseCalls` names each Call an App makes
+and the input it takes, such as `call('member.list', { room_ref })`.
 
 ## Test without a House
 

package/dist/calls.d.ts

@@ -0,0 +1,118 @@
+export interface HouseCalls {
+    readonly 'access.read': {
+        readonly room_ref: string;
+        readonly statistics?: boolean;
+    };
+    readonly 'conversation.answer': {
+        readonly answer: {
+            readonly interaction_id: string;
+            readonly response: unknown;
+        };
+        readonly conversation: string;
+        readonly operation_id?: string;
+    };
+    readonly 'conversation.create': {
+        readonly agent_id: string;
+        readonly operation_id?: string;
+    };
+    readonly 'conversation.delete': {
+        readonly conversation: string;
+        readonly operation_id?: string;
+    };
+    readonly 'conversation.history': {
+        readonly conversations: readonly {
+            readonly after?: string;
+            readonly conversation: string;
+        }[];
+    };
+    readonly 'conversation.interrupt': {
+        readonly conversation: string;
+        readonly operation_id?: string;
+    };
+    readonly 'conversation.kill': {
+        readonly conversation: string;
+        readonly operation_id?: string;
+    };
+    readonly 'conversation.markDone': {
+        readonly conversation_id?: string;
+        readonly result?: string;
+        readonly operation_id: string;
+    };
+    readonly 'conversation.rename': {
+        readonly conversation_id: string;
+        readonly operation_id: string;
+        readonly name: string;
+    };
+    readonly 'conversation.send': {
+        readonly conversation: string;
+        readonly files?: readonly {
+            readonly blob: Blob;
+            readonly byteLength: number;
+            readonly contentHash: string;
+            readonly height?: number;
+            readonly mediaType: string;
+            readonly name: string;
+            readonly width?: number;
+        }[];
+        readonly operation_id: string;
+        readonly text?: string;
+    };
+    readonly 'conversation.setOption': {
+        readonly conversation_id: string;
+        readonly operation_id: string;
+        readonly option: string;
+        readonly value: string | boolean;
+    };
+    readonly 'feature.list': Readonly<Record<string, never>>;
+    readonly 'holder.list': Readonly<Record<string, never>>;
+    readonly 'holder.ring': {
+        readonly to: string;
+    };
+    readonly 'member.list': {
+        readonly room_ref: string;
+        readonly history?: boolean;
+        readonly limit?: number;
+        readonly cursor?: string;
+    };
+    readonly 'message.send': {
+        readonly to: string;
+        readonly body: unknown;
+    };
+    readonly 'processing.read': {
+        readonly room_ref: string;
+        readonly path: string;
+    };
+    readonly 'record.list': {
+        readonly room_ref: string;
+        readonly record?: string;
+        readonly cursor?: string;
+        readonly limit?: number;
+        readonly order?: 'asc' | 'desc';
+    };
+    readonly 'relay.read': Readonly<Record<string, never>>;
+    readonly 'routine.list': {
+        readonly room_ref: string;
+    };
+    readonly 'routineAccess.list': {
+        readonly room_ref: string;
+    };
+    readonly 'routineAllowance.list': {
+        readonly room_ref: string;
+        readonly access: string;
+    };
+    readonly 'routineRequest.list': {
+        readonly room_ref: string;
+    };
+    readonly 'storage.read': {
+        readonly room_ref?: string;
+    };
+    readonly submit: {
+        readonly content: string;
+    };
+    readonly 'trigger.list': {
+        readonly room_ref: string;
+    };
+    readonly 'triggerOccurrence.list': {
+        readonly room_ref: string;
+    };
+}

package/dist/calls.js

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -1,16 +1,22 @@
-import type { MdRuntimeClient } from '@agentshouse/mdruntime/client';
+import type { MdRuntimeClient, Open } from './mdruntime/client.js';
+import type { HouseCalls } from './calls.js';
+export type { HouseCalls } from './calls.js';
+export type HouseCallInput<Name extends string> = Name extends keyof HouseCalls ? HouseCalls[Name] : unknown;
+export interface HouseRuntime extends Omit<MdRuntimeClient, 'call'> {
+    call<Name extends Open<keyof HouseCalls>>(name: Name, input: HouseCallInput<Name>): ReturnType<MdRuntimeClient['call']>;
+}
 export interface HouseSyncState {
     readonly state: string;
     readonly providerUnreachable: boolean;
 }
 export interface HouseCredentialState {
-    readonly state: 'none' | 'held' | 'rejected';
+    readonly state: Open<'none' | 'held' | 'rejected'>;
     readonly expiresAt: number | null;
 }
 export type HouseAnalyticsChoice = 'accept' | 'decline';
 export interface HouseAnalytics {
     readonly measures: boolean;
-    readonly choice: HouseAnalyticsChoice | null;
+    readonly choice: Open<HouseAnalyticsChoice> | null;
 }
 export interface HouseStatus {
     readonly app: string | null;
@@ -22,11 +28,12 @@ export interface HouseStatus {
     readonly credential: HouseCredentialState;
     readonly sync: HouseSyncState | null;
     readonly refusal: {
-        readonly reason: string;
+        readonly code: string;
+        readonly retryable: boolean;
     } | null;
     readonly loss: string | null;
     readonly analytics: HouseAnalytics;
-    readonly serviceMode: 'open' | 'write-halted' | null;
+    readonly serviceMode: Open<'open' | 'write-halted'> | null;
     readonly offline: boolean;
 }
 export type HouseNavigationMode = 'push' | 'replace';
@@ -65,6 +72,7 @@ export interface HouseExternalRequest {
     readonly body_base64?: string;
     readonly account?: string;
     readonly slot?: string;
+    readonly room_ref?: string;
 }
 export type HouseExternalAnswer = {
     readonly status: number;
@@ -77,30 +85,47 @@ export type HouseExternalAnswer = {
 export interface HouseRefusal {
     readonly error: {
         readonly code: string;
+        readonly retryable: boolean;
     };
 }
 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 type HouseInstallation = Open<'accepted' | 'dismissed' | 'manual'>;
+export type HouseNotifications = Open<'on' | 'off' | 'blocked' | 'unavailable'>;
 export interface HouseCeremonyRefused extends Error {
     readonly name: 'HouseCeremonyRefused';
+    readonly code: Open<'house_ceremony_refused'>;
+    readonly retryable: boolean;
     readonly path: string | null;
 }
 export interface HouseNavigationRefused extends Error {
     readonly name: 'HouseNavigationRefused';
+    readonly code: Open<'house_navigation_refused'>;
+    readonly retryable: boolean;
     readonly address: string | null;
 }
+export interface HouseBrowserRefused extends Error {
+    readonly code: string;
+    readonly retryable: boolean;
+}
+export interface HouseTrialWithheld {
+    readonly code: Open<'house_trial_withheld'>;
+    readonly retryable: true;
+}
+export type HouseTask = unknown;
+export type HouseActivation = Open<'committed' | 'abandoned'>;
+export interface HouseCooperation {
+    checkpoint(): Promise<void> | void;
+    persist(): Promise<void> | void;
+    capture(): Promise<HouseTask> | HouseTask;
+    restore(task: HouseTask | null): Promise<void> | void;
+    ready(): Promise<boolean> | boolean;
+    settle(activation: HouseActivation): void;
+}
 export interface HouseBridge {
-    readonly runtime: Promise<MdRuntimeClient>;
+    readonly runtime: Promise<HouseRuntime>;
     address(): string | null;
     onAddress(listener: (address: string) => void): () => void;
     push(address: string): Promise<string>;
@@ -110,7 +135,6 @@ export interface HouseBridge {
     notifications(on?: boolean): Promise<HouseNotifications>;
     setBadge(unread: readonly string[]): Promise<void>;
     setTab(tab: HouseTab): void;
-    readAttachment(room: string, attachment: string): Promise<HouseImageCopy | null>;
     sourceTop(app: string, release?: string): Promise<HouseSourceTop | HouseRefusal | null>;
     sourceDownload(app: string, release?: string): Promise<HouseSourceDownload | HouseRefusal | null>;
     callExternal(request: HouseExternalRequest): Promise<HouseExternalAnswer | HouseRefusal | null>;
@@ -120,6 +144,9 @@ export interface HouseBridge {
     onStatus(listener: (status: HouseStatus) => void): () => void;
     messages(listener: (message: HouseAppMessage) => void): () => void;
     analyticsConsent(choice: HouseAnalyticsChoice): void;
+    cooperate(cooperation: HouseCooperation): () => void;
+}
+export interface HouseHeld {
+    readonly houseBridge: HouseBridge;
 }
 export declare const houseBridge: () => HouseBridge;
-export {};

package/dist/mdmodel/blocks.d.ts

@@ -0,0 +1,10 @@
+import type { Extent } from './types.js';
+export type HeadingLine = {
+    readonly level: number;
+    readonly name: string;
+    readonly start: number;
+    readonly textEnd: number;
+    readonly next: number;
+};
+export declare function headingLines(content: string, from: number, to: number): HeadingLine[];
+export declare function blockRanges(content: string, from: number, to: number): Extent[];

package/dist/mdmodel/condition.d.ts

@@ -0,0 +1,149 @@
+import { type ValueFacts } from './definition.js';
+import type { Document, VerifiedModel } from './types.js';
+export type ConditionValue = string | number | boolean | {
+    readonly owner: true;
+};
+export type ConditionTest = {
+    readonly all: readonly ConditionTest[];
+} | {
+    readonly any: readonly ConditionTest[];
+} | {
+    readonly not: ConditionTest;
+} | ({
+    readonly path: string;
+} & ({
+    readonly eq: ConditionValue;
+} | {
+    readonly in: readonly ConditionValue[];
+} | {
+    readonly exists: boolean;
+} | {
+    readonly contains: ConditionValue;
+} | {
+    readonly gt: number | string;
+} | {
+    readonly gte: number | string;
+} | {
+    readonly lt: number | string;
+} | {
+    readonly lte: number | string;
+} | {
+    readonly prefix: string;
+}));
+export type ConditionScope = {
+    readonly type: string;
+} | {
+    readonly folder: string;
+} | {
+    readonly document: string;
+};
+type DocumentEventBase = {
+    readonly on: 'documents';
+    readonly scope: ConditionScope;
+    readonly by?: ConditionTest;
+};
+export type DocumentCondition = (DocumentEventBase & {
+    readonly mode: 'starts_matching';
+    readonly new_documents: boolean;
+    readonly match: ConditionTest;
+}) | (DocumentEventBase & {
+    readonly mode: 'field_changes';
+    readonly field: string;
+    readonly from?: readonly ConditionValue[] | 'new';
+    readonly to?: readonly ConditionValue[] | 'deleted';
+    readonly match?: ConditionTest;
+});
+export type ItemCondition = {
+    readonly on: 'items';
+    readonly source?: string;
+    readonly address?: string;
+    readonly match?: ConditionTest;
+};
+export type CronCondition = {
+    readonly on: 'clock';
+    readonly cron: string;
+    readonly time_zone: string;
+};
+export type DateCondition = {
+    readonly on: 'clock';
+    readonly scope: {
+        readonly type: string;
+    };
+    readonly date: string;
+    readonly days: number;
+    readonly at: string;
+    readonly time_zone: string;
+    readonly match?: ConditionTest;
+};
+export type Condition = DocumentCondition | ItemCondition | CronCondition | DateCondition;
+export type FactKind = 'string' | 'number' | 'boolean' | 'date' | 'time' | 'enum' | 'reference';
+type Scalar = string | number | boolean;
+export type Fact = {
+    readonly kind: FactKind;
+    readonly value: Scalar;
+    readonly member?: string;
+} | {
+    readonly kind: 'prose';
+} | {
+    readonly kind: 'null';
+} | {
+    readonly kind: 'unreadable';
+} | {
+    readonly kind: 'list';
+    readonly items: readonly Fact[];
+} | {
+    readonly kind: 'object';
+    readonly fields: Readonly<Record<string, Fact>>;
+};
+export type DocumentFacts = {
+    readonly id: string;
+    readonly path: string;
+    readonly type: string | null;
+    readonly fields: Readonly<Record<string, Fact>>;
+    readonly sections: readonly string[];
+};
+export declare const WRITE_DOORS: readonly ['browser', 'agent', 'client'];
+export type WriteDoor = (typeof WRITE_DOORS)[number];
+export type Actor = {
+    readonly user?: string;
+    readonly site?: string;
+    readonly door?: WriteDoor;
+};
+export type DocumentEvent = {
+    readonly before: DocumentFacts | null;
+    readonly after: DocumentFacts | null;
+    readonly changed: readonly string[];
+    readonly by: Actor;
+};
+export type ItemFacts = {
+    readonly delivery: string;
+    readonly source: string | null;
+    readonly address: string | null;
+    readonly has_attachment: boolean;
+    readonly provider: string | null;
+    readonly container: string | null;
+    readonly author: string | null;
+    readonly headers: Readonly<Record<string, string>>;
+    readonly json: {
+        readonly value: unknown;
+    } | null;
+};
+export type Resolved = {
+    readonly id: string;
+    readonly member?: string;
+};
+type Truth = boolean | undefined;
+export declare function factKind(facts: ValueFacts): FactKind | null;
+export declare function facts(document: Document, at: {
+    readonly id: string;
+    readonly path: string;
+}, model: VerifiedModel, resolve: (target: string) => Resolved | undefined): DocumentFacts;
+export declare function prosePaths(facts: DocumentFacts): string[];
+export declare function datePointers(fields: Readonly<Record<string, ValueFacts>>): string[];
+export declare function dated(value: unknown): value is string;
+export declare function instant(value: unknown): bigint | undefined;
+export declare function pointed(value: unknown, pointer: string): unknown;
+export declare function holds(test: ConditionTest, document: DocumentFacts, owner: string): Truth;
+export declare function fires(condition: DocumentCondition, event: DocumentEvent, owner: string): boolean;
+export declare function itemFires(condition: ItemCondition, item: ItemFacts, owner: string): boolean;
+export {};

package/dist/mdmodel/definition.d.ts

@@ -0,0 +1,79 @@
+import type { VerifiedModel } from './types.js';
+export type JsonType = 'string' | 'number' | 'integer' | 'boolean' | 'object' | 'array' | 'null';
+export type ValueFacts = {
+    readonly type?: JsonType;
+    readonly format?: string;
+    readonly values?: readonly unknown[];
+    readonly reference?: readonly string[];
+    readonly prose: boolean;
+    readonly conditional?: true;
+    readonly prefix?: readonly ValueFacts[];
+    readonly items?: ValueFacts;
+    readonly properties?: Readonly<Record<string, ValueFacts>>;
+    readonly patterns?: readonly PatternFacts[];
+    readonly additional?: ValueFacts;
+};
+export type PatternFacts = {
+    readonly pattern: string;
+    readonly facts: ValueFacts;
+};
+export type SectionSpec = {
+    readonly kind: 'text';
+    readonly required: boolean;
+} | {
+    readonly kind: 'list';
+    readonly required: boolean;
+    readonly items: ValueFacts;
+};
+export type Shape = {
+    readonly schema: Readonly<Record<string, unknown>>;
+    readonly defs: Readonly<Record<string, unknown>>;
+};
+export type RuleValue = string | number | boolean | null;
+export type Transition = {
+    readonly from: RuleValue;
+    readonly to: RuleValue;
+    readonly roles?: readonly string[];
+};
+export type FieldRules = {
+    readonly changeRoles?: readonly string[];
+    readonly initialRoles?: readonly string[];
+    readonly transitions?: readonly Transition[];
+};
+export type Definition = {
+    readonly name: string;
+    readonly memberDocument: boolean;
+    readonly frontmatter: ValueFacts;
+    readonly fields: Readonly<Record<string, ValueFacts>>;
+    readonly sections: Readonly<Record<string, SectionSpec>>;
+    readonly rules: Readonly<Record<string, FieldRules>>;
+    readonly createRoles?: readonly string[];
+    readonly deleteRoles?: readonly string[];
+    readonly shape: Shape;
+};
+export type Failure = {
+    readonly rule: string;
+    readonly location?: string;
+};
+export declare const JSON_TYPES: readonly JsonType[];
+export declare const BUILT_IN_TYPE = "any";
+export declare const ATTACHMENT = "attachment";
+export declare const ARRAY_INDEX: RegExp;
+export declare function escapePointer(key: string): string;
+export declare function pointerSegments(pointer: string): string[];
+export declare function refTarget(reference: string, defs: Readonly<Record<string, unknown>>): {
+    readonly name: string;
+    readonly node: unknown;
+} | undefined;
+export declare function valueFacts(node: unknown, defs: Readonly<Record<string, unknown>>): ValueFacts;
+export declare function itemFacts(facts: ValueFacts, index: number): ValueFacts | undefined;
+export declare function memberFacts(facts: ValueFacts, key: string): ValueFacts | undefined;
+export type PointerFacts = {
+    readonly facts: ValueFacts;
+    readonly through: boolean;
+    readonly conditional: boolean;
+};
+export declare function crossedFacts(facts: ValueFacts): ValueFacts[];
+export declare function fieldFacts(definition: Definition, key: string): ValueFacts | undefined;
+export declare function pointerFacts(definition: Definition, pointer: string): PointerFacts | undefined;
+export declare function readSchema(text: string): VerifiedModel | Failure;

package/dist/mdmodel/divide.d.ts

@@ -0,0 +1,2 @@
+import type { Division, DivisionContext, Document } from './types.js';
+export declare function divide(document: Document, file: string, context: DivisionContext): Division;

package/dist/mdmodel/document.d.ts

@@ -0,0 +1,15 @@
+import { type Definition } from './definition.js';
+import type { ApplyResult, BodyResult, FrontmatterResult, Change, Document, Link, LinkOccurrence, ParseResult } from './types.js';
+import { type YamlMap } from './yaml.js';
+export declare function parseFrontmatter(content: string, file?: string): FrontmatterResult;
+export declare function parse(content: string, file?: string): ParseResult;
+export declare function relativize(document: Document, file: string, handle: string, definition?: Definition): ApplyResult;
+export declare function relativizeBody(body: string, file: string, handle: string): BodyResult;
+export declare function relinkBody(body: string, file: string, moves: ReadonlyMap<string, string>): BodyResult;
+export declare function links(document: Document, file: string): readonly Link[];
+export declare function linkOccurrences(document: Document, file: string): readonly LinkOccurrence[];
+export declare function bodyLinks(body: string, file: string): readonly Link[];
+export declare function apply(document: Document, change: Change): ApplyResult;
+export declare function serialize(document: Document): string;
+export declare function fieldStart(document: Document, pointer: string): number | undefined;
+export declare function frontmatter(document: Document): YamlMap | null;

package/dist/mdmodel/fields.d.ts

@@ -0,0 +1,5 @@
+export declare const TYPE_FIELD = "type";
+export declare const MEMBER_FIELD = "member";
+export declare const SITE_FIELD = "site";
+export declare const RECEIVED_FIELD = "received";
+export declare const HOUSE_FIELDS: readonly string[];

package/dist/mdmodel/index.d.ts

@@ -0,0 +1,18 @@
+export { dated, datePointers, factKind, facts, fires, holds, instant, itemFires, pointed, prosePaths, WRITE_DOORS, } from './condition.js';
+export type { Actor, Condition, ConditionScope, ConditionTest, ConditionValue, CronCondition, DateCondition, DocumentCondition, DocumentEvent, DocumentFacts, Fact, FactKind, ItemCondition, ItemFacts, Resolved, WriteDoor, } from './condition.js';
+export { headingLines } from './blocks.js';
+export type { HeadingLine } from './blocks.js';
+export { divide } from './divide.js';
+export { apply, bodyLinks, fieldStart, linkOccurrences, links, parse, parseFrontmatter, relativize, relativizeBody, relinkBody, serialize, } from './document.js';
+export { HOUSE_FIELDS, MEMBER_FIELD, RECEIVED_FIELD, SITE_FIELD, TYPE_FIELD } from './fields.js';
+export { relative, retarget, target } from './paths.js';
+export { MARKDOWN_SYNTAX_PROFILE } from './profile.js';
+export { project } from './project.js';
+export { references } from './references.js';
+export { ARRAY_INDEX, ATTACHMENT, crossedFacts, escapePointer, itemFacts, memberFacts, pointerFacts, pointerSegments, } from './definition.js';
+export type { Definition, FieldRules, JsonType, PatternFacts, PointerFacts, RuleValue, SectionSpec, Shape, Transition, ValueFacts, } from './definition.js';
+export type { ApplyResult, BodyResult, Change, Division, DivisionContext, Document, DocumentCheck, Frontmatter, FrontmatterResult, Library, ModelVerification, Link, LinkOccurrence, ParseResult, Projection, ProjectionContext, Reached, Reference, Refusal, Span, Validation, ValidationContext, VerifiedModel, } from './types.js';
+export { checkDocument, resolves, sectionReferences, validate, verify } from './validate.js';
+export { VERSION } from './version.js';
+export { bodyAfterFrontmatter, equalValue, frontmatterValue } from './yaml.js';
+export type { FrontmatterValue } from './yaml.js';

package/dist/mdmodel/paths.d.ts

@@ -0,0 +1,17 @@
+export declare function dirname(path: string): string;
+export declare function join(base: string, relative: string): string;
+export declare function normalize(path: string): string | null;
+export declare function destinationPath(href: string): string | null;
+export declare function classifyHref(from: string, href: string): {
+    kind: 'skip';
+} | {
+    kind: 'path';
+    path: string;
+} | {
+    kind: 'invalid';
+};
+export declare function target(from: string, href: string): string | null;
+export declare function retarget(href: string, to: string): string;
+export declare function relative(from: string, target: string): string;
+export declare const SHELL_ROOMS = "/rooms/";
+export declare function shellTarget(href: string, handle: string): string | null;

package/dist/mdmodel/profile.d.ts

@@ -0,0 +1,5 @@
+export declare const MARKDOWN_SYNTAX_PROFILE: {
+    readonly name: 'GitHub Flavored Markdown';
+    readonly spec: '0.29';
+    readonly url: 'https://github.github.com/gfm/';
+};

package/dist/mdmodel/project.d.ts

@@ -0,0 +1,20 @@
+import type { Document, Extent, Projection, ProjectionContext, Refusal } from './types.js';
+export type Piece = Extent & {
+    readonly text: string;
+};
+export type Edit = Piece;
+export type Input = {
+    readonly values: readonly Piece[];
+    readonly ranges: readonly Extent[];
+    readonly edits: readonly Edit[];
+};
+export type InputResult = {
+    readonly ok: true;
+    readonly input: Input;
+} | {
+    readonly ok: false;
+    readonly refusal: Refusal;
+};
+export declare function rangeText(content: string, range: Extent, edits: readonly Edit[]): string;
+export declare function projectionInput(document: Document, file: string, context: ProjectionContext): InputResult;
+export declare function project(document: Document, file: string, context?: ProjectionContext): Projection;

package/dist/mdmodel/references.d.ts

@@ -0,0 +1,3 @@
+import { type Definition } from './definition.js';
+import type { Frontmatter, Reference } from './types.js';
+export declare function references(document: Pick<Frontmatter, 'fields'>, definition: Definition): readonly Reference[];