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

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;
+}

package/lib-esm/trackers/SessionTracker.js

@@ -0,0 +1,70 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { sessionListener, } from '@aws-amplify/core/internals/utils';
+import { ConsoleLogger } from '@aws-amplify/core';
+var SESSION_START_EVENT = '_session.start';
+var SESSION_STOP_EVENT = '_session.stop';
+var logger = new ConsoleLogger('SessionTracker');
+var SessionTracker = /** @class */ (function () {
+    function SessionTracker(eventRecorder, options) {
+        this.options = {};
+        this.eventRecorder = eventRecorder;
+        this.sessionTrackingActive = false;
+        this.initialEventSent = false;
+        this.handleStateChange = this.handleStateChange.bind(this);
+        this.configure(eventRecorder, options);
+    }
+    SessionTracker.prototype.configure = function (eventRecorder, options) {
+        var _a;
+        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 : {},
+        };
+        // Setup state listeners
+        if (!this.sessionTrackingActive) {
+            sessionListener.addStateChangeListener(this.handleStateChange, !this.initialEventSent);
+            this.sessionTrackingActive = true;
+        }
+    };
+    SessionTracker.prototype.cleanup = function () {
+        if (this.sessionTrackingActive) {
+            sessionListener.removeStateChangeListener(this.handleStateChange);
+        }
+        this.sessionTrackingActive = false;
+    };
+    SessionTracker.prototype.handleStateChange = function (state) {
+        if (state === 'started') {
+            this.sessionStarted();
+        }
+        else {
+            this.sessionStopped();
+        }
+    };
+    SessionTracker.prototype.sessionStarted = function () {
+        var _a;
+        var attributes = (_a = this.options.attributes) !== null && _a !== void 0 ? _a : {};
+        logger.debug('Recording automatically tracked page view event', {
+            SESSION_START_EVENT: SESSION_START_EVENT,
+            attributes: attributes,
+        });
+        this.eventRecorder(SESSION_START_EVENT, attributes);
+        // NOTE: The initial event will not be re-sent on re-configuration (e.g. to add additional custom attributes)
+        if (!this.initialEventSent) {
+            this.initialEventSent = true;
+        }
+    };
+    SessionTracker.prototype.sessionStopped = function () {
+        var _a;
+        var attributes = (_a = this.options.attributes) !== null && _a !== void 0 ? _a : {};
+        logger.debug('Recording automatically tracked page view event', {
+            SESSION_STOP_EVENT: SESSION_STOP_EVENT,
+            attributes: attributes,
+        });
+        this.eventRecorder(SESSION_STOP_EVENT, attributes);
+    };
+    return SessionTracker;
+}());
+export { SessionTracker };

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

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

package/lib-esm/trackers/SessionTracker.native.js

@@ -0,0 +1,70 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { sessionListener, } from '@aws-amplify/core/internals/utils';
+import { ConsoleLogger } from '@aws-amplify/core';
+var SESSION_START_EVENT = '_session.start';
+var SESSION_STOP_EVENT = '_session.stop';
+var logger = new ConsoleLogger('SessionTracker');
+var SessionTracker = /** @class */ (function () {
+    function SessionTracker(eventRecorder, options) {
+        this.options = {};
+        this.eventRecorder = eventRecorder;
+        this.initialEventSent = false;
+        this.sessionTrackingActive = false;
+        this.handleStateChange = this.handleStateChange.bind(this);
+        this.configure(eventRecorder, options);
+    }
+    SessionTracker.prototype.configure = function (eventRecorder, options) {
+        var _a;
+        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 : {},
+        };
+        // Setup state listeners
+        if (!this.sessionTrackingActive) {
+            sessionListener.addStateChangeListener(this.handleStateChange, !this.initialEventSent);
+            this.sessionTrackingActive = true;
+        }
+    };
+    SessionTracker.prototype.cleanup = function () {
+        if (this.sessionTrackingActive) {
+            sessionListener.removeStateChangeListener(this.handleStateChange);
+        }
+        this.sessionTrackingActive = false;
+    };
+    SessionTracker.prototype.handleStateChange = function (state) {
+        if (state === 'started') {
+            this.sessionStarted();
+        }
+        else {
+            this.sessionStopped();
+        }
+    };
+    SessionTracker.prototype.sessionStarted = function () {
+        var _a;
+        var attributes = (_a = this.options.attributes) !== null && _a !== void 0 ? _a : {};
+        logger.debug('Recording automatically tracked page view event', {
+            SESSION_START_EVENT: SESSION_START_EVENT,
+            attributes: attributes,
+        });
+        this.eventRecorder(SESSION_START_EVENT, attributes);
+        // NOTE: The initial event will not be re-sent on re-configuration (e.g. to add additional custom attributes)
+        if (!this.initialEventSent) {
+            this.initialEventSent = true;
+        }
+    };
+    SessionTracker.prototype.sessionStopped = function () {
+        var _a;
+        var attributes = (_a = this.options.attributes) !== null && _a !== void 0 ? _a : {};
+        logger.debug('Recording automatically tracked page view event', {
+            SESSION_STOP_EVENT: SESSION_STOP_EVENT,
+            attributes: attributes,
+        });
+        this.eventRecorder(SESSION_STOP_EVENT, attributes);
+    };
+    return SessionTracker;
+}());
+export { SessionTracker };

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

@@ -0,0 +1,3 @@
+export { EventTracker } from './EventTracker';
+export { PageViewTracker } from './PageViewTracker';
+export { SessionTracker } from './SessionTracker';

package/lib-esm/trackers/index.js

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