@aws-amplify/analytics 0.0.0-unstable-1ca644b-20260128091132

package/src/providers/pinpoint/apis/configureAutoTrack.ts

@@ -0,0 +1,54 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { UpdateEndpointException } from '@aws-amplify/core/internals/providers/pinpoint';
+
+import { AnalyticsValidationErrorCode } from '../../../errors';
+import {
+	TrackerAttributes,
+	TrackerInterface,
+	TrackerType,
+} from '../../../types/trackers';
+import {
+	updateProviderTrackers,
+	validateTrackerConfiguration,
+} from '../../../utils';
+import { ConfigureAutoTrackInput } from '../types';
+
+import { record } from './record';
+
+// Configured Tracker instances for Pinpoint
+const configuredTrackers: Partial<Record<TrackerType, TrackerInterface>> = {};
+
+// Callback that will emit an appropriate event to Pinpoint when required by the Tracker
+const emitTrackingEvent = (
+	eventName: string,
+	attributes: TrackerAttributes,
+) => {
+	record({
+		name: eventName,
+		attributes,
+	});
+};
+
+/**
+ * Configures automatic event tracking for Pinpoint. This API will automatically transmit an analytic event when
+ * configured events are detected within your application. This can include: DOM element events (via the `event`
+ * tracker), session events (via the `session` tracker), and page view events (via the `pageView` tracker).
+ *
+ * @deprecated AWS will end support for Amazon Pinpoint on October 30, 2026.
+ *
+ * @remark Only session tracking is currently supported on React Native.
+ *
+ * @param {ConfigureAutoTrackInput} params The input object to configure auto track behavior.
+ *
+ * @throws service: {@link UpdateEndpointException} - Thrown when the underlying Pinpoint service returns an error.
+ * @throws validation: {@link AnalyticsValidationErrorCode} - Thrown when the provided parameters or library
+ *  configuration is incorrect.
+ */
+export const configureAutoTrack = (input: ConfigureAutoTrackInput): void => {
+	validateTrackerConfiguration(input);
+
+	// Initialize or update this provider's trackers
+	updateProviderTrackers(input, emitTrackingEvent, configuredTrackers);
+};

package/src/providers/pinpoint/apis/flushEvents.ts

@@ -0,0 +1,42 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { flushEvents as flushEventsCore } from '@aws-amplify/core/internals/providers/pinpoint';
+import { AnalyticsAction } from '@aws-amplify/core/internals/utils';
+import { ConsoleLogger } from '@aws-amplify/core';
+
+import { resolveConfig, resolveCredentials } from '../utils';
+import { getAnalyticsUserAgentString } from '../../../utils';
+
+const logger = new ConsoleLogger('Analytics');
+
+/**
+ * Flushes all buffered Pinpoint events to the service.
+ *
+ * @deprecated AWS will end support for Amazon Pinpoint on October 30, 2026.
+ *
+ * @note
+ * This API will make a best-effort attempt to flush events from the buffer. Events recorded immediately after invoking
+ * this API may not be included in the flush.
+ */
+export const flushEvents = () => {
+	const { appId, region, bufferSize, flushSize, flushInterval, resendLimit } =
+		resolveConfig();
+	resolveCredentials()
+		.then(({ credentials, identityId }) => {
+			flushEventsCore({
+				appId,
+				region,
+				credentials,
+				identityId,
+				bufferSize,
+				flushSize,
+				flushInterval,
+				resendLimit,
+				userAgentValue: getAnalyticsUserAgentString(AnalyticsAction.Record),
+			});
+		})
+		.catch(e => {
+			logger.warn('Failed to flush events', e);
+		});
+};

package/src/providers/pinpoint/apis/identifyUser.ts

@@ -0,0 +1,81 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { AnalyticsAction } from '@aws-amplify/core/internals/utils';
+import {
+	UpdateEndpointException,
+	updateEndpoint,
+} from '@aws-amplify/core/internals/providers/pinpoint';
+
+import { AnalyticsValidationErrorCode } from '../../../errors';
+import { getAnalyticsUserAgentString } from '../../../utils';
+import { IdentifyUserInput } from '../types';
+import { resolveConfig, resolveCredentials } from '../utils';
+
+/**
+ * Sends information about a user to Pinpoint. Sending user information allows you to associate a user to their user
+ * profile and activities or actions in your application. Activity can be tracked across devices & platforms by using
+ * the same `userId`.
+ *
+ * @deprecated AWS will end support for Amazon Pinpoint on October 30, 2026.
+ *
+ * @param {IdentifyUserInput} params The input object used to construct requests sent to Pinpoint's UpdateEndpoint
+ *  API.
+ *
+ * @throws service: {@link UpdateEndpointException} - Thrown when the underlying Pinpoint service returns an error.
+ * @throws validation: {@link AnalyticsValidationErrorCode} - Thrown when the provided parameters or library
+ *  configuration is incorrect.
+ *
+ * @returns A promise that will resolve when the operation is complete.
+ *
+ * @example
+ * ```ts
+ * // Identify a user with Pinpoint
+ * await identifyUser({
+ *     userId,
+ *     userProfile: {
+ *         email: 'userEmail@example.com'
+ *         customProperties: {
+ *             phoneNumber: ['555-555-5555'],
+ *         },
+ *     }
+ * });
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Identify a user with Pinpoint with some additional demographics
+ * await identifyUser({
+ *     userId,
+ *     userProfile: {
+ *         email: 'userEmail@example.com'
+ *         customProperties: {
+ *             phoneNumber: ['555-555-5555'],
+ *         },
+ *         demographic: {
+ *             platform: 'ios',
+ *             timezone: 'America/Los_Angeles'
+ *         }
+ *     }
+ * });
+ */
+export const identifyUser = async ({
+	userId,
+	userProfile,
+	options,
+}: IdentifyUserInput): Promise<void> => {
+	const { credentials, identityId } = await resolveCredentials();
+	const { appId, region } = resolveConfig();
+	const { userAttributes } = options ?? {};
+	await updateEndpoint({
+		appId,
+		category: 'Analytics',
+		credentials,
+		identityId,
+		region,
+		userAttributes,
+		userId,
+		userProfile,
+		userAgentValue: getAnalyticsUserAgentString(AnalyticsAction.IdentifyUser),
+	});
+};

package/src/providers/pinpoint/apis/index.ts

@@ -0,0 +1,7 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export { record } from './record';
+export { identifyUser } from './identifyUser';
+export { configureAutoTrack } from './configureAutoTrack';
+export { flushEvents } from './flushEvents';

package/src/providers/pinpoint/apis/record.ts

@@ -0,0 +1,92 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { ConsoleLogger, Hub } from '@aws-amplify/core';
+import {
+	AMPLIFY_SYMBOL,
+	AnalyticsAction,
+} from '@aws-amplify/core/internals/utils';
+import { record as recordCore } from '@aws-amplify/core/internals/providers/pinpoint';
+
+import {
+	AnalyticsValidationErrorCode,
+	assertValidationError,
+} from '../../../errors';
+import {
+	getAnalyticsUserAgentString,
+	isAnalyticsEnabled,
+} from '../../../utils';
+import { RecordInput } from '../types';
+import { resolveConfig, resolveCredentials } from '../utils';
+
+const logger = new ConsoleLogger('Analytics');
+
+/**
+ * Records an Analytic event to Pinpoint. Events will be buffered and periodically sent to Pinpoint.
+ *
+ * @deprecated AWS will end support for Amazon Pinpoint on October 30, 2026.
+ *
+ * @param params The input object used to construct the request.
+ *
+ * @throws validation: {@link AnalyticsValidationErrorCode} - Thrown when the provided parameters or library
+ *  configuration is incorrect.
+ *
+ * @example
+ * ```ts
+ * // Send an event to Pinpoint
+ * record({ name: eventName })
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Send an event to Pinpoint with metrics & custom attributes
+ * record({
+ *     name: eventName,
+ *     attributes: {
+ *         'my-attribute': attributeValue
+ *     },
+ *     metrics: {
+ *         'my-metric': metricValue
+ *     }
+ * })
+ * ```
+ */
+export const record = (input: RecordInput): void => {
+	const { appId, region, bufferSize, flushSize, flushInterval, resendLimit } =
+		resolveConfig();
+
+	if (!isAnalyticsEnabled()) {
+		logger.debug('Analytics is disabled, event will not be recorded.');
+
+		return;
+	}
+
+	assertValidationError(!!input.name, AnalyticsValidationErrorCode.NoEventName);
+
+	resolveCredentials()
+		.then(({ credentials, identityId }) => {
+			Hub.dispatch(
+				'analytics',
+				{ event: 'record', data: input, message: 'Recording Analytics event' },
+				'Analytics',
+				AMPLIFY_SYMBOL,
+			);
+			recordCore({
+				appId,
+				category: 'Analytics',
+				credentials,
+				event: input,
+				identityId,
+				region,
+				userAgentValue: getAnalyticsUserAgentString(AnalyticsAction.Record),
+				bufferSize,
+				flushSize,
+				flushInterval,
+				resendLimit,
+			});
+		})
+		.catch(e => {
+			// An error occured while fetching credentials or persisting the event to the buffer
+			logger.warn('Failed to record event.', e);
+		});
+};

package/src/providers/pinpoint/index.ts

@@ -0,0 +1,9 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export { record, identifyUser, flushEvents, configureAutoTrack } from './apis';
+export {
+	RecordInput,
+	IdentifyUserInput,
+	ConfigureAutoTrackInput,
+} from './types/inputs';

package/src/providers/pinpoint/types/index.ts

@@ -0,0 +1,9 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export {
+	RecordInput,
+	IdentifyUserInput,
+	ConfigureAutoTrackInput,
+} from './inputs';
+export { IdentifyUserOptions } from './options';

package/src/providers/pinpoint/types/inputs.ts

@@ -0,0 +1,26 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { PinpointAnalyticsEvent } from '@aws-amplify/core/internals/providers/pinpoint';
+
+import {
+	AnalyticsConfigureAutoTrackInput,
+	AnalyticsIdentifyUserInput,
+} from '../../../types';
+
+import { IdentifyUserOptions } from './options';
+
+/**
+ * Input type for Pinpoint record API.
+ */
+export type RecordInput = PinpointAnalyticsEvent;
+
+/**
+ * Input type for Pinpoint identifyUser API.
+ */
+export type IdentifyUserInput = AnalyticsIdentifyUserInput<IdentifyUserOptions>;
+
+/**
+ * Input type for Pinpoint configureAutoTrack API.
+ */
+export type ConfigureAutoTrackInput = AnalyticsConfigureAutoTrackInput;

package/src/providers/pinpoint/types/options.ts

@@ -0,0 +1,12 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { PinpointServiceOptions } from '@aws-amplify/core/internals/providers/pinpoint';
+
+/**
+ * Options specific to Pinpoint identityUser.
+ */
+export type IdentifyUserOptions = Pick<
+	PinpointServiceOptions,
+	'userAttributes'
+>;

package/src/providers/pinpoint/utils/index.ts

@@ -0,0 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export { resolveConfig } from './resolveConfig';
+export { resolveCredentials } from './resolveCredentials';

package/src/providers/pinpoint/utils/resolveConfig.ts

@@ -0,0 +1,21 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { Amplify } from '@aws-amplify/core';
+
+import {
+	AnalyticsValidationErrorCode,
+	assertValidationError,
+} from '../../../errors';
+
+/**
+ * @internal
+ */
+export const resolveConfig = () => {
+	const { appId, region, bufferSize, flushSize, flushInterval, resendLimit } =
+		Amplify.getConfig().Analytics?.Pinpoint ?? {};
+	assertValidationError(!!appId, AnalyticsValidationErrorCode.NoAppId);
+	assertValidationError(!!region, AnalyticsValidationErrorCode.NoRegion);
+
+	return { appId, region, bufferSize, flushSize, flushInterval, resendLimit };
+};

package/src/providers/pinpoint/utils/resolveCredentials.ts

@@ -0,0 +1,22 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { fetchAuthSession } from '@aws-amplify/core';
+
+import {
+	AnalyticsValidationErrorCode,
+	assertValidationError,
+} from '../../../errors';
+
+/**
+ * @internal
+ */
+export const resolveCredentials = async () => {
+	const { credentials, identityId } = await fetchAuthSession();
+	assertValidationError(
+		!!credentials,
+		AnalyticsValidationErrorCode.NoCredentials,
+	);
+
+	return { credentials, identityId };
+};

package/src/trackers/EventTracker.ts

@@ -0,0 +1,136 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { ConsoleLogger } from '@aws-amplify/core';
+import { isBrowser } from '@aws-amplify/core/internals/utils';
+
+import {
+	DOMEvent,
+	EventTrackingOptions,
+	TrackerEventRecorder,
+	TrackerInterface,
+} from '../types/trackers';
+
+const DEFAULT_EVENTS = ['click'] as DOMEvent[];
+const DEFAULT_SELECTOR_PREFIX = 'data-amplify-analytics-';
+const DEFAULT_EVENT_NAME = 'event'; // Default event name as sent to the analytics provider
+
+const logger = new ConsoleLogger('EventTracker');
+
+export class EventTracker implements TrackerInterface {
+	private trackerActive: boolean;
+	private options: EventTrackingOptions;
+	private eventRecorder: TrackerEventRecorder;
+
+	constructor(
+		eventRecorder: TrackerEventRecorder,
+		options?: EventTrackingOptions,
+	) {
+		this.options = {};
+		this.trackerActive = false;
+		this.eventRecorder = eventRecorder;
+		this.handleDocEvent = this.handleDocEvent.bind(this);
+
+		this.configure(eventRecorder, options);
+	}
+
+	public configure(
+		eventRecorder: TrackerEventRecorder,
+		options?: EventTrackingOptions,
+	) {
+		this.eventRecorder = eventRecorder;
+
+		// Clean up any existing listeners
+		this.cleanup();
+
+		// Apply defaults
+		this.options = {
+			attributes: options?.attributes ?? undefined,
+			events: options?.events ?? DEFAULT_EVENTS,
+			selectorPrefix: options?.selectorPrefix ?? DEFAULT_SELECTOR_PREFIX,
+		};
+
+		// Register event listeners
+		if (isBrowser()) {
+			this.options.events?.forEach(targetEvent => {
+				document.addEventListener(targetEvent, this.handleDocEvent, {
+					capture: true,
+				});
+			});
+
+			this.trackerActive = true;
+		}
+	}
+
+	public cleanup() {
+		// No-op if document listener is not active
+		if (!this.trackerActive) {
+			return;
+		}
+
+		// Clean up event listeners
+		this.options.events?.forEach(targetEvent => {
+			document.removeEventListener(targetEvent, this.handleDocEvent, {
+				capture: true,
+			});
+		});
+	}
+
+	private handleDocEvent(event: Event) {
+		/**
+		 * Example DOM element:
+		 *
+		 * ```
+		 * <button
+		 *   data-amplify-analytics-on="click"
+		 *   data-amplify-analytics-name="click"
+		 *   data-amplify-analytics-attrs="attr1:attr1_value,attr2:attr2_value"
+		 * />
+		 * ```
+		 */
+		const triggerSelector = `[${this.options.selectorPrefix}on]`;
+		const attrSelector = `${this.options.selectorPrefix}attrs`;
+		const eventNameSelector = `${this.options.selectorPrefix}name`;
+		const eventSource = event.target;
+
+		// Validate that the triggering event type is being tracked
+		if (!this.options.events?.includes(event.type as DOMEvent)) {
+			return;
+		}
+
+		if (eventSource instanceof HTMLElement) {
+			const target = eventSource.closest(triggerSelector);
+
+			if (target) {
+				// Parse event name from the element
+				const eventName =
+					target.getAttribute(eventNameSelector) || DEFAULT_EVENT_NAME;
+
+				// Parse attributes from the element
+				const elementAttributes: Record<string, string> = {};
+				const rawElementAttributes = target.getAttribute(attrSelector);
+				rawElementAttributes?.split(/\s*,\s*/).forEach(attr => {
+					const tmp = attr.trim().split(/\s*:\s*/);
+					elementAttributes[tmp[0]] = tmp[1];
+				});
+
+				// Assemble final list of attributes
+				const attributes = Object.assign(
+					{
+						type: event.type,
+						target: `${target.localName} with id ${target.id}`,
+					},
+					this.options.attributes,
+					elementAttributes,
+				);
+
+				logger.debug('Recording automatically tracked DOM event', {
+					eventName,
+					attributes,
+				});
+
+				this.eventRecorder(eventName, attributes);
+			}
+		}
+	}
+}

package/src/trackers/PageViewTracker.ts

@@ -0,0 +1,155 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { ConsoleLogger } from '@aws-amplify/core';
+import { isBrowser } from '@aws-amplify/core/internals/utils';
+
+import {
+	PageViewTrackingOptions,
+	TrackerEventRecorder,
+	TrackerInterface,
+} from '../types/trackers';
+
+const logger = new ConsoleLogger('PageViewTracker');
+
+const DEFAULT_EVENT_NAME = 'pageView';
+const DEFAULT_APP_TYPE = 'singlePage';
+const DEFAULT_URL_PROVIDER = () => {
+	return window.location.origin + window.location.pathname;
+};
+const PREV_URL_STORAGE_KEY = 'aws-amplify-analytics-prevUrl';
+
+export class PageViewTracker implements TrackerInterface {
+	private trackerActive: boolean;
+	private options: PageViewTrackingOptions;
+	private eventRecorder: TrackerEventRecorder;
+
+	// SPA tracking helpers
+	private spaTrackingActive: boolean;
+	private pushStateProxy?: any;
+	private replaceStateProxy?: any;
+	private originalPushState: any;
+	private originalReplaceState: any;
+
+	constructor(
+		eventRecorder: TrackerEventRecorder,
+		options?: PageViewTrackingOptions,
+	) {
+		this.options = {};
+		this.trackerActive = true;
+		this.eventRecorder = eventRecorder;
+		this.spaTrackingActive = false;
+		this.handleLocationChange = this.handleLocationChange.bind(this);
+
+		this.configure(eventRecorder, options);
+	}
+
+	public configure(
+		eventRecorder: TrackerEventRecorder,
+		options?: PageViewTrackingOptions,
+	) {
+		this.eventRecorder = eventRecorder;
+
+		// Clean up any existing listeners
+		this.cleanup();
+
+		// Apply defaults
+		this.options = {
+			appType: options?.appType ?? DEFAULT_APP_TYPE,
+			attributes: options?.attributes ?? undefined,
+			eventName: options?.eventName ?? DEFAULT_EVENT_NAME,
+			urlProvider: options?.urlProvider ?? DEFAULT_URL_PROVIDER,
+		};
+
+		// Configure SPA or MPA page view tracking
+		if (isBrowser()) {
+			if (this.options.appType === 'singlePage') {
+				this.setupSPATracking();
+			} else {
+				this.setupMPATracking();
+			}
+
+			this.trackerActive = true;
+		}
+	}
+
+	public cleanup() {
+		// No-op if document listener is not active
+		if (!this.trackerActive) {
+			return;
+		}
+
+		// Clean up SPA page view listeners
+		if (this.spaTrackingActive) {
+			window.history.pushState = this.originalPushState;
+			window.history.replaceState = this.originalReplaceState;
+			this.pushStateProxy?.revoke();
+			this.replaceStateProxy?.revoke();
+			window.removeEventListener('popstate', this.handleLocationChange);
+
+			this.spaTrackingActive = false;
+		}
+	}
+
+	private setupSPATracking() {
+		if (!this.spaTrackingActive) {
+			// Configure proxies on History APIs
+			this.pushStateProxy = Proxy.revocable(window.history.pushState, {
+				apply: (target, thisArg, args) => {
+					target.apply(thisArg, args as any);
+					this.handleLocationChange();
+				},
+			});
+			this.replaceStateProxy = Proxy.revocable(window.history.replaceState, {
+				apply: (target, thisArg, args) => {
+					target.apply(thisArg, args as any);
+					this.handleLocationChange();
+				},
+			});
+
+			this.originalPushState = window.history.pushState;
+			this.originalReplaceState = window.history.replaceState;
+			window.history.pushState = this.pushStateProxy.proxy;
+			window.history.replaceState = this.replaceStateProxy.proxy;
+			window.addEventListener('popstate', this.handleLocationChange);
+			sessionStorage.removeItem(PREV_URL_STORAGE_KEY);
+
+			this.spaTrackingActive = true;
+		}
+	}
+
+	private setupMPATracking() {
+		this.handleLocationChange();
+	}
+
+	private handleLocationChange() {
+		const currentUrl = this.options.urlProvider!();
+		const eventName = this.options.eventName || DEFAULT_EVENT_NAME;
+
+		if (this.urlHasChanged()) {
+			sessionStorage.setItem(PREV_URL_STORAGE_KEY, currentUrl);
+
+			// Assemble attribute list
+			const attributes = Object.assign(
+				{
+					url: currentUrl,
+				},
+				this.options.attributes,
+			);
+
+			logger.debug('Recording automatically tracked page view event', {
+				eventName,
+				attributes,
+			});
+
+			this.eventRecorder(eventName, attributes);
+		}
+	}
+
+	private urlHasChanged() {
+		const prevUrl = sessionStorage.getItem(PREV_URL_STORAGE_KEY);
+		const currUrl = this.options.urlProvider!();
+
+		return currUrl !== prevUrl;
+	}
+}