@meltstudio/config-loader 1.0.3 → 1.1.0

package/README.md

@@ -1,9 +1,13 @@
-# Config Loader
+# @meltstudio/config-loader
+
+> ⚠️ **WARNING**: This project is in beta, so some features may change in the future. Use at your own discretion
+
 ## Project Description
 
 The Config Loader package is a powerful and user-friendly tool that simplifies the process of retrieving and collecting variables from one or multiple files for your project. It provides an efficient way to extract specific information from files and access those variables in your code. The result is a JSON object, making it easy to work with in various applications.
 
 ## Features
+
 - Retrieve and collect variables from one or multiple files in your project.
 - YAML file support (support for other file types coming soon.)
 - Data can also be retrieved from CLI or environment variables .
@@ -23,9 +27,11 @@ To install the project, you can use the following steps:
 1. Ensure that you have [Node.js](https://nodejs.org/) installed on your machine.
 2. Open a terminal or command prompt.
 3. Run the following command to install the project and its dependencies via npm:
+
 ```bash
 $ npm install @meltstudio/config-loader
 ```
+
 ```bash
 $ yarn add @meltstudio/config-loader
 ```
@@ -37,48 +43,45 @@ Here's an example of how to use the `@meltstudio/config-loader` package in a Typ
 ```typescript
 import path from "path";
 
-import Settings, { option } from "@/src";
+import c from "@meltstudio/config-loader";
 
 const run = (): void => {
-  const settings = new Settings(
-    {
-      version: option.string({ required: true, cli: true }),
-      website: {
-        title: option.string({ required: true }),
-        url: option.string({
-          required: false,
-          defaultValue: "www.mywebsite.dev",
-        }),
-        description: option.string({ required: true }),
-        isProduction: option.bool({ required: true }),
-      },
-      database: {
-        host: option.string({ required: true }),
-        port: option.number({ required: true }),
-        credentials: {
-          username: option.string(),
-          password: option.string(),
-        },
-      },
-      socialMedia: option.array({
-        required: true,
-        item: option.string({ required: true }),
-      }),
-      features: option.array({
-        required: true,
-        item: {
-          name: option.string(),
-          enabled: option.bool(),
-        },
+  const settings = c.schema({
+    version: c.string({ required: true, cli: true }),
+    website: {
+      title: c.string({ required: true }),
+      url: c.string({
+        required: false,
+        defaultValue: "www.mywebsite.dev",
       }),
+      description: c.string({ required: true }),
+      isProduction: c.bool({ required: true }),
     },
-    {
-      env: false,
-      args: true,
-      files: path.join(__dirname, "./config.yaml"),
-    }
-  );
-  const config = settings.get();
+    database: {
+      host: c.string({ required: true }),
+      port: c.number({ required: true }),
+      credentials: {
+        username: c.string(),
+        password: c.string(),
+      },
+    },
+    socialMedia: c.array({
+      required: true,
+      item: c.string({ required: true }),
+    }),
+    features: c.array({
+      required: true,
+      item: {
+        name: c.string(),
+        enabled: c.bool(),
+      },
+    }),
+  });
+  const config = settings.load({
+    env: false,
+    args: true,
+    files: path.join(__dirname, "./config.yaml"),
+  });
   console.log(JSON.stringify(config, null, 2));
 };
 
@@ -86,6 +89,7 @@ run();
 ```
 
 With a config.yaml file with the following contents:
+
 ```yaml
 version: 1.0.0
 website:
@@ -115,6 +119,7 @@ apiKeys:
 ```
 
 The expected output would be:
+
 ```json
 {
   "version": "1.0.0",
@@ -154,84 +159,93 @@ You can try executing our example in your project by following these steps with
 ```bash
 yarn example:run
 ```
+
 ### Usage with CLI
+
 When using our package with cli, it is important to have the cli attribute set to true.
 This will allow values to be sent when running the package from the command line.
+
 ```typescript
 import path from "path";
 
-import Settings, { option } from "@/src";
+import c from "@meltstudio/config-loader";
 
 const run = (): void => {
-  const settings = new Settings(
-    {
-      version: option.string({ 
-        required: true,
-        cli: true, 👈
-      }),
-    },
-    {
-      env: false,
-      args: true,
-      files: path.join(__dirname, "./config.yaml"),
-    }
-  );
-  const config = settings.get();
+  const settings = c.schema({
+    version: c.string({
+      required: true,
+      cli: true, 👈
+    }),
+  });
+  const config = settings.load({
+    env: false,
+    args: true,
+    files: path.join(__dirname, "./config.yaml"),
+  });
   console.log(JSON.stringify(config, null, 2));
 };
 
 run();
 ```
-now for use it you need to send the property name on the command line with the new value
+
+To use it you need to send the property name on the command line with the new value
+
 ```bash
 yarn example:run --version 2.0.0
 ```
+
 Having the following config.yaml file:
+
 ```yaml
 version: 1.0.0
 ```
+
 The expected output would be:
+
 ```json
 {
-  "version": "2.0.0",
+  "version": "2.0.0"
 }
 ```
+
 You can see that the CLI variable overrode the yaml file variable
+
 ### Usage with Environment Variables
+
 The Config Loader package allows you to use environment variables in your system configuration. You can specify variable names in your configuration and get them. To use this feature you need to set **env: true**
+
 ```typescript
 import path from "path";
 
-import Settings, { option } from "@/src";
+import c from "@meltstudio/config-loader";
 
 const run = (): void => {
-  const settings = new Settings(
-    {
-      database: {
-        host: option.string({ required: true }),
-        port: option.number({ required: true }),
-        credentials: {
-          username: option.string(),
-          password: option.string({
-            env: "DB_PASSWORD",
-            cli: true,
-          }),
-        },
+  const settings = c.schema({
+    database: {
+      host: c.string({ required: true }),
+      port: c.number({ required: true }),
+      credentials: {
+        username: c.string(),
+        password: c.string({
+          env: "DB_PASSWORD",
+          cli: true,
+        }),
       },
     },
-    {
-      env: true, 👈
-      args: true,
-      files: path.join(__dirname, "./config.yaml"),
-    }
-  );
-  const config = settings.get();
+  });
+  const config = settings.load({
+    env: true, 👈
+    args: true,
+    files: path.join(__dirname, "./config.yaml"),
+  });
   console.log(JSON.stringify(config, null, 2));
 };
 
 run();
 ```
+
 With the following config.yaml file:
+
 ```yaml
 database:
   host: localhost
@@ -240,10 +254,13 @@ database:
     username: admin
     password: IGNORED_PASSWORD
 ```
+
 ```bash
 yarn example:run
 ```
+
 If you have the environment variable `DB_PASSWORD=ENV_USED_PASSWORD`, the expected output would be:
+
 ```json
 {
   "database": {
@@ -256,6 +273,9 @@ If you have the environment variable `DB_PASSWORD=ENV_USED_PASSWORD`, the expect
   }
 }
 ```
+
 You can notice that the environment variable overrode the value in the config.yaml file
+
 ## License
+
 This package is licensed under the Apache License 2.0. For more information, please see the [LICENSE](./LICENSE) file.

package/dist/index.d.ts

@@ -9,9 +9,6 @@ declare class ConfigNode {
     constructor(value: Value | ArrayValue, path: string, source_type: SourceTypes, file: string | null, variable_name: string | null, arg_name: string | null);
 }
 
-type NodeTree = {
-    [key: string]: NodeTree | ConfigNode;
-};
 type SettingsSources<T> = {
     env: boolean;
     args: boolean;
@@ -37,7 +34,7 @@ declare class ArrayValueContainer {
 }
 
 type Value = boolean | string | number | object | InvalidValue;
-type DefaultValue = Value | (() => string) | (() => number);
+type DefaultValue = Value | (() => string) | (() => number) | (() => boolean);
 type RecursiveNode<T> = {
     [key: string]: OptionBase | T;
 };
@@ -85,27 +82,10 @@ declare class PrimitiveOption extends OptionBase {
 
 type OptionTypes = PrimitiveOption | ArrayOption;
 
-declare class Settings<T> {
+declare class SettingsBuilder {
     private readonly schema;
-    private readonly sources;
-    private sourceFile;
-    private argsData;
-    private envData;
-    private optionsTree;
-    private defaultData;
-    private program;
-    constructor(schema: Node, sources: SettingsSources<T>);
-    private validateFiles;
-    private load;
-    private traverseOptions;
-    private buildOption;
-    private getValidatedArray;
-    private processArrayWithSchema;
-    private setOption;
-    private addArg;
-    private getValuesFromTree;
-    get(): T;
-    getExtended(): NodeTree;
+    constructor(schema: Node);
+    load<T>(sources: SettingsSources<T>): T;
 }
 
 interface OptionPropsArgs {
@@ -125,6 +105,7 @@ declare const option: {
     number: (opts?: OptionPropsArgs) => PrimitiveOption;
     bool: (opts?: OptionPropsArgs) => PrimitiveOption;
     array: (opts: ArrayOptionPropsArgs) => ArrayOption;
+    schema: (theSchema: Node) => SettingsBuilder;
 };
 
-export { Settings as default, option };
+export { option as default };

package/dist/index.js

@@ -35,29 +35,13 @@ var __publicField = (obj, key, value) => {
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
-  default: () => src_default,
-  option: () => option
+  default: () => src_default
 });
 module.exports = __toCommonJS(src_exports);
 
-// src/types.ts
-var InvalidValue = class {
-};
-
-// src/option/arrayOption.ts
-var ArrayValueContainer = class {
-  val;
-  item;
-  constructor(item, val) {
-    this.val = val;
-    this.item = item;
-  }
-};
-var arrayOption_default = ArrayValueContainer;
-
-// src/option/base.ts
-var fs = __toESM(require("fs"));
-var import_js_yaml = __toESM(require("js-yaml"));
+// src/settings.ts
+var import_commander = require("commander");
+var fs2 = __toESM(require("fs"));
 
 // src/nodes/configNode.ts
 var ConfigNode = class {
@@ -78,6 +62,34 @@ var ConfigNode = class {
 };
 var configNode_default = ConfigNode;
 
+// src/nodes/configNodeArray.ts
+var ConfigNodeArray = class {
+  arrayValues;
+  constructor(arrayValues) {
+    this.arrayValues = arrayValues;
+  }
+};
+var configNodeArray_default = ConfigNodeArray;
+
+// src/types.ts
+var InvalidValue = class {
+};
+
+// src/option/arrayOption.ts
+var ArrayValueContainer = class {
+  val;
+  item;
+  constructor(item, val) {
+    this.val = val;
+    this.item = item;
+  }
+};
+var arrayOption_default = ArrayValueContainer;
+
+// src/option/base.ts
+var fs = __toESM(require("fs"));
+var import_js_yaml = __toESM(require("js-yaml"));
+
 // src/utils.ts
 function valueIsInvalid(val) {
   return val instanceof InvalidValue || val === null || val === void 0;
@@ -231,10 +243,18 @@ var OptionBase = class {
       }
     }
     if (this.params.defaultValue !== void 0) {
+      let defaultValue;
       if (typeof this.params.defaultValue === "function") {
+        defaultValue = this.params.defaultValue();
+      } else {
+        defaultValue = this.params.defaultValue;
+      }
+      if (this.params.kind === "array" && Array.isArray(defaultValue)) {
+        defaultValue = this.buildArrayOption(defaultValue);
+      }
+      if (!valueIsInvalid(defaultValue)) {
         return new configNode_default(
-          // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-          this.checkType(this.params.defaultValue(), path, "default"),
+          this.checkType(defaultValue, path, "default"),
           ident,
           "default",
           null,
@@ -242,14 +262,6 @@ var OptionBase = class {
           null
         );
       }
-      return new configNode_default(
-        this.checkType(this.params.defaultValue, path, "default"),
-        ident,
-        "default",
-        null,
-        null,
-        null
-      );
     }
     if (this.params.required) {
       OptionErrors.errors.push(`Required option '${ident}' not provided.`);
@@ -410,19 +422,6 @@ var ArrayOption = class extends OptionBase {
 var PrimitiveOption = class extends OptionBase {
 };
 
-// src/settings.ts
-var import_commander = require("commander");
-var fs2 = __toESM(require("fs"));
-
-// src/nodes/configNodeArray.ts
-var ConfigNodeArray = class {
-  arrayValues;
-  constructor(arrayValues) {
-    this.arrayValues = arrayValues;
-  }
-};
-var configNodeArray_default = ConfigNodeArray;
-
 // src/settings.ts
 var Settings = class {
   schema;
@@ -433,8 +432,8 @@ var Settings = class {
   optionsTree = {};
   defaultData = {};
   program;
-  constructor(schema, sources) {
-    this.schema = schema;
+  constructor(schema2, sources) {
+    this.schema = schema2;
     this.sources = sources;
     this.program = new import_commander.Command().allowUnknownOption(true).allowExcessArguments(true);
     this.load();
@@ -645,8 +644,19 @@ var Settings = class {
 };
 var settings_default = Settings;
 
+// src/builder/settings.ts
+var SettingsBuilder = class {
+  schema;
+  constructor(schema2) {
+    this.schema = schema2;
+  }
+  load(sources) {
+    const settings = new settings_default(this.schema, sources);
+    return settings.get();
+  }
+};
+
 // src/index.ts
-var src_default = settings_default;
 var DEFAULTS = {
   required: false,
   env: null,
@@ -681,14 +691,15 @@ var array = (opts) => {
     ...opts
   });
 };
+var schema = (theSchema) => {
+  return new SettingsBuilder(theSchema);
+};
 var option = {
   string,
   number,
   bool,
   // object,
-  array
+  array,
+  schema
 };
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  option
-});
+var src_default = option;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meltstudio/config-loader",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "Melt Studio's tool for loading configurations into a Node.js application.",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -25,7 +25,10 @@
     "type-check": "tsc --noEmit",
     "test": "jest --verbose",
     "example:run": "ts-node -r tsconfig-paths/register ./example/index.ts",
-    "prepare": "husky install"
+    "prepare": "husky install",
+    "docs:install": "python -m venv ./mkdocs-py-env && ./mkdocs-py-env/Scripts/pip install -r ./mkdocs-requirements.txt",
+    "docs:build": "./mkdocs-py-env/Scripts/mkdocs build",
+    "docs:serve": "./mkdocs-py-env/Scripts/mkdocs serve"
   },
   "dependencies": {
     "@types/js-yaml": "^4.0.5",