@snf/qa-bot-core 0.2.11 → 0.2.13

package/dist/types/config.d.ts

@@ -2,23 +2,32 @@ import type { Settings, Flow } from 'react-chatbotify';
 /**
  * Analytics event types fired by qa-bot-core
  */
-export type QABotAnalyticsEventType = 'qa_bot_opened' | 'qa_bot_closed' | 'qa_new_chat_started' | 'qa_question_asked' | 'qa_response_received' | 'qa_response_error' | 'qa_response_rated' | 'qa_login_prompt_shown';
+export type QABotAnalyticsEventType = 'chatbot_open' | 'chatbot_close' | 'chatbot_new_chat' | 'chatbot_question_sent' | 'chatbot_answer_received' | 'chatbot_answer_error' | 'chatbot_rating_sent' | 'chatbot_login_prompt_shown';
 /**
  * Analytics event payload
- * Fields are populated based on event type:
- * - qa_bot_opened: sessionId
- * - qa_bot_closed: sessionId, messageCount, durationMs
- * - qa_new_chat_started: sessionId, previousMessageCount
- * - qa_question_asked: sessionId, queryId, questionLength
- * - qa_response_received: sessionId, queryId, responseTimeMs, success, responseLength, hasMetadata
- * - qa_response_error: sessionId, queryId, errorType
- * - qa_response_rated: sessionId, queryId, rating
- * - qa_login_prompt_shown: sessionId
+ *
+ * Common fields (auto-populated for all events):
+ * - timestamp: When the event occurred
+ * - sessionId: Current chat session ID
+ * - pageUrl: URL where the bot is displayed
+ * - isEmbedded: Whether bot is in embedded mode (true) or floating/widget mode (false)
+ *
+ * Event-specific fields:
+ * - chatbot_open: (common fields only)
+ * - chatbot_close: messageCount, durationMs
+ * - chatbot_new_chat: previousMessageCount
+ * - chatbot_question_sent: queryId, questionLength
+ * - chatbot_answer_received: queryId, responseTimeMs, success, responseLength, hasMetadata
+ * - chatbot_answer_error: queryId, errorType
+ * - chatbot_rating_sent: queryId, rating
+ * - chatbot_login_prompt_shown: (common fields only)
  */
 export interface QABotAnalyticsEvent {
     type: QABotAnalyticsEventType;
     timestamp: number;
     sessionId?: string;
+    pageUrl?: string;
+    isEmbedded?: boolean;
     queryId?: string;
     questionLength?: number;
     responseTimeMs?: number;

package/dist/types/contexts/AnalyticsContext.d.ts

@@ -1,11 +1,19 @@
 import React from 'react';
 import type { QABotAnalyticsEvent } from '../config';
+/**
+ * Event type without auto-populated fields.
+ * Call sites provide event-specific data; common fields are added by the enriched tracker.
+ */
+export type AnalyticsEventInput = Omit<QABotAnalyticsEvent, 'timestamp' | 'sessionId' | 'pageUrl' | 'isEmbedded'>;
 interface AnalyticsContextValue {
-    trackEvent: (event: Omit<QABotAnalyticsEvent, 'timestamp'>) => void;
+    trackEvent: (event: AnalyticsEventInput) => void;
 }
 interface AnalyticsProviderProps {
-    onAnalyticsEvent?: (event: QABotAnalyticsEvent) => void;
-    getSessionId: () => string | null;
+    /**
+     * Pre-enriched track function that adds common fields (timestamp, sessionId, pageUrl, isEmbedded).
+     * Created by QABot and passed down to ensure consistent enrichment across all call sites.
+     */
+    trackEvent: (event: AnalyticsEventInput) => void;
     children: React.ReactNode;
 }
 export declare const AnalyticsProvider: React.FC<AnalyticsProviderProps>;

package/dist/types/utils/flows/qa-flow.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-import type { QABotAnalyticsEvent } from '../../config';
+import type { AnalyticsEventInput } from '../../contexts/AnalyticsContext';
 /**
  * Configuration for creating a Q&A flow
  */
@@ -22,14 +22,14 @@ export interface CreateQAFlowParams {
     loginUrl?: string;
     /** The acting user's identifier (optional) */
     actingUser?: string;
-    /** Callback for analytics events (optional) */
-    onAnalyticsEvent?: (event: QABotAnalyticsEvent) => void;
+    /** Enriched analytics tracker (adds common fields automatically) */
+    trackEvent?: (event: AnalyticsEventInput) => void;
 }
 /**
  * Creates the basic Q&A conversation flow
  * Handles questions, responses, and optional ratings
  */
-export declare const createQAFlow: ({ endpoint, ratingEndpoint, apiKey, sessionId: getSessionId, isResetting, isLoggedIn, allowAnonAccess, loginUrl, actingUser, onAnalyticsEvent }: CreateQAFlowParams) => {
+export declare const createQAFlow: ({ endpoint, ratingEndpoint, apiKey, sessionId: getSessionId, isResetting, isLoggedIn, allowAnonAccess, loginUrl, actingUser, trackEvent }: CreateQAFlowParams) => {
     qa_loop: {
         message: string;
         component: React.JSX.Element;

package/dist/types/utils/logger.d.ts

@@ -7,7 +7,7 @@
  * Usage for consumers:
  *   localStorage.setItem('QA_BOT_DEBUG', 'true');  // Enable debug logs + version
  */
-export declare const LIB_VERSION = "0.2.11";
+export declare const LIB_VERSION = "0.2.13";
 export declare const logger: {
     version: () => void;
     session: (action: string, ...args: unknown[]) => void;

package/dist/types/utils/session-utils.d.ts

@@ -43,12 +43,12 @@ export declare const getAllSessions: () => Array<{
 export declare const getSessionMessages: (sessionId: string) => StoredMessage[];
 /**
  * Get the message count for a session.
- * Used for analytics (qa_bot_closed, qa_new_chat_started events).
+ * Used for analytics (chatbot_close, chatbot_new_chat events).
  */
 export declare const getSessionMessageCount: (sessionId: string) => number;
 /**
  * Compute how long a session has been active (in milliseconds).
  * Calculates the difference between now and the session's startedAt timestamp.
- * Used for analytics (qa_bot_closed event).
+ * Used for analytics (chatbot_close event).
  */
 export declare const computeSessionDurationMs: (sessionId: string) => number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@snf/qa-bot-core",
-  "version": "0.2.11",
+  "version": "0.2.13",
   "description": "A configurable chatbot setup for quick integration of RAG-powered Q&A and rating system",
   "main": "./dist/qa-bot-core.umd.cjs",
   "module": "./dist/qa-bot-core.js",