@hubspot/local-dev-lib 1.2.0 → 1.4.0

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

@@ -13,5 +13,5 @@ type WatchOptions = {
     filePaths?: Array<string>;
 };
 type ErrorHandler = (error: AxiosError) => void;
-export declare function watch(accountId: number, src: string, dest: string, { mode, remove, disableInitial, notify, commandOptions, filePaths, }: WatchOptions, postInitialUploadCallback?: ((result: Array<UploadFolderResults>) => void) | null, onUploadFolderError?: ErrorHandler, onQueueAddError?: ErrorHandler): chokidar.FSWatcher;
+export declare function watch(accountId: number, src: string, dest: string, { mode, remove, disableInitial, notify, commandOptions, filePaths, }: WatchOptions, postInitialUploadCallback?: ((result: Array<UploadFolderResults>) => void) | null, onUploadFolderError?: ErrorHandler, onQueueAddError?: ErrorHandler, onUploadFileError?: (file: string, dest: string, accountId: number) => ErrorHandler): chokidar.FSWatcher;
 export {};

package/lib/cms/watch.js

@@ -35,7 +35,18 @@ function _notifyOfThemePreview(filePath, accountId) {
     }));
 }
 const notifyOfThemePreview = (0, debounce_1.default)(_notifyOfThemePreview, 1000);
-async function uploadFile(accountId, file, dest, options, mode = null) {
+const defaultOnUploadFileError = (file, dest, accountId) => (error) => {
+    logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.uploadFailed`, {
+        file,
+        dest,
+    }));
+    (0, apiErrors_1.throwApiUploadError)(error, {
+        accountId,
+        request: dest,
+        payload: file,
+    });
+};
+async function uploadFile(accountId, file, dest, options, mode = null, onUploadFileError = defaultOnUploadFileError) {
     const src = options.src;
     const absoluteSrcPath = path_1.default.resolve((0, path_2.getCwd)(), file);
     const themeJsonPath = (0, themes_1.getThemeJSONPath)(absoluteSrcPath);
@@ -71,17 +82,7 @@ async function uploadFile(accountId, file, dest, options, mode = null) {
             .catch(() => {
             logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.uploadFailed`, { file, dest }));
             logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.uploadRetry`, { file, dest }));
-            return (0, fileMapper_2.upload)(accountId, file, dest, apiOptions).catch((error) => {
-                logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.uploadFailed`, {
-                    file,
-                    dest,
-                }));
-                (0, apiErrors_1.throwApiUploadError)(error, {
-                    accountId,
-                    request: dest,
-                    payload: file,
-                });
-            });
+            return (0, fileMapper_2.upload)(accountId, file, dest, apiOptions).catch(onUploadFileError(file, dest, accountId));
         });
     });
 }
@@ -108,7 +109,7 @@ async function deleteRemoteFile(accountId, filePath, remoteFilePath) {
         });
     });
 }
-function watch(accountId, src, dest, { mode, remove, disableInitial, notify, commandOptions, filePaths, }, postInitialUploadCallback = null, onUploadFolderError, onQueueAddError) {
+function watch(accountId, src, dest, { mode, remove, disableInitial, notify, commandOptions, filePaths, }, postInitialUploadCallback = null, onUploadFolderError, onQueueAddError, onUploadFileError) {
     const regex = new RegExp(`^${(0, escapeRegExp_1.escapeRegExp)(src)}`);
     if (notify) {
         (0, ignoreRules_1.ignoreFile)(notify);
@@ -145,7 +146,7 @@ function watch(accountId, src, dest, { mode, remove, disableInitial, notify, com
         const uploadPromise = uploadFile(accountId, filePath, destPath, {
             src,
             commandOptions,
-        }, mode);
+        }, mode, onUploadFileError);
         (0, notify_1.triggerNotify)(notify, 'Added', filePath, uploadPromise);
     });
     if (remove) {
@@ -185,7 +186,7 @@ function watch(accountId, src, dest, { mode, remove, disableInitial, notify, com
         const uploadPromise = uploadFile(accountId, filePath, destPath, {
             src,
             commandOptions,
-        }, mode);
+        }, mode, onUploadFileError);
         (0, notify_1.triggerNotify)(notify, 'Changed', filePath, uploadPromise);
     });
     return watcher;

package/package.json

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

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',
+};