@hubspot/cli 7.0.11-experimental.0 → 7.1.0-beta.0

package/commands/auth.js

@@ -33,7 +33,7 @@ const ALLOWED_AUTH_METHODS = [
 const SUPPORTED_AUTHENTICATION_PROTOCOLS_TEXT = commaSeparatedValues(ALLOWED_AUTH_METHODS);
 exports.command = 'auth';
 exports.describe = i18n(`${i18nKey}.describe`, {
-    supportedProtocols: SUPPORTED_AUTHENTICATION_PROTOCOLS_TEXT,
+    configName: DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME,
 });
 exports.handler = async (options) => {
     const { authType: authTypeFlagValue, config: configFlagValue, qa, providedAccountId, } = options;

package/commands/project/deploy.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 // @ts-nocheck
+const { useV3Api } = require('../../lib/projects/buildAndDeploy');
 const chalk = require('chalk');
 const { addAccountOptions, addConfigOptions, addUseEnvironmentOptions, } = require('../../lib/commonOpts');
 const { trackCommandUsage } = require('../../lib/usageTracking');
@@ -83,7 +84,7 @@ exports.handler = async (options) => {
             logger.error(i18n(`${i18nKey}.errors.noBuildId`));
             return process.exit(EXIT_CODES.ERROR);
         }
-        const { data: deployResp } = await deployProject(derivedAccountId, projectName, buildIdToDeploy, options.useV3);
+        const { data: deployResp } = await deployProject(derivedAccountId, projectName, buildIdToDeploy, useV3Api(projectConfig?.platformVersion));
         if (!deployResp || deployResp.error) {
             logger.error(i18n(`${i18nKey}.errors.deploy`, {
                 details: deployResp.error.message,
@@ -123,11 +124,6 @@ exports.builder = yargs => {
             describe: i18n(`${i18nKey}.options.build.describe`),
             type: 'number',
         },
-        'use-v3': {
-            hidden: true,
-            type: 'boolean',
-            default: false,
-        },
     });
     yargs.example([
         ['$0 project deploy', i18n(`${i18nKey}.examples.default`)],

package/commands/project/upload.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 // @ts-nocheck
+const { useV3Api } = require('../../lib/projects/buildAndDeploy');
 const { addAccountOptions, addConfigOptions, addUseEnvironmentOptions, } = require('../../lib/commonOpts');
 const chalk = require('chalk');
 const { logger } = require('@hubspot/local-dev-lib/logger');
@@ -30,7 +31,7 @@ exports.handler = async (options) => {
         uploadCommand: true,
     });
     try {
-        const { result, uploadError } = await handleProjectUpload(derivedAccountId, projectConfig, projectDir, pollProjectBuildAndDeploy, message, options.translate);
+        const { result, uploadError } = await handleProjectUpload(derivedAccountId, projectConfig, projectDir, pollProjectBuildAndDeploy, message, useV3Api(projectConfig?.platformVersion));
         if (uploadError) {
             if (isSpecifiedError(uploadError, {
                 subCategory: PROJECT_ERROR_TYPES.PROJECT_LOCKED,
@@ -80,11 +81,6 @@ exports.builder = yargs => {
             type: 'string',
             default: '',
         },
-        translate: {
-            hidden: true,
-            type: 'boolean',
-            default: false,
-        },
     });
     yargs.example([['$0 project upload', i18n(`${i18nKey}.examples.default`)]]);
     addConfigOptions(yargs);

package/lang/en.lyaml

@@ -91,7 +91,7 @@ en:
             other: "Remove {{ count }} inactive accounts from the CLI config?"
           removeSuccess: "Removed {{ accountName }} from the CLI config."
     auth:
-      describe: "Configure authentication for a HubSpot account. Supported authentication protocols are {{ supportedProtocols }}."
+      describe: "Configure authentication for your HubSpot account. This will update the {{ configName }} file that stores your account information."
       errors:
         noConfigFileFound: "No config file was found. To create a new config file, use the \"hs init\" command."
         unsupportedAuthType: "Unsupported auth type: {{ type }}. The only supported authentication protocols are {{ supportedProtocols }}."
@@ -156,7 +156,7 @@ en:
             target:
               describe: "Medium to test against"
             verbose:
-              describe: "View a detailed output of the lighthouse sores"
+              describe: "View a detailed output of the lighthouse scores"
         getReactModule:
           describe: "Get a specified default React module."
           selectModulePrompt: "Select a React module to download"
@@ -188,11 +188,11 @@ en:
           folderOverwritePrompt: "The folder with name \"{{ folderName }}\" already exists. Overwrite?"
           errors:
             nameRequired: "The \"name\" argument is required when creating an API Sample."
-            noSamples: "Currently there are no samples available, please, try again later."
+            noSamples: "Currently there are no samples available. Please try again later."
           info:
             sampleChosen: "You've chosen {{ sampleType }} sample written on {{ sampleLanguage }} language"
           success:
-            sampleCreated: "Please, follow {{ filePath }}/README.md to find out how to run the sample"
+            sampleCreated: "Please follow {{ filePath }}/README.md to find out how to run the sample"
         module:
           errors:
             nameRequired: "The \"name\" argument is required when creating a Custom Module."
@@ -443,7 +443,7 @@ en:
           success:
             fetch: "Downloaded HubDB table {{ tableId }} to {{ path }}"
     init:
-      describe: "Initialize {{ configName }} for a HubSpot account."
+      describe: "Configure authentication for your HubSpot account. This will create a {{ configName }} file to store your account information."
       options:
         authType:
           describe: "Authentication mechanism"
@@ -1262,7 +1262,7 @@ en:
         selectScopes: "Select access scopes (see https://developers.hubspot.com/docs/methods/oauth2/initiate-oauth-integration#scopes)"
         personalAccessKeySetupTitle: "HubSpot Personal Access Key Setup"
         personalAccessKeyBrowserOpenPrep: "A personal access key is required to authenticate the CLI to interact with your HubSpot account. We'll open a secure page in your default browser where you can view and copy your personal access key."
-        personalAccessKeyBrowserOpenPrompt: "Open hubspot.com to copy your personal access key?"
+        personalAccessKeyBrowserOpenPrompt: "Open HubSpot to copy your personal access key?"
         logs:
           openingWebBrowser: "Opening {{ url }} in your web browser"
         errors:
@@ -1296,8 +1296,8 @@ en:
           blank: "The name may not be blank. Please try again."
           space: "The name may not contain spaces. Please try again."
       createApiSamplePrompt:
-        selectApiSampleApp: "Please, select API sample app"
-        selectLanguage: "Please, select sample app's language"
+        selectApiSampleApp: "Please select API sample app"
+        selectLanguage: "Please select sample app's language"
         errors:
           apiSampleAppRequired: "Please select API sample app"
           languageRequired: "Please select API sample app's language"
@@ -1372,8 +1372,8 @@ en:
       installPublicAppPrompt:
         explanation: "Local development requires this app to be installed in the target test account"
         reinstallExplanation: "This app's required scopes have been updated since it was last installed on the target test account. To avoid issues with local development, we recommend reinstalling the app with the updated scopes."
-        prompt: "Open hubspot.com to install this app?"
-        reinstallPrompt: "Open hubspot.com to reinstall this app?"
+        prompt: "Open HubSpot to install this app?"
+        reinstallPrompt: "Open HubSpot to reinstall this app?"
         decline: "To continue local development of this app, install it in your target test account and re-run {{#bold}}`hs project dev`{{/bold}}"
       selectHubDBTablePrompt:
         selectTable: "Select a HubDB table:"
@@ -1517,6 +1517,8 @@ en:
         inactiveSecondary: "Run {{ command }} to remove inactive accounts from your CLI config"
         unableToDetermine: "Unable to determine if the portal is active"
         pak:
+          incomplete: "Personal access key is valid, but there are more scopes available to your user that are not included in your key."
+          incompleteSecondary: "To add the available scopes, run {{ command }} and re-authenticate your account with a new key that has those scopes. Visit HubSpot to view selected and available scopes for your personal access key. {{ link }}"
           invalid: "Personal access key is invalid"
           invalidSecondary: "To get a new key, run {{ command }}, deactivate your access key, and generate a new one. Then use that new key to authenticate your account."
           valid: "Personal Access Key is valid. {{ link }}"

package/lib/buildAccount.d.ts

@@ -4,10 +4,10 @@ import { CLIAccount } from '@hubspot/local-dev-lib/types/Accounts';
 import { DeveloperTestAccount } from '@hubspot/local-dev-lib/types/developerTestAccounts';
 import { SandboxResponse } from '@hubspot/local-dev-lib/types/Sandbox';
 export declare function saveAccountToConfig(accountId: number | undefined, accountName: string, env: Environment, personalAccessKey?: string, force?: boolean): Promise<string>;
-export declare function buildDeveloperTestAccount(name: string, accountConfig: CLIAccount, env: Environment, portalLimit: number): Promise<DeveloperTestAccount>;
+export declare function buildDeveloperTestAccount(testAccountName: string, parentAccountConfig: CLIAccount, env: Environment, portalLimit: number): Promise<DeveloperTestAccount>;
 type SandboxType = typeof HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX | typeof HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX;
 type SandboxAccount = SandboxResponse & {
     name: string;
 };
-export declare function buildSandbox(name: string, accountConfig: CLIAccount, sandboxType: SandboxType, env: Environment, force?: boolean): Promise<SandboxAccount>;
+export declare function buildSandbox(sandboxName: string, parentAccountConfig: CLIAccount, sandboxType: SandboxType, env: Environment, force?: boolean): Promise<SandboxAccount>;
 export {};

package/lib/buildAccount.js

@@ -60,11 +60,11 @@ async function saveAccountToConfig(accountId, accountName, env, personalAccessKe
     logger_1.logger.log('');
     return validName;
 }
-async function buildDeveloperTestAccount(name, accountConfig, env, portalLimit) {
+async function buildDeveloperTestAccount(testAccountName, parentAccountConfig, env, portalLimit) {
     const i18nKey = 'lib.developerTestAccount.create.loading';
-    const id = (0, getAccountIdentifier_1.getAccountIdentifier)(accountConfig);
-    const accountId = (0, config_1.getAccountId)(id);
-    if (!accountId) {
+    const id = (0, getAccountIdentifier_1.getAccountIdentifier)(parentAccountConfig);
+    const parentAccountId = (0, config_1.getAccountId)(id);
+    if (!parentAccountId) {
         throw new Error((0, lang_1.i18n)(`${i18nKey}.fail`));
     }
     SpinniesManager_1.default.init({
@@ -73,16 +73,16 @@ async function buildDeveloperTestAccount(name, accountConfig, env, portalLimit)
     logger_1.logger.log('');
     SpinniesManager_1.default.add('buildDeveloperTestAccount', {
         text: (0, lang_1.i18n)(`${i18nKey}.add`, {
-            accountName: name,
+            accountName: testAccountName,
         }),
     });
     let developerTestAccount;
     try {
-        const { data } = await (0, developerTestAccounts_1.createDeveloperTestAccount)(accountId, name);
+        const { data } = await (0, developerTestAccounts_1.createDeveloperTestAccount)(parentAccountId, testAccountName);
         developerTestAccount = data;
         SpinniesManager_1.default.succeed('buildDeveloperTestAccount', {
             text: (0, lang_1.i18n)(`${i18nKey}.succeed`, {
-                accountName: name,
+                accountName: testAccountName,
                 accountId: developerTestAccount.id,
             }),
         });
@@ -91,13 +91,13 @@ async function buildDeveloperTestAccount(name, accountConfig, env, portalLimit)
         (0, index_1.debugError)(e);
         SpinniesManager_1.default.fail('buildDeveloperTestAccount', {
             text: (0, lang_1.i18n)(`${i18nKey}.fail`, {
-                accountName: name,
+                accountName: testAccountName,
             }),
         });
-        (0, developerTestAccounts_2.handleDeveloperTestAccountCreateError)(e, accountId, env, portalLimit);
+        (0, developerTestAccounts_2.handleDeveloperTestAccountCreateError)(e, parentAccountId, env, portalLimit);
     }
     try {
-        await saveAccountToConfig(accountId, name, env);
+        await saveAccountToConfig(developerTestAccount.id, testAccountName, env);
     }
     catch (err) {
         (0, index_1.logError)(err);
@@ -105,7 +105,7 @@ async function buildDeveloperTestAccount(name, accountConfig, env, portalLimit)
     }
     return developerTestAccount;
 }
-async function buildSandbox(name, accountConfig, sandboxType, env, force = false) {
+async function buildSandbox(sandboxName, parentAccountConfig, sandboxType, env, force = false) {
     let i18nKey;
     if (sandboxType === config_2.HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX) {
         i18nKey = 'lib.sandbox.create.loading.standard';
@@ -113,9 +113,9 @@ async function buildSandbox(name, accountConfig, sandboxType, env, force = false
     else {
         i18nKey = 'lib.sandbox.create.loading.developer';
     }
-    const id = (0, getAccountIdentifier_1.getAccountIdentifier)(accountConfig);
-    const accountId = (0, config_1.getAccountId)(id);
-    if (!accountId) {
+    const id = (0, getAccountIdentifier_1.getAccountIdentifier)(parentAccountConfig);
+    const parentAccountId = (0, config_1.getAccountId)(id);
+    if (!parentAccountId) {
         throw new Error((0, lang_1.i18n)(`${i18nKey}.fail`));
     }
     SpinniesManager_1.default.init({
@@ -124,17 +124,17 @@ async function buildSandbox(name, accountConfig, sandboxType, env, force = false
     logger_1.logger.log('');
     SpinniesManager_1.default.add('buildSandbox', {
         text: (0, lang_1.i18n)(`${i18nKey}.add`, {
-            accountName: name,
+            accountName: sandboxName,
         }),
     });
     let sandbox;
     try {
         const sandboxApiType = sandboxes_1.SANDBOX_API_TYPE_MAP[sandboxType];
-        const { data } = await (0, sandboxHubs_1.createSandbox)(accountId, name, sandboxApiType);
-        sandbox = { name, ...data };
+        const { data } = await (0, sandboxHubs_1.createSandbox)(parentAccountId, sandboxName, sandboxApiType);
+        sandbox = { name: sandboxName, ...data };
         SpinniesManager_1.default.succeed('buildSandbox', {
             text: (0, lang_1.i18n)(`${i18nKey}.succeed`, {
-                accountName: name,
+                accountName: sandboxName,
                 accountId: sandbox.sandbox.sandboxHubId,
             }),
         });
@@ -143,13 +143,13 @@ async function buildSandbox(name, accountConfig, sandboxType, env, force = false
         (0, index_1.debugError)(e);
         SpinniesManager_1.default.fail('buildSandbox', {
             text: (0, lang_1.i18n)(`${i18nKey}.fail`, {
-                accountName: name,
+                accountName: sandboxName,
             }),
         });
-        (0, sandboxes_1.handleSandboxCreateError)(e, env, name, accountId);
+        (0, sandboxes_1.handleSandboxCreateError)(e, env, sandboxName, parentAccountId);
     }
     try {
-        await saveAccountToConfig(accountId, name, env, sandbox.personalAccessKey, force);
+        await saveAccountToConfig(sandbox.sandbox.sandboxHubId, sandboxName, env, sandbox.personalAccessKey, force);
     }
     catch (err) {
         (0, index_1.logError)(err);

package/lib/doctor/Doctor.js

@@ -91,16 +91,29 @@ class Doctor {
         const localI18nKey = `${i18nKey}.accountChecks`;
         try {
             await (0, personalAccessKey_1.accessTokenForPersonalAccessKey)(this.accountId, true);
+            const pakScopes = new Set(await (0, personalAccessKey_1.scopesOnAccessToken)(this.accountId));
+            const missingScopes = (await (0, personalAccessKey_1.authorizedScopesForPortalAndUser)(this.accountId)).filter((data) => data.userAuthorized && !pakScopes.has(data.scopeGroup.name));
             this.diagnosis?.addCLIConfigSection({
                 type: 'success',
                 message: i18n(`${localI18nKey}.active`),
             });
-            this.diagnosis?.addCLIConfigSection({
-                type: 'success',
-                message: i18n(`${localI18nKey}.pak.valid`, {
-                    link: uiLink(i18n(`${localI18nKey}.pak.viewScopes`), `${(0, urls_1.getHubSpotWebsiteOrigin)(this.diagnosticInfoBuilder?.env || 'PROD')}/personal-access-key/${this.diagnosticInfo?.account.accountId}`),
-                }),
-            });
+            const linkToPakUI = uiLink(i18n(`${localI18nKey}.pak.viewScopes`), `${(0, urls_1.getHubSpotWebsiteOrigin)(this.diagnosticInfoBuilder?.env || 'PROD')}/personal-access-key/${this.diagnosticInfo?.account.accountId}`);
+            if (missingScopes.length > 0) {
+                this.diagnosis?.addCLIConfigSection({
+                    type: 'warning',
+                    message: i18n(`${localI18nKey}.pak.incomplete`),
+                    secondaryMessaging: i18n(`${localI18nKey}.pak.incompleteSecondary`, {
+                        command: (0, ui_1.uiCommandReference)(`hs auth`),
+                        link: linkToPakUI,
+                    }),
+                });
+            }
+            else {
+                this.diagnosis?.addCLIConfigSection({
+                    type: 'success',
+                    message: i18n(`${localI18nKey}.pak.valid`, { link: linkToPakUI }),
+                });
+            }
         }
         catch (error) {
             const portalNotActive = (0, index_1.isSpecifiedError)(error, {

package/lib/errorHandlers/index.js

@@ -11,7 +11,6 @@ const index_1 = require("@hubspot/local-dev-lib/errors/index");
 const suppressError_1 = require("./suppressError");
 const lang_1 = require("../lang");
 const util_1 = __importDefault(require("util"));
-const axios_1 = require("axios");
 const i18nKey = 'lib.errorHandlers.index';
 function logError(error, context) {
     debugError(error, context);
@@ -50,11 +49,9 @@ function debugError(error, context) {
     else {
         logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.errorOccurred`, { error: String(error) }));
     }
-    if (error instanceof Error && error.cause) {
+    if (error instanceof Error && error.cause && !(0, index_1.isHubSpotHttpError)(error)) {
         logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.errorCause`, {
-            cause: (0, axios_1.isAxiosError)(error.cause)
-                ? `${error.cause.message}`
-                : util_1.default.inspect(error.cause, false, null, true),
+            cause: util_1.default.inspect(error.cause, false, null, true),
         }));
     }
     if (context) {

package/lib/projects/buildAndDeploy.d.ts

@@ -2,6 +2,7 @@ import { FileResult } from 'tmp';
 import { Build } from '@hubspot/local-dev-lib/types/Build';
 import { Deploy } from '@hubspot/local-dev-lib/types/Deploy';
 import { ProjectConfig, ProjectTask, ProjectPollResult } from '../../types/Projects';
+export declare function useV3Api(platformVersion?: string | null): boolean;
 type PollTaskStatusFunction<T extends ProjectTask> = (accountId: number, taskName: string, taskId: number, deployedBuildId: number | null, silenceLogs: boolean) => Promise<T>;
 export declare const pollBuildStatus: PollTaskStatusFunction<Build>;
 export declare const pollDeployStatus: PollTaskStatusFunction<Deploy>;

package/lib/projects/buildAndDeploy.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pollDeployStatus = exports.pollBuildStatus = void 0;
+exports.useV3Api = useV3Api;
 exports.displayWarnLogs = displayWarnLogs;
 exports.pollProjectBuildAndDeploy = pollProjectBuildAndDeploy;
 const chalk_1 = __importDefault(require("chalk"));
@@ -19,6 +20,13 @@ const i18nKey = 'lib.projectBuildAndDeploy';
 const SPINNER_STATUS = {
     SPINNING: 'spinning',
 };
+function useV3Api(platformVersion) {
+    if (!platformVersion || typeof platformVersion !== 'string') {
+        return false;
+    }
+    const [year, minor] = platformVersion.split('.');
+    return Number(year) >= 2025 && Number(minor) >= 1;
+}
 function getSubtasks(task) {
     if ('subbuildStatuses' in task) {
         return task.subbuildStatuses;

package/lib/projects/index.js

@@ -223,12 +223,6 @@ async function ensureProjectExists(accountId, projectName, { forceCreate = false
                 return { projectExists: false };
             }
         }
-        if ((0, index_1.isSpecifiedError)(err, {
-            statusCode: 401,
-        })) {
-            logger_1.logger.error(err.message);
-            process.exit(exitCodes_1.EXIT_CODES.ERROR);
-        }
         (0, index_2.logError)(err, new index_2.ApiErrorContext({ accountId }));
         process.exit(exitCodes_1.EXIT_CODES.ERROR);
     }

package/lib/projects/structure.d.ts

@@ -1,8 +1,11 @@
-import { ComponentTypes, Component, PublicAppComponentConfig, PrivateAppComponentConfig, AppCardComponentConfig } from '../../types/Projects';
+import { ComponentTypes, Component, GenericComponentConfig, PublicAppComponentConfig, PrivateAppComponentConfig, AppCardComponentConfig } from '../../types/Projects';
 export declare const CONFIG_FILES: {
     [k in ComponentTypes]: string;
 };
+export declare function getComponentTypeFromConfigFile(configFile: string): ComponentTypes | null;
+export declare function loadConfigFile(configPath: string): GenericComponentConfig | null;
 export declare function getAppCardConfigs(appConfig: PublicAppComponentConfig | PrivateAppComponentConfig, appPath: string): Array<AppCardComponentConfig>;
+export declare function getIsLegacyApp(appConfig: GenericComponentConfig, appPath: string): boolean;
 export declare function findProjectComponents(projectSourceDir: string): Promise<Array<Component>>;
 export declare function getProjectComponentTypes(components: Array<Component>): {
     [key in ComponentTypes]?: boolean;

package/lib/projects/structure.js

@@ -34,7 +34,10 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CONFIG_FILES = void 0;
+exports.getComponentTypeFromConfigFile = getComponentTypeFromConfigFile;
+exports.loadConfigFile = loadConfigFile;
 exports.getAppCardConfigs = getAppCardConfigs;
+exports.getIsLegacyApp = getIsLegacyApp;
 exports.findProjectComponents = findProjectComponents;
 exports.getProjectComponentTypes = getProjectComponentTypes;
 exports.getComponentUid = getComponentUid;

package/package.json

@@ -1,12 +1,12 @@
 {
     "name": "@hubspot/cli",
-    "version": "7.0.11-experimental.0",
+    "version": "7.1.0-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": "0.1.1-experimental.0",
-        "@hubspot/project-parsing-lib": "0.0.3-experimental.0",
+        "@hubspot/local-dev-lib": "3.3.0",
+        "@hubspot/project-parsing-lib": "0.0.4",
         "@hubspot/serverless-dev-runtime": "7.0.2",
         "@hubspot/theme-preview-dev-server": "0.0.10",
         "@hubspot/ui-extensions-dev-server": "0.8.42",