# aurelia-acl

> An ACL plugin to use with aurelia.

Latest version **1.0.0** (published 2017-06-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install aurelia-acl
pnpm add aurelia-acl
yarn add aurelia-acl
bun add aurelia-acl
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-06-01 |
| First published | 2016-06-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | SpoonX |
| Maintainers | rwoverdijk |
| Keywords | aurelia, acl, permission, permissions, spoonx, auth, authentication |

## Links

- npm: https://www.npmjs.com/package/aurelia-acl
- Repository: https://github.com/SpoonX/aurelia-acl
- Homepage: https://github.com/SpoonX/aurelia-acl#readme
- Issues: https://github.com/SpoonX/aurelia-acl/issues
- npm.io page: https://npm.io/package/aurelia-acl

## Dependencies (4)

- [aurelia-pal](https://npm.io/package/aurelia-pal.md) ^1.0.0
- [aurelia-logging](https://npm.io/package/aurelia-logging.md) ^1.0.0
- [aurelia-templating](https://npm.io/package/aurelia-templating.md) ^1.0.0
- [aurelia-dependency-injection](https://npm.io/package/aurelia-dependency-injection.md) ^1.2.0

## Alternatives

- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads
- [escher-request](https://npm.io/package/escher-request.md) — 545 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2017-06-01
- 0.0.2 — 2016-10-28
- 0.0.1 — 2016-06-25

## README

# aurelia-acl

[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg?maxAge=2592000?style=plastic)](https://gitter.im/SpoonX/Dev)

> 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`:

```js
  "aurelia-acl"
```

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

```sh
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](./configure.md);


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

## Usage

```html
<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](http://aurelia-acl.spoonx.org/).

The [changelog](https://aurelia-acl.spoonx.org/CHANGELOG.html) 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](./CONTRIBUTING.md)

## License

MIT

---
_Source: https://npm.io/package/aurelia-acl · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._