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

package/types/sync/syncManagerOffline.d.ts

@@ -0,0 +1,9 @@
+import { ISyncManagerCS, ISyncManagerFactoryParams } from './types';
+import { ISplitsParser } from './offline/splitsParser/types';
+/**
+ * Offline SyncManager factory.
+ * Can be used for server-side API, and client-side API with or without multiple clients.
+ *
+ * @param splitsParser e.g., `splitsParserFromFile`, `splitsParserFromSettings`.
+ */
+export declare function syncManagerOfflineFactory(splitsParserFactory: () => ISplitsParser): (params: ISyncManagerFactoryParams) => ISyncManagerCS;

package/types/sync/syncManagerOnline.d.ts

@@ -1,6 +1,6 @@
 import { ISyncManagerCS, ISyncManagerFactoryParams } from './types';
-import { IPushManagerFactoryParams, IPushManager } from './streaming/types';
-import { IPollingManager, IPollingManagerFactoryParams } from './polling/types';
+import { IPushManager } from './streaming/types';
+import { IPollingManager } from './polling/types';
 /**
  * Online SyncManager factory.
  * Can be used for server-side API, and client-side API with or without multiple clients.
@@ -9,4 +9,4 @@ import { IPollingManager, IPollingManagerFactoryParams } from './polling/types';
  * `pollingManagerSSFactory` or `pollingManagerCSFactory` respectively.
  * @param pushManagerFactory optional to build a SyncManager with or without streaming support
  */
-export declare function syncManagerOnlineFactory(pollingManagerFactory?: (...args: IPollingManagerFactoryParams) => IPollingManager, pushManagerFactory?: (...args: IPushManagerFactoryParams) => IPushManager | undefined): (params: ISyncManagerFactoryParams) => ISyncManagerCS;
+export declare function syncManagerOnlineFactory(pollingManagerFactory?: (params: ISyncManagerFactoryParams) => IPollingManager, pushManagerFactory?: (params: ISyncManagerFactoryParams, pollingManager: IPollingManager) => IPushManager | undefined): (params: ISyncManagerFactoryParams) => ISyncManagerCS;

package/types/types.d.ts

@@ -375,6 +375,7 @@ interface IBasicClient extends IStatusInterface {
      * @returns {Promise<void>}
      */
     destroy(): Promise<void>;
+    isBrowserClient: boolean;
 }
 /**
  * Common definitions between SDK instances for different environments interface.

package/types/utils/EventEmitter.d.ts

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

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

@@ -72,10 +72,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/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/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/types.d.ts

@@ -5,19 +5,19 @@ 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 */
+    /** Function to 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'];