@ms-cloudpack/config 0.27.2 → 0.28.0

package/lib/getCachePath.d.ts

@@ -1,7 +1,13 @@
 /**
- * Gets the path to the cache directory.
+ * Get the cache path from user preferences if set.
+ * Falls back to the default cache path `~/.cloudpack`.
+ *
+ * NOTE: If a session object is available, you should use `session.cachePath` instead.
+ *
+ * @param overridePath If set, this path (probably from a CLI option) will be used instead
+ * of the path from preferences.
  */
-export declare function getCachePath(): string;
+export declare function getCachePath(overridePath?: string): Promise<string>;
 /**
  * Gets the path to the app's local cache directory.
  */

package/lib/getCachePath.d.ts.map

@@ -1 +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"}
+{"version":3,"file":"getCachePath.d.ts","sourceRoot":"","sources":["../src/getCachePath.ts"],"names":[],"mappings":"AAIA;;;;;;;;GAQG;AACH,wBAAsB,YAAY,CAAC,YAAY,CAAC,EAAE,MAAM,mBAEvD;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,UAEhD"}

package/lib/getCachePath.js

@@ -1,10 +1,17 @@
 import os from 'os';
 import path from 'path';
+import { readUserPreferences } from './readUserPreferences.js';
 /**
- * Gets the path to the cache directory.
+ * Get the cache path from user preferences if set.
+ * Falls back to the default cache path `~/.cloudpack`.
+ *
+ * NOTE: If a session object is available, you should use `session.cachePath` instead.
+ *
+ * @param overridePath If set, this path (probably from a CLI option) will be used instead
+ * of the path from preferences.
  */
-export function getCachePath() {
-    return path.join(os.homedir(), '.cloudpack');
+export async function getCachePath(overridePath) {
+    return overridePath || (await readUserPreferences())?.cachePath || path.join(os.homedir(), '.cloudpack');
 }
 /**
  * Gets the path to the app's local cache directory.

package/lib/getCachePath.js.map

@@ -1 +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"]}
+{"version":3,"file":"getCachePath.js","sourceRoot":"","sources":["../src/getCachePath.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAE/D;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,YAAqB;IACtD,OAAO,YAAY,IAAI,CAAC,MAAM,mBAAmB,EAAE,CAAC,EAAE,SAAS,IAAI,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,YAAY,CAAC,CAAC;AAC3G,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';\nimport { readUserPreferences } from './readUserPreferences.js';\n\n/**\n * Get the cache path from user preferences if set.\n * Falls back to the default cache path `~/.cloudpack`.\n *\n * NOTE: If a session object is available, you should use `session.cachePath` instead.\n *\n * @param overridePath If set, this path (probably from a CLI option) will be used instead\n * of the path from preferences.\n */\nexport async function getCachePath(overridePath?: string) {\n  return overridePath || (await readUserPreferences())?.cachePath || 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/package.json

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