@salesforce/core 8.14.1 → 8.15.0

package/lib/org/org.d.ts

@@ -5,6 +5,11 @@ import { OrgUsersConfig } from '../config/orgUsersConfig';
 import { Connection } from './connection';
 import { AuthFields, AuthInfo } from './authInfo';
 import { ScratchOrgCreateOptions, ScratchOrgCreateResult } from './scratchOrgCreate';
+export type XOR<T, U> = (T & {
+    [K in keyof U]?: never;
+}) | (U & {
+    [K in keyof T]?: never;
+});
 export type OrganizationInformation = {
     Name: string;
     InstanceName: string;
@@ -59,6 +64,7 @@ export type SandboxProcessObject = {
     Description?: string;
     ApexClassId?: string;
     EndDate?: string;
+    Features?: string[];
 };
 export type SandboxRequest = {
     SandboxName: string;
@@ -68,6 +74,7 @@ export type SandboxRequest = {
     Description?: string;
     ApexClassId?: string;
     ActivationUserGroupId?: string;
+    Features?: string[];
 };
 export type ResumeSandboxRequest = {
     SandboxName?: string;
@@ -91,6 +98,7 @@ export type SandboxInfo = {
     SourceId?: string;
     ActivationUserGroupId?: string;
     CopyArchivedActivities?: boolean;
+    Features?: string[];
 };
 export type ScratchOrgRequest = Omit<ScratchOrgCreateOptions, 'hubOrg'>;
 export type SandboxFields = {
@@ -102,6 +110,11 @@ export type SandboxFields = {
     sandboxInfoId?: string;
     timestamp?: string;
 };
+export type SandboxInfoQueryFields = XOR<{
+    name: string;
+}, {
+    id: string;
+}>;
 /**
  * Provides a way to manage a locally authenticated Org.
  *
@@ -313,6 +326,7 @@ export declare class Org extends AsyncOptionalCreatable<Org.Options> {
      * @returns org information
      */
     retrieveOrganizationInformation(): Promise<OrganizationInformation>;
+    querySandboxInfo(by: SandboxInfoQueryFields): Promise<SandboxInfo>;
     /**
      * 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.

package/lib/org/org.js

@@ -84,6 +84,26 @@ const sandboxProcessFields = [
     'SourceId',
     'Description',
     'EndDate',
+    'Features',
+];
+const sandboxInfoFields = [
+    'Id',
+    'IsDeleted',
+    'CreatedDate',
+    'CreatedById',
+    'LastModifiedDate',
+    'LastModifiedById',
+    'SandboxName',
+    'LicenseType',
+    'TemplateId',
+    'HistoryDays',
+    'CopyChatter',
+    'AutoActivate',
+    'ApexClassId',
+    'Description',
+    'SourceId',
+    'ActivationUserGroupId',
+    'Features',
 ];
 /**
  * Provides a way to manage a locally authenticated Org.
@@ -597,6 +617,26 @@ class Org extends kit_1.AsyncOptionalCreatable {
     async retrieveOrganizationInformation() {
         return this.getConnection().singleRecordQuery('SELECT Name, InstanceName, IsSandbox, TrialExpirationDate, NamespacePrefix FROM Organization');
     }
+    async querySandboxInfo(by) {
+        if (by.id) {
+            // Validate that the ID is a valid Salesforce ID
+            if (!(0, sfdc_1.validateSalesforceId)(by.id)) {
+                throw new sfError_1.SfError(`Invalid Salesforce ID format: ${by.id}`, 'InvalidSalesforceId');
+            }
+        }
+        const whereClause = by.id ? `Id='${by.id}'` : `SandboxName='${by.name}'`;
+        const soql = `SELECT ${sandboxInfoFields.join(',')} FROM SandboxInfo WHERE ${whereClause} ORDER BY CreatedDate DESC`;
+        const result = (await this.connection.tooling.query(soql)).records.filter((item) => !item.IsDeleted);
+        if (result.length === 0) {
+            throw new sfError_1.SfError(`No record found for ${soql}`, connection_1.SingleRecordQueryErrors.NoRecords);
+        }
+        if (result.length > 1) {
+            const err = new sfError_1.SfError('The query returned more than 1 record', connection_1.SingleRecordQueryErrors.MultipleRecords);
+            err.data = result;
+            throw err;
+        }
+        return result[0];
+    }
     /**
      * 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.

package/package.json

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