@solarpunkltd/swarm-id 0.8.2 → 0.9.0

package/dist/types.d.ts

@@ -665,52 +665,357 @@ export declare const AppMetadataSchema: z.ZodObject<{
     icon: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export type AppMetadata = z.infer<typeof AppMetadataSchema>;
-export declare const ButtonConfigSchema: z.ZodOptional<z.ZodObject<{
-    connectText: z.ZodOptional<z.ZodString>;
-    disconnectText: z.ZodOptional<z.ZodString>;
-    loadingText: z.ZodOptional<z.ZodString>;
+/**
+ * What a mounted Swarm ID button does. Both open the connect window: signed
+ * out it signs the person in, signed in it is where they change the stamp the
+ * site uses, which the window asks for on every connect.
+ */
+export declare const ButtonActionSchema: z.ZodEnum<{
+    "sign-in": "sign-in";
+    "change-stamp": "change-stamp";
+}>;
+export type ButtonAction = z.infer<typeof ButtonActionSchema>;
+/**
+ * A font file's URL: https, or http on a loopback host for local work, with
+ * no user name or password in it. The button frame takes loopback http only
+ * in a development build.
+ */
+export declare function isButtonFontUrl(value: string): boolean;
+export declare const ButtonFontFaceSchema: z.ZodObject<{
+    family: z.ZodString;
+    url: z.ZodString;
+    weight: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+    style: z.ZodOptional<z.ZodEnum<{
+        normal: "normal";
+        italic: "italic";
+        oblique: "oblique";
+    }>>;
+}, z.core.$strip>;
+/**
+ * A font file the button frame loads itself, so the label can use a family
+ * the site serves. It is fetched cross-origin from Swarm ID's frame, so the
+ * site serves it with an `Access-Control-Allow-Origin` that names Swarm ID's
+ * origin. Name `family` in `fontFamily` too, ahead of a fallback.
+ */
+export type ButtonFontFace = z.infer<typeof ButtonFontFaceSchema>;
+export declare const ButtonConfigSchema: z.ZodObject<{
+    text: z.ZodOptional<z.ZodString>;
+    busyText: z.ZodOptional<z.ZodString>;
+    ariaLabel: z.ZodOptional<z.ZodString>;
+    disabled: z.ZodOptional<z.ZodBoolean>;
+    busy: z.ZodOptional<z.ZodBoolean>;
     backgroundColor: z.ZodOptional<z.ZodString>;
     color: z.ZodOptional<z.ZodString>;
     borderRadius: z.ZodOptional<z.ZodString>;
+    borderColor: z.ZodOptional<z.ZodString>;
+    borderWidth: z.ZodOptional<z.ZodString>;
+    borderStyle: z.ZodOptional<z.ZodEnum<{
+        solid: "solid";
+        dashed: "dashed";
+        dotted: "dotted";
+        double: "double";
+    }>>;
     fontFamily: z.ZodOptional<z.ZodString>;
     fontSize: z.ZodOptional<z.ZodString>;
     fontWeight: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
-}, z.core.$strip>>;
+    fontFaces: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        family: z.ZodString;
+        url: z.ZodString;
+        weight: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+        style: z.ZodOptional<z.ZodEnum<{
+            normal: "normal";
+            italic: "italic";
+            oblique: "oblique";
+        }>>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+/**
+ * How a mounted Swarm ID button looks and reads. It is painted inside Swarm
+ * ID's own frame, where the site's CSS cannot reach, so everything the site
+ * wants it to match is said here. The button fills the frame, which fills the
+ * site's container, and text that does not fit ends in an ellipsis.
+ */
 export interface ButtonConfig {
-    connectText?: string;
-    disconnectText?: string;
-    loadingText?: string;
+    /** The label. Default: "Sign in with Swarm ID", or "Change stamp in Swarm ID" */
+    text?: string;
+    /** The label while the connect window is open or `busy` is set. Default: "Waiting for Swarm ID" */
+    busyText?: string;
+    /** The accessible name, where the label alone does not say what the button does. Default: the label */
+    ariaLabel?: string;
+    /** Shown but not clickable */
+    disabled?: boolean;
+    /** Shown as working and not clickable, for a step of the site's own, such as signing out */
+    busy?: boolean;
+    /** CSS colour. Default: "#dd7200" */
     backgroundColor?: string;
+    /** CSS colour of the label. Default: "white" */
     color?: string;
+    /** CSS border-radius of the button and its frame. Default: "0" */
     borderRadius?: string;
+    /**
+     * CSS colour of a border, for a secondary style. Naming this or
+     * `borderWidth` draws one, kept in the busy and disabled looks. Default: the
+     * label's colour
+     */
+    borderColor?: string;
+    /** CSS width of the border. Default: "1px" once a border is drawn */
+    borderWidth?: string;
+    /** Default: "solid" */
+    borderStyle?: "solid" | "dashed" | "dotted" | "double";
+    /** CSS font-family. A stack falls back to the first family the frame has, not the page. Default: the frame's own */
     fontFamily?: string;
+    /** CSS font-size. Default: "14px" */
     fontSize?: string;
+    /** CSS font-weight, a keyword or a number. Default: "600" */
     fontWeight?: string | number;
+    /**
+     * Font files the frame loads for the label, at most 8. A file that does not
+     * load leaves the label in the next family of `fontFamily`, and the frame
+     * says so once in the console
+     */
+    fontFaces?: ButtonFontFace[];
 }
-export declare const ParentIdentifyMessageSchema: z.ZodObject<{
-    type: z.ZodLiteral<"parentIdentify">;
-    requestId: z.ZodString;
-    beeApiUrl: z.ZodOptional<z.ZodString>;
+/** Where a mounted button's connect window is. `blocked`: the browser refused to open it */
+export declare const ButtonWindowStateSchema: z.ZodEnum<{
+    open: "open";
+    closed: "closed";
+    blocked: "blocked";
+}>;
+export type ButtonWindowState = z.infer<typeof ButtonWindowStateSchema>;
+/** What `SwarmIdClient.mountButton` takes */
+export interface MountButtonOptions {
+    action: ButtonAction;
+    config?: ButtonConfig;
+    /**
+     * Called when the button's connect window opens, closes or is blocked, for
+     * example to say that the browser blocked it.
+     */
+    onWindowChange?: (state: ButtonWindowState) => void;
+}
+/** A mounted Swarm ID button */
+export interface MountedButton {
+    /**
+     * Resolves once the button is shown. Rejects with `init-failed` when Swarm
+     * ID refuses the site or the frame does not answer in time.
+     */
+    ready: Promise<void>;
+    /** Change what the button does or how it looks, in place. Does nothing once unmounted */
+    update(options: {
+        action?: ButtonAction;
+        config?: ButtonConfig;
+    }): void;
+    /** Remove the button. The session stays as it is, and `onWindowChange` is not called again */
+    unmount(): void;
+}
+export declare const ButtonIdentifyMessageSchema: z.ZodObject<{
+    type: z.ZodLiteral<"buttonIdentify">;
+    action: z.ZodEnum<{
+        "sign-in": "sign-in";
+        "change-stamp": "change-stamp";
+    }>;
+    config: z.ZodOptional<z.ZodObject<{
+        text: z.ZodOptional<z.ZodString>;
+        busyText: z.ZodOptional<z.ZodString>;
+        ariaLabel: z.ZodOptional<z.ZodString>;
+        disabled: z.ZodOptional<z.ZodBoolean>;
+        busy: z.ZodOptional<z.ZodBoolean>;
+        backgroundColor: z.ZodOptional<z.ZodString>;
+        color: z.ZodOptional<z.ZodString>;
+        borderRadius: z.ZodOptional<z.ZodString>;
+        borderColor: z.ZodOptional<z.ZodString>;
+        borderWidth: z.ZodOptional<z.ZodString>;
+        borderStyle: z.ZodOptional<z.ZodEnum<{
+            solid: "solid";
+            dashed: "dashed";
+            dotted: "dotted";
+            double: "double";
+        }>>;
+        fontFamily: z.ZodOptional<z.ZodString>;
+        fontSize: z.ZodOptional<z.ZodString>;
+        fontWeight: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+        fontFaces: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            family: z.ZodString;
+            url: z.ZodString;
+            weight: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+            style: z.ZodOptional<z.ZodEnum<{
+                normal: "normal";
+                italic: "italic";
+                oblique: "oblique";
+            }>>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+    metadata: z.ZodObject<{
+        name: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        icon: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
     popupMode: z.ZodOptional<z.ZodEnum<{
         popup: "popup";
         window: "window";
     }>>;
+}, z.core.$strip>;
+export declare const ButtonUpdateMessageSchema: z.ZodObject<{
+    type: z.ZodLiteral<"buttonUpdate">;
+    action: z.ZodEnum<{
+        "sign-in": "sign-in";
+        "change-stamp": "change-stamp";
+    }>;
+    config: z.ZodOptional<z.ZodObject<{
+        text: z.ZodOptional<z.ZodString>;
+        busyText: z.ZodOptional<z.ZodString>;
+        ariaLabel: z.ZodOptional<z.ZodString>;
+        disabled: z.ZodOptional<z.ZodBoolean>;
+        busy: z.ZodOptional<z.ZodBoolean>;
+        backgroundColor: z.ZodOptional<z.ZodString>;
+        color: z.ZodOptional<z.ZodString>;
+        borderRadius: z.ZodOptional<z.ZodString>;
+        borderColor: z.ZodOptional<z.ZodString>;
+        borderWidth: z.ZodOptional<z.ZodString>;
+        borderStyle: z.ZodOptional<z.ZodEnum<{
+            solid: "solid";
+            dashed: "dashed";
+            dotted: "dotted";
+            double: "double";
+        }>>;
+        fontFamily: z.ZodOptional<z.ZodString>;
+        fontSize: z.ZodOptional<z.ZodString>;
+        fontWeight: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+        fontFaces: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            family: z.ZodString;
+            url: z.ZodString;
+            weight: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+            style: z.ZodOptional<z.ZodEnum<{
+                normal: "normal";
+                italic: "italic";
+                oblique: "oblique";
+            }>>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const ParentToButtonMessageSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"buttonIdentify">;
+    action: z.ZodEnum<{
+        "sign-in": "sign-in";
+        "change-stamp": "change-stamp";
+    }>;
+    config: z.ZodOptional<z.ZodObject<{
+        text: z.ZodOptional<z.ZodString>;
+        busyText: z.ZodOptional<z.ZodString>;
+        ariaLabel: z.ZodOptional<z.ZodString>;
+        disabled: z.ZodOptional<z.ZodBoolean>;
+        busy: z.ZodOptional<z.ZodBoolean>;
+        backgroundColor: z.ZodOptional<z.ZodString>;
+        color: z.ZodOptional<z.ZodString>;
+        borderRadius: z.ZodOptional<z.ZodString>;
+        borderColor: z.ZodOptional<z.ZodString>;
+        borderWidth: z.ZodOptional<z.ZodString>;
+        borderStyle: z.ZodOptional<z.ZodEnum<{
+            solid: "solid";
+            dashed: "dashed";
+            dotted: "dotted";
+            double: "double";
+        }>>;
+        fontFamily: z.ZodOptional<z.ZodString>;
+        fontSize: z.ZodOptional<z.ZodString>;
+        fontWeight: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+        fontFaces: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            family: z.ZodString;
+            url: z.ZodString;
+            weight: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+            style: z.ZodOptional<z.ZodEnum<{
+                normal: "normal";
+                italic: "italic";
+                oblique: "oblique";
+            }>>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
     metadata: z.ZodObject<{
         name: z.ZodString;
         description: z.ZodOptional<z.ZodString>;
         icon: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>;
-    buttonConfig: z.ZodOptional<z.ZodObject<{
-        connectText: z.ZodOptional<z.ZodString>;
-        disconnectText: z.ZodOptional<z.ZodString>;
-        loadingText: z.ZodOptional<z.ZodString>;
+    popupMode: z.ZodOptional<z.ZodEnum<{
+        popup: "popup";
+        window: "window";
+    }>>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"buttonUpdate">;
+    action: z.ZodEnum<{
+        "sign-in": "sign-in";
+        "change-stamp": "change-stamp";
+    }>;
+    config: z.ZodOptional<z.ZodObject<{
+        text: z.ZodOptional<z.ZodString>;
+        busyText: z.ZodOptional<z.ZodString>;
+        ariaLabel: z.ZodOptional<z.ZodString>;
+        disabled: z.ZodOptional<z.ZodBoolean>;
+        busy: z.ZodOptional<z.ZodBoolean>;
         backgroundColor: z.ZodOptional<z.ZodString>;
         color: z.ZodOptional<z.ZodString>;
         borderRadius: z.ZodOptional<z.ZodString>;
+        borderColor: z.ZodOptional<z.ZodString>;
+        borderWidth: z.ZodOptional<z.ZodString>;
+        borderStyle: z.ZodOptional<z.ZodEnum<{
+            solid: "solid";
+            dashed: "dashed";
+            dotted: "dotted";
+            double: "double";
+        }>>;
         fontFamily: z.ZodOptional<z.ZodString>;
         fontSize: z.ZodOptional<z.ZodString>;
         fontWeight: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+        fontFaces: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            family: z.ZodString;
+            url: z.ZodString;
+            weight: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+            style: z.ZodOptional<z.ZodEnum<{
+                normal: "normal";
+                italic: "italic";
+                oblique: "oblique";
+            }>>;
+        }, z.core.$strip>>>;
     }, z.core.$strip>>;
+}, z.core.$strip>], "type">;
+export type ParentToButtonMessage = z.infer<typeof ParentToButtonMessageSchema>;
+export declare const ButtonToParentMessageSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"buttonReady">;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"buttonInitError">;
+    error: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"buttonWindowChanged">;
+    state: z.ZodEnum<{
+        open: "open";
+        closed: "closed";
+        blocked: "blocked";
+    }>;
+}, z.core.$strip>], "type">;
+export type ButtonToParentMessage = z.infer<typeof ButtonToParentMessageSchema>;
+/**
+ * The button frame telling the session frames beside it that it opened a
+ * connect window under this challenge, so the handover that comes back under
+ * it is theirs to take.
+ */
+export declare const ConnectWindowOpenedMessageSchema: z.ZodObject<{
+    type: z.ZodLiteral<"connectWindowOpened">;
+    challenge: z.ZodString;
+}, z.core.$strip>;
+export type ConnectWindowOpenedMessage = z.infer<typeof ConnectWindowOpenedMessageSchema>;
+/**
+ * Sent by the button frame on a wildcard origin the moment it loads, before
+ * the parent has identified itself, so outside the unions above, as
+ * `proxyInitialized` is.
+ */
+export declare const BUTTON_FRAME_LOADED = "buttonFrameLoaded";
+export declare const ParentIdentifyMessageSchema: z.ZodObject<{
+    type: z.ZodLiteral<"parentIdentify">;
+    requestId: z.ZodString;
+    beeApiUrl: z.ZodOptional<z.ZodString>;
+    metadata: z.ZodObject<{
+        name: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        icon: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
     subsidisedGatewayUrl: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export declare const CheckAuthMessageSchema: z.ZodObject<{
@@ -1295,38 +1600,15 @@ export declare const GetPostageBatchMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"getPostageBatch">;
     requestId: z.ZodString;
 }, z.core.$strip>;
-export declare const ConnectMessageSchema: z.ZodObject<{
-    type: z.ZodLiteral<"connect">;
-    requestId: z.ZodString;
-    popupMode: z.ZodOptional<z.ZodEnum<{
-        popup: "popup";
-        window: "window";
-    }>>;
-}, z.core.$strip>;
 export declare const ParentToIframeMessageSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     type: z.ZodLiteral<"parentIdentify">;
     requestId: z.ZodString;
     beeApiUrl: z.ZodOptional<z.ZodString>;
-    popupMode: z.ZodOptional<z.ZodEnum<{
-        popup: "popup";
-        window: "window";
-    }>>;
     metadata: z.ZodObject<{
         name: z.ZodString;
         description: z.ZodOptional<z.ZodString>;
         icon: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>;
-    buttonConfig: z.ZodOptional<z.ZodObject<{
-        connectText: z.ZodOptional<z.ZodString>;
-        disconnectText: z.ZodOptional<z.ZodString>;
-        loadingText: z.ZodOptional<z.ZodString>;
-        backgroundColor: z.ZodOptional<z.ZodString>;
-        color: z.ZodOptional<z.ZodString>;
-        borderRadius: z.ZodOptional<z.ZodString>;
-        fontFamily: z.ZodOptional<z.ZodString>;
-        fontSize: z.ZodOptional<z.ZodString>;
-        fontWeight: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
-    }, z.core.$strip>>;
     subsidisedGatewayUrl: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>, z.ZodObject<{
     type: z.ZodLiteral<"checkAuth">;
@@ -1835,13 +2117,6 @@ export declare const ParentToIframeMessageSchema: z.ZodDiscriminatedUnion<[z.Zod
 }, z.core.$strip>, z.ZodObject<{
     type: z.ZodLiteral<"getPostageBatch">;
     requestId: z.ZodString;
-}, z.core.$strip>, z.ZodObject<{
-    type: z.ZodLiteral<"connect">;
-    requestId: z.ZodString;
-    popupMode: z.ZodOptional<z.ZodEnum<{
-        popup: "popup";
-        window: "window";
-    }>>;
 }, z.core.$strip>], "type">;
 export type ParentIdentifyMessage = z.infer<typeof ParentIdentifyMessageSchema>;
 export type CheckAuthMessage = z.infer<typeof CheckAuthMessageSchema>;
@@ -1886,7 +2161,6 @@ export type ActAddGranteesMessage = z.infer<typeof ActAddGranteesMessageSchema>;
 export type ActRevokeGranteesMessage = z.infer<typeof ActRevokeGranteesMessageSchema>;
 export type ActGetGranteesMessage = z.infer<typeof ActGetGranteesMessageSchema>;
 export type GetPostageBatchMessage = z.infer<typeof GetPostageBatchMessageSchema>;
-export type ConnectMessage = z.infer<typeof ConnectMessageSchema>;
 export type ParentToIframeMessage = z.infer<typeof ParentToIframeMessageSchema>;
 export declare const ProxyReadyMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"proxyReady">;
@@ -2030,6 +2304,7 @@ export declare const SwarmIdErrorCodeSchema: z.ZodEnum<{
     "invalid-state": "invalid-state";
     "init-failed": "init-failed";
     "popup-blocked": "popup-blocked";
+    "button-required": "button-required";
     internal: "internal";
 }>;
 export type SwarmIdErrorCode = z.infer<typeof SwarmIdErrorCodeSchema>;
@@ -2048,6 +2323,7 @@ export declare const WireErrorSchema: z.ZodObject<{
         "invalid-state": "invalid-state";
         "init-failed": "init-failed";
         "popup-blocked": "popup-blocked";
+        "button-required": "button-required";
         internal: "internal";
     }>>;
     reason: z.ZodCatch<z.ZodOptional<z.ZodEnum<{
@@ -2081,6 +2357,7 @@ export declare const ErrorMessageSchema: z.ZodObject<{
         "invalid-state": "invalid-state";
         "init-failed": "init-failed";
         "popup-blocked": "popup-blocked";
+        "button-required": "button-required";
         internal: "internal";
     }>>;
     reason: z.ZodCatch<z.ZodOptional<z.ZodEnum<{
@@ -2148,11 +2425,6 @@ export declare const ConnectionInfoChangedMessageSchema: z.ZodObject<{
     beeApiUrl: z.ZodOptional<z.ZodString>;
     postageBatchId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
-export declare const ConnectResponseMessageSchema: z.ZodObject<{
-    type: z.ZodLiteral<"connectResponse">;
-    requestId: z.ZodString;
-    success: z.ZodBoolean;
-}, z.core.$strip>;
 export declare const IsConnectedResponseMessageSchema: z.ZodObject<{
     type: z.ZodLiteral<"isConnectedResponse">;
     requestId: z.ZodString;
@@ -2451,6 +2723,7 @@ export declare const IframeToParentMessageSchema: z.ZodDiscriminatedUnion<[z.Zod
         "invalid-state": "invalid-state";
         "init-failed": "init-failed";
         "popup-blocked": "popup-blocked";
+        "button-required": "button-required";
         internal: "internal";
     }>>;
     reason: z.ZodCatch<z.ZodOptional<z.ZodEnum<{
@@ -2516,10 +2789,6 @@ export declare const IframeToParentMessageSchema: z.ZodDiscriminatedUnion<[z.Zod
     }, z.core.$strip>>;
     beeApiUrl: z.ZodOptional<z.ZodString>;
     postageBatchId: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>, z.ZodObject<{
-    type: z.ZodLiteral<"connectResponse">;
-    requestId: z.ZodString;
-    success: z.ZodBoolean;
 }, z.core.$strip>, z.ZodObject<{
     type: z.ZodLiteral<"isConnectedResponse">;
     requestId: z.ZodString;
@@ -2714,7 +2983,6 @@ export type DownloadChunkResponseMessage = z.infer<typeof DownloadChunkResponseM
 export type UploadProgressMessage = z.infer<typeof UploadProgressMessageSchema>;
 export type ErrorMessage = z.infer<typeof ErrorMessageSchema>;
 export type ConnectionInfoChangedMessage = z.infer<typeof ConnectionInfoChangedMessageSchema>;
-export type ConnectResponseMessage = z.infer<typeof ConnectResponseMessageSchema>;
 export type IsConnectedResponseMessage = z.infer<typeof IsConnectedResponseMessageSchema>;
 export type GetNodeInfoResponseMessage = z.infer<typeof GetNodeInfoResponseMessageSchema>;
 export type GsocMineResponseMessage = z.infer<typeof GsocMineResponseMessageSchema>;
@@ -2930,6 +3198,11 @@ export declare const SetSecretMessageSchema: z.ZodObject<{
         stampPending: z.ZodOptional<z.ZodLiteral<true>>;
     }, z.core.$strip>;
 }, z.core.$strip>;
+/**
+ * What the connect popup posts to the session frame. The popup was opened by
+ * the button frame, and posts to the Swarm ID frames beside its opener
+ * (`ui/src/lib/handover-targets.ts`).
+ */
 export declare const PopupToIframeMessageSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     type: z.ZodLiteral<"setSecret">;
     appOrigin: z.ZodString;
@@ -3024,8 +3297,6 @@ export interface ClientOptions {
     onConnectionChange?: (info: ConnectionInfo) => void;
     popupMode?: "popup" | "window";
     metadata: AppMetadata;
-    buttonConfig?: ButtonConfig;
-    containerId?: string;
     /** URL of a subsidised gateway for users without postage stamps. Gateway handles stamping server-side. */
     subsidisedGatewayUrl?: string;
     /**

package/dist/utils/button-view.d.ts

@@ -0,0 +1,16 @@
+import type { ButtonAction, ButtonConfig } from "../types";
+/** What the button frame paints, worked out from what the site asked for */
+export interface ButtonView {
+    text: string;
+    /** Set only when the site gave one, so the label is the name otherwise */
+    ariaLabel: string | undefined;
+    disabled: boolean;
+    busy: boolean;
+    style: Record<string, string>;
+}
+/**
+ * The button for `action` as `config` asks, busy while its connect window is
+ * open or the site says so. A busy button stays focusable and ignores clicks,
+ * a disabled one is out of the tab order.
+ */
+export declare function buttonView(action: ButtonAction, config: ButtonConfig, windowOpen: boolean): ButtonView;

package/dist/utils/storage-probe.d.ts

@@ -1,13 +1,16 @@
 /**
- * Whether the proxy iframe can read the trusted domain's first-party store —
+ * Whether a Swarm ID frame can read the trusted domain's first-party store,
  * asked BEFORE authentication, because it decides which transport the auth
- * popup has to take (#613).
+ * popup has to take (#613). Both frames a site embeds read it: the session
+ * frame, to tell the client whether `connect()` can work, and the button
+ * frame, to decide whether to leave the popup's challenge in storage.
  *
  * The mirror image of the probe the connect popup already runs: there, the
- * iframe writes a challenge and the popup checks whether it can read it back
- * first-party (`ui/src/lib/stores/connect.svelte.ts`). That answer arrives far
- * too late to choose a transport, so the same question is asked the other way
- * round — the first-party app leaves a marker, and the iframe reads it back.
+ * button frame writes a challenge and the popup checks whether it can read it
+ * back first-party (`ui/src/lib/stores/connect.svelte.ts`). That answer
+ * arrives far too late to choose a transport, so the same question is asked
+ * the other way round: the first-party app leaves a marker, and the frames
+ * read it back.
  *
  * Deliberately NOT any of these:
  *
@@ -24,7 +27,14 @@
  * The marker only ever answers YES with certainty. Absent means "not proven
  * shared" — a partitioned iframe, or a browser that has never had the SwarmID
  * site open at the top level — and the caller treats that as partitioned,
- * which is the safe direction: the delegated transport works in both modes.
+ * which is the safe direction: the handover through the Swarm ID button works
+ * in both modes.
+ *
+ * The marker is sealed, because the keys in that store are: a frame that sees
+ * the store but not the IndexedDB key that opens it sees no session in it.
+ * Playwright's WebKit gives a cross-site frame exactly that, one
+ * `localStorage` and its own IndexedDB (measured 2026-10-15), and a plain
+ * marker had it wait for a storage write it could never read.
  */
 export declare const STORAGE_SHARED_KEY = "swarm-id-first-party";
 /**
@@ -35,6 +45,6 @@ export declare const STORAGE_SHARED_KEY = "swarm-id-first-party";
  * bucket and make the iframe report itself shared — the one wrong answer this
  * must never give.
  */
-export declare function markFirstPartyStorage(): void;
-/** Whether this context can see the marker a first-party page left. */
-export declare function isStorageShared(): boolean;
+export declare function markFirstPartyStorage(): Promise<void>;
+/** Whether this context can see, and open, the marker a first-party page left. */
+export declare function isStorageShared(): Promise<boolean>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solarpunkltd/swarm-id",
-  "version": "0.8.2",
+  "version": "0.9.0",
   "type": "module",
   "description": "Swarm ID library for authentication and Bee API operations",
   "main": "dist/swarm-id.esm.js",