@workleap/mixpanel 1.0.2 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @workleap/mixpanel
 
+## 1.1.0
+
+### Minor Changes
+
+- [#8](https://github.com/workleap/wl-tracking/pull/8) [`5199dc1`](https://github.com/workleap/wl-tracking/commit/5199dc1cce5d9ab05c0cda84be2ac81cdf6a9456) Thanks [@alexasselin008](https://github.com/alexasselin008)! - Add the possibility to specify only the environment to use, and the tracking function will provide the correct URL
+
+### Patch Changes
+
+- [#6](https://github.com/workleap/wl-tracking/pull/6) [`e26a764`](https://github.com/workleap/wl-tracking/commit/e26a764282f881b4ab50009db1f88879e8a02776) Thanks [@alexasselin008](https://github.com/alexasselin008)! - Export types from the packages
+
 ## 1.0.2
 
 ### Patch Changes

package/dist/createTrackingFunction.d.ts

@@ -1,3 +1,4 @@
+import { type Environment } from "./env.ts";
 import { type TrackEventProperties } from "./properties.ts";
 export interface TrackingOptions {
     /**
@@ -19,7 +20,7 @@ export interface TrackingOptions {
  * @param options Options for tracking the event.
  */
 export type TrackingFunction = (eventName: string, properties: TrackEventProperties, options?: TrackingOptions) => Promise<void>;
-interface CreateTrackingFunctionOptions {
+export interface CreateTrackingFunctionOptions {
     /**
      * The product identifier of the target product.
      * @default null
@@ -29,9 +30,16 @@ interface CreateTrackingFunctionOptions {
 /**
  * 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 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;
-export {};

package/dist/createTrackingFunction.js

@@ -1,28 +1,23 @@
+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__
 
-// 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 = {}) {
+
+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(resolveApiUrl("tracking/track", trackingApiBaseUrl), {
+        await fetch(fullUrl, {
             method: "POST",
             credentials: "include",
             keepalive: options?.keepAlive,
@@ -32,7 +27,7 @@ function resolveApiUrl(path, baseUrl) {
             body: JSON.stringify({
                 eventName,
                 productId,
-                targetProductId: targetProductId,
+                targetProductId,
                 properties: allProperties
             })
         });

package/dist/createTrackingFunction.js.map

@@ -1 +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"}
+{"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                productId,\n                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;gBACAL;gBACAG;gBACA,YAAYM;YAChB;QACJ;IACJ;AACJ"}

package/dist/env.d.ts

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

package/dist/env.js

@@ -0,0 +1,33 @@
+
+;// CONCATENATED MODULE: ./src/env.ts?__rslib_entry__
+const EnvironmentList = [
+    "development",
+    "staging",
+    "production",
+    "local",
+    "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/"
+};
+// 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}`;
+}
+function getTrackingEndpoint(envOrTrackingApiBaseUrl) {
+    let baseUrl;
+    if (EnvironmentList.includes(envOrTrackingApiBaseUrl)) {
+        baseUrl = NavigationApiBaseUrl[envOrTrackingApiBaseUrl];
+    } else {
+        baseUrl = envOrTrackingApiBaseUrl;
+    }
+    return resolveApiUrl("tracking/track", baseUrl);
+}
+
+export { getTrackingEndpoint };
+
+//# sourceMappingURL=env.js.map

package/dist/env.js.map

@@ -0,0 +1 @@
+{"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 +1,3 @@
 export * from "./createTrackingFunction.ts";
+export type { Environment } from "./env.ts";
+export type { TrackEventProperties } from "./properties.ts";

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["webpack://@workleap/mixpanel/./src/index.ts"],"sourcesContent":["export * from \"./createTrackingFunction.ts\";\n\n"],"names":[],"mappings":";;;AAA4C"}
+{"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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workleap/mixpanel",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",

package/src/createTrackingFunction.ts

@@ -1,3 +1,4 @@
+import { getTrackingEndpoint, type Environment } from "./env.ts";
 import { getBaseProperties, type TrackEventProperties } from "./properties.ts";
 
 export interface TrackingOptions {
@@ -22,12 +23,7 @@ export interface TrackingOptions {
  */
 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 {
+export interface CreateTrackingFunctionOptions {
     /**
      * The product identifier of the target product.
      * @default null
@@ -38,18 +34,28 @@ interface CreateTrackingFunctionOptions {
 /**
  * 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 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, 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(resolveApiUrl("tracking/track", trackingApiBaseUrl), {
+        await fetch(fullUrl, {
             method: "POST",
             credentials: "include",
             keepalive: options?.keepAlive,
@@ -57,7 +63,7 @@ export function createTrackingFunction(productId: string, trackingApiBaseUrl: st
             body: JSON.stringify({
                 eventName,
                 productId,
-                targetProductId: targetProductId,
+                targetProductId,
                 properties: allProperties
             })
         });

package/src/env.ts

@@ -0,0 +1,27 @@
+
+const EnvironmentList = ["development", "staging", "production", "local", "msw"] as const;
+export type Environment = typeof EnvironmentList[number];
+
+const NavigationApiBaseUrl: Record<Environment, 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/"
+};
+
+// 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}`;
+}
+
+export function getTrackingEndpoint(envOrTrackingApiBaseUrl: Environment | (string & {})) {
+    let baseUrl: string;
+    if (EnvironmentList.includes(envOrTrackingApiBaseUrl as Environment)) {
+        baseUrl = NavigationApiBaseUrl[envOrTrackingApiBaseUrl as Environment];
+    } else {
+        baseUrl = envOrTrackingApiBaseUrl;
+    }
+
+    return resolveApiUrl("tracking/track", baseUrl);
+}

package/src/index.ts

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