@workleap/mixpanel 1.0.0

package/dist/createTrackingFunction.d.ts

@@ -0,0 +1,37 @@
+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>;
+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 trackingApiUrl The base URL of the tracking controlled. e.g. "/api/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;
+export {};

package/dist/createTrackingFunction.js

@@ -0,0 +1,44 @@
+import * as __WEBPACK_EXTERNAL_MODULE__properties_js_2cf909bd__ from "./properties.js";
+
+;// CONCATENATED MODULE: external "./properties.js"
+
+;// CONCATENATED MODULE: ./src/createTrackingFunction.ts?__rslib_entry__
+
+// Cannot use URL() because it doesn't support relative base url: https://github.com/whatwg/url/issues/531.
+function resolveApiUrl(path, baseUrl) {
+    return `${baseUrl}${baseUrl.endsWith("/") ? "" : "/"}${path.startsWith("/") ? path.substring(1) : path}`;
+}
+/**
+ * Creates a function that sends tracking events to the tracking API.
+ * @param productId Your product identifier. e.g. "wlp", "ov"
+ * @param trackingApiUrl The base URL of the tracking controlled. e.g. "/api/navigation"
+ * @param createOptions Options for creating the tracking function.
+ * @returns A function that sends tracking events to the tracking API.
+ */ function createTrackingFunction(productId, trackingApiBaseUrl, createOptions = {}) {
+    const targetProductId = createOptions?.targetProductId ?? null;
+    return async (eventName, properties, options)=>{
+        const baseProperties = (0,__WEBPACK_EXTERNAL_MODULE__properties_js_2cf909bd__.getBaseProperties)();
+        const allProperties = {
+            ...baseProperties,
+            ...properties
+        };
+        await fetch(resolveApiUrl("tracking/track", trackingApiBaseUrl), {
+            method: "POST",
+            credentials: "include",
+            keepalive: options?.keepAlive,
+            headers: {
+                "Content-Type": "application/json"
+            },
+            body: JSON.stringify({
+                eventName,
+                productId,
+                targetProductId: targetProductId,
+                properties: allProperties
+            })
+        });
+    };
+}
+
+export { createTrackingFunction };
+
+//# sourceMappingURL=createTrackingFunction.js.map

package/dist/createTrackingFunction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createTrackingFunction.js","sources":["webpack://@workleap/mixpanel/./src/createTrackingFunction.ts"],"sourcesContent":["import { 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\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\ninterface 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 trackingApiUrl The base URL of the tracking controlled. e.g. \"/api/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 {\n    const targetProductId = createOptions?.targetProductId ?? null;\n\n    return async (eventName, properties, options) => {\n        const baseProperties = getBaseProperties();\n        const allProperties = { ...baseProperties, ...properties };\n\n        await fetch(resolveApiUrl(\"tracking/track\", trackingApiBaseUrl), {\n            method: \"POST\",\n            credentials: \"include\",\n            keepalive: options?.keepAlive,\n            headers: { \"Content-Type\": \"application/json\" },\n            body: JSON.stringify({\n                eventName,\n                productId,\n                targetProductId: targetProductId,\n                properties: allProperties\n            })\n        });\n    };\n}\n"],"names":["getBaseProperties","resolveApiUrl","path","baseUrl","createTrackingFunction","productId","trackingApiBaseUrl","createOptions","targetProductId","eventName","properties","options","baseProperties","allProperties","fetch","JSON"],"mappings":";;;;;AAA+E;AAwB/E,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;AAUA;;;;;;CAMC,GACM,SAASE,uBAAuBC,SAAiB,EAAEC,kBAA0B,EAAEC,gBAA+C,CAAC,CAAC;IACnI,MAAMC,kBAAkBD,eAAe,mBAAmB;IAE1D,OAAO,OAAOE,WAAWC,YAAYC;QACjC,MAAMC,iBAAiBZ,yEAAiBA;QACxC,MAAMa,gBAAgB;YAAE,GAAGD,cAAc;YAAE,GAAGF,UAAU;QAAC;QAEzD,MAAMI,MAAMb,cAAc,kBAAkBK,qBAAqB;YAC7D,QAAQ;YACR,aAAa;YACb,WAAWK,SAAS;YACpB,SAAS;gBAAE,gBAAgB;YAAmB;YAC9C,MAAMI,KAAK,SAAS,CAAC;gBACjBN;gBACAJ;gBACA,iBAAiBG;gBACjB,YAAYK;YAChB;QACJ;IACJ;AACJ"}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from "./createTrackingFunction.ts";

package/dist/index.js

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

package/dist/index.js.map

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

package/dist/properties.d.ts

@@ -0,0 +1,13 @@
+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

@@ -0,0 +1,39 @@
+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

@@ -0,0 +1 @@
+{"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.d.ts

@@ -0,0 +1,10 @@
+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";
+/**
+ * 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 referringDomain(referrer: string): string;

package/dist/utils.js

@@ -0,0 +1,127 @@
+
+;// CONCATENATED MODULE: ./src/utils.ts?__rslib_entry__
+// 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
+    if (opera || userAgent.includes(" OPR/")) {
+        if (userAgent.includes("Mini")) {
+            return "Opera Mini";
+        }
+        return "Opera";
+    } else if (/(BlackBerry|PlayBook|BB10)/i.test(userAgent)) {
+        return "BlackBerry";
+    } else if (userAgent.includes("IEMobile") || userAgent.includes("WPDesktop")) {
+        return "Internet Explorer Mobile";
+    } else if (userAgent.includes("Edge")) {
+        return "Microsoft Edge";
+    } else if (userAgent.includes("FBIOS")) {
+        return "Facebook Mobile";
+    } else if (userAgent.includes("Chrome")) {
+        return "Chrome";
+    } else if (userAgent.includes("CriOS")) {
+        return "Chrome iOS";
+    } else if (userAgent.includes("UCWEB") || userAgent.includes("UCBrowser")) {
+        return "UC Browser";
+    } else if (userAgent.includes("FxiOS")) {
+        return "Firefox iOS";
+    } else if (vendor.includes("Apple")) {
+        if (userAgent.includes("Mobile")) {
+            return "Mobile Safari";
+        }
+        return "Safari";
+    } else if (userAgent.includes("Android")) {
+        return "Android Mobile";
+    } else if (userAgent.includes("Konqueror")) {
+        return "Konqueror";
+    } else if (userAgent.includes("Firefox")) {
+        return "Firefox";
+    } else if (userAgent.includes("MSIE") || userAgent.includes("Trident/")) {
+        return "Internet Explorer";
+    } else if (userAgent.includes("Gecko")) {
+        return "Mozilla";
+    }
+    return "";
+}
+/**
+ * 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
+ */ function browserVersion(userAgent, vendor, opera) {
+    const browser = browserName(userAgent, vendor, opera);
+    const versionRegexs = {
+        "Internet Explorer Mobile": /rv:(\d+(\.\d+)?)/,
+        "Microsoft Edge": /Edge\/(\d+(\.\d+)?)/,
+        "Chrome": /Chrome\/(\d+(\.\d+)?)/,
+        "Chrome iOS": /CriOS\/(\d+(\.\d+)?)/,
+        "UC Browser": /(UCBrowser|UCWEB)\/(\d+(\.\d+)?)/,
+        "Safari": /Version\/(\d+(\.\d+)?)/,
+        "Mobile Safari": /Version\/(\d+(\.\d+)?)/,
+        "Opera": /(Opera|OPR)\/(\d+(\.\d+)?)/,
+        "Firefox": /Firefox\/(\d+(\.\d+)?)/,
+        "Firefox iOS": /FxiOS\/(\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+)?)/
+    };
+    const regex = versionRegexs[browser];
+    if (regex === undefined) {
+        return null;
+    }
+    const matches = userAgent.match(regex);
+    if (!matches) {
+        return null;
+    }
+    return parseFloat(matches[matches.length - 2]);
+}
+function osName(userAgent) {
+    const a = userAgent;
+    if (/Windows/i.test(a)) {
+        if (/Phone/.test(a) || /WPDesktop/.test(a)) {
+            return "Windows Phone";
+        }
+        return "Windows";
+    } else if (/(iPhone|iPad|iPod)/.test(a)) {
+        return "iOS";
+    } 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";
+    } else if (/Linux/.test(a)) {
+        return "Linux";
+    } else if (/CrOS/.test(a)) {
+        return "Chrome OS";
+    }
+    return "";
+}
+function deviceType(userAgent) {
+    if (/Windows Phone/i.test(userAgent) || /WPDesktop/.test(userAgent)) {
+        return "Windows Phone";
+    } else if (/iPad/.test(userAgent)) {
+        return "iPad";
+    } else if (/iPod/.test(userAgent)) {
+        return "iPod Touch";
+    } else if (/iPhone/.test(userAgent)) {
+        return "iPhone";
+    } else if (/(BlackBerry|PlayBook|BB10)/i.test(userAgent)) {
+        return "BlackBerry";
+    } else if (/Android/.test(userAgent)) {
+        return "Android";
+    }
+    return "";
+}
+function referringDomain(referrer) {
+    const split = referrer.split("/");
+    if (split.length >= 3) {
+        return split[2];
+    }
+    return "";
+}
+
+export { browserName, browserVersion, deviceType, osName, referringDomain };
+
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"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/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@workleap/mixpanel",
+  "version": "1.0.0",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/workleap/wl-tracking.git",
+    "directory": "packages/mixpanel"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "src",
+    "dist",
+    "CHANGELOG.md",
+    "README.md"
+  ],
+  "devDependencies": {
+    "@rsbuild/core": "1.2.19",
+    "@rslib/core": "0.5.5",
+    "@workleap/eslint-plugin": "3.3.1",
+    "@workleap/rslib-configs": "1.0.3",
+    "@workleap/typescript-configs": "3.0.2",
+    "eslint": "8.57.1",
+    "happy-dom": "17.4.4",
+    "typescript": "5.8.2",
+    "vitest": "3.0.9"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "sideEffects": false,
+  "scripts": {
+    "build": "rslib build --config ./rslib.build.ts",
+    "eslint": "eslint . --max-warnings=-0 --cache --cache-location node_modules/.cache/eslint",
+    "typecheck": "tsc",
+    "test": "vitest --config vitest.config.ts --no-watch"
+  }
+}

package/src/createTrackingFunction.ts

@@ -0,0 +1,65 @@
+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>;
+
+// Cannot use URL() because it doesn't support relative base url: https://github.com/whatwg/url/issues/531.
+function resolveApiUrl(path: string, baseUrl: string | undefined) : string {
+    return `${baseUrl}${baseUrl!.endsWith("/") ? "" : "/"}${path.startsWith("/") ? path.substring(1) : path}`;
+}
+
+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 trackingApiUrl The base URL of the tracking controlled. e.g. "/api/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 {
+    const targetProductId = createOptions?.targetProductId ?? null;
+
+    return async (eventName, properties, options) => {
+        const baseProperties = getBaseProperties();
+        const allProperties = { ...baseProperties, ...properties };
+
+        await fetch(resolveApiUrl("tracking/track", trackingApiBaseUrl), {
+            method: "POST",
+            credentials: "include",
+            keepalive: options?.keepAlive,
+            headers: { "Content-Type": "application/json" },
+            body: JSON.stringify({
+                eventName,
+                productId,
+                targetProductId: targetProductId,
+                properties: allProperties
+            })
+        });
+    };
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./createTrackingFunction.ts";
+

package/src/properties.ts

@@ -0,0 +1,36 @@
+
+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;
+}

package/src/utils.ts

@@ -0,0 +1,135 @@
+// 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
+
+    if (opera || userAgent.includes(" OPR/")) {
+        if (userAgent.includes("Mini")) {
+            return "Opera Mini";
+        }
+
+        return "Opera";
+    } else if (/(BlackBerry|PlayBook|BB10)/i.test(userAgent)) {
+        return "BlackBerry";
+    } else if (userAgent.includes("IEMobile") || userAgent.includes("WPDesktop")) {
+        return "Internet Explorer Mobile";
+    } else if (userAgent.includes("Edge")) {
+        return "Microsoft Edge";
+    } else if (userAgent.includes("FBIOS")) {
+        return "Facebook Mobile";
+    } else if (userAgent.includes("Chrome")) {
+        return "Chrome";
+    } else if (userAgent.includes("CriOS")) {
+        return "Chrome iOS";
+    } else if (userAgent.includes("UCWEB") || userAgent.includes("UCBrowser")) {
+        return "UC Browser";
+    } else if (userAgent.includes("FxiOS")) {
+        return "Firefox iOS";
+    } else if (vendor.includes("Apple")) {
+        if (userAgent.includes("Mobile")) {
+            return "Mobile Safari";
+        }
+
+        return "Safari";
+    } else if (userAgent.includes("Android")) {
+        return "Android Mobile";
+    } else if (userAgent.includes("Konqueror")) {
+        return "Konqueror";
+    } else if (userAgent.includes("Firefox")) {
+        return "Firefox";
+    } else if (userAgent.includes("MSIE") || userAgent.includes("Trident/")) {
+        return "Internet Explorer";
+    } else if (userAgent.includes("Gecko")) {
+        return "Mozilla";
+    }
+
+    return "";
+}
+
+/**
+ * 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 function browserVersion(userAgent: string, vendor?: string, opera?: object) {
+    const browser = browserName(userAgent, vendor, opera);
+    const versionRegexs: { [key: string]: RegExp } = {
+        "Internet Explorer Mobile": /rv:(\d+(\.\d+)?)/,
+        "Microsoft Edge": /Edge\/(\d+(\.\d+)?)/,
+        "Chrome": /Chrome\/(\d+(\.\d+)?)/,
+        "Chrome iOS": /CriOS\/(\d+(\.\d+)?)/,
+        "UC Browser": /(UCBrowser|UCWEB)\/(\d+(\.\d+)?)/,
+        "Safari": /Version\/(\d+(\.\d+)?)/,
+        "Mobile Safari": /Version\/(\d+(\.\d+)?)/,
+        "Opera": /(Opera|OPR)\/(\d+(\.\d+)?)/,
+        "Firefox": /Firefox\/(\d+(\.\d+)?)/,
+        "Firefox iOS": /FxiOS\/(\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+)?)/
+    };
+    const regex = versionRegexs[browser];
+    if (regex === undefined) {
+        return null;
+    }
+    const matches = userAgent.match(regex);
+    if (!matches) {
+        return null;
+    }
+
+    return parseFloat(matches[matches.length - 2]);
+}
+
+export function osName(userAgent: string) {
+    const a = userAgent;
+    if (/Windows/i.test(a)) {
+        if (/Phone/.test(a) || /WPDesktop/.test(a)) {
+            return "Windows Phone";
+        }
+
+        return "Windows";
+    } else if (/(iPhone|iPad|iPod)/.test(a)) {
+        return "iOS";
+    } 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";
+    } else if (/Linux/.test(a)) {
+        return "Linux";
+    } else if (/CrOS/.test(a)) {
+        return "Chrome OS";
+    }
+
+    return "";
+}
+
+export function deviceType(userAgent: string) {
+    if (/Windows Phone/i.test(userAgent) || /WPDesktop/.test(userAgent)) {
+        return "Windows Phone";
+    } else if (/iPad/.test(userAgent)) {
+        return "iPad";
+    } else if (/iPod/.test(userAgent)) {
+        return "iPod Touch";
+    } else if (/iPhone/.test(userAgent)) {
+        return "iPhone";
+    } else if (/(BlackBerry|PlayBook|BB10)/i.test(userAgent)) {
+        return "BlackBerry";
+    } else if (/Android/.test(userAgent)) {
+        return "Android";
+    }
+
+    return "";
+}
+
+export function referringDomain(referrer: string) {
+    const split = referrer.split("/");
+    if (split.length >= 3) {
+        return split[2];
+    }
+
+    return "";
+}