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

package/lib/providers/personalize/utils/cachedSession.js

@@ -0,0 +1,49 @@
+"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.updateCachedSession = exports.resolveCachedSession = void 0;
+const core_1 = require("@aws-amplify/core");
+const utils_1 = require("@aws-amplify/core/internals/utils");
+const PERSONALIZE_CACHE_USERID = '_awsct_uid';
+const PERSONALIZE_CACHE_SESSIONID = '_awsct_sid';
+const DEFAULT_CACHE_PREFIX = 'personalize';
+const DELIMITER = '.';
+const CACHE_EXPIRY_IN_DAYS = 7;
+const normalize = (key) => [key, (0, utils_1.isBrowser)() ? window.location.host : DEFAULT_CACHE_PREFIX].join(DELIMITER);
+const getCache = (key) => core_1.Cache.getItem(normalize(key));
+const setCache = (key, value) => {
+    const expiredAt = new Date(Date.now() + 3600000 * 24 * CACHE_EXPIRY_IN_DAYS);
+    core_1.Cache.setItem(normalize(key), value, {
+        expires: expiredAt.getTime(),
+    });
+};
+const resolveCachedSession = async () => {
+    let sessionId = await getCache(PERSONALIZE_CACHE_SESSIONID);
+    if (!sessionId) {
+        sessionId = (0, utils_1.amplifyUuid)();
+        setCache(PERSONALIZE_CACHE_SESSIONID, sessionId);
+    }
+    const userId = await getCache(PERSONALIZE_CACHE_USERID);
+    return {
+        sessionId,
+        userId,
+    };
+};
+exports.resolveCachedSession = resolveCachedSession;
+const updateCachedSession = (newUserId, currentSessionId, currentUserId) => {
+    const isNoCachedSession = !currentSessionId;
+    const isSignOutCase = !newUserId && !currentUserId;
+    const isSwitchUserCase = !!newUserId && !!currentUserId && newUserId !== currentUserId;
+    const isRequireNewSession = isNoCachedSession || isSignOutCase || isSwitchUserCase;
+    const isRequireUpdateSession = !!currentSessionId && !currentUserId && !!newUserId;
+    if (isRequireNewSession) {
+        const newSessionId = (0, utils_1.amplifyUuid)();
+        setCache(PERSONALIZE_CACHE_SESSIONID, newSessionId);
+        setCache(PERSONALIZE_CACHE_USERID, newUserId);
+    }
+    else if (isRequireUpdateSession) {
+        setCache(PERSONALIZE_CACHE_USERID, newUserId);
+    }
+};
+exports.updateCachedSession = updateCachedSession;

package/lib/providers/personalize/utils/constants.d.ts

@@ -0,0 +1,7 @@
+export declare const DEFAULT_PERSONALIZE_CONFIG: {
+    flushSize: number;
+    flushInterval: number;
+};
+export declare const PERSONALIZE_FLUSH_SIZE_MAX = 10;
+export declare const IDENTIFY_EVENT_TYPE = "Identify";
+export declare const MEDIA_AUTO_TRACK_EVENT_TYPE = "MediaAutoTrack";

package/lib/providers/personalize/utils/constants.js

@@ -0,0 +1,12 @@
+"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.MEDIA_AUTO_TRACK_EVENT_TYPE = exports.IDENTIFY_EVENT_TYPE = exports.PERSONALIZE_FLUSH_SIZE_MAX = exports.DEFAULT_PERSONALIZE_CONFIG = void 0;
+exports.DEFAULT_PERSONALIZE_CONFIG = {
+    flushSize: 5,
+    flushInterval: 5000,
+};
+exports.PERSONALIZE_FLUSH_SIZE_MAX = 10;
+exports.IDENTIFY_EVENT_TYPE = 'Identify';
+exports.MEDIA_AUTO_TRACK_EVENT_TYPE = 'MediaAutoTrack';

package/lib/providers/personalize/utils/getEventBuffer.d.ts

@@ -0,0 +1,3 @@
+import { EventBuffer } from '../../../utils';
+import { PersonalizeBufferConfig, PersonalizeBufferEvent } from '../types';
+export declare const getEventBuffer: ({ region, flushSize, flushInterval, bufferSize, credentials, identityId, userAgentValue, }: PersonalizeBufferConfig) => EventBuffer<PersonalizeBufferEvent>;

package/lib/providers/personalize/utils/getEventBuffer.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.getEventBuffer = void 0;
+const utils_1 = require("../../../utils");
+const client_personalize_events_1 = require("@aws-sdk/client-personalize-events");
+/**
+ * These Records hold cached event buffers and AWS clients.
+ * The hash key is determined by the region and session,
+ * consisting of a combined value comprising [region, sessionToken, identityId].
+ *
+ * Only one active session should exist at any given moment.
+ * When a new session is initiated, the previous ones should be released.
+ * */
+const eventBufferMap = {};
+const cachedClients = {};
+const DELIMITER = '#';
+const createPutEventsCommand = (ids, events) => {
+    const [trackingId, sessionId, userId] = ids.split(DELIMITER);
+    return new client_personalize_events_1.PutEventsCommand({
+        trackingId,
+        sessionId,
+        userId,
+        eventList: events.map(event => ({
+            eventId: event.event.eventId,
+            eventType: event.event.eventType,
+            properties: JSON.stringify(event.event.properties),
+            sentAt: new Date(event.timestamp),
+        })),
+    });
+};
+const submitEvents = async (events, client) => {
+    const groupedByIds = Object.entries((0, utils_1.groupBy)(event => [event.trackingId, event.sessionId, event.userId]
+        .filter(id => !!id)
+        .join(DELIMITER), events));
+    const requests = groupedByIds
+        .map(([ids, events]) => createPutEventsCommand(ids, events))
+        .map(command => client.send(command));
+    await Promise.allSettled(requests);
+    return Promise.resolve([]);
+};
+const getEventBuffer = ({ region, flushSize, flushInterval, bufferSize, credentials, identityId, userAgentValue, }) => {
+    const sessionIdentityKey = [region, identityId].filter(x => !!x).join('-');
+    if (!eventBufferMap[sessionIdentityKey]) {
+        const getClient = () => {
+            if (!cachedClients[sessionIdentityKey]) {
+                cachedClients[sessionIdentityKey] = new client_personalize_events_1.PersonalizeEventsClient({
+                    region,
+                    credentials,
+                    customUserAgent: userAgentValue,
+                });
+            }
+            return events => submitEvents(events, cachedClients[sessionIdentityKey]);
+        };
+        eventBufferMap[sessionIdentityKey] =
+            new utils_1.EventBuffer({
+                bufferSize,
+                flushSize,
+                flushInterval,
+            }, getClient);
+        const releaseSessionKeys = Object.keys(eventBufferMap).filter(key => key !== sessionIdentityKey);
+        for (const releaseSessionKey of releaseSessionKeys) {
+            eventBufferMap[releaseSessionKey].flushAll().finally(() => {
+                eventBufferMap[releaseSessionKey].release();
+                delete eventBufferMap[releaseSessionKey];
+                delete cachedClients[releaseSessionKey];
+            });
+        }
+    }
+    return eventBufferMap[sessionIdentityKey];
+};
+exports.getEventBuffer = getEventBuffer;

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

@@ -0,0 +1,5 @@
+export { getEventBuffer } from './getEventBuffer';
+export { resolveConfig } from './resolveConfig';
+export { autoTrackMedia } from './autoTrackMedia';
+export { resolveCachedSession, updateCachedSession } from './cachedSession';
+export { DEFAULT_PERSONALIZE_CONFIG, PERSONALIZE_FLUSH_SIZE_MAX, } from './constants';

package/lib/providers/personalize/utils/index.js

@@ -0,0 +1,17 @@
+"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.PERSONALIZE_FLUSH_SIZE_MAX = exports.DEFAULT_PERSONALIZE_CONFIG = exports.updateCachedSession = exports.resolveCachedSession = exports.autoTrackMedia = exports.resolveConfig = exports.getEventBuffer = void 0;
+var getEventBuffer_1 = require("./getEventBuffer");
+Object.defineProperty(exports, "getEventBuffer", { enumerable: true, get: function () { return getEventBuffer_1.getEventBuffer; } });
+var resolveConfig_1 = require("./resolveConfig");
+Object.defineProperty(exports, "resolveConfig", { enumerable: true, get: function () { return resolveConfig_1.resolveConfig; } });
+var autoTrackMedia_1 = require("./autoTrackMedia");
+Object.defineProperty(exports, "autoTrackMedia", { enumerable: true, get: function () { return autoTrackMedia_1.autoTrackMedia; } });
+var cachedSession_1 = require("./cachedSession");
+Object.defineProperty(exports, "resolveCachedSession", { enumerable: true, get: function () { return cachedSession_1.resolveCachedSession; } });
+Object.defineProperty(exports, "updateCachedSession", { enumerable: true, get: function () { return cachedSession_1.updateCachedSession; } });
+var constants_1 = require("./constants");
+Object.defineProperty(exports, "DEFAULT_PERSONALIZE_CONFIG", { enumerable: true, get: function () { return constants_1.DEFAULT_PERSONALIZE_CONFIG; } });
+Object.defineProperty(exports, "PERSONALIZE_FLUSH_SIZE_MAX", { enumerable: true, get: function () { return constants_1.PERSONALIZE_FLUSH_SIZE_MAX; } });

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

@@ -0,0 +1,7 @@
+export declare const resolveConfig: () => {
+    region: string;
+    trackingId: string;
+    bufferSize: number;
+    flushSize: number;
+    flushInterval: number;
+};

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

@@ -0,0 +1,26 @@
+"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.resolveConfig = void 0;
+const core_1 = require("@aws-amplify/core");
+const errors_1 = require("../../../errors");
+const _1 = require("./");
+const resolveConfig = () => {
+    const config = core_1.Amplify.getConfig().Analytics?.Personalize;
+    const { region, trackingId, flushSize = _1.DEFAULT_PERSONALIZE_CONFIG.flushSize, flushInterval = _1.DEFAULT_PERSONALIZE_CONFIG.flushInterval, } = {
+        ..._1.DEFAULT_PERSONALIZE_CONFIG,
+        ...config,
+    };
+    (0, errors_1.assertValidationError)(!!region, errors_1.AnalyticsValidationErrorCode.NoRegion);
+    (0, errors_1.assertValidationError)(!!trackingId, errors_1.AnalyticsValidationErrorCode.NoTrackingId);
+    (0, errors_1.assertValidationError)(flushSize <= _1.PERSONALIZE_FLUSH_SIZE_MAX, errors_1.AnalyticsValidationErrorCode.InvalidFlushSize, `FlushSize for Personalize should be less or equal than ${_1.PERSONALIZE_FLUSH_SIZE_MAX}`);
+    return {
+        region,
+        trackingId,
+        bufferSize: flushSize + 1,
+        flushSize,
+        flushInterval,
+    };
+};
+exports.resolveConfig = resolveConfig;

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

@@ -0,0 +1,15 @@
+import { ConfigureAutoTrackInput } from '../types';
+/**
+ * Configures automatic event tracking for Pinpoint. This API will automatically transmit an analytic event when
+ * configured events are detected within your application. This can include: DOM element events (via the `event`
+ * tracker), session events (via the `session` tracker), and page view events (via the `pageView` tracker).
+ *
+ * @remark Only session tracking is currently supported on React Native.
+ *
+ * @param {ConfigureAutoTrackInput} params The input object to configure auto track behavior.
+ *
+ * @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.
+ */
+export declare const configureAutoTrack: (input: ConfigureAutoTrackInput) => void;

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

@@ -0,0 +1,35 @@
+"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.configureAutoTrack = void 0;
+const utils_1 = require("../../../utils");
+const record_1 = require("./record");
+// Configured Tracker instances for Pinpoint
+const configuredTrackers = {};
+// Callback that will emit an appropriate event to Pinpoint when required by the Tracker
+const emitTrackingEvent = (eventName, attributes) => {
+    (0, record_1.record)({
+        name: eventName,
+        attributes,
+    });
+};
+/**
+ * Configures automatic event tracking for Pinpoint. This API will automatically transmit an analytic event when
+ * configured events are detected within your application. This can include: DOM element events (via the `event`
+ * tracker), session events (via the `session` tracker), and page view events (via the `pageView` tracker).
+ *
+ * @remark Only session tracking is currently supported on React Native.
+ *
+ * @param {ConfigureAutoTrackInput} params The input object to configure auto track behavior.
+ *
+ * @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.
+ */
+const configureAutoTrack = (input) => {
+    (0, utils_1.validateTrackerConfiguration)(input);
+    // Initialize or update this provider's trackers
+    (0, utils_1.updateProviderTrackers)(input, emitTrackingEvent, configuredTrackers);
+};
+exports.configureAutoTrack = configureAutoTrack;

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

@@ -0,0 +1,8 @@
+/**
+ * Flushes all buffered Pinpoint events to the service.
+ *
+ * @note
+ * This API will make a best-effort attempt to flush events from the buffer. Events recorded immediately after invoking
+ * this API may not be included in the flush.
+ */
+export declare const flushEvents: () => void;

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

@@ -0,0 +1,25 @@
+"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.flushEvents = void 0;
+const utils_1 = require("../utils");
+const pinpoint_1 = require("@aws-amplify/core/internals/providers/pinpoint");
+const utils_2 = require("@aws-amplify/core/internals/utils");
+const core_1 = require("@aws-amplify/core");
+const utils_3 = require("../../../utils");
+const logger = new core_1.ConsoleLogger('Analytics');
+/**
+ * Flushes all buffered Pinpoint events to the service.
+ *
+ * @note
+ * This API will make a best-effort attempt to flush events from the buffer. Events recorded immediately after invoking
+ * this API may not be included in the flush.
+ */
+const flushEvents = () => {
+    const { appId, region } = (0, utils_1.resolveConfig)();
+    (0, utils_1.resolveCredentials)()
+        .then(({ credentials, identityId }) => (0, pinpoint_1.flushEvents)(appId, region, credentials, identityId, (0, utils_3.getAnalyticsUserAgentString)(utils_2.AnalyticsAction.Record)))
+        .catch(e => logger.warn('Failed to flush events', e));
+};
+exports.flushEvents = flushEvents;

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

@@ -19,8 +19,9 @@ import { IdentifyUserInput } from '../types';
  * await identifyUser({
  *     userId,
  *     userProfile: {
- *         attributes: {
- *             email: [userEmail],
+ *         email: 'userEmail@example.com'
+ *         customProperties: {
+ *             phoneNumber: ['555-555-5555'],
  *         },
  *     }
  * });
@@ -32,8 +33,9 @@ import { IdentifyUserInput } from '../types';
  * await identifyUser({
  *     userId,
  *     userProfile: {
- *         attributes: {
- *             email: [userEmail],
+ *         email: 'userEmail@example.com'
+ *         customProperties: {
+ *             phoneNumber: ['555-555-5555'],
  *         },
  *         demographic: {
  *             platform: 'ios',
@@ -42,4 +44,4 @@ import { IdentifyUserInput } from '../types';
  *     }
  * });
  */
-export declare const identifyUser: ({ userId, userProfile, }: IdentifyUserInput) => Promise<void>;
+export declare const identifyUser: ({ userId, userProfile, options, }: IdentifyUserInput) => Promise<void>;

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

@@ -3,11 +3,10 @@
 // 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 userAgent_1 = require("../../../utils/userAgent");
-var utils_2 = require("../utils");
+const utils_1 = require("@aws-amplify/core/internals/utils");
+const pinpoint_1 = require("@aws-amplify/core/internals/providers/pinpoint");
+const utils_2 = require("../../../utils");
+const 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
@@ -28,8 +27,9 @@ var utils_2 = require("../utils");
  * await identifyUser({
  *     userId,
  *     userProfile: {
- *         attributes: {
- *             email: [userEmail],
+ *         email: 'userEmail@example.com'
+ *         customProperties: {
+ *             phoneNumber: ['555-555-5555'],
  *         },
  *     }
  * });
@@ -41,8 +41,9 @@ var utils_2 = require("../utils");
  * await identifyUser({
  *     userId,
  *     userProfile: {
- *         attributes: {
- *             email: [userEmail],
+ *         email: 'userEmail@example.com'
+ *         customProperties: {
+ *             phoneNumber: ['555-555-5555'],
  *         },
  *         demographic: {
  *             platform: 'ios',
@@ -51,29 +52,20 @@ var utils_2 = require("../utils");
  *     }
  * });
  */
-var identifyUser = function (_a) {
-    var userId = _a.userId, userProfile = _a.userProfile;
-    return tslib_1.__awaiter(void 0, void 0, void 0, function () {
-        var _b, credentials, identityId, _c, appId, region;
-        return tslib_1.__generator(this, function (_d) {
-            switch (_d.label) {
-                case 0: return [4 /*yield*/, (0, utils_2.resolveCredentials)()];
-                case 1:
-                    _b = _d.sent(), credentials = _b.credentials, identityId = _b.identityId;
-                    _c = (0, utils_2.resolveConfig)(), appId = _c.appId, region = _c.region;
-                    (0, pinpoint_1.updateEndpoint)({
-                        appId: appId,
-                        category: 'Analytics',
-                        credentials: credentials,
-                        identityId: identityId,
-                        region: region,
-                        userId: userId,
-                        userProfile: userProfile,
-                        userAgentValue: (0, userAgent_1.getAnalyticsUserAgentString)(utils_1.AnalyticsAction.UpdateEndpoint),
-                    });
-                    return [2 /*return*/];
-            }
-        });
+const identifyUser = async ({ userId, userProfile, options, }) => {
+    const { credentials, identityId } = await (0, utils_3.resolveCredentials)();
+    const { appId, region } = (0, utils_3.resolveConfig)();
+    const { userAttributes } = options ?? {};
+    (0, pinpoint_1.updateEndpoint)({
+        appId,
+        category: 'Analytics',
+        credentials,
+        identityId,
+        region,
+        userAttributes,
+        userId,
+        userProfile,
+        userAgentValue: (0, utils_2.getAnalyticsUserAgentString)(utils_1.AnalyticsAction.IdentifyUser),
     });
 };
 exports.identifyUser = identifyUser;

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

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

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

@@ -2,8 +2,12 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.identifyUser = exports.record = void 0;
+exports.flushEvents = exports.configureAutoTrack = exports.identifyUser = exports.record = void 0;
 var record_1 = require("./record");
 Object.defineProperty(exports, "record", { enumerable: true, get: function () { return record_1.record; } });
 var identifyUser_1 = require("./identifyUser");
 Object.defineProperty(exports, "identifyUser", { enumerable: true, get: function () { return identifyUser_1.identifyUser; } });
+var configureAutoTrack_1 = require("./configureAutoTrack");
+Object.defineProperty(exports, "configureAutoTrack", { enumerable: true, get: function () { return configureAutoTrack_1.configureAutoTrack; } });
+var flushEvents_1 = require("./flushEvents");
+Object.defineProperty(exports, "flushEvents", { enumerable: true, get: function () { return flushEvents_1.flushEvents; } });

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

@@ -10,27 +10,21 @@ import { RecordInput } from '../types';
  * @example
  * ```ts
  * // Send an event to Pinpoint
- * record({
- *     event: {
- * 	       name: eventName,
- *     }
- * })
+ * record({ name: eventName })
  * ```
  *
  * @example
  * ```ts
  * // Send an event to Pinpoint with metrics & custom attributes
  * record({
- *     event: {
- *         name: eventName,
- *         attributes: {
- *             'my-attribute': attributeValue
- *         },
- *         metrics: {
- *             'my-metric': metricValue
- *         }
+ *     name: eventName,
+ *     attributes: {
+ *         'my-attribute': attributeValue
+ *     },
+ *     metrics: {
+ *         'my-metric': metricValue
  *     }
  * })
  * ```
  */
-export declare const record: ({ event }: RecordInput) => void;
+export declare const record: (input: RecordInput) => void;

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

@@ -3,12 +3,13 @@
 // SPDX-License-Identifier: Apache-2.0
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.record = void 0;
-var utils_1 = require("@aws-amplify/core/internals/utils");
-var pinpoint_1 = require("@aws-amplify/core/internals/providers/pinpoint");
-var errors_1 = require("../../../errors");
-var userAgent_1 = require("../../../utils/userAgent");
-var utils_2 = require("../utils");
-var logger = new utils_1.ConsoleLogger('Analytics');
+const core_1 = require("@aws-amplify/core");
+const utils_1 = require("@aws-amplify/core/internals/utils");
+const pinpoint_1 = require("@aws-amplify/core/internals/providers/pinpoint");
+const errors_1 = require("../../../errors");
+const utils_2 = require("../../../utils");
+const utils_3 = require("../utils");
+const logger = new core_1.ConsoleLogger('Analytics');
 /**
  * Records an Analytic event to Pinpoint. Events will be buffered and periodically sent to Pinpoint.
  *
@@ -20,48 +21,44 @@ var logger = new utils_1.ConsoleLogger('Analytics');
  * @example
  * ```ts
  * // Send an event to Pinpoint
- * record({
- *     event: {
- * 	       name: eventName,
- *     }
- * })
+ * record({ name: eventName })
  * ```
  *
  * @example
  * ```ts
  * // Send an event to Pinpoint with metrics & custom attributes
  * record({
- *     event: {
- *         name: eventName,
- *         attributes: {
- *             'my-attribute': attributeValue
- *         },
- *         metrics: {
- *             'my-metric': metricValue
- *         }
+ *     name: eventName,
+ *     attributes: {
+ *         'my-attribute': attributeValue
+ *     },
+ *     metrics: {
+ *         'my-metric': metricValue
  *     }
  * })
  * ```
  */
-var record = function (_a) {
-    var event = _a.event;
-    var _b = (0, utils_2.resolveConfig)(), appId = _b.appId, region = _b.region;
-    (0, errors_1.assertValidationError)(!!event, errors_1.AnalyticsValidationErrorCode.NoEvent);
-    (0, errors_1.assertValidationError)(!!event.name, errors_1.AnalyticsValidationErrorCode.NoEventName);
-    (0, utils_2.resolveCredentials)()
-        .then(function (_a) {
-        var credentials = _a.credentials, identityId = _a.identityId;
+const record = (input) => {
+    const { appId, region } = (0, utils_3.resolveConfig)();
+    if (!(0, utils_2.isAnalyticsEnabled)()) {
+        logger.debug('Analytics is disabled, event will not be recorded.');
+        return;
+    }
+    (0, errors_1.assertValidationError)(!!input.name, errors_1.AnalyticsValidationErrorCode.NoEventName);
+    (0, utils_3.resolveCredentials)()
+        .then(({ credentials, identityId }) => {
+        core_1.Hub.dispatch('analytics', { event: 'record', data: input, message: 'Recording Analytics event' }, 'Analytics', utils_1.AMPLIFY_SYMBOL);
         (0, pinpoint_1.record)({
-            appId: appId,
+            appId,
             category: 'Analytics',
-            credentials: credentials,
-            event: event,
-            identityId: identityId,
-            region: region,
-            userAgentValue: (0, userAgent_1.getAnalyticsUserAgentString)(utils_1.AnalyticsAction.Record),
+            credentials,
+            event: input,
+            identityId,
+            region,
+            userAgentValue: (0, utils_2.getAnalyticsUserAgentString)(utils_1.AnalyticsAction.Record),
         });
     })
-        .catch(function (e) {
+        .catch(e => {
         // An error occured while fetching credentials or persisting the event to the buffer
         logger.warn('Failed to record event.', e);
     });

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

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

package/lib/providers/pinpoint/index.js

@@ -2,7 +2,9 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.identifyUser = exports.record = void 0;
+exports.configureAutoTrack = exports.flushEvents = exports.identifyUser = exports.record = void 0;
 var apis_1 = require("./apis");
 Object.defineProperty(exports, "record", { enumerable: true, get: function () { return apis_1.record; } });
 Object.defineProperty(exports, "identifyUser", { enumerable: true, get: function () { return apis_1.identifyUser; } });
+Object.defineProperty(exports, "flushEvents", { enumerable: true, get: function () { return apis_1.flushEvents; } });
+Object.defineProperty(exports, "configureAutoTrack", { enumerable: true, get: function () { return apis_1.configureAutoTrack; } });

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

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

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

@@ -2,6 +2,3 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UpdateEndpointException = void 0;
-var errors_1 = require("./errors");
-Object.defineProperty(exports, "UpdateEndpointException", { enumerable: true, get: function () { return errors_1.UpdateEndpointException; } });

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

@@ -1,24 +1,15 @@
-import { UserProfile } from '@aws-amplify/core';
 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 = {
-    /**
-     * An event to send to the default Analytics provider.
-     */
-    event: PinpointAnalyticsEvent;
-};
+export type RecordInput = PinpointAnalyticsEvent;
 /**
  * Input type for Pinpoint identifyUser API.
  */
-export type IdentifyUserInput = {
-    /**
-     * A User ID associated to the current device.
-     */
-    userId: string;
-    /**
-     * Additional information about the user and their device.
-     */
-    userProfile: UserProfile;
-};
+export type IdentifyUserInput = AnalyticsIdentifyUserInput<IdentifyUserOptions>;
+/**
+ * Input type for Pinpoint configureAutoTrack API.
+ */
+export type ConfigureAutoTrackInput = AnalyticsConfigureAutoTrackInput;

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

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