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

package/lang/en.d.ts

@@ -17,6 +17,26 @@ export declare const commands: {
     readonly account: {
         readonly describe: "Commands for managing configured accounts.";
         readonly subcommands: {
+            readonly auth: {
+                readonly describe: "Configure authentication for your HubSpot account.";
+                readonly verboseDescribe: `Configure authentication for a HubSpot account. This will create or update the global config file at ${string} that stores your account information.
+
+The authentication method is ${string}, which is an access token tied to a specific user account.
+
+Global configuration replaces hubspot.config.yml, and you will be prompted to migrate your existing config if one exists.`;
+                readonly options: {
+                    readonly account: "HubSpot account to authenticate";
+                };
+                readonly errors: {
+                    readonly failedToUpdateConfig: "Failed to update the configuration file. Please try again.";
+                    readonly migrationNotConfirmed: `Did not migrate your configuration file. Run ${string} to update your existing config, or use ${string} to switch to the new global configuration.`;
+                    readonly mergeNotConfirmed: `Did not merge configuration files. When you are ready to merge the deprecated config file with the global config file, run ${string}.`;
+                };
+                readonly success: {
+                    readonly configFileCreated: (configPath: string) => string;
+                    readonly configFileUpdated: (accountId: number) => string;
+                };
+            };
             readonly list: {
                 readonly accounts: `${string}:`;
                 readonly defaultAccount: (account: string) => string;
@@ -141,6 +161,21 @@ export declare const commands: {
     readonly config: {
         readonly describe: "Commands for managing the CLI config file.";
         readonly subcommands: {
+            readonly migrate: {
+                readonly describe: `Migrate from the deprecated hubspot.config.yml file to the new global config file at ${string}.`;
+                readonly verboseDescribe: "This command will create or update the global configuration file in your root directory. It will archive the current config as archived.hubspot.config.yml.";
+                readonly errors: {
+                    readonly noConfigToMigrate: "No hubspot.config.yml was found. There is nothing to migrate.";
+                    readonly configNotFound: (configPath: string) => string;
+                };
+                readonly options: {
+                    readonly force: "Bypass prompts and overwrite any conflicting values in the global config with the deprecated config values.";
+                };
+                readonly examples: {
+                    readonly default: `Migrate from the deprecated hubspot.config.yml file to the new global config file at ${string}`;
+                    readonly configFlag: `Migrate a specific config file (specified with the config flag) to the new global config file at ${string}`;
+                };
+            };
             readonly set: {
                 readonly describe: "Set various configuration options within the hubspot CLI config file.";
                 readonly promptMessage: "Select a config option to update";
@@ -843,7 +878,13 @@ Local development of unified apps is currently only compatible with accounts tha
             };
             readonly logs: {
                 readonly success: (projectName: string, projectDest: string) => string;
-                readonly welcomeMessage: "Welcome to HubSpot Developer Projects!";
+                readonly welcomeMessage: `
+${string}`;
+            };
+            readonly prompts: {
+                readonly parentComponents: "[--project-base] What would you like in your project?";
+                readonly emptyProject: "Empty Project";
+                readonly app: "App";
             };
             readonly examples: {
                 readonly default: "Create a new project";
@@ -862,6 +903,21 @@ Local development of unified apps is currently only compatible with accounts tha
                 readonly templateSource: {
                     readonly describe: "Path to custom GitHub repository from which to create project template";
                 };
+                readonly platformVersion: {
+                    readonly describe: "The target platform version for the new project.";
+                };
+                readonly projectBase: {
+                    readonly describe: "The top level component to include in the project.";
+                };
+                readonly distribution: {
+                    readonly describe: "How the app will be distributed.";
+                };
+                readonly auth: {
+                    readonly describe: "Authentication model for the application.";
+                };
+                readonly features: {
+                    readonly describe: "Features to include in the project. Only valid if project-base is app";
+                };
             };
         };
         readonly migrateApp: {
@@ -947,11 +1003,23 @@ Local development of unified apps is currently only compatible with accounts tha
                 readonly type: {
                     readonly describe: "The path to the component type's location within the hubspot-project-components Github repo: https://github.com/HubSpot/hubspot-project-components";
                 };
+                readonly distribution: {
+                    readonly describe: "The distribution method for the application.";
+                };
+                readonly auth: {
+                    readonly describe: "The authentication type for the application.";
+                };
+                readonly features: {
+                    readonly describe: "Which features to include with the application.";
+                };
             };
             readonly creatingComponent: (projectName: string) => string;
-            readonly success: (componentName: string) => string;
+            readonly success: (componentName: string, multiple?: boolean) => string;
             readonly error: {
                 readonly failedToDownloadComponent: "Failed to download project component. Please try again later.";
+                readonly maxExceeded: (maxCount: number) => string;
+                readonly authTypeNotAllowed: (authType: string) => string;
+                readonly distributionNotAllowed: (dist: string) => string;
                 readonly locationInProject: "This command must be run from within a project directory.";
                 readonly failedToFetchComponentList: "Failed to fetch the list of available components. Please try again later.";
                 readonly projectContainsPublicApp: "This project contains a public app. This command is currently only compatible with projects that contain private apps.";
@@ -1184,15 +1252,13 @@ Local development of unified apps is currently only compatible with accounts tha
         };
     };
     readonly remove: {
-        readonly describe: "Delete a file or folder from HubSpot.";
-        readonly deleted: (path: string, accountId: string) => string;
+        readonly describe: "Delete a file or folder from the HubSpot CMS.";
+        readonly deleted: (path: string, accountId: number) => string;
         readonly errors: {
-            readonly deleteFailed: (path: string, accountId: string) => string;
+            readonly deleteFailed: (path: string, accountId: number) => string;
         };
         readonly positionals: {
-            readonly path: {
-                readonly describe: "Remote hubspot path";
-            };
+            readonly path: "Remote hubspot path";
         };
     };
     readonly sandbox: {
@@ -1434,9 +1500,7 @@ Local development of unified apps is currently only compatible with accounts tha
                 };
                 readonly success: (themePath: string, selectorsPath: string) => string;
                 readonly positionals: {
-                    readonly path: {
-                        readonly describe: "The path of the theme you'd like to generate an editor-preview.json for.";
-                    };
+                    readonly path: "The path of the theme you'd like to generate an editor-preview.json for.";
                 };
             };
             readonly marketplaceValidate: {
@@ -1467,25 +1531,16 @@ Local development of unified apps is currently only compatible with accounts tha
                 readonly errors: {
                     readonly invalidPath: (path: string) => string;
                     readonly noThemeComponents: "Your project has no theme components available to preview.";
+                    readonly uploadFailed: (src: string, dest: string) => string;
                 };
                 readonly positionals: {
-                    readonly src: {
-                        readonly describe: "Path to the local directory your theme is in, relative to your current working directory";
-                    };
-                    readonly dest: {
-                        readonly 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.";
-                    };
+                    readonly src: "Path to the local directory your theme is in, relative to your current working directory";
+                    readonly 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.";
                 };
                 readonly options: {
-                    readonly notify: {
-                        readonly describe: "Log to specified file when a watch task is triggered and after workers have gone idle. Ex. --notify path/to/file";
-                    };
-                    readonly noSsl: {
-                        readonly describe: "Disable HTTPS";
-                    };
-                    readonly port: {
-                        readonly describe: "The port on which to start the local server";
-                    };
+                    readonly notify: "Log to specified file when a watch task is triggered and after workers have gone idle. Ex. --notify path/to/file";
+                    readonly noSsl: "Disable HTTPS";
+                    readonly port: "The port on which to start the local server";
                 };
                 readonly initialUploadProgressBar: {
                     readonly start: "Starting...";
@@ -1509,11 +1564,6 @@ Local development of unified apps is currently only compatible with accounts tha
                 readonly logs: {
                     readonly validatingModule: (path: string) => string;
                 };
-                readonly options: {
-                    readonly json: {
-                        readonly describe: "Output raw json data";
-                    };
-                };
                 readonly results: {
                     readonly required: "Required validation results:";
                     readonly recommended: "Recommended validation results:";
@@ -1524,9 +1574,7 @@ Local development of unified apps is currently only compatible with accounts tha
                     readonly noErrors: "No errors";
                 };
                 readonly positionals: {
-                    readonly src: {
-                        readonly describe: "Path to the module within the Design Manager.";
-                    };
+                    readonly src: "Path to the module within the Design Manager.";
                 };
             };
         };
@@ -1539,85 +1587,53 @@ Local development of unified apps is currently only compatible with accounts tha
             readonly invalidPath: (path: string) => string;
             readonly uploadFailed: (src: string, dest: string) => string;
             readonly someFilesFailed: (dest: string) => string;
-            readonly deleteFailed: (path: string, accountId: string) => string;
+            readonly deleteFailed: (path: string, accountId: number) => string;
         };
         readonly options: {
-            readonly options: {
-                readonly describe: "Options to pass to javascript fields files";
-            };
-            readonly saveOutput: {
-                readonly describe: "If true, saves all output from javascript fields files as 'fields.output.json'.";
-            };
-            readonly convertFields: {
-                readonly describe: "If true, converts any javascript fields files contained in module folder or project root.";
-            };
-            readonly clean: {
-                readonly 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.";
-            };
-            readonly force: {
-                readonly describe: "Skips confirmation prompts when doing a clean upload.";
-            };
+            readonly options: "Options to pass to javascript fields files";
+            readonly saveOutput: "If true, saves all output from javascript fields files as 'fields.output.json'.";
+            readonly convertFields: "If true, converts any javascript fields files contained in module folder or project root.";
+            readonly 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.";
+            readonly force: "Skips confirmation prompts when doing a clean upload.";
         };
         readonly previewUrl: (previewUrl: string) => string;
         readonly positionals: {
-            readonly src: {
-                readonly describe: "Path to the local file, relative to your current working directory.";
-            };
-            readonly dest: {
-                readonly describe: "Path in HubSpot Design Tools, can be a net new path.";
-            };
+            readonly src: "Path to the local file, relative to your current working directory.";
+            readonly dest: "Path in HubSpot Design Tools, can be a net new path.";
         };
         readonly success: {
-            readonly fileUploaded: (src: string, dest: string, accountId: string) => string;
+            readonly fileUploaded: (src: string, dest: string, accountId: number) => string;
             readonly uploadComplete: (dest: string) => string;
         };
-        readonly uploading: (src: string, dest: string, accountId: string) => string;
+        readonly uploading: (src: string, dest: string, accountId: number) => string;
         readonly notUploaded: (src: string) => string;
-        readonly cleaning: (filePath: string, accountId: string) => string;
-        readonly confirmCleanUpload: (filePath: string, accountId: string) => string;
+        readonly cleaning: (filePath: string, accountId: number) => string;
+        readonly confirmCleanUpload: (filePath: string, accountId: number) => string;
     };
     readonly watch: {
         readonly describe: "Watch a directory on your computer for changes and upload the changed files to the HubSpot CMS.";
         readonly errors: {
-            readonly folderFailed: (src: string, dest: string, accountId: string) => string;
-            readonly fileFailed: (file: string, dest: string, accountId: string) => string;
+            readonly folderFailed: (src: string, dest: string, accountId: number) => string;
+            readonly fileFailed: (file: string, dest: string, accountId: number) => string;
             readonly destinationRequired: "A destination directory needs to be passed";
             readonly invalidPath: (path: string) => string;
         };
         readonly options: {
-            readonly disableInitial: {
-                readonly describe: "Disable the initial upload when watching a directory (default)";
-            };
-            readonly initialUpload: {
-                readonly describe: "Upload directory before watching for updates";
-            };
-            readonly notify: {
-                readonly describe: "Log to specified file when a watch task is triggered and after workers have gone idle. Ex. --notify path/to/file";
-            };
-            readonly remove: {
-                readonly describe: "Will cause watch to delete files in your HubSpot account that are not found locally.";
-            };
-            readonly convertFields: {
-                readonly describe: "If true, converts any javascript fields files contained in module folder or project root.";
-            };
-            readonly saveOutput: {
-                readonly describe: "If true, saves all output from javascript fields files as 'fields.output.json'.";
-            };
-            readonly options: {
-                readonly describe: "Options to pass to javascript fields files";
-            };
+            readonly disableInitial: "Disable the initial upload when watching a directory (default)";
+            readonly initialUpload: "Upload directory before watching for updates";
+            readonly notify: "Log to specified file when a watch task is triggered and after workers have gone idle. Ex. --notify path/to/file";
+            readonly remove: "Will cause watch to delete files in your HubSpot account that are not found locally.";
+            readonly convertFields: "If true, converts any javascript fields files contained in module folder or project root.";
+            readonly saveOutput: "If true, saves all output from javascript fields files as 'fields.output.json'.";
+            readonly options: "Options to pass to javascript fields files";
         };
         readonly positionals: {
-            readonly src: {
-                readonly describe: "Path to the local directory your files are in, relative to your current working directory";
-            };
-            readonly dest: {
-                readonly describe: "Path in HubSpot Design Tools. Can be a net new path";
-            };
+            readonly src: "Path to the local directory your files are in, relative to your current working directory";
+            readonly dest: "Path in HubSpot Design Tools. Can be a net new path";
         };
         readonly warnings: {
-            readonly disableInitial: () => string;
-            readonly initialUpload: () => string;
+            readonly disableInitial: `Passing the "${string}" option is no longer necessary. Running "${string}" no longer uploads the watched directory by default.`;
+            readonly initialUpload: `To upload the directory run "${string}" beforehand or add the "${string}" option when running "${string}".`;
             readonly notUploaded: (path: string) => string;
         };
     };
@@ -2284,6 +2300,7 @@ export declare const lib: {
             readonly unknownMessageType: (type: string) => string;
             readonly invalidJSON: (data: string) => string;
             readonly portManagerNotRunning: (prefix: string) => string;
+            readonly originNotAllowed: (origin?: string) => string;
         };
         readonly logs: {
             readonly startup: (port: number) => string;
@@ -2371,10 +2388,21 @@ Run ${string} to upgrade to version ${string}`;
     };
     readonly projects: {
         readonly create: {
+            readonly prompt: {
+                readonly marketPlaceDistribution: "On the HubSpot marketplace";
+                readonly privateDistribution: "Privately";
+                readonly distribution: "[--distribution] How would you like to distribute your application?";
+                readonly auth: "[--auth] What type of authentication would you like your application to use";
+                readonly staticAuth: "Static Auth";
+                readonly oauth: "OAuth";
+            };
             readonly errors: {
                 readonly 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.";
                 readonly 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.";
-                readonly 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\"].";
+                readonly 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\"].";
+                readonly exceededMaxNumberOfApps: (max: number) => string;
+                readonly unableToParseAppConfig: (file: string) => string;
+                readonly invalidAuthDistCombo: (authType: string, distribution: string) => string;
             };
         };
         readonly validateProjectConfig: {
@@ -2579,6 +2607,24 @@ Run ${string} to upgrade to version ${string}`;
             };
         };
     };
+    readonly configMigrate: {
+        readonly deprecatedConfigWarning: (deprecatedConfigPath: string) => string;
+        readonly handleMigration: {
+            readonly description: (archivedConfigName: string) => string;
+            readonly confirmPrompt: "Migrate the deprecated config to the global location?";
+            readonly success: "Your deprecated config file has been successfully migrated.";
+        };
+        readonly handleMergeConfigProperties: {
+            readonly mergeConflictMessage: (count: number, propertyList: string) => string;
+            readonly mergeConfigConflictPrompt: (property: string, newValue: string, oldValue: string) => string;
+        };
+        readonly handleMerge: {
+            readonly description: (archivedConfigName: string) => string;
+            readonly confirmPrompt: "Merge the deprecated config into your global config?";
+            readonly skippedExistingAccounts: (accountIds: (string | number)[]) => string;
+            readonly success: "Your deprecated config file has been successfully merged with the global config file.";
+        };
+    };
     readonly prompts: {
         readonly projectDevTargetAccountPrompt: {
             readonly createNewSandboxOption: "<Test on a new development sandbox>";
@@ -2716,7 +2762,9 @@ Run ${string} to upgrade to version ${string}`;
             readonly enterName: "[--name] Give your component a name: ";
             readonly errors: {
                 readonly nameRequired: "A component name is required";
+                readonly componentRequired: "Must select a feature to add";
                 readonly invalidType: (type: string) => string;
+                readonly cannotAddFeature: (feature: string, reasons: string | boolean) => string;
             };
         };
         readonly secretPrompt: {