@hubspot/local-dev-lib 0.7.12-experimental.1 → 0.7.13-experimental.0

package/api/fileMapper.d.ts

@@ -1,5 +1,5 @@
 import { AxiosResponse } from 'axios';
-import { FileMapperNode, FileMapperOptions, FileTree } from '../types/Files.js';
+import { DirectoryMetaNode, FileMapperNode, FileMapperOptions, FileTree } from '../types/Files.js';
 import { HubSpotPromise } from '../types/Http.js';
 export declare function createFileMapperNodeFromStreamResponse(filePath: string, response: Partial<AxiosResponse>): FileMapperNode;
 export declare function upload(accountId: number, src: string, dest: string, options?: FileMapperOptions): HubSpotPromise<void>;
@@ -10,3 +10,4 @@ export declare function downloadDefault(accountId: number, filepath: string, opt
 export declare function deleteFile(accountId: number, filePath: string): HubSpotPromise<void>;
 export declare function moveFile(accountId: number, srcPath: string, destPath: string): HubSpotPromise<void>;
 export declare function getDirectoryContentsByPath(accountId: number, path: string): HubSpotPromise<FileMapperNode>;
+export declare function getDirectoryMetaByPath(accountId: number, path: string, options?: FileMapperOptions): HubSpotPromise<DirectoryMetaNode>;

package/api/fileMapper.js

@@ -89,3 +89,10 @@ export function getDirectoryContentsByPath(accountId, path) {
         url: `${FILE_MAPPER_API_PATH}/meta/${path}`,
     });
 }
+// getDirectoryContentsByPath has the wrong return type for /meta/ — children are strings, not FileMapperNodes
+export function getDirectoryMetaByPath(accountId, path, options = {}) {
+    return http.get(accountId, {
+        url: `${FILE_MAPPER_API_PATH}/meta/${path.split('/').map(encodeURIComponent).join('/')}`,
+        ...options,
+    });
+}

package/api/projects.d.ts

@@ -6,7 +6,7 @@ import { Deploy, ProjectDeployResponse, ProjectDeployResponseV1, ProjectDeletion
 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>;
-export declare function uploadProject(accountId: number, projectName: string, projectFile: string, uploadMessage: string, platformVersion?: string, intermediateRepresentation?: unknown): HubSpotPromise<UploadProjectResponse | UploadIRResponse>;
+export declare function uploadProject(accountId: number, projectName: string, projectFile: string, uploadMessage: string, platformVersion?: string, intermediateRepresentation?: unknown, skipAutoDeploy?: boolean): HubSpotPromise<UploadProjectResponse | UploadIRResponse>;
 export declare function fetchProject(accountId: number, projectName: string): HubSpotPromise<Project>;
 export declare function fetchProjectComponentsMetadata(accountId: number, projectId: number): HubSpotPromise<ProjectComponentsMetadata>;
 export declare function downloadProject(accountId: number, projectName: string, buildId: number): HubSpotPromise<Buffer>;

package/api/projects.js

@@ -21,7 +21,7 @@ export function createProject(accountId, name) {
         },
     });
 }
-export async function uploadProject(accountId, projectName, projectFile, uploadMessage, platformVersion, intermediateRepresentation) {
+export async function uploadProject(accountId, projectName, projectFile, uploadMessage, platformVersion, intermediateRepresentation, skipAutoDeploy) {
     if (intermediateRepresentation) {
         const formData = {
             projectFilesZip: fs.createReadStream(projectFile),
@@ -30,6 +30,7 @@ export async function uploadProject(accountId, projectName, projectFile, uploadM
                 ...intermediateRepresentation,
                 projectName,
                 buildMessage: uploadMessage,
+                skipAutoDeploy: skipAutoDeploy || false,
             }),
         };
         const response = await http.post(accountId, {
@@ -49,6 +50,9 @@ export async function uploadProject(accountId, projectName, projectFile, uploadM
     if (platformVersion) {
         formData.platformVersion = platformVersion;
     }
+    if (skipAutoDeploy) {
+        formData.skipAutoDeploy = String(skipAutoDeploy);
+    }
     return http.post(accountId, {
         url: `${PROJECTS_API_PATH}/upload/${encodeURIComponent(projectName)}`,
         timeout: 60_000,

package/lib/cms/themes.js

@@ -1,7 +1,5 @@
 import findup from 'findup-sync';
-import { getHubSpotWebsiteOrigin } from '../urls.js';
-import { ENVIRONMENTS } from '../../constants/environments.js';
-import { getConfigAccountEnvironment } from '../../config/index.js';
+import { getHubSpotWebsiteOriginByAccountId } from '../urls.js';
 export function getThemeJSONPath(path) {
     return findup('theme.json', {
         cwd: path,
@@ -21,8 +19,6 @@ export function getThemePreviewUrl(filePath, accountId) {
     const themeName = getThemeNameFromPath(filePath);
     if (!themeName)
         return;
-    const baseUrl = getHubSpotWebsiteOrigin(getConfigAccountEnvironment(accountId) === 'qa'
-        ? ENVIRONMENTS.QA
-        : ENVIRONMENTS.PROD);
+    const baseUrl = getHubSpotWebsiteOriginByAccountId(accountId);
     return `${baseUrl}/theme-previewer/${accountId}/edit/${encodeURIComponent(themeName)}`;
 }

package/lib/fileMapper.d.ts

@@ -3,10 +3,15 @@ export declare function isPathToFile(filepath: string): boolean;
 export declare function isPathToModule(filepath: string): boolean;
 export declare function isPathToRoot(filepath: string): boolean;
 export declare function isPathToHubspot(filepath: string): boolean;
-export declare function getFileMapperQueryValues(cmsPublishMode?: CmsPublishMode | null, { staging, assetVersion }?: FileMapperInputOptions): FileMapperOptions;
+export declare function getFileMapperQueryValues(cmsPublishMode?: CmsPublishMode | null, { staging, assetVersion, timeout }?: FileMapperInputOptions): FileMapperOptions;
 export declare function getTypeDataFromPath(src: string): PathTypeData;
 export declare function recurseFolder(node: FileMapperNode, callback: RecursiveFileMapperCallback, filepath?: string, depth?: number): boolean;
 export declare function writeUtimes(accountId: number, filepath: string, node: FileMapperNode): Promise<void>;
+/**
+ * @deprecated Use downloadFileOrFolder instead. This function fetches the
+ * entire directory tree in a single request, which times out for large
+ * directories.
+ */
 export declare function fetchFolderFromApi(accountId: number, src: string, cmsPublishMode?: CmsPublishMode, options?: FileMapperInputOptions): Promise<FileMapperNode>;
 /**
  * Fetch a file/folder and write to local file system.

package/lib/fileMapper.js

@@ -4,16 +4,13 @@ import path from 'path';
 import PQueue from 'p-queue';
 import { getCwd, getExt, convertToLocalFileSystemPath, isAllowedExtension, } from './path.js';
 import { logger } from './logger.js';
-import { fetchFileStream, download, downloadDefault, } from '../api/fileMapper.js';
+import { fetchFileStream, download, downloadDefault, getDirectoryMetaByPath, } from '../api/fileMapper.js';
 import { MODULE_EXTENSION, FUNCTIONS_EXTENSION, JSR_ALLOWED_EXTENSIONS, } from '../constants/extensions.js';
 import { CMS_PUBLISH_MODE } from '../constants/files.js';
 import { isTimeoutError } from '../errors/index.js';
 import { i18n } from '../utils/lang.js';
 import { FileSystemError } from '../models/FileSystemError.js';
 const i18nKey = 'lib.fileMapper';
-const queue = new PQueue({
-    concurrency: 10,
-});
 export function isPathToFile(filepath) {
     const ext = getExt(filepath);
     return !!ext && ext !== MODULE_EXTENSION && ext !== FUNCTIONS_EXTENSION;
@@ -37,13 +34,14 @@ function useApiBuffer(cmsPublishMode) {
     return cmsPublishMode === CMS_PUBLISH_MODE.draft;
 }
 // Determines API param based on publish mode and options
-export function getFileMapperQueryValues(cmsPublishMode, { staging, assetVersion } = {}) {
+export function getFileMapperQueryValues(cmsPublishMode, { staging, assetVersion, timeout } = {}) {
     return {
         params: {
             buffer: useApiBuffer(cmsPublishMode),
             environmentId: staging ? 2 : 1,
             version: assetVersion,
         },
+        ...(timeout !== undefined && { timeout }),
     };
 }
 // Determines version number to log based on input.options
@@ -141,40 +139,6 @@ async function fetchAndWriteFileStream(accountId, srcPath, filepath, cmsPublishM
     const node = await fetchFileStream(accountId, srcPath, filepath, getFileMapperQueryValues(cmsPublishMode, options));
     await writeUtimes(accountId, filepath, node);
 }
-// Writes an individual file or folder (not recursive).  If file source is missing, the
-//file is fetched.
-async function writeFileMapperNode(accountId, filepath, node, cmsPublishMode, options = {}) {
-    const localFilepath = convertToLocalFileSystemPath(path.resolve(filepath));
-    if (await skipExisting(localFilepath, options.overwrite)) {
-        logger.log(i18n(`${i18nKey}.skippedExisting`, {
-            filepath: localFilepath,
-        }));
-        return true;
-    }
-    if (!node.folder) {
-        try {
-            await fetchAndWriteFileStream(accountId, node.path, localFilepath, cmsPublishMode, options);
-            return true;
-        }
-        catch (err) {
-            return false;
-        }
-    }
-    try {
-        await fs.ensureDir(localFilepath);
-        logger.log(i18n(`${i18nKey}.wroteFolder`, {
-            filepath: localFilepath,
-        }));
-    }
-    catch (err) {
-        throw new FileSystemError({ cause: err }, {
-            filepath: localFilepath,
-            accountId,
-            operation: 'write',
-        });
-    }
-    return true;
-}
 async function downloadFile(accountId, src, destPath, cmsPublishMode, options = {}) {
     const { isFile, isHubspot } = getTypeDataFromPath(src);
     if (!isFile) {
@@ -201,7 +165,6 @@ async function downloadFile(accountId, src, destPath, cmsPublishMode, options =
         }
         const localFsPath = convertToLocalFileSystemPath(filepath);
         await fetchAndWriteFileStream(accountId, src, localFsPath, cmsPublishMode, options);
-        await queue.onIdle();
         logger.success(i18n(`${i18nKey}.completedFetch`, {
             src,
             version: getAssetVersionIdentifier(options.assetVersion, src),
@@ -218,6 +181,11 @@ async function downloadFile(accountId, src, destPath, cmsPublishMode, options =
         }
     }
 }
+/**
+ * @deprecated Use downloadFileOrFolder instead. This function fetches the
+ * entire directory tree in a single request, which times out for large
+ * directories.
+ */
 export async function fetchFolderFromApi(accountId, src, cmsPublishMode, options = {}) {
     const { isRoot, isFolder, isHubspot } = getTypeDataFromPath(src);
     if (!isFolder) {
@@ -233,44 +201,82 @@ export async function fetchFolderFromApi(accountId, src, cmsPublishMode, options
     logger.log(i18n(`${i18nKey}.folderFetch`, { src, accountId }));
     return node;
 }
+async function queueFolderTree(accountId, src, localPath, directoryNode, ctx) {
+    const { cmsPublishMode, options, failedPaths, queue } = ctx;
+    if (!directoryNode.folder)
+        return;
+    const { isRoot } = getTypeDataFromPath(src);
+    let children = directoryNode.children || [];
+    if (isRoot) {
+        children = ['@hubspot', ...children];
+    }
+    try {
+        await fs.ensureDir(localPath);
+    }
+    catch (err) {
+        throw new FileSystemError({ cause: err }, { filepath: localPath, accountId, operation: 'write' });
+    }
+    logger.log(i18n(`${i18nKey}.wroteFolder`, { filepath: localPath }));
+    const queryValues = getFileMapperQueryValues(cmsPublishMode, options);
+    const queueFileDownload = (remotePath, destPath) => {
+        queue.add(async () => {
+            try {
+                await fetchAndWriteFileStream(accountId, remotePath, destPath, cmsPublishMode, options);
+            }
+            catch (err) {
+                failedPaths.add(remotePath);
+                logger.debug(i18n(`${i18nKey}.errors.failedToFetchFile`, {
+                    src: remotePath,
+                    dest: destPath,
+                }));
+            }
+        });
+    };
+    for (const childName of children) {
+        const childRemotePath = isRoot ? childName : `${src}/${childName}`;
+        const childLocalPath = convertToLocalFileSystemPath(path.join(localPath, childName));
+        if (isAllowedExtension(childRemotePath, [...JSR_ALLOWED_EXTENSIONS])) {
+            queueFileDownload(childRemotePath, childLocalPath);
+        }
+        else {
+            const { data: childNode } = await getDirectoryMetaByPath(accountId, childRemotePath, queryValues);
+            if (childNode) {
+                if (childNode.folder) {
+                    await queueFolderTree(accountId, childRemotePath, childLocalPath, childNode, ctx);
+                }
+                else {
+                    queueFileDownload(childRemotePath, childLocalPath);
+                }
+            }
+        }
+    }
+}
 async function downloadFolder(accountId, src, destPath, cmsPublishMode, options = {}) {
+    src = src.length > 1 ? src.replace(/\/+$/, '') : src;
+    const dest = path.resolve(destPath);
+    const { isRoot } = getTypeDataFromPath(src);
+    const metaPath = isRoot ? '/' : src;
+    const queryValues = getFileMapperQueryValues(cmsPublishMode, options);
+    const failedPaths = new Set();
+    const queue = new PQueue({ concurrency: 10 });
     try {
-        const node = await fetchFolderFromApi(accountId, src, cmsPublishMode, options);
-        if (!node) {
+        const { data: rootMeta } = await getDirectoryMetaByPath(accountId, metaPath, queryValues);
+        if (!rootMeta)
             return;
-        }
-        const dest = path.resolve(destPath);
+        logger.log(i18n(`${i18nKey}.folderFetch`, { src, accountId }));
         const rootPath = dest === getCwd()
-            ? convertToLocalFileSystemPath(path.resolve(dest, node.name))
+            ? convertToLocalFileSystemPath(path.resolve(dest, rootMeta.name || path.basename(src)))
             : dest;
-        let success = true;
-        recurseFolder(node, (childNode, filepath) => {
-            queue.add(async () => {
-                const succeeded = await writeFileMapperNode(accountId, filepath || '', childNode, cmsPublishMode, options);
-                if (succeeded === false) {
-                    success = false;
-                    logger.debug(i18n(`${i18nKey}.errors.failedToFetchFile`, {
-                        src: childNode.path,
-                        dest: filepath || '',
-                    }));
-                }
-            });
-            return success;
-        }, rootPath);
+        await queueFolderTree(accountId, src, rootPath, rootMeta, {
+            cmsPublishMode,
+            options,
+            failedPaths,
+            queue,
+        });
         await queue.onIdle();
-        if (success) {
-            logger.success(i18n(`${i18nKey}.completedFolderFetch`, {
-                src,
-                version: getAssetVersionIdentifier(options.assetVersion, src),
-                dest,
-            }));
-        }
-        else {
-            // TODO: Fix this exception. It is triggering the catch block so this error is being rewritten
-            throw new Error(i18n(`${i18nKey}.errors.incompleteFetch`, { src }));
-        }
     }
     catch (err) {
+        queue.clear();
         const error = err;
         if (isTimeoutError(error)) {
             throw new Error(i18n(`${i18nKey}.errors.assetTimeout`), { cause: error });
@@ -279,6 +285,14 @@ async function downloadFolder(accountId, src, destPath, cmsPublishMode, options
             throw new Error(i18n(`${i18nKey}.errors.failedToFetchFolder`, { src, dest: destPath }), { cause: err });
         }
     }
+    if (failedPaths.size > 0) {
+        throw new Error(i18n(`${i18nKey}.errors.incompleteFetch`, { src }));
+    }
+    logger.success(i18n(`${i18nKey}.completedFolderFetch`, {
+        src,
+        version: getAssetVersionIdentifier(options.assetVersion, src),
+        dest,
+    }));
 }
 /**
  * Fetch a file/folder and write to local file system.

package/lib/urls.d.ts

@@ -1,2 +1,3 @@
 export declare const getHubSpotWebsiteOrigin: (env: string) => string;
+export declare function getHubSpotWebsiteOriginByAccountId(accountId: number): string;
 export declare function getHubSpotApiOrigin(env?: string, useLocalHost?: boolean): string;

package/lib/urls.js

@@ -1,4 +1,5 @@
 import { ENVIRONMENTS } from '../constants/environments.js';
+import { getConfigAccountEnvironment } from '../config/index.js';
 function getEnvUrlString(env) {
     if (typeof env !== 'string') {
         return '';
@@ -6,6 +7,11 @@ function getEnvUrlString(env) {
     return env.toLowerCase() === ENVIRONMENTS.QA ? ENVIRONMENTS.QA : '';
 }
 export const getHubSpotWebsiteOrigin = (env) => `https://app.hubspot${getEnvUrlString(env)}.com`;
+export function getHubSpotWebsiteOriginByAccountId(accountId) {
+    return getHubSpotWebsiteOrigin(getConfigAccountEnvironment(accountId) === ENVIRONMENTS.QA
+        ? ENVIRONMENTS.QA
+        : ENVIRONMENTS.PROD);
+}
 export function getHubSpotApiOrigin(env, useLocalHost) {
     let domain;
     const domainOverride = process.env.HUBAPI_DOMAIN_OVERRIDE;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/local-dev-lib",
-    "version": "0.7.12-experimental.1",
+    "version": "0.7.13-experimental.0",
     "type": "module",
     "description": "Provides library functionality for HubSpot local development tooling, including the HubSpot CLI",
     "files": [
@@ -9,7 +9,7 @@
     ],
     "repository": {
         "type": "git",
-        "url": "https://github.com/HubSpot/hubspot-local-dev-lib"
+        "url": "git+https://github.com/HubSpot/hubspot-local-dev-lib.git"
     },
     "publishConfig": {
         "registry": "https://registry.npmjs.org/",
@@ -47,7 +47,7 @@
         "open": "^8.4.2",
         "tsx": "^4.20.6",
         "typescript": "^5.9.3",
-        "vitest": "^2.1.9",
+        "vitest": "^3.2.6",
         "yargs": "^17.7.2"
     },
     "exports": {
@@ -72,7 +72,7 @@
     },
     "dependencies": {
         "address": "2.0.2",
-        "axios": "1.15.2",
+        "axios": "1.16.0",
         "chalk": "5.6.2",
         "chokidar": "3.6.0",
         "content-disposition": "0.5.4",
@@ -85,7 +85,7 @@
         "http-proxy-agent": "7.0.2",
         "https-proxy-agent": "7.0.6",
         "ignore": "^7.0.0",
-        "js-yaml": "4.1.1",
+        "js-yaml": "4.2.0",
         "moment": "2.30.1",
         "p-queue": "^7.0.0",
         "prettier": "^3.6.2",

package/types/Files.d.ts

@@ -18,6 +18,14 @@ export type FileMapperNode = {
     folder: boolean;
     children: Array<FileMapperNode>;
 };
+export type DirectoryMetaNode = {
+    name: string;
+    path: string;
+    folder: boolean;
+    children: Array<string>;
+    createdAt?: number;
+    updatedAt?: number;
+};
 export type CmsPublishMode = ValueOf<typeof CMS_PUBLISH_MODE>;
 export type FileMapperOptions = Omit<HttpOptions, 'url'>;
 export type FileMapperInputOptions = {