refactor: Replaced explicit typings with auto generated ones (#745)

## Summary
This SDK was originally javascript only. We had to add explicit typings in `lib/index.d.ts` to support typescript users. Now that it has been converted to typescript, we can safely remove `lib/index.d.ts` and autogenerate typings. This PR does exactly that. We also encountered some discrepancies with existing typings so we fixed those too. 

## Test plan
- Manually tested thoroughly with typescript projects
- All existing tests pass.

Author: ozayr-zaviar

packages/optimizely-sdk/CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Changed
 - Add package.json script for running Karma tests locally using Chrome ([#651](https://github.com/optimizely/javascript-sdk/pull/651)).
+- Replaced explicit typescript typings with auto generated ones ([#745](https://github.com/optimizely/javascript-sdk/pull/745))
 
 ## [4.9.1] - January 18, 2022
 
@@ -18,13 +19,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [4.9.0] - January 14, 2022
 
 ### New Features
-* Add a set of new APIs for overriding and managing user-level flag, experiment and delivery rule decisions. These methods can be used for QA and automated testing purposes. They are an extension of the OptimizelyUserContext interface ([#705](https://github.com/optimizely/javascript-sdk/pull/705), [#727](https://github.com/optimizely/javascript-sdk/pull/727), [#729](https://github.com/optimizely/javascript-sdk/pull/729), [#730](https://github.com/optimizely/javascript-sdk/pull/730)):
+- Add a set of new APIs for overriding and managing user-level flag, experiment and delivery rule decisions. These methods can be used for QA and automated testing purposes. They are an extension of the OptimizelyUserContext interface ([#705](https://github.com/optimizely/javascript-sdk/pull/705), [#727](https://github.com/optimizely/javascript-sdk/pull/727), [#729](https://github.com/optimizely/javascript-sdk/pull/729), [#730](https://github.com/optimizely/javascript-sdk/pull/730)):
 	- setForcedDecision
 	- getForcedDecision
 	- removeForcedDecision
 	- removeAllForcedDecisions
 
-* For details, refer to our documentation pages: [OptimizelyUserContext](https://docs.developers.optimizely.com/full-stack/v4.0/docs/optimizelyusercontext-javascript-node) and [Forced Decision methods](https://docs.developers.optimizely.com/full-stack/v4.0/docs/forced-decision-methods-javascript-node).
+- For details, refer to our documentation pages: [OptimizelyUserContext](https://docs.developers.optimizely.com/full-stack/v4.0/docs/optimizelyusercontext-javascript-node) and [Forced Decision methods](https://docs.developers.optimizely.com/full-stack/v4.0/docs/forced-decision-methods-javascript-node).
 
 ## [4.8.0] - November 29, 2021
 

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

@@ -1,5 +1,5 @@
 /**
- * Copyright 2016-2021, Optimizely
+ * Copyright 2016-2022, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -45,7 +45,9 @@ import {
 } from '../../shared_types';
 
 interface TryCreatingProjectConfigConfig {
-  datafile: string;
+  // TODO[OASIS-6649]: Don't use object type
+  // eslint-disable-next-line  @typescript-eslint/ban-types
+  datafile: string | object;
   jsonSchemaValidator?: {
     validate(jsonObject: unknown): boolean,
   };

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

@@ -1,5 +1,5 @@
 /**
- * Copyright 2019-2021, Optimizely
+ * Copyright 2019-2022, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -29,7 +29,9 @@ const logger = getLogger();
 const MODULE_NAME = 'PROJECT_CONFIG_MANAGER';
 
 interface ProjectConfigManagerConfig {
-  datafile?: string,
+  // TODO[OASIS-6649]: Don't use object type
+  // eslint-disable-next-line  @typescript-eslint/ban-types
+  datafile?: string | object,
   jsonSchemaValidator?: {
     validate(jsonObject: unknown): boolean,
   };
@@ -169,10 +171,12 @@ export class ProjectConfigManager {
    * the new config object's revision is newer than the current one, sets/updates the project config
    * and optimizely config object instance variables and returns null for the error. If unsuccessful,
    * the project config and optimizely config objects will not be updated, and the error is returned.
-   * @param   {string}        newDatafile
+   * @param   {string | object}        newDatafile
    * @returns {Error|null}    error or null
    */
-  private handleNewDatafile(newDatafile: string): Error | null {
+  // TODO[OASIS-6649]: Don't use object type
+  // eslint-disable-next-line  @typescript-eslint/ban-types
+  private handleNewDatafile(newDatafile: string | object): Error | null {
     const { configObj, error } = tryCreatingProjectConfig({
       datafile: newDatafile,
       jsonSchemaValidator: this.jsonSchemaValidator,

packages/optimizely-sdk/lib/export_types.ts

@@ -0,0 +1,41 @@
+/**
+ * Copyright 2022, 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.
+ */
+export {
+  UserAttributes,
+  OptimizelyConfig,
+  OptimizelyVariable,
+  OptimizelyVariation,
+  OptimizelyExperiment,
+  OptimizelyFeature,
+  OptimizelyDecisionContext,
+  OptimizelyForcedDecision,
+  EventTags,
+  Event,
+  EventDispatcher,
+  DatafileOptions,
+  OptimizelyOptions,
+  UserProfileService,
+  UserProfile,
+  ListenerPayload,
+  OptimizelyDecision,
+  OptimizelyUserContext,
+  NotificationListener,
+  Config,
+  Client,
+  ActivateListenerPayload,
+  TrackListenerPayload,
+  NotificationCenter
+} from './shared_types'

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

@@ -1,5 +1,5 @@
 /**
- * Copyright 2016-2017, 2019-2020 Optimizely
+ * Copyright 2016-2017, 2019-2022 Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -31,7 +31,7 @@ import Optimizely from './optimizely';
 import eventProcessorConfigValidator from './utils/event_processor_config_validator';
 import { createNotificationCenter } from './core/notification_center';
 import { default as eventProcessor } from './plugins/event_processor';
-import { SDKOptions, OptimizelyDecideOption } from './shared_types';
+import { OptimizelyDecideOption, Client, Config } from './shared_types';
 import { createHttpPollingDatafileManager } from './plugins/datafile_manager/http_polling_datafile_manager';
 
 const logger = getLogger();
@@ -47,13 +47,15 @@ let hasRetriedEvents = false;
 
 /**
  * Creates an instance of the Optimizely class
- * @param  {SDKOptions} config
- * @return {Optimizely|null} the Optimizely object
+ * @param  {Config} config
+ * @return {Client|null} the Optimizely client object
  *                           null on error 
  */
-const createInstance = function(config: SDKOptions): Optimizely | null {
+const createInstance = function(config: Config): Client | null {
   try {
     // TODO warn about setting per instance errorHandler / logger / logLevel
+    let isValidInstance = false
+
     if (config.errorHandler) {
       setErrorHandler(config.errorHandler);
     }
@@ -68,10 +70,9 @@ const createInstance = function(config: SDKOptions): Optimizely | null {
 
     try {
       configValidator.validate(config);
-      config.isValidInstance = true;
+      isValidInstance = true;
     } catch (ex) {
       logger.error(ex);
-      config.isValidInstance = false;
     }
 
     let eventDispatcher;
@@ -125,6 +126,7 @@ const createInstance = function(config: SDKOptions): Optimizely | null {
       errorHandler,
       datafileManager: config.sdkKey ? createHttpPollingDatafileManager(config.sdkKey, logger, config.datafile, config.datafileOptions) : undefined,
       notificationCenter,
+      isValidInstance: isValidInstance
     };
 
     const optimizely = new Optimizely(optimizelyOptions);
@@ -181,3 +183,5 @@ export default {
   __internalResetRetryState,
   OptimizelyDecideOption,
 };
+
+export * from './export_types'