posthog-js 1.76.0 → 1.77.1

package/lib/src/types.d.ts

@@ -0,0 +1,294 @@
+import type { MaskInputOptions, SlimDOMOptions } from 'rrweb-snapshot';
+import { PostHog } from './posthog-core';
+import { RetryQueue } from './retry-queue';
+export declare type Property = any;
+export declare type Properties = Record<string, Property>;
+export interface CaptureResult {
+    uuid: string;
+    event: string;
+    properties: Properties;
+    $set?: Properties;
+    $set_once?: Properties;
+    timestamp?: Date;
+}
+export declare type CaptureCallback = (response: any, data: any) => void;
+export declare type AutocaptureCompatibleElement = 'a' | 'button' | 'form' | 'input' | 'select' | 'textarea' | 'label';
+export declare type DomAutocaptureEvents = 'click' | 'change' | 'submit';
+/**
+ * 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
+ */
+export interface AutocaptureConfig {
+    /**
+     * List of URLs to allow autocapture on, can be strings to match
+     * or regexes e.g. ['https://example.com', 'test.com/.*']
+     */
+    url_allowlist?: (string | RegExp)[];
+    /**
+     * List of DOM events to allow autocapture on  e.g. ['click', 'change', 'submit']
+     */
+    dom_event_allowlist?: DomAutocaptureEvents[];
+    /**
+     * List of DOM elements to allow autocapture on
+     * e.g. ['a', 'button', 'form', 'input', 'select', 'textarea', 'label']
+     */
+    element_allowlist?: AutocaptureCompatibleElement[];
+    /**
+     * List of CSS selectors to allow autocapture on
+     * e.g. ['[ph-capture]']
+     */
+    css_selector_allowlist?: string[];
+}
+export declare type UUIDVersion = 'og' | 'v7';
+export interface PostHogConfig {
+    api_host: string;
+    api_method: string;
+    api_transport: string;
+    ui_host: string | null;
+    token: string;
+    autocapture: boolean | AutocaptureConfig;
+    rageclick: boolean;
+    cross_subdomain_cookie: boolean;
+    persistence: 'localStorage' | 'cookie' | 'memory' | 'localStorage+cookie' | 'sessionStorage';
+    persistence_name: string;
+    cookie_name: string;
+    loaded: (posthog_instance: PostHog) => void;
+    store_google: boolean;
+    custom_campaign_params: string[];
+    save_referrer: boolean;
+    test: boolean;
+    verbose: boolean;
+    capture_pageview: boolean;
+    capture_pageleave: boolean;
+    debug: boolean;
+    cookie_expiration: number;
+    upgrade: boolean;
+    disable_session_recording: boolean;
+    disable_persistence: boolean;
+    disable_cookie: boolean;
+    enable_recording_console_log?: boolean;
+    secure_cookie: boolean;
+    ip: boolean;
+    opt_out_capturing_by_default: boolean;
+    opt_out_persistence_by_default: boolean;
+    opt_out_capturing_persistence_type: 'localStorage' | 'cookie';
+    opt_out_capturing_cookie_prefix: string | null;
+    opt_in_site_apps: boolean;
+    respect_dnt: boolean;
+    property_blacklist: string[];
+    xhr_headers: {
+        [header_name: string]: string;
+    };
+    on_xhr_error: (failedRequest: XMLHttpRequest) => void;
+    inapp_protocol: string;
+    inapp_link_new_window: boolean;
+    request_batching: boolean;
+    sanitize_properties: ((properties: Properties, event_name: string) => Properties) | null;
+    properties_string_max_length: number;
+    session_recording: SessionRecordingOptions;
+    session_idle_timeout_seconds: number;
+    mask_all_element_attributes: boolean;
+    mask_all_text: boolean;
+    advanced_disable_decide: boolean;
+    advanced_disable_feature_flags: boolean;
+    advanced_disable_feature_flags_on_first_load: boolean;
+    advanced_disable_toolbar_metrics: boolean;
+    get_device_id: (uuid: string) => string;
+    name: string;
+    callback_fn: string;
+    _onCapture: (eventName: string, eventData: CaptureResult) => void;
+    capture_performance?: boolean;
+    disable_compression: boolean;
+    bootstrap: {
+        distinctID?: string;
+        isIdentifiedID?: boolean;
+        featureFlags?: Record<string, boolean | string>;
+        featureFlagPayloads?: Record<string, JsonType>;
+    };
+    segment?: any;
+    __preview_measure_pageview_stats?: boolean;
+}
+export interface OptInOutCapturingOptions {
+    capture: (event: string, properties: Properties, options: CaptureOptions) => void;
+    capture_event_name: string;
+    capture_properties: Properties;
+    enable_persistence: boolean;
+    clear_persistence: boolean;
+    persistence_type: 'cookie' | 'localStorage' | 'localStorage+cookie';
+    cookie_prefix: string;
+    cookie_expiration: number;
+    cross_subdomain_cookie: boolean;
+    secure_cookie: boolean;
+}
+export interface isFeatureEnabledOptions {
+    send_event: boolean;
+}
+export interface SessionRecordingOptions {
+    blockClass?: string | RegExp;
+    blockSelector?: string | null;
+    ignoreClass?: string;
+    maskTextClass?: string | RegExp;
+    maskTextSelector?: string | null;
+    maskTextFn?: ((text: string) => string) | null;
+    maskAllInputs?: boolean;
+    maskInputOptions?: MaskInputOptions;
+    maskInputFn?: ((text: string, element?: HTMLElement) => string) | null;
+    /** Modify the network request before it is captured. Returning null stops it being captured */
+    maskNetworkRequestFn?: ((url: NetworkRequest) => NetworkRequest | null | undefined) | null;
+    slimDOMOptions?: SlimDOMOptions | 'all' | true;
+    collectFonts?: boolean;
+    inlineStylesheet?: boolean;
+    recorderVersion?: 'v1' | 'v2';
+    recordCrossOriginIframes?: boolean;
+}
+export declare type SessionIdChangedCallback = (sessionId: string, windowId: string | null | undefined) => void;
+export declare enum Compression {
+    GZipJS = "gzip-js",
+    Base64 = "base64"
+}
+export interface XHROptions {
+    transport?: 'XHR' | 'sendBeacon';
+    method?: 'POST' | 'GET';
+    urlQueryArgs?: {
+        compression: Compression;
+    };
+    verbose?: boolean;
+    blob?: boolean;
+    sendBeacon?: boolean;
+}
+export interface CaptureOptions extends XHROptions {
+    $set?: Properties; /** used with $identify */
+    $set_once?: Properties; /** used with $identify */
+    _batchKey?: string; /** key of queue, e.g. 'sessionRecording' vs 'event' */
+    _metrics?: Properties;
+    _noTruncate?: boolean; /** if set, overrides and disables config.properties_string_max_length */
+    endpoint?: string; /** defaults to '/e/' */
+    send_instantly?: boolean; /** if set skips the batched queue */
+    timestamp?: Date;
+}
+export interface RetryQueueElement {
+    retryAt: Date;
+    requestData: QueuedRequestData;
+}
+export interface QueuedRequestData {
+    url: string;
+    data: Properties;
+    options: CaptureOptions;
+    headers?: Properties;
+    callback?: RequestCallback;
+    retriesPerformedSoFar?: number;
+}
+export interface XHRParams extends QueuedRequestData {
+    retryQueue: RetryQueue;
+    onXHRError: (req: XMLHttpRequest) => void;
+    timeout?: number;
+    onRateLimited?: (req: XMLHttpRequest) => void;
+}
+export interface DecideResponse {
+    status: number;
+    supportedCompression: Compression[];
+    config: {
+        enable_collect_everything: boolean;
+    };
+    custom_properties: AutoCaptureCustomProperty[];
+    featureFlags: Record<string, string | boolean>;
+    featureFlagPayloads: Record<string, JsonType>;
+    errorsWhileComputingFlags: boolean;
+    autocapture_opt_out?: boolean;
+    capturePerformance?: boolean;
+    autocaptureExceptions?: boolean | {
+        endpoint?: string;
+        errors_to_ignore: string[];
+    };
+    sessionRecording?: {
+        endpoint?: string;
+        consoleLogRecordingEnabled?: boolean;
+        recorderVersion?: 'v1' | 'v2';
+    };
+    toolbarParams: ToolbarParams;
+    editorParams?: ToolbarParams; /** @deprecated, renamed to toolbarParams, still present on older API responses */
+    toolbarVersion: 'toolbar'; /** @deprecated, moved to toolbarParams */
+    isAuthenticated: boolean;
+    siteApps: {
+        id: number;
+        url: string;
+    }[];
+}
+export declare type FeatureFlagsCallback = (flags: string[], variants: Record<string, string | boolean>) => void;
+export interface AutoCaptureCustomProperty {
+    name: string;
+    css_selector: string;
+    event_selectors: string[];
+}
+export interface CompressionData {
+    data: string;
+    compression?: Compression;
+}
+export interface GDPROptions {
+    capture?: (event: string, properties: Properties, options: CaptureOptions) => void; /** function used for capturing a PostHog event to record the opt-in action */
+    captureEventName?: string; /** event name to be used for capturing the opt-in action */
+    captureProperties?: Properties; /** set of properties to be captured along with the opt-in action */
+    /** persistence mechanism used */
+    persistenceType?: 'cookie' | 'localStorage' | 'localStorage+cookie';
+    persistencePrefix?: string; /** [__ph_opt_in_out] - custom prefix to be used in the cookie/localstorage name */
+    cookieExpiration?: number; /** number of days until the opt-in cookie expires */
+    crossSubdomainCookie?: boolean; /** whether the opt-in cookie is set as cross-subdomain or not */
+    secureCookie?: boolean; /** whether the opt-in cookie is set as secure or not */
+    respectDnt?: boolean;
+    window?: Window;
+}
+export declare type RequestCallback = (response: Record<string, any>, data?: Properties) => void;
+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) => void;
+    remove: (name: string, cross_subdomain?: boolean) => void;
+}
+export declare type Breaker = {};
+export declare type EventHandler = (event: Event) => boolean | void;
+export declare type ToolbarUserIntent = 'add-action' | 'edit-action';
+export declare type ToolbarSource = 'url' | 'localstorage';
+export declare type ToolbarVersion = 'toolbar';
+export interface ToolbarParams {
+    token?: string; /** public posthog-js token */
+    temporaryToken?: string; /** private temporary user token */
+    actionId?: number;
+    userIntent?: ToolbarUserIntent;
+    source?: ToolbarSource;
+    toolbarVersion?: ToolbarVersion;
+    instrument?: boolean;
+    distinctId?: string;
+    userEmail?: string;
+    dataAttributes?: string[];
+    featureFlags?: Record<string, string | boolean>;
+}
+export interface PostData {
+    buffer?: BlobPart;
+    compression?: Compression;
+    data?: string;
+}
+export interface JSC {
+    (): void;
+    [key: string]: (response: any) => void;
+}
+export declare type SnippetArrayItem = [method: string, ...args: any[]];
+export declare type JsonType = string | number | boolean | null | {
+    [key: string]: JsonType;
+} | Array<JsonType>;
+/** A feature that isn't publicly available yet.*/
+export interface EarlyAccessFeature {
+    name: string;
+    description: string;
+    stage: 'concept' | 'alpha' | 'beta';
+    documentationUrl: string | null;
+    flagKey: string | null;
+}
+export declare type EarlyAccessFeatureCallback = (earlyAccessFeatures: EarlyAccessFeature[]) => void;
+export interface EarlyAccessFeatureResponse {
+    earlyAccessFeatures: EarlyAccessFeature[];
+}
+export declare type NetworkRequest = {
+    url: string;
+};

package/lib/src/types.js

@@ -0,0 +1,6 @@
+export var Compression;
+(function (Compression) {
+    Compression["GZipJS"] = "gzip-js";
+    Compression["Base64"] = "base64";
+})(Compression || (Compression = {}));
+//# sourceMappingURL=types.js.map

package/lib/src/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AA4JA,MAAM,CAAN,IAAY,WAGX;AAHD,WAAY,WAAW;IACnB,iCAAkB,CAAA;IAClB,gCAAiB,CAAA;AACrB,CAAC,EAHW,WAAW,KAAX,WAAW,QAGtB","sourcesContent":["import type { MaskInputOptions, SlimDOMOptions } from 'rrweb-snapshot'\nimport { PostHog } from './posthog-core'\nimport { RetryQueue } from './retry-queue'\n\nexport type Property = any\nexport type Properties = Record<string, Property>\nexport interface CaptureResult {\n    uuid: string\n    event: string\n    properties: Properties\n    $set?: Properties\n    $set_once?: Properties\n    timestamp?: Date\n}\nexport type CaptureCallback = (response: any, data: any) => void\n\nexport type AutocaptureCompatibleElement = 'a' | 'button' | 'form' | 'input' | 'select' | 'textarea' | 'label'\nexport type DomAutocaptureEvents = 'click' | 'change' | 'submit'\n\n/**\n * If an array is passed for an allowlist, autocapture events will only be sent for elements matching\n * at least one of the elements in the array. Multiple allowlists can be used\n */\nexport interface AutocaptureConfig {\n    /**\n     * List of URLs to allow autocapture on, can be strings to match\n     * or regexes e.g. ['https://example.com', 'test.com/.*']\n     */\n    url_allowlist?: (string | RegExp)[]\n\n    /**\n     * List of DOM events to allow autocapture on  e.g. ['click', 'change', 'submit']\n     */\n    dom_event_allowlist?: DomAutocaptureEvents[]\n\n    /**\n     * List of DOM elements to allow autocapture on\n     * e.g. ['a', 'button', 'form', 'input', 'select', 'textarea', 'label']\n     */\n    element_allowlist?: AutocaptureCompatibleElement[]\n\n    /**\n     * List of CSS selectors to allow autocapture on\n     * e.g. ['[ph-capture]']\n     */\n    css_selector_allowlist?: string[]\n}\n\nexport type UUIDVersion = 'og' | 'v7'\n\nexport interface PostHogConfig {\n    api_host: string\n    api_method: string\n    api_transport: string\n    ui_host: string | null\n    token: string\n    autocapture: boolean | AutocaptureConfig\n    rageclick: boolean\n    cross_subdomain_cookie: boolean\n    persistence: 'localStorage' | 'cookie' | 'memory' | 'localStorage+cookie' | 'sessionStorage'\n    persistence_name: string\n    cookie_name: string\n    loaded: (posthog_instance: PostHog) => void\n    store_google: boolean\n    custom_campaign_params: string[]\n    save_referrer: boolean\n    test: boolean\n    verbose: boolean\n    capture_pageview: boolean\n    capture_pageleave: boolean\n    debug: boolean\n    cookie_expiration: number\n    upgrade: boolean\n    disable_session_recording: boolean\n    disable_persistence: boolean\n    disable_cookie: boolean\n    enable_recording_console_log?: boolean\n    secure_cookie: boolean\n    ip: boolean\n    opt_out_capturing_by_default: boolean\n    opt_out_persistence_by_default: boolean\n    opt_out_capturing_persistence_type: 'localStorage' | 'cookie'\n    opt_out_capturing_cookie_prefix: string | null\n    opt_in_site_apps: boolean\n    respect_dnt: boolean\n    property_blacklist: string[]\n    xhr_headers: { [header_name: string]: string }\n    on_xhr_error: (failedRequest: XMLHttpRequest) => void\n    inapp_protocol: string\n    inapp_link_new_window: boolean\n    request_batching: boolean\n    sanitize_properties: ((properties: Properties, event_name: string) => Properties) | null\n    properties_string_max_length: number\n    session_recording: SessionRecordingOptions\n    session_idle_timeout_seconds: number\n    mask_all_element_attributes: boolean\n    mask_all_text: boolean\n    advanced_disable_decide: boolean\n    advanced_disable_feature_flags: boolean\n    advanced_disable_feature_flags_on_first_load: boolean\n    advanced_disable_toolbar_metrics: boolean\n    get_device_id: (uuid: string) => string\n    name: string\n    callback_fn: string\n    _onCapture: (eventName: string, eventData: CaptureResult) => void\n    capture_performance?: boolean\n    // Should only be used for testing. Could negatively impact performance.\n    disable_compression: boolean\n    bootstrap: {\n        distinctID?: string\n        isIdentifiedID?: boolean\n        featureFlags?: Record<string, boolean | string>\n        featureFlagPayloads?: Record<string, JsonType>\n    }\n    segment?: any\n    __preview_measure_pageview_stats?: boolean\n}\n\nexport interface OptInOutCapturingOptions {\n    capture: (event: string, properties: Properties, options: CaptureOptions) => void\n    capture_event_name: string\n    capture_properties: Properties\n    enable_persistence: boolean\n    clear_persistence: boolean\n    persistence_type: 'cookie' | 'localStorage' | 'localStorage+cookie'\n    cookie_prefix: string\n    cookie_expiration: number\n    cross_subdomain_cookie: boolean\n    secure_cookie: boolean\n}\n\nexport interface isFeatureEnabledOptions {\n    send_event: boolean\n}\n\nexport interface SessionRecordingOptions {\n    blockClass?: string | RegExp\n    blockSelector?: string | null\n    ignoreClass?: string\n    maskTextClass?: string | RegExp\n    maskTextSelector?: string | null\n    maskTextFn?: ((text: string) => string) | null\n    maskAllInputs?: boolean\n    maskInputOptions?: MaskInputOptions\n    maskInputFn?: ((text: string, element?: HTMLElement) => string) | null\n    /** Modify the network request before it is captured. Returning null stops it being captured */\n    maskNetworkRequestFn?: ((url: NetworkRequest) => NetworkRequest | null | undefined) | null\n    slimDOMOptions?: SlimDOMOptions | 'all' | true\n    collectFonts?: boolean\n    inlineStylesheet?: boolean\n    recorderVersion?: 'v1' | 'v2'\n    recordCrossOriginIframes?: boolean\n}\n\nexport type SessionIdChangedCallback = (sessionId: string, windowId: string | null | undefined) => void\n\nexport enum Compression {\n    GZipJS = 'gzip-js',\n    Base64 = 'base64',\n}\n\nexport interface XHROptions {\n    transport?: 'XHR' | 'sendBeacon'\n    method?: 'POST' | 'GET'\n    urlQueryArgs?: { compression: Compression }\n    verbose?: boolean\n    blob?: boolean\n    sendBeacon?: boolean\n}\n\nexport interface CaptureOptions extends XHROptions {\n    $set?: Properties /** used with $identify */\n    $set_once?: Properties /** used with $identify */\n    _batchKey?: string /** key of queue, e.g. 'sessionRecording' vs 'event' */\n    _metrics?: Properties\n    _noTruncate?: boolean /** if set, overrides and disables config.properties_string_max_length */\n    endpoint?: string /** defaults to '/e/' */\n    send_instantly?: boolean /** if set skips the batched queue */\n    timestamp?: Date\n}\n\nexport interface RetryQueueElement {\n    retryAt: Date\n    requestData: QueuedRequestData\n}\nexport interface QueuedRequestData {\n    url: string\n    data: Properties\n    options: CaptureOptions\n    headers?: Properties\n    callback?: RequestCallback\n    retriesPerformedSoFar?: number\n}\n\nexport interface XHRParams extends QueuedRequestData {\n    retryQueue: RetryQueue\n    onXHRError: (req: XMLHttpRequest) => void\n    timeout?: number\n    onRateLimited?: (req: XMLHttpRequest) => void\n}\n\nexport interface DecideResponse {\n    status: number\n    supportedCompression: Compression[]\n    config: {\n        enable_collect_everything: boolean\n    }\n    custom_properties: AutoCaptureCustomProperty[] // TODO: delete, not sent\n    featureFlags: Record<string, string | boolean>\n    featureFlagPayloads: Record<string, JsonType>\n    errorsWhileComputingFlags: boolean\n    autocapture_opt_out?: boolean\n    capturePerformance?: boolean\n    // this is currently in development and may have breaking changes without a major version bump\n    autocaptureExceptions?:\n        | boolean\n        | {\n              endpoint?: string\n              errors_to_ignore: string[]\n          }\n    sessionRecording?: {\n        endpoint?: string\n        consoleLogRecordingEnabled?: boolean\n        recorderVersion?: 'v1' | 'v2'\n    }\n    toolbarParams: ToolbarParams\n    editorParams?: ToolbarParams /** @deprecated, renamed to toolbarParams, still present on older API responses */\n    toolbarVersion: 'toolbar' /** @deprecated, moved to toolbarParams */\n    isAuthenticated: boolean\n    siteApps: { id: number; url: string }[]\n}\n\nexport type FeatureFlagsCallback = (flags: string[], variants: Record<string, string | boolean>) => void\n\n// TODO: delete custom_properties after changeless typescript refactor\nexport interface AutoCaptureCustomProperty {\n    name: string\n    css_selector: string\n    event_selectors: string[]\n}\n\nexport interface CompressionData {\n    data: string\n    compression?: Compression\n}\n\nexport interface GDPROptions {\n    capture?: (\n        event: string,\n        properties: Properties,\n        options: CaptureOptions\n    ) => void /** function used for capturing a PostHog event to record the opt-in action */\n    captureEventName?: string /** event name to be used for capturing the opt-in action */\n    captureProperties?: Properties /** set of properties to be captured along with the opt-in action */\n    /** persistence mechanism used */\n    persistenceType?: 'cookie' | 'localStorage' | 'localStorage+cookie'\n    persistencePrefix?: string /** [__ph_opt_in_out] - custom prefix to be used in the cookie/localstorage name */\n    cookieExpiration?: number /** number of days until the opt-in cookie expires */\n    crossSubdomainCookie?: boolean /** whether the opt-in cookie is set as cross-subdomain or not */\n    secureCookie?: boolean /** whether the opt-in cookie is set as secure or not */\n    respectDnt?: boolean\n    window?: Window\n}\n\nexport type RequestCallback = (response: Record<string, any>, data?: Properties) => void\n\nexport interface PersistentStore {\n    is_supported: () => boolean\n    error: (error: any) => void\n    parse: (name: string) => any\n    get: (name: string) => any\n    set: (name: string, value: any, expire_days?: number | null, cross_subdomain?: boolean, secure?: boolean) => void\n    remove: (name: string, cross_subdomain?: boolean) => void\n}\n\n// eslint-disable-next-line @typescript-eslint/ban-types\nexport type Breaker = {}\nexport type EventHandler = (event: Event) => boolean | void\n\nexport type ToolbarUserIntent = 'add-action' | 'edit-action'\nexport type ToolbarSource = 'url' | 'localstorage'\nexport type ToolbarVersion = 'toolbar'\n\n/* sync with posthog */\nexport interface ToolbarParams {\n    token?: string /** public posthog-js token */\n    temporaryToken?: string /** private temporary user token */\n    actionId?: number\n    userIntent?: ToolbarUserIntent\n    source?: ToolbarSource\n    toolbarVersion?: ToolbarVersion\n    instrument?: boolean\n    distinctId?: string\n    userEmail?: string\n    dataAttributes?: string[]\n    featureFlags?: Record<string, string | boolean>\n}\n\nexport interface PostData {\n    buffer?: BlobPart\n    compression?: Compression\n    data?: string\n}\n\nexport interface JSC {\n    (): void\n    [key: string]: (response: any) => void\n}\n\nexport type SnippetArrayItem = [method: string, ...args: any[]]\n\nexport type JsonType = string | number | boolean | null | { [key: string]: JsonType } | Array<JsonType>\n\n/** A feature that isn't publicly available yet.*/\nexport interface EarlyAccessFeature {\n    // Sync this with the backend's EarlyAccessFeatureSerializer!\n    name: string\n    description: string\n    stage: 'concept' | 'alpha' | 'beta'\n    documentationUrl: string | null\n    flagKey: string | null\n}\n\nexport type EarlyAccessFeatureCallback = (earlyAccessFeatures: EarlyAccessFeature[]) => void\n\nexport interface EarlyAccessFeatureResponse {\n    earlyAccessFeatures: EarlyAccessFeature[]\n}\n\nexport type NetworkRequest = {\n    url: string\n}\n"]}

package/lib/src/utils.d.ts

@@ -0,0 +1,89 @@
+import { Breaker, EventHandler, Properties } from './types';
+declare const win: Window & typeof globalThis;
+declare const document: Document;
+declare const userAgent: string;
+declare const logger: {
+    /** @type {function(...*)} */
+    log: (...args: any[]) => void;
+    /** @type {function(...*)} */
+    error: (..._args: any[]) => void;
+    /** @type {function(...*)} */
+    critical: (..._args: any[]) => void;
+};
+export declare const _trim: (str: string) => string;
+export declare const _bind_instance_methods: (obj: Record<string, any>) => void;
+export declare function _eachArray<E = any>(obj: E[] | null | undefined, iterator: (value: E, key: number) => void | Breaker, thisArg?: any): void;
+/**
+ * @param {*=} obj
+ * @param {function(...*)=} iterator
+ * @param {Object=} thisArg
+ */
+export declare function _each(obj: any, iterator: (value: any, key: any) => void | Breaker, thisArg?: any): void;
+export declare const _extend: (obj: Record<string, any>, ...args: Record<string, any>[]) => Record<string, any>;
+export declare const _isArray: (arg: any) => arg is any[];
+export declare const _isFunction: (f: any) => f is (...args: any[]) => any;
+export declare const _include: (obj: null | string | Array<any> | Record<string, any>, target: any) => boolean | Breaker;
+export declare function _includes<T = any>(str: T[] | string, needle: T): boolean;
+/**
+ * Object.entries() polyfill
+ * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/entries
+ */
+export declare function _entries<T = any>(obj: Record<string, T>): [string, T][];
+export declare const _isObject: (obj: any) => obj is Record<string, any>;
+export declare const _isEmptyObject: (obj: any) => obj is Record<string, any>;
+export declare const _isUndefined: (obj: any) => obj is undefined;
+export declare const _isString: (obj: any) => obj is string;
+export declare const _isDate: (obj: any) => obj is Date;
+export declare const _isNumber: (obj: any) => obj is number;
+export declare const _encodeDates: (obj: Properties) => Properties;
+export declare const _timestamp: () => number;
+export declare const _formatDate: (d: Date) => string;
+export declare const _safewrap: <F extends (...args: any[]) => any = (...args: any[]) => any>(f: F) => F;
+export declare const _safewrap_class: (klass: Function, functions: string[]) => void;
+export declare const _safewrap_instance_methods: (obj: Record<string, any>) => void;
+export declare const _strip_empty_properties: (p: Properties) => Properties;
+export declare function _copyAndTruncateStrings<T extends Record<string, any> = Record<string, any>>(object: T, maxStringLength: number | null): T;
+export declare function _base64Encode(data: null): null;
+export declare function _base64Encode(data: undefined): undefined;
+export declare function _base64Encode(data: string): string;
+export declare const _utf8Encode: (string: string) => string;
+export declare const _isBlockedUA: (ua: string) => boolean;
+/**
+ * @param {Object=} formdata
+ * @param {string=} arg_separator
+ */
+export declare const _HTTPBuildQuery: (formdata: Record<string, any>, arg_separator?: string) => string;
+export declare const _getQueryParam: (url: string, param: string) => string;
+export declare const _getHashParam: (hash: string, param: string) => string | null;
+export declare const _register_event: (element: Element | Window | Document | Node, type: string, handler: EventHandler, oldSchool?: boolean, useCapture?: boolean) => void;
+export declare const isLocalhost: () => boolean;
+export declare function loadScript(scriptUrlToLoad: string, callback: (error?: string | Event, event?: Event) => void): void;
+export declare const _info: {
+    campaignParams: (customParams?: string[]) => Record<string, any>;
+    searchEngine: () => string | null;
+    searchInfo: () => Record<string, any>;
+    /**
+     * This function detects which browser is running this script.
+     * The order of the checks are important since many user agents
+     * include key words used in later checks.
+     */
+    browser: (user_agent: string, vendor: string, opera?: any) => string;
+    /**
+     * This function detects which browser version is running this script,
+     * parsing major and minor version (e.g., 42.1). User agent strings from:
+     * http://www.useragentstring.com/pages/useragentstring.php
+     */
+    browserVersion: (userAgent: string, vendor: string, opera: string) => number | null;
+    browserLanguage: () => string;
+    os: (user_agent: string) => {
+        os_name: string;
+        os_version: string;
+    };
+    device: (user_agent: string) => string;
+    deviceType: (user_agent: string) => string;
+    referrer: () => string;
+    referringDomain: () => string;
+    properties: () => Properties;
+    people_properties: () => Properties;
+};
+export { win as window, userAgent, logger, document };