@ezbot-ai/javascript-sdk/build/main/lib/types.d.ts

The easiest way to interact with ezbot via JS (node and browser)

import { CommonEventProperties } from '@snowplow/browser-tracker';
import { ActivityTrackingConfiguration, BrowserTracker, PageViewEvent, TrackerConfiguration } from '@snowplow/browser-tracker-core';
import { visualChanges, visualUtils } from './visualChanges';
type VariableConfig = {
    selector: string;
    action: 'setText' | 'setInnerHTML' | 'setHref' | 'setSrc' | 'hide' | 'show' | 'addClasses' | 'removeClasses' | 'setStyle' | 'setAttribute' | 'setFontSize' | 'setFontColor' | 'setBackgroundColor' | 'setVisibility' | 'setOuterHTML' | 'addGlobalCSS';
    attribute?: string;
};
type Prediction = {
    key: string;
    type: string;
    version: string;
    value: string;
    config: VariableConfig | null;
};
type Predictions = {
    predictions: Array<Prediction>;
};
type PredictionsResponse = {
    holdback: boolean;
    predictions: Array<Prediction>;
};
type EzbotRewardEvent = {
    schema: string;
    data: EzbotRewardEventPayload;
};
type EzbotRewardEventPayload = {
    key: string;
    reward?: number | null;
    rewardUnits?: string | null;
    category?: string | null;
};
type EzbotLinkClickEvent = {
    schema: string;
    data: EzbotLinkClickEventPayload;
};
type EzbotLinkClickEventPayload = {
    text?: string | null;
    href?: string | null;
    selector: string;
};
type PredictionForContext = {
    variable: string;
    value: string;
};
type EzbotPredictionsContext = {
    schema: string;
    data: {
        predictions: Array<PredictionForContext>;
    };
};
declare global {
    interface Window {
        ezbot?: {
            trackerConfig: EzbotTrackerConfig;
            userId?: string | null;
            tracker: BrowserTracker;
            predictions: Array<Prediction>;
            sessionId: string;
            trackPageView: (config: Readonly<PageViewEvent & CommonEventProperties>) => void;
            trackRewardEvent: (payload: Readonly<EzbotRewardEventPayload>) => void;
            startActivityTracking: (config: ActivityTrackingConfiguration) => void;
            setUserId: (userId?: string | null) => void;
            setUserIdFromCookie: (cookieName: string) => void;
            makeVisualChanges: () => void;
            utils: {
                visual: typeof visualUtils;
            };
            actions: {
                visual: typeof visualChanges;
            };
            intervals: Array<number>;
            mode: 'ezbot' | 'interactive';
        };
    }
}
type CrossDomainConfig = {
    enabled: boolean;
    domains: string[];
};
type EzbotTrackerConfig = TrackerConfiguration & {
    crossDomain?: CrossDomainConfig;
};
export { VariableConfig, Prediction, Predictions, PredictionsResponse, EzbotRewardEvent, EzbotRewardEventPayload, EzbotLinkClickEvent, EzbotLinkClickEventPayload, EzbotPredictionsContext, PredictionForContext, CrossDomainConfig, EzbotTrackerConfig, };