posthog-js-lite 2.0.0 → 2.1.0

package/lib/index.d.ts

@@ -9,6 +9,7 @@ declare type PosthogCoreOptions = {
         distinctId?: string;
         isIdentifiedId?: boolean;
         featureFlags?: Record<string, boolean | string>;
+        featureFlagPayloads?: Record<string, JsonType>;
     };
     fetchRetryCount?: number;
     fetchRetryDelay?: number;
@@ -21,6 +22,7 @@ declare enum PostHogPersistedProperty {
     DistinctId = "distinct_id",
     Props = "props",
     FeatureFlags = "feature_flags",
+    FeatureFlagPayloads = "feature_flag_payloads",
     OverrideFeatureFlags = "override_feature_flags",
     Queue = "queue",
     OptedOut = "opted_out",
@@ -70,8 +72,15 @@ declare type PostHogDecideResponse = {
     featureFlags: {
         [key: string]: string | boolean;
     };
+    featureFlagPayloads: {
+        [key: string]: JsonType;
+    };
+    errorsWhileComputingFlags: boolean;
     sessionRecording: boolean;
-};
+};
+declare type JsonType = string | number | boolean | null | {
+    [key: string]: JsonType;
+} | Array<JsonType>;
 
 interface RetriableOptions {
     retryCount?: number;
@@ -164,8 +173,16 @@ declare abstract class PostHogCore {
     private decideAsync;
     private _decideAsync;
     private setKnownFeatureFlags;
+    private setKnownFeatureFlagPayloads;
     getFeatureFlag(key: string): boolean | string | undefined;
+    getFeatureFlagPayload(key: string): JsonType | undefined;
+    getFeatureFlagPayloads(): PostHogDecideResponse['featureFlagPayloads'] | undefined;
+    _parsePayload(response: any): any;
     getFeatureFlags(): PostHogDecideResponse['featureFlags'] | undefined;
+    getFeatureFlagsAndPayloads(): {
+        flags: PostHogDecideResponse['featureFlags'] | undefined;
+        payloads: PostHogDecideResponse['featureFlagPayloads'] | undefined;
+    };
     isFeatureEnabled(key: string): boolean | undefined;
     reloadFeatureFlagsAsync(sendAnonDistinctId?: boolean): Promise<PostHogDecideResponse['featureFlags']>;
     onFeatureFlags(cb: (flags: PostHogDecideResponse['featureFlags']) => void): () => void;

package/lib/index.esm.js

@@ -146,6 +146,7 @@ var PostHogPersistedProperty;
     PostHogPersistedProperty["DistinctId"] = "distinct_id";
     PostHogPersistedProperty["Props"] = "props";
     PostHogPersistedProperty["FeatureFlags"] = "feature_flags";
+    PostHogPersistedProperty["FeatureFlagPayloads"] = "feature_flag_payloads";
     PostHogPersistedProperty["OverrideFeatureFlags"] = "override_feature_flags";
     PostHogPersistedProperty["Queue"] = "queue";
     PostHogPersistedProperty["OptedOut"] = "opted_out";
@@ -754,6 +755,7 @@ var PostHogCore = /** @class */ (function () {
                 return ((res[key] = ((_b = (_a = options.bootstrap) === null || _a === void 0 ? void 0 : _a.featureFlags) === null || _b === void 0 ? void 0 : _b[key]) || false), res);
             }, {});
             this.setKnownFeatureFlags(activeFlags);
+            (options === null || options === void 0 ? void 0 : options.bootstrap.featureFlagPayloads) && this.setKnownFeatureFlagPayloads(options === null || options === void 0 ? void 0 : options.bootstrap.featureFlagPayloads);
         }
     };
     Object.defineProperty(PostHogCore.prototype, "props", {
@@ -933,11 +935,10 @@ var PostHogCore = /** @class */ (function () {
         return this;
     };
     PostHogCore.prototype.groupIdentify = function (groupType, groupKey, groupProperties) {
-        var payload = {
+        var payload = this.buildPayload({
             event: '$groupidentify',
-            distinctId: "$".concat(groupType, "_").concat(groupKey),
             properties: __assign({ $group_type: groupType, $group_key: groupKey, $group_set: groupProperties || {} }, this.getCommonEventProperties()),
-        };
+        });
         this.enqueue('capture', payload);
         return this;
     };
@@ -978,7 +979,7 @@ var PostHogCore = /** @class */ (function () {
             var url, distinctId, groups, personProperties, groupProperties, fetchOptions;
             var _this = this;
             return __generator(this, function (_a) {
-                url = "".concat(this.host, "/decide/?v=2");
+                url = "".concat(this.host, "/decide/?v=3");
                 distinctId = this.getDistinctId();
                 groups = this.props.$groups || {};
                 personProperties = this.getPersistedProperty(PostHogPersistedProperty.PersonProperties) || {};
@@ -999,7 +1000,17 @@ var PostHogCore = /** @class */ (function () {
                     .then(function (r) { return r.json(); })
                     .then(function (res) {
                     if (res.featureFlags) {
-                        _this.setKnownFeatureFlags(res.featureFlags);
+                        var newFeatureFlags = res.featureFlags;
+                        var newFeatureFlagPayloads = res.featureFlagPayloads;
+                        if (res.errorsWhileComputingFlags) {
+                            // if not all flags were computed, we upsert flags instead of replacing them
+                            var currentFlags = _this.getPersistedProperty(PostHogPersistedProperty.FeatureFlags);
+                            var currentFlagPayloads = _this.getPersistedProperty(PostHogPersistedProperty.FeatureFlagPayloads);
+                            newFeatureFlags = __assign(__assign({}, currentFlags), res.featureFlags);
+                            newFeatureFlagPayloads = __assign(__assign({}, currentFlagPayloads), res.featureFlagPayloads);
+                        }
+                        _this.setKnownFeatureFlags(newFeatureFlags);
+                        _this.setKnownFeatureFlagPayloads(newFeatureFlagPayloads);
                     }
                     return res;
                 })
@@ -1014,6 +1025,9 @@ var PostHogCore = /** @class */ (function () {
         this.setPersistedProperty(PostHogPersistedProperty.FeatureFlags, featureFlags);
         this._events.emit('featureflags', featureFlags);
     };
+    PostHogCore.prototype.setKnownFeatureFlagPayloads = function (featureFlagPayloads) {
+        this.setPersistedProperty(PostHogPersistedProperty.FeatureFlagPayloads, featureFlagPayloads);
+    };
     PostHogCore.prototype.getFeatureFlag = function (key) {
         var featureFlags = this.getFeatureFlags();
         if (!featureFlags) {
@@ -1021,8 +1035,9 @@ var PostHogCore = /** @class */ (function () {
             return undefined;
         }
         var response = featureFlags[key];
+        // `/decide` v3 returns all flags
         if (response === undefined) {
-            // `/decide` returns nothing for flags which are false.
+            // For cases where the flag is unknown, return false
             response = false;
         }
         if (this.sendFeatureFlagEvent && !this.flagCallReported[key]) {
@@ -1035,6 +1050,37 @@ var PostHogCore = /** @class */ (function () {
         // If we have flags we either return the value (true or string) or false
         return response;
     };
+    PostHogCore.prototype.getFeatureFlagPayload = function (key) {
+        var payloads = this.getFeatureFlagPayloads();
+        if (!payloads) {
+            return undefined;
+        }
+        var response = payloads[key];
+        // Undefined means a loading or missing data issue. Null means evaluation happened and there was no match
+        if (response === undefined) {
+            return null;
+        }
+        return this._parsePayload(response);
+    };
+    PostHogCore.prototype.getFeatureFlagPayloads = function () {
+        var _this = this;
+        var payloads = this.getPersistedProperty(PostHogPersistedProperty.FeatureFlagPayloads);
+        if (payloads) {
+            return Object.fromEntries(Object.entries(payloads).map(function (_a) {
+                var k = _a[0], v = _a[1];
+                return [k, _this._parsePayload(v)];
+            }));
+        }
+        return payloads;
+    };
+    PostHogCore.prototype._parsePayload = function (response) {
+        try {
+            return JSON.parse(response);
+        }
+        catch (_a) {
+            return response;
+        }
+    };
     PostHogCore.prototype.getFeatureFlags = function () {
         var flags = this.getPersistedProperty(PostHogPersistedProperty.FeatureFlags);
         var overriddenFlags = this.getPersistedProperty(PostHogPersistedProperty.OverrideFeatureFlags);
@@ -1052,6 +1098,14 @@ var PostHogCore = /** @class */ (function () {
         }
         return flags;
     };
+    PostHogCore.prototype.getFeatureFlagsAndPayloads = function () {
+        var flags = this.getFeatureFlags();
+        var payloads = this.getFeatureFlagPayloads();
+        return {
+            flags: flags,
+            payloads: payloads,
+        };
+    };
     PostHogCore.prototype.isFeatureEnabled = function (key) {
         var response = this.getFeatureFlag(key);
         if (response === undefined) {
@@ -1237,7 +1291,7 @@ var PostHogCore = /** @class */ (function () {
     return PostHogCore;
 }());
 
-var version = "2.0.0";
+var version = "2.1.0";
 
 function getContext(window) {
   var context = {};