@uipath/tasks-tool 1.202.0-preview.141 → 1.202.0-preview.142

package/tests/complete.e2e.test.ts

@@ -1,207 +0,0 @@
-import { RESULTS } from "@uipath/common";
-import { beforeAll, describe, expect, it } from "vitest";
-import {
-    type E2EManifest,
-    MANIFEST_PATH,
-} from "../../../tests/e2e-shared/global-setup";
-import {
-    EXEC_TIMEOUT,
-    localCliRaw,
-    parseOutput,
-    readManifest,
-} from "../../../tests/e2e-shared/helpers";
-
-// Scenario: scenarios/tasks-tool/complete.md
-// `uip tasks complete <task-id>` — completion with action and data.
-
-interface CompleteEnvelope {
-    Result: string;
-    Code?: string;
-    Data?: unknown;
-    Message?: string;
-    Instructions?: string;
-    ErrorCode?: string;
-}
-
-// `tasks list` passes through the raw SDK task payload, which is
-// PascalCase (Id/FolderId/Type/Status/...) — confirmed against a live tenant.
-interface TaskSummary {
-    Id?: number;
-    FolderId?: number;
-    Type?: string;
-    Status?: string;
-}
-
-const { tempDir } = readManifest<E2EManifest>(MANIFEST_PATH).sharedInstall;
-
-describe("tasks complete e2e", () => {
-    let formTaskId: string | undefined;
-    let formTaskFolderId: string | undefined;
-    let quickFormTaskId: string | undefined;
-    let quickFormTaskFolderId: string | undefined;
-
-    beforeAll(() => {
-        const listRaw = localCliRaw(tempDir, "tasks list --output json");
-        if (listRaw.exitCode !== 0) return;
-        const listRes = parseOutput(listRaw.stdout, "json") as {
-            Data?: TaskSummary[];
-        };
-        const tasks = listRes.Data ?? [];
-
-        const formTask = tasks.find(
-            (t) => t.Type === "FormTask" && t.Status !== "Completed",
-        );
-        if (formTask?.Id !== undefined) {
-            formTaskId = String(formTask.Id);
-            formTaskFolderId =
-                formTask.FolderId !== undefined
-                    ? String(formTask.FolderId)
-                    : undefined;
-        }
-
-        const quickFormTask = tasks.find(
-            (t) => t.Type === "QuickFormTask" && t.Status === "Pending",
-        );
-        if (quickFormTask?.Id !== undefined) {
-            quickFormTaskId = String(quickFormTask.Id);
-            quickFormTaskFolderId =
-                quickFormTask.FolderId !== undefined
-                    ? String(quickFormTask.FolderId)
-                    : undefined;
-        }
-    }, EXEC_TIMEOUT);
-
-    // ── Deterministic (no tenant) ────────────────────────────────────────────
-
-    it(
-        "S1: missing --type fails fast",
-        () => {
-            const raw = localCliRaw(
-                tempDir,
-                "tasks complete 5 --folder-id 1 --output json",
-            );
-            expect(raw.exitCode).toBe(3);
-            const res = parseOutput(raw.stdout, "json") as CompleteEnvelope;
-            expect(res.Result).toBe("ValidationError");
-            expect(res.ErrorCode).toBe("invalid_argument");
-            expect(res.Message).toBe(
-                "error: required option '--type <type>' not specified",
-            );
-        },
-        EXEC_TIMEOUT,
-    );
-
-    // ── Tenant read (requires login) ─────────────────────────────────────────
-
-    it(
-        "S2: missing folder fails loud when not interactive",
-        () => {
-            const raw = localCliRaw(
-                tempDir,
-                "tasks complete 5 --type FormTask --output json",
-            );
-            expect(raw.exitCode).not.toBe(0);
-            const res = parseOutput(raw.stdout, "json") as CompleteEnvelope;
-            expect(res.Result).toBe(RESULTS.Failure);
-            expect(res.Message).toBe("A folder is required");
-            expect(res.Instructions).toMatch(/--folder-id/);
-            expect(res.Instructions).toMatch(/--folder-path/);
-            expect(res.Instructions).toMatch(/--folder-key/);
-        },
-        EXEC_TIMEOUT,
-    );
-
-    it(
-        "S3: invalid task type value is rejected",
-        () => {
-            const raw = localCliRaw(
-                tempDir,
-                "tasks complete 5 --type NotARealType --folder-id 1 --output json",
-            );
-            expect(raw.exitCode).not.toBe(0);
-            const res = parseOutput(raw.stdout, "json") as CompleteEnvelope;
-            expect(res.Result).toBe(RESULTS.Failure);
-            expect(res.Message).toBe("Invalid task type 'NotARealType'");
-            expect(res.Instructions).toMatch(/FormTask/);
-        },
-        EXEC_TIMEOUT,
-    );
-
-    it(
-        "S4: invalid JSON in --data is rejected",
-        () => {
-            const raw = localCliRaw(
-                tempDir,
-                `tasks complete 5 --type FormTask --folder-id 1 --data "{not json" --output json`,
-            );
-            expect(raw.exitCode).not.toBe(0);
-            const res = parseOutput(raw.stdout, "json") as CompleteEnvelope;
-            expect(res.Result).toBe(RESULTS.Failure);
-            expect(res.Message).toBe("Invalid JSON in --data");
-        },
-        EXEC_TIMEOUT,
-    );
-
-    // ── Tenant read/write (guarded — skip if no completable FormTask exists) ──
-    //
-    // The action/button name a FormTask actually accepts comes from its form
-    // layout definition, which `uip tasks` has no way to discover — `--action`
-    // is validated purely server-side against buttons this CLI can't inspect.
-    // Confirmed live: a task with a real FormLayoutId still rejected both
-    // "Approve" and "Submit" with "Provided form action does not match any
-    // button". So this scenario can only assert that a *wrong* action fails
-    // cleanly (already covered structurally) plus, opportunistically, that a
-    // guessed common action name either completes the task or fails with
-    // that specific button-mismatch message — never a connection/auth error.
-    it(
-        "S5: completes a task with an action and data",
-        () => {
-            if (!formTaskId || !formTaskFolderId) return;
-            const raw = localCliRaw(
-                tempDir,
-                `tasks complete ${formTaskId} --type FormTask --folder-id ${formTaskFolderId} --action Submit --data "{}" --output json`,
-            );
-            const res = parseOutput(raw.stdout, "json") as CompleteEnvelope;
-            if (res.Result === RESULTS.Success) {
-                expect(raw.exitCode).toBe(0);
-                expect(res.Code).toBe("TaskCompleted");
-                return;
-            }
-            // No way to know this fixture's real button name — accept the
-            // known button-mismatch failure rather than asserting success.
-            expect(res.Result).toBe(RESULTS.Failure);
-            expect(res.Instructions).toBe(
-                "Provided form action does not match any button",
-            );
-        },
-        EXEC_TIMEOUT,
-    );
-
-    // `QuickFormTask` (Maestro HITL QuickForm nodes) was previously missing
-    // from VALID_TASK_TYPES — completion was impossible for this type before
-    // this PR. "Submit" is the default single-outcome QuickForm action name;
-    // a QuickForm with custom outcomes would need a different name this CLI
-    // has no way to discover, so this scenario applies the same defensive
-    // accept-known-button-mismatch pattern as S5.
-    it(
-        "S6: completes a QuickFormTask",
-        () => {
-            if (!quickFormTaskId || !quickFormTaskFolderId) return;
-            const raw = localCliRaw(
-                tempDir,
-                `tasks complete ${quickFormTaskId} --type QuickFormTask --folder-id ${quickFormTaskFolderId} --action Submit --data "{}" --output json`,
-            );
-            const res = parseOutput(raw.stdout, "json") as CompleteEnvelope;
-            if (res.Result === RESULTS.Success) {
-                expect(raw.exitCode).toBe(0);
-                expect(res.Code).toBe("TaskCompleted");
-                return;
-            }
-            expect(res.Result).toBe(RESULTS.Failure);
-            expect(res.Instructions).toBe(
-                "Provided form action does not match any button",
-            );
-        },
-        EXEC_TIMEOUT,
-    );
-});

package/tests/data.e2e.test.ts

@@ -1,187 +0,0 @@
-import { RESULTS } from "@uipath/common";
-import { describe, expect, it } from "vitest";
-import {
-    type E2EManifest,
-    MANIFEST_PATH,
-} from "../../../tests/e2e-shared/global-setup";
-import {
-    EXEC_TIMEOUT,
-    localCliRaw,
-    localCliRawWithArgs,
-    parseOutput,
-    readManifest,
-} from "../../../tests/e2e-shared/helpers";
-
-interface Envelope {
-    Result: string;
-    Code?: string;
-    Data?: unknown;
-    Message?: string;
-    Instructions?: string;
-}
-
-interface TaskRow {
-    Id?: number;
-    IsDeleted?: boolean;
-    Status?: string;
-    Type?: string;
-    FolderId?: number;
-}
-
-const { tempDir } = readManifest<E2EManifest>(MANIFEST_PATH).sharedInstall;
-
-function listTasks(asAdmin: boolean): TaskRow[] {
-    const flag = asAdmin ? "--as-admin " : "";
-    const raw = localCliRaw(
-        tempDir,
-        `tasks list ${flag}--limit 200 --output json`,
-    );
-    if (raw.exitCode !== 0) return [];
-    return (parseOutput(raw.stdout, "json") as { Data?: TaskRow[] }).Data ?? [];
-}
-
-function discoverTask(): { taskId: string; folderId: string } | null {
-    const envFolder = process.env.TASKS_TOOL_E2E_FOLDER_ID;
-    const envTask =
-        process.env.TASKS_TOOL_E2E_TASK_ID_DATA ??
-        process.env.TASKS_TOOL_E2E_TASK_ID;
-    if (envFolder && envTask) {
-        return { taskId: envTask, folderId: envFolder };
-    }
-    for (const asAdmin of [false, true]) {
-        const task = listTasks(asAdmin).find(
-            (t) =>
-                !t.IsDeleted &&
-                t.Status !== "Completed" &&
-                t.Type === "ExternalTask" &&
-                typeof t.Id === "number" &&
-                typeof t.FolderId === "number",
-        );
-        if (task) {
-            return {
-                taskId: String(task.Id),
-                folderId: String(envFolder ?? task.FolderId),
-            };
-        }
-    }
-    // No actionable ExternalTask on this tenant; skip the live suite (guarded by describe.skipIf below).
-    return null;
-}
-
-const discovered = discoverTask();
-const taskId = discovered?.taskId ?? "";
-const folderId = discovered?.folderId ?? "";
-
-function getData(id: string): Envelope {
-    const raw = localCliRaw(
-        tempDir,
-        `tasks data get ${id} --folder-id ${folderId} --output json`,
-    );
-    return parseOutput(raw.stdout, "json") as Envelope;
-}
-
-function saveData(id: string, dataJson: string): Envelope {
-    const raw = localCliRawWithArgs(tempDir, [
-        "tasks",
-        "data",
-        "save",
-        id,
-        "--folder-id",
-        folderId,
-        "--data",
-        dataJson,
-        "--output",
-        "json",
-    ]);
-    return parseOutput(raw.stdout, "json") as Envelope;
-}
-
-describe.skipIf(!discovered)("tasks data e2e", () => {
-    it(
-        "S1: get task data",
-        () => {
-            const res = getData(taskId);
-            expect(res.Result).toBe(RESULTS.Success);
-            expect(res.Code).toBe("TaskData");
-            expect((res.Data as { Id?: number }).Id).toBe(Number(taskId));
-        },
-        EXEC_TIMEOUT,
-    );
-
-    it(
-        "S2: get a non-existent task reports a failure",
-        () => {
-            const res = getData("999999999");
-            expect(res.Result).toBe(RESULTS.Failure);
-            expect(res.Message).toMatch(/^Error getting data for task/);
-        },
-        EXEC_TIMEOUT,
-    );
-
-    it(
-        "S3: invalid task id reports a validation error",
-        () => {
-            const res = getData("not-a-number");
-            expect(res.Result).toBe(RESULTS.Failure);
-            expect(res.Message).toMatch(/^Invalid <task-id>/);
-            expect(res.Instructions).toBe("Must be a positive integer.");
-        },
-        EXEC_TIMEOUT,
-    );
-
-    it(
-        "S4: save task data",
-        () => {
-            const res = saveData(taskId, '{"amount":1200}');
-            expect(res.Result).toBe(RESULTS.Success);
-            expect(res.Code).toBe("TaskDataSaved");
-        },
-        EXEC_TIMEOUT,
-    );
-
-    it(
-        "S5: invalid data JSON reports a validation error",
-        () => {
-            const res = saveData(taskId, "not-json");
-            expect(res.Result).toBe(RESULTS.Failure);
-            expect(res.Message).toBe("Invalid JSON in --data");
-        },
-        EXEC_TIMEOUT,
-    );
-
-    it(
-        "S6: save on a non-existent task reports a failure",
-        () => {
-            const res = saveData("999999999", '{"amount":1}');
-            expect(res.Result).toBe(RESULTS.Failure);
-            expect(res.Message).toMatch(/^Error saving data for task/);
-        },
-        EXEC_TIMEOUT,
-    );
-
-    it(
-        "S7: non-object data is rejected before the API call",
-        () => {
-            const res = saveData(taskId, "[1,2,3]");
-            expect(res.Result).toBe(RESULTS.Failure);
-            expect(res.Message).toBe("--data must be a JSON object");
-        },
-        EXEC_TIMEOUT,
-    );
-
-    it(
-        "S8: data round-trips through save and get",
-        () => {
-            const marker = `sdk-cli-e2e-${Date.now()}`;
-            const save = saveData(taskId, `{"Marker":"${marker}"}`);
-            expect(save.Result).toBe(RESULTS.Success);
-
-            const res = getData(taskId);
-            expect(res.Result).toBe(RESULTS.Success);
-            const payload = (res.Data as { Data?: Record<string, unknown> })
-                .Data;
-            expect(payload?.Marker).toBe(marker);
-        },
-        EXEC_TIMEOUT,
-    );
-});

package/tests/get.e2e.test.ts

@@ -1,103 +0,0 @@
-import { RESULTS } from "@uipath/common";
-import { describe, expect, it } from "vitest";
-import {
-    type E2EManifest,
-    MANIFEST_PATH,
-} from "../../../tests/e2e-shared/global-setup";
-import {
-    EXEC_TIMEOUT,
-    localCliRaw,
-    parseOutput,
-    readManifest,
-} from "../../../tests/e2e-shared/helpers";
-
-// Scenario: scenarios/tasks-tool/get.md
-// `uip tasks get <id>` — single task detail retrieval.
-
-interface GetEnvelope {
-    Result: string;
-    Code?: string;
-    Data?: unknown;
-    Message?: string;
-    Instructions?: string;
-    ErrorCode?: string;
-}
-
-const { tempDir } = readManifest<E2EManifest>(MANIFEST_PATH).sharedInstall;
-
-/** Discover a real task ID via `tasks list`, or undefined if the tenant has none. */
-function discoverTaskId(): string | undefined {
-    const raw = localCliRaw(tempDir, "tasks list --limit 1 --output json");
-    if (raw.exitCode !== 0) return undefined;
-    const res = parseOutput(raw.stdout, "json") as GetEnvelope;
-    // `tasks list` passes through the raw SDK task payload, which is
-    // PascalCase (Id/...) — confirmed against a live tenant.
-    const items = res.Data as Array<{ Id?: number }> | undefined;
-    const id = items?.[0]?.Id;
-    return typeof id === "number" ? String(id) : undefined;
-}
-
-describe("tasks get e2e", () => {
-    it(
-        "S1: missing id argument fails fast",
-        () => {
-            const raw = localCliRaw(tempDir, "tasks get --output json");
-            expect(raw.exitCode).toBe(3);
-            const res = parseOutput(raw.stdout, "json") as GetEnvelope;
-            expect(res.Result).toBe("ValidationError");
-            expect(res.ErrorCode).toBe("invalid_argument");
-            expect(res.Message).toBe("error: missing required argument 'id'");
-        },
-        EXEC_TIMEOUT,
-    );
-
-    it(
-        "S2: gets a task's details when one exists",
-        () => {
-            const id = discoverTaskId();
-            if (!id) return; // tenant has no tasks to fetch
-            const raw = localCliRaw(tempDir, `tasks get ${id} --output json`);
-            expect(raw.exitCode).toBe(0);
-            const res = parseOutput(raw.stdout, "json") as GetEnvelope;
-            expect(res.Result).toBe(RESULTS.Success);
-            expect(res.Code).toBe("TaskDetails");
-            expect(res.Data).not.toBeNull();
-        },
-        EXEC_TIMEOUT,
-    );
-
-    it(
-        "S3: unknown task id reports a clean not-found failure",
-        () => {
-            const raw = localCliRaw(
-                tempDir,
-                "tasks get 999999999 --output json",
-            );
-            expect(raw.exitCode).not.toBe(0);
-            const res = parseOutput(raw.stdout, "json") as GetEnvelope;
-            expect(res.Result).toBe(RESULTS.Failure);
-            expect(res.Message).toBe("Error getting task '999999999'");
-        },
-        EXEC_TIMEOUT,
-    );
-
-    it(
-        "S4: --task-type without a folder option is rejected",
-        () => {
-            const raw = localCliRaw(
-                tempDir,
-                "tasks get 1 --task-type FormTask --output json",
-            );
-            expect(raw.exitCode).not.toBe(0);
-            const res = parseOutput(raw.stdout, "json") as GetEnvelope;
-            expect(res.Result).toBe(RESULTS.Failure);
-            expect(res.Message).toBe(
-                "A folder is required when --task-type is specified",
-            );
-            expect(res.Instructions).toMatch(/--folder-id/);
-            expect(res.Instructions).toMatch(/--folder-path/);
-            expect(res.Instructions).toMatch(/--folder-key/);
-        },
-        EXEC_TIMEOUT,
-    );
-});

package/tests/labels.e2e.test.ts

@@ -1,184 +0,0 @@
-import { RESULTS } from "@uipath/common";
-import { describe, expect, it } from "vitest";
-import {
-    type E2EManifest,
-    MANIFEST_PATH,
-} from "../../../tests/e2e-shared/global-setup";
-import {
-    EXEC_TIMEOUT,
-    localCliRaw,
-    localCliRawWithArgs,
-    parseOutput,
-    readManifest,
-} from "../../../tests/e2e-shared/helpers";
-
-interface Envelope {
-    Result: string;
-    Code?: string;
-    Message?: string;
-    Instructions?: string;
-}
-
-interface TaskRow {
-    Id?: number;
-    IsDeleted?: boolean;
-    Status?: string;
-    Type?: string;
-    FolderId?: number;
-}
-
-const { tempDir } = readManifest<E2EManifest>(MANIFEST_PATH).sharedInstall;
-
-function listTasks(asAdmin: boolean): TaskRow[] {
-    const flag = asAdmin ? "--as-admin " : "";
-    const raw = localCliRaw(
-        tempDir,
-        `tasks list ${flag}--limit 200 --output json`,
-    );
-    if (raw.exitCode !== 0) return [];
-    return (parseOutput(raw.stdout, "json") as { Data?: TaskRow[] }).Data ?? [];
-}
-
-function discoverTask(): { taskId: string; folderId: string } | null {
-    const envFolder = process.env.TASKS_TOOL_E2E_FOLDER_ID;
-    const envTask =
-        process.env.TASKS_TOOL_E2E_TASK_ID_LABELS ??
-        process.env.TASKS_TOOL_E2E_TASK_ID;
-    if (envFolder && envTask) {
-        return { taskId: envTask, folderId: envFolder };
-    }
-    for (const asAdmin of [false, true]) {
-        const task = listTasks(asAdmin).find(
-            (t) =>
-                !t.IsDeleted &&
-                t.Status !== "Completed" &&
-                t.Type === "ExternalTask" &&
-                typeof t.Id === "number" &&
-                typeof t.FolderId === "number",
-        );
-        if (task) {
-            return {
-                taskId: String(task.Id),
-                folderId: String(envFolder ?? task.FolderId),
-            };
-        }
-    }
-    // No actionable ExternalTask on this tenant; skip the live suite (guarded by describe.skipIf below).
-    return null;
-}
-
-const discovered = discoverTask();
-const taskId = discovered?.taskId ?? "";
-const folderId = discovered?.folderId ?? "";
-
-function setTags(id: string, tagsJson: string): Envelope {
-    const raw = localCliRawWithArgs(tempDir, [
-        "tasks",
-        "labels",
-        id,
-        "--folder-id",
-        folderId,
-        "--labels",
-        tagsJson,
-        "--output",
-        "json",
-    ]);
-    return parseOutput(raw.stdout, "json") as Envelope;
-}
-
-describe.skipIf(!discovered)("tasks labels e2e", () => {
-    it(
-        "S1: set labels on a task",
-        () => {
-            const res = setTags(taskId, '[{"name":"urgent"}]');
-            expect(res.Result).toBe(RESULTS.Success);
-            expect(res.Code).toBe("TaskLabelsSaved");
-        },
-        EXEC_TIMEOUT,
-    );
-
-    it(
-        "S2: clear labels with an empty array",
-        () => {
-            const res = setTags(taskId, "[]");
-            expect(res.Result).toBe(RESULTS.Success);
-            expect(res.Code).toBe("TaskLabelsSaved");
-        },
-        EXEC_TIMEOUT,
-    );
-
-    it(
-        "S3: invalid task id reports a validation error",
-        () => {
-            const res = setTags("not-a-number", "[]");
-            expect(res.Result).toBe(RESULTS.Failure);
-            expect(res.Message).toMatch(/^Invalid <task-id>/);
-            expect(res.Instructions).toBe("Must be a positive integer.");
-        },
-        EXEC_TIMEOUT,
-    );
-
-    it(
-        "S4: set labels on a non-existent task reports a failure",
-        () => {
-            const res = setTags("999999999", '[{"name":"urgent"}]');
-            expect(res.Result).toBe(RESULTS.Failure);
-            expect(res.Message).toMatch(/^Error saving labels on task/);
-        },
-        EXEC_TIMEOUT,
-    );
-
-    it(
-        "S5: invalid JSON in --labels is rejected before the API call",
-        () => {
-            const res = setTags(taskId, "not-json");
-            expect(res.Result).toBe(RESULTS.Failure);
-            expect(res.Message).toBe("Invalid JSON in --labels");
-        },
-        EXEC_TIMEOUT,
-    );
-
-    it(
-        "S6: non-array --labels is rejected before the API call",
-        () => {
-            const res = setTags(taskId, '{"name":"urgent"}');
-            expect(res.Result).toBe(RESULTS.Failure);
-            expect(res.Message).toBe("--labels must be a JSON array");
-        },
-        EXEC_TIMEOUT,
-    );
-
-    it(
-        "S7: set a label with a display name and value",
-        () => {
-            const res = setTags(
-                taskId,
-                '[{"name":"region","displayName":"Region","displayValue":"EMEA"}]',
-            );
-            expect(res.Result).toBe(RESULTS.Success);
-            expect(res.Code).toBe("TaskLabelsSaved");
-        },
-        EXEC_TIMEOUT,
-    );
-
-    it(
-        "S8: labels round-trip through set and read-back",
-        () => {
-            const marker = `sdkclie2e${Date.now()}`;
-            const set = setTags(taskId, `[{"name":"${marker}"}]`);
-            expect(set.Result).toBe(RESULTS.Success);
-
-            const getRaw = localCliRaw(
-                tempDir,
-                `tasks get ${taskId} --output json`,
-            );
-            const task = parseOutput(getRaw.stdout, "json") as {
-                Data?: { Tags?: { Name?: string }[] };
-            };
-            expect((task.Data?.Tags ?? []).some((t) => t.Name === marker)).toBe(
-                true,
-            );
-        },
-        EXEC_TIMEOUT,
-    );
-});