@hubspot/local-dev-lib 0.2.2 → 0.2.3

package/api/fileMapper.d.ts

@@ -7,6 +7,6 @@ export declare function fetchModule(accountId: number, moduleId: number, options
 export declare function fetchFileStream(accountId: number, filePath: string, destination: string, options?: FileMapperOptions): Promise<FileMapperNode>;
 export declare function download(accountId: number, filepath: string, options?: FileMapperOptions): Promise<FileMapperNode>;
 export declare function downloadDefault(accountId: number, filepath: string, options?: FileMapperOptions): Promise<FileMapperNode>;
-export declare function deleteFile(accountId: number, filePath: string, options?: FileMapperOptions): Promise<void>;
+export declare function deleteFile(accountId: number, filePath: string): Promise<void>;
 export declare function moveFile(accountId: number, srcPath: string, destPath: string): Promise<void>;
-export declare function getDirectoryContentsByPath(accountId: number, path: string): Promise<void>;
+export declare function getDirectoryContentsByPath(accountId: number, path: string): Promise<FileMapperNode>;

package/api/fileMapper.js

@@ -83,10 +83,9 @@ async function downloadDefault(accountId, filepath, options = {}) {
 }
 exports.downloadDefault = downloadDefault;
 // Delete a file or folder by path
-async function deleteFile(accountId, filePath, options = {}) {
+async function deleteFile(accountId, filePath) {
     return http_1.default.delete(accountId, {
         url: `${exports.FILE_MAPPER_API_PATH}/delete/${encodeURIComponent(filePath)}`,
-        ...options,
     });
 }
 exports.deleteFile = deleteFile;
@@ -94,6 +93,7 @@ exports.deleteFile = deleteFile;
 async function moveFile(accountId, srcPath, destPath) {
     return http_1.default.put(accountId, {
         url: `${exports.FILE_MAPPER_API_PATH}/rename/${srcPath}?path=${destPath}`,
+        headers: { 'Content-Type': 'application/json' },
     });
 }
 exports.moveFile = moveFile;

package/api/functions.d.ts

@@ -1,4 +1,7 @@
+import { QueryParams } from '../types/Http';
 import { GetBuildStatusResponse, GetRoutesResponse } from '../types/Functions';
 export declare function getRoutes(accountId: number): Promise<GetRoutesResponse>;
+export declare function getFunctionLogs(accountId: number, route: string, query?: QueryParams): Promise<unknown>;
+export declare function getLatestFunctionLog(accountId: number, route: string): Promise<unknown>;
 export declare function buildPackage(accountId: number, folderPath: string): Promise<string>;
-export declare function getBuildStatus(portalId: number, buildId: number): Promise<GetBuildStatusResponse>;
+export declare function getBuildStatus(accountId: number, buildId: number): Promise<GetBuildStatusResponse>;

package/api/functions.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.getBuildStatus = exports.buildPackage = exports.getRoutes = void 0;
+exports.getBuildStatus = exports.buildPackage = exports.getLatestFunctionLog = exports.getFunctionLogs = exports.getRoutes = void 0;
 const http_1 = __importDefault(require("../http"));
 const FUNCTION_API_PATH = 'cms/v3/functions';
 async function getRoutes(accountId) {
@@ -12,6 +12,20 @@ async function getRoutes(accountId) {
     });
 }
 exports.getRoutes = getRoutes;
+async function getFunctionLogs(accountId, route, query = {}) {
+    const { limit = 5 } = query;
+    return http_1.default.get(accountId, {
+        url: `${FUNCTION_API_PATH}/results/by-route/${encodeURIComponent(route)}`,
+        query: { ...query, limit },
+    });
+}
+exports.getFunctionLogs = getFunctionLogs;
+async function getLatestFunctionLog(accountId, route) {
+    return http_1.default.get(accountId, {
+        url: `${FUNCTION_API_PATH}/results/by-route/${encodeURIComponent(route)}/latest`,
+    });
+}
+exports.getLatestFunctionLog = getLatestFunctionLog;
 async function buildPackage(accountId, folderPath) {
     return http_1.default.post(accountId, {
         url: `${FUNCTION_API_PATH}/build/async`,
@@ -24,8 +38,8 @@ async function buildPackage(accountId, folderPath) {
     });
 }
 exports.buildPackage = buildPackage;
-async function getBuildStatus(portalId, buildId) {
-    return http_1.default.get(portalId, {
+async function getBuildStatus(accountId, buildId) {
+    return http_1.default.get(accountId, {
         url: `${FUNCTION_API_PATH}/build/${buildId}/poll`,
     });
 }

package/api/projects.js

@@ -50,7 +50,7 @@ async function downloadProject(accountId, projectName, buildId) {
     return http_1.default.get(accountId, {
         url: `${PROJECTS_API_PATH}/${encodeURIComponent(projectName)}/builds/${buildId}/archive-full`,
         encoding: null,
-        headers: { accept: 'application/zip', contentType: 'application/json' },
+        headers: { accept: 'application/zip', 'Content-Type': 'application/json' },
     });
 }
 exports.downloadProject = downloadProject;

package/errors/apiErrors.d.ts

@@ -5,10 +5,7 @@ export declare function isMissingScopeError(err: AxiosError<any>): boolean;
 export declare function isGatingError(err: AxiosError<any>): boolean;
 export declare function isApiUploadValidationError(err: AxiosError<any>): boolean;
 export declare function isSpecifiedHubSpotAuthError(err: GenericError, { status, category, subCategory }: Partial<HubSpotAuthError>): boolean;
-/**
- * @throws
- */
-export declare function throwAxiosErrorWithContext(error: AxiosError<any>, context?: AxiosErrorContext): never;
+export declare function getAxiosErrorWithContext(error: AxiosError<any>, context?: AxiosErrorContext): Error;
 /**
  * @throws
  */

package/errors/apiErrors.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.throwApiUploadError = exports.throwApiError = exports.throwAxiosErrorWithContext = exports.isSpecifiedHubSpotAuthError = exports.isApiUploadValidationError = exports.isGatingError = exports.isMissingScopeError = void 0;
+exports.throwApiUploadError = exports.throwApiError = exports.getAxiosErrorWithContext = exports.isSpecifiedHubSpotAuthError = exports.isApiUploadValidationError = exports.isGatingError = exports.isMissingScopeError = void 0;
 const api_1 = require("../constants/api");
 const lang_1 = require("../utils/lang");
 const standardErrors_1 = require("./standardErrors");
@@ -57,37 +57,40 @@ function parseValidationErrors(responseData = { errors: [], message: '' }) {
     }
     return errorMessages;
 }
+/**
+ * @throws
+ */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-function logValidationErrors(error) {
+function throwValidationErrors(error) {
     const validationErrorMessages = parseValidationErrors(error?.response?.data);
     if (validationErrorMessages.length) {
         (0, standardErrors_1.throwError)(new Error(validationErrorMessages.join(' '), { cause: error }));
     }
 }
-/**
- * @throws
- */
-function throwAxiosErrorWithContext(
+function getAxiosErrorWithContext(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 error, context = {}) {
     const { status } = error;
     const method = error.config?.method;
     const { projectName } = context;
-    const isPutOrPost = method === 'put' || method === 'post';
-    const action = method && (api_1.HTTP_METHOD_VERBS[method] || api_1.HTTP_METHOD_VERBS.get);
-    const preposition = (method && api_1.HTTP_METHOD_PREPOSITIONS[method]) ||
-        api_1.HTTP_METHOD_PREPOSITIONS.get;
-    const request = context.request
-        ? `${action} ${preposition} "${context.request}"`
-        : action;
-    const messageDetail = request && context.accountId
-        ? (0, lang_1.i18n)(`${i18nKey}.messageDetail`, {
-            request,
+    let messageDetail;
+    if (context.accountId) {
+        const action = (method && api_1.HTTP_METHOD_VERBS[method]) || api_1.HTTP_METHOD_VERBS.get;
+        const preposition = (method && api_1.HTTP_METHOD_PREPOSITIONS[method]) ||
+            api_1.HTTP_METHOD_PREPOSITIONS.get;
+        const requestName = context.request
+            ? `${action} ${preposition} '${context.request}'`
+            : action;
+        messageDetail = (0, lang_1.i18n)(`${i18nKey}.messageDetail`, {
             accountId: context.accountId,
-        })
-        : 'request';
+            requestName,
+        });
+    }
+    else {
+        messageDetail = (0, lang_1.i18n)(`${i18nKey}.genericMessageDetail`);
+    }
     const errorMessage = [];
-    if (isPutOrPost && context.payload) {
+    if ((method === 'put' || method === 'post') && context.payload) {
         errorMessage.push((0, lang_1.i18n)(`${i18nKey}.unableToUpload`, { payload: context.payload }));
     }
     const isProjectMissingScopeError = isMissingScopeError(error) && projectName;
@@ -101,12 +104,12 @@ error, context = {}) {
             break;
         case 403:
             if (isProjectMissingScopeError) {
-                errorMessage.push((0, lang_1.i18n)(`${i18nKey}.codes.403MissingScope`, {
+                errorMessage.push((0, lang_1.i18n)(`${i18nKey}.codes.403ProjectMissingScope`, {
                     accountId: context.accountId || '',
                 }));
             }
             else if (isProjectGatingError) {
-                errorMessage.push((0, lang_1.i18n)(`${i18nKey}.codes.403Gating`, {
+                errorMessage.push((0, lang_1.i18n)(`${i18nKey}.codes.403ProjectGating`, {
                     accountId: context.accountId || '',
                 }));
             }
@@ -115,16 +118,7 @@ error, context = {}) {
             }
             break;
         case 404:
-            if (context.request) {
-                errorMessage.push((0, lang_1.i18n)(`${i18nKey}.codes.404Request`, {
-                    action: action || 'request',
-                    request: context.request,
-                    account: context.accountId || '',
-                }));
-            }
-            else {
-                errorMessage.push((0, lang_1.i18n)(`${i18nKey}.codes.404`, { messageDetail }));
-            }
+            errorMessage.push((0, lang_1.i18n)(`${i18nKey}.codes.404`, { messageDetail }));
             break;
         case 429:
             errorMessage.push((0, lang_1.i18n)(`${i18nKey}.codes.429`, { messageDetail }));
@@ -144,25 +138,28 @@ error, context = {}) {
             }
             break;
     }
-    if (error?.response?.data?.message &&
-        !isProjectMissingScopeError &&
-        !isProjectGatingError) {
-        errorMessage.push(error.response.data.message);
-    }
-    if (error?.response?.data?.errors) {
-        error.response.data.errors.forEach((err) => {
-            errorMessage.push('\n- ' + err.message);
-        });
+    if (error?.response?.data) {
+        const { message, errors } = error.response.data;
+        if (message && !isProjectMissingScopeError && !isProjectGatingError) {
+            errorMessage.push(message);
+        }
+        if (errors) {
+            errors.forEach((err) => {
+                if (err.message) {
+                    errorMessage.push('\n- ' + err.message);
+                }
+            });
+        }
     }
-    (0, standardErrors_1.throwError)(new Error(errorMessage.join(' '), { cause: error }));
+    return new Error(errorMessage.join(' '), { cause: error });
 }
-exports.throwAxiosErrorWithContext = throwAxiosErrorWithContext;
+exports.getAxiosErrorWithContext = getAxiosErrorWithContext;
 /**
  * @throws
  */
 function throwApiError(error, context = {}) {
     if (error.isAxiosError) {
-        throwAxiosErrorWithContext(error, context);
+        throw getAxiosErrorWithContext(error, context);
     }
     (0, standardErrors_1.throwError)(error);
 }
@@ -172,7 +169,7 @@ exports.throwApiError = throwApiError;
  */
 function throwApiUploadError(error, context = {}) {
     if (isApiUploadValidationError(error)) {
-        logValidationErrors(error);
+        throwValidationErrors(error);
     }
     throwApiError(error, context);
 }

package/errors/fileSystemErrors.d.ts

@@ -1,4 +1,5 @@
 import { BaseError, FileSystemErrorContext } from '../types/Error';
+export declare function getFileSystemError(error: BaseError, context: FileSystemErrorContext): Error;
 /**
  * @throws
  */

package/errors/fileSystemErrors.js

@@ -1,13 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.throwFileSystemError = void 0;
+exports.throwFileSystemError = exports.getFileSystemError = void 0;
 const lang_1 = require("../utils/lang");
 const standardErrors_1 = require("./standardErrors");
 const i18nKey = 'errors.fileSystemErrors';
-/**
- * @throws
- */
-function throwFileSystemError(error, context) {
+function getFileSystemError(error, context) {
     let fileAction = '';
     if (context.read) {
         fileAction = (0, lang_1.i18n)(`${i18nKey}.readAction`);
@@ -26,6 +23,13 @@ function throwFileSystemError(error, context) {
     if ((0, standardErrors_1.isSystemError)(error)) {
         message.push((0, lang_1.i18n)(`${i18nKey}.baseMessage`, { errorMessage: error.message }));
     }
-    throw new Error(message.join(' '), { cause: error });
+    return new Error(message.join(' '), { cause: error });
+}
+exports.getFileSystemError = getFileSystemError;
+/**
+ * @throws
+ */
+function throwFileSystemError(error, context) {
+    throw getFileSystemError(error, context);
 }
 exports.throwFileSystemError = throwFileSystemError;

package/errors/standardErrors.d.ts

@@ -9,12 +9,6 @@ export declare function isFatalError(err: BaseError): boolean;
 export declare function throwErrorWithMessage(identifier: LangKey, interpolation?: {
     [key: string]: string | number;
 }, cause?: BaseError): never;
-/**
- * @throws
- */
-export declare function throwTypeErrorWithMessage(identifier: LangKey, interpolation?: {
-    [key: string]: string | number;
-}, cause?: BaseError): never;
 /**
  * @throws
  */

package/errors/standardErrors.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.throwError = exports.throwAuthErrorWithMessage = exports.throwTypeErrorWithMessage = exports.throwErrorWithMessage = exports.isFatalError = exports.isSystemError = void 0;
+exports.throwError = exports.throwAuthErrorWithMessage = exports.throwErrorWithMessage = exports.isFatalError = exports.isSystemError = void 0;
 const HubSpotAuthError_1 = require("../models/HubSpotAuthError");
 const lang_1 = require("../utils/lang");
 function isSystemError(err) {
@@ -25,13 +25,6 @@ function throwErrorWithMessage(identifier, interpolation, cause) {
     genericThrowErrorWithMessage(Error, identifier, interpolation, cause);
 }
 exports.throwErrorWithMessage = throwErrorWithMessage;
-/**
- * @throws
- */
-function throwTypeErrorWithMessage(identifier, interpolation, cause) {
-    genericThrowErrorWithMessage(TypeError, identifier, interpolation, cause);
-}
-exports.throwTypeErrorWithMessage = throwTypeErrorWithMessage;
 /**
  * @throws
  */

package/http/getAxiosConfig.js

@@ -8,12 +8,13 @@ exports.DEFAULT_USER_AGENT_HEADERS = {
     'User-Agent': `HubSpot Local Dev Lib/${package_json_1.version}`,
 };
 function getAxiosConfig(options) {
-    const { env, localHostOverride, ...rest } = options;
+    const { env, localHostOverride, headers, ...rest } = options;
     const { httpTimeout, httpUseLocalhost } = (0, config_1.getAndLoadConfigIfNeeded)();
     return {
         baseURL: (0, urls_1.getHubSpotApiOrigin)(env, localHostOverride ? false : httpUseLocalhost),
         headers: {
             ...exports.DEFAULT_USER_AGENT_HEADERS,
+            ...(headers || {}),
         },
         timeout: httpTimeout || 15000,
         ...rest,

package/lang/en.json

@@ -379,7 +379,8 @@
             "baseMessage": "An error occurred while {{ fileAction }} {{ filepath }}."
         },
         "apiErrors": {
-            "messageDetail": "{{ request }} in account {{ accountId }}",
+            "messageDetail": "{{ requestName }} in account {{ accountId }}",
+            "genericMessageDetail": "request",
             "unableToUpload": "Unable to upload \"{{ payload }}.",
             "codes": {
                 "400": "The {{ messageDetail }} was bad.",
@@ -388,9 +389,8 @@
                 "404": "The {{ messageDetail }} was not found.",
                 "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.",
-                "403MissingScope": "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.",
-                "403Gating": "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.",
-                "404Request": "The {{ action }} failed because \"{{ request }}\" was not found in account {{ accountId }}.",
+                "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.",
                 "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

@@ -379,7 +379,8 @@
       "baseMessage": "An error occurred while {{ fileAction }} {{ filepath }}."
     },
     "apiErrors": {
-      "messageDetail": "{{ request }} in account {{ accountId }}",
+      "messageDetail": "{{ requestName }} in account {{ accountId }}",
+      "genericMessageDetail": "request",
       "unableToUpload": "Unable to upload \"{{ payload }}.",
       "codes": {
         "400": "The {{ messageDetail }} was bad.",
@@ -388,9 +389,8 @@
         "404": "The {{ messageDetail }} was not found.",
         "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.",
-        "403MissingScope": "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.",
-        "403Gating": "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.",
-        "404Request": "The {{ action }} failed because \"{{ request }}\" was not found in account {{ accountId }}.",
+        "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.",
         "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/lib/fileMapper.js

@@ -82,7 +82,7 @@ function validateFileMapperNode(node) {
     catch (err) {
         json = node;
     }
-    (0, standardErrors_1.throwTypeErrorWithMessage)(`${i18nKey}.errors.invalidNode`, {
+    (0, standardErrors_1.throwErrorWithMessage)(`${i18nKey}.errors.invalidNode`, {
         json: JSON.stringify(json),
     });
 }

package/package.json

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

package/types/Http.d.ts

@@ -15,6 +15,7 @@ export type AxiosConfigOptions = {
     data?: Data;
     resolveWithFullResponse?: boolean;
     timeout?: number;
+    headers?: Data;
 };
 export type FormData = {
     [key: string]: string | ReadStream;

package/utils/cms/modules.js

@@ -19,7 +19,7 @@ exports.isPathInput = isPathInput;
 function throwInvalidPathInput(pathInput) {
     if (isPathInput(pathInput))
         return;
-    (0, standardErrors_1.throwTypeErrorWithMessage)(`${i18nKey}.throwInvalidPathInput`);
+    (0, standardErrors_1.throwErrorWithMessage)(`${i18nKey}.throwInvalidPathInput`);
 }
 function isModuleFolder(pathInput) {
     throwInvalidPathInput(pathInput);