Class FeedsTrait

Feed Trait adds global GraphQL Feeds query field listing user's feed messages.

Usage:

traits:
  - type: feed
    sources:
      - Manual

The 'sources' configuration option specifies which entity types may be be referenced by an feed message. These will be used to build the FeedSource 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<FeedTraitConfig>
- FeedsTrait

Constructors

constructor

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

Properties

`Protected` `Optional` _config

_config?: FeedTraitConfig

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?: "feed"

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: FeedTraitConfig, _schemaManager: SchemaManager, unions: SchemaUnion[]): {
name: string;
types: string[];
}[]
Implements alterUnions.

Adds a FeedSource union with all the possible feed source types defined in the trait configuration.

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: FeedTraitConfig
- _schemaManager: SchemaManager
- unions: SchemaUnion[]
Returns {
name: string;
types: string[];
}[]
- Defined in src/traits/FeedTrait.ts:328

getEntity

getEntity(parent: FeedItem, _args: Record<string, any>, context: KosmosUserContext<object>): Promise<null | ItemWithId>
GraphQL resolver to get an entity object from the entity_id and entity_type properties.
Parameters
- parent: FeedItem
- _args: Record<string, any>
- context: KosmosUserContext<object>
Returns Promise<null | ItemWithId>
- Defined in src/traits/FeedTrait.ts:234

getGroup

getGroup(parent: FeedItem, _args: Record<string, any>, context: KosmosUserContext<object>): Promise<null | ItemWithId>
GraphQL resolver to get entity from optional variables group_uuid and group_label
Parameters
- parent: FeedItem
- _args: Record<string, any>
- context: KosmosUserContext<object>
Returns Promise<null | ItemWithId>
- Defined in src/traits/FeedTrait.ts:258

getUser

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

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/FeedTrait.ts:343

hookIntoSchemaManager

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

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

listFeedItems

listFeedItems(_parent: unknown, args: Record<string, any>, context: KosmosUserContext<object>): Promise<FeedGraphQLResult>
GraphQL resolver to list the user's feed messages.
Parameters
- _parent: unknown
- args: Record<string, any>
- context: KosmosUserContext<object>
Returns Promise<FeedGraphQLResult>
- Defined in src/traits/FeedTrait.ts:126

makeGlobal

makeGlobal(): FeedsTrait
Makes this Trait instance global.

Returns FeedsTrait
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/FeedTrait.ts:306

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 feed 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/FeedTrait.ts:114

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/FeedTrait.ts:291

setConfig

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

traitConfig

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

updateLastReadCursor

updateLastReadCursor(_parent: unknown, args: Record<string, any>, context: KosmosUserContext<object>): Promise<boolean>
GraphQL mutation resolver to update the last read position of the user's feed.
Parameters
- _parent: unknown
- args: Record<string, any>
- context: KosmosUserContext<object>
Returns Promise<boolean>
- Defined in src/traits/FeedTrait.ts:191

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/FeedTrait.ts:95

Class FeedsTrait

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

graphqlSchemaManager: GraphQLSchemaManager

dataSourceWrapper: DataSourceWrapper

db: NoSQLDatabase

config: RuntimeConfig

schemaManager: SchemaManager

Returns FeedsTrait

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: FeedTraitConfig

_schemaManager: SchemaManager

unions: SchemaUnion[]

Returns { name: string; types: string[]; }[]

getEntity

Parameters

parent: FeedItem

_args: Record<string, any>

context: KosmosUserContext<object>

Returns Promise<null | ItemWithId>

getGroup

Parameters

parent: FeedItem

_args: Record<string, any>

context: KosmosUserContext<object>

Returns Promise<null | ItemWithId>

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

listFeedItems

Parameters

_parent: unknown

args: Record<string, any>

context: KosmosUserContext<object>

Returns Promise<FeedGraphQLResult>

makeGlobal

Returns FeedsTrait

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

`Protected` `Optional` _config

`Protected` _global

`Optional` _relationship

`Protected` `Optional` _type

`Protected` config

`Private` dataSourceWrapper

`Private` db

`Private` graphqlSchemaManager

`Private` schemaManager

Returns {
name: string;
types: string[];
}[]

`Optional` relationship: null | object

`Optional` callbackName: string

`Static` traitTypeName