Class InboxTrait

Inbox Trait adds global GraphQL Inbox query field listing user's notifications.

Usage:

traits:
  - type: inbox
    sources:
      - User

The 'sources' configuration option specifies which entity types may be be referenced by an inbox notification. These will be used to build the NotificationSource union type. If omitted, the entity type to which the trait is attached will be used (normally this should be the User entity).

Hierarchy

Trait<InboxTraitConfig>
- InboxTrait

Implements

TraitAlterUnions<InboxTraitConfig>

Constructors

constructor

new InboxTrait(graphqlSchemaManager: GraphQLSchemaManager, dataSourceWrapper: DataSourceWrapper, db: NoSQLDatabase, config: RuntimeConfig, schemaManager: SchemaManager): InboxTrait
Parameters
- graphqlSchemaManager: GraphQLSchemaManager
- dataSourceWrapper: DataSourceWrapper
- db: NoSQLDatabase
- config: RuntimeConfig
- schemaManager: SchemaManager
Returns InboxTrait
Overrides Trait.constructor
- Defined in src/traits/InboxTrait.ts:103

Properties

`Protected` `Optional` _config

_config?: InboxTraitConfig

Trait instance configuration.

`Protected` _global

_global: boolean = false

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

`Optional` _relationship

_relationship?: null | object

`Protected` `Optional` _type

_type?: "inbox"

Trait type.

`Protected` config

config: RuntimeConfig

`Private` dataSourceWrapper

dataSourceWrapper: DataSourceWrapper

`Private` db

db: NoSQLDatabase

`Private` graphqlSchemaManager

graphqlSchemaManager: GraphQLSchemaManager

logger

logger: Logger

`Private` schemaManager

schemaManager: SchemaManager

tableName

tableName: string

Methods

alterUnions

alterUnions(type: SchemaItemType, conf: InboxTraitConfig, _schemaManager: SchemaManager, unions: SchemaUnion[]): SchemaUnion[]
Implements alterUnions.

Adds a NotificationSource union with all the possible notification source types defined in the trait configuration, and an additional MissingEntity type for notifications that relate to deleted entities.

Note that enabling this trait on multiple schema types is not supported, and doing so will cause the union to be declared multiple times.
Parameters
- type: SchemaItemType
- conf: InboxTraitConfig
- _schemaManager: SchemaManager
- unions: SchemaUnion[]
Returns SchemaUnion[]
Implementation of TraitAlterUnions.alterUnions
- Defined in src/traits/InboxTrait.ts:369

getEntity

getEntity(parent: InboxMessage, _args: Record<string, any>, context: KosmosUserContext<object>): Promise<ItemWithId | {
id: string;
label: string;
}>
GraphQL resolver to get an entity object from the entity_id and entity_type properties.
Parameters
- parent: InboxMessage
- _args: Record<string, any>
- context: KosmosUserContext<object>
Returns Promise<ItemWithId | {
id: string;
label: string;
}>
- Defined in src/traits/InboxTrait.ts:167

getUser

getUser(parent: unknown, _args: Record<string, any>, context: KosmosUserContext<object>): Promise<null | ItemWithId>
GraphQL resolver to get a user object from the message_from UUID.
Parameters
- parent: unknown
- _args: Record<string, any>
- context: KosmosUserContext<object>
Returns Promise<null | ItemWithId>
- Defined in src/traits/InboxTrait.ts:149

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/InboxTrait.ts:384

hookIntoSchemaManager

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

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

listNotifications

listNotifications(_parent: unknown, args: Record<string, any>, context: KosmosUserContext<object>): Promise<InboxGraphQLResult>
GraphQL resolver to list the user's inbox messages.
Parameters
- _parent: unknown
- args: Record<string, any>
- context: KosmosUserContext<object>
Returns Promise<InboxGraphQLResult>
- Defined in src/traits/InboxTrait.ts:198

makeGlobal

makeGlobal(): InboxTrait
Makes this Trait instance global.

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

mutationSchema

mutationSchema(schemaString: string): string
This is where any GraphQL mutation entries that are rquired by the trait are added.

Returns
The GraphQL schema string, including our additions.
Parameters
- schemaString: string
  
  The original GraphQL schema string.
Returns string
- Defined in src/traits/InboxTrait.ts:344

name

name(): string
Used to return the name.

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

preDelete

preDelete(data: TraitDataObject<unknown, Record<string, any>, Promise<any>>, uuid: string, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>): Promise<void>
Use the preDelete hook to clean up the deleted user's inbox from DynamoDB.

Todo
Implement this.
Parameters
- data: TraitDataObject<unknown, Record<string, any>, Promise<any>>
  
  Used by traits for non user accessible entities
- uuid: string
  
  The UUID of vertex being deleted.
- datasourceWrapper: DataSourceWrapper
  
  Datasource wrapper object.
- context: KosmosUserContext<object>
  
  The context of the user on whose behalf the call is being made.
Returns Promise<void>
- Defined in src/traits/InboxTrait.ts:137

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

querySchemaGlobal

querySchemaGlobal(schemaString: string, _source: string, relationship?: null | object): string
This method is used to retrieve additions to the GraphQL schema and to register the callbacks associated to the Vertex.

Returns
- GraphQL schema with trait schema appended.
Parameters
- schemaString: string
  
  Existing GraphQL schema.
- _source: string
  
  String name of the source vertex that the trait is connected to (not used here)
- Optional relationship: null | object
  
  JSON Object of the relationship, can be null where trait is not attached to a relationship.
Returns string
- Defined in src/traits/InboxTrait.ts:329

setConfig

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

setReadStatus

setReadStatus(_parent: unknown, args: Record<string, any>, context: KosmosUserContext<object>): Promise<boolean>
GraphQL mutation resolver to mark a message as read or unread.

Since the read status is indexed in the partition key, we can't simply overwrite the data.status property in place - we must write a new record and delete the old one.
Parameters
- _parent: unknown
- args: Record<string, any>
- context: KosmosUserContext<object>
Returns Promise<boolean>
- Defined in src/traits/InboxTrait.ts:273

traitConfig

traitConfig(): InboxTraitConfig
Returns InboxTraitConfig
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/InboxTrait.ts:118

Class InboxTrait

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

graphqlSchemaManager: GraphQLSchemaManager

dataSourceWrapper: DataSourceWrapper

db: NoSQLDatabase

config: RuntimeConfig

schemaManager: SchemaManager

Returns InboxTrait

Properties

Protected Optional _config

Protected _global

Optional _relationship

Protected Optional _type

Protected config

Private dataSourceWrapper

Private db

Private graphqlSchemaManager

logger

Private schemaManager

tableName

Methods

alterUnions

Parameters

type: SchemaItemType

conf: InboxTraitConfig

_schemaManager: SchemaManager

unions: SchemaUnion[]

Returns SchemaUnion[]

getEntity

Parameters

parent: InboxMessage

_args: Record<string, any>

context: KosmosUserContext<object>

Returns Promise<ItemWithId | { id: string; label: string; }>

getUser

Parameters

parent: unknown

_args: Record<string, any>

context: KosmosUserContext<object>

Returns Promise<null | ItemWithId>

hookIntoSchema

Parameters

schemaItem: SchemaItem<SchemaItemType>

Returns void

hookIntoSchemaManager

Returns void

listNotifications

Parameters

_parent: unknown

args: Record<string, any>

context: KosmosUserContext<object>

Returns Promise<InboxGraphQLResult>

makeGlobal

Returns InboxTrait

mutationSchema

Returns

Parameters

schemaString: string

Returns string

name

Returns string

preDelete

Todo

Parameters

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

uuid: string

datasourceWrapper: DataSourceWrapper

context: KosmosUserContext<object>

Returns Promise<void>

process

Type Parameters

RT = any

`Protected` `Optional` _config

`Protected` _global

`Optional` _relationship

`Protected` `Optional` _type

`Protected` config

`Private` dataSourceWrapper

`Private` db

`Private` graphqlSchemaManager

`Private` schemaManager

Returns Promise<ItemWithId | {
id: string;
label: string;
}>

`Optional` relationship: null | object

`Optional` callbackName: string

`Static` traitTypeName