@splitsoftware/splitio-commons 2.5.0 → 2.5.1-rc.0

package/CHANGES.txt

@@ -1,3 +1,6 @@
+2.6.0 (September 19, 2025)
+ - Added `storage.wrapper` configuration option to allow the SDK to use a custom storage wrapper for the storage type `LOCALSTORAGE`. Default value is `window.localStorage`.
+
 2.5.0 (September 10, 2025)
  - Added `factory.getRolloutPlan()` method for standalone server-side SDKs, which returns the rollout plan snapshot from the storage.
  - Added `initialRolloutPlan` configuration option for standalone client-side SDKs, which allows preloading the SDK storage with a snapshot of the rollout plan.
@@ -51,6 +54,15 @@
    - Removed internal ponyfills for `Map` and `Set` global objects, dropping support for IE and other outdated browsers. The SDK now requires the runtime environment to support these features natively or to provide a polyfill.
    - Removed the `sync.localhostMode` configuration option to plug the LocalhostMode module.
 
+1.17.1 (July 25, 2025)
+ - Updated the Redis storage to avoid lazy require of the `ioredis` dependency when the SDK is initialized.
+ - Updated some transitive dependencies for vulnerability fixes.
+ - Bugfix - Enhanced HTTP client module to implement timeouts for failing requests that might otherwise remain pending indefinitely on some Fetch API implementations, pausing the SDK synchronization process.
+ - Bugfix - Properly handle rejected promises when using targeting rules with segment matchers in consumer modes (e.g., Redis and Pluggable storages).
+ - Bugfix - Sanitize the `SplitSDKMachineName` header value to avoid exceptions on HTTP/S requests when it contains non ISO-8859-1 characters (Related to issue https://github.com/splitio/javascript-client/issues/847).
+ - Bugfix - Fixed an issue with the SDK_UPDATE event on server-side, where it was not being emitted if there was an empty segment and the SDK received a feature flag update notification.
+ - Bugfix - Fixed an issue with the server-side polling manager that caused dangling timers when the SDK was destroyed before it was ready.
+
 1.17.0 (September 6, 2024)
  - Added `sync.requestOptions.getHeaderOverrides` configuration option to enhance SDK HTTP request Headers for Authorization Frameworks.
  - Added `isTimedout` and `lastUpdate` properties to IStatusInterface to keep track of the timestamp of the last SDK event, used on React and Redux SDKs.

package/cjs/storages/inLocalStorage/MySegmentsCacheInLocal.js

@@ -7,19 +7,20 @@ var AbstractMySegmentsCacheSync_1 = require("../AbstractMySegmentsCacheSync");
 var constants_1 = require("./constants");
 var MySegmentsCacheInLocal = /** @class */ (function (_super) {
     (0, tslib_1.__extends)(MySegmentsCacheInLocal, _super);
-    function MySegmentsCacheInLocal(log, keys) {
+    function MySegmentsCacheInLocal(log, keys, storage) {
         var _this = _super.call(this) || this;
         _this.log = log;
         _this.keys = keys;
+        _this.storage = storage;
         return _this;
         // There is not need to flush segments cache like splits cache, since resetSegments receives the up-to-date list of active segments
     }
     MySegmentsCacheInLocal.prototype.addSegment = function (name) {
         var segmentKey = this.keys.buildSegmentNameKey(name);
         try {
-            if (localStorage.getItem(segmentKey) === constants_1.DEFINED)
+            if (this.storage.getItem(segmentKey) === constants_1.DEFINED)
                 return false;
-            localStorage.setItem(segmentKey, constants_1.DEFINED);
+            this.storage.setItem(segmentKey, constants_1.DEFINED);
             return true;
         }
         catch (e) {
@@ -30,9 +31,9 @@ var MySegmentsCacheInLocal = /** @class */ (function (_super) {
     MySegmentsCacheInLocal.prototype.removeSegment = function (name) {
         var segmentKey = this.keys.buildSegmentNameKey(name);
         try {
-            if (localStorage.getItem(segmentKey) !== constants_1.DEFINED)
+            if (this.storage.getItem(segmentKey) !== constants_1.DEFINED)
                 return false;
-            localStorage.removeItem(segmentKey);
+            this.storage.removeItem(segmentKey);
             return true;
         }
         catch (e) {
@@ -41,17 +42,16 @@ var MySegmentsCacheInLocal = /** @class */ (function (_super) {
         }
     };
     MySegmentsCacheInLocal.prototype.isInSegment = function (name) {
-        return localStorage.getItem(this.keys.buildSegmentNameKey(name)) === constants_1.DEFINED;
+        return this.storage.getItem(this.keys.buildSegmentNameKey(name)) === constants_1.DEFINED;
     };
     MySegmentsCacheInLocal.prototype.getRegisteredSegments = function () {
-        var _this = this;
-        // Scan current values from localStorage
-        return Object.keys(localStorage).reduce(function (accum, key) {
-            var segmentName = _this.keys.extractSegmentName(key);
+        var registeredSegments = [];
+        for (var i = 0, len = this.storage.length; i < len; i++) {
+            var segmentName = this.keys.extractSegmentName(this.storage.key(i));
             if (segmentName)
-                accum.push(segmentName);
-            return accum;
-        }, []);
+                registeredSegments.push(segmentName);
+        }
+        return registeredSegments;
     };
     MySegmentsCacheInLocal.prototype.getKeysCount = function () {
         return 1;
@@ -59,9 +59,9 @@ var MySegmentsCacheInLocal = /** @class */ (function (_super) {
     MySegmentsCacheInLocal.prototype.setChangeNumber = function (changeNumber) {
         try {
             if (changeNumber)
-                localStorage.setItem(this.keys.buildTillKey(), changeNumber + '');
+                this.storage.setItem(this.keys.buildTillKey(), changeNumber + '');
             else
-                localStorage.removeItem(this.keys.buildTillKey());
+                this.storage.removeItem(this.keys.buildTillKey());
         }
         catch (e) {
             this.log.error(e);
@@ -69,7 +69,7 @@ var MySegmentsCacheInLocal = /** @class */ (function (_super) {
     };
     MySegmentsCacheInLocal.prototype.getChangeNumber = function () {
         var n = -1;
-        var value = localStorage.getItem(this.keys.buildTillKey());
+        var value = this.storage.getItem(this.keys.buildTillKey());
         if (value !== null) {
             value = parseInt(value, 10);
             return (0, lang_1.isNaNNumber)(value) ? n : value;

package/cjs/storages/inLocalStorage/RBSegmentsCacheInLocal.js

@@ -6,14 +6,15 @@ var sets_1 = require("../../utils/lang/sets");
 var AbstractSplitsCacheSync_1 = require("../AbstractSplitsCacheSync");
 var constants_1 = require("./constants");
 var RBSegmentsCacheInLocal = /** @class */ (function () {
-    function RBSegmentsCacheInLocal(settings, keys) {
+    function RBSegmentsCacheInLocal(settings, keys, storage) {
         this.keys = keys;
         this.log = settings.log;
+        this.storage = storage;
     }
     RBSegmentsCacheInLocal.prototype.clear = function () {
         var _this = this;
         this.getNames().forEach(function (name) { return _this.remove(name); });
-        localStorage.removeItem(this.keys.buildRBSegmentsTillKey());
+        this.storage.removeItem(this.keys.buildRBSegmentsTillKey());
     };
     RBSegmentsCacheInLocal.prototype.update = function (toAdd, toRemove, changeNumber) {
         var _this = this;
@@ -23,8 +24,8 @@ var RBSegmentsCacheInLocal = /** @class */ (function () {
     };
     RBSegmentsCacheInLocal.prototype.setChangeNumber = function (changeNumber) {
         try {
-            localStorage.setItem(this.keys.buildRBSegmentsTillKey(), changeNumber + '');
-            localStorage.setItem(this.keys.buildLastUpdatedKey(), Date.now() + '');
+            this.storage.setItem(this.keys.buildRBSegmentsTillKey(), changeNumber + '');
+            this.storage.setItem(this.keys.buildLastUpdatedKey(), Date.now() + '');
         }
         catch (e) {
             this.log.error(constants_1.LOG_PREFIX + e);
@@ -32,20 +33,19 @@ var RBSegmentsCacheInLocal = /** @class */ (function () {
     };
     RBSegmentsCacheInLocal.prototype.updateSegmentCount = function (diff) {
         var segmentsCountKey = this.keys.buildSplitsWithSegmentCountKey();
-        var count = (0, lang_1.toNumber)(localStorage.getItem(segmentsCountKey)) + diff;
-        // @ts-expect-error
+        var count = (0, lang_1.toNumber)(this.storage.getItem(segmentsCountKey)) + diff;
         if (count > 0)
-            localStorage.setItem(segmentsCountKey, count);
+            this.storage.setItem(segmentsCountKey, count + '');
         else
-            localStorage.removeItem(segmentsCountKey);
+            this.storage.removeItem(segmentsCountKey);
     };
     RBSegmentsCacheInLocal.prototype.add = function (rbSegment) {
         try {
             var name_1 = rbSegment.name;
             var rbSegmentKey = this.keys.buildRBSegmentKey(name_1);
-            var rbSegmentFromLocalStorage = localStorage.getItem(rbSegmentKey);
-            var previous = rbSegmentFromLocalStorage ? JSON.parse(rbSegmentFromLocalStorage) : null;
-            localStorage.setItem(rbSegmentKey, JSON.stringify(rbSegment));
+            var rbSegmentFromStorage = this.storage.getItem(rbSegmentKey);
+            var previous = rbSegmentFromStorage ? JSON.parse(rbSegmentFromStorage) : null;
+            this.storage.setItem(rbSegmentKey, JSON.stringify(rbSegment));
             var usesSegmentsDiff = 0;
             if (previous && (0, AbstractSplitsCacheSync_1.usesSegments)(previous))
                 usesSegmentsDiff--;
@@ -65,7 +65,7 @@ var RBSegmentsCacheInLocal = /** @class */ (function () {
             var rbSegment = this.get(name);
             if (!rbSegment)
                 return false;
-            localStorage.removeItem(this.keys.buildRBSegmentKey(name));
+            this.storage.removeItem(this.keys.buildRBSegmentKey(name));
             if ((0, AbstractSplitsCacheSync_1.usesSegments)(rbSegment))
                 this.updateSegmentCount(-1);
             return true;
@@ -76,11 +76,11 @@ var RBSegmentsCacheInLocal = /** @class */ (function () {
         }
     };
     RBSegmentsCacheInLocal.prototype.getNames = function () {
-        var len = localStorage.length;
+        var len = this.storage.length;
         var accum = [];
         var cur = 0;
         while (cur < len) {
-            var key = localStorage.key(cur);
+            var key = this.storage.key(cur);
             if (key != null && this.keys.isRBSegmentKey(key))
                 accum.push(this.keys.extractKey(key));
             cur++;
@@ -88,7 +88,7 @@ var RBSegmentsCacheInLocal = /** @class */ (function () {
         return accum;
     };
     RBSegmentsCacheInLocal.prototype.get = function (name) {
-        var item = localStorage.getItem(this.keys.buildRBSegmentKey(name));
+        var item = this.storage.getItem(this.keys.buildRBSegmentKey(name));
         return item && JSON.parse(item);
     };
     RBSegmentsCacheInLocal.prototype.getAll = function () {
@@ -102,7 +102,7 @@ var RBSegmentsCacheInLocal = /** @class */ (function () {
     };
     RBSegmentsCacheInLocal.prototype.getChangeNumber = function () {
         var n = -1;
-        var value = localStorage.getItem(this.keys.buildRBSegmentsTillKey());
+        var value = this.storage.getItem(this.keys.buildRBSegmentsTillKey());
         if (value !== null) {
             value = parseInt(value, 10);
             return (0, lang_1.isNaNNumber)(value) ? n : value;
@@ -110,7 +110,7 @@ var RBSegmentsCacheInLocal = /** @class */ (function () {
         return n;
     };
     RBSegmentsCacheInLocal.prototype.usesSegments = function () {
-        var storedCount = localStorage.getItem(this.keys.buildSplitsWithSegmentCountKey());
+        var storedCount = this.storage.getItem(this.keys.buildSplitsWithSegmentCountKey());
         var splitsWithSegmentsCount = storedCount === null ? 0 : (0, lang_1.toNumber)(storedCount);
         return (0, lang_1.isFiniteNumber)(splitsWithSegmentsCount) ?
             splitsWithSegmentsCount > 0 :

package/cjs/storages/inLocalStorage/SplitsCacheInLocal.js

@@ -6,25 +6,22 @@ var AbstractSplitsCacheSync_1 = require("../AbstractSplitsCacheSync");
 var lang_1 = require("../../utils/lang");
 var constants_1 = require("./constants");
 var sets_1 = require("../../utils/lang/sets");
-/**
- * ISplitsCacheSync implementation that stores split definitions in browser LocalStorage.
- */
 var SplitsCacheInLocal = /** @class */ (function (_super) {
     (0, tslib_1.__extends)(SplitsCacheInLocal, _super);
-    function SplitsCacheInLocal(settings, keys) {
+    function SplitsCacheInLocal(settings, keys, storage) {
         var _this = _super.call(this) || this;
         _this.keys = keys;
         _this.log = settings.log;
         _this.flagSetsFilter = settings.sync.__splitFiltersValidation.groupedFilters.bySet;
+        _this.storage = storage;
         return _this;
     }
     SplitsCacheInLocal.prototype._decrementCount = function (key) {
-        var count = (0, lang_1.toNumber)(localStorage.getItem(key)) - 1;
-        // @ts-expect-error
+        var count = (0, lang_1.toNumber)(this.storage.getItem(key)) - 1;
         if (count > 0)
-            localStorage.setItem(key, count);
+            this.storage.setItem(key, count + '');
         else
-            localStorage.removeItem(key);
+            this.storage.removeItem(key);
     };
     SplitsCacheInLocal.prototype._decrementCounts = function (split) {
         try {
@@ -42,12 +39,10 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
     SplitsCacheInLocal.prototype._incrementCounts = function (split) {
         try {
             var ttKey = this.keys.buildTrafficTypeKey(split.trafficTypeName);
-            // @ts-expect-error
-            localStorage.setItem(ttKey, (0, lang_1.toNumber)(localStorage.getItem(ttKey)) + 1);
+            this.storage.setItem(ttKey, ((0, lang_1.toNumber)(this.storage.getItem(ttKey)) + 1) + '');
             if ((0, AbstractSplitsCacheSync_1.usesSegments)(split)) {
                 var segmentsCountKey = this.keys.buildSplitsWithSegmentCountKey();
-                // @ts-expect-error
-                localStorage.setItem(segmentsCountKey, (0, lang_1.toNumber)(localStorage.getItem(segmentsCountKey)) + 1);
+                this.storage.setItem(segmentsCountKey, ((0, lang_1.toNumber)(this.storage.getItem(segmentsCountKey)) + 1) + '');
             }
         }
         catch (e) {
@@ -59,17 +54,18 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
      * We cannot simply call `localStorage.clear()` since that implies removing user items from the storage.
      */
     SplitsCacheInLocal.prototype.clear = function () {
+        var _this = this;
         // collect item keys
-        var len = localStorage.length;
+        var len = this.storage.length;
         var accum = [];
         for (var cur = 0; cur < len; cur++) {
-            var key = localStorage.key(cur);
+            var key = this.storage.key(cur);
             if (key != null && this.keys.isSplitsCacheKey(key))
                 accum.push(key);
         }
         // remove items
         accum.forEach(function (key) {
-            localStorage.removeItem(key);
+            _this.storage.removeItem(key);
         });
         this.hasSync = false;
     };
@@ -77,13 +73,13 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
         try {
             var name_1 = split.name;
             var splitKey = this.keys.buildSplitKey(name_1);
-            var splitFromLocalStorage = localStorage.getItem(splitKey);
-            var previousSplit = splitFromLocalStorage ? JSON.parse(splitFromLocalStorage) : null;
+            var splitFromStorage = this.storage.getItem(splitKey);
+            var previousSplit = splitFromStorage ? JSON.parse(splitFromStorage) : null;
             if (previousSplit) {
                 this._decrementCounts(previousSplit);
                 this.removeFromFlagSets(previousSplit.name, previousSplit.sets);
             }
-            localStorage.setItem(splitKey, JSON.stringify(split));
+            this.storage.setItem(splitKey, JSON.stringify(split));
             this._incrementCounts(split);
             this.addToFlagSets(split);
             return true;
@@ -98,7 +94,7 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
             var split = this.getSplit(name);
             if (!split)
                 return false;
-            localStorage.removeItem(this.keys.buildSplitKey(name));
+            this.storage.removeItem(this.keys.buildSplitKey(name));
             this._decrementCounts(split);
             this.removeFromFlagSets(split.name, split.sets);
             return true;
@@ -109,14 +105,14 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
         }
     };
     SplitsCacheInLocal.prototype.getSplit = function (name) {
-        var item = localStorage.getItem(this.keys.buildSplitKey(name));
+        var item = this.storage.getItem(this.keys.buildSplitKey(name));
         return item && JSON.parse(item);
     };
     SplitsCacheInLocal.prototype.setChangeNumber = function (changeNumber) {
         try {
-            localStorage.setItem(this.keys.buildSplitsTillKey(), changeNumber + '');
+            this.storage.setItem(this.keys.buildSplitsTillKey(), changeNumber + '');
             // update "last updated" timestamp with current time
-            localStorage.setItem(this.keys.buildLastUpdatedKey(), Date.now() + '');
+            this.storage.setItem(this.keys.buildLastUpdatedKey(), Date.now() + '');
             this.hasSync = true;
             return true;
         }
@@ -127,7 +123,7 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
     };
     SplitsCacheInLocal.prototype.getChangeNumber = function () {
         var n = -1;
-        var value = localStorage.getItem(this.keys.buildSplitsTillKey());
+        var value = this.storage.getItem(this.keys.buildSplitsTillKey());
         if (value !== null) {
             value = parseInt(value, 10);
             return (0, lang_1.isNaNNumber)(value) ? n : value;
@@ -135,11 +131,11 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
         return n;
     };
     SplitsCacheInLocal.prototype.getSplitNames = function () {
-        var len = localStorage.length;
+        var len = this.storage.length;
         var accum = [];
         var cur = 0;
         while (cur < len) {
-            var key = localStorage.key(cur);
+            var key = this.storage.key(cur);
             if (key != null && this.keys.isSplitKey(key))
                 accum.push(this.keys.extractKey(key));
             cur++;
@@ -147,14 +143,14 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
         return accum;
     };
     SplitsCacheInLocal.prototype.trafficTypeExists = function (trafficType) {
-        var ttCount = (0, lang_1.toNumber)(localStorage.getItem(this.keys.buildTrafficTypeKey(trafficType)));
+        var ttCount = (0, lang_1.toNumber)(this.storage.getItem(this.keys.buildTrafficTypeKey(trafficType)));
         return (0, lang_1.isFiniteNumber)(ttCount) && ttCount > 0;
     };
     SplitsCacheInLocal.prototype.usesSegments = function () {
         // If cache hasn't been synchronized with the cloud, assume we need them.
         if (!this.hasSync)
             return true;
-        var storedCount = localStorage.getItem(this.keys.buildSplitsWithSegmentCountKey());
+        var storedCount = this.storage.getItem(this.keys.buildSplitsWithSegmentCountKey());
         var splitsWithSegmentsCount = storedCount === null ? 0 : (0, lang_1.toNumber)(storedCount);
         return (0, lang_1.isFiniteNumber)(splitsWithSegmentsCount) ?
             splitsWithSegmentsCount > 0 :
@@ -164,8 +160,8 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
         var _this = this;
         return flagSets.map(function (flagSet) {
             var flagSetKey = _this.keys.buildFlagSetKey(flagSet);
-            var flagSetFromLocalStorage = localStorage.getItem(flagSetKey);
-            return new Set(flagSetFromLocalStorage ? JSON.parse(flagSetFromLocalStorage) : []);
+            var flagSetFromStorage = _this.storage.getItem(flagSetKey);
+            return new Set(flagSetFromStorage ? JSON.parse(flagSetFromStorage) : []);
         });
     };
     SplitsCacheInLocal.prototype.addToFlagSets = function (featureFlag) {
@@ -176,10 +172,10 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
             if (_this.flagSetsFilter.length > 0 && !_this.flagSetsFilter.some(function (filterFlagSet) { return filterFlagSet === featureFlagSet; }))
                 return;
             var flagSetKey = _this.keys.buildFlagSetKey(featureFlagSet);
-            var flagSetFromLocalStorage = localStorage.getItem(flagSetKey);
-            var flagSetCache = new Set(flagSetFromLocalStorage ? JSON.parse(flagSetFromLocalStorage) : []);
+            var flagSetFromStorage = _this.storage.getItem(flagSetKey);
+            var flagSetCache = new Set(flagSetFromStorage ? JSON.parse(flagSetFromStorage) : []);
             flagSetCache.add(featureFlag.name);
-            localStorage.setItem(flagSetKey, JSON.stringify((0, sets_1.setToArray)(flagSetCache)));
+            _this.storage.setItem(flagSetKey, JSON.stringify((0, sets_1.setToArray)(flagSetCache)));
         });
     };
     SplitsCacheInLocal.prototype.removeFromFlagSets = function (featureFlagName, flagSets) {
@@ -192,16 +188,16 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
     };
     SplitsCacheInLocal.prototype.removeNames = function (flagSetName, featureFlagName) {
         var flagSetKey = this.keys.buildFlagSetKey(flagSetName);
-        var flagSetFromLocalStorage = localStorage.getItem(flagSetKey);
-        if (!flagSetFromLocalStorage)
+        var flagSetFromStorage = this.storage.getItem(flagSetKey);
+        if (!flagSetFromStorage)
             return;
-        var flagSetCache = new Set(JSON.parse(flagSetFromLocalStorage));
+        var flagSetCache = new Set(JSON.parse(flagSetFromStorage));
         flagSetCache.delete(featureFlagName);
         if (flagSetCache.size === 0) {
-            localStorage.removeItem(flagSetKey);
+            this.storage.removeItem(flagSetKey);
             return;
         }
-        localStorage.setItem(flagSetKey, JSON.stringify((0, sets_1.setToArray)(flagSetCache)));
+        this.storage.setItem(flagSetKey, JSON.stringify((0, sets_1.setToArray)(flagSetCache)));
     };
     return SplitsCacheInLocal;
 }(AbstractSplitsCacheSync_1.AbstractSplitsCacheSync));

package/cjs/storages/inLocalStorage/index.js

@@ -17,6 +17,20 @@ var TelemetryCacheInMemory_1 = require("../inMemory/TelemetryCacheInMemory");
 var UniqueKeysCacheInMemoryCS_1 = require("../inMemory/UniqueKeysCacheInMemoryCS");
 var key_1 = require("../../utils/key");
 var validateCache_1 = require("./validateCache");
+var storageAdapter_1 = require("./storageAdapter");
+function validateStorage(log, prefix, wrapper) {
+    if (wrapper) {
+        if ((0, isLocalStorageAvailable_1.isValidStorageWrapper)(wrapper)) {
+            return (0, isLocalStorageAvailable_1.isWebStorage)(wrapper) ?
+                wrapper : // localStorage and sessionStorage don't need adapter
+                (0, storageAdapter_1.storageAdapter)(log, prefix, wrapper);
+        }
+        log.warn(constants_1.LOG_PREFIX + 'Invalid storage provided. Falling back to LocalStorage API');
+    }
+    if ((0, isLocalStorageAvailable_1.isLocalStorageAvailable)())
+        return localStorage;
+    log.warn(constants_1.LOG_PREFIX + 'LocalStorage API is unavailable. Falling back to default MEMORY storage');
+}
 /**
  * InLocal storage factory for standalone client-side SplitFactory
  */
@@ -24,18 +38,17 @@ function InLocalStorage(options) {
     if (options === void 0) { options = {}; }
     var prefix = (0, KeyBuilder_1.validatePrefix)(options.prefix);
     function InLocalStorageCSFactory(params) {
-        // Fallback to InMemoryStorage if LocalStorage API is not available
-        if (!(0, isLocalStorageAvailable_1.isLocalStorageAvailable)()) {
-            params.settings.log.warn(constants_1.LOG_PREFIX + 'LocalStorage API is unavailable. Falling back to default MEMORY storage');
-            return (0, InMemoryStorageCS_1.InMemoryStorageCSFactory)(params);
-        }
         var settings = params.settings, _a = params.settings, log = _a.log, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize;
+        var storage = validateStorage(log, prefix, options.wrapper);
+        if (!storage)
+            return (0, InMemoryStorageCS_1.InMemoryStorageCSFactory)(params);
         var matchingKey = (0, key_1.getMatching)(settings.core.key);
         var keys = new KeyBuilderCS_1.KeyBuilderCS(prefix, matchingKey);
-        var splits = new SplitsCacheInLocal_1.SplitsCacheInLocal(settings, keys);
-        var rbSegments = new RBSegmentsCacheInLocal_1.RBSegmentsCacheInLocal(settings, keys);
-        var segments = new MySegmentsCacheInLocal_1.MySegmentsCacheInLocal(log, keys);
-        var largeSegments = new MySegmentsCacheInLocal_1.MySegmentsCacheInLocal(log, (0, KeyBuilderCS_1.myLargeSegmentsKeyBuilder)(prefix, matchingKey));
+        var splits = new SplitsCacheInLocal_1.SplitsCacheInLocal(settings, keys, storage);
+        var rbSegments = new RBSegmentsCacheInLocal_1.RBSegmentsCacheInLocal(settings, keys, storage);
+        var segments = new MySegmentsCacheInLocal_1.MySegmentsCacheInLocal(log, keys, storage);
+        var largeSegments = new MySegmentsCacheInLocal_1.MySegmentsCacheInLocal(log, (0, KeyBuilderCS_1.myLargeSegmentsKeyBuilder)(prefix, matchingKey), storage);
+        var validateCachePromise;
         return {
             splits: splits,
             rbSegments: rbSegments,
@@ -47,16 +60,21 @@ function InLocalStorage(options) {
             telemetry: (0, TelemetryCacheInMemory_1.shouldRecordTelemetry)(params) ? new TelemetryCacheInMemory_1.TelemetryCacheInMemory(splits, segments) : undefined,
             uniqueKeys: new UniqueKeysCacheInMemoryCS_1.UniqueKeysCacheInMemoryCS(),
             validateCache: function () {
-                return (0, validateCache_1.validateCache)(options, settings, keys, splits, rbSegments, segments, largeSegments);
+                return validateCachePromise || (validateCachePromise = (0, validateCache_1.validateCache)(options, storage, settings, keys, splits, rbSegments, segments, largeSegments));
+            },
+            save: function () {
+                return storage.save && storage.save();
+            },
+            destroy: function () {
+                return storage.whenSaved && storage.whenSaved();
             },
-            destroy: function () { },
             // When using shared instantiation with MEMORY we reuse everything but segments (they are customer per key).
             shared: function (matchingKey) {
                 return {
                     splits: this.splits,
                     rbSegments: this.rbSegments,
-                    segments: new MySegmentsCacheInLocal_1.MySegmentsCacheInLocal(log, new KeyBuilderCS_1.KeyBuilderCS(prefix, matchingKey)),
-                    largeSegments: new MySegmentsCacheInLocal_1.MySegmentsCacheInLocal(log, (0, KeyBuilderCS_1.myLargeSegmentsKeyBuilder)(prefix, matchingKey)),
+                    segments: new MySegmentsCacheInLocal_1.MySegmentsCacheInLocal(log, new KeyBuilderCS_1.KeyBuilderCS(prefix, matchingKey), storage),
+                    largeSegments: new MySegmentsCacheInLocal_1.MySegmentsCacheInLocal(log, (0, KeyBuilderCS_1.myLargeSegmentsKeyBuilder)(prefix, matchingKey), storage),
                     impressions: this.impressions,
                     impressionCounts: this.impressionCounts,
                     events: this.events,

package/cjs/storages/inLocalStorage/storageAdapter.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.storageAdapter = void 0;
+var constants_1 = require("./constants");
+function storageAdapter(log, prefix, wrapper) {
+    var keys = [];
+    var cache = {};
+    var loadPromise;
+    var savePromise = Promise.resolve();
+    return {
+        load: function () {
+            return loadPromise || (loadPromise = Promise.resolve().then(function () {
+                return wrapper.getItem(prefix);
+            }).then(function (storedCache) {
+                cache = JSON.parse(storedCache || '{}');
+                keys = Object.keys(cache);
+            }).catch(function (e) {
+                log.error(constants_1.LOG_PREFIX + 'Rejected promise calling wrapper `getItem` method, with error: ' + e);
+            }));
+        },
+        save: function () {
+            return savePromise = savePromise.then(function () {
+                return Promise.resolve(wrapper.setItem(prefix, JSON.stringify(cache)));
+            }).catch(function (e) {
+                log.error(constants_1.LOG_PREFIX + 'Rejected promise calling wrapper `setItem` method, with error: ' + e);
+            });
+        },
+        whenSaved: function () {
+            return savePromise;
+        },
+        get length() {
+            return keys.length;
+        },
+        getItem: function (key) {
+            return cache[key] || null;
+        },
+        key: function (index) {
+            return keys[index] || null;
+        },
+        removeItem: function (key) {
+            var index = keys.indexOf(key);
+            if (index === -1)
+                return;
+            keys.splice(index, 1);
+            delete cache[key];
+        },
+        setItem: function (key, value) {
+            if (keys.indexOf(key) === -1)
+                keys.push(key);
+            cache[key] = value;
+        }
+    };
+}
+exports.storageAdapter = storageAdapter;

package/cjs/storages/inLocalStorage/validateCache.js

@@ -11,10 +11,10 @@ var MILLIS_IN_A_DAY = 86400000;
  *
  * @returns `true` if cache should be cleared, `false` otherwise
  */
-function validateExpiration(options, settings, keys, currentTimestamp, isThereCache) {
+function validateExpiration(options, storage, settings, keys, currentTimestamp, isThereCache) {
     var log = settings.log, initialRolloutPlan = settings.initialRolloutPlan;
     // Check expiration
-    var lastUpdatedTimestamp = parseInt(localStorage.getItem(keys.buildLastUpdatedKey()), 10);
+    var lastUpdatedTimestamp = parseInt(storage.getItem(keys.buildLastUpdatedKey()), 10);
     if (!(0, lang_1.isNaNNumber)(lastUpdatedTimestamp)) {
         var cacheExpirationInDays = (0, lang_1.isFiniteNumber)(options.expirationDays) && options.expirationDays >= 1 ? options.expirationDays : DEFAULT_CACHE_EXPIRATION_IN_DAYS;
         var expirationTimestamp = currentTimestamp - MILLIS_IN_A_DAY * cacheExpirationInDays;
@@ -25,11 +25,11 @@ function validateExpiration(options, settings, keys, currentTimestamp, isThereCa
     }
     // Check hash
     var storageHashKey = keys.buildHashKey();
-    var storageHash = localStorage.getItem(storageHashKey);
+    var storageHash = storage.getItem(storageHashKey);
     var currentStorageHash = (0, KeyBuilder_1.getStorageHash)(settings);
     if (storageHash !== currentStorageHash) {
         try {
-            localStorage.setItem(storageHashKey, currentStorageHash);
+            storage.setItem(storageHashKey, currentStorageHash);
         }
         catch (e) {
             log.error(constants_1.LOG_PREFIX + e);
@@ -42,7 +42,7 @@ function validateExpiration(options, settings, keys, currentTimestamp, isThereCa
     }
     // Clear on init
     if (options.clearOnInit) {
-        var lastClearTimestamp = parseInt(localStorage.getItem(keys.buildLastClear()), 10);
+        var lastClearTimestamp = parseInt(storage.getItem(keys.buildLastClear()), 10);
         if ((0, lang_1.isNaNNumber)(lastClearTimestamp) || lastClearTimestamp < currentTimestamp - MILLIS_IN_A_DAY) {
             log.info(constants_1.LOG_PREFIX + 'clearOnInit was set and cache was not cleared in the last 24 hours. Cleaning up cache');
             return true;
@@ -57,24 +57,29 @@ function validateExpiration(options, settings, keys, currentTimestamp, isThereCa
  *
  * @returns `true` if cache is ready to be used, `false` otherwise (cache was cleared or there is no cache)
  */
-function validateCache(options, settings, keys, splits, rbSegments, segments, largeSegments) {
-    var currentTimestamp = Date.now();
-    var isThereCache = splits.getChangeNumber() > -1;
-    if (validateExpiration(options, settings, keys, currentTimestamp, isThereCache)) {
-        splits.clear();
-        rbSegments.clear();
-        segments.clear();
-        largeSegments.clear();
-        // Update last clear timestamp
-        try {
-            localStorage.setItem(keys.buildLastClear(), currentTimestamp + '');
-        }
-        catch (e) {
-            settings.log.error(constants_1.LOG_PREFIX + e);
+function validateCache(options, storage, settings, keys, splits, rbSegments, segments, largeSegments) {
+    return Promise.resolve(storage.load && storage.load()).then(function () {
+        var currentTimestamp = Date.now();
+        var isThereCache = splits.getChangeNumber() > -1;
+        if (validateExpiration(options, storage, settings, keys, currentTimestamp, isThereCache)) {
+            splits.clear();
+            rbSegments.clear();
+            segments.clear();
+            largeSegments.clear();
+            // Update last clear timestamp
+            try {
+                storage.setItem(keys.buildLastClear(), currentTimestamp + '');
+            }
+            catch (e) {
+                settings.log.error(constants_1.LOG_PREFIX + e);
+            }
+            // Persist clear
+            if (storage.save)
+                storage.save();
+            return false;
         }
-        return false;
-    }
-    // Check if ready from cache
-    return isThereCache;
+        // Check if ready from cache
+        return isThereCache;
+    });
 }
 exports.validateCache = validateCache;

package/cjs/sync/offline/syncTasks/fromObjectSyncTask.js

@@ -45,10 +45,9 @@ function fromObjectUpdaterFactory(splitsParser, storage, readiness, settings) {
                 readiness.splits.emit(constants_2.SDK_SPLITS_ARRIVED);
                 if (startingUp) {
                     startingUp = false;
-                    var isCacheLoaded_1 = storage.validateCache ? storage.validateCache() : false;
-                    Promise.resolve().then(function () {
+                    Promise.resolve(storage.validateCache ? storage.validateCache() : false).then(function (isCacheLoaded) {
                         // Emits SDK_READY_FROM_CACHE
-                        if (isCacheLoaded_1)
+                        if (isCacheLoaded)
                             readiness.splits.emit(constants_2.SDK_SPLITS_CACHE_LOADED);
                         // Emits SDK_READY
                         readiness.segments.emit(constants_2.SDK_SEGMENTS_ARRIVED);

package/cjs/sync/polling/updaters/mySegmentsUpdater.js

@@ -34,6 +34,8 @@ function mySegmentsUpdaterFactory(log, mySegmentsFetcher, storage, segmentsEvent
             shouldNotifyUpdate = segments.resetSegments(segmentsData.ms || {});
             shouldNotifyUpdate = largeSegments.resetSegments(segmentsData.ls || {}) || shouldNotifyUpdate;
         }
+        if (storage.save)
+            storage.save();
         // Notify update if required
         if ((0, AbstractSplitsCacheSync_1.usesSegmentsSync)(storage) && (shouldNotifyUpdate || readyOnAlreadyExistentState)) {
             readyOnAlreadyExistentState = false;