@buoy-gg/route-events 7.0.40 → 7.0.42

package/lib/commonjs/sync/routeEventsSyncAdapter.js

@@ -1,275 +1 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.routeEventsSyncAdapter = exports.SNAPSHOT_PARAM_INLINE_LIMIT = void 0;
-var _sharedUi = require("@buoy-gg/shared-ui");
-var _routeEventStore = require("../stores/routeEventStore");
-var _navigationStackStore = require("../stores/navigationStackStore");
-var _RouteParser = require("../RouteParser");
-var _expoRouterStore = require("../expoRouterStore");
-/**
- * Navigation params larger than this are NOT streamed in the snapshot.
- * Apps routinely pass whole user objects (or a stringified payload) through
- * `navigate(..., { user })`; 500 of those on every route change exceed the
- * 2MB emit budget and drop the Routes panel. Pathname/segments stay inline.
- */
-const SNAPSHOT_PARAM_INLINE_LIMIT = exports.SNAPSHOT_PARAM_INLINE_LIMIT = 16 * 1024;
-const PARAMS_ON_DEVICE = Object.freeze({
-  __buoyOmitted: "route-params",
-  note: "Navigation params stay on the device."
-});
-function shouldOmitParams(params) {
-  if (params == null) return false;
-  return (0, _sharedUi.isOverWireBudget)(params, SNAPSHOT_PARAM_INLINE_LIMIT);
-}
-function toWireParams(params) {
-  if (!shouldOmitParams(params)) return params;
-  return PARAMS_ON_DEVICE;
-}
-function toWireEvent(event) {
-  if (!shouldOmitParams(event.params)) return event;
-  return {
-    ...event,
-    params: toWireParams(event.params)
-  };
-}
-function toWireStackItem(item) {
-  if (!shouldOmitParams(item.params)) return item;
-  return {
-    ...item,
-    params: toWireParams(item.params)
-  };
-}
-
-/**
- * Serializable snapshot of the device's route tree, sent to the dashboard so
- * the Routes tab can render a sitemap (the raw expo-router RouteNode itself is
- * not JSON-serializable — it holds components/functions — so we send the parsed
- * RouteInfo[] instead).
- */
-
-/**
- * Payload shape for the route-events tool (adapter version 3). Consumers must
- * tolerate older shapes: v1 sends a bare RouteChangeEvent[]; v2 omits `stack`.
- */
-
-function getSitemapSnapshot() {
-  const metadata = (0, _expoRouterStore.getRouteNodeMetadata)();
-  return {
-    routes: _RouteParser.RouteParser.parseRouteTree((0, _expoRouterStore.loadRouteNode)()),
-    source: metadata.source,
-    lastUpdatedAt: metadata.lastLoadedAt
-  };
-}
-
-/**
- * Sync adapter for the route-events tool, consumed by @buoy-gg/external-sync's
- * `useExternalSync` (structurally matches its ToolSyncAdapter interface so
- * this package doesn't need a dependency on it).
- *
- * Subscribing attaches the routeObserver listener, so route changes are only
- * recorded while a dashboard is watching. (Route events still require a
- * <RouteTracker /> inside the navigation tree to be emitted at all.)
- *
- * The snapshot carries both the route-change events AND the parsed route
- * sitemap, so the dashboard — which has no local expo-router store — can render
- * the route tree. The `navigate` action lets the dashboard drive navigation on
- * the device.
- */
-const routeEventsSyncAdapter = exports.routeEventsSyncAdapter = {
-  version: 3,
-  getSnapshot: () => ({
-    events: _routeEventStore.routeEventStore.getEvents().map(toWireEvent),
-    sitemap: getSitemapSnapshot(),
-    stack: _navigationStackStore.navigationStackStore.getStack().map(toWireStackItem)
-  }),
-  subscribe: onChange => {
-    const unsubscribeEvents = _routeEventStore.routeEventStore.subscribeToEvents(onChange);
-    const unsubscribeStack = _navigationStackStore.navigationStackStore.subscribe(onChange);
-
-    // The expo-router route tree can still be populating when a dashboard
-    // starts watching. Poll briefly until it's available and push a snapshot
-    // the moment it loads, so the Routes tab fills in without needing the user
-    // to navigate first. Stops as soon as the tree is found.
-    let pollTimer = null;
-    if (!(0, _expoRouterStore.loadRouteNode)()) {
-      let retries = 0;
-      const maxRetries = 100; // ~10s
-      const poll = () => {
-        retries += 1;
-        if ((0, _expoRouterStore.loadRouteNode)()) {
-          pollTimer = null;
-          onChange();
-          return;
-        }
-        pollTimer = retries < maxRetries ? setTimeout(poll, 100) : null;
-      };
-      pollTimer = setTimeout(poll, 100);
-    }
-    return () => {
-      unsubscribeEvents();
-      unsubscribeStack();
-      if (pollTimer) clearTimeout(pollTimer);
-    };
-  },
-  actions: {
-    clearEvents: () => {
-      _routeEventStore.routeEventStore.clearEvents();
-    },
-    /**
-     * Just where the app is right now — no sitemap, no history.
-     *
-     * The full snapshot carries the parsed route tree, which is the wrong
-     * thing to hand a caller that polls (the macro recorder reads this several
-     * times a second to notice a screen change). Reading the last route event
-     * is also what makes this honest about apps with no <RouteTracker />: they
-     * get `{ path: null }` rather than a plausible-looking guess.
-     */
-    getCurrentRoute: () => {
-      // BaseEventStore is newest-FIRST, and the store only captures while
-      // something is subscribed.
-      const latest = _routeEventStore.routeEventStore.getEvents()[0];
-
-      /**
-       * A RECORDED event only wins while the recorder is running.
-       *
-       * The store starts capturing when its first subscriber arrives and stops
-       * with the last one, so an app with Ask Buoy on the phone and no
-       * dashboard attached has NO route events at all — the stack fallback
-       * below is its normal path, not the fresh-launch edge case this code was
-       * written for. Worse, events left over from a closed capture window are
-       * stale the moment the user navigates again: a live QA session read
-       * `/(tabs)/menu` from an event six scenarios after the app had moved to
-       * `/cart`. The live stack cannot be stale, so it wins whenever nothing
-       * is recording.
-       */
-      if (latest && _routeEventStore.routeEventStore.isCapturing()) {
-        return {
-          path: latest.pathname,
-          params: toWireParams(latest.params),
-          at: latest.timestamp,
-          source: "event"
-        };
-      }
-
-      // The live stack knows even when the history is empty, which is the
-      // difference between a macro that can run from anywhere and one that
-      // only works if you happen to be on the screen it was recorded from.
-      const stack = _navigationStackStore.navigationStackStore.getStack();
-      const focused = stack.find(item => item.isFocused) ?? stack[stack.length - 1];
-      if (focused?.pathname) {
-        return {
-          path: focused.pathname,
-          params: toWireParams(focused.params ?? {}),
-          at: null,
-          source: "stack"
-        };
-      }
-
-      // No live stack (no <RouteTracker/>) and the recorder is off: an old
-      // event is all there is. Say that it may be stale rather than passing it
-      // off as where the app is.
-      if (latest) {
-        return {
-          path: latest.pathname,
-          params: toWireParams(latest.params),
-          at: latest.timestamp,
-          source: "event",
-          stale: true
-        };
-      }
-      return {
-        path: null,
-        params: {},
-        at: null,
-        source: null
-      };
-    },
-    /**
-     * Navigate the device to a concrete path. The dashboard resolves any
-     * dynamic params into a concrete path before invoking this.
-     */
-    navigate: params => {
-      const p = params;
-      const path = p?.path;
-      if (!path) {
-        throw new Error("navigate requires a 'path' param");
-      }
-      const router = (0, _sharedUi.getSafeRouter)();
-      if (!router) {
-        // Bare React Navigation: no paths, but the tracker captured the
-        // container ref, so navigate by SCREEN NAME — "/Settings" and
-        // "Settings" both resolve, and nested navigators are walked via the
-        // root state. This is half the market; "throw off expo-router" made
-        // navigate a dead verb for every RN CLI app.
-        const actions = _navigationStackStore.navigationStackStore.getActions();
-        const name = path.replace(/^\//, "");
-        if (!actions?.navigateToRoute || !name) {
-          throw new Error("expo-router is not available here and no navigation container was captured — is <RouteTracker /> mounted inside your NavigationContainer?");
-        }
-        const ok = actions.navigateToRoute(name, p?.params);
-        if (!ok) {
-          throw new Error(`Could not navigate to "${name}" — no navigation container is live.`);
-        }
-        return {
-          navigated: path,
-          replaced: false,
-          via: "react-navigation"
-        };
-      }
-      // Push by default so navigate-then-back flows keep working. Callers that
-      // mean "leave this screen" (sitemap Go, agents resetting to home) pass
-      // replace: true — otherwise "Go to home" stacks another `/` on top.
-      const go = p?.replace === true && typeof router.replace === "function" ? router.replace : router.navigate;
-      go(path);
-      return {
-        navigated: path,
-        replaced: p?.replace === true
-      };
-    },
-    // ── Stack actions: delegate to the live navigation actions captured by
-    //    <RouteTracker /> (they hold the React Navigation container ref). ──
-    stackNavigateToIndex: params => {
-      const index = params?.index;
-      if (typeof index !== "number") {
-        throw new Error("stackNavigateToIndex requires a numeric 'index'");
-      }
-      const actions = _navigationStackStore.navigationStackStore.getActions();
-      if (!actions) throw new Error("navigation stack is not available");
-      actions.navigateToIndex(index);
-      return {
-        navigatedToIndex: index
-      };
-    },
-    stackPopToIndex: params => {
-      const index = params?.index;
-      if (typeof index !== "number") {
-        throw new Error("stackPopToIndex requires a numeric 'index'");
-      }
-      const actions = _navigationStackStore.navigationStackStore.getActions();
-      if (!actions) throw new Error("navigation stack is not available");
-      actions.popToIndex(index);
-      return {
-        poppedToIndex: index
-      };
-    },
-    stackGoBack: () => {
-      const actions = _navigationStackStore.navigationStackStore.getActions();
-      if (!actions) throw new Error("navigation stack is not available");
-      actions.goBack();
-      return {
-        wentBack: true
-      };
-    },
-    stackPopToTop: () => {
-      const actions = _navigationStackStore.navigationStackStore.getActions();
-      if (!actions) throw new Error("navigation stack is not available");
-      actions.popToTop();
-      return {
-        poppedToTop: true
-      };
-    }
-  }
-};
+"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.routeEventsSyncAdapter=exports.SNAPSHOT_PARAM_INLINE_LIMIT=void 0;var _sharedUi=require("@buoy-gg/shared-ui");var _routeEventStore=require("../stores/routeEventStore");var _navigationStackStore=require("../stores/navigationStackStore");var _RouteParser=require("../RouteParser");var _expoRouterStore=require("../expoRouterStore");const SNAPSHOT_PARAM_INLINE_LIMIT=exports.SNAPSHOT_PARAM_INLINE_LIMIT=16*1024;const PARAMS_ON_DEVICE=Object.freeze({__buoyOmitted:"route-params",note:"Navigation params stay on the device."});function shouldOmitParams(t){if(t==null)return false;return(0,_sharedUi.isOverWireBudget)(t,SNAPSHOT_PARAM_INLINE_LIMIT)}function toWireParams(t){if(!shouldOmitParams(t))return t;return PARAMS_ON_DEVICE}function toWireEvent(t){if(!shouldOmitParams(t.params))return t;return{...t,params:toWireParams(t.params)}}function toWireStackItem(t){if(!shouldOmitParams(t.params))return t;return{...t,params:toWireParams(t.params)}}function getSitemapSnapshot(){const t=(0,_expoRouterStore.getRouteNodeMetadata)();return{routes:_RouteParser.RouteParser.parseRouteTree((0,_expoRouterStore.loadRouteNode)()),source:t.source,lastUpdatedAt:t.lastLoadedAt}}const routeEventsSyncAdapter=exports.routeEventsSyncAdapter={version:3,getSnapshot:()=>({events:_routeEventStore.routeEventStore.getEvents().map(toWireEvent),sitemap:getSitemapSnapshot(),stack:_navigationStackStore.navigationStackStore.getStack().map(toWireStackItem)}),subscribe:t=>{const e=_routeEventStore.routeEventStore.subscribeToEvents(t);const a=_navigationStackStore.navigationStackStore.subscribe(t);let r=null;if(!(0,_expoRouterStore.loadRouteNode)()){let n=0;const i=100;const o=()=>{n+=1;if((0,_expoRouterStore.loadRouteNode)()){r=null;t();return}r=n<i?setTimeout(o,100):null};r=setTimeout(o,100)}return()=>{e();a();if(r)clearTimeout(r)}},actions:{clearEvents:()=>{_routeEventStore.routeEventStore.clearEvents()},getCurrentRoute:()=>{const t=_routeEventStore.routeEventStore.getEvents()[0];if(t&&_routeEventStore.routeEventStore.isCapturing()){return{path:t.pathname,params:toWireParams(t.params),at:t.timestamp,source:"event"}}const e=_navigationStackStore.navigationStackStore.getStack();const a=e.find(r=>r.isFocused)??e[e.length-1];if(a?.pathname){return{path:a.pathname,params:toWireParams(a.params??{}),at:null,source:"stack"}}if(t){return{path:t.pathname,params:toWireParams(t.params),at:t.timestamp,source:"event",stale:true}}return{path:null,params:{},at:null,source:null}},navigate:t=>{const e=t;const a=e?.path;if(!a){throw new Error("navigate requires a 'path' param")}const r=(0,_sharedUi.getSafeRouter)();if(!r){const i=_navigationStackStore.navigationStackStore.getActions();const o=a.replace(/^\//,"");if(!i?.navigateToRoute||!o){throw new Error("expo-router is not available here and no navigation container was captured \u2014 is <RouteTracker /> mounted inside your NavigationContainer?")}const s=i.navigateToRoute(o,e?.params);if(!s){throw new Error(`Could not navigate to "${o}" \u2014 no navigation container is live.`)}return{navigated:a,replaced:false,via:"react-navigation"}}const n=e?.replace===true&&typeof r.replace==="function"?r.replace:r.navigate;n(a);return{navigated:a,replaced:e?.replace===true}},stackNavigateToIndex:t=>{const e=t?.index;if(typeof e!=="number"){throw new Error("stackNavigateToIndex requires a numeric 'index'")}const a=_navigationStackStore.navigationStackStore.getActions();if(!a)throw new Error("navigation stack is not available");a.navigateToIndex(e);return{navigatedToIndex:e}},stackPopToIndex:t=>{const e=t?.index;if(typeof e!=="number"){throw new Error("stackPopToIndex requires a numeric 'index'")}const a=_navigationStackStore.navigationStackStore.getActions();if(!a)throw new Error("navigation stack is not available");a.popToIndex(e);return{poppedToIndex:e}},stackGoBack:()=>{const t=_navigationStackStore.navigationStackStore.getActions();if(!t)throw new Error("navigation stack is not available");t.goBack();return{wentBack:true}},stackPopToTop:()=>{const t=_navigationStackStore.navigationStackStore.getActions();if(!t)throw new Error("navigation stack is not available");t.popToTop();return{poppedToTop:true}}}};