@splitsoftware/splitio-commons 1.14.0 → 1.14.1-rc.0

package/CHANGES.txt

@@ -1,3 +1,6 @@
+1.15.0 (May 15, 2024)
+ - Added an optional settings validation parameter to let overwrite the default flag spec version, used by the JS Synchronizer.
+
 1.14.0 (May 6, 2024)
  - Added support for targeting rules based on semantic versions (https://semver.org/).
  - Added special impression label "targeting rule type unsupported by sdk" when the matcher type is not supported by the SDK, which returns 'control' treatment.

package/cjs/services/splitApi.js

@@ -20,6 +20,7 @@ function splitApiFactory(settings, platform, telemetryTracker) {
     var urls = settings.urls;
     var filterQueryString = settings.sync.__splitFiltersValidation && settings.sync.__splitFiltersValidation.queryString;
     var SplitSDKImpressionsMode = settings.sync.impressionsMode;
+    var flagSpecVersion = settings.sync.flagSpecVersion;
     var splitHttpClient = (0, splitHttpClient_1.splitHttpClientFactory)(settings, platform.getFetch);
     return {
         // @TODO throw errors if health check requests fail, to log them in the Synchronizer
@@ -32,7 +33,7 @@ function splitApiFactory(settings, platform, telemetryTracker) {
             return splitHttpClient(url).then(function () { return true; }).catch(function () { return false; });
         },
         fetchAuth: function (userMatchingKeys) {
-            var url = urls.auth + "/v2/auth?s=" + constants_1.FLAGS_SPEC;
+            var url = urls.auth + "/v2/auth?s=" + flagSpecVersion;
             if (userMatchingKeys) { // `userMatchingKeys` is undefined in server-side
                 var queryParams = userMatchingKeys.map(userKeyToQueryParam).join('&');
                 if (queryParams)
@@ -41,7 +42,7 @@ function splitApiFactory(settings, platform, telemetryTracker) {
             return splitHttpClient(url, undefined, telemetryTracker.trackHttp(constants_1.TOKEN));
         },
         fetchSplitChanges: function (since, noCache, till) {
-            var url = urls.sdk + "/splitChanges?s=" + constants_1.FLAGS_SPEC + "&since=" + since + (filterQueryString || '') + (till ? '&till=' + till : '');
+            var url = urls.sdk + "/splitChanges?s=" + flagSpecVersion + "&since=" + since + (filterQueryString || '') + (till ? '&till=' + till : '');
             return splitHttpClient(url, noCache ? noCacheHeaderOptions : undefined, telemetryTracker.trackHttp(constants_1.SPLITS))
                 .catch(function (err) {
                 if (err.statusCode === 414)

package/cjs/storages/KeyBuilder.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getStorageHash = exports.KeyBuilder = exports.validatePrefix = void 0;
-var constants_1 = require("../utils/constants");
 var lang_1 = require("../utils/lang");
 var murmur3_1 = require("../utils/murmur3/murmur3");
 var everythingAtTheEnd = /[^.]+$/;
@@ -71,6 +70,6 @@ exports.KeyBuilder = KeyBuilder;
  * The hash is in hexadecimal format (8 characters max, 32 bits).
  */
 function getStorageHash(settings) {
-    return (0, murmur3_1.hash)(settings.core.authorizationKey + "::" + settings.sync.__splitFiltersValidation.queryString + "::" + constants_1.FLAGS_SPEC).toString(16);
+    return (0, murmur3_1.hash)(settings.core.authorizationKey + "::" + settings.sync.__splitFiltersValidation.queryString + "::" + settings.sync.flagSpecVersion).toString(16);
 }
 exports.getStorageHash = getStorageHash;

package/cjs/sync/streaming/SSEClient/index.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SSEClient = void 0;
 var lang_1 = require("../../../utils/lang");
-var VERSION = '1.1';
+var ABLY_API_VERSION = '1.1';
 var CONTROL_CHANNEL_REGEX = /^control_/;
 /**
  * Build metadata headers for SSE connection.
@@ -60,7 +60,7 @@ var SSEClient = /** @class */ (function () {
             var params = CONTROL_CHANNEL_REGEX.test(channel) ? '[?occupancy=metrics.publishers]' : '';
             return encodeURIComponent(params + channel);
         }).join(',');
-        var url = this.streamingUrl + "?channels=" + channelsQueryParam + "&accessToken=" + authToken.token + "&v=" + VERSION + "&heartbeats=true"; // same results using `&heartbeats=false`
+        var url = this.streamingUrl + "?channels=" + channelsQueryParam + "&accessToken=" + authToken.token + "&v=" + ABLY_API_VERSION + "&heartbeats=true"; // same results using `&heartbeats=false`
         this.connection = new this.eventSource(
         // For client-side SDKs, SplitSDKClientKey and SplitSDKClientKey metadata is passed as query params,
         // because native EventSource implementations for browser doesn't support headers.

package/cjs/utils/constants/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MY_SEGMENT = exports.SEGMENT = exports.TOKEN = exports.TELEMETRY = exports.EVENTS = exports.IMPRESSIONS_COUNT = exports.IMPRESSIONS = exports.SPLITS = exports.NONE_ENUM = exports.DEBUG_ENUM = exports.OPTIMIZED_ENUM = exports.CONSUMER_PARTIAL_ENUM = exports.CONSUMER_ENUM = exports.STANDALONE_ENUM = exports.DEDUPED = exports.DROPPED = exports.QUEUED = exports.NAMES_FN_LABEL = exports.SPLITS_FN_LABEL = exports.SPLIT_FN_LABEL = exports.TRACK_FN_LABEL = exports.GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SETS = exports.GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SET = exports.GET_TREATMENTS_BY_FLAG_SETS = exports.GET_TREATMENTS_BY_FLAG_SET = exports.GET_TREATMENTS_WITH_CONFIG = exports.GET_TREATMENT_WITH_CONFIG = exports.GET_TREATMENTS = exports.GET_TREATMENT = exports.CONSENT_UNKNOWN = exports.CONSENT_DECLINED = exports.CONSENT_GRANTED = exports.STORAGE_PLUGGABLE = exports.STORAGE_REDIS = exports.STORAGE_LOCALSTORAGE = exports.STORAGE_MEMORY = exports.CONSUMER_PARTIAL_MODE = exports.CONSUMER_MODE = exports.PRODUCER_MODE = exports.STANDALONE_MODE = exports.LOCALHOST_MODE = exports.NONE = exports.OPTIMIZED = exports.DEBUG = exports.SPLIT_EVENT = exports.SPLIT_IMPRESSION = exports.NA = exports.UNKNOWN = exports.CONTROL_WITH_CONFIG = exports.CONTROL = void 0;
-exports.FLAGS_SPEC = exports.PAUSED = exports.ENABLED = exports.DISABLED = exports.NON_REQUESTED = exports.REQUESTED = exports.POLLING = exports.STREAMING = exports.AUTH_REJECTION = exports.SYNC_MODE_UPDATE = exports.ABLY_ERROR = exports.TOKEN_REFRESH = exports.SSE_CONNECTION_ERROR = exports.STREAMING_STATUS = exports.OCCUPANCY_SEC = exports.OCCUPANCY_PRI = exports.CONNECTION_ESTABLISHED = exports.TRACK = exports.TREATMENTS_WITH_CONFIG_BY_FLAGSETS = exports.TREATMENTS_WITH_CONFIG_BY_FLAGSET = exports.TREATMENTS_BY_FLAGSETS = exports.TREATMENTS_BY_FLAGSET = exports.TREATMENTS_WITH_CONFIG = exports.TREATMENT_WITH_CONFIG = exports.TREATMENTS = exports.TREATMENT = void 0;
+exports.FLAG_SPEC_VERSION = exports.PAUSED = exports.ENABLED = exports.DISABLED = exports.NON_REQUESTED = exports.REQUESTED = exports.POLLING = exports.STREAMING = exports.AUTH_REJECTION = exports.SYNC_MODE_UPDATE = exports.ABLY_ERROR = exports.TOKEN_REFRESH = exports.SSE_CONNECTION_ERROR = exports.STREAMING_STATUS = exports.OCCUPANCY_SEC = exports.OCCUPANCY_PRI = exports.CONNECTION_ESTABLISHED = exports.TRACK = exports.TREATMENTS_WITH_CONFIG_BY_FLAGSETS = exports.TREATMENTS_WITH_CONFIG_BY_FLAGSET = exports.TREATMENTS_BY_FLAGSETS = exports.TREATMENTS_BY_FLAGSET = exports.TREATMENTS_WITH_CONFIG = exports.TREATMENT_WITH_CONFIG = exports.TREATMENTS = exports.TREATMENT = void 0;
 // Special treatments
 exports.CONTROL = 'control';
 exports.CONTROL_WITH_CONFIG = {
@@ -90,4 +90,4 @@ exports.NON_REQUESTED = 1;
 exports.DISABLED = 0;
 exports.ENABLED = 1;
 exports.PAUSED = 2;
-exports.FLAGS_SPEC = '1.1';
+exports.FLAG_SPEC_VERSION = '1.1';

package/cjs/utils/settingsValidation/index.js

@@ -74,7 +74,8 @@ exports.base = {
         // impressions collection mode
         impressionsMode: constants_1.OPTIMIZED,
         localhostMode: undefined,
-        enabled: true
+        enabled: true,
+        flagSpecVersion: constants_1.FLAG_SPEC_VERSION
     },
     // Logger
     log: undefined
@@ -90,7 +91,7 @@ function fromSecondsToMillis(n) {
  * @param validationParams defaults and fields validators used to validate and creates a settings object from a given config
  */
 function settingsValidation(config, validationParams) {
-    var defaults = validationParams.defaults, runtime = validationParams.runtime, storage = validationParams.storage, integrations = validationParams.integrations, logger = validationParams.logger, localhost = validationParams.localhost, consent = validationParams.consent;
+    var defaults = validationParams.defaults, runtime = validationParams.runtime, storage = validationParams.storage, integrations = validationParams.integrations, logger = validationParams.logger, localhost = validationParams.localhost, consent = validationParams.consent, flagSpec = validationParams.flagSpec;
     // creates a settings object merging base, defaults and config objects.
     var withDefaults = (0, lang_1.merge)({}, exports.base, defaults, config);
     // ensure a valid logger.
@@ -98,7 +99,8 @@ function settingsValidation(config, validationParams) {
     var log = logger(withDefaults); // @ts-ignore, modify readonly prop
     withDefaults.log = log;
     // ensure a valid impressionsMode
-    withDefaults.sync.impressionsMode = (0, impressionsMode_1.validImpressionsMode)(log, withDefaults.sync.impressionsMode);
+    var sync = withDefaults.sync;
+    sync.impressionsMode = (0, impressionsMode_1.validImpressionsMode)(log, sync.impressionsMode);
     function validateMinValue(paramName, actualValue, minValue) {
         if (actualValue >= minValue)
             return actualValue;
@@ -114,7 +116,7 @@ function settingsValidation(config, validationParams) {
     scheduler.eventsPushRate = fromSecondsToMillis(scheduler.eventsPushRate);
     scheduler.telemetryRefreshRate = fromSecondsToMillis(validateMinValue('telemetryRefreshRate', scheduler.telemetryRefreshRate, 60));
     // Default impressionsRefreshRate for DEBUG mode is 60 secs
-    if ((0, lang_1.get)(config, 'scheduler.impressionsRefreshRate') === undefined && withDefaults.sync.impressionsMode === constants_1.DEBUG)
+    if ((0, lang_1.get)(config, 'scheduler.impressionsRefreshRate') === undefined && sync.impressionsMode === constants_1.DEBUG)
         scheduler.impressionsRefreshRate = 60;
     scheduler.impressionsRefreshRate = fromSecondsToMillis(scheduler.impressionsRefreshRate);
     // Log deprecation for old telemetry param
@@ -166,22 +168,23 @@ function settingsValidation(config, validationParams) {
     if (integrations)
         withDefaults.integrations = integrations(withDefaults);
     if (localhost)
-        withDefaults.sync.localhostMode = localhost(withDefaults);
+        sync.localhostMode = localhost(withDefaults);
     // validate push options
     if (withDefaults.streamingEnabled !== false) { // @ts-ignore, modify readonly prop
         withDefaults.streamingEnabled = true;
         // Backoff bases.
-        // We are not checking if bases are positive numbers. Thus, we might be reauthenticating immediately (`setTimeout` with NaN or negative number)
+        // We are not checking if bases are positive numbers. Thus, we might be re-authenticating immediately (`setTimeout` with NaN or negative number)
         scheduler.pushRetryBackoffBase = fromSecondsToMillis(scheduler.pushRetryBackoffBase);
     }
     // validate sync enabled
-    if (withDefaults.sync.enabled !== false) { // @ts-ignore, modify readonly prop
-        withDefaults.sync.enabled = true;
+    if (sync.enabled !== false) {
+        sync.enabled = true;
     }
     // validate the `splitFilters` settings and parse splits query
-    var splitFiltersValidation = (0, splitFilters_1.validateSplitFilters)(log, withDefaults.sync.splitFilters, withDefaults.mode);
-    withDefaults.sync.splitFilters = splitFiltersValidation.validFilters;
-    withDefaults.sync.__splitFiltersValidation = splitFiltersValidation;
+    var splitFiltersValidation = (0, splitFilters_1.validateSplitFilters)(log, sync.splitFilters, withDefaults.mode);
+    sync.splitFilters = splitFiltersValidation.validFilters;
+    sync.__splitFiltersValidation = splitFiltersValidation;
+    sync.flagSpecVersion = flagSpec ? flagSpec(withDefaults) : constants_1.FLAG_SPEC_VERSION;
     // ensure a valid user consent value
     // @ts-ignore, modify readonly prop
     withDefaults.userConsent = consent(withDefaults);

package/esm/services/splitApi.js

@@ -1,6 +1,6 @@
 import { splitHttpClientFactory } from './splitHttpClient';
 import { objectAssign } from '../utils/lang/objectAssign';
-import { SPLITS, IMPRESSIONS, IMPRESSIONS_COUNT, EVENTS, TELEMETRY, TOKEN, SEGMENT, MY_SEGMENT, FLAGS_SPEC } from '../utils/constants';
+import { SPLITS, IMPRESSIONS, IMPRESSIONS_COUNT, EVENTS, TELEMETRY, TOKEN, SEGMENT, MY_SEGMENT } from '../utils/constants';
 import { ERROR_TOO_MANY_SETS } from '../logger/constants';
 var noCacheHeaderOptions = { headers: { 'Cache-Control': 'no-cache' } };
 function userKeyToQueryParam(userKey) {
@@ -17,6 +17,7 @@ export function splitApiFactory(settings, platform, telemetryTracker) {
     var urls = settings.urls;
     var filterQueryString = settings.sync.__splitFiltersValidation && settings.sync.__splitFiltersValidation.queryString;
     var SplitSDKImpressionsMode = settings.sync.impressionsMode;
+    var flagSpecVersion = settings.sync.flagSpecVersion;
     var splitHttpClient = splitHttpClientFactory(settings, platform.getFetch);
     return {
         // @TODO throw errors if health check requests fail, to log them in the Synchronizer
@@ -29,7 +30,7 @@ export function splitApiFactory(settings, platform, telemetryTracker) {
             return splitHttpClient(url).then(function () { return true; }).catch(function () { return false; });
         },
         fetchAuth: function (userMatchingKeys) {
-            var url = urls.auth + "/v2/auth?s=" + FLAGS_SPEC;
+            var url = urls.auth + "/v2/auth?s=" + flagSpecVersion;
             if (userMatchingKeys) { // `userMatchingKeys` is undefined in server-side
                 var queryParams = userMatchingKeys.map(userKeyToQueryParam).join('&');
                 if (queryParams)
@@ -38,7 +39,7 @@ export function splitApiFactory(settings, platform, telemetryTracker) {
             return splitHttpClient(url, undefined, telemetryTracker.trackHttp(TOKEN));
         },
         fetchSplitChanges: function (since, noCache, till) {
-            var url = urls.sdk + "/splitChanges?s=" + FLAGS_SPEC + "&since=" + since + (filterQueryString || '') + (till ? '&till=' + till : '');
+            var url = urls.sdk + "/splitChanges?s=" + flagSpecVersion + "&since=" + since + (filterQueryString || '') + (till ? '&till=' + till : '');
             return splitHttpClient(url, noCache ? noCacheHeaderOptions : undefined, telemetryTracker.trackHttp(SPLITS))
                 .catch(function (err) {
                 if (err.statusCode === 414)

package/esm/storages/KeyBuilder.js

@@ -1,4 +1,3 @@
-import { FLAGS_SPEC } from '../utils/constants';
 import { startsWith } from '../utils/lang';
 import { hash } from '../utils/murmur3/murmur3';
 var everythingAtTheEnd = /[^.]+$/;
@@ -67,5 +66,5 @@ export { KeyBuilder };
  * The hash is in hexadecimal format (8 characters max, 32 bits).
  */
 export function getStorageHash(settings) {
-    return hash(settings.core.authorizationKey + "::" + settings.sync.__splitFiltersValidation.queryString + "::" + FLAGS_SPEC).toString(16);
+    return hash(settings.core.authorizationKey + "::" + settings.sync.__splitFiltersValidation.queryString + "::" + settings.sync.flagSpecVersion).toString(16);
 }

package/esm/sync/streaming/SSEClient/index.js

@@ -1,5 +1,5 @@
 import { isString } from '../../../utils/lang';
-var VERSION = '1.1';
+var ABLY_API_VERSION = '1.1';
 var CONTROL_CHANNEL_REGEX = /^control_/;
 /**
  * Build metadata headers for SSE connection.
@@ -57,7 +57,7 @@ var SSEClient = /** @class */ (function () {
             var params = CONTROL_CHANNEL_REGEX.test(channel) ? '[?occupancy=metrics.publishers]' : '';
             return encodeURIComponent(params + channel);
         }).join(',');
-        var url = this.streamingUrl + "?channels=" + channelsQueryParam + "&accessToken=" + authToken.token + "&v=" + VERSION + "&heartbeats=true"; // same results using `&heartbeats=false`
+        var url = this.streamingUrl + "?channels=" + channelsQueryParam + "&accessToken=" + authToken.token + "&v=" + ABLY_API_VERSION + "&heartbeats=true"; // same results using `&heartbeats=false`
         this.connection = new this.eventSource(
         // For client-side SDKs, SplitSDKClientKey and SplitSDKClientKey metadata is passed as query params,
         // because native EventSource implementations for browser doesn't support headers.

package/esm/utils/constants/index.js

@@ -86,4 +86,4 @@ export var NON_REQUESTED = 1;
 export var DISABLED = 0;
 export var ENABLED = 1;
 export var PAUSED = 2;
-export var FLAGS_SPEC = '1.1';
+export var FLAG_SPEC_VERSION = '1.1';

package/esm/utils/settingsValidation/index.js

@@ -1,7 +1,7 @@
 import { merge, get } from '../lang';
 import { validateMode } from './mode';
 import { validateSplitFilters } from './splitFilters';
-import { STANDALONE_MODE, OPTIMIZED, LOCALHOST_MODE, DEBUG } from '../constants';
+import { STANDALONE_MODE, OPTIMIZED, LOCALHOST_MODE, DEBUG, FLAG_SPEC_VERSION } from '../constants';
 import { validImpressionsMode } from './impressionsMode';
 import { validateKey } from '../inputValidation/key';
 import { validateTrafficType } from '../inputValidation/trafficType';
@@ -71,7 +71,8 @@ export var base = {
         // impressions collection mode
         impressionsMode: OPTIMIZED,
         localhostMode: undefined,
-        enabled: true
+        enabled: true,
+        flagSpecVersion: FLAG_SPEC_VERSION
     },
     // Logger
     log: undefined
@@ -87,7 +88,7 @@ function fromSecondsToMillis(n) {
  * @param validationParams defaults and fields validators used to validate and creates a settings object from a given config
  */
 export function settingsValidation(config, validationParams) {
-    var defaults = validationParams.defaults, runtime = validationParams.runtime, storage = validationParams.storage, integrations = validationParams.integrations, logger = validationParams.logger, localhost = validationParams.localhost, consent = validationParams.consent;
+    var defaults = validationParams.defaults, runtime = validationParams.runtime, storage = validationParams.storage, integrations = validationParams.integrations, logger = validationParams.logger, localhost = validationParams.localhost, consent = validationParams.consent, flagSpec = validationParams.flagSpec;
     // creates a settings object merging base, defaults and config objects.
     var withDefaults = merge({}, base, defaults, config);
     // ensure a valid logger.
@@ -95,7 +96,8 @@ export function settingsValidation(config, validationParams) {
     var log = logger(withDefaults); // @ts-ignore, modify readonly prop
     withDefaults.log = log;
     // ensure a valid impressionsMode
-    withDefaults.sync.impressionsMode = validImpressionsMode(log, withDefaults.sync.impressionsMode);
+    var sync = withDefaults.sync;
+    sync.impressionsMode = validImpressionsMode(log, sync.impressionsMode);
     function validateMinValue(paramName, actualValue, minValue) {
         if (actualValue >= minValue)
             return actualValue;
@@ -111,7 +113,7 @@ export function settingsValidation(config, validationParams) {
     scheduler.eventsPushRate = fromSecondsToMillis(scheduler.eventsPushRate);
     scheduler.telemetryRefreshRate = fromSecondsToMillis(validateMinValue('telemetryRefreshRate', scheduler.telemetryRefreshRate, 60));
     // Default impressionsRefreshRate for DEBUG mode is 60 secs
-    if (get(config, 'scheduler.impressionsRefreshRate') === undefined && withDefaults.sync.impressionsMode === DEBUG)
+    if (get(config, 'scheduler.impressionsRefreshRate') === undefined && sync.impressionsMode === DEBUG)
         scheduler.impressionsRefreshRate = 60;
     scheduler.impressionsRefreshRate = fromSecondsToMillis(scheduler.impressionsRefreshRate);
     // Log deprecation for old telemetry param
@@ -163,22 +165,23 @@ export function settingsValidation(config, validationParams) {
     if (integrations)
         withDefaults.integrations = integrations(withDefaults);
     if (localhost)
-        withDefaults.sync.localhostMode = localhost(withDefaults);
+        sync.localhostMode = localhost(withDefaults);
     // validate push options
     if (withDefaults.streamingEnabled !== false) { // @ts-ignore, modify readonly prop
         withDefaults.streamingEnabled = true;
         // Backoff bases.
-        // We are not checking if bases are positive numbers. Thus, we might be reauthenticating immediately (`setTimeout` with NaN or negative number)
+        // We are not checking if bases are positive numbers. Thus, we might be re-authenticating immediately (`setTimeout` with NaN or negative number)
         scheduler.pushRetryBackoffBase = fromSecondsToMillis(scheduler.pushRetryBackoffBase);
     }
     // validate sync enabled
-    if (withDefaults.sync.enabled !== false) { // @ts-ignore, modify readonly prop
-        withDefaults.sync.enabled = true;
+    if (sync.enabled !== false) {
+        sync.enabled = true;
     }
     // validate the `splitFilters` settings and parse splits query
-    var splitFiltersValidation = validateSplitFilters(log, withDefaults.sync.splitFilters, withDefaults.mode);
-    withDefaults.sync.splitFilters = splitFiltersValidation.validFilters;
-    withDefaults.sync.__splitFiltersValidation = splitFiltersValidation;
+    var splitFiltersValidation = validateSplitFilters(log, sync.splitFilters, withDefaults.mode);
+    sync.splitFilters = splitFiltersValidation.validFilters;
+    sync.__splitFiltersValidation = splitFiltersValidation;
+    sync.flagSpecVersion = flagSpec ? flagSpec(withDefaults) : FLAG_SPEC_VERSION;
     // ensure a valid user consent value
     // @ts-ignore, modify readonly prop
     withDefaults.userConsent = consent(withDefaults);

package/package.json

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

package/src/services/splitApi.ts

@@ -4,7 +4,7 @@ import { splitHttpClientFactory } from './splitHttpClient';
 import { ISplitApi } from './types';
 import { objectAssign } from '../utils/lang/objectAssign';
 import { ITelemetryTracker } from '../trackers/types';
-import { SPLITS, IMPRESSIONS, IMPRESSIONS_COUNT, EVENTS, TELEMETRY, TOKEN, SEGMENT, MY_SEGMENT, FLAGS_SPEC } from '../utils/constants';
+import { SPLITS, IMPRESSIONS, IMPRESSIONS_COUNT, EVENTS, TELEMETRY, TOKEN, SEGMENT, MY_SEGMENT } from '../utils/constants';
 import { ERROR_TOO_MANY_SETS } from '../logger/constants';
 
 const noCacheHeaderOptions = { headers: { 'Cache-Control': 'no-cache' } };
@@ -29,6 +29,7 @@ export function splitApiFactory(
   const urls = settings.urls;
   const filterQueryString = settings.sync.__splitFiltersValidation && settings.sync.__splitFiltersValidation.queryString;
   const SplitSDKImpressionsMode = settings.sync.impressionsMode;
+  const flagSpecVersion = settings.sync.flagSpecVersion;
   const splitHttpClient = splitHttpClientFactory(settings, platform.getFetch);
 
   return {
@@ -44,7 +45,7 @@ export function splitApiFactory(
     },
 
     fetchAuth(userMatchingKeys?: string[]) {
-      let url = `${urls.auth}/v2/auth?s=${FLAGS_SPEC}`;
+      let url = `${urls.auth}/v2/auth?s=${flagSpecVersion}`;
       if (userMatchingKeys) { // `userMatchingKeys` is undefined in server-side
         const queryParams = userMatchingKeys.map(userKeyToQueryParam).join('&');
         if (queryParams) url += '&' + queryParams;
@@ -53,7 +54,7 @@ export function splitApiFactory(
     },
 
     fetchSplitChanges(since: number, noCache?: boolean, till?: number) {
-      const url = `${urls.sdk}/splitChanges?s=${FLAGS_SPEC}&since=${since}${filterQueryString || ''}${till ? '&till=' + till : ''}`;
+      const url = `${urls.sdk}/splitChanges?s=${flagSpecVersion}&since=${since}${filterQueryString || ''}${till ? '&till=' + till : ''}`;
       return splitHttpClient(url, noCache ? noCacheHeaderOptions : undefined, telemetryTracker.trackHttp(SPLITS))
         .catch((err) => {
           if (err.statusCode === 414) settings.log.error(ERROR_TOO_MANY_SETS);

package/src/storages/KeyBuilder.ts

@@ -1,5 +1,4 @@
 import { ISettings } from '../types';
-import { FLAGS_SPEC } from '../utils/constants';
 import { startsWith } from '../utils/lang';
 import { hash } from '../utils/murmur3/murmur3';
 
@@ -86,5 +85,5 @@ export class KeyBuilder {
  * The hash is in hexadecimal format (8 characters max, 32 bits).
  */
 export function getStorageHash(settings: ISettings) {
-  return hash(`${settings.core.authorizationKey}::${settings.sync.__splitFiltersValidation.queryString}::${FLAGS_SPEC}`).toString(16);
+  return hash(`${settings.core.authorizationKey}::${settings.sync.__splitFiltersValidation.queryString}::${settings.sync.flagSpecVersion}`).toString(16);
 }

package/src/sync/streaming/SSEClient/index.ts

@@ -4,7 +4,7 @@ import { isString } from '../../../utils/lang';
 import { IAuthTokenPushEnabled } from '../AuthClient/types';
 import { ISSEClient, ISseEventHandler } from './types';
 
-const VERSION = '1.1';
+const ABLY_API_VERSION = '1.1';
 
 const CONTROL_CHANNEL_REGEX = /^control_/;
 
@@ -78,7 +78,7 @@ export class SSEClient implements ISSEClient {
         return encodeURIComponent(params + channel);
       }
     ).join(',');
-    const url = `${this.streamingUrl}?channels=${channelsQueryParam}&accessToken=${authToken.token}&v=${VERSION}&heartbeats=true`; // same results using `&heartbeats=false`
+    const url = `${this.streamingUrl}?channels=${channelsQueryParam}&accessToken=${authToken.token}&v=${ABLY_API_VERSION}&heartbeats=true`; // same results using `&heartbeats=false`
 
     this.connection = new this.eventSource!(
       // For client-side SDKs, SplitSDKClientKey and SplitSDKClientKey metadata is passed as query params,

package/src/types.ts

@@ -118,7 +118,8 @@ export interface ISettings {
     impressionsMode: SplitIO.ImpressionsMode,
     __splitFiltersValidation: ISplitFiltersValidation,
     localhostMode?: SplitIO.LocalhostFactory,
-    enabled: boolean
+    enabled: boolean,
+    flagSpecVersion: string
   },
   readonly runtime: {
     ip: string | false

package/src/utils/constants/index.ts

@@ -105,4 +105,4 @@ export const DISABLED = 0;
 export const ENABLED = 1;
 export const PAUSED = 2;
 
-export const FLAGS_SPEC = '1.1';
+export const FLAG_SPEC_VERSION = '1.1';

package/src/utils/settingsValidation/index.ts

@@ -1,7 +1,7 @@
 import { merge, get } from '../lang';
 import { validateMode } from './mode';
 import { validateSplitFilters } from './splitFilters';
-import { STANDALONE_MODE, OPTIMIZED, LOCALHOST_MODE, DEBUG } from '../constants';
+import { STANDALONE_MODE, OPTIMIZED, LOCALHOST_MODE, DEBUG, FLAG_SPEC_VERSION } from '../constants';
 import { validImpressionsMode } from './impressionsMode';
 import { ISettingsValidationParams } from './types';
 import { ISettings } from '../../types';
@@ -84,7 +84,8 @@ export const base = {
     // impressions collection mode
     impressionsMode: OPTIMIZED,
     localhostMode: undefined,
-    enabled: true
+    enabled: true,
+    flagSpecVersion: FLAG_SPEC_VERSION
   },
 
   // Logger
@@ -104,7 +105,7 @@ function fromSecondsToMillis(n: number) {
  */
 export function settingsValidation(config: unknown, validationParams: ISettingsValidationParams) {
 
-  const { defaults, runtime, storage, integrations, logger, localhost, consent } = validationParams;
+  const { defaults, runtime, storage, integrations, logger, localhost, consent, flagSpec } = validationParams;
 
   // creates a settings object merging base, defaults and config objects.
   const withDefaults = merge({}, base, defaults, config) as ISettings;
@@ -115,7 +116,8 @@ export function settingsValidation(config: unknown, validationParams: ISettingsV
   withDefaults.log = log;
 
   // ensure a valid impressionsMode
-  withDefaults.sync.impressionsMode = validImpressionsMode(log, withDefaults.sync.impressionsMode);
+  const sync = withDefaults.sync;
+  sync.impressionsMode = validImpressionsMode(log, sync.impressionsMode);
 
   function validateMinValue(paramName: string, actualValue: number, minValue: number) {
     if (actualValue >= minValue) return actualValue;
@@ -133,7 +135,7 @@ export function settingsValidation(config: unknown, validationParams: ISettingsV
   scheduler.telemetryRefreshRate = fromSecondsToMillis(validateMinValue('telemetryRefreshRate', scheduler.telemetryRefreshRate, 60));
 
   // Default impressionsRefreshRate for DEBUG mode is 60 secs
-  if (get(config, 'scheduler.impressionsRefreshRate') === undefined && withDefaults.sync.impressionsMode === DEBUG) scheduler.impressionsRefreshRate = 60;
+  if (get(config, 'scheduler.impressionsRefreshRate') === undefined && sync.impressionsMode === DEBUG) scheduler.impressionsRefreshRate = 60;
   scheduler.impressionsRefreshRate = fromSecondsToMillis(scheduler.impressionsRefreshRate);
 
   // Log deprecation for old telemetry param
@@ -186,25 +188,26 @@ export function settingsValidation(config: unknown, validationParams: ISettingsV
   // @ts-ignore, modify readonly prop
   if (integrations) withDefaults.integrations = integrations(withDefaults);
 
-  if (localhost) withDefaults.sync.localhostMode = localhost(withDefaults);
+  if (localhost) sync.localhostMode = localhost(withDefaults);
 
   // validate push options
   if (withDefaults.streamingEnabled !== false) { // @ts-ignore, modify readonly prop
     withDefaults.streamingEnabled = true;
     // Backoff bases.
-    // We are not checking if bases are positive numbers. Thus, we might be reauthenticating immediately (`setTimeout` with NaN or negative number)
+    // We are not checking if bases are positive numbers. Thus, we might be re-authenticating immediately (`setTimeout` with NaN or negative number)
     scheduler.pushRetryBackoffBase = fromSecondsToMillis(scheduler.pushRetryBackoffBase);
   }
 
   // validate sync enabled
-  if (withDefaults.sync.enabled !== false) { // @ts-ignore, modify readonly prop
-    withDefaults.sync.enabled = true;
+  if (sync.enabled !== false) {
+    sync.enabled = true;
   }
 
   // validate the `splitFilters` settings and parse splits query
-  const splitFiltersValidation = validateSplitFilters(log, withDefaults.sync.splitFilters, withDefaults.mode);
-  withDefaults.sync.splitFilters = splitFiltersValidation.validFilters;
-  withDefaults.sync.__splitFiltersValidation = splitFiltersValidation;
+  const splitFiltersValidation = validateSplitFilters(log, sync.splitFilters, withDefaults.mode);
+  sync.splitFilters = splitFiltersValidation.validFilters;
+  sync.__splitFiltersValidation = splitFiltersValidation;
+  sync.flagSpecVersion = flagSpec ? flagSpec(withDefaults) : FLAG_SPEC_VERSION;
 
   // ensure a valid user consent value
   // @ts-ignore, modify readonly prop

package/src/utils/settingsValidation/types.ts

@@ -26,4 +26,6 @@ export interface ISettingsValidationParams {
   localhost?: (settings: ISettings) => ISettings['sync']['localhostMode'],
   /** User consent validator (`settings.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/types.d.ts

@@ -113,6 +113,7 @@ export interface ISettings {
         __splitFiltersValidation: ISplitFiltersValidation;
         localhostMode?: SplitIO.LocalhostFactory;
         enabled: boolean;
+        flagSpecVersion: string;
     };
     readonly runtime: {
         ip: string | false;

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

@@ -78,4 +78,4 @@ export declare const NON_REQUESTED = 1;
 export declare const DISABLED = 0;
 export declare const ENABLED = 1;
 export declare const PAUSED = 2;
-export declare const FLAGS_SPEC = "1.1";
+export declare const FLAG_SPEC_VERSION = "1.1";

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

@@ -38,6 +38,7 @@ export declare const base: {
         impressionsMode: string;
         localhostMode: undefined;
         enabled: boolean;
+        flagSpecVersion: string;
     };
     log: undefined;
 };

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

@@ -29,4 +29,6 @@ export interface ISettingsValidationParams {
     localhost?: (settings: ISettings) => ISettings['sync']['localhostMode'];
     /** User consent validator (`settings.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'];
 }