@salesforce/core 4.0.0 → 4.1.0

package/lib/util/sfdcUrl.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="node" />
 import { URL } from 'url';
+export declare function getLoginAudienceCombos(audienceUrl: string, loginUrl: string): Array<[string, string]>;
 export declare class SfdcUrl extends URL {
     /**
      * Salesforce URLs
@@ -27,7 +28,7 @@ export declare class SfdcUrl extends URL {
     /**
      * Tests whether this url is an internal Salesforce domain
      *
-     * @returns {boolean} true if this is a internal domain
+     * @returns {boolean} true if this is an internal domain
      */
     isInternalUrl(): boolean;
     /**
@@ -43,36 +44,21 @@ export declare class SfdcUrl extends URL {
      * If SFDX_DOMAIN_RETRY environment variable is set (number) it overrides the default timeout duration (240 seconds)
      *
      * @returns {Promise<true | never>} The resolved ip address or never
-     * @throws {@link SfdxError} If can't resolve DNS.
+     * @throws {@link SfError} If can't resolve DNS.
      */
     checkLightningDomain(): Promise<true | never>;
     /**
-     * Method that performs the dns lookup of the host. If the lookup fails the internal polling (1 second), client will try again untill timeout
+     * Method that performs the dns lookup of the host. If the lookup fails the internal polling (1 second), client will try again until timeout
      * If SFDX_DOMAIN_RETRY environment variable is set (number) it overrides the default timeout duration (240 seconds)
      *
      * @returns the resolved ip address.
-     * @throws {@link SfdxError} If can't resolve DNS.
+     * @throws {@link SfError} If can't resolve DNS.
      */
     lookup(): Promise<string>;
-    /**
-     * Tests whether this url is a sandbox url
-     *
-     * @param createdOrgInstance The Salesforce instance the org was created on. e.g. `cs42`
-     * @returns {boolean}
-     */
-    isSandboxUrl(createdOrgInstance?: string): boolean;
     /**
      * Test whether this url represents a lightning domain
      *
      * @returns {boolean} true if this domain is a lightning domain
      */
     isLightningDomain(): boolean;
-    /**
-     * Tests whether this url is a sandbox url
-     * otherwise tries to resolve dns cnames and then look if any is sandbox url
-     *
-     * @param createdOrgInstance The Salesforce instance the org was created on. e.g. `cs42`
-     * @returns {Promise<boolean>} true if this domain resolves to sanbox url
-     */
-    private resolvesToSandbox;
 }

package/lib/util/sfdcUrl.js

@@ -6,13 +6,37 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SfdcUrl = void 0;
+exports.SfdcUrl = exports.getLoginAudienceCombos = void 0;
 const url_1 = require("url");
 const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
 const myDomainResolver_1 = require("../status/myDomainResolver");
 const logger_1 = require("../logger");
 const lifecycleEvents_1 = require("../lifecycleEvents");
+function getLoginAudienceCombos(audienceUrl, loginUrl) {
+    const filtered = [
+        [loginUrl, loginUrl],
+        [SfdcUrl.SANDBOX, SfdcUrl.SANDBOX],
+        [SfdcUrl.PRODUCTION, SfdcUrl.PRODUCTION],
+        [audienceUrl, audienceUrl],
+        [audienceUrl, SfdcUrl.PRODUCTION],
+        [audienceUrl, SfdcUrl.SANDBOX],
+        [loginUrl, audienceUrl],
+        [loginUrl, SfdcUrl.PRODUCTION],
+        [loginUrl, SfdcUrl.SANDBOX],
+        [SfdcUrl.PRODUCTION, audienceUrl],
+        [SfdcUrl.SANDBOX, audienceUrl],
+    ].filter(([login, audience]) => !((login === SfdcUrl.PRODUCTION && audience === SfdcUrl.SANDBOX) ||
+        (login === SfdcUrl.SANDBOX && audience === SfdcUrl.PRODUCTION)));
+    const reduced = filtered.reduce((acc, [login, audience]) => {
+        const l = new url_1.URL(login);
+        const a = new url_1.URL(audience);
+        acc.set(`${l.origin}:${a.origin}`, [login, audience]);
+        return acc;
+    }, new Map());
+    return [...reduced.values()];
+}
+exports.getLoginAudienceCombos = getLoginAudienceCombos;
 class SfdcUrl extends url_1.URL {
     constructor(input, base) {
         super(input.toString(), base);
@@ -45,13 +69,6 @@ class SfdcUrl extends url_1.URL {
             this.logger.debug(`Audience URL overridden by env var SFDX_AUDIENCE_URL=${envVarVal}`);
             return envVarVal;
         }
-        if (this.isInternalUrl()) {
-            // This is for internal developers when just doing authorize
-            return this.origin;
-        }
-        if (await this.resolvesToSandbox(createdOrgInstance)) {
-            return SfdcUrl.SANDBOX;
-        }
         if ((createdOrgInstance && /^gs1/gi.test(createdOrgInstance)) || /(gs1.my.salesforce.com)/gi.test(this.origin)) {
             return 'https://gs1.salesforce.com';
         }
@@ -74,14 +91,12 @@ class SfdcUrl extends url_1.URL {
             'crmforce.mil',
         ];
         const allowlistOfSalesforceHosts = ['developer.salesforce.com', 'trailhead.salesforce.com'];
-        return allowlistOfSalesforceDomainPatterns.some((pattern) => {
-            return this.hostname.endsWith(pattern) || allowlistOfSalesforceHosts.includes(this.hostname);
-        });
+        return allowlistOfSalesforceDomainPatterns.some((pattern) => this.hostname.endsWith(pattern) || allowlistOfSalesforceHosts.includes(this.hostname));
     }
     /**
      * Tests whether this url is an internal Salesforce domain
      *
-     * @returns {boolean} true if this is a internal domain
+     * @returns {boolean} true if this is an internal domain
      */
     isInternalUrl() {
         const INTERNAL_URL_PARTS = [
@@ -110,6 +125,15 @@ class SfdcUrl extends url_1.URL {
         if (this.origin.endsWith('.my.salesforce.mil')) {
             return this.origin.replace('.my.salesforce.mil', '.lightning.crmforce.mil');
         }
+        // enhanced domains
+        // ex: sandbox.my.salesforce.com, scratch.my.salesforce.com, etc
+        if (this.origin.endsWith('.my.salesforce.com')) {
+            return this.origin.replace('.my.salesforce.com', '.lightning.force.com');
+        }
+        // alternative domains
+        if (this.origin.endsWith('.my-salesforce.com')) {
+            return this.origin.replace('.my-salesforce.com', '.my-lightning.com');
+        }
         // all non-mil domains
         return `https://${(0, ts_types_1.ensureArray)(/https?:\/\/([^.]*)/.exec(this.origin))
             .slice(1, 2)
@@ -121,7 +145,7 @@ class SfdcUrl extends url_1.URL {
      * If SFDX_DOMAIN_RETRY environment variable is set (number) it overrides the default timeout duration (240 seconds)
      *
      * @returns {Promise<true | never>} The resolved ip address or never
-     * @throws {@link SfdxError} If can't resolve DNS.
+     * @throws {@link SfError} If can't resolve DNS.
      */
     async checkLightningDomain() {
         const quantity = (0, ts_types_1.ensureNumber)(new kit_1.Env().getNumber('SFDX_DOMAIN_RETRY', 240));
@@ -138,11 +162,11 @@ class SfdcUrl extends url_1.URL {
         return true;
     }
     /**
-     * Method that performs the dns lookup of the host. If the lookup fails the internal polling (1 second), client will try again untill timeout
+     * Method that performs the dns lookup of the host. If the lookup fails the internal polling (1 second), client will try again until timeout
      * If SFDX_DOMAIN_RETRY environment variable is set (number) it overrides the default timeout duration (240 seconds)
      *
      * @returns the resolved ip address.
-     * @throws {@link SfdxError} If can't resolve DNS.
+     * @throws {@link SfError} If can't resolve DNS.
      */
     async lookup() {
         const quantity = (0, ts_types_1.ensureNumber)(new kit_1.Env().getNumber('SFDX_DOMAIN_RETRY', 240));
@@ -154,46 +178,13 @@ class SfdcUrl extends url_1.URL {
         });
         return resolver.resolve();
     }
-    /**
-     * Tests whether this url is a sandbox url
-     *
-     * @param createdOrgInstance The Salesforce instance the org was created on. e.g. `cs42`
-     * @returns {boolean}
-     */
-    isSandboxUrl(createdOrgInstance) {
-        return ((createdOrgInstance && /^cs|s$/gi.test(createdOrgInstance)) ||
-            this.origin.endsWith('sandbox.my.salesforce.mil') ||
-            /sandbox\.my\.salesforce\.com/gi.test(this.origin) || // enhanced domains >= 230
-            /(cs[0-9]+(\.my|)\.salesforce\.com)/gi.test(this.origin) || // my domains on CS instance OR CS instance without my domain
-            /([a-z]{3}[0-9]+s\.sfdc-.+\.salesforce\.com)/gi.test(this.origin) || // falcon sandbox ex: usa2s.sfdc-whatever.salesforce.com
-            /([a-z]{3}[0-9]+s\.sfdc-.+\.force\.com)/gi.test(this.origin) || // falcon sandbox ex: usa2s.sfdc-whatever.force.com
-            this.hostname === 'test.salesforce.com');
-    }
     /**
      * Test whether this url represents a lightning domain
      *
      * @returns {boolean} true if this domain is a lightning domain
      */
     isLightningDomain() {
-        return /\.lightning\.force\.com/.test(this.origin);
-    }
-    /**
-     * Tests whether this url is a sandbox url
-     * otherwise tries to resolve dns cnames and then look if any is sandbox url
-     *
-     * @param createdOrgInstance The Salesforce instance the org was created on. e.g. `cs42`
-     * @returns {Promise<boolean>} true if this domain resolves to sanbox url
-     */
-    async resolvesToSandbox(createdOrgInstance) {
-        if (this.isSandboxUrl(createdOrgInstance)) {
-            return true;
-        }
-        const myDomainResolver = await myDomainResolver_1.MyDomainResolver.create({ url: this });
-        const cnames = await myDomainResolver.getCnames();
-        return cnames.some((cname) => {
-            const url = new SfdcUrl(`https://${cname}`);
-            return url.isSandboxUrl();
-        });
+        return this.origin.includes('.lightning.force.com') || this.origin.includes('.lightning.crmforce.mil');
     }
 }
 exports.SfdcUrl = SfdcUrl;

package/lib/util/structuredWriter.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { Readable } from 'stream';
+export interface StructuredWriter {
+    addToStore(contents: string | Readable | Buffer, path: string): Promise<void>;
+    finalize(): Promise<void>;
+    getDestinationPath(): string | undefined;
+    get buffer(): Buffer;
+}

package/lib/util/structuredWriter.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=structuredWriter.js.map

package/lib/util/zipWriter.d.ts

@@ -1,14 +1,16 @@
 /// <reference types="node" />
-import { pipeline as cbPipeline, Readable, Writable } from 'stream';
-export declare const pipeline: typeof cbPipeline.__promisify__;
-export declare class ZipWriter extends Writable {
-    private rootDestination?;
+/// <reference types="node" />
+import { Readable, Writable } from 'stream';
+import { StructuredWriter } from './structuredWriter';
+export declare class ZipWriter extends Writable implements StructuredWriter {
+    private readonly rootDestination?;
     private zip;
     private buffers;
     constructor(rootDestination?: string | undefined);
-    addToZip(contents: string | Readable | Buffer, path: string): void;
+    get buffer(): Buffer;
+    addToStore(contents: string | Readable | Buffer, path: string): Promise<void>;
     finalize(): Promise<void>;
+    getDestinationPath(): string | undefined;
     private getOutputStream;
     private getInputBuffer;
-    get buffer(): Buffer;
 }

package/lib/util/zipWriter.js

@@ -6,12 +6,12 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ZipWriter = exports.pipeline = void 0;
+exports.ZipWriter = void 0;
 const fs_1 = require("fs");
 const stream_1 = require("stream");
 const util_1 = require("util");
 const archiver_1 = require("archiver");
-exports.pipeline = (0, util_1.promisify)(stream_1.pipeline);
+const pipeline = (0, util_1.promisify)(stream_1.pipeline);
 class ZipWriter extends stream_1.Writable {
     constructor(rootDestination) {
         super({ objectMode: true });
@@ -21,15 +21,22 @@ class ZipWriter extends stream_1.Writable {
         // higher values = diminishing returns on compression and made conversion slower
         this.zip = (0, archiver_1.create)('zip', { zlib: { level: 3 } });
         this.buffers = [];
-        void (0, exports.pipeline)(this.zip, this.getOutputStream());
+        void pipeline(this.zip, this.getOutputStream());
     }
-    addToZip(contents, path) {
+    get buffer() {
+        return Buffer.concat(this.buffers);
+    }
+    async addToStore(contents, path) {
         this.zip.append(contents, { name: path });
+        return Promise.resolve();
     }
     async finalize() {
         await this.zip.finalize();
         await this.getInputBuffer();
     }
+    getDestinationPath() {
+        return this.rootDestination;
+    }
     getOutputStream() {
         if (this.rootDestination) {
             return (0, fs_1.createWriteStream)(this.rootDestination);
@@ -51,18 +58,11 @@ class ZipWriter extends stream_1.Writable {
                 inputStream.on('data', (chunk) => {
                     this.buffers.push(chunk);
                 });
-                inputStream.once('end', () => {
-                    return resolve();
-                });
-                inputStream.once('error', (error) => {
-                    return reject(error);
-                });
+                inputStream.once('end', () => resolve());
+                inputStream.once('error', (error) => reject(error));
             });
         }
     }
-    get buffer() {
-        return Buffer.concat(this.buffers);
-    }
 }
 exports.ZipWriter = ZipWriter;
 //# sourceMappingURL=zipWriter.js.map

package/lib/webOAuthServer.d.ts

@@ -1,7 +1,8 @@
 /// <reference types="node" />
 import * as http from 'http';
+import { JwtOAuth2Config } from 'jsforce';
 import { AsyncCreatable } from '@salesforce/kit';
-import { AuthInfo, OAuth2Config } from './org/authInfo';
+import { AuthInfo } from './org';
 /**
  * Handles the creation of a web server for web based login flows.
  *
@@ -25,6 +26,7 @@ export declare class WebOAuthServer extends AsyncCreatable<WebOAuthServer.Option
     private webServer;
     private oauth2;
     private oauthConfig;
+    private oauthError;
     constructor(options: WebOAuthServer.Options);
     /**
      * Returns the configured oauthLocalPort or the WebOAuthServer.DEFAULT_PORT
@@ -79,12 +81,14 @@ export declare class WebOAuthServer extends AsyncCreatable<WebOAuthServer.Option
 }
 export declare namespace WebOAuthServer {
     interface Options {
-        oauthConfig: OAuth2Config;
+        oauthConfig: JwtOAuth2Config;
     }
     type Request = http.IncomingMessage & {
         query: {
             code: string;
             state: string;
+            error?: string;
+            error_description?: string;
         };
     };
 }
@@ -98,6 +102,7 @@ export declare class WebServer extends AsyncCreatable<WebServer.Options> {
     host: string;
     private logger;
     private sockets;
+    private redirectStatus;
     constructor(options: WebServer.Options);
     /**
      * Starts the http server after checking that the port is open
@@ -110,7 +115,7 @@ export declare class WebServer extends AsyncCreatable<WebServer.Options> {
     /**
      * sends a response error.
      *
-     * @param statusCode he statusCode for the response.
+     * @param status the statusCode for the response.
      * @param message the message for the http body.
      * @param response the response to write the error to.
      */
@@ -118,7 +123,7 @@ export declare class WebServer extends AsyncCreatable<WebServer.Options> {
     /**
      * sends a response redirect.
      *
-     * @param statusCode the statusCode for the response.
+     * @param status the statusCode for the response.
      * @param url the url to redirect to.
      * @param response the response to write the redirect to.
      */
@@ -126,11 +131,20 @@ export declare class WebServer extends AsyncCreatable<WebServer.Options> {
     /**
      * sends a response to the browser reporting an error.
      *
-     * @param error the error
-     * @param response the response to write the redirect to.
+     * @param error the oauth error
+     * @param response the HTTP response.
      */
     reportError(error: Error, response: http.ServerResponse): void;
+    /**
+     * sends a response to the browser reporting the success.
+     *
+     * @param response the HTTP response.
+     */
+    reportSuccess(response: http.ServerResponse): void;
+    handleSuccess(response: http.ServerResponse): Promise<void>;
+    handleError(response: http.ServerResponse): Promise<void>;
     protected init(): Promise<void>;
+    private handleRedirect;
     /**
      * Make sure we can't open a socket on the localhost/host port. It's important because we don't want to send
      * auth tokens to a random strange port listener. We want to make sure we can startup our server first.