heimdall-guard v1.1.0

Heimdall Guard

A simple authorization module based on Attribute-based access control (ABAC). Inspired by blitz-guard.

import { GuardBuilder } from 'heimdall-guard';

type MyCtx = { roles: string[] }
type CustomResources = 'blog-post';
type CustomActions = 'archive';

const { can } = GuardBuilder<CustomResources, CustomActions, MyCtx>((ctx, { can }) => {
  if (ctx.roles.include('user')) {
    can('archive', 'blog-post');
  }

  if (ctx.roles.include('admin')) {
    can('delete', 'blog-post');
  }
})

false === can('delete', 'blog-post', { roles: ["user"] })
true === can('delete', 'blog-post', { roles: ["admin"] })

true === can('delete', 'blog-post', { roles: ["admin", "user"] })
true === can('archive', 'blog-post', { roles: ["admin", "user"] })