@leanbase.com/js 0.1.3 → 0.2.0-alpha.0

package/lib/leanbase.js

@@ -0,0 +1,294 @@
+import { PostHogCore, getFetch, isEmptyObject, isEmptyString, isNumber, isObject, isString, isUndefined, } from '@posthog/core';
+import { LeanbasePersistence } from './leanbase-persistence';
+import { addEventListener, copyAndTruncateStrings, document, extend, isCrossDomainCookie, navigator, userAgent, } from './utils';
+import Config from './config';
+import { Autocapture } from './autocapture';
+import { logger } from './leanbase-logger';
+import { COOKIELESS_MODE_FLAG_PROPERTY, USER_STATE } from './constants';
+import { getEventProperties } from './utils/event-utils';
+import { uuidv7 } from './uuidv7';
+import { PageViewManager } from './page-view';
+import { ScrollManager } from './scroll-manager';
+import { isLikelyBot } from './utils/blocked-uas';
+const defaultConfig = () => ({
+    host: 'https://i.leanbase.co',
+    token: '',
+    autocapture: true,
+    rageclick: true,
+    persistence: 'localStorage+cookie',
+    capture_pageview: true,
+    capture_pageleave: 'if_capture_pageview',
+    persistence_name: '',
+    mask_all_element_attributes: false,
+    cookie_expiration: 365,
+    cross_subdomain_cookie: isCrossDomainCookie(document?.location),
+    custom_campaign_params: [],
+    custom_personal_data_properties: [],
+    disable_persistence: false,
+    mask_personal_data_properties: false,
+    secure_cookie: window?.location?.protocol === 'https:',
+    mask_all_text: false,
+    bootstrap: {},
+    session_idle_timeout_seconds: 30 * 60,
+    save_campaign_params: true,
+    save_referrer: true,
+    opt_out_useragent_filter: false,
+    properties_string_max_length: 65535,
+    loaded: () => { },
+});
+export class Leanbase extends PostHogCore {
+    constructor(token, config) {
+        const mergedConfig = extend(defaultConfig(), config || {}, {
+            token,
+        });
+        super(token, mergedConfig);
+        this.personProcessingSetOncePropertiesSent = false;
+        this.isLoaded = false;
+        this.config = mergedConfig;
+        this.visibilityStateListener = null;
+        this.initialPageviewCaptured = false;
+        this.scrollManager = new ScrollManager(this);
+        this.pageViewManager = new PageViewManager(this);
+        this.init(token, mergedConfig);
+    }
+    init(token, config) {
+        this.setConfig(extend(defaultConfig(), config, {
+            token,
+        }));
+        this.isLoaded = true;
+        this.persistence = new LeanbasePersistence(this.config);
+        this.replayAutocapture = new Autocapture(this);
+        this.replayAutocapture.startIfEnabled();
+        if (this.config.preloadFeatureFlags !== false) {
+            this.reloadFeatureFlags();
+        }
+        this.config.loaded?.(this);
+        if (this.config.capture_pageview) {
+            setTimeout(() => {
+                if (this.config.cookieless_mode === 'always') {
+                    this.captureInitialPageview();
+                }
+            }, 1);
+        }
+        addEventListener(document, 'DOMContentLoaded', () => {
+            this.loadRemoteConfig();
+        });
+        addEventListener(window, 'onpagehide' in self ? 'pagehide' : 'unload', this.capturePageLeave.bind(this), {
+            passive: false,
+        });
+    }
+    captureInitialPageview() {
+        if (!document) {
+            return;
+        }
+        if (document.visibilityState !== 'visible') {
+            if (!this.visibilityStateListener) {
+                this.visibilityStateListener = this.captureInitialPageview.bind(this);
+                addEventListener(document, 'visibilitychange', this.visibilityStateListener);
+            }
+            return;
+        }
+        if (!this.initialPageviewCaptured) {
+            this.initialPageviewCaptured = true;
+            this.capture('$pageview', { title: document.title });
+            if (this.visibilityStateListener) {
+                document.removeEventListener('visibilitychange', this.visibilityStateListener);
+                this.visibilityStateListener = null;
+            }
+        }
+    }
+    capturePageLeave() {
+        const { capture_pageleave, capture_pageview } = this.config;
+        if (capture_pageleave === true ||
+            (capture_pageleave === 'if_capture_pageview' &&
+                (capture_pageview === true || capture_pageview === 'history_change'))) {
+            this.capture('$pageleave');
+        }
+    }
+    async loadRemoteConfig() {
+        if (!this.isRemoteConfigLoaded) {
+            const remoteConfig = await this.reloadRemoteConfigAsync();
+            if (remoteConfig) {
+                this.onRemoteConfig(remoteConfig);
+            }
+        }
+    }
+    onRemoteConfig(config) {
+        if (!(document && document.body)) {
+            setTimeout(() => {
+                this.onRemoteConfig(config);
+            }, 500);
+            return;
+        }
+        this.isRemoteConfigLoaded = true;
+        this.replayAutocapture?.onRemoteConfig(config);
+    }
+    fetch(url, options) {
+        const fetchFn = getFetch();
+        if (!fetchFn) {
+            return Promise.reject(new Error('Fetch API is not available in this environment.'));
+        }
+        return fetchFn(url, options);
+    }
+    setConfig(config) {
+        const oldConfig = { ...this.config };
+        if (isObject(config)) {
+            extend(this.config, config);
+            this.persistence?.update_config(this.config, oldConfig);
+            this.replayAutocapture?.startIfEnabled();
+        }
+        const isTempStorage = this.config.persistence === 'sessionStorage' || this.config.persistence === 'memory';
+        this.sessionPersistence = isTempStorage
+            ? this.persistence
+            : new LeanbasePersistence({ ...this.config, persistence: 'sessionStorage' });
+    }
+    getLibraryId() {
+        return 'leanbase';
+    }
+    getLibraryVersion() {
+        return Config.LIB_VERSION;
+    }
+    getCustomUserAgent() {
+        return;
+    }
+    getPersistedProperty(key) {
+        return this.persistence?.get_property(key);
+    }
+    setPersistedProperty(key, value) {
+        this.persistence?.set_property(key, value);
+    }
+    calculateEventProperties(eventName, eventProperties, timestamp, uuid, readOnly) {
+        if (!this.persistence || !this.sessionPersistence) {
+            return eventProperties;
+        }
+        timestamp = timestamp || new Date();
+        const startTimestamp = readOnly ? undefined : this.persistence?.remove_event_timer(eventName);
+        let properties = { ...eventProperties };
+        properties['token'] = this.config.token;
+        if (this.config.cookieless_mode == 'always' || this.config.cookieless_mode == 'on_reject') {
+            properties[COOKIELESS_MODE_FLAG_PROPERTY] = true;
+        }
+        if (eventName === '$snapshot') {
+            const persistenceProps = { ...this.persistence.properties() };
+            properties['distinct_id'] = persistenceProps.distinct_id;
+            if (!(isString(properties['distinct_id']) || isNumber(properties['distinct_id'])) ||
+                isEmptyString(properties['distinct_id'])) {
+                logger.error('Invalid distinct_id for replay event. This indicates a bug in your implementation');
+            }
+            return properties;
+        }
+        const infoProperties = getEventProperties(this.config.mask_personal_data_properties, this.config.custom_personal_data_properties);
+        if (this.sessionManager) {
+            const { sessionId, windowId } = this.sessionManager.checkAndGetSessionAndWindowId(readOnly, timestamp.getTime());
+            properties['$session_id'] = sessionId;
+            properties['$window_id'] = windowId;
+        }
+        if (this.sessionPropsManager) {
+            extend(properties, this.sessionPropsManager.getSessionProps());
+        }
+        let pageviewProperties = this.pageViewManager.doEvent();
+        if (eventName === '$pageview' && !readOnly) {
+            pageviewProperties = this.pageViewManager.doPageView(timestamp, uuid);
+        }
+        if (eventName === '$pageleave' && !readOnly) {
+            pageviewProperties = this.pageViewManager.doPageLeave(timestamp);
+        }
+        properties = extend(properties, pageviewProperties);
+        if (eventName === '$pageview' && document) {
+            properties['title'] = document.title;
+        }
+        if (!isUndefined(startTimestamp)) {
+            const duration_in_ms = timestamp.getTime() - startTimestamp;
+            properties['$duration'] = parseFloat((duration_in_ms / 1000).toFixed(3));
+        }
+        if (userAgent && this.config.opt_out_useragent_filter) {
+            properties['$browser_type'] = isLikelyBot(navigator, []) ? 'bot' : 'browser';
+        }
+        properties = extend({}, infoProperties, this.persistence.properties(), this.sessionPersistence.properties(), properties);
+        properties['$is_identified'] = this.isIdentified();
+        return properties;
+    }
+    isIdentified() {
+        return (this.persistence?.get_property(USER_STATE) === 'identified' ||
+            this.sessionPersistence?.get_property(USER_STATE) === 'identified');
+    }
+    /**
+     * Add additional set_once properties to the event when creating a person profile. This allows us to create the
+     * profile with mostly-accurate properties, despite earlier events not setting them. We do this by storing them in
+     * persistence.
+     * @param dataSetOnce
+     */
+    calculateSetOnceProperties(dataSetOnce) {
+        if (!this.persistence) {
+            return dataSetOnce;
+        }
+        if (this.personProcessingSetOncePropertiesSent) {
+            return dataSetOnce;
+        }
+        const initialProps = this.persistence.get_initial_props();
+        const sessionProps = this.sessionPropsManager?.getSetOnceProps();
+        const setOnceProperties = extend({}, initialProps, sessionProps || {}, dataSetOnce || {});
+        this.personProcessingSetOncePropertiesSent = true;
+        if (isEmptyObject(setOnceProperties)) {
+            return undefined;
+        }
+        return setOnceProperties;
+    }
+    capture(event, properties, options) {
+        if (!this.isLoaded || !this.sessionPersistence || !this.persistence) {
+            return;
+        }
+        if (isUndefined(event) || !isString(event)) {
+            logger.error('No event name provided to posthog.capture');
+            return;
+        }
+        if (properties?.$current_url && !isString(properties?.$current_url)) {
+            logger.error('Invalid `$current_url` property provided to `posthog.capture`. Input must be a string. Ignoring provided value.');
+            delete properties?.$current_url;
+        }
+        this.sessionPersistence.update_search_keyword();
+        if (this.config.save_campaign_params) {
+            this.sessionPersistence.update_campaign_params();
+        }
+        if (this.config.save_referrer) {
+            this.sessionPersistence.update_referrer_info();
+        }
+        if (this.config.save_campaign_params || this.config.save_referrer) {
+            this.persistence.set_initial_person_info();
+        }
+        const systemTime = new Date();
+        const timestamp = options?.timestamp || systemTime;
+        const uuid = uuidv7();
+        let data = {
+            uuid,
+            event,
+            properties: this.calculateEventProperties(event, properties || {}, timestamp, uuid),
+        };
+        const setProperties = options?.$set;
+        if (setProperties) {
+            data.$set = options?.$set;
+        }
+        const setOnceProperties = this.calculateSetOnceProperties(options?.$set_once);
+        if (setOnceProperties) {
+            data.$set_once = setOnceProperties;
+        }
+        data = copyAndTruncateStrings(data, options?._noTruncate ? null : this.config.properties_string_max_length);
+        data.timestamp = timestamp;
+        if (!isUndefined(options?.timestamp)) {
+            data.properties['$event_time_override_provided'] = true;
+            data.properties['$event_time_override_system_time'] = systemTime;
+        }
+        const finalSet = { ...data.properties['$set'], ...data['$set'] };
+        if (!isEmptyObject(finalSet)) {
+            this.setPersonPropertiesForFlags(finalSet);
+        }
+        super.capture(data.event, data.properties, options);
+    }
+    identify(distinctId, properties, options) {
+        super.identify(distinctId, properties, options);
+    }
+    destroy() {
+        this.persistence?.clear();
+    }
+}
+//# sourceMappingURL=leanbase.js.map

package/lib/leanbase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"leanbase.js","sourceRoot":"","sources":["../src/leanbase.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,WAAW,EACX,QAAQ,EACR,aAAa,EACb,aAAa,EACb,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,WAAW,GACd,MAAM,eAAe,CAAA;AActB,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAA;AAC5D,OAAO,EACH,gBAAgB,EAChB,sBAAsB,EACtB,QAAQ,EACR,MAAM,EACN,mBAAmB,EACnB,SAAS,EACT,SAAS,GACZ,MAAM,SAAS,CAAA;AAChB,OAAO,MAAM,MAAM,UAAU,CAAA;AAC7B,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAC1C,OAAO,EAAE,6BAA6B,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACvE,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AAGxD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AACjC,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AAEjD,MAAM,aAAa,GAAG,GAAmB,EAAE,CAAC,CAAC;IACzC,IAAI,EAAE,uBAAuB;IAC7B,KAAK,EAAE,EAAE;IACT,WAAW,EAAE,IAAI;IACjB,SAAS,EAAE,IAAI;IACf,WAAW,EAAE,qBAAqB;IAClC,gBAAgB,EAAE,IAAI;IACtB,iBAAiB,EAAE,qBAAqB;IACxC,gBAAgB,EAAE,EAAE;IACpB,2BAA2B,EAAE,KAAK;IAClC,iBAAiB,EAAE,GAAG;IACtB,sBAAsB,EAAE,mBAAmB,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC/D,sBAAsB,EAAE,EAAE;IAC1B,+BAA+B,EAAE,EAAE;IACnC,mBAAmB,EAAE,KAAK;IAC1B,6BAA6B,EAAE,KAAK;IACpC,aAAa,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,KAAK,QAAQ;IACtD,aAAa,EAAE,KAAK;IACpB,SAAS,EAAE,EAAE;IACb,4BAA4B,EAAE,EAAE,GAAG,EAAE;IACrC,oBAAoB,EAAE,IAAI;IAC1B,aAAa,EAAE,IAAI;IACnB,wBAAwB,EAAE,KAAK;IAC/B,4BAA4B,EAAE,KAAK;IACnC,MAAM,EAAE,GAAG,EAAE,GAAE,CAAC;CACnB,CAAC,CAAA;AAEF,MAAM,OAAO,QAAS,SAAQ,WAAW;IAgBrC,YAAY,KAAa,EAAE,MAAgC;QACvD,MAAM,YAAY,GAAG,MAAM,CAAC,aAAa,EAAE,EAAE,MAAM,IAAI,EAAE,EAAE;YACvD,KAAK;SACR,CAAC,CAAA;QACF,KAAK,CAAC,KAAK,EAAE,YAAY,CAAC,CAAA;QAT9B,0CAAqC,GAAG,KAAK,CAAA;QAC7C,aAAQ,GAAY,KAAK,CAAA;QASrB,IAAI,CAAC,MAAM,GAAG,YAA8B,CAAA;QAC5C,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAA;QACnC,IAAI,CAAC,uBAAuB,GAAG,KAAK,CAAA;QACpC,IAAI,CAAC,aAAa,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,CAAA;QAC5C,IAAI,CAAC,eAAe,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,CAAA;QAChD,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,YAAY,CAAC,CAAA;IAClC,CAAC;IAED,IAAI,CAAC,KAAa,EAAE,MAA+B;QAC/C,IAAI,CAAC,SAAS,CACV,MAAM,CAAC,aAAa,EAAE,EAAE,MAAM,EAAE;YAC5B,KAAK;SACR,CAAC,CACL,CAAA;QACD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;QACpB,IAAI,CAAC,WAAW,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACvD,IAAI,CAAC,iBAAiB,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,CAAA;QAC9C,IAAI,CAAC,iBAAiB,CAAC,cAAc,EAAE,CAAA;QAEvC,IAAI,IAAI,CAAC,MAAM,CAAC,mBAAmB,KAAK,KAAK,EAAE,CAAC;YAC5C,IAAI,CAAC,kBAAkB,EAAE,CAAA;QAC7B,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,CAAA;QAC1B,IAAI,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE,CAAC;YAC/B,UAAU,CAAC,GAAG,EAAE;gBACZ,IAAI,IAAI,CAAC,MAAM,CAAC,eAAe,KAAK,QAAQ,EAAE,CAAC;oBAC3C,IAAI,CAAC,sBAAsB,EAAE,CAAA;gBACjC,CAAC;YACL,CAAC,EAAE,CAAC,CAAC,CAAA;QACT,CAAC;QAED,gBAAgB,CAAC,QAAQ,EAAE,kBAAkB,EAAE,GAAG,EAAE;YAChD,IAAI,CAAC,gBAAgB,EAAE,CAAA;QAC3B,CAAC,CAAC,CAAA;QACF,gBAAgB,CAAC,MAAM,EAAE,YAAY,IAAI,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,EAAE,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YACrG,OAAO,EAAE,KAAK;SACjB,CAAC,CAAA;IACN,CAAC;IAED,sBAAsB;QAClB,IAAI,CAAC,QAAQ,EAAE,CAAC;YACZ,OAAM;QACV,CAAC;QAED,IAAI,QAAQ,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YACzC,IAAI,CAAC,IAAI,CAAC,uBAAuB,EAAE,CAAC;gBAChC,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;gBACrE,gBAAgB,CAAC,QAAQ,EAAE,kBAAkB,EAAE,IAAI,CAAC,uBAAuB,CAAC,CAAA;YAChF,CAAC;YAED,OAAM;QACV,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAChC,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAA;YACnC,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;YAEpD,IAAI,IAAI,CAAC,uBAAuB,EAAE,CAAC;gBAC/B,QAAQ,CAAC,mBAAmB,CAAC,kBAAkB,EAAE,IAAI,CAAC,uBAAuB,CAAC,CAAA;gBAC9E,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAA;YACvC,CAAC;QACL,CAAC;IACL,CAAC;IAED,gBAAgB;QACZ,MAAM,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,MAAM,CAAA;QAC3D,IACI,iBAAiB,KAAK,IAAI;YAC1B,CAAC,iBAAiB,KAAK,qBAAqB;gBACxC,CAAC,gBAAgB,KAAK,IAAI,IAAI,gBAAgB,KAAK,gBAAgB,CAAC,CAAC,EAC3E,CAAC;YACC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;QAC9B,CAAC;IACL,CAAC;IAED,KAAK,CAAC,gBAAgB;QAClB,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC7B,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,uBAAuB,EAAE,CAAA;YACzD,IAAI,YAAY,EAAE,CAAC;gBACf,IAAI,CAAC,cAAc,CAAC,YAA4B,CAAC,CAAA;YACrD,CAAC;QACL,CAAC;IACL,CAAC;IAED,cAAc,CAAC,MAAoB;QAC/B,IAAI,CAAC,CAAC,QAAQ,IAAI,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAC/B,UAAU,CAAC,GAAG,EAAE;gBACZ,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAA;YAC/B,CAAC,EAAE,GAAG,CAAC,CAAA;YACP,OAAM;QACV,CAAC;QAED,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAA;QAChC,IAAI,CAAC,iBAAiB,EAAE,cAAc,CAAC,MAAM,CAAC,CAAA;IAClD,CAAC;IAED,KAAK,CAAC,GAAW,EAAE,OAA4B;QAC3C,MAAM,OAAO,GAAG,QAAQ,EAAE,CAAA;QAC1B,IAAI,CAAC,OAAO,EAAE,CAAC;YACX,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC,CAAA;QACvF,CAAC;QAED,OAAO,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;IAChC,CAAC;IAED,SAAS,CAAC,MAA+B;QACrC,MAAM,SAAS,GAAG,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,CAAA;QACpC,IAAI,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YACnB,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;YAC3B,IAAI,CAAC,WAAW,EAAE,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;YACvD,IAAI,CAAC,iBAAiB,EAAE,cAAc,EAAE,CAAA;QAC5C,CAAC;QAED,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,KAAK,gBAAgB,IAAI,IAAI,CAAC,MAAM,CAAC,WAAW,KAAK,QAAQ,CAAA;QAC1G,IAAI,CAAC,kBAAkB,GAAG,aAAa;YACnC,CAAC,CAAC,IAAI,CAAC,WAAW;YAClB,CAAC,CAAC,IAAI,mBAAmB,CAAC,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,WAAW,EAAE,gBAAgB,EAAE,CAAC,CAAA;IACpF,CAAC;IAED,YAAY;QACR,OAAO,UAAU,CAAA;IACrB,CAAC;IAED,iBAAiB;QACb,OAAO,MAAM,CAAC,WAAW,CAAA;IAC7B,CAAC;IAED,kBAAkB;QACd,OAAM;IACV,CAAC;IAED,oBAAoB,CAAI,GAA6B;QACjD,OAAO,IAAI,CAAC,WAAW,EAAE,YAAY,CAAC,GAAG,CAAC,CAAA;IAC9C,CAAC;IAED,oBAAoB,CAAI,GAA6B,EAAE,KAAe;QAClE,IAAI,CAAC,WAAW,EAAE,YAAY,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;IAC9C,CAAC;IAED,wBAAwB,CACpB,SAAiB,EACjB,eAAuC,EACvC,SAAe,EACf,IAAY,EACZ,QAAkB;QAElB,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAChD,OAAO,eAAe,CAAA;QAC1B,CAAC;QAED,SAAS,GAAG,SAAS,IAAI,IAAI,IAAI,EAAE,CAAA;QACnC,MAAM,cAAc,GAAG,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,kBAAkB,CAAC,SAAS,CAAC,CAAA;QAC7F,IAAI,UAAU,GAAG,EAAE,GAAG,eAAe,EAAE,CAAA;QACvC,UAAU,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAA;QACvC,IAAI,IAAI,CAAC,MAAM,CAAC,eAAe,IAAI,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAC,eAAe,IAAI,WAAW,EAAE,CAAC;YACxF,UAAU,CAAC,6BAA6B,CAAC,GAAG,IAAI,CAAA;QACpD,CAAC;QAED,IAAI,SAAS,KAAK,WAAW,EAAE,CAAC;YAC5B,MAAM,gBAAgB,GAAG,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,EAAE,CAAA;YAC7D,UAAU,CAAC,aAAa,CAAC,GAAG,gBAAgB,CAAC,WAAW,CAAA;YACxD,IACI,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,IAAI,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC;gBAC7E,aAAa,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,EAC1C,CAAC;gBACC,MAAM,CAAC,KAAK,CAAC,mFAAmF,CAAC,CAAA;YACrG,CAAC;YACD,OAAO,UAAU,CAAA;QACrB,CAAC;QAED,MAAM,cAAc,GAAG,kBAAkB,CACrC,IAAI,CAAC,MAAM,CAAC,6BAA6B,EACzC,IAAI,CAAC,MAAM,CAAC,+BAA+B,CAC9C,CAAA;QAED,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACtB,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,cAAc,CAAC,6BAA6B,CAC7E,QAAQ,EACR,SAAS,CAAC,OAAO,EAAE,CACtB,CAAA;YACD,UAAU,CAAC,aAAa,CAAC,GAAG,SAAS,CAAA;YACrC,UAAU,CAAC,YAAY,CAAC,GAAG,QAAQ,CAAA;QACvC,CAAC;QAED,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC3B,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,mBAAmB,CAAC,eAAe,EAAE,CAAC,CAAA;QAClE,CAAC;QAED,IAAI,kBAAkB,GAAwB,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,CAAA;QAC5E,IAAI,SAAS,KAAK,WAAW,IAAI,CAAC,QAAQ,EAAE,CAAC;YACzC,kBAAkB,GAAG,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,SAAS,EAAE,IAAI,CAAC,CAAA;QACzE,CAAC;QAED,IAAI,SAAS,KAAK,YAAY,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC1C,kBAAkB,GAAG,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,SAAS,CAAC,CAAA;QACpE,CAAC;QAED,UAAU,GAAG,MAAM,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAA;QAEnD,IAAI,SAAS,KAAK,WAAW,IAAI,QAAQ,EAAE,CAAC;YACxC,UAAU,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAA;QACxC,CAAC;QAED,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,EAAE,CAAC;YAC/B,MAAM,cAAc,GAAG,SAAS,CAAC,OAAO,EAAE,GAAG,cAAc,CAAA;YAC3D,UAAU,CAAC,WAAW,CAAC,GAAG,UAAU,CAAC,CAAC,cAAc,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAA;QAC5E,CAAC;QAED,IAAI,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,wBAAwB,EAAE,CAAC;YACpD,UAAU,CAAC,eAAe,CAAC,GAAG,WAAW,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAA;QAChF,CAAC;QAED,UAAU,GAAG,MAAM,CACf,EAAE,EACF,cAAc,EACd,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,EAC7B,IAAI,CAAC,kBAAkB,CAAC,UAAU,EAAE,EACpC,UAAU,CACb,CAAA;QAED,UAAU,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,YAAY,EAAE,CAAA;QAClD,OAAO,UAAU,CAAA;IACrB,CAAC;IAED,YAAY;QACR,OAAO,CACH,IAAI,CAAC,WAAW,EAAE,YAAY,CAAC,UAAU,CAAC,KAAK,YAAY;YAC3D,IAAI,CAAC,kBAAkB,EAAE,YAAY,CAAC,UAAU,CAAC,KAAK,YAAY,CACrE,CAAA;IACL,CAAC;IAED;;;;;OAKG;IACH,0BAA0B,CAAC,WAAwB;QAC/C,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACpB,OAAO,WAAW,CAAA;QACtB,CAAC;QAED,IAAI,IAAI,CAAC,qCAAqC,EAAE,CAAC;YAC7C,OAAO,WAAW,CAAA;QACtB,CAAC;QAED,MAAM,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAA;QACzD,MAAM,YAAY,GAAG,IAAI,CAAC,mBAAmB,EAAE,eAAe,EAAE,CAAA;QAChE,MAAM,iBAAiB,GAAG,MAAM,CAAC,EAAE,EAAE,YAAY,EAAE,YAAY,IAAI,EAAE,EAAE,WAAW,IAAI,EAAE,CAAC,CAAA;QACzF,IAAI,CAAC,qCAAqC,GAAG,IAAI,CAAA;QACjD,IAAI,aAAa,CAAC,iBAAiB,CAAC,EAAE,CAAC;YACnC,OAAO,SAAS,CAAA;QACpB,CAAC;QAED,OAAO,iBAAiB,CAAA;IAC5B,CAAC;IAED,OAAO,CAAC,KAAa,EAAE,UAAmC,EAAE,OAAgC;QACxF,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,kBAAkB,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YAClE,OAAM;QACV,CAAC;QAED,IAAI,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACzC,MAAM,CAAC,KAAK,CAAC,2CAA2C,CAAC,CAAA;YACzD,OAAM;QACV,CAAC;QAED,IAAI,UAAU,EAAE,YAAY,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,YAAY,CAAC,EAAE,CAAC;YAClE,MAAM,CAAC,KAAK,CACR,iHAAiH,CACpH,CAAA;YACD,OAAO,UAAU,EAAE,YAAY,CAAA;QACnC,CAAC;QAED,IAAI,CAAC,kBAAkB,CAAC,qBAAqB,EAAE,CAAA;QAE/C,IAAI,IAAI,CAAC,MAAM,CAAC,oBAAoB,EAAE,CAAC;YACnC,IAAI,CAAC,kBAAkB,CAAC,sBAAsB,EAAE,CAAA;QACpD,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC;YAC5B,IAAI,CAAC,kBAAkB,CAAC,oBAAoB,EAAE,CAAA;QAClD,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,CAAC,oBAAoB,IAAI,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC;YAChE,IAAI,CAAC,WAAW,CAAC,uBAAuB,EAAE,CAAA;QAC9C,CAAC;QAED,MAAM,UAAU,GAAG,IAAI,IAAI,EAAE,CAAA;QAC7B,MAAM,SAAS,GAAG,OAAO,EAAE,SAAS,IAAI,UAAU,CAAA;QAClD,MAAM,IAAI,GAAG,MAAM,EAAE,CAAA;QACrB,IAAI,IAAI,GAAkB;YACtB,IAAI;YACJ,KAAK;YACL,UAAU,EAAE,IAAI,CAAC,wBAAwB,CAAC,KAAK,EAAE,UAAU,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC;SACtF,CAAA;QAED,MAAM,aAAa,GAAG,OAAO,EAAE,IAAI,CAAA;QACnC,IAAI,aAAa,EAAE,CAAC;YAChB,IAAI,CAAC,IAAI,GAAG,OAAO,EAAE,IAAI,CAAA;QAC7B,CAAC;QAED,MAAM,iBAAiB,GAAG,IAAI,CAAC,0BAA0B,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;QAC7E,IAAI,iBAAiB,EAAE,CAAC;YACpB,IAAI,CAAC,SAAS,GAAG,iBAAiB,CAAA;QACtC,CAAC;QAED,IAAI,GAAG,sBAAsB,CAAC,IAAI,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,4BAA4B,CAAC,CAAA;QAC3G,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC1B,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC;YACnC,IAAI,CAAC,UAAU,CAAC,+BAA+B,CAAC,GAAG,IAAI,CAAA;YACvD,IAAI,CAAC,UAAU,CAAC,kCAAkC,CAAC,GAAG,UAAU,CAAA;QACpE,CAAC;QAED,MAAM,QAAQ,GAAG,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,EAAE,CAAA;QAChE,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC3B,IAAI,CAAC,2BAA2B,CAAC,QAAQ,CAAC,CAAA;QAC9C,CAAC;QAED,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;IACvD,CAAC;IAED,QAAQ,CAAC,UAAmB,EAAE,UAAmC,EAAE,OAAgC;QAC/F,KAAK,CAAC,QAAQ,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,CAAC,CAAA;IACnD,CAAC;IAED,OAAO;QACH,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,CAAA;IAC7B,CAAC;CACJ"}

package/lib/page-view.d.ts

@@ -0,0 +1,29 @@
+import { Leanbase } from './leanbase';
+interface PageViewEventProperties {
+    $pageview_id?: string;
+    $prev_pageview_id?: string;
+    $prev_pageview_pathname?: string;
+    $prev_pageview_duration?: number;
+    $prev_pageview_last_scroll?: number;
+    $prev_pageview_last_scroll_percentage?: number;
+    $prev_pageview_max_scroll?: number;
+    $prev_pageview_max_scroll_percentage?: number;
+    $prev_pageview_last_content?: number;
+    $prev_pageview_last_content_percentage?: number;
+    $prev_pageview_max_content?: number;
+    $prev_pageview_max_content_percentage?: number;
+}
+export declare class PageViewManager {
+    _currentPageview?: {
+        timestamp: Date;
+        pageViewId: string | undefined;
+        pathname: string | undefined;
+    };
+    _instance: Leanbase;
+    constructor(instance: Leanbase);
+    doPageView(timestamp: Date, pageViewId?: string): PageViewEventProperties;
+    doPageLeave(timestamp: Date): PageViewEventProperties;
+    doEvent(): PageViewEventProperties;
+    private _previousPageViewProperties;
+}
+export {};

package/lib/page-view.js

@@ -0,0 +1,81 @@
+import { window } from './utils';
+import { clampToRange, isUndefined } from '@posthog/core';
+import { extend } from './utils';
+import { logger } from './leanbase-logger';
+// This keeps track of the PageView state (such as the previous PageView's path, timestamp, id, and scroll properties).
+// We store the state in memory, which means that for non-SPA sites, the state will be lost on page reload. This means
+// that non-SPA sites should always send a $pageleave event on any navigation, before the page unloads. For SPA sites,
+// they only need to send a $pageleave event when the user navigates away from the site, as the information is not lost
+// on an internal navigation, and is included as the $prev_pageview_ properties in the next $pageview event.
+// Practically, this means that to find the scroll properties for a given pageview, you need to find the event where
+// event name is $pageview or $pageleave and where $prev_pageview_id matches the original pageview event's id.
+export class PageViewManager {
+    constructor(instance) {
+        this._instance = instance;
+    }
+    doPageView(timestamp, pageViewId) {
+        const response = this._previousPageViewProperties(timestamp, pageViewId);
+        // On a pageview we reset the contexts
+        this._currentPageview = { pathname: window?.location.pathname ?? '', pageViewId, timestamp };
+        this._instance.scrollManager.resetContext();
+        return response;
+    }
+    doPageLeave(timestamp) {
+        return this._previousPageViewProperties(timestamp, this._currentPageview?.pageViewId);
+    }
+    doEvent() {
+        return { $pageview_id: this._currentPageview?.pageViewId };
+    }
+    _previousPageViewProperties(timestamp, pageviewId) {
+        const previousPageView = this._currentPageview;
+        if (!previousPageView) {
+            return { $pageview_id: pageviewId };
+        }
+        let properties = {
+            $pageview_id: pageviewId,
+            $prev_pageview_id: previousPageView.pageViewId,
+        };
+        const scrollContext = this._instance.scrollManager.getContext();
+        if (scrollContext && !this._instance.config.disable_scroll_properties) {
+            let { maxScrollHeight, lastScrollY, maxScrollY, maxContentHeight, lastContentY, maxContentY } = scrollContext;
+            if (!isUndefined(maxScrollHeight) &&
+                !isUndefined(lastScrollY) &&
+                !isUndefined(maxScrollY) &&
+                !isUndefined(maxContentHeight) &&
+                !isUndefined(lastContentY) &&
+                !isUndefined(maxContentY)) {
+                // Use ceil, so that e.g. scrolling 999.5px of a 1000px page is considered 100% scrolled
+                maxScrollHeight = Math.ceil(maxScrollHeight);
+                lastScrollY = Math.ceil(lastScrollY);
+                maxScrollY = Math.ceil(maxScrollY);
+                maxContentHeight = Math.ceil(maxContentHeight);
+                lastContentY = Math.ceil(lastContentY);
+                maxContentY = Math.ceil(maxContentY);
+                // if the maximum scroll height is near 0, then the percentage is 1
+                const lastScrollPercentage = maxScrollHeight <= 1 ? 1 : clampToRange(lastScrollY / maxScrollHeight, 0, 1, logger);
+                const maxScrollPercentage = maxScrollHeight <= 1 ? 1 : clampToRange(maxScrollY / maxScrollHeight, 0, 1, logger);
+                const lastContentPercentage = maxContentHeight <= 1 ? 1 : clampToRange(lastContentY / maxContentHeight, 0, 1, logger);
+                const maxContentPercentage = maxContentHeight <= 1 ? 1 : clampToRange(maxContentY / maxContentHeight, 0, 1, logger);
+                properties = extend(properties, {
+                    $prev_pageview_last_scroll: lastScrollY,
+                    $prev_pageview_last_scroll_percentage: lastScrollPercentage,
+                    $prev_pageview_max_scroll: maxScrollY,
+                    $prev_pageview_max_scroll_percentage: maxScrollPercentage,
+                    $prev_pageview_last_content: lastContentY,
+                    $prev_pageview_last_content_percentage: lastContentPercentage,
+                    $prev_pageview_max_content: maxContentY,
+                    $prev_pageview_max_content_percentage: maxContentPercentage,
+                });
+            }
+        }
+        if (previousPageView.pathname) {
+            properties.$prev_pageview_pathname = previousPageView.pathname;
+        }
+        if (previousPageView.timestamp) {
+            // Use seconds, for consistency with our other duration-related properties like $duration
+            properties.$prev_pageview_duration = (timestamp.getTime() - previousPageView.timestamp.getTime()) / 1000;
+        }
+        return properties;
+    }
+}
+//# sourceMappingURL=page-view.js.map

package/lib/page-view.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"page-view.js","sourceRoot":"","sources":["../src/page-view.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAEhC,OAAO,EAAE,YAAY,EAAE,WAAW,EAAU,MAAM,eAAe,CAAA;AACjE,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAChC,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAiB1C,uHAAuH;AACvH,sHAAsH;AACtH,sHAAsH;AACtH,uHAAuH;AACvH,4GAA4G;AAE5G,oHAAoH;AACpH,8GAA8G;AAE9G,MAAM,OAAO,eAAe;IAIxB,YAAY,QAAkB;QAC1B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAA;IAC7B,CAAC;IAED,UAAU,CAAC,SAAe,EAAE,UAAmB;QAC3C,MAAM,QAAQ,GAAG,IAAI,CAAC,2BAA2B,CAAC,SAAS,EAAE,UAAU,CAAC,CAAA;QAExE,sCAAsC;QACtC,IAAI,CAAC,gBAAgB,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,QAAQ,IAAI,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,CAAA;QAC5F,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,YAAY,EAAE,CAAA;QAE3C,OAAO,QAAQ,CAAA;IACnB,CAAC;IAED,WAAW,CAAC,SAAe;QACvB,OAAO,IAAI,CAAC,2BAA2B,CAAC,SAAS,EAAE,IAAI,CAAC,gBAAgB,EAAE,UAAU,CAAC,CAAA;IACzF,CAAC;IAED,OAAO;QACH,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,gBAAgB,EAAE,UAAU,EAAE,CAAA;IAC9D,CAAC;IAEO,2BAA2B,CAAC,SAAe,EAAE,UAA8B;QAC/E,MAAM,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAA;QAE9C,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACpB,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,CAAA;QACvC,CAAC;QAED,IAAI,UAAU,GAA4B;YACtC,YAAY,EAAE,UAAU;YACxB,iBAAiB,EAAE,gBAAgB,CAAC,UAAU;SACjD,CAAA;QAED,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,CAAA;QAE/D,IAAI,aAAa,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,yBAAyB,EAAE,CAAC;YACpE,IAAI,EAAE,eAAe,EAAE,WAAW,EAAE,UAAU,EAAE,gBAAgB,EAAE,YAAY,EAAE,WAAW,EAAE,GACzF,aAAa,CAAA;YAEjB,IACI,CAAC,WAAW,CAAC,eAAe,CAAC;gBAC7B,CAAC,WAAW,CAAC,WAAW,CAAC;gBACzB,CAAC,WAAW,CAAC,UAAU,CAAC;gBACxB,CAAC,WAAW,CAAC,gBAAgB,CAAC;gBAC9B,CAAC,WAAW,CAAC,YAAY,CAAC;gBAC1B,CAAC,WAAW,CAAC,WAAW,CAAC,EAC3B,CAAC;gBACC,wFAAwF;gBACxF,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;gBAC5C,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;gBACpC,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;gBAClC,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;gBAC9C,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;gBACtC,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;gBAEpC,mEAAmE;gBACnE,MAAM,oBAAoB,GACtB,eAAe,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,WAAW,GAAG,eAAe,EAAE,CAAC,EAAE,CAAC,EAAE,MAAgB,CAAC,CAAA;gBAClG,MAAM,mBAAmB,GACrB,eAAe,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,UAAU,GAAG,eAAe,EAAE,CAAC,EAAE,CAAC,EAAE,MAAgB,CAAC,CAAA;gBACjG,MAAM,qBAAqB,GACvB,gBAAgB,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,YAAY,GAAG,gBAAgB,EAAE,CAAC,EAAE,CAAC,EAAE,MAAgB,CAAC,CAAA;gBACrG,MAAM,oBAAoB,GACtB,gBAAgB,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,WAAW,GAAG,gBAAgB,EAAE,CAAC,EAAE,CAAC,EAAE,MAAgB,CAAC,CAAA;gBAEpG,UAAU,GAAG,MAAM,CAAC,UAAU,EAAE;oBAC5B,0BAA0B,EAAE,WAAW;oBACvC,qCAAqC,EAAE,oBAAoB;oBAC3D,yBAAyB,EAAE,UAAU;oBACrC,oCAAoC,EAAE,mBAAmB;oBACzD,2BAA2B,EAAE,YAAY;oBACzC,sCAAsC,EAAE,qBAAqB;oBAC7D,0BAA0B,EAAE,WAAW;oBACvC,qCAAqC,EAAE,oBAAoB;iBAC9D,CAAC,CAAA;YACN,CAAC;QACL,CAAC;QAED,IAAI,gBAAgB,CAAC,QAAQ,EAAE,CAAC;YAC5B,UAAU,CAAC,uBAAuB,GAAG,gBAAgB,CAAC,QAAQ,CAAA;QAClE,CAAC;QACD,IAAI,gBAAgB,CAAC,SAAS,EAAE,CAAC;YAC7B,yFAAyF;YACzF,UAAU,CAAC,uBAAuB,GAAG,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,gBAAgB,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,GAAG,IAAI,CAAA;QAC5G,CAAC;QAED,OAAO,UAAU,CAAA;IACrB,CAAC;CACJ"}

package/lib/scroll-manager.d.ts

@@ -0,0 +1,21 @@
+import { Leanbase } from './leanbase';
+export interface ScrollContext {
+    maxScrollHeight?: number;
+    maxScrollY?: number;
+    lastScrollY?: number;
+    maxContentHeight?: number;
+    maxContentY?: number;
+    lastContentY?: number;
+}
+export declare class ScrollManager {
+    private _instance;
+    private _context;
+    constructor(_instance: Leanbase);
+    getContext(): ScrollContext | undefined;
+    resetContext(): ScrollContext | undefined;
+    private _updateScrollData;
+    startMeasuringScrollPosition(): void;
+    scrollElement(): Element | undefined;
+    scrollY(): number;
+    scrollX(): number;
+}

package/lib/scroll-manager.js

@@ -0,0 +1,79 @@
+import { window } from './utils';
+import { addEventListener } from './utils';
+import { isArray } from '@posthog/core';
+// This class is responsible for tracking scroll events and maintaining the scroll context
+export class ScrollManager {
+    constructor(_instance) {
+        this._instance = _instance;
+        this._updateScrollData = () => {
+            if (!this._context) {
+                this._context = {};
+            }
+            const el = this.scrollElement();
+            const scrollY = this.scrollY();
+            const scrollHeight = el ? Math.max(0, el.scrollHeight - el.clientHeight) : 0;
+            const contentY = scrollY + (el?.clientHeight || 0);
+            const contentHeight = el?.scrollHeight || 0;
+            this._context.lastScrollY = Math.ceil(scrollY);
+            this._context.maxScrollY = Math.max(scrollY, this._context.maxScrollY ?? 0);
+            this._context.maxScrollHeight = Math.max(scrollHeight, this._context.maxScrollHeight ?? 0);
+            this._context.lastContentY = contentY;
+            this._context.maxContentY = Math.max(contentY, this._context.maxContentY ?? 0);
+            this._context.maxContentHeight = Math.max(contentHeight, this._context.maxContentHeight ?? 0);
+        };
+    }
+    getContext() {
+        return this._context;
+    }
+    resetContext() {
+        const ctx = this._context;
+        // update the scroll properties for the new page, but wait until the next tick
+        // of the event loop
+        setTimeout(this._updateScrollData, 0);
+        return ctx;
+    }
+    // `capture: true` is required to get scroll events for other scrollable elements
+    // on the page, not just the window
+    // see https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener#usecapture
+    startMeasuringScrollPosition() {
+        addEventListener(window, 'scroll', this._updateScrollData, { capture: true });
+        addEventListener(window, 'scrollend', this._updateScrollData, { capture: true });
+        addEventListener(window, 'resize', this._updateScrollData);
+    }
+    scrollElement() {
+        if (this._instance.config.scroll_root_selector) {
+            const selectors = isArray(this._instance.config.scroll_root_selector)
+                ? this._instance.config.scroll_root_selector
+                : [this._instance.config.scroll_root_selector];
+            for (const selector of selectors) {
+                const element = window?.document.querySelector(selector);
+                if (element) {
+                    return element;
+                }
+            }
+            return undefined;
+        }
+        else {
+            return window?.document.documentElement;
+        }
+    }
+    scrollY() {
+        if (this._instance.config.scroll_root_selector) {
+            const element = this.scrollElement();
+            return (element && element.scrollTop) || 0;
+        }
+        else {
+            return window ? window.scrollY || window.pageYOffset || window.document.documentElement.scrollTop || 0 : 0;
+        }
+    }
+    scrollX() {
+        if (this._instance.config.scroll_root_selector) {
+            const element = this.scrollElement();
+            return (element && element.scrollLeft) || 0;
+        }
+        else {
+            return window ? window.scrollX || window.pageXOffset || window.document.documentElement.scrollLeft || 0 : 0;
+        }
+    }
+}
+//# sourceMappingURL=scroll-manager.js.map

package/lib/scroll-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scroll-manager.js","sourceRoot":"","sources":["../src/scroll-manager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAEhC,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAC1C,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AAevC,0FAA0F;AAC1F,MAAM,OAAO,aAAa;IAGtB,YAAoB,SAAmB;QAAnB,cAAS,GAAT,SAAS,CAAU;QAgB/B,sBAAiB,GAAG,GAAG,EAAE;YAC7B,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACjB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAA;YACtB,CAAC;YAED,MAAM,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,CAAA;YAE/B,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,EAAE,CAAA;YAC9B,MAAM,YAAY,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,YAAY,GAAG,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YAC5E,MAAM,QAAQ,GAAG,OAAO,GAAG,CAAC,EAAE,EAAE,YAAY,IAAI,CAAC,CAAC,CAAA;YAClD,MAAM,aAAa,GAAG,EAAE,EAAE,YAAY,IAAI,CAAC,CAAA;YAE3C,IAAI,CAAC,QAAQ,CAAC,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAC9C,IAAI,CAAC,QAAQ,CAAC,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,UAAU,IAAI,CAAC,CAAC,CAAA;YAC3E,IAAI,CAAC,QAAQ,CAAC,eAAe,GAAG,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,CAAC,QAAQ,CAAC,eAAe,IAAI,CAAC,CAAC,CAAA;YAE1F,IAAI,CAAC,QAAQ,CAAC,YAAY,GAAG,QAAQ,CAAA;YACrC,IAAI,CAAC,QAAQ,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,WAAW,IAAI,CAAC,CAAC,CAAA;YAC9E,IAAI,CAAC,QAAQ,CAAC,gBAAgB,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,IAAI,CAAC,QAAQ,CAAC,gBAAgB,IAAI,CAAC,CAAC,CAAA;QACjG,CAAC,CAAA;IAnCyC,CAAC;IAE3C,UAAU;QACN,OAAO,IAAI,CAAC,QAAQ,CAAA;IACxB,CAAC;IAED,YAAY;QACR,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAA;QAEzB,8EAA8E;QAC9E,oBAAoB;QACpB,UAAU,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC,CAAA;QAErC,OAAO,GAAG,CAAA;IACd,CAAC;IAuBD,iFAAiF;IACjF,mCAAmC;IACnC,+FAA+F;IAC/F,4BAA4B;QACxB,gBAAgB,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,iBAAiB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAA;QAC7E,gBAAgB,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,CAAC,iBAAiB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAA;QAChF,gBAAgB,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAA;IAC9D,CAAC;IAEM,aAAa;QAChB,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,oBAAoB,EAAE,CAAC;YAC7C,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,oBAAoB,CAAC;gBACjE,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,oBAAoB;gBAC5C,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAA;YAClD,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;gBAC/B,MAAM,OAAO,GAAG,MAAM,EAAE,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAA;gBACxD,IAAI,OAAO,EAAE,CAAC;oBACV,OAAO,OAAO,CAAA;gBAClB,CAAC;YACL,CAAC;YACD,OAAO,SAAS,CAAA;QACpB,CAAC;aAAM,CAAC;YACJ,OAAO,MAAM,EAAE,QAAQ,CAAC,eAAe,CAAA;QAC3C,CAAC;IACL,CAAC;IAEM,OAAO;QACV,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,oBAAoB,EAAE,CAAC;YAC7C,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,EAAE,CAAA;YACpC,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;QAC9C,CAAC;aAAM,CAAC;YACJ,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,WAAW,IAAI,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,SAAS,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QAC9G,CAAC;IACL,CAAC;IAEM,OAAO;QACV,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,oBAAoB,EAAE,CAAC;YAC7C,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,EAAE,CAAA;YACpC,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;QAC/C,CAAC;aAAM,CAAC;YACJ,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,WAAW,IAAI,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,UAAU,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QAC/G,CAAC;IACL,CAAC;CACJ"}

package/lib/session-props.d.ts

@@ -0,0 +1,32 @@
+import type { SessionIdManager } from './sessionid';
+import type { LeanbasePersistence } from './leanbase-persistence';
+import type { Leanbase } from './leanbase';
+interface LegacySessionSourceProps {
+    initialPathName: string;
+    referringDomain: string;
+    utm_medium?: string;
+    utm_source?: string;
+    utm_campaign?: string;
+    utm_content?: string;
+    utm_term?: string;
+}
+interface CurrentSessionSourceProps {
+    r: string;
+    u: string | undefined;
+}
+interface StoredSessionSourceProps {
+    sessionId: string;
+    props: LegacySessionSourceProps | CurrentSessionSourceProps;
+}
+export declare class SessionPropsManager {
+    private readonly _instance;
+    private readonly _sessionIdManager;
+    private readonly _persistence;
+    private readonly _sessionSourceParamGenerator;
+    constructor(instance: Leanbase, sessionIdManager: SessionIdManager, persistence: LeanbasePersistence, sessionSourceParamGenerator?: (instance?: Leanbase) => LegacySessionSourceProps | CurrentSessionSourceProps);
+    _getStored(): StoredSessionSourceProps | undefined;
+    _onSessionIdCallback: (sessionId: string) => void;
+    getSetOnceProps(): Record<string, any>;
+    getSessionProps(): Record<string, any>;
+}
+export {};

package/lib/session-props.js

@@ -0,0 +1,73 @@
+/* Store some session-level attribution-related properties in the persistence layer
+ *
+ * These have the same lifespan as a session_id, meaning that if the session_id changes, these properties will be reset.
+ *
+ * We only store the entry URL and referrer, and derive many props (such as utm tags) from those.
+ *
+ * Given that the cookie is limited to 4K bytes, we don't want to store too much data, so we chose not to store device
+ * properties (such as browser, OS, etc) here, as usually getting the current value of those from event properties is
+ * sufficient.
+ */
+import { getPersonInfo, getPersonPropsFromInfo } from './utils/event-utils';
+import { CLIENT_SESSION_PROPS } from './constants';
+import { each, stripEmptyProperties } from './utils';
+import { stripLeadingDollar } from '@posthog/core';
+const generateSessionSourceParams = (posthog) => {
+    return getPersonInfo(posthog?.config.mask_personal_data_properties, posthog?.config.custom_personal_data_properties);
+};
+export class SessionPropsManager {
+    constructor(instance, sessionIdManager, persistence, sessionSourceParamGenerator) {
+        this._onSessionIdCallback = (sessionId) => {
+            const stored = this._getStored();
+            if (stored && stored.sessionId === sessionId) {
+                return;
+            }
+            const newProps = {
+                sessionId,
+                props: this._sessionSourceParamGenerator(this._instance),
+            };
+            this._persistence.register({ [CLIENT_SESSION_PROPS]: newProps });
+        };
+        this._instance = instance;
+        this._sessionIdManager = sessionIdManager;
+        this._persistence = persistence;
+        this._sessionSourceParamGenerator = sessionSourceParamGenerator || generateSessionSourceParams;
+        this._sessionIdManager.onSessionId(this._onSessionIdCallback);
+    }
+    _getStored() {
+        return this._persistence.props[CLIENT_SESSION_PROPS];
+    }
+    getSetOnceProps() {
+        const p = this._getStored()?.props;
+        if (!p) {
+            return {};
+        }
+        if ('r' in p) {
+            return getPersonPropsFromInfo(p);
+        }
+        else {
+            return {
+                $referring_domain: p.referringDomain,
+                $pathname: p.initialPathName,
+                utm_source: p.utm_source,
+                utm_campaign: p.utm_campaign,
+                utm_medium: p.utm_medium,
+                utm_content: p.utm_content,
+                utm_term: p.utm_term,
+            };
+        }
+    }
+    getSessionProps() {
+        // it's the same props, but don't include null for unset properties, and add a prefix
+        const p = {};
+        each(stripEmptyProperties(this.getSetOnceProps()), (v, k) => {
+            if (k === '$current_url') {
+                // $session_entry_current_url would be a weird name, call it $session_entry_url instead
+                k = 'url';
+            }
+            p[`$session_entry_${stripLeadingDollar(k)}`] = v;
+        });
+        return p;
+    }
+}
+//# sourceMappingURL=session-props.js.map

package/lib/session-props.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"session-props.js","sourceRoot":"","sources":["../src/session-props.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAE,aAAa,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAA;AAG3E,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAA;AAElD,OAAO,EAAE,IAAI,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AACpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAsBlD,MAAM,2BAA2B,GAAG,CAAC,OAAkB,EAAwD,EAAE;IAC7G,OAAO,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC,6BAA6B,EAAE,OAAO,EAAE,MAAM,CAAC,+BAA+B,CAAC,CAAA;AACxH,CAAC,CAAA;AAED,MAAM,OAAO,mBAAmB;IAQ5B,YACI,QAAkB,EAClB,gBAAkC,EAClC,WAAgC,EAChC,2BAA2G;QAc/G,yBAAoB,GAAG,CAAC,SAAiB,EAAE,EAAE;YACzC,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,EAAE,CAAA;YAChC,IAAI,MAAM,IAAI,MAAM,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC3C,OAAM;YACV,CAAC;YAED,MAAM,QAAQ,GAA6B;gBACvC,SAAS;gBACT,KAAK,EAAE,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,SAAS,CAAC;aAC3D,CAAA;YACD,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,oBAAoB,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAA;QACpE,CAAC,CAAA;QAvBG,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAA;QACzB,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAA;QACzC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAA;QAC/B,IAAI,CAAC,4BAA4B,GAAG,2BAA2B,IAAI,2BAA2B,CAAA;QAE9F,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAA;IACjE,CAAC;IAED,UAAU;QACN,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAA;IACxD,CAAC;IAeD,eAAe;QACX,MAAM,CAAC,GAAG,IAAI,CAAC,UAAU,EAAE,EAAE,KAAK,CAAA;QAClC,IAAI,CAAC,CAAC,EAAE,CAAC;YACL,OAAO,EAAE,CAAA;QACb,CAAC;QACD,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC;YACX,OAAO,sBAAsB,CAAC,CAAC,CAAC,CAAA;QACpC,CAAC;aAAM,CAAC;YACJ,OAAO;gBACH,iBAAiB,EAAE,CAAC,CAAC,eAAe;gBACpC,SAAS,EAAE,CAAC,CAAC,eAAe;gBAC5B,UAAU,EAAE,CAAC,CAAC,UAAU;gBACxB,YAAY,EAAE,CAAC,CAAC,YAAY;gBAC5B,UAAU,EAAE,CAAC,CAAC,UAAU;gBACxB,WAAW,EAAE,CAAC,CAAC,WAAW;gBAC1B,QAAQ,EAAE,CAAC,CAAC,QAAQ;aACvB,CAAA;QACL,CAAC;IACL,CAAC;IAED,eAAe;QACX,qFAAqF;QACrF,MAAM,CAAC,GAAwB,EAAE,CAAA;QACjC,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YACxD,IAAI,CAAC,KAAK,cAAc,EAAE,CAAC;gBACvB,uFAAuF;gBACvF,CAAC,GAAG,KAAK,CAAA;YACb,CAAC;YACD,CAAC,CAAC,kBAAkB,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAA;QACpD,CAAC,CAAC,CAAA;QACF,OAAO,CAAC,CAAA;IACZ,CAAC;CACJ"}