posthog-js-lite 2.3.0 → 2.5.0

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 2.5.0 - 2023-12-04
+
+1.  Renamed `personProperties` to `setPersonPropertiesForFlags` to match `posthog-js` and more clearly indicated what it does
+2.  Renamed `groupProperties` to `setGroupPropertiesForFlags` to match `posthog-js` and more clearly indicated what it does
+
+# 2.4.0 - 2023-04-20
+
+1. Fixes a race condition that could occur when initialising PostHog
+2. Fixes an issue where feature flags would not be reloaded after a reset
+
 # 2.3.0 - 2023-04-19
 
 1. Some small fixes to incorrect types

package/lib/index.cjs.js

@@ -158,6 +158,8 @@ var PostHogPersistedProperty;
     PostHogPersistedProperty["SessionLastTimestamp"] = "session_timestamp";
     PostHogPersistedProperty["PersonProperties"] = "person_properties";
     PostHogPersistedProperty["GroupProperties"] = "group_properties";
+    PostHogPersistedProperty["InstalledAppBuild"] = "installed_app_build";
+    PostHogPersistedProperty["InstalledAppVersion"] = "installed_app_version";
 })(PostHogPersistedProperty || (PostHogPersistedProperty = {}));
 
 function assert(truthyValue, message) {
@@ -716,7 +718,10 @@ var PostHogFetchHttpError = /** @class */ (function (_super) {
 var PostHogFetchNetworkError = /** @class */ (function (_super) {
     __extends(PostHogFetchNetworkError, _super);
     function PostHogFetchNetworkError(error) {
-        var _this = _super.call(this, 'Network error while fetching PostHog', error instanceof Error ? { cause: error } : {}) || this;
+        var _this = 
+        // TRICKY: "cause" is a newer property but is just ignored otherwise. Cast to any to ignore the type issue.
+        // @ts-ignore
+        _super.call(this, 'Network error while fetching PostHog', error instanceof Error ? { cause: error } : {}) || this;
         _this.error = error;
         _this.name = 'PostHogFetchNetworkError';
         return _this;
@@ -1132,7 +1137,11 @@ var PostHogCoreStateless = /** @class */ (function () {
                         return [4 /*yield*/, this.flushAsync()];
                     case 2:
                         _a.sent();
-                        return [4 /*yield*/, Promise.allSettled(Object.values(this.pendingPromises))];
+                        return [4 /*yield*/, Promise.all(Object.values(this.pendingPromises).map(function (x) {
+                                return x.catch(function () {
+                                    // ignore errors as we are shutting down and can't deal with them anyways.
+                                });
+                            }))];
                     case 3:
                         _a.sent();
                         return [3 /*break*/, 5];
@@ -1162,14 +1171,9 @@ var PostHogCore = /** @class */ (function (_super) {
         var disableGeoipOption = (_a = options === null || options === void 0 ? void 0 : options.disableGeoip) !== null && _a !== void 0 ? _a : false;
         _this = _super.call(this, apiKey, __assign(__assign({}, options), { disableGeoip: disableGeoipOption })) || this;
         _this.flagCallReported = {};
+        _this.sessionProps = {};
         _this.sendFeatureFlagEvent = (_b = options === null || options === void 0 ? void 0 : options.sendFeatureFlagEvent) !== null && _b !== void 0 ? _b : true;
         _this._sessionExpirationTimeSeconds = (_c = options === null || options === void 0 ? void 0 : options.sessionExpirationTimeSeconds) !== null && _c !== void 0 ? _c : 1800; // 30 minutes
-        // NOTE: It is important we don't initiate anything in the constructor as some async IO may still be underway on the parent
-        if ((options === null || options === void 0 ? void 0 : options.preloadFeatureFlags) !== false) {
-            safeSetTimeout(function () {
-                _this.reloadFeatureFlags();
-            }, 1);
-        }
         return _this;
     }
     PostHogCore.prototype.setupBootstrap = function (options) {
@@ -1209,6 +1213,7 @@ var PostHogCore = /** @class */ (function (_super) {
     });
     PostHogCore.prototype.clearProps = function () {
         this.props = undefined;
+        this.sessionProps = {};
     };
     PostHogCore.prototype.on = function (event, cb) {
         return this._events.on(event, cb);
@@ -1236,7 +1241,7 @@ var PostHogCore = /** @class */ (function (_super) {
         return __assign(__assign({ $active_feature_flags: featureFlags ? Object.keys(featureFlags) : undefined }, featureVariantProperties), _super.prototype.getCommonEventProperties.call(this));
     };
     PostHogCore.prototype.enrichProperties = function (properties) {
-        return __assign(__assign(__assign(__assign({}, this.props), (properties || {})), this.getCommonEventProperties()), { $session_id: this.getSessionId() });
+        return __assign(__assign(__assign(__assign(__assign({}, this.props), this.sessionProps), (properties || {})), this.getCommonEventProperties()), { $session_id: this.getSessionId() });
     };
     PostHogCore.prototype.getSessionId = function () {
         var sessionId = this.getPersistedProperty(PostHogPersistedProperty.SessionId);
@@ -1262,13 +1267,19 @@ var PostHogCore = /** @class */ (function (_super) {
     PostHogCore.prototype.getDistinctId = function () {
         return this.getPersistedProperty(PostHogPersistedProperty.DistinctId) || this.getAnonymousId();
     };
+    PostHogCore.prototype.unregister = function (property) {
+        delete this.props[property];
+        this.setPersistedProperty(PostHogPersistedProperty.Props, this.props);
+    };
     PostHogCore.prototype.register = function (properties) {
         this.props = __assign(__assign({}, this.props), properties);
         this.setPersistedProperty(PostHogPersistedProperty.Props, this.props);
     };
-    PostHogCore.prototype.unregister = function (property) {
-        delete this.props[property];
-        this.setPersistedProperty(PostHogPersistedProperty.Props, this.props);
+    PostHogCore.prototype.registerForSession = function (properties) {
+        this.sessionProps = __assign(__assign({}, this.sessionProps), properties);
+    };
+    PostHogCore.prototype.unregisterForSession = function (property) {
+        delete this.sessionProps[property];
     };
     /***
      *** TRACKING
@@ -1284,9 +1295,7 @@ var PostHogCore = /** @class */ (function (_super) {
             // We keep the AnonymousId to be used by decide calls and identify to link the previousId
             this.setPersistedProperty(PostHogPersistedProperty.AnonymousId, previousDistinctId);
             this.setPersistedProperty(PostHogPersistedProperty.DistinctId, distinctId);
-            if (this.getFeatureFlags()) {
-                this.reloadFeatureFlags();
-            }
+            this.reloadFeatureFlags();
         }
         _super.prototype.identifyStateless.call(this, distinctId, allProperties, options);
         return this;
@@ -1326,7 +1335,7 @@ var PostHogCore = /** @class */ (function (_super) {
         this.register({
             $groups: __assign(__assign({}, existingGroups), groups),
         });
-        if (Object.keys(groups).find(function (type) { return existingGroups[type] !== groups[type]; }) && this.getFeatureFlags()) {
+        if (Object.keys(groups).find(function (type) { return existingGroups[type] !== groups[type]; })) {
             this.reloadFeatureFlags();
         }
         return this;
@@ -1350,13 +1359,20 @@ var PostHogCore = /** @class */ (function (_super) {
     /***
      * PROPERTIES
      ***/
-    PostHogCore.prototype.personProperties = function (properties) {
+    PostHogCore.prototype.setPersonPropertiesForFlags = function (properties) {
         // Get persisted person properties
         var existingProperties = this.getPersistedProperty(PostHogPersistedProperty.PersonProperties) || {};
         this.setPersistedProperty(PostHogPersistedProperty.PersonProperties, __assign(__assign({}, existingProperties), properties));
         return this;
     };
-    PostHogCore.prototype.groupProperties = function (properties) {
+    PostHogCore.prototype.resetPersonPropertiesForFlags = function () {
+        this.setPersistedProperty(PostHogPersistedProperty.PersonProperties, {});
+    };
+    /** @deprecated - Renamed to setPersonPropertiesForFlags */
+    PostHogCore.prototype.personProperties = function (properties) {
+        return this.setPersonPropertiesForFlags(properties);
+    };
+    PostHogCore.prototype.setGroupPropertiesForFlags = function (properties) {
         // Get persisted group properties
         var existingProperties = this.getPersistedProperty(PostHogPersistedProperty.GroupProperties) || {};
         if (Object.keys(existingProperties).length !== 0) {
@@ -1368,6 +1384,13 @@ var PostHogCore = /** @class */ (function (_super) {
         this.setPersistedProperty(PostHogPersistedProperty.GroupProperties, __assign(__assign({}, existingProperties), properties));
         return this;
     };
+    PostHogCore.prototype.resetGroupPropertiesForFlags = function () {
+        this.setPersistedProperty(PostHogPersistedProperty.GroupProperties, {});
+    };
+    /** @deprecated - Renamed to setGroupPropertiesForFlags */
+    PostHogCore.prototype.groupProperties = function (properties) {
+        return this.setGroupPropertiesForFlags(properties);
+    };
     /***
      *** FEATURE FLAGS
      ***/
@@ -1559,7 +1582,7 @@ var PostHogCore = /** @class */ (function (_super) {
     return PostHogCore;
 }(PostHogCoreStateless));
 
-var version = "2.3.0";
+var version = "2.5.0";
 
 function getContext(window) {
   var context = {};
@@ -1924,6 +1947,10 @@ function (_super) {
 
     _this.setupBootstrap(options);
 
+    if ((options === null || options === void 0 ? void 0 : options.preloadFeatureFlags) !== false) {
+      _this.reloadFeatureFlags();
+    }
+
     return _this;
   }