Skip to content

Interface: NextRbac<T> ​

Defined in: packages/next/src/server.ts:96

The helpers returned by createNextRbac(). T comes from the rbac instance: with typed names, every name (including each part of a 'a|b' list) must be one of them; untyped, any string is accepted.

Type Parameters ​

Type ParameterDefault type
T extends RbacTypeConfigDefaultRbacTypes

Properties ​

PropertyTypeDefined in
rbacRbac<T>packages/next/src/server.ts:97

Methods ​

authorize() ​

ts
authorize<Q>(requirement, scope?): Promise<AuthorizeResult>;

Defined in: packages/next/src/server.ts:100

Non-throwing check: who is the user and do they meet the requirement?

Type Parameters ​

Type Parameter
Q extends Requirement

Parameters ​

ParameterType
requirementQ & CheckRequirement<Q, T, DefaultGuardName<T>>
scope?ScopeOptions<string>

Returns ​

Promise<AuthorizeResult>


can() ​

ts
can(permission, scope?): Promise<boolean>;

Defined in: packages/next/src/server.ts:106

Parameters ​

ParameterType
permissionPermissionName<T>
scope?ScopeOptions<string>

Returns ​

Promise<boolean>


canAll() ​

ts
canAll(permissions, scope?): Promise<boolean>;

Defined in: packages/next/src/server.ts:108

Parameters ​

ParameterType
permissionsMany<PermissionName<T>>
scope?ScopeOptions<string>

Returns ​

Promise<boolean>


canAny() ​

ts
canAny(permissions, scope?): Promise<boolean>;

Defined in: packages/next/src/server.ts:107

Parameters ​

ParameterType
permissionsMany<PermissionName<T>>
scope?ScopeOptions<string>

Returns ​

Promise<boolean>


getSnapshot() ​

ts
getSnapshot(scope?): Promise<RbacSnapshot>;

Defined in: packages/next/src/server.ts:105

Roles & permissions of the current user — pass to <RbacProvider snapshot={...}>. Guests get an empty snapshot.

Parameters ​

ParameterType
scope?ScopeOptions<string>

Returns ​

Promise<RbacSnapshot>


getSubject() ​

ts
getSubject(): Promise<Subject | null>;

Defined in: packages/next/src/server.ts:98

Returns ​

Promise<Subject | null>


hasAllRoles() ​

ts
hasAllRoles(roles, scope?): Promise<boolean>;

Defined in: packages/next/src/server.ts:111

Parameters ​

ParameterType
rolesMany<RoleName<T>>
scope?ScopeOptions<string>

Returns ​

Promise<boolean>


hasRole() ​

ts
hasRole(role, scope?): Promise<boolean>;

Defined in: packages/next/src/server.ts:110

true if the user has the role — or ANY of the roles when given an array.

Parameters ​

ParameterType
roleMany<RoleName<T>>
scope?ScopeOptions<string>

Returns ​

Promise<boolean>


requirePermission() ​

ts
requirePermission<S>(permission, opts?): Promise<Subject>;

Defined in: packages/next/src/server.ts:116

Ensures the user has the permission (or ANY of the permissions). Returns the subject. Guests: redirect(loginUrl) or notFound(). Missing permission: notFound(). Both configurable.

Type Parameters ​

Type Parameter
S extends Many<string>

Parameters ​

ParameterType
permissionS & CheckNames<S, PermissionName<T>>
opts?RequireOptions<string>

Returns ​

Promise<Subject>


requireRole() ​

ts
requireRole<S>(role, opts?): Promise<Subject>;

Defined in: packages/next/src/server.ts:121

Ensures the user has the role (or ANY of the roles). Returns the subject.

Type Parameters ​

Type Parameter
S extends Many<string>

Parameters ​

ParameterType
roleS & CheckNames<S, RoleName<T>>
opts?RequireOptions<string>

Returns ​

Promise<Subject>


requireRoleOrPermission() ​

ts
requireRoleOrPermission<S>(items, opts?): Promise<Subject>;

Defined in: packages/next/src/server.ts:123

Ensures the user has ANY of the given roles or permissions. Returns the subject.

Type Parameters ​

Type Parameter
S extends Many<string>

Parameters ​

ParameterType
itemsS & CheckNames<S, PermissionName<T> | RoleName<T>>
opts?RequireOptions<string>

Returns ​

Promise<Subject>


withPermission() ​

ts
withPermission<S, Args, R>(
   permission, 
   action, 
   scope?
): (...args) => Promise<R>;

Defined in: packages/next/src/server.ts:128

Wraps a server action; throws RbacUnauthorizedError unless the user has the permission (or ANY of them).

Type Parameters ​

Type Parameter
S extends Many<string>
Args extends unknown[]
R

Parameters ​

ParameterType
permissionS & CheckNames<S, PermissionName<T>>
action(...args) => MaybePromise<R>
scope?ScopeOptions<string>

Returns ​

(...args) => Promise<R>


withRbac() ​

ts
withRbac<Args, O>(handler, options): (...args) => Promise<Response>;

Defined in: packages/next/src/server.ts:143

Wraps a route handler. Responds 401 (guest) or 403 (missing role/permission) with a JSON body. Mirrors spatie's permission, role and role_or_permission middleware.

Type Parameters ​

Type Parameter
Args extends unknown[]
O extends WithRbacOptions

Parameters ​

ParameterType
handler(...args) => MaybePromise<Response>
optionsO & CheckRequirement<O, T, DefaultGuardName<T>>

Returns ​

(...args) => Promise<Response>


withRole() ​

ts
withRole<S, Args, R>(
   role, 
   action, 
   scope?
): (...args) => Promise<R>;

Defined in: packages/next/src/server.ts:134

Wraps a server action; throws RbacUnauthorizedError unless the user has the role (or ANY of them).

Type Parameters ​

Type Parameter
S extends Many<string>
Args extends unknown[]
R

Parameters ​

ParameterType
roleS & CheckNames<S, RoleName<T>>
action(...args) => MaybePromise<R>
scope?ScopeOptions<string>

Returns ​

(...args) => Promise<R>

Released under the MIT License. Inspired by spatie/laravel-permission.