@salesforce/core 8.17.0 → 8.18.0

package/lib/org/authInfo.d.ts

@@ -259,6 +259,8 @@ export declare class AuthInfo extends AsyncOptionalCreatable<AuthInfo.Options> {
     getFields(decrypt?: boolean): Readonly<AuthFields>;
     /**
      * Get the org front door (used for web based oauth flows)
+     *
+     * @deprecated Will be removed in the next major version. Use the `Org.getFrontDoorUrl()` method instead.
      */
     getOrgFrontDoorUrl(): string;
     /**

package/lib/org/authInfo.js

@@ -545,6 +545,8 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
     }
     /**
      * Get the org front door (used for web based oauth flows)
+     *
+     * @deprecated Will be removed in the next major version. Use the `Org.getFrontDoorUrl()` method instead.
      */
     getOrgFrontDoorUrl() {
         const authFields = this.getFields(true);

package/lib/org/org.d.ts

@@ -152,6 +152,39 @@ export declare class Org extends AsyncOptionalCreatable<Org.Options> {
      * @ignore
      */
     constructor(options?: Org.Options);
+    /**
+     * Generate a URL to a metadata UI builder/setup section in an org.
+     *
+     * Bot: open in Agentforce Builder
+     * ApexPage: opens page
+     * Flow: open in Flow Builder
+     * FlexiPage: open in Lightning App Builder
+     * CustomObject: open in Object Manager
+     * ApexClass: open in Setup -> Apex Classes UI
+     *
+     * if you pass any other metadata type you'll get a path to Lightning App Builder
+     *
+     * @example
+     * // use SDR resolver:
+     * import { MetadataResolver } from '@salesforce/source-deploy-retrieve';
+     *
+     * const metadataResolver = new MetadataResolver();
+     * const components = metadataResolver.getComponentsFromPath(filePath);
+     * const typeName = components[0]?.type?.name;
+     *
+     * const metadataBuilderUrl = await org.getMetadataUIURL(typeName, filePath);
+     *
+     * @typeName Bot | ApexPage | Flow | FlexiPage | CustomObject | ApexClass
+     * @file Absolute file path to the metadata file
+     */
+    getMetadataUIURL(typeName: string, file: string): Promise<string>;
+    /**
+     * Get a Frontdoor URL
+     *
+     * This uses the UI Bridge API to generate a single-use Frontdoor URL:
+     * https://help.salesforce.com/s/articleView?id=xcloud.frontdoor_singleaccess.htm&type=5
+     */
+    getFrontDoorUrl(redirectUri?: string): Promise<string>;
     /**
      * create a sandbox from a production org
      * 'this' needs to be a production org with sandbox licenses available

package/lib/org/org.js

@@ -29,10 +29,13 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Org = exports.SandboxEvents = exports.OrgTypes = void 0;
 exports.sandboxIsResumable = sandboxIsResumable;
-const node_path_1 = require("node:path");
+const node_path_1 = __importDefault(require("node:path"));
 const fs = __importStar(require("node:fs"));
 const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
@@ -53,7 +56,7 @@ const authInfo_1 = require("./authInfo");
 const scratchOrgCreate_1 = require("./scratchOrgCreate");
 const orgConfigProperties_1 = require("./orgConfigProperties");
 ;
-const messages = new messages_1.Messages('@salesforce/core', 'org', new Map([["notADevHub", "The provided dev hub username %s is not a valid dev hub."], ["noUsernameFound", "No username found."], ["noDevHubFound", "Unable to associate this scratch org with a DevHub."], ["deleteOrgHubError", "The Dev Hub org cannot be deleted."], ["insufficientAccessToDelete", "You do not have the appropriate permissions to delete a scratch org. Please contact your Salesforce admin."], ["scratchOrgNotFound", "Attempting to delete an expired or deleted org"], ["sandboxDeleteFailed", "The sandbox org deletion failed with a result of %s."], ["sandboxNotFound", "We can't find a SandboxProcess for the sandbox %s."], ["sandboxInfoCreateFailed", "The sandbox org creation failed with a result of %s."], ["sandboxInfoRefreshFailed", "The sandbox org refresh failed with a result of %s."], ["missingAuthUsername", "The sandbox %s does not have an authorized username."], ["orgPollingTimeout", "Sandbox status is %s; timed out waiting for completion."], ["NotFoundOnDevHub", "The scratch org does not belong to the dev hub username %s."], ["AuthInfoOrgIdUndefined", "AuthInfo orgId is undefined."], ["sandboxCreateNotComplete", "The sandbox creation has not completed."], ["SandboxProcessNotFoundBySandboxName", "We can't find a SandboxProcess with the SandboxName %s."], ["MultiSandboxProcessNotFoundBySandboxName", "We found more than one SandboxProcess with the SandboxName %s."], ["sandboxNotResumable", "The sandbox %s cannot resume with status of %s."]]));
+const messages = new messages_1.Messages('@salesforce/core', 'org', new Map([["notADevHub", "The provided dev hub username %s is not a valid dev hub."], ["noUsernameFound", "No username found."], ["noDevHubFound", "Unable to associate this scratch org with a DevHub."], ["deleteOrgHubError", "The Dev Hub org cannot be deleted."], ["insufficientAccessToDelete", "You do not have the appropriate permissions to delete a scratch org. Please contact your Salesforce admin."], ["scratchOrgNotFound", "Attempting to delete an expired or deleted org"], ["sandboxDeleteFailed", "The sandbox org deletion failed with a result of %s."], ["sandboxNotFound", "We can't find a SandboxProcess for the sandbox %s."], ["sandboxInfoCreateFailed", "The sandbox org creation failed with a result of %s."], ["sandboxInfoRefreshFailed", "The sandbox org refresh failed with a result of %s."], ["missingAuthUsername", "The sandbox %s does not have an authorized username."], ["orgPollingTimeout", "Sandbox status is %s; timed out waiting for completion."], ["NotFoundOnDevHub", "The scratch org does not belong to the dev hub username %s."], ["AuthInfoOrgIdUndefined", "AuthInfo orgId is undefined."], ["sandboxCreateNotComplete", "The sandbox creation has not completed."], ["SandboxProcessNotFoundBySandboxName", "We can't find a SandboxProcess with the SandboxName %s."], ["MultiSandboxProcessNotFoundBySandboxName", "We found more than one SandboxProcess with the SandboxName %s."], ["sandboxNotResumable", "The sandbox %s cannot resume with status of %s."], ["FrontdoorURLError", "Failed to generate a frontdoor URL."], ["FlowIdNotFound", "ID not found for Flow %s."], ["CustomObjectIdNotFound", "ID not found for custom object %s."], ["ApexClassIdNotFound", "ID not found for Apex class %s."]]));
 var OrgTypes;
 (function (OrgTypes) {
     OrgTypes["Scratch"] = "scratch";
@@ -146,6 +149,111 @@ class Org extends kit_1.AsyncOptionalCreatable {
         super(options);
         this.options = options ?? {};
     }
+    /**
+     * Generate a URL to a metadata UI builder/setup section in an org.
+     *
+     * Bot: open in Agentforce Builder
+     * ApexPage: opens page
+     * Flow: open in Flow Builder
+     * FlexiPage: open in Lightning App Builder
+     * CustomObject: open in Object Manager
+     * ApexClass: open in Setup -> Apex Classes UI
+     *
+     * if you pass any other metadata type you'll get a path to Lightning App Builder
+     *
+     * @example
+     * // use SDR resolver:
+     * import { MetadataResolver } from '@salesforce/source-deploy-retrieve';
+     *
+     * const metadataResolver = new MetadataResolver();
+     * const components = metadataResolver.getComponentsFromPath(filePath);
+     * const typeName = components[0]?.type?.name;
+     *
+     * const metadataBuilderUrl = await org.getMetadataUIURL(typeName, filePath);
+     *
+     * @typeName Bot | ApexPage | Flow | FlexiPage | CustomObject | ApexClass
+     * @file Absolute file path to the metadata file
+     */
+    async getMetadataUIURL(typeName, file) {
+        const botFileNameToId = async (conn, filePath) => (await conn.singleRecordQuery(`SELECT id FROM BotDefinition WHERE DeveloperName='${node_path_1.default.basename(filePath, '.bot-meta.xml')}'`)).Id;
+        /** query flexipage via toolingAPI to get its ID (starts with 0M0) */
+        const flexiPageFilenameToId = async (conn, filePath) => (await conn.singleRecordQuery(`SELECT id FROM flexipage WHERE DeveloperName='${node_path_1.default.basename(filePath, '.flexipage-meta.xml')}'`, { tooling: true })).Id;
+        /** query the rest API to turn a flow's filepath into a FlowId  (starts with 301) */
+        const flowFileNameToId = async (conn, filePath) => {
+            try {
+                const flow = await conn.singleRecordQuery(`SELECT DurableId FROM FlowVersionView WHERE FlowDefinitionView.ApiName = '${node_path_1.default.basename(filePath, '.flow-meta.xml')}' ORDER BY VersionNumber DESC LIMIT 1`);
+                return flow.DurableId;
+            }
+            catch (error) {
+                throw messages.createError('FlowIdNotFound', [filePath]);
+            }
+        };
+        const customObjectFileNameToId = async (conn, filePath) => {
+            try {
+                const customObject = await conn.singleRecordQuery(`SELECT Id FROM CustomObject WHERE DeveloperName = '${node_path_1.default.basename(filePath.replace(/__c/g, ''), '.object-meta.xml')}'`, {
+                    tooling: true,
+                });
+                return customObject.Id;
+            }
+            catch (error) {
+                throw messages.createError('CustomObjectIdNotFound', [filePath]);
+            }
+        };
+        const apexClassFileNameToId = async (conn, filePath) => {
+            try {
+                const apexClass = await conn.singleRecordQuery(`SELECT Id FROM ApexClass WHERE Name = '${node_path_1.default.basename(filePath, '.cls')}'`, {
+                    tooling: true,
+                });
+                return apexClass.Id;
+            }
+            catch (error) {
+                throw messages.createError('ApexClassIdNotFound', [filePath]);
+            }
+        };
+        let redirectUri = '';
+        switch (typeName) {
+            case 'ApexClass':
+                redirectUri = `lightning/setup/ApexClasses/page?address=%2F${await apexClassFileNameToId(this.connection, file)}`;
+                break;
+            case 'CustomObject':
+                redirectUri = `lightning/setup/ObjectManager/${await customObjectFileNameToId(this.connection, file)}/Details/view`;
+                break;
+            case 'Bot':
+                redirectUri = `/AiCopilot/copilotStudio.app#/copilot/builder?copilotId=${await botFileNameToId(this.connection, file)}`;
+                break;
+            case 'ApexPage':
+                redirectUri = `/apex/${node_path_1.default.basename(file).replace('.page-meta.xml', '').replace('.page', '')}`;
+                break;
+            case 'Flow':
+                redirectUri = `/builder_platform_interaction/flowBuilder.app?flowId=${await flowFileNameToId(this.connection, file)}`;
+                break;
+            case 'FlexiPage':
+                redirectUri = `/visualEditor/appBuilder.app?pageId=${await flexiPageFilenameToId(this.connection, file)}`;
+                break;
+            default:
+                redirectUri = '/lightning/setup/FlexiPageList/home';
+                break;
+        }
+        return this.getFrontDoorUrl(redirectUri);
+    }
+    /**
+     * Get a Frontdoor URL
+     *
+     * This uses the UI Bridge API to generate a single-use Frontdoor URL:
+     * https://help.salesforce.com/s/articleView?id=xcloud.frontdoor_singleaccess.htm&type=5
+     */
+    async getFrontDoorUrl(redirectUri) {
+        // the `singleaccess` endpoint returns 403 when using an expired token and jsforce only triggers a token refresh on 401 so we check if it's valid first
+        await this.refreshAuth();
+        const singleAccessUrl = new URL('/services/oauth2/singleaccess', this.connection.instanceUrl);
+        if (redirectUri) {
+            singleAccessUrl.searchParams.append('redirect_uri', redirectUri);
+        }
+        const response = await this.connection.requestGet(singleAccessUrl.toString());
+        if (response.frontdoor_uri)
+            return response.frontdoor_uri;
+        throw new sfError_1.SfError(messages.getMessage('FrontdoorURLError')).setData(response);
+    }
     /**
      * create a sandbox from a production org
      * 'this' needs to be a production org with sandbox licenses available
@@ -925,7 +1033,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
     }
     async getLocalDataDir(orgDataPath) {
         const rootFolder = await config_1.Config.resolveRootFolder(false);
-        return (0, node_path_1.join)(rootFolder, global_1.Global.SFDX_STATE_FOLDER, orgDataPath ? orgDataPath : 'orgs');
+        return node_path_1.default.join(rootFolder, global_1.Global.SFDX_STATE_FOLDER, orgDataPath ? orgDataPath : 'orgs');
     }
     /**
      * Gets the sandboxProcessObject and then polls for it to complete.
@@ -1351,7 +1459,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
     async removeSourceTrackingFiles() {
         try {
             const rootFolder = await config_1.Config.resolveRootFolder(false);
-            await fs.promises.rm((0, node_path_1.join)(rootFolder, global_1.Global.SF_STATE_FOLDER, 'orgs', this.getOrgId()), {
+            await fs.promises.rm(node_path_1.default.join(rootFolder, global_1.Global.SF_STATE_FOLDER, 'orgs', this.getOrgId()), {
                 recursive: true,
                 force: true,
             });

package/messages/org.md

@@ -69,3 +69,19 @@ We found more than one SandboxProcess with the SandboxName %s.
 # sandboxNotResumable
 
 The sandbox %s cannot resume with status of %s.
+
+# FrontdoorURLError
+
+Failed to generate a frontdoor URL.
+
+# FlowIdNotFound
+
+ID not found for Flow %s.
+
+# CustomObjectIdNotFound
+
+ID not found for custom object %s.
+
+# ApexClassIdNotFound
+
+ID not found for Apex class %s.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "8.17.0",
+  "version": "8.18.0",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/index",
   "types": "lib/index.d.ts",
@@ -53,7 +53,7 @@
     "messageTransformer/messageTransformer.ts"
   ],
   "dependencies": {
-    "@jsforce/jsforce-node": "^3.8.2",
+    "@jsforce/jsforce-node": "^3.9.1",
     "@salesforce/kit": "^3.2.2",
     "@salesforce/schemas": "^1.9.0",
     "@salesforce/ts-types": "^2.0.10",