spoonx / aurelia-acl

Permission plugin that works with aurelia-auth.

Archived

It was fun while it lasted, but we have to stop maintaining these repositories. We haven't used these projects for quite some time and maintaining them is becoming harder to do.

You deserve better, and for that reason we've decided to archive some repositories, which includes this one.

Feel free to fork and alter the repositories, and go forth making awesome stuff.

aurelia-acl

ACL for your aurelia application.

Simple and small. Set permissions, and then use the provided tools to verify them.

Installation

Jspm

Run jspm i aurelia-acl from your project root.

And add following to the bundles.dist.aurelia.includes section of build/bundles.js:

  "aurelia-acl"

If the installation results in having forks, try resolving them by running:

jspm inspect --forks
jspm resolve --only registry:package-name@version

Configuration

The most basic way to configure your permissions is by passing them as an object literal. More configuration options can be found on the documentation;

aurelia.use
   .plugin('aurelia-acl', {
     chat: ['read', 'post'],
     statistics: true // grants access to all statistics
   });

Usage

<template>
  <chatbox allowed="{chat: 'read'}"></chatbox>
</template>

The chatbox is only visible when acl is granted for chat.read.

Documentation

You can find detailed documentation, including installation instructions over at the aurelia-acl documentation.

The changelog provides you with information about important changes made over releases.

Contributing

Report bugs, request features, send pull requests for fixes and features and read the CONTRIBUTING.md

License

MIT

aurelia-acl's Issues

Update readme + book

The readme is old and says nothing. It also needs a book.

consider BindingSignaler

like SpoonX/aurelia-authentication#202

if.bind="myPara | signal:'acl-changed'"
aka the bind will be checked when acl changes

consider EventAggregator

Publishing an event when acl changes

import {inject} from 'aurelia-framework';
import {EventAggregator} from 'aurelia-event-aggregator';

@inject(EventAggregator)
export class App {
   constructor(eventAggregator) {
      this.eventAggregator = eventAggregator;
   }

   publish(){
      var payload = 'Lost privilege xy.';
      this.eventAggregator.publish('acl-changed', payload);
   }

   subscribe() {
      this.subscriber = this.eventAggregator.subscribe('myEventName', payload => {
         console.log(payload);
      });
   }

   dispose() {
      this.subscriber.dispose();
      console.log('Disposed!!!');
   }
}

Enable travis CI

It makes sense to CI this project. It is relatively easy to test and already has tests and a travis.yml file. @RWOverdijk