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 Parameter | Default type |
|---|---|
T extends RbacTypeConfig | DefaultRbacTypes |
Properties
| Property | Type | Defined in |
|---|---|---|
rbac | Rbac<T> | packages/next/src/server.ts:97 |
Methods
authorize()
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
| Parameter | Type |
|---|---|
requirement | Q & CheckRequirement<Q, T, DefaultGuardName<T>> |
scope? | ScopeOptions<string> |
Returns
Promise<AuthorizeResult>
can()
can(permission, scope?): Promise<boolean>;Defined in: packages/next/src/server.ts:106
Parameters
| Parameter | Type |
|---|---|
permission | PermissionName<T> |
scope? | ScopeOptions<string> |
Returns
Promise<boolean>
canAll()
canAll(permissions, scope?): Promise<boolean>;Defined in: packages/next/src/server.ts:108
Parameters
| Parameter | Type |
|---|---|
permissions | Many<PermissionName<T>> |
scope? | ScopeOptions<string> |
Returns
Promise<boolean>
canAny()
canAny(permissions, scope?): Promise<boolean>;Defined in: packages/next/src/server.ts:107
Parameters
| Parameter | Type |
|---|---|
permissions | Many<PermissionName<T>> |
scope? | ScopeOptions<string> |
Returns
Promise<boolean>
getSnapshot()
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
| Parameter | Type |
|---|---|
scope? | ScopeOptions<string> |
Returns
Promise<RbacSnapshot>
getSubject()
getSubject(): Promise<Subject | null>;Defined in: packages/next/src/server.ts:98
Returns
Promise<Subject | null>
hasAllRoles()
hasAllRoles(roles, scope?): Promise<boolean>;Defined in: packages/next/src/server.ts:111
Parameters
| Parameter | Type |
|---|---|
roles | Many<RoleName<T>> |
scope? | ScopeOptions<string> |
Returns
Promise<boolean>
hasRole()
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
| Parameter | Type |
|---|---|
role | Many<RoleName<T>> |
scope? | ScopeOptions<string> |
Returns
Promise<boolean>
requirePermission()
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
| Parameter | Type |
|---|---|
permission | S & CheckNames<S, PermissionName<T>> |
opts? | RequireOptions<string> |
Returns
Promise<Subject>
requireRole()
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
| Parameter | Type |
|---|---|
role | S & CheckNames<S, RoleName<T>> |
opts? | RequireOptions<string> |
Returns
Promise<Subject>
requireRoleOrPermission()
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
| Parameter | Type |
|---|---|
items | S & CheckNames<S, PermissionName<T> | RoleName<T>> |
opts? | RequireOptions<string> |
Returns
Promise<Subject>
withPermission()
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
| Parameter | Type |
|---|---|
permission | S & CheckNames<S, PermissionName<T>> |
action | (...args) => MaybePromise<R> |
scope? | ScopeOptions<string> |
Returns
(...args) => Promise<R>
withRbac()
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
| Parameter | Type |
|---|---|
handler | (...args) => MaybePromise<Response> |
options | O & CheckRequirement<O, T, DefaultGuardName<T>> |
Returns
(...args) => Promise<Response>
withRole()
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
| Parameter | Type |
|---|---|
role | S & CheckNames<S, RoleName<T>> |
action | (...args) => MaybePromise<R> |
scope? | ScopeOptions<string> |
Returns
(...args) => Promise<R>
