@ericsanchezok/synergy-plugin 2.1.2 → 2.2.0

package/dist/manifest.js

@@ -0,0 +1,422 @@
+import z from "zod";
+const ToolRendererDef = z
+    .object({
+    tool: z.string().min(1),
+    exportName: z.string().optional().default("default"),
+    priority: z.number().int().min(0).max(100).optional().default(0),
+    fallback: z
+        .object({
+        icon: z.string().optional(),
+        title: z.string().optional(),
+        subtitleTemplate: z.string().optional(),
+    })
+        .optional(),
+})
+    .strict();
+const PartRendererDef = z
+    .object({
+    type: z.string().min(1),
+    exportName: z.string().optional().default("default"),
+    priority: z.number().int().min(0).max(100).optional().default(0),
+})
+    .strict();
+const PanelDef = z
+    .object({
+    id: z.string().min(1).max(64),
+    label: z.string().min(1).max(64),
+    icon: z.string().min(1),
+    exportName: z.string().optional().default("default"),
+    sandbox: z.boolean().optional().default(false),
+    sandboxEntry: z
+        .string()
+        .regex(/^[a-zA-Z0-9_/.-]+\.js$/)
+        .max(256)
+        .optional(),
+})
+    .strict();
+const SettingsDef = z
+    .object({
+    id: z.string().min(1).max(64),
+    label: z.string().min(1).max(64),
+    icon: z.string().min(1),
+    group: z.string(),
+    formSchema: z.record(z.string(), z.unknown()).optional(),
+    exportName: z.string().optional(),
+    sandbox: z.boolean().optional().default(false),
+    sandboxEntry: z
+        .string()
+        .regex(/^[a-zA-Z0-9_/.-]+\.js$/)
+        .max(256)
+        .optional(),
+})
+    .strict();
+const ChatComponentDef = z
+    .object({
+    id: z.string().min(1),
+    exportName: z.string().optional().default("default"),
+    slot: z.enum(["before-tools", "after-tools", "before-reasoning", "after-reasoning"]).optional(),
+})
+    .strict();
+const ThemeDef = z
+    .object({
+    id: z.string().min(1).max(64),
+    label: z.string().min(1).max(64),
+    path: z.string().min(1),
+})
+    .strict();
+const IconDef = z
+    .object({
+    name: z.string().min(1).max(128),
+    path: z.string().min(1),
+})
+    .strict();
+const RouteDef = z
+    .object({
+    path: z.string().min(1),
+    entry: z.string().min(1),
+    label: z.string().min(1),
+    icon: z.string().optional(),
+})
+    .strict();
+const UICommandDef = z
+    .object({
+    id: z.string().min(1).max(64),
+    label: z.string().min(1).max(64),
+    exportName: z.string().optional(),
+    description: z.string().max(256).optional(),
+    icon: z.string().optional(),
+})
+    .strict();
+const UIContribution = z
+    .object({
+    entry: z
+        .string()
+        .regex(/^[a-zA-Z0-9_/.-]+\.js$/)
+        .max(256)
+        .optional(),
+    minUIApiVersion: z
+        .string()
+        .regex(/^\d+\.\d+\.\d+$/)
+        .optional(),
+    toolRenderers: z.array(ToolRendererDef).optional(),
+    partRenderers: z.array(PartRendererDef).optional(),
+    workspacePanels: z.array(PanelDef).optional(),
+    globalPanels: z.array(PanelDef).optional(),
+    settings: z.array(SettingsDef).optional(),
+    chatComponents: z.array(ChatComponentDef).optional(),
+    themes: z.array(ThemeDef).optional(),
+    icons: z.array(IconDef).optional(),
+    routes: z.array(RouteDef).optional(),
+    commands: z.array(UICommandDef).optional(),
+})
+    .partial()
+    .optional();
+const PluginPermissionsSchema = z
+    .object({
+    /** Tool execution permissions */
+    tools: z
+        .object({
+        invoke: z.boolean().default(true),
+        shell: z.boolean().default(false),
+        filesystem: z.preprocess((val) => {
+            if (val === true)
+                return "write";
+            if (val === false)
+                return "none";
+            return val;
+        }, z.enum(["none", "read", "write"]).default("none")),
+        network: z.boolean().default(false),
+        mcp: z.enum(["none", "invoke", "spawn"]).default("none"),
+    })
+        .optional(),
+    /** Data access */
+    data: z
+        .object({
+        session: z.enum(["none", "metadata", "read"]).default("none"),
+        workspace: z.enum(["none", "metadata", "read"]).default("none"),
+        config: z.enum(["plugin", "global"]).default("plugin"),
+        secrets: z.enum(["none", "own"]).default("none"),
+    })
+        .optional(),
+    /** Network access */
+    network: z
+        .object({
+        connectDomains: z.array(z.string()).default([]),
+        resourceDomains: z.array(z.string()).default([]),
+        frameDomains: z.array(z.string()).default([]),
+    })
+        .optional(),
+    /** UI surface permissions */
+    ui: z
+        .object({
+        toolRenderers: z.boolean().default(false),
+        partRenderers: z.boolean().default(false),
+        workspacePanels: z.boolean().default(false),
+        globalPanels: z.boolean().default(false),
+        settings: z.boolean().default(false),
+        themes: z.boolean().default(false),
+        icons: z.boolean().default(false),
+        routes: z.boolean().default(false),
+        trustedImport: z.boolean().default(false),
+        sandboxIframe: z.boolean().default(false),
+    })
+        .optional(),
+    /** Hook permission declarations */
+    hooks: z
+        .object({
+        events: z.enum(["none", "selected", "all"]).default("selected"),
+        eventNames: z.array(z.string()).default([]),
+        toolExecute: z.enum(["none", "own", "declared", "all"]).default("own"),
+        permissionAsk: z.enum(["none", "own", "all"]).default("none"),
+        promptTransform: z.boolean().default(false),
+        compactionTransform: z.boolean().default(false),
+    })
+        .optional(),
+})
+    .optional();
+// PluginManifest: the declarative plugin descriptor (plugin.json)
+export const PluginManifest = z
+    .object({
+    // Identity
+    name: z.string().min(1).max(128),
+    version: z.string().regex(/^\d+\.\d+\.\d+(-[a-zA-Z0-9.]+)?(\+[a-zA-Z0-9.]+)?$/),
+    description: z.string().min(1).max(1024),
+    author: z.string().optional(),
+    homepage: z.string().url().optional(),
+    repository: z.string().optional(),
+    license: z.string().optional(),
+    icon: z.string().optional(),
+    keywords: z.array(z.string()).optional(),
+    // Compatibility
+    minSynergyVersion: z
+        .string()
+        .regex(/^\d+\.\d+\.\d+$/)
+        .optional(),
+    engines: z
+        .object({
+        synergy: z.string().optional(),
+        bun: z.string().optional(),
+    })
+        .optional(),
+    // Dependencies on other plugins
+    dependencies: z.record(z.string(), z.string()).optional(),
+    // Trust tier request
+    trust: z
+        .object({
+        requestedTier: z.enum(["declarative", "trusted-import", "sandbox"]).optional(),
+        reason: z.string().optional(),
+    })
+        .optional(),
+    // Permission / trust declaration
+    permissions: PluginPermissionsSchema,
+    // Declarative contributions
+    contributes: z
+        .object({
+        tools: z
+            .array(z.object({
+            id: z.string().optional(),
+            name: z.string(),
+            title: z.string().optional(),
+            description: z.string(),
+            icon: z.string().optional(),
+            category: z.string().optional(),
+            kind: z.string().optional(),
+            capabilities: z
+                .object({
+                filesystem: z.enum(["none", "read", "write"]).optional(),
+                network: z.boolean().optional(),
+                shell: z.boolean().optional(),
+                session: z.enum(["none", "metadata", "read"]).optional(),
+                workspace: z.enum(["none", "metadata", "read"]).optional(),
+                config: z.enum(["none", "plugin", "global"]).optional(),
+            })
+                .optional(),
+            risk: z.enum(["low", "medium", "high"]).optional(),
+        }))
+            .optional(),
+        skills: z
+            .array(z.object({
+            name: z.string(),
+            description: z.string(),
+            dir: z.string(),
+        }))
+            .optional(),
+        agents: z
+            .array(z.object({
+            name: z.string(),
+            description: z.string(),
+            mode: z.enum(["subagent", "primary", "all"]).default("subagent"),
+            model: z.string().optional(),
+        }))
+            .optional(),
+        mcp: z
+            .object({
+            defaults: z
+                .object({
+                startup: z.enum(["eager", "lazy", "manual"]).optional(),
+                required: z.boolean().optional(),
+                connectTimeout: z.number().optional(),
+                listTimeout: z.number().optional(),
+                callTimeout: z.number().optional(),
+                retry: z
+                    .object({
+                    maxAttempts: z.number().int().positive().optional(),
+                    backoffMs: z.number().int().positive().optional(),
+                    backoffMultiplier: z.number().positive().optional(),
+                    cooldownMs: z.number().int().nonnegative().optional(),
+                })
+                    .optional(),
+                idleShutdownMs: z.number().int().positive().optional(),
+                toolFilter: z
+                    .object({
+                    include: z.array(z.string()).optional(),
+                    exclude: z.array(z.string()).optional(),
+                })
+                    .optional(),
+                tools: z
+                    .object({
+                    approval: z.enum(["auto", "always", "per_session"]).optional(),
+                    maxOutputBytes: z.number().int().positive().optional(),
+                })
+                    .optional(),
+                toolCache: z
+                    .object({
+                    mode: z.enum(["disabled", "session", "persistent"]).optional(),
+                    ttlMs: z.number().int().positive().optional(),
+                })
+                    .optional(),
+            })
+                .optional()
+                .describe("Default lifecycle settings applied to all MCP servers contributed by this plugin"),
+            locked: z
+                .boolean()
+                .optional()
+                .describe("If true, the user cannot override this plugin's MCP server declarations"),
+        })
+            .catchall(z
+            .object({
+            type: z.literal("local"),
+            command: z.array(z.string()),
+            environment: z.record(z.string(), z.string()).optional(),
+            description: z.string().optional(),
+            timeout: z.number().optional(),
+            startup: z.enum(["eager", "lazy", "manual"]).optional(),
+            required: z.boolean().optional(),
+            connectTimeout: z.number().optional(),
+            listTimeout: z.number().optional(),
+            callTimeout: z.number().optional(),
+            retry: z
+                .object({
+                maxAttempts: z.number().int().positive().optional(),
+                backoffMs: z.number().int().positive().optional(),
+                backoffMultiplier: z.number().positive().optional(),
+                cooldownMs: z.number().int().nonnegative().optional(),
+            })
+                .optional(),
+            idleShutdownMs: z.number().int().positive().optional(),
+            toolFilter: z
+                .object({
+                include: z.array(z.string()).optional(),
+                exclude: z.array(z.string()).optional(),
+            })
+                .optional(),
+            tools: z
+                .object({
+                approval: z.enum(["auto", "always", "per_session"]).optional(),
+                maxOutputBytes: z.number().int().positive().optional(),
+            })
+                .optional(),
+            toolCache: z
+                .object({
+                mode: z.enum(["disabled", "session", "persistent"]).optional(),
+                ttlMs: z.number().int().positive().optional(),
+            })
+                .optional(),
+        })
+            .strict()
+            .or(z
+            .object({
+            type: z.literal("remote"),
+            url: z.string(),
+            headers: z.record(z.string(), z.string()).optional(),
+            description: z.string().optional(),
+            timeout: z.number().optional(),
+            startup: z.enum(["eager", "lazy", "manual"]).optional(),
+            required: z.boolean().optional(),
+            connectTimeout: z.number().optional(),
+            listTimeout: z.number().optional(),
+            callTimeout: z.number().optional(),
+            retry: z
+                .object({
+                maxAttempts: z.number().int().positive().optional(),
+                backoffMs: z.number().int().positive().optional(),
+                backoffMultiplier: z.number().positive().optional(),
+                cooldownMs: z.number().int().nonnegative().optional(),
+            })
+                .optional(),
+            idleShutdownMs: z.number().int().positive().optional(),
+            toolFilter: z
+                .object({
+                include: z.array(z.string()).optional(),
+                exclude: z.array(z.string()).optional(),
+            })
+                .optional(),
+            tools: z
+                .object({
+                approval: z.enum(["auto", "always", "per_session"]).optional(),
+                maxOutputBytes: z.number().int().positive().optional(),
+            })
+                .optional(),
+            toolCache: z
+                .object({
+                mode: z.enum(["disabled", "session", "persistent"]).optional(),
+                ttlMs: z.number().int().positive().optional(),
+            })
+                .optional(),
+        })
+            .strict()))
+            .optional(),
+        commands: z
+            .array(z.object({
+            name: z.string(),
+            description: z.string(),
+        }))
+            .optional(),
+        config: z
+            .object({
+            schema: z.record(z.string(), z.any()).optional(),
+            defaults: z.record(z.string(), z.any()).optional(),
+        })
+            .optional(),
+        permissions: PluginPermissionsSchema,
+        ui: UIContribution,
+    })
+        .partial()
+        .optional(),
+    // Lifecycle
+    main: z.string().optional().default("./src/index.ts"),
+    lifecycle: z
+        .object({
+        install: z.string().optional(),
+        uninstall: z.string().optional(),
+        update: z.string().optional(),
+    })
+        .optional(),
+    // Runtime preferences
+    runtime: z
+        .object({
+        mode: z.enum(["in-process", "worker", "process"]).optional(),
+        minRuntimeApiVersion: z.string().optional(),
+        resources: z
+            .object({
+            memoryMb: z.number().positive().optional(),
+            startupTimeoutMs: z.number().positive().optional(),
+            requestTimeoutMs: z.number().positive().optional(),
+            maxConcurrentRequests: z.number().positive().optional(),
+            maxLogBytesPerMinute: z.number().positive().optional(),
+        })
+            .optional(),
+    })
+        .optional(),
+})
+    .strict();

package/dist/tool.d.ts

@@ -16,6 +16,16 @@ export interface ToolResult {
     title?: string;
     output: string;
     metadata?: Record<string, any>;
+    attachments?: Array<{
+        type: "file";
+        id: string;
+        sessionID: string;
+        messageID: string;
+        mime: string;
+        filename?: string;
+        url: string;
+        localPath?: string;
+    }>;
 }
 export declare function tool<Args extends z.ZodRawShape>(input: {
     description: string;

package/dist/ui.d.ts

@@ -0,0 +1,45 @@
+import type { Component } from "solid-js";
+export interface PluginToolRendererProps {
+    input: Record<string, unknown>;
+    metadata: Record<string, unknown>;
+    tool: string;
+    title?: string;
+    output?: string;
+    status?: string;
+    raw?: string;
+    charsReceived?: number;
+    hideDetails?: boolean;
+    defaultOpen?: boolean;
+    forceOpen?: boolean;
+}
+export type PluginToolRenderer = Component<PluginToolRendererProps>;
+export interface PluginPartRendererProps {
+    part: unknown;
+    message?: unknown;
+}
+export type PluginPartRenderer = Component<PluginPartRendererProps>;
+export interface PluginPanelProps {
+    pluginId: string;
+    panelId: string;
+    scopeId?: string;
+}
+export type PluginWorkspacePanel = Component<PluginPanelProps>;
+export type PluginGlobalPanel = Component<PluginPanelProps>;
+export interface PluginSettingsProps {
+    pluginId: string;
+    values: Record<string, unknown>;
+    onChange(values: Record<string, unknown>): void;
+}
+export type PluginSettingsSection = Component<PluginSettingsProps>;
+export type PluginChatSlot = "before-tools" | "after-tools" | "before-reasoning" | "after-reasoning";
+export interface PluginChatComponentProps {
+    slot: PluginChatSlot;
+    sessionId?: string;
+    messageId?: string;
+}
+export type PluginChatComponent = Component<PluginChatComponentProps>;
+export interface PluginCommandContext {
+    pluginId: string;
+    serverUrl: string;
+}
+export type PluginUICommand = (context: PluginCommandContext) => void | Promise<void>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
   "name": "@ericsanchezok/synergy-plugin",
-  "version": "2.1.2",
+  "version": "2.2.0",
   "type": "module",
   "license": "MIT",
   "repository": {
@@ -28,6 +28,14 @@
     "./hooks": {
       "import": "./dist/hooks.js",
       "types": "./dist/hooks.d.ts"
+    },
+    "./shell": {
+      "import": "./dist/shell.js",
+      "types": "./dist/shell.d.ts"
+    },
+    "./ui": {
+      "import": "./dist/ui.js",
+      "types": "./dist/ui.d.ts"
     }
   },
   "files": [