[FSSDK-12115] Notification center type definition update (#1119)

Author: junaed-optimizely

lib/core/decision_service/index.ts

@@ -44,6 +44,7 @@ import * as stringValidator from '../../utils/string_value_validator';
 import {
   BucketerParams,
   DecisionResponse,
+  DecisionSource,
   Experiment,
   ExperimentBucketMap,
   FeatureFlag,
@@ -60,7 +61,7 @@ const MODULE_NAME = 'DECISION_SERVICE';
 export interface DecisionObj {
   experiment: Experiment | null;
   variation: Variation | null;
-  decisionSource: string;
+  decisionSource: DecisionSource;
 }
 
 interface DecisionServiceOptions {

lib/core/notification_center/index.ts

@@ -15,7 +15,7 @@
  */
 import { LogHandler, ErrorHandler } from '../../modules/logging';
 import { objectValues } from '../../utils/fns';
-import { NotificationListener, ListenerPayload } from '../../shared_types';
+import { ListenerPayload, NotificationListener, NotificationPayloadMap } from '../../shared_types';
 
 import {
   LOG_LEVEL,

lib/export_types.ts

@@ -37,6 +37,9 @@ export {
   UserProfileService,
   UserProfile,
   ListenerPayload,
+  DecisionListenerPayload,
+  LogEventListenerPayload,
+  NotificationPayloadMap,
   OptimizelyDecision,
   OptimizelyUserContext,
   NotificationListener,
@@ -47,4 +50,18 @@ export {
   NotificationCenter,
   OptimizelySegmentOption,
   ICache,
+  // Decision info types
+  DecisionNotificationType,
+  DecisionSource,
+  DecisionSourceInfo,
+  VariablesMap,
+  // Specific decision info types for type narrowing
+  AbTestDecisionInfo,
+  FeatureDecisionInfo,
+  FeatureTestDecisionInfo,
+  FeatureVariableDecisionInfo,
+  AllFeatureVariablesDecisionInfo,
+  FlagDecisionInfo,
+  DecisionInfoMap,
+  DecisionListenerPayloadForType,
 } from './shared_types';

lib/shared_types.ts

@@ -23,7 +23,7 @@ import { ErrorHandler, LogHandler, LogLevel, LoggerFacade } from './modules/logg
 import { EventProcessor } from './modules/event_processor';
 
 import { NotificationCenter as NotificationCenterImpl } from './core/notification_center';
-import { NOTIFICATION_TYPES } from './utils/enums';
+import { NOTIFICATION_TYPES, DECISION_NOTIFICATION_TYPES, DECISION_SOURCES } from './utils/enums';
 
 import { IOptimizelyUserContext as OptimizelyUserContext } from './optimizely_user_context';
 
@@ -120,9 +120,93 @@ export interface ListenerPayload {
   attributes?: UserAttributes;
 }
 
-export type NotificationListener<T extends ListenerPayload> = (notificationData: T) => void;
+export type DecisionNotificationType = typeof DECISION_NOTIFICATION_TYPES[keyof typeof DECISION_NOTIFICATION_TYPES];
+
+export type DecisionSource = typeof DECISION_SOURCES[keyof typeof DECISION_SOURCES];
+
+export type DecisionSourceInfo = {
+  experimentKey?: string;
+  variationKey?: string;
+};
+
+export type VariablesMap = { [variableKey: string]: unknown };
+
+export type AbTestDecisionInfo = {
+  experimentKey: string;
+  variationKey: string | null;
+};
 
-// NotificationCenter-related types
+export type FeatureDecisionInfo = {
+  featureKey: string;
+  featureEnabled: boolean;
+  source: DecisionSource;
+  sourceInfo: DecisionSourceInfo;
+};
+
+export type FeatureTestDecisionInfo = {
+  experimentKey: string;
+  variationKey: string | null;
+};
+
+export type FeatureVariableDecisionInfo = {
+  featureKey: string;
+  featureEnabled: boolean;
+  source: DecisionSource;
+  variableKey: string;
+  variableValue: FeatureVariableValue;
+  variableType: VariableType;
+  sourceInfo: DecisionSourceInfo;
+};
+
+export type AllFeatureVariablesDecisionInfo = {
+  featureKey: string;
+  featureEnabled: boolean;
+  source: DecisionSource;
+  variableValues: VariablesMap;
+  sourceInfo: DecisionSourceInfo;
+};
+
+export type FlagDecisionInfo = {
+  flagKey: string;
+  enabled: boolean;
+  variationKey: string | null;
+  ruleKey: string | null;
+  variables: VariablesMap;
+  reasons: string[];
+  decisionEventDispatched: boolean;
+  experimentId?: string;
+  variationId?: string;
+};
+
+export type DecisionInfoMap = {
+  [DECISION_NOTIFICATION_TYPES.AB_TEST]: AbTestDecisionInfo;
+  [DECISION_NOTIFICATION_TYPES.FEATURE]: FeatureDecisionInfo;
+  [DECISION_NOTIFICATION_TYPES.FEATURE_TEST]: FeatureTestDecisionInfo;
+  [DECISION_NOTIFICATION_TYPES.FEATURE_VARIABLE]: FeatureVariableDecisionInfo;
+  [DECISION_NOTIFICATION_TYPES.ALL_FEATURE_VARIABLES]: AllFeatureVariablesDecisionInfo;
+  [DECISION_NOTIFICATION_TYPES.FLAG]: FlagDecisionInfo;
+};
+
+export type DecisionListenerPayloadForType<T extends DecisionNotificationType> = ListenerPayload & {
+  type: T;
+  decisionInfo: DecisionInfoMap[T];
+};
+
+export type DecisionListenerPayload = {
+  [T in DecisionNotificationType]: DecisionListenerPayloadForType<T>;
+}[DecisionNotificationType];
+
+export type LogEventListenerPayload = Event;
+
+export type NotificationPayloadMap = {
+  [NOTIFICATION_TYPES.ACTIVATE]: ActivateListenerPayload;
+  [NOTIFICATION_TYPES.DECISION]: DecisionListenerPayload;
+  [NOTIFICATION_TYPES.TRACK]: TrackListenerPayload;
+  [NOTIFICATION_TYPES.LOG_EVENT]: LogEventListenerPayload;
+  [NOTIFICATION_TYPES.OPTIMIZELY_CONFIG_UPDATE]: undefined;
+};
+
+export type NotificationListener<T extends ListenerPayload> = (notificationData: T) => void;
 export interface NotificationCenter {
   addNotificationListener<T extends ListenerPayload>(
     notificationType: string,

lib/utils/enums/index.ts

@@ -230,7 +230,7 @@ export const DECISION_NOTIFICATION_TYPES = {
   FEATURE_VARIABLE: 'feature-variable',
   ALL_FEATURE_VARIABLES: 'all-feature-variables',
   FLAG: 'flag',
-};
+} as const;
 
 /*
  * Represents the source of a decision for feature management. When a feature
@@ -242,7 +242,7 @@ export const DECISION_SOURCES = {
   FEATURE_TEST: 'feature-test',
   ROLLOUT: 'rollout',
   EXPERIMENT: 'experiment',
-};
+} as const;
 
 export const AUDIENCE_EVALUATION_TYPES = {
   RULE: 'rule',