feat: Converted index.browser.js to TS

packages/optimizely-sdk/lib/core/decision_service/index.d.ts

@@ -13,95 +13,94 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { LogHandler } from '@optimizely/js-sdk-logging';
+import { ProjectConfig } from '../project_config';
+import { UserAttributes, UserProfileService, Experiment, Variation } from '../../shared_types';
+import { FeatureFlag } from '../project_config/entities';
 
-declare module '@optimizely/optimizely-sdk/lib/core/decision_service' {
-  import { LogHandler } from '@optimizely/js-sdk-logging';
-  import { ProjectConfig } from '@optimizely/optimizely-sdk/lib/core/project_config';
+/**
+ * Creates an instance of the DecisionService.
+ * @param  {Options}          options        Configuration options
+ * @return {DecisionService}  An instance of the DecisionService
+ */
+export function createDecisionService(options: Options): DecisionService;
+
+export interface DecisionService {
 
   /**
-   * Creates an instance of the DecisionService.
-   * @param  {Options}          options        Configuration options
-   * @return {DecisionService}  An instance of the DecisionService
+   * Gets variation where visitor will be bucketed.
+   * @param   {ProjectConfig}  configObj      The parsed project configuration object
+   * @param   {string}         experimentKey
+   * @param   {string}         userId
+   * @param   {UserAttributes} attributes
+   * @return  {string|null}    The variation the user is bucketed into.
    */
-  export function createDecisionService(options: Options): DecisionService;
-
-  interface DecisionService {
+  getVariation(
+    configObj: ProjectConfig,
+    experimentKey: string,
+    userId: string,
+    attributes?: UserAttributes
+  ): string | null;
 
-    /**
-     * Gets variation where visitor will be bucketed.
-     * @param   {ProjectConfig}  configObj      The parsed project configuration object
-     * @param   {string}         experimentKey
-     * @param   {string}         userId
-     * @param   {UserAttributes} attributes
-     * @return  {string|null}    The variation the user is bucketed into.
-     */
-    getVariation(
-      configObj: ProjectConfig,
-      experimentKey: string,
-      userId: string,
-      attributes?: import('../../shared_types').UserAttributes
-    ): string | null;
-
-    /**
-     * Given a feature, user ID, and attributes, returns an object representing a
-     * decision. If the user was bucketed into a variation for the given feature
-     * and attributes, the returned decision object will have variation and
-     * experiment properties (both objects), as well as a decisionSource property.
-     * decisionSource indicates whether the decision was due to a rollout or an
-     * experiment.
-     * @param   {ProjectConfig} configObj      The parsed project configuration object
-     * @param   {FeatureFlag}   feature        A feature flag object from project configuration
-     * @param   {string}        userId         A string identifying the user, for bucketing
-     * @param   {unknown}       attributes     Optional user attributes
-     * @return  {Decision}      An object with experiment, variation, and decisionSource
-     * properties. If the user was not bucketed into a variation, the variation
-     * property is null.
-     */
-    getVariationForFeature(
-      configObj: ProjectConfig,
-      feature: import('../project_config/entities').FeatureFlag,
-      userId: string,
-      attributes: unknown
-    ): Decision;
+  /**
+   * Given a feature, user ID, and attributes, returns an object representing a
+   * decision. If the user was bucketed into a variation for the given feature
+   * and attributes, the returned decision object will have variation and
+   * experiment properties (both objects), as well as a decisionSource property.
+   * decisionSource indicates whether the decision was due to a rollout or an
+   * experiment.
+   * @param   {ProjectConfig} configObj      The parsed project configuration object
+   * @param   {FeatureFlag}   feature        A feature flag object from project configuration
+   * @param   {string}        userId         A string identifying the user, for bucketing
+   * @param   {unknown}       attributes     Optional user attributes
+   * @return  {Decision}      An object with experiment, variation, and decisionSource
+   * properties. If the user was not bucketed into a variation, the variation
+   * property is null.
+   */
+  getVariationForFeature(
+    configObj: ProjectConfig,
+    feature: FeatureFlag,
+    userId: string,
+    attributes: unknown
+  ): Decision;
 
-    /**
-     * Removes forced variation for given userId and experimentKey
-     * @param  {unknown}        userId         String representing the user id
-     * @param  {string}         experimentId   Number representing the experiment id
-     * @param  {string}         experimentKey  Key representing the experiment id
-     * @throws If the user id is not valid or not in the forced variation map
-     */
-    removeForcedVariation(userId: unknown, experimentId: string, experimentKey: string): void;
+  /**
+   * Removes forced variation for given userId and experimentKey
+   * @param  {unknown}        userId         String representing the user id
+   * @param  {string}         experimentId   Number representing the experiment id
+   * @param  {string}         experimentKey  Key representing the experiment id
+   * @throws If the user id is not valid or not in the forced variation map
+   */
+  removeForcedVariation(userId: unknown, experimentId: string, experimentKey: string): void;
 
-    /**
-     * Gets the forced variation key for the given user and experiment.
-     * @param  {ProjectConfig}  configObj      Object representing project configuration
-     * @param  {string}         experimentKey  Key for experiment.
-     * @param  {string}         userId         The user Id.
-     * @return {string|null}    Variation key that specifies the variation which the given user and experiment should be forced into.
-     */
-    getForcedVariation(configObj: ProjectConfig, experimentKey: string, userId: string): string | null;
+  /**
+   * Gets the forced variation key for the given user and experiment.
+   * @param  {ProjectConfig}  configObj      Object representing project configuration
+   * @param  {string}         experimentKey  Key for experiment.
+   * @param  {string}         userId         The user Id.
+   * @return {string|null}    Variation key that specifies the variation which the given user and experiment should be forced into.
+   */
+  getForcedVariation(configObj: ProjectConfig, experimentKey: string, userId: string): string | null;
 
-    /**
-     * Sets the forced variation for a user in a given experiment
-     * @param  {ProjectConfig}  configObj      Object representing project configuration
-     * @param  {string}         experimentKey  Key for experiment.
-     * @param  {string}         userId         The user Id.
-     * @param  {unknown}        variationKey   Key for variation. If null, then clear the existing experiment-to-variation mapping
-     * @return {boolean}        A boolean value that indicates if the set completed successfully.
-     */
-    setForcedVariation(configObj: ProjectConfig, experimentKey: string, userId: string, variationKey: unknown): boolean;
-  }
+  /**
+   * Sets the forced variation for a user in a given experiment
+   * @param  {ProjectConfig}  configObj      Object representing project configuration
+   * @param  {string}         experimentKey  Key for experiment.
+   * @param  {string}         userId         The user Id.
+   * @param  {unknown}        variationKey   Key for variation. If null, then clear the existing experiment-to-variation mapping
+   * @return {boolean}        A boolean value that indicates if the set completed successfully.
+   */
+  setForcedVariation(configObj: ProjectConfig, experimentKey: string, userId: string, variationKey: unknown): boolean;
+}
 
-  interface Options {
-    userProfileService: import('../../shared_types').UserProfileService | null;
-    logger: LogHandler;
-    UNSTABLE_conditionEvaluators: unknown;
-  }
+interface Options {
+  userProfileService: UserProfileService | null;
+  logger: LogHandler;
+  UNSTABLE_conditionEvaluators: unknown;
+}
 
-  interface Decision {
-    experiment: import('../../shared_types').Experiment | null;
-    variation: import('../../shared_types').Variation | null;
-    decisionSource: string;
-  }
+interface Decision {
+  experiment: Experiment | null;
+  variation: Variation | null;
+  decisionSource: string;
 }

packages/optimizely-sdk/lib/core/event_builder/event_helpers.d.ts

@@ -0,0 +1,58 @@
+/**
+ * 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 { ProjectConfig } from '../project_config';
+import { EventTags, UserAttributes } from '../../shared_types';
+
+interface ImpressionConfig {
+  experimentKey: string;
+  variationKey: string;
+  userId: string;
+  userAttributes?: UserAttributes;
+  clientEngine: string;
+  clientVersion: string;
+  configObj: ProjectConfig;
+}
+
+// eslint-disable-next-line  @typescript-eslint/no-empty-interface
+interface ImpressionEvent {}
+
+interface ConversionConfig {
+  eventKey: string;
+  eventTags?: EventTags;
+  userId: string;
+  userAttributes?: UserAttributes;
+  clientEngine: string;
+  clientVersion: string;
+  configObj: ProjectConfig;
+}
+
+// eslint-disable-next-line  @typescript-eslint/no-empty-interface
+interface ConversionEvent {}
+
+/**
+ * Creates an ImpressionEvent object from decision data
+ * @param {ImpressionConfig} config
+ * @return {ImpressionEvent} an ImpressionEvent object
+ */
+export function buildImpressionEvent(config: ImpressionConfig): ImpressionEvent;
+
+/**
+ * Creates a ConversionEvent object from track
+ * @param {ConversionConfig} config
+ * @return {ConversionEvent} a ConversionEvent object
+ */
+export function buildConversionEvent(config: ConversionConfig): ConversionEvent;

packages/optimizely-sdk/lib/core/event_builder/index.d.ts

@@ -0,0 +1,56 @@
+/**
+ * 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 { ProjectConfig } from '../project_config';
+import { LogHandler } from '@optimizely/js-sdk-logging';
+import { EventTags, UserAttributes } from '../../shared_types';
+import { Event as EventLoggingEndpoint } from '../../shared_types';
+
+interface ImpressionOptions {
+  attributes?: UserAttributes;
+  clientEngine: string;
+  clientVersion: string;
+  configObj: ProjectConfig;
+  experimentId: string;
+  eventKey?: string;
+  variationId: string;
+  logger?: LogHandler;
+  userId: string;
+}
+
+interface ConversionEventOptions {
+  attributes?: UserAttributes;
+  clientEngine: string;
+  clientVersion: string;
+  configObj: ProjectConfig;
+  eventKey: string;
+  logger: LogHandler;
+  userId: string;
+  eventTags?: EventTags;
+}
+
+/**
+ * Create impression event params to be sent to the logging endpoint
+ * @param  {ImpressionOptions} options Object containing values needed to build impression event
+ * @return {EventLoggingEndpoint} Params to be used in impression event logging endpoint call
+ */
+export function getImpressionEvent(options: ImpressionOptions): EventLoggingEndpoint;
+
+/**
+ * Create conversion event params to be sent to the logging endpoint
+ * @param  {ConversionEventOptions} options  Object containing values needed to build conversion event
+ * @return {EventLoggingEndpoint} Params to be used in conversion event logging endpoint call
+ */
+export function getConversionEvent(options: ConversionEventOptions): EventLoggingEndpoint;

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

@@ -0,0 +1,97 @@
+/* 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 {
+  Event,
+  EventTags,
+  UserAttributes,
+  Experiment,
+  Variation
+} from '../../shared_types';
+
+export enum NOTIFICATION_TYPES {
+  ACTIVATE = 'ACTIVATE:experiment, user_id,attributes, variation, event',
+  DECISION = 'DECISION:type, userId, attributes, decisionInfo',
+  LOG_EVENT = 'LOG_EVENT:logEvent',
+  OPTIMIZELY_CONFIG_UPDATE = 'OPTIMIZELY_CONFIG_UPDATE',
+  TRACK = 'TRACK:event_key, user_id, attributes, event_tags, event',
+}
+
+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?: DECISION_NOTIFICATION_TYPES;
+  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;