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

package/lib/trackers/EventTracker.js

@@ -0,0 +1,104 @@
+"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.EventTracker = void 0;
+var core_1 = require("@aws-amplify/core");
+var utils_1 = require("@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 core_1.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 ((0, utils_1.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;
+}());
+exports.EventTracker = EventTracker;

package/lib/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/trackers/PageViewTracker.js

@@ -0,0 +1,116 @@
+"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.PageViewTracker = void 0;
+var core_1 = require("@aws-amplify/core");
+var utils_1 = require("@aws-amplify/core/internals/utils");
+var logger = new core_1.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 ((0, utils_1.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;
+}());
+exports.PageViewTracker = PageViewTracker;

package/lib/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/trackers/SessionTracker.js

@@ -0,0 +1,73 @@
+"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.SessionTracker = void 0;
+var utils_1 = require("@aws-amplify/core/internals/utils");
+var core_1 = require("@aws-amplify/core");
+var SESSION_START_EVENT = '_session.start';
+var SESSION_STOP_EVENT = '_session.stop';
+var logger = new core_1.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) {
+            utils_1.sessionListener.addStateChangeListener(this.handleStateChange, !this.initialEventSent);
+            this.sessionTrackingActive = true;
+        }
+    };
+    SessionTracker.prototype.cleanup = function () {
+        if (this.sessionTrackingActive) {
+            utils_1.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;
+}());
+exports.SessionTracker = SessionTracker;

package/lib/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/trackers/SessionTracker.native.js

@@ -0,0 +1,73 @@
+"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.SessionTracker = void 0;
+var utils_1 = require("@aws-amplify/core/internals/utils");
+var core_1 = require("@aws-amplify/core");
+var SESSION_START_EVENT = '_session.start';
+var SESSION_STOP_EVENT = '_session.stop';
+var logger = new core_1.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) {
+            utils_1.sessionListener.addStateChangeListener(this.handleStateChange, !this.initialEventSent);
+            this.sessionTrackingActive = true;
+        }
+    };
+    SessionTracker.prototype.cleanup = function () {
+        if (this.sessionTrackingActive) {
+            utils_1.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;
+}());
+exports.SessionTracker = SessionTracker;

package/lib/trackers/index.d.ts

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

package/lib/trackers/index.js

@@ -0,0 +1,11 @@
+"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.SessionTracker = exports.PageViewTracker = exports.EventTracker = void 0;
+var EventTracker_1 = require("./EventTracker");
+Object.defineProperty(exports, "EventTracker", { enumerable: true, get: function () { return EventTracker_1.EventTracker; } });
+var PageViewTracker_1 = require("./PageViewTracker");
+Object.defineProperty(exports, "PageViewTracker", { enumerable: true, get: function () { return PageViewTracker_1.PageViewTracker; } });
+var SessionTracker_1 = require("./SessionTracker");
+Object.defineProperty(exports, "SessionTracker", { enumerable: true, get: function () { return SessionTracker_1.SessionTracker; } });