@aws-amplify/analytics 7.0.1-api-v6-models.8035dfc.0 → 7.0.1-api-v6-models.3eb7748.0

package/src/utils/trackerHelpers.ts

@@ -0,0 +1,57 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import {
+	TrackerAttributes,
+	TrackerEventRecorder,
+	TrackerInterface,
+	TrackerType,
+} from '../types/trackers';
+import { EventTracker, PageViewTracker, SessionTracker } from '../trackers';
+import { ConfigureAutoTrackInput } from '../providers/pinpoint';
+
+/**
+ * Updates a provider's trackers as appropriate for the provided auto-track configuration.
+ *
+ * @remark
+ * This utility will mutate the provider's configured trackers via `providerTrackers`.
+ */
+export const updateProviderTrackers = (
+	input: ConfigureAutoTrackInput,
+	providerEventRecorder: TrackerEventRecorder,
+	providerTrackers: Partial<Record<TrackerType, TrackerInterface>>
+) => {
+	let trackerInstance;
+	const trackerType = input.type;
+	const currentTracker = providerTrackers[trackerType];
+
+	// Check if the tracker was disabled & should be cleaned up
+	if (!input.enable) {
+		if (currentTracker) {
+			currentTracker.cleanup();
+			delete providerTrackers[trackerType];
+		}
+
+		return;
+	}
+
+	// Re-configure the existing tracker, or create & configure an instance if it doesn't exist yet
+	if (currentTracker) {
+		currentTracker.configure(providerEventRecorder, input.options);
+
+		return;
+	}
+
+	// Create a new tracker instance for the type
+	if (trackerType === 'event') {
+		trackerInstance = new EventTracker(providerEventRecorder, input.options);
+	} else if (trackerType === 'pageView') {
+		trackerInstance = new PageViewTracker(providerEventRecorder, input.options);
+	} else if (trackerType === 'session') {
+		trackerInstance = new SessionTracker(providerEventRecorder, input.options);
+	}
+
+	if (trackerInstance) {
+		providerTrackers[trackerType] = trackerInstance;
+	}
+};

package/lib/providers/pinpoint/types/errors.d.ts

@@ -1,9 +0,0 @@
-export declare enum UpdateEndpointException {
-    BadRequestException = "BadRequestException",
-    ForbiddenException = "ForbiddenException",
-    InternalServerErrorException = "InternalServerErrorException",
-    MethodNotAllowedException = "MethodNotAllowedException",
-    NotFoundException = "NotFoundException",
-    PayloadTooLargeException = "PayloadTooLargeException",
-    TooManyRequestsException = "TooManyRequestsException"
-}

package/lib/providers/pinpoint/types/errors.js

@@ -1,15 +0,0 @@
-"use strict";
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UpdateEndpointException = void 0;
-var UpdateEndpointException;
-(function (UpdateEndpointException) {
-    UpdateEndpointException["BadRequestException"] = "BadRequestException";
-    UpdateEndpointException["ForbiddenException"] = "ForbiddenException";
-    UpdateEndpointException["InternalServerErrorException"] = "InternalServerErrorException";
-    UpdateEndpointException["MethodNotAllowedException"] = "MethodNotAllowedException";
-    UpdateEndpointException["NotFoundException"] = "NotFoundException";
-    UpdateEndpointException["PayloadTooLargeException"] = "PayloadTooLargeException";
-    UpdateEndpointException["TooManyRequestsException"] = "TooManyRequestsException";
-})(UpdateEndpointException = exports.UpdateEndpointException || (exports.UpdateEndpointException = {}));

package/lib/types/analytics.d.ts

@@ -1,50 +0,0 @@
-/**
- * Analytics instance options
- */
-export interface EventAttributes {
-    [key: string]: string;
-}
-export interface EventMetrics {
-    [key: string]: number;
-}
-export interface PageViewTrackOpts {
-    enable: boolean;
-    type?: string;
-    eventName?: string;
-    provider?: string;
-    attributes?: EventAttributes | (() => EventAttributes | Promise<EventAttributes>);
-    getUrl?: () => string;
-}
-export interface EventTrackOpts {
-    enable: boolean;
-    events?: Array<string>;
-    selectorPrefix?: string;
-    provider?: string;
-    attributes?: EventAttributes | (() => EventAttributes | Promise<EventAttributes>);
-}
-export interface SessionTrackOpts {
-    enable: boolean;
-    attributes?: EventAttributes | (() => EventAttributes | Promise<EventAttributes>);
-    provider?: string;
-}
-export type AutoTrackAttributes = (() => EventAttributes | Promise<EventAttributes>) | EventAttributes;
-export interface AutoTrackSessionOpts {
-    enable: boolean;
-    attributes?: AutoTrackAttributes;
-    provider?: string;
-}
-export interface AutoTrackPageViewOpts {
-    enable: boolean;
-    eventName?: string;
-    attributes?: AutoTrackAttributes;
-    type?: 'SPA' | 'multiPageApp';
-    provider?: string;
-    getUrl?: () => string;
-}
-export interface AutoTrackEventOpts {
-    enable: boolean;
-    events?: string[];
-    selectorPrefix?: string;
-    provider?: string;
-    attributes?: AutoTrackAttributes;
-}

package/lib-esm/providers/pinpoint/types/errors.d.ts

@@ -1,9 +0,0 @@
-export declare enum UpdateEndpointException {
-    BadRequestException = "BadRequestException",
-    ForbiddenException = "ForbiddenException",
-    InternalServerErrorException = "InternalServerErrorException",
-    MethodNotAllowedException = "MethodNotAllowedException",
-    NotFoundException = "NotFoundException",
-    PayloadTooLargeException = "PayloadTooLargeException",
-    TooManyRequestsException = "TooManyRequestsException"
-}

package/lib-esm/providers/pinpoint/types/errors.js

@@ -1,12 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-export var UpdateEndpointException;
-(function (UpdateEndpointException) {
-    UpdateEndpointException["BadRequestException"] = "BadRequestException";
-    UpdateEndpointException["ForbiddenException"] = "ForbiddenException";
-    UpdateEndpointException["InternalServerErrorException"] = "InternalServerErrorException";
-    UpdateEndpointException["MethodNotAllowedException"] = "MethodNotAllowedException";
-    UpdateEndpointException["NotFoundException"] = "NotFoundException";
-    UpdateEndpointException["PayloadTooLargeException"] = "PayloadTooLargeException";
-    UpdateEndpointException["TooManyRequestsException"] = "TooManyRequestsException";
-})(UpdateEndpointException || (UpdateEndpointException = {}));

package/lib-esm/types/analytics.d.ts

@@ -1,50 +0,0 @@
-/**
- * Analytics instance options
- */
-export interface EventAttributes {
-    [key: string]: string;
-}
-export interface EventMetrics {
-    [key: string]: number;
-}
-export interface PageViewTrackOpts {
-    enable: boolean;
-    type?: string;
-    eventName?: string;
-    provider?: string;
-    attributes?: EventAttributes | (() => EventAttributes | Promise<EventAttributes>);
-    getUrl?: () => string;
-}
-export interface EventTrackOpts {
-    enable: boolean;
-    events?: Array<string>;
-    selectorPrefix?: string;
-    provider?: string;
-    attributes?: EventAttributes | (() => EventAttributes | Promise<EventAttributes>);
-}
-export interface SessionTrackOpts {
-    enable: boolean;
-    attributes?: EventAttributes | (() => EventAttributes | Promise<EventAttributes>);
-    provider?: string;
-}
-export type AutoTrackAttributes = (() => EventAttributes | Promise<EventAttributes>) | EventAttributes;
-export interface AutoTrackSessionOpts {
-    enable: boolean;
-    attributes?: AutoTrackAttributes;
-    provider?: string;
-}
-export interface AutoTrackPageViewOpts {
-    enable: boolean;
-    eventName?: string;
-    attributes?: AutoTrackAttributes;
-    type?: 'SPA' | 'multiPageApp';
-    provider?: string;
-    getUrl?: () => string;
-}
-export interface AutoTrackEventOpts {
-    enable: boolean;
-    events?: string[];
-    selectorPrefix?: string;
-    provider?: string;
-    attributes?: AutoTrackAttributes;
-}

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

@@ -1,12 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-export enum UpdateEndpointException {
-	BadRequestException = 'BadRequestException',
-	ForbiddenException = 'ForbiddenException',
-	InternalServerErrorException = 'InternalServerErrorException',
-	MethodNotAllowedException = 'MethodNotAllowedException',
-	NotFoundException = 'NotFoundException',
-	PayloadTooLargeException = 'PayloadTooLargeException',
-	TooManyRequestsException = 'TooManyRequestsException',
-}

package/src/types/analytics.ts

@@ -1,70 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-/**
- * Analytics instance options
- */
-
-export interface EventAttributes {
-	[key: string]: string;
-}
-
-export interface EventMetrics {
-	[key: string]: number;
-}
-
-export interface PageViewTrackOpts {
-	enable: boolean;
-	type?: string;
-	eventName?: string;
-	provider?: string;
-	attributes?:
-		| EventAttributes
-		| (() => EventAttributes | Promise<EventAttributes>);
-	getUrl?: () => string;
-}
-
-export interface EventTrackOpts {
-	enable: boolean;
-	events?: Array<string>;
-	selectorPrefix?: string;
-	provider?: string;
-	attributes?:
-		| EventAttributes
-		| (() => EventAttributes | Promise<EventAttributes>);
-}
-
-export interface SessionTrackOpts {
-	enable: boolean;
-	attributes?:
-		| EventAttributes
-		| (() => EventAttributes | Promise<EventAttributes>);
-	provider?: string;
-}
-
-export type AutoTrackAttributes =
-	| (() => EventAttributes | Promise<EventAttributes>)
-	| EventAttributes;
-
-export interface AutoTrackSessionOpts {
-	enable: boolean;
-	attributes?: AutoTrackAttributes;
-	provider?: string;
-}
-
-export interface AutoTrackPageViewOpts {
-	enable: boolean;
-	eventName?: string;
-	attributes?: AutoTrackAttributes;
-	type?: 'SPA' | 'multiPageApp';
-	provider?: string;
-	getUrl?: () => string;
-}
-
-export interface AutoTrackEventOpts {
-	enable: boolean;
-	events?: string[];
-	selectorPrefix?: string;
-	provider?: string;
-	attributes?: AutoTrackAttributes;
-}