@splitsoftware/splitio-commons 1.1.1-rc.0 → 1.2.1-rc.2

package/types/sync/polling/fetchers/types.d.ts

@@ -2,4 +2,4 @@ import { ISplitChangesResponse, ISegmentChangesResponse } from '../../../dtos/ty
 import { IResponse } from '../../../services/types';
 export declare type ISplitChangesFetcher = (since: number, noCache?: boolean, decorator?: (promise: Promise<IResponse>) => Promise<IResponse>) => Promise<ISplitChangesResponse>;
 export declare type ISegmentChangesFetcher = (since: number, segmentName: string, noCache?: boolean, decorator?: (promise: Promise<ISegmentChangesResponse[]>) => Promise<ISegmentChangesResponse[]>) => Promise<ISegmentChangesResponse[]>;
-export declare type IMySegmentsFetcher = (noCache?: boolean, decorator?: (promise: Promise<IResponse>) => Promise<IResponse>) => Promise<string[]>;
+export declare type IMySegmentsFetcher = (userMatchingKey: string, noCache?: boolean, decorator?: (promise: Promise<IResponse>) => Promise<IResponse>) => Promise<string[]>;

package/types/sync/polling/pollingManagerCS.d.ts

@@ -1,10 +1,7 @@
 import { IPollingManagerCS } from './types';
-import { IReadinessManager } from '../../readiness/types';
-import { ISplitApi } from '../../services/types';
-import { IStorageSync } from '../../storages/types';
-import { ISettings } from '../../types';
+import { ISyncManagerFactoryParams } from '../types';
 /**
  * Expose start / stop mechanism for polling data from services.
  * For client-side API with multiple clients.
  */
-export declare function pollingManagerCSFactory(splitApi: ISplitApi, storage: IStorageSync, readiness: IReadinessManager, settings: ISettings): IPollingManagerCS;
+export declare function pollingManagerCSFactory(params: ISyncManagerFactoryParams): IPollingManagerCS;

package/types/sync/polling/pollingManagerSS.d.ts

@@ -1,9 +1,6 @@
-import { IStorageSync } from '../../storages/types';
-import { IReadinessManager } from '../../readiness/types';
-import { ISplitApi } from '../../services/types';
-import { ISettings } from '../../types';
 import { IPollingManager } from './types';
+import { ISyncManagerFactoryParams } from '../types';
 /**
  * Expose start / stop mechanism for pulling data from services.
  */
-export declare function pollingManagerSSFactory(splitApi: ISplitApi, storage: IStorageSync, readiness: IReadinessManager, settings: ISettings): IPollingManager;
+export declare function pollingManagerSSFactory(params: ISyncManagerFactoryParams): IPollingManager;

package/types/sync/polling/syncTasks/splitsSyncTask.copy.d.ts

@@ -0,0 +1,35 @@
+import { ISet } from '../../../utils/lang/sets';
+import { ISegmentsCacheSync, ISplitsCacheSync, IStorageSync } from '../../../storages/types';
+import { ISplitChangesFetcher } from '../fetchers/types';
+import { ISplit } from '../../../dtos/types';
+import { IReadinessManager, ISplitsEventEmitter } from '../../../readiness/types';
+import { ISplitsSyncTask } from '../types';
+import { IFetchSplitChanges } from '../../../services/types';
+import { ISettings } from '../../../types';
+declare type ISplitChangesUpdater = (noCache?: boolean) => Promise<boolean>;
+/**
+ * Collect segments from a raw split definition.
+ * Exported for testing purposes.
+ */
+export declare function parseSegments({ conditions }: ISplit): ISet<string>;
+interface ISplitMutations {
+    added: [string, string][];
+    removed: string[];
+    segments: string[];
+}
+/**
+ * Given the list of splits from /splitChanges endpoint, it returns the mutations,
+ * i.e., an object with added splits, removed splits and used segments.
+ * Exported for testing purposes.
+ */
+export declare function computeSplitsMutation(entries: ISplit[]): ISplitMutations;
+/**
+ * factory of SplitChanges updater (a.k.a, SplitsSyncTask), a task that:
+ *  - fetches split changes using `splitChangesFetcher`
+ *  - updates `splitsCache`
+ *  - uses `splitsEventEmitter` to emit events related to split data updates
+ * Exported for testing purposes.
+ */
+export declare function splitChangesUpdaterFactory(splitChangesFetcher: ISplitChangesFetcher, splitsCache: ISplitsCacheSync, segmentsCache: ISegmentsCacheSync, splitsEventEmitter: ISplitsEventEmitter, requestTimeoutBeforeReady: number, retriesOnFailureBeforeReady: number): ISplitChangesUpdater;
+export default function splitsSyncTaskFactory(fetchSplitChanges: IFetchSplitChanges, storage: IStorageSync, readiness: IReadinessManager, settings: ISettings): ISplitsSyncTask;
+export {};

package/types/sync/polling/syncTasks/splitsSyncTask.morelikeoriginal.d.ts

@@ -0,0 +1,35 @@
+import { ISet } from '../../../utils/lang/sets';
+import { ISegmentsCacheSync, ISplitsCacheSync, IStorageSync } from '../../../storages/types';
+import { ISplitChangesFetcher } from '../fetchers/types';
+import { ISplit } from '../../../dtos/types';
+import { IReadinessManager, ISplitsEventEmitter } from '../../../readiness/types';
+import { ISplitsSyncTask } from '../types';
+import { IFetchSplitChanges } from '../../../services/types';
+import { ISettings } from '../../../types';
+declare type ISplitChangesUpdater = (noCache?: boolean) => Promise<boolean>;
+/**
+ * Collect segments from a raw split definition.
+ * Exported for testing purposes.
+ */
+export declare function parseSegments({ conditions }: ISplit): ISet<string>;
+interface ISplitMutations {
+    added: [string, string][];
+    removed: string[];
+    segments: string[];
+}
+/**
+ * Given the list of splits from /splitChanges endpoint, it returns the mutations,
+ * i.e., an object with added splits, removed splits and used segments.
+ * Exported for testing purposes.
+ */
+export declare function computeSplitsMutation(entries: ISplit[]): ISplitMutations;
+/**
+ * factory of SplitChanges updater (a.k.a, SplitsSyncTask), a task that:
+ *  - fetches split changes using `splitChangesFetcher`
+ *  - updates `splitsCache`
+ *  - uses `splitsEventEmitter` to emit events related to split data updates
+ * Exported for testing purposes.
+ */
+export declare function splitChangesUpdaterFactory(splitChangesFetcher: ISplitChangesFetcher, splitsCache: ISplitsCacheSync, segmentsCache: ISegmentsCacheSync, splitsEventEmitter: ISplitsEventEmitter, requestTimeoutBeforeReady: number, retriesOnFailureBeforeReady: number): ISplitChangesUpdater;
+export default function splitsSyncTaskFactory(fetchSplitChanges: IFetchSplitChanges, storage: IStorageSync, readiness: IReadinessManager, settings: ISettings): ISplitsSyncTask;
+export {};

package/types/sync/polling/types.d.ts

@@ -1,7 +1,5 @@
 import { IReadinessManager } from '../../readiness/types';
-import { ISplitApi } from '../../services/types';
 import { IStorageSync } from '../../storages/types';
-import { ISettings } from '../../types';
 import { SegmentsData } from '../streaming/SSEHandler/types';
 import { ITask, ISyncTask } from '../types';
 export interface ISplitsSyncTask extends ISyncTask<[noCache?: boolean], boolean> {
@@ -21,12 +19,3 @@ export interface IPollingManagerCS extends IPollingManager {
     remove(matchingKey: string): void;
     get(matchingKey: string): ISegmentsSyncTask | undefined;
 }
-/**
- * Signature of polling manager factory/constructor
- */
-export declare type IPollingManagerFactoryParams = [
-    splitApi: ISplitApi,
-    storage: IStorageSync,
-    readiness: IReadinessManager,
-    settings: ISettings
-];

package/types/sync/polling/updaters/mySegmentsUpdater.d.ts

@@ -9,5 +9,5 @@ declare type IMySegmentsUpdater = (segmentList?: string[], noCache?: boolean) =>
  *  - updates `mySegmentsCache`
  *  - uses `segmentsEventEmitter` to emit events related to segments data updates
  */
-export declare function mySegmentsUpdaterFactory(log: ILogger, mySegmentsFetcher: IMySegmentsFetcher, splitsCache: ISplitsCacheSync, mySegmentsCache: ISegmentsCacheSync, segmentsEventEmitter: ISegmentsEventEmitter, requestTimeoutBeforeReady: number, retriesOnFailureBeforeReady: number): IMySegmentsUpdater;
+export declare function mySegmentsUpdaterFactory(log: ILogger, mySegmentsFetcher: IMySegmentsFetcher, splitsCache: ISplitsCacheSync, mySegmentsCache: ISegmentsCacheSync, segmentsEventEmitter: ISegmentsEventEmitter, requestTimeoutBeforeReady: number, retriesOnFailureBeforeReady: number, matchingKey: string): IMySegmentsUpdater;
 export {};

package/types/sync/streaming/AuthClient/indexV1.d.ts

@@ -0,0 +1,12 @@
+import { IFetchAuth } from '../../../services/types';
+import { IAuthenticate } from './types';
+/**
+ * Factory of authentication function.
+ *
+ * @param fetchAuth `SplitAPI.fetchAuth` endpoint
+ */
+export declare function authenticateFactory(fetchAuth: IFetchAuth): IAuthenticate;
+/**
+ * Returns the hash of a given user key
+ */
+export declare function hashUserKey(userKey: string): string;

package/types/sync/streaming/AuthClient/indexV2.d.ts

@@ -0,0 +1,8 @@
+import { IFetchAuthV2 } from '../../../services/types';
+import { IAuthenticateV2 } from './types';
+/**
+ * Factory of authentication function.
+ *
+ * @param fetchAuth `SplitAPI.fetchAuth` endpoint
+ */
+export declare function authenticateFactory(fetchAuthV2: IFetchAuthV2): IAuthenticateV2;

package/types/sync/streaming/UpdateWorkers/SegmentsUpdateWorker.d.ts

@@ -16,7 +16,7 @@ export declare class SegmentsUpdateWorker implements IUpdateWorker {
      * @param {Object} segmentsCache segments data cache
      * @param {Object} segmentsSyncTask task for syncing segments data
      */
-    constructor(segmentsCache: ISegmentsCacheSync, segmentsSyncTask: ISegmentsSyncTask);
+    constructor(segmentsSyncTask: ISegmentsSyncTask, segmentsCache: ISegmentsCacheSync);
     __handleSegmentUpdateCall(): void;
     /**
      * Invoked by NotificationProcessor on SEGMENT_UPDATE event

package/types/sync/streaming/pushManager.d.ts

@@ -1,13 +1,9 @@
-import { IPushManagerCS } from './types';
-import { IStorageSync } from '../../storages/types';
-import { IReadinessManager } from '../../readiness/types';
+import { IPushManager } from './types';
 import { IPollingManager } from '../polling/types';
-import { IFetchAuth } from '../../services/types';
-import { ISettings } from '../../types';
-import { IPlatform } from '../../sdkFactory/types';
+import { ISyncManagerFactoryParams } from '../types';
 /**
  * PushManager factory:
  * - for server-side if key is not provided in settings.
  * - for client-side, with support for multiple clients, if key is provided in settings
  */
-export declare function pushManagerFactory(pollingManager: IPollingManager, storage: IStorageSync, readiness: IReadinessManager, fetchAuth: IFetchAuth, platform: IPlatform, settings: ISettings): IPushManagerCS | undefined;
+export declare function pushManagerFactory(params: ISyncManagerFactoryParams, pollingManager: IPollingManager): IPushManager | undefined;

package/types/sync/streaming/pushManagerCS.d.ts

@@ -0,0 +1 @@
+export declare const pushManagerCSFactory: (params: import("../types").ISyncManagerFactoryParams, pollingManager: import("../polling/types").IPollingManager) => import("./types").IPushManager | undefined;

package/types/sync/streaming/pushManagerNoUsers.d.ts

@@ -0,0 +1,13 @@
+import { IPushManagerCS } from './types';
+import { IStorageSync } from '../../storages/types';
+import { IReadinessManager } from '../../readiness/types';
+import { IPollingManager } from '../polling/types';
+import { IFetchAuthV2 } from '../../services/types';
+import { ISettings } from '../../types';
+import { IPlatform } from '../../sdkFactory/types';
+/**
+ * PushManager factory:
+ * - for server-side if key is not provided in settings.
+ * - for client-side, with support for multiple clients, if key is provided in settings
+ */
+export default function pushManagerFactory(pollingManager: IPollingManager, storage: IStorageSync, readiness: IReadinessManager, fetchAuthV2: IFetchAuthV2, platform: IPlatform, settings: ISettings): IPushManagerCS | undefined;

package/types/sync/streaming/pushManagerSS.d.ts

@@ -0,0 +1 @@
+export declare const pushManagerSSFactory: (params: import("../types").ISyncManagerFactoryParams, pollingManager: import("../polling/types").IPollingManager) => import("./types").IPushManager | undefined;

package/types/sync/streaming/types.d.ts

@@ -1,11 +1,7 @@
 import { IMySegmentsUpdateData, IMySegmentsUpdateV2Data, ISegmentUpdateData, ISplitUpdateData, ISplitKillData } from './SSEHandler/types';
 import { ITask } from '../types';
-import { IPollingManager, ISegmentsSyncTask } from '../polling/types';
-import { IReadinessManager } from '../../readiness/types';
-import { IFetchAuth } from '../../services/types';
-import { IStorageSync } from '../../storages/types';
-import { IEventEmitter, ISettings } from '../../types';
-import { IPlatform } from '../../sdkFactory/types';
+import { ISegmentsSyncTask } from '../polling/types';
+import { IEventEmitter } from '../../types';
 import { ControlType } from './constants';
 export declare type PUSH_SUBSYSTEM_UP = 'PUSH_SUBSYSTEM_UP';
 export declare type PUSH_SUBSYSTEM_DOWN = 'PUSH_SUBSYSTEM_DOWN';
@@ -30,26 +26,10 @@ export interface IPushEventEmitter extends IEventEmitter {
     emit<T extends IPushEvent>(event: T, parsedData?: IParsedData<T>, channel?: T extends MY_SEGMENTS_UPDATE ? string : undefined): boolean;
 }
 /**
- * PushManager for server-side
+ * PushManager
  */
 export interface IPushManager extends ITask, IPushEventEmitter {
-}
-/**
- * PushManager for client-side with support for multiple clients
- */
-export interface IPushManagerCS extends IPushManager {
     add(userKey: string, mySegmentsSyncTask: ISegmentsSyncTask): void;
     remove(userKey: string): void;
 }
-/**
- * Signature of push manager factory/constructor
- */
-export declare type IPushManagerFactoryParams = [
-    pollingManager: IPollingManager,
-    storage: IStorageSync,
-    readiness: IReadinessManager,
-    fetchAuth: IFetchAuth,
-    platform: IPlatform,
-    settings: ISettings
-];
 export {};

package/types/sync/submitters/submitterManager.d.ts

@@ -1,4 +1,2 @@
-import { ISplitApi } from '../../services/types';
-import { IStorageSync } from '../../storages/types';
-import { ISettings } from '../../types';
-export declare function submitterManagerFactory(settings: ISettings, storage: IStorageSync, splitApi: ISplitApi): import("../types").ISyncTask<[], any>;
+import { ISyncManagerFactoryParams } from '../types';
+export declare function submitterManagerFactory(params: ISyncManagerFactoryParams): import("../types").ISyncTask<[], any>;

package/types/sync/submitters/telemetrySyncTask.d.ts

@@ -0,0 +1,17 @@
+import { ISyncTask, ITimeTracker } from '../types';
+import { IPostMetricsUsage } from '../../services/types';
+import { IStorageSync, TelemetryCacheSync } from '../../storages/types';
+import { TelemetryStatsPayload } from './types';
+import { ILogger } from '../../logger/types';
+/**
+ * Converts `impressions` data from cache into request payload.
+ */
+export declare function telemetryCacheAdapter(telemetryCache: TelemetryCacheSync, storage: IStorageSync): {
+    isEmpty(): boolean;
+    clear(): void;
+    state(): TelemetryStatsPayload;
+};
+/**
+ * Sync task that periodically posts impressions data
+ */
+export declare function telemetrySyncTaskFactory(log: ILogger, postMetricsUsage: IPostMetricsUsage, telemetryCache: TelemetryCacheSync, telemetryRefreshRate: number, latencyTracker: ITimeTracker, storage: IStorageSync): ISyncTask;

package/types/sync/syncManagerFromFile.d.ts

@@ -0,0 +1,2 @@
+import { SplitIO } from '../types';
+export declare function LocalhostFromFile(): SplitIO.LocalhostFactory;

package/types/sync/syncManagerFromObject.d.ts

@@ -0,0 +1,2 @@
+import { SplitIO } from '../types';
+export declare function LocalhostFromObject(): SplitIO.LocalhostFactory;

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,4 @@
+export declare function validateRuntime(): {
+    ip: boolean;
+    hostname: boolean;
+};

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

@@ -0,0 +1,5 @@
+import { ISettings } from '../../../types';
+export declare function validateRuntime(settings: ISettings): {
+    ip: string | false;
+    hostname: string | false;
+};

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'];