Merge branch 'master' into alibaker/add-notification-center-unit-tests

Author: alibaker-optimizely

packages/optimizely-sdk/CHANGELOG.MD

@@ -8,17 +8,22 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Bug fixes
 - Fixed default event dispatcher not used in React Native entry point ([#383](https://github.com/optimizely/javascript-sdk/pull/383))
 
+## [3.4.1] - January 28th, 2020
+
+### Bug fixes
+- Added `getOptimizelyConfig` and related types to TypeScript type definitions([#390](https://github.com/optimizely/javascript-sdk/pull/390)).
+
 ## [3.4.0] - January 21th, 2020
 
 ### Bug fixes
-- Fixed incorrect payload for decision notification triggered by calling getVariation on a feature test in a mutex group([#375](https://github.com/optimizely/javascript-sdk/pull/375))
+- Fixed incorrect payload for decision notification triggered by calling getVariation on a feature test in a mutex group([#375](https://github.com/optimizely/javascript-sdk/pull/375)).
 
 ### New Features
-- Added a new API to get a project configuration static data.
-  - Call `getOptimizelyConfig()` to get a snapshot copy of project configuration static data.
+- Added a new API to get project configuration static data.
+  - Call `getOptimizelyConfig()` to get a snapshot of project configuration static data.
   - It returns an `OptimizelyConfig` instance which includes a datafile revision number, all experiments, and feature flags mapped by their key values.
-  - Added caching for `getOptimizelyConfig` - `OptimizelyConfig` object will be cached and reused for the lifetime of the datafile
-  - For details, refer to a documention page: https://docs.developers.optimizely.com/full-stack/docs/optimizelyconfig-javascript-node
+  - Added caching for `getOptimizelyConfig` - `OptimizelyConfig` object will be cached and reused for the lifetime of the datafile.
+  - For details, refer to our documentation page: [https://docs.developers.optimizely.com/full-stack/docs/optimizelyconfig-javascript-node](https://docs.developers.optimizely.com/full-stack/docs/optimizelyconfig-javascript-node).
 
 ### Removed Features
 - Removed support for `'launched'` experiment status

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

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

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

@@ -1,5 +1,5 @@
 /**
- * Copyright 2018-2019, Optimizely
+ * Copyright 2018-2020, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -111,10 +111,11 @@ declare module "@optimizely/optimizely-sdk" {
       userId: string,
       attributes?: UserAttributes
     ): string | null;
+    getOptimizelyConfig(): OptimizelyConfig | null;
     onReady(options?: {
       timeout?: number;
     }): Promise<{ success: boolean; reason?: string }>;
-    close(): void;
+    close(): void;    
   }
 
   // An event to be submitted to Optimizely, enabling tracking the reach and impact of
@@ -214,6 +215,66 @@ declare module "@optimizely/optimizely-sdk" {
       };
     };
   }
+
+  /**
+   * Optimizely Config Entities
+   */
+  export interface OptimizelyVariable {
+    id: string;
+    key: string;
+    type: string;
+    value: string;
+  }
+  
+  export interface OptimizelyVariation {
+    id: string;
+    key: string;
+    featureEnabled?: boolean;
+    variablesMap: {
+      [variableKey: string]: {
+        variable: OptimizelyVariable;
+      };
+    };
+  }
+
+  export interface OptimizelyExperiment {
+    id: string;
+    key: string;
+    variationsMap: {
+      [variationKey: string]: {
+        variation: OptimizelyVariation;
+      };
+    };
+  }
+
+  export interface OptimizelyFeature {
+    id: string;
+    key: string;
+    experimentsMap: {
+      [experimentKey: string]: {
+        experiment: OptimizelyExperiment;
+      };
+    };
+    variablesMap: {
+      [variableKey: string]: {
+        variable: OptimizelyVariable;
+      };
+    };
+  }
+
+  export interface OptimizelyConfig {
+    experimentsMap: {
+      [experimentKey: string]: {
+        experiment: OptimizelyExperiment;
+      };
+    };
+    featuresMap: {
+      [featureKey: string]: {
+        feature: OptimizelyFeature;
+      };
+    };
+    revision: string;
+  }
 }
 
 declare module "@optimizely/optimizely-sdk/lib/utils/enums" {

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

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

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

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

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

@@ -159,7 +159,7 @@ exports.CONTROL_ATTRIBUTES = {
 exports.JAVASCRIPT_CLIENT_ENGINE = 'javascript-sdk';
 exports.NODE_CLIENT_ENGINE = 'node-sdk';
 exports.REACT_CLIENT_ENGINE = 'react-sdk';
-exports.NODE_CLIENT_VERSION = '3.4.0';
+exports.NODE_CLIENT_VERSION = '3.4.1';
 
 exports.VALID_CLIENT_ENGINES = [
   exports.NODE_CLIENT_ENGINE,

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

@@ -1,6 +1,6 @@
 {
   "name": "@optimizely/optimizely-sdk",
-  "version": "3.4.0",
+  "version": "3.4.1",
   "description": "JavaScript SDK for Optimizely X Full Stack",
   "main": "lib/index.node.js",
   "browser": "lib/index.browser.js",