@workleap/mixpanel 6.0.2 → 6.1.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @workleap/mixpanel
 
+## 6.1.0
+
+### Minor Changes
+
+- [#281](https://github.com/workleap/wl-telemetry/pull/281) [`7bc53df`](https://github.com/workleap/wl-telemetry/commit/7bc53df81efadfc0bd87f475995ee92916b5802e) Thanks [@patricklafrance](https://github.com/patricklafrance)! - Redact the private query parameters from the `$current_url` and `$referrer` properties sent with every Mixpanel event, and remove the fragment from `$current_url`. The `token`, `email` and `password` query parameters are redacted by default, additional names can be provided with the new `privateQueryParameterNames` option. An application using hash routing will no longer get the route in `$current_url`.
+
+## 6.0.3
+
+### Patch Changes
+
+- [#269](https://github.com/workleap/wl-telemetry/pull/269) [`0a200c0`](https://github.com/workleap/wl-telemetry/commit/0a200c0dcbb3997a4cc3857836a4c4e269c41723) Thanks [@patricklafrance](https://github.com/patricklafrance)! - Raise the minimum `@workleap/logging` version to `2.1.0`.
+- Updated dependencies [[`0a200c0`](https://github.com/workleap/wl-telemetry/commit/0a200c0dcbb3997a4cc3857836a4c4e269c41723)]:
+  - @workleap-telemetry/core@2.0.7
+
 ## 6.0.2
 
 ### Patch Changes

package/dist/js/MixpanelClient.d.ts

@@ -25,6 +25,10 @@ export interface MixpanelClientOptions {
      * @see {@link https://workleap.github.io/wl-telemetry}
      */
     productId?: string;
+    /**
+     * @see {@link https://workleap.github.io/wl-telemetry}
+     */
+    privateQueryParameterNames?: string[];
 }
 export declare class MixpanelClientImpl implements MixpanelClient {
     #private;

package/dist/js/MixpanelClient.js

@@ -2,16 +2,23 @@ import { getBaseProperties } from "./properties.js";
 
 
 
+const DefaultPrivateQueryParameterNames = [
+    "token",
+    "email",
+    "password"
+];
 class MixpanelClientImpl {
     #globalEventProperties = new Map();
     #endpoint;
     #logger;
     #productId;
+    #privateQueryParameterNames;
     constructor(endpoint, logger, options = {}){
-        const { productId } = options;
+        const { productId, privateQueryParameterNames = [] } = options;
         this.#endpoint = endpoint;
         this.#logger = logger;
         this.#productId = productId;
+        this.#privateQueryParameterNames = DefaultPrivateQueryParameterNames.concat(privateQueryParameterNames);
     }
     // IMPORTANT: If you update this method, make sure to update the MixpanelPartialClient
     // interface as well in @workleap-telemetry/core.
@@ -20,7 +27,7 @@ class MixpanelClientImpl {
         const trackFunction = async (eventName, properties, _options = {})=>{
             try {
                 const { keepAlive = false } = _options;
-                const baseProperties = getBaseProperties();
+                const baseProperties = getBaseProperties(this.#privateQueryParameterNames);
                 const allProperties = {
                     ...baseProperties,
                     ...Object.fromEntries(this.#globalEventProperties),

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\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,kBAAkBA;IAClB,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"}
+{"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     * @see {@link https://workleap.github.io/wl-telemetry}\n     */\n    privateQueryParameterNames?: string[];\n}\n\nconst DefaultPrivateQueryParameterNames = [\"token\", \"email\", \"password\"];\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    readonly #privateQueryParameterNames: string[];\n\n    constructor(endpoint: string, logger: Logger, options: MixpanelClientOptions = {}) {\n        const { productId, privateQueryParameterNames = [] } = options;\n\n        this.#endpoint = endpoint;\n        this.#logger = logger;\n        this.#productId = productId;\n        this.#privateQueryParameterNames = DefaultPrivateQueryParameterNames.concat(privateQueryParameterNames);\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 { productId, targetProductId, additionalProperties = {} } = options;\n\n        const trackFunction: MixpanelTrackingFunction = async (eventName, properties, _options = {}) => {\n            try {\n                const { keepAlive = false } = _options;\n\n                const baseProperties = getBaseProperties(this.#privateQueryParameterNames);\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","DefaultPrivateQueryParameterNames","MixpanelClientImpl","Map","endpoint","logger","options","productId","privateQueryParameterNames","targetProductId","additionalProperties","trackFunction","eventName","properties","_options","keepAlive","baseProperties","allProperties","Object","fetch","JSON","error","key","value","values","x"],"mappings":";;;AAEoD;AAkCpD,MAAMC,oCAAoC;IAAC;IAAS;IAAS;CAAW;AAEjE,MAAMC;IACA,sBAAsB,GAAG,IAAIC,MAAuB;IACpD,SAAS,CAAS;IAClB,OAAO,CAAS;IAChB,UAAU,CAAU;IACpB,2BAA2B,CAAW;IAE/C,YAAYC,QAAgB,EAAEC,MAAc,EAAEC,UAAiC,CAAC,CAAC,CAAE;QAC/E,MAAM,EAAEC,SAAS,EAAEC,6BAA6B,EAAE,EAAE,GAAGF;QAEvD,IAAI,CAAC,SAAS,GAAGF;QACjB,IAAI,CAAC,OAAO,GAAGC;QACf,IAAI,CAAC,UAAU,GAAGE;QAClB,IAAI,CAAC,2BAA2B,GAAGN,kCAAkC,MAAM,CAACO;IAChF;IAEA,sFAAsF;IACtF,iDAAiD;IACjD,uBAAuBF,UAAiD,CAAC,CAAC,EAAE;QACxE,MAAM,EAAEC,SAAS,EAAEE,eAAe,EAAEC,uBAAuB,CAAC,CAAC,EAAE,GAAGJ;QAElE,MAAMK,gBAA0C,OAAOC,WAAWC,YAAYC,WAAW,CAAC,CAAC;YACvF,IAAI;gBACA,MAAM,EAAEC,YAAY,KAAK,EAAE,GAAGD;gBAE9B,MAAME,iBAAiBhB,iBAAiBA,CAAC,IAAI,CAAC,2BAA2B;gBAEzE,MAAMiB,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,mBAAmBL,aAAa,IAAI,CAAC,UAAU;wBAC/C,uFAAuF;wBACvF,gBAAgB;wBAChB,yBAAyBE,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/NoopMixpanelClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"js/NoopMixpanelClient.js","sources":["../../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,kBAAkBA;IAC3B,yBAAyB;QACrB,OAAO,IAAMC,QAAQ,OAAO;IAChC;IAEA,yBAAyB,CAAC;IAC1B,2BAA2B,CAAC;AAChC"}
+{"version":3,"file":"js/NoopMixpanelClient.js","sources":["../../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/env.d.ts

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

package/dist/js/env.js

@@ -6,11 +6,11 @@ const EnvironmentList = [
     "msw"
 ];
 const NavigationApiBaseUrl = {
-    "production": "https://api.platform.workleap.com/shell/navigation/",
-    "staging": "https://api.platform.workleap-stg.com/shell/navigation/",
-    "development": "https://api.platform.workleap-dev.com/shell/navigation/",
-    "local": "https://api.platform.workleap-dev.com/shell/navigation/",
-    "msw": "/api/shell/navigation/"
+    production: "https://api.platform.workleap.com/shell/navigation/",
+    staging: "https://api.platform.workleap-stg.com/shell/navigation/",
+    development: "https://api.platform.workleap-dev.com/shell/navigation/",
+    local: "https://api.platform.workleap-dev.com/shell/navigation/",
+    msw: "/api/shell/navigation/"
 };
 // Cannot use URL() because it doesn't support relative base url: https://github.com/whatwg/url/issues/531.
 function resolveApiUrl(path, baseUrl) {

package/dist/js/env.js.map

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

package/dist/js/index.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 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"}
+{"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"],"names":["createTelemetryContext","initializeMixpanel","NoopMixpanelClient"],"mappings":";;;AAA6H;AAGhC;AAEhC"}

package/dist/js/initializeMixpanel.d.ts

@@ -18,6 +18,11 @@ export interface InitializeMixpanelOptions {
      * @see {@link https://workleap.github.io/wl-telemetry}
      */
     trackingEndpoint?: string;
+    /**
+     * Names of additional query parameters to redact from the URLs sent with every event.
+     * @see {@link https://workleap.github.io/wl-telemetry}
+     */
+    privateQueryParameterNames?: string[];
     /**
      * Context including telemetry correlation ids.
      * @see {@link https://workleap.github.io/wl-telemetry}

package/dist/js/initializeMixpanel.js

@@ -31,12 +31,13 @@ function __resetRegistrationGuard() {
 }
 class MixpanelInitializer {
     initialize(envOrTrackingApiBaseUrl, options = {}) {
-        const { productId, trackingEndpoint, telemetryContext, logRocketInstrumentationClient, verbose = false, loggers = [] } = options;
+        const { productId, trackingEndpoint, privateQueryParameterNames, 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
+            productId,
+            privateQueryParameterNames
         });
         // Set the telemetry correlation ids on every Mixpanel event.
         if (telemetryContext) {
@@ -63,7 +64,7 @@ class MixpanelInitializer {
  * @returns {MixpanelClient} A Mixpanel client instance.
  * @see {@link https://workleap.github.io/wl-telemetry}
  */ function initializeMixpanel(envOrTrackingApiBaseUrl, options) {
-    getRegistrationGuard().throw("[mixpanel] Mixpanel has already been initialized. Did you call the \"initializeMixpanel\" function twice?");
+    getRegistrationGuard().throw('[mixpanel] Mixpanel has already been initialized. Did you call the "initializeMixpanel" function twice?');
     return new MixpanelInitializer().initialize(envOrTrackingApiBaseUrl, options);
 }
 

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 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,yBAAyBA;AAE7B,yEAAyE;AACzE,+DAA+D;AAC/D,SAASC,oBAAoBA;IACzB,IAAI,CAACD,yBAAyBA,EAAE;QAC5BA,yBAAyBA,GAAG,IAAIN,gBAAgBA;IACpD;IAEA,OAAOM,yBAAyBA;AACpC;AAEA,8CAA8C;AACvC,SAASE,wBAAwBA;IACpC,IAAIF,yBAAyBA,EAAE;QAC3BA,yBAAyBA,CAAC,KAAK;IACnC;AACJ;AA0CO,MAAMG,mBAAmBA;IAC5B,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,kBAAkBA,CAC9Bf,uBAA4D,EAC5DC,OAAmC;IAEnCJ,oBAAoBA,GAAG,KAAK,CAAC;IAE7B,OAAO,IAAIE,mBAAmBA,GAAG,UAAU,CACvCC,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     * Names of additional query parameters to redact from the URLs sent with every event.\n     * @see {@link https://workleap.github.io/wl-telemetry}\n     */\n    privateQueryParameterNames?: 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 { productId, trackingEndpoint, privateQueryParameterNames, telemetryContext, logRocketInstrumentationClient, verbose = false, loggers = [] } = 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            privateQueryParameterNames\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.withText(\"[mixpanel] Received LogRocket session replay URL:\").withText(sessionUrl).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(envOrTrackingApiBaseUrl: MixpanelEnvironment | (string & {}), options?: InitializeMixpanelOptions) {\n    getRegistrationGuard().throw('[mixpanel] Mixpanel has already been initialized. Did you call the \"initializeMixpanel\" function twice?');\n\n    return new MixpanelInitializer().initialize(envOrTrackingApiBaseUrl, options);\n}\n"],"names":["HasExecutedGuard","createCompositeLogger","getTrackingEndpoint","MixpanelClientImpl","getTelemetryProperties","OtherProperties","registrationGuardInstance","getRegistrationGuard","__resetRegistrationGuard","MixpanelInitializer","envOrTrackingApiBaseUrl","options","productId","trackingEndpoint","privateQueryParameterNames","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;AA+CO,MAAMG;IACT,WAAWC,uBAA4D,EAAEC,UAAoE,CAAC,CAAC,EAAE;QAC7I,MAAM,EAAEC,SAAS,EAAEC,gBAAgB,EAAEC,0BAA0B,EAAEC,gBAAgB,EAAEC,8BAA8B,EAAEC,UAAU,KAAK,EAAEC,UAAU,EAAE,EAAE,GAAGP;QAErJ,MAAMQ,SAASlB,qBAAqBA,CAACgB,SAASC;QAC9C,MAAME,WAAWlB,mBAAmBA,CAACQ,yBAAyBG;QAE9DM,OAAO,WAAW,CAAC;QAEnB,MAAME,SAAS,IAAIlB,kBAAkBA,CAACiB,UAAUD,QAAQ;YACpDP;YACAE;QACJ;QAEA,6DAA6D;QAC7D,IAAIC,kBAAkB;YAClB,KAAK,MAAM,CAACO,KAAKC,MAAM,IAAIC,OAAO,OAAO,CAACpB,sBAAsBA,CAACW,mBAAoB;gBACjFM,OAAO,sBAAsB,CAACC,KAAKC;YACvC;QACJ;QAEA,mGAAmG;QACnG,yDAAyD;QACzD,IAAIP,gCAAgC;YAChCA,+BAA+B,6BAA6B,CAAC,CAACS;gBAC1DN,OAAO,QAAQ,CAAC,qDAAqD,QAAQ,CAACM,YAAY,KAAK;gBAE/FJ,OAAO,sBAAsB,CAAChB,mCAAmC,EAAEoB;YACvE;QACJ;QAEA,kGAAkG;QAClG,OAAOJ;IACX;AACJ;AAEA;;;;;;CAMC,GACM,SAASK,mBAAmBhB,uBAA4D,EAAEC,OAAmC;IAChIJ,uBAAuB,KAAK,CAAC;IAE7B,OAAO,IAAIE,sBAAsB,UAAU,CAACC,yBAAyBC;AACzE"}

package/dist/js/properties.d.ts

@@ -11,7 +11,7 @@ export declare const BaseProperties: {
     readonly ScreenHeight: "$screen_height";
     readonly ScreenWidth: "$screen_width";
 };
-export declare function getBaseProperties(): {
+export declare function getBaseProperties(privateQueryParameterNames: string[]): {
     $os: string;
     $browser: string;
     $referrer: string;

package/dist/js/properties.js

@@ -1,4 +1,4 @@
-import { browserName, browserVersion, deviceType, osName, referringDomain } from "./utils.js";
+import { browserName, browserVersion, deviceType, osName, redactQueryParameters, referringDomain } from "./utils.js";
 
 
 
@@ -14,16 +14,17 @@ const BaseProperties = {
     ScreenHeight: "$screen_height",
     ScreenWidth: "$screen_width"
 };
-function getBaseProperties() {
+function getBaseProperties(privateQueryParameterNames) {
     const userAgent = navigator.userAgent;
     const device = deviceType(userAgent);
     return {
         [BaseProperties.Os]: osName(userAgent),
         [BaseProperties.Browser]: browserName(userAgent, navigator.vendor),
-        [BaseProperties.Referrer]: document.referrer,
+        [BaseProperties.Referrer]: redactQueryParameters(document.referrer, privateQueryParameterNames),
         [BaseProperties.ReferringDomain]: referringDomain(document.referrer),
         [BaseProperties.Device]: device,
-        [BaseProperties.CurrentUrl]: window.location.href,
+        // The fragment is removed because it can include sensitive values, such as an access token.
+        [BaseProperties.CurrentUrl]: redactQueryParameters(window.location.href.split("#")[0], privateQueryParameterNames),
         [BaseProperties.BrowserVersion]: browserVersion(userAgent, navigator.vendor),
         [BaseProperties.ScreenHeight]: window.screen.height,
         [BaseProperties.ScreenWidth]: window.screen.width,

package/dist/js/properties.js.map

@@ -1 +1 @@
-{"version":3,"file":"js/properties.js","sources":["../../src/js/properties.ts"],"sourcesContent":["\nimport type { MixpanelEventProperties, TelemetryContext } from \"@workleap-telemetry/core\";\nimport { browserName, browserVersion, deviceType, osName, referringDomain } from \"./utils.ts\";\n\nexport const BaseProperties = {\n    Browser: \"$browser\",\n    BrowserVersion: \"$browser_version\",\n    CurrentUrl: \"$current_url\",\n    Device: \"$device\",\n    IsMobile: \"Is Mobile\",\n    Os: \"$os\",\n    Referrer: \"$referrer\",\n    ReferringDomain: \"$referring_domain\",\n    ScreenHeight: \"$screen_height\",\n    ScreenWidth: \"$screen_width\"\n} as const;\n\nexport function getBaseProperties() {\n    const userAgent = navigator.userAgent;\n    const device = deviceType(userAgent);\n\n    return {\n        [BaseProperties.Os]: osName(userAgent),\n        [BaseProperties.Browser]: browserName(userAgent, navigator.vendor),\n        [BaseProperties.Referrer]: document.referrer,\n        [BaseProperties.ReferringDomain]: referringDomain(document.referrer),\n        [BaseProperties.Device]: device,\n        [BaseProperties.CurrentUrl]: window.location.href,\n        [BaseProperties.BrowserVersion]: browserVersion(userAgent, navigator.vendor),\n        [BaseProperties.ScreenHeight]: window.screen.height,\n        [BaseProperties.ScreenWidth]: window.screen.width,\n        [BaseProperties.IsMobile]: device.length > 0\n    } satisfies MixpanelEventProperties;\n}\n\nexport const TelemetryProperties = {\n    DeviceId: \"Device Id\",\n    TelemetryId: \"Telemetry Id\"\n} as const;\n\nexport function getTelemetryProperties(context: TelemetryContext) {\n    return {\n        [TelemetryProperties.TelemetryId]: context.telemetryId,\n        [TelemetryProperties.DeviceId]: context.deviceId\n    } satisfies MixpanelEventProperties;\n}\n\nexport const OtherProperties = {\n    LogRocketSessionUrl: \"LogRocket Session Url\"\n};\n"],"names":["browserName","browserVersion","deviceType","osName","referringDomain","BaseProperties","getBaseProperties","userAgent","navigator","device","document","window","TelemetryProperties","getTelemetryProperties","context","OtherProperties"],"mappings":";;;AAE8F;AAEvF,MAAMK,cAAcA,GAAG;IAC1B,SAAS;IACT,gBAAgB;IAChB,YAAY;IACZ,QAAQ;IACR,UAAU;IACV,IAAI;IACJ,UAAU;IACV,iBAAiB;IACjB,cAAc;IACd,aAAa;AACjB,EAAW;AAEJ,SAASC,iBAAiBA;IAC7B,MAAMC,YAAYC,UAAU,SAAS;IACrC,MAAMC,SAASP,UAAUA,CAACK;IAE1B,OAAO;QACH,CAACF,cAAcA,CAAC,EAAE,CAAC,EAAEF,MAAMA,CAACI;QAC5B,CAACF,cAAcA,CAAC,OAAO,CAAC,EAAEL,WAAWA,CAACO,WAAWC,UAAU,MAAM;QACjE,CAACH,cAAcA,CAAC,QAAQ,CAAC,EAAEK,SAAS,QAAQ;QAC5C,CAACL,cAAcA,CAAC,eAAe,CAAC,EAAED,eAAeA,CAACM,SAAS,QAAQ;QACnE,CAACL,cAAcA,CAAC,MAAM,CAAC,EAAEI;QACzB,CAACJ,cAAcA,CAAC,UAAU,CAAC,EAAEM,OAAO,QAAQ,CAAC,IAAI;QACjD,CAACN,cAAcA,CAAC,cAAc,CAAC,EAAEJ,cAAcA,CAACM,WAAWC,UAAU,MAAM;QAC3E,CAACH,cAAcA,CAAC,YAAY,CAAC,EAAEM,OAAO,MAAM,CAAC,MAAM;QACnD,CAACN,cAAcA,CAAC,WAAW,CAAC,EAAEM,OAAO,MAAM,CAAC,KAAK;QACjD,CAACN,cAAcA,CAAC,QAAQ,CAAC,EAAEI,OAAO,MAAM,GAAG;IAC/C;AACJ;AAEO,MAAMG,mBAAmBA,GAAG;IAC/B,UAAU;IACV,aAAa;AACjB,EAAW;AAEJ,SAASC,sBAAsBA,CAACC,OAAyB;IAC5D,OAAO;QACH,CAACF,mBAAmBA,CAAC,WAAW,CAAC,EAAEE,QAAQ,WAAW;QACtD,CAACF,mBAAmBA,CAAC,QAAQ,CAAC,EAAEE,QAAQ,QAAQ;IACpD;AACJ;AAEO,MAAMC,eAAeA,GAAG;IAC3B,qBAAqB;AACzB,EAAE"}
+{"version":3,"file":"js/properties.js","sources":["../../src/js/properties.ts"],"sourcesContent":["import type { MixpanelEventProperties, TelemetryContext } from \"@workleap-telemetry/core\";\nimport { browserName, browserVersion, deviceType, osName, redactQueryParameters, referringDomain } from \"./utils.ts\";\n\nexport const BaseProperties = {\n    Browser: \"$browser\",\n    BrowserVersion: \"$browser_version\",\n    CurrentUrl: \"$current_url\",\n    Device: \"$device\",\n    IsMobile: \"Is Mobile\",\n    Os: \"$os\",\n    Referrer: \"$referrer\",\n    ReferringDomain: \"$referring_domain\",\n    ScreenHeight: \"$screen_height\",\n    ScreenWidth: \"$screen_width\"\n} as const;\n\nexport function getBaseProperties(privateQueryParameterNames: string[]) {\n    const userAgent = navigator.userAgent;\n    const device = deviceType(userAgent);\n\n    return {\n        [BaseProperties.Os]: osName(userAgent),\n        [BaseProperties.Browser]: browserName(userAgent, navigator.vendor),\n        [BaseProperties.Referrer]: redactQueryParameters(document.referrer, privateQueryParameterNames),\n        [BaseProperties.ReferringDomain]: referringDomain(document.referrer),\n        [BaseProperties.Device]: device,\n        // The fragment is removed because it can include sensitive values, such as an access token.\n        [BaseProperties.CurrentUrl]: redactQueryParameters(window.location.href.split(\"#\")[0], privateQueryParameterNames),\n        [BaseProperties.BrowserVersion]: browserVersion(userAgent, navigator.vendor),\n        [BaseProperties.ScreenHeight]: window.screen.height,\n        [BaseProperties.ScreenWidth]: window.screen.width,\n        [BaseProperties.IsMobile]: device.length > 0\n    } satisfies MixpanelEventProperties;\n}\n\nexport const TelemetryProperties = {\n    DeviceId: \"Device Id\",\n    TelemetryId: \"Telemetry Id\"\n} as const;\n\nexport function getTelemetryProperties(context: TelemetryContext) {\n    return {\n        [TelemetryProperties.TelemetryId]: context.telemetryId,\n        [TelemetryProperties.DeviceId]: context.deviceId\n    } satisfies MixpanelEventProperties;\n}\n\nexport const OtherProperties = {\n    LogRocketSessionUrl: \"LogRocket Session Url\"\n};\n"],"names":["browserName","browserVersion","deviceType","osName","redactQueryParameters","referringDomain","BaseProperties","getBaseProperties","privateQueryParameterNames","userAgent","navigator","device","document","window","TelemetryProperties","getTelemetryProperties","context","OtherProperties"],"mappings":";;;AACqH;AAE9G,MAAMM,iBAAiB;IAC1B,SAAS;IACT,gBAAgB;IAChB,YAAY;IACZ,QAAQ;IACR,UAAU;IACV,IAAI;IACJ,UAAU;IACV,iBAAiB;IACjB,cAAc;IACd,aAAa;AACjB,EAAW;AAEJ,SAASC,kBAAkBC,0BAAoC;IAClE,MAAMC,YAAYC,UAAU,SAAS;IACrC,MAAMC,SAAST,UAAUA,CAACO;IAE1B,OAAO;QACH,CAACH,eAAe,EAAE,CAAC,EAAEH,MAAMA,CAACM;QAC5B,CAACH,eAAe,OAAO,CAAC,EAAEN,WAAWA,CAACS,WAAWC,UAAU,MAAM;QACjE,CAACJ,eAAe,QAAQ,CAAC,EAAEF,qBAAqBA,CAACQ,SAAS,QAAQ,EAAEJ;QACpE,CAACF,eAAe,eAAe,CAAC,EAAED,eAAeA,CAACO,SAAS,QAAQ;QACnE,CAACN,eAAe,MAAM,CAAC,EAAEK;QACzB,4FAA4F;QAC5F,CAACL,eAAe,UAAU,CAAC,EAAEF,qBAAqBA,CAACS,OAAO,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,EAAEL;QACvF,CAACF,eAAe,cAAc,CAAC,EAAEL,cAAcA,CAACQ,WAAWC,UAAU,MAAM;QAC3E,CAACJ,eAAe,YAAY,CAAC,EAAEO,OAAO,MAAM,CAAC,MAAM;QACnD,CAACP,eAAe,WAAW,CAAC,EAAEO,OAAO,MAAM,CAAC,KAAK;QACjD,CAACP,eAAe,QAAQ,CAAC,EAAEK,OAAO,MAAM,GAAG;IAC/C;AACJ;AAEO,MAAMG,sBAAsB;IAC/B,UAAU;IACV,aAAa;AACjB,EAAW;AAEJ,SAASC,uBAAuBC,OAAyB;IAC5D,OAAO;QACH,CAACF,oBAAoB,WAAW,CAAC,EAAEE,QAAQ,WAAW;QACtD,CAACF,oBAAoB,QAAQ,CAAC,EAAEE,QAAQ,QAAQ;IACpD;AACJ;AAEO,MAAMC,kBAAkB;IAC3B,qBAAqB;AACzB,EAAE"}

package/dist/js/utils.d.ts

@@ -1,10 +1,11 @@
-export declare function browserName(userAgent: string, vendor?: string, opera?: object): "" | "Opera Mini" | "Opera" | "BlackBerry" | "Internet Explorer Mobile" | "Microsoft Edge" | "Facebook Mobile" | "Chrome" | "Chrome iOS" | "UC Browser" | "Firefox iOS" | "Mobile Safari" | "Safari" | "Android Mobile" | "Konqueror" | "Firefox" | "Internet Explorer" | "Mozilla";
+export declare function browserName(userAgent: string, vendor?: string, opera?: object): "" | "Android Mobile" | "BlackBerry" | "Chrome" | "Chrome iOS" | "Facebook Mobile" | "Firefox" | "Firefox iOS" | "Internet Explorer" | "Internet Explorer Mobile" | "Konqueror" | "Microsoft Edge" | "Mobile Safari" | "Mozilla" | "Opera" | "Opera Mini" | "Safari" | "UC Browser";
 /**
  * This function detects which browser version is running this script,
  * parsing major and minor version (e.g., 42.1). User agent strings from:
  * http://www.useragentstring.com/pages/useragentstring.php
  */
 export declare function browserVersion(userAgent: string, vendor?: string, opera?: object): number | null;
-export declare function osName(userAgent: string): "" | "BlackBerry" | "Android" | "Windows Phone" | "Windows" | "iOS" | "Mac OS X" | "Linux" | "Chrome OS";
-export declare function deviceType(userAgent: string): "" | "BlackBerry" | "Android" | "Windows Phone" | "iPad" | "iPod Touch" | "iPhone";
+export declare function osName(userAgent: string): "" | "Android" | "BlackBerry" | "Chrome OS" | "Linux" | "Mac OS X" | "Windows" | "Windows Phone" | "iOS";
+export declare function deviceType(userAgent: string): "" | "Android" | "BlackBerry" | "Windows Phone" | "iPad" | "iPhone" | "iPod Touch";
 export declare function referringDomain(referrer: string): string;
+export declare function redactQueryParameters(url: string, queryParameterNames: string[]): string;

package/dist/js/utils.js

@@ -1,7 +1,7 @@
 // This code is adapted from https://github.com/mixpanel/mixpanel-js/blob/master/src/utils.js
 function browserName(userAgent, vendor, opera) {
     // vendor is undefined for at least IE9
-    vendor = vendor || ""; // eslint-disable-line no-param-reassign
+    vendor = vendor || ""; // oxlint-disable-line eslint/no-param-reassign
     if (opera || userAgent.includes(" OPR/")) {
         if (userAgent.includes("Mini")) {
             return "Opera Mini";
@@ -50,19 +50,19 @@ function browserName(userAgent, vendor, opera) {
     const versionRegexs = {
         "Internet Explorer Mobile": /rv:(\d+(\.\d+)?)/,
         "Microsoft Edge": /Edge\/(\d+(\.\d+)?)/,
-        "Chrome": /Chrome\/(\d+(\.\d+)?)/,
+        Chrome: /Chrome\/(\d+(\.\d+)?)/,
         "Chrome iOS": /CriOS\/(\d+(\.\d+)?)/,
         "UC Browser": /(UCBrowser|UCWEB)\/(\d+(\.\d+)?)/,
-        "Safari": /Version\/(\d+(\.\d+)?)/,
+        Safari: /Version\/(\d+(\.\d+)?)/,
         "Mobile Safari": /Version\/(\d+(\.\d+)?)/,
-        "Opera": /(Opera|OPR)\/(\d+(\.\d+)?)/,
-        "Firefox": /Firefox\/(\d+(\.\d+)?)/,
+        Opera: /(Opera|OPR)\/(\d+(\.\d+)?)/,
+        Firefox: /Firefox\/(\d+(\.\d+)?)/,
         "Firefox iOS": /FxiOS\/(\d+(\.\d+)?)/,
-        "Konqueror": /Konqueror:(\d+(\.\d+)?)/,
-        "BlackBerry": /BlackBerry (\d+(\.\d+)?)/,
+        Konqueror: /Konqueror:(\d+(\.\d+)?)/,
+        BlackBerry: /BlackBerry (\d+(\.\d+)?)/,
         "Android Mobile": /android\s(\d+(\.\d+)?)/,
         "Internet Explorer": /(rv:|MSIE )(\d+(\.\d+)?)/,
-        "Mozilla": /rv:(\d+(\.\d+)?)/
+        Mozilla: /rv:(\d+(\.\d+)?)/
     };
     const regex = versionRegexs[browser];
     if (regex === undefined) {
@@ -77,45 +77,36 @@ function browserName(userAgent, vendor, opera) {
 function osName(userAgent) {
     const a = userAgent;
     if (/Windows/i.test(a)) {
-        // eslint-disable-next-line @typescript-eslint/prefer-includes
         if (/Phone/.test(a) || /WPDesktop/.test(a)) {
             return "Windows Phone";
         }
         return "Windows";
     } else if (/(iPhone|iPad|iPod)/.test(a)) {
         return "iOS";
-    // eslint-disable-next-line @typescript-eslint/prefer-includes
     } else if (/Android/.test(a)) {
         return "Android";
     } else if (/(BlackBerry|PlayBook|BB10)/i.test(a)) {
         return "BlackBerry";
     } else if (/Mac/i.test(a)) {
         return "Mac OS X";
-    // eslint-disable-next-line @typescript-eslint/prefer-includes
     } else if (/Linux/.test(a)) {
         return "Linux";
-    // eslint-disable-next-line @typescript-eslint/prefer-includes
     } else if (/CrOS/.test(a)) {
         return "Chrome OS";
     }
     return "";
 }
 function deviceType(userAgent) {
-    // eslint-disable-next-line @typescript-eslint/prefer-includes
     if (/Windows Phone/i.test(userAgent) || /WPDesktop/.test(userAgent)) {
         return "Windows Phone";
-    // eslint-disable-next-line @typescript-eslint/prefer-includes
     } else if (/iPad/.test(userAgent)) {
         return "iPad";
-    // eslint-disable-next-line @typescript-eslint/prefer-includes
     } else if (/iPod/.test(userAgent)) {
         return "iPod Touch";
-    // eslint-disable-next-line @typescript-eslint/prefer-includes
     } else if (/iPhone/.test(userAgent)) {
         return "iPhone";
     } else if (/(BlackBerry|PlayBook|BB10)/i.test(userAgent)) {
         return "BlackBerry";
-    // eslint-disable-next-line @typescript-eslint/prefer-includes
     } else if (/Android/.test(userAgent)) {
         return "Android";
     }
@@ -128,7 +119,19 @@ function referringDomain(referrer) {
     }
     return "";
 }
+function redactQueryParameters(url, queryParameterNames) {
+    let redactedUrl = url;
+    for (const x of queryParameterNames){
+        // A name can include regular expression special characters, and can be percent-encoded in the URL, such as "user[email]" and "user%5Bemail%5D".
+        const escapedNames = [
+            x,
+            encodeURIComponent(x)
+        ].map((y)=>y.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"));
+        redactedUrl = redactedUrl.replace(new RegExp(`(?:${escapedNames.join("|")})=([^&]*)`, "gi"), ()=>`${x}=**redacted**`);
+    }
+    return redactedUrl;
+}
 
-export { browserName, browserVersion, deviceType, osName, referringDomain };
+export { browserName, browserVersion, deviceType, osName, redactQueryParameters, referringDomain };
 
 //# sourceMappingURL=utils.js.map

package/dist/js/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"js/utils.js","sources":["../../src/js/utils.ts"],"sourcesContent":["// This code is adapted from https://github.com/mixpanel/mixpanel-js/blob/master/src/utils.js\nexport function browserName(userAgent: string, vendor?: string, opera?: object) {\n    // vendor is undefined for at least IE9\n    vendor = vendor || \"\"; // eslint-disable-line no-param-reassign\n\n    if (opera || userAgent.includes(\" OPR/\")) {\n        if (userAgent.includes(\"Mini\")) {\n            return \"Opera Mini\";\n        }\n\n        return \"Opera\";\n    } else if (/(BlackBerry|PlayBook|BB10)/i.test(userAgent)) {\n        return \"BlackBerry\";\n    } else if (userAgent.includes(\"IEMobile\") || userAgent.includes(\"WPDesktop\")) {\n        return \"Internet Explorer Mobile\";\n    } else if (userAgent.includes(\"Edge\")) {\n        return \"Microsoft Edge\";\n    } else if (userAgent.includes(\"FBIOS\")) {\n        return \"Facebook Mobile\";\n    } else if (userAgent.includes(\"Chrome\")) {\n        return \"Chrome\";\n    } else if (userAgent.includes(\"CriOS\")) {\n        return \"Chrome iOS\";\n    } else if (userAgent.includes(\"UCWEB\") || userAgent.includes(\"UCBrowser\")) {\n        return \"UC Browser\";\n    } else if (userAgent.includes(\"FxiOS\")) {\n        return \"Firefox iOS\";\n    } else if (vendor.includes(\"Apple\")) {\n        if (userAgent.includes(\"Mobile\")) {\n            return \"Mobile Safari\";\n        }\n\n        return \"Safari\";\n    } else if (userAgent.includes(\"Android\")) {\n        return \"Android Mobile\";\n    } else if (userAgent.includes(\"Konqueror\")) {\n        return \"Konqueror\";\n    } else if (userAgent.includes(\"Firefox\")) {\n        return \"Firefox\";\n    } else if (userAgent.includes(\"MSIE\") || userAgent.includes(\"Trident/\")) {\n        return \"Internet Explorer\";\n    } else if (userAgent.includes(\"Gecko\")) {\n        return \"Mozilla\";\n    }\n\n    return \"\";\n}\n\n/**\n * This function detects which browser version is running this script,\n * parsing major and minor version (e.g., 42.1). User agent strings from:\n * http://www.useragentstring.com/pages/useragentstring.php\n */\nexport function browserVersion(userAgent: string, vendor?: string, opera?: object) {\n    const browser = browserName(userAgent, vendor, opera);\n    const versionRegexs: { [key: string]: RegExp } = {\n        \"Internet Explorer Mobile\": /rv:(\\d+(\\.\\d+)?)/,\n        \"Microsoft Edge\": /Edge\\/(\\d+(\\.\\d+)?)/,\n        \"Chrome\": /Chrome\\/(\\d+(\\.\\d+)?)/,\n        \"Chrome iOS\": /CriOS\\/(\\d+(\\.\\d+)?)/,\n        \"UC Browser\": /(UCBrowser|UCWEB)\\/(\\d+(\\.\\d+)?)/,\n        \"Safari\": /Version\\/(\\d+(\\.\\d+)?)/,\n        \"Mobile Safari\": /Version\\/(\\d+(\\.\\d+)?)/,\n        \"Opera\": /(Opera|OPR)\\/(\\d+(\\.\\d+)?)/,\n        \"Firefox\": /Firefox\\/(\\d+(\\.\\d+)?)/,\n        \"Firefox iOS\": /FxiOS\\/(\\d+(\\.\\d+)?)/,\n        \"Konqueror\": /Konqueror:(\\d+(\\.\\d+)?)/,\n        \"BlackBerry\": /BlackBerry (\\d+(\\.\\d+)?)/,\n        \"Android Mobile\": /android\\s(\\d+(\\.\\d+)?)/,\n        \"Internet Explorer\": /(rv:|MSIE )(\\d+(\\.\\d+)?)/,\n        \"Mozilla\": /rv:(\\d+(\\.\\d+)?)/\n    };\n    const regex = versionRegexs[browser];\n    if (regex === undefined) {\n        return null;\n    }\n    const matches = userAgent.match(regex);\n    if (!matches) {\n        return null;\n    }\n\n    return parseFloat(matches[matches.length - 2]);\n}\n\nexport function osName(userAgent: string) {\n    const a = userAgent;\n    if (/Windows/i.test(a)) {\n        // eslint-disable-next-line @typescript-eslint/prefer-includes\n        if (/Phone/.test(a) || /WPDesktop/.test(a)) {\n            return \"Windows Phone\";\n        }\n\n        return \"Windows\";\n    } else if (/(iPhone|iPad|iPod)/.test(a)) {\n        return \"iOS\";\n    // eslint-disable-next-line @typescript-eslint/prefer-includes\n    } else if (/Android/.test(a)) {\n        return \"Android\";\n    } else if (/(BlackBerry|PlayBook|BB10)/i.test(a)) {\n        return \"BlackBerry\";\n    } else if (/Mac/i.test(a)) {\n        return \"Mac OS X\";\n    // eslint-disable-next-line @typescript-eslint/prefer-includes\n    } else if (/Linux/.test(a)) {\n        return \"Linux\";\n    // eslint-disable-next-line @typescript-eslint/prefer-includes\n    } else if (/CrOS/.test(a)) {\n        return \"Chrome OS\";\n    }\n\n    return \"\";\n}\n\nexport function deviceType(userAgent: string) {\n    // eslint-disable-next-line @typescript-eslint/prefer-includes\n    if (/Windows Phone/i.test(userAgent) || /WPDesktop/.test(userAgent)) {\n        return \"Windows Phone\";\n    // eslint-disable-next-line @typescript-eslint/prefer-includes\n    } else if (/iPad/.test(userAgent)) {\n        return \"iPad\";\n    // eslint-disable-next-line @typescript-eslint/prefer-includes\n    } else if (/iPod/.test(userAgent)) {\n        return \"iPod Touch\";\n    // eslint-disable-next-line @typescript-eslint/prefer-includes\n    } else if (/iPhone/.test(userAgent)) {\n        return \"iPhone\";\n    } else if (/(BlackBerry|PlayBook|BB10)/i.test(userAgent)) {\n        return \"BlackBerry\";\n    // eslint-disable-next-line @typescript-eslint/prefer-includes\n    } else if (/Android/.test(userAgent)) {\n        return \"Android\";\n    }\n\n    return \"\";\n}\n\nexport function referringDomain(referrer: string) {\n    const split = referrer.split(\"/\");\n    if (split.length >= 3) {\n        return split[2];\n    }\n\n    return \"\";\n}\n"],"names":["browserName","userAgent","vendor","opera","browserVersion","browser","versionRegexs","regex","undefined","matches","parseFloat","osName","a","deviceType","referringDomain","referrer","split"],"mappings":"AAAA,6FAA6F;AACtF,SAASA,WAAWA,CAACC,SAAiB,EAAEC,MAAe,EAAEC,KAAc;IAC1E,uCAAuC;IACvCD,SAASA,UAAU,IAAI,wCAAwC;IAE/D,IAAIC,SAASF,UAAU,QAAQ,CAAC,UAAU;QACtC,IAAIA,UAAU,QAAQ,CAAC,SAAS;YAC5B,OAAO;QACX;QAEA,OAAO;IACX,OAAO,IAAI,8BAA8B,IAAI,CAACA,YAAY;QACtD,OAAO;IACX,OAAO,IAAIA,UAAU,QAAQ,CAAC,eAAeA,UAAU,QAAQ,CAAC,cAAc;QAC1E,OAAO;IACX,OAAO,IAAIA,UAAU,QAAQ,CAAC,SAAS;QACnC,OAAO;IACX,OAAO,IAAIA,UAAU,QAAQ,CAAC,UAAU;QACpC,OAAO;IACX,OAAO,IAAIA,UAAU,QAAQ,CAAC,WAAW;QACrC,OAAO;IACX,OAAO,IAAIA,UAAU,QAAQ,CAAC,UAAU;QACpC,OAAO;IACX,OAAO,IAAIA,UAAU,QAAQ,CAAC,YAAYA,UAAU,QAAQ,CAAC,cAAc;QACvE,OAAO;IACX,OAAO,IAAIA,UAAU,QAAQ,CAAC,UAAU;QACpC,OAAO;IACX,OAAO,IAAIC,OAAO,QAAQ,CAAC,UAAU;QACjC,IAAID,UAAU,QAAQ,CAAC,WAAW;YAC9B,OAAO;QACX;QAEA,OAAO;IACX,OAAO,IAAIA,UAAU,QAAQ,CAAC,YAAY;QACtC,OAAO;IACX,OAAO,IAAIA,UAAU,QAAQ,CAAC,cAAc;QACxC,OAAO;IACX,OAAO,IAAIA,UAAU,QAAQ,CAAC,YAAY;QACtC,OAAO;IACX,OAAO,IAAIA,UAAU,QAAQ,CAAC,WAAWA,UAAU,QAAQ,CAAC,aAAa;QACrE,OAAO;IACX,OAAO,IAAIA,UAAU,QAAQ,CAAC,UAAU;QACpC,OAAO;IACX;IAEA,OAAO;AACX;AAEA;;;;CAIC,GACM,SAASG,cAAcA,CAACH,SAAiB,EAAEC,MAAe,EAAEC,KAAc;IAC7E,MAAME,UAAUL,WAAWA,CAACC,WAAWC,QAAQC;IAC/C,MAAMG,gBAA2C;QAC7C,4BAA4B;QAC5B,kBAAkB;QAClB,UAAU;QACV,cAAc;QACd,cAAc;QACd,UAAU;QACV,iBAAiB;QACjB,SAAS;QACT,WAAW;QACX,eAAe;QACf,aAAa;QACb,cAAc;QACd,kBAAkB;QAClB,qBAAqB;QACrB,WAAW;IACf;IACA,MAAMC,QAAQD,aAAa,CAACD,QAAQ;IACpC,IAAIE,UAAUC,WAAW;QACrB,OAAO;IACX;IACA,MAAMC,UAAUR,UAAU,KAAK,CAACM;IAChC,IAAI,CAACE,SAAS;QACV,OAAO;IACX;IAEA,OAAOC,WAAWD,OAAO,CAACA,QAAQ,MAAM,GAAG,EAAE;AACjD;AAEO,SAASE,MAAMA,CAACV,SAAiB;IACpC,MAAMW,IAAIX;IACV,IAAI,WAAW,IAAI,CAACW,IAAI;QACpB,8DAA8D;QAC9D,IAAI,QAAQ,IAAI,CAACA,MAAM,YAAY,IAAI,CAACA,IAAI;YACxC,OAAO;QACX;QAEA,OAAO;IACX,OAAO,IAAI,qBAAqB,IAAI,CAACA,IAAI;QACrC,OAAO;IACX,8DAA8D;IAC9D,OAAO,IAAI,UAAU,IAAI,CAACA,IAAI;QAC1B,OAAO;IACX,OAAO,IAAI,8BAA8B,IAAI,CAACA,IAAI;QAC9C,OAAO;IACX,OAAO,IAAI,OAAO,IAAI,CAACA,IAAI;QACvB,OAAO;IACX,8DAA8D;IAC9D,OAAO,IAAI,QAAQ,IAAI,CAACA,IAAI;QACxB,OAAO;IACX,8DAA8D;IAC9D,OAAO,IAAI,OAAO,IAAI,CAACA,IAAI;QACvB,OAAO;IACX;IAEA,OAAO;AACX;AAEO,SAASC,UAAUA,CAACZ,SAAiB;IACxC,8DAA8D;IAC9D,IAAI,iBAAiB,IAAI,CAACA,cAAc,YAAY,IAAI,CAACA,YAAY;QACjE,OAAO;IACX,8DAA8D;IAC9D,OAAO,IAAI,OAAO,IAAI,CAACA,YAAY;QAC/B,OAAO;IACX,8DAA8D;IAC9D,OAAO,IAAI,OAAO,IAAI,CAACA,YAAY;QAC/B,OAAO;IACX,8DAA8D;IAC9D,OAAO,IAAI,SAAS,IAAI,CAACA,YAAY;QACjC,OAAO;IACX,OAAO,IAAI,8BAA8B,IAAI,CAACA,YAAY;QACtD,OAAO;IACX,8DAA8D;IAC9D,OAAO,IAAI,UAAU,IAAI,CAACA,YAAY;QAClC,OAAO;IACX;IAEA,OAAO;AACX;AAEO,SAASa,eAAeA,CAACC,QAAgB;IAC5C,MAAMC,QAAQD,SAAS,KAAK,CAAC;IAC7B,IAAIC,MAAM,MAAM,IAAI,GAAG;QACnB,OAAOA,KAAK,CAAC,EAAE;IACnB;IAEA,OAAO;AACX"}
+{"version":3,"file":"js/utils.js","sources":["../../src/js/utils.ts"],"sourcesContent":["// This code is adapted from https://github.com/mixpanel/mixpanel-js/blob/master/src/utils.js\nexport function browserName(userAgent: string, vendor?: string, opera?: object) {\n    // vendor is undefined for at least IE9\n    vendor = vendor || \"\"; // oxlint-disable-line eslint/no-param-reassign\n\n    if (opera || userAgent.includes(\" OPR/\")) {\n        if (userAgent.includes(\"Mini\")) {\n            return \"Opera Mini\";\n        }\n\n        return \"Opera\";\n    } else if (/(BlackBerry|PlayBook|BB10)/i.test(userAgent)) {\n        return \"BlackBerry\";\n    } else if (userAgent.includes(\"IEMobile\") || userAgent.includes(\"WPDesktop\")) {\n        return \"Internet Explorer Mobile\";\n    } else if (userAgent.includes(\"Edge\")) {\n        return \"Microsoft Edge\";\n    } else if (userAgent.includes(\"FBIOS\")) {\n        return \"Facebook Mobile\";\n    } else if (userAgent.includes(\"Chrome\")) {\n        return \"Chrome\";\n    } else if (userAgent.includes(\"CriOS\")) {\n        return \"Chrome iOS\";\n    } else if (userAgent.includes(\"UCWEB\") || userAgent.includes(\"UCBrowser\")) {\n        return \"UC Browser\";\n    } else if (userAgent.includes(\"FxiOS\")) {\n        return \"Firefox iOS\";\n    } else if (vendor.includes(\"Apple\")) {\n        if (userAgent.includes(\"Mobile\")) {\n            return \"Mobile Safari\";\n        }\n\n        return \"Safari\";\n    } else if (userAgent.includes(\"Android\")) {\n        return \"Android Mobile\";\n    } else if (userAgent.includes(\"Konqueror\")) {\n        return \"Konqueror\";\n    } else if (userAgent.includes(\"Firefox\")) {\n        return \"Firefox\";\n    } else if (userAgent.includes(\"MSIE\") || userAgent.includes(\"Trident/\")) {\n        return \"Internet Explorer\";\n    } else if (userAgent.includes(\"Gecko\")) {\n        return \"Mozilla\";\n    }\n\n    return \"\";\n}\n\n/**\n * This function detects which browser version is running this script,\n * parsing major and minor version (e.g., 42.1). User agent strings from:\n * http://www.useragentstring.com/pages/useragentstring.php\n */\nexport function browserVersion(userAgent: string, vendor?: string, opera?: object) {\n    const browser = browserName(userAgent, vendor, opera);\n    const versionRegexs: { [key: string]: RegExp } = {\n        \"Internet Explorer Mobile\": /rv:(\\d+(\\.\\d+)?)/,\n        \"Microsoft Edge\": /Edge\\/(\\d+(\\.\\d+)?)/,\n        Chrome: /Chrome\\/(\\d+(\\.\\d+)?)/,\n        \"Chrome iOS\": /CriOS\\/(\\d+(\\.\\d+)?)/,\n        \"UC Browser\": /(UCBrowser|UCWEB)\\/(\\d+(\\.\\d+)?)/,\n        Safari: /Version\\/(\\d+(\\.\\d+)?)/,\n        \"Mobile Safari\": /Version\\/(\\d+(\\.\\d+)?)/,\n        Opera: /(Opera|OPR)\\/(\\d+(\\.\\d+)?)/,\n        Firefox: /Firefox\\/(\\d+(\\.\\d+)?)/,\n        \"Firefox iOS\": /FxiOS\\/(\\d+(\\.\\d+)?)/,\n        Konqueror: /Konqueror:(\\d+(\\.\\d+)?)/,\n        BlackBerry: /BlackBerry (\\d+(\\.\\d+)?)/,\n        \"Android Mobile\": /android\\s(\\d+(\\.\\d+)?)/,\n        \"Internet Explorer\": /(rv:|MSIE )(\\d+(\\.\\d+)?)/,\n        Mozilla: /rv:(\\d+(\\.\\d+)?)/\n    };\n    const regex = versionRegexs[browser];\n    if (regex === undefined) {\n        return null;\n    }\n    const matches = userAgent.match(regex);\n    if (!matches) {\n        return null;\n    }\n\n    return parseFloat(matches[matches.length - 2]);\n}\n\nexport function osName(userAgent: string) {\n    const a = userAgent;\n    if (/Windows/i.test(a)) {\n        if (/Phone/.test(a) || /WPDesktop/.test(a)) {\n            return \"Windows Phone\";\n        }\n\n        return \"Windows\";\n    } else if (/(iPhone|iPad|iPod)/.test(a)) {\n        return \"iOS\";\n    } else if (/Android/.test(a)) {\n        return \"Android\";\n    } else if (/(BlackBerry|PlayBook|BB10)/i.test(a)) {\n        return \"BlackBerry\";\n    } else if (/Mac/i.test(a)) {\n        return \"Mac OS X\";\n    } else if (/Linux/.test(a)) {\n        return \"Linux\";\n    } else if (/CrOS/.test(a)) {\n        return \"Chrome OS\";\n    }\n\n    return \"\";\n}\n\nexport function deviceType(userAgent: string) {\n    if (/Windows Phone/i.test(userAgent) || /WPDesktop/.test(userAgent)) {\n        return \"Windows Phone\";\n    } else if (/iPad/.test(userAgent)) {\n        return \"iPad\";\n    } else if (/iPod/.test(userAgent)) {\n        return \"iPod Touch\";\n    } else if (/iPhone/.test(userAgent)) {\n        return \"iPhone\";\n    } else if (/(BlackBerry|PlayBook|BB10)/i.test(userAgent)) {\n        return \"BlackBerry\";\n    } else if (/Android/.test(userAgent)) {\n        return \"Android\";\n    }\n\n    return \"\";\n}\n\nexport function referringDomain(referrer: string) {\n    const split = referrer.split(\"/\");\n    if (split.length >= 3) {\n        return split[2];\n    }\n\n    return \"\";\n}\n\nexport function redactQueryParameters(url: string, queryParameterNames: string[]) {\n    let redactedUrl = url;\n\n    for (const x of queryParameterNames) {\n        // A name can include regular expression special characters, and can be percent-encoded in the URL, such as \"user[email]\" and \"user%5Bemail%5D\".\n        const escapedNames = [x, encodeURIComponent(x)].map(y => y.replace(/[.*+?^${}()|[\\]\\\\]/g, \"\\\\$&\"));\n\n        redactedUrl = redactedUrl.replace(new RegExp(`(?:${escapedNames.join(\"|\")})=([^&]*)`, \"gi\"), () => `${x}=**redacted**`);\n    }\n\n    return redactedUrl;\n}\n"],"names":["browserName","userAgent","vendor","opera","browserVersion","browser","versionRegexs","regex","undefined","matches","parseFloat","osName","a","deviceType","referringDomain","referrer","split","redactQueryParameters","url","queryParameterNames","redactedUrl","x","escapedNames","encodeURIComponent","y","RegExp"],"mappings":"AAAA,6FAA6F;AACtF,SAASA,YAAYC,SAAiB,EAAEC,MAAe,EAAEC,KAAc;IAC1E,uCAAuC;IACvCD,SAASA,UAAU,IAAI,+CAA+C;IAEtE,IAAIC,SAASF,UAAU,QAAQ,CAAC,UAAU;QACtC,IAAIA,UAAU,QAAQ,CAAC,SAAS;YAC5B,OAAO;QACX;QAEA,OAAO;IACX,OAAO,IAAI,8BAA8B,IAAI,CAACA,YAAY;QACtD,OAAO;IACX,OAAO,IAAIA,UAAU,QAAQ,CAAC,eAAeA,UAAU,QAAQ,CAAC,cAAc;QAC1E,OAAO;IACX,OAAO,IAAIA,UAAU,QAAQ,CAAC,SAAS;QACnC,OAAO;IACX,OAAO,IAAIA,UAAU,QAAQ,CAAC,UAAU;QACpC,OAAO;IACX,OAAO,IAAIA,UAAU,QAAQ,CAAC,WAAW;QACrC,OAAO;IACX,OAAO,IAAIA,UAAU,QAAQ,CAAC,UAAU;QACpC,OAAO;IACX,OAAO,IAAIA,UAAU,QAAQ,CAAC,YAAYA,UAAU,QAAQ,CAAC,cAAc;QACvE,OAAO;IACX,OAAO,IAAIA,UAAU,QAAQ,CAAC,UAAU;QACpC,OAAO;IACX,OAAO,IAAIC,OAAO,QAAQ,CAAC,UAAU;QACjC,IAAID,UAAU,QAAQ,CAAC,WAAW;YAC9B,OAAO;QACX;QAEA,OAAO;IACX,OAAO,IAAIA,UAAU,QAAQ,CAAC,YAAY;QACtC,OAAO;IACX,OAAO,IAAIA,UAAU,QAAQ,CAAC,cAAc;QACxC,OAAO;IACX,OAAO,IAAIA,UAAU,QAAQ,CAAC,YAAY;QACtC,OAAO;IACX,OAAO,IAAIA,UAAU,QAAQ,CAAC,WAAWA,UAAU,QAAQ,CAAC,aAAa;QACrE,OAAO;IACX,OAAO,IAAIA,UAAU,QAAQ,CAAC,UAAU;QACpC,OAAO;IACX;IAEA,OAAO;AACX;AAEA;;;;CAIC,GACM,SAASG,eAAeH,SAAiB,EAAEC,MAAe,EAAEC,KAAc;IAC7E,MAAME,UAAUL,YAAYC,WAAWC,QAAQC;IAC/C,MAAMG,gBAA2C;QAC7C,4BAA4B;QAC5B,kBAAkB;QAClB,QAAQ;QACR,cAAc;QACd,cAAc;QACd,QAAQ;QACR,iBAAiB;QACjB,OAAO;QACP,SAAS;QACT,eAAe;QACf,WAAW;QACX,YAAY;QACZ,kBAAkB;QAClB,qBAAqB;QACrB,SAAS;IACb;IACA,MAAMC,QAAQD,aAAa,CAACD,QAAQ;IACpC,IAAIE,UAAUC,WAAW;QACrB,OAAO;IACX;IACA,MAAMC,UAAUR,UAAU,KAAK,CAACM;IAChC,IAAI,CAACE,SAAS;QACV,OAAO;IACX;IAEA,OAAOC,WAAWD,OAAO,CAACA,QAAQ,MAAM,GAAG,EAAE;AACjD;AAEO,SAASE,OAAOV,SAAiB;IACpC,MAAMW,IAAIX;IACV,IAAI,WAAW,IAAI,CAACW,IAAI;QACpB,IAAI,QAAQ,IAAI,CAACA,MAAM,YAAY,IAAI,CAACA,IAAI;YACxC,OAAO;QACX;QAEA,OAAO;IACX,OAAO,IAAI,qBAAqB,IAAI,CAACA,IAAI;QACrC,OAAO;IACX,OAAO,IAAI,UAAU,IAAI,CAACA,IAAI;QAC1B,OAAO;IACX,OAAO,IAAI,8BAA8B,IAAI,CAACA,IAAI;QAC9C,OAAO;IACX,OAAO,IAAI,OAAO,IAAI,CAACA,IAAI;QACvB,OAAO;IACX,OAAO,IAAI,QAAQ,IAAI,CAACA,IAAI;QACxB,OAAO;IACX,OAAO,IAAI,OAAO,IAAI,CAACA,IAAI;QACvB,OAAO;IACX;IAEA,OAAO;AACX;AAEO,SAASC,WAAWZ,SAAiB;IACxC,IAAI,iBAAiB,IAAI,CAACA,cAAc,YAAY,IAAI,CAACA,YAAY;QACjE,OAAO;IACX,OAAO,IAAI,OAAO,IAAI,CAACA,YAAY;QAC/B,OAAO;IACX,OAAO,IAAI,OAAO,IAAI,CAACA,YAAY;QAC/B,OAAO;IACX,OAAO,IAAI,SAAS,IAAI,CAACA,YAAY;QACjC,OAAO;IACX,OAAO,IAAI,8BAA8B,IAAI,CAACA,YAAY;QACtD,OAAO;IACX,OAAO,IAAI,UAAU,IAAI,CAACA,YAAY;QAClC,OAAO;IACX;IAEA,OAAO;AACX;AAEO,SAASa,gBAAgBC,QAAgB;IAC5C,MAAMC,QAAQD,SAAS,KAAK,CAAC;IAC7B,IAAIC,MAAM,MAAM,IAAI,GAAG;QACnB,OAAOA,KAAK,CAAC,EAAE;IACnB;IAEA,OAAO;AACX;AAEO,SAASC,sBAAsBC,GAAW,EAAEC,mBAA6B;IAC5E,IAAIC,cAAcF;IAElB,KAAK,MAAMG,KAAKF,oBAAqB;QACjC,gJAAgJ;QAChJ,MAAMG,eAAe;YAACD;YAAGE,mBAAmBF;SAAG,CAAC,GAAG,CAACG,CAAAA,IAAKA,EAAE,OAAO,CAAC,uBAAuB;QAE1FJ,cAAcA,YAAY,OAAO,CAAC,IAAIK,OAAO,CAAC,GAAG,EAAEH,aAAa,IAAI,CAAC,KAAK,SAAS,CAAC,EAAE,OAAO,IAAM,GAAGD,EAAE,aAAa,CAAC;IAC1H;IAEA,OAAOD;AACX"}

package/dist/react/MixpanelContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"react/MixpanelContext.js","sources":["../../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    throwOnUndefined?: boolean;\n}\n\nexport function useMixpanelClient(options?: { throwOnUndefined?: true }): MixpanelClient;\nexport function useMixpanelClient(options: { throwOnUndefined: false }): 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        throwOnUndefined = true\n    } = options;\n\n    const client = useContext(MixpanelContext);\n\n    if (!client && throwOnUndefined) {\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","throwOnUndefined","Error"],"mappings":";;;;;;AAA0E;AAGnE,MAAME,eAAeA,iBAAGF,aAAaA,CAA6BG,WAAW;AASpF;;CAEC,GACM,SAASC,gBAAgBA,CAACC,KAA4B;IACzD,MAAM,EACFC,MAAM,EACNC,QAAQ,EACX,GAAGF;IAEJ,qBACI,IAACH,eAAeA,CAAC,QAAQ;QAAC,OAAOI;kBAC5BC;;AAGb;AAYA;;;CAGC,GACM,SAASC,iBAAiBA,CAACC,UAAoC,CAAC,CAAC;IACpE,MAAM,EACFC,mBAAmB,IAAI,EAC1B,GAAGD;IAEJ,MAAMH,SAASL,UAAUA,CAACC,eAAeA;IAEzC,IAAI,CAACI,UAAUI,kBAAkB;QAC7B,MAAM,IAAIC,MAAM;IACpB;IAEA,OAAOL;AACX"}
+{"version":3,"file":"react/MixpanelContext.js","sources":["../../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 { client, children } = props;\n\n    return <MixpanelContext.Provider value={client}>{children}</MixpanelContext.Provider>;\n}\n\nexport interface UseMixpanelClientOptions {\n    /**\n     * Whether or not an exception should be thrown if the client hasn't been provided.\n     */\n    throwOnUndefined?: boolean;\n}\n\nexport function useMixpanelClient(options?: { throwOnUndefined?: true }): MixpanelClient;\nexport function useMixpanelClient(options: { throwOnUndefined: false }): 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 { throwOnUndefined = true } = options;\n\n    const client = useContext(MixpanelContext);\n\n    if (!client && throwOnUndefined) {\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","throwOnUndefined","Error"],"mappings":";;;;;;AAA0E;AAGnE,MAAME,gCAAkBF,aAAaA,CAA6BG,WAAW;AASpF;;CAEC,GACM,SAASC,iBAAiBC,KAA4B;IACzD,MAAM,EAAEC,MAAM,EAAEC,QAAQ,EAAE,GAAGF;IAE7B,qBAAO,IAACH,gBAAgB,QAAQ;QAAC,OAAOI;kBAASC;;AACrD;AAYA;;;CAGC,GACM,SAASC,kBAAkBC,UAAoC,CAAC,CAAC;IACpE,MAAM,EAAEC,mBAAmB,IAAI,EAAE,GAAGD;IAEpC,MAAMH,SAASL,UAAUA,CAACC;IAE1B,IAAI,CAACI,UAAUI,kBAAkB;QAC7B,MAAM,IAAIC,MAAM;IACpB;IAEA,OAAOL;AACX"}

package/dist/react/MixpanelPropertiesProvider.js.map

@@ -1 +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,yBAAyBA,iBAAGH,aAAaA,CAA0B,CAAC;AAS1E;;;CAGC,GACM,SAASI,0BAA0BA,CAACC,KAAsC;IAC7E,MAAM,EACFC,KAAK,EACLC,QAAQ,EACX,GAAGF;IAEJ,MAAMG,gBAAgBP,UAAUA,CAACE,yBAAyBA;IAE1D,MAAMM,eAAeP,OAAOA,CAAC,IAAO;YAChC,GAAGM,aAAa;YAChB,GAAGF,KAAK;QACZ,IAAI;QAACE;QAAeF;KAAM;IAE1B,qBACI,IAACH,yBAAyBA,CAAC,QAAQ;QAAC,OAAOM;kBACtCF;;AAGb;AAEA;;;;CAIC,GACM,MAAMG,6BAA6BA,GAAG;IACzC,OAAOT,UAAUA,CAACE,yBAAyBA;AAC/C,EAAE"}
+{"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 { value, children } = props;\n\n    const parentContext = useContext(MixpanelPropertiesContext);\n\n    const contextValue = useMemo(\n        () => ({\n            ...parentContext,\n            ...value\n        }),\n        [parentContext, value]\n    );\n\n    return <MixpanelPropertiesContext.Provider value={contextValue}>{children}</MixpanelPropertiesContext.Provider>;\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,EAAEC,KAAK,EAAEC,QAAQ,EAAE,GAAGF;IAE5B,MAAMG,gBAAgBP,UAAUA,CAACE;IAEjC,MAAMM,eAAeP,OAAOA,CACxB,IAAO;YACH,GAAGM,aAAa;YAChB,GAAGF,KAAK;QACZ,IACA;QAACE;QAAeF;KAAM;IAG1B,qBAAO,IAACH,0BAA0B,QAAQ;QAAC,OAAOM;kBAAeF;;AACrE;AAEA;;;;CAIC,GACM,MAAMG,gCAAgC;IACzC,OAAOT,UAAUA,CAACE;AACtB,EAAE"}

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 { 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"}
+{"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"],"names":["MixpanelProvider","useMixpanelClient","MixpanelPropertiesProvider","useMixpanelProviderProperties","useTrackingFunction"],"mappings":";;;;AAA+B;AAC4E;AACwC;AACnD"}

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 { 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,mBAAmBA,CAACC,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"}
+{"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 { productId, targetProductId } = 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,EAAEC,SAAS,EAAEC,eAAe,EAAE,GAAGF;IAEvC,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,19 +1,21 @@
 {
   "name": "@workleap/mixpanel",
-  "author": "Workleap",
-  "version": "6.0.2",
+  "version": "6.1.0",
   "description": "A package containing utilities for Mixpanel telemetry.",
   "license": "Apache-2.0",
+  "author": "Workleap",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/workleap/wl-telemetry.git",
     "directory": "packages/mixpanel"
   },
+  "files": [
+    "src",
+    "dist",
+    "CHANGELOG.md"
+  ],
   "type": "module",
-  "publishConfig": {
-    "access": "public",
-    "provenance": true
-  },
+  "sideEffects": false,
   "exports": {
     ".": {
       "types": "./dist/js/index.d.ts",
@@ -26,14 +28,28 @@
       "default": "./dist/react/index.js"
     }
   },
-  "files": [
-    "src",
-    "dist",
-    "CHANGELOG.md"
-  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "dependencies": {
+    "@workleap-telemetry/core": "^2.0.7",
+    "@workleap/logging": "^2.1.0"
+  },
+  "devDependencies": {
+    "@rsbuild/core": "2.3.1",
+    "@rslib/core": "1.0.6",
+    "@types/node": "26.6.6",
+    "@types/react": "19.3.0",
+    "@workleap/rslib-configs": "2.1.1",
+    "@workleap/typescript-configs": "5.1.0",
+    "happy-dom": "21.0.4",
+    "typescript": "7.0.2",
+    "vitest": "5.1.0"
+  },
   "peerDependencies": {
     "@types/react": "^18.0.0 || ^19.0.0",
-    "@workleap/logrocket": "^4.0.4",
+    "@workleap/logrocket": "^4.0.7",
     "react": "^18.0.0 || ^19.0.0",
     "react-dom": "^18.0.0 || ^19.0.0"
   },
@@ -51,32 +67,9 @@
       "optional": true
     }
   },
-  "dependencies": {
-    "@workleap-telemetry/core": "^2.0.6",
-    "@workleap/logging": "^2.0.1"
-  },
-  "devDependencies": {
-    "@eslint/js": "9.39.2",
-    "@rsbuild/core": "2.2.14",
-    "@rslib/core": "1.0.3",
-    "@types/node": "26.6.5",
-    "@types/react": "19.3.0",
-    "@typescript-eslint/parser": "8.72.0",
-    "@typescript/native-preview": "7.0.0-dev.20260707.2",
-    "@workleap/eslint-configs": "2.0.6",
-    "@workleap/rslib-configs": "2.0.0",
-    "@workleap/typescript-configs": "5.0.0",
-    "eslint": "9.39.2",
-    "happy-dom": "21.0.4",
-    "typescript": "6.0.3",
-    "typescript-eslint": "8.72.0",
-    "vitest": "5.0.5"
-  },
-  "sideEffects": false,
   "scripts": {
     "build": "rslib build --config ./rslib.build.ts",
-    "eslint": "eslint . --max-warnings=0 --cache --cache-location node_modules/.cache/eslint",
-    "typecheck": "tsgo",
+    "typecheck": "tsc",
     "test": "vitest --config vitest.config.ts --no-watch"
   }
 }

package/src/js/MixpanelClient.ts

@@ -28,40 +28,40 @@ export interface MixpanelClientOptions {
      * @see {@link https://workleap.github.io/wl-telemetry}
      */
     productId?: string;
+    /**
+     * @see {@link https://workleap.github.io/wl-telemetry}
+     */
+    privateQueryParameterNames?: string[];
 }
 
+const DefaultPrivateQueryParameterNames = ["token", "email", "password"];
+
 export class MixpanelClientImpl implements MixpanelClient {
     readonly #globalEventProperties = new Map<string, unknown>();
     readonly #endpoint: string;
     readonly #logger: Logger;
     readonly #productId?: string;
+    readonly #privateQueryParameterNames: string[];
 
     constructor(endpoint: string, logger: Logger, options: MixpanelClientOptions = {}) {
-        const {
-            productId
-        } = options;
+        const { productId, privateQueryParameterNames = [] } = options;
 
         this.#endpoint = endpoint;
         this.#logger = logger;
         this.#productId = productId;
+        this.#privateQueryParameterNames = DefaultPrivateQueryParameterNames.concat(privateQueryParameterNames);
     }
 
     // IMPORTANT: If you update this method, make sure to update the MixpanelPartialClient
     // interface as well in @workleap-telemetry/core.
     createTrackingFunction(options: CreateMixpanelTrackingFunctionOptions = {}) {
-        const {
-            productId,
-            targetProductId,
-            additionalProperties = {}
-        } = options;
+        const { productId, targetProductId, additionalProperties = {} } = options;
 
         const trackFunction: MixpanelTrackingFunction = async (eventName, properties, _options = {}) => {
             try {
-                const {
-                    keepAlive = false
-                } = _options;
+                const { keepAlive = false } = _options;
 
-                const baseProperties = getBaseProperties();
+                const baseProperties = getBaseProperties(this.#privateQueryParameterNames);
 
                 const allProperties = {
                     ...baseProperties,

package/src/js/env.ts

@@ -1,13 +1,13 @@
 const EnvironmentList = ["development", "staging", "production", "local", "msw"] as const;
 
-export type MixpanelEnvironment = typeof EnvironmentList[number];
+export type MixpanelEnvironment = (typeof EnvironmentList)[number];
 
 const NavigationApiBaseUrl: Record<MixpanelEnvironment, string> = {
-    "production": "https://api.platform.workleap.com/shell/navigation/",
-    "staging": "https://api.platform.workleap-stg.com/shell/navigation/",
-    "development": "https://api.platform.workleap-dev.com/shell/navigation/",
-    "local": "https://api.platform.workleap-dev.com/shell/navigation/",
-    "msw": "/api/shell/navigation/"
+    production: "https://api.platform.workleap.com/shell/navigation/",
+    staging: "https://api.platform.workleap-stg.com/shell/navigation/",
+    development: "https://api.platform.workleap-dev.com/shell/navigation/",
+    local: "https://api.platform.workleap-dev.com/shell/navigation/",
+    msw: "/api/shell/navigation/"
 };
 
 // Cannot use URL() because it doesn't support relative base url: https://github.com/whatwg/url/issues/531.

package/src/js/index.ts

@@ -4,4 +4,3 @@ export type { MixpanelEnvironment } from "./env.ts";
 export { initializeMixpanel, type InitializeMixpanelOptions } from "./initializeMixpanel.ts";
 export type { MixpanelClient } from "./MixpanelClient.ts";
 export { NoopMixpanelClient } from "./NoopMixpanelClient.ts";
-

package/src/js/initializeMixpanel.ts

@@ -40,6 +40,11 @@ export interface InitializeMixpanelOptions {
      * @see {@link https://workleap.github.io/wl-telemetry}
      */
     trackingEndpoint?: string;
+    /**
+     * Names of additional query parameters to redact from the URLs sent with every event.
+     * @see {@link https://workleap.github.io/wl-telemetry}
+     */
+    privateQueryParameterNames?: string[];
     /**
      * Context including telemetry correlation ids.
      * @see {@link https://workleap.github.io/wl-telemetry}
@@ -65,14 +70,7 @@ export interface InitializeMixpanelOptions {
 
 export class MixpanelInitializer {
     initialize(envOrTrackingApiBaseUrl: MixpanelEnvironment | (string & {}), options: Omit<InitializeMixpanelOptions, "globalEventProperties"> = {}) {
-        const {
-            productId,
-            trackingEndpoint,
-            telemetryContext,
-            logRocketInstrumentationClient,
-            verbose = false,
-            loggers = []
-        } = options;
+        const { productId, trackingEndpoint, privateQueryParameterNames, telemetryContext, logRocketInstrumentationClient, verbose = false, loggers = [] } = options;
 
         const logger = createCompositeLogger(verbose, loggers);
         const endpoint = getTrackingEndpoint(envOrTrackingApiBaseUrl, trackingEndpoint);
@@ -80,7 +78,8 @@ export class MixpanelInitializer {
         logger.information("[mixpanel] Mixpanel is initialized.");
 
         const client = new MixpanelClientImpl(endpoint, logger, {
-            productId
+            productId,
+            privateQueryParameterNames
         });
 
         // Set the telemetry correlation ids on every Mixpanel event.
@@ -94,10 +93,7 @@ export class MixpanelInitializer {
         // once it's available to set it on every Mixpanel event.
         if (logRocketInstrumentationClient) {
             logRocketInstrumentationClient.registerGetSessionUrlListener((sessionUrl: string) => {
-                logger
-                    .withText("[mixpanel] Received LogRocket session replay URL:")
-                    .withText(sessionUrl)
-                    .debug();
+                logger.withText("[mixpanel] Received LogRocket session replay URL:").withText(sessionUrl).debug();
 
                 client.setGlobalEventProperty(OtherProperties.LogRocketSessionUrl, sessionUrl);
             });
@@ -115,14 +111,8 @@ export class MixpanelInitializer {
  * @returns {MixpanelClient} A Mixpanel client instance.
  * @see {@link https://workleap.github.io/wl-telemetry}
  */
-export function initializeMixpanel(
-    envOrTrackingApiBaseUrl: MixpanelEnvironment | (string & {}),
-    options?: InitializeMixpanelOptions
-) {
-    getRegistrationGuard().throw("[mixpanel] Mixpanel has already been initialized. Did you call the \"initializeMixpanel\" function twice?");
-
-    return new MixpanelInitializer().initialize(
-        envOrTrackingApiBaseUrl,
-        options
-    );
+export function initializeMixpanel(envOrTrackingApiBaseUrl: MixpanelEnvironment | (string & {}), options?: InitializeMixpanelOptions) {
+    getRegistrationGuard().throw('[mixpanel] Mixpanel has already been initialized. Did you call the "initializeMixpanel" function twice?');
+
+    return new MixpanelInitializer().initialize(envOrTrackingApiBaseUrl, options);
 }

package/src/js/properties.ts

@@ -1,6 +1,5 @@
-
 import type { MixpanelEventProperties, TelemetryContext } from "@workleap-telemetry/core";
-import { browserName, browserVersion, deviceType, osName, referringDomain } from "./utils.ts";
+import { browserName, browserVersion, deviceType, osName, redactQueryParameters, referringDomain } from "./utils.ts";
 
 export const BaseProperties = {
     Browser: "$browser",
@@ -15,17 +14,18 @@ export const BaseProperties = {
     ScreenWidth: "$screen_width"
 } as const;
 
-export function getBaseProperties() {
+export function getBaseProperties(privateQueryParameterNames: string[]) {
     const userAgent = navigator.userAgent;
     const device = deviceType(userAgent);
 
     return {
         [BaseProperties.Os]: osName(userAgent),
         [BaseProperties.Browser]: browserName(userAgent, navigator.vendor),
-        [BaseProperties.Referrer]: document.referrer,
+        [BaseProperties.Referrer]: redactQueryParameters(document.referrer, privateQueryParameterNames),
         [BaseProperties.ReferringDomain]: referringDomain(document.referrer),
         [BaseProperties.Device]: device,
-        [BaseProperties.CurrentUrl]: window.location.href,
+        // The fragment is removed because it can include sensitive values, such as an access token.
+        [BaseProperties.CurrentUrl]: redactQueryParameters(window.location.href.split("#")[0], privateQueryParameterNames),
         [BaseProperties.BrowserVersion]: browserVersion(userAgent, navigator.vendor),
         [BaseProperties.ScreenHeight]: window.screen.height,
         [BaseProperties.ScreenWidth]: window.screen.width,

package/src/js/utils.ts

@@ -1,7 +1,7 @@
 // This code is adapted from https://github.com/mixpanel/mixpanel-js/blob/master/src/utils.js
 export function browserName(userAgent: string, vendor?: string, opera?: object) {
     // vendor is undefined for at least IE9
-    vendor = vendor || ""; // eslint-disable-line no-param-reassign
+    vendor = vendor || ""; // oxlint-disable-line eslint/no-param-reassign
 
     if (opera || userAgent.includes(" OPR/")) {
         if (userAgent.includes("Mini")) {
@@ -56,19 +56,19 @@ export function browserVersion(userAgent: string, vendor?: string, opera?: objec
     const versionRegexs: { [key: string]: RegExp } = {
         "Internet Explorer Mobile": /rv:(\d+(\.\d+)?)/,
         "Microsoft Edge": /Edge\/(\d+(\.\d+)?)/,
-        "Chrome": /Chrome\/(\d+(\.\d+)?)/,
+        Chrome: /Chrome\/(\d+(\.\d+)?)/,
         "Chrome iOS": /CriOS\/(\d+(\.\d+)?)/,
         "UC Browser": /(UCBrowser|UCWEB)\/(\d+(\.\d+)?)/,
-        "Safari": /Version\/(\d+(\.\d+)?)/,
+        Safari: /Version\/(\d+(\.\d+)?)/,
         "Mobile Safari": /Version\/(\d+(\.\d+)?)/,
-        "Opera": /(Opera|OPR)\/(\d+(\.\d+)?)/,
-        "Firefox": /Firefox\/(\d+(\.\d+)?)/,
+        Opera: /(Opera|OPR)\/(\d+(\.\d+)?)/,
+        Firefox: /Firefox\/(\d+(\.\d+)?)/,
         "Firefox iOS": /FxiOS\/(\d+(\.\d+)?)/,
-        "Konqueror": /Konqueror:(\d+(\.\d+)?)/,
-        "BlackBerry": /BlackBerry (\d+(\.\d+)?)/,
+        Konqueror: /Konqueror:(\d+(\.\d+)?)/,
+        BlackBerry: /BlackBerry (\d+(\.\d+)?)/,
         "Android Mobile": /android\s(\d+(\.\d+)?)/,
         "Internet Explorer": /(rv:|MSIE )(\d+(\.\d+)?)/,
-        "Mozilla": /rv:(\d+(\.\d+)?)/
+        Mozilla: /rv:(\d+(\.\d+)?)/
     };
     const regex = versionRegexs[browser];
     if (regex === undefined) {
@@ -85,7 +85,6 @@ export function browserVersion(userAgent: string, vendor?: string, opera?: objec
 export function osName(userAgent: string) {
     const a = userAgent;
     if (/Windows/i.test(a)) {
-        // eslint-disable-next-line @typescript-eslint/prefer-includes
         if (/Phone/.test(a) || /WPDesktop/.test(a)) {
             return "Windows Phone";
         }
@@ -93,17 +92,14 @@ export function osName(userAgent: string) {
         return "Windows";
     } else if (/(iPhone|iPad|iPod)/.test(a)) {
         return "iOS";
-    // eslint-disable-next-line @typescript-eslint/prefer-includes
     } else if (/Android/.test(a)) {
         return "Android";
     } else if (/(BlackBerry|PlayBook|BB10)/i.test(a)) {
         return "BlackBerry";
     } else if (/Mac/i.test(a)) {
         return "Mac OS X";
-    // eslint-disable-next-line @typescript-eslint/prefer-includes
     } else if (/Linux/.test(a)) {
         return "Linux";
-    // eslint-disable-next-line @typescript-eslint/prefer-includes
     } else if (/CrOS/.test(a)) {
         return "Chrome OS";
     }
@@ -112,21 +108,16 @@ export function osName(userAgent: string) {
 }
 
 export function deviceType(userAgent: string) {
-    // eslint-disable-next-line @typescript-eslint/prefer-includes
     if (/Windows Phone/i.test(userAgent) || /WPDesktop/.test(userAgent)) {
         return "Windows Phone";
-    // eslint-disable-next-line @typescript-eslint/prefer-includes
     } else if (/iPad/.test(userAgent)) {
         return "iPad";
-    // eslint-disable-next-line @typescript-eslint/prefer-includes
     } else if (/iPod/.test(userAgent)) {
         return "iPod Touch";
-    // eslint-disable-next-line @typescript-eslint/prefer-includes
     } else if (/iPhone/.test(userAgent)) {
         return "iPhone";
     } else if (/(BlackBerry|PlayBook|BB10)/i.test(userAgent)) {
         return "BlackBerry";
-    // eslint-disable-next-line @typescript-eslint/prefer-includes
     } else if (/Android/.test(userAgent)) {
         return "Android";
     }
@@ -142,3 +133,16 @@ export function referringDomain(referrer: string) {
 
     return "";
 }
+
+export function redactQueryParameters(url: string, queryParameterNames: string[]) {
+    let redactedUrl = url;
+
+    for (const x of queryParameterNames) {
+        // A name can include regular expression special characters, and can be percent-encoded in the URL, such as "user[email]" and "user%5Bemail%5D".
+        const escapedNames = [x, encodeURIComponent(x)].map(y => y.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"));
+
+        redactedUrl = redactedUrl.replace(new RegExp(`(?:${escapedNames.join("|")})=([^&]*)`, "gi"), () => `${x}=**redacted**`);
+    }
+
+    return redactedUrl;
+}

package/src/react/MixpanelContext.tsx

@@ -14,16 +14,9 @@ export interface MixpanelProviderProps extends PropsWithChildren {
  * @see {@link https://workleap.github.io/wl-telemetry}
  */
 export function MixpanelProvider(props: MixpanelProviderProps) {
-    const {
-        client,
-        children
-    } = props;
-
-    return (
-        <MixpanelContext.Provider value={client}>
-            {children}
-        </MixpanelContext.Provider>
-    );
+    const { client, children } = props;
+
+    return <MixpanelContext.Provider value={client}>{children}</MixpanelContext.Provider>;
 }
 
 export interface UseMixpanelClientOptions {
@@ -41,9 +34,7 @@ export function useMixpanelClient(options: { throwOnUndefined: false }): Mixpane
  * @see {@link https://workleap.github.io/wl-telemetry}
  */
 export function useMixpanelClient(options: UseMixpanelClientOptions = {}) {
-    const {
-        throwOnUndefined = true
-    } = options;
+    const { throwOnUndefined = true } = options;
 
     const client = useContext(MixpanelContext);
 

package/src/react/MixpanelPropertiesProvider.tsx

@@ -14,23 +14,19 @@ export interface MixpanelPropertiesProviderProps extends PropsWithChildren {
  * @see {@link https://workleap.github.io/wl-telemetry}
  */
 export function MixpanelPropertiesProvider(props: MixpanelPropertiesProviderProps) {
-    const {
-        value,
-        children
-    } = props;
+    const { value, children } = props;
 
     const parentContext = useContext(MixpanelPropertiesContext);
 
-    const contextValue = useMemo(() => ({
-        ...parentContext,
-        ...value
-    }), [parentContext, value]);
-
-    return (
-        <MixpanelPropertiesContext.Provider value={contextValue}>
-            {children}
-        </MixpanelPropertiesContext.Provider>
+    const contextValue = useMemo(
+        () => ({
+            ...parentContext,
+            ...value
+        }),
+        [parentContext, value]
     );
+
+    return <MixpanelPropertiesContext.Provider value={contextValue}>{children}</MixpanelPropertiesContext.Provider>;
 }
 
 /**

package/src/react/index.ts

@@ -2,4 +2,3 @@ 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

@@ -13,10 +13,7 @@ export type UseTrackingFunctionOptions = CreateMixpanelTrackingFunctionOptions;
  * @see {@link https://workleap.github.io/wl-telemetry}
  */
 export function useTrackingFunction(options: UseTrackingFunctionOptions = {}) {
-    const {
-        productId,
-        targetProductId
-    } = options;
+    const { productId, targetProductId } = options;
 
     const client = useMixpanelClient();
     const additionalProperties = useMixpanelProviderProperties();