HierarchicalAccessStrategy
katanakit-js / HierarchicalAccessStrategy
Class: HierarchicalAccessStrategy
Section titled “Class: HierarchicalAccessStrategy”Defined in: core/services/access.service.ts:113
Estrategia por defecto: control de acceso jerárquico basado en roles registrados. Es la estrategia estándar del servicio.
Example
Section titled “Example”const strategy = new HierarchicalAccessStrategy();strategy.useCan({ id: 1, roles: ["editor"] }, "content:create"); // trueImplements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new HierarchicalAccessStrategy(): HierarchicalAccessStrategy;Defined in: core/services/access.service.ts:117
Returns
Section titled “Returns”HierarchicalAccessStrategy
Methods
Section titled “Methods”useCan()
Section titled “useCan()”useCan(subject, capability): boolean;Defined in: core/services/access.service.ts:196
Whether the subject may perform a capability. Any of the subject’s roles granting the capability (directly or by inheritance) is enough.
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
Example
Section titled “Example”useCan({ id: 1, roles: ["author"] }, "content:publish"); // falseuseCan({ id: 1, roles: ["author"] }, "content:create"); // trueuseCan({ id: 2, roles: ["editor"] }, "content:create"); // true (inherits author)useCan({ id: 3, roles: [] }, "conversations:use"); // falseImplementation of
Section titled “Implementation of”useCapabilitiesFor()
Section titled “useCapabilitiesFor()”useCapabilitiesFor(role): string[];Defined in: core/services/access.service.ts:140
Effective capabilities of a role: its own plus every less-privileged role’s.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
role |
string |
Returns
Section titled “Returns”string[]
Example
Section titled “Example”useCapabilitiesFor("author"); // content:create, content:edit:own, ..., conversations:useuseCapabilitiesFor("guest"); // []Implementation of
Section titled “Implementation of”IAccessStrategy.useCapabilitiesFor
useHasRole()
Section titled “useHasRole()”useHasRole(subject, role): boolean;Defined in: core/services/access.service.ts:180
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
Implementation of
Section titled “Implementation of”useRegisterRole()
Section titled “useRegisterRole()”useRegisterRole(definition): void;Defined in: core/services/access.service.ts:161
Registers (or replaces) a role definition. Use it to extend a built-in
role’s capabilities, e.g. grant content:create to member, or to add
a deployment-specific role that inherits from the built-ins by rank.
The definition is copied, so mutating the caller’s object afterwards
has no effect.
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
Implementation of
Section titled “Implementation of”IAccessStrategy.useRegisterRole
useResetRoles()
Section titled “useResetRoles()”useResetRoles(): void;Defined in: core/services/access.service.ts:167
Restores the built-in role registry (mainly for tests).
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”useRoles()
Section titled “useRoles()”useRoles(): { capabilities: string[]; label: string; rank: number; slug: string;}[];Defined in: core/services/access.service.ts:175
Lists every registered role definition. Returns copies, not live state.
Returns
Section titled “Returns”{
capabilities: string[];
label: string;
rank: number;
slug: string;
}[]