Class BookmarkBehaviour

The base Behaviour class.

Mermaid

Behaviour life cycle / configuration flow

%%{init:{"theme":"dark"}}%% sequenceDiagram actor User participant IoC participant Kosmos config participant GraphQL participant BehaviourTrait participant Behaviour participant BehaviourInstanceManager IoC->>Kosmos config: Reads config Kosmos config->>IoC: List of available Behaviours and their Kosmos configs loop All available behaviours Note over IoC,Behaviour: Configurations are tenant and content type agnostic IoC->>Behaviour: Instantiate and pass in KosmosConfig end loop Handling requests User->>GraphQL: GraphQL query calling Behaviour GraphQL->>BehaviourTrait: Calls Behaviour wrapper BehaviourTrait->>BehaviourInstanceManager: Retrieve Behaviour instance config opt Missing config/instance BehaviourInstanceManager->>BehaviourTrait: Error BehaviourTrait->>GraphQL: Error GraphQL->>User: Error end BehaviourInstanceManager->>BehaviourTrait: Behaviour instance config BehaviourTrait->>Behaviour: Executes resolver, passing in context, args and instance config Behaviour->>BehaviourTrait: Response BehaviourTrait->>GraphQL: Response GraphQL->>User: Response end

%%{init:{"theme":"default"}}%% sequenceDiagram actor User participant IoC participant Kosmos config participant GraphQL participant BehaviourTrait participant Behaviour participant BehaviourInstanceManager IoC->>Kosmos config: Reads config Kosmos config->>IoC: List of available Behaviours and their Kosmos configs loop All available behaviours Note over IoC,Behaviour: Configurations are tenant and content type agnostic IoC->>Behaviour: Instantiate and pass in KosmosConfig end loop Handling requests User->>GraphQL: GraphQL query calling Behaviour GraphQL->>BehaviourTrait: Calls Behaviour wrapper BehaviourTrait->>BehaviourInstanceManager: Retrieve Behaviour instance config opt Missing config/instance BehaviourInstanceManager->>BehaviourTrait: Error BehaviourTrait->>GraphQL: Error GraphQL->>User: Error end BehaviourInstanceManager->>BehaviourTrait: Behaviour instance config BehaviourTrait->>Behaviour: Executes resolver, passing in context, args and instance config Behaviour->>BehaviourTrait: Response BehaviourTrait->>GraphQL: Response GraphQL->>User: Response end

sequenceDiagram
    actor User
    participant IoC
    participant Kosmos config
    participant GraphQL
    participant BehaviourTrait
    participant Behaviour
    participant BehaviourInstanceManager
    IoC->>Kosmos config: Reads config
    Kosmos config->>IoC: List of available Behaviours and their Kosmos configs
    loop All available behaviours
        Note over IoC,Behaviour: Configurations are tenant and content type agnostic
        IoC->>Behaviour: Instantiate and pass in KosmosConfig
    end
    loop Handling requests
        User->>GraphQL: GraphQL query calling Behaviour
        GraphQL->>BehaviourTrait: Calls Behaviour wrapper
        BehaviourTrait->>BehaviourInstanceManager: Retrieve Behaviour instance config
        opt Missing config/instance
            BehaviourInstanceManager->>BehaviourTrait: Error
            BehaviourTrait->>GraphQL: Error
            GraphQL->>User: Error
        end
        BehaviourInstanceManager->>BehaviourTrait: Behaviour instance config
        BehaviourTrait->>Behaviour: Executes resolver, passing in context, args and instance config
        Behaviour->>BehaviourTrait: Response
        BehaviourTrait->>GraphQL: Response
        GraphQL->>User: Response
    end

Hierarchy

BehaviourBase<"bookmark", BookmarkBehaviourKosmosConfig, BookmarkBehaviourInstanceConfig>
- BookmarkBehaviour

Constructors

constructor

new BookmarkBehaviour(graphQlSchemaManager: GraphQLSchemaManager, dataSourceWrapper: DataSourceWrapper, graphHandler: GraphHandler, accessControl: AccessControl, g: GraphTraversalSource<GraphTraversal>): BookmarkBehaviour
Parameters
- graphQlSchemaManager: GraphQLSchemaManager
- dataSourceWrapper: DataSourceWrapper
- graphHandler: GraphHandler
- accessControl: AccessControl
- g: GraphTraversalSource<GraphTraversal>
Returns BookmarkBehaviour
Overrides BehaviourBase.constructor
- Defined in src/behaviours/classes/BookmarkBehaviour.ts:65

Properties

`Private` `Readonly` accessControl

accessControl: AccessControl

`Private` `Readonly` dataSourceWrapper

dataSourceWrapper: DataSourceWrapper

`Private` `Readonly` g

g: GraphTraversalSource<GraphTraversal>

`Private` `Readonly` graphHandler

graphHandler: GraphHandler

`Private` `Readonly` graphQlSchemaManager

graphQlSchemaManager: GraphQLSchemaManager

`Private` `Optional` schemaItem

schemaItem?: SchemaItem<SchemaItemType>

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

addEntityBookmarkResolver(...__namedParameters: [schemaItem: SchemaItem<"vertex">, entityType: string, instance: BookmarkBehaviourInstanceConfig, params: [source: null, args: ItemWithId, context: KosmosUserContext<object>, info: GraphQLResolveInfo]]): Promise<null | ItemWithId>
Add bookmark mutation resolver
Parameters
- Rest ...__namedParameters: [schemaItem: SchemaItem<"vertex">, entityType: string, instance: BookmarkBehaviourInstanceConfig, params: [source: null, args: ItemWithId, context: KosmosUserContext<object>, info: GraphQLResolveInfo]]
Returns Promise<null | ItemWithId>
- Defined in src/behaviours/classes/BookmarkBehaviour.ts:188

`Private` bookmarkListQuery

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

`Private` bookmarkedResolver

bookmarkedResolver(...__namedParameters: [schemaItem: SchemaItem<"vertex">, entityType: string, instance: BookmarkBehaviourInstanceConfig, params: [source: ItemWithId, args: null, context: KosmosUserContext<object>, info: GraphQLResolveInfo]]): Promise<boolean>
Bookmarked property resolver
Parameters
- Rest ...__namedParameters: [schemaItem: SchemaItem<"vertex">, entityType: string, instance: BookmarkBehaviourInstanceConfig, params: [source: ItemWithId, args: null, context: KosmosUserContext<object>, info: GraphQLResolveInfo]]
Returns Promise<boolean>
- Defined in src/behaviours/classes/BookmarkBehaviour.ts:291

`Private` bookmarksListResolver

bookmarksListResolver(...__namedParameters: [schemaItem: SchemaItem<"vertex">, entityType: string, instance: BookmarkBehaviourInstanceConfig, params: [source: null, args: BookmarksListArgs, context: KosmosUserContext<object>, info: GraphQLResolveInfo]]): Promise<any>
List of bookmarked items resolver
Parameters
- Rest ...__namedParameters: [schemaItem: SchemaItem<"vertex">, entityType: string, instance: BookmarkBehaviourInstanceConfig, params: [source: null, args: BookmarksListArgs, context: KosmosUserContext<object>, info: GraphQLResolveInfo]]
Returns Promise<any>
- Defined in src/behaviours/classes/BookmarkBehaviour.ts:274

`Private` findBookmarkedEdge

findBookmarkedEdge(context: KosmosUserContext<object>, bookmarkedEntity: string): Promise<{
done: boolean;
value: ConnectionItem<ItemWithIdAndLabel, ItemWithIdAndLabel>;
}>
Returns bookmark edge between user and target entity

Returns
edge
Parameters
- context: KosmosUserContext<object>
  
  user context
- bookmarkedEntity: string
  
  entity uuid
Returns Promise<{
done: boolean;
value: ConnectionItem<ItemWithIdAndLabel, ItemWithIdAndLabel>;
}>
- Defined in src/behaviours/classes/BookmarkBehaviour.ts:321

`Private` getBookmarkListType

getBookmarkListType(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/BookmarkBehaviour.ts:354

`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/BookmarkBehaviour.ts:336

hookIntoSchema

hookIntoSchema(schemaItem: SchemaItem<SchemaItemType>, resolverWrapper: BehaviourResolverWrapper<BookmarkBehaviourInstanceConfig, any, Record<string, any>, Promise<any>>): void
Parameters
- schemaItem: SchemaItem<SchemaItemType>
- resolverWrapper: BehaviourResolverWrapper<BookmarkBehaviourInstanceConfig, any, Record<string, any>, Promise<any>>
Returns void
Overrides BehaviourBase.hookIntoSchema
- Defined in src/behaviours/classes/BookmarkBehaviour.ts:100

lazyInit

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

`Private` removeEntityBookmarkResolver

removeEntityBookmarkResolver(...__namedParameters: [schemaItem: SchemaItem<"vertex">, entityType: string, instance: BookmarkBehaviourInstanceConfig, params: [source: null, args: ItemWithId, context: KosmosUserContext<object>, info: GraphQLResolveInfo]]): Promise<null | ItemWithId>
Remove bookmark mutation resolver
Parameters
- Rest ...__namedParameters: [schemaItem: SchemaItem<"vertex">, entityType: string, instance: BookmarkBehaviourInstanceConfig, params: [source: null, args: ItemWithId, context: KosmosUserContext<object>, info: GraphQLResolveInfo]]
Returns Promise<null | ItemWithId>
- Defined in src/behaviours/classes/BookmarkBehaviour.ts:237

validateBehaviourConfig

validateBehaviourConfig(config: InstanceConfig<any>): config is BookmarkBehaviourInstanceConfig
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 BookmarkBehaviourInstanceConfig
Overrides BehaviourBase.validateBehaviourConfig
- Defined in src/behaviours/classes/BookmarkBehaviour.ts:84

validateKosmosConfig

validateKosmosConfig(config: KosmosConfig<any>): config is BookmarkBehaviourKosmosConfig
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 BookmarkBehaviourKosmosConfig
Overrides BehaviourBase.validateKosmosConfig
- Defined in src/behaviours/classes/BookmarkBehaviour.ts:80

`Static` `Private` addBookmarkMutationName

addBookmarkMutationName(label: string): string
Parameters
- label: string
Returns string
- Defined in src/behaviours/classes/BookmarkBehaviour.ts:92

`Static` `Private` getBookmarksListResolverName

getBookmarksListResolverName(label: string): string
Parameters
- label: string
Returns string
- Defined in src/behaviours/classes/BookmarkBehaviour.ts:88

`Static` `Private` removeBookmarkMutationName

removeBookmarkMutationName(label: string): string
Parameters
- label: string
Returns string
- Defined in src/behaviours/classes/BookmarkBehaviour.ts:96

Class BookmarkBehaviour

Mermaid

Behaviour life cycle / configuration flow

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

graphQlSchemaManager: GraphQLSchemaManager

dataSourceWrapper: DataSourceWrapper

graphHandler: GraphHandler

accessControl: AccessControl

g: GraphTraversalSource<GraphTraversal>

Returns BookmarkBehaviour

Properties

Private Readonly accessControl

Private Readonly dataSourceWrapper

Private Readonly g

Private Readonly graphHandler

Private Readonly graphQlSchemaManager

Private Optional schemaItem

Accessors

kosmosConfig

Returns TKosmosConfig

Parameters

value: KosmosConfig<any>

Returns void

machineName

Returns TName

Methods

Private addEntityBookmarkResolver

Parameters

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

Returns Promise<null | ItemWithId>

Private bookmarkListQuery

Parameters

context: KosmosUserContext<object>

schemaItem: SchemaItem<SchemaItemType>

Returns Promise<TraitGraphQuery<any>>

Private bookmarkedResolver

Parameters

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

Returns Promise<boolean>

Private bookmarksListResolver

Parameters

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

Returns Promise<any>

Private findBookmarkedEdge

Returns

Parameters

context: KosmosUserContext<object>

bookmarkedEntity: string

Returns Promise<{ done: boolean; value: ConnectionItem<ItemWithIdAndLabel, ItemWithIdAndLabel>; }>

Private getBookmarkListType

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

Parameters

schemaItem: SchemaItem<SchemaItemType>

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

Returns void

lazyInit

Parameters

__namedParameters: RuntimeInitParameters<"bookmark", BookmarkBehaviourInstanceConfig>

Returns Promise<void>

Private removeEntityBookmarkResolver

Parameters

`Private` `Readonly` accessControl

`Private` `Readonly` dataSourceWrapper

`Private` `Readonly` g

`Private` `Readonly` graphHandler

`Private` `Readonly` graphQlSchemaManager

`Private` `Optional` schemaItem

`Private` addEntityBookmarkResolver

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

`Private` bookmarkListQuery

`Private` bookmarkedResolver

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

`Private` bookmarksListResolver

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

`Private` findBookmarkedEdge

Returns Promise<{
done: boolean;
value: ConnectionItem<ItemWithIdAndLabel, ItemWithIdAndLabel>;
}>

`Private` getBookmarkListType

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

`Private` getTraitDataObject

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

`Private` removeEntityBookmarkResolver

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

`Static` `Private` addBookmarkMutationName

`Static` `Private` getBookmarksListResolverName

`Static` `Private` removeBookmarkMutationName