@uipath/data-fabric-tool 1.195.0 → 1.197.0-preview.59

package/src/commands/files.spec.ts

@@ -109,6 +109,7 @@ describe("files upload", () => {
             "record-1",
             "attachment",
             expect.any(File),
+            undefined,
         );
         expect(OutputFormatter.success).toHaveBeenCalledWith(
             expect.objectContaining({
@@ -132,6 +133,7 @@ describe("files upload", () => {
             "record-1",
             "attachment",
             expect.objectContaining({ name: "upload" }),
+            undefined,
         );
     });
 
@@ -237,22 +239,63 @@ describe("files delete", () => {
     it("should delete and return FileDeleted on success", async () => {
         const sdk = mockSdk();
         const program = buildProgram();
-        await runCommand(program, "files delete entity-1 record-1 attachment");
+        await runCommand(
+            program,
+            "files delete entity-1 record-1 attachment --yes --reason cleanup",
+        );
+        expect(sdk.entities.deleteAttachment).toHaveBeenCalledWith(
+            "entity-1",
+            "record-1",
+            "attachment",
+            undefined,
+        );
+        expect(OutputFormatter.success).toHaveBeenCalledWith(
+            expect.objectContaining({
+                Result: "Success",
+                Code: "FileDeleted",
+                Data: expect.objectContaining({ Reason: "cleanup" }),
+            }),
+        );
+    });
+
+    it("should accept --confirm as a deprecated alias for --yes", async () => {
+        const sdk = mockSdk();
+        const program = buildProgram();
+        await runCommand(
+            program,
+            "files delete entity-1 record-1 attachment --confirm --reason cleanup",
+        );
         expect(sdk.entities.deleteAttachment).toHaveBeenCalledWith(
             "entity-1",
             "record-1",
             "attachment",
+            undefined,
         );
         expect(OutputFormatter.success).toHaveBeenCalledWith(
             expect.objectContaining({ Result: "Success", Code: "FileDeleted" }),
         );
     });
 
+    it("should require confirmation: without --yes, exit 1 and SDK not called", async () => {
+        const sdk = mockSdk();
+        const program = buildProgram();
+        await runCommand(
+            program,
+            "files delete entity-1 record-1 attachment --reason cleanup",
+        );
+        expect(sdk.entities.deleteAttachment).not.toHaveBeenCalled();
+        expect(OutputFormatter.success).not.toHaveBeenCalled();
+        expect(process.exitCode).toBe(1);
+    });
+
     it("should error when delete API fails", async () => {
         const sdk = mockSdk();
         sdk.entities.deleteAttachment.mockRejectedValue(new Error("Forbidden"));
         const program = buildProgram();
-        await runCommand(program, "files delete entity-1 record-1 attachment");
+        await runCommand(
+            program,
+            "files delete entity-1 record-1 attachment --yes --reason cleanup",
+        );
         expect(OutputFormatter.error).toHaveBeenCalledWith(
             expect.objectContaining({
                 Result: "Failure",
@@ -265,7 +308,10 @@ describe("files delete", () => {
         const sdk = mockSdk();
         vi.mocked(connectOrFail).mockResolvedValue(undefined);
         const program = buildProgram();
-        await runCommand(program, "files delete entity-1 record-1 attachment");
+        await runCommand(
+            program,
+            "files delete entity-1 record-1 attachment --yes --reason cleanup",
+        );
         expect(sdk.entities.deleteAttachment).not.toHaveBeenCalled();
         expect(OutputFormatter.success).not.toHaveBeenCalled();
     });
@@ -328,3 +374,62 @@ describe("files download edge cases", () => {
         );
     });
 });
+
+describe("files --folder-key forwarding", () => {
+    beforeEach(() => {
+        vi.clearAllMocks();
+        vi.mocked(OutputFormatter.success).mockReset();
+        vi.mocked(OutputFormatter.error).mockReset();
+    });
+
+    it("should forward --folder-key to uploadAttachment", async () => {
+        const sdk = mockSdk();
+        mockFs.readFile.mockResolvedValue(new Uint8Array([1, 2, 3]));
+        const program = buildProgram();
+        await runCommand(
+            program,
+            "files upload entity-1 record-1 attachment --file /tmp/report.pdf --folder-key folder-guid-1",
+        );
+        expect(sdk.entities.uploadAttachment).toHaveBeenCalledWith(
+            "entity-1",
+            "record-1",
+            "attachment",
+            expect.any(File),
+            { folderKey: "folder-guid-1" },
+        );
+    });
+
+    it("should forward --folder-key to downloadAttachment", async () => {
+        const blob = new Blob(["data"]);
+        const sdk = mockSdk({
+            downloadAttachment: vi.fn().mockResolvedValue(blob),
+        });
+        mockFs.writeFile.mockResolvedValue(undefined);
+        const program = buildProgram();
+        await runCommand(
+            program,
+            "files download entity-1 record-1 attachment --folder-key folder-guid-2",
+        );
+        expect(sdk.entities.downloadAttachment).toHaveBeenCalledWith(
+            "entity-1",
+            "record-1",
+            "attachment",
+            { folderKey: "folder-guid-2" },
+        );
+    });
+
+    it("should forward --folder-key to deleteAttachment", async () => {
+        const sdk = mockSdk();
+        const program = buildProgram();
+        await runCommand(
+            program,
+            "files delete entity-1 record-1 attachment --yes --reason cleanup --folder-key folder-guid-3",
+        );
+        expect(sdk.entities.deleteAttachment).toHaveBeenCalledWith(
+            "entity-1",
+            "record-1",
+            "attachment",
+            { folderKey: "folder-guid-3" },
+        );
+    });
+});

package/src/commands/files.ts

@@ -8,23 +8,29 @@ import {
     RESULTS,
 } from "@uipath/common";
 import { getFileSystem } from "@uipath/filesystem";
-import type { Command } from "commander";
+import { type Command, Option } from "commander";
 import { readFileBinary } from "../utils/input";
-import { fail } from "../utils/output";
+import { fail, requireDestructiveConfirmation } from "../utils/output";
 import { connectOrFail } from "../utils/sdk-client";
 
 interface UploadOptions {
     tenant?: string;
     file?: string;
+    folderKey?: string;
 }
 
 interface DownloadOptions {
     tenant?: string;
     destination?: string;
+    folderKey?: string;
 }
 
 interface DeleteOptions {
     tenant?: string;
+    yes?: boolean;
+    confirm?: boolean;
+    reason?: string;
+    folderKey?: string;
 }
 
 const FILES_UPLOAD_EXAMPLES: CommandExample[] = [
@@ -92,6 +98,10 @@ export const registerFilesCommand = (program: Command) => {
             createHiddenDeprecatedTenantOption("-t, --tenant <tenant-name>"),
         )
         .option("-f, --file <path>", "Path to the file to upload")
+        .option(
+            "--folder-key <key>",
+            "Folder key (GUID) of the folder containing the entity (for folder-scoped entities)",
+        )
         .examples(FILES_UPLOAD_EXAMPLES)
         .trackedAction(
             processContext,
@@ -131,6 +141,9 @@ export const registerFilesCommand = (program: Command) => {
                             [fileContent as Uint8Array<ArrayBuffer>],
                             fileName,
                         ),
+                        options.folderKey !== undefined
+                            ? { folderKey: options.folderKey }
+                            : undefined,
                     ),
                 );
 
@@ -167,6 +180,10 @@ export const registerFilesCommand = (program: Command) => {
             "--destination <path>",
             "Output file path (defaults to <record-id>_<field-name>.bin)",
         )
+        .option(
+            "--folder-key <key>",
+            "Folder key (GUID) of the folder containing the entity (for folder-scoped entities)",
+        )
         .examples(FILES_DOWNLOAD_EXAMPLES)
         .trackedAction(
             processContext,
@@ -184,6 +201,9 @@ export const registerFilesCommand = (program: Command) => {
                         entityId,
                         recordId,
                         fieldName,
+                        options.folderKey !== undefined
+                            ? { folderKey: options.folderKey }
+                            : undefined,
                     ),
                 );
 
@@ -241,6 +261,18 @@ export const registerFilesCommand = (program: Command) => {
         .addOption(
             createHiddenDeprecatedTenantOption("-t, --tenant <tenant-name>"),
         )
+        .option("-y, --yes", "Acknowledge this is an irreversible operation")
+        .addOption(
+            new Option("--confirm", "Deprecated alias for --yes").hideHelp(),
+        )
+        .option(
+            "--reason <reason>",
+            "Reason for the deletion — echoed back in the response so the caller can log it",
+        )
+        .option(
+            "--folder-key <key>",
+            "Folder key (GUID) of the folder containing the entity (for folder-scoped entities)",
+        )
         .examples(FILES_DELETE_EXAMPLES)
         .trackedAction(
             processContext,
@@ -250,6 +282,13 @@ export const registerFilesCommand = (program: Command) => {
                 fieldName: string,
                 options: DeleteOptions,
             ) => {
+                const reason = requireDestructiveConfirmation(
+                    options,
+                    `delete the file in field '${fieldName}'`,
+                    'Pass --reason "<text>" to record why the file is being deleted.',
+                );
+                if (reason === null) return;
+
                 const sdk = await connectOrFail(options.tenant);
                 if (!sdk) return;
 
@@ -258,6 +297,9 @@ export const registerFilesCommand = (program: Command) => {
                         entityId,
                         recordId,
                         fieldName,
+                        options.folderKey !== undefined
+                            ? { folderKey: options.folderKey }
+                            : undefined,
                     ),
                 );
 
@@ -275,6 +317,7 @@ export const registerFilesCommand = (program: Command) => {
                         EntityId: entityId,
                         RecordId: recordId,
                         FieldName: fieldName,
+                        Reason: reason,
                     },
                 });
             },