@hubspot/cli 7.2.1-experimental.0 → 7.2.2-beta.0

package/lib/commonOpts.js

@@ -1,4 +1,7 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.addGlobalOptions = addGlobalOptions;
 exports.addAccountOptions = addAccountOptions;
@@ -7,13 +10,19 @@ exports.addOverwriteOptions = addOverwriteOptions;
 exports.addCmsPublishModeOptions = addCmsPublishModeOptions;
 exports.addTestingOptions = addTestingOptions;
 exports.addUseEnvironmentOptions = addUseEnvironmentOptions;
+exports.addCustomHelpOutput = addCustomHelpOutput;
 exports.setLogLevel = setLogLevel;
 exports.getCommandName = getCommandName;
 exports.getCmsPublishMode = getCmsPublishMode;
+const chalk_1 = __importDefault(require("chalk"));
+const yargs_parser_1 = __importDefault(require("yargs-parser"));
 const logger_1 = require("@hubspot/local-dev-lib/logger");
 const files_1 = require("@hubspot/local-dev-lib/constants/files");
 const config_1 = require("@hubspot/local-dev-lib/config");
 const lang_1 = require("./lang");
+const errorHandlers_1 = require("./errorHandlers");
+const exitCodes_1 = require("./enums/exitCodes");
+const ui_1 = require("./ui");
 const i18nKey = 'lib.commonOpts';
 function addGlobalOptions(yargs) {
     yargs.version(false);
@@ -70,6 +79,27 @@ function addUseEnvironmentOptions(yargs) {
     })
         .conflicts('use-env', 'account');
 }
+async function addCustomHelpOutput(yargs, command, describe) {
+    try {
+        const parsedArgv = (0, yargs_parser_1.default)(process.argv.slice(2));
+        if (parsedArgv && parsedArgv.help) {
+            // Construct the full command, including positional arguments
+            const commandBase = `hs ${parsedArgv._.slice(0, -1).join(' ')}`;
+            const fullCommand = `${commandBase.trim()} ${command}`;
+            // Format the original help output to be more readable
+            let commandHelp = await yargs.getHelp();
+            ['Options:', 'Examples:', 'Positionals:'].forEach(header => {
+                commandHelp = commandHelp.replace(header, chalk_1.default.bold(header));
+            });
+            logger_1.logger.log(`${(0, ui_1.uiCommandReference)(fullCommand, false)}\n\n${describe}\n\n${commandHelp}`);
+            process.exit(exitCodes_1.EXIT_CODES.SUCCESS);
+        }
+    }
+    catch (e) {
+        // Ignore error to allow yargs to show the default help output using the command description
+        (0, errorHandlers_1.debugError)(e);
+    }
+}
 function setLogLevel(options) {
     const { debug } = options;
     if (debug) {

package/lib/errorHandlers/index.js

@@ -8,9 +8,11 @@ exports.logError = logError;
 exports.debugError = debugError;
 const logger_1 = require("@hubspot/local-dev-lib/logger");
 const index_1 = require("@hubspot/local-dev-lib/errors/index");
+const config_1 = require("@hubspot/local-dev-lib/config");
 const suppressError_1 = require("./suppressError");
 const lang_1 = require("../lang");
 const util_1 = __importDefault(require("util"));
+const ui_1 = require("../ui");
 const i18nKey = 'lib.errorHandlers.index';
 function logError(error, context) {
     debugError(error, context);
@@ -41,6 +43,21 @@ function logError(error, context) {
         // Unknown errors
         logger_1.logger.error((0, lang_1.i18n)(`${i18nKey}.unknownErrorOccurred`));
     }
+    if ((0, index_1.isHubSpotHttpError)(error) && error.code === 'ETIMEDOUT') {
+        const config = (0, config_1.getConfig)();
+        const defaultTimeout = config?.httpTimeout;
+        // Timeout was caused by the default timeout
+        if (error.timeout && defaultTimeout === error.timeout) {
+            logger_1.logger.error((0, lang_1.i18n)(`${i18nKey}.configTimeoutErrorOccurred`, {
+                timeout: error.timeout,
+                configSetCommand: (0, ui_1.uiCommandReference)('hs config set'),
+            }));
+        }
+        // Timeout was caused by a custom timeout set by the CLI or LDL
+        else {
+            logger_1.logger.error((0, lang_1.i18n)(`${i18nKey}.genericTimeoutErrorOccurred`));
+        }
+    }
 }
 function debugError(error, context) {
     if ((0, index_1.isHubSpotHttpError)(error)) {

package/lib/localDev.d.ts

@@ -14,5 +14,5 @@ export declare function createSandboxForLocalDev(accountId: number, accountConfi
 export declare function createDeveloperTestAccountForLocalDev(accountId: number, accountConfig: CLIAccount, env: Environment): Promise<number>;
 export declare function useExistingDevTestAccount(env: Environment, account: DeveloperTestAccount): Promise<void>;
 export declare function createNewProjectForLocalDev(projectConfig: ProjectConfig, targetAccountId: number, shouldCreateWithoutConfirmation: boolean, hasPublicApps: boolean): Promise<Project>;
-export declare function createInitialBuildForNewProject(projectConfig: ProjectConfig, projectDir: string, targetAccountId: number): Promise<Build>;
+export declare function createInitialBuildForNewProject(projectConfig: ProjectConfig, projectDir: string, targetAccountId: number, sendIr?: boolean): Promise<Build>;
 export declare function getAccountHomeUrl(accountId: number): string;

package/lib/localDev.js

@@ -294,8 +294,8 @@ function projectUploadCallback(accountId, projectConfig, tempFile, buildId) {
 }
 // Create an initial build if the project was newly created in the account
 // Return the newly deployed build
-async function createInitialBuildForNewProject(projectConfig, projectDir, targetAccountId) {
-    const { result: initialUploadResult, uploadError } = await (0, upload_1.handleProjectUpload)(targetAccountId, projectConfig, projectDir, projectUploadCallback, (0, lang_1.i18n)(`${i18nKey}.createInitialBuildForNewProject.initialUploadMessage`));
+async function createInitialBuildForNewProject(projectConfig, projectDir, targetAccountId, sendIr) {
+    const { result: initialUploadResult, uploadError } = await (0, upload_1.handleProjectUpload)(targetAccountId, projectConfig, projectDir, projectUploadCallback, (0, lang_1.i18n)(`${i18nKey}.createInitialBuildForNewProject.initialUploadMessage`), sendIr);
     if (uploadError) {
         if ((0, index_1.isSpecifiedError)(uploadError, {
             subCategory: constants_1.PROJECT_ERROR_TYPES.PROJECT_LOCKED,

package/lib/projects/buildAndDeploy.js

@@ -16,6 +16,7 @@ const lang_1 = require("../lang");
 const errorHandlers_1 = require("../errorHandlers");
 const ui_1 = require("../ui");
 const urls_1 = require("./urls");
+const exitCodes_1 = require("../enums/exitCodes");
 const i18nKey = 'lib.projectBuildAndDeploy';
 const SPINNER_STATUS = {
     SPINNING: 'spinning',
@@ -48,6 +49,15 @@ function getSubtaskType(task) {
     }
     return task.deployType;
 }
+function handleTaskStatusError(statusText) {
+    logger_1.logger.error((0, lang_1.i18n)(`${i18nKey}.makePollTaskStatusFunc.errorFetchingTaskStatus`, {
+        taskType: statusText.TYPE_KEY === constants_1.PROJECT_BUILD_TEXT.TYPE_KEY
+            ? 'build'
+            : 'deploy',
+        openCommand: (0, ui_1.uiCommandReference)('hs project open'),
+    }));
+    process.exit(exitCodes_1.EXIT_CODES.ERROR);
+}
 function makePollTaskStatusFunc({ statusFn, structureFn, statusText, statusStrings, linkToHubSpot, }) {
     return async function (accountId, taskName, taskId, deployedBuildId = null, silenceLogs = false) {
         const displayId = deployedBuildId || taskId;
@@ -111,7 +121,7 @@ function makePollTaskStatusFunc({ statusFn, structureFn, statusText, statusStrin
                 task.subtasks.forEach((subtask, i) => addTaskSpinner(subtask, 4, i === task.subtasks.length - 1));
             });
         }
-        return new Promise((resolve, reject) => {
+        return new Promise(resolve => {
             const pollInterval = setInterval(async () => {
                 let taskStatus;
                 try {
@@ -124,19 +134,11 @@ function makePollTaskStatusFunc({ statusFn, structureFn, statusText, statusStrin
                         accountId,
                         projectName: taskName,
                     }));
-                    return reject(new Error((0, lang_1.i18n)(`${i18nKey}.makePollTaskStatusFunc.errorFetchingTaskStatus`, {
-                        taskType: statusText.TYPE_KEY === constants_1.PROJECT_BUILD_TEXT.TYPE_KEY
-                            ? 'build'
-                            : 'deploy',
-                    })));
+                    handleTaskStatusError(statusText);
                 }
                 const subtasks = getSubtasks(taskStatus);
                 if (!taskStatus || !taskStatus.status || !subtasks) {
-                    return reject(new Error((0, lang_1.i18n)(`${i18nKey}.makePollTaskStatusFunc.errorFetchingTaskStatus`, {
-                        taskType: statusText.TYPE_KEY === constants_1.PROJECT_BUILD_TEXT.TYPE_KEY
-                            ? 'build'
-                            : 'deploy',
-                    })));
+                    handleTaskStatusError(statusText);
                 }
                 const { status } = taskStatus;
                 if (SpinniesManager_1.default.hasActiveSpinners()) {

package/lib/prompts/accountNamePrompt.d.ts

@@ -1,12 +1,11 @@
 import { PromptConfig } from '../../types/Prompts';
 import { AccountType } from '@hubspot/local-dev-lib/types/Accounts';
-type AccountNamePromptResponse = {
+export type AccountNamePromptResponse = {
     name: string;
 };
 export declare function getCliAccountNamePromptConfig(defaultName?: string): PromptConfig<AccountNamePromptResponse>;
-export declare function cliAccountNamePrompt(defaultName: string): Promise<AccountNamePromptResponse>;
+export declare function cliAccountNamePrompt(defaultName?: string): Promise<AccountNamePromptResponse>;
 export declare function hubspotAccountNamePrompt({ accountType, currentPortalCount, }: {
     accountType: AccountType;
     currentPortalCount?: number;
 }): Promise<AccountNamePromptResponse>;
-export {};

package/lib/prompts/createProjectPrompt.js

@@ -9,7 +9,20 @@ const path_1 = __importDefault(require("path"));
 const path_2 = require("@hubspot/local-dev-lib/path");
 const promptUtils_1 = require("./promptUtils");
 const lang_1 = require("../lang");
+const constants_1 = require("../constants");
 const i18nKey = 'lib.prompts.createProjectPrompt';
+function validateProjectDirectory(input) {
+    if (!input) {
+        return (0, lang_1.i18n)(`${i18nKey}.errors.destRequired`);
+    }
+    if (fs_1.default.existsSync(path_1.default.resolve((0, path_2.getCwd)(), path_1.default.join(input, constants_1.PROJECT_CONFIG_FILE)))) {
+        return (0, lang_1.i18n)(`${i18nKey}.errors.invalidDest`);
+    }
+    if (!(0, path_2.isValidPath)(input)) {
+        return (0, lang_1.i18n)(`${i18nKey}.errors.invalidCharacters`);
+    }
+    return true;
+}
 function findTemplateByNameOrLabel(projectTemplates, templateNameOrLabel) {
     return projectTemplates.find(t => t.name === templateNameOrLabel || t.label === templateNameOrLabel);
 }
@@ -38,18 +51,7 @@ async function createProjectPrompt(promptOptions, projectTemplates) {
                 const projectName = (0, path_2.sanitizeFileName)(promptOptions.name || answers.name);
                 return path_1.default.resolve((0, path_2.getCwd)(), projectName);
             },
-            validate: (input) => {
-                if (!input) {
-                    return (0, lang_1.i18n)(`${i18nKey}.errors.destRequired`);
-                }
-                if (fs_1.default.existsSync(input)) {
-                    return (0, lang_1.i18n)(`${i18nKey}.errors.invalidDest`);
-                }
-                if (!(0, path_2.isValidPath)(input)) {
-                    return (0, lang_1.i18n)(`${i18nKey}.errors.invalidCharacters`);
-                }
-                return true;
-            },
+            validate: validateProjectDirectory,
             filter: input => {
                 return (0, path_2.untildify)(input);
             },

package/lib/prompts/personalAccessKeyPrompt.d.ts

@@ -1,5 +1,6 @@
+import { AccountNamePromptResponse } from './accountNamePrompt';
 import { PromptConfig } from '../../types/Prompts';
-type PersonalAccessKeyPromptResponse = {
+export type PersonalAccessKeyPromptResponse = {
     personalAccessKey: string;
     env: string;
 };
@@ -15,6 +16,7 @@ type ClientSecretPromptResponse = {
 type ScopesPromptResponse = {
     scopes: string[];
 };
+export type OauthPromptResponse = AccountNamePromptResponse & AccountIdPromptResponse & ClientIdPromptResponse & ClientSecretPromptResponse & ScopesPromptResponse;
 /**
  * Displays notification to user that we are about to open the browser,
  * then opens their browser to the personal-access-key shortlink
@@ -23,7 +25,5 @@ export declare function personalAccessKeyPrompt({ env, account, }: {
     env: string;
     account?: number;
 }): Promise<PersonalAccessKeyPromptResponse>;
-export declare const OAUTH_FLOW: (PromptConfig<{
-    name: string;
-}> | PromptConfig<AccountIdPromptResponse> | PromptConfig<ClientIdPromptResponse> | PromptConfig<ClientSecretPromptResponse> | PromptConfig<ScopesPromptResponse>)[];
+export declare const OAUTH_FLOW: (PromptConfig<AccountNamePromptResponse> | PromptConfig<AccountIdPromptResponse> | PromptConfig<ClientIdPromptResponse> | PromptConfig<ClientSecretPromptResponse> | PromptConfig<ScopesPromptResponse>)[];
 export {};

package/lib/ui/index.d.ts

@@ -7,8 +7,8 @@ export declare function uiLine(): void;
 export declare function uiLink(linkText: string, url: string): string;
 export declare function uiAccountDescription(accountId?: number | null, bold?: boolean): string;
 export declare function uiInfoSection(title: string, logContent: () => void): void;
-export declare function uiCommandReference(command: string): string;
-export declare function uiFeatureHighlight(commands: string[], title?: string): void;
+export declare function uiCommandReference(command: string, withQuotes?: boolean): string;
+export declare function uiFeatureHighlight(features: string[], title?: string): void;
 export declare function uiBetaTag(message: string, log?: boolean): string | undefined;
 export declare function uiDeprecatedTag(message: string): void;
 export declare function uiCommandDisabledBanner(command: string, url?: string, message?: string): void;

package/lib/ui/index.js

@@ -70,21 +70,21 @@ function uiInfoSection(title, logContent) {
     logger_1.logger.log('');
     uiLine();
 }
-function uiCommandReference(command) {
+function uiCommandReference(command, withQuotes = true) {
     const terminalUISupport = getTerminalUISupport();
-    const commandReference = `\`${command}\``;
+    const commandReference = withQuotes ? `\`${command}\`` : command;
     return chalk_1.default.bold(terminalUISupport.color
         ? chalk_1.default.hex(exports.UI_COLORS.MARIGOLD_DARK)(commandReference)
         : commandReference);
 }
-function uiFeatureHighlight(commands, title) {
+function uiFeatureHighlight(features, title) {
     const i18nKey = 'lib.ui.featureHighlight';
     uiInfoSection(title ? title : (0, lang_1.i18n)(`${i18nKey}.defaultTitle`), () => {
-        commands.forEach((c, i) => {
-            const commandKey = `${i18nKey}.commandKeys.${c}`;
-            const message = (0, lang_1.i18n)(`${commandKey}.message`, {
-                command: uiCommandReference((0, lang_1.i18n)(`${commandKey}.command`)),
-                link: uiLink((0, lang_1.i18n)(`${commandKey}.linkText`), (0, lang_1.i18n)(`${commandKey}.url`)),
+        features.forEach((c, i) => {
+            const featureKey = `${i18nKey}.featureKeys.${c}`;
+            const message = (0, lang_1.i18n)(`${featureKey}.message`, {
+                command: uiCommandReference((0, lang_1.i18n)(`${featureKey}.command`)),
+                link: uiLink((0, lang_1.i18n)(`${featureKey}.linkText`), (0, lang_1.i18n)(`${featureKey}.url`)),
             });
             if (i !== 0) {
                 logger_1.logger.log('');

package/lib/ui/supportHyperlinks.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.supportsHyperlinkModule = void 0;
-const hasFlag_1 = require("../hasFlag");
+const yargsUtils_1 = require("../yargsUtils");
 //See https://github.com/jamestalmage/supports-hyperlinks (License: https://github.com/jamestalmage/supports-hyperlinks/blob/master/license)
 function parseVersion(versionString) {
     if (/^\d{3,4}$/.test(versionString)) {
@@ -22,7 +22,7 @@ function parseVersion(versionString) {
 }
 function supportsHyperlink(stream) {
     const { env } = process;
-    if ((0, hasFlag_1.hasFlag)('noHyperlinks')) {
+    if ((0, yargsUtils_1.hasFlag)('noHyperlinks')) {
         return false;
     }
     if (stream && !stream.isTTY) {

package/lib/ui/supportsColor.js

@@ -7,7 +7,7 @@ exports.supportsColor = void 0;
 const process_1 = __importDefault(require("process"));
 const os_1 = __importDefault(require("os"));
 const tty_1 = __importDefault(require("tty"));
-const hasFlag_1 = require("../hasFlag");
+const yargsUtils_1 = require("../yargsUtils");
 const { env } = process_1.default;
 function translateLevel(level) {
     if (level === 0) {
@@ -33,7 +33,7 @@ function _supportsColor(haveStream, { streamIsTTY } = {}) {
     if (env.TERM === 'dumb') {
         return min;
     }
-    if ((0, hasFlag_1.hasFlag)('noColor')) {
+    if ((0, yargsUtils_1.hasFlag)('noColor')) {
         return 0;
     }
     if (process_1.default.platform === 'win32') {

package/lib/usageTracking.d.ts

@@ -16,6 +16,6 @@ type Meta = {
 export declare function trackCommandUsage(command: string, meta?: Meta, accountId?: number): Promise<void>;
 export declare function trackHelpUsage(command: string): Promise<void>;
 export declare function trackConvertFieldsUsage(command: string): Promise<void>;
-export declare function trackAuthAction(command: string, authType: string, step: string, accountId: number): Promise<void>;
+export declare function trackAuthAction(command: string, authType: string, step: string, accountId?: number): Promise<void>;
 export declare function trackCommandMetadataUsage(command: string, meta?: Meta, accountId?: number): Promise<void>;
 export {};

package/lib/yargsUtils.d.ts

@@ -0,0 +1,9 @@
+import { Argv } from 'yargs';
+export declare function hasFlag(flag: string, argv?: string[]): boolean;
+export declare function makeYargsBuilder<T>(callback: (yargs: Argv) => Argv<T>, command: string, describe: string, options: {
+    useGlobalOptions?: boolean;
+    useAccountOptions?: boolean;
+    useConfigOptions?: boolean;
+    useUseEnvironmentOptions?: boolean;
+    useTestingOptions?: boolean;
+}): (yargs: Argv) => Promise<Argv<T>>;

package/lib/yargsUtils.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasFlag = hasFlag;
+exports.makeYargsBuilder = makeYargsBuilder;
+const process_1 = __importDefault(require("process"));
+const commonOpts_1 = require("./commonOpts");
+// See https://github.com/sindresorhus/has-flag/blob/main/index.js (License: https://github.com/sindresorhus/has-flag/blob/main/license)
+function hasFlag(flag, argv = process_1.default.argv) {
+    const prefix = flag.startsWith('-') ? '' : flag.length === 1 ? '-' : '--';
+    const position = argv.indexOf(prefix + flag);
+    const terminatorPosition = argv.indexOf('--');
+    return (position !== -1 &&
+        (terminatorPosition === -1 || position < terminatorPosition));
+}
+function makeYargsBuilder(callback, command, describe, options) {
+    return async function (yargs) {
+        if (options.useGlobalOptions) {
+            (0, commonOpts_1.addGlobalOptions)(yargs);
+        }
+        if (options.useAccountOptions) {
+            (0, commonOpts_1.addAccountOptions)(yargs);
+        }
+        if (options.useConfigOptions) {
+            (0, commonOpts_1.addConfigOptions)(yargs);
+        }
+        if (options.useUseEnvironmentOptions) {
+            (0, commonOpts_1.addUseEnvironmentOptions)(yargs);
+        }
+        if (options.useTestingOptions) {
+            (0, commonOpts_1.addTestingOptions)(yargs);
+        }
+        const result = callback(yargs);
+        // Must go last to pick up available options
+        await (0, commonOpts_1.addCustomHelpOutput)(result, command, describe);
+        return result;
+    };
+}

package/package.json

@@ -1,15 +1,15 @@
 {
     "name": "@hubspot/cli",
-    "version": "7.2.1-experimental.0",
+    "version": "7.2.2-beta.0",
     "description": "The official CLI for developing on HubSpot",
     "license": "Apache-2.0",
     "repository": "https://github.com/HubSpot/hubspot-cli",
     "dependencies": {
-        "@hubspot/local-dev-lib": "3.3.2",
-        "@hubspot/project-parsing-lib": "0.1.0",
+        "@hubspot/local-dev-lib": "3.4.1",
+        "@hubspot/project-parsing-lib": "0.1.4",
         "@hubspot/serverless-dev-runtime": "7.0.2",
         "@hubspot/theme-preview-dev-server": "0.0.10",
-        "@hubspot/ui-extensions-dev-server": "0.8.47",
+        "@hubspot/ui-extensions-dev-server": "0.8.50",
         "archiver": "7.0.1",
         "chalk": "4.1.2",
         "chokidar": "3.6.0",

package/lib/hasFlag.d.ts

@@ -1 +0,0 @@
-export declare function hasFlag(flag: string, argv?: string[]): boolean;

package/lib/hasFlag.js

@@ -1,15 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasFlag = hasFlag;
-const process_1 = __importDefault(require("process"));
-// See https://github.com/sindresorhus/has-flag/blob/main/index.js (License: https://github.com/sindresorhus/has-flag/blob/main/license)
-function hasFlag(flag, argv = process_1.default.argv) {
-    const prefix = flag.startsWith('-') ? '' : flag.length === 1 ? '-' : '--';
-    const position = argv.indexOf(prefix + flag);
-    const terminatorPosition = argv.indexOf('--');
-    return (position !== -1 &&
-        (terminatorPosition === -1 || position < terminatorPosition));
-}