AccessService
katanakit-js / AccessService
Class: AccessService
Section titled “Class: AccessService”Defined in: core/services/access.service.ts:272
AccessService - Singleton facade con Strategy Pattern.
Centraliza el control de acceso (roles y capacidades) delegando el algoritmo concreto en una IAccessStrategy intercambiable. Por defecto usa HierarchicalAccessStrategy.
Example
Section titled “Example”// Uso con la estrategia por defecto (jerárquica)AccessService.getInstance().useCan({ id: 1, roles: ["admin"] }, "members:manage");
// Cambiar a estrategia plana en runtimeAccessService.getInstance().useSetStrategy(new FlatAccessStrategy());Methods
Section titled “Methods”useCan()
Section titled “useCan()”useCan(subject, capability): boolean;Defined in: core/services/access.service.ts:358
Whether the subject may perform a capability (delegado a la estrategia activa).
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
subject |
{ [key: string]: unknown; id: string | number; roles: string[]; } |
subject.id? |
string | number |
subject.roles? |
string[] |
capability |
string |
Returns
Section titled “Returns”boolean
useCapabilitiesFor()
Section titled “useCapabilitiesFor()”useCapabilitiesFor(role): string[];Defined in: core/services/access.service.ts:329
Effective capabilities of a role (delegado a la estrategia activa).
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
role |
string |
Returns
Section titled “Returns”string[]
useGetStrategy()
Section titled “useGetStrategy()”useGetStrategy(): IAccessStrategy;Defined in: core/services/access.service.ts:322
Returns the currently active strategy.
Returns
Section titled “Returns”useHasRole()
Section titled “useHasRole()”useHasRole(subject, role): boolean;Defined in: core/services/access.service.ts:351
Exact role membership - no hierarchy involved.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
subject |
{ [key: string]: unknown; id: string | number; roles: string[]; } |
subject.id? |
string | number |
subject.roles? |
string[] |
role |
string |
Returns
Section titled “Returns”boolean
useRegisterRole()
Section titled “useRegisterRole()”useRegisterRole(definition): void;Defined in: core/services/access.service.ts:336
Registers (or replaces) a role definition (delegado a la estrategia activa).
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
definition |
{ capabilities: string[]; label: string; rank: number; slug: string; } |
definition.capabilities? |
string[] |
definition.label? |
string |
definition.rank? |
number |
definition.slug? |
string |
Returns
Section titled “Returns”void
useResetRoles()
Section titled “useResetRoles()”useResetRoles(): void;Defined in: core/services/access.service.ts:341
Restores the built-in role registry (delegado a la estrategia activa).
Returns
Section titled “Returns”void
useRoles()
Section titled “useRoles()”useRoles(): { capabilities: string[]; label: string; rank: number; slug: string;}[];Defined in: core/services/access.service.ts:346
Lists every registered role definition (delegado a la estrategia activa).
Returns
Section titled “Returns”{
capabilities: string[];
label: string;
rank: number;
slug: string;
}[]
useSetStrategy()
Section titled “useSetStrategy()”useSetStrategy(strategy): void;Defined in: core/services/access.service.ts:317
Intercambia la estrategia de acceso en runtime (Strategy Pattern).
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
strategy |
IAccessStrategy |
La nueva estrategia a utilizar. |
Returns
Section titled “Returns”void
create()
Section titled “create()”static create(strategy?): AccessService;Defined in: core/services/access.service.ts:308
Crea una instancia NO-singleton con una estrategia específica. Útil para tests o para aislar varios contextos de acceso.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
strategy? |
IAccessStrategy |
Estrategia a inyectar. |
Returns
Section titled “Returns”AccessService
Una nueva instancia de AccessService.
Example
Section titled “Example”const flatAccess = AccessService.create(new FlatAccessStrategy());getInstance()
Section titled “getInstance()”static getInstance(): AccessService;Defined in: core/services/access.service.ts:289
Obtiene la instancia única del AccessService (Singleton).
Returns
Section titled “Returns”AccessService
La instancia única de AccessService.