@flxbl-io/sfp
Version:
sfp is a CLI tool to help you manage your Salesforce projects in an artifact centric model
69 lines • 5.36 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.orgApiVersionFlag = exports.maxDeprecatedUrl = exports.maxDeprecated = exports.minValidApiVersion = void 0;
/*
* 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
*/
const core_1 = require("@oclif/core");
const core_2 = require("@salesforce/core");
core_2.Messages.importMessagesDirectory(__dirname);
const messages = core_2.Messages.loadMessages('@flxbl-io/sfp', 'core-messages');
// versions below this are retired
exports.minValidApiVersion = 21;
// this and all un-retired versions below it are deprecated
exports.maxDeprecated = 30;
exports.maxDeprecatedUrl = 'https://help.salesforce.com/s/articleView?id=000354473&type=1;';
/**const messages = Messages.loadMessages('@flxbl-io/sfp', 'core-messages');
* apiVersion for a salesforce org's rest api.
* Will validate format and that the api version is still supported.
* Will default to the version specified in Config, if it exists (and will provide an override warning)
*
* CAVEAT: unlike the apiversion flag on sfdxCommand, this does not set the version on the org/connection
* We leave this up to the plugins to implement
*
* @example
*
* ```
* import { Flags } from '@salesforce/sf-plugins-core';
* public static flags = {
* 'api-version': Flags.orgApiVersion({
* char: 'a',
* description: 'api version for the org'
* }),
* }
* ```
*/
exports.orgApiVersionFlag = core_1.Flags.custom({
aliases: ['apiversion'],
parse: async (input) => validate(input),
default: async () => getDefaultFromConfig(),
description: messages.getMessage('flags.apiVersion.description'),
});
const getDefaultFromConfig = async () => {
// (perf) only import ConfigAggregator if necessary
const { ConfigAggregator } = await import('@salesforce/core');
const config = await ConfigAggregator.create();
const apiVersionFromConfig = config.getInfo(core_2.OrgConfigProperties.ORG_API_VERSION)?.value;
if (apiVersionFromConfig) {
await core_2.Lifecycle.getInstance().emitWarning(messages.getMessage('flags.apiVersion.overrideWarning', [apiVersionFromConfig]));
return validate(apiVersionFromConfig);
}
};
const validate = async (input) => {
// basic format check
if (!(0, core_2.validateApiVersion)(input)) {
throw messages.createError('errors.InvalidApiVersion', [input]);
}
const requestedVersion = parseInt(input, 10);
if (requestedVersion < exports.minValidApiVersion) {
throw messages.createError('errors.RetiredApiVersion', [exports.minValidApiVersion]);
}
if (requestedVersion <= exports.maxDeprecated) {
await core_2.Lifecycle.getInstance().emitWarning(messages.getMessage('flags.apiVersion.warning.deprecated', [exports.maxDeprecated, exports.maxDeprecatedUrl]));
}
return input;
};
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoib3JnQXBpVmVyc2lvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9mbGFncy9vcmdBcGlWZXJzaW9uLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBOzs7OztHQUtHO0FBQ0gsc0NBQW9DO0FBQ3BDLDJDQUFnRztBQUVoRyxlQUFRLENBQUMsdUJBQXVCLENBQUMsU0FBUyxDQUFDLENBQUM7QUFDNUMsTUFBTSxRQUFRLEdBQUcsZUFBUSxDQUFDLFlBQVksQ0FBQyxlQUFlLEVBQUUsZUFBZSxDQUFDLENBQUM7QUFFekUsa0NBQWtDO0FBQ3JCLFFBQUEsa0JBQWtCLEdBQUcsRUFBRSxDQUFDO0FBQ3JDLDJEQUEyRDtBQUM5QyxRQUFBLGFBQWEsR0FBRyxFQUFFLENBQUM7QUFDbkIsUUFBQSxnQkFBZ0IsR0FBRyxnRUFBZ0UsQ0FBQztBQUVqRzs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQW1CRztBQUNVLFFBQUEsaUJBQWlCLEdBQUcsWUFBSyxDQUFDLE1BQU0sQ0FBQztJQUM1QyxPQUFPLEVBQUUsQ0FBQyxZQUFZLENBQUM7SUFDdkIsS0FBSyxFQUFFLEtBQUssRUFBRSxLQUFLLEVBQUUsRUFBRSxDQUFDLFFBQVEsQ0FBQyxLQUFLLENBQUM7SUFDdkMsT0FBTyxFQUFFLEtBQUssSUFBSSxFQUFFLENBQUMsb0JBQW9CLEVBQUU7SUFDM0MsV0FBVyxFQUFFLFFBQVEsQ0FBQyxVQUFVLENBQUMsOEJBQThCLENBQUM7Q0FDakUsQ0FBQyxDQUFDO0FBRUgsTUFBTSxvQkFBb0IsR0FBRyxLQUFLLElBQWlDLEVBQUU7SUFDbkUsbURBQW1EO0lBQ25ELE1BQU0sRUFBRSxnQkFBZ0IsRUFBRSxHQUFHLE1BQU0sTUFBTSxDQUFDLGtCQUFrQixDQUFDLENBQUM7SUFDOUQsTUFBTSxNQUFNLEdBQUcsTUFBTSxnQkFBZ0IsQ0FBQyxNQUFNLEVBQUUsQ0FBQztJQUMvQyxNQUFNLG9CQUFvQixHQUFHLE1BQU0sQ0FBQyxPQUFPLENBQUMsMEJBQW1CLENBQUMsZUFBZSxDQUFDLEVBQUUsS0FBZSxDQUFDO0lBQ2xHLElBQUksb0JBQW9CLEVBQUUsQ0FBQztRQUN6QixNQUFNLGdCQUFTLENBQUMsV0FBVyxFQUFFLENBQUMsV0FBVyxDQUN2QyxRQUFRLENBQUMsVUFBVSxDQUFDLGtDQUFrQyxFQUFFLENBQUMsb0JBQW9CLENBQUMsQ0FBQyxDQUNoRixDQUFDO1FBQ0YsT0FBTyxRQUFRLENBQUMsb0JBQW9CLENBQUMsQ0FBQztJQUN4QyxDQUFDO0FBQ0gsQ0FBQyxDQUFDO0FBRUYsTUFBTSxRQUFRLEdBQUcsS0FBSyxFQUFFLEtBQWEsRUFBbUIsRUFBRTtJQUN4RCxxQkFBcUI7SUFDckIsSUFBSSxDQUFDLElBQUEseUJBQWtCLEVBQUMsS0FBSyxDQUFDLEVBQUUsQ0FBQztRQUMvQixNQUFNLFFBQVEsQ0FBQyxXQUFXLENBQUMsMEJBQTBCLEVBQUUsQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDO0lBQ2xFLENBQUM7SUFDRCxNQUFNLGdCQUFnQixHQUFHLFFBQVEsQ0FBQyxLQUFLLEVBQUUsRUFBRSxDQUFDLENBQUM7SUFDN0MsSUFBSSxnQkFBZ0IsR0FBRywwQkFBa0IsRUFBRSxDQUFDO1FBQzFDLE1BQU0sUUFBUSxDQUFDLFdBQVcsQ0FBQywwQkFBMEIsRUFBRSxDQUFDLDBCQUFrQixDQUFDLENBQUMsQ0FBQztJQUMvRSxDQUFDO0lBQ0QsSUFBSSxnQkFBZ0IsSUFBSSxxQkFBYSxFQUFFLENBQUM7UUFDdEMsTUFBTSxnQkFBUyxDQUFDLFdBQVcsRUFBRSxDQUFDLFdBQVcsQ0FDdkMsUUFBUSxDQUFDLFVBQVUsQ0FBQyxxQ0FBcUMsRUFBRSxDQUFDLHFCQUFhLEVBQUUsd0JBQWdCLENBQUMsQ0FBQyxDQUM5RixDQUFDO0lBQ0osQ0FBQztJQUNELE9BQU8sS0FBSyxDQUFDO0FBQ2YsQ0FBQyxDQUFDIn0=