Merge pull request #514 from splitio/development

Release v3.1.0

Author: EmilianoSanchez

CHANGES.txt

@@ -1,3 +1,7 @@
+3.1.0 (July 23, 2026)
+ - Added support for rule-based segments in /api/v1/configs endpoint.
+ - Updated polling flow to fetch new referenced segments immediately.
+
 3.0.0 (June 26, 2026)
  - Extracted SDK lifecycle methods (`init`, `flush`, and `destroy`) into a reusable `sdkLifecycle` module.
  - Extracted the `track` method into a standalone `trackMethod` factory for reuse across SDKs.

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "Split JavaScript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",

package.json

@@ -192,7 +192,7 @@ export interface IDefinitionCondition {
     matchers: IDefinitionMatcher[]
   }
   partitions?: IDefinitionPartition[]
-  label?: string
+  label?: string | null
   conditionType?: 'ROLLOUT' | 'WHITELIST'
 }
 

src/dtos/types.ts

@@ -7,12 +7,12 @@ import SplitIO from '../../../types/splitio';
 import { ILogger } from '../../logger/types';
 
 // Build Evaluation object if and only if matchingResult is true
-function match(log: ILogger, matchingResult: boolean, bucketingKey: string | undefined, seed?: number, treatments?: { getTreatmentFor: (x: number) => string }, label?: string): IEvaluation | boolean | undefined {
+function match(log: ILogger, matchingResult: boolean, bucketingKey: string | undefined, seed?: number, treatments?: { getTreatmentFor: (x: number) => string }, label?: string | null): IEvaluation | boolean | undefined {
   if (matchingResult) {
     return treatments ? // Feature flag
       {
         treatment: getTreatment(log, bucketingKey as string, seed, treatments),
-        label: label!
+        label: label ?? ''
       } : // Rule-based segment
       true;
   }
@@ -22,7 +22,7 @@ function match(log: ILogger, matchingResult: boolean, bucketingKey: string | und
 }
 
 // Condition factory
-export function conditionContext(log: ILogger, matcherEvaluator: (key: SplitIO.SplitKeyObject, attributes?: SplitIO.Attributes, splitEvaluator?: IDefinitionEvaluator) => MaybeThenable<boolean>, treatments?: { getTreatmentFor: (x: number) => string }, label?: string, conditionType?: 'ROLLOUT' | 'WHITELIST'): IEvaluator {
+export function conditionContext(log: ILogger, matcherEvaluator: (key: SplitIO.SplitKeyObject, attributes?: SplitIO.Attributes, splitEvaluator?: IDefinitionEvaluator) => MaybeThenable<boolean>, treatments?: { getTreatmentFor: (x: number) => string }, label?: string | null, conditionType?: 'ROLLOUT' | 'WHITELIST'): IEvaluator {
 
   return function conditionEvaluator(key: SplitIO.SplitKeyObject, seed?: number, trafficAllocation?: number, trafficAllocationSeed?: number, attributes?: SplitIO.Attributes, splitEvaluator?: IDefinitionEvaluator) {
 

src/evaluator/condition/index.ts

@@ -1,5 +1,6 @@
 import { releaseApiKey, validateAndTrackApiKey } from '../utils/inputValidation/apiKey';
 import { ISdkFactoryContext } from '../sdkFactory/types';
+import { LOCALHOST_MODE } from '../utils/constants';
 
 const COOLDOWN_TIME_IN_MILLIS = 1000;
 
@@ -12,7 +13,7 @@ export function sdkLifecycleFactory(params: ISdkFactoryContext, isSharedClient?:
   let hasInit = false;
   let lastActionTime = 0;
 
-  const signalListener = platform.SignalListener && new platform.SignalListener(params);
+  const signalListener = platform.SignalListener && settings.mode !== LOCALHOST_MODE ? new platform.SignalListener(params) : undefined;
 
   function __cooldown(func: Function, time: number) {
     const now = Date.now();

src/sdkClient/sdkLifecycle.ts

@@ -105,11 +105,7 @@ export interface ISdkFactoryParams {
 
   // Sdk client method factory.
   // It Allows to distinguish SDK clients with the client-side API (`IBrowserSDK` and `IBrowserAsyncSDK`) or server-side API (`ISDK` and `IAsyncSDK`).
-  sdkClientMethodFactory: (params: ISdkFactoryContext) => (
-    { (): SplitIO.IBrowserClient & { init(): void }; (key: SplitIO.SplitKey): SplitIO.IBrowserClient & { init(): void }; } |
-    (() => SplitIO.IClient & { init(): void }) |
-    (() => SplitIO.IAsyncClient & { init(): void })
-  )
+  sdkClientMethodFactory: (params: ISdkFactoryContext) => ({ (): SplitIO.IBrowserClient; (key: SplitIO.SplitKey): SplitIO.IBrowserClient; } | (() => SplitIO.IClient) | (() => SplitIO.IAsyncClient))
 
   // Impression observer factory.
   impressionsObserverFactory: () => IImpressionObserver

src/sdkFactory/types.ts

@@ -45,10 +45,10 @@ describe('serviceApi', () => {
     assertHeaders(settings, headers);
     expect(url).toBe(expectedFlagsUrl(-1, 100, settings.validateFilters || false, settings, -1));
 
-    serviceApi.fetchConfigs(-1, false, 100);
+    serviceApi.fetchConfigs(-1, false, 100, -1);
     [url, { headers }] = fetchMock.mock.calls[4];
     assertHeaders(settings, headers);
-    expect(url).toBe(expectedConfigsUrl(-1, 100, settings.validateFilters || false, settings));
+    expect(url).toBe(expectedConfigsUrl(-1, 100, settings.validateFilters || false, settings, -1));
 
     serviceApi.fetchConfigsSegmentChanges(-1, 'segmentName', false, 100);
     [url, { headers }] = fetchMock.mock.calls[5];
@@ -81,9 +81,9 @@ describe('serviceApi', () => {
       return `sdk/splitChanges?s=1.1&since=${since}${rbSince ? '&rbSince=' + rbSince : ''}${usesFilter ? filterQueryString : ''}${till ? '&till=' + till : ''}`;
     }
 
-    function expectedConfigsUrl(since: number, till: number, usesFilter: boolean, settings: ISettings) {
+    function expectedConfigsUrl(since: number, till: number, usesFilter: boolean, settings: ISettings, rbSince?: number) {
       const filterQueryString = settings.sync.__splitFiltersValidation && settings.sync.__splitFiltersValidation.queryString;
-      return `configs/v1/configs?since=${since}${usesFilter ? filterQueryString : ''}${till ? '&till=' + till : ''}`;
+      return `configs/v1/configs?since=${since}${rbSince ? '&rbSince=' + rbSince : ''}${usesFilter ? filterQueryString : ''}${till ? '&till=' + till : ''}`;
     }
   });
 

src/services/__tests__/splitApi.spec.ts

@@ -70,8 +70,8 @@ export function serviceApiFactory(
     },
 
     // @TODO support filterQueryString and handle ERROR_TOO_MANY_SETS error
-    fetchConfigs(since: number, noCache?: boolean, till?: number) {
-      const url = `${urls.configs}/api/v1/configs?since=${since}${filterQueryString || ''}${till ? '&till=' + till : ''}`;
+    fetchConfigs(since: number, noCache?: boolean, till?: number, rbSince?: number) {
+      const url = `${urls.configs}/api/v1/configs?since=${since}${rbSince ? '&rbSince=' + rbSince : ''}${filterQueryString || ''}${till ? '&till=' + till : ''}`;
       return secureSplitHttpClient(url, noCache ? noCacheHeaderOptions : undefined);
     },
 

src/services/serviceApi.ts

@@ -149,8 +149,8 @@ export function splitApiFactory(
 
     // Not used. Just here to satisfy the IServiceApi interface.
 
-    fetchConfigs(since: number, noCache?: boolean, till?: number) {
-      const url = `${urls.configs}/v1/configs?since=${since}${filterQueryString || ''}${till ? '&till=' + till : ''}`;
+    fetchConfigs(since: number, noCache?: boolean, till?: number, rbSince?: number) {
+      const url = `${urls.configs}/v1/configs?since=${since}${rbSince ? '&rbSince=' + rbSince : ''}${filterQueryString || ''}${till ? '&till=' + till : ''}`;
       return splitHttpClient(url, noCache ? noCacheHeaderOptions : undefined);
     },