@workleap/mixpanel 4.0.8 → 5.0.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @workleap/mixpanel
 
+## 5.0.0
+
+### Major Changes
+
+- [#150](https://github.com/workleap/wl-telemetry/pull/150) [`133e534`](https://github.com/workleap/wl-telemetry/commit/133e53429453d821086574789e29437001a3c0d5) Thanks [@patricklafrance](https://github.com/patricklafrance)! - Remove deprecated global variables and functions. Updated `initializeMixpanel` signature with breaking changes. View [migration documentation](https://workleap.github.io/wl-telemetry/updating/mixpanel/migrate-to-v4.0/).
+
+### Patch Changes
+
+- Updated dependencies [[`133e534`](https://github.com/workleap/wl-telemetry/commit/133e53429453d821086574789e29437001a3c0d5), [`133e534`](https://github.com/workleap/wl-telemetry/commit/133e53429453d821086574789e29437001a3c0d5)]:
+  - @workleap-telemetry/core@2.0.0
+  - @workleap/logrocket@3.0.0
+
+## 4.0.9
+
+### Patch Changes
+
+- [#148](https://github.com/workleap/wl-telemetry/pull/148) [`1c81d0a`](https://github.com/workleap/wl-telemetry/commit/1c81d0aa6e8ea5793b34a76a491c837748c7612b) Thanks [@patricklafrance](https://github.com/patricklafrance)! - Bumped dependencies.
+
+- Updated dependencies [[`1c81d0a`](https://github.com/workleap/wl-telemetry/commit/1c81d0aa6e8ea5793b34a76a491c837748c7612b)]:
+  - @workleap/logrocket@2.1.9
+  - @workleap-telemetry/core@1.0.8
+
 ## 4.0.8
 
 ### Patch Changes

package/dist/js/MixpanelClient.d.ts

@@ -1,6 +1,5 @@
 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}
  */
@@ -8,7 +7,7 @@ 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}
      */
@@ -18,9 +17,18 @@ export interface MixpanelClient {
      */
     setGlobalEventProperties: (values: Record<string, unknown>) => void;
 }
+/**
+ * @see {@link https://workleap.github.io/wl-telemetry}
+ */
+export interface MixpanelClientOptions {
+    /**
+     * @see {@link https://workleap.github.io/wl-telemetry}
+     */
+    productId?: string;
+}
 export declare class MixpanelClientImpl implements MixpanelClient {
     #private;
-    constructor(productId: string, endpoint: string, globalEventProperties: MixpanelGlobalEventProperties, logger: Logger);
+    constructor(endpoint: string, logger: Logger, options?: MixpanelClientOptions);
     createTrackingFunction(options?: CreateMixpanelTrackingFunctionOptions): MixpanelTrackingFunction;
     setGlobalEventProperty(key: string, value: unknown): void;
     setGlobalEventProperties(values: Record<string, unknown>): void;

package/dist/js/MixpanelClient.js

@@ -5,20 +5,20 @@ import { getBaseProperties } from "./properties.js";
 ;// CONCATENATED MODULE: ./src/js/MixpanelClient.ts
 
 class MixpanelClientImpl {
-    #productId;
+    #globalEventProperties = new Map();
     #endpoint;
-    #globalEventProperties;
     #logger;
-    constructor(productId, endpoint, globalEventProperties, logger){
-        this.#productId = productId;
+    #productId;
+    constructor(endpoint, logger, options = {}){
+        const { productId } = options;
         this.#endpoint = endpoint;
-        this.#globalEventProperties = globalEventProperties;
         this.#logger = logger;
+        this.#productId = productId;
     }
     // IMPORTANT: If you update this method, make sure to update the MixpanelPartialClient
     // interface as well in @workleap-telemetry/core.
     createTrackingFunction(options = {}) {
-        const { targetProductId } = options;
+        const { productId, targetProductId, additionalProperties = {} } = options;
         const trackFunction = async (eventName, properties, _options = {})=>{
             try {
                 const { keepAlive = false } = _options;
@@ -26,6 +26,7 @@ class MixpanelClientImpl {
                 const allProperties = {
                     ...baseProperties,
                     ...Object.fromEntries(this.#globalEventProperties),
+                    ...additionalProperties,
                     ...properties
                 };
                 await fetch(this.#endpoint, {
@@ -37,7 +38,7 @@ class MixpanelClientImpl {
                     },
                     body: JSON.stringify({
                         eventName,
-                        productIdentifier: this.#productId,
+                        productIdentifier: productId ?? this.#productId,
                         // Not sure why, but it seems important to send "null" if not target product identifier
                         // are provided.
                         targetProductIdentifier: targetProductId ?? null,

package/dist/js/MixpanelClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"js/MixpanelClient.js","sources":["../../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,yBAAyBF,mBAAmB;wBAC5C,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"}
+{"version":3,"file":"js/MixpanelClient.js","sources":["../../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\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     * @see {@link https://workleap.github.io/wl-telemetry}\n     */\n    setGlobalEventProperty: (key: string, value: unknown) => void;\n    /**\n     * @see {@link https://workleap.github.io/wl-telemetry}\n     */\n    setGlobalEventProperties: (values: Record<string, unknown>) => void;\n}\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport interface MixpanelClientOptions {\n    /**\n     * @see {@link https://workleap.github.io/wl-telemetry}\n     */\n    productId?: string;\n}\n\nexport class MixpanelClientImpl implements MixpanelClient {\n    readonly #globalEventProperties = new Map<string, unknown>();\n    readonly #endpoint: string;\n    readonly #logger: Logger;\n    readonly #productId?: string;\n\n    constructor(endpoint: string, logger: Logger, options: MixpanelClientOptions = {}) {\n        const {\n            productId\n        } = options;\n\n        this.#endpoint = endpoint;\n        this.#logger = logger;\n        this.#productId = productId;\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            productId,\n            targetProductId,\n            additionalProperties = {}\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                    ...additionalProperties,\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: productId ?? 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","Map","endpoint","logger","options","productId","targetProductId","additionalProperties","trackFunction","eventName","properties","_options","keepAlive","baseProperties","allProperties","Object","fetch","JSON","error","key","value","values","x"],"mappings":";;;;;AAEoD;AA8B7C,MAAMC;IACA,sBAAsB,GAAG,IAAIC,MAAuB;IACpD,SAAS,CAAS;IAClB,OAAO,CAAS;IAChB,UAAU,CAAU;IAE7B,YAAYC,QAAgB,EAAEC,MAAc,EAAEC,UAAiC,CAAC,CAAC,CAAE;QAC/E,MAAM,EACFC,SAAS,EACZ,GAAGD;QAEJ,IAAI,CAAC,SAAS,GAAGF;QACjB,IAAI,CAAC,OAAO,GAAGC;QACf,IAAI,CAAC,UAAU,GAAGE;IACtB;IAEA,sFAAsF;IACtF,iDAAiD;IACjD,uBAAuBD,UAAiD,CAAC,CAAC,EAAE;QACxE,MAAM,EACFC,SAAS,EACTC,eAAe,EACfC,uBAAuB,CAAC,CAAC,EAC5B,GAAGH;QAEJ,MAAMI,gBAA0C,OAAOC,WAAWC,YAAYC,WAAW,CAAC,CAAC;YACvF,IAAI;gBACA,MAAM,EACFC,YAAY,KAAK,EACpB,GAAGD;gBAEJ,MAAME,iBAAiBd,iBAAiBA;gBAExC,MAAMe,gBAAgB;oBAClB,GAAGD,cAAc;oBACjB,GAAGE,OAAO,WAAW,CAAC,IAAI,CAAC,sBAAsB,CAAC;oBAClD,GAAGR,oBAAoB;oBACvB,GAAGG,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,mBAAmBJ,aAAa,IAAI,CAAC,UAAU;wBAC/C,uFAAuF;wBACvF,gBAAgB;wBAChB,yBAAyBC,mBAAmB;wBAC5C,YAAYQ;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/index.d.ts

@@ -1,7 +1,6 @@
 export { createTelemetryContext, type CreateTelemetryContextOptions, type TelemetryContext } from "@workleap-telemetry/core";
 export type { CreateMixpanelTrackingFunctionOptions, MixpanelEventProperties, MixpanelTrackingFunction, MixpanelTrackingFunctionOptions } from "@workleap-telemetry/core";
-export { createTrackingFunction } from "./createTrackingFunction.ts";
 export type { MixpanelEnvironment } from "./env.ts";
 export { initializeMixpanel, type InitializeMixpanelOptions } from "./initializeMixpanel.ts";
-export type { MixpanelClient, MixpanelGlobalEventProperties } from "./MixpanelClient.ts";
+export type { MixpanelClient } from "./MixpanelClient.ts";
 export { NoopMixpanelClient } from "./NoopMixpanelClient.ts";

package/dist/js/index.js

@@ -1,12 +1,9 @@
 import { createTelemetryContext } from "@workleap-telemetry/core";
-import { createTrackingFunction } from "./createTrackingFunction.js";
 import { initializeMixpanel } from "./initializeMixpanel.js";
 import { NoopMixpanelClient } from "./NoopMixpanelClient.js";
 
 ;// CONCATENATED MODULE: external "@workleap-telemetry/core"
 
-;// CONCATENATED MODULE: external "./createTrackingFunction.js"
-
 ;// CONCATENATED MODULE: external "./initializeMixpanel.js"
 
 ;// CONCATENATED MODULE: external "./NoopMixpanelClient.js"
@@ -16,7 +13,6 @@ import { NoopMixpanelClient } from "./NoopMixpanelClient.js";
 
 
 
-
-export { NoopMixpanelClient, createTelemetryContext, createTrackingFunction, initializeMixpanel };
+export { NoopMixpanelClient, createTelemetryContext, initializeMixpanel };
 
 //# sourceMappingURL=index.js.map

package/dist/js/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"js/index.js","sources":["../../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"}
+{"version":3,"file":"js/index.js","sources":["../../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 type { MixpanelEnvironment } from \"./env.ts\";\nexport { initializeMixpanel, type InitializeMixpanelOptions } from \"./initializeMixpanel.ts\";\nexport type { MixpanelClient } from \"./MixpanelClient.ts\";\nexport { NoopMixpanelClient } from \"./NoopMixpanelClient.ts\";\n\n"],"names":["createTelemetryContext","initializeMixpanel","NoopMixpanelClient"],"mappings":";;;;;;;;;;;AAA6H;AAGhC;AAEhC"}

package/dist/js/initializeMixpanel.d.ts

@@ -1,13 +1,17 @@
 import { type LogRocketInstrumentationPartialClient, type TelemetryContext } from "@workleap-telemetry/core";
 import { type RootLogger } from "@workleap/logging";
 import { type MixpanelEnvironment } from "./env.ts";
-import { type MixpanelClient, type MixpanelGlobalEventProperties } from "./MixpanelClient.ts";
-export declare const IsInitializedVariableName = "__WLP_MIXPANEL_IS_INITIALIZED__";
+import { type MixpanelClient } from "./MixpanelClient.ts";
 export declare function __resetRegistrationGuard(): void;
 /**
  * @see {@link https://workleap.github.io/wl-telemetry}
  */
 export interface InitializeMixpanelOptions {
+    /**
+     * An optional product id that will be attached to every event.
+     * @see {@link https://workleap.github.io/wl-telemetry}
+     */
+    productId?: string;
     /**
      * An optional tracking endpoint.
      * @default "tracking/track"
@@ -37,16 +41,13 @@ export interface InitializeMixpanelOptions {
     loggers?: RootLogger[];
 }
 export declare class MixpanelInitializer {
-    #private;
-    constructor(globalEventProperties: MixpanelGlobalEventProperties);
-    initialize(productId: string, envOrTrackingApiBaseUrl: MixpanelEnvironment | (string & {}), options?: InitializeMixpanelOptions): MixpanelClient;
+    initialize(envOrTrackingApiBaseUrl: MixpanelEnvironment | (string & {}), options?: Omit<InitializeMixpanelOptions, "globalEventProperties">): MixpanelClient;
 }
 /**
  * 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}
  */
-export declare function initializeMixpanel(productId: string, envOrTrackingApiBaseUrl: MixpanelEnvironment | (string & {}), options?: InitializeMixpanelOptions): MixpanelClient;
+export declare function initializeMixpanel(envOrTrackingApiBaseUrl: MixpanelEnvironment | (string & {}), options?: InitializeMixpanelOptions): MixpanelClient;

package/dist/js/initializeMixpanel.js

@@ -1,6 +1,5 @@
 import { HasExecutedGuard } from "@workleap-telemetry/core";
 import { createCompositeLogger } from "@workleap/logging";
-import { setMixpanelContext } from "./context.js";
 import { getTrackingEndpoint } from "./env.js";
 import { MixpanelClientImpl } from "./MixpanelClient.js";
 import { OtherProperties, getTelemetryProperties } from "./properties.js";
@@ -9,8 +8,6 @@ import { OtherProperties, getTelemetryProperties } from "./properties.js";
 
 ;// CONCATENATED MODULE: external "@workleap/logging"
 
-;// CONCATENATED MODULE: external "./context.js"
-
 ;// CONCATENATED MODULE: external "./env.js"
 
 ;// CONCATENATED MODULE: external "./MixpanelClient.js"
@@ -23,26 +20,6 @@ import { OtherProperties, getTelemetryProperties } from "./properties.js";
 
 
 
-
-// DEPRECATED: Grace period ends on January 1th 2026.
-// Don't forget to remove the tests as well.
-const IsInitializedVariableName = "__WLP_MIXPANEL_IS_INITIALIZED__";
-// DEPRECATED: Grace period ends on January 1th 2026.
-function registerDeprecatedContextAndGlobalVariables(productId, endpoint, globalEventProperties, logger) {
-    setMixpanelContext({
-        productId,
-        endpoint,
-        globalEventProperties,
-        logger
-    });
-    // Indicates to the host applications that Mixpanel has been initialized.
-    // It's useful in cases where an "add-on", like the platform widgets needs
-    // to know whether or not the host application is using Mixpanel.
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore
-    globalThis[IsInitializedVariableName] = true;
-}
-///////////////////////////
 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..
@@ -59,18 +36,18 @@ function __resetRegistrationGuard() {
     }
 }
 class MixpanelInitializer {
-    #globalEventProperties;
-    constructor(globalEventProperties){
-        this.#globalEventProperties = globalEventProperties;
-    }
-    initialize(productId, envOrTrackingApiBaseUrl, options = {}) {
-        const { trackingEndpoint, telemetryContext, logRocketInstrumentationClient, verbose = false, loggers = [] } = options;
+    initialize(envOrTrackingApiBaseUrl, options = {}) {
+        const { productId, trackingEndpoint, telemetryContext, logRocketInstrumentationClient, verbose = false, loggers = [] } = options;
         const logger = createCompositeLogger(verbose, loggers);
         const endpoint = getTrackingEndpoint(envOrTrackingApiBaseUrl, trackingEndpoint);
+        logger.information("[mixpanel] Mixpanel is initialized.");
+        const client = new MixpanelClientImpl(endpoint, logger, {
+            productId
+        });
         // 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);
+                client.setGlobalEventProperty(key, value);
             }
         }
         // If a LogRocket client is already available, register a listener to get the LogRocket session url
@@ -78,28 +55,24 @@ class MixpanelInitializer {
         if (logRocketInstrumentationClient) {
             logRocketInstrumentationClient.registerGetSessionUrlListener((sessionUrl)=>{
                 logger.withText("[mixpanel] Received LogRocket session replay URL:").withText(sessionUrl).debug();
-                this.#globalEventProperties.set(OtherProperties.LogRocketSessionUrl, sessionUrl);
+                client.setGlobalEventProperty(OtherProperties.LogRocketSessionUrl, sessionUrl);
             });
         }
-        registerDeprecatedContextAndGlobalVariables(productId, endpoint, this.#globalEventProperties, logger);
-        logger.information("[mixpanel] Mixpanel is initialized.");
-        const client = new MixpanelClientImpl(productId, endpoint, this.#globalEventProperties, logger);
         // The cast is to normalize the inferred return type to the "LogRocketInstrumentationClient" type.
         return client;
     }
 }
 /**
  * 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) {
+ */ function initializeMixpanel(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);
+    return new MixpanelInitializer().initialize(envOrTrackingApiBaseUrl, options);
 }
 
-export { IsInitializedVariableName, MixpanelInitializer, __resetRegistrationGuard, initializeMixpanel };
+export { MixpanelInitializer, __resetRegistrationGuard, initializeMixpanel };
 
 //# sourceMappingURL=initializeMixpanel.js.map

package/dist/js/initializeMixpanel.js.map

@@ -1 +1 @@
-{"version":3,"file":"js/initializeMixpanel.js","sources":["../../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\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;AAqCO,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"}
+{"version":3,"file":"js/initializeMixpanel.js","sources":["../../src/js/initializeMixpanel.ts"],"sourcesContent":["import { HasExecutedGuard, type LogRocketInstrumentationPartialClient, type TelemetryContext } from \"@workleap-telemetry/core\";\nimport { createCompositeLogger, type RootLogger } from \"@workleap/logging\";\nimport { getTrackingEndpoint, type MixpanelEnvironment } from \"./env.ts\";\nimport { MixpanelClientImpl, type MixpanelClient } from \"./MixpanelClient.ts\";\nimport { getTelemetryProperties, OtherProperties } from \"./properties.ts\";\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 product id that will be attached to every event.\n     * @see {@link https://workleap.github.io/wl-telemetry}\n     */\n    productId?: string;\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\nexport class MixpanelInitializer {\n    initialize(envOrTrackingApiBaseUrl: MixpanelEnvironment | (string & {}), options: Omit<InitializeMixpanelOptions, \"globalEventProperties\"> = {}) {\n        const {\n            productId,\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        logger.information(\"[mixpanel] Mixpanel is initialized.\");\n\n        const client = new MixpanelClientImpl(endpoint, logger, {\n            productId\n        });\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                client.setGlobalEventProperty(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                client.setGlobalEventProperty(OtherProperties.LogRocketSessionUrl, sessionUrl);\n            });\n        }\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 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    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().initialize(\n        envOrTrackingApiBaseUrl,\n        options\n    );\n}\n"],"names":["HasExecutedGuard","createCompositeLogger","getTrackingEndpoint","MixpanelClientImpl","getTelemetryProperties","OtherProperties","registrationGuardInstance","getRegistrationGuard","__resetRegistrationGuard","MixpanelInitializer","envOrTrackingApiBaseUrl","options","productId","trackingEndpoint","telemetryContext","logRocketInstrumentationClient","verbose","loggers","logger","endpoint","client","key","value","Object","sessionUrl","initializeMixpanel"],"mappings":";;;;;;;;;;;;;;;;;AAA+H;AACpD;AACF;AACK;AACJ;AAE1E,IAAIM;AAEJ,yEAAyE;AACzE,+DAA+D;AAC/D,SAASC;IACL,IAAI,CAACD,2BAA2B;QAC5BA,4BAA4B,IAAIN,gBAAgBA;IACpD;IAEA,OAAOM;AACX;AAEA,8CAA8C;AACvC,SAASE;IACZ,IAAIF,2BAA2B;QAC3BA,0BAA0B,KAAK;IACnC;AACJ;AA0CO,MAAMG;IACT,WAAWC,uBAA4D,EAAEC,UAAoE,CAAC,CAAC,EAAE;QAC7I,MAAM,EACFC,SAAS,EACTC,gBAAgB,EAChBC,gBAAgB,EAChBC,8BAA8B,EAC9BC,UAAU,KAAK,EACfC,UAAU,EAAE,EACf,GAAGN;QAEJ,MAAMO,SAASjB,qBAAqBA,CAACe,SAASC;QAC9C,MAAME,WAAWjB,mBAAmBA,CAACQ,yBAAyBG;QAE9DK,OAAO,WAAW,CAAC;QAEnB,MAAME,SAAS,IAAIjB,kBAAkBA,CAACgB,UAAUD,QAAQ;YACpDN;QACJ;QAEA,6DAA6D;QAC7D,IAAIE,kBAAkB;YAClB,KAAK,MAAM,CAACO,KAAKC,MAAM,IAAIC,OAAO,OAAO,CAACnB,sBAAsBA,CAACU,mBAAoB;gBACjFM,OAAO,sBAAsB,CAACC,KAAKC;YACvC;QACJ;QAEA,mGAAmG;QACnG,yDAAyD;QACzD,IAAIP,gCAAgC;YAChCA,+BAA+B,6BAA6B,CAAC,CAACS;gBAC1DN,OACK,QAAQ,CAAC,qDACT,QAAQ,CAACM,YACT,KAAK;gBAEVJ,OAAO,sBAAsB,CAACf,mCAAmC,EAAEmB;YACvE;QACJ;QAEA,kGAAkG;QAClG,OAAOJ;IACX;AACJ;AAEA;;;;;;CAMC,GACM,SAASK,mBACZf,uBAA4D,EAC5DC,OAAmC;IAEnCJ,uBAAuB,KAAK,CAAC;IAE7B,OAAO,IAAIE,sBAAsB,UAAU,CACvCC,yBACAC;AAER"}

package/dist/react/MixpanelPropertiesProvider.d.ts

@@ -0,0 +1,18 @@
+import { type PropsWithChildren } from "react";
+/**
+ * @see {@link https://workleap.github.io/wl-telemetry}
+ */
+export interface MixpanelPropertiesProviderProps extends PropsWithChildren {
+    value: Record<string, unknown>;
+}
+/**
+ * Define Mixpanel properties that will be passed down to nested "useTrackingFunction" or "useMixpanelTrackingFunction" hook.
+ * @see {@link https://workleap.github.io/wl-telemetry}
+ */
+export declare function MixpanelPropertiesProvider(props: MixpanelPropertiesProviderProps): import("react/jsx-runtime").JSX.Element;
+/**
+ * Retrieve the Mixpanel properties from all parent providers.
+ * @returns The context value or an empty object literal if no provider isdefined.
+ * @see {@link https://workleap.github.io/wl-telemetry}
+ */
+export declare const useMixpanelProviderProperties: () => Record<string, unknown>;

package/dist/react/MixpanelPropertiesProvider.js

@@ -0,0 +1,40 @@
+import { jsx } from "react/jsx-runtime";
+import { createContext, useContext, useMemo } from "react";
+
+;// CONCATENATED MODULE: external "react/jsx-runtime"
+
+;// CONCATENATED MODULE: external "react"
+
+;// CONCATENATED MODULE: ./src/react/MixpanelPropertiesProvider.tsx
+
+
+const MixpanelPropertiesContext = /*#__PURE__*/ createContext({});
+/**
+ * Define Mixpanel properties that will be passed down to nested "useTrackingFunction" or "useMixpanelTrackingFunction" hook.
+ * @see {@link https://workleap.github.io/wl-telemetry}
+ */ function MixpanelPropertiesProvider(props) {
+    const { value, children } = props;
+    const parentContext = useContext(MixpanelPropertiesContext);
+    const contextValue = useMemo(()=>({
+            ...parentContext,
+            ...value
+        }), [
+        parentContext,
+        value
+    ]);
+    return /*#__PURE__*/ jsx(MixpanelPropertiesContext.Provider, {
+        value: contextValue,
+        children: children
+    });
+}
+/**
+ * Retrieve the Mixpanel properties from all parent providers.
+ * @returns The context value or an empty object literal if no provider isdefined.
+ * @see {@link https://workleap.github.io/wl-telemetry}
+ */ const useMixpanelProviderProperties = ()=>{
+    return useContext(MixpanelPropertiesContext);
+};
+
+export { MixpanelPropertiesProvider, useMixpanelProviderProperties };
+
+//# sourceMappingURL=MixpanelPropertiesProvider.js.map

package/dist/react/MixpanelPropertiesProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"react/MixpanelPropertiesProvider.js","sources":["../../src/react/MixpanelPropertiesProvider.tsx"],"sourcesContent":["import { createContext, type PropsWithChildren, useContext, useMemo } from \"react\";\n\nconst MixpanelPropertiesContext = createContext<Record<string, unknown>>({});\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport interface MixpanelPropertiesProviderProps extends PropsWithChildren {\n    value: Record<string, unknown>;\n}\n\n/**\n * Define Mixpanel properties that will be passed down to nested \"useTrackingFunction\" or \"useMixpanelTrackingFunction\" hook.\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport function MixpanelPropertiesProvider(props: MixpanelPropertiesProviderProps) {\n    const {\n        value,\n        children\n    } = props;\n\n    const parentContext = useContext(MixpanelPropertiesContext);\n\n    const contextValue = useMemo(() => ({\n        ...parentContext,\n        ...value\n    }), [parentContext, value]);\n\n    return (\n        <MixpanelPropertiesContext.Provider value={contextValue}>\n            {children}\n        </MixpanelPropertiesContext.Provider>\n    );\n}\n\n/**\n * Retrieve the Mixpanel properties from all parent providers.\n * @returns The context value or an empty object literal if no provider isdefined.\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport const useMixpanelProviderProperties = () => {\n    return useContext(MixpanelPropertiesContext);\n};\n"],"names":["createContext","useContext","useMemo","MixpanelPropertiesContext","MixpanelPropertiesProvider","props","value","children","parentContext","contextValue","useMixpanelProviderProperties"],"mappings":";;;;;;;;;AAAmF;AAEnF,MAAMG,0CAA4BH,aAAaA,CAA0B,CAAC;AAS1E;;;CAGC,GACM,SAASI,2BAA2BC,KAAsC;IAC7E,MAAM,EACFC,KAAK,EACLC,QAAQ,EACX,GAAGF;IAEJ,MAAMG,gBAAgBP,UAAUA,CAACE;IAEjC,MAAMM,eAAeP,OAAOA,CAAC,IAAO;YAChC,GAAGM,aAAa;YAChB,GAAGF,KAAK;QACZ,IAAI;QAACE;QAAeF;KAAM;IAE1B,qBACI,IAACH,0BAA0B,QAAQ;QAAC,OAAOM;kBACtCF;;AAGb;AAEA;;;;CAIC,GACM,MAAMG,gCAAgC;IACzC,OAAOT,UAAUA,CAACE;AACtB,EAAE"}

package/dist/react/index.d.ts

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

package/dist/react/index.js

@@ -1,9 +1,12 @@
 import { MixpanelProvider, useMixpanelClient } from "./MixpanelContext.js";
+import { MixpanelPropertiesProvider, useMixpanelProviderProperties } from "./MixpanelPropertiesProvider.js";
 import { useTrackingFunction } from "./useTrackingFunction.js";
 export * from "../js/index.js";
 
 ;// CONCATENATED MODULE: external "./MixpanelContext.js"
 
+;// CONCATENATED MODULE: external "./MixpanelPropertiesProvider.js"
+
 ;// CONCATENATED MODULE: external "./useTrackingFunction.js"
 
 ;// CONCATENATED MODULE: ./src/react/index.ts
@@ -11,6 +14,7 @@ export * from "../js/index.js";
 
 
 
-export { MixpanelProvider, useMixpanelClient, useTrackingFunction };
+
+export { MixpanelPropertiesProvider, MixpanelProvider, useMixpanelClient, useMixpanelProviderProperties, useTrackingFunction };
 
 //# sourceMappingURL=index.js.map

package/dist/react/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"react/index.js","sources":["../../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"}
+{"version":3,"file":"react/index.js","sources":["../../src/react/index.ts"],"sourcesContent":["export * from \"../js/index.ts\";\nexport { MixpanelProvider, useMixpanelClient, type UseMixpanelClientOptions } from \"./MixpanelContext.tsx\";\nexport { MixpanelPropertiesProvider, useMixpanelProviderProperties, type MixpanelPropertiesProviderProps } from \"./MixpanelPropertiesProvider.tsx\";\nexport { useTrackingFunction, type UseTrackingFunctionOptions } from \"./useTrackingFunction.ts\";\n\n"],"names":["MixpanelProvider","useMixpanelClient","MixpanelPropertiesProvider","useMixpanelProviderProperties","useTrackingFunction"],"mappings":";;;;;;;;;;;;AAA+B;AAC4E;AACwC;AACnD"}

package/dist/react/useTrackingFunction.js

@@ -1,13 +1,13 @@
-import { useContext, useMemo } from "react";
-import { createTrackingFunction } from "../js/createTrackingFunction.js";
-import { MixpanelContext } from "./MixpanelContext.js";
+import { useMemo } from "react";
+import { useMixpanelClient } from "./MixpanelContext.js";
+import { useMixpanelProviderProperties } from "./MixpanelPropertiesProvider.js";
 
 ;// CONCATENATED MODULE: external "react"
 
-;// CONCATENATED MODULE: external "../js/createTrackingFunction.js"
-
 ;// CONCATENATED MODULE: external "./MixpanelContext.js"
 
+;// CONCATENATED MODULE: external "./MixpanelPropertiesProvider.js"
+
 ;// CONCATENATED MODULE: ./src/react/useTrackingFunction.ts
 
 
@@ -16,19 +16,21 @@ import { MixpanelContext } from "./MixpanelContext.js";
  * Create a Mixpanel tracking function.
  * @see {@link https://workleap.github.io/wl-telemetry}
  */ function useTrackingFunction(options = {}) {
-    const { targetProductId } = options;
-    const client = useContext(MixpanelContext);
+    const { productId, targetProductId } = options;
+    const client = useMixpanelClient();
+    const additionalProperties = useMixpanelProviderProperties();
     return useMemo(()=>{
         const trackOptions = {
-            targetProductId
+            productId,
+            targetProductId,
+            additionalProperties
         };
-        // DEPRECATED: Grace period ends on January 1th 2026.
-        // After the grace period, only create the tracking function from the client, remove the fallback
-        // and also use "useMixpanelClient" to retrieve the client rather than "useContext".
-        return client ? client.createTrackingFunction(trackOptions) : createTrackingFunction(trackOptions);
+        return client.createTrackingFunction(trackOptions);
     }, [
         client,
-        targetProductId
+        productId,
+        targetProductId,
+        additionalProperties
     ]);
 }
 

package/dist/react/useTrackingFunction.js.map

@@ -1 +1 @@
-{"version":3,"file":"react/useTrackingFunction.js","sources":["../../src/react/useTrackingFunction.ts"],"sourcesContent":["import type { CreateMixpanelTrackingFunctionOptions } from \"@workleap-telemetry/core\";\nimport { useContext, useMemo } from \"react\";\nimport { createTrackingFunction } from \"../js/createTrackingFunction.ts\";\nimport { MixpanelContext } from \"./MixpanelContext.tsx\";\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport type UseTrackingFunctionOptions = CreateMixpanelTrackingFunctionOptions;\n\n/**\n * Create a Mixpanel tracking function.\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport function useTrackingFunction(options: UseTrackingFunctionOptions = {}) {\n    const {\n        targetProductId\n    } = options;\n\n    const client = useContext(MixpanelContext);\n\n    return useMemo(() => {\n        const trackOptions = {\n            targetProductId\n        } satisfies CreateMixpanelTrackingFunctionOptions;\n\n        // DEPRECATED: Grace period ends on January 1th 2026.\n        // After the grace period, only create the tracking function from the client, remove the fallback\n        // and also use \"useMixpanelClient\" to retrieve the client rather than \"useContext\".\n        return client\n            ? client.createTrackingFunction(trackOptions)\n            : createTrackingFunction(trackOptions);\n    }, [client, targetProductId]);\n}\n"],"names":["useContext","useMemo","createTrackingFunction","MixpanelContext","useTrackingFunction","options","targetProductId","client","trackOptions"],"mappings":";;;;;;;;;;;AAC4C;AAC6B;AACjB;AAOxD;;;CAGC,GACM,SAASI,oBAAoBC,UAAsC,CAAC,CAAC;IACxE,MAAM,EACFC,eAAe,EAClB,GAAGD;IAEJ,MAAME,SAASP,UAAUA,CAACG,eAAeA;IAEzC,OAAOF,OAAOA,CAAC;QACX,MAAMO,eAAe;YACjBF;QACJ;QAEA,qDAAqD;QACrD,iGAAiG;QACjG,oFAAoF;QACpF,OAAOC,SACDA,OAAO,sBAAsB,CAACC,gBAC9BN,sBAAsBA,CAACM;IACjC,GAAG;QAACD;QAAQD;KAAgB;AAChC"}
+{"version":3,"file":"react/useTrackingFunction.js","sources":["../../src/react/useTrackingFunction.ts"],"sourcesContent":["import type { CreateMixpanelTrackingFunctionOptions } from \"@workleap-telemetry/core\";\nimport { useMemo } from \"react\";\nimport { useMixpanelClient } from \"./MixpanelContext.tsx\";\nimport { useMixpanelProviderProperties } from \"./MixpanelPropertiesProvider.tsx\";\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport type UseTrackingFunctionOptions = CreateMixpanelTrackingFunctionOptions;\n\n/**\n * Create a Mixpanel tracking function.\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport function useTrackingFunction(options: UseTrackingFunctionOptions = {}) {\n    const {\n        productId,\n        targetProductId\n    } = options;\n\n    const client = useMixpanelClient();\n    const additionalProperties = useMixpanelProviderProperties();\n\n    return useMemo(() => {\n        const trackOptions = {\n            productId,\n            targetProductId,\n            additionalProperties\n        } satisfies CreateMixpanelTrackingFunctionOptions;\n\n        return client.createTrackingFunction(trackOptions);\n    }, [client, productId, targetProductId, additionalProperties]);\n}\n"],"names":["useMemo","useMixpanelClient","useMixpanelProviderProperties","useTrackingFunction","options","productId","targetProductId","client","additionalProperties","trackOptions"],"mappings":";;;;;;;;;;;AACgC;AAC0B;AACuB;AAOjF;;;CAGC,GACM,SAASG,oBAAoBC,UAAsC,CAAC,CAAC;IACxE,MAAM,EACFC,SAAS,EACTC,eAAe,EAClB,GAAGF;IAEJ,MAAMG,SAASN,iBAAiBA;IAChC,MAAMO,uBAAuBN,6BAA6BA;IAE1D,OAAOF,OAAOA,CAAC;QACX,MAAMS,eAAe;YACjBJ;YACAC;YACAE;QACJ;QAEA,OAAOD,OAAO,sBAAsB,CAACE;IACzC,GAAG;QAACF;QAAQF;QAAWC;QAAiBE;KAAqB;AACjE"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@workleap/mixpanel",
   "author": "Workleap",
-  "version": "4.0.8",
+  "version": "5.0.0",
   "description": "A package containing utilities for Mixpanel telemetry.",
   "license": "Apache-2.0",
   "repository": {
@@ -34,7 +34,7 @@
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0",
     "react-dom": "^18.0.0 || ^19.0.0",
-    "@workleap/logrocket": "2.1.8"
+    "@workleap/logrocket": "3.0.0"
   },
   "peerDependenciesMeta": {
     "@workleap/logrocket": {
@@ -48,29 +48,30 @@
     }
   },
   "dependencies": {
-    "@workleap/logging": "^1.3.3",
-    "@workleap-telemetry/core": "1.0.7"
+    "@workleap/logging": "^1.3.6",
+    "@workleap-telemetry/core": "2.0.0"
   },
   "devDependencies": {
     "@eslint/js": "9.39.2",
-    "@rsbuild/core": "1.7.2",
-    "@rslib/core": "0.19.2",
-    "@types/react": "19.2.8",
-    "@typescript-eslint/parser": "8.53.0",
-    "@workleap/eslint-configs": "1.1.9",
-    "@workleap/rslib-configs": "1.1.5",
+    "@rsbuild/core": "1.7.3",
+    "@rslib/core": "0.19.5",
+    "@types/react": "19.2.13",
+    "@typescript-eslint/parser": "8.55.0",
+    "@typescript/native-preview": "7.0.0-dev.20260209.1",
+    "@workleap/eslint-configs": "1.1.12",
+    "@workleap/rslib-configs": "1.1.7",
     "@workleap/typescript-configs": "3.0.7",
     "eslint": "9.39.2",
-    "happy-dom": "20.1.0",
+    "happy-dom": "20.6.0",
     "typescript": "5.9.3",
-    "typescript-eslint": "8.53.0",
-    "vitest": "4.0.17"
+    "typescript-eslint": "8.55.0",
+    "vitest": "4.0.18"
   },
   "sideEffects": false,
   "scripts": {
     "build": "rslib build --config ./rslib.build.ts",
     "eslint": "eslint . --max-warnings=0 --cache --cache-location node_modules/.cache/eslint",
-    "typecheck": "tsc",
+    "typecheck": "tsgo",
     "test": "vitest --config vitest.config.ts --no-watch"
   }
 }

package/src/js/MixpanelClient.ts

@@ -2,8 +2,6 @@ import type { CreateMixpanelTrackingFunctionOptions, MixpanelTrackingFunction }
 import type { Logger } from "@workleap/logging";
 import { getBaseProperties } from "./properties.ts";
 
-export type MixpanelGlobalEventProperties = Map<string, unknown>;
-
 /**
  * @see {@link https://workleap.github.io/wl-telemetry}
  */
@@ -11,37 +9,50 @@ 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;
-
     /**
      * @see {@link https://workleap.github.io/wl-telemetry}
      */
     setGlobalEventProperties: (values: Record<string, unknown>) => void;
 }
 
+/**
+ * @see {@link https://workleap.github.io/wl-telemetry}
+ */
+export interface MixpanelClientOptions {
+    /**
+     * @see {@link https://workleap.github.io/wl-telemetry}
+     */
+    productId?: string;
+}
+
 export class MixpanelClientImpl implements MixpanelClient {
-    readonly #productId: string;
+    readonly #globalEventProperties = new Map<string, unknown>();
     readonly #endpoint: string;
-    readonly #globalEventProperties: MixpanelGlobalEventProperties;
     readonly #logger: Logger;
+    readonly #productId?: string;
+
+    constructor(endpoint: string, logger: Logger, options: MixpanelClientOptions = {}) {
+        const {
+            productId
+        } = options;
 
-    constructor(productId: string, endpoint: string, globalEventProperties: MixpanelGlobalEventProperties, logger: Logger) {
-        this.#productId = productId;
         this.#endpoint = endpoint;
-        this.#globalEventProperties = globalEventProperties;
         this.#logger = logger;
+        this.#productId = productId;
     }
 
     // IMPORTANT: If you update this method, make sure to update the MixpanelPartialClient
     // interface as well in @workleap-telemetry/core.
     createTrackingFunction(options: CreateMixpanelTrackingFunctionOptions = {}) {
         const {
-            targetProductId
+            productId,
+            targetProductId,
+            additionalProperties = {}
         } = options;
 
         const trackFunction: MixpanelTrackingFunction = async (eventName, properties, _options = {}) => {
@@ -55,6 +66,7 @@ export class MixpanelClientImpl implements MixpanelClient {
                 const allProperties = {
                     ...baseProperties,
                     ...Object.fromEntries(this.#globalEventProperties),
+                    ...additionalProperties,
                     ...properties
                 };
 
@@ -65,7 +77,7 @@ export class MixpanelClientImpl implements MixpanelClient {
                     headers: { "Content-Type": "application/json" },
                     body: JSON.stringify({
                         eventName,
-                        productIdentifier: this.#productId,
+                        productIdentifier: productId ?? this.#productId,
                         // Not sure why, but it seems important to send "null" if not target product identifier
                         // are provided.
                         targetProductIdentifier: targetProductId ?? null,

package/src/js/index.ts

@@ -1,8 +1,7 @@
 export { createTelemetryContext, type CreateTelemetryContextOptions, type TelemetryContext } from "@workleap-telemetry/core";
 export type { CreateMixpanelTrackingFunctionOptions, MixpanelEventProperties, MixpanelTrackingFunction, MixpanelTrackingFunctionOptions } from "@workleap-telemetry/core";
-export { createTrackingFunction } from "./createTrackingFunction.ts";
 export type { MixpanelEnvironment } from "./env.ts";
 export { initializeMixpanel, type InitializeMixpanelOptions } from "./initializeMixpanel.ts";
-export type { MixpanelClient, MixpanelGlobalEventProperties } from "./MixpanelClient.ts";
+export type { MixpanelClient } from "./MixpanelClient.ts";
 export { NoopMixpanelClient } from "./NoopMixpanelClient.ts";
 

package/src/js/initializeMixpanel.ts

@@ -1,33 +1,9 @@
 import { HasExecutedGuard, type LogRocketInstrumentationPartialClient, type TelemetryContext } from "@workleap-telemetry/core";
-import { createCompositeLogger, type Logger, type RootLogger } from "@workleap/logging";
-import { setMixpanelContext } from "./context.ts";
+import { createCompositeLogger, type RootLogger } from "@workleap/logging";
 import { getTrackingEndpoint, type MixpanelEnvironment } from "./env.ts";
-import { type MixpanelClient, MixpanelClientImpl, type MixpanelGlobalEventProperties } from "./MixpanelClient.ts";
+import { MixpanelClientImpl, type MixpanelClient } from "./MixpanelClient.ts";
 import { getTelemetryProperties, OtherProperties } from "./properties.ts";
 
-// DEPRECATED: Grace period ends on January 1th 2026.
-// Don't forget to remove the tests as well.
-export const IsInitializedVariableName = "__WLP_MIXPANEL_IS_INITIALIZED__";
-
-// DEPRECATED: Grace period ends on January 1th 2026.
-function registerDeprecatedContextAndGlobalVariables(productId: string, endpoint: string, globalEventProperties: Map<string, unknown>, logger: Logger) {
-    setMixpanelContext({
-        productId,
-        endpoint,
-        globalEventProperties,
-        logger
-    });
-
-    // Indicates to the host applications that Mixpanel has been initialized.
-    // It's useful in cases where an "add-on", like the platform widgets needs
-    // to know whether or not the host application is using Mixpanel.
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore
-    globalThis[IsInitializedVariableName] = true;
-}
-
-///////////////////////////
-
 let registrationGuardInstance: HasExecutedGuard | undefined;
 
 // It's important to use a lazy singleton instead of a singleton to avoid
@@ -53,6 +29,11 @@ export function __resetRegistrationGuard() {
  * @see {@link https://workleap.github.io/wl-telemetry}
  */
 export interface InitializeMixpanelOptions {
+    /**
+     * An optional product id that will be attached to every event.
+     * @see {@link https://workleap.github.io/wl-telemetry}
+     */
+    productId?: string;
     /**
      * An optional tracking endpoint.
      * @default "tracking/track"
@@ -83,18 +64,9 @@ export interface InitializeMixpanelOptions {
 }
 
 export class MixpanelInitializer {
-    readonly #globalEventProperties: MixpanelGlobalEventProperties;
-
-    constructor(globalEventProperties: MixpanelGlobalEventProperties) {
-        this.#globalEventProperties = globalEventProperties;
-    }
-
-    initialize(
-        productId: string,
-        envOrTrackingApiBaseUrl: MixpanelEnvironment | (string & {}),
-        options: InitializeMixpanelOptions = {}
-    ) {
+    initialize(envOrTrackingApiBaseUrl: MixpanelEnvironment | (string & {}), options: Omit<InitializeMixpanelOptions, "globalEventProperties"> = {}) {
         const {
+            productId,
             trackingEndpoint,
             telemetryContext,
             logRocketInstrumentationClient,
@@ -105,10 +77,16 @@ export class MixpanelInitializer {
         const logger = createCompositeLogger(verbose, loggers);
         const endpoint = getTrackingEndpoint(envOrTrackingApiBaseUrl, trackingEndpoint);
 
+        logger.information("[mixpanel] Mixpanel is initialized.");
+
+        const client = new MixpanelClientImpl(endpoint, logger, {
+            productId
+        });
+
         // 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);
+                client.setGlobalEventProperty(key, value);
             }
         }
 
@@ -121,16 +99,10 @@ export class MixpanelInitializer {
                     .withText(sessionUrl)
                     .debug();
 
-                this.#globalEventProperties.set(OtherProperties.LogRocketSessionUrl, sessionUrl);
+                client.setGlobalEventProperty(OtherProperties.LogRocketSessionUrl, sessionUrl);
             });
         }
 
-        registerDeprecatedContextAndGlobalVariables(productId, endpoint, this.#globalEventProperties, logger);
-
-        logger.information("[mixpanel] Mixpanel is initialized.");
-
-        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;
     }
@@ -138,23 +110,18 @@ export class MixpanelInitializer {
 
 /**
  * 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}
  */
 export function initializeMixpanel(
-    productId: string,
     envOrTrackingApiBaseUrl: MixpanelEnvironment | (string & {}),
     options?: InitializeMixpanelOptions
 ) {
     getRegistrationGuard().throw("[mixpanel] Mixpanel has already been initialized. Did you call the \"initializeMixpanel\" function twice?");
 
-    return new MixpanelInitializer(
-        new Map<string, unknown>()
-    ).initialize(
-        productId,
+    return new MixpanelInitializer().initialize(
         envOrTrackingApiBaseUrl,
         options
     );

package/src/react/MixpanelPropertiesProvider.tsx

@@ -0,0 +1,43 @@
+import { createContext, type PropsWithChildren, useContext, useMemo } from "react";
+
+const MixpanelPropertiesContext = createContext<Record<string, unknown>>({});
+
+/**
+ * @see {@link https://workleap.github.io/wl-telemetry}
+ */
+export interface MixpanelPropertiesProviderProps extends PropsWithChildren {
+    value: Record<string, unknown>;
+}
+
+/**
+ * Define Mixpanel properties that will be passed down to nested "useTrackingFunction" or "useMixpanelTrackingFunction" hook.
+ * @see {@link https://workleap.github.io/wl-telemetry}
+ */
+export function MixpanelPropertiesProvider(props: MixpanelPropertiesProviderProps) {
+    const {
+        value,
+        children
+    } = props;
+
+    const parentContext = useContext(MixpanelPropertiesContext);
+
+    const contextValue = useMemo(() => ({
+        ...parentContext,
+        ...value
+    }), [parentContext, value]);
+
+    return (
+        <MixpanelPropertiesContext.Provider value={contextValue}>
+            {children}
+        </MixpanelPropertiesContext.Provider>
+    );
+}
+
+/**
+ * Retrieve the Mixpanel properties from all parent providers.
+ * @returns The context value or an empty object literal if no provider isdefined.
+ * @see {@link https://workleap.github.io/wl-telemetry}
+ */
+export const useMixpanelProviderProperties = () => {
+    return useContext(MixpanelPropertiesContext);
+};

package/src/react/index.ts

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

package/src/react/useTrackingFunction.ts

@@ -1,7 +1,7 @@
 import type { CreateMixpanelTrackingFunctionOptions } from "@workleap-telemetry/core";
-import { useContext, useMemo } from "react";
-import { createTrackingFunction } from "../js/createTrackingFunction.ts";
-import { MixpanelContext } from "./MixpanelContext.tsx";
+import { useMemo } from "react";
+import { useMixpanelClient } from "./MixpanelContext.tsx";
+import { useMixpanelProviderProperties } from "./MixpanelPropertiesProvider.tsx";
 
 /**
  * @see {@link https://workleap.github.io/wl-telemetry}
@@ -14,21 +14,20 @@ export type UseTrackingFunctionOptions = CreateMixpanelTrackingFunctionOptions;
  */
 export function useTrackingFunction(options: UseTrackingFunctionOptions = {}) {
     const {
+        productId,
         targetProductId
     } = options;
 
-    const client = useContext(MixpanelContext);
+    const client = useMixpanelClient();
+    const additionalProperties = useMixpanelProviderProperties();
 
     return useMemo(() => {
         const trackOptions = {
-            targetProductId
+            productId,
+            targetProductId,
+            additionalProperties
         } satisfies CreateMixpanelTrackingFunctionOptions;
 
-        // DEPRECATED: Grace period ends on January 1th 2026.
-        // After the grace period, only create the tracking function from the client, remove the fallback
-        // and also use "useMixpanelClient" to retrieve the client rather than "useContext".
-        return client
-            ? client.createTrackingFunction(trackOptions)
-            : createTrackingFunction(trackOptions);
-    }, [client, targetProductId]);
+        return client.createTrackingFunction(trackOptions);
+    }, [client, productId, targetProductId, additionalProperties]);
 }

package/dist/js/context.d.ts

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

package/dist/js/context.js

@@ -1,28 +0,0 @@
-
-;// 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.
-    // It's important to share the context with a global DOM object rather than
-    // a singleton because projects like the platform widgets will use a distinct instance
-    // of this package than the host application.
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore
-    globalThis[MixpanelContextVariableName] = context;
-}
-function getMixpanelContext() {
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore
-    const context = globalThis[MixpanelContextVariableName];
-    if (!context) {
-        throw new Error("[mixpanel] The Mixpanel context is not available. Did you initialize Mixpanel with the \"initializeMixpanel\" function?");
-    }
-    return context;
-}
-
-export { MixpanelContextVariableName, getMixpanelContext, setMixpanelContext };
-
-//# sourceMappingURL=context.js.map

package/dist/js/context.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"js/context.js","sources":["../../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"],"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

@@ -1,5 +0,0 @@
-import type { CreateMixpanelTrackingFunctionOptions, MixpanelTrackingFunction } from "@workleap-telemetry/core";
-/**
- * @see {@link https://workleap.github.io/wl-telemetry}
- */
-export declare function createTrackingFunction(options?: CreateMixpanelTrackingFunctionOptions): MixpanelTrackingFunction;

package/dist/js/createTrackingFunction.js

@@ -1,53 +0,0 @@
-import { getMixpanelContext } from "./context.js";
-import { getBaseProperties } from "./properties.js";
-
-;// CONCATENATED MODULE: external "./context.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, globalEventProperties, logger } = getMixpanelContext();
-    const trackFunction = async (eventName, properties, _options = {})=>{
-        try {
-            const { keepAlive = false } = _options;
-            const baseProperties = getBaseProperties();
-            const allProperties = {
-                ...baseProperties,
-                ...Object.fromEntries(globalEventProperties),
-                ...properties
-            };
-            await fetch(endpoint, {
-                method: "POST",
-                credentials: "include",
-                keepalive: keepAlive,
-                headers: {
-                    "Content-Type": "application/json"
-                },
-                body: JSON.stringify({
-                    eventName,
-                    productIdentifier: 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) {
-            logger.withText(`[mixpanel] An error occurred while sending a tracking event to "${endpoint}":`).withError(error).error();
-        }
-    };
-    return trackFunction;
-}
-
-export { createTrackingFunction };
-
-//# sourceMappingURL=createTrackingFunction.js.map

package/dist/js/createTrackingFunction.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"js/createTrackingFunction.js","sources":["../../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 type { CreateMixpanelTrackingFunctionOptions, MixpanelTrackingFunction } from \"@workleap-telemetry/core\";\nimport { getMixpanelContext } from \"./context.ts\";\nimport { getBaseProperties } from \"./properties.ts\";\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;AAG/B;AACE;AAEpD;;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,yBAAyBD,mBAAmB;oBAC5C,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/src/js/context.ts

@@ -1,38 +0,0 @@
-// 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.
-
-import type { Logger } from "@workleap/logging";
-import type { MixpanelGlobalEventProperties } from "./MixpanelClient.ts";
-
-export const MixpanelContextVariableName = "__WLP_MIXPANEL_CONTEXT__";
-
-export interface MixpanelContext {
-    productId: string;
-    endpoint: string;
-    globalEventProperties: MixpanelGlobalEventProperties;
-    logger: Logger;
-}
-
-export function setMixpanelContext(context: MixpanelContext) {
-    // Will be used by the "track" function.
-    // It's important to share the context with a global DOM object rather than
-    // a singleton because projects like the platform widgets will use a distinct instance
-    // of this package than the host application.
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore
-    globalThis[MixpanelContextVariableName] = context;
-}
-
-export function getMixpanelContext() {
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore
-    const context = globalThis[MixpanelContextVariableName] as MixpanelContext;
-
-    if (!context) {
-        throw new Error("[mixpanel] The Mixpanel context is not available. Did you initialize Mixpanel with the \"initializeMixpanel\" function?");
-    }
-
-    return context;
-}
-

package/src/js/createTrackingFunction.ts

@@ -1,61 +0,0 @@
-// 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.
-
-import type { CreateMixpanelTrackingFunctionOptions, MixpanelTrackingFunction } from "@workleap-telemetry/core";
-import { getMixpanelContext } from "./context.ts";
-import { getBaseProperties } from "./properties.ts";
-
-/**
- * @see {@link https://workleap.github.io/wl-telemetry}
- */
-export function createTrackingFunction(options: CreateMixpanelTrackingFunctionOptions = {}) {
-    const {
-        targetProductId
-    } = options;
-
-    const {
-        productId,
-        endpoint,
-        globalEventProperties,
-        logger
-    } = getMixpanelContext();
-
-    const trackFunction: MixpanelTrackingFunction = async (eventName, properties, _options = {}) => {
-        try {
-            const {
-                keepAlive = false
-            } = _options;
-
-            const baseProperties = getBaseProperties();
-
-            const allProperties = {
-                ...baseProperties,
-                ...Object.fromEntries(globalEventProperties),
-                ...properties
-            };
-
-            await fetch(endpoint, {
-                method: "POST",
-                credentials: "include",
-                keepalive: keepAlive,
-                headers: { "Content-Type": "application/json" },
-                body: JSON.stringify({
-                    eventName,
-                    productIdentifier: 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: unknown) {
-            logger
-                .withText(`[mixpanel] An error occurred while sending a tracking event to "${endpoint}":`)
-                .withError(error as Error)
-                .error();
-        }
-    };
-
-    return trackFunction;
-}