@dexto/tools-filesystem 1.5.0

package/LICENSE

@@ -0,0 +1,44 @@
+Elastic License 2.0 (ELv2)
+
+**Acceptance**
+By using the software, you agree to all of the terms and conditions below.
+
+**Copyright License**
+The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software, in each case subject to the limitations and conditions below
+
+**Limitations**
+You may not provide the software to third parties as a hosted or managed service, where the service provides users with access to any substantial set of the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality in the software, and you may not remove or obscure any functionality in the software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices of the licensor in the software. Any use of the licensor’s trademarks is subject to applicable law.
+
+**Patents**
+The licensor grants you a license, under any patent claims the licensor can license, or becomes able to license, to make, have made, use, sell, offer for sale, import and have imported the software, in each case subject to the limitations and conditions in this license. This license does not cover any patent claims that you cause to be infringed by modifications or additions to the software. If you or your company make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+**Notices**
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the software prominent notices stating that you have modified the software.
+
+**No Other Rights**
+These terms do not imply any licenses other than those expressly granted in these terms.
+
+**Termination**
+If you use the software in violation of these terms, such use is not licensed, and your licenses will automatically terminate. If the licensor provides you with a notice of your violation, and you cease all violation of this license no later than 30 days after you receive that notice, your licenses will be reinstated retroactively. However, if you violate these terms after such reinstatement, any additional violation of these terms will cause your licenses to terminate automatically and permanently.
+
+**No Liability**
+As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.
+
+**Definitions**
+The _licensor_ is the entity offering these terms, and the _software_ is the software the licensor makes available under these terms, including any portion of it.
+
+_you_ refers to the individual or entity agreeing to these terms.
+
+_your company_ is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. _control_ means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
+
+_your licenses_ are all the licenses granted to you for the software under these terms.
+
+_use_ means anything you do with the software requiring one of your licenses.
+
+_trademark_ means trademarks, service marks, and similar rights.

package/dist/directory-approval.integration.test.cjs

@@ -0,0 +1,467 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var import_vitest = require("vitest");
+var path = __toESM(require("node:path"), 1);
+var fs = __toESM(require("node:fs/promises"), 1);
+var os = __toESM(require("node:os"), 1);
+var import_read_file_tool = require("./read-file-tool.js");
+var import_write_file_tool = require("./write-file-tool.js");
+var import_edit_file_tool = require("./edit-file-tool.js");
+var import_filesystem_service = require("./filesystem-service.js");
+var import_core = require("@dexto/core");
+const createMockLogger = () => ({
+  debug: import_vitest.vi.fn(),
+  info: import_vitest.vi.fn(),
+  warn: import_vitest.vi.fn(),
+  error: import_vitest.vi.fn(),
+  createChild: import_vitest.vi.fn().mockReturnThis()
+});
+(0, import_vitest.describe)("Directory Approval Integration Tests", () => {
+  let mockLogger;
+  let tempDir;
+  let fileSystemService;
+  let directoryApproval;
+  let isSessionApprovedMock;
+  let addApprovedMock;
+  (0, import_vitest.beforeEach)(async () => {
+    mockLogger = createMockLogger();
+    const rawTempDir = await fs.mkdtemp(path.join(os.tmpdir(), "dexto-fs-test-"));
+    tempDir = await fs.realpath(rawTempDir);
+    fileSystemService = new import_filesystem_service.FileSystemService(
+      {
+        allowedPaths: [tempDir],
+        blockedPaths: [],
+        blockedExtensions: [],
+        maxFileSize: 10 * 1024 * 1024,
+        workingDirectory: tempDir,
+        enableBackups: false,
+        backupRetentionDays: 7
+      },
+      mockLogger
+    );
+    await fileSystemService.initialize();
+    isSessionApprovedMock = import_vitest.vi.fn().mockReturnValue(false);
+    addApprovedMock = import_vitest.vi.fn();
+    directoryApproval = {
+      isSessionApproved: isSessionApprovedMock,
+      addApproved: addApprovedMock
+    };
+    import_vitest.vi.clearAllMocks();
+  });
+  (0, import_vitest.afterEach)(async () => {
+    try {
+      await fs.rm(tempDir, { recursive: true, force: true });
+    } catch {
+    }
+  });
+  (0, import_vitest.describe)("Read File Tool", () => {
+    (0, import_vitest.describe)("getApprovalOverride", () => {
+      (0, import_vitest.it)("should return null for paths within working directory (no prompt needed)", async () => {
+        const tool = (0, import_read_file_tool.createReadFileTool)({
+          fileSystemService,
+          directoryApproval
+        });
+        const testFile = path.join(tempDir, "test.txt");
+        await fs.writeFile(testFile, "test content");
+        const override = tool.getApprovalOverride?.({ file_path: testFile });
+        (0, import_vitest.expect)(override).toBeNull();
+      });
+      (0, import_vitest.it)("should return directory access approval for external paths", async () => {
+        const tool = (0, import_read_file_tool.createReadFileTool)({
+          fileSystemService,
+          directoryApproval
+        });
+        const externalPath = "/external/project/file.ts";
+        const override = tool.getApprovalOverride?.({ file_path: externalPath });
+        (0, import_vitest.expect)(override).not.toBeNull();
+        (0, import_vitest.expect)(override?.type).toBe(import_core.ApprovalType.DIRECTORY_ACCESS);
+        const metadata = override?.metadata;
+        (0, import_vitest.expect)(metadata?.path).toBe(path.resolve(externalPath));
+        (0, import_vitest.expect)(metadata?.parentDir).toBe(path.dirname(path.resolve(externalPath)));
+        (0, import_vitest.expect)(metadata?.operation).toBe("read");
+        (0, import_vitest.expect)(metadata?.toolName).toBe("read_file");
+      });
+      (0, import_vitest.it)("should return null when external path is session-approved", async () => {
+        isSessionApprovedMock.mockReturnValue(true);
+        const tool = (0, import_read_file_tool.createReadFileTool)({
+          fileSystemService,
+          directoryApproval
+        });
+        const externalPath = "/external/project/file.ts";
+        const override = tool.getApprovalOverride?.({ file_path: externalPath });
+        (0, import_vitest.expect)(override).toBeNull();
+        (0, import_vitest.expect)(isSessionApprovedMock).toHaveBeenCalledWith(externalPath);
+      });
+      (0, import_vitest.it)("should return null when file_path is missing", async () => {
+        const tool = (0, import_read_file_tool.createReadFileTool)({
+          fileSystemService,
+          directoryApproval
+        });
+        const override = tool.getApprovalOverride?.({});
+        (0, import_vitest.expect)(override).toBeNull();
+      });
+    });
+    (0, import_vitest.describe)("onApprovalGranted", () => {
+      (0, import_vitest.it)("should add directory as session-approved when rememberDirectory is true", async () => {
+        const tool = (0, import_read_file_tool.createReadFileTool)({
+          fileSystemService,
+          directoryApproval
+        });
+        const externalPath = "/external/project/file.ts";
+        tool.getApprovalOverride?.({ file_path: externalPath });
+        tool.onApprovalGranted?.({
+          approvalId: "test-approval",
+          status: import_core.ApprovalStatus.APPROVED,
+          data: { rememberDirectory: true }
+        });
+        (0, import_vitest.expect)(addApprovedMock).toHaveBeenCalledWith(
+          path.dirname(path.resolve(externalPath)),
+          "session"
+        );
+      });
+      (0, import_vitest.it)("should add directory as once-approved when rememberDirectory is false", async () => {
+        const tool = (0, import_read_file_tool.createReadFileTool)({
+          fileSystemService,
+          directoryApproval
+        });
+        const externalPath = "/external/project/file.ts";
+        tool.getApprovalOverride?.({ file_path: externalPath });
+        tool.onApprovalGranted?.({
+          approvalId: "test-approval",
+          status: import_core.ApprovalStatus.APPROVED,
+          data: { rememberDirectory: false }
+        });
+        (0, import_vitest.expect)(addApprovedMock).toHaveBeenCalledWith(
+          path.dirname(path.resolve(externalPath)),
+          "once"
+        );
+      });
+      (0, import_vitest.it)("should default to once-approved when rememberDirectory is not specified", async () => {
+        const tool = (0, import_read_file_tool.createReadFileTool)({
+          fileSystemService,
+          directoryApproval
+        });
+        const externalPath = "/external/project/file.ts";
+        tool.getApprovalOverride?.({ file_path: externalPath });
+        tool.onApprovalGranted?.({
+          approvalId: "test-approval",
+          status: import_core.ApprovalStatus.APPROVED,
+          data: {}
+        });
+        (0, import_vitest.expect)(addApprovedMock).toHaveBeenCalledWith(
+          path.dirname(path.resolve(externalPath)),
+          "once"
+        );
+      });
+      (0, import_vitest.it)("should not call addApproved when directoryApproval is not provided", async () => {
+        const tool = (0, import_read_file_tool.createReadFileTool)({
+          fileSystemService,
+          directoryApproval: void 0
+        });
+        const externalPath = "/external/project/file.ts";
+        tool.getApprovalOverride?.({ file_path: externalPath });
+        tool.onApprovalGranted?.({
+          approvalId: "test-approval",
+          status: import_core.ApprovalStatus.APPROVED,
+          data: { rememberDirectory: true }
+        });
+        (0, import_vitest.expect)(addApprovedMock).not.toHaveBeenCalled();
+      });
+    });
+    (0, import_vitest.describe)("execute", () => {
+      (0, import_vitest.it)("should read file contents within working directory", async () => {
+        const tool = (0, import_read_file_tool.createReadFileTool)({
+          fileSystemService,
+          directoryApproval
+        });
+        const testFile = path.join(tempDir, "readable.txt");
+        await fs.writeFile(testFile, "Hello, world!\nLine 2");
+        const result = await tool.execute({ file_path: testFile }, {});
+        (0, import_vitest.expect)(result.content).toBe("Hello, world!\nLine 2");
+        (0, import_vitest.expect)(result.lines).toBe(2);
+      });
+    });
+  });
+  (0, import_vitest.describe)("Write File Tool", () => {
+    (0, import_vitest.describe)("getApprovalOverride", () => {
+      (0, import_vitest.it)("should return null for paths within working directory", async () => {
+        const tool = (0, import_write_file_tool.createWriteFileTool)({
+          fileSystemService,
+          directoryApproval
+        });
+        const testFile = path.join(tempDir, "new-file.txt");
+        const override = tool.getApprovalOverride?.({
+          file_path: testFile,
+          content: "test"
+        });
+        (0, import_vitest.expect)(override).toBeNull();
+      });
+      (0, import_vitest.it)("should return directory access approval for external paths", async () => {
+        const tool = (0, import_write_file_tool.createWriteFileTool)({
+          fileSystemService,
+          directoryApproval
+        });
+        const externalPath = "/external/project/new.ts";
+        const override = tool.getApprovalOverride?.({
+          file_path: externalPath,
+          content: "test"
+        });
+        (0, import_vitest.expect)(override).not.toBeNull();
+        (0, import_vitest.expect)(override?.type).toBe(import_core.ApprovalType.DIRECTORY_ACCESS);
+        const metadata = override?.metadata;
+        (0, import_vitest.expect)(metadata?.operation).toBe("write");
+        (0, import_vitest.expect)(metadata?.toolName).toBe("write_file");
+      });
+      (0, import_vitest.it)("should return null when external path is session-approved", async () => {
+        isSessionApprovedMock.mockReturnValue(true);
+        const tool = (0, import_write_file_tool.createWriteFileTool)({
+          fileSystemService,
+          directoryApproval
+        });
+        const externalPath = "/external/project/new.ts";
+        const override = tool.getApprovalOverride?.({
+          file_path: externalPath,
+          content: "test"
+        });
+        (0, import_vitest.expect)(override).toBeNull();
+      });
+    });
+    (0, import_vitest.describe)("onApprovalGranted", () => {
+      (0, import_vitest.it)("should add directory as session-approved when rememberDirectory is true", async () => {
+        const tool = (0, import_write_file_tool.createWriteFileTool)({
+          fileSystemService,
+          directoryApproval
+        });
+        const externalPath = "/external/project/new.ts";
+        tool.getApprovalOverride?.({ file_path: externalPath, content: "test" });
+        tool.onApprovalGranted?.({
+          approvalId: "test-approval",
+          status: import_core.ApprovalStatus.APPROVED,
+          data: { rememberDirectory: true }
+        });
+        (0, import_vitest.expect)(addApprovedMock).toHaveBeenCalledWith(
+          path.dirname(path.resolve(externalPath)),
+          "session"
+        );
+      });
+    });
+  });
+  (0, import_vitest.describe)("Edit File Tool", () => {
+    (0, import_vitest.describe)("getApprovalOverride", () => {
+      (0, import_vitest.it)("should return null for paths within working directory", async () => {
+        const tool = (0, import_edit_file_tool.createEditFileTool)({
+          fileSystemService,
+          directoryApproval
+        });
+        const testFile = path.join(tempDir, "existing.txt");
+        const override = tool.getApprovalOverride?.({
+          file_path: testFile,
+          old_string: "old",
+          new_string: "new"
+        });
+        (0, import_vitest.expect)(override).toBeNull();
+      });
+      (0, import_vitest.it)("should return directory access approval for external paths", async () => {
+        const tool = (0, import_edit_file_tool.createEditFileTool)({
+          fileSystemService,
+          directoryApproval
+        });
+        const externalPath = "/external/project/existing.ts";
+        const override = tool.getApprovalOverride?.({
+          file_path: externalPath,
+          old_string: "old",
+          new_string: "new"
+        });
+        (0, import_vitest.expect)(override).not.toBeNull();
+        (0, import_vitest.expect)(override?.type).toBe(import_core.ApprovalType.DIRECTORY_ACCESS);
+        const metadata = override?.metadata;
+        (0, import_vitest.expect)(metadata?.operation).toBe("edit");
+        (0, import_vitest.expect)(metadata?.toolName).toBe("edit_file");
+      });
+      (0, import_vitest.it)("should return null when external path is session-approved", async () => {
+        isSessionApprovedMock.mockReturnValue(true);
+        const tool = (0, import_edit_file_tool.createEditFileTool)({
+          fileSystemService,
+          directoryApproval
+        });
+        const externalPath = "/external/project/existing.ts";
+        const override = tool.getApprovalOverride?.({
+          file_path: externalPath,
+          old_string: "old",
+          new_string: "new"
+        });
+        (0, import_vitest.expect)(override).toBeNull();
+      });
+    });
+  });
+  (0, import_vitest.describe)("Session vs Once Approval Scenarios", () => {
+    (0, import_vitest.it)("should not prompt for subsequent requests after session approval", async () => {
+      const tool = (0, import_read_file_tool.createReadFileTool)({
+        fileSystemService,
+        directoryApproval
+      });
+      const externalPath1 = "/external/project/file1.ts";
+      const externalPath2 = "/external/project/file2.ts";
+      let override = tool.getApprovalOverride?.({ file_path: externalPath1 });
+      (0, import_vitest.expect)(override).not.toBeNull();
+      tool.onApprovalGranted?.({
+        approvalId: "approval-1",
+        status: import_core.ApprovalStatus.APPROVED,
+        data: { rememberDirectory: true }
+      });
+      (0, import_vitest.expect)(addApprovedMock).toHaveBeenCalledWith(
+        path.dirname(path.resolve(externalPath1)),
+        "session"
+      );
+      isSessionApprovedMock.mockReturnValue(true);
+      override = tool.getApprovalOverride?.({ file_path: externalPath2 });
+      (0, import_vitest.expect)(override).toBeNull();
+    });
+    (0, import_vitest.it)("should prompt for subsequent requests after once approval", async () => {
+      const tool = (0, import_read_file_tool.createReadFileTool)({
+        fileSystemService,
+        directoryApproval
+      });
+      const externalPath1 = "/external/project/file1.ts";
+      const externalPath2 = "/external/project/file2.ts";
+      let override = tool.getApprovalOverride?.({ file_path: externalPath1 });
+      (0, import_vitest.expect)(override).not.toBeNull();
+      tool.onApprovalGranted?.({
+        approvalId: "approval-1",
+        status: import_core.ApprovalStatus.APPROVED,
+        data: { rememberDirectory: false }
+      });
+      (0, import_vitest.expect)(addApprovedMock).toHaveBeenCalledWith(
+        path.dirname(path.resolve(externalPath1)),
+        "once"
+      );
+      isSessionApprovedMock.mockReturnValue(false);
+      override = tool.getApprovalOverride?.({ file_path: externalPath2 });
+      (0, import_vitest.expect)(override).not.toBeNull();
+    });
+  });
+  (0, import_vitest.describe)("Path Containment Scenarios", () => {
+    (0, import_vitest.it)("should cover child paths when parent directory is session-approved", async () => {
+      const tool = (0, import_read_file_tool.createReadFileTool)({
+        fileSystemService,
+        directoryApproval
+      });
+      isSessionApprovedMock.mockImplementation((filePath) => {
+        const normalizedPath = path.resolve(filePath);
+        const approvedDir = "/external/project";
+        return normalizedPath.startsWith(approvedDir + path.sep) || normalizedPath === approvedDir;
+      });
+      let override = tool.getApprovalOverride?.({ file_path: "/external/project/file.ts" });
+      (0, import_vitest.expect)(override).toBeNull();
+      override = tool.getApprovalOverride?.({
+        file_path: "/external/project/deep/nested/file.ts"
+      });
+      (0, import_vitest.expect)(override).toBeNull();
+    });
+    (0, import_vitest.it)("should NOT cover sibling directories", async () => {
+      const tool = (0, import_read_file_tool.createReadFileTool)({
+        fileSystemService,
+        directoryApproval
+      });
+      isSessionApprovedMock.mockImplementation((filePath) => {
+        const normalizedPath = path.resolve(filePath);
+        const approvedDir = "/external/sub";
+        return normalizedPath.startsWith(approvedDir + path.sep) || normalizedPath === approvedDir;
+      });
+      let override = tool.getApprovalOverride?.({ file_path: "/external/sub/file.ts" });
+      (0, import_vitest.expect)(override).toBeNull();
+      override = tool.getApprovalOverride?.({ file_path: "/external/other/file.ts" });
+      (0, import_vitest.expect)(override).not.toBeNull();
+    });
+  });
+  (0, import_vitest.describe)("Different External Directories Scenarios", () => {
+    (0, import_vitest.it)("should require separate approval for different external directories", async () => {
+      const tool = (0, import_read_file_tool.createReadFileTool)({
+        fileSystemService,
+        directoryApproval
+      });
+      const dir1Path = "/external/project1/file.ts";
+      const dir2Path = "/external/project2/file.ts";
+      const override1 = tool.getApprovalOverride?.({ file_path: dir1Path });
+      (0, import_vitest.expect)(override1).not.toBeNull();
+      const metadata1 = override1?.metadata;
+      (0, import_vitest.expect)(metadata1?.parentDir).toBe("/external/project1");
+      const override2 = tool.getApprovalOverride?.({ file_path: dir2Path });
+      (0, import_vitest.expect)(override2).not.toBeNull();
+      const metadata2 = override2?.metadata;
+      (0, import_vitest.expect)(metadata2?.parentDir).toBe("/external/project2");
+    });
+  });
+  (0, import_vitest.describe)("Mixed Operations Scenarios", () => {
+    (0, import_vitest.it)("should share directory approval across different file operations", async () => {
+      const readTool = (0, import_read_file_tool.createReadFileTool)({ fileSystemService, directoryApproval });
+      const writeTool = (0, import_write_file_tool.createWriteFileTool)({ fileSystemService, directoryApproval });
+      const editTool = (0, import_edit_file_tool.createEditFileTool)({ fileSystemService, directoryApproval });
+      const externalDir = "/external/project";
+      (0, import_vitest.expect)(
+        readTool.getApprovalOverride?.({ file_path: `${externalDir}/file1.ts` })
+      ).not.toBeNull();
+      (0, import_vitest.expect)(
+        writeTool.getApprovalOverride?.({
+          file_path: `${externalDir}/file2.ts`,
+          content: "test"
+        })
+      ).not.toBeNull();
+      (0, import_vitest.expect)(
+        editTool.getApprovalOverride?.({
+          file_path: `${externalDir}/file3.ts`,
+          old_string: "a",
+          new_string: "b"
+        })
+      ).not.toBeNull();
+      isSessionApprovedMock.mockReturnValue(true);
+      (0, import_vitest.expect)(
+        readTool.getApprovalOverride?.({ file_path: `${externalDir}/file1.ts` })
+      ).toBeNull();
+      (0, import_vitest.expect)(
+        writeTool.getApprovalOverride?.({
+          file_path: `${externalDir}/file2.ts`,
+          content: "test"
+        })
+      ).toBeNull();
+      (0, import_vitest.expect)(
+        editTool.getApprovalOverride?.({
+          file_path: `${externalDir}/file3.ts`,
+          old_string: "a",
+          new_string: "b"
+        })
+      ).toBeNull();
+    });
+  });
+  (0, import_vitest.describe)("Without Directory Approval Callbacks", () => {
+    (0, import_vitest.it)("should work without directory approval callbacks (all paths need normal tool confirmation)", async () => {
+      const tool = (0, import_read_file_tool.createReadFileTool)({
+        fileSystemService,
+        directoryApproval: void 0
+      });
+      const override = tool.getApprovalOverride?.({ file_path: "/external/project/file.ts" });
+      (0, import_vitest.expect)(override).not.toBeNull();
+    });
+  });
+});

package/dist/directory-approval.integration.test.d.cts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/directory-approval.integration.test.d.ts

@@ -0,0 +1,2 @@
+
+export {  }