Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Bagaar/ember-permissions
Permission management for Ember applications.
https://github.com/Bagaar/ember-permissions
ember-addon permissions
Last synced: 3 months ago
JSON representation
Permission management for Ember applications.
- Host: GitHub
- URL: https://github.com/Bagaar/ember-permissions
- Owner: Bagaar
- License: mit
- Created: 2019-01-29T17:29:31.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-03-06T15:30:23.000Z (8 months ago)
- Last Synced: 2024-07-30T03:43:19.872Z (4 months ago)
- Topics: ember-addon, permissions
- Language: TypeScript
- Homepage:
- Size: 2.15 MB
- Stars: 14
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-ember - ember-permissions - Permission management for Ember applications. (Packages / Security)
README
# @bagaar/ember-permissions
[](https://github.com/bagaar/ember-permissions/actions?query=workflow%3ACI)
[](https://badge.fury.io/js/%40bagaar%2Fember-permissions)
Permission management for Ember applications.
## Table of Contents
- [Introduction](#introduction)
- [Compatibility](#compatibility)
- [Installation](#installation)
- [Usage](#usage)
- [Public API](#public-api)
- [`permissions` Service](#permissions-service)
- [`setPermissions`](#setpermissions)
- [`setRoutePermissions`](#setroutepermissions)
- [`hasPermissions`](#haspermissions)
- [`hasSomePermissions`](#hassomepermissions)
- [`canAccessRoute`](#canaccessroute)
- [`enableRouteValidation`](#enableroutevalidation)
- [`addRouteAccessDeniedHandler`](#addrouteaccessdeniedhandler)
- [`removeRouteAccessDeniedHandler`](#removerouteaccessdeniedhandler)
- [Helpers](#helpers)
- [`has-permissions`](#has-permissions)
- [`has-some-permissions`](#has-some-permissions)
- [`can-access-route`](#can-access-route)
- [Contributing](#contributing)
- [License](#license)
## Introduction
`@bagaar/ember-permissions` is an addon that allows you to **manage and validate permissions** for the current session. It also allows you to **define required permissions per route** so you can protect specific parts of your application. Instead of using a mixin to protect your routes, the addon allows you to define the required permissions per route in a single file. Specific handlers can be added to determine what needs to happen when a transition occurs that is denied.
## Compatibility
- Ember.js v4.8 or above
- Embroider or ember-auto-import v2
## Installation
```shell
npm install -D @bagaar/ember-permissions
```
```shell
pnpm add -D @bagaar/ember-permissions
```
```shell
yarn add -D @bagaar/ember-permissions
```
## Usage
### 1\. Setting up Session Permissions
First, we need to let the `permissions` service know which permissions are available for the current session. In the example below, we're using an additional `api` service to request the permissions from an API. Afterwards, we pass along the permissions to the `permissions` service via the [`setPermissions`](#setpermissions) method.
```javascript
// app/routes/protected.js
import Route from '@ember/routing/route';
import { service } from '@ember/service';
export default class ProtectedRoute extends Route {
@service('api') apiService;
@service('permissions') permissionsService;
async beforeModel() {
const permissions = await this.apiService.request('/permissions');
this.permissionsService.setPermissions(permissions);
}
}
```
Once the permissions are set, we can start checking their presence. In the example below, we use the [`has-permissions`](#has-permissions) helper to conditionally render a delete button based on the presence of the `delete-users` permission.
```handlebars
{{! app/templates/users/index.hbs }}
{{#if (has-permissions "delete-users")}}
Delete User
{{/if}}
```
> **NOTE:** If you need to validate permissions inside a JavaScript file, you can use the [`hasPermissions`](#haspermissions) or the [`hasSomePermissions`](#hassomepermissions) method on the `permissions` service instead.
### 2\. Setting up Route Permissions
Start off with defining the required permissions per route. You're free to define them where you want, as long as the format is the same as shown below.
```javascript
// app/route-permissions.js
export default {
'users.index': ['view-users'],
'users.create': ['create-users'],
'users.edit': ['edit-users'],
};
```
Next, edit the `protected` route from step 1 as follows:
1. Use the [`setRoutePermissions`](#setroutepermissions) method to pass along the required permissions per route to the `permissions` service
2. Add a route-access-denied handler to determine what needs to happen when a transition occurs that is denied
3. Call [`enableRouteValidation`](#enableroutevalidation) with the initial transition
```javascript
// app/routes/protected.js
import { registerDestructor } from '@ember/destroyable';
import Route from '@ember/routing/route';
import { service } from '@ember/service';
import ROUTE_PERMISSIONS from 'app-name/route-permissions';
export default class ProtectedRoute extends Route {
@service('api') apiService;
@service('permissions') permissionsService;
@service('router') routerService;
async beforeModel(transition) {
const permissions = await this.apiService.request('/permissions');
this.permissionsService.setPermissions(permissions);
this.permissionsService.setRoutePermissions(ROUTE_PERMISSIONS);
const handler = (/* deniedTransition */) => {
// Handle the denied transition.
// E.g. redirect to a generic error route:
this.routerService.replaceWith('error', { error: 'access-denied' });
};
this.permissionsService.addRouteAccessDeniedHandler(handler);
registerDestructor(this, () => {
this.permissionsService.removeRouteAccessDeniedHandler(handler);
});
this.permissionsService.enableRouteValidation(transition);
}
}
```
Now, each transition will be validated (including the provided initial transition) against the required permissions per route. If a transition is denied, the added route-access-denied handler will be called with the denied transition.
Since the required permissions per route are now set, we can start checking if routes can be accessed. In the example below, we use the [`can-access-route`](#can-access-route) helper to do so.
```handlebars
{{! app/components/menu.hbs }}
{{#if (can-access-route "users.index")}}
Users
{{/if}}
```
> **NOTE:** If you need to validate if a route can be accessed inside a JavaScript file, you can use the [`canAccessRoute`](#canaccessroute) method on the `permissions` service instead.
## Public API
### `permissions` Service
#### Methods
##### `setPermissions`
Set the permissions for the current session.
###### Arguments
An array of permissions.
###### Returns
/
###### Example
```javascript
permissionsService.setPermissions([
'view-users',
'create-users',
'edit-users',
]);
```
##### `setRoutePermissions`
Set the required permissions per route.
###### Arguments
An object of which the keys are route names and the values are arrays of required permissions.
###### Returns
/
###### Example
```javascript
permissionsService.setRoutePermissions({
'users.index': ['view-users'],
'users.create': ['create-users'],
'users.edit': ['edit-users'],
});
```
##### `hasPermissions`
Check if all the provided permissions are available for the current session.
###### Arguments
An array of permissions.
###### Returns
Returns `true` if all the provided permissions are available for the current session, `false` if otherwise.
###### Example
```javascript
permissionsService.hasPermissions([
'view-users',
'create-users',
'edit-users',
]);
```
##### `hasSomePermissions`
Check if some of the provided permissions are available for the current session.
###### Arguments
An array of permissions.
###### Returns
Returns `true` if some of the provided permissions are available for the current session, `false` if otherwise.
###### Example
```javascript
permissionsService.hasSomePermissions([
'view-users',
'create-users',
'edit-users',
]);
```
##### `canAccessRoute`
Check if the provided route can be accessed.
###### Arguments
A route's name.
###### Returns
Returns `true` if the provided route can be accessed, `false` if otherwise.
###### Example
```javascript
permissionsService.canAccessRoute('users.index');
```
##### `enableRouteValidation`
Tell the `permissions` service that it should start validating each transition (including the provided initial transition) and confirm that it's allowed based on the required permissions per route. If a transition is denied, all added route-access-denied handlers will be called with the denied transtion.
###### Arguments
The initial transition.
###### Returns
/
###### Example
```javascript
permissionsService.enableRouteValidation(transition);
```
##### `addRouteAccessDeniedHandler`
Add a route-access-denied handler.
###### Arguments
A handler.
###### Returns
/
###### Example
```javascript
const handler = (/* deniedTransition */) => {
// Handle the denied transition.
// E.g. redirect to a generic error route:
this.routerService.replaceWith('error', { error: 'access-denied' });
};
this.permissionsService.addRouteAccessDeniedHandler(handler);
```
##### `removeRouteAccessDeniedHandler`
Remove a previously added route-access-denied handler.
###### Arguments
A handler.
###### Returns
/
###### Example
```javascript
const handler = (/* deniedTransition */) => {
// Handle the denied transition.
// E.g. redirect to a generic error route:
this.routerService.replaceWith('error', { error: 'access-denied' });
};
this.permissionsService.removeRouteAccessDeniedHandler(handler);
```
### Helpers
#### `has-permissions`
Check if all the provided permissions are available for the current session.
###### Arguments
Separate permissions.
###### Returns
Returns `true` if all the provided permissions are available for the current session, `false` if otherwise.
###### Example
```handlebars
{{has-permissions "view-users" "create-users" "edit-users"}}
```
#### `has-some-permissions`
Check if some of the provided permissions are available for the current session.
###### Arguments
Separate permissions.
###### Returns
Returns `true` if some of the provided permissions are available for the current session, `false` if otherwise.
###### Example
```handlebars
{{has-some-permissions "view-users" "create-users" "edit-users"}}
```
#### `can-access-route`
Check if the provided route can be accessed.
###### Arguments
A route's name.
###### Returns
Returns `true` if the provided route can be accessed, `false` if otherwise.
###### Example
```handlebars
{{can-access-route "users.index"}}
```
## Contributing
See the [Contributing](CONTRIBUTING.md) guide for details.
## License
This project is licensed under the [MIT License](LICENSE.md).