posthog-js 1.76.0 → 1.77.1

package/lib/src/posthog-persistence.js

@@ -0,0 +1,256 @@
+/* eslint camelcase: "off" */
+import { _each, _extend, _include, _info, _isObject, _isUndefined, _strip_empty_properties, logger } from './utils';
+import { cookieStore, localStore, localPlusCookieStore, memoryStore, sessionStore } from './storage';
+import { PERSISTENCE_RESERVED_PROPERTIES, EVENT_TIMERS_KEY, ENABLED_FEATURE_FLAGS, POSTHOG_QUOTA_LIMITED, USER_STATE, } from './constants';
+var CASE_INSENSITIVE_PERSISTENCE_TYPES = [
+    'cookie',
+    'localstorage',
+    'localstorage+cookie',
+    'sessionstorage',
+    'memory',
+];
+/**
+ * PostHog Persistence Object
+ * @constructor
+ */
+var PostHogPersistence = /** @class */ (function () {
+    function PostHogPersistence(config) {
+        // clean chars that aren't accepted by the http spec for cookie values
+        // https://datatracker.ietf.org/doc/html/rfc2616#section-2.2
+        var token = '';
+        if (config['token']) {
+            token = config['token'].replace(/\+/g, 'PL').replace(/\//g, 'SL').replace(/=/g, 'EQ');
+        }
+        this.props = {};
+        this.campaign_params_saved = false;
+        this.custom_campaign_params = config['custom_campaign_params'] || [];
+        if (config['persistence_name']) {
+            this.name = 'ph_' + config['persistence_name'];
+        }
+        else {
+            this.name = 'ph_' + token + '_posthog';
+        }
+        if (CASE_INSENSITIVE_PERSISTENCE_TYPES.indexOf(config['persistence'].toLowerCase()) === -1) {
+            logger.critical('Unknown persistence type ' + config['persistence'] + '; falling back to cookie');
+            config['persistence'] = 'cookie';
+        }
+        // We handle storage type in a case-insensitive way for backwards compatibility
+        var storage_type = config['persistence'].toLowerCase();
+        if (storage_type === 'localstorage' && localStore.is_supported()) {
+            this.storage = localStore;
+        }
+        else if (storage_type === 'localstorage+cookie' && localPlusCookieStore.is_supported()) {
+            this.storage = localPlusCookieStore;
+        }
+        else if (storage_type === 'sessionstorage' && sessionStore.is_supported()) {
+            this.storage = sessionStore;
+        }
+        else if (storage_type === 'memory') {
+            this.storage = memoryStore;
+        }
+        else {
+            this.storage = cookieStore;
+        }
+        this.user_state = 'anonymous';
+        this.load();
+        this.update_config(config);
+        this.save();
+    }
+    PostHogPersistence.prototype.properties = function () {
+        var p = {};
+        // Filter out reserved properties
+        _each(this.props, function (v, k) {
+            if (k === ENABLED_FEATURE_FLAGS && typeof v === 'object') {
+                var keys = Object.keys(v);
+                for (var i = 0; i < keys.length; i++) {
+                    p["$feature/".concat(keys[i])] = v[keys[i]];
+                }
+            }
+            else if (!_include(PERSISTENCE_RESERVED_PROPERTIES, k)) {
+                p[k] = v;
+            }
+        });
+        return p;
+    };
+    PostHogPersistence.prototype.load = function () {
+        if (this.disabled) {
+            return;
+        }
+        var entry = this.storage.parse(this.name);
+        if (entry) {
+            this.props = _extend({}, entry);
+        }
+    };
+    /**
+     * NOTE: Saving frequently causes issues with Recordings and Consent Management Platform (CMP) tools which
+     * observe cookie changes, and modify their UI, often causing infinite loops.
+     * As such callers of this should ideally check that the data has changed beforehand
+     */
+    PostHogPersistence.prototype.save = function () {
+        if (this.disabled) {
+            return;
+        }
+        this.storage.set(this.name, this.props, this.expire_days, this.cross_subdomain, this.secure);
+    };
+    PostHogPersistence.prototype.remove = function () {
+        // remove both domain and subdomain cookies
+        this.storage.remove(this.name, false);
+        this.storage.remove(this.name, true);
+    };
+    // removes the storage entry and deletes all loaded data
+    // forced name for tests
+    PostHogPersistence.prototype.clear = function () {
+        this.remove();
+        this.props = {};
+    };
+    /**
+     * @param {Object} props
+     * @param {*=} default_value
+     * @param {number=} days
+     */
+    PostHogPersistence.prototype.register_once = function (props, default_value, days) {
+        var _this = this;
+        if (_isObject(props)) {
+            if (typeof default_value === 'undefined') {
+                default_value = 'None';
+            }
+            this.expire_days = typeof days === 'undefined' ? this.default_expiry : days;
+            var hasChanges_1 = false;
+            _each(props, function (val, prop) {
+                if (!_this.props.hasOwnProperty(prop) || _this.props[prop] === default_value) {
+                    _this.props[prop] = val;
+                    hasChanges_1 = true;
+                }
+            });
+            if (hasChanges_1) {
+                this.save();
+                return true;
+            }
+        }
+        return false;
+    };
+    /**
+     * @param {Object} props
+     * @param {number=} days
+     */
+    PostHogPersistence.prototype.register = function (props, days) {
+        var _this = this;
+        if (_isObject(props)) {
+            this.expire_days = typeof days === 'undefined' ? this.default_expiry : days;
+            var hasChanges_2 = false;
+            _each(props, function (val, prop) {
+                if (props.hasOwnProperty(prop) && _this.props[prop] !== val) {
+                    _this.props[prop] = val;
+                    hasChanges_2 = true;
+                }
+            });
+            if (hasChanges_2) {
+                this.save();
+                return true;
+            }
+        }
+        return false;
+    };
+    PostHogPersistence.prototype.unregister = function (prop) {
+        if (prop in this.props) {
+            delete this.props[prop];
+            this.save();
+        }
+    };
+    PostHogPersistence.prototype.update_campaign_params = function () {
+        if (!this.campaign_params_saved) {
+            this.register(_info.campaignParams(this.custom_campaign_params));
+            this.campaign_params_saved = true;
+        }
+    };
+    PostHogPersistence.prototype.update_search_keyword = function () {
+        this.register(_info.searchInfo());
+    };
+    PostHogPersistence.prototype.update_referrer_info = function () {
+        this.register({
+            $referrer: this.props['$referrer'] || _info.referrer(),
+            $referring_domain: this.props['$referring_domain'] || _info.referringDomain(),
+        });
+    };
+    PostHogPersistence.prototype.get_referrer_info = function () {
+        return _strip_empty_properties({
+            $referrer: this['props']['$referrer'],
+            $referring_domain: this['props']['$referring_domain'],
+        });
+    };
+    // safely fills the passed in object with stored properties,
+    // does not override any properties defined in both
+    // returns the passed in object
+    PostHogPersistence.prototype.safe_merge = function (props) {
+        _each(this.props, function (val, prop) {
+            if (!(prop in props)) {
+                props[prop] = val;
+            }
+        });
+        return props;
+    };
+    PostHogPersistence.prototype.update_config = function (config) {
+        this.default_expiry = this.expire_days = config['cookie_expiration'];
+        this.set_disabled(config['disable_persistence']);
+        this.set_cross_subdomain(config['cross_subdomain_cookie']);
+        this.set_secure(config['secure_cookie']);
+    };
+    PostHogPersistence.prototype.set_disabled = function (disabled) {
+        this.disabled = disabled;
+        if (this.disabled) {
+            this.remove();
+        }
+        else {
+            this.save();
+        }
+    };
+    PostHogPersistence.prototype.set_cross_subdomain = function (cross_subdomain) {
+        if (cross_subdomain !== this.cross_subdomain) {
+            this.cross_subdomain = cross_subdomain;
+            this.remove();
+            this.save();
+        }
+    };
+    PostHogPersistence.prototype.get_cross_subdomain = function () {
+        return !!this.cross_subdomain;
+    };
+    PostHogPersistence.prototype.set_secure = function (secure) {
+        if (secure !== this.secure) {
+            this.secure = secure;
+            this.remove();
+            this.save();
+        }
+    };
+    PostHogPersistence.prototype.set_event_timer = function (event_name, timestamp) {
+        var timers = this.props[EVENT_TIMERS_KEY] || {};
+        timers[event_name] = timestamp;
+        this.props[EVENT_TIMERS_KEY] = timers;
+        this.save();
+    };
+    PostHogPersistence.prototype.remove_event_timer = function (event_name) {
+        var timers = this.props[EVENT_TIMERS_KEY] || {};
+        var timestamp = timers[event_name];
+        if (!_isUndefined(timestamp)) {
+            delete this.props[EVENT_TIMERS_KEY][event_name];
+            this.save();
+        }
+        return timestamp;
+    };
+    PostHogPersistence.prototype.get_user_state = function () {
+        return this.props[USER_STATE] || 'anonymous';
+    };
+    PostHogPersistence.prototype.set_user_state = function (state) {
+        this.props[USER_STATE] = state;
+        this.save();
+    };
+    PostHogPersistence.prototype.get_quota_limits = function () {
+        return this.props[POSTHOG_QUOTA_LIMITED] || {};
+    };
+    PostHogPersistence.prototype.set_quota_limits = function (state) {
+        this.props[POSTHOG_QUOTA_LIMITED] = state;
+        this.save();
+    };
+    return PostHogPersistence;
+}());
+export { PostHogPersistence };
+//# sourceMappingURL=posthog-persistence.js.map

package/lib/src/posthog-persistence.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"posthog-persistence.js","sourceRoot":"","sources":["../../src/posthog-persistence.ts"],"names":[],"mappings":"AAAA,6BAA6B;AAE7B,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,uBAAuB,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AACnH,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,oBAAoB,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAEpG,OAAO,EACH,+BAA+B,EAC/B,gBAAgB,EAChB,qBAAqB,EACrB,qBAAqB,EACrB,UAAU,GACb,MAAM,aAAa,CAAA;AAEpB,IAAM,kCAAkC,GAAuD;IAC3F,QAAQ;IACR,cAAc;IACd,qBAAqB;IACrB,gBAAgB;IAChB,QAAQ;CACX,CAAA;AAED;;;GAGG;AACH;IAaI,4BAAY,MAAqB;QAC7B,sEAAsE;QACtE,4DAA4D;QAC5D,IAAI,KAAK,GAAG,EAAE,CAAA;QAEd,IAAI,MAAM,CAAC,OAAO,CAAC,EAAE;YACjB,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;SACxF;QAED,IAAI,CAAC,KAAK,GAAG,EAAE,CAAA;QACf,IAAI,CAAC,qBAAqB,GAAG,KAAK,CAAA;QAClC,IAAI,CAAC,sBAAsB,GAAG,MAAM,CAAC,wBAAwB,CAAC,IAAI,EAAE,CAAA;QAEpE,IAAI,MAAM,CAAC,kBAAkB,CAAC,EAAE;YAC5B,IAAI,CAAC,IAAI,GAAG,KAAK,GAAG,MAAM,CAAC,kBAAkB,CAAC,CAAA;SACjD;aAAM;YACH,IAAI,CAAC,IAAI,GAAG,KAAK,GAAG,KAAK,GAAG,UAAU,CAAA;SACzC;QAED,IACI,kCAAkC,CAAC,OAAO,CACtC,MAAM,CAAC,aAAa,CAAC,CAAC,WAAW,EAA6C,CACjF,KAAK,CAAC,CAAC,EACV;YACE,MAAM,CAAC,QAAQ,CAAC,2BAA2B,GAAG,MAAM,CAAC,aAAa,CAAC,GAAG,0BAA0B,CAAC,CAAA;YACjG,MAAM,CAAC,aAAa,CAAC,GAAG,QAAQ,CAAA;SACnC;QACD,+EAA+E;QAC/E,IAAM,YAAY,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC,WAAW,EAA6C,CAAA;QACnG,IAAI,YAAY,KAAK,cAAc,IAAI,UAAU,CAAC,YAAY,EAAE,EAAE;YAC9D,IAAI,CAAC,OAAO,GAAG,UAAU,CAAA;SAC5B;aAAM,IAAI,YAAY,KAAK,qBAAqB,IAAI,oBAAoB,CAAC,YAAY,EAAE,EAAE;YACtF,IAAI,CAAC,OAAO,GAAG,oBAAoB,CAAA;SACtC;aAAM,IAAI,YAAY,KAAK,gBAAgB,IAAI,YAAY,CAAC,YAAY,EAAE,EAAE;YACzE,IAAI,CAAC,OAAO,GAAG,YAAY,CAAA;SAC9B;aAAM,IAAI,YAAY,KAAK,QAAQ,EAAE;YAClC,IAAI,CAAC,OAAO,GAAG,WAAW,CAAA;SAC7B;aAAM;YACH,IAAI,CAAC,OAAO,GAAG,WAAW,CAAA;SAC7B;QAED,IAAI,CAAC,UAAU,GAAG,WAAW,CAAA;QAE7B,IAAI,CAAC,IAAI,EAAE,CAAA;QACX,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAA;QAC1B,IAAI,CAAC,IAAI,EAAE,CAAA;IACf,CAAC;IAED,uCAAU,GAAV;QACI,IAAM,CAAC,GAAe,EAAE,CAAA;QACxB,iCAAiC;QACjC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,EAAE,CAAC;YAC5B,IAAI,CAAC,KAAK,qBAAqB,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE;gBACtD,IAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;gBAC3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;oBAClC,CAAC,CAAC,mBAAY,IAAI,CAAC,CAAC,CAAC,CAAE,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;iBACxC;aACJ;iBAAM,IAAI,CAAC,QAAQ,CAAC,+BAA+B,EAAE,CAAC,CAAC,EAAE;gBACtD,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;aACX;QACL,CAAC,CAAC,CAAA;QACF,OAAO,CAAC,CAAA;IACZ,CAAC;IAED,iCAAI,GAAJ;QACI,IAAI,IAAI,CAAC,QAAQ,EAAE;YACf,OAAM;SACT;QAED,IAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAE3C,IAAI,KAAK,EAAE;YACP,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,CAAA;SAClC;IACL,CAAC;IAED;;;;OAIG;IACH,iCAAI,GAAJ;QACI,IAAI,IAAI,CAAC,QAAQ,EAAE;YACf,OAAM;SACT;QACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;IAChG,CAAC;IAED,mCAAM,GAAN;QACI,2CAA2C;QAC3C,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;QACrC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IACxC,CAAC;IAED,wDAAwD;IACxD,wBAAwB;IAExB,kCAAK,GAAL;QACI,IAAI,CAAC,MAAM,EAAE,CAAA;QACb,IAAI,CAAC,KAAK,GAAG,EAAE,CAAA;IACnB,CAAC;IAED;;;;OAIG;IAEH,0CAAa,GAAb,UAAc,KAAiB,EAAE,aAAkB,EAAE,IAAa;QAAlE,iBAsBC;QArBG,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE;YAClB,IAAI,OAAO,aAAa,KAAK,WAAW,EAAE;gBACtC,aAAa,GAAG,MAAM,CAAA;aACzB;YACD,IAAI,CAAC,WAAW,GAAG,OAAO,IAAI,KAAK,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAA;YAE3E,IAAI,YAAU,GAAG,KAAK,CAAA;YAEtB,KAAK,CAAC,KAAK,EAAE,UAAC,GAAG,EAAE,IAAI;gBACnB,IAAI,CAAC,KAAI,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,KAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,aAAa,EAAE;oBACxE,KAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,GAAG,CAAA;oBACtB,YAAU,GAAG,IAAI,CAAA;iBACpB;YACL,CAAC,CAAC,CAAA;YAEF,IAAI,YAAU,EAAE;gBACZ,IAAI,CAAC,IAAI,EAAE,CAAA;gBACX,OAAO,IAAI,CAAA;aACd;SACJ;QACD,OAAO,KAAK,CAAA;IAChB,CAAC;IAED;;;OAGG;IAEH,qCAAQ,GAAR,UAAS,KAAiB,EAAE,IAAa;QAAzC,iBAmBC;QAlBG,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE;YAClB,IAAI,CAAC,WAAW,GAAG,OAAO,IAAI,KAAK,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAA;YAE3E,IAAI,YAAU,GAAG,KAAK,CAAA;YAEtB,KAAK,CAAC,KAAK,EAAE,UAAC,GAAG,EAAE,IAAI;gBACnB,IAAI,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,KAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE;oBACxD,KAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,GAAG,CAAA;oBACtB,YAAU,GAAG,IAAI,CAAA;iBACpB;YACL,CAAC,CAAC,CAAA;YAEF,IAAI,YAAU,EAAE;gBACZ,IAAI,CAAC,IAAI,EAAE,CAAA;gBACX,OAAO,IAAI,CAAA;aACd;SACJ;QACD,OAAO,KAAK,CAAA;IAChB,CAAC;IAED,uCAAU,GAAV,UAAW,IAAY;QACnB,IAAI,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE;YACpB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YACvB,IAAI,CAAC,IAAI,EAAE,CAAA;SACd;IACL,CAAC;IAED,mDAAsB,GAAtB;QACI,IAAI,CAAC,IAAI,CAAC,qBAAqB,EAAE;YAC7B,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAA;YAChE,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAA;SACpC;IACL,CAAC;IAED,kDAAqB,GAArB;QACI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC,CAAA;IACrC,CAAC;IAED,iDAAoB,GAApB;QACI,IAAI,CAAC,QAAQ,CAAC;YACV,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,KAAK,CAAC,QAAQ,EAAE;YACtD,iBAAiB,EAAE,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,IAAI,KAAK,CAAC,eAAe,EAAE;SAChF,CAAC,CAAA;IACN,CAAC;IAED,8CAAiB,GAAjB;QACI,OAAO,uBAAuB,CAAC;YAC3B,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,WAAW,CAAC;YACrC,iBAAiB,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,mBAAmB,CAAC;SACxD,CAAC,CAAA;IACN,CAAC;IAED,4DAA4D;IAC5D,mDAAmD;IACnD,+BAA+B;IAE/B,uCAAU,GAAV,UAAW,KAAiB;QACxB,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,UAAU,GAAG,EAAE,IAAI;YACjC,IAAI,CAAC,CAAC,IAAI,IAAI,KAAK,CAAC,EAAE;gBAClB,KAAK,CAAC,IAAI,CAAC,GAAG,GAAG,CAAA;aACpB;QACL,CAAC,CAAC,CAAA;QAEF,OAAO,KAAK,CAAA;IAChB,CAAC;IAED,0CAAa,GAAb,UAAc,MAAqB;QAC/B,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,mBAAmB,CAAC,CAAA;QACpE,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC,CAAA;QAChD,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,wBAAwB,CAAC,CAAC,CAAA;QAC1D,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAA;IAC5C,CAAC;IAED,yCAAY,GAAZ,UAAa,QAAiB;QAC1B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QACxB,IAAI,IAAI,CAAC,QAAQ,EAAE;YACf,IAAI,CAAC,MAAM,EAAE,CAAA;SAChB;aAAM;YACH,IAAI,CAAC,IAAI,EAAE,CAAA;SACd;IACL,CAAC;IAED,gDAAmB,GAAnB,UAAoB,eAAwB;QACxC,IAAI,eAAe,KAAK,IAAI,CAAC,eAAe,EAAE;YAC1C,IAAI,CAAC,eAAe,GAAG,eAAe,CAAA;YACtC,IAAI,CAAC,MAAM,EAAE,CAAA;YACb,IAAI,CAAC,IAAI,EAAE,CAAA;SACd;IACL,CAAC;IAED,gDAAmB,GAAnB;QACI,OAAO,CAAC,CAAC,IAAI,CAAC,eAAe,CAAA;IACjC,CAAC;IAED,uCAAU,GAAV,UAAW,MAAe;QACtB,IAAI,MAAM,KAAK,IAAI,CAAC,MAAM,EAAE;YACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;YACpB,IAAI,CAAC,MAAM,EAAE,CAAA;YACb,IAAI,CAAC,IAAI,EAAE,CAAA;SACd;IACL,CAAC;IAED,4CAAe,GAAf,UAAgB,UAAkB,EAAE,SAAiB;QACjD,IAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAA;QACjD,MAAM,CAAC,UAAU,CAAC,GAAG,SAAS,CAAA;QAC9B,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,GAAG,MAAM,CAAA;QACrC,IAAI,CAAC,IAAI,EAAE,CAAA;IACf,CAAC;IAED,+CAAkB,GAAlB,UAAmB,UAAkB;QACjC,IAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAA;QACjD,IAAM,SAAS,GAAG,MAAM,CAAC,UAAU,CAAC,CAAA;QACpC,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,UAAU,CAAC,CAAA;YAC/C,IAAI,CAAC,IAAI,EAAE,CAAA;SACd;QACD,OAAO,SAAS,CAAA;IACpB,CAAC;IAED,2CAAc,GAAd;QACI,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,WAAW,CAAA;IAChD,CAAC;IAED,2CAAc,GAAd,UAAe,KAAiC;QAC5C,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,KAAK,CAAA;QAC9B,IAAI,CAAC,IAAI,EAAE,CAAA;IACf,CAAC;IAED,6CAAgB,GAAhB;QACI,OAAO,IAAI,CAAC,KAAK,CAAC,qBAAqB,CAAC,IAAI,EAAE,CAAA;IAClD,CAAC;IAED,6CAAgB,GAAhB,UAAiB,KAA6B;QAC1C,IAAI,CAAC,KAAK,CAAC,qBAAqB,CAAC,GAAG,KAAK,CAAA;QACzC,IAAI,CAAC,IAAI,EAAE,CAAA;IACf,CAAC;IACL,yBAAC;AAAD,CAAC,AA/RD,IA+RC","sourcesContent":["/* eslint camelcase: \"off\" */\n\nimport { _each, _extend, _include, _info, _isObject, _isUndefined, _strip_empty_properties, logger } from './utils'\nimport { cookieStore, localStore, localPlusCookieStore, memoryStore, sessionStore } from './storage'\nimport { PersistentStore, PostHogConfig, Properties } from './types'\nimport {\n    PERSISTENCE_RESERVED_PROPERTIES,\n    EVENT_TIMERS_KEY,\n    ENABLED_FEATURE_FLAGS,\n    POSTHOG_QUOTA_LIMITED,\n    USER_STATE,\n} from './constants'\n\nconst CASE_INSENSITIVE_PERSISTENCE_TYPES: readonly Lowercase<PostHogConfig['persistence']>[] = [\n    'cookie',\n    'localstorage',\n    'localstorage+cookie',\n    'sessionstorage',\n    'memory',\n]\n\n/**\n * PostHog Persistence Object\n * @constructor\n */\nexport class PostHogPersistence {\n    props: Properties\n    storage: PersistentStore\n    campaign_params_saved: boolean\n    custom_campaign_params: string[]\n    name: string\n    disabled: boolean | undefined\n    secure: boolean | undefined\n    expire_days: number | undefined\n    default_expiry: number | undefined\n    cross_subdomain: boolean | undefined\n    user_state: 'anonymous' | 'identified'\n\n    constructor(config: PostHogConfig) {\n        // clean chars that aren't accepted by the http spec for cookie values\n        // https://datatracker.ietf.org/doc/html/rfc2616#section-2.2\n        let token = ''\n\n        if (config['token']) {\n            token = config['token'].replace(/\\+/g, 'PL').replace(/\\//g, 'SL').replace(/=/g, 'EQ')\n        }\n\n        this.props = {}\n        this.campaign_params_saved = false\n        this.custom_campaign_params = config['custom_campaign_params'] || []\n\n        if (config['persistence_name']) {\n            this.name = 'ph_' + config['persistence_name']\n        } else {\n            this.name = 'ph_' + token + '_posthog'\n        }\n\n        if (\n            CASE_INSENSITIVE_PERSISTENCE_TYPES.indexOf(\n                config['persistence'].toLowerCase() as Lowercase<PostHogConfig['persistence']>\n            ) === -1\n        ) {\n            logger.critical('Unknown persistence type ' + config['persistence'] + '; falling back to cookie')\n            config['persistence'] = 'cookie'\n        }\n        // We handle storage type in a case-insensitive way for backwards compatibility\n        const storage_type = config['persistence'].toLowerCase() as Lowercase<PostHogConfig['persistence']>\n        if (storage_type === 'localstorage' && localStore.is_supported()) {\n            this.storage = localStore\n        } else if (storage_type === 'localstorage+cookie' && localPlusCookieStore.is_supported()) {\n            this.storage = localPlusCookieStore\n        } else if (storage_type === 'sessionstorage' && sessionStore.is_supported()) {\n            this.storage = sessionStore\n        } else if (storage_type === 'memory') {\n            this.storage = memoryStore\n        } else {\n            this.storage = cookieStore\n        }\n\n        this.user_state = 'anonymous'\n\n        this.load()\n        this.update_config(config)\n        this.save()\n    }\n\n    properties(): Properties {\n        const p: Properties = {}\n        // Filter out reserved properties\n        _each(this.props, function (v, k) {\n            if (k === ENABLED_FEATURE_FLAGS && typeof v === 'object') {\n                const keys = Object.keys(v)\n                for (let i = 0; i < keys.length; i++) {\n                    p[`$feature/${keys[i]}`] = v[keys[i]]\n                }\n            } else if (!_include(PERSISTENCE_RESERVED_PROPERTIES, k)) {\n                p[k] = v\n            }\n        })\n        return p\n    }\n\n    load(): void {\n        if (this.disabled) {\n            return\n        }\n\n        const entry = this.storage.parse(this.name)\n\n        if (entry) {\n            this.props = _extend({}, entry)\n        }\n    }\n\n    /**\n     * NOTE: Saving frequently causes issues with Recordings and Consent Management Platform (CMP) tools which\n     * observe cookie changes, and modify their UI, often causing infinite loops.\n     * As such callers of this should ideally check that the data has changed beforehand\n     */\n    save(): void {\n        if (this.disabled) {\n            return\n        }\n        this.storage.set(this.name, this.props, this.expire_days, this.cross_subdomain, this.secure)\n    }\n\n    remove(): void {\n        // remove both domain and subdomain cookies\n        this.storage.remove(this.name, false)\n        this.storage.remove(this.name, true)\n    }\n\n    // removes the storage entry and deletes all loaded data\n    // forced name for tests\n\n    clear(): void {\n        this.remove()\n        this.props = {}\n    }\n\n    /**\n     * @param {Object} props\n     * @param {*=} default_value\n     * @param {number=} days\n     */\n\n    register_once(props: Properties, default_value: any, days?: number): boolean {\n        if (_isObject(props)) {\n            if (typeof default_value === 'undefined') {\n                default_value = 'None'\n            }\n            this.expire_days = typeof days === 'undefined' ? this.default_expiry : days\n\n            let hasChanges = false\n\n            _each(props, (val, prop) => {\n                if (!this.props.hasOwnProperty(prop) || this.props[prop] === default_value) {\n                    this.props[prop] = val\n                    hasChanges = true\n                }\n            })\n\n            if (hasChanges) {\n                this.save()\n                return true\n            }\n        }\n        return false\n    }\n\n    /**\n     * @param {Object} props\n     * @param {number=} days\n     */\n\n    register(props: Properties, days?: number): boolean {\n        if (_isObject(props)) {\n            this.expire_days = typeof days === 'undefined' ? this.default_expiry : days\n\n            let hasChanges = false\n\n            _each(props, (val, prop) => {\n                if (props.hasOwnProperty(prop) && this.props[prop] !== val) {\n                    this.props[prop] = val\n                    hasChanges = true\n                }\n            })\n\n            if (hasChanges) {\n                this.save()\n                return true\n            }\n        }\n        return false\n    }\n\n    unregister(prop: string): void {\n        if (prop in this.props) {\n            delete this.props[prop]\n            this.save()\n        }\n    }\n\n    update_campaign_params(): void {\n        if (!this.campaign_params_saved) {\n            this.register(_info.campaignParams(this.custom_campaign_params))\n            this.campaign_params_saved = true\n        }\n    }\n\n    update_search_keyword(): void {\n        this.register(_info.searchInfo())\n    }\n\n    update_referrer_info(): void {\n        this.register({\n            $referrer: this.props['$referrer'] || _info.referrer(),\n            $referring_domain: this.props['$referring_domain'] || _info.referringDomain(),\n        })\n    }\n\n    get_referrer_info(): Properties {\n        return _strip_empty_properties({\n            $referrer: this['props']['$referrer'],\n            $referring_domain: this['props']['$referring_domain'],\n        })\n    }\n\n    // safely fills the passed in object with stored properties,\n    // does not override any properties defined in both\n    // returns the passed in object\n\n    safe_merge(props: Properties): Properties {\n        _each(this.props, function (val, prop) {\n            if (!(prop in props)) {\n                props[prop] = val\n            }\n        })\n\n        return props\n    }\n\n    update_config(config: PostHogConfig): void {\n        this.default_expiry = this.expire_days = config['cookie_expiration']\n        this.set_disabled(config['disable_persistence'])\n        this.set_cross_subdomain(config['cross_subdomain_cookie'])\n        this.set_secure(config['secure_cookie'])\n    }\n\n    set_disabled(disabled: boolean): void {\n        this.disabled = disabled\n        if (this.disabled) {\n            this.remove()\n        } else {\n            this.save()\n        }\n    }\n\n    set_cross_subdomain(cross_subdomain: boolean): void {\n        if (cross_subdomain !== this.cross_subdomain) {\n            this.cross_subdomain = cross_subdomain\n            this.remove()\n            this.save()\n        }\n    }\n\n    get_cross_subdomain(): boolean {\n        return !!this.cross_subdomain\n    }\n\n    set_secure(secure: boolean): void {\n        if (secure !== this.secure) {\n            this.secure = secure\n            this.remove()\n            this.save()\n        }\n    }\n\n    set_event_timer(event_name: string, timestamp: number): void {\n        const timers = this.props[EVENT_TIMERS_KEY] || {}\n        timers[event_name] = timestamp\n        this.props[EVENT_TIMERS_KEY] = timers\n        this.save()\n    }\n\n    remove_event_timer(event_name: string): number {\n        const timers = this.props[EVENT_TIMERS_KEY] || {}\n        const timestamp = timers[event_name]\n        if (!_isUndefined(timestamp)) {\n            delete this.props[EVENT_TIMERS_KEY][event_name]\n            this.save()\n        }\n        return timestamp\n    }\n\n    get_user_state(): 'anonymous' | 'identified' {\n        return this.props[USER_STATE] || 'anonymous'\n    }\n\n    set_user_state(state: 'anonymous' | 'identified'): void {\n        this.props[USER_STATE] = state\n        this.save()\n    }\n\n    get_quota_limits(): Record<string, number> {\n        return this.props[POSTHOG_QUOTA_LIMITED] || {}\n    }\n\n    set_quota_limits(state: Record<string, number>): void {\n        this.props[POSTHOG_QUOTA_LIMITED] = state\n        this.save()\n    }\n}\n"]}

package/lib/src/posthog-surveys.d.ts

@@ -0,0 +1,57 @@
+import { PostHog } from './posthog-core';
+/**
+ * Having Survey types in types.ts was confusing tsc
+ * and generating an invalid module.d.ts
+ * See https://github.com/PostHog/posthog-js/issues/698
+ */
+export interface SurveyAppearance {
+    background_color?: string;
+    button_color?: string;
+    text_color?: string;
+}
+export declare enum SurveyType {
+    Popover = "Popover",
+    Button = "Button",
+    Email = "Email",
+    FullScreen = "Fullscreen"
+}
+export interface SurveyQuestion {
+    type: SurveyQuestionType;
+    question: string;
+    required?: boolean;
+    link?: boolean;
+    choices?: string[];
+}
+export declare enum SurveyQuestionType {
+    Open = "open",
+    MultipleChoiceSingle = "multiple_single",
+    MultipleChoiceMulti = "multiple_multi",
+    NPS = "nps",
+    Rating = "rating",
+    Link = "link"
+}
+export interface SurveyResponse {
+    surveys: Survey[];
+}
+export declare type SurveyCallback = (surveys: Survey[]) => void;
+export interface Survey {
+    name: string;
+    description: string;
+    type: SurveyType;
+    linked_flag_key?: string | null;
+    targeting_flag_key?: string | null;
+    questions: SurveyQuestion[];
+    appearance?: SurveyAppearance | null;
+    conditions?: {
+        url?: string;
+        selector?: string;
+    } | null;
+    start_date?: string | null;
+    end_date?: string | null;
+}
+export declare class PostHogSurveys {
+    instance: PostHog;
+    constructor(instance: PostHog);
+    getSurveys(callback: SurveyCallback, forceReload?: boolean): void;
+    getActiveMatchingSurveys(callback: SurveyCallback, forceReload?: boolean): void;
+}

package/lib/src/posthog-surveys.js

@@ -0,0 +1,76 @@
+import { SURVEYS } from './constants';
+export var SurveyType;
+(function (SurveyType) {
+    SurveyType["Popover"] = "Popover";
+    SurveyType["Button"] = "Button";
+    SurveyType["Email"] = "Email";
+    SurveyType["FullScreen"] = "Fullscreen";
+})(SurveyType || (SurveyType = {}));
+export var SurveyQuestionType;
+(function (SurveyQuestionType) {
+    SurveyQuestionType["Open"] = "open";
+    SurveyQuestionType["MultipleChoiceSingle"] = "multiple_single";
+    SurveyQuestionType["MultipleChoiceMulti"] = "multiple_multi";
+    SurveyQuestionType["NPS"] = "nps";
+    SurveyQuestionType["Rating"] = "rating";
+    SurveyQuestionType["Link"] = "link";
+})(SurveyQuestionType || (SurveyQuestionType = {}));
+var PostHogSurveys = /** @class */ (function () {
+    function PostHogSurveys(instance) {
+        this.instance = instance;
+    }
+    PostHogSurveys.prototype.getSurveys = function (callback, forceReload) {
+        var _this = this;
+        if (forceReload === void 0) { forceReload = false; }
+        var existingSurveys = this.instance.get_property(SURVEYS);
+        if (!existingSurveys || forceReload) {
+            this.instance._send_request("".concat(this.instance.get_config('api_host'), "/api/surveys/?token=").concat(this.instance.get_config('token')), {}, { method: 'GET' }, function (response) {
+                var _a;
+                var surveys = response.surveys;
+                _this.instance.persistence.register((_a = {}, _a[SURVEYS] = surveys, _a));
+                return callback(surveys);
+            });
+        }
+        else {
+            return callback(existingSurveys);
+        }
+    };
+    PostHogSurveys.prototype.getActiveMatchingSurveys = function (callback, forceReload) {
+        var _this = this;
+        if (forceReload === void 0) { forceReload = false; }
+        this.getSurveys(function (surveys) {
+            var activeSurveys = surveys.filter(function (survey) {
+                return !!(survey.start_date && !survey.end_date);
+            });
+            var conditionMatchedSurveys = activeSurveys.filter(function (survey) {
+                var _a, _b;
+                if (!survey.conditions) {
+                    return true;
+                }
+                var urlCheck = ((_a = survey.conditions) === null || _a === void 0 ? void 0 : _a.url)
+                    ? window.location.href.indexOf(survey.conditions.url) > -1
+                    : true;
+                var selectorCheck = ((_b = survey.conditions) === null || _b === void 0 ? void 0 : _b.selector)
+                    ? document.querySelector(survey.conditions.selector)
+                    : true;
+                return urlCheck && selectorCheck;
+            });
+            var targetingMatchedSurveys = conditionMatchedSurveys.filter(function (survey) {
+                if (!survey.linked_flag_key && !survey.targeting_flag_key) {
+                    return true;
+                }
+                var linkedFlagCheck = survey.linked_flag_key
+                    ? _this.instance.featureFlags.isFeatureEnabled(survey.linked_flag_key)
+                    : true;
+                var targetingFlagCheck = survey.targeting_flag_key
+                    ? _this.instance.featureFlags.isFeatureEnabled(survey.targeting_flag_key)
+                    : true;
+                return linkedFlagCheck && targetingFlagCheck;
+            });
+            return callback(targetingMatchedSurveys);
+        }, forceReload);
+    };
+    return PostHogSurveys;
+}());
+export { PostHogSurveys };
+//# sourceMappingURL=posthog-surveys.js.map

package/lib/src/posthog-surveys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"posthog-surveys.js","sourceRoot":"","sources":["../../src/posthog-surveys.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAarC,MAAM,CAAN,IAAY,UAKX;AALD,WAAY,UAAU;IAClB,iCAAmB,CAAA;IACnB,+BAAiB,CAAA;IACjB,6BAAe,CAAA;IACf,uCAAyB,CAAA;AAC7B,CAAC,EALW,UAAU,KAAV,UAAU,QAKrB;AAUD,MAAM,CAAN,IAAY,kBAOX;AAPD,WAAY,kBAAkB;IAC1B,mCAAa,CAAA;IACb,8DAAwC,CAAA;IACxC,4DAAsC,CAAA;IACtC,iCAAW,CAAA;IACX,uCAAiB,CAAA;IACjB,mCAAa,CAAA;AACjB,CAAC,EAPW,kBAAkB,KAAlB,kBAAkB,QAO7B;AAsBD;IAGI,wBAAY,QAAiB;QACzB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAC5B,CAAC;IAED,mCAAU,GAAV,UAAW,QAAwB,EAAE,WAAmB;QAAxD,iBAgBC;QAhBoC,4BAAA,EAAA,mBAAmB;QACpD,IAAM,eAAe,GAAG,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;QAC3D,IAAI,CAAC,eAAe,IAAI,WAAW,EAAE;YACjC,IAAI,CAAC,QAAQ,CAAC,aAAa,CACvB,UAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,iCAAuB,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,CAAE,EACjG,EAAE,EACF,EAAE,MAAM,EAAE,KAAK,EAAE,EACjB,UAAC,QAAQ;;gBACL,IAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAA;gBAChC,KAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,QAAQ,WAAG,GAAC,OAAO,IAAG,OAAO,MAAG,CAAA;gBAC1D,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAA;YAC5B,CAAC,CACJ,CAAA;SACJ;aAAM;YACH,OAAO,QAAQ,CAAC,eAAe,CAAC,CAAA;SACnC;IACL,CAAC;IAED,iDAAwB,GAAxB,UAAyB,QAAwB,EAAE,WAAmB;QAAtE,iBAgCC;QAhCkD,4BAAA,EAAA,mBAAmB;QAClE,IAAI,CAAC,UAAU,CAAC,UAAC,OAAO;YACpB,IAAM,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,UAAC,MAAM;gBACxC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;YACpD,CAAC,CAAC,CAAA;YACF,IAAM,uBAAuB,GAAG,aAAa,CAAC,MAAM,CAAC,UAAC,MAAM;;gBACxD,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE;oBACpB,OAAO,IAAI,CAAA;iBACd;gBACD,IAAM,QAAQ,GAAG,CAAA,MAAA,MAAM,CAAC,UAAU,0CAAE,GAAG;oBACnC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;oBAC1D,CAAC,CAAC,IAAI,CAAA;gBACV,IAAM,aAAa,GAAG,CAAA,MAAA,MAAM,CAAC,UAAU,0CAAE,QAAQ;oBAC7C,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC;oBACpD,CAAC,CAAC,IAAI,CAAA;gBACV,OAAO,QAAQ,IAAI,aAAa,CAAA;YACpC,CAAC,CAAC,CAAA;YACF,IAAM,uBAAuB,GAAG,uBAAuB,CAAC,MAAM,CAAC,UAAC,MAAM;gBAClE,IAAI,CAAC,MAAM,CAAC,eAAe,IAAI,CAAC,MAAM,CAAC,kBAAkB,EAAE;oBACvD,OAAO,IAAI,CAAA;iBACd;gBACD,IAAM,eAAe,GAAG,MAAM,CAAC,eAAe;oBAC1C,CAAC,CAAC,KAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,gBAAgB,CAAC,MAAM,CAAC,eAAe,CAAC;oBACrE,CAAC,CAAC,IAAI,CAAA;gBACV,IAAM,kBAAkB,GAAG,MAAM,CAAC,kBAAkB;oBAChD,CAAC,CAAC,KAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,gBAAgB,CAAC,MAAM,CAAC,kBAAkB,CAAC;oBACxE,CAAC,CAAC,IAAI,CAAA;gBACV,OAAO,eAAe,IAAI,kBAAkB,CAAA;YAChD,CAAC,CAAC,CAAA;YAEF,OAAO,QAAQ,CAAC,uBAAuB,CAAC,CAAA;QAC5C,CAAC,EAAE,WAAW,CAAC,CAAA;IACnB,CAAC;IACL,qBAAC;AAAD,CAAC,AA1DD,IA0DC","sourcesContent":["import { PostHog } from './posthog-core'\nimport { SURVEYS } from './constants'\n\n/**\n * Having Survey types in types.ts was confusing tsc\n * and generating an invalid module.d.ts\n * See https://github.com/PostHog/posthog-js/issues/698\n */\nexport interface SurveyAppearance {\n    background_color?: string\n    button_color?: string\n    text_color?: string\n}\n\nexport enum SurveyType {\n    Popover = 'Popover',\n    Button = 'Button',\n    Email = 'Email',\n    FullScreen = 'Fullscreen',\n}\n\nexport interface SurveyQuestion {\n    type: SurveyQuestionType\n    question: string\n    required?: boolean\n    link?: boolean\n    choices?: string[]\n}\n\nexport enum SurveyQuestionType {\n    Open = 'open',\n    MultipleChoiceSingle = 'multiple_single',\n    MultipleChoiceMulti = 'multiple_multi',\n    NPS = 'nps',\n    Rating = 'rating',\n    Link = 'link',\n}\n\nexport interface SurveyResponse {\n    surveys: Survey[]\n}\n\nexport type SurveyCallback = (surveys: Survey[]) => void\n\nexport interface Survey {\n    // Sync this with the backend's SurveySerializer!\n    name: string\n    description: string\n    type: SurveyType\n    linked_flag_key?: string | null\n    targeting_flag_key?: string | null\n    questions: SurveyQuestion[]\n    appearance?: SurveyAppearance | null\n    conditions?: { url?: string; selector?: string } | null\n    start_date?: string | null\n    end_date?: string | null\n}\n\nexport class PostHogSurveys {\n    instance: PostHog\n\n    constructor(instance: PostHog) {\n        this.instance = instance\n    }\n\n    getSurveys(callback: SurveyCallback, forceReload = false) {\n        const existingSurveys = this.instance.get_property(SURVEYS)\n        if (!existingSurveys || forceReload) {\n            this.instance._send_request(\n                `${this.instance.get_config('api_host')}/api/surveys/?token=${this.instance.get_config('token')}`,\n                {},\n                { method: 'GET' },\n                (response) => {\n                    const surveys = response.surveys\n                    this.instance.persistence.register({ [SURVEYS]: surveys })\n                    return callback(surveys)\n                }\n            )\n        } else {\n            return callback(existingSurveys)\n        }\n    }\n\n    getActiveMatchingSurveys(callback: SurveyCallback, forceReload = false) {\n        this.getSurveys((surveys) => {\n            const activeSurveys = surveys.filter((survey) => {\n                return !!(survey.start_date && !survey.end_date)\n            })\n            const conditionMatchedSurveys = activeSurveys.filter((survey) => {\n                if (!survey.conditions) {\n                    return true\n                }\n                const urlCheck = survey.conditions?.url\n                    ? window.location.href.indexOf(survey.conditions.url) > -1\n                    : true\n                const selectorCheck = survey.conditions?.selector\n                    ? document.querySelector(survey.conditions.selector)\n                    : true\n                return urlCheck && selectorCheck\n            })\n            const targetingMatchedSurveys = conditionMatchedSurveys.filter((survey) => {\n                if (!survey.linked_flag_key && !survey.targeting_flag_key) {\n                    return true\n                }\n                const linkedFlagCheck = survey.linked_flag_key\n                    ? this.instance.featureFlags.isFeatureEnabled(survey.linked_flag_key)\n                    : true\n                const targetingFlagCheck = survey.targeting_flag_key\n                    ? this.instance.featureFlags.isFeatureEnabled(survey.targeting_flag_key)\n                    : true\n                return linkedFlagCheck && targetingFlagCheck\n            })\n\n            return callback(targetingMatchedSurveys)\n        }, forceReload)\n    }\n}\n"]}

package/lib/src/rate-limiter.d.ts

@@ -0,0 +1,5 @@
+export declare class RateLimiter {
+    limits: Record<string, number>;
+    isRateLimited(batchKey: string | undefined): boolean;
+    on429Response(response: XMLHttpRequest): void;
+}

package/lib/src/rate-limiter.js

@@ -0,0 +1,66 @@
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+import { SESSION_RECORDING_BATCH_KEY } from './extensions/sessionrecording';
+/**
+ * Really a 429 response should have a `Retry-After` header which is either a date string,
+ * or the number of seconds to wait before retrying
+ *
+ * But we can rate limit endpoints differently, so send custom header per endpoint
+ * The endpoints are configurable, so we tie the headers/retries to specific batch keys
+ *
+ * And only support a number of seconds to wait before retrying
+ */
+var supportedRetryHeaders = {
+    'X-PostHog-Retry-After-Recordings': SESSION_RECORDING_BATCH_KEY,
+    'X-PostHog-Retry-After-Events': 'events',
+};
+var RateLimiter = /** @class */ (function () {
+    function RateLimiter() {
+        this.limits = {};
+    }
+    RateLimiter.prototype.isRateLimited = function (batchKey) {
+        var retryAfter = this.limits[batchKey || 'events'] || false;
+        if (retryAfter === false) {
+            return false;
+        }
+        return new Date().getTime() < retryAfter;
+    };
+    RateLimiter.prototype.on429Response = function (response) {
+        var _this = this;
+        if (response.status !== 429) {
+            return;
+        }
+        Object.entries(supportedRetryHeaders).forEach(function (_a) {
+            var _b = __read(_a, 2), header = _b[0], batchKey = _b[1];
+            var responseHeader = response.getResponseHeader(header);
+            if (!responseHeader) {
+                return;
+            }
+            var retryAfterSeconds = parseInt(responseHeader, 10);
+            if (isNaN(retryAfterSeconds)) {
+                retryAfterSeconds = 60;
+            }
+            if (retryAfterSeconds) {
+                var retryAfterMillis = retryAfterSeconds * 1000;
+                _this.limits[batchKey] = new Date().getTime() + retryAfterMillis;
+            }
+        });
+    };
+    return RateLimiter;
+}());
+export { RateLimiter };
+//# sourceMappingURL=rate-limiter.js.map

package/lib/src/rate-limiter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rate-limiter.js","sourceRoot":"","sources":["../../src/rate-limiter.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAA;AAE3E;;;;;;;;GAQG;AACH,IAAM,qBAAqB,GAAG;IAC1B,kCAAkC,EAAE,2BAA2B;IAC/D,8BAA8B,EAAE,QAAQ;CAC3C,CAAA;AAED;IAAA;QACI,WAAM,GAA2B,EAAE,CAAA;IAiCvC,CAAC;IA/BG,mCAAa,GAAb,UAAc,QAA4B;QACtC,IAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,QAAQ,CAAC,IAAI,KAAK,CAAA;QAE7D,IAAI,UAAU,KAAK,KAAK,EAAE;YACtB,OAAO,KAAK,CAAA;SACf;QACD,OAAO,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,UAAU,CAAA;IAC5C,CAAC;IAED,mCAAa,GAAb,UAAc,QAAwB;QAAtC,iBAqBC;QApBG,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;YACzB,OAAM;SACT;QAED,MAAM,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC,OAAO,CAAC,UAAC,EAAkB;gBAAlB,KAAA,aAAkB,EAAjB,MAAM,QAAA,EAAE,QAAQ,QAAA;YAC5D,IAAM,cAAc,GAAG,QAAQ,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAA;YACzD,IAAI,CAAC,cAAc,EAAE;gBACjB,OAAM;aACT;YAED,IAAI,iBAAiB,GAAG,QAAQ,CAAC,cAAc,EAAE,EAAE,CAAC,CAAA;YACpD,IAAI,KAAK,CAAC,iBAAiB,CAAC,EAAE;gBAC1B,iBAAiB,GAAG,EAAE,CAAA;aACzB;YAED,IAAI,iBAAiB,EAAE;gBACnB,IAAM,gBAAgB,GAAG,iBAAiB,GAAG,IAAI,CAAA;gBACjD,KAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,gBAAgB,CAAA;aAClE;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IACL,kBAAC;AAAD,CAAC,AAlCD,IAkCC","sourcesContent":["import { SESSION_RECORDING_BATCH_KEY } from './extensions/sessionrecording'\n\n/**\n * Really a 429 response should have a `Retry-After` header which is either a date string,\n * or the number of seconds to wait before retrying\n *\n * But we can rate limit endpoints differently, so send custom header per endpoint\n * The endpoints are configurable, so we tie the headers/retries to specific batch keys\n *\n * And only support a number of seconds to wait before retrying\n */\nconst supportedRetryHeaders = {\n    'X-PostHog-Retry-After-Recordings': SESSION_RECORDING_BATCH_KEY,\n    'X-PostHog-Retry-After-Events': 'events',\n}\n\nexport class RateLimiter {\n    limits: Record<string, number> = {}\n\n    isRateLimited(batchKey: string | undefined): boolean {\n        const retryAfter = this.limits[batchKey || 'events'] || false\n\n        if (retryAfter === false) {\n            return false\n        }\n        return new Date().getTime() < retryAfter\n    }\n\n    on429Response(response: XMLHttpRequest): void {\n        if (response.status !== 429) {\n            return\n        }\n\n        Object.entries(supportedRetryHeaders).forEach(([header, batchKey]) => {\n            const responseHeader = response.getResponseHeader(header)\n            if (!responseHeader) {\n                return\n            }\n\n            let retryAfterSeconds = parseInt(responseHeader, 10)\n            if (isNaN(retryAfterSeconds)) {\n                retryAfterSeconds = 60\n            }\n\n            if (retryAfterSeconds) {\n                const retryAfterMillis = retryAfterSeconds * 1000\n                this.limits[batchKey] = new Date().getTime() + retryAfterMillis\n            }\n        })\n    }\n}\n"]}

package/lib/src/request-queue.d.ts

@@ -0,0 +1,10 @@
+import { RequestQueueScaffold } from './base-request-queue';
+import { Properties, QueuedRequestData, XHROptions } from './types';
+export declare class RequestQueue extends RequestQueueScaffold {
+    handlePollRequest: (url: string, data: Properties, options?: XHROptions) => void;
+    constructor(handlePollRequest: (url: string, data: Properties, options?: XHROptions) => void, pollInterval?: number);
+    enqueue(url: string, data: Properties, options: XHROptions): void;
+    poll(): void;
+    unload(): void;
+    formatQueue(): Record<string, QueuedRequestData>;
+}