@simon-says-build/ssb-overlay 0.5.1 → 0.7.0

package/index.d.ts

@@ -39,7 +39,19 @@ export function SsbHost(props: {
    * Without it there is no Talk button.
    */
   voice?: { Room: new (opts?: object) => any; startAudio?: () => Promise<void> | void; stopAudio?: () => Promise<void> | void };
+  /**
+   * What this build is, over what the overlay reads itself (0.7.0): sent with the
+   * push token so SSB knows what is installed. `devClient: false` makes "Ready to
+   * see" pushes say the news without a preview link this build can't open.
+   */
+  client?: { app?: string; build?: string; ota?: string; os?: string; devClient?: boolean };
   /** Keep the button off the home indicator / tab bar. Default {top: 60, bottom: 40}. */
   insets?: { top?: number; bottom?: number };
+  /**
+   * Which build this is: the origin the app's JS bundle was loaded from (a
+   * SimonSays preview's tunnel). Read off the bundle when omitted; Ready lists
+   * only what this build holds, and ▶ Demo plays it here.
+   */
+  bundle?: string;
   children?: ReactNode;
 }): ReactNode;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simon-says-build/ssb-overlay",
-  "version": "0.5.1",
+  "version": "0.7.0",
   "description": "The SSB button inside a native app SimonSays controls: screenshot the screen, mark it, and ask SSB for a change. Renders nothing for anyone SSB does not let in.",
   "repository": {
     "type": "git",
@@ -22,6 +22,7 @@
     "README.md"
   ],
   "peerDependencies": {
+    "@simon-says-build/demo-player": ">=0.1.0",
     "react": ">=18",
     "react-native": ">=0.76"
   },

package/src/SsbHost.js

@@ -21,11 +21,14 @@
 import React, { useCallback, useEffect, useMemo, useRef, useState } from 'react';
 import {
   ActivityIndicator, Image, Keyboard, KeyboardAvoidingView, Linking, PanResponder, Platform, Pressable,
-  ScrollView, StyleSheet, Text, TextInput, View, useWindowDimensions,
+  NativeModules, ScrollView, StyleSheet, Text, TextInput, View, useWindowDimensions,
 } from 'react-native';
+// The app's demo player (a peer): ▶ Demo hands it the demo to play in this
+// build. An older player has no playDemo, and the button is not offered.
+import { playDemo, PLAYER_VERSION } from '@simon-says-build/demo-player';
 import {
   FAB, addPoint, clampFab, demoBanner, fabHome, isDrag, describeHost, draftsOf, fieldTop, inAppApi, namedHosts, newReply, offerOf,
-  STATE_WORD, boxItem, workView, drawingBox, drawingMark, drawingPoint, itemRect, overlayConfig, pollEvery, SNAPSHOT_TOPIC, snapshotOf, talkLine, segmentsOf, sendBody, smallestAt, ssbLinkOf,
+  STATE_WORD, boxItem, bundleOriginOf, clientInfo, elsewhereLine, workView, drawingBox, drawingMark, drawingPoint, itemRect, overlayConfig, pollEvery, SNAPSHOT_TOPIC, snapshotOf, talkLine, segmentsOf, sendBody, smallestAt, ssbLinkOf,
 } from './core.js';
 
 const h = React.createElement;
@@ -65,11 +68,31 @@ const frames = (n = 2) => new Promise((resolve) => {
   step(n);
 });
 
-export function SsbHost({ appId, backend, api, getToken, sessionKey, route, capture, storage, pushToken, notifications, voice, insets, children }) {
+// Where this app's JS was loaded from: a preview's tunnel, or a file.
+const scriptURL = () => {
+  try { const sc = NativeModules.SourceCode; return sc?.getConstants?.()?.scriptURL ?? sc?.scriptURL ?? ''; } catch { return ''; }
+};
+
+// What this build is, for the push registration (core.js clientInfo). Each
+// read is optional: an app without expo-application or a dev launcher still
+// registers, it just says less.
+function buildInfo(override) {
+  const mods = globalThis.expo?.modules || {};
+  const appMod = mods.ExpoApplication || NativeModules.ExpoApplication || {};
+  const updates = mods.ExpoUpdates || NativeModules.ExpoUpdates || {};
+  const hasLauncher = !!(mods.ExpoDevLauncher || mods.ExpoDevLauncherInternal || NativeModules.EXDevLauncher || NativeModules.EXDevLauncherInternal);
+  return clientInfo({
+    player: PLAYER_VERSION, app: appMod.nativeApplicationVersion, build: appMod.nativeBuildVersion,
+    os: `${Platform.OS} ${Platform.Version ?? ''}`.trim(),
+    runtime: typeof updates.runtimeVersion === 'string' ? updates.runtimeVersion : undefined, hasLauncher, bundleOrigin: bundleOriginOf(scriptURL()), override,
+  });
+}
+
+export function SsbHost({ appId, backend, api, getToken, sessionKey, route, capture, storage, pushToken, notifications, voice, insets, bundle, client, children }) {
   const config = useMemo(() => overlayConfig({ appId, backend, api }), [appId, backend, api]);
   useSsbLinks(notifications);
   if (!config || typeof getToken !== 'function') return children ?? null;
-  return h(Host, { config, getToken, sessionKey, route, capture, storage, pushToken, voice, insets: { ...DEFAULT_INSETS, ...(insets || {}) } }, children);
+  return h(Host, { config, getToken, sessionKey, route, capture, storage, pushToken, voice, bundle, client, insets: { ...DEFAULT_INSETS, ...(insets || {}) } }, children);
 }
 
 // A tapped "Ready to see" notification (functions/in-app-notify.mjs) opens
@@ -85,7 +108,12 @@ function useSsbLinks(notifications) {
   }, [notifications]);
 }
 
-function Host({ config, getToken, sessionKey, route, capture, storage, pushToken, voice, insets, children }) {
+function Host({ config, getToken, sessionKey, route, capture, storage, pushToken, voice, insets, bundle, client, children }) {
+  // WHICH BUILD THIS IS (docs/IN-APP-SSB.md "Ready is this build"): Ready is
+  // only what this bundle holds. `bundle` overrides (the harness); else the
+  // origin the JS came from.
+  const here = useMemo(() => (bundle !== undefined ? String(bundle || '') : bundleOriginOf(scriptURL())), [bundle]);
+  const [elsewhere, setElsewhere] = useState([]);
   const screen = useWindowDimensions();
   const tokenRef = useRef(getToken);
   tokenRef.current = getToken;
@@ -134,7 +162,7 @@ function Host({ config, getToken, sessionKey, route, capture, storage, pushToken
       if (!live) return;
       setGate(g?.show ? g : null);
       // This device, for "it's done, tap to see it" — only for someone SSB let in.
-      if (g?.show && pushToken) Promise.resolve(pushToken()).then((t) => (t ? ssb.pushToken(t, Platform.OS) : null)).catch(() => {});
+      if (g?.show && pushToken) Promise.resolve(pushToken()).then((t) => (t ? ssb.pushToken(t, Platform.OS, buildInfo(client)) : null)).catch(() => {});
     }).catch(() => { if (live) setGate(null); });
     return () => { live = false; };
   }, [ssb, sessionKey]);
@@ -181,7 +209,18 @@ function Host({ config, getToken, sessionKey, route, capture, storage, pushToken
   const open = mode !== 'idle';
   useEffect(() => { if (open) load(); }, [open, chatId]);
   // The top of the panel: the app's work, asked when it opens and while it stays open.
-  const loadWork = useCallback(async () => { try { setWork((await ssb.work())?.inFlight || []); } catch { /* the last list stands */ } }, [ssb]);
+  const loadWork = useCallback(async () => {
+    try { const r = await ssb.work(here); setWork(r?.inFlight || []); setElsewhere(r?.readyElsewhere || []); } catch { /* the last list stands */ }
+  }, [ssb, here]);
+  // ▶ Demo: one demo of everything Ready in this build, played by this build.
+  const startDemo = useCallback(async () => {
+    setBusy(true); setError(null);
+    try {
+      const r = await ssb.demo(here);
+      if (!playDemo({ id: r.demoId, token: r.token, api: config.api, here: true })) throw new Error('the demo could not start');
+      Keyboard.dismiss(); setMode('idle');
+    } catch (e) { setError(e.message); } finally { setBusy(false); }
+  }, [ssb, here, config.api]);
   useEffect(() => {
     if (mode !== 'sheet' || !gate) return undefined;
     loadWork();
@@ -445,7 +484,8 @@ function Host({ config, getToken, sessionKey, route, capture, storage, pushToken
           h(Pressable, { testID: 'ssb-draw-send', onPress: sendDrawing, disabled: !note.trim() || busy, accessibilityRole: 'button', accessibilityLabel: 'Send to SSB', style: [s.sendRound, (!note.trim() || busy) && s.disabled] }, h(Text, { style: s.sendRoundText }, '→'))) : null);
     }
     if (mode === 'sheet') return h(Panel, {
-      gate, chat, work, screen, insets, draft, setDraft, busy, error,
+      gate, chat, work, screen, insets, draft, setDraft, busy, error, elsewhere,
+      onDemo: typeof playDemo === 'function' ? startDemo : null,
       onSend: sendDraft, onDraw: () => { Keyboard.dismiss(); setMode('drawing'); }, onClose: close,
       canTalk: !!voice?.Room, talk, onTalk: startTalk, onEndTalk: endTalk, onMute: toggleMute,
       onNew: () => { rememberChat(null); setChat(null); }, onDecide: decide, onStartAll: startAll, onOpenLink: openLink,
@@ -458,14 +498,16 @@ function Host({ config, getToken, sessionKey, route, capture, storage, pushToken
     h(View, { ref: chromeRef, collapsable: false, pointerEvents: 'box-none', style: StyleSheet.absoluteFill }, chrome));
 }
 
-function Panel({ gate, chat, work, screen, insets, draft, setDraft, busy, error, onSend, onDraw, onClose, onNew, onDecide, onStartAll, onOpenLink, canTalk, talk, onTalk, onEndTalk, onMute }) {
+function Panel({ gate, chat, work, elsewhere, onDemo, screen, insets, draft, setDraft, busy, error, onSend, onDraw, onClose, onNew, onDecide, onStartAll, onOpenLink, canTalk, talk, onTalk, onEndTalk, onMute }) {
   const scroll = useRef(null);
   const [open, setOpen] = useState(null);            // the draft whose detail is shown
   const { flying, waiting, sent } = workView({ inFlight: work, chat });
   const offer = offerOf(chat);
   const banner = demoBanner(chat);
   const msgs = chat?.messages || [];
-  const hasWork = flying.length || waiting.length || sent.length || banner;
+  const ready = flying.filter((x) => x.state === 'ready');
+  const away = elsewhereLine(elsewhere);
+  const hasWork = flying.length || waiting.length || sent.length || banner || away;
   const showMe = (x) => (x.state === 'ready' && banner?.url ? banner.url : null);
   return h(View, { style: [s.panel, { paddingTop: insets.top }], testID: 'ssb-panel' },
     h(KeyboardAvoidingView, { behavior: Platform.OS === 'ios' ? 'padding' : undefined, style: { flex: 1 } },
@@ -482,7 +524,10 @@ function Panel({ gate, chat, work, screen, insets, draft, setDraft, busy, error,
           testID: 'ssb-demo', disabled: !banner.url, onPress: () => onOpenLink(banner.url),
           accessibilityRole: banner.url ? 'button' : 'text', style: [s.demo, banner.url && s.demoReady],
         }, h(Text, { style: [s.demoText, banner.url && { color: '#fff' }] }, banner.text), banner.url ? h(Text, { style: s.demoGo }, '▶ See it') : null) : null,
-        flying.length ? h(Text, { style: s.section, testID: 'ssb-section-flight' }, 'In flight') : null,
+        flying.length ? h(View, { style: s.sectionRow },
+          h(Text, { style: [s.section, { flex: 1 }], testID: 'ssb-section-flight' }, 'In flight'),
+          ready.length && onDemo ? h(Pressable, { testID: 'ssb-demo-ready', onPress: onDemo, disabled: busy, accessibilityRole: 'button', accessibilityLabel: `Demo what is ready in this build (${ready.length})`, style: [s.primary, s.small, busy && s.disabled] },
+            h(Text, { style: s.primaryText }, `▶ Demo (${ready.length})`)) : null) : null,
         // A row opens its job in the SimonSays app, the console when that app
         // is not on the phone (functions/in-app.mjs jobLinksFor) — for those
         // who can open it there; anyone else's rows stay plain.
@@ -494,6 +539,7 @@ function Panel({ gate, chat, work, screen, insets, draft, setDraft, busy, error,
           showMe(x)
             ? h(Pressable, { onPress: () => onOpenLink(showMe(x)), accessibilityRole: 'button', accessibilityLabel: `Show me: ${x.title}`, style: [s.primary, s.small] }, h(Text, { style: s.primaryText }, '▶ Show me'))
             : h(Text, { style: [s.state, s[`state_${x.state}`]] }, STATE_WORD[x.state] || x.state))),
+        away ? h(Text, { style: [s.draftBody, { paddingHorizontal: 16, paddingVertical: 8 }], testID: 'ssb-ready-elsewhere' }, away) : null,
         waiting.length ? h(View, { style: s.sectionRow },
           h(Text, { style: [s.section, { flex: 1 }] }, 'Drafts'),
           waiting.length > 1 ? h(Pressable, { testID: 'ssb-start-all', onPress: onStartAll, disabled: busy, accessibilityRole: 'button', accessibilityLabel: 'Start all', style: [s.primary, s.small, busy && s.disabled] }, h(Text, { style: s.primaryText }, `Start all (${waiting.length})`)) : null) : null,

package/src/core.js

@@ -3,6 +3,9 @@
 // (functions/annotate.mjs), so the shapes below are the extension's.
 
 export const DEFAULT_API = 'https://simonsays.build';
+// What this overlay is, said when it registers for pushes (clientInfo below).
+// Kept equal to package.json by test/core.test.mjs.
+export const OVERLAY_VERSION = '0.7.0';
 export const HOST = 5;
 export const TEXT = 6;
 const PIN_SLOP = 12;           // a drag shorter than this is a tap: a pin, not a box
@@ -41,9 +44,13 @@ export function inAppApi(config, getToken, fetchImpl = globalThis.fetch) {
     send: (body) => post('/annotations', body),
     chat: (id) => call(`/chats/${encodeURIComponent(id)}`),
     decide: (chatId, proposalId, action, body) => post(`/chats/${encodeURIComponent(chatId)}/proposals/${encodeURIComponent(proposalId)}/${action}`, body),
-    pushToken: (token, platform) => post('/push-token', { token, platform }),
+    // `client`: what this build is (clientInfo), so SSB knows what is installed.
+    pushToken: (token, platform, client) => post('/push-token', { token, platform, ...(client ? { client } : {}) }),
     voice: (body) => post('/voice', body),
-    work: () => call('/work'),
+    // `bundle`: where this app's JS came from (a preview's tunnel), so SSB
+    // scopes Ready to this build; undefined = the whole list, as before.
+    work: (bundle) => call(bundle === undefined ? '/work' : `/work?bundle=${encodeURIComponent(bundle)}`),
+    demo: (bundle) => post('/demo', { bundle }),
   };
 }
 
@@ -308,3 +315,30 @@ export function workView({ inFlight = [], chat = null } = {}) {
   const { waiting, sent } = draftsOf(chat);
   return { flying, waiting, sent: sent.filter((p) => !p.jobId || !flyingIds.has(p.jobId)) };
 }
+
+// READY IS THIS BUILD (2026-10-20, docs/IN-APP-SSB.md): the origin the app's
+// JS bundle was loaded from — a preview's tunnel — or "" for a build that
+// loads from a file (a store or local build, which holds no SSB preview).
+export function bundleOriginOf(scriptURL) {
+  const m = /^(https?:\/\/[^/?#]+)/i.exec(String(scriptURL || ''));
+  return m ? m[1] : '';
+}
+// What the overlay says about Ready work this build does not hold.
+export function elsewhereLine(readyElsewhere = []) {
+  const n = (readyElsewhere || []).reduce((t, x) => t + (Number(x?.count) || 0), 0);
+  if (!n) return '';
+  return `${n === 1 ? '1 more change is' : `${n} more changes are`} ready in another build — open its preview to see ${n === 1 ? 'it' : 'them'}.`;
+}
+
+// WHAT IS INSTALLED (0.7.0, docs/IN-APP-SSB.md "What is installed"): said with
+// the push token, so SSB knows which builds can open a "Ready to see" preview.
+// `devClient`: a dev launcher is in the binary → true; none, and the JS came
+// from a file (a store or release build) → false; otherwise unknown (absent),
+// and SSB sends the link as before. The host's `client` prop outranks all of it.
+export function clientInfo({ player, app, build, os, runtime, hasLauncher, bundleOrigin, override } = {}) {
+  const devClient = hasLauncher ? true : bundleOrigin === '' ? false : undefined;
+  // `runtime`: expo-updates' runtimeVersion, which under the fingerprint policy
+  // IS the native fingerprint a preview is gated on (docs/DEV-CLIENTS.md).
+  const out = { overlay: OVERLAY_VERSION, player, app, build, os, runtime, devClient, ...(override || {}) };
+  return Object.fromEntries(Object.entries(out).filter(([, v]) => v !== undefined && v !== null && v !== ''));
+}