@hubspot/local-dev-lib 1.4.0 → 1.6.0

package/api/appsDev.d.ts

@@ -1,2 +1,3 @@
-import { PublicApp } from '../types/Apps';
+import { PublicApp, PublicAppDeveloperTestAccountInstallData } from '../types/Apps';
 export declare function fetchPublicAppsForPortal(accountId: number): Promise<Array<PublicApp>>;
+export declare function fetchPublicAppDeveloperTestAccountInstallData(appId: number, accountId: number): Promise<PublicAppDeveloperTestAccountInstallData>;

package/api/appsDev.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.fetchPublicAppsForPortal = void 0;
+exports.fetchPublicAppDeveloperTestAccountInstallData = exports.fetchPublicAppsForPortal = void 0;
 const http_1 = __importDefault(require("../http"));
 const APPS_DEV_API_PATH = 'apps-dev/external/public/v3';
 async function fetchPublicAppsForPortal(accountId) {
@@ -13,3 +13,9 @@ async function fetchPublicAppsForPortal(accountId) {
     return resp ? resp.results : [];
 }
 exports.fetchPublicAppsForPortal = fetchPublicAppsForPortal;
+function fetchPublicAppDeveloperTestAccountInstallData(appId, accountId) {
+    return http_1.default.get(accountId, {
+        url: `${APPS_DEV_API_PATH}/${appId}/test-portal-installs`,
+    });
+}
+exports.fetchPublicAppDeveloperTestAccountInstallData = fetchPublicAppDeveloperTestAccountInstallData;

package/api/github.js

@@ -40,6 +40,7 @@ exports.fetchRepoFile = fetchRepoFile;
 async function fetchRepoFileByDownloadUrl(downloadUrl) {
     return axios_1.default.get(downloadUrl, {
         headers: { ...(0, getAxiosConfig_1.getDefaultUserAgentHeader)(), ...GITHUB_AUTH_HEADERS },
+        responseType: 'arraybuffer',
     });
 }
 exports.fetchRepoFileByDownloadUrl = fetchRepoFileByDownloadUrl;

package/http/getAxiosConfig.js

@@ -1,9 +1,28 @@
 "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.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 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,
 };
@@ -31,6 +50,8 @@ function getAxiosConfig(options) {
         },
         timeout: httpTimeout || 15000,
         transitional: DEFAULT_TRANSITIONAL,
+        httpAgent,
+        httpsAgent,
         ...rest,
     };
 }

package/lang/en.json

@@ -10,15 +10,15 @@
                 "init": "Extracting project source...",
                 "success": "Completed project source extraction.",
                 "errors": {
-                    "write": "An error occured writing temp project source.",
-                    "extract": "An error occured extracting project source."
+                    "write": "An error occurred writing temp project source.",
+                    "extract": "An error occurred extracting project source."
                 }
             },
             "copySourceToDest": {
                 "init": "Copying project source...",
                 "sourceEmpty": "Project source is empty",
                 "success": "Completed copying project source.",
-                "error": "An error occured copying project source to {{ dest }}."
+                "error": "An error occurred copying project source to {{ dest }}."
             },
             "cleanupTempDir": {
                 "error": "Failed to clean up temp dir: {{ tmpDir }}"
@@ -33,7 +33,7 @@
             "fetchFileFromRepository": {
                 "fetching": "Fetching {{ path }}...",
                 "errors": {
-                    "fetchFail": "An error occured fetching JSON file."
+                    "fetchFail": "An error occurred fetching JSON file."
                 }
             },
             "fetchReleaseData": {
@@ -130,7 +130,7 @@
                 },
                 "createTmpDirSync": {
                     "errors": {
-                        "writeFailed": "An error occured writing temporary project source."
+                        "writeFailed": "An error occurred writing temporary project source."
                     }
                 },
                 "cleanupTmpDirSync": {

package/lang/lang/en.json

@@ -10,15 +10,15 @@
         "init": "Extracting project source...",
         "success": "Completed project source extraction.",
         "errors": {
-          "write": "An error occured writing temp project source.",
-          "extract": "An error occured extracting project source."
+          "write": "An error occurred writing temp project source.",
+          "extract": "An error occurred extracting project source."
         }
       },
       "copySourceToDest": {
         "init": "Copying project source...",
         "sourceEmpty": "Project source is empty",
         "success": "Completed copying project source.",
-        "error": "An error occured copying project source to {{ dest }}."
+        "error": "An error occurred copying project source to {{ dest }}."
       },
       "cleanupTempDir": {
         "error": "Failed to clean up temp dir: {{ tmpDir }}"
@@ -33,7 +33,7 @@
       "fetchFileFromRepository": {
         "fetching": "Fetching {{ path }}...",
         "errors": {
-          "fetchFail": "An error occured fetching JSON file."
+          "fetchFail": "An error occurred fetching JSON file."
         }
       },
       "fetchReleaseData": {
@@ -130,7 +130,7 @@
         },
         "createTmpDirSync": {
           "errors": {
-            "writeFailed": "An error occured writing temporary project source."
+            "writeFailed": "An error occurred writing temporary project source."
           }
         },
         "cleanupTmpDirSync": {

package/lib/archive.js

@@ -65,7 +65,7 @@ async function copySourceToDest(src, dest, { sourceDir, includesRootDir = true,
             if (!rootDir) {
                 logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.copySourceToDest.sourceEmpty`));
                 // Create the dest path if it doesn't already exist
-                fs_extra_1.default.ensureDir(dest);
+                await fs_extra_1.default.ensureDir(dest);
                 // No root found so nothing to copy
                 return true;
             }
@@ -88,11 +88,11 @@ async function copySourceToDest(src, dest, { sourceDir, includesRootDir = true,
     }
     return false;
 }
-function cleanupTempDir(tmpDir) {
+async function cleanupTempDir(tmpDir) {
     if (!tmpDir)
         return;
     try {
-        fs_extra_1.default.remove(tmpDir);
+        await fs_extra_1.default.remove(tmpDir);
     }
     catch (e) {
         logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.cleanupTempDir.error`, { tmpDir }));
@@ -109,7 +109,7 @@ async function extractZipArchive(zip, name, dest, { sourceDir, includesRootDir,
                 hideLogs,
             });
         }
-        cleanupTempDir(tmpDir);
+        await cleanupTempDir(tmpDir);
     }
     return success;
 }

package/lib/cms/uploadFolder.js

@@ -103,7 +103,7 @@ const defaultUploadFinalErrorCallback = (accountId, file, destPath, error) => {
     });
 };
 async function uploadFolder(accountId, src, dest, fileMapperOptions, commandOptions = {}, filePaths = [], mode = null) {
-    const { saveOutput, convertFields, onAttemptCallback, onSuccessCallback, onFirstErrorCallback, onRetryCallback, onFinalErrorCallback } = commandOptions;
+    const { saveOutput, convertFields, onAttemptCallback, onSuccessCallback, onFirstErrorCallback, onRetryCallback, onFinalErrorCallback, } = commandOptions;
     const _onAttemptCallback = onAttemptCallback || defaultUploadAttemptCallback;
     const _onSuccessCallback = onSuccessCallback || defaultUploadSuccessCallback;
     const _onFirstErrorCallback = onFirstErrorCallback || defaultUploadFirstErrorCallback;

package/lib/github.d.ts

@@ -11,6 +11,7 @@ type CloneGithubRepoOptions = {
     sourceDir?: string;
 };
 export declare function cloneGithubRepo(repoPath: RepoPath, dest: string, options?: CloneGithubRepoOptions): Promise<boolean>;
+export declare function fetchGitHubRepoContentFromDownloadUrl(dest: string, downloadUrl: string): Promise<void>;
 export declare function downloadGithubRepoContents(repoPath: RepoPath, contentPath: string, dest: string, ref?: string, filter?: (contentPiecePath: string, downloadPath: string) => boolean): Promise<void>;
 export declare function listGithubRepoContents(repoPath: RepoPath, contentPath: string, fileFilter?: 'file' | 'dir'): Promise<GithubRepoFile[]>;
 export {};

package/lib/github.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.listGithubRepoContents = exports.downloadGithubRepoContents = exports.cloneGithubRepo = exports.fetchReleaseData = exports.fetchFileFromRepository = void 0;
+exports.listGithubRepoContents = exports.downloadGithubRepoContents = exports.fetchGitHubRepoContentFromDownloadUrl = exports.cloneGithubRepo = exports.fetchReleaseData = exports.fetchFileFromRepository = void 0;
 const path_1 = __importDefault(require("path"));
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const standardErrors_1 = require("../errors/standardErrors");
@@ -88,11 +88,17 @@ async function cloneGithubRepo(repoPath, dest, options = {}) {
 exports.cloneGithubRepo = cloneGithubRepo;
 async function fetchGitHubRepoContentFromDownloadUrl(dest, downloadUrl) {
     const resp = await (0, github_1.fetchRepoFileByDownloadUrl)(downloadUrl);
-    const fileContents = typeof resp.data === 'string'
-        ? resp.data
-        : JSON.stringify(resp.data, null, 2);
-    fs_extra_1.default.outputFileSync(dest, fileContents, 'utf8');
+    const contentType = resp.headers['content-type'];
+    let fileContents;
+    if (contentType.startsWith('text')) {
+        fileContents = Buffer.from(resp.data).toString('utf8');
+    }
+    else {
+        fileContents = resp.data;
+    }
+    await fs_extra_1.default.outputFileSync(dest, fileContents);
 }
+exports.fetchGitHubRepoContentFromDownloadUrl = fetchGitHubRepoContentFromDownloadUrl;
 // Writes files from a public repository to the destination folder
 async function downloadGithubRepoContents(repoPath, contentPath, dest, ref, filter) {
     fs_extra_1.default.ensureDirSync(path_1.default.dirname(dest));

package/lib/path.d.ts

@@ -9,3 +9,5 @@ export declare function getExt(filepath: string): string;
 export declare function getAllowedExtensions(allowList?: Array<string>): Set<string>;
 export declare function isAllowedExtension(filepath: string, allowList?: Array<string>): boolean;
 export declare function getAbsoluteFilePath(_path: string): string;
+export declare function sanitizeFileName(fileName: string): string;
+export declare function isValidPath(_path: string): boolean;

package/lib/path.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.getAbsoluteFilePath = exports.isAllowedExtension = exports.getAllowedExtensions = exports.getExt = exports.getCwd = exports.splitHubSpotPath = exports.splitLocalPath = exports.convertToLocalFileSystemPath = exports.convertToUnixPath = void 0;
+exports.isValidPath = exports.sanitizeFileName = exports.getAbsoluteFilePath = exports.isAllowedExtension = exports.getAllowedExtensions = exports.getExt = exports.getCwd = exports.splitHubSpotPath = exports.splitLocalPath = exports.convertToLocalFileSystemPath = exports.convertToUnixPath = void 0;
 const path_1 = __importDefault(require("path"));
 const unixify_1 = __importDefault(require("unixify"));
 const extensions_1 = require("../constants/extensions");
@@ -87,3 +87,36 @@ function getAbsoluteFilePath(_path) {
     return path_1.default.resolve(getCwd(), _path);
 }
 exports.getAbsoluteFilePath = getAbsoluteFilePath;
+// Reserved names (Windows specific)
+const reservedNames = /^(CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$/i;
+// Based on the node-sanitize-filename package: https://github.com/parshap/node-sanitize-filename/blob/master/index.js
+function sanitizeFileName(fileName) {
+    // Windows invalid/control characters
+    // eslint-disable-next-line no-control-regex
+    const invalidChars = /[<>:"/|?*\x00-\x1F]/g;
+    //Replace invalid characters with dash
+    let sanitizedFileName = fileName.replace(invalidChars, '-');
+    // Removes trailing periods and spaces for Windows
+    sanitizedFileName = sanitizedFileName.replace(/[. ]+$/, '');
+    //Reserved names check for Windows
+    if (reservedNames.test(sanitizedFileName)) {
+        sanitizedFileName = `-${sanitizedFileName}`;
+    }
+    return sanitizedFileName;
+}
+exports.sanitizeFileName = sanitizeFileName;
+// Based on the node-sanitize-filename package: https://github.com/parshap/node-sanitize-filename/blob/master/index.js
+function isValidPath(_path) {
+    // Invalid characters excluding forward slash
+    // eslint-disable-next-line no-control-regex
+    const invalidChars = /[<>:"|?*\x00-\x1F]/;
+    const baseName = path_1.default.basename(_path);
+    if (invalidChars.test(baseName)) {
+        return false;
+    }
+    if (reservedNames.test(baseName)) {
+        return false;
+    }
+    return true;
+}
+exports.isValidPath = isValidPath;

package/lib/sandboxes.js

@@ -51,8 +51,7 @@ async function initiateSync(fromHubId, toHubId, tasks, sandboxHubId) {
 exports.initiateSync = initiateSync;
 async function fetchTaskStatus(accountId, taskId) {
     try {
-        const result = await (0, sandboxSync_1.fetchTaskStatus)(accountId, taskId);
-        return result;
+        return await (0, sandboxSync_1.fetchTaskStatus)(accountId, taskId);
     }
     catch (err) {
         (0, apiErrors_1.throwApiError)(err);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/local-dev-lib",
-    "version": "1.4.0",
+    "version": "1.6.0",
     "description": "Provides library functionality for HubSpot local development tooling, including the HubSpot CLI",
     "main": "lib/index.js",
     "repository": {
@@ -16,15 +16,15 @@
         "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",
+        "lint": "eslint --max-warnings=0 . && prettier . --check",
         "local-dev": "yarn build && cd dist && yarn link && cd .. && tsc --watch --rootDir . --outdir dist",
-        "prettier:write": "prettier --write ./**/*.{ts,js,json}",
+        "prettier:write": "prettier . --write",
         "pub": "cd dist && npm publish --tag latest && cd ..",
         "push": "git push --atomic origin main v$npm_package_version",
         "release:major": "yarn check-main && yarn version --major && yarn build && yarn pub && yarn push",
         "release:minor": "yarn check-main && yarn version --minor && yarn build && yarn pub && yarn push",
         "release:patch": "yarn check-main && yarn version --patch && yarn build && yarn pub && yarn push",
-        "test": "node --experimental-vm-modules ./node_modules/.bin/jest"
+        "test": "NODE_NO_WARNINGS=1 node --experimental-vm-modules ./node_modules/.bin/jest"
     },
     "license": "Apache-2.0",
     "devDependencies": {
@@ -37,7 +37,6 @@
         "@types/jest": "^29.5.0",
         "@types/js-yaml": "^4.0.5",
         "@types/node": "^18.14.2",
-        "@types/prettier": "^3.0.0",
         "@types/unixify": "^1.0.0",
         "@typescript-eslint/eslint-plugin": "^5.54.0",
         "@typescript-eslint/parser": "^5.59.7",
@@ -72,7 +71,7 @@
         "js-yaml": "^4.1.0",
         "moment": "^2.29.4",
         "p-queue": "^6.0.2",
-        "prettier": "^3.0.3",
+        "prettier": "^3.3.0",
         "semver": "^6.3.0",
         "unixify": "^1.0.0"
     },

package/types/Apps.d.ts

@@ -6,6 +6,13 @@ export type PublicAppInstallationData = {
         name: string;
     }>;
 };
+export type PublicAppDeveloperTestAccountInstallData = {
+    testPortalInstalls: Array<{
+        portalId: number;
+        accountName: string;
+    }>;
+    testPortalInstallCount: string;
+};
 export type PublicApp = {
     id: number;
     name: string;

package/types/FileManager.d.ts

@@ -13,7 +13,6 @@ export type File = {
     friendly_url: string;
     meta: {
         allows_anonymous_access: boolean;
-        charset_guess: string;
         line_count: number;
         indexable: boolean;
     };