@client-compose/client 0.6.0 → 0.8.0

package/dist/proxy.d.ts

@@ -1,6 +1,8 @@
-import { type ActionRequest, type ActionResponse, type ClientContext, type ScreenRequest, type ScreenResponse } from "@client-compose/protocol";
+import { type ActionRequest, type ActionResponse, type ClientContext, type IslandEntry, type IslandRequest, type ScreenRequest, type ScreenResponse } from "@client-compose/protocol";
 /** A screen request from the browser: the server sets the client context. */
 export type ProxiedScreenRequest = Omit<ScreenRequest, "client">;
+/** An island request from the browser: the server sets the client context. */
+export type ProxiedIslandRequest = Omit<IslandRequest, "client">;
 /** An action request from the browser: the server sets the client context. */
 export type ProxiedActionRequest = Omit<ActionRequest, "client">;
 /** The composer's response, or the status and body it failed with. */
@@ -34,8 +36,14 @@ export interface ComposerProxy {
     performAction(body: unknown): Promise<ProxyResult<ActionResponse>>;
     /** Checks a browser's screen request, then loads it with the server's context and headers. */
     loadScreen(body: unknown): Promise<ProxyResult<ScreenResponse>>;
+    /**
+     * Checks a browser's island request (a page of an island, spec §4.5), then loads it with the
+     * server's context and headers. Resolves with the island's entry.
+     */
+    loadIsland(body: unknown): Promise<ProxyResult<IslandEntry>>;
 }
 export declare function isProxiedScreenRequest(value: unknown): value is ProxiedScreenRequest;
+export declare function isProxiedIslandRequest(value: unknown): value is ProxiedIslandRequest;
 export declare function isProxiedActionRequest(value: unknown): value is ProxiedActionRequest;
 export declare function createComposerProxy(options: ComposerProxyOptions): ComposerProxy;
 //# sourceMappingURL=proxy.d.ts.map

package/dist/proxy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"proxy.d.ts","sourceRoot":"","sources":["../src/proxy.ts"],"names":[],"mappings":"AAeA,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,cAAc,EAEnB,KAAK,aAAa,EAElB,KAAK,aAAa,EAClB,KAAK,cAAc,EACpB,MAAM,0BAA0B,CAAC;AAIlC,6EAA6E;AAC7E,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;AACjE,8EAA8E;AAC9E,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;AAEjE,sEAAsE;AACtE,MAAM,MAAM,WAAW,CAAC,CAAC,IACvB;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,QAAQ,EAAE,CAAC,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAE1E,MAAM,WAAW,oBAAoB;IACnC,yBAAyB;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,4FAA4F;IAC5F,MAAM,EAAE,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACrD,kFAAkF;IAClF,OAAO,CAAC,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACzE,qEAAqE;IACrE,WAAW,CAAC,EAAE,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpD,mEAAmE;IACnE,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IACrB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,CACjB,OAAO,EAAE,aAAa,EACtB,QAAQ,EAAE,cAAc,KACrB,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;CAC/C;AAED,MAAM,WAAW,aAAa;IAC5B,iGAAiG;IACjG,aAAa,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC;IACnE,8FAA8F;IAC9F,UAAU,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC;CACjE;AAkBD,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,oBAAoB,CAQpF;AAED,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,oBAAoB,CASpF;AASD,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,oBAAoB,GAAG,aAAa,CAsChF"}
+{"version":3,"file":"proxy.d.ts","sourceRoot":"","sources":["../src/proxy.ts"],"names":[],"mappings":"AAeA,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,cAAc,EAEnB,KAAK,aAAa,EAClB,KAAK,WAAW,EAChB,KAAK,aAAa,EAElB,KAAK,aAAa,EAClB,KAAK,cAAc,EACpB,MAAM,0BAA0B,CAAC;AAWlC,6EAA6E;AAC7E,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;AACjE,8EAA8E;AAC9E,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;AACjE,8EAA8E;AAC9E,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;AAEjE,sEAAsE;AACtE,MAAM,MAAM,WAAW,CAAC,CAAC,IACvB;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,QAAQ,EAAE,CAAC,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAE1E,MAAM,WAAW,oBAAoB;IACnC,yBAAyB;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,4FAA4F;IAC5F,MAAM,EAAE,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACrD,kFAAkF;IAClF,OAAO,CAAC,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACzE,qEAAqE;IACrE,WAAW,CAAC,EAAE,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpD,mEAAmE;IACnE,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IACrB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,CACjB,OAAO,EAAE,aAAa,EACtB,QAAQ,EAAE,cAAc,KACrB,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;CAC/C;AAED,MAAM,WAAW,aAAa;IAC5B,iGAAiG;IACjG,aAAa,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC;IACnE,8FAA8F;IAC9F,UAAU,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC;IAChE;;;OAGG;IACH,UAAU,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC;CAC9D;AAoBD,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,oBAAoB,CAWpF;AAED,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,oBAAoB,CAcpF;AAED,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,oBAAoB,CAWpF;AASD,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,oBAAoB,GAAG,aAAa,CAiFhF"}

package/dist/proxy.js

@@ -13,7 +13,7 @@
 // Errors come back as data, since frameworks often strip thrown errors' details on the way to the
 // browser.
 import { PROTOCOL_VERSION, } from "@client-compose/protocol";
-import { ActionFetchError, fetchAction, fetchScreen, ScreenFetchError } from "./index.js";
+import { ActionFetchError, fetchAction, fetchIsland, fetchScreen, IslandFetchError, ScreenFetchError, } from "./index.js";
 const isRecord = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
 function isCapabilities(value) {
     return (isRecord(value) &&
@@ -22,20 +22,45 @@ function isCapabilities(value) {
 function isStringRecord(value) {
     return isRecord(value) && Object.values(value).every((v) => typeof v === "string");
 }
+// Each guard returns at the first thing a request gets wrong, so it checks no more than it must.
 export function isProxiedScreenRequest(value) {
-    return (isRecord(value) &&
-        value.protocol === PROTOCOL_VERSION &&
-        typeof value.screen === "string" &&
-        (value.params === undefined || isStringRecord(value.params)) &&
-        isCapabilities(value.islands));
+    if (!isRecord(value) || value.protocol !== PROTOCOL_VERSION) {
+        return false;
+    }
+    if (typeof value.screen !== "string") {
+        return false;
+    }
+    if (value.params !== undefined && !isStringRecord(value.params)) {
+        return false;
+    }
+    return isCapabilities(value.islands);
+}
+export function isProxiedIslandRequest(value) {
+    if (!isRecord(value) || value.protocol !== PROTOCOL_VERSION) {
+        return false;
+    }
+    if (typeof value.screen !== "string" || typeof value.key !== "string") {
+        return false;
+    }
+    if (typeof value.version !== "number" || !Number.isInteger(value.version)) {
+        return false;
+    }
+    if (value.params !== undefined && !isStringRecord(value.params)) {
+        return false;
+    }
+    return value.cursor === undefined || typeof value.cursor === "string";
 }
 export function isProxiedActionRequest(value) {
-    return (isRecord(value) &&
-        value.protocol === PROTOCOL_VERSION &&
-        typeof value.action === "string" &&
-        typeof value.version === "number" &&
-        "input" in value &&
-        (value.idempotencyKey === undefined || typeof value.idempotencyKey === "string"));
+    if (!isRecord(value) || value.protocol !== PROTOCOL_VERSION) {
+        return false;
+    }
+    if (typeof value.action !== "string" || typeof value.version !== "number") {
+        return false;
+    }
+    if (!("input" in value)) {
+        return false;
+    }
+    return value.idempotencyKey === undefined || typeof value.idempotencyKey === "string";
 }
 /** What the composer itself answers to a malformed request. */
 const BAD_REQUEST = {
@@ -45,12 +70,16 @@ const BAD_REQUEST = {
 };
 export function createComposerProxy(options) {
     async function init() {
-        const headers = (await options.headers?.()) ?? {};
-        return { ...options.requestInit, headers: { ...options.requestInit?.headers, ...headers } };
+        const headers = new Headers(options.requestInit?.headers);
+        for (const [name, value] of Object.entries((await options.headers?.()) ?? {})) {
+            headers.set(name, value);
+        }
+        return { ...options.requestInit, headers };
     }
     async function performAction(body) {
-        if (!isProxiedActionRequest(body))
+        if (!isProxiedActionRequest(body)) {
             return BAD_REQUEST;
+        }
         const request = { ...body, client: await options.client() };
         try {
             const response = await fetchAction(options.baseUrl, request, await init(), options.fetch);
@@ -60,14 +89,20 @@ export function createComposerProxy(options) {
             };
         }
         catch (error) {
-            if (error instanceof ActionFetchError)
-                return { ok: false, status: error.status, body: error.body };
+            if (error instanceof ActionFetchError) {
+                return {
+                    ok: false,
+                    status: error.status,
+                    body: error.body,
+                };
+            }
             throw error;
         }
     }
     async function loadScreen(body) {
-        if (!isProxiedScreenRequest(body))
+        if (!isProxiedScreenRequest(body)) {
             return BAD_REQUEST;
+        }
         const request = { ...body, client: await options.client() };
         try {
             return {
@@ -76,11 +111,42 @@ export function createComposerProxy(options) {
             };
         }
         catch (error) {
-            if (error instanceof ScreenFetchError)
-                return { ok: false, status: error.status, body: error.body };
+            if (error instanceof ScreenFetchError) {
+                return {
+                    ok: false,
+                    status: error.status,
+                    body: error.body,
+                };
+            }
+            throw error;
+        }
+    }
+    async function loadIsland(body) {
+        if (!isProxiedIslandRequest(body)) {
+            return BAD_REQUEST;
+        }
+        const request = { ...body, client: await options.client() };
+        try {
+            return {
+                ok: true,
+                response: await fetchIsland(options.baseUrl, request, await init(), options.fetch),
+            };
+        }
+        catch (error) {
+            if (error instanceof IslandFetchError) {
+                return {
+                    ok: false,
+                    status: error.status,
+                    body: error.body,
+                };
+            }
             throw error;
         }
     }
-    return { performAction, loadScreen };
+    return {
+        performAction,
+        loadScreen,
+        loadIsland,
+    };
 }
 //# sourceMappingURL=proxy.js.map

package/dist/proxy.js.map

@@ -1 +1 @@
-{"version":3,"file":"proxy.js","sourceRoot":"","sources":["../src/proxy.ts"],"names":[],"mappings":"AAAA,iGAAiG;AACjG,oGAAoG;AACpG,+FAA+F;AAC/F,EAAE;AACF,0CAA0C;AAC1C,+BAA+B;AAC/B,0FAA0F;AAC1F,uFAAuF;AACvF,UAAU;AACV,+FAA+F;AAC/F,EAAE;AACF,mGAAmG;AACnG,kGAAkG;AAClG,WAAW;AAEX,OAAO,EAKL,gBAAgB,GAGjB,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAuC1F,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAoC,EAAE,CACpE,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAEvE,SAAS,cAAc,CAAC,KAAc;IACpC,OAAO,CACL,QAAQ,CAAC,KAAK,CAAC;QACf,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CACxB,CAAC,QAAQ,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CACtF,CACF,CAAC;AACJ,CAAC;AAED,SAAS,cAAc,CAAC,KAAc;IACpC,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC;AACrF,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,KAAc;IACnD,OAAO,CACL,QAAQ,CAAC,KAAK,CAAC;QACf,KAAK,CAAC,QAAQ,KAAK,gBAAgB;QACnC,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ;QAChC,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS,IAAI,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC5D,cAAc,CAAC,KAAK,CAAC,OAAO,CAAC,CAC9B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,KAAc;IACnD,OAAO,CACL,QAAQ,CAAC,KAAK,CAAC;QACf,KAAK,CAAC,QAAQ,KAAK,gBAAgB;QACnC,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ;QAChC,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ;QACjC,OAAO,IAAI,KAAK;QAChB,CAAC,KAAK,CAAC,cAAc,KAAK,SAAS,IAAI,OAAO,KAAK,CAAC,cAAc,KAAK,QAAQ,CAAC,CACjF,CAAC;AACJ,CAAC;AAED,+DAA+D;AAC/D,MAAM,WAAW,GAAG;IAClB,EAAE,EAAE,KAAK;IACT,MAAM,EAAE,GAAG;IACX,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,gBAAgB,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,EAAE,CAAC;CAC5E,CAAC;AAEX,MAAM,UAAU,mBAAmB,CAAC,OAA6B;IAC/D,KAAK,UAAU,IAAI;QACjB,MAAM,OAAO,GAAG,CAAC,MAAM,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC;QAClD,OAAO,EAAE,GAAG,OAAO,CAAC,WAAW,EAAE,OAAO,EAAE,EAAE,GAAG,OAAO,CAAC,WAAW,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,EAAE,CAAC;IAC9F,CAAC;IAED,KAAK,UAAU,aAAa,CAAC,IAAa;QACxC,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC;YAAE,OAAO,WAAW,CAAC;QACtD,MAAM,OAAO,GAAkB,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;QAC3E,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,IAAI,EAAE,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;YAC1F,OAAO;gBACL,EAAE,EAAE,IAAI;gBACR,QAAQ,EAAE,CAAC,MAAM,OAAO,CAAC,gBAAgB,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,IAAI,QAAQ;aAC5E,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,gBAAgB;gBACnC,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;YAC/D,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED,KAAK,UAAU,UAAU,CAAC,IAAa;QACrC,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC;YAAE,OAAO,WAAW,CAAC;QACtD,MAAM,OAAO,GAAkB,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;QAC3E,IAAI,CAAC;YACH,OAAO;gBACL,EAAE,EAAE,IAAI;gBACR,QAAQ,EAAE,MAAM,WAAW,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,IAAI,EAAE,EAAE,OAAO,CAAC,KAAK,CAAC;aACnF,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,gBAAgB;gBACnC,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;YAC/D,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,CAAC;AACvC,CAAC"}
+{"version":3,"file":"proxy.js","sourceRoot":"","sources":["../src/proxy.ts"],"names":[],"mappings":"AAAA,iGAAiG;AACjG,oGAAoG;AACpG,+FAA+F;AAC/F,EAAE;AACF,0CAA0C;AAC1C,+BAA+B;AAC/B,0FAA0F;AAC1F,uFAAuF;AACvF,UAAU;AACV,+FAA+F;AAC/F,EAAE;AACF,mGAAmG;AACnG,kGAAkG;AAClG,WAAW;AAEX,OAAO,EAOL,gBAAgB,GAGjB,MAAM,0BAA0B,CAAC;AAElC,OAAO,EACL,gBAAgB,EAChB,WAAW,EACX,WAAW,EACX,WAAW,EACX,gBAAgB,EAChB,gBAAgB,GACjB,MAAM,YAAY,CAAC;AA8CpB,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAoC,EAAE,CACpE,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAEvE,SAAS,cAAc,CAAC,KAAc;IACpC,OAAO,CACL,QAAQ,CAAC,KAAK,CAAC;QACf,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CACxB,CAAC,QAAQ,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CACtF,CACF,CAAC;AACJ,CAAC;AAED,SAAS,cAAc,CAAC,KAAc;IACpC,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC;AACrF,CAAC;AAED,iGAAiG;AAEjG,MAAM,UAAU,sBAAsB,CAAC,KAAc;IACnD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,QAAQ,KAAK,gBAAgB,EAAE,CAAC;QAC5D,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;QACrC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QAChE,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,cAAc,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AACvC,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,KAAc;IACnD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,QAAQ,KAAK,gBAAgB,EAAE,CAAC;QAC5D,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,IAAI,OAAO,KAAK,CAAC,GAAG,KAAK,QAAQ,EAAE,CAAC;QACtE,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;QAC1E,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QAChE,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,KAAK,CAAC,MAAM,KAAK,SAAS,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC;AACxE,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,KAAc;IACnD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,QAAQ,KAAK,gBAAgB,EAAE,CAAC;QAC5D,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC1E,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,CAAC,CAAC,OAAO,IAAI,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,KAAK,CAAC,cAAc,KAAK,SAAS,IAAI,OAAO,KAAK,CAAC,cAAc,KAAK,QAAQ,CAAC;AACxF,CAAC;AAED,+DAA+D;AAC/D,MAAM,WAAW,GAAG;IAClB,EAAE,EAAE,KAAK;IACT,MAAM,EAAE,GAAG;IACX,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,gBAAgB,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,EAAE,CAAC;CAC5E,CAAC;AAEX,MAAM,UAAU,mBAAmB,CAAC,OAA6B;IAC/D,KAAK,UAAU,IAAI;QACjB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAC1D,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;YAC9E,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC3B,CAAC;QACD,OAAO,EAAE,GAAG,OAAO,CAAC,WAAW,EAAE,OAAO,EAAE,CAAC;IAC7C,CAAC;IAED,KAAK,UAAU,aAAa,CAAC,IAAa;QACxC,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,EAAE,CAAC;YAClC,OAAO,WAAW,CAAC;QACrB,CAAC;QACD,MAAM,OAAO,GAAkB,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;QAC3E,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,IAAI,EAAE,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;YAC1F,OAAO;gBACL,EAAE,EAAE,IAAI;gBACR,QAAQ,EAAE,CAAC,MAAM,OAAO,CAAC,gBAAgB,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,IAAI,QAAQ;aAC5E,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,gBAAgB,EAAE,CAAC;gBACtC,OAAO;oBACL,EAAE,EAAE,KAAK;oBACT,MAAM,EAAE,KAAK,CAAC,MAAM;oBACpB,IAAI,EAAE,KAAK,CAAC,IAAI;iBACjB,CAAC;YACJ,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED,KAAK,UAAU,UAAU,CAAC,IAAa;QACrC,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,EAAE,CAAC;YAClC,OAAO,WAAW,CAAC;QACrB,CAAC;QACD,MAAM,OAAO,GAAkB,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;QAC3E,IAAI,CAAC;YACH,OAAO;gBACL,EAAE,EAAE,IAAI;gBACR,QAAQ,EAAE,MAAM,WAAW,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,IAAI,EAAE,EAAE,OAAO,CAAC,KAAK,CAAC;aACnF,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,gBAAgB,EAAE,CAAC;gBACtC,OAAO;oBACL,EAAE,EAAE,KAAK;oBACT,MAAM,EAAE,KAAK,CAAC,MAAM;oBACpB,IAAI,EAAE,KAAK,CAAC,IAAI;iBACjB,CAAC;YACJ,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED,KAAK,UAAU,UAAU,CAAC,IAAa;QACrC,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,EAAE,CAAC;YAClC,OAAO,WAAW,CAAC;QACrB,CAAC;QACD,MAAM,OAAO,GAAkB,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;QAC3E,IAAI,CAAC;YACH,OAAO;gBACL,EAAE,EAAE,IAAI;gBACR,QAAQ,EAAE,MAAM,WAAW,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,IAAI,EAAE,EAAE,OAAO,CAAC,KAAK,CAAC;aACnF,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,gBAAgB,EAAE,CAAC;gBACtC,OAAO;oBACL,EAAE,EAAE,KAAK;oBACT,MAAM,EAAE,KAAK,CAAC,MAAM;oBACpB,IAAI,EAAE,KAAK,CAAC,IAAI;iBACjB,CAAC;YACJ,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED,OAAO;QACL,aAAa;QACb,UAAU;QACV,UAAU;KACX,CAAC;AACJ,CAAC"}

package/dist/testing.d.ts

@@ -1,8 +1,13 @@
-import { type ActionDescriptor, type ActionEffects, type Capabilities, type ClientContext, type DeclaredError, type IslandDescriptor, type IslandEntry, type IslandError, type ScreenMeta } from "@client-compose/protocol";
-/** A response for the fake composer to send. */
+import { type ActionDescriptor, type ActionEffects, type Capabilities, type ClientContext, type DeclaredError, type IslandDescriptor, type IslandEntry, type IslandError, type PendingIsland, type ScreenMeta } from "@client-compose/protocol";
+/**
+ * A response for the fake composer to send: a JSON body, or a screen's stream (spec §4.6), as
+ * lines that come when they're given.
+ */
 export interface FakeResponse {
     status: number;
-    body: unknown;
+    body?: unknown;
+    /** Opens the stream's body, for each request answered with it. */
+    stream?: () => ReadableStream<Uint8Array>;
 }
 /** A request the fake composer received. */
 export interface RecordedRequest {
@@ -19,6 +24,15 @@ export interface RecordedScreenRequest extends RecordedRequest {
     client: ClientContext | undefined;
     islands: Capabilities;
 }
+/** An island request (spec §4.5): a page of one island, or the island resolved again. */
+export interface RecordedIslandRequest extends RecordedRequest {
+    screen: string;
+    key: string;
+    version: number;
+    params: Record<string, string>;
+    cursor: string | undefined;
+    client: ClientContext | undefined;
+}
 export interface RecordedActionRequest extends RecordedRequest {
     action: string;
     version: number;
@@ -31,6 +45,8 @@ export interface FakeGatewayHandlers {
     screens?: Record<string, (request: RecordedScreenRequest) => FakeResponse>;
     /** By action name. */
     actions?: Record<string, (request: RecordedActionRequest) => FakeResponse>;
+    /** Island requests, by `"{screen}/{key}"`. */
+    islands?: Record<string, (request: RecordedIslandRequest) => FakeResponse>;
     /** Anything else, e.g. uploads to storage: return undefined to leave a request to the others. */
     other?: (request: RecordedRequest) => FakeResponse | undefined;
 }
@@ -40,6 +56,7 @@ export interface FakeGateway {
     /** Every request received, in order. */
     requests: RecordedRequest[];
     screenRequests(): RecordedScreenRequest[];
+    islandRequests(): RecordedIslandRequest[];
     actionRequests(): RecordedActionRequest[];
 }
 /** A composer whose screens and actions are the handlers given. */
@@ -53,12 +70,38 @@ export interface InstalledFakeGateway extends FakeGateway {
  * app rendered in a test). Call `restore()` after the test.
  */
 export declare function installFakeGateway(handlers?: FakeGatewayHandlers): InstalledFakeGateway;
-/** An island in a screen response, typed by its generated descriptor. */
-export declare function island<P>(key: string, descriptor: IslandDescriptor<P>, props: P): IslandEntry<P>;
+/**
+ * An island in a screen or island response, typed by its generated descriptor. Give `next` for an
+ * island with more pages (spec §4.5).
+ */
+export declare function island<P>(key: string, descriptor: IslandDescriptor<P>, props: P, next?: string): IslandEntry<P>;
 /** An island that failed on the composer (spec §3.4). */
 export declare function islandError(key: string, descriptor: IslandDescriptor<unknown>, error: IslandError): IslandEntry;
-/** A screen response. */
+/** A screen, all of it at once: its stream's head with every island, then its end (spec §4.6). */
 export declare function screen(id: string, islands: IslandEntry<unknown>[], meta?: ScreenMeta): FakeResponse;
+/** An island still being resolved, in a streamed screen's head (spec §4.6). */
+export declare function pending(key: string, descriptor: IslandDescriptor<unknown>): PendingIsland;
+/** A streamed screen whose lines a test sends, so it controls when each island arrives. */
+export interface StreamedScreen extends FakeResponse {
+    /** Sends a pending island's entry. */
+    send(entry: IslandEntry<unknown>): void;
+    /** Sends the end line. */
+    end(): void;
+    /** Ends the stream without its end line, as a dropped connection would. */
+    cut(): void;
+}
+/**
+ * A screen whose head is sent at once, with its islands resolved or `pending(…)`, and whose other
+ * lines are sent when the test says (spec §4.6). Answer one request with it.
+ *
+ *     const results = streamedScreen("search", [island("box", BoxV1, {}), pending("results", ResultsV1)]);
+ *     // render, check the placeholder, then:
+ *     results.send(island("results", ResultsV1, { items: [] }));
+ *     results.end();
+ */
+export declare function streamedScreen(id: string, islands: (IslandEntry<unknown> | PendingIsland)[], meta?: ScreenMeta): StreamedScreen;
+/** An island response (spec §4.5): a page of one island, or the island resolved again. */
+export declare function islandResponse(screen: string, entry: IslandEntry<unknown>): FakeResponse;
 /** A screen request that fails, e.g. `screenError(404, "not_found")` or `screenError(401, "unauthenticated")`. */
 export declare function screenError(status: number, code: string): FakeResponse;
 /** An action that succeeded, with its result typed by the descriptor. */

package/dist/testing.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"testing.d.ts","sourceRoot":"","sources":["../src/testing.ts"],"names":[],"mappings":"AAYA,OAAO,EACL,KAAK,gBAAgB,EACrB,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,KAAK,aAAa,EAClB,KAAK,gBAAgB,EACrB,KAAK,WAAW,EAChB,KAAK,WAAW,EAEhB,KAAK,UAAU,EAChB,MAAM,0BAA0B,CAAC;AAElC,gDAAgD;AAChD,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,OAAO,CAAC;CACf;AAED,4CAA4C;AAC5C,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,mCAAmC;IACnC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,2FAA2F;IAC3F,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC5D,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,MAAM,EAAE,aAAa,GAAG,SAAS,CAAC;IAClC,OAAO,EAAE,YAAY,CAAC;CACvB;AAED,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC5D,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,aAAa,GAAG,SAAS,CAAC;IAClC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;CACpC;AAED,MAAM,WAAW,mBAAmB;IAClC,oBAAoB;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,qBAAqB,KAAK,YAAY,CAAC,CAAC;IAC3E,sBAAsB;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,qBAAqB,KAAK,YAAY,CAAC,CAAC;IAC3E,iGAAiG;IACjG,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,YAAY,GAAG,SAAS,CAAC;CAChE;AAED,MAAM,WAAW,WAAW;IAC1B,wFAAwF;IACxF,KAAK,EAAE,OAAO,KAAK,CAAC;IACpB,wCAAwC;IACxC,QAAQ,EAAE,eAAe,EAAE,CAAC;IAC5B,cAAc,IAAI,qBAAqB,EAAE,CAAC;IAC1C,cAAc,IAAI,qBAAqB,EAAE,CAAC;CAC3C;AAsFD,mEAAmE;AACnE,wBAAgB,iBAAiB,CAAC,QAAQ,GAAE,mBAAwB,GAAG,WAAW,CA6BjF;AAED,MAAM,WAAW,oBAAqB,SAAQ,WAAW;IACvD,mDAAmD;IACnD,OAAO,IAAI,IAAI,CAAC;CACjB;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,GAAE,mBAAwB,GAAG,oBAAoB,CAU3F;AAID,yEAAyE;AACzE,wBAAgB,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAEhG;AAED,yDAAyD;AACzD,wBAAgB,WAAW,CACzB,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,gBAAgB,CAAC,OAAO,CAAC,EACrC,KAAK,EAAE,WAAW,GACjB,WAAW,CAEb;AAED,yBAAyB;AACzB,wBAAgB,MAAM,CACpB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE,EAC/B,IAAI,CAAC,EAAE,UAAU,GAChB,YAAY,CAKd;AAED,kHAAkH;AAClH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,YAAY,CAEtE;AAED,yEAAyE;AACzE,wBAAgB,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,aAAa,EACpD,MAAM,EAAE,gBAAgB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EACjC,MAAM,EAAE,CAAC,EACT,OAAO,CAAC,EAAE,aAAa,GACtB,YAAY,CAGd;AAED,4DAA4D;AAC5D,wBAAgB,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,aAAa,EACvD,MAAM,EAAE,gBAAgB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EACjC,KAAK,EAAE,CAAC,GACP,YAAY,CAGd;AAED,uGAAuG;AACvG,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,YAAY,CAExE"}
+{"version":3,"file":"testing.d.ts","sourceRoot":"","sources":["../src/testing.ts"],"names":[],"mappings":"AAaA,OAAO,EACL,KAAK,gBAAgB,EACrB,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,KAAK,aAAa,EAClB,KAAK,gBAAgB,EACrB,KAAK,WAAW,EAChB,KAAK,WAAW,EAChB,KAAK,aAAa,EAElB,KAAK,UAAU,EAChB,MAAM,0BAA0B,CAAC;AAElC;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,kEAAkE;IAClE,MAAM,CAAC,EAAE,MAAM,cAAc,CAAC,UAAU,CAAC,CAAC;CAC3C;AAED,4CAA4C;AAC5C,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,mCAAmC;IACnC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,2FAA2F;IAC3F,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC5D,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,MAAM,EAAE,aAAa,GAAG,SAAS,CAAC;IAClC,OAAO,EAAE,YAAY,CAAC;CACvB;AAED,yFAAyF;AACzF,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC5D,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,MAAM,EAAE,aAAa,GAAG,SAAS,CAAC;CACnC;AAED,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC5D,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,aAAa,GAAG,SAAS,CAAC;IAClC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;CACpC;AAED,MAAM,WAAW,mBAAmB;IAClC,oBAAoB;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,qBAAqB,KAAK,YAAY,CAAC,CAAC;IAC3E,sBAAsB;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,qBAAqB,KAAK,YAAY,CAAC,CAAC;IAC3E,8CAA8C;IAC9C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,qBAAqB,KAAK,YAAY,CAAC,CAAC;IAC3E,iGAAiG;IACjG,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,YAAY,GAAG,SAAS,CAAC;CAChE;AAED,MAAM,WAAW,WAAW;IAC1B,wFAAwF;IACxF,KAAK,EAAE,OAAO,KAAK,CAAC;IACpB,wCAAwC;IACxC,QAAQ,EAAE,eAAe,EAAE,CAAC;IAC5B,cAAc,IAAI,qBAAqB,EAAE,CAAC;IAC1C,cAAc,IAAI,qBAAqB,EAAE,CAAC;IAC1C,cAAc,IAAI,qBAAqB,EAAE,CAAC;CAC3C;AAmID,mEAAmE;AACnE,wBAAgB,iBAAiB,CAAC,QAAQ,GAAE,mBAAwB,GAAG,WAAW,CA0CjF;AAED,MAAM,WAAW,oBAAqB,SAAQ,WAAW;IACvD,mDAAmD;IACnD,OAAO,IAAI,IAAI,CAAC;CACjB;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,GAAE,mBAAwB,GAAG,oBAAoB,CAU3F;AAID;;;GAGG;AACH,wBAAgB,MAAM,CAAC,CAAC,EACtB,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAC/B,KAAK,EAAE,CAAC,EACR,IAAI,CAAC,EAAE,MAAM,GACZ,WAAW,CAAC,CAAC,CAAC,CAShB;AAED,yDAAyD;AACzD,wBAAgB,WAAW,CACzB,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,gBAAgB,CAAC,OAAO,CAAC,EACrC,KAAK,EAAE,WAAW,GACjB,WAAW,CAQb;AAED,kGAAkG;AAClG,wBAAgB,MAAM,CACpB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE,EAC/B,IAAI,CAAC,EAAE,UAAU,GAChB,YAAY,CAYd;AAED,+EAA+E;AAC/E,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,gBAAgB,CAAC,OAAO,CAAC,GAAG,aAAa,CAOzF;AAED,2FAA2F;AAC3F,MAAM,WAAW,cAAe,SAAQ,YAAY;IAClD,sCAAsC;IACtC,IAAI,CAAC,KAAK,EAAE,WAAW,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;IACxC,0BAA0B;IAC1B,GAAG,IAAI,IAAI,CAAC;IACZ,2EAA2E;IAC3E,GAAG,IAAI,IAAI,CAAC;CACb;AAED;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAC5B,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,aAAa,CAAC,EAAE,EACjD,IAAI,CAAC,EAAE,UAAU,GAChB,cAAc,CA6ChB;AAcD,0FAA0F;AAC1F,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,CAAC,OAAO,CAAC,GAAG,YAAY,CASxF;AAED,kHAAkH;AAClH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,YAAY,CAEtE;AAED,yEAAyE;AACzE,wBAAgB,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,aAAa,EACpD,MAAM,EAAE,gBAAgB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EACjC,MAAM,EAAE,CAAC,EACT,OAAO,CAAC,EAAE,aAAa,GACtB,YAAY,CAed;AAED,4DAA4D;AAC5D,wBAAgB,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,aAAa,EACvD,MAAM,EAAE,gBAAgB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EACjC,KAAK,EAAE,CAAC,GACP,YAAY,CAcd;AAED,uGAAuG;AACvG,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,YAAY,CAExE"}

package/dist/testing.js

@@ -5,6 +5,7 @@
 //     const gateway = createFakeGateway({
 //       screens: { profile: () => screen("profile", [island("header", ProfileHeaderV1, { name: "Ada" })]) },
 //       actions: { follow: () => actionOk(FollowUserV1, { followers: 8 }) },
+//       islands: { "profile/posts": (r) => islandResponse("profile", island("posts", PostsV1, …, "page:3")) },
 //     });
 //     // pass gateway.fetch as the client's fetch, then assert on gateway.actionRequests()
 //
@@ -12,13 +13,15 @@
 import { PROTOCOL_VERSION, } from "@client-compose/protocol";
 const isRecord = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
 function strings(value) {
-    if (!isRecord(value))
+    if (!isRecord(value)) {
         return {};
+    }
     return Object.fromEntries(Object.entries(value).filter((e) => typeof e[1] === "string"));
 }
 function capabilities(value) {
-    if (!isRecord(value))
+    if (!isRecord(value)) {
         return {};
+    }
     return Object.fromEntries(Object.entries(value).map(([type, versions]) => [
         type,
         Array.isArray(versions) ? versions.filter((v) => typeof v === "number") : [],
@@ -27,13 +30,19 @@ function capabilities(value) {
 function clientContext(value) {
     if (!isRecord(value) ||
         typeof value.platform !== "string" ||
-        typeof value.appVersion !== "string")
+        typeof value.appVersion !== "string") {
         return undefined;
-    return { ...value, platform: value.platform, appVersion: value.appVersion };
+    }
+    return {
+        ...value,
+        platform: value.platform,
+        appVersion: value.appVersion,
+    };
 }
 function parseBody(body) {
-    if (typeof body !== "string")
+    if (typeof body !== "string") {
         return body;
+    }
     try {
         return JSON.parse(body);
     }
@@ -42,8 +51,9 @@ function parseBody(body) {
     }
 }
 function urlOf(input) {
-    if (typeof input === "string")
+    if (typeof input === "string") {
         return input;
+    }
     return input instanceof URL ? input.href : input.url;
 }
 function headersOf(init) {
@@ -51,10 +61,15 @@ function headersOf(init) {
     new Headers(init).forEach((value, name) => (out[name] = value));
     return out;
 }
+function isIslandURL(url) {
+    return /\/screens\/[^/]+\/islands\/[^/?]+/.test(url);
+}
 function asScreenRequest(request) {
     const { body } = request;
-    if (!request.url.includes("/screens/") || !isRecord(body) || typeof body.screen !== "string")
+    const isScreen = request.url.includes("/screens/") && !isIslandURL(request.url);
+    if (!isScreen || !isRecord(body) || typeof body.screen !== "string") {
         return undefined;
+    }
     return {
         ...request,
         screen: body.screen,
@@ -63,10 +78,29 @@ function asScreenRequest(request) {
         islands: capabilities(body.islands),
     };
 }
+function asIslandRequest(request) {
+    const { body } = request;
+    if (!isIslandURL(request.url) || !isRecord(body)) {
+        return undefined;
+    }
+    if (typeof body.screen !== "string" || typeof body.key !== "string") {
+        return undefined;
+    }
+    return {
+        ...request,
+        screen: body.screen,
+        key: body.key,
+        version: typeof body.version === "number" ? body.version : 0,
+        params: strings(body.params),
+        cursor: typeof body.cursor === "string" ? body.cursor : undefined,
+        client: clientContext(body.client),
+    };
+}
 function asActionRequest(request) {
     const { body } = request;
-    if (!request.url.includes("/actions/") || !isRecord(body) || typeof body.action !== "string")
+    if (!request.url.includes("/actions/") || !isRecord(body) || typeof body.action !== "string") {
         return undefined;
+    }
     return {
         ...request,
         action: body.action,
@@ -77,6 +111,12 @@ function asActionRequest(request) {
     };
 }
 function respond(response) {
+    if (response.stream) {
+        return new Response(response.stream(), {
+            status: response.status,
+            headers: { "content-type": "application/jsonl" },
+        });
+    }
     return new Response(JSON.stringify(response.body), {
         status: response.status,
         headers: { "content-type": "application/json" },
@@ -94,22 +134,31 @@ export function createFakeGateway(handlers = {}) {
         };
         requests.push(request);
         const other = handlers.other?.(request);
-        if (other)
+        if (other) {
             return respond(other);
+        }
+        const islandRequest = asIslandRequest(request);
+        const islandHandler = islandRequest && handlers.islands?.[`${islandRequest.screen}/${islandRequest.key}`];
+        if (islandRequest && islandHandler) {
+            return respond(islandHandler(islandRequest));
+        }
         const screenRequest = asScreenRequest(request);
         const screenHandler = screenRequest && handlers.screens?.[screenRequest.screen];
-        if (screenRequest && screenHandler)
+        if (screenRequest && screenHandler) {
             return respond(screenHandler(screenRequest));
+        }
         const actionRequest = asActionRequest(request);
         const actionHandler = actionRequest && handlers.actions?.[actionRequest.action];
-        if (actionRequest && actionHandler)
+        if (actionRequest && actionHandler) {
             return respond(actionHandler(actionRequest));
+        }
         throw new Error(`fake gateway: no handler for ${request.method} ${request.url} ${JSON.stringify(request.body)}`);
     }
     return {
         fetch: fakeFetch,
         requests,
         screenRequests: () => requests.flatMap((r) => asScreenRequest(r) ?? []),
+        islandRequests: () => requests.flatMap((r) => asIslandRequest(r) ?? []),
         actionRequests: () => requests.flatMap((r) => asActionRequest(r) ?? []),
     };
 }
@@ -129,19 +178,128 @@ export function installFakeGateway(handlers = {}) {
     };
 }
 // ---- Responses ----
-/** An island in a screen response, typed by its generated descriptor. */
-export function island(key, descriptor, props) {
-    return { key, type: descriptor.type, version: descriptor.version, status: "ok", props };
+/**
+ * An island in a screen or island response, typed by its generated descriptor. Give `next` for an
+ * island with more pages (spec §4.5).
+ */
+export function island(key, descriptor, props, next) {
+    return {
+        key,
+        type: descriptor.type,
+        version: descriptor.version,
+        status: "ok",
+        props,
+        ...(next !== undefined && { next }),
+    };
 }
 /** An island that failed on the composer (spec §3.4). */
 export function islandError(key, descriptor, error) {
-    return { key, type: descriptor.type, version: descriptor.version, status: "error", error };
+    return {
+        key,
+        type: descriptor.type,
+        version: descriptor.version,
+        status: "error",
+        error,
+    };
 }
-/** A screen response. */
+/** A screen, all of it at once: its stream's head with every island, then its end (spec §4.6). */
 export function screen(id, islands, meta) {
+    const head = {
+        kind: "head",
+        protocol: PROTOCOL_VERSION,
+        screen: id,
+        islands,
+        ...(meta && { meta }),
+    };
     return {
         status: 200,
-        body: { protocol: PROTOCOL_VERSION, screen: id, islands, ...(meta && { meta }) },
+        stream: () => linesStream([head, { kind: "end" }]),
+    };
+}
+/** An island still being resolved, in a streamed screen's head (spec §4.6). */
+export function pending(key, descriptor) {
+    return {
+        key,
+        type: descriptor.type,
+        version: descriptor.version,
+        status: "pending",
+    };
+}
+/**
+ * A screen whose head is sent at once, with its islands resolved or `pending(…)`, and whose other
+ * lines are sent when the test says (spec §4.6). Answer one request with it.
+ *
+ *     const results = streamedScreen("search", [island("box", BoxV1, {}), pending("results", ResultsV1)]);
+ *     // render, check the placeholder, then:
+ *     results.send(island("results", ResultsV1, { items: [] }));
+ *     results.end();
+ */
+export function streamedScreen(id, islands, meta) {
+    const encoder = new TextEncoder();
+    const queued = [];
+    let controller;
+    let closed = false;
+    const write = (line) => {
+        const text = `${JSON.stringify(line)}\n`;
+        if (controller) {
+            controller.enqueue(encoder.encode(text));
+        }
+        else {
+            queued.push(text);
+        }
+    };
+    const close = () => {
+        closed = true;
+        controller?.close();
+    };
+    write({
+        kind: "head",
+        protocol: PROTOCOL_VERSION,
+        screen: id,
+        islands,
+        ...(meta && { meta }),
+    });
+    return {
+        status: 200,
+        stream: () => new ReadableStream({
+            start(c) {
+                controller = c;
+                for (const text of queued.splice(0)) {
+                    c.enqueue(encoder.encode(text));
+                }
+                if (closed) {
+                    c.close();
+                }
+            },
+        }),
+        send: (entry) => write({ kind: "island", island: entry }),
+        end: () => {
+            write({ kind: "end" });
+            close();
+        },
+        cut: close,
+    };
+}
+function linesStream(lines) {
+    const encoder = new TextEncoder();
+    return new ReadableStream({
+        start(controller) {
+            for (const line of lines) {
+                controller.enqueue(encoder.encode(`${JSON.stringify(line)}\n`));
+            }
+            controller.close();
+        },
+    });
+}
+/** An island response (spec §4.5): a page of one island, or the island resolved again. */
+export function islandResponse(screen, entry) {
+    return {
+        status: 200,
+        body: {
+            protocol: PROTOCOL_VERSION,
+            screen,
+            island: entry,
+        },
     };
 }
 /** A screen request that fails, e.g. `screenError(404, "not_found")` or `screenError(401, "unauthenticated")`. */
@@ -150,13 +308,36 @@ export function screenError(status, code) {
 }
 /** An action that succeeded, with its result typed by the descriptor. */
 export function actionOk(action, result, effects) {
-    const base = { protocol: PROTOCOL_VERSION, action: action.action, version: action.version };
-    return { status: 200, body: { ...base, status: "ok", result, ...(effects && { effects }) } };
+    const base = {
+        protocol: PROTOCOL_VERSION,
+        action: action.action,
+        version: action.version,
+    };
+    return {
+        status: 200,
+        body: {
+            ...base,
+            status: "ok",
+            result,
+            ...(effects && { effects }),
+        },
+    };
 }
 /** An action that ended with one of its declared errors. */
 export function actionError(action, error) {
-    const base = { protocol: PROTOCOL_VERSION, action: action.action, version: action.version };
-    return { status: 200, body: { ...base, status: "error", error } };
+    const base = {
+        protocol: PROTOCOL_VERSION,
+        action: action.action,
+        version: action.version,
+    };
+    return {
+        status: 200,
+        body: {
+            ...base,
+            status: "error",
+            error,
+        },
+    };
 }
 /** An action the composer didn't perform, e.g. `actionFailure(401, "unauthenticated")` (spec §5.4). */
 export function actionFailure(status, code) {