Expand plugin host surface (#5205)
## Thinking Path > - Paperclip orchestrates AI agents for zero-human companies > - The plugin system is the extension boundary for optional product capabilities > - Rich plugins need more than a worker entrypoint: they need scoped database storage, local project folders, managed agents/routines, host navigation, and reusable UI components > - The LLM Wiki work exposed those missing host surfaces while keeping plugin code outside the core control plane > - This pull request expands the core plugin host, SDK, server APIs, and UI bridge so plugins can declare and use those surfaces > - The benefit is that future plugins can integrate with Paperclip through documented, validated contracts instead of bespoke server or UI imports ## What Changed - Added plugin-managed database namespaces and migration tracking, including Drizzle schema/migration files and SQL validation for namespace isolation. - Added server support for plugin local folders, managed agents, managed routines, scoped plugin APIs, and plugin operation visibility. - Expanded shared plugin manifest/types/validators and SDK host/testing/UI exports for richer plugin surfaces. - Added reusable UI pieces for file trees, managed routines, resizable sidebars, route sidebars, and plugin bridge initialization. - Updated plugin docs and example plugins to use the expanded host and SDK surface. ## Verification - `pnpm install --frozen-lockfile` - `pnpm run preflight:workspace-links && pnpm exec vitest run packages/shared/src/validators/plugin.test.ts server/src/__tests__/plugin-database.test.ts server/src/__tests__/plugin-local-folders.test.ts server/src/__tests__/plugin-managed-agents.test.ts server/src/__tests__/plugin-managed-routines.test.ts server/src/__tests__/plugin-orchestration-apis.test.ts ui/src/api/plugins.test.ts ui/src/components/FileTree.test.tsx ui/src/components/ResizableSidebarPane.test.tsx ui/src/pages/PluginPage.test.tsx ui/src/plugins/bridge.test.ts` passed: 11 files, 67 tests. - Confirmed this PR changes 89 files and does not include `pnpm-lock.yaml` or `.github/workflows/*`. ## Risks - Medium: this expands plugin host contracts across db/shared/server/ui and includes a new core migration (`0076_useful_elektra.sql`). - The plugin database namespace validator is intentionally restrictive; plugin authors may need follow-up affordances for SQL patterns that remain blocked. - Merge this before the LLM Wiki plugin PR so the plugin can resolve the new SDK and host APIs. > For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and discuss it in `#dev` before opening the PR. Feature PRs that overlap with planned core work may need to be redirected — check the roadmap first. See `CONTRIBUTING.md`. ## Model Used - OpenAI Codex, GPT-5 coding agent, tool-enabled shell/git/GitHub workflow. Context window size was not exposed by the runtime. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [x] If this change affects the UI, I have included before/after screenshots - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
This commit is contained in:
@@ -0,0 +1,180 @@
|
||||
import { Button } from "@/components/ui/button";
|
||||
import {
|
||||
RoutineListRow,
|
||||
type RoutineListAgentSummary,
|
||||
type RoutineListProjectSummary,
|
||||
type RoutineListRowItem,
|
||||
} from "@/components/RoutineList";
|
||||
|
||||
export type ManagedRoutinesListAgent = {
|
||||
id: string;
|
||||
name: string;
|
||||
icon?: string | null;
|
||||
};
|
||||
|
||||
export type ManagedRoutinesListProject = {
|
||||
id: string;
|
||||
name: string;
|
||||
color?: string | null;
|
||||
};
|
||||
|
||||
export type ManagedRoutineMissingRef = {
|
||||
resourceKind: string;
|
||||
resourceKey: string;
|
||||
};
|
||||
|
||||
export type ManagedRoutinesListItem = {
|
||||
key: string;
|
||||
title: string;
|
||||
status: string;
|
||||
routineId?: string | null;
|
||||
href?: string | null;
|
||||
resourceKey?: string | null;
|
||||
projectId?: string | null;
|
||||
assigneeAgentId?: string | null;
|
||||
cronExpression?: string | null;
|
||||
lastRunAt?: Date | string | null;
|
||||
lastRunStatus?: string | null;
|
||||
managedByPluginDisplayName?: string | null;
|
||||
missingRefs?: ManagedRoutineMissingRef[];
|
||||
};
|
||||
|
||||
export type ManagedRoutinesListProps = {
|
||||
routines: ManagedRoutinesListItem[];
|
||||
agents?: ManagedRoutinesListAgent[];
|
||||
projects?: ManagedRoutinesListProject[];
|
||||
pluginDisplayName?: string | null;
|
||||
emptyMessage?: string;
|
||||
runningRoutineKey?: string | null;
|
||||
statusMutationRoutineKey?: string | null;
|
||||
reconcilingRoutineKey?: string | null;
|
||||
resettingRoutineKey?: string | null;
|
||||
onRunNow?: (routine: ManagedRoutinesListItem) => void;
|
||||
onToggleEnabled?: (routine: ManagedRoutinesListItem, enabled: boolean) => void;
|
||||
onReconcile?: (routine: ManagedRoutinesListItem) => void;
|
||||
onReset?: (routine: ManagedRoutinesListItem) => void;
|
||||
};
|
||||
|
||||
function managedRoutineToRow(routine: ManagedRoutinesListItem): RoutineListRowItem {
|
||||
return {
|
||||
id: routine.key,
|
||||
title: routine.title,
|
||||
status: routine.status,
|
||||
projectId: routine.projectId ?? null,
|
||||
assigneeAgentId: routine.assigneeAgentId ?? null,
|
||||
lastRun: routine.lastRunAt || routine.lastRunStatus
|
||||
? {
|
||||
triggeredAt: routine.lastRunAt ?? null,
|
||||
status: routine.lastRunStatus ?? null,
|
||||
}
|
||||
: null,
|
||||
};
|
||||
}
|
||||
|
||||
export function ManagedRoutinesList({
|
||||
routines,
|
||||
agents = [],
|
||||
projects = [],
|
||||
pluginDisplayName = null,
|
||||
emptyMessage = "No managed routines.",
|
||||
runningRoutineKey = null,
|
||||
statusMutationRoutineKey = null,
|
||||
reconcilingRoutineKey = null,
|
||||
resettingRoutineKey = null,
|
||||
onRunNow,
|
||||
onToggleEnabled,
|
||||
onReconcile,
|
||||
onReset,
|
||||
}: ManagedRoutinesListProps) {
|
||||
const agentById = new Map<string, RoutineListAgentSummary>(
|
||||
agents.map((agent) => [agent.id, { name: agent.name, icon: agent.icon }]),
|
||||
);
|
||||
const projectById = new Map<string, RoutineListProjectSummary>(
|
||||
projects.map((project) => [project.id, { name: project.name, color: project.color }]),
|
||||
);
|
||||
|
||||
if (routines.length === 0) {
|
||||
return (
|
||||
<div className="rounded-lg border border-border px-3 py-8 text-center text-sm text-muted-foreground">
|
||||
{emptyMessage}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
return (
|
||||
<div className="rounded-lg border border-border">
|
||||
{routines.map((routine) => {
|
||||
const row = managedRoutineToRow(routine);
|
||||
const href = routine.href ?? (routine.routineId ? `/routines/${routine.routineId}` : "/routines");
|
||||
const missingRefs = routine.missingRefs ?? [];
|
||||
const canUseRoutine = Boolean(routine.routineId && routine.resourceKey && missingRefs.length === 0);
|
||||
const managedBy = routine.managedByPluginDisplayName ?? pluginDisplayName;
|
||||
const hasRepairActions = Boolean(onReconcile || onReset);
|
||||
|
||||
return (
|
||||
<div key={routine.key} className="last:[&_a]:border-b-0">
|
||||
<RoutineListRow
|
||||
routine={row}
|
||||
projectById={projectById}
|
||||
agentById={agentById}
|
||||
runningRoutineId={runningRoutineKey}
|
||||
statusMutationRoutineId={statusMutationRoutineKey}
|
||||
href={href}
|
||||
configureLabel="Configure"
|
||||
managedByLabel={managedBy ? `Managed by ${managedBy}` : null}
|
||||
runNowButton
|
||||
hideArchiveAction
|
||||
disableRunNow={!canUseRoutine}
|
||||
disableToggle={!canUseRoutine}
|
||||
secondaryDetails={
|
||||
<span className="flex flex-wrap items-center gap-x-3 gap-y-1">
|
||||
{routine.resourceKey ? <span>{routine.resourceKey}</span> : null}
|
||||
{routine.cronExpression ? <span>Schedule {routine.cronExpression}</span> : null}
|
||||
</span>
|
||||
}
|
||||
onRunNow={() => onRunNow?.(routine)}
|
||||
onToggleEnabled={() => onToggleEnabled?.(routine, row.status === "active")}
|
||||
/>
|
||||
{hasRepairActions ? (
|
||||
<div
|
||||
className="flex flex-wrap items-center justify-between gap-2 border-b border-border px-3 pb-3 text-xs text-muted-foreground last:border-b-0"
|
||||
onClick={(event) => {
|
||||
event.preventDefault();
|
||||
event.stopPropagation();
|
||||
}}
|
||||
>
|
||||
<span>
|
||||
{missingRefs.length
|
||||
? `Missing ${missingRefs.map((ref) => `${ref.resourceKind}:${ref.resourceKey}`).join(", ")}`
|
||||
: "Routine defaults can be repaired."}
|
||||
</span>
|
||||
<span className="flex items-center gap-2">
|
||||
{onReconcile ? (
|
||||
<Button
|
||||
size="sm"
|
||||
variant="ghost"
|
||||
disabled={reconcilingRoutineKey === routine.key}
|
||||
onClick={() => onReconcile(routine)}
|
||||
>
|
||||
{reconcilingRoutineKey === routine.key ? "Reconciling..." : "Reconcile"}
|
||||
</Button>
|
||||
) : null}
|
||||
{onReset ? (
|
||||
<Button
|
||||
size="sm"
|
||||
variant="ghost"
|
||||
disabled={resettingRoutineKey === routine.key}
|
||||
onClick={() => onReset(routine)}
|
||||
>
|
||||
{resettingRoutineKey === routine.key ? "Resetting..." : "Reset"}
|
||||
</Button>
|
||||
) : null}
|
||||
</span>
|
||||
</div>
|
||||
) : null}
|
||||
</div>
|
||||
);
|
||||
})}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
Reference in New Issue
Block a user