@workleap/mixpanel 4.0.2 → 4.0.3

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @workleap/mixpanel
 
+## 4.0.3
+
+### Patch Changes
+
+- [#111](https://github.com/workleap/wl-telemetry/pull/111) [`e146e03`](https://github.com/workleap/wl-telemetry/commit/e146e030aa9e4a624d4429e0ba4f0627153179cc) Thanks [@patricklafrance](https://github.com/patricklafrance)! - Added a `NoopTelemetryClient` and added `dontThrowOnUndefined` option to the hooks to retrieve the telemetry clients.
+
+- Updated dependencies [[`e146e03`](https://github.com/workleap/wl-telemetry/commit/e146e030aa9e4a624d4429e0ba4f0627153179cc)]:
+  - @workleap/logrocket@2.1.3
+
 ## 4.0.2
 
 ### Patch Changes

package/dist/js/MixpanelClient.d.ts

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

package/dist/js/MixpanelClient.js

@@ -4,9 +4,7 @@ import { getBaseProperties } from "./properties.js";
 
 ;// CONCATENATED MODULE: ./src/js/MixpanelClient.ts
 
-/**
- * @see {@link https://workleap.github.io/wl-telemetry}
- */ class MixpanelClient {
+class MixpanelClientImpl {
     #productId;
     #endpoint;
     #globalEventProperties;
@@ -19,9 +17,7 @@ import { getBaseProperties } from "./properties.js";
     }
     // IMPORTANT: If you update this method, make sure to update the MixpanelPartialClient
     // interface as well in @workleap-telemetry/core.
-    /**
-     * @see {@link https://workleap.github.io/wl-telemetry}
-     */ createTrackingFunction(options = {}) {
+    createTrackingFunction(options = {}) {
         const { targetProductId } = options;
         const trackFunction = async (eventName, properties, _options = {})=>{
             try {
@@ -54,20 +50,16 @@ import { getBaseProperties } from "./properties.js";
         };
         return trackFunction;
     }
-    /**
-     * @see {@link https://workleap.github.io/wl-telemetry}
-     */ setGlobalEventProperty(key, value) {
+    setGlobalEventProperty(key, value) {
         this.#globalEventProperties.set(key, value);
     }
-    /**
-     * @see {@link https://workleap.github.io/wl-telemetry}
-     */ setGlobalEventProperties(values) {
+    setGlobalEventProperties(values) {
         Object.keys(values).forEach((x)=>{
             this.#globalEventProperties.set(x, values[x]);
         });
     }
 }
 
-export { MixpanelClient };
+export { MixpanelClientImpl };
 
 //# sourceMappingURL=MixpanelClient.js.map

package/dist/js/MixpanelClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"js/MixpanelClient.js","sources":["webpack://@workleap/mixpanel/./src/js/MixpanelClient.ts"],"sourcesContent":["import type { CreateMixpanelTrackingFunctionOptions, MixpanelPartialClient, MixpanelTrackingFunction } from \"@workleap-telemetry/core\";\nimport type { Logger } from \"@workleap/logging\";\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 implements MixpanelPartialClient {\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    // IMPORTANT: If you update this method, make sure to update the MixpanelPartialClient\n    // interface as well in @workleap-telemetry/core.\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,sFAAsF;IACtF,iDAAiD;IACjD;;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"}
+{"version":3,"file":"js/MixpanelClient.js","sources":["webpack://@workleap/mixpanel/./src/js/MixpanelClient.ts"],"sourcesContent":["import type { CreateMixpanelTrackingFunctionOptions, MixpanelTrackingFunction } from \"@workleap-telemetry/core\";\nimport type { Logger } from \"@workleap/logging\";\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 interface MixpanelClient {\n    /**\n     * @see {@link https://workleap.github.io/wl-telemetry}\n     */\n    createTrackingFunction: (options: CreateMixpanelTrackingFunctionOptions) => MixpanelTrackingFunction;\n\n    /**\n     * @see {@link https://workleap.github.io/wl-telemetry}\n     */\n    setGlobalEventProperty: (key: string, value: unknown) => void;\n\n    /**\n     * @see {@link https://workleap.github.io/wl-telemetry}\n     */\n    setGlobalEventProperties: (values: Record<string, unknown>) => void;\n}\n\nexport class MixpanelClientImpl implements 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    // IMPORTANT: If you update this method, make sure to update the MixpanelPartialClient\n    // interface as well in @workleap-telemetry/core.\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    setGlobalEventProperty(key: string, value: unknown) {\n        this.#globalEventProperties.set(key, value);\n    }\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","MixpanelClientImpl","productId","endpoint","globalEventProperties","logger","options","targetProductId","trackFunction","eventName","properties","_options","keepAlive","baseProperties","allProperties","Object","fetch","JSON","error","key","value","values","x"],"mappings":";;;;;AAEoD;AAwB7C,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,sFAAsF;IACtF,iDAAiD;IACjD,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,uBAAuBW,GAAW,EAAEC,KAAc,EAAE;QAChD,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAACD,KAAKC;IACzC;IAEA,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/NoopMixpanelClient.d.ts

@@ -1,4 +1,6 @@
-import type { MixpanelPartialClient } from "@workleap-telemetry/core";
-export declare class NoopMixpanelClient implements MixpanelPartialClient {
+import type { MixpanelClient } from "./MixpanelClient.ts";
+export declare class NoopMixpanelClient implements MixpanelClient {
     createTrackingFunction(): () => Promise<void>;
+    setGlobalEventProperty(): void;
+    setGlobalEventProperties(): void;
 }

package/dist/js/NoopMixpanelClient.js

@@ -4,6 +4,8 @@ class NoopMixpanelClient {
     createTrackingFunction() {
         return ()=>Promise.resolve();
     }
+    setGlobalEventProperty() {}
+    setGlobalEventProperties() {}
 }
 
 export { NoopMixpanelClient };

package/dist/js/NoopMixpanelClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"js/NoopMixpanelClient.js","sources":["webpack://@workleap/mixpanel/./src/js/NoopMixpanelClient.ts"],"sourcesContent":["import type { MixpanelPartialClient } from \"@workleap-telemetry/core\";\n\nexport class NoopMixpanelClient implements MixpanelPartialClient {\n    createTrackingFunction() {\n        return () => Promise.resolve();\n    }\n}\n"],"names":["NoopMixpanelClient","Promise"],"mappings":";;AAEO,MAAMA;IACT,yBAAyB;QACrB,OAAO,IAAMC,QAAQ,OAAO;IAChC;AACJ"}
+{"version":3,"file":"js/NoopMixpanelClient.js","sources":["webpack://@workleap/mixpanel/./src/js/NoopMixpanelClient.ts"],"sourcesContent":["import type { MixpanelClient } from \"./MixpanelClient.ts\";\n\nexport class NoopMixpanelClient implements MixpanelClient {\n    createTrackingFunction() {\n        return () => Promise.resolve();\n    }\n\n    setGlobalEventProperty() {}\n    setGlobalEventProperties() {}\n}\n"],"names":["NoopMixpanelClient","Promise"],"mappings":";;AAEO,MAAMA;IACT,yBAAyB;QACrB,OAAO,IAAMC,QAAQ,OAAO;IAChC;IAEA,yBAAyB,CAAC;IAC1B,2BAA2B,CAAC;AAChC"}

package/dist/js/index.d.ts

@@ -3,5 +3,5 @@ export type { CreateMixpanelTrackingFunctionOptions, MixpanelEventProperties, Mi
 export { createTrackingFunction } from "./createTrackingFunction.ts";
 export type { MixpanelEnvironment } from "./env.ts";
 export { initializeMixpanel, type InitializeMixpanelOptions } from "./initializeMixpanel.ts";
-export { MixpanelClient, type MixpanelGlobalEventProperties } from "./MixpanelClient.ts";
+export type { MixpanelClient, MixpanelGlobalEventProperties } from "./MixpanelClient.ts";
 export { NoopMixpanelClient } from "./NoopMixpanelClient.ts";

package/dist/js/index.js

@@ -1,7 +1,6 @@
 import { createTelemetryContext } from "@workleap-telemetry/core";
 import { createTrackingFunction } from "./createTrackingFunction.js";
 import { initializeMixpanel } from "./initializeMixpanel.js";
-import { MixpanelClient } from "./MixpanelClient.js";
 import { NoopMixpanelClient } from "./NoopMixpanelClient.js";
 
 ;// CONCATENATED MODULE: external "@workleap-telemetry/core"
@@ -10,8 +9,6 @@ import { NoopMixpanelClient } from "./NoopMixpanelClient.js";
 
 ;// CONCATENATED MODULE: external "./initializeMixpanel.js"
 
-;// CONCATENATED MODULE: external "./MixpanelClient.js"
-
 ;// CONCATENATED MODULE: external "./NoopMixpanelClient.js"
 
 ;// CONCATENATED MODULE: ./src/js/index.ts
@@ -20,7 +17,6 @@ import { NoopMixpanelClient } from "./NoopMixpanelClient.js";
 
 
 
-
-export { MixpanelClient, NoopMixpanelClient, createTelemetryContext, createTrackingFunction, initializeMixpanel };
+export { NoopMixpanelClient, 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 { createTelemetryContext, type CreateTelemetryContextOptions, type TelemetryContext } from \"@workleap-telemetry/core\";\nexport type { CreateMixpanelTrackingFunctionOptions, MixpanelEventProperties, MixpanelTrackingFunction, MixpanelTrackingFunctionOptions } from \"@workleap-telemetry/core\";\nexport { createTrackingFunction } from \"./createTrackingFunction.ts\";\nexport type { MixpanelEnvironment } from \"./env.ts\";\nexport { initializeMixpanel, type InitializeMixpanelOptions } from \"./initializeMixpanel.ts\";\nexport { MixpanelClient, type MixpanelGlobalEventProperties } from \"./MixpanelClient.ts\";\nexport { NoopMixpanelClient } from \"./NoopMixpanelClient.ts\";\n\n"],"names":["createTelemetryContext","createTrackingFunction","initializeMixpanel","MixpanelClient","NoopMixpanelClient"],"mappings":";;;;;;;;;;;;;;;;;AAA6H;AAExD;AAEwB;AACJ;AAC5B"}
+{"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 type { CreateMixpanelTrackingFunctionOptions, MixpanelEventProperties, MixpanelTrackingFunction, MixpanelTrackingFunctionOptions } from \"@workleap-telemetry/core\";\nexport { createTrackingFunction } from \"./createTrackingFunction.ts\";\nexport type { MixpanelEnvironment } from \"./env.ts\";\nexport { initializeMixpanel, type InitializeMixpanelOptions } from \"./initializeMixpanel.ts\";\nexport type { MixpanelClient, MixpanelGlobalEventProperties } from \"./MixpanelClient.ts\";\nexport { NoopMixpanelClient } from \"./NoopMixpanelClient.ts\";\n\n"],"names":["createTelemetryContext","createTrackingFunction","initializeMixpanel","NoopMixpanelClient"],"mappings":";;;;;;;;;;;;;;AAA6H;AAExD;AAEwB;AAEhC"}

package/dist/js/initializeMixpanel.d.ts

@@ -1,7 +1,7 @@
 import { type LogRocketInstrumentationPartialClient, type TelemetryContext } from "@workleap-telemetry/core";
 import { type RootLogger } from "@workleap/logging";
 import { type MixpanelEnvironment } from "./env.ts";
-import { MixpanelClient, type MixpanelGlobalEventProperties } from "./MixpanelClient.ts";
+import { type MixpanelClient, type MixpanelGlobalEventProperties } from "./MixpanelClient.ts";
 export declare const IsInitializedVariableName = "__WLP_MIXPANEL_IS_INITIALIZED__";
 export declare function __resetRegistrationGuard(): void;
 /**

package/dist/js/initializeMixpanel.js

@@ -2,7 +2,7 @@ import { HasExecutedGuard } from "@workleap-telemetry/core";
 import { createCompositeLogger } from "@workleap/logging";
 import { setMixpanelContext } from "./context.js";
 import { getTrackingEndpoint } from "./env.js";
-import { MixpanelClient } from "./MixpanelClient.js";
+import { MixpanelClientImpl } from "./MixpanelClient.js";
 import { OtherProperties, getTelemetryProperties } from "./properties.js";
 
 ;// CONCATENATED MODULE: external "@workleap-telemetry/core"
@@ -83,7 +83,9 @@ class MixpanelInitializer {
         }
         registerDeprecatedContextAndGlobalVariables(productId, endpoint, this.#globalEventProperties, logger);
         logger.information("[mixpanel] Mixpanel is initialized.");
-        return new MixpanelClient(productId, endpoint, this.#globalEventProperties, logger);
+        const client = new MixpanelClientImpl(productId, endpoint, this.#globalEventProperties, logger);
+        // The cast is to normalize the inferred return type to the "LogRocketInstrumentationClient" type.
+        return client;
     }
 }
 /**

package/dist/js/initializeMixpanel.js.map

@@ -1 +1 @@
-{"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"}
+{"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 { type MixpanelClient, MixpanelClientImpl, 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        const client = new MixpanelClientImpl(productId, endpoint, this.#globalEventProperties, logger);\n\n        // The cast is to normalize the inferred return type to the \"LogRocketInstrumentationClient\" type.\n        return client as MixpanelClient;\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","MixpanelClientImpl","getTelemetryProperties","OtherProperties","IsInitializedVariableName","registerDeprecatedContextAndGlobalVariables","productId","endpoint","globalEventProperties","logger","globalThis","registrationGuardInstance","getRegistrationGuard","__resetRegistrationGuard","MixpanelInitializer","envOrTrackingApiBaseUrl","options","trackingEndpoint","telemetryContext","logRocketInstrumentationClient","verbose","loggers","key","value","Object","sessionUrl","client","initializeMixpanel","Map"],"mappings":";;;;;;;;;;;;;;;;;;;;AAA+H;AACvC;AACtC;AACuB;AACyC;AACxC;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,MAAMiB,SAAS,IAAIzB,kBAAkBA,CAACK,WAAWC,UAAU,IAAI,CAAC,sBAAsB,EAAEE;QAExF,kGAAkG;QAClG,OAAOiB;IACX;AACJ;AAEA;;;;;;;CAOC,GACM,SAASC,mBACZrB,SAAiB,EACjBS,uBAA4D,EAC5DC,OAAmC;IAEnCJ,uBAAuB,KAAK,CAAC;IAE7B,OAAO,IAAIE,oBACP,IAAIc,OACN,UAAU,CACRtB,WACAS,yBACAC;AAER"}

package/dist/react/MixpanelContext.d.ts

@@ -1,18 +1,25 @@
-import type { MixpanelPartialClient } from "@workleap-telemetry/core";
 import { type PropsWithChildren } from "react";
-export declare const MixpanelContext: import("react").Context<MixpanelPartialClient | undefined>;
+import type { MixpanelClient } from "../js/MixpanelClient.ts";
+export declare const MixpanelContext: import("react").Context<MixpanelClient | undefined>;
 /**
  * @see {@link https://workleap.github.io/wl-telemetry}
  */
 export interface MixpanelProviderProps extends PropsWithChildren {
-    client: MixpanelPartialClient;
+    client: MixpanelClient;
 }
 /**
  * @see {@link https://workleap.github.io/wl-telemetry}
  */
 export declare function MixpanelProvider(props: MixpanelProviderProps): import("react/jsx-runtime").JSX.Element;
-/**
- * Retrieve the Mixpanel client.
- * @see {@link https://workleap.github.io/wl-telemetry}
- */
-export declare function useMixpanelClient(): MixpanelPartialClient;
+export interface UseMixpanelClientOptions {
+    /**
+     * Whether or not an exception should be thrown if the client hasn't been provided.
+     */
+    dontThrowOnUndefined?: boolean;
+}
+export declare function useMixpanelClient(options?: {
+    dontThrowOnUndefined?: false;
+}): MixpanelClient;
+export declare function useMixpanelClient(options: {
+    dontThrowOnUndefined: true;
+}): MixpanelClient | undefined;

package/dist/react/MixpanelContext.js

@@ -21,9 +21,10 @@ const MixpanelContext = /*#__PURE__*/ createContext(undefined);
 /**
  * Retrieve the Mixpanel client.
  * @see {@link https://workleap.github.io/wl-telemetry}
- */ function useMixpanelClient() {
+ */ function useMixpanelClient(options = {}) {
+    const { dontThrowOnUndefined = false } = options;
     const client = useContext(MixpanelContext);
-    if (!client) {
+    if (!client && !dontThrowOnUndefined) {
         throw new Error("[mixpanel] The useMixpanelClient function is called before a MixpanelClient instance has been provided.");
     }
     return client;

package/dist/react/MixpanelContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"react/MixpanelContext.js","sources":["webpack://@workleap/mixpanel/./src/react/MixpanelContext.tsx"],"sourcesContent":["import type { MixpanelPartialClient } from \"@workleap-telemetry/core\";\nimport { createContext, type PropsWithChildren, useContext } from \"react\";\n\nexport const MixpanelContext = createContext<MixpanelPartialClient | undefined>(undefined);\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport interface MixpanelProviderProps extends PropsWithChildren {\n    client: MixpanelPartialClient;\n}\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport function MixpanelProvider(props: MixpanelProviderProps) {\n    const {\n        client,\n        children\n    } = props;\n\n    return (\n        <MixpanelContext.Provider value={client}>\n            {children}\n        </MixpanelContext.Provider>\n    );\n}\n\n/**\n * Retrieve the Mixpanel client.\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport function useMixpanelClient() {\n    const client = useContext(MixpanelContext);\n\n    if (!client) {\n        throw new Error(\"[mixpanel] The useMixpanelClient function is called before a MixpanelClient instance has been provided.\");\n    }\n\n    return client;\n}\n"],"names":["createContext","useContext","MixpanelContext","undefined","MixpanelProvider","props","client","children","useMixpanelClient","Error"],"mappings":";;;;;;;;;AAC0E;AAEnE,MAAME,gCAAkBF,aAAaA,CAAoCG,WAAW;AAS3F;;CAEC,GACM,SAASC,iBAAiBC,KAA4B;IACzD,MAAM,EACFC,MAAM,EACNC,QAAQ,EACX,GAAGF;IAEJ,qBACI,IAACH,gBAAgB,QAAQ;QAAC,OAAOI;kBAC5BC;;AAGb;AAEA;;;CAGC,GACM,SAASC;IACZ,MAAMF,SAASL,UAAUA,CAACC;IAE1B,IAAI,CAACI,QAAQ;QACT,MAAM,IAAIG,MAAM;IACpB;IAEA,OAAOH;AACX"}
+{"version":3,"file":"react/MixpanelContext.js","sources":["webpack://@workleap/mixpanel/./src/react/MixpanelContext.tsx"],"sourcesContent":["import { createContext, type PropsWithChildren, useContext } from \"react\";\nimport type { MixpanelClient } from \"../js/MixpanelClient.ts\";\n\nexport const MixpanelContext = createContext<MixpanelClient | undefined>(undefined);\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport interface MixpanelProviderProps extends PropsWithChildren {\n    client: MixpanelClient;\n}\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport function MixpanelProvider(props: MixpanelProviderProps) {\n    const {\n        client,\n        children\n    } = props;\n\n    return (\n        <MixpanelContext.Provider value={client}>\n            {children}\n        </MixpanelContext.Provider>\n    );\n}\n\nexport interface UseMixpanelClientOptions {\n    /**\n     * Whether or not an exception should be thrown if the client hasn't been provided.\n     */\n    dontThrowOnUndefined?: boolean;\n}\n\nexport function useMixpanelClient(options?: { dontThrowOnUndefined?: false }): MixpanelClient;\nexport function useMixpanelClient(options: { dontThrowOnUndefined: true }): MixpanelClient | undefined;\n\n/**\n * Retrieve the Mixpanel client.\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport function useMixpanelClient(options: UseMixpanelClientOptions = {}) {\n    const {\n        dontThrowOnUndefined = false\n    } = options;\n\n    const client = useContext(MixpanelContext);\n\n    if (!client && !dontThrowOnUndefined) {\n        throw new Error(\"[mixpanel] The useMixpanelClient function is called before a MixpanelClient instance has been provided.\");\n    }\n\n    return client;\n}\n"],"names":["createContext","useContext","MixpanelContext","undefined","MixpanelProvider","props","client","children","useMixpanelClient","options","dontThrowOnUndefined","Error"],"mappings":";;;;;;;;;AAA0E;AAGnE,MAAME,gCAAkBF,aAAaA,CAA6BG,WAAW;AASpF;;CAEC,GACM,SAASC,iBAAiBC,KAA4B;IACzD,MAAM,EACFC,MAAM,EACNC,QAAQ,EACX,GAAGF;IAEJ,qBACI,IAACH,gBAAgB,QAAQ;QAAC,OAAOI;kBAC5BC;;AAGb;AAYA;;;CAGC,GACM,SAASC,kBAAkBC,UAAoC,CAAC,CAAC;IACpE,MAAM,EACFC,uBAAuB,KAAK,EAC/B,GAAGD;IAEJ,MAAMH,SAASL,UAAUA,CAACC;IAE1B,IAAI,CAACI,UAAU,CAACI,sBAAsB;QAClC,MAAM,IAAIC,MAAM;IACpB;IAEA,OAAOL;AACX"}

package/dist/react/index.d.ts

@@ -1,3 +1,3 @@
 export * from "../js/index.ts";
-export { MixpanelProvider, useMixpanelClient } from "./MixpanelContext.tsx";
+export { MixpanelProvider, useMixpanelClient, type UseMixpanelClientOptions } from "./MixpanelContext.tsx";
 export { useTrackingFunction, type UseTrackingFunctionOptions } from "./useTrackingFunction.ts";

package/dist/react/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"react/index.js","sources":["webpack://@workleap/mixpanel/./src/react/index.ts"],"sourcesContent":["export * from \"../js/index.ts\";\nexport { MixpanelProvider, useMixpanelClient } from \"./MixpanelContext.tsx\";\nexport { useTrackingFunction, type UseTrackingFunctionOptions } from \"./useTrackingFunction.ts\";\n\n"],"names":["MixpanelProvider","useMixpanelClient","useTrackingFunction"],"mappings":";;;;;;;;;AAA+B;AAC6C;AACoB"}
+{"version":3,"file":"react/index.js","sources":["webpack://@workleap/mixpanel/./src/react/index.ts"],"sourcesContent":["export * from \"../js/index.ts\";\nexport { MixpanelProvider, useMixpanelClient, type UseMixpanelClientOptions } from \"./MixpanelContext.tsx\";\nexport { useTrackingFunction, type UseTrackingFunctionOptions } from \"./useTrackingFunction.ts\";\n\n"],"names":["MixpanelProvider","useMixpanelClient","useTrackingFunction"],"mappings":";;;;;;;;;AAA+B;AAC4E;AACX"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@workleap/mixpanel",
   "author": "Workleap",
-  "version": "4.0.2",
+  "version": "4.0.3",
   "description": "A package containing utilities for Mixpanel telemetry.",
   "license": "Apache-2.0",
   "repository": {
@@ -35,7 +35,7 @@
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0",
     "react-dom": "^18.0.0 || ^19.0.0",
-    "@workleap/logrocket": "2.1.2"
+    "@workleap/logrocket": "2.1.3"
   },
   "peerDependenciesMeta": {
     "@workleap/logrocket": {

package/src/js/MixpanelClient.ts

@@ -1,4 +1,4 @@
-import type { CreateMixpanelTrackingFunctionOptions, MixpanelPartialClient, MixpanelTrackingFunction } from "@workleap-telemetry/core";
+import type { CreateMixpanelTrackingFunctionOptions, MixpanelTrackingFunction } from "@workleap-telemetry/core";
 import type { Logger } from "@workleap/logging";
 import { getBaseProperties } from "./properties.ts";
 
@@ -7,7 +7,24 @@ export type MixpanelGlobalEventProperties = Map<string, unknown>;
 /**
  * @see {@link https://workleap.github.io/wl-telemetry}
  */
-export class MixpanelClient implements MixpanelPartialClient {
+export interface MixpanelClient {
+    /**
+     * @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;
+}
+
+export class MixpanelClientImpl implements MixpanelClient {
     readonly #productId: string;
     readonly #endpoint: string;
     readonly #globalEventProperties: MixpanelGlobalEventProperties;
@@ -22,9 +39,6 @@ export class MixpanelClient implements MixpanelPartialClient {
 
     // IMPORTANT: If you update this method, make sure to update the MixpanelPartialClient
     // interface as well in @workleap-telemetry/core.
-    /**
-     * @see {@link https://workleap.github.io/wl-telemetry}
-     */
     createTrackingFunction(options: CreateMixpanelTrackingFunctionOptions = {}) {
         const {
             targetProductId
@@ -69,16 +83,10 @@ export class MixpanelClient implements MixpanelPartialClient {
         return trackFunction;
     }
 
-    /**
-     * @see {@link https://workleap.github.io/wl-telemetry}
-     */
     setGlobalEventProperty(key: string, value: unknown) {
         this.#globalEventProperties.set(key, value);
     }
 
-    /**
-     * @see {@link https://workleap.github.io/wl-telemetry}
-     */
     setGlobalEventProperties(values: Record<string, unknown>) {
         Object.keys(values).forEach(x => {
             this.#globalEventProperties.set(x, values[x]);

package/src/js/NoopMixpanelClient.ts

@@ -1,7 +1,10 @@
-import type { MixpanelPartialClient } from "@workleap-telemetry/core";
+import type { MixpanelClient } from "./MixpanelClient.ts";
 
-export class NoopMixpanelClient implements MixpanelPartialClient {
+export class NoopMixpanelClient implements MixpanelClient {
     createTrackingFunction() {
         return () => Promise.resolve();
     }
+
+    setGlobalEventProperty() {}
+    setGlobalEventProperties() {}
 }

package/src/js/index.ts

@@ -3,6 +3,6 @@ export type { CreateMixpanelTrackingFunctionOptions, MixpanelEventProperties, Mi
 export { createTrackingFunction } from "./createTrackingFunction.ts";
 export type { MixpanelEnvironment } from "./env.ts";
 export { initializeMixpanel, type InitializeMixpanelOptions } from "./initializeMixpanel.ts";
-export { MixpanelClient, type MixpanelGlobalEventProperties } from "./MixpanelClient.ts";
+export type { MixpanelClient, MixpanelGlobalEventProperties } from "./MixpanelClient.ts";
 export { NoopMixpanelClient } from "./NoopMixpanelClient.ts";
 

package/src/js/initializeMixpanel.ts

@@ -2,7 +2,7 @@ import { HasExecutedGuard, type LogRocketInstrumentationPartialClient, type Tele
 import { createCompositeLogger, type Logger, type RootLogger } from "@workleap/logging";
 import { setMixpanelContext } from "./context.ts";
 import { getTrackingEndpoint, type MixpanelEnvironment } from "./env.ts";
-import { MixpanelClient, type MixpanelGlobalEventProperties } from "./MixpanelClient.ts";
+import { type MixpanelClient, MixpanelClientImpl, type MixpanelGlobalEventProperties } from "./MixpanelClient.ts";
 import { getTelemetryProperties, OtherProperties } from "./properties.ts";
 
 // DEPRECATED: Grace period ends on January 1th 2026.
@@ -130,7 +130,10 @@ export class MixpanelInitializer {
 
         logger.information("[mixpanel] Mixpanel is initialized.");
 
-        return new MixpanelClient(productId, endpoint, this.#globalEventProperties, logger);
+        const client = new MixpanelClientImpl(productId, endpoint, this.#globalEventProperties, logger);
+
+        // The cast is to normalize the inferred return type to the "LogRocketInstrumentationClient" type.
+        return client as MixpanelClient;
     }
 }
 

package/src/react/MixpanelContext.tsx

@@ -1,13 +1,13 @@
-import type { MixpanelPartialClient } from "@workleap-telemetry/core";
 import { createContext, type PropsWithChildren, useContext } from "react";
+import type { MixpanelClient } from "../js/MixpanelClient.ts";
 
-export const MixpanelContext = createContext<MixpanelPartialClient | undefined>(undefined);
+export const MixpanelContext = createContext<MixpanelClient | undefined>(undefined);
 
 /**
  * @see {@link https://workleap.github.io/wl-telemetry}
  */
 export interface MixpanelProviderProps extends PropsWithChildren {
-    client: MixpanelPartialClient;
+    client: MixpanelClient;
 }
 
 /**
@@ -26,14 +26,28 @@ export function MixpanelProvider(props: MixpanelProviderProps) {
     );
 }
 
+export interface UseMixpanelClientOptions {
+    /**
+     * Whether or not an exception should be thrown if the client hasn't been provided.
+     */
+    dontThrowOnUndefined?: boolean;
+}
+
+export function useMixpanelClient(options?: { dontThrowOnUndefined?: false }): MixpanelClient;
+export function useMixpanelClient(options: { dontThrowOnUndefined: true }): MixpanelClient | undefined;
+
 /**
  * Retrieve the Mixpanel client.
  * @see {@link https://workleap.github.io/wl-telemetry}
  */
-export function useMixpanelClient() {
+export function useMixpanelClient(options: UseMixpanelClientOptions = {}) {
+    const {
+        dontThrowOnUndefined = false
+    } = options;
+
     const client = useContext(MixpanelContext);
 
-    if (!client) {
+    if (!client && !dontThrowOnUndefined) {
         throw new Error("[mixpanel] The useMixpanelClient function is called before a MixpanelClient instance has been provided.");
     }
 

package/src/react/index.ts

@@ -1,4 +1,4 @@
 export * from "../js/index.ts";
-export { MixpanelProvider, useMixpanelClient } from "./MixpanelContext.tsx";
+export { MixpanelProvider, useMixpanelClient, type UseMixpanelClientOptions } from "./MixpanelContext.tsx";
 export { useTrackingFunction, type UseTrackingFunctionOptions } from "./useTrackingFunction.ts";