3c73ed26b5
## 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>
177 lines
5.0 KiB
TypeScript
177 lines
5.0 KiB
TypeScript
import {
|
|
useCallback,
|
|
useEffect,
|
|
useMemo,
|
|
useRef,
|
|
useState,
|
|
type KeyboardEvent,
|
|
type PointerEvent,
|
|
type ReactNode,
|
|
} from "react";
|
|
import { cn } from "@/lib/utils";
|
|
|
|
const DEFAULT_SIDEBAR_WIDTH = 240;
|
|
const MIN_SIDEBAR_WIDTH = 208;
|
|
const MAX_SIDEBAR_WIDTH = 420;
|
|
const SIDEBAR_WIDTH_STEP = 16;
|
|
|
|
function clampSidebarWidth(width: number) {
|
|
return Math.min(MAX_SIDEBAR_WIDTH, Math.max(MIN_SIDEBAR_WIDTH, width));
|
|
}
|
|
|
|
function readStoredSidebarWidth(storageKey: string) {
|
|
if (typeof window === "undefined") return DEFAULT_SIDEBAR_WIDTH;
|
|
|
|
try {
|
|
const stored = window.localStorage.getItem(storageKey);
|
|
if (!stored) return DEFAULT_SIDEBAR_WIDTH;
|
|
const parsed = Number.parseInt(stored, 10);
|
|
if (!Number.isFinite(parsed)) return DEFAULT_SIDEBAR_WIDTH;
|
|
return clampSidebarWidth(parsed);
|
|
} catch {
|
|
return DEFAULT_SIDEBAR_WIDTH;
|
|
}
|
|
}
|
|
|
|
function writeStoredSidebarWidth(storageKey: string, width: number) {
|
|
if (typeof window === "undefined") return;
|
|
|
|
try {
|
|
window.localStorage.setItem(storageKey, String(clampSidebarWidth(width)));
|
|
} catch {
|
|
// Storage can be unavailable in private contexts; resizing should still work.
|
|
}
|
|
}
|
|
|
|
type ResizableSidebarPaneProps = {
|
|
children: ReactNode;
|
|
open: boolean;
|
|
resizable?: boolean;
|
|
storageKey?: string;
|
|
className?: string;
|
|
};
|
|
|
|
export function ResizableSidebarPane({
|
|
children,
|
|
open,
|
|
resizable = false,
|
|
storageKey = "paperclip.sidebar.width",
|
|
className,
|
|
}: ResizableSidebarPaneProps) {
|
|
const [width, setWidth] = useState(() => readStoredSidebarWidth(storageKey));
|
|
const [isResizing, setIsResizing] = useState(false);
|
|
const widthRef = useRef(width);
|
|
const dragState = useRef<{ startX: number; startWidth: number } | null>(null);
|
|
|
|
useEffect(() => {
|
|
const storedWidth = readStoredSidebarWidth(storageKey);
|
|
widthRef.current = storedWidth;
|
|
setWidth(storedWidth);
|
|
}, [storageKey]);
|
|
|
|
const visibleWidth = open ? width : 0;
|
|
const paneStyle = useMemo(
|
|
() => ({ width: `${visibleWidth}px` }),
|
|
[visibleWidth],
|
|
);
|
|
|
|
const commitWidth = useCallback(
|
|
(nextWidth: number) => {
|
|
const clamped = clampSidebarWidth(nextWidth);
|
|
widthRef.current = clamped;
|
|
setWidth(clamped);
|
|
writeStoredSidebarWidth(storageKey, clamped);
|
|
},
|
|
[storageKey],
|
|
);
|
|
|
|
const handlePointerDown = useCallback(
|
|
(event: PointerEvent<HTMLDivElement>) => {
|
|
if (!open || !resizable) return;
|
|
|
|
event.preventDefault();
|
|
event.currentTarget.setPointerCapture(event.pointerId);
|
|
dragState.current = { startX: event.clientX, startWidth: widthRef.current };
|
|
setIsResizing(true);
|
|
},
|
|
[open, resizable],
|
|
);
|
|
|
|
const handlePointerMove = useCallback(
|
|
(event: PointerEvent<HTMLDivElement>) => {
|
|
if (!dragState.current) return;
|
|
|
|
const nextWidth = dragState.current.startWidth + event.clientX - dragState.current.startX;
|
|
const clamped = clampSidebarWidth(nextWidth);
|
|
widthRef.current = clamped;
|
|
setWidth(clamped);
|
|
},
|
|
[],
|
|
);
|
|
|
|
const endResize = useCallback(() => {
|
|
if (!dragState.current) return;
|
|
|
|
dragState.current = null;
|
|
setIsResizing(false);
|
|
writeStoredSidebarWidth(storageKey, widthRef.current);
|
|
}, [storageKey]);
|
|
|
|
const handleKeyDown = useCallback(
|
|
(event: KeyboardEvent<HTMLDivElement>) => {
|
|
if (!open || !resizable) return;
|
|
|
|
if (event.key === "ArrowLeft") {
|
|
event.preventDefault();
|
|
commitWidth(width - SIDEBAR_WIDTH_STEP);
|
|
} else if (event.key === "ArrowRight") {
|
|
event.preventDefault();
|
|
commitWidth(width + SIDEBAR_WIDTH_STEP);
|
|
} else if (event.key === "Home") {
|
|
event.preventDefault();
|
|
commitWidth(MIN_SIDEBAR_WIDTH);
|
|
} else if (event.key === "End") {
|
|
event.preventDefault();
|
|
commitWidth(MAX_SIDEBAR_WIDTH);
|
|
}
|
|
},
|
|
[commitWidth, open, resizable, width],
|
|
);
|
|
|
|
return (
|
|
<div
|
|
className={cn(
|
|
"relative overflow-hidden",
|
|
!isResizing && "transition-[width] duration-100 ease-out",
|
|
className,
|
|
)}
|
|
style={paneStyle}
|
|
>
|
|
{children}
|
|
{resizable && open ? (
|
|
<div
|
|
role="separator"
|
|
aria-label="Resize sidebar"
|
|
aria-orientation="vertical"
|
|
aria-valuemin={MIN_SIDEBAR_WIDTH}
|
|
aria-valuemax={MAX_SIDEBAR_WIDTH}
|
|
aria-valuenow={width}
|
|
tabIndex={0}
|
|
className={cn(
|
|
"absolute inset-y-0 right-0 z-20 w-3 cursor-col-resize touch-none outline-none",
|
|
"before:absolute before:inset-y-0 before:left-1/2 before:w-px before:-translate-x-1/2 before:bg-transparent before:transition-colors",
|
|
"hover:before:bg-border focus-visible:before:bg-ring",
|
|
isResizing && "before:bg-ring",
|
|
)}
|
|
onPointerDown={handlePointerDown}
|
|
onPointerMove={handlePointerMove}
|
|
onPointerUp={endResize}
|
|
onPointerCancel={endResize}
|
|
onLostPointerCapture={endResize}
|
|
onKeyDown={handleKeyDown}
|
|
/>
|
|
) : null}
|
|
</div>
|
|
);
|
|
}
|