[FSSDK-10989] refactor notification center types

Author: raju-opti

lib/export_types.ts

@@ -39,7 +39,6 @@ export {
   ListenerPayload,
   OptimizelyDecision,
   OptimizelyUserContext,
-  NotificationListener,
   Config,
   Client,
   ActivateListenerPayload,

lib/notification_center/index.tests.js

@@ -1,5 +1,5 @@
 /**
- * Copyright 2020, 2022, Optimizely
+ * Copyright 2020, 2022, 2024, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,14 +15,16 @@
  */
 import { LogHandler, ErrorHandler } from '../modules/logging';
 import { objectValues } from '../utils/fns';
-import { NotificationListener, ListenerPayload } from '../shared_types';
 
 import {
   LOG_LEVEL,
   LOG_MESSAGES,
-  NOTIFICATION_TYPES,
 } from '../utils/enums';
 
+import { NOTIFICATION_TYPES } from './type';
+import { NotificationType, NotificationPayload } from './type';
+import { Consumer } from '../utils/type';
+
 const MODULE_NAME = 'NOTIFICATION_CENTER';
 
 interface NotificationCenterOptions {
@@ -40,13 +42,30 @@ type NotificationListeners = {
   [key: string]: ListenerEntry[];
 }
 
+export interface NotificationCenter {
+  addNotificationListener<N extends NotificationType>(
+    notificationType: N,
+    callback: Consumer<NotificationPayload[N]>
+  ): number
+  removeNotificationListener(listenerId: number): boolean;
+  clearAllNotificationListeners(): void;
+  clearNotificationListeners(notificationType: NotificationType): void;
+}
+
+export interface NotificationSender {
+  sendNotifications<N extends NotificationType>(
+    notificationType: N,
+    notificationData: NotificationPayload[N]
+  ): void;
+}
+
 /**
  * NotificationCenter allows registration and triggering of callback functions using
  * notification event types defined in NOTIFICATION_TYPES of utils/enums/index.js:
  * - ACTIVATE: An impression event will be sent to Optimizely.
  * - TRACK a conversion event will be sent to Optimizely
  */
-export class NotificationCenter {
+export class DefaultNotificationCenter implements NotificationCenter, NotificationSender {
   private logger: LogHandler;
   private errorHandler: ErrorHandler;
   private notificationListeners: NotificationListeners;
@@ -80,9 +99,9 @@ export class NotificationCenter {
    * can happen if the first argument is not a valid notification type, or if the same callback
    * function was already added as a listener by a prior call to this function.
    */
-  addNotificationListener<T extends ListenerPayload>(
-    notificationType: string,
-    callback: NotificationListener<T>
+  addNotificationListener<N extends NotificationType>(
+    notificationType: N,
+    callback: Consumer<NotificationPayload[N]>
   ): number {
     try {
       const notificationTypeValues: string[] = objectValues(NOTIFICATION_TYPES);
@@ -187,7 +206,7 @@ export class NotificationCenter {
    * Remove all previously added notification listeners for the argument type
    * @param   {NOTIFICATION_TYPES}    notificationType One of NOTIFICATION_TYPES
    */
-  clearNotificationListeners(notificationType: NOTIFICATION_TYPES): void {
+  clearNotificationListeners(notificationType: NotificationType): void {
     try {
       this.notificationListeners[notificationType] = [];
     } catch (e: any) {
@@ -202,9 +221,9 @@ export class NotificationCenter {
    * @param {string} notificationType One of NOTIFICATION_TYPES
    * @param {Object} notificationData Will be passed to callbacks called
    */
-  sendNotifications<T extends ListenerPayload>(
-    notificationType: string,
-    notificationData?: T
+  sendNotifications<N extends NotificationType>(
+    notificationType: N,
+    notificationData: NotificationPayload[N]
   ): void {
     try {
       (this.notificationListeners[notificationType] || []).forEach(
@@ -235,12 +254,6 @@ export class NotificationCenter {
  * @param   {NotificationCenterOptions}   options
  * @returns {NotificationCenter}          An instance of NotificationCenter
  */
-export function createNotificationCenter(options: NotificationCenterOptions): NotificationCenter {
-  return new NotificationCenter(options);
-}
-
-export interface NotificationSender {
-  // TODO[OASIS-6649]: Don't use any type
-  // eslint-disable-next-line  @typescript-eslint/no-explicit-any
-  sendNotifications(notificationType: NOTIFICATION_TYPES, notificationData?: any): void
+export function createNotificationCenter(options: NotificationCenterOptions): DefaultNotificationCenter {
+  return new DefaultNotificationCenter(options);
 }

lib/notification_center/index.ts

@@ -0,0 +1,64 @@
+import { LogEvent } from '../event_processor/event_dispatcher/event_dispatcher';
+import { EventTags, Experiment, UserAttributes, Variation } from '../shared_types';
+
+export type UserEventListenerPayload = {
+  userId: string;
+  attributes?: UserAttributes;
+}
+
+export type ActivateListenerPayload = UserEventListenerPayload & {
+  experiment: Experiment | null;
+  variation: Variation | null;
+  logEvent: LogEvent;
+}
+
+export type TrackListenerPayload = UserEventListenerPayload & {
+  eventKey: string;
+  eventTags?: EventTags;
+  logEvent: LogEvent;
+}
+
+export const DECISION_NOTIFICATION_TYPES = {
+  AB_TEST: 'ab-test',
+  FEATURE: 'feature',
+  FEATURE_TEST: 'feature-test',
+  FEATURE_VARIABLE: 'feature-variable',
+  ALL_FEATURE_VARIABLES: 'all-feature-variables',
+  FLAG: 'flag',
+} as const;
+
+export type DecisionNotificationType = typeof DECISION_NOTIFICATION_TYPES[keyof typeof DECISION_NOTIFICATION_TYPES];
+
+// TODO: Add more specific types for decision info
+export type OptimizelyDecisionInfo = Record<string, any>;
+
+export type DecisionListenerPayload = UserEventListenerPayload & {
+  type: DecisionNotificationType;
+  decisionInfo: OptimizelyDecisionInfo;
+}
+
+export type LogEventListenerPayload = LogEvent;
+
+export type OptimizelyConfigUpdateListenerPayload = undefined;
+
+export type NotificationPayload = {
+  ACTIVATE: ActivateListenerPayload;
+  DECISION: DecisionListenerPayload;
+  TRACK: TrackListenerPayload;
+  LOG_EVENT: LogEventListenerPayload;
+  OPTIMIZELY_CONFIG_UPDATE: OptimizelyConfigUpdateListenerPayload;
+};
+
+export type NotificationType = keyof NotificationPayload;
+
+export type NotiticationTypeValues = {
+  [key in NotificationType]: key;
+}
+
+export const NOTIFICATION_TYPES: NotiticationTypeValues = {
+  ACTIVATE: 'ACTIVATE',
+  DECISION: 'DECISION',
+  LOG_EVENT: 'LOG_EVENT',
+  OPTIMIZELY_CONFIG_UPDATE: 'OPTIMIZELY_CONFIG_UPDATE',
+  TRACK: 'TRACK',
+};