@aws-amplify/analytics 7.0.1-console-preview.8d88eef.0 → 7.0.1-console-preview.b278dcb.0

package/lib/types/index.d.ts

@@ -1,4 +1,3 @@
-export { AutoTrackAttributes, AutoTrackEventOpts, AutoTrackPageViewOpts, AutoTrackSessionOpts, EventAttributes, EventMetrics, EventTrackOpts, PageViewTrackOpts, SessionTrackOpts, } from './analytics';
 export { AnalyticsServiceOptions } from './options';
-export { AnalyticsIdentifyUserInput } from './inputs';
+export { AnalyticsConfigureAutoTrackInput, AnalyticsIdentifyUserInput, } from './inputs';
 export { KinesisStream, KinesisShard, KinesisEventData } from './kinesis';

package/lib/types/inputs.d.ts

@@ -1,5 +1,6 @@
 import { UserProfile } from '@aws-amplify/core';
 import { AnalyticsServiceOptions } from '.';
+import { SessionTrackingOptions, PageViewTrackingOptions, EventTrackingOptions } from './trackers';
 /**
  * Input type for `identifyUser`.
  */
@@ -17,3 +18,18 @@ export type AnalyticsIdentifyUserInput<ServiceOptions extends AnalyticsServiceOp
      */
     options?: ServiceOptions;
 };
+/**
+ * Input type for `configureAutoTrack`.
+ */
+export type AnalyticsConfigureAutoTrackInput = {
+    enable: boolean;
+} & ({
+    type: 'session';
+    options?: SessionTrackingOptions;
+} | {
+    type: 'pageView';
+    options?: PageViewTrackingOptions;
+} | {
+    type: 'event';
+    options?: EventTrackingOptions;
+});

package/lib/types/trackers.d.ts

@@ -0,0 +1,22 @@
+export type SessionTrackingOptions = {
+    attributes?: TrackerAttributes;
+};
+export type PageViewTrackingOptions = {
+    attributes?: TrackerAttributes;
+    eventName?: string;
+    urlProvider?: () => string;
+    appType?: 'multiPage' | 'singlePage';
+};
+export type 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;
+}

package/lib/utils/index.d.ts

@@ -3,3 +3,5 @@ export { groupBy } from './groupBy';
 export { EventBuffer, IAnalyticsClient, EventBufferConfig, } from './eventBuffer';
 export { enableAnalytics, disableAnalytics, isAnalyticsEnabled, } from './statusHelpers';
 export { getAnalyticsUserAgent, getAnalyticsUserAgentString, } from './userAgent';
+export { updateProviderTrackers } from './trackerHelpers';
+export { validateTrackerConfiguration } from './trackerConfigHelpers';

package/lib/utils/index.js

@@ -2,7 +2,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAnalyticsUserAgentString = exports.getAnalyticsUserAgent = exports.isAnalyticsEnabled = exports.disableAnalytics = exports.enableAnalytics = exports.EventBuffer = exports.groupBy = exports.resolveCredentials = void 0;
+exports.validateTrackerConfiguration = exports.updateProviderTrackers = exports.getAnalyticsUserAgentString = exports.getAnalyticsUserAgent = exports.isAnalyticsEnabled = exports.disableAnalytics = exports.enableAnalytics = exports.EventBuffer = exports.groupBy = exports.resolveCredentials = void 0;
 var resolveCredentials_1 = require("./resolveCredentials");
 Object.defineProperty(exports, "resolveCredentials", { enumerable: true, get: function () { return resolveCredentials_1.resolveCredentials; } });
 var groupBy_1 = require("./groupBy");
@@ -16,3 +16,7 @@ Object.defineProperty(exports, "isAnalyticsEnabled", { enumerable: true, get: fu
 var userAgent_1 = require("./userAgent");
 Object.defineProperty(exports, "getAnalyticsUserAgent", { enumerable: true, get: function () { return userAgent_1.getAnalyticsUserAgent; } });
 Object.defineProperty(exports, "getAnalyticsUserAgentString", { enumerable: true, get: function () { return userAgent_1.getAnalyticsUserAgentString; } });
+var trackerHelpers_1 = require("./trackerHelpers");
+Object.defineProperty(exports, "updateProviderTrackers", { enumerable: true, get: function () { return trackerHelpers_1.updateProviderTrackers; } });
+var trackerConfigHelpers_1 = require("./trackerConfigHelpers");
+Object.defineProperty(exports, "validateTrackerConfiguration", { enumerable: true, get: function () { return trackerConfigHelpers_1.validateTrackerConfiguration; } });

package/lib/utils/trackerConfigHelpers.d.ts

@@ -0,0 +1,5 @@
+import { AnalyticsConfigureAutoTrackInput } from '../types';
+/**
+ * Validates tracker configuration.
+ */
+export declare const validateTrackerConfiguration: (input: AnalyticsConfigureAutoTrackInput) => void;

package/lib/utils/trackerConfigHelpers.js

@@ -0,0 +1,15 @@
+"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.validateTrackerConfiguration = void 0;
+var errors_1 = require("../errors");
+/**
+ * Validates tracker configuration.
+ */
+var validateTrackerConfiguration = function (input) {
+    (0, errors_1.assertValidationError)(input.type === 'event' ||
+        input.type === 'pageView' ||
+        input.type === 'session', errors_1.AnalyticsValidationErrorCode.InvalidTracker);
+};
+exports.validateTrackerConfiguration = validateTrackerConfiguration;

package/lib/utils/trackerConfigHelpers.native.d.ts

@@ -0,0 +1,5 @@
+import { AnalyticsConfigureAutoTrackInput } from '../types';
+/**
+ * Validates tracker configuration.
+ */
+export declare const validateTrackerConfiguration: (input: AnalyticsConfigureAutoTrackInput) => void;

package/lib/utils/trackerConfigHelpers.native.js

@@ -0,0 +1,14 @@
+"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.validateTrackerConfiguration = void 0;
+var errors_1 = require("../errors");
+/**
+ * Validates tracker configuration.
+ */
+var validateTrackerConfiguration = function (input) {
+    // React Native only supports session tracking
+    (0, errors_1.assertValidationError)(input.type === 'session', errors_1.AnalyticsValidationErrorCode.UnsupportedPlatform);
+};
+exports.validateTrackerConfiguration = validateTrackerConfiguration;

package/lib/utils/trackerHelpers.d.ts

@@ -0,0 +1,9 @@
+import { TrackerEventRecorder, TrackerInterface, TrackerType } from '../types/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 declare const updateProviderTrackers: (input: ConfigureAutoTrackInput, providerEventRecorder: TrackerEventRecorder, providerTrackers: Partial<Record<TrackerType, TrackerInterface>>) => void;

package/lib/utils/trackerHelpers.js

@@ -0,0 +1,44 @@
+"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.updateProviderTrackers = void 0;
+var trackers_1 = require("../trackers");
+/**
+ * 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`.
+ */
+var updateProviderTrackers = function (input, providerEventRecorder, providerTrackers) {
+    var trackerInstance;
+    var trackerType = input.type;
+    var 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 trackers_1.EventTracker(providerEventRecorder, input.options);
+    }
+    else if (trackerType === 'pageView') {
+        trackerInstance = new trackers_1.PageViewTracker(providerEventRecorder, input.options);
+    }
+    else if (trackerType === 'session') {
+        trackerInstance = new trackers_1.SessionTracker(providerEventRecorder, input.options);
+    }
+    if (trackerInstance) {
+        providerTrackers[trackerType] = trackerInstance;
+    }
+};
+exports.updateProviderTrackers = updateProviderTrackers;

package/lib-esm/errors/validation.d.ts

@@ -4,6 +4,8 @@ export declare enum AnalyticsValidationErrorCode {
     NoCredentials = "NoCredentials",
     NoEventName = "NoEventName",
     NoRegion = "NoRegion",
+    InvalidTracker = "InvalidTracker",
+    UnsupportedPlatform = "UnsupportedPlatform",
     NoTrackingId = "NoTrackingId",
     InvalidFlushSize = "InvalidFlushSize"
 }

package/lib-esm/errors/validation.js

@@ -7,6 +7,8 @@ export var AnalyticsValidationErrorCode;
     AnalyticsValidationErrorCode["NoCredentials"] = "NoCredentials";
     AnalyticsValidationErrorCode["NoEventName"] = "NoEventName";
     AnalyticsValidationErrorCode["NoRegion"] = "NoRegion";
+    AnalyticsValidationErrorCode["InvalidTracker"] = "InvalidTracker";
+    AnalyticsValidationErrorCode["UnsupportedPlatform"] = "UnsupportedPlatform";
     AnalyticsValidationErrorCode["NoTrackingId"] = "NoTrackingId";
     AnalyticsValidationErrorCode["InvalidFlushSize"] = "InvalidFlushSize";
 })(AnalyticsValidationErrorCode || (AnalyticsValidationErrorCode = {}));
@@ -23,6 +25,12 @@ export var validationErrorMap = (_a = {},
     _a[AnalyticsValidationErrorCode.NoRegion] = {
         message: 'Missing region.',
     },
+    _a[AnalyticsValidationErrorCode.InvalidTracker] = {
+        message: 'Invalid tracker type specified.',
+    },
+    _a[AnalyticsValidationErrorCode.UnsupportedPlatform] = {
+        message: 'Only session tracking is supported on React Native.',
+    },
     _a[AnalyticsValidationErrorCode.InvalidFlushSize] = {
         message: 'Invalid FlushSize, it should be smaller than BufferSize',
     },

package/lib-esm/index.d.ts

@@ -1,3 +1,3 @@
-export { record, identifyUser, RecordInput, IdentifyUserInput, flushEvents, } from './providers/pinpoint';
+export { record, identifyUser, configureAutoTrack, flushEvents, RecordInput, IdentifyUserInput, ConfigureAutoTrackInput, } from './providers/pinpoint';
 export { enable, disable } from './apis';
 export { AnalyticsError } from './errors';

package/lib-esm/index.js

@@ -1,5 +1,5 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-export { record, identifyUser, flushEvents, } from './providers/pinpoint';
+export { record, identifyUser, configureAutoTrack, flushEvents, } from './providers/pinpoint';
 export { enable, disable } from './apis';
 export { AnalyticsError } from './errors';

package/lib-esm/providers/pinpoint/apis/configureAutoTrack.d.ts

@@ -0,0 +1,15 @@
+import { ConfigureAutoTrackInput } from '../types';
+/**
+ * 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).
+ *
+ * @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 declare const configureAutoTrack: (input: ConfigureAutoTrackInput) => void;

package/lib-esm/providers/pinpoint/apis/configureAutoTrack.js

@@ -0,0 +1,31 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { updateProviderTrackers, validateTrackerConfiguration, } from '../../../utils';
+import { record } from './record';
+// Configured Tracker instances for Pinpoint
+var configuredTrackers = {};
+// Callback that will emit an appropriate event to Pinpoint when required by the Tracker
+var emitTrackingEvent = function (eventName, attributes) {
+    record({
+        name: eventName,
+        attributes: 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).
+ *
+ * @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 var configureAutoTrack = function (input) {
+    validateTrackerConfiguration(input);
+    // Initialize or update this provider's trackers
+    updateProviderTrackers(input, emitTrackingEvent, configuredTrackers);
+};

package/lib-esm/providers/pinpoint/apis/index.d.ts

@@ -1,3 +1,4 @@
 export { record } from './record';
 export { identifyUser } from './identifyUser';
+export { configureAutoTrack } from './configureAutoTrack';
 export { flushEvents } from './flushEvents';

package/lib-esm/providers/pinpoint/apis/index.js

@@ -2,4 +2,5 @@
 // SPDX-License-Identifier: Apache-2.0
 export { record } from './record';
 export { identifyUser } from './identifyUser';
+export { configureAutoTrack } from './configureAutoTrack';
 export { flushEvents } from './flushEvents';

package/lib-esm/providers/pinpoint/apis/record.js

@@ -1,7 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import { Hub, ConsoleLogger } from '@aws-amplify/core';
-import { AMPLIFY_SYMBOL, AnalyticsAction } from '@aws-amplify/core/internals/utils';
+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';

package/lib-esm/providers/pinpoint/index.d.ts

@@ -1,2 +1,2 @@
-export { record, identifyUser, flushEvents } from './apis';
-export { RecordInput, IdentifyUserInput } from './types/inputs';
+export { record, identifyUser, flushEvents, configureAutoTrack } from './apis';
+export { RecordInput, IdentifyUserInput, ConfigureAutoTrackInput, } from './types/inputs';

package/lib-esm/providers/pinpoint/index.js

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

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

@@ -1,2 +1,2 @@
-export { RecordInput, IdentifyUserInput } from './inputs';
+export { RecordInput, IdentifyUserInput, ConfigureAutoTrackInput, } from './inputs';
 export { IdentifyUserOptions } from './options';

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

@@ -1,6 +1,6 @@
 import { PinpointAnalyticsEvent } from '@aws-amplify/core/internals/providers/pinpoint';
 import { IdentifyUserOptions } from '.';
-import { AnalyticsIdentifyUserInput } from '../../../types';
+import { AnalyticsConfigureAutoTrackInput, AnalyticsIdentifyUserInput } from '../../../types';
 /**
  * Input type for Pinpoint record API.
  */
@@ -9,3 +9,7 @@ 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/lib-esm/trackers/EventTracker.d.ts

@@ -0,0 +1,10 @@
+import { EventTrackingOptions, TrackerEventRecorder, TrackerInterface } from '../types/trackers';
+export declare class EventTracker implements TrackerInterface {
+    private trackerActive;
+    private options;
+    private eventRecorder;
+    constructor(eventRecorder: TrackerEventRecorder, options?: EventTrackingOptions);
+    configure(eventRecorder: TrackerEventRecorder, options?: EventTrackingOptions): void;
+    cleanup(): void;
+    private handleDocEvent;
+}

package/lib-esm/trackers/EventTracker.js

@@ -0,0 +1,101 @@
+// 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';
+var DEFAULT_EVENTS = ['click'];
+var DEFAULT_SELECTOR_PREFIX = 'data-amplify-analytics-';
+var DEFAULT_EVENT_NAME = 'event'; // Default event name as sent to the analytics provider
+var logger = new ConsoleLogger('EventTracker');
+var EventTracker = /** @class */ (function () {
+    function EventTracker(eventRecorder, options) {
+        this.options = {};
+        this.trackerActive = false;
+        this.eventRecorder = eventRecorder;
+        this.handleDocEvent = this.handleDocEvent.bind(this);
+        this.configure(eventRecorder, options);
+    }
+    EventTracker.prototype.configure = function (eventRecorder, options) {
+        var _this = this;
+        var _a, _b, _c, _d;
+        this.eventRecorder = eventRecorder;
+        // Clean up any existing listeners
+        this.cleanup();
+        // Apply defaults
+        this.options = {
+            attributes: (_a = options === null || options === void 0 ? void 0 : options.attributes) !== null && _a !== void 0 ? _a : undefined,
+            events: (_b = options === null || options === void 0 ? void 0 : options.events) !== null && _b !== void 0 ? _b : DEFAULT_EVENTS,
+            selectorPrefix: (_c = options === null || options === void 0 ? void 0 : options.selectorPrefix) !== null && _c !== void 0 ? _c : DEFAULT_SELECTOR_PREFIX,
+        };
+        // Register event listeners
+        if (isBrowser()) {
+            (_d = this.options.events) === null || _d === void 0 ? void 0 : _d.forEach(function (targetEvent) {
+                document.addEventListener(targetEvent, _this.handleDocEvent, {
+                    capture: true,
+                });
+            });
+            this.trackerActive = true;
+        }
+    };
+    EventTracker.prototype.cleanup = function () {
+        var _this = this;
+        var _a;
+        // No-op if document listener is not active
+        if (!this.trackerActive) {
+            return;
+        }
+        // Clean up event listeners
+        (_a = this.options.events) === null || _a === void 0 ? void 0 : _a.forEach(function (targetEvent) {
+            document.removeEventListener(targetEvent, _this.handleDocEvent, {
+                capture: true,
+            });
+        });
+    };
+    EventTracker.prototype.handleDocEvent = function (event) {
+        var _a;
+        /**
+         * Example DOM element:
+         *
+         * ```
+         * <button
+         *   data-amplify-analytics-on="click"
+         *   data-amplify-analytics-name="click"
+         *   data-amplify-analytics-attrs="attr1:attr1_value,attr2:attr2_value"
+         * />
+         * ```
+         */
+        var triggerSelector = "[".concat(this.options.selectorPrefix, "on]");
+        var attrSelector = "".concat(this.options.selectorPrefix, "attrs");
+        var eventNameSelector = "".concat(this.options.selectorPrefix, "name");
+        var eventSource = event.target;
+        // Validate that the triggering event type is being tracked
+        if (!((_a = this.options.events) === null || _a === void 0 ? void 0 : _a.includes(event.type))) {
+            return;
+        }
+        if (eventSource instanceof HTMLElement) {
+            var target = eventSource.closest(triggerSelector);
+            if (target) {
+                // Parse event name from the element
+                var eventName = target.getAttribute(eventNameSelector) || DEFAULT_EVENT_NAME;
+                // Parse attributes from the element
+                var elementAttributes_1 = {};
+                var rawElementAttributes = target.getAttribute(attrSelector);
+                rawElementAttributes === null || rawElementAttributes === void 0 ? void 0 : rawElementAttributes.split(/\s*,\s*/).forEach(function (attr) {
+                    var tmp = attr.trim().split(/\s*:\s*/);
+                    elementAttributes_1[tmp[0]] = tmp[1];
+                });
+                // Assemble final list of attributes
+                var attributes = Object.assign({
+                    type: event.type,
+                    target: "".concat(target.localName, " with id ").concat(target.id),
+                }, this.options.attributes, elementAttributes_1);
+                logger.debug('Recording automatically tracked DOM event', {
+                    eventName: eventName,
+                    attributes: attributes,
+                });
+                this.eventRecorder(eventName, attributes);
+            }
+        }
+    };
+    return EventTracker;
+}());
+export { EventTracker };

package/lib-esm/trackers/PageViewTracker.d.ts

@@ -0,0 +1,18 @@
+import { PageViewTrackingOptions, TrackerEventRecorder, TrackerInterface } from '../types/trackers';
+export declare class PageViewTracker implements TrackerInterface {
+    private trackerActive;
+    private options;
+    private eventRecorder;
+    private spaTrackingActive;
+    private pushStateProxy?;
+    private replaceStateProxy?;
+    private originalPushState;
+    private originalReplaceState;
+    constructor(eventRecorder: TrackerEventRecorder, options?: PageViewTrackingOptions);
+    configure(eventRecorder: TrackerEventRecorder, options?: PageViewTrackingOptions): void;
+    cleanup(): void;
+    private setupSPATracking;
+    private setupMPATracking;
+    private handleLocationChange;
+    private urlHasChanged;
+}

package/lib-esm/trackers/PageViewTracker.js

@@ -0,0 +1,113 @@
+// 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';
+var logger = new ConsoleLogger('PageViewTracker');
+var DEFAULT_EVENT_NAME = 'pageView';
+var DEFAULT_APP_TYPE = 'singlePage';
+var DEFAULT_URL_PROVIDER = function () {
+    return window.location.origin + window.location.pathname;
+};
+var PREV_URL_STORAGE_KEY = 'aws-amplify-analytics-prevUrl';
+var PageViewTracker = /** @class */ (function () {
+    function PageViewTracker(eventRecorder, options) {
+        this.options = {};
+        this.trackerActive = true;
+        this.eventRecorder = eventRecorder;
+        this.spaTrackingActive = false;
+        this.handleLocationChange = this.handleLocationChange.bind(this);
+        this.configure(eventRecorder, options);
+    }
+    PageViewTracker.prototype.configure = function (eventRecorder, options) {
+        var _a, _b, _c, _d, _e, _f;
+        this.eventRecorder = eventRecorder;
+        // Clean up any existing listeners
+        this.cleanup();
+        // Apply defaults
+        this.options = {
+            appType: (_a = options === null || options === void 0 ? void 0 : options.appType) !== null && _a !== void 0 ? _a : DEFAULT_APP_TYPE,
+            attributes: (_b = options === null || options === void 0 ? void 0 : options.attributes) !== null && _b !== void 0 ? _b : undefined,
+            eventName: (_d = (_c = this.options) === null || _c === void 0 ? void 0 : _c.eventName) !== null && _d !== void 0 ? _d : DEFAULT_EVENT_NAME,
+            urlProvider: (_f = (_e = this.options) === null || _e === void 0 ? void 0 : _e.urlProvider) !== null && _f !== void 0 ? _f : 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;
+        }
+    };
+    PageViewTracker.prototype.cleanup = function () {
+        var _a, _b;
+        // 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;
+            (_a = this.pushStateProxy) === null || _a === void 0 ? void 0 : _a.revoke();
+            (_b = this.replaceStateProxy) === null || _b === void 0 ? void 0 : _b.revoke();
+            window.removeEventListener('popstate', this.handleLocationChange);
+            this.spaTrackingActive = false;
+        }
+    };
+    PageViewTracker.prototype.setupSPATracking = function () {
+        var _this = this;
+        if (!this.spaTrackingActive) {
+            // Configure proxies on History APIs
+            this.pushStateProxy = Proxy.revocable(window.history.pushState, {
+                apply: function (target, thisArg, args) {
+                    var proxiedResult = target.apply(thisArg, args);
+                    _this.handleLocationChange();
+                    return proxiedResult;
+                },
+            });
+            this.replaceStateProxy = Proxy.revocable(window.history.replaceState, {
+                apply: function (target, thisArg, args) {
+                    var proxiedResult = target.apply(thisArg, args);
+                    _this.handleLocationChange();
+                    return proxiedResult;
+                },
+            });
+            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;
+        }
+    };
+    PageViewTracker.prototype.setupMPATracking = function () {
+        this.handleLocationChange();
+    };
+    PageViewTracker.prototype.handleLocationChange = function () {
+        var currentUrl = this.options.urlProvider();
+        var eventName = this.options.eventName || DEFAULT_EVENT_NAME;
+        if (this.urlHasChanged()) {
+            sessionStorage.setItem(PREV_URL_STORAGE_KEY, currentUrl);
+            // Assemble attribute list
+            var attributes = Object.assign({
+                url: currentUrl,
+            }, this.options.attributes);
+            logger.debug('Recording automatically tracked page view event', {
+                eventName: eventName,
+                attributes: attributes,
+            });
+            this.eventRecorder(eventName, attributes);
+        }
+    };
+    PageViewTracker.prototype.urlHasChanged = function () {
+        var prevUrl = sessionStorage.getItem(PREV_URL_STORAGE_KEY);
+        var currUrl = this.options.urlProvider();
+        return currUrl !== prevUrl;
+    };
+    return PageViewTracker;
+}());
+export { PageViewTracker };

package/lib-esm/trackers/SessionTracker.d.ts

@@ -0,0 +1,13 @@
+import { SessionTrackingOptions, TrackerEventRecorder, TrackerInterface } from '../types/trackers';
+export declare class SessionTracker implements TrackerInterface {
+    private options;
+    private eventRecorder;
+    private sessionTrackingActive;
+    private initialEventSent;
+    constructor(eventRecorder: TrackerEventRecorder, options?: SessionTrackingOptions);
+    configure(eventRecorder: TrackerEventRecorder, options?: SessionTrackingOptions): void;
+    cleanup(): void;
+    private handleStateChange;
+    private sessionStarted;
+    private sessionStopped;
+}