@splitsoftware/splitio-commons 1.17.1-rc.2 → 2.0.0-rc.0

package/cjs/utils/lang/maps.js

@@ -1,96 +0,0 @@
-"use strict";
-/**
- * Map implementation based on es6-map polyfill (https://github.com/medikoo/es6-map/blob/master/polyfill.js),
- * with the minimal features used by the SDK.
-
-Copyright (C) 2013 Mariusz Nowak (www.medikoo.com)
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
-**/
-Object.defineProperty(exports, "__esModule", { value: true });
-exports._Map = exports.__getMapConstructor = exports.MapPoly = void 0;
-var MapPoly = /** @class */ (function () {
-    // unlike ES6 `Map`, it only accepts an array as first argument iterable
-    function MapPoly(entries) {
-        var _this = this;
-        this.__mapKeysData__ = [];
-        this.__mapValuesData__ = [];
-        if (Array.isArray(entries))
-            entries.forEach(function (entry) { _this.set(entry[0], entry[1]); });
-    }
-    MapPoly.prototype.clear = function () {
-        if (!this.__mapKeysData__.length)
-            return;
-        this.__mapKeysData__.length = 0;
-        this.__mapValuesData__.length = 0;
-    };
-    MapPoly.prototype.delete = function (key) {
-        var index = this.__mapKeysData__.indexOf(key);
-        if (index === -1)
-            return false;
-        this.__mapKeysData__.splice(index, 1);
-        this.__mapValuesData__.splice(index, 1);
-        return true;
-    };
-    MapPoly.prototype.forEach = function (callbackfn, thisArg) {
-        for (var i = 0; i < this.__mapKeysData__.length; i++) {
-            callbackfn.call(thisArg, this.__mapValuesData__[i], this.__mapKeysData__[i], this);
-        }
-    };
-    MapPoly.prototype.get = function (key) {
-        var index = this.__mapKeysData__.indexOf(key);
-        if (index === -1)
-            return;
-        return this.__mapValuesData__[index];
-    };
-    MapPoly.prototype.has = function (key) {
-        return this.__mapKeysData__.indexOf(key) !== -1;
-    };
-    MapPoly.prototype.set = function (key, value) {
-        var index = this.__mapKeysData__.indexOf(key);
-        if (index === -1)
-            index = this.__mapKeysData__.push(key) - 1;
-        this.__mapValuesData__[index] = value;
-        return this;
-    };
-    Object.defineProperty(MapPoly.prototype, "size", {
-        get: function () {
-            return this.__mapKeysData__.length;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    return MapPoly;
-}());
-exports.MapPoly = MapPoly;
-/**
- * return the Map constructor to use. If native Map is not available or it doesn't support the required features (e.g., IE11),
- * a ponyfill with minimal features is returned instead.
- *
- * Exported for testing purposes only.
- */
-function __getMapConstructor() {
-    // eslint-disable-next-line compat/compat
-    if (typeof Array.from === 'function' && typeof Map === 'function' && Map.prototype && Map.prototype.values) {
-        return Map;
-    }
-    return MapPoly;
-}
-exports.__getMapConstructor = __getMapConstructor;
-exports._Map = __getMapConstructor();

package/esm/integrations/browser.js

@@ -1,27 +0,0 @@
-import { GOOGLE_ANALYTICS_TO_SPLIT, SPLIT_TO_GOOGLE_ANALYTICS } from '../utils/constants/browser';
-import { pluggableIntegrationsManagerFactory } from './pluggable';
-import { GoogleAnalyticsToSplit } from './ga/GoogleAnalyticsToSplit';
-import { SplitToGoogleAnalytics } from './ga/SplitToGoogleAnalytics';
-/**
- * IntegrationsManager factory for the browser variant of the isomorphic JS SDK.
- * The integrations manager instantiates integration modules, and bypass tracked events and impressions to them.
- *
- * @param integrations valid integration settings object for browser sdk
- * @param params information of the Sdk factory instance that integrations can access to
- *
- * @returns integration manager or undefined if `integrations` are not present in settings.
- */
-export function integrationsManagerFactory(integrations, params) {
-    // maps integration config items into integration factories to reuse the pluggable integration manager
-    var integrationFactories = integrations
-        .map(function (integrationOptions) {
-        switch (integrationOptions.type) {
-            case GOOGLE_ANALYTICS_TO_SPLIT: return GoogleAnalyticsToSplit(integrationOptions);
-            case SPLIT_TO_GOOGLE_ANALYTICS: return SplitToGoogleAnalytics(integrationOptions);
-        }
-    })
-        .filter(function (integrationFactory) {
-        return integrationFactory && typeof integrationFactory === 'function';
-    });
-    return pluggableIntegrationsManagerFactory(integrationFactories, params);
-}

package/esm/integrations/ga/GaToSplit.js

@@ -1,250 +0,0 @@
-import { objectAssign } from '../../utils/lang/objectAssign';
-import { isString, isFiniteNumber, uniqAsStrings } from '../../utils/lang';
-import { validateEvent, validateEventValue, validateEventProperties, validateKey, validateTrafficType } from '../../utils/inputValidation';
-var logPrefix = 'ga-to-split: ';
-var logNameMapper = 'ga-to-split:mapper';
-/**
- * Provides a plugin to use with analytics.js, accounting for the possibility
- * that the global command queue has been renamed or not yet defined.
- * @param window Reference to global object.
- * @param pluginName The plugin name identifier.
- * @param pluginConstructor The plugin constructor function.
- * @param log Logger instance.
- * @param autoRequire If true, log error when auto-require script is not detected
- */
-function providePlugin(window, pluginName, pluginConstructor, log, autoRequire, telemetryTracker) {
-    // get reference to global command queue. Init it if not defined yet.
-    var gaAlias = window.GoogleAnalyticsObject || 'ga';
-    window[gaAlias] = window[gaAlias] || function () {
-        (window[gaAlias].q = window[gaAlias].q || []).push(arguments);
-    };
-    // provides the plugin for use with analytics.js.
-    window[gaAlias]('provide', pluginName, pluginConstructor);
-    var hasAutoRequire = window[gaAlias].q && window[gaAlias].q.push !== [].push;
-    if (autoRequire && !hasAutoRequire) { // Expecting spy on ga.q push method but not found
-        log.error(logPrefix + 'integration is configured to autorequire the splitTracker plugin, but the necessary script does not seem to have run. Please check the docs.');
-    }
-    if (telemetryTracker && hasAutoRequire) {
-        telemetryTracker.addTag('integration:ga-autorequire');
-    }
-}
-// Default mapping: object used for building the default mapper from hits to Split events
-var defaultMapping = {
-    eventTypeId: {
-        event: 'eventAction',
-        social: 'socialAction',
-    },
-    eventValue: {
-        event: 'eventValue',
-        timing: 'timingValue',
-    },
-    eventProperties: {
-        pageview: ['page'],
-        screenview: ['screenName'],
-        event: ['eventCategory', 'eventLabel'],
-        social: ['socialNetwork', 'socialTarget'],
-        timing: ['timingCategory', 'timingVar', 'timingLabel'],
-        exception: ['exDescription', 'exFatal'],
-    }
-};
-/**
- * Build a mapper function based on a mapping object
- *
- * @param {object} mapping
- */
-function mapperBuilder(mapping) {
-    return function (model) {
-        var hitType = model.get('hitType');
-        // @ts-expect-error
-        var eventTypeId = model.get(mapping.eventTypeId[hitType] || 'hitType');
-        // @ts-expect-error
-        var value = model.get(mapping.eventValue[hitType]);
-        var properties = {}; // @ts-expect-error
-        var fields = mapping.eventProperties[hitType];
-        if (fields) {
-            for (var i = 0; i < fields.length; i++) {
-                var fieldValue = model.get(fields[i]);
-                if (fieldValue !== undefined)
-                    properties[fields[i]] = fieldValue;
-            }
-        }
-        return {
-            eventTypeId: eventTypeId,
-            value: value,
-            properties: properties,
-            timestamp: Date.now(),
-        };
-    };
-}
-// exposed for unit testing purposses.
-export var defaultMapper = mapperBuilder(defaultMapping);
-export var defaultPrefix = 'ga';
-/**
- * Return a new list of identities removing invalid and duplicated ones.
- *
- * @param {Array} identities list of identities
- * @returns list of valid and unique identities. The list might be empty if `identities` is not an array or all its elements are invalid.
- */
-export function validateIdentities(identities) {
-    if (!Array.isArray(identities))
-        return [];
-    // Remove duplicated identities
-    var uniqueIdentities = uniqAsStrings(identities);
-    // Filter based on rum-agent identities validator
-    return uniqueIdentities.filter(function (identity) {
-        if (!identity)
-            return false;
-        var maybeKey = identity.key;
-        var maybeTT = identity.trafficType;
-        if (!isString(maybeKey) && !isFiniteNumber(maybeKey))
-            return false;
-        if (!isString(maybeTT))
-            return false;
-        return true;
-    });
-}
-/**
- * Checks if EventData fields (except EventTypeId) are valid, and logs corresponding warnings.
- * EventTypeId is validated separately.
- *
- * @param {EventData} data event data instance to validate. Precondition: data != undefined
- * @returns {boolean} Whether the data instance is a valid EventData or not.
- */
-export function validateEventData(log, eventData) {
-    if (!validateEvent(log, eventData.eventTypeId, logNameMapper))
-        return false;
-    if (validateEventValue(log, eventData.value, logNameMapper) === false)
-        return false;
-    var properties = validateEventProperties(log, eventData.properties, logNameMapper).properties;
-    if (properties === false)
-        return false;
-    if (eventData.timestamp && !isFiniteNumber(eventData.timestamp))
-        return false;
-    if (eventData.key && validateKey(log, eventData.key, logNameMapper) === false)
-        return false;
-    if (eventData.trafficTypeName && validateTrafficType(log, eventData.trafficTypeName, logNameMapper) === false)
-        return false;
-    return true;
-}
-var INVALID_PREFIX_REGEX = /^[^a-zA-Z0-9]+/;
-var INVALID_SUBSTRING_REGEX = /[^-_.:a-zA-Z0-9]+/g;
-/**
- * Fixes the passed string value to comply with EventTypeId format, by removing invalid characters and truncating if necessary.
- *
- * @param {object} log factory logger
- * @param {string} eventTypeId string value to fix.
- * @returns {string} Fixed version of `eventTypeId`.
- */
-export function fixEventTypeId(log, eventTypeId) {
-    // return the input eventTypeId if it cannot be fixed
-    if (!isString(eventTypeId) || eventTypeId.length === 0) {
-        return eventTypeId;
-    }
-    // replace invalid substrings and truncate
-    var fixed = eventTypeId
-        .replace(INVALID_PREFIX_REGEX, '')
-        .replace(INVALID_SUBSTRING_REGEX, '_');
-    var truncated = fixed.slice(0, 80);
-    if (truncated.length < fixed.length)
-        log.warn(logPrefix + 'EventTypeId was truncated because it cannot be more than 80 characters long.');
-    return truncated;
-}
-/**
- * GaToSplit integration.
- * This function provides the SplitTracker plugin to ga command queue.
- *
- * @param {object} sdkOptions options passed at the SDK integrations settings (isomorphic SDK) or the GoogleAnalyticsToSplit plugin (pluggable browser SDK)
- * @param {object} storage SDK storage passed to track events
- * @param {object} coreSettings core settings used to define an identity if no one provided as SDK or plugin options
- * @param {object} log factory logger
- */
-export function GaToSplit(sdkOptions, params) {
-    var storage = params.storage, _a = params.settings, coreSettings = _a.core, log = _a.log, telemetryTracker = params.telemetryTracker;
-    var defaultOptions = {
-        prefix: defaultPrefix,
-        // We set default identities if key and TT are present in settings.core
-        identities: (coreSettings.key && coreSettings.trafficType) ?
-            [{ key: coreSettings.key, trafficType: coreSettings.trafficType }] :
-            undefined
-    };
-    var SplitTracker = /** @class */ (function () {
-        // Constructor for the SplitTracker plugin.
-        function SplitTracker(tracker, pluginOptions) {
-            // precedence of options: SDK options (config.integrations) overwrite pluginOptions (`ga('require', 'splitTracker', pluginOptions)`)
-            var opts = objectAssign({}, defaultOptions, sdkOptions, pluginOptions);
-            this.tracker = tracker;
-            // Validate identities
-            var validIdentities = validateIdentities(opts.identities);
-            if (validIdentities.length === 0) {
-                log.warn(logPrefix + 'No valid identities were provided. Please check that you are passing a valid list of identities or providing a traffic type at the SDK configuration.');
-                return;
-            }
-            var invalids = validIdentities.length - opts.identities.length;
-            if (invalids) {
-                log.warn(logPrefix + (invalids + " identities were discarded because they are invalid or duplicated. Identities must be an array of objects with key and trafficType."));
-            }
-            opts.identities = validIdentities;
-            // Validate prefix
-            if (!isString(opts.prefix)) {
-                log.warn(logPrefix + 'The provided `prefix` was ignored since it is invalid. Please check that you are passing a string object as `prefix`.');
-                opts.prefix = undefined;
-            }
-            // Overwrite sendHitTask to perform plugin tasks:
-            // 1) filter hits
-            // 2) map hits to Split events
-            // 3) handle events, i.e., validate and send them to Split BE
-            var originalSendHitTask = tracker.get('sendHitTask');
-            tracker.set('sendHitTask', function (model) {
-                originalSendHitTask(model);
-                // filter hit if `hits` flag is false or if it comes from Split-to-GA integration
-                if (opts.hits === false || model.get('splitHit'))
-                    return;
-                try {
-                    if (opts.filter && !opts.filter(model))
-                        return;
-                }
-                catch (err) {
-                    log.warn(logPrefix + ("custom filter threw: " + err));
-                    return;
-                }
-                // map hit into an EventData instance
-                var eventData = defaultMapper(model);
-                if (opts.mapper) {
-                    try {
-                        eventData = opts.mapper(model, eventData);
-                    }
-                    catch (err) {
-                        log.warn(logPrefix + ("custom mapper threw: " + err));
-                        return;
-                    }
-                    if (!eventData)
-                        return;
-                }
-                // Add prefix. Nothing is appended if the prefix is falsy, e.g. undefined or ''.
-                if (opts.prefix)
-                    eventData.eventTypeId = opts.prefix + "." + eventData.eventTypeId;
-                eventData.eventTypeId = fixEventTypeId(log, eventData.eventTypeId);
-                if (!validateEventData(log, eventData))
-                    return;
-                // Store the event
-                if (eventData.key && eventData.trafficTypeName) {
-                    storage.events.track(eventData);
-                }
-                else { // Store the event for each Key-TT pair (identities), if key and TT is not present in eventData
-                    opts.identities.forEach(function (identity) {
-                        var event = objectAssign({
-                            key: identity.key,
-                            trafficTypeName: identity.trafficType,
-                        }, eventData);
-                        storage.events.track(event);
-                    });
-                }
-            });
-            log.info(logPrefix + 'integration started');
-        }
-        return SplitTracker;
-    }());
-    // Register the plugin, even if config is invalid, since, if not provided, it will block `ga` command queue.
-    // eslint-disable-next-line no-undef
-    providePlugin(window, 'splitTracker', SplitTracker, log, sdkOptions.autoRequire === true, telemetryTracker);
-}

package/esm/integrations/ga/GoogleAnalyticsToSplit.js

@@ -1,10 +0,0 @@
-import { GaToSplit } from './GaToSplit';
-export function GoogleAnalyticsToSplit(options) {
-    if (options === void 0) { options = {}; }
-    // GaToSplit integration factory
-    function GoogleAnalyticsToSplitFactory(params) {
-        return GaToSplit(options, params);
-    }
-    GoogleAnalyticsToSplitFactory.type = 'GOOGLE_ANALYTICS_TO_SPLIT';
-    return GoogleAnalyticsToSplitFactory;
-}

package/esm/integrations/ga/SplitToGa.js

@@ -1,120 +0,0 @@
-/* eslint-disable no-undef */
-import { uniq } from '../../utils/lang';
-import { SPLIT_IMPRESSION, SPLIT_EVENT } from '../../utils/constants';
-var logPrefix = 'split-to-ga: ';
-var noGaWarning = '`ga` command queue not found.';
-var noHit = 'No hit was sent.';
-var SplitToGa = /** @class */ (function () {
-    /**
-     * constructor description
-     * @param {object} options options passed at the SDK integrations settings (isomorphic SDK) or the SplitToGoogleAnalytics plugin (pluggable browser SDK)
-     */
-    function SplitToGa(log, options) {
-        this.trackerNames = SplitToGa.defaultTrackerNames;
-        this.log = log;
-        if (options) {
-            if (typeof options.filter === 'function')
-                this.filter = options.filter;
-            if (typeof options.mapper === 'function')
-                this.mapper = options.mapper;
-            // We strip off duplicated values if we received a `trackerNames` param.
-            // We don't warn if a tracker does not exist, since the user might create it after the SDK is initialized.
-            // Note: GA allows to create and get trackers using a string or number as tracker name, and does nothing if other types are used.
-            if (Array.isArray(options.trackerNames))
-                this.trackerNames = uniq(options.trackerNames);
-            // No need to validate `impressions` and `events` flags. Any other value than `false` is ignored (considered true by default).
-            this.impressions = options.impressions;
-            this.events = options.events;
-        }
-        log.info(logPrefix + 'integration started');
-        if (typeof SplitToGa.getGa() !== 'function')
-            log.warn(logPrefix + (noGaWarning + " No hits will be sent until it is available."));
-    }
-    // Default mapper function.
-    SplitToGa.defaultMapper = function (_a) {
-        var type = _a.type, payload = _a.payload;
-        switch (type) {
-            case SPLIT_IMPRESSION:
-                return {
-                    hitType: 'event',
-                    eventCategory: 'split-impression',
-                    eventAction: 'Evaluate ' + payload.impression.feature,
-                    eventLabel: 'Treatment: ' + payload.impression.treatment + '. Targeting rule: ' + payload.impression.label + '.',
-                    nonInteraction: true,
-                };
-            case SPLIT_EVENT:
-                return {
-                    hitType: 'event',
-                    eventCategory: 'split-event',
-                    eventAction: payload.eventTypeId,
-                    eventValue: payload.value,
-                    nonInteraction: true,
-                };
-        }
-    };
-    // Util to access ga command queue, accounting for the possibility that it has been renamed.
-    SplitToGa.getGa = function () {
-        return typeof window !== 'undefined' ? window[window['GoogleAnalyticsObject'] || 'ga'] : undefined;
-    };
-    /**
-     * Validates if a given object is a UniversalAnalytics.FieldsObject instance, and logs a warning if not.
-     * It checks that the object contains a `hitType`, since it is the minimal field required to send the hit
-     * and avoid the GA error `No hit type specified. Aborting hit.`.
-     * Other validations (e.g., an `event` hitType must have a `eventCategory` and `eventAction`) are handled
-     * and logged (as warnings or errors depending the case) by GA debugger, but the hit is sent anyway.
-     *
-     * @param {object} log factory logger
-     * @param {UniversalAnalytics.FieldsObject} fieldsObject object to validate.
-     * @returns {boolean} Whether the data instance is a valid FieldsObject or not.
-     */
-    SplitToGa.validateFieldsObject = function (log, fieldsObject) {
-        if (fieldsObject && fieldsObject.hitType)
-            return true;
-        log.warn(logPrefix + 'your custom mapper returned an invalid FieldsObject instance. It must be an object with at least a `hitType` field.');
-        return false;
-    };
-    SplitToGa.prototype.queue = function (data) {
-        // access ga command queue via `getGa` method, accounting for the possibility that
-        // the global `ga` reference was not yet mutated by analytics.js.
-        var ga = SplitToGa.getGa();
-        if (ga) {
-            if (this.impressions === false && data.type === SPLIT_IMPRESSION)
-                return;
-            if (this.events === false && data.type === SPLIT_EVENT)
-                return;
-            var fieldsObject_1;
-            try { // only try/catch filter and mapper, which might be defined by the user
-                // filter
-                if (this.filter && !this.filter(data))
-                    return;
-                // map data into a FieldsObject instance
-                fieldsObject_1 = SplitToGa.defaultMapper(data);
-                if (this.mapper) {
-                    fieldsObject_1 = this.mapper(data, fieldsObject_1);
-                    // don't send the hit if it is falsy or invalid
-                    if (!fieldsObject_1 || !SplitToGa.validateFieldsObject(this.log, fieldsObject_1))
-                        return;
-                }
-            }
-            catch (err) {
-                this.log.warn(logPrefix + ("queue method threw: " + err + ". " + noHit));
-                return;
-            }
-            // send the hit
-            this.trackerNames.forEach(function (trackerName) {
-                var sendCommand = trackerName ? trackerName + ".send" : 'send';
-                // mark the hit as a Split one to avoid the loop.
-                fieldsObject_1.splitHit = true;
-                // Send to GA using our reference to the GA object.
-                ga(sendCommand, fieldsObject_1);
-            });
-        }
-        else {
-            this.log.warn(logPrefix + (noGaWarning + " " + noHit));
-        }
-    };
-    // A falsy object represents the default tracker
-    SplitToGa.defaultTrackerNames = [''];
-    return SplitToGa;
-}());
-export { SplitToGa };

package/esm/integrations/ga/SplitToGoogleAnalytics.js

@@ -1,10 +0,0 @@
-import { SplitToGa } from './SplitToGa';
-export function SplitToGoogleAnalytics(options) {
-    if (options === void 0) { options = {}; }
-    // SplitToGa integration factory
-    function SplitToGoogleAnalyticsFactory(params) {
-        return new SplitToGa(params.settings.log, options);
-    }
-    SplitToGoogleAnalyticsFactory.type = 'SPLIT_TO_GOOGLE_ANALYTICS';
-    return SplitToGoogleAnalyticsFactory;
-}

package/esm/integrations/ga/types.js

@@ -1 +0,0 @@
-export {};

package/esm/sdkClient/sdkClientMethodCSWithTT.js

@@ -1,72 +0,0 @@
-import { clientCSDecorator } from './clientCS';
-import { validateKey } from '../utils/inputValidation/key';
-import { validateTrafficType } from '../utils/inputValidation/trafficType';
-import { getMatching, keyParser } from '../utils/key';
-import { sdkClientFactory } from './sdkClient';
-import { objectAssign } from '../utils/lang/objectAssign';
-import { RETRIEVE_CLIENT_DEFAULT, NEW_SHARED_CLIENT, RETRIEVE_CLIENT_EXISTING, LOG_PREFIX_CLIENT_INSTANTIATION } from '../logger/constants';
-import { SDK_SEGMENTS_ARRIVED } from '../readiness/constants';
-import { buildInstanceId } from './identity';
-/**
- * Factory of client method for the client-side (browser) variant of the Isomorphic JS SDK,
- * where clients can have a bound TT for the track method, which is provided via the settings
- * (default client) or the client method (shared clients).
- */
-export function sdkClientMethodCSFactory(params) {
-    var clients = params.clients, storage = params.storage, syncManager = params.syncManager, sdkReadinessManager = params.sdkReadinessManager, _a = params.settings, _b = _a.core, key = _b.key, trafficType = _b.trafficType, log = _a.log;
-    var mainClientInstance = clientCSDecorator(log, sdkClientFactory(params), key, trafficType);
-    var parsedDefaultKey = keyParser(key);
-    var defaultInstanceId = buildInstanceId(parsedDefaultKey, trafficType);
-    // Cache instances created per factory.
-    clients[defaultInstanceId] = mainClientInstance;
-    return function client(key, trafficType) {
-        if (key === undefined) {
-            log.debug(RETRIEVE_CLIENT_DEFAULT);
-            return mainClientInstance;
-        }
-        // Validate the key value
-        var validKey = validateKey(log, key, LOG_PREFIX_CLIENT_INSTANTIATION);
-        if (validKey === false) {
-            throw new Error('Shared Client needs a valid key.');
-        }
-        var validTrafficType;
-        if (trafficType !== undefined) {
-            validTrafficType = validateTrafficType(log, trafficType, LOG_PREFIX_CLIENT_INSTANTIATION);
-            if (validTrafficType === false) {
-                throw new Error('Shared Client needs a valid traffic type or no traffic type at all.');
-            }
-        }
-        var instanceId = buildInstanceId(validKey, validTrafficType);
-        if (!clients[instanceId]) {
-            var matchingKey = getMatching(validKey);
-            var sharedSdkReadiness_1 = sdkReadinessManager.shared();
-            var sharedStorage = storage.shared && storage.shared(matchingKey, function (err) {
-                if (err) {
-                    sharedSdkReadiness_1.readinessManager.timeout();
-                    return;
-                }
-                // Emit SDK_READY in consumer mode for shared clients
-                sharedSdkReadiness_1.readinessManager.segments.emit(SDK_SEGMENTS_ARRIVED);
-            });
-            // 3 possibilities:
-            // - Standalone mode: both syncManager and sharedSyncManager are defined
-            // - Consumer mode: both syncManager and sharedSyncManager are undefined
-            // - Consumer partial mode: syncManager is defined (only for submitters) but sharedSyncManager is undefined
-            // @ts-ignore
-            var sharedSyncManager = syncManager && sharedStorage && syncManager.shared(matchingKey, sharedSdkReadiness_1.readinessManager, sharedStorage);
-            // As shared clients reuse all the storage information, we don't need to check here if we
-            // will use offline or online mode. We should stick with the original decision.
-            clients[instanceId] = clientCSDecorator(log, sdkClientFactory(objectAssign({}, params, {
-                sdkReadinessManager: sharedSdkReadiness_1,
-                storage: sharedStorage || storage,
-                syncManager: sharedSyncManager,
-            }), true), validKey, validTrafficType);
-            sharedSyncManager && sharedSyncManager.start();
-            log.info(NEW_SHARED_CLIENT);
-        }
-        else {
-            log.debug(RETRIEVE_CLIENT_EXISTING);
-        }
-        return clients[instanceId];
-    };
-}