@hubspot/local-dev-lib 0.3.14 → 1.0.0

package/api/github.js

@@ -16,7 +16,7 @@ const GITHUB_AUTH_HEADERS = {
 async function fetchRepoReleaseData(repoPath, tag = '') {
     const URL = `${GITHUB_REPOS_API}/${repoPath}/releases`;
     return axios_1.default.get(`${URL}/${tag ? `tags/${tag}` : 'latest'}`, {
-        headers: { ...getAxiosConfig_1.DEFAULT_USER_AGENT_HEADERS, ...GITHUB_AUTH_HEADERS },
+        headers: { ...(0, getAxiosConfig_1.getDefaultUserAgentHeader)(), ...GITHUB_AUTH_HEADERS },
     });
 }
 exports.fetchRepoReleaseData = fetchRepoReleaseData;
@@ -25,21 +25,21 @@ exports.fetchRepoReleaseData = fetchRepoReleaseData;
 async function fetchRepoAsZip(zipUrl) {
     return axios_1.default.get(zipUrl, {
         responseType: 'arraybuffer',
-        headers: { ...getAxiosConfig_1.DEFAULT_USER_AGENT_HEADERS, ...GITHUB_AUTH_HEADERS },
+        headers: { ...(0, getAxiosConfig_1.getDefaultUserAgentHeader)(), ...GITHUB_AUTH_HEADERS },
     });
 }
 exports.fetchRepoAsZip = fetchRepoAsZip;
 // Returns the raw file contents via the raw.githubusercontent endpoint
 async function fetchRepoFile(repoPath, filePath, ref) {
     return axios_1.default.get(`${GITHUB_RAW_CONTENT_API_PATH}/${repoPath}/${ref}/${filePath}`, {
-        headers: { ...getAxiosConfig_1.DEFAULT_USER_AGENT_HEADERS, ...GITHUB_AUTH_HEADERS },
+        headers: { ...(0, getAxiosConfig_1.getDefaultUserAgentHeader)(), ...GITHUB_AUTH_HEADERS },
     });
 }
 exports.fetchRepoFile = fetchRepoFile;
 // Returns the raw file contents via the raw.githubusercontent endpoint
 async function fetchRepoFileByDownloadUrl(downloadUrl) {
     return axios_1.default.get(downloadUrl, {
-        headers: { ...getAxiosConfig_1.DEFAULT_USER_AGENT_HEADERS, ...GITHUB_AUTH_HEADERS },
+        headers: { ...(0, getAxiosConfig_1.getDefaultUserAgentHeader)(), ...GITHUB_AUTH_HEADERS },
     });
 }
 exports.fetchRepoFileByDownloadUrl = fetchRepoFileByDownloadUrl;
@@ -48,7 +48,7 @@ exports.fetchRepoFileByDownloadUrl = fetchRepoFileByDownloadUrl;
 async function fetchRepoContents(repoPath, path, ref) {
     const refQuery = ref ? `?ref=${ref}` : '';
     return axios_1.default.get(`${GITHUB_REPOS_API}/${repoPath}/contents/${path}${refQuery}`, {
-        headers: { ...getAxiosConfig_1.DEFAULT_USER_AGENT_HEADERS, ...GITHUB_AUTH_HEADERS },
+        headers: { ...(0, getAxiosConfig_1.getDefaultUserAgentHeader)(), ...GITHUB_AUTH_HEADERS },
     });
 }
 exports.fetchRepoContents = fetchRepoContents;

package/http/getAxiosConfig.d.ts

@@ -1,6 +1,9 @@
 import { AxiosConfigOptions } 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;

package/http/getAxiosConfig.js

@@ -1,12 +1,22 @@
 "use strict";
 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}`,
+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,
 };
@@ -16,7 +26,7 @@ function getAxiosConfig(options) {
     return {
         baseURL: (0, urls_1.getHubSpotApiOrigin)(env, localHostOverride ? false : httpUseLocalhost),
         headers: {
-            ...exports.DEFAULT_USER_AGENT_HEADERS,
+            ...getDefaultUserAgentHeader(),
             ...(headers || {}),
         },
         timeout: httpTimeout || 15000,

package/http/index.d.ts

@@ -1,5 +1,6 @@
 import { AxiosResponse } from 'axios';
 import { HttpOptions } from '../types/Http';
+export declare function addUserAgentHeader(key: string, value: string): void;
 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>;

package/http/index.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+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"));
@@ -15,6 +16,10 @@ const standardErrors_1 = require("../errors/standardErrors");
 const logger_1 = require("../lib/logger");
 const lang_1 = require("../utils/lang");
 const i18nKey = 'http.index';
+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);

package/lang/en.json

@@ -380,7 +380,7 @@
                 "429": "The {{ messageDetail }} surpassed the rate limit. Retry in one minute.",
                 "503": "The {{ messageDetail }} could not be handled at this time. Please try again or visit https://help.hubspot.com/ to submit a ticket or contact HubSpot Support if the issue persists.",
                 "403ProjectMissingScope": "Couldn't run the project command because there are scopes missing in your production account. To update scopes, deactivate your current personal access key for {{ accountId }}, and generate a new one. Then run `hs auth` to update the CLI with the new key.",
-                "403ProjectGating": "The current target account {{ accountId }} does not have access to HubSpot projects. To opt in to the CRM Development Beta and use projects, visit https://app.hubspot.com/l/whats-new/betas?productUpdateId=13860216.",
+                "403ProjectGating": "The current target account {{ accountId }} does not have access to HubSpot projects. To opt in to the CRM Development Beta and use projects, visit https://app.hubspot.com/l/product-updates/in-beta?update=13899236.",
                 "500Generic": "The {{ messageDetail }} failed due to a server error. Please try again or visit https://help.hubspot.com/ to submit a ticket or contact HubSpot Support if the issue persists.",
                 "400Generic": "The {{ messageDetail }} failed due to a client error.",
                 "generic": "The {{ messageDetail }} failed."

package/lang/lang/en.json

@@ -380,7 +380,7 @@
         "429": "The {{ messageDetail }} surpassed the rate limit. Retry in one minute.",
         "503": "The {{ messageDetail }} could not be handled at this time. Please try again or visit https://help.hubspot.com/ to submit a ticket or contact HubSpot Support if the issue persists.",
         "403ProjectMissingScope": "Couldn't run the project command because there are scopes missing in your production account. To update scopes, deactivate your current personal access key for {{ accountId }}, and generate a new one. Then run `hs auth` to update the CLI with the new key.",
-        "403ProjectGating": "The current target account {{ accountId }} does not have access to HubSpot projects. To opt in to the CRM Development Beta and use projects, visit https://app.hubspot.com/l/whats-new/betas?productUpdateId=13860216.",
+        "403ProjectGating": "The current target account {{ accountId }} does not have access to HubSpot projects. To opt in to the CRM Development Beta and use projects, visit https://app.hubspot.com/l/product-updates/in-beta?update=13899236.",
         "500Generic": "The {{ messageDetail }} failed due to a server error. Please try again or visit https://help.hubspot.com/ to submit a ticket or contact HubSpot Support if the issue persists.",
         "400Generic": "The {{ messageDetail }} failed due to a client error.",
         "generic": "The {{ messageDetail }} failed."

package/package.json

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