@splitsoftware/splitio-commons 3.1.0 → 3.1.1-rc.1

package/types/splitio.d.ts

@@ -2290,133 +2290,9 @@ declare namespace SplitIO {
     split(featureFlagName: string): SplitViewAsync;
   }
 
-  /**
-   * Fallback configuration objects returned by the `client.getConfig` method when the SDK is not ready or the provided config name is not found.
-   */
-  type FallbackConfigs = {
-    /**
-     * Fallback config for all config names.
-     */
-    global?: Config;
-    /**
-     * Fallback configs for specific config names. It takes precedence over the global fallback config.
-     */
-    byName?: {
-      [configName: string]: Config;
-    };
-  }
-
-  /**
-   * Configs SDK settings.
-   */
-  interface ConfigsClientSettings {
-    /**
-     * SDK key used to authenticate with Harness services.
-     *
-     * @see {@link https://developer.harness.io/docs/feature-management-experimentation/management-and-administration/account-settings/api-keys/}
-     */
-    sdkKey: string;
-    /**
-     * Log level for SDK logging.
-     * - `'none'`: No logging
-     * - `'error'`: Log errors only
-     * - `'warn'`: Log warnings and errors
-     * - `'info'`: Log info, warnings, and errors
-     * - `'debug'`: Log debug info and above
-     * @defaultValue `'none'`
-     */
-    logLevel?: 'none' | 'error' | 'warn' | 'info' | 'debug';
-    /**
-     * Synchronization configuration.
-     */
-    sync?: {
-      /**
-       * Polling rate for configs and segments refresh, in seconds. Minimum value: 5.
-       *
-       * @defaultValue `60`
-       */
-      pollingRate?: number;
-      /**
-       * Push rate for events and impressions, in seconds. Minimum value: 60.
-       *
-       * @defaultValue `60`
-       */
-      pushRate?: number;
-      /**
-       * Maximum queue size for events and impressions. When the queue reaches this size, a flush is triggered. Minimum value: 1000.
-       *
-       * @defaultValue `10000`
-       */
-      queueSize?: number;
-      /**
-       * Time in seconds before emitting the `SDK_READY_TIMED_OUT` event.
-       * A value of `-1` disables the timeout and thus the event is never emitted.
-       *
-       * @defaultValue `10`
-       */
-      readyTimeout?: number;
-      /**
-       * Base URLs used by the SDK for different services.
-       */
-      serviceEndpoints?: {
-        /**
-         * String property to override the base URL where the SDK will get JWT authentication credentials.
-         *
-         * @defaultValue `'https://auth.split.io'`
-         */
-        auth?: string;
-        /**
-         * String property to override the base URL where the SDK will get rollout plan related data, like configs and segments definitions.
-         *
-         * @defaultValue `'https://configs.split.io'`
-         */
-        configs?: string;
-        /**
-         * String property to override the base URL where the SDK will post event-related information like impressions.
-         *
-         * @defaultValue `'https://events.split.io'`
-         */
-        events?: string;
-      };
-    };
-    /**
-     * Fallback configuration objects returned by the `client.getConfig` method when the SDK is not ready or the provided config name is not found.
-     */
-    fallbackConfigs?: FallbackConfigs;
-    /**
-     * Custom options object for HTTP(S) requests.
-     * If provided, this object is merged with the options object passed by the SDK for EventSource and Fetch calls.
-     */
-    requestOptions?: {
-      /**
-       * Custom Node.js HTTP(S) Agent used by the SDK for HTTP(S) requests.
-       *
-       * You can use it, for example, for certificate pinning or setting a network proxy:
-       *
-       * ```
-       * const { ConfigsClient } = require('@splitsoftware/configs');
-       * const { HttpsProxyAgent } = require('https-proxy-agent');
-       *
-       * const proxyAgent = new HttpsProxyAgent(process.env.HTTPS_PROXY || 'http://10.10.1.10:1080');
-       *
-       * const client = ConfigsClient({
-       *   ...
-       *   requestOptions: {
-       *     agent: proxyAgent
-       *   }
-       * })
-       * ```
-       *
-       * @see {@link https://nodejs.org/api/https.html#class-httpsagent}
-       *
-       * @defaultValue `undefined`
-       */
-      agent?: RequestOptions['agent'];
-    };
-  }
 
   /**
-   * Target for a config evaluation.
+   * Target for an evaluation.
    */
   interface Target {
     /**
@@ -2434,50 +2310,4 @@ declare namespace SplitIO {
   type JsonValue = string | number | boolean | null | JsonObject | JsonArray;
   type JsonArray = JsonValue[];
   type JsonObject = { [key: string]: JsonValue; };
-
-  /**
-   * Config object returned by getConfig.
-   */
-  type Config = {
-    /**
-     * The name of the variant.
-     */
-    variant: string;
-    /**
-     * The config value, a raw JSON object.
-     */
-    value: JsonObject;
-  }
-
-  /**
-   * Configs SDK client interface.
-   */
-  interface ConfigsClient extends Omit<IStatusInterface, 'ready' | 'whenReadyFromCache'> {
-    /**
-     * Destroys the client.
-     *
-     * @returns A promise that resolves once all clients are destroyed.
-     */
-    destroy(): Promise<void>;
-    /**
-     * Gets the config object for a given config name and optional target. If no target is provided, the default variant of the config is returned.
-     *
-     * @param configName - The name of the config we want to get.
-     * @param target - The target of the config evaluation.
-     * @param options - An object of type EvaluationOptions for advanced evaluation options.
-     * @returns The config object.
-     */
-    getConfig(configName: string, target?: Target, options?: EvaluationOptions): Config;
-    /**
-     * Tracks an event to be fed to the results product on Harness FME user interface.
-     *
-     * @param trafficKey - The key that identifies the entity related to this event.
-     * @param trafficType - The traffic type of the entity related to this event. See {@link https://developer.harness.io/docs/feature-management-experimentation/management-and-administration/fme-settings/traffic-types/}
-     * @param eventType - The event type corresponding to this event.
-     * @param value - The value of this event.
-     * @param properties - The properties of this event. Values can be string, number, boolean or null.
-     * @returns Whether the event was added to the queue successfully or not.
-     */
-    track(trafficKey: SplitKey, trafficType: string, eventType: string, value?: number, properties?: Properties): boolean;
-  }
 }

package/cjs/evaluator/fallbackConfigsCalculator/fallbackSanitizer/index.js

@@ -1,70 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.sanitizeFallbacks = exports.isValidConfig = exports.isValidConfigName = void 0;
-var lang_1 = require("../../../utils/lang");
-var CONFIG_NAME_DISCARD_REASON = 'Invalid config name (max 100 chars, no spaces)';
-var VARIANT_DISCARD_REASON = 'Invalid variant (max 100 chars and must match pattern)';
-var VALUE_DISCARD_REASON = 'Invalid value (must be an object)';
-var VARIANT_PATTERN = /^[0-9]+[.a-zA-Z0-9_-]*$|^[a-zA-Z]+[a-zA-Z0-9_-]*$/;
-function isValidConfigName(name) {
-    return name.length <= 100 && !name.includes(' ');
-}
-exports.isValidConfigName = isValidConfigName;
-function isValidConfig(config) {
-    if (!(0, lang_1.isObject)(config))
-        return false;
-    if (!(0, lang_1.isString)(config.variant) || config.variant.length > 100 || !VARIANT_PATTERN.test(config.variant))
-        return false;
-    if (!(0, lang_1.isObject)(config.value))
-        return false;
-    return true;
-}
-exports.isValidConfig = isValidConfig;
-function sanitizeGlobal(logger, config) {
-    if (config === undefined)
-        return undefined;
-    if (!isValidConfig(config)) {
-        if (!(0, lang_1.isObject)(config) || !(0, lang_1.isString)(config.variant) || config.variant.length > 100 || !VARIANT_PATTERN.test(config.variant)) {
-            logger.error("Fallback configs - Discarded fallback: ".concat(VARIANT_DISCARD_REASON));
-        }
-        else {
-            logger.error("Fallback configs - Discarded fallback: ".concat(VALUE_DISCARD_REASON));
-        }
-        return undefined;
-    }
-    return config;
-}
-function sanitizeByName(logger, byNameFallbacks) {
-    var sanitizedByName = {};
-    if (!(0, lang_1.isObject)(byNameFallbacks))
-        return sanitizedByName;
-    Object.keys(byNameFallbacks).forEach(function (configName) {
-        var config = byNameFallbacks[configName];
-        if (!isValidConfigName(configName)) {
-            logger.error("Fallback configs - Discarded config '".concat(configName, "': ").concat(CONFIG_NAME_DISCARD_REASON));
-            return;
-        }
-        if (!isValidConfig(config)) {
-            if (!(0, lang_1.isObject)(config) || !(0, lang_1.isString)(config.variant) || config.variant.length > 100 || !VARIANT_PATTERN.test(config.variant)) {
-                logger.error("Fallback configs - Discarded config '".concat(configName, "': ").concat(VARIANT_DISCARD_REASON));
-            }
-            else {
-                logger.error("Fallback configs - Discarded config '".concat(configName, "': ").concat(VALUE_DISCARD_REASON));
-            }
-            return;
-        }
-        sanitizedByName[configName] = config;
-    });
-    return sanitizedByName;
-}
-function sanitizeFallbacks(logger, fallbacks) {
-    if (!(0, lang_1.isObject)(fallbacks)) {
-        logger.error('Fallback configs - Discarded configuration: it must be an object with optional `global` and `byName` properties');
-        return;
-    }
-    return {
-        global: sanitizeGlobal(logger, fallbacks.global),
-        byName: sanitizeByName(logger, fallbacks.byName)
-    };
-}
-exports.sanitizeFallbacks = sanitizeFallbacks;

package/cjs/evaluator/fallbackConfigsCalculator/index.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FallbackConfigsCalculator = exports.FALLBACK_PREFIX = void 0;
-var constants_1 = require("../../utils/constants");
-exports.FALLBACK_PREFIX = 'fallback - ';
-function FallbackConfigsCalculator(fallbacks) {
-    if (fallbacks === void 0) { fallbacks = {}; }
-    return function (configName, label) {
-        var _a;
-        if (label === void 0) { label = ''; }
-        var fallback = ((_a = fallbacks.byName) === null || _a === void 0 ? void 0 : _a[configName]) || fallbacks.global;
-        return fallback ?
-            {
-                treatment: fallback.variant,
-                config: fallback.value,
-                label: "".concat(exports.FALLBACK_PREFIX).concat(label),
-            } :
-            {
-                treatment: constants_1.CONTROL,
-                config: null,
-                label: label,
-            };
-    };
-}
-exports.FallbackConfigsCalculator = FallbackConfigsCalculator;

package/esm/evaluator/fallbackConfigsCalculator/fallbackSanitizer/index.js

@@ -1,64 +0,0 @@
-import { isObject, isString } from '../../../utils/lang';
-var CONFIG_NAME_DISCARD_REASON = 'Invalid config name (max 100 chars, no spaces)';
-var VARIANT_DISCARD_REASON = 'Invalid variant (max 100 chars and must match pattern)';
-var VALUE_DISCARD_REASON = 'Invalid value (must be an object)';
-var VARIANT_PATTERN = /^[0-9]+[.a-zA-Z0-9_-]*$|^[a-zA-Z]+[a-zA-Z0-9_-]*$/;
-export function isValidConfigName(name) {
-    return name.length <= 100 && !name.includes(' ');
-}
-export function isValidConfig(config) {
-    if (!isObject(config))
-        return false;
-    if (!isString(config.variant) || config.variant.length > 100 || !VARIANT_PATTERN.test(config.variant))
-        return false;
-    if (!isObject(config.value))
-        return false;
-    return true;
-}
-function sanitizeGlobal(logger, config) {
-    if (config === undefined)
-        return undefined;
-    if (!isValidConfig(config)) {
-        if (!isObject(config) || !isString(config.variant) || config.variant.length > 100 || !VARIANT_PATTERN.test(config.variant)) {
-            logger.error("Fallback configs - Discarded fallback: ".concat(VARIANT_DISCARD_REASON));
-        }
-        else {
-            logger.error("Fallback configs - Discarded fallback: ".concat(VALUE_DISCARD_REASON));
-        }
-        return undefined;
-    }
-    return config;
-}
-function sanitizeByName(logger, byNameFallbacks) {
-    var sanitizedByName = {};
-    if (!isObject(byNameFallbacks))
-        return sanitizedByName;
-    Object.keys(byNameFallbacks).forEach(function (configName) {
-        var config = byNameFallbacks[configName];
-        if (!isValidConfigName(configName)) {
-            logger.error("Fallback configs - Discarded config '".concat(configName, "': ").concat(CONFIG_NAME_DISCARD_REASON));
-            return;
-        }
-        if (!isValidConfig(config)) {
-            if (!isObject(config) || !isString(config.variant) || config.variant.length > 100 || !VARIANT_PATTERN.test(config.variant)) {
-                logger.error("Fallback configs - Discarded config '".concat(configName, "': ").concat(VARIANT_DISCARD_REASON));
-            }
-            else {
-                logger.error("Fallback configs - Discarded config '".concat(configName, "': ").concat(VALUE_DISCARD_REASON));
-            }
-            return;
-        }
-        sanitizedByName[configName] = config;
-    });
-    return sanitizedByName;
-}
-export function sanitizeFallbacks(logger, fallbacks) {
-    if (!isObject(fallbacks)) {
-        logger.error('Fallback configs - Discarded configuration: it must be an object with optional `global` and `byName` properties');
-        return;
-    }
-    return {
-        global: sanitizeGlobal(logger, fallbacks.global),
-        byName: sanitizeByName(logger, fallbacks.byName)
-    };
-}

package/esm/evaluator/fallbackConfigsCalculator/index.js

@@ -1,21 +0,0 @@
-import { CONTROL } from '../../utils/constants';
-export var FALLBACK_PREFIX = 'fallback - ';
-export function FallbackConfigsCalculator(fallbacks) {
-    if (fallbacks === void 0) { fallbacks = {}; }
-    return function (configName, label) {
-        var _a;
-        if (label === void 0) { label = ''; }
-        var fallback = ((_a = fallbacks.byName) === null || _a === void 0 ? void 0 : _a[configName]) || fallbacks.global;
-        return fallback ?
-            {
-                treatment: fallback.variant,
-                config: fallback.value,
-                label: "".concat(FALLBACK_PREFIX).concat(label),
-            } :
-            {
-                treatment: CONTROL,
-                config: null,
-                label: label,
-            };
-    };
-}

package/src/evaluator/fallbackConfigsCalculator/fallbackSanitizer/index.ts

@@ -1,76 +0,0 @@
-import SplitIO from '../../../../types/splitio';
-import { ILogger } from '../../../logger/types';
-import { isObject, isString } from '../../../utils/lang';
-
-const CONFIG_NAME_DISCARD_REASON = 'Invalid config name (max 100 chars, no spaces)';
-const VARIANT_DISCARD_REASON = 'Invalid variant (max 100 chars and must match pattern)';
-const VALUE_DISCARD_REASON = 'Invalid value (must be an object)';
-
-const VARIANT_PATTERN = /^[0-9]+[.a-zA-Z0-9_-]*$|^[a-zA-Z]+[a-zA-Z0-9_-]*$/;
-
-export function isValidConfigName(name: string): boolean {
-  return name.length <= 100 && !name.includes(' ');
-}
-
-export function isValidConfig(config?: SplitIO.Config): boolean {
-  if (!isObject(config)) return false;
-  if (!isString(config!.variant) || config!.variant.length > 100 || !VARIANT_PATTERN.test(config!.variant)) return false;
-  if (!isObject(config!.value)) return false;
-  return true;
-}
-
-function sanitizeGlobal(logger: ILogger, config?: SplitIO.Config): SplitIO.Config | undefined {
-  if (config === undefined) return undefined;
-  if (!isValidConfig(config)) {
-    if (!isObject(config) || !isString(config!.variant) || config!.variant.length > 100 || !VARIANT_PATTERN.test(config!.variant)) {
-      logger.error(`Fallback configs - Discarded fallback: ${VARIANT_DISCARD_REASON}`);
-    } else {
-      logger.error(`Fallback configs - Discarded fallback: ${VALUE_DISCARD_REASON}`);
-    }
-    return undefined;
-  }
-  return config;
-}
-
-function sanitizeByName(
-  logger: ILogger,
-  byNameFallbacks?: Record<string, SplitIO.Config>
-): Record<string, SplitIO.Config> {
-  const sanitizedByName: Record<string, SplitIO.Config> = {};
-
-  if (!isObject(byNameFallbacks)) return sanitizedByName;
-
-  Object.keys(byNameFallbacks!).forEach((configName) => {
-    const config = byNameFallbacks![configName];
-
-    if (!isValidConfigName(configName)) {
-      logger.error(`Fallback configs - Discarded config '${configName}': ${CONFIG_NAME_DISCARD_REASON}`);
-      return;
-    }
-
-    if (!isValidConfig(config)) {
-      if (!isObject(config) || !isString(config.variant) || config.variant.length > 100 || !VARIANT_PATTERN.test(config.variant)) {
-        logger.error(`Fallback configs - Discarded config '${configName}': ${VARIANT_DISCARD_REASON}`);
-      } else {
-        logger.error(`Fallback configs - Discarded config '${configName}': ${VALUE_DISCARD_REASON}`);
-      }
-      return;
-    }
-
-    sanitizedByName[configName] = config;
-  });
-
-  return sanitizedByName;
-}
-
-export function sanitizeFallbacks(logger: ILogger, fallbacks: SplitIO.FallbackConfigs): SplitIO.FallbackConfigs | undefined {
-  if (!isObject(fallbacks)) {
-    logger.error('Fallback configs - Discarded configuration: it must be an object with optional `global` and `byName` properties');
-    return;
-  }
-
-  return {
-    global: sanitizeGlobal(logger, fallbacks.global),
-    byName: sanitizeByName(logger, fallbacks.byName)
-  };
-}

package/src/evaluator/fallbackConfigsCalculator/index.ts

@@ -1,24 +0,0 @@
-import { IFallbackCalculator } from '../fallbackTreatmentsCalculator/index';
-import { CONTROL } from '../../utils/constants';
-import SplitIO from '../../../types/splitio';
-
-export const FALLBACK_PREFIX = 'fallback - ';
-
-export function FallbackConfigsCalculator(fallbacks: SplitIO.FallbackConfigs = {}): IFallbackCalculator {
-
-  return (configName: string, label = '') => {
-    const fallback = fallbacks.byName?.[configName] || fallbacks.global;
-
-    return fallback ?
-      {
-        treatment: fallback.variant,
-        config: fallback.value,
-        label: `${FALLBACK_PREFIX}${label}`,
-      } :
-      {
-        treatment: CONTROL,
-        config: null,
-        label,
-      };
-  };
-}