binhend 2.3.11 → 2.3.12

package/index.js

@@ -30,7 +30,8 @@ const csrf = require('./packages/middlewares/src/csrf');
 const trycatch = require('./packages/middlewares/src/trycatch');
 const { Auth } = require('./packages/middlewares/src/authorize');
 
-const { config, ConfigLoader, env } = require('./packages/config');
+const { config, ConfigLoader } = require('./packages/config/src/configuration');
+const { env } = require('./packages/config/src/process.env');
 
 const CSD = require('./packages/csd/src/csd');
 const CinCSD = require('./packages/csd/src/controller');

package/jsconfig.json

@@ -1,11 +1,15 @@
 {
     "compilerOptions": {
-        "forceConsistentCasingInFileNames": true,
-        "moduleResolution": "node",
-        "target": "ES2022",
-        "checkJs": true,
-        "allowJs": true,
-        "noEmit": true,
+        "forceConsistentCasingInFileNames": true, // Enforce consistent file name casing across platforms (Linux is case-sensitive, Windows is not); e.g. require("case/sensitive/path")
+        "moduleResolution": "node", // Resolve modules using Node.js resolution algorithm (e.g. require("./utils") → utils.(js|json|node) or utils/index.js)
+        "target": "ES2022", // Enable type checking based on the JavaScript version whose syntax and built-ins are supported
+
+        "checkJs": true, // Enable type checking for .js files (read JSDoc, validate types, report type errors)
+        "allowJs": true, // Allow JavaScript files in the project (mainly useful for TypeScript projects)
+        "noEmit": true, // Do not emit compiled output files (.js, .d.ts); use TypeScript only for type checking and IntelliSense
+
+        "resolveJsonModule": true, // Allow importing JSON files as modules with inferred types
+        // "maxNodeModuleJsDepth": 10, // Allow VSCode to read JSDoc types from JavaScript files inside node_modules (improves IntelliSense for JS libraries)
 
         "baseUrl": "./",
         "paths": {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "binhend",
-    "version": "2.3.11",
+    "version": "2.3.12",
     "description": "",
     "main": "index.js",
     "author": "Nguyen Duc Binh",

package/packages/config/src/process.env.js

@@ -4,18 +4,44 @@ const { cli } = require('./configuration').ConfigLoader;
 const { String } = require('@binhend/validation');
 const { isString } = require('@binhend/types');
 
-function Options(options = {}) {
-    options = options || {};
+/**
+ * Options used to configure the env loader.
+ * @typedef {Object} EnvOptions
+ * @property {string} [cli] - Key used to detect env extension from CLI configs (highest priority).
+ * @property {string} [ext] - Explicit env extension to load (lower priority).
+ * @property {string} [path] - Root path where the config module file is located.
+ */
 
+/**
+ * Validator for instances of EnvOptions
+ *
+ * @param {EnvOptions} [options] - Configuration options need to be validated.
+ * @returns {EnvOptions} Validated configuration options.
+ */
+function EnvOptions(options) {
     return {
-        cli: String(options.cli), // implicitly indicate env extension via a key in CLI configs
-        ext: String(options.ext), // explicitly declare env extension, lower priority
-        path: String(options.path, { default: require.main.path }), // root path where config module file located
+        cli: String(options?.cli, { message: `Must be string|undefined for option "cli". Current: [${typeof options?.cli}] cli=${options?.cli}` }),
+        ext: String(options?.ext, { message: `Must be string|undefined for option "ext". Current: [${typeof options?.ext}] ext=${options?.ext}` }),
+        path: String(options?.path, { default: require.main.path }),
     };
 }
 
-function env(options = Options()) {
-    options = options || Options();
+/**
+ * Load configuration values from local files, system environment variables,
+ * and CLI arguments.
+ * 
+ * Higher-priority sources overwrite values from lower-priority sources.
+ *
+ * Priority order (highest → lowest):
+ * 1. CLI arguments
+ * 2. System environment variables
+ * 3. Local config files
+ *
+ * @param {EnvOptions} [options] - Configuration options for loading environment settings.
+ * @returns {Record<string, any>} Object containing the merged configuration values.
+ */
+function env(options) {
+    options = EnvOptions(options);
 
     const cliConfigs = cli();
     const env = isString(options.cli) && cliConfigs.hasOwnProperty(options.cli) ? cliConfigs[options.cli] : options.ext;
@@ -33,7 +59,7 @@ function env(options = Options()) {
         }
     }
     catch (error) {
-        console.log(`[BINHEND][CONFIG] No config file: ${configModuleFilePath}`);
+        console.log(`[BINHEND][CONFIG] No local env file: ${configModuleFilePath}`);
     }
 
     return {