@optimizely/optimizely-sdk/lib/core/notification_center/index.d.ts

JavaScript SDK for Optimizely X Full Stack

/* eslint-disable no-shadow */
/**
 * Copyright 2020, Optimizely
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import { LogHandler, ErrorHandler } from '@optimizely/js-sdk-logging';
import { EventTags, UserAttributes, Event } from '../../shared_types';
import { Experiment, Variation } from '../project_config/entities';

export type NOTIFICATION_TYPES = import('@optimizely/js-sdk-utils').NOTIFICATION_TYPES;

export enum DECISION_NOTIFICATION_TYPES {
  AB_TEST = 'ab-test',
  FEATURE = 'feature',
  FEATURE_TEST = 'feature-test',
  FEATURE_VARIABLE = 'feature-variable',
  ALL_FEATURE_VARIABLES = 'all-feature-variables',
}

export type Options = {
  logger: LogHandler;
  errorHandler: ErrorHandler;
};

export type SourceInfo = {
  experimentKey?: string;
  variationKey?: string;
};

export type VariableValues = {
  [name: string]: unknown;
};

export type DecisionInfo = {
  experimentKey?: string;
  variationKey?: string | null;
  featureKey?: string;
  featureEnabled?: boolean;
  source?: string;
  sourceInfo?: SourceInfo;
  variableKey?: string;
  variableValue?: unknown;
  variableValues?: VariableValues;
  variableType?: string;
};

export interface NotificationData {
  type?: string;
  userId?: string;
  attributes?: UserAttributes;
  decisionInfo?: DecisionInfo;
  experiment?: Experiment;
  variation?: Variation;
  logEvent?: Event;
  eventKey?: string;
  eventTags?: EventTags;
}

export interface NotificationCenter {
  /**
   * Fires notifications for the argument type. All registered callbacks for this type will be
   * called. The notificationData object will be passed on to callbacks called.
   * @param {NOTIFICATION_TYPES} notificationType One of NOTIFICATION_TYPES
   * @param {NotificationData} notificationData Will be passed to callbacks called
   */
  sendNotifications(notificationType: NOTIFICATION_TYPES, notificationData?: NotificationData): void;
}

/**
 * Create an instance of NotificationCenter
 * @param {Options} options
 * @returns {NotificationCenter} An instance of NotificationCenter
 */
export function createNotificationCenter(options: Options): NotificationCenter;