@aws-amplify/analytics/src/types/trackers.ts

Analytics category of aws-amplify

// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0

export interface SessionTrackingOptions {
	attributes?: TrackerAttributes;
}

export interface PageViewTrackingOptions {
	attributes?: TrackerAttributes;
	eventName?: string;
	urlProvider?(): string;
	appType?: 'multiPage' | 'singlePage';
}

export interface EventTrackingOptions {
	attributes?: TrackerAttributes;
	events?: DOMEvent[];
	selectorPrefix?: string;
}

export type TrackerType = 'event' | 'pageView' | 'session';

export type TrackerAttributes = Record<string, string>;

export type TrackerEventRecorder = (
	eventName: string,
	attributes: TrackerAttributes,
) => void;

export type DOMEvent = keyof GlobalEventHandlersEventMap;

export interface TrackerInterface {
	configure(eventRecorder: TrackerEventRecorder, options?: object): void;
	cleanup(): void;
}