@botiverse/porthole 0.1.3 → 0.1.5

package/src/server/types.ts

@@ -19,10 +19,13 @@ export interface ContentDomain {
    */
   readonly name?: (scope: string) => string;
   /**
-   * Labels this server never serves or names (another server's namespace under the same domain,
-   * `f` for `<instance>.f.<domain>`, or `www`). Requests for them get null (the host's routes).
+   * Labels this server never serves or names: another server's namespace under the same domain
+   * (`f` for `<instance>.f.<domain>`, `www`), or the host's own (`p-*`: every label starting
+   * `p-`). Each entry is a whole label, or a prefix ending in `*`; or a function that says
+   * whether a label is reserved. Requests for them, and for the names under them, get null (the
+   * host's routes), so a host routes them without wrapping `handle`.
    */
-  readonly reserved?: readonly string[];
+  readonly reserved?: readonly string[] | ((label: string) => boolean);
 }
 
 /**

package/src/shell/annotate.ts

@@ -369,6 +369,9 @@ export const ANNOTATE_RUNTIME = String.raw`if (declared("annotate")) {
         const root = ensureLayer();
         const parts = [];
         const style = createElement.call(document, "style");
+        if (nonce !== "") {
+          style.nonce = nonce;
+        }
         style.textContent = STYLE;
         parts.push(style);
         const flashOn = Date.now() < flashUntil;
@@ -439,20 +442,41 @@ export const ANNOTATE_RUNTIME = String.raw`if (declared("annotate")) {
       let anchorTimer = 0;
       let deadline = 0;
       let reportAll = false;
+      // Nothing is reported before the content is in place (an empty shell would orphan every
+      // mark), nor before a run of changes settles; a focus asked for meanwhile waits for it.
+      let waitingForContent = false;
+      let pendingFocus = null;
+      const settling = () => anchorTimer !== 0 || waitingForContent || marks.some((mark) => mark.state === null);
       const scheduleAnchor = (all) => {
         if (all) {
           reportAll = true;
         }
+        if (!contentIsIn()) {
+          if (!waitingForContent) {
+            waitingForContent = true;
+            whenContentIsIn(() => {
+              waitingForContent = false;
+              scheduleAnchor(false);
+            });
+          }
+          return;
+        }
         const now = Date.now();
         if (deadline === 0) {
           deadline = now + 1000;
         }
         clearTimeout(anchorTimer);
         anchorTimer = setTimeout(() => {
+          anchorTimer = 0;
           deadline = 0;
           const every = reportAll;
           reportAll = false;
           anchorAll(every);
+          if (pendingFocus !== null) {
+            const id = pendingFocus;
+            pendingFocus = null;
+            focus(id);
+          }
         }, Math.max(0, Math.min(150, deadline - now)));
       };
       new MutationObserver((records) => {
@@ -475,6 +499,12 @@ export const ANNOTATE_RUNTIME = String.raw`if (declared("annotate")) {
         if (!mark) {
           return;
         }
+        if (settling()) {
+          // Where it is isn't known yet: focus it once anchoring has settled, then say where.
+          pendingFocus = id;
+          active = id;
+          return;
+        }
         active = id;
         if (mark.found !== null) {
           const rect = rectOf(mark.found);
@@ -657,6 +687,7 @@ export const ANNOTATE_RUNTIME = String.raw`if (declared("annotate")) {
             focus(String(params.id));
             break;
           case M.clear:
+            pendingFocus = null;
             marks = [];
             active = null;
             draw();

package/src/shell/document.ts

@@ -25,8 +25,17 @@ export interface ShellDocumentOptions {
    * both apply, and the stricter wins.
    */
   readonly cspMeta?: boolean;
+  /**
+   * The embedding page's CSP nonce, where its `script-src` is nonce-based (P054): a `srcdoc` frame
+   * inherits the embedding page's policy, so the shell's script and style carry it, and so does
+   * every script the shell runs for the content. The frame can read it.
+   */
+  readonly nonce?: string;
 }
 
+/** A CSP nonce: base64 or base64url characters, 8 to 256 of them. */
+const NONCE = /^[A-Za-z0-9+/_=-]{8,256}$/u;
+
 const escapeAttribute = (value: string): string =>
   value.replace(/&/gu, "&amp;").replace(/"/gu, "&quot;").replace(/</gu, "&lt;");
 
@@ -86,6 +95,10 @@ export function shellDocument(plan: ShellPlan, csp: string, options: ShellDocume
       throw new TypeError(`shellDocument: ${problem}`);
     }
   }
+  if (options.nonce !== undefined && !NONCE.test(options.nonce)) {
+    throw new TypeError("shellDocument: a nonce is 8 to 256 base64 characters");
+  }
+  const nonce = options.nonce === undefined ? "" : ` nonce="${options.nonce}"`;
   // The annotation runtime only where it is declared; spliced in before the plan, which may carry
   // any text (a document) and must not be searched.
   const runtime = SHELL_RUNTIME.replace("__ANNOTATE__", () =>
@@ -113,13 +126,13 @@ export function shellDocument(plan: ShellPlan, csp: string, options: ShellDocume
 ${head.join("\n")}
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <title>${escapeText(options.title ?? "Content")}</title>
-<style>
+<style${nonce}>
 ${BASE_STYLE}
 </style>
 </head>
 <body>
 <div id="porthole-root"></div>
-<script>${runtime}</script>
+<script${nonce}>${runtime}</script>
 </body>
 </html>
 `;

package/src/shell/runtime.ts

@@ -31,6 +31,9 @@
 export const SHELL_RUNTIME = String.raw`(() => {
   "use strict";
   const plan = __PLAN__;
+  // The embedding page's nonce, where it gave one (a srcdoc frame inherits its policy): every
+  // script the shell runs for the content carries it.
+  const nonce = document.currentScript && document.currentScript.nonce ? document.currentScript.nonce : "";
   const declared = (name) => Object.prototype.hasOwnProperty.call(plan.capabilities, name);
   // Fixed in place: content can neither restore what is removed nor replace what is wrapped.
   const lock = (target, name, value) => {
@@ -485,6 +488,9 @@ export const SHELL_RUNTIME = String.raw`(() => {
       }
       // A script made by a script is async unless told otherwise: keep the page's order.
       live.async = script.hasAttribute("async");
+      if (nonce !== "") {
+        live.nonce = nonce;
+      }
       live.textContent = script.textContent;
       const external = live.hasAttribute("src") && !live.async && live.type !== "module";
       const loaded = external
@@ -509,6 +515,27 @@ export const SHELL_RUNTIME = String.raw`(() => {
     window.dispatchEvent(new Event("load"));
   };
 
+  // Whether the content is in place: a fragment or page the shell draws, once drawn whole; a
+  // view the plan carries, once rendered; a view that is the document itself, from the start.
+  const contentHooks = [];
+  let contentIn = typeof plan.document !== "string" && plan.protocol !== "shell";
+  const contentIsIn = () => contentIn;
+  const whenContentIsIn = (run) => {
+    if (contentIn) {
+      run();
+    } else {
+      contentHooks.push(run);
+    }
+  };
+  const contentArrived = () => {
+    if (!contentIn) {
+      contentIn = true;
+      for (const run of contentHooks.splice(0)) {
+        run();
+      }
+    }
+  };
+
   // A fragment takes the person's scheme; a whole document only if it declares that it supports
   // both (or the config says always), else it shows as its author styled it (P039).
   let lastContext = null;
@@ -544,6 +571,7 @@ export const SHELL_RUNTIME = String.raw`(() => {
     schemeFollows();
     await runScripts(scripts);
     announceLoaded();
+    contentArrived();
   };
 
   // A document the plan carries (a served page, an MCP Apps view) is rendered once the shell's own
@@ -579,12 +607,16 @@ export const SHELL_RUNTIME = String.raw`(() => {
   const notify = (method, params) => send({ method, params });
 
   const themeNames = new Set(plan.themeVariables);
+  // What the content was last told of (its scheme and values): the theme it starts with is no
+  // change, and a host context that changes neither (a host re-sending it) is none either.
+  let announced = null;
   const applyTheme = (context) => {
     if (context === null || typeof context !== "object") {
       return;
     }
     // The spec's variables, and Porthole's own beside them (its own-prefixed field).
     const own = context["porthole/styles"];
+    const applied = [];
     for (const variables of [context.styles && context.styles.variables, own && own.variables]) {
       if (variables === null || typeof variables !== "object") {
         continue;
@@ -593,12 +625,21 @@ export const SHELL_RUNTIME = String.raw`(() => {
         const value = variables[name];
         if (themeNames.has(name) && typeof value === "string") {
           document.documentElement.style.setProperty(name, value);
+          applied.push(name + ":" + value);
         }
       }
     }
     lastContext = context;
     schemeFollows();
-    window.dispatchEvent(new CustomEvent(plan.themeEvent, { detail: { theme: context.theme } }));
+    const now = JSON.stringify([context.theme, applied.sort()]);
+    if (announced === null) {
+      announced = now;
+      return;
+    }
+    if (now !== announced) {
+      announced = now;
+      window.dispatchEvent(new CustomEvent(plan.themeEvent, { detail: { theme: context.theme } }));
+    }
   };
 
   // No size before there is something to size: an empty shell's height would make the host
@@ -672,7 +713,10 @@ export const SHELL_RUNTIME = String.raw`(() => {
   window.addEventListener("error", (event) => {
     const error = event.error;
     const where = event.lineno ? " (line " + event.lineno + ")" : "";
-    report(error && error.stack ? String(error.stack).split("\n").slice(0, 3).join(" ") : event.message + where);
+    // V8's stack starts with the message; WebKit's and Firefox's don't, so it goes first there.
+    const stack = error && error.stack ? String(error.stack).split("\n").slice(0, 3).join(" ") : "";
+    const said = error && error.message !== undefined ? String(error.name || "Error") + ": " + String(error.message) : event.message;
+    report(stack === "" ? said + where : stack.indexOf(String(error.message)) === -1 ? said + " " + stack : stack);
   });
   window.addEventListener("unhandledrejection", (event) => {
     const reason = event.reason;
@@ -804,6 +848,7 @@ export const SHELL_RUNTIME = String.raw`(() => {
     schedule();
     await runScripts(scripts);
     announceLoaded();
+    contentArrived();
     schedule();
   };