@syntrologie/runtime-sdk 2.11.0 → 2.12.0

package/dist/overlays/runtime/overlay/overlay-runner.d.ts

@@ -0,0 +1,4 @@
+import type { CanvasRecipe, OverlayContext } from '../../types';
+export declare function runOverlays(recipe: CanvasRecipe, ctx: OverlayContext): Promise<() => void>;
+/** Start a tour by ID - clears completion state and begins */
+export declare function startTour(tourId: string): void;

package/dist/overlays/runtime/overlay/overlay-state.d.ts

@@ -0,0 +1,21 @@
+import type { HighlightStep, ModalStep, TooltipStep } from '../../types';
+export type Step = TooltipStep | HighlightStep | ModalStep;
+export declare const ACTIVE_TOUR_KEY = "syntro_active_tour";
+export interface ActiveTourState {
+    tourId: string;
+    stepId: string;
+    timestamp: number;
+}
+export declare const TOUR_STATE_EXPIRY_MS: number;
+/** Get active tour state from localStorage (returns null if expired) */
+export declare function getActiveTourState(): ActiveTourState | null;
+/** Save active tour state to localStorage with timestamp */
+export declare function setActiveTourState(state: Omit<ActiveTourState, 'timestamp'> | null): void;
+/** Check if a step's route matches the current page */
+export declare function stepRouteMatches(step: Step, path: string): boolean;
+/**
+ * Watch for route changes in SPAs.
+ * Uses NavigationMonitor subscription if available (single patch point),
+ * otherwise falls back to direct History API patching (legacy).
+ */
+export declare function watchRouteChanges(callback: (newPath: string) => void, subscribeNavigation?: (cb: (url: string, method: string) => void) => () => void): () => void;

package/dist/overlays/types.d.ts

@@ -113,8 +113,10 @@ export type CanvasRecipe = {
 export type OverlayContext = {
     overlayRoot: HTMLElement;
     resolve: (sel: Selector) => Promise<HTMLElement | null>;
-    onEvent: (name: string, payload?: any) => void;
+    onEvent: (name: string, payload?: Record<string, unknown>) => void;
     canvasHost?: HTMLElement | null;
+    /** Recipe ID for telemetry attribution */
+    recipeId?: string;
     /** Telemetry client for persisting tour state to PostHog */
     telemetry?: {
         setPersonPropertiesOnce?: (props: Record<string, unknown>) => void;

package/dist/react.js

@@ -1,10 +1,9 @@
 import {
   Syntro
-} from "./chunk-H3FAYTUV.js";
-import "./chunk-NBFQGKSV.js";
-import "./chunk-37TTQRH5.js";
-import "./chunk-Q77NT67W.js";
-import "./chunk-JMHRHAEL.js";
+} from "./chunk-J2LGX2PV.js";
+import "./chunk-L6RJMBR2.js";
+import "./chunk-XDYJ64IN.js";
+import "./chunk-BU4Z6PD7.js";
 
 // src/react.tsx
 import { createContext, useContext, useEffect, useRef, useState } from "react";
@@ -34,6 +33,7 @@ function SyntroProvider({
     if (globalInitPromise && globalInitToken === token) {
       globalInitPromise.then((result) => {
         var _a, _b;
+        if (!result) return;
         handleRef.current = result.canvas;
         setState({
           canvas: result.canvas,
@@ -51,6 +51,7 @@ function SyntroProvider({
     globalInitPromise = Syntro.init({ token, canvas: canvasOptions, fetcher });
     globalInitPromise.then((result) => {
       var _a, _b;
+      if (!result) return;
       handleRef.current = result.canvas;
       setState({
         canvas: result.canvas,

package/dist/react.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/react.tsx"],
-  "sourcesContent": ["/**\n * React bindings for the Syntro SDK.\n *\n * Usage:\n * ```tsx\n * import { SyntroProvider, useSyntro } from '@syntrologie/runtime-sdk/react';\n *\n * function App() {\n *   return (\n *     <SyntroProvider token=\"syn_xxx\">\n *       <MyApp />\n *     </SyntroProvider>\n *   );\n * }\n *\n * function MyComponent() {\n *   const { canvas, experiments, telemetry, isReady } = useSyntro();\n *   // ...\n * }\n * ```\n */\nimport { createContext, type ReactNode, useContext, useEffect, useRef, useState } from 'react';\n\nimport type { SmartCanvasHandle } from './api';\nimport { Syntro, type SyntroInitOptions, type SyntroInitResult } from './bootstrap';\nimport type { ExperimentClient } from './experiments/types';\nimport type { TelemetryClient } from './telemetry/types';\n\nexport interface SyntroContextValue {\n  /** The SmartCanvas handle */\n  canvas: SmartCanvasHandle | null;\n  /** The experiment client */\n  experiments: ExperimentClient | null;\n  /** The telemetry client */\n  telemetry: TelemetryClient | null;\n  /** Whether the SDK has finished initializing */\n  isReady: boolean;\n  /** Any error that occurred during initialization */\n  error: Error | null;\n}\n\nconst SyntroContext = createContext<SyntroContextValue | null>(null);\n\n// Global tracking to handle React Strict Mode double-mounting\nlet globalInitPromise: Promise<SyntroInitResult> | null = null;\nlet globalInitToken: string | null = null;\n\nexport interface SyntroProviderProps {\n  /**\n   * The Syntro token containing all credentials.\n   */\n  token: string;\n\n  /**\n   * Optional canvas configuration overrides.\n   */\n  canvasOptions?: SyntroInitOptions['canvas'];\n\n  /**\n   * Custom config fetcher to override the default experiment-based fetcher.\n   * Use this for local development or when bypassing the experiment server.\n   */\n  fetcher?: SyntroInitOptions['fetcher'];\n\n  /**\n   * Children to render.\n   */\n  children: ReactNode;\n\n  /**\n   * Called when initialization completes.\n   */\n  onReady?: (result: SyntroInitResult) => void;\n\n  /**\n   * Called when initialization fails.\n   */\n  onError?: (error: Error) => void;\n}\n\n/**\n * Provider component that initializes the Syntro SDK.\n *\n * Place this at the root of your app or at the top of any subtree\n * that needs access to the SDK.\n */\nexport function SyntroProvider({\n  token,\n  canvasOptions,\n  fetcher,\n  children,\n  onReady,\n  onError,\n}: SyntroProviderProps) {\n  const [state, setState] = useState<SyntroContextValue>({\n    canvas: null,\n    experiments: null,\n    telemetry: null,\n    isReady: false,\n    error: null,\n  });\n\n  const initRef = useRef(false);\n  const handleRef = useRef<SmartCanvasHandle | null>(null);\n\n  useEffect(() => {\n    if (!token) return;\n\n    // Reuse existing init if same token (handles React Strict Mode remounts)\n    if (globalInitPromise && globalInitToken === token) {\n      globalInitPromise.then((result) => {\n        handleRef.current = result.canvas;\n        setState({\n          canvas: result.canvas,\n          experiments: result.experiments ?? null,\n          telemetry: result.telemetry ?? null,\n          isReady: true,\n          error: null,\n        });\n      });\n      return;\n    }\n\n    // Prevent double init\n    if (initRef.current) return;\n    initRef.current = true;\n\n    globalInitToken = token;\n    globalInitPromise = Syntro.init({ token, canvas: canvasOptions, fetcher });\n\n    globalInitPromise\n      .then((result) => {\n        handleRef.current = result.canvas;\n        setState({\n          canvas: result.canvas,\n          experiments: result.experiments ?? null,\n          telemetry: result.telemetry ?? null,\n          isReady: true,\n          error: null,\n        });\n        onReady?.(result);\n      })\n      .catch((err) => {\n        const error = err instanceof Error ? err : new Error(String(err));\n        setState((prev) => ({ ...prev, error, isReady: true }));\n        onError?.(error);\n        // Clear global state on error so retry is possible\n        globalInitPromise = null;\n        globalInitToken = null;\n      });\n\n    // Don't destroy on unmount in dev mode - React Strict Mode will remount\n    // The canvas persists and will be reused on remount\n  }, [token, canvasOptions, fetcher, onError, onReady]);\n\n  return <SyntroContext.Provider value={state}>{children}</SyntroContext.Provider>;\n}\n\n/**\n * Hook to access the Syntro SDK.\n *\n * Must be used within a SyntroProvider.\n *\n * @returns The SDK context containing canvas, experiments, telemetry, and status\n */\nexport function useSyntro(): SyntroContextValue {\n  const context = useContext(SyntroContext);\n  if (!context) {\n    throw new Error('useSyntro must be used within a SyntroProvider');\n  }\n  return context;\n}\n\n/**\n * Hook to check if the SDK is ready.\n *\n * Shorthand for `useSyntro().isReady`.\n */\nexport function useSyntroReady(): boolean {\n  return useSyntro().isReady;\n}\n\n/**\n * Hook to access the experiment client.\n *\n * @returns The experiment client, or null if not configured\n */\nexport function useSyntroExperiments(): ExperimentClient | null {\n  return useSyntro().experiments;\n}\n\n/**\n * Hook to access the telemetry client.\n *\n * @returns The telemetry client, or null if not configured\n */\nexport function useSyntroTelemetry(): TelemetryClient | null {\n  return useSyntro().telemetry;\n}\n\n/**\n * Hook to access the canvas handle.\n *\n * @returns The canvas handle, or null if not ready\n */\nexport function useSyntroCanvas(): SmartCanvasHandle | null {\n  return useSyntro().canvas;\n}\n"],
-  "mappings": ";;;;;;;;;AAqBA,SAAS,eAA+B,YAAY,WAAW,QAAQ,gBAAgB;AAsI9E;AAlHT,IAAM,gBAAgB,cAAyC,IAAI;AAGnE,IAAI,oBAAsD;AAC1D,IAAI,kBAAiC;AAyC9B,SAAS,eAAe;AAAA,EAC7B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,GAAwB;AACtB,QAAM,CAAC,OAAO,QAAQ,IAAI,SAA6B;AAAA,IACrD,QAAQ;AAAA,IACR,aAAa;AAAA,IACb,WAAW;AAAA,IACX,SAAS;AAAA,IACT,OAAO;AAAA,EACT,CAAC;AAED,QAAM,UAAU,OAAO,KAAK;AAC5B,QAAM,YAAY,OAAiC,IAAI;AAEvD,YAAU,MAAM;AACd,QAAI,CAAC,MAAO;AAGZ,QAAI,qBAAqB,oBAAoB,OAAO;AAClD,wBAAkB,KAAK,CAAC,WAAW;AA9GzC;AA+GQ,kBAAU,UAAU,OAAO;AAC3B,iBAAS;AAAA,UACP,QAAQ,OAAO;AAAA,UACf,cAAa,YAAO,gBAAP,YAAsB;AAAA,UACnC,YAAW,YAAO,cAAP,YAAoB;AAAA,UAC/B,SAAS;AAAA,UACT,OAAO;AAAA,QACT,CAAC;AAAA,MACH,CAAC;AACD;AAAA,IACF;AAGA,QAAI,QAAQ,QAAS;AACrB,YAAQ,UAAU;AAElB,sBAAkB;AAClB,wBAAoB,OAAO,KAAK,EAAE,OAAO,QAAQ,eAAe,QAAQ,CAAC;AAEzE,sBACG,KAAK,CAAC,WAAW;AAnIxB;AAoIQ,gBAAU,UAAU,OAAO;AAC3B,eAAS;AAAA,QACP,QAAQ,OAAO;AAAA,QACf,cAAa,YAAO,gBAAP,YAAsB;AAAA,QACnC,YAAW,YAAO,cAAP,YAAoB;AAAA,QAC/B,SAAS;AAAA,QACT,OAAO;AAAA,MACT,CAAC;AACD,yCAAU;AAAA,IACZ,CAAC,EACA,MAAM,CAAC,QAAQ;AACd,YAAM,QAAQ,eAAe,QAAQ,MAAM,IAAI,MAAM,OAAO,GAAG,CAAC;AAChE,eAAS,CAAC,UAAU,EAAE,GAAG,MAAM,OAAO,SAAS,KAAK,EAAE;AACtD,yCAAU;AAEV,0BAAoB;AACpB,wBAAkB;AAAA,IACpB,CAAC;AAAA,EAIL,GAAG,CAAC,OAAO,eAAe,SAAS,SAAS,OAAO,CAAC;AAEpD,SAAO,oBAAC,cAAc,UAAd,EAAuB,OAAO,OAAQ,UAAS;AACzD;AASO,SAAS,YAAgC;AAC9C,QAAM,UAAU,WAAW,aAAa;AACxC,MAAI,CAAC,SAAS;AACZ,UAAM,IAAI,MAAM,gDAAgD;AAAA,EAClE;AACA,SAAO;AACT;AAOO,SAAS,iBAA0B;AACxC,SAAO,UAAU,EAAE;AACrB;AAOO,SAAS,uBAAgD;AAC9D,SAAO,UAAU,EAAE;AACrB;AAOO,SAAS,qBAA6C;AAC3D,SAAO,UAAU,EAAE;AACrB;AAOO,SAAS,kBAA4C;AAC1D,SAAO,UAAU,EAAE;AACrB;",
+  "sourcesContent": ["/**\n * React bindings for the Syntro SDK.\n *\n * Usage:\n * ```tsx\n * import { SyntroProvider, useSyntro } from '@syntrologie/runtime-sdk/react';\n *\n * function App() {\n *   return (\n *     <SyntroProvider token=\"syn_xxx\">\n *       <MyApp />\n *     </SyntroProvider>\n *   );\n * }\n *\n * function MyComponent() {\n *   const { canvas, experiments, telemetry, isReady } = useSyntro();\n *   // ...\n * }\n * ```\n */\nimport { createContext, type ReactNode, useContext, useEffect, useRef, useState } from 'react';\n\nimport type { SmartCanvasHandle } from './api';\nimport { Syntro, type SyntroInitOptions, type SyntroInitResult } from './bootstrap';\nimport type { ExperimentClient } from './experiments/types';\nimport type { TelemetryClient } from './telemetry/types';\n\nexport interface SyntroContextValue {\n  /** The SmartCanvas handle */\n  canvas: SmartCanvasHandle | null;\n  /** The experiment client */\n  experiments: ExperimentClient | null;\n  /** The telemetry client */\n  telemetry: TelemetryClient | null;\n  /** Whether the SDK has finished initializing */\n  isReady: boolean;\n  /** Any error that occurred during initialization */\n  error: Error | null;\n}\n\nconst SyntroContext = createContext<SyntroContextValue | null>(null);\n\n// Global tracking to handle React Strict Mode double-mounting\nlet globalInitPromise: Promise<SyntroInitResult | undefined> | null = null;\nlet globalInitToken: string | null = null;\n\nexport interface SyntroProviderProps {\n  /**\n   * The Syntro token containing all credentials.\n   */\n  token: string;\n\n  /**\n   * Optional canvas configuration overrides.\n   */\n  canvasOptions?: SyntroInitOptions['canvas'];\n\n  /**\n   * Custom config fetcher to override the default experiment-based fetcher.\n   * Use this for local development or when bypassing the experiment server.\n   */\n  fetcher?: SyntroInitOptions['fetcher'];\n\n  /**\n   * Children to render.\n   */\n  children: ReactNode;\n\n  /**\n   * Called when initialization completes.\n   */\n  onReady?: (result: SyntroInitResult) => void;\n\n  /**\n   * Called when initialization fails.\n   */\n  onError?: (error: Error) => void;\n}\n\n/**\n * Provider component that initializes the Syntro SDK.\n *\n * Place this at the root of your app or at the top of any subtree\n * that needs access to the SDK.\n */\nexport function SyntroProvider({\n  token,\n  canvasOptions,\n  fetcher,\n  children,\n  onReady,\n  onError,\n}: SyntroProviderProps) {\n  const [state, setState] = useState<SyntroContextValue>({\n    canvas: null,\n    experiments: null,\n    telemetry: null,\n    isReady: false,\n    error: null,\n  });\n\n  const initRef = useRef(false);\n  const handleRef = useRef<SmartCanvasHandle | null>(null);\n\n  useEffect(() => {\n    if (!token) return;\n\n    // Reuse existing init if same token (handles React Strict Mode remounts)\n    if (globalInitPromise && globalInitToken === token) {\n      globalInitPromise.then((result) => {\n        if (!result) return;\n        handleRef.current = result.canvas;\n        setState({\n          canvas: result.canvas,\n          experiments: result.experiments ?? null,\n          telemetry: result.telemetry ?? null,\n          isReady: true,\n          error: null,\n        });\n      });\n      return;\n    }\n\n    // Prevent double init\n    if (initRef.current) return;\n    initRef.current = true;\n\n    globalInitToken = token;\n    globalInitPromise = Syntro.init({ token, canvas: canvasOptions, fetcher });\n\n    globalInitPromise\n      .then((result) => {\n        if (!result) return;\n        handleRef.current = result.canvas;\n        setState({\n          canvas: result.canvas,\n          experiments: result.experiments ?? null,\n          telemetry: result.telemetry ?? null,\n          isReady: true,\n          error: null,\n        });\n        onReady?.(result);\n      })\n      .catch((err) => {\n        const error = err instanceof Error ? err : new Error(String(err));\n        setState((prev) => ({ ...prev, error, isReady: true }));\n        onError?.(error);\n        // Clear global state on error so retry is possible\n        globalInitPromise = null;\n        globalInitToken = null;\n      });\n\n    // Don't destroy on unmount in dev mode - React Strict Mode will remount\n    // The canvas persists and will be reused on remount\n  }, [token, canvasOptions, fetcher, onError, onReady]);\n\n  return <SyntroContext.Provider value={state}>{children}</SyntroContext.Provider>;\n}\n\n/**\n * Hook to access the Syntro SDK.\n *\n * Must be used within a SyntroProvider.\n *\n * @returns The SDK context containing canvas, experiments, telemetry, and status\n */\nexport function useSyntro(): SyntroContextValue {\n  const context = useContext(SyntroContext);\n  if (!context) {\n    throw new Error('useSyntro must be used within a SyntroProvider');\n  }\n  return context;\n}\n\n/**\n * Hook to check if the SDK is ready.\n *\n * Shorthand for `useSyntro().isReady`.\n */\nexport function useSyntroReady(): boolean {\n  return useSyntro().isReady;\n}\n\n/**\n * Hook to access the experiment client.\n *\n * @returns The experiment client, or null if not configured\n */\nexport function useSyntroExperiments(): ExperimentClient | null {\n  return useSyntro().experiments;\n}\n\n/**\n * Hook to access the telemetry client.\n *\n * @returns The telemetry client, or null if not configured\n */\nexport function useSyntroTelemetry(): TelemetryClient | null {\n  return useSyntro().telemetry;\n}\n\n/**\n * Hook to access the canvas handle.\n *\n * @returns The canvas handle, or null if not ready\n */\nexport function useSyntroCanvas(): SmartCanvasHandle | null {\n  return useSyntro().canvas;\n}\n"],
+  "mappings": ";;;;;;;;AAqBA,SAAS,eAA+B,YAAY,WAAW,QAAQ,gBAAgB;AAwI9E;AApHT,IAAM,gBAAgB,cAAyC,IAAI;AAGnE,IAAI,oBAAkE;AACtE,IAAI,kBAAiC;AAyC9B,SAAS,eAAe;AAAA,EAC7B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,GAAwB;AACtB,QAAM,CAAC,OAAO,QAAQ,IAAI,SAA6B;AAAA,IACrD,QAAQ;AAAA,IACR,aAAa;AAAA,IACb,WAAW;AAAA,IACX,SAAS;AAAA,IACT,OAAO;AAAA,EACT,CAAC;AAED,QAAM,UAAU,OAAO,KAAK;AAC5B,QAAM,YAAY,OAAiC,IAAI;AAEvD,YAAU,MAAM;AACd,QAAI,CAAC,MAAO;AAGZ,QAAI,qBAAqB,oBAAoB,OAAO;AAClD,wBAAkB,KAAK,CAAC,WAAW;AA9GzC;AA+GQ,YAAI,CAAC,OAAQ;AACb,kBAAU,UAAU,OAAO;AAC3B,iBAAS;AAAA,UACP,QAAQ,OAAO;AAAA,UACf,cAAa,YAAO,gBAAP,YAAsB;AAAA,UACnC,YAAW,YAAO,cAAP,YAAoB;AAAA,UAC/B,SAAS;AAAA,UACT,OAAO;AAAA,QACT,CAAC;AAAA,MACH,CAAC;AACD;AAAA,IACF;AAGA,QAAI,QAAQ,QAAS;AACrB,YAAQ,UAAU;AAElB,sBAAkB;AAClB,wBAAoB,OAAO,KAAK,EAAE,OAAO,QAAQ,eAAe,QAAQ,CAAC;AAEzE,sBACG,KAAK,CAAC,WAAW;AApIxB;AAqIQ,UAAI,CAAC,OAAQ;AACb,gBAAU,UAAU,OAAO;AAC3B,eAAS;AAAA,QACP,QAAQ,OAAO;AAAA,QACf,cAAa,YAAO,gBAAP,YAAsB;AAAA,QACnC,YAAW,YAAO,cAAP,YAAoB;AAAA,QAC/B,SAAS;AAAA,QACT,OAAO;AAAA,MACT,CAAC;AACD,yCAAU;AAAA,IACZ,CAAC,EACA,MAAM,CAAC,QAAQ;AACd,YAAM,QAAQ,eAAe,QAAQ,MAAM,IAAI,MAAM,OAAO,GAAG,CAAC;AAChE,eAAS,CAAC,UAAU,EAAE,GAAG,MAAM,OAAO,SAAS,KAAK,EAAE;AACtD,yCAAU;AAEV,0BAAoB;AACpB,wBAAkB;AAAA,IACpB,CAAC;AAAA,EAIL,GAAG,CAAC,OAAO,eAAe,SAAS,SAAS,OAAO,CAAC;AAEpD,SAAO,oBAAC,cAAc,UAAd,EAAuB,OAAO,OAAQ,UAAS;AACzD;AASO,SAAS,YAAgC;AAC9C,QAAM,UAAU,WAAW,aAAa;AACxC,MAAI,CAAC,SAAS;AACZ,UAAM,IAAI,MAAM,gDAAgD;AAAA,EAClE;AACA,SAAO;AACT;AAOO,SAAS,iBAA0B;AACxC,SAAO,UAAU,EAAE;AACrB;AAOO,SAAS,uBAAgD;AAC9D,SAAO,UAAU,EAAE;AACrB;AAOO,SAAS,qBAA6C;AAC3D,SAAO,UAAU,EAAE;AACrB;AAOO,SAAS,kBAA4C;AAC1D,SAAO,UAAU,EAAE;AACrB;",
   "names": []
 }