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

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';