@tracelog/lib 2.6.2 → 2.7.0

package/dist/public-api.d.mts

@@ -527,6 +527,18 @@ interface DeviceInfo {
     browser: string;
 }
 
+/**
+ * Visitor identity data from identify() call.
+ *
+ * Sent piggyback in every batch so the backend always has the latest identity,
+ * even if earlier batches were lost.
+ */
+interface IdentifyData {
+    /** External user identifier assigned by the site owner */
+    userId: string;
+    /** Optional user attributes (name, email, plan, etc.) */
+    traits?: Record<string, string>;
+}
 /**
  * Event queue structure sent to backend.
  *
@@ -543,6 +555,8 @@ interface EventsQueue {
     events: EventData[];
     /** Optional metadata attached to all events in this batch */
     global_metadata?: Record<string, MetadataType>;
+    /** Visitor identity from identify() call — included in every batch */
+    identify?: IdentifyData;
 }
 /**
  * Extended queue structure for localStorage persistence with expiration tracking.
@@ -735,6 +749,8 @@ interface State {
     scrollEventCount?: number;
     sessionReferrer?: string;
     sessionUtm?: UTM;
+    /** Visitor identity from identify() call */
+    identity?: IdentifyData;
 }
 
 /**
@@ -2371,6 +2387,8 @@ interface TraceLogTestBridge {
         scroll: ScrollHandler | null;
         viewport: ViewportHandler | null;
     };
+    identify(userId: string, traits?: Record<string, string>): void;
+    resetIdentity(): Promise<void>;
     waitForInitialization(timeout?: number): Promise<void>;
     flushQueue(): Promise<void>;
     clearQueue(): void;
@@ -2533,6 +2551,8 @@ declare const tracelog: {
     setQaMode: (enabled: boolean) => void;
     updateGlobalMetadata: (metadata: Record<string, MetadataType>) => void;
     mergeGlobalMetadata: (metadata: Record<string, MetadataType>) => void;
+    identify: (userId: string, traits?: Record<string, string>) => void;
+    resetIdentity: () => Promise<void>;
 };
 
-export { AppConfigValidationError, type BeforeBatchTransformer, type BeforeSendTransformer, type ClickCoordinates, type ClickData, type ClickTrackingElementData, type Config, type CustomEventData, type CustomHeadersProvider, 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, type InitResult, 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_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, TimeoutError, 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, type CustomHeadersProvider, 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, type IdentifyData, type InitResult, 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_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, TimeoutError, 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

@@ -527,6 +527,18 @@ interface DeviceInfo {
     browser: string;
 }
 
+/**
+ * Visitor identity data from identify() call.
+ *
+ * Sent piggyback in every batch so the backend always has the latest identity,
+ * even if earlier batches were lost.
+ */
+interface IdentifyData {
+    /** External user identifier assigned by the site owner */
+    userId: string;
+    /** Optional user attributes (name, email, plan, etc.) */
+    traits?: Record<string, string>;
+}
 /**
  * Event queue structure sent to backend.
  *
@@ -543,6 +555,8 @@ interface EventsQueue {
     events: EventData[];
     /** Optional metadata attached to all events in this batch */
     global_metadata?: Record<string, MetadataType>;
+    /** Visitor identity from identify() call — included in every batch */
+    identify?: IdentifyData;
 }
 /**
  * Extended queue structure for localStorage persistence with expiration tracking.
@@ -735,6 +749,8 @@ interface State {
     scrollEventCount?: number;
     sessionReferrer?: string;
     sessionUtm?: UTM;
+    /** Visitor identity from identify() call */
+    identity?: IdentifyData;
 }
 
 /**
@@ -2371,6 +2387,8 @@ interface TraceLogTestBridge {
         scroll: ScrollHandler | null;
         viewport: ViewportHandler | null;
     };
+    identify(userId: string, traits?: Record<string, string>): void;
+    resetIdentity(): Promise<void>;
     waitForInitialization(timeout?: number): Promise<void>;
     flushQueue(): Promise<void>;
     clearQueue(): void;
@@ -2533,6 +2551,8 @@ declare const tracelog: {
     setQaMode: (enabled: boolean) => void;
     updateGlobalMetadata: (metadata: Record<string, MetadataType>) => void;
     mergeGlobalMetadata: (metadata: Record<string, MetadataType>) => void;
+    identify: (userId: string, traits?: Record<string, string>) => void;
+    resetIdentity: () => Promise<void>;
 };
 
-export { AppConfigValidationError, type BeforeBatchTransformer, type BeforeSendTransformer, type ClickCoordinates, type ClickData, type ClickTrackingElementData, type Config, type CustomEventData, type CustomHeadersProvider, 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, type InitResult, 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_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, TimeoutError, 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, type CustomHeadersProvider, 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, type IdentifyData, type InitResult, 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_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, TimeoutError, 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 };