Class MembershipAccessTrait

The membership access trait handles the access control rules around memberships.

Migration notes:

if you don't want to change the policy files, do the next steps. Or you can skip them, but it might require an additional changes in the policy files.
move your 'parents' field to the trait (see the usage section)
if an entity doesn't have 'parents' field add the trait anyway, just without 'parents' config (e.g. in Organisation).
the trait must be the first in the list of traits, but below data_objects

Usage:

 id: /Activity
 label: Activity
 $ref: /Base
 type: object
 traits:
   - type: membership_access
     parents:
       - type: Content
         edge: hasActivity
         direction: in
       - type: Menu
         edge: hasActivity
         direction: in

Hierarchy

Trait<MembershipAccessTraitConfig>
- MembershipAccessTrait

Constructors

constructor

new MembershipAccessTrait(_schemaManager: SchemaManager): MembershipAccessTrait
Parameters
- _schemaManager: SchemaManager
Returns MembershipAccessTrait
Overrides Trait.constructor
- Defined in src/traits/MembershipAccessTrait.ts:66

Properties

`Private` _applyConditionsFor

_applyConditionsFor: ActionsType[] = ...

`Protected` `Optional` _config

_config?: MembershipAccessTraitConfig

Trait instance configuration.

`Protected` _global

_global: boolean = false

Whether this is a global (not bound to any specific schema item) trait instance.

`Protected` `Readonly` _schemaManager

_schemaManager: SchemaManager

`Private` `Optional` _source

_source?: string

`Protected` `Optional` _type

_type?: "membershipAccess"

Trait type.

Methods

`Protected` _getDescendantRules

_getDescendantRules(vertex: string): null | string
Parameters
- vertex: string
Returns null | string
- Defined in src/traits/MembershipAccessTrait.ts:179

`Protected` _getInverseRules

_getInverseRules(vertexTypes: string[], target: string, childDefs: SchemaItemsKeyedByType, processed: string[]): string[]
Get all rules for accessing content via the access control paths starting from the user. Rules are assumed to start from an entity of which the user has already been determined to be a direct or transitive member.
Parameters
- vertexTypes: string[]
- target: string
- childDefs: SchemaItemsKeyedByType
- processed: string[]
Returns string[]
- Defined in src/traits/MembershipAccessTrait.ts:272

`Protected` _getParentRules

_getParentRules(vertex: string): null | string
Get all the rules for finding ancestors of a vertex type.

Returns a pseudo-gremlin rule.
Parameters
- vertex: string
Returns null | string
- Defined in src/traits/MembershipAccessTrait.ts:226

`Protected` _getUnionOfRules

_getUnionOfRules(rules: string[]): null | string
Get union of rules.
Parameters
- rules: string[]
Returns null | string
- Defined in src/traits/MembershipAccessTrait.ts:249

`Protected` _reverseDirection

_reverseDirection(direction: string): undefined | string
Reverse direction.
Parameters
- direction: string
Returns undefined | string
- Defined in src/traits/MembershipAccessTrait.ts:265

generateAccessControl

generateAccessControl(statements: TheStatementSchema): TheStatementSchema
Alter generated access statements, add membership access rules.
Parameters
- statements: TheStatementSchema
Returns TheStatementSchema
- Defined in src/traits/MembershipAccessTrait.ts:296

`Protected` getDefaultStatement

getDefaultStatement(vertexName: string, type: string): DefaultPolicyStatement
Get the default policy statement.
Parameters
- vertexName: string
- type: string
Returns DefaultPolicyStatement
- Defined in src/traits/MembershipAccessTrait.ts:106

`Protected` handleStatementUpdateActions

handleStatementUpdateActions(vertexName: string, statement: TheItemsSchema): void
Handle statement update actions.
Parameters
- vertexName: string
- statement: TheItemsSchema
Returns void
- Defined in src/traits/MembershipAccessTrait.ts:123

`Protected` handleStatementViewActions

handleStatementViewActions(vertexName: string, statement: TheItemsSchema): void
Handle statement view actions.
Parameters
- vertexName: string
- statement: TheItemsSchema
Returns void
- Defined in src/traits/MembershipAccessTrait.ts:151

hookIntoSchema

hookIntoSchema(schemaItem: SchemaItem<SchemaItemType>): void
Attaches Trait callbacks to schema item hooks.
Parameters
- schemaItem: SchemaItem<SchemaItemType>
Returns void
Overrides Trait.hookIntoSchema
- Defined in src/traits/MembershipAccessTrait.ts:394

hookIntoSchemaManager

hookIntoSchemaManager(): void
Attaches Trait callbacks to schema manager hooks.

Returns void
Inherited from Trait.hookIntoSchemaManager
- Defined in src/traits/Trait.ts:225

makeGlobal

makeGlobal(): MembershipAccessTrait
Makes this Trait instance global.

Returns MembershipAccessTrait
Inherited from Trait.makeGlobal
- Defined in src/traits/Trait.ts:237

name

name(): string
Used to return the name.

Returns string
Inherited from Trait.name
- Defined in src/traits/Trait.ts:198

process

process<RT, Payload>(callbackName: string, datasourceWrapper: DataSourceWrapper, data: TraitDataObject<RT, Payload, Promise<any>>): Promise<RT>
This method is triggered when a trait callback has been activated
Type Parameters
- RT = any
- Payload = any
Parameters
- callbackName: string
  
  This is the name of the callback function to call.
- datasourceWrapper: DataSourceWrapper
  
  References to the Graph Hanlder
- data: TraitDataObject<RT, Payload, Promise<any>>
  
  Request data passed along as part of the request.
Returns Promise<RT>
Inherited from Trait.process
- Defined in src/traits/Trait.ts:147

setConfig

setConfig(config: MembershipAccessTraitConfig): void
MembershipAccessTrait config setter
Parameters
- config: MembershipAccessTraitConfig
  
  This configuration object.
Returns void
Overrides Trait.setConfig
- Defined in src/traits/MembershipAccessTrait.ts:82

traitConfig

traitConfig(): MembershipAccessTraitConfig
Returns MembershipAccessTraitConfig
Inherited from Trait.traitConfig
- Defined in src/traits/Trait.ts:205

wrapLegacyResolver

wrapLegacyResolver<RT, Payload>(resolver: LegacyKosmosTraitResolverCallback<RT, any>, datasourceWrapper: DataSourceWrapper, callbackName?: string): KosmosGraphQLResolver<RT, Payload, Promise<RT>>
Helper method for wrapping legacy Kosmos traits callbacks.

TODO: Remove this method once all Traits are converted.
Type Parameters
- RT = any
- Payload = any
Parameters
- resolver: LegacyKosmosTraitResolverCallback<RT, any>
- datasourceWrapper: DataSourceWrapper
- Optional callbackName: string
  
  Optional callback name; passing this parameter will additionally wrap the callback into legacy process().
Returns KosmosGraphQLResolver<RT, Payload, Promise<RT>>
Inherited from Trait.wrapLegacyResolver
- Defined in src/traits/Trait.ts:168

`Static` traitTypeName

traitTypeName(): string
This method should return the trait machine name(s).

Returns

Returns string
Overrides Trait.traitTypeName
- Defined in src/traits/MembershipAccessTrait.ts:99

Class MembershipAccessTrait

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

_schemaManager: SchemaManager

Returns MembershipAccessTrait

Properties

Private _applyConditionsFor

Protected Optional _config

Protected _global

Protected Readonly _schemaManager

Private Optional _source

Protected Optional _type

Methods

Protected _getDescendantRules

Parameters

vertex: string

Returns null | string

Protected _getInverseRules

Parameters

vertexTypes: string[]

target: string

childDefs: SchemaItemsKeyedByType

processed: string[]

Returns string[]

Protected _getParentRules

Parameters

vertex: string

Returns null | string

Protected _getUnionOfRules

Parameters

rules: string[]

Returns null | string

Protected _reverseDirection

Parameters

direction: string

Returns undefined | string

generateAccessControl

Parameters

statements: TheStatementSchema

Returns TheStatementSchema

Protected getDefaultStatement

Parameters

vertexName: string

type: string

Returns DefaultPolicyStatement

Protected handleStatementUpdateActions

Parameters

vertexName: string

statement: TheItemsSchema

Returns void

Protected handleStatementViewActions

Parameters

vertexName: string

statement: TheItemsSchema

Returns void

hookIntoSchema

Parameters

schemaItem: SchemaItem<SchemaItemType>

Returns void

hookIntoSchemaManager

Returns void

makeGlobal

Returns MembershipAccessTrait

name

Returns string

process

Type Parameters

RT = any

Payload = any

Parameters

callbackName: string

datasourceWrapper: DataSourceWrapper

data: TraitDataObject<RT, Payload, Promise<any>>

Returns Promise<RT>

`Private` _applyConditionsFor

`Protected` `Optional` _config

`Protected` _global

`Protected` `Readonly` _schemaManager

`Private` `Optional` _source

`Protected` `Optional` _type

`Protected` _getDescendantRules

`Protected` _getInverseRules

`Protected` _getParentRules

`Protected` _getUnionOfRules

`Protected` _reverseDirection

`Protected` getDefaultStatement

`Protected` handleStatementUpdateActions

`Protected` handleStatementViewActions

`Optional` callbackName: string

`Static` traitTypeName