Move enum and type to namespace

Author: ZamoraEmmanuel

src/readiness/__tests__/readinessManager.spec.ts

@@ -3,7 +3,7 @@ import { EventEmitter } from '../../utils/MinEvents';
 import { IReadinessManager } from '../types';
 import { SDK_READY, SDK_UPDATE, SDK_SPLITS_ARRIVED, SDK_SEGMENTS_ARRIVED, SDK_READY_FROM_CACHE, SDK_SPLITS_CACHE_LOADED, SDK_READY_TIMED_OUT } from '../constants';
 import { ISettings } from '../../types';
-import { SdkUpdateMetadata, SdkUpdateMetadataKeys } from '../../sync/polling/types';
+import { SdkUpdateMetadata, SdkUpdateMetadataKeys } from '../../../types/splitio';
 
 const settings = {
   startup: {

src/sync/polling/types.ts

@@ -31,15 +31,3 @@ export interface IPollingManagerCS extends IPollingManager {
   remove(matchingKey: string): void;
   get(matchingKey: string): IMySegmentsSyncTask | undefined
 }
-
-export enum SdkUpdateMetadataKeys {
-  FLAGS_UPDATE = 'FLAGS_UPDATE',
-  SEGMENTS_UPDATE = 'SEGMENTS_UPDATE'
-}
-/**
- * SdkUpdateMetadata type for polling updaters
- */
-export type SdkUpdateMetadata = {
-  type: SdkUpdateMetadataKeys.FLAGS_UPDATE | SdkUpdateMetadataKeys.SEGMENTS_UPDATE
-  names: string[]
-}

src/sync/polling/updaters/__tests__/segmentChangesUpdater.spec.ts

@@ -7,7 +7,7 @@ import { loggerMock } from '../../../../logger/__tests__/sdkLogger.mock';
 import { ISegmentChangesFetcher } from '../../fetchers/types';
 import { ISegmentChangesResponse } from '../../../../dtos/types';
 import { SDK_SEGMENTS_ARRIVED } from '../../../../readiness/constants';
-import { SdkUpdateMetadataKeys } from '../../types';
+import { SdkUpdateMetadataKeys } from '../../../../../types/splitio';
 
 describe('segmentChangesUpdater', () => {
   const segments = new SegmentsCacheInMemory();

src/sync/polling/updaters/__tests__/splitChangesUpdater.spec.ts

@@ -16,7 +16,7 @@ import { RBSegmentsCacheInMemory } from '../../../../storages/inMemory/RBSegment
 import { RB_SEGMENT_UPDATE, SPLIT_UPDATE } from '../../../streaming/constants';
 import { IN_RULE_BASED_SEGMENT } from '../../../../utils/constants';
 import { SDK_SPLITS_ARRIVED } from '../../../../readiness/constants';
-import { SdkUpdateMetadataKeys } from '../../types';
+import { SdkUpdateMetadataKeys } from '../../../../../types/splitio';
 
 const ARCHIVED_FF = 'ARCHIVED';
 

src/sync/polling/updaters/segmentChangesUpdater.ts

@@ -5,7 +5,7 @@ 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';
+import { SdkUpdateMetadata, SdkUpdateMetadataKeys } from '../../../../types/splitio';
 
 
 type ISegmentChangesUpdater = (fetchOnlyNew?: boolean, segmentName?: string, noCache?: boolean, till?: number) => Promise<boolean>

src/sync/polling/updaters/splitChangesUpdater.ts

@@ -10,7 +10,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 { SdkUpdateMetadata, SdkUpdateMetadataKeys } from '../types';
+import { SdkUpdateMetadata, SdkUpdateMetadataKeys } from '../../../../types/splitio';
 
 export type InstantUpdate = { payload: ISplit | IRBSegment, changeNumber: number, type: string };
 type SplitChangesUpdater = (noCache?: boolean, till?: number, instantUpdate?: InstantUpdate) => Promise<boolean>

types/splitio.d.ts

@@ -495,17 +495,28 @@ declare namespace SplitIO {
   /**
    * Metadata keys for SDK update events.
    */
-  enum SdkUpdateMetadataKeys {
+  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'
   }
 
   /**
-   * List of modified flags or segments
-   * when a sdk update event is emitted.
+   * Metadata for the update event emitted when the SDK cache is updated with new data for flags or segments.
    */
   type SdkUpdateMetadata = {
+    /**
+     * The type of update event.
+     */
     type: SdkUpdateMetadataKeys.FLAGS_UPDATE | SdkUpdateMetadataKeys.SEGMENTS_UPDATE
+    /**
+     * The names of the flags or segments that were updated.
+     */
     names: string[]
   }