posthog-js-lite 2.4.0 → 2.5.0

package/lib/index.d.ts

@@ -30,7 +30,9 @@ declare enum PostHogPersistedProperty {
     SessionId = "session_id",
     SessionLastTimestamp = "session_timestamp",
     PersonProperties = "person_properties",
-    GroupProperties = "group_properties"
+    GroupProperties = "group_properties",
+    InstalledAppBuild = "installed_app_build",
+    InstalledAppVersion = "installed_app_version"
 }
 declare type PostHogFetchOptions = {
     method: 'GET' | 'POST' | 'PUT' | 'PATCH';
@@ -173,6 +175,7 @@ declare abstract class PostHogCore extends PostHogCoreStateless {
     private flagCallReported;
     protected _decideResponsePromise?: Promise<PostHogDecideResponse | undefined>;
     protected _sessionExpirationTimeSeconds: number;
+    protected sessionProps: PostHogEventProperties;
     constructor(apiKey: string, options?: PosthogCoreOptions);
     protected setupBootstrap(options?: Partial<PosthogCoreOptions>): void;
     private get props();
@@ -182,15 +185,19 @@ declare abstract class PostHogCore extends PostHogCoreStateless {
     on(event: string, cb: (...args: any[]) => void): () => void;
     reset(propertiesToKeep?: PostHogPersistedProperty[]): void;
     protected getCommonEventProperties(): any;
-    private enrichProperties;
+    enrichProperties(properties?: PostHogEventProperties): any;
     getSessionId(): string | undefined;
     resetSessionId(): void;
     getAnonymousId(): string;
     getDistinctId(): string;
+    unregister(property: string): void;
     register(properties: {
         [key: string]: any;
     }): void;
-    unregister(property: string): void;
+    registerForSession(properties: {
+        [key: string]: any;
+    }): void;
+    unregisterForSession(property: string): void;
     /***
      *** TRACKING
      ***/
@@ -211,9 +218,19 @@ declare abstract class PostHogCore extends PostHogCoreStateless {
     /***
      * PROPERTIES
      ***/
+    setPersonPropertiesForFlags(properties: {
+        [type: string]: string;
+    }): this;
+    resetPersonPropertiesForFlags(): void;
+    /** @deprecated - Renamed to setPersonPropertiesForFlags */
     personProperties(properties: {
         [type: string]: string;
     }): this;
+    setGroupPropertiesForFlags(properties: {
+        [type: string]: Record<string, string>;
+    }): this;
+    resetGroupPropertiesForFlags(): void;
+    /** @deprecated - Renamed to setGroupPropertiesForFlags */
     groupProperties(properties: {
         [type: string]: Record<string, string>;
     }): this;

package/lib/index.esm.js

@@ -154,6 +154,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) {
@@ -712,7 +714,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;
@@ -1162,6 +1167,7 @@ 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
         return _this;
@@ -1203,6 +1209,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);
@@ -1230,7 +1237,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);
@@ -1256,13 +1263,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
@@ -1342,13 +1355,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) {
@@ -1360,6 +1380,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
      ***/
@@ -1551,7 +1578,7 @@ var PostHogCore = /** @class */ (function (_super) {
     return PostHogCore;
 }(PostHogCoreStateless));
 
-var version = "2.4.0";
+var version = "2.5.0";
 
 function getContext(window) {
   var context = {};