Skip to main content

Class: ModuleCatalogController

Defined in: Controllers/ModuleCatalogController.ts:13

Module Catalog Controller Manages module catalog sources and catalog operations. A 'catalog' is an online or local source of downloadable modules, distinct from the data-access Repository pattern.

Constructors​

Constructor​

new ModuleCatalogController(mainDb, repositoryService): ModuleCatalogController

Defined in: Controllers/ModuleCatalogController.ts:16

Parameters​

mainDb​

ISql

repositoryService​

IModuleCatalogService

Returns​

ModuleCatalogController

Methods​

addRepository()​

addRepository(name, url, type, abbreviation?): Promise<ModuleCatalog>

Defined in: Controllers/ModuleCatalogController.ts:49

Add a new repository

Parameters​

name​

string

url​

string

type​

CatalogSourceType

abbreviation?​

string

Returns​

Promise<ModuleCatalog>

getCatalog()​

getCatalog(repositoryId): RepositoryCatalog | undefined

Defined in: Controllers/ModuleCatalogController.ts:122

Get catalog for a repository

Parameters​

repositoryId​

number

Returns​

RepositoryCatalog | undefined

getEnabledRepositories()​

getEnabledRepositories(): ModuleCatalog[]

Defined in: Controllers/ModuleCatalogController.ts:35

Get enabled repositories. An enabled catalog is included in module discovery and refresh operations. Disabling a catalog hides its modules from the UI without deleting the entry.

Returns​

ModuleCatalog[]

getOfficialRepository()​

getOfficialRepository(): ModuleCatalog | undefined

Defined in: Controllers/ModuleCatalogController.ts:156

Get official repository

Returns​

ModuleCatalog | undefined

getRepositories()​

getRepositories(): ModuleCatalog[]

Defined in: Controllers/ModuleCatalogController.ts:26

Get all repositories

Returns​

ModuleCatalog[]

getRepositoriesNeedingRefresh()​

getRepositoriesNeedingRefresh(thresholdDays?): ModuleCatalog[]

Defined in: Controllers/ModuleCatalogController.ts:136

Get repositories that need refresh

Parameters​

thresholdDays?​

number = 7

Returns​

ModuleCatalog[]

getRepository()​

getRepository(repositoryId): ModuleCatalog | undefined

Defined in: Controllers/ModuleCatalogController.ts:42

Get repository by ID

Parameters​

repositoryId​

number

Returns​

ModuleCatalog | undefined

refreshAllCatalogs()​

refreshAllCatalogs(): Promise<ModuleCatalog[]>

Defined in: Controllers/ModuleCatalogController.ts:115

Refresh all enabled repository catalogs

Returns​

Promise<ModuleCatalog[]>

refreshCatalog()​

refreshCatalog(repositoryId): Promise<ModuleCatalog>

Defined in: Controllers/ModuleCatalogController.ts:108

Refresh repository catalog

Parameters​

repositoryId​

number

Returns​

Promise<ModuleCatalog>

removeRepository()​

removeRepository(repositoryId): boolean

Defined in: Controllers/ModuleCatalogController.ts:88

Remove a repository

Parameters​

repositoryId​

number

Returns​

boolean

setRepositoryEnabled()​

setRepositoryEnabled(repositoryId, enabled): void

Defined in: Controllers/ModuleCatalogController.ts:101

Enable or disable a repository

Parameters​

repositoryId​

number

enabled​

boolean

Returns​

void

updateRepository()​

updateRepository(repository): ModuleCatalog

Defined in: Controllers/ModuleCatalogController.ts:129

Update a repository's properties

Parameters​

repository​

ModuleCatalog

Returns​

ModuleCatalog

updateRepositoryPriority()​

updateRepositoryPriority(repositoryId, priority): void

Defined in: Controllers/ModuleCatalogController.ts:143

Update repository priority

Parameters​

repositoryId​

number

priority​

number

Returns​

void