@catbee/utils 0.0.8-next.0 → 0.0.8-rc.0

package/build/esm/utils/crypto.utils.js

@@ -0,0 +1,375 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2025 Catbee Technologies. https://catbee-utils.npm.hprasath.com/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.
+ */
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+import { createHmac, createHash, randomBytes, createCipheriv, createDecipheriv, scrypt, timingSafeEqual } from 'crypto';
+import { promisify } from 'util';
+import { uuid } from './id.utils';
+/**
+ * Generates an HMAC digest using the specified algorithm and secret key.
+ *
+ * @param {string} algorithm - The hashing algorithm (e.g., 'sha256', 'sha1').
+ * @param {string} input - The string to hash.
+ * @param {string} secret - The secret key for HMAC.
+ * @param {BinaryToTextEncoding} [encoding='hex'] - Output encoding ('hex', 'base64', etc).
+ * @returns {string} HMAC digest as a string.
+ */
+export function hmac(algorithm, input, secret, encoding) {
+    if (encoding === void 0) { encoding = 'hex'; }
+    return createHmac(algorithm, secret).update(input).digest(encoding);
+}
+/**
+ * Generates a hash digest using the specified algorithm.
+ *
+ * @param {string} algorithm - The hashing algorithm (e.g., 'sha256', 'md5').
+ * @param {string} input - The string to hash.
+ * @param {BinaryToTextEncoding} [encoding='hex'] - Output encoding ('hex', 'base64', etc).
+ * @returns {string} Hash digest as a string.
+ */
+export function hash(algorithm, input, encoding) {
+    if (encoding === void 0) { encoding = 'hex'; }
+    return createHash(algorithm).update(input).digest(encoding);
+}
+/**
+ * Generates an HMAC-SHA256 digest.
+ *
+ * @param {string} input - The string to hash.
+ * @param {string} secret - The secret key.
+ * @returns {string} SHA-256 HMAC digest as a string.
+ */
+export function sha256Hmac(input, secret) {
+    return hmac('sha256', input, secret);
+}
+/**
+ * Generates a SHA1 hash digest.
+ *
+ * @param {string} input - The string to hash.
+ * @param {BinaryToTextEncoding} [encoding='hex'] - Output encoding.
+ * @returns {string} SHA-1 hash as a string.
+ */
+export function sha1(input, encoding) {
+    if (encoding === void 0) { encoding = 'hex'; }
+    return hash('sha1', input, encoding);
+}
+/**
+ * Generates a SHA256 hash digest.
+ *
+ * @param {string} input - The string to hash.
+ * @param {BinaryToTextEncoding} [encoding='hex'] - Output encoding.
+ * @returns {string} SHA-256 hash as a string.
+ */
+export function sha256(input, encoding) {
+    if (encoding === void 0) { encoding = 'hex'; }
+    return hash('sha256', input, encoding);
+}
+/**
+ * Generates an MD5 hash digest.
+ *
+ * @param {string} input - The string to hash.
+ * @returns {string} MD5 hash as a string.
+ */
+export function md5(input) {
+    return hash('md5', input);
+}
+/**
+ * Generates a cryptographically strong random string by hashing a random UUID with SHA-256.
+ *
+ * @returns {string} Random string hashed with SHA-256 (hex encoding).
+ */
+export function randomString() {
+    return sha256(uuid());
+}
+/**
+ * Generates a secure random buffer of specified byte length.
+ *
+ * @param {number} [byteLength=32] - Number of random bytes to generate.
+ * @returns {Buffer} Buffer containing random bytes.
+ */
+export function generateRandomBytes(byteLength) {
+    if (byteLength === void 0) { byteLength = 32; }
+    return randomBytes(byteLength);
+}
+/**
+ * Generates a secure random string of specified byte length with specified encoding.
+ *
+ * @param {number} [byteLength=32] - Number of random bytes to generate.
+ * @param {BinaryToTextEncoding} [encoding='hex'] - Output encoding.
+ * @returns {string} Random string in specified encoding.
+ */
+export function generateRandomBytesAsString(byteLength, encoding) {
+    if (byteLength === void 0) { byteLength = 32; }
+    if (encoding === void 0) { encoding = 'hex'; }
+    return randomBytes(byteLength).toString(encoding);
+}
+/**
+ * Generates a secure API key with a specified format.
+ *
+ * @param {string} [prefix=''] - Optional prefix for the key.
+ * @param {number} [byteLength=24] - Number of random bytes to generate.
+ * @returns {string} Formatted API key.
+ */
+export function generateApiKey(prefix, byteLength) {
+    if (prefix === void 0) { prefix = ''; }
+    if (byteLength === void 0) { byteLength = 24; }
+    var randomString = generateRandomBytesAsString(byteLength, 'base64');
+    var key = randomString
+        .replace(/[+/=]/g, '') // Remove non-URL-safe characters
+        .substring(0, 32); // Limit length
+    return prefix ? "".concat(prefix, "_").concat(key) : key;
+}
+/**
+ * Compares two strings, arrays, or buffers in constant time to prevent timing attacks.
+ *
+ * @param {string | Buffer | Uint8Array} a - First value to compare
+ * @param {string | Buffer | Uint8Array} b - Second value to compare
+ * @returns {boolean} True if values are equal
+ */
+export function safeCompare(a, b) {
+    if (typeof a === 'string' && typeof b === 'string') {
+        // Convert strings to buffers
+        var bufA = Buffer.from(a);
+        var bufB = Buffer.from(b);
+        // Compare lengths first (not constant time, but prevents timing attack on contents)
+        if (bufA.length !== bufB.length)
+            return false;
+        return timingSafeEqual(bufA, bufB);
+    }
+    else if ((a instanceof Buffer || a instanceof Uint8Array) && (b instanceof Buffer || b instanceof Uint8Array)) {
+        // Compare lengths first
+        if (a.length !== b.length)
+            return false;
+        return timingSafeEqual(a instanceof Buffer ? a : Buffer.from(a), b instanceof Buffer ? b : Buffer.from(b));
+    }
+    throw new Error('Cannot compare: inputs must be strings, Buffers, or Uint8Arrays');
+}
+// Promisified version of scrypt for key derivation
+var scryptAsync = promisify(scrypt);
+/**
+ * Encrypts data using a symmetric key with secure defaults (AES-256-GCM).
+ *
+ * @param {string | Buffer} data - Data to encrypt
+ * @param {string | Buffer} key - Encryption key or passphrase
+ * @param {EncryptionOptions} [options] - Encryption options
+ * @returns {Promise<EncryptionResult>} Encrypted data with metadata
+ */
+export function encrypt(data_1, key_1) {
+    return __awaiter(this, arguments, void 0, function (data, key, options) {
+        var algorithm, inputEncoding, outputEncoding, iv, derivedKey, _a, cipher, ciphertext, encrypted, authTag;
+        if (options === void 0) { options = {}; }
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    algorithm = options.algorithm || 'aes-256-gcm';
+                    inputEncoding = options.inputEncoding || 'utf8';
+                    outputEncoding = options.outputEncoding || 'hex';
+                    iv = randomBytes(16);
+                    if (!(typeof key === 'string')) return [3 /*break*/, 2];
+                    return [4 /*yield*/, scryptAsync(key, iv.slice(0, 8), 32)];
+                case 1:
+                    _a = _b.sent();
+                    return [3 /*break*/, 3];
+                case 2:
+                    _a = key;
+                    _b.label = 3;
+                case 3:
+                    derivedKey = _a;
+                    cipher = createCipheriv(algorithm, derivedKey, iv);
+                    if (typeof data === 'string') {
+                        ciphertext = cipher.update(data, inputEncoding, outputEncoding);
+                        ciphertext += cipher.final(outputEncoding);
+                    }
+                    else {
+                        encrypted = Buffer.concat([cipher.update(data), cipher.final()]);
+                        ciphertext = outputEncoding ? encrypted.toString(outputEncoding) : encrypted;
+                    }
+                    authTag = algorithm.includes('gcm') ? cipher.getAuthTag() : undefined;
+                    return [2 /*return*/, {
+                            ciphertext: ciphertext,
+                            iv: iv,
+                            authTag: authTag,
+                            algorithm: algorithm
+                        }];
+            }
+        });
+    });
+}
+/**
+ * Decrypts data that was encrypted with the encrypt function.
+ *
+ * @param {EncryptionResult} encryptedData - The encrypted data and metadata
+ * @param {string | Buffer} key - Decryption key or passphrase
+ * @param {DecryptionOptions} [options] - Decryption options
+ * @returns {Promise<string | Buffer>} Decrypted data
+ */
+export function decrypt(encryptedData_1, key_1) {
+    return __awaiter(this, arguments, void 0, function (encryptedData, key, options) {
+        var algorithm, inputEncoding, outputEncoding, derivedKey, _a, decipher, decrypted, result;
+        if (options === void 0) { options = {}; }
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    algorithm = options.algorithm || encryptedData.algorithm || 'aes-256-gcm';
+                    inputEncoding = options.inputEncoding || 'hex';
+                    outputEncoding = options.outputEncoding || 'utf8';
+                    if (!(typeof key === 'string')) return [3 /*break*/, 2];
+                    return [4 /*yield*/, scryptAsync(key, encryptedData.iv.slice(0, 8), 32)];
+                case 1:
+                    _a = _b.sent();
+                    return [3 /*break*/, 3];
+                case 2:
+                    _a = key;
+                    _b.label = 3;
+                case 3:
+                    derivedKey = _a;
+                    decipher = createDecipheriv(algorithm, derivedKey, encryptedData.iv);
+                    // Set auth tag if using GCM mode
+                    if (encryptedData.authTag && algorithm.includes('gcm')) {
+                        decipher.setAuthTag(encryptedData.authTag);
+                    }
+                    if (typeof encryptedData.ciphertext === 'string') {
+                        decrypted = decipher.update(encryptedData.ciphertext, inputEncoding, outputEncoding);
+                        decrypted += decipher.final(outputEncoding);
+                    }
+                    else {
+                        result = Buffer.concat([decipher.update(encryptedData.ciphertext), decipher.final()]);
+                        decrypted = outputEncoding ? result.toString(outputEncoding) : result;
+                    }
+                    return [2 /*return*/, decrypted];
+            }
+        });
+    });
+}
+/**
+ * Creates a signed token with an expiration time and payload.
+ *
+ * @param {object} payload - Data to include in the token
+ * @param {string} secret - Secret key for signing
+ * @param {number} [expiresInSeconds=3600] - Token expiration in seconds
+ * @returns {string} Signed token string
+ */
+export function createSignedToken(payload, secret, expiresInSeconds) {
+    if (expiresInSeconds === void 0) { expiresInSeconds = 3600; }
+    // Create payload with expiration
+    var tokenPayload = __assign(__assign({}, payload), { exp: Math.floor(Date.now() / 1000) + expiresInSeconds });
+    // Convert to string
+    var payloadStr = JSON.stringify(tokenPayload);
+    // Base64 encode the payload
+    var base64Payload = Buffer.from(payloadStr).toString('base64url');
+    // Create signature
+    var signature = hmac('sha256', base64Payload, secret, 'base64url');
+    // Combine payload and signature
+    return "".concat(base64Payload, ".").concat(signature);
+}
+/**
+ * Verifies and decodes a signed token.
+ *
+ * @param {string} token - The token to verify
+ * @param {string} secret - Secret key for verification
+ * @returns {object | null} Decoded payload if valid, null if invalid
+ */
+export function verifySignedToken(token, secret) {
+    try {
+        // Split token into parts
+        var _a = __read(token.split('.'), 2), payloadB64 = _a[0], signature = _a[1];
+        if (!payloadB64 || !signature)
+            return null;
+        // Verify signature
+        var expectedSignature = hmac('sha256', payloadB64, secret, 'base64url');
+        if (!safeCompare(signature, expectedSignature))
+            return null;
+        // Decode payload
+        var payloadStr = Buffer.from(payloadB64, 'base64url').toString('utf8');
+        var payload = JSON.parse(payloadStr);
+        // Check expiration
+        if (payload.exp && payload.exp < Math.floor(Date.now() / 1000)) {
+            return null;
+        }
+        return payload;
+    }
+    catch (_b) {
+        return null;
+    }
+}
+//# sourceMappingURL=crypto.utils.js.map

package/build/esm/utils/crypto.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"crypto.utils.js","sourceRoot":"","sources":["../../../src/utils/crypto.utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,OAAO,EACL,UAAU,EACV,UAAU,EAEV,WAAW,EACX,cAAc,EACd,gBAAgB,EAChB,MAAM,EACN,eAAe,EAEhB,MAAM,QAAQ,CAAC;AAChB,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AACjC,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAgBlC;;;;;;;;GAQG;AACH,MAAM,UAAU,IAAI,CAAC,SAAiB,EAAE,KAAa,EAAE,MAAc,EAAE,QAAsC;IAAtC,yBAAA,EAAA,gBAAsC;IAC3G,OAAO,UAAU,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AACtE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,IAAI,CAAC,SAAiB,EAAE,KAAa,EAAE,QAAsC;IAAtC,yBAAA,EAAA,gBAAsC;IAC3F,OAAO,UAAU,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AAC9D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,KAAa,EAAE,MAAc;IACtD,OAAO,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;AACvC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,IAAI,CAAC,KAAa,EAAE,QAAsC;IAAtC,yBAAA,EAAA,gBAAsC;IACxE,OAAO,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;AACvC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,MAAM,CAAC,KAAa,EAAE,QAAsC;IAAtC,yBAAA,EAAA,gBAAsC;IAC1E,OAAO,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;AACzC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,GAAG,CAAC,KAAa;IAC/B,OAAO,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAC5B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY;IAC1B,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;AACxB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CAAC,UAAuB;IAAvB,2BAAA,EAAA,eAAuB;IACzD,OAAO,WAAW,CAAC,UAAU,CAAC,CAAC;AACjC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,2BAA2B,CAAC,UAAuB,EAAE,QAAsC;IAA/D,2BAAA,EAAA,eAAuB;IAAE,yBAAA,EAAA,gBAAsC;IACzG,OAAO,WAAW,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AACpD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAAC,MAAmB,EAAE,UAAuB;IAA5C,uBAAA,EAAA,WAAmB;IAAE,2BAAA,EAAA,eAAuB;IACzE,IAAM,YAAY,GAAG,2BAA2B,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IACvE,IAAM,GAAG,GAAG,YAAY;SACrB,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,iCAAiC;SACvD,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,eAAe;IAEpC,OAAO,MAAM,CAAC,CAAC,CAAC,UAAG,MAAM,cAAI,GAAG,CAAE,CAAC,CAAC,CAAC,GAAG,CAAC;AAC3C,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,CAA+B,EAAE,CAA+B;IAC1F,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;QACnD,6BAA6B;QAC7B,IAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC5B,IAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAE5B,oFAAoF;QACpF,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM;YAAE,OAAO,KAAK,CAAC;QAE9C,OAAO,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACrC,CAAC;SAAM,IAAI,CAAC,CAAC,YAAY,MAAM,IAAI,CAAC,YAAY,UAAU,CAAC,IAAI,CAAC,CAAC,YAAY,MAAM,IAAI,CAAC,YAAY,UAAU,CAAC,EAAE,CAAC;QAChH,wBAAwB;QACxB,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM;YAAE,OAAO,KAAK,CAAC;QAExC,OAAO,eAAe,CAAC,CAAC,YAAY,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,YAAY,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7G,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAC;AACrF,CAAC;AAwCD,mDAAmD;AACnD,IAAM,WAAW,GAAG,SAAS,CAAmD,MAAM,CAAC,CAAC;AAExF;;;;;;;GAOG;AACH,MAAM,UAAgB,OAAO;wDAC3B,IAAqB,EACrB,GAAoB,EACpB,OAA+B;;QAA/B,wBAAA,EAAA,YAA+B;;;;oBAEzB,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,aAAa,CAAC;oBAC/C,aAAa,GAAG,OAAO,CAAC,aAAa,IAAI,MAAM,CAAC;oBAChD,cAAc,GAAG,OAAO,CAAC,cAAc,IAAI,KAAK,CAAC;oBAGjD,EAAE,GAAG,WAAW,CAAC,EAAE,CAAC,CAAC;yBAGR,CAAA,OAAO,GAAG,KAAK,QAAQ,CAAA,EAAvB,wBAAuB;oBAAG,qBAAM,WAAW,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,EAAA;;oBAA1C,KAAA,SAA0C,CAAA;;;oBAAG,KAAA,GAAG,CAAA;;;oBAAvF,UAAU,KAA6E;oBAGvF,MAAM,GAAG,cAAc,CAAC,SAAS,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC;oBAKzD,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;wBAC7B,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,aAAa,EAAE,cAAgC,CAAC,CAAC;wBAClF,UAAU,IAAI,MAAM,CAAC,KAAK,CAAC,cAAgC,CAAC,CAAC;oBAC/D,CAAC;yBAAM,CAAC;wBACA,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;wBACvE,UAAU,GAAG,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,CAAC;oBAGK,OAAO,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAE,MAAc,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAErF,sBAAO;4BACL,UAAU,YAAA;4BACV,EAAE,IAAA;4BACF,OAAO,SAAA;4BACP,SAAS,WAAA;yBACV,EAAC;;;;CACH;AAED;;;;;;;GAOG;AACH,MAAM,UAAgB,OAAO;wDAC3B,aAA+B,EAC/B,GAAoB,EACpB,OAA+B;;QAA/B,wBAAA,EAAA,YAA+B;;;;oBAEzB,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,aAAa,CAAC,SAAS,IAAI,aAAa,CAAC;oBAC1E,aAAa,GAAG,OAAO,CAAC,aAAa,IAAI,KAAK,CAAC;oBAC/C,cAAc,GAAG,OAAO,CAAC,cAAc,IAAI,MAAM,CAAC;yBAGrC,CAAA,OAAO,GAAG,KAAK,QAAQ,CAAA,EAAvB,wBAAuB;oBAAG,qBAAM,WAAW,CAAC,GAAG,EAAE,aAAa,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,EAAA;;oBAAxD,KAAA,SAAwD,CAAA;;;oBAAG,KAAA,GAAG,CAAA;;;oBAArG,UAAU,KAA2F;oBAGrG,QAAQ,GAAG,gBAAgB,CAAC,SAAS,EAAE,UAAU,EAAE,aAAa,CAAC,EAAE,CAAC,CAAC;oBAE3E,iCAAiC;oBACjC,IAAI,aAAa,CAAC,OAAO,IAAI,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;wBACtD,QAAgB,CAAC,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;oBACtD,CAAC;oBAKD,IAAI,OAAO,aAAa,CAAC,UAAU,KAAK,QAAQ,EAAE,CAAC;wBACjD,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,UAAU,EAAE,aAA+B,EAAE,cAAc,CAAC,CAAC;wBACvG,SAAS,IAAI,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;oBAC9C,CAAC;yBAAM,CAAC;wBACA,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;wBAC5F,SAAS,GAAG,cAAc,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;oBACxE,CAAC;oBAED,sBAAO,SAAS,EAAC;;;;CAClB;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,iBAAiB,CAC/B,OAA4B,EAC5B,MAAc,EACd,gBAA+B;IAA/B,iCAAA,EAAA,uBAA+B;IAE/B,iCAAiC;IACjC,IAAM,YAAY,yBACb,OAAO,KACV,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,GAAG,gBAAgB,GACtD,CAAC;IAEF,oBAAoB;IACpB,IAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;IAEhD,4BAA4B;IAC5B,IAAM,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IAEpE,mBAAmB;IACnB,IAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,EAAE,aAAa,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAErE,gCAAgC;IAChC,OAAO,UAAG,aAAa,cAAI,SAAS,CAAE,CAAC;AACzC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAa,EAAE,MAAc;IAC7D,IAAI,CAAC;QACH,yBAAyB;QACnB,IAAA,KAAA,OAA0B,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,IAAA,EAAzC,UAAU,QAAA,EAAE,SAAS,QAAoB,CAAC;QAEjD,IAAI,CAAC,UAAU,IAAI,CAAC,SAAS;YAAE,OAAO,IAAI,CAAC;QAE3C,mBAAmB;QACnB,IAAM,iBAAiB,GAAG,IAAI,CAAC,QAAQ,EAAE,UAAU,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;QAC1E,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,iBAAiB,CAAC;YAAE,OAAO,IAAI,CAAC;QAE5D,iBAAiB;QACjB,IAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACzE,IAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAEvC,mBAAmB;QACnB,IAAI,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;YAC/D,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAAC,WAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC","sourcesContent":["/*\n * The MIT License\n *\n * Copyright (c) 2025 Catbee Technologies. https://catbee-utils.npm.hprasath.com/license\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport {\n  createHmac,\n  createHash,\n  BinaryToTextEncoding,\n  randomBytes,\n  createCipheriv,\n  createDecipheriv,\n  scrypt,\n  timingSafeEqual,\n  CipherGCMTypes\n} from 'crypto';\nimport { promisify } from 'util';\nimport { uuid } from './id.utils';\n\nexport type BufferEncoding =\n  | 'ascii'\n  | 'utf8'\n  | 'utf-8'\n  | 'utf16le'\n  | 'utf-16le'\n  | 'ucs2'\n  | 'ucs-2'\n  | 'base64'\n  | 'base64url'\n  | 'latin1'\n  | 'binary'\n  | 'hex';\n\n/**\n * Generates an HMAC digest using the specified algorithm and secret key.\n *\n * @param {string} algorithm - The hashing algorithm (e.g., 'sha256', 'sha1').\n * @param {string} input - The string to hash.\n * @param {string} secret - The secret key for HMAC.\n * @param {BinaryToTextEncoding} [encoding='hex'] - Output encoding ('hex', 'base64', etc).\n * @returns {string} HMAC digest as a string.\n */\nexport function hmac(algorithm: string, input: string, secret: string, encoding: BinaryToTextEncoding = 'hex'): string {\n  return createHmac(algorithm, secret).update(input).digest(encoding);\n}\n\n/**\n * Generates a hash digest using the specified algorithm.\n *\n * @param {string} algorithm - The hashing algorithm (e.g., 'sha256', 'md5').\n * @param {string} input - The string to hash.\n * @param {BinaryToTextEncoding} [encoding='hex'] - Output encoding ('hex', 'base64', etc).\n * @returns {string} Hash digest as a string.\n */\nexport function hash(algorithm: string, input: string, encoding: BinaryToTextEncoding = 'hex'): string {\n  return createHash(algorithm).update(input).digest(encoding);\n}\n\n/**\n * Generates an HMAC-SHA256 digest.\n *\n * @param {string} input - The string to hash.\n * @param {string} secret - The secret key.\n * @returns {string} SHA-256 HMAC digest as a string.\n */\nexport function sha256Hmac(input: string, secret: string): string {\n  return hmac('sha256', input, secret);\n}\n\n/**\n * Generates a SHA1 hash digest.\n *\n * @param {string} input - The string to hash.\n * @param {BinaryToTextEncoding} [encoding='hex'] - Output encoding.\n * @returns {string} SHA-1 hash as a string.\n */\nexport function sha1(input: string, encoding: BinaryToTextEncoding = 'hex'): string {\n  return hash('sha1', input, encoding);\n}\n\n/**\n * Generates a SHA256 hash digest.\n *\n * @param {string} input - The string to hash.\n * @param {BinaryToTextEncoding} [encoding='hex'] - Output encoding.\n * @returns {string} SHA-256 hash as a string.\n */\nexport function sha256(input: string, encoding: BinaryToTextEncoding = 'hex'): string {\n  return hash('sha256', input, encoding);\n}\n\n/**\n * Generates an MD5 hash digest.\n *\n * @param {string} input - The string to hash.\n * @returns {string} MD5 hash as a string.\n */\nexport function md5(input: string): string {\n  return hash('md5', input);\n}\n\n/**\n * Generates a cryptographically strong random string by hashing a random UUID with SHA-256.\n *\n * @returns {string} Random string hashed with SHA-256 (hex encoding).\n */\nexport function randomString(): string {\n  return sha256(uuid());\n}\n\n/**\n * Generates a secure random buffer of specified byte length.\n *\n * @param {number} [byteLength=32] - Number of random bytes to generate.\n * @returns {Buffer} Buffer containing random bytes.\n */\nexport function generateRandomBytes(byteLength: number = 32): Buffer {\n  return randomBytes(byteLength);\n}\n\n/**\n * Generates a secure random string of specified byte length with specified encoding.\n *\n * @param {number} [byteLength=32] - Number of random bytes to generate.\n * @param {BinaryToTextEncoding} [encoding='hex'] - Output encoding.\n * @returns {string} Random string in specified encoding.\n */\nexport function generateRandomBytesAsString(byteLength: number = 32, encoding: BinaryToTextEncoding = 'hex'): string {\n  return randomBytes(byteLength).toString(encoding);\n}\n\n/**\n * Generates a secure API key with a specified format.\n *\n * @param {string} [prefix=''] - Optional prefix for the key.\n * @param {number} [byteLength=24] - Number of random bytes to generate.\n * @returns {string} Formatted API key.\n */\nexport function generateApiKey(prefix: string = '', byteLength: number = 24): string {\n  const randomString = generateRandomBytesAsString(byteLength, 'base64');\n  const key = randomString\n    .replace(/[+/=]/g, '') // Remove non-URL-safe characters\n    .substring(0, 32); // Limit length\n\n  return prefix ? `${prefix}_${key}` : key;\n}\n\n/**\n * Compares two strings, arrays, or buffers in constant time to prevent timing attacks.\n *\n * @param {string | Buffer | Uint8Array} a - First value to compare\n * @param {string | Buffer | Uint8Array} b - Second value to compare\n * @returns {boolean} True if values are equal\n */\nexport function safeCompare(a: string | Buffer | Uint8Array, b: string | Buffer | Uint8Array): boolean {\n  if (typeof a === 'string' && typeof b === 'string') {\n    // Convert strings to buffers\n    const bufA = Buffer.from(a);\n    const bufB = Buffer.from(b);\n\n    // Compare lengths first (not constant time, but prevents timing attack on contents)\n    if (bufA.length !== bufB.length) return false;\n\n    return timingSafeEqual(bufA, bufB);\n  } else if ((a instanceof Buffer || a instanceof Uint8Array) && (b instanceof Buffer || b instanceof Uint8Array)) {\n    // Compare lengths first\n    if (a.length !== b.length) return false;\n\n    return timingSafeEqual(a instanceof Buffer ? a : Buffer.from(a), b instanceof Buffer ? b : Buffer.from(b));\n  }\n\n  throw new Error('Cannot compare: inputs must be strings, Buffers, or Uint8Arrays');\n}\n\n/**\n * Interface for encryption options\n */\nexport interface EncryptionOptions {\n  /** Algorithm to use (default: aes-256-gcm) */\n  algorithm?: CipherGCMTypes;\n  /** Input encoding for plaintext if string (default: utf8) */\n  inputEncoding?: BufferEncoding;\n  /** Output encoding for ciphertext (default: hex) */\n  outputEncoding?: BinaryToTextEncoding;\n}\n\n/**\n * Interface for decryption options\n */\nexport interface DecryptionOptions {\n  /** Algorithm to use (default: aes-256-gcm) */\n  algorithm?: CipherGCMTypes;\n  /** Input encoding for ciphertext if string (default: hex) */\n  inputEncoding?: BinaryToTextEncoding;\n  /** Output encoding for plaintext (default: utf8) */\n  outputEncoding?: BufferEncoding;\n}\n\n/**\n * Result of encryption operation including all data needed for decryption\n */\nexport interface EncryptionResult {\n  /** Encrypted data (string or Buffer based on options) */\n  ciphertext: string | Buffer;\n  /** Initialization vector */\n  iv: Buffer;\n  /** Authentication tag (for GCM mode) */\n  authTag?: Buffer;\n  /** Algorithm used */\n  algorithm: string;\n}\n\n// Promisified version of scrypt for key derivation\nconst scryptAsync = promisify<string | Buffer, string | Buffer, number, Buffer>(scrypt);\n\n/**\n * Encrypts data using a symmetric key with secure defaults (AES-256-GCM).\n *\n * @param {string | Buffer} data - Data to encrypt\n * @param {string | Buffer} key - Encryption key or passphrase\n * @param {EncryptionOptions} [options] - Encryption options\n * @returns {Promise<EncryptionResult>} Encrypted data with metadata\n */\nexport async function encrypt(\n  data: string | Buffer,\n  key: string | Buffer,\n  options: EncryptionOptions = {}\n): Promise<EncryptionResult> {\n  const algorithm = options.algorithm || 'aes-256-gcm';\n  const inputEncoding = options.inputEncoding || 'utf8';\n  const outputEncoding = options.outputEncoding || 'hex';\n\n  // Generate a random IV\n  const iv = randomBytes(16);\n\n  // Derive key using scrypt if key is a string (passphrase)\n  const derivedKey = typeof key === 'string' ? await scryptAsync(key, iv.slice(0, 8), 32) : key;\n\n  // Create cipher\n  const cipher = createCipheriv(algorithm, derivedKey, iv);\n\n  // Encrypt the data\n  let ciphertext: string | Buffer;\n\n  if (typeof data === 'string') {\n    ciphertext = cipher.update(data, inputEncoding, outputEncoding as BufferEncoding);\n    ciphertext += cipher.final(outputEncoding as BufferEncoding);\n  } else {\n    const encrypted = Buffer.concat([cipher.update(data), cipher.final()]);\n    ciphertext = outputEncoding ? encrypted.toString(outputEncoding) : encrypted;\n  }\n\n  // Get authentication tag if using GCM mode\n  const authTag = algorithm.includes('gcm') ? (cipher as any).getAuthTag() : undefined;\n\n  return {\n    ciphertext,\n    iv,\n    authTag,\n    algorithm\n  };\n}\n\n/**\n * Decrypts data that was encrypted with the encrypt function.\n *\n * @param {EncryptionResult} encryptedData - The encrypted data and metadata\n * @param {string | Buffer} key - Decryption key or passphrase\n * @param {DecryptionOptions} [options] - Decryption options\n * @returns {Promise<string | Buffer>} Decrypted data\n */\nexport async function decrypt(\n  encryptedData: EncryptionResult,\n  key: string | Buffer,\n  options: DecryptionOptions = {}\n): Promise<string | Buffer> {\n  const algorithm = options.algorithm || encryptedData.algorithm || 'aes-256-gcm';\n  const inputEncoding = options.inputEncoding || 'hex';\n  const outputEncoding = options.outputEncoding || 'utf8';\n\n  // Derive key using scrypt if key is a string (passphrase)\n  const derivedKey = typeof key === 'string' ? await scryptAsync(key, encryptedData.iv.slice(0, 8), 32) : key;\n\n  // Create decipher\n  const decipher = createDecipheriv(algorithm, derivedKey, encryptedData.iv);\n\n  // Set auth tag if using GCM mode\n  if (encryptedData.authTag && algorithm.includes('gcm')) {\n    (decipher as any).setAuthTag(encryptedData.authTag);\n  }\n\n  // Decrypt the data\n  let decrypted: string | Buffer;\n\n  if (typeof encryptedData.ciphertext === 'string') {\n    decrypted = decipher.update(encryptedData.ciphertext, inputEncoding as BufferEncoding, outputEncoding);\n    decrypted += decipher.final(outputEncoding);\n  } else {\n    const result = Buffer.concat([decipher.update(encryptedData.ciphertext), decipher.final()]);\n    decrypted = outputEncoding ? result.toString(outputEncoding) : result;\n  }\n\n  return decrypted;\n}\n\n/**\n * Creates a signed token with an expiration time and payload.\n *\n * @param {object} payload - Data to include in the token\n * @param {string} secret - Secret key for signing\n * @param {number} [expiresInSeconds=3600] - Token expiration in seconds\n * @returns {string} Signed token string\n */\nexport function createSignedToken(\n  payload: Record<string, any>,\n  secret: string,\n  expiresInSeconds: number = 3600\n): string {\n  // Create payload with expiration\n  const tokenPayload = {\n    ...payload,\n    exp: Math.floor(Date.now() / 1000) + expiresInSeconds\n  };\n\n  // Convert to string\n  const payloadStr = JSON.stringify(tokenPayload);\n\n  // Base64 encode the payload\n  const base64Payload = Buffer.from(payloadStr).toString('base64url');\n\n  // Create signature\n  const signature = hmac('sha256', base64Payload, secret, 'base64url');\n\n  // Combine payload and signature\n  return `${base64Payload}.${signature}`;\n}\n\n/**\n * Verifies and decodes a signed token.\n *\n * @param {string} token - The token to verify\n * @param {string} secret - Secret key for verification\n * @returns {object | null} Decoded payload if valid, null if invalid\n */\nexport function verifySignedToken(token: string, secret: string): Record<string, any> | null {\n  try {\n    // Split token into parts\n    const [payloadB64, signature] = token.split('.');\n\n    if (!payloadB64 || !signature) return null;\n\n    // Verify signature\n    const expectedSignature = hmac('sha256', payloadB64, secret, 'base64url');\n    if (!safeCompare(signature, expectedSignature)) return null;\n\n    // Decode payload\n    const payloadStr = Buffer.from(payloadB64, 'base64url').toString('utf8');\n    const payload = JSON.parse(payloadStr);\n\n    // Check expiration\n    if (payload.exp && payload.exp < Math.floor(Date.now() / 1000)) {\n      return null;\n    }\n\n    return payload;\n  } catch {\n    return null;\n  }\n}\n"]}

package/build/esm/utils/date.utils.d.ts

@@ -0,0 +1,159 @@
+/**
+ * Format options for the formatDate function
+ */
+export interface DateFormatOptions {
+    /** Date format pattern (default: 'yyyy-MM-dd') */
+    format?: string;
+    /** Locale to use for formatting (default: system locale) */
+    locale?: string | string[];
+    /** Time zone to use (default: system time zone) */
+    timeZone?: string;
+}
+/**
+ * Format a date according to the specified format pattern.
+ *
+ * @param date - Date to format
+ * @param options - Formatting options
+ * @returns Formatted date string
+ *
+ * @example
+ * ```typescript
+ * // Format as ISO date
+ * formatDate(new Date(), { format: 'yyyy-MM-dd' }); // '2023-05-15'
+ *
+ * // Format with time
+ * formatDate(new Date(), { format: 'yyyy-MM-dd HH:mm:ss' }); // '2023-05-15 14:30:22'
+ *
+ * // Format with locale
+ * formatDate(new Date(), { format: 'PPPP', locale: 'fr-FR' }); // 'lundi 15 mai 2023'
+ * ```
+ */
+export declare function formatDate(date: Date | number, options?: DateFormatOptions): string;
+/**
+ * Format a date as relative time (e.g., "5 minutes ago", "in 3 days").
+ *
+ * @param date - Date to format
+ * @param now - Reference date (default: current time)
+ * @param locale - Locale to use for formatting
+ * @returns Formatted relative time string
+ */
+export declare function formatRelativeTime(date: Date | number, now?: Date | number, locale?: string | string[]): string;
+/**
+ * Parse a date string or timestamp into a Date object.
+ *
+ * @param input - Date string or timestamp to parse
+ * @param fallback - Fallback date if parsing fails
+ * @returns Parsed Date object or fallback
+ *
+ * @example
+ * ```typescript
+ * parseDate('2023-05-15'); // Date object for May 15, 2023
+ * parseDate('invalid', new Date()); // Returns current date as fallback
+ * ```
+ */
+export declare function parseDate(input: string | number, fallback?: Date): Date | null;
+/**
+ * Calculate the difference between two dates in the specified unit.
+ *
+ * @param date1 - First date
+ * @param date2 - Second date (default: current time)
+ * @param unit - Unit of time for the difference
+ * @returns Difference in the specified unit
+ *
+ * @example
+ * ```typescript
+ * // Get difference in days
+ * dateDiff(new Date('2023-05-15'), new Date('2023-05-10'), 'days'); // 5
+ *
+ * // Get difference in hours
+ * dateDiff(new Date('2023-05-15T10:00:00'), new Date('2023-05-15T06:00:00'), 'hours'); // 4
+ * ```
+ */
+export declare function dateDiff(date1: Date | number, date2?: Date | number, unit?: 'milliseconds' | 'seconds' | 'minutes' | 'hours' | 'days' | 'months' | 'years'): number;
+/**
+ * Add a specified amount of time to a date.
+ *
+ * @param date - Base date
+ * @param amount - Amount to add (can be negative)
+ * @param unit - Unit of time to add
+ * @returns New date with the addition
+ *
+ * @example
+ * ```typescript
+ * // Add 5 days
+ * addToDate(new Date('2023-05-15'), 5, 'days'); // Date for May 20, 2023
+ *
+ * // Subtract 2 hours
+ * addToDate(new Date('2023-05-15T10:00:00'), -2, 'hours'); // Date for May 15, 2023 08:00:00
+ * ```
+ */
+export declare function addToDate(date: Date | number, amount: number, unit: 'milliseconds' | 'seconds' | 'minutes' | 'hours' | 'days' | 'months' | 'years'): Date;
+/**
+ * Get the start of a time period containing the specified date.
+ *
+ * @param date - Date to get the start from
+ * @param unit - Time unit
+ * @returns Date object representing the start of the time unit
+ *
+ * @example
+ * ```typescript
+ * // Get start of day (midnight)
+ * startOf(new Date('2023-05-15T14:30:00'), 'day'); // Date for May 15, 2023 00:00:00
+ *
+ * // Get start of month
+ * startOf(new Date('2023-05-15'), 'month'); // Date for May 1, 2023
+ * ```
+ */
+export declare function startOf(date: Date | number, unit: 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year'): Date;
+/**
+ * Get the end of a time period containing the specified date.
+ *
+ * @param date - Date to get the end from
+ * @param unit - Time unit
+ * @returns Date object representing the end of the time unit
+ *
+ * @example
+ * ```typescript
+ * // Get end of day (23:59:59.999)
+ * endOf(new Date('2023-05-15T14:30:00'), 'day'); // Date for May 15, 2023 23:59:59.999
+ *
+ * // Get end of month
+ * endOf(new Date('2023-05-15'), 'month'); // Date for May 31, 2023 23:59:59.999
+ * ```
+ */
+export declare function endOf(date: Date | number, unit: 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year'): Date;
+/**
+ * Check if a date is between two other dates.
+ *
+ * @param date - Date to check
+ * @param start - Start date of the range
+ * @param end - End date of the range
+ * @param inclusive - Whether the comparison should be inclusive of start/end
+ * @returns True if the date is within the range
+ *
+ * @example
+ * ```typescript
+ * const date = new Date('2023-05-15');
+ * const start = new Date('2023-05-10');
+ * const end = new Date('2023-05-20');
+ *
+ * isBetween(date, start, end); // true
+ * ```
+ */
+export declare function isBetween(date: Date | number, start: Date | number, end: Date | number, inclusive?: boolean): boolean;
+/**
+ * Check if a year is a leap year.
+ *
+ * @param year - Year to check (or date object)
+ * @returns True if the year is a leap year
+ */
+export declare function isLeapYear(year: number | Date): boolean;
+/**
+ * Get the number of days in a month.
+ *
+ * @param year - Year
+ * @param month - Month (0-11)
+ * @returns Number of days in the month
+ */
+export declare function daysInMonth(year: number | Date, month?: number): number;
+//# sourceMappingURL=date.utils.d.ts.map