@ms-cloudpack/config 0.33.22 → 0.33.23

package/lib/readConfig/addReadAppConfigOptions.d.ts

@@ -1,4 +1,4 @@
 import type { AppConfig } from '@ms-cloudpack/common-types';
 import type { ReadAppConfigOptions } from './readAppConfig.js';
-export declare function addReadAppConfigOptions<TConfig extends Pick<AppConfig, 'packageSettings' | 'features'>>(config: TConfig, options: ReadAppConfigOptions): TConfig;
+export declare function addReadAppConfigOptions<TConfig extends Pick<AppConfig, 'packageSettings' | 'features' | 'define'>>(config: TConfig, options: ReadAppConfigOptions): TConfig;
 //# sourceMappingURL=addReadAppConfigOptions.d.ts.map

package/lib/readConfig/addReadAppConfigOptions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"addReadAppConfigOptions.d.ts","sourceRoot":"","sources":["../../src/readConfig/addReadAppConfigOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAE/D,wBAAgB,uBAAuB,CAAC,OAAO,SAAS,IAAI,CAAC,SAAS,EAAE,iBAAiB,GAAG,UAAU,CAAC,EACrG,MAAM,EAAE,OAAO,EACf,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAcT"}
+{"version":3,"file":"addReadAppConfigOptions.d.ts","sourceRoot":"","sources":["../../src/readConfig/addReadAppConfigOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAE/D,wBAAgB,uBAAuB,CAAC,OAAO,SAAS,IAAI,CAAC,SAAS,EAAE,iBAAiB,GAAG,UAAU,GAAG,QAAQ,CAAC,EAChH,MAAM,EAAE,OAAO,EACf,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAqBT"}

package/lib/readConfig/addReadAppConfigOptions.js

@@ -1,5 +1,5 @@
 export function addReadAppConfigOptions(config, options) {
-    const { extraPackageSettings, extraFeatures } = options;
+    const { extraPackageSettings, extraFeatures, extraDefineFlags } = options;
     if (extraPackageSettings) {
         // Add these last so they take precedence.
         (config.packageSettings ??= []).push(...extraPackageSettings);
@@ -8,6 +8,12 @@ export function addReadAppConfigOptions(config, options) {
         // Merge extra features
         config.features = { ...config.features, ...extraFeatures };
     }
+    if (extraDefineFlags) {
+        config.define = {
+            ...config.define,
+            ...extraDefineFlags,
+        };
+    }
     return config;
 }
 //# sourceMappingURL=addReadAppConfigOptions.js.map

package/lib/readConfig/addReadAppConfigOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"addReadAppConfigOptions.js","sourceRoot":"","sources":["../../src/readConfig/addReadAppConfigOptions.ts"],"names":[],"mappings":"AAGA,MAAM,UAAU,uBAAuB,CACrC,MAAe,EACf,OAA6B;IAE7B,MAAM,EAAE,oBAAoB,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;IAExD,IAAI,oBAAoB,EAAE,CAAC;QACzB,0CAA0C;QAC1C,CAAC,MAAM,CAAC,eAAe,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,oBAAoB,CAAC,CAAC;IAChE,CAAC;IAED,IAAI,aAAa,EAAE,CAAC;QAClB,uBAAuB;QACvB,MAAM,CAAC,QAAQ,GAAG,EAAE,GAAG,MAAM,CAAC,QAAQ,EAAE,GAAG,aAAa,EAAE,CAAC;IAC7D,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["import type { AppConfig } from '@ms-cloudpack/common-types';\nimport type { ReadAppConfigOptions } from './readAppConfig.js';\n\nexport function addReadAppConfigOptions<TConfig extends Pick<AppConfig, 'packageSettings' | 'features'>>(\n  config: TConfig,\n  options: ReadAppConfigOptions,\n): TConfig {\n  const { extraPackageSettings, extraFeatures } = options;\n\n  if (extraPackageSettings) {\n    // Add these last so they take precedence.\n    (config.packageSettings ??= []).push(...extraPackageSettings);\n  }\n\n  if (extraFeatures) {\n    // Merge extra features\n    config.features = { ...config.features, ...extraFeatures };\n  }\n\n  return config;\n}\n"]}
+{"version":3,"file":"addReadAppConfigOptions.js","sourceRoot":"","sources":["../../src/readConfig/addReadAppConfigOptions.ts"],"names":[],"mappings":"AAGA,MAAM,UAAU,uBAAuB,CACrC,MAAe,EACf,OAA6B;IAE7B,MAAM,EAAE,oBAAoB,EAAE,aAAa,EAAE,gBAAgB,EAAE,GAAG,OAAO,CAAC;IAE1E,IAAI,oBAAoB,EAAE,CAAC;QACzB,0CAA0C;QAC1C,CAAC,MAAM,CAAC,eAAe,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,oBAAoB,CAAC,CAAC;IAChE,CAAC;IAED,IAAI,aAAa,EAAE,CAAC;QAClB,uBAAuB;QACvB,MAAM,CAAC,QAAQ,GAAG,EAAE,GAAG,MAAM,CAAC,QAAQ,EAAE,GAAG,aAAa,EAAE,CAAC;IAC7D,CAAC;IAED,IAAI,gBAAgB,EAAE,CAAC;QACrB,MAAM,CAAC,MAAM,GAAG;YACd,GAAG,MAAM,CAAC,MAAM;YAChB,GAAG,gBAAgB;SACpB,CAAC;IACJ,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["import type { AppConfig } from '@ms-cloudpack/common-types';\nimport type { ReadAppConfigOptions } from './readAppConfig.js';\n\nexport function addReadAppConfigOptions<TConfig extends Pick<AppConfig, 'packageSettings' | 'features' | 'define'>>(\n  config: TConfig,\n  options: ReadAppConfigOptions,\n): TConfig {\n  const { extraPackageSettings, extraFeatures, extraDefineFlags } = options;\n\n  if (extraPackageSettings) {\n    // Add these last so they take precedence.\n    (config.packageSettings ??= []).push(...extraPackageSettings);\n  }\n\n  if (extraFeatures) {\n    // Merge extra features\n    config.features = { ...config.features, ...extraFeatures };\n  }\n\n  if (extraDefineFlags) {\n    config.define = {\n      ...config.define,\n      ...extraDefineFlags,\n    };\n  }\n\n  return config;\n}\n"]}

package/lib/readConfig/readAppConfig.d.ts

@@ -1,4 +1,5 @@
 import type { AppConfig, Features, PackageSettings } from '@ms-cloudpack/common-types';
+import type { DefineFlags } from '@ms-cloudpack/common-types-browser';
 export interface ReadAppConfigOptions {
     /**
      * Extra feature settings. There will be a warning if any of these are invalid.
@@ -8,6 +9,10 @@ export interface ReadAppConfigOptions {
      * Extra package settings to add at the end of user-provided settings (so they take precedence).
      */
     extraPackageSettings?: PackageSettings[];
+    /**
+     * Extra define flags to add at the end of user-provided settings (so they take precedence).
+     */
+    extraDefineFlags?: DefineFlags;
 }
 /**
  * Reads the user config file and merges with any parent configs asynchronously.

package/lib/readConfig/readAppConfig.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"readAppConfig.d.ts","sourceRoot":"","sources":["../../src/readConfig/readAppConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAYvF,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,aAAa,CAAC,EAAE,QAAQ,CAAC;IAEzB;;OAEG;IACH,oBAAoB,CAAC,EAAE,eAAe,EAAE,CAAC;CAC1C;AAED;;;;;;;;GAQG;AACH,wBAAsB,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,SAAS,CAAC,CAmBvG"}
+{"version":3,"file":"readAppConfig.d.ts","sourceRoot":"","sources":["../../src/readConfig/readAppConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAWvF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AAEtE,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,aAAa,CAAC,EAAE,QAAQ,CAAC;IAEzB;;OAEG;IACH,oBAAoB,CAAC,EAAE,eAAe,EAAE,CAAC;IAEzC;;OAEG;IACH,gBAAgB,CAAC,EAAE,WAAW,CAAC;CAChC;AAED;;;;;;;;GAQG;AACH,wBAAsB,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,SAAS,CAAC,CAmBvG"}

package/lib/readConfig/readAppConfig.js.map

@@ -1 +1 @@
-{"version":3,"file":"readAppConfig.js","sourceRoot":"","sources":["../../src/readConfig/readAppConfig.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AACpE,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAC;AAC7E,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAcvE;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,OAAe,EAAE,OAA8B;IACjF,MAAM,EAAE,aAAa,EAAE,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;IAEjD,iGAAiG;IACjG,6FAA6F;IAC7F,iEAAiE;IACjE,IAAI,MAAiB,CAAC;IACtB,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;QAClC,MAAM,GAAG,EAAE,CAAC;IACd,CAAC;SAAM,CAAC;QACN,MAAM,GAAG,CAAC,MAAM,qBAAqB,CAAC,aAAa,CAAC,CAAC,IAAI,EAAE,CAAC;QAC5D,0BAA0B,CAAC,MAAiC,CAAC,CAAC;IAChE,CAAC;IAED,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,GAAG,uBAAuB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;GAGG;AACH,SAAS,0BAA0B,CAAC,MAAoD;IACtF,MAAM,EACJ,SAAS,EAAE,EAAE,2BAA2B,EAAE,EAC1C,UAAU,GACX,GAAG,MAAM,CAAC;IACX,IAAI,CAAC,2BAA2B,EAAE,CAAC;QACjC,OAAO;IACT,CAAC;IAED,KAAK,MAAM,CAAC,IAAI,EAAE,eAAe,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,2BAA2B,CAAC,EAAE,CAAC;QAClF,IAAI,CAAC;YACH,MAAM,SAAS,GAAG,aAAa,CAAC,EAAE,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,CAAC,CAAC;YAC7E,2BAA2B,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,QAAQ,EAAE,CAAC;QAC3D,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,wCAAwC,eAAe,OAAQ,CAAW,CAAC,OAAO,IAAI,CAAC,EAAE,CAAC,CAAC;QAC7G,CAAC;IACH,CAAC;AACH,CAAC;AACD;;;GAGG;AACH,KAAK,UAAU,qBAAqB,CAAC,UAAkB;IACrD,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAY,UAAU,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC;IACpG,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,6DAA6D;QAC7D,MAAM,IAAI,KAAK,CAAC,8BAA8B,UAAU,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,eAAe,UAAU,+CAA+C,CAAC,CAAC;IAC5F,CAAC;IAED,aAAa,CAAC,SAAS,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IAE9C,0BAA0B,CAAC,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,CAAC;IAEtD,uBAAuB,CAAC,SAAS,CAAC,CAAC;IAEnC,4FAA4F;IAC5F,MAAM,EAAE,OAAO,EAAE,QAAQ,GAAG,EAAE,EAAE,GAAG,SAAS,CAAC;IAC7C,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;IACrE,MAAM,aAAa,GAAG,MAAM,OAAO,CAAC,GAAG,CACrC,YAAY,CAAC,GAAG,CAAC,CAAC,eAAe,EAAE,EAAE,CAAC,qBAAqB,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,eAAe,EAAE,CAAC,CAAC,CAAC,CACnH,CAAC;IACF,OAAO,iBAAiB,CAAC,EAAE,SAAS,EAAE,aAAa,EAAE,CAAC,CAAC;AACzD,CAAC;AAED;;;;GAIG;AACH,SAAS,cAAc,CAAC,SAAoB;IAC1C,IAAI,OAAO,GAAG,IAAI,CAAC;IAEnB,qEAAqE;IACrE,KAAK,MAAM,OAAO,IAAI,SAAS,CAAC,eAAe,IAAI,EAAE,EAAE,CAAC;QACtD,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;QAC1B,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QACvD,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;YACxB,MAAM,MAAM,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;YAChC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBACpB,OAAO,GAAG,KAAK,CAAC;gBAChB,OAAO,CAAC,KAAK,CAAC,kCAAkC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;YAClE,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;GAEG;AACH,SAAS,aAAa,CAAC,QAA6C,EAAE,UAAkB;IACtF,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO;IACT,CAAC;IAED,MAAM,eAAe,GAAa,EAAE,CAAC;IACrC,KAAK,MAAM,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;QAChD,IAAI,CAAC,WAAW,CAAC,WAA6B,CAAC,EAAE,CAAC;YAChD,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAClC,OAAO,QAAQ,CAAC,WAAW,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC;IAED,IAAI,eAAe,CAAC,MAAM,EAAE,CAAC;QAC3B,OAAO,CAAC,IAAI,CACV,+BAA+B,UAAU,iEAAiE;YACxG,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAC7B,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAS,uBAAuB,CAAC,MAAiB;IAChD,sCAAsC;IACtC,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,eAAe,GAAG,EAAE,EAAE,GAAG,MAAM,CAAC;IAE3D,IAAI,SAAS,EAAE,CAAC;QACd,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,kFAAkF,CAAC,CAAC;QACtG,CAAC;QAED,MAAM,CAAC,MAAM,GAAG,SAAS,CAAC;QAC1B,OAAO,MAAM,CAAC,SAAS,CAAC;IAC1B,CAAC;IAED,IAAI,MAAM,EAAE,MAAM,EAAE,CAAC;QACnB,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC9B,OAAO,MAAM,CAAC,MAAM,CAAC;IACvB,CAAC;IAED,KAAK,MAAM,OAAO,IAAI,eAAe,EAAE,CAAC;QACtC,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;YACxB,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC;YACtC,OAAO,OAAO,CAAC,WAAW,CAAC;QAC7B,CAAC;IACH,CAAC;IACD,qCAAqC;AACvC,CAAC","sourcesContent":["import type { AppConfig, Features, PackageSettings } from '@ms-cloudpack/common-types';\nimport { allFeatures } from '@ms-cloudpack/common-types';\nimport { readJson } from '@ms-cloudpack/json-utilities';\nimport fs from 'fs';\nimport { getConfigPath } from '../getConfigPath.js';\nimport { mergeParentConfig } from './mergeParentConfig.js';\nimport { resolveParentConfig } from './resolveParentConfig.js';\nimport { resolveModule } from '@ms-cloudpack/path-utilities';\nimport { validateMatch } from '../packageSettings/validateMatch.js';\nimport { expandEnvironmentVariables } from './expandEnvironmentVariables.js';\nimport { addReadAppConfigOptions } from './addReadAppConfigOptions.js';\n\nexport interface ReadAppConfigOptions {\n  /**\n   * Extra feature settings. There will be a warning if any of these are invalid.\n   */\n  extraFeatures?: Features;\n\n  /**\n   * Extra package settings to add at the end of user-provided settings (so they take precedence).\n   */\n  extraPackageSettings?: PackageSettings[];\n}\n\n/**\n * Reads the user config file and merges with any parent configs asynchronously.\n * Note this is only useful for making modifications to the user config.\n * For a full merged representation of config, use `readConfig` instead.\n *\n * Throws an error if the config file exists but is not valid JSON, there's some error reading it,\n * or any settings are invalid. (As of writing, this doesn't do full schema validation; it only\n * checks certain specific settings.)\n */\nexport async function readAppConfig(appPath: string, options?: ReadAppConfigOptions): Promise<AppConfig> {\n  const { appConfigPath } = getConfigPath(appPath);\n\n  // Do a separate existence check for the top-level config, since it's fine if that doesn't exist.\n  // (readAppConfigInternal throws if the file doesn't exist because it's also used for reading\n  // parent configs from \"extends\", which must exist if specified.)\n  let config: AppConfig;\n  if (!fs.existsSync(appConfigPath)) {\n    config = {};\n  } else {\n    config = (await readAppConfigInternal(appConfigPath)) || {};\n    expandEnvironmentVariables(config as Record<string, unknown>);\n  }\n\n  if (options) {\n    config = addReadAppConfigOptions(config, options);\n  }\n\n  return config;\n}\n\n/**\n * Resolve import specifiers for bundler capabilities registry.\n * Throws if a specifier can't be resolved.\n */\nfunction resolveBundlerCapabilities(params: { appConfig: AppConfig; configPath: string }): void {\n  const {\n    appConfig: { bundlerCapabilitiesRegistry },\n    configPath,\n  } = params;\n  if (!bundlerCapabilitiesRegistry) {\n    return;\n  }\n\n  for (const [name, importSpecifier] of Object.entries(bundlerCapabilitiesRegistry)) {\n    try {\n      const moduleUrl = resolveModule({ parentPath: configPath, importSpecifier });\n      bundlerCapabilitiesRegistry[name] = moduleUrl.toString();\n    } catch (e) {\n      throw new Error(`Error resolving bundler capability  \"${importSpecifier}\":\\n${(e as Error).message || e}`);\n    }\n  }\n}\n/**\n * Reads the user config, with any `extends` parent configs merged in.\n * Throws an error if the config file exists but is not valid JSON, or there's some error reading it.\n */\nasync function readAppConfigInternal(configPath: string): Promise<AppConfig> {\n  const appConfig = await readJson<AppConfig>(configPath, { mode: 'permissive', throwOnError: true });\n  if (!appConfig) {\n    // shouldn't happen, but just in case/to satisfy the types...\n    throw new Error(`Could not read config file ${configPath}`);\n  }\n\n  if (!validateConfig(appConfig)) {\n    throw new Error(`Config file ${configPath} has invalid settings (see above for details)`);\n  }\n\n  checkFeatures(appConfig.features, configPath);\n\n  resolveBundlerCapabilities({ appConfig, configPath });\n\n  processDeprecatedValues(appConfig);\n\n  // Read and merge with any parent configs (the same processing is applied to parent configs)\n  const { extends: _extends = [] } = appConfig;\n  const extendsArray = Array.isArray(_extends) ? _extends : [_extends];\n  const parentConfigs = await Promise.all(\n    extendsArray.map((importSpecifier) => readAppConfigInternal(resolveParentConfig({ configPath, importSpecifier }))),\n  );\n  return mergeParentConfig({ appConfig, parentConfigs });\n}\n\n/**\n * Validate parts of the current config file (before merging with parents) and log any errors.\n * Logging here and then letting the caller throw if needed allows us to show more errors at once.\n * @returns true if valid, false if not\n */\nfunction validateConfig(appConfig: AppConfig): boolean {\n  let isValid = true;\n\n  // Verify that there are no matches with a negated name and a version\n  for (const setting of appConfig.packageSettings || []) {\n    const { match } = setting;\n    const matches = Array.isArray(match) ? match : [match];\n    for (const m of matches) {\n      const result = validateMatch(m);\n      if (!result.isValid) {\n        isValid = false;\n        console.error(`Invalid packageSettings match: ${result.error}`);\n      }\n    }\n  }\n\n  return isValid;\n}\n\n/**\n * Warn if any feature names are invalid, and remove them.\n */\nfunction checkFeatures(features: Record<string, boolean> | undefined, configPath: string): void {\n  if (!features) {\n    return;\n  }\n\n  const invalidFeatures: string[] = [];\n  for (const featureName of Object.keys(features)) {\n    if (!allFeatures[featureName as keyof Features]) {\n      invalidFeatures.push(featureName);\n      delete features[featureName];\n    }\n  }\n\n  if (invalidFeatures.length) {\n    console.warn(\n      `Unknown feature(s) found in ${configPath} (most likely they were graduated or removed in Cloudpack):\\n  ` +\n        invalidFeatures.join(', '),\n    );\n  }\n}\n\n/**\n * Delete deprecated values and convert them to the new format. (This mutates the `config` object.)\n */\nfunction processDeprecatedValues(config: AppConfig): void {\n  /* eslint-disable etc/no-deprecated */\n  const { devServer, server, packageSettings = [] } = config;\n\n  if (devServer) {\n    if (server) {\n      throw new Error('Cannot have both \"devServer\" and \"server\" in the config file. Use \"server\" only.');\n    }\n\n    config.server = devServer;\n    delete config.devServer;\n  }\n\n  if (server?.routes) {\n    config.routes = server.routes;\n    delete server.routes;\n  }\n\n  for (const setting of packageSettings) {\n    if (setting.bundlerType) {\n      setting.bundler = setting.bundlerType;\n      delete setting.bundlerType;\n    }\n  }\n  /* eslint-enable etc/no-deprecated */\n}\n"]}
+{"version":3,"file":"readAppConfig.js","sourceRoot":"","sources":["../../src/readConfig/readAppConfig.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AACpE,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAC;AAC7E,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAoBvE;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,OAAe,EAAE,OAA8B;IACjF,MAAM,EAAE,aAAa,EAAE,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;IAEjD,iGAAiG;IACjG,6FAA6F;IAC7F,iEAAiE;IACjE,IAAI,MAAiB,CAAC;IACtB,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;QAClC,MAAM,GAAG,EAAE,CAAC;IACd,CAAC;SAAM,CAAC;QACN,MAAM,GAAG,CAAC,MAAM,qBAAqB,CAAC,aAAa,CAAC,CAAC,IAAI,EAAE,CAAC;QAC5D,0BAA0B,CAAC,MAAiC,CAAC,CAAC;IAChE,CAAC;IAED,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,GAAG,uBAAuB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;GAGG;AACH,SAAS,0BAA0B,CAAC,MAAoD;IACtF,MAAM,EACJ,SAAS,EAAE,EAAE,2BAA2B,EAAE,EAC1C,UAAU,GACX,GAAG,MAAM,CAAC;IACX,IAAI,CAAC,2BAA2B,EAAE,CAAC;QACjC,OAAO;IACT,CAAC;IAED,KAAK,MAAM,CAAC,IAAI,EAAE,eAAe,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,2BAA2B,CAAC,EAAE,CAAC;QAClF,IAAI,CAAC;YACH,MAAM,SAAS,GAAG,aAAa,CAAC,EAAE,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,CAAC,CAAC;YAC7E,2BAA2B,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,QAAQ,EAAE,CAAC;QAC3D,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,wCAAwC,eAAe,OAAQ,CAAW,CAAC,OAAO,IAAI,CAAC,EAAE,CAAC,CAAC;QAC7G,CAAC;IACH,CAAC;AACH,CAAC;AACD;;;GAGG;AACH,KAAK,UAAU,qBAAqB,CAAC,UAAkB;IACrD,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAY,UAAU,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC;IACpG,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,6DAA6D;QAC7D,MAAM,IAAI,KAAK,CAAC,8BAA8B,UAAU,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,eAAe,UAAU,+CAA+C,CAAC,CAAC;IAC5F,CAAC;IAED,aAAa,CAAC,SAAS,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IAE9C,0BAA0B,CAAC,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,CAAC;IAEtD,uBAAuB,CAAC,SAAS,CAAC,CAAC;IAEnC,4FAA4F;IAC5F,MAAM,EAAE,OAAO,EAAE,QAAQ,GAAG,EAAE,EAAE,GAAG,SAAS,CAAC;IAC7C,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;IACrE,MAAM,aAAa,GAAG,MAAM,OAAO,CAAC,GAAG,CACrC,YAAY,CAAC,GAAG,CAAC,CAAC,eAAe,EAAE,EAAE,CAAC,qBAAqB,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,eAAe,EAAE,CAAC,CAAC,CAAC,CACnH,CAAC;IACF,OAAO,iBAAiB,CAAC,EAAE,SAAS,EAAE,aAAa,EAAE,CAAC,CAAC;AACzD,CAAC;AAED;;;;GAIG;AACH,SAAS,cAAc,CAAC,SAAoB;IAC1C,IAAI,OAAO,GAAG,IAAI,CAAC;IAEnB,qEAAqE;IACrE,KAAK,MAAM,OAAO,IAAI,SAAS,CAAC,eAAe,IAAI,EAAE,EAAE,CAAC;QACtD,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;QAC1B,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QACvD,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;YACxB,MAAM,MAAM,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;YAChC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBACpB,OAAO,GAAG,KAAK,CAAC;gBAChB,OAAO,CAAC,KAAK,CAAC,kCAAkC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;YAClE,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;GAEG;AACH,SAAS,aAAa,CAAC,QAA6C,EAAE,UAAkB;IACtF,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO;IACT,CAAC;IAED,MAAM,eAAe,GAAa,EAAE,CAAC;IACrC,KAAK,MAAM,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;QAChD,IAAI,CAAC,WAAW,CAAC,WAA6B,CAAC,EAAE,CAAC;YAChD,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAClC,OAAO,QAAQ,CAAC,WAAW,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC;IAED,IAAI,eAAe,CAAC,MAAM,EAAE,CAAC;QAC3B,OAAO,CAAC,IAAI,CACV,+BAA+B,UAAU,iEAAiE;YACxG,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAC7B,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAS,uBAAuB,CAAC,MAAiB;IAChD,sCAAsC;IACtC,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,eAAe,GAAG,EAAE,EAAE,GAAG,MAAM,CAAC;IAE3D,IAAI,SAAS,EAAE,CAAC;QACd,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,kFAAkF,CAAC,CAAC;QACtG,CAAC;QAED,MAAM,CAAC,MAAM,GAAG,SAAS,CAAC;QAC1B,OAAO,MAAM,CAAC,SAAS,CAAC;IAC1B,CAAC;IAED,IAAI,MAAM,EAAE,MAAM,EAAE,CAAC;QACnB,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC9B,OAAO,MAAM,CAAC,MAAM,CAAC;IACvB,CAAC;IAED,KAAK,MAAM,OAAO,IAAI,eAAe,EAAE,CAAC;QACtC,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;YACxB,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC;YACtC,OAAO,OAAO,CAAC,WAAW,CAAC;QAC7B,CAAC;IACH,CAAC;IACD,qCAAqC;AACvC,CAAC","sourcesContent":["import type { AppConfig, Features, PackageSettings } from '@ms-cloudpack/common-types';\nimport { allFeatures } from '@ms-cloudpack/common-types';\nimport { readJson } from '@ms-cloudpack/json-utilities';\nimport fs from 'fs';\nimport { getConfigPath } from '../getConfigPath.js';\nimport { mergeParentConfig } from './mergeParentConfig.js';\nimport { resolveParentConfig } from './resolveParentConfig.js';\nimport { resolveModule } from '@ms-cloudpack/path-utilities';\nimport { validateMatch } from '../packageSettings/validateMatch.js';\nimport { expandEnvironmentVariables } from './expandEnvironmentVariables.js';\nimport { addReadAppConfigOptions } from './addReadAppConfigOptions.js';\nimport type { DefineFlags } from '@ms-cloudpack/common-types-browser';\n\nexport interface ReadAppConfigOptions {\n  /**\n   * Extra feature settings. There will be a warning if any of these are invalid.\n   */\n  extraFeatures?: Features;\n\n  /**\n   * Extra package settings to add at the end of user-provided settings (so they take precedence).\n   */\n  extraPackageSettings?: PackageSettings[];\n\n  /**\n   * Extra define flags to add at the end of user-provided settings (so they take precedence).\n   */\n  extraDefineFlags?: DefineFlags;\n}\n\n/**\n * Reads the user config file and merges with any parent configs asynchronously.\n * Note this is only useful for making modifications to the user config.\n * For a full merged representation of config, use `readConfig` instead.\n *\n * Throws an error if the config file exists but is not valid JSON, there's some error reading it,\n * or any settings are invalid. (As of writing, this doesn't do full schema validation; it only\n * checks certain specific settings.)\n */\nexport async function readAppConfig(appPath: string, options?: ReadAppConfigOptions): Promise<AppConfig> {\n  const { appConfigPath } = getConfigPath(appPath);\n\n  // Do a separate existence check for the top-level config, since it's fine if that doesn't exist.\n  // (readAppConfigInternal throws if the file doesn't exist because it's also used for reading\n  // parent configs from \"extends\", which must exist if specified.)\n  let config: AppConfig;\n  if (!fs.existsSync(appConfigPath)) {\n    config = {};\n  } else {\n    config = (await readAppConfigInternal(appConfigPath)) || {};\n    expandEnvironmentVariables(config as Record<string, unknown>);\n  }\n\n  if (options) {\n    config = addReadAppConfigOptions(config, options);\n  }\n\n  return config;\n}\n\n/**\n * Resolve import specifiers for bundler capabilities registry.\n * Throws if a specifier can't be resolved.\n */\nfunction resolveBundlerCapabilities(params: { appConfig: AppConfig; configPath: string }): void {\n  const {\n    appConfig: { bundlerCapabilitiesRegistry },\n    configPath,\n  } = params;\n  if (!bundlerCapabilitiesRegistry) {\n    return;\n  }\n\n  for (const [name, importSpecifier] of Object.entries(bundlerCapabilitiesRegistry)) {\n    try {\n      const moduleUrl = resolveModule({ parentPath: configPath, importSpecifier });\n      bundlerCapabilitiesRegistry[name] = moduleUrl.toString();\n    } catch (e) {\n      throw new Error(`Error resolving bundler capability  \"${importSpecifier}\":\\n${(e as Error).message || e}`);\n    }\n  }\n}\n/**\n * Reads the user config, with any `extends` parent configs merged in.\n * Throws an error if the config file exists but is not valid JSON, or there's some error reading it.\n */\nasync function readAppConfigInternal(configPath: string): Promise<AppConfig> {\n  const appConfig = await readJson<AppConfig>(configPath, { mode: 'permissive', throwOnError: true });\n  if (!appConfig) {\n    // shouldn't happen, but just in case/to satisfy the types...\n    throw new Error(`Could not read config file ${configPath}`);\n  }\n\n  if (!validateConfig(appConfig)) {\n    throw new Error(`Config file ${configPath} has invalid settings (see above for details)`);\n  }\n\n  checkFeatures(appConfig.features, configPath);\n\n  resolveBundlerCapabilities({ appConfig, configPath });\n\n  processDeprecatedValues(appConfig);\n\n  // Read and merge with any parent configs (the same processing is applied to parent configs)\n  const { extends: _extends = [] } = appConfig;\n  const extendsArray = Array.isArray(_extends) ? _extends : [_extends];\n  const parentConfigs = await Promise.all(\n    extendsArray.map((importSpecifier) => readAppConfigInternal(resolveParentConfig({ configPath, importSpecifier }))),\n  );\n  return mergeParentConfig({ appConfig, parentConfigs });\n}\n\n/**\n * Validate parts of the current config file (before merging with parents) and log any errors.\n * Logging here and then letting the caller throw if needed allows us to show more errors at once.\n * @returns true if valid, false if not\n */\nfunction validateConfig(appConfig: AppConfig): boolean {\n  let isValid = true;\n\n  // Verify that there are no matches with a negated name and a version\n  for (const setting of appConfig.packageSettings || []) {\n    const { match } = setting;\n    const matches = Array.isArray(match) ? match : [match];\n    for (const m of matches) {\n      const result = validateMatch(m);\n      if (!result.isValid) {\n        isValid = false;\n        console.error(`Invalid packageSettings match: ${result.error}`);\n      }\n    }\n  }\n\n  return isValid;\n}\n\n/**\n * Warn if any feature names are invalid, and remove them.\n */\nfunction checkFeatures(features: Record<string, boolean> | undefined, configPath: string): void {\n  if (!features) {\n    return;\n  }\n\n  const invalidFeatures: string[] = [];\n  for (const featureName of Object.keys(features)) {\n    if (!allFeatures[featureName as keyof Features]) {\n      invalidFeatures.push(featureName);\n      delete features[featureName];\n    }\n  }\n\n  if (invalidFeatures.length) {\n    console.warn(\n      `Unknown feature(s) found in ${configPath} (most likely they were graduated or removed in Cloudpack):\\n  ` +\n        invalidFeatures.join(', '),\n    );\n  }\n}\n\n/**\n * Delete deprecated values and convert them to the new format. (This mutates the `config` object.)\n */\nfunction processDeprecatedValues(config: AppConfig): void {\n  /* eslint-disable etc/no-deprecated */\n  const { devServer, server, packageSettings = [] } = config;\n\n  if (devServer) {\n    if (server) {\n      throw new Error('Cannot have both \"devServer\" and \"server\" in the config file. Use \"server\" only.');\n    }\n\n    config.server = devServer;\n    delete config.devServer;\n  }\n\n  if (server?.routes) {\n    config.routes = server.routes;\n    delete server.routes;\n  }\n\n  for (const setting of packageSettings) {\n    if (setting.bundlerType) {\n      setting.bundler = setting.bundlerType;\n      delete setting.bundlerType;\n    }\n  }\n  /* eslint-enable etc/no-deprecated */\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ms-cloudpack/config",
-  "version": "0.33.22",
+  "version": "0.33.23",
   "description": "Configuration handling for cloudpack.",
   "license": "MIT",
   "type": "module",
@@ -23,6 +23,7 @@
     "semver": "^7.6.0"
   },
   "devDependencies": {
+    "@ms-cloudpack/common-types-browser": "^0.5.5",
     "@ms-cloudpack/eslint-plugin-internal": "^0.0.1",
     "@ms-cloudpack/scripts": "^0.0.1",
     "@ms-cloudpack/test-utilities": "^0.5.0"