Files
TREK/client/src/components/Settings/PluginSettingsTab.tsx
T
Maurice 5ee7cc052c refactor(plugins): share the plugin user settings, OAuth and activity logic between desktop and phone
The declared field form with its save, the actions and their confirm state, the OAuth connect and disconnect and the activity log now live in usePluginUserSettings, usePluginOAuth and usePluginActivity. Each shell keeps its own form, confirm dialog or sheet and picker.
2026-10-09 15:19:47 +02:00

254 lines
11 KiB
TypeScript

import { Fragment, type ReactNode } from 'react'
import { Save, Loader2, Link2, Unlink, CheckCircle, Puzzle, Zap } from 'lucide-react'
import { resolvePluginIcon } from '../shared/PluginIcon'
import CustomSelect from '../shared/CustomSelect'
import ConfirmDialog from '../shared/ConfirmDialog'
import { fs } from '../shared/DialogShell'
import { EditorField, INPUT } from '../shared/dialogParts'
import { SettingRow, SettingRows, SettingsCard, SettingsHint, SETTINGS_BUTTON, SETTINGS_BUTTON_DANGER, SETTINGS_BUTTON_PRIMARY } from './settingsKit'
import PluginFrame from '../Plugins/PluginFrame'
import type { PluginUserSettingField } from '../../api/client'
import { usePluginStore } from '../../store/pluginStore'
import { useTranslation } from '../../i18n'
import PluginActivityPanel from './PluginActivityPanel'
import { usePluginOAuth, usePluginUserSettings, type PluginOAuthState } from '../Plugins/usePluginUserSettings'
type FieldGroup = { kind: 'switches' | 'fields'; fields: PluginUserSettingField[] }
/** Runs of on/off fields become one box of switch rows; everything else stays a field. */
function groupFields(fields: PluginUserSettingField[]): FieldGroup[] {
const groups: FieldGroup[] = []
for (const f of fields) {
const kind = f.input_type === 'checkbox' ? 'switches' : 'fields'
const last = groups[groups.length - 1]
if (last && last.kind === kind) last.fields.push(f)
else groups.push({ kind, fields: [f] })
}
return groups
}
/**
* A declared checkbox in the look of ToggleSwitch. It stays a real checkbox
* underneath, so a label points at it and assistive tech reads it as one.
*/
function CheckSwitch({ id, checked, onChange }: { id: string; checked: boolean; onChange: (checked: boolean) => void }) {
return (
<span className="relative inline-flex h-6 w-11 flex-none">
<input
id={id}
type="checkbox"
checked={checked}
onChange={e => onChange(e.target.checked)}
className="peer absolute inset-0 z-10 m-0 h-full w-full cursor-pointer opacity-0"
/>
<span aria-hidden="true" className="pointer-events-none absolute inset-0 rounded-full bg-[color:var(--border-primary)] transition-colors peer-checked:bg-accent peer-focus-visible:ring-2 peer-focus-visible:ring-[color:var(--text-primary)]" />
<span aria-hidden="true" className="pointer-events-none absolute left-0.5 top-0.5 h-5 w-5 rounded-full bg-surface-card shadow-sm transition-[left] duration-200 peer-checked:left-[22px] peer-checked:bg-[color:var(--accent-text)]" />
</span>
)
}
/** Host-brokered OAuth: a Connect/Disconnect control. The host runs the whole flow +
* holds the tokens; this only triggers connect (redirect to the provider) / disconnect. */
function PluginOAuthSection({ id, state, setState }: {
id: string
state: PluginOAuthState | null
setState: (s: PluginOAuthState) => void
}) {
const { t } = useTranslation()
const { busy, connect, disconnect } = usePluginOAuth(id, state, setState)
if (!state?.configured) return null
return (
<SettingRows>
<SettingRow
label={state.connected
? <span className="inline-flex items-center gap-1.5"><CheckCircle size={14} className="flex-none text-success" />{t('settings.plugins.oauth.connected')}</span>
: t('settings.plugins.oauth.notConnected')}
control={state.connected
? <button type="button" onClick={disconnect} disabled={busy} className={SETTINGS_BUTTON} style={fs(13, 'body')}><Unlink size={14} />{t('settings.plugins.oauth.disconnect')}</button>
: <button type="button" onClick={connect} disabled={busy} className={SETTINGS_BUTTON_PRIMARY} style={fs(13, 'body')}>{busy ? <Loader2 size={14} className="animate-spin" /> : <Link2 size={14} />}{t('settings.plugins.oauth.connect')}</button>}
/>
</SettingRows>
)
}
/**
* A user's own per-plugin settings (#plugins). The host renders the plugin's
* declared `scope:'user'` fields as an editable form — a plugin never ships markup
* here; the field list is trusted, validated manifest data. Secrets stay write-only
* (masked, never echoed back). One form per active plugin that declares user fields.
*/
function PluginSettingsForm({ id, name, icon }: { id: string; name: string; icon: string | null }) {
const { t } = useTranslation()
const {
fields,
values,
setValue,
hasFields,
visible,
saving,
save,
actions,
running,
actionResult,
runAction,
performAction,
pendingAction,
setPendingAction,
oauth,
setOauth,
} = usePluginUserSettings(id)
if (!visible || fields === null) return null
const fieldId = (key: string) => `plugin-setting-${id}-${key}`
const labelOf = (f: PluginUserSettingField): ReactNode => (
<>{f.label || f.key}{f.required && <span className="text-danger"> *</span>}</>
)
return (
<SettingsCard icon={resolvePluginIcon(icon)} title={name}>
{hasFields && (
<div className={`flex flex-col gap-4 ${saving ? 'opacity-60' : ''}`}>
{groupFields(fields ?? []).map(group => group.kind === 'switches' ? (
// Consecutive on/off fields share one box of rows, like the rest of settings.
<SettingRows key={group.fields[0].key}>
{group.fields.map(f => (
<SettingRow
key={f.key}
label={labelOf(f)}
hint={f.hint || undefined}
htmlFor={fieldId(f.key)}
control={
<CheckSwitch
id={fieldId(f.key)}
checked={values[f.key] === true}
onChange={checked => setValue(f.key, checked)}
/>
}
/>
))}
</SettingRows>
) : (
<Fragment key={group.fields[0].key}>
{group.fields.map(f => (
<EditorField key={f.key} label={labelOf(f)} htmlFor={fieldId(f.key)} hint={f.hint || undefined}>
{f.input_type === 'select' && f.options ? (
<CustomSelect
id={fieldId(f.key)}
value={String(values[f.key] ?? '')}
onChange={v => setValue(f.key, String(v))}
options={[{ value: '', label: '—' }, ...f.options.map(o => ({ value: o.value, label: o.label }))]}
/>
) : (
<input
id={fieldId(f.key)}
type={f.secret ? 'password' : (f.input_type === 'number' ? 'number' : 'text')}
value={String(values[f.key] ?? '')}
placeholder={f.placeholder || ''}
autoComplete={f.secret ? 'new-password' : 'off'}
onChange={e => setValue(f.key, e.target.value)}
className={INPUT}
/>
)}
</EditorField>
))}
</Fragment>
))}
<div className="flex justify-end">
<button type="button" onClick={save} disabled={saving} className={SETTINGS_BUTTON_PRIMARY} style={fs(13, 'body')}>
{saving ? <Loader2 size={14} className="animate-spin" /> : <Save size={14} />}
{t('common.save')}
</button>
</div>
</div>
)}
{actions.length > 0 && (
<div>
<p className="m-0 mb-2 flex items-center gap-1.5 font-geist font-bold uppercase tracking-[.08em] text-content-faint" style={fs(10)}>
<Zap size={11} className="flex-none" />
{t('settings.plugins.actions')}
</p>
<SettingRows>
{actions.map(a => {
const res = actionResult[a.key]
return (
<div key={a.key} className="flex flex-wrap items-center gap-x-3 gap-y-1.5 px-3.5 py-3">
<button type="button"
onClick={() => runAction(a)}
disabled={running !== null}
className={a.danger ? SETTINGS_BUTTON_DANGER : SETTINGS_BUTTON}
style={fs(13, 'body')}
>
{running === a.key && <Loader2 size={14} className="animate-spin" />}
{a.label}
</button>
{a.hint && <span className="min-w-0 flex-1 text-content-faint" style={fs(11.5)}>{a.hint}</span>}
{res && (
<span className={`ms-auto font-medium ${res.ok ? 'text-success' : 'text-danger'}`} style={fs(12, 'body')}>
{res.message || (res.ok ? t('common.success') : t('common.error'))}
</span>
)}
</div>
)
})}
</SettingRows>
</div>
)}
<PluginOAuthSection id={id} state={oauth} setState={setOauth} />
<ConfirmDialog
isOpen={pendingAction !== null}
onClose={() => setPendingAction(null)}
onConfirm={() => { if (pendingAction) void performAction(pendingAction) }}
message={t('settings.plugins.actions.confirm')}
confirmLabel={pendingAction?.label}
danger
/>
</SettingsCard>
)
}
/**
* A plugin's OWN settings surface (capabilities.settingsUi): its sandboxed
* client/settings.html framed inside the familiar settings card. Unlike the
* declared-fields form above, the plugin renders this itself — same opaque-origin
* sandbox and postMessage bridge as its widget, so it can only reach its own
* routes. The frame auto-sizes via trek:resize like a dashboard widget.
*/
function PluginSettingsUiCard({ id, name, icon }: { id: string; name: string; icon: string | null }) {
return (
<SettingsCard icon={resolvePluginIcon(icon)} title={name}>
{/* min-height covers the beat before the frame's first trek:resize lands.
color-scheme light on the frame element matches the sandboxed document's
default ("normal"): mismatched schemes make Chromium paint an opaque
white canvas behind the transparent frame (same trap .hero-overlay-frame
guards against), which glares in dark mode. */}
<div className="min-h-[120px] overflow-hidden rounded-[12px] border border-edge-faint bg-surface-card">
<PluginFrame pluginId={id} path="settings.html" title={name} surface="user-settings" className="[color-scheme:light]" />
</div>
</SettingsCard>
)
}
export default function PluginSettingsTab() {
const { t } = useTranslation()
const plugins = usePluginStore(s => s.plugins)
return (
<div>
<SettingsCard icon={Puzzle} title={t('settings.plugins.title')} hint={t('settings.plugins.subtitle')}>
{plugins.length === 0 ? <SettingsHint>{t('settings.plugins.empty')}</SettingsHint> : null}
</SettingsCard>
{plugins.map(p => (
<Fragment key={p.id}>
<PluginSettingsForm id={p.id} name={p.name} icon={p.icon} />
{p.settingsUi && <PluginSettingsUiCard id={p.id} name={p.name} icon={p.icon} />}
</Fragment>
))}
<PluginActivityPanel />
</div>
)
}