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

package/types/readiness/types.d.ts

@@ -1,67 +0,0 @@
-import { IEventEmitter, IStatusInterface } from '../types';
-/** Splits data emitter */
-declare type SDK_SPLITS_ARRIVED = 'state::splits-arrived';
-declare type SDK_SPLITS_CACHE_LOADED = 'state::splits-cache-loaded';
-declare type ISplitsEvent = SDK_SPLITS_ARRIVED | SDK_SPLITS_CACHE_LOADED;
-export interface ISplitsEventEmitter extends IEventEmitter {
-    emit(event: ISplitsEvent, ...args: any[]): boolean;
-    on(event: ISplitsEvent, listener: (...args: any[]) => void): this;
-    once(event: ISplitsEvent, listener: (...args: any[]) => void): this;
-    splitsArrived: boolean;
-    splitsCacheLoaded: boolean;
-    initialized: boolean;
-    initCallbacks: (() => void)[];
-}
-/** Segments data emitter */
-declare type SDK_SEGMENTS_ARRIVED = 'state::segments-arrived';
-declare type ISegmentsEvent = SDK_SEGMENTS_ARRIVED;
-export interface ISegmentsEventEmitter extends IEventEmitter {
-    emit(event: ISegmentsEvent, ...args: any[]): boolean;
-    on(event: ISegmentsEvent, listener: (...args: any[]) => void): this;
-    once(event: ISegmentsEvent, listener: (...args: any[]) => void): this;
-    segmentsArrived: boolean;
-}
-/** Readiness emitter */
-export declare type SDK_READY_TIMED_OUT = 'init::timeout';
-export declare type SDK_READY = 'init::ready';
-export declare type SDK_READY_FROM_CACHE = 'init::cache-ready';
-export declare type SDK_UPDATE = 'state::update';
-export declare type SDK_DESTROY = 'state::destroy';
-export declare type IReadinessEvent = SDK_READY_TIMED_OUT | SDK_READY | SDK_READY_FROM_CACHE | SDK_UPDATE | SDK_DESTROY;
-export interface IReadinessEventEmitter extends IEventEmitter {
-    emit(event: IReadinessEvent, ...args: any[]): boolean;
-}
-/** Readiness manager */
-export interface IReadinessManager {
-    /** Event emitters */
-    splits: ISplitsEventEmitter;
-    segments: ISegmentsEventEmitter;
-    gate: IReadinessEventEmitter;
-    /** Readiness status */
-    isReady(): boolean;
-    isReadyFromCache(): boolean;
-    isTimedout(): boolean;
-    hasTimedout(): boolean;
-    isDestroyed(): boolean;
-    isOperational(): boolean;
-    lastUpdate(): number;
-    timeout(): void;
-    setDestroyed(): void;
-    destroy(): void;
-    init(): void;
-    /** for client-side */
-    shared(): IReadinessManager;
-}
-/** SDK readiness manager */
-export interface ISdkReadinessManager {
-    readinessManager: IReadinessManager;
-    sdkStatus: IStatusInterface;
-    /**
-     * Increment internalReadyCbCount, an offset value of SDK_READY listeners that are added/removed internally
-     * by the SDK. It is required to properly log the warning 'No listeners for SDK Readiness detected'
-     */
-    incInternalReadyCbCount(): void;
-    /** for client-side */
-    shared(): ISdkReadinessManager;
-}
-export {};

package/types/sdkClient/client.d.ts

@@ -1,6 +0,0 @@
-import { SplitIO } from '../types';
-import { ISdkFactoryContext } from '../sdkFactory/types';
-/**
- * Creator of base client with getTreatments and track methods.
- */
-export declare function clientFactory(params: ISdkFactoryContext): SplitIO.IClient | SplitIO.IAsyncClient;

package/types/sdkClient/clientAttributesDecoration.d.ts

@@ -1,55 +0,0 @@
-import { SplitIO } from '../types';
-import { ILogger } from '../logger/types';
-/**
- * Add in memory attributes storage methods and combine them with any attribute received from the getTreatment/s call
- */
-export declare function clientAttributesDecoration<TClient extends SplitIO.IClient | SplitIO.IAsyncClient>(log: ILogger, client: TClient): TClient & {
-    getTreatment: (maybeKey: SplitIO.SplitKey, maybeFeatureFlagName: string, maybeAttributes?: SplitIO.Attributes | undefined) => string | SplitIO.AsyncTreatment;
-    getTreatmentWithConfig: (maybeKey: SplitIO.SplitKey, maybeFeatureFlagName: string, maybeAttributes?: SplitIO.Attributes | undefined) => SplitIO.TreatmentWithConfig | SplitIO.AsyncTreatmentWithConfig;
-    getTreatments: (maybeKey: SplitIO.SplitKey, maybeFeatureFlagNames: string[], maybeAttributes?: SplitIO.Attributes | undefined) => SplitIO.Treatments | SplitIO.AsyncTreatments;
-    getTreatmentsWithConfig: (maybeKey: SplitIO.SplitKey, maybeFeatureFlagNames: string[], maybeAttributes?: SplitIO.Attributes | undefined) => SplitIO.TreatmentsWithConfig | SplitIO.AsyncTreatmentsWithConfig;
-    getTreatmentsByFlagSets: (maybeKey: SplitIO.SplitKey, maybeFlagSets: string[], maybeAttributes?: SplitIO.Attributes | undefined) => SplitIO.Treatments | SplitIO.AsyncTreatments;
-    getTreatmentsWithConfigByFlagSets: (maybeKey: SplitIO.SplitKey, maybeFlagSets: string[], maybeAttributes?: SplitIO.Attributes | undefined) => SplitIO.TreatmentsWithConfig | SplitIO.AsyncTreatmentsWithConfig;
-    getTreatmentsByFlagSet: (maybeKey: SplitIO.SplitKey, maybeFlagSet: string, maybeAttributes?: SplitIO.Attributes | undefined) => SplitIO.Treatments | SplitIO.AsyncTreatments;
-    getTreatmentsWithConfigByFlagSet: (maybeKey: SplitIO.SplitKey, maybeFlagSet: string, maybeAttributes?: SplitIO.Attributes | undefined) => SplitIO.TreatmentsWithConfig | SplitIO.AsyncTreatmentsWithConfig;
-    track: (maybeKey: SplitIO.SplitKey, maybeTT: string, maybeEvent: string, maybeEventValue?: number | undefined, maybeProperties?: SplitIO.Properties | undefined) => boolean | Promise<boolean>;
-    /**
-     * Add an attribute to client's in memory attributes storage
-     *
-     * @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: SplitIO.AttributeType): boolean;
-    /**
-     * Returns the attribute with the given name
-     *
-     * @param {string} attributeName Attribute name
-     * @returns {Object} Attribute with the given name
-     */
-    getAttribute(attributeName: string): SplitIO.AttributeType;
-    /**
-     * Add to client's in memory attributes storage the attributes in 'attributes'
-     *
-     * @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
-     *
-     * @returns {Object} returns all the stored attributes
-     */
-    getAttributes(): Record<string, SplitIO.AttributeType>;
-    /**
-     * Removes from client's in memory attributes storage the attribute with the given name
-     *
-     * @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;
-};

package/types/sdkClient/clientCS.d.ts

@@ -1,9 +0,0 @@
-import { ILogger } from '../logger/types';
-import { SplitIO } from '../types';
-/**
- * Decorator that binds a key to client methods
- *
- * @param client sync client instance
- * @param key validated split key
- */
-export declare function clientCSDecorator(log: ILogger, client: SplitIO.IClient, key: SplitIO.SplitKey): SplitIO.ICsClient;

package/types/sdkClient/clientInputValidation.d.ts

@@ -1,7 +0,0 @@
-import { IReadinessManager } from '../readiness/types';
-import { ISettings, SplitIO } from '../types';
-/**
- * Decorator that validates the input before actually executing the client methods.
- * We should "guard" the client here, while not polluting the "real" implementation of those methods.
- */
-export declare function clientInputValidationDecorator<TClient extends SplitIO.IClient | SplitIO.IAsyncClient>(settings: ISettings, client: TClient, readinessManager: IReadinessManager): TClient;

package/types/sdkClient/identity.d.ts

@@ -1,2 +0,0 @@
-import { SplitIO } from '../types';
-export declare function buildInstanceId(key: SplitIO.SplitKey, trafficType?: string): string;

package/types/sdkClient/sdkClient.d.ts

@@ -1,6 +0,0 @@
-import { SplitIO } from '../types';
-import { ISdkFactoryContext } from '../sdkFactory/types';
-/**
- * Creates an Sdk client, i.e., a base client with status and destroy interface
- */
-export declare function sdkClientFactory(params: ISdkFactoryContext, isSharedClient?: boolean): SplitIO.IClient | SplitIO.IAsyncClient;

package/types/sdkClient/sdkClientMethod.d.ts

@@ -1,6 +0,0 @@
-import { SplitIO } from '../types';
-import { ISdkFactoryContext } from '../sdkFactory/types';
-/**
- * Factory of client method for server-side SDKs
- */
-export declare function sdkClientMethodFactory(params: ISdkFactoryContext): () => SplitIO.IClient | SplitIO.IAsyncClient;

package/types/sdkClient/sdkClientMethodCS.d.ts

@@ -1,7 +0,0 @@
-import { SplitIO } from '../types';
-import { ISdkFactoryContext } from '../sdkFactory/types';
-/**
- * Factory of client method for the client-side API variant where TT is ignored.
- * Therefore, clients don't have a bound TT for the track method.
- */
-export declare function sdkClientMethodCSFactory(params: ISdkFactoryContext): (key?: SplitIO.SplitKey) => SplitIO.ICsClient;

package/types/sdkClient/sdkClientMethodCSWithTT.d.ts

@@ -1,8 +0,0 @@
-import { SplitIO } from '../types';
-import { ISdkFactoryContext } from '../sdkFactory/types';
-/**
- * Factory of client method for the client-side (browser) variant of the Isomorphic JS SDK,
- * where clients can have a bound TT for the track method, which is provided via the settings
- * (default client) or the client method (shared clients).
- */
-export declare function sdkClientMethodCSFactory(params: ISdkFactoryContext): (key?: SplitIO.SplitKey, trafficType?: string) => SplitIO.ICsClient;

package/types/sdkFactory/index.d.ts

@@ -1,6 +0,0 @@
-import { ISdkFactoryParams } from './types';
-import { SplitIO } from '../types';
-/**
- * Modular SDK factory
- */
-export declare function sdkFactory(params: ISdkFactoryParams): SplitIO.ICsSDK | SplitIO.ISDK | SplitIO.IAsyncSDK;

package/types/sdkFactory/types.d.ts

@@ -1,85 +0,0 @@
-import { IIntegrationManager, IIntegrationFactoryParams } from '../integrations/types';
-import { ISignalListener } from '../listeners/types';
-import { IReadinessManager, ISdkReadinessManager } from '../readiness/types';
-import type { sdkManagerFactory } from '../sdkManager';
-import type { splitApiFactory } from '../services/splitApi';
-import { IFetch, ISplitApi, IEventSourceConstructor } from '../services/types';
-import { IStorageAsync, IStorageSync, IStorageFactoryParams } from '../storages/types';
-import { ISyncManager } from '../sync/types';
-import { IImpressionObserver } from '../trackers/impressionObserver/types';
-import { IImpressionsTracker, IEventTracker, ITelemetryTracker, IFilterAdapter, IUniqueKeysTracker } from '../trackers/types';
-import { SplitIO, ISettings, IEventEmitter, IBasicClient } from '../types';
-/**
- * Environment related dependencies.
- */
-export interface IPlatform {
-    /**
-     * If provided, it is used to retrieve the Fetch API for HTTP requests. Otherwise, the global fetch is used.
-     */
-    getFetch?: (settings: ISettings) => (IFetch | undefined);
-    /**
-     * If provided, it is used to pass additional options to fetch and eventsource calls.
-     */
-    getOptions?: (settings: ISettings) => object;
-    /**
-     * If provided, it is used to retrieve the EventSource constructor for streaming support.
-     */
-    getEventSource?: (settings: ISettings) => (IEventSourceConstructor | undefined);
-    /**
-     * EventEmitter constructor, like NodeJS.EventEmitter or a polyfill.
-     */
-    EventEmitter: new () => IEventEmitter;
-    /**
-     * Function used to track latencies for telemetry.
-     */
-    now?: () => number;
-}
-export interface ISdkFactoryContext {
-    platform: IPlatform;
-    sdkReadinessManager: ISdkReadinessManager;
-    readiness: IReadinessManager;
-    settings: ISettings;
-    impressionsTracker: IImpressionsTracker;
-    eventTracker: IEventTracker;
-    telemetryTracker: ITelemetryTracker;
-    storage: IStorageSync | IStorageAsync;
-    uniqueKeysTracker?: IUniqueKeysTracker;
-    signalListener?: ISignalListener;
-    splitApi?: ISplitApi;
-    syncManager?: ISyncManager;
-    clients: Record<string, IBasicClient>;
-}
-export interface ISdkFactoryContextSync extends ISdkFactoryContext {
-    storage: IStorageSync;
-    splitApi: ISplitApi;
-    syncManager: ISyncManager;
-}
-export interface ISdkFactoryContextAsync extends ISdkFactoryContext {
-    storage: IStorageAsync;
-    splitApi: undefined;
-    syncManager: undefined;
-}
-/**
- * Object parameter with the modules required to create an SDK factory instance
- */
-export interface ISdkFactoryParams {
-    lazyInit?: boolean;
-    settings: ISettings;
-    platform: IPlatform;
-    storageFactory: (params: IStorageFactoryParams) => IStorageSync | IStorageAsync;
-    splitApiFactory?: typeof splitApiFactory;
-    syncManagerFactory?: (params: ISdkFactoryContextSync) => ISyncManager;
-    sdkManagerFactory: typeof sdkManagerFactory;
-    sdkClientMethodFactory: (params: ISdkFactoryContext) => ({
-        (): SplitIO.ICsClient;
-        (key: SplitIO.SplitKey): SplitIO.ICsClient;
-    } | (() => SplitIO.IClient) | (() => SplitIO.IAsyncClient));
-    impressionsObserverFactory: () => IImpressionObserver;
-    filterAdapterFactory?: () => IFilterAdapter;
-    SignalListener?: new (syncManager: ISyncManager | undefined, // Used by NodeSignalListener to flush data, and by BrowserSignalListener to close streaming connection.
-    settings: ISettings, // Used by BrowserSignalListener
-    storage: IStorageSync | IStorageAsync, // Used by BrowserSignalListener
-    serviceApi: ISplitApi | undefined) => ISignalListener;
-    integrationsManagerFactory?: (params: IIntegrationFactoryParams) => IIntegrationManager | undefined;
-    extraProps?: (params: ISdkFactoryContext) => object;
-}

package/types/sdkManager/index.d.ts

@@ -1,4 +0,0 @@
-import { ISplitsCacheAsync, ISplitsCacheSync } from '../storages/types';
-import { ISdkReadinessManager } from '../readiness/types';
-import { ISettings, SplitIO } from '../types';
-export declare function sdkManagerFactory<TSplitCache extends ISplitsCacheSync | ISplitsCacheAsync>(settings: Pick<ISettings, 'log' | 'mode'>, splits: TSplitCache, { readinessManager, sdkStatus }: ISdkReadinessManager): TSplitCache extends ISplitsCacheAsync ? SplitIO.IAsyncManager : SplitIO.IManager;

package/types/services/decorateHeaders.d.ts

@@ -1,2 +0,0 @@
-import { ISettings } from '../types';
-export declare function decorateHeaders(settings: ISettings, headers: Record<string, string>): Record<string, string>;

package/types/services/splitApi.d.ts

@@ -1,12 +0,0 @@
-import { IPlatform } from '../sdkFactory/types';
-import { ISettings } from '../types';
-import { ISplitApi } from './types';
-import { ITelemetryTracker } from '../trackers/types';
-/**
- * Factory of SplitApi objects, which group the collection of Split HTTP endpoints used by the SDK
- *
- * @param settings validated settings object
- * @param platform object containing environment-specific dependencies
- * @param telemetryTracker telemetry tracker
- */
-export declare function splitApiFactory(settings: ISettings, platform: Pick<IPlatform, 'getOptions' | 'getFetch'>, telemetryTracker: ITelemetryTracker): ISplitApi;

package/types/services/splitHttpClient.d.ts

@@ -1,10 +0,0 @@
-import { ISplitHttpClient } from './types';
-import { ISettings } from '../types';
-import { IPlatform } from '../sdkFactory/types';
-/**
- * Factory of Split HTTP clients, which are HTTP clients with predefined headers for Split endpoints.
- *
- * @param settings SDK settings, used to access authorizationKey, logger instance and metadata (SDK version, ip and hostname) to set additional headers
- * @param platform object containing environment-specific dependencies
- */
-export declare function splitHttpClientFactory(settings: ISettings, { getOptions, getFetch }: Pick<IPlatform, 'getOptions' | 'getFetch'>): ISplitHttpClient;

package/types/services/types.d.ts

@@ -1,54 +0,0 @@
-export declare type IRequestOptions = {
-    method?: string;
-    headers?: Record<string, string>;
-    body?: string;
-};
-export declare type IResponse = {
-    ok: boolean;
-    status: number;
-    json: () => Promise<any>;
-    text: () => Promise<string>;
-};
-export declare type NetworkError = Error & {
-    statusCode?: number;
-};
-export declare type IFetch = (url: string, options?: IRequestOptions) => Promise<IResponse>;
-export declare type IHealthCheckAPI = () => Promise<boolean>;
-export declare type ISplitHttpClient = (url: string, options?: IRequestOptions, latencyTracker?: (error?: NetworkError) => void, logErrorsAsInfo?: boolean) => Promise<IResponse>;
-export declare type IFetchAuth = (userKeys?: string[]) => Promise<IResponse>;
-export declare type IFetchSplitChanges = (since: number, noCache?: boolean, till?: number) => Promise<IResponse>;
-export declare type IFetchSegmentChanges = (since: number, segmentName: string, noCache?: boolean, till?: number) => Promise<IResponse>;
-export declare type IFetchMemberships = (userMatchingKey: string, noCache?: boolean, till?: number) => Promise<IResponse>;
-export declare type IPostEventsBulk = (body: string, headers?: Record<string, string>) => Promise<IResponse>;
-export declare type IPostUniqueKeysBulkCs = (body: string, headers?: Record<string, string>) => Promise<IResponse>;
-export declare type IPostUniqueKeysBulkSs = (body: string, headers?: Record<string, string>) => Promise<IResponse>;
-export declare type IPostTestImpressionsBulk = (body: string, headers?: Record<string, string>) => Promise<IResponse>;
-export declare type IPostTestImpressionsCount = (body: string, headers?: Record<string, string>) => Promise<IResponse>;
-export declare type IPostMetricsConfig = (body: string, headers?: Record<string, string>) => Promise<IResponse>;
-export declare type IPostMetricsUsage = (body: string, headers?: Record<string, string>) => Promise<IResponse>;
-export interface ISplitApi {
-    getSdkAPIHealthCheck: IHealthCheckAPI;
-    getEventsAPIHealthCheck: IHealthCheckAPI;
-    fetchAuth: IFetchAuth;
-    fetchSplitChanges: IFetchSplitChanges;
-    fetchSegmentChanges: IFetchSegmentChanges;
-    fetchMemberships: IFetchMemberships;
-    postEventsBulk: IPostEventsBulk;
-    postUniqueKeysBulkCs: IPostUniqueKeysBulkCs;
-    postUniqueKeysBulkSs: IPostUniqueKeysBulkSs;
-    postTestImpressionsBulk: IPostTestImpressionsBulk;
-    postTestImpressionsCount: IPostTestImpressionsCount;
-    postMetricsConfig: IPostMetricsConfig;
-    postMetricsUsage: IPostMetricsUsage;
-}
-interface EventSourceEventMap {
-    'error': Event;
-    'message': MessageEvent;
-    'open': Event;
-}
-interface IEventSource {
-    addEventListener<K extends keyof EventSourceEventMap>(type: K, listener: (this: IEventSource, ev: EventSourceEventMap[K]) => any): void;
-    close(): void;
-}
-export declare type IEventSourceConstructor = new (url: string, eventSourceInitDict?: any) => IEventSource;
-export {};

package/types/storages/AbstractMySegmentsCacheSync.d.ts

@@ -1,39 +0,0 @@
-import { IMySegmentsResponse } from '../dtos/types';
-import { MySegmentsData } from '../sync/polling/types';
-import { ISegmentsCacheSync } from './types';
-/**
- * This class provides a skeletal implementation of the ISegmentsCacheSync interface
- * to minimize the effort required to implement this interface.
- */
-export declare abstract class AbstractMySegmentsCacheSync implements ISegmentsCacheSync {
-    protected abstract addSegment(name: string): boolean;
-    protected abstract removeSegment(name: string): boolean;
-    protected abstract setChangeNumber(changeNumber?: number): boolean | void;
-    /**
-     * For server-side synchronizer: check if `key` is in `name` segment.
-     * For client-side synchronizer: check if `name` segment is in the cache. `key` is undefined.
-     */
-    abstract isInSegment(name: string, key?: string): boolean;
-    /**
-     * clear the cache.
-     */
-    clear(): void;
-    registerSegments(): boolean;
-    update(): boolean;
-    /**
-     * For server-side synchronizer: get the list of segments to fetch changes.
-     * Also used for the `seC` (segment count) telemetry stat.
-     */
-    abstract getRegisteredSegments(): string[];
-    /**
-     * Only used for the `skC`(segment keys count) telemetry stat: 1 for client-side, and total count of keys in server-side.
-     * @TODO for client-side it should be the number of clients, but it requires a refactor of MySegments caches to simplify the code.
-     */
-    abstract getKeysCount(): number;
-    abstract getChangeNumber(name: string): number;
-    /**
-     * For server-side synchronizer: the method is not used.
-     * For client-side synchronizer: it resets or updates the cache.
-     */
-    resetSegments(segmentsData: MySegmentsData | IMySegmentsResponse): boolean;
-}

package/types/storages/AbstractSegmentsCacheSync.d.ts

@@ -1,54 +0,0 @@
-import { IMySegmentsResponse } from '../dtos/types';
-import { MySegmentsData } from '../sync/polling/types';
-import { ISegmentsCacheSync } from './types';
-/**
- * This class provides a skeletal implementation of the ISegmentsCacheSync interface
- * to minimize the effort required to implement this interface.
- */
-export declare abstract class AbstractSegmentsCacheSync implements ISegmentsCacheSync {
-    /**
-     * For server-side synchronizer: add `segmentKeys` list of keys to `name` segment.
-     * For client-side synchronizer: add `name` segment to the cache. `segmentKeys` is undefined.
-     */
-    abstract addToSegment(name: string, segmentKeys?: string[]): boolean;
-    /**
-     * For server-side synchronizer: remove `segmentKeys` list of keys from `name` segment.
-     * For client-side synchronizer: remove `name` segment from the cache. `segmentKeys` is undefined.
-     */
-    abstract removeFromSegment(name: string, segmentKeys?: string[]): boolean;
-    /**
-     * For server-side synchronizer: check if `key` is in `name` segment.
-     * For client-side synchronizer: check if `name` segment is in the cache. `key` is undefined.
-     */
-    abstract isInSegment(name: string, key?: string): boolean;
-    /**
-     * clear the cache.
-     */
-    clear(): void;
-    /**
-     * For server-side synchronizer: add the given list of segments to the cache, with an empty list of keys. The segments that already exist are not modified.
-     * For client-side synchronizer: the method is not used.
-     */
-    registerSegments(names: string[]): boolean;
-    /**
-     * For server-side synchronizer: get the list of segments to fetch changes.
-     * Also used for the `seC` (segment count) telemetry stat.
-     */
-    abstract getRegisteredSegments(): string[];
-    /**
-     * Only used for the `skC`(segment keys count) telemetry stat: 1 for client-side, and total count of keys in server-side.
-     * @TODO for client-side it should be the number of clients, but it requires a refactor of MySegments caches to simplify the code.
-     */
-    abstract getKeysCount(): number;
-    /**
-     * For server-side synchronizer: change number of `name` segment.
-     * For client-side synchronizer: change number of mySegments.
-     */
-    abstract setChangeNumber(name?: string, changeNumber?: number): boolean | void;
-    abstract getChangeNumber(name: string): number;
-    /**
-     * For server-side synchronizer: the method is not used.
-     * For client-side synchronizer: it resets or updates the cache.
-     */
-    resetSegments(segmentsData: MySegmentsData | IMySegmentsResponse): boolean;
-}

package/types/storages/AbstractSplitsCache.d.ts

@@ -1,46 +0,0 @@
-import { ISplit, MaybeThenable } from '../dtos/types';
-/**
- * This class provides a skeletal implementation of the ISplitsCacheAsync interface
- * to minimize the effort required to implement this interface.
- */
-export declare abstract class AbstractSplitsCache {
-    /**
-     * Check if the splits information is already stored in cache. This data can be preloaded.
-     * It is used as condition to emit SDK_SPLITS_CACHE_LOADED, and then SDK_READY_FROM_CACHE.
-     */
-    checkCache(): boolean;
-    protected abstract addSplit(name: string, split: ISplit): MaybeThenable<boolean>;
-    /**
-     * Add a list of splits.
-     * The returned promise is resolved when the operation success or rejected if it fails (e.g., wrapper operation fails).
-     */
-    protected addSplits(entries: [string, ISplit][]): Promise<boolean[]>;
-    protected abstract removeSplit(name: string): MaybeThenable<boolean>;
-    /**
-     * Remove a list of splits.
-     * The returned promise is resolved when the operation success, with a boolean array indicating if the splits existed or not.
-     * or rejected if it fails (e.g., wrapper operation fails).
-     */
-    protected removeSplits(names: string[]): Promise<boolean[]>;
-    protected abstract setChangeNumber(changeNumber: number): MaybeThenable<boolean | void>;
-    /**
-     * Updates the cache with the provided changeNumber, feature flags to add and feature flags to remove.
-     *
-     * @returns {Promise<boolean>} a promise that resolved once the operation is performed successfully. The fulfillment value is `true` if at least one feature flag was added, modified or removed; or `false` if there was no change.
-     * The promise will reject if some storage operation rejects.
-     */
-    update(changeNumber: number, toAdd: [string, ISplit][], toRemove?: string[]): Promise<boolean>;
-    abstract getSplit(name: string): MaybeThenable<ISplit | null>;
-    /**
-     * Kill `name` split and set `defaultTreatment` and `changeNumber`.
-     * Used for SPLIT_KILL push notifications.
-     *
-     * @param {string} name
-     * @param {string} defaultTreatment
-     * @param {number} changeNumber
-     * @returns {Promise} a promise that is resolved once the split kill operation is performed. The fulfillment value is a boolean: `true` if the operation successed updating the split or `false` if no split is updated,
-     * for instance, if the `changeNumber` is old, or if the split is not found (e.g., `/splitchanges` hasn't been fetched yet), or if the storage fails to apply the update.
-     * The promise will never be rejected.
-     */
-    killLocally(name: string, defaultTreatment: string, changeNumber: number): Promise<boolean>;
-}

package/types/storages/AbstractSplitsCacheAsync.d.ts

@@ -1,38 +0,0 @@
-import { ISplitsCacheAsync } from './types';
-import { ISplit } from '../dtos/types';
-/**
- * This class provides a skeletal implementation of the ISplitsCacheAsync interface
- * to minimize the effort required to implement this interface.
- */
-export declare abstract class AbstractSplitsCacheAsync implements ISplitsCacheAsync {
-    abstract addSplit(name: string, split: ISplit): Promise<boolean>;
-    abstract addSplits(entries: [string, ISplit][]): Promise<boolean[] | void>;
-    abstract removeSplits(names: string[]): Promise<boolean[] | void>;
-    abstract getSplit(name: string): Promise<ISplit | null>;
-    abstract getSplits(names: string[]): Promise<Record<string, ISplit | null>>;
-    abstract setChangeNumber(changeNumber: number): Promise<boolean | void>;
-    abstract getChangeNumber(): Promise<number>;
-    abstract getAll(): Promise<ISplit[]>;
-    abstract getSplitNames(): Promise<string[]>;
-    abstract getNamesByFlagSets(flagSets: string[]): Promise<Set<string>[]>;
-    abstract trafficTypeExists(trafficType: string): Promise<boolean>;
-    abstract clear(): Promise<boolean | void>;
-    usesSegments(): Promise<boolean>;
-    /**
-     * Check if the splits information is already stored in cache.
-     * Noop, just keeping the interface. This is used by client-side implementations only.
-     */
-    checkCache(): Promise<boolean>;
-    /**
-     * Kill `name` split and set `defaultTreatment` and `changeNumber`.
-     * Used for SPLIT_KILL push notifications.
-     *
-     * @param {string} name
-     * @param {string} defaultTreatment
-     * @param {number} changeNumber
-     * @returns {Promise} a promise that is resolved once the split kill operation is performed. The fulfillment value is a boolean: `true` if the operation successed updating the split or `false` if no split is updated,
-     * for instance, if the `changeNumber` is old, or if the split is not found (e.g., `/splitchanges` hasn't been fetched yet), or if the storage fails to apply the update.
-     * The promise will never be rejected.
-     */
-    killLocally(name: string, defaultTreatment: string, changeNumber: number): Promise<boolean>;
-}

package/types/storages/AbstractSplitsCacheSync.d.ts

@@ -1,43 +0,0 @@
-import { ISplitsCacheSync } from './types';
-import { ISplit } from '../dtos/types';
-/**
- * This class provides a skeletal implementation of the ISplitsCacheSync interface
- * to minimize the effort required to implement this interface.
- */
-export declare abstract class AbstractSplitsCacheSync implements ISplitsCacheSync {
-    abstract addSplit(name: string, split: ISplit): boolean;
-    addSplits(entries: [string, ISplit][]): boolean[];
-    abstract removeSplit(name: string): boolean;
-    removeSplits(names: string[]): boolean[];
-    abstract getSplit(name: string): ISplit | null;
-    getSplits(names: string[]): Record<string, ISplit | null>;
-    abstract setChangeNumber(changeNumber: number): boolean | void;
-    abstract getChangeNumber(): number;
-    getAll(): ISplit[];
-    abstract getSplitNames(): string[];
-    abstract trafficTypeExists(trafficType: string): boolean;
-    abstract usesSegments(): boolean;
-    abstract clear(): void;
-    /**
-     * Check if the splits information is already stored in cache. This data can be preloaded.
-     * It is used as condition to emit SDK_SPLITS_CACHE_LOADED, and then SDK_READY_FROM_CACHE.
-     */
-    checkCache(): boolean;
-    /**
-     * Kill `name` split and set `defaultTreatment` and `changeNumber`.
-     * Used for SPLIT_KILL push notifications.
-     *
-     * @param {string} name
-     * @param {string} defaultTreatment
-     * @param {number} changeNumber
-     * @returns {boolean} `true` if the operation successed updating the split, or `false` if no split is updated,
-     * for instance, if the `changeNumber` is old, or if the split is not found (e.g., `/splitchanges` hasn't been fetched yet), or if the storage fails to apply the update.
-     */
-    killLocally(name: string, defaultTreatment: string, changeNumber: number): boolean;
-    abstract getNamesByFlagSets(flagSets: string[]): Set<string>[];
-}
-/**
- * Given a parsed split, it returns a boolean flagging if its conditions use segments matchers (rules & whitelists).
- * This util is intended to simplify the implementation of `splitsCache::usesSegments` method
- */
-export declare function usesSegments(split: ISplit): boolean;

package/types/storages/KeyBuilder.d.ts

@@ -1,22 +0,0 @@
-import { ISettings } from '../types';
-export declare function validatePrefix(prefix: unknown): string;
-export declare class KeyBuilder {
-    readonly prefix: string;
-    constructor(prefix?: string);
-    buildTrafficTypeKey(trafficType: string): string;
-    buildFlagSetKey(flagSet: string): string;
-    buildSplitKey(splitName: string): string;
-    buildSplitsTillKey(): string;
-    isSplitKey(key: string): boolean;
-    buildSplitKeyPrefix(): string;
-    buildSplitsWithSegmentCountKey(): string;
-    buildSegmentNameKey(segmentName: string): string;
-    buildSegmentTillKey(segmentName: string): string;
-    extractKey(builtKey: string): string;
-    buildHashKey(): string;
-}
-/**
- * Generates a murmur32 hash based on the authorization key, the feature flags filter query, and version of SplitChanges API.
- * The hash is in hexadecimal format (8 characters max, 32 bits).
- */
-export declare function getStorageHash(settings: ISettings): string;

package/types/storages/KeyBuilderCS.d.ts

@@ -1,20 +0,0 @@
-import { KeyBuilder } from './KeyBuilder';
-export interface MySegmentsKeyBuilder {
-    buildSegmentNameKey(segmentName: string): string;
-    extractSegmentName(builtSegmentKeyName: string): string | undefined;
-    buildTillKey(): string;
-}
-export declare class KeyBuilderCS extends KeyBuilder implements MySegmentsKeyBuilder {
-    protected readonly regexSplitsCacheKey: RegExp;
-    protected readonly matchingKey: string;
-    constructor(prefix: string, matchingKey: string);
-    /**
-     * @override
-     */
-    buildSegmentNameKey(segmentName: string): string;
-    extractSegmentName(builtSegmentKeyName: string): string | undefined;
-    buildLastUpdatedKey(): string;
-    isSplitsCacheKey(key: string): boolean;
-    buildTillKey(): string;
-}
-export declare function myLargeSegmentsKeyBuilder(prefix: string, matchingKey: string): MySegmentsKeyBuilder;