@catbee/utils 2.0.0-next.0 → 2.0.0

package/fs/fs.utils.d.ts

@@ -1,196 +0,0 @@
-/*
- * The MIT License
- * 
- * Copyright (c) 2025 Catbee Technologies. https://catbee.in/license
- * 
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- * 
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- * 
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import type { BufferEncoding } from '@catbee/utils/crypto';
-import { Stats } from 'fs';
-/**
- * Checks whether a file or directory exists at the given path.
- *
- * @param {string} path - The file or directory path to check.
- * @returns {Promise<boolean>} Resolves to `true` if the path exists, `false` otherwise.
- */
-export declare function fileExists(path: string): Promise<boolean>;
-/**
- * Reads and parses a JSON file from the specified path.
- *
- * @typeParam T - The expected type of the parsed JSON object.
- * @param {string} path - The path to the JSON file.
- * @returns {Promise<T | null>} The parsed object, or `null` if reading or parsing fails.
- */
-export declare function readJsonFile<T = any>(path: string): Promise<T | null>;
-/**
- * Read and parse JSON file or return a provided default value on error.
- *
- * @typeParam T
- * @param {string} path - Path to JSON file
- * @param {T} defaultValue - Default value to return when read/parse fails
- * @returns {Promise<T>} Parsed JSON or defaultValue
- */
-export declare function readJsonOrDefault<T = any>(path: string, defaultValue: T): Promise<T>;
-/**
- * Writes a JavaScript object to a file as formatted JSON.
- *
- * @param {string} path - The destination file path.
- * @param {any} data - The object to serialize and write.
- * @param {number} [space=2] - Number of spaces for JSON formatting.
- * @returns {Promise<void>} Resolves when writing is complete.
- */
-export declare function writeJsonFile(path: string, data: any, space?: number): Promise<void>;
-/**
- * Deletes a file if it exists.
- *
- * @param {string} path - The file path to delete.
- * @returns {Promise<boolean>} Resolves to `true` if the file was deleted or didn't exist, `false` if deletion failed.
- */
-export declare function deleteFileIfExists(path: string): Promise<boolean>;
-/**
- * Reads a text file from the specified path.
- *
- * @param {string} path - The path to the text file.
- * @param {BufferEncoding} [encoding="utf-8"] - The encoding to use.
- * @returns {Promise<string | null>} The file contents, or `null` if reading fails.
- */
-export declare function readTextFile(path: string, encoding?: BufferEncoding): Promise<string | null>;
-/**
- * Writes text content to a file.
- *
- * @param {string} path - The destination file path.
- * @param {string} content - The text content to write.
- * @param {BufferEncoding} [encoding="utf-8"] - The encoding to use.
- * @returns {Promise<boolean>} Resolves to `true` if successful, `false` otherwise.
- */
-export declare function writeTextFile(path: string, content: string, encoding?: BufferEncoding): Promise<boolean>;
-/**
- * Appends text content to a file.
- *
- * @param {string} path - The file path to append to.
- * @param {string} content - The text content to append.
- * @param {BufferEncoding} [encoding="utf-8"] - The encoding to use.
- * @returns {Promise<boolean>} Resolves to `true` if successful, `false` otherwise.
- */
-export declare function appendTextFile(path: string, content: string, encoding?: BufferEncoding): Promise<boolean>;
-/**
- * Copies a file from source to destination.
- *
- * @param {string} source - Source file path.
- * @param {string} destination - Destination file path.
- * @param {boolean} [overwrite=false] - Whether to overwrite if destination exists.
- * @returns {Promise<boolean>} Resolves to `true` if successful, `false` otherwise.
- */
-export declare function copyFile(source: string, destination: string, overwrite?: boolean): Promise<boolean>;
-/**
- * Renames/moves a file.
- *
- * @param {string} oldPath - Current file path.
- * @param {string} newPath - New file path.
- * @returns {Promise<boolean>} Resolves to `true` if successful, `false` otherwise.
- */
-export declare function moveFile(oldPath: string, newPath: string): Promise<boolean>;
-/**
- * Gets file stats if the file exists.
- *
- * @param {string} path - Path to the file.
- * @returns {Promise<fs.Stats | null>} File stats object or null if file doesn't exist.
- */
-export declare function getFileStats(path: string): Promise<Stats | null>;
-/**
- * Creates a temporary file with optional content.
- *
- * @param {object} [options] - Options for creating the temp file.
- * @param {string} [options.prefix="tmp-"] - Filename prefix.
- * @param {string} [options.extension=""] - File extension.
- * @param {string} [options.dir] - Directory to create the file in (defaults to OS temp dir).
- * @param {string | Buffer} [options.content] - Optional content to write to the file.
- * @returns {Promise<string>} Path to the created temporary file.
- */
-export declare function createTempFile({ prefix, extension, dir, content }?: {
-    prefix?: string;
-    extension?: string;
-    dir?: string;
-    content?: string | Buffer;
-}): Promise<string>;
-/**
- * Streams a file from source to destination.
- * Useful for large files to avoid loading the entire file into memory.
- *
- * @param {string} source - Source file path.
- * @param {string} destination - Destination file path.
- * @returns {Promise<void>} Resolves when streaming completes.
- * @throws {Error} If streaming fails.
- */
-export declare function streamFile(source: string, destination: string): Promise<void>;
-/**
- * Reads a directory and returns file names.
- *
- * @param {string} dirPath - Path to the directory.
- * @param {object} [options] - Options for reading the directory.
- * @param {boolean} [options.fullPaths=false] - Whether to return full paths.
- * @param {RegExp} [options.filter] - Optional regex to filter files.
- * @returns {Promise<string[]>} Array of file names or paths.
- * @throws {Error} If directory cannot be read.
- */
-export declare function readDirectory(dirPath: string, options?: {
-    fullPaths?: boolean;
-    filter?: RegExp;
-}): Promise<string[]>;
-/**
- * Creates a directory if it doesn't exist.
- *
- * @param {string} dirPath - Path to the directory.
- * @param {boolean} [recursive=true] - Whether to create parent directories.
- * @returns {Promise<boolean>} Resolves to `true` if successful, `false` otherwise.
- */
-export declare function createDirectory(dirPath: string, recursive?: boolean): Promise<boolean>;
-/**
- * Safely reads and parses a JSON file with error details.
- *
- * @typeParam T - The expected type of the parsed JSON object.
- * @param {string} path - The path to the JSON file.
- * @returns {Promise<{ data: T | null; error: Error | null }>} Object with data and error properties.
- */
-export declare function safeReadJsonFile<T = any>(path: string): Promise<{
-    data: T | null;
-    error: Error | null;
-}>;
-/**
- * Checks if a path points to a file (not a directory).
- *
- * @param {string} path - Path to check.
- * @returns {Promise<boolean>} True if the path is a file, false otherwise.
- */
-export declare function isFile(path: string): Promise<boolean>;
-/**
- * Gets the size of a file in bytes.
- *
- * @param {string} path - Path to the file.
- * @returns {Promise<number>} Size in bytes or -1 if file doesn't exist.
- */
-export declare function getFileSize(path: string): Promise<number>;
-/**
- * Reads a file as a Buffer.
- *
- * @param {string} path - Path to the file.
- * @returns {Promise<Buffer | null>} File contents as Buffer or null if reading fails.
- */
-export declare function readFileBuffer(path: string): Promise<Buffer | null>;

package/http-status-codes/http-status-codes.d.ts

@@ -1,289 +0,0 @@
-/*
- * The MIT License
- * 
- * Copyright (c) 2025 Catbee Technologies. https://catbee.in/license
- * 
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- * 
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- * 
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-/**
- * Complete HTTP status codes enum with descriptions.
- * For use with API responses and error handling.
- */
-export declare enum HttpStatusCodes {
-    /**
-     * The server has received the request headers and the client should proceed to send the request body.
-     */
-    CONTINUE = 100,
-    /**
-     * The server is switching protocols according to the client's request.
-     */
-    SWITCHING_PROTOCOLS = 101,
-    /**
-     * Server has received the request and is still processing it.
-     */
-    PROCESSING = 102,
-    /**
-     * The server is sending preliminary headers while preparing the final response.
-     */
-    EARLY_HINTS = 103,
-    /**
-     * The request succeeded. The result meaning depends on the HTTP method used.
-     */
-    OK = 200,
-    /**
-     * The request succeeded and a new resource was created as a result.
-     */
-    CREATED = 201,
-    /**
-     * The request has been received but not yet acted upon.
-     */
-    ACCEPTED = 202,
-    /**
-     * The returned information is from a third-party source, not the origin server.
-     */
-    NON_AUTHORITATIVE_INFORMATION = 203,
-    /**
-     * The request succeeded but there's no content to send in the response.
-     */
-    NO_CONTENT = 204,
-    /**
-     * The client should reset the document view that caused this request.
-     */
-    RESET_CONTENT = 205,
-    /**
-     * The server is delivering only part of the resource due to a range header sent by the client.
-     */
-    PARTIAL_CONTENT = 206,
-    /**
-     * Conveys information about multiple resources, for complex operations.
-     */
-    MULTI_STATUS = 207,
-    /**
-     * The members of a DAV binding have already been enumerated and are not included in the response.
-     */
-    ALREADY_REPORTED = 208,
-    /**
-     * The server has fulfilled a request for the resource, and the response represents the result of one or more instance-manipulations.
-     */
-    IM_USED = 226,
-    /**
-     * The request has more than one possible response and the client should choose one.
-     */
-    MULTIPLE_CHOICES = 300,
-    /**
-     * The resource has been permanently moved to a new URL.
-     */
-    MOVED_PERMANENTLY = 301,
-    /**
-     * The resource has been temporarily moved to another URL.
-     */
-    MOVED_TEMPORARILY = 302,
-    /**
-     * The response to the request can be found under another URI using the GET method.
-     */
-    SEE_OTHER = 303,
-    /**
-     * The resource hasn't been modified since the last request.
-     */
-    NOT_MODIFIED = 304,
-    /**
-     * @deprecated
-     * Response must be accessed through a proxy.
-     */
-    USE_PROXY = 305,
-    /**
-     * The resource is temporarily available at a different URI, using the same HTTP method.
-     */
-    TEMPORARY_REDIRECT = 307,
-    /**
-     * The resource has been permanently moved to another URL, using the same HTTP method.
-     */
-    PERMANENT_REDIRECT = 308,
-    /**
-     * The server cannot process the request due to a client error (malformed request).
-     */
-    BAD_REQUEST = 400,
-    /**
-     * Authentication is required and has failed or not been provided.
-     */
-    UNAUTHORIZED = 401,
-    /**
-     * Reserved for future use, originally intended for digital payment systems.
-     */
-    PAYMENT_REQUIRED = 402,
-    /**
-     * The client doesn't have permission to access the requested resource.
-     */
-    FORBIDDEN = 403,
-    /**
-     * The requested resource could not be found on the server.
-     */
-    NOT_FOUND = 404,
-    /**
-     * The request method is not supported for the requested resource.
-     */
-    METHOD_NOT_ALLOWED = 405,
-    /**
-     * The server can't provide a response matching the list of acceptable values in the client's headers.
-     */
-    NOT_ACCEPTABLE = 406,
-    /**
-     * Authentication by a proxy is required.
-     */
-    PROXY_AUTHENTICATION_REQUIRED = 407,
-    /**
-     * The server timed out waiting for the request.
-     */
-    REQUEST_TIMEOUT = 408,
-    /**
-     * The request conflicts with the current state of the server.
-     */
-    CONFLICT = 409,
-    /**
-     * The resource has been permanently deleted with no forwarding address.
-     */
-    GONE = 410,
-    /**
-     * The server requires a Content-Length header field.
-     */
-    LENGTH_REQUIRED = 411,
-    /**
-     * Preconditions in the client's headers failed.
-     */
-    PRECONDITION_FAILED = 412,
-    /**
-     * Request entity is larger than limits defined by server.
-     */
-    REQUEST_TOO_LONG = 413,
-    /**
-     * The request payload exceeds server size limits.
-     * Modern equivalent of REQUEST_TOO_LONG.
-     */
-    PAYLOAD_TOO_LARGE = 413,
-    /**
-     * The URI requested is too long for the server to interpret.
-     */
-    REQUEST_URI_TOO_LONG = 414,
-    /**
-     * The server does not support the media type requested by the client.
-     */
-    UNSUPPORTED_MEDIA_TYPE = 415,
-    /**
-     * The range specified by the Range header cannot be fulfilled.
-     */
-    REQUESTED_RANGE_NOT_SATISFIABLE = 416,
-    /**
-     * The server cannot meet the expectations given in the Expect header.
-     */
-    EXPECTATION_FAILED = 417,
-    /**
-     * The server refuses to brew coffee because it is a teapot. (April Fools' joke)
-     */
-    IM_A_TEAPOT = 418,
-    /**
-     * The server cannot store the representation needed to complete the request.
-     */
-    INSUFFICIENT_SPACE_ON_RESOURCE = 419,
-    /**
-     * @deprecated
-     * A method has failed - specific to Spring Framework.
-     */
-    METHOD_FAILURE = 420,
-    /**
-     * The server cannot produce a response for the requested URI scheme and authority.
-     */
-    MISDIRECTED_REQUEST = 421,
-    /**
-     * The request was well-formed but has semantic errors preventing processing.
-     */
-    UNPROCESSABLE_ENTITY = 422,
-    /**
-     * The requested resource is locked against access.
-     */
-    LOCKED = 423,
-    /**
-     * The request failed due to the failure of a previous request.
-     */
-    FAILED_DEPENDENCY = 424,
-    /**
-     * The client should switch to a different protocol.
-     */
-    UPGRADE_REQUIRED = 426,
-    /**
-     * The server requires conditional requests to prevent lost updates.
-     */
-    PRECONDITION_REQUIRED = 428,
-    /**
-     * The client has sent too many requests in a given time period (rate limiting).
-     */
-    TOO_MANY_REQUESTS = 429,
-    /**
-     * Request headers are too large for the server to process.
-     */
-    REQUEST_HEADER_FIELDS_TOO_LARGE = 431,
-    /**
-     * Resource cannot be legally provided (e.g., censored by government).
-     */
-    UNAVAILABLE_FOR_LEGAL_REASONS = 451,
-    /**
-     * The server encountered an unexpected error preventing it from fulfilling the request.
-     */
-    INTERNAL_SERVER_ERROR = 500,
-    /**
-     * The server does not support the functionality required to fulfill the request.
-     */
-    NOT_IMPLEMENTED = 501,
-    /**
-     * The server, acting as a gateway, received an invalid response from an upstream server.
-     */
-    BAD_GATEWAY = 502,
-    /**
-     * The server is currently unable to handle the request due to temporary overload or maintenance.
-     */
-    SERVICE_UNAVAILABLE = 503,
-    /**
-     * The server, acting as a gateway, did not receive a timely response from an upstream server.
-     */
-    GATEWAY_TIMEOUT = 504,
-    /**
-     * The server does not support the HTTP protocol version used in the request.
-     */
-    HTTP_VERSION_NOT_SUPPORTED = 505,
-    /**
-     * Transparent content negotiation for the request resulted in circular reference.
-     */
-    VARIANT_ALSO_NEGOTIATES = 506,
-    /**
-     * The server cannot store the representation needed to complete the request.
-     */
-    INSUFFICIENT_STORAGE = 507,
-    /**
-     * The server detected an infinite loop while processing the request.
-     */
-    LOOP_DETECTED = 508,
-    /**
-     * Further extensions to the request are required for the server to fulfill it.
-     */
-    NOT_EXTENDED = 510,
-    /**
-     * The client needs to authenticate to gain network access.
-     */
-    NETWORK_AUTHENTICATION_REQUIRED = 511
-}

package/id/id.utils.d.ts

@@ -1,59 +0,0 @@
-/*
- * The MIT License
- * 
- * Copyright (c) 2025 Catbee Technologies. https://catbee.in/license
- * 
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- * 
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- * 
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-/**
- * Generates a UUID v4 string (RFC 4122).
- *
- * @returns {string} UUID v4 (e.g., 'c0de1234-5678-9abc-def0-123456789abc')
- */
-export declare function uuid(): string;
-/**
- * Generates a nanoid-style random ID (URL-safe, customizable length).
- *
- * @param {number} length - Length of the ID (default: 21).
- * @returns {string} Nanoid-style random string.
- */
-export declare function nanoId(length?: number): string;
-/**
- * Generates a cryptographically strong random hex string.
- *
- * @param {number} byteLength - Number of random bytes (default: 16 → 32 hex chars).
- * @returns {string} Random hex string.
- */
-export declare function randomHex(byteLength?: number): string;
-/**
- * Generates a random integer between min (inclusive) and max (inclusive).
- *
- * @param {number} min - Minimum value.
- * @param {number} max - Maximum value.
- * @returns {number} Random integer in range.
- */
-export declare function randomInt(min: number, max: number): number;
-/**
- * Generates a cryptographically strong random base64 string.
- *
- * @param {number} byteLength - Number of random bytes (default: 16).
- * @returns {string} Random base64 string (URL-safe, no padding).
- */
-export declare function randomBase64(byteLength?: number): string;