@aws-amplify/analytics 7.0.1-console-preview.d745d43.0 → 7.0.1-mjs-test.20ead30.0

package/lib/providers/pinpoint/apis/identifyUser.js

@@ -1,83 +0,0 @@
-"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.identifyUser = void 0;
-var tslib_1 = require("tslib");
-var utils_1 = require("@aws-amplify/core/internals/utils");
-var pinpoint_1 = require("@aws-amplify/core/internals/providers/pinpoint");
-var utils_2 = require("../../../utils");
-var utils_3 = require("../utils");
-/**
- * Sends information about a user to Pinpoint. Sending user information allows you to associate a user to their user
- * profile and activities or actions in your application. Activity can be tracked across devices & platforms by using
- * the same `userId`.
- *
- * @param {IdentifyUserParameters} params The input object used to construct requests sent to Pinpoint's UpdateEndpoint
- *  API.
- *
- * @throws service: {@link UpdateEndpointException} - Thrown when the underlying Pinpoint service returns an error.
- * @throws validation: {@link AnalyticsValidationErrorCode} - Thrown when the provided parameters or library
- *  configuration is incorrect.
- *
- * @returns A promise that will resolve when the operation is complete.
- *
- * @example
- * ```ts
- * // Identify a user with Pinpoint
- * await identifyUser({
- *     userId,
- *     userProfile: {
- *         email: 'userEmail@example.com'
- *         customProperties: {
- *             phoneNumber: ['555-555-5555'],
- *         },
- *     }
- * });
- * ```
- *
- * @example
- * ```ts
- * // Identify a user with Pinpoint with some additional demographics
- * await identifyUser({
- *     userId,
- *     userProfile: {
- *         email: 'userEmail@example.com'
- *         customProperties: {
- *             phoneNumber: ['555-555-5555'],
- *         },
- *         demographic: {
- *             platform: 'ios',
- *             timezone: 'America/Los_Angeles'
- *         }
- *     }
- * });
- */
-var identifyUser = function (_a) {
-    var userId = _a.userId, userProfile = _a.userProfile, options = _a.options;
-    return tslib_1.__awaiter(void 0, void 0, void 0, function () {
-        var _b, credentials, identityId, _c, appId, region, userAttributes;
-        return tslib_1.__generator(this, function (_d) {
-            switch (_d.label) {
-                case 0: return [4 /*yield*/, (0, utils_3.resolveCredentials)()];
-                case 1:
-                    _b = _d.sent(), credentials = _b.credentials, identityId = _b.identityId;
-                    _c = (0, utils_3.resolveConfig)(), appId = _c.appId, region = _c.region;
-                    userAttributes = (options !== null && options !== void 0 ? options : {}).userAttributes;
-                    (0, pinpoint_1.updateEndpoint)({
-                        appId: appId,
-                        category: 'Analytics',
-                        credentials: credentials,
-                        identityId: identityId,
-                        region: region,
-                        userAttributes: userAttributes,
-                        userId: userId,
-                        userProfile: userProfile,
-                        userAgentValue: (0, utils_2.getAnalyticsUserAgentString)(utils_1.AnalyticsAction.IdentifyUser),
-                    });
-                    return [2 /*return*/];
-            }
-        });
-    });
-};
-exports.identifyUser = identifyUser;

package/lib/providers/pinpoint/apis/index.d.ts

@@ -1,4 +0,0 @@
-export { record } from './record';
-export { identifyUser } from './identifyUser';
-export { configureAutoTrack } from './configureAutoTrack';
-export { flushEvents } from './flushEvents';

package/lib/providers/pinpoint/apis/record.d.ts

@@ -1,30 +0,0 @@
-import { RecordInput } from '../types';
-/**
- * Records an Analytic event to Pinpoint. Events will be buffered and periodically sent to Pinpoint.
- *
- * @param {RecordInput} params The input object used to construct the request.
- *
- * @throws validation: {@link AnalyticsValidationErrorCode} - Thrown when the provided parameters or library
- *  configuration is incorrect.
- *
- * @example
- * ```ts
- * // Send an event to Pinpoint
- * record({ name: eventName })
- * ```
- *
- * @example
- * ```ts
- * // Send an event to Pinpoint with metrics & custom attributes
- * record({
- *     name: eventName,
- *     attributes: {
- *         'my-attribute': attributeValue
- *     },
- *     metrics: {
- *         'my-metric': metricValue
- *     }
- * })
- * ```
- */
-export declare const record: (input: RecordInput) => void;

package/lib/providers/pinpoint/index.d.ts

@@ -1,2 +0,0 @@
-export { record, identifyUser, flushEvents, configureAutoTrack } from './apis';
-export { RecordInput, IdentifyUserInput, ConfigureAutoTrackInput, } from './types/inputs';

package/lib/providers/pinpoint/types/index.d.ts

@@ -1,2 +0,0 @@
-export { RecordInput, IdentifyUserInput, ConfigureAutoTrackInput, } from './inputs';
-export { IdentifyUserOptions } from './options';

package/lib/providers/pinpoint/types/inputs.d.ts

@@ -1,15 +0,0 @@
-import { PinpointAnalyticsEvent } from '@aws-amplify/core/internals/providers/pinpoint';
-import { IdentifyUserOptions } from '.';
-import { AnalyticsConfigureAutoTrackInput, AnalyticsIdentifyUserInput } from '../../../types';
-/**
- * Input type for Pinpoint record API.
- */
-export type RecordInput = PinpointAnalyticsEvent;
-/**
- * Input type for Pinpoint identifyUser API.
- */
-export type IdentifyUserInput = AnalyticsIdentifyUserInput<IdentifyUserOptions>;
-/**
- * Input type for Pinpoint configureAutoTrack API.
- */
-export type ConfigureAutoTrackInput = AnalyticsConfigureAutoTrackInput;

package/lib/providers/pinpoint/types/options.d.ts

@@ -1,5 +0,0 @@
-import { PinpointServiceOptions } from '@aws-amplify/core/internals/providers/pinpoint';
-/**
- * Options specific to Pinpoint identityUser.
- */
-export type IdentifyUserOptions = Pick<PinpointServiceOptions, 'userAttributes'>;

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

@@ -1,2 +0,0 @@
-export { resolveConfig } from './resolveConfig';
-export { resolveCredentials } from './resolveCredentials';

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

@@ -1,7 +0,0 @@
-/**
- * @internal
- */
-export declare const resolveConfig: () => {
-    appId: string;
-    region: string;
-};

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

@@ -1,7 +0,0 @@
-/**
- * @internal
- */
-export declare const resolveCredentials: () => Promise<{
-    credentials: import("@aws-amplify/core/lib-esm/libraryUtils").AWSCredentials;
-    identityId: string | undefined;
-}>;

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

@@ -1,24 +0,0 @@
-"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.resolveCredentials = void 0;
-var tslib_1 = require("tslib");
-var core_1 = require("@aws-amplify/core");
-var 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 }];
-        }
-    });
-}); };
-exports.resolveCredentials = resolveCredentials;

package/lib/setupTests.d.ts

@@ -1 +0,0 @@
-declare const anyGlobal: any;

package/lib/trackers/EventTracker.d.ts

@@ -1,10 +0,0 @@
-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

@@ -1,104 +0,0 @@
-"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

@@ -1,18 +0,0 @@
-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/SessionTracker.d.ts

@@ -1,13 +0,0 @@
-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.native.d.ts

@@ -1,13 +0,0 @@
-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/index.d.ts

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