@aws-amplify/analytics 7.0.1-console-preview.f63250a.0 → 7.0.1-console-preview.e8aa063.0

package/lib-esm/Analytics.d.ts

@@ -1,87 +0,0 @@
-import { AnalyticsProvider, AnalyticsEvent, AutoTrackSessionOpts, AutoTrackPageViewOpts, AutoTrackEventOpts, PersonalizeAnalyticsEvent, KinesisAnalyticsEvent } from './types';
-import { PageViewTracker, EventTracker, SessionTracker } from './trackers';
-declare const trackers: {
-    pageView: typeof PageViewTracker;
-    event: typeof EventTracker;
-    session: typeof SessionTracker;
-};
-type TrackerTypes = keyof typeof trackers;
-/**
- * Provide mobile analytics client functions
- */
-export declare class AnalyticsClass {
-    private _config;
-    private _pluggables;
-    private _disabled;
-    private _trackers;
-    /**
-     * Initialize Analtyics
-     * @param config - Configuration of the Analytics
-     */
-    constructor();
-    getModuleName(): string;
-    /**
-     * configure Analytics
-     * @param {Object} config - Configuration of the Analytics
-     */
-    configure(config?: any): any;
-    /**
-     * add plugin into Analytics category
-     * @param pluggable - an instance of the plugin
-     */
-    addPluggable(pluggable: AnalyticsProvider): any;
-    /**
-     * Get the plugin object
-     * @param providerName - the name of the provider to be removed
-     */
-    getPluggable(providerName: string): AnalyticsProvider;
-    /**
-     * Remove the plugin object
-     * @param providerName - the name of the provider to be removed
-     */
-    removePluggable(providerName: string): void;
-    /**
-     * stop sending events
-     */
-    disable(): void;
-    /**
-     * start sending events
-     */
-    enable(): void;
-    /**
-     * Record Session start
-     * @param [provider] - name of the provider.
-     * @return - A promise which resolves if buffer doesn't overflow
-     */
-    startSession(provider?: string): Promise<unknown>;
-    /**
-     * Record Session stop
-     * @param [provider] - name of the provider.
-     * @return - A promise which resolves if buffer doesn't overflow
-     */
-    stopSession(provider?: string): Promise<unknown>;
-    /**
-     * Record one analytic event and send it to Pinpoint
-     * @param event - An object with the name of the event, attributes of the event and event metrics.
-     * @param [provider] - name of the provider.
-     */
-    record(event: AnalyticsEvent | PersonalizeAnalyticsEvent | KinesisAnalyticsEvent, provider?: string): Promise<unknown>;
-    updateEndpoint(attrs: {
-        [key: string]: any;
-    }, provider?: string): Promise<unknown>;
-    private _sendEvent;
-    /**
-     * Enable or disable auto tracking
-     * @param trackerType - The type of tracker to activate.
-     * @param [opts] - Auto tracking options.
-     */
-    autoTrack(trackerType: 'session', opts: AutoTrackSessionOpts): any;
-    autoTrack(trackerType: 'pageView', opts: AutoTrackPageViewOpts): any;
-    autoTrack(trackerType: 'event', opts: AutoTrackEventOpts): any;
-    autoTrack(trackerType: TrackerTypes, opts: {
-        provider: string;
-        [key: string]: any;
-    }): any;
-}
-export declare const Analytics: AnalyticsClass;
-export {};

package/lib-esm/Analytics.js

@@ -1,351 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-import { __assign, __awaiter, __generator } from "tslib";
-import { Amplify, ConsoleLogger as Logger, Hub, parseAWSExports, } from '@aws-amplify/core';
-import { AWSPinpointProvider } from './providers/AWSPinpointProvider';
-import { PageViewTracker, EventTracker, SessionTracker } from './trackers';
-var logger = new Logger('AnalyticsClass');
-var AMPLIFY_SYMBOL = (typeof Symbol !== 'undefined' && typeof Symbol.for === 'function'
-    ? Symbol.for('amplify_default')
-    : '@@amplify_default');
-var dispatchAnalyticsEvent = function (event, data, message) {
-    Hub.dispatch('analytics', { event: event, data: data, message: message }, 'Analytics', AMPLIFY_SYMBOL);
-};
-var trackers = {
-    pageView: PageViewTracker,
-    event: EventTracker,
-    session: SessionTracker,
-};
-var _instance = null;
-/**
- * Provide mobile analytics client functions
- */
-var AnalyticsClass = /** @class */ (function () {
-    /**
-     * Initialize Analtyics
-     * @param config - Configuration of the Analytics
-     */
-    function AnalyticsClass() {
-        this._config = {};
-        this._pluggables = [];
-        this._disabled = false;
-        this._trackers = {};
-        _instance = this;
-        this.record = this.record.bind(this);
-        Hub.listen('auth', listener);
-        Hub.listen('storage', listener);
-        Hub.listen('analytics', listener);
-        Hub.listen('core', listener);
-    }
-    AnalyticsClass.prototype.getModuleName = function () {
-        return 'Analytics';
-    };
-    /**
-     * configure Analytics
-     * @param {Object} config - Configuration of the Analytics
-     */
-    AnalyticsClass.prototype.configure = function (config) {
-        var _this = this;
-        if (!config)
-            return this._config;
-        logger.debug('configure Analytics', config);
-        var amplifyConfig = parseAWSExports(config);
-        this._config = Object.assign({}, this._config, amplifyConfig.Analytics, config);
-        if (this._config['disabled']) {
-            this._disabled = true;
-        }
-        // turn on the autoSessionRecord if not specified
-        if (this._config['autoSessionRecord'] === undefined) {
-            this._config['autoSessionRecord'] = true;
-        }
-        this._pluggables.forEach(function (pluggable) {
-            // for backward compatibility
-            var providerConfig = pluggable.getProviderName() === 'AWSPinpoint' &&
-                !_this._config['AWSPinpoint']
-                ? _this._config
-                : _this._config[pluggable.getProviderName()];
-            pluggable.configure(__assign({ disabled: _this._config['disabled'], autoSessionRecord: _this._config['autoSessionRecord'] }, providerConfig));
-        });
-        if (this._pluggables.length === 0) {
-            this.addPluggable(new AWSPinpointProvider());
-        }
-        dispatchAnalyticsEvent('configured', null, "The Analytics category has been configured successfully");
-        logger.debug('current configuration', this._config);
-        return this._config;
-    };
-    /**
-     * add plugin into Analytics category
-     * @param pluggable - an instance of the plugin
-     */
-    AnalyticsClass.prototype.addPluggable = function (pluggable) {
-        if (pluggable && pluggable.getCategory() === 'Analytics') {
-            this._pluggables.push(pluggable);
-            // for backward compatibility
-            var providerConfig = pluggable.getProviderName() === 'AWSPinpoint' &&
-                !this._config['AWSPinpoint']
-                ? this._config
-                : this._config[pluggable.getProviderName()];
-            var config = __assign({ disabled: this._config['disabled'] }, providerConfig);
-            pluggable.configure(config);
-            return config;
-        }
-    };
-    /**
-     * Get the plugin object
-     * @param providerName - the name of the provider to be removed
-     */
-    AnalyticsClass.prototype.getPluggable = function (providerName) {
-        for (var i = 0; i < this._pluggables.length; i += 1) {
-            var pluggable = this._pluggables[i];
-            if (pluggable.getProviderName() === providerName) {
-                return pluggable;
-            }
-        }
-        logger.debug('No plugin found with providerName', providerName);
-        return null;
-    };
-    /**
-     * Remove the plugin object
-     * @param providerName - the name of the provider to be removed
-     */
-    AnalyticsClass.prototype.removePluggable = function (providerName) {
-        var idx = 0;
-        while (idx < this._pluggables.length) {
-            if (this._pluggables[idx].getProviderName() === providerName) {
-                break;
-            }
-            idx += 1;
-        }
-        if (idx === this._pluggables.length) {
-            logger.debug('No plugin found with providerName', providerName);
-            return;
-        }
-        else {
-            this._pluggables.splice(idx, idx + 1);
-            return;
-        }
-    };
-    /**
-     * stop sending events
-     */
-    AnalyticsClass.prototype.disable = function () {
-        this._disabled = true;
-    };
-    /**
-     * start sending events
-     */
-    AnalyticsClass.prototype.enable = function () {
-        this._disabled = false;
-    };
-    /**
-     * Record Session start
-     * @param [provider] - name of the provider.
-     * @return - A promise which resolves if buffer doesn't overflow
-     */
-    AnalyticsClass.prototype.startSession = function (provider) {
-        return __awaiter(this, void 0, void 0, function () {
-            var event, params;
-            return __generator(this, function (_a) {
-                event = { name: '_session.start' };
-                params = { event: event, provider: provider };
-                dispatchAnalyticsEvent('record', event, 'Recording Analytics session start event');
-                return [2 /*return*/, this._sendEvent(params)];
-            });
-        });
-    };
-    /**
-     * Record Session stop
-     * @param [provider] - name of the provider.
-     * @return - A promise which resolves if buffer doesn't overflow
-     */
-    AnalyticsClass.prototype.stopSession = function (provider) {
-        return __awaiter(this, void 0, void 0, function () {
-            var event, params;
-            return __generator(this, function (_a) {
-                event = { name: '_session.stop' };
-                params = { event: event, provider: provider };
-                dispatchAnalyticsEvent('record', event, 'Recording Analytics session stop event');
-                return [2 /*return*/, this._sendEvent(params)];
-            });
-        });
-    };
-    /**
-     * Record one analytic event and send it to Pinpoint
-     * @param event - An object with the name of the event, attributes of the event and event metrics.
-     * @param [provider] - name of the provider.
-     */
-    AnalyticsClass.prototype.record = function (event, provider) {
-        return __awaiter(this, void 0, void 0, function () {
-            var params;
-            return __generator(this, function (_a) {
-                params = { event: event, provider: provider };
-                dispatchAnalyticsEvent('record', params.event, 'Recording Analytics event');
-                return [2 /*return*/, this._sendEvent(params)];
-            });
-        });
-    };
-    AnalyticsClass.prototype.updateEndpoint = function (attrs, provider) {
-        return __awaiter(this, void 0, void 0, function () {
-            var event;
-            return __generator(this, function (_a) {
-                event = __assign(__assign({}, attrs), { name: '_update_endpoint' });
-                return [2 /*return*/, this.record(event, provider)];
-            });
-        });
-    };
-    AnalyticsClass.prototype._sendEvent = function (params) {
-        var _this = this;
-        if (this._disabled) {
-            logger.debug('Analytics has been disabled');
-            return Promise.resolve();
-        }
-        var provider = params.provider ? params.provider : 'AWSPinpoint';
-        return new Promise(function (resolve, reject) {
-            _this._pluggables.forEach(function (pluggable) {
-                if (pluggable.getProviderName() === provider) {
-                    pluggable.record(params, { resolve: resolve, reject: reject });
-                }
-            });
-        });
-    };
-    AnalyticsClass.prototype.autoTrack = function (trackerType, opts) {
-        if (!trackers[trackerType]) {
-            logger.debug('invalid tracker type');
-            return;
-        }
-        // to sync up two different configuration ways of auto session tracking
-        if (trackerType === 'session') {
-            this._config['autoSessionRecord'] = opts['enable'];
-        }
-        var tracker = this._trackers[trackerType];
-        if (!tracker) {
-            this._trackers[trackerType] = new trackers[trackerType](this.record, opts);
-        }
-        else {
-            tracker.configure(opts);
-        }
-    };
-    return AnalyticsClass;
-}());
-export { AnalyticsClass };
-var endpointUpdated = false;
-var authConfigured = false;
-var analyticsConfigured = false;
-var credentialsConfigured = false;
-var listener = function (capsule) {
-    var channel = capsule.channel, payload = capsule.payload;
-    logger.debug('on hub capsule ' + channel, payload);
-    switch (channel) {
-        case 'auth':
-            authEvent(payload);
-            break;
-        case 'storage':
-            storageEvent(payload);
-            break;
-        case 'analytics':
-            analyticsEvent(payload);
-            break;
-        case 'core':
-            coreEvent(payload);
-            break;
-        default:
-            break;
-    }
-};
-var storageEvent = function (payload) {
-    var _a = payload.data, attrs = _a.attrs, metrics = _a.metrics;
-    if (!attrs)
-        return;
-    if (analyticsConfigured) {
-        _instance
-            .record({
-            name: 'Storage',
-            attributes: attrs,
-            metrics: metrics,
-        })
-            .catch(function (e) {
-            logger.debug('Failed to send the storage event automatically', e);
-        });
-    }
-};
-var authEvent = function (payload) {
-    var event = payload.event;
-    if (!event) {
-        return;
-    }
-    var recordAuthEvent = function (eventName) { return __awaiter(void 0, void 0, void 0, function () {
-        var err_1;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    if (!(authConfigured && analyticsConfigured)) return [3 /*break*/, 4];
-                    _a.label = 1;
-                case 1:
-                    _a.trys.push([1, 3, , 4]);
-                    return [4 /*yield*/, _instance.record({ name: "_userauth.".concat(eventName) })];
-                case 2: return [2 /*return*/, _a.sent()];
-                case 3:
-                    err_1 = _a.sent();
-                    logger.debug("Failed to send the ".concat(eventName, " event automatically"), err_1);
-                    return [3 /*break*/, 4];
-                case 4: return [2 /*return*/];
-            }
-        });
-    }); };
-    switch (event) {
-        case 'signIn':
-            return recordAuthEvent('sign_in');
-        case 'signUp':
-            return recordAuthEvent('sign_up');
-        case 'signOut':
-            return recordAuthEvent('sign_out');
-        case 'signIn_failure':
-            return recordAuthEvent('auth_fail');
-        case 'configured':
-            authConfigured = true;
-            if (analyticsConfigured) {
-                sendEvents();
-            }
-            break;
-    }
-};
-var analyticsEvent = function (payload) {
-    var event = payload.event;
-    if (!event)
-        return;
-    switch (event) {
-        case 'pinpointProvider_configured':
-            analyticsConfigured = true;
-            if (authConfigured || credentialsConfigured) {
-                sendEvents();
-            }
-            break;
-    }
-};
-var coreEvent = function (payload) {
-    var event = payload.event;
-    if (!event)
-        return;
-    switch (event) {
-        case 'credentials_configured':
-            credentialsConfigured = true;
-            if (analyticsConfigured) {
-                sendEvents();
-            }
-            break;
-    }
-};
-var sendEvents = function () {
-    var config = _instance.configure();
-    if (!endpointUpdated && config['autoSessionRecord']) {
-        _instance.updateEndpoint({ immediate: true }).catch(function (e) {
-            logger.debug('Failed to update the endpoint', e);
-        });
-        endpointUpdated = true;
-    }
-    _instance.autoTrack('session', {
-        enable: config['autoSessionRecord'],
-    });
-};
-export var Analytics = new AnalyticsClass();
-Amplify.register(Analytics);

package/lib-esm/providers/AWSKinesisFirehoseProvider.d.ts

@@ -1,12 +0,0 @@
-import { AWSKinesisProvider } from './AWSKinesisProvider';
-export declare class AWSKinesisFirehoseProvider extends AWSKinesisProvider {
-    private _kinesisFirehose;
-    constructor(config?: any);
-    /**
-     * get provider name of the plugin
-     */
-    getProviderName(): string;
-    protected _sendEvents(group: any): boolean;
-    protected _init(config: any, credentials: any): boolean;
-    private _initFirehose;
-}

package/lib-esm/providers/AWSKinesisFirehoseProvider.js

@@ -1,79 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-import { __extends } from "tslib";
-import { AnalyticsAction, ConsoleLogger as Logger } from '@aws-amplify/core';
-import { AWSKinesisProvider } from './AWSKinesisProvider';
-import { PutRecordBatchCommand, FirehoseClient, } from '@aws-sdk/client-firehose';
-import { fromUtf8 } from '@aws-sdk/util-utf8-browser';
-import { getAnalyticsUserAgent } from '../utils/UserAgent';
-var logger = new Logger('AWSKineisFirehoseProvider');
-var AWSKinesisFirehoseProvider = /** @class */ (function (_super) {
-    __extends(AWSKinesisFirehoseProvider, _super);
-    function AWSKinesisFirehoseProvider(config) {
-        return _super.call(this, config) || this;
-    }
-    /**
-     * get provider name of the plugin
-     */
-    AWSKinesisFirehoseProvider.prototype.getProviderName = function () {
-        return 'AWSKinesisFirehose';
-    };
-    AWSKinesisFirehoseProvider.prototype._sendEvents = function (group) {
-        var _this = this;
-        if (group.length === 0) {
-            return;
-        }
-        var _a = group[0], config = _a.config, credentials = _a.credentials;
-        var initClients = this._init(config, credentials);
-        if (!initClients)
-            return false;
-        var records = {};
-        group.map(function (params) {
-            // split by streamName
-            var evt = params.event;
-            var streamName = evt.streamName, data = evt.data;
-            if (records[streamName] === undefined) {
-                records[streamName] = [];
-            }
-            var bufferData = data && typeof data !== 'string' ? JSON.stringify(data) : data;
-            var Data = fromUtf8(bufferData);
-            var record = { Data: Data };
-            records[streamName].push(record);
-        });
-        Object.keys(records).map(function (streamName) {
-            logger.debug('putting records to kinesis', streamName, 'with records', records[streamName]);
-            _this._kinesisFirehose
-                .send(new PutRecordBatchCommand({
-                Records: records[streamName],
-                DeliveryStreamName: streamName,
-            }))
-                .then(function (res) { return logger.debug('Upload records to stream', streamName); })
-                .catch(function (err) { return logger.debug('Failed to upload records to Kinesis', err); });
-        });
-    };
-    AWSKinesisFirehoseProvider.prototype._init = function (config, credentials) {
-        logger.debug('init clients');
-        if (this._kinesisFirehose &&
-            this._config.credentials &&
-            this._config.credentials.sessionToken === credentials.sessionToken &&
-            this._config.credentials.identityId === credentials.identityId) {
-            logger.debug('no change for analytics config, directly return from init');
-            return true;
-        }
-        this._config.credentials = credentials;
-        var region = config.region;
-        return this._initFirehose(region, credentials);
-    };
-    AWSKinesisFirehoseProvider.prototype._initFirehose = function (region, credentials) {
-        logger.debug('initialize kinesis firehose with credentials', credentials);
-        this._kinesisFirehose = new FirehoseClient({
-            apiVersion: '2015-08-04',
-            region: region,
-            credentials: credentials,
-            customUserAgent: getAnalyticsUserAgent(AnalyticsAction.Record),
-        });
-        return true;
-    };
-    return AWSKinesisFirehoseProvider;
-}(AWSKinesisProvider));
-export { AWSKinesisFirehoseProvider };

package/lib-esm/providers/AWSKinesisProvider.d.ts

@@ -1,43 +0,0 @@
-import { AnalyticsProvider } from '../types';
-export declare class AWSKinesisProvider implements AnalyticsProvider {
-    protected _config: any;
-    private _kinesis;
-    private _buffer;
-    private _timer;
-    constructor(config?: any);
-    private _setupTimer;
-    /**
-     * get the category of the plugin
-     */
-    getCategory(): string;
-    /**
-     * get provider name of the plugin
-     */
-    getProviderName(): string;
-    /**
-     * configure the plugin
-     * @param {Object} config - configuration
-     */
-    configure(config: any): object;
-    /**
-     * record an event
-     * @param {Object} params - the params of an event
-     */
-    record(params: any): Promise<boolean>;
-    updateEndpoint(): Promise<boolean>;
-    /**
-     * @private
-     * @param params - params for the event recording
-     * Put events into buffer
-     */
-    private _putToBuffer;
-    private _sendFromBuffer;
-    protected _sendEvents(group: any): boolean;
-    protected _init(config: any, credentials: any): boolean;
-    private _initKinesis;
-    /**
-     * @private
-     * check if current credentials exists
-     */
-    private _getCredentials;
-}