PluginManifest
Since Plugin API: 1.0.0
Plugin manifest schema
Signature
export interface PluginManifest { id: string; name: string; version: string; minAppVersion: string; pluginApiVersion: string; author: string; description: string; authorUrl?: string; repository?: string; icons?: string[]; permissions?: PluginPermission[]; thumbnailProviders?: { id: string; rendererVersion: string; }[];}Members
| Name | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | Unique plugin identifier (e.g., “vendor.plugin-name”) |
name |
string |
yes | Human-readable name |
version |
string |
yes | Plugin version (semver format) |
minAppVersion |
string |
yes | Minimum Phials app version required |
pluginApiVersion |
string |
yes | Public plugin API / SDK contract version this bundle targets (semver). |
author |
string |
yes | Plugin author name |
description |
string |
yes | Brief description of the plugin |
authorUrl |
string |
no | Author’s website or profile URL |
repository |
string |
no | GitHub repository URL |
icons |
string[] |
no | Iconify icons to preload |
permissions |
PluginPermission[] |
no | Required permissions |
thumbnailProviders |
{ … }[] |
no | Optional complete Thumbnail contribution catalog used by the owning Host to retire obsolete renderers. Introduced in Plugin API 2.0.0. |