agentool 0.0.1 → 1.0.0

package/dist/memory/index.d.cts

@@ -0,0 +1,63 @@
+import * as ai from 'ai';
+import { B as BaseToolConfig } from '../types-3QPDuCXN.cjs';
+
+/**
+ * Configuration for the memory tool.
+ * Extends {@link BaseToolConfig} with an optional memory directory path.
+ *
+ * @example
+ * ```typescript
+ * import type { MemoryConfig } from 'agentool/memory';
+ * const config: MemoryConfig = { memoryDir: '/my/project/.agentool/memory' };
+ * ```
+ */
+interface MemoryConfig extends BaseToolConfig {
+    /** Directory for memory files. Defaults to `<cwd>/.agentool/memory`. */
+    memoryDir?: string;
+}
+/**
+ * Creates a memory tool that provides file-based key-value storage.
+ *
+ * Memory entries are stored as individual `.md` files inside the configured
+ * memory directory. Keys are sanitized to prevent path traversal.
+ * Execute never throws; errors are returned as descriptive strings.
+ *
+ * @param config - Optional configuration for cwd and memory directory.
+ * @returns A Vercel AI SDK tool with `description`, `parameters`, and `execute`.
+ *
+ * @example
+ * ```typescript
+ * import { createMemory } from 'agentool/memory';
+ *
+ * const memTool = createMemory({ cwd: '/my/project' });
+ * const result = await memTool.execute(
+ *   { action: 'write', key: 'notes', content: 'Hello' },
+ *   { toolCallId: 'id', messages: [] },
+ * );
+ * ```
+ */
+declare function createMemory(config?: MemoryConfig): ai.Tool<{
+    action: "read" | "write" | "list" | "delete";
+    content?: string | undefined;
+    key?: string | undefined;
+}, string>;
+/**
+ * Default memory tool instance using `.agentool/memory` under the current
+ * working directory.
+ *
+ * @example
+ * ```typescript
+ * import { memory } from 'agentool/memory';
+ * const result = await memory.execute(
+ *   { action: 'list' },
+ *   { toolCallId: 'id', messages: [] },
+ * );
+ * ```
+ */
+declare const memory: ai.Tool<{
+    action: "read" | "write" | "list" | "delete";
+    content?: string | undefined;
+    key?: string | undefined;
+}, string>;
+
+export { type MemoryConfig, createMemory, memory };

package/dist/memory/index.d.ts

@@ -0,0 +1,63 @@
+import * as ai from 'ai';
+import { B as BaseToolConfig } from '../types-3QPDuCXN.js';
+
+/**
+ * Configuration for the memory tool.
+ * Extends {@link BaseToolConfig} with an optional memory directory path.
+ *
+ * @example
+ * ```typescript
+ * import type { MemoryConfig } from 'agentool/memory';
+ * const config: MemoryConfig = { memoryDir: '/my/project/.agentool/memory' };
+ * ```
+ */
+interface MemoryConfig extends BaseToolConfig {
+    /** Directory for memory files. Defaults to `<cwd>/.agentool/memory`. */
+    memoryDir?: string;
+}
+/**
+ * Creates a memory tool that provides file-based key-value storage.
+ *
+ * Memory entries are stored as individual `.md` files inside the configured
+ * memory directory. Keys are sanitized to prevent path traversal.
+ * Execute never throws; errors are returned as descriptive strings.
+ *
+ * @param config - Optional configuration for cwd and memory directory.
+ * @returns A Vercel AI SDK tool with `description`, `parameters`, and `execute`.
+ *
+ * @example
+ * ```typescript
+ * import { createMemory } from 'agentool/memory';
+ *
+ * const memTool = createMemory({ cwd: '/my/project' });
+ * const result = await memTool.execute(
+ *   { action: 'write', key: 'notes', content: 'Hello' },
+ *   { toolCallId: 'id', messages: [] },
+ * );
+ * ```
+ */
+declare function createMemory(config?: MemoryConfig): ai.Tool<{
+    action: "read" | "write" | "list" | "delete";
+    content?: string | undefined;
+    key?: string | undefined;
+}, string>;
+/**
+ * Default memory tool instance using `.agentool/memory` under the current
+ * working directory.
+ *
+ * @example
+ * ```typescript
+ * import { memory } from 'agentool/memory';
+ * const result = await memory.execute(
+ *   { action: 'list' },
+ *   { toolCallId: 'id', messages: [] },
+ * );
+ * ```
+ */
+declare const memory: ai.Tool<{
+    action: "read" | "write" | "list" | "delete";
+    content?: string | undefined;
+    key?: string | undefined;
+}, string>;
+
+export { type MemoryConfig, createMemory, memory };

package/dist/memory/index.js

@@ -0,0 +1,9 @@
+import {
+  createMemory,
+  memory
+} from "../chunk-VLNDEVKS.js";
+import "../chunk-I3ONDY7P.js";
+export {
+  createMemory,
+  memory
+};

package/dist/multi-edit/index.cjs

@@ -0,0 +1,11 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+var _chunk3VO6NETRcjs = require('../chunk-3VO6NETR.cjs');
+require('../chunk-5NW4OGRI.cjs');
+require('../chunk-CAEVLIQB.cjs');
+require('../chunk-QZ5GS6HW.cjs');
+
+
+
+exports.createMultiEdit = _chunk3VO6NETRcjs.createMultiEdit; exports.multiEdit = _chunk3VO6NETRcjs.multiEdit;

package/dist/multi-edit/index.d.cts

@@ -0,0 +1,72 @@
+import * as ai from 'ai';
+import { B as BaseToolConfig } from '../types-3QPDuCXN.cjs';
+
+/**
+ * Configuration for the multi-edit tool.
+ *
+ * @example
+ * ```typescript
+ * import type { MultiEditConfig } from 'agentool/multi-edit';
+ * const config: MultiEditConfig = { cwd: '/my/project' };
+ * ```
+ */
+type MultiEditConfig = BaseToolConfig;
+/**
+ * Creates a multi-edit tool that atomically applies multiple string
+ * replacements to a single file.
+ *
+ * All edits are validated and applied in memory first. The file is only
+ * written when every edit succeeds. If any edit fails (not found or
+ * non-unique), the file is left unchanged and an error is returned.
+ *
+ * @param config - Optional configuration for the working directory.
+ * @returns A Vercel AI SDK tool with `description`, `parameters`, and `execute`.
+ *
+ * @example
+ * ```typescript
+ * import { createMultiEdit } from 'agentool/multi-edit';
+ *
+ * const multiEditTool = createMultiEdit({ cwd: '/my/project' });
+ * const result = await multiEditTool.execute(
+ *   {
+ *     file_path: 'src/index.ts',
+ *     edits: [
+ *       { old_string: 'foo', new_string: 'bar' },
+ *       { old_string: 'baz', new_string: 'qux' },
+ *     ],
+ *   },
+ *   { toolCallId: 'id', messages: [] },
+ * );
+ * ```
+ */
+declare function createMultiEdit(config?: MultiEditConfig): ai.Tool<{
+    file_path: string;
+    edits: {
+        old_string: string;
+        new_string: string;
+    }[];
+}, string>;
+/**
+ * Default multi-edit tool instance using the current working directory.
+ *
+ * @example
+ * ```typescript
+ * import { multiEdit } from 'agentool/multi-edit';
+ * const result = await multiEdit.execute(
+ *   {
+ *     file_path: 'file.txt',
+ *     edits: [{ old_string: 'a', new_string: 'b' }],
+ *   },
+ *   { toolCallId: 'id', messages: [] },
+ * );
+ * ```
+ */
+declare const multiEdit: ai.Tool<{
+    file_path: string;
+    edits: {
+        old_string: string;
+        new_string: string;
+    }[];
+}, string>;
+
+export { type MultiEditConfig, createMultiEdit, multiEdit };

package/dist/multi-edit/index.d.ts

@@ -0,0 +1,72 @@
+import * as ai from 'ai';
+import { B as BaseToolConfig } from '../types-3QPDuCXN.js';
+
+/**
+ * Configuration for the multi-edit tool.
+ *
+ * @example
+ * ```typescript
+ * import type { MultiEditConfig } from 'agentool/multi-edit';
+ * const config: MultiEditConfig = { cwd: '/my/project' };
+ * ```
+ */
+type MultiEditConfig = BaseToolConfig;
+/**
+ * Creates a multi-edit tool that atomically applies multiple string
+ * replacements to a single file.
+ *
+ * All edits are validated and applied in memory first. The file is only
+ * written when every edit succeeds. If any edit fails (not found or
+ * non-unique), the file is left unchanged and an error is returned.
+ *
+ * @param config - Optional configuration for the working directory.
+ * @returns A Vercel AI SDK tool with `description`, `parameters`, and `execute`.
+ *
+ * @example
+ * ```typescript
+ * import { createMultiEdit } from 'agentool/multi-edit';
+ *
+ * const multiEditTool = createMultiEdit({ cwd: '/my/project' });
+ * const result = await multiEditTool.execute(
+ *   {
+ *     file_path: 'src/index.ts',
+ *     edits: [
+ *       { old_string: 'foo', new_string: 'bar' },
+ *       { old_string: 'baz', new_string: 'qux' },
+ *     ],
+ *   },
+ *   { toolCallId: 'id', messages: [] },
+ * );
+ * ```
+ */
+declare function createMultiEdit(config?: MultiEditConfig): ai.Tool<{
+    file_path: string;
+    edits: {
+        old_string: string;
+        new_string: string;
+    }[];
+}, string>;
+/**
+ * Default multi-edit tool instance using the current working directory.
+ *
+ * @example
+ * ```typescript
+ * import { multiEdit } from 'agentool/multi-edit';
+ * const result = await multiEdit.execute(
+ *   {
+ *     file_path: 'file.txt',
+ *     edits: [{ old_string: 'a', new_string: 'b' }],
+ *   },
+ *   { toolCallId: 'id', messages: [] },
+ * );
+ * ```
+ */
+declare const multiEdit: ai.Tool<{
+    file_path: string;
+    edits: {
+        old_string: string;
+        new_string: string;
+    }[];
+}, string>;
+
+export { type MultiEditConfig, createMultiEdit, multiEdit };

package/dist/multi-edit/index.js

@@ -0,0 +1,11 @@
+import {
+  createMultiEdit,
+  multiEdit
+} from "../chunk-EA3YV7ZG.js";
+import "../chunk-G3ITTPGX.js";
+import "../chunk-6PQLFDGT.js";
+import "../chunk-I3ONDY7P.js";
+export {
+  createMultiEdit,
+  multiEdit
+};

package/dist/read/index.cjs

@@ -0,0 +1,10 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+var _chunkTBVHHF3Hcjs = require('../chunk-TBVHHF3H.cjs');
+require('../chunk-CAEVLIQB.cjs');
+require('../chunk-QZ5GS6HW.cjs');
+
+
+
+exports.createRead = _chunkTBVHHF3Hcjs.createRead; exports.read = _chunkTBVHHF3Hcjs.read;

package/dist/read/index.d.cts

@@ -0,0 +1,67 @@
+import * as ai from 'ai';
+import { B as BaseToolConfig } from '../types-3QPDuCXN.cjs';
+
+/**
+ * Configuration for the read tool.
+ * Extends {@link BaseToolConfig} with an optional maximum line count.
+ *
+ * @example
+ * ```typescript
+ * import type { ReadConfig } from 'agentool/read';
+ * const config: ReadConfig = { cwd: '/my/project', maxLines: 500 };
+ * ```
+ */
+interface ReadConfig extends BaseToolConfig {
+    /**
+     * Maximum number of lines to return when no explicit limit is given.
+     * @default 2000
+     */
+    maxLines?: number;
+}
+/**
+ * Creates a read tool that reads file contents with line numbers.
+ *
+ * The tool resolves the given path (supporting `~` and relative paths),
+ * reads the requested range of lines, and returns the content with
+ * `cat -n` style line numbers. It never throws; errors are returned as
+ * descriptive strings.
+ *
+ * @param config - Optional configuration for cwd and max lines.
+ * @returns A Vercel AI SDK tool with `description`, `parameters`, and `execute`.
+ *
+ * @example
+ * ```typescript
+ * import { createRead } from 'agentool/read';
+ *
+ * const readTool = createRead({ cwd: '/my/project' });
+ * const result = await readTool.execute(
+ *   { file_path: 'src/index.ts' },
+ *   { toolCallId: 'id', messages: [] },
+ * );
+ * ```
+ */
+declare function createRead(config?: ReadConfig): ai.Tool<{
+    file_path: string;
+    offset?: number | undefined;
+    limit?: number | undefined;
+}, string>;
+/**
+ * Default read tool instance using the current working directory
+ * and a 2000-line default limit.
+ *
+ * @example
+ * ```typescript
+ * import { read } from 'agentool/read';
+ * const result = await read.execute(
+ *   { file_path: '/tmp/file.txt' },
+ *   { toolCallId: 'id', messages: [] },
+ * );
+ * ```
+ */
+declare const read: ai.Tool<{
+    file_path: string;
+    offset?: number | undefined;
+    limit?: number | undefined;
+}, string>;
+
+export { type ReadConfig, createRead, read };

package/dist/read/index.d.ts

@@ -0,0 +1,67 @@
+import * as ai from 'ai';
+import { B as BaseToolConfig } from '../types-3QPDuCXN.js';
+
+/**
+ * Configuration for the read tool.
+ * Extends {@link BaseToolConfig} with an optional maximum line count.
+ *
+ * @example
+ * ```typescript
+ * import type { ReadConfig } from 'agentool/read';
+ * const config: ReadConfig = { cwd: '/my/project', maxLines: 500 };
+ * ```
+ */
+interface ReadConfig extends BaseToolConfig {
+    /**
+     * Maximum number of lines to return when no explicit limit is given.
+     * @default 2000
+     */
+    maxLines?: number;
+}
+/**
+ * Creates a read tool that reads file contents with line numbers.
+ *
+ * The tool resolves the given path (supporting `~` and relative paths),
+ * reads the requested range of lines, and returns the content with
+ * `cat -n` style line numbers. It never throws; errors are returned as
+ * descriptive strings.
+ *
+ * @param config - Optional configuration for cwd and max lines.
+ * @returns A Vercel AI SDK tool with `description`, `parameters`, and `execute`.
+ *
+ * @example
+ * ```typescript
+ * import { createRead } from 'agentool/read';
+ *
+ * const readTool = createRead({ cwd: '/my/project' });
+ * const result = await readTool.execute(
+ *   { file_path: 'src/index.ts' },
+ *   { toolCallId: 'id', messages: [] },
+ * );
+ * ```
+ */
+declare function createRead(config?: ReadConfig): ai.Tool<{
+    file_path: string;
+    offset?: number | undefined;
+    limit?: number | undefined;
+}, string>;
+/**
+ * Default read tool instance using the current working directory
+ * and a 2000-line default limit.
+ *
+ * @example
+ * ```typescript
+ * import { read } from 'agentool/read';
+ * const result = await read.execute(
+ *   { file_path: '/tmp/file.txt' },
+ *   { toolCallId: 'id', messages: [] },
+ * );
+ * ```
+ */
+declare const read: ai.Tool<{
+    file_path: string;
+    offset?: number | undefined;
+    limit?: number | undefined;
+}, string>;
+
+export { type ReadConfig, createRead, read };

package/dist/read/index.js

@@ -0,0 +1,10 @@
+import {
+  createRead,
+  read
+} from "../chunk-ZHCMEQJJ.js";
+import "../chunk-6PQLFDGT.js";
+import "../chunk-I3ONDY7P.js";
+export {
+  createRead,
+  read
+};

package/dist/sleep/index.cjs

@@ -0,0 +1,8 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+var _chunkOXLQ7QVLcjs = require('../chunk-OXLQ7QVL.cjs');
+
+
+
+exports.createSleep = _chunkOXLQ7QVLcjs.createSleep; exports.sleep = _chunkOXLQ7QVLcjs.sleep;

package/dist/sleep/index.d.cts

@@ -0,0 +1,60 @@
+import * as ai from 'ai';
+import { B as BaseToolConfig } from '../types-3QPDuCXN.cjs';
+
+/**
+ * Configuration for the sleep tool.
+ * Extends {@link BaseToolConfig} with an optional maximum duration cap.
+ *
+ * @example
+ * ```typescript
+ * import type { SleepConfig } from 'agentool/sleep';
+ * const config: SleepConfig = { maxDuration: 60000 };
+ * ```
+ */
+interface SleepConfig extends BaseToolConfig {
+    /**
+     * Maximum allowed sleep duration in milliseconds.
+     * Requested durations exceeding this value are clamped.
+     * @default 300000 (5 minutes)
+     */
+    maxDuration?: number;
+}
+/**
+ * Creates a sleep tool that pauses execution for a specified duration.
+ *
+ * The tool clamps the requested duration to `[0, maxDuration]` and reports
+ * the actual elapsed time. It never throws; errors are returned as strings.
+ *
+ * @param config - Optional configuration with a custom max duration.
+ * @returns A Vercel AI SDK tool with `description`, `parameters`, and `execute`.
+ *
+ * @example
+ * ```typescript
+ * import { createSleep } from 'agentool/sleep';
+ *
+ * // Default max of 300 000 ms
+ * const sleepTool = createSleep();
+ *
+ * // Custom max of 10 seconds
+ * const shortSleep = createSleep({ maxDuration: 10000 });
+ * ```
+ */
+declare function createSleep(config?: SleepConfig): ai.Tool<{
+    durationMs: number;
+    reason?: string | undefined;
+}, string>;
+/**
+ * Default sleep tool instance with a 300 000 ms (5-minute) maximum duration.
+ *
+ * @example
+ * ```typescript
+ * import { sleep } from 'agentool/sleep';
+ * const result = await sleep.execute({ durationMs: 1000, reason: 'rate limit' });
+ * ```
+ */
+declare const sleep: ai.Tool<{
+    durationMs: number;
+    reason?: string | undefined;
+}, string>;
+
+export { type SleepConfig, createSleep, sleep };

package/dist/sleep/index.d.ts

@@ -0,0 +1,60 @@
+import * as ai from 'ai';
+import { B as BaseToolConfig } from '../types-3QPDuCXN.js';
+
+/**
+ * Configuration for the sleep tool.
+ * Extends {@link BaseToolConfig} with an optional maximum duration cap.
+ *
+ * @example
+ * ```typescript
+ * import type { SleepConfig } from 'agentool/sleep';
+ * const config: SleepConfig = { maxDuration: 60000 };
+ * ```
+ */
+interface SleepConfig extends BaseToolConfig {
+    /**
+     * Maximum allowed sleep duration in milliseconds.
+     * Requested durations exceeding this value are clamped.
+     * @default 300000 (5 minutes)
+     */
+    maxDuration?: number;
+}
+/**
+ * Creates a sleep tool that pauses execution for a specified duration.
+ *
+ * The tool clamps the requested duration to `[0, maxDuration]` and reports
+ * the actual elapsed time. It never throws; errors are returned as strings.
+ *
+ * @param config - Optional configuration with a custom max duration.
+ * @returns A Vercel AI SDK tool with `description`, `parameters`, and `execute`.
+ *
+ * @example
+ * ```typescript
+ * import { createSleep } from 'agentool/sleep';
+ *
+ * // Default max of 300 000 ms
+ * const sleepTool = createSleep();
+ *
+ * // Custom max of 10 seconds
+ * const shortSleep = createSleep({ maxDuration: 10000 });
+ * ```
+ */
+declare function createSleep(config?: SleepConfig): ai.Tool<{
+    durationMs: number;
+    reason?: string | undefined;
+}, string>;
+/**
+ * Default sleep tool instance with a 300 000 ms (5-minute) maximum duration.
+ *
+ * @example
+ * ```typescript
+ * import { sleep } from 'agentool/sleep';
+ * const result = await sleep.execute({ durationMs: 1000, reason: 'rate limit' });
+ * ```
+ */
+declare const sleep: ai.Tool<{
+    durationMs: number;
+    reason?: string | undefined;
+}, string>;
+
+export { type SleepConfig, createSleep, sleep };

package/dist/sleep/index.js

@@ -0,0 +1,8 @@
+import {
+  createSleep,
+  sleep
+} from "../chunk-MF7CJVIZ.js";
+export {
+  createSleep,
+  sleep
+};

package/dist/task/index.cjs

@@ -0,0 +1,8 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+var _chunkXLD2Y3SScjs = require('../chunk-XLD2Y3SS.cjs');
+
+
+
+exports.createTask = _chunkXLD2Y3SScjs.createTask; exports.task = _chunkXLD2Y3SScjs.task;

package/dist/task/index.d.cts

@@ -0,0 +1,67 @@
+import * as ai from 'ai';
+import { B as BaseToolConfig } from '../types-3QPDuCXN.cjs';
+
+/**
+ * Configuration for the task tool.
+ * Extends {@link BaseToolConfig} with an optional tasks file path.
+ *
+ * @example
+ * ```typescript
+ * import type { TaskConfig } from 'agentool/task';
+ * const config: TaskConfig = { cwd: '/my/project' };
+ * ```
+ */
+interface TaskConfig extends BaseToolConfig {
+    /** Path to the tasks JSON file. Defaults to `<cwd>/.agentool/tasks.json`. */
+    tasksFile?: string;
+}
+/**
+ * Creates a task tool that provides JSON file-based task tracking.
+ *
+ * Tasks are stored in a single JSON file with CRUD operations.
+ * Each task has an id, subject, description, status, and timestamps.
+ * Execute never throws; errors are returned as descriptive strings.
+ *
+ * @param config - Optional configuration for cwd and tasks file path.
+ * @returns A Vercel AI SDK tool with `description`, `parameters`, and `execute`.
+ *
+ * @example
+ * ```typescript
+ * import { createTask } from 'agentool/task';
+ *
+ * const taskTool = createTask({ cwd: '/my/project' });
+ * const result = await taskTool.execute(
+ *   { action: 'create', subject: 'Fix bug', description: 'Fix the login bug' },
+ *   { toolCallId: 'id', messages: [] },
+ * );
+ * ```
+ */
+declare function createTask(config?: TaskConfig): ai.Tool<{
+    action: "list" | "delete" | "create" | "get" | "update";
+    status?: "pending" | "in_progress" | "completed" | undefined;
+    description?: string | undefined;
+    id?: string | undefined;
+    subject?: string | undefined;
+}, string>;
+/**
+ * Default task tool instance using `.agentool/tasks.json` under the current
+ * working directory.
+ *
+ * @example
+ * ```typescript
+ * import { task } from 'agentool/task';
+ * const result = await task.execute(
+ *   { action: 'list' },
+ *   { toolCallId: 'id', messages: [] },
+ * );
+ * ```
+ */
+declare const task: ai.Tool<{
+    action: "list" | "delete" | "create" | "get" | "update";
+    status?: "pending" | "in_progress" | "completed" | undefined;
+    description?: string | undefined;
+    id?: string | undefined;
+    subject?: string | undefined;
+}, string>;
+
+export { type TaskConfig, createTask, task };