feat: Convert fns module to TS

packages/optimizely-sdk/.eslintrc.js

@@ -4,7 +4,10 @@ module.exports = {
     commonjs: true,
     node: true,
   },
-  extends: 'eslint:recommended',
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+  ],
   globals: {
     Atomics: 'readonly',
     SharedArrayBuffer: 'readonly',
@@ -14,7 +17,18 @@ module.exports = {
     ecmaVersion: 6,
     sourceType: 'module',
   },
+  overrides: [
+    {
+      'files': ['*.ts'],
+      'rules': {
+        '@typescript-eslint/explicit-module-boundary-types': ['error']
+      }
+    }
+  ],
   rules: {
     'no-prototype-builtins': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-empty-function': 'off',
+    'no-shadow': 'error',
   },
 };

packages/optimizely-sdk/karma.base.conf.js

@@ -24,6 +24,18 @@ module.exports = {
 
   webpack: {
     mode: 'production',
+    module: {
+      rules: [
+        {
+          test: /\.[tj]s$/,
+          use: 'ts-loader',
+          exclude: /node_modules/,
+        },
+      ],
+    },
+    resolve: {
+      extensions: ['.ts', '.js'],
+    },
   },
 
   //browserStack setup

packages/optimizely-sdk/lib/core/audience_evaluator/index.js

@@ -16,7 +16,7 @@
 import { sprintf } from '@optimizely/js-sdk-utils';
 import { getLogger } from '@optimizely/js-sdk-logging';
 
-import fns from '../../utils/fns';
+import * as fns from '../../utils/fns';
 import {
   LOG_LEVEL,
   LOG_MESSAGES,

packages/optimizely-sdk/lib/core/custom_attribute_condition_evaluator/index.js

@@ -15,7 +15,7 @@
  ***************************************************************************/
 import { sprintf } from '@optimizely/js-sdk-utils';
 
-import fns from '../../utils/fns';
+import * as fns from '../../utils/fns';
 import {
   LOG_LEVEL,
   LOG_MESSAGES,

packages/optimizely-sdk/lib/core/decision_service/index.js

@@ -17,10 +17,10 @@ import { sprintf } from'@optimizely/js-sdk-utils';
 
 import bucketer from '../bucketer';
 import enums from '../../utils/enums';
-import fns from '../../utils/fns';
+import * as fns from '../../utils/fns';
 import projectConfig from '../project_config';
 import AudienceEvaluator from '../audience_evaluator';
-import stringValidator from '../../utils/string_value_validator';
+import * as stringValidator from '../../utils/string_value_validator';
 
 var MODULE_NAME = 'DECISION_SERVICE';
 var ERROR_MESSAGES = enums.ERROR_MESSAGES;

packages/optimizely-sdk/lib/core/decision_service/index.tests.js

@@ -32,7 +32,7 @@ import AudienceEvaluator from '../audience_evaluator';
 import errorHandler from '../../plugins/error_handler';
 import eventBuilder from '../../core/event_builder/index.js';
 import eventDispatcher from '../../plugins/event_dispatcher/index.node';
-import jsonSchemaValidator from '../../utils/json_schema_validator';
+import * as jsonSchemaValidator from '../../utils/json_schema_validator';
 import {
   getTestProjectConfig,
   getTestProjectConfigWithFeatures,

packages/optimizely-sdk/lib/core/event_builder/event_helpers.js

@@ -15,10 +15,10 @@
  */
 import { getLogger } from '@optimizely/js-sdk-logging';
 
-import fns from '../../utils/fns';
+import * as fns from '../../utils/fns';
 import projectConfig from '../project_config';
-import eventTagUtils from '../../utils/event_tag_utils';
-import attributesValidator from'../../utils/attributes_validator';
+import * as eventTagUtils from '../../utils/event_tag_utils';
+import * as attributesValidator from'../../utils/attributes_validator';
 
 var logger = getLogger('EVENT_BUILDER');
 
@@ -106,6 +106,14 @@ export var buildConversionEvent = function(config) {
   var eventTags = config.eventTags;
   var eventId = projectConfig.getEventId(configObj, eventKey);
 
+  let revenue = null;
+  let eventValue = null;
+
+  if (eventTags) {
+    revenue = eventTagUtils.getRevenueValue(eventTags, logger);
+    eventValue = eventTagUtils.getEventValue(eventTags, logger);
+  }
+
   return {
     type: 'conversion',
     timestamp: fns.currentTimestamp(),
@@ -131,8 +139,8 @@ export var buildConversionEvent = function(config) {
       key: eventKey,
     },
 
-    revenue: eventTagUtils.getRevenueValue(eventTags, logger),
-    value: eventTagUtils.getEventValue(eventTags, logger),
+    revenue: revenue,
+    value: eventValue,
     tags: eventTags,
   };
 };

packages/optimizely-sdk/lib/core/event_builder/event_helpers.tests.js

@@ -16,7 +16,7 @@
 import sinon from 'sinon';
 import { assert } from 'chai';
 
-import fns from '../../utils/fns';
+import * as fns from '../../utils/fns';
 import projectConfig from '../project_config';
 import { buildImpressionEvent, buildConversionEvent } from './event_helpers';
 

packages/optimizely-sdk/lib/core/event_builder/index.js

@@ -13,11 +13,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import fns from '../../utils/fns';
+import * as fns from '../../utils/fns';
 import enums from '../../utils/enums';
 import projectConfig from '../project_config';
-import eventTagUtils from '../../utils/event_tag_utils';
-import attributeValidator from '../../utils/attributes_validator';
+import * as eventTagUtils from '../../utils/event_tag_utils';
+import * as attributeValidator from '../../utils/attributes_validator';
 
 var ACTIVATE_EVENT_KEY = 'campaign_activated';
 var CUSTOM_ATTRIBUTE_FEATURE_TYPE = 'custom';

packages/optimizely-sdk/lib/core/event_builder/index.tests.js

@@ -16,7 +16,7 @@
 import sinon from 'sinon';
 import { assert } from 'chai';
 
-import fns from '../../utils/fns';
+import * as fns from '../../utils/fns';
 import testData from '../../tests/test_data';
 import projectConfig from '../project_config';
 import packageJSON from '../../../package.json';

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

@@ -15,7 +15,7 @@
  */
 import { sprintf, objectValues } from '@optimizely/js-sdk-utils';
 
-import fns from '../../utils/fns';
+import * as fns from '../../utils/fns';
 import {
   ERROR_MESSAGES,
   LOG_MESSAGES,

packages/optimizely-sdk/lib/core/project_config/index.tests.js

@@ -19,7 +19,7 @@ import { forEach, cloneDeep } from 'lodash';
 import { getLogger } from '@optimizely/js-sdk-logging';
 import { sprintf } from '@optimizely/js-sdk-utils';
 
-import fns from '../../utils/fns';
+import * as fns from '../../utils/fns';
 import projectConfig from './';
 import {
   ERROR_MESSAGES,

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

@@ -17,7 +17,7 @@ import { sprintf } from '@optimizely/js-sdk-utils';
 import { getLogger } from '@optimizely/js-sdk-logging';
 import { HttpPollingDatafileManager } from '@optimizely/js-sdk-datafile-manager';
 
-import fns from '../../utils/fns';
+import * as fns from '../../utils/fns';
 import { ERROR_MESSAGES } from '../../utils/enums';
 import projectConfig from '../../core/project_config';
 import { getOptimizelyConfig } from '../optimizely_config';

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

@@ -25,7 +25,7 @@ import { ERROR_MESSAGES, LOG_MESSAGES } from '../../utils/enums';
 import testData from '../../tests/test_data';
 import * as optimizelyConfig from '../optimizely_config/index';
 import projectConfigManager from './project_config_manager';
-import jsonSchemaValidator from '../../utils/json_schema_validator';
+import * as jsonSchemaValidator from '../../utils/json_schema_validator';
 
 describe('lib/core/project_config/project_config_manager', function() {
   var globalStubErrorHandler;

packages/optimizely-sdk/lib/core/project_config/project_config_schema.js → packages/optimizely-sdk/lib/core/project_config/project_config_schema.ts

@@ -17,7 +17,9 @@
 /**
  * Project Config JSON Schema file used to validate the project json datafile
  */
-export var schema = {
+ import { JSONSchema4 } from 'json-schema';
+
+ var schemaDefinition = {
   $schema: 'http://json-schema.org/draft-04/schema#',
   type: 'object',
   properties: {
@@ -276,4 +278,6 @@ export var schema = {
   },
 };
 
-export default schema;
+const schema = schemaDefinition as JSONSchema4
+
+export default schema

packages/optimizely-sdk/lib/index.browser.js

@@ -23,7 +23,7 @@ import {
 } from '@optimizely/js-sdk-logging';
 import { LocalStoragePendingEventsDispatcher } from '@optimizely/js-sdk-event-processor';
 
-import fns from './utils/fns';
+import * as fns from './utils/fns';
 import configValidator from './utils/config_validator';
 import defaultErrorHandler from './plugins/error_handler';
 import defaultEventDispatcher from './plugins/event_dispatcher/index.browser';

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

@@ -39,6 +39,8 @@ declare module '@optimizely/optimizely-sdk' {
 
   // The options object given to Optimizely.createInstance.
   export interface Config {
+    // TODO[OASIS-6649]: Don't use object type
+    // eslint-disable-next-line  @typescript-eslint/ban-types
     datafile?: object | string;
     datafileOptions?: DatafileOptions;
     errorHandler?: ErrorHandler;
@@ -50,6 +52,8 @@ declare module '@optimizely/optimizely-sdk' {
       | enums.LOG_LEVEL.INFO
       | enums.LOG_LEVEL.NOTSET
       | enums.LOG_LEVEL.WARNING;
+    // TODO[OASIS-6649]: Don't use object type
+    // eslint-disable-next-line  @typescript-eslint/ban-types
     jsonSchemaValidator?: object;
     userProfileService?: UserProfileService | null;
     eventBatchSize?: number;
@@ -115,6 +119,8 @@ declare module '@optimizely/optimizely-sdk' {
     // HTTP method with which to send the event.
     httpVerb: 'POST';
     // Value to send in the request body, JSON-serialized.
+    // TODO[OASIS-6649]: Don't use any type
+    // eslint-disable-next-line  @typescript-eslint/no-explicit-any
     params: any;
   }
 
@@ -159,6 +165,8 @@ declare module '@optimizely/optimizely-sdk' {
   }
 
   export type UserAttributes = {
+    // TODO[OASIS-6649]: Don't use any type
+    // eslint-disable-next-line  @typescript-eslint/no-explicit-any
     [name: string]: any;
   };
 
@@ -183,6 +191,8 @@ declare module '@optimizely/optimizely-sdk' {
       endOfRange: number;
     }>;
     audienceIds: string[];
+    // TODO[OASIS-6649]: Don't use object type
+    // eslint-disable-next-line  @typescript-eslint/ban-types
     forcedVariations: object;
   }
 

packages/optimizely-sdk/lib/index.node.js

@@ -22,7 +22,7 @@ import {
   LogLevel,
 } from '@optimizely/js-sdk-logging';
 
-import fns from './utils/fns';
+import * as fns from './utils/fns';
 import Optimizely from './optimizely';
 import enums from './utils/enums';
 import loggerPlugin from './plugins/logger';

packages/optimizely-sdk/lib/index.react_native.js

@@ -22,7 +22,7 @@ import {
   LogLevel,
 } from '@optimizely/js-sdk-logging';
 
-import fns from './utils/fns';
+import * as fns from './utils/fns';
 import enums from './utils/enums';
 import Optimizely from './optimizely';
 import configValidator from './utils/config_validator';

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

@@ -16,17 +16,17 @@
 import { sprintf, objectValues } from '@optimizely/js-sdk-utils';
 import * as eventProcessor from '@optimizely/js-sdk-event-processor';
 
-import fns from '../utils/fns'
+import * as fns from '../utils/fns'
 import { validate } from '../utils/attributes_validator';
 import decisionService from '../core/decision_service';
 import enums from '../utils/enums';
 import { getImpressionEvent, getConversionEvent } from '../core/event_builder/index.js';
 import { buildConversionEvent, buildImpressionEvent } from '../core/event_builder/event_helpers';
-import eventTagsValidator from '../utils/event_tags_validator';
+import * as eventTagsValidator from '../utils/event_tags_validator';
 import notificationCenter from '../core/notification_center';
 import projectConfig from '../core/project_config';
-import userProfileServiceValidator from '../utils/user_profile_service_validator';
-import stringValidator from '../utils/string_value_validator';
+import * as userProfileServiceValidator from '../utils/user_profile_service_validator';
+import * as stringValidator from '../utils/string_value_validator';
 import projectConfigManager from '../core/project_config/project_config_manager';
 
 var ERROR_MESSAGES = enums.ERROR_MESSAGES;
@@ -754,8 +754,8 @@ Optimizely.prototype._getFeatureVariableForType = function(featureKey, variableK
     );
     return null;
   }
-
-  var decision = this.decisionService.getVariationForFeature(configObj, featureFlag, userId, attributes);
+  
+  var decision = this.decisionService.getVariationForFeature(configObj, featureFlag, userId, attributes);  
   var featureEnabled = decision.variation !== null ? decision.variation.featureEnabled : false;
   var variableValue = this._getFeatureVariableValueFromVariation(featureKey, featureEnabled, decision.variation, variable, userId);
 
@@ -766,7 +766,7 @@ Optimizely.prototype._getFeatureVariableForType = function(featureKey, variableK
       variationKey: decision.variation.key,
     };
   }
-
+  
   this.notificationCenter.sendNotifications(NOTIFICATION_TYPES.DECISION, {
     type: DECISION_NOTIFICATION_TYPES.FEATURE_VARIABLE,
     userId: userId,
@@ -785,10 +785,10 @@ Optimizely.prototype._getFeatureVariableForType = function(featureKey, variableK
 };
 
 /**
- * Helper method to get the non type-casted value for a variable attached to a
- * feature flag. Returns appropriate variable value depending on whether there
- * was a matching variation, feature was enabled or not or varible was part of the
- * available variation or not. Also logs the appropriate message explaining how it
+ * Helper method to get the non type-casted value for a variable attached to a 
+ * feature flag. Returns appropriate variable value depending on whether there 
+ * was a matching variation, feature was enabled or not or varible was part of the 
+ * available variation or not. Also logs the appropriate message explaining how it 
  * evaluated the value of the variable.
  *
  * @param {string} featureKey           Key of the feature whose variable's value is
@@ -857,7 +857,7 @@ Optimizely.prototype._getFeatureVariableValueFromVariation = function(featureKey
       )
     );
   }
-
+  
   return projectConfig.getTypeCastValue(variableValue, variable.type, this.logger);
 }
 
@@ -1021,21 +1021,21 @@ Optimizely.prototype.getAllFeatureVariables = function(featureKey, userId, attri
     if (!this.__validateInputs({ feature_key: featureKey, user_id: userId }, attributes)) {
       return null;
     }
-
+  
     var configObj = this.projectConfigManager.getConfig();
     if (!configObj) {
       return null;
     }
-
+  
     var featureFlag = projectConfig.getFeatureFromKey(configObj, featureKey, this.logger);
     if (!featureFlag) {
       return null;
     }
-
-    var decision = this.decisionService.getVariationForFeature(configObj, featureFlag, userId, attributes);
-    var featureEnabled = decision.variation !== null ? decision.variation.featureEnabled : false;
+    
+    var decision = this.decisionService.getVariationForFeature(configObj, featureFlag, userId, attributes);    
+    var featureEnabled = decision.variation !== null ? decision.variation.featureEnabled : false;    
     var allVariables = {};
-
+    
     featureFlag.variables.forEach(function (variable) {
       allVariables[variable.key] = this._getFeatureVariableValueFromVariation(featureKey, featureEnabled, decision.variation, variable, userId);
     }.bind(this));
@@ -1054,8 +1054,8 @@ Optimizely.prototype.getAllFeatureVariables = function(featureKey, userId, attri
       decisionInfo: {
         featureKey: featureKey,
         featureEnabled: featureEnabled,
-        source: decision.decisionSource,
-        variableValues: allVariables,
+        source: decision.decisionSource,        
+        variableValues: allVariables,        
         sourceInfo: sourceInfo,
       },
     });