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

Analytics category of aws-amplify

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

import { UserProfile } from '@aws-amplify/core';

import { AnalyticsServiceOptions } from './options';
import {
	EventTrackingOptions,
	PageViewTrackingOptions,
	SessionTrackingOptions,
} from './trackers';

/**
 * Input type for `identifyUser`.
 */
export interface AnalyticsIdentifyUserInput<
	ServiceOptions extends AnalyticsServiceOptions = AnalyticsServiceOptions,
> {
	/**
	 * A User ID associated to the current device.
	 */
	userId: string;

	/**
	 * Additional information about the user and their device.
	 */
	userProfile: UserProfile;

	/**
	 * Options to be passed to the API.
	 */
	options?: ServiceOptions;
}

/**
 * Input type for `configureAutoTrack`.
 */
export type AnalyticsConfigureAutoTrackInput = {
	enable: boolean;
} & (
	| {
			type: 'session';
			options?: SessionTrackingOptions;
	  }
	| {
			type: 'pageView';
			options?: PageViewTrackingOptions;
	  }
	| {
			type: 'event';
			options?: EventTrackingOptions;
	  }
);