@mydoma/myd-permissions v3.1.0

What is this repository for?

• This repository is a permission checker for MyDoma applications.

How do I get set up?

install

npm i @mydoma/myd-permissions

include

const myd-permissions = require('@mydoma/myd-permissions')

Three functions are exposed.

codes

myd-permissions.codes(permission)

returns a value from this set of codes

{  
    readOnly: 1,
    readWrite: 3,
    create: 7,
    superUser: 'SuperUser',
    client: 'Client',
    specialUser: 'SpecialUser'
}

check

permissions.check({userId, permissions: [{ type, required }]})

Checks whether the userId specified has at least one of the permissions required and returns a boolean value. example:

let permitted = myd-permissions.check({userId: '12345',
                 permissions: [{ type: 'prd', 
                 required: myd-permissions.codes.create }]
               })

sentry

A wrapper function for check. It takes exactly the same parameters as check, but throws {code: 403} when no matching permissions are found.

map

myd-permissions.map(permission)

Deprecated - a legacy function that converts some older permission values to the standard ones found in the MyDoma database.

Who do I talk to?

• colleen@mydomastudio.com