Skip to main content

Type Alias: RoleScaffoldMeta

RoleScaffoldMeta = object

Defined in: packages/polizy/src/types.ts:118

Runtime metadata attached by withRoleScaffold. Lets the engine and the RoleRegistry recognize the generic role-binding relations without changing the type-safe relation/action vocabulary. Present only on scaffolded schemas.

Properties​

assigneeRelation​

assigneeRelation: string

Defined in: packages/polizy/src/types.ts:122

Reserved group relation binding a subject to a role it is assigned.

capPrefix​

capPrefix: string

Defined in: packages/polizy/src/types.ts:124

Prefix of the direct relations binding a role to a capability (e.g. "cap_").

grantable​

grantable: readonly string[]

Defined in: packages/polizy/src/types.ts:126

Action names custom roles may grant (each has a ${capPrefix}${action} relation).

roleType​

roleType: string

Defined in: packages/polizy/src/types.ts:120

Object type used for role objects (e.g. "role").