posthog-js-lite 2.4.0 → 2.6.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';
@@ -42,7 +44,10 @@ declare type PostHogFetchOptions = {
     body?: string;
     signal?: AbortSignal;
 };
-declare type PosthogCaptureOptions = {
+declare type PostHogCaptureOptions = {
+    /** If provided overrides the auto-generated event ID */
+    uuid?: string;
+    /** If provided overrides the auto-generated timestamp */
     timestamp?: Date;
     disableGeoip?: boolean;
 };
@@ -111,9 +116,9 @@ declare abstract class PostHogCoreStateless {
     private captureMode;
     private removeDebugCallback?;
     private debugMode;
-    private pendingPromises;
     private disableGeoip;
     private _optoutOverride;
+    private pendingPromises;
     protected _events: SimpleEventEmitter;
     protected _flushTimer?: any;
     protected _retryOptions: RetriableOptions;
@@ -131,20 +136,21 @@ declare abstract class PostHogCoreStateless {
     on(event: string, cb: (...args: any[]) => void): () => void;
     debug(enabled?: boolean): void;
     private buildPayload;
+    protected addPendingPromise(promise: Promise<any>): void;
     /***
      *** TRACKING
      ***/
-    protected identifyStateless(distinctId: string, properties?: PostHogEventProperties, options?: PosthogCaptureOptions): this;
+    protected identifyStateless(distinctId: string, properties?: PostHogEventProperties, options?: PostHogCaptureOptions): this;
     protected captureStateless(distinctId: string, event: string, properties?: {
         [key: string]: any;
-    }, options?: PosthogCaptureOptions): this;
+    }, options?: PostHogCaptureOptions): this;
     protected aliasStateless(alias: string, distinctId: string, properties?: {
         [key: string]: any;
-    }, options?: PosthogCaptureOptions): this;
+    }, options?: PostHogCaptureOptions): this;
     /***
      *** GROUPS
      ***/
-    protected groupIdentifyStateless(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties, options?: PosthogCaptureOptions, distinctId?: string, eventProperties?: PostHogEventProperties): this;
+    protected groupIdentifyStateless(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties, options?: PostHogCaptureOptions, distinctId?: string, eventProperties?: PostHogEventProperties): this;
     /***
      *** FEATURE FLAGS
      ***/
@@ -161,7 +167,7 @@ declare abstract class PostHogCoreStateless {
     /***
      *** QUEUEING AND FLUSHING
      ***/
-    protected enqueue(type: string, _message: any, options?: PosthogCaptureOptions): void;
+    protected enqueue(type: string, _message: any, options?: PostHogCaptureOptions): void;
     flushAsync(): Promise<any>;
     flush(callback?: (err?: any, data?: any) => void): void;
     private fetchWithRetry;
@@ -173,6 +179,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,38 +189,52 @@ 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
      ***/
-    identify(distinctId?: string, properties?: PostHogEventProperties, options?: PosthogCaptureOptions): this;
+    identify(distinctId?: string, properties?: PostHogEventProperties, options?: PostHogCaptureOptions): this;
     capture(event: string, properties?: {
         [key: string]: any;
-    }, options?: PosthogCaptureOptions): this;
+    }, options?: PostHogCaptureOptions): this;
     alias(alias: string): this;
-    autocapture(eventType: string, elements: PostHogAutocaptureElement[], properties?: PostHogEventProperties, options?: PosthogCaptureOptions): this;
+    autocapture(eventType: string, elements: PostHogAutocaptureElement[], properties?: PostHogEventProperties, options?: PostHogCaptureOptions): this;
     /***
      *** GROUPS
      ***/
     groups(groups: {
         [type: string]: string | number;
     }): this;
-    group(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties, options?: PosthogCaptureOptions): this;
-    groupIdentify(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties, options?: PosthogCaptureOptions): this;
+    group(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties, options?: PostHogCaptureOptions): this;
+    groupIdentify(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties, options?: PostHogCaptureOptions): this;
     /***
      * 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;
@@ -726,8 +731,8 @@ var PostHogCoreStateless = /** @class */ (function () {
     function PostHogCoreStateless(apiKey, options) {
         var _a, _b, _c, _d, _e;
         this.debugMode = false;
-        this.pendingPromises = {};
         this.disableGeoip = true;
+        this.pendingPromises = {};
         // internal
         this._events = new SimpleEventEmitter();
         assert(apiKey, "You must pass your PostHog project's api key.");
@@ -785,6 +790,14 @@ var PostHogCoreStateless = /** @class */ (function () {
             properties: __assign(__assign({}, (payload.properties || {})), this.getCommonEventProperties()),
         };
     };
+    PostHogCoreStateless.prototype.addPendingPromise = function (promise) {
+        var _this = this;
+        var promiseUUID = generateUUID();
+        this.pendingPromises[promiseUUID] = promise;
+        promise.finally(function () {
+            delete _this.pendingPromises[promiseUUID];
+        });
+    };
     /***
      *** TRACKING
      ***/
@@ -835,6 +848,7 @@ var PostHogCoreStateless = /** @class */ (function () {
         if (extraPayload === void 0) { extraPayload = {}; }
         return __awaiter(this, void 0, void 0, function () {
             var url, fetchOptions;
+            var _this = this;
             return __generator(this, function (_a) {
                 url = "".concat(this.host, "/decide/?v=3");
                 fetchOptions = {
@@ -845,7 +859,7 @@ var PostHogCoreStateless = /** @class */ (function () {
                 return [2 /*return*/, this.fetchWithRetry(url, fetchOptions)
                         .then(function (response) { return response.json(); })
                         .catch(function (error) {
-                        console.error('Error fetching feature flags', error);
+                        _this._events.emit('error', error);
                         return undefined;
                     })];
             });
@@ -979,10 +993,10 @@ var PostHogCoreStateless = /** @class */ (function () {
         var _this = this;
         var _a;
         if (this.optedOut) {
-            this._events.emit(type, "Library is disabled. Not sending event. To re-enable, call posthog.enable()");
+            this._events.emit(type, "Library is disabled. Not sending event. To re-enable, call posthog.optIn()");
             return;
         }
-        var message = __assign(__assign({}, _message), { type: type, library: this.getLibraryId(), library_version: this.getLibraryVersion(), timestamp: (options === null || options === void 0 ? void 0 : options.timestamp) ? options === null || options === void 0 ? void 0 : options.timestamp : currentISOTime() });
+        var message = __assign(__assign({}, _message), { type: type, library: this.getLibraryId(), library_version: this.getLibraryVersion(), timestamp: (options === null || options === void 0 ? void 0 : options.timestamp) ? options === null || options === void 0 ? void 0 : options.timestamp : currentISOTime(), uuid: (options === null || options === void 0 ? void 0 : options.uuid) ? options.uuid : generateUUID(globalThis) });
         var addGeoipDisableProperty = (_a = options === null || options === void 0 ? void 0 : options.disableGeoip) !== null && _a !== void 0 ? _a : this.disableGeoip;
         if (addGeoipDisableProperty) {
             if (!message.properties) {
@@ -1032,14 +1046,11 @@ var PostHogCoreStateless = /** @class */ (function () {
             batch: messages,
             sent_at: currentISOTime(),
         };
-        var promiseUUID = generateUUID();
         var done = function (err) {
             if (err) {
                 _this._events.emit('error', err);
             }
             callback === null || callback === void 0 ? void 0 : callback(err, messages);
-            // remove promise from pendingPromises
-            delete _this.pendingPromises[promiseUUID];
             _this._events.emit('flush', messages);
         };
         // Don't set the user agent if we're not on a browser. The latest spec allows
@@ -1065,12 +1076,11 @@ var PostHogCoreStateless = /** @class */ (function () {
                 body: payload,
             };
         var requestPromise = this.fetchWithRetry(url, fetchOptions);
-        this.pendingPromises[promiseUUID] = requestPromise;
-        requestPromise
+        this.addPendingPromise(requestPromise
             .then(function () { return done(); })
             .catch(function (err) {
             done(err);
-        });
+        }));
     };
     PostHogCoreStateless.prototype.fetchWithRetry = function (url, options, retryOptions) {
         var _a;
@@ -1124,7 +1134,7 @@ var PostHogCoreStateless = /** @class */ (function () {
                         clearTimeout(this._flushTimer);
                         _a.label = 1;
                     case 1:
-                        _a.trys.push([1, 4, , 5]);
+                        _a.trys.push([1, 5, , 6]);
                         return [4 /*yield*/, this.flushAsync()];
                     case 2:
                         _a.sent();
@@ -1132,18 +1142,31 @@ var PostHogCoreStateless = /** @class */ (function () {
                                 return x.catch(function () {
                                     // ignore errors as we are shutting down and can't deal with them anyways.
                                 });
-                            }))];
+                            }))
+                            // flush again to make sure we send all events, some of which might've been added
+                            // while we were waiting for the pending promises to resolve
+                            // For example, see sendFeatureFlags in posthog-node/src/posthog-node.ts::capture
+                        ];
                     case 3:
                         _a.sent();
-                        return [3 /*break*/, 5];
+                        // flush again to make sure we send all events, some of which might've been added
+                        // while we were waiting for the pending promises to resolve
+                        // For example, see sendFeatureFlags in posthog-node/src/posthog-node.ts::capture
+                        return [4 /*yield*/, this.flushAsync()];
                     case 4:
+                        // flush again to make sure we send all events, some of which might've been added
+                        // while we were waiting for the pending promises to resolve
+                        // For example, see sendFeatureFlags in posthog-node/src/posthog-node.ts::capture
+                        _a.sent();
+                        return [3 /*break*/, 6];
+                    case 5:
                         e_2 = _a.sent();
                         if (!isPostHogFetchError(e_2)) {
                             throw e_2;
                         }
                         console.error('Error while shutting down PostHog', e_2);
-                        return [3 /*break*/, 5];
-                    case 5: return [2 /*return*/];
+                        return [3 /*break*/, 6];
+                    case 6: return [2 /*return*/];
                 }
             });
         });
@@ -1162,6 +1185,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 +1227,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 +1255,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 +1281,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 +1373,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 +1398,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 +1596,7 @@ var PostHogCore = /** @class */ (function (_super) {
     return PostHogCore;
 }(PostHogCoreStateless));
 
-var version = "2.4.0";
+var version = "2.6.0";
 
 function getContext(window) {
   var context = {};