@ms-cloudpack/config 0.26.0 → 0.26.1

package/lib/sortGeneratedConfig.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sortGeneratedConfig.d.ts","sourceRoot":"","sources":["../src/sortGeneratedConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAyC,MAAM,4BAA4B,CAAC;AAIzG;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,eAAe,QAiC7D"}
+{"version":3,"file":"sortGeneratedConfig.d.ts","sourceRoot":"","sources":["../src/sortGeneratedConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAyC,MAAM,4BAA4B,CAAC;AAIzG;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,eAAe,QAoC7D"}

package/lib/sortGeneratedConfig.js

@@ -5,7 +5,10 @@ import { compareSettings } from './compareSettings.js';
  * order of operations.
  */
 export function sortGeneratedConfig(generated) {
-    const { packageSettings = [] } = generated;
+    const { packageSettings } = generated;
+    if (!packageSettings) {
+        return;
+    }
     // Ensure package overrides are sorted based on package name and version requirement.
     packageSettings.sort(compareSettings);
     for (let i = 0; i < packageSettings.length; i++) {

package/lib/sortGeneratedConfig.js.map

@@ -1 +1 @@
-{"version":3,"file":"sortGeneratedConfig.js","sourceRoot":"","sources":["../src/sortGeneratedConfig.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAAC,SAA0B;IAC5D,MAAM,EAAE,eAAe,GAAG,EAAE,EAAE,GAAG,SAAS,CAAC;IAE3C,qFAAqF;IACrF,eAAe,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAEtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAChD,8DAA8D;QAC9D,MAAM,eAAe,GAAG,eAAe,CAAC,CAAC,CAAwB,CAAC;QAClE,MAAM,gBAAgB,GAGlB;YACF,mEAAmE;YACnE,KAAK,EAAE,eAAe,CAAC,KAAK;SAC7B,CAAC;QAEF,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,IAAI,EAA+B,EAAE,CAAC;YACnF,IAAI,GAAG,KAAK,OAAO,EAAE,CAAC;gBACpB,mEAAmE;gBACnE,MAAM,KAAK,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC;gBACnC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBACzB,gBAAgB,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;gBACvC,CAAC;qBAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;oBACvD,gBAAgB,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;gBAChD,CAAC;qBAAM,CAAC;oBACN,gBAAgB,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;gBAChC,CAAC;YACH,CAAC;QACH,CAAC;QAED,eAAe,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,gBAAgB,CAAC,CAAC;IACjD,CAAC;AACH,CAAC","sourcesContent":["import type { GeneratedConfig, PackageSettings, PackageSettingsMatch } from '@ms-cloudpack/common-types';\nimport { sortObjectKeys } from './sortObjectKeys.js';\nimport { compareSettings } from './compareSettings.js';\n\n/**\n * Sorts the generated config so that we don't have unneeded changes due to differences in\n * order of operations.\n */\nexport function sortGeneratedConfig(generated: GeneratedConfig) {\n  const { packageSettings = [] } = generated;\n\n  // Ensure package overrides are sorted based on package name and version requirement.\n  packageSettings.sort(compareSettings);\n\n  for (let i = 0; i < packageSettings.length; i++) {\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    const originalSetting = packageSettings[i] as Record<string, any>;\n    const formattedSetting: {\n      match: PackageSettingsMatch;\n      [key: string]: unknown;\n    } = {\n      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n      match: originalSetting.match,\n    };\n\n    for (const key of Object.keys(originalSetting).sort() as (keyof PackageSettings)[]) {\n      if (key !== 'match') {\n        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n        const value = originalSetting[key];\n        if (Array.isArray(value)) {\n          formattedSetting[key] = value.sort();\n        } else if (typeof value === 'object' && value !== null) {\n          formattedSetting[key] = sortObjectKeys(value);\n        } else {\n          formattedSetting[key] = value;\n        }\n      }\n    }\n\n    packageSettings.splice(i, 1, formattedSetting);\n  }\n}\n"]}
+{"version":3,"file":"sortGeneratedConfig.js","sourceRoot":"","sources":["../src/sortGeneratedConfig.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAAC,SAA0B;IAC5D,MAAM,EAAE,eAAe,EAAE,GAAG,SAAS,CAAC;IACtC,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,OAAO;IACT,CAAC;IAED,qFAAqF;IACrF,eAAe,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAEtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAChD,8DAA8D;QAC9D,MAAM,eAAe,GAAG,eAAe,CAAC,CAAC,CAAwB,CAAC;QAClE,MAAM,gBAAgB,GAGlB;YACF,mEAAmE;YACnE,KAAK,EAAE,eAAe,CAAC,KAAK;SAC7B,CAAC;QAEF,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,IAAI,EAA+B,EAAE,CAAC;YACnF,IAAI,GAAG,KAAK,OAAO,EAAE,CAAC;gBACpB,mEAAmE;gBACnE,MAAM,KAAK,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC;gBACnC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBACzB,gBAAgB,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;gBACvC,CAAC;qBAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;oBACvD,gBAAgB,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;gBAChD,CAAC;qBAAM,CAAC;oBACN,gBAAgB,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;gBAChC,CAAC;YACH,CAAC;QACH,CAAC;QAED,eAAe,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,gBAAgB,CAAC,CAAC;IACjD,CAAC;AACH,CAAC","sourcesContent":["import type { GeneratedConfig, PackageSettings, PackageSettingsMatch } from '@ms-cloudpack/common-types';\nimport { sortObjectKeys } from './sortObjectKeys.js';\nimport { compareSettings } from './compareSettings.js';\n\n/**\n * Sorts the generated config so that we don't have unneeded changes due to differences in\n * order of operations.\n */\nexport function sortGeneratedConfig(generated: GeneratedConfig) {\n  const { packageSettings } = generated;\n  if (!packageSettings) {\n    return;\n  }\n\n  // Ensure package overrides are sorted based on package name and version requirement.\n  packageSettings.sort(compareSettings);\n\n  for (let i = 0; i < packageSettings.length; i++) {\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    const originalSetting = packageSettings[i] as Record<string, any>;\n    const formattedSetting: {\n      match: PackageSettingsMatch;\n      [key: string]: unknown;\n    } = {\n      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n      match: originalSetting.match,\n    };\n\n    for (const key of Object.keys(originalSetting).sort() as (keyof PackageSettings)[]) {\n      if (key !== 'match') {\n        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n        const value = originalSetting[key];\n        if (Array.isArray(value)) {\n          formattedSetting[key] = value.sort();\n        } else if (typeof value === 'object' && value !== null) {\n          formattedSetting[key] = sortObjectKeys(value);\n        } else {\n          formattedSetting[key] = value;\n        }\n      }\n    }\n\n    packageSettings.splice(i, 1, formattedSetting);\n  }\n}\n"]}

package/lib/writeGeneratedConfig.d.ts

@@ -1,6 +1,19 @@
 import type { GeneratedConfig } from '@ms-cloudpack/common-types';
 /**
- * Writes generated config. This is used for `init` to provide package overrides needed.
+ * Comment added to the top of the generated file (exported for testing only).
+ * @internal
  */
-export declare function writeGeneratedConfig(config: GeneratedConfig, appPath: string): Promise<void>;
+export declare const fileHeaderComment = "/**\n * THIS FILE IS AUTO-GENERATED.\n * DO NOT MANUALLY EDIT THIS FILE.\n */\n";
+/**
+ * Clean up the generated config (sort it and remove empty settings) and write it to
+ * cloudpack.generated.json. This is used at the end of `init`.
+ *
+ * If the config file exists but is no longer needed, it will be deleted.
+ *
+ * @returns
+ * - `'written'` if the config was written
+ * - `'deleted'` if the config previously existed but is now empty and was deleted
+ * - `'no-op'` if the config didn't previously exist and is still empty
+ */
+export declare function writeGeneratedConfig(config: GeneratedConfig, appPath: string): Promise<'written' | 'deleted' | 'no-op'>;
 //# sourceMappingURL=writeGeneratedConfig.d.ts.map

package/lib/writeGeneratedConfig.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"writeGeneratedConfig.d.ts","sourceRoot":"","sources":["../src/writeGeneratedConfig.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAMlE;;GAEG;AACH,wBAAsB,oBAAoB,CAAC,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,iBAgBlF"}
+{"version":3,"file":"writeGeneratedConfig.d.ts","sourceRoot":"","sources":["../src/writeGeneratedConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAQlE;;;GAGG;AACH,eAAO,MAAM,iBAAiB,oFAAoF,CAAC;AAEnH;;;;;;;;;;GAUG;AACH,wBAAsB,oBAAoB,CACxC,MAAM,EAAE,eAAe,EACvB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC,CAwB1C"}

package/lib/writeGeneratedConfig.js

@@ -1,19 +1,40 @@
 import { writeJson } from '@ms-cloudpack/json-utilities';
+import fs from 'fs';
+import { cleanGeneratedConfig } from './cleanGeneratedConfig.js';
 import { getConfigPath } from './getConfigPath.js';
 import { generatedAppConfigSchemaUrl } from './schemaUrls.js';
 import { sortGeneratedConfig } from './sortGeneratedConfig.js';
-import { cleanGeneratedConfig } from './cleanGeneratedConfig.js';
 /**
- * Writes generated config. This is used for `init` to provide package overrides needed.
+ * Comment added to the top of the generated file (exported for testing only).
+ * @internal
+ */
+export const fileHeaderComment = `/**\n * THIS FILE IS AUTO-GENERATED.\n * DO NOT MANUALLY EDIT THIS FILE.\n */\n`;
+/**
+ * Clean up the generated config (sort it and remove empty settings) and write it to
+ * cloudpack.generated.json. This is used at the end of `init`.
+ *
+ * If the config file exists but is no longer needed, it will be deleted.
+ *
+ * @returns
+ * - `'written'` if the config was written
+ * - `'deleted'` if the config previously existed but is now empty and was deleted
+ * - `'no-op'` if the config didn't previously exist and is still empty
  */
 export async function writeGeneratedConfig(config, appPath) {
     const { generatedConfigPath } = getConfigPath(appPath);
-    const fileHeaderComment = `/**\n * THIS FILE IS AUTO-GENERATED.\n * DO NOT MANUALLY EDIT THIS FILE.\n */\n`;
     sortGeneratedConfig(config);
     cleanGeneratedConfig(config);
-    return writeJson(generatedConfigPath, {
+    if (!config.packageSettings?.length) {
+        if (fs.existsSync(generatedConfigPath)) {
+            fs.unlinkSync(generatedConfigPath);
+            return 'deleted';
+        }
+        return 'no-op';
+    }
+    await writeJson(generatedConfigPath, {
         $schema: generatedAppConfigSchemaUrl,
         ...config,
     }, { fileHeaderComment });
+    return 'written';
 }
 //# sourceMappingURL=writeGeneratedConfig.js.map

package/lib/writeGeneratedConfig.js.map

@@ -1 +1 @@
-{"version":3,"file":"writeGeneratedConfig.js","sourceRoot":"","sources":["../src/writeGeneratedConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAEzD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,2BAA2B,EAAE,MAAM,iBAAiB,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEjE;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,MAAuB,EAAE,OAAe;IACjF,MAAM,EAAE,mBAAmB,EAAE,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;IACvD,MAAM,iBAAiB,GAAG,iFAAiF,CAAC;IAE5G,mBAAmB,CAAC,MAAM,CAAC,CAAC;IAE5B,oBAAoB,CAAC,MAAM,CAAC,CAAC;IAE7B,OAAO,SAAS,CACd,mBAAmB,EACnB;QACE,OAAO,EAAE,2BAA2B;QACpC,GAAG,MAAM;KACV,EACD,EAAE,iBAAiB,EAAE,CACtB,CAAC;AACJ,CAAC","sourcesContent":["import { writeJson } from '@ms-cloudpack/json-utilities';\nimport type { GeneratedConfig } from '@ms-cloudpack/common-types';\nimport { getConfigPath } from './getConfigPath.js';\nimport { generatedAppConfigSchemaUrl } from './schemaUrls.js';\nimport { sortGeneratedConfig } from './sortGeneratedConfig.js';\nimport { cleanGeneratedConfig } from './cleanGeneratedConfig.js';\n\n/**\n * Writes generated config. This is used for `init` to provide package overrides needed.\n */\nexport async function writeGeneratedConfig(config: GeneratedConfig, appPath: string) {\n  const { generatedConfigPath } = getConfigPath(appPath);\n  const fileHeaderComment = `/**\\n * THIS FILE IS AUTO-GENERATED.\\n * DO NOT MANUALLY EDIT THIS FILE.\\n */\\n`;\n\n  sortGeneratedConfig(config);\n\n  cleanGeneratedConfig(config);\n\n  return writeJson(\n    generatedConfigPath,\n    {\n      $schema: generatedAppConfigSchemaUrl,\n      ...config,\n    },\n    { fileHeaderComment },\n  );\n}\n"]}
+{"version":3,"file":"writeGeneratedConfig.js","sourceRoot":"","sources":["../src/writeGeneratedConfig.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AACzD,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,2BAA2B,EAAE,MAAM,iBAAiB,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAE/D;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,iFAAiF,CAAC;AAEnH;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,MAAuB,EACvB,OAAe;IAEf,MAAM,EAAE,mBAAmB,EAAE,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;IAEvD,mBAAmB,CAAC,MAAM,CAAC,CAAC;IAE5B,oBAAoB,CAAC,MAAM,CAAC,CAAC;IAE7B,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,MAAM,EAAE,CAAC;QACpC,IAAI,EAAE,CAAC,UAAU,CAAC,mBAAmB,CAAC,EAAE,CAAC;YACvC,EAAE,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;YACnC,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,MAAM,SAAS,CACb,mBAAmB,EACnB;QACE,OAAO,EAAE,2BAA2B;QACpC,GAAG,MAAM;KACV,EACD,EAAE,iBAAiB,EAAE,CACtB,CAAC;IACF,OAAO,SAAS,CAAC;AACnB,CAAC","sourcesContent":["import type { GeneratedConfig } from '@ms-cloudpack/common-types';\nimport { writeJson } from '@ms-cloudpack/json-utilities';\nimport fs from 'fs';\nimport { cleanGeneratedConfig } from './cleanGeneratedConfig.js';\nimport { getConfigPath } from './getConfigPath.js';\nimport { generatedAppConfigSchemaUrl } from './schemaUrls.js';\nimport { sortGeneratedConfig } from './sortGeneratedConfig.js';\n\n/**\n * Comment added to the top of the generated file (exported for testing only).\n * @internal\n */\nexport const fileHeaderComment = `/**\\n * THIS FILE IS AUTO-GENERATED.\\n * DO NOT MANUALLY EDIT THIS FILE.\\n */\\n`;\n\n/**\n * Clean up the generated config (sort it and remove empty settings) and write it to\n * cloudpack.generated.json. This is used at the end of `init`.\n *\n * If the config file exists but is no longer needed, it will be deleted.\n *\n * @returns\n * - `'written'` if the config was written\n * - `'deleted'` if the config previously existed but is now empty and was deleted\n * - `'no-op'` if the config didn't previously exist and is still empty\n */\nexport async function writeGeneratedConfig(\n  config: GeneratedConfig,\n  appPath: string,\n): Promise<'written' | 'deleted' | 'no-op'> {\n  const { generatedConfigPath } = getConfigPath(appPath);\n\n  sortGeneratedConfig(config);\n\n  cleanGeneratedConfig(config);\n\n  if (!config.packageSettings?.length) {\n    if (fs.existsSync(generatedConfigPath)) {\n      fs.unlinkSync(generatedConfigPath);\n      return 'deleted';\n    }\n    return 'no-op';\n  }\n\n  await writeJson(\n    generatedConfigPath,\n    {\n      $schema: generatedAppConfigSchemaUrl,\n      ...config,\n    },\n    { fileHeaderComment },\n  );\n  return 'written';\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ms-cloudpack/config",
-  "version": "0.26.0",
+  "version": "0.26.1",
   "description": "Configuration handling for cloudpack.",
   "license": "MIT",
   "type": "module",