@ bitsentry/ plugin- sdk

BitSentry桌面插件的SDK合同和验证计划.

这个包裹是故意小的。 它定义了稳定插件边界 初始方和第三方插件编译对等,而 SuperTerminal 拥有 插件发现,安装,证书存储,执行,以及UI.

安装

npm install @bitsentry/plugin-sdk

使用量

import type { DesktopCodePlugin } from "@bitsentry/plugin-sdk";

export const plugin: DesktopCodePlugin = {
  id: "example",
  name: "Example",
  version: "0.1.0",
  description: "Example BitSentry desktop plugin.",
  type: "data_source",
  auth: {
    fields: [],
  },
  actions: [
    {
      id: "ping",
      title: "Ping",
      description: "Return a test response.",
      riskLevel: "read",
      fields: [],
      async execute() {
        return {
          ok: true,
          status: 200,
          summary: "Plugin executed successfully.",
          data: { pong: true },
        };
      },
    },
  ],
};

export default plugin;

合同表面

SDK导出类型Script和Zod计划用于:

• 插件描述符
• 认证和设置字段
• 插件动作
• 执行请求和结果
• 数据源设置和认证钩
• 从艺术安装请求和结果

插件应该依赖于此软件包而不是从 SuperTerminal 或 导入 @bitsentry-ce/core。这样可以使插件寄存器独立于 桌面应用程序的内部软件包图.

版本

0.x 在插件系统稳定时,释放可能会演变。 之后 1.0.0, (中文(简体) ), 打破合同的更改将需要一个大的版本起伏.

许可证

阿帕奇 - 2.0