@aws-amplify/analytics 7.0.16 → 7.0.17-unstable.0d2aa5d.0

package/src/providers/personalize/utils/getEventBuffer.ts

@@ -1,19 +1,16 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { 
-	AWSCredentials, 
-	haveCredentialsChanged 
+import {
+	AWSCredentials,
+	haveCredentialsChanged,
 } from '@aws-amplify/core/internals/utils';
 import {
 	PersonalizeEventsClient,
 	PutEventsCommand,
 } from '@aws-sdk/client-personalize-events';
-import { 
-	EventBuffer, 
-	groupBy, 
-	IAnalyticsClient
-} from '../../../utils';
+
+import { EventBuffer, IAnalyticsClient, groupBy } from '../../../utils';
 import { PersonalizeBufferConfig, PersonalizeBufferEvent } from '../types';
 
 /**
@@ -25,15 +22,17 @@ import { PersonalizeBufferConfig, PersonalizeBufferEvent } from '../types';
  * When a new session is initiated, the previous ones should be released.
  * */
 const eventBufferMap: Record<string, EventBuffer<PersonalizeBufferEvent>> = {};
-const cachedClients: Record<string, [PersonalizeEventsClient, AWSCredentials]> = {};
+const cachedClients: Record<string, [PersonalizeEventsClient, AWSCredentials]> =
+	{};
 
 const DELIMITER = '#';
 
 const createPutEventsCommand = (
 	ids: string,
-	events: PersonalizeBufferEvent[]
+	events: PersonalizeBufferEvent[],
 ): PutEventsCommand => {
 	const [trackingId, sessionId, userId] = ids.split(DELIMITER);
+
 	return new PutEventsCommand({
 		trackingId,
 		sessionId,
@@ -49,7 +48,7 @@ const createPutEventsCommand = (
 
 const submitEvents = async (
 	events: PersonalizeBufferEvent[],
-	client: PersonalizeEventsClient
+	client: PersonalizeEventsClient,
 ): Promise<PersonalizeBufferEvent[]> => {
 	const groupedByIds = Object.entries(
 		groupBy(
@@ -57,15 +56,16 @@ const submitEvents = async (
 				[event.trackingId, event.sessionId, event.userId]
 					.filter(id => !!id)
 					.join(DELIMITER),
-			events
-		)
+			events,
+		),
 	);
 
 	const requests = groupedByIds
-		.map(([ids, events]) => createPutEventsCommand(ids, events))
+		.map(([ids, groupedEvents]) => createPutEventsCommand(ids, groupedEvents))
 		.map(command => client.send(command));
 
 	await Promise.allSettled(requests);
+
 	return Promise.resolve([]);
 };
 
@@ -79,12 +79,16 @@ export const getEventBuffer = ({
 	userAgentValue,
 }: PersonalizeBufferConfig): EventBuffer<PersonalizeBufferEvent> => {
 	const sessionIdentityKey = [region, identityId].filter(x => !!x).join('-');
-	const [ cachedClient, cachedCredentials ] = cachedClients[sessionIdentityKey] ?? [];
+	const [cachedClient, cachedCredentials] =
+		cachedClients[sessionIdentityKey] ?? [];
 	let credentialsHaveChanged = false;
 
 	// Check if credentials have changed for the cached client
 	if (cachedClient) {
-		credentialsHaveChanged = haveCredentialsChanged(cachedCredentials, credentials);
+		credentialsHaveChanged = haveCredentialsChanged(
+			cachedCredentials,
+			credentials,
+		);
 	}
 
 	if (!eventBufferMap[sessionIdentityKey] || credentialsHaveChanged) {
@@ -96,11 +100,11 @@ export const getEventBuffer = ({
 						credentials,
 						customUserAgent: userAgentValue,
 					}),
-					credentials
+					credentials,
 				];
 			}
 
-			const [ personalizeClient ] = cachedClients[sessionIdentityKey];
+			const [personalizeClient] = cachedClients[sessionIdentityKey];
 
 			return events => submitEvents(events, personalizeClient);
 		};
@@ -112,11 +116,11 @@ export const getEventBuffer = ({
 					flushSize,
 					flushInterval,
 				},
-				getClient
+				getClient,
 			);
 
 		const releaseSessionKeys = Object.keys(eventBufferMap).filter(
-			key => key !== sessionIdentityKey
+			key => key !== sessionIdentityKey,
 		);
 		for (const releaseSessionKey of releaseSessionKeys) {
 			eventBufferMap[releaseSessionKey].flushAll().finally(() => {

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

@@ -2,10 +2,12 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { Amplify } from '@aws-amplify/core';
+
 import {
 	AnalyticsValidationErrorCode,
 	assertValidationError,
 } from '../../../errors';
+
 import {
 	DEFAULT_PERSONALIZE_CONFIG,
 	PERSONALIZE_FLUSH_SIZE_MAX,
@@ -26,12 +28,12 @@ export const resolveConfig = () => {
 	assertValidationError(!!region, AnalyticsValidationErrorCode.NoRegion);
 	assertValidationError(
 		!!trackingId,
-		AnalyticsValidationErrorCode.NoTrackingId
+		AnalyticsValidationErrorCode.NoTrackingId,
 	);
 	assertValidationError(
 		flushSize <= PERSONALIZE_FLUSH_SIZE_MAX,
 		AnalyticsValidationErrorCode.InvalidFlushSize,
-		`FlushSize for Personalize should be less or equal than ${PERSONALIZE_FLUSH_SIZE_MAX}`
+		`FlushSize for Personalize should be less or equal than ${PERSONALIZE_FLUSH_SIZE_MAX}`,
 	);
 
 	return {

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

@@ -1,17 +1,20 @@
 // 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 {
-	TrackerType,
 	TrackerAttributes,
 	TrackerInterface,
+	TrackerType,
 } from '../../../types/trackers';
 import {
 	updateProviderTrackers,
 	validateTrackerConfiguration,
 } from '../../../utils';
 import { ConfigureAutoTrackInput } from '../types';
+
 import { record } from './record';
 
 // Configured Tracker instances for Pinpoint
@@ -20,7 +23,7 @@ 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
+	attributes: TrackerAttributes,
 ) => {
 	record({
 		name: eventName,

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

@@ -1,10 +1,11 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { resolveConfig, resolveCredentials } from '../utils';
 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');
@@ -20,7 +21,7 @@ export const flushEvents = () => {
 	const { appId, region, bufferSize, flushSize, flushInterval, resendLimit } =
 		resolveConfig();
 	resolveCredentials()
-		.then(({ credentials, identityId }) =>
+		.then(({ credentials, identityId }) => {
 			flushEventsCore({
 				appId,
 				region,
@@ -31,7 +32,9 @@ export const flushEvents = () => {
 				flushInterval,
 				resendLimit,
 				userAgentValue: getAnalyticsUserAgentString(AnalyticsAction.Record),
-			})
-		)
-		.catch(e => logger.warn('Failed to flush events', e));
+			});
+		})
+		.catch(e => {
+			logger.warn('Failed to flush events', e);
+		});
 };

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

@@ -3,9 +3,10 @@
 
 import { AnalyticsAction } from '@aws-amplify/core/internals/utils';
 import {
-	updateEndpoint,
 	UpdateEndpointException,
+	updateEndpoint,
 } from '@aws-amplify/core/internals/providers/pinpoint';
+
 import { AnalyticsValidationErrorCode } from '../../../errors';
 import { getAnalyticsUserAgentString } from '../../../utils';
 import { IdentifyUserInput } from '../types';
@@ -16,7 +17,7 @@ import { resolveConfig, resolveCredentials } from '../utils';
  * profile and activities or actions in your application. Activity can be tracked across devices & platforms by using
  * the same `userId`.
  *
- * @param {IdentifyUserParameters} params The input object used to construct requests sent to Pinpoint's UpdateEndpoint
+ * @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.

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

@@ -1,12 +1,13 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { Hub, ConsoleLogger } from '@aws-amplify/core';
+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,
@@ -54,6 +55,7 @@ export const record = (input: RecordInput): void => {
 
 	if (!isAnalyticsEnabled()) {
 		logger.debug('Analytics is disabled, event will not be recorded.');
+
 		return;
 	}
 
@@ -65,7 +67,7 @@ export const record = (input: RecordInput): void => {
 				'analytics',
 				{ event: 'record', data: input, message: 'Recording Analytics event' },
 				'Analytics',
-				AMPLIFY_SYMBOL
+				AMPLIFY_SYMBOL,
 			);
 			recordCore({
 				appId,

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

@@ -2,12 +2,14 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { PinpointAnalyticsEvent } from '@aws-amplify/core/internals/providers/pinpoint';
-import { IdentifyUserOptions } from './options';
+
 import {
 	AnalyticsConfigureAutoTrackInput,
 	AnalyticsIdentifyUserInput,
 } from '../../../types';
 
+import { IdentifyUserOptions } from './options';
+
 /**
  * Input type for Pinpoint record API.
  */

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

@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { Amplify } from '@aws-amplify/core';
+
 import {
 	AnalyticsValidationErrorCode,
 	assertValidationError,

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

@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { fetchAuthSession } from '@aws-amplify/core';
+
 import {
 	AnalyticsValidationErrorCode,
 	assertValidationError,
@@ -14,7 +15,8 @@ export const resolveCredentials = async () => {
 	const { credentials, identityId } = await fetchAuthSession();
 	assertValidationError(
 		!!credentials,
-		AnalyticsValidationErrorCode.NoCredentials
+		AnalyticsValidationErrorCode.NoCredentials,
 	);
+
 	return { credentials, identityId };
 };

package/src/trackers/EventTracker.ts

@@ -1,14 +1,15 @@
 // 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 {
-	EventTrackingOptions,
 	DOMEvent,
+	EventTrackingOptions,
 	TrackerEventRecorder,
 	TrackerInterface,
 } from '../types/trackers';
-import { ConsoleLogger } from '@aws-amplify/core';
-import { isBrowser } from '@aws-amplify/core/internals/utils';
 
 const DEFAULT_EVENTS = ['click'] as DOMEvent[];
 const DEFAULT_SELECTOR_PREFIX = 'data-amplify-analytics-';
@@ -23,7 +24,7 @@ export class EventTracker implements TrackerInterface {
 
 	constructor(
 		eventRecorder: TrackerEventRecorder,
-		options?: EventTrackingOptions
+		options?: EventTrackingOptions,
 	) {
 		this.options = {};
 		this.trackerActive = false;
@@ -35,7 +36,7 @@ export class EventTracker implements TrackerInterface {
 
 	public configure(
 		eventRecorder: TrackerEventRecorder,
-		options?: EventTrackingOptions
+		options?: EventTrackingOptions,
 	) {
 		this.eventRecorder = eventRecorder;
 
@@ -120,7 +121,7 @@ export class EventTracker implements TrackerInterface {
 						target: `${target.localName} with id ${target.id}`,
 					},
 					this.options.attributes,
-					elementAttributes
+					elementAttributes,
 				);
 
 				logger.debug('Recording automatically tracked DOM event', {

package/src/trackers/PageViewTracker.ts

@@ -1,13 +1,14 @@
 // 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';
-import { ConsoleLogger } from '@aws-amplify/core';
-import { isBrowser } from '@aws-amplify/core/internals/utils';
 
 const logger = new ConsoleLogger('PageViewTracker');
 
@@ -32,7 +33,7 @@ export class PageViewTracker implements TrackerInterface {
 
 	constructor(
 		eventRecorder: TrackerEventRecorder,
-		options?: PageViewTrackingOptions
+		options?: PageViewTrackingOptions,
 	) {
 		this.options = {};
 		this.trackerActive = true;
@@ -45,7 +46,7 @@ export class PageViewTracker implements TrackerInterface {
 
 	public configure(
 		eventRecorder: TrackerEventRecorder,
-		options?: PageViewTrackingOptions
+		options?: PageViewTrackingOptions,
 	) {
 		this.eventRecorder = eventRecorder;
 
@@ -95,20 +96,14 @@ export class PageViewTracker implements TrackerInterface {
 			// Configure proxies on History APIs
 			this.pushStateProxy = Proxy.revocable(window.history.pushState, {
 				apply: (target, thisArg, args) => {
-					const proxiedResult = target.apply(thisArg, args as any);
-
+					target.apply(thisArg, args as any);
 					this.handleLocationChange();
-
-					return proxiedResult;
 				},
 			});
 			this.replaceStateProxy = Proxy.revocable(window.history.replaceState, {
 				apply: (target, thisArg, args) => {
-					const proxiedResult = target.apply(thisArg, args as any);
-
+					target.apply(thisArg, args as any);
 					this.handleLocationChange();
-
-					return proxiedResult;
 				},
 			});
 
@@ -139,7 +134,7 @@ export class PageViewTracker implements TrackerInterface {
 				{
 					url: currentUrl,
 				},
-				this.options.attributes
+				this.options.attributes,
 			);
 
 			logger.debug('Recording automatically tracked page view event', {

package/src/trackers/SessionTracker.native.ts

@@ -2,12 +2,13 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import {
-	sessionListener,
-	SessionState,
 	SESSION_START_EVENT,
 	SESSION_STOP_EVENT,
+	SessionState,
+	sessionListener,
 } from '@aws-amplify/core/internals/utils';
 import { ConsoleLogger } from '@aws-amplify/core';
+
 import {
 	SessionTrackingOptions,
 	TrackerEventRecorder,
@@ -24,7 +25,7 @@ export class SessionTracker implements TrackerInterface {
 
 	constructor(
 		eventRecorder: TrackerEventRecorder,
-		options?: SessionTrackingOptions
+		options?: SessionTrackingOptions,
 	) {
 		this.options = {};
 		this.eventRecorder = eventRecorder;
@@ -37,7 +38,7 @@ export class SessionTracker implements TrackerInterface {
 
 	public configure(
 		eventRecorder: TrackerEventRecorder,
-		options?: SessionTrackingOptions
+		options?: SessionTrackingOptions,
 	) {
 		this.eventRecorder = eventRecorder;
 
@@ -53,7 +54,7 @@ export class SessionTracker implements TrackerInterface {
 		if (!this.sessionTrackingActive) {
 			sessionListener.addStateChangeListener(
 				this.handleStateChange,
-				!this.initialEventSent
+				!this.initialEventSent,
 			);
 
 			this.sessionTrackingActive = true;

package/src/trackers/SessionTracker.ts

@@ -2,12 +2,13 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import {
-	sessionListener,
-	SessionState,
 	SESSION_START_EVENT,
 	SESSION_STOP_EVENT,
+	SessionState,
+	sessionListener,
 } from '@aws-amplify/core/internals/utils';
 import { ConsoleLogger } from '@aws-amplify/core';
+
 import {
 	SessionTrackingOptions,
 	TrackerEventRecorder,
@@ -24,7 +25,7 @@ export class SessionTracker implements TrackerInterface {
 
 	constructor(
 		eventRecorder: TrackerEventRecorder,
-		options?: SessionTrackingOptions
+		options?: SessionTrackingOptions,
 	) {
 		this.options = {};
 		this.eventRecorder = eventRecorder;
@@ -37,7 +38,7 @@ export class SessionTracker implements TrackerInterface {
 
 	public configure(
 		eventRecorder: TrackerEventRecorder,
-		options?: SessionTrackingOptions
+		options?: SessionTrackingOptions,
 	) {
 		this.eventRecorder = eventRecorder;
 
@@ -53,7 +54,7 @@ export class SessionTracker implements TrackerInterface {
 		if (!this.sessionTrackingActive) {
 			sessionListener.addStateChangeListener(
 				this.handleStateChange,
-				!this.initialEventSent
+				!this.initialEventSent,
 			);
 
 			this.sessionTrackingActive = true;

package/src/types/inputs.ts

@@ -2,19 +2,20 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { UserProfile } from '@aws-amplify/core';
+
 import { AnalyticsServiceOptions } from './options';
 import {
-	SessionTrackingOptions,
-	PageViewTrackingOptions,
 	EventTrackingOptions,
+	PageViewTrackingOptions,
+	SessionTrackingOptions,
 } from './trackers';
 
 /**
  * Input type for `identifyUser`.
  */
-export type AnalyticsIdentifyUserInput<
+export interface AnalyticsIdentifyUserInput<
 	ServiceOptions extends AnalyticsServiceOptions = AnalyticsServiceOptions,
-> = {
+> {
 	/**
 	 * A User ID associated to the current device.
 	 */
@@ -29,7 +30,7 @@ export type AnalyticsIdentifyUserInput<
 	 * Options to be passed to the API.
 	 */
 	options?: ServiceOptions;
-};
+}
 
 /**
  * Input type for `configureAutoTrack`.

package/src/types/kinesis.ts

@@ -1,10 +1,10 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-export type KinesisStream = {
+export interface KinesisStream {
 	region: string;
 	streamName: string;
-};
+}
 
 export type KinesisShard = KinesisStream & {
 	partitionKey: string;

package/src/types/trackers.ts

@@ -1,22 +1,22 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-export type SessionTrackingOptions = {
+export interface SessionTrackingOptions {
 	attributes?: TrackerAttributes;
-};
+}
 
-export type PageViewTrackingOptions = {
+export interface PageViewTrackingOptions {
 	attributes?: TrackerAttributes;
 	eventName?: string;
-	urlProvider?: () => string;
+	urlProvider?(): string;
 	appType?: 'multiPage' | 'singlePage';
-};
+}
 
-export type EventTrackingOptions = {
+export interface EventTrackingOptions {
 	attributes?: TrackerAttributes;
 	events?: DOMEvent[];
 	selectorPrefix?: string;
-};
+}
 
 export type TrackerType = 'event' | 'pageView' | 'session';
 
@@ -24,7 +24,7 @@ export type TrackerAttributes = Record<string, string>;
 
 export type TrackerEventRecorder = (
 	eventName: string,
-	attributes: TrackerAttributes
+	attributes: TrackerAttributes,
 ) => void;
 
 export type DOMEvent = keyof GlobalEventHandlersEventMap;

package/src/utils/eventBuffer/EventBuffer.ts

@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { ConsoleLogger } from '@aws-amplify/core';
+
 import { EventBufferConfig, IAnalyticsClient } from './';
 
 const logger = new ConsoleLogger('EventBuffer');
@@ -15,7 +16,7 @@ export class EventBuffer<T> {
 
 	constructor(
 		config: EventBufferConfig,
-		getAnalyticsClient: () => IAnalyticsClient<T>
+		getAnalyticsClient: () => IAnalyticsClient<T>,
 	) {
 		this.list = [];
 		this.config = config;
@@ -27,7 +28,7 @@ export class EventBuffer<T> {
 		for (const event of events) {
 			if (this.list.length + 1 > this.config.bufferSize) {
 				logger.debug(
-					`Exceed ${typeof event} event buffer limits, event dropped`
+					`Exceed ${typeof event} event buffer limits, event dropped`,
 				);
 				continue;
 			}

package/src/utils/eventBuffer/types.ts

@@ -1,12 +1,10 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-export interface IAnalyticsClient<T> {
-	(events: T[]): Promise<T[]>;
-}
+export type IAnalyticsClient<T> = (events: T[]) => Promise<T[]>;
 
-export type EventBufferConfig = {
+export interface EventBufferConfig {
 	flushSize: number;
 	flushInterval: number;
 	bufferSize: number;
-};
+}

package/src/utils/groupBy.ts

@@ -3,13 +3,14 @@
 
 export const groupBy = <T>(
 	getGroupId: (x: T) => string,
-	list: T[]
+	list: T[],
 ): Record<string, T[]> => {
 	return list.reduce(
 		(result, current) => {
 			const groupId = getGroupId(current);
+
 			return { ...result, [groupId]: [...(result[groupId] ?? []), current] };
 		},
-		{} as Record<string, T[]>
+		{} as Record<string, T[]>,
 	);
 };

package/src/utils/resolveCredentials.ts

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