Class LikeBehaviour

Like Behaviour adds like/dislike functionality.

Usage (config.yml):

behaviours:
  - type: like

Hierarchy

BehaviourBase<"like", LikeBehaviourKosmosConfig, LikeBehaviourInstanceConfig>
- LikeBehaviour

Constructors

constructor

new LikeBehaviour(graphQlSchemaManager: GraphQLSchemaManager, dataSourceWrapper: DataSourceWrapper, g: GraphTraversalSource<GraphTraversal>, _schemaManager: SchemaManager): LikeBehaviour
Parameters
- graphQlSchemaManager: GraphQLSchemaManager
- dataSourceWrapper: DataSourceWrapper
- g: GraphTraversalSource<GraphTraversal>
- _schemaManager: SchemaManager
Returns LikeBehaviour
Overrides BehaviourBase.constructor
- Defined in src/behaviours/classes/LikeBehaviour.ts:76

Properties

`Private` `Readonly` _schemaManager

_schemaManager: SchemaManager

`Private` `Readonly` dataSourceWrapper

dataSourceWrapper: DataSourceWrapper

`Private` `Readonly` g

g: GraphTraversalSource<GraphTraversal>

`Private` `Readonly` graphQlSchemaManager

graphQlSchemaManager: GraphQLSchemaManager

Accessors

kosmosConfig

get kosmosConfig(): TKosmosConfig
Returns Kosmos-side configuration for this Behaviour.

Returns TKosmosConfig
Inherited from BehaviourBase.kosmosConfig
- Defined in src/behaviours/BehaviourBase.ts:131
set kosmosConfig(value: KosmosConfig<any>): void
Sets Kosmos-side configuration for this Behaviour.
Parameters
- value: KosmosConfig<any>
  
  The new configuration object.
Returns void
Inherited from BehaviourBase.kosmosConfig
- Defined in src/behaviours/BehaviourBase.ts:147

machineName

get machineName(): TName
Returns behaviour machine name.

Returns TName
Inherited from BehaviourBase.machineName
- Defined in src/behaviours/BehaviourBase.ts:159

Methods

`Private` addLike

addLike(vertexLabel: string, entityId: string, context: KosmosUserContext<object>, traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, userId?: string): Promise<void>
Adds Like of a given entity.
Parameters
- vertexLabel: string
  
  Entity type (vertex label).
- entityId: string
  
  Entity ID.
- context: KosmosUserContext<object>
  
  The user/request context.
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- Optional userId: string
  
  User ID override; if not given, will be taken from context.
Returns Promise<void>
- Defined in src/behaviours/classes/LikeBehaviour.ts:490

`Private` addLikeResolver

addLikeResolver(...params: [schemaItem: SchemaItem<"vertex">, entityType: string, instance: LikeBehaviourInstanceConfig, params: [source: null, args: {
id: string;
}, context: KosmosUserContext<object>, info: GraphQLResolveInfo]]): Promise<null | ItemWithId>
The addSomethingLike mutation resolver.

Refer AddRemoveLikeMutationResolver for arguments and return value types.
Parameters
- Rest ...params: [schemaItem: SchemaItem<"vertex">, entityType: string, instance: LikeBehaviourInstanceConfig, params: [source: null, args: {
  id: string;
  }, context: KosmosUserContext<object>, info: GraphQLResolveInfo]]
Returns Promise<null | ItemWithId>
- Defined in src/behaviours/classes/LikeBehaviour.ts:282

`Private` countLikes

countLikes(tenant: string, vertexLabel: string, entityId: string): Promise<number>
Counts Likes for a given entity.

Returns
The Likes count.
Parameters
- tenant: string
  
  Tenant ID.
- vertexLabel: string
  
  Entity type (vertex label).
- entityId: string
  
  Entity ID.
Returns Promise<number>
- Defined in src/behaviours/classes/LikeBehaviour.ts:408

`Private` getLikeUuid

getLikeUuid(userId: string, tenant: string, vertexLabel: string, entityId: string): Promise<null | string>
Retrieves UUID of Like of a given entity.

Returns
Like UUID or null if it doesn't exist.
Parameters
- userId: string
  
  User ID
- tenant: string
  
  Tenant ID.
- vertexLabel: string
  
  Entity type (vertex label).
- entityId: string
  
  Entity ID.
Returns Promise<null | string>
- Defined in src/behaviours/classes/LikeBehaviour.ts:459

`Private` getTraitDataObject

getTraitDataObject(schemaItem: SchemaItem<SchemaItemType>, ...__namedParameters: [source: unknown, args: Record<string, any>, context: KosmosUserContext<object>, info: GraphQLResolveInfo]): TraitDataObject<unknown, Record<string, any>, Promise<any>>
Construct trait data object from different objects
Parameters
- schemaItem: SchemaItem<SchemaItemType>
- Rest ...__namedParameters: [source: unknown, args: Record<string, any>, context: KosmosUserContext<object>, info: GraphQLResolveInfo]
Returns TraitDataObject<unknown, Record<string, any>, Promise<any>>
- Defined in src/behaviours/classes/LikeBehaviour.ts:380

hookIntoSchema

hookIntoSchema(schemaItem: SchemaItem<SchemaItemType>, resolverWrapper: BehaviourResolverWrapper<LikeBehaviourInstanceConfig, any, Record<string, any>, Promise<any>>): void
Inherit Doc
Parameters
- schemaItem: SchemaItem<SchemaItemType>
- resolverWrapper: BehaviourResolverWrapper<LikeBehaviourInstanceConfig, any, Record<string, any>, Promise<any>>
Returns void
Overrides BehaviourBase.hookIntoSchema
- Defined in src/behaviours/classes/LikeBehaviour.ts:106

lazyInit

lazyInit(__namedParameters: RuntimeInitParameters<"like", LikeBehaviourInstanceConfig>): Promise<void>
This method would be automatically before the first invocation of Behaviour for each entity type.

Behaviours may override this method, and it would be called once before each resolver.
Parameters
- __namedParameters: RuntimeInitParameters<"like", LikeBehaviourInstanceConfig>
Returns Promise<void>
Inherited from BehaviourBase.lazyInit
- Defined in src/behaviours/BehaviourBase.ts:176

`Private` likedByConnectionResolver

likedByConnectionResolver(...__namedParameters: [schemaItem: SchemaItem<"vertex">, entityType: string, instance: LikeBehaviourInstanceConfig, params: [source: ItemWithId, args: {}, context: KosmosUserContext<object>, info: GraphQLResolveInfo]]): Promise<any>
The likedByConnection field resolver.

Refer RetrieveLikedByConnectionResolver for arguments and return value types.
Parameters
- Rest ...__namedParameters: [schemaItem: SchemaItem<"vertex">, entityType: string, instance: LikeBehaviourInstanceConfig, params: [source: ItemWithId, args: {}, context: KosmosUserContext<object>, info: GraphQLResolveInfo]]
Returns Promise<any>
- Defined in src/behaviours/classes/LikeBehaviour.ts:212

`Private` likedByQuery

likedByQuery(dataSourceWrapper: DataSourceWrapper, data: any): Promise<TraitGraphQuery<any>>
Parameters
- dataSourceWrapper: DataSourceWrapper
- data: any
Returns Promise<TraitGraphQuery<any>>
- Defined in src/behaviours/classes/LikeBehaviour.ts:178

`Private` likedResolver

likedResolver(...__namedParameters: [schemaItem: SchemaItem<"vertex">, entityType: string, instance: LikeBehaviourInstanceConfig, params: [source: ItemWithId, args: {}, context: KosmosUserContext<object>, info: GraphQLResolveInfo]]): Promise<boolean>
The liked field resolver.

Refer RetrieveCurrentUserLikeResolver for arguments and return value types.
Parameters
- Rest ...__namedParameters: [schemaItem: SchemaItem<"vertex">, entityType: string, instance: LikeBehaviourInstanceConfig, params: [source: ItemWithId, args: {}, context: KosmosUserContext<object>, info: GraphQLResolveInfo]]
Returns Promise<boolean>
- Defined in src/behaviours/classes/LikeBehaviour.ts:259

`Private` likesCountResolver

likesCountResolver(...__namedParameters: [schemaItem: SchemaItem<"vertex">, entityType: string, instance: LikeBehaviourInstanceConfig, params: [source: ItemWithId, args: {}, context: KosmosUserContext<object>, info: GraphQLResolveInfo]]): Promise<number>
The likesCount field resolver.

Refer RetrieveLikesCountResolver for arguments and return value types.
Parameters
- Rest ...__namedParameters: [schemaItem: SchemaItem<"vertex">, entityType: string, instance: LikeBehaviourInstanceConfig, params: [source: ItemWithId, args: {}, context: KosmosUserContext<object>, info: GraphQLResolveInfo]]
Returns Promise<number>
- Defined in src/behaviours/classes/LikeBehaviour.ts:241

`Private` removeLike

removeLike(vertexLabel: string, entityId: string, context: KosmosUserContext<object>, traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, userId?: string): Promise<void>
Removes Like of a given entity.
Parameters
- vertexLabel: string
  
  Entity type (vertex label).
- entityId: string
  
  Entity ID.
- context: KosmosUserContext<object>
  
  The user/request context.
- traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- Optional userId: string
  
  User ID override; if not given, will be taken from context.
Returns Promise<void>
- Defined in src/behaviours/classes/LikeBehaviour.ts:520

`Private` removeLikeResolver

removeLikeResolver(...params: [schemaItem: SchemaItem<"vertex">, entityType: string, instance: LikeBehaviourInstanceConfig, params: [source: null, args: {
id: string;
}, context: KosmosUserContext<object>, info: GraphQLResolveInfo]]): Promise<null | ItemWithId>
The RemoveSomethingLike mutation resolver.

Refer AddRemoveLikeMutationResolver for arguments and return value types.
Parameters
- Rest ...params: [schemaItem: SchemaItem<"vertex">, entityType: string, instance: LikeBehaviourInstanceConfig, params: [source: null, args: {
  id: string;
  }, context: KosmosUserContext<object>, info: GraphQLResolveInfo]]
Returns Promise<null | ItemWithId>
- Defined in src/behaviours/classes/LikeBehaviour.ts:332

`Private` userLikesContent

userLikesContent(user: string, tenant: string, vertexLabel: string, entityId: string): Promise<boolean>
Checks if user likes content.

Returns
Whether user likes content.
Parameters
- user: string
  
  User ID.
- tenant: string
  
  Tenant ID.
- vertexLabel: string
  
  Entity type (vertex label).
- entityId: string
  
  Entity ID.
Returns Promise<boolean>
- Defined in src/behaviours/classes/LikeBehaviour.ts:437

validateBehaviourConfig

validateBehaviourConfig(config: InstanceConfig<any>): config is InstanceConfig<"like">
Validates runtime (e.g. ContentItem) configuration for this Behaviour.

Inherited classes may either return false for generic issues or throw BehaviourRuntimeError to return a specific error message.
Parameters
- config: InstanceConfig<any>
  
  The instance configuration value to check.
Returns config is InstanceConfig<"like">
Overrides BehaviourBase.validateBehaviourConfig
- Defined in src/behaviours/classes/LikeBehaviour.ts:92

validateKosmosConfig

validateKosmosConfig(config: KosmosConfig<any>): config is KosmosConfig<"like">
Validates Kosmos (e.g. build time) configuration for this Behaviour.

Inherited classes may either return false for generic issues or throw BehaviourConfigError to return a specific error message.
Parameters
- config: KosmosConfig<any>
  
  The Kosmos configuration value to check.
Returns config is KosmosConfig<"like">
Overrides BehaviourBase.validateKosmosConfig
- Defined in src/behaviours/classes/LikeBehaviour.ts:99

Class LikeBehaviour

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

graphQlSchemaManager: GraphQLSchemaManager

dataSourceWrapper: DataSourceWrapper

g: GraphTraversalSource<GraphTraversal>

_schemaManager: SchemaManager

Returns LikeBehaviour

Properties

Private Readonly _schemaManager

Private Readonly dataSourceWrapper

Private Readonly g

Private Readonly graphQlSchemaManager

Accessors

kosmosConfig

Returns TKosmosConfig

Parameters

value: KosmosConfig<any>

Returns void

machineName

Returns TName

Methods

Private addLike

Parameters

vertexLabel: string

entityId: string

context: KosmosUserContext<object>

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

Optional userId: string

Returns Promise<void>

Private addLikeResolver

Parameters

Rest ...params: [schemaItem: SchemaItem<"vertex">, entityType: string, instance: LikeBehaviourInstanceConfig, params: [source: null, args: { id: string; }, context: KosmosUserContext<object>, info: GraphQLResolveInfo]]

Returns Promise<null | ItemWithId>

Private countLikes

Returns

Parameters

tenant: string

vertexLabel: string

entityId: string

Returns Promise<number>

Private getLikeUuid

Returns

Parameters

userId: string

tenant: string

vertexLabel: string

entityId: string

Returns Promise<null | string>

Private getTraitDataObject

Parameters

schemaItem: SchemaItem<SchemaItemType>

Rest ...__namedParameters: [source: unknown, args: Record<string, any>, context: KosmosUserContext<object>, info: GraphQLResolveInfo]

Returns TraitDataObject<unknown, Record<string, any>, Promise<any>>

hookIntoSchema

Inherit Doc

Parameters

schemaItem: SchemaItem<SchemaItemType>

resolverWrapper: BehaviourResolverWrapper<LikeBehaviourInstanceConfig, any, Record<string, any>, Promise<any>>

Returns void

lazyInit

Parameters

__namedParameters: RuntimeInitParameters<"like", LikeBehaviourInstanceConfig>

Returns Promise<void>

Private likedByConnectionResolver

Parameters

Rest ...__namedParameters: [schemaItem: SchemaItem<"vertex">, entityType: string, instance: LikeBehaviourInstanceConfig, params: [source: ItemWithId, args: {}, context: KosmosUserContext<object>, info: GraphQLResolveInfo]]

Returns Promise<any>

Private likedByQuery

Parameters

dataSourceWrapper: DataSourceWrapper

data: any

Returns Promise<TraitGraphQuery<any>>

`Private` `Readonly` _schemaManager

`Private` `Readonly` dataSourceWrapper

`Private` `Readonly` g

`Private` `Readonly` graphQlSchemaManager

`Private` addLike

`Optional` userId: string

`Private` addLikeResolver

`Rest` ...params: [schemaItem: SchemaItem<"vertex">, entityType: string, instance: LikeBehaviourInstanceConfig, params: [source: null, args: {
id: string;
}, context: KosmosUserContext<object>, info: GraphQLResolveInfo]]

`Private` countLikes

`Private` getLikeUuid

`Private` getTraitDataObject

`Rest` ...__namedParameters: [source: unknown, args: Record<string, any>, context: KosmosUserContext<object>, info: GraphQLResolveInfo]

`Private` likedByConnectionResolver

`Rest` ...__namedParameters: [schemaItem: SchemaItem<"vertex">, entityType: string, instance: LikeBehaviourInstanceConfig, params: [source: ItemWithId, args: {}, context: KosmosUserContext<object>, info: GraphQLResolveInfo]]

`Private` likedByQuery

`Private` likedResolver

`Rest` ...__namedParameters: [schemaItem: SchemaItem<"vertex">, entityType: string, instance: LikeBehaviourInstanceConfig, params: [source: ItemWithId, args: {}, context: KosmosUserContext<object>, info: GraphQLResolveInfo]]

`Private` likesCountResolver

`Rest` ...__namedParameters: [schemaItem: SchemaItem<"vertex">, entityType: string, instance: LikeBehaviourInstanceConfig, params: [source: ItemWithId, args: {}, context: KosmosUserContext<object>, info: GraphQLResolveInfo]]

`Private` removeLike

`Optional` userId: string

`Private` removeLikeResolver

`Rest` ...params: [schemaItem: SchemaItem<"vertex">, entityType: string, instance: LikeBehaviourInstanceConfig, params: [source: null, args: {
id: string;
}, context: KosmosUserContext<object>, info: GraphQLResolveInfo]]

`Private` userLikesContent