@hubspot/cli 7.8.12-experimental.1 → 7.9.0-beta.1

package/commands/theme/preview.js

@@ -1,200 +1,37 @@
-import fs from 'fs';
-import path from 'path';
-import cliProgress from 'cli-progress';
-import { commands } from '../../lang/en.js';
-import { getCwd } from '@hubspot/local-dev-lib/path';
-import { FILE_UPLOAD_RESULT_TYPES } from '@hubspot/local-dev-lib/constants/files';
-import { getThemeJSONPath } from '@hubspot/local-dev-lib/cms/themes';
-import { preview } from '@hubspot/theme-preview-dev-server';
-import { getUploadableFileList } from '../../lib/upload.js';
-import { trackCommandUsage } from '../../lib/usageTracking.js';
-import { previewPrompt, previewProjectPrompt, } from '../../lib/prompts/previewPrompt.js';
-import { EXIT_CODES } from '../../lib/enums/exitCodes.js';
-import { ApiErrorContext, logError } from '../../lib/errorHandlers/index.js';
-import { handleExit, handleKeypress } from '../../lib/process.js';
-import { getProjectConfig } from '../../lib/projects/config.js';
-import { findProjectComponents } from '../../lib/projects/structure.js';
-import { ComponentTypes } from '../../types/Projects.js';
+import { uiCommandRelocatedMessage, uiCommandRenamedDescription, uiDeprecatedTag, } from '../../lib/ui/index.js';
+import previewCommand from '../cms/theme/preview.js';
 import { makeYargsBuilder } from '../../lib/yargsUtils.js';
-import { uiLogger } from '../../lib/ui/logger.js';
-const command = 'preview [--src] [--dest]';
-const describe = commands.theme.subcommands.preview.describe;
-function validateSrcPath(src) {
-    const logInvalidPath = () => {
-        uiLogger.error(commands.theme.subcommands.preview.errors.invalidPath(src));
-    };
-    try {
-        const stats = fs.statSync(src);
-        if (!stats.isDirectory()) {
-            logInvalidPath();
-            return false;
-        }
-    }
-    catch (e) {
-        logInvalidPath();
-        return false;
-    }
-    return true;
-}
-function handleUserInput() {
-    const onTerminate = () => {
-        uiLogger.log(commands.theme.subcommands.preview.logs.processExited);
-        process.exit(EXIT_CODES.SUCCESS);
-    };
-    handleExit(onTerminate);
-    handleKeypress(key => {
-        if ((key.ctrl && key.name === 'c') || key.name === 'q') {
-            onTerminate();
-        }
-    });
-}
-async function determineSrcAndDest(args) {
-    let absoluteSrc;
-    let dest;
-    const { projectDir, projectConfig } = await getProjectConfig();
-    if (!(projectDir && projectConfig)) {
-        // Not in a project, prompt for src and dest of traditional theme
-        const previewPromptAnswers = await previewPrompt(args);
-        const src = args.src || previewPromptAnswers.src;
-        dest = args.dest || previewPromptAnswers.dest;
-        absoluteSrc = path.resolve(getCwd(), src);
-        if (!dest || !validateSrcPath(absoluteSrc)) {
-            process.exit(EXIT_CODES.ERROR);
-        }
-    }
-    else {
-        // In a project
-        let themeJsonPath = getThemeJSONPath(getCwd());
-        if (!themeJsonPath) {
-            const projectComponents = await findProjectComponents(projectDir);
-            const themeComponents = projectComponents.filter(c => c.type === ComponentTypes.HublTheme);
-            if (themeComponents.length === 0) {
-                uiLogger.error(commands.theme.subcommands.preview.errors.noThemeComponents);
-                process.exit(EXIT_CODES.ERROR);
-            }
-            const answer = await previewProjectPrompt(themeComponents);
-            themeJsonPath = `${answer.themeComponentPath}/theme.json`;
-        }
-        const { dir: themeDir } = path.parse(themeJsonPath);
-        absoluteSrc = themeDir;
-        const { base: themeName } = path.parse(themeDir);
-        dest = `@projects/${projectConfig.name}/${themeName}`;
-    }
-    return { absoluteSrc, dest };
-}
+import { commands } from '../../lang/en.js';
+const command = 'preview';
+const describe = uiDeprecatedTag(previewCommand.describe, false);
 async function handler(args) {
-    const { derivedAccountId, notify, noSsl, resetSession, port, generateFieldsTypes, } = args;
-    const { absoluteSrc, dest } = await determineSrcAndDest(args);
-    const filePaths = await getUploadableFileList(absoluteSrc, false);
-    function startProgressBar(numFiles) {
-        const initialUploadProgressBar = new cliProgress.SingleBar({
-            gracefulExit: true,
-            format: '[{bar}] {percentage}% | {value}/{total} | {label}',
-            hideCursor: true,
-        }, cliProgress.Presets.rect);
-        initialUploadProgressBar.start(numFiles, 0, {
-            label: commands.theme.subcommands.preview.initialUploadProgressBar.start,
-        });
-        let uploadsHaveStarted = false;
-        const uploadOptions = {
-            onAttemptCallback: () => {
-                /* Intentionally blank */
-            },
-            onSuccessCallback: () => {
-                initialUploadProgressBar.increment();
-                if (!uploadsHaveStarted) {
-                    uploadsHaveStarted = true;
-                    initialUploadProgressBar.update(0, {
-                        label: commands.theme.subcommands.preview.initialUploadProgressBar
-                            .uploading,
-                    });
-                }
-            },
-            onFirstErrorCallback: () => {
-                /* Intentionally blank */
-            },
-            onRetryCallback: () => {
-                /* Intentionally blank */
-            },
-            onFinalErrorCallback: () => initialUploadProgressBar.increment(),
-            onFinishCallback: (results) => {
-                initialUploadProgressBar.update(numFiles, {
-                    label: commands.theme.subcommands.preview.initialUploadProgressBar.finish,
-                });
-                initialUploadProgressBar.stop();
-                results.forEach(result => {
-                    if (result.resultType == FILE_UPLOAD_RESULT_TYPES.FAILURE) {
-                        uiLogger.error(commands.theme.subcommands.preview.errors.uploadFailed(result.file, dest));
-                        logError(result.error, new ApiErrorContext({
-                            accountId: derivedAccountId,
-                            request: dest,
-                            payload: result.file,
-                        }));
-                    }
-                });
-            },
-        };
-        return uploadOptions;
-    }
-    trackCommandUsage('preview', {}, derivedAccountId);
-    let createUnifiedDevServer;
-    try {
-        // @ts-ignore TODO: Remove when we deprecate Node 18
-        require.resolve('@hubspot/cms-dev-server');
-        // @ts-ignore TODO: Remove when we deprecate Node 18
-        const { createDevServer } = await import('@hubspot/cms-dev-server');
-        createUnifiedDevServer = createDevServer;
-    }
-    catch (e) {
-        uiLogger.warn('Unified dev server requires node 20 to run. Defaulting to legacy preview.');
-    }
-    if (createUnifiedDevServer) {
-        if (port) {
-            process.env['PORT'] = port.toString();
-        }
-        createUnifiedDevServer(absoluteSrc, false, '', '', !noSsl, generateFieldsTypes, {
-            filePaths,
-            resetSession: resetSession || false,
-            startProgressBar,
-            dest,
-        });
-    }
-    else {
-        preview(derivedAccountId, absoluteSrc, dest, {
-            notify,
-            filePaths,
-            noSsl,
-            port,
-            resetSession: resetSession || false,
-            startProgressBar,
-            handleUserInput,
-        });
-    }
+    uiCommandRelocatedMessage('hs cms theme preview');
+    await previewCommand.handler(args);
 }
-function themePreviewBuilder(yargs) {
+function deprecatedThemePreviewBuilder(yargs) {
     yargs
         .option('src', {
-        describe: commands.theme.subcommands.preview.positionals.src,
+        describe: commands.cms.subcommands.theme.subcommands.preview.positionals.src,
         type: 'string',
         requiresArg: true,
     })
         .option('dest', {
-        describe: commands.theme.subcommands.preview.positionals.dest,
+        describe: commands.cms.subcommands.theme.subcommands.preview.positionals.dest,
         type: 'string',
         requiresArg: true,
     })
         .option('notify', {
         alias: 'n',
-        describe: commands.theme.subcommands.preview.options.notify,
+        describe: commands.cms.subcommands.theme.subcommands.preview.options.notify,
         type: 'string',
         requiresArg: true,
     })
         .option('no-ssl', {
-        describe: commands.theme.subcommands.preview.options.noSsl,
+        describe: commands.cms.subcommands.theme.subcommands.preview.options.noSsl,
         type: 'boolean',
     })
         .option('port', {
-        describe: commands.theme.subcommands.preview.options.port,
+        describe: commands.cms.subcommands.theme.subcommands.preview.options.port,
         type: 'number',
     })
         .option('resetSession', {
@@ -207,15 +44,16 @@ function themePreviewBuilder(yargs) {
     });
     return yargs;
 }
-const builder = makeYargsBuilder(themePreviewBuilder, command, describe, {
+const verboseDescribe = uiCommandRenamedDescription(previewCommand.describe, 'hs cms theme preview');
+const builder = makeYargsBuilder(deprecatedThemePreviewBuilder, command, verboseDescribe, {
     useGlobalOptions: true,
     useConfigOptions: true,
     useAccountOptions: true,
 });
-const themePreviewCommand = {
-    command,
+const deprecatedPreviewCommand = {
+    ...previewCommand,
     describe,
     handler,
     builder,
 };
-export default themePreviewCommand;
+export default deprecatedPreviewCommand;

package/commands/theme.d.ts

@@ -1,3 +1,3 @@
 import { YargsCommandModuleBucket } from '../types/Yargs.js';
-declare const themeCommand: YargsCommandModuleBucket;
-export default themeCommand;
+declare const deprecatedCmsThemeCommand: YargsCommandModuleBucket;
+export default deprecatedCmsThemeCommand;

package/commands/theme.js

@@ -1,23 +1,29 @@
-import marketplaceValidate from './theme/marketplace-validate.js';
-import generateSelectors from './theme/generate-selectors.js';
+import { uiCommandRelocatedMessage, uiCommandRenamedDescription, uiDeprecatedTag, } from '../lib/ui/index.js';
+import cmsThemeCommand from './cms/theme.js';
+import generateSelectorsCommand from './theme/generate-selectors.js';
+import marketplaceValidateCommand from './theme/marketplace-validate.js';
 import previewCommand from './theme/preview.js';
-import { commands } from '../lang/en.js';
 import { makeYargsBuilder } from '../lib/yargsUtils.js';
-const command = ['theme', 'themes'];
-const describe = commands.theme.describe;
-function themeBuilder(yargs) {
+const command = ['theme'];
+const describe = uiDeprecatedTag(cmsThemeCommand.describe, false);
+async function handler(args) {
+    uiCommandRelocatedMessage('hs cms theme');
+    await cmsThemeCommand.handler(args);
+}
+function deprecatedCmsThemeBuilder(yargs) {
     yargs
+        .command(generateSelectorsCommand)
+        .command(marketplaceValidateCommand)
         .command(previewCommand)
-        .command(marketplaceValidate)
-        .command(generateSelectors)
         .demandCommand(1, '');
     return yargs;
 }
-const builder = makeYargsBuilder(themeBuilder, command, describe);
-const themeCommand = {
-    command,
+const verboseDescribe = uiCommandRenamedDescription(cmsThemeCommand.describe, 'hs cms theme');
+const builder = makeYargsBuilder(deprecatedCmsThemeBuilder, command, verboseDescribe);
+const deprecatedCmsThemeCommand = {
+    ...cmsThemeCommand,
     describe,
+    handler,
     builder,
-    handler: () => { },
 };
-export default themeCommand;
+export default deprecatedCmsThemeCommand;

package/commands/upload.d.ts

@@ -1,12 +1,4 @@
-import { CommonArgs, ConfigArgs, AccountArgs, EnvironmentArgs, CmsPublishModeArgs, YargsCommandModule } from '../types/Yargs.js';
-type UploadArgs = CommonArgs & ConfigArgs & AccountArgs & EnvironmentArgs & CmsPublishModeArgs & {
-    src?: string;
-    dest?: string;
-    fieldOptions?: string | string[];
-    saveOutput?: boolean;
-    convertFields?: boolean;
-    clean?: boolean;
-    force?: boolean;
-};
-declare const uploadCommand: YargsCommandModule<unknown, UploadArgs>;
-export default uploadCommand;
+import { YargsCommandModule } from '../types/Yargs.js';
+import { UploadArgs } from './cms/upload.js';
+declare const deprecatedCmsUploadCommand: YargsCommandModule<unknown, UploadArgs>;
+export default deprecatedCmsUploadCommand;

package/commands/upload.js

@@ -1,212 +1,62 @@
-import fs from 'fs';
-import path from 'path';
-import { uploadFolder, hasUploadErrors, } from '@hubspot/local-dev-lib/cms/uploadFolder';
-import { getFileMapperQueryValues } from '@hubspot/local-dev-lib/fileMapper';
-import { upload, deleteFile } from '@hubspot/local-dev-lib/api/fileMapper';
-import { getCwd, convertToUnixPath, isAllowedExtension, } from '@hubspot/local-dev-lib/path';
-import { validateSrcAndDestPaths } from '@hubspot/local-dev-lib/cms/modules';
-import { shouldIgnoreFile } from '@hubspot/local-dev-lib/ignoreRules';
-import { getThemePreviewUrl, getThemeJSONPath, } from '@hubspot/local-dev-lib/cms/themes';
-import { FieldsJs, isConvertableFieldJs, cleanupTmpDirSync, } from '@hubspot/local-dev-lib/cms/handleFieldsJS';
-import { ApiErrorContext, logError } from '../lib/errorHandlers/index.js';
-import { getCmsPublishMode } from '../lib/commonOpts.js';
-import { uploadPrompt } from '../lib/prompts/uploadPrompt.js';
-import { confirmPrompt } from '../lib/prompts/promptUtils.js';
-import { validateCmsPublishMode } from '../lib/validation.js';
-import { trackCommandUsage } from '../lib/usageTracking.js';
-import { getUploadableFileList } from '../lib/upload.js';
-import { commands } from '../lang/en.js';
-import { EXIT_CODES } from '../lib/enums/exitCodes.js';
+import { uiCommandRelocatedMessage, uiCommandRenamedDescription, uiDeprecatedTag, } from '../lib/ui/index.js';
+import cmsUploadCommand from './cms/upload.js';
 import { makeYargsBuilder } from '../lib/yargsUtils.js';
-import { uiLogger } from '../lib/ui/logger.js';
+import { commands } from '../lang/en.js';
 const command = 'upload [src] [dest]';
-const describe = commands.upload.describe;
-function logThemePreview(filePath, accountId) {
-    const previewUrl = getThemePreviewUrl(filePath, accountId);
-    // Only log if we are actually in a theme
-    if (previewUrl) {
-        uiLogger.log(commands.upload.previewUrl(previewUrl));
-    }
-}
+const describe = uiDeprecatedTag(cmsUploadCommand.describe, false);
 async function handler(args) {
-    if (!validateCmsPublishMode(args)) {
-        process.exit(EXIT_CODES.WARNING);
-    }
-    const { derivedAccountId } = args;
-    const cmsPublishMode = getCmsPublishMode(args);
-    const uploadPromptAnswers = await uploadPrompt(args);
-    const src = args.src || uploadPromptAnswers.src;
-    const saveOutput = args.saveOutput;
-    let dest = args.dest || uploadPromptAnswers.dest;
-    let absoluteSrcPath = path.resolve(getCwd(), src);
-    if (!dest) {
-        uiLogger.error(commands.upload.errors.destinationRequired);
-        return;
-    }
-    // Check for theme.json file and determine the root path for the project based on it if it exists
-    const themeJsonPath = getThemeJSONPath(absoluteSrcPath);
-    const projectRoot = themeJsonPath
-        ? path.dirname(themeJsonPath)
-        : path.dirname(getCwd());
-    const convertFields = projectRoot &&
-        isConvertableFieldJs(projectRoot, absoluteSrcPath, args.convertFields);
-    let fieldsJs;
-    if (convertFields) {
-        fieldsJs = await new FieldsJs(projectRoot, absoluteSrcPath, undefined, args.fieldOptions).init();
-        if (fieldsJs.rejected)
-            return;
-        // Ensures that the dest path is a .json. The user might pass '.js' accidentally - this ensures it just works.
-        if (fieldsJs.outputPath) {
-            absoluteSrcPath = fieldsJs.outputPath;
-        }
-        dest = path.join(path.dirname(dest), 'fields.json');
-    }
-    let stats;
-    try {
-        stats = fs.statSync(absoluteSrcPath);
-        if (!stats.isFile() && !stats.isDirectory()) {
-            uiLogger.error(commands.upload.errors.invalidPath(src));
-            return;
-        }
-    }
-    catch (e) {
-        uiLogger.error(commands.upload.errors.invalidPath(src));
-        return;
-    }
-    const normalizedDest = convertToUnixPath(dest);
-    trackCommandUsage('upload', { mode: cmsPublishMode, type: stats.isFile() ? 'file' : 'folder' }, derivedAccountId);
-    const srcDestIssues = await validateSrcAndDestPaths({ isLocal: true, path: src }, { isHubSpot: true, path: dest });
-    if (srcDestIssues.length) {
-        srcDestIssues.forEach(({ message }) => uiLogger.error(message));
-        process.exit(EXIT_CODES.WARNING);
-    }
-    if (stats.isFile()) {
-        if (!isAllowedExtension(src) && !convertFields) {
-            uiLogger.error(commands.upload.errors.invalidPath(src));
-            return;
-        }
-        if (shouldIgnoreFile(absoluteSrcPath)) {
-            uiLogger.error(commands.upload.errors.fileIgnored(src));
-            return;
-        }
-        upload(derivedAccountId, absoluteSrcPath, normalizedDest, getFileMapperQueryValues(cmsPublishMode))
-            .then(() => {
-            uiLogger.success(commands.upload.success.fileUploaded(src, normalizedDest, derivedAccountId));
-            logThemePreview(src, derivedAccountId);
-        })
-            .catch(error => {
-            uiLogger.error(commands.upload.errors.uploadFailed(src, normalizedDest));
-            logError(error, new ApiErrorContext({
-                accountId: derivedAccountId,
-                request: normalizedDest,
-                payload: src,
-            }));
-            process.exit(EXIT_CODES.WARNING);
-        })
-            .finally(() => {
-            if (!convertFields)
-                return;
-            if (saveOutput && fieldsJs) {
-                fieldsJs.saveOutput();
-            }
-            if (fieldsJs) {
-                cleanupTmpDirSync(fieldsJs.rootWriteDir);
-            }
-        });
-    }
-    else {
-        uiLogger.log(commands.upload.uploading(src, dest, derivedAccountId));
-        // Generate the first-pass file list in here, and pass to uploadFolder.
-        const filePaths = await getUploadableFileList(absoluteSrcPath, args.convertFields ?? false);
-        if (args.clean) {
-            //  If clean is true, will first delete the dest folder and then upload src. Cleans up files that only exist on HS.
-            let cleanUpload = args.force;
-            if (!args.force) {
-                cleanUpload = await confirmPrompt(commands.upload.confirmCleanUpload(dest, derivedAccountId), { defaultAnswer: false });
-            }
-            if (cleanUpload) {
-                try {
-                    await deleteFile(derivedAccountId, dest);
-                    uiLogger.log(commands.upload.cleaning(dest, derivedAccountId));
-                }
-                catch (error) {
-                    uiLogger.error(commands.upload.errors.deleteFailed(dest, derivedAccountId));
-                }
-            }
-        }
-        uploadFolder(derivedAccountId, absoluteSrcPath, dest, {}, {
-            convertFields: args.convertFields,
-            // @ts-expect-error - fieldOptions is a string or string[]
-            fieldOptions: args.fieldOptions ?? undefined,
-            saveOutput: args.saveOutput,
-        }, filePaths)
-            .then(results => {
-            if (!hasUploadErrors(results)) {
-                uiLogger.success(commands.upload.success.uploadComplete(dest));
-                logThemePreview(src, derivedAccountId);
-            }
-            else {
-                uiLogger.error(commands.upload.errors.someFilesFailed(dest));
-                process.exit(EXIT_CODES.WARNING);
-            }
-        })
-            .catch(error => {
-            uiLogger.error(commands.upload.errors.uploadFailed(src, dest));
-            logError(error, {
-                accountId: derivedAccountId,
-            });
-            process.exit(EXIT_CODES.WARNING);
-        });
-    }
+    uiCommandRelocatedMessage('hs cms upload');
+    await cmsUploadCommand.handler(args);
 }
-function uploadBuilder(yargs) {
+function deprecatedCmsUploadBuilder(yargs) {
     yargs.positional('src', {
-        describe: commands.upload.positionals.src,
+        describe: commands.cms.subcommands.upload.positionals.src,
         type: 'string',
     });
     yargs.positional('dest', {
-        describe: commands.upload.positionals.dest,
+        describe: commands.cms.subcommands.upload.positionals.dest,
         type: 'string',
     });
     yargs.option('fieldOptions', {
-        describe: commands.upload.options.options,
+        describe: commands.cms.subcommands.upload.options.options,
         type: 'array',
         default: [''],
         hidden: true,
     });
     yargs.option('saveOutput', {
-        describe: commands.upload.options.saveOutput,
+        describe: commands.cms.subcommands.upload.options.saveOutput,
         type: 'boolean',
         default: false,
     });
     yargs.option('convertFields', {
-        describe: commands.upload.options.convertFields,
+        describe: commands.cms.subcommands.upload.options.convertFields,
         type: 'boolean',
         default: false,
     });
     yargs.option('clean', {
-        describe: commands.upload.options.clean,
+        describe: commands.cms.subcommands.upload.options.clean,
         type: 'boolean',
         default: false,
     });
     yargs.option('force', {
-        describe: commands.upload.options.force,
+        describe: commands.cms.subcommands.upload.options.force,
         type: 'boolean',
         default: false,
     });
     return yargs;
 }
-const builder = makeYargsBuilder(uploadBuilder, command, describe, {
+const verboseDescribe = uiCommandRenamedDescription(cmsUploadCommand.describe, 'hs cms upload');
+const builder = makeYargsBuilder(deprecatedCmsUploadBuilder, command, verboseDescribe, {
     useGlobalOptions: true,
     useConfigOptions: true,
     useAccountOptions: true,
     useEnvironmentOptions: true,
     useCmsPublishModeOptions: true,
 });
-const uploadCommand = {
-    command,
+const deprecatedCmsUploadCommand = {
+    ...cmsUploadCommand,
     describe,
     handler,
     builder,
 };
-export default uploadCommand;
+export default deprecatedCmsUploadCommand;

package/commands/watch.d.ts

@@ -1,14 +1,4 @@
-import { AccountArgs, CmsPublishModeArgs, CommonArgs, ConfigArgs, EnvironmentArgs, YargsCommandModule } from '../types/Yargs.js';
-type WatchCommandArgs = ConfigArgs & AccountArgs & EnvironmentArgs & CommonArgs & CmsPublishModeArgs & {
-    src?: string;
-    dest?: string;
-    fieldOptions?: string[];
-    remove?: boolean;
-    initialUpload?: boolean;
-    disableInitial?: boolean;
-    notify?: string;
-    convertFields?: boolean;
-    saveOutput?: boolean;
-};
-declare const watchCommand: YargsCommandModule<unknown, WatchCommandArgs>;
-export default watchCommand;
+import { YargsCommandModule } from '../types/Yargs.js';
+import { WatchCommandArgs } from './cms/watch.js';
+declare const deprecatedCmsWatchCommand: YargsCommandModule<unknown, WatchCommandArgs>;
+export default deprecatedCmsWatchCommand;