@aws-amplify/analytics 7.0.1-preview-testing.034e780.0 → 7.0.1-server-generate-client.1e317a1.0

package/lib/providers/kinesis-firehose/apis/record.js

@@ -0,0 +1,45 @@
+"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.record = void 0;
+var utils_1 = require("../utils");
+var utils_2 = require("../../../utils");
+var util_utf8_1 = require("@smithy/util-utf8");
+var utils_3 = require("@aws-amplify/core/internals/utils");
+var core_1 = require("@aws-amplify/core");
+var logger = new core_1.ConsoleLogger('KinesisFirehose');
+var record = function (_a) {
+    var streamName = _a.streamName, data = _a.data;
+    if (!(0, utils_2.isAnalyticsEnabled)()) {
+        logger.debug('Analytics is disabled, event will not be recorded.');
+        return;
+    }
+    var timestamp = Date.now();
+    var _b = (0, utils_1.resolveConfig)(), region = _b.region, bufferSize = _b.bufferSize, flushSize = _b.flushSize, flushInterval = _b.flushInterval, resendLimit = _b.resendLimit;
+    (0, utils_2.resolveCredentials)()
+        .then(function (_a) {
+        var credentials = _a.credentials, identityId = _a.identityId;
+        var buffer = (0, utils_1.getEventBuffer)({
+            region: region,
+            credentials: credentials,
+            identityId: identityId,
+            bufferSize: bufferSize,
+            flushSize: flushSize,
+            flushInterval: flushInterval,
+            resendLimit: resendLimit,
+            userAgentValue: (0, utils_2.getAnalyticsUserAgentString)(utils_3.AnalyticsAction.Record),
+        });
+        buffer.append({
+            region: region,
+            streamName: streamName,
+            event: ArrayBuffer.isView(data) ? data : (0, util_utf8_1.fromUtf8)(JSON.stringify(data)),
+            timestamp: timestamp,
+            retryCount: 0,
+        });
+    })
+        .catch(function (e) {
+        logger.warn('Failed to record event.', e);
+    });
+};
+exports.record = record;

package/lib/providers/kinesis-firehose/index.d.ts

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

package/lib/providers/kinesis-firehose/index.js

@@ -0,0 +1,8 @@
+"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 = exports.record = void 0;
+var apis_1 = require("./apis");
+Object.defineProperty(exports, "record", { enumerable: true, get: function () { return apis_1.record; } });
+Object.defineProperty(exports, "flushEvents", { enumerable: true, get: function () { return apis_1.flushEvents; } });

package/lib/providers/kinesis-firehose/types/buffer.d.ts

@@ -0,0 +1,15 @@
+import { EventBufferConfig } from '../../../utils';
+import { KinesisStream } from '../../../types';
+import { AWSCredentials } from '@aws-amplify/core/internals/utils';
+export type KinesisFirehoseBufferEvent = KinesisStream & {
+    event: Uint8Array;
+    retryCount: number;
+    timestamp: number;
+};
+export type KinesisFirehoseEventBufferConfig = EventBufferConfig & {
+    region: string;
+    credentials: AWSCredentials;
+    identityId?: string;
+    resendLimit?: number;
+    userAgentValue?: string;
+};

package/lib/providers/kinesis-firehose/types/index.d.ts

@@ -0,0 +1,2 @@
+export { RecordInput } from './inputs';
+export { KinesisFirehoseBufferEvent, KinesisFirehoseEventBufferConfig, } from './buffer';

package/lib/providers/kinesis-firehose/types/index.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/kinesis-firehose/types/inputs.d.ts

@@ -0,0 +1,5 @@
+import { KinesisEventData } from '../../../types';
+export type RecordInput = {
+    streamName: string;
+    data: KinesisEventData;
+};

package/lib/providers/kinesis-firehose/types/inputs.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/kinesis-firehose/utils/constants.d.ts

@@ -0,0 +1,6 @@
+export declare const DEFAULT_KINESIS_FIREHOSE_CONFIG: {
+    bufferSize: number;
+    flushSize: number;
+    flushInterval: number;
+    resendLimit: number;
+};

package/lib/providers/kinesis-firehose/utils/constants.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.DEFAULT_KINESIS_FIREHOSE_CONFIG = void 0;
+exports.DEFAULT_KINESIS_FIREHOSE_CONFIG = {
+    bufferSize: 1000,
+    flushSize: 100,
+    flushInterval: 5000,
+    resendLimit: 5,
+};

package/lib/providers/kinesis-firehose/utils/getEventBuffer.d.ts

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

package/lib/providers/kinesis-firehose/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_firehose_1 = require("@aws-sdk/client-firehose");
+/**
+ * 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 createPutRecordsBatchCommand = function (streamName, events) {
+    return new client_firehose_1.PutRecordBatchCommand({
+        DeliveryStreamName: streamName,
+        Records: events.map(function (event) { return ({
+            Data: event.event,
+        }); }),
+    });
+};
+var submitEvents = function (events, client, resendLimit) { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
+    var groupedByStreamName, requests, responses, failedEvents;
+    return tslib_1.__generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                groupedByStreamName = Object.entries((0, utils_1.groupBy)(function (event) { return event.streamName; }, events));
+                requests = groupedByStreamName
+                    .map(function (_a) {
+                    var _b = tslib_1.__read(_a, 2), streamName = _b[0], events = _b[1];
+                    return createPutRecordsBatchCommand(streamName, events);
+                })
+                    .map(function (command) { return client.send(command); });
+                return [4 /*yield*/, Promise.allSettled(requests)];
+            case 1:
+                responses = _a.sent();
+                failedEvents = responses
+                    .map(function (response, i) {
+                    return response.status === 'rejected' ? groupedByStreamName[i][1] : [];
+                })
+                    .flat();
+                return [2 /*return*/, resendLimit
+                        ? failedEvents
+                            .filter(function (event) { return event.retryCount < resendLimit; })
+                            .map(function (event) { return (tslib_1.__assign(tslib_1.__assign({}, event), { retryCount: event.retryCount + 1 })); })
+                            .sort(function (a, b) { return a.timestamp - b.timestamp; })
+                        : []];
+        }
+    });
+}); };
+var getEventBuffer = function (_a) {
+    var e_1, _b;
+    var region = _a.region, credentials = _a.credentials, identityId = _a.identityId, bufferSize = _a.bufferSize, flushSize = _a.flushSize, flushInterval = _a.flushInterval, resendLimit = _a.resendLimit, userAgentValue = _a.userAgentValue;
+    var sessionToken = credentials.sessionToken;
+    var sessionIdentityKey = [region, sessionToken, identityId]
+        .filter(function (id) { return !!id; })
+        .join('-');
+    if (!eventBufferMap[sessionIdentityKey]) {
+        var getClient = function () {
+            if (!cachedClients[sessionIdentityKey]) {
+                cachedClients[sessionIdentityKey] = new client_firehose_1.FirehoseClient({
+                    region: region,
+                    credentials: credentials,
+                    customUserAgent: userAgentValue,
+                });
+            }
+            var firehoseClient = cachedClients[sessionIdentityKey];
+            return function (events) { return submitEvents(events, firehoseClient, resendLimit); };
+        };
+        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/kinesis-firehose/utils/index.d.ts

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

package/lib/providers/kinesis-firehose/utils/index.js

@@ -0,0 +1,9 @@
+"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 = 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; } });

package/lib/providers/kinesis-firehose/utils/resolveConfig.d.ts

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

package/lib/providers/kinesis-firehose/utils/resolveConfig.js

@@ -0,0 +1,24 @@
+"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 constants_1 = require("./constants");
+var resolveConfig = function () {
+    var _a;
+    var config = (_a = core_1.Amplify.getConfig().Analytics) === null || _a === void 0 ? void 0 : _a.KinesisFirehose;
+    var _b = tslib_1.__assign(tslib_1.__assign({}, constants_1.DEFAULT_KINESIS_FIREHOSE_CONFIG), config), region = _b.region, _c = _b.bufferSize, bufferSize = _c === void 0 ? constants_1.DEFAULT_KINESIS_FIREHOSE_CONFIG.bufferSize : _c, _d = _b.flushSize, flushSize = _d === void 0 ? constants_1.DEFAULT_KINESIS_FIREHOSE_CONFIG.flushSize : _d, _e = _b.flushInterval, flushInterval = _e === void 0 ? constants_1.DEFAULT_KINESIS_FIREHOSE_CONFIG.flushInterval : _e, resendLimit = _b.resendLimit;
+    (0, errors_1.assertValidationError)(!!region, errors_1.AnalyticsValidationErrorCode.NoRegion);
+    (0, errors_1.assertValidationError)(flushSize < bufferSize, errors_1.AnalyticsValidationErrorCode.InvalidFlushSize);
+    return {
+        region: region,
+        bufferSize: bufferSize,
+        flushSize: flushSize,
+        flushInterval: flushInterval,
+        resendLimit: resendLimit,
+    };
+};
+exports.resolveConfig = resolveConfig;

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

@@ -0,0 +1,8 @@
+/**
+ * Flushes all buffered Personalize 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/personalize/apis/flushEvents.js

@@ -0,0 +1,36 @@
+"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 utils_2 = require("../../../utils");
+var utils_3 = require("@aws-amplify/core/internals/utils");
+var core_1 = require("@aws-amplify/core");
+var logger = new core_1.ConsoleLogger('Personalize');
+/**
+ * Flushes all buffered Personalize 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)(), region = _a.region, flushSize = _a.flushSize, bufferSize = _a.bufferSize, flushInterval = _a.flushInterval;
+    (0, utils_2.resolveCredentials)()
+        .then(function (_a) {
+        var credentials = _a.credentials, identityId = _a.identityId;
+        return (0, utils_1.getEventBuffer)({
+            region: region,
+            flushSize: flushSize,
+            flushInterval: flushInterval,
+            bufferSize: bufferSize,
+            credentials: credentials,
+            identityId: identityId,
+            userAgentValue: (0, utils_2.getAnalyticsUserAgentString)(utils_3.AnalyticsAction.Record),
+        });
+    })
+        .then(function (eventBuffer) { return eventBuffer.flushAll(); })
+        .catch(function (e) { return logger.warn('Failed to flush events', e); });
+};
+exports.flushEvents = flushEvents;

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

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

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

@@ -0,0 +1,9 @@
+"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 = exports.record = void 0;
+var record_1 = require("./record");
+Object.defineProperty(exports, "record", { enumerable: true, get: function () { return record_1.record; } });
+var flushEvents_1 = require("./flushEvents");
+Object.defineProperty(exports, "flushEvents", { enumerable: true, get: function () { return flushEvents_1.flushEvents; } });

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

@@ -0,0 +1,2 @@
+import { RecordInput } from '../types';
+export declare const record: ({ userId, eventId, eventType, properties, }: RecordInput) => void;

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

@@ -0,0 +1,87 @@
+"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.record = void 0;
+var tslib_1 = require("tslib");
+var utils_1 = require("../utils");
+var utils_2 = require("../../../utils");
+var utils_3 = require("@aws-amplify/core/internals/utils");
+var core_1 = require("@aws-amplify/core");
+var constants_1 = require("../utils/constants");
+var logger = new core_1.ConsoleLogger('Personalize');
+var record = function (_a) {
+    var userId = _a.userId, eventId = _a.eventId, eventType = _a.eventType, properties = _a.properties;
+    if (!(0, utils_2.isAnalyticsEnabled)()) {
+        logger.debug('Analytics is disabled, event will not be recorded.');
+        return;
+    }
+    var _b = (0, utils_1.resolveConfig)(), region = _b.region, trackingId = _b.trackingId, bufferSize = _b.bufferSize, flushSize = _b.flushSize, flushInterval = _b.flushInterval;
+    (0, utils_2.resolveCredentials)()
+        .then(function (_a) {
+        var credentials = _a.credentials, identityId = _a.identityId;
+        return tslib_1.__awaiter(void 0, void 0, void 0, function () {
+            var timestamp, _b, cachedSessionId, cachedUserId, _c, updatedSessionId, updatedUserId, eventBuffer;
+            return tslib_1.__generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0:
+                        timestamp = Date.now();
+                        return [4 /*yield*/, (0, utils_1.resolveCachedSession)()];
+                    case 1:
+                        _b = _d.sent(), cachedSessionId = _b.sessionId, cachedUserId = _b.userId;
+                        if (eventType === constants_1.IDENTIFY_EVENT_TYPE) {
+                            (0, utils_1.updateCachedSession)(typeof properties.userId === 'string' ? properties.userId : '', cachedSessionId, cachedUserId);
+                        }
+                        else if (!!userId) {
+                            (0, utils_1.updateCachedSession)(userId, cachedSessionId, cachedUserId);
+                        }
+                        return [4 /*yield*/, (0, utils_1.resolveCachedSession)()];
+                    case 2:
+                        _c = _d.sent(), updatedSessionId = _c.sessionId, updatedUserId = _c.userId;
+                        eventBuffer = (0, utils_1.getEventBuffer)({
+                            region: region,
+                            flushSize: flushSize,
+                            flushInterval: flushInterval,
+                            bufferSize: bufferSize,
+                            credentials: credentials,
+                            identityId: identityId,
+                            userAgentValue: (0, utils_2.getAnalyticsUserAgentString)(utils_3.AnalyticsAction.Record),
+                        });
+                        if (eventType === constants_1.MEDIA_AUTO_TRACK_EVENT_TYPE) {
+                            (0, utils_1.autoTrackMedia)({
+                                trackingId: trackingId,
+                                sessionId: updatedSessionId,
+                                userId: updatedUserId,
+                                event: {
+                                    eventId: eventId,
+                                    eventType: eventType,
+                                    properties: properties,
+                                },
+                            }, eventBuffer);
+                        }
+                        else {
+                            eventBuffer.append({
+                                trackingId: trackingId,
+                                sessionId: updatedSessionId,
+                                userId: updatedUserId,
+                                event: {
+                                    eventId: eventId,
+                                    eventType: eventType,
+                                    properties: properties,
+                                },
+                                timestamp: timestamp,
+                            });
+                        }
+                        if (eventBuffer.length >= bufferSize) {
+                            eventBuffer.flushAll();
+                        }
+                        return [2 /*return*/];
+                }
+            });
+        });
+    })
+        .catch(function (e) {
+        logger.warn('Failed to record event.', e);
+    });
+};
+exports.record = record;

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

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

package/lib/providers/personalize/index.js

@@ -0,0 +1,8 @@
+"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 = exports.record = void 0;
+var apis_1 = require("./apis");
+Object.defineProperty(exports, "record", { enumerable: true, get: function () { return apis_1.record; } });
+Object.defineProperty(exports, "flushEvents", { enumerable: true, get: function () { return apis_1.flushEvents; } });

package/lib/providers/personalize/types/buffer.d.ts

@@ -0,0 +1,16 @@
+import { PersonalizeEvent } from './';
+import { EventBufferConfig } from '../../../utils';
+import { AWSCredentials } from '@aws-amplify/core/internals/utils';
+export type PersonalizeBufferEvent = {
+    trackingId: string;
+    sessionId?: string;
+    userId?: string;
+    event: PersonalizeEvent;
+    timestamp: number;
+};
+export type PersonalizeBufferConfig = EventBufferConfig & {
+    region: string;
+    credentials: AWSCredentials;
+    identityId?: string;
+    userAgentValue?: string;
+};

package/lib/providers/personalize/types/buffer.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/personalize/types/index.d.ts

@@ -0,0 +1,2 @@
+export { RecordInput, PersonalizeEvent } from './inputs';
+export { PersonalizeBufferEvent, PersonalizeBufferConfig } from './buffer';

package/lib/providers/personalize/types/index.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/personalize/types/inputs.d.ts

@@ -0,0 +1,7 @@
+export type PersonalizeEvent = {
+    userId?: string;
+    eventId?: string;
+    eventType: string;
+    properties: Record<string, unknown>;
+};
+export type RecordInput = PersonalizeEvent;

package/lib/providers/personalize/types/inputs.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/personalize/utils/autoTrackMedia.d.ts

@@ -0,0 +1,10 @@
+import { EventBuffer } from '../../../utils';
+import { PersonalizeBufferEvent, PersonalizeEvent } from '../types';
+type MediaAutoTrackConfig = {
+    trackingId: string;
+    sessionId: string;
+    userId?: string;
+    event: PersonalizeEvent;
+};
+export declare const autoTrackMedia: (config: MediaAutoTrackConfig, eventBuffer: EventBuffer<PersonalizeBufferEvent>) => Promise<void>;
+export {};