@salesforce/sf-plugins-core 5.0.13 → 5.0.14-dev.1

package/lib/deployer.js

@@ -1,58 +0,0 @@
-"use strict";
-/*
- * Copyright (c) 2022, 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
- */
-/* eslint-disable @typescript-eslint/explicit-member-accessibility */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Deployer = exports.Deployable = void 0;
-const node_events_1 = require("node:events");
-const core_1 = require("@oclif/core");
-const ux_1 = require("./ux");
-class Deployable {
-}
-exports.Deployable = Deployable;
-/**
- * Interface for deploying Deployables.
- */
-class Deployer extends node_events_1.EventEmitter {
-    constructor() {
-        super(...arguments);
-        /**
-         * Deployables are individual pieces that can be deployed on their own. For example,
-         * each package in a salesforce project is considered a deployable that can be deployed
-         * on its own.
-         */
-        this.deployables = [];
-        this.prompter = new ux_1.Prompter();
-    }
-    /**
-     * Method for displaying deploy progress to the user
-     */
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars, @typescript-eslint/no-empty-function, class-methods-use-this
-    progress(current, total, message) { }
-    /**
-     * Log messages to the console
-     */
-    // eslint-disable-next-line class-methods-use-this
-    log(msg, ...args) {
-        core_1.ux.log(msg, ...args);
-    }
-    /**
-     * Prompt user for additional information
-     */
-    async prompt(questions, initialAnswers) {
-        const answers = await this.prompter.prompt(questions, initialAnswers);
-        return answers;
-    }
-    /**
-     * Overwrite the deployables property on the class.
-     */
-    selectDeployables(deployables) {
-        this.deployables = Object.assign([], deployables);
-    }
-}
-exports.Deployer = Deployer;
-//# sourceMappingURL=deployer.js.map

package/lib/hooks.d.ts

@@ -1,34 +0,0 @@
-import { Config } from '@oclif/core/lib/interfaces/config';
-import { Hook, Hooks } from '@oclif/core/lib/interfaces/hooks';
-import { Deployer } from './deployer';
-import { EnvList, EnvDisplay, JsonObject, Deploy, Login, Logout } from './types';
-import { Deauthorizer } from './deauthorizer';
-/**
- * Interface that defines the well known Unified CLI command hooks.
- */
-interface SfHooks<T = unknown> extends Hooks {
-    'sf:env:list': EnvList.HookMeta<T & JsonObject>;
-    'sf:env:display': EnvDisplay.HookMeta<T & JsonObject>;
-    'sf:deploy': Deploy.HookMeta<T & Deployer>;
-    'sf:login': Login.HookMeta;
-    'sf:logout': Logout.HookMeta<T & Deauthorizer>;
-}
-type GenericHook<T extends keyof SfHooks, P> = Hook<T, SfHooks<P>>;
-/**
- * Class that provides a static method to run a pre-defined sf hook. See {@link SfHooks}.
- */
-export declare class SfHook {
-    /**
-     * Executes a well known Unified CLI hook. See {@link SfHooks}.
-     */
-    static run<T extends keyof SfHooks>(config: Config, hookName: T, options?: SfHooks[T]['options']): Promise<Hook.Result<SfHooks[T]['return']>>;
-}
-export declare namespace SfHook {
-    type EnvList<T> = GenericHook<'sf:env:list', T>;
-    type EnvDisplay<T> = GenericHook<'sf:env:display', T>;
-    type Deploy<T> = GenericHook<'sf:deploy', T>;
-    type Login = Hook<'sf:login', SfHooks>;
-    type Logout = Hook<'sf:logout', SfHooks>;
-}
-export {};
-//# sourceMappingURL=hooks.d.ts.map

package/lib/hooks.js

@@ -1,30 +0,0 @@
-"use strict";
-/*
- * Copyright (c) 2022, 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.SfHook = void 0;
-const kit_1 = require("@salesforce/kit");
-const core_1 = require("@oclif/core");
-/**
- * Class that provides a static method to run a pre-defined sf hook. See {@link SfHooks}.
- */
-class SfHook {
-    /**
-     * Executes a well known Unified CLI hook. See {@link SfHooks}.
-     */
-    static async run(config, hookName, options = {}) {
-        const timeout = kit_1.Duration.milliseconds(kit_1.env.getNumber('SF_HOOK_TIMEOUT_MS') ?? 5000);
-        const results = await config.runHook(hookName, options, timeout.milliseconds, true);
-        results.failures.forEach((failure) => {
-            core_1.ux.debug(`Failed to run ${hookName} hook for ${failure.plugin.name}`);
-            core_1.ux.debug(failure.error.toString());
-        });
-        return results;
-    }
-}
-exports.SfHook = SfHook;
-//# sourceMappingURL=hooks.js.map

package/lib/types/index.d.ts

@@ -1,128 +0,0 @@
-import { Deauthorizer } from '../deauthorizer';
-import { Deployer } from '../deployer';
-export type JsonObject = {
-    [key: string]: string | string[] | number | number[] | boolean | boolean[] | null | undefined;
-};
-/**
- * By default `sf env display` will display every key/value returned by the hook.
- * It will also Title Case every key for readability. To overwrite this behavior,
- * you can specify how a key should be displayed to the user.
- *
- * @example
- *
- * ```
- * { data: { theURL: 'https://example.com' } }
- * // Renders as:
- * Key     Value
- * ------- -------------------
- * The URL https://example.com
- * ```
- *
- * @example
- *
- * ```
- * {
- *   data: { theURL: 'https://example.com' }
- *   keys: { theURL: 'Url' },
- * }
- * // Renders as:
- * Key Value
- * --- -------------------
- * Url https://example.com
- *```
- * If no environment matches the provided targetEnv, then return null in the data field.
- *
- * @example
- * ```
- * { data: null }
- * ```
- */
-export declare namespace EnvDisplay {
-    type Keys<T> = Record<keyof T, string>;
-    export type HookMeta<T extends JsonObject> = {
-        options: {
-            targetEnv: string;
-        };
-        return: {
-            data: T | null;
-            keys?: Keys<T>;
-        };
-    };
-    export {};
-}
-/**
- * By default `sf env list` will render a table with all the data provided by the hook.
- * The columns of the table are derived from the keys of the provided data. These column
- * headers are Title Cased for readability. To overwrite a column name specify it with
- * the `keys` property.
- *
- * @example
- *
- * ```
- * {
- *   title: 'My Envs',
- *   data: [{ username: 'foo', theURL: 'https://example.com' }]
- * }
- * // Renders as:
- * My Envs
- * ================================
- * | Username | The URL
- * | foo      | https://example.com
- *```
- *
- * @example
- *
- * ```
- * {
- *   data: [{ username: 'foo', theURL: 'https://example.com' }]
- *   keys: { theURL: 'Url', username: 'Name' },
- * }
- *
- * // Renders as:
- * My Envs
- * ============================
- * | Name | Url
- * | foo  | https://example.com
- *
- *```
- */
-export declare namespace EnvList {
-    export enum EnvType {
-        'salesforceOrgs' = "salesforceOrgs",
-        'scratchOrgs' = "scratchOrgs",
-        'computeEnvs' = "computeEnvs"
-    }
-    export type Table<T extends JsonObject> = {
-        type: EnvType | string;
-        data: T[];
-        keys?: Record<keyof T, string>;
-        title: string;
-    };
-    type Options = {
-        all: boolean;
-    };
-    export type HookMeta<T extends JsonObject> = {
-        options: Options;
-        return: Array<Table<T>>;
-    };
-    export {};
-}
-export declare namespace Deploy {
-    type HookMeta<T extends Deployer> = {
-        options: Record<string, unknown>;
-        return: T[];
-    };
-}
-export declare namespace Login {
-    type HookMeta = {
-        options: Record<string, unknown>;
-        return: void;
-    };
-}
-export declare namespace Logout {
-    type HookMeta<T extends Deauthorizer> = {
-        options: Record<string, unknown>;
-        return: T;
-    };
-}
-//# sourceMappingURL=index.d.ts.map

package/lib/types/index.js

@@ -1,55 +0,0 @@
-"use strict";
-/*
- * Copyright (c) 2022, 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.EnvList = void 0;
-/**
- * By default `sf env list` will render a table with all the data provided by the hook.
- * The columns of the table are derived from the keys of the provided data. These column
- * headers are Title Cased for readability. To overwrite a column name specify it with
- * the `keys` property.
- *
- * @example
- *
- * ```
- * {
- *   title: 'My Envs',
- *   data: [{ username: 'foo', theURL: 'https://example.com' }]
- * }
- * // Renders as:
- * My Envs
- * ================================
- * | Username | The URL
- * | foo      | https://example.com
- *```
- *
- * @example
- *
- * ```
- * {
- *   data: [{ username: 'foo', theURL: 'https://example.com' }]
- *   keys: { theURL: 'Url', username: 'Name' },
- * }
- *
- * // Renders as:
- * My Envs
- * ============================
- * | Name | Url
- * | foo  | https://example.com
- *
- *```
- */
-var EnvList;
-(function (EnvList) {
-    let EnvType;
-    (function (EnvType) {
-        EnvType["salesforceOrgs"] = "salesforceOrgs";
-        EnvType["scratchOrgs"] = "scratchOrgs";
-        EnvType["computeEnvs"] = "computeEnvs";
-    })(EnvType = EnvList.EnvType || (EnvList.EnvType = {}));
-})(EnvList = exports.EnvList || (exports.EnvList = {}));
-//# sourceMappingURL=index.js.map

package/lib/ux/index.d.ts

@@ -1,6 +0,0 @@
-export { UxBase } from './base';
-export { Ux } from './ux';
-export { Progress } from './progress';
-export { Prompter, generateTableChoices, Separator } from './prompter';
-export { Spinner } from './spinner';
-//# sourceMappingURL=index.d.ts.map

package/lib/ux/index.js

@@ -1,22 +0,0 @@
-"use strict";
-/*
- * Copyright (c) 2022, 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.Spinner = exports.Separator = exports.generateTableChoices = exports.Prompter = exports.Progress = exports.Ux = exports.UxBase = void 0;
-var base_1 = require("./base");
-Object.defineProperty(exports, "UxBase", { enumerable: true, get: function () { return base_1.UxBase; } });
-var ux_1 = require("./ux");
-Object.defineProperty(exports, "Ux", { enumerable: true, get: function () { return ux_1.Ux; } });
-var progress_1 = require("./progress");
-Object.defineProperty(exports, "Progress", { enumerable: true, get: function () { return progress_1.Progress; } });
-var prompter_1 = require("./prompter");
-Object.defineProperty(exports, "Prompter", { enumerable: true, get: function () { return prompter_1.Prompter; } });
-Object.defineProperty(exports, "generateTableChoices", { enumerable: true, get: function () { return prompter_1.generateTableChoices; } });
-Object.defineProperty(exports, "Separator", { enumerable: true, get: function () { return prompter_1.Separator; } });
-var spinner_1 = require("./spinner");
-Object.defineProperty(exports, "Spinner", { enumerable: true, get: function () { return spinner_1.Spinner; } });
-//# sourceMappingURL=index.js.map

package/lib/ux/prompter.d.ts

@@ -1,40 +0,0 @@
-import { QuestionCollection, Separator, ChoiceBase } from 'inquirer';
-import { Dictionary, Nullable } from '@salesforce/ts-types';
-export declare class Prompter {
-    /**
-     * Prompt user for information. See https://www.npmjs.com/package/inquirer for more.
-     */
-    prompt<T extends Prompter.Answers>(questions: Prompter.Questions<T>, initialAnswers?: Partial<T>): Promise<T>;
-    /**
-     * Prompt user for information with a timeout (in milliseconds). See https://www.npmjs.com/package/inquirer for more.
-     */
-    timedPrompt<T extends Prompter.Answers>(questions: Prompter.Questions<T>, ms?: number, initialAnswers?: Partial<T>): Promise<T>;
-    /**
-     * Simplified prompt for single-question confirmation. Times out and throws after 10s
-     *
-     * @param message text to display.  Do not include a question mark.
-     * @param ms milliseconds to wait for user input.  Defaults to 10s.
-     * @param defaultAnswer default answer for the prompt.  Defaults to true.  Pass in `false` to require a positive response.
-     * @return true if the user confirms, false if they do not.
-     */
-    confirm(message: string, ms?: number, defaultAnswer?: boolean): Promise<boolean>;
-}
-export declare namespace Prompter {
-    type Answers<T = Record<string, unknown>> = T & Record<string, unknown>;
-    type Questions<T extends Answers> = QuestionCollection<T>;
-}
-/**
- * Generate a formatted table for list and checkbox prompts
- *
- * Each option should contain the same keys as specified in columns.
- *
- * @example
- * ```
- * const columns = { name: 'Name', type: 'Type', path: 'Path' };
- * const options = [{ name: 'foo', type: 'org', path: '/path/to/foo/' }];
- * generateTableChoices(columns, options);
- * ```
- */
-export declare function generateTableChoices<T>(columns: Dictionary<string>, choices: Array<Dictionary<Nullable<string> | T>>, padForCheckbox?: boolean): ChoiceBase[];
-export { Separator };
-//# sourceMappingURL=prompter.d.ts.map

package/lib/ux/prompter.js

@@ -1,99 +0,0 @@
-"use strict";
-/*
- * Copyright (c) 2022, 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.Separator = exports.generateTableChoices = exports.Prompter = void 0;
-const inquirer_1 = require("inquirer");
-Object.defineProperty(exports, "Separator", { enumerable: true, get: function () { return inquirer_1.Separator; } });
-const ts_types_1 = require("@salesforce/ts-types");
-const core_1 = require("@oclif/core");
-class Prompter {
-    /**
-     * Prompt user for information. See https://www.npmjs.com/package/inquirer for more.
-     */
-    // eslint-disable-next-line class-methods-use-this
-    async prompt(questions, initialAnswers) {
-        const answers = await (0, inquirer_1.prompt)(questions, initialAnswers);
-        return answers;
-    }
-    /**
-     * Prompt user for information with a timeout (in milliseconds). See https://www.npmjs.com/package/inquirer for more.
-     */
-    // eslint-disable-next-line class-methods-use-this
-    async timedPrompt(questions, ms = 10000, initialAnswers) {
-        let id;
-        const thePrompt = (0, inquirer_1.prompt)(questions, initialAnswers);
-        const timeout = new Promise((_, reject) => {
-            id = setTimeout(() => {
-                // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-                // @ts-expect-error
-                // eslint-disable-next-line @typescript-eslint/no-unsafe-call
-                thePrompt.ui['activePrompt'].done();
-                core_1.ux.log();
-                reject(new Error(`Timed out after ${ms} ms.`));
-            }, ms).unref();
-        });
-        return Promise.race([timeout, thePrompt]).then((result) => {
-            clearTimeout(id);
-            return result;
-        });
-    }
-    /**
-     * Simplified prompt for single-question confirmation. Times out and throws after 10s
-     *
-     * @param message text to display.  Do not include a question mark.
-     * @param ms milliseconds to wait for user input.  Defaults to 10s.
-     * @param defaultAnswer default answer for the prompt.  Defaults to true.  Pass in `false` to require a positive response.
-     * @return true if the user confirms, false if they do not.
-     */
-    async confirm(message, ms = 10000, defaultAnswer = true) {
-        const { confirmed } = await this.timedPrompt([
-            {
-                name: 'confirmed',
-                message,
-                type: 'confirm',
-                default: defaultAnswer,
-            },
-        ], ms);
-        return confirmed;
-    }
-}
-exports.Prompter = Prompter;
-/**
- * Generate a formatted table for list and checkbox prompts
- *
- * Each option should contain the same keys as specified in columns.
- *
- * @example
- * ```
- * const columns = { name: 'Name', type: 'Type', path: 'Path' };
- * const options = [{ name: 'foo', type: 'org', path: '/path/to/foo/' }];
- * generateTableChoices(columns, options);
- * ```
- */
-function generateTableChoices(columns, choices, 
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-padForCheckbox = true) {
-    const columnEntries = Object.entries(columns);
-    const columnLengths = columnEntries.map(([key, value]) => Math.max((0, ts_types_1.ensureString)(value).length, ...choices.map((option) => (0, ts_types_1.ensureString)(option[key], `Type ${typeof option[key]} for ${key} in ${Object.keys(option).join(', ')}`)
-        .length)) + 1);
-    const choicesOptions = [
-        new inquirer_1.Separator(`${padForCheckbox ? ' '.repeat(2) : ''}${columnEntries
-            .map(([, value], index) => value?.padEnd(columnLengths[index], ' '))
-            .join('')}`),
-    ];
-    for (const meta of choices) {
-        const name = columnEntries
-            .map(([key], index) => (0, ts_types_1.ensureString)(meta[key]).padEnd(columnLengths[index], ' '))
-            .join('');
-        const choice = { name, value: meta.value, short: (0, ts_types_1.ensureString)(meta.name) };
-        choicesOptions.push(choice);
-    }
-    return choicesOptions;
-}
-exports.generateTableChoices = generateTableChoices;
-//# sourceMappingURL=prompter.js.map