@hubspot/local-dev-lib 1.10.0 → 1.12.0

package/api/projects.d.ts

@@ -2,7 +2,7 @@
 import { QueryParams } from '../types/Http';
 import { Project, FetchProjectResponse, UploadProjectResponse, ProjectSettings, FetchPlatformVersionResponse } from '../types/Project';
 import { Build, FetchProjectBuildsResponse } from '../types/Build';
-import { ComponentMetadataResponse, ComponentStructureResponse } from '../types/ComponentStructure';
+import { ComponentStructureResponse, ProjectComponentsMetadata } from '../types/ComponentStructure';
 import { Deploy, ProjectDeployResponse } from '../types/Deploy';
 import { ProjectLog } from '../types/ProjectLog';
 import { MigrateAppResponse, CloneAppResponse, PollAppResponse } from '../types/Migration';
@@ -10,6 +10,7 @@ export declare function fetchProjects(accountId: number): Promise<FetchProjectRe
 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>;
 export declare function fetchProject(accountId: number, projectName: string): Promise<Project>;
+export declare function fetchProjectComponentsMetadata(accountId: number, projectId: number): Promise<ProjectComponentsMetadata>;
 export declare function downloadProject(accountId: number, projectName: string, buildId: number): Promise<Buffer>;
 export declare function deleteProject(accountId: number, projectName: string): Promise<void>;
 export declare function fetchPlatformVersions(accountId: number): Promise<FetchPlatformVersionResponse>;
@@ -20,7 +21,6 @@ export declare function deployProject(accountId: number, projectName: string, bu
 export declare function getDeployStatus(accountId: number, projectName: string, deployId: number): Promise<Deploy>;
 export declare function getDeployStructure(accountId: number, projectName: string, deployId: number): Promise<ComponentStructureResponse>;
 export declare function fetchProjectSettings(accountId: number, projectName: string): Promise<ProjectSettings>;
-export declare function fetchDeployComponentsMetadata(accountId: number, projectId: number): Promise<ComponentMetadataResponse>;
 export declare function provisionBuild(accountId: number, projectName: string, platformVersion?: string): Promise<Build>;
 export declare function queueBuild(accountId: number, projectName: string, platformVersion?: string): Promise<void>;
 export declare function uploadFileToBuild(accountId: number, projectName: string, filePath: string, path: string): Promise<void>;

package/api/projects.js

@@ -3,10 +3,11 @@ 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.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.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;
 const http_1 = __importDefault(require("../http"));
 const fs_1 = __importDefault(require("fs"));
 const PROJECTS_API_PATH = 'dfs/v1/projects';
+const DEVELOPER_FILE_SYSTEM_PATH = 'dfs/v1';
 const PROJECTS_DEPLOY_API_PATH = 'dfs/deploy/v1';
 const PROJECTS_LOGS_API_PATH = 'dfs/logging/v1';
 const DEVELOPER_PROJECTS_API_PATH = 'developer/projects/v1';
@@ -36,7 +37,7 @@ async function uploadProject(accountId, projectName, projectFile, uploadMessage,
     }
     return http_1.default.post(accountId, {
         url: `${PROJECTS_API_PATH}/upload/${encodeURIComponent(projectName)}`,
-        timeout: 60000,
+        timeout: 60_000,
         data: formData,
         headers: { 'Content-Type': 'multipart/form-data' },
     });
@@ -48,6 +49,12 @@ async function fetchProject(accountId, projectName) {
     });
 }
 exports.fetchProject = fetchProject;
+async function fetchProjectComponentsMetadata(accountId, projectId) {
+    return http_1.default.get(accountId, {
+        url: `${DEVELOPER_FILE_SYSTEM_PATH}/projects-deployed-build/${projectId}`,
+    });
+}
+exports.fetchProjectComponentsMetadata = fetchProjectComponentsMetadata;
 async function downloadProject(accountId, projectName, buildId) {
     return http_1.default.get(accountId, {
         url: `${PROJECTS_API_PATH}/${encodeURIComponent(projectName)}/builds/${buildId}/archive-full`,
@@ -115,18 +122,12 @@ async function fetchProjectSettings(accountId, projectName) {
     });
 }
 exports.fetchProjectSettings = fetchProjectSettings;
-async function fetchDeployComponentsMetadata(accountId, projectId) {
-    return http_1.default.get(accountId, {
-        url: `${PROJECTS_API_PATH}/by-id/${projectId}/deploy-components-metadata`,
-    });
-}
-exports.fetchDeployComponentsMetadata = fetchDeployComponentsMetadata;
 async function provisionBuild(accountId, projectName, platformVersion) {
     return http_1.default.post(accountId, {
         url: `${PROJECTS_API_PATH}/${encodeURIComponent(projectName)}/builds/staged/provision`,
         params: { platformVersion },
         headers: { 'Content-Type': 'application/json' },
-        timeout: 50000,
+        timeout: 50_000,
     });
 }
 exports.provisionBuild = provisionBuild;

package/lib/path.d.ts

@@ -11,3 +11,4 @@ export declare function isAllowedExtension(filepath: string, allowList?: Array<s
 export declare function getAbsoluteFilePath(_path: string): string;
 export declare function sanitizeFileName(fileName: string): string;
 export declare function isValidPath(_path: string): boolean;
+export declare function untildify(pathWithTilde: string): string;

package/lib/path.js

@@ -3,10 +3,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isValidPath = exports.sanitizeFileName = exports.getAbsoluteFilePath = exports.isAllowedExtension = exports.getAllowedExtensions = exports.getExt = exports.getCwd = exports.splitHubSpotPath = exports.splitLocalPath = exports.convertToLocalFileSystemPath = exports.convertToUnixPath = void 0;
+exports.untildify = 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");
+const os_1 = __importDefault(require("os"));
 function convertToUnixPath(_path) {
     return (0, unixify_1.default)(path_1.default.normalize(_path));
 }
@@ -120,3 +121,14 @@ function isValidPath(_path) {
     return true;
 }
 exports.isValidPath = isValidPath;
+// Based on the untildify package: https://github.com/sindresorhus/untildify/blob/main/index.js
+function untildify(pathWithTilde) {
+    const homeDirectory = os_1.default.homedir();
+    if (typeof pathWithTilde !== 'string') {
+        throw new TypeError(`Expected a string, got ${typeof pathWithTilde}`);
+    }
+    return homeDirectory
+        ? pathWithTilde.replace(/^~(?=$|\/|\\)/, homeDirectory)
+        : pathWithTilde;
+}
+exports.untildify = untildify;

package/lib/personalAccessKey.d.ts

@@ -2,7 +2,7 @@ import { CLIAccount } from '../types/Accounts';
 import { Environment } from '../types/Config';
 import { AccessToken } from '../types/Accounts';
 export declare function getAccessToken(personalAccessKey: string, env?: Environment, accountId?: number): Promise<AccessToken>;
-export declare function accessTokenForPersonalAccessKey(accountId: number): Promise<string | undefined>;
+export declare function accessTokenForPersonalAccessKey(accountId: number, forceRefresh?: boolean): Promise<string | undefined>;
 export declare function enabledFeaturesForPersonalAccessKey(accountId: number): Promise<{
     [key: string]: number;
 } | undefined>;

package/lib/personalAccessKey.js

@@ -92,7 +92,7 @@ async function getNewAccessTokenByAccountId(accountId) {
     const accessTokenResponse = await getNewAccessToken(accountId, personalAccessKey, auth?.tokenInfo?.expiresAt, env);
     return accessTokenResponse;
 }
-async function accessTokenForPersonalAccessKey(accountId) {
+async function accessTokenForPersonalAccessKey(accountId, forceRefresh = false) {
     const account = (0, config_1.getAccountConfig)(accountId);
     if (!account) {
         (0, standardErrors_1.throwErrorWithMessage)(`${i18nKey}.errors.accountNotFound`, { accountId });
@@ -101,6 +101,7 @@ async function accessTokenForPersonalAccessKey(accountId) {
     const authTokenInfo = auth && auth.tokenInfo;
     const authDataExists = authTokenInfo && auth?.tokenInfo?.accessToken;
     if (!authDataExists ||
+        forceRefresh ||
         (0, moment_1.default)().add(5, 'minutes').isAfter((0, moment_1.default)(authTokenInfo.expiresAt))) {
         return getNewAccessToken(accountId, personalAccessKey, authTokenInfo && authTokenInfo.expiresAt, env).then(tokenInfo => tokenInfo.accessToken);
     }

package/package.json

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

package/types/ComponentStructure.d.ts

@@ -6,15 +6,35 @@ export type ComponentStructure = {
 export type ComponentStructureResponse = {
     topLevelComponentsWithChildren: ComponentStructure;
 };
-export type ComponentMetadata = {
-    componentIdentifier: string;
+export type ProjectComponentsMetadata = {
+    topLevelComponentMetadata: TopLevelComponents[];
+};
+export interface ComponentMetadata<T> {
     componentName: string;
-    componentType: ValueOf<typeof COMPONENT_TYPES> | ValueOf<typeof SUBCOMPONENT_TYPES>;
-    metadata: {
-        appId: string;
+    type: {
+        name: T;
     };
-    parentComponentType: string;
-};
-export type ComponentMetadataResponse = {
-    results: Array<ComponentMetadata>;
-};
+    deployOutput: unknown;
+}
+export interface TopLevelComponent extends ComponentMetadata<ValueOf<typeof COMPONENT_TYPES>> {
+    featureComponents: FeatureComponents[];
+}
+export interface PrivateAppComponentMetadata extends TopLevelComponent {
+    deployOutput: {
+        cardId: number;
+        appId: number;
+    };
+}
+export type TopLevelComponents = PrivateAppComponentMetadata | TopLevelComponent;
+export interface FeatureComponent<T = unknown> extends ComponentMetadata<ValueOf<typeof SUBCOMPONENT_TYPES>> {
+    deployOutput: T;
+}
+export type AppFunctionComponentMetadata = FeatureComponent<{
+    appId: number;
+    appFunctionName: string;
+    endpoint?: {
+        path: string;
+        methods: string[];
+    };
+}>;
+export type FeatureComponents = FeatureComponent | AppFunctionComponentMetadata;