@salesforce/core 3.24.5 → 3.25.0

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [3.25.0](https://github.com/forcedotcom/sfdx-core/compare/v3.24.5...v3.25.0) (2022-07-29)
+
+### Features
+
+- orgAccessor.get has throwOnNotFound option ([a2ee821](https://github.com/forcedotcom/sfdx-core/commit/a2ee8219adf692de7de17ba254e05f501ef5814c))
+
 ### [3.24.5](https://github.com/forcedotcom/sfdx-core/compare/v3.24.4...v3.24.5) (2022-07-28)
 
 ### Bug Fixes

package/lib/org/authRemover.js

@@ -14,7 +14,6 @@ const messages_1 = require("../messages");
 const stateAggregator_1 = require("../stateAggregator");
 const orgConfigProperties_1 = require("./orgConfigProperties");
 messages_1.Messages.importMessagesDirectory(__dirname);
-const coreMessages = messages_1.Messages.load('@salesforce/core', 'core', ['namedOrgNotFound']);
 const messages = messages_1.Messages.load('@salesforce/core', 'auth', ['targetOrgNotSet']);
 /**
  * Handles  the removing of authorizations, which includes deleting the auth file
@@ -72,12 +71,8 @@ class AuthRemover extends kit_1.AsyncOptionalCreatable {
      * @returns {Promise<SfOrg>}
      */
     async findAuth(usernameOrAlias) {
-        const username = await this.resolveUsername(usernameOrAlias || this.getTargetOrg());
-        const auth = this.stateAggregator.orgs.get(username);
-        if (!auth) {
-            throw coreMessages.createError('namedOrgNotFound');
-        }
-        return auth;
+        const username = await this.resolveUsername(usernameOrAlias ?? this.getTargetOrg());
+        return this.stateAggregator.orgs.get(username, false, true);
     }
     /**
      * Finds all org authorizations in the global info file (.sf/sf.json)

package/lib/stateAggregator/accessors/orgAccessor.d.ts

@@ -26,7 +26,7 @@ export declare abstract class BaseOrgAccessor<T extends ConfigFile, P extends Co
     private contents;
     private logger;
     /**
-     * Read the auth file for the given useranme. Once the file has been read, it can be reaccessed with the `get` method.
+     * Read the auth file for the given username. Once the file has been read, it can be re-accessed with the `get` method.
      *
      * @param username username to read
      * @param decrypt if true, decrypt encrypted values
@@ -39,13 +39,7 @@ export declare abstract class BaseOrgAccessor<T extends ConfigFile, P extends Co
      * @param decrypt if true, decrypt encrypted values
      */
     readAll(decrypt?: boolean): Promise<P[]>;
-    /**
-     * Return the contents of the username's auth file from cache. The `read` or `readAll` methods must be called first in order to populate the cache.
-     *
-     * @param username username to get
-     * @param decrypt if true, decrypt encrypted values
-     */
-    get(username: string, decrypt?: boolean): Nullable<P>;
+    get(username: string, decrypt?: boolean, throwOnNotFound?: true): P;
     /**
      * Return the contents of all the auth files from cache. The `read` or `readAll` methods must be called first in order to populate the cache.
      *

package/lib/stateAggregator/accessors/orgAccessor.js

@@ -14,6 +14,7 @@ const authInfoConfig_1 = require("../../config/authInfoConfig");
 const global_1 = require("../../global");
 const types_1 = require("../types");
 const logger_1 = require("../../logger");
+const messages_1 = require("../../messages");
 /**
  * @deprecated
  */
@@ -62,7 +63,7 @@ class BaseOrgAccessor extends kit_1.AsyncOptionalCreatable {
         this.contents = new Map();
     }
     /**
-     * Read the auth file for the given useranme. Once the file has been read, it can be reaccessed with the `get` method.
+     * Read the auth file for the given username. Once the file has been read, it can be re-accessed with the `get` method.
      *
      * @param username username to read
      * @param decrypt if true, decrypt encrypted values
@@ -96,13 +97,21 @@ class BaseOrgAccessor extends kit_1.AsyncOptionalCreatable {
         return this.getAll(decrypt);
     }
     /**
-     * Return the contents of the username's auth file from cache. The `read` or `readAll` methods must be called first in order to populate the cache.
+     * Return the contents of the username's auth file from cache.
+     * The `read` or `readAll` methods must be called first in order to populate the cache.
+     * If throwOnNotFound is not true, an empty object {} is returned if the org is not found.
      *
      * @param username username to get
      * @param decrypt if true, decrypt encrypted values
+     * @param throwOnNotFound if true, throw if the auth file does not already exist in the cache
      */
-    get(username, decrypt = false) {
+    get(username, decrypt = false, throwOnNotFound = false) {
         const config = this.configs.get(username);
+        if (throwOnNotFound && config?.keys().length === 0) {
+            messages_1.Messages.importMessagesDirectory(__dirname);
+            const messages = messages_1.Messages.load('@salesforce/core', 'core', ['namedOrgNotFound']);
+            throw messages.createError('namedOrgNotFound', [username]);
+        }
         if (config) {
             this.contents.set(username, config.getContents(decrypt));
         }
@@ -115,10 +124,7 @@ class BaseOrgAccessor extends kit_1.AsyncOptionalCreatable {
      * @returns
      */
     getAll(decrypt = false) {
-        return [...this.configs.keys()].reduce((orgs, username) => {
-            const org = this.get(username, decrypt);
-            return org && !(0, kit_1.isEmpty)(org) ? orgs.concat([org]) : orgs;
-        }, []);
+        return [...this.configs.keys()].map((username) => this.get(username, decrypt)).filter((org) => !(0, kit_1.isEmpty)(org));
     }
     /**
      * Returns true if the username has been cached.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "3.24.5",
+  "version": "3.25.0",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",