Class AdminDashboardRoleService

Role catalog, role↔permission mapping and per-user role assignment. One role per user, so assigning replaces whatever the user held. A role assignment publishes with publishConfirmed; catalog edits are config, so publish.

Hierarchy (View Summary)

AdminDashboardRoleQueryService
- AdminDashboardRoleService

Index

Constructors

constructor

new AdminDashboardRoleService(
    __namedParameters: {
        db: B2bDatabase;
        internalEventPublisher: InternalEventPublisher;
    },
): AdminDashboardRoleService
Parameters
- __namedParameters: { db: B2bDatabase; internalEventPublisher: InternalEventPublisher }
Returns AdminDashboardRoleService
Overrides AdminDashboardRoleQueryService.constructor
- Defined in packages/dashboard-auth-services/src/admin/AdminDashboardRoleService.ts:254

Properties

`Protected` `Readonly`db

db: B2bDatabase

`Static`instance

instance: (...args: []) => AdminDashboardRoleService = ...

The process service: the shared database and the internal event bus.

Methods

assignToUser

assignToUser(
    input: { assignedByUserId: string; roleId: string; userId: string },
): Promise<
    | { ok: true; value: AdminDashboardUser }
    | { error: ServiceError; ok: false },
>
Gives a user this role, replacing any other. Idempotent.
Parameters
- input: { assignedByUserId: string; roleId: string; userId: string }
Returns Promise<
| { ok: true; value: AdminDashboardUser }
| { error: ServiceError; ok: false },
>
- Defined in packages/dashboard-auth-services/src/admin/AdminDashboardRoleService.ts:557

create

create(
    input: {
        data: { description?: string; name: string; permissionKeys: string[] };
    },
): Promise<
    | { ok: true; value: AdminDashboardRole }
    | { error: ServiceError; ok: false },
>
permissionKeys is the full set; an unknown key fails the whole create.
Parameters
- input: { data: { description?: string; name: string; permissionKeys: string[] } }
Returns Promise<
| { ok: true; value: AdminDashboardRole }
| { error: ServiceError; ok: false },
>
- Defined in packages/dashboard-auth-services/src/admin/AdminDashboardRoleService.ts:266

delete

delete(
__namedParameters: { id: string },
): Promise<{ ok: true; value: void } | { error: ServiceError; ok: false }>
Hard-deletes a custom role; the table has no deleted_at. System roles and roles still held by a user are refused.
Parameters
- __namedParameters: { id: string }
Returns Promise<{ ok: true; value: void } | { error: ServiceError; ok: false }>
- Defined in packages/dashboard-auth-services/src/admin/AdminDashboardRoleService.ts:491

get

get(__namedParameters: { id: string }): Promise<AdminDashboardRole | null>
Parameters
- __namedParameters: { id: string }
Returns Promise<AdminDashboardRole | null>
Inherited from AdminDashboardRoleQueryService.get
- Defined in packages/dashboard-auth-services/src/admin/AdminDashboardRoleService.ts:76

listPermissionsForUser

listPermissionsForUser(
    __namedParameters: { userId: string },
): Promise<
    {
        ok: true;
        value: { permissionKeys: string[]; roleName: string
        | null };
    },
>
The permission keys the user's role grants, deduped and sorted; [] for no role. One query, for the per-request auth path (lib/auth.ts).
Parameters
- __namedParameters: { userId: string }
Returns Promise<
    {
        ok: true;
        value: { permissionKeys: string[]; roleName: string
        | null };
    },
>
Inherited from AdminDashboardRoleQueryService.listPermissionsForUser
- Defined in packages/dashboard-auth-services/src/admin/AdminDashboardRoleService.ts:191

search

search(
    input?: {
        ids?: string[];
        names?: string[];
        page?: number;
        pageSize?: number;
        userIds?: string[];
    },
): Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: AdminDashboardRole[]; total: number };
    },
>
Parameters
- Optionalinput: {
      ids?: string[];
      names?: string[];
      page?: number;
      pageSize?: number;
      userIds?: string[];
  }
  - Optionalids?: string[]
  - Optionalnames?: string[]
  - Optionalpage?: number
  - OptionalpageSize?: number
  - OptionaluserIds?: string[]
    
    Roles held by any of these users.
Returns Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: AdminDashboardRole[]; total: number };
    },
>
Inherited from AdminDashboardRoleQueryService.search
- Defined in packages/dashboard-auth-services/src/admin/AdminDashboardRoleService.ts:85

unassignFromUser

unassignFromUser(
    input: { assignedByUserId: string; userId: string },
): Promise<
    | { ok: true; value: AdminDashboardUser }
    | { error: ServiceError; ok: false },
>
Clears a user's role. Idempotent.
Parameters
- input: { assignedByUserId: string; userId: string }
Returns Promise<
| { ok: true; value: AdminDashboardUser }
| { error: ServiceError; ok: false },
>
- Defined in packages/dashboard-auth-services/src/admin/AdminDashboardRoleService.ts:566

update

update(
    input: {
        data: {
            description?: string;
            name?: string;
            permissionKeys?: string[];
        };
        id: string;
    },
): Promise<
    | { ok: true; value: AdminDashboardRole }
    | { error: ServiceError; ok: false },
>
Updates the name and description, and replaces the permission set when permissionKeys is given. A field whose value is unchanged is not written.
Parameters
- input: {
  data: { description?: string; name?: string; permissionKeys?: string[] };
  id: string;
  }
Returns Promise<
| { ok: true; value: AdminDashboardRole }
| { error: ServiceError; ok: false },
>
- Defined in packages/dashboard-auth-services/src/admin/AdminDashboardRoleService.ts:344

Class AdminDashboardRoleService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AdminDashboardRoleService

Properties

Protected Readonlydb

Staticinstance

Methods

assignToUser

Parameters

Returns Promise< | { ok: true; value: AdminDashboardUser } | { error: ServiceError; ok: false },>

create

Parameters

Returns Promise< | { ok: true; value: AdminDashboardRole } | { error: ServiceError; ok: false },>

delete

Parameters

Returns Promise<{ ok: true; value: void } | { error: ServiceError; ok: false }>

get

Parameters

Returns Promise<AdminDashboardRole | null>

listPermissionsForUser

Parameters

Returns Promise< { ok: true; value: { permissionKeys: string[]; roleName: string | null }; },>

search

Parameters

Optionalids?: string[]

Optionalnames?: string[]

Optionalpage?: number

OptionalpageSize?: number

OptionaluserIds?: string[]

Returns Promise< { ok: true; value: { hasNext: boolean; items: AdminDashboardRole[]; total: number }; },>

unassignFromUser

Parameters

Returns Promise< | { ok: true; value: AdminDashboardUser } | { error: ServiceError; ok: false },>

update

Parameters

Returns Promise< | { ok: true; value: AdminDashboardRole } | { error: ServiceError; ok: false },>

Settings

On This Page

`Protected` `Readonly`db

`Static`instance

Returns Promise<
| { ok: true; value: AdminDashboardUser }
| { error: ServiceError; ok: false },
>

Returns Promise<
| { ok: true; value: AdminDashboardRole }
| { error: ServiceError; ok: false },
>

Returns Promise<
{
ok: true;
value: { permissionKeys: string[]; roleName: string
| null };
},
>

`Optional`ids?: string[]

`Optional`names?: string[]

`Optional`page?: number

`Optional`pageSize?: number

`Optional`userIds?: string[]

Returns Promise<
{
ok: true;
value: { hasNext: boolean; items: AdminDashboardRole[]; total: number };
},
>

Returns Promise<
| { ok: true; value: AdminDashboardUser }
| { error: ServiceError; ok: false },
>

Returns Promise<
| { ok: true; value: AdminDashboardRole }
| { error: ServiceError; ok: false },
>