@nominalso/vibe-bridge 0.5.0 → 0.6.0

package/dist/index.cjs

@@ -28,17 +28,14 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
-var index_exports = {};
-__export(index_exports, {
-  BRIDGE_VERSION: () => version,
+var src_exports = {};
+__export(src_exports, {
+  BRIDGE_VERSION: () => BRIDGE_VERSION,
   BridgeError: () => BridgeError,
   HttpBridgeError: () => HttpBridgeError,
   VibeAppBridge: () => VibeAppBridge
 });
-module.exports = __toCommonJS(index_exports);
-
-// package.json
-var version = "0.5.0";
+module.exports = __toCommonJS(src_exports);
 
 // ../protocol-types/dist/index.js
 function normalizeSubroute(subroute) {
@@ -69,20 +66,46 @@ function isBridgeMessage(data) {
   if (CORRELATED_KINDS_SET.has(d.kind) && typeof d.requestId !== "string") return false;
   return true;
 }
+var BRIDGE_ERROR_BRAND = /* @__PURE__ */ Symbol.for("@nominalso/vibe-bridge:BridgeError");
+var HTTP_BRIDGE_ERROR_BRAND = /* @__PURE__ */ Symbol.for("@nominalso/vibe-bridge:HttpBridgeError");
 var BridgeError = class extends Error {
   constructor(code, message) {
     super(message);
     this.code = code;
     this.name = "BridgeError";
   }
+  /**
+   * Cross-realm-safe type guard. Prefer this over `instanceof BridgeError` when
+   * an error may have been thrown by a differently-built copy of the SDK (e.g.
+   * server bundle vs client bundle) — it matches on a process-global brand
+   * rather than class identity.
+   */
+  static isBridgeError(err) {
+    return typeof err === "object" && err !== null && err[BRIDGE_ERROR_BRAND] === true;
+  }
 };
+Object.defineProperty(BridgeError.prototype, BRIDGE_ERROR_BRAND, {
+  value: true,
+  enumerable: false
+});
 var HttpBridgeError = class extends BridgeError {
   constructor(status, message) {
     super("REQUEST_FAILED", message);
     this.status = status;
     this.name = "HttpBridgeError";
   }
+  /**
+   * Cross-realm-safe type guard (see {@link BridgeError.isBridgeError}). Returns
+   * `true` only for `HttpBridgeError` instances, not plain `BridgeError`s.
+   */
+  static isHttpBridgeError(err) {
+    return typeof err === "object" && err !== null && err[HTTP_BRIDGE_ERROR_BRAND] === true;
+  }
 };
+Object.defineProperty(HttpBridgeError.prototype, HTTP_BRIDGE_ERROR_BRAND, {
+  value: true,
+  enumerable: false
+});
 function isOriginPattern(entry) {
   return entry.includes("*");
 }
@@ -111,8 +134,11 @@ function isOriginAllowed(origin, allowlist, { allowPatterns }) {
   return false;
 }
 
-// src/VibeAppBridge.ts
-var import_posthog_js = __toESM(require("posthog-js"), 1);
+// package.json
+var version = "0.6.0";
+
+// src/version.ts
+var BRIDGE_VERSION = version;
 
 // src/data-methods.ts
 var BridgeDataMethods = class {
@@ -428,13 +454,23 @@ function resolveRequestTimeout(type, requestTimeout) {
 
 // src/VibeAppBridge.ts
 function resolvePosthog(mod) {
-  let candidate = mod;
-  while (candidate && typeof candidate.init !== "function" && candidate.default) {
-    candidate = candidate.default;
-  }
-  return candidate;
+  const hasInit = (o) => typeof o?.init === "function";
+  const d1 = mod?.default;
+  if (hasInit(d1)) return d1;
+  const d2 = d1?.default;
+  if (hasInit(d2)) return d2;
+  if (hasInit(mod)) return mod;
+  return null;
+}
+function serverEnvError(method) {
+  return new BridgeError(
+    "SERVER_ENVIRONMENT",
+    `VibeAppBridge.${method} was called outside a browser (no \`window\`). The bridge only runs in the browser \u2014 call it from a client component or effect, not during SSR, in a React Server Component, or in a Worker.`
+  );
+}
+function assertBrowser(method) {
+  if (typeof window === "undefined") throw serverEnvError(method);
 }
-var posthog = resolvePosthog(import_posthog_js.default);
 var PARENT_ORIGIN_OVERRIDE_KEY = "__NOM_VIBE_PARENT_ORIGIN__";
 var PREVIEW_HOST_RE = /(?:^|\.)(?:vercel\.app|lovable\.app|lovable\.dev|lovableproject\.com)$|^(?:localhost|127\.0\.0\.1)$/;
 function isPreviewSelfHost(hostname) {
@@ -494,9 +530,22 @@ function resolveOriginPolicy(configured) {
   return { targetOrigin, isTrusted };
 }
 var VibeAppBridge = class extends BridgeDataMethods {
-  constructor({ parentOrigin, requestTimeout } = {}) {
+  /**
+   * Stores options only — **pure and side-effect-free**. No `window`,
+   * `document`, `history`, `postMessage`, `crypto`, or `posthog-js` access
+   * happens here, so constructing a bridge is safe during SSR / in a Server
+   * Component / in a Worker. Browser wiring is deferred to {@link connect} /
+   * {@link attach}.
+   */
+  constructor(options = {}) {
     super();
+    /** Concrete origin to `postMessage` to, or `null` until resolved at {@link attach}. */
+    this.targetOrigin = null;
+    /** Validates an inbound `event.origin`; rejects everything until {@link attach}. */
+    this.isTrustedOrigin = () => false;
     this.pendingRequests = /* @__PURE__ */ new Map();
+    /** Whether {@link attach} has installed the message listener + resolved origin. */
+    this.attached = false;
     this.context = null;
     /**
      * Set once {@link initPostHog} has successfully called `posthog.init()`.
@@ -504,6 +553,16 @@ var VibeAppBridge = class extends BridgeDataMethods {
      * recording is actually live.
      */
     this.posthogInitialized = false;
+    /** The lazily-imported `posthog-js` singleton, once recording is initialized. */
+    this.posthogInstance = null;
+    /**
+     * Set for the duration of an in-flight {@link initPostHog} (which is async — it
+     * awaits `import('posthog-js')`). Serializes initialization so two overlapping
+     * `POSTHOG_PUSH`es can't both call `posthog.init()`.
+     */
+    this.posthogIniting = false;
+    /** So the "posthog-js not installed" warning is logged at most once. */
+    this.posthogUnavailableWarned = false;
     this.connectPromise = null;
     this.connectPollInterval = null;
     this.connectTimeout = null;
@@ -544,8 +603,12 @@ var VibeAppBridge = class extends BridgeDataMethods {
       },
       // Persistent (not nulled after connect): the host delivers PostHog once at
       // connect via its own push, and initPostHog is idempotent, so this can run
-      // whenever the message arrives, independent of how connect() resolved.
-      POSTHOG_PUSH: (payload) => this.initPostHog(payload),
+      // whenever the message arrives, independent of how connect() resolved. Fire
+      // and forget — initPostHog is async (lazy-imports posthog-js) and swallows
+      // its own errors.
+      POSTHOG_PUSH: (payload) => {
+        void this.initPostHog(payload);
+      },
       // Persistent: the host pushes auth changes (logout, identity/tenant
       // switch) at any time after connect.
       AUTH_CHANGED: (payload) => this.authChangeCallback?.(payload),
@@ -575,42 +638,72 @@ var VibeAppBridge = class extends BridgeDataMethods {
     this.ui = {
       /** Collapse or expand the host's side navigation. */
       setSideNav: (payload) => {
+        assertBrowser("ui.setSideNav()");
         this.sendCommand("SET_SIDE_NAV", payload);
       },
       /** Switch the host to a different subsidiary. */
       switchSubsidiary: (subsidiaryId) => {
+        assertBrowser("ui.switchSubsidiary()");
         this.sendCommand("SWITCH_SUBSIDIARY", { subsidiaryId });
       }
     };
-    const policy = resolveOriginPolicy(parentOrigin);
-    this.targetOrigin = policy.targetOrigin;
-    this.isTrustedOrigin = policy.isTrusted;
-    this.requestTimeout = requestTimeout;
+    this.parentOriginOption = options.parentOrigin;
+    this.requestTimeout = options.requestTimeout;
     this.boundHandleMessage = this.handleMessage.bind(this);
-    window.addEventListener("message", this.boundHandleMessage);
   }
   dispatchPush(msg) {
     const handler = this.pushHandlers[msg.type];
     handler(msg.payload);
   }
+  /**
+   * Installs the browser wiring: resolves the parent-origin policy and starts
+   * listening for host `postMessage`s. **Idempotent** and safe to call before
+   * {@link connect} if you want the bridge receiving pushes early; {@link
+   * connect} calls it for you, so most apps never call this directly.
+   *
+   * @throws `BridgeError` code `'SERVER_ENVIRONMENT'` if called where there is no
+   *   `window`.
+   */
+  attach() {
+    assertBrowser("attach()");
+    if (this.attached) return;
+    const policy = resolveOriginPolicy(this.parentOriginOption);
+    this.targetOrigin = policy.targetOrigin;
+    this.isTrustedOrigin = policy.isTrusted;
+    window.addEventListener("message", this.boundHandleMessage);
+    this.attached = true;
+  }
+  /**
+   * Lazily installs the browser wiring on first transport use. Keeps the
+   * constructor pure while ensuring that any method reaching the wire (a data
+   * `request`, a fire-and-forget command) works without an explicit prior
+   * `attach()`/`connect()` — attach stays idempotent, so `connect()` is
+   * unaffected.
+   */
+  ensureAttached() {
+    if (!this.attached) this.attach();
+  }
   /**
    * Connects to the host and returns the tenant/user {@link ContextPayload}.
    * **Call this once on app init and await it before any other method** — data
    * methods, `upload()`, and subroute reporting all require an established
    * connection. Concurrent calls return the same promise.
    *
-   * Sends a `CONNECT` handshake, re-sending every 500ms until the host replies
-   * by pushing the context (so it works even if the host mounts after the
-   * iframe loads). Context is only ever delivered by push. Rejects with `Bridge
-   * connect timed out` after 10 seconds if no context arrives (usually a
-   * `parentOrigin` mismatch or the host hasn't mounted).
+   * First {@link attach | attaches} the browser wiring (message listener +
+   * origin resolution), then sends a `CONNECT` handshake, re-sending every 500ms
+   * until the host replies by pushing the context (so it works even if the host
+   * mounts after the iframe loads). Context is only ever delivered by push.
+   * Rejects with `Bridge connect timed out` after 10 seconds if no context
+   * arrives (usually a `parentOrigin` mismatch or the host hasn't mounted).
    *
    * After connecting, if the context includes an initial subroute (e.g. from
    * a deep link), the bridge navigates to it and starts auto-tracking
    * internal navigation via the history API.
    *
    * @returns The tenant/user/subsidiary context for this app session.
-   * @throws If no context is received within 10 seconds.
+   * @throws Rejects with `BridgeError` code `'SERVER_ENVIRONMENT'` if called
+   *   where there is no `window`, `'PARENT_ORIGIN_UNRESOLVED'` if no embedding
+   *   origin could be resolved, or `'TIMEOUT'` if no context arrives in 10s.
    * @example
    * ```ts
    * const ctx = await bridge.connect()
@@ -618,8 +711,10 @@ var VibeAppBridge = class extends BridgeDataMethods {
    * ```
    */
   connect() {
+    if (typeof window === "undefined") return Promise.reject(serverEnvError("connect()"));
     if (this.context) return Promise.resolve(this.context);
     if (this.connectPromise) return this.connectPromise;
+    this.attach();
     if (this.targetOrigin === null) {
       return Promise.reject(
         new BridgeError(
@@ -653,7 +748,7 @@ var VibeAppBridge = class extends BridgeDataMethods {
         this.onContextReceived = null;
         this.rejectConnect = null;
         console.log(
-          `[vibe-bridge] Connected \u2014 bridge: ${version}, host: ${ctx.hostVersion}, tenant: ${ctx.tenant}, user: ${ctx.user.displayName}`
+          `[vibe-bridge] Connected \u2014 bridge: ${BRIDGE_VERSION}, host: ${ctx.hostVersion}, tenant: ${ctx.tenant}, user: ${ctx.user.displayName}`
         );
         const initialSubroute = ctx.subroute ? normalizeSubroute(ctx.subroute) : null;
         if (initialSubroute && initialSubroute !== "/") {
@@ -670,7 +765,7 @@ var VibeAppBridge = class extends BridgeDataMethods {
         resolve(ctx);
       };
       const sendConnect = () => {
-        this.sendCommand("CONNECT", { bridgeVersion: version });
+        this.sendCommand("CONNECT", { bridgeVersion: BRIDGE_VERSION });
       };
       sendConnect();
       this.connectPollInterval = setInterval(sendConnect, CONNECT_POLL_MS);
@@ -683,6 +778,7 @@ var VibeAppBridge = class extends BridgeDataMethods {
    * Use this for hash-based routers or non-standard navigation patterns.
    */
   reportSubroute(subroute, options) {
+    assertBrowser("reportSubroute()");
     const normalized = normalizeSubroute(subroute);
     if (normalized === null) return;
     this.lastReportedSubroute = normalized;
@@ -693,6 +789,8 @@ var VibeAppBridge = class extends BridgeDataMethods {
    * If no callback is registered, the SDK uses `history.pushState` + a
    * `popstate` event, which works for most SPA routers automatically.
    * Returns an unsubscribe function.
+   *
+   * Pure — only stores the callback, so it is safe to call before {@link connect}.
    */
   onSubrouteRequest(callback) {
     this.subrouteCallback = callback;
@@ -707,6 +805,8 @@ var VibeAppBridge = class extends BridgeDataMethods {
    * returns. Returns an unsubscribe function. Single subscriber: a second call
    * replaces the first. Wire it **before {@link connect}** (the bridge warns at
    * connect if it isn't).
+   *
+   * Pure — only stores the callback, so it is safe to call before {@link connect}.
    */
   onContextChange(callback) {
     this.contextChangeCallback = callback;
@@ -723,7 +823,7 @@ var VibeAppBridge = class extends BridgeDataMethods {
    *
    * **Wire this before {@link connect}** — without it the embedded app won't
    * sign out when the user logs out of Nominal (the bridge warns at connect if
-   * it isn't wired).
+   * it isn't wired). Pure — only stores the callback.
    */
   onAuthChange(callback) {
     this.authChangeCallback = callback;
@@ -769,6 +869,7 @@ var VibeAppBridge = class extends BridgeDataMethods {
    * ```
    */
   navigate(path, action = "push") {
+    assertBrowser("navigate()");
     this.sendCommand("NAVIGATE", { path, action });
   }
   /**
@@ -782,10 +883,12 @@ var VibeAppBridge = class extends BridgeDataMethods {
    * ```
    */
   navigateTo(route, routeParams, action = "push") {
+    assertBrowser("navigateTo()");
     this.sendCommand("NAVIGATE", { route, routeParams, action });
   }
   /** Refreshes the host's current route (re-fetches its server data). Fire-and-forget. */
   refresh() {
+    assertBrowser("refresh()");
     this.sendCommand("NAVIGATE", { action: "refresh" });
   }
   /**
@@ -807,8 +910,9 @@ var VibeAppBridge = class extends BridgeDataMethods {
    *
    * **No-op until {@link connect} has resolved with PostHog enabled by the
    * host** — if the host didn't send a `posthog` block (older host, or recording
-   * disabled for this env/app), nothing is sent. App authors don't import
-   * `posthog-js` themselves; this is the supported event surface.
+   * disabled for this env/app), or `posthog-js` isn't installed (it is an
+   * optional dependency), nothing is sent. App authors don't import `posthog-js`
+   * themselves; this is the supported event surface.
    *
    * The event is sent **directly** from the iframe's own PostHog instance (only
    * the session *recording* is forwarded to the parent), so it carries the
@@ -825,20 +929,33 @@ var VibeAppBridge = class extends BridgeDataMethods {
    * ```
    */
   track(event, properties) {
-    if (!this.posthogInitialized) return;
-    posthog.capture(event, properties);
+    assertBrowser("track()");
+    if (!this.posthogInitialized || !this.posthogInstance) return;
+    this.posthogInstance.capture(event, properties);
   }
+  /**
+   * Tears down the bridge: stops the connect handshake, removes the message
+   * listener, restores patched history methods, and rejects any in-flight calls
+   * with a `'DESTROYED'` error. **Idempotent and safe on the server** — calling
+   * it when {@link connect}/{@link attach} never ran (or where there is no
+   * `window`) is a no-op, so it is safe as a React effect cleanup.
+   */
   destroy() {
     this.teardownNavigationTracking();
     this.rejectConnect?.(new BridgeError("DESTROYED", "Bridge destroyed"));
     this.stopConnectPolling();
-    window.removeEventListener("message", this.boundHandleMessage);
+    if (this.attached && typeof window !== "undefined") {
+      window.removeEventListener("message", this.boundHandleMessage);
+    }
+    this.attached = false;
     for (const pending of this.pendingRequests.values()) {
       pending.reject(new BridgeError("DESTROYED", "Bridge destroyed"));
     }
     this.pendingRequests.clear();
     this.context = null;
     this.posthogInitialized = false;
+    this.posthogInstance = null;
+    this.posthogIniting = false;
     this.connectPromise = null;
     this.onContextReceived = null;
     this.rejectConnect = null;
@@ -857,23 +974,34 @@ var VibeAppBridge = class extends BridgeDataMethods {
       this.connectTimeout = null;
     }
   }
+  warnPosthogUnavailable() {
+    if (this.posthogUnavailableWarned) return;
+    this.posthogUnavailableWarned = true;
+    console.warn(
+      "[vibe-bridge] The host enabled session recording but `posthog-js` is not installed (it is an optional dependency). Recording and track() are disabled. Run `npm i posthog-js` to enable them."
+    );
+  }
   /**
    * Initializes PostHog session recording + analytics from the host-supplied
    * config carried by a one-time `POSTHOG_PUSH`, **only when the host opted in**
    * (`config.enabled`).
    *
+   * `posthog-js` is an **optional dependency**, loaded lazily via `await
+   * import('posthog-js')` the first time recording is enabled — so it stays out
+   * of the import graph (and out of any server bundle) for apps that never
+   * record. If it isn't installed, this warns once and no-ops (never throws).
+   *
    * The host is the single source of truth: when it sends no `POSTHOG_PUSH`
    * (recording disabled for this env/app) or `enabled: false`, this does
-   * nothing — `enabled` is the kill-switch even though `posthog-js` is bundled
-   * into the bridge. Cross-origin replay needs `recordCrossOriginIframes` on both
-   * sides so the parent receives the iframe's rrweb frames into one stitched
-   * recording, and `identify()` ties the iframe's recording + events to the same
-   * person as the host. Idempotent (the `posthogInitialized` guard) and wrapped
-   * in try/catch so a duplicate push or a PostHog failure is harmless.
+   * nothing. Cross-origin replay needs `recordCrossOriginIframes` on both sides
+   * so the parent receives the iframe's rrweb frames into one stitched recording,
+   * and `identify()` ties the iframe's recording + events to the same person as
+   * the host. Idempotent (the `posthogInitialized` guard) and wrapped in
+   * try/catch so a duplicate push or a PostHog failure is harmless.
    */
-  initPostHog(config) {
+  async initPostHog(config) {
     if (!config.enabled) return;
-    if (this.posthogInitialized) return;
+    if (this.posthogInitialized || this.posthogIniting) return;
     if (typeof window === "undefined") return;
     if (!config.token || !config.apiHost || !config.distinctId) {
       console.warn(
@@ -881,7 +1009,20 @@ var VibeAppBridge = class extends BridgeDataMethods {
       );
       return;
     }
+    this.posthogIniting = true;
     try {
+      let posthog;
+      try {
+        posthog = resolvePosthog(await import("posthog-js"));
+      } catch {
+        this.warnPosthogUnavailable();
+        return;
+      }
+      if (!posthog) {
+        this.warnPosthogUnavailable();
+        return;
+      }
+      if (!this.attached) return;
       posthog.init(config.token, {
         api_host: config.apiHost,
         // absolute ingestion host, NOT a relative /ingest proxy
@@ -904,16 +1045,19 @@ var VibeAppBridge = class extends BridgeDataMethods {
         }
       });
       posthog.identify(config.distinctId);
+      this.posthogInstance = posthog;
       this.posthogInitialized = true;
       console.log("[vibe-bridge] PostHog session recording initialized");
     } catch (err) {
       console.warn("[vibe-bridge] PostHog init failed \u2014 continuing without recording.", err);
+    } finally {
+      this.posthogIniting = false;
     }
   }
   /**
    * Monkey-patches `history.pushState` and `history.replaceState` to
    * auto-detect SPA navigation and report it to the host. Called after
-   * connect() resolves.
+   * connect() resolves (so `window`/`history` are guaranteed present).
    */
   setupNavigationTracking() {
     if (this.origPushState) return;
@@ -964,6 +1108,7 @@ var VibeAppBridge = class extends BridgeDataMethods {
     this.sendCommand("REPORT_SUBROUTE", { subroute, replace });
   }
   sendCommand(type, payload) {
+    this.ensureAttached();
     this.postToParent({
       __protocol: PROTOCOL_ID,
       __version: PROTOCOL_VERSION,
@@ -979,12 +1124,18 @@ var VibeAppBridge = class extends BridgeDataMethods {
    * `onProgress` callback. `type` autocompletes to every operation name and
    * narrows `payload`/return to that operation's types.
    *
+   * @throws Rejects with `BridgeError` code `'SERVER_ENVIRONMENT'` if called
+   *   where there is no `window`.
    * @example
    * ```ts
    * const accounts = await bridge.request('GET_ACCOUNTS', { query: { account_ids: ['acc-1'] } })
    * ```
    */
   request(type, payload, onProgress) {
+    if (typeof window === "undefined") {
+      return Promise.reject(serverEnvError(`request(${String(type)})`));
+    }
+    this.ensureAttached();
     return new Promise((resolve, reject) => {
       const requestId = crypto.randomUUID();
       const timer = setTimeout(
@@ -1056,3 +1207,4 @@ var VibeAppBridge = class extends BridgeDataMethods {
   HttpBridgeError,
   VibeAppBridge
 });
+//# sourceMappingURL=index.cjs.map