@splitsoftware/splitio-commons 2.10.2-rc.5 → 2.10.2-rc.6

package/CHANGES.txt

@@ -1,6 +1,6 @@
 2.11.0 (January XX, 2026)
  - Added metadata to SDK_UPDATE events to indicate the type of update (FLAGS_UPDATE or SEGMENTS_UPDATE) and the names of updated flags or segments.
- - Added metadata to SDK_READY and SDK_READY_FROM_CACHE events, including `initialCacheLoad` (boolean: `true` for fresh install/first app launch, `false` for warm cache/second app launch) and `lastUpdateTimestamp` (Int64 milliseconds since epoch).
+ - Added metadata to SDK_READY and SDK_READY_FROM_CACHE events, including `initialCacheLoad` (boolean: `true` for fresh install/first app launch, `false` for warm cache/second app launch) and `lastUpdateTimestamp` (milliseconds since epoch).
 
 2.10.1 (December 18, 2025)
  - Bugfix - Handle `null` prerequisites properly.

package/CONTRIBUTORS-GUIDE.md

@@ -7,7 +7,7 @@ Split SDK is an open source project and we welcome feedback and contribution. Th
 ### Development process
 
 1. Fork the repository and create a topic branch from `development` branch. Please use a descriptive name for your branch.
-2. While developing, use descriptive messages in your commits. Avoid short or meaningless sentences like: "fix bug".
+2. While developing, use descriptive messages in your commits. Avoid short or meaningless sentences like "fix bug".
 3. Make sure to add tests for both positive and negative cases.
 4. Run the linter script of the project and fix any issues you find.
 5. Run the build script and make sure it runs with no errors.
@@ -40,4 +40,4 @@ Consider running the linter and type check script (`npm run check`) and fixing a
 
 # Contact
 
-If you have any other questions or need to contact us directly in a private manner send us a note at sdks@split.io
+If you have any other questions or need to contact us directly in a private manner send us a note at sdks@split.io

package/LICENSE

@@ -1,13 +1,202 @@
-Copyright © 2025 Split Software, Inc.
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
 
-    http://www.apache.org/licenses/LICENSE-2.0
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/cjs/readiness/readinessManager.js

@@ -39,9 +39,11 @@ function readinessManagerFactory(EventEmitter, settings, splits, isShared) {
         // ensure lastUpdate is always increasing per event, is case Date.now() is mocked or its value is the same
         lastUpdate = dateNow > lastUpdate ? dateNow : lastUpdate + 1;
     }
+    var metadataReady = {
+        initialCacheLoad: true
+    };
     // emit SDK_READY_FROM_CACHE
     var isReadyFromCache = false;
-    var cacheLastUpdateTimestamp = null;
     if (splits.splitsCacheLoaded)
         isReadyFromCache = true; // ready from cache, but doesn't emit SDK_READY_FROM_CACHE
     else
@@ -70,16 +72,13 @@ function readinessManagerFactory(EventEmitter, settings, splits, isShared) {
     if (splits.hasInit)
         __init();
     function checkIsReadyFromCache(cacheMetadata) {
+        metadataReady = cacheMetadata;
         isReadyFromCache = true;
-        cacheLastUpdateTimestamp = cacheMetadata.lastUpdateTimestamp;
         // Don't emit SDK_READY_FROM_CACHE if SDK_READY has been emitted
         if (!isReady && !isDestroyed) {
             try {
                 syncLastUpdate();
-                gate.emit(constants_1.SDK_READY_FROM_CACHE, {
-                    initialCacheLoad: !cacheMetadata.isCacheValid,
-                    lastUpdateTimestamp: cacheLastUpdateTimestamp
-                });
+                gate.emit(constants_1.SDK_READY_FROM_CACHE, cacheMetadata);
             }
             catch (e) {
                 // throws user callback exceptions in next tick
@@ -105,19 +104,15 @@ function readinessManagerFactory(EventEmitter, settings, splits, isShared) {
                 clearTimeout(readyTimeoutId);
                 isReady = true;
                 try {
-                    var wasReadyFromCache = isReadyFromCache;
+                    syncLastUpdate();
                     if (!isReadyFromCache) {
                         isReadyFromCache = true;
                         var metadataReadyFromCache = {
                             initialCacheLoad: true,
-                            lastUpdateTimestamp: null // No cache timestamp when fresh install
+                            lastUpdateTimestamp: undefined // No cache timestamp when fresh install
                         };
                         gate.emit(constants_1.SDK_READY_FROM_CACHE, metadataReadyFromCache);
                     }
-                    var metadataReady = {
-                        initialCacheLoad: !wasReadyFromCache,
-                        lastUpdateTimestamp: wasReadyFromCache ? cacheLastUpdateTimestamp : null
-                    };
                     gate.emit(constants_1.SDK_READY, metadataReady);
                 }
                 catch (e) {

package/cjs/sdkFactory/index.js

@@ -46,17 +46,17 @@ function sdkFactory(params) {
                 return;
             }
             readiness.splits.emit(constants_2.SDK_SPLITS_ARRIVED);
-            readiness.segments.emit(constants_2.SDK_SEGMENTS_ARRIVED, { isCacheValid: true, lastUpdateTimestamp: null });
+            readiness.segments.emit(constants_2.SDK_SEGMENTS_ARRIVED);
         },
         onReadyFromCacheCb: function () {
-            readiness.splits.emit(constants_2.SDK_SPLITS_CACHE_LOADED, { isCacheValid: true, lastUpdateTimestamp: null });
+            readiness.splits.emit(constants_2.SDK_SPLITS_CACHE_LOADED, { initialCacheLoad: false /* Not an initial load, cache exists */ });
         }
     });
     var fallbackTreatmentsCalculator = new fallbackTreatmentsCalculator_1.FallbackTreatmentsCalculator(settings.fallbackTreatments);
     if (initialRolloutPlan) {
         (0, setRolloutPlan_1.setRolloutPlan)(log, initialRolloutPlan, storage, key && (0, key_1.getMatching)(key));
         if (storage.splits.getChangeNumber() > -1)
-            readiness.splits.emit(constants_2.SDK_SPLITS_CACHE_LOADED, { isCacheValid: true, lastUpdateTimestamp: null });
+            readiness.splits.emit(constants_2.SDK_SPLITS_CACHE_LOADED, { initialCacheLoad: false /* Not an initial load, cache exists */ });
     }
     var clients = {};
     var telemetryTracker = (0, telemetryTracker_1.telemetryTrackerFactory)(storage.telemetry, platform.now);

package/cjs/storages/inLocalStorage/validateCache.js

@@ -55,7 +55,7 @@ function validateExpiration(options, storage, settings, keys, currentTimestamp,
  * - its hash has changed, i.e., the SDK key, flags filter criteria or flags spec version was modified
  * - `clearOnInit` was set and cache was not cleared in the last 24 hours
  *
- * @returns Metadata object with `isCacheValid` (true if cache is ready to be used, false otherwise) and `lastUpdateTimestamp` (timestamp of last cache update or null)
+ * @returns Metadata object with `initialCacheLoad` (true if is fresh install, false if is ready from cache) and `lastUpdateTimestamp` (timestamp of last cache update or undefined)
  */
 function validateCache(options, storage, settings, keys, splits, rbSegments, segments, largeSegments) {
     return Promise.resolve(storage.load && storage.load()).then(function () {
@@ -63,8 +63,8 @@ function validateCache(options, storage, settings, keys, splits, rbSegments, seg
         var isThereCache = splits.getChangeNumber() > -1;
         // Get lastUpdateTimestamp from storage
         var lastUpdatedTimestampStr = storage.getItem(keys.buildLastUpdatedKey());
-        var lastUpdatedTimestamp = lastUpdatedTimestampStr ? parseInt(lastUpdatedTimestampStr, 10) : null;
-        var lastUpdateTimestamp = (!(0, lang_1.isNaNNumber)(lastUpdatedTimestamp) && lastUpdatedTimestamp !== null) ? lastUpdatedTimestamp : null;
+        var lastUpdatedTimestamp = lastUpdatedTimestampStr ? parseInt(lastUpdatedTimestampStr, 10) : undefined;
+        var lastUpdateTimestamp = (!(0, lang_1.isNaNNumber)(lastUpdatedTimestamp) && lastUpdatedTimestamp !== undefined) ? lastUpdatedTimestamp : undefined;
         if (validateExpiration(options, storage, settings, keys, currentTimestamp, isThereCache)) {
             splits.clear();
             rbSegments.clear();
@@ -81,13 +81,13 @@ function validateCache(options, storage, settings, keys, splits, rbSegments, seg
             if (storage.save)
                 storage.save();
             return {
-                isCacheValid: false,
-                lastUpdateTimestamp: null
+                initialCacheLoad: true,
+                lastUpdateTimestamp: undefined
             };
         }
         // Check if ready from cache
         return {
-            isCacheValid: isThereCache,
+            initialCacheLoad: !isThereCache,
             lastUpdateTimestamp: lastUpdateTimestamp
         };
     });

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

@@ -45,9 +45,9 @@ function fromObjectUpdaterFactory(splitsParser, storage, readiness, settings) {
                 readiness.splits.emit(constants_2.SDK_SPLITS_ARRIVED, { type: constants_2.FLAGS_UPDATE, names: [] });
                 if (startingUp) {
                     startingUp = false;
-                    Promise.resolve(storage.validateCache ? storage.validateCache() : { isCacheValid: false, lastUpdateTimestamp: null }).then(function (cacheMetadata) {
+                    Promise.resolve(storage.validateCache ? storage.validateCache() : { initialCacheLoad: true /* Fallback: assume initial load when validateCache doesn't exist */ }).then(function (cacheMetadata) {
                         // Emits SDK_READY_FROM_CACHE
-                        if (cacheMetadata.isCacheValid) {
+                        if (!cacheMetadata.initialCacheLoad) {
                             readiness.splits.emit(constants_2.SDK_SPLITS_CACHE_LOADED, cacheMetadata);
                         }
                         // Emits SDK_READY

package/cjs/sync/syncManagerOnline.js

@@ -71,12 +71,12 @@ function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFactory) {
                 running = true;
                 // @TODO once event, impression and telemetry storages support persistence, call when `validateCache` promise is resolved
                 submitterManager.start(!(0, consent_1.isConsentGranted)(settings));
-                return Promise.resolve(storage.validateCache ? storage.validateCache() : { isCacheValid: false, lastUpdateTimestamp: null }).then(function (cacheMetadata) {
+                return Promise.resolve(storage.validateCache ? storage.validateCache() : { initialCacheLoad: true /* Fallback: assume initial load when validateCache doesn't exist */ }).then(function (cacheMetadata) {
                     if (!running)
                         return;
                     if (startFirstTime) {
                         // Emits SDK_READY_FROM_CACHE
-                        if (cacheMetadata.isCacheValid) {
+                        if (!cacheMetadata.initialCacheLoad) {
                             readiness.splits.emit(constants_4.SDK_SPLITS_CACHE_LOADED, cacheMetadata);
                         }
                     }

package/cjs/utils/settingsValidation/storage/storageCS.js

@@ -6,7 +6,7 @@ var constants_1 = require("../../../logger/constants");
 var constants_2 = require("../../../utils/constants");
 function __InLocalStorageMockFactory(params) {
     var result = (0, InMemoryStorageCS_1.InMemoryStorageCSFactory)(params);
-    result.validateCache = function () { return Promise.resolve({ isCacheValid: true, lastUpdateTimestamp: null }); }; // to emit SDK_READY_FROM_CACHE
+    result.validateCache = function () { return Promise.resolve({ initialCacheLoad: false /* Not an initial load, cache exists - to emit SDK_READY_FROM_CACHE */ }); };
     return result;
 }
 exports.__InLocalStorageMockFactory = __InLocalStorageMockFactory;

package/esm/readiness/readinessManager.js

@@ -36,9 +36,11 @@ export function readinessManagerFactory(EventEmitter, settings, splits, isShared
         // ensure lastUpdate is always increasing per event, is case Date.now() is mocked or its value is the same
         lastUpdate = dateNow > lastUpdate ? dateNow : lastUpdate + 1;
     }
+    var metadataReady = {
+        initialCacheLoad: true
+    };
     // emit SDK_READY_FROM_CACHE
     var isReadyFromCache = false;
-    var cacheLastUpdateTimestamp = null;
     if (splits.splitsCacheLoaded)
         isReadyFromCache = true; // ready from cache, but doesn't emit SDK_READY_FROM_CACHE
     else
@@ -67,16 +69,13 @@ export function readinessManagerFactory(EventEmitter, settings, splits, isShared
     if (splits.hasInit)
         __init();
     function checkIsReadyFromCache(cacheMetadata) {
+        metadataReady = cacheMetadata;
         isReadyFromCache = true;
-        cacheLastUpdateTimestamp = cacheMetadata.lastUpdateTimestamp;
         // Don't emit SDK_READY_FROM_CACHE if SDK_READY has been emitted
         if (!isReady && !isDestroyed) {
             try {
                 syncLastUpdate();
-                gate.emit(SDK_READY_FROM_CACHE, {
-                    initialCacheLoad: !cacheMetadata.isCacheValid,
-                    lastUpdateTimestamp: cacheLastUpdateTimestamp
-                });
+                gate.emit(SDK_READY_FROM_CACHE, cacheMetadata);
             }
             catch (e) {
                 // throws user callback exceptions in next tick
@@ -102,19 +101,15 @@ export function readinessManagerFactory(EventEmitter, settings, splits, isShared
                 clearTimeout(readyTimeoutId);
                 isReady = true;
                 try {
-                    var wasReadyFromCache = isReadyFromCache;
+                    syncLastUpdate();
                     if (!isReadyFromCache) {
                         isReadyFromCache = true;
                         var metadataReadyFromCache = {
                             initialCacheLoad: true,
-                            lastUpdateTimestamp: null // No cache timestamp when fresh install
+                            lastUpdateTimestamp: undefined // No cache timestamp when fresh install
                         };
                         gate.emit(SDK_READY_FROM_CACHE, metadataReadyFromCache);
                     }
-                    var metadataReady = {
-                        initialCacheLoad: !wasReadyFromCache,
-                        lastUpdateTimestamp: wasReadyFromCache ? cacheLastUpdateTimestamp : null
-                    };
                     gate.emit(SDK_READY, metadataReady);
                 }
                 catch (e) {

package/esm/sdkFactory/index.js

@@ -43,17 +43,17 @@ export function sdkFactory(params) {
                 return;
             }
             readiness.splits.emit(SDK_SPLITS_ARRIVED);
-            readiness.segments.emit(SDK_SEGMENTS_ARRIVED, { isCacheValid: true, lastUpdateTimestamp: null });
+            readiness.segments.emit(SDK_SEGMENTS_ARRIVED);
         },
         onReadyFromCacheCb: function () {
-            readiness.splits.emit(SDK_SPLITS_CACHE_LOADED, { isCacheValid: true, lastUpdateTimestamp: null });
+            readiness.splits.emit(SDK_SPLITS_CACHE_LOADED, { initialCacheLoad: false /* Not an initial load, cache exists */ });
         }
     });
     var fallbackTreatmentsCalculator = new FallbackTreatmentsCalculator(settings.fallbackTreatments);
     if (initialRolloutPlan) {
         setRolloutPlan(log, initialRolloutPlan, storage, key && getMatching(key));
         if (storage.splits.getChangeNumber() > -1)
-            readiness.splits.emit(SDK_SPLITS_CACHE_LOADED, { isCacheValid: true, lastUpdateTimestamp: null });
+            readiness.splits.emit(SDK_SPLITS_CACHE_LOADED, { initialCacheLoad: false /* Not an initial load, cache exists */ });
     }
     var clients = {};
     var telemetryTracker = telemetryTrackerFactory(storage.telemetry, platform.now);

package/esm/storages/inLocalStorage/validateCache.js

@@ -52,7 +52,7 @@ function validateExpiration(options, storage, settings, keys, currentTimestamp,
  * - its hash has changed, i.e., the SDK key, flags filter criteria or flags spec version was modified
  * - `clearOnInit` was set and cache was not cleared in the last 24 hours
  *
- * @returns Metadata object with `isCacheValid` (true if cache is ready to be used, false otherwise) and `lastUpdateTimestamp` (timestamp of last cache update or null)
+ * @returns Metadata object with `initialCacheLoad` (true if is fresh install, false if is ready from cache) and `lastUpdateTimestamp` (timestamp of last cache update or undefined)
  */
 export function validateCache(options, storage, settings, keys, splits, rbSegments, segments, largeSegments) {
     return Promise.resolve(storage.load && storage.load()).then(function () {
@@ -60,8 +60,8 @@ export function validateCache(options, storage, settings, keys, splits, rbSegmen
         var isThereCache = splits.getChangeNumber() > -1;
         // Get lastUpdateTimestamp from storage
         var lastUpdatedTimestampStr = storage.getItem(keys.buildLastUpdatedKey());
-        var lastUpdatedTimestamp = lastUpdatedTimestampStr ? parseInt(lastUpdatedTimestampStr, 10) : null;
-        var lastUpdateTimestamp = (!isNaNNumber(lastUpdatedTimestamp) && lastUpdatedTimestamp !== null) ? lastUpdatedTimestamp : null;
+        var lastUpdatedTimestamp = lastUpdatedTimestampStr ? parseInt(lastUpdatedTimestampStr, 10) : undefined;
+        var lastUpdateTimestamp = (!isNaNNumber(lastUpdatedTimestamp) && lastUpdatedTimestamp !== undefined) ? lastUpdatedTimestamp : undefined;
         if (validateExpiration(options, storage, settings, keys, currentTimestamp, isThereCache)) {
             splits.clear();
             rbSegments.clear();
@@ -78,13 +78,13 @@ export function validateCache(options, storage, settings, keys, splits, rbSegmen
             if (storage.save)
                 storage.save();
             return {
-                isCacheValid: false,
-                lastUpdateTimestamp: null
+                initialCacheLoad: true,
+                lastUpdateTimestamp: undefined
             };
         }
         // Check if ready from cache
         return {
-            isCacheValid: isThereCache,
+            initialCacheLoad: !isThereCache,
             lastUpdateTimestamp: lastUpdateTimestamp
         };
     });

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

@@ -42,9 +42,9 @@ export function fromObjectUpdaterFactory(splitsParser, storage, readiness, setti
                 readiness.splits.emit(SDK_SPLITS_ARRIVED, { type: FLAGS_UPDATE, names: [] });
                 if (startingUp) {
                     startingUp = false;
-                    Promise.resolve(storage.validateCache ? storage.validateCache() : { isCacheValid: false, lastUpdateTimestamp: null }).then(function (cacheMetadata) {
+                    Promise.resolve(storage.validateCache ? storage.validateCache() : { initialCacheLoad: true /* Fallback: assume initial load when validateCache doesn't exist */ }).then(function (cacheMetadata) {
                         // Emits SDK_READY_FROM_CACHE
-                        if (cacheMetadata.isCacheValid) {
+                        if (!cacheMetadata.initialCacheLoad) {
                             readiness.splits.emit(SDK_SPLITS_CACHE_LOADED, cacheMetadata);
                         }
                         // Emits SDK_READY

package/esm/sync/syncManagerOnline.js

@@ -68,12 +68,12 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
                 running = true;
                 // @TODO once event, impression and telemetry storages support persistence, call when `validateCache` promise is resolved
                 submitterManager.start(!isConsentGranted(settings));
-                return Promise.resolve(storage.validateCache ? storage.validateCache() : { isCacheValid: false, lastUpdateTimestamp: null }).then(function (cacheMetadata) {
+                return Promise.resolve(storage.validateCache ? storage.validateCache() : { initialCacheLoad: true /* Fallback: assume initial load when validateCache doesn't exist */ }).then(function (cacheMetadata) {
                     if (!running)
                         return;
                     if (startFirstTime) {
                         // Emits SDK_READY_FROM_CACHE
-                        if (cacheMetadata.isCacheValid) {
+                        if (!cacheMetadata.initialCacheLoad) {
                             readiness.splits.emit(SDK_SPLITS_CACHE_LOADED, cacheMetadata);
                         }
                     }

package/esm/utils/settingsValidation/storage/storageCS.js

@@ -3,7 +3,7 @@ import { ERROR_STORAGE_INVALID } from '../../../logger/constants';
 import { LOCALHOST_MODE, STANDALONE_MODE, STORAGE_PLUGGABLE, STORAGE_LOCALSTORAGE, STORAGE_MEMORY } from '../../../utils/constants';
 export function __InLocalStorageMockFactory(params) {
     var result = InMemoryStorageCSFactory(params);
-    result.validateCache = function () { return Promise.resolve({ isCacheValid: true, lastUpdateTimestamp: null }); }; // to emit SDK_READY_FROM_CACHE
+    result.validateCache = function () { return Promise.resolve({ initialCacheLoad: false /* Not an initial load, cache exists - to emit SDK_READY_FROM_CACHE */ }); };
     return result;
 }
 __InLocalStorageMockFactory.type = STORAGE_MEMORY;

package/package.json

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

package/src/readiness/readinessManager.ts

@@ -1,9 +1,8 @@
 import { objectAssign } from '../utils/lang/objectAssign';
 import { ISettings } from '../types';
-import SplitIO from '../../types/splitio';
+import SplitIO, { SdkReadyMetadata } from '../../types/splitio';
 import { SDK_SPLITS_ARRIVED, SDK_SPLITS_CACHE_LOADED, SDK_SEGMENTS_ARRIVED, SDK_READY_TIMED_OUT, SDK_READY_FROM_CACHE, SDK_UPDATE, SDK_READY } from './constants';
 import { IReadinessEventEmitter, IReadinessManager, ISegmentsEventEmitter, ISplitsEventEmitter } from './types';
-import { CacheValidationMetadata } from '../storages/inLocalStorage/validateCache';
 
 function splitsEventEmitterFactory(EventEmitter: new () => SplitIO.IEventEmitter): ISplitsEventEmitter {
   const splitsEventEmitter = objectAssign(new EventEmitter(), {
@@ -54,9 +53,12 @@ export function readinessManagerFactory(
     lastUpdate = dateNow > lastUpdate ? dateNow : lastUpdate + 1;
   }
 
+  let metadataReady: SdkReadyMetadata = {
+    initialCacheLoad: true
+  };
+
   // emit SDK_READY_FROM_CACHE
   let isReadyFromCache = false;
-  let cacheLastUpdateTimestamp: number | null = null;
   if (splits.splitsCacheLoaded) isReadyFromCache = true; // ready from cache, but doesn't emit SDK_READY_FROM_CACHE
   else splits.once(SDK_SPLITS_CACHE_LOADED, checkIsReadyFromCache);
 
@@ -86,17 +88,14 @@ export function readinessManagerFactory(
   splits.initCallbacks.push(__init);
   if (splits.hasInit) __init();
 
-  function checkIsReadyFromCache(cacheMetadata: CacheValidationMetadata) {
+  function checkIsReadyFromCache(cacheMetadata: SdkReadyMetadata) {
+    metadataReady = cacheMetadata;
     isReadyFromCache = true;
-    cacheLastUpdateTimestamp = cacheMetadata.lastUpdateTimestamp;
     // Don't emit SDK_READY_FROM_CACHE if SDK_READY has been emitted
     if (!isReady && !isDestroyed) {
       try {
         syncLastUpdate();
-        gate.emit(SDK_READY_FROM_CACHE, {
-          initialCacheLoad: !cacheMetadata.isCacheValid,
-          lastUpdateTimestamp: cacheLastUpdateTimestamp
-        });
+        gate.emit(SDK_READY_FROM_CACHE, cacheMetadata);
       } catch (e) {
         // throws user callback exceptions in next tick
         setTimeout(() => { throw e; }, 0);
@@ -119,19 +118,15 @@ export function readinessManagerFactory(
         clearTimeout(readyTimeoutId);
         isReady = true;
         try {
-          const wasReadyFromCache = isReadyFromCache;
+          syncLastUpdate();
           if (!isReadyFromCache) {
             isReadyFromCache = true;
             const metadataReadyFromCache: SplitIO.SdkReadyMetadata = {
-              initialCacheLoad: true,
-              lastUpdateTimestamp: null // No cache timestamp when fresh install
+              initialCacheLoad: true, // Fresh install, no cache existed
+              lastUpdateTimestamp: undefined // No cache timestamp when fresh install
             };
             gate.emit(SDK_READY_FROM_CACHE, metadataReadyFromCache);
           }
-          const metadataReady: SplitIO.SdkReadyMetadata = {
-            initialCacheLoad: !wasReadyFromCache,
-            lastUpdateTimestamp: wasReadyFromCache ? cacheLastUpdateTimestamp : null
-          };
           gate.emit(SDK_READY, metadataReady);
         } catch (e) {
           // throws user callback exceptions in next tick

package/src/sdkFactory/index.ts

@@ -54,10 +54,10 @@ export function sdkFactory(params: ISdkFactoryParams): SplitIO.ISDK | SplitIO.IA
         return;
       }
       readiness.splits.emit(SDK_SPLITS_ARRIVED);
-      readiness.segments.emit(SDK_SEGMENTS_ARRIVED, { isCacheValid: true, lastUpdateTimestamp: null });
+      readiness.segments.emit(SDK_SEGMENTS_ARRIVED);
     },
     onReadyFromCacheCb() {
-      readiness.splits.emit(SDK_SPLITS_CACHE_LOADED, { isCacheValid: true, lastUpdateTimestamp: null });
+      readiness.splits.emit(SDK_SPLITS_CACHE_LOADED, { initialCacheLoad: false /* Not an initial load, cache exists */ });
     }
   });
 
@@ -65,7 +65,7 @@ export function sdkFactory(params: ISdkFactoryParams): SplitIO.ISDK | SplitIO.IA
 
   if (initialRolloutPlan) {
     setRolloutPlan(log, initialRolloutPlan, storage as IStorageSync, key && getMatching(key));
-    if ((storage as IStorageSync).splits.getChangeNumber() > -1) readiness.splits.emit(SDK_SPLITS_CACHE_LOADED, { isCacheValid: true, lastUpdateTimestamp: null });
+    if ((storage as IStorageSync).splits.getChangeNumber() > -1) readiness.splits.emit(SDK_SPLITS_CACHE_LOADED, { initialCacheLoad: false /* Not an initial load, cache exists */ });
   }
 
   const clients: Record<string, SplitIO.IBasicClient> = {};

package/src/storages/inLocalStorage/index.ts

@@ -14,7 +14,7 @@ import { STORAGE_LOCALSTORAGE } from '../../utils/constants';
 import { shouldRecordTelemetry, TelemetryCacheInMemory } from '../inMemory/TelemetryCacheInMemory';
 import { UniqueKeysCacheInMemoryCS } from '../inMemory/UniqueKeysCacheInMemoryCS';
 import { getMatching } from '../../utils/key';
-import { validateCache, CacheValidationMetadata } from './validateCache';
+import { validateCache } from './validateCache';
 import { ILogger } from '../../logger/types';
 import SplitIO from '../../../types/splitio';
 import { storageAdapter } from './storageAdapter';
@@ -54,7 +54,7 @@ export function InLocalStorage(options: SplitIO.InLocalStorageOptions = {}): ISt
     const rbSegments = new RBSegmentsCacheInLocal(settings, keys, storage);
     const segments = new MySegmentsCacheInLocal(log, keys, storage);
     const largeSegments = new MySegmentsCacheInLocal(log, myLargeSegmentsKeyBuilder(prefix, matchingKey), storage);
-    let validateCachePromise: Promise<CacheValidationMetadata> | undefined;
+    let validateCachePromise: Promise<SplitIO.SdkReadyMetadata> | undefined;
 
     return {
       splits,

package/src/storages/inLocalStorage/validateCache.ts

@@ -12,11 +12,6 @@ import { StorageAdapter } from '../types';
 const DEFAULT_CACHE_EXPIRATION_IN_DAYS = 10;
 const MILLIS_IN_A_DAY = 86400000;
 
-export interface CacheValidationMetadata {
-  isCacheValid: boolean;
-  lastUpdateTimestamp: number | null;
-}
-
 /**
  * Validates if cache should be cleared and sets the cache `hash` if needed.
  *
@@ -71,9 +66,9 @@ function validateExpiration(options: SplitIO.InLocalStorageOptions, storage: Sto
  * - its hash has changed, i.e., the SDK key, flags filter criteria or flags spec version was modified
  * - `clearOnInit` was set and cache was not cleared in the last 24 hours
  *
- * @returns Metadata object with `isCacheValid` (true if cache is ready to be used, false otherwise) and `lastUpdateTimestamp` (timestamp of last cache update or null)
+ * @returns Metadata object with `initialCacheLoad` (true if is fresh install, false if is ready from cache) and `lastUpdateTimestamp` (timestamp of last cache update or undefined)
  */
-export function validateCache(options: SplitIO.InLocalStorageOptions, storage: StorageAdapter, settings: ISettings, keys: KeyBuilderCS, splits: SplitsCacheInLocal, rbSegments: RBSegmentsCacheInLocal, segments: MySegmentsCacheInLocal, largeSegments: MySegmentsCacheInLocal): Promise<CacheValidationMetadata> {
+export function validateCache(options: SplitIO.InLocalStorageOptions, storage: StorageAdapter, settings: ISettings, keys: KeyBuilderCS, splits: SplitsCacheInLocal, rbSegments: RBSegmentsCacheInLocal, segments: MySegmentsCacheInLocal, largeSegments: MySegmentsCacheInLocal): Promise<SplitIO.SdkReadyMetadata> {
 
   return Promise.resolve(storage.load && storage.load()).then(() => {
     const currentTimestamp = Date.now();
@@ -81,8 +76,8 @@ export function validateCache(options: SplitIO.InLocalStorageOptions, storage: S
 
     // Get lastUpdateTimestamp from storage
     const lastUpdatedTimestampStr = storage.getItem(keys.buildLastUpdatedKey());
-    const lastUpdatedTimestamp = lastUpdatedTimestampStr ? parseInt(lastUpdatedTimestampStr, 10) : null;
-    const lastUpdateTimestamp = (!isNaNNumber(lastUpdatedTimestamp) && lastUpdatedTimestamp !== null) ? lastUpdatedTimestamp : null;
+    const lastUpdatedTimestamp = lastUpdatedTimestampStr ? parseInt(lastUpdatedTimestampStr, 10) : undefined;
+    const lastUpdateTimestamp = (!isNaNNumber(lastUpdatedTimestamp) && lastUpdatedTimestamp !== undefined) ? lastUpdatedTimestamp : undefined;
 
     if (validateExpiration(options, storage, settings, keys, currentTimestamp, isThereCache)) {
       splits.clear();
@@ -101,14 +96,14 @@ export function validateCache(options: SplitIO.InLocalStorageOptions, storage: S
       if (storage.save) storage.save();
 
       return {
-        isCacheValid: false,
-        lastUpdateTimestamp: null
+        initialCacheLoad: true, // Cache was cleared, so this is an initial load (no cache existed)
+        lastUpdateTimestamp: undefined
       };
     }
 
     // Check if ready from cache
     return {
-      isCacheValid: isThereCache,
+      initialCacheLoad: !isThereCache, // true if no cache exists (initial load), false if cache exists (ready from cache)
       lastUpdateTimestamp
     };
   });

package/src/storages/types.ts

@@ -499,7 +499,7 @@ export interface IStorageSync extends IStorageBase<
   IUniqueKeysCacheSync
 > {
   // Defined in client-side
-  validateCache?: () => Promise<{ isCacheValid: boolean; lastUpdateTimestamp: number | null }>,
+  validateCache?: () => Promise<SplitIO.SdkReadyMetadata>,
   largeSegments?: ISegmentsCacheSync,
 }
 

package/src/sync/offline/syncTasks/fromObjectSyncTask.ts

@@ -59,9 +59,9 @@ export function fromObjectUpdaterFactory(
 
         if (startingUp) {
           startingUp = false;
-          Promise.resolve(storage.validateCache ? storage.validateCache() : { isCacheValid: false, lastUpdateTimestamp: null }).then((cacheMetadata) => {
+          Promise.resolve(storage.validateCache ? storage.validateCache() : { initialCacheLoad: true /* Fallback: assume initial load when validateCache doesn't exist */ }).then((cacheMetadata) => {
             // Emits SDK_READY_FROM_CACHE
-            if (cacheMetadata.isCacheValid) {
+            if (!cacheMetadata.initialCacheLoad) {
               readiness.splits.emit(SDK_SPLITS_CACHE_LOADED, cacheMetadata);
             }
             // Emits SDK_READY

package/src/sync/syncManagerOnline.ts

@@ -92,12 +92,12 @@ export function syncManagerOnlineFactory(
         // @TODO once event, impression and telemetry storages support persistence, call when `validateCache` promise is resolved
         submitterManager.start(!isConsentGranted(settings));
 
-        return Promise.resolve(storage.validateCache ? storage.validateCache() : { isCacheValid: false, lastUpdateTimestamp: null }).then((cacheMetadata) => {
+        return Promise.resolve(storage.validateCache ? storage.validateCache() : { initialCacheLoad: true /* Fallback: assume initial load when validateCache doesn't exist */ }).then((cacheMetadata) => {
           if (!running) return;
 
           if (startFirstTime) {
             // Emits SDK_READY_FROM_CACHE
-            if (cacheMetadata.isCacheValid) {
+            if (!cacheMetadata.initialCacheLoad) {
               readiness.splits.emit(SDK_SPLITS_CACHE_LOADED, cacheMetadata);
             }
 

package/src/utils/settingsValidation/storage/storageCS.ts

@@ -8,7 +8,7 @@ import { IStorageFactoryParams, IStorageSync } from '../../../storages/types';
 
 export function __InLocalStorageMockFactory(params: IStorageFactoryParams): IStorageSync {
   const result = InMemoryStorageCSFactory(params);
-  result.validateCache = () => Promise.resolve({ isCacheValid: true, lastUpdateTimestamp: null }); // to emit SDK_READY_FROM_CACHE
+  result.validateCache = () => Promise.resolve({ initialCacheLoad: false /* Not an initial load, cache exists - to emit SDK_READY_FROM_CACHE */ });
   return result;
 }
 __InLocalStorageMockFactory.type = STORAGE_MEMORY;

package/types/splitio.d.ts

@@ -520,17 +520,17 @@ declare namespace SplitIO {
    */
   type SdkReadyMetadata = {
     /**
-     * Indicates whether the SDK was loaded from cache initially.
-     * - `true` when SDK_READY_FROM_CACHE is emitted from cache (before SDK_READY)
-     * - `true` when SDK_READY is emitted and the SDK was ready from cache first
-     * - `false` when SDK_READY_FROM_CACHE is emitted because SDK became ready without cache
-     * - `false` when SDK_READY is emitted and the SDK was not ready from cache
+     * Indicates whether the SDK was loaded from cache initially. (fresh install or ready from cache)
+     * - `false` when SDK_READY_FROM_CACHE is emitted from cache (before SDK_READY)
+     * - `false` when SDK_READY is emitted and the SDK was ready from cache first
+     * - `true` when SDK_READY_FROM_CACHE is emitted because SDK became ready without cache
+     * - `true` when SDK_READY is emitted and the SDK was not ready from cache
      */
     initialCacheLoad: boolean
     /**
-     * Timestamp in milliseconds since epoch when the event was emitted.
+     * Timestamp in milliseconds since epoch when the cache was last updated. Undefined if `initialCacheLoad` is `true`.
      */
-    lastUpdateTimestamp: number | null
+    lastUpdateTimestamp?: number
   }
 
   /**