@syntrologie/runtime-sdk 2.8.0-canary.4 → 2.8.0-canary.40

package/CAPABILITIES.md

@@ -233,6 +233,7 @@ Inserts HTML content relative to an element.
 | `anchorId` | string          | Yes      | Element selector                                            |
 | `html`     | string          | Yes      | HTML content (sanitized)                                    |
 | `position` | string          | Yes      | `"before"`, `"after"`, `"prepend"`, `"append"`, `"replace"` |
+| `deepLink` | object          | No       | Makes the entire inserted element clickable to open the canvas panel and navigate to a specific tile |
 
 **Positions:**
 
@@ -251,6 +252,27 @@ Inserts HTML content relative to an element.
 }
 ```
 
+**Deep-linking to canvas tiles:**
+
+Use `deepLink` to make inserted content open the canvas panel and navigate to a specific tile when clicked. This is the correct way to connect inserted buttons/links to canvas tiles — do NOT use `onclick` handlers with `window.SynOS`.
+
+| Property         | Type   | Required | Description                        |
+| ---------------- | ------ | -------- | ---------------------------------- |
+| `deepLink.tileId` | string | Yes      | ID of the tile to open             |
+| `deepLink.itemId` | string | No       | Specific item within the tile      |
+
+```json
+{
+  "kind": "insert_html",
+  "anchorId": "[data-id='pricing-heading']",
+  "html": "<button style='background: #4a90e2; color: white; border: none; padding: 8px 16px; border-radius: 20px; cursor: pointer;'>Help Me Choose</button>",
+  "position": "after",
+  "deepLink": { "tileId": "plan_selector_faq" }
+}
+```
+
+The SDK automatically handles opening the canvas, setting the cursor to pointer, and publishing a `notification.deep_link` event. The click handler is wired up and cleaned up by the SDK — no JavaScript in the HTML is needed.
+
 ### add_class
 
 Adds a CSS class to an element.
@@ -1284,3 +1306,25 @@ Control when adaptives activate using `DecisionStrategy`:
 - Listen for `action.failed` to handle errors
 - Track `action.applied` for analytics
 - Use EventBus for cross-adaptive coordination
+
+### 6. Opening the Canvas from Inserted Content
+
+When `content:insertHtml` needs to open the canvas panel (e.g., a "Help Me Choose" button that opens an FAQ tile), use the `deepLink` property — **never write `onclick` handlers or reference `window.SynOS` in HTML**.
+
+```json
+{
+  "kind": "insert_html",
+  "anchorId": "[data-id='pricing-heading']",
+  "html": "<button style='background: #4a90e2; color: white; border: none; padding: 8px 16px; border-radius: 20px; cursor: pointer;'>Help Me Choose</button>",
+  "position": "after",
+  "deepLink": { "tileId": "plan_selector_faq" }
+}
+```
+
+The `deepLink` object:
+- `tileId` (required) — ID of the canvas tile to navigate to
+- `itemId` (optional) — specific item within the tile (e.g., a FAQ question ID)
+
+The SDK automatically opens the canvas, navigates to the tile, sets cursor to pointer, and wires up click/cleanup handlers.
+
+**NEVER use `onclick`, `window.SynOS`, or any JavaScript in `insert_html` HTML strings.** The HTML is sanitized and event handlers are stripped. Use `deepLink` instead.

package/dist/actions/schema.d.ts

@@ -26592,4 +26592,4 @@ export declare const coreActionStepSchemas: ({
         }>]>>>;
     }, z.ZodTypeAny, "passthrough">>;
 })[];
-export { AnchorIdZ, HighlightStyleZ, BadgePositionZ, PlacementZ, CtaButtonZ, TooltipContentZ, ModalContentZ, InsertPositionZ, TooltipTriggerZ, WidgetConfigZ, TourStepForSchemaZ, ScrollBehaviorZ, ScrollLogicalPositionZ, SetTextZ, SetAttrZ, AddClassZ, RemoveClassZ, SetStyleZ, InsertHtmlZ, HighlightZ, PulseZ, BadgeZ, TooltipZ, ModalZ, ScrollToZ, NavigateZ, MountWidgetZ, WaitZ, SequenceZ, ParallelZ, TourZ, };
+export { AddClassZ, AnchorIdZ, BadgePositionZ, BadgeZ, CtaButtonZ, HighlightStyleZ, HighlightZ, InsertHtmlZ, InsertPositionZ, ModalContentZ, ModalZ, MountWidgetZ, NavigateZ, ParallelZ, PlacementZ, PulseZ, RemoveClassZ, ScrollBehaviorZ, ScrollLogicalPositionZ, ScrollToZ, SequenceZ, SetAttrZ, SetStyleZ, SetTextZ, TooltipContentZ, TooltipTriggerZ, TooltipZ, TourStepForSchemaZ, TourZ, WaitZ, WidgetConfigZ, };

package/dist/actions/schema.js

@@ -31,7 +31,7 @@ import {
   WaitZ,
   WidgetConfigZ,
   coreActionStepSchemas
-} from "../chunk-R5DNAIRI.js";
+} from "../chunk-TN5BLBPU.js";
 import "../chunk-XDYJ64IN.js";
 import "../chunk-BU4Z6PD7.js";
 export {

package/dist/actions/validation-core.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Action Validation — Core
+ *
+ * Main validate dispatch function, anchor validation, dangerous attrs constants,
+ * and common validation helpers.
+ */
+import type { ActionStep, AnchorId, ValidationError, ValidationResult, ValidationWarning } from './types';
+/** Dangerous attribute names that should not be set */
+export declare const DANGEROUS_ATTRS: Set<string>;
+/** Maximum HTML content length */
+export declare const MAX_HTML_LENGTH = 50000;
+/** Maximum style count */
+export declare const MAX_STYLE_COUNT = 50;
+/**
+ * Validate an action step.
+ */
+export declare function validateAction(action: ActionStep): ValidationResult;
+export declare function validateAnchorAction(action: {
+    anchorId: AnchorId;
+}, errors: ValidationError[], warnings: ValidationWarning[]): void;
+/**
+ * Validate a batch of actions.
+ */
+export declare function validateActions(actions: ActionStep[]): ValidationResult;

package/dist/actions/validation-rules.d.ts

@@ -0,0 +1,74 @@
+/**
+ * Action Validation — Rules
+ *
+ * Specific validators by action kind: badge, tooltip, modal, content
+ * (text/attrs/classes/styles/HTML), tour, sequence, parallel, wait,
+ * navigate, mountWidget, and warning detection.
+ */
+import type { ActionStep, ValidationError, ValidationWarning } from './types';
+export declare function validateBadgeAction(action: {
+    content: string;
+}, errors: ValidationError[], warnings: ValidationWarning[]): void;
+export declare function validateTooltipAction(action: {
+    content: {
+        title?: string;
+        body: string;
+    };
+}, errors: ValidationError[], _warnings: ValidationWarning[]): void;
+export declare function validateInsertHtmlAction(action: {
+    html: string;
+    position: string;
+}, errors: ValidationError[], _warnings: ValidationWarning[]): void;
+export declare function validateSetTextAction(action: {
+    text: string;
+}, errors: ValidationError[], _warnings: ValidationWarning[]): void;
+export declare function validateSetAttrAction(action: {
+    attr: string;
+    value: string;
+}, errors: ValidationError[], _warnings: ValidationWarning[]): void;
+export declare function validateClassAction(action: {
+    className: string;
+}, errors: ValidationError[], warnings: ValidationWarning[]): void;
+export declare function validateSetStyleAction(action: {
+    styles: Record<string, string>;
+}, errors: ValidationError[], _warnings: ValidationWarning[]): void;
+export declare function validateMountWidgetAction(action: {
+    slot: string;
+    widget: {
+        widgetId: string;
+    };
+}, errors: ValidationError[], _warnings: ValidationWarning[]): void;
+export declare function validateWaitAction(action: {
+    durationMs?: number;
+    event?: string;
+}, errors: ValidationError[], _warnings: ValidationWarning[]): void;
+export declare function validateSequenceAction(action: {
+    actions: ActionStep[];
+}, errors: ValidationError[], warnings: ValidationWarning[]): void;
+export declare function validateParallelAction(action: {
+    actions: ActionStep[];
+    waitFor?: string;
+}, errors: ValidationError[], warnings: ValidationWarning[]): void;
+export declare function validateNavigateAction(action: {
+    url: string;
+}, errors: ValidationError[], warnings: ValidationWarning[]): void;
+export declare function validateModalAction(action: {
+    content: {
+        title?: string;
+        body: string;
+    };
+    size?: string;
+    ctaButtons?: {
+        label: string;
+        actionId: string;
+    }[];
+}, errors: ValidationError[], _warnings: ValidationWarning[]): void;
+export declare function validateTourAction(action: {
+    tourId: string;
+    steps: {
+        id: string;
+        action: ActionStep;
+        route?: string;
+        onAction?: Record<string, string>;
+    }[];
+}, errors: ValidationError[], warnings: ValidationWarning[]): void;

package/dist/actions/validation.d.ts

@@ -1,14 +1,8 @@
 /**
- * Action Validation
+ * Action Validation — Barrel re-export
  *
- * Validates action steps before execution.
+ * Re-exports from validation-core and validation-rules so that existing
+ * imports from './validation' continue to work unchanged.
  */
-import type { ActionStep, ValidationResult } from './types';
-/**
- * Validate an action step.
- */
-export declare function validateAction(action: ActionStep): ValidationResult;
-/**
- * Validate a batch of actions.
- */
-export declare function validateActions(actions: ActionStep[]): ValidationResult;
+export { DANGEROUS_ATTRS, MAX_HTML_LENGTH, MAX_STYLE_COUNT, validateAction, validateActions, validateAnchorAction, } from './validation-core';
+export { validateBadgeAction, validateClassAction, validateInsertHtmlAction, validateModalAction, validateMountWidgetAction, validateNavigateAction, validateParallelAction, validateSequenceAction, validateSetAttrAction, validateSetStyleAction, validateSetTextAction, validateTooltipAction, validateTourAction, validateWaitAction, } from './validation-rules';

package/dist/bootstrap-init.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Bootstrap init helpers — token decode, host resolution, browser metadata
+ * collection, env var resolution, segment cache, and geo data fetching.
+ */
+/**
+ * Get environment variable, supporting both Vite and Next.js patterns.
+ */
+export declare function getEnvVar(name: string): string | undefined;
+/**
+ * Load cached segment attributes from localStorage.
+ * Returns cached values for instant Phase 1 evaluation.
+ */
+export declare function loadCachedSegmentAttributes(): Record<string, boolean>;
+/**
+ * Save segment attributes to localStorage for faster future loads.
+ */
+export declare function cacheSegmentAttributes(attrs: Record<string, boolean>): void;
+/**
+ * Extract segment flags (in_segment_*) from PostHog feature flags.
+ */
+export declare function extractSegmentFlags(allFlags: Record<string, boolean | string> | undefined): Record<string, boolean>;
+/**
+ * Collect browser metadata for instant GrowthBook targeting.
+ * This data is available synchronously from browser APIs — no network call needed.
+ * Only non-empty values are included.
+ */
+export declare function collectBrowserMetadata(): Record<string, string | string[]>;
+export declare const GEO_DEFAULT_HOST = "https://geo.syntrologie.com";
+/**
+ * Fetch geo data from the Cloudflare Worker, with localStorage caching.
+ * Returns cached data immediately on subsequent visits. Best-effort — never blocks init.
+ */
+export declare function fetchGeo(geoHost: string): Promise<Record<string, string>>;

package/dist/bootstrap-runtime.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Bootstrap runtime phase — EventBus creation, event processor, experiment client,
+ * telemetry, runtime factory, canvas initialization, app loader, and cleanup.
+ */
+import type { SyntroInitOptions, SyntroInitResult } from './bootstrap-types';
+/** Internal init implementation — all errors propagate to the outer init() try/catch. */
+export declare function _initCore(options: SyntroInitOptions): Promise<SyntroInitResult>;

package/dist/bootstrap-types.d.ts

@@ -0,0 +1,90 @@
+/**
+ * Bootstrap type definitions — interfaces, enums, and type exports
+ * for the Syntro SDK initialization flow.
+ */
+import type { SmartCanvasConfig, SmartCanvasHandle } from './api';
+import type { AppLoader } from './apps/AppLoader';
+import type { ExperimentClient } from './experiments/types';
+import type { SessionMetricTracker } from './metrics';
+import type { SmartCanvasRuntime } from './runtime';
+import type { TelemetryClient } from './telemetry/types';
+import type { CanvasConfigFetcher } from './types';
+export interface SyntroInitOptions {
+    /**
+     * The Syntro token containing all credentials.
+     * Generated from your admin dashboard.
+     *
+     * Optional in editor mode (when editor_token is present in URL params).
+     */
+    token?: string;
+    /**
+     * Optional canvas configuration overrides.
+     */
+    canvas?: Partial<Omit<SmartCanvasConfig, 'integrations' | 'fetcher'>>;
+    /**
+     * Custom config fetcher to override the default experiment-based fetcher.
+     * Use this for local development or when bypassing the experiment server.
+     *
+     * When provided, this fetcher is used instead of the experiments-based config lookup.
+     * The token's telemetry credentials (t field) are still used if present.
+     */
+    fetcher?: CanvasConfigFetcher;
+    /**
+     * @deprecated Session metrics are always enabled. This flag has no effect.
+     */
+    enableSessionMetrics?: boolean;
+    /**
+     * CDN base URL for loading adaptive bundles.
+     * Adaptives are loaded from: {cdnBase}/adaptives/{appId}/index.js
+     *
+     * @default "https://cdn.syntrologie.com"
+     */
+    cdnBase?: string;
+    /**
+     * @deprecated Core app executors are now registered synchronously.
+     * This option has no effect and will be removed in a future version.
+     */
+    registerBuiltInApps?: boolean;
+    /**
+     * Enable debug mode. emit() returns EmitResult, all events logged to console.
+     * @default false
+     */
+    debug?: boolean;
+    /**
+     * Enable test mode. PostHog capture skipped, toasts not rendered,
+     * full event history retained (uncapped).
+     * @default false
+     */
+    testMode?: boolean;
+}
+export interface SyntroInitResult {
+    /**
+     * The SmartCanvas handle for controlling the canvas.
+     */
+    canvas: SmartCanvasHandle;
+    /**
+     * The unified v2 runtime with all providers.
+     * Use this to access telemetry, context, events, and state.
+     */
+    runtime: SmartCanvasRuntime;
+    /**
+     * The experiment client, if experiments are configured in the token.
+     * @deprecated Access via runtime.telemetry or use DecisionStrategy instead
+     */
+    experiments?: ExperimentClient;
+    /**
+     * The telemetry client, if telemetry is configured in the token.
+     * @deprecated Access via runtime.telemetry instead
+     */
+    telemetry?: TelemetryClient;
+    /**
+     * The session metric tracker, if enableSessionMetrics is true.
+     * @deprecated Access via runtime.sessionMetrics instead
+     */
+    sessionMetrics?: SessionMetricTracker;
+    /**
+     * App loader for loading external apps from CDN.
+     * Exposed for manual app loading if needed.
+     */
+    appLoader: AppLoader;
+}

package/dist/bootstrap.d.ts

@@ -16,89 +16,11 @@
  * runtime.state.dismissals.mark('my-tile');
  * ```
  */
-import { type SmartCanvasConfig, type SmartCanvasHandle } from './api';
 import type { appRegistry } from './apps';
-import { type AppLoader } from './apps/AppLoader';
-import type { ExperimentClient } from './experiments/types';
-import { type SessionMetricTracker } from './metrics';
-import { type SmartCanvasRuntime } from './runtime';
-import type { TelemetryClient } from './telemetry/types';
+import type { SmartCanvasRuntime } from './runtime';
 import { decodeToken, encodeToken } from './token';
-import type { CanvasConfigFetcher } from './types';
-export interface SyntroInitOptions {
-    /**
-     * The Syntro token containing all credentials.
-     * Generated from your admin dashboard.
-     *
-     * Optional in editor mode (when editor_token is present in URL params).
-     */
-    token?: string;
-    /**
-     * Optional canvas configuration overrides.
-     */
-    canvas?: Partial<Omit<SmartCanvasConfig, 'integrations' | 'fetcher'>>;
-    /**
-     * Custom config fetcher to override the default experiment-based fetcher.
-     * Use this for local development or when bypassing the experiment server.
-     *
-     * When provided, this fetcher is used instead of the experiments-based config lookup.
-     * The token's telemetry credentials (t field) are still used if present.
-     */
-    fetcher?: CanvasConfigFetcher;
-    /**
-     * @deprecated Session metrics are always enabled. This flag has no effect.
-     */
-    enableSessionMetrics?: boolean;
-    /**
-     * CDN base URL for loading adaptive bundles.
-     * Adaptives are loaded from: {cdnBase}/adaptives/{appId}/index.js
-     *
-     * @default "https://cdn.syntrologie.com"
-     */
-    cdnBase?: string;
-    /**
-     * @deprecated Core app executors are now registered synchronously.
-     * This option has no effect and will be removed in a future version.
-     */
-    registerBuiltInApps?: boolean;
-}
-export interface SyntroInitResult {
-    /**
-     * The SmartCanvas handle for controlling the canvas.
-     */
-    canvas: SmartCanvasHandle;
-    /**
-     * The unified v2 runtime with all providers.
-     * Use this to access telemetry, context, events, and state.
-     */
-    runtime: SmartCanvasRuntime;
-    /**
-     * The experiment client, if experiments are configured in the token.
-     * @deprecated Access via runtime.telemetry or use DecisionStrategy instead
-     */
-    experiments?: ExperimentClient;
-    /**
-     * The telemetry client, if telemetry is configured in the token.
-     * @deprecated Access via runtime.telemetry instead
-     */
-    telemetry?: TelemetryClient;
-    /**
-     * The session metric tracker, if enableSessionMetrics is true.
-     * @deprecated Access via runtime.sessionMetrics instead
-     */
-    sessionMetrics?: SessionMetricTracker;
-    /**
-     * App loader for loading external apps from CDN.
-     * Exposed for manual app loading if needed.
-     */
-    appLoader: AppLoader;
-}
-/**
- * Collect browser metadata for instant GrowthBook targeting.
- * This data is available synchronously from browser APIs — no network call needed.
- * Only non-empty values are included.
- */
-export declare function collectBrowserMetadata(): Record<string, string | string[]>;
+export { collectBrowserMetadata, fetchGeo } from './bootstrap-init';
+export type { SyntroInitOptions, SyntroInitResult } from './bootstrap-types';
 /**
  * Initialize the Syntro SDK with a single token.
  *
@@ -112,7 +34,17 @@ export declare function collectBrowserMetadata(): Record<string, string | string
  * @param options - Initialization options
  * @returns The initialized SDK components
  */
-declare function init(options: SyntroInitOptions): Promise<SyntroInitResult>;
+declare function init(options: import('./bootstrap-types').SyntroInitOptions): Promise<import('./bootstrap-types').SyntroInitResult | undefined>;
+/**
+ * Emit a custom event through the SDK.
+ *
+ * Events flow through the EventBus (tile notification rule matching)
+ * and PostHog (analytics). Event names must use the `app:` prefix.
+ *
+ * @param eventName - Event name (e.g., 'app:setup:sdk_connected')
+ * @param props - Optional event properties
+ */
+declare function emit(eventName: string, props?: Record<string, unknown>): void;
 /**
  * The Syntro namespace for single-token initialization.
  */
@@ -120,6 +52,9 @@ export declare const Syntro: {
     init: typeof init;
     encodeToken: typeof encodeToken;
     decodeToken: typeof decodeToken;
+    events: {
+        emit: typeof emit;
+    };
 };
 declare global {
     interface Window {
@@ -131,4 +66,3 @@ declare global {
         };
     }
 }
-export {};