@prodact.ai/sdk 0.0.6 → 0.0.7

package/dist/index.d.ts

@@ -0,0 +1,332 @@
+// Core SDK Types
+export interface ProduckConfig {
+  guiderId?: string;
+  sdkKey?: string;
+  apiUrl?: string;
+  onAction?: (actionKey: string, action: ActionPayload) => void;
+  onMessage?: (message: ChatMessage) => void;
+  onError?: (error: Error) => void;
+  onFlowStart?: (flow: FlowPayload) => void;
+  onFlowStepComplete?: (step: FlowStepResult, flow: FlowPayload) => void;
+  onFlowComplete?: (result: FlowResult) => void;
+  recording?: RecordingConfig;
+  proactive?: ProactiveConfig;
+  userFlows?: UserFlowConfig;
+  onProactiveMessage?: (message: string, context: ProactiveContext) => void;
+  initialMessage?: string;
+  streamInitialMessage?: boolean;
+}
+
+export interface ActionPayload {
+  actionKey: string;
+  name: string;
+  actionType: string;
+  actionConfig: Record<string, any>;
+  responseMessage?: string;
+}
+
+export interface FlowStep {
+  operationId: string;
+  order: number;
+  condition?: Record<string, any>;
+  inputMapping?: Record<string, any>;
+}
+
+export interface FlowPayload {
+  flowId: string;
+  name: string;
+  description: string;
+  steps: FlowStep[];
+}
+
+export interface FlowStepResult {
+  operationId: string;
+  order: number;
+  success: boolean;
+  data?: any;
+  error?: string;
+}
+
+export interface FlowResult {
+  flowId: string;
+  name: string;
+  steps: FlowStepResult[];
+  completed: boolean;
+  totalSteps: number;
+  successfulSteps: number;
+}
+
+export interface ChatMessage {
+  role: 'user' | 'assistant';
+  content: string;
+  action?: ActionPayload;
+  flow?: FlowPayload;
+  flowResult?: FlowResult;
+  visualFlows?: VisualFlowReference[];
+  images?: ImageReference[];
+}
+
+export interface VisualFlowReference {
+  flowId: string;
+  name: string;
+  description: string;
+  score: number;
+  stepsCount?: number;
+  tags?: string[];
+}
+
+export interface ImageReference {
+  url: string;
+  name: string;
+  description: string;
+  score: number;
+}
+
+export interface VisualFlowStep {
+  id: string;
+  stepOrder: number;
+  title: string;
+  description: string;
+  screenshotUrl: string | null;
+  elementSelector: string | null;
+  pageUrl: string;
+}
+
+export interface VisualFlowDetails {
+  id: string;
+  flowId: string;
+  name: string;
+  description: string;
+  tags: string[];
+  steps: VisualFlowStep[];
+}
+
+export type ActionHandler = (payload: ActionPayload) => void | Promise<void>;
+
+export type ProduckEventType = 'action' | 'message' | 'error' | 'ready' | 'flowStart' | 'flowStepComplete' | 'flowComplete' | 'proactive';
+
+// Recording Types
+export interface RecordingConfig {
+  enabled?: boolean;
+  samplingRate?: number;
+  privacy?: RecordingPrivacyConfig;
+  performance?: RecordingPerformanceConfig;
+  capture?: RecordingCaptureConfig;
+  maxDuration?: number;
+}
+
+export interface RecordingPrivacyConfig {
+  maskAllInputs?: boolean;
+  maskInputTypes?: string[];
+  maskSelectors?: string[];
+  blockSelectors?: string[];
+  ignoreSelectors?: string[];
+  maskTextContent?: boolean;
+  maskTextSelectors?: string[];
+}
+
+export interface RecordingPerformanceConfig {
+  checkoutEveryNms?: number;
+  batchSize?: number;
+  batchIntervalMs?: number;
+  compressionEnabled?: boolean;
+}
+
+export interface RecordingCaptureConfig {
+  mouse?: boolean;
+  scroll?: boolean;
+  input?: boolean;
+  resize?: boolean;
+  mediaInteraction?: boolean;
+  console?: boolean;
+  errors?: boolean;
+}
+
+export interface RecordingSession {
+  sessionId: string;
+  startTime: Date;
+  duration: number;
+  eventCount: number;
+  isActive: boolean;
+}
+
+export interface RecordingStats {
+  totalEvents: number;
+  batchesSent: number;
+  errors: number;
+  duration: number;
+}
+
+export interface CustomRecordingEvent {
+  type: string;
+  data: Record<string, any>;
+  timestamp?: number;
+}
+
+// Proactive Types
+export interface ProactiveConfig {
+  enabled?: boolean;
+  idleTimeThreshold?: number;
+  scrollDepthThreshold?: number;
+  ragClickThreshold?: number;
+  exitIntentEnabled?: boolean;
+  triggers?: ProactiveTrigger[];
+}
+
+export interface ProactiveTrigger {
+  type: 'idle' | 'scroll' | 'rage_click' | 'exit_intent' | 'time_on_page' | 'custom';
+  condition?: Record<string, any>;
+  message?: string;
+  priority?: number;
+}
+
+export interface ProactiveContext {
+  triggerType: string;
+  pageUrl: string;
+  timeOnPage: number;
+  scrollDepth: number;
+  metadata?: Record<string, any>;
+}
+
+export interface ProactiveCallbacks {
+  onTrigger?: (trigger: ProactiveTrigger, context: ProactiveContext) => void;
+  onMessage?: (message: string, context: ProactiveContext) => void;
+}
+
+export declare const defaultProactiveConfig: ProactiveConfig;
+
+// User Flow Types
+export interface UserFlowConfig {
+  enabled?: boolean;
+  events?: UserFlowEventsConfig;
+  elements?: UserFlowElementConfig;
+  performance?: UserFlowPerformanceConfig;
+}
+
+export interface UserFlowEventsConfig {
+  clicks?: boolean;
+  inputs?: boolean;
+  scrolls?: boolean;
+  navigation?: boolean;
+  errors?: boolean;
+  customEvents?: boolean;
+}
+
+export interface UserFlowElementConfig {
+  captureSelectors?: boolean;
+  captureText?: boolean;
+  maxTextLength?: number;
+}
+
+export interface UserFlowPerformanceConfig {
+  batchSize?: number;
+  batchIntervalMs?: number;
+  maxEventsPerSession?: number;
+}
+
+export interface UserIdentification {
+  userId?: string;
+  email?: string;
+  name?: string;
+  metadata?: Record<string, any>;
+}
+
+export interface DeviceInfo {
+  userAgent: string;
+  language: string;
+  platform: string;
+  screenWidth: number;
+  screenHeight: number;
+  viewportWidth: number;
+  viewportHeight: number;
+  devicePixelRatio: number;
+  timezone: string;
+}
+
+export interface ElementInfo {
+  tagName: string;
+  id?: string;
+  className?: string;
+  text?: string;
+  selector?: string;
+}
+
+export interface UserFlowEvent {
+  type: string;
+  timestamp: number;
+  data: Record<string, any>;
+}
+
+export interface UserFlowSession {
+  sessionId: string;
+  startTime: Date;
+  events: UserFlowEvent[];
+}
+
+export interface TrackingState {
+  isTracking: boolean;
+  sessionId: string | null;
+  eventCount: number;
+}
+
+export interface TrackerStats {
+  totalEvents: number;
+  batchesSent: number;
+  errors: number;
+}
+
+// Core SDK Class
+export declare class ProduckSDK {
+  constructor(config: ProduckConfig);
+  init(): Promise<void>;
+  getSessionToken(): string | null;
+  sendMessage(message: string): Promise<ChatMessage>;
+  registerAction(key: string, handler: ActionHandler): void;
+  unregisterAction(key: string): void;
+  on(event: ProduckEventType, callback: Function): void;
+  off(event: ProduckEventType, callback: Function): void;
+  getVisualFlow(flowId: string): Promise<VisualFlowDetails | null>;
+  destroy(): void;
+  
+  // Recording methods
+  startRecording(): Promise<void>;
+  stopRecording(): Promise<void>;
+  pauseRecording(): void;
+  resumeRecording(): void;
+  getRecordingStats(): RecordingStats | null;
+  addCustomEvent(event: CustomRecordingEvent): void;
+  
+  // User identification
+  identify(user: UserIdentification): void;
+  
+  // User flow tracking
+  trackEvent(eventType: string, data?: Record<string, any>): void;
+  getFlowStats(): TrackerStats | null;
+}
+
+// Session Recorder Class
+export declare class SessionRecorder {
+  constructor(config?: RecordingConfig);
+  start(sdkSessionToken: string, apiUrl: string, sdkKey?: string): Promise<void>;
+  stop(): Promise<void>;
+  pause(): void;
+  resume(): void;
+  getStats(): RecordingStats;
+  getSession(): RecordingSession | null;
+  addCustomEvent(event: CustomRecordingEvent): void;
+}
+
+// User Flow Tracker Class
+export declare class UserFlowTracker {
+  constructor(config?: UserFlowConfig);
+  start(sessionToken: string, apiUrl: string, sdkKey?: string): void;
+  stop(): void;
+  identify(user: UserIdentification): void;
+  trackEvent(eventType: string, data?: Record<string, any>): void;
+  getStats(): TrackerStats;
+}
+
+// Factory functions
+export declare function createProduck(config: ProduckConfig): ProduckSDK;
+export declare function createSessionRecorder(config?: RecordingConfig): SessionRecorder;
+export declare function createUserFlowTracker(config?: UserFlowConfig): UserFlowTracker;

package/dist/react.d.ts

@@ -0,0 +1,155 @@
+import { ReactNode, CSSProperties } from 'react';
+
+// Re-export core types
+export type {
+  ProduckConfig,
+  ActionPayload,
+  ChatMessage,
+  ActionHandler,
+  FlowPayload,
+  FlowStep,
+  FlowResult,
+  FlowStepResult,
+  VisualFlowReference,
+  VisualFlowDetails,
+  VisualFlowStep,
+  ImageReference,
+} from './index';
+
+import type {
+  ProduckConfig,
+  ActionPayload,
+  ChatMessage,
+  FlowPayload,
+  FlowResult,
+  FlowStepResult,
+  VisualFlowReference,
+} from './index';
+
+import { ProduckSDK } from './index';
+
+// Context Types
+export interface ProduckContextValue {
+  sdk: ProduckSDK | null;
+  isReady: boolean;
+  sessionToken: string | null;
+  messages: ChatMessage[];
+  isLoading: boolean;
+  sendMessage: (message: string) => Promise<void>;
+  register: (actionKey: string, handler: (payload: ActionPayload) => void) => void;
+  unregister: (actionKey: string) => void;
+  activeFlow: FlowPayload | null;
+  flowResult: FlowResult | null;
+  isExecutingFlow: boolean;
+}
+
+// Provider Props
+export interface ProduckProviderProps {
+  config: Omit<ProduckConfig, 'onAction' | 'onMessage' | 'onError' | 'onFlowStart' | 'onFlowStepComplete' | 'onFlowComplete'>;
+  children: ReactNode;
+  onAction?: (actionKey: string, payload: ActionPayload) => void;
+  onError?: (error: Error) => void;
+  onFlowStart?: (flow: FlowPayload) => void;
+  onFlowStepComplete?: (step: FlowStepResult, flow: FlowPayload) => void;
+  onFlowComplete?: (result: FlowResult) => void;
+}
+
+// Chat Appearance
+export interface ProduckChatAppearance {
+  width?: string | number;
+  height?: string | number;
+  borderRadius?: string | number;
+  backgroundColor?: string;
+  headerBackgroundColor?: string;
+  headerTextColor?: string;
+  inputBackgroundColor?: string;
+  inputTextColor?: string;
+  inputBorderColor?: string;
+  userMessageBackgroundColor?: string;
+  userMessageTextColor?: string;
+  assistantMessageBackgroundColor?: string;
+  assistantMessageTextColor?: string;
+  buttonBackgroundColor?: string;
+  buttonTextColor?: string;
+  buttonBorderRadius?: string | number;
+  floatingButtonSize?: string | number;
+  fontFamily?: string;
+  fontSize?: string | number;
+  headerFontSize?: string | number;
+  border?: string;
+  boxShadow?: string;
+  floatingButtonIcon?: ReactNode;
+  floatingButtonLoadingIcon?: ReactNode;
+  showCloseButton?: boolean;
+  headerIcon?: ReactNode;
+  sendButtonText?: string;
+  sendButtonIcon?: ReactNode;
+  emptyStateIcon?: ReactNode;
+  emptyStateTitle?: string;
+  emptyStateSubtitle?: string;
+}
+
+// Chat Props
+export interface ProduckChatProps {
+  placeholder?: string;
+  title?: string;
+  position?: 'bottom-right' | 'bottom-left' | 'inline';
+  theme?: 'light' | 'dark';
+  primaryColor?: string;
+  className?: string;
+  style?: CSSProperties;
+  defaultOpen?: boolean;
+  appearance?: ProduckChatAppearance;
+  initialMessage?: string;
+  initialMessageDelay?: number;
+  autoOpenDelay?: number;
+  proactiveEnabled?: boolean;
+  showPoweredBy?: boolean;
+  poweredByText?: string;
+  poweredByUrl?: string;
+}
+
+// Target Props
+export interface ProduckTargetProps {
+  actionKey: string;
+  children: ReactNode;
+  onTrigger?: (payload: ActionPayload) => void;
+  highlightStyle?: CSSProperties;
+  highlightDuration?: number;
+  scrollIntoView?: boolean;
+}
+
+// Visual Flow Display Props
+export interface VisualFlowDisplayProps {
+  flowRef: VisualFlowReference;
+  theme?: 'light' | 'dark';
+  primaryColor?: string;
+}
+
+// Components
+export declare function ProduckProvider(props: ProduckProviderProps): JSX.Element;
+export declare function ProduckChat(props: ProduckChatProps): JSX.Element;
+export declare function ProduckTarget(props: ProduckTargetProps): JSX.Element;
+export declare function VisualFlowDisplay(props: VisualFlowDisplayProps): JSX.Element;
+
+// Context
+export declare const ProduckContext: React.Context<ProduckContextValue | null>;
+
+// Hooks
+export declare function useProduck(): ProduckContextValue;
+export declare function useProduckAction(
+  actionKey: string,
+  handler: (payload: ActionPayload) => void,
+  deps?: any[]
+): void;
+export declare function useProduckReady(): boolean;
+export declare function useProduckMessages(): {
+  messages: ChatMessage[];
+  isLoading: boolean;
+  sendMessage: (message: string) => Promise<void>;
+};
+export declare function useProduckFlow(): {
+  activeFlow: FlowPayload | null;
+  flowResult: FlowResult | null;
+  isExecutingFlow: boolean;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prodact.ai/sdk",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "Interactive SDK for Prodact.ai - AI-powered UI interactions",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -26,7 +26,8 @@
     "README.md"
   ],
   "scripts": {
-    "build": "tsup",
+    "build": "tsup && npm run postbuild",
+    "postbuild": "cp types/index.d.ts dist/index.d.ts && cp types/react.d.ts dist/react.d.ts",
     "build:cdn": "tsup --config tsup.cdn.config.ts",
     "build:wordpress": "tsup --config tsup.wordpress.config.ts",
     "build:all": "npm run build && npm run build:cdn",