@splitsoftware/splitio-commons 2.0.0-rc.3 → 2.0.0-rc.4

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

@@ -1,217 +0,0 @@
-import { IMetadata } from '../../dtos/types';
-import { SplitIO } from '../../types';
-import { ISyncTask } from '../types';
-export declare type ImpressionsPayload = {
-    /** Split name */
-    f: string;
-    /** Key Impressions */
-    i: {
-        /** User Key */
-        k: string;
-        /** Treatment */
-        t: string;
-        /** Timestamp */
-        m: number;
-        /** ChangeNumber */
-        c: number;
-        /** Rule label */
-        r?: string;
-        /** Bucketing Key */
-        b?: string;
-        /** Previous time */
-        pt?: number;
-    }[];
-}[];
-export declare type ImpressionCountsPayload = {
-    pf: {
-        /** Split name */
-        f: string;
-        /** Time Frame */
-        m: number;
-        /** Count */
-        rc: number;
-    }[];
-};
-export declare type UniqueKeysItemSs = {
-    /** Split name */
-    f: string;
-    /** keyNames */
-    ks: string[];
-};
-export declare type UniqueKeysPayloadSs = {
-    keys: UniqueKeysItemSs[];
-};
-export declare type UniqueKeysPayloadCs = {
-    keys: {
-        /** keyNames */
-        k: string;
-        /** Split name */
-        fs: string[];
-    }[];
-};
-export declare type StoredImpressionWithMetadata = {
-    /** Metadata */
-    m: IMetadata;
-    /** Stored impression */
-    i: {
-        /** keyName */
-        k: string;
-        /** bucketingKey */
-        b?: string;
-        /** Split name */
-        f: string;
-        /** treatment */
-        t: string;
-        /** label */
-        r: string;
-        /** changeNumber */
-        c: number;
-        /** time */
-        m: number;
-        /** previous time */
-        pt?: number;
-    };
-};
-export declare type StoredEventWithMetadata = {
-    /** Metadata */
-    m: IMetadata;
-    /** Stored event */
-    e: SplitIO.EventData;
-};
-export declare type MultiMethodLatencies = Map<string, MethodLatencies>;
-export declare type MultiMethodExceptions = Map<string, MethodExceptions>;
-export declare type MultiConfigs = Map<string, TelemetryConfigStats>;
-/**
- * Telemetry usage stats
- */
-export declare type QUEUED = 0;
-export declare type DROPPED = 1;
-export declare type DEDUPED = 2;
-export declare type ImpressionDataType = QUEUED | DROPPED | DEDUPED;
-export declare type EventDataType = QUEUED | DROPPED;
-export declare type UpdatesFromSSEEnum = SPLITS | MEMBERSHIPS;
-export declare type SPLITS = 'sp';
-export declare type IMPRESSIONS = 'im';
-export declare type IMPRESSIONS_COUNT = 'ic';
-export declare type EVENTS = 'ev';
-export declare type TELEMETRY = 'te';
-export declare type TOKEN = 'to';
-export declare type SEGMENT = 'se';
-export declare type MEMBERSHIPS = 'ms';
-export declare type OperationType = SPLITS | IMPRESSIONS | IMPRESSIONS_COUNT | EVENTS | TELEMETRY | TOKEN | SEGMENT | MEMBERSHIPS;
-export declare type LastSync = Partial<Record<OperationType, number | undefined>>;
-export declare type HttpErrors = Partial<Record<OperationType, {
-    [statusCode: string]: number;
-}>>;
-export declare type HttpLatencies = Partial<Record<OperationType, Array<number>>>;
-export declare type TREATMENT = 't';
-export declare type TREATMENTS = 'ts';
-export declare type TREATMENT_WITH_CONFIG = 'tc';
-export declare type TREATMENTS_WITH_CONFIG = 'tcs';
-export declare type TRACK = 'tr';
-export declare type TREATMENTS_BY_FLAGSET = 'tf';
-export declare type TREATMENTS_BY_FLAGSETS = 'tfs';
-export declare type TREATMENTS_WITH_CONFIG_BY_FLAGSET = 'tcf';
-export declare type TREATMENTS_WITH_CONFIG_BY_FLAGSETS = 'tcfs';
-export declare type Method = TREATMENT | TREATMENTS | TREATMENT_WITH_CONFIG | TREATMENTS_WITH_CONFIG | TRACK | TREATMENTS_BY_FLAGSET | TREATMENTS_BY_FLAGSETS | TREATMENTS_WITH_CONFIG_BY_FLAGSET | TREATMENTS_WITH_CONFIG_BY_FLAGSETS;
-export declare type MethodLatencies = Partial<Record<Method, Array<number>>>;
-export declare type MethodExceptions = Partial<Record<Method, number>>;
-export declare type CONNECTION_ESTABLISHED = 0;
-export declare type OCCUPANCY_PRI = 10;
-export declare type OCCUPANCY_SEC = 20;
-export declare type STREAMING_STATUS = 30;
-export declare type SSE_CONNECTION_ERROR = 40;
-export declare type TOKEN_REFRESH = 50;
-export declare type ABLY_ERROR = 60;
-export declare type SYNC_MODE_UPDATE = 70;
-export declare type StreamingEventType = CONNECTION_ESTABLISHED | OCCUPANCY_PRI | OCCUPANCY_SEC | STREAMING_STATUS | SSE_CONNECTION_ERROR | TOKEN_REFRESH | ABLY_ERROR | SYNC_MODE_UPDATE;
-export declare type StreamingEvent = {
-    e: StreamingEventType;
-    d?: number;
-    t: number;
-};
-export declare type TelemetryUsageStats = {
-    mL?: MethodLatencies;
-    mE?: MethodExceptions;
-};
-export declare type UpdatesFromSSE = {
-    sp?: number;
-    ms?: number;
-    mls?: number;
-};
-export declare type TelemetryUsageStatsPayload = TelemetryUsageStats & {
-    lS: LastSync;
-    hE: HttpErrors;
-    hL: HttpLatencies;
-    tR: number;
-    aR: number;
-    iQ: number;
-    iDe: number;
-    iDr: number;
-    spC?: number;
-    seC?: number;
-    skC?: number;
-    lsC?: number;
-    lskC?: number;
-    sL?: number;
-    eQ: number;
-    eD: number;
-    sE: Array<StreamingEvent>;
-    t?: Array<string>;
-    ufs?: UpdatesFromSSE;
-};
-/**
- * Telemetry config stats
- */
-export declare type STANDALONE_ENUM = 0;
-export declare type CONSUMER_ENUM = 1;
-export declare type CONSUMER_PARTIAL_ENUM = 2;
-export declare type OperationMode = STANDALONE_ENUM | CONSUMER_ENUM | CONSUMER_PARTIAL_ENUM;
-export declare type OPTIMIZED_ENUM = 0;
-export declare type DEBUG_ENUM = 1;
-export declare type NONE_ENUM = 2;
-export declare type ImpressionsMode = OPTIMIZED_ENUM | DEBUG_ENUM | NONE_ENUM;
-export declare type RefreshRates = {
-    sp: number;
-    se?: number;
-    ms?: number;
-    im: number;
-    ev: number;
-    te: number;
-};
-export declare type UrlOverrides = {
-    s: boolean;
-    e: boolean;
-    a: boolean;
-    st: boolean;
-    t: boolean;
-};
-export declare type TelemetryConfigStats = {
-    oM: OperationMode;
-    st: 'memory' | 'redis' | 'pluggable' | 'localstorage';
-    aF: number;
-    rF: number;
-    t?: Array<string>;
-};
-export declare type TelemetryConfigStatsPayload = TelemetryConfigStats & {
-    sE: boolean;
-    rR: RefreshRates;
-    uO: UrlOverrides;
-    iQ: number;
-    eQ: number;
-    iM: ImpressionsMode;
-    iL: boolean;
-    hP: boolean;
-    tR: number;
-    tC?: number;
-    nR: number;
-    i?: Array<string>;
-    uC: number;
-    fsT: number;
-    fsI: number;
-};
-export interface ISubmitterManager extends ISyncTask {
-    start(onlyTelemetry?: boolean): void;
-    stop(allExceptTelemetry?: boolean): void;
-    execute(onlyTelemetry?: boolean): Promise<any>;
-}

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

@@ -1,13 +0,0 @@
-import { ISyncManagerCS } from './types';
-import { IPushManager } from './streaming/types';
-import { IPollingManager } from './polling/types';
-import { ISdkFactoryContextSync } from '../sdkFactory/types';
-/**
- * Online SyncManager factory.
- * Can be used for server-side API, and client-side API with or without multiple clients.
- *
- * @param pollingManagerFactory allows to specialize the SyncManager for server-side or client-side API by passing
- * `pollingManagerSSFactory` or `pollingManagerCSFactory` respectively.
- * @param pushManagerFactory optional to build a SyncManager with or without streaming support
- */
-export declare function syncManagerOnlineFactory(pollingManagerFactory?: (params: ISdkFactoryContextSync) => IPollingManager, pushManagerFactory?: (params: ISdkFactoryContextSync, pollingManager: IPollingManager) => IPushManager | undefined): (params: ISdkFactoryContextSync) => ISyncManagerCS;

package/types/sync/syncTask.d.ts

@@ -1,13 +0,0 @@
-import { ILogger } from '../logger/types';
-import { ISyncTask } from './types';
-/**
- * Creates an object that handles the periodic execution of a given task via "start" and "stop" methods.
- * The task can be also executed by calling the "execute" method. Multiple calls run sequentially to avoid race conditions (e.g., submitters executed on SDK destroy or full queue, while periodic execution is pending).
- *
- * @param log  Logger instance.
- * @param task  Task to execute that returns a promise that NEVER REJECTS. Otherwise, periodic execution can result in Unhandled Promise Rejections.
- * @param period  Period in milliseconds to execute the task.
- * @param taskName  Optional task name for logging.
- * @returns A sync task that wraps the given task.
- */
-export declare function syncTaskFactory<Input extends any[], Output = any>(log: ILogger, task: (...args: Input) => Promise<Output>, period: number, taskName?: string): ISyncTask<Input, Output>;

package/types/sync/types.d.ts

@@ -1,43 +0,0 @@
-import { IReadinessManager } from '../readiness/types';
-import { IStorageSync } from '../storages/types';
-import { IPollingManager } from './polling/types';
-import { IPushManager } from './streaming/types';
-import { ISubmitterManager } from './submitters/types';
-export interface ITask<Input extends any[] = []> {
-    /**
-     * Start periodic execution of the task
-     */
-    start(...args: Input): any;
-    /**
-     * Stop periodic execution of the task
-     */
-    stop(): any;
-    /**
-     * Returns true if the task periodic execution is running
-     */
-    isRunning(): boolean;
-}
-export interface ISyncTask<Input extends any[] = [], Output = any> extends ITask<Input> {
-    /**
-     * Start periodic execution of the task, and returns the promise of the first execution
-     */
-    start(...args: Input): Promise<Output> | void;
-    /**
-     * Explicitly executes the task. It can be invoked multiple times. Returns a promise when the task is resolved
-     */
-    execute(...args: Input): Promise<Output>;
-    /**
-     * Returns true if the task is being executed
-     */
-    isExecuting(): boolean;
-}
-/** SyncManager */
-export interface ISyncManager extends ITask {
-    flush(): Promise<any>;
-    pushManager?: IPushManager;
-    pollingManager?: IPollingManager;
-    submitterManager?: ISubmitterManager;
-}
-export interface ISyncManagerCS extends ISyncManager {
-    shared(matchingKey: string, readinessManager: IReadinessManager, storage: IStorageSync): Pick<ISyncManager, 'stop' | 'flush'> | undefined;
-}

package/types/trackers/eventTracker.d.ts

@@ -1,10 +0,0 @@
-import { IEventsCacheBase, ITelemetryCacheAsync, ITelemetryCacheSync } from '../storages/types';
-import { IEventsHandler, IEventTracker } from './types';
-import { ISettings } from '../types';
-/**
- * Event tracker stores events in cache and pass them to the integrations manager if provided.
- *
- * @param eventsCache cache to save events
- * @param integrationsManager optional event handler used for integrations
- */
-export declare function eventTrackerFactory(settings: ISettings, eventsCache: IEventsCacheBase, whenInit: (cb: () => void) => void, integrationsManager?: IEventsHandler, telemetryCache?: ITelemetryCacheSync | ITelemetryCacheAsync): IEventTracker;

package/types/trackers/impressionObserver/ImpressionObserver.d.ts

@@ -1,8 +0,0 @@
-import { ImpressionDTO } from '../../types';
-import { IImpressionObserver } from './types';
-export declare class ImpressionObserver<K extends string | number = string> implements IImpressionObserver {
-    private cache;
-    private hasher;
-    constructor(size: number, hasher: (impression: ImpressionDTO) => K);
-    testAndSet(impression: ImpressionDTO): number | undefined;
-}

package/types/trackers/impressionObserver/buildKey.d.ts

@@ -1,2 +0,0 @@
-import { ImpressionDTO } from '../../types';
-export declare function buildKey(impression: ImpressionDTO): string;

package/types/trackers/impressionObserver/impressionObserverCS.d.ts

@@ -1,4 +0,0 @@
-import { ImpressionObserver } from './ImpressionObserver';
-import { ImpressionDTO } from '../../types';
-export declare function hashImpression32(impression: ImpressionDTO): number;
-export declare function impressionObserverCSFactory(): ImpressionObserver<number>;

package/types/trackers/impressionObserver/impressionObserverSS.d.ts

@@ -1,4 +0,0 @@
-import { ImpressionObserver } from './ImpressionObserver';
-import { ImpressionDTO } from '../../types';
-export declare function hashImpression128(impression: ImpressionDTO): string;
-export declare function impressionObserverSSFactory(): ImpressionObserver<string>;

package/types/trackers/impressionObserver/types.d.ts

@@ -1,4 +0,0 @@
-import { ImpressionDTO } from '../../types';
-export interface IImpressionObserver {
-    testAndSet(impression: ImpressionDTO): number | undefined;
-}

package/types/trackers/impressionsTracker.d.ts

@@ -1,13 +0,0 @@
-import { IImpressionsCacheBase, ITelemetryCacheSync, ITelemetryCacheAsync } from '../storages/types';
-import { IImpressionsHandler, IImpressionsTracker, IStrategy } from './types';
-import { ISettings } from '../types';
-/**
- * Impressions tracker stores impressions in cache and pass them to the listener and integrations manager if provided.
- *
- * @param impressionsCache cache to save impressions
- * @param metadata runtime metadata (ip, hostname and version)
- * @param impressionListener optional impression listener
- * @param integrationsManager optional integrations manager
- * @param strategy strategy for impressions tracking.
- */
-export declare function impressionsTrackerFactory(settings: ISettings, impressionsCache: IImpressionsCacheBase, strategy: IStrategy, whenInit: (cb: () => void) => void, integrationsManager?: IImpressionsHandler, telemetryCache?: ITelemetryCacheSync | ITelemetryCacheAsync): IImpressionsTracker;

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 { IImpressionCountsCacheBase } 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: IImpressionCountsCacheBase, uniqueKeysTracker: IUniqueKeysTracker): IStrategy;

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

@@ -1,11 +0,0 @@
-import { IImpressionCountsCacheBase } 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: IImpressionCountsCacheBase): IStrategy;

package/types/trackers/telemetryTracker.d.ts

@@ -1,3 +0,0 @@
-import { ITelemetryCacheSync, ITelemetryCacheAsync } from '../storages/types';
-import { ITelemetryTracker } from './types';
-export declare function telemetryTrackerFactory(telemetryCache?: ITelemetryCacheSync | ITelemetryCacheAsync, now?: () => number): ITelemetryTracker;

package/types/trackers/types.d.ts

@@ -1,68 +0,0 @@
-import { SplitIO, ImpressionDTO } from '../types';
-import { StreamingEventType, Method, OperationType, UpdatesFromSSEEnum } from '../sync/submitters/types';
-import { IEventsCacheBase } from '../storages/types';
-import { NetworkError } from '../services/types';
-/** Events tracker */
-export interface IEventsHandler {
-    handleEvent(eventData: SplitIO.EventData): any;
-}
-export declare type IEventTracker = IEventsCacheBase;
-/** Impressions tracker */
-export interface IImpressionsHandler {
-    handleImpression(impressionData: SplitIO.ImpressionData): any;
-}
-export interface IImpressionsTracker {
-    track(impressions: ImpressionDTO[], attributes?: SplitIO.Attributes): void;
-}
-/** Telemetry tracker */
-export declare type AUTH_REJECTION = 80;
-export interface ITelemetryTracker {
-    /**
-     * Creates a telemetry evaluator tracker, to record Latencies, Exceptions and NonReadyUsage of client operations (getTreatments and track method calls)
-     */
-    trackEval(method: Method): (label?: string) => void;
-    /**
-     * Creates a telemetry runtime tracker, to record Latencies and Exceptions of HTTP requests
-     */
-    trackHttp(method: OperationType): (error?: NetworkError) => void;
-    /**
-     * Records session length
-     */
-    sessionLength(): void;
-    /**
-     * Records streaming event
-     */
-    streamingEvent(e: StreamingEventType | AUTH_REJECTION, d?: number): void;
-    /**
-     * Records tag
-     */
-    addTag(tag: string): void;
-    /**
-     * Records updates from sse
-     */
-    trackUpdatesFromSSE(type: UpdatesFromSSEEnum): void;
-}
-export interface IFilterAdapter {
-    add(key: string, featureName: string): boolean;
-    contains(key: string, featureName: string): boolean;
-    clear(): void;
-    refreshRate?: number;
-}
-export interface IImpressionSenderAdapter {
-    recordUniqueKeys(data: Object): void;
-    recordImpressionCounts(data: Object): void;
-}
-/** Unique keys tracker */
-export interface IUniqueKeysTracker {
-    start(): void;
-    stop(): void;
-    track(key: string, featureName: string): void;
-}
-export interface IStrategyResult {
-    impressionsToStore: ImpressionDTO[];
-    impressionsToListener: ImpressionDTO[];
-    deduped: number;
-}
-export interface IStrategy {
-    process(impressions: ImpressionDTO[]): IStrategyResult;
-}

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 uniqueKeysCache cache to save unique keys
- * @param filterAdapter filter adapter
- */
-export declare function uniqueKeysTrackerFactory(log: ILogger, uniqueKeysCache: IUniqueKeysCacheBase, filterAdapter?: IFilterAdapter): IUniqueKeysTracker;