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

package/index.d.ts

@@ -39,6 +39,12 @@ 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 };
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simon-says-build/ssb-overlay",
-  "version": "0.6.0",
+  "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",

package/src/SsbHost.js

@@ -25,10 +25,10 @@ import {
 } 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 } from '@simon-says-build/demo-player';
+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, bundleOriginOf, elsewhereLine, 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;
@@ -73,11 +73,26 @@ const scriptURL = () => {
   try { const sc = NativeModules.SourceCode; return sc?.getConstants?.()?.scriptURL ?? sc?.scriptURL ?? ''; } catch { return ''; }
 };
 
-export function SsbHost({ appId, backend, api, getToken, sessionKey, route, capture, storage, pushToken, notifications, voice, insets, bundle, children }) {
+// 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, bundle, 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
@@ -93,7 +108,7 @@ function useSsbLinks(notifications) {
   }, [notifications]);
 }
 
-function Host({ config, getToken, sessionKey, route, capture, storage, pushToken, voice, insets, bundle, 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.
@@ -147,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]);

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,7 +44,8 @@ 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),
     // `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.
@@ -325,3 +329,16 @@ export function elsewhereLine(readyElsewhere = []) {
   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 !== ''));
+}