arlas-wui-toolkit / Exports / ArlasStartupService

Class: ArlasStartupService

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new ArlasStartupService(settingsService, configService, collaborativesearchService, injector, fetchOptions, getOptions, http, translateService, configUpdater, persistenceService, errorService, fetchInterceptorService)

Parameters

Name Type
settingsService ArlasSettingsService
configService ArlasConfigService
collaborativesearchService ArlasCollaborativesearchService
injector Injector
fetchOptions any
getOptions any
http HttpClient
translateService TranslateService
configUpdater any
persistenceService PersistenceService
errorService ErrorService
fetchInterceptorService FetchInterceptorService

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:150

Properties

analytics

analytics: { components: any[] ; groupId: string }[]

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:139


arlasExploreApi

arlasExploreApi: ArlasExploreApi

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:147


arlasIsUp

arlasIsUp: Subject<boolean>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:146


collectionId

collectionId: string

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:141


collectionsMap

collectionsMap: Map<string, CollectionReferenceParameters>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:140


configurationUpdaterService

configurationUpdaterService: ArlasConfigurationUpdaterService

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:148


contributorRegistry

contributorRegistry: Map<string, Contributor>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:136


emptyMode

emptyMode: boolean = false

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:138


errorStartUpServiceBus

errorStartUpServiceBus: Subject<any>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:145


selectorById

selectorById: string

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:142


shouldRunApp

shouldRunApp: boolean = true

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:137


temporalContributor

temporalContributor: string[]

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:143

Methods

applyAppSettings

applyAppSettings(): Promise<ArlasSettings>

  • Fetches and parses the settings.yaml.
  • Validates it against the correponding schema

Returns

Promise<ArlasSettings>

ARLAS settings object Promise

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:334


applyFGA

applyFGA(data): Promise<any>

Retrieves fields that are available for exploration and updates the configuration to keep only corresponding widgets and components

Parameters

Name Type Description
data any configuration object

Returns

Promise<any>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:302


authenticate

authenticate(settings): Promise<ArlasSettings>

if authentication is configured, trigger authentication service that redirects to login page if it's the first time and fetches the appropriate token

Parameters

Name Type Description
settings ArlasSettings ArlasSettings object

Returns

Promise<ArlasSettings>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:376


buildContributor

buildContributor(data): Promise<any>

Parameters

Name Type
data any

Returns

Promise<any>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:600


enrichHeaders

enrichHeaders(settings): Promise<ArlasSettings>

Enriches headers of calls sent to ARLAS-server & ARLAS-persistence

Parameters

Name Type
settings ArlasSettings

Returns

Promise<ArlasSettings>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:410


errorStartUp

errorStartUp(): void

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:168


getAppConfigurationObject

getAppConfigurationObject(settings): Promise<any>

  • Fetches the configuration file from ARLAS-persistence if it's configurated, otherwise fetches the config.json in "src" folder.
  • Validates the configuration against the corresponding schema

Parameters

Name Type Description
settings ArlasSettings Arlas Settings object

Returns

Promise<any>

ARLAS Configuration object Promise

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:457


getCollections

getCollections(data): Promise<any>

Parameters

Name Type
data any

Returns

Promise<any>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:549


getFGAService

getFGAService(): ArlasConfigurationUpdaterService

Returns

ArlasConfigurationUpdaterService

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:164


listAvailableFields

listAvailableFields(collectionNames): Promise<Set<string>>

Lists the fields of collectionName that are available for exploration with arlasExploreApi

Parameters

Name Type
collectionNames Set<string>

Returns

Promise<Set<string>>

available fields

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:576


load

load(): Promise<any>

Returns

Promise<any>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:677


loadExtraConfig

loadExtraConfig(extraConfig, data): Promise<any>

Loads extra configuration declared in the main configuration file.

Parameters

Name Type Description
extraConfig ExtraConfig This object specifies the path to the extra configuration file, the attribute to change in the main configuration file, and the attribute to take from the extra configuration file.
data Object Content of the extra configuration file

Returns

Promise<any>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:658


setCollaborativeService

setCollaborativeService(data): Promise<any>

Parameters

Name Type
data any

Returns

Promise<any>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:518


setConfigService

setConfigService(data): any

  • Sets the configuration object in ArlasConfigService.
  • Sets the ArlasConfigService instance in ArlasCollaborativeSearchService

Parameters

Name Type Description
data any configation object

Returns

any

the same configuration object

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:259


testArlasUp

testArlasUp(configData): Promise<any>

Parameters

Name Type
configData any

Returns

Promise<any>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:531


translationLoaded

translationLoaded(data): Promise<any>

Parameters

Name Type
data any

Returns

Promise<any>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:228


updateConfiguration

updateConfiguration(data, availableFields): any

Updates configuration by keeping only components/widgets that are availbale for exploration

Parameters

Name Type Description
data any configuration object
availableFields Set<string> list of fields that are available for exploration

Returns

any

the updated configuration object

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:284


validateConfiguration

validateConfiguration(data): Promise<any>

Parameters

Name Type
data any

Returns

Promise<any>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:193


validateSettings

validateSettings(settings): Promise<any>

Parameters

Name Type
settings any

Returns

Promise<any>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:173