From f0d256ffa282b4ac2987bd2b1219339dd6a6d7d5 Mon Sep 17 00:00:00 2001 From: Polina Nguen <43302774+yavorona@users.noreply.github.com> Date: Mon, 6 Apr 2020 12:10:59 -0700 Subject: [PATCH 1/4] Update CHANGELOG.MD --- packages/optimizely-sdk/CHANGELOG.MD | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/packages/optimizely-sdk/CHANGELOG.MD b/packages/optimizely-sdk/CHANGELOG.MD index 474dea1ab..382cb7307 100644 --- a/packages/optimizely-sdk/CHANGELOG.MD +++ b/packages/optimizely-sdk/CHANGELOG.MD @@ -12,6 +12,23 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ### Breaking Changes: - Removed `Promise` polyfill from browser entry point ([417](https://github.com/optimizely/javascript-sdk/pull/417)) +### New Features + + - Changed functionality of JSON schema validation in React Native, Node, and Browser entry points ([442](https://github.com/optimizely/javascript-sdk/pull/442)) + - Previosly, `skipJSONValidation` flag was used by the user to specify whether the JSON object should be validated + - Now, `skipJSONValidation` has been removed entirely from all three entry points. Instead, a user will need to import `jsonSchemaValidator` from `@optimizely/optimizely-sdk/lib/utils/json_schema_validator` and pass it to `createInstance` to perform validation as shown below: + + ```js + const optimizelySDK = require('@optimizely/optimizely-sdk'); + const jsonSchemaValidator = require('@optimizely/optimizely-sdk/lib/utils/json_schema_validator'); + + // Require JSON schema validation for the datafile + var optimizelyClientInstance = optimizely.createInstance({ + datafile: datafile, + jsonSchemaValidator: jsonSchemaValidator, + }); + ``` + ## [3.6.0-alpha.1] - March 4, 2020 ### New Features From 7391bcde6a365e3cc438ae6cadffa1768dd7103b Mon Sep 17 00:00:00 2001 From: Polina Nguen Date: Mon, 6 Apr 2020 15:47:16 -0700 Subject: [PATCH 2/4] Address Ali's comments --- packages/optimizely-sdk/CHANGELOG.MD | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/optimizely-sdk/CHANGELOG.MD b/packages/optimizely-sdk/CHANGELOG.MD index 382cb7307..358208724 100644 --- a/packages/optimizely-sdk/CHANGELOG.MD +++ b/packages/optimizely-sdk/CHANGELOG.MD @@ -14,9 +14,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ### New Features - - Changed functionality of JSON schema validation in React Native, Node, and Browser entry points ([442](https://github.com/optimizely/javascript-sdk/pull/442)) - - Previosly, `skipJSONValidation` flag was used by the user to specify whether the JSON object should be validated - - Now, `skipJSONValidation` has been removed entirely from all three entry points. Instead, a user will need to import `jsonSchemaValidator` from `@optimizely/optimizely-sdk/lib/utils/json_schema_validator` and pass it to `createInstance` to perform validation as shown below: + - Changed functionality of JSON schema validation in React Native, Node, and Browser entry points ([442](https://github.com/optimizely/javascript-sdk/pull/442)). + - Previously, `skipJSONValidation` flag was used by the user to specify whether the JSON object should be validated. + - Now, `skipJSONValidation` has been removed entirely from all entry points. Instead, a user will need to import `jsonSchemaValidator` from `@optimizely/optimizely-sdk/lib/utils/json_schema_validator` and pass it to `createInstance` to perform validation as shown below: ```js const optimizelySDK = require('@optimizely/optimizely-sdk'); From a8ef7c69b50a1b2981be5cc0f6e457ff7fbdb20c Mon Sep 17 00:00:00 2001 From: Polina Nguen Date: Mon, 6 Apr 2020 16:09:41 -0700 Subject: [PATCH 3/4] Address comments --- packages/optimizely-sdk/CHANGELOG.MD | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/optimizely-sdk/CHANGELOG.MD b/packages/optimizely-sdk/CHANGELOG.MD index 358208724..77082800a 100644 --- a/packages/optimizely-sdk/CHANGELOG.MD +++ b/packages/optimizely-sdk/CHANGELOG.MD @@ -14,7 +14,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ### New Features - - Changed functionality of JSON schema validation in React Native, Node, and Browser entry points ([442](https://github.com/optimizely/javascript-sdk/pull/442)). + - Changed functionality of JSON schema validation in all entry points ([442](https://github.com/optimizely/javascript-sdk/pull/442)). - Previously, `skipJSONValidation` flag was used by the user to specify whether the JSON object should be validated. - Now, `skipJSONValidation` has been removed entirely from all entry points. Instead, a user will need to import `jsonSchemaValidator` from `@optimizely/optimizely-sdk/lib/utils/json_schema_validator` and pass it to `createInstance` to perform validation as shown below: From 2ac23944c1dfc12ac98f1b4d671bd45c48332357 Mon Sep 17 00:00:00 2001 From: Polina Nguen Date: Wed, 8 Apr 2020 14:07:33 -0700 Subject: [PATCH 4/4] Move new changes under "Breaking Changes" --- packages/optimizely-sdk/CHANGELOG.MD | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/packages/optimizely-sdk/CHANGELOG.MD b/packages/optimizely-sdk/CHANGELOG.MD index 77082800a..fb1cf3d54 100644 --- a/packages/optimizely-sdk/CHANGELOG.MD +++ b/packages/optimizely-sdk/CHANGELOG.MD @@ -10,11 +10,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ## [4.0.0-alpha.1] - March 4, 2020 ### Breaking Changes: -- Removed `Promise` polyfill from browser entry point ([417](https://github.com/optimizely/javascript-sdk/pull/417)) - -### New Features - - - Changed functionality of JSON schema validation in all entry points ([442](https://github.com/optimizely/javascript-sdk/pull/442)). +- Removed `Promise` polyfill from browser entry point ([417](https://github.com/optimizely/javascript-sdk/pull/417)). +- Changed functionality of JSON schema validation in all entry points ([442](https://github.com/optimizely/javascript-sdk/pull/442)). - Previously, `skipJSONValidation` flag was used by the user to specify whether the JSON object should be validated. - Now, `skipJSONValidation` has been removed entirely from all entry points. Instead, a user will need to import `jsonSchemaValidator` from `@optimizely/optimizely-sdk/lib/utils/json_schema_validator` and pass it to `createInstance` to perform validation as shown below: