@agentshouse/app-bridge 0.1.0-c58a055eeaa71 → 0.1.0-c646d0da70608

package/docs/families.md

@@ -39,10 +39,21 @@
   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.
+- **Handoff** - when House hands its runtime over to a newer build, the App keeps
+  running, its `runtime` client and observations included: a call it makes
+  meanwhile waits for the newer runtime, however long that takes, and is
+  answered once, by it; each observation goes on with the newer 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 an original attachment
   reference, 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.
@@ -82,6 +93,31 @@
   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.
 
+- **Cooperation** - `cooperate({ checkpoint, persist, capture, restore,
+ready, settle })` lets House activate a newer release of the App while it
+  runs, keeping the User's task; the function it returns withdraws it.
+  Register it in the entry script, before the first draw, or House treats the
+  page as not cooperating and the newer release waits for the App's next
+  open. When a newer release is stored, House calls `checkpoint()`, which
+  resolves at the App's next safe checkpoint and may never resolve, then
+  `persist()`, which makes authored work durable, then `capture()`, which
+  answers the meaningful task the App owns, such as the selected record,
+  filters, cursor, selection and scroll position, as JSON of at most 65,536
+  characters; House keeps the address itself. In the newer release House
+  calls `restore(task)` once its document has drawn, so the scroll position
+  and focus it sets hold, or `restore(null)` when it opens the release without
+  a task, then `ready()`, the App's own check that its local data and
+  capabilities work, and finally `settle('committed')` once the release is
+  active or `settle('abandoned')` when House returns to the release before
+  it, restoring the same task there. A release House opens already active is
+  settled `'committed'` at once, after `restore(task)` when House hands it a
+  task, and a cooperation registered after House settled is settled at its
+  registration. Until `settle('committed')` House fails the release's outside
+  calls at once, as offline, those of the workers it starts included, and
+  refuses its Saves, write acts and external calls with the retryable code
+  `house_trial_withheld`, so a start-up effect is not repeated; run start-up
+  effects after `settle('committed')`.
+
 ## The test host
 
 `createHouseBridgeTestHost(options)` plays House in one page: it installs a
@@ -104,4 +140,7 @@ 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
 message `message({ from, body })` plays, and hands `bridge.runtime` the MD
-Runtime client `attachRuntime(client)` gives it.
+Runtime client `attachRuntime(client)` gives it. `checkpoint()` runs the
+registered cooperation's checkpoint, persist and capture and answers the task,
+`restore(task)` runs its restore and answers its readiness check, and
+`settle(activation)` hands it the outcome.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agentshouse/app-bridge",
-  "version": "0.1.0-c58a055eeaa71",
+  "version": "0.1.0-c646d0da70608",
   "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.",
   "license": "MIT",
   "type": "module",
@@ -18,9 +18,6 @@
       "default": "./dist/test-host.js"
     }
   },
-  "dependencies": {
-    "@agentshouse/mdruntime": "0.1.0-c967d1ca66fee"
-  },
   "files": [
     "dist",
     "docs",