@hubspot/local-dev-lib 0.6.1-experimental.0 → 0.6.3-experimental.0

package/http/getAxiosConfig.js

@@ -1,26 +1,20 @@
-"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.shouldUseProxy = exports.hostnameMatchesNoProxyPattern = 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");
-const http_1 = __importDefault(require("http"));
-const https_1 = __importDefault(require("https"));
-const http_proxy_agent_1 = require("http-proxy-agent");
-const https_proxy_agent_1 = require("https-proxy-agent");
+import pkg from '../package.json' with { type: 'json' };
+import { getConfig } from '../config/index.js';
+import { getHubSpotApiOrigin } from '../lib/urls.js';
+import http from 'http';
+import https from 'https';
+import { HttpProxyAgent } from 'http-proxy-agent';
+import { HttpsProxyAgent } from 'https-proxy-agent';
 // 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({
+const httpAgent = new http.Agent({
     keepAlive: true,
     maxTotalSockets: MAX_TOTAL_SOCKETS,
     maxSockets: MAX_SOCKETS_PER_HOST,
 });
-const httpsAgent = new https_1.default.Agent({
+const httpsAgent = new https.Agent({
     keepAlive: true,
     maxTotalSockets: MAX_TOTAL_SOCKETS,
     maxSockets: MAX_SOCKETS_PER_HOST,
@@ -39,7 +33,7 @@ function getHttpProxyAgent() {
     if (!proxyUrl) {
         return httpAgent;
     }
-    return new http_proxy_agent_1.HttpProxyAgent(proxyUrl, {
+    return new HttpProxyAgent(proxyUrl, {
         keepAlive: true,
         maxTotalSockets: MAX_TOTAL_SOCKETS,
         maxSockets: MAX_SOCKETS_PER_HOST,
@@ -52,29 +46,28 @@ function getHttpsProxyAgent() {
     if (!proxyUrl) {
         return httpsAgent;
     }
-    return new https_proxy_agent_1.HttpsProxyAgent(proxyUrl, {
+    return new HttpsProxyAgent(proxyUrl, {
         keepAlive: true,
         maxTotalSockets: MAX_TOTAL_SOCKETS,
         maxSockets: MAX_SOCKETS_PER_HOST,
     });
 }
-exports.USER_AGENTS = {
-    'HubSpot Local Dev Lib': package_json_1.version,
+export const USER_AGENTS = {
+    'HubSpot Local Dev Lib': pkg.version,
 };
-function getDefaultUserAgentHeader() {
+export function getDefaultUserAgentHeader() {
     let userAgentString = '';
-    Object.keys(exports.USER_AGENTS).forEach((userAgentKey, i) => {
-        userAgentString += `${i > 0 ? ', ' : ''}${userAgentKey}/${exports.USER_AGENTS[userAgentKey]}`;
+    Object.keys(USER_AGENTS).forEach((userAgentKey, i) => {
+        userAgentString += `${i > 0 ? ', ' : ''}${userAgentKey}/${USER_AGENTS[userAgentKey]}`;
     });
     return {
         'User-Agent': userAgentString,
     };
 }
-exports.getDefaultUserAgentHeader = getDefaultUserAgentHeader;
 const DEFAULT_TRANSITIONAL = {
     clarifyTimeoutError: true,
 };
-function hostnameMatchesNoProxyPattern(hostname, pattern) {
+export function hostnameMatchesNoProxyPattern(hostname, pattern) {
     const hostnameNormalized = hostname.toLowerCase();
     const patternNormalized = pattern.trim().toLowerCase();
     if (patternNormalized === '*') {
@@ -87,8 +80,7 @@ function hostnameMatchesNoProxyPattern(hostname, pattern) {
         hostnameNormalized.endsWith(`.${patternNormalized}`) // domain suffix match (e.g. "api.hubapi.com" matches ".hubapi.com")
     );
 }
-exports.hostnameMatchesNoProxyPattern = hostnameMatchesNoProxyPattern;
-function shouldUseProxy(baseURL) {
+export function shouldUseProxy(baseURL) {
     if (!getHttpProxyEnvVariable() &&
         !getHttpsProxyEnvVariable() &&
         !getAllProxyEnvVariable()) {
@@ -104,12 +96,11 @@ function shouldUseProxy(baseURL) {
     }
     return true;
 }
-exports.shouldUseProxy = shouldUseProxy;
-function getAxiosConfig(options) {
+export function getAxiosConfig(options) {
     const { env, localHostOverride, headers, ...rest } = options;
     let config;
     try {
-        config = (0, config_1.getConfig)();
+        config = getConfig();
     }
     catch (e) {
         config = null;
@@ -122,7 +113,7 @@ function getAxiosConfig(options) {
     if (config && config.httpUseLocalhost) {
         httpUseLocalhost = config.httpUseLocalhost;
     }
-    const baseURL = (0, urls_1.getHubSpotApiOrigin)(env, localHostOverride ? false : httpUseLocalhost);
+    const baseURL = getHubSpotApiOrigin(env, localHostOverride ? false : httpUseLocalhost);
     return {
         baseURL,
         headers: {
@@ -138,4 +129,3 @@ function getAxiosConfig(options) {
         ...rest,
     };
 }
-exports.getAxiosConfig = getAxiosConfig;

package/http/index.d.ts

@@ -1,5 +1,5 @@
 import { AxiosPromise } from 'axios';
-import { HttpOptions, HubSpotPromise } from '../types/Http';
+import { HttpOptions, HubSpotPromise } from '../types/Http.js';
 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>;
@@ -12,6 +12,6 @@ export declare const http: {
     put: typeof putRequest;
     patch: typeof patchRequest;
     delete: typeof deleteRequest;
-    getOctetStream: (accountId: number, options: HttpOptions, destPath: string) => AxiosPromise<any>;
+    getOctetStream: (accountId: number, options: HttpOptions, destPath: string) => AxiosPromise;
 };
 export {};

package/http/index.js

@@ -1,109 +1,24 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-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 = __importStar(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 logger_1 = require("../lib/logger");
-const lang_1 = require("../utils/lang");
-const HubSpotHttpError_1 = require("../models/HubSpotHttpError");
-const auth_1 = require("../constants/auth");
-const localDevAuth_1 = require("../api/localDevAuth");
-const fireAlarm_1 = require("../api/fireAlarm");
-const util = __importStar(require("util"));
-const trackUsage_1 = require("../lib/trackUsage");
+import path from 'path';
+import fs from 'fs-extra';
+import contentDisposition from 'content-disposition';
+import { getConfigAccountById } from '../config/index.js';
+import { USER_AGENTS, getAxiosConfig } from './getAxiosConfig.js';
+import { addQueryParams } from './addQueryParams.js';
+import { accessTokenForPersonalAccessKey } from '../lib/personalAccessKey.js';
+import { getOauthManager } from '../lib/oauth.js';
+import { logger } from '../lib/logger.js';
+import { i18n } from '../utils/lang.js';
+import { PERSONAL_ACCESS_KEY_AUTH_METHOD, OAUTH_AUTH_METHOD, API_KEY_AUTH_METHOD, } from '../constants/auth.js';
+import { httpClient } from './client.js';
 const i18nKey = 'http.index';
-const IGNORE_URLS_NETWORK_DEBUG = [
-    localDevAuth_1.LOCALDEVAUTH_ACCESS_TOKEN_PATH,
-    trackUsage_1.CMS_CLI_USAGE_PATH,
-    trackUsage_1.VSCODE_USAGE_PATH,
-    fireAlarm_1.FIREALARM_API_AUTH_PATH,
-];
-function logRequest(response) {
-    try {
-        if (!process.env.HUBSPOT_NETWORK_LOGGING) {
-            return;
-        }
-        if (!process.env.HUBSPOT_DEBUG_LOGGING_VERBOSE &&
-            IGNORE_URLS_NETWORK_DEBUG.some(url => response?.config?.url && response.config.url.includes(url))) {
-            return;
-        }
-        logger_1.logger.debug(util.inspect({
-            method: response.config.method,
-            baseURL: response.config.baseURL,
-            url: response.config.url,
-            data: response.data,
-            status: response.status,
-        }, false, null, true));
-    }
-    catch (error) {
-        // Ignore any errors that occur while logging the response
-    }
-}
-axios_1.default.interceptors.response.use((response) => {
-    logRequest(response);
-    return response;
-}, error => {
-    try {
-        if ((0, axios_1.isAxiosError)(error) && error.response) {
-            logRequest(error.response);
-        }
-    }
-    catch (e) {
-        // Ignore any errors that occur while logging the response
-    }
-    // Don't re-wrap if already a HubSpotHttpError. This can happen when
-    // multiple copies of local-dev-lib are loaded and share the same axios
-    // instance, causing multiple interceptors to be registered.
-    if (error instanceof HubSpotHttpError_1.HubSpotHttpError ||
-        error?.name === HubSpotHttpError_1.HubSpotHttpErrorName) {
-        return Promise.reject(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;
+export function addUserAgentHeader(key, value) {
+    USER_AGENTS[key] = value;
 }
-exports.addUserAgentHeader = addUserAgentHeader;
 async function withOauth(account, axiosConfig) {
     const { headers } = axiosConfig;
-    const oauth = (0, oauth_1.getOauthManager)(account);
+    const oauth = getOauthManager(account);
     if (!oauth) {
-        throw new Error((0, lang_1.i18n)(`${i18nKey}.errors.withOauth`, { accountId: account.accountId }));
+        throw new Error(i18n(`${i18nKey}.errors.withOauth`, { accountId: account.accountId }));
     }
     const accessToken = await oauth.accessToken();
     return {
@@ -116,7 +31,7 @@ async function withOauth(account, axiosConfig) {
 }
 async function withPersonalAccessKey(accountId, axiosConfig) {
     const { headers } = axiosConfig;
-    const accessToken = await (0, personalAccessKey_1.accessTokenForPersonalAccessKey)(accountId);
+    const accessToken = await accessTokenForPersonalAccessKey(accountId);
     return {
         ...axiosConfig,
         headers: {
@@ -136,16 +51,16 @@ function withPortalId(portalId, axiosConfig) {
     };
 }
 async function withAuth(accountId, options) {
-    const account = (0, config_1.getConfigAccountById)(accountId);
+    const account = getConfigAccountById(accountId);
     const { env, authType } = account;
-    const axiosConfig = withPortalId(accountId, (0, getAxiosConfig_1.getAxiosConfig)({ env, ...options }));
-    if (authType === auth_1.PERSONAL_ACCESS_KEY_AUTH_METHOD.value) {
+    const axiosConfig = withPortalId(accountId, getAxiosConfig({ env, ...options }));
+    if (authType === PERSONAL_ACCESS_KEY_AUTH_METHOD.value) {
         return withPersonalAccessKey(accountId, axiosConfig);
     }
-    if (authType === auth_1.OAUTH_AUTH_METHOD.value) {
+    if (authType === OAUTH_AUTH_METHOD.value) {
         return withOauth(account, axiosConfig);
     }
-    if (authType === auth_1.API_KEY_AUTH_METHOD.value) {
+    if (authType === API_KEY_AUTH_METHOD.value) {
         const { params } = axiosConfig;
         return {
             ...axiosConfig,
@@ -155,42 +70,42 @@ async function withAuth(accountId, options) {
             },
         };
     }
-    throw new Error((0, lang_1.i18n)(`${i18nKey}.errors.invalidAuthType`, {
+    throw new Error(i18n(`${i18nKey}.errors.invalidAuthType`, {
         accountId,
         authType,
     }));
 }
 async function getRequest(accountId, options) {
     const { params, ...rest } = options;
-    const optionsWithParams = (0, addQueryParams_1.addQueryParams)(rest, params);
+    const optionsWithParams = addQueryParams(rest, params);
     const requestConfig = await withAuth(accountId, optionsWithParams);
-    return (0, axios_1.default)(requestConfig);
+    return httpClient(requestConfig);
 }
 async function postRequest(accountId, options) {
     const requestConfig = await withAuth(accountId, options);
-    return (0, axios_1.default)({ ...requestConfig, method: 'post' });
+    return httpClient({ ...requestConfig, method: 'post' });
 }
 async function putRequest(accountId, options) {
     const requestConfig = await withAuth(accountId, options);
-    return (0, axios_1.default)({ ...requestConfig, method: 'put' });
+    return httpClient({ ...requestConfig, method: 'put' });
 }
 async function patchRequest(accountId, options) {
     const requestConfig = await withAuth(accountId, options);
-    return (0, axios_1.default)({ ...requestConfig, method: 'patch' });
+    return httpClient({ ...requestConfig, method: 'patch' });
 }
 async function deleteRequest(accountId, options) {
     const requestConfig = await withAuth(accountId, options);
-    return (0, axios_1.default)({ ...requestConfig, method: 'delete' });
+    return httpClient({ ...requestConfig, method: 'delete' });
 }
 function createGetRequestStream(contentType) {
     return async (accountId, options, destPath) => {
         const { params, ...rest } = options;
-        const axiosConfig = (0, addQueryParams_1.addQueryParams)(rest, params);
+        const axiosConfig = addQueryParams(rest, params);
         // eslint-disable-next-line no-async-promise-executor
         return new Promise(async (resolve, reject) => {
             try {
                 const { headers, ...opts } = await withAuth(accountId, axiosConfig);
-                const res = await (0, axios_1.default)({
+                const res = await httpClient({
                     method: 'get',
                     ...opts,
                     headers: {
@@ -201,20 +116,20 @@ function createGetRequestStream(contentType) {
                 });
                 if (res.status >= 200 && res.status < 300) {
                     let filepath = destPath;
-                    if (fs_extra_1.default.existsSync(destPath)) {
-                        const stat = fs_extra_1.default.statSync(destPath);
+                    if (fs.existsSync(destPath)) {
+                        const stat = fs.statSync(destPath);
                         if (stat.isDirectory()) {
-                            const { parameters } = content_disposition_1.default.parse(res.headers['content-disposition'] || '');
-                            filepath = path_1.default.join(destPath, parameters.filename);
+                            const { parameters } = contentDisposition.parse(res.headers['content-disposition'] || '');
+                            filepath = path.join(destPath, parameters.filename);
                         }
                     }
                     try {
-                        fs_extra_1.default.ensureFileSync(filepath);
+                        fs.ensureFileSync(filepath);
                     }
                     catch (err) {
                         reject(err);
                     }
-                    const writeStream = fs_extra_1.default.createWriteStream(filepath, {
+                    const writeStream = fs.createWriteStream(filepath, {
                         encoding: 'binary',
                     });
                     res.data.pipe(writeStream);
@@ -222,7 +137,7 @@ function createGetRequestStream(contentType) {
                         reject(err);
                     });
                     writeStream.on('close', async () => {
-                        logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.createGetRequestStream.onWrite`, {
+                        logger.log(i18n(`${i18nKey}.createGetRequestStream.onWrite`, {
                             filepath,
                         }));
                         resolve(res);
@@ -239,7 +154,7 @@ function createGetRequestStream(contentType) {
     };
 }
 const getOctetStream = createGetRequestStream('application/octet-stream');
-exports.http = {
+export const http = {
     get: getRequest,
     post: postRequest,
     put: putRequest,

package/http/unauthed.d.ts

@@ -1,4 +1,4 @@
-import { HttpOptions, HubSpotPromise } from '../types/Http';
+import { HttpOptions, HubSpotPromise } from '../types/Http.js';
 declare function getRequest<T>(options: HttpOptions): HubSpotPromise<T>;
 declare function postRequest<T>(options: HttpOptions): HubSpotPromise<T>;
 declare function putRequest<T>(options: HttpOptions): HubSpotPromise<T>;

package/http/unauthed.js

@@ -1,35 +1,29 @@
-"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");
+import { httpClient } from './client.js';
+import { getAxiosConfig } from './getAxiosConfig.js';
+import { addQueryParams } from './addQueryParams.js';
 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);
+    const optionsWithParams = addQueryParams(rest, params);
+    const requestConfig = await getAxiosConfig(optionsWithParams);
+    return httpClient(requestConfig);
 }
 async function postRequest(options) {
-    const requestConfig = await (0, getAxiosConfig_1.getAxiosConfig)(options);
-    return (0, axios_1.default)({ ...requestConfig, method: 'post' });
+    const requestConfig = await getAxiosConfig(options);
+    return httpClient({ ...requestConfig, method: 'post' });
 }
 async function putRequest(options) {
-    const requestConfig = await (0, getAxiosConfig_1.getAxiosConfig)(options);
-    return (0, axios_1.default)({ ...requestConfig, method: 'put' });
+    const requestConfig = await getAxiosConfig(options);
+    return httpClient({ ...requestConfig, method: 'put' });
 }
 async function patchRequest(options) {
-    const requestConfig = await (0, getAxiosConfig_1.getAxiosConfig)(options);
-    return (0, axios_1.default)({ ...requestConfig, method: 'patch' });
+    const requestConfig = await getAxiosConfig(options);
+    return httpClient({ ...requestConfig, method: 'patch' });
 }
 async function deleteRequest(options) {
-    const requestConfig = await (0, getAxiosConfig_1.getAxiosConfig)(options);
-    return (0, axios_1.default)({ ...requestConfig, method: 'delete' });
+    const requestConfig = await getAxiosConfig(options);
+    return httpClient({ ...requestConfig, method: 'delete' });
 }
-exports.http = {
+export const http = {
     get: getRequest,
     post: postRequest,
     put: putRequest,

package/lang/en.json

@@ -4,7 +4,8 @@
       "invalidEvent": "Usage tracking event {{ eventName }} is not a valid event type.",
       "sendingEventAuthenticated": "Sending usage event to authenticated endpoint",
       "retryingEventUnauthenticated": "Failed to send the usage event as authenticated. Trying again as unauthenticated.",
-      "sendingEventUnauthenticated": "Sending usage event to unauthenticated endpoint"
+      "sendingEventUnauthenticated": "Sending usage event to unauthenticated endpoint",
+      "unauthenticatedSendFailed": "Failed to send usage event to unauthenticated endpoint"
     },
     "archive": {
       "extractZip": {
@@ -315,7 +316,7 @@
       },
       "buildConfigFromEnvironment": {
         "missingAccountId": "HUBSPOT_ACCOUNT_ID is required, but not currently set",
-        "invalidAuthType": "Auth type is invalid. Use HUBSPOT_CLIENT_ID, HUBSPOT_CLIENT_SECRET, and HUBSPOT_REFRESH_TOKEN to authenticate with Oauth2, PERSONAL_ACCESS_KEY to authenticate with Personal Access Key, or API_KEY to authenticate with API Key."
+        "invalidAuthType": "Auth type is invalid. Use HUBSPOT_CLIENT_ID, HUBSPOT_CLIENT_SECRET, and HUBSPOT_REFRESH_TOKEN to authenticate with Oauth2, HUBSPOT_PERSONAL_ACCESS_KEY to authenticate with Personal Access Key, or API_KEY to authenticate with API Key."
       }
     },
     "defaultAccountOverride": {

package/lib/archive.d.ts

@@ -1,4 +1,2 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { CopySourceToDestOptions } from '../types/Archive';
+import { CopySourceToDestOptions } from '../types/Archive.js';
 export declare function extractZipArchive(zip: Buffer, name: string, dest: string, { sourceDir, includesRootDir, hideLogs, handleCollision, }?: CopySourceToDestOptions): Promise<boolean>;