Skip to main content

Class: ModuleCatalog

Defined in: Data/Models/Main/ModuleCatalog.ts:13

Module catalog entity from the main database. Represents a source for downloadable modules (distinct from the data-access Repository pattern).

Constructors​

Constructor​

new ModuleCatalog(data): ModuleCatalog

Defined in: Data/Models/Main/ModuleCatalog.ts:33

Parameters​

data​
abbreviation?​

string

catalogId?​

number

catalogJson?​

string

isEnabled?​

boolean

lastFetched?​

string

lastUpdated?​

string

metadata?​

Metadata

name​

string

priority?​

number

signatureStatus?​

CatalogSignatureStatus

signingPublicKey?​

string

type​

CatalogSourceType

url​

string

Returns​

ModuleCatalog

Properties​

abbreviation?​

optional abbreviation?: string

Defined in: Data/Models/Main/ModuleCatalog.ts:16

catalogId?​

optional catalogId?: number

Defined in: Data/Models/Main/ModuleCatalog.ts:14

catalogJson?​

optional catalogJson?: string

Defined in: Data/Models/Main/ModuleCatalog.ts:21

isEnabled​

isEnabled: boolean

Defined in: Data/Models/Main/ModuleCatalog.ts:19

lastFetched?​

optional lastFetched?: string

Defined in: Data/Models/Main/ModuleCatalog.ts:23

lastUpdated?​

optional lastUpdated?: string

Defined in: Data/Models/Main/ModuleCatalog.ts:22

metadata?​

optional metadata?: Metadata

Defined in: Data/Models/Main/ModuleCatalog.ts:24

name​

name: string

Defined in: Data/Models/Main/ModuleCatalog.ts:15

priority​

priority: number

Defined in: Data/Models/Main/ModuleCatalog.ts:20

signatureStatus?​

optional signatureStatus?: CatalogSignatureStatus

Defined in: Data/Models/Main/ModuleCatalog.ts:26

Result of verifying the detached signature on the last successful fetch.

signingPublicKey?​

optional signingPublicKey?: string

Defined in: Data/Models/Main/ModuleCatalog.ts:31

Hex Ed25519 public key that signed this catalog. Recorded on first use so a later key change can be detected (trust-on-first-use).

type​

type: CatalogSourceType

Defined in: Data/Models/Main/ModuleCatalog.ts:18

url​

url: string

Defined in: Data/Models/Main/ModuleCatalog.ts:17

Methods​

getDisplayName()​

getDisplayName(): string

Defined in: Data/Models/Main/ModuleCatalog.ts:74

Get the display name with abbreviation

Returns​

string

getParsedCatalog()​

getParsedCatalog(): RepositoryCatalog | undefined

Defined in: Data/Models/Main/ModuleCatalog.ts:104

Get the parsed catalog (if available)

Returns​

RepositoryCatalog | undefined

hasBeenSigned()​

hasBeenSigned(): boolean

Defined in: Data/Models/Main/ModuleCatalog.ts:67

Whether this catalog has ever served a valid signature. Once true, a subsequent unsigned fetch is treated as a downgrade attack.

Returns​

boolean

isOfficial()​

isOfficial(): boolean

Defined in: Data/Models/Main/ModuleCatalog.ts:84

Check if repository is official

Returns​

boolean

needsRefresh()​

needsRefresh(): boolean

Defined in: Data/Models/Main/ModuleCatalog.ts:91

Check if catalog needs refresh (older than 7 days)

Returns​

boolean

setCatalog()​

setCatalog(catalog): void

Defined in: Data/Models/Main/ModuleCatalog.ts:118

Set the catalog JSON (from object)

Parameters​

catalog​

RepositoryCatalog

Returns​

void