@arraypress/extension-kit 1.7.0 → 1.9.0

package/src/frame/window.d.ts

@@ -0,0 +1,182 @@
+/**
+ * Windows around a page, drawn as HTML: Chrome's (the macOS tab strip and toolbar) and a plain
+ * macOS window's title bar, light or dark, sharing the traffic lights, the colours and the
+ * shadow. Chrome's is shared by the store screenshots (`build/store-frame`, which lays it on a
+ * 1280×800 canvas in Playwright) and by extension pages, which draw either on a canvas around a
+ * capture through {@link windowChromeSvg} or {@link macWindowSvg} (an SVG image with the HTML
+ * inside, which Chrome draws without tainting the canvas). The markup is XML-clean so both can
+ * use it.
+ *
+ * Window metrics follow Chrome's 2023 refresh on macOS (tabs 34px high in a 42px strip, a 46px
+ * toolbar with a pill omnibox) and AppKit's titled window as macOS 26 and later draw it, measured
+ * on macOS 27.2 (`NSThemeFrame`'s `cornerRadius` 16, a 32pt title bar, the window buttons 14pt
+ * at 9, 32 and 55 from the left and 9 from the top, the title in the 13pt headline font at 85,
+ * after the buttons).
+ *
+ * @module frame/window
+ */
+/** The tab strip's and the toolbar's heights (px): the content starts below both. */
+export declare const WINDOW_BARS: Readonly<{
+    strip: 42;
+    toolbar: 46;
+}>;
+/** A plain macOS window (macOS 26 and later): its title bar's height and its corners' radius (px). */
+export declare const MAC_WINDOW: Readonly<{
+    titleBar: 32;
+    radius: 16;
+}>;
+/** The window's default width (px): the store screenshot's. */
+export declare const WINDOW_W = 1152;
+/**
+ * A letter favicon for made-up sites (no real brands).
+ *
+ * @param {string} letter - The letter.
+ * @param {string} bg - Background colour.
+ * @param {string} [fg] - Letter colour. Default white.
+ * @returns {string} A data: URL of the SVG.
+ */
+export declare const letterIcon: (letter: string, bg: string, fg?: string) => string;
+export type WindowShadow = {
+    /**
+     * How far down it falls.
+     */
+    y: number;
+    /**
+     * Its blur.
+     */
+    blur: number;
+    /**
+     * Its colour.
+     */
+    color: string;
+};
+/**
+ * Chrome's light and dark window colours, a macOS title bar's (`titleBar`, and `titleLine` below
+ * it, as AppKit draws them), the canvas behind, and the window's shadow (`windowShadow` for a
+ * canvas's `shadow*`, `shadow` for CSS).
+ */
+export declare const THEMES: {
+    light: {
+        bg: string;
+        caption: string;
+        sub: string;
+        frame: string;
+        tabText: string;
+        tabTextInactive: string;
+        tabSep: string;
+        activeTab: string;
+        toolbar: string;
+        toolbarIcon: string;
+        omnibox: string;
+        url: string;
+        urlDim: string;
+        contentLine: string;
+        titleBar: string;
+        titleLine: string;
+        windowShadow: WindowShadow;
+        shadow: string;
+    };
+    dark: {
+        bg: string;
+        caption: string;
+        sub: string;
+        frame: string;
+        tabText: string;
+        tabTextInactive: string;
+        tabSep: string;
+        activeTab: string;
+        toolbar: string;
+        toolbarIcon: string;
+        omnibox: string;
+        url: string;
+        urlDim: string;
+        contentLine: string;
+        titleBar: string;
+        titleLine: string;
+        windowShadow: WindowShadow;
+        shadow: string;
+    };
+};
+export type Theme = keyof typeof THEMES;
+export type Tab = {
+    /**
+     * Its title.
+     */
+    title: string;
+    /**
+     * Its favicon's URL.
+     */
+    icon: string;
+    /**
+     * The selected tab.
+     */
+    active?: boolean;
+    /**
+     * Playing sound.
+     */
+    audible?: boolean;
+    /**
+     * Muted.
+     */
+    muted?: boolean;
+};
+/**
+ * The window's tab strip and toolbar, as HTML. Positions are window-relative.
+ *
+ * @param {object} options - What to draw.
+ * @param {readonly Tab[]} options.tabs - The tabs, left to right.
+ * @param {string} options.url - The address bar's text.
+ * @param {string} [options.urlHost] - The start of `url` to show in full; the rest is dimmed.
+ * @param {Theme} [options.theme] - Default light.
+ * @param {number} [options.w] - The window's width. Default {@link WINDOW_W}.
+ * @param {readonly string[]} [options.ext] - Toolbar extension icons' URLs.
+ * @returns {string} The HTML, with its own styles.
+ */
+export declare function windowChrome({ tabs, url, urlHost, theme, w, ext }: {
+    tabs: readonly Tab[];
+    url: string;
+    urlHost?: string;
+    theme?: Theme;
+    w?: number;
+    ext?: readonly string[];
+}): string;
+/**
+ * The window's tab strip and toolbar as a standalone SVG image, `w` wide and the bars' height
+ * high (scale it when drawing), for an extension page to draw on a canvas: `new Image()` with a
+ * `data:image/svg+xml` URL of it, then `drawImage`. Images in it (the tabs' icons, `ext`) must be
+ * `data:` URLs: an SVG image loads nothing else.
+ *
+ * @param {Parameters<typeof windowChrome>[0]} options - As {@link windowChrome}.
+ * @returns {string} The SVG markup.
+ * @example
+ * const svg = windowChromeSvg({ tabs: [{ title: 'Example', icon: letterIcon('E', '#1a73e8'), active: true }], url: 'example.com', w: 1280 });
+ */
+export declare function windowChromeSvg(options: Parameters<typeof windowChrome>[0]): string;
+/**
+ * A plain macOS window's title bar, as HTML: the traffic lights at the left, the title after
+ * them (macOS 26 on), a hairline below.
+ *
+ * @param {object} options - What to draw.
+ * @param {string} options.title - The window's title.
+ * @param {Theme} [options.theme] - Default light.
+ * @param {number} [options.w] - The window's width. Default {@link WINDOW_W}.
+ * @returns {string} The HTML, with its own styles.
+ */
+declare function macTitleBar({ title, theme, w }: {
+    title: string;
+    theme?: Theme;
+    w?: number;
+}): string;
+/**
+ * A plain macOS window's title bar as a standalone SVG image, `w` wide and `MAC_WINDOW.titleBar`
+ * high (scale it when drawing), for an extension page to draw on a canvas as
+ * {@link windowChromeSvg}'s bars are drawn. The window's corners (`MAC_WINDOW.radius`) and its
+ * shadow (`THEMES[theme].windowShadow`) are the canvas's to draw.
+ *
+ * @param {Parameters<typeof macTitleBar>[0]} options - As {@link macTitleBar}.
+ * @returns {string} The SVG markup.
+ * @example
+ * const svg = macWindowSvg({ title: 'Example', theme: 'dark', w: 1280 });
+ */
+export declare function macWindowSvg(options: Parameters<typeof macTitleBar>[0]): string;
+export {};

package/src/frame/window.js

@@ -0,0 +1,299 @@
+/**
+ * Windows around a page, drawn as HTML: Chrome's (the macOS tab strip and toolbar) and a plain
+ * macOS window's title bar, light or dark, sharing the traffic lights, the colours and the
+ * shadow. Chrome's is shared by the store screenshots (`build/store-frame`, which lays it on a
+ * 1280×800 canvas in Playwright) and by extension pages, which draw either on a canvas around a
+ * capture through {@link windowChromeSvg} or {@link macWindowSvg} (an SVG image with the HTML
+ * inside, which Chrome draws without tainting the canvas). The markup is XML-clean so both can
+ * use it.
+ *
+ * Window metrics follow Chrome's 2023 refresh on macOS (tabs 34px high in a 42px strip, a 46px
+ * toolbar with a pill omnibox) and AppKit's titled window as macOS 26 and later draw it, measured
+ * on macOS 27.2 (`NSThemeFrame`'s `cornerRadius` 16, a 32pt title bar, the window buttons 14pt
+ * at 9, 32 and 55 from the left and 9 from the top, the title in the 13pt headline font at 85,
+ * after the buttons).
+ *
+ * @module frame/window
+ */
+
+/** The tab strip's and the toolbar's heights (px): the content starts below both. */
+export const WINDOW_BARS = Object.freeze({ strip: 42, toolbar: 46 });
+
+/** A plain macOS window (macOS 26 and later): its title bar's height and its corners' radius (px). */
+export const MAC_WINDOW = Object.freeze({ titleBar: 32, radius: 16 });
+
+/** The window's default width (px): the store screenshot's. */
+export const WINDOW_W = 1152;
+
+/**
+ * @param {unknown} s - Text.
+ * @returns {string} It, escaped for HTML text and attributes.
+ */
+const esc = (s) => String(s).replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;');
+
+/** Material icon paths (24×24). */
+const P = {
+  back: 'M20 11H7.83l5.59-5.59L12 4l-8 8 8 8 1.41-1.41L7.83 13H20v-2z',
+  forward: 'M12 4l-1.41 1.41L16.17 11H4v2h12.17l-5.58 5.59L12 20l8-8z',
+  reload: 'M17.65 6.35C16.2 4.9 14.21 4 12 4c-4.42 0-7.99 3.58-7.99 8s3.57 8 7.99 8c3.73 0 6.84-2.55 7.73-6h-2.08c-.82 2.33-3.04 4-5.65 4-3.31 0-6-2.69-6-6s2.69-6 6-6c1.66 0 3.14.69 4.22 1.78L13 11h7V4l-2.35 2.35z',
+  close: 'M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z',
+  add: 'M19 13h-6v6h-2v-6H5v-2h6V5h2v6h6v2z',
+  more: 'M12 8c1.1 0 2-.9 2-2s-.9-2-2-2-2 .9-2 2 .9 2 2 2zm0 2c-1.1 0-2 .9-2 2s.9 2 2 2 2-.9 2-2-.9-2-2-2zm0 6c-1.1 0-2 .9-2 2s.9 2 2 2 2-.9 2-2-.9-2-2-2z',
+  puzzle: 'M20.5 11H19V7c0-1.1-.9-2-2-2h-4V3.5C13 2.12 11.88 1 10.5 1S8 2.12 8 3.5V5H4c-1.1 0-1.99.9-1.99 2v3.8H3.5c1.49 0 2.7 1.21 2.7 2.7s-1.21 2.7-2.7 2.7H2V20c0 1.1.9 2 2 2h3.8v-1.5c0-1.49 1.21-2.7 2.7-2.7 1.49 0 2.7 1.21 2.7 2.7V22H17c1.1 0 2-.9 2-2v-4h1.5c1.38 0 2.5-1.12 2.5-2.5S21.88 11 20.5 11z',
+  star: 'M22 9.24l-7.19-.62L12 2 9.19 8.63 2 9.24l5.46 4.73L5.82 21 12 17.27 18.18 21l-1.63-7.03L22 9.24zM12 15.4l-3.76 2.27 1-4.28-3.32-2.88 4.38-.38L12 6.1l1.71 4.04 4.38.38-3.32 2.88 1 4.28L12 15.4z',
+  tune: 'M3 17v2h6v-2H3zM3 5v2h10V5H3zm10 16v-2h8v-2h-8v-2h-2v6h2zM7 9v2H3v2h4v2h2V9H7zm14 4v-2H11v2h10zm-6-4h2V7h4V5h-4V3h-2v6z',
+  sound: 'M3 9v6h4l5 5V4L7 9H3zm13.5 3c0-1.77-1.02-3.29-2.5-4.03v8.05c1.48-.73 2.5-2.25 2.5-4.02zM14 3.23v2.06c2.89.86 5 3.54 5 6.71s-2.11 5.85-5 6.71v2.06c4.01-.91 7-4.49 7-8.77s-2.99-7.86-7-8.77z',
+  muted: 'M16.5 12c0-1.77-1.02-3.29-2.5-4.03v2.21l2.45 2.45c.03-.2.05-.41.05-.63zm2.5 0c0 .94-.2 1.82-.54 2.64l1.51 1.51C20.63 14.91 21 13.5 21 12c0-4.28-2.99-7.86-7-8.77v2.06c2.89.86 5 3.54 5 6.71zM4.27 3L3 4.27 7.73 9H3v6h4l5 5v-6.73l4.25 4.25c-.67.52-1.42.93-2.25 1.18v2.06c1.38-.31 2.63-.95 3.69-1.81L19.73 21 21 19.73l-9-9L4.27 3zM12 4L9.91 6.09 12 8.18V4z',
+  person: 'M12 12c2.21 0 4-1.79 4-4s-1.79-4-4-4-4 1.79-4 4 1.79 4 4 4zm0 2c-2.67 0-8 1.34-8 4v2h16v-2c0-2.66-5.33-4-8-4z',
+};
+
+/**
+ * A Material icon as inline SVG, in the text colour.
+ *
+ * @param {keyof typeof P} name - Which icon.
+ * @param {number} [size] - Width and height in px. Default 20.
+ * @returns {string} The SVG markup.
+ */
+const icon = (name, size = 20) =>
+  `<svg viewBox="0 0 24 24" width="${size}" height="${size}"><path fill="currentColor" d="${P[name]}"/></svg>`;
+
+/**
+ * A letter favicon for made-up sites (no real brands).
+ *
+ * @param {string} letter - The letter.
+ * @param {string} bg - Background colour.
+ * @param {string} [fg] - Letter colour. Default white.
+ * @returns {string} A data: URL of the SVG.
+ */
+export const letterIcon = (letter, bg, fg = '#fff') =>
+  `data:image/svg+xml,${encodeURIComponent(`<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16"><rect width="16" height="16" rx="4" fill="${bg}"/><text x="8" y="12" font-family="-apple-system,Helvetica,Arial" font-size="11" font-weight="700" text-anchor="middle" fill="${fg}">${letter}</text></svg>`)}`;
+
+/**
+ * A window's shadow: soft and dropped below it, as macOS draws one (px; `blur` as CSS's and a
+ * canvas's `shadowBlur`, twice the blur's standard deviation).
+ *
+ * @typedef {object} WindowShadow
+ * @property {number} y How far down it falls.
+ * @property {number} blur Its blur.
+ * @property {string} color Its colour.
+ */
+
+/** @type {{light: WindowShadow, dark: WindowShadow}} */
+const SHADOWS = {
+  light: { y: 24, blur: 60, color: 'rgba(31,45,70,.20)' },
+  dark: { y: 24, blur: 60, color: 'rgba(0,0,0,.55)' },
+};
+
+/**
+ * A window's shadow and its hairline rim as a CSS `box-shadow`.
+ *
+ * @param {WindowShadow} shadow - The shadow.
+ * @param {string} rim - The rim's colour.
+ * @returns {string} The `box-shadow` value.
+ */
+const boxShadow = (shadow, rim) => `0 ${shadow.y}px ${shadow.blur}px ${shadow.color}, 0 0 0 .5px ${rim}`;
+
+/**
+ * Chrome's light and dark window colours, a macOS title bar's (`titleBar`, and `titleLine` below
+ * it, as AppKit draws them), the canvas behind, and the window's shadow (`windowShadow` for a
+ * canvas's `shadow*`, `shadow` for CSS).
+ */
+export const THEMES = {
+  light: {
+    bg: '#eef2f8', caption: '#1f1f1f', sub: '#444746',
+    frame: '#dde3ea', tabText: '#1f1f1f', tabTextInactive: '#474747', tabSep: '#a8afb8', activeTab: '#ffffff',
+    toolbar: '#ffffff', toolbarIcon: '#474747', omnibox: '#e9eef6', url: '#1f1f1f', urlDim: '#5e5e5e',
+    contentLine: '#d3d7dc', titleBar: '#ffffff', titleLine: '#eaeaea',
+    windowShadow: SHADOWS.light, shadow: boxShadow(SHADOWS.light, 'rgba(0,0,0,.18)'),
+  },
+  dark: {
+    bg: '#1b1c1f', caption: '#e3e3e3', sub: '#c4c7c5',
+    frame: '#1f1f1f', tabText: '#e3e3e3', tabTextInactive: '#c7c7c7', tabSep: '#5f6368', activeTab: '#3c3c3c',
+    toolbar: '#3c3c3c', toolbarIcon: '#c7c7c7', omnibox: '#282828', url: '#e3e3e3', urlDim: '#a8a8a8',
+    contentLine: '#2a2a2a', titleBar: '#282828', titleLine: '#3c3c3c',
+    windowShadow: SHADOWS.dark, shadow: boxShadow(SHADOWS.dark, 'rgba(255,255,255,.14)'),
+  },
+};
+
+/** The traffic lights' colours: close, minimise, zoom. */
+const LIGHTS = ['#ff5f57', '#febc2e', '#28c840'];
+
+/** The traffic lights' styles: circles with a faint edge, their size and spacing set where they're placed. */
+const LIGHTS_CSS = `.lights { position: absolute; display: flex; }
+    .lights i { width: var(--light); height: var(--light); border-radius: 50%; display: block; box-shadow: inset 0 0 0 .5px rgba(0,0,0,.12); }`;
+
+/**
+ * macOS's traffic lights (styled by {@link LIGHTS_CSS}).
+ *
+ * @param {{left: number, top: number, size: number, gap: number}} place - The first one's left edge, their top edge, their size and the space between them (px).
+ * @returns {string} The HTML.
+ */
+const trafficLights = ({ left, top, size, gap }) =>
+  `<span class="lights" style="left:${left}px;top:${top}px;gap:${gap}px;--light:${size}px">${LIGHTS.map((color) => `<i style="background:${color}"></i>`).join('')}</span>`;
+
+/** @typedef {keyof typeof THEMES} Theme */
+
+/**
+ * One tab in the drawn window.
+ *
+ * @typedef {object} Tab
+ * @property {string} title Its title.
+ * @property {string} icon Its favicon's URL.
+ * @property {boolean} [active] The selected tab.
+ * @property {boolean} [audible] Playing sound.
+ * @property {boolean} [muted] Muted.
+ */
+
+const TAB_H = 34;
+
+/**
+ * Lay out tabs like Chrome: equal widths up to 240px, shrinking to fit.
+ *
+ * @param {readonly Tab[]} tabs - The tabs.
+ * @param {number} w - The window's width.
+ * @returns {{ x: number, width: number }[]} Each tab's window-relative x and width.
+ */
+function tabLayout(tabs, w) {
+  const left = 84;
+  const right = 60;
+  const max = 240;
+  const avail = w - left - right - 36;
+  const width = Math.min(max, Math.floor(avail / tabs.length));
+  return tabs.map((_, i) => ({ x: left + i * width, width }));
+}
+
+/**
+ * The window's tab strip and toolbar, as HTML. Positions are window-relative.
+ *
+ * @param {object} options - What to draw.
+ * @param {readonly Tab[]} options.tabs - The tabs, left to right.
+ * @param {string} options.url - The address bar's text.
+ * @param {string} [options.urlHost] - The start of `url` to show in full; the rest is dimmed.
+ * @param {Theme} [options.theme] - Default light.
+ * @param {number} [options.w] - The window's width. Default {@link WINDOW_W}.
+ * @param {readonly string[]} [options.ext] - Toolbar extension icons' URLs.
+ * @returns {string} The HTML, with its own styles.
+ */
+export function windowChrome({ tabs, url, urlHost, theme = 'light', w = WINDOW_W, ext = [] }) {
+  const t = THEMES[theme];
+  const layout = tabLayout(tabs, w);
+  const tabHtml = tabs.map((tab, i) => {
+    const { x, width } = layout[i];
+    const sepAfter = i < tabs.length - 1 && !tab.active && !tabs[i + 1].active;
+    const alert = tab.muted ? icon('muted', 16) : tab.audible ? icon('sound', 16) : '';
+    const showClose = tab.active || width >= 120;
+    return `<div class="tab${tab.active ? ' active' : ''}" style="left:${x}px;width:${width}px">
+      <img class="fav" src="${tab.icon}" width="16" height="16" alt=""/>
+      <span class="title">${esc(tab.title)}</span>
+      ${alert ? `<span class="alert">${alert}</span>` : ''}
+      ${showClose ? `<span class="x">${icon('close', 14)}</span>` : ''}
+    </div>${sepAfter ? `<span class="sep" style="left:${x + width - 1}px"></span>` : ''}`;
+  }).join('');
+  const last = layout[layout.length - 1];
+  const plusX = last.x + last.width + 4;
+  const extIcons = ext.map((src) => `<img src="${src}" width="16" height="16" alt="" style="margin:0 9px"/>`).join('');
+  return `
+  <div class="strip">
+    ${trafficLights({ left: 16, top: 15, size: 12, gap: 8 })}
+    ${tabHtml}
+    <span class="plus" style="left:${plusX}px">${icon('add', 18)}</span>
+  </div>
+  <div class="toolbar">
+    <span class="tb">${icon('back')}</span><span class="tb dim">${icon('forward')}</span><span class="tb">${icon('reload')}</span>
+    <div class="omni"><span class="site">${icon('tune', 16)}</span><span class="url">${urlHost ? `${esc(urlHost)}<span class="dim">${esc(url.slice(urlHost.length))}</span>` : esc(url)}</span><span class="star">${icon('star', 18)}</span></div>
+    ${extIcons}<span class="tb">${icon('puzzle')}</span>
+    <span class="avatar">${icon('person', 18)}</span><span class="tb">${icon('more')}</span>
+  </div>
+  <style>
+    .strip { position: relative; height: ${WINDOW_BARS.strip}px; background: ${t.frame}; }
+    ${LIGHTS_CSS}
+    .tab { position: absolute; bottom: 0; height: ${TAB_H}px; display: flex; align-items: center; gap: 8px; padding: 0 10px 0 14px; box-sizing: border-box; color: ${t.tabTextInactive}; font: 12px/16px system-ui; }
+    .tab.active { background: ${t.activeTab}; color: ${t.tabText}; border-radius: 10px 10px 0 0; z-index: 1; }
+    .tab.active::before, .tab.active::after { content: ''; position: absolute; bottom: 0; width: 10px; height: 10px; }
+    .tab.active::before { left: -10px; background: radial-gradient(circle at 0 0, transparent 10px, ${t.activeTab} 10.5px); }
+    .tab.active::after { right: -10px; background: radial-gradient(circle at 100% 0, transparent 10px, ${t.activeTab} 10.5px); }
+    .tab .fav { flex: none; }
+    .tab .title { flex: 1; min-width: 0; white-space: nowrap; overflow: hidden; -webkit-mask-image: linear-gradient(90deg, #000 calc(100% - 18px), transparent); }
+    .tab .alert, .tab .x { flex: none; display: flex; color: ${t.toolbarIcon}; }
+    .sep { position: absolute; bottom: 9px; width: 1px; height: 18px; background: ${t.tabSep}; }
+    .plus { position: absolute; top: 11px; display: flex; color: ${t.toolbarIcon}; padding: 2px; }
+    .toolbar { height: ${WINDOW_BARS.toolbar}px; background: ${t.toolbar}; display: flex; align-items: center; gap: 4px; padding: 0 8px; box-sizing: border-box; border-bottom: 1px solid ${t.contentLine}; }
+    .tb { width: 34px; height: 34px; display: grid; place-items: center; color: ${t.toolbarIcon}; flex: none; }
+    .tb.dim { opacity: .45; }
+    .omni { flex: 1; min-width: 0; height: 34px; margin: 0 8px; border-radius: 17px; background: ${t.omnibox}; display: flex; align-items: center; gap: 10px; padding: 0 12px; color: ${t.url}; font: 14px system-ui; }
+    .omni .site { display: flex; color: ${t.toolbarIcon}; }
+    .omni .url { flex: 1; min-width: 0; white-space: nowrap; overflow: hidden; text-overflow: ellipsis; }
+    .omni .dim { color: ${t.urlDim}; }
+    .omni .star { display: flex; color: ${t.toolbarIcon}; }
+    .avatar { flex: none; width: 26px; height: 26px; margin: 0 4px; border-radius: 50%; background: #7cacf8; color: #fff; display: grid; place-items: end center; overflow: hidden; }
+  </style>`;
+}
+
+
+/**
+ * The window's tab strip and toolbar as a standalone SVG image, `w` wide and the bars' height
+ * high (scale it when drawing), for an extension page to draw on a canvas: `new Image()` with a
+ * `data:image/svg+xml` URL of it, then `drawImage`. Images in it (the tabs' icons, `ext`) must be
+ * `data:` URLs: an SVG image loads nothing else.
+ *
+ * @param {Parameters<typeof windowChrome>[0]} options - As {@link windowChrome}.
+ * @returns {string} The SVG markup.
+ * @example
+ * const svg = windowChromeSvg({ tabs: [{ title: 'Example', icon: letterIcon('E', '#1a73e8'), active: true }], url: 'example.com', w: 1280 });
+ */
+export function windowChromeSvg(options) {
+  const w = options.w ?? WINDOW_W;
+  return svgImage(windowChrome({ ...options, w }), w, WINDOW_BARS.strip + WINDOW_BARS.toolbar);
+}
+
+/**
+ * A plain macOS window's title bar, as HTML: the traffic lights at the left, the title after
+ * them (macOS 26 on), a hairline below.
+ *
+ * @param {object} options - What to draw.
+ * @param {string} options.title - The window's title.
+ * @param {Theme} [options.theme] - Default light.
+ * @param {number} [options.w] - The window's width. Default {@link WINDOW_W}.
+ * @returns {string} The HTML, with its own styles.
+ */
+function macTitleBar({ title, theme = 'light', w = WINDOW_W }) {
+  const t = THEMES[theme];
+  return `
+  <div class="bar" style="width:${w}px">${trafficLights({ left: 9, top: 9, size: 14, gap: 9 })}<span class="title">${esc(title)}</span></div>
+  <style>
+    .bar { position: relative; height: ${MAC_WINDOW.titleBar}px; background: ${t.titleBar}; border-bottom: 1px solid ${t.titleLine}; box-sizing: border-box; }
+    ${LIGHTS_CSS}
+    .title { position: absolute; left: 85px; right: 16px; top: 0; color: ${t.tabText}; font: 600 13px/${MAC_WINDOW.titleBar - 1}px system-ui; white-space: nowrap; overflow: hidden; text-overflow: ellipsis; }
+  </style>`;
+}
+
+/**
+ * A plain macOS window's title bar as a standalone SVG image, `w` wide and `MAC_WINDOW.titleBar`
+ * high (scale it when drawing), for an extension page to draw on a canvas as
+ * {@link windowChromeSvg}'s bars are drawn. The window's corners (`MAC_WINDOW.radius`) and its
+ * shadow (`THEMES[theme].windowShadow`) are the canvas's to draw.
+ *
+ * @param {Parameters<typeof macTitleBar>[0]} options - As {@link macTitleBar}.
+ * @returns {string} The SVG markup.
+ * @example
+ * const svg = macWindowSvg({ title: 'Example', theme: 'dark', w: 1280 });
+ */
+export function macWindowSvg(options) {
+  const w = options.w ?? WINDOW_W;
+  return svgImage(macTitleBar({ ...options, w }), w, MAC_WINDOW.titleBar);
+}
+
+/**
+ * HTML as a standalone SVG image, `w` × `h`.
+ *
+ * @param {string} html - The HTML (XML-clean).
+ * @param {number} w - Its width (px).
+ * @param {number} h - Its height.
+ * @returns {string} The SVG markup.
+ */
+function svgImage(html, w, h) {
+  return `<svg xmlns="http://www.w3.org/2000/svg" width="${w}" height="${h}" viewBox="0 0 ${w} ${h}">`
+    + `<foreignObject x="0" y="0" width="${w}" height="${h}">`
+    + `<div xmlns="http://www.w3.org/1999/xhtml" style="width:${w}px;height:${h}px;margin:0;-webkit-font-smoothing:antialiased">${html}</div>`
+    + '</foreignObject></svg>';
+}

package/src/index.d.ts

@@ -2,8 +2,9 @@
  * The kit's browser half: what an extension's pages, offscreen document,
  * service worker and content scripts load, Chrome's page components (the ⋮
  * menu, the text dialog, the toast with Undo, a settings card's site list,
- * the built-in AI row), per-site lists' sites, Chrome's on-device model, and
- * a content script's slices and change watcher included. Every function takes the `chrome`
+ * the built-in AI row), Chrome's window drawn around a capture, per-site lists' sites, Chrome's on-device model,
+ * a content script's slices, change watcher and overlay, a module's function called in a page,
+ * and a tab's side panel opened from a click. Every function takes the `chrome`
  * APIs it uses as arguments, so tests run the real logic against fakes.
  *
  * Build-time helpers are in `@arraypress/extension-kit/build`, test helpers
@@ -15,12 +16,16 @@
 export { githubAboutLinks, isPlaceholder } from './about/links.js';
 export { MODEL_MESSAGES, chromeLanguageModel, createModelSession, describeModel, downloadModel, modelAvailability, } from './ai/model.js';
 export { setShortcuts } from './commands/shortcuts.js';
-export { BLOCK_CHARS, SLICE_MS, blocksOf, inSlices } from './content/slices.js';
+export { BLOCK_CHARS, SLICE_MS, blocksOf, eachInSlices, inSlices } from './content/slices.js';
+export { pageOverlay } from './content/overlay.js';
 export { MAX_WAIT_MS, SETTLE_MS, watchChanges } from './content/watch.js';
 export { focusedElement } from './dom/focus.js';
+export { MAC_WINDOW, THEMES, WINDOW_BARS, WINDOW_W, letterIcon, macWindowSvg, windowChrome, windowChromeSvg } from './frame/window.js';
 export { localize, translator } from './dom/i18n.js';
 export { byId, setAboutLinks, statusFlasher, valueRow } from './dom/page.js';
 export { setUpPage } from './dom/setup.js';
+export { openSidePanel, sidePanelPath } from './panel/side-panel.js';
+export { callInPage, importAndCall } from './scripting/call.js';
 export { contentScriptSync } from './scripting/registration.js';
 export { createSettingsSaver } from './settings/saver.js';
 export { MAX_SYNC_ITEM_BYTES } from './settings/storage.js';
@@ -45,9 +50,14 @@ export type ModelAnswer = import('./ai/model.js').ModelAnswer;
 export type ModelSession = import('./ai/model.js').ModelSession;
 export type ModelStatus = import('./ai/model.js').ModelStatus;
 export type SliceOptions = import('./content/slices.js').SliceOptions;
+export type PageOverlay = import('./content/overlay.js').PageOverlay;
 export type WatchHandlers = import('./content/watch.js').WatchHandlers;
+export type WindowTab = import('./frame/window.js').Tab;
+export type WindowTheme = import('./frame/window.js').Theme;
+export type WindowShadow = import('./frame/window.js').WindowShadow;
 export type ModelRow = import('./ui/model-row.js').ModelRow;
 export type ContentScript = import('./scripting/registration.js').ContentScript;
+export type FrameResult = import('./scripting/call.js').FrameResult<unknown>;
 export type ActionMenu = import('./ui/menu.js').ActionMenu;
 export type MenuEntry = import('./ui/menu.js').MenuEntry;
 export type MenuItem = import('./ui/menu.js').MenuItem;
@@ -69,9 +79,14 @@ export type Toast = import('./ui/toast.js').Toast;
  * @typedef {import('./ai/model.js').ModelSession} ModelSession
  * @typedef {import('./ai/model.js').ModelStatus} ModelStatus
  * @typedef {import('./content/slices.js').SliceOptions} SliceOptions
+ * @typedef {import('./content/overlay.js').PageOverlay} PageOverlay
  * @typedef {import('./content/watch.js').WatchHandlers} WatchHandlers
+ * @typedef {import('./frame/window.js').Tab} WindowTab
+ * @typedef {import('./frame/window.js').Theme} WindowTheme
+ * @typedef {import('./frame/window.js').WindowShadow} WindowShadow
  * @typedef {import('./ui/model-row.js').ModelRow} ModelRow
  * @typedef {import('./scripting/registration.js').ContentScript} ContentScript
+ * @typedef {import('./scripting/call.js').FrameResult<unknown>} FrameResult
  * @typedef {import('./ui/menu.js').ActionMenu} ActionMenu
  * @typedef {import('./ui/menu.js').MenuEntry} MenuEntry
  * @typedef {import('./ui/menu.js').MenuItem} MenuItem

package/src/index.js

@@ -2,8 +2,9 @@
  * The kit's browser half: what an extension's pages, offscreen document,
  * service worker and content scripts load, Chrome's page components (the ⋮
  * menu, the text dialog, the toast with Undo, a settings card's site list,
- * the built-in AI row), per-site lists' sites, Chrome's on-device model, and
- * a content script's slices and change watcher included. Every function takes the `chrome`
+ * the built-in AI row), Chrome's window drawn around a capture, per-site lists' sites, Chrome's on-device model,
+ * a content script's slices, change watcher and overlay, a module's function called in a page,
+ * and a tab's side panel opened from a click. Every function takes the `chrome`
  * APIs it uses as arguments, so tests run the real logic against fakes.
  *
  * Build-time helpers are in `@arraypress/extension-kit/build`, test helpers
@@ -18,12 +19,16 @@ export {
   MODEL_MESSAGES, chromeLanguageModel, createModelSession, describeModel, downloadModel, modelAvailability,
 } from './ai/model.js';
 export { setShortcuts } from './commands/shortcuts.js';
-export { BLOCK_CHARS, SLICE_MS, blocksOf, inSlices } from './content/slices.js';
+export { BLOCK_CHARS, SLICE_MS, blocksOf, eachInSlices, inSlices } from './content/slices.js';
+export { pageOverlay } from './content/overlay.js';
 export { MAX_WAIT_MS, SETTLE_MS, watchChanges } from './content/watch.js';
 export { focusedElement } from './dom/focus.js';
+export { MAC_WINDOW, THEMES, WINDOW_BARS, WINDOW_W, letterIcon, macWindowSvg, windowChrome, windowChromeSvg } from './frame/window.js';
 export { localize, translator } from './dom/i18n.js';
 export { byId, setAboutLinks, statusFlasher, valueRow } from './dom/page.js';
 export { setUpPage } from './dom/setup.js';
+export { openSidePanel, sidePanelPath } from './panel/side-panel.js';
+export { callInPage, importAndCall } from './scripting/call.js';
 export { contentScriptSync } from './scripting/registration.js';
 export { createSettingsSaver } from './settings/saver.js';
 export { MAX_SYNC_ITEM_BYTES } from './settings/storage.js';
@@ -56,9 +61,14 @@ export { TOAST_MS, createToast } from './ui/toast.js';
  * @typedef {import('./ai/model.js').ModelSession} ModelSession
  * @typedef {import('./ai/model.js').ModelStatus} ModelStatus
  * @typedef {import('./content/slices.js').SliceOptions} SliceOptions
+ * @typedef {import('./content/overlay.js').PageOverlay} PageOverlay
  * @typedef {import('./content/watch.js').WatchHandlers} WatchHandlers
+ * @typedef {import('./frame/window.js').Tab} WindowTab
+ * @typedef {import('./frame/window.js').Theme} WindowTheme
+ * @typedef {import('./frame/window.js').WindowShadow} WindowShadow
  * @typedef {import('./ui/model-row.js').ModelRow} ModelRow
  * @typedef {import('./scripting/registration.js').ContentScript} ContentScript
+ * @typedef {import('./scripting/call.js').FrameResult<unknown>} FrameResult
  * @typedef {import('./ui/menu.js').ActionMenu} ActionMenu
  * @typedef {import('./ui/menu.js').MenuEntry} MenuEntry
  * @typedef {import('./ui/menu.js').MenuItem} MenuItem

package/src/panel/side-panel.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Opening Chrome's side panel for one tab, from a click: the panel is the
+ * tab's own (no `side_panel` in the manifest, no global panel), so it shows
+ * only beside the page it's about and goes when the person switches tabs, as
+ * Chrome does for a tab's panel. Chrome opens a panel only while the click
+ * still counts, so nothing is awaited before `open`.
+ *
+ * @module panel/side-panel
+ */
+export type SidePanelApi = Pick<typeof chrome.sidePanel, 'setOptions' | 'open'>;
+/**
+ * The parts of `chrome.sidePanel` opening one uses.
+ *
+ * @typedef {Pick<typeof chrome.sidePanel, 'setOptions' | 'open'>} SidePanelApi
+ */
+/**
+ * The panel page's address for a tab: `path?tab=<id>`, so the page knows its tab.
+ *
+ * @param {string} path - The panel page, `panel/panel.html`.
+ * @param {number} tabId - The tab.
+ * @returns {string} `panel/panel.html?tab=12`.
+ */
+export declare const sidePanelPath: (path: string, tabId: number) => string;
+/**
+ * Open the side panel beside a tab, from a click (the toolbar button's, a
+ * shortcut's, or a button on an extension page).
+ *
+ * @param {SidePanelApi} sidePanel - `chrome.sidePanel` (or a fake in tests).
+ * @param {number} tabId - The tab.
+ * @param {string} path - The panel page; it gets `?tab=<id>`.
+ * @returns {Promise<void>} Once it's open; rejects when Chrome refuses (no click behind it).
+ * @example
+ * chrome.action.onClicked.addListener((tab) => openSidePanel(chrome.sidePanel, tab.id, 'panel/panel.html'));
+ */
+export declare function openSidePanel(sidePanel: SidePanelApi, tabId: number, path: string): Promise<void>;

package/src/panel/side-panel.js

@@ -0,0 +1,41 @@
+/**
+ * Opening Chrome's side panel for one tab, from a click: the panel is the
+ * tab's own (no `side_panel` in the manifest, no global panel), so it shows
+ * only beside the page it's about and goes when the person switches tabs, as
+ * Chrome does for a tab's panel. Chrome opens a panel only while the click
+ * still counts, so nothing is awaited before `open`.
+ *
+ * @module panel/side-panel
+ */
+
+/**
+ * The parts of `chrome.sidePanel` opening one uses.
+ *
+ * @typedef {Pick<typeof chrome.sidePanel, 'setOptions' | 'open'>} SidePanelApi
+ */
+
+/**
+ * The panel page's address for a tab: `path?tab=<id>`, so the page knows its tab.
+ *
+ * @param {string} path - The panel page, `panel/panel.html`.
+ * @param {number} tabId - The tab.
+ * @returns {string} `panel/panel.html?tab=12`.
+ */
+export const sidePanelPath = (path, tabId) => `${path}?tab=${tabId}`;
+
+/**
+ * Open the side panel beside a tab, from a click (the toolbar button's, a
+ * shortcut's, or a button on an extension page).
+ *
+ * @param {SidePanelApi} sidePanel - `chrome.sidePanel` (or a fake in tests).
+ * @param {number} tabId - The tab.
+ * @param {string} path - The panel page; it gets `?tab=<id>`.
+ * @returns {Promise<void>} Once it's open; rejects when Chrome refuses (no click behind it).
+ * @example
+ * chrome.action.onClicked.addListener((tab) => openSidePanel(chrome.sidePanel, tab.id, 'panel/panel.html'));
+ */
+export function openSidePanel(sidePanel, tabId, path) {
+  // Not awaited: open() must be called while the click still counts.
+  sidePanel.setOptions({ tabId, path: sidePanelPath(path, tabId), enabled: true }).catch((error) => console.error('Setting the side panel up:', error));
+  return sidePanel.open({ tabId });
+}