Skip to main content

AdminPluginFileService

Admin Docs


Class: AdminPluginFileService

Defined in: src/plugin/services/AdminPluginFileService.ts:46

Production-First Plugin File Service Writes actual files to the filesystem for production deployment

Methods

getInstalledPlugins()

getInstalledPlugins(): Promise<IInstalledPlugin[]>

Defined in: src/plugin/services/AdminPluginFileService.ts:300

Get all installed plugins from filesystem

Returns

Promise<IInstalledPlugin[]>


getPlugin()

getPlugin(pluginId): Promise<IInstalledPlugin>

Defined in: src/plugin/services/AdminPluginFileService.ts:325

Get specific plugin from filesystem

Parameters

pluginId

string

Returns

Promise<IInstalledPlugin>


healthCheck()

healthCheck(): Promise<{ message: string; status: "error" | "healthy"; }>

Defined in: src/plugin/services/AdminPluginFileService.ts:361

Health check for the service

Returns

Promise<{ message: string; status: "error" | "healthy"; }>


installPlugin()

installPlugin(pluginId, files): Promise<IPluginInstallationResult>

Defined in: src/plugin/services/AdminPluginFileService.ts:173

Install plugin files to filesystem (Production-First)

Parameters

pluginId

string

files

Record<string, string>

Returns

Promise<IPluginInstallationResult>


removePlugin()

removePlugin(pluginId): Promise<boolean>

Defined in: src/plugin/services/AdminPluginFileService.ts:348

Remove plugin from filesystem

Parameters

pluginId

string

Returns

Promise<boolean>


validatePluginFiles()

validatePluginFiles(files): IPluginFileValidationResult

Defined in: src/plugin/services/AdminPluginFileService.ts:64

Validate plugin files structure

Parameters

files

Record<string, string>

Returns

IPluginFileValidationResult


validatePluginId()

validatePluginId(pluginId): object

Defined in: src/plugin/services/AdminPluginFileService.ts:143

Validate plugin ID

Parameters

pluginId

string

Returns

object

error?

optional error: string

valid

valid: boolean


getInstance()

static getInstance(): AdminPluginFileService

Defined in: src/plugin/services/AdminPluginFileService.ts:54

Get singleton instance

Returns

AdminPluginFileService


getPluginDetails()

static getPluginDetails(pluginId): Promise<IPluginDetails>

Defined in: src/plugin/services/AdminPluginFileService.ts:383

Get comprehensive plugin details from local files

Parameters

pluginId

string

Returns

Promise<IPluginDetails>