@nuts-foundation/auth - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

index.js

@@ -15,2 +15,4 @@ let NutsLogin = (function () {
     config.postTokenPath = 'postTokenPath' in config ? config.postTokenPath : '/login';
+    // location for the browser to navigate to after success
+    config.afterSuccessPath = 'afterSuccessPath' in config ? config.afterSuccessPath : '/user'
 
@@ -95,3 +97,3 @@ if (!document.getElementById(config.qrEl)) {
 
-// handle these cases: https://godoc.org/github.com/privacybydesign/irmago/server#Status
+  // handle these cases: https://godoc.org/github.com/privacybydesign/irmago/server#Status
     const stateMachine = function (status) {
@@ -143,3 +145,7 @@ switch (status.status) {
         }
-        window.location = '/user'
+        if (res.status == 200) {
+            window.location = config.afterSuccessPath
+        } else {
+          setState(ERROR_STATE);
+        }
       }).catch((err) => {
@@ -185,3 +191,3 @@ console.log("error while validating session", err);
   };
-
+  
 })();

package.json

 {
   "name": "@nuts-foundation/auth",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Lib to connect your frontend to the nuts-auth.",
@@ -5,0 +5,0 @@ "repository": "nuts-foundation/nuts-auth-js",

README.md

@@ -1,2 +0,87 @@
-# nuts-auth-js
-An easy to use client js library to authenticate a user with nuts-auth
+# @nuts-foundation/auth
+
+[![npm (scoped)](https://img.shields.io/npm/v/@nuts-foundation/auth)](https://www.npmjs.com/package/@nuts-foundation/auth)
+
+An easy to use client js library to authenticate a user with nuts-auth.
+
+It connects to the auth server, polls for status, updates the UI and forwards the user to a given URL at success.
+
+## Install
+
+From CDN:
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/@nuts-foundation/auth/index.min.js"></script>
+```
+
+## Style guide
+
+Combine it with the NUTS style guide and get the frontend for free!
+https://github.com/nuts-foundation/irma-web-frontend
+
+## Dependencies
+
+This library depends on the [qrcodejs package from davidshumjs](https://davidshimjs.github.io/qrcodejs/)
+
+## Usage
+
+```html
+<!--The nuts auth styleguide -->
+<link rel="stylesheet" href="//nuts-foundation.github.io/irma-web-frontend/application.css" />
+<!--A lib to render qr-codes -->
+<script src="https://cdn.jsdelivr.net/gh/davidshimjs/qrcodejs@gh-pages/qrcode.min.js"></script>
+<!--The nuts auth js lib -->
+<script src="https://cdn.jsdelivr.net/npm/@nuts-foundation/auth@0.1.0/index.min.js"></script>
+
+
+<section class="nuts-login-form irma-web-form">
+  <header class="header">
+    <p>Login with <i class="irma-web-logo">IRMA</i></p>
+    <section class="helper">
+      <p>Don't know what to do here? Take a look at the <a href="https://privacybydesign.foundation/irma-begin/">de
+          website of IRMA</a>.</p>
+    </section>
+  </header>
+  <section class="content">
+    <section class="centered loading">
+      <div class="irma-web-loading-animation"><i></i><i></i><i></i><i></i><i></i><i></i><i></i><i></i><i></i>
+      </div>
+      <p>One moment please...</p>
+    </section>
+    <section class="centered initialized">
+      <div id="qrcode"></div>
+    </section>
+    <section class="centered waiting-for-user">
+      <div class="irma-web-waiting-for-user-animation"></div>
+      <p>Follow the instructions on your phone</p>
+    </section>
+    <section class="centered success">
+      <div class="irma-web-checkmark-animation"></div>
+      <p>Success!</p>
+    </section>
+    <section class="centered expired">
+      <p>The transaction took long</p>
+      <p><a href="#" onclick="nutsLogin.start()">Try again</a></p>
+    </section>
+    <section class="centered cancelled">
+      <p>The transaction got cancelled</p>
+      <p><a href="#" onclick="nutsLogin.start()">Try again</a></p>
+    </section>
+    <section class="centered errored">
+      <p>Something went wrong</p>
+      <p><a href="#" onclick="nutsLogin.start()">Try again</a></p>
+    </section>
+  </section>
+</section>
+```
+
+```js
+nutsLogin = NutsLogin.init({
+    nutsAuthUrl: "http://localhost:1323",
+    qrEl: 'qrcode',
+    logLevel: 'debug',
+    postTokenPath: '/login',
+    afterSuccessPath: '/user'
+  })
+nutsLogin.start();
+````

No alert changes

Improved metrics

Total package byte prevSize

43846

increased by7.34%

Lines of code

163

increased by3.82%

Number of lines in readme file

88

increased by2833.33%

No dependency changes