@hubspot/local-dev-lib 0.5.0-experimental.12 → 0.5.0-experimental.13

package/config/index.d.ts

@@ -1,5 +1,5 @@
 import { HubSpotConfigAccount } from '../types/Accounts';
-import { HubSpotConfig, ConfigFlag } from '../types/Config';
+import { HubSpotConfig, ConfigFlag, HubSpotConfigValidationResult } from '../types/Config';
 import { CmsPublishMode } from '../types/Files';
 import { Environment } from '../types/Config';
 export declare function getGlobalConfigFilePath(): string;
@@ -9,7 +9,7 @@ export declare function globalConfigFileExists(): boolean;
 export declare function configFileExists(): boolean;
 export declare function getConfigFilePath(): string;
 export declare function getConfig(): HubSpotConfig;
-export declare function isConfigValid(): boolean;
+export declare function validateConfig(): HubSpotConfigValidationResult;
 export declare function createEmptyConfigFile(useGlobalConfig?: boolean): void;
 export declare function deleteConfigFileIfEmpty(): void;
 export declare function getConfigAccountById(accountId: number): HubSpotConfigAccount;

package/config/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.removeLocalStateFlag = exports.addLocalStateFlag = exports.hasLocalStateFlag = exports.isConfigFlagEnabled = exports.updateDefaultCmsPublishMode = exports.updateAutoOpenBrowser = exports.updateAllowAutoUpdates = exports.updateAllowUsageTracking = exports.updateHttpTimeout = exports.removeAccountFromConfig = exports.renameConfigAccount = exports.setConfigAccountAsDefault = exports.updateConfigAccount = exports.addConfigAccount = exports.getConfigAccountEnvironment = exports.getAllConfigAccounts = exports.getConfigDefaultAccountIfExists = exports.getConfigDefaultAccount = exports.getConfigAccountIfExists = exports.getConfigAccountByName = exports.getConfigAccountById = exports.deleteConfigFileIfEmpty = exports.createEmptyConfigFile = exports.isConfigValid = exports.getConfig = exports.getConfigFilePath = exports.configFileExists = exports.globalConfigFileExists = exports.localConfigFileExists = exports.getLocalConfigFilePathIfExists = exports.getGlobalConfigFilePath = void 0;
+exports.removeLocalStateFlag = exports.addLocalStateFlag = exports.hasLocalStateFlag = exports.isConfigFlagEnabled = exports.updateDefaultCmsPublishMode = exports.updateAutoOpenBrowser = exports.updateAllowAutoUpdates = exports.updateAllowUsageTracking = exports.updateHttpTimeout = exports.removeAccountFromConfig = exports.renameConfigAccount = exports.setConfigAccountAsDefault = exports.updateConfigAccount = exports.addConfigAccount = exports.getConfigAccountEnvironment = exports.getAllConfigAccounts = exports.getConfigDefaultAccountIfExists = exports.getConfigDefaultAccount = exports.getConfigAccountIfExists = exports.getConfigAccountByName = exports.getConfigAccountById = exports.deleteConfigFileIfEmpty = exports.createEmptyConfigFile = exports.validateConfig = exports.getConfig = exports.getConfigFilePath = exports.configFileExists = exports.globalConfigFileExists = exports.localConfigFileExists = exports.getLocalConfigFilePathIfExists = exports.getGlobalConfigFilePath = void 0;
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const findup_sync_1 = __importDefault(require("findup-sync"));
 const config_1 = require("../constants/config");
@@ -81,44 +81,45 @@ function getConfig() {
     }
 }
 exports.getConfig = getConfig;
-function isConfigValid() {
+function validateConfig() {
     const config = getConfig();
     if (config.accounts.length === 0) {
-        logger_1.logger.debug((0, lang_1.i18n)('config.isConfigValid.missingAccounts'));
-        return false;
+        return {
+            isValid: false,
+            errors: [(0, lang_1.i18n)('config.validateConfig.missingAccounts')],
+        };
     }
     const accountIdsMap = {};
     const accountNamesMap = {};
-    return config.accounts.every(account => {
-        if (!(0, utils_1.isConfigAccountValid)(account)) {
-            return false;
+    const validationErrors = [];
+    config.accounts.forEach(account => {
+        const accountValidationResult = (0, utils_1.validateConfigAccount)(account);
+        if (!accountValidationResult.isValid) {
+            validationErrors.push(...accountValidationResult.errors);
         }
         if (accountIdsMap[account.accountId]) {
-            logger_1.logger.debug((0, lang_1.i18n)('config.isConfigValid.duplicateAccountIds', {
+            validationErrors.push((0, lang_1.i18n)('config.validateConfig.duplicateAccountIds', {
                 accountId: account.accountId,
             }));
-            return false;
         }
         if (account.name) {
             if (accountNamesMap[account.name.toLowerCase()]) {
-                logger_1.logger.debug((0, lang_1.i18n)('config.isConfigValid.duplicateAccountNames', {
+                logger_1.logger.debug((0, lang_1.i18n)('config.validateConfig.duplicateAccountNames', {
                     accountName: account.name,
                 }));
-                return false;
             }
             if (/\s+/.test(account.name)) {
-                logger_1.logger.debug((0, lang_1.i18n)('config.isConfigValid.invalidAccountName', {
+                logger_1.logger.debug((0, lang_1.i18n)('config.validateConfig.invalidAccountName', {
                     accountName: account.name,
                 }));
-                return false;
             }
             accountNamesMap[account.name] = true;
         }
         accountIdsMap[account.accountId] = true;
-        return true;
     });
+    return { isValid: validationErrors.length === 0, errors: validationErrors };
 }
-exports.isConfigValid = isConfigValid;
+exports.validateConfig = validateConfig;
 function createEmptyConfigFile(useGlobalConfig = false) {
     const { configFilePathFromEnvironment } = (0, utils_1.getConfigPathEnvironmentVariables)();
     const defaultPath = useGlobalConfig
@@ -222,7 +223,7 @@ function getConfigAccountEnvironment(identifier) {
 }
 exports.getConfigAccountEnvironment = getConfigAccountEnvironment;
 function addConfigAccount(accountToAdd) {
-    if (!(0, utils_1.isConfigAccountValid)(accountToAdd)) {
+    if (!(0, utils_1.validateConfigAccount)(accountToAdd)) {
         throw new HubSpotConfigError_1.HubSpotConfigError((0, lang_1.i18n)('config.addConfigAccount.invalidAccount'), config_2.HUBSPOT_CONFIG_ERROR_TYPES.INVALID_ACCOUNT, config_1.HUBSPOT_CONFIG_OPERATIONS.WRITE);
     }
     const config = getConfig();
@@ -237,7 +238,7 @@ function addConfigAccount(accountToAdd) {
 }
 exports.addConfigAccount = addConfigAccount;
 function updateConfigAccount(updatedAccount) {
-    if (!(0, utils_1.isConfigAccountValid)(updatedAccount)) {
+    if (!(0, utils_1.validateConfigAccount)(updatedAccount)) {
         throw new HubSpotConfigError_1.HubSpotConfigError((0, lang_1.i18n)('config.updateConfigAccount.invalidAccount', {
             name: updatedAccount.name,
         }), config_2.HUBSPOT_CONFIG_ERROR_TYPES.INVALID_ACCOUNT, config_1.HUBSPOT_CONFIG_OPERATIONS.WRITE);

package/config/utils.d.ts

@@ -1,5 +1,5 @@
 import { ACCOUNT_IDENTIFIERS } from '../constants/config';
-import { HubSpotConfig, DeprecatedHubSpotConfigFields, HubSpotConfigErrorType } from '../types/Config';
+import { HubSpotConfig, DeprecatedHubSpotConfigFields, HubSpotConfigErrorType, HubSpotConfigValidationResult } from '../types/Config';
 import { HubSpotConfigAccount, AccountType, TokenInfo } from '../types/Accounts';
 import { ValueOf } from '../types/Utils';
 export declare function getLocalConfigDefaultFilePath(): string;
@@ -70,7 +70,7 @@ export declare function getAccountIdentifierAndType(accountIdentifier: string |
 export declare function getConfigAccountByIdentifier(accounts: Array<HubSpotConfigAccount>, identifierFieldName: ValueOf<typeof ACCOUNT_IDENTIFIERS>, identifier: string | number): HubSpotConfigAccount | undefined;
 export declare function getConfigAccountByInferredIdentifier(accounts: Array<HubSpotConfigAccount>, accountIdentifier: string | number): HubSpotConfigAccount | undefined;
 export declare function getConfigAccountIndexById(accounts: Array<HubSpotConfigAccount>, id: number): number;
-export declare function isConfigAccountValid(account: Partial<HubSpotConfigAccount>): boolean;
+export declare function validateConfigAccount(account: Partial<HubSpotConfigAccount>): HubSpotConfigValidationResult;
 export declare function handleConfigFileSystemError(error: unknown, path: string): {
     message?: string;
     type: HubSpotConfigErrorType;

package/config/utils.js

@@ -3,13 +3,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.handleConfigFileSystemError = exports.isConfigAccountValid = exports.getConfigAccountIndexById = exports.getConfigAccountByInferredIdentifier = exports.getConfigAccountByIdentifier = exports.getAccountIdentifierAndType = exports.buildConfigFromEnvironment = exports.parseConfig = exports.normalizeParsedConfig = exports.writeConfigFile = exports.formatConfigForWrite = exports.removeUndefinedFieldsFromConfigAccount = exports.readConfigFile = exports.doesConfigFileExistAtPath = exports.getConfigPathEnvironmentVariables = exports.getLocalConfigDefaultFilePath = void 0;
+exports.handleConfigFileSystemError = exports.validateConfigAccount = exports.getConfigAccountIndexById = exports.getConfigAccountByInferredIdentifier = exports.getConfigAccountByIdentifier = exports.getAccountIdentifierAndType = exports.buildConfigFromEnvironment = exports.parseConfig = exports.normalizeParsedConfig = exports.writeConfigFile = exports.formatConfigForWrite = exports.removeUndefinedFieldsFromConfigAccount = exports.readConfigFile = exports.doesConfigFileExistAtPath = exports.getConfigPathEnvironmentVariables = exports.getLocalConfigDefaultFilePath = void 0;
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const js_yaml_1 = __importDefault(require("js-yaml"));
 const config_1 = require("../constants/config");
 const auth_1 = require("../constants/auth");
 const FileSystemError_1 = require("../models/FileSystemError");
-const logger_1 = require("../lib/logger");
 const environment_1 = require("../lib/environment");
 const path_1 = require("../lib/path");
 const files_1 = require("../constants/files");
@@ -278,50 +277,49 @@ function getConfigAccountIndexById(accounts, id) {
     return accounts.findIndex(account => account.accountId === id);
 }
 exports.getConfigAccountIndexById = getConfigAccountIndexById;
-function isConfigAccountValid(account) {
+function validateConfigAccount(account) {
+    const validationErrors = [];
     if (!account || typeof account !== 'object') {
-        logger_1.logger.debug((0, lang_1.i18n)('config.utils.isConfigAccountValid.missingAccount'));
-        return false;
+        validationErrors.push((0, lang_1.i18n)('config.utils.validateConfigAccount.missingAccount'));
+        return { isValid: false, errors: validationErrors };
     }
     if (!account.accountId) {
-        logger_1.logger.debug((0, lang_1.i18n)('config.utils.isConfigAccountValid.missingAccountId'));
-        return false;
+        validationErrors.push((0, lang_1.i18n)('config.utils.validateConfigAccount.missingAccountId'));
+        return { isValid: false, errors: validationErrors };
     }
     if (!account.authType) {
-        logger_1.logger.debug((0, lang_1.i18n)('config.utils.isConfigAccountValid.missingAuthType', {
+        validationErrors.push((0, lang_1.i18n)('config.utils.validateConfigAccount.missingAuthType', {
             accountId: account.accountId,
         }));
-        return false;
+        return { isValid: false, errors: validationErrors };
     }
-    let valid = false;
     if (account.authType === auth_1.PERSONAL_ACCESS_KEY_AUTH_METHOD.value) {
-        valid =
-            'personalAccessKey' in account && Boolean(account.personalAccessKey);
-        if (!valid) {
-            logger_1.logger.debug((0, lang_1.i18n)('config.utils.isConfigAccountValid.missingPersonalAccessKey', {
+        const isValidPersonalAccessKeyAccount = 'personalAccessKey' in account && Boolean(account.personalAccessKey);
+        if (!isValidPersonalAccessKeyAccount) {
+            validationErrors.push((0, lang_1.i18n)('config.utils.validateConfigAccount.missingPersonalAccessKey', {
                 accountId: account.accountId,
             }));
         }
     }
     if (account.authType === auth_1.OAUTH_AUTH_METHOD.value) {
-        valid = 'auth' in account && Boolean(account.auth);
-        if (!valid) {
-            logger_1.logger.debug((0, lang_1.i18n)('config.utils.isConfigAccountValid.missingAuth', {
+        const isValidOAuthAccount = 'auth' in account && Boolean(account.auth);
+        if (!isValidOAuthAccount) {
+            validationErrors.push((0, lang_1.i18n)('config.utils.validateConfigAccount.missingAuth', {
                 accountId: account.accountId,
             }));
         }
     }
     if (account.authType === auth_1.API_KEY_AUTH_METHOD.value) {
-        valid = 'apiKey' in account && Boolean(account.apiKey);
-        if (!valid) {
-            logger_1.logger.debug((0, lang_1.i18n)('config.utils.isConfigAccountValid.missingApiKey', {
+        const isValidAPIKeyAccount = 'apiKey' in account && Boolean(account.apiKey);
+        if (!isValidAPIKeyAccount) {
+            validationErrors.push((0, lang_1.i18n)('config.utils.validateConfigAccount.missingApiKey', {
                 accountId: account.accountId,
             }));
         }
     }
-    return valid;
+    return { isValid: validationErrors.length === 0, errors: validationErrors };
 }
-exports.isConfigAccountValid = isConfigAccountValid;
+exports.validateConfigAccount = validateConfigAccount;
 function handleConfigFileSystemError(error, path) {
     let message;
     let type = config_1.HUBSPOT_CONFIG_ERROR_TYPES.UNKNOWN;

package/lang/en.json

@@ -251,11 +251,11 @@
       "error": "No config file found.",
       "errorWithPath": "No config file found at {{ path }}."
     },
-    "isConfigValid": {
-      "missingAccounts": "Invalid config: no accounts found",
-      "duplicateAccountIds": "Invalid config: multiple accounts with accountId: {{ accountId }}",
-      "duplicateAccountNames": "Invalid config: multiple accounts with name: {{ accountName }}",
-      "invalidAccountName": "Invalid config: account name {{ accountName }} contains spaces"
+    "validateConfig": {
+      "missingAccounts": "No accounts found",
+      "duplicateAccountIds": "Multiple accounts with accountId: {{ accountId }}",
+      "duplicateAccountNames": "Multiple accounts with name: {{ accountName }}",
+      "invalidAccountName": "Account name {{ accountName }} contains spaces"
     },
     "getConfigAccountById": {
       "error": "No account with id {{ accountId }} exists in config"
@@ -299,13 +299,13 @@
         "configNotFoundError": "No config file found at {{ path }}.",
         "insufficientPermissionsError": "Insufficient permissions to access config file at {{ path }}"
       },
-      "isConfigAccountValid": {
-        "missingAccount": "Invalid config: at least one account in config is missing data",
-        "missingAuthType": "Invalid config: account {{ accountId }} has no authType",
-        "missingAccountId": "Invalid config: at least one account in config is missing accountId",
-        "missingApiKey": "Invalid config: account {{ accountId }} has authType of apikey but is missing the apiKey field",
-        "missingAuth": "Invalid config: account {{ accountId }} has authtype of oauth2 but is missing auth data",
-        "missingPersonalAccessKey": "Invalid config: account {{ accountId }} has authType of personalAccessKey but is missing the personalAccessKey field"
+      "validateConfigAccount": {
+        "missingAccount": "At least one account in config is missing data",
+        "missingAuthType": "Account {{ accountId }} has no authType",
+        "missingAccountId": "At least one account in config is missing accountId",
+        "missingApiKey": "Account {{ accountId }} has authType of apikey but is missing the apiKey field",
+        "missingAuth": "Account {{ accountId }} has authtype of oauth2 but is missing auth data",
+        "missingPersonalAccessKey": "Account {{ accountId }} has authType of personalAccessKey but is missing the personalAccessKey field"
       },
       "getConfigPathEnvironmentVariables": {
         "invalidEnvironmentVariables": "USE_ENVIRONMENT_HUBSPOT_CONFIG and HUBSPOT_CONFIG_PATH cannot both be set simultaneously"

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/local-dev-lib",
-    "version": "0.5.0-experimental.12",
+    "version": "0.5.0-experimental.13",
     "description": "Provides library functionality for HubSpot local development tooling, including the HubSpot CLI",
     "repository": {
         "type": "git",

package/types/Config.d.ts

@@ -34,3 +34,7 @@ export type HubSpotState = {
 };
 export type HubSpotConfigErrorType = ValueOf<typeof HUBSPOT_CONFIG_ERROR_TYPES>;
 export type HubSpotConfigOperation = ValueOf<typeof HUBSPOT_CONFIG_OPERATIONS>;
+export type HubSpotConfigValidationResult = {
+    isValid: boolean;
+    errors: Array<string>;
+};