@agentshouse/app-bridge 0.1.0-cf8a685b77ec0 → 0.1.0-cfb5ca35059bb
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/README.md +19 -16
- package/dist/index.d.ts +974 -0
- package/dist/index.js +1 -0
- package/dist/mdmodel/blocks.d.ts +10 -0
- package/dist/mdmodel/condition.d.ts +179 -0
- package/dist/mdmodel/definition.d.ts +81 -0
- package/dist/mdmodel/divide.d.ts +2 -0
- package/dist/mdmodel/document.d.ts +15 -0
- package/dist/mdmodel/fields.d.ts +5 -0
- package/dist/mdmodel/index.d.ts +20 -0
- package/dist/mdmodel/links.d.ts +28 -0
- package/dist/mdmodel/paths.d.ts +25 -0
- package/dist/mdmodel/profile.d.ts +5 -0
- package/dist/mdmodel/project.d.ts +21 -0
- package/dist/mdmodel/references.d.ts +3 -0
- package/dist/mdmodel/types.d.ts +167 -0
- package/dist/mdmodel/validate.d.ts +31 -0
- package/dist/mdmodel/version.d.ts +1 -0
- package/dist/mdmodel/yaml.d.ts +55 -0
- package/dist/mdruntime/adapter.d.ts +530 -0
- package/dist/mdruntime/binary.d.ts +17 -0
- package/dist/mdruntime/chain.d.ts +10 -0
- package/dist/mdruntime/change-set.d.ts +27 -0
- package/dist/mdruntime/change.d.ts +118 -0
- package/dist/mdruntime/client.d.ts +89 -0
- package/dist/mdruntime/collection.d.ts +27 -0
- package/dist/mdruntime/compile.d.ts +15 -0
- package/dist/mdruntime/connection.d.ts +152 -0
- package/dist/mdruntime/conversation.d.ts +118 -0
- package/dist/mdruntime/durability.d.ts +11 -0
- package/dist/mdruntime/failure.d.ts +12 -0
- package/dist/mdruntime/fulltext.d.ts +26 -0
- package/dist/mdruntime/identity.d.ts +6 -0
- package/dist/mdruntime/media.d.ts +7 -0
- package/dist/mdruntime/messages.d.ts +27 -0
- package/dist/mdruntime/model.d.ts +62 -0
- package/dist/mdruntime/observation.d.ts +44 -0
- package/dist/mdruntime/open.d.ts +1 -0
- package/dist/mdruntime/opened.d.ts +21 -0
- package/dist/mdruntime/outcome.d.ts +84 -0
- package/dist/mdruntime/overlay.d.ts +24 -0
- package/dist/mdruntime/query.d.ts +283 -0
- package/dist/mdruntime/reach.d.ts +53 -0
- package/dist/mdruntime/readiness.d.ts +51 -0
- package/dist/mdruntime/recovery.d.ts +25 -0
- package/dist/mdruntime/replica.d.ts +67 -0
- package/dist/mdruntime/room-draft.d.ts +173 -0
- package/dist/mdruntime/save.d.ts +102 -0
- package/dist/mdruntime/search.d.ts +72 -0
- package/dist/mdruntime/seed.d.ts +15 -0
- package/dist/mdruntime/status.d.ts +27 -0
- package/dist/mdruntime/store.d.ts +154 -0
- package/dist/mdruntime/stored.d.ts +129 -0
- package/dist/mdruntime/tables.d.ts +324 -0
- package/dist/mdruntime/wire.d.ts +234 -0
- package/dist/{client/src/test-host.d.ts → test-host.d.ts} +10 -8
- package/dist/test-host.js +190 -0
- package/docs/families.md +86 -42
- package/package.json +12 -10
- package/dist/client/src/bridge.d.ts +0 -38
- package/dist/client/src/bridge.js +0 -320
- package/dist/client/src/index.d.ts +0 -3
- package/dist/client/src/index.js +0 -2
- package/dist/client/src/test-host.js +0 -185
- package/dist/client/src/wire.d.ts +0 -215
- package/dist/client/src/wire.js +0 -1
- package/dist/src/apps/remainder.d.ts +0 -2
- package/dist/src/apps/remainder.js +0 -16
- package/dist/src/apps/tab.d.ts +0 -6
- package/dist/src/apps/tab.js +0 -27
|
@@ -0,0 +1,190 @@
|
|
|
1
|
+
const HOST_ORIGIN = 'https://house.invalid';
|
|
2
|
+
const ADDRESS_MAX_CHARS = 64 * 1024;
|
|
3
|
+
function sameOriginPath(value) {
|
|
4
|
+
if (typeof value !== 'string')
|
|
5
|
+
return null;
|
|
6
|
+
if (value.charAt(0) !== '/' || value.slice(0, 2) === '//')
|
|
7
|
+
return null;
|
|
8
|
+
if (value.length > ADDRESS_MAX_CHARS)
|
|
9
|
+
return null;
|
|
10
|
+
const target = new URL(value, HOST_ORIGIN);
|
|
11
|
+
return target.origin === HOST_ORIGIN ? `${target.pathname}${target.search}${target.hash}` : null;
|
|
12
|
+
}
|
|
13
|
+
function appAddress(address) {
|
|
14
|
+
return address.startsWith('/') ? address : `/${address}`;
|
|
15
|
+
}
|
|
16
|
+
function ceremonyRefused(path) {
|
|
17
|
+
return Object.assign(new Error('house_ceremony_refused'), {
|
|
18
|
+
name: 'HouseCeremonyRefused',
|
|
19
|
+
code: 'house_ceremony_refused',
|
|
20
|
+
retryable: false,
|
|
21
|
+
path,
|
|
22
|
+
});
|
|
23
|
+
}
|
|
24
|
+
function navigationRefused(address) {
|
|
25
|
+
return Object.assign(new Error('house_navigation_refused'), {
|
|
26
|
+
name: 'HouseNavigationRefused',
|
|
27
|
+
code: 'house_navigation_refused',
|
|
28
|
+
retryable: false,
|
|
29
|
+
address,
|
|
30
|
+
});
|
|
31
|
+
}
|
|
32
|
+
function followHeld(listeners, listener, held) {
|
|
33
|
+
let following = true;
|
|
34
|
+
queueMicrotask(() => {
|
|
35
|
+
if (!following)
|
|
36
|
+
return;
|
|
37
|
+
listeners.add(listener);
|
|
38
|
+
const value = held();
|
|
39
|
+
if (value !== null)
|
|
40
|
+
listener(value);
|
|
41
|
+
});
|
|
42
|
+
return () => {
|
|
43
|
+
following = false;
|
|
44
|
+
listeners.delete(listener);
|
|
45
|
+
};
|
|
46
|
+
}
|
|
47
|
+
export function createHouseBridgeTestHost(options = {}) {
|
|
48
|
+
const navigations = [];
|
|
49
|
+
const ceremonies = [];
|
|
50
|
+
const consents = [];
|
|
51
|
+
const tabs = [];
|
|
52
|
+
const externalCalls = [];
|
|
53
|
+
const chats = [];
|
|
54
|
+
const addressListeners = new Set();
|
|
55
|
+
const statusListeners = new Set();
|
|
56
|
+
const messageListeners = new Set();
|
|
57
|
+
let current = appAddress(options.address ?? '/');
|
|
58
|
+
let published = options.status ?? null;
|
|
59
|
+
let shown = null;
|
|
60
|
+
let seen = null;
|
|
61
|
+
let attached = () => { };
|
|
62
|
+
const runtime = new Promise((resolve) => {
|
|
63
|
+
attached = resolve;
|
|
64
|
+
});
|
|
65
|
+
function arrive(target) {
|
|
66
|
+
current = target;
|
|
67
|
+
queueMicrotask(() => {
|
|
68
|
+
shown = target;
|
|
69
|
+
for (const listener of addressListeners)
|
|
70
|
+
listener(target);
|
|
71
|
+
});
|
|
72
|
+
}
|
|
73
|
+
function publish(next) {
|
|
74
|
+
published = next;
|
|
75
|
+
queueMicrotask(() => {
|
|
76
|
+
seen = next;
|
|
77
|
+
for (const listener of statusListeners)
|
|
78
|
+
listener(next);
|
|
79
|
+
});
|
|
80
|
+
}
|
|
81
|
+
function navigate(mode, asked) {
|
|
82
|
+
let path = asked;
|
|
83
|
+
if (/^https?:\/\//i.test(asked)) {
|
|
84
|
+
try {
|
|
85
|
+
const target = new URL(asked);
|
|
86
|
+
path = target.origin === HOST_ORIGIN ? target.pathname + target.search + target.hash : '';
|
|
87
|
+
}
|
|
88
|
+
catch {
|
|
89
|
+
path = '';
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
const target = sameOriginPath(path);
|
|
93
|
+
if (target === null)
|
|
94
|
+
return Promise.reject(navigationRefused(asked));
|
|
95
|
+
navigations.push({ mode, address: target });
|
|
96
|
+
arrive(target);
|
|
97
|
+
return new Promise((resolve) => {
|
|
98
|
+
queueMicrotask(() => resolve(target));
|
|
99
|
+
});
|
|
100
|
+
}
|
|
101
|
+
const bridge = {
|
|
102
|
+
runtime: runtime,
|
|
103
|
+
chat: {
|
|
104
|
+
mount(element, options = {}) {
|
|
105
|
+
const chat = { element, options, mounted: true };
|
|
106
|
+
chats.push(chat);
|
|
107
|
+
return Promise.resolve({
|
|
108
|
+
update(next) {
|
|
109
|
+
chat.options = next;
|
|
110
|
+
},
|
|
111
|
+
unmount() {
|
|
112
|
+
chat.mounted = false;
|
|
113
|
+
},
|
|
114
|
+
});
|
|
115
|
+
},
|
|
116
|
+
},
|
|
117
|
+
address: () => shown,
|
|
118
|
+
onAddress(listener) {
|
|
119
|
+
return followHeld(addressListeners, listener, () => shown);
|
|
120
|
+
},
|
|
121
|
+
push: (asked) => navigate('push', asked),
|
|
122
|
+
replace: (asked) => navigate('replace', asked),
|
|
123
|
+
ceremony(path) {
|
|
124
|
+
const target = sameOriginPath(path);
|
|
125
|
+
if (target === null)
|
|
126
|
+
return Promise.reject(ceremonyRefused(path));
|
|
127
|
+
ceremonies.push(target);
|
|
128
|
+
return new Promise(() => { });
|
|
129
|
+
},
|
|
130
|
+
install: () => Promise.resolve('manual'),
|
|
131
|
+
notifications: () => Promise.resolve('unavailable'),
|
|
132
|
+
setBadge: () => Promise.resolve(),
|
|
133
|
+
setTab(tab) {
|
|
134
|
+
tabs.push(tab);
|
|
135
|
+
},
|
|
136
|
+
sourceTop: (app) => Promise.resolve(options.sources?.find((entry) => entry.top.app_ref === app)?.top ?? null),
|
|
137
|
+
sourceDownload: (app) => Promise.resolve(options.sources?.find((entry) => entry.top.app_ref === app)?.download ?? null),
|
|
138
|
+
callExternal(request) {
|
|
139
|
+
externalCalls.push(request);
|
|
140
|
+
return Promise.resolve(options.external?.(request) ?? null);
|
|
141
|
+
},
|
|
142
|
+
readScreenshot: (app) => Promise.resolve(options.screenshots?.[app] ?? null),
|
|
143
|
+
readSiteScreenshot: (site) => Promise.resolve(options.siteScreenshots?.[site] ?? null),
|
|
144
|
+
status: () => seen,
|
|
145
|
+
onStatus(listener) {
|
|
146
|
+
return followHeld(statusListeners, listener, () => seen);
|
|
147
|
+
},
|
|
148
|
+
messages(listener) {
|
|
149
|
+
messageListeners.add(listener);
|
|
150
|
+
return () => {
|
|
151
|
+
messageListeners.delete(listener);
|
|
152
|
+
};
|
|
153
|
+
},
|
|
154
|
+
analyticsConsent(choice) {
|
|
155
|
+
if (published === null || !published.analytics.measures)
|
|
156
|
+
return;
|
|
157
|
+
if (choice !== 'accept' && choice !== 'decline')
|
|
158
|
+
return;
|
|
159
|
+
consents.push(choice);
|
|
160
|
+
publish({ ...published, analytics: { measures: true, choice } });
|
|
161
|
+
},
|
|
162
|
+
cooperate: () => () => { },
|
|
163
|
+
};
|
|
164
|
+
Object.defineProperty(globalThis, 'houseBridge', { value: bridge, configurable: true });
|
|
165
|
+
if (published !== null)
|
|
166
|
+
publish(published);
|
|
167
|
+
arrive(current);
|
|
168
|
+
return {
|
|
169
|
+
navigations,
|
|
170
|
+
chats,
|
|
171
|
+
ceremonies,
|
|
172
|
+
consents,
|
|
173
|
+
tabs,
|
|
174
|
+
externalCalls,
|
|
175
|
+
address: () => current,
|
|
176
|
+
open(asked) {
|
|
177
|
+
arrive(appAddress(asked));
|
|
178
|
+
},
|
|
179
|
+
publish,
|
|
180
|
+
message({ from, body }) {
|
|
181
|
+
queueMicrotask(() => {
|
|
182
|
+
for (const listener of messageListeners)
|
|
183
|
+
listener({ from, body });
|
|
184
|
+
});
|
|
185
|
+
},
|
|
186
|
+
attachRuntime(client) {
|
|
187
|
+
attached(client);
|
|
188
|
+
},
|
|
189
|
+
};
|
|
190
|
+
}
|
package/docs/families.md
CHANGED
|
@@ -12,39 +12,55 @@
|
|
|
12
12
|
purpose-bound authenticated pages. The shell navigates only to a same-origin
|
|
13
13
|
absolute path, carries its current address as the return target, and the page
|
|
14
14
|
returns there when it completes. An App names an address House gave it in a
|
|
15
|
-
reading and composes
|
|
15
|
+
reading and composes one only for `/bind/<app_ref>`, where the User binds
|
|
16
|
+
its Rooms, with `?slot=<name>` to open at one slot.
|
|
16
17
|
- **Installation** - `install()` offers the page as a Home-screen app. Where the
|
|
17
18
|
browser has an install prompt ready the shell shows it and the call resolves
|
|
18
19
|
`'accepted'` or `'dismissed'` with the User's choice, spending that prompt;
|
|
19
20
|
otherwise, as on every iPhone and iPad, it resolves `'manual'` and the App
|
|
20
21
|
shows its own instructions. A prompt the browser refuses to show, as for a
|
|
21
|
-
call made without a click, rejects with
|
|
22
|
-
and stays ready. Call it from a click. The standard
|
|
22
|
+
call made without a click, rejects with an error named and coded by the
|
|
23
|
+
browser's own error name, with `retryable` false, and stays ready. Call it from a click. The standard
|
|
23
24
|
`display-mode: standalone` media query tells the App it runs installed.
|
|
24
25
|
- **Notifications** - House's own panel alone; an App's or a Site's call
|
|
25
|
-
rejects with `HouseCeremonyRefused`. `notifications()` answers this browser
|
|
26
|
+
rejects with an error named `HouseCeremonyRefused`, carrying `code` and `retryable`. `notifications()` answers this browser
|
|
26
27
|
storage's push state: `'on'`, `'off'`, `'blocked'` where the browser refuses
|
|
27
28
|
notifications, or `'unavailable'` where it has no push, as on an iPhone or
|
|
28
29
|
iPad outside a Home-screen app. `notifications(true)` asks the browser's
|
|
29
30
|
permission and subscribes, `notifications(false)` unsubscribes, and each
|
|
30
|
-
answers the state it leaves; a failure of the browser's push service
|
|
31
|
-
|
|
31
|
+
answers the state it leaves; a failure of the browser's push service, and
|
|
32
|
+
of `setBadge`, rejects the same way. Call `notifications(true)` from a
|
|
32
33
|
click. `setBadge(unread)` takes the identifiers of the Human Notifications
|
|
33
34
|
unread in this storage and sets the icon's badge to their number, or clears
|
|
34
35
|
it at none, where the browser shows one.
|
|
35
36
|
- **Status** - the App reference the runtime client is attached under,
|
|
36
|
-
`preferences`: the `
|
|
37
|
+
`preferences`: the `roomRef` and Path of the App's own preferences document,
|
|
37
38
|
or `null` until the runtime holds that Room, sync
|
|
38
|
-
state, credential state and observed failure, `
|
|
39
|
+
state, credential state and its `expiresAt`, observed failure, `analytics`:
|
|
39
40
|
whether the page measures and the visitor's stored analytics choice, and
|
|
40
|
-
`
|
|
41
|
+
`serviceMode`: `open`, `write-halted` while House refuses writes, so the
|
|
41
42
|
App can stop retrying them, or `null` while the runtime holds no House
|
|
42
|
-
connection.
|
|
43
|
-
|
|
44
|
-
|
|
43
|
+
connection. Every status field is camelCase. `onStatus(listener)` and
|
|
44
|
+
`onAddress(listener)` hand a listener the status and the address the bridge
|
|
45
|
+
already holds, then each change.
|
|
46
|
+
The App reports the visitor's choice with `analyticsConsent('accept')` or
|
|
47
|
+
`analyticsConsent('decline')`; the shell hands it to House's analytics loader, and
|
|
45
48
|
the choice never reaches House.
|
|
46
|
-
- **
|
|
47
|
-
|
|
49
|
+
- **Releases and builds** - an open App keeps the release it loaded: a newer
|
|
50
|
+
release, or a newer House build, takes effect at the App's next load, offline
|
|
51
|
+
too once the browser stored it. When one tab loads a newer House build, the
|
|
52
|
+
other House tabs reload into it; Room Drafts, chat drafts and unsent changes
|
|
53
|
+
survive the reload.
|
|
54
|
+
- **A runtime that ends** - when the browser ends House's runtime under an open
|
|
55
|
+
App, the App keeps running, its `runtime` client and observations included:
|
|
56
|
+
each observation goes on with the next runtime's values, and the status and
|
|
57
|
+
the address arrive again. A runtime that ended before answering has its reads
|
|
58
|
+
answered by the next one; since it may have applied any other call, an act on
|
|
59
|
+
House is answered the outcome `transport-uncertainty`, and every other call,
|
|
60
|
+
a Save or a draft write among them, fails with the retryable code
|
|
61
|
+
`transport-uncertainty`.
|
|
62
|
+
- **Site image read** - given a Published Room and the Path of one of its
|
|
63
|
+
binary entries, it answers the web copy's path and metadata, or `null` when no
|
|
48
64
|
copy exists. The original bytes never cross this bridge at a Site.
|
|
49
65
|
- **App release code** - `sourceTop(app, release)` answers the top level of
|
|
50
66
|
the latest successful release of an App the User may use: its folders, its
|
|
@@ -53,24 +69,24 @@
|
|
|
53
69
|
path, its size and its `text`, or its bytes as `base64`. The browser keeps
|
|
54
70
|
each answer per App and release: a read naming a release it holds answers
|
|
55
71
|
without asking House, and keeping a newer release drops the earlier one. A
|
|
56
|
-
refusal is House's `{ error: { code } }`, `app_release_not_found` for an
|
|
72
|
+
refusal is House's `{ error: { code, retryable } }`, `app_release_not_found` for an
|
|
57
73
|
App with no release; a read House does not answer, or one that outlived
|
|
58
74
|
the browser's signed-in User, is `null`.
|
|
59
|
-
- **External calls** - `callExternal({ url, method, headers, body,
|
|
75
|
+
- **External calls** - `callExternal({ url, method, headers, body, room_ref })`
|
|
60
76
|
has House's server send an HTTPS request to one of the release's declared
|
|
61
77
|
external origins and resolves with the service's `status`, `headers` and its
|
|
62
78
|
body as `body` text or `body_base64`, or a refusal as House's
|
|
63
|
-
`{ error: { code } }`, or `null` when House does not answer. House fills in the
|
|
64
|
-
App and its running release
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
`
|
|
79
|
+
`{ error: { code, retryable } }`, or `null` when House does not answer. House fills in the
|
|
80
|
+
App and its running release. A `room_ref` names a Room the signed-in User binds to the App
|
|
81
|
+
in a `write` slot, and House adds that Room's Service key for the URL's origin, which App
|
|
82
|
+
code never sees; a call naming no Room carries no key, and a Site's call names no Room.
|
|
83
|
+
`body_base64` replaces `body` for bytes.
|
|
68
84
|
- **App messages** - `messages(listener)` hands the listener each message
|
|
69
85
|
another holder of this App sends to this User's running copies, as `from`,
|
|
70
86
|
the sender's User id, and `body`, the JSON value they sent, until the
|
|
71
87
|
function it returns is called. App code sends one through the Runtime's
|
|
72
88
|
`call('apps/messages/send', { to, body })` with the recipient's User id and
|
|
73
|
-
a body of at most 32
|
|
89
|
+
a body of at most 32 kB of JSON; House fills in the App and relays it only
|
|
74
90
|
to copies running now, storing nothing. The panel sends none.
|
|
75
91
|
- **App screenshot read** - given an App reference, `readScreenshot(app)`
|
|
76
92
|
answers the image this browser captured of that App's screen the first time
|
|
@@ -82,25 +98,53 @@
|
|
|
82
98
|
after its latest release, as a JPEG `Blob`, or `null` when House holds none
|
|
83
99
|
or does not answer. A Site's own renderer reads none.
|
|
84
100
|
|
|
101
|
+
- **Chat** - `chat.mount(element, options)` places House's Chat, the one chat
|
|
102
|
+
in which the User's Agent conversations show, in `element` over the page's
|
|
103
|
+
`runtime` client, and resolves to a handle: `update(options)` replaces its
|
|
104
|
+
options and `unmount()` removes it. House serves the Chat with the page and
|
|
105
|
+
keeps it current, so the App installs and bundles nothing for it. The
|
|
106
|
+
options: `conversation` opens one, `null` for a new chat, `agent` is the
|
|
107
|
+
Agent a new chat goes to, `showChats` adds its conversation list, `width` is
|
|
108
|
+
`full`, the element, or `3/4`, `1/2` or `1/3` of the window docked at its
|
|
109
|
+
right edge, `onOpen` hears each conversation it opens as
|
|
110
|
+
`{ conversation, agent }`, and `onLink` takes a link without a scheme in
|
|
111
|
+
place of the browser. CSS custom properties named `--chat-*` on the element
|
|
112
|
+
or an ancestor set its look. It shows conversations only to a release that
|
|
113
|
+
declares them. A Site and the House panel have none: their call rejects with
|
|
114
|
+
an error named and coded `NotSupportedError`, with `retryable` false.
|
|
115
|
+
|
|
116
|
+
- **First place** - `cooperate({ placed })` tells House when the page has
|
|
117
|
+
drawn the place it opened on; the function it returns withdraws it. Register
|
|
118
|
+
it in the entry script, before the first draw. `placed()` resolves once the
|
|
119
|
+
page has drawn that place with what it shows: House keeps its
|
|
120
|
+
first-preparation surface over a page registered by its first draw until
|
|
121
|
+
then, and lifts it at the first draw of a page that registered none, so the
|
|
122
|
+
User goes from the surface to a drawn place in one change. House asks the
|
|
123
|
+
page for nothing else.
|
|
124
|
+
|
|
85
125
|
## The test host
|
|
86
126
|
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
`
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
`
|
|
99
|
-
`
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
127
|
+
`createHouseBridgeTestHost(options)` plays House in one page: it installs a
|
|
128
|
+
bridge object that `houseBridge()` returns, until the next host replaces it.
|
|
129
|
+
It delivers the address the App starts at and each address `open` plays as
|
|
130
|
+
Back or Forward, admitting nothing, so it delivers `//notes` exactly as a
|
|
131
|
+
browser at `/apps/<app>//notes` does. It records every push and replace and
|
|
132
|
+
answers each with the address the shell would then show, records an admitted
|
|
133
|
+
ceremony, and refuses a push, replace or ceremony that is not a same-origin
|
|
134
|
+
absolute path of at most 1,000 characters with an error named
|
|
135
|
+
`HouseNavigationRefused` or `HouseCeremonyRefused`. It publishes a status,
|
|
136
|
+
its `serviceMode` included, records in `consents` each `analyticsConsent` it
|
|
137
|
+
takes while that status measures and publishes the status the choice leaves,
|
|
138
|
+
records in `tabs` each `setTab`, answers a release code read from the
|
|
139
|
+
`sources` it was given, or `null`, answers each `callExternal` from the
|
|
140
|
+
`external` function it was given, or `null`, and records the request in
|
|
141
|
+
`externalCalls`, answers `readScreenshot` from the `screenshots` it was given
|
|
142
|
+
by App reference and `readSiteScreenshot` from the `siteScreenshots` it was
|
|
143
|
+
given by Site identifier, answers every `install()` `'manual'`, as a browser
|
|
144
|
+
with no install prompt does, answers every `notifications()` `'unavailable'`,
|
|
145
|
+
as a browser without push does, settles every `setBadge`, records in `chats`
|
|
146
|
+
each Chat `chat.mount` places, with its `element`, the `options` it was last
|
|
147
|
+
given and whether it is still `mounted`, drawing nothing, delivers each App
|
|
148
|
+
message `message({ from, body })` plays, and hands `bridge.runtime` the MD
|
|
149
|
+
Runtime client `attachRuntime(client)` gives it. It takes a `cooperate` and
|
|
150
|
+
never calls `placed()`.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@agentshouse/app-bridge",
|
|
3
|
-
"version": "0.1.0-
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "0.1.0-cfb5ca35059bb",
|
|
4
|
+
"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.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
7
7
|
"sideEffects": false,
|
|
@@ -10,21 +10,23 @@
|
|
|
10
10
|
},
|
|
11
11
|
"exports": {
|
|
12
12
|
".": {
|
|
13
|
-
"types": "./dist/
|
|
14
|
-
"default": "./dist/
|
|
13
|
+
"types": "./dist/index.d.ts",
|
|
14
|
+
"default": "./dist/index.js"
|
|
15
15
|
},
|
|
16
16
|
"./test-host": {
|
|
17
|
-
"types": "./dist/
|
|
18
|
-
"default": "./dist/
|
|
17
|
+
"types": "./dist/test-host.d.ts",
|
|
18
|
+
"default": "./dist/test-host.js"
|
|
19
19
|
}
|
|
20
20
|
},
|
|
21
|
-
"dependencies": {
|
|
22
|
-
"@agentshouse/mdruntime": "0.1.0-ca1eff92bbe73"
|
|
23
|
-
},
|
|
24
21
|
"files": [
|
|
25
22
|
"dist",
|
|
26
23
|
"docs",
|
|
27
24
|
"README.md",
|
|
28
25
|
"LICENSE"
|
|
29
|
-
]
|
|
26
|
+
],
|
|
27
|
+
"repository": {
|
|
28
|
+
"type": "git",
|
|
29
|
+
"url": "git+https://github.com/agentshouse/core.git",
|
|
30
|
+
"directory": "client"
|
|
31
|
+
}
|
|
30
32
|
}
|
|
@@ -1,38 +0,0 @@
|
|
|
1
|
-
import type { MdRuntimeClient } from '@agentshouse/mdruntime/client';
|
|
2
|
-
import type { HouseAppMessage, HouseExternalAnswer, HouseExternalRequest, HouseBridgePort, HouseGaChoice, HouseImageCopy, HouseInstallation, HouseNotifications, HouseRefusal, HouseSourceDownload, HouseSourceTop, HouseStatus, HouseTab } from './wire.js';
|
|
3
|
-
export type { HouseImageCopy } from './wire.js';
|
|
4
|
-
export declare class HouseCeremonyRefused extends Error {
|
|
5
|
-
readonly path: string | null;
|
|
6
|
-
constructor(path: string | null);
|
|
7
|
-
}
|
|
8
|
-
export declare class HouseNavigationRefused extends Error {
|
|
9
|
-
readonly address: string | null;
|
|
10
|
-
constructor(address: string | null);
|
|
11
|
-
}
|
|
12
|
-
export interface HouseBridgeSource {
|
|
13
|
-
readonly port: Promise<HouseBridgePort>;
|
|
14
|
-
readonly runtime: Promise<MdRuntimeClient>;
|
|
15
|
-
}
|
|
16
|
-
export interface HouseBridge {
|
|
17
|
-
readonly runtime: Promise<MdRuntimeClient>;
|
|
18
|
-
address(): string | null;
|
|
19
|
-
onAddress(listener: (address: string) => void): () => void;
|
|
20
|
-
push(address: string): Promise<string>;
|
|
21
|
-
replace(address: string): Promise<string>;
|
|
22
|
-
ceremony(path: string): Promise<never>;
|
|
23
|
-
install(): Promise<HouseInstallation>;
|
|
24
|
-
notifications(on?: boolean): Promise<HouseNotifications>;
|
|
25
|
-
setBadge(unread: readonly string[]): Promise<void>;
|
|
26
|
-
setTab(tab: HouseTab): void;
|
|
27
|
-
readAttachment(room: string, attachment: string): Promise<HouseImageCopy | null>;
|
|
28
|
-
sourceTop(app: string, release?: string): Promise<HouseSourceTop | HouseRefusal | null>;
|
|
29
|
-
sourceDownload(app: string, release?: string): Promise<HouseSourceDownload | HouseRefusal | null>;
|
|
30
|
-
callExternal(request: HouseExternalRequest): Promise<HouseExternalAnswer | HouseRefusal | null>;
|
|
31
|
-
readScreenshot(app: string): Promise<Blob | null>;
|
|
32
|
-
readSiteScreenshot(site: string): Promise<Blob | null>;
|
|
33
|
-
status(): HouseStatus | null;
|
|
34
|
-
onStatus(listener: (status: HouseStatus) => void): () => void;
|
|
35
|
-
messages(listener: (message: HouseAppMessage) => void): () => void;
|
|
36
|
-
gaConsent(choice: HouseGaChoice): void;
|
|
37
|
-
}
|
|
38
|
-
export declare function connectHouseBridge(source?: HouseBridgeSource): HouseBridge;
|