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

package/types/storages/dataLoader.d.ts

@@ -1,10 +1,21 @@
 import { SplitIO } from '../types';
-import { DataLoader } from './types';
+import { ISegmentsCacheSync, ISplitsCacheSync, IStorageSync } from './types';
 /**
- * Factory of client-side storage loader
+ * Storage-agnostic adaptation of `loadDataIntoLocalStorage` function
+ * (https://github.com/godaddy/split-javascript-data-loader/blob/master/src/load-data.js)
  *
- * @param preloadedData validated data following the format proposed in https://github.com/godaddy/split-javascript-data-loader
- * and extended with a `mySegmentsData` property.
- * @returns function to preload the storage
+ * @param preloadedData validated data following the format proposed in https://github.com/godaddy/split-javascript-data-loader and extended with a `mySegmentsData` property.
+ * @param storage object containing `splits` and `segments` cache (client-side variant)
+ * @param userKey user key (matching key) of the provided MySegmentsCache
+ *
+ * @TODO extend to load largeSegments
+ * @TODO extend to load data on shared mySegments storages. Be specific when emitting SDK_READY_FROM_CACHE on shared clients. Maybe the serializer should provide the `useSegments` flag.
+ * @TODO add logs, and input validation in this module, in favor of size reduction.
+ * @TODO unit tests
  */
-export declare function dataLoaderFactory(preloadedData: SplitIO.PreloadedData): DataLoader;
+export declare function loadData(preloadedData: SplitIO.PreloadedData, storage: {
+    splits?: ISplitsCacheSync;
+    segments: ISegmentsCacheSync;
+    largeSegments?: ISegmentsCacheSync;
+}, userKey?: string): void;
+export declare function getSnapshot(storage: IStorageSync, userKeys?: string[]): SplitIO.PreloadedData;

package/types/storages/inLocalStorage/SplitsCacheInLocal.d.ts

@@ -35,12 +35,6 @@ export declare class SplitsCacheInLocal extends AbstractSplitsCacheSync {
     getSplitNames(): string[];
     trafficTypeExists(trafficType: string): boolean;
     usesSegments(): boolean;
-    /**
-     * Check if the splits information is already stored in browser LocalStorage.
-     * In this function we could add more code to check if the data is valid.
-     * @override
-     */
-    checkCache(): boolean;
     /**
      * Clean Splits cache if its `lastUpdated` timestamp is older than the given `expirationTimestamp`,
      *

package/types/storages/types.d.ts

@@ -192,7 +192,6 @@ 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>[]>;
 }
@@ -208,7 +207,6 @@ 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>[];
 }
@@ -224,7 +222,6 @@ 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>[]>;
 }
@@ -394,7 +391,6 @@ 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;
     /**
@@ -402,6 +398,7 @@ 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/types.d.ts

@@ -1,4 +1,4 @@
-import { ISplitFiltersValidation } from './dtos/types';
+import { ISplit, ISplitFiltersValidation } from './dtos/types';
 import { IIntegration, IIntegrationFactoryParams } from './integrations/types';
 import { ILogger } from './logger/types';
 import { ISdkFactoryContext } from './sdkFactory/types';
@@ -92,6 +92,7 @@ export interface ISettings {
         eventsFirstPushWindow: number;
     };
     readonly storage: IStorageSyncFactory | IStorageAsyncFactory;
+    readonly preloadedData?: SplitIO.PreloadedData;
     readonly integrations: Array<{
         readonly type: string;
         (params: IIntegrationFactoryParams): IIntegration | void;
@@ -422,7 +423,7 @@ export interface IStatusInterface extends IEventEmitter {
  * @interface IBasicClient
  * @extends IStatusInterface
  */
-interface IBasicClient extends IStatusInterface {
+export interface IBasicClient extends IStatusInterface {
     /**
      * Flush data
      * @function flush
@@ -452,6 +453,12 @@ interface IBasicSDK {
      * @property Logger
      */
     Logger: ILoggerAPI;
+    /**
+     * Destroy all the clients created by this factory.
+     * @function destroy
+     * @returns {Promise<void>}
+     */
+    destroy(): Promise<void>;
 }
 /****** Exposed namespace ******/
 /**
@@ -764,21 +771,19 @@ 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;
         /**
-         * Map of feature flags to their stringified definitions.
+         * List of feature flag definitions.
+         * @TODO rename to flags
          */
-        splitsData: {
-            [splitName: string]: string;
-        };
+        splitsData: ISplit[];
         /**
          * Optional map of user keys to their list of segments.
-         * @TODO remove when releasing first version
+         * @TODO rename to memberships
          */
         mySegmentsData?: {
             [key: string]: string[];
@@ -786,9 +791,10 @@ 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,10 +1,5 @@
 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
  *