@hubspot/cli 8.3.0 → 8.4.0-beta.0

package/lib/theme/cmsDevServerProcess.js

@@ -6,6 +6,7 @@ import { fileURLToPath } from 'url';
 import { getConfigFilePath } from '@hubspot/local-dev-lib/config';
 import SpinniesManager from '../ui/SpinniesManager.js';
 import { lib } from '../../lang/en.js';
+import { EXIT_CODES } from '../enums/exitCodes.js';
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 // cms-dev-server version to install to isolated cache
@@ -83,7 +84,7 @@ async function ensureCmsDevServerCache(targetVersion) {
     return cacheDir;
 }
 export async function spawnDevServer(options) {
-    const { absoluteSrc, accountName, noSsl, port, generateFieldsTypes, resetSession, dest, } = options;
+    const { absoluteSrc, accountName, noSsl, port, generateFieldsTypes, resetSession, dest, exit, } = options;
     // Ensure cms-dev-server is installed in isolated cache
     const cacheDir = await ensureCmsDevServerCache(TARGET_CMS_DEV_SERVER_VERSION);
     // Get config path to pass to createDevServer
@@ -123,18 +124,18 @@ export async function spawnDevServer(options) {
         cwd: cacheDir,
     });
     // Handle process events
-    devServer.on('error', error => {
+    devServer.on('error', async (error) => {
         console.error(lib.theme.cmsDevServerProcess.serverStartError(error));
-        process.exit(1);
+        await exit(EXIT_CODES.ERROR);
     });
-    devServer.on('exit', (code, signal) => {
+    devServer.on('exit', async (code, signal) => {
         if (code !== 0 && code !== null) {
             console.error(lib.theme.cmsDevServerProcess.serverExit(code));
-            process.exit(code);
+            await exit(code);
         }
         if (signal) {
             console.error(lib.theme.cmsDevServerProcess.serverKill(signal));
-            process.exit(1);
+            await exit(EXIT_CODES.ERROR);
         }
     });
     // Handle CLI termination

package/lib/ui/SpinniesManager.d.ts

@@ -12,6 +12,7 @@ declare class SpinniesManager {
     private lineCount;
     private currentFrameIndex;
     private spin;
+    private sigintHandler;
     constructor();
     init(options?: Partial<SpinnerState>): void;
     private resetState;

package/lib/ui/SpinniesManager.js

@@ -10,7 +10,8 @@ The above copyright notice and this permission notice shall be included in all c
 import readline from 'readline';
 import chalk from 'chalk';
 import cliCursor from 'cli-cursor';
-import { breakText, cleanStream, colorOptions, getLinesLength, prefixOptions, purgeSpinnerOptions, purgeSpinnersOptions, SPINNERS, terminalSupportsUnicode, writeStream, } from './spinniesUtils.js';
+import { breakText, cleanStream, colorOptions, getLinesLength, prefixOptions, purgeSpinnerOptions, purgeSpinnersOptions, SPINNERS, writeStream, } from './spinniesUtils.js';
+import { isUnicodeSupported } from '@hubspot/local-dev-lib/isUnicodeSupported';
 import { uiLogger } from './logger.js';
 function safeColor(text, color) {
     const chalkFn = chalk[color];
@@ -29,6 +30,7 @@ class SpinniesManager {
     lineCount = 0;
     currentFrameIndex = 0;
     spin;
+    sigintHandler = null;
     constructor() {
         this.resetState();
     }
@@ -37,7 +39,7 @@ class SpinniesManager {
             spinnerColor: 'greenBright',
             succeedColor: 'green',
             failColor: 'red',
-            spinner: terminalSupportsUnicode() ? SPINNERS.dots : SPINNERS.dashes,
+            spinner: isUnicodeSupported() ? SPINNERS.dots : SPINNERS.dashes,
             disableSpins: false,
             ...purgeSpinnersOptions(options),
         };
@@ -247,12 +249,24 @@ class SpinniesManager {
         }
     }
     bindSigint() {
-        process.removeAllListeners('SIGINT');
-        process.on('SIGINT', () => {
+        if (this.sigintHandler) {
+            process.removeListener('SIGINT', this.sigintHandler);
+        }
+        this.sigintHandler = () => {
             cliCursor.show();
             readline.moveCursor(process.stderr, 0, this.lineCount);
-            process.exit(0);
-        });
+            const remainingListeners = process
+                .listeners('SIGINT')
+                .filter(l => l !== this.sigintHandler);
+            if (remainingListeners.length === 0) {
+                // process.exit is intentionally used here rather than the command-level
+                // exit() function because this SIGINT handler runs outside of a command
+                // context and needs to force-terminate the process when no other SIGINT
+                // listeners remain to handle it.
+                process.exit(0);
+            }
+        };
+        process.on('SIGINT', this.sigintHandler);
     }
 }
 const toExport = new SpinniesManager();

package/lib/ui/spinniesUtils.d.ts

@@ -28,5 +28,4 @@ export declare function breakText(text: string, prefixLength: number): string;
 export declare function getLinesLength(text: string, prefixLength: number): number[];
 export declare function writeStream(stream: NodeJS.WriteStream, output: string, rawLines: number[]): void;
 export declare function cleanStream(stream: NodeJS.WriteStream, rawLines: number[]): void;
-export declare function terminalSupportsUnicode(): boolean;
 export {};

package/lib/ui/spinniesUtils.js

@@ -9,6 +9,8 @@ The above copyright notice and this permission notice shall be included in all c
 **/
 import readline from 'readline';
 import stripAnsi from 'strip-ansi';
+import { isUnicodeSupported } from '@hubspot/local-dev-lib/isUnicodeSupported';
+import { getSymbols } from '@hubspot/local-dev-lib/logger';
 export const VALID_STATUSES = [
     'succeed',
     'fail',
@@ -64,7 +66,7 @@ export function purgeSpinnersOptions({ spinner, disableSpins, ...others }) {
     return { ...colors, ...prefixes, ...disableSpinsOption, spinner };
 }
 function turnToValidSpinner(spinner = {}) {
-    const platformSpinner = terminalSupportsUnicode()
+    const platformSpinner = isUnicodeSupported()
         ? SPINNERS.dots
         : SPINNERS.dashes;
     if (typeof spinner !== 'object') {
@@ -101,14 +103,9 @@ export function colorOptions({ color, succeedColor, failColor, spinnerColor, })
     return colors;
 }
 export function prefixOptions({ succeedPrefix, failPrefix, }) {
-    if (terminalSupportsUnicode()) {
-        succeedPrefix = succeedPrefix || '✓';
-        failPrefix = failPrefix || '✖';
-    }
-    else {
-        succeedPrefix = succeedPrefix || '√';
-        failPrefix = failPrefix || '×';
-    }
+    const symbols = getSymbols();
+    succeedPrefix = succeedPrefix || symbols.success;
+    failPrefix = failPrefix || symbols.error;
     return { succeedPrefix, failPrefix };
 }
 export function breakText(text, prefixLength) {
@@ -142,10 +139,3 @@ export function cleanStream(stream, rawLines) {
     readline.clearScreenDown(stream);
     readline.moveCursor(stream, 0, -rawLines.length);
 }
-export function terminalSupportsUnicode() {
-    // The default command prompt and powershell in Windows do not support Unicode characters.
-    // However, the VSCode integrated terminal and the Windows Terminal both do.
-    return (process.platform !== 'win32' ||
-        process.env.TERM_PROGRAM === 'vscode' ||
-        !!process.env.WT_SESSION);
-}

package/lib/usageTracking.d.ts

@@ -1,4 +1,4 @@
-type Meta = {
+export type UsageTrackingMeta = {
     action?: string;
     os?: string;
     nodeVersion?: string;
@@ -24,9 +24,8 @@ export declare function getNodeVersionData(): {
     nodeMajorVersion: string;
 };
 export declare function getPlatform(): string;
-export declare function trackCommandUsage(command: string, meta?: Meta, accountId?: number): Promise<void>;
+export declare function trackCommandUsage(command: string, meta?: UsageTrackingMeta, 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 trackCommandMetadataUsage(command: string, meta?: Meta, accountId?: number): Promise<void>;
-export {};
+export declare function trackCommandMetadataUsage(command: string, meta?: UsageTrackingMeta, accountId?: number): Promise<void>;

package/lib/yargs/makeYargsBuilder.d.ts

@@ -0,0 +1,13 @@
+import { Argv } from 'yargs';
+export declare function makeYargsBuilder<T>(callback: (yargs: Argv) => Argv<T>, command: string | string[], describe?: string, options?: {
+    useGlobalOptions?: boolean;
+    useAccountOptions?: boolean;
+    useConfigOptions?: boolean;
+    useEnvironmentOptions?: boolean;
+    useTestingOptions?: boolean;
+    useCmsPublishModeOptions?: boolean | {
+        read?: boolean;
+        write?: boolean;
+    };
+    useJSONOutputOptions?: boolean;
+}): (yargs: Argv) => Promise<Argv<T>>;

package/lib/yargs/makeYargsBuilder.js

@@ -0,0 +1,33 @@
+import { addCustomHelpOutput, addTestingOptions, addAccountOptions, addConfigOptions, addGlobalOptions, addUseEnvironmentOptions, addCmsPublishModeOptions, addJSONOutputOptions, } from '../commonOpts.js';
+export function makeYargsBuilder(callback, command, describe, options = {}) {
+    return async function (yargs) {
+        if (options.useGlobalOptions) {
+            addGlobalOptions(yargs);
+        }
+        if (options.useAccountOptions) {
+            addAccountOptions(yargs);
+        }
+        if (options.useConfigOptions) {
+            addConfigOptions(yargs);
+        }
+        if (options.useEnvironmentOptions) {
+            addUseEnvironmentOptions(yargs);
+        }
+        if (options.useTestingOptions) {
+            addTestingOptions(yargs);
+        }
+        if (options.useJSONOutputOptions) {
+            addJSONOutputOptions(yargs);
+        }
+        if (options.useCmsPublishModeOptions) {
+            const opts = typeof options.useCmsPublishModeOptions === 'object'
+                ? options.useCmsPublishModeOptions
+                : { write: true };
+            addCmsPublishModeOptions(yargs, opts);
+        }
+        const result = callback(yargs);
+        // Must go last to pick up available options
+        await addCustomHelpOutput(result, command, describe);
+        return result;
+    };
+}

package/lib/yargs/makeYargsHandlerWithUsageTracking.d.ts

@@ -0,0 +1,3 @@
+import { ArgumentsCamelCase } from 'yargs';
+import { CommonArgs } from '../../types/Yargs.js';
+export declare function makeYargsHandlerWithUsageTracking<T extends CommonArgs>(trackingName: string, handler: (args: ArgumentsCamelCase<T>) => Promise<void>): (args: ArgumentsCamelCase<T>) => Promise<void>;

package/lib/yargs/makeYargsHandlerWithUsageTracking.js

@@ -0,0 +1,95 @@
+import { getConfig } from '@hubspot/local-dev-lib/config';
+import { getStateValue, setStateValue, } from '@hubspot/local-dev-lib/config/state';
+import { STATE_FLAGS } from '@hubspot/local-dev-lib/constants/config';
+import { trackCommandUsage as _trackCommandUsage } from '../usageTracking.js';
+import { pkg } from '../jsonLoader.js';
+import { uiLogger } from '../ui/logger.js';
+import { lib } from '../../lang/en.js';
+import { EXIT_CODES } from '../enums/exitCodes.js';
+import { isPromptExitError } from '../errors/PromptExitError.js';
+import { debugError } from '../errorHandlers/index.js';
+function logUsageTrackingMessage(isJsonOutput) {
+    if (isJsonOutput) {
+        return;
+    }
+    try {
+        const config = getConfig();
+        if (config?.allowUsageTracking !== true) {
+            return;
+        }
+        const lastShownVersion = getStateValue(STATE_FLAGS.USAGE_TRACKING_MESSAGE_LAST_SHOW_VERSION);
+        if (lastShownVersion === pkg.version) {
+            return;
+        }
+        setStateValue(STATE_FLAGS.USAGE_TRACKING_MESSAGE_LAST_SHOW_VERSION, pkg.version);
+        uiLogger.info(lib.usageTracking.transparencyMessage);
+    }
+    catch (_e) {
+        return;
+    }
+}
+export function makeYargsHandlerWithUsageTracking(trackingName, handler) {
+    return async (args) => {
+        const meta = {};
+        let trackingFired = false;
+        const trackingArgs = args;
+        const addUsageMetadata = (newMeta) => {
+            Object.assign(meta, newMeta);
+        };
+        trackingArgs.addUsageMetadata = addUsageMetadata;
+        const trackCommandUsage = async (successful) => {
+            if (trackingFired) {
+                return;
+            }
+            trackingFired = true;
+            try {
+                const { accountId: overrideAccountId, ...trackingMeta } = meta;
+                trackingMeta.successful = successful;
+                await _trackCommandUsage(trackingName, trackingMeta, overrideAccountId ?? args.derivedAccountId);
+            }
+            catch (_e) { }
+        };
+        const onForcedExit = () => {
+            process.exit(EXIT_CODES.SUCCESS);
+        };
+        const onSigint = async () => {
+            process.removeListener('SIGINT', onSigint);
+            process.on('SIGINT', onForcedExit);
+            try {
+                await trackCommandUsage(false);
+            }
+            catch (_e) { }
+            process.removeListener('SIGINT', onForcedExit);
+            process.exit(EXIT_CODES.SUCCESS);
+        };
+        process.on('SIGINT', onSigint);
+        const trackCommandUsageAndRemoveListeners = async (successful) => {
+            await trackCommandUsage(successful);
+            process.removeListener('SIGINT', onSigint);
+            process.removeListener('SIGINT', onForcedExit);
+        };
+        trackingArgs.exit = async (code) => {
+            await trackCommandUsageAndRemoveListeners(code !== EXIT_CODES.ERROR);
+            return process.exit(code);
+        };
+        const jsonArgs = args;
+        logUsageTrackingMessage(Boolean(jsonArgs.json || jsonArgs.formatOutputAsJson));
+        try {
+            await handler(trackingArgs);
+        }
+        catch (e) {
+            const isSuccessfulPromptExit = isPromptExitError(e)
+                ? e.exitCode !== EXIT_CODES.ERROR
+                : false;
+            await trackCommandUsageAndRemoveListeners(isSuccessfulPromptExit);
+            if (isPromptExitError(e)) {
+                return process.exit(e.exitCode);
+            }
+            else {
+                debugError(e);
+                return process.exit(EXIT_CODES.ERROR);
+            }
+        }
+        await trackCommandUsageAndRemoveListeners(true);
+    };
+}

package/lib/yargs/strictEnforceBoolean.d.ts

@@ -0,0 +1 @@
+export declare function strictEnforceBoolean(rawArgs: string[], booleanOptions: string[]): boolean;

package/lib/yargs/strictEnforceBoolean.js

@@ -0,0 +1,13 @@
+import { commands } from '../../lang/en.js';
+export function strictEnforceBoolean(rawArgs, booleanOptions) {
+    for (const option of booleanOptions) {
+        const argIndex = rawArgs.findIndex(arg => arg.startsWith(`--${option}=`));
+        if (argIndex !== -1) {
+            const value = rawArgs[argIndex].split('=')[1];
+            if (value && !['true', 'false'].includes(value.toLowerCase())) {
+                throw new Error(commands.config.subcommands.set.errors.invalidBoolean(option, value));
+            }
+        }
+    }
+    return true;
+}

package/lib/yargsUtils.d.ts

@@ -1,16 +1,3 @@
-import { Argv } from 'yargs';
-import { hasFlag } from './utils/hasFlag.js';
-export { hasFlag };
-export declare function makeYargsBuilder<T>(callback: (yargs: Argv) => Argv<T>, command: string | string[], describe?: string, options?: {
-    useGlobalOptions?: boolean;
-    useAccountOptions?: boolean;
-    useConfigOptions?: boolean;
-    useEnvironmentOptions?: boolean;
-    useTestingOptions?: boolean;
-    useCmsPublishModeOptions?: boolean | {
-        read?: boolean;
-        write?: boolean;
-    };
-    useJSONOutputOptions?: boolean;
-}): (yargs: Argv) => Promise<Argv<T>>;
-export declare function strictEnforceBoolean(rawArgs: string[], booleanOptions: string[]): boolean;
+export { hasFlag } from './utils/hasFlag.js';
+export { makeYargsBuilder } from './yargs/makeYargsBuilder.js';
+export { strictEnforceBoolean } from './yargs/strictEnforceBoolean.js';

package/lib/yargsUtils.js

@@ -1,49 +1,4 @@
-import { addCustomHelpOutput, addTestingOptions, addAccountOptions, addConfigOptions, addGlobalOptions, addUseEnvironmentOptions, addCmsPublishModeOptions, addJSONOutputOptions, } from './commonOpts.js';
-import { hasFlag } from './utils/hasFlag.js';
-import { commands } from '../lang/en.js';
 // Re-export for backwards compatibility
-export { hasFlag };
-export function makeYargsBuilder(callback, command, describe, options = {}) {
-    return async function (yargs) {
-        if (options.useGlobalOptions) {
-            addGlobalOptions(yargs);
-        }
-        if (options.useAccountOptions) {
-            addAccountOptions(yargs);
-        }
-        if (options.useConfigOptions) {
-            addConfigOptions(yargs);
-        }
-        if (options.useEnvironmentOptions) {
-            addUseEnvironmentOptions(yargs);
-        }
-        if (options.useTestingOptions) {
-            addTestingOptions(yargs);
-        }
-        if (options.useJSONOutputOptions) {
-            addJSONOutputOptions(yargs);
-        }
-        if (options.useCmsPublishModeOptions) {
-            const opts = typeof options.useCmsPublishModeOptions === 'object'
-                ? options.useCmsPublishModeOptions
-                : { write: true };
-            addCmsPublishModeOptions(yargs, opts);
-        }
-        const result = callback(yargs);
-        // Must go last to pick up available options
-        await addCustomHelpOutput(result, command, describe);
-        return result;
-    };
-}
-export function strictEnforceBoolean(rawArgs, booleanOptions) {
-    for (const option of booleanOptions) {
-        const argIndex = rawArgs.findIndex(arg => arg.startsWith(`--${option}=`));
-        if (argIndex !== -1) {
-            const value = rawArgs[argIndex].split('=')[1];
-            if (value && !['true', 'false'].includes(value.toLowerCase())) {
-                throw new Error(commands.config.subcommands.set.errors.invalidBoolean(option, value));
-            }
-        }
-    }
-    return true;
-}
+export { hasFlag } from './utils/hasFlag.js';
+export { makeYargsBuilder } from './yargs/makeYargsBuilder.js';
+export { strictEnforceBoolean } from './yargs/strictEnforceBoolean.js';

package/package.json

@@ -1,15 +1,19 @@
 {
     "name": "@hubspot/cli",
-    "version": "8.3.0",
+    "version": "8.4.0-beta.0",
     "description": "The official CLI for developing on HubSpot",
     "license": "Apache-2.0",
     "repository": "https://github.com/HubSpot/hubspot-cli",
     "type": "module",
+    "files": [
+        "**/*",
+        "!**/__tests__/**"
+    ],
     "dependencies": {
-        "@hubspot/local-dev-lib": "5.2.0",
+        "@hubspot/local-dev-lib": "5.3.3",
         "@hubspot/project-parsing-lib": "0.12.1",
         "@hubspot/serverless-dev-runtime": "7.0.7",
-        "@hubspot/ui-extensions-dev-server": "2.0.0",
+        "@hubspot/ui-extensions-dev-server": "2.0.3",
         "@inquirer/prompts": "7.1.0",
         "@modelcontextprotocol/sdk": "1.25.0",
         "archiver": "7.0.1",
@@ -55,7 +59,7 @@
         "@typescript-eslint/eslint-plugin": "^8.30.1",
         "@typescript-eslint/parser": "^8.11.0",
         "@vitest/coverage-v8": "^2.1.9",
-        "axios": "^1.12.2",
+        "axios": "1.14.0",
         "eslint": "^8.56.0",
         "eslint-plugin-import": "^2.31.0",
         "husky": "^4.3.8",
@@ -76,6 +80,7 @@
         "debug-mcp": "yarn build && npx @modelcontextprotocol/inspector node dist/mcp-server/server.js",
         "hs": "yarn build && node ./dist/bin/hs",
         "hs-debug": "yarn build && NODE_DEBUG=http* node --inspect-brk ./dist/bin/hs",
+        "hs-proxy": "yarn build && HTTPS_PROXY=http://localhost:8181 NODE_TLS_REJECT_UNAUTHORIZED=0 node ./dist/bin/hs",
         "lint": "echo 'Linting is disabled for Blazar'",
         "lint:local": "eslint . && prettier --list-different './**/*.{ts,tsx,js,json}'",
         "list-all-commands": "yarn tsx ./scripts/get-all-commands.ts",

package/types/LocalDev.d.ts

@@ -6,6 +6,10 @@ import { Project } from '@hubspot/local-dev-lib/types/Project';
 import { ProjectConfig } from './Projects.js';
 import LocalDevState from '../lib/projects/localDev/LocalDevState.js';
 import { APP_INSTALLATION_STATES, LOCAL_DEV_UI_MESSAGE_RECEIVE_TYPES, LOCAL_DEV_SERVER_MESSAGE_TYPES } from '../lib/constants.js';
+import { ExitFunction } from './Yargs.js';
+export type LocalDevActions = {
+    exit: ExitFunction;
+};
 export type LocalDevStateConstructorOptions = {
     targetProjectAccountId: number;
     targetTestingAccountId: number;
@@ -19,6 +23,7 @@ export type LocalDevStateConstructorOptions = {
     };
     initialProjectProfileData: HSProfileVariables;
     env: Environment;
+    actions: LocalDevActions;
 };
 export type LocalDevDeployWebsocketMessage = {
     type: typeof LOCAL_DEV_UI_MESSAGE_RECEIVE_TYPES.DEPLOY;

package/types/Projects.d.ts

@@ -117,6 +117,25 @@ export type AppCardComponentConfig = {
     };
 };
 export type GenericComponentConfig = PublicAppComponentConfig | PrivateAppComponentConfig | AppCardComponentConfig;
+export type ProjectInfo = {
+    projectName: string;
+    platformVersion: string;
+    projectId: number;
+    deployedBuildId: number;
+    autoDeployEnabled: boolean;
+    projectUrl?: string;
+    app?: {
+        name: string;
+        id: number;
+        uid: string;
+        authType?: string;
+        distributionType?: string;
+    };
+    components: {
+        uid: string;
+        type: string;
+    }[];
+};
 export declare enum ComponentTypes {
     PrivateApp = "private-app",
     PublicApp = "public-app",

package/types/Yargs.d.ts

@@ -1,11 +1,25 @@
 import { Options, CommandModule, Argv } from 'yargs';
 import { CmsPublishMode } from '@hubspot/local-dev-lib/types/Files';
-export type CommonArgs = {
+import { EXIT_CODES } from '../lib/enums/exitCodes.js';
+import { ValueOf } from '@hubspot/local-dev-lib/types/Utils';
+import { UsageTrackingMeta } from '../lib/usageTracking.js';
+export type UsageTrackingMetaWithAccountId = UsageTrackingMeta & {
+    accountId?: number;
+};
+export type AddUsageMetadata = (meta: Omit<UsageTrackingMetaWithAccountId, 'successful'>) => void;
+export type UsageTrackingArgs = {
+    addUsageMetadata: AddUsageMetadata;
+    exit: ExitFunction;
+};
+type AccountMiddlewareArgs = {
     derivedAccountId: number;
     userProvidedAccount?: string;
+};
+type DebugArgs = {
     d: boolean;
     debug: boolean;
 };
+export type CommonArgs = AccountMiddlewareArgs & DebugArgs & UsageTrackingArgs;
 export type ConfigArgs = {
     c?: string;
     config?: string;
@@ -44,3 +58,6 @@ export interface YargsCommandModule<T, U> extends CommandModule<T, U> {
     builder: (yargs: Argv) => Promise<Argv<U>>;
 }
 export type YargsCommandModuleBucket = YargsCommandModule<unknown, object>;
+export type ExitCode = ValueOf<typeof EXIT_CODES>;
+export type ExitFunction = (code: ExitCode) => Promise<never>;
+export {};

package/api/__tests__/migrate.test.d.ts

@@ -1 +0,0 @@
-export {};