Files
kandev/apps/web/components/settings/plugins/plugin-detail.tsx
T
2026-09-12 14:58:49 +02:00

314 lines
11 KiB
TypeScript

"use client";
import { useRef, useState, type RefObject } from "react";
import { IconArrowLeft } from "@tabler/icons-react";
import { Trans, useTranslation } from "react-i18next";
import { Badge } from "@kandev/ui/badge";
import { Button } from "@kandev/ui/button";
import { CardContent, CardHeader, CardTitle } from "@kandev/ui/card";
import { Separator } from "@kandev/ui/separator";
import { PluginSlot } from "@/components/plugins/plugin-slot";
import Link from "@/components/routing/app-link";
import { useRouter } from "@/lib/routing/client-router";
import { useResponsiveBreakpoint } from "@/hooks/use-responsive-breakpoint";
import { usePlugins } from "@/hooks/domains/plugins/use-plugins";
import { useIsAdmin } from "@/hooks/domains/auth/use-is-admin";
import { SettingsCard } from "@/components/settings/settings-card";
import { useSettingsSaveContributor } from "@/components/settings/settings-save-provider";
import { PluginConfigForm } from "./plugin-config-form";
import { PluginManifestCard } from "./plugin-manifest-card";
import { PluginShortcutsCard } from "./plugin-shortcuts-card";
import { PluginRepoLink } from "./plugin-repo-link";
import { PluginStatusBadge } from "./plugin-status-badge";
import { PluginErrorDiagnostic } from "./plugin-error-diagnostic";
import { PluginUninstallConfirmation } from "./uninstall-plugin-dialog";
import { usePluginActions } from "./use-plugin-actions";
import { usePluginConfigForm } from "./use-plugin-config-form";
import type { PluginRecord } from "@/lib/types/plugins";
import { SETTINGS_TYPOGRAPHY } from "@/components/settings/settings-typography";
import { controlSizingClassName } from "@kandev/ui/control-sizing";
const PLUGINS_SETTINGS_HREF = "/settings/plugins";
/**
* Per-plugin settings page (Settings > Plugins > <plugin>): manifest
* overview plus the schema-driven settings form declared by the plugin
* author via the manifest's config_schema (e.g. a GitHub plugin's PAT).
* Saving restarts a running plugin so it re-reads config via the Host
* GetConfig RPC.
*/
export function PluginDetail({ pluginId }: { pluginId: string }) {
const canManage = useIsAdmin();
const { items, loaded } = usePlugins();
const router = useRouter();
const { isFinePointer } = useResponsiveBreakpoint();
const actions = usePluginActions();
const plugin = items.find((p) => p.id === pluginId) ?? null;
const [confirmingUninstall, setConfirmingUninstall] = useState(false);
const uninstallAnchorRef = useRef<HTMLButtonElement>(null);
const form = usePluginConfigForm(canManage ? plugin : null);
useSettingsSaveContributor({
id: `plugin-config:${pluginId}`,
revision: form.revision,
isDirty: canManage && form.isDirty,
canSave: canManage && form.canSave,
invalidReason: form.invalidReason,
save: form.handleSave,
discard: form.discard,
});
if (!plugin) {
return loaded ? <PluginNotFound pluginId={pluginId} /> : null;
}
return (
<div className="space-y-6" data-testid={`plugin-detail-${plugin.id}`}>
<PluginDetailHeader plugin={plugin} />
<Separator />
{canManage && (
<>
{/* Owner-scoped inline slot for the plugin's own settings UI, at the top (see PLUGIN-API.md). */}
<PluginSlot
name="plugin-settings"
ownerPluginId={plugin.id}
slotProps={{ pluginId: plugin.id, status: plugin.status }}
/>
<PluginSettingsCard
plugin={plugin}
form={form}
busy={actions.busyId === plugin.id || actions.uninstallBusy}
/>
</>
)}
<PluginShortcutsCard plugin={plugin} plugins={items} />
<PluginManifestCard plugin={plugin} />
{canManage && (
<>
<PluginDangerZone
plugin={plugin}
actions={actions}
isFinePointer={isFinePointer}
confirmingUninstall={confirmingUninstall}
uninstallAnchorRef={uninstallAnchorRef}
onUninstall={() => {
setConfirmingUninstall(true);
}}
/>
<PluginUninstallConfirmation
target={plugin}
open={confirmingUninstall}
isFinePointer={isFinePointer}
anchorRef={uninstallAnchorRef}
onOpenChange={setConfirmingUninstall}
onCancel={() => {
setConfirmingUninstall(false);
}}
onConfirm={async () => {
const uninstalled = await actions.confirmUninstall(plugin);
if (uninstalled) router.push(PLUGINS_SETTINGS_HREF);
}}
/>
</>
)}
</div>
);
}
type PluginDetailHeaderProps = {
plugin: PluginRecord;
};
function PluginDetailHeader({ plugin }: PluginDetailHeaderProps) {
const { t } = useTranslation();
return (
<div className="space-y-3">
<Link
href={PLUGINS_SETTINGS_HREF}
className="inline-flex items-center gap-1 text-sm text-muted-foreground hover:text-foreground cursor-pointer"
>
<IconArrowLeft className="h-4 w-4" />
{t("common:plugins")}
</Link>
<div className="flex flex-wrap items-start justify-between gap-3">
<div className="min-w-0 space-y-1">
<div className="flex flex-wrap items-center gap-2">
<h2 className="text-2xl font-bold truncate">{plugin.display_name}</h2>
<PluginStatusBadge status={plugin.status} />
{plugin.signed === false && (
<Badge
variant="outline"
className={
"border-amber-500/40 bg-amber-500/10 text-amber-600 dark:text-amber-400 " +
SETTINGS_TYPOGRAPHY.meta
}
>
{t("plugins:unsigned")}
</Badge>
)}
</div>
<div className="flex flex-wrap items-center gap-x-3 gap-y-1 text-xs text-muted-foreground">
<span className="font-mono">
{plugin.id} · v{plugin.version}
</span>
<PluginRepoLink url={plugin.repo_url} />
</div>
{plugin.description && (
<p className="text-sm text-muted-foreground">{plugin.description}</p>
)}
<PluginErrorDiagnostic plugin={plugin} />
</div>
</div>
</div>
);
}
type PluginSettingsCardProps = {
plugin: PluginRecord;
form: ReturnType<typeof usePluginConfigForm>;
busy: boolean;
};
function PluginSettingsCard({ plugin, form, busy }: PluginSettingsCardProps) {
const { t } = useTranslation();
return (
<SettingsCard isDirty={form.isDirty} data-testid="plugin-settings-card">
<CardHeader>
<CardTitle className="text-base">{t("plugins:settings")}</CardTitle>
</CardHeader>
<CardContent>
<PluginSettingsBody plugin={plugin} form={form} busy={busy} />
</CardContent>
</SettingsCard>
);
}
function PluginSettingsBody({ plugin, form, busy }: PluginSettingsCardProps) {
const { t } = useTranslation();
if (form.fields.length === 0) {
return (
<p className="text-sm text-muted-foreground">
{/* `config_schema` is a manifest key — the contract, not copy. */}
<Trans i18nKey="plugins:noDeclaredSettings">
This plugin does not declare any settings (no <code>config_schema</code> in its manifest).
</Trans>
</p>
);
}
if (form.configError) {
return <p className="text-sm text-destructive">{form.configError}</p>;
}
if (form.configLoading) {
return <p className="text-sm text-muted-foreground">{t("plugins:loadingSettings")}</p>;
}
return (
<div className="space-y-4">
<PluginConfigForm
fields={form.fields}
values={form.values}
initialValues={form.initialValues}
disabled={busy || form.saveStatus === "loading"}
onChange={form.handleChange}
/>
{plugin.status === "active" && (
<p className="text-xs text-muted-foreground">{t("plugins:savingRestartsPlugin")}</p>
)}
</div>
);
}
type PluginDangerZoneProps = {
plugin: PluginRecord;
actions: ReturnType<typeof usePluginActions>;
isFinePointer: boolean;
confirmingUninstall: boolean;
uninstallAnchorRef: RefObject<HTMLButtonElement | null>;
onUninstall: () => void;
};
function PluginDangerZone({
plugin,
actions,
isFinePointer,
confirmingUninstall,
uninstallAnchorRef,
onUninstall,
}: PluginDangerZoneProps) {
const { t } = useTranslation();
const { isMobile } = useResponsiveBreakpoint();
const busy = actions.busyId === plugin.id || actions.uninstallBusy;
const canEnable =
plugin.status === "disabled" || plugin.status === "registered" || plugin.status === "error";
const canDisable = plugin.status === "active" || plugin.status === "error";
return (
<div className="flex flex-wrap items-center gap-2">
{canEnable && (
<Button
variant="outline"
size="sm"
className={controlSizingClassName(
"compact",
"cursor-pointer max-md:min-h-11 [@media(pointer:coarse)]:min-h-11",
)}
disabled={busy}
onClick={() => actions.handleEnable(plugin)}
>
{t("plugins:enable")}
</Button>
)}
{canDisable && (
<Button
variant="outline"
size="sm"
className={controlSizingClassName(
"compact",
"cursor-pointer max-md:min-h-11 [@media(pointer:coarse)]:min-h-11",
)}
disabled={busy}
onClick={() => actions.handleDisable(plugin)}
>
{t("plugins:disable")}
</Button>
)}
{(isMobile || isFinePointer || !confirmingUninstall) && (
<Button
ref={uninstallAnchorRef}
variant="ghost"
size="sm"
className={controlSizingClassName(
"compact",
"cursor-pointer text-destructive hover:text-destructive max-md:min-h-11 [@media(pointer:coarse)]:min-h-11",
)}
disabled={busy}
onClick={onUninstall}
>
{t("plugins:uninstall")}
</Button>
)}
</div>
);
}
function PluginNotFound({ pluginId }: { pluginId: string }) {
const { t } = useTranslation();
return (
<div className="space-y-4">
<Link
href={PLUGINS_SETTINGS_HREF}
className="inline-flex items-center gap-1 text-sm text-muted-foreground hover:text-foreground cursor-pointer"
>
<IconArrowLeft className="h-4 w-4" />
{t("common:plugins")}
</Link>
<div className="rounded-md border border-dashed p-6 text-sm text-muted-foreground">
{/* The plugin id is an identifier the user typed or followed, never copy. */}
<Trans i18nKey="plugins:noInstalledPluginWithId" values={{ id: pluginId }}>
No installed plugin with id <span className="font-mono">{pluginId}</span>.
</Trans>
</div>
</div>
);
}