@hubspot/cli 4.0.1-beta.0 → 4.0.1-beta.3

package/README.md

@@ -133,7 +133,7 @@ hs hubdb delete <id or name>
 
 ## Authentication
 
-There are three ways that the tools can authenticate with HubSpot.
+There are two ways that the tools can authenticate with HubSpot.
 
 ### Personal Access Key (recommended)
 
@@ -146,20 +146,6 @@ There are three ways that the tools can authenticate with HubSpot.
 3. Select `OAuth2` and follow the steps
 
 _**Note:** The Account ID used should be the Test Account ID (not the developer app ID). Client ID and Client Secret are from the developer app._
-
-### HubSpot API Key
-
-1. [Set up an API Key for the Account](https://knowledge.hubspot.com/articles/kcs_article/integrations/how-do-i-get-my-hubspot-api-key)
-2. Edit the [hubspot.config.yml](../../docs/HubspotConfigFile.md) file to set the `authType` for the account to `apikey` and add `apiKey` as shown below:
-
-```yaml
-defaultPortal: DEV
-portals:
-  - name: DEV
-    portalId: 123
-    authType: apikey
-    apiKey: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
-```
 ### Exit Codes
 
 The CLI will exit with one of the following exit codes:

package/commands/accounts/info.js

@@ -0,0 +1,53 @@
+const { logger } = require('@hubspot/cli-lib/logger');
+const { getAccountConfig } = require('@hubspot/cli-lib/lib/config');
+const { getAccessToken } = require('@hubspot/cli-lib/personalAccessKey.js');
+const {
+  getAccountId,
+  addAccountOptions,
+  addConfigOptions,
+} = require('../../lib/commonOpts');
+const { loadAndValidateOptions } = require('../../lib/validation');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.accounts.subcommands.info';
+exports.describe = i18n(`${i18nKey}.describe`);
+
+exports.command = 'info [--account]';
+
+exports.handler = async options => {
+  await loadAndValidateOptions(options);
+
+  let accountId = getAccountId(options);
+  const config = getAccountConfig(accountId);
+
+  // check if the provided account is using a personal access key, if not, show an error
+  if (config.authType === 'personalaccesskey') {
+    const { name, personalAccessKey, env } = config;
+
+    const response = await getAccessToken(personalAccessKey, env, accountId);
+
+    let scopeGroups = response.scopeGroups.join('\n');
+
+    logger.log(i18n(`${i18nKey}.name`, { name }));
+    logger.log(i18n(`${i18nKey}.accountId`, { accountId }));
+    logger.log(i18n(`${i18nKey}.scopeGroups`, { scopeGroups }));
+  } else {
+    logger.log(i18n(`${i18nKey}.errors.notUsingPersonalAccessKey`));
+  }
+};
+
+exports.builder = yargs => {
+  addConfigOptions(yargs, true);
+  addAccountOptions(yargs, true);
+
+  yargs.example([
+    ['$0 accounts info', i18n(`${i18nKey}.examples.default`)],
+    [
+      '$0 accounts info --account=MyAccount',
+      i18n(`${i18nKey}.examples.nameBased`),
+    ],
+    ['$0 accounts info --account=1234567', i18n(`${i18nKey}.examples.idBased`)],
+  ]);
+
+  return yargs;
+};

package/commands/accounts/list.js

@@ -19,6 +19,54 @@ const i18nKey = 'cli.commands.accounts.subcommands.list';
 exports.command = 'list';
 exports.describe = i18n(`${i18nKey}.describe`);
 
+const sortAndMapPortals = portals => {
+  const mappedPortalData = {};
+  portals
+    .sort((a, b) => {
+      if (a.sandboxAccountType === null && b.sandboxAccountType !== null) {
+        return -1;
+      }
+      if (a.sandboxAccountType !== null && b.sandboxAccountType === null) {
+        return 1;
+      }
+      return 0;
+    })
+    .forEach(portal => {
+      if (
+        portal.sandboxAccountType !== undefined &&
+        portal.sandboxAccountType === null
+      ) {
+        mappedPortalData[portal.portalId] = [portal];
+      } else if (portal.sandboxAccountType && portal.parentAccountId) {
+        mappedPortalData[portal.parentAccountId] = [
+          ...(mappedPortalData[portal.parentAccountId] || []),
+          portal,
+        ];
+      } else {
+        mappedPortalData[portal.portalId] = [portal];
+      }
+    });
+  return mappedPortalData;
+};
+
+const getPortalData = mappedPortalData => {
+  const portalData = [];
+  Object.values(mappedPortalData).forEach(set => {
+    set.forEach((portal, i) => {
+      if (i === 0) {
+        portalData.push([portal.name, portal.portalId, portal.authType]);
+      } else {
+        portalData.push([
+          `↳ ${portal.name} [sandbox]`,
+          portal.portalId,
+          portal.authType,
+        ]);
+      }
+    });
+  });
+  return portalData;
+};
+
 exports.handler = async options => {
   await loadAndValidateOptions(options);
 
@@ -28,9 +76,8 @@ exports.handler = async options => {
 
   const config = getConfig();
   const configPath = getConfigPath();
-  const portalData = config.portals.map(portal => {
-    return [portal.name, portal.portalId, portal.authType];
-  });
+  const mappedPortalData = sortAndMapPortals(config.portals);
+  const portalData = getPortalData(mappedPortalData);
   portalData.unshift(
     getTableHeader([
       i18n(`${i18nKey}.labels.name`),

package/commands/accounts.js

@@ -3,6 +3,7 @@ const { i18n } = require('@hubspot/cli-lib/lib/lang');
 const list = require('./accounts/list');
 const rename = require('./accounts/rename');
 const use = require('./accounts/use');
+const info = require('./accounts/info');
 
 const i18nKey = 'cli.commands.accounts';
 
@@ -20,6 +21,7 @@ exports.builder = yargs => {
     })
     .command(rename)
     .command(use)
+    .command(info)
     .demandCommand(1, '');
 
   return yargs;

package/commands/auth.js

@@ -3,7 +3,6 @@ const { logger } = require('@hubspot/cli-lib/logger');
 const {
   OAUTH_AUTH_METHOD,
   PERSONAL_ACCESS_KEY_AUTH_METHOD,
-  API_KEY_AUTH_METHOD,
   ENVIRONMENTS,
   DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME,
 } = require('@hubspot/cli-lib/lib/constants');
@@ -22,7 +21,6 @@ const { promptUser } = require('../lib/prompts/promptUtils');
 const {
   personalAccessKeyPrompt,
   OAUTH_FLOW,
-  API_KEY_FLOW,
 } = require('../lib/prompts/personalAccessKeyPrompt');
 const {
   enterAccountNamePrompt,
@@ -80,25 +78,6 @@ exports.handler = async options => {
   let successAuthMethod;
 
   switch (authType) {
-    case API_KEY_AUTH_METHOD.value:
-      configData = await promptUser(API_KEY_FLOW);
-      updatedConfig = await updateAccountConfig(configData);
-      validName = updatedConfig.name;
-
-      if (!validName) {
-        const { name: namePrompt } = await enterAccountNamePrompt();
-        validName = namePrompt;
-      }
-
-      updateAccountConfig({
-        ...updatedConfig,
-        environment: updatedConfig.env,
-        name: validName,
-      });
-      writeConfig();
-
-      successAuthMethod = API_KEY_AUTH_METHOD.name;
-      break;
     case OAUTH_AUTH_METHOD.value:
       configData = await promptUser(OAUTH_FLOW);
       await authenticateWithOauth({
@@ -188,7 +167,6 @@ exports.builder = yargs => {
     choices: [
       `${PERSONAL_ACCESS_KEY_AUTH_METHOD.value}`,
       `${OAUTH_AUTH_METHOD.value}`,
-      `${API_KEY_AUTH_METHOD.value}`,
     ],
     default: PERSONAL_ACCESS_KEY_AUTH_METHOD.value,
     defaultDescription: i18n(`${i18nKey}.positionals.type.defaultDescription`, {

package/commands/filemanager/fetch.js

@@ -35,7 +35,7 @@ exports.handler = async options => {
   trackCommandUsage('filemanager-fetch', {}, accountId);
 
   // Fetch and write file/folder.
-  downloadFileOrFolder(accountId, src, dest, options);
+  await downloadFileOrFolder(accountId, src, dest, options);
 };
 
 exports.builder = yargs => {

package/commands/init.js

@@ -5,8 +5,6 @@ const {
   createEmptyConfigFile,
   deleteEmptyConfigFile,
   updateDefaultAccount,
-  writeConfig,
-  updateAccountConfig,
 } = require('@hubspot/cli-lib/lib/config');
 const { addConfigOptions } = require('../lib/commonOpts');
 const { handleExit } = require('@hubspot/cli-lib/lib/process');
@@ -15,7 +13,6 @@ const {
   DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME,
   PERSONAL_ACCESS_KEY_AUTH_METHOD,
   OAUTH_AUTH_METHOD,
-  API_KEY_AUTH_METHOD,
   ENVIRONMENTS,
 } = require('@hubspot/cli-lib/lib/constants');
 const { i18n } = require('@hubspot/cli-lib/lib/lang');
@@ -29,7 +26,6 @@ const { setLogLevel, addTestingOptions } = require('../lib/commonOpts');
 const { promptUser } = require('../lib/prompts/promptUtils');
 const {
   OAUTH_FLOW,
-  API_KEY_FLOW,
   personalAccessKeyPrompt,
 } = require('../lib/prompts/personalAccessKeyPrompt');
 const {
@@ -70,28 +66,14 @@ const oauthConfigCreationFlow = async env => {
   return accountConfig;
 };
 
-const apiKeyConfigCreationFlow = async env => {
-  const configData = await promptUser(API_KEY_FLOW);
-  const accountConfig = {
-    ...configData,
-    env,
-  };
-  updateAccountConfig(accountConfig);
-  updateDefaultAccount(accountConfig.name);
-  writeConfig();
-  return accountConfig;
-};
-
 const CONFIG_CREATION_FLOWS = {
   [PERSONAL_ACCESS_KEY_AUTH_METHOD.value]: personalAccessKeyConfigCreationFlow,
   [OAUTH_AUTH_METHOD.value]: oauthConfigCreationFlow,
-  [API_KEY_AUTH_METHOD.value]: apiKeyConfigCreationFlow,
 };
 
 const AUTH_TYPE_NAMES = {
   [PERSONAL_ACCESS_KEY_AUTH_METHOD.value]: PERSONAL_ACCESS_KEY_AUTH_METHOD.name,
   [OAUTH_AUTH_METHOD.value]: OAUTH_AUTH_METHOD.name,
-  [API_KEY_AUTH_METHOD.value]: API_KEY_AUTH_METHOD.name,
 };
 
 exports.command = 'init [--account]';
@@ -164,7 +146,6 @@ exports.builder = yargs => {
       choices: [
         `${PERSONAL_ACCESS_KEY_AUTH_METHOD.value}`,
         `${OAUTH_AUTH_METHOD.value}`,
-        `${API_KEY_AUTH_METHOD.value}`,
       ],
       default: PERSONAL_ACCESS_KEY_AUTH_METHOD.value,
       defaultDescription: i18n(`${i18nKey}.options.auth.defaultDescription`, {

package/commands/project/logs.js

@@ -10,7 +10,10 @@ const {
 const { trackCommandUsage } = require('../../lib/usageTracking');
 const { logger } = require('@hubspot/cli-lib/logger');
 const { outputLogs } = require('@hubspot/cli-lib/lib/logs');
-const { fetchProject } = require('@hubspot/cli-lib/api/dfs');
+const {
+  fetchProject,
+  fetchDeployComponentsMetadata,
+} = require('@hubspot/cli-lib/api/dfs');
 const {
   getTableContents,
   getTableHeader,
@@ -142,12 +145,30 @@ exports.handler = async options => {
   const endpointName = options.endpoint || promptEndpointName;
 
   let relativeAppPath;
+  let appId;
 
   if (appName && !endpointName) {
     await ensureProjectExists(accountId, projectName, {
       allowCreate: false,
     });
-    const { deployedBuild } = await fetchProject(accountId, projectName);
+
+    const { deployedBuild, id: projectId } = await fetchProject(
+      accountId,
+      projectName
+    );
+
+    const { results: deployComponents } = await fetchDeployComponentsMetadata(
+      accountId,
+      projectId
+    );
+
+    const appComponent = deployComponents.find(
+      c => c.componentName === appName
+    );
+
+    if (appComponent) {
+      appId = appComponent.componentIdentifier;
+    }
 
     if (deployedBuild && deployedBuild.subbuildStatuses) {
       const appSubbuild = deployedBuild.subbuildStatuses.find(
@@ -196,10 +217,15 @@ exports.handler = async options => {
   );
 
   logger.log(
-    uiLink(
-      i18n(`${i18nKey}.logs.hubspotLogsLink`),
-      getPrivateAppsUrl(accountId)
-    )
+    appId
+      ? uiLink(
+          i18n(`${i18nKey}.logs.hubspotLogsDirectLink`),
+          `${getPrivateAppsUrl(accountId)}/${appId}/logs/extensions`
+        )
+      : uiLink(
+          i18n(`${i18nKey}.logs.hubspotLogsLink`),
+          getPrivateAppsUrl(accountId)
+        )
   );
   logger.log();
   uiLine();

package/commands/sandbox/create.js

@@ -157,6 +157,8 @@ exports.handler = async options => {
           url,
         })
       );
+    } else {
+      logger.error(err.error.message);
     }
     process.exit(EXIT_CODES.ERROR);
   }

package/commands/sandbox/delete.js

@@ -0,0 +1,41 @@
+const {
+  addAccountOptions,
+  addConfigOptions,
+  addUseEnvironmentOptions,
+} = require('../../lib/commonOpts');
+const { logger } = require('@hubspot/cli-lib/logger');
+
+const { loadAndValidateOptions } = require('../../lib/validation');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.sandbox.subcommands.delete';
+
+exports.command = 'delete';
+exports.describe = i18n(`${i18nKey}.describe`);
+
+exports.handler = async options => {
+  await loadAndValidateOptions(options);
+
+  logger.log('');
+  logger.log(i18n(`${i18nKey}.temporaryMessage`));
+};
+
+exports.builder = yargs => {
+  yargs.option('account', {
+    describe: i18n(`${i18nKey}.options.account.describe`),
+    type: 'string',
+  });
+
+  yargs.example([
+    [
+      '$0 sandbox delete --account=MySandboxAccount',
+      i18n(`${i18nKey}.examples.default`),
+    ],
+  ]);
+
+  addConfigOptions(yargs, true);
+  addAccountOptions(yargs, true);
+  addUseEnvironmentOptions(yargs, true);
+
+  return yargs;
+};

package/commands/sandbox.js

@@ -1,5 +1,6 @@
 const { addConfigOptions, addAccountOptions } = require('../lib/commonOpts');
 const create = require('./sandbox/create');
+const del = require('./sandbox/delete');
 
 // const i18nKey = 'cli.commands.sandbox';
 
@@ -10,7 +11,10 @@ exports.builder = yargs => {
   addConfigOptions(yargs, true);
   addAccountOptions(yargs, true);
 
-  yargs.command(create).demandCommand(1, '');
+  yargs
+    .command(create)
+    .command(del)
+    .demandCommand(1, '');
 
   return yargs;
 };

package/hubspot.sample.config.yml

@@ -11,13 +11,6 @@ allowUsageTracking: false
 
 # List of accounts that are intended to be used
 portals:
-  # Account set up to use an API Key
-  - name: DEV
-    portalId: 123
-    # Override mode for account
-    defaultMode: draft
-    authType: apikey
-    apiKey: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
   # Account set up to use OAuth2
   - name: PROD
     portalId: 456

package/lib/__tests__/validation.js

@@ -24,13 +24,6 @@ describe('validation', () => {
       getAccountConfig.mockReturnValueOnce(undefined);
       expect(await validateAccount({ account: 123 })).toBe(false);
     });
-    it('returns false if an api key is missing', async () => {
-      getAccountId.mockReturnValueOnce(123);
-      getAccountConfig.mockReturnValueOnce({
-        accountId: 123,
-      });
-      expect(await validateAccount({ account: 123 })).toBe(false);
-    });
     it('returns false for oauth2 authType if auth is missing', async () => {
       getAccountId.mockReturnValueOnce(123);
       getAccountConfig.mockReturnValueOnce({

package/lib/projects.js

@@ -449,6 +449,14 @@ const makePollTaskStatusFunc = ({
                   } with the following error ---`
                 );
                 logger.error(subTask.errorMessage);
+
+                // Log nested errors
+                if (subTask.standardError && subTask.standardError.errors) {
+                  logger.log();
+                  subTask.standardError.errors.forEach(error => {
+                    logger.log(error.message);
+                  });
+                }
               });
             }
 

package/lib/prompts/personalAccessKeyPrompt.js

@@ -6,7 +6,6 @@ const {
 const { deleteEmptyConfigFile } = require('@hubspot/cli-lib/lib/config');
 const { getHubSpotWebsiteOrigin } = require('@hubspot/cli-lib/lib/urls');
 const { logger } = require('@hubspot/cli-lib/logger');
-const { API_KEY_REGEX } = require('../regex');
 const { promptUser } = require('./promptUtils');
 const { accountNamePrompt } = require('./enterAccountNamePrompt');
 const { i18n } = require('@hubspot/cli-lib/lib/lang');
@@ -89,17 +88,6 @@ const CLIENT_SECRET = {
   },
 };
 
-const ACCOUNT_API_KEY = {
-  name: 'apiKey',
-  message: i18n(`${i18nKey}.enterApiKey`),
-  validate(val) {
-    if (!API_KEY_REGEX.test(val)) {
-      return i18n(`${i18nKey}.errors.invalidAPIKey`);
-    }
-    return true;
-  },
-};
-
 const PERSONAL_ACCESS_KEY_BROWSER_OPEN_PREP = {
   name: 'personalAcessKeyBrowserOpenPrep',
   type: 'confirm',
@@ -142,17 +130,14 @@ const OAUTH_FLOW = [
   CLIENT_SECRET,
   SCOPES,
 ];
-const API_KEY_FLOW = [accountNamePrompt(), ACCOUNT_ID, ACCOUNT_API_KEY];
 
 module.exports = {
   personalAccessKeyPrompt,
   CLIENT_ID,
   CLIENT_SECRET,
-  ACCOUNT_API_KEY,
   ACCOUNT_ID,
   SCOPES,
   PERSONAL_ACCESS_KEY,
   // Flows
-  API_KEY_FLOW,
   OAUTH_FLOW,
 };

package/lib/regex.js

@@ -1,7 +1,5 @@
-const API_KEY_REGEX = /^([a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12})$/i;
 const STRING_WITH_NO_SPACES_REGEX = /^\S*$/;
 
 module.exports = {
-  API_KEY_REGEX,
   STRING_WITH_NO_SPACES_REGEX,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hubspot/cli",
-  "version": "4.0.1-beta.0",
+  "version": "4.0.1-beta.3",
   "description": "CLI for working with HubSpot",
   "license": "Apache-2.0",
   "repository": {
@@ -8,8 +8,8 @@
     "url": "https://github.com/HubSpot/hubspot-cms-tools"
   },
   "dependencies": {
-    "@hubspot/cli-lib": "4.0.1-beta.0",
-    "@hubspot/serverless-dev-runtime": "4.0.1-beta.0",
+    "@hubspot/cli-lib": "4.0.1-beta.3",
+    "@hubspot/serverless-dev-runtime": "4.0.1-beta.3",
     "archiver": "^5.3.0",
     "chalk": "^4.1.2",
     "express": "^4.17.1",
@@ -37,5 +37,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "fb23906d7f8694f9de4bb43043127a74f5b63a29"
+  "gitHead": "e2fac76a5ea9f51f69dfb786a5f285ffcf88a47a"
 }