npm - @uipath/common - Versions diffs - 1.200.0-preview.120 → 1.201.0-preview.121 - Mend

@uipath/common 1.200.0-preview.120 → 1.201.0-preview.121

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (14) hide show

package/dist/command-extensions.d.ts +6 -0
package/dist/error-handler.d.ts +36 -0
package/dist/formatter.d.ts +21 -4
package/dist/index.browser.js +90 -41
package/dist/index.d.ts +4 -1
package/dist/index.js +8202 -7989
package/dist/option-validators.d.ts +14 -0
package/dist/output-codecs.d.ts +56 -0
package/dist/solution-project-types.d.ts +22 -0
package/dist/telemetry/proxy-http-agent.d.ts +2 -0
package/dist/tool-provider.d.ts +1 -21
package/package.json +2 -2
package/dist/solution-project-artifacts.d.ts +0 -43
package/dist/tool-module-import.d.ts +0 -9

package/dist/command-extensions.d.ts ADDED Viewed

@@ -0,0 +1,6 @@
+import { Command } from "commander";
+import "./command-examples";
+import "./preview";
+import "./trackedAction.js";
+/** Install Common's Commander augmentations on a caller-owned constructor. */
+export declare function installCommandExtensions(commandConstructor: typeof Command): void;

package/dist/error-handler.d.ts CHANGED Viewed

@@ -45,6 +45,23 @@ export interface ConnectivityError {
     /** Actionable, user-facing remediation steps. */
     instructions: string;
 }
+/**
+ * A local OS/sandbox permission failure (EACCES, EPERM, EROFS), already
+ * classified with actionable guidance. Returned by
+ * {@link describePermissionError}. Deliberately distinct from an HTTP 403:
+ * this failure means the local OS refused a syscall, so the fix is a local
+ * permission grant or elevation, never a credential or role change.
+ */
+export interface LocalPermissionError {
+    /** The OS error code, e.g. `EACCES`. */
+    code: string;
+    /** The most specific message found while walking the cause chain. */
+    message: string;
+    /** The file or directory the OS refused access to, when known. */
+    path?: string;
+    /** Actionable, user-facing remediation steps. */
+    instructions: string;
+}
 export declare function formatErrorChain(error: unknown): string;
 /**
  * Classify an outbound connectivity failure by walking the error graph.
@@ -60,6 +77,25 @@ export declare function formatErrorChain(error: unknown): string;
  * failure so callers can fall back to their normal handling.
  */
 export declare function describeConnectivityError(error: unknown): ConnectivityError | undefined;
+/**
+ * Classify a local OS/sandbox permission failure by walking the error graph.
+ *
+ * Recognises `EACCES`/`EPERM`/`EROFS` on the `code` property of any node in
+ * the `.cause` / `AggregateError.errors` graph, and falls back to the errno
+ * token inside the message for errors that were re-wrapped and lost their
+ * `code` (e.g. `catchError`'s `new Error(String(err))`). Returns `undefined`
+ * for anything else — including HTTP-shaped errors, which are the service's
+ * failures, not the local OS's.
+ */
+export declare function describePermissionError(error: unknown): LocalPermissionError | undefined;
+/**
+ * Parse an `HTTP <status>` prefix out of an error message. SDK wrappers often
+ * throw plain `Error`s shaped `HTTP 403: <body>` with no structured status
+ * field; every classifier that treats "has a status" as "the service
+ * answered" must see these too, or the local-vs-service split drifts between
+ * layers. Shared by {@link extractErrorDetails} and `instructionsFor`.
+ */
+export declare function parseHttpStatusFromMessage(message: string): number | undefined;
 export declare function isHtmlDocument(body: string): boolean;
 /**
  * Extract a structured error message and details from an unknown thrown value.

package/dist/formatter.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@ import { type CommandErrorClass, type TerminalOutcome } from "./telemetry/comman
 export type OutputFormat = "table" | "json" | "yaml" | "plain";
 export type ResultType = "Success" | "Failure" | "ConfigError" | "AuthenticationError" | "ValidationError" | "TimeoutError";
 export type FailureResultType = Exclude<ResultType, "Success">;
-export declare const CLI_ERROR_CODES: readonly ["invalid_argument", "authentication_required", "permission_denied", "not_found", "rate_limited", "network_error", "timeout", "server_error", "method_not_allowed", "configuration_error", "unknown_error"];
+export declare const CLI_ERROR_CODES: readonly ["invalid_argument", "authentication_required", "permission_denied", "local_permission_denied", "not_found", "rate_limited", "network_error", "timeout", "server_error", "method_not_allowed", "configuration_error", "unknown_error"];
 export type CliErrorCode = (typeof CLI_ERROR_CODES)[number];
 export declare const RETRY_HINTS: readonly ["RetryWillNotFix", "RetryLater", "RetryAfter1Second", "RetryAfter10Seconds", "RetryAfter30Seconds", "RetryAfter60Seconds"];
 export type RetryHint = (typeof RETRY_HINTS)[number];
@@ -41,14 +41,24 @@ export type DataRecord = Record<string, unknown> | (object & Record<never, never
 export declare class Pagination {
     Returned: number;
     Limit: number;
-    Offset: number;
+    /** Absent for APIs that page by cursor instead of by offset. */
+    Offset?: number;
     Total?: number;
     HasMore: boolean;
-    constructor({ returned, limit, offset, total, }: {
+    /**
+     * Opaque cursor the caller passes back to fetch the next page. Only set by
+     * APIs that page by cursor (e.g. PIMS instance listing); absent on the last
+     * page and on offset-paged commands.
+     */
+    NextPage?: string;
+    constructor({ returned, limit, offset, total, hasMore, nextPage, }: {
         returned: number;
         limit: number;
-        offset: number;
+        offset?: number;
         total?: number;
+        /** Server-reported "more pages exist"; overrides the derived guess. */
+        hasMore?: boolean;
+        nextPage?: string;
     });
 }
 export declare class SuccessOutput {
@@ -77,6 +87,10 @@ export interface ErrorContext {
     method?: string;
     /** Distributed-tracing id parsed from the backend error body when present. */
     traceId?: string;
+    /** Local filesystem path the OS refused access to. Set only for
+     *  `local_permission_denied` failures — it is the one datum a caller
+     *  needs to decide which permission to grant. */
+    path?: string;
 }
 export declare class FailureOutput {
     Result: FailureResultType;
@@ -142,6 +156,9 @@ export declare function escapeNonAscii(jsonText: string): string;
  * successfully can still throw at evaluation time (e.g. type-coercion errors
  * when functions receive unexpected types). Callers that need a fully
  * closed-box guarantee must additionally wrap {@link applyFilter}.
+ *
+ * Requires `loadOutputCodecsAsync({ filter: true })` to have run — the CLI
+ * host awaits it immediately before calling this.
  */
 export declare function validateOutputFilter(filter: string): Error | null;
 /**

package/dist/index.browser.js CHANGED Viewed

@@ -21052,6 +21052,16 @@ var TLS_ERROR_CODES = new Set([
 ]);
 var TLS_INSTRUCTIONS = "The server's TLS certificate could not be verified. Most often a " + "corporate proxy/firewall re-signs HTTPS with a root CA that Node does " + "not trust — set NODE_EXTRA_CA_CERTS to that CA's PEM file (and HTTPS_PROXY " + "if you connect through a proxy). If the certificate is instead expired or " + "its hostname does not match, fix the endpoint URL or the system clock. " + "Then retry.";
 var NETWORK_INSTRUCTIONS = "Could not reach the UiPath service. Check your network connection and " + "VPN, confirm any HTTP_PROXY/HTTPS_PROXY/NO_PROXY settings are correct, " + "then retry.";
+var LOCAL_PERMISSION_ERROR_CODES = new Set(["EACCES", "EPERM", "EROFS"]);
+var LOCAL_PERMISSION_MESSAGE_PATTERN = /\b(EACCES|EPERM|EROFS)\b/;
+function localPermissionInstructions(code2, path) {
+  const target = path !== undefined ? `'${path}'` : "a local file or resource";
+  if (code2 === "EROFS") {
+    return `The filesystem containing ${target} is read-only (EROFS), so the ` + "CLI could not write to it. This is a local environment problem, " + "not a UiPath service error — retrying will not help. Use a " + "writable location, or give this environment write access to the " + "path.";
+  }
+  const remedy = process.platform === "win32" ? "Re-run from an elevated terminal, close any program holding " + "the file open, or grant your user access to the path." : "Grant this user (or the sandbox the command runs in) access " + "to the path, or run the command outside the sandbox.";
+  return `The operating system denied access to ${target} (${code2}). This is ` + "a local permission problem, not a UiPath service error — retrying " + `without a permission change will not help. ${remedy}`;
+}
 function formatErrorChain(error) {
   const lines = [];
   const seen = new Set;
@@ -21084,16 +21094,7 @@ function formatErrorChain(error) {
 `);
 }
 function describeConnectivityError(error) {
-  const queue2 = [error];
-  const seen = new Set;
-  for (let steps = 0;queue2.length > 0 && steps < 32; steps++) {
-    const current = queue2.shift();
-    if (current === null || typeof current !== "object")
-      continue;
-    if (seen.has(current))
-      continue;
-    seen.add(current);
-    const cur = current;
+  for (const cur of walkErrorGraph(error)) {
     const code2 = typeof cur.code === "string" ? cur.code : undefined;
     const message = typeof cur.message === "string" ? cur.message : undefined;
     if (code2 && TLS_ERROR_CODES.has(code2)) {
@@ -21112,6 +21113,49 @@ function describeConnectivityError(error) {
         instructions: NETWORK_INSTRUCTIONS
       };
     }
+  }
+  return;
+}
+function describePermissionError(error) {
+  for (const cur of walkErrorGraph(error)) {
+    const message = typeof cur.message === "string" ? cur.message : undefined;
+    const code2 = matchLocalPermissionCode(cur.code, message);
+    if (!code2)
+      continue;
+    const path = localPermissionPath(cur.path, message);
+    return {
+      code: code2,
+      message: message ?? code2,
+      ...path !== undefined ? { path } : {},
+      instructions: localPermissionInstructions(code2, path)
+    };
+  }
+  return;
+}
+function matchLocalPermissionCode(code2, message) {
+  if (typeof code2 === "string" && LOCAL_PERMISSION_ERROR_CODES.has(code2)) {
+    return code2;
+  }
+  const match = message ? LOCAL_PERMISSION_MESSAGE_PATTERN.exec(message) : null;
+  return match ? match[1] : undefined;
+}
+function localPermissionPath(path, message) {
+  if (typeof path === "string")
+    return path;
+  return message ? /'([^']+)'/.exec(message)?.[1] : undefined;
+}
+function* walkErrorGraph(error) {
+  const queue2 = [error];
+  const seen = new Set;
+  for (let steps = 0;queue2.length > 0 && steps < 32; steps++) {
+    const current = queue2.shift();
+    if (current === null || typeof current !== "object")
+      continue;
+    if (seen.has(current))
+      continue;
+    seen.add(current);
+    const cur = current;
+    yield cur;
     if (cur.cause !== undefined)
       queue2.push(cur.cause);
     if (Array.isArray(cur.errors))
@@ -21172,6 +21216,12 @@ function classifyError(status, error) {
   if (status !== undefined && status >= 500 && status < 600) {
     return { errorCode: "server_error", retry: "RetryLater" };
   }
+  if (status === undefined && describePermissionError(error)) {
+    return {
+      errorCode: "local_permission_denied",
+      retry: "RetryWillNotFix"
+    };
+  }
   const connectivity = describeConnectivityError(error);
   if (connectivity) {
     return {
@@ -21274,6 +21324,16 @@ async function extractErrorDetails(error, options) {
       message = `${message}: ${connectivity.message}`;
     }
   }
+  const permission = status === undefined ? describePermissionError(error) : undefined;
+  if (permission) {
+    if (permission.message !== message && !message.includes(permission.message)) {
+      message = `${message}: ${permission.message}`;
+    }
+    if (!message.includes(permission.instructions)) {
+      const punctuated = message.endsWith(".") ? message : `${message}.`;
+      message = `${punctuated} ${permission.instructions}`;
+    }
+  }
   let details = rawMessage;
   if (rawBody) {
     if (parsedBody) {
@@ -21313,6 +21373,9 @@ async function extractErrorDetails(error, options) {
   if (parsedBody?.traceId && typeof parsedBody.traceId === "string") {
     context.traceId = parsedBody.traceId;
   }
+  if (permission?.path !== undefined) {
+    context.path = permission.path;
+  }
   if (status === 429) {
     const resp = response;
     const headersObj = resp?.headers;
@@ -21388,7 +21451,10 @@ function extractHttpStatus(err) {
   if (!err || typeof err !== "object")
     return;
   const e = err;
-  return e.response?.status ?? e.status ?? e.statusCode;
+  const structured = e.response?.status ?? e.status ?? e.statusCode;
+  if (structured !== undefined)
+    return structured;
+  return typeof e.message === "string" ? parseHttpStatusFromMessage(e.message) : undefined;
 }
 var GENERIC = "Check authentication and parameters";
 function instructionsFor(ctx, err) {
@@ -21422,6 +21488,10 @@ function instructionsFor(ctx, err) {
       if (status !== undefined && status >= 500 && status < 600) {
         return "Orchestrator returned a server error — retry; if it persists, check service status";
       }
+      const permission = describePermissionError(err);
+      if (permission) {
+        return permission.instructions;
+      }
       const connectivity = describeConnectivityError(err);
       if (connectivity) {
         return connectivity.instructions;
@@ -21688,6 +21758,11 @@ function parseSafeInteger(raw, min) {
   }
   return parsed;
 }
+function splitScopeList(raw) {
+  if (!raw)
+    return [];
+  return raw.split(/[\s,]+/).filter((scope) => scope.length > 0);
+}
 // src/orchestrator-urls.ts
 function requireNonEmpty(label, value) {
   if (typeof value !== "string" || value.trim().length === 0) {
@@ -23358,38 +23433,11 @@ async function importPackagerTool(specifier) {
   return registerError;
 }
-// src/tool-module-import.ts
-async function importToolModule(specifier) {
-  return await import(specifier);
-}
 // src/tool-provider.ts
 var factorySlot = singleton("PackagerFactoryProvider");
 function setPackagerFactoryProvider(provider) {
   factorySlot.set(provider);
 }
-var moduleSlot = singleton("ToolModuleProvider");
-function setToolModuleProvider(provider) {
-  moduleSlot.set(provider);
-}
-async function ensureToolModule(verb, packageName, moduleName) {
-  if (!/^[a-z0-9-]+$/.test(moduleName)) {
-    throw new Error(`Invalid tool module name '${moduleName}'.`);
-  }
-  const provider = moduleSlot.get();
-  if (provider) {
-    return provider(verb, moduleName);
-  }
-  const specifier = `${packageName}/${moduleName}`;
-  const [importError, mod] = await catchError(importToolModule(specifier));
-  if (importError) {
-    logger.debug(`No tool-module provider registered; import of '${specifier}' failed: ${importError.message}`);
-    throw new Error(`This command needs '${packageName}'. Install it.`, {
-      cause: importError
-    });
-  }
-  return mod;
-}
 async function ensurePackagerFactory(verb, packageName) {
   const provider = factorySlot.get();
   if (provider) {
@@ -23413,8 +23461,8 @@ async function loadPackagerTool(specifier) {
 export {
   withCompleter,
   takeRecordedCommandFailureTelemetry,
+  splitScopeList,
   singleton,
-  setToolModuleProvider,
   setSdkUserAgentHostToken,
   setPackagerFactoryProvider,
   setOutputFormatExplicit,
@@ -23434,6 +23482,7 @@ export {
   parseOffset,
   parseNonNegativeInteger,
   parseLimit,
+  parseHttpStatusFromMessage,
   parseBoundedInt,
   normalizeSkillName,
   msToDuration,
@@ -23470,8 +23519,8 @@ export {
   extractErrorMessage,
   extractErrorDetails,
   extractCommandHelp,
-  ensureToolModule,
   ensurePackagerFactory,
+  describePermissionError,
   describeConnectivityError,
   createPollAbortController,
   configureLogger,
@@ -23510,4 +23559,4 @@ export {
   AUTH_FILENAME
 };
-//# debugId=C2BB3B73AD55AF7D64756E2164756E21
+//# debugId=8E9A65CE1EE8015D64756E2164756E21

package/dist/index.d.ts CHANGED Viewed

@@ -2,6 +2,7 @@ export * from "./attachment-binding";
 export * from "./body-validators";
 export * from "./catch-error";
 export * from "./command-examples";
+export * from "./command-extensions";
 export * from "./command-help";
 export * from "./command-walker";
 export * from "./completer";
@@ -20,6 +21,7 @@ export * from "./logger";
 export * from "./option-aliases";
 export * from "./option-validators";
 export * from "./orchestrator-urls";
+export * from "./output-codecs";
 export * from "./output-context";
 export * from "./output-format-context";
 export * from "./output-sink";
@@ -31,7 +33,7 @@ export * from "./registry";
 export * from "./screen-logger";
 export * from "./sdk-user-agent";
 export * from "./singleton";
-export * from "./solution-project-artifacts";
+export * from "./solution-project-types";
 export * from "./stdin";
 export { BrowserContextStorage } from "./telemetry/browser-context-storage.js";
 export * from "./telemetry/command-attribution.js";
@@ -40,6 +42,7 @@ export { ConsoleTelemetryProvider } from "./telemetry/console-telemetry-provider
 export * from "./telemetry/node.js";
 export { setGlobalTelemetryProperties } from "./telemetry/node-appinsights-telemetry-provider.js";
 export { redactError, redactProperties, redactProperty, redactValue, } from "./telemetry/pii-redactor.js";
+export { getProxyAuthHttpsAgent, setProxyAuthHttpsAgent, } from "./telemetry/proxy-http-agent.js";
 export { type ShipSucceededTelemetryPayload, trackShipSucceeded, } from "./telemetry/ship-succeeded.js";
 export * from "./telemetry/telemetry-events.js";
 export * from "./telemetry/telemetry-init.js";