@splitsoftware/splitio-commons 2.0.0-rc.3 → 2.0.0-rc.4

package/types/utils/promise/wrapper.d.ts

@@ -1,21 +0,0 @@
-/**
- * wraps a given promise in a new one with a default onRejected function,
- * that handles the promise rejection if not other onRejected handler is provided.
- *
- * Caveats:
- *  - There are some cases where the `defaultOnRejected` handler is not invoked
- * and the promise rejection must be handled by the user (same as the Promise spec):
- *    - using async/await syntax with a transpiler to Promises
- *    - setting an `onFinally` handler as the first handler (e.g. `promiseWrapper(Promise.reject()).finally(...)`)
- *    - setting more than one handler with at least one of them being an onRejected handler
- *  - If the wrapped promise is rejected when using native async/await syntax, the `defaultOnRejected` handler is invoked
- * and neither the catch block nor the remaining try block are executed.
- *
- * @param customPromise promise to wrap
- * @param defaultOnRejected default onRejected function
- * @returns a promise that doesn't need to be handled for rejection (except when using async/await syntax) and
- * includes a method named `hasOnFulfilled` that returns true if the promise has attached an onFulfilled handler.
- */
-export declare function promiseWrapper<T>(customPromise: Promise<T>, defaultOnRejected: (_: any) => any): Promise<T> & {
-    hasOnFulfilled: () => boolean;
-};

package/types/utils/settingsValidation/consent.d.ts

@@ -1,6 +0,0 @@
-import { ILogger } from '../../logger/types';
-import { ConsentStatus } from '../../types';
-export declare function validateConsent({ userConsent, log }: {
-    userConsent?: any;
-    log: ILogger;
-}): ConsentStatus;

package/types/utils/settingsValidation/impressionsMode.d.ts

@@ -1,3 +0,0 @@
-import { ILogger } from '../../logger/types';
-import { SplitIO } from '../../types';
-export declare function validImpressionsMode(log: ILogger, impressionsMode: any): SplitIO.ImpressionsMode;

package/types/utils/settingsValidation/index.d.ts

@@ -1,50 +0,0 @@
-import { ISettingsValidationParams } from './types';
-import { ISettings } from '../../types';
-export declare const base: {
-    mode: import("../../types").SDKMode;
-    core: {
-        authorizationKey: undefined;
-        key: undefined;
-        labelsEnabled: boolean;
-        IPAddressesEnabled: undefined;
-    };
-    scheduler: {
-        featuresRefreshRate: number;
-        segmentsRefreshRate: number;
-        telemetryRefreshRate: number;
-        impressionsRefreshRate: number;
-        offlineRefreshRate: number;
-        eventsPushRate: number;
-        eventsQueueSize: number;
-        impressionsQueueSize: number;
-        pushRetryBackoffBase: number;
-    };
-    urls: {
-        sdk: string;
-        events: string;
-        auth: string;
-        streaming: string;
-        telemetry: string;
-    };
-    storage: undefined;
-    debug: undefined;
-    impressionListener: undefined;
-    version: undefined;
-    integrations: undefined;
-    streamingEnabled: boolean;
-    sync: {
-        splitFilters: undefined;
-        impressionsMode: string;
-        enabled: boolean;
-        flagSpecVersion: string;
-    };
-    log: undefined;
-};
-/**
- * Validates the given config and use it to build a settings object.
- * NOTE: it doesn't validate the SDK Key. Call `validateApiKey` or `validateAndTrackApiKey` for that after settings validation.
- *
- * @param config user defined configuration
- * @param validationParams defaults and fields validators used to validate and creates a settings object from a given config
- */
-export declare function settingsValidation(config: unknown, validationParams: ISettingsValidationParams): ISettings;

package/types/utils/settingsValidation/integrations/common.d.ts

@@ -1,14 +0,0 @@
-import { ILogger } from '../../../logger/types';
-/**
- * This function validates `settings.integrations` object
- *
- * @param {any} settings config object provided by the user to initialize the sdk
- * @param {function} integrationValidator filter used to remove invalid integration items
- * @param {string} extraWarning optional string used to better describe why an item might be invalid
- *
- * @returns {Array} array of valid integration items. The array might be empty if `settings` object does not have valid integrations.
- */
-export declare function validateIntegrations(settings: {
-    log: ILogger;
-    integrations?: any;
-}, integrationValidator: (integrationItem: any) => boolean, extraWarning?: string): any[];

package/types/utils/settingsValidation/integrations/configurable.d.ts

@@ -1,13 +0,0 @@
-import { ILogger } from '../../../logger/types';
-/**
- * This function validates `settings.integrations` object that consists of a list of configuration items, used by the isomorphic JS SDK.
- *
- * @param {any} settings config object provided by the user to initialize the sdk
- * @param {Array<string>} validIntegrationTypes list of integration types to filter from `settings.integrations`
- *
- * @returns {Array} array of valid integration items. The array might be empty if `settings` object does not have valid integrations.
- */
-export declare function validateConfigurableIntegrations(settings: {
-    log: ILogger;
-    integrations?: any;
-}, validIntegrationTypes?: string[]): any[];

package/types/utils/settingsValidation/integrations/pluggable.d.ts

@@ -1,13 +0,0 @@
-import { ISettings } from '../../../types';
-import { ILogger } from '../../../logger/types';
-/**
- * This function validates `settings.integrations` object that consists of a list of pluggable integration factories.
- *
- * @param {any} settings config object provided by the user to initialize the sdk
- *
- * @returns {Array} array of valid integration factories. The array might be empty if `settings` object does not have valid integrations.
- */
-export declare function validatePluggableIntegrations(settings: {
-    log: ILogger;
-    integrations?: any;
-}): ISettings['integrations'];

package/types/utils/settingsValidation/logger/builtinLogger.d.ts

@@ -1,10 +0,0 @@
-import { ILogger } from '../../../logger/types';
-/**
- * Validates the `debug` property at config and use it to set the log level.
- *
- * @param settings user config object, with an optional `debug` property of type boolean or string log level.
- * @returns a logger instance with the log level at `settings.debug`. If `settings.debug` is invalid or not provided, `initialLogLevel` is used.
- */
-export declare function validateLogger(settings: {
-    debug: unknown;
-}): ILogger;

package/types/utils/settingsValidation/logger/commons.d.ts

@@ -1,9 +0,0 @@
-import { LogLevel } from '../../../types';
-/**
- * Returns the LogLevel for the given debugValue or undefined if it is invalid,
- * i.e., if the debugValue is not a boolean or LogLevel string.
- *
- * @param debugValue debug value at config
- * @returns LogLevel of the given debugValue or undefined if the provided value is invalid
- */
-export declare function getLogLevel(debugValue: unknown): LogLevel | undefined;

package/types/utils/settingsValidation/logger/pluggableLogger.d.ts

@@ -1,11 +0,0 @@
-import { ILogger } from '../../../logger/types';
-/**
- * Validates the `debug` property at config and use it to set the logger.
- *
- * @param settings user config object, with an optional `debug` property of type boolean, string log level or a Logger object.
- * @returns a logger instance, that might be: the provided logger at `settings.debug`, or one with the given `debug` log level,
- * or one with NONE log level if `debug` is not defined or invalid.
- */
-export declare function validateLogger(settings: {
-    debug: unknown;
-}): ILogger;

package/types/utils/settingsValidation/mode.d.ts

@@ -1,5 +0,0 @@
-export declare function validateMode(key: string, mode: string): string;
-/**
- * Storage is async if mode is consumer or partial consumer
- */
-export declare function isConsumerMode(mode: string): boolean;

package/types/utils/settingsValidation/runtime.d.ts

@@ -1,2 +0,0 @@
-import { ISettings } from '../../types';
-export declare function validateRuntime(): ISettings['runtime'];

package/types/utils/settingsValidation/splitFilters.d.ts

@@ -1,17 +0,0 @@
-import { ISplitFiltersValidation } from '../../dtos/types';
-import { ILogger } from '../../logger/types';
-/**
- * Validates `splitFilters` configuration object and parses it into a query string for filtering splits on `/splitChanges` fetch.
- *
- * @param {ILogger} log logger
- * @param {any} maybeSplitFilters split filters configuration param provided by the user
- * @param {string} mode settings mode
- * @returns it returns an object with the following properties:
- *  - `validFilters`: the validated `splitFilters` configuration object defined by the user.
- *  - `queryString`: the parsed split filter query. it is null if all filters are invalid or all values in filters are invalid.
- *  - `groupedFilters`: list of values grouped by filter type.
- *
- * @throws Error if the some of the grouped list of values per filter exceeds the max allowed length
- */
-export declare function validateSplitFilters(log: ILogger, maybeSplitFilters: any, mode: string): ISplitFiltersValidation;
-export declare function validateFlagSets(log: ILogger, method: string, flagSets: string[], flagSetsInConfig: string[]): string[] | false;

package/types/utils/settingsValidation/storage/storageCS.d.ts

@@ -1,21 +0,0 @@
-import { ISettings, SDKMode } from '../../../types';
-import { ILogger } from '../../../logger/types';
-import { IStorageFactoryParams, IStorageSync } from '../../../storages/types';
-export declare function __InLocalStorageMockFactory(params: IStorageFactoryParams): IStorageSync;
-export declare namespace __InLocalStorageMockFactory {
-    var type: import("../../../storages/types").StorageType;
-}
-/**
- * This function validates `settings.storage` object
- *
- * @param {any} settings config object provided by the user to initialize the sdk
- *
- * @returns {Object} valid storage factory. Default to `InMemoryStorageCSFactory` if the provided storage is invalid or not compatible with the sdk mode if mode is standalone or localhost
- *
- * @throws error if mode is consumer and the provided storage is not compatible
- */
-export declare function validateStorageCS(settings: {
-    log: ILogger;
-    storage?: any;
-    mode: SDKMode;
-}): ISettings['storage'];

package/types/utils/settingsValidation/types.d.ts

@@ -1,30 +0,0 @@
-import { ISettings } from '../../types';
-/**
- * Parameters used to specialize the settings validation for each API variant
- * (client-side, server-side) and environment (Node server, Browser, etc)
- */
-export interface ISettingsValidationParams {
-    /**
-     * Object of values to overwrite base settings.
-     * Version and startup properties are required, because they are not defined in the base settings.
-     */
-    defaults: Partial<ISettings> & {
-        version: string;
-    } & {
-        startup: ISettings['startup'];
-    };
-    /** If true, validates core.key */
-    acceptKey?: boolean;
-    /** Define runtime values (`settings.runtime`) */
-    runtime: (settings: ISettings) => ISettings['runtime'];
-    /** Storage validator (`settings.storage`) */
-    storage?: (settings: ISettings) => ISettings['storage'];
-    /** Integrations validator (`settings.integrations`) */
-    integrations?: (settings: ISettings) => ISettings['integrations'];
-    /** Logger validator (`settings.debug`) */
-    logger: (settings: ISettings) => ISettings['log'];
-    /** User consent validator (`settings.userConsent`) */
-    consent?: (settings: ISettings) => ISettings['userConsent'];
-    /** Flag spec version validation. Configurable by the JS Synchronizer but not by the SDKs */
-    flagSpec?: (settings: ISettings) => ISettings['sync']['flagSpecVersion'];
-}

package/types/utils/settingsValidation/url.d.ts

@@ -1,10 +0,0 @@
-import { ISettings } from '../../types';
-/**
- * Get URL based on a given target (path).
- * ATM, it is only used for testing purposes.
- *
- * @param settings settings object
- * @param target url path
- * @return complete url
- */
-export declare function url(settings: ISettings, target: string): string;

package/types/utils/time/index.d.ts

@@ -1,4 +0,0 @@
-/**
-* Truncates de time frame received with the time window.
-*/
-export declare function truncateTimeFrame(timestampInMs: number): number;

package/types/utils/timeTracker/now/browser.d.ts

@@ -1 +0,0 @@
-export declare const now: () => number;

package/types/utils/timeTracker/now/node.d.ts

@@ -1 +0,0 @@
-export declare function now(): number;

package/types/utils/timeTracker/timer.d.ts

@@ -1 +0,0 @@
-export declare function timer(now: () => number): () => number;