@floe-ai/sdk 0.1.0-dev.2 → 0.1.0-dev.21

package/dist-sdk/index.d.ts

@@ -1,26 +1,8 @@
-declare interface ContextData {
-    screenshot?: string;
-    url: string;
-    structure: PageStructure;
-    timestamp: number;
-    userProfile?: any;
-}
-
-declare interface ElementInfo {
-    selector: string;
-    type: string;
-    text?: string;
-    visible: boolean;
-    position: DOMRect;
-    attributes: Record<string, string>;
-}
-
-declare class EventEmitter {
-    private events;
-    on(event: string, listener: (...args: any[]) => void): this;
-    off(event: string, listener: (...args: any[]) => void): this;
-    emit(event: string, ...args: any[]): boolean;
-}
+import { ContextData } from './types';
+import { EventEmitter } from './types';
+import { ScreenshotOptions } from './types';
+import { SDKConfig } from './types';
+import { UIAction } from './types';
 
 /**
  * Initialize Floe SDK
@@ -72,6 +54,20 @@ export declare interface FloeConfig {
     userInfo?: FloeUserInfo;
     /** Skip the welcome modal for returning users */
     skipOnboardingModal?: boolean;
+    /** Nudge configuration - Intercom Fin-style sliding notification */
+    nudge?: FloeNudgeConfig;
+}
+
+/**
+ * Nudge configuration for Intercom Fin-style sliding notification
+ */
+export declare interface FloeNudgeConfig {
+    /** Main nudge message (default: "Hi 👋 How can I help you today?") */
+    text?: string;
+    /** Auto-show nudge when minimized (default: true) */
+    autoShow?: boolean;
+    /** Auto-hide after ms, 0 = never (default: 0) */
+    autoHideDelay?: number;
 }
 
 /**
@@ -126,6 +122,7 @@ declare class OnboardingSDK extends EventEmitter {
     private botAudioAnalyzer;
     private userAudioAnalyzer;
     private userMicStream;
+    private userMicStreamRequestId;
     private audioElements;
     private pageTracker;
     private screenShareEnabled;
@@ -138,12 +135,18 @@ declare class OnboardingSDK extends EventEmitter {
     private endUserStatus;
     private connectionProgress;
     private isReturningUser;
+    private hasSkippedOnboarding;
     private _isMinimized;
     constructor(config: SDKConfig);
     /**
      * Generate unique session ID
      */
     private generateSessionId;
+    /**
+     * Validate client key and check if bot is enabled for this site.
+     * This is called before showing any UI to ensure the bot should be displayed.
+     */
+    private validateClientKeyAndBotStatus;
     /**
      * Start screen sharing: sends the tab/window as a WebRTC video track to Pipecat.
      */
@@ -269,6 +272,32 @@ declare class OnboardingSDK extends EventEmitter {
      * Actions: highlight, click, type, focus, hover, scroll
      */
     private handleHybridAction;
+    /**
+     * Wait for navigation to complete by polling the current URL.
+     * Compares normalized URL components (origin, pathname, search, hash)
+     * to avoid false positives from substring matching.
+     *
+     * @param expectedUrl - Absolute URL we're navigating to (already resolved)
+     * @param timeoutMs - Maximum time to wait in milliseconds
+     * @returns true if navigation was observed, false if timed out
+     */
+    private waitForNavigation;
+    /**
+     * Finalize any pending bot navigation that was interrupted by a full-page load.
+     *
+     * When navigate sets `window.location.href` for a cross-origin or MPA target the
+     * entire JS context is destroyed, so the optimistic sendMetadata never fires.
+     * The navigate handler persists a record to sessionStorage before triggering
+     * the navigation.  On the next page load this method reads it back, validates
+     * that we actually arrived at the expected destination, and sends the final
+     * bot_action_complete metadata so the server can auto-advance the task.
+     *
+     * Called once during init() — safe to call before the WebRTC transport is
+     * connected because sendMetadata already guards on `this.isConnected`.
+     * We retry briefly after init to cover the case where the transport
+     * connects a moment later.
+     */
+    private _finalizePendingNavigation;
     /**
      * Check a precondition and report the result to the server.
      * Used for conditional task execution (e.g., check if an option exists before selecting it).
@@ -345,6 +374,24 @@ declare class OnboardingSDK extends EventEmitter {
      * @returns true if action succeeded
      */
     private executeActionFast;
+    /**
+     * Handle direct API execution request from server
+     * Part of Capability-Based Guidance - allows bot to execute APIs directly
+     *
+     * The SDK makes the fetch() call with the user's session/cookies,
+     * then reports the result back to the bot.
+     */
+    private handleExecuteApi;
+    /**
+     * Evaluate a JSONPath-style condition (simple implementation)
+     * Supports: $.path.to.value == "expected" or just $.path.to.value (truthy check)
+     */
+    private evaluateJsonPathCondition;
+    /**
+     * Extract value from object using simple JSONPath
+     * Supports: $.path.to.value or just path.to.value
+     */
+    private extractJsonPath;
     /**
      * Handle batched navigation request from server
      * Executes multiple navigation steps quickly without LLM round-trips
@@ -503,59 +550,4 @@ declare class OnboardingSDK extends EventEmitter {
     disconnect(): Promise<void>;
 }
 
-declare interface PageStructure {
-    title: string;
-    url: string;
-    elements: ElementInfo[];
-    viewport: {
-        width: number;
-        height: number;
-    };
-}
-
-declare interface ScreenshotOptions {
-    redact?: boolean;
-    scale?: number;
-    quality?: number;
-    format?: 'webp' | 'jpeg' | 'png';
-}
-
-declare interface SDKConfig {
-    clientKey: string;
-    apiUrl?: string;
-    enableVideo?: boolean;
-    enableAudio?: boolean;
-    enableScreenCapture?: boolean;
-    redactionPatterns?: Record<string, RegExp>;
-    debug?: boolean;
-    industry?: string;
-    useCase?: string;
-    companyName?: string;
-    companySize?: string;
-    role?: string;
-    userInfo?: UserInfo;
-    skipOnboardingModal?: boolean;
-    enableDiscoveryPopup?: boolean;
-}
-
-declare interface UIAction {
-    type: 'click' | 'type' | 'select' | 'hover' | 'scroll';
-    selector: string;
-    value?: string;
-    description?: string;
-}
-
-/**
- * AI Onboarding Agent SDK
- * Voice-first onboarding platform with WebRTC connectivity to Pipecat server
- */
-declare interface UserInfo {
-    externalId?: string;
-    email?: string;
-    name?: string;
-    company?: string;
-    designation?: string;
-    metadata?: Record<string, any>;
-}
-
 export { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@floe-ai/sdk",
-  "version": "0.1.0-dev.2",
+  "version": "0.1.0-dev.21",
   "description": "Floe AI Onboarding SDK for React applications",
   "type": "module",
   "main": "./dist-sdk/floe-sdk.es.js",
@@ -34,12 +34,11 @@
     "preview": "vite preview",
     "serve": "node serve-dist.js",
     "serve:sdk": "vite preview --config vite.config.sdk.ts --port 5174",
-    "clean": "rm -rf dist dist-sdk",
-    "prepublishOnly": "npm run build:sdk"
+    "clean": "rm -rf dist dist-sdk"
   },
   "peerDependencies": {
-    "react": "^18.0.0",
-    "react-dom": "^18.0.0"
+    "react": "^18.0.0 || ^19.0.0",
+    "react-dom": "^18.0.0 || ^19.0.0"
   },
   "dependencies": {
     "@pipecat-ai/client-js": "^1.4.1",
@@ -49,8 +48,8 @@
     "@pipecat-ai/voice-ui-kit": "^0.4.2"
   },
   "devDependencies": {
-    "@types/react": "^18.2.0",
-    "@types/react-dom": "^18.2.0",
+    "@types/react": "^18.2.0 || ^19.0.0",
+    "@types/react-dom": "^18.2.0 || ^19.0.0",
     "@vitejs/plugin-react": "^4.2.0",
     "cors": "^2.8.5",
     "express": "^5.1.0",