@splitsoftware/splitio-commons 1.17.1-rc.4 → 2.0.0-rc.1

package/src/integrations/ga/types.ts

@@ -1,153 +0,0 @@
-import { SplitIO } from '../../types';
-
-/**
- * A pair of user key and it's trafficType, required for tracking valid Split events.
- * @typedef {Object} Identity
- * @property {string} key The user key.
- * @property {string} trafficType The key traffic type.
- */
-export type Identity = {
-  key: string;
-  trafficType: string;
-};
-
-/**
- * Options for GoogleAnalyticsToSplit integration plugin
- */
-export interface GoogleAnalyticsToSplitOptions {
-  /**
-   * Optional flag to filter GA hits from being tracked as Split events.
-   * @property {boolean} hits
-   * @default true
-   */
-  hits?: boolean,
-  /**
-   * Optional predicate used to define a custom filter for tracking GA hits as Split events.
-   * For example, the following filter allows to track only 'event' hits:
-   *  `(model) => model.get('hitType') === 'event'`
-   * By default, all hits are tracked as Split events.
-   */
-  filter?: (model: UniversalAnalytics.Model) => boolean,
-  /**
-   * Optional function useful when you need to modify the Split event before tracking it.
-   * This function is invoked with two arguments:
-   * 1. the GA model object representing the hit.
-   * 2. the default format of the mapped Split event instance.
-   * The return value must be a Split event, that can be the second argument or a new object.
-   *
-   * For example, the following mapper adds a custom property to events:
-   *  `(model, defaultMapping) => {
-   *      defaultMapping.properties.someProperty = SOME_VALUE;
-   *      return defaultMapping;
-   *  }`
-   */
-  mapper?: (model: UniversalAnalytics.Model, defaultMapping: SplitIO.EventData) => SplitIO.EventData,
-  /**
-   * Optional prefix for EventTypeId, to prevent any kind of data collision between events.
-   * @property {string} prefix
-   * @default 'ga'
-   */
-  prefix?: string,
-  /**
-   * List of Split identities (key & traffic type pairs) used to track events.
-   * If not provided, events are sent using the key and traffic type provided at SDK config
-   */
-  identities?: Identity[],
-  /**
-   * Optional flag to log an error if the `auto-require` script is not detected.
-   * The auto-require script automatically requires the `splitTracker` plugin for created trackers,
-   * and should be placed right after your Google Analytics, Google Tag Manager or gtag.js script tag.
-   *
-   * @see {@link https://help.split.io/hc/en-us/articles/360040838752#set-up-with-gtm-and-gtag.js}
-   *
-   * @property {boolean} autoRequire
-   * @default false
-   */
-  autoRequire?: boolean,
-}
-
-/**
- * Enable 'Google Analytics to Split' integration, to track Google Analytics hits as Split events.
- * Used by the browser variant of the isomorphic JS SDK.
- *
- * @see {@link https://help.split.io/hc/en-us/articles/360040838752#google-analytics-to-split}
- */
-export interface IGoogleAnalyticsToSplitConfig extends GoogleAnalyticsToSplitOptions {
-  type: 'GOOGLE_ANALYTICS_TO_SPLIT'
-}
-
-/**
- * Options for SplitToGoogleAnalytics integration plugin
- */
-export interface SplitToGoogleAnalyticsOptions {
-  /**
-   * Optional flag to filter Split impressions from being tracked as GA hits.
-   * @property {boolean} impressions
-   * @default true
-   */
-  impressions?: boolean,
-  /**
-   * Optional flag to filter Split events from being tracked as GA hits.
-   * @property {boolean} events
-   * @default true
-   */
-  events?: boolean,
-  /**
-   * Optional predicate used to define a custom filter for tracking Split data (events and impressions) as GA hits.
-   * For example, the following filter allows to track only impressions, equivalent to setting events to false:
-   *  `(data) => data.type === 'IMPRESSION'`
-   */
-  filter?: (data: SplitIO.IntegrationData) => boolean,
-  /**
-   * Optional function useful when you need to modify the GA hit before sending it.
-   * This function is invoked with two arguments:
-   * 1. the input data (Split event or impression).
-   * 2. the default format of the mapped FieldsObject instance (GA hit).
-   * The return value must be a FieldsObject, that can be the second argument or a new object.
-   *
-   * For example, the following mapper adds a custom dimension to hits:
-   *  `(data, defaultMapping) => {
-   *      defaultMapping.dimension1 = SOME_VALUE;
-   *      return defaultMapping;
-   *  }`
-   *
-   * Default FieldsObject instance for data.type === 'IMPRESSION':
-   *  `{
-   *    hitType: 'event',
-   *    eventCategory: 'split-impression',
-   *    eventAction: 'Evaluate ' + data.payload.impression.feature,
-   *    eventLabel: 'Treatment: ' + data.payload.impression.treatment + '. Targeting rule: ' + data.payload.impression.label + '.',
-   *    nonInteraction: true,
-   *  }`
-   * Default FieldsObject instance for data.type === 'EVENT':
-   *  `{
-   *    hitType: 'event',
-   *    eventCategory: 'split-event',
-   *    eventAction: data.payload.eventTypeId,
-   *    eventValue: data.payload.value,
-   *    nonInteraction: true,
-   *  }`
-   */
-  mapper?: (data: SplitIO.IntegrationData, defaultMapping: UniversalAnalytics.FieldsObject) => UniversalAnalytics.FieldsObject,
-  /**
-   * List of tracker names to send the hit. An empty string represents the default tracker.
-   * If not provided, hits are only sent to default tracker.
-   */
-  trackerNames?: string[],
-}
-
-/**
- * Enable 'Split to Google Analytics' integration, to track Split impressions and events as Google Analytics hits.
- * Used by the browser variant of the isomorphic JS SDK.
- *
- * @see {@link https://help.split.io/hc/en-us/articles/360040838752#split-to-google-analytics}
- */
-export interface ISplitToGoogleAnalyticsConfig extends SplitToGoogleAnalyticsOptions {
-  type: 'SPLIT_TO_GOOGLE_ANALYTICS'
-}
-
-/**
- * Available integration options for the browser
- * Used by the browser variant of the isomorphic JS SDK.
- */
-export type BrowserIntegration = ISplitToGoogleAnalyticsConfig | IGoogleAnalyticsToSplitConfig;

package/src/sdkClient/sdkClientMethodCSWithTT.ts

@@ -1,96 +0,0 @@
-import { clientCSDecorator } from './clientCS';
-import { SplitIO } from '../types';
-import { validateKey } from '../utils/inputValidation/key';
-import { validateTrafficType } from '../utils/inputValidation/trafficType';
-import { getMatching, keyParser } from '../utils/key';
-import { sdkClientFactory } from './sdkClient';
-import { ISyncManagerCS } from '../sync/types';
-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 { ISdkFactoryContext } from '../sdkFactory/types';
-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: ISdkFactoryContext): (key?: SplitIO.SplitKey, trafficType?: string) => SplitIO.ICsClient {
-  const { clients, storage, syncManager, sdkReadinessManager, settings: { core: { key, trafficType }, log } } = params;
-
-  const mainClientInstance = clientCSDecorator(
-    log,
-    sdkClientFactory(params) as SplitIO.IClient,
-    key,
-    trafficType
-  );
-
-  const parsedDefaultKey = keyParser(key);
-  const defaultInstanceId = buildInstanceId(parsedDefaultKey, trafficType);
-
-  // Cache instances created per factory.
-  clients[defaultInstanceId] = mainClientInstance;
-
-  return function client(key?: SplitIO.SplitKey, trafficType?: string) {
-    if (key === undefined) {
-      log.debug(RETRIEVE_CLIENT_DEFAULT);
-      return mainClientInstance;
-    }
-
-    // Validate the key value
-    const validKey = validateKey(log, key, LOG_PREFIX_CLIENT_INSTANTIATION);
-    if (validKey === false) {
-      throw new Error('Shared Client needs a valid key.');
-    }
-
-    let 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.');
-      }
-    }
-    const instanceId = buildInstanceId(validKey, validTrafficType);
-
-    if (!clients[instanceId]) {
-      const matchingKey = getMatching(validKey);
-
-      const sharedSdkReadiness = sdkReadinessManager.shared();
-      const sharedStorage = storage.shared && storage.shared(matchingKey, (err) => {
-        if (err) {
-          sharedSdkReadiness.readinessManager.timeout();
-          return;
-        }
-        // Emit SDK_READY in consumer mode for shared clients
-        sharedSdkReadiness.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
-      const sharedSyncManager = syncManager && sharedStorage && (syncManager as ISyncManagerCS).shared(matchingKey, sharedSdkReadiness.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,
-          storage: sharedStorage || storage,
-          syncManager: sharedSyncManager,
-        }), true) as SplitIO.IClient,
-        validKey,
-        validTrafficType
-      );
-
-      log.info(NEW_SHARED_CLIENT);
-    } else {
-      log.debug(RETRIEVE_CLIENT_EXISTING);
-    }
-
-    return clients[instanceId] as SplitIO.ICsClient;
-  };
-}

package/src/utils/lang/maps.ts

@@ -1,108 +0,0 @@
-/**
- * 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.
-**/
-
-export interface IMap<K, V> {
-  clear(): void;
-  delete(key: K): boolean;
-  forEach(callbackfn: (value: V, key: K, map: Map<K, V>) => void, thisArg?: any): void;
-  get(key: K): V | undefined;
-  has(key: K): boolean;
-  set(key: K, value: V): this;
-  readonly size: number;
-}
-
-export class MapPoly<K, V> implements IMap<K, V>{
-  private __mapKeysData__: K[] = [];
-  private __mapValuesData__: V[] = [];
-
-  // unlike ES6 `Map`, it only accepts an array as first argument iterable
-  constructor(entries?: readonly (readonly [K, V])[] | null) {
-    if (Array.isArray(entries)) entries.forEach(entry => { this.set(entry[0], entry[1]); });
-  }
-
-  clear() {
-    if (!this.__mapKeysData__.length) return;
-    this.__mapKeysData__.length = 0;
-    this.__mapValuesData__.length = 0;
-  }
-
-  delete(key: K) {
-    const index = this.__mapKeysData__.indexOf(key);
-    if (index === -1) return false;
-    this.__mapKeysData__.splice(index, 1);
-    this.__mapValuesData__.splice(index, 1);
-    return true;
-  }
-
-  forEach(callbackfn: (value: V, key: K, map: Map<K, V>) => void, thisArg?: any) {
-    for (let i = 0; i < this.__mapKeysData__.length; i++) {
-      callbackfn.call(thisArg, this.__mapValuesData__[i], this.__mapKeysData__[i], this as any);
-    }
-  }
-
-  get(key: K) {
-    const index = this.__mapKeysData__.indexOf(key);
-    if (index === -1) return;
-    return this.__mapValuesData__[index];
-  }
-
-  has(key: K): boolean {
-    return this.__mapKeysData__.indexOf(key) !== -1;
-  }
-
-  set(key: K, value: V) {
-    let index = this.__mapKeysData__.indexOf(key);
-    if (index === -1) index = this.__mapKeysData__.push(key) - 1;
-    this.__mapValuesData__[index] = value;
-    return this;
-  }
-
-  get size() {
-    return this.__mapKeysData__.length;
-  }
-
-}
-
-interface IMapConstructor {
-  new(): IMap<any, any>;
-  new <K, V>(entries?: readonly (readonly [K, V])[] | null): IMap<K, V>;
-  readonly prototype: IMap<any, any>;
-}
-
-/**
- * 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.
- */
-export function __getMapConstructor(): IMapConstructor {
-  // eslint-disable-next-line compat/compat
-  if (typeof Array.from === 'function' && typeof Map === 'function' && Map.prototype && Map.prototype.values) {
-    return Map;
-  }
-  return MapPoly;
-}
-
-export const _Map = __getMapConstructor();