@splitsoftware/splitio-commons 1.2.0 → 1.2.1-rc.10

package/types/types.d.ts

@@ -48,6 +48,11 @@ declare type EventConsts = {
  * @typedef {string} SDKMode
  */
 export declare type SDKMode = 'standalone' | 'consumer' | 'localhost' | 'consumer_partial';
+/**
+ * User consent status.
+ * @typedef {string} ConsentStatus
+ */
+export declare type ConsentStatus = 'GRANTED' | 'DECLINED' | 'UNKNOWN';
 /**
  * Settings interface. This is a representation of the settings the SDK expose, that's why
  * most of it's props are readonly. Only features should be rewritten when localhost mode is active.
@@ -67,6 +72,7 @@ export interface ISettings {
     readonly scheduler: {
         featuresRefreshRate: number;
         impressionsRefreshRate: number;
+        impressionsQueueSize: number;
         metricsRefreshRate: number;
         segmentsRefreshRate: number;
         offlineRefreshRate: number;
@@ -104,6 +110,7 @@ export interface ISettings {
     };
     readonly log: ILogger;
     readonly impressionListener?: unknown;
+    readonly userConsent?: ConsentStatus;
 }
 /**
  * Log levels.
@@ -249,6 +256,13 @@ interface INodeBasicSettings extends ISharedSettings {
          * @default 300
          */
         impressionsRefreshRate?: number;
+        /**
+         * The maximum number of impression items we want to queue. If we queue more values, it will trigger a flush and reset the timer.
+         * If you use a 0 here, the queue will have no maximum size.
+         * @property {number} impressionsQueueSize
+         * @default 30000
+         */
+        impressionsQueueSize?: number;
         /**
          * The SDK sends diagnostic metrics to Split servers. This parameters controls this metric flush period in seconds.
          * @property {number} metricsRefreshRate
@@ -375,6 +389,7 @@ interface IBasicClient extends IStatusInterface {
      * @returns {Promise<void>}
      */
     destroy(): Promise<void>;
+    isClientSide: boolean;
 }
 /**
  * Common definitions between SDK instances for different environments interface.
@@ -765,6 +780,13 @@ export declare namespace SplitIO {
              * @default 60
              */
             impressionsRefreshRate?: number;
+            /**
+             * The maximum number of impression items we want to queue. If we queue more values, it will trigger a flush and reset the timer.
+             * If you use a 0 here, the queue will have no maximum size.
+             * @property {number} impressionsQueueSize
+             * @default 30000
+             */
+            impressionsQueueSize?: number;
             /**
              * The SDK sends diagnostic metrics to Split servers. This parameters controls this metric flush period in seconds.
              * @property {number} metricsRefreshRate

package/types/utils/EventEmitter.d.ts

@@ -0,0 +1,4 @@
+import { IEventEmitter } from '../types';
+export declare const EventEmitter: {
+    new (): IEventEmitter;
+};

package/types/utils/consent.d.ts

@@ -0,0 +1,2 @@
+import { ISettings } from '../types';
+export declare function isConsentGranted(settings: ISettings): boolean;

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

@@ -20,3 +20,6 @@ export declare const STORAGE_MEMORY: StorageType;
 export declare const STORAGE_LOCALSTORAGE: StorageType;
 export declare const STORAGE_REDIS: StorageType;
 export declare const STORAGE_PLUGGABLE: StorageType;
+export declare const CONSENT_GRANTED = "GRANTED";
+export declare const CONSENT_DECLINED = "DECLINED";
+export declare const CONSENT_UNKNOWN = "UNKNOWN";

package/types/utils/lang/errors.d.ts

@@ -0,0 +1,10 @@
+export declare class SplitError extends Error {
+    constructor(msg?: string);
+}
+export declare class SplitTimeoutError extends SplitError {
+    constructor(msg?: string);
+}
+export declare class SplitNetworkError extends SplitError {
+    statusCode?: number;
+    constructor(msg?: string, code?: number);
+}

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

@@ -55,13 +55,18 @@ export declare function isIntegerNumber(val: any): boolean;
  */
 export declare function isNaNNumber(val: any): boolean;
 /**
- * Validates if a value is an object with the Object prototype (map object).
+ * Validates if a value is an object created by the Object constructor (plain object).
+ * It checks `constructor.name` to avoid false negatives when validating values on a separate VM context, which has its own global built-ins.
  */
 export declare function isObject(obj: any): boolean;
 /**
  * Checks if a given value is a string.
  */
 export declare function isString(val: any): val is string;
+/**
+ * String sanitizer. Returns the provided value converted to uppercase if it is a string.
+ */
+export declare function stringToUpperCase(val: any): any;
 /**
  * Deep copy version of Object.assign using recursion.
  * There are some assumptions here. It's for internal use and we don't need verbose errors
@@ -72,10 +77,6 @@ export declare function merge(target: {
 }, source: {
     [key: string]: any;
 }, ...rest: any[]): object;
-/**
- * Shallow clone an object
- */
-export declare function shallowClone(obj: any): any;
 /**
  * Checks if the target string starts with the sub string.
  */

package/types/utils/lang/maps.d.ts

@@ -44,5 +44,12 @@ interface IMapConstructor {
     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 declare function __getMapConstructor(): IMapConstructor;
 export declare const _Map: IMapConstructor;
 export {};

package/types/utils/murmur3/commons.d.ts

@@ -0,0 +1,12 @@
+export declare function UTF16ToUTF8(key: string): string | undefined;
+/*!
+ * +----------------------------------------------------------------------------------+
+ * | murmurHash3.js v3.0.0 (http://github.com/karanlyons/murmurHash3.js)              |
+ * | A TypeScript/JavaScript implementation of MurmurHash3's hashing algorithms.      |
+ * |----------------------------------------------------------------------------------|
+ * | Copyright (c) 2012-2020 Karan Lyons. Freely distributable under the MIT license. |
+ * +----------------------------------------------------------------------------------+
+ */
+export declare function x86Multiply(m: number, n: number): number;
+export declare function x86Rotl(m: number, n: number): number;
+export declare function x86Fmix(h: number): number;

package/types/utils/murmur3/legacy.d.ts

@@ -0,0 +1,2 @@
+export declare function hash(str: string, seed: number): number;
+export declare function bucket(str: string, seed: number): number;

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

@@ -0,0 +1,3 @@
+import { IMetadata } from '../../dtos/types';
+import { ISettings } from '../../types';
+export default function buildMetadata(settings: ISettings): IMetadata;

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

@@ -0,0 +1,6 @@
+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 +1,3 @@
 import { ILogger } from '../../logger/types';
 import { SplitIO } from '../../types';
-export declare function validImpressionsMode(log: ILogger, impressionsMode: string): SplitIO.ImpressionsMode;
+export declare function validImpressionsMode(log: ILogger, impressionsMode: any): SplitIO.ImpressionsMode;

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

@@ -0,0 +1,9 @@
+import { ISettings } from '../../../types';
+/**
+ * This function validates `settings.storage` object
+ *
+ * @param {any} settings config object provided by the user to initialize the sdk
+ *
+ * @returns {Object} valid storage factory. It might be the default `InMemoryStorageCSFactory` if the provided storage is invalid.
+ */
+export declare function validateLocalhost(settings: ISettings): import("../../../types").SplitIO.LocalhostFactory | undefined;

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

@@ -0,0 +1,11 @@
+import { ILogger } from '../../logger/types';
+/**
+ * Validates the `log` (logger) property at config.
+ *
+ * @param settings user config object
+ * @returns the provided logger or a no-op logger if no one is provided
+ * @throws throws an error if a logger was provided but is invalid
+ */
+export default function logger(settings: {
+    log: unknown;
+}): ILogger;

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

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

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

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

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

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

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

@@ -5,22 +5,28 @@ import { ISettings } from '../../types';
  */
 export interface ISettingsValidationParams {
     /**
-     * Object of values to overwrite default settings.
-     * Version and startup properties are mandatory, because these values are not part of the base setting.
+     * 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'];
     };
-    /** Function to overwrite runtime values (ip and hostname) which are false by default */
-    runtime?: (settings: ISettings) => ISettings['runtime'];
-    /** Storage validator */
+    /** If true, validates core.key */
+    acceptKey?: boolean;
+    /** If true, validates core.trafficType */
+    acceptTT?: boolean;
+    /** Define runtime values (`settings.runtime`) */
+    runtime: (settings: ISettings) => ISettings['runtime'];
+    /** Storage validator (`settings.storage`) */
     storage?: (settings: ISettings) => ISettings['storage'];
-    /** Integrations validator */
+    /** Integrations validator (`settings.integrations`) */
     integrations?: (settings: ISettings) => ISettings['integrations'];
     /** Logger validator (`settings.debug`) */
     logger: (settings: ISettings) => ISettings['log'];
     /** Localhost mode validator (`settings.sync.localhostMode`) */
     localhost?: (settings: ISettings) => ISettings['sync']['localhostMode'];
+    /** User consent validator (`settings.userConsent`) */
+    consent: (settings: ISettings) => ISettings['userConsent'];
 }

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

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