@pixelml/plugin 0.0.0-dev-202512250746

package/dist/example.d.ts

@@ -0,0 +1,2 @@
+import { Plugin } from "./index";
+export declare const ExamplePlugin: Plugin;

package/dist/example.js

@@ -0,0 +1,16 @@
+import { tool } from "./tool";
+export const ExamplePlugin = async (ctx) => {
+    return {
+        tool: {
+            mytool: tool({
+                description: "This is a custom tool",
+                args: {
+                    foo: tool.schema.string().describe("foo"),
+                },
+                async execute(args) {
+                    return `Hello ${args.foo}!`;
+                },
+            }),
+        },
+    };
+};

package/dist/index.d.ts

@@ -0,0 +1,192 @@
+import type { Event, createClawClient, Project, Model, Provider, Permission, UserMessage, Message, Part, Auth, Config } from "@pixelml/sdk";
+import type { BunShell } from "./shell";
+import { type ToolDefinition } from "./tool";
+export * from "./tool";
+export type ProviderContext = {
+    source: "env" | "config" | "custom" | "api";
+    info: Provider;
+    options: Record<string, any>;
+};
+export type PluginInput = {
+    client: ReturnType<typeof createClawClient>;
+    project: Project;
+    directory: string;
+    worktree: string;
+    $: BunShell;
+};
+export type Plugin = (input: PluginInput) => Promise<Hooks>;
+export type AuthHook = {
+    provider: string;
+    loader?: (auth: () => Promise<Auth>, provider: Provider) => Promise<Record<string, any>>;
+    methods: ({
+        type: "oauth";
+        label: string;
+        prompts?: Array<{
+            type: "text";
+            key: string;
+            message: string;
+            placeholder?: string;
+            validate?: (value: string) => string | undefined;
+            condition?: (inputs: Record<string, string>) => boolean;
+        } | {
+            type: "select";
+            key: string;
+            message: string;
+            options: Array<{
+                label: string;
+                value: string;
+                hint?: string;
+            }>;
+            condition?: (inputs: Record<string, string>) => boolean;
+        }>;
+        authorize(inputs?: Record<string, string>): Promise<AuthOuathResult>;
+    } | {
+        type: "api";
+        label: string;
+        prompts?: Array<{
+            type: "text";
+            key: string;
+            message: string;
+            placeholder?: string;
+            validate?: (value: string) => string | undefined;
+            condition?: (inputs: Record<string, string>) => boolean;
+        } | {
+            type: "select";
+            key: string;
+            message: string;
+            options: Array<{
+                label: string;
+                value: string;
+                hint?: string;
+            }>;
+            condition?: (inputs: Record<string, string>) => boolean;
+        }>;
+        authorize?(inputs?: Record<string, string>): Promise<{
+            type: "success";
+            key: string;
+            provider?: string;
+        } | {
+            type: "failed";
+        }>;
+    })[];
+};
+export type AuthOuathResult = {
+    url: string;
+    instructions: string;
+} & ({
+    method: "auto";
+    callback(): Promise<({
+        type: "success";
+        provider?: string;
+    } & ({
+        refresh: string;
+        access: string;
+        expires: number;
+    } | {
+        key: string;
+    })) | {
+        type: "failed";
+    }>;
+} | {
+    method: "code";
+    callback(code: string): Promise<({
+        type: "success";
+        provider?: string;
+    } & ({
+        refresh: string;
+        access: string;
+        expires: number;
+    } | {
+        key: string;
+    })) | {
+        type: "failed";
+    }>;
+});
+export interface Hooks {
+    event?: (input: {
+        event: Event;
+    }) => Promise<void>;
+    config?: (input: Config) => Promise<void>;
+    tool?: {
+        [key: string]: ToolDefinition;
+    };
+    auth?: AuthHook;
+    /**
+     * Called when a new message is received
+     */
+    "chat.message"?: (input: {
+        sessionID: string;
+        agent?: string;
+        model?: {
+            providerID: string;
+            modelID: string;
+        };
+        messageID?: string;
+    }, output: {
+        message: UserMessage;
+        parts: Part[];
+    }) => Promise<void>;
+    /**
+     * Modify parameters sent to LLM
+     */
+    "chat.params"?: (input: {
+        sessionID: string;
+        agent: string;
+        model: Model;
+        provider: ProviderContext;
+        message: UserMessage;
+    }, output: {
+        temperature: number;
+        topP: number;
+        topK: number;
+        options: Record<string, any>;
+    }) => Promise<void>;
+    "permission.ask"?: (input: Permission, output: {
+        status: "ask" | "deny" | "allow";
+    }) => Promise<void>;
+    "tool.execute.before"?: (input: {
+        tool: string;
+        sessionID: string;
+        callID: string;
+    }, output: {
+        args: any;
+    }) => Promise<void>;
+    "tool.execute.after"?: (input: {
+        tool: string;
+        sessionID: string;
+        callID: string;
+    }, output: {
+        title: string;
+        output: string;
+        metadata: any;
+    }) => Promise<void>;
+    "experimental.chat.messages.transform"?: (input: {}, output: {
+        messages: {
+            info: Message;
+            parts: Part[];
+        }[];
+    }) => Promise<void>;
+    "experimental.chat.system.transform"?: (input: {}, output: {
+        system: string[];
+    }) => Promise<void>;
+    /**
+     * Called before session compaction starts. Allows plugins to customize
+     * the compaction prompt.
+     *
+     * - `context`: Additional context strings appended to the default prompt
+     * - `prompt`: If set, replaces the default compaction prompt entirely
+     */
+    "experimental.session.compacting"?: (input: {
+        sessionID: string;
+    }, output: {
+        context: string[];
+        prompt?: string;
+    }) => Promise<void>;
+    "experimental.text.complete"?: (input: {
+        sessionID: string;
+        messageID: string;
+        partID: string;
+    }, output: {
+        text: string;
+    }) => Promise<void>;
+}

package/dist/index.js

@@ -0,0 +1 @@
+export * from "./tool";

package/dist/shell.d.ts

@@ -0,0 +1,109 @@
+export type ShellFunction = (input: Uint8Array) => Uint8Array;
+export type ShellExpression = {
+    toString(): string;
+} | Array<ShellExpression> | string | {
+    raw: string;
+} | ReadableStream;
+export interface BunShell {
+    (strings: TemplateStringsArray, ...expressions: ShellExpression[]): BunShellPromise;
+    /**
+     * Perform bash-like brace expansion on the given pattern.
+     * @param pattern - Brace pattern to expand
+     */
+    braces(pattern: string): string[];
+    /**
+     * Escape strings for input into shell commands.
+     */
+    escape(input: string): string;
+    /**
+     * Change the default environment variables for shells created by this instance.
+     */
+    env(newEnv?: Record<string, string | undefined>): BunShell;
+    /**
+     * Default working directory to use for shells created by this instance.
+     */
+    cwd(newCwd?: string): BunShell;
+    /**
+     * Configure the shell to not throw an exception on non-zero exit codes.
+     */
+    nothrow(): BunShell;
+    /**
+     * Configure whether or not the shell should throw an exception on non-zero exit codes.
+     */
+    throws(shouldThrow: boolean): BunShell;
+}
+export interface BunShellPromise extends Promise<BunShellOutput> {
+    readonly stdin: WritableStream;
+    /**
+     * Change the current working directory of the shell.
+     */
+    cwd(newCwd: string): this;
+    /**
+     * Set environment variables for the shell.
+     */
+    env(newEnv: Record<string, string> | undefined): this;
+    /**
+     * By default, the shell will write to the current process's stdout and stderr, as well as buffering that output.
+     * This configures the shell to only buffer the output.
+     */
+    quiet(): this;
+    /**
+     * Read from stdout as a string, line by line
+     * Automatically calls quiet() to disable echoing to stdout.
+     */
+    lines(): AsyncIterable<string>;
+    /**
+     * Read from stdout as a string.
+     * Automatically calls quiet() to disable echoing to stdout.
+     */
+    text(encoding?: BufferEncoding): Promise<string>;
+    /**
+     * Read from stdout as a JSON object
+     * Automatically calls quiet()
+     */
+    json(): Promise<any>;
+    /**
+     * Read from stdout as an ArrayBuffer
+     * Automatically calls quiet()
+     */
+    arrayBuffer(): Promise<ArrayBuffer>;
+    /**
+     * Read from stdout as a Blob
+     * Automatically calls quiet()
+     */
+    blob(): Promise<Blob>;
+    /**
+     * Configure the shell to not throw an exception on non-zero exit codes.
+     */
+    nothrow(): this;
+    /**
+     * Configure whether or not the shell should throw an exception on non-zero exit codes.
+     */
+    throws(shouldThrow: boolean): this;
+}
+export interface BunShellOutput {
+    readonly stdout: Buffer;
+    readonly stderr: Buffer;
+    readonly exitCode: number;
+    /**
+     * Read from stdout as a string
+     */
+    text(encoding?: BufferEncoding): string;
+    /**
+     * Read from stdout as a JSON object
+     */
+    json(): any;
+    /**
+     * Read from stdout as an ArrayBuffer
+     */
+    arrayBuffer(): ArrayBuffer;
+    /**
+     * Read from stdout as an Uint8Array
+     */
+    bytes(): Uint8Array;
+    /**
+     * Read from stdout as a Blob
+     */
+    blob(): Blob;
+}
+export type BunShellError = Error & BunShellOutput;

package/dist/tool.d.ts

@@ -0,0 +1,20 @@
+import { z } from "zod";
+export type ToolContext = {
+    sessionID: string;
+    messageID: string;
+    agent: string;
+    abort: AbortSignal;
+};
+export declare function tool<Args extends z.ZodRawShape>(input: {
+    description: string;
+    args: Args;
+    execute(args: z.infer<z.ZodObject<Args>>, context: ToolContext): Promise<string>;
+}): {
+    description: string;
+    args: Args;
+    execute(args: z.infer<z.ZodObject<Args>>, context: ToolContext): Promise<string>;
+};
+export declare namespace tool {
+    var schema: typeof z;
+}
+export type ToolDefinition = ReturnType<typeof tool>;

package/dist/tool.js

@@ -0,0 +1,5 @@
+import { z } from "zod";
+export function tool(input) {
+    return input;
+}
+tool.schema = z;

package/package.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "https://json.schemastore.org/package.json",
+  "name": "@pixelml/plugin",
+  "version": "0.0.0-dev-202512250746",
+  "type": "module",
+  "scripts": {
+    "typecheck": "tsgo --noEmit",
+    "build": "tsc"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./tool": {
+      "import": "./dist/tool.js",
+      "types": "./dist/tool.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@pixelml/sdk": "workspace:*",
+    "zod": "catalog:"
+  },
+  "devDependencies": {
+    "@tsconfig/node22": "catalog:",
+    "@types/node": "catalog:",
+    "typescript": "catalog:",
+    "@typescript/native-preview": "catalog:"
+  }
+}