path: root/packages/instant/src/util/analytics.ts

import { ObjectMap } from '@0x/types';

import { heapUtil } from './heap';

enum EventNames {
    WALLET_OPENED = 'Wallet - Opened',
    WALLET_READY = 'Wallet - Ready',
    WIDGET_OPENED = 'Widget - Opened',
}
const track = (eventName: EventNames, eventData: ObjectMap<string | number> = {}): void => {
    heapUtil.evaluateHeapCall(heap => heap.track(eventName, eventData));
};
function trackingEventFnWithoutPayload(eventName: EventNames): () => void {
    return () => {
        track(eventName);
    };
}
// tslint:disable-next-line:no-unused-variable
function trackingEventFnWithPayload<T extends ObjectMap<string | number>>(
    eventName: EventNames,
): (eventDataProperties: T) => void {
    return (eventDataProperties: T) => {
        track(eventName, eventDataProperties);
    };
}

export interface AnalyticsUserOptions {
    ethAddress?: string;
    ethBalanceInUnitAmount?: string;
}
export interface AnalyticsEventOptions {
    embeddedHost?: string;
    embeddedUrl?: string;
    networkId?: number;
    providerName?: string;
    gitSha?: string;
    npmVersion?: string;
}
export const analytics = {
    addUserProperties: (properties: AnalyticsUserOptions): void => {
        heapUtil.evaluateHeapCall(heap => heap.addUserProperties(properties));
    },
    addEventProperties: (properties: AnalyticsEventOptions): void => {
        heapUtil.evaluateHeapCall(heap => heap.addEventProperties(properties));
    },
    walletOpened: trackingEventFnWithoutPayload(EventNames.WALLET_OPENED),
    walletReady: trackingEventFnWithoutPayload(EventNames.WALLET_READY),
    widgetOpened: trackingEventFnWithoutPayload(EventNames.WIDGET_OPENED),
};