Properly alias/deprecate the change

Author: spencerwilson-optimizely

packages/optimizely-sdk/CHANGELOG.MD

@@ -1,3 +1,14 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+### Deprecated
+* The UMD build of the SDK now assigns the SDK namespace object to `window.optimizelySdk` rather than to `window.optimizelyClient`. The old name still works, but on its first access a deprecation warning is logged to the console. The alias will be removed in the 3.0.0 release.
+
 ## 2.1.1
 June 19, 2018
 

packages/optimizely-sdk/package.json

@@ -7,7 +7,7 @@
   "scripts": {
     "test": "mocha ./lib/*.tests.js ./lib/**/*.tests.js ./lib/**/**/*tests.js --recursive",
     "test-xbrowser": "karma start karma.bs.conf.js --single-run",
-    "build-browser-umd": "webpack -p lib/index.browser.js dist/optimizely.browser.umd.min.js --output-library-target=umd --output-library=optimizelySdk",
+    "build-browser-umd": "./scripts/build_browser_umd.sh",
     "lint": "eslint lib/**",
     "cover": "istanbul cover _mocha ./lib/*.tests.js ./lib/**/*.tests.js ./lib/**/**/*tests.js",
     "coveralls": "npm run cover -- --report lcovonly && cat ./coverage/lcov.info | coveralls",

packages/optimizely-sdk/scripts/build_browser_umd.sh

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash -e
+
+BUNDLE_NAME="optimizelySdk"
+
+npx webpack -p lib/index.browser.js dist/optimizely.browser.umd.min.js \
+  --output-library-target=umd \
+  --output-library="$BUNDLE_NAME"
+
+# Append some backwards-compatibility code to the bundle
+cat - >> dist/optimizely.browser.umd.min.js <<EOF
+
+
+window._optimizelyClientWarningGiven = false;
+
+Object.defineProperty(window, 'optimizelyClient', {
+  get: function () {
+    if (!window._optimizelyClientWarningGiven) {
+      console.warn('Accessing the SDK via window.optimizelyClient is deprecated; please use window.optimizelySdk instead. This functionality will be dropped in 3.0.0.');
+      window._optimizelyClientWarningGiven = true;
+    }
+
+    return {
+      createInstance: window.optimizelySdk.createInstance
+    };
+  }
+});
+EOF
+