@aws-amplify/analytics 7.0.1-preview-testing.be90020.0 → 7.0.1-ssr-api.df60e41.0

package/lib/providers/pinpoint/types/options.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/providers/pinpoint/utils/resolveConfig.js

@@ -3,16 +3,15 @@
 // SPDX-License-Identifier: Apache-2.0
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolveConfig = void 0;
-var core_1 = require("@aws-amplify/core");
-var errors_1 = require("../../../errors");
+const core_1 = require("@aws-amplify/core");
+const errors_1 = require("../../../errors");
 /**
  * @internal
  */
-var resolveConfig = function () {
-    var _a, _b;
-    var _c = (_b = (_a = core_1.Amplify.getConfig().Analytics) === null || _a === void 0 ? void 0 : _a.Pinpoint) !== null && _b !== void 0 ? _b : {}, appId = _c.appId, region = _c.region;
+const resolveConfig = () => {
+    const { appId, region } = core_1.Amplify.getConfig().Analytics?.Pinpoint ?? {};
     (0, errors_1.assertValidationError)(!!appId, errors_1.AnalyticsValidationErrorCode.NoAppId);
     (0, errors_1.assertValidationError)(!!region, errors_1.AnalyticsValidationErrorCode.NoRegion);
-    return { appId: appId, region: region };
+    return { appId, region };
 };
 exports.resolveConfig = resolveConfig;

package/lib/providers/pinpoint/utils/resolveCredentials.d.ts

@@ -2,11 +2,6 @@
  * @internal
  */
 export declare const resolveCredentials: () => Promise<{
-    credentials: {
-        accessKeyId: string;
-        secretAccessKey: string;
-        sessionToken?: string | undefined;
-        expiration?: Date | undefined;
-    };
+    credentials: import("@aws-amplify/core/lib-esm/libraryUtils").AWSCredentials;
     identityId: string | undefined;
 }>;

package/lib/providers/pinpoint/utils/resolveCredentials.js

@@ -3,22 +3,14 @@
 // SPDX-License-Identifier: Apache-2.0
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolveCredentials = void 0;
-var tslib_1 = require("tslib");
-var core_1 = require("@aws-amplify/core");
-var errors_1 = require("../../../errors");
+const core_1 = require("@aws-amplify/core");
+const errors_1 = require("../../../errors");
 /**
  * @internal
  */
-var resolveCredentials = function () { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
-    var _a, credentials, identityId;
-    return tslib_1.__generator(this, function (_b) {
-        switch (_b.label) {
-            case 0: return [4 /*yield*/, (0, core_1.fetchAuthSession)()];
-            case 1:
-                _a = _b.sent(), credentials = _a.credentials, identityId = _a.identityId;
-                (0, errors_1.assertValidationError)(!!credentials, errors_1.AnalyticsValidationErrorCode.NoCredentials);
-                return [2 /*return*/, { credentials: credentials, identityId: identityId }];
-        }
-    });
-}); };
+const resolveCredentials = async () => {
+    const { credentials, identityId } = await (0, core_1.fetchAuthSession)();
+    (0, errors_1.assertValidationError)(!!credentials, errors_1.AnalyticsValidationErrorCode.NoCredentials);
+    return { credentials, identityId };
+};
 exports.resolveCredentials = resolveCredentials;

package/lib/setupTests.js

@@ -1,7 +1,7 @@
 "use strict";
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-var anyGlobal = global;
+const anyGlobal = global;
 anyGlobal.navigator = anyGlobal.navigator || {};
 // @ts-ignore
 anyGlobal.navigator.sendBeacon = anyGlobal.navigator.sendBeacon || jest.fn();

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

@@ -0,0 +1,98 @@
+"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;
+const core_1 = require("@aws-amplify/core");
+const utils_1 = require("@aws-amplify/core/internals/utils");
+const DEFAULT_EVENTS = ['click'];
+const DEFAULT_SELECTOR_PREFIX = 'data-amplify-analytics-';
+const DEFAULT_EVENT_NAME = 'event'; // Default event name as sent to the analytics provider
+const logger = new core_1.ConsoleLogger('EventTracker');
+class EventTracker {
+    constructor(eventRecorder, options) {
+        this.options = {};
+        this.trackerActive = false;
+        this.eventRecorder = eventRecorder;
+        this.handleDocEvent = this.handleDocEvent.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 ?? undefined,
+            events: options?.events ?? DEFAULT_EVENTS,
+            selectorPrefix: options?.selectorPrefix ?? DEFAULT_SELECTOR_PREFIX,
+        };
+        // Register event listeners
+        if ((0, utils_1.isBrowser)()) {
+            this.options.events?.forEach(targetEvent => {
+                document.addEventListener(targetEvent, this.handleDocEvent, {
+                    capture: true,
+                });
+            });
+            this.trackerActive = true;
+        }
+    }
+    cleanup() {
+        // No-op if document listener is not active
+        if (!this.trackerActive) {
+            return;
+        }
+        // Clean up event listeners
+        this.options.events?.forEach(targetEvent => {
+            document.removeEventListener(targetEvent, this.handleDocEvent, {
+                capture: true,
+            });
+        });
+    }
+    handleDocEvent(event) {
+        /**
+         * Example DOM element:
+         *
+         * ```
+         * <button
+         *   data-amplify-analytics-on="click"
+         *   data-amplify-analytics-name="click"
+         *   data-amplify-analytics-attrs="attr1:attr1_value,attr2:attr2_value"
+         * />
+         * ```
+         */
+        const triggerSelector = `[${this.options.selectorPrefix}on]`;
+        const attrSelector = `${this.options.selectorPrefix}attrs`;
+        const eventNameSelector = `${this.options.selectorPrefix}name`;
+        const eventSource = event.target;
+        // Validate that the triggering event type is being tracked
+        if (!this.options.events?.includes(event.type)) {
+            return;
+        }
+        if (eventSource instanceof HTMLElement) {
+            const target = eventSource.closest(triggerSelector);
+            if (target) {
+                // Parse event name from the element
+                const eventName = target.getAttribute(eventNameSelector) || DEFAULT_EVENT_NAME;
+                // Parse attributes from the element
+                const elementAttributes = {};
+                const rawElementAttributes = target.getAttribute(attrSelector);
+                rawElementAttributes?.split(/\s*,\s*/).forEach(attr => {
+                    const tmp = attr.trim().split(/\s*:\s*/);
+                    elementAttributes[tmp[0]] = tmp[1];
+                });
+                // Assemble final list of attributes
+                const attributes = Object.assign({
+                    type: event.type,
+                    target: `${target.localName} with id ${target.id}`,
+                }, this.options.attributes, elementAttributes);
+                logger.debug('Recording automatically tracked DOM event', {
+                    eventName,
+                    attributes,
+                });
+                this.eventRecorder(eventName, attributes);
+            }
+        }
+    }
+}
+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,112 @@
+"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;
+const core_1 = require("@aws-amplify/core");
+const utils_1 = require("@aws-amplify/core/internals/utils");
+const logger = new core_1.ConsoleLogger('PageViewTracker');
+const DEFAULT_EVENT_NAME = 'pageView';
+const DEFAULT_APP_TYPE = 'singlePage';
+const DEFAULT_URL_PROVIDER = () => {
+    return window.location.origin + window.location.pathname;
+};
+const PREV_URL_STORAGE_KEY = 'aws-amplify-analytics-prevUrl';
+class PageViewTracker {
+    constructor(eventRecorder, options) {
+        this.options = {};
+        this.trackerActive = true;
+        this.eventRecorder = eventRecorder;
+        this.spaTrackingActive = false;
+        this.handleLocationChange = this.handleLocationChange.bind(this);
+        this.configure(eventRecorder, options);
+    }
+    configure(eventRecorder, options) {
+        this.eventRecorder = eventRecorder;
+        // Clean up any existing listeners
+        this.cleanup();
+        // Apply defaults
+        this.options = {
+            appType: options?.appType ?? DEFAULT_APP_TYPE,
+            attributes: options?.attributes ?? undefined,
+            eventName: this.options?.eventName ?? DEFAULT_EVENT_NAME,
+            urlProvider: this.options?.urlProvider ?? 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;
+        }
+    }
+    cleanup() {
+        // 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;
+            this.pushStateProxy?.revoke();
+            this.replaceStateProxy?.revoke();
+            window.removeEventListener('popstate', this.handleLocationChange);
+            this.spaTrackingActive = false;
+        }
+    }
+    setupSPATracking() {
+        if (!this.spaTrackingActive) {
+            // Configure proxies on History APIs
+            this.pushStateProxy = Proxy.revocable(window.history.pushState, {
+                apply: (target, thisArg, args) => {
+                    const proxiedResult = target.apply(thisArg, args);
+                    this.handleLocationChange();
+                    return proxiedResult;
+                },
+            });
+            this.replaceStateProxy = Proxy.revocable(window.history.replaceState, {
+                apply: (target, thisArg, args) => {
+                    const 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;
+        }
+    }
+    setupMPATracking() {
+        this.handleLocationChange();
+    }
+    handleLocationChange() {
+        const currentUrl = this.options.urlProvider();
+        const eventName = this.options.eventName || DEFAULT_EVENT_NAME;
+        if (this.urlHasChanged()) {
+            sessionStorage.setItem(PREV_URL_STORAGE_KEY, currentUrl);
+            // Assemble attribute list
+            const attributes = Object.assign({
+                url: currentUrl,
+            }, this.options.attributes);
+            logger.debug('Recording automatically tracked page view event', {
+                eventName,
+                attributes,
+            });
+            this.eventRecorder(eventName, attributes);
+        }
+    }
+    urlHasChanged() {
+        const prevUrl = sessionStorage.getItem(PREV_URL_STORAGE_KEY);
+        const currUrl = this.options.urlProvider();
+        return currUrl !== prevUrl;
+    }
+}
+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,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.sessionTrackingActive = false;
+        this.initialEventSent = 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/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

@@ -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; } });