UseGrantAwareCan
katanakit-js / useGrantAwareCan
Function: useGrantAwareCan()
Section titled “Function: useGrantAwareCan()”function useGrantAwareCan(options): ResourceAccessDecision;Defined in: core/services/grant.service.ts:84
Resolves a capability against a subject and a resource.
Two independent sources, checked in order:
- the subject’s global roles — a department head may sign any payroll;
- a grant on this exact resource — an employee sees only their own file.
Neither subsumes the other, which is why this is not useCan with extra
arguments. A global role answers “what class of thing may this person ever
do”; a grant answers “may they do it to this one”. A deployment needs
both the moment anyone shares a document with one person and nothing with
everybody else.
An expired grant is treated as absent, so revoking a contractor is deleting one row — not auditing every query path that might have cached the role.
Pure: no storage access, no clock read, no globals.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options |
GrantAwareOptions |
Returns
Section titled “Returns”Example
Section titled “Example”useGrantAwareCan({ subject: sessionSubject, resource: { type: "expediente", id: 42 }, capability: "expediente:read", useGrants: ({ subject, resource }) => listShares(subject.id, resource),});