@botiverse/porthole 0.1.2 → 0.1.3

package/dist/protocol/shell-adapter.js

@@ -1,5 +1,5 @@
 import { JSON_RPC_ERRORS, parseJsonRpc, } from "./jsonrpc.js";
-import { MCP_APPS_METHODS as M, MCP_APPS_PROTOCOL_VERSION } from "./mcp-apps.js";
+import { COPY_TEXT_METHOD, MCP_APPS_METHODS as M, MCP_APPS_PROTOCOL_VERSION, } from "./mcp-apps.js";
 /**
  * The core's adapter: the host side of the MCP Apps subset the shell speaks, which content using
  * the official App SDK speaks too. Every message is checked before use; every power goes through
@@ -28,6 +28,7 @@ const REQUESTS = {
         }),
     },
     [M.openLink]: { capability: "openLink", args: (params) => ({ url: params.url }) },
+    [COPY_TEXT_METHOD]: { capability: "copyText", args: (params) => ({ text: params.text }) },
     [M.downloadFile]: {
         capability: "downloadFile",
         args: (params) => ({ contents: params.contents }),
@@ -44,7 +45,10 @@ const REQUESTS = {
 };
 /** What a capability's outcome looks like to the view. */
 function answer(capability, outcome) {
-    const flagged = capability === "sendPrompt" || capability === "openLink" || capability === "downloadFile";
+    const flagged = capability === "sendPrompt" ||
+        capability === "openLink" ||
+        capability === "downloadFile" ||
+        capability === "copyText";
     if (!outcome.ok) {
         return flagged
             ? { result: { isError: true } }

package/dist/react/dialog.js

@@ -47,6 +47,8 @@ function words(request) {
             return { heading: "Share this with the agent?", accept: "Share", detail: json(request.args) };
         case "readData":
             return { heading: "Let it read this?", accept: "Allow", detail: request.args.uri };
+        case "copyText":
+            return { heading: "Copy this text?", accept: "Copy", detail: request.args.text };
         default:
             return { heading: "Allow this?", accept: "Allow", detail: json(request.args) };
     }

package/dist/react/frame.d.ts

@@ -1,4 +1,5 @@
 import { type CSSProperties, type ReactElement, type ReactNode } from "react";
+import type { AnnotateMode, AnnotationMark, AnnotationReport } from "../annotate/types.ts";
 import type { CapabilityHandlers, Confirm, Refusal } from "../bridge/types.ts";
 import type { CapabilityName } from "../config/capabilities.ts";
 import type { ColorScheme, PortholeConfig } from "../config/schema.ts";
@@ -21,6 +22,8 @@ export interface PortholeProviderProps {
     readonly locator?: InstanceLocator;
     /** A class for the default dialog, to restyle it. */
     readonly dialogClassName?: string;
+    /** A class for the default copy toast, to restyle it. */
+    readonly toastClassName?: string;
     readonly children?: ReactNode;
 }
 export declare function PortholeProvider(props: PortholeProviderProps): ReactElement;
@@ -83,6 +86,21 @@ export interface PortholeFrameProps {
      * restyle): the running frame reads them again.
      */
     readonly themeKey?: string | number;
+    /**
+     * Annotations, where the config declares `annotate` (P053): what the person may point at now
+     * (elements, text, or both), or null to stop. A picked element ends element picking: set it
+     * again to pick again.
+     */
+    readonly annotating?: AnnotateMode | null;
+    /** The anchors to mark in the frame (the host's comments). Keep it stable (memoized). */
+    readonly annotations?: readonly AnnotationMark[];
+    /** The mark to bring into view and make the active one; each new id focuses it. */
+    readonly focusedAnnotation?: string | null;
+    /**
+     * What the frame reported: a selection (an anchor and where it is), its clearing, a cancelled
+     * pick, where marks are. The content's word: UI hints, never permissions.
+     */
+    readonly onAnnotation?: (report: AnnotationReport) => void;
     /** Draws the placeholder instead of the default one. */
     readonly renderPlaceholder?: (props: PlaceholderProps) => ReactNode;
     readonly className?: string;

package/dist/react/frame.js

@@ -1,8 +1,10 @@
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 import { createContext, useCallback, useContext, useEffect, useEffectEvent, useId, useLayoutEffect, useMemo, useRef, useState, useSyncExternalStore, } from "react";
+import { writeClipboard } from "../host/clipboard.js";
 import { createHost } from "../host/create-host.js";
 import { ConfirmDialog } from "./dialog.js";
 import { createLiveFrames } from "./live.js";
+import { CopyToast } from "./toast.js";
 /**
  * The React binding: a `<PortholeProvider>` near the root owns what is per page (which frames
  * run, the heights displays reported, and the default confirmation dialog); a `<PortholeFrame>` per
@@ -28,14 +30,24 @@ export function PortholeProvider(props) {
     const confirm = useCallback((request, proceed) => own.current !== undefined
         ? own.current(request, proceed)
         : new Promise((resolve) => setQueue((waiting) => [...waiting, { request, resolve, proceed }])), []);
+    // The default copyText: the host's page writes the clipboard (in the frame's click, which
+    // activated this page too) and shows the person what went on it, or offers to copy it.
+    const [notice, setNotice] = useState(null);
+    const copyText = useCallback(async ({ text }, context) => {
+        const copied = await writeClipboard(text, globalThis.document);
+        setNotice({ text, copied, title: context.title });
+        return copied;
+    }, []);
+    const closeNotice = useCallback(() => setNotice(null), []);
     const { hostInfo, locator } = props;
     const value = useMemo(() => ({
         live,
         heights,
         confirm,
+        copyText,
         ...(hostInfo === undefined ? {} : { hostInfo }),
         ...(locator === undefined ? {} : { locator }),
-    }), [live, heights, confirm, hostInfo, locator]);
+    }), [live, heights, confirm, copyText, hostInfo, locator]);
     const current = queue[0] ?? null;
     return (_jsxs(Page.Provider, { value: value, children: [props.children, props.confirm === undefined ? (_jsx(ConfirmDialog, { request: current?.request ?? null, ...(props.dialogClassName === undefined ? {} : { className: props.dialogClassName }), onAnswer: (accepted) => {
                     // A yes runs the effect inside this very click (a window it opens is the person's).
@@ -44,7 +56,10 @@ export function PortholeProvider(props) {
                     }
                     current?.resolve(accepted ? "accepted" : "declined");
                     setQueue((waiting) => waiting.slice(1));
-                } })) : null] }));
+                } })) : null, _jsx(CopyToast, { notice: notice, ...(props.toastClassName === undefined ? {} : { className: props.toastClassName }), onClose: closeNotice, onCopy: (failed) => {
+                    // A click on the host's own page: the write has the gesture it needs now.
+                    void writeClipboard(failed.text, globalThis.document).then((copied) => setNotice({ ...failed, copied }));
+                } })] }));
 }
 const PLACEHOLDER_STYLE = {
     position: "absolute",
@@ -163,6 +178,9 @@ function Mount({ frame, page, initialHeightPx, placeholder, run }) {
             case "outcome":
                 frame.onOutcome?.(detail);
                 return;
+            case "annotation":
+                frame.onAnnotation?.(detail);
+                return;
         }
     });
     useEffect(() => {
@@ -183,6 +201,13 @@ function Mount({ frame, page, initialHeightPx, placeholder, run }) {
         for (const name of Object.keys(first.handlers ?? {})) {
             handlers[name] = (args, context) => latest().handlers?.[name]?.(args, named(context));
         }
+        // Copy buttons without a handler of the host's: the provider's, which shows a toast.
+        if (config.capabilities.copyText !== undefined && handlers.copyText === undefined) {
+            const fallback = page.copyText;
+            if (fallback !== undefined) {
+                handlers.copyText = (args, context) => fallback(args, named(context));
+            }
+        }
         const asks = first.confirm !== undefined || page.confirm !== undefined;
         let display;
         try {
@@ -218,10 +243,14 @@ function Mount({ frame, page, initialHeightPx, placeholder, run }) {
             "refused",
             "muted",
             "outcome",
+            "annotation",
         ];
         for (const event of events) {
             display.on(event, (detail) => notify(event, detail));
         }
+        if (config.capabilities.annotate !== undefined) {
+            applyAnnotations(display, first);
+        }
         if (first.content !== undefined) {
             display.setContent(first.content, { partial: first.partial === true });
         }
@@ -237,6 +266,34 @@ function Mount({ frame, page, initialHeightPx, placeholder, run }) {
             handle.current?.setContent(content, { partial: partial === true });
         }
     }, [content, partial]);
+    // Annotations follow their props (a new display gets them all when it is made, above).
+    const annotates = config.capabilities.annotate !== undefined;
+    const { annotating, annotations, focusedAnnotation } = frame;
+    const mode = annotating === undefined || annotating === null
+        ? ""
+        : JSON.stringify([annotating.elements ?? true, annotating.text ?? true]);
+    useEffect(() => {
+        const display = handle.current;
+        if (!annotates || display === null) {
+            return;
+        }
+        const wanted = mode === "" ? null : JSON.parse(mode);
+        attempt(() => wanted === null
+            ? display.annotations.stop()
+            : display.annotations.start({ elements: wanted[0], text: wanted[1] }), latest());
+    }, [annotates, mode]);
+    useEffect(() => {
+        const display = handle.current;
+        if (annotates && display !== null) {
+            attempt(() => display.annotations.show(annotations ?? []), latest());
+        }
+    }, [annotates, annotations]);
+    useEffect(() => {
+        const display = handle.current;
+        if (annotates && display !== null && typeof focusedAnnotation === "string") {
+            attempt(() => display.annotations.focus(focusedAnnotation), latest());
+        }
+    }, [annotates, focusedAnnotation]);
     useEffect(() => {
         handle.current?.setTheme(scheme);
     }, [scheme]);
@@ -253,3 +310,26 @@ function Mount({ frame, page, initialHeightPx, placeholder, run }) {
             ...(ready ? {} : { minHeight: Math.max(startHeight, PLACEHOLDER_HEIGHT_PX) }),
         }, children: [_jsx("div", { ref: holder, "data-porthole-mount": "", style: { opacity: ready ? 1 : 0, ...(fills ? { height: "100%" } : {}) } }), ready ? null : placeholder({ state: "loading", title: frame.title, run })] }));
 }
+/** Runs an annotation call, telling the frame's `onError` what it threw (a bad anchor, say). */
+function attempt(run, frame) {
+    try {
+        run();
+    }
+    catch (error) {
+        frame.onError?.(error instanceof Error ? error.message : String(error));
+    }
+}
+/** A new display's annotations, from the props as they are. */
+function applyAnnotations(display, frame) {
+    attempt(() => {
+        if (frame.annotations !== undefined && frame.annotations.length > 0) {
+            display.annotations.show(frame.annotations);
+        }
+        if (typeof frame.focusedAnnotation === "string") {
+            display.annotations.focus(frame.focusedAnnotation);
+        }
+        if (frame.annotating !== undefined && frame.annotating !== null) {
+            display.annotations.start(frame.annotating);
+        }
+    }, frame);
+}

package/dist/react/index.d.ts

@@ -2,7 +2,7 @@
  * `@botiverse/porthole/react`: the thin React binding (TSX: a host's bundler compiles it, or the
  * package's `dist`). Peer: `react` (19.2+, for `useEffectEvent`).
  *
- *   <PortholeProvider>                         // per page: live-frame cap, heights, the dialog
+ *   <PortholeProvider>                         // per page: live-frame cap, heights, the dialog, the copy toast
  *     <PortholeFrame config={widgetConfig} displayId={id} title={title} scheme={scheme}
  *       content={code} partial={streaming} handlers={{ sendPrompt, openLink }}
  *       theme={tokensFor} onError={report} />
@@ -10,4 +10,5 @@
  */
 export { PLACEHOLDER_HEIGHT_PX, PortholeFrame, PortholeProvider, type PlaceholderProps, type PortholeFrameProps, type PortholeProviderProps, } from "./frame.tsx";
 export { ARM_DELAY_MS, ConfirmDialog, type ConfirmDialogProps } from "./dialog.tsx";
+export { CopyToast, TOAST_CHARS, TOAST_MS, clipped, type CopyNotice, type CopyToastProps, } from "./toast.tsx";
 export { admitFrame, createLiveFrames, type FrameState, type LiveFrames } from "./live.ts";

package/dist/react/index.js

@@ -2,7 +2,7 @@
  * `@botiverse/porthole/react`: the thin React binding (TSX: a host's bundler compiles it, or the
  * package's `dist`). Peer: `react` (19.2+, for `useEffectEvent`).
  *
- *   <PortholeProvider>                         // per page: live-frame cap, heights, the dialog
+ *   <PortholeProvider>                         // per page: live-frame cap, heights, the dialog, the copy toast
  *     <PortholeFrame config={widgetConfig} displayId={id} title={title} scheme={scheme}
  *       content={code} partial={streaming} handlers={{ sendPrompt, openLink }}
  *       theme={tokensFor} onError={report} />
@@ -10,4 +10,5 @@
  */
 export { PLACEHOLDER_HEIGHT_PX, PortholeFrame, PortholeProvider, } from "./frame.js";
 export { ARM_DELAY_MS, ConfirmDialog } from "./dialog.js";
+export { CopyToast, TOAST_CHARS, TOAST_MS, clipped, } from "./toast.js";
 export { admitFrame, createLiveFrames } from "./live.js";

package/dist/react/toast.d.ts

@@ -0,0 +1,33 @@
+import { type ReactElement } from "react";
+/**
+ * The default copy notice (P052): when content's `copyText` copied something, the host's page
+ * shows the person what went on their clipboard, clipped, in a small toast outside every frame.
+ * If the write failed (no recent gesture), it says so and offers a Copy button: a click on the
+ * host's own page, which writes it. A host replaces it by passing its own `copyText` handler; it
+ * styles it through the `porthole-toast` class and data attributes.
+ */
+/** How long a toast for a copy that worked stays. */
+export declare const TOAST_MS = 5000;
+/** The most of the copied text a toast shows. */
+export declare const TOAST_CHARS = 280;
+export interface CopyNotice {
+    /** The whole text copied (or to copy). */
+    readonly text: string;
+    /** Whether it is on the clipboard. */
+    readonly copied: boolean;
+    /** The display's title, as the host named it. */
+    readonly title: string;
+}
+export interface CopyToastProps {
+    readonly notice: CopyNotice | null;
+    /** The person asked to copy it again (it failed), from this click. */
+    readonly onCopy: (notice: CopyNotice) => void;
+    readonly onClose: () => void;
+    readonly className?: string;
+}
+/** The text as the toast shows it: at most a few lines and `TOAST_CHARS` characters. */
+export declare function clipped(text: string): {
+    readonly shown: string;
+    readonly clipped: boolean;
+};
+export declare function CopyToast({ notice, onCopy, onClose, className }: CopyToastProps): ReactElement;

package/dist/react/toast.js

@@ -0,0 +1,42 @@
+import { Fragment as _Fragment, jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { useEffect } from "react";
+/**
+ * The default copy notice (P052): when content's `copyText` copied something, the host's page
+ * shows the person what went on their clipboard, clipped, in a small toast outside every frame.
+ * If the write failed (no recent gesture), it says so and offers a Copy button: a click on the
+ * host's own page, which writes it. A host replaces it by passing its own `copyText` handler; it
+ * styles it through the `porthole-toast` class and data attributes.
+ */
+/** How long a toast for a copy that worked stays. */
+export const TOAST_MS = 5_000;
+/** The most of the copied text a toast shows. */
+export const TOAST_CHARS = 280;
+const TOAST_LINES = 4;
+/** The text as the toast shows it: at most a few lines and `TOAST_CHARS` characters. */
+export function clipped(text) {
+    const lines = text.split("\n");
+    let shown = lines.slice(0, TOAST_LINES).join("\n");
+    if (shown.length > TOAST_CHARS) {
+        shown = shown.slice(0, TOAST_CHARS);
+    }
+    return shown.length < text.length
+        ? { shown: `${shown}…`, clipped: true }
+        : { shown, clipped: false };
+}
+const STYLE = `.porthole-toast{position:fixed;left:50%;bottom:24px;transform:translateX(-50%);z-index:2147483647;color-scheme:light dark;color:CanvasText;background:Canvas;border:1px solid color-mix(in srgb,CanvasText 18%,transparent);border-radius:12px;padding:12px 14px;width:min(420px,calc(100vw - 32px));box-shadow:0 8px 28px rgb(0 0 0 / .25);font:inherit;font-size:.9em}
+.porthole-toast p{margin:0 0 6px}
+.porthole-toast [data-porthole-source]{opacity:.72}
+.porthole-toast pre{margin:0;white-space:pre-wrap;overflow-wrap:anywhere;max-height:8em;overflow:hidden;padding:8px 10px;border-radius:8px;background:color-mix(in srgb,CanvasText 7%,transparent);font:12px/1.45 ui-monospace,SFMono-Regular,Menlo,monospace}
+.porthole-toast menu{display:flex;justify-content:flex-end;gap:8px;margin:8px 0 0;padding:0}
+.porthole-toast button{font:inherit;min-height:32px;padding:0 12px;border-radius:8px;border:1px solid color-mix(in srgb,CanvasText 25%,transparent);background:transparent;color:inherit;cursor:pointer}`;
+export function CopyToast({ notice, onCopy, onClose, className }) {
+    useEffect(() => {
+        if (notice === null || !notice.copied) {
+            return;
+        }
+        const timer = setTimeout(onClose, TOAST_MS);
+        return () => clearTimeout(timer);
+    }, [notice, onClose]);
+    const view = notice === null ? null : clipped(notice.text);
+    return (_jsxs("div", { role: "status", "aria-live": "polite", className: className === undefined ? "porthole-toast" : `porthole-toast ${className}`, "data-porthole-toast": "", "data-porthole-copied": notice === null ? "" : String(notice.copied), hidden: notice === null, children: [_jsx("style", { children: STYLE }), notice === null || view === null ? null : (_jsxs(_Fragment, { children: [_jsxs("p", { children: [_jsx("strong", { children: notice.copied ? "Copied" : "Not copied yet" }), " ", _jsx("span", { "data-porthole-source": "", children: `from “${notice.title}”` })] }), _jsx("pre", { "data-porthole-copied-text": "", children: view.shown }), view.clipped ? (_jsx("p", { "data-porthole-length": "", children: `${notice.text.length.toLocaleString("en-US")} characters in all` })) : null, _jsxs("menu", { children: [notice.copied ? null : (_jsx("button", { type: "button", "data-porthole-copy": "", onClick: () => onCopy(notice), children: "Copy" })), _jsx("button", { type: "button", "data-porthole-close": "", onClick: onClose, children: notice.copied ? "OK" : "Close" })] })] }))] }));
+}

package/dist/shell/annotate.d.ts

@@ -0,0 +1,20 @@
+/**
+ * The shell's annotation runtime (P053), spliced into the shell's runtime (`__ANNOTATE__`) when
+ * the config declares `annotate`, so it runs before any content does, with the DOM's own
+ * functions as they were. Plain ES2020 like the rest of the shell; no template literals (it sits
+ * in one).
+ *
+ * The host drives it (`porthole/annotate.start|stop|show|focus|clear`) and it reports
+ * (`porthole/annotate.selected|unselected|cancelled|anchored`):
+ * - picking an element: the element under the pointer (or finger) is outlined with its name; a
+ *   click or tap picks it, and the content's own handlers never see that click; Escape cancels;
+ * - selecting text: each selection that settles is reported, with where it is, and its clearing;
+ * - marks: each anchor is found in the content as it is now (its CSS selector, its text where it
+ *   was, its text anywhere, its words with any spacing) and drawn over it, in a layer of the
+ *   shell's own (a closed shadow root), again whenever the content changes; what can't be found
+ *   is reported `orphaned`.
+ *
+ * It shares the realm with the content, which can interfere with all of it: the host takes its
+ * reports as UI hints only.
+ */
+export declare const ANNOTATE_RUNTIME: string;