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

package/src/sync/submitters/types.ts

@@ -103,7 +103,7 @@ export type DROPPED = 1;
 export type DEDUPED = 2;
 export type ImpressionDataType = QUEUED | DROPPED | DEDUPED
 export type EventDataType = QUEUED | DROPPED;
-export type UpdatesFromSSEEnum = SPLITS | MEMBERSHIPS;
+export type UpdatesFromSSEEnum = SPLITS | MY_SEGMENT;
 
 export type SPLITS = 'sp';
 export type IMPRESSIONS = 'im';
@@ -112,8 +112,8 @@ export type EVENTS = 'ev';
 export type TELEMETRY = 'te';
 export type TOKEN = 'to';
 export type SEGMENT = 'se';
-export type MEMBERSHIPS = 'ms';
-export type OperationType = SPLITS | IMPRESSIONS | IMPRESSIONS_COUNT | EVENTS | TELEMETRY | TOKEN | SEGMENT | MEMBERSHIPS;
+export type MY_SEGMENT = 'ms';
+export type OperationType = SPLITS | IMPRESSIONS | IMPRESSIONS_COUNT | EVENTS | TELEMETRY | TOKEN | SEGMENT | MY_SEGMENT;
 
 export type LastSync = Partial<Record<OperationType, number | undefined>>
 export type HttpErrors = Partial<Record<OperationType, { [statusCode: string]: number }>>
@@ -158,9 +158,8 @@ export type TelemetryUsageStats = {
 
 // amount of instant updates that we are doing by avoiding fetching to Split servers
 export type UpdatesFromSSE = {
-  sp?: number, // splits
+  sp: number, // splits
   ms?: number, // my segments
-  mls?: number // my large segments
 }
 
 // 'metrics/usage' JSON request body
@@ -176,14 +175,12 @@ export type TelemetryUsageStatsPayload = TelemetryUsageStats & {
   spC?: number, // splitCount
   seC?: number, // segmentCount
   skC?: number, // segmentKeyCount
-  lsC?: number, // largeSegmentCount
-  lskC?: number, // largeSegmentKeyCount
   sL?: number, // sessionLengthMs
   eQ: number, // eventsQueued
   eD: number, // eventsDropped
   sE: Array<StreamingEvent>, // streamingEvents
   t?: Array<string>, // tags
-  ufs?: UpdatesFromSSE, // instant updates
+  ufs?: UpdatesFromSSE, //UpdatesFromSSE
 }
 
 /**

package/src/sync/syncManagerOnline.ts

@@ -143,27 +143,27 @@ export function syncManagerOnlineFactory(
 
         const mySegmentsSyncTask = (pollingManager as IPollingManagerCS).add(matchingKey, readinessManager, storage);
 
-        if (running) {
-          if (syncEnabled) {
-            if (pushManager) {
-              if (pollingManager!.isRunning()) {
-                // if doing polling, we must start the periodic fetch of data
-                if (storage.splits.usesSegments()) mySegmentsSyncTask.start();
+        return {
+          isRunning: mySegmentsSyncTask.isRunning,
+          start() {
+            if (syncEnabled) {
+              if (pushManager) {
+                if (pollingManager!.isRunning()) {
+                  // if doing polling, we must start the periodic fetch of data
+                  if (storage.splits.usesSegments()) mySegmentsSyncTask.start();
+                } else {
+                  // if not polling, we must execute the sync task for the initial fetch
+                  // of segments since `syncAll` was already executed when starting the main client
+                  mySegmentsSyncTask.execute();
+                }
+                pushManager.add(matchingKey, mySegmentsSyncTask);
               } else {
-                // if not polling, we must execute the sync task for the initial fetch
-                // of segments since `syncAll` was already executed when starting the main client
-                mySegmentsSyncTask.execute();
+                if (storage.splits.usesSegments()) mySegmentsSyncTask.start();
               }
-              pushManager.add(matchingKey, mySegmentsSyncTask);
             } else {
-              if (storage.splits.usesSegments()) mySegmentsSyncTask.start();
+              if (!readinessManager.isReady()) mySegmentsSyncTask.execute();
             }
-          } else {
-            if (!readinessManager.isReady()) mySegmentsSyncTask.execute();
-          }
-        }
-
-        return {
+          },
           stop() {
             // check in case `client.destroy()` has been invoked more than once for the same client
             const mySegmentsSyncTask = (pollingManager as IPollingManagerCS).get(matchingKey);

package/src/sync/syncTask.ts

@@ -68,8 +68,8 @@ export function syncTaskFactory<Input extends any[], Output = any>(log: ILogger,
     },
 
     stop() {
-      running = false;
-      if (timeoutID) {
+      if (running) {
+        running = false;
         log.debug(SYNC_TASK_STOP, [taskName]);
         clearTimeout(timeoutID);
         timeoutID = undefined;

package/src/sync/types.ts

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

package/src/trackers/eventTracker.ts

@@ -16,7 +16,6 @@ import { isConsumerMode } from '../utils/settingsValidation/mode';
 export function eventTrackerFactory(
   settings: ISettings,
   eventsCache: IEventsCacheBase,
-  whenInit: (cb: () => void) => void,
   integrationsManager?: IEventsHandler,
   telemetryCache?: ITelemetryCacheSync | ITelemetryCacheAsync
 ): IEventTracker {
@@ -32,16 +31,14 @@ export function eventTrackerFactory(
     if (tracked) {
       log.info(EVENTS_TRACKER_SUCCESS, [msg]);
       if (integrationsManager) {
-        whenInit(() => {
-          // Wrap in a timeout because we don't want it to be blocking.
-          setTimeout(() => {
-            // copy of event, to avoid unexpected behaviour if modified by integrations
-            const eventDataCopy = objectAssign({}, eventData);
-            if (properties) eventDataCopy.properties = objectAssign({}, properties);
-            // integrationsManager does not throw errors (they are internally handled by each integration module)
-            integrationsManager.handleEvent(eventDataCopy);
-          });
-        });
+        // Wrap in a timeout because we don't want it to be blocking.
+        setTimeout(function () {
+          // copy of event, to avoid unexpected behaviour if modified by integrations
+          const eventDataCopy = objectAssign({}, eventData);
+          if (properties) eventDataCopy.properties = objectAssign({}, properties);
+          // integrationsManager does not throw errors (they are internally handled by each integration module)
+          integrationsManager.handleEvent(eventDataCopy);
+        }, 0);
       }
     } else {
       log.error(ERROR_EVENTS_TRACKER, [msg]);

package/src/trackers/impressionsTracker.ts

@@ -19,7 +19,6 @@ export function impressionsTrackerFactory(
   settings: ISettings,
   impressionsCache: IImpressionsCacheBase,
   strategy: IStrategy,
-  whenInit: (cb: () => void) => void,
   integrationsManager?: IImpressionsHandler,
   telemetryCache?: ITelemetryCacheSync | ITelemetryCacheAsync,
 ): IImpressionsTracker {
@@ -67,19 +66,17 @@ export function impressionsTrackerFactory(
             sdkLanguageVersion: version
           };
 
-          whenInit(() => {
-            // Wrap in a timeout because we don't want it to be blocking.
-            setTimeout(() => {
-              // integrationsManager.handleImpression does not throw errors
-              if (integrationsManager) integrationsManager.handleImpression(impressionData);
+          // Wrap in a timeout because we don't want it to be blocking.
+          setTimeout(function () {
+            // integrationsManager.handleImpression does not throw errors
+            if (integrationsManager) integrationsManager.handleImpression(impressionData);
 
-              try { // @ts-ignore. An exception on the listeners should not break the SDK.
-                if (impressionListener) impressionListener.logImpression(impressionData);
-              } catch (err) {
-                log.error(ERROR_IMPRESSIONS_LISTENER, [err]);
-              }
-            });
-          });
+            try { // @ts-ignore. An exception on the listeners should not break the SDK.
+              if (impressionListener) impressionListener.logImpression(impressionData);
+            } catch (err) {
+              log.error(ERROR_IMPRESSIONS_LISTENER, [err]);
+            }
+          }, 0);
         }
       }
     }

package/src/trackers/types.ts

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

package/src/trackers/uniqueKeysTracker.ts

@@ -25,6 +25,10 @@ export function uniqueKeysTrackerFactory(
 ): IUniqueKeysTracker {
   let intervalId: any;
 
+  if (filterAdapter.refreshRate) {
+    intervalId = setInterval(filterAdapter.clear, filterAdapter.refreshRate);
+  }
+
   return {
 
     track(key: string, featureName: string): void {
@@ -35,12 +39,6 @@ export function uniqueKeysTrackerFactory(
       uniqueKeysCache.track(key, featureName);
     },
 
-    start(): void {
-      if (filterAdapter.refreshRate) {
-        intervalId = setInterval(filterAdapter.clear, filterAdapter.refreshRate);
-      }
-    },
-
     stop(): void {
       clearInterval(intervalId);
     }

package/src/types.ts

@@ -426,7 +426,7 @@ export interface IStatusInterface extends IEventEmitter {
  * @interface IBasicClient
  * @extends IStatusInterface
  */
-export interface IBasicClient extends IStatusInterface {
+interface IBasicClient extends IStatusInterface {
   /**
    * Flush data
    * @function flush
@@ -459,12 +459,6 @@ interface IBasicSDK {
    * @property Logger
    */
   Logger: ILoggerAPI
-  /**
-   * Destroy all the clients created by this factory.
-   * @function destroy
-   * @returns {Promise<void>}
-   */
-  destroy(): Promise<void>
 }
 /****** Exposed namespace ******/
 /**

package/src/utils/constants/index.ts

@@ -75,7 +75,7 @@ export const EVENTS = 'ev';
 export const TELEMETRY = 'te';
 export const TOKEN = 'to';
 export const SEGMENT = 'se';
-export const MEMBERSHIPS = 'ms';
+export const MY_SEGMENT = 'ms';
 
 export const TREATMENT = 't';
 export const TREATMENTS = 'ts';
@@ -105,8 +105,7 @@ export const DISABLED = 0;
 export const ENABLED = 1;
 export const PAUSED = 2;
 
-export const FLAG_SPEC_VERSION = '1.2';
+export const FLAG_SPEC_VERSION = '1.1';
 
 // Matcher types
 export const IN_SEGMENT = 'IN_SEGMENT';
-export const IN_LARGE_SEGMENT = 'IN_LARGE_SEGMENT';

package/src/utils/settingsValidation/index.ts

@@ -209,12 +209,11 @@ export function settingsValidation(config: unknown, validationParams: ISettingsV
   const splitFiltersValidation = validateSplitFilters(log, sync.splitFilters, withDefaults.mode);
   sync.splitFilters = splitFiltersValidation.validFilters;
   sync.__splitFiltersValidation = splitFiltersValidation;
-
-  // ensure a valid flag spec version
   sync.flagSpecVersion = flagSpec ? flagSpec(withDefaults) : FLAG_SPEC_VERSION;
+
   // ensure a valid user consent value
   // @ts-ignore, modify readonly prop
-  withDefaults.userConsent = consent ? consent(withDefaults) : undefined;
+  withDefaults.userConsent = consent(withDefaults);
 
   return withDefaults;
 }

package/src/utils/settingsValidation/types.ts

@@ -25,7 +25,7 @@ export interface ISettingsValidationParams {
   /** Localhost mode validator (`settings.sync.localhostMode`) */
   localhost?: (settings: ISettings) => ISettings['sync']['localhostMode'],
   /** User consent validator (`settings.userConsent`) */
-  consent?: (settings: ISettings) => ISettings['userConsent'],
+  consent: (settings: ISettings) => ISettings['userConsent'],
   /** Flag spec version validation. Configurable by the JS Synchronizer but not by the SDKs */
   flagSpec?: (settings: ISettings) => ISettings['sync']['flagSpecVersion']
 }

package/types/dtos/types.d.ts

@@ -21,9 +21,6 @@ export interface IWhitelistMatcherData {
 export interface IInSegmentMatcherData {
     segmentName: string;
 }
-export interface IInLargeSegmentMatcherData {
-    largeSegmentName: string;
-}
 export interface IDependencyMatcherData {
     split: string;
     treatments: string[];
@@ -36,7 +33,6 @@ interface ISplitMatcherBase {
         attribute: string | null;
     };
     userDefinedSegmentMatcherData?: null | IInSegmentMatcherData;
-    userDefinedLargeSegmentMatcherData?: null | IInLargeSegmentMatcherData;
     whitelistMatcherData?: null | IWhitelistMatcherData;
     unaryNumericMatcherData?: null | IUnaryNumericMatcherData;
     betweenMatcherData?: null | IBetweenMatcherData;
@@ -52,10 +48,6 @@ interface IInSegmentMatcher extends ISplitMatcherBase {
     matcherType: 'IN_SEGMENT';
     userDefinedSegmentMatcherData: IInSegmentMatcherData;
 }
-interface IInLargeSegmentMatcher extends ISplitMatcherBase {
-    matcherType: 'IN_LARGE_SEGMENT';
-    userDefinedLargeSegmentMatcherData: IInLargeSegmentMatcherData;
-}
 interface IWhitelistMatcher extends ISplitMatcherBase {
     matcherType: 'WHITELIST';
     whitelistMatcherData: IWhitelistMatcherData;
@@ -136,7 +128,7 @@ interface IInListSemverMatcher extends ISplitMatcherBase {
     matcherType: 'IN_LIST_SEMVER';
     whitelistMatcherData: IWhitelistMatcherData;
 }
-export declare type ISplitMatcher = IAllKeysMatcher | IInSegmentMatcher | IWhitelistMatcher | IEqualToMatcher | IGreaterThanOrEqualToMatcher | ILessThanOrEqualToMatcher | IBetweenMatcher | IEqualToSetMatcher | IContainsAnyOfSetMatcher | IContainsAllOfSetMatcher | IPartOfSetMatcher | IStartsWithMatcher | IEndsWithMatcher | IContainsStringMatcher | IInSplitTreatmentMatcher | IEqualToBooleanMatcher | IMatchesStringMatcher | IEqualToSemverMatcher | IGreaterThanOrEqualToSemverMatcher | ILessThanOrEqualToSemverMatcher | IBetweenSemverMatcher | IInListSemverMatcher | IInLargeSegmentMatcher;
+export declare type ISplitMatcher = IAllKeysMatcher | IInSegmentMatcher | IWhitelistMatcher | IEqualToMatcher | IGreaterThanOrEqualToMatcher | ILessThanOrEqualToMatcher | IBetweenMatcher | IEqualToSetMatcher | IContainsAnyOfSetMatcher | IContainsAllOfSetMatcher | IPartOfSetMatcher | IStartsWithMatcher | IEndsWithMatcher | IContainsStringMatcher | IInSplitTreatmentMatcher | IEqualToBooleanMatcher | IMatchesStringMatcher | IEqualToSemverMatcher | IGreaterThanOrEqualToSemverMatcher | ILessThanOrEqualToSemverMatcher | IBetweenSemverMatcher | IInListSemverMatcher;
 /** Split object */
 export interface ISplitPartition {
     treatment: string;
@@ -181,16 +173,13 @@ export interface ISegmentChangesResponse {
     since: number;
     till: number;
 }
+export interface IMySegmentsResponseItem {
+    id: string;
+    name: string;
+}
+/** Interface of the parsed JSON response of `/mySegments/{userKey}` */
 export interface IMySegmentsResponse {
-    cn?: number;
-    k?: {
-        n: string;
-    }[];
-}
-/** Interface of the parsed JSON response of `/memberships/{userKey}` */
-export interface IMembershipsResponse {
-    ms?: IMySegmentsResponse;
-    ls?: IMySegmentsResponse;
+    mySegments: IMySegmentsResponseItem[];
 }
 /** Metadata internal type for storages */
 export interface IMetadata {

package/types/evaluator/matchersTransform/segment.d.ts

@@ -1,5 +1,5 @@
-import { IInSegmentMatcherData, IInLargeSegmentMatcherData } from '../../dtos/types';
+import { IInSegmentMatcherData } from '../../dtos/types';
 /**
  * Extract segment name as a plain string.
  */
-export declare function segmentTransform(segment?: IInSegmentMatcherData | IInLargeSegmentMatcherData): string | undefined;
+export declare function segmentTransform(segment?: IInSegmentMatcherData): string | undefined;

package/types/logger/constants.d.ts

@@ -77,7 +77,7 @@ export declare const WARN_SPLITS_FILTER_IGNORED = 219;
 export declare const WARN_SPLITS_FILTER_INVALID = 220;
 export declare const WARN_SPLITS_FILTER_EMPTY = 221;
 export declare const WARN_SDK_KEY = 222;
-export declare const STREAMING_PARSING_MEMBERSHIPS_UPDATE = 223;
+export declare const STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2 = 223;
 export declare const STREAMING_PARSING_SPLIT_UPDATE = 224;
 export declare const WARN_INVALID_FLAGSET = 225;
 export declare const WARN_LOWERCASE_FLAGSET = 226;

package/types/readiness/readinessManager.d.ts

@@ -1,6 +1,6 @@
-import { IEventEmitter, ISettings } from '../types';
+import { IEventEmitter } from '../types';
 import { IReadinessManager, ISplitsEventEmitter } from './types';
 /**
  * Factory of readiness manager, which handles the ready / update event propagation.
  */
-export declare function readinessManagerFactory(EventEmitter: new () => IEventEmitter, settings: ISettings, splits?: ISplitsEventEmitter): IReadinessManager;
+export declare function readinessManagerFactory(EventEmitter: new () => IEventEmitter, readyTimeout?: number, splits?: ISplitsEventEmitter): IReadinessManager;

package/types/readiness/sdkReadinessManager.d.ts

@@ -1,5 +1,6 @@
 import { ISdkReadinessManager } from './types';
-import { IEventEmitter, ISettings } from '../types';
+import { IEventEmitter } from '../types';
+import { ILogger } from '../logger/types';
 /**
  * SdkReadinessManager factory, which provides the public status API of SDK clients and manager: ready promise, readiness event emitter and constants (SDK_READY, etc).
  * It also updates logs related warnings and errors.
@@ -7,4 +8,4 @@ import { IEventEmitter, ISettings } from '../types';
  * @param readyTimeout time in millis to emit SDK_READY_TIME_OUT event
  * @param readinessManager optional readinessManager to use. only used internally for `shared` method
  */
-export declare function sdkReadinessManagerFactory(EventEmitter: new () => IEventEmitter, settings: ISettings, readinessManager?: import("./types").IReadinessManager): ISdkReadinessManager;
+export declare function sdkReadinessManagerFactory(log: ILogger, EventEmitter: new () => IEventEmitter, readyTimeout?: number, readinessManager?: import("./types").IReadinessManager): ISdkReadinessManager;

package/types/readiness/types.d.ts

@@ -9,8 +9,6 @@ export interface ISplitsEventEmitter extends IEventEmitter {
     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';
@@ -48,9 +46,8 @@ export interface IReadinessManager {
     timeout(): void;
     setDestroyed(): void;
     destroy(): void;
-    init(): void;
     /** for client-side */
-    shared(): IReadinessManager;
+    shared(readyTimeout?: number): IReadinessManager;
 }
 /** SDK readiness manager */
 export interface ISdkReadinessManager {
@@ -62,6 +59,6 @@ export interface ISdkReadinessManager {
      */
     incInternalReadyCbCount(): void;
     /** for client-side */
-    shared(): ISdkReadinessManager;
+    shared(readyTimeout?: number): ISdkReadinessManager;
 }
 export {};

package/types/sdkClient/sdkClientMethod.d.ts

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

package/types/sdkFactory/types.d.ts

@@ -8,7 +8,7 @@ import { IStorageAsync, IStorageSync, IStorageFactoryParams } from '../storages/
 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';
+import { SplitIO, ISettings, IEventEmitter } from '../types';
 /**
  * Environment related dependencies.
  */
@@ -47,7 +47,6 @@ export interface ISdkFactoryContext {
     signalListener?: ISignalListener;
     splitApi?: ISplitApi;
     syncManager?: ISyncManager;
-    clients: Record<string, IBasicClient>;
 }
 export interface ISdkFactoryContextSync extends ISdkFactoryContext {
     storage: IStorageSync;
@@ -63,7 +62,6 @@ export interface ISdkFactoryContextAsync extends ISdkFactoryContext {
  * 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;

package/types/services/decorateHeaders.d.ts

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

package/types/services/splitApi.d.ts

@@ -9,4 +9,4 @@ import { ITelemetryTracker } from '../trackers/types';
  * @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;
+export declare function splitApiFactory(settings: ISettings, platform: IPlatform, telemetryTracker: ITelemetryTracker): ISplitApi;

package/types/services/splitHttpClient.d.ts

@@ -7,4 +7,4 @@ import { IPlatform } from '../sdkFactory/types';
  * @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;
+export declare function splitHttpClientFactory(settings: ISettings, { getOptions, getFetch }: IPlatform): ISplitHttpClient;

package/types/services/types.d.ts

@@ -18,7 +18,7 @@ export declare type ISplitHttpClient = (url: string, options?: IRequestOptions,
 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 IFetchMySegments = (userMatchingKey: string, noCache?: boolean) => 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>;
@@ -32,7 +32,7 @@ export interface ISplitApi {
     fetchAuth: IFetchAuth;
     fetchSplitChanges: IFetchSplitChanges;
     fetchSegmentChanges: IFetchSegmentChanges;
-    fetchMemberships: IFetchMemberships;
+    fetchMySegments: IFetchMySegments;
     postEventsBulk: IPostEventsBulk;
     postUniqueKeysBulkCs: IPostUniqueKeysBulkCs;
     postUniqueKeysBulkSs: IPostUniqueKeysBulkSs;

package/types/storages/AbstractSegmentsCacheSync.d.ts

@@ -1,5 +1,3 @@
-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
@@ -24,7 +22,7 @@ export declare abstract class AbstractSegmentsCacheSync implements ISegmentsCach
     /**
      * clear the cache.
      */
-    clear(): void;
+    abstract 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.
@@ -41,14 +39,18 @@ export declare abstract class AbstractSegmentsCacheSync implements ISegmentsCach
      */
     abstract getKeysCount(): number;
     /**
-     * For server-side synchronizer: change number of `name` segment.
-     * For client-side synchronizer: change number of mySegments.
+     * For server-side synchronizer: set the change number of `name` segment.
+     * For client-side synchronizer: the method is not used.
+     */
+    setChangeNumber(name: string, changeNumber: number): boolean;
+    /**
+     * For server-side synchronizer: get the change number of `name` segment.
+     * For client-side synchronizer: the method is not used.
      */
-    abstract setChangeNumber(name?: string, changeNumber?: number): boolean | void;
-    abstract getChangeNumber(name: string): number;
+    getChangeNumber(name: string): number | undefined;
     /**
      * For server-side synchronizer: the method is not used.
-     * For client-side synchronizer: it resets or updates the cache.
+     * For client-side synchronizer: reset the cache with the given list of segments.
      */
-    resetSegments(segmentsData: MySegmentsData | IMySegmentsResponse): boolean;
+    resetSegments(names: string[]): boolean;
 }

package/types/storages/AbstractSplitsCacheSync.d.ts

@@ -12,7 +12,7 @@ export declare abstract class AbstractSplitsCacheSync implements ISplitsCacheSyn
     removeSplits(names: string[]): boolean[];
     abstract getSplit(name: string): ISplit | null;
     getSplits(names: string[]): Record<string, ISplit | null>;
-    abstract setChangeNumber(changeNumber: number): boolean | void;
+    abstract setChangeNumber(changeNumber: number): boolean;
     abstract getChangeNumber(): number;
     getAll(): ISplit[];
     abstract getSplitNames(): string[];

package/types/storages/KeyBuilderCS.d.ts

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

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

@@ -1,15 +1,25 @@
 import { ILogger } from '../../logger/types';
-import { AbstractMySegmentsCacheSync } from '../AbstractMySegmentsCacheSync';
-import type { MySegmentsKeyBuilder } from '../KeyBuilderCS';
-export declare class MySegmentsCacheInLocal extends AbstractMySegmentsCacheSync {
+import { AbstractSegmentsCacheSync } from '../AbstractSegmentsCacheSync';
+import { KeyBuilderCS } from '../KeyBuilderCS';
+export declare class MySegmentsCacheInLocal extends AbstractSegmentsCacheSync {
     private readonly keys;
     private readonly log;
-    constructor(log: ILogger, keys: MySegmentsKeyBuilder);
-    protected addSegment(name: string): boolean;
-    protected removeSegment(name: string): boolean;
+    constructor(log: ILogger, keys: KeyBuilderCS);
+    /**
+     * Removes list of segments from localStorage
+     * @NOTE this method is not being used at the moment.
+     */
+    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.
+     *
+     * @param {string[]} segmentNames 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;
-    protected setChangeNumber(changeNumber?: number): void;
-    getChangeNumber(): number;
 }

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

@@ -1,16 +1,22 @@
-import { AbstractMySegmentsCacheSync } from '../AbstractMySegmentsCacheSync';
+import { AbstractSegmentsCacheSync } from '../AbstractSegmentsCacheSync';
 /**
  * Default MySegmentsCacheInMemory implementation that stores MySegments in memory.
  * Supported by all JS runtimes.
  */
-export declare class MySegmentsCacheInMemory extends AbstractMySegmentsCacheSync {
+export declare class MySegmentsCacheInMemory extends AbstractSegmentsCacheSync {
     private segmentCache;
-    private cn?;
-    protected addSegment(name: string): boolean;
-    protected removeSegment(name: string): boolean;
+    clear(): void;
+    addToSegment(name: string): boolean;
+    removeFromSegment(name: string): boolean;
     isInSegment(name: string): boolean;
-    protected setChangeNumber(changeNumber?: number): void;
-    getChangeNumber(): number;
+    /**
+     * 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;
 }