@hubspot/cli 7.7.1-experimental.0 → 7.7.2-experimental.0

package/lang/en.js

@@ -5,11 +5,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.lib = exports.commands = void 0;
 const chalk_1 = __importDefault(require("chalk"));
+const projects_1 = require("@hubspot/local-dev-lib/constants/projects");
+const auth_1 = require("@hubspot/local-dev-lib/constants/auth");
+const config_1 = require("@hubspot/local-dev-lib/constants/config");
 const ui_1 = require("../lib/ui");
 const urls_1 = require("../lib/projects/urls");
-const ui_2 = require("../lib/ui");
-const projects_1 = require("@hubspot/local-dev-lib/constants/projects");
 const constants_1 = require("../lib/constants");
+const v3_1 = require("../lib/projects/create/v3");
 exports.commands = {
     generalErrors: {
         srcIsProject: (src, command) => `"${src}" is in a project folder. Did you mean "hs project ${command}"?`,
@@ -29,6 +31,22 @@ exports.commands = {
     account: {
         describe: 'Commands for managing configured accounts.',
         subcommands: {
+            auth: {
+                describe: 'Configure authentication for your HubSpot account.',
+                verboseDescribe: `Configure authentication for a HubSpot account. This will create or update the global config file at ${config_1.GLOBAL_CONFIG_PATH} that stores your account information.\n\nThe authentication method is ${chalk_1.default.bold(auth_1.PERSONAL_ACCESS_KEY_AUTH_METHOD.value)}, which is an access token tied to a specific user account.\n\nGlobal configuration replaces ${config_1.DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME}, and you will be prompted to migrate your existing config if one exists.`,
+                options: {
+                    account: 'HubSpot account to authenticate',
+                },
+                errors: {
+                    failedToUpdateConfig: 'Failed to update the configuration file. Please try again.',
+                    migrationNotConfirmed: `Did not migrate your configuration file. Run ${(0, ui_1.uiCommandReference)('hs auth')} to update your existing config, or use ${(0, ui_1.uiCommandReference)('hs config migrate')} to switch to the new global configuration.`,
+                    mergeNotConfirmed: `Did not merge configuration files. When you are ready to merge the deprecated config file with the global config file, run ${(0, ui_1.uiCommandReference)('hs config migrate')}.`,
+                },
+                success: {
+                    configFileCreated: (configPath) => `Created config file "${configPath}"`,
+                    configFileUpdated: (accountId) => `Connected account ${(0, ui_1.uiAccountDescription)(accountId)} and set it as the default account`,
+                },
+            },
             list: {
                 accounts: `${chalk_1.default.bold('Accounts')}:`,
                 defaultAccount: (account) => `${chalk_1.default.bold('Default account')}: ${account}`,
@@ -153,6 +171,21 @@ exports.commands = {
     config: {
         describe: 'Commands for managing the CLI config file.',
         subcommands: {
+            migrate: {
+                describe: `Migrate from the deprecated ${config_1.DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME} file to the new global config file at ${config_1.GLOBAL_CONFIG_PATH}.`,
+                verboseDescribe: `This command will create or update the global configuration file in your root directory. It will archive the current config as ${config_1.ARCHIVED_HUBSPOT_CONFIG_YAML_FILE_NAME}.`,
+                errors: {
+                    noConfigToMigrate: `No ${config_1.DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME} was found. There is nothing to migrate.`,
+                    configNotFound: (configPath) => `A configuration file at ${configPath} could not be found. Please try again with a valid file path.`,
+                },
+                options: {
+                    force: 'Bypass prompts and overwrite any conflicting values in the global config with the deprecated config values.',
+                },
+                examples: {
+                    default: `Migrate from the deprecated ${config_1.DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME} file to the new global config file at ${config_1.GLOBAL_CONFIG_PATH}`,
+                    configFlag: `Migrate a specific config file (specified with the config flag) to the new global config file at ${config_1.GLOBAL_CONFIG_PATH}`,
+                },
+            },
             set: {
                 describe: 'Set various configuration options within the hubspot CLI config file.',
                 promptMessage: 'Select a config option to update',
@@ -846,8 +879,13 @@ exports.commands = {
                 cannotNestProjects: (projectDir) => `A project already exists at ${projectDir}. Projects cannot be nested within other projects. Please choose a different destination and try again.`,
             },
             logs: {
-                success: (projectName, projectDest) => `Project ${chalk_1.default.bold(projectName)} was successfully created in ${projectDest}`,
-                welcomeMessage: 'Welcome to HubSpot Developer Projects!',
+                success: (projectName, projectDest) => `\nProject ${chalk_1.default.bold(projectName)} was successfully created in ${projectDest}`,
+                welcomeMessage: `\n${chalk_1.default.bold('Welcome to HubSpot Developer Projects!')}`,
+            },
+            prompts: {
+                parentComponents: '[--project-base] What would you like in your project?',
+                emptyProject: 'Empty Project',
+                app: 'App',
             },
             examples: {
                 default: 'Create a new project',
@@ -866,6 +904,21 @@ exports.commands = {
                 templateSource: {
                     describe: 'Path to custom GitHub repository from which to create project template',
                 },
+                platformVersion: {
+                    describe: 'The target platform version for the new project.',
+                },
+                projectBase: {
+                    describe: 'The top level component to include in the project.',
+                },
+                distribution: {
+                    describe: 'How the app will be distributed.',
+                },
+                auth: {
+                    describe: 'Authentication model for the application.',
+                },
+                features: {
+                    describe: `Features to include in the project. Only valid if project-base is ${v3_1.PROJECT_WITH_APP}`,
+                },
             },
         },
         migrateApp: {
@@ -951,11 +1004,23 @@ exports.commands = {
                 type: {
                     describe: "The path to the component type's location within the hubspot-project-components Github repo: https://github.com/HubSpot/hubspot-project-components",
                 },
+                distribution: {
+                    describe: 'The distribution method for the application.',
+                },
+                auth: {
+                    describe: 'The authentication type for the application.',
+                },
+                features: {
+                    describe: 'Which features to include with the application.',
+                },
             },
-            creatingComponent: (projectName) => `Adding a new component to ${chalk_1.default.bold(projectName)}`,
-            success: (componentName) => `${componentName} was successfully added to your project.`,
+            creatingComponent: (projectName) => `\nAdding a new component to ${chalk_1.default.bold(projectName)}\n`,
+            success: (componentName, multiple = false) => `${componentName} ${multiple ? 'were' : 'was'} successfully added to your app.`,
             error: {
                 failedToDownloadComponent: 'Failed to download project component. Please try again later.',
+                maxExceeded: (maxCount) => `This project has the maximum allowed(${maxCount})`,
+                authTypeNotAllowed: (authType) => `Auth type '${authType}' not allowed.`,
+                distributionNotAllowed: (dist) => `Distribution '${dist}' not allowed.`,
                 locationInProject: 'This command must be run from within a project directory.',
                 failedToFetchComponentList: 'Failed to fetch the list of available components. Please try again later.',
                 projectContainsPublicApp: 'This project contains a public app. This command is currently only compatible with projects that contain private apps.',
@@ -1186,15 +1251,13 @@ exports.commands = {
         },
     },
     remove: {
-        describe: 'Delete a file or folder from HubSpot.',
-        deleted: (path, accountId) => `Deleted "${path}" from account ${accountId}`,
+        describe: 'Delete a file or folder from the HubSpot CMS.',
+        deleted: (path, accountId) => `Deleted "${path}" from account ${(0, ui_1.uiAccountDescription)(accountId)}`,
         errors: {
-            deleteFailed: (path, accountId) => `Deleting "${path}" from account ${accountId} failed`,
+            deleteFailed: (path, accountId) => `Deleting "${path}" from account ${(0, ui_1.uiAccountDescription)(accountId)} failed`,
         },
         positionals: {
-            path: {
-                describe: 'Remote hubspot path',
-            },
+            path: 'Remote hubspot path',
         },
     },
     sandbox: {
@@ -1436,9 +1499,7 @@ exports.commands = {
                 },
                 success: (themePath, selectorsPath) => `Selectors generated for ${themePath}, please double check the selectors generated at ${selectorsPath} before uploading the theme.`,
                 positionals: {
-                    path: {
-                        describe: "The path of the theme you'd like to generate an editor-preview.json for.",
-                    },
+                    path: "The path of the theme you'd like to generate an editor-preview.json for.",
                 },
             },
             marketplaceValidate: {
@@ -1469,25 +1530,16 @@ exports.commands = {
                 errors: {
                     invalidPath: (path) => `The path "${path}" is not a path to a directory`,
                     noThemeComponents: 'Your project has no theme components available to preview.',
+                    uploadFailed: (src, dest) => `Uploading file "${src}" to "${dest}" failed`,
                 },
                 positionals: {
-                    src: {
-                        describe: 'Path to the local directory your theme is in, relative to your current working directory',
-                    },
-                    dest: {
-                        describe: 'Path in HubSpot Design Tools. Can be a net new path. If you wish to preview a site page using your theme changes it must match the path of the theme used by the site.',
-                    },
+                    src: 'Path to the local directory your theme is in, relative to your current working directory',
+                    dest: 'Path in HubSpot Design Tools. Can be a net new path. If you wish to preview a site page using your theme changes it must match the path of the theme used by the site.',
                 },
                 options: {
-                    notify: {
-                        describe: 'Log to specified file when a watch task is triggered and after workers have gone idle. Ex. --notify path/to/file',
-                    },
-                    noSsl: {
-                        describe: 'Disable HTTPS',
-                    },
-                    port: {
-                        describe: 'The port on which to start the local server',
-                    },
+                    notify: 'Log to specified file when a watch task is triggered and after workers have gone idle. Ex. --notify path/to/file',
+                    noSsl: 'Disable HTTPS',
+                    port: 'The port on which to start the local server',
                 },
                 initialUploadProgressBar: {
                     start: 'Starting...',
@@ -1511,11 +1563,6 @@ exports.commands = {
                 logs: {
                     validatingModule: (path) => `Validating module "${path}" \n`,
                 },
-                options: {
-                    json: {
-                        describe: 'Output raw json data',
-                    },
-                },
                 results: {
                     required: 'Required validation results:',
                     recommended: 'Recommended validation results:',
@@ -1526,9 +1573,7 @@ exports.commands = {
                     noErrors: 'No errors',
                 },
                 positionals: {
-                    src: {
-                        describe: 'Path to the module within the Design Manager.',
-                    },
+                    src: 'Path to the module within the Design Manager.',
                 },
             },
         },
@@ -1541,86 +1586,54 @@ exports.commands = {
             invalidPath: (path) => `The path "${path}" is not a path to a file or folder`,
             uploadFailed: (src, dest) => `Uploading file "${src}" to "${dest}" failed`,
             someFilesFailed: (dest) => `One or more files failed to upload to "${dest}" in the Design Manager`,
-            deleteFailed: (path, accountId) => `Deleting "${path}" from account ${accountId} failed`,
+            deleteFailed: (path, accountId) => `Deleting "${path}" from account ${(0, ui_1.uiAccountDescription)(accountId)} failed`,
         },
         options: {
-            options: {
-                describe: 'Options to pass to javascript fields files',
-            },
-            saveOutput: {
-                describe: "If true, saves all output from javascript fields files as 'fields.output.json'.",
-            },
-            convertFields: {
-                describe: 'If true, converts any javascript fields files contained in module folder or project root.',
-            },
-            clean: {
-                describe: 'Will delete the destination directory and its contents before uploading. This will also clear the global content associated with any global partial templates and modules.',
-            },
-            force: {
-                describe: 'Skips confirmation prompts when doing a clean upload.',
-            },
+            options: 'Options to pass to javascript fields files',
+            saveOutput: "If true, saves all output from javascript fields files as 'fields.output.json'.",
+            convertFields: 'If true, converts any javascript fields files contained in module folder or project root.',
+            clean: 'Will delete the destination directory and its contents before uploading. This will also clear the global content associated with any global partial templates and modules.',
+            force: 'Skips confirmation prompts when doing a clean upload.',
         },
         previewUrl: (previewUrl) => `To preview this theme, visit: ${previewUrl}`,
         positionals: {
-            src: {
-                describe: 'Path to the local file, relative to your current working directory.',
-            },
-            dest: {
-                describe: 'Path in HubSpot Design Tools, can be a net new path.',
-            },
+            src: 'Path to the local file, relative to your current working directory.',
+            dest: 'Path in HubSpot Design Tools, can be a net new path.',
         },
         success: {
-            fileUploaded: (src, dest, accountId) => `Uploaded file from "${src}" to "${dest}" in the Design Manager of account ${accountId}`,
+            fileUploaded: (src, dest, accountId) => `Uploaded file from "${src}" to "${dest}" in the Design Manager of account ${(0, ui_1.uiAccountDescription)(accountId)}`,
             uploadComplete: (dest) => `Uploading files to "${dest}" in the Design Manager is complete`,
         },
-        uploading: (src, dest, accountId) => `Uploading files from "${src}" to "${dest}" in the Design Manager of account ${accountId}`,
+        uploading: (src, dest, accountId) => `Uploading files from "${src}" to "${dest}" in the Design Manager of account ${(0, ui_1.uiAccountDescription)(accountId)}`,
         notUploaded: (src) => `There was an error processing "${src}". The file has not been uploaded.`,
-        cleaning: (filePath, accountId) => `Removing "${filePath}" from account ${accountId} and uploading local...`,
-        confirmCleanUpload: (filePath, accountId) => `You are about to delete the directory "${filePath}" and its contents on HubSpot account ${accountId} before uploading. This will also clear the global content associated with any global partial templates and modules. Are you sure you want to do this?`,
+        cleaning: (filePath, accountId) => `Removing "${filePath}" from account ${(0, ui_1.uiAccountDescription)(accountId)} and uploading local...`,
+        confirmCleanUpload: (filePath, accountId) => `You are about to delete the directory "${filePath}" and its contents on HubSpot account ${(0, ui_1.uiAccountDescription)(accountId)} before uploading. This will also clear the global content associated with any global partial templates and modules. Are you sure you want to do this?`,
     },
     watch: {
         describe: 'Watch a directory on your computer for changes and upload the changed files to the HubSpot CMS.',
         errors: {
-            folderFailed: (src, dest, accountId) => `Initial uploading of folder "${src}" to "${dest}" in account ${accountId} had failures`,
-            fileFailed: (file, dest, accountId) => `Upload of file "${file}" to "${dest}" in account ${accountId} failed`,
+            folderFailed: (src, dest, accountId) => `Initial uploading of folder "${src}" to "${dest}" in account ${(0, ui_1.uiAccountDescription)(accountId)} had failures`,
+            fileFailed: (file, dest, accountId) => `Upload of file "${file}" to "${dest}" in account ${(0, ui_1.uiAccountDescription)(accountId)} failed`,
             destinationRequired: 'A destination directory needs to be passed',
             invalidPath: (path) => `The "${path}" is not a path to a directory`,
         },
         options: {
-            disableInitial: {
-                describe: 'Disable the initial upload when watching a directory (default)',
-            },
-            initialUpload: {
-                describe: 'Upload directory before watching for updates',
-            },
-            notify: {
-                describe: 'Log to specified file when a watch task is triggered and after workers have gone idle. Ex. --notify path/to/file',
-            },
-            remove: {
-                describe: 'Will cause watch to delete files in your HubSpot account that are not found locally.',
-            },
-            convertFields: {
-                describe: 'If true, converts any javascript fields files contained in module folder or project root.',
-            },
-            saveOutput: {
-                describe: "If true, saves all output from javascript fields files as 'fields.output.json'.",
-            },
-            options: {
-                describe: 'Options to pass to javascript fields files',
-            },
+            disableInitial: 'Disable the initial upload when watching a directory (default)',
+            initialUpload: 'Upload directory before watching for updates',
+            notify: 'Log to specified file when a watch task is triggered and after workers have gone idle. Ex. --notify path/to/file',
+            remove: 'Will cause watch to delete files in your HubSpot account that are not found locally.',
+            convertFields: 'If true, converts any javascript fields files contained in module folder or project root.',
+            saveOutput: "If true, saves all output from javascript fields files as 'fields.output.json'.",
+            options: 'Options to pass to javascript fields files',
         },
         positionals: {
-            src: {
-                describe: 'Path to the local directory your files are in, relative to your current working directory',
-            },
-            dest: {
-                describe: 'Path in HubSpot Design Tools. Can be a net new path',
-            },
+            src: 'Path to the local directory your files are in, relative to your current working directory',
+            dest: 'Path in HubSpot Design Tools. Can be a net new path',
         },
         warnings: {
-            disableInitial: () => `Passing the "${chalk_1.default.bold('--disable-initial')}" option is no longer necessary. Running "${chalk_1.default.bold('hs watch')}" no longer uploads the watched directory by default.`,
-            initialUpload: () => `To upload the directory run "${chalk_1.default.bold('hs upload')}" beforehand or add the "${chalk_1.default.bold('--initial-upload')}" option when running "${chalk_1.default.bold('hs watch')}".`,
-            notUploaded: (path) => `The "${chalk_1.default.bold('hs watch')}" command no longer uploads the watched directory when started. The directory "${path}" was not uploaded.`,
+            disableInitial: `Passing the "${chalk_1.default.bold('--disable-initial')}" option is no longer necessary. Running "${(0, ui_1.uiCommandReference)('hs watch')}" no longer uploads the watched directory by default.`,
+            initialUpload: `To upload the directory run "${(0, ui_1.uiCommandReference)('hs upload')}" beforehand or add the "${chalk_1.default.bold('--initial-upload')}" option when running "${(0, ui_1.uiCommandReference)('hs watch')}".`,
+            notUploaded: (path) => `The "${(0, ui_1.uiCommandReference)('hs watch')}" command no longer uploads the watched directory when started. The directory "${path}" was not uploaded.`,
         },
     },
     convertFields: {
@@ -2241,7 +2254,7 @@ exports.lib = {
         noComponents: 'There are no components in this project.',
         betaMessage: 'HubSpot projects local development',
         learnMoreLocalDevServer: (0, ui_1.uiLink)('Learn more about the projects local dev server', 'https://developers.hubspot.com/docs/platform/project-cli-commands#start-a-local-development-server'),
-        running: (projectName, accountIdentifier) => chalk_1.default.hex(ui_2.UI_COLORS.SORBET)(`Running ${chalk_1.default.bold(projectName)} locally on ${accountIdentifier}, waiting for changes ...`),
+        running: (projectName, accountIdentifier) => chalk_1.default.hex(ui_1.UI_COLORS.SORBET)(`Running ${chalk_1.default.bold(projectName)} locally on ${accountIdentifier}, waiting for changes ...`),
         quitHelper: `Press ${chalk_1.default.bold('q')} to stop the local dev server`,
         viewProjectLink: (name, accountId) => (0, ui_1.uiLink)('View project in HubSpot', (0, urls_1.getProjectDetailUrl)(name, accountId) || ''),
         viewTestAccountLink: 'View developer test account in HubSpot',
@@ -2286,6 +2299,7 @@ exports.lib = {
             unknownMessageType: (type) => `Unsupported message received. Unknown message type: ${type}`,
             invalidJSON: (data) => `Unsupported message received. Invalid JSON: ${data}`,
             portManagerNotRunning: (prefix) => `${prefix}Error: PortManagerServing must be running before starting LocalDevWebsocketServer.`,
+            originNotAllowed: (origin) => `Connections from ${origin ? `origin ${origin}` : 'this origin'} are not allowed.`,
         },
         logs: {
             startup: (port) => `LocalDevWebsocketServer running on port ${port}`,
@@ -2372,10 +2386,21 @@ exports.lib = {
     },
     projects: {
         create: {
+            prompt: {
+                marketPlaceDistribution: 'On the HubSpot marketplace',
+                privateDistribution: 'Privately',
+                distribution: '[--distribution] How would you like to distribute your application?',
+                auth: '[--auth] What type of authentication would you like your application to use',
+                staticAuth: 'Static Auth',
+                oauth: 'OAuth',
+            },
             errors: {
                 noProjectsInConfig: 'Unable to find any projects in the target repository\'s config.json file. Please ensure that there is a "projects" array in the config file.',
                 missingConfigFileTemplateSource: 'Failed to fetch the config.json file from the target repository. Please ensure that there is a valid config.json file at the root of the repository and try again.',
-                missingPropertiesInConfig: 'Found misconfigured projects in the target repository\'s config.json file. Please ensure that each project in the target repository\'s config.json file contains the following properties: ["name", "label", "path", "insertPath"].',
+                missingPropertiesInConfig: 'Found misconfigured projects in the target repository\'s config.json file. Please ensure that each project in the target repository\'s config.json file contains the following properties: ["name", "label", "path"].',
+                exceededMaxNumberOfApps: (max) => `This project currently has the maximum number of apps: ${max}`,
+                unableToParseAppConfig: (file) => `Unable to parse app file: ${file}`,
+                invalidAuthDistCombo: (authType, distribution) => `Invalid distribution and auth combination. Apps with distribution '${distribution}' must have auth '${authType}'`,
             },
         },
         validateProjectConfig: {
@@ -2578,6 +2603,24 @@ exports.lib = {
             },
         },
     },
+    configMigrate: {
+        deprecatedConfigWarning: (deprecatedConfigPath) => `This command applies to global configuration, but we detected a deprecated config at ${deprecatedConfigPath}.`,
+        handleMigration: {
+            description: (archivedConfigName) => `We will migrate your deprecated config file to the new global configuration file location. This will create a new global configuration file in your root directory. Then it will archive the deprecated config as ${archivedConfigName} for you to manually cleanup at your convenience.`,
+            confirmPrompt: 'Migrate the deprecated config to the global location?',
+            success: 'Your deprecated config file has been successfully migrated.',
+        },
+        handleMergeConfigProperties: {
+            mergeConflictMessage: (count, propertyList) => `Conflict${count > 1 ? 's' : ''} detected for ${chalk_1.default.bold(propertyList)}.`,
+            mergeConfigConflictPrompt: (property, newValue, oldValue) => `Change ${property} from ${newValue} to ${oldValue}?`,
+        },
+        handleMerge: {
+            description: (archivedConfigName) => `We will automatically merge the contents of your deprecated config file into your global configuration file. This will merge the configured accounts and settings into the global config. Then it will archive the deprecated config as ${archivedConfigName} for you to manually cleanup at your convenience.`,
+            confirmPrompt: 'Merge the deprecated config into your global config?',
+            skippedExistingAccounts: (accountIds) => `The following accounts were not merged because they already exist in the global config:${accountIds.map(id => `\n- ${(0, ui_1.uiAccountDescription)(Number(id))}`).join('')}`,
+            success: 'Your deprecated config file has been successfully merged with the global config file.',
+        },
+    },
     prompts: {
         projectDevTargetAccountPrompt: {
             createNewSandboxOption: '<Test on a new development sandbox>',
@@ -2715,7 +2758,9 @@ exports.lib = {
             enterName: '[--name] Give your component a name: ',
             errors: {
                 nameRequired: 'A component name is required',
+                componentRequired: 'Must select a feature to add',
                 invalidType: (type) => `[--type] Could not find type "${type}". Please choose an available type:`,
+                cannotAddFeature: (feature, reasons) => `Cannot Add feature '${feature}' to project for the following reasons: ${reasons}`,
             },
         },
         secretPrompt: {