Authorization Util

Simplistic authorization management - alternative to heavy (though much more robust) solutions. The core idea is that a user has already been authenticated (like having a JWT, for example), and we now need to effectively manage the authorization for whatever role they may have.

Most simply put, this is intended to allow an initial configuration of mapping authorizations to a set of roles that are available. The functionality is a very small subset of what you may get from something like CASL, but with a miniscul footprint and zero dependencies. If all you need are the very basics, this may suit your needs.

Getting going...

import AuthorizationService from ".";

/**
 * Role definitions somewhere on app initialization
 */
AuthorizationService.defineRole("admin", [
  "can_create_profile",
  "can_edit_profile",
  "can_view_profile",
]);
AuthorizationService.defineRole("employee", [
  "can_edit_profile",
  "can_view_profile",
]);
AuthorizationService.defineRole("customer", ["can_view_profile"]);

/**
 * Example usage:
 *
 * 1. The create button will only render for the admin role
 * 2. The edit button will only render for admin and employee roles
 * 3. The description will display for all three roles
 */
render(
  <>
    {AuthorizationService.userCan(currentRole, "can_create_profile") && (
      <Button>Create Profile</Button>
    )}

    {AuthorizationService.userCan(currentRole, "can_edit_profile") && (
      <Button>Edit Profile</Button>
    )}

    {AuthorizationService.userCan(currentRole, "can_view_profile") && (
      <p>A profile description...</p>
    )}
  </>
);

Test

npm run test

# we also have a ci specific test command that outputs coverage
npm run test-ci

Typescript

Typescript was introduced as of v1.2.0.