@splitsoftware/splitio-commons 2.10.2-rc.1 → 2.10.2-rc.3

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

@@ -6,6 +6,7 @@ var syncTask_1 = require("../../syncTask");
 var constants_1 = require("../../../utils/constants");
 var constants_2 = require("../../../readiness/constants");
 var constants_3 = require("../../../logger/constants");
+var types_1 = require("../../polling/types");
 /**
  * Offline equivalent of `splitChangesUpdaterFactory`
  */
@@ -42,7 +43,7 @@ function fromObjectUpdaterFactory(splitsParser, storage, readiness, settings) {
                 splitsCache.clear(),
                 splitsCache.update(splits, [], Date.now())
             ]).then(function () {
-                readiness.splits.emit(constants_2.SDK_SPLITS_ARRIVED, { type: "FLAGS_UPDATE" /* FLAGS_UPDATE */, names: [] });
+                readiness.splits.emit(constants_2.SDK_SPLITS_ARRIVED, { type: types_1.SdkUpdateMetadataKeys.FLAGS_UPDATE, names: [] });
                 if (startingUp) {
                     startingUp = false;
                     Promise.resolve(storage.validateCache ? storage.validateCache() : false).then(function (isCacheLoaded) {
@@ -50,7 +51,7 @@ function fromObjectUpdaterFactory(splitsParser, storage, readiness, settings) {
                         if (isCacheLoaded)
                             readiness.splits.emit(constants_2.SDK_SPLITS_CACHE_LOADED);
                         // Emits SDK_READY
-                        readiness.segments.emit(constants_2.SDK_SEGMENTS_ARRIVED, { type: "SEGMENTS_UPDATE" /* SEGMENTS_UPDATE */, names: [] });
+                        readiness.segments.emit(constants_2.SDK_SEGMENTS_ARRIVED, { type: types_1.SdkUpdateMetadataKeys.SEGMENTS_UPDATE, names: [] });
                     });
                 }
                 return true;

package/cjs/sync/polling/types.js

@@ -1,2 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SdkUpdateMetadataKeys = void 0;
+/**
+ * Metadata keys for SDK update events.
+ */
+var SdkUpdateMetadataKeys;
+(function (SdkUpdateMetadataKeys) {
+    /**
+     * The update event emitted when the SDK cache is updated with new data for flags.
+     */
+    SdkUpdateMetadataKeys["FLAGS_UPDATE"] = "FLAGS_UPDATE";
+    /**
+     * The update event emitted when the SDK cache is updated with new data for segments.
+     */
+    SdkUpdateMetadataKeys["SEGMENTS_UPDATE"] = "SEGMENTS_UPDATE";
+})(SdkUpdateMetadataKeys = exports.SdkUpdateMetadataKeys || (exports.SdkUpdateMetadataKeys = {}));

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

@@ -6,6 +6,7 @@ var constants_1 = require("../../../readiness/constants");
 var constants_2 = require("../../../logger/constants");
 var constants_3 = require("../../streaming/constants");
 var AbstractSplitsCacheSync_1 = require("../../../storages/AbstractSplitsCacheSync");
+var types_1 = require("../types");
 /**
  * factory of MySegments updater, a task that:
  *  - fetches mySegments using `mySegmentsFetcher`
@@ -39,7 +40,7 @@ function mySegmentsUpdaterFactory(log, mySegmentsFetcher, storage, segmentsEvent
         // Notify update if required
         if ((0, AbstractSplitsCacheSync_1.usesSegmentsSync)(storage) && (shouldNotifyUpdate || readyOnAlreadyExistentState)) {
             readyOnAlreadyExistentState = false;
-            segmentsEventEmitter.emit(constants_1.SDK_SEGMENTS_ARRIVED, { type: "SEGMENTS_UPDATE" /* SEGMENTS_UPDATE */, names: [] });
+            segmentsEventEmitter.emit(constants_1.SDK_SEGMENTS_ARRIVED, { type: types_1.SdkUpdateMetadataKeys.SEGMENTS_UPDATE, names: [] });
         }
     }
     function _mySegmentsUpdater(retry, segmentsData, noCache, till) {

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

@@ -4,6 +4,7 @@ exports.segmentChangesUpdaterFactory = void 0;
 var constants_1 = require("../../../readiness/constants");
 var constants_2 = require("../../../logger/constants");
 var timeout_1 = require("../../../utils/promise/timeout");
+var types_1 = require("../types");
 /**
  * Factory of SegmentChanges updater, a task that:
  *  - fetches segment changes using `segmentChangesFetcher`
@@ -67,7 +68,7 @@ function segmentChangesUpdaterFactory(log, segmentChangesFetcher, segments, read
                 if (shouldUpdateFlags.some(function (update) { return update; }) || readyOnAlreadyExistentState) {
                     readyOnAlreadyExistentState = false;
                     var metadata = {
-                        type: "SEGMENTS_UPDATE" /* SEGMENTS_UPDATE */,
+                        type: types_1.SdkUpdateMetadataKeys.SEGMENTS_UPDATE,
                         names: []
                     };
                     if (readiness)

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

@@ -8,6 +8,7 @@ var lang_1 = require("../../../utils/lang");
 var constants_3 = require("../../../utils/constants");
 var sets_1 = require("../../../utils/lang/sets");
 var constants_4 = require("../../streaming/constants");
+var types_1 = require("../types");
 // Checks that all registered segments have been fetched (changeNumber !== -1 for every segment).
 // Returns a promise that could be rejected.
 // @TODO review together with Segments and MySegments storage APIs
@@ -165,7 +166,7 @@ function splitChangesUpdaterFactory(log, splitChangesFetcher, storage, splitFilt
                             .catch(function () { return false; } /** noop. just to handle a possible `checkAllSegmentsExist` rejection, before emitting SDK event */)
                             .then(function (emitSplitsArrivedEvent) {
                             var metadata = {
-                                type: updatedFlags.length > 0 ? "FLAGS_UPDATE" /* FLAGS_UPDATE */ : "SEGMENTS_UPDATE" /* SEGMENTS_UPDATE */,
+                                type: updatedFlags.length > 0 ? types_1.SdkUpdateMetadataKeys.FLAGS_UPDATE : types_1.SdkUpdateMetadataKeys.SEGMENTS_UPDATE,
                                 names: updatedFlags.length > 0 ? updatedFlags : []
                             };
                             // emit SDK events

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

@@ -3,6 +3,7 @@ import { syncTaskFactory } from '../../syncTask';
 import { CONTROL } from '../../../utils/constants';
 import { SDK_SPLITS_ARRIVED, SDK_SEGMENTS_ARRIVED, SDK_SPLITS_CACHE_LOADED } from '../../../readiness/constants';
 import { SYNC_OFFLINE_DATA, ERROR_SYNC_OFFLINE_LOADING } from '../../../logger/constants';
+import { SdkUpdateMetadataKeys } from '../../polling/types';
 /**
  * Offline equivalent of `splitChangesUpdaterFactory`
  */
@@ -39,7 +40,7 @@ export function fromObjectUpdaterFactory(splitsParser, storage, readiness, setti
                 splitsCache.clear(),
                 splitsCache.update(splits, [], Date.now())
             ]).then(function () {
-                readiness.splits.emit(SDK_SPLITS_ARRIVED, { type: "FLAGS_UPDATE" /* FLAGS_UPDATE */, names: [] });
+                readiness.splits.emit(SDK_SPLITS_ARRIVED, { type: SdkUpdateMetadataKeys.FLAGS_UPDATE, names: [] });
                 if (startingUp) {
                     startingUp = false;
                     Promise.resolve(storage.validateCache ? storage.validateCache() : false).then(function (isCacheLoaded) {
@@ -47,7 +48,7 @@ export function fromObjectUpdaterFactory(splitsParser, storage, readiness, setti
                         if (isCacheLoaded)
                             readiness.splits.emit(SDK_SPLITS_CACHE_LOADED);
                         // Emits SDK_READY
-                        readiness.segments.emit(SDK_SEGMENTS_ARRIVED, { type: "SEGMENTS_UPDATE" /* SEGMENTS_UPDATE */, names: [] });
+                        readiness.segments.emit(SDK_SEGMENTS_ARRIVED, { type: SdkUpdateMetadataKeys.SEGMENTS_UPDATE, names: [] });
                     });
                 }
                 return true;

package/esm/sync/polling/types.js

@@ -1 +1,14 @@
-export {};
+/**
+ * Metadata keys for SDK update events.
+ */
+export var SdkUpdateMetadataKeys;
+(function (SdkUpdateMetadataKeys) {
+    /**
+     * The update event emitted when the SDK cache is updated with new data for flags.
+     */
+    SdkUpdateMetadataKeys["FLAGS_UPDATE"] = "FLAGS_UPDATE";
+    /**
+     * The update event emitted when the SDK cache is updated with new data for segments.
+     */
+    SdkUpdateMetadataKeys["SEGMENTS_UPDATE"] = "SEGMENTS_UPDATE";
+})(SdkUpdateMetadataKeys || (SdkUpdateMetadataKeys = {}));

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

@@ -3,6 +3,7 @@ import { SDK_SEGMENTS_ARRIVED } from '../../../readiness/constants';
 import { SYNC_MYSEGMENTS_FETCH_RETRY } from '../../../logger/constants';
 import { MEMBERSHIPS_LS_UPDATE } from '../../streaming/constants';
 import { usesSegmentsSync } from '../../../storages/AbstractSplitsCacheSync';
+import { SdkUpdateMetadataKeys } from '../types';
 /**
  * factory of MySegments updater, a task that:
  *  - fetches mySegments using `mySegmentsFetcher`
@@ -36,7 +37,7 @@ export function mySegmentsUpdaterFactory(log, mySegmentsFetcher, storage, segmen
         // Notify update if required
         if (usesSegmentsSync(storage) && (shouldNotifyUpdate || readyOnAlreadyExistentState)) {
             readyOnAlreadyExistentState = false;
-            segmentsEventEmitter.emit(SDK_SEGMENTS_ARRIVED, { type: "SEGMENTS_UPDATE" /* SEGMENTS_UPDATE */, names: [] });
+            segmentsEventEmitter.emit(SDK_SEGMENTS_ARRIVED, { type: SdkUpdateMetadataKeys.SEGMENTS_UPDATE, names: [] });
         }
     }
     function _mySegmentsUpdater(retry, segmentsData, noCache, till) {

package/esm/sync/polling/updaters/segmentChangesUpdater.js

@@ -1,6 +1,7 @@
 import { SDK_SEGMENTS_ARRIVED } from '../../../readiness/constants';
 import { LOG_PREFIX_INSTANTIATION, LOG_PREFIX_SYNC_SEGMENTS } from '../../../logger/constants';
 import { timeout } from '../../../utils/promise/timeout';
+import { SdkUpdateMetadataKeys } from '../types';
 /**
  * Factory of SegmentChanges updater, a task that:
  *  - fetches segment changes using `segmentChangesFetcher`
@@ -64,7 +65,7 @@ export function segmentChangesUpdaterFactory(log, segmentChangesFetcher, segment
                 if (shouldUpdateFlags.some(function (update) { return update; }) || readyOnAlreadyExistentState) {
                     readyOnAlreadyExistentState = false;
                     var metadata = {
-                        type: "SEGMENTS_UPDATE" /* SEGMENTS_UPDATE */,
+                        type: SdkUpdateMetadataKeys.SEGMENTS_UPDATE,
                         names: []
                     };
                     if (readiness)

package/esm/sync/polling/updaters/splitChangesUpdater.js

@@ -5,6 +5,7 @@ import { startsWith } from '../../../utils/lang';
 import { IN_RULE_BASED_SEGMENT, IN_SEGMENT, RULE_BASED_SEGMENT, STANDARD_SEGMENT } from '../../../utils/constants';
 import { setToArray } from '../../../utils/lang/sets';
 import { SPLIT_UPDATE } from '../../streaming/constants';
+import { SdkUpdateMetadataKeys } from '../types';
 // Checks that all registered segments have been fetched (changeNumber !== -1 for every segment).
 // Returns a promise that could be rejected.
 // @TODO review together with Segments and MySegments storage APIs
@@ -160,7 +161,7 @@ export function splitChangesUpdaterFactory(log, splitChangesFetcher, storage, sp
                             .catch(function () { return false; } /** noop. just to handle a possible `checkAllSegmentsExist` rejection, before emitting SDK event */)
                             .then(function (emitSplitsArrivedEvent) {
                             var metadata = {
-                                type: updatedFlags.length > 0 ? "FLAGS_UPDATE" /* FLAGS_UPDATE */ : "SEGMENTS_UPDATE" /* SEGMENTS_UPDATE */,
+                                type: updatedFlags.length > 0 ? SdkUpdateMetadataKeys.FLAGS_UPDATE : SdkUpdateMetadataKeys.SEGMENTS_UPDATE,
                                 names: updatedFlags.length > 0 ? updatedFlags : []
                             };
                             // emit SDK events

package/package.json

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

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

@@ -9,7 +9,7 @@ import { ISettings } from '../../../types';
 import { CONTROL } from '../../../utils/constants';
 import { SDK_SPLITS_ARRIVED, SDK_SEGMENTS_ARRIVED, SDK_SPLITS_CACHE_LOADED } from '../../../readiness/constants';
 import { SYNC_OFFLINE_DATA, ERROR_SYNC_OFFLINE_LOADING } from '../../../logger/constants';
-import { SdkUpdateMetadataKeys } from '../../../../types/splitio';
+import { SdkUpdateMetadataKeys } from '../../polling/types';
 
 /**
  * Offline equivalent of `splitChangesUpdaterFactory`

package/src/sync/polling/types.ts

@@ -4,6 +4,20 @@ import { IStorageSync } from '../../storages/types';
 import { MEMBERSHIPS_LS_UPDATE, MEMBERSHIPS_MS_UPDATE } from '../streaming/types';
 import { ITask, ISyncTask } from '../types';
 
+/**
+ * Metadata keys for SDK update events.
+ */
+export enum SdkUpdateMetadataKeys {
+  /**
+   * The update event emitted when the SDK cache is updated with new data for flags.
+   */
+  FLAGS_UPDATE = 'FLAGS_UPDATE',
+  /**
+   * The update event emitted when the SDK cache is updated with new data for segments.
+   */
+  SEGMENTS_UPDATE = 'SEGMENTS_UPDATE'
+}
+
 export interface ISplitsSyncTask extends ISyncTask<[noCache?: boolean, till?: number, splitUpdateNotification?: { payload: ISplit | IRBSegment, changeNumber: number }], boolean> { }
 
 export interface ISegmentsSyncTask extends ISyncTask<[fetchOnlyNew?: boolean, segmentName?: string, noCache?: boolean, till?: number], boolean> { }

package/src/sync/polling/updaters/mySegmentsUpdater.ts

@@ -9,7 +9,7 @@ import { MySegmentsData } from '../types';
 import { IMembershipsResponse } from '../../../dtos/types';
 import { MEMBERSHIPS_LS_UPDATE } from '../../streaming/constants';
 import { usesSegmentsSync } from '../../../storages/AbstractSplitsCacheSync';
-import { SdkUpdateMetadataKeys } from '../../../../types/splitio';
+import { SdkUpdateMetadataKeys } from '../types';
 
 type IMySegmentsUpdater = (segmentsData?: MySegmentsData, noCache?: boolean, till?: number) => Promise<boolean>
 

package/src/sync/polling/updaters/segmentChangesUpdater.ts

@@ -5,7 +5,8 @@ import { SDK_SEGMENTS_ARRIVED } from '../../../readiness/constants';
 import { ILogger } from '../../../logger/types';
 import { LOG_PREFIX_INSTANTIATION, LOG_PREFIX_SYNC_SEGMENTS } from '../../../logger/constants';
 import { timeout } from '../../../utils/promise/timeout';
-import { SdkUpdateMetadata, SdkUpdateMetadataKeys } from '../../../../types/splitio';
+import { SdkUpdateMetadata } from '../../../../types/splitio';
+import { SdkUpdateMetadataKeys } from '../types';
 
 
 type ISegmentChangesUpdater = (fetchOnlyNew?: boolean, segmentName?: string, noCache?: boolean, till?: number) => Promise<boolean>

package/src/sync/polling/updaters/splitChangesUpdater.ts

@@ -10,7 +10,8 @@ import { startsWith } from '../../../utils/lang';
 import { IN_RULE_BASED_SEGMENT, IN_SEGMENT, RULE_BASED_SEGMENT, STANDARD_SEGMENT } from '../../../utils/constants';
 import { setToArray } from '../../../utils/lang/sets';
 import { SPLIT_UPDATE } from '../../streaming/constants';
-import { SdkUpdateMetadata, SdkUpdateMetadataKeys } from '../../../../types/splitio';
+import { SdkUpdateMetadata } from '../../../../types/splitio';
+import { SdkUpdateMetadataKeys } from '../types';
 
 export type InstantUpdate = { payload: ISplit | IRBSegment, changeNumber: number, type: string };
 type SplitChangesUpdater = (noCache?: boolean, till?: number, instantUpdate?: InstantUpdate) => Promise<boolean>

package/types/splitio.d.ts

@@ -492,20 +492,6 @@ declare namespace SplitIO {
     removeItem(key: string): void | Promise<void>;
   }
 
-  /**
-   * Metadata keys for SDK update events.
-   */
-  const enum SdkUpdateMetadataKeys {
-    /**
-     * The update event emitted when the SDK cache is updated with new data for flags.
-     */
-    FLAGS_UPDATE = 'FLAGS_UPDATE',
-    /**
-     * The update event emitted when the SDK cache is updated with new data for segments.
-     */
-    SEGMENTS_UPDATE = 'SEGMENTS_UPDATE'
-  }
-
   /**
    * Metadata for the update event emitted when the SDK cache is updated with new data for flags or segments.
    */
@@ -513,13 +499,22 @@ declare namespace SplitIO {
     /**
      * The type of update event.
      */
-    type: SdkUpdateMetadataKeys.FLAGS_UPDATE | SdkUpdateMetadataKeys.SEGMENTS_UPDATE
+    type: 'FLAGS_UPDATE' | 'SEGMENTS_UPDATE'
     /**
      * The names of the flags or segments that were updated.
      */
     names: string[]
   }
 
+  /**
+   * Metadata keys for SDK update events.
+   * Use the string literals directly: 'FLAGS_UPDATE' or 'SEGMENTS_UPDATE'
+   */
+  type SdkUpdateMetadataKeys = {
+    FLAGS_UPDATE: 'FLAGS_UPDATE';
+    SEGMENTS_UPDATE: 'SEGMENTS_UPDATE';
+  };
+
   /**
    * Metadata for the ready events emitted when the SDK is ready to evaluate feature flags.
    */