Files
kandev/apps/web/lib/api/domains/plugins-api.ts
T
Kandev Agent c53f699714 feat: add plugin system with grpc runtime and native ui plugins
- go plugin backends ship as release tarballs (per-platform binaries, checksums) that
  kandev installs from url/upload or filesystem sideload+sync, then spawns and
  supervises via hashicorp/go-plugin (unix socket / loopback tcp+automtls)
- strict typed grpc contract (kandev.plugin.v1): DeliverEvent/InvokeTool/HandleWebhook
  plus a capability-gated host service (state, secrets, emit); author sdk in
  pkg/pluginsdk; packaging cli in cmd/plugin-pack
- native frontend bundles: window.registerKandevPlugin + registry/host loader with
  dynamic routes, nav items, slots and ws handlers; plugins settings page with
  install dialog, sync button and enable/disable/uninstall
- gated behind the plugins feature flag (prod off, dev/e2e on); covered by unit and
  integration tests plus playwright e2e against a real packaged fixture plugin

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-16 17:55:45 +01:00

149 lines
5.4 KiB
TypeScript

import { ApiError, fetchJson, type ApiRequestOptions } from "../client";
import { getBackendConfig } from "@/lib/config";
import type { PluginRecord, PluginToolDTO, SyncResult } from "@/lib/types/plugins";
const BASE = "/api/plugins";
// listPlugins fetches every registered plugin (GET /api/plugins).
export async function listPlugins(options?: ApiRequestOptions) {
const res = await fetchJson<{ plugins?: PluginRecord[] }>(BASE, options);
return res.plugins ?? [];
}
// getPlugin fetches a single plugin record by id. Rejects with a 404
// ApiError when the id is unknown.
export async function getPlugin(id: string, options?: ApiRequestOptions) {
return fetchJson<PluginRecord>(`${BASE}/${encodeURIComponent(id)}`, options);
}
// InstallResponse mirrors the backend's InstallResponse
// (internal/plugins/dto.go): the install endpoint always wraps the stored
// record under "plugin" (plus an optional "warning" when the package
// installed but its initial spawn/handshake failed — Plugin.Status is left
// as "error" in that case).
type InstallResponse = {
plugin: PluginRecord;
warning?: string;
};
// installPluginFromUrl asks the backend to download, verify, and install a
// plugin package from a remote URL (POST /api/plugins/install, JSON body).
// Returns the stored plugin record. Throws ApiError on 400 (invalid
// package/manifest — message names the problem, e.g. bad checksum or
// missing platform executable) or 409 (that version is already installed).
export async function installPluginFromUrl(
url: string,
options?: ApiRequestOptions,
): Promise<PluginRecord> {
const res = await fetchJson<InstallResponse>(`${BASE}/install`, {
...options,
init: {
...(options?.init ?? {}),
method: "POST",
body: JSON.stringify({ url }),
},
});
return res.plugin;
}
// installPluginUpload uploads a plugin package (.tar.gz) directly as
// multipart/form-data under the "package" field (POST /api/plugins/install).
// Bypasses fetchJson, which always forces a JSON Content-Type header — that
// would stop the browser from setting the multipart boundary itself. Same
// error semantics as installPluginFromUrl.
export async function installPluginUpload(
file: File,
options?: ApiRequestOptions,
): Promise<PluginRecord> {
const baseUrl = options?.baseUrl ?? getBackendConfig().apiBaseUrl;
const formData = new FormData();
formData.append("package", file);
// Spread caller init *first* so method/body always win, matching the
// convention in lib/api/domains/voice-api.ts.
const response = await fetch(`${baseUrl}${BASE}/install`, {
...options?.init,
method: "POST",
body: formData,
});
if (!response.ok) await throwInstallError(response);
const body = (await response.json()) as InstallResponse;
return body.plugin;
}
async function throwInstallError(response: Response): Promise<never> {
let body: unknown = null;
let message = `Plugin install failed: ${response.status} ${response.statusText}`;
try {
body = await response.json();
} catch {
// body remains null
}
if (body && typeof body === "object" && "error" in body) {
const errVal = (body as { error?: unknown }).error;
if (typeof errVal === "string") message = errVal;
}
throw new ApiError(message, response.status, body);
}
// updatePluginConfig replaces a plugin's operator-editable config
// (PATCH /api/plugins/:id).
export async function updatePluginConfig(
id: string,
config: Record<string, unknown>,
options?: ApiRequestOptions,
) {
return fetchJson<{ updated: boolean }>(`${BASE}/${encodeURIComponent(id)}`, {
...options,
init: {
...(options?.init ?? {}),
method: "PATCH",
body: JSON.stringify({ config }),
},
});
}
// enablePlugin transitions a plugin to active (POST /api/plugins/:id/enable).
export async function enablePlugin(id: string, options?: ApiRequestOptions) {
return fetchJson<{ enabled: boolean }>(`${BASE}/${encodeURIComponent(id)}/enable`, {
...options,
init: { ...(options?.init ?? {}), method: "POST" },
});
}
// disablePlugin transitions a plugin to disabled (POST /api/plugins/:id/disable).
export async function disablePlugin(id: string, options?: ApiRequestOptions) {
return fetchJson<{ disabled: boolean }>(`${BASE}/${encodeURIComponent(id)}/disable`, {
...options,
init: { ...(options?.init ?? {}), method: "POST" },
});
}
// uninstallPlugin removes a plugin's registration (DELETE /api/plugins/:id).
export async function uninstallPlugin(id: string, options?: ApiRequestOptions) {
return fetchJson<{ deleted: boolean }>(`${BASE}/${encodeURIComponent(id)}`, {
...options,
init: { ...(options?.init ?? {}), method: "DELETE" },
});
}
// listPluginTools aggregates the declared tools of every active plugin
// (GET /api/plugins/tools).
export async function listPluginTools(options?: ApiRequestOptions) {
const res = await fetchJson<{ tools?: PluginToolDTO[] }>(`${BASE}/tools`, options);
return res.tools ?? [];
}
// syncPlugins reconciles the plugin registry with the plugins directory on
// disk (POST /api/plugins/sync): registers unrecorded directory sideloads
// as disabled, installs and deletes dropped *.tar.gz packages, and marks
// records with a missing install path as errored. Returns the SyncResult
// summarizing what changed this run.
export async function syncPlugins(options?: ApiRequestOptions): Promise<SyncResult> {
return fetchJson<SyncResult>(`${BASE}/sync`, {
...options,
init: { ...(options?.init ?? {}), method: "POST" },
});
}