Class CognitoTrait

The trait to integrate a vertex with AWS cognito

Mermaid

CognitoTrait Sequence

%%{init:{"theme":"dark"}}%% sequenceDiagram participant User participant TraitDataObject participant DataSourceWrapper participant GraphQLSchemaManager participant CognitoUserPoolApi participant CognitoTrait

User ->> CognitoTrait: postCreate(traitData, item, legacyDatasourceWrapper, context) CognitoTrait ->> CognitoUserPoolApi: createUser(false, true, context) CognitoUserPoolApi -->> CognitoTrait: Success Response CognitoTrait -->> User: Promise<void>

User ->> CognitoTrait: postUpdate(traitData, item, legacyDatasourceWrapper, context) CognitoTrait ->> CognitoUserPoolApi: updateUser(context, item) CognitoUserPoolApi -->> CognitoTrait: Success Response CognitoTrait -->> User: Promise<void>

User ->> CognitoTrait: postDelete(_traitData, entity, _legacyDatasourceWrapper, context) CognitoTrait ->> CognitoUserPoolApi: deleteUser(context) CognitoUserPoolApi -->> CognitoTrait: Success Response CognitoTrait -->> User: Promise<void>

User ->> CognitoTrait: cognitoSendWelcomeEmail(datasourceWrapper, data) CognitoTrait ->> CognitoUserPoolApi: sendWelcomeEmail( temporaryPassword, setPasswordAutomatically, context ) CognitoUserPoolApi -->> CognitoTrait: Success Response CognitoTrait -->> User: CognitoOperationResult

User ->> CognitoTrait: enableMFA(datasourceWrapper, data) CognitoTrait ->> CognitoUserPoolApi: userMFASMSpreference(context, true) CognitoUserPoolApi -->> CognitoTrait: Success Response CognitoTrait -->> User: CognitoOperationResult

User ->> CognitoTrait: disableMFA(datasourceWrapper, data) CognitoTrait ->> CognitoUserPoolApi: userMFASMSpreference(context, false) CognitoUserPoolApi -->> CognitoTrait: Success Response CognitoTrait -->> User: CognitoOperationResult

%%{init:{"theme":"default"}}%% sequenceDiagram participant User participant TraitDataObject participant DataSourceWrapper participant GraphQLSchemaManager participant CognitoUserPoolApi participant CognitoTrait

sequenceDiagram
   participant User
   participant TraitDataObject
   participant DataSourceWrapper
   participant GraphQLSchemaManager
   participant CognitoUserPoolApi
   participant CognitoTrait
   User ->> CognitoTrait: postCreate(traitData, item, legacyDatasourceWrapper, context)
   CognitoTrait ->> CognitoUserPoolApi: createUser(false, true, context)
   CognitoUserPoolApi -->> CognitoTrait: Success Response
   CognitoTrait -->> User: Promise<void>
   User ->> CognitoTrait: postUpdate(traitData, item, legacyDatasourceWrapper, context)
   CognitoTrait ->> CognitoUserPoolApi: updateUser(context, item)
   CognitoUserPoolApi -->> CognitoTrait: Success Response
   CognitoTrait -->> User: Promise<void>
   User ->> CognitoTrait: postDelete(_traitData, entity, _legacyDatasourceWrapper, context)
   CognitoTrait ->> CognitoUserPoolApi: deleteUser(context)
   CognitoUserPoolApi -->> CognitoTrait: Success Response
   CognitoTrait -->> User: Promise<void>
   User ->> CognitoTrait: cognitoSendWelcomeEmail(datasourceWrapper, data)
   CognitoTrait ->> CognitoUserPoolApi: sendWelcomeEmail(
     temporaryPassword,
     setPasswordAutomatically,
     context
   )
   CognitoUserPoolApi -->> CognitoTrait: Success Response
   CognitoTrait -->> User: CognitoOperationResult
   User ->> CognitoTrait: enableMFA(datasourceWrapper, data)
   CognitoTrait ->> CognitoUserPoolApi: userMFASMSpreference(context, true)
   CognitoUserPoolApi -->> CognitoTrait: Success Response
   CognitoTrait -->> User: CognitoOperationResult
   User ->> CognitoTrait: disableMFA(datasourceWrapper, data)
   CognitoTrait ->> CognitoUserPoolApi: userMFASMSpreference(context, false)
   CognitoUserPoolApi -->> CognitoTrait: Success Response
   CognitoTrait -->> User: CognitoOperationResult

Hierarchy

Trait<CognitoTraitConfig>
- CognitoTrait

Constructors

constructor

new CognitoTrait(graphqlSchemaManager: GraphQLSchemaManager, dataSourceWrapper: DataSourceWrapper, _graphqlSchemaManager: GraphQLSchemaManager, _cognito: AWSCognitoUserPoolApi, _access: AccessControl): CognitoTrait
Parameters
- graphqlSchemaManager: GraphQLSchemaManager
- dataSourceWrapper: DataSourceWrapper
- _graphqlSchemaManager: GraphQLSchemaManager
- _cognito: AWSCognitoUserPoolApi
- _access: AccessControl
Returns CognitoTrait
Overrides Trait.constructor
- Defined in src/traits/CognitoTrait.ts:79

Properties

Trait instance configuration.

`Protected` _global

_global: boolean = false

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

`Protected` `Readonly` _graphqlSchemaManager

_graphqlSchemaManager: GraphQLSchemaManager

`Protected` `Optional` _type

_type?: "cognito"

Trait type.

`Protected` `Readonly` dataSourceWrapper

dataSourceWrapper: DataSourceWrapper

`Protected` `Readonly` graphqlSchemaManager

graphqlSchemaManager: GraphQLSchemaManager

logger

logger: Logger

Methods

addIdp

addIdp(datasourceWrapper: DataSourceWrapper, data: TraitDataObject<unknown, Record<string, any>, Promise<any>>): Promise<CognitoOperationResult>
add custom IdP.

Returns
A promise that resolves to true if the operation is successful.
Parameters
- datasourceWrapper: DataSourceWrapper
  
  The data source wrapper.
- data: TraitDataObject<unknown, Record<string, any>, Promise<any>>
  
  The trait data object.
Returns Promise<CognitoOperationResult>
- Defined in src/traits/CognitoTrait.ts:383

`Private` checkUserRole

checkUserRole(traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>): Promise<void>
Checks the user roles in the provided trait data to determine if the action is allowed.

Throws
Throws an error if the user does not have the required roles for the action.
Parameters
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
  
  The trait data object containing user roles in the context.
Returns Promise<void>
- Defined in src/traits/CognitoTrait.ts:108

cognitoSendWelcomeEmail

cognitoSendWelcomeEmail(datasourceWrapper: DataSourceWrapper, data: TraitDataObject<unknown, Record<string, any>, Promise<any>>): Promise<CognitoOperationResult>
Sends a welcome email to a user.

Returns
A promise that resolves to true if the operation is successful.
Parameters
- datasourceWrapper: DataSourceWrapper
  
  The data source wrapper.
- data: TraitDataObject<unknown, Record<string, any>, Promise<any>>
  
  The trait data object.
Returns Promise<CognitoOperationResult>
- Defined in src/traits/CognitoTrait.ts:252

disableMFA

disableMFA(datasourceWrapper: DataSourceWrapper, data: TraitDataObject<unknown, Record<string, any>, Promise<any>>): Promise<CognitoOperationResult>
Disables multi-factor authentication (MFA) for a user.

Returns
A promise that resolves to true if the operation is successful.
Parameters
- datasourceWrapper: DataSourceWrapper
  
  The data source wrapper.
- data: TraitDataObject<unknown, Record<string, any>, Promise<any>>
  
  The trait data object.
Returns Promise<CognitoOperationResult>
- Defined in src/traits/CognitoTrait.ts:326

enableMFA

enableMFA(datasourceWrapper: DataSourceWrapper, data: TraitDataObject<unknown, Record<string, any>, Promise<any>>): Promise<CognitoOperationResult>
Enables multi-factor authentication (MFA) for a user.

Returns
A promise that resolves to true if the operation is successful.
Parameters
- datasourceWrapper: DataSourceWrapper
  
  The data source wrapper.
- data: TraitDataObject<unknown, Record<string, any>, Promise<any>>
  
  The trait data object.
Returns Promise<CognitoOperationResult>
- Defined in src/traits/CognitoTrait.ts:287

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/CognitoTrait.ts:437

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

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

postCreate

postCreate(traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: ItemWithId, legacyDatasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>): Promise<void>
Creates user from in cognito
Parameters
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- item: ItemWithId
- legacyDatasourceWrapper: DataSourceWrapper
- context: KosmosUserContext<object>
Returns Promise<void>
- Defined in src/traits/CognitoTrait.ts:165

postDelete

postDelete(_traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: ItemWithId, _legacyDatasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>): Promise<void>
Deletes user from cognito
Parameters
- _traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- item: ItemWithId
- _legacyDatasourceWrapper: DataSourceWrapper
- context: KosmosUserContext<object>
Returns Promise<void>
- Defined in src/traits/CognitoTrait.ts:232

postUpdate

postUpdate(traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: ItemWithId, legacyDatasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>): Promise<void>
Update a user from in cognito
Parameters
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- item: ItemWithId
- legacyDatasourceWrapper: DataSourceWrapper
- context: KosmosUserContext<object>
Returns Promise<void>
- Defined in src/traits/CognitoTrait.ts:205

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

removeIdp

removeIdp(datasourceWrapper: DataSourceWrapper, data: TraitDataObject<unknown, Record<string, any>, Promise<any>>): Promise<CognitoOperationResult>
Parameters
- datasourceWrapper: DataSourceWrapper
- data: TraitDataObject<unknown, Record<string, any>, Promise<any>>
Returns Promise<CognitoOperationResult>
- Defined in src/traits/CognitoTrait.ts:414

setConfig

setConfig(config: CognitoTraitConfig): void
Configuration setter.
Parameters
- config: CognitoTraitConfig
  
  The new configuration.
Returns void
Inherited from Trait.setConfig
- Defined in src/traits/Trait.ts:124

traitConfig

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

updateWelcomeEmailTemplate

updateWelcomeEmailTemplate(datasourceWrapper: DataSourceWrapper, data: TraitDataObject<unknown, Record<string, any>, Promise<any>>): Promise<CognitoOperationResult>
update welcome email template.

Returns
A promise that resolves to true if the operation is successful.
Parameters
- datasourceWrapper: DataSourceWrapper
  
  The data source wrapper.
- data: TraitDataObject<unknown, Record<string, any>, Promise<any>>
  
  The trait data object.
Returns Promise<CognitoOperationResult>
- Defined in src/traits/CognitoTrait.ts:358

`Private` userContextHasCognitoIss

userContextHasCognitoIss(context: KosmosUserContext<object>): boolean
Check user context has iss

This is used to extract congito user pool id to enable us to talk to the cognito api

Returns
if user iss is provided.
Parameters
- context: KosmosUserContext<object>
Returns boolean
- Defined in src/traits/CognitoTrait.ts:150

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/CognitoTrait.ts:98

Class CognitoTrait

Mermaid

CognitoTrait Sequence

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

graphqlSchemaManager: GraphQLSchemaManager

dataSourceWrapper: DataSourceWrapper

_graphqlSchemaManager: GraphQLSchemaManager

_cognito: AWSCognitoUserPoolApi

_access: AccessControl

Returns CognitoTrait

Properties

Protected _access

Protected _cognito

Protected Optional _config

Protected _global

Protected Readonly _graphqlSchemaManager

Protected Optional _type

Protected Readonly dataSourceWrapper

Protected Readonly graphqlSchemaManager

logger

Methods

addIdp

Returns

Parameters

datasourceWrapper: DataSourceWrapper

data: TraitDataObject<unknown, Record<string, any>, Promise<any>>

Returns Promise<CognitoOperationResult>

Private checkUserRole

Throws

Parameters

traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>

Returns Promise<void>

cognitoSendWelcomeEmail

Returns

Parameters

datasourceWrapper: DataSourceWrapper

data: TraitDataObject<unknown, Record<string, any>, Promise<any>>

Returns Promise<CognitoOperationResult>

disableMFA

Returns

Parameters

datasourceWrapper: DataSourceWrapper

data: TraitDataObject<unknown, Record<string, any>, Promise<any>>

Returns Promise<CognitoOperationResult>

enableMFA

Returns

Parameters

datasourceWrapper: DataSourceWrapper

data: TraitDataObject<unknown, Record<string, any>, Promise<any>>

Returns Promise<CognitoOperationResult>

hookIntoSchema

Parameters

schemaItem: SchemaItem<SchemaItemType>

Returns void

hookIntoSchemaManager

Returns void

makeGlobal

Returns CognitoTrait

name

Returns string

postCreate

Parameters

traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>

item: ItemWithId

legacyDatasourceWrapper: DataSourceWrapper

context: KosmosUserContext<object>

Returns Promise<void>

postDelete

Parameters

_traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>

item: ItemWithId

_legacyDatasourceWrapper: DataSourceWrapper

context: KosmosUserContext<object>

`Protected` _access

`Protected` _cognito

`Protected` `Optional` _config

`Protected` _global

`Protected` `Readonly` _graphqlSchemaManager

`Protected` `Optional` _type

`Protected` `Readonly` dataSourceWrapper

`Protected` `Readonly` graphqlSchemaManager

`Private` checkUserRole

`Private` userContextHasCognitoIss

`Optional` callbackName: string

`Static` traitTypeName