@dsb-norge/vue-keycloak-js - npm Package Compare versions

Comparing version 1.2.0 to 1.3.0

package.json

 {
   "name": "@dsb-norge/vue-keycloak-js",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "author": "Nils Lien <[e-mail]>",
@@ -5,0 +5,0 @@ "description": "A Keycloak plugin for Vue >= 2.x",

README.md

@@ -60,5 +60,5 @@ vue-keycloak plugin
 The plugin adds a `$keycloak` property to the global Vue instance.
-This is actually a new Vue instance and can be used as such.
-It shadows most of the keycloak instance's properties and functions,
-with the exception of the callback events, which the plugin needs to control itself.
+This is actually a [Vue.observable](https://vuejs.org/v2/api/#Vue-observable) instance and can be used as such.
+It shadows most of the keycloak instance's properties and functions. All other variables & functions can be found
+on `$keycloak.keycloak` attribute
 
@@ -98,2 +98,3 @@ These properties/functions are exposed:
   tokenParsed: String          // The parsed token as a JavaScript object
+  keycloak: Object             // The original keycloak instance 'as is' from keycloak-js adapter
 }
@@ -132,3 +133,3 @@ ```
 Thereafter, the config object, either returned from an endpoint (string) or
-set directly (object), must be compatible with the Keycloak JS adapter constructor arguments.
+set directly (object), must be compatible with the [Keycloak JS adapter](https://www.keycloak.org/docs/latest/securing_apps/#_javascript_adapter) constructor arguments.
 
@@ -278,2 +279,4 @@ The `logoutRedirectUri` must instead be defined in [`options.logout`](#logout)
 
+
+##### To avoid waiting for configuration endpoint before loading vue app:
 ```javascript
@@ -283,2 +286,15 @@ Vue.use(VueKeyCloak, {
     onLoad: 'check-sso'
+  }
+})
+
+new Vue({
+  render: h => h(App)
+}).$mount('#app')
+```
+
+##### Wait until keycloak adapter is ready before loading vue app:
+```javascript
+Vue.use(VueKeyCloak, {
+  init: {
+    onLoad: 'check-sso'
   },
@@ -285,0 +301,0 @@ onReady: kc => {

New alerts

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

347

increased by4.83%

Worsened metrics

Total package byte prevSize

13121

decreased by-95.73%

Number of package files

3

decreased by-50%

Lines of code

0

decreased by-100%

Number of medium supply chain risk alerts

2

increased byInfinity%

No dependency changes