@ms-cloudpack/config 0.17.10 → 0.17.12

package/lib/readUserConfig.d.ts

@@ -1,6 +1,6 @@
 import type { UserConfig } from '@ms-cloudpack/config-types';
 /**
- * Reads the user config file asynchronously. Note this is only useful for making modifications to the user config.
+ * Reads the user config file and merges with any parent configs asynchronously. Note this is only useful for making modifications to the user config.
  * For a full merged representation of config, use `readConfig` instead.
  */
 export declare function readUserConfig(appPath: string): Promise<UserConfig>;

package/lib/readUserConfig.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"readUserConfig.d.ts","sourceRoot":"","sources":["../src/readUserConfig.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAE7D;;;GAGG;AACH,wBAAsB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAIzE"}
+{"version":3,"file":"readUserConfig.d.ts","sourceRoot":"","sources":["../src/readUserConfig.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAgD7D;;;GAGG;AACH,wBAAsB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAMzE"}

package/lib/readUserConfig.js

@@ -1,11 +1,47 @@
 import { readJson } from '@ms-cloudpack/json-utilities';
 import { getConfigPath } from './getConfigPath.js';
+import { safeImportParentConfig } from './safeImportParentConfig.js';
 /**
- * Reads the user config file asynchronously. Note this is only useful for making modifications to the user config.
+ * Reads the user config file and merges it with any parent configs.
+ * @param params - The path to the user config file or the import specifier for the parent config file.
+ */
+async function readUserConfigInternal(params) {
+    if ('filePath' in params && 'importSpecifier' in params) {
+        throw new Error('Only one of filePath or importSpecifier can be specified');
+    }
+    // Read the user config file
+    const userConfig = 'importSpecifier' in params
+        ? await safeImportParentConfig(params.importSpecifier)
+        : await readJson(params.filePath, { verbose: true, mode: 'permissive' });
+    // If there is no userConfig or 'extends' property, return it early
+    if (!userConfig?.extends) {
+        return userConfig;
+    }
+    // Recursively read the parent config file
+    const parentConfig = await readUserConfigInternal({ importSpecifier: userConfig.extends });
+    // If unable to read the parent config file, return the userConfig
+    if (!parentConfig) {
+        return userConfig;
+    }
+    // Merge the parent config with the user config and return the result
+    const result = {
+        ...parentConfig,
+        ...userConfig,
+        features: {
+            ...(parentConfig.features || {}),
+            ...(userConfig.features || {}),
+        },
+    };
+    delete result.extends; // Remove the extends property from the result
+    return result;
+}
+/**
+ * Reads the user config file and merges with any parent configs asynchronously. Note this is only useful for making modifications to the user config.
  * For a full merged representation of config, use `readConfig` instead.
  */
 export async function readUserConfig(appPath) {
     const { userConfigPath } = getConfigPath(appPath);
-    return (await readJson(userConfigPath, { verbose: true, mode: 'permissive' })) || {};
+    const userConfig = (await readUserConfigInternal({ filePath: userConfigPath })) || {};
+    return userConfig;
 }
 //# sourceMappingURL=readUserConfig.js.map

package/lib/readUserConfig.js.map

@@ -1 +1 @@
-{"version":3,"file":"readUserConfig.js","sourceRoot":"","sources":["../src/readUserConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAGnD;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,OAAe;IAClD,MAAM,EAAE,cAAc,EAAE,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;IAElD,OAAO,CAAC,MAAM,QAAQ,CAAC,cAAc,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;AACvF,CAAC","sourcesContent":["import { readJson } from '@ms-cloudpack/json-utilities';\nimport { getConfigPath } from './getConfigPath.js';\nimport type { UserConfig } from '@ms-cloudpack/config-types';\n\n/**\n * Reads the user config file asynchronously. Note this is only useful for making modifications to the user config.\n * For a full merged representation of config, use `readConfig` instead.\n */\nexport async function readUserConfig(appPath: string): Promise<UserConfig> {\n  const { userConfigPath } = getConfigPath(appPath);\n\n  return (await readJson(userConfigPath, { verbose: true, mode: 'permissive' })) || {};\n}\n"]}
+{"version":3,"file":"readUserConfig.js","sourceRoot":"","sources":["../src/readUserConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAErE;;;GAGG;AACH,KAAK,UAAU,sBAAsB,CACnC,MAA0D;IAE1D,IAAI,UAAU,IAAI,MAAM,IAAI,iBAAiB,IAAI,MAAM,EAAE;QACvD,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;KAC7E;IAED,4BAA4B;IAC5B,MAAM,UAAU,GACd,iBAAiB,IAAI,MAAM;QACzB,CAAC,CAAC,MAAM,sBAAsB,CAAC,MAAM,CAAC,eAAe,CAAC;QACtD,CAAC,CAAC,MAAM,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC,CAAC;IAE7E,mEAAmE;IACnE,IAAI,CAAC,UAAU,EAAE,OAAO,EAAE;QACxB,OAAO,UAAU,CAAC;KACnB;IAED,0CAA0C;IAC1C,MAAM,YAAY,GAAG,MAAM,sBAAsB,CAAC,EAAE,eAAe,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;IAE3F,kEAAkE;IAClE,IAAI,CAAC,YAAY,EAAE;QACjB,OAAO,UAAU,CAAC;KACnB;IAED,qEAAqE;IACrE,MAAM,MAAM,GAAe;QACzB,GAAG,YAAY;QACf,GAAG,UAAU;QACb,QAAQ,EAAE;YACR,GAAG,CAAC,YAAY,CAAC,QAAQ,IAAI,EAAE,CAAC;YAChC,GAAG,CAAC,UAAU,CAAC,QAAQ,IAAI,EAAE,CAAC;SAC/B;KACF,CAAC;IAEF,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,8CAA8C;IAErE,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,OAAe;IAClD,MAAM,EAAE,cAAc,EAAE,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;IAElD,MAAM,UAAU,GAAG,CAAC,MAAM,sBAAsB,CAAC,EAAE,QAAQ,EAAE,cAAc,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IAEtF,OAAO,UAAU,CAAC;AACpB,CAAC","sourcesContent":["import { readJson } from '@ms-cloudpack/json-utilities';\nimport { getConfigPath } from './getConfigPath.js';\nimport type { UserConfig } from '@ms-cloudpack/config-types';\nimport { safeImportParentConfig } from './safeImportParentConfig.js';\n\n/**\n * Reads the user config file and merges it with any parent configs.\n * @param params - The path to the user config file or the import specifier for the parent config file.\n */\nasync function readUserConfigInternal(\n  params: { filePath: string } | { importSpecifier: string },\n): Promise<UserConfig | undefined> {\n  if ('filePath' in params && 'importSpecifier' in params) {\n    throw new Error('Only one of filePath or importSpecifier can be specified');\n  }\n\n  // Read the user config file\n  const userConfig: UserConfig | undefined =\n    'importSpecifier' in params\n      ? await safeImportParentConfig(params.importSpecifier)\n      : await readJson(params.filePath, { verbose: true, mode: 'permissive' });\n\n  // If there is no userConfig or 'extends' property, return it early\n  if (!userConfig?.extends) {\n    return userConfig;\n  }\n\n  // Recursively read the parent config file\n  const parentConfig = await readUserConfigInternal({ importSpecifier: userConfig.extends });\n\n  // If unable to read the parent config file, return the userConfig\n  if (!parentConfig) {\n    return userConfig;\n  }\n\n  // Merge the parent config with the user config and return the result\n  const result: UserConfig = {\n    ...parentConfig,\n    ...userConfig,\n    features: {\n      ...(parentConfig.features || {}),\n      ...(userConfig.features || {}),\n    },\n  };\n\n  delete result.extends; // Remove the extends property from the result\n\n  return result;\n}\n\n/**\n * Reads the user config file and merges with any parent configs asynchronously. Note this is only useful for making modifications to the user config.\n * For a full merged representation of config, use `readConfig` instead.\n */\nexport async function readUserConfig(appPath: string): Promise<UserConfig> {\n  const { userConfigPath } = getConfigPath(appPath);\n\n  const userConfig = (await readUserConfigInternal({ filePath: userConfigPath })) || {};\n\n  return userConfig;\n}\n"]}

package/lib/safeImportParentConfig.d.ts

@@ -0,0 +1,8 @@
+import type { UserConfig } from '@ms-cloudpack/config-types';
+/**
+ * Imports the parent config and returns the default export which is the json that represents UserConfig.
+ * @param userConfigImportSpecifier - The import specifier for the parent config file.
+ * @returns The UserConfig object. If import specifier can not be resolved, returns undefined.
+ */
+export declare function safeImportParentConfig(userConfigImportSpecifier: string): Promise<UserConfig | undefined>;
+//# sourceMappingURL=safeImportParentConfig.d.ts.map

package/lib/safeImportParentConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"safeImportParentConfig.d.ts","sourceRoot":"","sources":["../src/safeImportParentConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAE7D;;;;GAIG;AACH,wBAAsB,sBAAsB,CAAC,yBAAyB,EAAE,MAAM,mCAW7E"}

package/lib/safeImportParentConfig.js

@@ -0,0 +1,17 @@
+/**
+ * Imports the parent config and returns the default export which is the json that represents UserConfig.
+ * @param userConfigImportSpecifier - The import specifier for the parent config file.
+ * @returns The UserConfig object. If import specifier can not be resolved, returns undefined.
+ */
+export async function safeImportParentConfig(userConfigImportSpecifier) {
+    try {
+        const module = await import(userConfigImportSpecifier, { assert: { type: 'json' } });
+        return module.default;
+    }
+    catch (e) {
+        // If unable to import the parent config, log a warning and return undefined
+        console.warn(`Unable to import parent config ${userConfigImportSpecifier}`);
+        return undefined;
+    }
+}
+//# sourceMappingURL=safeImportParentConfig.js.map

package/lib/safeImportParentConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"safeImportParentConfig.js","sourceRoot":"","sources":["../src/safeImportParentConfig.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAAC,yBAAiC;IAC5E,IAAI;QACF,MAAM,MAAM,GAAG,MAAO,MAAM,CAAC,yBAAyB,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,CAEjF,CAAC;QACJ,OAAO,MAAM,CAAC,OAAO,CAAC;KACvB;IAAC,OAAO,CAAC,EAAE;QACV,4EAA4E;QAC5E,OAAO,CAAC,IAAI,CAAC,kCAAkC,yBAAyB,EAAE,CAAC,CAAC;QAC5E,OAAO,SAAS,CAAC;KAClB;AACH,CAAC","sourcesContent":["import type { UserConfig } from '@ms-cloudpack/config-types';\n\n/**\n * Imports the parent config and returns the default export which is the json that represents UserConfig.\n * @param userConfigImportSpecifier - The import specifier for the parent config file.\n * @returns The UserConfig object. If import specifier can not be resolved, returns undefined.\n */\nexport async function safeImportParentConfig(userConfigImportSpecifier: string) {\n  try {\n    const module = await (import(userConfigImportSpecifier, { assert: { type: 'json' } }) as Promise<{\n      default: UserConfig;\n    }>);\n    return module.default;\n  } catch (e) {\n    // If unable to import the parent config, log a warning and return undefined\n    console.warn(`Unable to import parent config ${userConfigImportSpecifier}`);\n    return undefined;\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ms-cloudpack/config",
-  "version": "0.17.10",
+  "version": "0.17.12",
   "description": "Configuration handling for cloudpack.",
   "license": "MIT",
   "type": "module",
@@ -14,10 +14,10 @@
     }
   },
   "dependencies": {
-    "@ms-cloudpack/bundler-types": "^0.23.6",
-    "@ms-cloudpack/config-types": "^0.3.1",
+    "@ms-cloudpack/bundler-types": "^0.23.8",
+    "@ms-cloudpack/config-types": "^0.3.3",
     "@ms-cloudpack/json-utilities": "^0.1.3",
-    "@ms-cloudpack/package-utilities": "^5.7.4",
+    "@ms-cloudpack/package-utilities": "^5.7.6",
     "semver": "^7.3.7"
   },
   "devDependencies": {