@uipath/packager-tool-workflowcompiler-browser 1.197.0 → 1.198.0-preview.80

package/dist/cleanup-result.d.ts

@@ -0,0 +1,2 @@
+export type { CleanedWorkflowDetail, RemoteCleanedWorkflow, RemoteWorkflowCompilerCleanupPayload as RemoteProjectCleanup, WorkflowCleanupDetails, } from "@uipath/solutionpackager-tool-core";
+export { toProjectCleanupInfoFromRemote as toProjectCleanupInfo } from "@uipath/solutionpackager-tool-core";

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 import "./i18n/index.js";
+export type { CleanedWorkflowDetail, WorkflowCleanupDetails, } from "./cleanup-result.js";
 export { WorkflowCompilerToolFactory } from "./workflow-compiler-tool-factory.js";

package/dist/index.js

@@ -585,11 +585,15 @@ import {
 
 // src/project-bundle-executor.ts
 import {
+  ToolErrorCodes as ToolErrorCodes2,
   ToolResult as ToolResult2,
   toRelativeUrl as toRelativeUrl2,
   translate as translate3
 } from "@uipath/solutionpackager-tool-core";
 
+// src/cleanup-result.ts
+import { toProjectCleanupInfoFromRemote } from "@uipath/solutionpackager-tool-core";
+
 // src/pack-result-processor.ts
 import {
   ToolErrorCodes,
@@ -854,7 +858,9 @@ class PackagerHubConnection {
       errorCode: jobResult.ErrorCode,
       status: jobResult.Status,
       message: jobResult.Message,
-      bucketId: jobResult.BucketId
+      bucketId: jobResult.BucketId,
+      changedFilesByProject: jobResult.ChangedFilesByProject,
+      unusedDependenciesByProject: jobResult.UnusedDependenciesByProject
     });
     this.completionResolve = null;
     this.completionReject = null;
@@ -887,6 +893,16 @@ class ProjectBundleExecutor {
       resolve: () => {}
     });
   }
+  async cleanupAsync(options, context) {
+    if (context.downloadUrl && !options.dryRun && !context.solutionId && !context.projectId) {
+      return ToolResult2.error(ToolErrorCodes2.InternalError, "Cleanup save-back requires a solutionId or projectId for downloaded workspaces.");
+    }
+    return this.enqueueAsync(context, {
+      operation: "Cleanup" /* Cleanup */,
+      options,
+      resolve: () => {}
+    });
+  }
   async enqueueAsync(context, entry) {
     const projectPath = entry.options.projectPath;
     context.logger?.info(`[BundleExecutor] ${entry.operation}Async called for project: ${projectPath}`);
@@ -1006,8 +1022,30 @@ class ProjectBundleExecutor {
       await this.handlePackBucketAsync(result, session, context);
       return;
     }
+    if (session.operation === "Cleanup" /* Cleanup */) {
+      this.resolveCleanup(result, session, context);
+      return;
+    }
     this.resolveAll(session, ToolResult2.success());
   }
+  resolveCleanup(result, session, context) {
+    for (const [projectPath, entry] of session.projects) {
+      const details = {};
+      if (result.changedFilesByProject) {
+        details.changedFilesByProject = result.changedFilesByProject;
+      }
+      const designId = context.projects.find((p) => p.ProjectPath === projectPath)?.Id;
+      const raw = designId ? result.unusedDependenciesByProject?.[designId] : undefined;
+      if (raw) {
+        details.projectCleanup = toProjectCleanupInfoFromRemote(raw);
+      }
+      const projectResult = ToolResult2.success();
+      if (Object.keys(details).length > 0) {
+        projectResult.details = details;
+      }
+      entry.resolve(projectResult);
+    }
+  }
   async handlePackBucketAsync(result, session, context) {
     if (result.bucketId == null) {
       this.resolveAll(session, ToolResult2.error("PackAgentError", translate3.t("toolWorkflowCompilerBrowser.errors.packSucceededNoBucket")));
@@ -1032,6 +1070,8 @@ class ProjectBundleExecutor {
     context.logger?.info(`[BundleExecutor] BeginSession URL: ${url}`);
     const firstEntry = session.projects.values().next().value;
     const opts = firstEntry.options;
+    const skipAnalyze = "skipAnalyze" in opts ? opts.skipAnalyze : false;
+    const skipValidate = "skipValidate" in opts ? opts.skipValidate : false;
     const rpaProjects = [...session.projects.entries()].map(([projectPath, entry]) => {
       const project = context.projects.find((p) => p.ProjectPath === projectPath);
       return {
@@ -1045,14 +1085,16 @@ class ProjectBundleExecutor {
       Command: session.operation,
       SupportedProtocolVersions: ["2.0"],
       DownloadUrl: context.downloadUrl ?? "",
+      SolutionId: context.solutionId ?? "",
+      ProjectId: context.projectId ?? "",
       SessionId: sessionId,
       ProfileKey: "StudioWeb",
       LicenseType: "Development",
       LogLevel: opts.logLevel ?? "Warning",
       Culture: "en-US",
       DownloadTimeoutInSeconds: 300,
-      SkipAnalyze: String(opts.skipAnalyze),
-      SkipValidate: String(opts.skipValidate),
+      SkipAnalyze: String(skipAnalyze),
+      SkipValidate: String(skipValidate),
       TargetFramework: context.targetFramework,
       RpaProjects: rpaProjects,
       WorkflowCompilerVersion: context.workflowCompilerVersion ?? ""
@@ -1080,6 +1122,13 @@ class ProjectBundleExecutor {
       executorInfo.Description = pkg.description ?? "";
       executorInfo.ReleaseNotes = pkg.releaseNotes ?? "";
     }
+    if (firstEntry.operation === "Cleanup" /* Cleanup */) {
+      executorInfo.DryRun = firstEntry.options.dryRun;
+      executorInfo.SkipImports = firstEntry.options.skipImports;
+      if (context.lockKey) {
+        executorInfo.LockKey = context.lockKey;
+      }
+    }
     const inputArguments = JSON.stringify(executorInfo);
     const body = {
       source: "StudioWeb",
@@ -1166,7 +1215,7 @@ class ProjectBundleExecutor {
 // src/workflow-compiler-tool.ts
 import {
   ProjectTool,
-  ToolErrorCodes as ToolErrorCodes2,
+  ToolErrorCodes as ToolErrorCodes3,
   ToolResult as ToolResult3
 } from "@uipath/solutionpackager-tool-core";
 
@@ -1184,7 +1233,7 @@ class WorkflowCompilerTool extends ProjectTool {
   }
   async validateAsync(options, _cancellationToken) {
     if (!this.context) {
-      return ToolResult3.error(ToolErrorCodes2.InternalError, "Validate operation requires a project operation context");
+      return ToolResult3.error(ToolErrorCodes3.InternalError, "Validate operation requires a project operation context");
     }
     return this.bundleExecutor.validateAsync(options, this.context);
   }
@@ -1194,10 +1243,16 @@ class WorkflowCompilerTool extends ProjectTool {
   }
   async packAsync(options, _cancellationToken) {
     if (!this.context) {
-      return ToolResult3.error(ToolErrorCodes2.InternalError, "Pack operation requires a project operation context");
+      return ToolResult3.error(ToolErrorCodes3.InternalError, "Pack operation requires a project operation context");
     }
     return this.bundleExecutor.packAsync(options, this.context);
   }
+  async cleanupAsync(options, _cancellationToken) {
+    if (!this.context) {
+      return ToolResult3.error(ToolErrorCodes3.InternalError, "Cleanup operation requires a project operation context");
+    }
+    return this.bundleExecutor.cleanupAsync(options, this.context);
+  }
 }
 
 // src/workflow-compiler-tool-factory.ts
@@ -1223,4 +1278,4 @@ export {
   WorkflowCompilerToolFactory
 };
 
-//# debugId=7131BE6BC75CD59264756E2164756E21
+//# debugId=3B5A7D9039EF896764756E2164756E21

package/dist/packager-hub-connection.d.ts

@@ -1,4 +1,5 @@
 import { type IToolLogger } from "@uipath/solutionpackager-tool-core";
+import type { RemoteProjectCleanup } from "./cleanup-result.js";
 /** @public */
 export declare enum CompletedStatus {
     Succeeded = 0,
@@ -10,6 +11,10 @@ export interface PackAgentResult {
     status: CompletedStatus;
     message?: string;
     bucketId?: number;
+    /** Cleanup only: files changed per project design id, relative to each project. */
+    changedFilesByProject?: Record<string, string[]>;
+    /** Cleanup only: raw per-project cleanup payload, keyed by project design id. */
+    unusedDependenciesByProject?: Record<string, RemoteProjectCleanup>;
 }
 export declare class PackagerHubConnection {
     private readonly logger?;

package/dist/project-bundle-executor.d.ts

@@ -1,11 +1,13 @@
-import { type IFileSystem, type IProjectPackOptions, type IProjectToolFactory, type IProjectValidateOptions, type ProjectOperationContext, ToolResult } from "@uipath/solutionpackager-tool-core";
+import { type IFileSystem, type IProjectCleanupOptions, type IProjectPackOptions, type IProjectToolFactory, type IProjectValidateOptions, type ProjectOperationContext, ToolResult } from "@uipath/solutionpackager-tool-core";
 export declare enum BundleOperation {
     Pack = "Pack",
-    Validate = "Validate"
+    Validate = "Validate",
+    Cleanup = "Cleanup"
 }
 export interface IProjectBundleExecutor {
     packAsync(options: IProjectPackOptions, context: ProjectOperationContext): Promise<ToolResult>;
     validateAsync(options: IProjectValidateOptions, context: ProjectOperationContext): Promise<ToolResult>;
+    cleanupAsync(options: IProjectCleanupOptions, context: ProjectOperationContext): Promise<ToolResult>;
 }
 export declare class ProjectBundleExecutor implements IProjectBundleExecutor {
     private readonly toolFactory;
@@ -22,12 +24,21 @@ export declare class ProjectBundleExecutor implements IProjectBundleExecutor {
     constructor(toolFactory: IProjectToolFactory, fileSystem: IFileSystem);
     packAsync(options: IProjectPackOptions, context: ProjectOperationContext): Promise<ToolResult>;
     validateAsync(options: IProjectValidateOptions, context: ProjectOperationContext): Promise<ToolResult>;
+    cleanupAsync(options: IProjectCleanupOptions, context: ProjectOperationContext): Promise<ToolResult>;
     private enqueueAsync;
     private getSessionAsync;
     private createSessionAsync;
     private runAgentAsync;
     private connectToHubAsync;
     private handleAgentResultAsync;
+    /**
+     * The agent removed unused items in-place and (for cloud solutions) saved the
+     * solution back to StudioWeb; there is no bucket to download. Resolve each
+     * project with its own result carrying the changed files (the full map, which
+     * solution-cleanup-service unions) and that project's cleanup payload mapped
+     * to the generic {@link toProjectCleanupInfo} shape.
+     */
+    private resolveCleanup;
     private handlePackBucketAsync;
     private sendBeginSessionAsync;
     /**

package/dist/workflow-compiler-tool.d.ts

@@ -1,4 +1,4 @@
-import { type IFileSystem, type IProjectBuildOptions, type IProjectPackOptions, type IProjectRestoreOptions, type IProjectValidateOptions, type IToolLogger, type ProjectOperationContext, ProjectTool, ToolResult } from "@uipath/solutionpackager-tool-core";
+import { type IFileSystem, type IProjectBuildOptions, type IProjectCleanupOptions, type IProjectPackOptions, type IProjectRestoreOptions, type IProjectValidateOptions, type IToolLogger, type ProjectOperationContext, ProjectTool, ToolResult } from "@uipath/solutionpackager-tool-core";
 import type { IProjectBundleExecutor } from "./project-bundle-executor.js";
 /**
  * Browser workflow compiler tool implementation.
@@ -14,4 +14,5 @@ export declare class WorkflowCompilerTool extends ProjectTool {
     validateAsync(options: IProjectValidateOptions, _cancellationToken?: AbortSignal): Promise<ToolResult>;
     buildAsync(_options: IProjectBuildOptions, _cancellationToken?: AbortSignal): Promise<ToolResult>;
     packAsync(options: IProjectPackOptions, _cancellationToken?: AbortSignal): Promise<ToolResult>;
+    cleanupAsync(options: IProjectCleanupOptions, _cancellationToken?: AbortSignal): Promise<ToolResult>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uipath/packager-tool-workflowcompiler-browser",
-  "version": "1.197.0",
+  "version": "1.198.0-preview.80",
   "description": "UiPath Workflow Compiler tool - browser implementation",
   "type": "module",
   "exports": {
@@ -25,8 +25,8 @@
   "author": "",
   "license": "ISC",
   "peerDependencies": {
-    "@uipath/solutionpackager-tool-core": "1.197.0",
+    "@uipath/solutionpackager-tool-core": "1.198.0",
     "@microsoft/signalr": ">=7 <11"
   },
-  "gitHead": "56f68b263cec4ea1f2a39d738bd99ecf52f88fea"
+  "gitHead": "9b2c3c0f21a256d2f38dd28bc97e72e6f7b10a9c"
 }

package/src/cleanup-result.ts

@@ -0,0 +1,7 @@
+export type {
+    CleanedWorkflowDetail,
+    RemoteCleanedWorkflow,
+    RemoteWorkflowCompilerCleanupPayload as RemoteProjectCleanup,
+    WorkflowCleanupDetails,
+} from "@uipath/solutionpackager-tool-core";
+export { toProjectCleanupInfoFromRemote as toProjectCleanupInfo } from "@uipath/solutionpackager-tool-core";

package/src/index.ts

@@ -1,5 +1,11 @@
 import "./i18n/index.js";
 
+// Tool-specific cleanup detail. Surfaced via `ProjectCleanupInfo.toolDetails`;
+// only consumers that want WorkflowCompiler specifics import these types.
+export type {
+    CleanedWorkflowDetail,
+    WorkflowCleanupDetails,
+} from "./cleanup-result.js";
 // Workflow Compiler (browser) tool factory. Consumers register it explicitly via
 // `toolsFactoryRepository.registerProjectToolFactory(new WorkflowCompilerToolFactory())`.
 export { WorkflowCompilerToolFactory } from "./workflow-compiler-tool-factory.js";

package/src/packager-hub-connection.ts

@@ -9,6 +9,7 @@ import {
     LogMessage,
     translate,
 } from "@uipath/solutionpackager-tool-core";
+import type { RemoteProjectCleanup } from "./cleanup-result.js";
 
 /** @public */
 export enum CompletedStatus {
@@ -22,6 +23,10 @@ export interface PackAgentResult {
     status: CompletedStatus;
     message?: string;
     bucketId?: number;
+    /** Cleanup only: files changed per project design id, relative to each project. */
+    changedFilesByProject?: Record<string, string[]>;
+    /** Cleanup only: raw per-project cleanup payload, keyed by project design id. */
+    unusedDependenciesByProject?: Record<string, RemoteProjectCleanup>;
 }
 
 interface ExecutorCommand<T> {
@@ -34,6 +39,8 @@ interface PackJobResult {
     Status: number;
     Message?: string;
     BucketId?: number;
+    ChangedFilesByProject?: Record<string, string[]>;
+    UnusedDependenciesByProject?: Record<string, RemoteProjectCleanup>;
 }
 
 enum PackagerCommandType {
@@ -225,6 +232,8 @@ export class PackagerHubConnection {
             status: jobResult.Status,
             message: jobResult.Message,
             bucketId: jobResult.BucketId,
+            changedFilesByProject: jobResult.ChangedFilesByProject,
+            unusedDependenciesByProject: jobResult.UnusedDependenciesByProject,
         });
         this.completionResolve = null;
         this.completionReject = null;

package/src/project-bundle-executor.ts

@@ -1,15 +1,18 @@
 import {
     type ConnectionInfo,
     type IFileSystem,
+    type IProjectCleanupOptions,
     type IProjectPackOptions,
     type IProjectToolFactory,
     type IProjectValidateOptions,
     type IToolLogger,
     type ProjectOperationContext,
+    ToolErrorCodes,
     ToolResult,
     toRelativeUrl,
     translate,
 } from "@uipath/solutionpackager-tool-core";
+import { toProjectCleanupInfo } from "./cleanup-result.js";
 import { PackResultProcessor } from "./pack-result-processor.js";
 import {
     CompletedStatus,
@@ -22,6 +25,7 @@ type ResolveCallback = (result: ToolResult) => void;
 export enum BundleOperation {
     Pack = "Pack",
     Validate = "Validate",
+    Cleanup = "Cleanup",
 }
 
 interface PackEntry {
@@ -36,7 +40,13 @@ interface ValidateEntry {
     resolve: ResolveCallback;
 }
 
-type ProjectEntry = PackEntry | ValidateEntry;
+interface CleanupEntry {
+    operation: BundleOperation.Cleanup;
+    options: IProjectCleanupOptions;
+    resolve: ResolveCallback;
+}
+
+type ProjectEntry = PackEntry | ValidateEntry | CleanupEntry;
 
 interface BundleSession {
     operation: BundleOperation;
@@ -55,6 +65,11 @@ export interface IProjectBundleExecutor {
         options: IProjectValidateOptions,
         context: ProjectOperationContext,
     ): Promise<ToolResult>;
+
+    cleanupAsync(
+        options: IProjectCleanupOptions,
+        context: ProjectOperationContext,
+    ): Promise<ToolResult>;
 }
 
 /**
@@ -117,6 +132,29 @@ export class ProjectBundleExecutor implements IProjectBundleExecutor {
         });
     }
 
+    async cleanupAsync(
+        options: IProjectCleanupOptions,
+        context: ProjectOperationContext,
+    ): Promise<ToolResult> {
+        if (
+            context.downloadUrl &&
+            !options.dryRun &&
+            !context.solutionId &&
+            !context.projectId
+        ) {
+            return ToolResult.error(
+                ToolErrorCodes.InternalError,
+                "Cleanup save-back requires a solutionId or projectId for downloaded workspaces.",
+            );
+        }
+
+        return this.enqueueAsync(context, {
+            operation: BundleOperation.Cleanup,
+            options,
+            resolve: () => {},
+        });
+    }
+
     private async enqueueAsync(
         context: ProjectOperationContext,
         entry: ProjectEntry,
@@ -361,9 +399,50 @@ export class ProjectBundleExecutor implements IProjectBundleExecutor {
             return;
         }
 
+        if (session.operation === BundleOperation.Cleanup) {
+            this.resolveCleanup(result, session, context);
+            return;
+        }
+
         this.resolveAll(session, ToolResult.success());
     }
 
+    /**
+     * The agent removed unused items in-place and (for cloud solutions) saved the
+     * solution back to StudioWeb; there is no bucket to download. Resolve each
+     * project with its own result carrying the changed files (the full map, which
+     * solution-cleanup-service unions) and that project's cleanup payload mapped
+     * to the generic {@link toProjectCleanupInfo} shape.
+     */
+    private resolveCleanup(
+        result: PackAgentResult,
+        session: BundleSession,
+        context: ProjectOperationContext,
+    ): void {
+        for (const [projectPath, entry] of session.projects) {
+            const details: Record<string, unknown> = {};
+            if (result.changedFilesByProject) {
+                details.changedFilesByProject = result.changedFilesByProject;
+            }
+
+            const designId = context.projects.find(
+                (p) => p.ProjectPath === projectPath,
+            )?.Id;
+            const raw = designId
+                ? result.unusedDependenciesByProject?.[designId]
+                : undefined;
+            if (raw) {
+                details.projectCleanup = toProjectCleanupInfo(raw);
+            }
+
+            const projectResult = ToolResult.success();
+            if (Object.keys(details).length > 0) {
+                projectResult.details = details;
+            }
+            entry.resolve(projectResult);
+        }
+    }
+
     private async handlePackBucketAsync(
         result: PackAgentResult,
         session: BundleSession,
@@ -426,6 +505,8 @@ export class ProjectBundleExecutor implements IProjectBundleExecutor {
 
         const firstEntry = session.projects.values().next().value!;
         const opts = firstEntry.options;
+        const skipAnalyze = "skipAnalyze" in opts ? opts.skipAnalyze : false;
+        const skipValidate = "skipValidate" in opts ? opts.skipValidate : false;
 
         const rpaProjects = [...session.projects.entries()].map(
             ([projectPath, entry]) => {
@@ -451,14 +532,16 @@ export class ProjectBundleExecutor implements IProjectBundleExecutor {
             Command: session.operation,
             SupportedProtocolVersions: ["2.0"],
             DownloadUrl: context.downloadUrl ?? "",
+            SolutionId: context.solutionId ?? "",
+            ProjectId: context.projectId ?? "",
             SessionId: sessionId,
             ProfileKey: "StudioWeb",
             LicenseType: "Development",
             LogLevel: opts.logLevel ?? "Warning",
             Culture: "en-US",
             DownloadTimeoutInSeconds: 300,
-            SkipAnalyze: String(opts.skipAnalyze),
-            SkipValidate: String(opts.skipValidate),
+            SkipAnalyze: String(skipAnalyze),
+            SkipValidate: String(skipValidate),
             TargetFramework: context.targetFramework,
             RpaProjects: rpaProjects,
             WorkflowCompilerVersion: context.workflowCompilerVersion ?? "",
@@ -490,6 +573,16 @@ export class ProjectBundleExecutor implements IProjectBundleExecutor {
             executorInfo.ReleaseNotes = pkg.releaseNotes ?? "";
         }
 
+        if (firstEntry.operation === BundleOperation.Cleanup) {
+            executorInfo.DryRun = firstEntry.options.dryRun;
+            executorInfo.SkipImports = firstEntry.options.skipImports;
+            // Forward the StudioWeb editing session's solution lock key so the agent's
+            // save-back overwrite is accepted while the solution is locked by that session.
+            if (context.lockKey) {
+                executorInfo.LockKey = context.lockKey;
+            }
+        }
+
         const inputArguments = JSON.stringify(executorInfo);
 
         const body: Record<string, unknown> = {

package/src/workflow-compiler-tool.ts

@@ -1,6 +1,7 @@
 import {
     type IFileSystem,
     type IProjectBuildOptions,
+    type IProjectCleanupOptions,
     type IProjectPackOptions,
     type IProjectRestoreOptions,
     type IProjectValidateOptions,
@@ -75,4 +76,18 @@ export class WorkflowCompilerTool extends ProjectTool {
 
         return this.bundleExecutor.packAsync(options, this.context);
     }
+
+    async cleanupAsync(
+        options: IProjectCleanupOptions,
+        _cancellationToken?: AbortSignal,
+    ): Promise<ToolResult> {
+        if (!this.context) {
+            return ToolResult.error(
+                ToolErrorCodes.InternalError,
+                "Cleanup operation requires a project operation context",
+            );
+        }
+
+        return this.bundleExecutor.cleanupAsync(options, this.context);
+    }
 }