@salesforce/core 3.31.4 → 3.31.7

package/lib/org/connection.js

@@ -1,396 +1,396 @@
-"use strict";
-/*
- * Copyright (c) 2020, salesforce.com, inc.
- * All rights reserved.
- * Licensed under the BSD 3-Clause license.
- * 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.SingleRecordQueryErrors = exports.Connection = exports.DNS_ERROR_NAME = exports.SFDX_HTTP_HEADERS = void 0;
-/* eslint-disable @typescript-eslint/ban-ts-comment */
-const url_1 = require("url");
-const kit_1 = require("@salesforce/kit");
-const ts_types_1 = require("@salesforce/ts-types");
-const jsforce_1 = require("jsforce");
-const tooling_1 = require("jsforce/lib/api/tooling");
-const myDomainResolver_1 = require("../status/myDomainResolver");
-const configAggregator_1 = require("../config/configAggregator");
-const logger_1 = require("../logger");
-const sfError_1 = require("../sfError");
-const sfdc_1 = require("../util/sfdc");
-const messages_1 = require("../messages");
-const lifecycleEvents_1 = require("../lifecycleEvents");
-const orgConfigProperties_1 = require("./orgConfigProperties");
-messages_1.Messages.importMessagesDirectory(__dirname);
-const messages = messages_1.Messages.load('@salesforce/core', 'connection', [
-    'incorrectAPIVersionError',
-    'domainNotFoundError',
-    'noInstanceUrlError',
-    'noApiVersionsError',
-]);
-const clientId = `sfdx toolbelt:${process.env.SFDX_SET_CLIENT_IDS ?? ''}`;
-exports.SFDX_HTTP_HEADERS = {
-    'content-type': 'application/json',
-    'user-agent': clientId,
-};
-exports.DNS_ERROR_NAME = 'DomainNotFoundError';
-/**
- * Handles connections and requests to Salesforce Orgs.
- *
- * ```
- * // Uses latest API version
- * const connection = await Connection.create({
- *   authInfo: await AuthInfo.create({ username: 'myAdminUsername' })
- * });
- * connection.query('SELECT Name from Account');
- *
- * // Use different API version
- * connection.setApiVersion("42.0");
- * connection.query('SELECT Name from Account');
- * ```
- */
-class Connection extends jsforce_1.Connection {
-    /**
-     * Constructor
-     * **Do not directly construct instances of this class -- use {@link Connection.create} instead.**
-     *
-     * @param options The options for the class instance.
-     * @ignore
-     */
-    constructor(options) {
-        super(options.connectionOptions ?? {});
-        this.options = options;
-        this.username = options.authInfo.getUsername();
-    }
-    /**
-     * Tooling api reference.
-     */
-    get tooling() {
-        return super.tooling;
-    }
-    /**
-     * Creates an instance of a Connection. Performs additional async initializations.
-     *
-     * @param options Constructor options.
-     */
-    static async create(options) {
-        const baseOptions = {
-            version: options.connectionOptions?.version,
-            callOptions: {
-                client: clientId,
-            },
-        };
-        if (!baseOptions.version) {
-            // Set the API version obtained from the config aggregator.
-            const configAggregator = options.configAggregator ?? (await configAggregator_1.ConfigAggregator.create());
-            baseOptions.version = (0, ts_types_1.asString)(configAggregator.getInfo('org-api-version').value);
-        }
-        const providedOptions = options.authInfo.getConnectionOptions();
-        // Get connection options from auth info and create a new jsForce connection
-        options.connectionOptions = Object.assign(baseOptions, providedOptions);
-        const conn = new this(options);
-        await conn.init();
-        try {
-            // No version passed in or in the config, so load one.
-            if (!baseOptions.version) {
-                const cachedVersion = await conn.loadInstanceApiVersion();
-                if (cachedVersion) {
-                    conn.setApiVersion(cachedVersion);
-                }
-            }
-            else {
-                conn.logger.debug(`The org-api-version ${baseOptions.version} was found from ${options.connectionOptions?.version ? 'passed in options' : 'config'}`);
-            }
-        }
-        catch (err) {
-            const e = err;
-            if (e.name === exports.DNS_ERROR_NAME) {
-                throw e;
-            }
-            conn.logger.debug(`Error trying to load the API version: ${e.name} - ${e.message}`);
-        }
-        conn.logger.debug(`Using apiVersion ${conn.getApiVersion()}`);
-        return conn;
-    }
-    /**
-     * Async initializer.
-     */
-    async init() {
-        // eslint-disable-next-line no-underscore-dangle
-        this.logger = this.tooling._logger = await logger_1.Logger.child('connection');
-    }
-    /**
-     * deploy a zipped buffer from the SDRL with REST or SOAP
-     *
-     * @param zipInput data to deploy
-     * @param options JSForce deploy options + a boolean for rest
-     */
-    async deploy(zipInput, options) {
-        const rest = options.rest;
-        // neither API expects this option
-        delete options.rest;
-        if (rest) {
-            this.logger.debug('deploy with REST');
-            await this.refreshAuth();
-            return this.metadata.deployRest(zipInput, options);
-        }
-        else {
-            this.logger.debug('deploy with SOAP');
-            return this.metadata.deploy(zipInput, options);
-        }
-    }
-    /**
-     * Send REST API request with given HTTP request info, with connected session information
-     * and SFDX headers.
-     *
-     * @param request HTTP request object or URL to GET request.
-     * @param options HTTP API request options.
-     */
-    request(request, options) {
-        const httpRequest = (0, ts_types_1.isString)(request) ? { method: 'GET', url: request } : request;
-        httpRequest.headers = Object.assign({}, exports.SFDX_HTTP_HEADERS, httpRequest.headers);
-        this.logger.debug(`request: ${JSON.stringify(httpRequest)}`);
-        return super.request(httpRequest, options);
-    }
-    /**
-     * The Force API base url for the instance.
-     */
-    baseUrl() {
-        // essentially the same as pathJoin(super.instanceUrl, 'services', 'data', `v${super.version}`);
-        // eslint-disable-next-line no-underscore-dangle
-        return super._baseUrl();
-    }
-    /**
-     * Will deploy a recently validated deploy request - directly calling jsforce now that this is supported.
-     * WARNING: will always return a string from jsforce, the type is JsonCollection to support backwards compatibility
-     *
-     * @param options.id = the deploy ID that's been validated already from a previous checkOnly deploy request
-     * @param options.rest = a boolean whether or not to use the REST API
-     * @deprecated use {@link Connection.metadata#deployRecentValidation} instead - the jsforce implementation, instead of this wrapper
-     */
-    async deployRecentValidation(options) {
-        // REST returns an object with an id property, SOAP returns the id as a string directly. That is now handled
-        // in jsforce, so we have to cast a string as unkown as JsonCollection to support backwards compatibility.
-        return (await this.metadata.deployRecentValidation(options));
-    }
-    /**
-     * Retrieves the highest api version that is supported by the target server instance.
-     */
-    async retrieveMaxApiVersion() {
-        await this.isResolvable();
-        const versions = await this.request(`${this.instanceUrl}/services/data`);
-        // if the server doesn't return a list of versions, it's possibly a instanceUrl issue where the local file is out of date.
-        if (!Array.isArray(versions)) {
-            this.logger.debug(`server response for retrieveMaxApiVersion: ${versions}`);
-            throw messages.createError('noApiVersionsError');
-        }
-        this.logger.debug(`response for org versions: ${versions.map((item) => item.version).join(',')}`);
-        const max = (0, ts_types_1.ensure)((0, kit_1.maxBy)(versions, (version) => version.version));
-        return max.version;
-    }
-    /**
-     * Use the latest API version available on `this.instanceUrl`.
-     */
-    async useLatestApiVersion() {
-        try {
-            this.setApiVersion(await this.retrieveMaxApiVersion());
-        }
-        catch (err) {
-            const error = err;
-            if (error.name === exports.DNS_ERROR_NAME) {
-                throw error; // throws on DNS connection errors
-            }
-            // Don't fail if we can't use the latest, just use the default
-            this.logger.warn('Failed to set the latest API version:', error);
-        }
-    }
-    /**
-     * Verify that instance has a reachable DNS entry, otherwise will throw error
-     */
-    async isResolvable() {
-        if (!this.options.connectionOptions?.instanceUrl) {
-            throw messages.createError('noInstanceUrlError');
-        }
-        const resolver = await myDomainResolver_1.MyDomainResolver.create({
-            url: new url_1.URL(this.options.connectionOptions.instanceUrl),
-        });
-        try {
-            await resolver.resolve();
-            return true;
-        }
-        catch (e) {
-            throw messages.createError('domainNotFoundError', [], [], e);
-        }
-    }
-    /**
-     * Get the API version used for all connection requests.
-     */
-    getApiVersion() {
-        return this.version;
-    }
-    /**
-     * Set the API version for all connection requests.
-     *
-     * **Throws** *{@link SfError}{ name: 'IncorrectAPIVersionError' }* Incorrect API version.
-     *
-     * @param version The API version.
-     */
-    setApiVersion(version) {
-        if (!sfdc_1.sfdc.validateApiVersion(version)) {
-            throw messages.createError('incorrectAPIVersionError', [version]);
-        }
-        this.version = version;
-    }
-    /**
-     * Getter for AuthInfo.
-     */
-    getAuthInfo() {
-        return this.options.authInfo;
-    }
-    /**
-     * Getter for the AuthInfo fields.
-     */
-    getAuthInfoFields() {
-        // If the StateAggregator.orgs.remove is called, the AuthFields are no longer accessible.
-        return this.options.authInfo.getFields() || {};
-    }
-    /**
-     * Getter for the auth fields.
-     */
-    getConnectionOptions() {
-        return this.options.authInfo.getConnectionOptions();
-    }
-    /**
-     * Getter for the username of the Salesforce Org.
-     */
-    getUsername() {
-        return this.username;
-    }
-    /**
-     * Returns true if this connection is using access token auth.
-     */
-    isUsingAccessToken() {
-        return this.options.authInfo.isUsingAccessToken();
-    }
-    /**
-     * Normalize a Salesforce url to include a instance information.
-     *
-     * @param url Partial url.
-     */
-    normalizeUrl(url) {
-        // eslint-disable-next-line no-underscore-dangle
-        return this._normalizeUrl(url);
-    }
-    /**
-     * Executes a query and auto-fetches (i.e., "queryMore") all results.  This is especially
-     * useful with large query result sizes, such as over 2000 records.  The default maximum
-     * fetch size is 10,000 records. Modify this via the options argument.
-     *
-     * @param soql The SOQL string.
-     * @param queryOptions The query options. NOTE: the autoFetch option will always be true.
-     */
-    async autoFetchQuery(soql, queryOptions = { tooling: false }) {
-        const config = await configAggregator_1.ConfigAggregator.create();
-        // take the limit from the calling function, then the config, then default 10,000
-        const maxFetch = (config.getInfo(orgConfigProperties_1.OrgConfigProperties.ORG_MAX_QUERY_LIMIT).value || queryOptions.maxFetch) ?? 10000;
-        const { tooling, ...queryOptionsWithoutTooling } = queryOptions;
-        const options = Object.assign(queryOptionsWithoutTooling, {
-            autoFetch: true,
-            maxFetch,
-        });
-        const query = tooling ? await this.tooling.query(soql, options) : await this.query(soql, options);
-        if (query.records.length && query.totalSize > query.records.length) {
-            void lifecycleEvents_1.Lifecycle.getInstance().emitWarning(`The query result is missing ${query.totalSize - query.records.length} records due to a ${maxFetch} record limit. Increase the number of records returned by setting the config value "maxQueryLimit" or the environment variable "SFDX_MAX_QUERY_LIMIT" to ${query.totalSize} or greater than ${maxFetch}.`);
-        }
-        return query;
-    }
-    /**
-     * Executes a query using either standard REST or Tooling API, returning a single record.
-     * Will throw if either zero records are found OR multiple records are found.
-     *
-     * @param soql The SOQL string.
-     * @param options The query options.
-     */
-    async singleRecordQuery(soql, options = {
-        choiceField: 'Name',
-    }) {
-        const result = options.tooling ? await this.tooling.query(soql) : await this.query(soql);
-        if (result.totalSize === 0) {
-            throw new sfError_1.SfError(`No record found for ${soql}`, exports.SingleRecordQueryErrors.NoRecords);
-        }
-        if (result.totalSize > 1) {
-            throw new sfError_1.SfError(options.returnChoicesOnMultiple
-                ? // eslint-disable-next-line @typescript-eslint/no-unsafe-return
-                    `Multiple records found. ${result.records.map((item) => item[options.choiceField]).join(',')}`
-                : 'The query returned more than 1 record', exports.SingleRecordQueryErrors.MultipleRecords);
-        }
-        return result.records[0];
-    }
-    /**
-     * Executes a get request on the baseUrl to force an auth refresh
-     * Useful for the raw methods (request, requestRaw) that use the accessToken directly and don't handle refreshes
-     */
-    async refreshAuth() {
-        this.logger.debug('Refreshing auth for org.');
-        const requestInfo = {
-            url: this.baseUrl(),
-            method: 'GET',
-        };
-        await this.request(requestInfo);
-    }
-    async loadInstanceApiVersion() {
-        const authFileFields = this.options.authInfo.getFields();
-        const lastCheckedDateString = authFileFields.instanceApiVersionLastRetrieved;
-        let version = authFileFields.instanceApiVersion;
-        let lastChecked;
-        try {
-            if (lastCheckedDateString && (0, ts_types_1.isString)(lastCheckedDateString)) {
-                lastChecked = Date.parse(lastCheckedDateString);
-            }
-        }
-        catch (e) {
-            /* Do nothing, it will just request the version again */
-        }
-        // Grab the latest api version from the server and cache it in the auth file
-        const useLatest = async () => {
-            // verifies DNS
-            await this.useLatestApiVersion();
-            version = this.getApiVersion();
-            await this.options.authInfo.save({
-                instanceApiVersion: version,
-                // This will get messed up if the user changes their local time on their machine.
-                // Not a big deal since it will just get updated sooner/later.
-                instanceApiVersionLastRetrieved: new Date().toLocaleString(),
-            });
-        };
-        const ignoreCache = kit_1.env.getBoolean('SFDX_IGNORE_API_VERSION_CACHE', false);
-        if (lastChecked && !ignoreCache) {
-            const now = new Date();
-            const has24HoursPastSinceLastCheck = now.getTime() - lastChecked > kit_1.Duration.hours(24).milliseconds;
-            this.logger.debug(`Last checked on ${lastCheckedDateString} (now is ${now.toLocaleString()}) - ${has24HoursPastSinceLastCheck ? '' : 'not '}getting latest`);
-            if (has24HoursPastSinceLastCheck) {
-                await useLatest();
-            }
-        }
-        else {
-            this.logger.debug(`Using the latest because lastChecked=${lastChecked} and SFDX_IGNORE_API_VERSION_CACHE=${ignoreCache}`);
-            // No version found in the file (we never checked before)
-            // so get the latest.
-            await useLatest();
-        }
-        this.logger.debug(`Loaded latest org-api-version ${version}`);
-        return version;
-    }
-}
-exports.Connection = Connection;
-exports.SingleRecordQueryErrors = {
-    NoRecords: 'SingleRecordQuery_NoRecords',
-    MultipleRecords: 'SingleRecordQuery_MultipleRecords',
-};
-// jsforce does some interesting proxy loading on lib classes.
-// Setting this in the Connection.tooling getter will not work, it
-// must be set on the prototype.
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore
-tooling_1.Tooling.prototype.autoFetchQuery = Connection.prototype.autoFetchQuery; // eslint-disable-line @typescript-eslint/unbound-method
+"use strict";
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * 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.SingleRecordQueryErrors = exports.Connection = exports.DNS_ERROR_NAME = exports.SFDX_HTTP_HEADERS = void 0;
+/* eslint-disable @typescript-eslint/ban-ts-comment */
+const url_1 = require("url");
+const kit_1 = require("@salesforce/kit");
+const ts_types_1 = require("@salesforce/ts-types");
+const jsforce_1 = require("jsforce");
+const tooling_1 = require("jsforce/lib/api/tooling");
+const myDomainResolver_1 = require("../status/myDomainResolver");
+const configAggregator_1 = require("../config/configAggregator");
+const logger_1 = require("../logger");
+const sfError_1 = require("../sfError");
+const sfdc_1 = require("../util/sfdc");
+const messages_1 = require("../messages");
+const lifecycleEvents_1 = require("../lifecycleEvents");
+const orgConfigProperties_1 = require("./orgConfigProperties");
+messages_1.Messages.importMessagesDirectory(__dirname);
+const messages = messages_1.Messages.load('@salesforce/core', 'connection', [
+    'incorrectAPIVersionError',
+    'domainNotFoundError',
+    'noInstanceUrlError',
+    'noApiVersionsError',
+]);
+const clientId = `sfdx toolbelt:${process.env.SFDX_SET_CLIENT_IDS ?? ''}`;
+exports.SFDX_HTTP_HEADERS = {
+    'content-type': 'application/json',
+    'user-agent': clientId,
+};
+exports.DNS_ERROR_NAME = 'DomainNotFoundError';
+/**
+ * Handles connections and requests to Salesforce Orgs.
+ *
+ * ```
+ * // Uses latest API version
+ * const connection = await Connection.create({
+ *   authInfo: await AuthInfo.create({ username: 'myAdminUsername' })
+ * });
+ * connection.query('SELECT Name from Account');
+ *
+ * // Use different API version
+ * connection.setApiVersion("42.0");
+ * connection.query('SELECT Name from Account');
+ * ```
+ */
+class Connection extends jsforce_1.Connection {
+    /**
+     * Constructor
+     * **Do not directly construct instances of this class -- use {@link Connection.create} instead.**
+     *
+     * @param options The options for the class instance.
+     * @ignore
+     */
+    constructor(options) {
+        super(options.connectionOptions ?? {});
+        this.options = options;
+        this.username = options.authInfo.getUsername();
+    }
+    /**
+     * Tooling api reference.
+     */
+    get tooling() {
+        return super.tooling;
+    }
+    /**
+     * Creates an instance of a Connection. Performs additional async initializations.
+     *
+     * @param options Constructor options.
+     */
+    static async create(options) {
+        const baseOptions = {
+            version: options.connectionOptions?.version,
+            callOptions: {
+                client: clientId,
+            },
+        };
+        if (!baseOptions.version) {
+            // Set the API version obtained from the config aggregator.
+            const configAggregator = options.configAggregator ?? (await configAggregator_1.ConfigAggregator.create());
+            baseOptions.version = (0, ts_types_1.asString)(configAggregator.getInfo('org-api-version').value);
+        }
+        const providedOptions = options.authInfo.getConnectionOptions();
+        // Get connection options from auth info and create a new jsForce connection
+        options.connectionOptions = Object.assign(baseOptions, providedOptions);
+        const conn = new this(options);
+        await conn.init();
+        try {
+            // No version passed in or in the config, so load one.
+            if (!baseOptions.version) {
+                const cachedVersion = await conn.loadInstanceApiVersion();
+                if (cachedVersion) {
+                    conn.setApiVersion(cachedVersion);
+                }
+            }
+            else {
+                conn.logger.debug(`The org-api-version ${baseOptions.version} was found from ${options.connectionOptions?.version ? 'passed in options' : 'config'}`);
+            }
+        }
+        catch (err) {
+            const e = err;
+            if (e.name === exports.DNS_ERROR_NAME) {
+                throw e;
+            }
+            conn.logger.debug(`Error trying to load the API version: ${e.name} - ${e.message}`);
+        }
+        conn.logger.debug(`Using apiVersion ${conn.getApiVersion()}`);
+        return conn;
+    }
+    /**
+     * Async initializer.
+     */
+    async init() {
+        // eslint-disable-next-line no-underscore-dangle
+        this.logger = this.tooling._logger = await logger_1.Logger.child('connection');
+    }
+    /**
+     * deploy a zipped buffer from the SDRL with REST or SOAP
+     *
+     * @param zipInput data to deploy
+     * @param options JSForce deploy options + a boolean for rest
+     */
+    async deploy(zipInput, options) {
+        const rest = options.rest;
+        // neither API expects this option
+        delete options.rest;
+        if (rest) {
+            this.logger.debug('deploy with REST');
+            await this.refreshAuth();
+            return this.metadata.deployRest(zipInput, options);
+        }
+        else {
+            this.logger.debug('deploy with SOAP');
+            return this.metadata.deploy(zipInput, options);
+        }
+    }
+    /**
+     * Send REST API request with given HTTP request info, with connected session information
+     * and SFDX headers.
+     *
+     * @param request HTTP request object or URL to GET request.
+     * @param options HTTP API request options.
+     */
+    request(request, options) {
+        const httpRequest = (0, ts_types_1.isString)(request) ? { method: 'GET', url: request } : request;
+        httpRequest.headers = Object.assign({}, exports.SFDX_HTTP_HEADERS, httpRequest.headers);
+        this.logger.debug(`request: ${JSON.stringify(httpRequest)}`);
+        return super.request(httpRequest, options);
+    }
+    /**
+     * The Force API base url for the instance.
+     */
+    baseUrl() {
+        // essentially the same as pathJoin(super.instanceUrl, 'services', 'data', `v${super.version}`);
+        // eslint-disable-next-line no-underscore-dangle
+        return super._baseUrl();
+    }
+    /**
+     * Will deploy a recently validated deploy request - directly calling jsforce now that this is supported.
+     * WARNING: will always return a string from jsforce, the type is JsonCollection to support backwards compatibility
+     *
+     * @param options.id = the deploy ID that's been validated already from a previous checkOnly deploy request
+     * @param options.rest = a boolean whether or not to use the REST API
+     * @deprecated use {@link Connection.metadata#deployRecentValidation} instead - the jsforce implementation, instead of this wrapper
+     */
+    async deployRecentValidation(options) {
+        // REST returns an object with an id property, SOAP returns the id as a string directly. That is now handled
+        // in jsforce, so we have to cast a string as unkown as JsonCollection to support backwards compatibility.
+        return (await this.metadata.deployRecentValidation(options));
+    }
+    /**
+     * Retrieves the highest api version that is supported by the target server instance.
+     */
+    async retrieveMaxApiVersion() {
+        await this.isResolvable();
+        const versions = await this.request(`${this.instanceUrl}/services/data`);
+        // if the server doesn't return a list of versions, it's possibly a instanceUrl issue where the local file is out of date.
+        if (!Array.isArray(versions)) {
+            this.logger.debug(`server response for retrieveMaxApiVersion: ${versions}`);
+            throw messages.createError('noApiVersionsError');
+        }
+        this.logger.debug(`response for org versions: ${versions.map((item) => item.version).join(',')}`);
+        const max = (0, ts_types_1.ensure)((0, kit_1.maxBy)(versions, (version) => version.version));
+        return max.version;
+    }
+    /**
+     * Use the latest API version available on `this.instanceUrl`.
+     */
+    async useLatestApiVersion() {
+        try {
+            this.setApiVersion(await this.retrieveMaxApiVersion());
+        }
+        catch (err) {
+            const error = err;
+            if (error.name === exports.DNS_ERROR_NAME) {
+                throw error; // throws on DNS connection errors
+            }
+            // Don't fail if we can't use the latest, just use the default
+            this.logger.warn('Failed to set the latest API version:', error);
+        }
+    }
+    /**
+     * Verify that instance has a reachable DNS entry, otherwise will throw error
+     */
+    async isResolvable() {
+        if (!this.options.connectionOptions?.instanceUrl) {
+            throw messages.createError('noInstanceUrlError');
+        }
+        const resolver = await myDomainResolver_1.MyDomainResolver.create({
+            url: new url_1.URL(this.options.connectionOptions.instanceUrl),
+        });
+        try {
+            await resolver.resolve();
+            return true;
+        }
+        catch (e) {
+            throw messages.createError('domainNotFoundError', [], [], e);
+        }
+    }
+    /**
+     * Get the API version used for all connection requests.
+     */
+    getApiVersion() {
+        return this.version;
+    }
+    /**
+     * Set the API version for all connection requests.
+     *
+     * **Throws** *{@link SfError}{ name: 'IncorrectAPIVersionError' }* Incorrect API version.
+     *
+     * @param version The API version.
+     */
+    setApiVersion(version) {
+        if (!sfdc_1.sfdc.validateApiVersion(version)) {
+            throw messages.createError('incorrectAPIVersionError', [version]);
+        }
+        this.version = version;
+    }
+    /**
+     * Getter for AuthInfo.
+     */
+    getAuthInfo() {
+        return this.options.authInfo;
+    }
+    /**
+     * Getter for the AuthInfo fields.
+     */
+    getAuthInfoFields() {
+        // If the StateAggregator.orgs.remove is called, the AuthFields are no longer accessible.
+        return this.options.authInfo.getFields() || {};
+    }
+    /**
+     * Getter for the auth fields.
+     */
+    getConnectionOptions() {
+        return this.options.authInfo.getConnectionOptions();
+    }
+    /**
+     * Getter for the username of the Salesforce Org.
+     */
+    getUsername() {
+        return this.username;
+    }
+    /**
+     * Returns true if this connection is using access token auth.
+     */
+    isUsingAccessToken() {
+        return this.options.authInfo.isUsingAccessToken();
+    }
+    /**
+     * Normalize a Salesforce url to include a instance information.
+     *
+     * @param url Partial url.
+     */
+    normalizeUrl(url) {
+        // eslint-disable-next-line no-underscore-dangle
+        return this._normalizeUrl(url);
+    }
+    /**
+     * Executes a query and auto-fetches (i.e., "queryMore") all results.  This is especially
+     * useful with large query result sizes, such as over 2000 records.  The default maximum
+     * fetch size is 10,000 records. Modify this via the options argument.
+     *
+     * @param soql The SOQL string.
+     * @param queryOptions The query options. NOTE: the autoFetch option will always be true.
+     */
+    async autoFetchQuery(soql, queryOptions = { tooling: false }) {
+        const config = await configAggregator_1.ConfigAggregator.create();
+        // take the limit from the calling function, then the config, then default 10,000
+        const maxFetch = (config.getInfo(orgConfigProperties_1.OrgConfigProperties.ORG_MAX_QUERY_LIMIT).value || queryOptions.maxFetch) ?? 10000;
+        const { tooling, ...queryOptionsWithoutTooling } = queryOptions;
+        const options = Object.assign(queryOptionsWithoutTooling, {
+            autoFetch: true,
+            maxFetch,
+        });
+        const query = tooling ? await this.tooling.query(soql, options) : await this.query(soql, options);
+        if (query.records.length && query.totalSize > query.records.length) {
+            void lifecycleEvents_1.Lifecycle.getInstance().emitWarning(`The query result is missing ${query.totalSize - query.records.length} records due to a ${maxFetch} record limit. Increase the number of records returned by setting the config value "maxQueryLimit" or the environment variable "SFDX_MAX_QUERY_LIMIT" to ${query.totalSize} or greater than ${maxFetch}.`);
+        }
+        return query;
+    }
+    /**
+     * Executes a query using either standard REST or Tooling API, returning a single record.
+     * Will throw if either zero records are found OR multiple records are found.
+     *
+     * @param soql The SOQL string.
+     * @param options The query options.
+     */
+    async singleRecordQuery(soql, options = {
+        choiceField: 'Name',
+    }) {
+        const result = options.tooling ? await this.tooling.query(soql) : await this.query(soql);
+        if (result.totalSize === 0) {
+            throw new sfError_1.SfError(`No record found for ${soql}`, exports.SingleRecordQueryErrors.NoRecords);
+        }
+        if (result.totalSize > 1) {
+            throw new sfError_1.SfError(options.returnChoicesOnMultiple
+                ? // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+                    `Multiple records found. ${result.records.map((item) => item[options.choiceField]).join(',')}`
+                : 'The query returned more than 1 record', exports.SingleRecordQueryErrors.MultipleRecords);
+        }
+        return result.records[0];
+    }
+    /**
+     * Executes a get request on the baseUrl to force an auth refresh
+     * Useful for the raw methods (request, requestRaw) that use the accessToken directly and don't handle refreshes
+     */
+    async refreshAuth() {
+        this.logger.debug('Refreshing auth for org.');
+        const requestInfo = {
+            url: this.baseUrl(),
+            method: 'GET',
+        };
+        await this.request(requestInfo);
+    }
+    async loadInstanceApiVersion() {
+        const authFileFields = this.options.authInfo.getFields();
+        const lastCheckedDateString = authFileFields.instanceApiVersionLastRetrieved;
+        let version = authFileFields.instanceApiVersion;
+        let lastChecked;
+        try {
+            if (lastCheckedDateString && (0, ts_types_1.isString)(lastCheckedDateString)) {
+                lastChecked = Date.parse(lastCheckedDateString);
+            }
+        }
+        catch (e) {
+            /* Do nothing, it will just request the version again */
+        }
+        // Grab the latest api version from the server and cache it in the auth file
+        const useLatest = async () => {
+            // verifies DNS
+            await this.useLatestApiVersion();
+            version = this.getApiVersion();
+            await this.options.authInfo.save({
+                instanceApiVersion: version,
+                // This will get messed up if the user changes their local time on their machine.
+                // Not a big deal since it will just get updated sooner/later.
+                instanceApiVersionLastRetrieved: new Date().toLocaleString(),
+            });
+        };
+        const ignoreCache = kit_1.env.getBoolean('SFDX_IGNORE_API_VERSION_CACHE', false);
+        if (lastChecked && !ignoreCache) {
+            const now = new Date();
+            const has24HoursPastSinceLastCheck = now.getTime() - lastChecked > kit_1.Duration.hours(24).milliseconds;
+            this.logger.debug(`Last checked on ${lastCheckedDateString} (now is ${now.toLocaleString()}) - ${has24HoursPastSinceLastCheck ? '' : 'not '}getting latest`);
+            if (has24HoursPastSinceLastCheck) {
+                await useLatest();
+            }
+        }
+        else {
+            this.logger.debug(`Using the latest because lastChecked=${lastChecked} and SFDX_IGNORE_API_VERSION_CACHE=${ignoreCache}`);
+            // No version found in the file (we never checked before)
+            // so get the latest.
+            await useLatest();
+        }
+        this.logger.debug(`Loaded latest org-api-version ${version}`);
+        return version;
+    }
+}
+exports.Connection = Connection;
+exports.SingleRecordQueryErrors = {
+    NoRecords: 'SingleRecordQuery_NoRecords',
+    MultipleRecords: 'SingleRecordQuery_MultipleRecords',
+};
+// jsforce does some interesting proxy loading on lib classes.
+// Setting this in the Connection.tooling getter will not work, it
+// must be set on the prototype.
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
+tooling_1.Tooling.prototype.autoFetchQuery = Connection.prototype.autoFetchQuery; // eslint-disable-line @typescript-eslint/unbound-method
 //# sourceMappingURL=connection.js.map