@design-edito/tools 0.3.0 → 1.0.1

package/node/cloud-storage/operations/remove-dir/index.js

@@ -1,35 +0,0 @@
-import {
-  removeDir as removeDir4
-} from "../../../../chunks/chunk-ZTPRFEPV.js";
-import {
-  removeDir as removeDir3
-} from "../../../../chunks/chunk-5X76KDYN.js";
-import {
-  removeDir as removeDir2
-} from "../../../../chunks/chunk-6YVXSCRH.js";
-import {
-  removeDir
-} from "../../../../chunks/chunk-W5VY535B.js";
-import {
-  isFtpClient,
-  isGcsBucket,
-  isS3ClientWithBucket,
-  isSftpClient
-} from "../../../../chunks/chunk-ISJONMNA.js";
-import {
-  makeFailure
-} from "../../../../chunks/chunk-QEKI6WGQ.js";
-import "../../../../chunks/chunk-FENXVJYO.js";
-import "../../../../chunks/chunk-XCBH6NLF.js";
-
-// src/node/cloud-storage/operations/remove-dir/index.ts
-async function removeDir5(client, sourcePath, options) {
-  if (isGcsBucket(client)) return removeDir4(client, sourcePath, options);
-  if (isS3ClientWithBucket(client)) return removeDir3(client.client, client.bucketName, sourcePath, options);
-  if (isFtpClient(client)) return removeDir(client, sourcePath, options);
-  if (isSftpClient(client)) return removeDir2(client, sourcePath, options);
-  return makeFailure("Invalid client type");
-}
-export {
-  removeDir5 as removeDir
-};

package/node/cloud-storage/operations/remove-file/index.d.ts

@@ -1,56 +0,0 @@
-import { Bucket as GCSBucket } from '@google-cloud/storage';
-import { Client as FtpClient } from 'basic-ftp';
-import SftpClient from 'ssh2-sftp-client';
-import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
-import { S3ClientWithBucket } from '../../clients/index.js';
-import { RemoveOptions as FtpRemoveOptions } from '../../../ftps/file/remove/index.js';
-import { RemoveOptions as SftpRemoveOptions } from '../../../sftp/file/remove/index.js';
-import { RemoveOptions as S3RemoveOptions } from '../../../@aws-s3/storage/file/remove/index.js';
-import { RemoveOptions as GcsRemoveOptions } from '../../../@google-cloud/storage/file/remove/index.js';
-/** Return type for remove file operations. */
-type Returned = Outcome.Either<true, string>;
-/**
- * Removes a file from a Google Cloud Storage bucket.
- *
- * @param {GCSBucket} client               - The Google Cloud Storage bucket instance.
- * @param {string}   path                 - The file path to remove.
- * @param {GcsRemoveOptions} [options]     - Optional remove configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
- * - On success:  `Outcome.makeSuccess(true)`.
- * - On failure:  `Outcome.makeFailure(errStr)`.
- */
-export declare function removeFile(client: GCSBucket, path: string, options?: GcsRemoveOptions): Promise<Returned>;
-/**
- * Removes a file from an S3 bucket.
- *
- * @param {S3ClientWithBucket} client      - The S3 client with bucket configuration.
- * @param {string}   path                 - The file path to remove.
- * @param {S3RemoveOptions} [options]      - Optional remove configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
- * - On success:  `Outcome.makeSuccess(true)`.
- * - On failure:  `Outcome.makeFailure(errStr)`.
- */
-export declare function removeFile(client: S3ClientWithBucket, path: string, options?: S3RemoveOptions): Promise<Returned>;
-/**
- * Removes a file from an FTP server.
- *
- * @param {FtpClient} client               - The FTP client instance.
- * @param {string}   path                 - The file path to remove.
- * @param {FtpRemoveOptions} [options]     - Optional remove configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
- * - On success:  `Outcome.makeSuccess(true)`.
- * - On failure:  `Outcome.makeFailure(errStr)`.
- */
-export declare function removeFile(client: FtpClient, path: string, options?: FtpRemoveOptions): Promise<Returned>;
-/**
- * Removes a file from an SFTP server.
- *
- * @param {SftpClient} client              - The SFTP client instance.
- * @param {string}   path                 - The file path to remove.
- * @param {SftpRemoveOptions} [options]    - Optional remove configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
- * - On success:  `Outcome.makeSuccess(true)`.
- * - On failure:  `Outcome.makeFailure(errStr)`.
- */
-export declare function removeFile(client: SftpClient, path: string, options?: SftpRemoveOptions): Promise<Returned>;
-export {};

package/node/cloud-storage/operations/remove-file/index.js

@@ -1,35 +0,0 @@
-import {
-  remove as remove4
-} from "../../../../chunks/chunk-66BURDRK.js";
-import {
-  remove as remove3
-} from "../../../../chunks/chunk-BQXTV2GG.js";
-import {
-  remove as remove2
-} from "../../../../chunks/chunk-BHGRXDTS.js";
-import {
-  remove
-} from "../../../../chunks/chunk-S2I77NEE.js";
-import {
-  isFtpClient,
-  isGcsBucket,
-  isS3ClientWithBucket,
-  isSftpClient
-} from "../../../../chunks/chunk-ISJONMNA.js";
-import {
-  makeFailure
-} from "../../../../chunks/chunk-QEKI6WGQ.js";
-import "../../../../chunks/chunk-FENXVJYO.js";
-import "../../../../chunks/chunk-XCBH6NLF.js";
-
-// src/node/cloud-storage/operations/remove-file/index.ts
-async function removeFile(client, path, options) {
-  if (isGcsBucket(client)) return remove4(client, path, options);
-  if (isS3ClientWithBucket(client)) return remove3(client.client, path, client.bucketName, options);
-  if (isFtpClient(client)) return remove(client, path, options);
-  if (isSftpClient(client)) return remove2(client, path, options);
-  return makeFailure("Invalid client type");
-}
-export {
-  removeFile
-};

package/node/cloud-storage/operations/stat-file/index.d.ts

@@ -1,54 +0,0 @@
-import { Bucket as GCSBucket } from '@google-cloud/storage';
-import { Client as FtpClient } from 'basic-ftp';
-import SftpClient from 'ssh2-sftp-client';
-import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
-import { S3ClientWithBucket } from '../../clients/index.js';
-import { Stat as FtpStat } from '../../../ftps/file/stat/index.js';
-import { Stat as SftpStat } from '../../../sftp/file/stat/index.js';
-import { Stat as S3Stat, StatOptions as S3StatOptions } from '../../../@aws-s3/storage/file/stat/index.js';
-import { Stat as GcsStat, StatOptions as GcsStatOptions } from '../../../@google-cloud/storage/file/stat/index.js';
-/** Return type for stat file operations. */
-type Returned<K extends FtpStat | SftpStat | S3Stat | GcsStat> = Outcome.Either<K, string>;
-/**
- * Retrieves metadata for a file in a Google Cloud Storage bucket.
- *
- * @param {GCSBucket} client              - The Google Cloud Storage bucket instance.
- * @param {string}   path                 - The file path to stat.
- * @param {GcsStatOptions} [options]       - Optional stat configuration.
- * @returns {Promise<Outcome.Either<GcsStat, string>>}
- * - On success:  `Outcome.makeSuccess(stat)` containing file metadata.
- * - On failure:  `Outcome.makeFailure(errStr)`.
- */
-export declare function statFile(client: GCSBucket, path: string, options?: GcsStatOptions): Promise<Returned<GcsStat>>;
-/**
- * Retrieves metadata for a file in an S3 bucket.
- *
- * @param {S3ClientWithBucket} client      - The S3 client with bucket configuration.
- * @param {string}   path                 - The file path to stat.
- * @param {S3StatOptions} [options]        - Optional stat configuration.
- * @returns {Promise<Outcome.Either<S3Stat, string>>}
- * - On success:  `Outcome.makeSuccess(stat)` containing file metadata.
- * - On failure:  `Outcome.makeFailure(errStr)`.
- */
-export declare function statFile(client: S3ClientWithBucket, path: string, options?: S3StatOptions): Promise<Returned<S3Stat>>;
-/**
- * Retrieves metadata for a file on an FTP server.
- *
- * @param {FtpClient} client              - The FTP client instance.
- * @param {string}   path                 - The file path to stat.
- * @returns {Promise<Outcome.Either<FtpStat, string>>}
- * - On success:  `Outcome.makeSuccess(stat)` containing file metadata.
- * - On failure:  `Outcome.makeFailure(errStr)`.
- */
-export declare function statFile(client: FtpClient, path: string): Promise<Returned<FtpStat>>;
-/**
- * Retrieves metadata for a file on an SFTP server.
- *
- * @param {SftpClient} client             - The SFTP client instance.
- * @param {string}   path                 - The file path to stat.
- * @returns {Promise<Outcome.Either<SftpStat, string>>}
- * - On success:  `Outcome.makeSuccess(stat)` containing file metadata.
- * - On failure:  `Outcome.makeFailure(errStr)`.
- */
-export declare function statFile(client: SftpClient, path: string): Promise<Returned<SftpStat>>;
-export {};

package/node/cloud-storage/operations/stat-file/index.js

@@ -1,35 +0,0 @@
-import {
-  stat as stat4
-} from "../../../../chunks/chunk-FSI422YG.js";
-import {
-  stat as stat3
-} from "../../../../chunks/chunk-AXMAF3J2.js";
-import {
-  stat as stat2
-} from "../../../../chunks/chunk-EEPLTO3E.js";
-import {
-  stat
-} from "../../../../chunks/chunk-BQABPH3I.js";
-import {
-  isFtpClient,
-  isGcsBucket,
-  isS3ClientWithBucket,
-  isSftpClient
-} from "../../../../chunks/chunk-ISJONMNA.js";
-import {
-  makeFailure
-} from "../../../../chunks/chunk-QEKI6WGQ.js";
-import "../../../../chunks/chunk-FENXVJYO.js";
-import "../../../../chunks/chunk-XCBH6NLF.js";
-
-// src/node/cloud-storage/operations/stat-file/index.ts
-async function statFile(client, path, options) {
-  if (isGcsBucket(client)) return stat4(client, path, options);
-  if (isS3ClientWithBucket(client)) return stat3(client.client, path, client.bucketName, options);
-  if (isFtpClient(client)) return stat(client, path);
-  if (isSftpClient(client)) return stat2(client, path);
-  return makeFailure("Invalid client type");
-}
-export {
-  statFile
-};

package/node/cloud-storage/operations/upload-file/index.d.ts

@@ -1,61 +0,0 @@
-import { Readable } from 'node:stream';
-import { Bucket as GCSBucket } from '@google-cloud/storage';
-import { Client as FtpClient } from 'basic-ftp';
-import SftpClient from 'ssh2-sftp-client';
-import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
-import { S3ClientWithBucket } from '../../clients/index.js';
-import { UploadOptions as FtpUploadOptions } from '../../../ftps/file/upload/index.js';
-import { UploadOptions as SftpUploadOptions } from '../../../sftp/file/upload/index.js';
-import { UploadOptions as S3UploadOptions } from '../../../@aws-s3/storage/file/upload/index.js';
-import { UploadOptions as GcsUploadOptions } from '../../../@google-cloud/storage/file/upload/index.js';
-/** Return type for upload file operations. */
-type Returned = Outcome.Either<true, string>;
-/**
- * Uploads a file stream to a Google Cloud Storage bucket.
- *
- * @param {Readable} fileStream           - The file content as a stream.
- * @param {string}   path                 - The path to upload the file to.
- * @param {GCSBucket} client              - The Google Cloud Storage bucket instance.
- * @param {GcsUploadOptions} [options]     - Optional upload configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
- * - On success:  `Outcome.makeSuccess(true)`.
- * - On failure:  `Outcome.makeFailure(errStr)`.
- */
-export declare function uploadFile(fileStream: Readable, path: string, client: GCSBucket, options?: GcsUploadOptions): Promise<Returned>;
-/**
- * Uploads a file stream to an S3 bucket.
- *
- * @param {Readable} fileStream           - The file content as a stream.
- * @param {string}   path                 - The path to upload the file to.
- * @param {S3ClientWithBucket} client     - The S3 client with bucket configuration.
- * @param {S3UploadOptions} [options]      - Optional upload configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
- * - On success:  `Outcome.makeSuccess(true)`.
- * - On failure:  `Outcome.makeFailure(errStr)`.
- */
-export declare function uploadFile(fileStream: Readable, path: string, client: S3ClientWithBucket, options?: S3UploadOptions): Promise<Returned>;
-/**
- * Uploads a file stream to an FTP server.
- *
- * @param {Readable} fileStream           - The file content as a stream.
- * @param {string}   path                 - The path to upload the file to.
- * @param {FtpClient} client              - The FTP client instance.
- * @param {FtpUploadOptions} [options]     - Optional upload configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
- * - On success:  `Outcome.makeSuccess(true)`.
- * - On failure:  `Outcome.makeFailure(errStr)`.
- */
-export declare function uploadFile(fileStream: Readable, path: string, client: FtpClient, options?: FtpUploadOptions): Promise<Returned>;
-/**
- * Uploads a file stream to an SFTP server.
- *
- * @param {Readable} fileStream           - The file content as a stream.
- * @param {string}   path                 - The path to upload the file to.
- * @param {SftpClient} client             - The SFTP client instance.
- * @param {SftpUploadOptions} [options]   - Optional upload configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
- * - On success:  `Outcome.makeSuccess(true)`.
- * - On failure:  `Outcome.makeFailure(errStr)`.
- */
-export declare function uploadFile(fileStream: Readable, path: string, client: SftpClient, options?: SftpUploadOptions): Promise<Returned>;
-export {};

package/node/cloud-storage/operations/upload-file/index.js

@@ -1,35 +0,0 @@
-import {
-  upload as upload4
-} from "../../../../chunks/chunk-UZ4SWSOZ.js";
-import {
-  upload as upload3
-} from "../../../../chunks/chunk-FM3HGCFL.js";
-import {
-  upload as upload2
-} from "../../../../chunks/chunk-Y6FD4ASO.js";
-import {
-  upload
-} from "../../../../chunks/chunk-AOEOW5XW.js";
-import {
-  isFtpClient,
-  isGcsBucket,
-  isS3ClientWithBucket,
-  isSftpClient
-} from "../../../../chunks/chunk-ISJONMNA.js";
-import {
-  makeFailure
-} from "../../../../chunks/chunk-QEKI6WGQ.js";
-import "../../../../chunks/chunk-FENXVJYO.js";
-import "../../../../chunks/chunk-XCBH6NLF.js";
-
-// src/node/cloud-storage/operations/upload-file/index.ts
-async function uploadFile(fileStream, path, client, options) {
-  if (isGcsBucket(client)) return upload4(client, path, fileStream, options);
-  if (isS3ClientWithBucket(client)) return upload3(client.client, client.bucketName, path, fileStream, options);
-  if (isFtpClient(client)) return upload(client, path, fileStream, options);
-  if (isSftpClient(client)) return upload2(client, path, fileStream, options);
-  return makeFailure("Invalid client type");
-}
-export {
-  uploadFile
-};

package/node/encryption/@aes-256-gcm/buffer/index.d.ts

@@ -1,20 +0,0 @@
-import { Buffer } from 'node:buffer';
-import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
-/**
- * Encrypts a `Buffer` by converting it to a `Uint8Array`, performing encryption, and then returning the result as a `Buffer`.
- *
- * @param {Buffer} inputBuffer - The input data to encrypt.
- * @param {string} encryptionKey - The encryption key to use.
- *
- * @returns {Outcome.Either<Buffer, string>} The result of the encryption. Success returns the encrypted data as a `Buffer` (with IV prepended), or failure returns an error message.
- */
-export declare function encrypt(inputBuffer: Buffer, encryptionKey: string): Outcome.Either<Buffer, string>;
-/**
- * Decrypts an encrypted `Buffer` by converting it to a `Uint8Array`, performing decryption, and then returning the result as a `Buffer`.
- *
- * @param {Buffer} encryptedBuffer - The encrypted data to decrypt.
- * @param {string} encryptionKey - The encryption key to use.
- *
- * @returns {Outcome.Either<Buffer, string>} The result of the decryption. Success returns the decrypted data as a `Buffer`, or failure returns an error message.
- */
-export declare function decrypt(encryptedBuffer: Buffer, encryptionKey: string): Outcome.Either<Buffer, string>;

package/node/encryption/@aes-256-gcm/buffer/index.js

@@ -1,28 +0,0 @@
-import {
-  decryptUint8Array,
-  encryptUint8Array
-} from "../../../../chunks/chunk-FH74QWR6.js";
-import {
-  makeSuccess
-} from "../../../../chunks/chunk-QEKI6WGQ.js";
-import "../../../../chunks/chunk-FENXVJYO.js";
-import "../../../../chunks/chunk-XCBH6NLF.js";
-
-// src/node/encryption/@aes-256-gcm/buffer/index.ts
-import { Buffer } from "node:buffer";
-function encrypt(inputBuffer, encryptionKey) {
-  const fileArray = new Uint8Array(inputBuffer);
-  const encryptionOutcome = encryptUint8Array(fileArray, encryptionKey);
-  if (!encryptionOutcome.success) return encryptionOutcome;
-  return makeSuccess(Buffer.from(encryptionOutcome.payload));
-}
-function decrypt(encryptedBuffer, encryptionKey) {
-  const encryptedArray = new Uint8Array(encryptedBuffer);
-  const decryptionOutcome = decryptUint8Array(encryptedArray, encryptionKey);
-  if (!decryptionOutcome.success) return decryptionOutcome;
-  return makeSuccess(Buffer.from(decryptionOutcome.payload));
-}
-export {
-  decrypt,
-  encrypt
-};

package/node/encryption/@aes-256-gcm/uint8-array/index.d.ts

@@ -1,21 +0,0 @@
-import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
-/**
- * Encrypts a `Uint8Array` using AES-256-GCM encryption and the specified encryption key.
- *
- * @param {Uint8Array} fileArray - The input data to encrypt.
- * @param {string} encryptionKey - The encryption key to use.
- * @param {number} [options.ivLength=16] - The length of the initialization vector (IV). Defaults to 16 bytes.
- *
- * @returns {Outcome.Either<Uint8Array, string>} The result of the encryption. Success returns the encrypted data as a `Uint8Array` (with IV prepended), or failure returns an error message.
- */
-export declare function encryptUint8Array(fileArray: Uint8Array, encryptionKey: string): Outcome.Either<Uint8Array, string>;
-/**
- * Decrypts an encrypted `Uint8Array` using AES-256-GCM encryption and the specified encryption key.
- *
- * @param {Uint8Array} encryptedFile - The encrypted data to decrypt.
- * @param {string} encryptionKey - The encryption key to use.
- * @param {number} [options.ivLength=16] - The length of the initialization vector (IV). Defaults to 16 bytes.
- *
- * @returns {Outcome.Either<Uint8Array, string>} The result of the decryption. Success returns the decrypted data as a `Uint8Array`, or failure returns an error message.
- */
-export declare function decryptUint8Array(encryptedFile: Uint8Array, encryptionKey: string): Outcome.Either<Uint8Array, string>;

package/node/encryption/@aes-256-gcm/uint8-array/index.js

@@ -1,11 +0,0 @@
-import {
-  decryptUint8Array,
-  encryptUint8Array
-} from "../../../../chunks/chunk-FH74QWR6.js";
-import "../../../../chunks/chunk-QEKI6WGQ.js";
-import "../../../../chunks/chunk-FENXVJYO.js";
-import "../../../../chunks/chunk-XCBH6NLF.js";
-export {
-  decryptUint8Array,
-  encryptUint8Array
-};

package/node/encryption/key/index.d.ts

@@ -1,16 +0,0 @@
-export type GenerateOptions = {
-    saltLength?: number;
-    iterations?: number;
-};
-/**
- * Generates an encryption key from a passphrase using PBKDF2.
- *
- * @param {string} passphrase - The passphrase to derive the key from.
- * @param {number} outputByteLength - The length of the output encryption key in bytes.
- * @param {GenerateOptions} [options] - Optional options.
- * @param {number} [options.saltLength=16] - The length of the salt in bytes. Defaults to 16 bytes.
- * @param {number} [options.iterations=100000] - The number of PBKDF2 iterations. Defaults to 100,000 iterations.
- *
- * @returns {string} The derived encryption key and salt, concatenated as a string in the format `salt:encryptionKey`.
- */
-export declare function generate(passphrase: string, outputByteLength: number, options?: GenerateOptions): string;

package/node/encryption/key/index.js

@@ -1,15 +0,0 @@
-import "../../../chunks/chunk-XCBH6NLF.js";
-
-// src/node/encryption/key/index.ts
-import { pbkdf2Sync, randomBytes } from "node:crypto";
-function generate(passphrase, outputByteLength, options) {
-  const { saltLength = 16, iterations = 1e5 } = options ?? {};
-  const salt = randomBytes(saltLength);
-  const key = pbkdf2Sync(passphrase, salt, iterations, outputByteLength, "sha256");
-  const saltString = salt.toString("hex");
-  const keyString = key.toString("hex");
-  return `${saltString}:${keyString}`;
-}
-export {
-  generate
-};

package/node/files/is-in-directory/index.d.ts

@@ -1,8 +0,0 @@
-/**
- * Checks whether a child path is contained within a parent directory.
- *
- * @param childPath  - The path to check if it's within the parent.
- * @param parentPath - The parent directory path.
- * @returns `true` if `childPath` is within `parentPath`, `false` otherwise.
- */
-export declare function isInDirectory(childPath: string, parentPath: string): boolean;

package/node/files/is-in-directory/index.js

@@ -1,11 +0,0 @@
-import "../../../chunks/chunk-XCBH6NLF.js";
-
-// src/node/files/is-in-directory/index.ts
-import path from "node:path";
-function isInDirectory(childPath, parentPath) {
-  const rel = path.relative(parentPath, childPath);
-  return rel !== "" && !rel.startsWith("..");
-}
-export {
-  isInDirectory
-};

package/node/files/read-write/index.d.ts

@@ -1,53 +0,0 @@
-import { promises as fs } from 'node:fs';
-type Path = Parameters<typeof fs.writeFile>[0];
-type ReadFileData = Awaited<ReturnType<typeof fs.readFile>>;
-type WriteFileData = Parameters<typeof fs.writeFile>[1];
-export type Options = {
-    /** Additional parameters forwarded to the underlying `fs.readFile`. */
-    readOptions?: Parameters<typeof fs.readFile>[1];
-    /** Additional parameters forwarded to the underlying `fs.writeFile`. */
-    writeOptions?: Parameters<typeof fs.writeFile>[2];
-    /** Output path for the edited file. If not provided, the file is written back to the original `path`. */
-    output?: Path;
-    /** If `true`, the file is not written to disk, only the edited content is returned. @default false */
-    dryRun?: boolean;
-};
-/** Function that takes the current file content and returns the edited content. */
-export type EditorFunc<T extends WriteFileData = WriteFileData> = (curr: ReadFileData) => T;
-/** Object mapping strings to replace (keys) with their replacements (values). */
-export type Replacements = Record<string, string>;
-/**
- * Reads a file, applies edits, and optionally writes it back.
- *
- * The function supports two editing modes:
- * - **Replacements mode**: Pass an object with string replacements.
- * - **Function mode**: Pass a function that transforms the file content.
- *
- * @param {Path} path                    - The path to the file to read and edit.
- * @param {Replacements} editor          - Object mapping strings to replace with their replacements.
- * @param {Options} [opts]               - Optional configuration.
- * @param {Parameters<typeof fs.readFile>[1]} [opts.readOptions]  - Extra `readFile` params.
- * @param {Parameters<typeof fs.writeFile>[2]} [opts.writeOptions] - Extra `writeFile` params.
- * @param {Path} [opts.output]           - Output path (defaults to `path`).
- * @param {boolean} [opts.dryRun=false]  - If `true`, skip writing to disk.
- * @returns {Promise<string>} The edited file content as a string.
- */
-export declare function readWrite(path: Path, editor: Replacements, opts?: Options): Promise<string>;
-/**
- * Reads a file, applies edits, and optionally writes it back.
- *
- * The function supports two editing modes:
- * - **Replacements mode**: Pass an object with string replacements.
- * - **Function mode**: Pass a function that transforms the file content.
- *
- * @param {Path} path                    - The path to the file to read and edit.
- * @param {EditorFunc<T>} editor         - Function that transforms the file content.
- * @param {Options} [opts]               - Optional configuration.
- * @param {Parameters<typeof fs.readFile>[1]} [opts.readOptions]  - Extra `readFile` params.
- * @param {Parameters<typeof fs.writeFile>[2]} [opts.writeOptions] - Extra `writeFile` params.
- * @param {Path} [opts.output]           - Output path (defaults to `path`).
- * @param {boolean} [opts.dryRun=false]  - If `true`, skip writing to disk.
- * @returns {Promise<T>} The edited file content of type `T`.
- */
-export declare function readWrite<T extends WriteFileData>(path: Path, editor: EditorFunc<T>, opts?: Options): Promise<T>;
-export {};

package/node/files/read-write/index.js

@@ -1,18 +0,0 @@
-import "../../../chunks/chunk-XCBH6NLF.js";
-
-// src/node/files/read-write/index.ts
-import { promises as fs } from "node:fs";
-async function readWrite(path, editor, opts = {}) {
-  const readData = await fs.readFile(path, opts.readOptions);
-  const edited = typeof editor === "function" ? editor(readData) : Object.entries(editor).reduce(
-    (acc, [from, to]) => acc.replaceAll(from, to),
-    readData.toString()
-  );
-  const actualWriteOptions = opts.writeOptions ?? opts.readOptions;
-  const targetOutput = opts.output === void 0 ? path : opts.output;
-  if (opts.dryRun !== true) await fs.writeFile(targetOutput, edited, actualWriteOptions);
-  return edited;
-}
-export {
-  readWrite
-};

package/node/files/subpaths/index.d.ts

@@ -1,63 +0,0 @@
-import { Stats } from 'node:fs';
-/** Type of child entry in a directory. */
-export type ChildType = 'file' | 'directory' | 'symlink';
-export type ChildDetails = {
-    /** The type of the child entry. */ type: ChildType;
-    /** Whether the child entry is hidden (starts with '.'). */ hidden: boolean;
-    /** The real path of the child entry (resolved if it's a symlink). */ realPath: string;
-};
-export type ListContext = {
-    /** Current recursion depth. */ depth?: number;
-    /** Cached lstat result for the current path. */ lstats?: Stats | null;
-    /** Root path from which the listing started. */ rootPath?: string | null;
-};
-export declare const defaultListContext: Required<ListContext>;
-/**
- * Fills missing properties in a list context with default values.
- *
- * @param {ListContext} input - The partial list context to fill.
- * @returns {Required<ListContext>} A complete list context with all properties set.
- */
-export declare const fillListContext: (input: ListContext) => Required<ListContext>;
-export type ListOptions = {
-    /** Whether to include directories in the results. @default true */ directories?: boolean;
-    /** Whether to include files in the results. @default true */ files?: boolean;
-    /** Whether to include symlinks in the results. @default true */ symlinks?: boolean;
-    /** Whether to include hidden files/directories (starting with '.'). @default true */ hidden?: boolean;
-    /** Whether to follow symlinks and include their contents. @default false */ followSimlinks?: boolean;
-    /** Whether to deduplicate paths when following symlinks. @default false */ dedupeSimlinksContents?: boolean;
-    /** Maximum recursion depth. @default Infinity */ maxDepth?: number;
-    /** Whether to return relative paths instead of absolute paths. @default false */ returnRelative?: boolean;
-    /** Patterns to exclude from the results. */ exclude?: RegExp | string | (RegExp | string)[] | null;
-    /** Patterns to include in the results (takes precedence over exclude). */ include?: RegExp | string | (RegExp | string)[] | null;
-    /** Custom filter function to further refine results. */ filter?: ((path: string, details: ChildDetails) => boolean | Promise<boolean>);
-};
-export declare const defaultListOptions: Required<ListOptions>;
-/**
- * Fills missing properties in list options with default values.
- *
- * @param {ListOptions} input - The partial list options to fill.
- * @returns {Required<ListOptions>} A complete list options object with all properties set.
- */
-export declare const fillOptions: (input: ListOptions) => Required<ListOptions>;
-/**
- * Lists all subpaths under a given directory path.
- *
- * The function recursively traverses the directory tree and returns all matching
- * files, directories, and symlinks based on the provided options.
- *
- * @param inputPath - The root directory path to list subpaths from.
- * @param [options] - Optional configuration for filtering and behavior. See `ListOptions` for details.
- * @returns Array of subpaths (absolute or relative based on `returnRelative` option).
- */
-export declare function list(...args: Parameters<typeof listAbsoluteSubpaths>): Promise<string[]>;
-/**
- * Internal function that lists absolute subpaths recursively.
- *
- * @param {string} inputPath              - The directory path to list.
- * @param {ListOptions} [_options]        - Optional configuration.
- * @param {ListContext} [__private_context] - Internal recursion context.
- * @returns {Promise<string[]>} Array of absolute subpaths.
- */
-declare function listAbsoluteSubpaths(inputPath: string, _options?: ListOptions, __private_context?: ListContext): Promise<string[]>;
-export {};