@workleap/mixpanel 1.1.1 → 2.0.0

package/src/js/HasExecutedGuard.ts

@@ -0,0 +1,19 @@
+export class HasExecutedGuard {
+    #hasExecuted: boolean = false;
+
+    throw(message: string) {
+        if (this.#hasExecuted) {
+            throw new Error(message);
+        }
+
+        this.#hasExecuted = true;
+    }
+
+    get hasExecuted() {
+        return this.#hasExecuted;
+    }
+
+    reset() {
+        this.#hasExecuted = false;
+    }
+}

package/src/{env.ts → js/env.ts}

@@ -1,5 +1,6 @@
 
 const EnvironmentList = ["development", "staging", "production", "local", "msw"] as const;
+
 export type Environment = typeof EnvironmentList[number];
 
 const NavigationApiBaseUrl: Record<Environment, string> = {
@@ -17,6 +18,7 @@ function resolveApiUrl(path: string, baseUrl: string | undefined) : string {
 
 export function getTrackingEndpoint(envOrTrackingApiBaseUrl: Environment | (string & {})) {
     let baseUrl: string;
+
     if (EnvironmentList.includes(envOrTrackingApiBaseUrl as Environment)) {
         baseUrl = NavigationApiBaseUrl[envOrTrackingApiBaseUrl as Environment];
     } else {

package/src/js/getMixpanelTrackingFunction.ts

@@ -0,0 +1,31 @@
+import type { MixpanelTrackingFunction } from "./initializeMixpanel.ts";
+
+export const TrackingFunctionName = "__WLP_MIXPANEL_TRACKING_FUNCTION__";
+
+/**
+ * @see https://workleap.github.io/wl-telemetry
+ */
+export interface GetMixpanelTrackingFunctionOptions {
+    throwOnUndefined?: boolean;
+}
+
+/**
+ * Retrieve the track function.
+ * @returns A function that sends tracking events to the tracking API.
+ * @see https://workleap.github.io/wl-telemetry
+ */
+export function getMixpanelTrackingFunction(options: GetMixpanelTrackingFunctionOptions = {}) {
+    const {
+        throwOnUndefined = true
+    } = options;
+
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    const trackFunction = globalThis[TrackingFunctionName];
+
+    if (!trackFunction && throwOnUndefined) {
+        throw new Error("[mixpanel] The tracking function is undefined. Did you call the \"initializeMixpanel\" function?");
+    }
+
+    return trackFunction as MixpanelTrackingFunction;
+}

package/src/js/index.ts

@@ -0,0 +1,5 @@
+export type { Environment } from "./env.ts";
+export { getMixpanelTrackingFunction } from "./getMixpanelTrackingFunction.ts";
+export { initializeMixpanel, type InitializeMixpanelOptions, type MixpanelTrackingFunction, type MixpanelTrackingOptions } from "./initializeMixpanel.ts";
+export type { MixpanelTrackEventProperties } from "./properties.ts";
+

package/src/js/initializeMixpanel.ts

@@ -0,0 +1,147 @@
+import { getBootstrappingStore, getTelemetryContext } from "@workleap/telemetry";
+import { getTrackingEndpoint, type Environment } from "./env.ts";
+import { TrackingFunctionName } from "./getMixpanelTrackingFunction.ts";
+import { HasExecutedGuard } from "./HasExecutedGuard.ts";
+import { getBaseProperties, TelemetryProperties, type MixpanelTrackEventProperties } from "./properties.ts";
+
+/**
+ * @see https://workleap.github.io/wl-telemetry
+ */
+export interface MixpanelTrackingOptions {
+    /**
+     * The product identifier of the target product.
+     */
+    targetProductId?: string;
+    /**
+   * Whether to keep the connection alive for the tracking request.
+   * It is mostly used for tracking links where the user might navigate away before the request is completed.
+   *
+   * Caution! The body size for keepalive requests is limited to 64 kibibytes.
+   *
+   * https://developer.mozilla.org/en-US/docs/Web/API/RequestInit#keepalive
+   *
+   * @default false
+   */
+    keepAlive?: boolean;
+}
+
+/**
+ * A function that sends tracking events to the tracking API.
+ * @param eventName The name of the event to track.
+ * @param properties The properties to send with the event.
+ * @param options Options for tracking the event.
+ * @see https://workleap.github.io/wl-telemetry
+ */
+export type MixpanelTrackingFunction = (eventName: string, properties: MixpanelTrackEventProperties, options?: MixpanelTrackingOptions) => Promise<void>;
+
+/**
+ * @see https://workleap.github.io/wl-telemetry
+ */
+export interface InitializeMixpanelOptions {
+    verbose?: boolean;
+}
+
+function registerLogRocketSessionUrlListener(superProperties: Map<string, string>, verbose = false) {
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    if (globalThis.__WLP_LOGROCKET_INSTRUMENTATION_REGISTER_GET_SESSION_URL_LISTENER__) {
+        // Automatically add the LogRocket session URL to all Honeycomb traces as an attribute.
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        globalThis.__WLP_LOGROCKET_INSTRUMENTATION_REGISTER_GET_SESSION_URL_LISTENER__((sessionUrl: string) => {
+            if (verbose) {
+                console.log("[mixpanel] Received LogRocket session replay URL:", sessionUrl);
+            }
+
+            superProperties.set(TelemetryProperties.LogRocketSessionUrl, sessionUrl);
+        });
+    } else if (verbose) {
+        console.log("[mixpanel] Cannot integrate with LogRocket because \"globalThis.__WLP_LOGROCKET_INSTRUMENTATION_REGISTER_GET_SESSION_URL_LISTENER__\" is not available.");
+    }
+}
+
+const initializationGuard = new HasExecutedGuard();
+
+// This function should only be used by tests.
+export function __resetInitializationGuard() {
+    initializationGuard.reset();
+}
+
+/**
+ * Creates a function that sends tracking events to the tracking API.
+ * @param productId Your product identifier.
+ * @param envOrTrackingApiBaseUrl The environment to get the navigation url from or a base URL.
+ * @param options Options for creating the tracking function.
+ * @returns A function that sends tracking events to the tracking API.
+ * @see https://workleap.github.io/wl-telemetry
+ */
+export function initializeMixpanel(productId: string, envOrTrackingApiBaseUrl: Environment | (string & {}), options: InitializeMixpanelOptions = {}) : MixpanelTrackingFunction {
+    const {
+        verbose
+    } = options;
+
+    initializationGuard.throw("[mixpanel] Mixpanel has already been initialized. Did you call the \"initializeMixpanel\" function twice?");
+
+    // Equivalent to: https://docs.mixpanel.com/docs/tracking-methods/sdks/javascript#setting-super-properties.
+    const superProperties = new Map<string, string>();
+
+    const fullUrl = getTrackingEndpoint(envOrTrackingApiBaseUrl);
+    const telemetryContext = getTelemetryContext({ verbose });
+
+    superProperties.set(TelemetryProperties.TelemetryId, telemetryContext.telemetryId);
+    superProperties.set(TelemetryProperties.DeviceId, telemetryContext.deviceId);
+
+    const bootstrappingStore = getBootstrappingStore();
+
+    // If LogRocket is already available, register the listener. Otherwise, subscribe to the bootstrapping store
+    // and register the listener once a notification is received that LogRocket is registered.
+    if (bootstrappingStore.state.isLogRocketReady) {
+        registerLogRocketSessionUrlListener(superProperties, verbose);
+    } else {
+        bootstrappingStore.subscribe((action, store, unsubscribe) => {
+            if (store.state.isLogRocketReady) {
+                unsubscribe();
+                registerLogRocketSessionUrlListener(superProperties, verbose);
+            }
+        });
+    }
+
+    const trackFunction: MixpanelTrackingFunction = async (eventName, properties, _options = {}) => {
+        try {
+            const {
+                targetProductId = null,
+                keepAlive = false
+            } = _options;
+
+            const baseProperties = getBaseProperties();
+
+            const allProperties = {
+                ...baseProperties,
+                ...Object.fromEntries(superProperties),
+                ...properties
+            };
+
+            await fetch(fullUrl, {
+                method: "POST",
+                credentials: "include",
+                keepalive: keepAlive,
+                headers: { "Content-Type": "application/json" },
+                body: JSON.stringify({
+                    eventName,
+                    productIdentifier: productId,
+                    targetProductIdentifier : targetProductId,
+                    properties: allProperties
+                })
+            });
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        } catch (error: unknown) {
+            // Do nothing...
+        }
+    };
+
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    globalThis[TrackingFunctionName] = trackFunction;
+
+    return trackFunction;
+}

package/src/js/properties.ts

@@ -0,0 +1,41 @@
+
+import { browserName, browserVersion, deviceType, osName, referringDomain } from "./utils.ts";
+
+export type MixpanelTrackEventProperties = Record<string, unknown>;
+
+export const BaseProperties = {
+    Browser: "$browser",
+    BrowserVersion: "$browser_version",
+    CurrentUrl: "$current_url",
+    Device: "$device",
+    IsMobile: "Is Mobile",
+    Os: "$os",
+    Referrer: "$referrer",
+    ReferringDomain: "$referring_domain",
+    ScreenHeight: "$screen_height",
+    ScreenWidth: "$screen_width"
+} as const;
+
+export const TelemetryProperties = {
+    DeviceId: "Device Id",
+    LogRocketSessionUrl: "LogRocket Session Url",
+    TelemetryId: "Telemetry Id"
+} as const;
+
+export function getBaseProperties() {
+    const userAgent = navigator.userAgent;
+    const device = deviceType(userAgent);
+
+    return {
+        [BaseProperties.Os]: osName(userAgent),
+        [BaseProperties.Browser]: browserName(userAgent, navigator.vendor),
+        [BaseProperties.Referrer]: document.referrer,
+        [BaseProperties.ReferringDomain]: referringDomain(document.referrer),
+        [BaseProperties.Device]: device,
+        [BaseProperties.CurrentUrl]: window.location.href,
+        [BaseProperties.BrowserVersion]: browserVersion(userAgent, navigator.vendor),
+        [BaseProperties.ScreenHeight]: window.screen.height,
+        [BaseProperties.ScreenWidth]: window.screen.width,
+        [BaseProperties.IsMobile]: device.length > 0
+    } satisfies MixpanelTrackEventProperties;
+}

package/src/react/index.ts

@@ -0,0 +1,2 @@
+export { useMixpanelTracking } from "./useMixpanelTracking.ts";
+

package/src/react/useMixpanelTracking.ts

@@ -0,0 +1,15 @@
+import { getMixpanelTrackingFunction, type GetMixpanelTrackingFunctionOptions } from "../js/getMixpanelTrackingFunction.ts";
+
+/**
+ * @see https://workleap.github.io/wl-telemetry
+ */
+export type UseMixpanelTrackingOptions = GetMixpanelTrackingFunctionOptions;
+
+/**
+ * Retrieve the track function.
+ * @returns A function that sends tracking events to the tracking API.
+ * @see https://workleap.github.io/wl-telemetry
+ */
+export function useMixpanelTracking(options?: UseMixpanelTrackingOptions) {
+    return getMixpanelTrackingFunction(options);
+}

package/dist/createTrackingFunction.d.ts

@@ -1,45 +0,0 @@
-import { type Environment } from "./env.ts";
-import { type TrackEventProperties } from "./properties.ts";
-export interface TrackingOptions {
-    /**
-   * Whether to keep the connection alive for the tracking request.
-   * It is mostly used for tracking links where the user might navigate away before the request is completed.
-   *
-   * Caution! The body size for keepalive requests is limited to 64 kibibytes.
-   *
-   * https://developer.mozilla.org/en-US/docs/Web/API/RequestInit#keepalive
-   *
-   * @default false
-   */
-    keepAlive?: boolean;
-}
-/**
- * A function that sends tracking events to the tracking API.
- * @param eventName The name of the event to track.
- * @param properties The properties to send with the event.
- * @param options Options for tracking the event.
- */
-export type TrackingFunction = (eventName: string, properties: TrackEventProperties, options?: TrackingOptions) => Promise<void>;
-export interface CreateTrackingFunctionOptions {
-    /**
-     * The product identifier of the target product.
-     * @default null
-     */
-    targetProductId?: string | null;
-}
-/**
- * Creates a function that sends tracking events to the tracking API.
- * @param productId Your product identifier. e.g. "wlp", "ov"
- * @param env The environment to get the navigation url from . e.g. "local", "prod"
- * @param createOptions Options for creating the tracking function.
- * @returns A function that sends tracking events to the tracking API.
- */
-export declare function createTrackingFunction(productId: string, env: Environment, createOptions?: CreateTrackingFunctionOptions): TrackingFunction;
-/**
- * Creates a function that sends tracking events to the tracking API.
- * @param productId Your product identifier. e.g. "wlp", "ov"
- * @param trackingApiBaseUrl The base Url to get the tracking api from . e.g. "https://api.platform.workleap-dev.com/shell/navigation/"
- * @param createOptions Options for creating the tracking function.
- * @returns A function that sends tracking events to the tracking API.
- */
-export declare function createTrackingFunction(productId: string, trackingApiBaseUrl: string, createOptions?: CreateTrackingFunctionOptions): TrackingFunction;

package/dist/createTrackingFunction.js

@@ -1,39 +0,0 @@
-import * as __WEBPACK_EXTERNAL_MODULE__env_js_a43599a2__ from "./env.js";
-import * as __WEBPACK_EXTERNAL_MODULE__properties_js_2cf909bd__ from "./properties.js";
-
-;// CONCATENATED MODULE: external "./env.js"
-
-;// CONCATENATED MODULE: external "./properties.js"
-
-;// CONCATENATED MODULE: ./src/createTrackingFunction.ts?__rslib_entry__
-
-
-function createTrackingFunction(productId, envOrTrackingApiBaseUrl, createOptions = {}) {
-    const targetProductId = createOptions?.targetProductId ?? null;
-    const fullUrl = (0,__WEBPACK_EXTERNAL_MODULE__env_js_a43599a2__.getTrackingEndpoint)(envOrTrackingApiBaseUrl);
-    return async (eventName, properties, options)=>{
-        const baseProperties = (0,__WEBPACK_EXTERNAL_MODULE__properties_js_2cf909bd__.getBaseProperties)();
-        const allProperties = {
-            ...baseProperties,
-            ...properties
-        };
-        await fetch(fullUrl, {
-            method: "POST",
-            credentials: "include",
-            keepalive: options?.keepAlive,
-            headers: {
-                "Content-Type": "application/json"
-            },
-            body: JSON.stringify({
-                eventName,
-                productIdentifier: productId,
-                targetProductIdentifier: targetProductId,
-                properties: allProperties
-            })
-        });
-    };
-}
-
-export { createTrackingFunction };
-
-//# sourceMappingURL=createTrackingFunction.js.map

package/dist/createTrackingFunction.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"createTrackingFunction.js","sources":["webpack://@workleap/mixpanel/./src/createTrackingFunction.ts"],"sourcesContent":["import { getTrackingEndpoint, type Environment } from \"./env.ts\";\nimport { getBaseProperties, type TrackEventProperties } from \"./properties.ts\";\n\nexport interface TrackingOptions {\n    /**\n   * Whether to keep the connection alive for the tracking request.\n   * It is mostly used for tracking links where the user might navigate away before the request is completed.\n   *\n   * Caution! The body size for keepalive requests is limited to 64 kibibytes.\n   *\n   * https://developer.mozilla.org/en-US/docs/Web/API/RequestInit#keepalive\n   *\n   * @default false\n   */\n    keepAlive?: boolean;\n}\n\n/**\n * A function that sends tracking events to the tracking API.\n * @param eventName The name of the event to track.\n * @param properties The properties to send with the event.\n * @param options Options for tracking the event.\n */\nexport type TrackingFunction = (eventName: string, properties: TrackEventProperties, options?: TrackingOptions) => Promise<void>;\n\nexport interface CreateTrackingFunctionOptions {\n    /**\n     * The product identifier of the target product.\n     * @default null\n     */\n    targetProductId?: string | null;\n}\n\n/**\n * Creates a function that sends tracking events to the tracking API.\n * @param productId Your product identifier. e.g. \"wlp\", \"ov\"\n * @param env The environment to get the navigation url from . e.g. \"local\", \"prod\"\n * @param createOptions Options for creating the tracking function.\n * @returns A function that sends tracking events to the tracking API.\n */\nexport function createTrackingFunction(productId: string, env: Environment, createOptions?: CreateTrackingFunctionOptions) : TrackingFunction;\n/**\n * Creates a function that sends tracking events to the tracking API.\n * @param productId Your product identifier. e.g. \"wlp\", \"ov\"\n * @param trackingApiBaseUrl The base Url to get the tracking api from . e.g. \"https://api.platform.workleap-dev.com/shell/navigation/\"\n * @param createOptions Options for creating the tracking function.\n * @returns A function that sends tracking events to the tracking API.\n */\nexport function createTrackingFunction(productId: string, trackingApiBaseUrl: string, createOptions?: CreateTrackingFunctionOptions) : TrackingFunction;\nexport function createTrackingFunction(productId: string, envOrTrackingApiBaseUrl: Environment | (string & {}), createOptions: CreateTrackingFunctionOptions = {}) : TrackingFunction {\n    const targetProductId = createOptions?.targetProductId ?? null;\n    const fullUrl = getTrackingEndpoint(envOrTrackingApiBaseUrl);\n\n    return async (eventName, properties, options) => {\n        const baseProperties = getBaseProperties();\n        const allProperties = { ...baseProperties, ...properties };\n\n        await fetch(fullUrl, {\n            method: \"POST\",\n            credentials: \"include\",\n            keepalive: options?.keepAlive,\n            headers: { \"Content-Type\": \"application/json\" },\n            body: JSON.stringify({\n                eventName,\n                productIdentifier: productId,\n                targetProductIdentifier : targetProductId,\n                properties: allProperties\n            })\n        });\n    };\n}\n"],"names":["getTrackingEndpoint","getBaseProperties","createTrackingFunction","productId","envOrTrackingApiBaseUrl","createOptions","targetProductId","fullUrl","eventName","properties","options","baseProperties","allProperties","fetch","JSON"],"mappings":";;;;;;;;AAAiE;AACc;AAgDxE,SAASE,uBAAuBC,SAAiB,EAAEC,uBAAoD,EAAEC,gBAA+C,CAAC,CAAC;IAC7J,MAAMC,kBAAkBD,eAAe,mBAAmB;IAC1D,MAAME,UAAUP,oEAAmBA,CAACI;IAEpC,OAAO,OAAOI,WAAWC,YAAYC;QACjC,MAAMC,iBAAiBV,yEAAiBA;QACxC,MAAMW,gBAAgB;YAAE,GAAGD,cAAc;YAAE,GAAGF,UAAU;QAAC;QAEzD,MAAMI,MAAMN,SAAS;YACjB,QAAQ;YACR,aAAa;YACb,WAAWG,SAAS;YACpB,SAAS;gBAAE,gBAAgB;YAAmB;YAC9C,MAAMI,KAAK,SAAS,CAAC;gBACjBN;gBACA,mBAAmBL;gBACnB,yBAA0BG;gBAC1B,YAAYM;YAChB;QACJ;IACJ;AACJ"}

package/dist/env.js.map

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

package/dist/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./createTrackingFunction.ts";
-export type { Environment } from "./env.ts";
-export type { TrackEventProperties } from "./properties.ts";

package/dist/index.js

@@ -1,7 +0,0 @@
-export * from "./createTrackingFunction.js";
-
-;// CONCATENATED MODULE: ./src/index.ts?__rslib_entry__
-
-
-
-//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sources":["webpack://@workleap/mixpanel/./src/index.ts"],"sourcesContent":["export * from \"./createTrackingFunction.ts\";\nexport type { Environment } from \"./env.ts\";\nexport type { TrackEventProperties } from \"./properties.ts\";\n\n"],"names":[],"mappings":";;;AAA4C"}

package/dist/properties.d.ts

@@ -1,13 +0,0 @@
-export type TrackEventProperties = Record<string, unknown>;
-export declare function getBaseProperties(): {
-    $os: string;
-    $browser: string;
-    $referrer: string;
-    $referring_domain: string;
-    $device: string;
-    $current_url: string;
-    $browser_version: number | null;
-    $screen_height: number;
-    $screen_width: number;
-    IsMobile: boolean;
-};

package/dist/properties.js

@@ -1,39 +0,0 @@
-import * as __WEBPACK_EXTERNAL_MODULE__utils_js_d88b7fe1__ from "./utils.js";
-
-;// CONCATENATED MODULE: external "./utils.js"
-
-;// CONCATENATED MODULE: ./src/properties.ts?__rslib_entry__
-
-const BaseTrackingProperties = {
-    AppVersion: "AppVersion",
-    Browser: "$browser",
-    BrowserVersion: "$browser_version",
-    CurrentUrl: "$current_url",
-    Device: "$device",
-    IsMobile: "IsMobile",
-    Os: "$os",
-    Referrer: "$referrer",
-    ReferringDomain: "$referring_domain",
-    ScreenHeight: "$screen_height",
-    ScreenWidth: "$screen_width"
-};
-function getBaseProperties() {
-    const userAgent = navigator.userAgent;
-    const device = (0,__WEBPACK_EXTERNAL_MODULE__utils_js_d88b7fe1__.deviceType)(userAgent);
-    return {
-        [BaseTrackingProperties.Os]: (0,__WEBPACK_EXTERNAL_MODULE__utils_js_d88b7fe1__.osName)(userAgent),
-        [BaseTrackingProperties.Browser]: (0,__WEBPACK_EXTERNAL_MODULE__utils_js_d88b7fe1__.browserName)(userAgent, navigator.vendor),
-        [BaseTrackingProperties.Referrer]: document.referrer,
-        [BaseTrackingProperties.ReferringDomain]: (0,__WEBPACK_EXTERNAL_MODULE__utils_js_d88b7fe1__.referringDomain)(document.referrer),
-        [BaseTrackingProperties.Device]: device,
-        [BaseTrackingProperties.CurrentUrl]: window.location.href,
-        [BaseTrackingProperties.BrowserVersion]: (0,__WEBPACK_EXTERNAL_MODULE__utils_js_d88b7fe1__.browserVersion)(userAgent, navigator.vendor),
-        [BaseTrackingProperties.ScreenHeight]: window.screen.height,
-        [BaseTrackingProperties.ScreenWidth]: window.screen.width,
-        [BaseTrackingProperties.IsMobile]: device.length > 0
-    };
-}
-
-export { getBaseProperties };
-
-//# sourceMappingURL=properties.js.map

package/dist/properties.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"properties.js","sources":["webpack://@workleap/mixpanel/./src/properties.ts"],"sourcesContent":["\nimport { browserName, browserVersion, deviceType, osName, referringDomain } from \"./utils.ts\";\n\nexport type TrackEventProperties = Record<string, unknown>;\n\nconst BaseTrackingProperties = {\n    AppVersion: \"AppVersion\",\n    Browser: \"$browser\",\n    BrowserVersion: \"$browser_version\",\n    CurrentUrl: \"$current_url\",\n    Device: \"$device\",\n    IsMobile: \"IsMobile\",\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        [BaseTrackingProperties.Os]: osName(userAgent),\n        [BaseTrackingProperties.Browser]: browserName(userAgent, navigator.vendor),\n        [BaseTrackingProperties.Referrer]: document.referrer,\n        [BaseTrackingProperties.ReferringDomain]: referringDomain(document.referrer),\n        [BaseTrackingProperties.Device]: device,\n        [BaseTrackingProperties.CurrentUrl]: window.location.href,\n        [BaseTrackingProperties.BrowserVersion]: browserVersion(userAgent, navigator.vendor),\n        [BaseTrackingProperties.ScreenHeight]: window.screen.height,\n        [BaseTrackingProperties.ScreenWidth]: window.screen.width,\n        [BaseTrackingProperties.IsMobile]: device.length > 0\n    } satisfies TrackEventProperties;\n}\n"],"names":["browserName","browserVersion","deviceType","osName","referringDomain","BaseTrackingProperties","getBaseProperties","userAgent","navigator","device","document","window"],"mappings":";;;;;AAC8F;AAI9F,MAAMK,yBAAyB;IAC3B,YAAY;IACZ,SAAS;IACT,gBAAgB;IAChB,YAAY;IACZ,QAAQ;IACR,UAAU;IACV,IAAI;IACJ,UAAU;IACV,iBAAiB;IACjB,cAAc;IACd,aAAa;AACjB;AAEO,SAASC;IACZ,MAAMC,YAAYC,UAAU,SAAS;IACrC,MAAMC,SAASP,6DAAUA,CAACK;IAE1B,OAAO;QACH,CAACF,uBAAuB,EAAE,CAAC,EAAEF,yDAAMA,CAACI;QACpC,CAACF,uBAAuB,OAAO,CAAC,EAAEL,8DAAWA,CAACO,WAAWC,UAAU,MAAM;QACzE,CAACH,uBAAuB,QAAQ,CAAC,EAAEK,SAAS,QAAQ;QACpD,CAACL,uBAAuB,eAAe,CAAC,EAAED,kEAAeA,CAACM,SAAS,QAAQ;QAC3E,CAACL,uBAAuB,MAAM,CAAC,EAAEI;QACjC,CAACJ,uBAAuB,UAAU,CAAC,EAAEM,OAAO,QAAQ,CAAC,IAAI;QACzD,CAACN,uBAAuB,cAAc,CAAC,EAAEJ,iEAAcA,CAACM,WAAWC,UAAU,MAAM;QACnF,CAACH,uBAAuB,YAAY,CAAC,EAAEM,OAAO,MAAM,CAAC,MAAM;QAC3D,CAACN,uBAAuB,WAAW,CAAC,EAAEM,OAAO,MAAM,CAAC,KAAK;QACzD,CAACN,uBAAuB,QAAQ,CAAC,EAAEI,OAAO,MAAM,GAAG;IACvD;AACJ"}

package/dist/utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.js","sources":["webpack://@workleap/mixpanel/./src/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        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"],"names":["browserName","userAgent","vendor","opera","browserVersion","browser","versionRegexs","regex","undefined","matches","parseFloat","osName","a","deviceType","referringDomain","referrer","split"],"mappings":";;AAAA,6FAA6F;AACtF,SAASA,YAAYC,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,eAAeH,SAAiB,EAAEC,MAAe,EAAEC,KAAc;IAC7E,MAAME,UAAUL,YAAYC,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,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"}

package/src/createTrackingFunction.ts

@@ -1,71 +0,0 @@
-import { getTrackingEndpoint, type Environment } from "./env.ts";
-import { getBaseProperties, type TrackEventProperties } from "./properties.ts";
-
-export interface TrackingOptions {
-    /**
-   * Whether to keep the connection alive for the tracking request.
-   * It is mostly used for tracking links where the user might navigate away before the request is completed.
-   *
-   * Caution! The body size for keepalive requests is limited to 64 kibibytes.
-   *
-   * https://developer.mozilla.org/en-US/docs/Web/API/RequestInit#keepalive
-   *
-   * @default false
-   */
-    keepAlive?: boolean;
-}
-
-/**
- * A function that sends tracking events to the tracking API.
- * @param eventName The name of the event to track.
- * @param properties The properties to send with the event.
- * @param options Options for tracking the event.
- */
-export type TrackingFunction = (eventName: string, properties: TrackEventProperties, options?: TrackingOptions) => Promise<void>;
-
-export interface CreateTrackingFunctionOptions {
-    /**
-     * The product identifier of the target product.
-     * @default null
-     */
-    targetProductId?: string | null;
-}
-
-/**
- * Creates a function that sends tracking events to the tracking API.
- * @param productId Your product identifier. e.g. "wlp", "ov"
- * @param env The environment to get the navigation url from . e.g. "local", "prod"
- * @param createOptions Options for creating the tracking function.
- * @returns A function that sends tracking events to the tracking API.
- */
-export function createTrackingFunction(productId: string, env: Environment, createOptions?: CreateTrackingFunctionOptions) : TrackingFunction;
-/**
- * Creates a function that sends tracking events to the tracking API.
- * @param productId Your product identifier. e.g. "wlp", "ov"
- * @param trackingApiBaseUrl The base Url to get the tracking api from . e.g. "https://api.platform.workleap-dev.com/shell/navigation/"
- * @param createOptions Options for creating the tracking function.
- * @returns A function that sends tracking events to the tracking API.
- */
-export function createTrackingFunction(productId: string, trackingApiBaseUrl: string, createOptions?: CreateTrackingFunctionOptions) : TrackingFunction;
-export function createTrackingFunction(productId: string, envOrTrackingApiBaseUrl: Environment | (string & {}), createOptions: CreateTrackingFunctionOptions = {}) : TrackingFunction {
-    const targetProductId = createOptions?.targetProductId ?? null;
-    const fullUrl = getTrackingEndpoint(envOrTrackingApiBaseUrl);
-
-    return async (eventName, properties, options) => {
-        const baseProperties = getBaseProperties();
-        const allProperties = { ...baseProperties, ...properties };
-
-        await fetch(fullUrl, {
-            method: "POST",
-            credentials: "include",
-            keepalive: options?.keepAlive,
-            headers: { "Content-Type": "application/json" },
-            body: JSON.stringify({
-                eventName,
-                productIdentifier: productId,
-                targetProductIdentifier : targetProductId,
-                properties: allProperties
-            })
-        });
-    };
-}

package/src/index.ts

@@ -1,4 +0,0 @@
-export * from "./createTrackingFunction.ts";
-export type { Environment } from "./env.ts";
-export type { TrackEventProperties } from "./properties.ts";
-

package/src/properties.ts

@@ -1,36 +0,0 @@
-
-import { browserName, browserVersion, deviceType, osName, referringDomain } from "./utils.ts";
-
-export type TrackEventProperties = Record<string, unknown>;
-
-const BaseTrackingProperties = {
-    AppVersion: "AppVersion",
-    Browser: "$browser",
-    BrowserVersion: "$browser_version",
-    CurrentUrl: "$current_url",
-    Device: "$device",
-    IsMobile: "IsMobile",
-    Os: "$os",
-    Referrer: "$referrer",
-    ReferringDomain: "$referring_domain",
-    ScreenHeight: "$screen_height",
-    ScreenWidth: "$screen_width"
-} as const;
-
-export function getBaseProperties() {
-    const userAgent = navigator.userAgent;
-    const device = deviceType(userAgent);
-
-    return {
-        [BaseTrackingProperties.Os]: osName(userAgent),
-        [BaseTrackingProperties.Browser]: browserName(userAgent, navigator.vendor),
-        [BaseTrackingProperties.Referrer]: document.referrer,
-        [BaseTrackingProperties.ReferringDomain]: referringDomain(document.referrer),
-        [BaseTrackingProperties.Device]: device,
-        [BaseTrackingProperties.CurrentUrl]: window.location.href,
-        [BaseTrackingProperties.BrowserVersion]: browserVersion(userAgent, navigator.vendor),
-        [BaseTrackingProperties.ScreenHeight]: window.screen.height,
-        [BaseTrackingProperties.ScreenWidth]: window.screen.width,
-        [BaseTrackingProperties.IsMobile]: device.length > 0
-    } satisfies TrackEventProperties;
-}