@splitsoftware/splitio-commons 2.8.0 → 2.8.1-rc.1

package/CHANGES.txt

@@ -1,3 +1,6 @@
+2.9.0 
+ - Added property `impressionsDisabled` in getTreatment(s) `evaluationOptions` parameter, to disable impressions per evaluations.
+
 2.8.0 (October 30, 2025)
  - Added new configuration for Fallback Treatments, which allows setting a treatment value and optional config to be returned in place of "control", either globally or by flag. Read more in our docs.
  - Added `client.getStatus()` method to retrieve the client readiness status properties (`isReady`, `isReadyFromCache`, etc).

package/cjs/evaluator/index.js

@@ -19,7 +19,7 @@ function treatmentsException(splitNames) {
     });
     return evaluations;
 }
-function evaluateFeature(log, key, splitName, attributes, storage) {
+function evaluateFeature(log, key, splitName, attributes, storage, options) {
     var parsedSplit;
     try {
         parsedSplit = storage.splits.getSplit(splitName);
@@ -29,15 +29,15 @@ function evaluateFeature(log, key, splitName, attributes, storage) {
         return treatmentException;
     }
     if ((0, thenable_1.thenable)(parsedSplit)) {
-        return parsedSplit.then(function (split) { return getEvaluation(log, key, split, attributes, storage); }).catch(
+        return parsedSplit.then(function (split) { return getEvaluation(log, key, split, attributes, storage, options); }).catch(
         // Exception on async `getSplit` storage. For example, when the storage is redis or
         // pluggable and there is a connection issue and we can't retrieve the split to be evaluated
         function () { return treatmentException; });
     }
-    return getEvaluation(log, key, parsedSplit, attributes, storage);
+    return getEvaluation(log, key, parsedSplit, attributes, storage, options);
 }
 exports.evaluateFeature = evaluateFeature;
-function evaluateFeatures(log, key, splitNames, attributes, storage) {
+function evaluateFeatures(log, key, splitNames, attributes, storage, options) {
     var parsedSplits;
     try {
         parsedSplits = storage.splits.getSplits(splitNames);
@@ -47,16 +47,16 @@ function evaluateFeatures(log, key, splitNames, attributes, storage) {
         return treatmentsException(splitNames);
     }
     return (0, thenable_1.thenable)(parsedSplits) ?
-        parsedSplits.then(function (splits) { return getEvaluations(log, key, splitNames, splits, attributes, storage); })
+        parsedSplits.then(function (splits) { return getEvaluations(log, key, splitNames, splits, attributes, storage, options); })
             .catch(function () {
             // Exception on async `getSplits` storage. For example, when the storage is redis or
             // pluggable and there is a connection issue and we can't retrieve the split to be evaluated
             return treatmentsException(splitNames);
         }) :
-        getEvaluations(log, key, splitNames, parsedSplits, attributes, storage);
+        getEvaluations(log, key, splitNames, parsedSplits, attributes, storage, options);
 }
 exports.evaluateFeatures = evaluateFeatures;
-function evaluateFeaturesByFlagSets(log, key, flagSets, attributes, storage, method) {
+function evaluateFeaturesByFlagSets(log, key, flagSets, attributes, storage, method, options) {
     var storedFlagNames;
     function evaluate(featureFlagsByFlagSets) {
         var featureFlags = new Set();
@@ -70,7 +70,7 @@ function evaluateFeaturesByFlagSets(log, key, flagSets, attributes, storage, met
             }
         }
         return featureFlags.size ?
-            evaluateFeatures(log, key, (0, sets_1.setToArray)(featureFlags), attributes, storage) :
+            evaluateFeatures(log, key, (0, sets_1.setToArray)(featureFlags), attributes, storage, options) :
             {};
     }
     // get features by flag sets
@@ -90,7 +90,7 @@ function evaluateFeaturesByFlagSets(log, key, flagSets, attributes, storage, met
         evaluate(storedFlagNames);
 }
 exports.evaluateFeaturesByFlagSets = evaluateFeaturesByFlagSets;
-function getEvaluation(log, key, splitJSON, attributes, storage) {
+function getEvaluation(log, key, splitJSON, attributes, storage, options) {
     var evaluation = {
         treatment: constants_1.CONTROL,
         label: labels_1.SPLIT_NOT_FOUND,
@@ -104,23 +104,23 @@ function getEvaluation(log, key, splitJSON, attributes, storage) {
             return evaluation.then(function (result) {
                 result.changeNumber = splitJSON.changeNumber;
                 result.config = splitJSON.configurations && splitJSON.configurations[result.treatment] || null;
-                result.impressionsDisabled = splitJSON.impressionsDisabled;
+                result.impressionsDisabled = (options === null || options === void 0 ? void 0 : options.impressionsDisabled) || splitJSON.impressionsDisabled;
                 return result;
             });
         }
         else {
             evaluation.changeNumber = splitJSON.changeNumber;
             evaluation.config = splitJSON.configurations && splitJSON.configurations[evaluation.treatment] || null;
-            evaluation.impressionsDisabled = splitJSON.impressionsDisabled;
+            evaluation.impressionsDisabled = (options === null || options === void 0 ? void 0 : options.impressionsDisabled) || splitJSON.impressionsDisabled;
         }
     }
     return evaluation;
 }
-function getEvaluations(log, key, splitNames, splits, attributes, storage) {
+function getEvaluations(log, key, splitNames, splits, attributes, storage, options) {
     var result = {};
     var thenables = [];
     splitNames.forEach(function (splitName) {
-        var evaluation = getEvaluation(log, key, splits[splitName], attributes, storage);
+        var evaluation = getEvaluation(log, key, splits[splitName], attributes, storage, options);
         if ((0, thenable_1.thenable)(evaluation)) {
             thenables.push(evaluation.then(function (res) {
                 result[splitName] = res;

package/cjs/sdkClient/client.js

@@ -45,7 +45,7 @@ function clientFactory(params) {
             return treatment;
         };
         var evaluation = readinessManager.isReadyFromCache() ?
-            (0, evaluator_1.evaluateFeature)(log, key, featureFlagName, attributes, storage) :
+            (0, evaluator_1.evaluateFeature)(log, key, featureFlagName, attributes, storage, options) :
             isAsync ? // If the SDK is not ready, treatment may be incorrect due to having splits but not segments data, or storage is not connected
                 Promise.resolve(treatmentNotReady) :
                 treatmentNotReady;
@@ -70,7 +70,7 @@ function clientFactory(params) {
             return treatments;
         };
         var evaluations = readinessManager.isReadyFromCache() ?
-            (0, evaluator_1.evaluateFeatures)(log, key, featureFlagNames, attributes, storage) :
+            (0, evaluator_1.evaluateFeatures)(log, key, featureFlagNames, attributes, storage, options) :
             isAsync ? // If the SDK is not ready, treatment may be incorrect due to having splits but not segments data, or storage is not connected
                 Promise.resolve(treatmentsNotReady(featureFlagNames)) :
                 treatmentsNotReady(featureFlagNames);
@@ -96,7 +96,7 @@ function clientFactory(params) {
             return treatments;
         };
         var evaluations = readinessManager.isReadyFromCache() ?
-            (0, evaluator_1.evaluateFeaturesByFlagSets)(log, key, flagSetNames, attributes, storage, methodName) :
+            (0, evaluator_1.evaluateFeaturesByFlagSets)(log, key, flagSetNames, attributes, storage, methodName, options) :
             isAsync ?
                 Promise.resolve({}) :
                 {};

package/cjs/utils/inputValidation/eventProperties.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateEvaluationOptions = exports.validateEventProperties = void 0;
+var tslib_1 = require("tslib");
 var lang_1 = require("../lang");
 var objectAssign_1 = require("../lang/objectAssign");
 var constants_1 = require("../../logger/constants");
@@ -64,7 +65,11 @@ exports.validateEventProperties = validateEventProperties;
 function validateEvaluationOptions(log, maybeOptions, method) {
     if ((0, lang_1.isObject)(maybeOptions)) {
         var properties = validateEventProperties(log, maybeOptions.properties, method).properties;
-        return properties && Object.keys(properties).length > 0 ? { properties: properties } : undefined;
+        var options = properties && Object.keys(properties).length > 0 ? { properties: properties } : undefined;
+        var impressionsDisabled = maybeOptions.impressionsDisabled;
+        if (!impressionsDisabled)
+            return options;
+        return options ? (0, tslib_1.__assign)((0, tslib_1.__assign)({}, options), { impressionsDisabled: impressionsDisabled }) : { impressionsDisabled: impressionsDisabled };
     }
     else if (maybeOptions) {
         log.error(constants_1.ERROR_NOT_PLAIN_OBJECT, [method, 'evaluation options']);

package/esm/evaluator/index.js

@@ -16,7 +16,7 @@ function treatmentsException(splitNames) {
     });
     return evaluations;
 }
-export function evaluateFeature(log, key, splitName, attributes, storage) {
+export function evaluateFeature(log, key, splitName, attributes, storage, options) {
     var parsedSplit;
     try {
         parsedSplit = storage.splits.getSplit(splitName);
@@ -26,14 +26,14 @@ export function evaluateFeature(log, key, splitName, attributes, storage) {
         return treatmentException;
     }
     if (thenable(parsedSplit)) {
-        return parsedSplit.then(function (split) { return getEvaluation(log, key, split, attributes, storage); }).catch(
+        return parsedSplit.then(function (split) { return getEvaluation(log, key, split, attributes, storage, options); }).catch(
         // Exception on async `getSplit` storage. For example, when the storage is redis or
         // pluggable and there is a connection issue and we can't retrieve the split to be evaluated
         function () { return treatmentException; });
     }
-    return getEvaluation(log, key, parsedSplit, attributes, storage);
+    return getEvaluation(log, key, parsedSplit, attributes, storage, options);
 }
-export function evaluateFeatures(log, key, splitNames, attributes, storage) {
+export function evaluateFeatures(log, key, splitNames, attributes, storage, options) {
     var parsedSplits;
     try {
         parsedSplits = storage.splits.getSplits(splitNames);
@@ -43,15 +43,15 @@ export function evaluateFeatures(log, key, splitNames, attributes, storage) {
         return treatmentsException(splitNames);
     }
     return thenable(parsedSplits) ?
-        parsedSplits.then(function (splits) { return getEvaluations(log, key, splitNames, splits, attributes, storage); })
+        parsedSplits.then(function (splits) { return getEvaluations(log, key, splitNames, splits, attributes, storage, options); })
             .catch(function () {
             // Exception on async `getSplits` storage. For example, when the storage is redis or
             // pluggable and there is a connection issue and we can't retrieve the split to be evaluated
             return treatmentsException(splitNames);
         }) :
-        getEvaluations(log, key, splitNames, parsedSplits, attributes, storage);
+        getEvaluations(log, key, splitNames, parsedSplits, attributes, storage, options);
 }
-export function evaluateFeaturesByFlagSets(log, key, flagSets, attributes, storage, method) {
+export function evaluateFeaturesByFlagSets(log, key, flagSets, attributes, storage, method, options) {
     var storedFlagNames;
     function evaluate(featureFlagsByFlagSets) {
         var featureFlags = new Set();
@@ -65,7 +65,7 @@ export function evaluateFeaturesByFlagSets(log, key, flagSets, attributes, stora
             }
         }
         return featureFlags.size ?
-            evaluateFeatures(log, key, setToArray(featureFlags), attributes, storage) :
+            evaluateFeatures(log, key, setToArray(featureFlags), attributes, storage, options) :
             {};
     }
     // get features by flag sets
@@ -84,7 +84,7 @@ export function evaluateFeaturesByFlagSets(log, key, flagSets, attributes, stora
         }) :
         evaluate(storedFlagNames);
 }
-function getEvaluation(log, key, splitJSON, attributes, storage) {
+function getEvaluation(log, key, splitJSON, attributes, storage, options) {
     var evaluation = {
         treatment: CONTROL,
         label: SPLIT_NOT_FOUND,
@@ -98,23 +98,23 @@ function getEvaluation(log, key, splitJSON, attributes, storage) {
             return evaluation.then(function (result) {
                 result.changeNumber = splitJSON.changeNumber;
                 result.config = splitJSON.configurations && splitJSON.configurations[result.treatment] || null;
-                result.impressionsDisabled = splitJSON.impressionsDisabled;
+                result.impressionsDisabled = (options === null || options === void 0 ? void 0 : options.impressionsDisabled) || splitJSON.impressionsDisabled;
                 return result;
             });
         }
         else {
             evaluation.changeNumber = splitJSON.changeNumber;
             evaluation.config = splitJSON.configurations && splitJSON.configurations[evaluation.treatment] || null;
-            evaluation.impressionsDisabled = splitJSON.impressionsDisabled;
+            evaluation.impressionsDisabled = (options === null || options === void 0 ? void 0 : options.impressionsDisabled) || splitJSON.impressionsDisabled;
         }
     }
     return evaluation;
 }
-function getEvaluations(log, key, splitNames, splits, attributes, storage) {
+function getEvaluations(log, key, splitNames, splits, attributes, storage, options) {
     var result = {};
     var thenables = [];
     splitNames.forEach(function (splitName) {
-        var evaluation = getEvaluation(log, key, splits[splitName], attributes, storage);
+        var evaluation = getEvaluation(log, key, splits[splitName], attributes, storage, options);
         if (thenable(evaluation)) {
             thenables.push(evaluation.then(function (res) {
                 result[splitName] = res;

package/esm/sdkClient/client.js

@@ -42,7 +42,7 @@ export function clientFactory(params) {
             return treatment;
         };
         var evaluation = readinessManager.isReadyFromCache() ?
-            evaluateFeature(log, key, featureFlagName, attributes, storage) :
+            evaluateFeature(log, key, featureFlagName, attributes, storage, options) :
             isAsync ? // If the SDK is not ready, treatment may be incorrect due to having splits but not segments data, or storage is not connected
                 Promise.resolve(treatmentNotReady) :
                 treatmentNotReady;
@@ -67,7 +67,7 @@ export function clientFactory(params) {
             return treatments;
         };
         var evaluations = readinessManager.isReadyFromCache() ?
-            evaluateFeatures(log, key, featureFlagNames, attributes, storage) :
+            evaluateFeatures(log, key, featureFlagNames, attributes, storage, options) :
             isAsync ? // If the SDK is not ready, treatment may be incorrect due to having splits but not segments data, or storage is not connected
                 Promise.resolve(treatmentsNotReady(featureFlagNames)) :
                 treatmentsNotReady(featureFlagNames);
@@ -93,7 +93,7 @@ export function clientFactory(params) {
             return treatments;
         };
         var evaluations = readinessManager.isReadyFromCache() ?
-            evaluateFeaturesByFlagSets(log, key, flagSetNames, attributes, storage, methodName) :
+            evaluateFeaturesByFlagSets(log, key, flagSetNames, attributes, storage, methodName, options) :
             isAsync ?
                 Promise.resolve({}) :
                 {};

package/esm/utils/inputValidation/eventProperties.js

@@ -1,3 +1,4 @@
+import { __assign } from "tslib";
 import { isObject, isString, isFiniteNumber, isBoolean } from '../lang';
 import { objectAssign } from '../lang/objectAssign';
 import { ERROR_NOT_PLAIN_OBJECT, ERROR_SIZE_EXCEEDED, WARN_SETTING_NULL, WARN_TRIMMING_PROPERTIES } from '../../logger/constants';
@@ -60,7 +61,11 @@ export function validateEventProperties(log, maybeProperties, method) {
 export function validateEvaluationOptions(log, maybeOptions, method) {
     if (isObject(maybeOptions)) {
         var properties = validateEventProperties(log, maybeOptions.properties, method).properties;
-        return properties && Object.keys(properties).length > 0 ? { properties: properties } : undefined;
+        var options = properties && Object.keys(properties).length > 0 ? { properties: properties } : undefined;
+        var impressionsDisabled = maybeOptions.impressionsDisabled;
+        if (!impressionsDisabled)
+            return options;
+        return options ? __assign(__assign({}, options), { impressionsDisabled: impressionsDisabled }) : { impressionsDisabled: impressionsDisabled };
     }
     else if (maybeOptions) {
         log.error(ERROR_NOT_PLAIN_OBJECT, [method, 'evaluation options']);

package/package.json

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

package/src/evaluator/index.ts

@@ -30,6 +30,7 @@ export function evaluateFeature(
   splitName: string,
   attributes: SplitIO.Attributes | undefined,
   storage: IStorageSync | IStorageAsync,
+  options?: SplitIO.EvaluationOptions
 ): MaybeThenable<IEvaluationResult> {
   let parsedSplit;
 
@@ -47,6 +48,7 @@ export function evaluateFeature(
       split,
       attributes,
       storage,
+      options,
     )).catch(
       // Exception on async `getSplit` storage. For example, when the storage is redis or
       // pluggable and there is a connection issue and we can't retrieve the split to be evaluated
@@ -60,6 +62,7 @@ export function evaluateFeature(
     parsedSplit,
     attributes,
     storage,
+    options,
   );
 }
 
@@ -69,6 +72,7 @@ export function evaluateFeatures(
   splitNames: string[],
   attributes: SplitIO.Attributes | undefined,
   storage: IStorageSync | IStorageAsync,
+  options?: SplitIO.EvaluationOptions,
 ): MaybeThenable<Record<string, IEvaluationResult>> {
   let parsedSplits;
 
@@ -80,13 +84,13 @@ export function evaluateFeatures(
   }
 
   return thenable(parsedSplits) ?
-    parsedSplits.then(splits => getEvaluations(log, key, splitNames, splits, attributes, storage))
+    parsedSplits.then(splits => getEvaluations(log, key, splitNames, splits, attributes, storage, options))
       .catch(() => {
         // Exception on async `getSplits` storage. For example, when the storage is redis or
         // pluggable and there is a connection issue and we can't retrieve the split to be evaluated
         return treatmentsException(splitNames);
       }) :
-    getEvaluations(log, key, splitNames, parsedSplits, attributes, storage);
+    getEvaluations(log, key, splitNames, parsedSplits, attributes, storage, options);
 }
 
 export function evaluateFeaturesByFlagSets(
@@ -96,6 +100,7 @@ export function evaluateFeaturesByFlagSets(
   attributes: SplitIO.Attributes | undefined,
   storage: IStorageSync | IStorageAsync,
   method: string,
+  options?: SplitIO.EvaluationOptions,
 ): MaybeThenable<Record<string, IEvaluationResult>> {
   let storedFlagNames: MaybeThenable<Set<string>[]>;
 
@@ -111,7 +116,7 @@ export function evaluateFeaturesByFlagSets(
     }
 
     return featureFlags.size ?
-      evaluateFeatures(log, key, setToArray(featureFlags), attributes, storage) :
+      evaluateFeatures(log, key, setToArray(featureFlags), attributes, storage, options) :
       {};
   }
 
@@ -138,6 +143,7 @@ function getEvaluation(
   splitJSON: ISplit | null,
   attributes: SplitIO.Attributes | undefined,
   storage: IStorageSync | IStorageAsync,
+  options?: SplitIO.EvaluationOptions,
 ): MaybeThenable<IEvaluationResult> {
   let evaluation: MaybeThenable<IEvaluationResult> = {
     treatment: CONTROL,
@@ -154,14 +160,14 @@ function getEvaluation(
       return evaluation.then(result => {
         result.changeNumber = splitJSON.changeNumber;
         result.config = splitJSON.configurations && splitJSON.configurations[result.treatment] || null;
-        result.impressionsDisabled = splitJSON.impressionsDisabled;
+        result.impressionsDisabled = options?.impressionsDisabled || splitJSON.impressionsDisabled;
 
         return result;
       });
     } else {
       evaluation.changeNumber = splitJSON.changeNumber;
       evaluation.config = splitJSON.configurations && splitJSON.configurations[evaluation.treatment] || null;
-      evaluation.impressionsDisabled = splitJSON.impressionsDisabled;
+      evaluation.impressionsDisabled = options?.impressionsDisabled || splitJSON.impressionsDisabled;
     }
   }
 
@@ -175,6 +181,7 @@ function getEvaluations(
   splits: Record<string, ISplit | null>,
   attributes: SplitIO.Attributes | undefined,
   storage: IStorageSync | IStorageAsync,
+  options?: SplitIO.EvaluationOptions,
 ): MaybeThenable<Record<string, IEvaluationResult>> {
   const result: Record<string, IEvaluationResult> = {};
   const thenables: Promise<void>[] = [];
@@ -184,7 +191,8 @@ function getEvaluations(
       key,
       splits[splitName],
       attributes,
-      storage
+      storage,
+      options
     );
     if (thenable(evaluation)) {
       thenables.push(evaluation.then(res => {

package/src/sdkClient/client.ts

@@ -52,7 +52,7 @@ export function clientFactory(params: ISdkFactoryContext): SplitIO.IClient | Spl
     };
 
     const evaluation = readinessManager.isReadyFromCache() ?
-      evaluateFeature(log, key, featureFlagName, attributes, storage) :
+      evaluateFeature(log, key, featureFlagName, attributes, storage, options) :
       isAsync ? // If the SDK is not ready, treatment may be incorrect due to having splits but not segments data, or storage is not connected
         Promise.resolve(treatmentNotReady) :
         treatmentNotReady;
@@ -81,7 +81,7 @@ export function clientFactory(params: ISdkFactoryContext): SplitIO.IClient | Spl
     };
 
     const evaluations = readinessManager.isReadyFromCache() ?
-      evaluateFeatures(log, key, featureFlagNames, attributes, storage) :
+      evaluateFeatures(log, key, featureFlagNames, attributes, storage, options) :
       isAsync ? // If the SDK is not ready, treatment may be incorrect due to having splits but not segments data, or storage is not connected
         Promise.resolve(treatmentsNotReady(featureFlagNames)) :
         treatmentsNotReady(featureFlagNames);
@@ -110,7 +110,7 @@ export function clientFactory(params: ISdkFactoryContext): SplitIO.IClient | Spl
     };
 
     const evaluations = readinessManager.isReadyFromCache() ?
-      evaluateFeaturesByFlagSets(log, key, flagSetNames, attributes, storage, methodName) :
+      evaluateFeaturesByFlagSets(log, key, flagSetNames, attributes, storage, methodName, options) :
       isAsync ?
         Promise.resolve({}) :
         {};

package/src/utils/inputValidation/eventProperties.ts

@@ -70,7 +70,12 @@ export function validateEventProperties(log: ILogger, maybeProperties: any, meth
 export function validateEvaluationOptions(log: ILogger, maybeOptions: any, method: string): SplitIO.EvaluationOptions | undefined {
   if (isObject(maybeOptions)) {
     const properties = validateEventProperties(log, maybeOptions.properties, method).properties;
-    return properties && Object.keys(properties).length > 0 ? { properties } : undefined;
+    let options =  properties && Object.keys(properties).length > 0 ? { properties } : undefined;
+
+    const impressionsDisabled = maybeOptions.impressionsDisabled;
+    if (!impressionsDisabled) return options;
+
+    return options ? { ...options, impressionsDisabled } : { impressionsDisabled };
   } else if (maybeOptions) {
     log.error(ERROR_NOT_PLAIN_OBJECT, [method, 'evaluation options']);
   }

package/types/splitio.d.ts

@@ -918,8 +918,16 @@ declare namespace SplitIO {
    * Evaluation options object for getTreatment methods.
    */
   type EvaluationOptions = {
+    /**
+     * Whether the evaluation/s will track impressions or not.
+     *
+     * @defaultValue `false`
+     */
+    impressionsDisabled?: boolean;
     /**
      * Optional properties to append to the generated impression object sent to Split backend.
+     *
+     * @defaultValue `undefined`
      */
     properties?: Properties;
   }