@cocreate/config 1.8.0 → 1.10.0

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+# [1.10.0](https://github.com/CoCreate-app/CoCreate-config/compare/v1.9.0...v1.10.0) (2023-12-01)
+
+
+### Features
+
+* get config using CoCreate-config ([d6e0b22](https://github.com/CoCreate-app/CoCreate-config/commit/d6e0b2266674c34582cdddc0f36f6836ba1c11f1))
+
+# [1.9.0](https://github.com/CoCreate-app/CoCreate-config/compare/v1.8.0...v1.9.0) (2023-11-25)
+
+
+### Bug Fixes
+
+* update licensing details ([0384b70](https://github.com/CoCreate-app/CoCreate-config/commit/0384b7042e18ee576d98dd92d32c32c7b0b9fba3))
+
+
+### Features
+
+* upgrade dependencies for latest features and fixes ([8003f7d](https://github.com/CoCreate-app/CoCreate-config/commit/8003f7dbeedcb6a87e4f3031b0e33aa05efc498e))
+
 # [1.8.0](https://github.com/CoCreate-app/CoCreate-config/compare/v1.7.0...v1.8.0) (2023-11-25)
 
 

package/README.md

@@ -68,18 +68,14 @@ Please Email the Developer Experience Team [here](mailto:develop@cocreate.app) i
 
 CoCreate-config is maintained and funded by CoCreate. The names and logos for CoCreate are trademarks of CoCreate, LLC.
 
-<a name="contribute"></a>
-
-# How to Contribute
-
-We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](https://github.com/CoCreate-app/CoCreate-config/blob/master/CONTRIBUTING.md) guide for details.
+<a name="license"></a>
 
-We want this library to be community-driven, and CoCreate led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create [issues](https://github.com/CoCreate-app/CoCreate-config/issues) and [pull requests](https://github.com/CoCreate-app/CoCreate-config/pulls) or merely upvote or comment on existing issues or pull requests.
+# License
 
-We appreciate your continued support, thank you!
+This software is dual-licensed under the GNU Affero General Public License version 3 (AGPLv3) and a commercial license.
 
-<a name="license"></a>
+-   **Open Source Use**: For open-source projects and non-commercial use, this software is available under the AGPLv3. The AGPLv3 allows you to freely use, modify, and distribute this software, provided that all modifications and derivative works are also licensed under the AGPLv3. For the full license text, see the [LICENSE file](https://github.com/CoCreate-app/CoCreate-config/blob/master/LICENSE).
 
-# License
+-   **Commercial Use**: For-profit companies and individuals intending to use this software for commercial purposes must obtain a commercial license. The commercial license is available when you sign up for an API key on our [website](https://cocreate.app). This license permits proprietary use and modification of the software without the copyleft requirements of the AGPLv3. It is ideal for integrating this software into proprietary commercial products and applications.
 
-[The MIT License (MIT)](https://github.com/CoCreate-app/CoCreate-config/blob/master/LICENSE)
+If you have not purchased a commercial license and intend to use this software for commercial purposes, you are required to sign up for an API key on our website.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cocreate/config",
-  "version": "1.8.0",
+  "version": "1.10.0",
   "description": "A convenient chain handler allows user to chain multiple CoCreate components together. When one action is complete next one will start. The sequence goes untill all config completed. Grounded on Vanilla javascript, easily configured using HTML5 attributes and/or JavaScript API.",
   "keywords": [
     "config",
@@ -59,6 +59,6 @@
     "webpack-log": "^3.0.1"
   },
   "dependencies": {
-    "@cocreate/utils": "^1.28.0"
+    "@cocreate/utils": "^1.29.0"
   }
 }

package/src/server.js

@@ -4,6 +4,42 @@ const path = require('path');
 const fs = require('fs');
 const { dotNotationToObject, getValueFromObject } = require('@cocreate/utils');
 
+/**
+ * Asynchronously retrieves configuration values. This function allows for 
+ * fetching values from project-specific configuration, global configuration, or 
+ * environment variables. Project configuration takes precedence over global and 
+ * environment settings. It also supports interactive prompts to gather critical values 
+ * from the user if they are not already defined in the configuration.
+ *
+ * @async
+ * @param {Object} items - An object representing the configuration items to retrieve. 
+ *                         The keys are the config paths, and the values are objects 
+ *                         specifying the prompt and any variable substitutions.
+ * @param {boolean} [env=true] - Flag to consider environment variables during config lookup.
+ * @param {boolean} [global=true] - Flag to consider global configuration during config lookup.
+ * @param {string} [configPath='CoCreate.config.js'] - Path to the project-specific configuration file.
+ * @returns {Promise<Object>} A promise that resolves with the configuration object.
+ *
+ * @example
+ * // Usage of the Config function
+ * async function initConfig() {
+ *   this.config = await Config({
+ *       'organization_id': { prompt: 'Enter your organization_id: ' },
+ *       'storage': {
+ *           prompt: 'Enter a friendly name for the new storage: ',
+ *           variable: 'name'
+ *       },
+ *       'storage.{{name}}.provider': {
+ *           prompt: 'Enter the storage provider, ex mongodb: '
+ *       },
+ *       'storage.{{name}}.url': {
+ *           prompt: 'Enter the storage providers url: '
+ *       }
+ *   });
+ *
+ *   const lazyLoadConfig = await Config('lazyload', false, false);
+ * }
+ */
 module.exports = async function (items, env = true, global = true, configPath = 'CoCreate.config.js') {
     async function promptForInput(question) {
         const rl = readline.createInterface({
@@ -38,6 +74,8 @@ module.exports = async function (items, env = true, global = true, configPath =
     let variables = {};
 
     async function getConfig(items) {
+        if (typeof items === 'string')
+            items = { [items]: '' }
         for (let key of Object.keys(items)) {
             let { value, prompt, choices, variable } = items[key];