@splitsoftware/splitio-commons 1.16.1-rc.0 → 1.16.1-rc.10

package/types/sync/streaming/SSEHandler/types.d.ts

@@ -1,11 +1,5 @@
 import { ControlType } from '../constants';
-import { MY_SEGMENTS_UPDATE, MY_SEGMENTS_UPDATE_V2, SEGMENT_UPDATE, SPLIT_UPDATE, SPLIT_KILL, CONTROL, OCCUPANCY, MY_LARGE_SEGMENTS_UPDATE } from '../types';
-export interface IMySegmentsUpdateData {
-    type: MY_SEGMENTS_UPDATE;
-    changeNumber: number;
-    includesPayload: boolean;
-    segmentList?: string[];
-}
+import { SEGMENT_UPDATE, SPLIT_UPDATE, SPLIT_KILL, CONTROL, OCCUPANCY, MY_LARGE_SEGMENTS_UPDATE, MY_SEGMENTS_UPDATE_V3 } from '../types';
 export declare enum Compression {
     None = 0,
     Gzip = 1,
@@ -21,25 +15,21 @@ export interface KeyList {
     a?: string[];
     r?: string[];
 }
-export interface IMySegmentsUpdateV2Data {
-    type: MY_SEGMENTS_UPDATE_V2;
-    changeNumber: number;
-    segmentName: string;
-    c: Compression;
-    d: string;
-    u: UpdateStrategy;
-}
-export interface IMyLargeSegmentsUpdateData {
-    type: MY_LARGE_SEGMENTS_UPDATE;
-    changeNumber: number;
-    largeSegments: string[];
-    c: Compression;
-    d: string;
+interface IMySegmentsUpdateData<T extends string> {
+    t: T;
+    cn: number;
+    n?: string[];
+    c?: Compression;
+    d?: string;
     u: UpdateStrategy;
     i?: number;
     h?: number;
     s?: number;
 }
+export interface IMySegmentsUpdateV3Data extends IMySegmentsUpdateData<MY_SEGMENTS_UPDATE_V3> {
+}
+export interface IMyLargeSegmentsUpdateData extends IMySegmentsUpdateData<MY_LARGE_SEGMENTS_UPDATE> {
+}
 export interface ISegmentUpdateData {
     type: SEGMENT_UPDATE;
     changeNumber: number;
@@ -68,7 +58,7 @@ export interface IOccupancyData {
         publishers: number;
     };
 }
-export declare type INotificationData = IMySegmentsUpdateData | IMySegmentsUpdateV2Data | IMyLargeSegmentsUpdateData | ISegmentUpdateData | ISplitUpdateData | ISplitKillData | IControlData | IOccupancyData;
+export declare type INotificationData = IMySegmentsUpdateV3Data | IMyLargeSegmentsUpdateData | ISegmentUpdateData | ISplitUpdateData | ISplitKillData | IControlData | IOccupancyData;
 export declare type INotificationMessage = {
     parsedData: INotificationData;
     channel: string;
@@ -79,3 +69,4 @@ export declare type INotificationError = Event & {
     parsedData?: any;
     message?: string;
 };
+export {};

package/types/sync/streaming/UpdateWorkers/MySegmentsUpdateWorker.d.ts

@@ -1,8 +1,8 @@
-import { IMySegmentsSyncTask } from '../../polling/types';
+import { IMySegmentsSyncTask, MySegmentsData } from '../../polling/types';
 import { IUpdateWorker } from './types';
 import { ITelemetryTracker } from '../../../trackers/types';
 import { UpdatesFromSSEEnum } from '../../submitters/types';
 /**
  * MySegmentsUpdateWorker factory
  */
-export declare function MySegmentsUpdateWorker(mySegmentsSyncTask: IMySegmentsSyncTask, telemetryTracker: ITelemetryTracker, updateType: UpdatesFromSSEEnum): IUpdateWorker;
+export declare function MySegmentsUpdateWorker(mySegmentsSyncTask: IMySegmentsSyncTask, telemetryTracker: ITelemetryTracker, updateType: UpdatesFromSSEEnum): IUpdateWorker<[changeNumber: number, segmentsData?: MySegmentsData, delay?: number]>;

package/types/sync/streaming/UpdateWorkers/SegmentsUpdateWorker.d.ts

@@ -1,8 +1,9 @@
 import { ILogger } from '../../../logger/types';
 import { ISegmentsCacheSync } from '../../../storages/types';
 import { ISegmentsSyncTask } from '../../polling/types';
+import { ISegmentUpdateData } from '../SSEHandler/types';
 import { IUpdateWorker } from './types';
 /**
  * SegmentsUpdateWorker factory
  */
-export declare function SegmentsUpdateWorker(log: ILogger, segmentsSyncTask: ISegmentsSyncTask, segmentsCache: ISegmentsCacheSync): IUpdateWorker;
+export declare function SegmentsUpdateWorker(log: ILogger, segmentsSyncTask: ISegmentsSyncTask, segmentsCache: ISegmentsCacheSync): IUpdateWorker<[ISegmentUpdateData]>;

package/types/sync/streaming/UpdateWorkers/SplitsUpdateWorker.d.ts

@@ -1,13 +1,14 @@
+import { ISplit } from '../../../dtos/types';
 import { ILogger } from '../../../logger/types';
 import { ISplitsEventEmitter } from '../../../readiness/types';
 import { ISplitsCacheSync } from '../../../storages/types';
 import { ITelemetryTracker } from '../../../trackers/types';
 import { ISegmentsSyncTask, ISplitsSyncTask } from '../../polling/types';
-import { ISplitKillData } from '../SSEHandler/types';
+import { ISplitKillData, ISplitUpdateData } from '../SSEHandler/types';
 import { IUpdateWorker } from './types';
 /**
  * SplitsUpdateWorker factory
  */
-export declare function SplitsUpdateWorker(log: ILogger, splitsCache: ISplitsCacheSync, splitsSyncTask: ISplitsSyncTask, splitsEventEmitter: ISplitsEventEmitter, telemetryTracker: ITelemetryTracker, segmentsSyncTask?: ISegmentsSyncTask): IUpdateWorker & {
+export declare function SplitsUpdateWorker(log: ILogger, splitsCache: ISplitsCacheSync, splitsSyncTask: ISplitsSyncTask, splitsEventEmitter: ISplitsEventEmitter, telemetryTracker: ITelemetryTracker, segmentsSyncTask?: ISegmentsSyncTask): IUpdateWorker<[updateData: ISplitUpdateData, payload?: ISplit]> & {
     killSplit(event: ISplitKillData): void;
 };

package/types/sync/streaming/UpdateWorkers/types.d.ts

@@ -1,4 +1,4 @@
-export interface IUpdateWorker {
+export interface IUpdateWorker<T extends any[]> {
     stop(): void;
-    put(...args: any[]): void;
+    put(...args: T): void;
 }

package/types/sync/streaming/constants.d.ts

@@ -19,8 +19,7 @@ export declare const PUSH_SUBSYSTEM_UP = "PUSH_SUBSYSTEM_UP";
  * triggers `startPolling` and `stopWorkers` calls
  */
 export declare const PUSH_SUBSYSTEM_DOWN = "PUSH_SUBSYSTEM_DOWN";
-export declare const MY_SEGMENTS_UPDATE = "MY_SEGMENTS_UPDATE";
-export declare const MY_SEGMENTS_UPDATE_V2 = "MY_SEGMENTS_UPDATE_V2";
+export declare const MY_SEGMENTS_UPDATE_V3 = "MY_SEGMENTS_UPDATE_V3";
 export declare const SEGMENT_UPDATE = "SEGMENT_UPDATE";
 export declare const SPLIT_KILL = "SPLIT_KILL";
 export declare const SPLIT_UPDATE = "SPLIT_UPDATE";

package/types/sync/streaming/parseUtils.d.ts

@@ -1,4 +1,5 @@
-import { Compression, KeyList } from './SSEHandler/types';
+import { Compression, IMyLargeSegmentsUpdateData, KeyList } from './SSEHandler/types';
+import { ISplit } from '../../dtos/types';
 /**
  * Decode, decompress and parse the provided 'data' into a KeyList object
  *
@@ -28,8 +29,6 @@ export declare function parseBitmap(data: string, compression: Compression): Uin
 export declare function isInBitmap(bitmap: Uint8Array, hash64hex: string): boolean;
 /**
  * Parse feature flags notifications for instant feature flag updates
- *
- * @param {ISplitUpdateData} data
- * @returns {KeyList}
  */
-export declare function parseFFUpdatePayload(compression: Compression, data: string): KeyList | undefined;
+export declare function parseFFUpdatePayload(compression: Compression, data: string): ISplit | undefined;
+export declare function getDelay(parsedData: Pick<IMyLargeSegmentsUpdateData, 'i' | 'h' | 's'>, matchingKey: string): number;

package/types/sync/streaming/pushManager.d.ts

@@ -1,8 +1,6 @@
 import { IPushManager } from './types';
 import { IPollingManager } from '../polling/types';
-import { IMyLargeSegmentsUpdateData } from './SSEHandler/types';
 import { ISdkFactoryContextSync } from '../../sdkFactory/types';
-export declare function getDelay(parsedData: IMyLargeSegmentsUpdateData, matchingKey: string): number;
 /**
  * PushManager factory:
  * - for server-side if key is not provided in settings.

package/types/sync/streaming/pushManagerCS_Spec1_3.d.ts

@@ -0,0 +1,9 @@
+import { IPushManager } from './types';
+import { IPollingManager } from '../polling/types';
+import { ISdkFactoryContextSync } from '../../sdkFactory/types';
+/**
+ * PushManager factory:
+ * - for server-side if key is not provided in settings.
+ * - for client-side, with support for multiple clients, if key is provided in settings
+ */
+export declare function pushManagerFactory(params: ISdkFactoryContextSync, pollingManager: IPollingManager): IPushManager | undefined;

package/types/sync/streaming/pushManager_Spec1_3.d.ts

@@ -0,0 +1,9 @@
+import { IPushManager } from './types';
+import { IPollingManager } from '../polling/types';
+import { ISdkFactoryContextSync } from '../../sdkFactory/types';
+/**
+ * PushManager factory:
+ * - for server-side if key is not provided in settings.
+ * - for client-side, with support for multiple clients, if key is provided in settings
+ */
+export declare function pushManagerFactory(params: ISdkFactoryContextSync, pollingManager: IPollingManager): IPushManager | undefined;

package/types/sync/streaming/types.d.ts

@@ -1,4 +1,4 @@
-import { IMySegmentsUpdateData, IMySegmentsUpdateV2Data, ISegmentUpdateData, ISplitUpdateData, ISplitKillData, IMyLargeSegmentsUpdateData } from './SSEHandler/types';
+import { IMySegmentsUpdateV3Data, ISegmentUpdateData, ISplitUpdateData, ISplitKillData, IMyLargeSegmentsUpdateData, INotificationData } from './SSEHandler/types';
 import { ITask } from '../types';
 import { IMySegmentsSyncTask } from '../polling/types';
 import { IEventEmitter } from '../../types';
@@ -7,30 +7,29 @@ export declare type PUSH_SUBSYSTEM_UP = 'PUSH_SUBSYSTEM_UP';
 export declare type PUSH_SUBSYSTEM_DOWN = 'PUSH_SUBSYSTEM_DOWN';
 export declare type PUSH_NONRETRYABLE_ERROR = 'PUSH_NONRETRYABLE_ERROR';
 export declare type PUSH_RETRYABLE_ERROR = 'PUSH_RETRYABLE_ERROR';
-export declare type MY_SEGMENTS_UPDATE = 'MY_SEGMENTS_UPDATE';
-export declare type MY_SEGMENTS_UPDATE_V2 = 'MY_SEGMENTS_UPDATE_V2';
+export declare type MY_SEGMENTS_UPDATE_V3 = 'MY_SEGMENTS_UPDATE_V3';
 export declare type SEGMENT_UPDATE = 'SEGMENT_UPDATE';
 export declare type SPLIT_KILL = 'SPLIT_KILL';
 export declare type SPLIT_UPDATE = 'SPLIT_UPDATE';
 export declare type MY_LARGE_SEGMENTS_UPDATE = 'MY_LARGE_SEGMENTS_UPDATE';
 export declare type CONTROL = 'CONTROL';
 export declare type OCCUPANCY = 'OCCUPANCY';
-export declare type IPushEvent = PUSH_SUBSYSTEM_UP | PUSH_SUBSYSTEM_DOWN | PUSH_NONRETRYABLE_ERROR | PUSH_RETRYABLE_ERROR | MY_SEGMENTS_UPDATE | MY_SEGMENTS_UPDATE_V2 | SEGMENT_UPDATE | SPLIT_UPDATE | SPLIT_KILL | MY_LARGE_SEGMENTS_UPDATE | ControlType.STREAMING_RESET;
-declare type IParsedData<T extends IPushEvent> = T extends MY_SEGMENTS_UPDATE ? IMySegmentsUpdateData : T extends MY_SEGMENTS_UPDATE_V2 ? IMySegmentsUpdateV2Data : T extends MY_LARGE_SEGMENTS_UPDATE ? IMyLargeSegmentsUpdateData : T extends SEGMENT_UPDATE ? ISegmentUpdateData : T extends SPLIT_UPDATE ? ISplitUpdateData : T extends SPLIT_KILL ? ISplitKillData : undefined;
+export declare type IPushEvent = PUSH_SUBSYSTEM_UP | PUSH_SUBSYSTEM_DOWN | PUSH_NONRETRYABLE_ERROR | PUSH_RETRYABLE_ERROR | MY_SEGMENTS_UPDATE_V3 | SEGMENT_UPDATE | SPLIT_UPDATE | SPLIT_KILL | MY_LARGE_SEGMENTS_UPDATE | ControlType.STREAMING_RESET;
+declare type IParsedData<T extends IPushEvent> = T extends MY_SEGMENTS_UPDATE_V3 ? IMySegmentsUpdateV3Data : T extends MY_LARGE_SEGMENTS_UPDATE ? IMyLargeSegmentsUpdateData : T extends SEGMENT_UPDATE ? ISegmentUpdateData : T extends SPLIT_UPDATE ? ISplitUpdateData : T extends SPLIT_KILL ? ISplitKillData : INotificationData;
 /**
  * EventEmitter used as Feedback Loop between the SyncManager and PushManager,
  * where the latter pushes messages and the former consumes it
  */
 export interface IPushEventEmitter extends IEventEmitter {
-    once<T extends IPushEvent>(event: T, listener: (parsedData: IParsedData<T>, channel: T extends MY_SEGMENTS_UPDATE ? string : undefined) => void): this;
-    on<T extends IPushEvent>(event: T, listener: (parsedData: IParsedData<T>, channel: T extends MY_SEGMENTS_UPDATE ? string : undefined) => void): this;
-    emit<T extends IPushEvent>(event: T, parsedData?: IParsedData<T>, channel?: T extends MY_SEGMENTS_UPDATE ? string : undefined): boolean;
+    once<T extends IPushEvent>(event: T, listener: (parsedData: IParsedData<T>) => void): this;
+    on<T extends IPushEvent>(event: T, listener: (parsedData: IParsedData<T>) => void): this;
+    emit<T extends IPushEvent>(event: T, parsedData?: IParsedData<T>): boolean;
 }
 /**
  * PushManager
  */
 export interface IPushManager extends ITask, IPushEventEmitter {
-    add(userKey: string, mySegmentsSyncTask: IMySegmentsSyncTask, myLargeSegmentsSyncTask?: IMySegmentsSyncTask): void;
+    add(userKey: string, mySegmentsSyncTask: IMySegmentsSyncTask): void;
     remove(userKey: string): void;
 }
 export {};

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

@@ -100,7 +100,7 @@ export declare type TOKEN = 'to';
 export declare type SEGMENT = 'se';
 export declare type MY_SEGMENT = 'ms';
 export declare type MY_LARGE_SEGMENT = 'mls';
-export declare type OperationType = SPLITS | IMPRESSIONS | IMPRESSIONS_COUNT | EVENTS | TELEMETRY | TOKEN | SEGMENT | MY_SEGMENT | MY_LARGE_SEGMENT;
+export declare type OperationType = SPLITS | IMPRESSIONS | IMPRESSIONS_COUNT | EVENTS | TELEMETRY | TOKEN | SEGMENT | MY_SEGMENT;
 export declare type LastSync = Partial<Record<OperationType, number | undefined>>;
 export declare type HttpErrors = Partial<Record<OperationType, {
     [statusCode: string]: number;
@@ -177,7 +177,6 @@ export declare type RefreshRates = {
     sp: number;
     se?: number;
     ms?: number;
-    mls?: number;
     im: number;
     ev: number;
     te: number;
@@ -198,7 +197,6 @@ export declare type TelemetryConfigStats = {
 };
 export declare type TelemetryConfigStatsPayload = TelemetryConfigStats & {
     sE: boolean;
-    lE?: boolean;
     rR: RefreshRates;
     uO: UrlOverrides;
     iQ: number;

package/types/types.d.ts

@@ -80,7 +80,6 @@ export interface ISettings {
         metricsRefreshRate?: number;
         telemetryRefreshRate: number;
         segmentsRefreshRate: number;
-        largeSegmentsRefreshRate: number;
         offlineRefreshRate: number;
         eventsPushRate: number;
         eventsQueueSize: number;
@@ -91,7 +90,6 @@ export interface ISettings {
         requestTimeoutBeforeReady: number;
         retriesOnFailureBeforeReady: number;
         eventsFirstPushWindow: number;
-        waitForLargeSegments: boolean;
     };
     readonly storage: IStorageSyncFactory | IStorageAsyncFactory;
     readonly integrations: Array<{
@@ -115,7 +113,6 @@ export interface ISettings {
         __splitFiltersValidation: ISplitFiltersValidation;
         localhostMode?: SplitIO.LocalhostFactory;
         enabled: boolean;
-        largeSegmentsEnabled: boolean;
         flagSpecVersion: string;
     };
     readonly runtime: {
@@ -813,13 +810,6 @@ export declare namespace SplitIO {
              * @default 10
              */
             eventsFirstPushWindow?: number;
-            /**
-             * Whether the SDK should wait for large segments to be ready before emitting SDK_READY event.
-             * It only applies if largeSegmentsEnabled is true.
-             * @property {number} waitForLargeSegments
-             * @default true
-             */
-            waitForLargeSegments?: boolean;
         };
         /**
          * SDK scheduler settings.
@@ -864,13 +854,6 @@ export declare namespace SplitIO {
              * @default 60
              */
             segmentsRefreshRate?: number;
-            /**
-             * The SDK polls Split servers for changes to large segment definitions. This parameter controls this polling period in seconds.
-             * It only applies if largeSegmentsEnabled is true.
-             * @property {number} largeSegmentsRefreshRate
-             * @default 60
-             */
-            largeSegmentsRefreshRate?: number;
             /**
              * The SDK posts the queued events data in bulks. This parameter controls the posting rate in seconds.
              * @property {number} eventsPushRate
@@ -943,14 +926,6 @@ export declare namespace SplitIO {
          * @property {Object} urls
          */
         urls?: UrlSettings;
-        sync?: ISharedSettings['sync'] & {
-            /**
-             * Enables synchronization of large segments.
-             * @property {boolean} largeSegmentsEnabled
-             * @default false
-             */
-            largeSegmentsEnabled?: boolean;
-        };
     }
     /**
      * Settings interface for SDK instances created on NodeJS.

package/types/utils/constants/index.d.ts

@@ -79,6 +79,6 @@ export declare const NON_REQUESTED = 1;
 export declare const DISABLED = 0;
 export declare const ENABLED = 1;
 export declare const PAUSED = 2;
-export declare const FLAG_SPEC_VERSION = "1.1";
+export declare const FLAG_SPEC_VERSION = "1.2";
 export declare const IN_SEGMENT = "IN_SEGMENT";
 export declare const IN_LARGE_SEGMENT = "IN_LARGE_SEGMENT";

package/types/utils/settingsValidation/index.d.ts

@@ -12,7 +12,6 @@ export declare const base: {
     scheduler: {
         featuresRefreshRate: number;
         segmentsRefreshRate: number;
-        largeSegmentsRefreshRate: number;
         telemetryRefreshRate: number;
         impressionsRefreshRate: number;
         offlineRefreshRate: number;
@@ -40,7 +39,6 @@ export declare const base: {
         localhostMode: undefined;
         enabled: boolean;
         flagSpecVersion: string;
-        largeSegmentsEnabled: boolean;
     };
     log: undefined;
 };