role-calc/README.md

library to work with roles, contains calculation of times for the session, validation of required roles

# role-calc

[![NPM version](https://badge.fury.io/js/role-calc.svg)](https://npmjs.org/package/role-calc) [![Build Status](https://travis-ci.org/kevoj/role-calc.svg?branch=master)](https://travis-ci.org/kevoj/role-calc) [![dependencies Status](https://david-dm.org/kevoj/role-calc/status.svg)](https://david-dm.org/kevoj/role-calc) [![devDependencies Status](https://david-dm.org/kevoj/role-calc/dev-status.svg)](https://david-dm.org/kevoj/role-calc?type=dev)
[![GitHub license](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](https://raw.githubusercontent.com/kevoj/role-calc/master/LICENSE)

> library to work with roles, contains calculation of times for the session, validation of required roles

This library is ideal for working with [redis-jwt](https://github.com/kevoj/redis-jwt)

## Installation

Npm

```bash
npm install role-calc --save
```

Yarn
```bash
yarn add role-calc
```

## Usage

### has

Evaluate if any of the required roles are met or all

```javascript

import {has} from 'role-calc';

// Roles required
let required = [
    'Developer',
    'Specialist',
    'Technician',
    'Director',
    'Manager',
    'Designer',
    'Analyst',
    'Administrator'
];

// Roles user
let candidates = [
    'Developer',
    'Administrator',
    'Designer'
];

// if it contains one
has(required, candidates);         // -> true
has(['Developer'], candidates);    // -> true
has(required, ['Other', 'Fake']);  // -> false

// must meet everyone '*'
has(required, candidates, '*');                   // -> false
has(['Developer', 'Designer'], candidates, '*');  // -> true
has(['Director'], ['Director', 'Other'], '*');    // -> true

```

### time

Gets the times of a list from an array of roles

```javascript

import {time} from 'role-calc';

// Roles with time
let roles = [
    {
        role: 'Developer',
        ttl: '15 minutes'
    },
    {
        role: 'Specialist',
        ttl: '2 hours'
    },
    {
        role: 'Manager',
        ttl: '3 days'
    },
    {
        role: 'Administrator',
        ttl: '1 years'
    },
    {
        role: 'Director',
        ttl: '90 minutes'
    },
    {
        role: 'Designer',
        ttl: '55 hours'
    },
    {
        role: 'other'
    }
];

// Roles user
let candidates = [
    'Developer',
    'Administrator',
    'Designer'
];

time(roles, candidates);
/*
->
[
  { role: 'Developer', ttl: '15 minutes' },
  { role: 'Administrator', ttl: '1 years' },
  { role: 'Designer', ttl: '55 hours' }
]
*/

```

### calc

Calculate time of multiple roles assigned to a user

```javascript

import {calc} from 'role-calc';

// Roles with time
let roles = [
    {
        role: 'Developer',
        ttl: '15 minutes'
    },
    {
        role: 'Specialist',
        ttl: '2 hours'
    },
    {
        role: 'Manager',
        ttl: '3 days'
    },
    {
        role: 'Administrator',
        ttl: '1 years'
    },
    {
        role: 'Director',
        ttl: '90 minutes'
    },
    {
        role: 'Designer',
        ttl: '55 hours'
    },
    {
        role: 'other'
    }
];

/*
time(roles, option, format)

- roles: array
- option: max, min, sum, average
- format(optional): milliseconds, seconds, minutes, hours, days, weeks, months, years
*/

calc(roles, 'sum'); // -> 533805 minutes
calc(roles, 'max', 'hours'); // -> 8766 hours
calc(roles, 'min', 'minutes'); // -> 15 minutes
calc(roles, 'average', 'days'); // -> 61.782986111111114 days

```

## Development

### Start

`npm start`

### Compile

`npm run compile`

### Test

`npm test`

## License

MIT © [Leonardo Rico](https://github.com/kevoj/role-calc/blob/master/LICENSE)