Class FieldVisibilityTrait

Field Visibility Trait is used to hide/replace sensitive fields information based on certain conditions.

Usage:

traits:
  # Hide email if user doesn't want it to be displayed.
  - type: fieldVisibility
    targets:
      - field: email
        condition: email_visible:true
        result: xxxxxxx

Hierarchy

Trait<FieldVisibilityTraitConfig>
- FieldVisibilityTrait

Index

Constructors

constructor

new FieldVisibilityTrait(): FieldVisibilityTrait
Returns FieldVisibilityTrait

Inherited from Trait.constructor

Properties

`Protected` `Optional` _config

_config?: FieldVisibilityTraitConfig

Trait instance configuration.

`Protected` _global

_global: boolean = false

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

`Private` _skip_roles

_skip_roles: string[] = []

`Private` _targets

_targets: FieldVisibilityTarget[] = []

`Protected` `Optional` _type

_type?: "fieldVisibility"

Trait type.

Methods

checkCondition

checkCondition(item: any, condition: string): boolean
Parameters
- item: any
- condition: string
Returns boolean
- Defined in src/traits/FieldVisibilityTrait.ts:136

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/FieldVisibilityTrait.ts:167

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(): FieldVisibilityTrait
Makes this Trait instance global.

Returns FieldVisibilityTrait
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

postView

postView(item: Record<string, any>, _: any, context: KosmosUserContext<object>): Record<string, any>
Post-view hook implementation.

Update the content..

Returns
Parameters
- item: Record<string, any>
- _: any
- context: KosmosUserContext<object>
Returns Record<string, any>
- Defined in src/traits/FieldVisibilityTrait.ts:112

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: FieldVisibilityTraitConfig): void
FieldVisibilityTrait config setter.
Parameters
- config: FieldVisibilityTraitConfig
  
  This configuration object contains a list of field visibility rules
Returns void
Overrides Trait.setConfig
- Defined in src/traits/FieldVisibilityTrait.ts:87

traitConfig

traitConfig(): FieldVisibilityTraitConfig
Returns FieldVisibilityTraitConfig
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/FieldVisibilityTrait.ts:97

Class FieldVisibilityTrait

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns FieldVisibilityTrait

Properties

Protected Optional _config

Protected _global

Private _skip_roles

Private _targets

Protected Optional _type

Methods

checkCondition

Parameters

item: any

condition: string

Returns boolean

hookIntoSchema

Parameters

schemaItem: SchemaItem<SchemaItemType>

Returns void

hookIntoSchemaManager

Returns void

makeGlobal

Returns FieldVisibilityTrait

name

Returns string

postView

Returns

Parameters

item: Record<string, any>

_: any

context: KosmosUserContext<object>

Returns Record<string, any>

process

Type Parameters

RT = any

Payload = any

Parameters

callbackName: string

datasourceWrapper: DataSourceWrapper

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

Returns Promise<RT>

setConfig

Parameters

config: FieldVisibilityTraitConfig

Returns void

traitConfig

Returns FieldVisibilityTraitConfig

wrapLegacyResolver

Type Parameters

RT = any

Payload = any

Parameters

resolver: LegacyKosmosTraitResolverCallback<RT, any>

datasourceWrapper: DataSourceWrapper

Optional callbackName: string

Returns KosmosGraphQLResolver<RT, Payload, Promise<RT>>

Static traitTypeName

Returns

Returns string

Settings

Member Visibility

Theme

`Protected` `Optional` _config

`Protected` _global

`Private` _skip_roles

`Private` _targets

`Protected` `Optional` _type

`Optional` callbackName: string

`Static` traitTypeName