@splitsoftware/splitio-commons 1.6.2-rc.1 → 1.6.2-rc.4

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

@@ -1,30 +0,0 @@
-import { IImpressionsCacheSync } from '../types';
-import { ImpressionDTO } from '../../types';
-export declare class ImpressionsCacheInMemory implements IImpressionsCacheSync {
-    private onFullQueue?;
-    private readonly maxQueue;
-    private queue;
-    /**
-     *
-     * @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(impressionsQueueSize?: number);
-    setOnFullQueueCb(cb: () => void): void;
-    /**
-     * Store impressions in sequential order
-     */
-    track(data: ImpressionDTO[]): void;
-    /**
-     * Clear the data stored on the cache.
-     */
-    clear(): void;
-    /**
-     * Pop the collected data, used as payload for posting.
-     */
-    pop(toMerge?: ImpressionDTO[]): ImpressionDTO[];
-    /**
-     * Check if the cache is empty.
-     */
-    isEmpty(): boolean;
-}

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

@@ -1,10 +0,0 @@
-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/inMemory/InMemoryStorageCS.d.ts

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

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/MySegmentsCacheInMemory.d.ts

@@ -1,22 +0,0 @@
-import { AbstractSegmentsCacheSync } from '../AbstractSegmentsCacheSync';
-/**
- * Default MySegmentsCacheInMemory implementation that stores MySegments in memory.
- * Supported by all JS runtimes.
- */
-export declare class MySegmentsCacheInMemory extends AbstractSegmentsCacheSync {
-    private segmentCache;
-    clear(): void;
-    addToSegment(name: string): boolean;
-    removeFromSegment(name: string): boolean;
-    isInSegment(name: string): boolean;
-    /**
-     * Reset (update) the cached list of segments with the given list, removing and adding segments if necessary.
-     * @NOTE based on the way we use segments in the browser, this way is the best option
-     *
-     * @param {string[]} names list of segment names
-     * @returns boolean indicating if the cache was updated (i.e., given list was different from the cached one)
-     */
-    resetSegments(names: string[]): boolean;
-    getRegisteredSegments(): string[];
-    getKeysCount(): number;
-}

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

@@ -1,19 +0,0 @@
-import { AbstractSegmentsCacheSync } from '../AbstractSegmentsCacheSync';
-/**
- * Default ISplitsCacheSync implementation that stores split definitions in memory.
- * Supported by all JS runtimes.
- */
-export declare class SegmentsCacheInMemory extends AbstractSegmentsCacheSync {
-    private segmentCache;
-    private segmentChangeNumber;
-    addToSegment(name: string, segmentKeys: string[]): boolean;
-    removeFromSegment(name: string, segmentKeys: string[]): boolean;
-    isInSegment(name: string, key: string): boolean;
-    clear(): void;
-    private _registerSegment;
-    registerSegments(names: string[]): boolean;
-    getRegisteredSegments(): string[];
-    getKeysCount(): number;
-    setChangeNumber(name: string, changeNumber: number): boolean;
-    getChangeNumber(name: string): number;
-}

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

@@ -1,20 +0,0 @@
-import { AbstractSplitsCacheSync } from '../AbstractSplitsCacheSync';
-/**
- * Default ISplitsCacheSync implementation that stores split definitions in memory.
- * Supported by all JS runtimes.
- */
-export declare class SplitsCacheInMemory extends AbstractSplitsCacheSync {
-    private splitsCache;
-    private ttCache;
-    private changeNumber;
-    private splitsWithSegmentsCount;
-    clear(): void;
-    addSplit(name: string, split: string): boolean;
-    removeSplit(name: string): boolean;
-    getSplit(name: string): string | null;
-    setChangeNumber(changeNumber: number): boolean;
-    getChangeNumber(): number;
-    getSplitNames(): string[];
-    trafficTypeExists(trafficType: string): boolean;
-    usesSegments(): boolean;
-}

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

@@ -1,53 +0,0 @@
-import { ImpressionDataType, EventDataType, LastSync, HttpErrors, HttpLatencies, StreamingEvent, Method, OperationType, MethodExceptions, MethodLatencies } from '../../sync/submitters/types';
-import { ITelemetryCacheSync } from '../types';
-/**
- * Used on client-side. 0.1% of instances will track telemetry
- */
-export declare function shouldRecordTelemetry(): boolean;
-export declare class TelemetryCacheInMemory implements ITelemetryCacheSync {
-    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(): LastSync;
-    recordSuccessfulSync(resource: OperationType, timeMs: number): void;
-    private httpErrors;
-    popHttpErrors(): HttpErrors;
-    recordHttpError(resource: OperationType, status: number): void;
-    private httpLatencies;
-    popHttpLatencies(): HttpLatencies;
-    recordHttpLatency(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(): MethodExceptions;
-    recordException(method: Method): void;
-    private latencies;
-    popLatencies(): MethodLatencies;
-    recordLatency(method: Method, latencyMs: number): void;
-}

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/EventsCacheInRedis.d.ts

@@ -1,32 +0,0 @@
-import { IEventsCacheAsync } from '../types';
-import { IMetadata } from '../../dtos/types';
-import { Redis } from 'ioredis';
-import { SplitIO } from '../../types';
-import { ILogger } from '../../logger/types';
-import { StoredEventWithMetadata } from '../../sync/submitters/types';
-export declare class EventsCacheInRedis implements IEventsCacheAsync {
-    private readonly log;
-    private readonly key;
-    private readonly redis;
-    private readonly metadata;
-    constructor(log: ILogger, key: string, redis: Redis, metadata: IMetadata);
-    /**
-     * Add a new event object into the queue.
-     * Unlike `impressions::track`, result promise is never rejected.
-     */
-    track(eventData: SplitIO.EventData): Promise<boolean>;
-    /**
-     * Generates the JSON as we'll store it on Redis.
-     */
-    private _toJSON;
-    count(): Promise<number>;
-    drop(count?: number): Promise<any>;
-    /**
-     * Pop the given number of events from the storage.
-     * The returned promise rejects if the wrapper operation fails.
-     *
-     * NOTE: this method doesn't take into account MAX_EVENT_SIZE or MAX_QUEUE_BYTE_SIZE limits.
-     * It is the submitter responsability to handle that.
-     */
-    popNWithMetadata(count: number): Promise<StoredEventWithMetadata[]>;
-}

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

@@ -1,18 +0,0 @@
-import { IImpressionsCacheAsync } from '../types';
-import { IMetadata } from '../../dtos/types';
-import { ImpressionDTO } from '../../types';
-import { Redis } from 'ioredis';
-import { StoredImpressionWithMetadata } from '../../sync/submitters/types';
-import { ILogger } from '../../logger/types';
-export declare class ImpressionsCacheInRedis implements IImpressionsCacheAsync {
-    private readonly log;
-    private readonly key;
-    private readonly redis;
-    private readonly metadata;
-    constructor(log: ILogger, key: string, redis: Redis, metadata: IMetadata);
-    track(impressions: ImpressionDTO[]): Promise<void>;
-    private _toJSON;
-    count(): Promise<number>;
-    drop(count?: number): Promise<any>;
-    popNWithMetadata(count: number): Promise<StoredImpressionWithMetadata[]>;
-}

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/storages/inRedis/RedisAdapter.d.ts

@@ -1,24 +0,0 @@
-import ioredis from 'ioredis';
-import { ILogger } from '../../logger/types';
-/**
- * Redis adapter on top of the library of choice (written with ioredis) for some extra control.
- */
-export declare class RedisAdapter extends ioredis {
-    private readonly log;
-    private _options;
-    private _notReadyCommandsQueue?;
-    private _runningCommands;
-    constructor(log: ILogger, storageSettings: Record<string, any>);
-    _listenToEvents(): void;
-    _setTimeoutWrappers(): void;
-    _setDisconnectWrapper(): void;
-    /**
-     * Receives the options and returns an array of parameters for the ioredis constructor.
-     * Keeping both redis setup options for backwards compatibility.
-     */
-    static _defineLibrarySettings(options: Record<string, any>): any[];
-    /**
-     * Parses the options into what we care about.
-     */
-    static _defineOptions({ connectionTimeout, operationTimeout, url, host, port, db, pass, tls }: Record<string, any>): object;
-}

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

@@ -1,18 +0,0 @@
-import { Redis } from 'ioredis';
-import { ILogger } from '../../logger/types';
-import { KeyBuilderSS } from '../KeyBuilderSS';
-import { ISegmentsCacheAsync } from '../types';
-export declare class SegmentsCacheInRedis implements ISegmentsCacheAsync {
-    private readonly log;
-    private readonly redis;
-    private readonly keys;
-    constructor(log: ILogger, keys: KeyBuilderSS, redis: Redis);
-    addToSegment(name: string, segmentKeys: string[]): Promise<boolean>;
-    removeFromSegment(name: string, segmentKeys: string[]): Promise<boolean>;
-    isInSegment(name: string, key: string): Promise<boolean>;
-    setChangeNumber(name: string, changeNumber: number): Promise<boolean>;
-    getChangeNumber(name: string): Promise<number>;
-    registerSegments(segments: string[]): Promise<boolean>;
-    getRegisteredSegments(): Promise<string[]>;
-    clear(): Promise<boolean>;
-}

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

@@ -1,91 +0,0 @@
-import { KeyBuilderSS } from '../KeyBuilderSS';
-import { Redis } from 'ioredis';
-import { ILogger } from '../../logger/types';
-import { AbstractSplitsCacheAsync } from '../AbstractSplitsCacheAsync';
-/**
- * ISplitsCacheAsync implementation that stores split definitions in Redis.
- * Supported by Node.
- */
-export declare class SplitsCacheInRedis extends AbstractSplitsCacheAsync {
-    private readonly log;
-    private readonly redis;
-    private readonly keys;
-    private redisError?;
-    constructor(log: ILogger, keys: KeyBuilderSS, redis: Redis);
-    private _decrementCounts;
-    private _incrementCounts;
-    /**
-     * Add a given split.
-     * The returned promise is resolved when the operation success
-     * or rejected if it fails (e.g., redis operation fails)
-     */
-    addSplit(name: string, split: string): Promise<boolean>;
-    /**
-     * Add a list of splits.
-     * The returned promise is resolved when the operation success
-     * or rejected if it fails (e.g., redis operation fails)
-     */
-    addSplits(entries: [string, string][]): Promise<boolean[]>;
-    /**
-     * Remove a given split.
-     * The returned promise is resolved when the operation success, with 1 or 0 indicating if the split existed or not.
-     * or rejected if it fails (e.g., redis operation fails).
-     */
-    removeSplit(name: string): Promise<number>;
-    /**
-     * Remove a list of splits.
-     * The returned promise is resolved when the operation success,
-     * or rejected if it fails (e.g., redis operation fails).
-     */
-    removeSplits(names: string[]): Promise<any>;
-    /**
-     * Get split definition or null if it's not defined.
-     * Returned promise is rejected if redis operation fails.
-     */
-    getSplit(name: string): Promise<string | null>;
-    /**
-     * Set till number.
-     * The returned promise is resolved when the operation success,
-     * or rejected if it fails.
-     */
-    setChangeNumber(changeNumber: number): Promise<boolean>;
-    /**
-     * Get till number or -1 if it's not defined.
-     * The returned promise is resolved with the changeNumber or -1 if it doesn't exist or a redis operation fails.
-     * The promise will never be rejected.
-     */
-    getChangeNumber(): Promise<number>;
-    /**
-     * Get list of all split definitions.
-     * The returned promise is resolved with the list of split definitions,
-     * or rejected if redis operation fails.
-     *
-     * @TODO we need to benchmark which is the maximun number of commands we could
-     *       pipeline without kill redis performance.
-     */
-    getAll(): Promise<string[]>;
-    /**
-     * Get list of split names.
-     * The returned promise is resolved with the list of split names,
-     * or rejected if redis operation fails.
-     */
-    getSplitNames(): Promise<string[]>;
-    /**
-     * Check traffic type existence.
-     * The returned promise is resolved with a boolean indicating whether the TT exist or not.
-     * In case of redis operation failure, the promise resolves with a true value, assuming that the TT might exist.
-     * It will never be rejected.
-     */
-    trafficTypeExists(trafficType: string): Promise<boolean>;
-    /**
-     * Delete everything in the current database.
-     *
-     * @NOTE documentation says it never fails.
-     */
-    clear(): Promise<boolean>;
-    /**
-     * Fetches multiple splits definitions.
-     * Returned promise is rejected if redis operation fails.
-     */
-    getSplits(names: string[]): Promise<Record<string, string | null>>;
-}

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

@@ -1,20 +0,0 @@
-import { ILogger } from '../../logger/types';
-import { Method } from '../../sync/submitters/types';
-import { KeyBuilderSS } from '../KeyBuilderSS';
-import { ITelemetryCacheAsync } from '../types';
-import { Redis } from 'ioredis';
-export declare class TelemetryCacheInRedis implements ITelemetryCacheAsync {
-    private readonly log;
-    private readonly keys;
-    private readonly redis;
-    /**
-     * Create a Telemetry cache that uses Redis as storage.
-     * @param log  Logger instance.
-     * @param keys  Key builder.
-     * @param redis  Redis client.
-     */
-    constructor(log: ILogger, keys: KeyBuilderSS, redis: Redis);
-    recordLatency(method: Method, latencyMs: number): Promise<number | void>;
-    recordException(method: Method): Promise<number | void>;
-    recordConfig(): Promise<number | void>;
-}

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

@@ -1 +0,0 @@
-export declare const LOG_PREFIX = "storage:redis: ";

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

@@ -1,10 +0,0 @@
-import { IStorageAsyncFactory } from '../types';
-export interface InRedisStorageOptions {
-    prefix?: string;
-    options?: Record<string, any>;
-}
-/**
- * InRedis storage factory for consumer server-side SplitFactory, that uses `Ioredis` Redis client for Node.
- * @see {@link https://www.npmjs.com/package/ioredis}
- */
-export declare function InRedisStorage(options?: InRedisStorageOptions): IStorageAsyncFactory;

package/types/storages/metadataBuilder.d.ts

@@ -1,3 +0,0 @@
-import { IMetadata } from '../dtos/types';
-import { ISettings } from '../types';
-export declare function metadataBuilder(settings: Pick<ISettings, 'version' | 'runtime'>): IMetadata;

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

@@ -1,38 +0,0 @@
-import { IPluggableStorageWrapper, IEventsCacheAsync } from '../types';
-import { IMetadata } from '../../dtos/types';
-import { SplitIO } from '../../types';
-import { ILogger } from '../../logger/types';
-import { StoredEventWithMetadata } from '../../sync/submitters/types';
-export declare class EventsCachePluggable implements IEventsCacheAsync {
-    private readonly log;
-    private readonly wrapper;
-    private readonly key;
-    private readonly metadata;
-    constructor(log: ILogger, key: string, wrapper: IPluggableStorageWrapper, metadata: IMetadata);
-    /**
-     * Push given event to the storage.
-     * @param eventData  Event item to push.
-     * @returns  A promise that is resolved with a boolean value indicating if the push operation succeeded or failed.
-     * Unlike `impressions::track`, The promise will never be rejected.
-     */
-    track(eventData: SplitIO.EventData): Promise<boolean>;
-    private _toJSON;
-    /**
-     * Returns a promise that resolves with the count of stored events, or 0 if there was some error.
-     * The promise will never be rejected.
-     */
-    count(): Promise<number>;
-    /**
-     * Removes the given number of events from the store. If a number is not provided, it deletes all items.
-     * The returned promise rejects if the wrapper operation fails.
-     */
-    drop(count?: number): Promise<any>;
-    /**
-     * Pop the given number of events from the storage.
-     * The returned promise rejects if the wrapper operation fails.
-     *
-     * NOTE: this method doesn't take into account MAX_EVENT_SIZE or MAX_QUEUE_BYTE_SIZE limits.
-     * It is the submitter responsability to handle that.
-     */
-    popNWithMetadata(count: number): Promise<StoredEventWithMetadata[]>;
-}

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

@@ -1,35 +0,0 @@
-import { IPluggableStorageWrapper, IImpressionsCacheAsync } from '../types';
-import { IMetadata } from '../../dtos/types';
-import { ImpressionDTO } from '../../types';
-import { ILogger } from '../../logger/types';
-import { StoredImpressionWithMetadata } from '../../sync/submitters/types';
-export declare class ImpressionsCachePluggable implements IImpressionsCacheAsync {
-    private readonly log;
-    private readonly key;
-    private readonly wrapper;
-    private readonly metadata;
-    constructor(log: ILogger, key: string, wrapper: IPluggableStorageWrapper, metadata: IMetadata);
-    /**
-     * Push given impressions to the storage.
-     * @param impressions  List of impresions to push.
-     * @returns  A promise that is resolved if the push operation succeeded
-     * or rejected if the wrapper operation fails.
-     */
-    track(impressions: ImpressionDTO[]): Promise<void>;
-    private _toJSON;
-    /**
-     * Returns a promise that resolves with the count of stored impressions, or 0 if there was some error.
-     * The promise will never be rejected.
-     */
-    count(): Promise<number>;
-    /**
-     * Removes the given number of impressions from the store. If a number is not provided, it deletes all items.
-     * The returned promise rejects if the wrapper operation fails.
-     */
-    drop(count?: number): Promise<void>;
-    /**
-     * Pop the given number of impressions from the store.
-     * The returned promise rejects if the wrapper operation fails.
-     */
-    popNWithMetadata(count: number): Promise<StoredImpressionWithMetadata[]>;
-}

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

@@ -1,54 +0,0 @@
-import { KeyBuilderSS } from '../KeyBuilderSS';
-import { IPluggableStorageWrapper, ISegmentsCacheAsync } from '../types';
-import { ILogger } from '../../logger/types';
-/**
- * ISegmentsCacheAsync implementation for pluggable storages.
- */
-export declare class SegmentsCachePluggable implements ISegmentsCacheAsync {
-    private readonly log;
-    private readonly keys;
-    private readonly wrapper;
-    constructor(log: ILogger, keys: KeyBuilderSS, wrapper: IPluggableStorageWrapper);
-    /**
-     * Add a list of `segmentKeys` to the given segment `name`.
-     * The returned promise is resolved when the operation success
-     * or rejected if wrapper operation fails.
-     */
-    addToSegment(name: string, segmentKeys: string[]): Promise<boolean | void>;
-    /**
-     * Remove a list of `segmentKeys` from the given segment `name`.
-     * The returned promise is resolved when the operation success
-     * or rejected if wrapper operation fails.
-     */
-    removeFromSegment(name: string, segmentKeys: string[]): Promise<boolean | void>;
-    /**
-     * Returns a promise that resolves with a boolean value indicating if `key` is part of `name` segment.
-     * Promise can be rejected if wrapper operation fails.
-     */
-    isInSegment(name: string, key: string): Promise<boolean>;
-    /**
-     * Set till number for the given segment `name`.
-     * The returned promise is resolved when the operation success,
-     * or rejected if it fails (e.g., wrapper operation fails).
-     */
-    setChangeNumber(name: string, changeNumber: number): Promise<boolean | void>;
-    /**
-     * Get till number or -1 if it's not defined.
-     * The returned promise is resolved with the changeNumber or -1 if it doesn't exist or a wrapper operation fails.
-     * The promise will never be rejected.
-     */
-    getChangeNumber(name: string): Promise<number>;
-    /**
-     * Add the given segment names to the set of registered segments.
-     * The returned promise is resolved when the operation success,
-     * or rejected if it fails (e.g., wrapper operation fails).
-     */
-    registerSegments(segments: string[]): Promise<boolean | void>;
-    /**
-     * Returns a promise that resolves with the set of registered segments in a list,
-     * or rejected if it fails (e.g., wrapper operation fails).
-     */
-    getRegisteredSegments(): Promise<string[]>;
-    /** @TODO implement if required by DataLoader or Producer mode  */
-    clear(): Promise<boolean>;
-}