Class ReadReportingBehaviour

Read Reporting Behaviour adds readReported/removes readReported functionality.

Usage (config.yml):

behaviours:
  - type: readReporting

Hierarchy

BehaviourBase<"read_reporting", ReadReportingBehaviourKosmosConfig, ReadReportingBehaviourInstanceConfig>
- ReadReportingBehaviour

Constructors

constructor

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

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` addReadReporting

addReadReporting(vertexLabel: string, entityId: string, context: KosmosUserContext<object>, traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, userId?: string): Promise<void>
Adds Read Report 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/ReadReportingBehaviour.ts:557

`Private` addReadReportingResolver

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

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

`Private` countReadReports

countReadReports(tenant: string, vertexLabel: string, entityId: string): Promise<number>
Counts Read Reports for a given entity.

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

`Private` getReadReportUuid

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

Returns
Read Report 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/ReadReportingBehaviour.ts:526

`Private` getReadReportsListType

getReadReportsListType(label: string): {
    name: string;
    schema: string;
    types: any[];
}
Parameters
- label: string
Returns {
    name: string;
    schema: string;
    types: any[];
}
- name: string
- schema: string
- types: any[]
- Defined in src/behaviours/classes/ReadReportingBehaviour.ts:606

`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/ReadReportingBehaviour.ts:447

hookIntoSchema

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

lazyInit

lazyInit(__namedParameters: RuntimeInitParameters<"read_reporting", ReadReportingBehaviourInstanceConfig>): 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<"read_reporting", ReadReportingBehaviourInstanceConfig>
Returns Promise<void>
Inherited from BehaviourBase.lazyInit
- Defined in src/behaviours/BehaviourBase.ts:176

`Private` readReportListResolver

readReportListResolver(...__namedParameters: [schemaItem: SchemaItem<"vertex">, entityType: string, instance: ReadReportingBehaviourInstanceConfig, params: [source: null, args: ReadReportedListArgs, context: KosmosUserContext<object>, info: GraphQLResolveInfo]]): Promise<any>
Parameters
- Rest ...__namedParameters: [schemaItem: SchemaItem<"vertex">, entityType: string, instance: ReadReportingBehaviourInstanceConfig, params: [source: null, args: ReadReportedListArgs, context: KosmosUserContext<object>, info: GraphQLResolveInfo]]
Returns Promise<any>
- Defined in src/behaviours/classes/ReadReportingBehaviour.ts:379

`Private` readReportedByQuery

readReportedByQuery(dataSourceWrapper: DataSourceWrapper, data: any): Promise<TraitGraphQuery<any>>
Parameters
- dataSourceWrapper: DataSourceWrapper
- data: any
Returns Promise<TraitGraphQuery<any>>
- Defined in src/behaviours/classes/ReadReportingBehaviour.ts:217

`Private` readReportedConnectionResolver

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

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

`Private` readReportedListQuery

readReportedListQuery(context: KosmosUserContext<object>, schemaItem: SchemaItem<SchemaItemType>): Promise<TraitGraphQuery<any>>
Returns query for getting list read reported items
Parameters
- context: KosmosUserContext<object>
  
  user context
- schemaItem: SchemaItem<SchemaItemType>
  
  schema item of bookmarked entity
Returns Promise<TraitGraphQuery<any>>
- Defined in src/behaviours/classes/ReadReportingBehaviour.ts:280

`Private` readReportedResolver

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

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

`Private` readReportsCount

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

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

`Private` removeReadReporting

removeReadReporting(vertexLabel: string, entityId: string, context: KosmosUserContext<object>, traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, userId?: string): Promise<void>
Removes Read Report 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/ReadReportingBehaviour.ts:587

`Private` removeReadReportingResolver

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

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

`Private` userReadReportsContent

userReadReportsContent(user: string, tenant: string, vertexLabel: string, entityId: string): Promise<boolean>
Checks if user has reported read the content.

Returns
Whether user reports has read 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/ReadReportingBehaviour.ts:504

validateBehaviourConfig

validateBehaviourConfig(config: InstanceConfig<any>): config is InstanceConfig<"read_reporting">
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<"read_reporting">
Overrides BehaviourBase.validateBehaviourConfig
- Defined in src/behaviours/classes/ReadReportingBehaviour.ts:105

validateKosmosConfig

validateKosmosConfig(config: KosmosConfig<any>): config is KosmosConfig<"read_reporting">
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<"read_reporting">
Overrides BehaviourBase.validateKosmosConfig
- Defined in src/behaviours/classes/ReadReportingBehaviour.ts:112

Class ReadReportingBehaviour

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

graphQlSchemaManager: GraphQLSchemaManager

dataSourceWrapper: DataSourceWrapper

g: GraphTraversalSource<GraphTraversal>

_schemaManager: SchemaManager

Returns ReadReportingBehaviour

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 addReadReporting

Parameters

vertexLabel: string

entityId: string

context: KosmosUserContext<object>

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

Optional userId: string

Returns Promise<void>

Private addReadReportingResolver

Parameters

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

Returns Promise<null | ItemWithId>

Private countReadReports

Returns

Parameters

tenant: string

vertexLabel: string

entityId: string

Returns Promise<number>

Private getReadReportUuid

Returns

Parameters

userId: string

tenant: string

vertexLabel: string

entityId: string

Returns Promise<null | string>

Private getReadReportsListType

Parameters

label: string

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

name: string

schema: string

types: any[]

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<ReadReportingBehaviourInstanceConfig, any, Record<string, any>, Promise<any>>

Returns void

lazyInit

Parameters

__namedParameters: RuntimeInitParameters<"read_reporting", ReadReportingBehaviourInstanceConfig>

Returns Promise<void>

Private readReportListResolver

Parameters

`Private` `Readonly` _schemaManager

`Private` `Readonly` dataSourceWrapper

`Private` `Readonly` g

`Private` `Readonly` graphQlSchemaManager

`Private` addReadReporting

`Optional` userId: string

`Private` addReadReportingResolver

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

`Private` countReadReports

`Private` getReadReportUuid

`Private` getReadReportsListType

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

`Private` getTraitDataObject

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

`Private` readReportListResolver

`Rest` ...__namedParameters: [schemaItem: SchemaItem<"vertex">, entityType: string, instance: ReadReportingBehaviourInstanceConfig, params: [source: null, args: ReadReportedListArgs, context: KosmosUserContext<object>, info: GraphQLResolveInfo]]

`Private` readReportedByQuery

`Private` readReportedConnectionResolver

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

`Private` readReportedListQuery

`Private` readReportedResolver

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

`Private` readReportsCount

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

`Private` removeReadReporting

`Optional` userId: string

`Private` removeReadReportingResolver

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

`Private` userReadReportsContent