@hubspot/local-dev-lib 1.3.0 → 1.5.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/api/projects.d.ts

@@ -5,6 +5,7 @@ import { Build, FetchProjectBuildsResponse } from '../types/Build';
 import { ComponentMetadataResponse, ComponentStructureResponse } from '../types/ComponentStructure';
 import { Deploy, ProjectDeployResponse } from '../types/Deploy';
 import { ProjectLog } from '../types/ProjectLog';
+import { MigrateAppResponse, PollAppResponse } from '../types/Migration';
 export declare function fetchProjects(accountId: number): Promise<FetchProjectResponse>;
 export declare function createProject(accountId: number, name: string): Promise<Project>;
 export declare function uploadProject(accountId: number, projectName: string, projectFile: string, uploadMessage: string, platformVersion?: string): Promise<UploadProjectResponse>;
@@ -35,4 +36,6 @@ export declare function fetchBuildWarnLogs(accountId: number, projectName: strin
 export declare function fetchDeployWarnLogs(accountId: number, projectName: string, deployId: number): Promise<{
     logs: Array<ProjectLog>;
 }>;
+export declare function migrateApp(accountId: number, appId: number, projectName: string): Promise<MigrateAppResponse>;
+export declare function checkMigrationStatus(accountId: number, id: number): Promise<PollAppResponse>;
 export {};

package/api/projects.js

@@ -3,13 +3,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetchDeployWarnLogs = exports.fetchBuildWarnLogs = exports.cancelStagedBuild = exports.deleteFileFromBuild = exports.uploadFileToBuild = exports.queueBuild = exports.provisionBuild = exports.fetchDeployComponentsMetadata = exports.fetchProjectSettings = exports.getDeployStructure = exports.getDeployStatus = exports.deployProject = exports.getBuildStructure = exports.getBuildStatus = exports.fetchProjectBuilds = exports.fetchPlatformVersions = exports.deleteProject = exports.downloadProject = exports.fetchProject = exports.uploadProject = exports.createProject = exports.fetchProjects = void 0;
+exports.checkMigrationStatus = exports.migrateApp = exports.fetchDeployWarnLogs = exports.fetchBuildWarnLogs = exports.cancelStagedBuild = exports.deleteFileFromBuild = exports.uploadFileToBuild = exports.queueBuild = exports.provisionBuild = exports.fetchDeployComponentsMetadata = exports.fetchProjectSettings = exports.getDeployStructure = exports.getDeployStatus = exports.deployProject = exports.getBuildStructure = exports.getBuildStatus = exports.fetchProjectBuilds = exports.fetchPlatformVersions = exports.deleteProject = exports.downloadProject = exports.fetchProject = exports.uploadProject = exports.createProject = exports.fetchProjects = void 0;
 const http_1 = __importDefault(require("../http"));
 const fs_1 = __importDefault(require("fs"));
 const PROJECTS_API_PATH = 'dfs/v1/projects';
 const PROJECTS_DEPLOY_API_PATH = 'dfs/deploy/v1';
 const PROJECTS_LOGS_API_PATH = 'dfs/logging/v1';
 const DEVELOPER_PROJECTS_API_PATH = 'developer/projects/v1';
+const MIGRATIONS_API_PATH = 'dfs/migrations/v1';
 async function fetchProjects(accountId) {
     return http_1.default.get(accountId, {
         url: PROJECTS_API_PATH,
@@ -172,3 +173,20 @@ async function fetchDeployWarnLogs(accountId, projectName, deployId) {
     });
 }
 exports.fetchDeployWarnLogs = fetchDeployWarnLogs;
+async function migrateApp(accountId, appId, projectName) {
+    return http_1.default.post(accountId, {
+        url: `${MIGRATIONS_API_PATH}/migrations`,
+        data: {
+            componentId: appId,
+            componentType: 'PUBLIC_APP_ID',
+            projectName,
+        },
+    });
+}
+exports.migrateApp = migrateApp;
+async function checkMigrationStatus(accountId, id) {
+    return http_1.default.get(accountId, {
+        url: `${MIGRATIONS_API_PATH}/migrations/${id}`,
+    });
+}
+exports.checkMigrationStatus = checkMigrationStatus;

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/lib/archive.d.ts

@@ -2,6 +2,7 @@
 type CopySourceToDestOptions = {
     sourceDir?: string;
     includesRootDir?: boolean;
+    hideLogs?: boolean;
 };
-export declare function extractZipArchive(zip: Buffer, name: string, dest: string, { sourceDir, includesRootDir }?: CopySourceToDestOptions): Promise<boolean>;
+export declare function extractZipArchive(zip: Buffer, name: string, dest: string, { sourceDir, includesRootDir, hideLogs }?: CopySourceToDestOptions): Promise<boolean>;
 export {};

package/lib/archive.js

@@ -13,10 +13,12 @@ const standardErrors_1 = require("../errors/standardErrors");
 const logger_1 = require("./logger");
 const lang_1 = require("../utils/lang");
 const i18nKey = 'lib.archive';
-async function extractZip(name, zip) {
+async function extractZip(name, zip, hideLogs = false) {
     const result = { extractDir: '', tmpDir: '' };
     const TMP_FOLDER_PREFIX = `hubspot-temp-${name}-`;
-    logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.extractZip.init`));
+    if (!hideLogs) {
+        logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.extractZip.init`));
+    }
     // Write zip to disk
     let tmpZipPath = '';
     try {
@@ -51,9 +53,11 @@ async function extractZip(name, zip) {
     logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.extractZip.success`));
     return result;
 }
-async function copySourceToDest(src, dest, { sourceDir, includesRootDir = true } = {}) {
+async function copySourceToDest(src, dest, { sourceDir, includesRootDir = true, hideLogs = false, } = {}) {
     try {
-        logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.copySourceToDest.init`));
+        if (!hideLogs) {
+            logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.copySourceToDest.init`));
+        }
         const srcDirPath = [src];
         if (includesRootDir) {
             const files = await fs_extra_1.default.readdir(src);
@@ -94,14 +98,15 @@ function cleanupTempDir(tmpDir) {
         logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.cleanupTempDir.error`, { tmpDir }));
     }
 }
-async function extractZipArchive(zip, name, dest, { sourceDir, includesRootDir } = {}) {
+async function extractZipArchive(zip, name, dest, { sourceDir, includesRootDir, hideLogs } = {}) {
     let success = false;
     if (zip) {
-        const { extractDir, tmpDir } = await extractZip(name, zip);
+        const { extractDir, tmpDir } = await extractZip(name, zip, hideLogs);
         if (extractDir !== null) {
             success = await copySourceToDest(extractDir, dest, {
                 sourceDir,
                 includesRootDir,
+                hideLogs,
             });
         }
         cleanupTempDir(tmpDir);

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/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/local-dev-lib",
-    "version": "1.3.0",
+    "version": "1.5.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/Migration.d.ts

@@ -0,0 +1,24 @@
+import { ValueOf } from './Utils';
+import { OptionalError } from './Error';
+export declare const MIGRATION_STATUS: {
+    readonly BUILDING: "BUILDING";
+    readonly FAILURE: "FAILURE";
+    readonly PREPARING: "PREPARING";
+    readonly PENDING: "PENDING";
+    readonly SUCCESS: "SUCCESS";
+};
+export type MigrateAppResponse = {
+    id: number;
+    status: ValueOf<typeof MIGRATION_STATUS>;
+};
+export type PollAppResponse = {
+    id: number;
+    project?: {
+        id: number;
+        name: string;
+        buildId: number;
+        deployId: number;
+    };
+    error: OptionalError;
+    status: ValueOf<typeof MIGRATION_STATUS>;
+};

package/types/Migration.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MIGRATION_STATUS = void 0;
+exports.MIGRATION_STATUS = {
+    BUILDING: 'BUILDING',
+    FAILURE: 'FAILURE',
+    PREPARING: 'PREPARING',
+    PENDING: 'PENDING',
+    SUCCESS: 'SUCCESS',
+};