@hubspot/local-dev-lib 0.3.10 → 0.3.12

package/api/localDevAuth.d.ts

@@ -1,5 +1,7 @@
 import { Environment } from '../types/Config';
 import { ScopeData } from '../types/Accounts';
+import { HUBSPOT_ACCOUNT_TYPES } from '../constants/config';
+import { ValueOf } from '../types/Utils';
 type AccessTokenResponse = {
     hubId: number;
     userId: number;
@@ -11,6 +13,7 @@ type AccessTokenResponse = {
     scopeGroups: Array<string>;
     encodedOAuthRefreshToken: string;
     hubName: string;
+    accountType: ValueOf<typeof HUBSPOT_ACCOUNT_TYPES>;
 };
 export declare function fetchAccessToken(personalAccessKey: string, env?: Environment, portalId?: number): Promise<AccessTokenResponse>;
 export declare function fetchScopeData(accountId: number, scopeGroup: string): Promise<ScopeData>;

package/config/config_DEPRECATED.js

@@ -580,10 +580,13 @@ function getConfigVariablesFromEnv() {
         personalAccessKey: env[environments_1.ENVIRONMENT_VARIABLES.HUBSPOT_PERSONAL_ACCESS_KEY],
         portalId: parseInt(env[environments_1.ENVIRONMENT_VARIABLES.HUBSPOT_PORTAL_ID] || '', 10),
         refreshToken: env[environments_1.ENVIRONMENT_VARIABLES.HUBSPOT_REFRESH_TOKEN],
+        httpTimeout: env[environments_1.ENVIRONMENT_VARIABLES.HTTP_TIMEOUT]
+            ? parseInt(env[environments_1.ENVIRONMENT_VARIABLES.HTTP_TIMEOUT])
+            : undefined,
         env: (0, environment_1.getValidEnv)(env[environments_1.ENVIRONMENT_VARIABLES.HUBSPOT_ENVIRONMENT]),
     };
 }
-function generatePersonalAccessKeyConfig(portalId, personalAccessKey, env) {
+function generatePersonalAccessKeyConfig(portalId, personalAccessKey, env, httpTimeout) {
     return {
         portals: [
             {
@@ -593,9 +596,10 @@ function generatePersonalAccessKeyConfig(portalId, personalAccessKey, env) {
                 env,
             },
         ],
+        httpTimeout,
     };
 }
-function generateOauthConfig(portalId, clientId, clientSecret, refreshToken, scopes, env) {
+function generateOauthConfig(portalId, clientId, clientSecret, refreshToken, scopes, env, httpTimeout) {
     return {
         portals: [
             {
@@ -612,6 +616,7 @@ function generateOauthConfig(portalId, clientId, clientSecret, refreshToken, sco
                 env,
             },
         ],
+        httpTimeout,
     };
 }
 function generateApiKeyConfig(portalId, apiKey, env) {
@@ -627,17 +632,20 @@ function generateApiKeyConfig(portalId, apiKey, env) {
     };
 }
 function loadConfigFromEnvironment({ useEnv = false, } = {}) {
-    const { apiKey, clientId, clientSecret, personalAccessKey, portalId, refreshToken, env, } = getConfigVariablesFromEnv();
+    const { apiKey, clientId, clientSecret, personalAccessKey, portalId, refreshToken, env, httpTimeout, } = getConfigVariablesFromEnv();
     const unableToLoadEnvConfigError = 'Unable to load config from environment variables.';
     if (!portalId) {
         useEnv && logger_1.logger.error(unableToLoadEnvConfigError);
         return;
     }
+    if (httpTimeout && httpTimeout < config_1.MIN_HTTP_TIMEOUT) {
+        throw new Error(`The HTTP timeout value ${httpTimeout} is invalid. The value must be a number greater than ${config_1.MIN_HTTP_TIMEOUT}.`);
+    }
     if (personalAccessKey) {
-        return generatePersonalAccessKeyConfig(portalId, personalAccessKey, env);
+        return generatePersonalAccessKeyConfig(portalId, personalAccessKey, env, httpTimeout);
     }
     else if (clientId && clientSecret && refreshToken) {
-        return generateOauthConfig(portalId, clientId, clientSecret, refreshToken, auth_1.OAUTH_SCOPES.map(scope => scope.value), env);
+        return generateOauthConfig(portalId, clientId, clientSecret, refreshToken, auth_1.OAUTH_SCOPES.map(scope => scope.value), env, httpTimeout);
     }
     else if (apiKey) {
         return generateApiKeyConfig(portalId, apiKey, env);

package/constants/environments.d.ts

@@ -11,4 +11,5 @@ export declare const ENVIRONMENT_VARIABLES: {
     readonly HUBSPOT_PORTAL_ID: "HUBSPOT_PORTAL_ID";
     readonly HUBSPOT_REFRESH_TOKEN: "HUBSPOT_REFRESH_TOKEN";
     readonly HUBSPOT_ENVIRONMENT: "HUBSPOT_ENVIRONMENT";
+    readonly HTTP_TIMEOUT: "HTTP_TIMEOUT";
 };

package/constants/environments.js

@@ -14,4 +14,5 @@ exports.ENVIRONMENT_VARIABLES = {
     HUBSPOT_PORTAL_ID: 'HUBSPOT_PORTAL_ID',
     HUBSPOT_REFRESH_TOKEN: 'HUBSPOT_REFRESH_TOKEN',
     HUBSPOT_ENVIRONMENT: 'HUBSPOT_ENVIRONMENT',
+    HTTP_TIMEOUT: 'HTTP_TIMEOUT',
 };

package/errors/apiErrors.d.ts

@@ -1,21 +1,24 @@
 import { AxiosError } from 'axios';
-import { GenericError, AxiosErrorContext } from '../types/Error';
+import { GenericError, AxiosErrorContext, ValidationError } from '../types/Error';
 import { HubSpotAuthError } from '../models/HubSpotAuthError';
-export declare function isSpecifiedError(err: Error | AxiosError, { statusCode, category, subCategory, }: {
+export declare function isSpecifiedError(err: Error | AxiosError, { statusCode, category, subCategory, code, }: {
     statusCode?: number;
     category?: string;
     subCategory?: string;
+    code?: string;
 }): boolean;
 export declare function isMissingScopeError(err: Error | AxiosError): boolean;
 export declare function isGatingError(err: Error | AxiosError): boolean;
+export declare function isTimeoutError(err: Error | AxiosError): boolean;
 export declare function isApiUploadValidationError(err: AxiosError<any>): boolean;
 export declare function isSpecifiedHubSpotAuthError(err: GenericError, { status, category, subCategory }: Partial<HubSpotAuthError>): boolean;
+export declare function parseValidationErrors(responseData?: {
+    errors?: Array<ValidationError>;
+    message?: string;
+}): Array<string>;
 export declare function getAxiosErrorWithContext(error: AxiosError<any>, context?: AxiosErrorContext): Error;
 /**
  * @throws
  */
 export declare function throwApiError(error: AxiosError, context?: AxiosErrorContext): never;
-/**
- * @throws
- */
 export declare function throwApiUploadError(error: AxiosError, context?: AxiosErrorContext): never;

package/errors/apiErrors.js

@@ -1,17 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.throwApiUploadError = exports.throwApiError = exports.getAxiosErrorWithContext = exports.isSpecifiedHubSpotAuthError = exports.isApiUploadValidationError = exports.isGatingError = exports.isMissingScopeError = exports.isSpecifiedError = void 0;
+exports.throwApiUploadError = exports.throwApiError = exports.getAxiosErrorWithContext = exports.parseValidationErrors = exports.isSpecifiedHubSpotAuthError = exports.isApiUploadValidationError = exports.isTimeoutError = exports.isGatingError = exports.isMissingScopeError = exports.isSpecifiedError = void 0;
 const api_1 = require("../constants/api");
 const lang_1 = require("../utils/lang");
 const standardErrors_1 = require("./standardErrors");
 const i18nKey = 'errors.apiErrors';
-function isSpecifiedError(err, { statusCode, category, subCategory, }) {
+function isSpecifiedError(err, { statusCode, category, subCategory, code, }) {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const error = (err && err.cause) || err;
     const statusCodeErr = !statusCode || error.response?.status === statusCode;
     const categoryErr = !category || error.response?.data?.category === category;
     const subCategoryErr = !subCategory || error.response?.data?.subCategory === subCategory;
-    return error.isAxiosError && statusCodeErr && categoryErr && subCategoryErr;
+    const codeError = !code || error.code === code;
+    return (error.isAxiosError &&
+        statusCodeErr &&
+        categoryErr &&
+        subCategoryErr &&
+        codeError);
 }
 exports.isSpecifiedError = isSpecifiedError;
 function isMissingScopeError(err) {
@@ -22,6 +27,10 @@ function isGatingError(err) {
     return isSpecifiedError(err, { statusCode: 403, category: 'GATED' });
 }
 exports.isGatingError = isGatingError;
+function isTimeoutError(err) {
+    return isSpecifiedError(err, { code: 'ETIMEDOUT' });
+}
+exports.isTimeoutError = isTimeoutError;
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function isApiUploadValidationError(err) {
     return (err.isAxiosError &&
@@ -58,14 +67,15 @@ function parseValidationErrors(responseData = { errors: [], message: '' }) {
     }
     return errorMessages;
 }
+exports.parseValidationErrors = parseValidationErrors;
 /**
  * @throws
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-function throwValidationErrors(error) {
+function throwValidationError(error) {
     const validationErrorMessages = parseValidationErrors(error?.response?.data);
     if (validationErrorMessages.length) {
-        (0, standardErrors_1.throwError)(new Error(validationErrorMessages.join(' '), { cause: error }));
+        return new Error(validationErrorMessages.join(' '), { cause: error });
     }
 }
 function getAxiosErrorWithContext(
@@ -165,12 +175,9 @@ function throwApiError(error, context = {}) {
     (0, standardErrors_1.throwError)(error);
 }
 exports.throwApiError = throwApiError;
-/**
- * @throws
- */
 function throwApiUploadError(error, context = {}) {
     if (isApiUploadValidationError(error)) {
-        throwValidationErrors(error);
+        throwValidationError(error);
     }
     throwApiError(error, context);
 }

package/http/getAxiosConfig.js

@@ -7,6 +7,9 @@ const urls_1 = require("../lib/urls");
 exports.DEFAULT_USER_AGENT_HEADERS = {
     'User-Agent': `HubSpot Local Dev Lib/${package_json_1.version}`,
 };
+const DEFAULT_TRANSITIONAL = {
+    clarifyTimeoutError: true,
+};
 function getAxiosConfig(options) {
     const { env, localHostOverride, headers, ...rest } = options;
     const { httpTimeout, httpUseLocalhost } = (0, config_1.getAndLoadConfigIfNeeded)();
@@ -17,6 +20,7 @@ function getAxiosConfig(options) {
             ...(headers || {}),
         },
         timeout: httpTimeout || 15000,
+        transitional: DEFAULT_TRANSITIONAL,
         ...rest,
     };
 }

package/lib/fileMapper.js

@@ -15,6 +15,7 @@ const standardErrors_1 = require("../errors/standardErrors");
 const extensions_1 = require("../constants/extensions");
 const files_1 = require("../constants/files");
 const fileSystemErrors_1 = require("../errors/fileSystemErrors");
+const apiErrors_1 = require("../errors/apiErrors");
 const lang_1 = require("../utils/lang");
 const i18nKey = 'lib.fileMapper';
 const queue = new p_queue_1.default({
@@ -196,9 +197,6 @@ async function writeFileMapperNode(accountId, filepath, node, mode, options = {}
     }
     return true;
 }
-function isTimeout(err) {
-    return !!err && (err.status === 408 || err.code === 'ESOCKETTIMEDOUT');
-}
 async function downloadFile(accountId, src, destPath, mode, options = {}) {
     const { isFile, isHubspot } = getTypeDataFromPath(src);
     try {
@@ -234,7 +232,7 @@ async function downloadFile(accountId, src, destPath, mode, options = {}) {
     }
     catch (err) {
         const error = err;
-        if (isHubspot && isTimeout(error)) {
+        if (isHubspot && (0, apiErrors_1.isTimeoutError)(error)) {
             (0, standardErrors_1.throwErrorWithMessage)(`${i18nKey}.errors.assetTimeout`, {}, error);
         }
         else {
@@ -249,24 +247,13 @@ async function fetchFolderFromApi(accountId, src, mode, options = {}) {
             src,
         });
     }
-    try {
-        const srcPath = isRoot ? '@root' : src;
-        const queryValues = getFileMapperQueryValues(mode, options);
-        const node = isHubspot
-            ? await (0, fileMapper_1.downloadDefault)(accountId, srcPath, queryValues)
-            : await (0, fileMapper_1.download)(accountId, srcPath, queryValues);
-        logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.folderFetch`, { src, accountId }));
-        return node;
-    }
-    catch (err) {
-        const error = err;
-        if (isHubspot && isTimeout(error)) {
-            (0, standardErrors_1.throwErrorWithMessage)(`${i18nKey}.errors.assetTimeout`, {}, error);
-        }
-        else {
-            (0, standardErrors_1.throwError)(error);
-        }
-    }
+    const srcPath = isRoot ? '@root' : src;
+    const queryValues = getFileMapperQueryValues(mode, options);
+    const node = isHubspot
+        ? await (0, fileMapper_1.downloadDefault)(accountId, srcPath, queryValues)
+        : await (0, fileMapper_1.download)(accountId, srcPath, queryValues);
+    logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.folderFetch`, { src, accountId }));
+    return node;
 }
 exports.fetchFolderFromApi = fetchFolderFromApi;
 async function downloadFolder(accountId, src, destPath, mode, options = {}) {
@@ -302,7 +289,13 @@ async function downloadFolder(accountId, src, destPath, mode, options = {}) {
         }
     }
     catch (err) {
-        (0, standardErrors_1.throwErrorWithMessage)(`${i18nKey}.errors.failedToFetchFolder`, { src, dest: destPath }, err);
+        const error = err;
+        if ((0, apiErrors_1.isTimeoutError)(error)) {
+            (0, standardErrors_1.throwErrorWithMessage)(`${i18nKey}.errors.assetTimeout`, {}, error);
+        }
+        else {
+            (0, standardErrors_1.throwErrorWithMessage)(`${i18nKey}.errors.failedToFetchFolder`, { src, dest: destPath }, err);
+        }
     }
 }
 /**

package/lib/personalAccessKey.d.ts

@@ -1,5 +1,7 @@
 import { CLIAccount } from '../types/Accounts';
 import { Environment } from '../types/Config';
+import { HUBSPOT_ACCOUNT_TYPES } from '../constants/config';
+import { ValueOf } from '../types/Utils';
 type AccessToken = {
     portalId: number;
     accessToken: string;
@@ -10,6 +12,7 @@ type AccessToken = {
     };
     encodedOAuthRefreshToken: string;
     hubName: string;
+    accountType: ValueOf<typeof HUBSPOT_ACCOUNT_TYPES>;
 };
 export declare function getAccessToken(personalAccessKey: string, env?: Environment, accountId?: number): Promise<AccessToken>;
 export declare function accessTokenForPersonalAccessKey(accountId: number): Promise<string | undefined>;

package/lib/personalAccessKey.js

@@ -13,6 +13,8 @@ const sandboxHubs_1 = require("../api/sandboxHubs");
 const config_1 = require("../config");
 const config_2 = require("../constants/config");
 const developerTestAccounts_1 = require("../api/developerTestAccounts");
+const logger_1 = require("./logging/logger");
+const apiErrors_1 = require("../errors/apiErrors");
 const i18nKey = 'lib.personalAccessKey';
 const refreshRequests = new Map();
 function getRefreshKey(personalAccessKey, expiration) {
@@ -40,6 +42,7 @@ async function getAccessToken(personalAccessKey, env = environments_1.ENVIRONMEN
         enabledFeatures: response.enabledFeatures,
         encodedOAuthRefreshToken: response.encodedOAuthRefreshToken,
         hubName: response.hubName,
+        accountType: response.accountType,
     };
 }
 exports.getAccessToken = getAccessToken;
@@ -107,50 +110,33 @@ async function enabledFeaturesForPersonalAccessKey(accountId) {
 }
 exports.enabledFeaturesForPersonalAccessKey = enabledFeaturesForPersonalAccessKey;
 async function updateConfigWithAccessToken(token, personalAccessKey, env, name, makeDefault = false) {
-    const { portalId, accessToken, expiresAt } = token;
+    const { portalId, accessToken, expiresAt, accountType } = token;
     const accountEnv = env || (0, config_1.getEnv)(name);
-    let accountType = config_2.HUBSPOT_ACCOUNT_TYPES.STANDARD;
-    let sandboxAccountType = null;
     let parentAccountId;
     try {
-        const sandboxDataResponse = await (0, sandboxHubs_1.fetchSandboxHubData)(accessToken, portalId, accountEnv);
-        if (sandboxDataResponse) {
-            const hubType = sandboxDataResponse.type
-                ? sandboxDataResponse.type.toUpperCase()
-                : null;
-            switch (hubType) {
-                case 'DEVELOPER':
-                    accountType = config_2.HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX;
-                    sandboxAccountType = 'DEVELOPER';
-                    break;
-                case 'STANDARD':
-                    accountType = config_2.HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX;
-                    sandboxAccountType = 'STANDARD';
-                    break;
-                default:
-                    accountType = config_2.HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX;
-                    sandboxAccountType = 'STANDARD';
-                    break;
-            }
+        if (accountType === config_2.HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX ||
+            accountType === config_2.HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX) {
+            const sandboxDataResponse = await (0, sandboxHubs_1.fetchSandboxHubData)(accessToken, portalId, accountEnv);
             if (sandboxDataResponse.parentHubId) {
                 parentAccountId = sandboxDataResponse.parentHubId;
             }
         }
     }
     catch (err) {
-        // Ignore error, returns 404 if account is not a sandbox
+        // Log error but do not throw
+        logger_1.logger.debug((0, apiErrors_1.getAxiosErrorWithContext)(err).message);
     }
     try {
-        if (accountType === config_2.HUBSPOT_ACCOUNT_TYPES.STANDARD) {
+        if (accountType === config_2.HUBSPOT_ACCOUNT_TYPES.DEVELOPER_TEST) {
             const developerTestAccountResponse = await (0, developerTestAccounts_1.fetchDeveloperTestAccountData)(accessToken, portalId, accountEnv);
             if (developerTestAccountResponse) {
-                accountType = config_2.HUBSPOT_ACCOUNT_TYPES.DEVELOPER_TEST;
                 parentAccountId = developerTestAccountResponse.parentPortalId;
             }
         }
     }
     catch (err) {
-        // Ignore error, returns 404 if account is not a test account
+        // Log error but do not throw
+        logger_1.logger.debug((0, apiErrors_1.getAxiosErrorWithContext)(err).message);
     }
     const updatedConfig = (0, config_1.updateAccountConfig)({
         accountId: portalId,
@@ -159,7 +145,6 @@ async function updateConfigWithAccessToken(token, personalAccessKey, env, name,
         name,
         authType: auth_1.PERSONAL_ACCESS_KEY_AUTH_METHOD.value,
         tokenInfo: { accessToken, expiresAt },
-        sandboxAccountType,
         parentAccountId,
         env: accountEnv,
     });

package/lib/urls.js

@@ -11,7 +11,11 @@ function getEnvUrlString(env) {
 const getHubSpotWebsiteOrigin = (env) => `https://app.hubspot${getEnvUrlString(env)}.com`;
 exports.getHubSpotWebsiteOrigin = getHubSpotWebsiteOrigin;
 function getHubSpotApiOrigin(env, useLocalHost) {
-    let domain = process.env.HUBAPI_DOMAIN_OVERRIDE;
+    let domain;
+    const domainOverride = process.env.HUBAPI_DOMAIN_OVERRIDE;
+    if (domainOverride && typeof domainOverride === 'string') {
+        domain = `${domainOverride}${getEnvUrlString(env)}`;
+    }
     if (!domain || typeof domain !== 'string') {
         domain = `${useLocalHost ? 'local' : 'api'}.hubapi${getEnvUrlString(env)}`;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/local-dev-lib",
-    "version": "0.3.10",
+    "version": "0.3.12",
     "description": "Provides library functionality for HubSpot local development tooling, including the HubSpot CLI",
     "main": "lib/index.js",
     "repository": {