Interface: ScopedNextRbac<T, G>
Defined in: packages/next/src/server.ts:154
The helpers of createNextRbac() when the engine has per-guard names (RbacTypeConfig['guards']): like NextRbac, but G is the guard of the checks (the guard option of createNextRbac(), else the default guard), and a call's { guard } takes the names of that guard instead: can('orders.read', { guard: 'api' }).
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends RbacTypeConfig | - |
G extends string | DefaultGuardName<T> |
Properties
| Property | Type | Defined in |
|---|---|---|
rbac | Rbac<T> | packages/next/src/server.ts:155 |
Methods
authorize()
authorize<Q, G2>(requirement, scope?): Promise<AuthorizeResult>;Defined in: packages/next/src/server.ts:158
Non-throwing check: who is the user and do they meet the requirement?
Type Parameters
| Type Parameter | Default type |
|---|---|
Q extends Requirement | - |
G2 extends string | G |
Parameters
| Parameter | Type |
|---|---|
requirement | Q & CheckRequirement<Q, T, G2> |
scope? | ScopeOptions<CheckGuard<T, G2>> |
Returns
Promise<AuthorizeResult>
can()
can<G2>(permission, scope?): Promise<boolean>;Defined in: packages/next/src/server.ts:164
Type Parameters
| Type Parameter | Default type |
|---|---|
G2 extends string | G |
Parameters
| Parameter | Type |
|---|---|
permission | PermissionName<T, G2> |
scope? | ScopeOptions<CheckGuard<T, G2>> |
Returns
Promise<boolean>
canAll()
canAll<G2>(permissions, scope?): Promise<boolean>;Defined in: packages/next/src/server.ts:166
Type Parameters
| Type Parameter | Default type |
|---|---|
G2 extends string | G |
Parameters
| Parameter | Type |
|---|---|
permissions | Many<PermissionName<T, G2>> |
scope? | ScopeOptions<CheckGuard<T, G2>> |
Returns
Promise<boolean>
canAny()
canAny<G2>(permissions, scope?): Promise<boolean>;Defined in: packages/next/src/server.ts:165
Type Parameters
| Type Parameter | Default type |
|---|---|
G2 extends string | G |
Parameters
| Parameter | Type |
|---|---|
permissions | Many<PermissionName<T, G2>> |
scope? | ScopeOptions<CheckGuard<T, G2>> |
Returns
Promise<boolean>
getSnapshot()
getSnapshot(scope?): Promise<RbacSnapshot>;Defined in: packages/next/src/server.ts:163
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:156
Returns
Promise<Subject | null>
hasAllRoles()
hasAllRoles<G2>(roles, scope?): Promise<boolean>;Defined in: packages/next/src/server.ts:169
Type Parameters
| Type Parameter | Default type |
|---|---|
G2 extends string | G |
Parameters
| Parameter | Type |
|---|---|
roles | Many<RoleName<T, G2>> |
scope? | ScopeOptions<CheckGuard<T, G2>> |
Returns
Promise<boolean>
hasRole()
hasRole<G2>(role, scope?): Promise<boolean>;Defined in: packages/next/src/server.ts:168
true if the user has the role — or ANY of the roles when given an array.
Type Parameters
| Type Parameter | Default type |
|---|---|
G2 extends string | G |
Parameters
| Parameter | Type |
|---|---|
role | Many<RoleName<T, G2>> |
scope? | ScopeOptions<CheckGuard<T, G2>> |
Returns
Promise<boolean>
requirePermission()
requirePermission<S, G2>(permission, opts?): Promise<Subject>;Defined in: packages/next/src/server.ts:174
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 | Default type |
|---|---|
S extends Many<string> | - |
G2 extends string | G |
Parameters
| Parameter | Type |
|---|---|
permission | S & CheckNames<S, PermissionName<T, G2>> |
opts? | RequireOptions<CheckGuard<T, G2>> |
Returns
Promise<Subject>
requireRole()
requireRole<S, G2>(role, opts?): Promise<Subject>;Defined in: packages/next/src/server.ts:179
Ensures the user has the role (or ANY of the roles). Returns the subject.
Type Parameters
| Type Parameter | Default type |
|---|---|
S extends Many<string> | - |
G2 extends string | G |
Parameters
| Parameter | Type |
|---|---|
role | S & CheckNames<S, RoleName<T, G2>> |
opts? | RequireOptions<CheckGuard<T, G2>> |
Returns
Promise<Subject>
requireRoleOrPermission()
requireRoleOrPermission<S, G2>(items, opts?): Promise<Subject>;Defined in: packages/next/src/server.ts:184
Ensures the user has ANY of the given roles or permissions. Returns the subject.
Type Parameters
| Type Parameter | Default type |
|---|---|
S extends Many<string> | - |
G2 extends string | G |
Parameters
| Parameter | Type |
|---|---|
items | S & CheckNames<S, PermissionName<T, G2> | RoleName<T, G2>> |
opts? | RequireOptions<CheckGuard<T, G2>> |
Returns
Promise<Subject>
withPermission()
withPermission<S, Args, R, G2>(
permission,
action,
scope?
): (...args) => Promise<R>;Defined in: packages/next/src/server.ts:189
Wraps a server action; throws RbacUnauthorizedError unless the user has the permission (or ANY of them).
Type Parameters
| Type Parameter | Default type |
|---|---|
S extends Many<string> | - |
Args extends unknown[] | - |
R | - |
G2 extends string | G |
Parameters
| Parameter | Type |
|---|---|
permission | S & CheckNames<S, PermissionName<T, G2>> |
action | (...args) => MaybePromise<R> |
scope? | ScopeOptions<CheckGuard<T, G2>> |
Returns
(...args) => Promise<R>
withRbac()
withRbac<Args, O>(handler, options): (...args) => Promise<Response>;Defined in: packages/next/src/server.ts:204
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, OptionsGuard<O, G>> |
Returns
(...args) => Promise<Response>
withRole()
withRole<S, Args, R, G2>(
role,
action,
scope?
): (...args) => Promise<R>;Defined in: packages/next/src/server.ts:195
Wraps a server action; throws RbacUnauthorizedError unless the user has the role (or ANY of them).
Type Parameters
| Type Parameter | Default type |
|---|---|
S extends Many<string> | - |
Args extends unknown[] | - |
R | - |
G2 extends string | G |
Parameters
| Parameter | Type |
|---|---|
role | S & CheckNames<S, RoleName<T, G2>> |
action | (...args) => MaybePromise<R> |
scope? | ScopeOptions<CheckGuard<T, G2>> |
Returns
(...args) => Promise<R>
