@hubspot/local-dev-lib 3.4.1 → 3.5.0-beta.0

package/api/fireAlarm.d.ts

@@ -0,0 +1,3 @@
+import { FireAlarm } from '../types/FireAlarm';
+import { HubSpotPromise } from '../types/Http';
+export declare function fetchFireAlarms(accountId: number): HubSpotPromise<Array<FireAlarm>>;

package/api/fireAlarm.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchFireAlarms = void 0;
+const http_1 = require("../http");
+const FIREALARM_API_AUTH_PATH = 'firealarm/v4/alarm';
+function fetchFireAlarms(accountId) {
+    return http_1.http.get(accountId, {
+        url: `${FIREALARM_API_AUTH_PATH}/hubspot-cli/${accountId}`,
+    });
+}
+exports.fetchFireAlarms = fetchFireAlarms;

package/api/github.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { GithubReleaseData, GithubRepoFile, RepoPath } from '../types/Github';
 import { HubSpotPromise } from '../types/Http';
 declare global {

package/api/projects.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { HubSpotPromise, QueryParams } from '../types/Http';
-import { Project, FetchProjectResponse, UploadProjectResponse, ProjectSettings, FetchPlatformVersionResponse, WarnLogsResponse, UploadIRResponse } from '../types/Project';
+import { Project, FetchProjectResponse, UploadProjectResponse, ProjectSettings, FetchPlatformVersionResponse, WarnLogsResponse, UploadIRResponse, ListAppsResponse, BeginMigrationResponse, FinishMigrationResponse } from '../types/Project';
 import { Build, FetchProjectBuildsResponse } from '../types/Build';
 import { ComponentStructureResponse, ProjectComponentsMetadata } from '../types/ComponentStructure';
 import { Deploy, ProjectDeployResponse } from '../types/Deploy';
@@ -27,8 +28,11 @@ export declare function deleteFileFromBuild(accountId: number, projectName: stri
 export declare function cancelStagedBuild(accountId: number, projectName: string): HubSpotPromise<void>;
 export declare function fetchBuildWarnLogs(accountId: number, projectName: string, buildId: number): HubSpotPromise<WarnLogsResponse>;
 export declare function fetchDeployWarnLogs(accountId: number, projectName: string, deployId: number): HubSpotPromise<WarnLogsResponse>;
+export declare function listAppsForMigration(accountId: number): HubSpotPromise<ListAppsResponse>;
+export declare function beginMigration(accountId: number, applicationId: number): HubSpotPromise<BeginMigrationResponse>;
+export declare function finishMigration(portalId: number, migrationId: number, componentUids: Record<string, string>, projectName: string, targetPlatformVersion: string): HubSpotPromise<FinishMigrationResponse>;
 export declare function migrateApp(accountId: number, appId: number, projectName: string): HubSpotPromise<MigrateAppResponse>;
-export declare function checkMigrationStatus(accountId: number, id: number): HubSpotPromise<PollAppResponse>;
+export declare function checkMigrationStatus(accountId: number, id: number, targetPlatformVersion?: string): HubSpotPromise<PollAppResponse>;
 export declare function cloneApp(accountId: number, appId: number): HubSpotPromise<CloneAppResponse>;
 export declare function checkCloneStatus(accountId: number, exportId: number): HubSpotPromise<CloneAppResponse>;
 export declare function downloadClonedProject(accountId: number, exportId: number): HubSpotPromise<Buffer>;

package/api/projects.js

@@ -3,16 +3,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.downloadClonedProject = exports.checkCloneStatus = exports.cloneApp = exports.checkMigrationStatus = exports.migrateApp = exports.fetchDeployWarnLogs = exports.fetchBuildWarnLogs = exports.cancelStagedBuild = exports.deleteFileFromBuild = exports.uploadFileToBuild = exports.queueBuild = exports.provisionBuild = exports.fetchProjectSettings = exports.getDeployStructure = exports.getDeployStatus = exports.deployProject = exports.getBuildStructure = exports.getBuildStatus = exports.fetchProjectBuilds = exports.fetchPlatformVersions = exports.deleteProject = exports.downloadProject = exports.fetchProjectComponentsMetadata = exports.fetchProject = exports.uploadProject = exports.createProject = exports.fetchProjects = void 0;
+exports.downloadClonedProject = exports.checkCloneStatus = exports.cloneApp = exports.checkMigrationStatus = exports.migrateApp = exports.finishMigration = exports.beginMigration = exports.listAppsForMigration = exports.fetchDeployWarnLogs = exports.fetchBuildWarnLogs = exports.cancelStagedBuild = exports.deleteFileFromBuild = exports.uploadFileToBuild = exports.queueBuild = exports.provisionBuild = exports.fetchProjectSettings = exports.getDeployStructure = exports.getDeployStatus = exports.deployProject = exports.getBuildStructure = exports.getBuildStatus = exports.fetchProjectBuilds = exports.fetchPlatformVersions = exports.deleteProject = exports.downloadProject = exports.fetchProjectComponentsMetadata = exports.fetchProject = exports.uploadProject = exports.createProject = exports.fetchProjects = void 0;
 const http_1 = require("../http");
 const fs_1 = __importDefault(require("fs"));
+const projects_1 = require("../constants/projects");
 const PROJECTS_API_PATH = 'dfs/v1/projects';
 const DEVELOPER_FILE_SYSTEM_PATH = 'dfs/v1';
 const PROJECTS_DEPLOY_API_PATH = 'dfs/deploy/v1';
 const PROJECTS_DEPLOY_API_PATH_V3 = 'dfs/deploy/v3';
 const PROJECTS_LOGS_API_PATH = 'dfs/logging/v1';
 const DEVELOPER_PROJECTS_API_PATH = 'developer/projects/v1';
-const MIGRATIONS_API_PATH = 'dfs/migrations/v1';
+const MIGRATIONS_API_PATH_V1 = 'dfs/migrations/v1';
+const MIGRATIONS_API_PATH_V2 = 'dfs/migrations/v2';
 const PROJECTS_V3_API_PATH = 'project-components-external/v3';
 function fetchProjects(accountId) {
     return http_1.http.get(accountId, {
@@ -205,9 +207,38 @@ function fetchDeployWarnLogs(accountId, projectName, deployId) {
     });
 }
 exports.fetchDeployWarnLogs = fetchDeployWarnLogs;
+async function listAppsForMigration(accountId) {
+    return http_1.http.get(accountId, {
+        url: `${MIGRATIONS_API_PATH_V2}/list-apps`,
+    });
+}
+exports.listAppsForMigration = listAppsForMigration;
+async function beginMigration(accountId, applicationId) {
+    return http_1.http.post(accountId, {
+        url: `${MIGRATIONS_API_PATH_V2}/migrations`,
+        data: {
+            applicationId,
+        },
+    });
+}
+exports.beginMigration = beginMigration;
+async function finishMigration(portalId, migrationId, componentUids, projectName, targetPlatformVersion) {
+    const pathPlatformVersion = targetPlatformVersion === projects_1.PLATFORM_VERSIONS.unstable
+        ? targetPlatformVersion
+        : `v${targetPlatformVersion.replace('.', '')}`;
+    return http_1.http.post(portalId, {
+        url: `${MIGRATIONS_API_PATH_V2}/migrations/migrate/${pathPlatformVersion}`,
+        data: {
+            migrationId,
+            projectName,
+            componentUids,
+        },
+    });
+}
+exports.finishMigration = finishMigration;
 function migrateApp(accountId, appId, projectName) {
     return http_1.http.post(accountId, {
-        url: `${MIGRATIONS_API_PATH}/migrations`,
+        url: `${MIGRATIONS_API_PATH_V1}/migrations`,
         data: {
             componentId: appId,
             componentType: 'PUBLIC_APP_ID',
@@ -216,15 +247,21 @@ function migrateApp(accountId, appId, projectName) {
     });
 }
 exports.migrateApp = migrateApp;
-function checkMigrationStatus(accountId, id) {
+function checkMigrationStatus(accountId, id, targetPlatformVersion = projects_1.PLATFORM_VERSIONS.v2023_2) {
+    if (targetPlatformVersion === projects_1.PLATFORM_VERSIONS.unstable ||
+        targetPlatformVersion === projects_1.PLATFORM_VERSIONS.v2025_2) {
+        return http_1.http.get(accountId, {
+            url: `${MIGRATIONS_API_PATH_V2}/migrations/${id}/status`,
+        });
+    }
     return http_1.http.get(accountId, {
-        url: `${MIGRATIONS_API_PATH}/migrations/${id}`,
+        url: `${MIGRATIONS_API_PATH_V1}/migrations/${id}`,
     });
 }
 exports.checkMigrationStatus = checkMigrationStatus;
 function cloneApp(accountId, appId) {
     return http_1.http.post(accountId, {
-        url: `${MIGRATIONS_API_PATH}/exports`,
+        url: `${MIGRATIONS_API_PATH_V1}/exports`,
         data: {
             componentId: appId,
             componentType: 'PUBLIC_APP_ID',
@@ -234,13 +271,13 @@ function cloneApp(accountId, appId) {
 exports.cloneApp = cloneApp;
 function checkCloneStatus(accountId, exportId) {
     return http_1.http.get(accountId, {
-        url: `${MIGRATIONS_API_PATH}/exports/${exportId}/status`,
+        url: `${MIGRATIONS_API_PATH_V1}/exports/${exportId}/status`,
     });
 }
 exports.checkCloneStatus = checkCloneStatus;
 function downloadClonedProject(accountId, exportId) {
     return http_1.http.get(accountId, {
-        url: `${MIGRATIONS_API_PATH}/exports/${exportId}/download-as-clone`,
+        url: `${MIGRATIONS_API_PATH_V1}/exports/${exportId}/download-as-clone`,
         responseType: 'arraybuffer',
     });
 }

package/constants/projects.d.ts

@@ -0,0 +1,11 @@
+export declare const UNMIGRATABLE_REASONS: {
+    UP_TO_DATE: string;
+    IS_A_PRIVATE_APP: string;
+    LISTED_IN_MARKETPLACE: string;
+};
+export declare const PLATFORM_VERSIONS: {
+    v2023_2: string;
+    v2025_1: string;
+    v2025_2: string;
+    unstable: string;
+};

package/constants/projects.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PLATFORM_VERSIONS = exports.UNMIGRATABLE_REASONS = void 0;
+exports.UNMIGRATABLE_REASONS = {
+    UP_TO_DATE: 'UP_TO_DATE',
+    IS_A_PRIVATE_APP: 'IS_A_PRIVATE_APP',
+    LISTED_IN_MARKETPLACE: 'LISTED_IN_MARKETPLACE',
+};
+exports.PLATFORM_VERSIONS = {
+    v2023_2: '2023.2',
+    v2025_1: '2025.1',
+    v2025_2: '2025.2',
+    unstable: 'unstable',
+};

package/lib/archive.d.ts

@@ -1,3 +1,4 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { CopySourceToDestOptions } from '../types/Archive';
 export declare function extractZipArchive(zip: Buffer, name: string, dest: string, { sourceDir, includesRootDir, hideLogs }?: CopySourceToDestOptions): Promise<boolean>;

package/lib/github.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { GithubReleaseData, GithubRepoFile, RepoPath, CloneGithubRepoOptions } from '../types/Github';
 /**
  * @deprecated Use `fetchRepoFile` instead - this util is a thin wrapper around it

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/local-dev-lib",
-    "version": "3.4.1",
+    "version": "3.5.0-beta.0",
     "description": "Provides library functionality for HubSpot local development tooling, including the HubSpot CLI",
     "repository": {
         "type": "git",

package/types/FireAlarm.d.ts

@@ -0,0 +1,8 @@
+export type FireAlarm = {
+    id: number;
+    title: string;
+    message: string;
+    querySelector: string | null;
+    severity: string;
+    createdAt: number;
+};

package/types/FireAlarm.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/types/Http.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 /// <reference types="node" />
 /// <reference types="node" />
+/// <reference types="node" />
 import { AxiosPromise, ResponseType } from 'axios';
 import { ReadStream } from 'fs';
 import { Stream } from 'stream';

package/types/Project.d.ts

@@ -1,6 +1,7 @@
 import { Build } from './Build';
 import { GithubSourceData } from './Github';
 import { ProjectLog } from './ProjectLog';
+import { UNMIGRATABLE_REASONS } from '../constants/projects';
 export type Project = {
     createdAt: number;
     deletedAt: number;
@@ -66,3 +67,38 @@ export type ProjectStandardError = {
 export type WarnLogsResponse = {
     logs: Array<ProjectLog>;
 };
+interface BaseMigrationApp {
+    appId: number;
+    appName: string;
+    isMigratable: boolean;
+    migrationComponents: ListAppsMigrationComponent[];
+}
+export interface MigratableApp extends BaseMigrationApp {
+    isMigratable: true;
+}
+export interface UnmigratableApp extends BaseMigrationApp {
+    isMigratable: false;
+    unmigratableReason: keyof typeof UNMIGRATABLE_REASONS;
+}
+export type MigrationApp = MigratableApp | UnmigratableApp;
+export interface ListAppsResponse {
+    migratableApps: MigratableApp[];
+    unmigratableApps: UnmigratableApp[];
+}
+export interface BeginMigrationResponse {
+    migrationId: number;
+    componentsRequiringUids: Record<string, {
+        componentType: string;
+        componentHint: string | null;
+    }>;
+}
+export interface ListAppsMigrationComponent {
+    id: string;
+    componentType: string;
+    isSupported: boolean;
+}
+export type FinishMigrationResponse = {
+    projectName: string;
+    buildId: number;
+};
+export {};