@hubspot/cli 8.8.0 → 8.9.0-beta.1

package/commands/account/auth.d.ts

@@ -1,8 +1,10 @@
 import { CommonArgs, ConfigArgs, YargsCommandModule } from '../../types/Yargs.js';
 type AccountAuthArgs = CommonArgs & ConfigArgs & {
     disableTracking?: boolean;
-} & {
     personalAccessKey?: string;
+    default?: boolean;
+    name?: string;
+    useDefaultName?: boolean;
 };
 declare const accountAuthCommand: YargsCommandModule<unknown, AccountAuthArgs>;
 export default accountAuthCommand;

package/commands/account/auth.js

@@ -20,7 +20,7 @@ const authType = PERSONAL_ACCESS_KEY_AUTH_METHOD.value;
 const describe = commands.account.subcommands.auth.describe;
 const command = 'auth';
 async function handler(args) {
-    const { disableTracking, personalAccessKey: providedPersonalAccessKey, userProvidedAccount, exit, } = args;
+    const { disableTracking, personalAccessKey: providedPersonalAccessKey, userProvidedAccount, default: setAsDefaultAccount, name: accountName, useDefaultName: useDefaultAccountName, exit, } = args;
     let parsedUserProvidedAccountId;
     if (userProvidedAccount) {
         try {
@@ -39,6 +39,9 @@ async function handler(args) {
         env: args.qa ? ENVIRONMENTS.QA : ENVIRONMENTS.PROD,
         providedPersonalAccessKey,
         accountId: parsedUserProvidedAccountId,
+        setAsDefaultAccount,
+        accountName,
+        useDefaultAccountName,
     });
     if (!updatedConfig) {
         if (!disableTracking) {
@@ -76,7 +79,20 @@ function accountAuthBuilder(yargs) {
             hidden: false,
             alias: 'pak',
         },
+        default: {
+            describe: commands.account.subcommands.auth.options.default,
+            type: 'boolean',
+        },
+        name: {
+            describe: commands.account.subcommands.auth.options.name,
+            type: 'string',
+        },
+        'use-default-name': {
+            describe: commands.account.subcommands.auth.options.useDefaultName,
+            type: 'boolean',
+        },
     });
+    yargs.conflicts('name', 'use-default-name');
     return yargs;
 }
 const builder = makeYargsBuilder(accountAuthBuilder, command, commands.account.subcommands.auth.verboseDescribe, {

package/commands/app/logDetails.d.ts

@@ -0,0 +1,9 @@
+import { AccountArgs, CommonArgs, ConfigArgs, YargsCommandModule } from '../../types/Yargs.js';
+export type AppLogDetailsArgs = CommonArgs & ConfigArgs & AccountArgs & {
+    logId: string;
+    app?: number;
+    type?: string;
+    json?: boolean;
+};
+declare const logDetailsCommand: YargsCommandModule<unknown, AppLogDetailsArgs>;
+export default logDetailsCommand;

package/commands/app/logDetails.js

@@ -0,0 +1,86 @@
+import { EXIT_CODES } from '../../lib/enums/exitCodes.js';
+import { makeWrappedYargsHandler } from '../../lib/yargs/makeWrappedYargsHandler.js';
+import { makeYargsBuilder } from '../../lib/yargsUtils.js';
+import { commands } from '../../lang/en.js';
+import { selectAppPrompt } from '../../lib/prompts/selectAppPrompt.js';
+import { listPrompt } from '../../lib/prompts/promptUtils.js';
+import { getTypeChoices, handleLogDetailsRequest, SYSTEM_TYPE_CHOICES, toSystemType, } from '../../lib/app/logs.js';
+import { logError } from '../../lib/errorHandlers/index.js';
+const command = 'log-details <log-id>';
+const describe = commands.app.subcommands.logDetails.describe;
+const handler = async (options) => {
+    const { logId, app: appIdArg, type: typeArg, derivedAccountId, exit, addUsageMetadata, } = options;
+    addUsageMetadata({ type: typeArg });
+    let appId = appIdArg;
+    if (!appId) {
+        const selectedApp = await selectAppPrompt(derivedAccountId);
+        if (!selectedApp) {
+            return exit(EXIT_CODES.ERROR);
+        }
+        appId = selectedApp.id;
+    }
+    let rawType = typeArg;
+    if (!rawType) {
+        rawType = await listPrompt(commands.app.subcommands.logDetails.prompts.selectType, {
+            choices: getTypeChoices(),
+        });
+        if (!rawType) {
+            return exit(EXIT_CODES.ERROR);
+        }
+    }
+    const systemType = toSystemType(rawType);
+    try {
+        await handleLogDetailsRequest(derivedAccountId, appId, logId, systemType, options);
+        return exit(EXIT_CODES.SUCCESS);
+    }
+    catch (e) {
+        logError(e);
+        return exit(EXIT_CODES.ERROR);
+    }
+};
+function logDetailsBuilder(yargs) {
+    yargs
+        .positional('log-id', {
+        describe: commands.app.subcommands.logDetails.positionals.logId,
+        type: 'string',
+        demandOption: true,
+    })
+        .options({
+        app: {
+            describe: commands.app.subcommands.logDetails.options.appId,
+            type: 'number',
+        },
+        type: {
+            describe: commands.app.subcommands.logDetails.options.type,
+            type: 'string',
+            choices: SYSTEM_TYPE_CHOICES,
+        },
+        json: {
+            describe: commands.app.subcommands.logDetails.options.json,
+            type: 'boolean',
+        },
+    });
+    yargs.example([
+        [
+            '$0 app log-details abc-123-def --app=123456 --type=webhooks',
+            commands.app.subcommands.logDetails.examples.basic,
+        ],
+        [
+            '$0 app log-details abc-123-def --app=123456 --type=webhooks --json',
+            commands.app.subcommands.logDetails.examples.json,
+        ],
+    ]);
+    return yargs;
+}
+const builder = makeYargsBuilder(logDetailsBuilder, command, commands.app.subcommands.logDetails.verboseDescribe, {
+    useGlobalOptions: true,
+    useConfigOptions: true,
+    useAccountOptions: true,
+});
+const logDetailsCommand = {
+    command,
+    describe,
+    builder,
+    handler: makeWrappedYargsHandler('app-log-details', handler),
+};
+export default logDetailsCommand;

package/commands/app/logs.d.ts

@@ -0,0 +1,13 @@
+import { AccountArgs, CommonArgs, ConfigArgs, EnvironmentArgs, YargsCommandModule } from '../../types/Yargs.js';
+export type AppLogsArgs = CommonArgs & ConfigArgs & AccountArgs & EnvironmentArgs & {
+    app?: number;
+    type?: string;
+    json?: boolean;
+    limit?: number;
+    since?: string;
+    tail?: boolean;
+    errorsOnly?: boolean;
+    compact?: boolean;
+};
+declare const logsCommand: YargsCommandModule<unknown, AppLogsArgs>;
+export default logsCommand;

package/commands/app/logs.js

@@ -0,0 +1,122 @@
+import { EXIT_CODES } from '../../lib/enums/exitCodes.js';
+import { makeWrappedYargsHandler } from '../../lib/yargs/makeWrappedYargsHandler.js';
+import { makeYargsBuilder } from '../../lib/yargsUtils.js';
+import { commands } from '../../lang/en.js';
+import { selectAppPrompt } from '../../lib/prompts/selectAppPrompt.js';
+import { listPrompt } from '../../lib/prompts/promptUtils.js';
+import { getTypeChoices, handleLogsRequest, SYSTEM_TYPE_CHOICES, tailAppLogs, toSystemType, } from '../../lib/app/logs.js';
+import { logError } from '../../lib/errorHandlers/index.js';
+const command = 'logs';
+const describe = commands.app.subcommands.logs.describe;
+const handler = async (options) => {
+    const { app: appIdArg, type, tail, derivedAccountId, exit, addUsageMetadata, } = options;
+    addUsageMetadata({
+        type,
+    });
+    let appId = appIdArg;
+    if (!appId) {
+        const selectedApp = await selectAppPrompt(derivedAccountId);
+        if (!selectedApp) {
+            return exit(EXIT_CODES.ERROR);
+        }
+        appId = selectedApp.id;
+    }
+    let rawType = type;
+    if (!rawType) {
+        rawType = await listPrompt(commands.app.subcommands.logs.prompts.selectType, {
+            choices: getTypeChoices(),
+        });
+        if (!rawType) {
+            return exit(EXIT_CODES.ERROR);
+        }
+    }
+    const systemType = toSystemType(rawType);
+    try {
+        if (tail) {
+            await tailAppLogs(derivedAccountId, appId, systemType, options);
+        }
+        else {
+            await handleLogsRequest(derivedAccountId, appId, systemType, options);
+        }
+        return exit(EXIT_CODES.SUCCESS);
+    }
+    catch (e) {
+        logError(e);
+        return exit(EXIT_CODES.ERROR);
+    }
+};
+function logsBuilder(yargs) {
+    yargs
+        .options({
+        app: {
+            describe: commands.app.subcommands.logs.options.appId,
+            type: 'number',
+        },
+        type: {
+            describe: commands.app.subcommands.logs.options.type,
+            type: 'string',
+            choices: SYSTEM_TYPE_CHOICES,
+        },
+        json: {
+            describe: commands.app.subcommands.logs.options.json,
+            type: 'boolean',
+        },
+        limit: {
+            describe: commands.app.subcommands.logs.options.limit,
+            type: 'number',
+        },
+        since: {
+            describe: commands.app.subcommands.logs.options.since,
+            type: 'string',
+        },
+        tail: {
+            describe: commands.app.subcommands.logs.options.tail,
+            type: 'boolean',
+        },
+        'errors-only': {
+            describe: commands.app.subcommands.logs.options.errorsOnly,
+            type: 'boolean',
+        },
+        compact: {
+            describe: commands.app.subcommands.logs.options.compact,
+            type: 'boolean',
+        },
+    })
+        .conflicts('tail', ['limit', 'json']);
+    yargs.example([
+        [
+            '$0 app logs --app=123456 --type=webhooks',
+            commands.app.subcommands.logs.examples.basic,
+        ],
+        [
+            '$0 app logs --app=123456 --type=api-call --since=1h',
+            commands.app.subcommands.logs.examples.since,
+        ],
+        [
+            '$0 app logs --app=123456 --type=serverless-execution --tail',
+            commands.app.subcommands.logs.examples.tail,
+        ],
+        [
+            '$0 app logs --app=123456 --type=crm-extensibility-card --json',
+            commands.app.subcommands.logs.examples.json,
+        ],
+        [
+            '$0 app logs --app=123456 --type=webhooks --compact',
+            commands.app.subcommands.logs.examples.compact,
+        ],
+    ]);
+    return yargs;
+}
+const builder = makeYargsBuilder(logsBuilder, command, commands.app.subcommands.logs.verboseDescribe, {
+    useGlobalOptions: true,
+    useConfigOptions: true,
+    useAccountOptions: true,
+    useEnvironmentOptions: true,
+});
+const logsCommand = {
+    command,
+    describe,
+    builder,
+    handler: makeWrappedYargsHandler('app-logs', handler),
+};
+export default logsCommand;

package/commands/app.js

@@ -1,11 +1,18 @@
 import migrateCommand from './app/migrate.js';
 import appSecretCommand from './app/secret.js';
+import logsCommand from './app/logs.js';
+import logDetailsCommand from './app/logDetails.js';
 import { makeYargsBuilder } from '../lib/yargsUtils.js';
 import { commands } from '../lang/en.js';
 const command = ['app', 'apps'];
 const describe = commands.app.describe;
 function appBuilder(yargs) {
-    yargs.command(migrateCommand).command(appSecretCommand).demandCommand(1, '');
+    yargs
+        .command(migrateCommand)
+        .command(appSecretCommand)
+        .command(logsCommand)
+        .command(logDetailsCommand)
+        .demandCommand(1, '');
     return yargs;
 }
 const builder = makeYargsBuilder(appBuilder, command, describe);

package/commands/auth.js

@@ -6,7 +6,7 @@ import { getAccessToken, updateConfigWithAccessToken, } from '@hubspot/local-dev
 import { updateConfigAccount, getConfigFilePath, globalConfigFileExists, } from '@hubspot/local-dev-lib/config';
 import { commaSeparatedValues, toKebabCase } from '@hubspot/local-dev-lib/text';
 import { promptUser } from '../lib/prompts/promptUtils.js';
-import { personalAccessKeyPrompt, OAUTH_FLOW, } from '../lib/prompts/personalAccessKeyPrompt.js';
+import { legacyPersonalAccessKeyPrompt as personalAccessKeyPrompt, OAUTH_FLOW, } from '../lib/prompts/personalAccessKeyPrompt.js';
 import { cliAccountNamePrompt } from '../lib/prompts/accountNamePrompt.js';
 import { setAsDefaultAccountPrompt } from '../lib/prompts/setAsDefaultAccountPrompt.js';
 import { setCLILogLevel } from '../lib/commonOpts.js';

package/commands/init.js

@@ -15,7 +15,7 @@ import { debugError, logError } from '../lib/errorHandlers/index.js';
 import { isPromptExitError } from '../lib/errors/PromptExitError.js';
 import { trackAuthAction } from '../lib/usageTracking.js';
 import { promptUser } from '../lib/prompts/promptUtils.js';
-import { OAUTH_FLOW, personalAccessKeyPrompt, } from '../lib/prompts/personalAccessKeyPrompt.js';
+import { OAUTH_FLOW, legacyPersonalAccessKeyPrompt as personalAccessKeyPrompt, } from '../lib/prompts/personalAccessKeyPrompt.js';
 import { cliAccountNamePrompt } from '../lib/prompts/accountNamePrompt.js';
 import { authenticateWithOauth } from '../lib/oauth.js';
 import { EXIT_CODES } from '../lib/enums/exitCodes.js';

package/commands/project/lint.js

@@ -29,6 +29,7 @@ async function handler(args) {
         const lintLocations = await getUieLintablePackageJsonLocations(projectConfig);
         const locationsReadyToLint = [];
         const locationsNeedingPackages = new Map();
+        let skippedDirectoryCount = 0;
         for (const lintLocation of lintLocations) {
             if (areAllLintPackagesInstalled(lintLocation)) {
                 locationsReadyToLint.push(lintLocation);
@@ -80,6 +81,9 @@ async function handler(args) {
             }
             else {
                 uiLogger.warn(commands.project.lint.skippingDirectoriesWarning(relativeLocations));
+                if (installMissingDeps === false) {
+                    skippedDirectoryCount = relativeLocations.length;
+                }
             }
         }
         if (locationsReadyToLint.length > 0) {
@@ -162,6 +166,10 @@ async function handler(args) {
                 return exit(EXIT_CODES.ERROR);
             }
         }
+        if (skippedDirectoryCount > 0) {
+            uiLogger.error(commands.project.lint.skippedDirectoriesError(skippedDirectoryCount));
+            return exit(EXIT_CODES.ERROR);
+        }
     }
     catch (e) {
         if (isPromptExitError(e)) {

package/lang/en.d.ts

@@ -115,6 +115,9 @@ export declare const commands: {
                 options: {
                     account: string;
                     personalAccessKey: string;
+                    default: string;
+                    name: string;
+                    useDefaultName: string;
                 };
                 errors: {
                     invalidAccountIdProvided: string;
@@ -2020,6 +2023,7 @@ export declare const commands: {
             failedToReadPackageJson: (packageJsonPath: string) => string;
             installLintPackagesPrompt: (directories: string[], missingPackages: string[]) => string;
             skippingDirectoriesWarning: (directories: string[]) => string;
+            skippedDirectoriesError: (directoryCount: number) => string;
             deprecatedEslintConfigWarning: (details: {
                 path: string;
                 files: string[];
@@ -2376,6 +2380,111 @@ export declare const commands: {
                     };
                 };
             };
+            logs: {
+                describe: string;
+                verboseDescribe: string;
+                options: {
+                    appId: string;
+                    type: string;
+                    json: string;
+                    limit: string;
+                    since: string;
+                    tail: string;
+                    errorsOnly: string;
+                    compact: string;
+                };
+                errors: {
+                    noLogs: string;
+                    noApps: string;
+                };
+                prompts: {
+                    selectType: string;
+                };
+                examples: {
+                    basic: string;
+                    since: string;
+                    tail: string;
+                    json: string;
+                    compact: string;
+                };
+                outputMessages: {
+                    viewInHubSpot: (url: string) => string;
+                    tableHeaders: {
+                        appId: string;
+                        type: string;
+                        logsFound: string;
+                    };
+                    logDetails: {
+                        id: string;
+                        duration: string;
+                        portal: string;
+                        trace: string;
+                        error: string;
+                        viewDetails: (logId: string, appId: number, systemType: string) => string;
+                        viewInUI: (url: string) => string;
+                    };
+                    tailMessages: {
+                        following: (appId: number) => string;
+                        stop: string;
+                    };
+                };
+            };
+            logDetails: {
+                describe: string;
+                verboseDescribe: string;
+                positionals: {
+                    logId: string;
+                };
+                options: {
+                    appId: string;
+                    type: string;
+                    json: string;
+                };
+                errors: {
+                    noApps: string;
+                };
+                prompts: {
+                    selectType: string;
+                };
+                examples: {
+                    basic: string;
+                    json: string;
+                };
+                outputMessages: {
+                    viewInHubSpot: (url: string) => string;
+                    logDetailsHeader: string;
+                    basicInfo: {
+                        id: string;
+                        timestamp: string;
+                        status: string;
+                        duration: string;
+                        systemType: string;
+                    };
+                    contextInfo: {
+                        header: string;
+                        portalId: string;
+                        traceId: string;
+                        function: string;
+                        location: string;
+                        card: string;
+                        userId: string;
+                    };
+                    requestResponse: {
+                        header: string;
+                        requestBody: string;
+                        responseBody: string;
+                    };
+                    errorInfo: {
+                        header: string;
+                        errorType: string;
+                        errorMessage: string;
+                        stackTrace: string;
+                    };
+                    additionalInfo: {
+                        header: string;
+                    };
+                };
+            };
         };
     };
     secret: {
@@ -3247,6 +3356,13 @@ export declare const lib: {
         appDataNotFound: string;
         oauthAppRedirectUrlError: (redirectUrl: string) => string;
     };
+    accountAuthWebsocket: {
+        logs: {
+            openingWebBrowser: (url: string) => string;
+            spinner: string;
+            received: string;
+        };
+    };
     CLIWebsocketServer: {
         errors: {
             portManagerNotRunning: (prefix?: string) => string;
@@ -3254,6 +3370,7 @@ export declare const lib: {
             missingTypeField: (data: string) => string;
             invalidJSON: (data: string) => string;
             unknownMessageType: (type: string) => string;
+            failedToBindEphemeralPort: (prefix?: string) => string;
         };
         logs: {
             startup: (port: number) => string;
@@ -3722,7 +3839,7 @@ export declare const lib: {
             functionName: (projectName: string) => string;
         };
         setAsDefaultAccountPrompt: {
-            setAsDefaultAccountMessage: string;
+            setAsDefaultAccountMessage: (accountName: string) => string;
             setAsDefaultAccount: (accountName: string) => string;
             keepingCurrentDefault: (accountName: string | number) => string;
         };