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

package/lib-esm/providers/kinesis-firehose/apis/flushEvents.js

@@ -0,0 +1,32 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { getEventBuffer, resolveConfig } from '../utils';
+import { getAnalyticsUserAgentString, resolveCredentials, } from '../../../utils';
+import { AnalyticsAction, ConsoleLogger, } from '@aws-amplify/core/internals/utils';
+var logger = new ConsoleLogger('KinesisFirehose');
+/**
+ * Flushes all buffered Kinesis 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 var flushEvents = function () {
+    var _a = resolveConfig(), region = _a.region, flushSize = _a.flushSize, flushInterval = _a.flushInterval, bufferSize = _a.bufferSize, resendLimit = _a.resendLimit;
+    resolveCredentials()
+        .then(function (_a) {
+        var credentials = _a.credentials, identityId = _a.identityId;
+        return getEventBuffer({
+            region: region,
+            flushSize: flushSize,
+            flushInterval: flushInterval,
+            bufferSize: bufferSize,
+            credentials: credentials,
+            identityId: identityId,
+            resendLimit: resendLimit,
+            userAgentValue: getAnalyticsUserAgentString(AnalyticsAction.Record),
+        });
+    })
+        .then(function (eventBuffer) { return eventBuffer.flushAll(); })
+        .catch(function (e) { return logger.warn('Failed to flush events.', e); });
+};

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

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

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

@@ -1,3 +1,4 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 export { record } from './record';
+export { flushEvents } from './flushEvents';

package/lib-esm/providers/kinesis-firehose/apis/record.d.ts

@@ -1,2 +1,2 @@
 import { RecordInput } from '../types';
-export declare const record: (input: RecordInput) => void;
+export declare const record: ({ streamName, data }: RecordInput) => void;

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

@@ -1,5 +1,40 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-export var record = function (input) {
-    throw new Error('Not Yet Implemented');
+import { getEventBuffer, resolveConfig } from '../utils';
+import { getAnalyticsUserAgentString, isAnalyticsEnabled, resolveCredentials, } from '../../../utils';
+import { fromUtf8 } from '@smithy/util-utf8';
+import { AnalyticsAction, ConsoleLogger as Logger, } from '@aws-amplify/core/internals/utils';
+var logger = new Logger('KinesisFirehose');
+export var record = function (_a) {
+    var streamName = _a.streamName, data = _a.data;
+    if (!isAnalyticsEnabled()) {
+        logger.debug('Analytics is disabled, event will not be recorded.');
+        return;
+    }
+    var timestamp = Date.now();
+    var _b = resolveConfig(), region = _b.region, bufferSize = _b.bufferSize, flushSize = _b.flushSize, flushInterval = _b.flushInterval, resendLimit = _b.resendLimit;
+    resolveCredentials()
+        .then(function (_a) {
+        var credentials = _a.credentials, identityId = _a.identityId;
+        var buffer = getEventBuffer({
+            region: region,
+            credentials: credentials,
+            identityId: identityId,
+            bufferSize: bufferSize,
+            flushSize: flushSize,
+            flushInterval: flushInterval,
+            resendLimit: resendLimit,
+            userAgentValue: getAnalyticsUserAgentString(AnalyticsAction.Record),
+        });
+        buffer.append({
+            region: region,
+            streamName: streamName,
+            event: ArrayBuffer.isView(data) ? data : fromUtf8(JSON.stringify(data)),
+            timestamp: timestamp,
+            retryCount: 0,
+        });
+    })
+        .catch(function (e) {
+        logger.warn('Failed to record event.', e);
+    });
 };

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

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

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

@@ -1,3 +1,3 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-export { record } from './apis';
+export { record, flushEvents } from './apis';

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

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

package/lib-esm/providers/kinesis-firehose/types/buffer.js

@@ -0,0 +1,3 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+export {};

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

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

package/lib-esm/providers/kinesis-firehose/types/inputs.d.ts

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

package/lib-esm/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-esm/providers/kinesis-firehose/utils/constants.js

@@ -0,0 +1,8 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+export var DEFAULT_KINESIS_FIREHOSE_CONFIG = {
+    bufferSize: 1000,
+    flushSize: 100,
+    flushInterval: 5000,
+    resendLimit: 5,
+};

package/lib-esm/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-esm/providers/kinesis-firehose/utils/getEventBuffer.js

@@ -0,0 +1,96 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { __assign, __awaiter, __generator, __read, __values } from "tslib";
+import { EventBuffer, groupBy } from '../../../utils';
+import { FirehoseClient, PutRecordBatchCommand, } from '@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 PutRecordBatchCommand({
+        DeliveryStreamName: streamName,
+        Records: events.map(function (event) { return ({
+            Data: event.event,
+        }); }),
+    });
+};
+var submitEvents = function (events, client, resendLimit) { return __awaiter(void 0, void 0, void 0, function () {
+    var groupedByStreamName, requests, responses, failedEvents;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                groupedByStreamName = Object.entries(groupBy(function (event) { return event.streamName; }, events));
+                requests = groupedByStreamName
+                    .map(function (_a) {
+                    var _b = __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 (__assign(__assign({}, event), { retryCount: event.retryCount + 1 })); })
+                            .sort(function (a, b) { return a.timestamp - b.timestamp; })
+                        : []];
+        }
+    });
+}); };
+export 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 FirehoseClient({
+                    region: region,
+                    credentials: credentials,
+                    customUserAgent: userAgentValue,
+                });
+            }
+            var firehoseClient = cachedClients[sessionIdentityKey];
+            return function (events) { return submitEvents(events, firehoseClient, resendLimit); };
+        };
+        eventBufferMap[sessionIdentityKey] =
+            new EventBuffer({
+                bufferSize: bufferSize,
+                flushSize: flushSize,
+                flushInterval: flushInterval,
+            }, getClient);
+        var releaseSessionKeys = Object.keys(eventBufferMap).filter(function (key) { return key !== sessionIdentityKey; });
+        try {
+            for (var releaseSessionKeys_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];
+};

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

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

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

@@ -0,0 +1,4 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+export { getEventBuffer } from './getEventBuffer';
+export { resolveConfig } from './resolveConfig';

package/lib-esm/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-esm/providers/kinesis-firehose/utils/resolveConfig.js

@@ -0,0 +1,20 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { __assign } from "tslib";
+import { Amplify } from '@aws-amplify/core';
+import { AnalyticsValidationErrorCode, assertValidationError, } from '../../../errors';
+import { DEFAULT_KINESIS_FIREHOSE_CONFIG } from './constants';
+export var resolveConfig = function () {
+    var _a;
+    var config = (_a = Amplify.getConfig().Analytics) === null || _a === void 0 ? void 0 : _a.KinesisFirehose;
+    var _b = __assign(__assign({}, DEFAULT_KINESIS_FIREHOSE_CONFIG), config), region = _b.region, _c = _b.bufferSize, bufferSize = _c === void 0 ? DEFAULT_KINESIS_FIREHOSE_CONFIG.bufferSize : _c, _d = _b.flushSize, flushSize = _d === void 0 ? DEFAULT_KINESIS_FIREHOSE_CONFIG.flushSize : _d, _e = _b.flushInterval, flushInterval = _e === void 0 ? DEFAULT_KINESIS_FIREHOSE_CONFIG.flushInterval : _e, resendLimit = _b.resendLimit;
+    assertValidationError(!!region, AnalyticsValidationErrorCode.NoRegion);
+    assertValidationError(flushSize < bufferSize, AnalyticsValidationErrorCode.InvalidFlushSize);
+    return {
+        region: region,
+        bufferSize: bufferSize,
+        flushSize: flushSize,
+        flushInterval: flushInterval,
+        resendLimit: resendLimit,
+    };
+};

package/lib-esm/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-esm/providers/personalize/apis/flushEvents.js

@@ -0,0 +1,31 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { getEventBuffer, resolveConfig } from '../utils';
+import { getAnalyticsUserAgentString, resolveCredentials, } from '../../../utils';
+import { AnalyticsAction, ConsoleLogger, } from '@aws-amplify/core/internals/utils';
+var logger = new 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.
+ */
+export var flushEvents = function () {
+    var _a = resolveConfig(), region = _a.region, flushSize = _a.flushSize, bufferSize = _a.bufferSize, flushInterval = _a.flushInterval;
+    resolveCredentials()
+        .then(function (_a) {
+        var credentials = _a.credentials, identityId = _a.identityId;
+        return getEventBuffer({
+            region: region,
+            flushSize: flushSize,
+            flushInterval: flushInterval,
+            bufferSize: bufferSize,
+            credentials: credentials,
+            identityId: identityId,
+            userAgentValue: getAnalyticsUserAgentString(AnalyticsAction.Record),
+        });
+    })
+        .then(function (eventBuffer) { return eventBuffer.flushAll(); })
+        .catch(function (e) { return logger.warn('Failed to flush events', e); });
+};

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

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

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

@@ -1,3 +1,4 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 export { record } from './record';
+export { flushEvents } from './flushEvents';

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

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

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

@@ -1,5 +1,68 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-export var record = function (input) {
-    throw new Error('Not Yet Implemented');
+import { autoTrackMedia, getEventBuffer, resolveCachedSession, resolveConfig, updateCachedSession, } from '../utils';
+import { getAnalyticsUserAgentString, isAnalyticsEnabled, resolveCredentials, } from '../../../utils';
+import { AnalyticsAction, ConsoleLogger, } from '@aws-amplify/core/internals/utils';
+import { IDENTIFY_EVENT_TYPE, MEDIA_AUTO_TRACK_EVENT_TYPE, } from '../utils/constants';
+var logger = new ConsoleLogger('Personalize');
+export var record = function (_a) {
+    var userId = _a.userId, eventId = _a.eventId, eventType = _a.eventType, properties = _a.properties;
+    if (!isAnalyticsEnabled()) {
+        logger.debug('Analytics is disabled, event will not be recorded.');
+        return;
+    }
+    var _b = resolveConfig(), region = _b.region, trackingId = _b.trackingId, bufferSize = _b.bufferSize, flushSize = _b.flushSize, flushInterval = _b.flushInterval;
+    resolveCredentials()
+        .then(function (_a) {
+        var credentials = _a.credentials, identityId = _a.identityId;
+        var timestamp = Date.now();
+        var _b = resolveCachedSession(trackingId), cachedSessionId = _b.sessionId, cachedUserId = _b.userId;
+        if (eventType === IDENTIFY_EVENT_TYPE) {
+            updateCachedSession(typeof properties.userId === 'string' ? properties.userId : '', cachedSessionId, cachedUserId);
+        }
+        else if (!!userId) {
+            updateCachedSession(userId, cachedSessionId, cachedUserId);
+        }
+        var _c = resolveCachedSession(trackingId), updatedSessionId = _c.sessionId, updatedUserId = _c.userId;
+        var eventBuffer = getEventBuffer({
+            region: region,
+            flushSize: flushSize,
+            flushInterval: flushInterval,
+            bufferSize: bufferSize,
+            credentials: credentials,
+            identityId: identityId,
+            userAgentValue: getAnalyticsUserAgentString(AnalyticsAction.Record),
+        });
+        if (eventType === MEDIA_AUTO_TRACK_EVENT_TYPE) {
+            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();
+        }
+    })
+        .catch(function (e) {
+        logger.warn('Failed to record event.', e);
+    });
 };

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

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

package/lib-esm/providers/personalize/index.js

@@ -1,3 +1,3 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-export { record } from './apis';
+export { record, flushEvents } from './apis';

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

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

package/lib-esm/providers/personalize/types/buffer.js

@@ -0,0 +1,3 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+export {};

package/lib-esm/providers/personalize/types/index.d.ts

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

package/lib-esm/providers/personalize/types/inputs.d.ts

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

package/lib-esm/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 {};