@hubspot/local-dev-lib 0.5.0-experimental.8 → 0.5.0-experimental.9

package/config/index.d.ts

@@ -16,7 +16,7 @@ export declare function getConfigAccountIfExists(identifier: number | string): H
 export declare function getConfigDefaultAccount(): HubSpotConfigAccount;
 export declare function getConfigDefaultAccountIfExists(): HubSpotConfigAccount | undefined;
 export declare function getAllConfigAccounts(): HubSpotConfigAccount[];
-export declare function getConfigAccountEnvironment(identifier?: number | string): Environment;
+export declare function getConfigAccountEnvironment(identifier: number | string): Environment;
 export declare function addConfigAccount(accountToAdd: HubSpotConfigAccount): void;
 export declare function updateConfigAccount(updatedAccount: HubSpotConfigAccount): void;
 export declare function setConfigAccountAsDefault(identifier: number | string): void;

package/config/index.js

@@ -19,12 +19,12 @@ function localConfigFileExists() {
 }
 exports.localConfigFileExists = localConfigFileExists;
 function globalConfigFileExists() {
-    return fs_extra_1.default.existsSync((0, utils_1.getGlobalConfigFilePath)());
+    return (0, utils_1.doesConfigFileExistAtPath)((0, utils_1.getGlobalConfigFilePath)());
 }
 exports.globalConfigFileExists = globalConfigFileExists;
 function configFileExists() {
     try {
-        return fs_extra_1.default.existsSync(getConfigFilePath());
+        return (0, utils_1.doesConfigFileExistAtPath)(getConfigFilePath());
     }
     catch (error) {
         return false;
@@ -33,7 +33,7 @@ function configFileExists() {
 exports.configFileExists = configFileExists;
 function getConfigDefaultFilePath() {
     const globalConfigFilePath = (0, utils_1.getGlobalConfigFilePath)();
-    if (fs_extra_1.default.existsSync(globalConfigFilePath)) {
+    if ((0, utils_1.doesConfigFileExistAtPath)(globalConfigFilePath)) {
         return globalConfigFilePath;
     }
     const localConfigFilePath = (0, utils_1.getLocalConfigFilePath)();
@@ -115,7 +115,15 @@ function createEmptyConfigFile(useGlobalConfig = false) {
 exports.createEmptyConfigFile = createEmptyConfigFile;
 function deleteConfigFile() {
     const pathToDelete = getConfigFilePath();
-    fs_extra_1.default.unlinkSync(pathToDelete);
+    try {
+        fs_extra_1.default.unlinkSync(pathToDelete);
+    }
+    catch (error) {
+        const { message, type } = (0, utils_1.handleConfigFileSystemError)(error, pathToDelete);
+        throw new HubSpotConfigError_1.HubSpotConfigError(message, type, config_1.HUBSPOT_CONFIG_OPERATIONS.DELETE, {
+            cause: error,
+        });
+    }
 }
 exports.deleteConfigFile = deleteConfigFile;
 function getConfigAccountById(accountId) {
@@ -185,15 +193,14 @@ function getAllConfigAccounts() {
 }
 exports.getAllConfigAccounts = getAllConfigAccounts;
 function getConfigAccountEnvironment(identifier) {
-    if (identifier) {
-        const config = getConfig();
-        const account = (0, utils_1.getConfigAccountByInferredIdentifier)(config.accounts, identifier);
-        if (account) {
-            return (0, environment_1.getValidEnv)(account.env);
-        }
+    const config = getConfig();
+    const account = (0, utils_1.getConfigAccountByInferredIdentifier)(config.accounts, identifier);
+    if (!account) {
+        throw new HubSpotConfigError_1.HubSpotConfigError((0, lang_1.i18n)('config.getConfigAccountEnvironment.accountNotFound', {
+            identifier,
+        }), config_2.HUBSPOT_CONFIG_ERROR_TYPES.ACCOUNT_NOT_FOUND, config_1.HUBSPOT_CONFIG_OPERATIONS.READ);
     }
-    const defaultAccount = getConfigDefaultAccount();
-    return (0, environment_1.getValidEnv)(defaultAccount.env);
+    return (0, environment_1.getValidEnv)(account.env);
 }
 exports.getConfigAccountEnvironment = getConfigAccountEnvironment;
 function addConfigAccount(accountToAdd) {

package/config/utils.d.ts

@@ -1,5 +1,5 @@
 import { ACCOUNT_IDENTIFIERS } from '../constants/config';
-import { HubSpotConfig, DeprecatedHubSpotConfigFields } from '../types/Config';
+import { HubSpotConfig, DeprecatedHubSpotConfigFields, HubSpotConfigErrorType } from '../types/Config';
 import { HubSpotConfigAccount, AccountType, TokenInfo } from '../types/Accounts';
 import { ValueOf } from '../types/Utils';
 export declare function getGlobalConfigFilePath(): string;
@@ -9,6 +9,7 @@ export declare function getConfigPathEnvironmentVariables(): {
     useEnvironmentConfig: boolean;
     configFilePathFromEnvironment: string | undefined;
 };
+export declare function doesConfigFileExistAtPath(path: string): boolean;
 export declare function readConfigFile(configPath: string): string;
 export declare function removeUndefinedFieldsFromConfigAccount<T extends HubSpotConfigAccount | Partial<HubSpotConfigAccount> = HubSpotConfigAccount>(account: T): T;
 export declare function formatConfigForWrite(config: HubSpotConfig): {
@@ -72,3 +73,7 @@ export declare function getConfigAccountByIdentifier(accounts: Array<HubSpotConf
 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 handleConfigFileSystemError(error: unknown, path: string): {
+    message?: string;
+    type: HubSpotConfigErrorType;
+};

package/config/utils.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.isConfigAccountValid = exports.getConfigAccountIndexById = exports.getConfigAccountByInferredIdentifier = exports.getConfigAccountByIdentifier = exports.getAccountIdentifierAndType = exports.buildConfigFromEnvironment = exports.parseConfig = exports.normalizeParsedConfig = exports.writeConfigFile = exports.formatConfigForWrite = exports.removeUndefinedFieldsFromConfigAccount = exports.readConfigFile = exports.getConfigPathEnvironmentVariables = exports.getLocalConfigDefaultFilePath = exports.getLocalConfigFilePath = exports.getGlobalConfigFilePath = void 0;
+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 = exports.getLocalConfigFilePath = exports.getGlobalConfigFilePath = void 0;
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const js_yaml_1 = __importDefault(require("js-yaml"));
 const findup_sync_1 = __importDefault(require("findup-sync"));
@@ -44,18 +44,24 @@ function getConfigPathEnvironmentVariables() {
     };
 }
 exports.getConfigPathEnvironmentVariables = getConfigPathEnvironmentVariables;
+function doesConfigFileExistAtPath(path) {
+    try {
+        return fs_extra_1.default.existsSync(path);
+    }
+    catch (error) {
+        const { message, type } = handleConfigFileSystemError(error, path);
+        throw new HubSpotConfigError_1.HubSpotConfigError(message, type, config_1.HUBSPOT_CONFIG_OPERATIONS.READ, { cause: error });
+    }
+}
+exports.doesConfigFileExistAtPath = doesConfigFileExistAtPath;
 function readConfigFile(configPath) {
-    let source = '';
     try {
-        source = fs_extra_1.default.readFileSync(configPath).toString();
+        return fs_extra_1.default.readFileSync(configPath).toString();
     }
     catch (err) {
-        throw new FileSystemError_1.FileSystemError({ cause: err }, {
-            filepath: configPath,
-            operation: 'read',
-        });
+        const { message, type } = handleConfigFileSystemError(err, configPath);
+        throw new HubSpotConfigError_1.HubSpotConfigError(message, type, config_1.HUBSPOT_CONFIG_OPERATIONS.READ, { cause: err });
     }
-    return source;
 }
 exports.readConfigFile = readConfigFile;
 function removeUndefinedFieldsFromConfigAccount(account) {
@@ -111,7 +117,7 @@ function formatConfigForWrite(config) {
 }
 exports.formatConfigForWrite = formatConfigForWrite;
 function writeConfigFile(config, configPath) {
-    const source = js_yaml_1.default.dump(JSON.parse(JSON.stringify(formatConfigForWrite(config), null, 2)));
+    const source = js_yaml_1.default.dump(formatConfigForWrite(config));
     try {
         fs_extra_1.default.ensureFileSync(configPath);
         fs_extra_1.default.writeFileSync(configPath, source);
@@ -136,6 +142,9 @@ function getAccountType(sandboxAccountType) {
     return config_1.HUBSPOT_ACCOUNT_TYPES.STANDARD;
 }
 function normalizeParsedConfig(parsedConfig) {
+    if (!parsedConfig.portals && !parsedConfig.accounts) {
+        parsedConfig.accounts = [];
+    }
     if (parsedConfig.portals) {
         parsedConfig.accounts = parsedConfig.portals.map(account => {
             if (account.portalId) {
@@ -325,3 +334,19 @@ function isConfigAccountValid(account) {
     return valid;
 }
 exports.isConfigAccountValid = isConfigAccountValid;
+function handleConfigFileSystemError(error, path) {
+    let message;
+    let type = config_1.HUBSPOT_CONFIG_ERROR_TYPES.UNKNOWN;
+    if (error instanceof Error && 'code' in error) {
+        if (error.code === 'ENOENT') {
+            message = (0, lang_1.i18n)('config.utils.handleConfigFileSystemError.configNotFoundError', { path });
+            type = config_1.HUBSPOT_CONFIG_ERROR_TYPES.CONFIG_NOT_FOUND;
+        }
+        else if (error.code === 'EACCES') {
+            message = (0, lang_1.i18n)('config.utils.handleConfigFileSystemError.insufficientPermissionsError', { path });
+            type = config_1.HUBSPOT_CONFIG_ERROR_TYPES.INSUFFICIENT_PERMISSIONS;
+        }
+    }
+    return { message, type };
+}
+exports.handleConfigFileSystemError = handleConfigFileSystemError;

package/constants/config.d.ts

@@ -59,14 +59,17 @@ export declare const ACCOUNT_IDENTIFIERS: {
 };
 export declare const HUBSPOT_CONFIG_ERROR_TYPES: {
     readonly CONFIG_NOT_FOUND: "CONFIG_NOT_FOUND";
+    readonly INSUFFICIENT_PERMISSIONS: "INSUFFICIENT_PERMISSIONS";
     readonly ACCOUNT_NOT_FOUND: "ACCOUNT_NOT_FOUND";
     readonly NO_DEFAULT_ACCOUNT: "NO_DEFAULT_ACCOUNT";
     readonly INVALID_ENVIRONMENT_VARIABLES: "ENVIRONMENT_VARIABLES";
     readonly YAML_PARSING: "YAML_PARSING";
     readonly INVALID_ACCOUNT: "INVALID_ACCOUNT";
     readonly INVALID_FIELD: "INVALID_FIELD";
+    readonly UNKNOWN: "UNKNOWN";
 };
 export declare const HUBSPOT_CONFIG_OPERATIONS: {
     readonly READ: "READ";
     readonly WRITE: "WRITE";
+    readonly DELETE: "DELETE";
 };

package/constants/config.js

@@ -68,14 +68,17 @@ exports.ACCOUNT_IDENTIFIERS = {
 };
 exports.HUBSPOT_CONFIG_ERROR_TYPES = {
     CONFIG_NOT_FOUND: 'CONFIG_NOT_FOUND',
+    INSUFFICIENT_PERMISSIONS: 'INSUFFICIENT_PERMISSIONS',
     ACCOUNT_NOT_FOUND: 'ACCOUNT_NOT_FOUND',
     NO_DEFAULT_ACCOUNT: 'NO_DEFAULT_ACCOUNT',
     INVALID_ENVIRONMENT_VARIABLES: 'ENVIRONMENT_VARIABLES',
     YAML_PARSING: 'YAML_PARSING',
     INVALID_ACCOUNT: 'INVALID_ACCOUNT',
     INVALID_FIELD: 'INVALID_FIELD',
+    UNKNOWN: 'UNKNOWN',
 };
 exports.HUBSPOT_CONFIG_OPERATIONS = {
     READ: 'READ',
     WRITE: 'WRITE',
+    DELETE: 'DELETE',
 };

package/lang/en.json

@@ -291,7 +291,14 @@
     "updateDefaultCmsPublishMode": {
       "invalidCmsPublishMode": "Error updating config default CMS publish mode: CMS publish can only be set to 'draft' or 'publish'"
     },
+    "getConfigAccountEnvironment": {
+      "accountNotFound": "Attempted to get environment for account with identifier {{ identifier }}, but that account was not found in config"
+    },
     "utils": {
+      "handleConfigFileSystemError": {
+        "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",
@@ -382,7 +389,7 @@
       }
     },
     "HubSpotConfigError": {
-      "baseMessage": "An error occurred while {{ operation }} your HubSpot config {{ configType }}: {{ message }}"
+      "baseMessage": "An error occurred while {{ operation }} your HubSpot config {{ configType }}{{ message }}"
     }
   },
   "utils": {

package/lib/personalAccessKey.js

@@ -121,9 +121,7 @@ async function authorizedScopesForPortalAndUser(accountId) {
 exports.authorizedScopesForPortalAndUser = authorizedScopesForPortalAndUser;
 async function updateConfigWithAccessToken(token, personalAccessKey, env, name, makeDefault = false) {
     const { portalId, accessToken, expiresAt, accountType } = token;
-    const account = name
-        ? (0, config_1.getConfigAccountIfExists)(name)
-        : (0, config_1.getConfigDefaultAccountIfExists)();
+    const account = name ? (0, config_1.getConfigAccountIfExists)(name) : undefined;
     const accountEnv = env || account?.env || environments_1.ENVIRONMENTS.PROD;
     let parentAccountId;
     try {

package/models/HubSpotConfigError.d.ts

@@ -2,5 +2,5 @@ import { HubSpotConfigErrorType, HubSpotConfigOperation } from '../types/Config'
 export declare class HubSpotConfigError extends Error {
     type: HubSpotConfigErrorType;
     operation: HubSpotConfigOperation;
-    constructor(message: string, type: HubSpotConfigErrorType, operation: HubSpotConfigOperation, options?: ErrorOptions);
+    constructor(message: string | undefined, type: HubSpotConfigErrorType, operation: HubSpotConfigOperation, options?: ErrorOptions);
 }

package/models/HubSpotConfigError.js

@@ -4,6 +4,11 @@ exports.HubSpotConfigError = void 0;
 const config_1 = require("../constants/config");
 const lang_1 = require("../utils/lang");
 const NAME = 'HubSpotConfigError';
+const OPERATION_TEXT = {
+    [config_1.HUBSPOT_CONFIG_OPERATIONS.READ]: 'reading',
+    [config_1.HUBSPOT_CONFIG_OPERATIONS.WRITE]: 'writing to',
+    [config_1.HUBSPOT_CONFIG_OPERATIONS.DELETE]: 'deleting',
+};
 function isEnvironmentError(type) {
     return type === config_1.HUBSPOT_CONFIG_ERROR_TYPES.INVALID_ENVIRONMENT_VARIABLES;
 }
@@ -14,10 +19,10 @@ class HubSpotConfigError extends Error {
         const configType = isEnvironmentError(type)
             ? 'environment variables'
             : 'file';
-        const operationText = operation === config_1.HUBSPOT_CONFIG_OPERATIONS.WRITE ? 'writing to' : 'reading';
+        const operationText = OPERATION_TEXT[operation];
         const withBaseMessage = (0, lang_1.i18n)('models.HubSpotConfigError.baseMessage', {
             configType,
-            message,
+            message: message ? `: ${message}` : '',
             operation: operationText,
         });
         super(withBaseMessage, options);

package/package.json

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