@cyberskill/shared 3.12.0 → 3.14.0

package/dist/config/commitlint/index.d.ts

@@ -1 +1,5 @@
-export {}
+declare const _default: {
+    extends: string[];
+    ignores: ((message: string) => boolean)[];
+};
+export default _default;

package/dist/{src/config → config}/config.type.d.ts

@@ -1,4 +1,4 @@
-import { T_Object } from '../../typescript/index.js';
+import { T_Object } from '../typescript/index.js';
 export declare enum E_ConfigType {
     ESLINT = "eslint",
     COMMITLINT = "commitlint",

package/dist/{src/config → config}/config.util.d.ts

@@ -1,4 +1,4 @@
-import { T_Object } from '../../typescript/index.js';
+import { T_Object } from '../typescript/index.js';
 import { T_ConfigType } from './config.type.js';
 /**
  * Merges configurations based on the specified type.

package/dist/{src/config → config}/env/env.util.d.ts

@@ -27,3 +27,8 @@ export declare function loadEnvFile(): void;
  * @returns A validated environment object with all required configuration values.
  */
 export declare function getEnv(): I_Environment;
+/**
+ * Resets the cached environment object. For testing only.
+ * Call this to force `getEnv()` to re-read and re-validate `process.env`.
+ */
+export declare function resetEnvForTesting(): void;

package/dist/config/env/env.util.js

@@ -1,29 +1,33 @@
 import { E_Environment as e } from "../../typescript/common.type.js";
 import { CYBERSKILL_STORAGE_DIRECTORY as t } from "./env.constant.js";
-import n from "node:path";
-import r from "@dotenvx/dotenvx";
-import { cleanEnv as i, makeValidator as a, str as o } from "envalid";
-import s from "node:os";
+import n from "@dotenvx/dotenvx";
+import { cleanEnv as r, makeValidator as i, str as a } from "envalid";
+import o from "node:os";
+import s from "node:path";
 import c from "node:process";
 //#region src/config/env/env.util.ts
-var l = !1, u = a((e) => typeof e == "boolean" ? e : typeof e == "string");
-function d() {
-	c.env.NODE_ENV !== e.PRODUCTION && !l && (r.config(), l = !0);
-}
+var l = !1, u = null, d = i((e) => typeof e == "boolean" ? e : typeof e == "string");
 function f() {
-	d();
-	let e = i(c.env, {
-		CWD: o({ default: c.cwd() }),
-		DEBUG: u({ default: !1 }),
-		CYBERSKILL_STORAGE_DIRECTORY: o({ default: n.join(s.homedir(), t) })
-	});
-	return {
+	c.env.NODE_ENV !== e.PRODUCTION && !l && (n.config(), l = !0);
+}
+function p() {
+	if (u) return u;
+	f();
+	let e = r(c.env, {
+		CWD: a({ default: c.cwd() }),
+		DEBUG: d({ default: !1 }),
+		CYBERSKILL_STORAGE_DIRECTORY: a({ default: s.join(o.homedir(), t) })
+	}), n = {
 		CWD: e.CWD,
 		DEBUG: e.DEBUG,
 		CYBERSKILL_STORAGE_DIRECTORY: e.CYBERSKILL_STORAGE_DIRECTORY
 	};
+	return u = n, n;
+}
+function m() {
+	u = null, l = !1;
 }
 //#endregion
-export { f as getEnv, d as loadEnvFile };
+export { p as getEnv, f as loadEnvFile, m as resetEnvForTesting };
 
 //# sourceMappingURL=env.util.js.map

package/dist/config/env/env.util.js.map

@@ -1 +1 @@
-{"version":3,"file":"env.util.js","names":[],"sources":["../../../src/config/env/env.util.ts"],"sourcesContent":["import dotenvx from '@dotenvx/dotenvx';\nimport { cleanEnv, makeValidator, str } from 'envalid';\nimport os from 'node:os';\nimport path from 'node:path';\nimport process from 'node:process';\n\nimport { E_Environment } from '#typescript/index.js';\n\nimport type { I_Environment } from './env.type.js';\n\nimport { CYBERSKILL_STORAGE_DIRECTORY } from './env.constant.js';\n\n/**\n * Flag to track whether environment file has been loaded.\n * This variable prevents multiple loading of environment files during\n * the application lifecycle, ensuring environment variables are only\n * loaded once per session.\n */\nlet isEnvFileLoaded = false;\n\n/**\n * Custom validator for debug environment variable.\n * This validator accepts boolean values directly and converts string values\n * to true, providing flexible debug configuration options. It handles\n * both explicit boolean settings and string-based flags.\n *\n * @param input - The input value to validate (boolean or string).\n * @returns True if the input is a valid debug setting, false otherwise.\n */\nconst debugValidator = makeValidator((input) => {\n    if (typeof input === 'boolean') {\n        return input;\n    }\n    if (typeof input === 'string') {\n        return true;\n    }\n\n    return false;\n});\n\n/**\n * Loads environment variables from .env files.\n * This function loads environment variables from .env files using dotenvx,\n * but only in non-production environments. It includes a safety mechanism\n * to prevent multiple loading of the same environment file.\n *\n * The function:\n * - Checks if the current environment is not production\n * - Loads environment variables from .env files\n * - Prevents duplicate loading with a flag mechanism\n * - Uses dotenvx for enhanced environment file support\n */\nexport function loadEnvFile() {\n    if (process.env['NODE_ENV'] !== E_Environment.PRODUCTION && !isEnvFileLoaded) {\n        dotenvx.config();\n        isEnvFileLoaded = true;\n    }\n}\n\n/**\n * Retrieves and validates the application environment configuration.\n * This function loads environment variables, validates them using envalid,\n * and returns a typed environment object with default values for missing\n * variables. It ensures all required environment variables are present\n * and properly typed.\n *\n * The function validates:\n * - CWD: Current working directory (defaults to process.cwd())\n * - DEBUG: Debug mode flag (defaults to false)\n * - CYBERSKILL_STORAGE_DIRECTORY: Storage directory path (defaults to user home directory)\n *\n * @returns A validated environment object with all required configuration values.\n */\nexport function getEnv(): I_Environment {\n    loadEnvFile();\n\n    const cleanedEnv = cleanEnv(process.env, {\n        CWD: str({ default: process.cwd() }),\n        DEBUG: debugValidator({ default: false }),\n        CYBERSKILL_STORAGE_DIRECTORY: str({ default: path.join(os.homedir(), CYBERSKILL_STORAGE_DIRECTORY) }),\n    });\n\n    const env = {\n        CWD: cleanedEnv.CWD,\n        DEBUG: cleanedEnv.DEBUG,\n        CYBERSKILL_STORAGE_DIRECTORY: cleanedEnv.CYBERSKILL_STORAGE_DIRECTORY,\n    };\n\n    return env;\n}\n"],"mappings":";;;;;;;;AAkBA,IAAI,IAAkB,IAWhB,IAAiB,GAAe,MAC9B,OAAO,KAAU,YACV,IAEP,OAAO,KAAU,SAKvB;AAcF,SAAgB,IAAc;AAC1B,CAAI,EAAQ,IAAI,aAAgB,EAAc,cAAc,CAAC,MACzD,EAAQ,QAAQ,EAChB,IAAkB;;AAkB1B,SAAgB,IAAwB;AACpC,IAAa;CAEb,IAAM,IAAa,EAAS,EAAQ,KAAK;EACrC,KAAK,EAAI,EAAE,SAAS,EAAQ,KAAK,EAAE,CAAC;EACpC,OAAO,EAAe,EAAE,SAAS,IAAO,CAAC;EACzC,8BAA8B,EAAI,EAAE,SAAS,EAAK,KAAK,EAAG,SAAS,EAAE,EAA6B,EAAE,CAAC;EACxG,CAAC;AAQF,QANY;EACR,KAAK,EAAW;EAChB,OAAO,EAAW;EAClB,8BAA8B,EAAW;EAC5C"}
+{"version":3,"file":"env.util.js","names":[],"sources":["../../../src/config/env/env.util.ts"],"sourcesContent":["import dotenvx from '@dotenvx/dotenvx';\nimport { cleanEnv, makeValidator, str } from 'envalid';\nimport os from 'node:os';\nimport path from 'node:path';\nimport process from 'node:process';\n\nimport { E_Environment } from '#typescript/index.js';\n\nimport type { I_Environment } from './env.type.js';\n\nimport { CYBERSKILL_STORAGE_DIRECTORY } from './env.constant.js';\n\n/**\n * Flag to track whether environment file has been loaded.\n * This variable prevents multiple loading of environment files during\n * the application lifecycle, ensuring environment variables are only\n * loaded once per session.\n */\nlet isEnvFileLoaded = false;\n\n/**\n * Cached environment object to avoid redundant validation on every getEnv() call.\n * Reset via resetEnvForTesting() in test environments.\n */\nlet _cachedEnv: I_Environment | null = null;\n\n/**\n * Custom validator for debug environment variable.\n * This validator accepts boolean values directly and converts string values\n * to true, providing flexible debug configuration options. It handles\n * both explicit boolean settings and string-based flags.\n *\n * @param input - The input value to validate (boolean or string).\n * @returns True if the input is a valid debug setting, false otherwise.\n */\nconst debugValidator = makeValidator((input) => {\n    if (typeof input === 'boolean') {\n        return input;\n    }\n    if (typeof input === 'string') {\n        return true;\n    }\n\n    return false;\n});\n\n/**\n * Loads environment variables from .env files.\n * This function loads environment variables from .env files using dotenvx,\n * but only in non-production environments. It includes a safety mechanism\n * to prevent multiple loading of the same environment file.\n *\n * The function:\n * - Checks if the current environment is not production\n * - Loads environment variables from .env files\n * - Prevents duplicate loading with a flag mechanism\n * - Uses dotenvx for enhanced environment file support\n */\nexport function loadEnvFile() {\n    if (process.env['NODE_ENV'] !== E_Environment.PRODUCTION && !isEnvFileLoaded) {\n        dotenvx.config();\n        isEnvFileLoaded = true;\n    }\n}\n\n/**\n * Retrieves and validates the application environment configuration.\n * This function loads environment variables, validates them using envalid,\n * and returns a typed environment object with default values for missing\n * variables. It ensures all required environment variables are present\n * and properly typed.\n *\n * The function validates:\n * - CWD: Current working directory (defaults to process.cwd())\n * - DEBUG: Debug mode flag (defaults to false)\n * - CYBERSKILL_STORAGE_DIRECTORY: Storage directory path (defaults to user home directory)\n *\n * @returns A validated environment object with all required configuration values.\n */\nexport function getEnv(): I_Environment {\n    if (_cachedEnv) {\n        return _cachedEnv;\n    }\n\n    loadEnvFile();\n\n    const cleanedEnv = cleanEnv(process.env, {\n        CWD: str({ default: process.cwd() }),\n        DEBUG: debugValidator({ default: false }),\n        CYBERSKILL_STORAGE_DIRECTORY: str({ default: path.join(os.homedir(), CYBERSKILL_STORAGE_DIRECTORY) }),\n    });\n\n    const env = {\n        CWD: cleanedEnv.CWD,\n        DEBUG: cleanedEnv.DEBUG,\n        CYBERSKILL_STORAGE_DIRECTORY: cleanedEnv.CYBERSKILL_STORAGE_DIRECTORY,\n    };\n\n    _cachedEnv = env;\n\n    return env;\n}\n\n/**\n * Resets the cached environment object. For testing only.\n * Call this to force `getEnv()` to re-read and re-validate `process.env`.\n */\nexport function resetEnvForTesting(): void {\n    _cachedEnv = null;\n    isEnvFileLoaded = false;\n}\n"],"mappings":";;;;;;;;AAkBA,IAAI,IAAkB,IAMlB,IAAmC,MAWjC,IAAiB,GAAe,MAC9B,OAAO,KAAU,YACV,IAEP,OAAO,KAAU,SAKvB;AAcF,SAAgB,IAAc;AAC1B,CAAI,EAAQ,IAAI,aAAgB,EAAc,cAAc,CAAC,MACzD,EAAQ,QAAQ,EAChB,IAAkB;;AAkB1B,SAAgB,IAAwB;AACpC,KAAI,EACA,QAAO;AAGX,IAAa;CAEb,IAAM,IAAa,EAAS,EAAQ,KAAK;EACrC,KAAK,EAAI,EAAE,SAAS,EAAQ,KAAK,EAAE,CAAC;EACpC,OAAO,EAAe,EAAE,SAAS,IAAO,CAAC;EACzC,8BAA8B,EAAI,EAAE,SAAS,EAAK,KAAK,EAAG,SAAS,EAAE,EAA6B,EAAE,CAAC;EACxG,CAAC,EAEI,IAAM;EACR,KAAK,EAAW;EAChB,OAAO,EAAW;EAClB,8BAA8B,EAAW;EAC5C;AAID,QAFA,IAAa,GAEN;;AAOX,SAAgB,IAA2B;AAEvC,CADA,IAAa,MACb,IAAkB"}

package/dist/config/env/index.d.ts

@@ -1 +1,3 @@
-export {}
+export * from './env.constant.js';
+export * from './env.type.js';
+export * from './env.util.js';

package/dist/config/env/index.js

@@ -1,3 +1,3 @@
 import { CYBERSKILL_STORAGE_DIRECTORY as e } from "./env.constant.js";
-import { getEnv as t, loadEnvFile as n } from "./env.util.js";
-export { e as CYBERSKILL_STORAGE_DIRECTORY, t as getEnv, n as loadEnvFile };
+import { getEnv as t, loadEnvFile as n, resetEnvForTesting as r } from "./env.util.js";
+export { e as CYBERSKILL_STORAGE_DIRECTORY, t as getEnv, n as loadEnvFile, r as resetEnvForTesting };