Add managed local plugin lifecycle (#3222)

* feat(plugins): add local plugin surfaces and RPCs Keep plugin execution scoped to its daemon while allowing one local TypeScript entry point to contribute validated RPCs and native client surfaces. Paseo owns host selection, navigation chrome, and per-installation query caches. * feat(plugins): add Linear attachment source * fix(nix): refresh npm dependency hash * test(server): exclude internal sessions from Hub counts * test(server): distinguish Hub execution sessions * feat(plugins): make local plugins explicitly opt-in Keep plugin loading dormant until configuration enables it, and collect unsupported examples under one directory. * refactor(plugins): establish host boundaries * fix(nix): refresh plugin dependency hash * fix(plugins): complete packaging and startup rollback * feat(plugins): add managed local lifecycle Make trusted local plugins recoverable and authorable through daemon-owned lifecycle operations, host settings, and a capability-gated CLI. Reloads fully stop the previous plugin before starting new code, while generated projects provide strict TSX checking without changing runtime dependency ownership. * fix(nix): refresh plugin dependency hash
2026-08-14 17:12:49 +02:00
parent f0bd2c8483
commit 23853a1515
115 changed files with 7481 additions and 17 deletions
@@ -0,0 +1,167 @@
+import { mkdir, readdir, writeFile } from "node:fs/promises";
+import path from "node:path";
+import { PluginIdSchema } from "@getpaseo/protocol/messages";
+
+const SDK_DECLARATIONS = `declare module "@paseo/plugin" {
+  import type { ComponentType } from "react";
+  import type { ZodType, input as ZodInput, output as ZodOutput } from "zod";
+
+  export interface PluginSurfaceProps {
+    theme: Record<string, unknown>;
+    host: { id: string; label: string };
+    layout: { compact: boolean; platform: "ios" | "android" | "web" };
+  }
+
+  export interface PluginRpcContract<
+    InputSchema extends ZodType = ZodType,
+    OutputSchema extends ZodType = ZodType,
+  > {
+    name: string;
+    input: InputSchema;
+    output: OutputSchema;
+  }
+
+  export interface PluginAttachmentItem {
+    id: string;
+    identifier: string;
+    title: string;
+    subtitle?: string;
+    url: string;
+    text: string;
+    resourceType: string;
+  }
+
+  export interface PluginAttachmentSearchPayload {
+    items: PluginAttachmentItem[];
+  }
+
+  export interface PluginAttachmentSourceContribution {
+    id: string;
+    title: string;
+    icon: string;
+    pickerTitle: string;
+    searchPlaceholder: string;
+    search: PluginRpcContract;
+  }
+
+  export interface PluginSidebarContribution {
+    id: string;
+    title: string;
+    icon: string;
+    surface: string;
+  }
+
+  export interface PluginSurfaceContribution {
+    id: string;
+    Component: ComponentType<PluginSurfaceProps>;
+  }
+
+  export interface PluginContext {
+    handle<InputSchema extends ZodType, OutputSchema extends ZodType>(
+      contract: PluginRpcContract<InputSchema, OutputSchema>,
+      handler: (
+        input: ZodOutput<InputSchema>,
+      ) => ZodInput<OutputSchema> | Promise<ZodInput<OutputSchema>>,
+    ): void;
+    addSurface(id: string, Component: ComponentType<PluginSurfaceProps>): void;
+    addSidebarItem(contribution: PluginSidebarContribution): void;
+    addAttachmentSource(contribution: PluginAttachmentSourceContribution): void;
+  }
+
+  export type PluginCleanup = () => void;
+  export type PluginContribution = (plugin: PluginContext) => PluginCleanup;
+
+  export function defineRpc<InputSchema extends ZodType, OutputSchema extends ZodType>(definition: {
+    name: string;
+    input: InputSchema;
+    output: OutputSchema;
+  }): PluginRpcContract<InputSchema, OutputSchema>;
+
+  export function useRpc<InputSchema extends ZodType, OutputSchema extends ZodType>(
+    contract: PluginRpcContract<InputSchema, OutputSchema>,
+  ): (input: ZodInput<InputSchema>) => Promise<ZodOutput<OutputSchema>>;
+
+  export function defineAttachmentSource<Definition extends PluginAttachmentSourceContribution>(
+    definition: Definition,
+  ): Definition;
+
+  export const PluginAttachmentItemSchema: import("zod").ZodType<PluginAttachmentItem>;
+  export const PluginAttachmentSearchPayloadSchema: import("zod").ZodType<PluginAttachmentSearchPayload>;
+}
+`;
+
+const TSCONFIG = {
+  compilerOptions: {
+    target: "ES2020",
+    module: "ESNext",
+    moduleResolution: "Bundler",
+    lib: ["ES2023", "DOM"],
+    jsx: "react-jsx",
+    strict: true,
+    skipLibCheck: true,
+    noEmit: true,
+    esModuleInterop: true,
+    allowSyntheticDefaultImports: true,
+  },
+  include: ["index.tsx", "paseo-plugin.d.ts"],
+};
+
+const ENTRY = `import type { PluginContext } from "@paseo/plugin";
+import React from "react";
+import { Text } from "react-native";
+
+function MainSurface() {
+  return <Text>Hello from my plugin</Text>;
+}
+
+export default function contribute(plugin: PluginContext) {
+  plugin.addSurface("main", MainSurface);
+  return () => undefined;
+}
+`;
+
+export interface PluginScaffold {
+  id: string;
+  directory: string;
+}
+
+export async function scaffoldPluginDirectory(
+  targetDirectory: string,
+  requestedId?: string,
+): Promise<PluginScaffold> {
+  const directory = path.resolve(targetDirectory);
+  const id = PluginIdSchema.parse(requestedId ?? path.basename(directory));
+  await mkdir(directory, { recursive: true });
+  const existing = await readdir(directory);
+  if (existing.length > 0) {
+    throw new Error(`Plugin directory must be empty: ${directory}`);
+  }
+
+  const packageJson = {
+    name: id,
+    private: true,
+    version: "0.0.0",
+    scripts: { typecheck: "tsc --noEmit" },
+    devDependencies: {
+      "@tanstack/react-query": "^5.90.11",
+      "@types/react": "~19.2.0",
+      react: "19.1.0",
+      "react-native": "0.81.5",
+      typescript: "^5.9.3",
+      zod: "^4.4.3",
+    },
+  };
+  const files = new Map<string, string>([
+    ["paseo-plugin.json", `${JSON.stringify({ id }, null, 2)}\n`],
+    ["package.json", `${JSON.stringify(packageJson, null, 2)}\n`],
+    ["tsconfig.json", `${JSON.stringify(TSCONFIG, null, 2)}\n`],
+    ["paseo-plugin.d.ts", SDK_DECLARATIONS],
+    ["index.tsx", ENTRY],
+  ]);
+  await Promise.all(
+    [...files].map(([filename, contents]) =>
+      writeFile(path.join(directory, filename), contents, { flag: "wx" }),
+    ),
+  );
+  return { id, directory };
+}