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

package/{src/types.ts → dist/types.d.ts}

@@ -1,22 +1,16 @@
-import { FeatureFlagValue, JsonType, PostHogCoreOptions } from '@posthog/core'
-import { KnownUnsafeEditableEvent } from '@posthog/core'
-import { Leanbase } from './leanbase'
-
-export const COPY_AUTOCAPTURE_EVENT = '$copy_autocapture'
-
-export type Property = any
-export type Properties = Record<string, Property>
-
-export type AutocaptureCompatibleElement = 'a' | 'button' | 'form' | 'input' | 'select' | 'textarea' | 'label'
-
-export type DomAutocaptureEvents = 'click' | 'change' | 'submit'
-
+import { FeatureFlagValue, JsonType, PostHogCoreOptions } from '@posthog/core';
+import { KnownUnsafeEditableEvent } from '@posthog/core';
+import { Leanbase } from './leanbase';
+export declare const COPY_AUTOCAPTURE_EVENT = "$copy_autocapture";
+export type Property = any;
+export type Properties = Record<string, Property>;
+export type AutocaptureCompatibleElement = 'a' | 'button' | 'form' | 'input' | 'select' | 'textarea' | 'label';
+export type DomAutocaptureEvents = 'click' | 'change' | 'submit';
 export interface BootstrapConfig {
-    distinctId?: string
-    isIdentifiedId?: boolean
-    featureFlags?: Record<string, FeatureFlagValue>
-    featureFlagPayloads?: Record<string, JsonType>
-
+    distinctId?: string;
+    isIdentifiedId?: boolean;
+    featureFlags?: Record<string, FeatureFlagValue>;
+    featureFlagPayloads?: Record<string, JsonType>;
     /**
      * Optionally provide a sessionID, this is so that you can provide an existing sessionID here to continue a user's session across a domain or device. It MUST be:
      * - unique to this user
@@ -24,9 +18,8 @@ export interface BootstrapConfig {
      * - the timestamp part must be <= the timestamp of the first event in the session
      * - the timestamp of the last event in the session must be < the timestamp part + 24 hours
      * **/
-    sessionID?: string
+    sessionID?: string;
 }
-
 /**
  * If an array is passed for an allowlist, autocapture events will only be sent for elements matching
  * at least one of the elements in the array. Multiple allowlists can be used
@@ -41,8 +34,7 @@ export interface AutocaptureConfig {
      * we check the allowlist first and then the ignorelist.
      * the ignorelist can override the allowlist
      */
-    url_allowlist?: (string | RegExp)[]
-
+    url_allowlist?: (string | RegExp)[];
     /**
      * List of URLs to not allow autocapture on, can be strings to match
      * or regexes e.g. ['https://example.com', 'test.com/.*']
@@ -52,13 +44,11 @@ export interface AutocaptureConfig {
      * we check the allowlist first and then the ignorelist.
      * the ignorelist can override the allowlist
      */
-    url_ignorelist?: (string | RegExp)[]
-
+    url_ignorelist?: (string | RegExp)[];
     /**
      * List of DOM events to allow autocapture on  e.g. ['click', 'change', 'submit']
      */
-    dom_event_allowlist?: DomAutocaptureEvents[]
-
+    dom_event_allowlist?: DomAutocaptureEvents[];
     /**
      * List of DOM elements to allow autocapture on
      * e.g. ['a', 'button', 'form', 'input', 'select', 'textarea', 'label']
@@ -68,8 +58,7 @@ export interface AutocaptureConfig {
      * if the allowlist has `button` then we allow the capture when the `button` or the `svg` is the click target
      * but not if either of the `div`s are detected as the click target
      */
-    element_allowlist?: AutocaptureCompatibleElement[]
-
+    element_allowlist?: AutocaptureCompatibleElement[];
     /**
      * List of CSS selectors to allow autocapture on
      * e.g. ['[ph-capture]']
@@ -80,39 +69,33 @@ export interface AutocaptureConfig {
      *
      * Everything is allowed when there's no allowlist
      */
-    css_selector_allowlist?: string[]
-
+    css_selector_allowlist?: string[];
     /**
      * Exclude certain element attributes from autocapture
      * E.g. ['aria-label'] or [data-attr-pii]
      */
-    element_attribute_ignorelist?: string[]
-
+    element_attribute_ignorelist?: string[];
     /**
      * When set to true, autocapture will capture the text of any element that is cut or copied.
      */
-    capture_copied_text?: boolean
+    capture_copied_text?: boolean;
 }
-
 export interface LeanbaseConfig extends Partial<PostHogCoreOptions> {
     /**
      * API host for Leanbase
      * @default 'https://i.leanbase.co'
      */
-    host?: string
-
+    host?: string;
     /**
      * The token for your Leanbase project.
      * It should NOT be provided manually in the config, but rather passed as the first parameter to `leanbase.init()`.
      */
-    token: string
-
+    token: string;
     /**
      * Enables debug mode, which provides more verbose logging for development purposes.
      * @default false
      */
-    debug?: boolean
-
+    debug?: boolean;
     /**
      * Determines whether Leanbase should autocapture events.
      * This setting does not affect capturing pageview events (see `capture_pageview`).
@@ -120,8 +103,7 @@ export interface LeanbaseConfig extends Partial<PostHogCoreOptions> {
      * by default autocapture is ignored on elements that match a `ph-no-capture` css class on the element or a parent
      * @default true
      */
-    autocapture: boolean | AutocaptureConfig
-
+    autocapture: boolean | AutocaptureConfig;
     /**
      * Determines whether Leanbase should capture pageview events automatically.
      * Can be:
@@ -131,16 +113,14 @@ export interface LeanbaseConfig extends Partial<PostHogCoreOptions> {
      *
      * @default true
      */
-    capture_pageview: boolean | 'history_change'
-
+    capture_pageview: boolean | 'history_change';
     /**
      * Determines the session idle timeout in seconds.
      * Any new event that's happened after this timeout will create a new session.
      *
      * @default 30 * 60 -- 30 minutes
      */
-    session_idle_timeout_seconds: number
-
+    session_idle_timeout_seconds: number;
     /**
      * An object containing the `distinctID`, `isIdentifiedID`, and `featureFlags` keys,
      * where `distinctID` is a string, and `featureFlags` is an object of key-value pairs.
@@ -157,8 +137,7 @@ export interface LeanbaseConfig extends Partial<PostHogCoreOptions> {
      *
      * @default {}
      */
-    bootstrap: BootstrapConfig
-
+    bootstrap: BootstrapConfig;
     /**
      * Determines whether Leanbase should capture pageleave events.
      * If set to `true`, it will capture pageleave events for all pages.
@@ -166,50 +145,43 @@ export interface LeanbaseConfig extends Partial<PostHogCoreOptions> {
      *
      * @default 'if_capture_pageview'
      */
-    capture_pageleave: boolean | 'if_capture_pageview'
-
+    capture_pageleave: boolean | 'if_capture_pageview';
     /**
      * Determines whether Leanbase should capture rage clicks.
      *
      * by default rageclicks are ignored on elements that match a `ph-no-capture` or `ph-no-rageclick` css class on the element or a parent
      * @default true
      */
-    rageclick: boolean | RageclickConfig
-
+    rageclick: boolean | RageclickConfig;
     /**
      * Determines where to store the Leanbase persistence information.
      */
-    persistence: 'localStorage' | 'cookie' | 'memory' | 'localStorage+cookie' | 'sessionStorage'
-
+    persistence: 'localStorage' | 'cookie' | 'memory' | 'localStorage+cookie' | 'sessionStorage';
     /**
      * The name for the super properties persistent store
      *
      * @default ''
      */
-    persistence_name: string
-
+    persistence_name: string;
     /**
      * Prevent autocapture from capturing any attribute names on elements.
      *
      * @default false
      */
-    mask_all_element_attributes: boolean
-
+    mask_all_element_attributes: boolean;
     /**
      * Prevent autocapture from capturing `textContent` on elements.
      *
      * @default false
      */
-    mask_all_text: boolean
-
+    mask_all_text: boolean;
     /**
      * Used to extend the list of campaign parameters that are saved by default.
      *
      * @see {CAMPAIGN_PARAMS} from './utils/event-utils' - Default campaign parameters like utm_source, utm_medium, etc.
      * @default []
      */
-    custom_campaign_params: string[]
-
+    custom_campaign_params: string[];
     /**
      * Mask personal data properties from the current URL.
      * This will mask personal data properties such as advertising IDs (gclid, fbclid, etc.), and you can also add
@@ -218,8 +190,7 @@ export interface LeanbaseConfig extends Partial<PostHogCoreOptions> {
      * @see {PERSONAL_DATA_CAMPAIGN_PARAMS} - Default campaign parameters that are masked by default.
      * @see {LeanbaseConfig.custom_personal_data_properties} - Custom list of personal data properties to mask.
      */
-    mask_personal_data_properties: boolean
-
+    mask_personal_data_properties: boolean;
     /**
      * Custom list of personal data properties to mask.
      *
@@ -229,15 +200,13 @@ export interface LeanbaseConfig extends Partial<PostHogCoreOptions> {
      * @default []
      * @see {LeanbaseConfig.mask_personal_data_properties} - Must be enabled for this to take effect.
      */
-    custom_personal_data_properties: string[]
-
+    custom_personal_data_properties: string[];
     /**
      * Determines the number of days to store cookies for.
      *
      * @default 365
      */
-    cookie_expiration: number
-
+    cookie_expiration: number;
     /**
      * Determines whether Leanbase should use secure cookies.
      * If this is `true`, Leanbase cookies will be marked as secure,
@@ -245,8 +214,7 @@ export interface LeanbaseConfig extends Partial<PostHogCoreOptions> {
      *
      * @default window.location.protocol === 'https:'
      */
-    secure_cookie: boolean
-
+    secure_cookie: boolean;
     /**
      * Determines if cookie should be set on the top level domain (example.com).
      * If leanbase-js is loaded on a subdomain (test.example.com), and `cross_subdomain_cookie` is set to false,
@@ -258,16 +226,14 @@ export interface LeanbaseConfig extends Partial<PostHogCoreOptions> {
      * @see `isCrossDomainCookie`
      * @default true
      */
-    cross_subdomain_cookie: boolean
-
+    cross_subdomain_cookie: boolean;
     /**
      * Determines whether Leanbase should disable persistence.
      * If set to `true`, the library will not save any data to the browser. It will also delete any data previously saved to the browser.
      *
      * @default false
      */
-    disable_persistence: boolean
-
+    disable_persistence: boolean;
     /**
      * Enables cookieless mode. In this mode, Leanbase will not set any cookies, or use session or local storage. User
      * identity is handled by generating a privacy-preserving hash on Leanbase's servers.
@@ -276,15 +242,13 @@ export interface LeanbaseConfig extends Partial<PostHogCoreOptions> {
      *
      * Note that you MUST enable cookieless mode in your Leanbase project's settings, otherwise all your cookieless events will be ignored. We plan to remove this requirement in the future.
      * */
-    cookieless_mode?: 'always' | 'on_reject'
-
+    cookieless_mode?: 'always' | 'on_reject';
     /**
      * Determines whether PostHog should save referrer information.
      *
      * @default true
      */
-    save_referrer: boolean
-
+    save_referrer: boolean;
     /**
      * Determines whether PostHog should save marketing parameters.
      * These are `utm_*` paramaters and friends.
@@ -292,22 +256,19 @@ export interface LeanbaseConfig extends Partial<PostHogCoreOptions> {
      * @see {CAMPAIGN_PARAMS} from './utils/event-utils' - Default campaign parameters like utm_source, utm_medium, etc.
      * @default true
      */
-    save_campaign_params: boolean
-
+    save_campaign_params: boolean;
     /**
      * Determines whether to disable scroll properties.
      * These allow you to keep track of how far down someone scrolled in your website.
      *
      * @default false
      */
-    disable_scroll_properties?: boolean
-
+    disable_scroll_properties?: boolean;
     /**
      * Let the pageview scroll stats use a custom css selector for the root element, e.g. `main`
      * It will use `window.document.documentElement` if not specified.
      */
-    scroll_root_selector?: string | string[]
-
+    scroll_root_selector?: string | string[];
     /**
      * Determines if users should be opted out of user agent filtering such as googlebot or other bots.
      * If this is set to `true`, PostHog will set `$browser_type` to either `bot` or `browser` for all events,
@@ -315,23 +276,20 @@ export interface LeanbaseConfig extends Partial<PostHogCoreOptions> {
      *
      * @default false
      */
-    opt_out_useragent_filter: boolean
-
+    opt_out_useragent_filter: boolean;
     /**
      * Determines the maximum length of the properties string that can be sent with capture calls.
      *
      * @default 65535
      */
-    properties_string_max_length: number
-
+    properties_string_max_length: number;
     /**
      * A function to be called once the Leanbase scripts have loaded successfully.
      *
      * @param instance - The Leanbase instance that has been loaded.
      */
-    loaded: (instance: Leanbase) => void
+    loaded: (instance: Leanbase) => void;
 }
-
 export interface RageclickConfig {
     /**
      * List of CSS selectors to ignore rageclicks on
@@ -345,41 +303,33 @@ export interface RageclickConfig {
      * If no ignorelist is set, we default to ignoring .ph-no-rageclick
      * If an element has .ph-no-capture, it will always be ignored by rageclick and autocapture
      */
-    css_selector_ignorelist?: string[]
+    css_selector_ignorelist?: string[];
 }
-
-export type PropertyMatchType = 'regex' | 'not_regex' | 'exact' | 'is_not' | 'icontains' | 'not_icontains'
-
+export type PropertyMatchType = 'regex' | 'not_regex' | 'exact' | 'is_not' | 'icontains' | 'not_icontains';
 export interface ErrorTrackingSuppressionRule {
-    type: 'AND' | 'OR'
-    values: ErrorTrackingSuppressionRuleValue[]
+    type: 'AND' | 'OR';
+    values: ErrorTrackingSuppressionRuleValue[];
 }
-
 export interface ErrorTrackingSuppressionRuleValue {
-    key: '$exception_types' | '$exception_values'
-    operator: PropertyMatchType
-    value: string | string[]
-    type: string
+    key: '$exception_types' | '$exception_values';
+    operator: PropertyMatchType;
+    value: string | string[];
+    type: string;
 }
-
-export enum Compression {
-    GZipJS = 'gzip-js',
-    Base64 = 'base64',
+export declare enum Compression {
+    GZipJS = "gzip-js",
+    Base64 = "base64"
 }
-
-export type SupportedWebVitalsMetrics = 'LCP' | 'CLS' | 'FCP' | 'INP'
-
+export type SupportedWebVitalsMetrics = 'LCP' | 'CLS' | 'FCP' | 'INP';
 export interface PerformanceCaptureConfig {
     /**
      *  Works with session replay to use the browser's native performance observer to capture performance metrics
      */
-    network_timing?: boolean
-
+    network_timing?: boolean;
     /**
      * Use chrome's web vitals library to wrap fetch and capture web vitals
      */
-    web_vitals?: boolean
-
+    web_vitals?: boolean;
     /**
      * We observe very large values reported by the Chrome web vitals library
      * These outliers are likely not real, useful values, and we exclude them
@@ -387,8 +337,7 @@ export interface PerformanceCaptureConfig {
      *
      * @default 15 * 60 * 1000 (15 minutes)
      */
-    __web_vitals_max_value?: number
-
+    __web_vitals_max_value?: number;
     /**
      * By default all 4 metrics are captured
      * You can set this config to restrict which metrics are captured
@@ -397,17 +346,15 @@ export interface PerformanceCaptureConfig {
      *
      * @default ['LCP', 'CLS', 'FCP', 'INP']
      */
-    web_vitals_allowed_metrics?: SupportedWebVitalsMetrics[]
-
+    web_vitals_allowed_metrics?: SupportedWebVitalsMetrics[];
     /**
      * We delay flushing web vitals metrics to reduce the number of events we send
      * This is the maximum time we will wait before sending the metrics
      *
      * @default 5000
      */
-    web_vitals_delayed_flush_ms?: number
+    web_vitals_delayed_flush_ms?: number;
 }
-
 /**
  * Remote configuration for the Leanbase instance
  *
@@ -418,13 +365,11 @@ export interface RemoteConfig {
     /**
      * Supported compression algorithms
      */
-    supportedCompression: Compression[]
-
+    supportedCompression: Compression[];
     /**
      * If set, disables autocapture
      */
-    autocapture_opt_out?: boolean
-
+    autocapture_opt_out?: boolean;
     /**
      *     originally capturePerformance was replay only and so boolean true
      *     is equivalent to { network_timing: true }
@@ -434,201 +379,166 @@ export interface RemoteConfig {
      *     they work standalone but enhance each other
      *     TODO: deprecate this so we make a new config that doesn't need this explanation
      */
-    capturePerformance?: boolean | PerformanceCaptureConfig
-
+    capturePerformance?: boolean | PerformanceCaptureConfig;
     /**
      * Whether we should use a custom endpoint for analytics
      *
      * @default { endpoint: "/e" }
      */
     analytics?: {
-        endpoint?: string
-    }
-
+        endpoint?: string;
+    };
     /**
      * Whether the `$elements_chain` property should be sent as a string or as an array
      *
      * @default false
      */
-    elementsChainAsString?: boolean
-
+    elementsChainAsString?: boolean;
     /**
      * Error tracking configuration options
      */
     errorTracking?: {
-        autocaptureExceptions?: boolean
-        captureExtensionExceptions?: boolean
-        suppressionRules?: ErrorTrackingSuppressionRule[]
-    }
-
+        autocaptureExceptions?: boolean;
+        captureExtensionExceptions?: boolean;
+        suppressionRules?: ErrorTrackingSuppressionRule[];
+    };
     /**
      * This is currently in development and may have breaking changes without a major version bump
      */
-    autocaptureExceptions?: boolean | { endpoint?: string }
-
+    autocaptureExceptions?: boolean | {
+        endpoint?: string;
+    };
     /**
      * @deprecated, moved to toolbarParams
      */
-    toolbarVersion: 'toolbar'
-
+    toolbarVersion: 'toolbar';
     /**
      * Whether the user is authenticated
      */
-    isAuthenticated: boolean
-
+    isAuthenticated: boolean;
     /**
      * List of site apps with their IDs and URLs
      */
-    siteApps: { id: string; url: string }[]
-
+    siteApps: {
+        id: string;
+        url: string;
+    }[];
     /**
      * Whether heatmaps are enabled
      */
-    heatmaps?: boolean
-
+    heatmaps?: boolean;
     /**
      * Whether to only capture identified users by default
      */
-    defaultIdentifiedOnly?: boolean
-
+    defaultIdentifiedOnly?: boolean;
     /**
      * Whether to capture dead clicks
      */
-    captureDeadClicks?: boolean
-
+    captureDeadClicks?: boolean;
     /**
      * Indicates if the team has any flags enabled (if not we don't need to load them)
      */
-    hasFeatureFlags?: boolean
+    hasFeatureFlags?: boolean;
 }
-
 /**
  * These are known events Leanbase events that can be processed by the `beforeCapture` function
  * That means Leanbase functionality does not rely on receiving 100% of these for calculations
  * So, it is safe to sample them to reduce the volume of events sent to Leanbase
  */
-export type KnownEventName =
-    | '$heatmaps_data'
-    | '$opt_in'
-    | '$exception'
-    | '$$heatmap'
-    | '$web_vitals'
-    | '$dead_click'
-    | '$autocapture'
-    | typeof COPY_AUTOCAPTURE_EVENT
-    | '$rageclick'
-
-export type EventName = KnownUnsafeEditableEvent | KnownEventName | (string & {})
-
+export type KnownEventName = '$heatmaps_data' | '$opt_in' | '$exception' | '$$heatmap' | '$web_vitals' | '$dead_click' | '$autocapture' | typeof COPY_AUTOCAPTURE_EVENT | '$rageclick';
+export type EventName = KnownUnsafeEditableEvent | KnownEventName | (string & {});
 export interface PersistentStore {
-    _is_supported: () => boolean
-    _error: (error: any) => void
-    _parse: (name: string) => any
-    _get: (name: string) => any
-    _set: (
-        name: string,
-        value: any,
-        expire_days?: number | null,
-        cross_subdomain?: boolean,
-        secure?: boolean,
-        debug?: boolean
-    ) => void
-    _remove: (name: string, cross_subdomain?: boolean) => void
+    _is_supported: () => boolean;
+    _error: (error: any) => void;
+    _parse: (name: string) => any;
+    _get: (name: string) => any;
+    _set: (name: string, value: any, expire_days?: number | null, cross_subdomain?: boolean, secure?: boolean, debug?: boolean) => void;
+    _remove: (name: string, cross_subdomain?: boolean) => void;
 }
-
 export interface RequestResponse {
-    statusCode: number
-    text?: string
-    json?: any
+    statusCode: number;
+    text?: string;
+    json?: any;
 }
-
-export type RequestCallback = (response: RequestResponse) => void
-
-// See https://nextjs.org/docs/app/api-reference/functions/fetch#fetchurl-options
-type NextOptions = { revalidate: false | 0 | number; tags: string[] }
-
+export type RequestCallback = (response: RequestResponse) => void;
+type NextOptions = {
+    revalidate: false | 0 | number;
+    tags: string[];
+};
 export interface RequestWithOptions {
-    url: string
-    data?: Record<string, any> | Record<string, any>[]
-    headers?: Record<string, any>
-    transport?: 'XHR' | 'fetch' | 'sendBeacon'
-    method?: 'POST' | 'GET'
-    urlQueryArgs?: { compression: Compression }
-    callback?: RequestCallback
-    timeout?: number
-    noRetries?: boolean
-    disableTransport?: ('XHR' | 'fetch' | 'sendBeacon')[]
-    disableXHRCredentials?: boolean
-    compression?: Compression | 'best-available'
+    url: string;
+    data?: Record<string, any> | Record<string, any>[];
+    headers?: Record<string, any>;
+    transport?: 'XHR' | 'fetch' | 'sendBeacon';
+    method?: 'POST' | 'GET';
+    urlQueryArgs?: {
+        compression: Compression;
+    };
+    callback?: RequestCallback;
+    timeout?: number;
+    noRetries?: boolean;
+    disableTransport?: ('XHR' | 'fetch' | 'sendBeacon')[];
+    disableXHRCredentials?: boolean;
+    compression?: Compression | 'best-available';
     fetchOptions?: {
-        cache?: RequestInit['cache']
-        next?: NextOptions
-    }
+        cache?: RequestInit['cache'];
+        next?: NextOptions;
+    };
 }
-
-export type SessionIdChangedCallback = (
-    sessionId: string,
-    windowId: string | null | undefined,
-    changeReason?: { noSessionId: boolean; activityTimeout: boolean; sessionPastMaximumLength: boolean }
-) => void
-
+export type SessionIdChangedCallback = (sessionId: string, windowId: string | null | undefined, changeReason?: {
+    noSessionId: boolean;
+    activityTimeout: boolean;
+    sessionPastMaximumLength: boolean;
+}) => void;
 export type LeanbasegCaptureOptions = {
     /** If provided overrides the auto-generated event ID */
-    uuid?: string
-    disableGeoip?: boolean
+    uuid?: string;
+    disableGeoip?: boolean;
     /**
      * Used when `$identify` is called
      * Will set person properties overriding previous values
      */
-    $set?: Properties
-
+    $set?: Properties;
     /**
      * Used when `$identify` is called
      * Will set person properties but only once, it will NOT override previous values
      */
-    $set_once?: Properties
-
+    $set_once?: Properties;
     /**
      * Used to override the desired endpoint for the captured event
      */
-    _url?: string
-
+    _url?: string;
     /**
      * key of queue, e.g. 'sessionRecording' vs 'event'
      */
-    _batchKey?: string
-
+    _batchKey?: string;
     /**
      * If set, overrides and disables config.properties_string_max_length
      */
-    _noTruncate?: boolean
-
+    _noTruncate?: boolean;
     /**
      * If set, skips the batched queue
      */
-    send_instantly?: boolean
-
+    send_instantly?: boolean;
     /**
      * If set, skips the client side rate limiting
      */
-    skip_client_rate_limiting?: boolean
-
+    skip_client_rate_limiting?: boolean;
     /**
      * If set, overrides the desired transport method
      */
-    transport?: RequestWithOptions['transport']
-
+    transport?: RequestWithOptions['transport'];
     /**
      * If set, overrides the current timestamp
      */
-    timestamp?: Date
-}
-
+    timestamp?: Date;
+};
 export interface CaptureResult {
-    uuid: string
-    event: EventName
-    properties: Properties
-    $set?: Properties
-    $set_once?: Properties
-    timestamp?: Date
+    uuid: string;
+    event: EventName;
+    properties: Properties;
+    $set?: Properties;
+    $set_once?: Properties;
+    timestamp?: Date;
 }
+export {};