@adobe/aio-cli-lib-app-config 3.0.0 → 3.0.2-pre.2024-01-08.sha-754ff986

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/aio-cli-lib-app-config",
-  "version": "3.0.0",
+  "version": "3.0.2-pre.2024-01-08.sha-754ff986",
   "description": "node lib to provide a consistent interface to various config files that make up Adobe Developer App Builder applications and extensions",
   "repository": "https://github.com/adobe/aio-cli-lib-app-config/",
   "license": "Apache-2.0",
@@ -18,9 +18,9 @@
     "generate-docs": "npm run typings && npm run jsdoc"
   },
   "dependencies": {
-    "@adobe/aio-lib-core-config": "^3.0.0",
-    "@adobe/aio-lib-core-logging": "^2.0.0",
-    "@adobe/aio-lib-env": "^2.0.0",
+    "@adobe/aio-lib-core-config": "next",
+    "@adobe/aio-lib-core-logging": "next",
+    "@adobe/aio-lib-env": "next",
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
     "fs-extra": "^9.0.1",
@@ -36,7 +36,7 @@
     "eslint-plugin-import": "^2.25.3",
     "eslint-plugin-jest": "^27",
     "eslint-plugin-jsdoc": "^42",
-    "eslint-plugin-n": "^16",
+    "eslint-plugin-n": "^15.7.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^6",
     "eslint-plugin-standard": "^4.0.0",
@@ -49,7 +49,7 @@
     "typescript": "^4.5.2"
   },
   "engines": {
-    "node": "^14.18 || ^16.13 || >=18"
+    "node": ">=18"
   },
   "jest": {
     "collectCoverage": true,
@@ -74,5 +74,6 @@
     "setupFilesAfterEnv": [
       "./test/jest.setup.js"
     ]
-  }
-}
+  },
+  "prereleaseSha": "754ff986ddcd5be75a3106e4da8af307b8c23f8a"
+}

package/schema/app.config.yaml.schema.json

@@ -218,6 +218,7 @@
         "properties": {
           "type": { "type": "string", "enum": ["string", "boolean"] },
           "title": { "type": "string", "maxLength": 200 },
+          "description": { "type": "string", "maxLength": 1000 },
           "envKey": { "type": "string", "pattern": "[a-zA-Z_]{1,}[a-zA-Z0-9_]{0,}", "maxLength": 100 },
           "enum": { "type": "array", "items": { "$ref": "#/definitions/configSchemaValue" }, "minItems": 1, "maxItems": 100 },
           "default": { "$ref": "#/definitions/configSchemaValue" },
@@ -227,7 +228,7 @@
         "additionalProperties": false
       }
     },
-    "configSchemaValue": { "type": "string", "maxLength": 1000 },
+    "configSchemaValue": { "type": ["string", "boolean"], "maxLength": 1000 },
     "productDependencies": {
       "type": "array",
       "items": {

package/src/index.js

@@ -137,13 +137,16 @@ const cloneDeep = require('lodash.clonedeep')
  *  }
  *
  * @param {object} options options to load Config
- * @param {boolean} options.allowNoImpl do not throw if there is no implementation
- * @param {boolean} options.ignoreAioConfig do not load .aio config via aio-lib-core-config, which is loaded synchronously and blocks the main thread.
+ * @param {boolean} [options.allowNoImpl=false] do not throw if there is no implementation
+ * @param {boolean} [options.ignoreAioConfig=false] do not load .aio config via aio-lib-core-config, which is loaded synchronously and blocks the main thread.
+ * @param {boolean} [options.validateAppConfig=true] set to false to not validate
  * @returns {object} the config
  */
 async function load (options = {}) {
   const allowNoImpl = options.allowNoImpl === undefined ? false : options.allowNoImpl
   const ignoreAioConfig = options.ignoreAioConfig === undefined ? false : options.ignoreAioConfig
+  const validateAppConfig = options.validateAppConfig === undefined ? true : options.validateAppConfig
+
   // *NOTE* it would be nice to support an appFolder option to load config from a different folder.
   // However, this requires to update aio-lib-core-config to support loading
   // from a different folder aswell (or enforcing ignore).
@@ -164,7 +167,9 @@ async function load (options = {}) {
     // this will resolve $include directives and output the app config into a single object
     // paths config values in $included files will be rewritten
     const appConfigWithIndex = await coalesce(defaults.USER_CONFIG_FILE, { absolutePaths: true })
-    await validate(appConfigWithIndex.config, { throws: true })
+    if (validateAppConfig) {
+      await validate(appConfigWithIndex.config, { throws: true })
+    }
     const mergedAppConfig = await mergeLegacyAppConfig(appConfigWithIndex, legacyAppConfigWithIndex)
 
     appConfig = mergedAppConfig.config
@@ -589,7 +594,13 @@ async function buildSingleConfig (configName, singleUserConfig, commonConfig, in
   // Let's search the config path that defines a key in the same config object level as 'web' or
   // 'action'
   const otherKeyInObject = Object.keys(singleUserConfig)[0]
-  const configFilePath = includeIndex[`${fullKeyPrefix}.${otherKeyInObject}`].file
+  let configFilePath
+  if (otherKeyInObject === undefined) {
+    // corner case if config is empty e.g. application: {}
+    configFilePath = includeIndex[`${fullKeyPrefix}`].file
+  } else {
+    configFilePath = includeIndex[`${fullKeyPrefix}.${otherKeyInObject}`].file
+  }
 
   const defaultActionPath = resolveToRoot('actions/', configFilePath)
   const defaultWebPath = resolveToRoot('web-src/', configFilePath)