posthog-js-lite 3.1.0 → 3.2.1

package/lib/index.d.ts

@@ -48,6 +48,8 @@ declare enum PostHogPersistedProperty {
     Props = "props",
     FeatureFlags = "feature_flags",
     FeatureFlagPayloads = "feature_flag_payloads",
+    BootstrapFeatureFlags = "bootstrap_feature_flags",
+    BootstrapFeatureFlagPayloads = "bootstrap_feature_flag_payloads",
     OverrideFeatureFlags = "override_feature_flags",
     Queue = "queue",
     OptedOut = "opted_out",
@@ -57,7 +59,8 @@ declare enum PostHogPersistedProperty {
     GroupProperties = "group_properties",
     InstalledAppBuild = "installed_app_build",
     InstalledAppVersion = "installed_app_version",
-    SessionReplay = "session_replay"
+    SessionReplay = "session_replay",
+    DecideEndpointWasHit = "decide_endpoint_was_hit"
 }
 type PostHogFetchOptions = {
     method: 'GET' | 'POST' | 'PUT' | 'PATCH';
@@ -327,6 +330,7 @@ declare class PostHog extends PostHogCore {
     private _storageCache;
     private _storageKey;
     constructor(apiKey: string, options?: PostHogOptions);
+    private getWindow;
     getPersistedProperty<T>(key: PostHogPersistedProperty): T | undefined;
     setPersistedProperty<T>(key: PostHogPersistedProperty, value: T | null): void;
     fetch(url: string, options: PostHogFetchOptions): Promise<PostHogFetchResponse>;

package/lib/index.esm.js

@@ -5,6 +5,8 @@ var PostHogPersistedProperty;
     PostHogPersistedProperty["Props"] = "props";
     PostHogPersistedProperty["FeatureFlags"] = "feature_flags";
     PostHogPersistedProperty["FeatureFlagPayloads"] = "feature_flag_payloads";
+    PostHogPersistedProperty["BootstrapFeatureFlags"] = "bootstrap_feature_flags";
+    PostHogPersistedProperty["BootstrapFeatureFlagPayloads"] = "bootstrap_feature_flag_payloads";
     PostHogPersistedProperty["OverrideFeatureFlags"] = "override_feature_flags";
     PostHogPersistedProperty["Queue"] = "queue";
     PostHogPersistedProperty["OptedOut"] = "opted_out";
@@ -15,6 +17,7 @@ var PostHogPersistedProperty;
     PostHogPersistedProperty["InstalledAppBuild"] = "installed_app_build";
     PostHogPersistedProperty["InstalledAppVersion"] = "installed_app_version";
     PostHogPersistedProperty["SessionReplay"] = "session_replay";
+    PostHogPersistedProperty["DecideEndpointWasHit"] = "decide_endpoint_was_hit";
 })(PostHogPersistedProperty || (PostHogPersistedProperty = {}));
 
 function assert(truthyValue, message) {
@@ -58,6 +61,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>
@@ -1438,12 +1444,14 @@ class PostHogCore extends PostHogCoreStateless {
                 .filter((flag) => !!bootstrapfeatureFlags[flag])
                 .reduce((res, key) => ((res[key] = bootstrapfeatureFlags[key] || false), res), {});
             if (Object.keys(bootstrapFlags).length) {
+                this.setPersistedProperty(PostHogPersistedProperty.BootstrapFeatureFlags, bootstrapFlags);
                 const currentFlags = this.getPersistedProperty(PostHogPersistedProperty.FeatureFlags) || {};
                 const newFeatureFlags = { ...bootstrapFlags, ...currentFlags };
                 this.setKnownFeatureFlags(newFeatureFlags);
             }
             const bootstrapFlagPayloads = bootstrap.featureFlagPayloads;
             if (bootstrapFlagPayloads && Object.keys(bootstrapFlagPayloads).length) {
+                this.setPersistedProperty(PostHogPersistedProperty.BootstrapFeatureFlagPayloads, bootstrapFlagPayloads);
                 const currentFlagPayloads = this.getPersistedProperty(PostHogPersistedProperty.FeatureFlagPayloads) || {};
                 const newFeatureFlagPayloads = { ...bootstrapFlagPayloads, ...currentFlagPayloads };
                 this.setKnownFeatureFlagPayloads(newFeatureFlagPayloads);
@@ -1759,6 +1767,8 @@ class PostHogCore extends PostHogCoreStateless {
                     }
                     this.setKnownFeatureFlags(newFeatureFlags);
                     this.setKnownFeatureFlagPayloads(Object.fromEntries(Object.entries(newFeatureFlagPayloads || {}).map(([k, v]) => [k, this._parsePayload(v)])));
+                    // Mark that we hit the /decide endpoint so we can capture this in the $feature_flag_called event
+                    this.setPersistedProperty(PostHogPersistedProperty.DecideEndpointWasHit, true);
                     const sessionReplay = res?.sessionRecording;
                     if (sessionReplay) {
                         this.setPersistedProperty(PostHogPersistedProperty.SessionReplay, sessionReplay);
@@ -1805,6 +1815,10 @@ class PostHogCore extends PostHogCoreStateless {
             this.capture('$feature_flag_called', {
                 $feature_flag: key,
                 $feature_flag_response: response,
+                $feature_flag_bootstrapped_response: this.getPersistedProperty(PostHogPersistedProperty.BootstrapFeatureFlags)?.[key],
+                $feature_flag_bootstrapped_payload: this.getPersistedProperty(PostHogPersistedProperty.BootstrapFeatureFlagPayloads)?.[key],
+                // If we haven't yet received a response from the /decide endpoint, we must have used the bootstrapped value
+                $used_bootstrap_value: !this.getPersistedProperty(PostHogPersistedProperty.DecideEndpointWasHit),
             });
         }
         // If we have flags we either return the value (true or string) or false
@@ -1902,15 +1916,18 @@ class PostHogCore extends PostHogCoreStateless {
     }
 }
 
-var version = "3.1.0";
+var version = "3.2.1";
 
 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),
@@ -2012,6 +2029,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)) {
@@ -2031,7 +2051,7 @@ function os(window) {
   } else if (/CrOS/.test(a)) {
     return 'Chrome OS';
   } else {
-    return '';
+    return undefined;
   }
 }
 function device(userAgent) {
@@ -2135,9 +2155,6 @@ const createStorageLike = store => {
   };
 };
 const checkStoreIsSupported = (storage, key = '__mplssupport__') => {
-  if (!window) {
-    return false;
-  }
   try {
     const val = 'xyz';
     storage.setItem(key, val);
@@ -2209,12 +2226,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) || '{}') || {};
@@ -2233,7 +2253,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';
@@ -2247,7 +2272,7 @@ class PostHog extends PostHogCore {
   getCommonEventProperties() {
     return {
       ...super.getCommonEventProperties(),
-      ...getContext(window)
+      ...getContext(this.getWindow())
     };
   }
 }