@catbee/utils 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +303 -107
- package/build/esm/config.d.ts +12 -0
- package/build/esm/config.js +12 -0
- package/build/esm/config.js.map +1 -1
- package/build/esm/index.d.ts +1 -0
- package/build/esm/index.js +1 -0
- package/build/esm/index.js.map +1 -1
- package/build/esm/types/api-response.d.ts +82 -0
- package/build/esm/types/api-response.js.map +1 -1
- package/build/esm/utils/array.utils.d.ts +64 -1
- package/build/esm/utils/array.utils.js +139 -2
- package/build/esm/utils/array.utils.js.map +1 -1
- package/build/esm/utils/async.utils.d.ts +60 -1
- package/build/esm/utils/async.utils.js +160 -2
- package/build/esm/utils/async.utils.js.map +1 -1
- package/build/esm/utils/cache.utils.d.ts +67 -4
- package/build/esm/utils/cache.utils.js +210 -28
- package/build/esm/utils/cache.utils.js.map +1 -1
- package/build/esm/utils/context-store.utils.d.ts +101 -0
- package/build/esm/utils/context-store.utils.js +182 -0
- package/build/esm/utils/context-store.utils.js.map +1 -1
- package/build/esm/utils/crypto.utils.d.ts +110 -8
- package/build/esm/utils/crypto.utils.js +298 -15
- package/build/esm/utils/crypto.utils.js.map +1 -1
- package/build/esm/utils/decorators.utils.d.ts +40 -0
- package/build/esm/utils/decorators.utils.js +312 -0
- package/build/esm/utils/decorators.utils.js.map +1 -0
- package/build/esm/utils/dir.utils.d.ts +121 -0
- package/build/esm/utils/dir.utils.js +577 -0
- package/build/esm/utils/dir.utils.js.map +1 -1
- package/build/esm/utils/env.utils.d.ts +83 -0
- package/build/esm/utils/env.utils.js +233 -0
- package/build/esm/utils/env.utils.js.map +1 -1
- package/build/esm/utils/exception.utils.d.ts +116 -0
- package/build/esm/utils/exception.utils.js +322 -0
- package/build/esm/utils/exception.utils.js.map +1 -1
- package/build/esm/utils/fs.utils.d.ts +132 -0
- package/build/esm/utils/fs.utils.js +421 -0
- package/build/esm/utils/fs.utils.js.map +1 -1
- package/build/esm/utils/http-status-codes.d.ts +87 -178
- package/build/esm/utils/http-status-codes.js +92 -178
- package/build/esm/utils/http-status-codes.js.map +1 -1
- package/build/esm/utils/id.utils.d.ts +11 -10
- package/build/esm/utils/id.utils.js +29 -20
- package/build/esm/utils/id.utils.js.map +1 -1
- package/build/esm/utils/logger.utils.d.ts +24 -0
- package/build/esm/utils/logger.utils.js +54 -0
- package/build/esm/utils/logger.utils.js.map +1 -1
- package/build/esm/utils/middleware.utils.d.ts +72 -0
- package/build/esm/utils/middleware.utils.js +158 -0
- package/build/esm/utils/middleware.utils.js.map +1 -0
- package/build/esm/utils/obj.utils.d.ts +65 -3
- package/build/esm/utils/obj.utils.js +205 -6
- package/build/esm/utils/obj.utils.js.map +1 -1
- package/build/esm/utils/response.utils.d.ts +101 -0
- package/build/esm/utils/response.utils.js +153 -0
- package/build/esm/utils/response.utils.js.map +1 -1
- package/build/esm/utils/string.utils.d.ts +61 -5
- package/build/esm/utils/string.utils.js +101 -11
- package/build/esm/utils/string.utils.js.map +1 -1
- package/build/esm/utils/url.utils.d.ts +117 -0
- package/build/esm/utils/url.utils.js +287 -0
- package/build/esm/utils/url.utils.js.map +1 -1
- package/build/esm/utils/validate.utils.d.ts +110 -0
- package/build/esm/utils/validate.utils.js +186 -0
- package/build/esm/utils/validate.utils.js.map +1 -1
- package/build/esnext/config.d.ts +12 -0
- package/build/esnext/config.js +12 -0
- package/build/esnext/config.js.map +1 -1
- package/build/esnext/index.d.ts +1 -0
- package/build/esnext/index.js +1 -0
- package/build/esnext/index.js.map +1 -1
- package/build/esnext/types/api-response.d.ts +82 -0
- package/build/esnext/types/api-response.js.map +1 -1
- package/build/esnext/utils/array.utils.d.ts +64 -1
- package/build/esnext/utils/array.utils.js +129 -2
- package/build/esnext/utils/array.utils.js.map +1 -1
- package/build/esnext/utils/async.utils.d.ts +60 -1
- package/build/esnext/utils/async.utils.js +117 -1
- package/build/esnext/utils/async.utils.js.map +1 -1
- package/build/esnext/utils/cache.utils.d.ts +67 -4
- package/build/esnext/utils/cache.utils.js +137 -9
- package/build/esnext/utils/cache.utils.js.map +1 -1
- package/build/esnext/utils/context-store.utils.d.ts +101 -0
- package/build/esnext/utils/context-store.utils.js +168 -0
- package/build/esnext/utils/context-store.utils.js.map +1 -1
- package/build/esnext/utils/crypto.utils.d.ts +110 -8
- package/build/esnext/utils/crypto.utils.js +205 -15
- package/build/esnext/utils/crypto.utils.js.map +1 -1
- package/build/esnext/utils/decorators.utils.d.ts +40 -0
- package/build/esnext/utils/decorators.utils.js +155 -0
- package/build/esnext/utils/decorators.utils.js.map +1 -0
- package/build/esnext/utils/dir.utils.d.ts +121 -0
- package/build/esnext/utils/dir.utils.js +306 -0
- package/build/esnext/utils/dir.utils.js.map +1 -1
- package/build/esnext/utils/env.utils.d.ts +83 -0
- package/build/esnext/utils/env.utils.js +185 -0
- package/build/esnext/utils/env.utils.js.map +1 -1
- package/build/esnext/utils/exception.utils.d.ts +116 -0
- package/build/esnext/utils/exception.utils.js +213 -0
- package/build/esnext/utils/exception.utils.js.map +1 -1
- package/build/esnext/utils/fs.utils.d.ts +132 -0
- package/build/esnext/utils/fs.utils.js +268 -0
- package/build/esnext/utils/fs.utils.js.map +1 -1
- package/build/esnext/utils/http-status-codes.d.ts +87 -178
- package/build/esnext/utils/http-status-codes.js +92 -178
- package/build/esnext/utils/http-status-codes.js.map +1 -1
- package/build/esnext/utils/id.utils.d.ts +11 -10
- package/build/esnext/utils/id.utils.js +27 -19
- package/build/esnext/utils/id.utils.js.map +1 -1
- package/build/esnext/utils/logger.utils.d.ts +24 -0
- package/build/esnext/utils/logger.utils.js +42 -0
- package/build/esnext/utils/logger.utils.js.map +1 -1
- package/build/esnext/utils/middleware.utils.d.ts +72 -0
- package/build/esnext/utils/middleware.utils.js +157 -0
- package/build/esnext/utils/middleware.utils.js.map +1 -0
- package/build/esnext/utils/obj.utils.d.ts +65 -3
- package/build/esnext/utils/obj.utils.js +167 -3
- package/build/esnext/utils/obj.utils.js.map +1 -1
- package/build/esnext/utils/response.utils.d.ts +101 -0
- package/build/esnext/utils/response.utils.js +138 -0
- package/build/esnext/utils/response.utils.js.map +1 -1
- package/build/esnext/utils/string.utils.d.ts +61 -5
- package/build/esnext/utils/string.utils.js +110 -14
- package/build/esnext/utils/string.utils.js.map +1 -1
- package/build/esnext/utils/url.utils.d.ts +117 -0
- package/build/esnext/utils/url.utils.js +248 -0
- package/build/esnext/utils/url.utils.js.map +1 -1
- package/build/esnext/utils/validate.utils.d.ts +110 -0
- package/build/esnext/utils/validate.utils.js +184 -0
- package/build/esnext/utils/validate.utils.js.map +1 -1
- package/build/src/config.d.ts +12 -0
- package/build/src/config.js +12 -0
- package/build/src/config.js.map +1 -1
- package/build/src/index.d.ts +1 -0
- package/build/src/index.js +1 -0
- package/build/src/index.js.map +1 -1
- package/build/src/types/api-response.d.ts +82 -0
- package/build/src/types/api-response.js.map +1 -1
- package/build/src/utils/array.utils.d.ts +64 -1
- package/build/src/utils/array.utils.js +137 -4
- package/build/src/utils/array.utils.js.map +1 -1
- package/build/src/utils/async.utils.d.ts +60 -1
- package/build/src/utils/async.utils.js +124 -4
- package/build/src/utils/async.utils.js.map +1 -1
- package/build/src/utils/cache.utils.d.ts +67 -4
- package/build/src/utils/cache.utils.js +137 -9
- package/build/src/utils/cache.utils.js.map +1 -1
- package/build/src/utils/context-store.utils.d.ts +101 -0
- package/build/src/utils/context-store.utils.js +171 -1
- package/build/src/utils/context-store.utils.js.map +1 -1
- package/build/src/utils/crypto.utils.d.ts +110 -8
- package/build/src/utils/crypto.utils.js +224 -27
- package/build/src/utils/crypto.utils.js.map +1 -1
- package/build/src/utils/decorators.utils.d.ts +40 -0
- package/build/src/utils/decorators.utils.js +165 -0
- package/build/src/utils/decorators.utils.js.map +1 -0
- package/build/src/utils/dir.utils.d.ts +121 -0
- package/build/src/utils/dir.utils.js +316 -0
- package/build/src/utils/dir.utils.js.map +1 -1
- package/build/src/utils/env.utils.d.ts +83 -0
- package/build/src/utils/env.utils.js +186 -1
- package/build/src/utils/env.utils.js.map +1 -1
- package/build/src/utils/exception.utils.d.ts +116 -0
- package/build/src/utils/exception.utils.js +226 -1
- package/build/src/utils/exception.utils.js.map +1 -1
- package/build/src/utils/fs.utils.d.ts +132 -0
- package/build/src/utils/fs.utils.js +282 -0
- package/build/src/utils/fs.utils.js.map +1 -1
- package/build/src/utils/http-status-codes.d.ts +87 -178
- package/build/src/utils/http-status-codes.js +92 -178
- package/build/src/utils/http-status-codes.js.map +1 -1
- package/build/src/utils/id.utils.d.ts +11 -10
- package/build/src/utils/id.utils.js +27 -19
- package/build/src/utils/id.utils.js.map +1 -1
- package/build/src/utils/logger.utils.d.ts +24 -0
- package/build/src/utils/logger.utils.js +45 -0
- package/build/src/utils/logger.utils.js.map +1 -1
- package/build/src/utils/middleware.utils.d.ts +72 -0
- package/build/src/utils/middleware.utils.js +163 -0
- package/build/src/utils/middleware.utils.js.map +1 -0
- package/build/src/utils/obj.utils.d.ts +65 -3
- package/build/src/utils/obj.utils.js +177 -7
- package/build/src/utils/obj.utils.js.map +1 -1
- package/build/src/utils/response.utils.d.ts +101 -0
- package/build/src/utils/response.utils.js +146 -1
- package/build/src/utils/response.utils.js.map +1 -1
- package/build/src/utils/string.utils.d.ts +61 -5
- package/build/src/utils/string.utils.js +122 -20
- package/build/src/utils/string.utils.js.map +1 -1
- package/build/src/utils/url.utils.d.ts +117 -0
- package/build/src/utils/url.utils.js +257 -0
- package/build/src/utils/url.utils.js.map +1 -1
- package/build/src/utils/validate.utils.d.ts +110 -0
- package/build/src/utils/validate.utils.js +198 -0
- package/build/src/utils/validate.utils.js.map +1 -1
- package/package.json +20 -12
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"dir.utils.js","sourceRoot":"","sources":["../../../src/utils/dir.utils.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,GAAG,MAAM,aAAa,CAAC;AAC9B,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB;;;;;;GAMG;AACH,MAAM,UAAgB,SAAS,CAAC,OAAe;;;;wBAC7C,qBAAM,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,EAAA;;oBAA7C,SAA6C,CAAC;;;;;CAC/C;AAED;;;;;;;GAOG;AACH,MAAM,UAAgB,SAAS;wDAC7B,OAAe,EACf,SAAiB;;;QAAjB,0BAAA,EAAA,iBAAiB;;;wBAED,qBAAM,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,EAAA;;oBAA7D,OAAO,GAAG,SAAmD;oBAC7D,KAAK,GAAa,EAAE,CAAC;;;;oBAEP,YAAA,SAAA,OAAO,CAAA;;;;oBAAhB,KAAK;oBACR,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;yBAE5C,KAAK,CAAC,MAAM,EAAE,EAAd,wBAAc;oBAChB,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;;;yBACZ,CAAA,SAAS,IAAI,KAAK,CAAC,WAAW,EAAE,CAAA,EAAhC,wBAAgC;oBACrB,qBAAM,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAA;;oBAA7C,WAAW,GAAG,SAA+B;oBACnD,KAAK,CAAC,IAAI,OAAV,KAAK,2BAAS,WAAW,WAAE;;;;;;;;;;;;;;;;yBAI/B,sBAAO,KAAK,EAAC;;;;CACd;AAED;;;;;;GAMG;AACH,MAAM,UAAgB,kBAAkB,CAAC,OAAe;;;;wBACtD,qBAAM,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,EAAA;;oBAAvD,SAAuD,CAAC;;;;;CACzD;AAED;;;;;GAKG;AACH,MAAM,UAAgB,WAAW,CAAC,OAAe;;;;;;;oBAEhC,qBAAM,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,EAAA;;oBAA9B,IAAI,GAAG,SAAuB;oBACpC,sBAAO,IAAI,CAAC,WAAW,EAAE,EAAC;;;oBAE1B,sBAAO,KAAK,EAAC;;;;;CAEhB;AAED;;;;;;;GAOG;AACH,MAAM,UAAgB,OAAO,CAAC,GAAW,EAAE,IAAY;;;;;;wBACrD,qBAAM,SAAS,CAAC,IAAI,CAAC,EAAA;;oBAArB,SAAqB,CAAC;oBACN,qBAAM,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,EAAA;;oBAAzD,OAAO,GAAG,SAA+C;;;;oBAE3C,YAAA,SAAA,OAAO,CAAA;;;;oBAAhB,KAAK;oBACR,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;oBACrC,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;yBAEzC,KAAK,CAAC,WAAW,EAAE,EAAnB,wBAAmB;oBACrB,qBAAM,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAA;;oBAAhC,SAAgC,CAAC;;wBAEjC,qBAAM,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAA;;oBAArC,SAAqC,CAAC;;;;;;;;;;;;;;;;;;;;CAG3C;AAED;;;;;;;GAOG;AACH,MAAM,UAAgB,OAAO,CAAC,GAAW,EAAE,IAAY;;;;wBACrD,qBAAM,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,EAAA;;oBAAxB,SAAwB,CAAC;oBACzB,qBAAM,kBAAkB,CAAC,GAAG,CAAC,EAAA;;oBAA7B,SAA6B,CAAC;;;;;CAC/B;AAED;;;;;;GAMG;AACH,MAAM,UAAgB,QAAQ,CAAC,OAAe;;;;;;wBAC5B,qBAAM,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,EAAA;;oBAA7D,OAAO,GAAG,SAAmD;;;;oBAE/C,YAAA,SAAA,OAAO,CAAA;;;;oBAAhB,KAAK;oBACR,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;yBAE7C,KAAK,CAAC,WAAW,EAAE,EAAnB,wBAAmB;oBACrB,qBAAM,GAAG,CAAC,EAAE,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,EAAA;;oBAAzD,SAAyD,CAAC;;wBAE1D,qBAAM,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,EAAA;;oBAA3B,SAA2B,CAAC;;;;;;;;;;;;;;;;;;;;CAGjC;AAED;;;;;;GAMG;AACH,MAAM,UAAgB,UAAU,CAAC,OAAe;;;;;;;oBAC1C,KAAK,GAAG,CAAC,CAAC;oBACE,qBAAM,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,EAAA;;oBAA7D,OAAO,GAAG,SAAmD;;;;oBAE/C,YAAA,SAAA,OAAO,CAAA;;;;oBAAhB,KAAK;oBACR,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;yBAC7C,KAAK,CAAC,WAAW,EAAE,EAAnB,wBAAmB;oBACrB,KAAA,KAAK,CAAA;oBAAI,qBAAM,UAAU,CAAC,SAAS,CAAC,EAAA;;oBAApC,KAAK,GAAL,KAAS,SAA2B,CAAC;;wBAExB,qBAAM,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAA;;oBAAhC,IAAI,GAAG,SAAyB;oBACtC,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC;;;;;;;;;;;;;;;;yBAIvB,sBAAO,KAAK,EAAC;;;;CACd;AAED;;;;;;GAMG;AACH,MAAM,UAAU,QAAQ,CACtB,OAAe,EACf,QAA2E;IAE3E,IAAM,OAAO,GAAG,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,UAAC,SAAS,EAAE,QAAQ;QACpD,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,OAAO,cAAM,OAAA,OAAO,CAAC,KAAK,EAAE,EAAf,CAAe,CAAC;AAC/B,CAAC","sourcesContent":["import fs from \"fs\";\nimport fsp from \"fs/promises\";\nimport path from \"path\";\n\n/**\n * Ensures that a directory exists, creating parent directories if needed (like `mkdir -p`).\n *\n * @param {string} dirPath - The directory path to ensure.\n * @returns {Promise<void>} Resolves when the directory exists.\n * @throws {Error} If directory cannot be created.\n */\nexport async function ensureDir(dirPath: string): Promise<void> {\n await fsp.mkdir(dirPath, { recursive: true });\n}\n\n/**\n * Recursively lists all files in a directory.\n *\n * @param {string} dirPath - The base directory.\n * @param {boolean} [recursive=false] - Whether to recurse into subdirectories.\n * @returns {Promise<string[]>} Array of absolute file paths.\n * @throws {Error} If the directory cannot be read.\n */\nexport async function listFiles(\n dirPath: string,\n recursive = false,\n): Promise<string[]> {\n const entries = await fsp.readdir(dirPath, { withFileTypes: true });\n const files: string[] = [];\n\n for (const entry of entries) {\n const fullPath = path.join(dirPath, entry.name);\n\n if (entry.isFile()) {\n files.push(fullPath);\n } else if (recursive && entry.isDirectory()) {\n const nestedFiles = await listFiles(fullPath, true);\n files.push(...nestedFiles);\n }\n }\n\n return files;\n}\n\n/**\n * Deletes a directory and all its contents recursively (like `rm -rf`).\n *\n * @param {string} dirPath - Directory to delete.\n * @returns {Promise<void>} Resolves when deletion is complete.\n * @throws {Error} If deletion fails.\n */\nexport async function deleteDirRecursive(dirPath: string): Promise<void> {\n await fsp.rm(dirPath, { recursive: true, force: true });\n}\n\n/**\n * Checks whether a given path is a directory.\n *\n * @param {string} pathStr - Path to check.\n * @returns {Promise<boolean>} True if the path is a directory, else false.\n */\nexport async function isDirectory(pathStr: string): Promise<boolean> {\n try {\n const stat = await fsp.stat(pathStr);\n return stat.isDirectory();\n } catch {\n return false;\n }\n}\n\n/**\n * Recursively copies a directory and all its contents to a destination.\n *\n * @param {string} src - Source directory path.\n * @param {string} dest - Destination directory path.\n * @returns {Promise<void>} Resolves when copy is complete.\n * @throws {Error} If source does not exist or copy fails.\n */\nexport async function copyDir(src: string, dest: string): Promise<void> {\n await ensureDir(dest);\n const entries = await fsp.readdir(src, { withFileTypes: true });\n\n for (const entry of entries) {\n const srcPath = path.join(src, entry.name);\n const destPath = path.join(dest, entry.name);\n\n if (entry.isDirectory()) {\n await copyDir(srcPath, destPath);\n } else {\n await fsp.copyFile(srcPath, destPath);\n }\n }\n}\n\n/**\n * Moves a directory to a new location by copying and deleting the original.\n *\n * @param {string} src - Source directory path.\n * @param {string} dest - Destination directory path.\n * @returns {Promise<void>} Resolves when move is complete.\n * @throws {Error} If copy or deletion fails.\n */\nexport async function moveDir(src: string, dest: string): Promise<void> {\n await copyDir(src, dest);\n await deleteDirRecursive(src);\n}\n\n/**\n * Empties a directory by deleting all files and subdirectories inside it.\n *\n * @param {string} dirPath - Path to the directory to empty.\n * @returns {Promise<void>} Resolves when the directory has been emptied.\n * @throws {Error} If files or subdirectories cannot be removed.\n */\nexport async function emptyDir(dirPath: string): Promise<void> {\n const entries = await fsp.readdir(dirPath, { withFileTypes: true });\n\n for (const entry of entries) {\n const entryPath = path.join(dirPath, entry.name);\n\n if (entry.isDirectory()) {\n await fsp.rm(entryPath, { recursive: true, force: true });\n } else {\n await fsp.unlink(entryPath);\n }\n }\n}\n\n/**\n * Calculates the total size (in bytes) of all files in a directory (recursive).\n *\n * @param {string} dirPath - Path to the directory.\n * @returns {Promise<number>} Total size in bytes.\n * @throws {Error} If any file stats cannot be read.\n */\nexport async function getDirSize(dirPath: string): Promise<number> {\n let total = 0;\n const entries = await fsp.readdir(dirPath, { withFileTypes: true });\n\n for (const entry of entries) {\n const entryPath = path.join(dirPath, entry.name);\n if (entry.isDirectory()) {\n total += await getDirSize(entryPath);\n } else {\n const stat = await fsp.stat(entryPath);\n total += stat.size;\n }\n }\n\n return total;\n}\n\n/**\n * Watches a directory for file changes and calls a callback on each event.\n *\n * @param {string} dirPath - Directory path to watch.\n * @param {(eventType: \"rename\" | \"change\", filename: string | null) => void} callback - Callback for each change event.\n * @returns {() => void} A function to stop watching the directory.\n */\nexport function watchDir(\n dirPath: string,\n callback: (eventType: \"rename\" | \"change\", filename: string | null) => void,\n): () => void {\n const watcher = fs.watch(dirPath, (eventType, filename) => {\n callback(eventType, filename);\n });\n\n return () => watcher.close();\n}\n"]}
|
|
1
|
+
{"version":3,"file":"dir.utils.js","sourceRoot":"","sources":["../../../src/utils/dir.utils.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,GAAG,MAAM,aAAa,CAAC;AAC9B,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAC5B,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAErC;;;;;;GAMG;AACH,MAAM,UAAgB,SAAS,CAAC,OAAe;;;;wBAC7C,qBAAM,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,EAAA;;oBAA7C,SAA6C,CAAC;;;;;CAC/C;AAED;;;;;;;GAOG;AACH,MAAM,UAAgB,SAAS;wDAC7B,OAAe,EACf,SAAiB;;;QAAjB,0BAAA,EAAA,iBAAiB;;;wBAED,qBAAM,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,EAAA;;oBAA7D,OAAO,GAAG,SAAmD;oBAC7D,KAAK,GAAa,EAAE,CAAC;;;;oBAEP,YAAA,SAAA,OAAO,CAAA;;;;oBAAhB,KAAK;oBACR,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;yBAE5C,KAAK,CAAC,MAAM,EAAE,EAAd,wBAAc;oBAChB,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;;;yBACZ,CAAA,SAAS,IAAI,KAAK,CAAC,WAAW,EAAE,CAAA,EAAhC,wBAAgC;oBACrB,qBAAM,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAA;;oBAA7C,WAAW,GAAG,SAA+B;oBACnD,KAAK,CAAC,IAAI,OAAV,KAAK,2BAAS,WAAW,WAAE;;;;;;;;;;;;;;;;yBAI/B,sBAAO,KAAK,EAAC;;;;CACd;AAED;;;;;;GAMG;AACH,MAAM,UAAgB,kBAAkB,CAAC,OAAe;;;;wBACtD,qBAAM,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,EAAA;;oBAAvD,SAAuD,CAAC;;;;;CACzD;AAED;;;;;GAKG;AACH,MAAM,UAAgB,WAAW,CAAC,OAAe;;;;;;;oBAEhC,qBAAM,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,EAAA;;oBAA9B,IAAI,GAAG,SAAuB;oBACpC,sBAAO,IAAI,CAAC,WAAW,EAAE,EAAC;;;oBAE1B,sBAAO,KAAK,EAAC;;;;;CAEhB;AAED;;;;;;;GAOG;AACH,MAAM,UAAgB,OAAO,CAAC,GAAW,EAAE,IAAY;;;;;;wBACrD,qBAAM,SAAS,CAAC,IAAI,CAAC,EAAA;;oBAArB,SAAqB,CAAC;oBACN,qBAAM,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,EAAA;;oBAAzD,OAAO,GAAG,SAA+C;;;;oBAE3C,YAAA,SAAA,OAAO,CAAA;;;;oBAAhB,KAAK;oBACR,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;oBACrC,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;yBAEzC,KAAK,CAAC,WAAW,EAAE,EAAnB,wBAAmB;oBACrB,qBAAM,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAA;;oBAAhC,SAAgC,CAAC;;wBAEjC,qBAAM,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAA;;oBAArC,SAAqC,CAAC;;;;;;;;;;;;;;;;;;;;CAG3C;AAED;;;;;;;GAOG;AACH,MAAM,UAAgB,OAAO,CAAC,GAAW,EAAE,IAAY;;;;wBACrD,qBAAM,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,EAAA;;oBAAxB,SAAwB,CAAC;oBACzB,qBAAM,kBAAkB,CAAC,GAAG,CAAC,EAAA;;oBAA7B,SAA6B,CAAC;;;;;CAC/B;AAED;;;;;;GAMG;AACH,MAAM,UAAgB,QAAQ,CAAC,OAAe;;;;;;wBAC5B,qBAAM,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,EAAA;;oBAA7D,OAAO,GAAG,SAAmD;;;;oBAE/C,YAAA,SAAA,OAAO,CAAA;;;;oBAAhB,KAAK;oBACR,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;yBAE7C,KAAK,CAAC,WAAW,EAAE,EAAnB,wBAAmB;oBACrB,qBAAM,GAAG,CAAC,EAAE,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,EAAA;;oBAAzD,SAAyD,CAAC;;wBAE1D,qBAAM,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,EAAA;;oBAA3B,SAA2B,CAAC;;;;;;;;;;;;;;;;;;;;CAGjC;AAED;;;;;;GAMG;AACH,MAAM,UAAgB,UAAU,CAAC,OAAe;;;;;;;oBAC1C,KAAK,GAAG,CAAC,CAAC;oBACE,qBAAM,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,EAAA;;oBAA7D,OAAO,GAAG,SAAmD;;;;oBAE/C,YAAA,SAAA,OAAO,CAAA;;;;oBAAhB,KAAK;oBACR,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;yBAC7C,KAAK,CAAC,WAAW,EAAE,EAAnB,wBAAmB;oBACrB,KAAA,KAAK,CAAA;oBAAI,qBAAM,UAAU,CAAC,SAAS,CAAC,EAAA;;oBAApC,KAAK,GAAL,KAAS,SAA2B,CAAC;;wBAExB,qBAAM,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAA;;oBAAhC,IAAI,GAAG,SAAyB;oBACtC,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC;;;;;;;;;;;;;;;;yBAIvB,sBAAO,KAAK,EAAC;;;;CACd;AAED;;;;;;GAMG;AACH,MAAM,UAAU,QAAQ,CACtB,OAAe,EACf,QAA2E;IAE3E,IAAM,OAAO,GAAG,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,UAAC,SAAS,EAAE,QAAQ;QACpD,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,OAAO,cAAM,OAAA,OAAO,CAAC,KAAK,EAAE,EAAf,CAAe,CAAC;AAC/B,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAgB,kBAAkB;wDACtC,OAAe,EACf,OAA8D;;QAA9D,wBAAA,EAAA,YAA8D;;YAExD,cAAc,cAAK,KAAK,EAAE,IAAI,IAAK,OAAO,CAAE,CAAC;YACnD,sBAAO,IAAI,CAAC,OAAO,EAAE,cAAc,CAAC,EAAC;;;CACtC;AAED;;;;;;;GAOG;AACH,MAAM,UAAgB,iBAAiB;wDACrC,OAAe,EACf,SAAiB;;QAAjB,0BAAA,EAAA,iBAAiB;;;wBAED,qBAAM,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,EAAA;;oBAA7D,OAAO,GAAG,SAAmD;oBAC7D,IAAI,GAAG,OAAO;yBACjB,MAAM,CAAC,UAAC,KAAK,IAAK,OAAA,KAAK,CAAC,WAAW,EAAE,EAAnB,CAAmB,CAAC;yBACtC,GAAG,CAAC,UAAC,KAAK,IAAK,OAAA,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,EAA9B,CAA8B,CAAC,CAAC;yBAE9C,CAAA,SAAS,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,CAAA,EAA5B,wBAA4B;oBACX,qBAAM,OAAO,CAAC,GAAG,CAClC,IAAI,CAAC,GAAG,CAAC,UAAC,GAAG,IAAK,OAAA,iBAAiB,CAAC,GAAG,EAAE,IAAI,CAAC,EAA5B,CAA4B,CAAC,CAChD,EAAA;;oBAFK,UAAU,GAAG,SAElB;oBACD,6DAAW,IAAI,kBAAK,UAAU,CAAC,IAAI,EAAE,WAAE;wBAGzC,sBAAO,IAAI,EAAC;;;;CACb;AAED;;;;;;GAMG;AACH,MAAM,UAAgB,cAAc,CAAC,OAAe;;;;;wBAC9C,qBAAM,WAAW,CAAC,OAAO,CAAC,EAAA;;yBAA1B,SAA0B,EAA1B,wBAA0B;oBAC5B,qBAAM,QAAQ,CAAC,OAAO,CAAC,EAAA;;oBAAvB,SAAuB,CAAC;;;;oBAGtB,qBAAM,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,EAAA;;oBAAzB,SAAyB,CAAC;;;;oBAE1B,+BAA+B;oBAC/B,IAAK,OAA+B,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;wBACvD,MAAM,OAAK,CAAC;oBACd,CAAC;;wBAEH,qBAAM,SAAS,CAAC,OAAO,CAAC,EAAA;;oBAAxB,SAAwB,CAAC;;;;;;CAE5B;AAED;;;;;;;;;GASG;AACH,MAAM,UAAgB,aAAa;wDACjC,OAAwE;;;QAAxE,wBAAA,EAAA,YAAwE;;;;oBAElE,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC;oBAClC,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC,MAAM,EAAE,CAAC;oBAC7C,OAAO,GAAG,UAAG,MAAM,SAAG,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAE,CAAC;oBACvD,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;oBAElD,qBAAM,SAAS,CAAC,WAAW,CAAC,EAAA;;oBAA5B,SAA4B,CAAC;oBAEvB,OAAO,GAAG;;;;;;oCAEZ,qBAAM,kBAAkB,CAAC,WAAW,CAAC,EAAA;;oCAArC,SAAqC,CAAC;;;;;;;;yBAIzC,CAAC;oBAEF,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;wBACpB,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE;4BACnB,IAAI,CAAC;gCACH,EAAE,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;4BAC3D,CAAC;4BAAC,WAAM,CAAC;gCACP,gCAAgC;4BAClC,CAAC;wBACH,CAAC,CAAC,CAAC;wBAEH,oCAAoC;wBACpC,CAAC,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,OAAO,CAAC,UAAC,MAAM;4BACzD,OAAO,CAAC,IAAI,CAAC,MAAwB,EAAE;gCACrC,OAAO,EAAE,CAAC,IAAI,CAAC,cAAM,OAAA,OAAO,CAAC,IAAI,EAAE,EAAd,CAAc,CAAC,CAAC;4BACvC,CAAC,CAAC,CAAC;wBACL,CAAC,CAAC,CAAC;oBACL,CAAC;oBAED,sBAAO,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,SAAA,EAAE,EAAC;;;;CACvC;AAED;;;;;;;GAOG;AACH,MAAM,UAAgB,cAAc;wDAClC,OAAe,EACf,SAAiB;;;QAAjB,0BAAA,EAAA,iBAAiB;;;wBAEH,qBAAM,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC,EAAA;;oBAA3C,KAAK,GAAG,SAAmC;oBACjD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;wBAAE,sBAAO,IAAI,EAAC;oBAEtB,qBAAM,OAAO,CAAC,GAAG,CAC7B,KAAK,CAAC,GAAG,CAAC,UAAO,IAAI;;;;;;4CACnB,IAAI,EAAE,IAAI;;wCACF,qBAAM,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAA;4CAFJ,sBAAA,CAExB,QAAK,GAAE,CAAC,SAAoB,CAAC,CAAC,KAAK;+CACnC,EAAA;;;6BAAA,CAAC,CACJ,EAAA;;oBALK,KAAK,GAAG,SAKb;oBAED,sBAAO,KAAK,CAAC,IAAI,CAAC,UAAC,CAAC,EAAE,CAAC,IAAK,OAAA,CAAC,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,EAAE,EAArC,CAAqC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAC;;;;CAC5E;AAED;;;;;;;GAOG;AACH,MAAM,UAAgB,cAAc;wDAClC,OAAe,EACf,SAAiB;;;QAAjB,0BAAA,EAAA,iBAAiB;;;wBAEH,qBAAM,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC,EAAA;;oBAA3C,KAAK,GAAG,SAAmC;oBACjD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;wBAAE,sBAAO,IAAI,EAAC;oBAEtB,qBAAM,OAAO,CAAC,GAAG,CAC7B,KAAK,CAAC,GAAG,CAAC,UAAO,IAAI;;;;;;4CACnB,IAAI,EAAE,IAAI;;wCACF,qBAAM,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAA;4CAFJ,sBAAA,CAExB,QAAK,GAAE,CAAC,SAAoB,CAAC,CAAC,KAAK;+CACnC,EAAA;;;6BAAA,CAAC,CACJ,EAAA;;oBALK,KAAK,GAAG,SAKb;oBAED,sBAAO,KAAK,CAAC,IAAI,CAAC,UAAC,CAAC,EAAE,CAAC,IAAK,OAAA,CAAC,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,EAAE,EAArC,CAAqC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAC;;;;CAC5E;AAED;;;;;;;;GAQG;AACH,MAAM,UAAgB,SAAS;wDAC7B,OAAe,EACf,SAAuE,EACvE,SAAiB;;;QAAjB,0BAAA,EAAA,iBAAiB;;;wBAED,qBAAM,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,EAAA;;oBAA7D,OAAO,GAAG,SAAmD;oBAC7D,OAAO,GAAa,EAAE,CAAC;;;;oBAET,YAAA,SAAA,OAAO,CAAA;;;;oBAAhB,KAAK;oBACR,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;oBACpC,qBAAM,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAA;;oBAAhC,IAAI,GAAG,SAAyB;oBAElC,qBAAM,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,EAAA;;oBAApC,IAAI,SAAgC,EAAE,CAAC;wBACrC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;oBAC1B,CAAC;yBAEG,CAAA,SAAS,IAAI,KAAK,CAAC,WAAW,EAAE,CAAA,EAAhC,wBAAgC;oBACZ,qBAAM,SAAS,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,EAAA;;oBAA3D,aAAa,GAAG,SAA2C;oBACjE,OAAO,CAAC,IAAI,OAAZ,OAAO,2BAAS,aAAa,WAAE;;;;;;;;;;;;;;;;yBAInC,sBAAO,OAAO,EAAC;;;;CAChB;AAED;;;;;;;;GAQG;AACH,MAAM,UAAgB,iBAAiB;wDACrC,OAAe,EACf,QAAoE,EACpE,cAAqB;;;;QAArB,+BAAA,EAAA,qBAAqB;;;;oBAGf,kBAAkB,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;oBAG7C,QAAQ,GAAmB,EAAE,CAAC;oBAG9B,UAAU,GAAG,UAAC,GAAW;wBAC7B,IAAI,CAAC;4BACH,IAAM,OAAO,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,UAAC,SAAS,EAAE,QAAQ;gCAChD,IAAI,CAAC,QAAQ;oCAAE,OAAO;gCAEtB,IAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;gCAC1C,+CAA+C;gCAC/C,IAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,kBAAkB,EAAE,QAAQ,CAAC,CAAC;gCACjE,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;gCAElC,oDAAoD;gCACpD,IAAI,SAAS,KAAK,QAAQ,IAAI,cAAc,EAAE,CAAC;oCAC7C,UAAU,CAAC;;;;;;oDAEH,qBAAM,WAAW,CAAC,QAAQ,CAAC,EAAA;;oDAA/B,IAAI,SAA2B,EAAE,CAAC;wDAChC,UAAU,CAAC,QAAQ,CAAC,CAAC;oDACvB,CAAC;;;;;;;;yCAIJ,EAAE,GAAG,CAAC,CAAC;gCACV,CAAC;4BACH,CAAC,CAAC,CAAC;4BACH,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;wBACzB,CAAC;wBAAC,WAAM,CAAC;4BACP,6CAA6C;wBAC/C,CAAC;oBACH,CAAC,CAAC;oBAEF,qCAAqC;oBACrC,UAAU,CAAC,kBAAkB,CAAC,CAAC;yBAG3B,cAAc,EAAd,wBAAc;oBACA,qBAAM,iBAAiB,CAAC,kBAAkB,EAAE,IAAI,CAAC,EAAA;;oBAA3D,OAAO,GAAG,SAAiD;;wBACjE,KAAqB,YAAA,SAAA,OAAO,CAAA,qFAAE,CAAC;4BAApB,MAAM;4BACf,UAAU,CAAC,MAAM,CAAC,CAAC;wBACrB,CAAC;;;;;;;;;;;gBAGH,0CAA0C;gBAC1C,sBAAO;wBACL,QAAQ,CAAC,OAAO,CAAC,UAAC,OAAO,IAAK,OAAA,OAAO,CAAC,KAAK,EAAE,EAAf,CAAe,CAAC,CAAC;oBACjD,CAAC,EAAC;;;;CACH;AAED;;;;;;GAMG;AACH,MAAM,UAAgB,WAAW,CAC/B,OAAe;;QAMf,SAAe,UAAU,CAAC,WAAmB;;;;;;gCAC3B,qBAAM,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,EAAA;;4BAAjE,OAAO,GAAG,SAAuD;;;;4BAEnD,YAAA,SAAA,OAAO,CAAA;;;;4BAAhB,KAAK;4BACR,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;iCAEjD,KAAK,CAAC,WAAW,EAAE,EAAnB,wBAAmB;4BACrB,QAAQ,EAAE,CAAC;4BACX,qBAAM,UAAU,CAAC,SAAS,CAAC,EAAA;;4BAA3B,SAA2B,CAAC;;;iCACnB,KAAK,CAAC,MAAM,EAAE,EAAd,wBAAc;4BACvB,SAAS,EAAE,CAAC;4BACC,qBAAM,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAA;;4BAAhC,IAAI,GAAG,SAAyB;4BACtC,SAAS,IAAI,IAAI,CAAC,IAAI,CAAC;;;;;;;;;;;;;;;;;;;;SAG5B;;;;;oBAnBG,SAAS,GAAG,CAAC,CAAC;oBACd,QAAQ,GAAG,CAAC,CAAC;oBACb,SAAS,GAAG,CAAC,CAAC;oBAmBlB,qBAAM,UAAU,CAAC,OAAO,CAAC,EAAA;;oBAAzB,SAAyB,CAAC;oBAE1B,sBAAO,EAAE,SAAS,WAAA,EAAE,QAAQ,UAAA,EAAE,SAAS,WAAA,EAAE,EAAC;;;;CAC3C;AAED;;;;;;;;;GASG;AACH,MAAM,UAAgB,OAAO,CAC3B,OAAe,EACf,OAQC;;;;;;;oBAEK,cAAc,GAAG,OAAO,CAAC,cAAc,IAAI,KAAK,CAAC;oBACvC,qBAAM,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,EAAA;;oBAA7D,OAAO,GAAG,SAAmD;;;;oBAE/C,YAAA,SAAA,OAAO,CAAA;;;;oBAAhB,KAAK;oBACR,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;oBACnC,qBAAM,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAA;;oBAAjC,KAAK,GAAG,SAAyB;oBACjC,SAAS,GAAG;wBAChB,IAAI,EAAE,SAAS;wBACf,IAAI,EAAE,KAAK,CAAC,IAAI;wBAChB,WAAW,EAAE,KAAK,CAAC,WAAW,EAAE;wBAChC,KAAK,OAAA;qBACN,CAAC;yBAEE,KAAK,CAAC,WAAW,EAAE,EAAnB,yBAAmB;yBAEjB,CAAA,cAAc,KAAK,KAAK,CAAA,EAAxB,wBAAwB;oBACH,qBAAM,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,EAAA;;oBAAnD,cAAc,GAAG,SAAkC;yBAErD,CAAA,cAAc,KAAK,KAAK,CAAA,EAAxB,wBAAwB;oBAC1B,qBAAM,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,EAAA;;oBAAjC,SAAiC,CAAC;;;;gBAGpC,iDAAiD;gBACjD,qBAAM,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,EAAA;;oBADjC,iDAAiD;oBACjD,SAAiC,CAAC;oBAClC,qBAAM,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,EAAA;;oBAAlC,SAAkC,CAAC;;;;gBAGrC,4CAA4C;gBAC5C,qBAAM,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,EAAA;;oBADlC,4CAA4C;oBAC5C,SAAkC,CAAC;;;;;;;;;;;;;;;;;yBAInC,CAAA,cAAc,KAAK,MAAM,CAAA,EAAzB,yBAAyB;oBAGb,qBAAM,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,EAAA;;oBAA/B,KAAK,GAAG,SAAuB;oBAC/B,SAAS,GAAG;wBAChB,IAAI,EAAE,OAAO;wBACb,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;wBAC5B,WAAW,EAAE,IAAI;wBACjB,KAAK,OAAA;qBACN,CAAC;oBACF,qBAAM,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,EAAA;;oBAAlC,SAAkC,CAAC;;;;;;CAEtC","sourcesContent":["import os from \"os\";\nimport fs from \"fs\";\nimport fsp from \"fs/promises\";\nimport path from \"path\";\nimport { glob } from \"glob\";\nimport { randomBytes } from \"crypto\";\n\n/**\n * Ensures that a directory exists, creating parent directories if needed (like `mkdir -p`).\n *\n * @param {string} dirPath - The directory path to ensure.\n * @returns {Promise<void>} Resolves when the directory exists.\n * @throws {Error} If directory cannot be created.\n */\nexport async function ensureDir(dirPath: string): Promise<void> {\n await fsp.mkdir(dirPath, { recursive: true });\n}\n\n/**\n * Recursively lists all files in a directory.\n *\n * @param {string} dirPath - The base directory.\n * @param {boolean} [recursive=false] - Whether to recurse into subdirectories.\n * @returns {Promise<string[]>} Array of absolute file paths.\n * @throws {Error} If the directory cannot be read.\n */\nexport async function listFiles(\n dirPath: string,\n recursive = false,\n): Promise<string[]> {\n const entries = await fsp.readdir(dirPath, { withFileTypes: true });\n const files: string[] = [];\n\n for (const entry of entries) {\n const fullPath = path.join(dirPath, entry.name);\n\n if (entry.isFile()) {\n files.push(fullPath);\n } else if (recursive && entry.isDirectory()) {\n const nestedFiles = await listFiles(fullPath, true);\n files.push(...nestedFiles);\n }\n }\n\n return files;\n}\n\n/**\n * Deletes a directory and all its contents recursively (like `rm -rf`).\n *\n * @param {string} dirPath - Directory to delete.\n * @returns {Promise<void>} Resolves when deletion is complete.\n * @throws {Error} If deletion fails.\n */\nexport async function deleteDirRecursive(dirPath: string): Promise<void> {\n await fsp.rm(dirPath, { recursive: true, force: true });\n}\n\n/**\n * Checks whether a given path is a directory.\n *\n * @param {string} pathStr - Path to check.\n * @returns {Promise<boolean>} True if the path is a directory, else false.\n */\nexport async function isDirectory(pathStr: string): Promise<boolean> {\n try {\n const stat = await fsp.stat(pathStr);\n return stat.isDirectory();\n } catch {\n return false;\n }\n}\n\n/**\n * Recursively copies a directory and all its contents to a destination.\n *\n * @param {string} src - Source directory path.\n * @param {string} dest - Destination directory path.\n * @returns {Promise<void>} Resolves when copy is complete.\n * @throws {Error} If source does not exist or copy fails.\n */\nexport async function copyDir(src: string, dest: string): Promise<void> {\n await ensureDir(dest);\n const entries = await fsp.readdir(src, { withFileTypes: true });\n\n for (const entry of entries) {\n const srcPath = path.join(src, entry.name);\n const destPath = path.join(dest, entry.name);\n\n if (entry.isDirectory()) {\n await copyDir(srcPath, destPath);\n } else {\n await fsp.copyFile(srcPath, destPath);\n }\n }\n}\n\n/**\n * Moves a directory to a new location by copying and deleting the original.\n *\n * @param {string} src - Source directory path.\n * @param {string} dest - Destination directory path.\n * @returns {Promise<void>} Resolves when move is complete.\n * @throws {Error} If copy or deletion fails.\n */\nexport async function moveDir(src: string, dest: string): Promise<void> {\n await copyDir(src, dest);\n await deleteDirRecursive(src);\n}\n\n/**\n * Empties a directory by deleting all files and subdirectories inside it.\n *\n * @param {string} dirPath - Path to the directory to empty.\n * @returns {Promise<void>} Resolves when the directory has been emptied.\n * @throws {Error} If files or subdirectories cannot be removed.\n */\nexport async function emptyDir(dirPath: string): Promise<void> {\n const entries = await fsp.readdir(dirPath, { withFileTypes: true });\n\n for (const entry of entries) {\n const entryPath = path.join(dirPath, entry.name);\n\n if (entry.isDirectory()) {\n await fsp.rm(entryPath, { recursive: true, force: true });\n } else {\n await fsp.unlink(entryPath);\n }\n }\n}\n\n/**\n * Calculates the total size (in bytes) of all files in a directory (recursive).\n *\n * @param {string} dirPath - Path to the directory.\n * @returns {Promise<number>} Total size in bytes.\n * @throws {Error} If any file stats cannot be read.\n */\nexport async function getDirSize(dirPath: string): Promise<number> {\n let total = 0;\n const entries = await fsp.readdir(dirPath, { withFileTypes: true });\n\n for (const entry of entries) {\n const entryPath = path.join(dirPath, entry.name);\n if (entry.isDirectory()) {\n total += await getDirSize(entryPath);\n } else {\n const stat = await fsp.stat(entryPath);\n total += stat.size;\n }\n }\n\n return total;\n}\n\n/**\n * Watches a directory for file changes and calls a callback on each event.\n *\n * @param {string} dirPath - Directory path to watch.\n * @param {(eventType: \"rename\" | \"change\", filename: string | null) => void} callback - Callback for each change event.\n * @returns {() => void} A function to stop watching the directory.\n */\nexport function watchDir(\n dirPath: string,\n callback: (eventType: \"rename\" | \"change\", filename: string | null) => void,\n): () => void {\n const watcher = fs.watch(dirPath, (eventType, filename) => {\n callback(eventType, filename);\n });\n\n return () => watcher.close();\n}\n\n/**\n * Finds files matching a glob pattern.\n *\n * @param {string} pattern - Glob pattern to match files.\n * @param {object} [options] - Options for glob pattern matching.\n * @param {string} [options.cwd] - Current working directory for relative patterns.\n * @param {boolean} [options.dot=false] - Include dotfiles in matches.\n * @param {boolean} [options.nodir=true] - Only match files, not directories.\n * @returns {Promise<string[]>} Array of matched file paths.\n * @throws {Error} If pattern matching fails.\n */\nexport async function findFilesByPattern(\n pattern: string,\n options: { cwd?: string; dot?: boolean; nodir?: boolean } = {},\n): Promise<string[]> {\n const defaultOptions = { nodir: true, ...options };\n return glob(pattern, defaultOptions);\n}\n\n/**\n * Gets all subdirectories in a directory.\n *\n * @param {string} dirPath - The directory to search in.\n * @param {boolean} [recursive=false] - Whether to include subdirectories recursively.\n * @returns {Promise<string[]>} Array of absolute subdirectory paths.\n * @throws {Error} If directory cannot be read.\n */\nexport async function getSubdirectories(\n dirPath: string,\n recursive = false,\n): Promise<string[]> {\n const entries = await fsp.readdir(dirPath, { withFileTypes: true });\n const dirs = entries\n .filter((entry) => entry.isDirectory())\n .map((entry) => path.join(dirPath, entry.name));\n\n if (recursive && dirs.length > 0) {\n const nestedDirs = await Promise.all(\n dirs.map((dir) => getSubdirectories(dir, true)),\n );\n return [...dirs, ...nestedDirs.flat()];\n }\n\n return dirs;\n}\n\n/**\n * Ensures a directory exists and is empty.\n *\n * @param {string} dirPath - Path to the directory.\n * @returns {Promise<void>} Resolves when the directory exists and is empty.\n * @throws {Error} If directory cannot be created or emptied.\n */\nexport async function ensureEmptyDir(dirPath: string): Promise<void> {\n if (await isDirectory(dirPath)) {\n await emptyDir(dirPath);\n } else {\n try {\n await fsp.unlink(dirPath);\n } catch (error) {\n // Ignore if file doesn't exist\n if ((error as NodeJS.ErrnoException).code !== \"ENOENT\") {\n throw error;\n }\n }\n await ensureDir(dirPath);\n }\n}\n\n/**\n * Creates a temporary directory with optional auto-cleanup.\n *\n * @param {object} [options] - Options for the temporary directory.\n * @param {string} [options.prefix='tmp-'] - Prefix for the directory name.\n * @param {string} [options.parentDir=os.tmpdir()] - Parent directory.\n * @param {boolean} [options.cleanup=false] - Whether to register cleanup on process exit.\n * @returns {Promise<{ path: string, cleanup: () => Promise<void> }>} Object with directory path and cleanup function.\n * @throws {Error} If directory cannot be created.\n */\nexport async function createTempDir(\n options: { prefix?: string; parentDir?: string; cleanup?: boolean } = {},\n): Promise<{ path: string; cleanup: () => Promise<void> }> {\n const prefix = options.prefix || \"tmp-\";\n const parentDir = options.parentDir || os.tmpdir();\n const dirName = `${prefix}${randomBytes(6).toString(\"hex\")}`;\n const tempDirPath = path.join(parentDir, dirName);\n\n await ensureDir(tempDirPath);\n\n const cleanup = async () => {\n try {\n await deleteDirRecursive(tempDirPath);\n } catch {\n // Ignore cleanup errors\n }\n };\n\n if (options.cleanup) {\n process.once(\"exit\", () => {\n try {\n fs.rmSync(tempDirPath, { recursive: true, force: true });\n } catch {\n // Ignore cleanup errors on exit\n }\n });\n\n // Handle signals for better cleanup\n [\"SIGINT\", \"SIGTERM\", \"SIGUSR1\", \"SIGUSR2\"].forEach((signal) => {\n process.once(signal as NodeJS.Signals, () => {\n cleanup().then(() => process.exit());\n });\n });\n }\n\n return { path: tempDirPath, cleanup };\n}\n\n/**\n * Finds the newest file in a directory.\n *\n * @param {string} dirPath - Directory to search.\n * @param {boolean} [recursive=false] - Whether to search subdirectories.\n * @returns {Promise<string | null>} Path to the newest file or null if no files.\n * @throws {Error} If directory cannot be read.\n */\nexport async function findNewestFile(\n dirPath: string,\n recursive = false,\n): Promise<string | null> {\n const files = await listFiles(dirPath, recursive);\n if (files.length === 0) return null;\n\n const stats = await Promise.all(\n files.map(async (file) => ({\n path: file,\n mtime: (await fsp.stat(file)).mtime,\n })),\n );\n\n return stats.sort((a, b) => b.mtime.getTime() - a.mtime.getTime())[0].path;\n}\n\n/**\n * Finds the oldest file in a directory.\n *\n * @param {string} dirPath - Directory to search.\n * @param {boolean} [recursive=false] - Whether to search subdirectories.\n * @returns {Promise<string | null>} Path to the oldest file or null if no files.\n * @throws {Error} If directory cannot be read.\n */\nexport async function findOldestFile(\n dirPath: string,\n recursive = false,\n): Promise<string | null> {\n const files = await listFiles(dirPath, recursive);\n if (files.length === 0) return null;\n\n const stats = await Promise.all(\n files.map(async (file) => ({\n path: file,\n mtime: (await fsp.stat(file)).mtime,\n })),\n );\n\n return stats.sort((a, b) => a.mtime.getTime() - b.mtime.getTime())[0].path;\n}\n\n/**\n * Finds files or directories in a directory matching a predicate function.\n *\n * @param {string} dirPath - Directory to search.\n * @param {(path: string, stat: fs.Stats) => boolean | Promise<boolean>} predicate - Function to test each path.\n * @param {boolean} [recursive=false] - Whether to search subdirectories.\n * @returns {Promise<string[]>} Array of matching paths.\n * @throws {Error} If directory cannot be read.\n */\nexport async function findInDir(\n dirPath: string,\n predicate: (path: string, stat: fs.Stats) => boolean | Promise<boolean>,\n recursive = false,\n): Promise<string[]> {\n const entries = await fsp.readdir(dirPath, { withFileTypes: true });\n const results: string[] = [];\n\n for (const entry of entries) {\n const entryPath = path.join(dirPath, entry.name);\n const stat = await fsp.stat(entryPath);\n\n if (await predicate(entryPath, stat)) {\n results.push(entryPath);\n }\n\n if (recursive && entry.isDirectory()) {\n const nestedResults = await findInDir(entryPath, predicate, true);\n results.push(...nestedResults);\n }\n }\n\n return results;\n}\n\n/**\n * Watches a directory recursively for file changes.\n *\n * @param {string} dirPath - Base directory path to watch.\n * @param {(eventType: \"rename\" | \"change\", filename: string) => void} callback - Callback for each change event.\n * @param {boolean} [includeSubdirs=true] - Whether to watch subdirectories.\n * @returns {Promise<() => void>} A function to stop watching the directory.\n * @throws {Error} If directory cannot be watched.\n */\nexport async function watchDirRecursive(\n dirPath: string,\n callback: (eventType: \"rename\" | \"change\", filename: string) => void,\n includeSubdirs = true,\n): Promise<() => void> {\n // Normalize the path to ensure consistent path separators\n const normalizedBasePath = path.normalize(dirPath);\n\n // Create watchers for the base dir and all subdirectories\n const watchers: fs.FSWatcher[] = [];\n\n // Helper function to add a watcher for a directory\n const addWatcher = (dir: string) => {\n try {\n const watcher = fs.watch(dir, (eventType, filename) => {\n if (!filename) return;\n\n const fullPath = path.join(dir, filename);\n // Make the path relative to the base directory\n const relativePath = path.relative(normalizedBasePath, fullPath);\n callback(eventType, relativePath);\n\n // If a new directory is created, we should watch it\n if (eventType === \"rename\" && includeSubdirs) {\n setTimeout(async () => {\n try {\n if (await isDirectory(fullPath)) {\n addWatcher(fullPath);\n }\n } catch {\n // Ignore errors checking newly created items\n }\n }, 100);\n }\n });\n watchers.push(watcher);\n } catch {\n // Silently ignore directories we can't watch\n }\n };\n\n // Add watcher for the base directory\n addWatcher(normalizedBasePath);\n\n // If watching subdirectories, add watchers for all existing subdirectories\n if (includeSubdirs) {\n const subdirs = await getSubdirectories(normalizedBasePath, true);\n for (const subdir of subdirs) {\n addWatcher(subdir);\n }\n }\n\n // Return a function to close all watchers\n return () => {\n watchers.forEach((watcher) => watcher.close());\n };\n}\n\n/**\n * Gets detailed directory statistics including file count, directory count, and size.\n *\n * @param {string} dirPath - Path to the directory.\n * @returns {Promise<{ fileCount: number, dirCount: number, totalSize: number }>} Directory statistics.\n * @throws {Error} If directory cannot be read.\n */\nexport async function getDirStats(\n dirPath: string,\n): Promise<{ fileCount: number; dirCount: number; totalSize: number }> {\n let fileCount = 0;\n let dirCount = 0;\n let totalSize = 0;\n\n async function processDir(currentPath: string): Promise<void> {\n const entries = await fsp.readdir(currentPath, { withFileTypes: true });\n\n for (const entry of entries) {\n const entryPath = path.join(currentPath, entry.name);\n\n if (entry.isDirectory()) {\n dirCount++;\n await processDir(entryPath);\n } else if (entry.isFile()) {\n fileCount++;\n const stat = await fsp.stat(entryPath);\n totalSize += stat.size;\n }\n }\n }\n\n await processDir(dirPath);\n\n return { fileCount, dirCount, totalSize };\n}\n\n/**\n * Walks through a directory hierarchy, calling a visitor function for each entry.\n *\n * @param {string} dirPath - Starting directory path.\n * @param {object} options - Options for walking the directory.\n * @param {(entry: { path: string, name: string, isDirectory: boolean, stats: fs.Stats }) => boolean | void | Promise<boolean | void>} options.visitorFn -\n * Function called for each file/directory. Return false to skip a directory.\n * @param {'pre' | 'post'} [options.traversalOrder='pre'] - Whether to visit directories before or after their contents.\n * @throws {Error} If directory cannot be read.\n */\nexport async function walkDir(\n dirPath: string,\n options: {\n visitorFn: (entry: {\n path: string;\n name: string;\n isDirectory: boolean;\n stats: fs.Stats;\n }) => boolean | void | Promise<boolean | void>;\n traversalOrder?: \"pre\" | \"post\";\n },\n): Promise<void> {\n const traversalOrder = options.traversalOrder || \"pre\";\n const entries = await fsp.readdir(dirPath, { withFileTypes: true });\n\n for (const entry of entries) {\n const entryPath = path.join(dirPath, entry.name);\n const stats = await fsp.stat(entryPath);\n const entryInfo = {\n path: entryPath,\n name: entry.name,\n isDirectory: entry.isDirectory(),\n stats,\n };\n\n if (entry.isDirectory()) {\n // Pre-order: visit directory before its contents\n if (traversalOrder === \"pre\") {\n const shouldContinue = await options.visitorFn(entryInfo);\n // If the visitor returns false, don't recurse into this directory\n if (shouldContinue !== false) {\n await walkDir(entryPath, options);\n }\n } else {\n // Post-order: visit directory after its contents\n await walkDir(entryPath, options);\n await options.visitorFn(entryInfo);\n }\n } else {\n // Files are always visited when encountered\n await options.visitorFn(entryInfo);\n }\n }\n\n if (traversalOrder === \"post\") {\n // Only visit the root if this is the top-level call (not for subdirectories)\n // But since this function is always called recursively, always visit after children\n const stats = await fsp.stat(dirPath);\n const entryInfo = {\n path: dirPath,\n name: path.basename(dirPath),\n isDirectory: true,\n stats,\n };\n await options.visitorFn(entryInfo);\n }\n}\n"]}
|
|
@@ -18,6 +18,24 @@ export declare class Env {
|
|
|
18
18
|
* @returns {boolean} `true` if NODE_ENV is 'development', else `false`.
|
|
19
19
|
*/
|
|
20
20
|
static isDev(): boolean;
|
|
21
|
+
/**
|
|
22
|
+
* Checks if the current NODE_ENV is 'production'.
|
|
23
|
+
*
|
|
24
|
+
* @returns {boolean} `true` if NODE_ENV is 'production', else `false`.
|
|
25
|
+
*/
|
|
26
|
+
static isProd(): boolean;
|
|
27
|
+
/**
|
|
28
|
+
* Checks if the current NODE_ENV is 'testing'.
|
|
29
|
+
*
|
|
30
|
+
* @returns {boolean} `true` if NODE_ENV is 'testing', else `false`.
|
|
31
|
+
*/
|
|
32
|
+
static isTest(): boolean;
|
|
33
|
+
/**
|
|
34
|
+
* Checks if the current NODE_ENV is 'staging'.
|
|
35
|
+
*
|
|
36
|
+
* @returns {boolean} `true` if NODE_ENV is 'staging', else `false`.
|
|
37
|
+
*/
|
|
38
|
+
static isStaging(): boolean;
|
|
21
39
|
/**
|
|
22
40
|
* Sets an environment variable (only affects runtime memory).
|
|
23
41
|
*
|
|
@@ -113,6 +131,71 @@ export declare class Env {
|
|
|
113
131
|
* @throws {Error} If missing or invalid.
|
|
114
132
|
*/
|
|
115
133
|
static getEnum<T extends string>(key: string, allowedValues: T[], defaultValue?: T): T;
|
|
134
|
+
/**
|
|
135
|
+
* Retrieves a URL environment variable and validates it.
|
|
136
|
+
*
|
|
137
|
+
* @param {string} key - The environment variable key.
|
|
138
|
+
* @param {string} [defaultValue] - Optional fallback value.
|
|
139
|
+
* @param {object} [options] - Validation options.
|
|
140
|
+
* @param {string[]} [options.protocols] - Allowed protocols.
|
|
141
|
+
* @param {boolean} [options.requireTld=true] - Whether TLD is required.
|
|
142
|
+
* @returns {string} The validated URL.
|
|
143
|
+
* @throws {Error} If URL is invalid.
|
|
144
|
+
*/
|
|
145
|
+
static getUrl(key: string, defaultValue?: string, options?: {
|
|
146
|
+
protocols?: string[];
|
|
147
|
+
requireTld?: boolean;
|
|
148
|
+
}): string;
|
|
149
|
+
/**
|
|
150
|
+
* Retrieves an email environment variable and validates it.
|
|
151
|
+
*
|
|
152
|
+
* @param {string} key - The environment variable key.
|
|
153
|
+
* @param {string} [defaultValue] - Optional fallback value.
|
|
154
|
+
* @returns {string} The validated email address.
|
|
155
|
+
* @throws {Error} If email is invalid.
|
|
156
|
+
*/
|
|
157
|
+
static getEmail(key: string, defaultValue?: string): string;
|
|
158
|
+
/**
|
|
159
|
+
* Retrieves a path environment variable and validates it exists.
|
|
160
|
+
*
|
|
161
|
+
* @param {string} key - The environment variable key.
|
|
162
|
+
* @param {string} [defaultValue] - Optional fallback value.
|
|
163
|
+
* @param {object} [options] - Validation options.
|
|
164
|
+
* @param {boolean} [options.mustExist=false] - Whether path must exist.
|
|
165
|
+
* @param {boolean} [options.makeAbsolute=true] - Convert relative paths to absolute.
|
|
166
|
+
* @returns {string} The validated path.
|
|
167
|
+
* @throws {Error} If path is invalid.
|
|
168
|
+
*/
|
|
169
|
+
static getPath(key: string, defaultValue?: string, options?: {
|
|
170
|
+
mustExist?: boolean;
|
|
171
|
+
makeAbsolute?: boolean;
|
|
172
|
+
}): string;
|
|
173
|
+
/**
|
|
174
|
+
* Retrieves a port environment variable and validates it.
|
|
175
|
+
*
|
|
176
|
+
* @param {string} key - The environment variable key.
|
|
177
|
+
* @param {number} [defaultValue=3000] - Optional fallback value.
|
|
178
|
+
* @returns {number} The validated port number.
|
|
179
|
+
* @throws {Error} If port is invalid.
|
|
180
|
+
*/
|
|
181
|
+
static getPort(key: string, defaultValue?: number): number;
|
|
182
|
+
/**
|
|
183
|
+
* Retrieves a duration string and converts to milliseconds.
|
|
184
|
+
* Supports formats like "1d", "2h", "30m", "45s", "100ms" or combinations like "1h30m".
|
|
185
|
+
*
|
|
186
|
+
* @param {string} key - The environment variable key.
|
|
187
|
+
* @param {string|number} [defaultValue='0'] - Optional fallback value.
|
|
188
|
+
* @returns {number} The duration in milliseconds.
|
|
189
|
+
* @throws {Error} If duration format is invalid.
|
|
190
|
+
*/
|
|
191
|
+
static getDuration(key: string, defaultValue?: string | number): number;
|
|
192
|
+
/**
|
|
193
|
+
* Gets all environment variables with sensitive values masked for safe logging.
|
|
194
|
+
*
|
|
195
|
+
* @param {string[]} [sensitiveKeys=['password', 'secret', 'key', 'token', 'auth']] - Keys to mask.
|
|
196
|
+
* @returns {Record<string, string>} Environment variables with sensitive values masked.
|
|
197
|
+
*/
|
|
198
|
+
static getSafeEnv(sensitiveKeys?: string[]): Record<string, string>;
|
|
116
199
|
/**
|
|
117
200
|
* Checks whether the specified environment variable exists.
|
|
118
201
|
*
|
|
@@ -1,4 +1,33 @@
|
|
|
1
|
+
var __values = (this && this.__values) || function(o) {
|
|
2
|
+
var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
|
|
3
|
+
if (m) return m.call(o);
|
|
4
|
+
if (o && typeof o.length === "number") return {
|
|
5
|
+
next: function () {
|
|
6
|
+
if (o && i >= o.length) o = void 0;
|
|
7
|
+
return { value: o && o[i++], done: !o };
|
|
8
|
+
}
|
|
9
|
+
};
|
|
10
|
+
throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
|
|
11
|
+
};
|
|
12
|
+
var __read = (this && this.__read) || function (o, n) {
|
|
13
|
+
var m = typeof Symbol === "function" && o[Symbol.iterator];
|
|
14
|
+
if (!m) return o;
|
|
15
|
+
var i = m.call(o), r, ar = [], e;
|
|
16
|
+
try {
|
|
17
|
+
while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
|
|
18
|
+
}
|
|
19
|
+
catch (error) { e = { error: error }; }
|
|
20
|
+
finally {
|
|
21
|
+
try {
|
|
22
|
+
if (r && !r.done && (m = i["return"])) m.call(i);
|
|
23
|
+
}
|
|
24
|
+
finally { if (e) throw e.error; }
|
|
25
|
+
}
|
|
26
|
+
return ar;
|
|
27
|
+
};
|
|
1
28
|
/* eslint-disable n/no-process-env */
|
|
29
|
+
import { existsSync } from "fs";
|
|
30
|
+
import { isAbsolute, resolve } from "path";
|
|
2
31
|
/**
|
|
3
32
|
* Enum representing valid application environments.
|
|
4
33
|
*/
|
|
@@ -24,6 +53,30 @@ var Env = /** @class */ (function () {
|
|
|
24
53
|
Env.isDev = function () {
|
|
25
54
|
return (Env.get("NODE_ENV", Environment.DEVELOPMENT) === Environment.DEVELOPMENT);
|
|
26
55
|
};
|
|
56
|
+
/**
|
|
57
|
+
* Checks if the current NODE_ENV is 'production'.
|
|
58
|
+
*
|
|
59
|
+
* @returns {boolean} `true` if NODE_ENV is 'production', else `false`.
|
|
60
|
+
*/
|
|
61
|
+
Env.isProd = function () {
|
|
62
|
+
return Env.get("NODE_ENV") === Environment.PRODUCTION;
|
|
63
|
+
};
|
|
64
|
+
/**
|
|
65
|
+
* Checks if the current NODE_ENV is 'testing'.
|
|
66
|
+
*
|
|
67
|
+
* @returns {boolean} `true` if NODE_ENV is 'testing', else `false`.
|
|
68
|
+
*/
|
|
69
|
+
Env.isTest = function () {
|
|
70
|
+
return Env.get("NODE_ENV") === Environment.TESTING;
|
|
71
|
+
};
|
|
72
|
+
/**
|
|
73
|
+
* Checks if the current NODE_ENV is 'staging'.
|
|
74
|
+
*
|
|
75
|
+
* @returns {boolean} `true` if NODE_ENV is 'staging', else `false`.
|
|
76
|
+
*/
|
|
77
|
+
Env.isStaging = function () {
|
|
78
|
+
return Env.get("NODE_ENV") === Environment.STAGING;
|
|
79
|
+
};
|
|
27
80
|
/**
|
|
28
81
|
* Sets an environment variable (only affects runtime memory).
|
|
29
82
|
*
|
|
@@ -194,6 +247,186 @@ var Env = /** @class */ (function () {
|
|
|
194
247
|
}
|
|
195
248
|
return value;
|
|
196
249
|
};
|
|
250
|
+
/**
|
|
251
|
+
* Retrieves a URL environment variable and validates it.
|
|
252
|
+
*
|
|
253
|
+
* @param {string} key - The environment variable key.
|
|
254
|
+
* @param {string} [defaultValue] - Optional fallback value.
|
|
255
|
+
* @param {object} [options] - Validation options.
|
|
256
|
+
* @param {string[]} [options.protocols] - Allowed protocols.
|
|
257
|
+
* @param {boolean} [options.requireTld=true] - Whether TLD is required.
|
|
258
|
+
* @returns {string} The validated URL.
|
|
259
|
+
* @throws {Error} If URL is invalid.
|
|
260
|
+
*/
|
|
261
|
+
Env.getUrl = function (key, defaultValue, options) {
|
|
262
|
+
if (options === void 0) { options = {}; }
|
|
263
|
+
var value = Env.get(key, defaultValue);
|
|
264
|
+
if (!value) {
|
|
265
|
+
throw new Error("Env ".concat(key, " is missing or empty"));
|
|
266
|
+
}
|
|
267
|
+
var url;
|
|
268
|
+
try {
|
|
269
|
+
url = new URL(value);
|
|
270
|
+
}
|
|
271
|
+
catch (_a) {
|
|
272
|
+
throw new Error("Env ".concat(key, " is not a valid URL"));
|
|
273
|
+
}
|
|
274
|
+
if (options.protocols && options.protocols.length > 0) {
|
|
275
|
+
var protocol = url.protocol.replace(":", "");
|
|
276
|
+
if (!options.protocols.includes(protocol)) {
|
|
277
|
+
throw new Error("Env ".concat(key, " must use one of the protocols: ").concat(options.protocols.join(", ")));
|
|
278
|
+
}
|
|
279
|
+
}
|
|
280
|
+
if (options.requireTld === true) {
|
|
281
|
+
// Check if hostname has a TLD (contains at least one dot and doesn't end with a dot)
|
|
282
|
+
// localhost, 127.0.0.1, etc. don't have TLDs
|
|
283
|
+
var hostname = url.hostname;
|
|
284
|
+
if (!hostname.includes(".") ||
|
|
285
|
+
hostname === "localhost" ||
|
|
286
|
+
/^[\d.]+$/.test(hostname) || // IP address
|
|
287
|
+
hostname.endsWith(".")) {
|
|
288
|
+
throw new Error("Env ".concat(key, " must have a valid host with TLD"));
|
|
289
|
+
}
|
|
290
|
+
}
|
|
291
|
+
return value;
|
|
292
|
+
};
|
|
293
|
+
/**
|
|
294
|
+
* Retrieves an email environment variable and validates it.
|
|
295
|
+
*
|
|
296
|
+
* @param {string} key - The environment variable key.
|
|
297
|
+
* @param {string} [defaultValue] - Optional fallback value.
|
|
298
|
+
* @returns {string} The validated email address.
|
|
299
|
+
* @throws {Error} If email is invalid.
|
|
300
|
+
*/
|
|
301
|
+
Env.getEmail = function (key, defaultValue) {
|
|
302
|
+
var value = Env.get(key, defaultValue);
|
|
303
|
+
if (!value) {
|
|
304
|
+
if (defaultValue === undefined) {
|
|
305
|
+
throw new Error("Email env ".concat(key, " is missing"));
|
|
306
|
+
}
|
|
307
|
+
return defaultValue;
|
|
308
|
+
}
|
|
309
|
+
// Simple email validation regex
|
|
310
|
+
var emailRegex = /^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/;
|
|
311
|
+
if (!emailRegex.test(value)) {
|
|
312
|
+
throw new Error("Env ".concat(key, " is not a valid email address"));
|
|
313
|
+
}
|
|
314
|
+
return value;
|
|
315
|
+
};
|
|
316
|
+
/**
|
|
317
|
+
* Retrieves a path environment variable and validates it exists.
|
|
318
|
+
*
|
|
319
|
+
* @param {string} key - The environment variable key.
|
|
320
|
+
* @param {string} [defaultValue] - Optional fallback value.
|
|
321
|
+
* @param {object} [options] - Validation options.
|
|
322
|
+
* @param {boolean} [options.mustExist=false] - Whether path must exist.
|
|
323
|
+
* @param {boolean} [options.makeAbsolute=true] - Convert relative paths to absolute.
|
|
324
|
+
* @returns {string} The validated path.
|
|
325
|
+
* @throws {Error} If path is invalid.
|
|
326
|
+
*/
|
|
327
|
+
Env.getPath = function (key, defaultValue, options) {
|
|
328
|
+
if (options === void 0) { options = {}; }
|
|
329
|
+
var value = Env.get(key, defaultValue);
|
|
330
|
+
if (!value) {
|
|
331
|
+
if (defaultValue === undefined) {
|
|
332
|
+
throw new Error("Path env ".concat(key, " is missing"));
|
|
333
|
+
}
|
|
334
|
+
return defaultValue;
|
|
335
|
+
}
|
|
336
|
+
var path = options.makeAbsolute !== false && !isAbsolute(value)
|
|
337
|
+
? resolve(process.cwd(), value)
|
|
338
|
+
: value;
|
|
339
|
+
if (options.mustExist && !existsSync(path)) {
|
|
340
|
+
throw new Error("Path in env ".concat(key, " does not exist: ").concat(path));
|
|
341
|
+
}
|
|
342
|
+
return path;
|
|
343
|
+
};
|
|
344
|
+
/**
|
|
345
|
+
* Retrieves a port environment variable and validates it.
|
|
346
|
+
*
|
|
347
|
+
* @param {string} key - The environment variable key.
|
|
348
|
+
* @param {number} [defaultValue=3000] - Optional fallback value.
|
|
349
|
+
* @returns {number} The validated port number.
|
|
350
|
+
* @throws {Error} If port is invalid.
|
|
351
|
+
*/
|
|
352
|
+
Env.getPort = function (key, defaultValue) {
|
|
353
|
+
if (defaultValue === void 0) { defaultValue = 3000; }
|
|
354
|
+
var port = Env.getNumber(key, defaultValue);
|
|
355
|
+
if (port < 0 || port > 65535) {
|
|
356
|
+
throw new Error("Env ".concat(key, " must be a valid port number (0-65535)"));
|
|
357
|
+
}
|
|
358
|
+
return port;
|
|
359
|
+
};
|
|
360
|
+
/**
|
|
361
|
+
* Retrieves a duration string and converts to milliseconds.
|
|
362
|
+
* Supports formats like "1d", "2h", "30m", "45s", "100ms" or combinations like "1h30m".
|
|
363
|
+
*
|
|
364
|
+
* @param {string} key - The environment variable key.
|
|
365
|
+
* @param {string|number} [defaultValue='0'] - Optional fallback value.
|
|
366
|
+
* @returns {number} The duration in milliseconds.
|
|
367
|
+
* @throws {Error} If duration format is invalid.
|
|
368
|
+
*/
|
|
369
|
+
Env.getDuration = function (key, defaultValue) {
|
|
370
|
+
if (defaultValue === void 0) { defaultValue = "0"; }
|
|
371
|
+
var value = Env.get(key, String(defaultValue));
|
|
372
|
+
if (!value)
|
|
373
|
+
return 0;
|
|
374
|
+
// Handle plain number input (assume milliseconds)
|
|
375
|
+
if (/^\d+$/.test(value)) {
|
|
376
|
+
return parseInt(value, 10);
|
|
377
|
+
}
|
|
378
|
+
// Parse duration string like "1d2h30m15s"
|
|
379
|
+
var durationRegex = /(\d+d)?(\d+h)?(\d+m)?(\d+s)?(\d+ms)?/;
|
|
380
|
+
var matches = value.match(durationRegex);
|
|
381
|
+
if (!matches || matches[0] === "") {
|
|
382
|
+
throw new Error("Env ".concat(key, " has invalid duration format. Use 1d, 2h, 30m, 45s, or 100ms."));
|
|
383
|
+
}
|
|
384
|
+
var ms = 0;
|
|
385
|
+
if (matches[1])
|
|
386
|
+
ms += parseInt(matches[1], 10) * 86400000; // days
|
|
387
|
+
if (matches[2])
|
|
388
|
+
ms += parseInt(matches[2], 10) * 3600000; // hours
|
|
389
|
+
if (matches[3])
|
|
390
|
+
ms += parseInt(matches[3], 10) * 60000; // minutes
|
|
391
|
+
if (matches[4])
|
|
392
|
+
ms += parseInt(matches[4], 10) * 1000; // seconds
|
|
393
|
+
if (matches[5])
|
|
394
|
+
ms += parseInt(matches[5], 10); // milliseconds
|
|
395
|
+
return ms;
|
|
396
|
+
};
|
|
397
|
+
/**
|
|
398
|
+
* Gets all environment variables with sensitive values masked for safe logging.
|
|
399
|
+
*
|
|
400
|
+
* @param {string[]} [sensitiveKeys=['password', 'secret', 'key', 'token', 'auth']] - Keys to mask.
|
|
401
|
+
* @returns {Record<string, string>} Environment variables with sensitive values masked.
|
|
402
|
+
*/
|
|
403
|
+
Env.getSafeEnv = function (sensitiveKeys) {
|
|
404
|
+
var e_1, _a;
|
|
405
|
+
if (sensitiveKeys === void 0) { sensitiveKeys = ["password", "secret", "key", "token", "auth"]; }
|
|
406
|
+
var safeEnv = {};
|
|
407
|
+
var _loop_1 = function (key, value) {
|
|
408
|
+
if (!value)
|
|
409
|
+
return "continue";
|
|
410
|
+
var isSensitive = sensitiveKeys.some(function (sensitiveKey) {
|
|
411
|
+
return key.toLowerCase().includes(sensitiveKey.toLowerCase());
|
|
412
|
+
});
|
|
413
|
+
safeEnv[key] = isSensitive ? "******" : value;
|
|
414
|
+
};
|
|
415
|
+
try {
|
|
416
|
+
for (var _b = __values(Object.entries(process.env)), _c = _b.next(); !_c.done; _c = _b.next()) {
|
|
417
|
+
var _d = __read(_c.value, 2), key = _d[0], value = _d[1];
|
|
418
|
+
_loop_1(key, value);
|
|
419
|
+
}
|
|
420
|
+
}
|
|
421
|
+
catch (e_1_1) { e_1 = { error: e_1_1 }; }
|
|
422
|
+
finally {
|
|
423
|
+
try {
|
|
424
|
+
if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
|
|
425
|
+
}
|
|
426
|
+
finally { if (e_1) throw e_1.error; }
|
|
427
|
+
}
|
|
428
|
+
return safeEnv;
|
|
429
|
+
};
|
|
197
430
|
/**
|
|
198
431
|
* Checks whether the specified environment variable exists.
|
|
199
432
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"env.utils.js","sourceRoot":"","sources":["../../../src/utils/env.utils.ts"],"names":[],"mappings":"AAAA,qCAAqC;AAErC;;GAEG;AACH,MAAM,CAAN,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,wCAAyB,CAAA;IACzB,0CAA2B,CAAA;IAC3B,kCAAmB,CAAA;IACnB,kCAAmB,CAAA;AACrB,CAAC,EALW,WAAW,KAAX,WAAW,QAKtB;AAED;;;GAGG;AACH;IAAA;IAoNA,CAAC;IAnNC;;;;OAIG;IACI,SAAK,GAAZ;QACE,OAAO,CACL,GAAG,CAAC,GAAG,CAAC,UAAU,EAAE,WAAW,CAAC,WAAW,CAAC,KAAK,WAAW,CAAC,WAAW,CACzE,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,OAAG,GAAV,UAAW,GAAW,EAAE,KAAa;QACnC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACI,UAAM,GAAb;QACE,OAAO,OAAO,CAAC,GAAG,CAAC;IACrB,CAAC;IAED;;;;;;OAMG;IACI,OAAG,GAAV,UAAW,GAAW,EAAE,YAAqB;;QAC3C,OAAO,MAAA,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,mCAAI,YAAY,CAAC;IAC1C,CAAC;IAED;;;;;;OAMG;IACI,eAAW,GAAlB,UAAmB,GAAW;QAC5B,IAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,uBAAgB,GAAG,gBAAa,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACI,aAAS,GAAhB,UAAiB,GAAW,EAAE,YAAoB;;QAChD,IAAM,KAAK,GAAG,MAAA,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,mCAAI,YAAY,CAAC;QAC/C,IAAM,WAAW,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QAClC,IAAI,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,cAAO,GAAG,qBAAkB,CAAC,CAAC;QAChD,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;;;OAMG;IACI,qBAAiB,GAAxB,UAAyB,GAAW;QAClC,IAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,uBAAgB,GAAG,gBAAa,CAAC,CAAC;QACpD,CAAC;QACD,IAAM,WAAW,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QAClC,IAAI,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,uBAAgB,GAAG,qBAAkB,CAAC,CAAC;QACzD,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;;;;;OAQG;IACI,cAAU,GAAjB,UAAkB,GAAW,EAAE,YAAoB;;QAApB,6BAAA,EAAA,oBAAoB;QACjD,IAAM,KAAK,GAAG,CAAC,MAAA,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,mCAAI,YAAY,CAAC,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE,CAAC;QAC1E,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QAC5D,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC;YAAE,OAAO,KAAK,CAAC;QAC9D,MAAM,IAAI,KAAK,CAAC,uBAAgB,GAAG,sBAAmB,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;OAMG;IACI,sBAAkB,GAAzB,UAA0B,GAAW;QACnC,IAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,uBAAgB,GAAG,gBAAa,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,cAAc;IAC7C,CAAC;IAED;;;;;;;;OAQG;IACI,WAAO,GAAd,UAA0C,GAAW,EAAE,YAAe;QACpE,IAAM,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC3B,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;YACpB,IAAI,CAAC;gBACH,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACvB,CAAC;YAAC,WAAM,CAAC;gBACP,MAAM,IAAI,KAAK,CAAC,uBAAgB,GAAG,gCAA6B,CAAC,CAAC;YACpE,CAAC;QACH,CAAC;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;;;;;;OAQG;IACI,YAAQ,GAAf,UACE,GAAW,EACX,YAAsB,EACtB,QAAc;QADd,6BAAA,EAAA,iBAAsB;QACtB,yBAAA,EAAA,cAAc;QAEd,IAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YAClC,OAAO,YAAY,CAAC;QACtB,CAAC;QACD,OAAO,KAAK;aACT,KAAK,CAAC,QAAQ,CAAC;aACf,GAAG,CAAC,UAAC,IAAI,IAAK,OAAA,IAAI,CAAC,IAAI,EAAE,EAAX,CAAW,CAAC;aAC1B,MAAM,CAAC,UAAC,IAAI,IAAK,OAAA,IAAI,CAAC,MAAM,GAAG,CAAC,EAAf,CAAe,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;;;;OASG;IACI,WAAO,GAAd,UACE,GAAW,EACX,aAAkB,EAClB,YAAgB;;QAEhB,IAAM,KAAK,GAAG,MAAA,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,mCAAI,YAAY,CAAC;QAC/C,IAAI,CAAC,KAAK,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,KAAU,CAAC,EAAE,CAAC;YAClD,MAAM,IAAI,KAAK,CACb,cAAO,GAAG,6BAAmB,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,yBAAe,KAAK,CAAE,CAC5E,CAAC;QACJ,CAAC;QACD,OAAO,KAAU,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACI,OAAG,GAAV,UAAW,GAAW;QACpB,OAAO,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACI,UAAM,GAAb,UAAc,GAAW;QACvB,OAAO,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;IACH,UAAC;AAAD,CAAC,AApND,IAoNC","sourcesContent":["/* eslint-disable n/no-process-env */\n\n/**\n * Enum representing valid application environments.\n */\nexport enum Environment {\n PRODUCTION = \"production\",\n DEVELOPMENT = \"development\",\n STAGING = \"staging\",\n TESTING = \"testing\",\n}\n\n/**\n * Utility class for accessing and managing environment variables.\n * Provides typed getters with fallback defaults and validation.\n */\nexport class Env {\n /**\n * Checks if the current NODE_ENV is 'development'.\n *\n * @returns {boolean} `true` if NODE_ENV is 'development', else `false`.\n */\n static isDev(): boolean {\n return (\n Env.get(\"NODE_ENV\", Environment.DEVELOPMENT) === Environment.DEVELOPMENT\n );\n }\n\n /**\n * Sets an environment variable (only affects runtime memory).\n *\n * @param {string} key - The environment variable key.\n * @param {string} value - The value to set.\n */\n static set(key: string, value: string): void {\n process.env[key] = value;\n }\n\n /**\n * Returns all environment variables as an object.\n *\n * @returns {object} The current `process.env` object.\n */\n static getAll(): object {\n return process.env;\n }\n\n /**\n * Retrieves a string environment variable with a fallback default.\n *\n * @param {string} key - The environment variable key.\n * @param {string} [defaultValue] - Value to return if the key is missing.\n * @returns {string | undefined} The env value or the fallback.\n */\n static get(key: string, defaultValue?: string): string | undefined {\n return process.env[key] ?? defaultValue;\n }\n\n /**\n * Retrieves a string environment variable and throws if it's missing.\n *\n * @param {string} key - The environment variable key.\n * @returns {string} The environment variable's value.\n * @throws {Error} If the variable is not defined.\n */\n static getRequired(key: string): string {\n const value = process.env[key];\n if (value === undefined) {\n throw new Error(`Required env ${key} is missing`);\n }\n return value;\n }\n\n /**\n * Retrieves an environment variable as a number, or returns a default.\n *\n * @param {string} key - The environment variable key.\n * @param {number} defaultValue - Fallback number if key is not present.\n * @returns {number} Parsed numeric value or default.\n * @throws {Error} If the value is not a valid number.\n */\n static getNumber(key: string, defaultValue: number): number {\n const value = process.env[key] ?? defaultValue;\n const numberValue = Number(value);\n if (isNaN(numberValue)) {\n throw new Error(`Env ${key} is not a number`);\n }\n return numberValue;\n }\n\n /**\n * Retrieves a required environment variable as a number.\n *\n * @param {string} key - The environment variable key.\n * @returns {number} Parsed number.\n * @throws {Error} If the value is missing or not a number.\n */\n static getNumberRequired(key: string): number {\n const value = process.env[key];\n if (value === undefined) {\n throw new Error(`Required env ${key} is missing`);\n }\n const numberValue = Number(value);\n if (isNaN(numberValue)) {\n throw new Error(`Required env ${key} is not a number`);\n }\n return numberValue;\n }\n\n /**\n * Retrieves an environment variable as a boolean.\n * Accepts `true`, `1`, `yes`, `on` as true; `false`, `0`, `no`, `off` as false.\n *\n * @param {string} key - The environment variable key.\n * @param {boolean} [defaultValue=false] - Optional fallback value if key is missing.\n * @returns {boolean} Parsed boolean.\n * @throws {Error} If the value is not a recognized boolean string.\n */\n static getBoolean(key: string, defaultValue = false): boolean {\n const value = (process.env[key] ?? defaultValue).toString().toLowerCase();\n if ([\"true\", \"1\", \"yes\", \"on\"].includes(value)) return true;\n if ([\"false\", \"0\", \"no\", \"off\"].includes(value)) return false;\n throw new Error(`Env variable ${key} is not a boolean`);\n }\n\n /**\n * Retrieves a required environment variable as a boolean.\n *\n * @param {string} key - The environment variable key.\n * @returns {boolean} Parsed boolean value.\n * @throws {Error} If missing or invalid.\n */\n static getBooleanRequired(key: string): boolean {\n const value = process.env[key];\n if (value === undefined) {\n throw new Error(`Required env ${key} is missing`);\n }\n return this.getBoolean(key); // reuse logic\n }\n\n /**\n * Parses a stringified JSON object from an environment variable.\n *\n * @typeParam T - The type to parse as (defaults to `object`).\n * @param {string} key - The environment variable key.\n * @param {T} defaultValue - Value to return if key is missing.\n * @returns {T} Parsed object or default.\n * @throws {Error} If the value is not valid JSON.\n */\n static getJSON<T extends object = object>(key: string, defaultValue: T): T {\n const v = process.env[key];\n if (v !== undefined) {\n try {\n return JSON.parse(v);\n } catch {\n throw new Error(`Env variable ${key} is not a valid JSON string`);\n }\n }\n return defaultValue;\n }\n\n /**\n * Parses a comma-separated string as an array.\n *\n * @typeParam T - The item type (optional, defaults to string).\n * @param {string} key - The environment variable key.\n * @param {T[]} [defaultValue=[]] - Array to return if value is empty or missing.\n * @param {string} [splitter=','] - Delimiter to split on.\n * @returns {string[] | T[]} An array of strings.\n */\n static getArray<T = string>(\n key: string,\n defaultValue: T[] = [],\n splitter = \",\",\n ): string[] | T[] {\n const value = process.env[key];\n if (!value || value.trim() === \"\") {\n return defaultValue;\n }\n return value\n .split(splitter)\n .map((item) => item.trim())\n .filter((item) => item.length > 0);\n }\n\n /**\n * Retrieves an enum-like environment variable value, validating against allowed values.\n *\n * @typeParam T - The allowed value type (string literal types).\n * @param {string} key - The environment variable key.\n * @param {T[]} allowedValues - Array of accepted string values.\n * @param {T} [defaultValue] - Optional fallback value.\n * @returns {T} The validated environment value.\n * @throws {Error} If missing or invalid.\n */\n static getEnum<T extends string>(\n key: string,\n allowedValues: T[],\n defaultValue?: T,\n ): T {\n const value = process.env[key] ?? defaultValue;\n if (!value || !allowedValues.includes(value as T)) {\n throw new Error(\n `Env ${key} must be one of ${allowedValues.join(\", \")}. Received: ${value}`,\n );\n }\n return value as T;\n }\n\n /**\n * Checks whether the specified environment variable exists.\n *\n * @param {string} key - The environment variable key.\n * @returns {boolean} `true` if the variable is defined, otherwise `false`.\n */\n static has(key: string): boolean {\n return process.env[key] !== undefined;\n }\n\n /**\n * Deletes the given environment variable (useful in tests).\n *\n * @param {string} key - The environment variable key to delete.\n * @returns {void}\n */\n static delete(key: string): void {\n delete process.env[key];\n }\n}\n"]}
|
|
1
|
+
{"version":3,"file":"env.utils.js","sourceRoot":"","sources":["../../../src/utils/env.utils.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qCAAqC;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAC3C;;GAEG;AACH,MAAM,CAAN,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,wCAAyB,CAAA;IACzB,0CAA2B,CAAA;IAC3B,kCAAmB,CAAA;IACnB,kCAAmB,CAAA;AACrB,CAAC,EALW,WAAW,KAAX,WAAW,QAKtB;AAED;;;GAGG;AACH;IAAA;IAubA,CAAC;IAtbC;;;;OAIG;IACI,SAAK,GAAZ;QACE,OAAO,CACL,GAAG,CAAC,GAAG,CAAC,UAAU,EAAE,WAAW,CAAC,WAAW,CAAC,KAAK,WAAW,CAAC,WAAW,CACzE,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,UAAM,GAAb;QACE,OAAO,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,WAAW,CAAC,UAAU,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACI,UAAM,GAAb;QACE,OAAO,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,WAAW,CAAC,OAAO,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACI,aAAS,GAAhB;QACE,OAAO,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,WAAW,CAAC,OAAO,CAAC;IACrD,CAAC;IAED;;;;;OAKG;IACI,OAAG,GAAV,UAAW,GAAW,EAAE,KAAa;QACnC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACI,UAAM,GAAb;QACE,OAAO,OAAO,CAAC,GAAG,CAAC;IACrB,CAAC;IAED;;;;;;OAMG;IACI,OAAG,GAAV,UAAW,GAAW,EAAE,YAAqB;;QAC3C,OAAO,MAAA,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,mCAAI,YAAY,CAAC;IAC1C,CAAC;IAED;;;;;;OAMG;IACI,eAAW,GAAlB,UAAmB,GAAW;QAC5B,IAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,uBAAgB,GAAG,gBAAa,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACI,aAAS,GAAhB,UAAiB,GAAW,EAAE,YAAoB;;QAChD,IAAM,KAAK,GAAG,MAAA,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,mCAAI,YAAY,CAAC;QAC/C,IAAM,WAAW,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QAClC,IAAI,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,cAAO,GAAG,qBAAkB,CAAC,CAAC;QAChD,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;;;OAMG;IACI,qBAAiB,GAAxB,UAAyB,GAAW;QAClC,IAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,uBAAgB,GAAG,gBAAa,CAAC,CAAC;QACpD,CAAC;QACD,IAAM,WAAW,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QAClC,IAAI,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,uBAAgB,GAAG,qBAAkB,CAAC,CAAC;QACzD,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;;;;;OAQG;IACI,cAAU,GAAjB,UAAkB,GAAW,EAAE,YAAoB;;QAApB,6BAAA,EAAA,oBAAoB;QACjD,IAAM,KAAK,GAAG,CAAC,MAAA,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,mCAAI,YAAY,CAAC,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE,CAAC;QAC1E,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QAC5D,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC;YAAE,OAAO,KAAK,CAAC;QAC9D,MAAM,IAAI,KAAK,CAAC,uBAAgB,GAAG,sBAAmB,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;OAMG;IACI,sBAAkB,GAAzB,UAA0B,GAAW;QACnC,IAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,uBAAgB,GAAG,gBAAa,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,cAAc;IAC7C,CAAC;IAED;;;;;;;;OAQG;IACI,WAAO,GAAd,UAA0C,GAAW,EAAE,YAAe;QACpE,IAAM,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC3B,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;YACpB,IAAI,CAAC;gBACH,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACvB,CAAC;YAAC,WAAM,CAAC;gBACP,MAAM,IAAI,KAAK,CAAC,uBAAgB,GAAG,gCAA6B,CAAC,CAAC;YACpE,CAAC;QACH,CAAC;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;;;;;;OAQG;IACI,YAAQ,GAAf,UACE,GAAW,EACX,YAAsB,EACtB,QAAc;QADd,6BAAA,EAAA,iBAAsB;QACtB,yBAAA,EAAA,cAAc;QAEd,IAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YAClC,OAAO,YAAY,CAAC;QACtB,CAAC;QACD,OAAO,KAAK;aACT,KAAK,CAAC,QAAQ,CAAC;aACf,GAAG,CAAC,UAAC,IAAI,IAAK,OAAA,IAAI,CAAC,IAAI,EAAE,EAAX,CAAW,CAAC;aAC1B,MAAM,CAAC,UAAC,IAAI,IAAK,OAAA,IAAI,CAAC,MAAM,GAAG,CAAC,EAAf,CAAe,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;;;;OASG;IACI,WAAO,GAAd,UACE,GAAW,EACX,aAAkB,EAClB,YAAgB;;QAEhB,IAAM,KAAK,GAAG,MAAA,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,mCAAI,YAAY,CAAC;QAC/C,IAAI,CAAC,KAAK,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,KAAU,CAAC,EAAE,CAAC;YAClD,MAAM,IAAI,KAAK,CACb,cAAO,GAAG,6BAAmB,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,yBAAe,KAAK,CAAE,CAC5E,CAAC;QACJ,CAAC;QACD,OAAO,KAAU,CAAC;IACpB,CAAC;IAED;;;;;;;;;;OAUG;IACI,UAAM,GAAb,UACE,GAAW,EACX,YAAqB,EACrB,OAA4D;QAA5D,wBAAA,EAAA,YAA4D;QAE5D,IAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;QACzC,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,cAAO,GAAG,yBAAsB,CAAC,CAAC;QACpD,CAAC;QAED,IAAI,GAAQ,CAAC;QACb,IAAI,CAAC;YACH,GAAG,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;QAAC,WAAM,CAAC;YACP,MAAM,IAAI,KAAK,CAAC,cAAO,GAAG,wBAAqB,CAAC,CAAC;QACnD,CAAC;QAED,IAAI,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtD,IAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YAC/C,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC1C,MAAM,IAAI,KAAK,CACb,cAAO,GAAG,6CAAmC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE,CAC5E,CAAC;YACJ,CAAC;QACH,CAAC;QAED,IAAI,OAAO,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;YAChC,qFAAqF;YACrF,6CAA6C;YAC7C,IAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;YAC9B,IACE,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC;gBACvB,QAAQ,KAAK,WAAW;gBACxB,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,aAAa;gBAC1C,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,EACtB,CAAC;gBACD,MAAM,IAAI,KAAK,CAAC,cAAO,GAAG,qCAAkC,CAAC,CAAC;YAChE,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACI,YAAQ,GAAf,UAAgB,GAAW,EAAE,YAAqB;QAChD,IAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;QAEzC,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;gBAC/B,MAAM,IAAI,KAAK,CAAC,oBAAa,GAAG,gBAAa,CAAC,CAAC;YACjD,CAAC;YACD,OAAO,YAAY,CAAC;QACtB,CAAC;QAED,gCAAgC;QAChC,IAAM,UAAU,GAAG,kDAAkD,CAAC;QACtE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,cAAO,GAAG,kCAA+B,CAAC,CAAC;QAC7D,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;;;OAUG;IACI,WAAO,GAAd,UACE,GAAW,EACX,YAAqB,EACrB,OAA6D;QAA7D,wBAAA,EAAA,YAA6D;QAE7D,IAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;QAEzC,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;gBAC/B,MAAM,IAAI,KAAK,CAAC,mBAAY,GAAG,gBAAa,CAAC,CAAC;YAChD,CAAC;YACD,OAAO,YAAY,CAAC;QACtB,CAAC;QAED,IAAM,IAAI,GACR,OAAO,CAAC,YAAY,KAAK,KAAK,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;YAClD,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,KAAK,CAAC;YAC/B,CAAC,CAAC,KAAK,CAAC;QAEZ,IAAI,OAAO,CAAC,SAAS,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,sBAAe,GAAG,8BAAoB,IAAI,CAAE,CAAC,CAAC;QAChE,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACI,WAAO,GAAd,UAAe,GAAW,EAAE,YAA2B;QAA3B,6BAAA,EAAA,mBAA2B;QACrD,IAAM,IAAI,GAAG,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;QAE9C,IAAI,IAAI,GAAG,CAAC,IAAI,IAAI,GAAG,KAAK,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,cAAO,GAAG,2CAAwC,CAAC,CAAC;QACtE,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACI,eAAW,GAAlB,UAAmB,GAAW,EAAE,YAAmC;QAAnC,6BAAA,EAAA,kBAAmC;QACjE,IAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;QAEjD,IAAI,CAAC,KAAK;YAAE,OAAO,CAAC,CAAC;QAErB,kDAAkD;QAClD,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACxB,OAAO,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAC7B,CAAC;QAED,0CAA0C;QAC1C,IAAM,aAAa,GAAG,sCAAsC,CAAC;QAC7D,IAAM,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAE3C,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CACb,cAAO,GAAG,kEAA+D,CAC1E,CAAC;QACJ,CAAC;QAED,IAAI,EAAE,GAAG,CAAC,CAAC;QAEX,IAAI,OAAO,CAAC,CAAC,CAAC;YAAE,EAAE,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC,OAAO;QAClE,IAAI,OAAO,CAAC,CAAC,CAAC;YAAE,EAAE,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,QAAQ;QAClE,IAAI,OAAO,CAAC,CAAC,CAAC;YAAE,EAAE,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,UAAU;QAClE,IAAI,OAAO,CAAC,CAAC,CAAC;YAAE,EAAE,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,UAAU;QACjE,IAAI,OAAO,CAAC,CAAC,CAAC;YAAE,EAAE,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,eAAe;QAE/D,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;OAKG;IACI,cAAU,GAAjB,UACE,aAAwE;;QAAxE,8BAAA,EAAA,iBAA2B,UAAU,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC;QAExE,IAAM,OAAO,GAA2B,EAAE,CAAC;gCAE/B,GAAG,EAAE,KAAK;YACpB,IAAI,CAAC,KAAK;kCAAW;YAErB,IAAM,WAAW,GAAG,aAAa,CAAC,IAAI,CAAC,UAAC,YAAY;gBAClD,OAAA,GAAG,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC;YAAtD,CAAsD,CACvD,CAAC;YAEF,OAAO,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC;;;YAPhD,KAA2B,IAAA,KAAA,SAAA,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA,gBAAA;gBAA3C,IAAA,KAAA,mBAAY,EAAX,GAAG,QAAA,EAAE,KAAK,QAAA;wBAAV,GAAG,EAAE,KAAK;aAQrB;;;;;;;;;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACI,OAAG,GAAV,UAAW,GAAW;QACpB,OAAO,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACI,UAAM,GAAb,UAAc,GAAW;QACvB,OAAO,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;IACH,UAAC;AAAD,CAAC,AAvbD,IAubC","sourcesContent":["/* eslint-disable n/no-process-env */\nimport { existsSync } from \"fs\";\nimport { isAbsolute, resolve } from \"path\";\n/**\n * Enum representing valid application environments.\n */\nexport enum Environment {\n PRODUCTION = \"production\",\n DEVELOPMENT = \"development\",\n STAGING = \"staging\",\n TESTING = \"testing\",\n}\n\n/**\n * Utility class for accessing and managing environment variables.\n * Provides typed getters with fallback defaults and validation.\n */\nexport class Env {\n /**\n * Checks if the current NODE_ENV is 'development'.\n *\n * @returns {boolean} `true` if NODE_ENV is 'development', else `false`.\n */\n static isDev(): boolean {\n return (\n Env.get(\"NODE_ENV\", Environment.DEVELOPMENT) === Environment.DEVELOPMENT\n );\n }\n\n /**\n * Checks if the current NODE_ENV is 'production'.\n *\n * @returns {boolean} `true` if NODE_ENV is 'production', else `false`.\n */\n static isProd(): boolean {\n return Env.get(\"NODE_ENV\") === Environment.PRODUCTION;\n }\n\n /**\n * Checks if the current NODE_ENV is 'testing'.\n *\n * @returns {boolean} `true` if NODE_ENV is 'testing', else `false`.\n */\n static isTest(): boolean {\n return Env.get(\"NODE_ENV\") === Environment.TESTING;\n }\n\n /**\n * Checks if the current NODE_ENV is 'staging'.\n *\n * @returns {boolean} `true` if NODE_ENV is 'staging', else `false`.\n */\n static isStaging(): boolean {\n return Env.get(\"NODE_ENV\") === Environment.STAGING;\n }\n\n /**\n * Sets an environment variable (only affects runtime memory).\n *\n * @param {string} key - The environment variable key.\n * @param {string} value - The value to set.\n */\n static set(key: string, value: string): void {\n process.env[key] = value;\n }\n\n /**\n * Returns all environment variables as an object.\n *\n * @returns {object} The current `process.env` object.\n */\n static getAll(): object {\n return process.env;\n }\n\n /**\n * Retrieves a string environment variable with a fallback default.\n *\n * @param {string} key - The environment variable key.\n * @param {string} [defaultValue] - Value to return if the key is missing.\n * @returns {string | undefined} The env value or the fallback.\n */\n static get(key: string, defaultValue?: string): string | undefined {\n return process.env[key] ?? defaultValue;\n }\n\n /**\n * Retrieves a string environment variable and throws if it's missing.\n *\n * @param {string} key - The environment variable key.\n * @returns {string} The environment variable's value.\n * @throws {Error} If the variable is not defined.\n */\n static getRequired(key: string): string {\n const value = process.env[key];\n if (value === undefined) {\n throw new Error(`Required env ${key} is missing`);\n }\n return value;\n }\n\n /**\n * Retrieves an environment variable as a number, or returns a default.\n *\n * @param {string} key - The environment variable key.\n * @param {number} defaultValue - Fallback number if key is not present.\n * @returns {number} Parsed numeric value or default.\n * @throws {Error} If the value is not a valid number.\n */\n static getNumber(key: string, defaultValue: number): number {\n const value = process.env[key] ?? defaultValue;\n const numberValue = Number(value);\n if (isNaN(numberValue)) {\n throw new Error(`Env ${key} is not a number`);\n }\n return numberValue;\n }\n\n /**\n * Retrieves a required environment variable as a number.\n *\n * @param {string} key - The environment variable key.\n * @returns {number} Parsed number.\n * @throws {Error} If the value is missing or not a number.\n */\n static getNumberRequired(key: string): number {\n const value = process.env[key];\n if (value === undefined) {\n throw new Error(`Required env ${key} is missing`);\n }\n const numberValue = Number(value);\n if (isNaN(numberValue)) {\n throw new Error(`Required env ${key} is not a number`);\n }\n return numberValue;\n }\n\n /**\n * Retrieves an environment variable as a boolean.\n * Accepts `true`, `1`, `yes`, `on` as true; `false`, `0`, `no`, `off` as false.\n *\n * @param {string} key - The environment variable key.\n * @param {boolean} [defaultValue=false] - Optional fallback value if key is missing.\n * @returns {boolean} Parsed boolean.\n * @throws {Error} If the value is not a recognized boolean string.\n */\n static getBoolean(key: string, defaultValue = false): boolean {\n const value = (process.env[key] ?? defaultValue).toString().toLowerCase();\n if ([\"true\", \"1\", \"yes\", \"on\"].includes(value)) return true;\n if ([\"false\", \"0\", \"no\", \"off\"].includes(value)) return false;\n throw new Error(`Env variable ${key} is not a boolean`);\n }\n\n /**\n * Retrieves a required environment variable as a boolean.\n *\n * @param {string} key - The environment variable key.\n * @returns {boolean} Parsed boolean value.\n * @throws {Error} If missing or invalid.\n */\n static getBooleanRequired(key: string): boolean {\n const value = process.env[key];\n if (value === undefined) {\n throw new Error(`Required env ${key} is missing`);\n }\n return this.getBoolean(key); // reuse logic\n }\n\n /**\n * Parses a stringified JSON object from an environment variable.\n *\n * @typeParam T - The type to parse as (defaults to `object`).\n * @param {string} key - The environment variable key.\n * @param {T} defaultValue - Value to return if key is missing.\n * @returns {T} Parsed object or default.\n * @throws {Error} If the value is not valid JSON.\n */\n static getJSON<T extends object = object>(key: string, defaultValue: T): T {\n const v = process.env[key];\n if (v !== undefined) {\n try {\n return JSON.parse(v);\n } catch {\n throw new Error(`Env variable ${key} is not a valid JSON string`);\n }\n }\n return defaultValue;\n }\n\n /**\n * Parses a comma-separated string as an array.\n *\n * @typeParam T - The item type (optional, defaults to string).\n * @param {string} key - The environment variable key.\n * @param {T[]} [defaultValue=[]] - Array to return if value is empty or missing.\n * @param {string} [splitter=','] - Delimiter to split on.\n * @returns {string[] | T[]} An array of strings.\n */\n static getArray<T = string>(\n key: string,\n defaultValue: T[] = [],\n splitter = \",\",\n ): string[] | T[] {\n const value = process.env[key];\n if (!value || value.trim() === \"\") {\n return defaultValue;\n }\n return value\n .split(splitter)\n .map((item) => item.trim())\n .filter((item) => item.length > 0);\n }\n\n /**\n * Retrieves an enum-like environment variable value, validating against allowed values.\n *\n * @typeParam T - The allowed value type (string literal types).\n * @param {string} key - The environment variable key.\n * @param {T[]} allowedValues - Array of accepted string values.\n * @param {T} [defaultValue] - Optional fallback value.\n * @returns {T} The validated environment value.\n * @throws {Error} If missing or invalid.\n */\n static getEnum<T extends string>(\n key: string,\n allowedValues: T[],\n defaultValue?: T,\n ): T {\n const value = process.env[key] ?? defaultValue;\n if (!value || !allowedValues.includes(value as T)) {\n throw new Error(\n `Env ${key} must be one of ${allowedValues.join(\", \")}. Received: ${value}`,\n );\n }\n return value as T;\n }\n\n /**\n * Retrieves a URL environment variable and validates it.\n *\n * @param {string} key - The environment variable key.\n * @param {string} [defaultValue] - Optional fallback value.\n * @param {object} [options] - Validation options.\n * @param {string[]} [options.protocols] - Allowed protocols.\n * @param {boolean} [options.requireTld=true] - Whether TLD is required.\n * @returns {string} The validated URL.\n * @throws {Error} If URL is invalid.\n */\n static getUrl(\n key: string,\n defaultValue?: string,\n options: { protocols?: string[]; requireTld?: boolean } = {},\n ): string {\n const value = Env.get(key, defaultValue);\n if (!value) {\n throw new Error(`Env ${key} is missing or empty`);\n }\n\n let url: URL;\n try {\n url = new URL(value);\n } catch {\n throw new Error(`Env ${key} is not a valid URL`);\n }\n\n if (options.protocols && options.protocols.length > 0) {\n const protocol = url.protocol.replace(\":\", \"\");\n if (!options.protocols.includes(protocol)) {\n throw new Error(\n `Env ${key} must use one of the protocols: ${options.protocols.join(\", \")}`,\n );\n }\n }\n\n if (options.requireTld === true) {\n // Check if hostname has a TLD (contains at least one dot and doesn't end with a dot)\n // localhost, 127.0.0.1, etc. don't have TLDs\n const hostname = url.hostname;\n if (\n !hostname.includes(\".\") ||\n hostname === \"localhost\" ||\n /^[\\d.]+$/.test(hostname) || // IP address\n hostname.endsWith(\".\")\n ) {\n throw new Error(`Env ${key} must have a valid host with TLD`);\n }\n }\n\n return value;\n }\n\n /**\n * Retrieves an email environment variable and validates it.\n *\n * @param {string} key - The environment variable key.\n * @param {string} [defaultValue] - Optional fallback value.\n * @returns {string} The validated email address.\n * @throws {Error} If email is invalid.\n */\n static getEmail(key: string, defaultValue?: string): string {\n const value = Env.get(key, defaultValue);\n\n if (!value) {\n if (defaultValue === undefined) {\n throw new Error(`Email env ${key} is missing`);\n }\n return defaultValue;\n }\n\n // Simple email validation regex\n const emailRegex = /^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$/;\n if (!emailRegex.test(value)) {\n throw new Error(`Env ${key} is not a valid email address`);\n }\n\n return value;\n }\n\n /**\n * Retrieves a path environment variable and validates it exists.\n *\n * @param {string} key - The environment variable key.\n * @param {string} [defaultValue] - Optional fallback value.\n * @param {object} [options] - Validation options.\n * @param {boolean} [options.mustExist=false] - Whether path must exist.\n * @param {boolean} [options.makeAbsolute=true] - Convert relative paths to absolute.\n * @returns {string} The validated path.\n * @throws {Error} If path is invalid.\n */\n static getPath(\n key: string,\n defaultValue?: string,\n options: { mustExist?: boolean; makeAbsolute?: boolean } = {},\n ): string {\n const value = Env.get(key, defaultValue);\n\n if (!value) {\n if (defaultValue === undefined) {\n throw new Error(`Path env ${key} is missing`);\n }\n return defaultValue;\n }\n\n const path =\n options.makeAbsolute !== false && !isAbsolute(value)\n ? resolve(process.cwd(), value)\n : value;\n\n if (options.mustExist && !existsSync(path)) {\n throw new Error(`Path in env ${key} does not exist: ${path}`);\n }\n\n return path;\n }\n\n /**\n * Retrieves a port environment variable and validates it.\n *\n * @param {string} key - The environment variable key.\n * @param {number} [defaultValue=3000] - Optional fallback value.\n * @returns {number} The validated port number.\n * @throws {Error} If port is invalid.\n */\n static getPort(key: string, defaultValue: number = 3000): number {\n const port = Env.getNumber(key, defaultValue);\n\n if (port < 0 || port > 65535) {\n throw new Error(`Env ${key} must be a valid port number (0-65535)`);\n }\n\n return port;\n }\n\n /**\n * Retrieves a duration string and converts to milliseconds.\n * Supports formats like \"1d\", \"2h\", \"30m\", \"45s\", \"100ms\" or combinations like \"1h30m\".\n *\n * @param {string} key - The environment variable key.\n * @param {string|number} [defaultValue='0'] - Optional fallback value.\n * @returns {number} The duration in milliseconds.\n * @throws {Error} If duration format is invalid.\n */\n static getDuration(key: string, defaultValue: string | number = \"0\"): number {\n const value = Env.get(key, String(defaultValue));\n\n if (!value) return 0;\n\n // Handle plain number input (assume milliseconds)\n if (/^\\d+$/.test(value)) {\n return parseInt(value, 10);\n }\n\n // Parse duration string like \"1d2h30m15s\"\n const durationRegex = /(\\d+d)?(\\d+h)?(\\d+m)?(\\d+s)?(\\d+ms)?/;\n const matches = value.match(durationRegex);\n\n if (!matches || matches[0] === \"\") {\n throw new Error(\n `Env ${key} has invalid duration format. Use 1d, 2h, 30m, 45s, or 100ms.`,\n );\n }\n\n let ms = 0;\n\n if (matches[1]) ms += parseInt(matches[1], 10) * 86400000; // days\n if (matches[2]) ms += parseInt(matches[2], 10) * 3600000; // hours\n if (matches[3]) ms += parseInt(matches[3], 10) * 60000; // minutes\n if (matches[4]) ms += parseInt(matches[4], 10) * 1000; // seconds\n if (matches[5]) ms += parseInt(matches[5], 10); // milliseconds\n\n return ms;\n }\n\n /**\n * Gets all environment variables with sensitive values masked for safe logging.\n *\n * @param {string[]} [sensitiveKeys=['password', 'secret', 'key', 'token', 'auth']] - Keys to mask.\n * @returns {Record<string, string>} Environment variables with sensitive values masked.\n */\n static getSafeEnv(\n sensitiveKeys: string[] = [\"password\", \"secret\", \"key\", \"token\", \"auth\"],\n ): Record<string, string> {\n const safeEnv: Record<string, string> = {};\n\n for (const [key, value] of Object.entries(process.env)) {\n if (!value) continue;\n\n const isSensitive = sensitiveKeys.some((sensitiveKey) =>\n key.toLowerCase().includes(sensitiveKey.toLowerCase()),\n );\n\n safeEnv[key] = isSensitive ? \"******\" : value;\n }\n\n return safeEnv;\n }\n\n /**\n * Checks whether the specified environment variable exists.\n *\n * @param {string} key - The environment variable key.\n * @returns {boolean} `true` if the variable is defined, otherwise `false`.\n */\n static has(key: string): boolean {\n return process.env[key] !== undefined;\n }\n\n /**\n * Deletes the given environment variable (useful in tests).\n *\n * @param {string} key - The environment variable key to delete.\n * @returns {void}\n */\n static delete(key: string): void {\n delete process.env[key];\n }\n}\n"]}
|
|
@@ -111,4 +111,120 @@ export declare class GatewayTimeoutException extends ErrorResponse {
|
|
|
111
111
|
*/
|
|
112
112
|
constructor(message?: string);
|
|
113
113
|
}
|
|
114
|
+
/**
|
|
115
|
+
* Represents a 422 Unprocessable Entity Error.
|
|
116
|
+
* Used when the server understands the content type but cannot process the contained instructions.
|
|
117
|
+
*/
|
|
118
|
+
export declare class UnprocessableEntityException extends ErrorResponse {
|
|
119
|
+
details?: Record<string, any> | undefined;
|
|
120
|
+
/**
|
|
121
|
+
* @param message - Optional custom message. Defaults to "Unprocessable Entity".
|
|
122
|
+
* @param details - Optional validation details or additional error context.
|
|
123
|
+
*/
|
|
124
|
+
constructor(message?: string, details?: Record<string, any> | undefined);
|
|
125
|
+
}
|
|
126
|
+
/**
|
|
127
|
+
* Represents a 405 Method Not Allowed Error.
|
|
128
|
+
* Used when the request method is not supported for the requested resource.
|
|
129
|
+
*/
|
|
130
|
+
export declare class MethodNotAllowedException extends ErrorResponse {
|
|
131
|
+
allowedMethods?: string[] | undefined;
|
|
132
|
+
/**
|
|
133
|
+
* @param message - Optional custom message. Defaults to "Method Not Allowed".
|
|
134
|
+
* @param allowedMethods - Optional array of allowed HTTP methods.
|
|
135
|
+
*/
|
|
136
|
+
constructor(message?: string, allowedMethods?: string[] | undefined);
|
|
137
|
+
}
|
|
138
|
+
/**
|
|
139
|
+
* Represents a 406 Not Acceptable Error.
|
|
140
|
+
* Used when the server cannot produce a response matching the client's accepted content types.
|
|
141
|
+
*/
|
|
142
|
+
export declare class NotAcceptableException extends ErrorResponse {
|
|
143
|
+
/**
|
|
144
|
+
* @param message - Optional custom message. Defaults to "Not Acceptable".
|
|
145
|
+
*/
|
|
146
|
+
constructor(message?: string);
|
|
147
|
+
}
|
|
148
|
+
/**
|
|
149
|
+
* Represents a 408 Request Timeout Error.
|
|
150
|
+
* Used when the server times out waiting for the client to send a request.
|
|
151
|
+
*/
|
|
152
|
+
export declare class RequestTimeoutException extends ErrorResponse {
|
|
153
|
+
/**
|
|
154
|
+
* @param message - Optional custom message. Defaults to "Request Timeout".
|
|
155
|
+
*/
|
|
156
|
+
constructor(message?: string);
|
|
157
|
+
}
|
|
158
|
+
/**
|
|
159
|
+
* Represents a 415 Unsupported Media Type Error.
|
|
160
|
+
* Used when the request's Content-Type is not supported.
|
|
161
|
+
*/
|
|
162
|
+
export declare class UnsupportedMediaTypeException extends ErrorResponse {
|
|
163
|
+
/**
|
|
164
|
+
* @param message - Optional custom message. Defaults to "Unsupported Media Type".
|
|
165
|
+
*/
|
|
166
|
+
constructor(message?: string);
|
|
167
|
+
}
|
|
168
|
+
/**
|
|
169
|
+
* Represents a 413 Payload Too Large Error.
|
|
170
|
+
* Used when the request body exceeds server limits.
|
|
171
|
+
*/
|
|
172
|
+
export declare class PayloadTooLargeException extends ErrorResponse {
|
|
173
|
+
/**
|
|
174
|
+
* @param message - Optional custom message. Defaults to "Payload Too Large".
|
|
175
|
+
*/
|
|
176
|
+
constructor(message?: string);
|
|
177
|
+
}
|
|
178
|
+
/**
|
|
179
|
+
* Represents a 507 Insufficient Storage Error.
|
|
180
|
+
* Used when the server has insufficient storage to complete the request.
|
|
181
|
+
*/
|
|
182
|
+
export declare class InsufficientStorageException extends ErrorResponse {
|
|
183
|
+
/**
|
|
184
|
+
* @param message - Optional custom message. Defaults to "Insufficient Storage".
|
|
185
|
+
*/
|
|
186
|
+
constructor(message?: string);
|
|
187
|
+
}
|
|
188
|
+
/**
|
|
189
|
+
* Checks if an error is an instance of HttpError or its subclasses.
|
|
190
|
+
*
|
|
191
|
+
* @param error - The error to check.
|
|
192
|
+
* @returns True if the error is an HttpError, false otherwise.
|
|
193
|
+
*/
|
|
194
|
+
export declare function isHttpError(error: unknown): error is ErrorResponse;
|
|
195
|
+
/**
|
|
196
|
+
* Creates an HTTP error with the specified status code and message.
|
|
197
|
+
* Factory function for creating appropriate HTTP error instances.
|
|
198
|
+
*
|
|
199
|
+
* @param status - HTTP status code.
|
|
200
|
+
* @param message - Optional custom error message.
|
|
201
|
+
* @returns An instance of the appropriate HTTP error class.
|
|
202
|
+
*/
|
|
203
|
+
export declare function createHttpError(status: number, message?: string): ErrorResponse;
|
|
204
|
+
/**
|
|
205
|
+
* Type guard to check if an object has specific error properties.
|
|
206
|
+
*
|
|
207
|
+
* @param error - The object to check.
|
|
208
|
+
* @returns True if object has error-like structure.
|
|
209
|
+
*/
|
|
210
|
+
export declare function hasErrorShape(error: unknown): error is {
|
|
211
|
+
message: string;
|
|
212
|
+
status?: number;
|
|
213
|
+
code?: string;
|
|
214
|
+
};
|
|
215
|
+
/**
|
|
216
|
+
* Safely extracts message from any error type.
|
|
217
|
+
*
|
|
218
|
+
* @param error - Any error object or value.
|
|
219
|
+
* @returns A string error message.
|
|
220
|
+
*/
|
|
221
|
+
export declare function getErrorMessage(error: unknown): string;
|
|
222
|
+
/**
|
|
223
|
+
* Wraps a function and transforms any errors into HTTP errors.
|
|
224
|
+
* Useful for API handlers to ensure consistent error responses.
|
|
225
|
+
*
|
|
226
|
+
* @param handler - The async function to wrap.
|
|
227
|
+
* @returns A function that always returns or throws an HTTP error.
|
|
228
|
+
*/
|
|
229
|
+
export declare function withErrorHandling<T extends (...args: any[]) => Promise<any>>(handler: T): (...args: Parameters<T>) => Promise<Awaited<ReturnType<T>>>;
|
|
114
230
|
//# sourceMappingURL=exception.utils.d.ts.map
|