@aws-amplify/analytics 7.0.1-console-preview.b5a42af.0 → 7.0.1-console-preview.4ae78ed.0

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

@@ -0,0 +1,100 @@
+"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;
+var tslib_1 = require("tslib");
+var utils_1 = require("../../../utils");
+var 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.
+ * */
+var eventBufferMap = {};
+var cachedClients = {};
+var DELIMITER = '#';
+var createPutEventsCommand = function (ids, events) {
+    var _a = tslib_1.__read(ids.split(DELIMITER), 3), trackingId = _a[0], sessionId = _a[1], userId = _a[2];
+    return new client_personalize_events_1.PutEventsCommand({
+        trackingId: trackingId,
+        sessionId: sessionId,
+        userId: userId,
+        eventList: events.map(function (event) { return ({
+            eventId: event.event.eventId,
+            eventType: event.event.eventType,
+            properties: JSON.stringify(event.event.properties),
+            sentAt: new Date(event.timestamp),
+        }); }),
+    });
+};
+var submitEvents = function (events, client) { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
+    var groupedByIds, requests;
+    return tslib_1.__generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                groupedByIds = Object.entries((0, utils_1.groupBy)(function (event) {
+                    return [event.trackingId, event.sessionId, event.userId]
+                        .filter(function (id) { return !!id; })
+                        .join(DELIMITER);
+                }, events));
+                requests = groupedByIds
+                    .map(function (_a) {
+                    var _b = tslib_1.__read(_a, 2), ids = _b[0], events = _b[1];
+                    return createPutEventsCommand(ids, events);
+                })
+                    .map(function (command) { return client.send(command); });
+                return [4 /*yield*/, Promise.allSettled(requests)];
+            case 1:
+                _a.sent();
+                return [2 /*return*/, Promise.resolve([])];
+        }
+    });
+}); };
+var getEventBuffer = function (_a) {
+    var e_1, _b;
+    var region = _a.region, flushSize = _a.flushSize, flushInterval = _a.flushInterval, bufferSize = _a.bufferSize, credentials = _a.credentials, identityId = _a.identityId, userAgentValue = _a.userAgentValue;
+    var sessionToken = credentials.sessionToken;
+    var sessionIdentityKey = [region, sessionToken, identityId]
+        .filter(function (x) { return !!x; })
+        .join('-');
+    if (!eventBufferMap[sessionIdentityKey]) {
+        var getClient = function () {
+            if (!cachedClients[sessionIdentityKey]) {
+                cachedClients[sessionIdentityKey] = new client_personalize_events_1.PersonalizeEventsClient({
+                    region: region,
+                    credentials: credentials,
+                    customUserAgent: userAgentValue,
+                });
+            }
+            return function (events) { return submitEvents(events, cachedClients[sessionIdentityKey]); };
+        };
+        eventBufferMap[sessionIdentityKey] =
+            new utils_1.EventBuffer({
+                bufferSize: bufferSize,
+                flushSize: flushSize,
+                flushInterval: flushInterval,
+            }, getClient);
+        var releaseSessionKeys = Object.keys(eventBufferMap).filter(function (key) { return key !== sessionIdentityKey; });
+        try {
+            for (var releaseSessionKeys_1 = tslib_1.__values(releaseSessionKeys), releaseSessionKeys_1_1 = releaseSessionKeys_1.next(); !releaseSessionKeys_1_1.done; releaseSessionKeys_1_1 = releaseSessionKeys_1.next()) {
+                var releaseSessionKey = releaseSessionKeys_1_1.value;
+                eventBufferMap[releaseSessionKey].release();
+                delete eventBufferMap[releaseSessionKey];
+                delete cachedClients[releaseSessionKey];
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (releaseSessionKeys_1_1 && !releaseSessionKeys_1_1.done && (_b = releaseSessionKeys_1.return)) _b.call(releaseSessionKeys_1);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+    }
+    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,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.resolveConfig = void 0;
+var tslib_1 = require("tslib");
+var core_1 = require("@aws-amplify/core");
+var errors_1 = require("../../../errors");
+var _1 = require("./");
+var resolveConfig = function () {
+    var _a;
+    var config = (_a = core_1.Amplify.getConfig().Analytics) === null || _a === void 0 ? void 0 : _a.Personalize;
+    var _b = tslib_1.__assign(tslib_1.__assign({}, _1.DEFAULT_PERSONALIZE_CONFIG), config), region = _b.region, trackingId = _b.trackingId, _c = _b.flushSize, flushSize = _c === void 0 ? _1.DEFAULT_PERSONALIZE_CONFIG.flushSize : _c, _d = _b.flushInterval, flushInterval = _d === void 0 ? _1.DEFAULT_PERSONALIZE_CONFIG.flushInterval : _d;
+    (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 ".concat(_1.PERSONALIZE_FLUSH_SIZE_MAX));
+    return {
+        region: region,
+        trackingId: trackingId,
+        bufferSize: flushSize + 1,
+        flushSize: flushSize,
+        flushInterval: flushInterval,
+    };
+};
+exports.resolveConfig = resolveConfig;

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,27 @@
+"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;
+var utils_1 = require("../utils");
+var pinpoint_1 = require("@aws-amplify/core/internals/providers/pinpoint");
+var utils_2 = require("@aws-amplify/core/internals/utils");
+var utils_3 = require("../../../utils");
+var logger = new utils_2.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.
+ */
+var flushEvents = function () {
+    var _a = (0, utils_1.resolveConfig)(), appId = _a.appId, region = _a.region;
+    (0, utils_1.resolveCredentials)()
+        .then(function (_a) {
+        var credentials = _a.credentials, identityId = _a.identityId;
+        return (0, pinpoint_1.flushEvents)(appId, region, credentials, identityId, (0, utils_3.getAnalyticsUserAgentString)(utils_2.AnalyticsAction.Record));
+    })
+        .catch(function (e) { return logger.warn('Failed to flush events', e); });
+};
+exports.flushEvents = flushEvents;

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

@@ -19,7 +19,7 @@ import { IdentifyUserInput } from '../types';
  * await identifyUser({
  *     userId,
  *     userProfile: {
- *         email: [userEmail]
+ *         email: 'userEmail@example.com'
  *         customProperties: {
  *             phoneNumber: ['555-555-5555'],
  *         },
@@ -33,7 +33,7 @@ import { IdentifyUserInput } from '../types';
  * await identifyUser({
  *     userId,
  *     userProfile: {
- *         email: [userEmail]
+ *         email: 'userEmail@example.com'
  *         customProperties: {
  *             phoneNumber: ['555-555-5555'],
  *         },

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

@@ -28,7 +28,7 @@ var utils_3 = require("../utils");
  * await identifyUser({
  *     userId,
  *     userProfile: {
- *         email: [userEmail]
+ *         email: 'userEmail@example.com'
  *         customProperties: {
  *             phoneNumber: ['555-555-5555'],
  *         },
@@ -42,7 +42,7 @@ var utils_3 = require("../utils");
  * await identifyUser({
  *     userId,
  *     userProfile: {
- *         email: [userEmail]
+ *         email: 'userEmail@example.com'
  *         customProperties: {
  *             phoneNumber: ['555-555-5555'],
  *         },
@@ -74,7 +74,7 @@ var identifyUser = function (_a) {
                         userAttributes: userAttributes,
                         userId: userId,
                         userProfile: userProfile,
-                        userAgentValue: (0, utils_2.getAnalyticsUserAgentString)(utils_1.AnalyticsAction.UpdateEndpoint),
+                        userAgentValue: (0, utils_2.getAnalyticsUserAgentString)(utils_1.AnalyticsAction.IdentifyUser),
                     });
                     return [2 /*return*/];
             }

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

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

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

@@ -2,8 +2,10 @@
 // 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.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 flushEvents_1 = require("./flushEvents");
+Object.defineProperty(exports, "flushEvents", { enumerable: true, get: function () { return flushEvents_1.flushEvents; } });

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

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

package/lib/providers/pinpoint/index.js

@@ -2,7 +2,8 @@
 // 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.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; } });