@workleap/mixpanel 2.1.8 → 3.0.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @workleap/mixpanel
 
+## 3.0.0
+
+### Major Changes
+
+- [#86](https://github.com/workleap/wl-telemetry/pull/86) [`6d399dd`](https://github.com/workleap/wl-telemetry/commit/6d399dd6e01448a474ec098c64b185e45d9b6b5e) Thanks [@patricklafrance](https://github.com/patricklafrance)! - New API for telemetry packages and a new @workleap/telemetry umbrella package.
+
+### Patch Changes
+
+- Updated dependencies [[`6d399dd`](https://github.com/workleap/wl-telemetry/commit/6d399dd6e01448a474ec098c64b185e45d9b6b5e)]:
+  - @workleap/logrocket@2.0.0
+  - @workleap-telemetry/core@1.0.0
+
+## 2.1.9
+
+### Patch Changes
+
+- [#76](https://github.com/workleap/wl-telemetry/pull/76) [`39f4cc7`](https://github.com/workleap/wl-telemetry/commit/39f4cc7485b5292ffaa3ea973109923c08330fb7) Thanks [@patricklafrance](https://github.com/patricklafrance)! - Fix Mixpanel package internal file export path.
+
 ## 2.1.8
 
 ### Patch Changes

package/dist/js/MixpanelClient.d.ts

@@ -0,0 +1,22 @@
+import type { Logger } from "@workleap/logging";
+import type { CreateMixpanelTrackingFunctionOptions, MixpanelTrackingFunction } from "./createTrackingFunction.ts";
+export type MixpanelGlobalEventProperties = Map<string, unknown>;
+/**
+ * @see {@link https://workleap.github.io/wl-telemetry}
+ */
+export declare class MixpanelClient {
+    #private;
+    constructor(productId: string, endpoint: string, globalEventProperties: MixpanelGlobalEventProperties, logger: Logger);
+    /**
+     * @see {@link https://workleap.github.io/wl-telemetry}
+     */
+    createTrackingFunction(options?: CreateMixpanelTrackingFunctionOptions): MixpanelTrackingFunction;
+    /**
+     * @see {@link https://workleap.github.io/wl-telemetry}
+     */
+    setGlobalEventProperty(key: string, value: unknown): void;
+    /**
+     * @see {@link https://workleap.github.io/wl-telemetry}
+     */
+    setGlobalEventProperties(values: Record<string, unknown>): void;
+}

package/dist/js/MixpanelClient.js

@@ -0,0 +1,71 @@
+import { getBaseProperties } from "./properties.js";
+
+;// CONCATENATED MODULE: external "./properties.js"
+
+;// CONCATENATED MODULE: ./src/js/MixpanelClient.ts
+
+/**
+ * @see {@link https://workleap.github.io/wl-telemetry}
+ */ class MixpanelClient {
+    #productId;
+    #endpoint;
+    #globalEventProperties;
+    #logger;
+    constructor(productId, endpoint, globalEventProperties, logger){
+        this.#productId = productId;
+        this.#endpoint = endpoint;
+        this.#globalEventProperties = globalEventProperties;
+        this.#logger = logger;
+    }
+    /**
+     * @see {@link https://workleap.github.io/wl-telemetry}
+     */ createTrackingFunction(options = {}) {
+        const { targetProductId } = options;
+        const trackFunction = async (eventName, properties, _options = {})=>{
+            try {
+                const { keepAlive = false } = _options;
+                const baseProperties = getBaseProperties();
+                const allProperties = {
+                    ...baseProperties,
+                    ...Object.fromEntries(this.#globalEventProperties),
+                    ...properties
+                };
+                await fetch(this.#endpoint, {
+                    method: "POST",
+                    credentials: "include",
+                    keepalive: keepAlive,
+                    headers: {
+                        "Content-Type": "application/json"
+                    },
+                    body: JSON.stringify({
+                        eventName,
+                        productIdentifier: this.#productId,
+                        // Not sure why, but it seems important to send "null" if not target product identifier
+                        // are provided.
+                        targetProductIdentifier: targetProductId ?? null,
+                        properties: allProperties
+                    })
+                });
+            } catch (error) {
+                this.#logger.withText(`[mixpanel] An error occurred while sending a tracking event to "${this.#endpoint}":`).withError(error).error();
+            }
+        };
+        return trackFunction;
+    }
+    /**
+     * @see {@link https://workleap.github.io/wl-telemetry}
+     */ setGlobalEventProperty(key, value) {
+        this.#globalEventProperties.set(key, value);
+    }
+    /**
+     * @see {@link https://workleap.github.io/wl-telemetry}
+     */ setGlobalEventProperties(values) {
+        Object.keys(values).forEach((x)=>{
+            this.#globalEventProperties.set(x, values[x]);
+        });
+    }
+}
+
+export { MixpanelClient };
+
+//# sourceMappingURL=MixpanelClient.js.map

package/dist/js/MixpanelClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"js/MixpanelClient.js","sources":["webpack://@workleap/mixpanel/./src/js/MixpanelClient.ts"],"sourcesContent":["import type { Logger } from \"@workleap/logging\";\nimport type { CreateMixpanelTrackingFunctionOptions, MixpanelTrackingFunction } from \"./createTrackingFunction.ts\";\nimport { getBaseProperties } from \"./properties.ts\";\n\nexport type MixpanelGlobalEventProperties = Map<string, unknown>;\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport class MixpanelClient {\n    readonly #productId: string;\n    readonly #endpoint: string;\n    readonly #globalEventProperties: MixpanelGlobalEventProperties;\n    readonly #logger: Logger;\n\n    constructor(productId: string, endpoint: string, globalEventProperties: MixpanelGlobalEventProperties, logger: Logger) {\n        this.#productId = productId;\n        this.#endpoint = endpoint;\n        this.#globalEventProperties = globalEventProperties;\n        this.#logger = logger;\n    }\n\n    /**\n     * @see {@link https://workleap.github.io/wl-telemetry}\n     */\n    createTrackingFunction(options: CreateMixpanelTrackingFunctionOptions = {}) {\n        const {\n            targetProductId\n        } = options;\n\n        const trackFunction: MixpanelTrackingFunction = 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(this.#globalEventProperties),\n                    ...properties\n                };\n\n                await fetch(this.#endpoint, {\n                    method: \"POST\",\n                    credentials: \"include\",\n                    keepalive: keepAlive,\n                    headers: { \"Content-Type\": \"application/json\" },\n                    body: JSON.stringify({\n                        eventName,\n                        productIdentifier: this.#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                this.#logger\n                    .withText(`[mixpanel] An error occurred while sending a tracking event to \"${this.#endpoint}\":`)\n                    .withError(error as Error)\n                    .error();\n            }\n        };\n\n        return trackFunction;\n    }\n\n    /**\n     * @see {@link https://workleap.github.io/wl-telemetry}\n     */\n    setGlobalEventProperty(key: string, value: unknown) {\n        this.#globalEventProperties.set(key, value);\n    }\n\n    /**\n     * @see {@link https://workleap.github.io/wl-telemetry}\n     */\n    setGlobalEventProperties(values: Record<string, unknown>) {\n        Object.keys(values).forEach(x => {\n            this.#globalEventProperties.set(x, values[x]);\n        });\n    }\n}\n"],"names":["getBaseProperties","MixpanelClient","productId","endpoint","globalEventProperties","logger","options","targetProductId","trackFunction","eventName","properties","_options","keepAlive","baseProperties","allProperties","Object","fetch","JSON","error","key","value","values","x"],"mappings":";;;;;AAEoD;AAIpD;;CAEC,GACM,MAAMC;IACA,UAAU,CAAS;IACnB,SAAS,CAAS;IAClB,sBAAsB,CAAgC;IACtD,OAAO,CAAS;IAEzB,YAAYC,SAAiB,EAAEC,QAAgB,EAAEC,qBAAoD,EAAEC,MAAc,CAAE;QACnH,IAAI,CAAC,UAAU,GAAGH;QAClB,IAAI,CAAC,SAAS,GAAGC;QACjB,IAAI,CAAC,sBAAsB,GAAGC;QAC9B,IAAI,CAAC,OAAO,GAAGC;IACnB;IAEA;;KAEC,GACD,uBAAuBC,UAAiD,CAAC,CAAC,EAAE;QACxE,MAAM,EACFC,eAAe,EAClB,GAAGD;QAEJ,MAAME,gBAA0C,OAAOC,WAAWC,YAAYC,WAAW,CAAC,CAAC;YACvF,IAAI;gBACA,MAAM,EACFC,YAAY,KAAK,EACpB,GAAGD;gBAEJ,MAAME,iBAAiBb,iBAAiBA;gBAExC,MAAMc,gBAAgB;oBAClB,GAAGD,cAAc;oBACjB,GAAGE,OAAO,WAAW,CAAC,IAAI,CAAC,sBAAsB,CAAC;oBAClD,GAAGL,UAAU;gBACjB;gBAEA,MAAMM,MAAM,IAAI,CAAC,SAAS,EAAE;oBACxB,QAAQ;oBACR,aAAa;oBACb,WAAWJ;oBACX,SAAS;wBAAE,gBAAgB;oBAAmB;oBAC9C,MAAMK,KAAK,SAAS,CAAC;wBACjBR;wBACA,mBAAmB,IAAI,CAAC,UAAU;wBAClC,uFAAuF;wBACvF,gBAAgB;wBAChB,yBAA0BF,mBAAmB;wBAC7C,YAAYO;oBAChB;gBACJ;YACJ,EAAE,OAAOI,OAAgB;gBACrB,IAAI,CAAC,OAAO,CACP,QAAQ,CAAC,CAAC,gEAAgE,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,EAC9F,SAAS,CAACA,OACV,KAAK;YACd;QACJ;QAEA,OAAOV;IACX;IAEA;;KAEC,GACD,uBAAuBW,GAAW,EAAEC,KAAc,EAAE;QAChD,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAACD,KAAKC;IACzC;IAEA;;KAEC,GACD,yBAAyBC,MAA+B,EAAE;QACtDN,OAAO,IAAI,CAACM,QAAQ,OAAO,CAACC,CAAAA;YACxB,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAACA,GAAGD,MAAM,CAACC,EAAE;QAChD;IACJ;AACJ"}

package/dist/js/context.d.ts

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

package/dist/js/context.js

@@ -1,5 +1,8 @@
 
 ;// CONCATENATED MODULE: ./src/js/context.ts
+// DEPRECATED: Grace period ends on January 1th 2026.
+// Must keep this code until the end of the grace period because host applications using version 2.* of
+// this package would get runtime errors from the Platform Widgets CDN otherwise.
 const MixpanelContextVariableName = "__WLP_MIXPANEL_CONTEXT__";
 function setMixpanelContext(context) {
     // Will be used by the "track" function.

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 { 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"}
+{"version":3,"file":"js/context.js","sources":["webpack://@workleap/mixpanel/./src/js/context.ts"],"sourcesContent":["// DEPRECATED: Grace period ends on January 1th 2026.\n// Must keep this code until the end of the grace period because host applications using version 2.* of\n// this package would get runtime errors from the Platform Widgets CDN otherwise.\n\nimport type { Logger } from \"@workleap/logging\";\nimport type { MixpanelGlobalEventProperties } from \"./MixpanelClient.ts\";\n\nexport const MixpanelContextVariableName = \"__WLP_MIXPANEL_CONTEXT__\";\n\nexport interface MixpanelContext {\n    productId: string;\n    endpoint: string;\n    globalEventProperties: MixpanelGlobalEventProperties;\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":";;AAAA,qDAAqD;AACrD,uGAAuG;AACvG,iFAAiF;AAK1E,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

@@ -2,7 +2,7 @@ import { type MixpanelEventProperties } from "./properties.ts";
 /**
  * @see {@link https://workleap.github.io/wl-telemetry}
  */
-export interface CreateTrackingFunctionOptions {
+export interface CreateMixpanelTrackingFunctionOptions {
     /**
      * The product identifier of the target product.
      */
@@ -11,7 +11,7 @@ export interface CreateTrackingFunctionOptions {
 /**
  * @see {@link https://workleap.github.io/wl-telemetry}
  */
-export interface TrackingFunctionOptions {
+export interface MixpanelTrackingFunctionOptions {
     /**
    * Whether to keep the connection alive for the tracking request.
    * It is mostly used for tracking links where the user might navigate away before the request is completed.
@@ -31,8 +31,8 @@ export interface TrackingFunctionOptions {
  * @param options Options for tracking the event.
  * @see {@link https://workleap.github.io/wl-telemetry}
  */
-export type TrackingFunction = (eventName: string, properties: MixpanelEventProperties, options?: TrackingFunctionOptions) => Promise<void>;
+export type MixpanelTrackingFunction = (eventName: string, properties: MixpanelEventProperties, options?: MixpanelTrackingFunctionOptions) => Promise<void>;
 /**
  * @see {@link https://workleap.github.io/wl-telemetry}
  */
-export declare function createTrackingFunction(options?: CreateTrackingFunctionOptions): TrackingFunction;
+export declare function createTrackingFunction(options?: CreateMixpanelTrackingFunctionOptions): MixpanelTrackingFunction;

package/dist/js/createTrackingFunction.js

@@ -6,20 +6,23 @@ import { getBaseProperties } from "./properties.js";
 ;// CONCATENATED MODULE: external "./properties.js"
 
 ;// CONCATENATED MODULE: ./src/js/createTrackingFunction.ts
+// DEPRECATED: Grace period ends on January 1th 2026.
+// Must keep this code until the end of the grace period because host applications using version 2.* of
+// this package would get runtime errors from the Platform Widgets CDN otherwise.
 
 
 /**
  * @see {@link https://workleap.github.io/wl-telemetry}
  */ function createTrackingFunction(options = {}) {
     const { targetProductId } = options;
-    const { productId, endpoint, superProperties, logger } = getMixpanelContext();
+    const { productId, endpoint, globalEventProperties, logger } = getMixpanelContext();
     const trackFunction = async (eventName, properties, _options = {})=>{
         try {
             const { keepAlive = false } = _options;
             const baseProperties = getBaseProperties();
             const allProperties = {
                 ...baseProperties,
-                ...Object.fromEntries(superProperties),
+                ...Object.fromEntries(globalEventProperties),
                 ...properties
             };
             await fetch(endpoint, {

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 {@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"}
+{"version":3,"file":"js/createTrackingFunction.js","sources":["webpack://@workleap/mixpanel/./src/js/createTrackingFunction.ts"],"sourcesContent":["// DEPRECATED: Grace period ends on January 1th 2026.\n// Must keep this code until the end of the grace period because host applications using version 2.* of\n// this package would get runtime errors from the Platform Widgets CDN otherwise.\n\nimport { 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 CreateMixpanelTrackingFunctionOptions {\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 MixpanelTrackingFunctionOptions {\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 MixpanelTrackingFunction = (eventName: string, properties: MixpanelEventProperties, options?: MixpanelTrackingFunctionOptions) => Promise<void>;\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport function createTrackingFunction(options: CreateMixpanelTrackingFunctionOptions = {}) {\n    const {\n        targetProductId\n    } = options;\n\n    const {\n        productId,\n        endpoint,\n        globalEventProperties,\n        logger\n    } = getMixpanelContext();\n\n    const trackFunction: MixpanelTrackingFunction = 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(globalEventProperties),\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","globalEventProperties","logger","trackFunction","eventName","properties","_options","keepAlive","baseProperties","allProperties","Object","fetch","JSON","error"],"mappings":";;;;;;;;AAAA,qDAAqD;AACrD,uGAAuG;AACvG,iFAAiF;AAE/B;AACgC;AAsClF;;CAEC,GACM,SAASE,uBAAuBC,UAAiD,CAAC,CAAC;IACtF,MAAM,EACFC,eAAe,EAClB,GAAGD;IAEJ,MAAM,EACFE,SAAS,EACTC,QAAQ,EACRC,qBAAqB,EACrBC,MAAM,EACT,GAAGR,kBAAkBA;IAEtB,MAAMS,gBAA0C,OAAOC,WAAWC,YAAYC,WAAW,CAAC,CAAC;QACvF,IAAI;YACA,MAAM,EACFC,YAAY,KAAK,EACpB,GAAGD;YAEJ,MAAME,iBAAiBb,iBAAiBA;YAExC,MAAMc,gBAAgB;gBAClB,GAAGD,cAAc;gBACjB,GAAGE,OAAO,WAAW,CAACT,sBAAsB;gBAC5C,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/env.d.ts

@@ -1,4 +1,4 @@
 declare const EnvironmentList: readonly ["development", "staging", "production", "local", "msw"];
-export type Environment = typeof EnvironmentList[number];
-export declare function getTrackingEndpoint(envOrTrackingApiBaseUrl: Environment | (string & {}), trackingEndpoint?: string): string;
+export type MixpanelEnvironment = typeof EnvironmentList[number];
+export declare function getTrackingEndpoint(envOrTrackingApiBaseUrl: MixpanelEnvironment | (string & {}), trackingEndpoint?: string): string;
 export {};

package/dist/js/env.js.map

@@ -1 +1 @@
-{"version":3,"file":"js/env.js","sources":["webpack://@workleap/mixpanel/./src/js/env.ts"],"sourcesContent":["\nconst EnvironmentList = [\"development\", \"staging\", \"production\", \"local\", \"msw\"] as const;\n\nexport type Environment = typeof EnvironmentList[number];\n\nconst NavigationApiBaseUrl: Record<Environment, string> = {\n    \"production\": \"https://api.platform.workleap.com/shell/navigation/\",\n    \"staging\": \"https://api.platform.workleap-stg.com/shell/navigation/\",\n    \"development\": \"https://api.platform.workleap-dev.com/shell/navigation/\",\n    \"local\": \"https://api.platform.workleap-dev.com/shell/navigation/\",\n    \"msw\": \"/api/shell/navigation/\"\n};\n\n// Cannot use URL() because it doesn't support relative base url: https://github.com/whatwg/url/issues/531.\nfunction resolveApiUrl(path: string, baseUrl: string | undefined) : string {\n    return `${baseUrl}${baseUrl!.endsWith(\"/\") ? \"\" : \"/\"}${path.startsWith(\"/\") ? path.substring(1) : path}`;\n}\n\nexport function getTrackingEndpoint(envOrTrackingApiBaseUrl: Environment | (string & {}), trackingEndpoint = \"tracking/track\"): string {\n    let baseUrl: string;\n\n    if (EnvironmentList.includes(envOrTrackingApiBaseUrl as Environment)) {\n        baseUrl = NavigationApiBaseUrl[envOrTrackingApiBaseUrl as Environment];\n    } else {\n        baseUrl = envOrTrackingApiBaseUrl;\n    }\n\n    return resolveApiUrl(trackingEndpoint, baseUrl);\n}\n"],"names":["EnvironmentList","NavigationApiBaseUrl","resolveApiUrl","path","baseUrl","getTrackingEndpoint","envOrTrackingApiBaseUrl","trackingEndpoint"],"mappings":";;AACA,MAAMA,kBAAkB;IAAC;IAAe;IAAW;IAAc;IAAS;CAAM;AAIhF,MAAMC,uBAAoD;IACtD,cAAc;IACd,WAAW;IACX,eAAe;IACf,SAAS;IACT,OAAO;AACX;AAEA,2GAA2G;AAC3G,SAASC,cAAcC,IAAY,EAAEC,OAA2B;IAC5D,OAAO,GAAGA,UAAUA,QAAS,QAAQ,CAAC,OAAO,KAAK,MAAMD,KAAK,UAAU,CAAC,OAAOA,KAAK,SAAS,CAAC,KAAKA,MAAM;AAC7G;AAEO,SAASE,oBAAoBC,uBAAoD,EAAEC,mBAAmB,gBAAgB;IACzH,IAAIH;IAEJ,IAAIJ,gBAAgB,QAAQ,CAACM,0BAAyC;QAClEF,UAAUH,oBAAoB,CAACK,wBAAuC;IAC1E,OAAO;QACHF,UAAUE;IACd;IAEA,OAAOJ,cAAcK,kBAAkBH;AAC3C"}
+{"version":3,"file":"js/env.js","sources":["webpack://@workleap/mixpanel/./src/js/env.ts"],"sourcesContent":["const EnvironmentList = [\"development\", \"staging\", \"production\", \"local\", \"msw\"] as const;\n\nexport type MixpanelEnvironment = typeof EnvironmentList[number];\n\nconst NavigationApiBaseUrl: Record<MixpanelEnvironment, string> = {\n    \"production\": \"https://api.platform.workleap.com/shell/navigation/\",\n    \"staging\": \"https://api.platform.workleap-stg.com/shell/navigation/\",\n    \"development\": \"https://api.platform.workleap-dev.com/shell/navigation/\",\n    \"local\": \"https://api.platform.workleap-dev.com/shell/navigation/\",\n    \"msw\": \"/api/shell/navigation/\"\n};\n\n// Cannot use URL() because it doesn't support relative base url: https://github.com/whatwg/url/issues/531.\nfunction resolveApiUrl(path: string, baseUrl: string | undefined) : string {\n    return `${baseUrl}${baseUrl!.endsWith(\"/\") ? \"\" : \"/\"}${path.startsWith(\"/\") ? path.substring(1) : path}`;\n}\n\nexport function getTrackingEndpoint(envOrTrackingApiBaseUrl: MixpanelEnvironment | (string & {}), trackingEndpoint = \"tracking/track\"): string {\n    let baseUrl: string;\n\n    if (EnvironmentList.includes(envOrTrackingApiBaseUrl as MixpanelEnvironment)) {\n        baseUrl = NavigationApiBaseUrl[envOrTrackingApiBaseUrl as MixpanelEnvironment];\n    } else {\n        baseUrl = envOrTrackingApiBaseUrl;\n    }\n\n    return resolveApiUrl(trackingEndpoint, baseUrl);\n}\n"],"names":["EnvironmentList","NavigationApiBaseUrl","resolveApiUrl","path","baseUrl","getTrackingEndpoint","envOrTrackingApiBaseUrl","trackingEndpoint"],"mappings":";;AAAA,MAAMA,kBAAkB;IAAC;IAAe;IAAW;IAAc;IAAS;CAAM;AAIhF,MAAMC,uBAA4D;IAC9D,cAAc;IACd,WAAW;IACX,eAAe;IACf,SAAS;IACT,OAAO;AACX;AAEA,2GAA2G;AAC3G,SAASC,cAAcC,IAAY,EAAEC,OAA2B;IAC5D,OAAO,GAAGA,UAAUA,QAAS,QAAQ,CAAC,OAAO,KAAK,MAAMD,KAAK,UAAU,CAAC,OAAOA,KAAK,SAAS,CAAC,KAAKA,MAAM;AAC7G;AAEO,SAASE,oBAAoBC,uBAA4D,EAAEC,mBAAmB,gBAAgB;IACjI,IAAIH;IAEJ,IAAIJ,gBAAgB,QAAQ,CAACM,0BAAiD;QAC1EF,UAAUH,oBAAoB,CAACK,wBAA+C;IAClF,OAAO;QACHF,UAAUE;IACd;IAEA,OAAOJ,cAAcK,kBAAkBH;AAC3C"}

package/dist/js/index.d.ts

@@ -1,4 +1,6 @@
-export { createTrackingFunction, type CreateTrackingFunctionOptions, type TrackingFunction, type TrackingFunctionOptions } from "./createTrackingFunction.ts";
-export type { Environment } from "./env.ts";
+export { createTelemetryContext, type CreateTelemetryContextOptions, type TelemetryContext } from "@workleap-telemetry/core";
+export { createTrackingFunction, type CreateMixpanelTrackingFunctionOptions, type MixpanelTrackingFunction, type MixpanelTrackingFunctionOptions } from "./createTrackingFunction.ts";
+export type { MixpanelEnvironment } from "./env.ts";
 export { initializeMixpanel, type InitializeMixpanelOptions } from "./initializeMixpanel.ts";
-export { setSuperProperties, setSuperProperty, type MixpanelEventProperties } from "./properties.ts";
+export { MixpanelClient, type MixpanelGlobalEventProperties } from "./MixpanelClient.ts";
+export { type MixpanelEventProperties } from "./properties.ts";

package/dist/js/index.js

@@ -1,18 +1,22 @@
+import { createTelemetryContext } from "@workleap-telemetry/core";
 import { createTrackingFunction } from "./createTrackingFunction.js";
 import { initializeMixpanel } from "./initializeMixpanel.js";
-import { setSuperProperties, setSuperProperty } from "./properties.js";
+import { MixpanelClient } from "./MixpanelClient.js";
+
+;// CONCATENATED MODULE: external "@workleap-telemetry/core"
 
 ;// CONCATENATED MODULE: external "./createTrackingFunction.js"
 
 ;// CONCATENATED MODULE: external "./initializeMixpanel.js"
 
-;// CONCATENATED MODULE: external "./properties.js"
+;// CONCATENATED MODULE: external "./MixpanelClient.js"
 
 ;// CONCATENATED MODULE: ./src/js/index.ts
 
 
 
 
-export { createTrackingFunction, initializeMixpanel, setSuperProperties, setSuperProperty };
+
+export { MixpanelClient, createTelemetryContext, createTrackingFunction, initializeMixpanel };
 
 //# sourceMappingURL=index.js.map

package/dist/js/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"js/index.js","sources":["webpack://@workleap/mixpanel/./src/js/index.ts"],"sourcesContent":["export { createTrackingFunction, type CreateTrackingFunctionOptions, type TrackingFunction, type TrackingFunctionOptions } from \"./createTrackingFunction.ts\";\nexport type { Environment } from \"./env.ts\";\nexport { initializeMixpanel, type InitializeMixpanelOptions } from \"./initializeMixpanel.ts\";\nexport { setSuperProperties, setSuperProperty, type MixpanelEventProperties } from \"./properties.ts\";\n\n"],"names":["createTrackingFunction","initializeMixpanel","setSuperProperties","setSuperProperty"],"mappings":";;;;;;;;;;;AAA8J;AAEjE;AACQ"}
+{"version":3,"file":"js/index.js","sources":["webpack://@workleap/mixpanel/./src/js/index.ts"],"sourcesContent":["export { createTelemetryContext, type CreateTelemetryContextOptions, type TelemetryContext } from \"@workleap-telemetry/core\";\nexport { createTrackingFunction, type CreateMixpanelTrackingFunctionOptions, type MixpanelTrackingFunction, type MixpanelTrackingFunctionOptions } from \"./createTrackingFunction.ts\";\nexport type { MixpanelEnvironment } from \"./env.ts\";\nexport { initializeMixpanel, type InitializeMixpanelOptions } from \"./initializeMixpanel.ts\";\nexport { MixpanelClient, type MixpanelGlobalEventProperties } from \"./MixpanelClient.ts\";\nexport { type MixpanelEventProperties } from \"./properties.ts\";\n\n"],"names":["createTelemetryContext","createTrackingFunction","initializeMixpanel","MixpanelClient"],"mappings":";;;;;;;;;;;;;;AAA6H;AACyD;AAEzF;AACJ"}

package/dist/js/initializeMixpanel.d.ts

@@ -1,6 +1,9 @@
+import { type LogRocketInstrumentationPartialClient, type TelemetryContext } from "@workleap-telemetry/core";
 import { type RootLogger } from "@workleap/logging";
-import { type Environment } from "./env.ts";
+import { type MixpanelEnvironment } from "./env.ts";
+import { MixpanelClient, type MixpanelGlobalEventProperties } from "./MixpanelClient.ts";
 export declare const IsInitializedVariableName = "__WLP_MIXPANEL_IS_INITIALIZED__";
+export declare function __resetRegistrationGuard(): void;
 /**
  * @see {@link https://workleap.github.io/wl-telemetry}
  */
@@ -8,24 +11,42 @@ export interface InitializeMixpanelOptions {
     /**
      * An optional tracking endpoint.
      * @default "tracking/track"
+     * @see {@link https://workleap.github.io/wl-telemetry}
      */
     trackingEndpoint?: string;
+    /**
+     * Context including telemetry correlation ids.
+     * @see {@link https://workleap.github.io/wl-telemetry}
+     */
+    telemetryContext?: TelemetryContext;
+    /**
+     * An optional LogRocket client to automatically add the LogRocket
+     * session URL to Mixpanel events once it's available.
+     * @see {@link https://workleap.github.io/wl-telemetry}
+     */
+    logRocketInstrumentationClient?: LogRocketInstrumentationPartialClient;
     /**
      * Whether or not debug information should be logged to the console.
+     * @see {@link https://workleap.github.io/wl-telemetry}
      */
     verbose?: boolean;
     /**
      * An array of RootLogger instances.
+     * @see {@link https://workleap.github.io/wl-telemetry}
      */
     loggers?: RootLogger[];
 }
-export declare function __resetInitializationGuard(): void;
+export declare class MixpanelInitializer {
+    #private;
+    constructor(globalEventProperties: MixpanelGlobalEventProperties);
+    initialize(productId: string, envOrTrackingApiBaseUrl: MixpanelEnvironment | (string & {}), options?: InitializeMixpanelOptions): MixpanelClient;
+}
 /**
- * Creates a function that sends tracking events to the tracking API.
- * @param productId Your product identifier.
+ * Initialize Mixpanel telemetry.
+ * @param productId The Mixpanel product identifier.
  * @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.
+ * @param options Mixpanel instrumentation options.
+ * @returns {MixpanelClient} A Mixpanel client instance.
  * @see {@link https://workleap.github.io/wl-telemetry}
  */
-export declare function initializeMixpanel(productId: string, envOrTrackingApiBaseUrl: Environment | (string & {}), options?: InitializeMixpanelOptions): void;
+export declare function initializeMixpanel(productId: string, envOrTrackingApiBaseUrl: MixpanelEnvironment | (string & {}), options?: InitializeMixpanelOptions): MixpanelClient;

package/dist/js/initializeMixpanel.js

@@ -1,19 +1,19 @@
+import { HasExecutedGuard } from "@workleap-telemetry/core";
 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";
+import { MixpanelClient } from "./MixpanelClient.js";
+import { OtherProperties, getTelemetryProperties } from "./properties.js";
 
-;// CONCATENATED MODULE: external "@workleap/logging"
+;// CONCATENATED MODULE: external "@workleap-telemetry/core"
 
-;// CONCATENATED MODULE: external "@workleap/telemetry"
+;// CONCATENATED MODULE: external "@workleap/logging"
 
 ;// CONCATENATED MODULE: external "./context.js"
 
 ;// CONCATENATED MODULE: external "./env.js"
 
-;// CONCATENATED MODULE: external "./HasExecutedGuard.js"
+;// CONCATENATED MODULE: external "./MixpanelClient.js"
 
 ;// CONCATENATED MODULE: external "./properties.js"
 
@@ -24,58 +24,15 @@ import { OtherProperties, getSuperProperties, getTelemetryProperties, setSuperPr
 
 
 
+// DEPRECATED: Grace period ends on January 1th 2026.
+// Don't forget to remove the tests as well.
 const IsInitializedVariableName = "__WLP_MIXPANEL_IS_INITIALIZED__";
-function registerLogRocketSessionUrlListener(logger) {
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore
-    if (globalThis.__WLP_LOGROCKET_INSTRUMENTATION_REGISTER_GET_SESSION_URL_LISTENER__) {
-        // Automatically add the LogRocket session URL to all Honeycomb traces as an attribute.
-        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-        // @ts-ignore
-        globalThis.__WLP_LOGROCKET_INSTRUMENTATION_REGISTER_GET_SESSION_URL_LISTENER__((sessionUrl)=>{
-            logger.withText("[mixpanel] Received LogRocket session replay URL:").withText(sessionUrl).debug();
-            setSuperProperty(OtherProperties.LogRocketSessionUrl, sessionUrl);
-        });
-    } else {
-        logger.information("[mixpanel] Cannot integrate with LogRocket because \"globalThis.__WLP_LOGROCKET_INSTRUMENTATION_REGISTER_GET_SESSION_URL_LISTENER__\" is not available.");
-    }
-}
-const initializationGuard = new HasExecutedGuard();
-// This function should only be used by tests.
-function __resetInitializationGuard() {
-    initializationGuard.reset();
-}
-/**
- * Creates a function that sends tracking events to the tracking API.
- * @param productId Your product identifier.
- * @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 {@link https://workleap.github.io/wl-telemetry}
- */ function initializeMixpanel(productId, envOrTrackingApiBaseUrl, 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 = createTelemetryContext(logger);
-    setSuperProperties(getTelemetryProperties(telemetryContext));
-    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) {
-        registerLogRocketSessionUrlListener(logger);
-    } else {
-        bootstrappingStore.subscribe((action, store, unsubscribe)=>{
-            if (store.state.isLogRocketReady) {
-                unsubscribe();
-                registerLogRocketSessionUrlListener(logger);
-            }
-        });
-    }
+// DEPRECATED: Grace period ends on January 1th 2026.
+function registerDeprecatedContextAndGlobalVariables(productId, endpoint, globalEventProperties, logger) {
     setMixpanelContext({
         productId,
         endpoint,
-        superProperties: getSuperProperties(),
+        globalEventProperties,
         logger
     });
     // Indicates to the host applications that Mixpanel has been initialized.
@@ -84,9 +41,63 @@ function __resetInitializationGuard() {
     // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore
     globalThis[IsInitializedVariableName] = true;
-    logger.information("[mixpanel] Mixpanel is initialized.");
+}
+///////////////////////////
+let registrationGuardInstance;
+// It's important to use a lazy singleton instead of a singleton to avoid
+// any future probleme related to HMR, tree-shaking, SSR, etc..
+function getRegistrationGuard() {
+    if (!registrationGuardInstance) {
+        registrationGuardInstance = new HasExecutedGuard();
+    }
+    return registrationGuardInstance;
+}
+// This function should only be used by tests.
+function __resetRegistrationGuard() {
+    if (registrationGuardInstance) {
+        registrationGuardInstance.reset();
+    }
+}
+class MixpanelInitializer {
+    #globalEventProperties;
+    constructor(globalEventProperties){
+        this.#globalEventProperties = globalEventProperties;
+    }
+    initialize(productId, envOrTrackingApiBaseUrl, options = {}) {
+        const { trackingEndpoint, telemetryContext, logRocketInstrumentationClient, verbose = false, loggers = [] } = options;
+        const logger = createCompositeLogger(verbose, loggers);
+        const endpoint = getTrackingEndpoint(envOrTrackingApiBaseUrl, trackingEndpoint);
+        // Set the telemetry correlation ids on every Mixpanel event.
+        if (telemetryContext) {
+            for (const [key, value] of Object.entries(getTelemetryProperties(telemetryContext))){
+                this.#globalEventProperties.set(key, value);
+            }
+        }
+        // If a LogRocket client is already available, register a listener to get the LogRocket session url
+        // once it's available to set it on every Mixpanel event.
+        if (logRocketInstrumentationClient) {
+            logRocketInstrumentationClient.registerGetSessionUrlListener((sessionUrl)=>{
+                logger.withText("[mixpanel] Received LogRocket session replay URL:").withText(sessionUrl).debug();
+                this.#globalEventProperties.set(OtherProperties.LogRocketSessionUrl, sessionUrl);
+            });
+        }
+        registerDeprecatedContextAndGlobalVariables(productId, endpoint, this.#globalEventProperties, logger);
+        logger.information("[mixpanel] Mixpanel is initialized.");
+        return new MixpanelClient(productId, endpoint, this.#globalEventProperties, logger);
+    }
+}
+/**
+ * Initialize Mixpanel telemetry.
+ * @param productId The Mixpanel product identifier.
+ * @param envOrTrackingApiBaseUrl The environment to get the navigation url from or a base URL.
+ * @param options Mixpanel instrumentation options.
+ * @returns {MixpanelClient} A Mixpanel client instance.
+ * @see {@link https://workleap.github.io/wl-telemetry}
+ */ function initializeMixpanel(productId, envOrTrackingApiBaseUrl, options) {
+    getRegistrationGuard().throw("[mixpanel] Mixpanel has already been initialized. Did you call the \"initializeMixpanel\" function twice?");
+    return new MixpanelInitializer(new Map()).initialize(productId, envOrTrackingApiBaseUrl, options);
 }
 
-export { IsInitializedVariableName, __resetInitializationGuard, initializeMixpanel };
+export { IsInitializedVariableName, MixpanelInitializer, __resetRegistrationGuard, initializeMixpanel };
 
 //# sourceMappingURL=initializeMixpanel.js.map

package/dist/js/initializeMixpanel.js.map

@@ -1 +1 @@
-{"version":3,"file":"js/initializeMixpanel.js","sources":["webpack://@workleap/mixpanel/./src/js/initializeMixpanel.ts"],"sourcesContent":["import { createCompositeLogger, type Logger, 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\nexport const IsInitializedVariableName = \"__WLP_MIXPANEL_IS_INITIALIZED__\";\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(logger: Logger) {\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            logger\n                .withText(\"[mixpanel] Received LogRocket session replay URL:\")\n                .withText(sessionUrl)\n                .debug();\n\n            setSuperProperty(OtherProperties.LogRocketSessionUrl, sessionUrl);\n        });\n    } else {\n        logger.information(\"[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(logger);\n    } else {\n        bootstrappingStore.subscribe((action, store, unsubscribe) => {\n            if (store.state.isLogRocketReady) {\n                unsubscribe();\n                registerLogRocketSessionUrlListener(logger);\n            }\n        });\n    }\n\n    setMixpanelContext({\n        productId,\n        endpoint,\n        superProperties: getSuperProperties(),\n        logger\n    });\n\n    // Indicates to the host applications that Mixpanel has been initialized.\n    // It's useful in cases where an \"add-on\", like the platform widgets needs\n    // to know whether or not the host application is using Mixpanel.\n    // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n    // @ts-ignore\n    globalThis[IsInitializedVariableName] = true;\n\n    logger.information(\"[mixpanel] Mixpanel is initialized.\");\n}\n"],"names":["createCompositeLogger","createBootstrappingStore","createTelemetryContext","setMixpanelContext","getTrackingEndpoint","HasExecutedGuard","getSuperProperties","getTelemetryProperties","OtherProperties","setSuperProperties","setSuperProperty","IsInitializedVariableName","registerLogRocketSessionUrlListener","logger","globalThis","sessionUrl","initializationGuard","__resetInitializationGuard","initializeMixpanel","productId","envOrTrackingApiBaseUrl","options","trackingEndpoint","verbose","loggers","endpoint","telemetryContext","bootstrappingStore","action","store","unsubscribe"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAwF;AACD;AACrC;AACe;AACR;AAC2E;AAE7H,MAAMW,4BAA4B,kCAAkC;AAqB3E,SAASC,oCAAoCC,MAAc;IACvD,6DAA6D;IAC7D,aAAa;IACb,IAAIC,WAAW,mEAAmE,EAAE;QAChF,uFAAuF;QACvF,6DAA6D;QAC7D,aAAa;QACbA,WAAW,mEAAmE,CAAC,CAACC;YAC5EF,OACK,QAAQ,CAAC,qDACT,QAAQ,CAACE,YACT,KAAK;YAEVL,gBAAgBA,CAACF,mCAAmC,EAAEO;QAC1D;IACJ,OAAO;QACHF,OAAO,WAAW,CAAC;IACvB;AACJ;AAEA,MAAMG,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,EAChBC,UAAU,KAAK,EACfC,UAAU,EAAE,EACf,GAAGH;IAEJL,oBAAoB,KAAK,CAAC;IAE1B,MAAMH,SAASb,qBAAqBA,CAACuB,SAASC;IAC9C,MAAMC,WAAWrB,mBAAmBA,CAACgB,yBAAyBE;IAC9D,MAAMI,mBAAmBxB,sBAAsBA,CAACW;IAEhDJ,kBAAkBA,CAACF,sBAAsBA,CAACmB;IAE1C,MAAMC,qBAAqB1B,wBAAwBA,CAACY;IAEpD,4GAA4G;IAC5G,0FAA0F;IAC1F,IAAIc,mBAAmB,KAAK,CAAC,gBAAgB,EAAE;QAC3Cf,oCAAoCC;IACxC,OAAO;QACHc,mBAAmB,SAAS,CAAC,CAACC,QAAQC,OAAOC;YACzC,IAAID,MAAM,KAAK,CAAC,gBAAgB,EAAE;gBAC9BC;gBACAlB,oCAAoCC;YACxC;QACJ;IACJ;IAEAV,kBAAkBA,CAAC;QACfgB;QACAM;QACA,iBAAiBnB,kBAAkBA;QACnCO;IACJ;IAEA,yEAAyE;IACzE,0EAA0E;IAC1E,iEAAiE;IACjE,6DAA6D;IAC7D,aAAa;IACbC,UAAU,CAACH,0BAA0B,GAAG;IAExCE,OAAO,WAAW,CAAC;AACvB"}
+{"version":3,"file":"js/initializeMixpanel.js","sources":["webpack://@workleap/mixpanel/./src/js/initializeMixpanel.ts"],"sourcesContent":["import { HasExecutedGuard, type LogRocketInstrumentationPartialClient, type TelemetryContext } from \"@workleap-telemetry/core\";\nimport { createCompositeLogger, type Logger, type RootLogger } from \"@workleap/logging\";\nimport { setMixpanelContext } from \"./context.ts\";\nimport { getTrackingEndpoint, type MixpanelEnvironment } from \"./env.ts\";\nimport { MixpanelClient, type MixpanelGlobalEventProperties } from \"./MixpanelClient.ts\";\nimport { getTelemetryProperties, OtherProperties } from \"./properties.ts\";\n\n// DEPRECATED: Grace period ends on January 1th 2026.\n// Don't forget to remove the tests as well.\nexport const IsInitializedVariableName = \"__WLP_MIXPANEL_IS_INITIALIZED__\";\n\n// DEPRECATED: Grace period ends on January 1th 2026.\nfunction registerDeprecatedContextAndGlobalVariables(productId: string, endpoint: string, globalEventProperties: Map<string, unknown>, logger: Logger) {\n    setMixpanelContext({\n        productId,\n        endpoint,\n        globalEventProperties,\n        logger\n    });\n\n    // Indicates to the host applications that Mixpanel has been initialized.\n    // It's useful in cases where an \"add-on\", like the platform widgets needs\n    // to know whether or not the host application is using Mixpanel.\n    // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n    // @ts-ignore\n    globalThis[IsInitializedVariableName] = true;\n}\n\n///////////////////////////\n\nlet registrationGuardInstance: HasExecutedGuard | undefined;\n\n// It's important to use a lazy singleton instead of a singleton to avoid\n// any future probleme related to HMR, tree-shaking, SSR, etc..\nfunction getRegistrationGuard() {\n    if (!registrationGuardInstance) {\n        registrationGuardInstance = new HasExecutedGuard();\n    }\n\n    return registrationGuardInstance;\n}\n\n// This function should only be used by tests.\nexport function __resetRegistrationGuard() {\n    if (registrationGuardInstance) {\n        registrationGuardInstance.reset();\n    }\n}\n\n///////////////////////////\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     * @see {@link https://workleap.github.io/wl-telemetry}\n     */\n    trackingEndpoint?: string;\n    /**\n     * Context including telemetry correlation ids.\n     * @see {@link https://workleap.github.io/wl-telemetry}\n     */\n    telemetryContext?: TelemetryContext;\n    /**\n     * An optional LogRocket client to automatically add the LogRocket\n     * session URL to Mixpanel events once it's available.\n     * @see {@link https://workleap.github.io/wl-telemetry}\n     */\n    logRocketInstrumentationClient?: LogRocketInstrumentationPartialClient;\n    /**\n     * Whether or not debug information should be logged to the console.\n     * @see {@link https://workleap.github.io/wl-telemetry}\n     */\n    verbose?: boolean;\n    /**\n     * An array of RootLogger instances.\n     * @see {@link https://workleap.github.io/wl-telemetry}\n     */\n    loggers?: RootLogger[];\n}\n\n\nexport class MixpanelInitializer {\n    readonly #globalEventProperties: MixpanelGlobalEventProperties;\n\n    constructor(globalEventProperties: MixpanelGlobalEventProperties) {\n        this.#globalEventProperties = globalEventProperties;\n    }\n\n    initialize(\n        productId: string,\n        envOrTrackingApiBaseUrl: MixpanelEnvironment | (string & {}),\n        options: InitializeMixpanelOptions = {}\n    ) {\n        const {\n            trackingEndpoint,\n            telemetryContext,\n            logRocketInstrumentationClient,\n            verbose = false,\n            loggers = []\n        } = options;\n\n        const logger = createCompositeLogger(verbose, loggers);\n        const endpoint = getTrackingEndpoint(envOrTrackingApiBaseUrl, trackingEndpoint);\n\n        // Set the telemetry correlation ids on every Mixpanel event.\n        if (telemetryContext) {\n            for (const [key, value] of Object.entries(getTelemetryProperties(telemetryContext))) {\n                this.#globalEventProperties.set(key, value);\n            }\n        }\n\n        // If a LogRocket client is already available, register a listener to get the LogRocket session url\n        // once it's available to set it on every Mixpanel event.\n        if (logRocketInstrumentationClient) {\n            logRocketInstrumentationClient.registerGetSessionUrlListener((sessionUrl: string) => {\n                logger\n                    .withText(\"[mixpanel] Received LogRocket session replay URL:\")\n                    .withText(sessionUrl)\n                    .debug();\n\n                this.#globalEventProperties.set(OtherProperties.LogRocketSessionUrl, sessionUrl);\n            });\n        }\n\n        registerDeprecatedContextAndGlobalVariables(productId, endpoint, this.#globalEventProperties, logger);\n\n        logger.information(\"[mixpanel] Mixpanel is initialized.\");\n\n        return new MixpanelClient(productId, endpoint, this.#globalEventProperties, logger);\n    }\n}\n\n/**\n * Initialize Mixpanel telemetry.\n * @param productId The Mixpanel product identifier.\n * @param envOrTrackingApiBaseUrl The environment to get the navigation url from or a base URL.\n * @param options Mixpanel instrumentation options.\n * @returns {MixpanelClient} A Mixpanel client instance.\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport function initializeMixpanel(\n    productId: string,\n    envOrTrackingApiBaseUrl: MixpanelEnvironment | (string & {}),\n    options?: InitializeMixpanelOptions\n) {\n    getRegistrationGuard().throw(\"[mixpanel] Mixpanel has already been initialized. Did you call the \\\"initializeMixpanel\\\" function twice?\");\n\n    return new MixpanelInitializer(\n        new Map<string, unknown>()\n    ).initialize(\n        productId,\n        envOrTrackingApiBaseUrl,\n        options\n    );\n}\n"],"names":["HasExecutedGuard","createCompositeLogger","setMixpanelContext","getTrackingEndpoint","MixpanelClient","getTelemetryProperties","OtherProperties","IsInitializedVariableName","registerDeprecatedContextAndGlobalVariables","productId","endpoint","globalEventProperties","logger","globalThis","registrationGuardInstance","getRegistrationGuard","__resetRegistrationGuard","MixpanelInitializer","envOrTrackingApiBaseUrl","options","trackingEndpoint","telemetryContext","logRocketInstrumentationClient","verbose","loggers","key","value","Object","sessionUrl","initializeMixpanel","Map"],"mappings":";;;;;;;;;;;;;;;;;;;;AAA+H;AACvC;AACtC;AACuB;AACgB;AACf;AAE1E,qDAAqD;AACrD,4CAA4C;AACrC,MAAMO,4BAA4B,kCAAkC;AAE3E,qDAAqD;AACrD,SAASC,4CAA4CC,SAAiB,EAAEC,QAAgB,EAAEC,qBAA2C,EAAEC,MAAc;IACjJV,kBAAkBA,CAAC;QACfO;QACAC;QACAC;QACAC;IACJ;IAEA,yEAAyE;IACzE,0EAA0E;IAC1E,iEAAiE;IACjE,6DAA6D;IAC7D,aAAa;IACbC,UAAU,CAACN,0BAA0B,GAAG;AAC5C;AAEA,2BAA2B;AAE3B,IAAIO;AAEJ,yEAAyE;AACzE,+DAA+D;AAC/D,SAASC;IACL,IAAI,CAACD,2BAA2B;QAC5BA,4BAA4B,IAAId,gBAAgBA;IACpD;IAEA,OAAOc;AACX;AAEA,8CAA8C;AACvC,SAASE;IACZ,IAAIF,2BAA2B;QAC3BA,0BAA0B,KAAK;IACnC;AACJ;AAsCO,MAAMG;IACA,sBAAsB,CAAgC;IAE/D,YAAYN,qBAAoD,CAAE;QAC9D,IAAI,CAAC,sBAAsB,GAAGA;IAClC;IAEA,WACIF,SAAiB,EACjBS,uBAA4D,EAC5DC,UAAqC,CAAC,CAAC,EACzC;QACE,MAAM,EACFC,gBAAgB,EAChBC,gBAAgB,EAChBC,8BAA8B,EAC9BC,UAAU,KAAK,EACfC,UAAU,EAAE,EACf,GAAGL;QAEJ,MAAMP,SAASX,qBAAqBA,CAACsB,SAASC;QAC9C,MAAMd,WAAWP,mBAAmBA,CAACe,yBAAyBE;QAE9D,6DAA6D;QAC7D,IAAIC,kBAAkB;YAClB,KAAK,MAAM,CAACI,KAAKC,MAAM,IAAIC,OAAO,OAAO,CAACtB,sBAAsBA,CAACgB,mBAAoB;gBACjF,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAACI,KAAKC;YACzC;QACJ;QAEA,mGAAmG;QACnG,yDAAyD;QACzD,IAAIJ,gCAAgC;YAChCA,+BAA+B,6BAA6B,CAAC,CAACM;gBAC1DhB,OACK,QAAQ,CAAC,qDACT,QAAQ,CAACgB,YACT,KAAK;gBAEV,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAACtB,mCAAmC,EAAEsB;YACzE;QACJ;QAEApB,4CAA4CC,WAAWC,UAAU,IAAI,CAAC,sBAAsB,EAAEE;QAE9FA,OAAO,WAAW,CAAC;QAEnB,OAAO,IAAIR,cAAcA,CAACK,WAAWC,UAAU,IAAI,CAAC,sBAAsB,EAAEE;IAChF;AACJ;AAEA;;;;;;;CAOC,GACM,SAASiB,mBACZpB,SAAiB,EACjBS,uBAA4D,EAC5DC,OAAmC;IAEnCJ,uBAAuB,KAAK,CAAC;IAE7B,OAAO,IAAIE,oBACP,IAAIa,OACN,UAAU,CACRrB,WACAS,yBACAC;AAER"}

package/dist/js/properties.d.ts

@@ -1,4 +1,4 @@
-import type { TelemetryContext } from "@workleap/telemetry";
+import type { TelemetryContext } from "@workleap-telemetry/core";
 export type MixpanelEventProperties = Record<string, unknown>;
 export declare const BaseProperties: {
     readonly Browser: "$browser";
@@ -35,8 +35,3 @@ export declare function getTelemetryProperties(context: TelemetryContext): {
 export declare const OtherProperties: {
     LogRocketSessionUrl: string;
 };
-export type SuperProperties = Map<string, unknown>;
-export declare function setSuperProperty(key: string, value: unknown): void;
-export declare function setSuperProperties(values: Record<string, unknown>): void;
-export declare function getSuperProperties(): SuperProperties;
-export declare function __clearSuperProperties(): void;