@appium/support 7.0.5 → 7.0.6

package/build/lib/env.d.ts

@@ -1,35 +1,32 @@
-/**
- * Resolves `true` if an `appium` dependency can be found somewhere in the given `cwd`.
- *
- * @param {string} cwd
- * @returns {Promise<boolean>}
- */
-export function hasAppiumDependency(cwd: string): Promise<boolean>;
+import _ from 'lodash';
+import { type NormalizedPackageJson } from 'read-pkg';
+import * as semver from 'semver';
 /**
  * Path to the default `APPIUM_HOME` dir (`~/.appium`).
- * @type {string}
  */
-export const DEFAULT_APPIUM_HOME: string;
+export declare const DEFAULT_APPIUM_HOME: string;
 /**
  * Basename of extension manifest file.
- * @type {string}
  */
-export const MANIFEST_BASENAME: string;
+export declare const MANIFEST_BASENAME = "extensions.yaml";
 /**
  * Relative path to extension manifest file from `APPIUM_HOME`.
- * @type {string}
  */
-export const MANIFEST_RELATIVE_PATH: string;
+export declare const MANIFEST_RELATIVE_PATH: string;
+/**
+ * Resolves `true` if an `appium` dependency can be found somewhere in the given `cwd`.
+ */
+export declare function hasAppiumDependency(cwd: string): Promise<boolean>;
 /**
  * Given `cwd`, use `npm` to find the closest package _or workspace root_, and return the path if the root depends upon `appium`.
  *
  * Looks at `dependencies` and `devDependencies` for `appium`.
  */
-export const findAppiumDependencyPackage: ((cwd?: string, acceptableVersionRange?: string | semver.Range) => Promise<string | undefined>) & _.MemoizedFunction;
+export declare const findAppiumDependencyPackage: ((cwd?: string, acceptableVersionRange?: string | semver.Range) => Promise<string | undefined>) & _.MemoizedFunction;
 /**
  * Read a `package.json` in dir `cwd`.  If none found, return `undefined`.
  */
-export const readPackageInDir: ((cwd: string) => Promise<import("read-pkg").NormalizedPackageJson | undefined>) & _.MemoizedFunction;
+export declare const readPackageInDir: ((cwd: string) => Promise<NormalizedPackageJson>) & _.MemoizedFunction;
 /**
  * Determines location of Appium's "home" dir
  *
@@ -38,15 +35,12 @@ export const readPackageInDir: ((cwd: string) => Promise<import("read-pkg").Norm
  *
  * All returned paths will be absolute.
  */
-export const resolveAppiumHome: ((cwd?: string) => Promise<string>) & _.MemoizedFunction;
+export declare const resolveAppiumHome: ((cwd?: string) => Promise<string>) & _.MemoizedFunction;
 /**
  * Figure out manifest path based on `appiumHome`.
  *
  * The assumption is that, if `appiumHome` has been provided, it was resolved via {@link resolveAppiumHome `resolveAppiumHome()`}!  If unsure,
  * don't pass a parameter and let `resolveAppiumHome()` handle it.
  */
-export const resolveManifestPath: ((appiumHome?: string) => Promise<string>) & _.MemoizedFunction;
-export type NormalizedPackageJson = import("read-pkg").NormalizedPackageJson;
-import * as semver from 'semver';
-import _ from 'lodash';
+export declare const resolveManifestPath: ((appiumHome?: string) => Promise<string>) & _.MemoizedFunction;
 //# sourceMappingURL=env.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"env.d.ts","sourceRoot":"","sources":["../../lib/env.js"],"names":[],"mappings":"AA8BA;;;;;GAKG;AACH,yCAHW,MAAM,GACJ,OAAO,CAAC,OAAO,CAAC,CAI5B;AA/BD;;;GAGG;AACH,kCAFU,MAAM,CAEsD;AAEtE;;;GAGG;AACH,gCAFU,MAAM,CAEmC;AAEnD;;;GAGG;AACH,qCAFU,MAAM,CAOd;AAYF;;;;GAIG;AACH,kDAEa,MAAM,2BACN,MAAM,GAAC,MAAM,CAAC,KAAK,KAGjB,OAAO,CAAC,MAAM,GAAC,SAAS,CAAC,uBAmCtC;AAEF;;GAEG;AACH,sCAGa,MAAM,KACJ,OAAO,CAAC,OAAO,UAAU,EAAE,qBAAqB,GAAC,SAAS,CAAC,uBAKxE;AAEF;;;;;;;GAOG;AACH,wCAEa,MAAM,KACJ,OAAO,CAAC,MAAM,CAAC,uBAa5B;AAEF;;;;;GAKG;AACH,iDAEa,MAAM,KACJ,OAAO,CAAC,MAAM,CAAC,uBAO5B;oCAGW,OAAO,UAAU,EAAE,qBAAqB;wBA9I7B,QAAQ;cAJlB,QAAQ"}
+{"version":3,"file":"env.d.ts","sourceRoot":"","sources":["../../lib/env.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,QAAQ,CAAC;AAGvB,OAAO,EAAc,KAAK,qBAAqB,EAAC,MAAM,UAAU,CAAC;AACjE,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAC;AAEjC;;GAEG;AACH,eAAO,MAAM,mBAAmB,EAAE,MAA2C,CAAC;AAE9E;;GAEG;AACH,eAAO,MAAM,iBAAiB,oBAAoB,CAAC;AAEnD;;GAEG;AACH,eAAO,MAAM,sBAAsB,QAKlC,CAAC;AAEF;;GAEG;AACH,wBAAsB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAEvE;AAED;;;;GAIG;AACH,eAAO,MAAM,2BAA2B,UAE/B,MAAM,2BACa,MAAM,GAAG,MAAM,CAAC,KAAK,KAC5C,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,sBA+B/B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,gBAAgB,SACW,MAAM,KAAG,OAAO,CAAC,qBAAqB,CAAC,sBAG9E,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,UACW,MAAM,KAAmB,OAAO,CAAC,MAAM,CAAC,sBAWhF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,iBAEf,MAAM,KAClB,OAAO,CAAC,MAAM,CAAC,sBAKnB,CAAC"}

package/build/lib/env.js

@@ -38,7 +38,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolveManifestPath = exports.resolveAppiumHome = exports.readPackageInDir = exports.findAppiumDependencyPackage = exports.MANIFEST_RELATIVE_PATH = exports.MANIFEST_BASENAME = exports.DEFAULT_APPIUM_HOME = void 0;
 exports.hasAppiumDependency = hasAppiumDependency;
-// @ts-check
 const lodash_1 = __importDefault(require("lodash"));
 const node_os_1 = require("node:os");
 const node_path_1 = __importDefault(require("node:path"));
@@ -46,24 +45,18 @@ const read_pkg_1 = require("read-pkg");
 const semver = __importStar(require("semver"));
 /**
  * Path to the default `APPIUM_HOME` dir (`~/.appium`).
- * @type {string}
  */
 exports.DEFAULT_APPIUM_HOME = node_path_1.default.resolve((0, node_os_1.homedir)(), '.appium');
 /**
  * Basename of extension manifest file.
- * @type {string}
  */
 exports.MANIFEST_BASENAME = 'extensions.yaml';
 /**
  * Relative path to extension manifest file from `APPIUM_HOME`.
- * @type {string}
  */
 exports.MANIFEST_RELATIVE_PATH = node_path_1.default.join('node_modules', '.cache', 'appium', exports.MANIFEST_BASENAME);
 /**
  * Resolves `true` if an `appium` dependency can be found somewhere in the given `cwd`.
- *
- * @param {string} cwd
- * @returns {Promise<boolean>}
  */
 async function hasAppiumDependency(cwd) {
     return Boolean(await (0, exports.findAppiumDependencyPackage)(cwd));
@@ -73,30 +66,20 @@ async function hasAppiumDependency(cwd) {
  *
  * Looks at `dependencies` and `devDependencies` for `appium`.
  */
-exports.findAppiumDependencyPackage = lodash_1.default.memoize(
-/**
- * @param {string} [cwd]
- * @param {string|semver.Range} [acceptableVersionRange='>=2.0.0-beta'] The expected
- * semver-compatible range for the Appium dependency. Packages that have 'appium' dependency
- * not satisfying this range will be skipped.
- * @returns {Promise<string|undefined>}
- */
-async function findAppiumDependencyPackage(cwd = process.cwd(), acceptableVersionRange = '>=2.0.0-beta') {
-    /**
-     * Tries to read `package.json` in `root` and resolves the identity if it depends on `appium`;
-     * otherwise resolves `undefined`.
-     * @param {string} root
-     * @returns {Promise<string|undefined>}
-     */
+exports.findAppiumDependencyPackage = lodash_1.default.memoize(async function findAppiumDependencyPackage(cwd = process.cwd(), acceptableVersionRange = '>=2.0.0-beta') {
     const readPkg = async (root) => {
         try {
             const pkg = await (0, exports.readPackageInDir)(root);
             const version = semver.minVersion(String(pkg?.dependencies?.appium ??
                 pkg?.devDependencies?.appium ??
                 pkg?.peerDependencies?.appium));
-            return version && semver.satisfies(version, acceptableVersionRange) ? root : undefined;
+            return version && semver.satisfies(version, acceptableVersionRange)
+                ? root
+                : undefined;
+        }
+        catch {
+            return undefined;
         }
-        catch { }
     };
     let currentDir = node_path_1.default.resolve(cwd);
     let isAtFsRoot = false;
@@ -108,17 +91,12 @@ async function findAppiumDependencyPackage(cwd = process.cwd(), acceptableVersio
         currentDir = node_path_1.default.dirname(currentDir);
         isAtFsRoot = currentDir.length <= node_path_1.default.dirname(currentDir).length;
     }
+    return undefined;
 });
 /**
  * Read a `package.json` in dir `cwd`.  If none found, return `undefined`.
  */
-exports.readPackageInDir = lodash_1.default.memoize(
-/**
- *
- * @param {string} cwd - Directory ostensibly having a `package.json`
- * @returns {Promise<import('read-pkg').NormalizedPackageJson|undefined>}
- */
-async function _readPackageInDir(cwd) {
+exports.readPackageInDir = lodash_1.default.memoize(async function _readPackageInDir(cwd) {
     return await (0, read_pkg_1.readPackage)({ cwd, normalize: true });
 });
 /**
@@ -129,19 +107,14 @@ async function _readPackageInDir(cwd) {
  *
  * All returned paths will be absolute.
  */
-exports.resolveAppiumHome = lodash_1.default.memoize(
-/**
- * @param {string} [cwd] - Current working directory.  _Must_ be absolute, if specified.
- * @returns {Promise<string>}
- */
-async function _resolveAppiumHome(cwd = process.cwd()) {
+exports.resolveAppiumHome = lodash_1.default.memoize(async function _resolveAppiumHome(cwd = process.cwd()) {
     if (!node_path_1.default.isAbsolute(cwd)) {
         throw new TypeError('`cwd` parameter must be an absolute path');
     }
     if (process.env.APPIUM_HOME) {
         return node_path_1.default.resolve(cwd, process.env.APPIUM_HOME);
     }
-    return await (0, exports.findAppiumDependencyPackage)(cwd) ?? exports.DEFAULT_APPIUM_HOME;
+    return (await (0, exports.findAppiumDependencyPackage)(cwd)) ?? exports.DEFAULT_APPIUM_HOME;
 });
 /**
  * Figure out manifest path based on `appiumHome`.
@@ -149,17 +122,7 @@ async function _resolveAppiumHome(cwd = process.cwd()) {
  * The assumption is that, if `appiumHome` has been provided, it was resolved via {@link resolveAppiumHome `resolveAppiumHome()`}!  If unsure,
  * don't pass a parameter and let `resolveAppiumHome()` handle it.
  */
-exports.resolveManifestPath = lodash_1.default.memoize(
-/**
- * @param {string} [appiumHome] - Appium home directory
- * @returns {Promise<string>}
- */
-async function _resolveManifestPath(appiumHome) {
-    // can you "await" in a default parameter? is that a good idea?
-    appiumHome = appiumHome ?? (await (0, exports.resolveAppiumHome)());
-    return node_path_1.default.join(appiumHome, exports.MANIFEST_RELATIVE_PATH);
+exports.resolveManifestPath = lodash_1.default.memoize(async function _resolveManifestPath(appiumHome) {
+    return node_path_1.default.join(appiumHome ?? await (0, exports.resolveAppiumHome)(), exports.MANIFEST_RELATIVE_PATH);
 });
-/**
- * @typedef {import('read-pkg').NormalizedPackageJson} NormalizedPackageJson
- */
 //# sourceMappingURL=env.js.map

package/build/lib/env.js.map

@@ -1 +1 @@
-{"version":3,"file":"env.js","sourceRoot":"","sources":["../../lib/env.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoCA,kDAEC;AAtCD,YAAY;AACZ,oDAAuB;AACvB,qCAAgC;AAChC,0DAA6B;AAC7B,uCAAqC;AACrC,+CAAiC;AAEjC;;;GAGG;AACU,QAAA,mBAAmB,GAAG,mBAAI,CAAC,OAAO,CAAC,IAAA,iBAAO,GAAE,EAAE,SAAS,CAAC,CAAC;AAEtE;;;GAGG;AACU,QAAA,iBAAiB,GAAG,iBAAiB,CAAC;AAEnD;;;GAGG;AACU,QAAA,sBAAsB,GAAG,mBAAI,CAAC,IAAI,CAC7C,cAAc,EACd,QAAQ,EACR,QAAQ,EACR,yBAAiB,CAClB,CAAC;AAEF;;;;;GAKG;AACI,KAAK,UAAU,mBAAmB,CAAC,GAAG;IAC3C,OAAO,OAAO,CAAC,MAAM,IAAA,mCAA2B,EAAC,GAAG,CAAC,CAAC,CAAC;AACzD,CAAC;AAED;;;;GAIG;AACU,QAAA,2BAA2B,GAAG,gBAAC,CAAC,OAAO;AAClD;;;;;;GAMG;AACH,KAAK,UAAU,2BAA2B,CACxC,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EACnB,sBAAsB,GAAG,cAAc;IAEvC;;;;;OAKG;IACH,MAAM,OAAO,GAAG,KAAK,EAAE,IAAI,EAAE,EAAE;QAC7B,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,MAAM,IAAA,wBAAgB,EAAC,IAAI,CAAC,CAAC;YACzC,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,MAAM,CACtC,GAAG,EAAE,YAAY,EAAE,MAAM;gBACzB,GAAG,EAAE,eAAe,EAAE,MAAM;gBAC5B,GAAG,EAAE,gBAAgB,EAAE,MAAM,CAC9B,CAAC,CAAC;YACH,OAAO,OAAO,IAAI,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;QACzF,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;IACZ,CAAC,CAAC;IAEF,IAAI,UAAU,GAAG,mBAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACnC,IAAI,UAAU,GAAG,KAAK,CAAC;IACvB,OAAO,CAAC,UAAU,EAAE,CAAC;QACnB,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,CAAC;QACzC,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,UAAU,GAAG,mBAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACtC,UAAU,GAAG,UAAU,CAAC,MAAM,IAAI,mBAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC;IACpE,CAAC;AACH,CAAC,CACF,CAAC;AAEF;;GAEG;AACU,QAAA,gBAAgB,GAAG,gBAAC,CAAC,OAAO;AACvC;;;;GAIG;AACH,KAAK,UAAU,iBAAiB,CAAC,GAAG;IAClC,OAAO,MAAM,IAAA,sBAAW,EAAC,EAAC,GAAG,EAAE,SAAS,EAAE,IAAI,EAAC,CAAC,CAAC;AACnD,CAAC,CACF,CAAC;AAEF;;;;;;;GAOG;AACU,QAAA,iBAAiB,GAAG,gBAAC,CAAC,OAAO;AACxC;;;GAGG;AACH,KAAK,UAAU,kBAAkB,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE;IACnD,IAAI,CAAC,mBAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,SAAS,CAAC,0CAA0C,CAAC,CAAC;IAClE,CAAC;IAED,IAAI,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC;QAC5B,OAAO,mBAAI,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IACpD,CAAC;IAED,OAAO,MAAM,IAAA,mCAA2B,EAAC,GAAG,CAAC,IAAI,2BAAmB,CAAC;AACvE,CAAC,CACF,CAAC;AAEF;;;;;GAKG;AACU,QAAA,mBAAmB,GAAG,gBAAC,CAAC,OAAO;AAC1C;;;GAGG;AACH,KAAK,UAAU,oBAAoB,CAAC,UAAU;IAC5C,+DAA+D;IAC/D,UAAU,GAAG,UAAU,IAAI,CAAC,MAAM,IAAA,yBAAiB,GAAE,CAAC,CAAC;IACvD,OAAO,mBAAI,CAAC,IAAI,CAAC,UAAU,EAAE,8BAAsB,CAAC,CAAC;AACvD,CAAC,CACF,CAAC;AAEF;;GAEG"}
+{"version":3,"file":"env.js","sourceRoot":"","sources":["../../lib/env.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6BA,kDAEC;AA/BD,oDAAuB;AACvB,qCAAgC;AAChC,0DAA6B;AAC7B,uCAAiE;AACjE,+CAAiC;AAEjC;;GAEG;AACU,QAAA,mBAAmB,GAAW,mBAAI,CAAC,OAAO,CAAC,IAAA,iBAAO,GAAE,EAAE,SAAS,CAAC,CAAC;AAE9E;;GAEG;AACU,QAAA,iBAAiB,GAAG,iBAAiB,CAAC;AAEnD;;GAEG;AACU,QAAA,sBAAsB,GAAG,mBAAI,CAAC,IAAI,CAC7C,cAAc,EACd,QAAQ,EACR,QAAQ,EACR,yBAAiB,CAClB,CAAC;AAEF;;GAEG;AACI,KAAK,UAAU,mBAAmB,CAAC,GAAW;IACnD,OAAO,OAAO,CAAC,MAAM,IAAA,mCAA2B,EAAC,GAAG,CAAC,CAAC,CAAC;AACzD,CAAC;AAED;;;;GAIG;AACU,QAAA,2BAA2B,GAAG,gBAAC,CAAC,OAAO,CAClD,KAAK,UAAU,2BAA2B,CACxC,MAAc,OAAO,CAAC,GAAG,EAAE,EAC3B,yBAAgD,cAAc;IAE9D,MAAM,OAAO,GAAG,KAAK,EAAE,IAAY,EAA+B,EAAE;QAClE,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,MAAM,IAAA,wBAAgB,EAAC,IAAI,CAAC,CAAC;YACzC,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,CAC/B,MAAM,CACJ,GAAG,EAAE,YAAY,EAAE,MAAM;gBACvB,GAAG,EAAE,eAAe,EAAE,MAAM;gBAC5B,GAAG,EAAE,gBAAgB,EAAE,MAAM,CAChC,CACF,CAAC;YACF,OAAO,OAAO,IAAI,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,sBAAsB,CAAC;gBACjE,CAAC,CAAC,IAAI;gBACN,CAAC,CAAC,SAAS,CAAC;QAChB,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC,CAAC;IAEF,IAAI,UAAU,GAAG,mBAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACnC,IAAI,UAAU,GAAG,KAAK,CAAC;IACvB,OAAO,CAAC,UAAU,EAAE,CAAC;QACnB,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,CAAC;QACzC,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,UAAU,GAAG,mBAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACtC,UAAU,GAAG,UAAU,CAAC,MAAM,IAAI,mBAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC;IACpE,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CACF,CAAC;AAEF;;GAEG;AACU,QAAA,gBAAgB,GAAG,gBAAC,CAAC,OAAO,CACvC,KAAK,UAAU,iBAAiB,CAAC,GAAW;IAC1C,OAAO,MAAM,IAAA,sBAAW,EAAC,EAAC,GAAG,EAAE,SAAS,EAAE,IAAI,EAAC,CAAC,CAAC;AACnD,CAAC,CACF,CAAC;AAEF;;;;;;;GAOG;AACU,QAAA,iBAAiB,GAAG,gBAAC,CAAC,OAAO,CACxC,KAAK,UAAU,kBAAkB,CAAC,MAAc,OAAO,CAAC,GAAG,EAAE;IAC3D,IAAI,CAAC,mBAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,SAAS,CAAC,0CAA0C,CAAC,CAAC;IAClE,CAAC;IAED,IAAI,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC;QAC5B,OAAO,mBAAI,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IACpD,CAAC;IAED,OAAO,CAAC,MAAM,IAAA,mCAA2B,EAAC,GAAG,CAAC,CAAC,IAAI,2BAAmB,CAAC;AACzE,CAAC,CACF,CAAC;AAEF;;;;;GAKG;AACU,QAAA,mBAAmB,GAAG,gBAAC,CAAC,OAAO,CAC1C,KAAK,UAAU,oBAAoB,CACjC,UAAmB;IAEnB,OAAO,mBAAI,CAAC,IAAI,CACd,UAAU,IAAI,MAAM,IAAA,yBAAiB,GAAE,EAAE,8BAAsB,CAChE,CAAC;AACJ,CAAC,CACF,CAAC"}

package/build/lib/fs.d.ts

@@ -1,187 +1,148 @@
-export default fs;
+import B from 'bluebird';
+import { close, constants, createReadStream, createWriteStream, promises as fsPromises, read, open, type PathLike, type MakeDirectoryOptions, type ReadAsyncOptions } from 'node:fs';
+import type { GlobOptions } from 'glob';
+import klaw from 'klaw';
+import type { Walker } from 'klaw';
+import ncp from 'ncp';
+import { type NormalizeOptions, type NormalizedPackageJson } from 'read-pkg';
+import sanitize from 'sanitize-filename';
+import which from 'which';
+/** Options for {@linkcode fs.mv} */
+export interface MvOptions {
+    /** Whether to automatically create the destination folder structure */
+    mkdirp?: boolean;
+    /** Set to false to throw if the destination file already exists */
+    clobber?: boolean;
+    /** @deprecated Legacy, not used */
+    limit?: number;
+}
 /**
- * The callback function which will be called during the directory walking
+ * Callback used during directory walking in {@linkcode fs.walkDir}.
+ * Return true to stop walking.
  */
-export type WalkDirCallback = (itemPath: string, isDirectory: boolean) => boolean | void;
-export type glob = typeof import("glob");
-export type PathLike = import("fs").PathLike;
-export type mv = {
-    /**
-     * Whether to automatically create the destination folder structure
-     */
-    mkdirp?: boolean | undefined;
-    /**
-     * Set it to false if you want an exception to be thrown
-     * if the destination file already exists
-     */
-    clobber?: boolean | undefined;
-    /**
-     * Legacy deprecated property, not used anymore
-     */
-    limit?: number | undefined;
-};
-export type ReadFn<TBuffer extends NodeJS.ArrayBufferView> = (fd: number, buffer: TBuffer | import("node:fs").ReadAsyncOptions<TBuffer>, offset?: number | undefined, length?: number | undefined, position?: number | null | undefined) => B<{
+export type WalkDirCallback = (itemPath: string, isDirectory: boolean) => boolean | void | Promise<boolean | void>;
+/**
+ * Promisified fs.read signature.
+ * @template TBuffer - Buffer type (e.g. NodeJS.ArrayBufferView)
+ * @deprecated use `typeof read.__promisify__` instead
+ */
+export type ReadFn<TBuffer extends NodeJS.ArrayBufferView = NodeJS.ArrayBufferView> = (fd: number, buffer: TBuffer | ReadAsyncOptions<TBuffer>, offset?: number, length?: number, position?: number | null) => B<{
     bytesRead: number;
     buffer: TBuffer;
 }>;
-export namespace fs {
+export declare const fs: {
     /**
-     * Resolves `true` if `path` is _readable_, which differs from Node.js' default behavior of "can we see it?"
-     *
+     * Resolves `true` if `path` is _readable_.
      * On Windows, ACLs are not supported, so this becomes a simple check for existence.
-     *
      * This function will never reject.
-     * @param {PathLike} path
-     * @returns {Promise<boolean>}
      */
-    export function hasAccess(path: PathLike): Promise<boolean>;
+    hasAccess(filePath: PathLike): Promise<boolean>;
     /**
      * Resolves `true` if `path` is executable; `false` otherwise.
-     *
-     * On Windows, this function delegates to {@linkcode fs.hasAccess}.
-     *
+     * On Windows, delegates to {@linkcode fs.hasAccess}.
      * This function will never reject.
-     * @param {PathLike} path
-     * @returns {Promise<boolean>}
      */
-    export function isExecutable(path: PathLike): Promise<boolean>;
+    isExecutable(filePath: PathLike): Promise<boolean>;
+    /** Alias for {@linkcode fs.hasAccess} */
+    exists(filePath: PathLike): Promise<boolean>;
     /**
-     * Alias for {@linkcode fs.hasAccess}
-     * @param {PathLike} path
-     */
-    export function exists(path: PathLike): Promise<boolean>;
-    /**
-     * Remove a directory and all its contents, recursively
-     * @param {PathLike} filepath
-     * @returns Promise<void>
+     * Remove a directory and all its contents, recursively.
      * @see https://nodejs.org/api/fs.html#fspromisesrmpath-options
      */
-    export function rimraf(filepath: PathLike): Promise<void>;
+    rimraf(filepath: PathLike): Promise<void>;
     /**
-     * Remove a directory and all its contents, recursively in sync
-     * @param {PathLike} filepath
-     * @returns undefined
+     * Remove a directory and all its contents, recursively (sync).
      * @see https://nodejs.org/api/fs.html#fsrmsyncpath-options
      */
-    export function rimrafSync(filepath: PathLike): void;
+    rimrafSync(filepath: PathLike): void;
     /**
-     * Like Node.js' `fsPromises.mkdir()`, but will _not_ reject if the directory already exists.
-     *
-     * @param {string|Buffer|URL} filepath
-     * @param {import('fs').MakeDirectoryOptions} [opts]
-     * @returns {Promise<string|undefined>}
+     * Like Node.js `fsPromises.mkdir()`, but will not reject if the directory already exists.
      * @see https://nodejs.org/api/fs.html#fspromisesmkdirpath-options
      */
-    export function mkdir(filepath: string | Buffer | URL, opts?: import("fs").MakeDirectoryOptions): Promise<string | undefined>;
+    mkdir(filepath: string | Buffer | URL, opts?: MakeDirectoryOptions): Promise<string | undefined>;
     /**
-     * Copies files _and entire directories_
-     * @param {string} source - Source to copy
-     * @param {string} destination - Destination to copy to
-     * @param {ncp.Options} [opts] - Additional arguments to pass to `ncp`
+     * Copies files and entire directories.
      * @see https://npm.im/ncp
-     * @returns {Promise<void>}
-     */
-    export function copyFile(source: string, destination: string, opts?: ncp.Options): Promise<void>;
-    /**
-     * Create an MD5 hash of a file.
-     * @param {PathLike} filePath
-     * @returns {Promise<string>}
      */
-    export function md5(filePath: PathLike): Promise<string>;
+    copyFile(source: string, destination: string, opts?: ncp.Options): Promise<void>;
+    /** Create an MD5 hash of a file. */
+    md5(filePath: PathLike): Promise<string>;
     /**
-     * Move a file or a folder
-     *
-     * @param {string} from Source file/folder
-     * @param {string} to Destination file/folder
-     * @param {mv} [opts] Move options
-     * @returns {Promise<void>}
+     * Move a file or a folder.
      */
-    export function mv(from: string, to: string, opts?: mv): Promise<void>;
-    export { which };
-    export let glob: (pattern: string, opts?: import("glob").GlobOptions) => B<string[]>;
-    export { sanitize as sanitizeName };
+    mv(from: string, to: string, opts?: MvOptions): Promise<void>;
+    /** Find path to an executable in system `PATH`. @see https://github.com/npm/node-which */
+    which: typeof which;
     /**
-     * Create a hex digest of some file at `filePath`
-     * @param {PathLike} filePath
-     * @param {string} [algorithm]
-     * @returns {Promise<string>}
+     * Given a glob pattern, resolve with list of files matching that pattern.
+     * @see https://github.com/isaacs/node-glob
      */
-    export function hash(filePath: PathLike, algorithm?: string): Promise<string>;
+    glob(pattern: string, options?: GlobOptions): Promise<string[]>;
+    /** Sanitize a filename. @see https://github.com/parshap/node-sanitize-filename */
+    sanitizeName: typeof sanitize;
+    /** Create a hex digest of some file at `filePath`. */
+    hash(filePath: PathLike, algorithm?: string): Promise<string>;
     /**
-     * Returns an `Walker` instance, which is a readable stream (and thusly an async iterator).
-     *
-     * @param {string} dir - Dir to start walking at
-     * @param {import('klaw').Options} [opts]
-     * @returns {import('klaw').Walker}
+     * Returns a Walker instance (readable stream / async iterator).
      * @see https://www.npmjs.com/package/klaw
      */
-    export function walk(dir: string, opts?: import("klaw").Options): import("klaw").Walker;
+    walk(dir: string, opts?: klaw.Options): Walker;
+    /** Recursively create a directory. */
+    mkdirp(dir: PathLike): Promise<string | undefined>;
     /**
-     * Recursively create a directory.
-     * @param {PathLike} dir
-     * @returns {Promise<string|undefined>}
+     * Walks a directory; callback is invoked with path joined with dir.
+     * @param dir - Directory path to start walking
+     * @param recursive - If true, walk subdirectories
+     * @param callback - Called for each path; return true to stop
+     * @returns The found path or null if not found
      */
-    export function mkdirp(dir: PathLike): Promise<string | undefined>;
+    walkDir(dir: string, recursive: boolean, callback: WalkDirCallback): Promise<string | null>;
     /**
-     * Walks a directory given according to the parameters given. The callback will be invoked with a path joined with the dir parameter
-     * @param {string} dir Directory path where we will start walking
-     * @param {boolean} recursive Set it to true if you want to continue walking sub directories
-     * @param {WalkDirCallback} callback The callback to be called when a new path is found
-     * @throws {Error} If the `dir` parameter contains a path to an invalid folder
-     * @returns {Promise<string?>} returns the found path or null if the item was not found
+     * Reads the closest `package.json` from absolute path `dir`.
+     * @throws If there were problems finding or reading `package.json`
      */
-    export function walkDir(dir: string, recursive: boolean, callback: WalkDirCallback): Promise<string | null>;
-    /**
-     * Reads the closest `package.json` file from absolute path `dir`.
-     * @param {string} dir - Directory to search from
-     * @param {import('read-pkg').Options} [opts] - Additional options for `read-pkg`
-     * @throws {Error} If there were problems finding or reading a `package.json` file
-     * @returns {import('read-pkg').NormalizedPackageJson} A parsed `package.json`
-     */
-    export function readPackageJsonFrom(dir: string, opts?: import("read-pkg").Options): import("read-pkg").NormalizedPackageJson;
+    readPackageJsonFrom(dir: string, opts?: NormalizeOptions & {
+        cwd?: string;
+    }): NormalizedPackageJson;
     /**
      * Finds the project root directory from `dir`.
-     * @param {string} dir - Directory to search from
-     * @throws {TypeError} If `dir` is not a nonempty string or relative path
-     * @throws {Error} If there were problems finding the project root
-     * @returns {string} The closeset parent dir containing `package.json`
-     */
-    export function findRoot(dir: string): string;
-    export let access: typeof fsPromises.access;
-    export let appendFile: typeof fsPromises.appendFile;
-    export let chmod: typeof fsPromises.chmod;
-    export let close: (arg1: number) => B<any>;
-    export { constants };
-    export { createWriteStream };
-    export { createReadStream };
-    export let lstat: typeof fsPromises.lstat;
-    export let open: (path: PathLike, flags: import("fs").OpenMode, mode?: import("fs").Mode) => Promise<number>;
-    export let openFile: typeof fsPromises.open;
-    export let readdir: typeof fsPromises.readdir;
-    export function read(fd: number, buffer: NodeJS.ArrayBufferView<ArrayBufferLike> | import("fs").ReadAsyncOptions<NodeJS.ArrayBufferView<ArrayBufferLike>>, offset: number | undefined, length: number | undefined, position: number | null | undefined): B<{
-        bytesRead: number;
-        buffer: NodeJS.ArrayBufferView<ArrayBufferLike>;
-    }>;
-    export let readFile: typeof fsPromises.readFile;
-    export let readlink: typeof fsPromises.readlink;
-    export let realpath: typeof fsPromises.realpath;
-    export let rename: typeof fsPromises.rename;
-    export let stat: typeof fsPromises.stat;
-    export let symlink: typeof fsPromises.symlink;
-    export let unlink: typeof fsPromises.unlink;
-    export let write: (arg1: number, arg2: string) => B<number>;
-    export let writeFile: typeof fsPromises.writeFile;
-    export let F_OK: number;
-    export let R_OK: number;
-    export let W_OK: number;
-    export let X_OK: number;
-}
-import B from 'bluebird';
-import ncp from 'ncp';
-import which from 'which';
-import sanitize from 'sanitize-filename';
-import { promises as fsPromises } from 'node:fs';
-import { constants } from 'node:fs';
-import { createWriteStream } from 'node:fs';
-import { createReadStream } from 'node:fs';
+     * @throws TypeError If `dir` is not a non-empty absolute path
+     * @throws Error If project root could not be found
+     */
+    findRoot(dir: string): string;
+    access: typeof fsPromises.access;
+    appendFile: typeof fsPromises.appendFile;
+    chmod: typeof fsPromises.chmod;
+    close: typeof close.__promisify__;
+    constants: typeof constants;
+    createWriteStream: typeof createWriteStream;
+    createReadStream: typeof createReadStream;
+    lstat: typeof fsPromises.lstat;
+    /**
+     * Promisified fs.open. Resolves with a file descriptor (not FileHandle).
+     * Use fs.openFile for a FileHandle.
+     */
+    open: typeof open.__promisify__;
+    openFile: typeof fsPromises.open;
+    readdir: typeof fsPromises.readdir;
+    read: typeof read.__promisify__;
+    readFile: typeof fsPromises.readFile;
+    readlink: typeof fsPromises.readlink;
+    realpath: typeof fsPromises.realpath;
+    rename: typeof fsPromises.rename;
+    stat: typeof fsPromises.stat;
+    symlink: typeof fsPromises.symlink;
+    unlink: typeof fsPromises.unlink;
+    write: (arg1: number, arg2: string) => B<number>;
+    writeFile: typeof fsPromises.writeFile;
+    /** @deprecated Use `constants.F_OK` instead. */
+    F_OK: number;
+    /** @deprecated Use `constants.R_OK` instead. */
+    R_OK: number;
+    /** @deprecated Use `constants.W_OK` instead. */
+    W_OK: number;
+    /** @deprecated Use `constants.X_OK` instead. */
+    X_OK: number;
+};
+export default fs;
 //# sourceMappingURL=fs.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"fs.d.ts","sourceRoot":"","sources":["../../lib/fs.js"],"names":[],"mappings":";;;;yCAodW,MAAM,eACN,OAAO,KACN,OAAO,GAAC,IAAI;;uBAKX,OAAO,IAAI,EAAE,QAAQ;;;;;;;;;;;;;;;;mBAYI,OAAO,SAA/B,MAAM,CAAC,eAAgB,SAE1B,MAAM,UACN,OAAO,GAAC,OAAO,SAAS,EAAE,gBAAgB,CAAC,OAAO,CAAC,qGAIjD,CAAC,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,OAAO,CAAA;CAAC,CAAC;;IA1clD;;;;;;;;OAQG;IACH,gCAHW,QAAQ,GACN,OAAO,CAAC,OAAO,CAAC,CAS5B;IAED;;;;;;;;OAQG;IACH,mCAHW,QAAQ,GACN,OAAO,CAAC,OAAO,CAAC,CAY5B;IAED;;;OAGG;IACH,6BAFW,QAAQ,oBAIlB;IAED;;;;;OAKG;IACH,iCAJW,QAAQ,iBAMlB;IAED;;;;;OAKG;IACH,qCAJW,QAAQ,QAMlB;IAED;;;;;;;OAOG;IACH,gCALW,MAAM,GAAC,MAAM,GAAC,GAAG,SACjB,OAAO,IAAI,EAAE,oBAAoB,GAC/B,OAAO,CAAC,MAAM,GAAC,SAAS,CAAC,CAWrC;IACD;;;;;;;OAOG;IACH,iCANW,MAAM,eACN,MAAM,SACN,GAAG,CAAC,OAAO,GAET,OAAO,CAAC,IAAI,CAAC,CAOzB;IAED;;;;OAIG;IACH,8BAHW,QAAQ,GACN,OAAO,CAAC,MAAM,CAAC,CAI3B;IAED;;;;;;;OAOG;IACH,yBALW,MAAM,MACN,MAAM,SACN,EAAE,GACA,OAAO,CAAC,IAAI,CAAC,CAmEzB;;qBAYgB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,MAAM,EAAE,WAAW,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC;;IAUpF;;;;;OAKG;IACH,+BAJW,QAAQ,cACR,MAAM,GACJ,OAAO,CAAC,MAAM,CAAC,CAgB3B;IAED;;;;;;;OAOG;IACH,0BALW,MAAM,SACN,OAAO,MAAM,EAAE,OAAO,GACpB,OAAO,MAAM,EAAE,MAAM,CAKjC;IAED;;;;OAIG;IACH,4BAHW,QAAQ,GACN,OAAO,CAAC,MAAM,GAAC,SAAS,CAAC,CAIrC;IAED;;;;;;;OAOG;IAEH,6BAPW,MAAM,aACN,OAAO,YACP,eAAe,GAEb,OAAO,CAAC,MAAM,OAAC,CAAC,CA+E5B;IACD;;;;;;OAMG;IACH,yCALW,MAAM,SACN,OAAO,UAAU,EAAE,OAAO,GAExB,OAAO,UAAU,EAAE,qBAAqB,CAYpD;IACD;;;;;;OAMG;IACH,8BALW,MAAM,GAGJ,MAAM,CAWlB;;;;;;;;;qBAcS,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,OAAO,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,MAAM,CAAC;;;IAwEpG,yBACQ,MAAM;mBAKU,MAAM;;OAChC;;;;;;;;;;;;;;;cA7ea,UAAU;gBAgBR,KAAK;kBAKH,OAAO;qBADJ,mBAAmB;uCARjC,SAAS;0BAAT,SAAS;kCAAT,SAAS;iCAAT,SAAS"}
+{"version":3,"file":"fs.d.ts","sourceRoot":"","sources":["../../lib/fs.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,UAAU,CAAC;AAEzB,OAAO,EACL,KAAK,EACL,SAAS,EACT,gBAAgB,EAChB,iBAAiB,EACjB,QAAQ,IAAI,UAAU,EACtB,IAAI,EAGJ,IAAI,EACJ,KAAK,QAAQ,EACb,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EAEtB,MAAM,SAAS,CAAC;AAGjB,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,MAAM,CAAC;AACtC,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,MAAM,CAAC;AAEjC,OAAO,GAAG,MAAM,KAAK,CAAC;AAGtB,OAAO,EAAkB,KAAK,gBAAgB,EAAE,KAAK,qBAAqB,EAAC,MAAM,UAAU,CAAC;AAC5F,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AACzC,OAAO,KAAK,MAAM,OAAO,CAAC;AAgB1B,oCAAoC;AACpC,MAAM,WAAW,SAAS;IACxB,uEAAuE;IACvE,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,mEAAmE;IACnE,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,mCAAmC;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,CAC5B,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,OAAO,KACjB,OAAO,GAAG,IAAI,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;AAE9C;;;;GAIG;AACH,MAAM,MAAM,MAAM,CAAC,OAAO,SAAS,MAAM,CAAC,eAAe,GAAG,MAAM,CAAC,eAAe,IAAI,CACpF,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,OAAO,GAAG,gBAAgB,CAAC,OAAO,CAAC,EAC3C,MAAM,CAAC,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,MAAM,EACf,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,KACrB,CAAC,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,OAAO,CAAA;CAAC,CAAC,CAAC;AAM7C,eAAO,MAAM,EAAE;IACb;;;;OAIG;wBACuB,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IASrD;;;;OAIG;2BAC0B,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAYxD,yCAAyC;qBAClB,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAIlD;;;OAGG;qBACoB,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/C;;;OAGG;yBACkB,QAAQ,GAAG,IAAI;IAIpC;;;OAGG;oBAES,MAAM,GAAG,MAAM,GAAG,GAAG,SACzB,oBAAoB,GACzB,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAU9B;;;OAGG;qBAEO,MAAM,eACD,MAAM,SACb,GAAG,CAAC,OAAO,GAChB,OAAO,CAAC,IAAI,CAAC;IAOhB,oCAAoC;kBAChB,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC;IAI9C;;OAEG;aAEK,MAAM,MACR,MAAM,SACJ,SAAS,GACd,OAAO,CAAC,IAAI,CAAC;IAgEhB,0FAA0F;;IAG1F;;;OAGG;kBACW,MAAM,YAAY,WAAW,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAM/D,kFAAkF;;IAGlF,sDAAsD;mBACjC,QAAQ,cAAa,MAAM,GAAY,OAAO,CAAC,MAAM,CAAC;IAgB3E;;;OAGG;cACO,MAAM,SAAS,IAAI,CAAC,OAAO,GAAG,MAAM;IAI9C,sCAAsC;gBACpB,QAAQ,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAIxD;;;;;;OAMG;iBAGI,MAAM,aACA,OAAO,YACR,eAAe,GACxB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAkFzB;;;OAGG;6BAEI,MAAM,SACL,gBAAgB,GAAG;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAC,GACtC,qBAAqB;IAWxB;;;;OAIG;kBACW,MAAM,GAAG,MAAM;;;;;;;;;IAmB7B;;;OAGG;;;;;;;;;;;;;;IAgBH,gDAAgD;;IAEhD,gDAAgD;;IAEhD,gDAAgD;;IAEhD,gDAAgD;;CAEjD,CAAC;AAEF,eAAe,EAAE,CAAC"}