Class: DrizzleRbacAdapter
Defined in: packages/drizzle/src/adapter.ts:162
Dialect-agnostic Drizzle implementation of RbacAdapter. Use drizzlePgAdapter(), drizzleSqliteAdapter() or drizzleMysqlAdapter() to construct it.
Implements
RbacAdapter
Constructors
Constructor
new DrizzleRbacAdapter(
db,
t,
dialect?,
options?
): DrizzleRbacAdapter;Defined in: packages/drizzle/src/adapter.ts:166
Parameters
| Parameter | Type | Default value |
|---|---|---|
db | any | undefined |
t | RbacTables | undefined |
dialect? | DrizzleDialect | 'pg' |
options? | DrizzleAdapterOptions | {} |
Returns
DrizzleRbacAdapter
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
supportsExpiry | readonly | boolean | true with { expiry: true }: the engine may then pass expiresAt. | packages/drizzle/src/adapter.ts:164 |
Methods
attachRolePermissions()
attachRolePermissions(roleId, permissionIds): Promise<void>;Defined in: packages/drizzle/src/adapter.ts:319
Parameters
| Parameter | Type |
|---|---|
roleId | Id |
permissionIds | readonly Id[] |
Returns
Promise<void>
Implementation of
RbacAdapter.attachRolePermissions
attachSubjectPermissions()
attachSubjectPermissions(
subject,
permissionIds,
teamId,
options?
): Promise<void>;Defined in: packages/drizzle/src/adapter.ts:368
options is only passed with supportsExpiry: true; store its expiresAt on every given link.
Parameters
| Parameter | Type |
|---|---|
subject | Subject |
permissionIds | readonly Id[] |
teamId | TeamId |
options? | AttachLinkOptions |
Returns
Promise<void>
Implementation of
RbacAdapter.attachSubjectPermissions
attachSubjectRoles()
attachSubjectRoles(
subject,
roleIds,
teamId,
options?
): Promise<void>;Defined in: packages/drizzle/src/adapter.ts:351
options is only passed with supportsExpiry: true; store its expiresAt on every given link.
Parameters
| Parameter | Type |
|---|---|
subject | Subject |
roleIds | readonly Id[] |
teamId | TeamId |
options? | AttachLinkOptions |
Returns
Promise<void>
Implementation of
RbacAdapter.attachSubjectRoles
createPermission()
createPermission(data): Promise<Permission>;Defined in: packages/drizzle/src/adapter.ts:192
Parameters
| Parameter | Type |
|---|---|
data | { guardName: string; name: string; } |
data.guardName | string |
data.name | string |
Returns
Promise<Permission>
Implementation of
RbacAdapter.createPermission
createRole()
createRole(data): Promise<Role>;Defined in: packages/drizzle/src/adapter.ts:248
Parameters
| Parameter | Type |
|---|---|
data | { guardName: string; name: string; teamId: TeamId; } |
data.guardName | string |
data.name | string |
data.teamId | TeamId |
Returns
Promise<Role>
Implementation of
RbacAdapter.createRole
deleteExpiredLinks()
deleteExpiredLinks(now): Promise<DeletedLinkCounts>;Defined in: packages/drizzle/src/adapter.ts:428
Deletes every role and direct-permission link (any subject, team and guard) whose expiresAt is at or before now. Links without an expiry stay. Used by rbac.pruneExpired().
Parameters
| Parameter | Type |
|---|---|
now | Date |
Returns
Promise<DeletedLinkCounts>
Implementation of
RbacAdapter.deleteExpiredLinks
deletePermission()
deletePermission(id): Promise<void>;Defined in: packages/drizzle/src/adapter.ts:233
Parameters
| Parameter | Type |
|---|---|
id | Id |
Returns
Promise<void>
Implementation of
RbacAdapter.deletePermission
deleteRole()
deleteRole(id): Promise<void>;Defined in: packages/drizzle/src/adapter.ts:295
Parameters
| Parameter | Type |
|---|---|
id | Id |
Returns
Promise<void>
Implementation of
RbacAdapter.deleteRole
detachRolePermissions()
detachRolePermissions(roleId, permissionIds?): Promise<void>;Defined in: packages/drizzle/src/adapter.ts:332
Parameters
| Parameter | Type |
|---|---|
roleId | Id |
permissionIds? | readonly Id[] |
Returns
Promise<void>
Implementation of
RbacAdapter.detachRolePermissions
detachSubjectPermissions()
detachSubjectPermissions(
subject,
permissionIds,
teamId
): Promise<void>;Defined in: packages/drizzle/src/adapter.ts:378
Parameters
| Parameter | Type |
|---|---|
subject | Subject |
permissionIds | readonly Id[] | undefined |
teamId | TeamId |
Returns
Promise<void>
Implementation of
RbacAdapter.detachSubjectPermissions
detachSubjectRoles()
detachSubjectRoles(
subject,
roleIds,
teamId
): Promise<void>;Defined in: packages/drizzle/src/adapter.ts:360
Parameters
| Parameter | Type |
|---|---|
subject | Subject |
roleIds | readonly Id[] | undefined |
teamId | TeamId |
Returns
Promise<void>
Implementation of
RbacAdapter.detachSubjectRoles
detachTeamLinks()
detachTeamLinks(teamId): Promise<void>;Defined in: packages/drizzle/src/adapter.ts:465
Removes every role and direct-permission link held in the team (model_has_* rows only; roles stay). Match the team id exactly. Never called with null (the global scope).
Used by rbac.deleteTeam(). Fallback: one detachSubjectRoles and one detachSubjectPermissions call (with undefined ids) per subject returned by getTeamLinks.
Parameters
| Parameter | Type |
|---|---|
teamId | Id |
Returns
Promise<void>
Implementation of
RbacAdapter.detachTeamLinks
findPermissions()
findPermissions(query?): Promise<Permission[]>;Defined in: packages/drizzle/src/adapter.ts:203
Parameters
| Parameter | Type |
|---|---|
query? | FindPermissionsQuery |
Returns
Promise<Permission[]>
Implementation of
RbacAdapter.findPermissions
findRoles()
findRoles(query?): Promise<Role[]>;Defined in: packages/drizzle/src/adapter.ts:259
Parameters
| Parameter | Type |
|---|---|
query? | FindRolesQuery |
Returns
Promise<Role[]>
Implementation of
RbacAdapter.findRoles
getRolePermissionLinks()
getRolePermissionLinks(roleIds): Promise<RolePermissionLink[]>;Defined in: packages/drizzle/src/adapter.ts:308
Parameters
| Parameter | Type |
|---|---|
roleIds | readonly Id[] |
Returns
Promise<RolePermissionLink[]>
Implementation of
RbacAdapter.getRolePermissionLinks
getSubjectIdsWithPermissions()
getSubjectIdsWithPermissions(
subjectType,
permissionIds,
teamId,
options?
): Promise<Id[]>;Defined in: packages/drizzle/src/adapter.ts:401
Ids of subjects of subjectType that have ANY of the given DIRECT permissions in the given team. Unique. With options (only passed with supportsExpiry: true), links expired at options.now don't count.
Parameters
| Parameter | Type |
|---|---|
subjectType | string |
permissionIds | readonly Id[] |
teamId | TeamId |
options? | ActiveLinkOptions |
Returns
Promise<Id[]>
Implementation of
RbacAdapter.getSubjectIdsWithPermissions
getSubjectIdsWithRoles()
getSubjectIdsWithRoles(
subjectType,
roleIds,
teamId,
options?
): Promise<Id[]>;Defined in: packages/drizzle/src/adapter.ts:392
Ids of subjects of subjectType that have ANY of the given roles in the given team. Unique. With options (only passed with supportsExpiry: true), links expired at options.now don't count.
Parameters
| Parameter | Type |
|---|---|
subjectType | string |
roleIds | readonly Id[] |
teamId | TeamId |
options? | ActiveLinkOptions |
Returns
Promise<Id[]>
Implementation of
RbacAdapter.getSubjectIdsWithRoles
getSubjectLinks()
getSubjectLinks(subject): Promise<SubjectLinks>;Defined in: packages/drizzle/src/adapter.ts:446
Every role and direct-permission link of the subject, in EVERY team (global included), whatever the guard. Match the subject exactly, like getSubjectRoleIds.
Used by rbac.for(subject).teams() and revokeAll({ allTeams: true }). No fallback: the required methods can only read one team at a time, so without it those two throw ADAPTER_METHOD_MISSING.
Parameters
| Parameter | Type |
|---|---|
subject | Subject |
Returns
Promise<SubjectLinks>
Implementation of
RbacAdapter.getSubjectLinks
getSubjectPermissionIds()
getSubjectPermissionIds(subject, teamId): Promise<Id[]>;Defined in: packages/drizzle/src/adapter.ts:364
Parameters
| Parameter | Type |
|---|---|
subject | Subject |
teamId | TeamId |
Returns
Promise<Id[]>
Implementation of
RbacAdapter.getSubjectPermissionIds
getSubjectPermissionLinks()
getSubjectPermissionLinks(subject, teamId): Promise<SubjectPermissionLink[]>;Defined in: packages/drizzle/src/adapter.ts:423
The subject's direct-permission links in the team, like getSubjectRoleLinks.
Parameters
| Parameter | Type |
|---|---|
subject | Subject |
teamId | TeamId |
Returns
Promise<SubjectPermissionLink[]>
Implementation of
RbacAdapter.getSubjectPermissionLinks
getSubjectRoleIds()
getSubjectRoleIds(subject, teamId): Promise<Id[]>;Defined in: packages/drizzle/src/adapter.ts:347
Parameters
| Parameter | Type |
|---|---|
subject | Subject |
teamId | TeamId |
Returns
Promise<Id[]>
Implementation of
RbacAdapter.getSubjectRoleIds
getSubjectRoleLinks()
getSubjectRoleLinks(subject, teamId): Promise<SubjectRoleLink[]>;Defined in: packages/drizzle/src/adapter.ts:419
The subject's role links in the team, expired ones included, each with its expiresAt (null = never). Match the subject and team exactly, like getSubjectRoleIds.
Parameters
| Parameter | Type |
|---|---|
subject | Subject |
teamId | TeamId |
Returns
Promise<SubjectRoleLink[]>
Implementation of
RbacAdapter.getSubjectRoleLinks
getTeamLinks()
getTeamLinks(teamId): Promise<SubjectLinks>;Defined in: packages/drizzle/src/adapter.ts:454
Every role and direct-permission link held in the team, by any subject, whatever the guard. Match the team id exactly. Never called with null (the global scope).
Used by rbac.deleteTeam(). No fallback: the required methods need each subject's type and id, so without it deleteTeam() throws ADAPTER_METHOD_MISSING before writing anything.
Parameters
| Parameter | Type |
|---|---|
teamId | Id |
Returns
Promise<SubjectLinks>
Implementation of
RbacAdapter.getTeamLinks
