@tracelog/lib 2.0.3 → 2.1.0

package/dist/public-api.d.mts

@@ -477,6 +477,24 @@ declare enum DeviceType {
     /** Unable to determine device type */
     Unknown = "unknown"
 }
+/**
+ * Comprehensive device and environment information
+ *
+ * **Purpose**: Provides rich device context for analytics segmentation,
+ * debugging, and user experience optimization.
+ *
+ * **Detection**: Uses navigator.userAgentData (modern) with UA string fallback.
+ *
+ * @see src/utils/browser/device-detector.utils.ts for detection implementation
+ */
+interface DeviceInfo {
+    /** Device form factor classification */
+    type: DeviceType;
+    /** OS name: "Windows", "macOS", "iOS", "Android", "Linux", "ChromeOS", "Unknown" */
+    os: string;
+    /** Browser name: "Chrome", "Firefox", "Safari", "Edge", "Opera", "Unknown" */
+    browser: string;
+}
 
 /**
  * Event queue structure sent to backend.
@@ -489,7 +507,7 @@ interface EventsQueue {
     /** Current session identifier (UUID) */
     session_id: string;
     /** Device information (type, OS, browser) */
-    device: DeviceType;
+    device: DeviceInfo;
     /** Array of events to send */
     events: EventData[];
     /** Optional metadata attached to all events in this batch */
@@ -568,13 +586,10 @@ declare class PermanentError extends Error {
     constructor(message: string, statusCode?: number | undefined);
 }
 
-/**
- * Log levels for the dual logging system
- */
-type LogLevel = 'CLIENT_ERROR' | 'CLIENT_WARN' | 'INFO' | 'ERROR' | 'WARN' | 'DEBUG' | 'VERBOSE';
-
 /**
  * App modes for the TraceLog Library
+ *
+ * - QA: Quality Assurance mode - logs custom events to console for verification
  */
 declare enum Mode {
     QA = "qa"
@@ -654,6 +669,7 @@ declare const isPrimaryScrollEvent: (event: EventData) => event is PrimaryScroll
 declare const isSecondaryScrollEvent: (event: EventData) => event is SecondaryScrollEvent;
 
 interface State {
+    /** QA mode flag - when true, custom events are logged to console */
     mode?: Mode;
     /**
      * Collection of API URLs for different integrations.
@@ -667,7 +683,7 @@ interface State {
     config: Config;
     sessionId: string | null;
     userId: string;
-    device: DeviceType;
+    device: DeviceInfo;
     pageUrl: string;
     hasStartSession: boolean;
     suppressNextScroll: boolean;
@@ -1306,7 +1322,7 @@ declare class EventManager extends StateManager {
      *
      * @see src/managers/README.md (lines 5-75) for detailed tracking logic
      */
-    track({ type, page_url, from_page_url, scroll_data, click_data, custom_event, web_vitals, error_data, viewport_data, }: Partial<EventData>): void;
+    track({ type, page_url, from_page_url, scroll_data, click_data, custom_event, web_vitals, error_data, viewport_data, page_view, }: Partial<EventData>): void;
     /**
      * Stops event tracking and clears all queues and buffers.
      *
@@ -2429,4 +2445,4 @@ declare const tracelog: {
     mergeGlobalMetadata: (metadata: Record<string, MetadataType>) => void;
 };
 
-export { AppConfigValidationError, type BeforeBatchTransformer, type BeforeSendTransformer, type ClickCoordinates, type ClickData, type ClickTrackingElementData, type Config, type CustomEventData, DEFAULT_SESSION_TIMEOUT, DEFAULT_WEB_VITALS_MODE, DeviceType, type EmitterCallback, EmitterEvent, type EmitterMap, type ErrorData, ErrorType, type EventData, EventType, type EventTypeName, type EventsQueue, InitializationTimeoutError, IntegrationValidationError, type LogLevel, MAX_ARRAY_LENGTH, MAX_CUSTOM_EVENT_ARRAY_SIZE, MAX_CUSTOM_EVENT_KEYS, MAX_CUSTOM_EVENT_NAME_LENGTH, MAX_CUSTOM_EVENT_STRING_SIZE, MAX_METADATA_NESTING_DEPTH, MAX_NESTED_OBJECT_KEYS, MAX_STRING_LENGTH, MAX_STRING_LENGTH_IN_ARRAY, type MetadataType, Mode, PII_PATTERNS, type PageViewData, PermanentError, type PersistedEventsQueue, type PrimaryScrollEvent, SamplingRateValidationError, type ScrollData, ScrollDirection, type SecondaryScrollEvent, type SessionEventCounts, SessionTimeoutValidationError, SpecialApiUrl, type State, type TraceLogTestBridge, TraceLogValidationError, type TransformerHook, type TransformerMap, type UTM, type ViewportConfig, type ViewportElement, type ViewportEventData, WEB_VITALS_GOOD_THRESHOLDS, WEB_VITALS_NEEDS_IMPROVEMENT_THRESHOLDS, WEB_VITALS_POOR_THRESHOLDS, type WebVitalType, type WebVitalsData, type WebVitalsMode, getWebVitalsThresholds, isPrimaryScrollEvent, isSecondaryScrollEvent, tracelog };
+export { AppConfigValidationError, type BeforeBatchTransformer, type BeforeSendTransformer, type ClickCoordinates, type ClickData, type ClickTrackingElementData, type Config, type CustomEventData, DEFAULT_SESSION_TIMEOUT, DEFAULT_WEB_VITALS_MODE, type DeviceInfo, DeviceType, type EmitterCallback, EmitterEvent, type EmitterMap, type ErrorData, ErrorType, type EventData, EventType, type EventTypeName, type EventsQueue, InitializationTimeoutError, IntegrationValidationError, MAX_ARRAY_LENGTH, MAX_CUSTOM_EVENT_ARRAY_SIZE, MAX_CUSTOM_EVENT_KEYS, MAX_CUSTOM_EVENT_NAME_LENGTH, MAX_CUSTOM_EVENT_STRING_SIZE, MAX_METADATA_NESTING_DEPTH, MAX_NESTED_OBJECT_KEYS, MAX_STRING_LENGTH, MAX_STRING_LENGTH_IN_ARRAY, type MetadataType, Mode, PII_PATTERNS, type PageViewData, PermanentError, type PersistedEventsQueue, type PrimaryScrollEvent, SamplingRateValidationError, type ScrollData, ScrollDirection, type SecondaryScrollEvent, type SessionEventCounts, SessionTimeoutValidationError, SpecialApiUrl, type State, type TraceLogTestBridge, TraceLogValidationError, type TransformerHook, type TransformerMap, type UTM, type ViewportConfig, type ViewportElement, type ViewportEventData, WEB_VITALS_GOOD_THRESHOLDS, WEB_VITALS_NEEDS_IMPROVEMENT_THRESHOLDS, WEB_VITALS_POOR_THRESHOLDS, type WebVitalType, type WebVitalsData, type WebVitalsMode, getWebVitalsThresholds, isPrimaryScrollEvent, isSecondaryScrollEvent, tracelog };

package/dist/public-api.d.ts

@@ -477,6 +477,24 @@ declare enum DeviceType {
     /** Unable to determine device type */
     Unknown = "unknown"
 }
+/**
+ * Comprehensive device and environment information
+ *
+ * **Purpose**: Provides rich device context for analytics segmentation,
+ * debugging, and user experience optimization.
+ *
+ * **Detection**: Uses navigator.userAgentData (modern) with UA string fallback.
+ *
+ * @see src/utils/browser/device-detector.utils.ts for detection implementation
+ */
+interface DeviceInfo {
+    /** Device form factor classification */
+    type: DeviceType;
+    /** OS name: "Windows", "macOS", "iOS", "Android", "Linux", "ChromeOS", "Unknown" */
+    os: string;
+    /** Browser name: "Chrome", "Firefox", "Safari", "Edge", "Opera", "Unknown" */
+    browser: string;
+}
 
 /**
  * Event queue structure sent to backend.
@@ -489,7 +507,7 @@ interface EventsQueue {
     /** Current session identifier (UUID) */
     session_id: string;
     /** Device information (type, OS, browser) */
-    device: DeviceType;
+    device: DeviceInfo;
     /** Array of events to send */
     events: EventData[];
     /** Optional metadata attached to all events in this batch */
@@ -568,13 +586,10 @@ declare class PermanentError extends Error {
     constructor(message: string, statusCode?: number | undefined);
 }
 
-/**
- * Log levels for the dual logging system
- */
-type LogLevel = 'CLIENT_ERROR' | 'CLIENT_WARN' | 'INFO' | 'ERROR' | 'WARN' | 'DEBUG' | 'VERBOSE';
-
 /**
  * App modes for the TraceLog Library
+ *
+ * - QA: Quality Assurance mode - logs custom events to console for verification
  */
 declare enum Mode {
     QA = "qa"
@@ -654,6 +669,7 @@ declare const isPrimaryScrollEvent: (event: EventData) => event is PrimaryScroll
 declare const isSecondaryScrollEvent: (event: EventData) => event is SecondaryScrollEvent;
 
 interface State {
+    /** QA mode flag - when true, custom events are logged to console */
     mode?: Mode;
     /**
      * Collection of API URLs for different integrations.
@@ -667,7 +683,7 @@ interface State {
     config: Config;
     sessionId: string | null;
     userId: string;
-    device: DeviceType;
+    device: DeviceInfo;
     pageUrl: string;
     hasStartSession: boolean;
     suppressNextScroll: boolean;
@@ -1306,7 +1322,7 @@ declare class EventManager extends StateManager {
      *
      * @see src/managers/README.md (lines 5-75) for detailed tracking logic
      */
-    track({ type, page_url, from_page_url, scroll_data, click_data, custom_event, web_vitals, error_data, viewport_data, }: Partial<EventData>): void;
+    track({ type, page_url, from_page_url, scroll_data, click_data, custom_event, web_vitals, error_data, viewport_data, page_view, }: Partial<EventData>): void;
     /**
      * Stops event tracking and clears all queues and buffers.
      *
@@ -2429,4 +2445,4 @@ declare const tracelog: {
     mergeGlobalMetadata: (metadata: Record<string, MetadataType>) => void;
 };
 
-export { AppConfigValidationError, type BeforeBatchTransformer, type BeforeSendTransformer, type ClickCoordinates, type ClickData, type ClickTrackingElementData, type Config, type CustomEventData, DEFAULT_SESSION_TIMEOUT, DEFAULT_WEB_VITALS_MODE, DeviceType, type EmitterCallback, EmitterEvent, type EmitterMap, type ErrorData, ErrorType, type EventData, EventType, type EventTypeName, type EventsQueue, InitializationTimeoutError, IntegrationValidationError, type LogLevel, MAX_ARRAY_LENGTH, MAX_CUSTOM_EVENT_ARRAY_SIZE, MAX_CUSTOM_EVENT_KEYS, MAX_CUSTOM_EVENT_NAME_LENGTH, MAX_CUSTOM_EVENT_STRING_SIZE, MAX_METADATA_NESTING_DEPTH, MAX_NESTED_OBJECT_KEYS, MAX_STRING_LENGTH, MAX_STRING_LENGTH_IN_ARRAY, type MetadataType, Mode, PII_PATTERNS, type PageViewData, PermanentError, type PersistedEventsQueue, type PrimaryScrollEvent, SamplingRateValidationError, type ScrollData, ScrollDirection, type SecondaryScrollEvent, type SessionEventCounts, SessionTimeoutValidationError, SpecialApiUrl, type State, type TraceLogTestBridge, TraceLogValidationError, type TransformerHook, type TransformerMap, type UTM, type ViewportConfig, type ViewportElement, type ViewportEventData, WEB_VITALS_GOOD_THRESHOLDS, WEB_VITALS_NEEDS_IMPROVEMENT_THRESHOLDS, WEB_VITALS_POOR_THRESHOLDS, type WebVitalType, type WebVitalsData, type WebVitalsMode, getWebVitalsThresholds, isPrimaryScrollEvent, isSecondaryScrollEvent, tracelog };
+export { AppConfigValidationError, type BeforeBatchTransformer, type BeforeSendTransformer, type ClickCoordinates, type ClickData, type ClickTrackingElementData, type Config, type CustomEventData, DEFAULT_SESSION_TIMEOUT, DEFAULT_WEB_VITALS_MODE, type DeviceInfo, DeviceType, type EmitterCallback, EmitterEvent, type EmitterMap, type ErrorData, ErrorType, type EventData, EventType, type EventTypeName, type EventsQueue, InitializationTimeoutError, IntegrationValidationError, MAX_ARRAY_LENGTH, MAX_CUSTOM_EVENT_ARRAY_SIZE, MAX_CUSTOM_EVENT_KEYS, MAX_CUSTOM_EVENT_NAME_LENGTH, MAX_CUSTOM_EVENT_STRING_SIZE, MAX_METADATA_NESTING_DEPTH, MAX_NESTED_OBJECT_KEYS, MAX_STRING_LENGTH, MAX_STRING_LENGTH_IN_ARRAY, type MetadataType, Mode, PII_PATTERNS, type PageViewData, PermanentError, type PersistedEventsQueue, type PrimaryScrollEvent, SamplingRateValidationError, type ScrollData, ScrollDirection, type SecondaryScrollEvent, type SessionEventCounts, SessionTimeoutValidationError, SpecialApiUrl, type State, type TraceLogTestBridge, TraceLogValidationError, type TransformerHook, type TransformerMap, type UTM, type ViewportConfig, type ViewportElement, type ViewportEventData, WEB_VITALS_GOOD_THRESHOLDS, WEB_VITALS_NEEDS_IMPROVEMENT_THRESHOLDS, WEB_VITALS_POOR_THRESHOLDS, type WebVitalType, type WebVitalsData, type WebVitalsMode, getWebVitalsThresholds, isPrimaryScrollEvent, isSecondaryScrollEvent, tracelog };