@photostructure/fs-metadata 0.1.2 → 0.1.3

package/dist/cjs/options.js

@@ -0,0 +1,115 @@
+"use strict";
+// src/options.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OptionsDefault = exports.IncludeSystemVolumesDefault = exports.LinuxMountTablePathsDefault = exports.SystemFsTypesDefault = exports.SystemPathPatternsDefault = exports.TimeoutMsDefault = void 0;
+exports.optionsWithDefaults = optionsWithDefaults;
+const node_os_1 = require("node:os");
+const object_js_1 = require("./object.js");
+const platform_js_1 = require("./platform.js");
+/**
+ * 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.
+ */
+exports.TimeoutMsDefault = 5_000;
+/**
+ * System paths and globs that indicate system volumes
+ */
+exports.SystemPathPatternsDefault = [
+    "/boot",
+    "/boot/efi",
+    "/dev",
+    "/dev/**",
+    "/proc/**",
+    "/run",
+    "/run/credentials/**",
+    "/run/lock",
+    "/run/snapd/**",
+    "/run/user/*/doc",
+    "/run/user/*/gvfs",
+    "/snap/**",
+    "/sys/**",
+    // windows for linux:
+    "/mnt/wslg/distro",
+    "/mnt/wslg/doc",
+    "/mnt/wslg/versions.txt",
+    "/usr/lib/wsl/drivers",
+    // MacOS stuff:
+    "/private/var/vm", // macOS swap
+    "/System/Volumes/Hardware",
+    "/System/Volumes/iSCPreboot",
+    "/System/Volumes/Preboot",
+    "/System/Volumes/Recovery",
+    "/System/Volumes/Reserved",
+    "/System/Volumes/Update",
+    "/System/Volumes/VM",
+    "/System/Volumes/xarts",
+];
+/**
+ * Filesystem types that indicate system volumes
+ */
+exports.SystemFsTypesDefault = new Set([
+    "autofs",
+    "binfmt_misc",
+    "cgroup",
+    "cgroup2",
+    "configfs",
+    "debugfs",
+    "devpts",
+    "devtmpfs",
+    "efivarfs",
+    "fusectl",
+    "fuse.snapfuse",
+    "hugetlbfs",
+    "mqueue",
+    "none",
+    "proc",
+    "pstore",
+    "rootfs",
+    "securityfs",
+    "snap*",
+    "squashfs",
+    "sysfs",
+    "tmpfs",
+]);
+exports.LinuxMountTablePathsDefault = [
+    "/proc/self/mounts",
+    "/proc/mounts",
+    "/etc/mtab",
+];
+/**
+ * Should {@link getAllVolumeMetadata()} include system volumes by
+ * default?
+ */
+exports.IncludeSystemVolumesDefault = platform_js_1.isWindows;
+/**
+ * Default {@link Options} object.
+ *
+ * @see {@link optionsWithDefaults} for creating an options object with default values
+ */
+exports.OptionsDefault = {
+    timeoutMs: exports.TimeoutMsDefault,
+    maxConcurrency: (0, node_os_1.availableParallelism)(),
+    systemPathPatterns: [...exports.SystemPathPatternsDefault],
+    systemFsTypes: new Set(exports.SystemFsTypesDefault),
+    linuxMountTablePaths: exports.LinuxMountTablePathsDefault,
+    includeSystemVolumes: exports.IncludeSystemVolumesDefault,
+};
+/**
+ * Create an {@link Options} object using default values from
+ * {@link OptionsDefault} for missing fields.
+ */
+function optionsWithDefaults(overrides = {}) {
+    if (!(0, object_js_1.isObject)(overrides)) {
+        throw new TypeError("options(): expected an object, got " +
+            typeof overrides +
+            ": " +
+            JSON.stringify(overrides));
+    }
+    return {
+        ...exports.OptionsDefault,
+        ...(0, object_js_1.compactValues)(overrides),
+    };
+}
+//# sourceMappingURL=options.js.map

package/dist/cjs/options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.js","sourceRoot":"","sources":["../../src/options.ts"],"names":[],"mappings":";AAAA,iBAAiB;;;AAiKjB,kDAgBC;AA/KD,qCAA+C;AAC/C,2CAAsD;AACtD,+CAA0C;AAuD1C;;;;;GAKG;AACU,QAAA,gBAAgB,GAAG,KAAc,CAAC;AAE/C;;GAEG;AACU,QAAA,yBAAyB,GAAG;IACvC,OAAO;IACP,WAAW;IACX,MAAM;IACN,SAAS;IACT,UAAU;IACV,MAAM;IACN,qBAAqB;IACrB,WAAW;IACX,eAAe;IACf,iBAAiB;IACjB,kBAAkB;IAClB,UAAU;IACV,SAAS;IAET,qBAAqB;IACrB,kBAAkB;IAClB,eAAe;IACf,wBAAwB;IACxB,sBAAsB;IAEtB,eAAe;IACf,iBAAiB,EAAE,aAAa;IAChC,0BAA0B;IAC1B,4BAA4B;IAC5B,yBAAyB;IACzB,0BAA0B;IAC1B,0BAA0B;IAC1B,wBAAwB;IACxB,oBAAoB;IACpB,uBAAuB;CACxB,CAAC;AAEF;;GAEG;AACU,QAAA,oBAAoB,GAAG,IAAI,GAAG,CAAC;IAC1C,QAAQ;IACR,aAAa;IACb,QAAQ;IACR,SAAS;IACT,UAAU;IACV,SAAS;IACT,QAAQ;IACR,UAAU;IACV,UAAU;IACV,SAAS;IACT,eAAe;IACf,WAAW;IACX,QAAQ;IACR,MAAM;IACN,MAAM;IACN,QAAQ;IACR,QAAQ;IACR,YAAY;IACZ,OAAO;IACP,UAAU;IACV,OAAO;IACP,OAAO;CACR,CAAC,CAAC;AAEU,QAAA,2BAA2B,GAAG;IACzC,mBAAmB;IACnB,cAAc;IACd,WAAW;CACZ,CAAC;AAEF;;;GAGG;AACU,QAAA,2BAA2B,GAAG,uBAAS,CAAC;AAErD;;;;GAIG;AACU,QAAA,cAAc,GAAY;IACrC,SAAS,EAAE,wBAAgB;IAC3B,cAAc,EAAE,IAAA,8BAAoB,GAAE;IACtC,kBAAkB,EAAE,CAAC,GAAG,iCAAyB,CAAC;IAClD,aAAa,EAAE,IAAI,GAAG,CAAC,4BAAoB,CAAC;IAC5C,oBAAoB,EAAE,mCAA2B;IACjD,oBAAoB,EAAE,mCAA2B;CACzC,CAAC;AAEX;;;GAGG;AACH,SAAgB,mBAAmB,CACjC,YAAwB,EAAE;IAE1B,IAAI,CAAC,IAAA,oBAAQ,EAAC,SAAS,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,SAAS,CACjB,qCAAqC;YACnC,OAAO,SAAS;YAChB,IAAI;YACJ,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAC5B,CAAC;IACJ,CAAC;IAED,OAAO;QACL,GAAG,sBAAc;QACjB,GAAI,IAAA,yBAAa,EAAC,SAAS,CAAO;KACnC,CAAC;AACJ,CAAC"}

package/dist/cjs/path.d.ts

@@ -0,0 +1,18 @@
+export declare function normalizePath(mountPoint: string | undefined): string | undefined;
+/**
+ * Normalizes a Linux or macOS mount point by removing any trailing slashes.
+ * This is a no-op for root mount points.
+ */
+export declare function normalizePosixPath(mountPoint: string | undefined): string | undefined;
+/**
+ * Normalizes a Windows mount point by ensuring drive letters end with a
+ * backslash.
+ */
+export declare function normalizeWindowsPath(mountPoint: string): string;
+/**
+ * @return true if `path` is the root directory--this is platform-specific. Only
+ * "/" on linux/macOS is considered a root directory. On Windows, the root
+ * directory is a drive letter followed by a colon, e.g. "C:\".
+ */
+export declare function isRootDirectory(path: string): boolean;
+//# sourceMappingURL=path.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"path.d.ts","sourceRoot":"","sources":["../../src/path.ts"],"names":[],"mappings":"AAMA,wBAAgB,aAAa,CAC3B,UAAU,EAAE,MAAM,GAAG,SAAS,GAC7B,MAAM,GAAG,SAAS,CASpB;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,UAAU,EAAE,MAAM,GAAG,SAAS,GAC7B,MAAM,GAAG,SAAS,CAMpB;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAM/D;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAGrD"}

package/dist/cjs/path.js

@@ -0,0 +1,50 @@
+"use strict";
+// src/path.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizePath = normalizePath;
+exports.normalizePosixPath = normalizePosixPath;
+exports.normalizeWindowsPath = normalizeWindowsPath;
+exports.isRootDirectory = isRootDirectory;
+const node_path_1 = require("node:path");
+const platform_js_1 = require("./platform.js");
+const string_js_1 = require("./string.js");
+function normalizePath(mountPoint) {
+    if ((0, string_js_1.isBlank)(mountPoint))
+        return undefined;
+    const result = platform_js_1.isWindows
+        ? normalizeWindowsPath(mountPoint)
+        : normalizePosixPath(mountPoint);
+    // Make sure the native code doesn't see anything weird:
+    return result != null ? (0, node_path_1.resolve)(result) : undefined;
+}
+/**
+ * Normalizes a Linux or macOS mount point by removing any trailing slashes.
+ * This is a no-op for root mount points.
+ */
+function normalizePosixPath(mountPoint) {
+    return (0, string_js_1.isBlank)(mountPoint)
+        ? undefined
+        : mountPoint === "/"
+            ? mountPoint
+            : mountPoint.replace(/\/+$/, "");
+}
+/**
+ * Normalizes a Windows mount point by ensuring drive letters end with a
+ * backslash.
+ */
+function normalizeWindowsPath(mountPoint) {
+    // Terrible things happen if we give syscalls "C:" instead of "C:\"
+    return /^[a-z]:$/i.test(mountPoint)
+        ? mountPoint.toUpperCase() + "\\"
+        : mountPoint;
+}
+/**
+ * @return true if `path` is the root directory--this is platform-specific. Only
+ * "/" on linux/macOS is considered a root directory. On Windows, the root
+ * directory is a drive letter followed by a colon, e.g. "C:\".
+ */
+function isRootDirectory(path) {
+    const n = normalizePath(path);
+    return n == null ? false : platform_js_1.isWindows ? (0, node_path_1.dirname)(n) === n : n === "/";
+}
+//# sourceMappingURL=path.js.map

package/dist/cjs/path.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"path.js","sourceRoot":"","sources":["../../src/path.ts"],"names":[],"mappings":";AAAA,cAAc;;AAMd,sCAWC;AAMD,gDAQC;AAMD,oDAMC;AAOD,0CAGC;AAnDD,yCAA6C;AAC7C,+CAA0C;AAC1C,2CAAsC;AAEtC,SAAgB,aAAa,CAC3B,UAA8B;IAE9B,IAAI,IAAA,mBAAO,EAAC,UAAU,CAAC;QAAE,OAAO,SAAS,CAAC;IAE1C,MAAM,MAAM,GAAG,uBAAS;QACtB,CAAC,CAAC,oBAAoB,CAAC,UAAU,CAAC;QAClC,CAAC,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;IAEnC,wDAAwD;IACxD,OAAO,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,IAAA,mBAAO,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACtD,CAAC;AAED;;;GAGG;AACH,SAAgB,kBAAkB,CAChC,UAA8B;IAE9B,OAAO,IAAA,mBAAO,EAAC,UAAU,CAAC;QACxB,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,UAAU,KAAK,GAAG;YAClB,CAAC,CAAC,UAAU;YACZ,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACvC,CAAC;AAED;;;GAGG;AACH,SAAgB,oBAAoB,CAAC,UAAkB;IACrD,mEAAmE;IAEnE,OAAO,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC;QACjC,CAAC,CAAC,UAAU,CAAC,WAAW,EAAE,GAAG,IAAI;QACjC,CAAC,CAAC,UAAU,CAAC;AACjB,CAAC;AAED;;;;GAIG;AACH,SAAgB,eAAe,CAAC,IAAY;IAC1C,MAAM,CAAC,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;IAC9B,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,uBAAS,CAAC,CAAC,CAAC,IAAA,mBAAO,EAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC;AACtE,CAAC"}

package/dist/cjs/platform.d.ts

@@ -0,0 +1,4 @@
+export declare const isLinux: boolean;
+export declare const isWindows: boolean;
+export declare const isMacOS: boolean;
+//# sourceMappingURL=platform.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"platform.d.ts","sourceRoot":"","sources":["../../src/platform.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,OAAO,SAAgB,CAAC;AACrC,eAAO,MAAM,SAAS,SAAgB,CAAC;AACvC,eAAO,MAAM,OAAO,SAAiB,CAAC"}

package/dist/cjs/platform.js

@@ -0,0 +1,10 @@
+"use strict";
+// src/platform.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isMacOS = exports.isWindows = exports.isLinux = void 0;
+const node_os_1 = require("node:os");
+const p = (0, node_os_1.platform)();
+exports.isLinux = p === "linux";
+exports.isWindows = p === "win32";
+exports.isMacOS = p === "darwin";
+//# sourceMappingURL=platform.js.map

package/dist/cjs/platform.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"platform.js","sourceRoot":"","sources":["../../src/platform.ts"],"names":[],"mappings":";AAAA,kBAAkB;;;AAElB,qCAAmC;AAEnC,MAAM,CAAC,GAAG,IAAA,kBAAQ,GAAE,CAAC;AAER,QAAA,OAAO,GAAG,CAAC,KAAK,OAAO,CAAC;AACxB,QAAA,SAAS,GAAG,CAAC,KAAK,OAAO,CAAC;AAC1B,QAAA,OAAO,GAAG,CAAC,KAAK,QAAQ,CAAC"}

package/dist/cjs/random.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @return a random character `[a-z]`
+ */
+export declare function randomLetter(): string;
+export declare function randomLetters(length: number): string;
+/**
+ * Shuffle an array using the Fisher-Yates (Knuth) algorithm.
+ * @param a The array to shuffle
+ * @returns A shallow shuffled copy of `a`
+ */
+export declare function shuffle<T>(a: T[]): T[];
+export declare function pickRandom<T>(a: T[]): T;
+//# sourceMappingURL=random.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"random.d.ts","sourceRoot":"","sources":["../../src/random.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,wBAAgB,YAAY,IAAI,MAAM,CAErC;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEpD;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,CAWtC;AACD,wBAAgB,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAKvC"}

package/dist/cjs/random.js

@@ -0,0 +1,43 @@
+"use strict";
+// src/random.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.randomLetter = randomLetter;
+exports.randomLetters = randomLetters;
+exports.shuffle = shuffle;
+exports.pickRandom = pickRandom;
+const node_crypto_1 = require("node:crypto");
+const CharCode_a = "a".charCodeAt(0);
+/**
+ * @return a random character `[a-z]`
+ */
+function randomLetter() {
+    return String.fromCharCode(CharCode_a + (0, node_crypto_1.randomInt)(0, 26));
+}
+function randomLetters(length) {
+    return Array.from({ length }, randomLetter).join("");
+}
+/**
+ * Shuffle an array using the Fisher-Yates (Knuth) algorithm.
+ * @param a The array to shuffle
+ * @returns A shallow shuffled copy of `a`
+ */
+function shuffle(a) {
+    if (a.length <= 1)
+        return a;
+    a = [...a]; // Copy the array
+    for (let i = a.length - 1; i > 0; i--) {
+        // Pick a random index from 0 to i
+        const j = Math.floor(Math.random() * (i + 1));
+        // Swap elements at indices i and j
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        [a[i], a[j]] = [a[j], a[i]];
+    }
+    return a;
+}
+function pickRandom(a) {
+    if (a == null || a.length === 0) {
+        throw new Error("Cannot pick from an empty array");
+    }
+    return a[(0, node_crypto_1.randomInt)(0, a.length)];
+}
+//# sourceMappingURL=random.js.map

package/dist/cjs/random.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"random.js","sourceRoot":"","sources":["../../src/random.ts"],"names":[],"mappings":";AAAA,gBAAgB;;AAQhB,oCAEC;AAED,sCAEC;AAOD,0BAWC;AACD,gCAKC;AApCD,6CAAwC;AAExC,MAAM,UAAU,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;AACrC;;GAEG;AACH,SAAgB,YAAY;IAC1B,OAAO,MAAM,CAAC,YAAY,CAAC,UAAU,GAAG,IAAA,uBAAS,EAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;AAC5D,CAAC;AAED,SAAgB,aAAa,CAAC,MAAc;IAC1C,OAAO,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,YAAY,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACvD,CAAC;AAED;;;;GAIG;AACH,SAAgB,OAAO,CAAI,CAAM;IAC/B,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC;QAAE,OAAO,CAAC,CAAC;IAC5B,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,iBAAiB;IAC7B,KAAK,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,kCAAkC;QAClC,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC9C,mCAAmC;QACnC,oEAAoE;QACpE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAE,EAAE,CAAC,CAAC,CAAC,CAAE,CAAC,CAAC;IAChC,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC;AACD,SAAgB,UAAU,CAAI,CAAM;IAClC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;IACrD,CAAC;IACD,OAAO,CAAC,CAAC,IAAA,uBAAS,EAAC,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAM,CAAC;AACxC,CAAC"}

package/dist/cjs/remote_info.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Represents remote filesystem information.
+ */
+export interface RemoteInfo {
+    /**
+     * We can sometimes fetch a URI of the resource (like "smb://server/share" or
+     * "file:///media/user/usb")
+     */
+    uri?: string;
+    /**
+     * Protocol used to access the share.
+     */
+    protocol?: string;
+    /**
+     * Does the protocol seem to be a remote filesystem?
+     */
+    remote: boolean;
+    /**
+     * If remote, may include the username used to access the share.
+     *
+     * This will be undefined on NFS and other remote filesystem types that do
+     * authentication out of band.
+     */
+    remoteUser?: string;
+    /**
+     * If remote, the ip or hostname hosting the share (like "rusty" or "10.1.1.3")
+     */
+    remoteHost?: string;
+    /**
+     * If remote, the name of the share (like "homes")
+     */
+    remoteShare?: string;
+}
+export declare function isRemoteInfo(obj: unknown): obj is RemoteInfo;
+export declare function normalizeProtocol(protocol: string): string;
+export declare function isRemoteFsType(fstype: string | undefined): boolean;
+export declare function parseURL(s: string): URL | undefined;
+export declare function extractRemoteInfo(fsSpec: string | undefined): RemoteInfo | undefined;
+//# sourceMappingURL=remote_info.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"remote_info.d.ts","sourceRoot":"","sources":["../../src/remote_info.ts"],"names":[],"mappings":"AAOA;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,UAAU,CAI5D;AA0BD,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAE1D;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAElE;AAED,wBAAgB,QAAQ,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,GAAG,SAAS,CAMnD;AAED,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,MAAM,GAAG,SAAS,GACzB,UAAU,GAAG,SAAS,CAuExB"}

package/dist/cjs/remote_info.js

@@ -0,0 +1,123 @@
+"use strict";
+// src/remote_info.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isRemoteInfo = isRemoteInfo;
+exports.normalizeProtocol = normalizeProtocol;
+exports.isRemoteFsType = isRemoteFsType;
+exports.parseURL = parseURL;
+exports.extractRemoteInfo = extractRemoteInfo;
+const debuglog_js_1 = require("./debuglog.js");
+const object_js_1 = require("./object.js");
+const platform_js_1 = require("./platform.js");
+const string_js_1 = require("./string.js");
+function isRemoteInfo(obj) {
+    if (!(0, object_js_1.isObject)(obj))
+        return false;
+    const { remoteHost, remoteShare } = obj;
+    return (0, string_js_1.isNotBlank)(remoteHost) && (0, string_js_1.isNotBlank)(remoteShare);
+}
+const NETWORK_FS_TYPES = new Set([
+    "9p",
+    "afp",
+    "afs",
+    "beegfs",
+    "ceph",
+    "cifs",
+    "ftp",
+    "fuse.cephfs",
+    "fuse.glusterfs",
+    "fuse.sshfs",
+    "fuse",
+    "gfs2",
+    "glusterfs",
+    "lustre",
+    "ncpfs",
+    "nfs",
+    "nfs4",
+    "smb",
+    "smbfs",
+    "sshfs",
+    "webdav",
+]);
+function normalizeProtocol(protocol) {
+    return (protocol ?? "").toLowerCase().replace(/:$/, "");
+}
+function isRemoteFsType(fstype) {
+    return (0, string_js_1.isNotBlank)(fstype) && NETWORK_FS_TYPES.has(normalizeProtocol(fstype));
+}
+function parseURL(s) {
+    try {
+        return (0, string_js_1.isBlank)(s) ? undefined : new URL(s);
+    }
+    catch {
+        return;
+    }
+}
+function extractRemoteInfo(fsSpec) {
+    if (fsSpec == null || (0, string_js_1.isBlank)(fsSpec))
+        return;
+    if (platform_js_1.isWindows) {
+        fsSpec = fsSpec.replace(/\\/g, "/");
+    }
+    const url = parseURL(fsSpec);
+    if (url?.protocol === "file:") {
+        return {
+            remote: false,
+            uri: fsSpec,
+        };
+    }
+    const patterns = [
+        // CIFS/SMB pattern: //hostname/share or //user@host/share
+        {
+            regex: /^\/\/(?:(?<remoteUser>[^/@]+)@)?(?<remoteHost>[^/@]+)\/(?<remoteShare>.+)$/,
+        },
+        // NFS pattern: hostname:/share
+        {
+            protocol: "nfs",
+            regex: /^(?<remoteHost>[^:]+):\/(?!\/)(?<remoteShare>.+)$/,
+        },
+    ];
+    for (const { protocol, regex } of patterns) {
+        const o = (0, object_js_1.compactValues)({
+            protocol,
+            remote: true,
+            ...(fsSpec.match(regex)?.groups ?? {}),
+        });
+        if (isRemoteInfo(o)) {
+            (0, debuglog_js_1.debug)("[extractRemoteInfo] matched pattern: %o", o);
+            return o;
+        }
+    }
+    // Let's try URL last, as nfs mounts are URI-ish
+    try {
+        // try to parse fsSpec as a uri:
+        const parsed = new URL(fsSpec);
+        if (parsed != null) {
+            (0, debuglog_js_1.debug)("[extractRemoteInfo] parsed URL: %o", parsed);
+            const protocol = normalizeProtocol(parsed.protocol);
+            if (!isRemoteFsType(protocol)) {
+                // don't set remoteUser, remoteHost, or remoteShare, it's not remote!
+                return {
+                    uri: fsSpec,
+                    remote: false,
+                };
+            }
+            else {
+                return (0, object_js_1.compactValues)({
+                    uri: fsSpec,
+                    protocol,
+                    remote: true,
+                    remoteUser: parsed.username,
+                    remoteHost: parsed.hostname,
+                    // URL pathname includes leading slash:
+                    remoteShare: parsed.pathname.replace(/^\//, ""),
+                });
+            }
+        }
+    }
+    catch {
+        // ignore
+    }
+    return;
+}
+//# sourceMappingURL=remote_info.js.map

package/dist/cjs/remote_info.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"remote_info.js","sourceRoot":"","sources":["../../src/remote_info.ts"],"names":[],"mappings":";AAAA,qBAAqB;;AAyCrB,oCAIC;AA0BD,8CAEC;AAED,wCAEC;AAED,4BAMC;AAED,8CAyEC;AA9JD,+CAAsC;AACtC,2CAAsD;AACtD,+CAA0C;AAC1C,2CAAkD;AAoClD,SAAgB,YAAY,CAAC,GAAY;IACvC,IAAI,CAAC,IAAA,oBAAQ,EAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC;IACjC,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,GAA0B,CAAC;IAC/D,OAAO,IAAA,sBAAU,EAAC,UAAU,CAAC,IAAI,IAAA,sBAAU,EAAC,WAAW,CAAC,CAAC;AAC3D,CAAC;AAED,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAC;IAC/B,IAAI;IACJ,KAAK;IACL,KAAK;IACL,QAAQ;IACR,MAAM;IACN,MAAM;IACN,KAAK;IACL,aAAa;IACb,gBAAgB;IAChB,YAAY;IACZ,MAAM;IACN,MAAM;IACN,WAAW;IACX,QAAQ;IACR,OAAO;IACP,KAAK;IACL,MAAM;IACN,KAAK;IACL,OAAO;IACP,OAAO;IACP,QAAQ;CACT,CAAC,CAAC;AAEH,SAAgB,iBAAiB,CAAC,QAAgB;IAChD,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;AAC1D,CAAC;AAED,SAAgB,cAAc,CAAC,MAA0B;IACvD,OAAO,IAAA,sBAAU,EAAC,MAAM,CAAC,IAAI,gBAAgB,CAAC,GAAG,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC;AAC/E,CAAC;AAED,SAAgB,QAAQ,CAAC,CAAS;IAChC,IAAI,CAAC;QACH,OAAO,IAAA,mBAAO,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;IAC7C,CAAC;IAAC,MAAM,CAAC;QACP,OAAO;IACT,CAAC;AACH,CAAC;AAED,SAAgB,iBAAiB,CAC/B,MAA0B;IAE1B,IAAI,MAAM,IAAI,IAAI,IAAI,IAAA,mBAAO,EAAC,MAAM,CAAC;QAAE,OAAO;IAE9C,IAAI,uBAAS,EAAE,CAAC;QACd,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACtC,CAAC;IAED,MAAM,GAAG,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;IAE7B,IAAI,GAAG,EAAE,QAAQ,KAAK,OAAO,EAAE,CAAC;QAC9B,OAAO;YACL,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,MAAM;SACZ,CAAC;IACJ,CAAC;IAED,MAAM,QAAQ,GAAG;QACf,0DAA0D;QAC1D;YACE,KAAK,EACH,4EAA4E;SAC/E;QACD,+BAA+B;QAC/B;YACE,QAAQ,EAAE,KAAK;YACf,KAAK,EAAE,mDAAmD;SAC3D;KACF,CAAC;IAEF,KAAK,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,QAAQ,EAAE,CAAC;QAC3C,MAAM,CAAC,GAAG,IAAA,yBAAa,EAAC;YACtB,QAAQ;YACR,MAAM,EAAE,IAAI;YACZ,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,MAAM,IAAI,EAAE,CAAC;SACvC,CAAC,CAAC;QACH,IAAI,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;YACpB,IAAA,mBAAK,EAAC,yCAAyC,EAAE,CAAC,CAAC,CAAC;YACpD,OAAO,CAAC,CAAC;QACX,CAAC;IACH,CAAC;IAED,gDAAgD;IAChD,IAAI,CAAC;QACH,gCAAgC;QAChC,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC;QAC/B,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;YACnB,IAAA,mBAAK,EAAC,oCAAoC,EAAE,MAAM,CAAC,CAAC;YACpD,MAAM,QAAQ,GAAG,iBAAiB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YACpD,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC9B,qEAAqE;gBACrE,OAAO;oBACL,GAAG,EAAE,MAAM;oBACX,MAAM,EAAE,KAAK;iBACd,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAA,yBAAa,EAAC;oBACnB,GAAG,EAAE,MAAM;oBACX,QAAQ;oBACR,MAAM,EAAE,IAAI;oBACZ,UAAU,EAAE,MAAM,CAAC,QAAQ;oBAC3B,UAAU,EAAE,MAAM,CAAC,QAAQ;oBAC3B,uCAAuC;oBACvC,WAAW,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;iBAChD,CAA0B,CAAC;YAC9B,CAAC;QACH,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACP,SAAS;IACX,CAAC;IAED,OAAO;AACT,CAAC"}

package/dist/cjs/setup.d.ts

@@ -0,0 +1,3 @@
+import { ExportedFunctions } from "./exports.js";
+export declare function setup(dirname: string): ExportedFunctions;
+//# sourceMappingURL=setup.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../../src/setup.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAiBjD,wBAAgB,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,iBAAiB,CA8CxD"}

package/dist/cjs/setup.js

@@ -0,0 +1,47 @@
+"use strict";
+// src/exports.ts
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setup = setup;
+const node_gyp_build_1 = __importDefault(require("node-gyp-build"));
+const debuglog_js_1 = require("./debuglog.js");
+const defer_js_1 = require("./defer.js");
+const fs_js_1 = require("./fs.js");
+const hidden_js_1 = require("./hidden.js");
+const mount_point_js_1 = require("./mount_point.js");
+const options_js_1 = require("./options.js");
+const volume_metadata_js_1 = require("./volume_metadata.js");
+function setup(dirname) {
+    const nativeFn = (0, defer_js_1.defer)(async () => {
+        const start = Date.now();
+        try {
+            const dir = await (0, fs_js_1.findAncestorDir)(dirname, "binding.gyp");
+            if (dir == null) {
+                throw new Error("Could not find bindings.gyp in any ancestor directory of " + dirname);
+            }
+            const bindings = (0, node_gyp_build_1.default)(dir);
+            bindings.setDebugLogging((0, debuglog_js_1.isDebugEnabled)());
+            bindings.setDebugPrefix((0, debuglog_js_1.debugLogContext)() + ":native");
+            return bindings;
+        }
+        catch (error) {
+            (0, debuglog_js_1.debug)("Loading native bindings failed: %s", error);
+            throw error;
+        }
+        finally {
+            (0, debuglog_js_1.debug)(`Native bindings took %d ms to load`, Date.now() - start);
+        }
+    });
+    return {
+        getVolumeMountPoints: (opts = {}) => (0, mount_point_js_1.getVolumeMountPoints)((0, options_js_1.optionsWithDefaults)(opts), nativeFn),
+        getVolumeMetadata: (mountPoint, opts = {}) => (0, volume_metadata_js_1.getVolumeMetadata)({ ...(0, options_js_1.optionsWithDefaults)(opts), mountPoint }, nativeFn),
+        getAllVolumeMetadata: (opts = {}) => (0, volume_metadata_js_1.getAllVolumeMetadata)((0, options_js_1.optionsWithDefaults)(opts), nativeFn),
+        isHidden: (pathname) => (0, hidden_js_1.isHidden)(pathname, nativeFn),
+        isHiddenRecursive: (pathname) => (0, hidden_js_1.isHiddenRecursive)(pathname, nativeFn),
+        getHiddenMetadata: (pathname) => (0, hidden_js_1.getHiddenMetadata)(pathname, nativeFn),
+        setHidden: (pathname, hidden, method = "auto") => (0, hidden_js_1.setHidden)(pathname, hidden, method, nativeFn),
+    };
+}
+//# sourceMappingURL=setup.js.map

package/dist/cjs/setup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup.js","sourceRoot":"","sources":["../../src/setup.ts"],"names":[],"mappings":";AAAA,iBAAiB;;;;;AAsBjB,sBA8CC;AAlED,oEAA0C;AAC1C,+CAAuE;AACvE,yCAAmC;AAEnC,mCAA0C;AAC1C,2CAMqB;AACrB,qDAG0B;AAC1B,6CAAmD;AAEnD,6DAA+E;AAE/E,SAAgB,KAAK,CAAC,OAAe;IACnC,MAAM,QAAQ,GAAG,IAAA,gBAAK,EAA0B,KAAK,IAAI,EAAE;QACzD,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACzB,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,MAAM,IAAA,uBAAe,EAAC,OAAO,EAAE,aAAa,CAAC,CAAC;YAC1D,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;gBAChB,MAAM,IAAI,KAAK,CACb,2DAA2D,GAAG,OAAO,CACtE,CAAC;YACJ,CAAC;YACD,MAAM,QAAQ,GAAG,IAAA,wBAAY,EAAC,GAAG,CAAmB,CAAC;YACrD,QAAQ,CAAC,eAAe,CAAC,IAAA,4BAAc,GAAE,CAAC,CAAC;YAC3C,QAAQ,CAAC,cAAc,CAAC,IAAA,6BAAe,GAAE,GAAG,SAAS,CAAC,CAAC;YACvD,OAAO,QAAQ,CAAC;QAClB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAA,mBAAK,EAAC,oCAAoC,EAAE,KAAK,CAAC,CAAC;YACnD,MAAM,KAAK,CAAC;QACd,CAAC;gBAAS,CAAC;YACT,IAAA,mBAAK,EAAC,oCAAoC,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,CAAC;QAClE,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,oBAAoB,EAAE,CAAC,OAA4C,EAAE,EAAE,EAAE,CACvE,IAAA,qCAAoB,EAAC,IAAA,gCAAmB,EAAC,IAAI,CAAC,EAAE,QAAQ,CAAC;QAE3D,iBAAiB,EAAE,CAAC,UAAkB,EAAE,IAAI,GAAG,EAAE,EAAE,EAAE,CACnD,IAAA,sCAAiB,EAAC,EAAE,GAAG,IAAA,gCAAmB,EAAC,IAAI,CAAC,EAAE,UAAU,EAAE,EAAE,QAAQ,CAAC;QAE3E,oBAAoB,EAAE,CAAC,IAAI,GAAG,EAAE,EAAE,EAAE,CAClC,IAAA,yCAAoB,EAAC,IAAA,gCAAmB,EAAC,IAAI,CAAC,EAAE,QAAQ,CAAC;QAE3D,QAAQ,EAAE,CAAC,QAAgB,EAAE,EAAE,CAAC,IAAA,oBAAQ,EAAC,QAAQ,EAAE,QAAQ,CAAC;QAE5D,iBAAiB,EAAE,CAAC,QAAgB,EAAE,EAAE,CACtC,IAAA,6BAAiB,EAAC,QAAQ,EAAE,QAAQ,CAAC;QAEvC,iBAAiB,EAAE,CAAC,QAAgB,EAAE,EAAE,CACtC,IAAA,6BAAiB,EAAC,QAAQ,EAAE,QAAQ,CAAC;QAEvC,SAAS,EAAE,CACT,QAAgB,EAChB,MAAe,EACf,SAAqB,MAAM,EAC3B,EAAE,CAAC,IAAA,qBAAS,EAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC;KAC1C,CAAC;AACb,CAAC"}

package/dist/cjs/string.d.ts

@@ -0,0 +1,38 @@
+export declare function isString(input: unknown): input is string;
+export declare function toS(input: unknown): string;
+/**
+ * @return true iff the input is a string and has at least one non-whitespace character
+ */
+export declare function isNotBlank(input: unknown): input is string;
+/**
+ * @return true iff the input is not a string or only has non-whitespace characters
+ */
+export declare function isBlank(input: unknown): input is undefined;
+export declare function toNotBlank(input: unknown): string | undefined;
+/**
+ * Decodes a string containing octal (\000-\377) and/or hexadecimal
+ * (\x00-\xFF) escape sequences
+ * @param input The string containing escape sequences to decode
+ * @returns The decoded string with escape sequences converted to their
+ * corresponding characters
+ * @throws Error if an invalid escape sequence is encountered
+ */
+export declare function decodeEscapeSequences(input: string): string;
+export declare function encodeEscapeSequences(input: string): string;
+/**
+ * Sort an array of strings using the locale-aware collation algorithm.
+ *
+ * @param arr The array of strings to sort. The original array **is sorted in
+ * place**.
+ */
+export declare function sortByLocale(arr: string[], locales?: Intl.LocalesArgument, options?: Intl.CollatorOptions): string[];
+/**
+ * Sort an array of objects using the locale-aware collation algorithm.
+ *
+ * @param arr The array of objects to sort.
+ * @param fn The function to extract the key to sort by from each object.
+ * @param locales The locales to use for sorting.
+ * @param options The collation options to use for sorting.
+ */
+export declare function sortObjectsByLocale<T>(arr: T[], fn: (key: T) => string, locales?: Intl.LocalesArgument, options?: Intl.CollatorOptions): T[];
+//# sourceMappingURL=string.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../../src/string.ts"],"names":[],"mappings":"AAEA,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAExD;AAED,wBAAgB,GAAG,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAE1C;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAE1D;AAED;;GAEG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,SAAS,CAE1D;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAE7D;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAiB3D;AAID,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAU3D;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAC1B,GAAG,EAAE,MAAM,EAAE,EACb,OAAO,CAAC,EAAE,IAAI,CAAC,eAAe,EAC9B,OAAO,CAAC,EAAE,IAAI,CAAC,eAAe,GAC7B,MAAM,EAAE,CAEV;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EACnC,GAAG,EAAE,CAAC,EAAE,EACR,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,MAAM,EACtB,OAAO,CAAC,EAAE,IAAI,CAAC,eAAe,EAC9B,OAAO,CAAC,EAAE,IAAI,CAAC,eAAe,GAC7B,CAAC,EAAE,CAEL"}