@tomradex/plugin-sdk 0.2.0 → 0.2.16

package/dist/terminals.d.ts

@@ -0,0 +1,72 @@
+import type { Disposer } from "./contract.js";
+/** SDK 0.2.10. Whether herdr can hand over a live terminal, and the command that fixes it when it cannot. */
+export type TerminalBridgeState = {
+    state: "ready";
+    version: string;
+} | {
+    state: "unsupported";
+} | {
+    state: "notInstalled";
+} | {
+    state: "notRunning";
+    version: string;
+} | {
+    state: "tooOld";
+    version: string;
+    need: string;
+    fix: string;
+} | {
+    state: "stale";
+    version: string;
+    server: string;
+    fix: string;
+};
+/** One picture of the terminal: ANSI bytes that paint it — the whole viewport when `full`, else only the cells that changed. */
+export interface TerminalFrame {
+    seq: number;
+    width: number;
+    height: number;
+    full: boolean;
+    bytes: Uint8Array;
+}
+/** A live terminal of a herdr pane. The frames repaint the viewport only: scrolling back is asked for with `scroll`. */
+export interface TerminalHandle {
+    readonly paneId: string;
+    readonly mode: "control" | "observe";
+    onFrame(listener: (frame: TerminalFrame) => void): Disposer;
+    /** Once, when the stream ends: herdr's reason, or what it said when it would not attach. */
+    onClose(listener: (reason: string | null) => void): Disposer;
+    /** Keys and pastes; a controller's only — an observer's input is dropped. */
+    input(data: string | Uint8Array): void;
+    resize(cols: number, rows: number): void;
+    scroll(scroll: {
+        direction: "up" | "down";
+        lines: number;
+        column?: number;
+        row?: number;
+        modifiers?: number;
+    }): void;
+    mouse(mouse: {
+        action: "down" | "up" | "drag" | "move";
+        button?: "left" | "middle" | "right" | "none";
+        column: number;
+        row: number;
+        modifiers?: number;
+    }): void;
+    /** Detach: the pane keeps running in herdr. Also done for every terminal the plugin left open when it unloads. */
+    close(): void;
+}
+/**
+ * SDK 0.2.10. Terminals of the herdr panes code sessions run in, through the
+ * app: a plugin neither reaches herdr's socket nor starts its CLI itself.
+ */
+export interface TerminalsApi {
+    state(): Promise<TerminalBridgeState>;
+    /** `control` (the default) takes input and size from any other owner; `observe` watches beside others. Rejects when `state()` is not ready. */
+    open(paneId: string, opts: {
+        mode?: "control" | "observe";
+        cols: number;
+        rows: number;
+    }): Promise<TerminalHandle>;
+}
+//# sourceMappingURL=terminals.d.ts.map

package/dist/terminals.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=terminals.js.map

package/dist/web-search.d.ts

@@ -0,0 +1,54 @@
+import type { Disposer } from "./contract.js";
+type Maybe<T> = T | Promise<T>;
+/** SDK 0.2.9. What the agent's `web_search` asks for; defaults are filled in before a provider sees it. */
+export interface WebSearchRequest {
+    query: string;
+    maxResults: number;
+    topic: "general" | "news";
+    timeRange?: "day" | "week" | "month" | "year";
+    includeDomains?: string[];
+    excludeDomains?: string[];
+}
+export interface WebSearchHit {
+    title: string;
+    url: string;
+    /** An excerpt, not the page. */
+    content: string;
+    published?: string;
+}
+export interface WebReadRequest {
+    urls: string[];
+    /** Keep only the passages relevant to this. */
+    query?: string;
+}
+export interface WebReadResponse {
+    pages: {
+        url: string;
+        content: string;
+    }[];
+    failed: {
+        url: string;
+        error: string;
+    }[];
+}
+/** One search backend, as the app's own providers are: the first registered one that is available answers. */
+export interface WebSearchProviderSpec {
+    /** Namespaced like every id a plugin registers. */
+    id: string;
+    title: string;
+    /** Why it cannot answer yet (no API key, say), or null when it can. Called often and synchronously: keep it cheap. The agent reads it as the tool's error. */
+    unavailable(): string | null;
+    search(request: WebSearchRequest, signal: AbortSignal): Maybe<{
+        results: WebSearchHit[];
+    }>;
+    /** Pages as Markdown. Without it, `web_fetch` is left to another provider. */
+    read?(request: WebReadRequest, signal: AbortSignal): Maybe<WebReadResponse>;
+    /** The settings pane where the person sets it up: the plugin's own section id, or an app pane such as "assistant" (models). */
+    settings?: string;
+}
+export interface WebSearchApi {
+    /** Answers the agent's `web_search` (and `web_fetch`, with `read`) until disposed or the plugin unloads. */
+    register(provider: WebSearchProviderSpec): Promise<Disposer>;
+}
+export {};
+//# sourceMappingURL=web-search.d.ts.map

package/dist/web-search.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=web-search.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tomradex/plugin-sdk",
-  "version": "0.2.0",
+  "version": "0.2.16",
   "type": "module",
   "author": "Haoyuan Tang",
   "engines": {
@@ -29,7 +29,7 @@
     "dist"
   ],
   "dependencies": {
-    "@tomradex/domain": "0.2.0",
+    "@tomradex/domain": "0.2.16",
     "zod": "^4.4.3"
   }
 }