@splitsoftware/splitio-commons 1.1.0 → 1.2.1-rc.1

package/types/storages/inMemory/TelemetryCacheInMemory.d.ts

@@ -0,0 +1,51 @@
+import { ImpressionDataType, EventDataType, StreamingEvent, Method, OperationType } from '../../sync/submitters/types';
+import { TelemetryCacheSync } from '../types';
+export declare class TelemetryCacheInMemory implements TelemetryCacheSync {
+    private timeUntilReady?;
+    getTimeUntilReady(): number | undefined;
+    recordTimeUntilReady(ms: number): void;
+    private timeUntilReadyFromCache?;
+    getTimeUntilReadyFromCache(): number | undefined;
+    recordTimeUntilReadyFromCache(ms: number): void;
+    private notReadyUsage;
+    getNonReadyUsage(): number;
+    recordNonReadyUsage(): void;
+    private impressionStats;
+    getImpressionStats(type: ImpressionDataType): number;
+    recordImpressionStats(type: ImpressionDataType, count: number): void;
+    private eventStats;
+    getEventStats(type: EventDataType): number;
+    recordEventStats(type: EventDataType, count: number): void;
+    private lastSync;
+    getLastSynchronization(): Record<OperationType, number | undefined>;
+    recordSuccessfulSync(resource: OperationType, timeMs: number): void;
+    private httpErrors;
+    popHttpErrors(): Record<OperationType, {
+        [statusCode: string]: number;
+    }>;
+    recordSyncError(resource: OperationType, status: number): void;
+    private httpLatencies;
+    popHttpLatencies(): Record<OperationType, number[]>;
+    recordSyncLatency(resource: OperationType, latencyMs: number): void;
+    private authRejections;
+    popAuthRejections(): number;
+    recordAuthRejections(): void;
+    private tokenRefreshes;
+    popTokenRefreshes(): number;
+    recordTokenRefreshes(): void;
+    private streamingEvents;
+    popStreamingEvents(): StreamingEvent[];
+    recordStreamingEvents(streamingEvent: StreamingEvent): void;
+    private tags;
+    popTags(): string[];
+    addTag(tag: string): void;
+    private sessionLength?;
+    getSessionLength(): number | undefined;
+    recordSessionLength(ms: number): void;
+    private exceptions;
+    popExceptions(): Record<Method, number>;
+    recordException(method: Method): void;
+    private latencies;
+    popLatencies(): Record<Method, number[]>;
+    recordLatency(method: Method, latencyMs: number): void;
+}

package/types/storages/inMemory/index.d.ts

@@ -0,0 +1,10 @@
+import { IStorageFactoryParams, IStorageSync } from '../types';
+/**
+ * InMemory storage factory for standalone server-side SplitFactory
+ *
+ * @param params parameters required by EventsCacheSync
+ */
+export declare function InMemoryStorageFactory(params: IStorageFactoryParams): IStorageSync;
+export declare namespace InMemoryStorageFactory {
+    var type: import("../types").StorageType;
+}

package/types/storages/parseSegments.d.ts

@@ -0,0 +1,6 @@
+import { ISplit } from '../dtos/types';
+import { ISet } from '../utils/lang/sets';
+/**
+ * Collect segments from a list of splits.
+ */
+export declare function parseSegments(splits: ISplit[]): ISet<string>;

package/types/storages/pluggable/TelemetryCachePluggable.d.ts

@@ -0,0 +1,2 @@
+export declare class TelemetryCachePluggable {
+}

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

@@ -4,4 +4,4 @@ import { IMySegmentsFetcher } from './types';
  * Factory of MySegments fetcher.
  * MySegments fetcher is a wrapper around `mySegments` API service that parses the response and handle errors.
  */
-export declare function mySegmentsFetcherFactory(fetchMySegments: IFetchMySegments, userMatchingKey: string): IMySegmentsFetcher;
+export declare function mySegmentsFetcherFactory(fetchMySegments: IFetchMySegments): IMySegmentsFetcher;

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/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/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

@@ -1,12 +1 @@
-import { IPushManagerCS } from './types';
-import { IStorageSync } from '../../storages/types';
-import { IReadinessManager } from '../../readiness/types';
-import { IPollingManager } from '../polling/types';
-import { IFetchAuth } from '../../services/types';
-import { ISettings } from '../../types';
-import { IPlatform } from '../../sdkFactory/types';
-/**
- * PushManager factory for client-side, with support for multiple clients.
- * It assumes settings contains a key.
- */
-export default function pushManagerCSFactory(pollingManager: IPollingManager, storage: IStorageSync, readiness: IReadinessManager, fetchAuth: IFetchAuth, platform: IPlatform, settings: ISettings): IPushManagerCS | undefined;
+export declare const pushManagerCSFactory: (params: import("../types").ISyncManagerFactoryParams, pollingManager: import("../polling/types").IPollingManager) => import("./types").IPushManager | undefined;

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

@@ -1,11 +1 @@
-import { IPushManager } from './types';
-import { IStorageSync } from '../../storages/types';
-import { IPollingManager } from '../polling/types';
-import { IReadinessManager } from '../../readiness/types';
-import { IFetchAuth } from '../../services/types';
-import { ISettings } from '../../types';
-import { IPlatform } from '../../sdkFactory/types';
-/**
- * PushManager factory for server-side
- */
-export default function pushManagerSSFactory(pollingManager: IPollingManager, storage: IStorageSync, readiness: IReadinessManager, fetchAuth: IFetchAuth, platform: IPlatform, settings: ISettings): IPushManager | undefined;
+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/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.
@@ -1108,6 +1109,45 @@ export declare namespace SplitIO {
          * @returns {boolean} Whether the event was added to the queue succesfully or not.
          */
         track(...args: [trafficType: string, eventType: string, value?: number, properties?: Properties] | [eventType: string, value?: number, properties?: Properties]): boolean;
+        /**
+         * Add an attribute to client's in memory attributes storage
+         * @function setAttribute
+         * @param {string} attributeName Attrinute name
+         * @param {string, number, boolean, list} attributeValue Attribute value
+         * @returns {boolean} true if the attribute was stored and false otherways
+         */
+        setAttribute(attributeName: string, attributeValue: Object): boolean;
+        /**
+         * Returns the attribute with the given key
+         * @function getAttribute
+         * @param {string} attributeName Attribute name
+         * @returns {Object} Attribute with the given key
+         */
+        getAttribute(attributeName: string): Object;
+        /**
+         * Add to client's in memory attributes storage the attributes in 'attributes'
+         * @function setAttributes
+         * @param {Object} attributes Object with attributes to store
+         * @returns true if attributes were stored an false otherways
+         */
+        setAttributes(attributes: Record<string, Object>): boolean;
+        /**
+         * Return all the attributes stored in client's in memory attributes storage
+         * @function getAttributes
+         * @returns {Object} returns all the stored attributes
+         */
+        getAttributes(): Record<string, Object>;
+        /**
+         * Removes from client's in memory attributes storage the attribute with the given key
+         * @function removeAttribute
+         * @param {string} attributeName
+         * @returns {boolean} true if attribute was removed and false otherways
+         */
+        removeAttribute(attributeName: string): boolean;
+        /**
+         * Remove all the stored attributes in the client's in memory attribute storage
+         */
+        clearAttributes(): boolean;
     }
     /**
      * Representation of a manager instance with synchronous storage of the SDK.

package/types/utils/EventEmitter.d.ts

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

package/types/utils/inputValidation/attribute.d.ts

@@ -0,0 +1,2 @@
+import { ILogger } from '../../logger/types';
+export declare function validateAttribute(log: ILogger, attributeKey: string, attributeValue: Object, method: string): boolean;

package/types/utils/inputValidation/attributes.d.ts

@@ -1,3 +1,4 @@
 import { SplitIO } from '../../types';
 import { ILogger } from '../../logger/types';
 export declare function validateAttributes(log: ILogger, maybeAttrs: any, method: string): SplitIO.Attributes | undefined | false;
+export declare function validateAttributesDeep(log: ILogger, maybeAttributes: Record<string, Object>, method: string): boolean;

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/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;