@aws-amplify/analytics 6.5.6-api-v6-models.b3abc9b.0 → 7.0.0

package/lib/trackers/SessionTracker.js

@@ -2,162 +2,66 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 Object.defineProperty(exports, "__esModule", { value: true });
-var tslib_1 = require("tslib");
-// the session tracker for web
-var core_1 = require("@aws-amplify/core");
-var logger = new core_1.ConsoleLogger('SessionTracker');
-var defaultOpts = {
-    enable: false,
-    provider: 'AWSPinpoint',
-};
-var initialEventSent = false;
-var SessionTracker = /** @class */ (function () {
-    function SessionTracker(tracker, opts) {
-        this._config = Object.assign({}, defaultOpts, opts);
-        this._tracker = tracker;
-        this._hasEnabled = false;
-        this._trackFunc = this._trackFunc.bind(this);
-        this._trackBeforeUnload = this._trackBeforeUnload.bind(this);
-        this.configure(this._config);
+exports.SessionTracker = void 0;
+const utils_1 = require("@aws-amplify/core/internals/utils");
+const core_1 = require("@aws-amplify/core");
+const logger = new core_1.ConsoleLogger('SessionTracker');
+class SessionTracker {
+    constructor(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._envCheck = function () {
-        if (!core_1.browserOrNode().isBrowser) {
-            return false;
+    configure(eventRecorder, options) {
+        this.eventRecorder = eventRecorder;
+        // Clean up any existing listeners
+        this.cleanup();
+        // Apply defaults
+        this.options = {
+            attributes: options?.attributes ?? {},
+        };
+        // Setup state listeners
+        if (!this.sessionTrackingActive) {
+            utils_1.sessionListener.addStateChangeListener(this.handleStateChange, !this.initialEventSent);
+            this.sessionTrackingActive = true;
         }
-        if (!document || !document.addEventListener) {
-            logger.debug('not in the supported web environment');
-            return false;
-        }
-        if (typeof document.hidden !== 'undefined') {
-            this._hidden = 'hidden';
-            this._visibilityChange = 'visibilitychange';
-        }
-        else if (typeof document['msHidden'] !== 'undefined') {
-            this._hidden = 'msHidden';
-            this._visibilityChange = 'msvisibilitychange';
+    }
+    cleanup() {
+        if (this.sessionTrackingActive) {
+            utils_1.sessionListener.removeStateChangeListener(this.handleStateChange);
         }
-        else if (typeof document['webkitHidden'] !== 'undefined') {
-            this._hidden = 'webkitHidden';
-            this._visibilityChange = 'webkitvisibilitychange';
+        this.sessionTrackingActive = false;
+    }
+    handleStateChange(state) {
+        if (state === 'started') {
+            this.sessionStarted();
         }
         else {
-            logger.debug('not in the supported web environment');
-            return false;
+            this.sessionStopped();
         }
-        return true;
-    };
-    SessionTracker.prototype._trackFunc = function () {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var customAttrs, _a, attributes;
-            return tslib_1.__generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        if (!(typeof this._config.attributes === 'function')) return [3 /*break*/, 2];
-                        return [4 /*yield*/, this._config.attributes()];
-                    case 1:
-                        _a = _b.sent();
-                        return [3 /*break*/, 3];
-                    case 2:
-                        _a = this._config.attributes;
-                        _b.label = 3;
-                    case 3:
-                        customAttrs = _a;
-                        attributes = Object.assign({}, customAttrs);
-                        if (document.visibilityState === this._hidden) {
-                            this._tracker({
-                                name: '_session.stop',
-                                attributes: attributes,
-                            }, this._config.provider).catch(function (e) {
-                                logger.debug('record session stop event failed.', e);
-                            });
-                        }
-                        else {
-                            this._tracker({
-                                name: '_session.start',
-                                attributes: attributes,
-                            }, this._config.provider).catch(function (e) {
-                                logger.debug('record session start event failed.', e);
-                            });
-                        }
-                        return [2 /*return*/];
-                }
-            });
-        });
-    };
-    SessionTracker.prototype._trackBeforeUnload = function (event) {
-        // before unload callback cannot be async => https://github.com/aws-amplify/amplify-js/issues/2088
-        var _this = this;
-        var customAttrs = typeof this._config.attributes === 'function'
-            ? Promise.resolve(this._config.attributes())
-            : Promise.resolve(this._config.attributes);
-        customAttrs.then(function (custom) {
-            var attributes = Object.assign({}, custom);
-            _this._tracker({
-                name: '_session.stop',
-                attributes: attributes,
-                immediate: true,
-            }, _this._config.provider).catch(function (e) {
-                logger.debug('record session stop event failed.', e);
-            });
-        });
-    };
-    // to keep configure a synchronized function
-    SessionTracker.prototype._sendInitialEvent = function () {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var customAttrs, _a, attributes;
-            return tslib_1.__generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        if (initialEventSent) {
-                            logger.debug('the start session has been sent when the page is loaded');
-                            return [2 /*return*/];
-                        }
-                        else {
-                            initialEventSent = true;
-                        }
-                        if (!(typeof this._config.attributes === 'function')) return [3 /*break*/, 2];
-                        return [4 /*yield*/, this._config.attributes()];
-                    case 1:
-                        _a = _b.sent();
-                        return [3 /*break*/, 3];
-                    case 2:
-                        _a = this._config.attributes;
-                        _b.label = 3;
-                    case 3:
-                        customAttrs = _a;
-                        attributes = Object.assign({}, customAttrs);
-                        this._tracker({
-                            name: '_session.start',
-                            attributes: attributes,
-                        }, this._config.provider).catch(function (e) {
-                            logger.debug('record session start event failed.', e);
-                        });
-                        return [2 /*return*/];
-                }
-            });
+    }
+    sessionStarted() {
+        const attributes = this.options.attributes ?? {};
+        logger.debug('Recording automatically tracked page view event', {
+            SESSION_START_EVENT: utils_1.SESSION_START_EVENT,
+            attributes,
         });
-    };
-    SessionTracker.prototype.configure = function (opts) {
-        if (!this._envCheck()) {
-            return this._config;
-        }
-        Object.assign(this._config, opts);
-        if (this._config.enable && !this._hasEnabled) {
-            // send a start session as soon as it's enabled
-            this._sendInitialEvent();
-            // listen on events
-            document.addEventListener(this._visibilityChange, this._trackFunc, false);
-            window.addEventListener('beforeunload', this._trackBeforeUnload, false);
-            this._hasEnabled = true;
-        }
-        else if (!this._config.enable && this._hasEnabled) {
-            document.removeEventListener(this._visibilityChange, this._trackFunc, false);
-            window.removeEventListener('beforeunload', this._trackBeforeUnload, false);
-            this._hasEnabled = false;
+        this.eventRecorder(utils_1.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;
         }
-        return this._config;
-    };
-    return SessionTracker;
-}());
+    }
+    sessionStopped() {
+        const attributes = this.options.attributes ?? {};
+        logger.debug('Recording automatically tracked page view event', {
+            SESSION_STOP_EVENT: utils_1.SESSION_STOP_EVENT,
+            attributes,
+        });
+        this.eventRecorder(utils_1.SESSION_STOP_EVENT, attributes);
+    }
+}
 exports.SessionTracker = SessionTracker;
-//# sourceMappingURL=SessionTracker.js.map

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,67 @@
+"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;
+const utils_1 = require("@aws-amplify/core/internals/utils");
+const core_1 = require("@aws-amplify/core");
+const logger = new core_1.ConsoleLogger('SessionTracker');
+class SessionTracker {
+    constructor(eventRecorder, options) {
+        this.options = {};
+        this.eventRecorder = eventRecorder;
+        this.initialEventSent = false;
+        this.sessionTrackingActive = false;
+        this.handleStateChange = this.handleStateChange.bind(this);
+        this.configure(eventRecorder, options);
+    }
+    configure(eventRecorder, options) {
+        this.eventRecorder = eventRecorder;
+        // Clean up any existing listeners
+        this.cleanup();
+        // Apply defaults
+        this.options = {
+            attributes: options?.attributes ?? {},
+        };
+        // Setup state listeners
+        if (!this.sessionTrackingActive) {
+            utils_1.sessionListener.addStateChangeListener(this.handleStateChange, !this.initialEventSent);
+            this.sessionTrackingActive = true;
+        }
+    }
+    cleanup() {
+        if (this.sessionTrackingActive) {
+            utils_1.sessionListener.removeStateChangeListener(this.handleStateChange);
+        }
+        this.sessionTrackingActive = false;
+    }
+    handleStateChange(state) {
+        if (state === 'started') {
+            this.sessionStarted();
+        }
+        else {
+            this.sessionStopped();
+        }
+    }
+    sessionStarted() {
+        const attributes = this.options.attributes ?? {};
+        logger.debug('Recording automatically tracked page view event', {
+            SESSION_START_EVENT: utils_1.SESSION_START_EVENT,
+            attributes,
+        });
+        this.eventRecorder(utils_1.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;
+        }
+    }
+    sessionStopped() {
+        const attributes = this.options.attributes ?? {};
+        logger.debug('Recording automatically tracked page view event', {
+            SESSION_STOP_EVENT: utils_1.SESSION_STOP_EVENT,
+            attributes,
+        });
+        this.eventRecorder(utils_1.SESSION_STOP_EVENT, attributes);
+    }
+}
+exports.SessionTracker = SessionTracker;

package/lib/trackers/index.d.ts

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

package/lib/trackers/index.js

@@ -1,11 +1,11 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-var PageViewTracker_1 = require("./PageViewTracker");
-exports.PageViewTracker = PageViewTracker_1.PageViewTracker;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SessionTracker = exports.PageViewTracker = exports.EventTracker = void 0;
 var EventTracker_1 = require("./EventTracker");
-exports.EventTracker = EventTracker_1.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");
-exports.SessionTracker = SessionTracker_1.SessionTracker;
-//# sourceMappingURL=index.js.map
+Object.defineProperty(exports, "SessionTracker", { enumerable: true, get: function () { return SessionTracker_1.SessionTracker; } });