@hubspot/local-dev-lib 0.0.6 → 0.0.7

package/errors/apiErrors.d.ts

@@ -1,9 +1,23 @@
-import { StatusCodeError, StatusCodeErrorContext } from '../types/Error';
-import { HubSpotAuthError } from './HubSpotAuthError';
-export declare function isMissingScopeError(err: StatusCodeError): boolean;
-export declare function isGatingError(err: StatusCodeError): boolean;
-export declare function isSpecifiedHubSpotAuthError(err: HubSpotAuthError, { statusCode, category, subCategory }: Partial<HubSpotAuthError>): boolean;
+import { GenericError, StatusCodeError, StatusCodeErrorContext } from '../types/Error';
+import { HubSpotAuthError } from '../models/HubSpotAuthError';
+export declare function isApiStatusCodeError(err: GenericError): boolean;
+export declare function isMissingScopeError(err: GenericError): boolean;
+export declare function isGatingError(err: GenericError): boolean;
+export declare function isApiUploadValidationError(err: GenericError): boolean;
+export declare function isSpecifiedHubSpotAuthError(err: GenericError, { statusCode, category, subCategory }: Partial<HubSpotAuthError>): boolean;
+/**
+ * @throws
+ */
 export declare function throwStatusCodeError(error: StatusCodeError, context?: StatusCodeErrorContext): never;
-export declare function throwApiStatusCodeError(error: StatusCodeError, context: StatusCodeErrorContext): never;
-export declare function throwApiError(error: StatusCodeError, context: StatusCodeErrorContext): never;
-export declare function throwApiUploadError(error: StatusCodeError, context: StatusCodeErrorContext): never;
+/**
+ * @throws
+ */
+export declare function throwApiStatusCodeError(error: StatusCodeError, context?: StatusCodeErrorContext): never;
+/**
+ * @throws
+ */
+export declare function throwApiError(error: StatusCodeError, context?: StatusCodeErrorContext): never;
+/**
+ * @throws
+ */
+export declare function throwApiUploadError(error: StatusCodeError, context?: StatusCodeErrorContext): never;

package/errors/apiErrors.js

@@ -1,38 +1,41 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.throwApiUploadError = exports.throwApiError = exports.throwApiStatusCodeError = exports.throwStatusCodeError = exports.isSpecifiedHubSpotAuthError = exports.isGatingError = exports.isMissingScopeError = void 0;
+exports.throwApiUploadError = exports.throwApiError = exports.throwApiStatusCodeError = exports.throwStatusCodeError = exports.isSpecifiedHubSpotAuthError = exports.isApiUploadValidationError = exports.isGatingError = exports.isMissingScopeError = exports.isApiStatusCodeError = void 0;
 const api_1 = require("../constants/api");
 const lang_1 = require("../utils/lang");
 const standardErrors_1 = require("./standardErrors");
 function isApiStatusCodeError(err) {
     return (err.name === 'StatusCodeError' ||
-        (err.statusCode && err.statusCode >= 100 && err.statusCode < 600));
+        (!!err.statusCode && err.statusCode >= 100 && err.statusCode < 600));
 }
+exports.isApiStatusCodeError = isApiStatusCodeError;
 function isMissingScopeError(err) {
-    return Boolean(err.name === 'StatusCodeError' &&
+    return (isApiStatusCodeError(err) &&
         err.statusCode === 403 &&
-        err.error &&
+        !!err.error &&
         err.error.category === 'MISSING_SCOPES');
 }
 exports.isMissingScopeError = isMissingScopeError;
 function isGatingError(err) {
-    return Boolean(err.name === 'StatusCodeError' &&
+    return (isApiStatusCodeError(err) &&
         err.statusCode === 403 &&
-        err.error &&
+        !!err.error &&
         err.error.category === 'GATED');
 }
 exports.isGatingError = isGatingError;
 function isApiUploadValidationError(err) {
-    return Boolean(err.statusCode === 400 &&
-        err.response &&
-        err.response.body &&
-        (err.response.body.message || err.response.body.errors));
+    return (isApiStatusCodeError(err) &&
+        err.statusCode === 400 &&
+        !!err.response &&
+        !!err.response.body &&
+        !!(err.response.body.message || !!err.response.body.errors));
 }
+exports.isApiUploadValidationError = isApiUploadValidationError;
 function isSpecifiedHubSpotAuthError(err, { statusCode, category, subCategory }) {
     const statusCodeErr = !statusCode || err.statusCode === statusCode;
     const categoryErr = !category || err.category === category;
     const subCategoryErr = !subCategory || err.subCategory === subCategory;
-    return (err.name === 'HubSpotAuthError' &&
+    return Boolean(err.name === 'HubSpotAuthError' &&
         statusCodeErr &&
         categoryErr &&
         subCategoryErr);
@@ -63,22 +66,28 @@ function logValidationErrors(error) {
         (0, standardErrors_1.throwError)(new Error(validationErrorMessages.join(' '), { cause: error }));
     }
 }
+/**
+ * @throws
+ */
 function throwStatusCodeError(error, context = {}) {
     const { statusCode, message, response } = error;
     const errorData = JSON.stringify({
         statusCode,
         message,
-        url: response.request.href,
-        method: response.request.method,
-        response: response.body,
-        headers: response.headers,
+        url: response ? response.request.href : null,
+        method: response ? response.request.method : null,
+        response: response ? response.body : null,
+        headers: response ? response.headers : null,
         context,
     });
     throw new Error(errorData, { cause: error });
 }
 exports.throwStatusCodeError = throwStatusCodeError;
-function throwApiStatusCodeError(error, context) {
-    const i18nKey = 'errors.api';
+/**
+ * @throws
+ */
+function throwApiStatusCodeError(error, context = {}) {
+    const i18nKey = 'errors.errorTypes.api';
     const { statusCode } = error;
     const { method } = error.options || {};
     const { projectName } = context;
@@ -166,14 +175,20 @@ function throwApiStatusCodeError(error, context) {
     (0, standardErrors_1.throwError)(new Error(errorMessage.join(' '), { cause: error }));
 }
 exports.throwApiStatusCodeError = throwApiStatusCodeError;
-function throwApiError(error, context) {
+/**
+ * @throws
+ */
+function throwApiError(error, context = {}) {
     if (isApiStatusCodeError(error)) {
         throwApiStatusCodeError(error, context);
     }
     (0, standardErrors_1.throwError)(error);
 }
 exports.throwApiError = throwApiError;
-function throwApiUploadError(error, context) {
+/**
+ * @throws
+ */
+function throwApiUploadError(error, context = {}) {
     if (isApiUploadValidationError(error)) {
         logValidationErrors(error);
     }

package/errors/standardErrors.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.throwError = exports.throwAuthErrorWithMessage = exports.throwTypeErrorWithMessage = exports.throwErrorWithMessage = exports.isFatalError = exports.isSystemError = void 0;
-const HubSpotAuthError_1 = require("./HubSpotAuthError");
+const HubSpotAuthError_1 = require("../models/HubSpotAuthError");
 const lang_1 = require("../utils/lang");
 const apiErrors_1 = require("./apiErrors");
 function isSystemError(err) {

package/lang/en.lyaml

@@ -134,8 +134,8 @@ en:
       logging:
         creatingFile: "Creating file at {{ path }}"
     processFieldsJs:
-      converting: "Converting \"{{ src }}\" to \"{{ dest }}\"."
-      converted: "Finished converting \"{{ src }}\" to \"{{ dest }}\"."
+      converting: 'Converting "{{ src }}" to "{{ dest }}".'
+      converted: 'Finished converting "{{ src }}" to "{{ dest }}".'
   errors:
     hubdb:
       invalidJsonPath: "The HubDB table file must be a '.json' file"
@@ -242,6 +242,6 @@ en:
       fetchTaskStatus: "There was an error fetching the task status while syncing sandboxes."
       fetchTypes: "There was an error fetching sandbox types."
     processFieldsJs:
-      fieldsJsNotReturnArray: "There was an error loading JS file \"{{ path }}\". Expected type \"Array\". Make sure that your function returns an array"
-      fieldsJsNotFunction:  "There was an error loading JS file \"{{ path }}\". Expected type \"Function\". Make sure that your default export is a function."
+      fieldsJsNotReturnArray: 'There was an error loading JS file "{{ path }}". Expected type "Array". Make sure that your function returns an array'
+      fieldsJsNotFunction: 'There was an error loading JS file "{{ path }}". Expected type "Function". Make sure that your default export is a function.'
       invalidMjsFile: ".mjs files are only supported when using Node 13.2.0+"

package/lib/fileMapper.d.ts

@@ -1,7 +1,23 @@
-import { Mode, FileMapperOptions, FileMapperInputOptions } from '../types/Files';
+import { FileMapperNode, Mode, FileMapperOptions, FileMapperInputOptions } from '../types/Files';
 import { LogCallbacksArg } from '../types/LogCallbacks';
-export declare function getFileMapperQueryValues(mode: Mode | null, { staging, assetVersion }: FileMapperInputOptions): FileMapperOptions;
+export declare function isPathToFile(filepath: string): boolean;
+export declare function isPathToModule(filepath: string): boolean;
+export declare function isPathToRoot(filepath: string): boolean;
+export declare function isPathToHubspot(filepath: string): boolean;
+export declare function getFileMapperQueryValues(mode?: Mode | null, { staging, assetVersion }?: FileMapperInputOptions): FileMapperOptions;
+type PathTypeData = {
+    isModule: boolean;
+    isHubspot: boolean;
+    isFile: boolean;
+    isRoot: boolean;
+    isFolder: boolean;
+};
+export declare function getTypeDataFromPath(src: string): PathTypeData;
+type RecursiveFileMapperCallback = (node: FileMapperNode, filepath?: string, depth?: number) => boolean;
+export declare function recurseFolder(node: FileMapperNode, callback: RecursiveFileMapperCallback, filepath?: string, depth?: number): boolean;
+export declare function writeUtimes(accountId: number, filepath: string, node: FileMapperNode): Promise<void>;
 declare const filemapperCallbackKeys: string[];
+export declare function fetchFolderFromApi(accountId: number, src: string, mode?: Mode, options?: FileMapperInputOptions, logCallbacks?: LogCallbacksArg<typeof filemapperCallbackKeys>): Promise<FileMapperNode>;
 /**
  * Fetch a file/folder and write to local file system.
  *
@@ -9,5 +25,5 @@ declare const filemapperCallbackKeys: string[];
  * @param {FileMapperInputArguments} input
  * @returns {Promise}
  */
-export declare function downloadFileOrFolder(accountId: number, src: string, dest: string, mode: Mode, options: FileMapperInputOptions | undefined, logCallbacks: LogCallbacksArg<typeof filemapperCallbackKeys>): Promise<void>;
+export declare function downloadFileOrFolder(accountId: number, src: string, dest: string, mode?: Mode, options?: FileMapperInputOptions, logCallbacks?: LogCallbacksArg<typeof filemapperCallbackKeys>): Promise<void>;
 export {};

package/lib/fileMapper.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.downloadFileOrFolder = exports.getFileMapperQueryValues = void 0;
+exports.downloadFileOrFolder = exports.fetchFolderFromApi = exports.writeUtimes = exports.recurseFolder = exports.getTypeDataFromPath = exports.getFileMapperQueryValues = exports.isPathToHubspot = exports.isPathToRoot = exports.isPathToModule = exports.isPathToFile = void 0;
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const path_1 = __importDefault(require("path"));
 const p_queue_1 = __importDefault(require("p-queue"));
@@ -22,26 +22,30 @@ function isPathToFile(filepath) {
     const ext = (0, path_2.getExt)(filepath);
     return !!ext && ext !== extensions_1.MODULE_EXTENSION && ext !== extensions_1.FUNCTIONS_EXTENSION;
 }
+exports.isPathToFile = isPathToFile;
 function isPathToModule(filepath) {
     const ext = (0, path_2.getExt)(filepath);
     return ext === extensions_1.MODULE_EXTENSION;
 }
+exports.isPathToModule = isPathToModule;
 function isPathToRoot(filepath) {
     if (typeof filepath !== 'string')
         return false;
     // Root pattern matches empty strings and: / \
     return /^(\/|\\)?$/.test(filepath.trim());
 }
+exports.isPathToRoot = isPathToRoot;
 function isPathToHubspot(filepath) {
     if (typeof filepath !== 'string')
         return false;
     return /^(\/|\\)?@hubspot/i.test(filepath.trim());
 }
+exports.isPathToHubspot = isPathToHubspot;
 function useApiBuffer(mode) {
     return mode === files_1.MODE.draft;
 }
 // Determines API param based on mode an options
-function getFileMapperQueryValues(mode, { staging, assetVersion }) {
+function getFileMapperQueryValues(mode, { staging, assetVersion } = {}) {
     return {
         params: {
             buffer: useApiBuffer(mode),
@@ -88,6 +92,7 @@ function getTypeDataFromPath(src) {
         isFolder,
     };
 }
+exports.getTypeDataFromPath = getTypeDataFromPath;
 function recurseFolder(node, callback, filepath = '', depth = 0) {
     validateFileMapperNode(node);
     const isRootFolder = node.folder && depth === 0;
@@ -108,6 +113,7 @@ function recurseFolder(node, callback, filepath = '', depth = 0) {
     });
     return depth === 0 ? false : __break;
 }
+exports.recurseFolder = recurseFolder;
 async function writeUtimes(accountId, filepath, node) {
     try {
         const now = new Date();
@@ -123,6 +129,7 @@ async function writeUtimes(accountId, filepath, node) {
         });
     }
 }
+exports.writeUtimes = writeUtimes;
 async function skipExisting(filepath, overwrite = false) {
     if (overwrite) {
         return false;
@@ -145,9 +152,9 @@ async function fetchAndWriteFileStream(accountId, srcPath, filepath, mode, optio
     if (!(0, path_2.isAllowedExtension)(srcPath)) {
         (0, standardErrors_1.throwErrorWithMessage)('filemapper.invalidFileType', { srcPath });
     }
+    let node;
     try {
-        const node = await (0, fileMapper_1.fetchFileStream)(accountId, srcPath, filepath, getFileMapperQueryValues(mode, options));
-        await writeUtimes(accountId, filepath, node);
+        node = await (0, fileMapper_1.fetchFileStream)(accountId, srcPath, filepath, getFileMapperQueryValues(mode, options));
     }
     catch (err) {
         (0, apiErrors_1.throwStatusCodeError)(err, {
@@ -155,6 +162,7 @@ async function fetchAndWriteFileStream(accountId, srcPath, filepath, mode, optio
             request: srcPath,
         });
     }
+    await writeUtimes(accountId, filepath, node);
 }
 // Writes an individual file or folder (not recursive).  If file source is missing, the
 //file is fetched.
@@ -263,6 +271,7 @@ async function fetchFolderFromApi(accountId, src, mode, options = {}, logCallbac
         }
     }
 }
+exports.fetchFolderFromApi = fetchFolderFromApi;
 async function downloadFolder(accountId, src, destPath, mode, options = {}, logCallbacks) {
     const logger = (0, logger_1.makeTypedLogger)(logCallbacks, 'filemapper');
     try {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/local-dev-lib",
-    "version": "0.0.6",
+    "version": "0.0.7",
     "description": "Provides library functionality for HubSpot local development tooling, including the HubSpot CLI",
     "main": "lib/index.js",
     "repository": {
@@ -12,14 +12,12 @@
         "access": "public"
     },
     "scripts": {
-        "build": "rm -rf ./dist/ && tsc --rootDir . --outdir dist && yarn copy-files",
+        "build": "rm -rf ./dist/ && tsc --rootDir . --outdir dist && yarn copy-files && yarn clear-postinstall",
         "check-main": "branch=$(git rev-parse --abbrev-ref HEAD) && [ $branch = main ] || (echo 'Error: New release can only be published on main branch' && exit 1)",
+        "clear-postinstall": "cd dist && npm pkg delete scripts.postinstall",
         "copy-files": "cp -r lang dist/lang",
         "lint": "eslint --max-warnings=0 . && prettier --check ./**/*.ts",
         "local-dev": "yarn build && cd dist && yarn link && cd .. && tsc --watch --rootDir . --outdir dist",
-        "postinstall": "husky install",
-        "prepack": "pinst --disable",
-        "postpack": "pinst --enable",
         "prettier:write": "prettier --write ./**/*.{ts,js,json}",
         "pub": "cd dist && npm publish --tag latest && cd ..",
         "push": "git push --atomic origin main v$npm_package_version",
@@ -44,7 +42,6 @@
         "eslint": "^8.35.0",
         "husky": "^8.0.0",
         "jest": "^29.5.0",
-        "pinst": "^3.0.0",
         "ts-jest": "^29.0.5",
         "typescript": "^4.9.5"
     },

package/types/Error.d.ts

@@ -1,4 +1,7 @@
 import { HttpMethod } from './Api';
+export interface GenericError extends Error {
+    [key: string]: any;
+}
 export interface BaseError extends Error {
     name: string;
     message: string;