@4fu/arbor-tools 0.0.0-stage → 0.1.0

package/modules/modules.d.ts

@@ -0,0 +1,121 @@
+/**
+ * The code mode modules: `journal`, `windows`, `board`, `notes`, `channels`
+ * and `workspace` (docs/tools.md#modules).
+ *
+ * A module whose backing feature is not configured is absent. The prompt names
+ * a module, never a function; how to call one comes from `tool_search` and
+ * `tool_describe`, which read the same catalog the window was opened with.
+ * `env`, `services` and the MCP servers' own modules are in `./env.ts`.
+ */
+import type { CallContext, ModuleSpec, ToolCall, ToolGroup, ToolResult } from "@4fu/arbor-interfaces";
+import type { LiveWindow, ToolServices } from "../host.ts";
+/** `journal`: search, show, around, trace, links. */
+export declare class JournalModuleGroup implements ToolGroup {
+    readonly id = "modules.journal";
+    private readonly services;
+    constructor(services: ToolServices);
+    tools(): readonly [];
+    modules(): readonly ModuleSpec[];
+    call(request: ToolCall, _context: CallContext): Promise<ToolResult>;
+    private answer;
+    private notOwned;
+}
+/** `windows`: list, show, send, broadcast, inbox. */
+export declare class WindowsModuleGroup implements ToolGroup {
+    readonly id = "modules.windows";
+    private readonly services;
+    constructor(services: ToolServices);
+    tools(): readonly [];
+    modules(): readonly ModuleSpec[];
+    call(request: ToolCall, context: CallContext): Promise<ToolResult>;
+    private notOwned;
+}
+/** `board`: list, set, expect, unexpect. */
+export declare class BoardModuleGroup implements ToolGroup {
+    readonly id = "modules.board";
+    private readonly services;
+    constructor(services: ToolServices);
+    tools(): readonly [];
+    modules(): readonly ModuleSpec[];
+    call(request: ToolCall, context: CallContext): Promise<ToolResult>;
+    private notOwned;
+}
+/** `notes`: search, read, context, active. Absent without a `NoteStore`. */
+export declare class NotesModuleGroup implements ToolGroup {
+    readonly id = "modules.notes";
+    private readonly services;
+    constructor(services: ToolServices);
+    tools(): readonly [];
+    modules(): readonly ModuleSpec[];
+    call(request: ToolCall, _context: CallContext): Promise<ToolResult>;
+    private notOwned;
+}
+/** `channels`: list, get. Absent when no plugin registered a channel. */
+export declare class ChannelsModuleGroup implements ToolGroup {
+    readonly id = "modules.channels";
+    private readonly services;
+    constructor(services: ToolServices);
+    tools(): readonly [];
+    modules(): readonly ModuleSpec[];
+    call(request: ToolCall, _context: CallContext): Promise<ToolResult>;
+    /** `channels.list`: every channel, and what is connected on it. */
+    private list;
+    /** `channels.get(ref)`: one outside message, by its native id. */
+    private get;
+    /** The channel a native id names, by its prefix: `http:42` is `http`'s. */
+    private channelOf;
+    private notOwned;
+}
+/** `tasks`: list, show. The tasks the host dispatched (docs/dispatch.md#tasks). */
+export declare class TasksModuleGroup implements ToolGroup {
+    readonly id = "modules.tasks";
+    private readonly services;
+    constructor(services: ToolServices);
+    tools(): readonly [];
+    modules(): readonly ModuleSpec[];
+    call(request: ToolCall, _context: CallContext): Promise<ToolResult>;
+    /** One task as one line: its ref, its kind, why it is one, its targets and its time. */
+    private line;
+    private notOwned;
+}
+/** `schedule`: list, create, update, cancel (docs/dispatch.md#scheduled-tasks). */
+export declare class ScheduleModuleGroup implements ToolGroup {
+    readonly id = "modules.schedule";
+    private readonly services;
+    constructor(services: ToolServices);
+    tools(): readonly [];
+    modules(): readonly ModuleSpec[];
+    call(request: ToolCall, _context: CallContext): Promise<ToolResult>;
+    /** `schedule.create`: one new scheduled task, from what the script named. */
+    private create;
+    /** `schedule.update`: only the fields the script named change. */
+    private update;
+    /** One repeat rule as one line: only once, a period, or a daily clock time. */
+    private repeatText;
+    /** One argument the script did not name in a shape this module can read. */
+    private badInput;
+    private notFound;
+    private notOwned;
+}
+/** `workspace`: grep, find, ls. Absent when the host has no workspace. */
+export declare class WorkspaceModuleGroup implements ToolGroup {
+    readonly id = "modules.workspace";
+    private readonly services;
+    constructor(services: ToolServices);
+    tools(): readonly [];
+    modules(): readonly ModuleSpec[];
+    call(request: ToolCall, context: CallContext): Promise<ToolResult>;
+    private ls;
+    private find;
+    private grep;
+    /**
+     * One lookup inside the workspace. An implementation that owns the execution
+     * environment answers with `exec`, because its `path` is not a host path;
+     * `null` means the caller walks the host directory itself.
+     */
+    private runIn;
+    private absent;
+    private notOwned;
+}
+export { EnvModuleGroup } from "./env.ts";
+export type { LiveWindow };