@@ -4,6 +4,86 @@ All notable changes to this project will be documented in this file.
44The format is based on [ Keep a Changelog] ( http://keepachangelog.com/ )
55and this project adheres to [ Semantic Versioning] ( http://semver.org/ ) .
66
7+ ## [ 0.8.0] - 2017-07-24
8+ This release makes it easier to include the chatbot UI into existing
9+ sites. The project now distributes a pre-built library in the dist
10+ directory. This allows to use the chatbot UI without having to build the
11+ application. The root directory of the repo now contains a package.json
12+ file to make it easier to npm install it.
13+
14+ There are a few breaking changes regarding the supported URL parameters
15+ which now use the ` lexWebUi ` prefix to avoid conflicts when including
16+ the component in an existing site.
17+
18+ ### Changed
19+ - ** [ BREAKING] ** Changed config passing URL query parameter from ` config `
20+ to ` lexWebUiConfig `
21+ - ** [ BREAKING] ** Changed URL query parameter to run in embedded mode from
22+ ` embed ` to ` lexWebUiEmbed `
23+ - The ` parentOrigin ` config variable now defaults to
24+ ` window.location.origin ` to support single origin iframe setups
25+ without having to set it in the the JSON config file
26+ - Restructured Vuex store including:
27+ * Split state, mutations and actions to individual files
28+ * Moved audio, recorder, aws credentials/clients out of the state.
29+ Those now exist as module variables visible from the store actions
30+ * AWS credentials from parent are now manually recreated to avoid
31+ including the AWS SDK as part of the store
32+ - Changed from using vuex mapGetter in components to instead use the
33+ store state variables. This was done to avoid redistributing vuex
34+ in the built library and to support vuex being loaded outside of the
35+ chatbot ui.
36+ - Moved Vue component initialization from LexApp.vue to LexWeb.vue
37+ - Moved Page component to LexApp.vue from LexWeb.vue
38+ - Moved webpack related import config from recorder to the general
39+ webpack config
40+ - Commented out webrtc-adapter import in preparation to deprecating it
41+ - Changed constructor arguments of lex client to accept a
42+ lexRuntime client instead of AWS credentials or SDK config. This allows
43+ redistributing without having to include AWS SDK as a direct dependency
44+ - Changed iframe container class name
45+ - Rearranged the README files. The main README contains info about the
46+ npm package and instructions to use the library. The CloudFormation and
47+ application details where move to different README files.
48+
49+ ### Added
50+ - Created a Vue plugin that can be used to instantiate the chatbot ui
51+ both as an import in a webpack based project or by directly sourcing
52+ the library in a script tag. The plugin registers itself and adds
53+ a property named ` $lexWebUi ` to the Vue class. It adds a global Vue
54+ component name ` LexWebUi `
55+ - Added a distribution build config and related scripts
56+ - Added an example on how to encode the URL query parameter config
57+ - Added a new config object key ` urlQueryParams ` holding the url query
58+ parameters
59+
60+ ## [ 0.7.1] - 2017-07-17
61+ This release adds basic unit and e2e testing. Various components were
62+ refactored to enable this.
63+
64+ ### Changed
65+ - Synched vue build environment with latest vue cli template
66+ - Refactored store to make it more modular and easier to test including:
67+ * It no longer exports a Vuex object but instead exports an object that
68+ can be used as a vuex constructor argument
69+ * It no longer uses the global AWS object. It now creates its own AWS
70+ Config object
71+ * It no longer creates the bot audio element. The Audio element is set
72+ with an action
73+ - Moved Vuex store instantiation to the LexApp component
74+ - Refactored the lex run time client library to accept an AWS SDK Config
75+ object to avoid using the global one
76+
77+ ### Added
78+ - Added setup for running e2e test including:
79+ * Added nightwatch chrome options to fake devices for mocking mic
80+ * Changed nightwatch runner to connect dev server if already running
81+ * Basic e2e test for stand-alone and iframe
82+ - Added setup to run unit tests including an initial set of basic tests
83+ for the vuex store and the LexWeb Vue component
84+ - Added version from package.js to vuex store state
85+ - Added babel-polyfill as an npm dev dependency for unit testing
86+
787## [ 0.7.0] - 2017-07-14
888### Added
989- Added capability to send messages from parent page to iframe using
0 commit comments