@photostructure/fs-metadata 0.1.2 → 0.1.3

package/dist/cjs/linux/mount_points.d.ts

@@ -0,0 +1,7 @@
+import { type MountPoint } from "../mount_point.js";
+import { type Options } from "../options.js";
+import type { NativeBindingsFn } from "../types/native_bindings.js";
+import { MountEntry } from "./mtab.js";
+export declare function getLinuxMountPoints(native: NativeBindingsFn, opts?: Pick<Options, "linuxMountTablePaths">): Promise<MountPoint[]>;
+export declare function getLinuxMtabMetadata(mountPoint: string, opts?: Pick<Options, "linuxMountTablePaths">): Promise<MountEntry>;
+//# sourceMappingURL=mount_points.d.ts.map

package/dist/cjs/linux/mount_points.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mount_points.d.ts","sourceRoot":"","sources":["../../../src/linux/mount_points.ts"],"names":[],"mappings":"AAIA,OAAO,EAAgB,KAAK,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAElE,OAAO,EAAuB,KAAK,OAAO,EAAE,MAAM,eAAe,CAAC;AAElE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,EAAE,UAAU,EAAqC,MAAM,WAAW,CAAC;AAE1E,wBAAsB,mBAAmB,CACvC,MAAM,EAAE,gBAAgB,EACxB,IAAI,CAAC,EAAE,IAAI,CAAC,OAAO,EAAE,sBAAsB,CAAC,GAC3C,OAAO,CAAC,UAAU,EAAE,CAAC,CAoDvB;AAED,wBAAsB,oBAAoB,CACxC,UAAU,EAAE,MAAM,EAClB,IAAI,CAAC,EAAE,IAAI,CAAC,OAAO,EAAE,sBAAsB,CAAC,GAC3C,OAAO,CAAC,UAAU,CAAC,CAoBrB"}

package/dist/cjs/linux/mount_points.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLinuxMountPoints = getLinuxMountPoints;
+exports.getLinuxMtabMetadata = getLinuxMtabMetadata;
+// src/linux/mount_points.ts
+const promises_1 = require("node:fs/promises");
+const debuglog_js_1 = require("../debuglog.js");
+const error_js_1 = require("../error.js");
+const mount_point_js_1 = require("../mount_point.js");
+const object_js_1 = require("../object.js");
+const options_js_1 = require("../options.js");
+const system_volume_js_1 = require("../system_volume.js");
+const mtab_js_1 = require("./mtab.js");
+async function getLinuxMountPoints(native, opts) {
+    const o = (0, options_js_1.optionsWithDefaults)(opts);
+    const raw = [];
+    try {
+        // Get GIO mounts if available from native module
+        const arr = await (await native()).getGioMountPoints?.();
+        (0, debuglog_js_1.debug)("[getLinuxMountPoints] GIO mount points: %o", arr);
+        if (arr != null)
+            raw.push(...arr);
+    }
+    catch (error) {
+        (0, debuglog_js_1.debug)("Failed to get GIO mount points: %s", error);
+        // GIO support not compiled in or failed, continue with just mtab mounts
+    }
+    let cause;
+    for (const input of o.linuxMountTablePaths) {
+        try {
+            const mtabContent = await (0, promises_1.readFile)(input, "utf8");
+            const arr = (0, mtab_js_1.parseMtab)(mtabContent)
+                .map((ea) => (0, mtab_js_1.mountEntryToMountPoint)(ea))
+                .filter((ea) => ea != null);
+            (0, debuglog_js_1.debug)("[getLinuxMountPoints] %s mount points: %o", input, arr);
+            if (arr.length > 0) {
+                raw.push(...arr);
+                break;
+            }
+        }
+        catch (error) {
+            cause ??= (0, error_js_1.toError)(error);
+        }
+    }
+    const byMountPoint = new Map();
+    for (const ea of raw) {
+        const prior = byMountPoint.get(ea.mountPoint);
+        const merged = { ...(0, object_js_1.compactValues)(prior), ...(0, object_js_1.compactValues)(ea) };
+        if ((0, mount_point_js_1.isMountPoint)(merged)) {
+            (0, system_volume_js_1.assignSystemVolume)(merged, o);
+            byMountPoint.set(merged.mountPoint, merged);
+        }
+    }
+    if (byMountPoint.size === 0) {
+        throw new error_js_1.WrappedError(`Failed to find any mount points (tried: ${JSON.stringify(o.linuxMountTablePaths)})`, { cause });
+    }
+    const results = [...byMountPoint.values()];
+    (0, debuglog_js_1.debug)("[getLinuxMountPoints] found %d mount points", results.length);
+    return o.includeSystemVolumes
+        ? results
+        : results.filter((ea) => !ea.isSystemVolume);
+}
+async function getLinuxMtabMetadata(mountPoint, opts) {
+    let caughtError;
+    const inputs = (0, options_js_1.optionsWithDefaults)(opts).linuxMountTablePaths;
+    for (const input of inputs) {
+        try {
+            const mtabContent = await (0, promises_1.readFile)(input, "utf8");
+            for (const ea of (0, mtab_js_1.parseMtab)(mtabContent)) {
+                if (ea.fs_file === mountPoint) {
+                    return ea;
+                }
+            }
+        }
+        catch (error) {
+            caughtError ??= (0, error_js_1.toError)(error);
+        }
+    }
+    throw new error_js_1.WrappedError(`Failed to find mount point ${mountPoint} in an linuxMountTablePaths (tried: ${JSON.stringify(inputs)})`, caughtError);
+}
+//# sourceMappingURL=mount_points.js.map

package/dist/cjs/linux/mount_points.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mount_points.js","sourceRoot":"","sources":["../../../src/linux/mount_points.ts"],"names":[],"mappings":";;AAWA,kDAuDC;AAED,oDAuBC;AA3FD,4BAA4B;AAC5B,+CAA4C;AAC5C,gDAAuC;AACvC,0CAAoD;AACpD,sDAAkE;AAClE,4CAA6C;AAC7C,8CAAkE;AAClE,0DAAyD;AAEzD,uCAA0E;AAEnE,KAAK,UAAU,mBAAmB,CACvC,MAAwB,EACxB,IAA4C;IAE5C,MAAM,CAAC,GAAG,IAAA,gCAAmB,EAAC,IAAI,CAAC,CAAC;IACpC,MAAM,GAAG,GAAiB,EAAE,CAAC;IAC7B,IAAI,CAAC;QACH,iDAAiD;QACjD,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,MAAM,EAAE,CAAC,CAAC,iBAAiB,EAAE,EAAE,CAAC;QACzD,IAAA,mBAAK,EAAC,4CAA4C,EAAE,GAAG,CAAC,CAAC;QACzD,IAAI,GAAG,IAAI,IAAI;YAAE,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC;IACpC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAA,mBAAK,EAAC,oCAAoC,EAAE,KAAK,CAAC,CAAC;QACnD,wEAAwE;IAC1E,CAAC;IAED,IAAI,KAAwB,CAAC;IAC7B,KAAK,MAAM,KAAK,IAAI,CAAC,CAAC,oBAAoB,EAAE,CAAC;QAC3C,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,MAAM,IAAA,mBAAQ,EAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YAClD,MAAM,GAAG,GAAG,IAAA,mBAAS,EAAC,WAAW,CAAC;iBAC/B,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAA,gCAAsB,EAAC,EAAE,CAAC,CAAC;iBACvC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,IAAI,IAAI,CAAC,CAAC;YAC9B,IAAA,mBAAK,EAAC,2CAA2C,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;YAC/D,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACnB,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC;gBACjB,MAAM;YACR,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,KAAK,KAAK,IAAA,kBAAO,EAAC,KAAK,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;IAED,MAAM,YAAY,GAAG,IAAI,GAAG,EAAsB,CAAC;IACnD,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE,CAAC;QACrB,MAAM,KAAK,GAAG,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC;QAC9C,MAAM,MAAM,GAAG,EAAE,GAAG,IAAA,yBAAa,EAAC,KAAK,CAAC,EAAE,GAAG,IAAA,yBAAa,EAAC,EAAE,CAAC,EAAE,CAAC;QACjE,IAAI,IAAA,6BAAY,EAAC,MAAM,CAAC,EAAE,CAAC;YACzB,IAAA,qCAAkB,EAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YAC9B,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;IAED,IAAI,YAAY,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,uBAAY,CACpB,2CAA2C,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,oBAAoB,CAAC,GAAG,EACpF,EAAE,KAAK,EAAE,CACV,CAAC;IACJ,CAAC;IAED,MAAM,OAAO,GAAG,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;IAC3C,IAAA,mBAAK,EAAC,6CAA6C,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IACrE,OAAO,CAAC,CAAC,oBAAoB;QAC3B,CAAC,CAAC,OAAO;QACT,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,cAAc,CAAC,CAAC;AACjD,CAAC;AAEM,KAAK,UAAU,oBAAoB,CACxC,UAAkB,EAClB,IAA4C;IAE5C,IAAI,WAA8B,CAAC;IACnC,MAAM,MAAM,GAAG,IAAA,gCAAmB,EAAC,IAAI,CAAC,CAAC,oBAAoB,CAAC;IAC9D,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,MAAM,IAAA,mBAAQ,EAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YAClD,KAAK,MAAM,EAAE,IAAI,IAAA,mBAAS,EAAC,WAAW,CAAC,EAAE,CAAC;gBACxC,IAAI,EAAE,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;oBAC9B,OAAO,EAAE,CAAC;gBACZ,CAAC;YACH,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,WAAW,KAAK,IAAA,kBAAO,EAAC,KAAK,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;IAED,MAAM,IAAI,uBAAY,CACpB,8BAA8B,UAAU,uCAAuC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,EACxG,WAAW,CACZ,CAAC;AACJ,CAAC"}

package/dist/cjs/linux/mtab.d.ts

@@ -0,0 +1,48 @@
+import { MountPoint } from "../mount_point.js";
+import { SystemVolumeConfig } from "../system_volume.js";
+import { VolumeMetadata } from "../volume_metadata.js";
+/**
+ * Represents an entry in the mount table.
+ */
+export interface MountEntry {
+    /**
+     * Device or remote filesystem
+     */
+    fs_spec: string;
+    /**
+     * Mount point
+     */
+    fs_file: string;
+    /**
+     * Filesystem type
+     */
+    fs_vfstype: string;
+    /**
+     * Mount options
+     */
+    fs_mntops: string | undefined;
+    /**
+     * Dump frequency
+     */
+    fs_freq: number | undefined;
+    /**
+     * fsck pass number
+     */
+    fs_passno: number | undefined;
+}
+export declare function mountEntryToMountPoint(entry: MountEntry): MountPoint | undefined;
+export type MtabVolumeMetadata = Omit<VolumeMetadata, "size" | "used" | "available" | "label" | "uuid" | "status">;
+export declare function mountEntryToPartialVolumeMetadata(entry: MountEntry, options?: Partial<SystemVolumeConfig>): MtabVolumeMetadata;
+/**
+ * Parses an mtab/fstab file content into structured mount entries
+ * @param content - Raw content of the mtab/fstab file
+ * @returns Array of parsed mount entries
+ */
+export declare function parseMtab(content: string): MountEntry[];
+/**
+ * Formats mount entries back into mtab file format
+ * @param entries - Array of mount entries
+ * @returns Formatted mtab file content
+ */
+export declare function formatMtab(entries: MountEntry[]): string;
+//# sourceMappingURL=mtab.d.ts.map

package/dist/cjs/linux/mtab.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mtab.d.ts","sourceRoot":"","sources":["../../../src/linux/mtab.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAU/C,OAAO,EAAkB,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AACzE,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,UAAU,GAChB,UAAU,GAAG,SAAS,CASxB;AAED,MAAM,MAAM,kBAAkB,GAAG,IAAI,CACnC,cAAc,EACd,MAAM,GAAG,MAAM,GAAG,WAAW,GAAG,OAAO,GAAG,MAAM,GAAG,QAAQ,CAC5D,CAAC;AAEF,wBAAgB,iCAAiC,CAC/C,KAAK,EAAE,UAAU,EACjB,OAAO,GAAE,OAAO,CAAC,kBAAkB,CAAM,GACxC,kBAAkB,CASpB;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,UAAU,EAAE,CAgCvD;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,UAAU,EAAE,GAAG,MAAM,CAcxD"}

package/dist/cjs/linux/mtab.js

@@ -0,0 +1,88 @@
+"use strict";
+// src/linux/mtab.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mountEntryToMountPoint = mountEntryToMountPoint;
+exports.mountEntryToPartialVolumeMetadata = mountEntryToPartialVolumeMetadata;
+exports.parseMtab = parseMtab;
+exports.formatMtab = formatMtab;
+const number_js_1 = require("../number.js");
+const path_js_1 = require("../path.js");
+const remote_info_js_1 = require("../remote_info.js");
+const string_js_1 = require("../string.js");
+const system_volume_js_1 = require("../system_volume.js");
+function mountEntryToMountPoint(entry) {
+    const mountPoint = (0, path_js_1.normalizePosixPath)(entry.fs_file);
+    const fstype = (0, string_js_1.toNotBlank)(entry.fs_vfstype) ?? (0, string_js_1.toNotBlank)(entry.fs_spec);
+    return mountPoint == null || fstype == null
+        ? undefined
+        : {
+            mountPoint,
+            fstype,
+        };
+}
+function mountEntryToPartialVolumeMetadata(entry, options = {}) {
+    return {
+        mountPoint: entry.fs_file,
+        fstype: entry.fs_vfstype,
+        mountFrom: entry.fs_spec,
+        isSystemVolume: (0, system_volume_js_1.isSystemVolume)(entry.fs_file, entry.fs_vfstype, options),
+        remote: false, // < default to false
+        ...(0, remote_info_js_1.extractRemoteInfo)(entry.fs_spec),
+    };
+}
+/**
+ * Parses an mtab/fstab file content into structured mount entries
+ * @param content - Raw content of the mtab/fstab file
+ * @returns Array of parsed mount entries
+ */
+function parseMtab(content) {
+    const entries = [];
+    const lines = content.split("\n");
+    for (const line of lines) {
+        // Skip comments and empty lines
+        if ((0, string_js_1.isBlank)(line) || line.trim().startsWith("#")) {
+            continue;
+        }
+        const fields = line
+            .trim()
+            .match(/(?:[^\s\\]+|\\.)+/g)
+            ?.map(string_js_1.decodeEscapeSequences);
+        if (!fields || fields.length < 3) {
+            continue; // Skip malformed lines
+        }
+        const fs_file = (0, path_js_1.normalizePosixPath)(fields[1]);
+        if (fs_file != null) {
+            entries.push({
+                fs_spec: fields[0],
+                // normalizeLinuxPath DOES NOT resolve()!
+                fs_file,
+                fs_vfstype: fields[2],
+                fs_mntops: fields[3],
+                fs_freq: (0, number_js_1.toInt)(fields[4]),
+                fs_passno: (0, number_js_1.toInt)(fields[5]),
+            });
+        }
+    }
+    return entries;
+}
+/**
+ * Formats mount entries back into mtab file format
+ * @param entries - Array of mount entries
+ * @returns Formatted mtab file content
+ */
+function formatMtab(entries) {
+    return entries
+        .map((entry) => {
+        const fields = [
+            entry.fs_spec,
+            (0, string_js_1.encodeEscapeSequences)(entry.fs_file),
+            entry.fs_vfstype,
+            entry.fs_mntops,
+            entry.fs_freq?.toString(),
+            entry.fs_passno?.toString(),
+        ];
+        return fields.join("\t");
+    })
+        .join("\n");
+}
+//# sourceMappingURL=mtab.js.map

package/dist/cjs/linux/mtab.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mtab.js","sourceRoot":"","sources":["../../../src/linux/mtab.ts"],"names":[],"mappings":";AAAA,oBAAoB;;AA6CpB,wDAWC;AAOD,8EAYC;AAOD,8BAgCC;AAOD,gCAcC;AApID,4CAAqC;AACrC,wCAAgD;AAChD,sDAAsD;AACtD,4CAKsB;AACtB,0DAAyE;AAiCzE,SAAgB,sBAAsB,CACpC,KAAiB;IAEjB,MAAM,UAAU,GAAG,IAAA,4BAAkB,EAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACrD,MAAM,MAAM,GAAG,IAAA,sBAAU,EAAC,KAAK,CAAC,UAAU,CAAC,IAAI,IAAA,sBAAU,EAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACzE,OAAO,UAAU,IAAI,IAAI,IAAI,MAAM,IAAI,IAAI;QACzC,CAAC,CAAC,SAAS;QACX,CAAC,CAAC;YACE,UAAU;YACV,MAAM;SACP,CAAC;AACR,CAAC;AAOD,SAAgB,iCAAiC,CAC/C,KAAiB,EACjB,UAAuC,EAAE;IAEzC,OAAO;QACL,UAAU,EAAE,KAAK,CAAC,OAAO;QACzB,MAAM,EAAE,KAAK,CAAC,UAAU;QACxB,SAAS,EAAE,KAAK,CAAC,OAAO;QACxB,cAAc,EAAE,IAAA,iCAAc,EAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,UAAU,EAAE,OAAO,CAAC;QACxE,MAAM,EAAE,KAAK,EAAE,qBAAqB;QACpC,GAAG,IAAA,kCAAiB,EAAC,KAAK,CAAC,OAAO,CAAC;KACpC,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,SAAgB,SAAS,CAAC,OAAe;IACvC,MAAM,OAAO,GAAiB,EAAE,CAAC;IACjC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAElC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,gCAAgC;QAChC,IAAI,IAAA,mBAAO,EAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACjD,SAAS;QACX,CAAC;QAED,MAAM,MAAM,GAAG,IAAI;aAChB,IAAI,EAAE;aACN,KAAK,CAAC,oBAAoB,CAAC;YAC5B,EAAE,GAAG,CAAC,iCAAqB,CAAC,CAAC;QAE/B,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACjC,SAAS,CAAC,uBAAuB;QACnC,CAAC;QACD,MAAM,OAAO,GAAG,IAAA,4BAAkB,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9C,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;YACpB,OAAO,CAAC,IAAI,CAAC;gBACX,OAAO,EAAE,MAAM,CAAC,CAAC,CAAW;gBAC5B,yCAAyC;gBACzC,OAAO;gBACP,UAAU,EAAE,MAAM,CAAC,CAAC,CAAW;gBAC/B,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;gBACpB,OAAO,EAAE,IAAA,iBAAK,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC;gBACzB,SAAS,EAAE,IAAA,iBAAK,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC;aAC5B,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;GAIG;AACH,SAAgB,UAAU,CAAC,OAAqB;IAC9C,OAAO,OAAO;SACX,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QACb,MAAM,MAAM,GAAG;YACb,KAAK,CAAC,OAAO;YACb,IAAA,iCAAqB,EAAC,KAAK,CAAC,OAAO,CAAC;YACpC,KAAK,CAAC,UAAU;YAChB,KAAK,CAAC,SAAS;YACf,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE;YACzB,KAAK,CAAC,SAAS,EAAE,QAAQ,EAAE;SAC5B,CAAC;QACF,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC"}

package/dist/cjs/mount_point.d.ts

@@ -0,0 +1,56 @@
+import { Options } from "./options.js";
+import { SystemVolumeConfig } from "./system_volume.js";
+import type { NativeBindingsFn } from "./types/native_bindings.js";
+import { VolumeHealthStatus } from "./volume_health_status.js";
+/**
+ * A mount point is a location in the file system where a volume is mounted.
+ *
+ * @see https://en.wikipedia.org/wiki/Mount_(computing)
+ */
+export interface MountPoint {
+    /**
+     * Mount location (like "/" or "C:\").
+     */
+    mountPoint: string;
+    /**
+     * The type of file system on the volume, like `ext4`, `apfs`, or `ntfs`.
+     *
+     * Note: on Windows this may show as "ntfs" for remote filesystems, as that
+     * is how the filesystem is presented to the OS.
+     */
+    fstype?: string;
+    /**
+     * On Windows, returns the health status of the volume.
+     *
+     * Note that this is only available on Windows, as both Linux and macOS  are
+     * prohibitively expensive, requiring forking `fsck -N` or `diskutil
+     * verifyVolume`.
+     *
+     * If there are non-critical errors while extracting metadata, those error
+     * messages may be added to this field (say, from blkid or gio).
+     *
+     * @see {@link VolumeHealthStatuses} for values returned by Windows.
+     */
+    status?: VolumeHealthStatus | string;
+    /**
+     * Indicates if this volume is primarily for system use (e.g., swap, snap
+     * loopbacks, EFI boot, or only system directories).
+     *
+     * Note: This is a best-effort classification and is not 100% accurate.
+     *
+     * @see {@link Options.systemPathPatterns} and {@link Options.systemFsTypes}
+     */
+    isSystemVolume?: boolean;
+    /**
+     * If there are non-critical errors while extracting metadata, those errors
+     * may be added to this field.
+     */
+    error?: Error | string;
+}
+export declare function isMountPoint(obj: unknown): obj is MountPoint;
+export type GetVolumeMountPointOptions = Partial<Pick<Options, "timeoutMs" | "linuxMountTablePaths" | "maxConcurrency" | "includeSystemVolumes"> & SystemVolumeConfig>;
+/**
+ * Helper function for {@link getVolumeMountPoints}.
+ */
+export declare function getVolumeMountPoints(opts: Required<GetVolumeMountPointOptions>, nativeFn: NativeBindingsFn): Promise<MountPoint[]>;
+//# sourceMappingURL=mount_point.d.ts.map

package/dist/cjs/mount_point.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mount_point.d.ts","sourceRoot":"","sources":["../../src/mount_point.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAGvC,OAAO,EAAsB,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAC5E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAmB,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAEhF;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,kBAAkB,GAAG,MAAM,CAAC;IAErC;;;;;;;OAOG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACxB;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,UAAU,CAG5D;AAED,MAAM,MAAM,0BAA0B,GAAG,OAAO,CAC9C,IAAI,CACF,OAAO,EACL,WAAW,GACX,sBAAsB,GACtB,gBAAgB,GAChB,sBAAsB,CACzB,GACC,kBAAkB,CACrB,CAAC;AAEF;;GAEG;AACH,wBAAsB,oBAAoB,CACxC,IAAI,EAAE,QAAQ,CAAC,0BAA0B,CAAC,EAC1C,QAAQ,EAAE,gBAAgB,GACzB,OAAO,CAAC,UAAU,EAAE,CAAC,CAMvB"}

package/dist/cjs/mount_point.js

@@ -0,0 +1,67 @@
+"use strict";
+// src/mount_point.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isMountPoint = isMountPoint;
+exports.getVolumeMountPoints = getVolumeMountPoints;
+const array_js_1 = require("./array.js");
+const async_js_1 = require("./async.js");
+const debuglog_js_1 = require("./debuglog.js");
+const mount_points_js_1 = require("./linux/mount_points.js");
+const object_js_1 = require("./object.js");
+const platform_js_1 = require("./platform.js");
+const string_js_1 = require("./string.js");
+const system_volume_js_1 = require("./system_volume.js");
+const volume_health_status_js_1 = require("./volume_health_status.js");
+function isMountPoint(obj) {
+    if (!(0, object_js_1.isObject)(obj))
+        return false;
+    return "mountPoint" in obj && (0, string_js_1.isNotBlank)(obj.mountPoint);
+}
+/**
+ * Helper function for {@link getVolumeMountPoints}.
+ */
+async function getVolumeMountPoints(opts, nativeFn) {
+    const p = _getVolumeMountPoints(opts, nativeFn);
+    // we rely on the native bindings on Windows to do proper timeouts
+    return platform_js_1.isWindows
+        ? p
+        : (0, async_js_1.withTimeout)({ desc: "getVolumeMountPoints", ...opts, promise: p });
+}
+async function _getVolumeMountPoints(o, nativeFn) {
+    (0, debuglog_js_1.debug)("[getVolumeMountPoints] gathering mount points with options: %o", o);
+    const result = await (platform_js_1.isWindows || platform_js_1.isMacOS
+        ? (async () => {
+            (0, debuglog_js_1.debug)("[getVolumeMountPoints] using native implementation");
+            const points = await (await nativeFn()).getVolumeMountPoints(o);
+            (0, debuglog_js_1.debug)("[getVolumeMountPoints] native returned %d mount points", points.length);
+            return points;
+        })()
+        : (0, mount_points_js_1.getLinuxMountPoints)(nativeFn, o));
+    (0, debuglog_js_1.debug)("[getVolumeMountPoints] raw mount points: %o", result);
+    const compacted = result
+        .map((ea) => (0, object_js_1.compactValues)(ea))
+        .filter((ea) => (0, string_js_1.isNotBlank)(ea.mountPoint));
+    const filtered = o.includeSystemVolumes
+        ? compacted
+        : compacted.filter((ea) => !ea.isSystemVolume);
+    const uniq = (0, array_js_1.uniqBy)(filtered, (ea) => (0, string_js_1.toNotBlank)(ea.mountPoint));
+    (0, debuglog_js_1.debug)("[getVolumeMountPoints] found %d unique mount points", uniq.length);
+    const results = (0, string_js_1.sortObjectsByLocale)(uniq, (ea) => ea.mountPoint);
+    (0, debuglog_js_1.debug)("[getVolumeMountPoints] getting status for %d mount points", results.length);
+    await (0, async_js_1.mapConcurrent)({
+        maxConcurrency: o.maxConcurrency,
+        items: results,
+        fn: async (mp) => {
+            (0, system_volume_js_1.assignSystemVolume)(mp, o);
+            if (((0, string_js_1.toNotBlank)(mp.status) ?? "healthy") === "healthy") {
+                // trust but verify
+                (0, debuglog_js_1.debug)("[getVolumeMountPoints] checking status of %s", mp.mountPoint);
+                mp.status = (await (0, volume_health_status_js_1.directoryStatus)(mp.mountPoint, o.timeoutMs)).status;
+                (0, debuglog_js_1.debug)("[getVolumeMountPoints] status for %s: %s", mp.mountPoint, mp.status);
+            }
+        },
+    });
+    (0, debuglog_js_1.debug)("[getVolumeMountPoints] completed with %d mount points", results.length);
+    return results;
+}
+//# sourceMappingURL=mount_point.js.map

package/dist/cjs/mount_point.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mount_point.js","sourceRoot":"","sources":["../../src/mount_point.ts"],"names":[],"mappings":";AAAA,qBAAqB;;AAgErB,oCAGC;AAgBD,oDASC;AA1FD,yCAAoC;AACpC,yCAAwD;AACxD,+CAAsC;AACtC,6DAA8D;AAC9D,2CAAsD;AAEtD,+CAAmD;AACnD,2CAA0E;AAC1E,yDAA4E;AAE5E,uEAAgF;AAoDhF,SAAgB,YAAY,CAAC,GAAY;IACvC,IAAI,CAAC,IAAA,oBAAQ,EAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC;IACjC,OAAO,YAAY,IAAI,GAAG,IAAI,IAAA,sBAAU,EAAC,GAAG,CAAC,UAAU,CAAC,CAAC;AAC3D,CAAC;AAaD;;GAEG;AACI,KAAK,UAAU,oBAAoB,CACxC,IAA0C,EAC1C,QAA0B;IAE1B,MAAM,CAAC,GAAG,qBAAqB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAChD,kEAAkE;IAClE,OAAO,uBAAS;QACd,CAAC,CAAC,CAAC;QACH,CAAC,CAAC,IAAA,sBAAW,EAAC,EAAE,IAAI,EAAE,sBAAsB,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;AACzE,CAAC;AAED,KAAK,UAAU,qBAAqB,CAClC,CAAuC,EACvC,QAA0B;IAE1B,IAAA,mBAAK,EAAC,gEAAgE,EAAE,CAAC,CAAC,CAAC;IAE3E,MAAM,MAAM,GAAG,MAAM,CAAC,uBAAS,IAAI,qBAAO;QACxC,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE;YACV,IAAA,mBAAK,EAAC,oDAAoD,CAAC,CAAC;YAC5D,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,QAAQ,EAAE,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC;YAChE,IAAA,mBAAK,EACH,wDAAwD,EACxD,MAAM,CAAC,MAAM,CACd,CAAC;YACF,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,EAAE;QACN,CAAC,CAAC,IAAA,qCAAmB,EAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC;IAEtC,IAAA,mBAAK,EAAC,6CAA6C,EAAE,MAAM,CAAC,CAAC;IAC7D,MAAM,SAAS,GAAG,MAAM;SACrB,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAA,yBAAa,EAAC,EAAE,CAAe,CAAC;SAC5C,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAA,sBAAU,EAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;IAC7C,MAAM,QAAQ,GAAG,CAAC,CAAC,oBAAoB;QACrC,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,cAAc,CAAC,CAAC;IACjD,MAAM,IAAI,GAAG,IAAA,iBAAM,EAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,IAAA,sBAAU,EAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;IACjE,IAAA,mBAAK,EAAC,qDAAqD,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC1E,MAAM,OAAO,GAAG,IAAA,+BAAmB,EAAC,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC;IACjE,IAAA,mBAAK,EACH,2DAA2D,EAC3D,OAAO,CAAC,MAAM,CACf,CAAC;IAEF,MAAM,IAAA,wBAAa,EAAC;QAClB,cAAc,EAAE,CAAC,CAAC,cAAc;QAChC,KAAK,EAAE,OAAO;QACd,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE;YACf,IAAA,qCAAkB,EAAC,EAAE,EAAE,CAAC,CAAC,CAAC;YAE1B,IAAI,CAAC,IAAA,sBAAU,EAAC,EAAE,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC,KAAK,SAAS,EAAE,CAAC;gBACvD,mBAAmB;gBACnB,IAAA,mBAAK,EAAC,8CAA8C,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC;gBACrE,EAAE,CAAC,MAAM,GAAG,CAAC,MAAM,IAAA,yCAAe,EAAC,EAAE,CAAC,UAAU,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC;gBACvE,IAAA,mBAAK,EACH,0CAA0C,EAC1C,EAAE,CAAC,UAAU,EACb,EAAE,CAAC,MAAM,CACV,CAAC;YACJ,CAAC;QACH,CAAC;KACF,CAAC,CAAC;IAEH,IAAA,mBAAK,EACH,uDAAuD,EACvD,OAAO,CAAC,MAAM,CACf,CAAC;IACF,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/cjs/number.d.ts

@@ -0,0 +1,8 @@
+export declare function isNumber(value: unknown): value is number;
+export declare function toInt(value: unknown): number | undefined;
+export declare function gt0(value: unknown): value is number;
+export declare function gte0(value: unknown): value is number;
+export declare function toGt0(value: unknown): number | undefined;
+export declare function toGte0(value: unknown): number | undefined;
+export declare function lte(a: number | undefined, b: number | undefined): boolean;
+//# sourceMappingURL=number.d.ts.map

package/dist/cjs/number.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"number.d.ts","sourceRoot":"","sources":["../../src/number.ts"],"names":[],"mappings":"AAEA,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAExD;AAID,wBAAgB,KAAK,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAQxD;AAED,wBAAgB,GAAG,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAEnD;AAED,wBAAgB,IAAI,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAEpD;AAED,wBAAgB,KAAK,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAExD;AAED,wBAAgB,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAEzD;AAED,wBAAgB,GAAG,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAEzE"}

package/dist/cjs/number.js

@@ -0,0 +1,41 @@
+"use strict";
+// src/number.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isNumber = isNumber;
+exports.toInt = toInt;
+exports.gt0 = gt0;
+exports.gte0 = gte0;
+exports.toGt0 = toGt0;
+exports.toGte0 = toGte0;
+exports.lte = lte;
+function isNumber(value) {
+    return typeof value === "number" && isFinite(value);
+}
+const INTEGER_REGEX = /^-?\d+$/;
+function toInt(value) {
+    try {
+        if (value == null)
+            return;
+        const s = String(value).trim();
+        return INTEGER_REGEX.test(s) ? parseInt(s) : undefined;
+    }
+    catch {
+        return;
+    }
+}
+function gt0(value) {
+    return isNumber(value) && value > 0;
+}
+function gte0(value) {
+    return isNumber(value) && value >= 0;
+}
+function toGt0(value) {
+    return gt0(value) ? value : undefined;
+}
+function toGte0(value) {
+    return gte0(value) ? value : undefined;
+}
+function lte(a, b) {
+    return isNumber(a) && isNumber(b) && a <= b;
+}
+//# sourceMappingURL=number.js.map

package/dist/cjs/number.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"number.js","sourceRoot":"","sources":["../../src/number.ts"],"names":[],"mappings":";AAAA,gBAAgB;;AAEhB,4BAEC;AAID,sBAQC;AAED,kBAEC;AAED,oBAEC;AAED,sBAEC;AAED,wBAEC;AAED,kBAEC;AAlCD,SAAgB,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC;AACtD,CAAC;AAED,MAAM,aAAa,GAAG,SAAS,CAAC;AAEhC,SAAgB,KAAK,CAAC,KAAc;IAClC,IAAI,CAAC;QACH,IAAI,KAAK,IAAI,IAAI;YAAE,OAAO;QAC1B,MAAM,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC;QAC/B,OAAO,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACzD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO;IACT,CAAC;AACH,CAAC;AAED,SAAgB,GAAG,CAAC,KAAc;IAChC,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC;AACtC,CAAC;AAED,SAAgB,IAAI,CAAC,KAAc;IACjC,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;AACvC,CAAC;AAED,SAAgB,KAAK,CAAC,KAAc;IAClC,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AACxC,CAAC;AAED,SAAgB,MAAM,CAAC,KAAc;IACnC,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AACzC,CAAC;AAED,SAAgB,GAAG,CAAC,CAAqB,EAAE,CAAqB;IAC9D,OAAO,QAAQ,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC9C,CAAC"}

package/dist/cjs/object.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Check if a value is an object
+ */
+export declare function isObject(value: unknown): value is object;
+/**
+ * Map a value to another value, or undefined if the value is undefined
+ */
+export declare function map<T, U>(obj: T | undefined, fn: (value: T) => U): U | undefined;
+/**
+ * Omit the specified fields from an object
+ */
+export declare function omit<T extends object, K extends keyof T>(obj: T, ...keys: K[]): Omit<T, K>;
+/**
+ * Pick the specified fields from an object
+ */
+export declare function pick<T extends object, K extends keyof T>(obj: T, ...keys: K[]): Pick<T, K>;
+export declare function compactValues<T extends object>(obj: T | undefined): Partial<T>;
+//# sourceMappingURL=object.d.ts.map

package/dist/cjs/object.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../../src/object.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAGxD;AAED;;GAEG;AACH,wBAAgB,GAAG,CAAC,CAAC,EAAE,CAAC,EACtB,GAAG,EAAE,CAAC,GAAG,SAAS,EAClB,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAClB,CAAC,GAAG,SAAS,CAEf;AAED;;GAEG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAC,EACtD,GAAG,EAAE,CAAC,EACN,GAAG,IAAI,EAAE,CAAC,EAAE,GACX,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAYZ;AACD;;GAEG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAC,EACtD,GAAG,EAAE,CAAC,EACN,GAAG,IAAI,EAAE,CAAC,EAAE,GACX,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAMZ;AACD,wBAAgB,aAAa,CAAC,CAAC,SAAS,MAAM,EAC5C,GAAG,EAAE,CAAC,GAAG,SAAS,GACjB,OAAO,CAAC,CAAC,CAAC,CAUZ"}

package/dist/cjs/object.js

@@ -0,0 +1,59 @@
+"use strict";
+// src/object.js
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isObject = isObject;
+exports.map = map;
+exports.omit = omit;
+exports.pick = pick;
+exports.compactValues = compactValues;
+const string_js_1 = require("./string.js");
+/**
+ * Check if a value is an object
+ */
+function isObject(value) {
+    // typeof null is 'object', so we need to check for that case YAY JAVASCRIPT
+    return value != null && typeof value === "object" && !Array.isArray(value);
+}
+/**
+ * Map a value to another value, or undefined if the value is undefined
+ */
+function map(obj, fn) {
+    return obj == null ? undefined : fn(obj);
+}
+/**
+ * Omit the specified fields from an object
+ */
+function omit(obj, ...keys) {
+    const result = {};
+    const keysSet = new Set(keys);
+    // OH THE TYPING HUGEMANATEE
+    for (const key of Object.keys(obj)) {
+        if (!keysSet.has(key)) {
+            result[key] = obj[key];
+        }
+    }
+    return result;
+}
+/**
+ * Pick the specified fields from an object
+ */
+function pick(obj, ...keys) {
+    const copy = {};
+    for (const key of keys) {
+        copy[key] = obj[key];
+    }
+    return copy;
+}
+function compactValues(obj) {
+    const result = {};
+    if (obj == null || !isObject(obj))
+        return {};
+    for (const [key, value] of Object.entries(obj)) {
+        // skip blank strings and nullish values:
+        if (value != null && (!(0, string_js_1.isString)(value) || (0, string_js_1.isNotBlank)(value))) {
+            result[key] = value;
+        }
+    }
+    return result;
+}
+//# sourceMappingURL=object.js.map

package/dist/cjs/object.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"object.js","sourceRoot":"","sources":["../../src/object.ts"],"names":[],"mappings":";AAAA,gBAAgB;;AAOhB,4BAGC;AAKD,kBAKC;AAKD,oBAeC;AAID,oBASC;AACD,sCAYC;AAhED,2CAAmD;AAEnD;;GAEG;AACH,SAAgB,QAAQ,CAAC,KAAc;IACrC,4EAA4E;IAC5E,OAAO,KAAK,IAAI,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC7E,CAAC;AAED;;GAEG;AACH,SAAgB,GAAG,CACjB,GAAkB,EAClB,EAAmB;IAEnB,OAAO,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;AAC3C,CAAC;AAED;;GAEG;AACH,SAAgB,IAAI,CAClB,GAAM,EACN,GAAG,IAAS;IAEZ,MAAM,MAAM,GAAG,EAAgB,CAAC;IAChC,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;IAE9B,4BAA4B;IAC5B,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAA4B,EAAE,CAAC;QAC9D,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAmB,CAAC,EAAE,CAAC;YACtC,MAAM,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AACD;;GAEG;AACH,SAAgB,IAAI,CAClB,GAAM,EACN,GAAG,IAAS;IAEZ,MAAM,IAAI,GAAG,EAAgB,CAAC;IAC9B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AACD,SAAgB,aAAa,CAC3B,GAAkB;IAElB,MAAM,MAAM,GAAG,EAAgB,CAAC;IAChC,IAAI,GAAG,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,EAAE,CAAC;IAC7C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/C,yCAAyC;QACzC,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,CAAC,IAAA,oBAAQ,EAAC,KAAK,CAAC,IAAI,IAAA,sBAAU,EAAC,KAAK,CAAC,CAAC,EAAE,CAAC;YAC7D,MAAM,CAAC,GAAc,CAAC,GAAG,KAAmB,CAAC;QAC/C,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/cjs/options.d.ts

@@ -0,0 +1,80 @@
+/**
+ * Configuration options for filesystem operations.
+ *
+ * @see {@link optionsWithDefaults} for creating an options object with default values
+ * @see {@link OptionsDefault} for the default values
+ */
+export interface Options {
+    /**
+     * Timeout in milliseconds for filesystem operations.
+     *
+     * Disable timeouts by setting this to 0.
+     *
+     * @see {@link TimeoutMsDefault}.
+     */
+    timeoutMs: number;
+    /**
+     * Maximum number of concurrent filesystem operations.
+     *
+     * Defaults to {@link https://nodejs.org/api/os.html#osavailableparallelism | availableParallelism}.
+     */
+    maxConcurrency: number;
+    /**
+     * On Linux and macOS, mount point pathnames that matches any of these glob
+     * patterns will have {@link MountPoint.isSystemVolume} set to true.
+     *
+     * @see {@link SystemPathPatternsDefault} for the default value
+     */
+    systemPathPatterns: string[];
+    /**
+     * On Linux and macOS, volumes whose filesystem matches any of these strings
+     * will have {@link MountPoint.isSystemVolume} set to true.
+     *
+     * @see {@link SystemFsTypesDefault} for the default value
+     */
+    systemFsTypes: Set<string>;
+    /**
+     * On Linux, use the first mount point table in this array that is readable.
+     *
+     * @see {@link LinuxMountTablePathsDefault} for the default values
+     */
+    linuxMountTablePaths: string[];
+    /**
+     * Should system volumes be included in result arrays? Defaults to true on
+     * Windows and false elsewhere.
+     */
+    includeSystemVolumes: boolean;
+}
+/**
+ * Default timeout in milliseconds for {@link Options.timeoutMs}.
+ *
+ * Note that this timeout may be insufficient for some devices, like spun-down
+ * optical drives or network shares that need to spin up or reconnect.
+ */
+export declare const TimeoutMsDefault: 5000;
+/**
+ * System paths and globs that indicate system volumes
+ */
+export declare const SystemPathPatternsDefault: string[];
+/**
+ * Filesystem types that indicate system volumes
+ */
+export declare const SystemFsTypesDefault: Set<string>;
+export declare const LinuxMountTablePathsDefault: string[];
+/**
+ * Should {@link getAllVolumeMetadata()} include system volumes by
+ * default?
+ */
+export declare const IncludeSystemVolumesDefault: boolean;
+/**
+ * Default {@link Options} object.
+ *
+ * @see {@link optionsWithDefaults} for creating an options object with default values
+ */
+export declare const OptionsDefault: Options;
+/**
+ * Create an {@link Options} object using default values from
+ * {@link OptionsDefault} for missing fields.
+ */
+export declare function optionsWithDefaults<T extends Options>(overrides?: Partial<T>): T;
+//# sourceMappingURL=options.d.ts.map

package/dist/cjs/options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../src/options.ts"],"names":[],"mappings":"AAMA;;;;;GAKG;AACH,MAAM,WAAW,OAAO;IACtB;;;;;;OAMG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;;;OAKG;IACH,kBAAkB,EAAE,MAAM,EAAE,CAAC;IAE7B;;;;;OAKG;IACH,aAAa,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAE3B;;;;OAIG;IACH,oBAAoB,EAAE,MAAM,EAAE,CAAC;IAE/B;;;OAGG;IACH,oBAAoB,EAAE,OAAO,CAAC;CAC/B;AAED;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,EAAG,IAAc,CAAC;AAE/C;;GAEG;AACH,eAAO,MAAM,yBAAyB,UA+BrC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB,aAuB/B,CAAC;AAEH,eAAO,MAAM,2BAA2B,UAIvC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,2BAA2B,SAAY,CAAC;AAErD;;;;GAIG;AACH,eAAO,MAAM,cAAc,EAAE,OAOnB,CAAC;AAEX;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,OAAO,EACnD,SAAS,GAAE,OAAO,CAAC,CAAC,CAAM,GACzB,CAAC,CAcH"}