@salesforce/core 6.2.2 → 6.2.3-qa.1

package/lib/org/org.d.ts

@@ -1,5 +1,5 @@
 import { AsyncOptionalCreatable, Duration } from '@salesforce/kit';
-import { AnyJson, JsonMap, Nullable, Optional } from '@salesforce/ts-types';
+import { AnyJson, JsonMap, Nullable } from '@salesforce/ts-types';
 import { ConfigAggregator } from '../config/configAggregator';
 import { OrgUsersConfig } from '../config/orgUsersConfig';
 import { Connection } from './connection';
@@ -208,7 +208,7 @@ export declare class Org extends AsyncOptionalCreatable<Org.Options> {
     /**
      * Returns the Org object or null if this org is not affiliated with a Dev Hub (according to the local config).
      */
-    getDevHubOrg(): Promise<Optional<Org>>;
+    getDevHubOrg(): Promise<Org | undefined>;
     /**
      * Returns `true` if the org is a Dev Hub.
      *
@@ -284,7 +284,7 @@ export declare class Org extends AsyncOptionalCreatable<Org.Options> {
      * Some organization information is locally cached, such as if the org name or if it is a scratch org.
      * This method populates/updates the filesystem from information retrieved from the org.
      */
-    updateLocalInformation(): Promise<void>;
+    updateLocalInformation(): Promise<Pick<AuthFields, Org.Fields.NAME | Org.Fields.INSTANCE_NAME | Org.Fields.NAMESPACE_PREFIX | Org.Fields.IS_SANDBOX | Org.Fields.IS_SCRATCH | Org.Fields.TRIAL_EXPIRATION_DATE> | undefined>;
     /**
      * Refreshes the auth for this org's instance by calling HTTP GET on the baseUrl of the connection object.
      */
@@ -341,7 +341,7 @@ export declare class Org extends AsyncOptionalCreatable<Org.Options> {
     /**
      * Returns the admin username used to create the org.
      */
-    getUsername(): Optional<string>;
+    getUsername(): string | undefined;
     /**
      * Returns the orgId for this org.
      */
@@ -546,7 +546,7 @@ export declare namespace Org {
          */
         IS_SCRATCH = "isScratch",
         /**
-         * Is the current org a dev hub org. e.g. Organization has IsSandbox == true and TrialExpirationDate == null.
+         * Is the current org a sandbox (not a scratch org on a non-prod instance), but an actual Sandbox org). e.g. Organization has IsSandbox == true and TrialExpirationDate == null.
          */
         IS_SANDBOX = "isSandbox",
         /**

package/lib/org/org.js

@@ -484,12 +484,12 @@ class Org extends kit_1.AsyncOptionalCreatable {
      * using {@link Org.retrieveOrganizationInformation}.
      */
     async determineIfScratch() {
-        let cache = this.getField(Org.Fields.IS_SCRATCH);
-        if (!cache) {
-            await this.updateLocalInformation();
-            cache = this.getField(Org.Fields.IS_SCRATCH);
+        const cache = this.getField(Org.Fields.IS_SCRATCH);
+        if (cache !== undefined) {
+            return cache;
         }
-        return cache;
+        const updated = await this.updateLocalInformation();
+        return updated?.isScratch === true;
     }
     /**
      * Returns `true` if the org is a sandbox.
@@ -499,12 +499,12 @@ class Org extends kit_1.AsyncOptionalCreatable {
      * using {@link Org.retrieveOrganizationInformation}.
      */
     async determineIfSandbox() {
-        let cache = this.getField(Org.Fields.IS_SANDBOX);
-        if (!cache) {
-            await this.updateLocalInformation();
-            cache = this.getField(Org.Fields.IS_SANDBOX);
+        const cache = this.getField(Org.Fields.IS_SANDBOX);
+        if (cache !== undefined) {
+            return cache;
         }
-        return cache;
+        const updated = await this.updateLocalInformation();
+        return updated?.isSandbox === true;
     }
     /**
      * Retrieve a handful of fields from the Organization table in Salesforce. If this does not have the
@@ -522,19 +522,21 @@ class Org extends kit_1.AsyncOptionalCreatable {
     async updateLocalInformation() {
         const username = this.getUsername();
         if (username) {
-            const organization = await this.retrieveOrganizationInformation();
-            const isScratch = organization.IsSandbox && Boolean(organization.TrialExpirationDate);
-            const isSandbox = organization.IsSandbox && !organization.TrialExpirationDate;
-            const stateAggregator = await stateAggregator_1.StateAggregator.getInstance();
-            stateAggregator.orgs.update(username, {
+            const [stateAggregator, organization] = await Promise.all([
+                stateAggregator_1.StateAggregator.getInstance(),
+                this.retrieveOrganizationInformation(),
+            ]);
+            const updateFields = {
                 [Org.Fields.NAME]: organization.Name,
                 [Org.Fields.INSTANCE_NAME]: organization.InstanceName,
                 [Org.Fields.NAMESPACE_PREFIX]: organization.NamespacePrefix,
-                [Org.Fields.IS_SANDBOX]: isSandbox,
-                [Org.Fields.IS_SCRATCH]: isScratch,
+                [Org.Fields.IS_SANDBOX]: organization.IsSandbox && !organization.TrialExpirationDate,
+                [Org.Fields.IS_SCRATCH]: organization.IsSandbox && Boolean(organization.TrialExpirationDate),
                 [Org.Fields.TRIAL_EXPIRATION_DATE]: organization.TrialExpirationDate,
-            });
+            };
+            stateAggregator.orgs.update(username, updateFields);
             await stateAggregator.orgs.write(username);
+            return updateFields;
         }
     }
     /**
@@ -546,8 +548,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
             url: this.getConnection().baseUrl(),
             method: 'GET',
         };
-        const conn = this.getConnection();
-        await conn.request(requestInfo);
+        await this.getConnection().request(requestInfo);
     }
     /**
      * Reads and returns the content of all user auth files for this org as an array.
@@ -557,16 +558,9 @@ class Org extends kit_1.AsyncOptionalCreatable {
         const contents = await config.read();
         const thisUsername = (0, ts_types_1.ensure)(this.getUsername());
         const usernames = (0, ts_types_1.ensureJsonArray)(contents.usernames ?? [thisUsername]);
-        return Promise.all(usernames.map((username) => {
-            if (username === thisUsername) {
-                return authInfo_1.AuthInfo.create({
-                    username: this.getConnection().getUsername(),
-                });
-            }
-            else {
-                return authInfo_1.AuthInfo.create({ username: (0, ts_types_1.ensureString)(username) });
-            }
-        }));
+        return Promise.all(usernames.map((username) => authInfo_1.AuthInfo.create({
+            username: username === thisUsername ? this.getConnection().getUsername() : (0, ts_types_1.ensureString)(username),
+        })));
     }
     /**
      * Adds a username to the user config for this org. For convenience `this` object is returned.
@@ -596,7 +590,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
         // TODO: This is kind of screwy because contents values can be `AnyJson | object`...
         // needs config refactoring to improve
         const usernames = contents.usernames ?? [];
-        if (!(0, ts_types_1.isArray)(usernames)) {
+        if (!Array.isArray(usernames)) {
             throw new sfError_1.SfError('Usernames is not an array', 'UnexpectedDataFormat');
         }
         let shouldUpdate = false;
@@ -698,11 +692,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
      * Returns a map of requested fields.
      */
     getFields(keys) {
-        const json = {};
-        return keys.reduce((map, key) => {
-            map[key] = this.getField(key);
-            return map;
-        }, json);
+        return Object.fromEntries(keys.map((key) => [key, this.getField(key)]));
     }
     /**
      * Returns the JSForce connection for the org.
@@ -1294,7 +1284,7 @@ exports.Org = Org;
          */
         Fields["IS_SCRATCH"] = "isScratch";
         /**
-         * Is the current org a dev hub org. e.g. Organization has IsSandbox == true and TrialExpirationDate == null.
+         * Is the current org a sandbox (not a scratch org on a non-prod instance), but an actual Sandbox org). e.g. Organization has IsSandbox == true and TrialExpirationDate == null.
          */
         Fields["IS_SANDBOX"] = "isSandbox";
         /**

package/lib/org/scratchOrgInfoApi.js

@@ -181,7 +181,11 @@ const authorizeScratchOrg = async (options) => {
         clientId: scratchOrgInfoComplete.ConnectedAppConsumerKey,
         createdOrgInstance: scratchOrgInfoComplete.SignupInstance,
         isDevHub: false,
-        snapshot: scratchOrgInfoComplete.Snapshot,
+        isScratch: true,
+        isSandbox: false,
+        // omit optional fields unless they are present
+        ...(scratchOrgInfoComplete.Namespace ? { namespacePrefix: scratchOrgInfoComplete.Namespace } : {}),
+        ...(scratchOrgInfoComplete.Snapshot ? { snapshot: scratchOrgInfoComplete.Snapshot } : {}),
     });
     return authInfo;
 };

package/package.json

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