@theokit/sdk-tools 0.26.3 → 0.27.1

package/dist/index.js

@@ -1,11 +1,11 @@
-import { rm, mkdir, writeFile, readFile, readdir, open, stat, copyFile } from 'fs/promises';
-import { dirname, relative, join, isAbsolute } from 'path';
+import { rm, mkdir, writeFile, readFile, readdir, open, stat } from 'fs/promises';
+import { dirname, relative, join, isAbsolute, extname } from 'path';
 import { Tool, ConfigurationError } from '@theokit/sdk';
 import { z } from 'zod';
 import { safePathJoin, assertNoSymlinkEscape, PathTraversalError, ForbiddenPathError, isForbiddenPath, safeFilenameForId } from '@theokit/sdk/path-safety';
 import { replaceFileAtomic } from '@theokit/sdk/persistence';
+import { existsSync, statSync, mkdirSync, writeFileSync, openSync, fstatSync, readFileSync, closeSync, constants, readdirSync } from 'fs';
 import { resolveFilesystem, FileNotFoundError, FilesystemSecurityError, FilesystemReadOnlyError, StaleFileError, FilesystemError } from '@theokit/sdk/filesystem';
-import { existsSync, statSync, mkdirSync, writeFileSync, readFileSync, readdirSync } from 'fs';
 import { resolveSandbox } from '@theokit/sdk/sandbox';
 import { spawn } from 'child_process';
 import { resolveInteractive, InteractiveUnavailableError, NoSuchSessionError } from '@theokit/sdk/interactive';
@@ -589,7 +589,18 @@ async function editViaLocal(projectRoot, path, old_string, new_string) {
   }
   const outcome = computeEdit(content, old_string, new_string);
   if (!outcome.ok) return JSON.stringify({ ok: false, error: "no_match", path });
-  await copyFile(absolutePath, `${absolutePath}.bak`);
+  try {
+    await writeFile(`${absolutePath}.bak`, content, {
+      encoding: "utf-8",
+      flag: constants.O_WRONLY | constants.O_CREAT | constants.O_TRUNC | constants.O_NOFOLLOW
+    });
+  } catch (err) {
+    const code = err.code;
+    if (code === "ELOOP" || code === "EEXIST") {
+      return JSON.stringify({ ok: false, error: "unsafe_backup_path", path });
+    }
+    throw err;
+  }
   await writeFile(absolutePath, outcome.result, "utf-8");
   return JSON.stringify({ ok: true, replacements: 1 });
 }
@@ -859,15 +870,15 @@ function createGitStatusTool(opts) {
       path: z.string().optional().describe("Optional project-relative path to scope the status report.")
     }),
     handler: async ({ path }, ctx) => {
-      if (!existsSync(join(projectRoot, ".git"))) {
-        return JSON.stringify({ ok: false, error: "not_a_repo" });
-      }
       const scopeCheck = checkPathScope(path, projectRoot);
       if (scopeCheck !== null) return scopeCheck;
       const args = buildArgs(path, opts.includeBranch !== false);
       if (opts.sandbox !== void 0) {
         return statusViaSandbox(opts.sandbox, ctx, args, timeoutMs);
       }
+      if (!existsSync(join(projectRoot, ".git"))) {
+        return JSON.stringify({ ok: false, error: "not_a_repo" });
+      }
       const result = await runGitProcess(projectRoot, args, timeoutMs, maxStdoutBytes);
       return formatGitResult(result, timeoutMs);
     }
@@ -2037,6 +2048,12 @@ function validateVitestScope(path, projectRoot) {
   }
   return checkPathScope(path, projectRoot);
 }
+var VITEST_MISSING = [
+  /npx canceled due to missing packages/i,
+  /could not determine executable to run/i,
+  /vitest: (?:command )?not found/i,
+  /command not found: vitest/i
+];
 function formatVitestResult(result, timeoutMs) {
   if (result.kind === "timeout") {
     return JSON.stringify({ ok: false, error: "timeout", timeoutMs });
@@ -2046,6 +2063,9 @@ function formatVitestResult(result, timeoutMs) {
   }
   const summary = extractTrailingJson(result.stdout);
   if (summary === null) {
+    if (VITEST_MISSING.some((pattern) => pattern.test(result.stderr))) {
+      return JSON.stringify({ ok: false, error: "no_vitest", detail: result.stderr.slice(0, 500) });
+    }
     return JSON.stringify({
       ok: false,
       error: "unparseable_output",
@@ -2575,9 +2595,9 @@ function truncateOutput(output, opts) {
     return { content: output, truncated: false, originalBytes };
   }
   mkdirSync(outputDir, { recursive: true });
-  const filename = `overflow-${Date.now()}-${randomUUID().slice(0, 8)}.txt`;
+  const filename = `overflow-${Date.now()}-${randomUUID()}.txt`;
   const overflowPath = join(outputDir, filename);
-  writeFileSync(overflowPath, output, "utf-8");
+  writeFileSync(overflowPath, output, { encoding: "utf-8", flag: "wx" });
   const buf = Buffer.from(output, "utf-8");
   const trailer = `
 
@@ -2625,6 +2645,98 @@ function createUpdatePlanTool() {
     }
   });
 }
+var MEDIA_TYPES = /* @__PURE__ */ new Map([
+  [".png", "image/png"],
+  [".jpg", "image/jpeg"],
+  [".jpeg", "image/jpeg"],
+  [".gif", "image/gif"],
+  [".webp", "image/webp"]
+]);
+var DEFAULT_MAX_IMAGE_BYTES = 5 * 1024 * 1024;
+var json = (result) => JSON.stringify(result);
+function createViewImageTool(options) {
+  const { projectRoot } = options;
+  const maxBytes = options.maxBytes ?? DEFAULT_MAX_IMAGE_BYTES;
+  return Tool.create({
+    name: options.name ?? "view_image",
+    description: options.description ?? "Read an image file from the project and show it to the model. Supports png, jpeg, gif and webp.",
+    inputSchema: z.object({
+      path: z.string().describe("Path to the image, relative to the project root.")
+    }),
+    handler: (input) => {
+      const refused = checkPathScope(input.path, projectRoot);
+      if (refused !== null) return refused;
+      if (isForbiddenAtAnyDepth(input.path)) {
+        return json({ ok: false, error: "path_traversal", path: input.path });
+      }
+      const mediaType = MEDIA_TYPES.get(extname(input.path).toLowerCase());
+      if (mediaType === void 0) {
+        return json({
+          ok: false,
+          error: "unsupported_image_type",
+          path: input.path,
+          supported: [...MEDIA_TYPES.keys()]
+        });
+      }
+      const absolute = safePathJoin(projectRoot, input.path);
+      const outcome = readWithinBudget(absolute, maxBytes);
+      if (!outcome.ok) return json(failureFor(outcome, input.path, maxBytes));
+      return json({
+        ok: true,
+        path: input.path,
+        media_type: mediaType,
+        bytes: outcome.bytes,
+        data: outcome.data
+      });
+    },
+    /**
+     * Turn a successful read into an image block.
+     *
+     * A failed read stays TEXT on purpose: the model needs to read "not_found" and try another path,
+     * and an error is not something to look at.
+     */
+    toModelOutput: (output) => {
+      let result;
+      try {
+        result = JSON.parse(output);
+      } catch {
+        return output;
+      }
+      if (result.ok !== true) return output;
+      return [
+        {
+          type: "image",
+          source: { type: "base64", media_type: result.media_type, data: result.data }
+        }
+      ];
+    }
+  });
+}
+function readWithinBudget(absolute, maxBytes) {
+  let fd;
+  try {
+    fd = openSync(absolute, "r");
+  } catch {
+    return { ok: false, error: "not_found" };
+  }
+  try {
+    const bytes = fstatSync(fd).size;
+    if (bytes > maxBytes) return { ok: false, error: "too_large", bytes };
+    return { ok: true, bytes, data: readFileSync(fd).toString("base64") };
+  } finally {
+    closeSync(fd);
+  }
+}
+function failureFor(outcome, path, maxBytes) {
+  if (outcome.error === "not_found") return { ok: false, error: "not_found", path };
+  return {
+    ok: false,
+    error: "image_too_large",
+    path,
+    bytes: outcome.bytes,
+    limit_bytes: maxBytes
+  };
+}
 var DEFAULT_TIMEOUT_MS4 = 3e4;
 var MAX_BODY_BYTES = 1 * 1024 * 1024;
 function createWebFetchTool(opts) {
@@ -2766,8 +2878,8 @@ function createBraveWebSearchAdapter(opts = {}) {
       headers: { "X-Subscription-Token": apiKey, Accept: "application/json" }
     });
     if (!res.ok) throw new Error(`brave_search_failed: HTTP ${res.status}`);
-    const json = await res.json();
-    const results = json?.web?.results ?? [];
+    const json2 = await res.json();
+    const results = json2?.web?.results ?? [];
     return results.map((r) => ({
       title: String(r?.title ?? ""),
       url: String(r?.url ?? ""),
@@ -2927,6 +3039,6 @@ async function isBinaryFile(absolutePath) {
   }
 }
 
-export { CatastrophicCommandError, ContextMatchError, DEFAULT_TOOL_GUIDANCE, ReadTracker, ReasoningTools, RedirectBlockedError, SsrfBlockedError, buildEnvContext, buildRepoMap, catastrophicShellReason, commandDenialReason, createApplyPatchTool, createBraveWebSearchAdapter, createCurrentTimeTool, createEditFileTool, createGenericHttpSearchAdapter, createGitDiffTool, createGitStatusTool, createGlobTool, createInteractiveShellTool, createListDirTool, createPlanModeTool, createQuestionTool, createReadFileTool, createRunVitestTool, createSearchTextTool, createSessionArtifactStore, createShellTool, createTodolistTool, createUpdatePlanTool, createWebFetchTool, createWebSearchTool, createWriteFileTool, createWriteStdinTool, denyCatastrophicCommands, formatCode, formatDiff, formatError, formatFileList, injectGuidance, isBlockedIp, isCommandAllowed, renderToolList, replaceUnique, resolveAndScreen, screenedFetch, todoItemsToPlanNodes, truncateOutput, withDefaultGuidance, withDescription, withName, withShellExitGuidance, withToolResultGuidance };
+export { CatastrophicCommandError, ContextMatchError, DEFAULT_MAX_IMAGE_BYTES, DEFAULT_TOOL_GUIDANCE, ReadTracker, ReasoningTools, RedirectBlockedError, SsrfBlockedError, buildEnvContext, buildRepoMap, catastrophicShellReason, commandDenialReason, createApplyPatchTool, createBraveWebSearchAdapter, createCurrentTimeTool, createEditFileTool, createGenericHttpSearchAdapter, createGitDiffTool, createGitStatusTool, createGlobTool, createInteractiveShellTool, createListDirTool, createPlanModeTool, createQuestionTool, createReadFileTool, createRunVitestTool, createSearchTextTool, createSessionArtifactStore, createShellTool, createTodolistTool, createUpdatePlanTool, createViewImageTool, createWebFetchTool, createWebSearchTool, createWriteFileTool, createWriteStdinTool, denyCatastrophicCommands, formatCode, formatDiff, formatError, formatFileList, injectGuidance, isBlockedIp, isCommandAllowed, renderToolList, replaceUnique, resolveAndScreen, screenedFetch, todoItemsToPlanNodes, truncateOutput, withDefaultGuidance, withDescription, withName, withShellExitGuidance, withToolResultGuidance };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map