# nestjs-role-protected

> Protect GraphQL resolvers with rbac

Latest version **0.2.1** (published 2020-07-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install nestjs-role-protected
pnpm add nestjs-role-protected
yarn add nestjs-role-protected
bun add nestjs-role-protected
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2020-07-15 |
| First published | 2020-01-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 10 |
| Unpacked size | 162 KB |
| Known vulnerabilities | 0 (+4 in 3 direct dependencies) |
| Install scripts | no |
| Author | Rokket Labs |
| Maintainers | rokket |

## Links

- npm: https://www.npmjs.com/package/nestjs-role-protected
- npm.io page: https://npm.io/package/nestjs-role-protected

## Dependencies (10)

- [rxjs](https://npm.io/package/rxjs.md) ^6.6.0
- [passport](https://npm.io/package/passport.md) ^0.4.1
- [@nestjs/jwt](https://npm.io/package/@nestjs/jwt.md) ^7.1.0
- [@nestjs/core](https://npm.io/package/@nestjs/core.md) ^7.3.2
- [passport-jwt](https://npm.io/package/passport-jwt.md) ^4.0.0
- [accesscontrol](https://npm.io/package/accesscontrol.md) ^2.2.1
- [@nestjs/common](https://npm.io/package/@nestjs/common.md) ^7.3.2
- [@nestjs/graphql](https://npm.io/package/@nestjs/graphql.md) ^7.5.5
- [@nestjs/passport](https://npm.io/package/@nestjs/passport.md) ^7.1.0
- [nest-access-control](https://npm.io/package/nest-access-control.md) ^2.0.2

## Recent versions

- 0.2.1 (latest) — 2020-07-15
- 0.2.0 — 2020-07-14
- 0.1.3-alpha2 — 2020-02-03
- 0.1.3-alpha — 2020-02-03
- 0.1.3 — 2020-02-03
- 0.1.1 — 2020-01-31
- 0.1.0 — 2020-01-31

## README

# Nest role protected

## Usage

First define your roles and permissions

```typescript
import { RolesBuilder } from 'nestjs-role-protected'

export enum Roles {
  USER = 'USER',
  ADMIN = 'ADMIN',
  GUEST = 'GUEST',
}

const rolesPermissions = {
  [Roles.ADMIN]: {
    Order: {
      'create:any': ['*'],
      'read:any': ['*'],
      'update:any': ['*'],
      'delete:any': ['*'],
    },
  },
  [Roles.USER]: {
    Order: {
      'create:own': ['*'],
      'read:own': ['*'],
      'delete:own': ['*'],
      'update:own': ['*'],
    },
  },
}

export const roles = new RolesBuilder(rolesPermissions)
```

then add the roles to the app module

```typescript
import { Module } from '@nestjs/common'
import { AccessControlModule } from 'nestjs-role-protected'

import { roles } from './app.roles'

@Module({
  imports: [
    /* ... many modules ... */
    AccessControlModule.forRoles(roles),
  ],
  controllers: [
    /* your controllers /*]
  providers: [/* your providers */
  ],
})
export class AppModule {}
```

now you can the RoleProtected decorator to protect your resolver methods! 🔥

```typescript
/* ... imports ... */
import { RoleProtected } from 'nestjs-role-protected'

@Resolver(Order)
export class OrdersResolver {
  /* ... constructor and others methods ... */
  @RoleProtected({
    action: 'update',
  })
  @Mutation(() => Order)
  async updateOrder(
    @Args('id') id: string,
    @Args('input') input: OrderUpdate,
    @CurrentUser() user: User,
  ): Promise<Order> {
    return this.ordersService.update(id, user, input)
  }
}
```

ok but what about ownership? you'll need to check if user is owner of the document BUT if he has permission to update any then you don't need to check that

```typescript
/* ... imports ... */
import { RoleProtected, CanDoAny } from 'nestjs-role-protected'

@Resolver(Order)
export class OrdersResolver {
  /* ...constructor and others methods ... */
  @RoleProtected({
    action: 'update',
  })
  @Mutation(() => Order)
  async updateOrder(
    @Args('id') id: string,
    @Args('input') input: OrderUpdate,
    @CurrentUser() user: User,
    @CanDoAny() canDoAny: () => boolean,
  ): Promise<Order> {
    return this.ordersService.update(id, user, input, canDoAny())
  }
}
```

and now you can use different methods in your service depending on your permission
e.g.:

```typescript

  async update(
    id: string,
    user: User,
    item: OrderUpdate,
    canDoAny: boolean,
  ): Promise<Order> {
    if (canDoAny) return await this.orderModel.findByIdAndUpdate(id, item, { new: true })

    return await this.orderModel.findOneAndUpdate({ id, user: user.id }, item, {
      new: true,
    })
```

---
_Source: https://npm.io/package/nestjs-role-protected · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
