Developer docs/Extension reference

addon.json manifest

Field	Type	Required	Description
`id`	`String`	yes
`name`	`String`	yes
`version`	`String`	yes
`kind`	`String`	yes
`engine`	`String`	yes
`description`	`String`	no
`author`	`String`	no
`permissions`	`Vec<String>`	no
`settings`	`Vec<SettingSpec>`	no
`migrations`	`Vec<String>`	no
`files`	`BTreeMap<String, String>`	no
`provides`	`Option<String>`	no	WASM addons (`engine: "wasm"`): the engine id this addon provides (`stripe`, `pterodactyl`, ...), the WIT ABI and the component path.
`abi`	`Option<String>`	no
`wasm`	`Option<String>`	no
`capabilities`	`Option<Value>`	no	Sandbox capabilities approved at install (http allowlist, secrets, kv, events).
`ui`	`Option<Value>`	no	Declarative admin/client pages and widgets (see `addon_ext::validate_ui`).
`i18n`	`Option<Value>`	no	Strings for `ui`, served as `plugin.<id>.<key>`: `{ "en": {...}, "ro": {...} }`.
`limits`	`Option<Value>`	no	Per-addon sandbox limits (`memory_mib`, `timeout_secs`, `fuel`), at most the admin maxima (`pelty_wasm::limit_maxima`).

Source: crates/pelty-api/src/addons.rs (Manifest).

#Settings

Field	Type	Required	Description
`key`	`String`	yes
`label`	`String`	no
`kind`	`String`	no	text \| number \| bool \| select \| textarea \| secret (sealed at rest, masked on read)
`required`	`bool`	no
`choices`	`Vec<String>`	no
`default`	`Option<Value>`	no

Source: crates/pelty-api/src/addons.rs (SettingSpec).

#capabilities

See Capabilities.

#ui

See UI schema.

#Full example

JSON

{
  "id": "integration-guide",
  "name": "Addon guide example",
  "version": "0.1.0",
  "kind": "integration",
  "engine": "wasm",
  "provides": "guide",
  "abi": "0.3.0",
  "wasm": "addon.wasm",
  "description": "addons.desc.integration.guide",
  "author": "MythicalSystems",
  "permissions": [],
  "capabilities": {
    "kv": true,
    "http": ["example.com"],
    "secrets": ["api_token"],
    "events": ["invoice.paid", "user.registered"],
    "emits": ["integration-guide:greeted"],
    "hooks": [
      { "event": "client.before_register", "priority": "normal" },
      { "event": "login.before", "priority": "high", "fail_open": true, "timeout_ms": 500 },
      { "event": "before:integration-guide:greeted" },
      { "event": "order.before_place", "priority": "highest", "ignore_cancelled": true },
      { "event": "after:PUT /api/v1/client/profile", "priority": "monitor" }
    ],
    "mixins": [
      { "target": "GET /api/v1/client/profile", "at": "after" }
    ],
    "jobs": [{ "op": "cleanup", "every_secs": 3600 }],
    "routes": [
      { "method": "GET", "path": "/hello", "access": "public" },
      { "method": "POST", "path": "/greet", "access": "client" },
      { "method": "GET", "path": "/stats", "access": "admin", "permission": "reports.read" }
    ],
    "ui": ["iframe"]
  },
  "ui": {
    "pages": [
      {
        "id": "stats", "area": "admin", "title": "plugin.integration-guide.stats_title", "icon": "ChartBar", "nav": true,
        "data": { "stats": { "get": "/api/v1/addons/integration-guide/stats" } },
        "body": { "type": "stack", "children": [
          { "type": "text", "text": "{{t:plugin.integration-guide.stats_hint}}" },
          { "type": "table", "rows": "{{data.stats.rows}}", "columns": [
            { "header": "plugin.integration-guide.key", "value": "{{row.key}}" },
            { "header": "plugin.integration-guide.value", "value": "{{row.value}}" }
          ] }
        ] }
      },
      { "id": "frame", "area": "client", "title": "plugin.integration-guide.frame_title", "icon": "AppWindow", "nav": true, "frame": { "src": "assets/ui.html", "height": 200 } }
    ],
    "slots": [
      { "slot": "client.dashboard", "body": { "type": "alert", "text": "{{t:plugin.integration-guide.hello}}" } },
      { "slot": "admin.invoices.toolbar", "order": 5, "body": { "type": "badge", "text": "{{t:plugin.integration-guide.badge}}" } }
    ]
  },
  "settings": [
    { "key": "greeting", "label": "Greeting text", "kind": "text", "required": false },
    { "key": "api_token", "label": "API token", "kind": "secret", "required": false }
  ],
  "i18n": {
    "en": { "stats_title": "Guide stats", "stats_hint": "Counters kept by the guide addon.", "key": "Counter", "value": "Value", "frame_title": "Guide frame", "hello": "Hello from the guide addon.", "badge": "Guide" },
    "ro": { "stats_title": "Statistici ghid", "stats_hint": "Contoare ținute de addon-ul ghid.", "key": "Contor", "value": "Valoare", "frame_title": "Cadru ghid", "hello": "Salut de la addon-ul ghid.", "badge": "Ghid" }
  }
}

Generated by pelty-docs from the PeltyCMS source. View as Markdown