Merge pull request #53 from onfido/release

Release 0.6.1

CHANGELOG.md

@@ -4,11 +4,27 @@ This project adheres to the Node default version scheme, meaning It's safe to us
 The standard for the caret can [be found here](https://docs.npmjs.com/misc/semver#caret-ranges-123-025-004).
 Breaking changes result in a different major. UI changes that might break customizations on top of the sdk, will be treated as breaking changes too.
 
+
+## [0.6.1]
+
+### Changed
+- Public: `Onfido.init()` now returns an object.
+- Internal: `isDesktop` detection is now based on [DetectRTC][detectrtc]'s `isMobile` detection
+- Internal: improved Webcam Detection, it now takes into account wether a Webcam exists and if it the user has given the website permission to use it. Before it was only checking whether the **getUserMedia** API is supported by the browser or not. [DetectRTC][detectrtc] is used for this detection.
+
+### Added
+- Public: it's now possible to change the init options at runtime by calling `setOptions()` on the object returned by `Onfido.init()`
+- Public: `useWebcam` option added to the facial and document capture step
+
+[detectrtc]: https://github.com/muaz-khan/DetectRTC
+
+
 ## [0.5.1]
 ### Fix
 - SDK Core dependency update, fixes issue https://github.com/onfido/onfido-sdk-ui/issues/25
 **Note:** This update only changes the dist folder release, npm releases get the dependency update if they do `npm install`
 
+
 ## [0.5.0]
 ### Added
 - API: Flow customization option `steps:[]`
@@ -20,5 +36,6 @@ Breaking changes result in a different major. UI changes that might break custom
 
 The standard for this change log can be found [here](http://keepachangelog.com/).
 
+[0.6.1]: https://github.com/onfido/onfido-sdk-ui/compare/0.5.1...0.6.1
 [0.5.1]: https://github.com/onfido/onfido-sdk-ui/compare/0.5.0...0.5.1
 [0.5.0]: https://github.com/onfido/onfido-sdk-ui/compare/0.4.0...0.5.0

README.md

@@ -45,7 +45,7 @@ And the CSS styles:
 
 #### Example app
 
-[JsFiddle example here.](https://jsfiddle.net/4xqtt6fL/3/)
+[JsFiddle example here.](https://jsfiddle.net/4xqtt6fL/7/)
 Simple example using script tags.
 
 #### 1.2 NPM style import
@@ -73,7 +73,7 @@ The library is **Browser only**, it does not support the **Node Context**.
 
 #### Example App
 
- **[Webpack Sample App repository here.](https://github.com/onfido/onfido-sdk-web-sample-app/tree/0.0.1)**
+ **[Webpack Sample App repository here.](https://github.com/onfido/onfido-sdk-web-sample-app/tree/0.0.2)**
 Example app which uses the npm style of import.
 
 ### 2. Some markup

dist/index.html

@@ -21,20 +21,20 @@
           if (request.status >= 200 && request.status < 400) {
             var data = JSON.parse(request.responseText)
 
-            Onfido.init({
+            window.onfidoOut = Onfido.init({
               useModal: false,
               token: data.message,
               onReady: function() {
-                // callback that fires when successfully authorised
+                /*callback for when */ console.log("successfully authorised")
               },
               onDocumentCapture: function(event) {
-                // callback for when the document has captured successfully
+                /*callback for when the*/ console.log("document has been captured successfully")
               },
               onFaceCapture: function(event) {
-                // callback for when the face capture was successful
+                /*callback for when the*/ console.log("face capture was successful")
               },
               onComplete: function(event) {
-                // callback for when everything is complete
+                /*callback for when */ console.log("everything is complete")
               },
               steps: [
                 {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "onfido-sdk-ui",
-  "version": "0.5.1",
+  "version": "0.6.1",
   "description": "JavaScript SDK view layer for Onfido identity verification",
   "scripts": {
     "predev": "npm run build",
@@ -75,6 +75,7 @@
     "postcss-url": "^5.1.2",
     "preact-compat": "^1.7.1",
     "raw-loader": "^0.5.1",
+    "rimraf": "^2.5.4",
     "sinon": "^1.17.3",
     "sinon-chai": "^2.8.0",
     "source-map-loader": "^0.1.5",