@splitsoftware/splitio-commons 1.16.1-rc.8 → 1.17.0-rc.1

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

@@ -24,7 +24,6 @@ export declare const MY_SEGMENTS_UPDATE_V2 = "MY_SEGMENTS_UPDATE_V2";
 export declare const SEGMENT_UPDATE = "SEGMENT_UPDATE";
 export declare const SPLIT_KILL = "SPLIT_KILL";
 export declare const SPLIT_UPDATE = "SPLIT_UPDATE";
-export declare const MY_LARGE_SEGMENTS_UPDATE = "MY_LARGE_SEGMENTS_UPDATE";
 export declare const CONTROL = "CONTROL";
 export declare const OCCUPANCY = "OCCUPANCY";
 export declare enum ControlType {

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

@@ -1,5 +1,4 @@
 import { Compression, KeyList } from './SSEHandler/types';
-import { ISplit } from '../../dtos/types';
 /**
  * Decode, decompress and parse the provided 'data' into a KeyList object
  *
@@ -29,5 +28,8 @@ 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): ISplit | undefined;
+export declare function parseFFUpdatePayload(compression: Compression, data: string): KeyList | undefined;

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: Pick<IMyLargeSegmentsUpdateData, 'i' | 'h' | 's'>, matchingKey: string): number;
 /**
  * PushManager factory:
  * - for server-side if key is not provided in settings.

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

@@ -1,4 +1,4 @@
-import { IMySegmentsUpdateData, IMySegmentsUpdateV2Data, ISegmentUpdateData, ISplitUpdateData, ISplitKillData, IMyLargeSegmentsUpdateData } from './SSEHandler/types';
+import { IMySegmentsUpdateData, IMySegmentsUpdateV2Data, ISegmentUpdateData, ISplitUpdateData, ISplitKillData } from './SSEHandler/types';
 import { ITask } from '../types';
 import { IMySegmentsSyncTask } from '../polling/types';
 import { IEventEmitter } from '../../types';
@@ -12,11 +12,10 @@ export declare type MY_SEGMENTS_UPDATE_V2 = 'MY_SEGMENTS_UPDATE_V2';
 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 | MY_SEGMENTS_UPDATE_V2 | SEGMENT_UPDATE | SPLIT_UPDATE | SPLIT_KILL | ControlType.STREAMING_RESET;
+declare type IParsedData<T extends IPushEvent> = T extends MY_SEGMENTS_UPDATE ? IMySegmentsUpdateData : T extends MY_SEGMENTS_UPDATE_V2 ? IMySegmentsUpdateV2Data : T extends SEGMENT_UPDATE ? ISegmentUpdateData : T extends SPLIT_UPDATE ? ISplitUpdateData : T extends SPLIT_KILL ? ISplitKillData : undefined;
 /**
  * EventEmitter used as Feedback Loop between the SyncManager and PushManager,
  * where the latter pushes messages and the former consumes it
@@ -30,7 +29,7 @@ export interface IPushEventEmitter extends IEventEmitter {
  * 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

@@ -90,7 +90,7 @@ export declare type DROPPED = 1;
 export declare type DEDUPED = 2;
 export declare type ImpressionDataType = QUEUED | DROPPED | DEDUPED;
 export declare type EventDataType = QUEUED | DROPPED;
-export declare type UpdatesFromSSEEnum = SPLITS | MY_SEGMENT | MY_LARGE_SEGMENT;
+export declare type UpdatesFromSSEEnum = SPLITS | MY_SEGMENT;
 export declare type SPLITS = 'sp';
 export declare type IMPRESSIONS = 'im';
 export declare type IMPRESSIONS_COUNT = 'ic';
@@ -99,8 +99,7 @@ export declare type TELEMETRY = 'te';
 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;
@@ -137,9 +136,8 @@ export declare type TelemetryUsageStats = {
     mE?: MethodExceptions;
 };
 export declare type UpdatesFromSSE = {
-    sp?: number;
+    sp: number;
     ms?: number;
-    mls?: number;
 };
 export declare type TelemetryUsageStatsPayload = TelemetryUsageStats & {
     lS: LastSync;
@@ -153,8 +151,6 @@ export declare type TelemetryUsageStatsPayload = TelemetryUsageStats & {
     spC?: number;
     seC?: number;
     skC?: number;
-    lseC?: number;
-    lskC?: number;
     sL?: number;
     eQ: number;
     eD: number;
@@ -177,7 +173,6 @@ export declare type RefreshRates = {
     sp: number;
     se?: number;
     ms?: number;
-    mls?: number;
     im: number;
     ev: number;
     te: number;
@@ -198,8 +193,6 @@ export declare type TelemetryConfigStats = {
 };
 export declare type TelemetryConfigStatsPayload = TelemetryConfigStats & {
     sE: boolean;
-    lsE?: boolean;
-    wls?: 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,8 +113,12 @@ export interface ISettings {
         __splitFiltersValidation: ISplitFiltersValidation;
         localhostMode?: SplitIO.LocalhostFactory;
         enabled: boolean;
-        largeSegmentsEnabled: boolean;
         flagSpecVersion: string;
+        requestOptions?: {
+            getHeaderOverrides?: (context: {
+                headers: Record<string, string>;
+            }) => Record<string, string>;
+        };
     };
     readonly runtime: {
         ip: string | false;
@@ -215,7 +217,12 @@ interface ISharedSettings {
          * Enables synchronization.
          * @property {boolean} enabled
          */
-        enabled: boolean;
+        enabled?: boolean;
+        requestOptions?: {
+            getHeaderOverrides?: (context: {
+                headers: Record<string, string>;
+            }) => Record<string, string>;
+        };
     };
 }
 /**
@@ -813,13 +820,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 +864,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 +936,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

@@ -53,7 +53,6 @@ export declare const TELEMETRY = "te";
 export declare const TOKEN = "to";
 export declare const SEGMENT = "se";
 export declare const MY_SEGMENT = "ms";
-export declare const MY_LARGE_SEGMENT = "mls";
 export declare const TREATMENT = "t";
 export declare const TREATMENTS = "ts";
 export declare const TREATMENT_WITH_CONFIG = "tc";
@@ -79,6 +78,5 @@ 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.2";
+export declare const FLAG_SPEC_VERSION = "1.1";
 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;
 };

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

@@ -28,7 +28,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/cjs/evaluator/matchers/large_segment.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.largeSegmentMatcherContext = void 0;
-var thenable_1 = require("../../utils/promise/thenable");
-function largeSegmentMatcherContext(largeSegmentName, storage) {
-    return function largeSegmentMatcher(key) {
-        var isInLargeSegment = storage.largeSegments ? storage.largeSegments.isInSegment(largeSegmentName, key) : false;
-        if ((0, thenable_1.thenable)(isInLargeSegment)) {
-            isInLargeSegment.then(function (result) {
-                return result;
-            });
-        }
-        return isInLargeSegment;
-    };
-}
-exports.largeSegmentMatcherContext = largeSegmentMatcherContext;

package/esm/evaluator/matchers/large_segment.js

@@ -1,12 +0,0 @@
-import { thenable } from '../../utils/promise/thenable';
-export function largeSegmentMatcherContext(largeSegmentName, storage) {
-    return function largeSegmentMatcher(key) {
-        var isInLargeSegment = storage.largeSegments ? storage.largeSegments.isInSegment(largeSegmentName, key) : false;
-        if (thenable(isInLargeSegment)) {
-            isInLargeSegment.then(function (result) {
-                return result;
-            });
-        }
-        return isInLargeSegment;
-    };
-}

package/src/evaluator/matchers/large_segment.ts

@@ -1,18 +0,0 @@
-import { MaybeThenable } from '../../dtos/types';
-import { ISegmentsCacheBase } from '../../storages/types';
-import { thenable } from '../../utils/promise/thenable';
-
-export function largeSegmentMatcherContext(largeSegmentName: string, storage: { largeSegments?: ISegmentsCacheBase }) {
-
-  return function largeSegmentMatcher(key: string): MaybeThenable<boolean> {
-    const isInLargeSegment = storage.largeSegments ? storage.largeSegments.isInSegment(largeSegmentName, key) : false;
-
-    if (thenable(isInLargeSegment)) {
-      isInLargeSegment.then(result => {
-        return result;
-      });
-    }
-
-    return isInLargeSegment;
-  };
-}