@tracelog/lib 2.2.1 → 2.3.0

package/dist/public-api.d.mts

@@ -62,6 +62,21 @@ type MetadataNestedObject = Record<string, MetadataNestedValue>;
  * ```
  */
 type MetadataType = MetadataPrimitive | string[] | MetadataNestedObject | MetadataNestedObject[];
+/**
+ * Result returned by tracelog.init()
+ *
+ * Contains the session identifier generated during initialization.
+ * The sessionId is empty string in edge cases (SSR, disabled, race condition).
+ *
+ * @example
+ * ```typescript
+ * const { sessionId } = await tracelog.init();
+ * console.log('Session started:', sessionId);
+ * ```
+ */
+interface InitResult {
+    sessionId: string;
+}
 
 /**
  * Element configuration for viewport tracking with optional identifiers
@@ -2287,7 +2302,7 @@ type CustomHeadersProvider = () => Record<string, string>;
  */
 interface TraceLogTestBridge {
     readonly initialized: boolean;
-    init(config?: Config): Promise<void>;
+    init(config?: Config): Promise<InitResult>;
     destroy(force?: boolean): void;
     sendCustomEvent(name: string, data?: Record<string, unknown> | Record<string, unknown>[]): void;
     event(name: string, metadata?: Record<string, unknown> | Record<string, unknown>[]): void;
@@ -2474,7 +2489,7 @@ declare const DEFAULT_WEB_VITALS_MODE: WebVitalsMode;
 declare const getWebVitalsThresholds: (mode?: WebVitalsMode) => Record<WebVitalType, number>;
 
 declare const tracelog: {
-    init: (config?: Config) => Promise<void>;
+    init: (config?: Config) => Promise<InitResult>;
     event: (name: string, metadata?: Record<string, MetadataType> | Record<string, MetadataType>[]) => void;
     on: <K extends keyof EmitterMap>(event: K, callback: EmitterCallback<EmitterMap[K]>) => void;
     off: <K extends keyof EmitterMap>(event: K, callback: EmitterCallback<EmitterMap[K]>) => void;
@@ -2483,10 +2498,11 @@ declare const tracelog: {
     setCustomHeaders: (provider: CustomHeadersProvider) => void;
     removeCustomHeaders: () => void;
     isInitialized: () => boolean;
+    getSessionId: () => string | null;
     destroy: () => void;
     setQaMode: (enabled: boolean) => void;
     updateGlobalMetadata: (metadata: Record<string, MetadataType>) => void;
     mergeGlobalMetadata: (metadata: Record<string, MetadataType>) => 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, 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, 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 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, 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

@@ -62,6 +62,21 @@ type MetadataNestedObject = Record<string, MetadataNestedValue>;
  * ```
  */
 type MetadataType = MetadataPrimitive | string[] | MetadataNestedObject | MetadataNestedObject[];
+/**
+ * Result returned by tracelog.init()
+ *
+ * Contains the session identifier generated during initialization.
+ * The sessionId is empty string in edge cases (SSR, disabled, race condition).
+ *
+ * @example
+ * ```typescript
+ * const { sessionId } = await tracelog.init();
+ * console.log('Session started:', sessionId);
+ * ```
+ */
+interface InitResult {
+    sessionId: string;
+}
 
 /**
  * Element configuration for viewport tracking with optional identifiers
@@ -2287,7 +2302,7 @@ type CustomHeadersProvider = () => Record<string, string>;
  */
 interface TraceLogTestBridge {
     readonly initialized: boolean;
-    init(config?: Config): Promise<void>;
+    init(config?: Config): Promise<InitResult>;
     destroy(force?: boolean): void;
     sendCustomEvent(name: string, data?: Record<string, unknown> | Record<string, unknown>[]): void;
     event(name: string, metadata?: Record<string, unknown> | Record<string, unknown>[]): void;
@@ -2474,7 +2489,7 @@ declare const DEFAULT_WEB_VITALS_MODE: WebVitalsMode;
 declare const getWebVitalsThresholds: (mode?: WebVitalsMode) => Record<WebVitalType, number>;
 
 declare const tracelog: {
-    init: (config?: Config) => Promise<void>;
+    init: (config?: Config) => Promise<InitResult>;
     event: (name: string, metadata?: Record<string, MetadataType> | Record<string, MetadataType>[]) => void;
     on: <K extends keyof EmitterMap>(event: K, callback: EmitterCallback<EmitterMap[K]>) => void;
     off: <K extends keyof EmitterMap>(event: K, callback: EmitterCallback<EmitterMap[K]>) => void;
@@ -2483,10 +2498,11 @@ declare const tracelog: {
     setCustomHeaders: (provider: CustomHeadersProvider) => void;
     removeCustomHeaders: () => void;
     isInitialized: () => boolean;
+    getSessionId: () => string | null;
     destroy: () => void;
     setQaMode: (enabled: boolean) => void;
     updateGlobalMetadata: (metadata: Record<string, MetadataType>) => void;
     mergeGlobalMetadata: (metadata: Record<string, MetadataType>) => 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, 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, 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 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, 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.js

@@ -555,7 +555,7 @@ var LONG_TASK_THROTTLE_MS = 1e3;
 var MAX_NAVIGATION_HISTORY = 50;
 
 // package.json
-var version = "2.2.0";
+var version = "2.2.1";
 
 // src/constants/version.constants.ts
 var LIB_VERSION = version;
@@ -846,7 +846,6 @@ var sanitizeString = (value) => {
       }
     });
   }
-  sanitized = sanitized.replaceAll("&", "&amp;").replaceAll("<", "&lt;").replaceAll(">", "&gt;").replaceAll('"', "&quot;").replaceAll("'", "&#x27;").replaceAll("/", "&#x2F;");
   const result = sanitized.trim();
   return result;
 };
@@ -6120,7 +6119,7 @@ var App = class extends StateManager {
    */
   async init(config = {}) {
     if (this.isInitialized) {
-      return;
+      return { sessionId: this.get("sessionId") ?? "" };
     }
     this.managers.storage = new StorageManager();
     try {
@@ -6138,6 +6137,7 @@ var App = class extends StateManager {
         log("warn", "Failed to recover persisted events", { error });
       });
       this.isInitialized = true;
+      return { sessionId: this.get("sessionId") ?? "" };
     } catch (error) {
       this.destroy(true);
       const errorMessage = error instanceof Error ? error.message : String(error);
@@ -6297,6 +6297,15 @@ var App = class extends StateManager {
   getEventManager() {
     return this.managers.event;
   }
+  /**
+   * Returns the current session ID.
+   *
+   * @returns The session ID string, or null if not yet initialized
+   * @internal Used by api.getSessionId()
+   */
+  getSessionId() {
+    return this.get("sessionId");
+  }
   /**
    * Validates metadata object structure and values.
    *
@@ -6409,17 +6418,17 @@ var isInitializing = false;
 var isDestroying = false;
 var init = async (config) => {
   if (typeof window === "undefined" || typeof document === "undefined") {
-    return;
+    return { sessionId: "" };
   }
   isDestroying = false;
   if (window.__traceLogDisabled === true) {
-    return;
+    return { sessionId: "" };
   }
   if (app) {
-    return;
+    return { sessionId: app.getSessionId() ?? "" };
   }
   if (isInitializing) {
-    return;
+    return { sessionId: "" };
   }
   isInitializing = true;
   try {
@@ -6448,8 +6457,9 @@ var init = async (config) => {
           reject(new Error(`[TraceLog] Initialization timeout after ${INITIALIZATION_TIMEOUT_MS}ms`));
         }, INITIALIZATION_TIMEOUT_MS);
       });
-      await Promise.race([initPromise, timeoutPromise]);
+      const result = await Promise.race([initPromise, timeoutPromise]);
       app = instance;
+      return result;
     } catch (error) {
       try {
         instance.destroy(true);
@@ -6575,6 +6585,15 @@ var isInitialized = () => {
   }
   return app !== null;
 };
+var getSessionId = () => {
+  if (typeof window === "undefined" || typeof document === "undefined") {
+    return null;
+  }
+  if (!app) {
+    return null;
+  }
+  return app.getSessionId();
+};
 var destroy = () => {
   if (typeof window === "undefined" || typeof document === "undefined") {
     return;
@@ -6648,6 +6667,7 @@ var tracelog = {
   setCustomHeaders,
   removeCustomHeaders,
   isInitialized,
+  getSessionId,
   destroy,
   setQaMode: setQaMode2,
   updateGlobalMetadata,