@ms-cloudpack/config 0.27.1 → 0.27.2

package/lib/constants.d.ts

@@ -1,3 +1,12 @@
+import type { UserPreferences } from '@ms-cloudpack/common-types';
 export declare const appConfigFileName = "cloudpack.config.json";
 export declare const generatedConfigFileName = "cloudpack.generated.json";
+export declare const userPreferencesFileName = ".cloudpack.preferences.json";
+/**
+ * Object with all valid keys of the UserPreferences object.
+ *
+ * (This is a mapping from key to true because TS doesn't have a good way to verify that an array
+ * contains all keys of a type.)
+ */
+export declare const allUserPreferences: Readonly<Record<keyof UserPreferences, boolean>>;
 //# sourceMappingURL=constants.d.ts.map

package/lib/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,iBAAiB,0BAA0B,CAAC;AACzD,eAAO,MAAM,uBAAuB,6BAA6B,CAAC"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAElE,eAAO,MAAM,iBAAiB,0BAA0B,CAAC;AACzD,eAAO,MAAM,uBAAuB,6BAA6B,CAAC;AAClE,eAAO,MAAM,uBAAuB,gCAAgC,CAAC;AAErE;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,eAAe,EAAE,OAAO,CAAC,CAE/E,CAAC"}

package/lib/constants.js

@@ -1,3 +1,13 @@
 export const appConfigFileName = 'cloudpack.config.json';
 export const generatedConfigFileName = 'cloudpack.generated.json';
+export const userPreferencesFileName = '.cloudpack.preferences.json';
+/**
+ * Object with all valid keys of the UserPreferences object.
+ *
+ * (This is a mapping from key to true because TS doesn't have a good way to verify that an array
+ * contains all keys of a type.)
+ */
+export const allUserPreferences = {
+    cachePath: true,
+};
 //# sourceMappingURL=constants.js.map

package/lib/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,iBAAiB,GAAG,uBAAuB,CAAC;AACzD,MAAM,CAAC,MAAM,uBAAuB,GAAG,0BAA0B,CAAC","sourcesContent":["export const appConfigFileName = 'cloudpack.config.json';\nexport const generatedConfigFileName = 'cloudpack.generated.json';\n"]}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,iBAAiB,GAAG,uBAAuB,CAAC;AACzD,MAAM,CAAC,MAAM,uBAAuB,GAAG,0BAA0B,CAAC;AAClE,MAAM,CAAC,MAAM,uBAAuB,GAAG,6BAA6B,CAAC;AAErE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAqD;IAClF,SAAS,EAAE,IAAI;CAChB,CAAC","sourcesContent":["import type { UserPreferences } from '@ms-cloudpack/common-types';\n\nexport const appConfigFileName = 'cloudpack.config.json';\nexport const generatedConfigFileName = 'cloudpack.generated.json';\nexport const userPreferencesFileName = '.cloudpack.preferences.json';\n\n/**\n * Object with all valid keys of the UserPreferences object.\n *\n * (This is a mapping from key to true because TS doesn't have a good way to verify that an array\n * contains all keys of a type.)\n */\nexport const allUserPreferences: Readonly<Record<keyof UserPreferences, boolean>> = {\n  cachePath: true,\n};\n"]}

package/lib/getCachePath.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Gets the path to the cache directory.
+ */
+export declare function getCachePath(): string;
+/**
+ * Gets the path to the app's local cache directory.
+ */
+export declare function getLocalCachePath(appPath: string): string;
+//# sourceMappingURL=getCachePath.d.ts.map

package/lib/getCachePath.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getCachePath.d.ts","sourceRoot":"","sources":["../src/getCachePath.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,wBAAgB,YAAY,WAE3B;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,UAEhD"}

package/lib/getCachePath.js

@@ -0,0 +1,15 @@
+import os from 'os';
+import path from 'path';
+/**
+ * Gets the path to the cache directory.
+ */
+export function getCachePath() {
+    return path.join(os.homedir(), '.cloudpack');
+}
+/**
+ * Gets the path to the app's local cache directory.
+ */
+export function getLocalCachePath(appPath) {
+    return path.join(appPath, 'node_modules', '.cache', 'cloudpack');
+}
+//# sourceMappingURL=getCachePath.js.map

package/lib/getCachePath.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getCachePath.js","sourceRoot":"","sources":["../src/getCachePath.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB;;GAEG;AACH,MAAM,UAAU,YAAY;IAC1B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,YAAY,CAAC,CAAC;AAC/C,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAC,OAAe;IAC/C,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;AACnE,CAAC","sourcesContent":["import os from 'os';\nimport path from 'path';\n\n/**\n * Gets the path to the cache directory.\n */\nexport function getCachePath() {\n  return path.join(os.homedir(), '.cloudpack');\n}\n\n/**\n * Gets the path to the app's local cache directory.\n */\nexport function getLocalCachePath(appPath: string) {\n  return path.join(appPath, 'node_modules', '.cache', 'cloudpack');\n}\n"]}

package/lib/getUserPreferencesPath.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Path to the user-level preferences file.
+ */
+export declare function getUserPreferencesPath(): string;
+/**
+ * For testing only: use this folder instead of the home directory for the user preferences.
+ */
+export declare function setMockUserPreferencesDir(newPath: string): void;
+/**
+ * Get the currently set mock user preferences directory.
+ * @internal
+ */
+export declare function _getMockUserPreferencesDir(): string | undefined;
+//# sourceMappingURL=getUserPreferencesPath.d.ts.map

package/lib/getUserPreferencesPath.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getUserPreferencesPath.d.ts","sourceRoot":"","sources":["../src/getUserPreferencesPath.ts"],"names":[],"mappings":"AAMA;;GAEG;AACH,wBAAgB,sBAAsB,WAErC;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CAAC,OAAO,EAAE,MAAM,QAExD;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,uBAEzC"}

package/lib/getUserPreferencesPath.js

@@ -0,0 +1,24 @@
+import os from 'os';
+import path from 'path';
+import { userPreferencesFileName } from './constants.js';
+let mockUserPreferencesDir;
+/**
+ * Path to the user-level preferences file.
+ */
+export function getUserPreferencesPath() {
+    return path.join(mockUserPreferencesDir || os.homedir(), userPreferencesFileName);
+}
+/**
+ * For testing only: use this folder instead of the home directory for the user preferences.
+ */
+export function setMockUserPreferencesDir(newPath) {
+    mockUserPreferencesDir = newPath;
+}
+/**
+ * Get the currently set mock user preferences directory.
+ * @internal
+ */
+export function _getMockUserPreferencesDir() {
+    return mockUserPreferencesDir;
+}
+//# sourceMappingURL=getUserPreferencesPath.js.map

package/lib/getUserPreferencesPath.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getUserPreferencesPath.js","sourceRoot":"","sources":["../src/getUserPreferencesPath.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AAEzD,IAAI,sBAA0C,CAAC;AAE/C;;GAEG;AACH,MAAM,UAAU,sBAAsB;IACpC,OAAO,IAAI,CAAC,IAAI,CAAC,sBAAsB,IAAI,EAAE,CAAC,OAAO,EAAE,EAAE,uBAAuB,CAAC,CAAC;AACpF,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,yBAAyB,CAAC,OAAe;IACvD,sBAAsB,GAAG,OAAO,CAAC;AACnC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,0BAA0B;IACxC,OAAO,sBAAsB,CAAC;AAChC,CAAC","sourcesContent":["import os from 'os';\nimport path from 'path';\nimport { userPreferencesFileName } from './constants.js';\n\nlet mockUserPreferencesDir: string | undefined;\n\n/**\n * Path to the user-level preferences file.\n */\nexport function getUserPreferencesPath() {\n  return path.join(mockUserPreferencesDir || os.homedir(), userPreferencesFileName);\n}\n\n/**\n * For testing only: use this folder instead of the home directory for the user preferences.\n */\nexport function setMockUserPreferencesDir(newPath: string) {\n  mockUserPreferencesDir = newPath;\n}\n\n/**\n * Get the currently set mock user preferences directory.\n * @internal\n */\nexport function _getMockUserPreferencesDir() {\n  return mockUserPreferencesDir;\n}\n"]}

package/lib/index.d.ts

@@ -1,14 +1,19 @@
 export { checkMatch } from './checkMatch.js';
 export { configTemplate } from './configTemplate.js';
 export { generatedConfigFileName, appConfigFileName } from './constants.js';
+export { allUserPreferences } from './constants.js';
 export { createPackageDefinitions } from './createPackageDefinitions.js';
+export { getCachePath, getLocalCachePath } from './getCachePath.js';
 export { getConfigPath } from './getConfigPath.js';
+export { getUserPreferencesPath, setMockUserPreferencesDir } from './getUserPreferencesPath.js';
 export { getPackageSettings } from './getPackageSettings.js';
 export { getGeneratedPackageSettings } from './getGeneratedPackageSettings.js';
 export { readConfig } from './readConfig.js';
 export { readGeneratedConfig } from './readGeneratedConfig.js';
 export { readAppConfig } from './readAppConfig.js';
+export { readUserPreferences } from './readUserPreferences.js';
 export { writeGeneratedConfig } from './writeGeneratedConfig.js';
 export { writeAppConfig } from './writeAppConfig.js';
 export { ensureGeneratedSettingsForPackage } from './ensureGeneratedSettingsForPackage.js';
+export { updateUserPreference } from './updateUserPreference.js';
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,uBAAuB,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAC5E,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAC/E,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,iCAAiC,EAAE,MAAM,wCAAwC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,uBAAuB,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAC5E,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACpE,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,sBAAsB,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAChG,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAC/E,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,iCAAiC,EAAE,MAAM,wCAAwC,CAAC;AAC3F,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC"}

package/lib/index.js

@@ -1,14 +1,19 @@
 export { checkMatch } from './checkMatch.js';
 export { configTemplate } from './configTemplate.js';
 export { generatedConfigFileName, appConfigFileName } from './constants.js';
+export { allUserPreferences } from './constants.js';
 export { createPackageDefinitions } from './createPackageDefinitions.js';
+export { getCachePath, getLocalCachePath } from './getCachePath.js';
 export { getConfigPath } from './getConfigPath.js';
+export { getUserPreferencesPath, setMockUserPreferencesDir } from './getUserPreferencesPath.js';
 export { getPackageSettings } from './getPackageSettings.js';
 export { getGeneratedPackageSettings } from './getGeneratedPackageSettings.js';
 export { readConfig } from './readConfig.js';
 export { readGeneratedConfig } from './readGeneratedConfig.js';
 export { readAppConfig } from './readAppConfig.js';
+export { readUserPreferences } from './readUserPreferences.js';
 export { writeGeneratedConfig } from './writeGeneratedConfig.js';
 export { writeAppConfig } from './writeAppConfig.js';
 export { ensureGeneratedSettingsForPackage } from './ensureGeneratedSettingsForPackage.js';
+export { updateUserPreference } from './updateUserPreference.js';
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,uBAAuB,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAC5E,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAC/E,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,iCAAiC,EAAE,MAAM,wCAAwC,CAAC","sourcesContent":["export { checkMatch } from './checkMatch.js';\nexport { configTemplate } from './configTemplate.js';\nexport { generatedConfigFileName, appConfigFileName } from './constants.js';\nexport { createPackageDefinitions } from './createPackageDefinitions.js';\nexport { getConfigPath } from './getConfigPath.js';\nexport { getPackageSettings } from './getPackageSettings.js';\nexport { getGeneratedPackageSettings } from './getGeneratedPackageSettings.js';\nexport { readConfig } from './readConfig.js';\nexport { readGeneratedConfig } from './readGeneratedConfig.js';\nexport { readAppConfig } from './readAppConfig.js';\nexport { writeGeneratedConfig } from './writeGeneratedConfig.js';\nexport { writeAppConfig } from './writeAppConfig.js';\nexport { ensureGeneratedSettingsForPackage } from './ensureGeneratedSettingsForPackage.js';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,uBAAuB,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAC5E,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACpE,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,sBAAsB,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAChG,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAC/E,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,iCAAiC,EAAE,MAAM,wCAAwC,CAAC;AAC3F,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC","sourcesContent":["export { checkMatch } from './checkMatch.js';\nexport { configTemplate } from './configTemplate.js';\nexport { generatedConfigFileName, appConfigFileName } from './constants.js';\nexport { allUserPreferences } from './constants.js';\nexport { createPackageDefinitions } from './createPackageDefinitions.js';\nexport { getCachePath, getLocalCachePath } from './getCachePath.js';\nexport { getConfigPath } from './getConfigPath.js';\nexport { getUserPreferencesPath, setMockUserPreferencesDir } from './getUserPreferencesPath.js';\nexport { getPackageSettings } from './getPackageSettings.js';\nexport { getGeneratedPackageSettings } from './getGeneratedPackageSettings.js';\nexport { readConfig } from './readConfig.js';\nexport { readGeneratedConfig } from './readGeneratedConfig.js';\nexport { readAppConfig } from './readAppConfig.js';\nexport { readUserPreferences } from './readUserPreferences.js';\nexport { writeGeneratedConfig } from './writeGeneratedConfig.js';\nexport { writeAppConfig } from './writeAppConfig.js';\nexport { ensureGeneratedSettingsForPackage } from './ensureGeneratedSettingsForPackage.js';\nexport { updateUserPreference } from './updateUserPreference.js';\n"]}

package/lib/readUserPreferences.d.ts

@@ -0,0 +1,6 @@
+import type { UserPreferences } from '@ms-cloudpack/common-types';
+/**
+ * Reads the user preferences file asynchronously.
+ */
+export declare function readUserPreferences(): Promise<UserPreferences>;
+//# sourceMappingURL=readUserPreferences.d.ts.map

package/lib/readUserPreferences.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"readUserPreferences.d.ts","sourceRoot":"","sources":["../src/readUserPreferences.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAGlE;;GAEG;AACH,wBAAsB,mBAAmB,IAAI,OAAO,CAAC,eAAe,CAAC,CAQpE"}

package/lib/readUserPreferences.js

@@ -0,0 +1,13 @@
+import { readJson } from '@ms-cloudpack/json-utilities';
+import { getUserPreferencesPath } from './getUserPreferencesPath.js';
+/**
+ * Reads the user preferences file asynchronously.
+ */
+export async function readUserPreferences() {
+    const { $schema, ...prefs } = (await readJson(getUserPreferencesPath(), {
+        verbose: true,
+        mode: 'permissive',
+    })) || {};
+    return prefs;
+}
+//# sourceMappingURL=readUserPreferences.js.map

package/lib/readUserPreferences.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"readUserPreferences.js","sourceRoot":"","sources":["../src/readUserPreferences.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAExD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAErE;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB;IACvC,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,EAAE,GACzB,CAAC,MAAM,QAAQ,CAAyC,sBAAsB,EAAE,EAAE;QAChF,OAAO,EAAE,IAAI;QACb,IAAI,EAAE,YAAY;KACnB,CAAC,CAAC,IAAI,EAAE,CAAC;IAEZ,OAAO,KAAK,CAAC;AACf,CAAC","sourcesContent":["import { readJson } from '@ms-cloudpack/json-utilities';\nimport type { UserPreferences } from '@ms-cloudpack/common-types';\nimport { getUserPreferencesPath } from './getUserPreferencesPath.js';\n\n/**\n * Reads the user preferences file asynchronously.\n */\nexport async function readUserPreferences(): Promise<UserPreferences> {\n  const { $schema, ...prefs } =\n    (await readJson<UserPreferences & { $schema?: string }>(getUserPreferencesPath(), {\n      verbose: true,\n      mode: 'permissive',\n    })) || {};\n\n  return prefs;\n}\n"]}

package/lib/schemaUrls.d.ts

@@ -2,4 +2,6 @@
 export declare const generatedAppConfigSchemaUrl = "https://unpkg.com/@ms-cloudpack/common-types/schema/GeneratedConfig.json";
 /** unpkg URL for the AppConfig JSON schema */
 export declare const appConfigSchemaUrl = "https://unpkg.com/@ms-cloudpack/common-types/schema/AppConfig.json";
+/** unpkg URL for the UserPreferences JSON schema */
+export declare const userPreferencesSchemaUrl = "https://unpkg.com/@ms-cloudpack/common-types/schema/UserPreferences.json";
 //# sourceMappingURL=schemaUrls.d.ts.map

package/lib/schemaUrls.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schemaUrls.d.ts","sourceRoot":"","sources":["../src/schemaUrls.ts"],"names":[],"mappings":"AAEA,oDAAoD;AACpD,eAAO,MAAM,2BAA2B,6EAAyC,CAAC;AAElF,8CAA8C;AAC9C,eAAO,MAAM,kBAAkB,uEAAmC,CAAC"}
+{"version":3,"file":"schemaUrls.d.ts","sourceRoot":"","sources":["../src/schemaUrls.ts"],"names":[],"mappings":"AAEA,oDAAoD;AACpD,eAAO,MAAM,2BAA2B,6EAAyC,CAAC;AAElF,8CAA8C;AAC9C,eAAO,MAAM,kBAAkB,uEAAmC,CAAC;AAEnE,oDAAoD;AACpD,eAAO,MAAM,wBAAwB,6EAAyC,CAAC"}

package/lib/schemaUrls.js

@@ -3,4 +3,6 @@ const schemaPrefix = 'https://unpkg.com/@ms-cloudpack/common-types/schema';
 export const generatedAppConfigSchemaUrl = `${schemaPrefix}/GeneratedConfig.json`;
 /** unpkg URL for the AppConfig JSON schema */
 export const appConfigSchemaUrl = `${schemaPrefix}/AppConfig.json`;
+/** unpkg URL for the UserPreferences JSON schema */
+export const userPreferencesSchemaUrl = `${schemaPrefix}/UserPreferences.json`;
 //# sourceMappingURL=schemaUrls.js.map

package/lib/schemaUrls.js.map

@@ -1 +1 @@
-{"version":3,"file":"schemaUrls.js","sourceRoot":"","sources":["../src/schemaUrls.ts"],"names":[],"mappings":"AAAA,MAAM,YAAY,GAAG,qDAAqD,CAAC;AAE3E,oDAAoD;AACpD,MAAM,CAAC,MAAM,2BAA2B,GAAG,GAAG,YAAY,uBAAuB,CAAC;AAElF,8CAA8C;AAC9C,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAG,YAAY,iBAAiB,CAAC","sourcesContent":["const schemaPrefix = 'https://unpkg.com/@ms-cloudpack/common-types/schema';\n\n/** unpkg URL for the GeneratedConfig JSON schema */\nexport const generatedAppConfigSchemaUrl = `${schemaPrefix}/GeneratedConfig.json`;\n\n/** unpkg URL for the AppConfig JSON schema */\nexport const appConfigSchemaUrl = `${schemaPrefix}/AppConfig.json`;\n"]}
+{"version":3,"file":"schemaUrls.js","sourceRoot":"","sources":["../src/schemaUrls.ts"],"names":[],"mappings":"AAAA,MAAM,YAAY,GAAG,qDAAqD,CAAC;AAE3E,oDAAoD;AACpD,MAAM,CAAC,MAAM,2BAA2B,GAAG,GAAG,YAAY,uBAAuB,CAAC;AAElF,8CAA8C;AAC9C,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAG,YAAY,iBAAiB,CAAC;AAEnE,oDAAoD;AACpD,MAAM,CAAC,MAAM,wBAAwB,GAAG,GAAG,YAAY,uBAAuB,CAAC","sourcesContent":["const schemaPrefix = 'https://unpkg.com/@ms-cloudpack/common-types/schema';\n\n/** unpkg URL for the GeneratedConfig JSON schema */\nexport const generatedAppConfigSchemaUrl = `${schemaPrefix}/GeneratedConfig.json`;\n\n/** unpkg URL for the AppConfig JSON schema */\nexport const appConfigSchemaUrl = `${schemaPrefix}/AppConfig.json`;\n\n/** unpkg URL for the UserPreferences JSON schema */\nexport const userPreferencesSchemaUrl = `${schemaPrefix}/UserPreferences.json`;\n"]}

package/lib/updateUserPreference.d.ts

@@ -0,0 +1,15 @@
+import type { UserPreferences } from '@ms-cloudpack/common-types';
+/**
+ * Validate and write an update to a user preference item.
+ * Creates the file if it doesn't already exist.
+ *
+ * Throws an error if the key is not a valid user preference name.
+ */
+export declare function updateUserPreference(params: {
+    key: keyof UserPreferences;
+    /** Update `key` to `newValue` */
+    newValue?: string;
+    /** Delete `key` */
+    deleteValue?: boolean;
+}): Promise<void>;
+//# sourceMappingURL=updateUserPreference.d.ts.map

package/lib/updateUserPreference.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"updateUserPreference.d.ts","sourceRoot":"","sources":["../src/updateUserPreference.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAQlE;;;;;GAKG;AACH,wBAAsB,oBAAoB,CAAC,MAAM,EAAE;IACjD,GAAG,EAAE,MAAM,eAAe,CAAC;IAC3B,iCAAiC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,mBAAmB;IACnB,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,iBAiCA"}

package/lib/updateUserPreference.js

@@ -0,0 +1,66 @@
+import { writeJson } from '@ms-cloudpack/json-utilities';
+import { _getMockUserPreferencesDir, getUserPreferencesPath } from './getUserPreferencesPath.js';
+import { allUserPreferences } from './constants.js';
+import { readUserPreferences } from './readUserPreferences.js';
+import path from 'path';
+import { isFolderSync } from '@ms-cloudpack/path-utilities';
+import { userPreferencesSchemaUrl } from './schemaUrls.js';
+/**
+ * Validate and write an update to a user preference item.
+ * Creates the file if it doesn't already exist.
+ *
+ * Throws an error if the key is not a valid user preference name.
+ */
+export async function updateUserPreference(params) {
+    const { key, deleteValue } = params;
+    if (process.env.JEST_WORKER_ID && !_getMockUserPreferencesDir()) {
+        // Prevent tests from accidentally messing with real global state...
+        throw new Error('Tests must call setMockUserPreferencesDir before calling updateUserPreference.');
+    }
+    // The key is user input which could potentially be invalid, despite the types.
+    if (!allUserPreferences[key]) {
+        throw new Error(`"${key}" is not a valid user preference name.`);
+    }
+    let value = params.newValue?.trim();
+    if (!deleteValue) {
+        if (value === undefined) {
+            throw new Error('Must specify newValue or deleteValue (this is a bug in Cloudpack)');
+        }
+        value = validateValue(key, value);
+    }
+    const newPreferences = {
+        ...(await readUserPreferences()),
+        $schema: userPreferencesSchemaUrl,
+    };
+    if (deleteValue) {
+        delete newPreferences[key];
+    }
+    else {
+        newPreferences[key] = value;
+    }
+    return writeJson(getUserPreferencesPath(), newPreferences, { update: true, mode: 'permissive' });
+}
+function validateValue(key, value) {
+    switch (key) {
+        case 'cachePath': {
+            if (!value) {
+                throw new Error('The cache folder cannot be empty.');
+            }
+            if (!path.isAbsolute(value)) {
+                throw new Error('The cache folder must be an absolute path.');
+            }
+            const parentFolder = path.dirname(value);
+            if (!isFolderSync(parentFolder)) {
+                throw new Error(`The parent folder "${parentFolder}" of the cache folder does not exist.`);
+            }
+            // The folder is valid
+            return value;
+        }
+        default: {
+            // this gives a type error if a new preference is added
+            const exhaustiveCheck = key;
+            throw new Error(`Unhandled user preference: "${exhaustiveCheck}"`);
+        }
+    }
+}
+//# sourceMappingURL=updateUserPreference.js.map

package/lib/updateUserPreference.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"updateUserPreference.js","sourceRoot":"","sources":["../src/updateUserPreference.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAEzD,OAAO,EAAE,0BAA0B,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACjG,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAC;AAE3D;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,MAM1C;IACC,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;IAEpC,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,IAAI,CAAC,0BAA0B,EAAE,EAAE,CAAC;QAChE,oEAAoE;QACpE,MAAM,IAAI,KAAK,CAAC,gFAAgF,CAAC,CAAC;IACpG,CAAC;IAED,+EAA+E;IAC/E,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CAAC,IAAI,GAAG,wCAAwC,CAAC,CAAC;IACnE,CAAC;IAED,IAAI,KAAK,GAAG,MAAM,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC;IAEpC,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;QACvF,CAAC;QACD,KAAK,GAAG,aAAa,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACpC,CAAC;IAED,MAAM,cAAc,GAAG;QACrB,GAAG,CAAC,MAAM,mBAAmB,EAAE,CAAC;QAChC,OAAO,EAAE,wBAAwB;KAClC,CAAC;IACF,IAAI,WAAW,EAAE,CAAC;QAChB,OAAO,cAAc,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;SAAM,CAAC;QACN,cAAc,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IAC9B,CAAC;IAED,OAAO,SAAS,CAAC,sBAAsB,EAAE,EAAE,cAAc,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC,CAAC;AACnG,CAAC;AAED,SAAS,aAAa,CAAC,GAA0B,EAAE,KAAa;IAC9D,QAAQ,GAAG,EAAE,CAAC;QACZ,KAAK,WAAW,CAAC,CAAC,CAAC;YACjB,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;YACvD,CAAC;YAED,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC5B,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;YAChE,CAAC;YAED,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACzC,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,CAAC;gBAChC,MAAM,IAAI,KAAK,CAAC,sBAAsB,YAAY,uCAAuC,CAAC,CAAC;YAC7F,CAAC;YAED,sBAAsB;YACtB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,CAAC,CAAC,CAAC;YACR,uDAAuD;YACvD,MAAM,eAAe,GAAU,GAAG,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,+BAA+B,eAAe,GAAG,CAAC,CAAC;QACrE,CAAC;IACH,CAAC;AACH,CAAC","sourcesContent":["import { writeJson } from '@ms-cloudpack/json-utilities';\nimport type { UserPreferences } from '@ms-cloudpack/common-types';\nimport { _getMockUserPreferencesDir, getUserPreferencesPath } from './getUserPreferencesPath.js';\nimport { allUserPreferences } from './constants.js';\nimport { readUserPreferences } from './readUserPreferences.js';\nimport path from 'path';\nimport { isFolderSync } from '@ms-cloudpack/path-utilities';\nimport { userPreferencesSchemaUrl } from './schemaUrls.js';\n\n/**\n * Validate and write an update to a user preference item.\n * Creates the file if it doesn't already exist.\n *\n * Throws an error if the key is not a valid user preference name.\n */\nexport async function updateUserPreference(params: {\n  key: keyof UserPreferences;\n  /** Update `key` to `newValue` */\n  newValue?: string;\n  /** Delete `key` */\n  deleteValue?: boolean;\n}) {\n  const { key, deleteValue } = params;\n\n  if (process.env.JEST_WORKER_ID && !_getMockUserPreferencesDir()) {\n    // Prevent tests from accidentally messing with real global state...\n    throw new Error('Tests must call setMockUserPreferencesDir before calling updateUserPreference.');\n  }\n\n  // The key is user input which could potentially be invalid, despite the types.\n  if (!allUserPreferences[key]) {\n    throw new Error(`\"${key}\" is not a valid user preference name.`);\n  }\n\n  let value = params.newValue?.trim();\n\n  if (!deleteValue) {\n    if (value === undefined) {\n      throw new Error('Must specify newValue or deleteValue (this is a bug in Cloudpack)');\n    }\n    value = validateValue(key, value);\n  }\n\n  const newPreferences = {\n    ...(await readUserPreferences()),\n    $schema: userPreferencesSchemaUrl,\n  };\n  if (deleteValue) {\n    delete newPreferences[key];\n  } else {\n    newPreferences[key] = value;\n  }\n\n  return writeJson(getUserPreferencesPath(), newPreferences, { update: true, mode: 'permissive' });\n}\n\nfunction validateValue(key: keyof UserPreferences, value: string) {\n  switch (key) {\n    case 'cachePath': {\n      if (!value) {\n        throw new Error('The cache folder cannot be empty.');\n      }\n\n      if (!path.isAbsolute(value)) {\n        throw new Error('The cache folder must be an absolute path.');\n      }\n\n      const parentFolder = path.dirname(value);\n      if (!isFolderSync(parentFolder)) {\n        throw new Error(`The parent folder \"${parentFolder}\" of the cache folder does not exist.`);\n      }\n\n      // The folder is valid\n      return value;\n    }\n\n    default: {\n      // this gives a type error if a new preference is added\n      const exhaustiveCheck: never = key;\n      throw new Error(`Unhandled user preference: \"${exhaustiveCheck}\"`);\n    }\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ms-cloudpack/config",
-  "version": "0.27.1",
+  "version": "0.27.2",
   "description": "Configuration handling for cloudpack.",
   "license": "MIT",
   "type": "module",
@@ -14,10 +14,10 @@
     }
   },
   "dependencies": {
-    "@ms-cloudpack/common-types": "^0.19.0",
+    "@ms-cloudpack/common-types": "^0.19.1",
     "@ms-cloudpack/json-utilities": "^0.1.7",
-    "@ms-cloudpack/package-utilities": "^10.0.0",
-    "@ms-cloudpack/path-utilities": "^2.7.37",
+    "@ms-cloudpack/package-utilities": "^10.0.1",
+    "@ms-cloudpack/path-utilities": "^2.7.38",
     "import-meta-resolve": "^4.0.0",
     "semver": "^7.6.0"
   },