Skip to main content

Type Alias: RoleScaffoldedSchema<S, Grantable, RoleType, Assignee, Prefix>

RoleScaffoldedSchema<S, Grantable, RoleType, Assignee, Prefix> = object

Defined in: packages/polizy/src/role-scaffold.ts:70

A schema returned by withRoleScaffold: the original schema with the role scaffold relations/actions merged in (literal types preserved), the role object type added, and the grantable action union recorded for the RoleRegistry via the _grantable phantom.

Type Parameters​

S​

S extends AuthSchema<any, any, any, any, any>

Grantable​

Grantable extends readonly string[]

RoleType​

RoleType extends string = "role"

Assignee​

Assignee extends string = "assignee"

Prefix​

Prefix extends string = "cap_"

Properties​

_grantable?​

optional _grantable?: Grantable[number]

Defined in: packages/polizy/src/role-scaffold.ts:85

_objectType?​

optional _objectType?: SchemaObjectTypes<S> | RoleType

Defined in: packages/polizy/src/role-scaffold.ts:84

_subjectType?​

optional _subjectType?: SchemaSubjectTypes<S>

Defined in: packages/polizy/src/role-scaffold.ts:83

actionToRelations​

actionToRelations: ScaffoldActions<S["actionToRelations"], Grantable, Prefix>

Defined in: packages/polizy/src/role-scaffold.ts:78

fieldLevelObjects?​

optional fieldLevelObjects?: S["fieldLevelObjects"]

Defined in: packages/polizy/src/role-scaffold.ts:80

fieldSeparator?​

optional fieldSeparator?: string

Defined in: packages/polizy/src/role-scaffold.ts:81

hierarchyPropagation?​

optional hierarchyPropagation?: S["hierarchyPropagation"]

Defined in: packages/polizy/src/role-scaffold.ts:79

relations​

relations: ScaffoldRelations<S["relations"], Grantable, Assignee, Prefix>

Defined in: packages/polizy/src/role-scaffold.ts:77

roleScaffold​

roleScaffold: RoleScaffoldMeta

Defined in: packages/polizy/src/role-scaffold.ts:82