@photostructure/fs-metadata 0.4.0 → 0.5.1

package/src/windows/hidden.cpp

@@ -66,10 +66,16 @@ class GetHiddenWorker : public Napi::AsyncWorker {
 
 public:
   GetHiddenWorker(Napi::Env env, std::string p, Napi::Promise::Deferred def)
-      : Napi::AsyncWorker(env), path(std::move(p)), deferred(std::move(def)) {}
+      : Napi::AsyncWorker(env), path(std::move(p)), deferred(def) {}
 
   void Execute() override {
     try {
+      // Add path validation to prevent directory traversal
+      if (path.find("..") != std::string::npos) {
+        throw FSException("Invalid path containing '..'",
+                          ERROR_INVALID_PARAMETER);
+      }
+
       auto wpath = PathConverter::ToWString(path);
       FileAttributeHandler handler(wpath);
       result = handler.isHidden();
@@ -80,9 +86,15 @@ public:
     }
   }
 
-  void OnOK() override { deferred.Resolve(Napi::Boolean::New(Env(), result)); }
+  void OnOK() override {
+    Napi::HandleScope scope(Env());
+    deferred.Resolve(Napi::Boolean::New(Env(), result));
+  }
 
-  void OnError(const Napi::Error &e) override { deferred.Reject(e.Value()); }
+  void OnError(const Napi::Error &e) override {
+    Napi::HandleScope scope(Env());
+    deferred.Reject(e.Value());
+  }
 };
 
 class SetHiddenWorker : public Napi::AsyncWorker {
@@ -93,11 +105,16 @@ class SetHiddenWorker : public Napi::AsyncWorker {
 public:
   SetHiddenWorker(Napi::Env env, std::string p, bool v,
                   Napi::Promise::Deferred def)
-      : Napi::AsyncWorker(env), path(std::move(p)), value(v),
-        deferred(std::move(def)) {}
+      : Napi::AsyncWorker(env), path(std::move(p)), value(v), deferred(def) {}
 
   void Execute() override {
     try {
+      // Add path validation to prevent directory traversal
+      if (path.find("..") != std::string::npos) {
+        throw FSException("Invalid path containing '..'",
+                          ERROR_INVALID_PARAMETER);
+      }
+
       auto wpath = PathConverter::ToWString(path);
       FileAttributeHandler handler(wpath);
       handler.setHidden(value);
@@ -108,9 +125,15 @@ public:
     }
   }
 
-  void OnOK() override { deferred.Resolve(Napi::Boolean::New(Env(), true)); }
+  void OnOK() override {
+    Napi::HandleScope scope(Env());
+    deferred.Resolve(Napi::Boolean::New(Env(), true));
+  }
 
-  void OnError(const Napi::Error &e) override { deferred.Reject(e.Value()); }
+  void OnError(const Napi::Error &e) override {
+    Napi::HandleScope scope(Env());
+    deferred.Reject(e.Value());
+  }
 };
 
 Napi::Promise GetHiddenAttribute(const Napi::CallbackInfo &info) {
@@ -123,8 +146,7 @@ Napi::Promise GetHiddenAttribute(const Napi::CallbackInfo &info) {
     }
 
     std::string path = info[0].As<Napi::String>();
-    auto *worker =
-        new GetHiddenWorker(env, std::move(path), std::move(deferred));
+    auto *worker = new GetHiddenWorker(env, std::move(path), deferred);
     worker->Queue();
 
     return deferred.Promise();
@@ -146,8 +168,7 @@ Napi::Promise SetHiddenAttribute(const Napi::CallbackInfo &info) {
     std::string path = info[0].As<Napi::String>();
     bool value = info[1].As<Napi::Boolean>();
 
-    auto *worker =
-        new SetHiddenWorker(env, std::move(path), value, std::move(deferred));
+    auto *worker = new SetHiddenWorker(env, std::move(path), value, deferred);
     worker->Queue();
 
     return deferred.Promise();

package/src/windows/volume_metadata.cpp

@@ -24,11 +24,20 @@ class WNetConnection {
 
 public:
   explicit WNetConnection(const std::string &path)
-      : drivePath(path.substr(0, 2)), bufferSize(BUFFER_SIZE),
-        buffer(std::make_unique<char[]>(BUFFER_SIZE)) {
+      : drivePath(path.substr(0, 2)), bufferSize(MAX_PATH) {
+
+    // Allocate initial buffer
+    buffer = std::make_unique<char[]>(bufferSize);
 
     DWORD result =
         WNetGetConnectionA(drivePath.c_str(), buffer.get(), &bufferSize);
+
+    if (result == ERROR_MORE_DATA) {
+      // bufferSize now contains the required size
+      buffer = std::make_unique<char[]>(bufferSize);
+      result = WNetGetConnectionA(drivePath.c_str(), buffer.get(), &bufferSize);
+    }
+
     isValid = (result == NO_ERROR);
   }
 
@@ -70,8 +79,9 @@ inline std::string GetVolumeGUID(const std::string &mountPoint) {
 
 // RAII wrapper for volume information
 class VolumeInfo {
-  char volumeName[BUFFER_SIZE];
-  char fstype[BUFFER_SIZE];
+  static constexpr DWORD VOLUME_NAME_SIZE = MAX_PATH + 1; // 261 characters
+  char volumeName[VOLUME_NAME_SIZE];
+  char fstype[VOLUME_NAME_SIZE];
   DWORD serialNumber;
   DWORD maxComponentLen;
   DWORD fsFlags;
@@ -79,9 +89,9 @@ class VolumeInfo {
 
 public:
   explicit VolumeInfo(const std::string &mountPoint) {
-    valid = GetVolumeInformationA(mountPoint.c_str(), volumeName, BUFFER_SIZE,
-                                  &serialNumber, &maxComponentLen, &fsFlags,
-                                  fstype, BUFFER_SIZE);
+    valid = GetVolumeInformationA(
+        mountPoint.c_str(), volumeName, VOLUME_NAME_SIZE, &serialNumber,
+        &maxComponentLen, &fsFlags, fstype, VOLUME_NAME_SIZE);
 
     if (!valid && GetLastError() != ERROR_NOT_READY) {
       throw FSException("GetVolumeInformation", GetLastError());

package/tsup.config.ts

@@ -1,9 +1,15 @@
 import { defineConfig } from "tsup";
 
 export default defineConfig({
+  entry: ["src/index.ts"],
+  format: ["cjs", "esm"],
+  dts: true, // Generate .d.ts files automatically
+  clean: true, // Clean dist before each build
+  sourcemap: true,
   outExtension: ({ format }) => ({
     js: format === "cjs" ? ".cjs" : ".mjs", // Use .cjs for CommonJS and .mjs for ESM
   }),
-  shims: true,
-  sourcemap: true,
+  shims: true, // Inject CJS shims (__dirname, __filename) in ESM output
+  target: "es2022", // Align with TypeScript target
+  tsconfig: "tsconfig.build.json", // Use a single tsconfig for building
 });

package/dist/types/array.d.ts

@@ -1,25 +0,0 @@
-/**
- * Remove duplicate elements from an array.
- *
- * - Primitive values are compared using strict equality.
- * - Objects and arrays are compared by reference.
- *
- * @return A new array with duplicate elements removed
- */
-export declare function uniq<T>(arr: T[]): T[];
-/**
- * Remove duplicate elements from an array based on a key function.
- * @param keyFn A function that returns a key for each element. Elements that
- * the key function returns nullish will be removed from the returned array.
- * @return a new array omitting duplicate elements based on a key function.
- */
-export declare function uniqBy<T, K>(arr: T[], keyFn: (item: T) => K | undefined): T[];
-/**
- * @return an array of specified length, with each element created by calling
- * the provided function.
- */
-export declare function times<T>(length: number, fn: (index: number) => T): T[];
-/**
- * @return a new array with elements that are not `null` or `undefined`.
- */
-export declare function compact<T>(arr: (T | null | undefined)[] | undefined): T[];

package/dist/types/async.d.ts

@@ -1,42 +0,0 @@
-/**
- * An error that is thrown when a promise does not resolve within the specified
- * time.
- */
-export declare class TimeoutError extends Error {
-    constructor(message: string, captureStackTrace?: boolean);
-}
-/**
- * Rejects the promise with a TimeoutError if it does not resolve within the
- * specified time.
- *
- * @param promise The promise to wrap.
- * @param timeoutMs The timeout in milliseconds. Timeouts are disabled if this is 0.
- * @returns A promise that resolves when the input promise resolves, or rejects
- * with a TimeoutError if the input promise does not resolve within the
- * specified time.
- * @throws {TimeoutError} if the input promise does not resolve within the
- * specified time.
- * @throws {TypeError} if timeoutMs is not a number that is greater than 0.
- */
-export declare function withTimeout<T>(opts: {
-    desc?: string;
-    promise: Promise<T>;
-    timeoutMs: number;
-}): Promise<T>;
-/**
- * Delay for the specified number of milliseconds.
- *
- * @param ms The number of milliseconds to delay
- * @param t Optional value to resolve with after delay
- * @returns Promise that resolves with the provided value (or void if none provided)
- */
-export declare function delay<T = void>(ms: number, t?: T): Promise<T>;
-/**
- * Apply `fn` to every item in `items` with a maximum concurrency of
- * `maxConcurrency`.
- */
-export declare function mapConcurrent<I, O>({ items, fn, maxConcurrency, }: {
-    items: I[];
-    fn: (t: I) => Promise<O>;
-    maxConcurrency?: number;
-}): Promise<(O | Error)[]>;

package/dist/types/debuglog.d.ts

@@ -1,3 +0,0 @@
-export declare const debugLogContext: () => string;
-export declare const isDebugEnabled: () => boolean;
-export declare function debug(msg: string, ...args: unknown[]): void;

package/dist/types/defer.d.ts

@@ -1,10 +0,0 @@
-export type Defer<T> = (() => T) & {
-    reset: () => void;
-};
-/**
- * Creates a deferred value that is computed once on first access and cached for
- * subsequent accesses.
- * @param thunk A function that takes no arguments and returns a value
- * @returns A function that returns the computed value
- */
-export declare function defer<T>(thunk: () => T): Defer<T>;

package/dist/types/dirname.d.ts

@@ -1 +0,0 @@
-export declare function _dirname(): string;

package/dist/types/error.d.ts

@@ -1,17 +0,0 @@
-export declare class WrappedError extends Error {
-    errno?: number;
-    code?: string;
-    syscall?: string;
-    path?: string;
-    constructor(context: string, options?: {
-        name?: string;
-        cause?: unknown;
-        errno?: number;
-        code?: string;
-        syscall?: string;
-        path?: string;
-    });
-    get details(): Record<string, unknown>;
-    toString(): string;
-}
-export declare function toError(cause: unknown): Error;

package/dist/types/fs.d.ts

@@ -1,22 +0,0 @@
-import { type PathLike, type StatOptions, Stats } from "node:fs";
-/**
- * Wrapping node:fs/promises.stat() so we can mock it in tests.
- */
-export declare function statAsync(path: PathLike, options?: StatOptions & {
-    bigint?: false;
-}): Promise<Stats>;
-export declare function canStatAsync(path: string): Promise<boolean>;
-/**
- * @return true if `path` exists and is a directory
- */
-export declare function isDirectory(path: string): Promise<boolean>;
-/**
- * @return the first directory containing `file` or an empty string
- */
-export declare function findAncestorDir(dir: string, file: string): Promise<string | undefined>;
-export declare function existsSync(path: string): boolean;
-/**
- * @return `true` if `dir` exists and is a directory and at least one entry can be read.
- * @throws {Error} if `dir` does not exist or is not a directory or cannot be read.
- */
-export declare function canReaddir(dir: string, timeoutMs: number): Promise<true>;

package/dist/types/glob.d.ts

@@ -1,17 +0,0 @@
-/**
- * Compiles an array of glob patterns into a single regular expression.
- *
- * The function supports the following patterns:
- * - `**` matches any number of directories.
- * - `*` matches any number of characters except for `/`.
- * - `?` matches exactly one character except for `/`.
- * - `.` is escaped to match a literal period.
- * - `/` at the end of the pattern matches either a slash or the end of the string.
- * - Other regex special characters are escaped.
- *
- * @param patterns - An array of glob patterns to compile.
- * @returns A `RegExp` object that matches any of the provided patterns.
- */
-export declare function compileGlob(patterns: string[] | readonly string[] | undefined): RegExp;
-export declare const AlwaysMatchRE: RegExp;
-export declare const NeverMatchRE: RegExp;

package/dist/types/hidden.d.ts

@@ -1,29 +0,0 @@
-import type { HiddenMetadata } from "./types/hidden_metadata.js";
-import type { NativeBindingsFn } from "./types/native_bindings.js";
-export declare const LocalSupport: {
-    dotPrefix: boolean;
-    systemFlag: boolean;
-};
-/**
- * Checks if the file or directory is hidden through any available method
- * @returns A boolean indicating if the item is hidden
- * @throws {Error} If the file doesn't exist or permissions are insufficient
- */
-export declare function isHiddenImpl(pathname: string, nativeFn: NativeBindingsFn): Promise<boolean>;
-export declare function isHiddenRecursiveImpl(path: string, nativeFn: NativeBindingsFn): Promise<boolean>;
-export declare function createHiddenPosixPath(pathname: string, hidden: boolean): string;
-/**
- * Gets detailed information about the hidden state of the file or directory
- * @returns An object containing detailed hidden state information
- * @throws {Error} If the file doesn't exist or permissions are insufficient
- */
-export declare function getHiddenMetadataImpl(pathname: string, nativeFn: NativeBindingsFn): Promise<HiddenMetadata>;
-export type HideMethod = "dotPrefix" | "systemFlag" | "all" | "auto";
-export type SetHiddenResult = {
-    pathname: string;
-    actions: {
-        dotPrefix: boolean;
-        systemFlag: boolean;
-    };
-};
-export declare function setHiddenImpl(pathname: string, hide: boolean, method: HideMethod, nativeFn: NativeBindingsFn): Promise<SetHiddenResult>;

package/dist/types/index.d.ts

@@ -1,91 +0,0 @@
-import type { HideMethod, SetHiddenResult } from "./hidden.js";
-import { IncludeSystemVolumesDefault, LinuxMountTablePathsDefault, OptionsDefault, optionsWithDefaults, SystemFsTypesDefault, SystemPathPatternsDefault, TimeoutMsDefault } from "./options.js";
-import type { StringEnum, StringEnumKeys, StringEnumType } from "./string_enum.js";
-import type { SystemVolumeConfig } from "./system_volume.js";
-import type { HiddenMetadata } from "./types/hidden_metadata.js";
-import type { MountPoint } from "./types/mount_point.js";
-import type { Options } from "./types/options.js";
-import type { VolumeMetadata } from "./types/volume_metadata.js";
-import type { VolumeHealthStatus } from "./volume_health_status.js";
-import { VolumeHealthStatuses } from "./volume_health_status.js";
-import type { GetVolumeMountPointOptions } from "./volume_mount_points.js";
-export type { GetVolumeMountPointOptions, HiddenMetadata, HideMethod, MountPoint, Options, SetHiddenResult, StringEnum, StringEnumKeys, StringEnumType, SystemVolumeConfig, VolumeHealthStatus, VolumeMetadata, };
-/**
- * List all active local and remote mount points on the system.
- *
- * Only readable directories are included in the results.
- *
- * Note that on Windows, `timeoutMs` will be used **per system call** and not
- * for the entire operation.
- *
- * @param opts Optional filesystem operation settings to override default values
- */
-export declare function getVolumeMountPoints(opts?: Partial<GetVolumeMountPointOptions>): Promise<MountPoint[]>;
-/**
- * Get metadata for the volume at the given mount point.
- *
- * @param mountPoint Must be a non-blank string
- * @param opts Optional filesystem operation settings
- */
-export declare function getVolumeMetadata(mountPoint: string, opts?: Partial<Pick<Options, "timeoutMs">>): Promise<VolumeMetadata>;
-/**
- * Retrieves metadata for all mounted volumes with optional filtering and
- * concurrency control.
- *
- * @param opts - Optional configuration object
- * @param opts.includeSystemVolumes - If true, includes system volumes in the
- * results. Defaults to true on Windows and false elsewhere.
- * @param opts.maxConcurrency - Maximum number of concurrent operations.
- * Defaults to the system's available parallelism: see
- * {@link https://nodejs.org/api/os.html#osavailableparallelism | os.availableParallelism()}
- * @param opts.timeoutMs - Maximum time to wait for
- * {@link getVolumeMountPointsImpl}, as well as **each** {@link getVolumeMetadataImpl}
- * to complete. Defaults to {@link TimeoutMsDefault}
- * @returns Promise that resolves to an array of either VolumeMetadata objects
- * or error objects containing the mount point and error
- * @throws Never - errors are caught and returned as part of the result array
- */
-export declare function getAllVolumeMetadata(opts?: Partial<Options> & {
-    includeSystemVolumes?: boolean;
-}): Promise<VolumeMetadata[]>;
-/**
- * Check if a file or directory is hidden.
- *
- * Note that `path` may be _effectively_ hidden if any of the ancestor
- * directories are hidden: use {@link isHiddenRecursive} to check for this.
- *
- * @param pathname Path to file or directory
- * @returns Promise resolving to boolean indicating hidden state
- */
-export declare function isHidden(pathname: string): Promise<boolean>;
-/**
- * Check if a file or directory is hidden, or if any of its ancestor
- * directories are hidden.
- *
- * @param pathname Path to file or directory
- * @returns Promise resolving to boolean indicating hidden state
- */
-export declare function isHiddenRecursive(pathname: string): Promise<boolean>;
-/**
- * Get detailed metadata about the hidden state of a file or directory.
- *
- * @param pathname Path to file or directory
- * @returns Promise resolving to metadata about the hidden state
- */
-export declare function getHiddenMetadata(pathname: string): Promise<HiddenMetadata>;
-/**
- * Set the hidden state of a file or directory
- *
- * @param pathname Path to file or directory
- * @param hidden - Whether the item should be hidden (true) or visible (false)
- * @param method Method to use for hiding the file or directory. The default
- * is "auto", which is "dotPrefix" on Linux and macOS, and "systemFlag" on
- * Windows. "all" will attempt to use all relevant methods for the current
- * operating system.
- * @returns Promise resolving the final name of the file or directory (as it
- * will change on POSIX systems), and the action(s) taken.
- * @throws {Error} If the file doesn't exist, permissions are insufficient, or
- * the requested method is unsupported
- */
-export declare function setHidden(pathname: string, hidden: boolean, method?: HideMethod): Promise<SetHiddenResult>;
-export { IncludeSystemVolumesDefault, LinuxMountTablePathsDefault, OptionsDefault, optionsWithDefaults, SystemFsTypesDefault, SystemPathPatternsDefault, TimeoutMsDefault, VolumeHealthStatuses, };

package/dist/types/linux/dev_disk.d.ts

@@ -1,13 +0,0 @@
-/**
- * Gets the UUID from symlinks for a given device path asynchronously
- * @param devicePath The device path to look up
- * @returns Promise that resolves to the UUID if found, empty string otherwise
- */
-export declare function getUuidFromDevDisk(devicePath: string): Promise<string | undefined>;
-/**
- * Gets the label from symlinks for a given device path asynchronously
- * @param devicePath The device path to look up
- * @returns Promise that resolves to the label if found, empty string otherwise
- */
-export declare function getLabelFromDevDisk(devicePath: string): Promise<string | undefined>;
-export declare function getBasenameLinkedTo(linkDir: string, linkPath: string): Promise<string | undefined>;

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

@@ -1,6 +0,0 @@
-import { type MountPoint } from "../types/mount_point.js";
-import type { NativeBindingsFn } from "../types/native_bindings.js";
-import type { Options } from "../types/options.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>;

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

@@ -1,47 +0,0 @@
-import { SystemVolumeConfig } from "../system_volume.js";
-import type { MountPoint } from "../types/mount_point.js";
-import type { VolumeMetadata } from "../types/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;

package/dist/types/mount_point.d.ts

@@ -1,2 +0,0 @@
-import { MountPoint } from "./types/mount_point";
-export declare function isMountPoint(obj: unknown): obj is MountPoint;

package/dist/types/number.d.ts

@@ -1,3 +0,0 @@
-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;

package/dist/types/object.d.ts

@@ -1,18 +0,0 @@
-/**
- * @return true iff value is an object and not an array
- */
-export declare function isObject(value: unknown): value is object;
-/**
- * @return undefined if `obj` is nullish, or the return value of `fn` applied
- * against `obj` if `obj` is defined
- */
-export declare function map<T, U>(obj: T | undefined, fn: (value: T) => U): U | undefined;
-/**
- * @return a shallow copy of `obj` that omits the specified `keys`
- */
-export declare function omit<T extends object, K extends keyof T>(obj: T, ...keys: K[]): Omit<T, K>;
-/**
- * @return a shallow copy of `obj` that only includes fields that are defined
- * and not nullish or blank.
- */
-export declare function compactValues<T extends object>(obj: T | undefined): Partial<T>;

package/dist/types/options.d.ts

@@ -1,33 +0,0 @@
-import type { Options } from "./types/options.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.
- */
-export declare const TimeoutMsDefault: 5000;
-/**
- * System paths and globs that indicate system volumes
- */
-export declare const SystemPathPatternsDefault: readonly ["/boot", "/boot/efi", "/dev", "/dev/**", "/proc/**", "/run", "/run/credentials/**", "/run/lock", "/run/snapd/**", "/run/user/*/doc", "/run/user/*/gvfs", "/snap/**", "/sys/**", "/tmp", "/var/tmp", "**/#snapshot", "/mnt/wslg/distro", "/mnt/wslg/doc", "/mnt/wslg/versions.txt", "/usr/lib/wsl/drivers", "/private/var/vm", "/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
- */
-export declare const SystemFsTypesDefault: readonly ["autofs", "binfmt_misc", "cgroup", "cgroup2", "configfs", "debugfs", "devpts", "devtmpfs", "efivarfs", "fusectl", "fuse.snapfuse", "hugetlbfs", "mqueue", "none", "proc", "pstore", "rootfs", "securityfs", "snap*", "squashfs", "sysfs", "tmpfs"];
-export declare const LinuxMountTablePathsDefault: readonly ["/proc/self/mounts", "/proc/mounts", "/etc/mtab"];
-/**
- * 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;

package/dist/types/path.d.ts

@@ -1,17 +0,0 @@
-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;

package/dist/types/platform.d.ts

@@ -1,4 +0,0 @@
-export declare const isLinux: boolean;
-export declare const isWindows: boolean;
-export declare const isMacOS: boolean;
-export declare const isArm: boolean;

package/dist/types/random.d.ts

@@ -1,12 +0,0 @@
-/**
- * @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;

package/dist/types/remote_info.d.ts

@@ -1,6 +0,0 @@
-import { RemoteInfo } from "./types/remote_info.js";
-export declare function isRemoteInfo(obj: unknown): obj is RemoteInfo;
-export declare function normalizeFsType(fstype: 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;

package/dist/types/stack_path.d.ts

@@ -1,2 +0,0 @@
-export declare function getCallerDirname(): string;
-export declare function extractCallerPath(stack: string): string;

package/dist/types/string.d.ts

@@ -1,37 +0,0 @@
-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[];