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

package/types/storages/types.d.ts

@@ -192,6 +192,7 @@ export interface ISplitsCacheBase {
     trafficTypeExists(trafficType: string): MaybeThenable<boolean>;
     usesSegments(): MaybeThenable<boolean>;
     clear(): MaybeThenable<boolean | void>;
+    checkCache(): MaybeThenable<boolean>;
     killLocally(name: string, defaultTreatment: string, changeNumber: number): MaybeThenable<boolean>;
     getNamesByFlagSets(flagSets: string[]): MaybeThenable<ISet<string>[]>;
 }
@@ -207,6 +208,7 @@ export interface ISplitsCacheSync extends ISplitsCacheBase {
     trafficTypeExists(trafficType: string): boolean;
     usesSegments(): boolean;
     clear(): void;
+    checkCache(): boolean;
     killLocally(name: string, defaultTreatment: string, changeNumber: number): boolean;
     getNamesByFlagSets(flagSets: string[]): ISet<string>[];
 }
@@ -222,40 +224,35 @@ export interface ISplitsCacheAsync extends ISplitsCacheBase {
     trafficTypeExists(trafficType: string): Promise<boolean>;
     usesSegments(): Promise<boolean>;
     clear(): Promise<boolean | void>;
+    checkCache(): Promise<boolean>;
     killLocally(name: string, defaultTreatment: string, changeNumber: number): Promise<boolean>;
     getNamesByFlagSets(flagSets: string[]): Promise<ISet<string>[]>;
 }
 /** Segments cache */
 export interface ISegmentsCacheBase {
-    addToSegment(name: string, segmentKeys: string[]): MaybeThenable<boolean | void>;
-    removeFromSegment(name: string, segmentKeys: string[]): MaybeThenable<boolean | void>;
     isInSegment(name: string, key?: string): MaybeThenable<boolean>;
     registerSegments(names: string[]): MaybeThenable<boolean | void>;
     getRegisteredSegments(): MaybeThenable<string[]>;
-    setChangeNumber(name: string, changeNumber: number): MaybeThenable<boolean | void>;
     getChangeNumber(name: string): MaybeThenable<number>;
+    update(name: string, addedKeys: string[], removedKeys: string[], changeNumber: number): MaybeThenable<boolean>;
     clear(): MaybeThenable<boolean | void>;
 }
 export interface ISegmentsCacheSync extends ISegmentsCacheBase {
-    addToSegment(name: string, segmentKeys?: string[]): boolean;
-    removeFromSegment(name: string, segmentKeys?: string[]): boolean;
     isInSegment(name: string, key?: string): boolean;
     registerSegments(names: string[]): boolean;
     getRegisteredSegments(): string[];
     getKeysCount(): number;
-    setChangeNumber(name: string, changeNumber: number): boolean | void;
     getChangeNumber(name?: string): number;
+    update(name: string, addedKeys: string[], removedKeys: string[], changeNumber: number): boolean;
     resetSegments(segmentsData: MySegmentsData | IMySegmentsResponse): boolean;
     clear(): void;
 }
 export interface ISegmentsCacheAsync extends ISegmentsCacheBase {
-    addToSegment(name: string, segmentKeys: string[]): Promise<boolean | void>;
-    removeFromSegment(name: string, segmentKeys: string[]): Promise<boolean | void>;
     isInSegment(name: string, key: string): Promise<boolean>;
     registerSegments(names: string[]): Promise<boolean | void>;
     getRegisteredSegments(): Promise<string[]>;
-    setChangeNumber(name: string, changeNumber: number): Promise<boolean | void>;
     getChangeNumber(name: string): Promise<number>;
+    update(name: string, addedKeys: string[], removedKeys: string[], changeNumber: number): Promise<boolean>;
     clear(): Promise<boolean | void>;
 }
 /** Recorder storages (impressions, events and telemetry) */
@@ -391,6 +388,7 @@ export interface IStorageSync extends IStorageBase<ISplitsCacheSync, ISegmentsCa
 export interface IStorageAsync extends IStorageBase<ISplitsCacheAsync, ISegmentsCacheAsync, IImpressionsCacheAsync | IImpressionsCacheSync, IImpressionCountsCacheBase, IEventsCacheAsync | IEventsCacheSync, ITelemetryCacheAsync | ITelemetryCacheSync, IUniqueKeysCacheBase> {
 }
 /** StorageFactory */
+export declare type DataLoader = (storage: IStorageSync, matchingKey: string) => void;
 export interface IStorageFactoryParams {
     settings: ISettings;
     /**
@@ -398,7 +396,6 @@ export interface IStorageFactoryParams {
      * It is meant for emitting SDK_READY event in consumer mode, and waiting before using the storage in the synchronizer.
      */
     onReadyCb: (error?: any) => void;
-    onReadyFromCacheCb: (error?: any) => void;
 }
 export declare type StorageType = 'MEMORY' | 'LOCALSTORAGE' | 'REDIS' | 'PLUGGABLE';
 export declare type IStorageSyncFactory = {

package/types/sync/types.d.ts

@@ -39,5 +39,5 @@ export interface ISyncManager extends ITask {
     submitterManager?: ISubmitterManager;
 }
 export interface ISyncManagerCS extends ISyncManager {
-    shared(matchingKey: string, readinessManager: IReadinessManager, storage: IStorageSync): ISyncManager | undefined;
+    shared(matchingKey: string, readinessManager: IReadinessManager, storage: IStorageSync): Pick<ISyncManager, 'stop' | 'flush'> | undefined;
 }

package/types/trackers/eventTracker.d.ts

@@ -7,4 +7,4 @@ import { ISettings } from '../types';
  * @param eventsCache cache to save events
  * @param integrationsManager optional event handler used for integrations
  */
-export declare function eventTrackerFactory(settings: ISettings, eventsCache: IEventsCacheBase, integrationsManager?: IEventsHandler, telemetryCache?: ITelemetryCacheSync | ITelemetryCacheAsync): IEventTracker;
+export declare function eventTrackerFactory(settings: ISettings, eventsCache: IEventsCacheBase, whenInit: (cb: () => void) => void, integrationsManager?: IEventsHandler, telemetryCache?: ITelemetryCacheSync | ITelemetryCacheAsync): IEventTracker;

package/types/trackers/impressionsTracker.d.ts

@@ -10,4 +10,4 @@ import { ISettings } from '../types';
  * @param integrationsManager optional integrations manager
  * @param strategy strategy for impressions tracking.
  */
-export declare function impressionsTrackerFactory(settings: ISettings, impressionsCache: IImpressionsCacheBase, strategy: IStrategy, integrationsManager?: IImpressionsHandler, telemetryCache?: ITelemetryCacheSync | ITelemetryCacheAsync): IImpressionsTracker;
+export declare function impressionsTrackerFactory(settings: ISettings, impressionsCache: IImpressionsCacheBase, strategy: IStrategy, whenInit: (cb: () => void) => void, integrationsManager?: IImpressionsHandler, telemetryCache?: ITelemetryCacheSync | ITelemetryCacheAsync): IImpressionsTracker;

package/types/trackers/types.d.ts

@@ -54,6 +54,7 @@ export interface IImpressionSenderAdapter {
 }
 /** Unique keys tracker */
 export interface IUniqueKeysTracker {
+    start(): void;
     stop(): void;
     track(key: string, featureName: string): void;
 }

package/types/types.d.ts

@@ -1,4 +1,4 @@
-import { ISplit, ISplitFiltersValidation } from './dtos/types';
+import { ISplitFiltersValidation } from './dtos/types';
 import { IIntegration, IIntegrationFactoryParams } from './integrations/types';
 import { ILogger } from './logger/types';
 import { ISdkFactoryContext } from './sdkFactory/types';
@@ -92,7 +92,6 @@ export interface ISettings {
         eventsFirstPushWindow: number;
     };
     readonly storage: IStorageSyncFactory | IStorageAsyncFactory;
-    readonly preloadedData?: SplitIO.PreloadedData;
     readonly integrations: Array<{
         readonly type: string;
         (params: IIntegrationFactoryParams): IIntegration | void;
@@ -771,19 +770,21 @@ export declare namespace SplitIO {
          * If this value is older than 10 days ago (expiration time policy), the data is not used to update the storage content.
          * @TODO configurable expiration time policy?
          */
+        lastUpdated: number;
         /**
          * Change number of the preloaded data.
          * If this value is older than the current changeNumber at the storage, the data is not used to update the storage content.
          */
         since: number;
         /**
-         * List of feature flag definitions.
-         * @TODO rename to flags
+         * Map of feature flags to their stringified definitions.
          */
-        splitsData: ISplit[];
+        splitsData: {
+            [splitName: string]: string;
+        };
         /**
          * Optional map of user keys to their list of segments.
-         * @TODO rename to memberships
+         * @TODO remove when releasing first version
          */
         mySegmentsData?: {
             [key: string]: string[];
@@ -791,10 +792,9 @@ export declare namespace SplitIO {
         /**
          * Optional map of segments to their stringified definitions.
          * This property is ignored if `mySegmentsData` was provided.
-         * @TODO rename to segments
          */
         segmentsData?: {
-            [segmentName: string]: string[];
+            [segmentName: string]: string;
         };
     }
     /**

package/types/utils/settingsValidation/storage/storageCS.d.ts

@@ -1,5 +1,10 @@
 import { ISettings, SDKMode } from '../../../types';
 import { ILogger } from '../../../logger/types';
+import { IStorageFactoryParams, IStorageSync } from '../../../storages/types';
+export declare function __InLocalStorageMockFactory(params: IStorageFactoryParams): IStorageSync;
+export declare namespace __InLocalStorageMockFactory {
+    var type: import("../../../storages/types").StorageType;
+}
 /**
  * This function validates `settings.storage` object
  *