@atlaskit/analytics-gas-types/dist/types/index.d.ts

Shared analytics functions/components for Fabric Elements

import { type AnalyticsEventPayload } from '@atlaskit/analytics-next';
export declare const UI_EVENT_TYPE = "ui";
export declare const TRACK_EVENT_TYPE = "track";
export declare const SCREEN_EVENT_TYPE = "screen";
export declare const OPERATIONAL_EVENT_TYPE = "operational";
export declare const DEFAULT_SOURCE = "unknown";
export type EventType = 'ui' | 'track' | 'screen' | 'operational';
export type GasPureScreenEventPayload = {
    name: string;
    attributes?: {
        [key: string]: any;
    };
    tags?: Array<string>;
};
export type GasPurePayload = {
    actionSubject: string;
    actionSubjectId?: string;
    attributes?: {
        packageName?: string;
        packageVersion?: string;
        componentName?: string;
        [key: string]: any;
    };
    nonPrivacySafeAttributes?: {
        [key: string]: any;
    };
    tags?: Array<string>;
    source?: string;
    action?: string;
};
export type WithEventType = {
    eventType: EventType;
};
export type GasCorePayload = GasPurePayload & WithEventType;
export type GasScreenEventPayload = GasPureScreenEventPayload & WithEventType;
export type GasPayload = AnalyticsEventPayload & GasCorePayload;