@hubspot/local-dev-lib 0.2.1 → 0.2.2-experimental.0

package/errors/index.d.ts

@@ -0,0 +1,18 @@
+import { HubSpotHttpError } from '../models/HubSpotHttpError';
+import { BaseError } from '../types/Error';
+import { FileSystemError } from '../models/FileSystemError';
+export declare function isSpecifiedError(err: unknown, { statusCode, category, subCategory, errorType, code, }: {
+    statusCode?: number;
+    category?: string;
+    subCategory?: string;
+    errorType?: string;
+    code?: string;
+}): err is HubSpotHttpError;
+export declare function isMissingScopeError(err: unknown): err is HubSpotHttpError;
+export declare function isGatingError(err: unknown): err is HubSpotHttpError;
+export declare function isTimeoutError(err: unknown): err is HubSpotHttpError;
+export declare function isAuthError(err: unknown): err is HubSpotHttpError;
+export declare function isValidationError(err: unknown): boolean;
+export declare function isHubSpotHttpError(error?: unknown): error is HubSpotHttpError;
+export declare function isSystemError(err: unknown): err is BaseError;
+export declare function isFileSystemError(err: unknown): err is FileSystemError;

package/errors/index.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isFileSystemError = exports.isSystemError = exports.isHubSpotHttpError = exports.isValidationError = exports.isAuthError = exports.isTimeoutError = exports.isGatingError = exports.isMissingScopeError = exports.isSpecifiedError = void 0;
+const HubSpotHttpError_1 = require("../models/HubSpotHttpError");
+const FileSystemError_1 = require("../models/FileSystemError");
+function isSpecifiedError(err, { statusCode, category, subCategory, errorType, code, }) {
+    if (!isHubSpotHttpError(err)) {
+        return false;
+    }
+    const { data, status, code: actualCode } = err;
+    const statusCodeMatchesError = !statusCode || status === statusCode;
+    const categoryMatchesError = !category || data?.category === category;
+    const subCategoryMatchesError = !subCategory || data?.subCategory === subCategory;
+    const errorTypeMatchesError = !errorType || data?.errorType === errorType;
+    const codeMatchesError = !code || actualCode === code;
+    return (statusCodeMatchesError &&
+        categoryMatchesError &&
+        subCategoryMatchesError &&
+        errorTypeMatchesError &&
+        codeMatchesError);
+}
+exports.isSpecifiedError = isSpecifiedError;
+function isMissingScopeError(err) {
+    return isSpecifiedError(err, { statusCode: 403, category: 'MISSING_SCOPES' });
+}
+exports.isMissingScopeError = isMissingScopeError;
+function isGatingError(err) {
+    return isSpecifiedError(err, { statusCode: 403, category: 'GATED' });
+}
+exports.isGatingError = isGatingError;
+function isTimeoutError(err) {
+    return isSpecifiedError(err, { code: 'ETIMEDOUT' });
+}
+exports.isTimeoutError = isTimeoutError;
+function isAuthError(err) {
+    return (isSpecifiedError(err, { statusCode: 401 }) ||
+        isSpecifiedError(err, { statusCode: 403 }));
+}
+exports.isAuthError = isAuthError;
+function isValidationError(err) {
+    return (isHubSpotHttpError(err) &&
+        isSpecifiedError(err, { statusCode: 400 }) &&
+        !!(err?.data?.message || !!err.data?.errors));
+}
+exports.isValidationError = isValidationError;
+function isHubSpotHttpError(error) {
+    return !!error && error instanceof HubSpotHttpError_1.HubSpotHttpError;
+}
+exports.isHubSpotHttpError = isHubSpotHttpError;
+function isSystemError(err) {
+    return (err instanceof Error &&
+        'errno' in err &&
+        err.errno != null &&
+        'code' in err &&
+        err.code != null &&
+        'syscall' in err &&
+        err.syscall != null);
+}
+exports.isSystemError = isSystemError;
+function isFileSystemError(err) {
+    return err instanceof FileSystemError_1.FileSystemError;
+}
+exports.isFileSystemError = isFileSystemError;

package/http/addQueryParams.d.ts

@@ -0,0 +1,2 @@
+import { HttpOptions, QueryParams } from '../types/Http';
+export declare function addQueryParams(configOptions: HttpOptions, queryParams?: QueryParams): HttpOptions;

package/http/addQueryParams.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addQueryParams = void 0;
+function addQueryParams(configOptions, queryParams = {}) {
+    const { params } = configOptions;
+    return {
+        ...configOptions,
+        params: {
+            ...queryParams,
+            ...params,
+        },
+    };
+}
+exports.addQueryParams = addQueryParams;

package/http/getAxiosConfig.d.ts

@@ -1,6 +1,9 @@
-import { AxiosConfigOptions } from '../types/Http';
+import { HttpOptions } from '../types/Http';
 import { AxiosRequestConfig } from 'axios';
-export declare const DEFAULT_USER_AGENT_HEADERS: {
+export declare const USER_AGENTS: {
+    [key: string]: string;
+};
+export declare function getDefaultUserAgentHeader(): {
     'User-Agent': string;
 };
-export declare function getAxiosConfig(options: AxiosConfigOptions): AxiosRequestConfig;
+export declare function getAxiosConfig(options: HttpOptions): AxiosRequestConfig;

package/http/getAxiosConfig.js

@@ -1,21 +1,65 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAxiosConfig = exports.DEFAULT_USER_AGENT_HEADERS = void 0;
+exports.getAxiosConfig = exports.getDefaultUserAgentHeader = exports.USER_AGENTS = void 0;
 const package_json_1 = require("../package.json");
 const config_1 = require("../config");
 const urls_1 = require("../lib/urls");
-exports.DEFAULT_USER_AGENT_HEADERS = {
-    'User-Agent': `HubSpot Local Dev Lib/${package_json_1.version}`,
+const https_1 = __importDefault(require("https"));
+const http_1 = __importDefault(require("http"));
+// Total number of sockets across all hosts
+const MAX_TOTAL_SOCKETS = 25;
+// Total number of sockets per each host
+const MAX_SOCKETS_PER_HOST = 5;
+const httpAgent = new http_1.default.Agent({
+    keepAlive: true,
+    maxTotalSockets: MAX_TOTAL_SOCKETS,
+    maxSockets: MAX_SOCKETS_PER_HOST,
+});
+const httpsAgent = new https_1.default.Agent({
+    keepAlive: true,
+    maxTotalSockets: MAX_TOTAL_SOCKETS,
+    maxSockets: MAX_SOCKETS_PER_HOST,
+});
+exports.USER_AGENTS = {
+    'HubSpot Local Dev Lib': package_json_1.version,
+};
+function getDefaultUserAgentHeader() {
+    let userAgentString = '';
+    Object.keys(exports.USER_AGENTS).forEach((userAgentKey, i) => {
+        userAgentString += `${i > 0 ? ', ' : ''}${userAgentKey}/${exports.USER_AGENTS[userAgentKey]}`;
+    });
+    return {
+        'User-Agent': userAgentString,
+    };
+}
+exports.getDefaultUserAgentHeader = getDefaultUserAgentHeader;
+const DEFAULT_TRANSITIONAL = {
+    clarifyTimeoutError: true,
 };
 function getAxiosConfig(options) {
-    const { env, localHostOverride, ...rest } = options;
-    const { httpTimeout, httpUseLocalhost } = (0, config_1.getAndLoadConfigIfNeeded)();
+    const { env, localHostOverride, headers, ...rest } = options;
+    const config = (0, config_1.getAndLoadConfigIfNeeded)();
+    let httpTimeout = 15000;
+    let httpUseLocalhost = false;
+    if (config && config.httpTimeout) {
+        httpTimeout = config.httpTimeout;
+    }
+    if (config && config.httpUseLocalhost) {
+        httpUseLocalhost = config.httpUseLocalhost;
+    }
     return {
         baseURL: (0, urls_1.getHubSpotApiOrigin)(env, localHostOverride ? false : httpUseLocalhost),
         headers: {
-            ...exports.DEFAULT_USER_AGENT_HEADERS,
+            ...getDefaultUserAgentHeader(),
+            ...(headers || {}),
         },
-        timeout: httpTimeout || 15000,
+        timeout: httpTimeout,
+        transitional: DEFAULT_TRANSITIONAL,
+        httpAgent,
+        httpsAgent,
         ...rest,
     };
 }

package/http/index.d.ts

@@ -1,18 +1,17 @@
-import { LogCallbacksArg } from '../types/LogCallbacks';
-import { HttpOptions } from '../types/Http';
-import { AxiosResponse } from 'axios';
-declare function getRequest<T>(accountId: number, options: HttpOptions): Promise<T>;
-declare function postRequest<T>(accountId: number, options: HttpOptions): Promise<T>;
-declare function putRequest<T>(accountId: number, options: HttpOptions): Promise<T>;
-declare function patchRequest<T>(accountId: number, options: HttpOptions): Promise<T>;
-declare function deleteRequest<T>(accountId: number, options: HttpOptions): Promise<T>;
-declare const getRequestStreamCallbackKeys: readonly ["onWrite"];
-declare const http: {
+import { AxiosPromise } from 'axios';
+import { HttpOptions, HubSpotPromise } from '../types/Http';
+export declare function addUserAgentHeader(key: string, value: string): void;
+declare function getRequest<T>(accountId: number, options: HttpOptions): HubSpotPromise<T>;
+declare function postRequest<T>(accountId: number, options: HttpOptions): HubSpotPromise<T>;
+declare function putRequest<T>(accountId: number, options: HttpOptions): HubSpotPromise<T>;
+declare function patchRequest<T>(accountId: number, options: HttpOptions): HubSpotPromise<T>;
+declare function deleteRequest<T>(accountId: number, options: HttpOptions): HubSpotPromise<T>;
+export declare const http: {
     get: typeof getRequest;
     post: typeof postRequest;
     put: typeof putRequest;
     patch: typeof patchRequest;
     delete: typeof deleteRequest;
-    getOctetStream: (accountId: number, options: HttpOptions, destPath: string, logCallbacks?: LogCallbacksArg<typeof getRequestStreamCallbackKeys>) => Promise<AxiosResponse>;
+    getOctetStream: (accountId: number, options: HttpOptions, destPath: string) => AxiosPromise<any>;
 };
-export default http;
+export {};

package/http/index.js

@@ -3,22 +3,34 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.http = exports.addUserAgentHeader = void 0;
 const path_1 = __importDefault(require("path"));
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const content_disposition_1 = __importDefault(require("content-disposition"));
+const axios_1 = __importDefault(require("axios"));
 const config_1 = require("../config");
 const getAxiosConfig_1 = require("./getAxiosConfig");
+const addQueryParams_1 = require("./addQueryParams");
 const personalAccessKey_1 = require("../lib/personalAccessKey");
 const oauth_1 = require("../lib/oauth");
-const standardErrors_1 = require("../errors/standardErrors");
-const logger_1 = require("../utils/logger");
-const axios_1 = __importDefault(require("axios"));
+const logger_1 = require("../lib/logger");
+const lang_1 = require("../utils/lang");
+const HubSpotHttpError_1 = require("../models/HubSpotHttpError");
 const i18nKey = 'http.index';
+axios_1.default.interceptors.response.use(undefined, error => {
+    // Wrap all axios errors in our own Error class.  Attach the error
+    // as the cause for the new error, so we maintain the stack trace
+    return Promise.reject(new HubSpotHttpError_1.HubSpotHttpError(error.message, { cause: error }));
+});
+function addUserAgentHeader(key, value) {
+    getAxiosConfig_1.USER_AGENTS[key] = value;
+}
+exports.addUserAgentHeader = addUserAgentHeader;
 async function withOauth(accountId, accountConfig, axiosConfig) {
     const { headers } = axiosConfig;
     const oauth = (0, oauth_1.getOauthManager)(accountId, accountConfig);
     if (!oauth) {
-        (0, standardErrors_1.throwErrorWithMessage)(`${i18nKey}.errors.withOauth`, { accountId });
+        throw new Error((0, lang_1.i18n)(`${i18nKey}.errors.withOauth`, { accountId }));
     }
     const accessToken = await oauth.accessToken();
     return {
@@ -53,7 +65,7 @@ function withPortalId(portalId, axiosConfig) {
 async function withAuth(accountId, options) {
     const accountConfig = (0, config_1.getAccountConfig)(accountId);
     if (!accountConfig) {
-        (0, standardErrors_1.throwErrorWithMessage)(`${i18nKey}.errors.withAuth`, { accountId });
+        throw new Error((0, lang_1.i18n)(`${i18nKey}.errors.withAuth`, { accountId }));
     }
     const { env, authType, apiKey } = accountConfig;
     const axiosConfig = withPortalId(accountId, (0, getAxiosConfig_1.getAxiosConfig)({ env, ...options }));
@@ -72,49 +84,32 @@ async function withAuth(accountId, options) {
         },
     };
 }
-function addQueryParams(configOptions, queryParams = {}) {
-    const { params } = configOptions;
-    return {
-        ...configOptions,
-        params: {
-            ...queryParams,
-            ...params,
-        },
-    };
-}
 async function getRequest(accountId, options) {
-    const { query, ...rest } = options;
-    const axiosConfig = addQueryParams(rest, query);
-    const configWithAuth = await withAuth(accountId, axiosConfig);
-    const { data } = await (0, axios_1.default)(configWithAuth);
-    return data;
+    const { params, ...rest } = options;
+    const optionsWithParams = (0, addQueryParams_1.addQueryParams)(rest, params);
+    const requestConfig = await withAuth(accountId, optionsWithParams);
+    return (0, axios_1.default)(requestConfig);
 }
 async function postRequest(accountId, options) {
-    const configWithAuth = await withAuth(accountId, options);
-    const { data } = await (0, axios_1.default)({ ...configWithAuth, method: 'post' });
-    return data;
+    const requestConfig = await withAuth(accountId, options);
+    return (0, axios_1.default)({ ...requestConfig, method: 'post' });
 }
 async function putRequest(accountId, options) {
-    const configWithAuth = await withAuth(accountId, options);
-    const { data } = await (0, axios_1.default)({ ...configWithAuth, method: 'put' });
-    return data;
+    const requestConfig = await withAuth(accountId, options);
+    return (0, axios_1.default)({ ...requestConfig, method: 'put' });
 }
 async function patchRequest(accountId, options) {
-    const configWithAuth = await withAuth(accountId, options);
-    const { data } = await (0, axios_1.default)({ ...configWithAuth, method: 'put' });
-    return data;
+    const requestConfig = await withAuth(accountId, options);
+    return (0, axios_1.default)({ ...requestConfig, method: 'patch' });
 }
 async function deleteRequest(accountId, options) {
-    const configWithAuth = await withAuth(accountId, options);
-    const { data } = await (0, axios_1.default)({ ...configWithAuth, method: 'delete' });
-    return data;
+    const requestConfig = await withAuth(accountId, options);
+    return (0, axios_1.default)({ ...requestConfig, method: 'delete' });
 }
-const getRequestStreamCallbackKeys = ['onWrite'];
 function createGetRequestStream(contentType) {
-    return async (accountId, options, destPath, logCallbacks) => {
-        const { query, ...rest } = options;
-        const axiosConfig = addQueryParams(rest, query);
-        const logger = (0, logger_1.makeTypedLogger)(logCallbacks);
+    return async (accountId, options, destPath) => {
+        const { params, ...rest } = options;
+        const axiosConfig = (0, addQueryParams_1.addQueryParams)(rest, params);
         // eslint-disable-next-line no-async-promise-executor
         return new Promise(async (resolve, reject) => {
             try {
@@ -151,9 +146,9 @@ function createGetRequestStream(contentType) {
                         reject(err);
                     });
                     writeStream.on('close', async () => {
-                        logger('onWrite', `${i18nKey}.createGetRequestStream.onWrite`, {
+                        logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.createGetRequestStream.onWrite`, {
                             filepath,
-                        });
+                        }));
                         resolve(res);
                     });
                 }
@@ -168,7 +163,7 @@ function createGetRequestStream(contentType) {
     };
 }
 const getOctetStream = createGetRequestStream('application/octet-stream');
-const http = {
+exports.http = {
     get: getRequest,
     post: postRequest,
     put: putRequest,
@@ -176,4 +171,3 @@ const http = {
     delete: deleteRequest,
     getOctetStream,
 };
-exports.default = http;

package/http/unauthed.d.ts

@@ -0,0 +1,14 @@
+import { HttpOptions, HubSpotPromise } from '../types/Http';
+declare function getRequest<T>(options: HttpOptions): HubSpotPromise<T>;
+declare function postRequest<T>(options: HttpOptions): HubSpotPromise<T>;
+declare function putRequest<T>(options: HttpOptions): HubSpotPromise<T>;
+declare function patchRequest<T>(options: HttpOptions): HubSpotPromise<T>;
+declare function deleteRequest<T>(options: HttpOptions): HubSpotPromise<T>;
+export declare const http: {
+    get: typeof getRequest;
+    post: typeof postRequest;
+    put: typeof putRequest;
+    patch: typeof patchRequest;
+    delete: typeof deleteRequest;
+};
+export {};

package/http/unauthed.js

@@ -0,0 +1,38 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.http = void 0;
+const axios_1 = __importDefault(require("axios"));
+const getAxiosConfig_1 = require("./getAxiosConfig");
+const addQueryParams_1 = require("./addQueryParams");
+async function getRequest(options) {
+    const { params, ...rest } = options;
+    const optionsWithParams = (0, addQueryParams_1.addQueryParams)(rest, params);
+    const requestConfig = await (0, getAxiosConfig_1.getAxiosConfig)(optionsWithParams);
+    return (0, axios_1.default)(requestConfig);
+}
+async function postRequest(options) {
+    const requestConfig = await (0, getAxiosConfig_1.getAxiosConfig)(options);
+    return (0, axios_1.default)({ ...requestConfig, method: 'post' });
+}
+async function putRequest(options) {
+    const requestConfig = await (0, getAxiosConfig_1.getAxiosConfig)(options);
+    return (0, axios_1.default)({ ...requestConfig, method: 'put' });
+}
+async function patchRequest(options) {
+    const requestConfig = await (0, getAxiosConfig_1.getAxiosConfig)(options);
+    return (0, axios_1.default)({ ...requestConfig, method: 'patch' });
+}
+async function deleteRequest(options) {
+    const requestConfig = await (0, getAxiosConfig_1.getAxiosConfig)(options);
+    return (0, axios_1.default)({ ...requestConfig, method: 'delete' });
+}
+exports.http = {
+    get: getRequest,
+    post: postRequest,
+    put: putRequest,
+    patch: patchRequest,
+    delete: deleteRequest,
+};