agentool 0.0.1 → 1.0.0

package/dist/task/index.d.ts

@@ -0,0 +1,67 @@
+import * as ai from 'ai';
+import { B as BaseToolConfig } from '../types-3QPDuCXN.js';
+
+/**
+ * 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 };

package/dist/task/index.js

@@ -0,0 +1,8 @@
+import {
+  createTask,
+  task
+} from "../chunk-FAEGCFTO.js";
+export {
+  createTask,
+  task
+};

package/dist/types-3QPDuCXN.d.cts

@@ -0,0 +1,45 @@
+/**
+ * Base configuration shared by all agentool tools.
+ * Every tool's factory function accepts a config extending this type.
+ *
+ * @example
+ * ```typescript
+ * import type { BaseToolConfig } from 'agentool';
+ * const config: BaseToolConfig = { cwd: '/my/project' };
+ * ```
+ */
+interface BaseToolConfig {
+    /**
+     * Working directory for file operations.
+     * Defaults to process.cwd() when not specified.
+     */
+    cwd?: string;
+}
+/**
+ * Result returned by tool execute functions.
+ * Tools always return strings -- never throw.
+ * Error results include operation, error type, and remediation.
+ *
+ * @example
+ * ```typescript
+ * import type { ToolResult } from 'agentool';
+ * const result: ToolResult = 'Found 3 matches in src/index.ts';
+ * ```
+ */
+type ToolResult = string;
+/**
+ * Configuration for tools that support timeouts.
+ * Extends {@link BaseToolConfig} with an optional timeout duration.
+ *
+ * @example
+ * ```typescript
+ * import type { TimeoutConfig } from 'agentool';
+ * const config: TimeoutConfig = { cwd: '/project', timeout: 30000 };
+ * ```
+ */
+interface TimeoutConfig extends BaseToolConfig {
+    /** Timeout in milliseconds. Defaults vary by tool. */
+    timeout?: number;
+}
+
+export type { BaseToolConfig as B, TimeoutConfig as T, ToolResult as a };

package/dist/types-3QPDuCXN.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Base configuration shared by all agentool tools.
+ * Every tool's factory function accepts a config extending this type.
+ *
+ * @example
+ * ```typescript
+ * import type { BaseToolConfig } from 'agentool';
+ * const config: BaseToolConfig = { cwd: '/my/project' };
+ * ```
+ */
+interface BaseToolConfig {
+    /**
+     * Working directory for file operations.
+     * Defaults to process.cwd() when not specified.
+     */
+    cwd?: string;
+}
+/**
+ * Result returned by tool execute functions.
+ * Tools always return strings -- never throw.
+ * Error results include operation, error type, and remediation.
+ *
+ * @example
+ * ```typescript
+ * import type { ToolResult } from 'agentool';
+ * const result: ToolResult = 'Found 3 matches in src/index.ts';
+ * ```
+ */
+type ToolResult = string;
+/**
+ * Configuration for tools that support timeouts.
+ * Extends {@link BaseToolConfig} with an optional timeout duration.
+ *
+ * @example
+ * ```typescript
+ * import type { TimeoutConfig } from 'agentool';
+ * const config: TimeoutConfig = { cwd: '/project', timeout: 30000 };
+ * ```
+ */
+interface TimeoutConfig extends BaseToolConfig {
+    /** Timeout in milliseconds. Defaults vary by tool. */
+    timeout?: number;
+}
+
+export type { BaseToolConfig as B, TimeoutConfig as T, ToolResult as a };

package/dist/web-fetch/index.cjs

@@ -0,0 +1,8 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+var _chunkU2YMJM25cjs = require('../chunk-U2YMJM25.cjs');
+
+
+
+exports.createWebFetch = _chunkU2YMJM25cjs.createWebFetch; exports.webFetch = _chunkU2YMJM25cjs.webFetch;

package/dist/web-fetch/index.d.cts

@@ -0,0 +1,56 @@
+import * as ai from 'ai';
+import { T as TimeoutConfig } from '../types-3QPDuCXN.cjs';
+
+/**
+ * Configuration for the web-fetch tool.
+ * Extends {@link TimeoutConfig} with optional content-length cap and user-agent.
+ *
+ * @example
+ * ```typescript
+ * const config: WebFetchConfig = {
+ *   timeout: 10000,
+ *   maxContentLength: 5 * 1024 * 1024,
+ *   userAgent: 'my-agent/1.0',
+ * };
+ * ```
+ */
+interface WebFetchConfig extends TimeoutConfig {
+    /** Maximum response body size in bytes. Passed to {@link fetchUrl}. */
+    maxContentLength?: number;
+    /** Custom User-Agent header sent with every request. */
+    userAgent?: string;
+}
+/**
+ * Factory that creates a web-fetch tool with the given configuration.
+ * The returned tool fetches a URL, automatically converts HTML to markdown
+ * via turndown, and truncates content at 100 000 characters.
+ *
+ * @param config - Optional configuration (timeout, max content length, user agent).
+ * @returns An AI SDK tool instance for fetching web pages.
+ *
+ * @example
+ * ```typescript
+ * import { createWebFetch } from 'agentool/web-fetch';
+ * const myTool = createWebFetch({ timeout: 5000 });
+ * ```
+ */
+declare function createWebFetch(config?: WebFetchConfig): ai.Tool<{
+    url: string;
+    prompt?: string | undefined;
+}, string>;
+/**
+ * Pre-configured web-fetch tool with default settings.
+ * Uses a 30 000 ms timeout, no content-length cap override, and no custom user-agent.
+ *
+ * @example
+ * ```typescript
+ * import { webFetch } from 'agentool/web-fetch';
+ * // Register directly with your AI SDK agent
+ * ```
+ */
+declare const webFetch: ai.Tool<{
+    url: string;
+    prompt?: string | undefined;
+}, string>;
+
+export { type WebFetchConfig, createWebFetch, webFetch };

package/dist/web-fetch/index.d.ts

@@ -0,0 +1,56 @@
+import * as ai from 'ai';
+import { T as TimeoutConfig } from '../types-3QPDuCXN.js';
+
+/**
+ * Configuration for the web-fetch tool.
+ * Extends {@link TimeoutConfig} with optional content-length cap and user-agent.
+ *
+ * @example
+ * ```typescript
+ * const config: WebFetchConfig = {
+ *   timeout: 10000,
+ *   maxContentLength: 5 * 1024 * 1024,
+ *   userAgent: 'my-agent/1.0',
+ * };
+ * ```
+ */
+interface WebFetchConfig extends TimeoutConfig {
+    /** Maximum response body size in bytes. Passed to {@link fetchUrl}. */
+    maxContentLength?: number;
+    /** Custom User-Agent header sent with every request. */
+    userAgent?: string;
+}
+/**
+ * Factory that creates a web-fetch tool with the given configuration.
+ * The returned tool fetches a URL, automatically converts HTML to markdown
+ * via turndown, and truncates content at 100 000 characters.
+ *
+ * @param config - Optional configuration (timeout, max content length, user agent).
+ * @returns An AI SDK tool instance for fetching web pages.
+ *
+ * @example
+ * ```typescript
+ * import { createWebFetch } from 'agentool/web-fetch';
+ * const myTool = createWebFetch({ timeout: 5000 });
+ * ```
+ */
+declare function createWebFetch(config?: WebFetchConfig): ai.Tool<{
+    url: string;
+    prompt?: string | undefined;
+}, string>;
+/**
+ * Pre-configured web-fetch tool with default settings.
+ * Uses a 30 000 ms timeout, no content-length cap override, and no custom user-agent.
+ *
+ * @example
+ * ```typescript
+ * import { webFetch } from 'agentool/web-fetch';
+ * // Register directly with your AI SDK agent
+ * ```
+ */
+declare const webFetch: ai.Tool<{
+    url: string;
+    prompt?: string | undefined;
+}, string>;
+
+export { type WebFetchConfig, createWebFetch, webFetch };

package/dist/web-fetch/index.js

@@ -0,0 +1,8 @@
+import {
+  createWebFetch,
+  webFetch
+} from "../chunk-Y7KOKDFP.js";
+export {
+  createWebFetch,
+  webFetch
+};

package/dist/write/index.cjs

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

package/dist/write/index.d.cts

@@ -0,0 +1,47 @@
+import * as ai from 'ai';
+import { B as BaseToolConfig } from '../types-3QPDuCXN.cjs';
+
+type WriteConfig = BaseToolConfig;
+/**
+ * Creates a write tool that writes text content to a file.
+ *
+ * The tool creates parent directories as needed (mkdir -p behavior).
+ * If the file already exists it is overwritten, not appended.
+ * Execute never throws; errors are returned as descriptive strings.
+ *
+ * @param config - Optional configuration with a custom working directory.
+ * @returns A Vercel AI SDK tool with `description`, `parameters`, and `execute`.
+ *
+ * @example
+ * ```typescript
+ * import { createWrite } from 'agentool/write';
+ *
+ * const writeTool = createWrite({ cwd: '/my/project' });
+ * const result = await writeTool.execute(
+ *   { file_path: 'src/index.ts', content: 'export {}' },
+ *   { toolCallId: 'id', messages: [] },
+ * );
+ * ```
+ */
+declare function createWrite(config?: BaseToolConfig): ai.Tool<{
+    content: string;
+    file_path: string;
+}, string>;
+/**
+ * Default write tool instance using the current working directory.
+ *
+ * @example
+ * ```typescript
+ * import { write } from 'agentool/write';
+ * const result = await write.execute(
+ *   { file_path: '/tmp/hello.txt', content: 'hello' },
+ *   { toolCallId: 'id', messages: [] },
+ * );
+ * ```
+ */
+declare const write: ai.Tool<{
+    content: string;
+    file_path: string;
+}, string>;
+
+export { type WriteConfig, createWrite, write };

package/dist/write/index.d.ts

@@ -0,0 +1,47 @@
+import * as ai from 'ai';
+import { B as BaseToolConfig } from '../types-3QPDuCXN.js';
+
+type WriteConfig = BaseToolConfig;
+/**
+ * Creates a write tool that writes text content to a file.
+ *
+ * The tool creates parent directories as needed (mkdir -p behavior).
+ * If the file already exists it is overwritten, not appended.
+ * Execute never throws; errors are returned as descriptive strings.
+ *
+ * @param config - Optional configuration with a custom working directory.
+ * @returns A Vercel AI SDK tool with `description`, `parameters`, and `execute`.
+ *
+ * @example
+ * ```typescript
+ * import { createWrite } from 'agentool/write';
+ *
+ * const writeTool = createWrite({ cwd: '/my/project' });
+ * const result = await writeTool.execute(
+ *   { file_path: 'src/index.ts', content: 'export {}' },
+ *   { toolCallId: 'id', messages: [] },
+ * );
+ * ```
+ */
+declare function createWrite(config?: BaseToolConfig): ai.Tool<{
+    content: string;
+    file_path: string;
+}, string>;
+/**
+ * Default write tool instance using the current working directory.
+ *
+ * @example
+ * ```typescript
+ * import { write } from 'agentool/write';
+ * const result = await write.execute(
+ *   { file_path: '/tmp/hello.txt', content: 'hello' },
+ *   { toolCallId: 'id', messages: [] },
+ * );
+ * ```
+ */
+declare const write: ai.Tool<{
+    content: string;
+    file_path: string;
+}, string>;
+
+export { type WriteConfig, createWrite, write };

package/dist/write/index.js

@@ -0,0 +1,10 @@
+import {
+  createWrite,
+  write
+} from "../chunk-7QL4BQCH.js";
+import "../chunk-6PQLFDGT.js";
+import "../chunk-I3ONDY7P.js";
+export {
+  createWrite,
+  write
+};

package/package.json

@@ -1,38 +1,163 @@
 {
   "name": "agentool",
-  "version": "0.0.1",
-  "description": "Lightweight, provider-agnostic AI agent toolkit for CI/CD",
+  "version": "1.0.0",
   "type": "module",
+  "description": "16 AI agent tools as standalone Vercel AI SDK modules",
+  "author": "Z-M-Huang",
   "license": "Apache-2.0",
-  "engines": {
-    "node": ">=20"
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Z-M-Huang/agentool.git"
+  },
+  "homepage": "https://github.com/Z-M-Huang/agentool#readme",
+  "bugs": {
+    "url": "https://github.com/Z-M-Huang/agentool/issues"
   },
+  "keywords": [
+    "ai",
+    "agent",
+    "tools",
+    "vercel-ai-sdk",
+    "llm",
+    "bash",
+    "grep",
+    "glob",
+    "file-operations",
+    "code-search",
+    "web-fetch",
+    "typescript",
+    "claude",
+    "openai",
+    "anthropic"
+  ],
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
-    "./core": {
-      "import": "./dist/core/index.js",
-      "types": "./dist/core/index.d.ts"
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./bash": {
+      "types": "./dist/bash/index.d.ts",
+      "import": "./dist/bash/index.js",
+      "require": "./dist/bash/index.cjs"
+    },
+    "./grep": {
+      "types": "./dist/grep/index.d.ts",
+      "import": "./dist/grep/index.js",
+      "require": "./dist/grep/index.cjs"
+    },
+    "./glob": {
+      "types": "./dist/glob/index.d.ts",
+      "import": "./dist/glob/index.js",
+      "require": "./dist/glob/index.cjs"
+    },
+    "./read": {
+      "types": "./dist/read/index.d.ts",
+      "import": "./dist/read/index.js",
+      "require": "./dist/read/index.cjs"
+    },
+    "./edit": {
+      "types": "./dist/edit/index.d.ts",
+      "import": "./dist/edit/index.js",
+      "require": "./dist/edit/index.cjs"
+    },
+    "./write": {
+      "types": "./dist/write/index.d.ts",
+      "import": "./dist/write/index.js",
+      "require": "./dist/write/index.cjs"
+    },
+    "./web-fetch": {
+      "types": "./dist/web-fetch/index.d.ts",
+      "import": "./dist/web-fetch/index.js",
+      "require": "./dist/web-fetch/index.cjs"
+    },
+    "./memory": {
+      "types": "./dist/memory/index.d.ts",
+      "import": "./dist/memory/index.js",
+      "require": "./dist/memory/index.cjs"
+    },
+    "./multi-edit": {
+      "types": "./dist/multi-edit/index.d.ts",
+      "import": "./dist/multi-edit/index.js",
+      "require": "./dist/multi-edit/index.cjs"
+    },
+    "./diff": {
+      "types": "./dist/diff/index.d.ts",
+      "import": "./dist/diff/index.js",
+      "require": "./dist/diff/index.cjs"
+    },
+    "./task": {
+      "types": "./dist/task/index.d.ts",
+      "import": "./dist/task/index.js",
+      "require": "./dist/task/index.cjs"
+    },
+    "./lsp": {
+      "types": "./dist/lsp/index.d.ts",
+      "import": "./dist/lsp/index.js",
+      "require": "./dist/lsp/index.cjs"
+    },
+    "./http-request": {
+      "types": "./dist/http-request/index.d.ts",
+      "import": "./dist/http-request/index.js",
+      "require": "./dist/http-request/index.cjs"
+    },
+    "./context-compaction": {
+      "types": "./dist/context-compaction/index.d.ts",
+      "import": "./dist/context-compaction/index.js",
+      "require": "./dist/context-compaction/index.cjs"
+    },
+    "./ask-user": {
+      "types": "./dist/ask-user/index.d.ts",
+      "import": "./dist/ask-user/index.js",
+      "require": "./dist/ask-user/index.cjs"
+    },
+    "./sleep": {
+      "types": "./dist/sleep/index.d.ts",
+      "import": "./dist/sleep/index.js",
+      "require": "./dist/sleep/index.cjs"
     }
   },
+  "scripts": {
+    "build": "tsup",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run --project unit",
+    "test:functional": "vitest run --project functional",
+    "lint": "eslint src/"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
   "files": [
-    "dist"
+    "dist",
+    "README.md",
+    "LICENSE"
   ],
   "peerDependencies": {
-    "ai": "^6.0.0"
+    "ai": ">=4.0.0",
+    "zod": ">=3.23.0"
+  },
+  "dependencies": {
+    "diff": "^7.0.0",
+    "turndown": "^7.2.0"
   },
   "devDependencies": {
+    "@ai-sdk/openai": "^3.0.50",
+    "@types/diff": "^7.0.0",
+    "@types/node": "^22.0.0",
+    "@types/turndown": "^5.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.58.0",
+    "@typescript-eslint/parser": "^8.58.0",
+    "@vitest/coverage-v8": "^3.0.0",
     "ai": "^6.0.0",
+    "dotenv": "^17.4.0",
+    "eslint": "^10.2.0",
     "tsup": "^8.0.0",
     "typescript": "^5.7.0",
+    "typescript-eslint": "^8.58.0",
     "vitest": "^3.0.0",
-    "zod": "^3.24.0"
-  },
-  "dependencies": {
-    "zod": "^3.24.0"
-  },
-  "scripts": {
-    "build": "tsup",
-    "typecheck": "tsc --noEmit",
-    "test": "vitest run",
-    "test:watch": "vitest"
+    "zod": "^3.25.0"
   }
-}
+}

package/dist/core/index.d.ts

@@ -1,20 +0,0 @@
-import { tool } from 'ai';
-
-/**
- * Result returned by every tool execution.
- */
-interface ToolResult {
-    success: boolean;
-    output: string;
-    error?: string;
-}
-/**
- * A single tool definition — the return type of AI SDK `tool()`.
- */
-type ToolDefinition = ReturnType<typeof tool<ZodType, ToolResult>>;
-/**
- * A record of named tool definitions, returned by ToolPack factories.
- */
-type ToolPack = Record<string, ToolDefinition>;
-
-export type { ToolDefinition, ToolPack, ToolResult };

package/dist/core/index.js

@@ -1 +0,0 @@
-//# sourceMappingURL=index.js.map

package/dist/core/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}