Incorporate comments

Author: yavorona

packages/optimizely-sdk/lib/core/project_config/project_config_manager.d.ts

@@ -29,9 +29,9 @@ interface ProjectConfigManagerConfig {
 * ProjectConfigManager provides project config objects via its methods
 * getConfig and onUpdate. It uses a DatafileManager to fetch datafiles. It is
 * responsible for parsing and validating datafiles, and converting datafile
-* JSON objects into project config objects.
+* string into project config objects.
 * @param     {ProjectConfig}        config
-* @param     {Object|string}        config.datafile
+* @param     {string}               config.datafile
 * @param     {Object}               config.datafileOptions
 * @param     {Object}               config.jsonSchemaValidator
 * @param     {string}               config.sdkKey

packages/optimizely-sdk/lib/core/project_config/project_config_manager.js

@@ -44,9 +44,9 @@ function getErrorMessage(maybeError, defaultMessage) {
  * ProjectConfigManager provides project config objects via its methods
  * getConfig and onUpdate. It uses a DatafileManager to fetch datafiles. It is
  * responsible for parsing and validating datafiles, and converting datafile
- * JSON objects into project config objects.
+ * string into project config objects.
  * @param {Object}         config
- * @param {Object|string=} config.datafile
+ * @param {string}         config.datafile
  * @param {Object=}        config.datafileOptions
  * @param {Object=}        config.jsonSchemaValidator
  * @param {string=}        config.sdkKey

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

@@ -158,7 +158,7 @@ declare module '@optimizely/optimizely-sdk' {
      *        After the event has at least been queued for dispatch, call this function to return
      *        control back to the Client.
      */
-    dispatchEvent: (event: Event, callback: () => void) => void;
+    dispatchEvent: (event: Event, callback: (response: { statusCode: number; }) => void) => void;
   }
 
   export type EventTags = {

packages/optimizely-sdk/lib/optimizely/index.ts

@@ -15,15 +15,15 @@
  ***************************************************************************/
 import { sprintf, objectValues } from '@optimizely/js-sdk-utils';
 import { LogHandler, ErrorHandler } from '@optimizely/js-sdk-logging';
-// import {EventDispatcher} from '@optimizely/js-sdk-event-processor';
 import { FeatureFlag, FeatureVariable } from '../core/project_config/entities';
 import {
   UserAttributes,
   EventTags,
   OptimizelyConfig,
   UserProfileService,
   DatafileOptions,
-  EventDispatcher
+  EventDispatcher,
+  OnReadyResult
 } from '../shared_types';
 import { Variation } from '../core/project_config/entities';
 import { createProjectConfigManager, ProjectConfigManager } from '../core/project_config/project_config_manager';
@@ -540,8 +540,7 @@ export default class Optimizely {
    */
   private validateInputs(
     // TODO: Make feature_key, user_id, variable_key, experiment_key camelCase
-    // stringInputs: Record<'feature_key' | 'user_id' | 'variable_key' | 'experiment_key', unknown>,
-    stringInputs: unknown,
+    stringInputs: Partial<Record<'feature_key' | 'user_id' | 'variable_key' | 'experiment_key' | 'event_key', unknown>>,
     userAttributes?: unknown,
     eventTags?: unknown
   ): boolean {
@@ -1341,9 +1340,9 @@ export default class Optimizely {
       timeoutValue = DEFAULT_ONREADY_TIMEOUT;
     }
 
-    let resolveTimeoutPromise: (value?: { success: boolean; reason?: string | undefined; }) => void;
-    const timeoutPromise = new Promise(
-      function(resolve: (value?: { success: boolean; reason?: string | undefined; }) => void) {
+    let resolveTimeoutPromise: (value: OnReadyResult) => void;
+    const timeoutPromise = new Promise<OnReadyResult>(
+      (resolve) => {
       resolveTimeoutPromise = resolve;
       }
     );
@@ -1357,7 +1356,7 @@ export default class Optimizely {
         success: false,
         reason: sprintf('onReady timeout expired after %s ms', timeoutValue),
       });
-    }).bind(this);
+    });
     const readyTimeout = setTimeout(onReadyTimeout, timeoutValue);
     const onClose = function() {
       resolveTimeoutPromise({

packages/optimizely-sdk/lib/shared_types.ts

@@ -49,7 +49,12 @@ export interface EventDispatcher {
    *        After the event has at least been queued for dispatch, call this function to return
    *        control back to the Client.
    */
-  dispatchEvent: (event: Event, callback: () => void) => void;
+  dispatchEvent: (event: Event, callback: (response: { statusCode: number; }) => void) => void;
+}
+
+export interface OnReadyResult {
+  success: boolean;
+  reason?: string;
 }
 
 /**