zengzag/workavatar/plugin-dev

<工作区>/my-plugin/
├── manifest.json           # 唯一信任入口（手写）
├── package.json            # 依赖声明（见"依赖声明约定"）
├── tsconfig.json           # 类型检查配置（可选）
├── build-plugin.mjs        # 构建脚本（从本技能 references 复制）
├── src/
│   ├── main/index.ts       # 主进程入口 → 编译为 dist/main/index.cjs
│   └── renderer/index.tsx  # 渲染端入口 → 编译为 dist/renderer/index.js
├── resources/              # 自包含重资源（onnx 模型等），只读，随包分发（无则省略）
└── locale/                 # zh-CN.json / en-US.json（多语言文案）

{
  "id": "my-plugin",
  "name": "My Plugin",
  "version": "1.0.0",
  "engine": ">=0.2.0",
  "description": "插件的功能描述",
  "author": "you@example.com",
  "main": "dist/main/index.cjs",
  "renderer": "dist/renderer/index.js",
  "locale": "locale",
  "ipc": ["list-things", "create-thing"],
  "capabilities": [
    { "domain": "data", "entities": ["conversations"], "access": "read" },
    { "domain": "execute", "kinds": ["llm-stream"] },
    { "domain": "events", "subscribe": ["conversation:deleted"], "publish": true },
    { "domain": "ui", "views": ["chat.toolbar"] },
    { "domain": "system", "features": ["notification", "scheduler"] }
  ],
  "nav": {
    "label": "navLabel",
    "icon": "<svg .../>",
    "order": 100,
    "detachable": true
  },
  "settings": [
    { "key": "apiBase", "type": "string", "label": "settings.apiBase", "default": "https://example.com", "required": true },
    { "key": "interval", "type": "number", "label": "settings.interval", "default": 30, "min": 5, "max": 600 },
    { "key": "enabled", "type": "boolean", "label": "settings.enabled", "default": true },
    { "key": "mode", "type": "select", "label": "settings.mode", "default": "fast",
      "options": [{ "value": "fast", "label": "settings.modeFast" }, { "value": "full", "label": "settings.modeFull" }] }
  ]
}

import type { PluginContext, PluginMigrationContext } from '@workavatar/plugin-sdk'
// 可选：数据迁移（首次激活时原子事务执行，幂等）
export const migrations = [{
  version: '1-init-schema',
  run(mig: PluginMigrationContext) {
    const db = mig.storage.openSqlite('index')
    db.exec(`CREATE TABLE IF NOT EXISTS my_items (
      id TEXT PRIMARY KEY, name TEXT NOT NULL,
      created_at INTEGER NOT NULL DEFAULT (unixepoch()))`)
  },
}]
export function activate(ctx: PluginContext): void {
  // IPC（短名必须在 manifest.ipc 白名单内）
  ctx.ipc.handle('list-things', () => {
    const db = ctx.storage.openSqlite('index')
    return db.prepare('SELECT * FROM my_items').all()
  })
  ctx.ipc.handle('create-thing', (payload: any) => {
    const db = ctx.storage.openSqlite('index')
    db.prepare('INSERT INTO my_items (id, name) VALUES (?, ?)').run(crypto.randomUUID(), payload?.name ?? '')
    ctx.ipc.broadcast('data-changed', { ts: Date.now() })  // 推送到本插件渲染端
    return { success: true }
  })
  // 访问宿主数据（需 capabilities.data）；注意宿主不 await activate，
  // 异步调用用 .then() 处理，耗时初始化不要阻塞 activate
  ctx.services.data?.query('conversations', { limit: 5 }).then((rows) => { /* ... */ })
  // 注册 agent 工具（无需 capabilities）
  ctx.contributions.registerAgentTools([{
    id: 'my_thing_lookup', name: 'my_thing_lookup',
    title: '查询我的插件数据', description: '按关键字查询插件数据',
    parameters: { type: 'object', properties: { keyword: { type: 'string' } } },
    handler: (args, context) => '查询结果...',
    onDemand: true,
  }])
}
export function deactivate(): void { /* 关定时器/窗口/DB 连接 */ }
// 可选：设置页保存后热应用（无需重启插件；ctx 建议存模块级变量后在回调中复用）
export function onSettingsChanged(values: Record<string, unknown>): void {
  // 按新 values 更新定时器 / 缓存 / 连接等
}

const interval = ctx.settings.get<number>('interval') ?? 30

import { useState } from 'react'
import { Button, Card, Typography } from 'antd'
import type { PluginRendererEntry, PluginRendererHost } from '@workavatar/plugin-sdk/renderer'
let hostRef: PluginRendererHost | null = null
function MyPage() {
  const [message, setMessage] = useState('')
  return (
    <Card title="My Plugin" style={{ maxWidth: 480, margin: 24 }}>
      <Button onClick={async () => {
        // 调用主进程 IPC（通道短名同 manifest.ipc）
        const res = await hostRef?.bridge.invoke('list-things')
        setMessage(JSON.stringify(res))
      }}>查询</Button>
      {message && <Typography.Text>{message}</Typography.Text>}
    </Card>
  )
}
const entry: PluginRendererEntry = {
  routes: [{ path: '', component: MyPage }],          // 挂载于 /plugin/<id>/
  // UI 注入到宿主界面（需 capabilities.ui.views；不需要就删掉这行）
  views: [{ view: 'chat.toolbar', component: MyPage }],
  init(host: PluginRendererHost): void { hostRef = host }, // 路由挂载前调用一次
  dispose(): void { hostRef = null },
}
export default entry

npm install                        # 安装构建依赖（需网络）
node build-plugin.mjs              # 构建到 dist/
node build-plugin.mjs --zip        # 构建并产出 release/plugins/<id>-v<version>.wap