craft-hub / PluginManager

Class: PluginManager

Defined in: packages/craft-hub/src/marketplace.ts:223

User-level marketplace and declarative plugin lifecycle manager.

Constructors

Constructor

new PluginManager(dataDir, builtinSources?, installer?, fetcher?, applicationVersion?): PluginManager

Defined in: packages/craft-hub/src/marketplace.ts:231

Parameters

dataDir

string

builtinSources?

MarketplaceSource[] = []

installer?

PluginPackageInstaller = ...

fetcher?

{(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

applicationVersion?

string = craftHubVersion

Returns

PluginManager

Properties

capabilityProvider

readonly capabilityProvider: CapabilityProvider

Defined in: packages/craft-hub/src/marketplace.ts:224

---

dataDir

readonly dataDir: string

Defined in: packages/craft-hub/src/marketplace.ts:232

Methods

addSource()

addSource(input): Promise<MarketplaceSource>

Defined in: packages/craft-hub/src/marketplace.ts:284

Parameters

input

catalogUrl

string

name

string

registry?

string

Returns

Promise<MarketplaceSource>

---

catalog()

catalog(): Promise<object & object[]>

Defined in: packages/craft-hub/src/marketplace.ts:277

Returns

Promise<object & object[]>

---

commandContributions()

commandContributions(): Promise<PluginCommandContributions[]>

Defined in: packages/craft-hub/src/marketplace.ts:447

Return active declarative command contributions without executing plugin code.

Returns

Promise<PluginCommandContributions[]>

---

initialize()

initialize(): Promise<void>

Defined in: packages/craft-hub/src/marketplace.ts:243

Returns

Promise<void>

---

install()

install(request): Promise<InstalledPlugin>

Defined in: packages/craft-hub/src/marketplace.ts:348

Parameters

request

InstallPluginRequest

Returns

Promise<InstalledPlugin>

---

listInstalled()

listInstalled(): Promise<InstalledPlugin[]>

Defined in: packages/craft-hub/src/marketplace.ts:266

Returns

Promise<InstalledPlugin[]>

---

listSources()

listSources(): Promise<MarketplaceSource[]>

Defined in: packages/craft-hub/src/marketplace.ts:261

Returns

Promise<MarketplaceSource[]>

---

onChanged()

onChanged(listener): () => void

Defined in: packages/craft-hub/src/marketplace.ts:272

Subscribe to installed-plugin or marketplace-source changes.

Parameters

listener

() => void

Returns

() => void

---

previewSource()

previewSource(input): Promise<MarketplaceSourcePreview>

Defined in: packages/craft-hub/src/marketplace.ts:306

Fetch and validate a marketplace source without changing persisted state.

Parameters

input

catalogUrl

string

name?

string

registry?

string

Returns

Promise<MarketplaceSourcePreview>

---

refreshSource()

refreshSource(id): Promise<MarketplaceSource>

Defined in: packages/craft-hub/src/marketplace.ts:331

Parameters

id

string

Returns

Promise<MarketplaceSource>

---

remove()

remove(packageName, deleteData?): Promise<void>

Defined in: packages/craft-hub/src/marketplace.ts:434

Parameters

packageName

string

deleteData?

boolean = false

Returns

Promise<void>

---

removeSource()

removeSource(id): Promise<void>

Defined in: packages/craft-hub/src/marketplace.ts:319

Parameters

id

string

Returns

Promise<void>

---

rollback()

rollback(packageName): Promise<InstalledPlugin>

Defined in: packages/craft-hub/src/marketplace.ts:413

Parameters

packageName

string

Returns

Promise<InstalledPlugin>

---

setEnabled()

setEnabled(packageName, enabled): Promise<InstalledPlugin>

Defined in: packages/craft-hub/src/marketplace.ts:404

Parameters

packageName

string

enabled

boolean

Returns

Promise<InstalledPlugin>