Meteor-Community-Packages/meteor-roles

Add isInRole to JS API as well

Open

#56 opened on Sep 19, 2014

View on GitHub
 (17 comments) (0 reactions) (0 assignees)JavaScript (919 stars) (161 forks)batch import
enhancementgood first issuehelp wanted

Description

Something you frequently do in the application, is check if the current user is allowed to access something. As there currently is no shorthand for this in the Javascript API, you have to do something like:

if ( Roles.userIsInRole( Meteor.userId(), 'permission' ) )
    // ...

I noticed the UI helper offers a beautiful shortand syntax for this, using the currently logged in user. I think it would make a lot of sense to add this to the API as well, so that one can simply do:

if ( Roles.isInRole( 'permission' ) )
    // ...

or even better:

if ( Roles.has( 'permission' ) )
    // ...

Contributor guide

Tech stack
javascript
Domain
authenticationauthorization
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
understanding of Meteor roles APIbasic JavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
The issue requests a shorthand method `Roles.isInRole('permission')` or `Roles.has('permission')` in the JS API, similar to the existing UI helper. To implement, look at the UI helper code in roles client.js (lines 28-35) and the current Roles.userIsInRole function. Add a new method that calls Roles.userIsInRole with the current user ID obtained from Meteor.userId(). Ensure the method is exported and documented.