@appium/support 7.0.5 → 7.0.6

package/build/lib/timing.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Duration = exports.Timer = void 0;
+exports.default = exports.Timer = exports.Duration = void 0;
 const lodash_1 = __importDefault(require("lodash"));
 const NS_PER_S = 1e9;
 const NS_PER_MS = 1e6;
@@ -11,8 +11,9 @@ const NS_PER_MS = 1e6;
  * Class representing a duration, encapsulating the number and units.
  */
 class Duration {
-    constructor(nanos) {
-        this._nanos = nanos;
+    _nanos;
+    constructor(_nanos) {
+        this._nanos = _nanos;
     }
     get nanos() {
         return this._nanos;
@@ -48,11 +49,12 @@ class Duration {
 }
 exports.Duration = Duration;
 class Timer {
+    _startTime;
     /**
      * Creates a timer
      */
-    constructor() {
-        this._startTime = null;
+    constructor(_startTime = null) {
+        this._startTime = _startTime;
     }
     get startTime() {
         return this._startTime;
@@ -63,13 +65,10 @@ class Timer {
      * @return {Timer} The current instance, for chaining
      */
     start() {
-        if (!lodash_1.default.isNull(this.startTime)) {
+        if (!lodash_1.default.isNull(this._startTime)) {
             throw new Error('Timer has already been started.');
         }
-        // once Node 10 is no longer supported, this check can be removed
-        this._startTime = lodash_1.default.isFunction(process.hrtime.bigint)
-            ? process.hrtime.bigint()
-            : process.hrtime();
+        this._startTime = process.hrtime.bigint();
         return this;
     }
     /**
@@ -78,23 +77,23 @@ class Timer {
      * @return {Duration} the duration
      */
     getDuration() {
-        if (lodash_1.default.isNull(this.startTime)) {
-            throw new Error(`Unable to get duration. Timer was not started`);
+        if (lodash_1.default.isNull(this._startTime)) {
+            throw new Error('Unable to get duration. Timer was not started');
         }
         let nanoDuration;
-        if (lodash_1.default.isArray(this.startTime)) {
+        if (lodash_1.default.isArray(this._startTime)) {
             // startTime was created using process.hrtime()
-            const [seconds, nanos] = process.hrtime(this.startTime);
+            const [seconds, nanos] = process.hrtime(this._startTime);
             nanoDuration = seconds * NS_PER_S + nanos;
         }
-        else if (typeof this.startTime === 'bigint' && lodash_1.default.isFunction(process.hrtime.bigint)) {
+        else if (typeof this._startTime === 'bigint') {
             // startTime was created using process.hrtime.bigint()
             const endTime = process.hrtime.bigint();
             // get the difference, and convert to number
-            nanoDuration = Number(endTime - this.startTime);
+            nanoDuration = Number(endTime - this._startTime);
         }
         else {
-            throw new Error(`Unable to get duration. Start time '${this.startTime}' cannot be parsed`);
+            throw new Error(`Unable to get duration. Start time '${this._startTime}' cannot be parsed`);
         }
         return new Duration(nanoDuration);
     }

package/build/lib/timing.js.map

@@ -1 +1 @@
-{"version":3,"file":"timing.js","sourceRoot":"","sources":["../../lib/timing.js"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AAEvB,MAAM,QAAQ,GAAG,GAAG,CAAC;AACrB,MAAM,SAAS,GAAG,GAAG,CAAC;AAEtB;;GAEG;AACH,MAAM,QAAQ;IACZ,YAAY,KAAK;QACf,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC;IAC/B,CAAC;IAED,QAAQ;QACN,mCAAmC;QACnC,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IACxC,CAAC;CACF;AAkEc,4BAAQ;AAhEvB,MAAM,KAAK;IACT;;OAEG;IACH;QACE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;IACzB,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,KAAK;QACH,IAAI,CAAC,gBAAC,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;QACrD,CAAC;QACD,iEAAiE;QACjE,IAAI,CAAC,UAAU,GAAG,gBAAC,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;YACnD,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE;YACzB,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,WAAW;QACT,IAAI,gBAAC,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;QACnE,CAAC;QAED,IAAI,YAAY,CAAC;QACjB,IAAI,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YAC9B,+CAA+C;YAC/C,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACxD,YAAY,GAAG,OAAO,GAAG,QAAQ,GAAG,KAAK,CAAC;QAC5C,CAAC;aAAM,IAAI,OAAO,IAAI,CAAC,SAAS,KAAK,QAAQ,IAAI,gBAAC,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;YACrF,sDAAsD;YACtD,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACxC,4CAA4C;YAC5C,YAAY,GAAG,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;QAClD,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,uCAAuC,IAAI,CAAC,SAAS,oBAAoB,CAAC,CAAC;QAC7F,CAAC;QAED,OAAO,IAAI,QAAQ,CAAC,YAAY,CAAC,CAAC;IACpC,CAAC;IAED,QAAQ;QACN,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,CAAC;QACvC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,SAAS,GAAG,CAAC,OAAO,GAAG,CAAC;QACjC,CAAC;IACH,CAAC;CACF;AAEO,sBAAK;AACb,kBAAe,KAAK,CAAC"}
+{"version":3,"file":"timing.js","sourceRoot":"","sources":["../../lib/timing.ts"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AAEvB,MAAM,QAAQ,GAAG,GAAG,CAAC;AACrB,MAAM,SAAS,GAAG,GAAG,CAAC;AAKtB;;GAEG;AACH,MAAa,QAAQ;IACC;IAApB,YAAoB,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;IAAG,CAAC;IAEtC,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC;IAC/B,CAAC;IAED,QAAQ;QACN,mCAAmC;QACnC,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IACxC,CAAC;CACF;AAtCD,4BAsCC;AAED,MAAa,KAAK;IAII;IAHpB;;OAEG;IACH,YAAoB,aAA4B,IAAI;QAAhC,eAAU,GAAV,UAAU,CAAsB;IAAG,CAAC;IAExD,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,KAAK;QACH,IAAI,CAAC,gBAAC,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;QACrD,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,WAAW;QACT,IAAI,gBAAC,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;QACnE,CAAC;QAED,IAAI,YAAoB,CAAC;QACzB,IAAI,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YAC/B,+CAA+C;YAC/C,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,UAA8B,CAAC,CAAC;YAC7E,YAAY,GAAG,OAAO,GAAG,QAAQ,GAAG,KAAK,CAAC;QAC5C,CAAC;aAAM,IAAI,OAAO,IAAI,CAAC,UAAU,KAAK,QAAQ,EAAE,CAAC;YAC/C,sDAAsD;YACtD,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACxC,4CAA4C;YAC5C,YAAY,GAAG,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC;QACnD,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,uCAAuC,IAAI,CAAC,UAAU,oBAAoB,CAAC,CAAC;QAC9F,CAAC;QAED,OAAO,IAAI,QAAQ,CAAC,YAAY,CAAC,CAAC;IACpC,CAAC;IAED,QAAQ;QACN,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,CAAC;QACvC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,SAAU,GAAa,CAAC,OAAO,GAAG,CAAC;QAC5C,CAAC;IACH,CAAC;CACF;AAzDD,sBAyDC;AAEgB,wBAAO"}

package/build/lib/util.d.ts

@@ -1,233 +1,216 @@
-/**
- * @template {string} T
- * @param {T} val
- * @returns {val is NonEmptyString<T>}
- */
-export function hasContent<T extends string>(val: T): val is NonEmptyString<T>;
-export type PluralizeOptions = {
-    /**
-     * - Whether to prefix with the number (e.g., 3 ducks)
-     */
-    inclusive?: boolean | undefined;
-};
-export type EncodingOptions = {
-    /**
-     * The maximum size of
-     * the resulting buffer in bytes. This is set to 1GB by default, because
-     * Appium limits the maximum HTTP body size to 1GB. Also, the NodeJS heap
-     * size must be enough to keep the resulting object (usually this size is
-     * limited to 1.4 GB)
-     */
-    maxSize?: number | undefined;
-};
-export type LockFileOptions = {
-    /**
-     * The max time in seconds to wait for the lock
-     */
-    timeout?: number | undefined;
-    /**
-     * Whether to try lock recovery if
-     * the first attempt to acquire it timed out.
-     */
-    tryRecovery?: boolean | undefined;
-};
-/**
- * A `string` which is never `''`.
- */
-export type NonEmptyString<T extends string> = T extends "" ? never : T;
-/**
- * return true if the the value is not `undefined`, `null`, or `NaN`.
+import B from 'bluebird';
+import { parse as shellParse } from 'shell-quote';
+export { shellParse };
+export { v1 as uuidV1, v3 as uuidV3, v4 as uuidV4, v5 as uuidV5 } from 'uuid';
+import type { Element } from '@appium/types';
+/** W3C WebDriver element identifier key used in element objects. */
+export declare const W3C_WEB_ELEMENT_IDENTIFIER = "element-6066-11e4-a52e-4f735466cecf";
+/** Size of one kibibyte in bytes (1024). */
+export declare const KiB = 1024;
+/** Size of one mebibyte in bytes (1024 * 1024). */
+export declare const MiB: number;
+/** Size of one gibibyte in bytes (1024 * 1024 * 1024). */
+export declare const GiB: number;
+/** A string which is never `''`. */
+export type NonEmptyString<T extends string = string> = T extends '' ? never : T;
+/**
+ * Type guard: returns true if the value is a non-empty string.
  *
- * XXX: `NaN` is not expressible in TypeScript.
- * @template T
- * @param {T} val
- * @returns {val is NonNullable<T>}
+ * @param val - Value to check
+ * @returns `true` if `val` is a string with at least one character
  */
-export function hasValue<T>(val: T): val is NonNullable<T>;
+export declare function hasContent(val: unknown): val is NonEmptyString;
 /**
- * Escape spaces in string, for commandline calls
- * @param {string} str - The string to escape spaces in
- * @returns {string} The string with escaped spaces
+ * Type guard: returns true if the value is not `undefined`, `null`, or `NaN`.
+ *
+ * @param val - Value to check
+ * @returns `true` if `val` is non-null and non-undefined (and not NaN for numbers)
  */
-export function escapeSpace(str: string): string;
+export declare function hasValue<T>(val: T): val is NonNullable<T>;
 /**
- * Escape special characters in string
- * @param {string|any} str - The string to escape special characters in
- * @param {string} quoteEscape - Whether to escape quotes
- * @returns {string|any} The string with escaped special characters, or original value if not a string
+ * Escapes spaces in a string for use in command-line arguments (e.g. ` ` → `\ `).
+ *
+ * @param str - String that may contain spaces
+ * @returns String with spaces escaped by a backslash
  */
-export function escapeSpecialChars(str: string | any, quoteEscape: string): string | any;
+export declare function escapeSpace(str: string): string;
 /**
- * Get the local IP address of the machine
- * @returns {string|undefined} The local IP address of the first external IPv4 interface, or undefined if not found
+ * Escapes special characters in a string (backslash, slash, quotes, control chars).
+ * If `quoteEscape` is provided, that character is also escaped.
+ *
+ * @param str - String to escape, or non-string value (returned unchanged)
+ * @param quoteEscape - Optional character to escape, or `false` to skip
+ * @returns Escaped string, or original value if `str` is not a string
  */
-export function localIp(): string | undefined;
-export function cancellableDelay(ms: any): B<any>;
-export function multiResolve(roots: any, ...args: any[]): any;
+export declare function escapeSpecialChars(str: string | unknown, quoteEscape?: string | false): string | unknown;
 /**
- * Parses an object if possible. Otherwise returns the object without parsing.
+ * Returns the first non-internal IPv4 address of the machine, if any.
  *
- * @param {any} obj
- * @returns {any}
+ * @returns The local IPv4 address, or `undefined` if none found
  */
-export function safeJsonParse(obj: any): any;
+export declare function localIp(): string | undefined;
 /**
+ * Creates a promise that resolves after a delay and can be cancelled via `.cancel()`.
  *
- * @param {string} elementId
- * @returns {import('@appium/types').Element}
+ * @param ms - Delay in milliseconds before the promise resolves
+ * @returns A Bluebird promise with a `cancel()` method; cancel rejects with CancellationError
  */
-export function wrapElement(elementId: string): import("@appium/types").Element;
+export declare function cancellableDelay(ms: number): B<void> & {
+    cancel: () => void;
+};
 /**
- * Removes the wrapper from element, if it exists.
- *   { ELEMENT: 4 } becomes 4
- *   { element-6066-11e4-a52e-4f735466cecf: 5 } becomes 5
- * @param {import('@appium/types').Element|string} el
- * @returns {string}
+ * Resolves each root path with the given path segments, returning an array of absolute paths.
+ *
+ * @param roots - Base directory paths to resolve against
+ * @param args - Path segments to join with each root (e.g. 'foo', 'bar' → root/foo/bar)
+ * @returns Array of absolute paths, one per root
  */
-export function unwrapElement(el: import("@appium/types").Element | string): string;
-export function filterObject(obj: any, predicate: any): any;
+export declare function multiResolve(roots: string[], ...args: string[]): string[];
 /**
- * Converts number of bytes to a readable size string.
+ * Parses a value as JSON if it is a string; otherwise returns the value as-is.
  *
- * @param {number|string} bytes - The actual number of bytes.
- * @returns {string} The actual string representation, for example
- *                   '1.00 KB' for '1024 B'
- * @throws {Error} If bytes count cannot be converted to an integer or
- *                 if it is less than zero.
+ * @param obj - String (to parse) or other value (returned unchanged)
+ * @returns Parsed object or original value
  */
-export function toReadableSizeString(bytes: number | string): string;
+export declare function safeJsonParse<T>(obj: unknown): T;
 /**
- * Checks whether the given path is a subpath of the
- * particular root folder. Both paths can include .. and . specifiers
+ * Stringifies an object to JSON, converting Buffers to strings for readable output.
  *
- * @param {string} originalPath The absolute file/folder path
- * @param {string} root The absolute root folder path
- * @param {?boolean} forcePosix Set it to true if paths must be interpreted in POSIX format
- * @returns {boolean} true if the given original path is the subpath of the root folder
- * @throws {Error} if any of the given paths is not absolute
+ * @param obj - Object to serialize
+ * @param replacer - Optional replacer function (same as JSON.stringify)
+ * @param space - Indentation for pretty-printing. Defaults to 2
+ * @returns JSON string
  */
-export function isSubPath(originalPath: string, root: string, forcePosix?: boolean | null): boolean;
-export const W3C_WEB_ELEMENT_IDENTIFIER: "element-6066-11e4-a52e-4f735466cecf";
+export declare function jsonStringify(obj: unknown, replacer?: ((key: string, value: unknown) => unknown) | null, space?: number | string): string;
 /**
- * Checks whether the given paths are pointing to the same file system
- * destination.
+ * Extracts the element ID from a W3C or JSONWP element object, or returns the string if already an ID.
  *
- * @param {string} path1 - Absolute or relative path to a file/folder
- * @param {string} path2 - Absolute or relative path to a file/folder
- * @param {...string} pathN - Zero or more absolute or relative paths to files/folders
- * @returns {Promise<boolean>} true if all paths are pointing to the same file system item
+ * @param el - Element object (with ELEMENT or W3C identifier) or raw element ID string
+ * @returns The element ID string
  */
-export function isSameDestination(path1: string, path2: string, ...pathN: string[]): Promise<boolean>;
+export declare function unwrapElement(el: Element | string): string;
 /**
- * Compares two version strings
+ * Wraps an element ID string in an element object compatible with both W3C and JSONWP.
  *
- * @param {string} ver1 - The first version number to compare. Should be a valid
- * version number supported by semver parser.
- * @param {string} ver2 - The second version number to compare. Should be a valid
- * version number supported by semver parser.
- * @param {string} operator - One of supported version number operators:
- * ==, !=, >, <, <=, >=, =
- * @returns {boolean} true or false depending on the actual comparison result
- * @throws {Error} if an unsupported operator is supplied or any of the supplied
- * version strings cannot be coerced
+ * @param elementId - The element ID to wrap
+ * @returns Element object with both ELEMENT and W3C identifier keys
  */
-export function compareVersions(ver1: string, operator: string, ver2: string): boolean;
+export declare function wrapElement(elementId: string): Element;
 /**
- * Coerces the given number/string to a valid version string
+ * Returns a copy of the object containing only properties that pass the predicate.
+ * If the predicate is missing, removes properties whose values are undefined.
+ * If the predicate is a scalar, keeps only properties whose value equals that scalar.
+ * If the predicate is a function, calls it for each (value, obj) and keeps properties where it returns true.
  *
- * @template {boolean} [Strict=true]
- * @param {string} ver - Version string to coerce
- * @param {Strict} [strict] - If `true` then an exception will be thrown
- * if `ver` cannot be coerced
- * @returns {Strict extends true ? string : string|null} Coerced version number or null if the string cannot be
- * coerced and strict mode is disabled
- * @throws {Error} if strict mode is enabled and `ver` cannot be coerced
+ * @param obj - Source object to filter
+ * @param predicate - Optional filter: undefined (drop undefined values), scalar (value match), or function
+ * @returns New object with only the properties that pass the predicate
  */
-export function coerceVersion<Strict extends boolean = true>(ver: string, strict?: Strict): Strict extends true ? string : string | null;
+export declare function filterObject<T extends Record<string, unknown>>(obj: T, predicate?: ((value: unknown, obj: T) => boolean) | unknown): Partial<T>;
 /**
- * Add appropriate quotes to command arguments. See https://github.com/substack/node-shell-quote
- * for more details
+ * Converts a byte count to a human-readable size string (e.g. "1.50 MB").
  *
- * @param {string|string[]} args - The arguments that will be parsed
- * @returns {string} - The arguments, quoted
+ * @param bytes - Number of bytes (or string coercible to a number)
+ * @returns Formatted string like "123 B", "1.50 KB", "2.00 MB", "3.00 GB"
+ * @throws {Error} If bytes cannot be converted to a non-negative integer
  */
-export function quote(args: string | string[]): string;
+export declare function toReadableSizeString(bytes: number | string): string;
 /**
- * Stringifies the object passed in, converting Buffers into Strings for better
- * display. This mimics JSON.stringify (see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify)
- * except the `replacer` argument can only be a function.
+ * Checks whether the given path is a subpath of the given root folder.
  *
- * @param {any} obj - the object to be serialized
- * @param {((key:any, value:any) => any)?} replacer - function to transform the properties added to the
- *                               serialized object
- * @param {number|string|undefined} space - used to insert white space into the output JSON
- *                                 string for readability purposes. Defaults to 2
- * @returns {string} - the JSON object serialized as a string
+ * @param originalPath - The absolute file or folder path to test
+ * @param root - The absolute root folder path
+ * @param forcePosix - If true, interpret paths in POSIX format (e.g. on Windows)
+ * @returns `true` if `originalPath` is under `root`
+ * @throws {Error} If either path is not absolute
  */
-export function jsonStringify(obj: any, replacer?: ((key: any, value: any) => any) | null, space?: number | string | undefined): string;
+export declare function isSubPath(originalPath: string, root: string, forcePosix?: boolean | null): boolean;
 /**
- * @typedef PluralizeOptions
- * @property {boolean} [inclusive=false] - Whether to prefix with the number (e.g., 3 ducks)
+ * Checks whether the given paths refer to the same file system entity (same inode).
+ * All paths must exist.
+ *
+ * @param path1 - First path
+ * @param path2 - Second path
+ * @param pathN - Additional paths to compare
+ * @returns `true` if all paths resolve to the same file/directory
  */
+export declare function isSameDestination(path1: string, path2: string, ...pathN: string[]): Promise<boolean>;
 /**
- * Get the form of a word appropriate to the count
+ * Coerces a value to a valid semver string (e.g. "1.0" → "1.0.0").
  *
- * @param {string} word - The word to pluralize
- * @param {number} count - How many of the word exist
- * @param {PluralizeOptions|boolean} options - options for word pluralization,
- *   or a boolean indicating the options.inclusive property
- * @returns {string} The word pluralized according to the number
+ * @param ver - Version string or number to coerce
+ * @param strict - If true, throws when coercion fails; if false, returns null
+ * @returns Valid semver string, or null when strict is false and coercion fails
+ * @throws {Error} When strict is true and ver cannot be coerced
  */
-export function pluralize(word: string, count: number, options?: PluralizeOptions | boolean): string;
-export const GiB: number;
-export const MiB: number;
-export const KiB: 1024;
+export declare function coerceVersion(ver: string, strict: true): string;
+export declare function coerceVersion(ver: string, strict?: false): string | null;
 /**
- * @typedef EncodingOptions
- * @property {number} [maxSize=1073741824] The maximum size of
- * the resulting buffer in bytes. This is set to 1GB by default, because
- * Appium limits the maximum HTTP body size to 1GB. Also, the NodeJS heap
- * size must be enough to keep the resulting object (usually this size is
- * limited to 1.4 GB)
+ * Compares two version strings using the given operator.
+ *
+ * @param ver1 - First version string
+ * @param operator - One of: ==, !=, >, <, >=, <=, =
+ * @param ver2 - Second version string
+ * @returns `true` if ver1 operator ver2 holds (e.g. "2.0.0" >= "1.0.0")
+ * @throws {Error} If operator is unsupported or either version cannot be coerced
  */
+export declare function compareVersions(ver1: string, operator: string, ver2: string): boolean;
 /**
- * Converts contents of a local file to an in-memory base-64 encoded buffer.
- * The operation is memory-usage friendly and should be used while encoding
- * large files to base64
+ * Quotes and escapes command-line arguments so they can be safely passed to a shell.
  *
- * @param {string} srcPath The full path to the file being encoded
- * @param {EncodingOptions} opts
- * @returns {Promise<Buffer>} base64-encoded content of the source file as memory buffer
- * @throws {Error} if there was an error while reading the source file
- * or the source file is too
+ * @param args - Single argument or array of arguments to quote
+ * @returns Quoted string suitable for shell parsing
  */
-export function toInMemoryBase64(srcPath: string, opts?: EncodingOptions): Promise<Buffer>;
-import { v1 as uuidV1 } from 'uuid';
-import { v3 as uuidV3 } from 'uuid';
-import { v4 as uuidV4 } from 'uuid';
-import { v5 as uuidV5 } from 'uuid';
-import { parse as shellParse } from 'shell-quote';
+export declare function quote(args: string | string[]): string;
+/** Options for pluralize(). */
+export interface PluralizeOptions {
+    /** If true, prefix the result with the count (e.g. "3 ducks"). */
+    inclusive?: boolean;
+}
 /**
- * @typedef LockFileOptions
- * @property {number} [timeout=120] The max time in seconds to wait for the lock
- * @property {boolean} [tryRecovery=false] Whether to try lock recovery if
- * the first attempt to acquire it timed out.
- */
+ * Returns the plural or singular form of a word appropriate to the count (e.g. "duck" + 1 → "duck", + 2 → "ducks").
+ *
+ * @param word - The word to pluralize (or singularize when count is 1)
+ * @param count - The count used to choose singular vs plural
+ * @param options - Options object or boolean: use `inclusive: true` (or `true`) to prefix with the number (e.g. "3 ducks")
+ * @returns The correctly inflected word, optionally prefixed with the count
+ */
+export declare function pluralize(word: string, count: number, options?: PluralizeOptions | boolean): string;
+/** Options for toInMemoryBase64(). */
+export interface EncodingOptions {
+    /** Maximum size of the resulting buffer in bytes. Default 1GB. */
+    maxSize?: number;
+}
+/**
+ * Reads a file and returns its contents as a base64-encoded buffer.
+ *
+ * @param srcPath - Full path to the file to encode
+ * @param opts - Encoding options (e.g. maxSize to cap buffer size)
+ * @returns Buffer containing the base64-encoded file content
+ * @throws {Error} If the file does not exist, is a directory, cannot be read, or exceeds maxSize
+ */
+export declare function toInMemoryBase64(srcPath: string, opts?: EncodingOptions): Promise<Buffer>;
+/** Options for getLockFileGuard(). */
+export interface LockFileOptions {
+    /** Max time in seconds to wait for the lock. Default 120. */
+    timeout?: number;
+    /** If true, attempt to unlock and retry once if the first acquisition times out (e.g. stale lock). */
+    tryRecovery?: boolean;
+}
+/** Guard function that runs the given behavior under the lock. */
+type LockFileGuardFn<T> = (behavior: () => Promise<T> | T) => Promise<T>;
+/** Return type of getLockFileGuard: guard function with a .check() method. */
+type LockFileGuard<T> = LockFileGuardFn<T> & {
+    check: () => Promise<boolean>;
+};
 /**
- * Create an async function which, when called, will not proceed until a certain file is no
- * longer present on the system. This allows for preventing concurrent behavior across processes
- * using a known lockfile path.
+ * Creates a guard that serializes access to a critical section using a lock file.
+ * The returned function acquires the lock, runs the given behavior, then releases the lock.
+ * Also exposes `.check()` to test whether the lock is currently held.
  *
- * @template T
- * @param {string} lockFile The full path to the file used for the lock
- * @param {LockFileOptions} opts
- * @returns async function that takes another async function defining the locked
- * behavior
+ * @param lockFile - Full path to the lock file
+ * @param opts - Options (see {@link LockFileOptions})
+ * @returns Async function that accepts a callback to run under the lock, plus a `.check()` method
  */
-export function getLockFileGuard<T>(lockFile: string, opts?: LockFileOptions): {
-    (behavior: (...args: any[]) => T): Promise<T>;
-    check(): Promise<boolean>;
-};
-import B from 'bluebird';
-export { uuidV1, uuidV3, uuidV4, uuidV5, shellParse };
+export declare function getLockFileGuard<T>(lockFile: string, opts?: LockFileOptions): LockFileGuard<T>;
 //# sourceMappingURL=util.d.ts.map

package/build/lib/util.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../lib/util.js"],"names":[],"mappings":"AA4BA;;;;GAIG;AACH,2BAJsB,CAAC,SAAV,MAAQ,OACV,CAAC,GACC,GAAG,IAAI,cAAc,CAAC,CAAC,CAAC,CAIpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAkiBqB,CAAC,SAAV,MAAQ,IACR,CAAC,SAAS,EAAE,GAAG,KAAK,GAAG,CAAC;AAjiBrC;;;;;;;GAOG;AACH,yBAJa,CAAC,OACH,CAAC,GACC,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,CAQjC;AAED;;;;GAIG;AACH,iCAHW,MAAM,GACJ,MAAM,CAIlB;AAED;;;;;GAKG;AACH,wCAJW,MAAM,GAAC,GAAG,eACV,MAAM,GACJ,MAAM,GAAC,GAAG,CAyBtB;AAED;;;GAGG;AACH,2BAFa,MAAM,GAAC,SAAS,CAY5B;AAMD,kDAoBC;AAED,8DAEC;AAED;;;;;GAKG;AACH,mCAHW,GAAG,GACD,GAAG,CASf;AAoDD;;;;GAIG;AACH,uCAHW,MAAM,GACJ,OAAO,eAAe,EAAE,OAAO,CAO3C;AA1BD;;;;;;GAMG;AACH,kCAHW,OAAO,eAAe,EAAE,OAAO,GAAC,MAAM,GACpC,MAAM,CASlB;AAsBD,4DAgBC;AAED;;;;;;;;GAQG;AACH,4CANW,MAAM,GAAC,MAAM,GACX,MAAM,CAkBlB;AAED;;;;;;;;;GASG;AACH,wCANW,MAAM,QACN,MAAM,eACL,OAAO,OAAA,GACN,OAAO,CAanB;AAvQD,yCAAmC,qCAAqC,CAAC;AAyQzE;;;;;;;;GAQG;AACH,yCALW,MAAM,SACN,MAAM,YACH,MAAM,EAAA,GACP,OAAO,CAAC,OAAO,CAAC,CAoB5B;AA2BD;;;;;;;;;;;;GAYG;AACH,sCAVW,MAAM,YAIN,MAAM,QAFN,MAAM,GAIJ,OAAO,CAenB;AAjDD;;;;;;;;;;GAUG;AACH,8BARwB,MAAM,SAAjB,OAAS,cACX,MAAM,WACN,MAAM,GAEJ,MAAM,SAAS,IAAI,GAAG,MAAM,GAAG,MAAM,GAAC,IAAI,CActD;AA8BD;;;;;;GAMG;AACH,4BAHW,MAAM,GAAC,MAAM,EAAE,GACb,MAAM,CAIlB;AA/ND;;;;;;;;;;;GAWG;AACH,mCAPW,GAAG,aACH,CAAC,CAAC,GAAG,EAAC,GAAG,EAAE,KAAK,EAAC,GAAG,KAAK,GAAG,CAAC,OAAC,UAE9B,MAAM,GAAC,MAAM,GAAC,SAAS,GAErB,MAAM,CAsBlB;AAiMD;;;GAGG;AAEH;;;;;;;;GAQG;AACH,gCANW,MAAM,SACN,MAAM,YACN,gBAAgB,GAAC,OAAO,GAEtB,MAAM,CAYlB;AAzXD,yBAAuB;AADvB,yBAAuB;AADvB,kBAAY,IAAI,CAAC;AA6XjB;;;;;;;GAOG;AAEH;;;;;;;;;;GAUG;AACH,0CANW,MAAM,SACN,eAAe,GACb,OAAO,CAAC,MAAM,CAAC,CAmD3B;6BApcM,MAAM;6BAAN,MAAM;6BAAN,MAAM;6BAAN,MAAM;oCAVN,aAAa;AAgdpB;;;;;GAKG;AAEH;;;;;;;;;;GAUG;AACH,iCANa,CAAC,YACH,MAAM,SACN,eAAe;eAcb,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,GACnB,OAAO,CAAC,CAAC,CAAC;;EAyCxB;cAhiBa,UAAU"}
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../lib/util.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,UAAU,CAAC;AASzB,OAAO,EAAsB,KAAK,IAAI,UAAU,EAAC,MAAM,aAAa,CAAC;AACrE,OAAO,EAAC,UAAU,EAAC,CAAC;AAGpB,OAAO,EAAC,EAAE,IAAI,MAAM,EAAE,EAAE,IAAI,MAAM,EAAE,EAAE,IAAI,MAAM,EAAE,EAAE,IAAI,MAAM,EAAC,MAAM,MAAM,CAAC;AAE5E,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,eAAe,CAAC;AAE3C,oEAAoE;AACpE,eAAO,MAAM,0BAA0B,wCAAwC,CAAC;AAEhF,4CAA4C;AAC5C,eAAO,MAAM,GAAG,OAAO,CAAC;AACxB,mDAAmD;AACnD,eAAO,MAAM,GAAG,QAAa,CAAC;AAC9B,0DAA0D;AAC1D,eAAO,MAAM,GAAG,QAAa,CAAC;AAE9B,oCAAoC;AACpC,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,GAAG,KAAK,GAAG,CAAC,CAAC;AAEjF;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,cAAc,CAE9D;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,CAKzD;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE/C;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAChC,GAAG,EAAE,MAAM,GAAG,OAAO,EACrB,WAAW,CAAC,EAAE,MAAM,GAAG,KAAK,GAC3B,MAAM,GAAG,OAAO,CAoBlB;AAED;;;;GAIG;AACH,wBAAgB,OAAO,IAAI,MAAM,GAAG,SAAS,CAa5C;AAED;;;;;GAKG;AAEH,wBAAgB,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG;IAAC,MAAM,EAAE,MAAM,IAAI,CAAA;CAAC,CAgB3E;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAEzE;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,GAAG,CAAC,CAMhD;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAC3B,GAAG,EAAE,OAAO,EACZ,QAAQ,GAAE,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC,GAAG,IAAW,EAClE,KAAK,GAAE,MAAM,GAAG,MAAU,GACzB,MAAM,CAiBR;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,EAAE,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAQ1D;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAKtD;AAED;;;;;;;;;GASG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC5D,GAAG,EAAE,CAAC,EACN,SAAS,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,KAAK,OAAO,CAAC,GAAG,OAAO,GAC1D,OAAO,CAAC,CAAC,CAAC,CAiBZ;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAanE;AAED;;;;;;;;GAQG;AACH,wBAAgB,SAAS,CACvB,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,MAAM,EACZ,UAAU,GAAE,OAAO,GAAG,IAAW,GAChC,OAAO,CAUT;AAED;;;;;;;;GAQG;AACH,wBAAsB,iBAAiB,CACrC,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,GAAG,KAAK,EAAE,MAAM,EAAE,GACjB,OAAO,CAAC,OAAO,CAAC,CAalB;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,GAAG,MAAM,CAAC;AACjE,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;AAc1E;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,MAAM,GACX,OAAO,CAaT;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,CAErD;AAED,+BAA+B;AAC/B,MAAM,WAAW,gBAAgB;IAC/B,kEAAkE;IAClE,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;;;;;;GAOG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EACb,OAAO,GAAE,gBAAgB,GAAG,OAAY,GACvC,MAAM,CAQR;AAED,sCAAsC;AACtC,MAAM,WAAW,eAAe;IAC9B,kEAAkE;IAClE,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;GAOG;AACH,wBAAsB,gBAAgB,CACpC,OAAO,EAAE,MAAM,EACf,IAAI,GAAE,eAAoB,GACzB,OAAO,CAAC,MAAM,CAAC,CAgDjB;AAED,sCAAsC;AACtC,MAAM,WAAW,eAAe;IAC9B,6DAA6D;IAC7D,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,sGAAsG;IACtG,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,kEAAkE;AAClE,KAAK,eAAe,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;AAEzE,8EAA8E;AAC9E,KAAK,aAAa,CAAC,CAAC,IAAI,eAAe,CAAC,CAAC,CAAC,GAAG;IAAC,KAAK,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAA;CAAC,CAAC;AAE7E;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAChC,QAAQ,EAAE,MAAM,EAChB,IAAI,GAAE,eAAoB,GACzB,aAAa,CAAC,CAAC,CAAC,CA6ClB"}