@workleap/mixpanel 1.0.0 → 1.0.2

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# @workleap/mixpanel
+
+## 1.0.2
+
+### Patch Changes
+
+- [#4](https://github.com/workleap/wl-tracking/pull/4) [`3430c6d`](https://github.com/workleap/wl-tracking/commit/3430c6dc2ccf381a96f8d1d03e7f695670d9e9d2) Thanks [@alexasselin008](https://github.com/alexasselin008)! - Added cjs entry point to our package
+
+## 1.0.1
+
+### Patch Changes
+
+- [#2](https://github.com/workleap/wl-tracking/pull/2) [`5e904ad`](https://github.com/workleap/wl-tracking/commit/5e904ad5117d86d0d7e7a727bfabe3f2db427f62) Thanks [@alexasselin008](https://github.com/alexasselin008)! - Add readme to package

package/README.md

@@ -0,0 +1,43 @@
+# `@workleap/mixpanel`
+
+This package allows you to add basic tracking capabilities to your applications. It exposes a single `track` function that calls a tracking endpoint that conforms to the Workleap Platform Tracking API in the environment URL you have provided.
+
+To use it you must first call the `createTrackingFunction` factory, which will return you a tracking function that you can then use in your code
+```ts
+import { createTrackingFunction } from "@workleap/mixpanel";
+
+const environmentVariables = getEnvironmentVariables();
+const productId = "wlp" //Workleap Management
+const track = createTrackingFunction(productId, environmentVariables.navigationApiBaseUrl);
+
+track("ButtonClicked", { "Trigger": "ChangePlan", "Location": "Header" });
+```
+
+You might want to track an action done in Workleap Management (or another product) that targets another product. The library provides a function options to specify the target product identifier.
+```ts
+import { createTrackingFunction } from "@workleap/mixpanel";
+
+const environmentVariables = getEnvironmentVariables();
+const productId = "wlp" //Workleap Management
+const targetProductId = "wov" //Officevibe
+const track = createTrackingFunction(productId, environmentVariables.navigationApiBaseUrl, {
+    targetProductId
+});
+
+track("ButtonClicked", { "Trigger": "ChangePlan", "Location": "Header" });
+```
+
+## Link Tracking
+
+If you want to track a link click, you can use the `track` function and add the `keepAlive` option to keep the current page alive while the tracking request is being made.
+
+```ts
+
+const track = createTrackingFunction(productId, environmentVariables.navigationApiBaseUrl);
+
+track("LinkClicked", { "Trigger": "ChangePlan", "Location": "Header" }, { keepAlive: true });
+```
+
+## Migration Notes
+
+The migration notes can be found [here](./MIGRATION_NOTES.md).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workleap/mixpanel",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
@@ -12,6 +12,7 @@
     "provenance": true
   },
   "type": "module",
+  "main": "./dist/index.js",
   "exports": {
     ".": {
       "import": "./dist/index.js",