@nikcli-ai/plugin 1.161.0 → 1.167.0

package/dist/index.d.ts

@@ -205,6 +205,8 @@ export interface Hooks {
     "tool.execute.before"?: (input: {
         tool: string;
         sessionID: string;
+        agent: string;
+        messageID: string;
         callID: string;
     }, output: {
         args: any;
@@ -212,6 +214,8 @@ export interface Hooks {
     "tool.execute.after"?: (input: {
         tool: string;
         sessionID: string;
+        agent: string;
+        messageID: string;
         callID: string;
     }, output: {
         title: string;

package/dist/tool.d.ts

@@ -2,6 +2,7 @@ import { z } from "zod";
 export type ToolContext = {
     sessionID: string;
     messageID: string;
+    callID: string;
     agent: string;
     abort: AbortSignal;
     metadata(input: {
@@ -10,8 +11,22 @@ export type ToolContext = {
             [key: string]: any;
         };
     }): void;
+    progress(input: ToolProgress): Promise<void>;
     ask(input: AskInput): Promise<void>;
 };
+export type ToolProgressContent = {
+    readonly type: "text";
+    readonly text: string;
+} | {
+    readonly type: "file";
+    readonly data: string;
+    readonly mime: string;
+    readonly name?: string;
+};
+export type ToolProgress = {
+    readonly structured: Readonly<Record<string, unknown>>;
+    readonly content?: ReadonlyArray<ToolProgressContent>;
+};
 type AskInput = {
     permission: string;
     patterns: string[];

package/dist/tui.d.ts

@@ -2,6 +2,7 @@ import type { NikcliClient, Event, LspStatus, McpStatus, Todo, Message, Part, Pr
 import type { CliRenderer, ParsedKey, RGBA } from "@opentui/core";
 import type { JSX, SolidPlugin } from "@opentui/solid";
 import type { Config as PluginConfig, PluginOptions } from "./index.js";
+import type { Data as TuiV2Data } from "./v2/tui/context.js";
 export type { CliRenderer, SlotMode } from "@opentui/core";
 export type TuiRouteCurrent = {
     name: "home";
@@ -278,6 +279,16 @@ export type TuiSlotMap = {
     sidebar_footer: {
         session_id: string;
     };
+    /** V2 plugin slots. Dotted names intentionally do not collide with v1 slots. */
+    "app.bottom": {};
+    "home.bottom": {};
+    "home.footer": {};
+    "sidebar.content": {
+        sessionID: string;
+    };
+    "sidebar.footer": {
+        sessionID: string;
+    };
 };
 export type TuiSlotContext = {
     theme: TuiTheme;
@@ -288,11 +299,16 @@ export type TuiSlotPlugin = Omit<SlotCore, "id"> & {
 };
 export type TuiSlots = {
     register: (plugin: TuiSlotPlugin) => string;
+    /** Host-backed disposable registration used by the v2 compatibility runtime. */
+    registerDisposable: (plugin: TuiSlotPlugin) => () => void;
 };
 export type TuiEventBus = {
     on: <Type extends Event["type"]>(type: Type, handler: (event: Extract<Event, {
         type: Type;
     }>) => void) => () => void;
+    listen: (handler: (event: {
+        details: Event;
+    }) => void) => () => void;
 };
 export type TuiDispose = () => void | Promise<void>;
 export type TuiLifecycle = {
@@ -368,6 +384,8 @@ export type TuiPluginApi = {
     readonly tuiConfig: Frozen<TuiConfigView>;
     kv: TuiKV;
     state: TuiState;
+    /** Full reactive data contract used by v2 TUI plugins. */
+    data: TuiV2Data;
     theme: TuiTheme;
     client: NikcliClient;
     event: TuiEventBus;

package/dist/v2/effect/index.d.ts

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

package/dist/v2/effect/index.js

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

package/dist/v2/effect/tool.d.ts

@@ -0,0 +1,41 @@
+import { Effect } from "effect";
+import z from "zod";
+import { type ToolAttachment, type ToolContext, type ToolProgress, type ToolProgressContent, type ToolResult } from "../../tool.js";
+export type Context = Omit<ToolContext, "progress"> & {
+    readonly progress: (update: ToolProgress) => Effect.Effect<void>;
+};
+export type Progress = ToolProgress;
+export type Content = ToolProgressContent;
+export type Attachment = ToolAttachment;
+export type Result = ToolResult;
+export interface ToolExecuteBeforeEvent {
+    readonly tool: string;
+    readonly sessionID: string;
+    readonly agent: string;
+    readonly messageID: string;
+    readonly callID: string;
+    input: unknown;
+}
+export interface ToolExecuteAfterEvent {
+    readonly tool: string;
+    readonly sessionID: string;
+    readonly agent: string;
+    readonly messageID: string;
+    readonly callID: string;
+    readonly input: unknown;
+    result: ToolResult;
+}
+export declare function tool<Args extends z.ZodRawShape>(input: {
+    description: string;
+    args: Args;
+    execute(args: z.infer<z.ZodObject<Args>>, context: Context): Effect.Effect<ToolResult, Error>;
+}): {
+    description: string;
+    args: Args;
+    execute(args: z.core.$InferObjectOutput<Args, {}>, context: ToolContext): Promise<ToolResult>;
+};
+export declare namespace tool {
+    var schema: typeof z;
+}
+export declare const make: typeof tool;
+export type ToolDefinition = ReturnType<typeof tool>;

package/dist/v2/effect/tool.js

@@ -0,0 +1,15 @@
+import { Effect } from "effect";
+import z from "zod";
+import { tool as promiseTool, } from "../../tool.js";
+export function tool(input) {
+    return promiseTool({
+        description: input.description,
+        args: input.args,
+        execute: (args, context) => Effect.runPromise(input.execute(args, {
+            ...context,
+            progress: (update) => Effect.promise(() => context.progress(update)),
+        })),
+    });
+}
+tool.schema = z;
+export const make = tool;

package/dist/v2/promise/index.d.ts

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

package/dist/v2/promise/index.js

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

package/dist/v2/promise/tool.d.ts

@@ -0,0 +1,18 @@
+export { tool, tool as make, type ToolAttachment as Attachment, type ToolContext as Context, type ToolDefinition, type ToolProgress as Progress, type ToolProgressContent as Content, type ToolResult as Result, } from "../../tool.js";
+export interface ToolExecuteBeforeEvent {
+    readonly tool: string;
+    readonly sessionID: string;
+    readonly agent: string;
+    readonly messageID: string;
+    readonly callID: string;
+    input: unknown;
+}
+export interface ToolExecuteAfterEvent {
+    readonly tool: string;
+    readonly sessionID: string;
+    readonly agent: string;
+    readonly messageID: string;
+    readonly callID: string;
+    readonly input: unknown;
+    result: import("../../tool.js").ToolResult;
+}

package/dist/v2/promise/tool.js

@@ -0,0 +1 @@
+export { tool, tool as make, } from "../../tool.js";

package/dist/v2/tui/context.d.ts

@@ -0,0 +1,142 @@
+import type { Agent, Command, ConnectorStatus, Event, McpResource, McpStatus, Message, Model, NikcliClient, Part, PermissionRequest, PermissionRule, Provider, Pty, QuestionRequest, ReferenceConfig, Session, SessionEntryAssistantReasoning, SessionEntryAssistantRetry, SessionEntryAssistantText, SessionEntryAssistantTool, SessionEntrySynthetic, SessionEntryUser } from "@nikcli-ai/sdk/v2";
+import type { JSX } from "@opentui/solid";
+export type LocationRef = {
+    readonly directory: string;
+    readonly workspaceID?: string;
+};
+export type SessionInfo = Session;
+export type SessionPendingInfo = SessionEntryUser | SessionEntrySynthetic | SessionEntryAssistantText | SessionEntryAssistantReasoning | SessionEntryAssistantTool | SessionEntryAssistantRetry;
+export type SessionMessageInfo = {
+    readonly info: Message;
+    readonly parts: Part[];
+};
+export type PermissionV2Request = PermissionRequest;
+export type FormInfo = QuestionRequest;
+export type PermissionSavedInfo = PermissionRule;
+export type ShellInfo = Pty;
+export type AgentInfo = Agent;
+export type CommandInfo = Command;
+export type IntegrationInfo = {
+    readonly name: string;
+    readonly status: ConnectorStatus;
+};
+export type McpServer = {
+    readonly name: string;
+    readonly status: McpStatus;
+};
+export type ModelInfo = Model;
+export type ProviderV2Info = Provider;
+export type ReferenceInfo = ReferenceConfig & {
+    readonly name: string;
+};
+export type SkillInfo = {
+    readonly name: string;
+    readonly description: string;
+    readonly location: string;
+    readonly category?: string;
+    readonly tags?: string[];
+    readonly version?: string;
+};
+interface LocationCollection<Value> {
+    list(location?: LocationRef): Value[] | undefined;
+    refresh(location?: LocationRef): Promise<void>;
+}
+/** Reactive nikcli data exposed to a v2 TUI plugin. */
+export interface Data {
+    readonly on: <Type extends Event["type"]>(type: Type, handler: (event: Extract<Event, {
+        type: Type;
+    }>) => void) => () => void;
+    readonly listen: (handler: (event: {
+        details: Event;
+    }) => void) => () => void;
+    readonly session: {
+        list(): SessionInfo[];
+        get(sessionID: string): SessionInfo | undefined;
+        root(sessionID: string): string;
+        family(sessionID: string): string[];
+        cost(sessionID: string): number;
+        status(sessionID: string): "idle" | "running";
+        readonly pending: {
+            list(sessionID: string): SessionPendingInfo[];
+            refresh(sessionID: string): Promise<void>;
+        };
+        refresh(sessionID: string): Promise<void>;
+        readonly message: {
+            list(sessionID: string): SessionMessageInfo[];
+            get(sessionID: string, messageID: string): SessionMessageInfo | undefined;
+            refresh(sessionID: string): Promise<void>;
+        };
+        readonly permission: {
+            list(sessionID: string): PermissionV2Request[] | undefined;
+            refresh(sessionID: string): Promise<void>;
+        };
+        readonly form: {
+            list(sessionID: string, location?: LocationRef): Array<FormInfo & {
+                readonly location?: LocationRef;
+            }> | undefined;
+            refresh(sessionID: string, location?: LocationRef): Promise<void>;
+        };
+    };
+    readonly project: {
+        readonly permission: {
+            list(projectID: string): PermissionSavedInfo[] | undefined;
+            refresh(projectID: string): Promise<void>;
+        };
+    };
+    readonly shell: {
+        list(location?: LocationRef): ShellInfo[];
+        get(id: string): ShellInfo | undefined;
+        refresh(location?: LocationRef): Promise<void>;
+    };
+    readonly location: {
+        default(): LocationRef;
+        refresh(location?: LocationRef): Promise<void>;
+        readonly agent: LocationCollection<AgentInfo>;
+        readonly command: LocationCollection<CommandInfo>;
+        readonly integration: LocationCollection<IntegrationInfo>;
+        readonly mcp: {
+            readonly server: LocationCollection<McpServer>;
+            readonly resource: LocationCollection<McpResource>;
+        };
+        readonly model: LocationCollection<ModelInfo>;
+        readonly provider: LocationCollection<ProviderV2Info>;
+        readonly reference: LocationCollection<ReferenceInfo>;
+        readonly skill: LocationCollection<SkillInfo>;
+    };
+}
+export type Route = {
+    readonly type: "home";
+} | {
+    readonly type: "session";
+    readonly sessionID: string;
+} | {
+    readonly type: "plugin";
+    readonly id: string;
+    readonly name: string;
+    readonly data?: Record<string, unknown>;
+};
+export type Destination = Route | Omit<Extract<Route, {
+    readonly type: "plugin";
+}>, "id">;
+export interface Page {
+    readonly name: string;
+    readonly render: (input: {
+        readonly data?: Record<string, unknown>;
+    }) => JSX.Element;
+}
+export type Slot = (props: Record<string, unknown>) => JSX.Element;
+export interface UI {
+    readonly router: {
+        register(page: Page): () => void;
+        navigate(destination: Destination): void;
+        current(): Route;
+    };
+    readonly slot: (name: string, render: Slot) => () => void;
+}
+export interface Context {
+    readonly options: Readonly<Record<string, unknown>>;
+    readonly client: NikcliClient;
+    readonly data: Data;
+    readonly ui: UI;
+}
+export {};

package/dist/v2/tui/index.d.ts

@@ -0,0 +1 @@
+export * as Plugin from "./plugin.js";

package/dist/v2/tui/index.js

@@ -0,0 +1 @@
+export * as Plugin from "./plugin.js";

package/dist/v2/tui/plugin.d.ts

@@ -0,0 +1,8 @@
+import type { Context } from "./context.js";
+export type { Context };
+export type Cleanup = () => Promise<void> | void;
+export interface Definition {
+    readonly id: string;
+    readonly setup: (context: Context) => Promise<Cleanup | void> | Cleanup | void;
+}
+export declare function define(plugin: Definition): Definition;

package/dist/v2/tui/plugin.js

@@ -0,0 +1,3 @@
+export function define(plugin) {
+    return plugin;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
   "name": "@nikcli-ai/plugin",
-  "version": "1.161.0",
+  "version": "1.167.0",
   "type": "module",
   "license": "MIT",
   "scripts": {
@@ -22,6 +22,30 @@
     "./tui": {
       "import": "./src/tui.ts",
       "types": "./src/tui.ts"
+    },
+    "./v2/tui": {
+      "import": "./src/v2/tui/index.ts",
+      "types": "./src/v2/tui/index.ts"
+    },
+    "./v2/tui/*": {
+      "import": "./src/v2/tui/*.ts",
+      "types": "./src/v2/tui/*.ts"
+    },
+    "./v2/effect": {
+      "import": "./src/v2/effect/index.ts",
+      "types": "./src/v2/effect/index.ts"
+    },
+    "./v2/effect/tool": {
+      "import": "./src/v2/effect/tool.ts",
+      "types": "./src/v2/effect/tool.ts"
+    },
+    "./v2/promise": {
+      "import": "./src/v2/promise/index.ts",
+      "types": "./src/v2/promise/index.ts"
+    },
+    "./v2/promise/tool": {
+      "import": "./src/v2/promise/tool.ts",
+      "types": "./src/v2/promise/tool.ts"
     }
   },
   "files": [
@@ -31,13 +55,20 @@
     "exports": {
       ".": "./dist/index.js",
       "./tool": "./dist/tool.js",
-      "./tui": "./dist/tui.js"
+      "./tui": "./dist/tui.js",
+      "./v2/tui": "./dist/v2/tui/index.js",
+      "./v2/tui/*": "./dist/v2/tui/*.js",
+      "./v2/effect": "./dist/v2/effect/index.js",
+      "./v2/effect/tool": "./dist/v2/effect/tool.js",
+      "./v2/promise": "./dist/v2/promise/index.js",
+      "./v2/promise/tool": "./dist/v2/promise/tool.js"
     }
   },
   "dependencies": {
-    "@nikcli-ai/sdk": "1.161.0",
+    "@nikcli-ai/sdk": "1.167.0",
     "@opentui/core": "0.1.91",
     "@opentui/solid": "0.1.91",
+    "effect": "4.0.0-beta.83",
     "zod": "4.1.8"
   },
   "devDependencies": {