@pushwoosh/kit-helpers 4.8.5 → 4.8.7

package/{ai-documentation.mdx → ai-documentation.md}

@@ -600,7 +600,7 @@ const cleanup = elementAddListeners(
 - **Path:** `~/src/hooks/useClickAway`
 - **Description:** Subscribes to clicks outside an element
 - **Signature:**
-```ts
+```typescript
 subscribeClickAway<T extends HTMLElement>(
   element: T,
   callback: (event: MouseEvent | TouchEvent) => void

package/analytics/identifyMixpanel.d.ts

@@ -0,0 +1 @@
+export declare const identifyMixpanel: (email: string) => void;

package/analytics/identifyMixpanel.js

@@ -0,0 +1,16 @@
+import { isProductionMode, isUserActionsTrackingOff } from './utils';
+export const identifyMixpanel = email => {
+  if (!isProductionMode() || isUserActionsTrackingOff()) {
+    return;
+  }
+  if (!window.mixpanel) {
+    const store = window.pwMixpanelIdentifyStore || [];
+    store.push(email);
+    window.pwMixpanelIdentifyStore = store;
+  } else {
+    window.mixpanel?.identify(email);
+    window.mixpanel?.people?.set({
+      $email: email
+    });
+  }
+};

package/analytics/identifyOpenReplay.d.ts

@@ -0,0 +1 @@
+export declare const identifyOpenReplaySession: (email: string) => void;

package/analytics/identifyOpenReplay.js

@@ -0,0 +1,13 @@
+import { isProductionMode, isUserActionsTrackingOff } from './utils';
+export const identifyOpenReplaySession = email => {
+  if (!isProductionMode() || isUserActionsTrackingOff()) {
+    return;
+  }
+  if (!window.OpenReplay) {
+    const store = window.pwOpenReplayIdentifyStore || [];
+    store.push(email);
+    window.pwOpenReplayIdentifyStore = store;
+  } else {
+    window.OpenReplay?.setUserID(email);
+  }
+};

package/analytics/trackMixpanel.d.ts

@@ -0,0 +1,2 @@
+import { type Event } from './utils';
+export declare function trackMixpanelEvent(event: Event): void;

package/analytics/trackMixpanel.js

@@ -0,0 +1,13 @@
+import { isProductionMode, isUserActionsTrackingOff } from './utils';
+export function trackMixpanelEvent(event) {
+  if (!isProductionMode() || isUserActionsTrackingOff()) {
+    return;
+  }
+  if (!window.mixpanel) {
+    const store = window.pwMixpanelTrackingEventsStore || [];
+    store.push(event);
+    window.pwMixpanelTrackingEventsStore = store;
+  } else {
+    window.mixpanel?.track(event.name, event.properties);
+  }
+}

package/analytics/utils.d.ts

@@ -0,0 +1,20 @@
+import { type Mixpanel } from 'mixpanel-browser';
+interface IOpenReplay {
+    setUserID(id: string): void;
+}
+export type Event = {
+    readonly name: string;
+    readonly properties?: Record<string, unknown>;
+};
+declare global {
+    interface Window {
+        mixpanel?: Mixpanel;
+        OpenReplay?: IOpenReplay;
+        pwMixpanelIdentifyStore?: string[];
+        pwOpenReplayIdentifyStore?: string[];
+        pwMixpanelTrackingEventsStore?: Event[];
+    }
+}
+export declare const isProductionMode: () => boolean;
+export declare const isUserActionsTrackingOff: () => boolean;
+export {};

package/analytics/utils.js

@@ -0,0 +1,7 @@
+export const isProductionMode = () => process.env.NODE_ENV === 'production';
+export const isUserActionsTrackingOff = () => {
+  const turnOffTracking = localStorage.getItem('pw_off_user_actions_tracking');
+  // Any value other than these specific "falsey" ones means tracking is off.
+  const trackingOnValues = [null, '', '0', 'false'];
+  return !trackingOnValues.includes(turnOffTracking);
+};

package/index.d.ts

@@ -1,6 +1,9 @@
 export * from './grid';
 export * from './expand';
 export * from './hooks/useClickAway';
+export { trackMixpanelEvent } from './analytics/trackMixpanel';
+export { identifyMixpanel } from './analytics/identifyMixpanel';
+export { identifyOpenReplaySession } from './analytics/identifyOpenReplay';
 export { formatNumber } from './formatNumber';
 export { default as usePersistentFunction } from './hooks/usePersistentFunction';
 export { default as useEffectOnce } from './hooks/useEffectOnce';

package/index.js

@@ -1,6 +1,9 @@
 export * from './grid';
 export * from './expand';
 export * from './hooks/useClickAway';
+export { trackMixpanelEvent } from './analytics/trackMixpanel';
+export { identifyMixpanel } from './analytics/identifyMixpanel';
+export { identifyOpenReplaySession } from './analytics/identifyOpenReplay';
 export { formatNumber } from './formatNumber';
 export { default as usePersistentFunction } from './hooks/usePersistentFunction';
 export { default as useEffectOnce } from './hooks/useEffectOnce';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushwoosh/kit-helpers",
-  "version": "4.8.5",
+  "version": "4.8.7",
   "description": "React component for build Pushwoosh products",
   "main": "index.js",
   "module": "index.js",
@@ -8,7 +8,7 @@
   "sideEffects": false,
   "scripts": {
     "start": "npm run playground",
-    "build": "pushwoosh-engine lib:build && cp ai-documentation.mdx dist/ai-documentation.mdx",
+    "build": "pushwoosh-engine lib:build && cp ai-documentation.md dist/ai-documentation.md",
     "playground": "pushwoosh-engine lib:playground",
     "check": "npm run check:lint && npm run check:types",
     "check:lint": "echo \"Run check:lint\" && eslint .",
@@ -16,6 +16,7 @@
   },
   "pre-commit": "check",
   "dependencies": {
+    "mixpanel-browser": "^2.71.0",
     "react-transition-group": "^4.4.5"
   },
   "devDependencies": {