mirror of
https://github.com/alkimake/paperclip.git
synced 2026-06-15 10:30:37 +09:00
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:
Dotta
GitHub
parent
d6bee62f02
commit
3c73ed26b5
89 changed files with 27516 additions and 914 deletions
|
|
@ -25,7 +25,8 @@
|
|||
* @see PLUGIN_SPEC.md §19.7 — Error Propagation Through The Bridge
|
||||
*/
|
||||
|
||||
import { createContext, useCallback, useContext, useRef, useState, useEffect } from "react";
|
||||
import { createContext, useCallback, useContext, useEffect, useMemo, useRef, useState, type MouseEvent as ReactMouseEvent } from "react";
|
||||
import { useLocation as useRouterLocation, useNavigate as useRouterNavigate, type NavigateOptions } from "react-router-dom";
|
||||
import type {
|
||||
PluginBridgeErrorCode,
|
||||
PluginLauncherBounds,
|
||||
|
|
@ -35,6 +36,8 @@ import type {
|
|||
import { pluginsApi } from "@/api/plugins";
|
||||
import { ApiError } from "@/api/client";
|
||||
import { useToastActions, type ToastInput } from "@/context/ToastContext";
|
||||
import { useSidebar } from "@/context/SidebarContext";
|
||||
import { isGlobalPath, normalizeCompanyPrefix } from "@/lib/company-routes";
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Bridge error type (mirrors the SDK's PluginBridgeError)
|
||||
|
|
@ -63,6 +66,36 @@ export interface PluginDataResult<T = unknown> {
|
|||
export type PluginToastInput = ToastInput;
|
||||
export type PluginToastFn = (input: PluginToastInput) => string | null;
|
||||
|
||||
export interface HostNavigationOptions {
|
||||
replace?: boolean;
|
||||
state?: unknown;
|
||||
}
|
||||
|
||||
export interface HostNavigationLinkOptions extends HostNavigationOptions {
|
||||
target?: string;
|
||||
rel?: string;
|
||||
}
|
||||
|
||||
export interface HostNavigationLinkProps {
|
||||
href: string;
|
||||
target?: string;
|
||||
rel?: string;
|
||||
onClick(event: ReactMouseEvent<HTMLAnchorElement>): void;
|
||||
}
|
||||
|
||||
export interface HostNavigation {
|
||||
resolveHref(to: string): string;
|
||||
navigate(to: string, options?: HostNavigationOptions): void;
|
||||
linkProps(to: string, options?: HostNavigationLinkOptions): HostNavigationLinkProps;
|
||||
}
|
||||
|
||||
export interface HostLocation {
|
||||
pathname: string;
|
||||
search: string;
|
||||
hash: string;
|
||||
state?: unknown;
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Host context type (mirrors the SDK's PluginHostContext)
|
||||
// ---------------------------------------------------------------------------
|
||||
|
|
@ -220,6 +253,81 @@ function serializeRenderEnvironmentSnapshot(
|
|||
return snapshot ? JSON.stringify(snapshot) : "";
|
||||
}
|
||||
|
||||
function splitPath(path: string): { pathname: string; search: string; hash: string } {
|
||||
const match = path.match(/^([^?#]*)(\?[^#]*)?(#.*)?$/);
|
||||
return {
|
||||
pathname: match?.[1] ?? path,
|
||||
search: match?.[2] ?? "",
|
||||
hash: match?.[3] ?? "",
|
||||
};
|
||||
}
|
||||
|
||||
function sameOriginPathFromHref(href: string): string | null {
|
||||
if (!/^[a-z][a-z\d+.-]*:/i.test(href) && !href.startsWith("//")) {
|
||||
return href;
|
||||
}
|
||||
if (typeof window === "undefined") return null;
|
||||
try {
|
||||
const url = new URL(href, window.location.origin);
|
||||
if (url.origin !== window.location.origin) return null;
|
||||
return `${url.pathname}${url.search}${url.hash}`;
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
function hasCompanyPrefix(pathname: string, companyPrefix: string): boolean {
|
||||
const [firstSegment] = pathname.split("/").filter(Boolean);
|
||||
return firstSegment?.toUpperCase() === normalizeCompanyPrefix(companyPrefix);
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolve a plugin-provided Paperclip path to the active company scope.
|
||||
*
|
||||
* This intentionally handles plugin page roots such as `/wiki`, which cannot
|
||||
* be listed in the host router's static board-route table ahead of time.
|
||||
*/
|
||||
export function resolveHostNavigationHref(
|
||||
to: string,
|
||||
companyPrefix: string | null | undefined,
|
||||
): string {
|
||||
const sameOriginPath = sameOriginPathFromHref(to);
|
||||
if (sameOriginPath === null) return to;
|
||||
|
||||
const { pathname, search, hash } = splitPath(sameOriginPath);
|
||||
if (!pathname.startsWith("/") || isGlobalPath(pathname) || !companyPrefix) {
|
||||
return sameOriginPath;
|
||||
}
|
||||
|
||||
if (hasCompanyPrefix(pathname, companyPrefix)) {
|
||||
return sameOriginPath;
|
||||
}
|
||||
|
||||
return `/${normalizeCompanyPrefix(companyPrefix)}${pathname}${search}${hash}`;
|
||||
}
|
||||
|
||||
function isPlainLeftClick(event: ReactMouseEvent<HTMLAnchorElement>): boolean {
|
||||
return (
|
||||
!event.defaultPrevented &&
|
||||
event.button === 0 &&
|
||||
!event.metaKey &&
|
||||
!event.altKey &&
|
||||
!event.ctrlKey &&
|
||||
!event.shiftKey
|
||||
);
|
||||
}
|
||||
|
||||
export function shouldHandleHostNavigationClick(
|
||||
event: ReactMouseEvent<HTMLAnchorElement>,
|
||||
href: string,
|
||||
target?: string,
|
||||
): boolean {
|
||||
if (!isPlainLeftClick(event)) return false;
|
||||
if (target && target !== "_self") return false;
|
||||
if (event.currentTarget.hasAttribute("download")) return false;
|
||||
return sameOriginPathFromHref(href) !== null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Concrete implementation of `usePluginData<T>(key, params)`.
|
||||
*
|
||||
|
|
@ -364,6 +472,81 @@ export function useHostContext(): PluginHostContext {
|
|||
return hostContext;
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// useHostNavigation — concrete implementation
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
export function useHostNavigation(): HostNavigation {
|
||||
const { hostContext } = usePluginBridgeContext();
|
||||
const routerNavigate = useRouterNavigate();
|
||||
const { isMobile, setSidebarOpen } = useSidebar();
|
||||
const companyPrefix = hostContext.companyPrefix;
|
||||
|
||||
const resolveHref = useCallback(
|
||||
(to: string) => resolveHostNavigationHref(to, companyPrefix),
|
||||
[companyPrefix],
|
||||
);
|
||||
|
||||
const navigate = useCallback(
|
||||
(to: string, options?: HostNavigationOptions) => {
|
||||
const href = resolveHref(to);
|
||||
const sameOriginPath = sameOriginPathFromHref(href);
|
||||
if (sameOriginPath === null) {
|
||||
window.location.assign(href);
|
||||
return;
|
||||
}
|
||||
routerNavigate(sameOriginPath, options as NavigateOptions | undefined);
|
||||
// Mirror host sidebar behavior: tapping a link inside the mobile drawer
|
||||
// dismisses the drawer so the user can see the destination page.
|
||||
if (isMobile) setSidebarOpen(false);
|
||||
},
|
||||
[isMobile, resolveHref, routerNavigate, setSidebarOpen],
|
||||
);
|
||||
|
||||
const linkProps = useCallback(
|
||||
(to: string, options?: HostNavigationLinkOptions): HostNavigationLinkProps => {
|
||||
const href = resolveHref(to);
|
||||
return {
|
||||
href,
|
||||
target: options?.target,
|
||||
rel: options?.rel,
|
||||
onClick: (event) => {
|
||||
if (!shouldHandleHostNavigationClick(event, href, options?.target)) return;
|
||||
event.preventDefault();
|
||||
navigate(href, options);
|
||||
},
|
||||
};
|
||||
},
|
||||
[navigate, resolveHref],
|
||||
);
|
||||
|
||||
return useMemo(
|
||||
() => ({
|
||||
resolveHref,
|
||||
navigate,
|
||||
linkProps,
|
||||
}),
|
||||
[linkProps, navigate, resolveHref],
|
||||
);
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// useHostLocation — concrete implementation
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
export function useHostLocation(): HostLocation {
|
||||
const location = useRouterLocation();
|
||||
return useMemo(
|
||||
() => ({
|
||||
pathname: location.pathname,
|
||||
search: location.search,
|
||||
hash: location.hash,
|
||||
state: location.state,
|
||||
}),
|
||||
[location.hash, location.pathname, location.search, location.state],
|
||||
);
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// usePluginToast — concrete implementation
|
||||
// ---------------------------------------------------------------------------
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue