@splitsoftware/splitio-commons 1.6.2-rc.2 → 1.6.2-rc.3

package/types/sdkClient/types.d.ts

@@ -1,18 +0,0 @@
-import { ISignalListener } from '../listeners/types';
-import { ISdkReadinessManager } from '../readiness/types';
-import { IStorageAsync, IStorageSync } from '../storages/types';
-import { ISyncManager } from '../sync/types';
-import { IEventTracker, IImpressionsTracker } from '../trackers/types';
-import { ISettings } from '../types';
-export interface IClientFactoryParams {
-    storage: IStorageSync | IStorageAsync;
-    sdkReadinessManager: ISdkReadinessManager;
-    settings: ISettings;
-    impressionsTracker: IImpressionsTracker;
-    eventTracker: IEventTracker;
-}
-export interface ISdkClientFactoryParams extends IClientFactoryParams {
-    signalListener?: ISignalListener;
-    syncManager?: ISyncManager;
-    sharedClient?: boolean;
-}

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

@@ -1,20 +0,0 @@
-import { ICountsCacheSync } from '../types';
-export declare class CountsCacheInMemory implements ICountsCacheSync {
-    private counters;
-    /**
-     * Add counts.
-     */
-    track(metricName: string): boolean;
-    /**
-     * Clear the collector
-     */
-    clear(): void;
-    /**
-     * Get the collected data, used as payload for posting.
-     */
-    state(): Record<string, number>;
-    /**
-     * Check if the cache is empty.
-     */
-    isEmpty(): boolean;
-}

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

@@ -1,20 +0,0 @@
-import { ILatenciesCacheSync } from '../types';
-export declare class LatenciesCacheInMemory implements ILatenciesCacheSync {
-    private counters;
-    /**
-     * Add latencies.
-     */
-    track(metricName: string, latency: number): boolean;
-    /**
-     * Clear the collector
-     */
-    clear(): void;
-    /**
-     * Get the collected data, used as payload for posting.
-     */
-    state(): Record<string, number[]>;
-    /**
-     * Check if the cache is empty.
-     */
-    isEmpty(): boolean;
-}

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

@@ -1,32 +0,0 @@
-import { IUniqueKeysCacheBase } from '../types';
-import { UniqueKeysPayloadSs } from '../../sync/submitters/types';
-export declare class UniqueKeysCacheInMemory implements IUniqueKeysCacheBase {
-    private onFullQueue?;
-    private readonly maxStorage;
-    private uniqueTrackerSize;
-    private uniqueKeysTracker;
-    constructor(uniqueKeysQueueSize?: number);
-    setOnFullQueueCb(cb: () => void): void;
-    /**
-     * Store unique keys in sequential order
-     * key: string = feature name.
-     * value: Set<string> = set of unique keys.
-     */
-    track(key: string, featureName: string): void;
-    /**
-     * Clear the data stored on the cache.
-     */
-    clear(): void;
-    /**
-     * Pop the collected data, used as payload for posting.
-     */
-    pop(): UniqueKeysPayloadSs;
-    /**
-     * Check if the cache is empty.
-     */
-    isEmpty(): boolean;
-    /**
-     * Converts `uniqueKeys` data from cache into request payload for SS.
-     */
-    private fromUniqueKeysCollector;
-}

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

@@ -1,37 +0,0 @@
-import { IUniqueKeysCacheBase } from '../types';
-import { UniqueKeysPayloadCs } from '../../sync/submitters/types';
-export declare class UniqueKeysCacheInMemoryCS implements IUniqueKeysCacheBase {
-    private onFullQueue?;
-    private readonly maxStorage;
-    private uniqueTrackerSize;
-    private uniqueKeysTracker;
-    /**
-     *
-     * @param impressionsQueueSize number of queued impressions to call onFullQueueCb.
-     * Default value is 0, that means no maximum value, in case we want to avoid this being triggered.
-     */
-    constructor(uniqueKeysQueueSize?: number);
-    setOnFullQueueCb(cb: () => void): void;
-    /**
-     * Store unique keys in sequential order
-     * key: string = key.
-     * value: HashSet<string> = set of split names.
-     */
-    track(key: string, featureName: string): void;
-    /**
-     * Clear the data stored on the cache.
-     */
-    clear(): void;
-    /**
-     * Pop the collected data, used as payload for posting.
-     */
-    pop(): UniqueKeysPayloadCs;
-    /**
-     * Check if the cache is empty.
-     */
-    isEmpty(): boolean;
-    /**
-     * Converts `uniqueKeys` data from cache into request payload.
-     */
-    private fromUniqueKeysCollector;
-}

package/types/storages/inRedis/CountsCacheInRedis.d.ts

@@ -1,9 +0,0 @@
-import { ICountsCacheAsync } from '../types';
-import { KeyBuilderSS } from '../KeyBuilderSS';
-import { Redis } from 'ioredis';
-export declare class CountsCacheInRedis implements ICountsCacheAsync {
-    private readonly redis;
-    private readonly keys;
-    constructor(keys: KeyBuilderSS, redis: Redis);
-    track(metricName: string): Promise<boolean>;
-}

package/types/storages/inRedis/LatenciesCacheInRedis.d.ts

@@ -1,9 +0,0 @@
-import { ILatenciesCacheAsync } from '../types';
-import { KeyBuilderSS } from '../KeyBuilderSS';
-import { Redis } from 'ioredis';
-export declare class LatenciesCacheInRedis implements ILatenciesCacheAsync {
-    private readonly redis;
-    private readonly keys;
-    constructor(keys: KeyBuilderSS, redis: Redis);
-    track(metricName: string, latency: number): Promise<boolean>;
-}

package/types/sync/offline/LocalhostFromFile.d.ts

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

package/types/sync/offline/splitsParser/splitsParserFromFile.d.ts

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

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

@@ -1,8 +0,0 @@
-import { IEventsCacheSync } from '../../storages/types';
-import { IPostEventsBulk } from '../../services/types';
-import { ISyncTask, ITimeTracker } from '../types';
-import { ILogger } from '../../logger/types';
-/**
- * Sync task that periodically posts tracked events
- */
-export declare function eventsSyncTaskFactory(log: ILogger, postEventsBulk: IPostEventsBulk, eventsCache: IEventsCacheSync, eventsPushRate: number, eventsFirstPushWindow: number, latencyTracker?: ITimeTracker): ISyncTask;

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

@@ -1,13 +0,0 @@
-import { ISyncTask, ITimeTracker } from '../types';
-import { IPostTestImpressionsCount } from '../../services/types';
-import { IImpressionCountsCacheSync } from '../../storages/types';
-import { ImpressionCountsPayload } from './types';
-import { ILogger } from '../../logger/types';
-/**
- * Converts `impressionCounts` data from cache into request payload.
- */
-export declare function fromImpressionCountsCollector(impressionsCount: Record<string, number>): ImpressionCountsPayload;
-/**
- * Sync task that periodically posts impression counts
- */
-export declare function impressionCountsSyncTaskFactory(log: ILogger, postTestImpressionsCount: IPostTestImpressionsCount, impressionCountsCache: IImpressionCountsCacheSync, latencyTracker?: ITimeTracker): ISyncTask;

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

@@ -1,14 +0,0 @@
-import { ISyncTask, ITimeTracker } from '../types';
-import { IPostTestImpressionsBulk } from '../../services/types';
-import { IImpressionsCacheSync } from '../../storages/types';
-import { ImpressionDTO } from '../../types';
-import { ImpressionsPayload } from './types';
-import { ILogger } from '../../logger/types';
-/**
- * Converts `impressions` data from cache into request payload.
- */
-export declare function fromImpressionsCollector(sendLabels: boolean, data: ImpressionDTO[]): ImpressionsPayload;
-/**
- * Sync task that periodically posts impressions data
- */
-export declare function impressionsSyncTaskFactory(log: ILogger, postTestImpressionsBulk: IPostTestImpressionsBulk, impressionsCache: IImpressionsCacheSync, impressionsRefreshRate: number, sendLabels?: boolean, latencyTracker?: ITimeTracker): ISyncTask;

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

@@ -1,12 +0,0 @@
-import { ICountsCacheSync, ILatenciesCacheSync } from '../../storages/types';
-import { IPostMetricsCounters, IPostMetricsTimes } from '../../services/types';
-import { ISyncTask, ITimeTracker } from '../types';
-import { ILogger } from '../../logger/types';
-/**
- * Sync task that periodically posts telemetry counts
- */
-export declare function countsSyncTaskFactory(log: ILogger, postMetricsCounters: IPostMetricsCounters, countsCache: ICountsCacheSync, metricsRefreshRate: number, latencyTracker?: ITimeTracker): ISyncTask;
-/**
- * Sync task that periodically posts telemetry latencies
- */
-export declare function latenciesSyncTaskFactory(log: ILogger, postMetricsLatencies: IPostMetricsTimes, latenciesCache: ILatenciesCacheSync, metricsRefreshRate: number, latencyTracker?: ITimeTracker): ISyncTask;

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

@@ -1,10 +0,0 @@
-import { ISyncTask, ITimeTracker } from '../types';
-import { IRecorderCacheProducerSync } from '../../storages/types';
-import { ILogger } from '../../logger/types';
-import { IResponse } from '../../services/types';
-/**
- * Base function to create submitter sync tasks, such as ImpressionsSyncTask and EventsSyncTask
- */
-export declare function submitterSyncTaskFactory<TState extends {
-    length?: number;
-}>(log: ILogger, postClient: (body: string) => Promise<IResponse>, sourceCache: IRecorderCacheProducerSync<TState>, postRate: number, dataName: string, latencyTracker?: ITimeTracker, fromCacheToPayload?: (cacheData: TState) => any, maxRetries?: number, debugLogs?: boolean): ISyncTask<[], void>;

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

@@ -1,5 +0,0 @@
-import { ISdkFactoryContextSync } from '../../sdkFactory/types';
-/**
- * Submitter that periodically posts impression counts
- */
-export declare function uniqueKeysSubmitterFactory(params: ISdkFactoryContextSync): import("../types").ISyncTask<[], void>;

package/types/sync/syncTaskComposite.d.ts

@@ -1,5 +0,0 @@
-import { ISyncTask } from './types';
-/**
- * Composite Sync Task: group of sync tasks that are treated as a single one.
- */
-export declare function syncTaskComposite(syncTasks: ISyncTask[]): ISyncTask;

package/types/trackers/filter/bloomFilter.d.ts

@@ -1,10 +0,0 @@
-import { IFilter } from './types';
-export declare class BloomFilterImp implements IFilter {
-    private spectedInsertions;
-    private errorRate;
-    private filter;
-    constructor(spectedInsertions: number, errorRate: number);
-    add(data: string): boolean;
-    contains(data: string): boolean;
-    clear(): void;
-}

package/types/trackers/filter/dictionaryFilter.d.ts

@@ -1,8 +0,0 @@
-import { IFilter } from './types';
-export declare class DictionaryFilter implements IFilter {
-    private filter;
-    constructor();
-    add(data: string): boolean;
-    contains(data: string): boolean;
-    clear(): void;
-}

package/types/trackers/filter/types.d.ts

@@ -1,5 +0,0 @@
-export interface IFilter {
-    add(data: string): boolean;
-    contains(data: string): boolean;
-    clear(): void;
-}

package/types/trackers/strategy/strategyDebug.d.ts

@@ -1,9 +0,0 @@
-import { IImpressionObserver } from '../impressionObserver/types';
-import { IStrategy } from '../types';
-/**
- * Debug strategy for impressions tracker. Wraps impressions to store and adds previousTime if it corresponds
- *
- * @param impressionsObserver impression observer. Previous time (pt property) is included in impression instances
- * @returns IStrategyResult
- */
-export declare function strategyDebugFactory(impressionsObserver: IImpressionObserver): IStrategy;

package/types/trackers/strategy/strategyNone.d.ts

@@ -1,10 +0,0 @@
-import { IImpressionCountsCacheSync } from '../../storages/types';
-import { IStrategy, IUniqueKeysTracker } from '../types';
-/**
- * None strategy for impressions tracker.
- *
- * @param impressionsCounter cache to save impressions count. impressions will be deduped (OPTIMIZED mode)
- * @param uniqueKeysTracker unique keys tracker in charge of tracking the unique keys per split.
- * @returns IStrategyResult
- */
-export declare function strategyNoneFactory(impressionsCounter: IImpressionCountsCacheSync, uniqueKeysTracker: IUniqueKeysTracker): IStrategy;

package/types/trackers/strategy/strategyOptimized.d.ts

@@ -1,11 +0,0 @@
-import { IImpressionCountsCacheSync } from '../../storages/types';
-import { IImpressionObserver } from '../impressionObserver/types';
-import { IStrategy } from '../types';
-/**
- * Optimized strategy for impressions tracker. Wraps impressions to store and adds previousTime if it corresponds
- *
- * @param impressionsObserver impression observer. previous time (pt property) is included in impression instances
- * @param impressionsCounter cache to save impressions count. impressions will be deduped (OPTIMIZED mode)
- * @returns IStrategyResult
- */
-export declare function strategyOptimizedFactory(impressionsObserver: IImpressionObserver, impressionsCounter: IImpressionCountsCacheSync): IStrategy;

package/types/trackers/uniqueKeysTracker.d.ts

@@ -1,13 +0,0 @@
-import { ILogger } from '../logger/types';
-import { IUniqueKeysCacheBase } from '../storages/types';
-import { IFilterAdapter, IUniqueKeysTracker } from './types';
-/**
- * Trackes uniques keys
- * Unique Keys Tracker will be in charge of checking if the MTK was already sent to the BE in the last period
- *  or schedule to be sent; if not it will be added in an internal cache and sent in the next post.
- *
- * @param log Logger instance
- * @param filterAdapter filter adapter
- * @param uniqueKeysCache cache to save unique keys
- */
-export declare function uniqueKeysTrackerFactory(log: ILogger, uniqueKeysCache: IUniqueKeysCacheBase, filterAdapter?: IFilterAdapter): IUniqueKeysTracker;