posthog-js-lite 3.2.0 → 3.3.0

package/CHANGELOG.md

@@ -1,18 +1,29 @@
 # Next
 
+# 3.3.0 - 2025-02-06
+
+## Added
+
+1. Adds `captureException` function to allow manual capture of exceptions
+
+# 3.2.1 - 2025-01-17
+
+## Fixed
+
+1. fix: check if window and fetch are available before using on web env
+
 # 3.2.0 - 2024-12-12
 
 ## Changed
 
 1. Add new debugging property `$feature_flag_bootstrapped_response`, `$feature_flag_bootstrapped_payload` and `$used_bootstrap_value` to `$feature_flag_called` event
 
-
 # 3.1.0 - 2024-11-21
 
 ## Changed
 
 1. chore: default `captureMode` changed to `json`.
-    1. To keep using the `form` mode, just set the `captureMode` option to `form` when initializing the PostHog client.
+   1. To keep using the `form` mode, just set the `captureMode` option to `form` when initializing the PostHog client.
 2. fix: identify method allows passing a $set_once object
 
 # 3.0.2 - 2024-06-15

package/README.md

@@ -2,7 +2,7 @@
 
 > 🚧 This is a reduced feature set package. Currently the only officially supported feature complete way of using PostHog on the web is [posthog-js](https://github.com/PostHog/posthog-js)
 
-This package is currently published to npm as [posthog-js-lite](https://www.npmjs.com/package/posthog-js-lite) and is a simplified version of the recommended and offically supported `posthog-js`.
+This package is currently published to npm as [posthog-js-lite](https://www.npmjs.com/package/posthog-js-lite) and is a simplified version of the recommended and officially supported `posthog-js`.
 
 You'd want to use this only if you're very conscious about package sizes, and this reduced feature set (only analytics and feature flags) works for your use case. The most common use case is in chrome extensions.
 

package/lib/index.cjs.js

@@ -65,6 +65,9 @@ function safeSetTimeout(fn, timeout) {
     // We unref if available to prevent Node.js hanging on exit
     t?.unref && t?.unref();
     return t;
+}
+function getFetch() {
+    return typeof fetch !== 'undefined' ? fetch : typeof global.fetch !== 'undefined' ? global.fetch : undefined;
 }
 
 // Copyright (c) 2013 Pieroxy <pieroxy@pieroxy.net>
@@ -1915,17 +1918,41 @@ class PostHogCore extends PostHogCoreStateless {
             return this.setPersistedProperty(PostHogPersistedProperty.OverrideFeatureFlags, flags);
         });
     }
+    /***
+     *** ERROR TRACKING
+     ***/
+    captureException(error, additionalProperties) {
+        const properties = {
+            $exception_level: 'error',
+            $exception_list: [
+                {
+                    type: error.name,
+                    value: error.message,
+                    mechanism: {
+                        handled: true,
+                        synthetic: false,
+                    },
+                },
+            ],
+            ...additionalProperties,
+        };
+        properties.$exception_personURL = new URL(`/project/${this.apiKey}/person/${this.getDistinctId()}`, this.host).toString();
+        this.capture('$exception', properties);
+    }
 }
 
-var version = "3.2.0";
+var version = "3.3.0";
 
 function getContext(window) {
   let context = {};
-  if (window.navigator) {
+  if (window?.navigator) {
     const userAgent = window.navigator.userAgent;
+    const osValue = os(window);
     context = {
       ...context,
-      $os: os(window),
+      ...(osValue !== undefined && {
+        $os: osValue
+      }),
       $browser: browser(userAgent, window.navigator.vendor, !!window.opera),
       $referrer: window.document.referrer,
       $referring_domain: referringDomain(window.document.referrer),
@@ -2027,6 +2054,9 @@ function browserVersion(userAgent, vendor, opera) {
   return parseFloat(matches[matches.length - 2]);
 }
 function os(window) {
+  if (!window?.navigator) {
+    return undefined;
+  }
   const a = window.navigator.userAgent;
   if (/Windows/i.test(a)) {
     if (/Phone/.test(a) || /WPDesktop/.test(a)) {
@@ -2046,7 +2076,7 @@ function os(window) {
   } else if (/CrOS/.test(a)) {
     return 'Chrome OS';
   } else {
-    return '';
+    return undefined;
   }
 }
 function device(userAgent) {
@@ -2150,9 +2180,6 @@ const createStorageLike = store => {
   };
 };
 const checkStoreIsSupported = (storage, key = '__mplssupport__') => {
-  if (!window) {
-    return false;
-  }
   try {
     const val = 'xyz';
     storage.setItem(key, val);
@@ -2224,12 +2251,15 @@ class PostHog extends PostHogCore {
     super(apiKey, options);
     // posthog-js stores options in one object on
     this._storageKey = options?.persistence_name ? `ph_${options.persistence_name}` : `ph_${apiKey}_posthog`;
-    this._storage = getStorage(options?.persistence || 'localStorage', window);
+    this._storage = getStorage(options?.persistence || 'localStorage', this.getWindow());
     this.setupBootstrap(options);
     if (options?.preloadFeatureFlags !== false) {
       this.reloadFeatureFlags();
     }
   }
+  getWindow() {
+    return typeof window !== 'undefined' ? window : undefined;
+  }
   getPersistedProperty(key) {
     if (!this._storageCache) {
       this._storageCache = JSON.parse(this._storage.getItem(this._storageKey) || '{}') || {};
@@ -2248,7 +2278,12 @@ class PostHog extends PostHogCore {
     this._storage.setItem(this._storageKey, JSON.stringify(this._storageCache));
   }
   fetch(url, options) {
-    return window.fetch(url, options);
+    const fetchFn = getFetch();
+    if (!fetchFn) {
+      // error will be handled by the caller (fetchWithRetry)
+      return Promise.reject(new Error('Fetch API is not available in this environment.'));
+    }
+    return fetchFn(url, options);
   }
   getLibraryId() {
     return 'posthog-js-lite';
@@ -2262,7 +2297,7 @@ class PostHog extends PostHogCore {
   getCommonEventProperties() {
     return {
       ...super.getCommonEventProperties(),
-      ...getContext(window)
+      ...getContext(this.getWindow())
     };
   }
 }