The Deadbolt JavaScript class constructor change.

CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.2.0] 2021-11-04
+### Changed
+- Slight breaking change in the JavaScript helper. The constructor will now only accept a permissions array or JSON encoded string.
+- You don't need to pass a whole user object into the `Deadbolt()` constructor.
+
 ## [2.1.0] 2021-09-01
 ### Added
 - Added a simple JavaScript library to aid in using permissions on the front-end (ESM).

README.md

@@ -401,7 +401,7 @@ class DatabaseDriver implements DriverInterface
 How the `permissions` method sources permissions is up to you. It could a database request, or even a remote API request.
 
 ## JavaScript Helper
-Deadbolt includes a simple JavaScript helper that provides some simple tools for checking permissions. You'll need to pass your User object to your front-end. You can import the `Deadbolt` class into your JavaScript component. If you're using Vue you could use it something like this:
+Deadbolt includes a simple JavaScript helper that provides some simple tools for checking permissions. You'll need to pass the user permissions to your front-end. You can import the `Deadbolt` class into your JavaScript component. If you're using Vue you could do something like this:
 
 ```javascript
 import Deadbolt from '../../vendor/thepublicgood/deadbolt/dist/Deadbolt';
@@ -412,7 +412,7 @@ export default {
   },
   setup (props) {
 
-    const permissions = new Deadbolt(props.user);
+    const permissions = new Deadbolt(props.user.permissions);
 
     // Check if the user has a permission
     permissions.has('articles.create');

src/js/Deadbolt.ts

@@ -1,14 +1,13 @@
-import {User} from '@/User';
-
 export default class Deadbolt {
 
     readonly _permissions: string[];
 
-    constructor(user: User, column: string = 'permissions') {
-        if (typeof user.permissions === 'string') {
-            this._permissions = JSON.parse(user[column]);
+    constructor(permissions: string|string[]) {
+
+        if (typeof permissions === 'string') {
+            this._permissions = JSON.parse(permissions);
         } else {
-            this._permissions = user[column];
+            this._permissions = permissions;
         }
     }
 

tests/js/deadbolt.test.js

@@ -10,7 +10,7 @@ const user = {
     ],
 }
 
-const permissions = new Deadbolt(user);
+const permissions = new Deadbolt(user.permissions);
 
 it('"has" should return true for an existing permission', () => {
     assert.equal(permissions.has('articles.create'), true);