Fix types

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 { EventMetadata, SdkUpdateMetadataKeys } from '../../sync/polling/types';
+import { SdkUpdateMetadata, SdkUpdateMetadataKeys } from '../../sync/polling/types';
 
 const settings = {
   startup: {
@@ -309,12 +309,12 @@ test('READINESS MANAGER / SDK_UPDATE should emit with metadata', () => {
   readinessManager.splits.emit(SDK_SPLITS_ARRIVED);
   readinessManager.segments.emit(SDK_SEGMENTS_ARRIVED);
 
-  const metadata: EventMetadata = {
+  const metadata: SdkUpdateMetadata = {
     [SdkUpdateMetadataKeys.UPDATED_FLAGS]: ['flag1', 'flag2']
   };
 
-  let receivedMetadata: EventMetadata | undefined;
-  readinessManager.gate.on(SDK_UPDATE, (meta: EventMetadata) => {
+  let receivedMetadata: SdkUpdateMetadata | undefined;
+  readinessManager.gate.on(SDK_UPDATE, (meta: SdkUpdateMetadata) => {
     receivedMetadata = meta;
   });
 
@@ -331,7 +331,7 @@ test('READINESS MANAGER / SDK_UPDATE should handle undefined metadata', () => {
   readinessManager.segments.emit(SDK_SEGMENTS_ARRIVED);
 
   let receivedMetadata: any;
-  readinessManager.gate.on(SDK_UPDATE, (meta: EventMetadata) => {
+  readinessManager.gate.on(SDK_UPDATE, (meta: SdkUpdateMetadata) => {
     receivedMetadata = meta;
   });
 
@@ -347,12 +347,12 @@ test('READINESS MANAGER / SDK_UPDATE should forward metadata from segments', ()
   readinessManager.splits.emit(SDK_SPLITS_ARRIVED);
   readinessManager.segments.emit(SDK_SEGMENTS_ARRIVED);
 
-  const metadata: EventMetadata = {
+  const metadata: SdkUpdateMetadata = {
     [SdkUpdateMetadataKeys.UPDATED_SEGMENTS]: ['segment1', 'segment2']
   };
 
-  let receivedMetadata: EventMetadata | undefined;
-  readinessManager.gate.on(SDK_UPDATE, (meta: EventMetadata) => {
+  let receivedMetadata: SdkUpdateMetadata | undefined;
+  readinessManager.gate.on(SDK_UPDATE, (meta: SdkUpdateMetadata) => {
     receivedMetadata = meta;
   });
 

src/readiness/types.ts

@@ -1,5 +1,19 @@
 import SplitIO from '../../types/splitio';
+import { SdkUpdateMetadata } from '../sync/polling/types';
 
+/** Readiness event types */
+
+export type SDK_READY_TIMED_OUT = 'init::timeout'
+export type SDK_READY = 'init::ready'
+export type SDK_READY_FROM_CACHE = 'init::cache-ready'
+export type SDK_UPDATE = 'state::update'
+export type SDK_DESTROY = 'state::destroy'
+
+export type IReadinessEvent = SDK_READY_TIMED_OUT | SDK_READY | SDK_READY_FROM_CACHE | SDK_UPDATE | SDK_DESTROY
+
+export interface IReadinessEventEmitter extends SplitIO.IEventEmitter {
+  emit(event: IReadinessEvent, ...args: any[]): boolean
+}
 /** Splits data emitter */
 
 type SDK_SPLITS_ARRIVED = 'state::splits-arrived'
@@ -9,6 +23,7 @@ type ISplitsEvent = SDK_SPLITS_ARRIVED | SDK_SPLITS_CACHE_LOADED
 export interface ISplitsEventEmitter extends SplitIO.IEventEmitter {
   emit(event: ISplitsEvent, ...args: any[]): boolean
   on(event: ISplitsEvent, listener: (...args: any[]) => void): this;
+  on(event: SDK_UPDATE, listener: (metadata: SdkUpdateMetadata) => void): this;
   once(event: ISplitsEvent, listener: (...args: any[]) => void): this;
   splitsArrived: boolean
   splitsCacheLoaded: boolean
@@ -24,23 +39,11 @@ type ISegmentsEvent = SDK_SEGMENTS_ARRIVED
 export interface ISegmentsEventEmitter extends SplitIO.IEventEmitter {
   emit(event: ISegmentsEvent, ...args: any[]): boolean
   on(event: ISegmentsEvent, listener: (...args: any[]) => void): this;
+  on(event: SDK_UPDATE, listener: (metadata: SdkUpdateMetadata) => void): this;
   once(event: ISegmentsEvent, listener: (...args: any[]) => void): this;
   segmentsArrived: boolean
 }
 
-/** Readiness emitter */
-
-export type SDK_READY_TIMED_OUT = 'init::timeout'
-export type SDK_READY = 'init::ready'
-export type SDK_READY_FROM_CACHE = 'init::cache-ready'
-export type SDK_UPDATE = 'state::update'
-export type SDK_DESTROY = 'state::destroy'
-export type IReadinessEvent = SDK_READY_TIMED_OUT | SDK_READY | SDK_READY_FROM_CACHE | SDK_UPDATE | SDK_DESTROY
-
-export interface IReadinessEventEmitter extends SplitIO.IEventEmitter {
-  emit(event: IReadinessEvent, ...args: any[]): boolean
-}
-
 /** Readiness manager */
 
 export interface IReadinessManager {

src/sync/streaming/types.ts

@@ -1,8 +1,9 @@
 import { IMembershipMSUpdateData, IMembershipLSUpdateData, ISegmentUpdateData, ISplitUpdateData, ISplitKillData, INotificationData } from './SSEHandler/types';
 import { ITask } from '../types';
-import { IMySegmentsSyncTask } from '../polling/types';
+import { IMySegmentsSyncTask, SdkUpdateMetadata } from '../polling/types';
 import SplitIO from '../../../types/splitio';
 import { ControlType } from './constants';
+import { SDK_UPDATE } from '../../readiness/types';
 
 // Internal SDK events, subscribed by SyncManager and PushManager
 export type PUSH_SUBSYSTEM_UP = 'PUSH_SUBSYSTEM_UP'
@@ -37,7 +38,7 @@ type IParsedData<T extends IPushEvent> =
  */
 export interface IPushEventEmitter extends SplitIO.IEventEmitter {
   once<T extends IPushEvent>(event: T, listener: (parsedData: IParsedData<T>) => void): this;
-  on<T extends IPushEvent>(event: T, listener: (parsedData: IParsedData<T>) => void): this;
+  on<T extends IPushEvent>(event: T, listener: (metadata: T extends SDK_UPDATE ? SdkUpdateMetadata : never) => void): this;
   emit<T extends IPushEvent>(event: T, parsedData?: IParsedData<T>): boolean;
 }