@workleap/mixpanel 2.0.2 → 2.1.1

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @workleap/mixpanel
 
+## 2.1.1
+
+### Patch Changes
+
+- [#54](https://github.com/workleap/wl-telemetry/pull/54) [`79ce028`](https://github.com/workleap/wl-telemetry/commit/79ce028f2418cc43ed18017e82ce9599e97d0e40) Thanks [@patricklafrance](https://github.com/patricklafrance)! - Added support for line change segments to the LogRocket logger.
+
+- Updated dependencies [[`79ce028`](https://github.com/workleap/wl-telemetry/commit/79ce028f2418cc43ed18017e82ce9599e97d0e40)]:
+  - @workleap/telemetry@1.1.1
+
+## 2.1.0
+
+### Minor Changes
+
+- [#52](https://github.com/workleap/wl-telemetry/pull/52) [`4affd67`](https://github.com/workleap/wl-telemetry/commit/4affd670d7c5c0495eb41a700e6fe9af1f9f4e0f) Thanks [@patricklafrance](https://github.com/patricklafrance)! - Added a `loggers` option and removed the peerDependency to `@workleap/telemetry`.
+
+### Patch Changes
+
+- Updated dependencies [[`4affd67`](https://github.com/workleap/wl-telemetry/commit/4affd670d7c5c0495eb41a700e6fe9af1f9f4e0f)]:
+  - @workleap/telemetry@1.1.0
+
 ## 2.0.2
 
 ### Patch Changes

package/dist/js/context.d.ts

@@ -1,10 +1,11 @@
+import type { Logger } from "@workleap/logging";
 import type { SuperProperties } from "./properties.ts";
-export declare const ContextVariableName = "__WLP_MIXPANEL_CONTEXT__";
+export declare const MixpanelContextVariableName = "__WLP_MIXPANEL_CONTEXT__";
 export interface MixpanelContext {
     productId: string;
     endpoint: string;
     superProperties: SuperProperties;
-    verbose: boolean;
+    logger: Logger;
 }
 export declare function setMixpanelContext(context: MixpanelContext): void;
 export declare function getMixpanelContext(): MixpanelContext;

package/dist/js/context.js

@@ -1,6 +1,6 @@
 
 ;// CONCATENATED MODULE: ./src/js/context.ts
-const ContextVariableName = "__WLP_MIXPANEL_CONTEXT__";
+const MixpanelContextVariableName = "__WLP_MIXPANEL_CONTEXT__";
 function setMixpanelContext(context) {
     // Will be used by the "track" function.
     // It's important to share the context with a global DOM object rather than
@@ -8,18 +8,18 @@ function setMixpanelContext(context) {
     // of this package than the host application.
     // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore
-    globalThis[ContextVariableName] = context;
+    globalThis[MixpanelContextVariableName] = context;
 }
 function getMixpanelContext() {
     // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore
-    const context = globalThis[ContextVariableName];
+    const context = globalThis[MixpanelContextVariableName];
     if (!context) {
         throw new Error("[mixpanel] The Mixpanel context is not available. Did you initialize Mixpanel with the \"initializeMixpanel\" function?");
     }
     return context;
 }
 
-export { ContextVariableName, getMixpanelContext, setMixpanelContext };
+export { MixpanelContextVariableName, getMixpanelContext, setMixpanelContext };
 
 //# sourceMappingURL=context.js.map

package/dist/js/context.js.map

@@ -1 +1 @@
-{"version":3,"file":"js/context.js","sources":["webpack://@workleap/mixpanel/./src/js/context.ts"],"sourcesContent":["import type { SuperProperties } from \"./properties.ts\";\n\nexport const ContextVariableName = \"__WLP_MIXPANEL_CONTEXT__\";\n\nexport interface MixpanelContext {\n    productId: string;\n    endpoint: string;\n    superProperties: SuperProperties;\n    verbose: boolean;\n}\n\nexport function setMixpanelContext(context: MixpanelContext) {\n    // Will be used by the \"track\" function.\n    // It's important to share the context with a global DOM object rather than\n    // a singleton because projects like the platform widgets will use a distinct instance\n    // of this package than the host application.\n    // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n    // @ts-ignore\n    globalThis[ContextVariableName] = context;\n}\n\nexport function getMixpanelContext() {\n    // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n    // @ts-ignore\n    const context = globalThis[ContextVariableName] as MixpanelContext;\n\n    if (!context) {\n        throw new Error(\"[mixpanel] The Mixpanel context is not available. Did you initialize Mixpanel with the \\\"initializeMixpanel\\\" function?\");\n    }\n\n    return context;\n}\n\n\n"],"names":["ContextVariableName","setMixpanelContext","context","globalThis","getMixpanelContext","Error"],"mappings":";;AAEO,MAAMA,sBAAsB,2BAA2B;AASvD,SAASC,mBAAmBC,OAAwB;IACvD,wCAAwC;IACxC,2EAA2E;IAC3E,sFAAsF;IACtF,6CAA6C;IAC7C,6DAA6D;IAC7D,aAAa;IACbC,UAAU,CAACH,oBAAoB,GAAGE;AACtC;AAEO,SAASE;IACZ,6DAA6D;IAC7D,aAAa;IACb,MAAMF,UAAUC,UAAU,CAACH,oBAAoB;IAE/C,IAAI,CAACE,SAAS;QACV,MAAM,IAAIG,MAAM;IACpB;IAEA,OAAOH;AACX"}
+{"version":3,"file":"js/context.js","sources":["webpack://@workleap/mixpanel/./src/js/context.ts"],"sourcesContent":["import type { Logger } from \"@workleap/logging\";\nimport type { SuperProperties } from \"./properties.ts\";\n\nexport const MixpanelContextVariableName = \"__WLP_MIXPANEL_CONTEXT__\";\n\nexport interface MixpanelContext {\n    productId: string;\n    endpoint: string;\n    superProperties: SuperProperties;\n    logger: Logger;\n}\n\nexport function setMixpanelContext(context: MixpanelContext) {\n    // Will be used by the \"track\" function.\n    // It's important to share the context with a global DOM object rather than\n    // a singleton because projects like the platform widgets will use a distinct instance\n    // of this package than the host application.\n    // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n    // @ts-ignore\n    globalThis[MixpanelContextVariableName] = context;\n}\n\nexport function getMixpanelContext() {\n    // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n    // @ts-ignore\n    const context = globalThis[MixpanelContextVariableName] as MixpanelContext;\n\n    if (!context) {\n        throw new Error(\"[mixpanel] The Mixpanel context is not available. Did you initialize Mixpanel with the \\\"initializeMixpanel\\\" function?\");\n    }\n\n    return context;\n}\n\n\n"],"names":["MixpanelContextVariableName","setMixpanelContext","context","globalThis","getMixpanelContext","Error"],"mappings":";;AAGO,MAAMA,8BAA8B,2BAA2B;AAS/D,SAASC,mBAAmBC,OAAwB;IACvD,wCAAwC;IACxC,2EAA2E;IAC3E,sFAAsF;IACtF,6CAA6C;IAC7C,6DAA6D;IAC7D,aAAa;IACbC,UAAU,CAACH,4BAA4B,GAAGE;AAC9C;AAEO,SAASE;IACZ,6DAA6D;IAC7D,aAAa;IACb,MAAMF,UAAUC,UAAU,CAACH,4BAA4B;IAEvD,IAAI,CAACE,SAAS;QACV,MAAM,IAAIG,MAAM;IACpB;IAEA,OAAOH;AACX"}

package/dist/js/createTrackingFunction.d.ts

@@ -1,6 +1,6 @@
 import { type MixpanelEventProperties } from "./properties.ts";
 /**
- * @see https://workleap.github.io/wl-telemetry
+ * @see {@link https://workleap.github.io/wl-telemetry}
  */
 export interface CreateTrackingFunctionOptions {
     /**
@@ -9,7 +9,7 @@ export interface CreateTrackingFunctionOptions {
     targetProductId?: string;
 }
 /**
- * @see https://workleap.github.io/wl-telemetry
+ * @see {@link https://workleap.github.io/wl-telemetry}
  */
 export interface TrackingFunctionOptions {
     /**
@@ -29,7 +29,10 @@ export interface TrackingFunctionOptions {
  * @param eventName The name of the event to track.
  * @param properties The properties to send with the event.
  * @param options Options for tracking the event.
- * @see https://workleap.github.io/wl-telemetry
+ * @see {@link https://workleap.github.io/wl-telemetry}
  */
 export type TrackingFunction = (eventName: string, properties: MixpanelEventProperties, options?: TrackingFunctionOptions) => Promise<void>;
+/**
+ * @see {@link https://workleap.github.io/wl-telemetry}
+ */
 export declare function createTrackingFunction(options?: CreateTrackingFunctionOptions): TrackingFunction;

package/dist/js/createTrackingFunction.js

@@ -8,9 +8,11 @@ import { getBaseProperties } from "./properties.js";
 ;// CONCATENATED MODULE: ./src/js/createTrackingFunction.ts
 
 
-function createTrackingFunction(options = {}) {
+/**
+ * @see {@link https://workleap.github.io/wl-telemetry}
+ */ function createTrackingFunction(options = {}) {
     const { targetProductId } = options;
-    const { productId, endpoint, superProperties } = getMixpanelContext();
+    const { productId, endpoint, superProperties, logger } = getMixpanelContext();
     const trackFunction = async (eventName, properties, _options = {})=>{
         try {
             const { keepAlive = false } = _options;
@@ -36,9 +38,8 @@ function createTrackingFunction(options = {}) {
                     properties: allProperties
                 })
             });
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
         } catch (error) {
-        // Do nothing...
+            logger.withText(`[mixpanel] An error occurred while sending a tracking event to "${endpoint}":`).withError(error).error();
         }
     };
     return trackFunction;

package/dist/js/createTrackingFunction.js.map

@@ -1 +1 @@
-{"version":3,"file":"js/createTrackingFunction.js","sources":["webpack://@workleap/mixpanel/./src/js/createTrackingFunction.ts"],"sourcesContent":["import { getMixpanelContext } from \"./context.ts\";\nimport { getBaseProperties, type MixpanelEventProperties } from \"./properties.ts\";\n\n/**\n * @see https://workleap.github.io/wl-telemetry\n */\nexport interface CreateTrackingFunctionOptions {\n    /**\n     * The product identifier of the target product.\n     */\n    targetProductId?: string;\n}\n\n/**\n * @see https://workleap.github.io/wl-telemetry\n */\nexport interface TrackingFunctionOptions {\n    /**\n   * Whether to keep the connection alive for the tracking request.\n   * It is mostly used for tracking links where the user might navigate away before the request is completed.\n   *\n   * Caution! The body size for keepalive requests is limited to 64 kibibytes.\n   *\n   * https://developer.mozilla.org/en-US/docs/Web/API/RequestInit#keepalive\n   *\n   * @default false\n   */\n    keepAlive?: boolean;\n}\n\n/**\n * A function that sends tracking events to the tracking API.\n * @param eventName The name of the event to track.\n * @param properties The properties to send with the event.\n * @param options Options for tracking the event.\n * @see https://workleap.github.io/wl-telemetry\n */\nexport type TrackingFunction = (eventName: string, properties: MixpanelEventProperties, options?: TrackingFunctionOptions) => Promise<void>;\n\nexport function createTrackingFunction(options: CreateTrackingFunctionOptions = {}) {\n    const {\n        targetProductId\n    } = options;\n\n    const {\n        productId,\n        endpoint,\n        superProperties\n    } = getMixpanelContext();\n\n    const trackFunction: TrackingFunction = async (eventName, properties, _options = {}) => {\n        try {\n            const {\n                keepAlive = false\n            } = _options;\n\n            const baseProperties = getBaseProperties();\n\n            const allProperties = {\n                ...baseProperties,\n                ...Object.fromEntries(superProperties),\n                ...properties\n            };\n\n            await fetch(endpoint, {\n                method: \"POST\",\n                credentials: \"include\",\n                keepalive: keepAlive,\n                headers: { \"Content-Type\": \"application/json\" },\n                body: JSON.stringify({\n                    eventName,\n                    productIdentifier: productId,\n                    // Not sure why, but it seems important to send \"null\" if not target product identifier\n                    // are provided.\n                    targetProductIdentifier : targetProductId ?? null,\n                    properties: allProperties\n                })\n            });\n        // eslint-disable-next-line @typescript-eslint/no-unused-vars\n        } catch (error: unknown) {\n            // Do nothing...\n        }\n    };\n\n    return trackFunction;\n}\n"],"names":["getMixpanelContext","getBaseProperties","createTrackingFunction","options","targetProductId","productId","endpoint","superProperties","trackFunction","eventName","properties","_options","keepAlive","baseProperties","allProperties","Object","fetch","JSON","error"],"mappings":";;;;;;;;AAAkD;AACgC;AAsC3E,SAASE,uBAAuBC,UAAyC,CAAC,CAAC;IAC9E,MAAM,EACFC,eAAe,EAClB,GAAGD;IAEJ,MAAM,EACFE,SAAS,EACTC,QAAQ,EACRC,eAAe,EAClB,GAAGP,kBAAkBA;IAEtB,MAAMQ,gBAAkC,OAAOC,WAAWC,YAAYC,WAAW,CAAC,CAAC;QAC/E,IAAI;YACA,MAAM,EACFC,YAAY,KAAK,EACpB,GAAGD;YAEJ,MAAME,iBAAiBZ,iBAAiBA;YAExC,MAAMa,gBAAgB;gBAClB,GAAGD,cAAc;gBACjB,GAAGE,OAAO,WAAW,CAACR,gBAAgB;gBACtC,GAAGG,UAAU;YACjB;YAEA,MAAMM,MAAMV,UAAU;gBAClB,QAAQ;gBACR,aAAa;gBACb,WAAWM;gBACX,SAAS;oBAAE,gBAAgB;gBAAmB;gBAC9C,MAAMK,KAAK,SAAS,CAAC;oBACjBR;oBACA,mBAAmBJ;oBACnB,uFAAuF;oBACvF,gBAAgB;oBAChB,yBAA0BD,mBAAmB;oBAC7C,YAAYU;gBAChB;YACJ;QACJ,6DAA6D;QAC7D,EAAE,OAAOI,OAAgB;QACrB,gBAAgB;QACpB;IACJ;IAEA,OAAOV;AACX"}
+{"version":3,"file":"js/createTrackingFunction.js","sources":["webpack://@workleap/mixpanel/./src/js/createTrackingFunction.ts"],"sourcesContent":["import { getMixpanelContext } from \"./context.ts\";\nimport { getBaseProperties, type MixpanelEventProperties } from \"./properties.ts\";\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport interface CreateTrackingFunctionOptions {\n    /**\n     * The product identifier of the target product.\n     */\n    targetProductId?: string;\n}\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport interface TrackingFunctionOptions {\n    /**\n   * Whether to keep the connection alive for the tracking request.\n   * It is mostly used for tracking links where the user might navigate away before the request is completed.\n   *\n   * Caution! The body size for keepalive requests is limited to 64 kibibytes.\n   *\n   * https://developer.mozilla.org/en-US/docs/Web/API/RequestInit#keepalive\n   *\n   * @default false\n   */\n    keepAlive?: boolean;\n}\n\n/**\n * A function that sends tracking events to the tracking API.\n * @param eventName The name of the event to track.\n * @param properties The properties to send with the event.\n * @param options Options for tracking the event.\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport type TrackingFunction = (eventName: string, properties: MixpanelEventProperties, options?: TrackingFunctionOptions) => Promise<void>;\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport function createTrackingFunction(options: CreateTrackingFunctionOptions = {}) {\n    const {\n        targetProductId\n    } = options;\n\n    const {\n        productId,\n        endpoint,\n        superProperties,\n        logger\n    } = getMixpanelContext();\n\n    const trackFunction: TrackingFunction = async (eventName, properties, _options = {}) => {\n        try {\n            const {\n                keepAlive = false\n            } = _options;\n\n            const baseProperties = getBaseProperties();\n\n            const allProperties = {\n                ...baseProperties,\n                ...Object.fromEntries(superProperties),\n                ...properties\n            };\n\n            await fetch(endpoint, {\n                method: \"POST\",\n                credentials: \"include\",\n                keepalive: keepAlive,\n                headers: { \"Content-Type\": \"application/json\" },\n                body: JSON.stringify({\n                    eventName,\n                    productIdentifier: productId,\n                    // Not sure why, but it seems important to send \"null\" if not target product identifier\n                    // are provided.\n                    targetProductIdentifier : targetProductId ?? null,\n                    properties: allProperties\n                })\n            });\n        } catch (error: unknown) {\n            logger\n                .withText(`[mixpanel] An error occurred while sending a tracking event to \"${endpoint}\":`)\n                .withError(error as Error)\n                .error();\n        }\n    };\n\n    return trackFunction;\n}\n"],"names":["getMixpanelContext","getBaseProperties","createTrackingFunction","options","targetProductId","productId","endpoint","superProperties","logger","trackFunction","eventName","properties","_options","keepAlive","baseProperties","allProperties","Object","fetch","JSON","error"],"mappings":";;;;;;;;AAAkD;AACgC;AAsClF;;CAEC,GACM,SAASE,uBAAuBC,UAAyC,CAAC,CAAC;IAC9E,MAAM,EACFC,eAAe,EAClB,GAAGD;IAEJ,MAAM,EACFE,SAAS,EACTC,QAAQ,EACRC,eAAe,EACfC,MAAM,EACT,GAAGR,kBAAkBA;IAEtB,MAAMS,gBAAkC,OAAOC,WAAWC,YAAYC,WAAW,CAAC,CAAC;QAC/E,IAAI;YACA,MAAM,EACFC,YAAY,KAAK,EACpB,GAAGD;YAEJ,MAAME,iBAAiBb,iBAAiBA;YAExC,MAAMc,gBAAgB;gBAClB,GAAGD,cAAc;gBACjB,GAAGE,OAAO,WAAW,CAACT,gBAAgB;gBACtC,GAAGI,UAAU;YACjB;YAEA,MAAMM,MAAMX,UAAU;gBAClB,QAAQ;gBACR,aAAa;gBACb,WAAWO;gBACX,SAAS;oBAAE,gBAAgB;gBAAmB;gBAC9C,MAAMK,KAAK,SAAS,CAAC;oBACjBR;oBACA,mBAAmBL;oBACnB,uFAAuF;oBACvF,gBAAgB;oBAChB,yBAA0BD,mBAAmB;oBAC7C,YAAYW;gBAChB;YACJ;QACJ,EAAE,OAAOI,OAAgB;YACrBX,OACK,QAAQ,CAAC,CAAC,gEAAgE,EAAEF,SAAS,EAAE,CAAC,EACxF,SAAS,CAACa,OACV,KAAK;QACd;IACJ;IAEA,OAAOV;AACX"}

package/dist/js/initializeMixpanel.d.ts

@@ -1,15 +1,22 @@
+import { type RootLogger } from "@workleap/logging";
 import { type Environment } from "./env.ts";
 /**
- * @see https://workleap.github.io/wl-telemetry
+ * @see {@link https://workleap.github.io/wl-telemetry}
  */
 export interface InitializeMixpanelOptions {
     /**
-     * The endpoint to use for tracking events.
-     * If not provided, the default endpoint for the environment will be used.
+     * An optional tracking endpoint.
      * @default "tracking/track"
      */
     trackingEndpoint?: string;
+    /**
+     * Whether or not debug information should be logged to the console.
+     */
     verbose?: boolean;
+    /**
+     * An array of RootLogger instances.
+     */
+    loggers?: RootLogger[];
 }
 export declare function __resetInitializationGuard(): void;
 /**
@@ -18,6 +25,6 @@ export declare function __resetInitializationGuard(): void;
  * @param envOrTrackingApiBaseUrl The environment to get the navigation url from or a base URL.
  * @param options Options for creating the tracking function.
  * @returns A function that sends tracking events to the tracking API.
- * @see https://workleap.github.io/wl-telemetry
+ * @see {@link https://workleap.github.io/wl-telemetry}
  */
 export declare function initializeMixpanel(productId: string, envOrTrackingApiBaseUrl: Environment | (string & {}), options?: InitializeMixpanelOptions): void;

package/dist/js/initializeMixpanel.js

@@ -1,9 +1,12 @@
-import { getBootstrappingStore, getTelemetryContext } from "@workleap/telemetry";
+import { createCompositeLogger } from "@workleap/logging";
+import { createBootstrappingStore, createTelemetryContext } from "@workleap/telemetry";
 import { setMixpanelContext } from "./context.js";
 import { getTrackingEndpoint } from "./env.js";
 import { HasExecutedGuard } from "./HasExecutedGuard.js";
 import { OtherProperties, getSuperProperties, getTelemetryProperties, setSuperProperties, setSuperProperty } from "./properties.js";
 
+;// CONCATENATED MODULE: external "@workleap/logging"
+
 ;// CONCATENATED MODULE: external "@workleap/telemetry"
 
 ;// CONCATENATED MODULE: external "./context.js"
@@ -20,6 +23,7 @@ import { OtherProperties, getSuperProperties, getTelemetryProperties, setSuperPr
 
 
 
+
 function registerLogRocketSessionUrlListener(verbose = false) {
     // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore
@@ -48,16 +52,15 @@ function __resetInitializationGuard() {
  * @param envOrTrackingApiBaseUrl The environment to get the navigation url from or a base URL.
  * @param options Options for creating the tracking function.
  * @returns A function that sends tracking events to the tracking API.
- * @see https://workleap.github.io/wl-telemetry
+ * @see {@link https://workleap.github.io/wl-telemetry}
  */ function initializeMixpanel(productId, envOrTrackingApiBaseUrl, options = {}) {
-    const { verbose = false, trackingEndpoint } = options;
+    const { trackingEndpoint, verbose = false, loggers = [] } = options;
     initializationGuard.throw("[mixpanel] Mixpanel has already been initialized. Did you call the \"initializeMixpanel\" function twice?");
+    const logger = createCompositeLogger(verbose, loggers);
     const endpoint = getTrackingEndpoint(envOrTrackingApiBaseUrl, trackingEndpoint);
-    const telemetryContext = getTelemetryContext({
-        verbose
-    });
+    const telemetryContext = createTelemetryContext(logger);
     setSuperProperties(getTelemetryProperties(telemetryContext));
-    const bootstrappingStore = getBootstrappingStore();
+    const bootstrappingStore = createBootstrappingStore(logger);
     // If LogRocket is already available, register the listener. Otherwise, subscribe to the bootstrapping store
     // and register the listener once a notification is received that LogRocket is registered.
     if (bootstrappingStore.state.isLogRocketReady) {
@@ -74,11 +77,9 @@ function __resetInitializationGuard() {
         productId,
         endpoint,
         superProperties: getSuperProperties(),
-        verbose
+        logger
     });
-    if (verbose) {
-        console.log("[mixpanel] Mixpanel is initialized.");
-    }
+    logger.debug("[mixpanel] Mixpanel is initialized.");
 }
 
 export { __resetInitializationGuard, initializeMixpanel };

package/dist/js/initializeMixpanel.js.map

@@ -1 +1 @@
-{"version":3,"file":"js/initializeMixpanel.js","sources":["webpack://@workleap/mixpanel/./src/js/initializeMixpanel.ts"],"sourcesContent":["import { getBootstrappingStore, getTelemetryContext } from \"@workleap/telemetry\";\nimport { setMixpanelContext } from \"./context.ts\";\nimport { getTrackingEndpoint, type Environment } from \"./env.ts\";\nimport { HasExecutedGuard } from \"./HasExecutedGuard.ts\";\nimport { getSuperProperties, getTelemetryProperties, OtherProperties, setSuperProperties, setSuperProperty } from \"./properties.ts\";\n\n/**\n * @see https://workleap.github.io/wl-telemetry\n */\nexport interface InitializeMixpanelOptions {\n    /**\n     * The endpoint to use for tracking events.\n     * If not provided, the default endpoint for the environment will be used.\n     * @default \"tracking/track\"\n     */\n    trackingEndpoint?: string;\n    verbose?: boolean;\n}\nfunction registerLogRocketSessionUrlListener(verbose = false) {\n    // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n    // @ts-ignore\n    if (globalThis.__WLP_LOGROCKET_INSTRUMENTATION_REGISTER_GET_SESSION_URL_LISTENER__) {\n        // Automatically add the LogRocket session URL to all Honeycomb traces as an attribute.\n        // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n        // @ts-ignore\n        globalThis.__WLP_LOGROCKET_INSTRUMENTATION_REGISTER_GET_SESSION_URL_LISTENER__((sessionUrl: string) => {\n            if (verbose) {\n                console.log(\"[mixpanel] Received LogRocket session replay URL:\", sessionUrl);\n            }\n\n            setSuperProperty(OtherProperties.LogRocketSessionUrl, sessionUrl);\n        });\n    } else if (verbose) {\n        console.log(\"[mixpanel] Cannot integrate with LogRocket because \\\"globalThis.__WLP_LOGROCKET_INSTRUMENTATION_REGISTER_GET_SESSION_URL_LISTENER__\\\" is not available.\");\n    }\n}\n\nconst initializationGuard = new HasExecutedGuard();\n\n// This function should only be used by tests.\nexport function __resetInitializationGuard() {\n    initializationGuard.reset();\n}\n\n/**\n * Creates a function that sends tracking events to the tracking API.\n * @param productId Your product identifier.\n * @param envOrTrackingApiBaseUrl The environment to get the navigation url from or a base URL.\n * @param options Options for creating the tracking function.\n * @returns A function that sends tracking events to the tracking API.\n * @see https://workleap.github.io/wl-telemetry\n */\nexport function initializeMixpanel(productId: string, envOrTrackingApiBaseUrl: Environment | (string & {}), options: InitializeMixpanelOptions = {}) {\n    const {\n        verbose = false,\n        trackingEndpoint\n    } = options;\n\n    initializationGuard.throw(\"[mixpanel] Mixpanel has already been initialized. Did you call the \\\"initializeMixpanel\\\" function twice?\");\n\n    const endpoint = getTrackingEndpoint(envOrTrackingApiBaseUrl, trackingEndpoint);\n    const telemetryContext = getTelemetryContext({ verbose });\n\n    setSuperProperties(getTelemetryProperties(telemetryContext));\n\n    const bootstrappingStore = getBootstrappingStore();\n\n    // If LogRocket is already available, register the listener. Otherwise, subscribe to the bootstrapping store\n    // and register the listener once a notification is received that LogRocket is registered.\n    if (bootstrappingStore.state.isLogRocketReady) {\n        registerLogRocketSessionUrlListener(verbose);\n    } else {\n        bootstrappingStore.subscribe((action, store, unsubscribe) => {\n            if (store.state.isLogRocketReady) {\n                unsubscribe();\n                registerLogRocketSessionUrlListener(verbose);\n            }\n        });\n    }\n\n    setMixpanelContext({\n        productId,\n        endpoint,\n        superProperties: getSuperProperties(),\n        verbose\n    });\n\n    if (verbose) {\n        console.log(\"[mixpanel] Mixpanel is initialized.\");\n    }\n}\n"],"names":["getBootstrappingStore","getTelemetryContext","setMixpanelContext","getTrackingEndpoint","HasExecutedGuard","getSuperProperties","getTelemetryProperties","OtherProperties","setSuperProperties","setSuperProperty","registerLogRocketSessionUrlListener","verbose","globalThis","sessionUrl","console","initializationGuard","__resetInitializationGuard","initializeMixpanel","productId","envOrTrackingApiBaseUrl","options","trackingEndpoint","endpoint","telemetryContext","bootstrappingStore","action","store","unsubscribe"],"mappings":";;;;;;;;;;;;;;;;;AAAiF;AAC/B;AACe;AACR;AAC2E;AAcpI,SAASU,oCAAoCC,UAAU,KAAK;IACxD,6DAA6D;IAC7D,aAAa;IACb,IAAIC,WAAW,mEAAmE,EAAE;QAChF,uFAAuF;QACvF,6DAA6D;QAC7D,aAAa;QACbA,WAAW,mEAAmE,CAAC,CAACC;YAC5E,IAAIF,SAAS;gBACTG,QAAQ,GAAG,CAAC,qDAAqDD;YACrE;YAEAJ,gBAAgBA,CAACF,mCAAmC,EAAEM;QAC1D;IACJ,OAAO,IAAIF,SAAS;QAChBG,QAAQ,GAAG,CAAC;IAChB;AACJ;AAEA,MAAMC,sBAAsB,IAAIX,gBAAgBA;AAEhD,8CAA8C;AACvC,SAASY;IACZD,oBAAoB,KAAK;AAC7B;AAEA;;;;;;;CAOC,GACM,SAASE,mBAAmBC,SAAiB,EAAEC,uBAAoD,EAAEC,UAAqC,CAAC,CAAC;IAC/I,MAAM,EACFT,UAAU,KAAK,EACfU,gBAAgB,EACnB,GAAGD;IAEJL,oBAAoB,KAAK,CAAC;IAE1B,MAAMO,WAAWnB,mBAAmBA,CAACgB,yBAAyBE;IAC9D,MAAME,mBAAmBtB,mBAAmBA,CAAC;QAAEU;IAAQ;IAEvDH,kBAAkBA,CAACF,sBAAsBA,CAACiB;IAE1C,MAAMC,qBAAqBxB,qBAAqBA;IAEhD,4GAA4G;IAC5G,0FAA0F;IAC1F,IAAIwB,mBAAmB,KAAK,CAAC,gBAAgB,EAAE;QAC3Cd,oCAAoCC;IACxC,OAAO;QACHa,mBAAmB,SAAS,CAAC,CAACC,QAAQC,OAAOC;YACzC,IAAID,MAAM,KAAK,CAAC,gBAAgB,EAAE;gBAC9BC;gBACAjB,oCAAoCC;YACxC;QACJ;IACJ;IAEAT,kBAAkBA,CAAC;QACfgB;QACAI;QACA,iBAAiBjB,kBAAkBA;QACnCM;IACJ;IAEA,IAAIA,SAAS;QACTG,QAAQ,GAAG,CAAC;IAChB;AACJ"}
+{"version":3,"file":"js/initializeMixpanel.js","sources":["webpack://@workleap/mixpanel/./src/js/initializeMixpanel.ts"],"sourcesContent":["import { createCompositeLogger, type RootLogger } from \"@workleap/logging\";\nimport { createBootstrappingStore, createTelemetryContext } from \"@workleap/telemetry\";\nimport { setMixpanelContext } from \"./context.ts\";\nimport { getTrackingEndpoint, type Environment } from \"./env.ts\";\nimport { HasExecutedGuard } from \"./HasExecutedGuard.ts\";\nimport { getSuperProperties, getTelemetryProperties, OtherProperties, setSuperProperties, setSuperProperty } from \"./properties.ts\";\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport interface InitializeMixpanelOptions {\n    /**\n     * An optional tracking endpoint.\n     * @default \"tracking/track\"\n     */\n    trackingEndpoint?: string;\n    /**\n     * Whether or not debug information should be logged to the console.\n     */\n    verbose?: boolean;\n    /**\n     * An array of RootLogger instances.\n     */\n    loggers?: RootLogger[];\n}\n\nfunction registerLogRocketSessionUrlListener(verbose = false) {\n    // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n    // @ts-ignore\n    if (globalThis.__WLP_LOGROCKET_INSTRUMENTATION_REGISTER_GET_SESSION_URL_LISTENER__) {\n        // Automatically add the LogRocket session URL to all Honeycomb traces as an attribute.\n        // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n        // @ts-ignore\n        globalThis.__WLP_LOGROCKET_INSTRUMENTATION_REGISTER_GET_SESSION_URL_LISTENER__((sessionUrl: string) => {\n            if (verbose) {\n                console.log(\"[mixpanel] Received LogRocket session replay URL:\", sessionUrl);\n            }\n\n            setSuperProperty(OtherProperties.LogRocketSessionUrl, sessionUrl);\n        });\n    } else if (verbose) {\n        console.log(\"[mixpanel] Cannot integrate with LogRocket because \\\"globalThis.__WLP_LOGROCKET_INSTRUMENTATION_REGISTER_GET_SESSION_URL_LISTENER__\\\" is not available.\");\n    }\n}\n\nconst initializationGuard = new HasExecutedGuard();\n\n// This function should only be used by tests.\nexport function __resetInitializationGuard() {\n    initializationGuard.reset();\n}\n\n/**\n * Creates a function that sends tracking events to the tracking API.\n * @param productId Your product identifier.\n * @param envOrTrackingApiBaseUrl The environment to get the navigation url from or a base URL.\n * @param options Options for creating the tracking function.\n * @returns A function that sends tracking events to the tracking API.\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport function initializeMixpanel(productId: string, envOrTrackingApiBaseUrl: Environment | (string & {}), options: InitializeMixpanelOptions = {}) {\n    const {\n        trackingEndpoint,\n        verbose = false,\n        loggers = []\n    } = options;\n\n    initializationGuard.throw(\"[mixpanel] Mixpanel has already been initialized. Did you call the \\\"initializeMixpanel\\\" function twice?\");\n\n    const logger = createCompositeLogger(verbose, loggers);\n    const endpoint = getTrackingEndpoint(envOrTrackingApiBaseUrl, trackingEndpoint);\n    const telemetryContext = createTelemetryContext(logger);\n\n    setSuperProperties(getTelemetryProperties(telemetryContext));\n\n    const bootstrappingStore = createBootstrappingStore(logger);\n\n    // If LogRocket is already available, register the listener. Otherwise, subscribe to the bootstrapping store\n    // and register the listener once a notification is received that LogRocket is registered.\n    if (bootstrappingStore.state.isLogRocketReady) {\n        registerLogRocketSessionUrlListener(verbose);\n    } else {\n        bootstrappingStore.subscribe((action, store, unsubscribe) => {\n            if (store.state.isLogRocketReady) {\n                unsubscribe();\n                registerLogRocketSessionUrlListener(verbose);\n            }\n        });\n    }\n\n    setMixpanelContext({\n        productId,\n        endpoint,\n        superProperties: getSuperProperties(),\n        logger\n    });\n\n    logger.debug(\"[mixpanel] Mixpanel is initialized.\");\n}\n"],"names":["createCompositeLogger","createBootstrappingStore","createTelemetryContext","setMixpanelContext","getTrackingEndpoint","HasExecutedGuard","getSuperProperties","getTelemetryProperties","OtherProperties","setSuperProperties","setSuperProperty","registerLogRocketSessionUrlListener","verbose","globalThis","sessionUrl","console","initializationGuard","__resetInitializationGuard","initializeMixpanel","productId","envOrTrackingApiBaseUrl","options","trackingEndpoint","loggers","logger","endpoint","telemetryContext","bootstrappingStore","action","store","unsubscribe"],"mappings":";;;;;;;;;;;;;;;;;;;;AAA2E;AACY;AACrC;AACe;AACR;AAC2E;AAqBpI,SAASW,oCAAoCC,UAAU,KAAK;IACxD,6DAA6D;IAC7D,aAAa;IACb,IAAIC,WAAW,mEAAmE,EAAE;QAChF,uFAAuF;QACvF,6DAA6D;QAC7D,aAAa;QACbA,WAAW,mEAAmE,CAAC,CAACC;YAC5E,IAAIF,SAAS;gBACTG,QAAQ,GAAG,CAAC,qDAAqDD;YACrE;YAEAJ,gBAAgBA,CAACF,mCAAmC,EAAEM;QAC1D;IACJ,OAAO,IAAIF,SAAS;QAChBG,QAAQ,GAAG,CAAC;IAChB;AACJ;AAEA,MAAMC,sBAAsB,IAAIX,gBAAgBA;AAEhD,8CAA8C;AACvC,SAASY;IACZD,oBAAoB,KAAK;AAC7B;AAEA;;;;;;;CAOC,GACM,SAASE,mBAAmBC,SAAiB,EAAEC,uBAAoD,EAAEC,UAAqC,CAAC,CAAC;IAC/I,MAAM,EACFC,gBAAgB,EAChBV,UAAU,KAAK,EACfW,UAAU,EAAE,EACf,GAAGF;IAEJL,oBAAoB,KAAK,CAAC;IAE1B,MAAMQ,SAASxB,qBAAqBA,CAACY,SAASW;IAC9C,MAAME,WAAWrB,mBAAmBA,CAACgB,yBAAyBE;IAC9D,MAAMI,mBAAmBxB,sBAAsBA,CAACsB;IAEhDf,kBAAkBA,CAACF,sBAAsBA,CAACmB;IAE1C,MAAMC,qBAAqB1B,wBAAwBA,CAACuB;IAEpD,4GAA4G;IAC5G,0FAA0F;IAC1F,IAAIG,mBAAmB,KAAK,CAAC,gBAAgB,EAAE;QAC3ChB,oCAAoCC;IACxC,OAAO;QACHe,mBAAmB,SAAS,CAAC,CAACC,QAAQC,OAAOC;YACzC,IAAID,MAAM,KAAK,CAAC,gBAAgB,EAAE;gBAC9BC;gBACAnB,oCAAoCC;YACxC;QACJ;IACJ;IAEAT,kBAAkBA,CAAC;QACfgB;QACAM;QACA,iBAAiBnB,kBAAkBA;QACnCkB;IACJ;IAEAA,OAAO,KAAK,CAAC;AACjB"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@workleap/mixpanel",
   "author": "Workleap",
-  "version": "2.0.2",
+  "version": "2.1.1",
   "description": "A package containing utilities for Mixpanel telemetry.",
   "license": "Apache-2.0",
   "repository": {
@@ -34,8 +34,7 @@
   ],
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0",
-    "react-dom": "^18.0.0 || ^19.0.0",
-    "@workleap/telemetry": "1.0.0"
+    "react-dom": "^18.0.0 || ^19.0.0"
   },
   "peerDependenciesMeta": {
     "react": {
@@ -45,6 +44,10 @@
       "optional": true
     }
   },
+  "dependencies": {
+    "@workleap/logging": "^1.2.0",
+    "@workleap/telemetry": "1.1.1"
+  },
   "devDependencies": {
     "@rsbuild/core": "1.4.6",
     "@rslib/core": "0.10.5",

package/src/js/context.ts

@@ -1,12 +1,13 @@
+import type { Logger } from "@workleap/logging";
 import type { SuperProperties } from "./properties.ts";
 
-export const ContextVariableName = "__WLP_MIXPANEL_CONTEXT__";
+export const MixpanelContextVariableName = "__WLP_MIXPANEL_CONTEXT__";
 
 export interface MixpanelContext {
     productId: string;
     endpoint: string;
     superProperties: SuperProperties;
-    verbose: boolean;
+    logger: Logger;
 }
 
 export function setMixpanelContext(context: MixpanelContext) {
@@ -16,13 +17,13 @@ export function setMixpanelContext(context: MixpanelContext) {
     // of this package than the host application.
     // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore
-    globalThis[ContextVariableName] = context;
+    globalThis[MixpanelContextVariableName] = context;
 }
 
 export function getMixpanelContext() {
     // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore
-    const context = globalThis[ContextVariableName] as MixpanelContext;
+    const context = globalThis[MixpanelContextVariableName] as MixpanelContext;
 
     if (!context) {
         throw new Error("[mixpanel] The Mixpanel context is not available. Did you initialize Mixpanel with the \"initializeMixpanel\" function?");

package/src/js/createTrackingFunction.ts

@@ -2,7 +2,7 @@ import { getMixpanelContext } from "./context.ts";
 import { getBaseProperties, type MixpanelEventProperties } from "./properties.ts";
 
 /**
- * @see https://workleap.github.io/wl-telemetry
+ * @see {@link https://workleap.github.io/wl-telemetry}
  */
 export interface CreateTrackingFunctionOptions {
     /**
@@ -12,7 +12,7 @@ export interface CreateTrackingFunctionOptions {
 }
 
 /**
- * @see https://workleap.github.io/wl-telemetry
+ * @see {@link https://workleap.github.io/wl-telemetry}
  */
 export interface TrackingFunctionOptions {
     /**
@@ -33,10 +33,13 @@ export interface TrackingFunctionOptions {
  * @param eventName The name of the event to track.
  * @param properties The properties to send with the event.
  * @param options Options for tracking the event.
- * @see https://workleap.github.io/wl-telemetry
+ * @see {@link https://workleap.github.io/wl-telemetry}
  */
 export type TrackingFunction = (eventName: string, properties: MixpanelEventProperties, options?: TrackingFunctionOptions) => Promise<void>;
 
+/**
+ * @see {@link https://workleap.github.io/wl-telemetry}
+ */
 export function createTrackingFunction(options: CreateTrackingFunctionOptions = {}) {
     const {
         targetProductId
@@ -45,7 +48,8 @@ export function createTrackingFunction(options: CreateTrackingFunctionOptions =
     const {
         productId,
         endpoint,
-        superProperties
+        superProperties,
+        logger
     } = getMixpanelContext();
 
     const trackFunction: TrackingFunction = async (eventName, properties, _options = {}) => {
@@ -76,9 +80,11 @@ export function createTrackingFunction(options: CreateTrackingFunctionOptions =
                     properties: allProperties
                 })
             });
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
         } catch (error: unknown) {
-            // Do nothing...
+            logger
+                .withText(`[mixpanel] An error occurred while sending a tracking event to "${endpoint}":`)
+                .withError(error as Error)
+                .error();
         }
     };
 

package/src/js/initializeMixpanel.ts

@@ -1,21 +1,29 @@
-import { getBootstrappingStore, getTelemetryContext } from "@workleap/telemetry";
+import { createCompositeLogger, type RootLogger } from "@workleap/logging";
+import { createBootstrappingStore, createTelemetryContext } from "@workleap/telemetry";
 import { setMixpanelContext } from "./context.ts";
 import { getTrackingEndpoint, type Environment } from "./env.ts";
 import { HasExecutedGuard } from "./HasExecutedGuard.ts";
 import { getSuperProperties, getTelemetryProperties, OtherProperties, setSuperProperties, setSuperProperty } from "./properties.ts";
 
 /**
- * @see https://workleap.github.io/wl-telemetry
+ * @see {@link https://workleap.github.io/wl-telemetry}
  */
 export interface InitializeMixpanelOptions {
     /**
-     * The endpoint to use for tracking events.
-     * If not provided, the default endpoint for the environment will be used.
+     * An optional tracking endpoint.
      * @default "tracking/track"
      */
     trackingEndpoint?: string;
+    /**
+     * Whether or not debug information should be logged to the console.
+     */
     verbose?: boolean;
+    /**
+     * An array of RootLogger instances.
+     */
+    loggers?: RootLogger[];
 }
+
 function registerLogRocketSessionUrlListener(verbose = false) {
     // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore
@@ -48,22 +56,24 @@ export function __resetInitializationGuard() {
  * @param envOrTrackingApiBaseUrl The environment to get the navigation url from or a base URL.
  * @param options Options for creating the tracking function.
  * @returns A function that sends tracking events to the tracking API.
- * @see https://workleap.github.io/wl-telemetry
+ * @see {@link https://workleap.github.io/wl-telemetry}
  */
 export function initializeMixpanel(productId: string, envOrTrackingApiBaseUrl: Environment | (string & {}), options: InitializeMixpanelOptions = {}) {
     const {
+        trackingEndpoint,
         verbose = false,
-        trackingEndpoint
+        loggers = []
     } = options;
 
     initializationGuard.throw("[mixpanel] Mixpanel has already been initialized. Did you call the \"initializeMixpanel\" function twice?");
 
+    const logger = createCompositeLogger(verbose, loggers);
     const endpoint = getTrackingEndpoint(envOrTrackingApiBaseUrl, trackingEndpoint);
-    const telemetryContext = getTelemetryContext({ verbose });
+    const telemetryContext = createTelemetryContext(logger);
 
     setSuperProperties(getTelemetryProperties(telemetryContext));
 
-    const bootstrappingStore = getBootstrappingStore();
+    const bootstrappingStore = createBootstrappingStore(logger);
 
     // If LogRocket is already available, register the listener. Otherwise, subscribe to the bootstrapping store
     // and register the listener once a notification is received that LogRocket is registered.
@@ -82,10 +92,8 @@ export function initializeMixpanel(productId: string, envOrTrackingApiBaseUrl: E
         productId,
         endpoint,
         superProperties: getSuperProperties(),
-        verbose
+        logger
     });
 
-    if (verbose) {
-        console.log("[mixpanel] Mixpanel is initialized.");
-    }
+    logger.debug("[mixpanel] Mixpanel is initialized.");
 }