@salesforce/sf-plugins-core 1.21.7 → 1.22.0

package/lib/compatibility.d.ts

@@ -36,6 +36,10 @@ export declare const requiredOrgFlagWithDeprecations: import("@oclif/core/lib/in
  * @deprecated
  */
 export declare const requiredHubFlagWithDeprecations: import("@oclif/core/lib/interfaces").OptionFlag<import("@salesforce/core").Org>;
+/**
+ * @deprecated
+ */
+export declare const optionalHubFlagWithDeprecations: import("@oclif/core/lib/interfaces").OptionFlag<import("@salesforce/core").Org | undefined>;
 export type ArrayWithDeprecationOptions = {
     multiple?: true;
     parse?: undefined;

package/lib/compatibility.js

@@ -6,7 +6,7 @@
  * 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.arrayWithDeprecation = exports.requiredHubFlagWithDeprecations = exports.requiredOrgFlagWithDeprecations = exports.optionalOrgFlagWithDeprecations = exports.loglevel = exports.orgApiVersionFlagWithDeprecations = void 0;
+exports.arrayWithDeprecation = exports.optionalHubFlagWithDeprecations = exports.requiredHubFlagWithDeprecations = exports.requiredOrgFlagWithDeprecations = exports.optionalOrgFlagWithDeprecations = exports.loglevel = exports.orgApiVersionFlagWithDeprecations = void 0;
 const core_1 = require("@oclif/core");
 const core_2 = require("@salesforce/core");
 const orgApiVersion_1 = require("./flags/orgApiVersion");
@@ -72,6 +72,14 @@ exports.requiredHubFlagWithDeprecations = (0, orgFlags_1.requiredHubFlag)({
     deprecateAliases: true,
     required: true,
 });
+/**
+ * @deprecated
+ */
+exports.optionalHubFlagWithDeprecations = (0, orgFlags_1.optionalHubFlag)({
+    aliases: ['targetdevhubusername'],
+    deprecateAliases: true,
+    required: false,
+});
 /**
  * @deprecated
  */

package/lib/deployer.d.ts

@@ -75,7 +75,7 @@ export declare namespace Deployer {
      * ```
      */
     type Options<T = AnyJson> = JsonMap & {
-        [key: string]: T;
+        [key: string]: T | undefined;
     };
 }
 //# sourceMappingURL=deployer.d.ts.map

package/lib/exported.d.ts

@@ -29,5 +29,6 @@ export declare const Flags: {
     requiredOrg: import("@oclif/core/lib/interfaces").Definition<import("@salesforce/core").Org, Record<string, unknown>>;
     requiredHub: import("@oclif/core/lib/interfaces").Definition<import("@salesforce/core").Org, Record<string, unknown>>;
     optionalOrg: import("@oclif/core/lib/interfaces").Definition<import("@salesforce/core").Org | undefined, Record<string, unknown>>;
+    optionalHub: import("@oclif/core/lib/interfaces").Definition<import("@salesforce/core").Org | undefined, Record<string, unknown>>;
 };
 //# sourceMappingURL=exported.d.ts.map

package/lib/exported.js

@@ -61,5 +61,6 @@ exports.Flags = {
     requiredOrg: orgFlags_1.requiredOrgFlag,
     requiredHub: orgFlags_1.requiredHubFlag,
     optionalOrg: orgFlags_1.optionalOrgFlag,
+    optionalHub: orgFlags_1.optionalHubFlag,
 };
 //# sourceMappingURL=exported.js.map

package/lib/flags/orgFlags.d.ts

@@ -1,4 +1,10 @@
 import { Org } from '@salesforce/core';
+export declare function maybeGetOrg(input: string): Promise<Org>;
+export declare function maybeGetOrg(input: undefined): Promise<undefined>;
+export declare function maybeGetOrg(input?: string | undefined): Promise<Org | undefined>;
+export declare const maybeGetHub: (input?: string) => Promise<Org | undefined>;
+export declare const getOrgOrThrow: (input?: string) => Promise<Org>;
+export declare const getHubOrThrow: (aliasOrUsername?: string) => Promise<Org>;
 /**
  * An optional org specified by username or alias
  * Will default to the default org if one is not specified.
@@ -66,4 +72,26 @@ export declare const requiredOrgFlag: import("@oclif/core/lib/interfaces").Defin
  * ```
  */
 export declare const requiredHubFlag: import("@oclif/core/lib/interfaces").Definition<Org, Record<string, unknown>>;
+/**
+ * An optional org that, if present, must be a devHub
+ * Will throw if the specified org does not exist
+ * Will default to the default dev hub if one is not specified
+ * Will NOT throw if no default deb hub exists and none is specified
+ *
+ * @example
+ *
+ * ```
+ * import { Flags } from '@salesforce/sf-plugins-core';
+ * public static flags = {
+ *     // setting length or prefix
+ *    'target-org': optionalHubFlag(),
+ *    // adding properties
+ *    'flag2': optionalHubFlag({
+ *        description: 'flag2 description',
+ *        char: 'h'
+ *     }),
+ * }
+ * ```
+ */
+export declare const optionalHubFlag: import("@oclif/core/lib/interfaces").Definition<Org | undefined, Record<string, unknown>>;
 //# sourceMappingURL=orgFlags.d.ts.map

package/lib/flags/orgFlags.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.requiredHubFlag = exports.requiredOrgFlag = exports.optionalOrgFlag = void 0;
+exports.optionalHubFlag = exports.requiredHubFlag = exports.requiredOrgFlag = exports.optionalOrgFlag = exports.getHubOrThrow = exports.getOrgOrThrow = exports.maybeGetHub = exports.maybeGetOrg = void 0;
 /*
  * Copyright (c) 2020, salesforce.com, inc.
  * All rights reserved.
@@ -11,7 +11,7 @@ const core_1 = require("@oclif/core");
 const core_2 = require("@salesforce/core");
 core_2.Messages.importMessagesDirectory(__dirname);
 const messages = core_2.Messages.loadMessages('@salesforce/sf-plugins-core', 'messages');
-const maybeGetOrg = async (input) => {
+async function maybeGetOrg(input) {
     try {
         return await core_2.Org.create({ aliasOrUsername: input });
     }
@@ -23,7 +23,18 @@ const maybeGetOrg = async (input) => {
             throw e;
         }
     }
+}
+exports.maybeGetOrg = maybeGetOrg;
+const maybeGetHub = async (input) => {
+    const org = await maybeGetOrg(input ?? (await getDefaultHub(false)));
+    if (org) {
+        return ensureDevHub(org, input ?? org.getUsername());
+    }
+    else {
+        return undefined;
+    }
 };
+exports.maybeGetHub = maybeGetHub;
 const getOrgOrThrow = async (input) => {
     const org = await maybeGetOrg(input);
     if (!org) {
@@ -31,21 +42,28 @@ const getOrgOrThrow = async (input) => {
     }
     return org;
 };
-const getHubOrThrow = async (aliasOrUsername) => {
-    if (!aliasOrUsername) {
-        // check config for a default
-        const config = await core_2.ConfigAggregator.create();
-        aliasOrUsername = config.getInfo(core_2.OrgConfigProperties.TARGET_DEV_HUB)?.value;
-        if (!aliasOrUsername) {
-            throw messages.createError('errors.NoDefaultDevHub');
-        }
-    }
-    const org = await core_2.Org.create({ aliasOrUsername });
+exports.getOrgOrThrow = getOrgOrThrow;
+const ensureDevHub = async (org, aliasOrUsername) => {
     if (await org.determineIfDevHubOrg()) {
         return org;
     }
-    throw messages.createError('errors.NotADevHub', [aliasOrUsername]);
+    throw messages.createError('errors.NotADevHub', [aliasOrUsername ?? org.getUsername()]);
+};
+async function getDefaultHub(throwIfNotFound) {
+    // check config for a default
+    const config = await core_2.ConfigAggregator.create();
+    const aliasOrUsername = config.getInfo(core_2.OrgConfigProperties.TARGET_DEV_HUB)?.value;
+    if (throwIfNotFound && !aliasOrUsername) {
+        throw messages.createError('errors.NoDefaultDevHub');
+    }
+    return aliasOrUsername;
+}
+const getHubOrThrow = async (aliasOrUsername) => {
+    const resolved = aliasOrUsername ?? (await getDefaultHub(true));
+    const org = await core_2.Org.create({ aliasOrUsername: resolved, isDevHub: true });
+    return ensureDevHub(org, resolved);
 };
+exports.getHubOrThrow = getHubOrThrow;
 /**
  * An optional org specified by username or alias
  * Will default to the default org if one is not specified.
@@ -97,9 +115,9 @@ exports.optionalOrgFlag = core_1.Flags.custom({
 exports.requiredOrgFlag = core_1.Flags.custom({
     char: 'o',
     summary: messages.getMessage('flags.targetOrg.summary'),
-    parse: async (input) => getOrgOrThrow(input),
-    default: async () => getOrgOrThrow(),
-    defaultHelp: async () => (await getOrgOrThrow())?.getUsername(),
+    parse: async (input) => (0, exports.getOrgOrThrow)(input),
+    default: async () => (0, exports.getOrgOrThrow)(),
+    defaultHelp: async () => (await (0, exports.getOrgOrThrow)())?.getUsername(),
     required: true,
 });
 /**
@@ -127,9 +145,38 @@ exports.requiredOrgFlag = core_1.Flags.custom({
 exports.requiredHubFlag = core_1.Flags.custom({
     char: 'v',
     summary: messages.getMessage('flags.targetDevHubOrg.summary'),
-    parse: async (input) => getHubOrThrow(input),
-    default: async () => getHubOrThrow(),
-    defaultHelp: async () => (await getHubOrThrow())?.getUsername(),
+    parse: async (input) => (0, exports.getHubOrThrow)(input),
+    default: async () => (0, exports.getHubOrThrow)(),
+    defaultHelp: async () => (await (0, exports.getHubOrThrow)())?.getUsername(),
     required: true,
 });
+/**
+ * An optional org that, if present, must be a devHub
+ * Will throw if the specified org does not exist
+ * Will default to the default dev hub if one is not specified
+ * Will NOT throw if no default deb hub exists and none is specified
+ *
+ * @example
+ *
+ * ```
+ * import { Flags } from '@salesforce/sf-plugins-core';
+ * public static flags = {
+ *     // setting length or prefix
+ *    'target-org': optionalHubFlag(),
+ *    // adding properties
+ *    'flag2': optionalHubFlag({
+ *        description: 'flag2 description',
+ *        char: 'h'
+ *     }),
+ * }
+ * ```
+ */
+exports.optionalHubFlag = core_1.Flags.custom({
+    char: 'v',
+    summary: messages.getMessage('flags.targetDevHubOrg.summary'),
+    parse: async (input) => (0, exports.maybeGetHub)(input),
+    default: async () => (0, exports.maybeGetHub)(),
+    defaultHelp: async () => (await (0, exports.maybeGetHub)())?.getUsername(),
+    required: false,
+});
 //# sourceMappingURL=orgFlags.js.map

package/lib/util.d.ts

@@ -1,11 +1,5 @@
 import { EnvironmentVariable, OrgConfigProperties, SfdxPropertyKeys } from '@salesforce/core';
-export type HelpSection = {
-    header: string;
-    body: Array<{
-        name: string;
-        description: string;
-    } | undefined>;
-};
+import { HelpSection } from '@oclif/core';
 /**
  * Function to build a help section for command help.
  * Takes a string to be used as section header text and an array of enums

package/lib/util.js

@@ -42,10 +42,11 @@ function toHelpSection(header, ...vars) {
             return Object.entries(v).map(([name, description]) => ({ name, description }));
         }
     })
-        .filter((b) => b);
+        .filter(isHelpSectionBodyEntry);
     return { header, body };
 }
 exports.toHelpSection = toHelpSection;
+const isHelpSectionBodyEntry = (entry) => typeof entry === 'object' && entry !== null && 'name' in entry && 'description' in entry;
 function parseVarArgs(args, argv) {
     const final = {};
     const argVals = Object.values(args);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/sf-plugins-core",
-  "version": "1.21.7",
+  "version": "1.22.0",
   "description": "Utils for writing deploy and retrieve plugins",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",