Merge branch 'pnguen/optimizely-module-to-ts' into uzair/react_native_js_to_ts

Author: uzair-folio3

packages/optimizely-sdk/CHANGELOG.MD

@@ -9,7 +9,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Bug fixes
 
-  - Fixed return type of `getAllFeatureVariables` method in TypeScript type definitions ([#576](https://github.com/optimizely/javascript-sdk/pull/576))
+- Fixed return type of `getAllFeatureVariables` method and `dispatchEvent ` method signature of `EventDispatcher` interface in TypeScript type definitions ([#576](https://github.com/optimizely/javascript-sdk/pull/576))
+
+## [4.3.0] - October 1, 2020
+
+### New Features
+
+- Added support for version audience evaluation ([#517](https://github.com/optimizely/javascript-sdk/pull/571))
+- Add datafile accessor ([#564](https://github.com/optimizely/javascript-sdk/pull/564))
 
 ## [4.2.1] - August 10, 2020
 
@@ -19,11 +26,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [4.2.0] - July 31, 2020
 
 ### New Features
+
   - Better offline support in React Native apps:
     - Persist downloaded datafiles in local storage for use in subsequent SDK initializations ([#430](https://github.com/optimizely/javascript-sdk/pull/430))
     - Persist pending impression & conversion events in local storage ([#517](https://github.com/optimizely/javascript-sdk/pull/517), [#532](https://github.com/optimizely/javascript-sdk/pull/532))
 
 ### Bug fixes
+
   - Fixed log messages for Targeted Rollouts ([#515](https://github.com/optimizely/javascript-sdk/pull/515))
 
 ## [4.1.0] - July 7, 2020

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.browser.tests.js

@@ -148,7 +148,7 @@ describe('javascript-sdk', function() {
         optlyInstance.onReady().catch(function() {});
 
         assert.instanceOf(optlyInstance, Optimizely);
-        assert.equal(optlyInstance.clientVersion, '4.2.1');
+        assert.equal(optlyInstance.clientVersion, '4.3.0');
       });
 
       it('should set the JavaScript client engine and version', function() {

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

@@ -67,72 +67,72 @@ declare module '@optimizely/optimizely-sdk' {
     activate(
       experimentKey: string,
       userId: string,
-      attributes?: import('./shared_types').UserAttributes
+      attributes?: UserAttributes
     ): string | null;
     track(
       eventKey: string,
       userId: string,
-      attributes?: import('./shared_types').UserAttributes,
+      attributes?: UserAttributes,
       eventTags?: EventTags
     ): void;
     getVariation(
       experimentKey: string,
       userId: string,
-      attributes?: import('./shared_types').UserAttributes
+      attributes?: UserAttributes
     ): string | null;
     setForcedVariation(experimentKey: string, userId: string, variationKey: string | null): boolean;
     getForcedVariation(experimentKey: string, userId: string): string | null;
     isFeatureEnabled(
       featureKey: string,
       userId: string,
-      attributes?: import('./shared_types').UserAttributes
+      attributes?: UserAttributes
     ): boolean;
     getEnabledFeatures(
       userId: string,
-      attributes?: import('./shared_types').UserAttributes
+      attributes?: UserAttributes
     ): string[];
     getFeatureVariable(
       featureKey: string,
       variableKey: string,
       userId: string,
-      attributes?: import('./shared_types').UserAttributes
+      attributes?: UserAttributes
     ): unknown;
     getFeatureVariableBoolean(
       featureKey: string,
       variableKey: string,
       userId: string,
-      attributes?: import('./shared_types').UserAttributes
+      attributes?: UserAttributes
     ): boolean | null;
     getFeatureVariableDouble(
       featureKey: string,
       variableKey: string,
       userId: string,
-      attributes?: import('./shared_types').UserAttributes
+      attributes?: UserAttributes
     ): number | null;
     getFeatureVariableInteger(
       featureKey: string,
       variableKey: string,
       userId: string,
-      attributes?: import('./shared_types').UserAttributes
+      attributes?: UserAttributes
     ): number | null;
     getFeatureVariableString(
       featureKey: string,
       variableKey: string,
       userId: string,
-      attributes?: import('./shared_types').UserAttributes
+      attributes?: UserAttributes
     ): string | null;
     getFeatureVariableJSON(
       featureKey: string,
       variableKey: string,
       userId: string,
-      attributes?: import('./shared_types').UserAttributes
+      attributes?: UserAttributes
     ): unknown;
     getAllFeatureVariables(
       featureKey: string,
       userId: string,
-      attributes?: import('./shared_types').UserAttributes
+      attributes?: UserAttributes
     ): { [variableKey: string]: unknown } | null;
-    getOptimizelyConfig(): import('./shared_types').OptimizelyConfig | null;
+    getOptimizelyConfig(): OptimizelyConfig | null;
     onReady(options?: { timeout?: number }): Promise<{ success: boolean; reason?: string }>;
     close(): Promise<{ success: boolean; reason?: string }>;
   }
@@ -150,6 +150,61 @@ declare module '@optimizely/optimizely-sdk' {
     params: any;
   }
 
+  export type UserAttributes = {
+    // TODO[OASIS-6649]: Don't use any type
+    // eslint-disable-next-line  @typescript-eslint/no-explicit-any
+    [name: string]: any;
+  }
+
+  /**
+   * Optimizely Config Entities
+   */
+  export interface OptimizelyExperiment {
+    id: string;
+    key: string;
+    variationsMap: {
+      [variationKey: string]: OptimizelyVariation;
+    };
+  }
+
+  export interface OptimizelyVariable {
+    id: string;
+    key: string;
+    type: string;
+    value: string;
+  }
+
+  export interface OptimizelyFeature {
+    id: string;
+    key: string;
+    experimentsMap: {
+      [experimentKey: string]: OptimizelyExperiment;
+    };
+    variablesMap: {
+      [variableKey: string]: OptimizelyVariable;
+    };
+  }
+
+  export interface OptimizelyVariation {
+    id: string;
+    key: string;
+    featureEnabled?: boolean;
+    variablesMap: {
+      [variableKey: string]: OptimizelyVariable;
+    };
+  }
+
+  export interface OptimizelyConfig {
+    experimentsMap: {
+      [experimentKey: string]: OptimizelyExperiment;
+    };
+    featuresMap: {
+      [featureKey: string]: OptimizelyFeature;
+    };
+    revision: string;
+    getDatafile(): string;
+  }
+
   export interface EventDispatcher {
     /**
      * @param event
@@ -158,7 +213,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 = {
@@ -180,7 +235,7 @@ declare module '@optimizely/optimizely-sdk' {
 
   export interface ListenerPayload {
     userId: string;
-    attributes: import('./shared_types').UserAttributes;
+    attributes: UserAttributes;
   }
 
   export interface ActivateListenerPayload extends ListenerPayload {

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

@@ -90,7 +90,7 @@ describe('optimizelyFactory', function() {
         optlyInstance.onReady().catch(function() {});
 
         assert.instanceOf(optlyInstance, Optimizely);
-        assert.equal(optlyInstance.clientVersion, '4.2.1');
+        assert.equal(optlyInstance.clientVersion, '4.3.0');
       });
 
       describe('event processor configuration', function() {

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

@@ -89,7 +89,7 @@ describe('javascript-sdk/react-native', function() {
         optlyInstance.onReady().catch(function() {});
 
         assert.instanceOf(optlyInstance, Optimizely);
-        assert.equal(optlyInstance.clientVersion, '4.2.1');
+        assert.equal(optlyInstance.clientVersion, '4.3.0');
       });
 
       it('should set the Javascript client engine and version', function() {

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 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 {
@@ -1330,7 +1329,7 @@ export class Optimizely {
    * @param  {number|undefined} options.timeout
    * @return {Promise}
    */
-  onReady(options?: { timeout?: number }): Promise<{ success: boolean; reason?: string }> {
+  onReady(options?: { timeout?: number }): Promise<OnReadyResult> {
     let timeoutValue: number | undefined;
     if (typeof options === 'object' && options !== null) {
       if (options.timeout !== undefined) {
@@ -1341,9 +1340,9 @@ export 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 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;
 }
 
 /**

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

@@ -173,7 +173,7 @@ export const CONTROL_ATTRIBUTES = {
 export const JAVASCRIPT_CLIENT_ENGINE = 'javascript-sdk';
 export const NODE_CLIENT_ENGINE = 'node-sdk';
 export const REACT_CLIENT_ENGINE = 'react-sdk';
-export const NODE_CLIENT_VERSION = '4.2.1';
+export const NODE_CLIENT_VERSION = '4.3.0';
 
 export const VALID_CLIENT_ENGINES = [
   NODE_CLIENT_ENGINE,

packages/optimizely-sdk/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@optimizely/optimizely-sdk",
-  "version": "4.2.1",
+  "version": "4.3.0",
   "description": "JavaScript SDK for Optimizely X Full Stack",
   "module": "dist/optimizely.browser.es.min.js",
   "main": "dist/optimizely.node.min.js",