@hubspot/cli 6.2.0 → 6.2.2-beta.0

package/lib/validation.js

@@ -1,52 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
 const fs = require('fs');
 const path = require('path');
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { MODE } = require('@hubspot/local-dev-lib/constants/files');
-const {
-  API_KEY_AUTH_METHOD,
-  OAUTH_AUTH_METHOD,
-  PERSONAL_ACCESS_KEY_AUTH_METHOD,
-} = require('@hubspot/local-dev-lib/constants/auth');
+const { API_KEY_AUTH_METHOD, OAUTH_AUTH_METHOD, PERSONAL_ACCESS_KEY_AUTH_METHOD, } = require('@hubspot/local-dev-lib/constants/auth');
 const { commaSeparatedValues } = require('@hubspot/local-dev-lib/text');
-const {
-  loadConfig,
-  getConfigPath,
-  validateConfig,
-  getAccountConfig,
-  loadConfigFromEnvironment,
-} = require('@hubspot/local-dev-lib/config');
+const { loadConfig, getConfigPath, validateConfig, getAccountConfig, loadConfigFromEnvironment, } = require('@hubspot/local-dev-lib/config');
 const { getOauthManager } = require('@hubspot/local-dev-lib/oauth');
-const {
-  accessTokenForPersonalAccessKey,
-} = require('@hubspot/local-dev-lib/personalAccessKey');
-const {
-  getAbsoluteFilePath,
-  getCwd,
-  getExt,
-} = require('@hubspot/local-dev-lib/path');
+const { accessTokenForPersonalAccessKey, } = require('@hubspot/local-dev-lib/personalAccessKey');
+const { getAbsoluteFilePath, getCwd, getExt, } = require('@hubspot/local-dev-lib/path');
 const { getAccountId, getMode, setLogLevel } = require('./commonOpts');
 const { logDebugInfo } = require('./debugInfo');
 const { EXIT_CODES } = require('./enums/exitCodes');
 const { checkAndWarnGitInclusion } = require('./ui/git');
 const { logError } = require('./errorHandlers/index');
-
 async function loadAndValidateOptions(options, shouldValidateAccount = true) {
-  setLogLevel(options);
-  logDebugInfo(options);
-  const { config: configPath } = options;
-  loadConfig(configPath, options);
-  checkAndWarnGitInclusion(getConfigPath());
-
-  let validAccount = true;
-  if (shouldValidateAccount) {
-    validAccount = await validateAccount(options);
-  }
-
-  if (!(validateConfig() && validAccount)) {
-    process.exit(EXIT_CODES.ERROR);
-  }
+    setLogLevel(options);
+    logDebugInfo(options);
+    const { config: configPath } = options;
+    loadConfig(configPath, options);
+    checkAndWarnGitInclusion(getConfigPath());
+    let validAccount = true;
+    if (shouldValidateAccount) {
+        validAccount = await validateAccount(options);
+    }
+    if (!(validateConfig() && validAccount)) {
+        process.exit(EXIT_CODES.ERROR);
+    }
 }
-
 /**
  * Validate that an account was passed to the command and that the account's configuration is valid
  *
@@ -55,186 +38,144 @@ async function loadAndValidateOptions(options, shouldValidateAccount = true) {
  * @returns {boolean}
  */
 async function validateAccount(options) {
-  const accountId = getAccountId(options);
-  const {
-    portalId: portalIdOption,
-    portal: portalOption,
-    accountId: _accountIdOption,
-    account: _accountOption,
-  } = options;
-  const accountOption = portalOption || _accountOption;
-  const accountIdOption = portalIdOption || _accountIdOption;
-
-  if (!accountId) {
-    if (accountOption) {
-      logger.error(
-        `The account "${accountOption}" could not be found in the config`
-      );
-    } else if (accountIdOption) {
-      logger.error(
-        `The account "${accountIdOption}" could not be found in the config`
-      );
-    } else {
-      logger.error(
-        'An account needs to be supplied either via "--account" or through setting a "defaultPortal"'
-      );
+    const accountId = getAccountId(options);
+    const { portalId: portalIdOption, portal: portalOption, accountId: _accountIdOption, account: _accountOption, } = options;
+    const accountOption = portalOption || _accountOption;
+    const accountIdOption = portalIdOption || _accountIdOption;
+    if (!accountId) {
+        if (accountOption) {
+            logger.error(`The account "${accountOption}" could not be found in the config`);
+        }
+        else if (accountIdOption) {
+            logger.error(`The account "${accountIdOption}" could not be found in the config`);
+        }
+        else {
+            logger.error('An account needs to be supplied either via "--account" or through setting a "defaultPortal"');
+        }
+        return false;
     }
-    return false;
-  }
-
-  if (accountOption && loadConfigFromEnvironment()) {
-    throw new Error(
-      'Cannot specify an account when environment variables are supplied. Please unset the environment variables or do not use the "--account" flag.'
-    );
-  }
-
-  const accountConfig = getAccountConfig(accountId);
-  if (!accountConfig) {
-    logger.error(`The account ${accountId} has not been configured`);
-    return false;
-  }
-
-  const { authType, auth, apiKey, personalAccessKey } = accountConfig;
-
-  if (typeof authType === 'string' && authType !== authType.toLowerCase()) {
-    logger.error(
-      `Invalid "authType" value "${authType}" for account "${accountId}" in config file: ${getConfigPath()}. Valid values are ${commaSeparatedValues(
-        [
-          PERSONAL_ACCESS_KEY_AUTH_METHOD,
-          OAUTH_AUTH_METHOD,
-          API_KEY_AUTH_METHOD,
-        ].map(method => method.value)
-      )}.`
-    );
-  }
-
-  if (authType === 'oauth2') {
-    if (typeof auth !== 'object') {
-      logger.error(
-        `The OAuth2 auth configuration for account ${accountId} is missing`
-      );
-      return false;
-    }
-
-    const { clientId, clientSecret, tokenInfo } = auth;
-
-    if (!clientId || !clientSecret || !tokenInfo || !tokenInfo.refreshToken) {
-      logger.error(
-        `The OAuth2 configuration for account ${accountId} is incorrect`
-      );
-      logger.error('Run "hs auth --type=oauth2" to reauthenticate');
-      return false;
-    }
-
-    const oauth = getOauthManager(accountId, accountConfig);
-    try {
-      const accessToken = await oauth.accessToken();
-      if (!accessToken) {
-        logger.error(
-          `The OAuth2 access token could not be found for accountId ${accountId}`
-        );
+    if (accountOption && loadConfigFromEnvironment()) {
+        throw new Error('Cannot specify an account when environment variables are supplied. Please unset the environment variables or do not use the "--account" flag.');
+    }
+    const accountConfig = getAccountConfig(accountId);
+    if (!accountConfig) {
+        logger.error(`The account ${accountId} has not been configured`);
         return false;
-      }
-    } catch (e) {
-      logger.error(e.message);
-      return false;
-    }
-  } else if (authType === 'personalaccesskey') {
-    if (!personalAccessKey) {
-      logger.error(
-        `The account "${accountId}" is configured to use a access key for authentication and is missing a "personalAccessKey" in the configuration file`
-      );
-      return false;
-    }
-
-    try {
-      const accessToken = await accessTokenForPersonalAccessKey(accountId);
-      if (!accessToken) {
-        logger.error(
-          `An OAuth2 access token for account "${accountId} could not be retrieved using the "personalAccessKey" provided`
-        );
+    }
+    const { authType, auth, apiKey, personalAccessKey } = accountConfig;
+    if (typeof authType === 'string' && authType !== authType.toLowerCase()) {
+        logger.error(`Invalid "authType" value "${authType}" for account "${accountId}" in config file: ${getConfigPath()}. Valid values are ${commaSeparatedValues([
+            PERSONAL_ACCESS_KEY_AUTH_METHOD,
+            OAUTH_AUTH_METHOD,
+            API_KEY_AUTH_METHOD,
+        ].map(method => method.value))}.`);
+    }
+    if (authType === 'oauth2') {
+        if (typeof auth !== 'object') {
+            logger.error(`The OAuth2 auth configuration for account ${accountId} is missing`);
+            return false;
+        }
+        const { clientId, clientSecret, tokenInfo } = auth;
+        if (!clientId || !clientSecret || !tokenInfo || !tokenInfo.refreshToken) {
+            logger.error(`The OAuth2 configuration for account ${accountId} is incorrect`);
+            logger.error('Run "hs auth --type=oauth2" to reauthenticate');
+            return false;
+        }
+        const oauth = getOauthManager(accountId, accountConfig);
+        try {
+            const accessToken = await oauth.accessToken();
+            if (!accessToken) {
+                logger.error(`The OAuth2 access token could not be found for accountId ${accountId}`);
+                return false;
+            }
+        }
+        catch (e) {
+            logger.error(e.message);
+            return false;
+        }
+    }
+    else if (authType === 'personalaccesskey') {
+        if (!personalAccessKey) {
+            logger.error(`The account "${accountId}" is configured to use a access key for authentication and is missing a "personalAccessKey" in the configuration file`);
+            return false;
+        }
+        try {
+            const accessToken = await accessTokenForPersonalAccessKey(accountId);
+            if (!accessToken) {
+                logger.error(`An OAuth2 access token for account "${accountId} could not be retrieved using the "personalAccessKey" provided`);
+                return false;
+            }
+        }
+        catch (e) {
+            logError(e);
+            return false;
+        }
+    }
+    else if (!apiKey) {
+        logger.error(`The accountId ${accountId} is missing authentication configuration`);
         return false;
-      }
-    } catch (e) {
-      logError(e);
-      return false;
-    }
-  } else if (!apiKey) {
-    logger.error(
-      `The accountId ${accountId} is missing authentication configuration`
-    );
-    return false;
-  }
-
-  return true;
+    }
+    return true;
 }
-
 /**
  * @param {object} command options
  * @returns {boolean}
  */
 function validateMode(options) {
-  const mode = getMode(options);
-  if (MODE[mode]) {
-    return true;
-  }
-  const modesMessage = `Available modes are: ${Object.values(MODE).join(
-    ', '
-  )}.`;
-  if (mode != null) {
-    logger.error([`The mode "${mode}" is invalid.`, modesMessage].join(' '));
-  } else {
-    logger.error(['The mode option is missing.', modesMessage].join(' '));
-  }
-  return false;
+    const mode = getMode(options);
+    if (MODE[mode]) {
+        return true;
+    }
+    const modesMessage = `Available modes are: ${Object.values(MODE).join(', ')}.`;
+    if (mode != null) {
+        logger.error([`The mode "${mode}" is invalid.`, modesMessage].join(' '));
+    }
+    else {
+        logger.error(['The mode option is missing.', modesMessage].join(' '));
+    }
+    return false;
 }
-
 const fileExists = _path => {
-  let isFile;
-  try {
-    const absoluteSrcPath = path.resolve(getCwd(), _path);
-    if (!absoluteSrcPath) return false;
-
-    const stats = fs.statSync(absoluteSrcPath);
-    isFile = stats.isFile();
-
-    if (!isFile) {
-      logger.error(`The path "${_path}" is not a path to a file`);
-      return false;
-    }
-  } catch (e) {
-    logger.error(`The path "${_path}" is not a path to a file`);
-    return false;
-  }
-
-  return true;
+    let isFile;
+    try {
+        const absoluteSrcPath = path.resolve(getCwd(), _path);
+        if (!absoluteSrcPath)
+            return false;
+        const stats = fs.statSync(absoluteSrcPath);
+        isFile = stats.isFile();
+        if (!isFile) {
+            logger.error(`The path "${_path}" is not a path to a file`);
+            return false;
+        }
+    }
+    catch (e) {
+        logger.error(`The path "${_path}" is not a path to a file`);
+        return false;
+    }
+    return true;
 };
-
 const checkAndConvertToJson = _path => {
-  const filePath = getAbsoluteFilePath(_path);
-  if (!fileExists(filePath)) return false;
-
-  if (getExt(_path) !== 'json') {
-    logger.error(`The file "${_path}" must be a valid JSON file`);
-    return null;
-  }
-
-  let result;
-
-  try {
-    result = JSON.parse(fs.readFileSync(filePath, 'utf-8'));
-  } catch (e) {
-    logger.error(`The file "${_path}" contains invalid JSON`);
-    result = null;
-  }
-
-  return result;
+    const filePath = getAbsoluteFilePath(_path);
+    if (!fileExists(filePath))
+        return false;
+    if (getExt(_path) !== 'json') {
+        logger.error(`The file "${_path}" must be a valid JSON file`);
+        return null;
+    }
+    let result;
+    try {
+        result = JSON.parse(fs.readFileSync(filePath, 'utf-8'));
+    }
+    catch (e) {
+        logger.error(`The file "${_path}" contains invalid JSON`);
+        result = null;
+    }
+    return result;
 };
-
 module.exports = {
-  validateMode,
-  validateAccount,
-  checkAndConvertToJson,
-  fileExists,
-  loadAndValidateOptions,
+    validateMode,
+    validateAccount,
+    checkAndConvertToJson,
+    fileExists,
+    loadAndValidateOptions,
 };

package/package.json

@@ -1,50 +1,86 @@
 {
-  "name": "@hubspot/cli",
-  "version": "6.2.0",
-  "description": "CLI for working with HubSpot",
-  "license": "Apache-2.0",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/HubSpot/hubspot-cli"
-  },
-  "dependencies": {
-    "@hubspot/local-dev-lib": "2.0.0",
-    "@hubspot/serverless-dev-runtime": "6.2.0",
-    "@hubspot/theme-preview-dev-server": "0.0.8",
-    "@hubspot/ui-extensions-dev-server": "0.8.33",
-    "archiver": "^5.3.0",
-    "chalk": "^4.1.2",
-    "chokidar": "^3.0.1",
-    "cli-cursor": "^3.1.0",
-    "cli-progress": "^3.11.2",
-    "express": "^4.17.1",
-    "findup-sync": "^4.0.0",
-    "fs-extra": "^8.1.0",
-    "inquirer": "8.2.0",
-    "js-yaml": "^4.1.0",
-    "moment": "^2.29.1",
-    "open": "^7.0.3",
-    "ora": "^4.0.3",
-    "p-queue": "^6.0.2",
-    "strip-ansi": "^5.2.0",
-    "table": "^6.6.0",
-    "tmp": "^0.2.1",
-    "update-notifier": "^5.1.0",
-    "yargs": "15.4.1"
-  },
-  "devDependencies": {
-    "axios": "^1.7.2",
-    "mock-stdin": "^1.0.0"
-  },
-  "engines": {
-    "node": ">=18"
-  },
-  "bin": {
-    "hs": "./bin/hs",
-    "hscms": "./bin/hscms"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "gitHead": "760939368a64cd5dedf529ca89106253dbf98fce"
+    "name": "@hubspot/cli",
+    "version": "6.2.2-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": "2.1.1",
+        "@hubspot/serverless-dev-runtime": "7.0.0",
+        "@hubspot/theme-preview-dev-server": "0.0.9",
+        "@hubspot/ui-extensions-dev-server": "0.8.33",
+        "archiver": "^7.0.1",
+        "chalk": "^4.1.2",
+        "chokidar": "^3.0.1",
+        "cli-cursor": "^3.1.0",
+        "cli-progress": "^3.11.2",
+        "express": "^4.17.1",
+        "findup-sync": "^4.0.0",
+        "fs-extra": "^8.1.0",
+        "inquirer": "8.2.0",
+        "jest": "^29.5.0",
+        "js-yaml": "^4.1.0",
+        "moment": "^2.29.1",
+        "open": "^7.0.3",
+        "p-queue": "^6.0.2",
+        "strip-ansi": "^5.2.0",
+        "table": "^6.6.0",
+        "tmp": "^0.2.1",
+        "update-notifier": "^5.1.0",
+        "yargs": "17.7.2"
+    },
+    "devDependencies": {
+        "@types/semver": "^7.5.8",
+        "@typescript-eslint/eslint-plugin": "^8.11.0",
+        "@typescript-eslint/parser": "^8.11.0",
+        "axios": "^1.7.2",
+        "eslint": "^8.56.0",
+        "eslint-plugin-import": "^2.31.0",
+        "husky": "^4.3.8",
+        "lint-staged": "^10.5.4",
+        "madge": "^8.0.0",
+        "mock-stdin": "^1.0.0",
+        "prettier": "^1.19.1",
+        "semver": "^7.6.3",
+        "ts-jest": "^29.2.5",
+        "ts-node": "^10.9.2",
+        "typescript": "^5.6.2"
+    },
+    "scripts": {
+        "build": "ts-node ./scripts/build.ts",
+        "lint": "eslint . && prettier --list-different ./**/*.{js,json}",
+        "prettier:write": "prettier --write ./**/*.{js,json}",
+        "test": "jest",
+        "test-cli": "yarn --cwd 'acceptance-tests' test-ci",
+        "test-cli-debug": "yarn --cwd 'acceptance-tests' test-debug",
+        "test-cli-qa": "yarn --cwd 'acceptance-tests' test-qa",
+        "test-cli-latest": "yarn build-docker && docker container run -it --rm --name=hs-cli-container hs-cli-image yarn --cwd 'acceptance-tests' test-latest",
+        "build-docker": "docker image build --tag hs-cli-image . && docker image prune -f",
+        "circular-deps": "yarn madge --circular .",
+        "release": "yarn ts-node ./scripts/release.ts release",
+        "hs": "yarn build && node ./dist/bin/hs",
+        "update-ldl": "yarn add --exact @hubspot/local-dev-lib@latest"
+    },
+    "lint-staged": {
+        "**/*.{js,ts,scss,css}": [
+            "prettier -l",
+            "eslint"
+        ]
+    },
+    "husky": {
+        "hooks": {
+            "pre-commit": "lint-staged"
+        }
+    },
+    "engines": {
+        "node": ">=18"
+    },
+    "bin": {
+        "hs": "./bin/hs",
+        "hscms": "./bin/hscms"
+    },
+    "publishConfig": {
+        "access": "public",
+        "registry": "https://registry.npmjs.org/"
+    }
 }

package/CHANGELOG.md

@@ -1,16 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-## [4.1.5](https://github.com/HubSpot/hubspot-cms-tools/compare/v4.1.5-beta.4...v4.1.5) (2023-01-09)
-
-**Note:** Version bump only for package @hubspot/cli
-
-
-
-
-
-## [3.0.4](https://github.com/HubSpot/hubspot-cms-tools/compare/v3.0.4-beta.1...v3.0.4) (2021-04-01)
-
-**Note:** Version bump only for package @hubspot/cli

package/commands/__tests__/projects.test.js

@@ -1,105 +0,0 @@
-const { command, describe: projectDescribe, builder } = require('../project');
-
-jest.mock('../project/deploy');
-jest.mock('../project/create');
-jest.mock('../project/upload');
-jest.mock('../project/listBuilds');
-jest.mock('../project/logs');
-jest.mock('../project/watch');
-jest.mock('../project/download');
-jest.mock('../project/open');
-jest.mock('../project/dev');
-jest.mock('../project/add');
-jest.mock('../project/migrateApp');
-jest.mock('../project/cloneApp');
-jest.mock('../project/installDeps');
-jest.mock('../../lib/commonOpts');
-
-const deploy = require('../project/deploy');
-const create = require('../project/create');
-const upload = require('../project/upload');
-const listBuilds = require('../project/listBuilds');
-const logs = require('../project/logs');
-const watch = require('../project/watch');
-const download = require('../project/download');
-const open = require('../project/open');
-const dev = require('../project/dev');
-const add = require('../project/add');
-const migrateApp = require('../project/migrateApp');
-const cloneApp = require('../project/cloneApp');
-const installDeps = require('../project/installDeps');
-const { addConfigOptions, addAccountOptions } = require('../../lib/commonOpts');
-
-describe('commands/projects', () => {
-  describe('command', () => {
-    it('should have the correct command structure', () => {
-      expect(command).toEqual('project');
-    });
-  });
-
-  describe('describe', () => {
-    it('should contain the beta tag', () => {
-      expect(projectDescribe).toContain('[BETA]');
-    });
-    it('should provide an accurate description of what the command is doing', () => {
-      expect(projectDescribe).toContain(
-        'Commands for working with projects. For more information, visit our documentation: https://developers.hubspot.com/docs/platform/build-and-deploy-using-hubspot-projects'
-      );
-    });
-  });
-
-  describe('builder', () => {
-    let yargs;
-
-    const subcommands = [
-      ['create', create],
-      ['add', add],
-      ['watch', watch],
-      ['dev', dev],
-      ['upload', upload],
-      ['deploy', deploy],
-      ['logs', logs],
-      ['listBuilds', listBuilds],
-      ['download', download],
-      ['open', open],
-      ['migrateApp', migrateApp],
-      ['cloneApp', cloneApp],
-      ['installDeps', installDeps],
-    ];
-
-    beforeEach(() => {
-      yargs = {
-        command: jest.fn().mockImplementation(() => yargs),
-        demandCommand: jest.fn().mockImplementation(() => yargs),
-      };
-    });
-
-    it('should add the config options', () => {
-      builder(yargs);
-      expect(addConfigOptions).toHaveBeenCalledTimes(1);
-      expect(addConfigOptions).toHaveBeenCalledWith(yargs);
-    });
-
-    it('should add the account options', () => {
-      builder(yargs);
-      expect(addAccountOptions).toHaveBeenCalledTimes(1);
-      expect(addAccountOptions).toHaveBeenCalledWith(yargs);
-    });
-
-    it('should add the correct number of sub commands', () => {
-      builder(yargs);
-      expect(yargs.command).toHaveBeenCalledTimes(subcommands.length);
-    });
-
-    it.each(subcommands)('should attach the %s subcommand', (name, module) => {
-      builder(yargs);
-      expect(yargs.command).toHaveBeenCalledWith(module);
-    });
-
-    it('should demand the command takes one positional argument', () => {
-      builder(yargs);
-      expect(yargs.demandCommand).toHaveBeenCalledTimes(1);
-      expect(yargs.demandCommand).toHaveBeenCalledWith(1, '');
-    });
-  });
-});