@hubspot/local-dev-lib 5.2.1-beta.0 → 5.2.1-beta.1

package/api/projects.d.ts

@@ -2,7 +2,7 @@ import { HubSpotPromise, QueryParams } from '../types/Http.js';
 import { Project, FetchProjectResponse, UploadProjectResponse, ProjectSettings, FetchPlatformVersionResponse, WarnLogsResponse, UploadIRResponse } from '../types/Project.js';
 import { Build, FetchProjectBuildsResponse } from '../types/Build.js';
 import { ComponentStructureResponse, ProjectComponentsMetadata } from '../types/ComponentStructure.js';
-import { Deploy, ProjectDeployResponse, ProjectDeployResponseV1 } from '../types/Deploy.js';
+import { Deploy, ProjectDeployResponse, ProjectDeployResponseV1, ProjectDeletionResponse } from '../types/Deploy.js';
 import { MigrateAppResponse, CloneAppResponse, PollAppResponse } from '../types/Migration.js';
 export declare function fetchProjects(accountId: number): HubSpotPromise<FetchProjectResponse>;
 export declare function createProject(accountId: number, name: string): HubSpotPromise<Project>;
@@ -11,6 +11,14 @@ export declare function fetchProject(accountId: number, projectName: string): Hu
 export declare function fetchProjectComponentsMetadata(accountId: number, projectId: number): HubSpotPromise<ProjectComponentsMetadata>;
 export declare function downloadProject(accountId: number, projectName: string, buildId: number): HubSpotPromise<Buffer>;
 export declare function deleteProject(accountId: number, projectName: string): HubSpotPromise<void>;
+/**
+ * Stages the project for deletion.  Returns a deployId that can be polled using getDeployStatus.
+ * This needs to be called first before `deleteProject` for unified projects
+ * @param accountId
+ * @param projectName - The name of the project to delete
+ * @param dryRun - Should this be a dry run of the deletion.  If set to true, returns a list of the components that will be removed `componentsToRemove`
+ */
+export declare function stageProjectForDeletion(accountId: number, projectName: string, dryRun: boolean): HubSpotPromise<ProjectDeletionResponse>;
 export declare function fetchPlatformVersions(accountId: number): HubSpotPromise<FetchPlatformVersionResponse>;
 export declare function fetchProjectBuilds(accountId: number, projectName: string, params?: QueryParams): HubSpotPromise<FetchProjectBuildsResponse>;
 export declare function getBuildStatus(accountId: number, projectName: string, buildId: number): HubSpotPromise<Build>;

package/api/projects.js

@@ -78,6 +78,19 @@ export function deleteProject(accountId, projectName) {
         url: `${DEVELOPER_PROJECTS_API_PATH}/${encodeURIComponent(projectName)}`,
     });
 }
+/**
+ * Stages the project for deletion.  Returns a deployId that can be polled using getDeployStatus.
+ * This needs to be called first before `deleteProject` for unified projects
+ * @param accountId
+ * @param projectName - The name of the project to delete
+ * @param dryRun - Should this be a dry run of the deletion.  If set to true, returns a list of the components that will be removed `componentsToRemove`
+ */
+export function stageProjectForDeletion(accountId, projectName, dryRun) {
+    return http.post(accountId, {
+        url: `${PROJECTS_DEPLOY_API_PATH_V3}/deploys/delete`,
+        data: { projectName, dryRun },
+    });
+}
 export function fetchPlatformVersions(accountId) {
     return http.get(accountId, {
         url: `${DEVELOPER_PROJECTS_API_PATH}/platformVersion`,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/local-dev-lib",
-    "version": "5.2.1-beta.0",
+    "version": "5.2.1-beta.1",
     "type": "module",
     "description": "Provides library functionality for HubSpot local development tooling, including the HubSpot CLI",
     "files": [

package/types/Deploy.d.ts

@@ -55,3 +55,12 @@ export type ProjectDeployResponseV1 = {
     id: string;
     links: DeployResponseLinks;
 };
+export type DeployedComponentInfo = {
+    componentType: string;
+    componentId: string;
+};
+export type ProjectDeletionResponse = {
+    deployId?: number;
+    componentsToRemove: DeployedComponentInfo[];
+    hasDeployedComponents: boolean;
+};