@hubspot/cli 7.7.0-experimental.2 → 7.7.0

package/commands/project/__tests__/watch.test.js

@@ -0,0 +1,35 @@
+import yargs from 'yargs';
+import { addAccountOptions, addConfigOptions, addUseEnvironmentOptions, } from '../../../lib/commonOpts.js';
+import projectWatchCommand from '../watch.js';
+vi.mock('../../../lib/commonOpts');
+describe('commands/project/watch', () => {
+    const yargsMock = yargs;
+    describe('command', () => {
+        it('should have the correct command structure', () => {
+            expect(projectWatchCommand.command).toEqual('watch');
+        });
+    });
+    describe('describe', () => {
+        it('should provide a description', () => {
+            expect(projectWatchCommand.describe).toBeDefined();
+        });
+    });
+    describe('builder', () => {
+        it('should support the correct options', () => {
+            projectWatchCommand.builder(yargsMock);
+            expect(addAccountOptions).toHaveBeenCalledTimes(1);
+            expect(addAccountOptions).toHaveBeenCalledWith(yargsMock);
+            expect(addConfigOptions).toHaveBeenCalledTimes(1);
+            expect(addConfigOptions).toHaveBeenCalledWith(yargsMock);
+            expect(addUseEnvironmentOptions).toHaveBeenCalledTimes(1);
+            expect(addUseEnvironmentOptions).toHaveBeenCalledWith(yargsMock);
+        });
+        it('should define options', () => {
+            const optionSpy = vi.spyOn(yargsMock, 'option');
+            const exampleSpy = vi.spyOn(yargsMock, 'example');
+            projectWatchCommand.builder(yargsMock);
+            expect(optionSpy).toHaveBeenCalledWith('initial-upload', expect.any(Object));
+            expect(exampleSpy).toHaveBeenCalled();
+        });
+    });
+});

package/commands/project/add.d.ts

@@ -1,7 +1,10 @@
-import { YargsCommandModule, CommonArgs } from '../../types/Yargs';
-type ProjectAddArgs = CommonArgs & {
-    type: string;
-    name: string;
+import { YargsCommandModule, CommonArgs } from '../../types/Yargs.js';
+export type ProjectAddArgs = CommonArgs & {
+    type?: string;
+    name?: string;
+    features?: string[];
+    distribution?: string;
+    auth?: string;
 };
 declare const projectAddCommand: YargsCommandModule<unknown, ProjectAddArgs>;
 export default projectAddCommand;

package/commands/project/add.js

@@ -1,117 +1,72 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = __importDefault(require("path"));
-const logger_1 = require("@hubspot/local-dev-lib/logger");
-const github_1 = require("@hubspot/local-dev-lib/github");
-const errorHandlers_1 = require("../../lib/errorHandlers");
-const usageTracking_1 = require("../../lib/usageTracking");
-const lang_1 = require("../../lib/lang");
-const projectAddPrompt_1 = require("../../lib/prompts/projectAddPrompt");
-const config_1 = require("../../lib/projects/config");
-const create_1 = require("../../lib/projects/create");
-const structure_1 = require("../../lib/projects/structure");
-const Projects_1 = require("../../types/Projects");
-const ui_1 = require("../../lib/ui");
-const constants_1 = require("../../lib/constants");
-const exitCodes_1 = require("../../lib/enums/exitCodes");
-const yargsUtils_1 = require("../../lib/yargsUtils");
+import { logError } from '../../lib/errorHandlers/index.js';
+import { getProjectConfig } from '../../lib/projects/config.js';
+import { EXIT_CODES } from '../../lib/enums/exitCodes.js';
+import { makeYargsBuilder } from '../../lib/yargsUtils.js';
+import { commands } from '../../lang/en.js';
+import { useV3Api } from '../../lib/projects/platformVersion.js';
+import { legacyAddComponent } from '../../lib/projects/add/legacyAddComponent.js';
+import { v3AddComponent } from '../../lib/projects/add/v3AddComponent.js';
+import { marketplaceDistribution, oAuth, privateDistribution, staticAuth, } from '../../lib/constants.js';
+import { uiLogger } from '../../lib/ui/logger.js';
 const command = 'add';
-const describe = (0, ui_1.uiBetaTag)((0, lang_1.i18n)(`commands.project.subcommands.add.describe`), false);
+const describe = commands.project.add.describe;
 async function handler(args) {
-    const { derivedAccountId } = args;
-    (0, usageTracking_1.trackCommandUsage)('project-add', undefined, derivedAccountId);
-    const { projectConfig, projectDir } = await (0, config_1.getProjectConfig)();
-    if (!projectDir || !projectConfig) {
-        logger_1.logger.error((0, lang_1.i18n)(`commands.project.subcommands.add.error.locationInProject`));
-        process.exit(exitCodes_1.EXIT_CODES.ERROR);
-    }
-    // We currently only support adding private apps to projects
-    let projectContainsPublicApp = false;
-    try {
-        const components = await (0, structure_1.findProjectComponents)(projectDir);
-        projectContainsPublicApp = components.some(c => c.type === Projects_1.ComponentTypes.PublicApp);
-    }
-    catch (err) {
-        (0, errorHandlers_1.debugError)(err);
-    }
-    if (projectContainsPublicApp) {
-        logger_1.logger.error((0, lang_1.i18n)(`commands.project.subcommands.add.error.projectContainsPublicApp`));
-        process.exit(exitCodes_1.EXIT_CODES.ERROR);
-    }
-    logger_1.logger.log('');
-    logger_1.logger.log((0, lang_1.i18n)(`commands.project.subcommands.add.creatingComponent`, {
-        projectName: projectConfig.name,
-    }));
-    logger_1.logger.log('');
-    let latestRepoReleaseTag;
     try {
-        // We want the tag_name from the latest release of the components repo
-        const repoReleaseData = await (0, github_1.fetchReleaseData)(constants_1.HUBSPOT_PROJECT_COMPONENTS_GITHUB_PATH);
-        if (repoReleaseData) {
-            latestRepoReleaseTag = repoReleaseData.tag_name;
+        const { derivedAccountId } = args;
+        const { projectConfig, projectDir } = await getProjectConfig();
+        if (!projectDir || !projectConfig) {
+            uiLogger.error(commands.project.add.error.locationInProject);
+            process.exit(EXIT_CODES.ERROR);
+        }
+        const isV3ProjectCreate = useV3Api(projectConfig.platformVersion);
+        if (isV3ProjectCreate) {
+            await v3AddComponent(args, projectDir, projectConfig, derivedAccountId);
+        }
+        else {
+            await legacyAddComponent(args, projectDir, projectConfig, derivedAccountId);
         }
     }
-    catch (err) {
-        (0, errorHandlers_1.debugError)(err);
-    }
-    if (!latestRepoReleaseTag) {
-        logger_1.logger.error((0, lang_1.i18n)(`commands.project.subcommands.add.error.failedToFetchComponentList`));
-        process.exit(exitCodes_1.EXIT_CODES.ERROR);
-    }
-    const components = await (0, create_1.getProjectComponentListFromRepo)(latestRepoReleaseTag);
-    if (!components.length) {
-        logger_1.logger.error((0, lang_1.i18n)(`commands.project.subcommands.add.error.failedToFetchComponentList`));
-        process.exit(exitCodes_1.EXIT_CODES.ERROR);
-    }
-    const projectAddPromptResponse = await (0, projectAddPrompt_1.projectAddPrompt)(components, args);
-    try {
-        const componentPath = path_1.default.join(projectDir, projectConfig.srcDir, projectAddPromptResponse.componentTemplate.insertPath, projectAddPromptResponse.name);
-        await (0, github_1.cloneGithubRepo)(constants_1.HUBSPOT_PROJECT_COMPONENTS_GITHUB_PATH, componentPath, {
-            sourceDir: projectAddPromptResponse.componentTemplate.path,
-            tag: latestRepoReleaseTag,
-            hideLogs: true,
-        });
-        logger_1.logger.log('');
-        logger_1.logger.success((0, lang_1.i18n)(`commands.project.subcommands.add.success`, {
-            componentName: projectAddPromptResponse.name,
-        }));
-    }
-    catch (error) {
-        (0, errorHandlers_1.debugError)(error);
-        logger_1.logger.error((0, lang_1.i18n)(`commands.project.subcommands.add.error.failedToDownloadComponent`));
-        process.exit(exitCodes_1.EXIT_CODES.ERROR);
+    catch (e) {
+        logError(e);
+        process.exit(EXIT_CODES.ERROR);
     }
-    process.exit(exitCodes_1.EXIT_CODES.SUCCESS);
+    process.exit(EXIT_CODES.SUCCESS);
 }
 function projectAddBuilder(yargs) {
     yargs.options({
         type: {
-            describe: (0, lang_1.i18n)(`commands.project.subcommands.add.options.type.describe`),
+            describe: commands.project.add.options.type.describe,
             type: 'string',
         },
         name: {
-            describe: (0, lang_1.i18n)(`commands.project.subcommands.add.options.name.describe`),
+            describe: commands.project.add.options.name.describe,
+            type: 'string',
+        },
+        distribution: {
+            describe: commands.project.add.options.distribution.describe,
+            type: 'string',
+            choices: [privateDistribution, marketplaceDistribution],
+        },
+        auth: {
+            describe: commands.project.add.options.auth.describe,
             type: 'string',
+            choices: [oAuth, staticAuth],
+        },
+        features: {
+            describe: commands.project.add.options.features.describe,
+            type: 'array',
         },
     });
-    yargs.example([
-        [
-            '$0 project add',
-            (0, lang_1.i18n)(`commands.project.subcommands.add.examples.default`),
-        ],
-    ]);
+    yargs.example([['$0 project add', commands.project.add.examples.default]]);
     yargs.example([
         [
             '$0 project add --name="my-component" --type="components/example-app"',
-            (0, lang_1.i18n)(`commands.project.subcommands.add.examples.withFlags`),
+            commands.project.add.examples.withFlags,
         ],
     ]);
     return yargs;
 }
-const builder = (0, yargsUtils_1.makeYargsBuilder)(projectAddBuilder, command, describe, {
+const builder = makeYargsBuilder(projectAddBuilder, command, describe, {
     useGlobalOptions: true,
 });
 const projectAddCommand = {
@@ -120,4 +75,4 @@ const projectAddCommand = {
     handler,
     builder,
 };
-exports.default = projectAddCommand;
+export default projectAddCommand;

package/commands/project/cloneApp.d.ts

@@ -1,4 +1,4 @@
-import { AccountArgs, CommonArgs, ConfigArgs, EnvironmentArgs, YargsCommandModule } from '../../types/Yargs';
+import { AccountArgs, CommonArgs, ConfigArgs, EnvironmentArgs, YargsCommandModule } from '../../types/Yargs.js';
 type CloneAppArgs = ConfigArgs & EnvironmentArgs & AccountArgs & CommonArgs & {
     dest: string;
     appId: number;

package/commands/project/cloneApp.js

@@ -1,44 +1,39 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = __importDefault(require("path"));
-const fs_1 = __importDefault(require("fs"));
-const usageTracking_1 = require("../../lib/usageTracking");
-const lang_1 = require("../../lib/lang");
-const selectPublicAppForMigrationPrompt_1 = require("../../lib/prompts/selectPublicAppForMigrationPrompt");
-const createProjectPrompt_1 = require("../../lib/prompts/createProjectPrompt");
-const polling_1 = require("../../lib/polling");
-const errorHandlers_1 = require("../../lib/errorHandlers");
-const exitCodes_1 = require("../../lib/enums/exitCodes");
-const accountTypes_1 = require("../../lib/accountTypes");
-const config_1 = require("../../lib/projects/config");
-const constants_1 = require("../../lib/constants");
-const projects_1 = require("@hubspot/local-dev-lib/api/projects");
-const path_2 = require("@hubspot/local-dev-lib/path");
-const logger_1 = require("@hubspot/local-dev-lib/logger");
-const archive_1 = require("@hubspot/local-dev-lib/archive");
-const config_2 = require("@hubspot/local-dev-lib/config");
-const SpinniesManager_1 = __importDefault(require("../../lib/ui/SpinniesManager"));
-const migrate_1 = require("../../lib/app/migrate");
-const yargsUtils_1 = require("../../lib/yargsUtils");
-const ui_1 = require("../../lib/ui");
+import path from 'path';
+import fs from 'fs';
+import { trackCommandUsage, trackCommandMetadataUsage, } from '../../lib/usageTracking.js';
+import { i18n } from '../../lib/lang.js';
+import { selectPublicAppForMigrationPrompt } from '../../lib/prompts/selectPublicAppForMigrationPrompt.js';
+import { projectNameAndDestPrompt } from '../../lib/prompts/projectNameAndDestPrompt.js';
+import { poll } from '../../lib/polling.js';
+import { logError, ApiErrorContext } from '../../lib/errorHandlers/index.js';
+import { EXIT_CODES } from '../../lib/enums/exitCodes.js';
+import { isAppDeveloperAccount, isUnifiedAccount, } from '../../lib/accountTypes.js';
+import { writeProjectConfig } from '../../lib/projects/config.js';
+import { PROJECT_CONFIG_FILE } from '../../lib/constants.js';
+import { cloneApp, checkCloneStatus, downloadClonedProject, } from '@hubspot/local-dev-lib/api/projects';
+import { getCwd, sanitizeFileName } from '@hubspot/local-dev-lib/path';
+import { logger } from '@hubspot/local-dev-lib/logger';
+import { extractZipArchive } from '@hubspot/local-dev-lib/archive';
+import { getAccountConfig } from '@hubspot/local-dev-lib/config';
+import SpinniesManager from '../../lib/ui/SpinniesManager.js';
+import { logInvalidAccountError } from '../../lib/app/migrate.js';
+import { makeYargsBuilder } from '../../lib/yargsUtils.js';
+import { uiDeprecatedTag, uiLine, uiAccountDescription, } from '../../lib/ui/index.js';
 const command = 'clone-app';
-const describe = (0, ui_1.uiDeprecatedTag)((0, lang_1.i18n)(`commands.project.subcommands.cloneApp.describe`), false);
+const describe = uiDeprecatedTag(i18n(`commands.project.subcommands.cloneApp.describe`), false);
 const deprecated = true;
 async function handler(args) {
     const { derivedAccountId } = args;
-    await (0, usageTracking_1.trackCommandUsage)('clone-app', {}, derivedAccountId);
-    const accountConfig = (0, config_2.getAccountConfig)(derivedAccountId);
-    const accountName = (0, ui_1.uiAccountDescription)(derivedAccountId);
+    await trackCommandUsage('clone-app', {}, derivedAccountId);
+    const accountConfig = getAccountConfig(derivedAccountId);
+    const accountName = uiAccountDescription(derivedAccountId);
     if (!accountConfig) {
-        throw new Error((0, lang_1.i18n)(`commands.projects.subcommands.cloneApp.errors.noAccountConfig`));
+        throw new Error(i18n(`commands.projects.subcommands.cloneApp.errors.noAccountConfig`));
     }
-    const defaultAccountIsUnified = await (0, accountTypes_1.isUnifiedAccount)(accountConfig);
-    if (!(0, accountTypes_1.isAppDeveloperAccount)(accountConfig) && !defaultAccountIsUnified) {
-        (0, migrate_1.logInvalidAccountError)();
-        process.exit(exitCodes_1.EXIT_CODES.SUCCESS);
+    const defaultAccountIsUnified = await isUnifiedAccount(accountConfig);
+    if (!isAppDeveloperAccount(accountConfig) && !defaultAccountIsUnified) {
+        logInvalidAccountError();
+        process.exit(EXIT_CODES.SUCCESS);
     }
     let appId;
     let projectName;
@@ -46,68 +41,68 @@ async function handler(args) {
     try {
         appId = args.appId;
         if (!appId) {
-            const appIdResponse = await (0, selectPublicAppForMigrationPrompt_1.selectPublicAppForMigrationPrompt)({
+            const appIdResponse = await selectPublicAppForMigrationPrompt({
                 accountId: derivedAccountId,
                 accountName,
                 isMigratingApp: false,
             });
             appId = appIdResponse.appId;
         }
-        const createProjectPromptResponse = await (0, createProjectPrompt_1.createProjectPrompt)(args);
-        projectName = createProjectPromptResponse.name;
-        projectDest = createProjectPromptResponse.dest;
+        const projectNameAndDestPromptResponse = await projectNameAndDestPrompt(args);
+        projectName = projectNameAndDestPromptResponse.name;
+        projectDest = projectNameAndDestPromptResponse.dest;
     }
     catch (error) {
-        (0, errorHandlers_1.logError)(error, new errorHandlers_1.ApiErrorContext({ accountId: derivedAccountId }));
-        process.exit(exitCodes_1.EXIT_CODES.ERROR);
+        logError(error, new ApiErrorContext({ accountId: derivedAccountId }));
+        process.exit(EXIT_CODES.ERROR);
     }
-    await (0, usageTracking_1.trackCommandMetadataUsage)('clone-app', { step: 'STARTED' }, derivedAccountId);
+    await trackCommandMetadataUsage('clone-app', { step: 'STARTED' }, derivedAccountId);
     try {
-        SpinniesManager_1.default.init();
-        SpinniesManager_1.default.add('cloneApp', {
-            text: (0, lang_1.i18n)(`commands.project.subcommands.cloneApp.cloneStatus.inProgress`),
+        SpinniesManager.init();
+        SpinniesManager.add('cloneApp', {
+            text: i18n(`commands.project.subcommands.cloneApp.cloneStatus.inProgress`),
         });
-        const { data: { exportId }, } = await (0, projects_1.cloneApp)(derivedAccountId, appId);
-        const { status } = await (0, polling_1.poll)(() => (0, projects_1.checkCloneStatus)(derivedAccountId, exportId));
+        const { data: { exportId }, } = await cloneApp(derivedAccountId, appId);
+        const { status } = await poll(() => checkCloneStatus(derivedAccountId, exportId));
         if (status === 'SUCCESS') {
             // Ensure correct project folder structure exists
-            const baseDestPath = path_1.default.resolve((0, path_2.getCwd)(), projectDest);
-            const absoluteDestPath = path_1.default.resolve(baseDestPath, 'src', 'app');
-            fs_1.default.mkdirSync(absoluteDestPath, { recursive: true });
+            const baseDestPath = path.resolve(getCwd(), projectDest);
+            const absoluteDestPath = path.resolve(baseDestPath, 'src', 'app');
+            fs.mkdirSync(absoluteDestPath, { recursive: true });
             // Extract zipped app files and place them in correct directory
-            const { data: zippedApp } = await (0, projects_1.downloadClonedProject)(derivedAccountId, exportId);
-            await (0, archive_1.extractZipArchive)(zippedApp, (0, path_2.sanitizeFileName)(projectName), absoluteDestPath, {
+            const { data: zippedApp } = await downloadClonedProject(derivedAccountId, exportId);
+            await extractZipArchive(zippedApp, sanitizeFileName(projectName), absoluteDestPath, {
                 includesRootDir: true,
                 hideLogs: true,
             });
             // Create hsproject.json file
-            const configPath = path_1.default.join(baseDestPath, constants_1.PROJECT_CONFIG_FILE);
+            const configPath = path.join(baseDestPath, PROJECT_CONFIG_FILE);
             const configContent = {
                 name: projectName,
                 srcDir: 'src',
                 platformVersion: '2023.2',
             };
-            const success = (0, config_1.writeProjectConfig)(configPath, configContent);
-            SpinniesManager_1.default.succeed('cloneApp', {
-                text: (0, lang_1.i18n)(`commands.project.subcommands.cloneApp.cloneStatus.done`),
+            const success = writeProjectConfig(configPath, configContent);
+            SpinniesManager.succeed('cloneApp', {
+                text: i18n(`commands.project.subcommands.cloneApp.cloneStatus.done`),
                 succeedColor: 'white',
             });
             if (!success) {
-                logger_1.logger.error((0, lang_1.i18n)(`commands.project.subcommands.cloneApp.errors.couldNotWriteConfigPath`), configPath);
+                logger.error(i18n(`commands.project.subcommands.cloneApp.errors.couldNotWriteConfigPath`), configPath);
             }
-            logger_1.logger.log('');
-            (0, ui_1.uiLine)();
-            logger_1.logger.success((0, lang_1.i18n)(`commands.project.subcommands.cloneApp.cloneStatus.success`, {
+            logger.log('');
+            uiLine();
+            logger.success(i18n(`commands.project.subcommands.cloneApp.cloneStatus.success`, {
                 dest: projectDest,
             }));
-            logger_1.logger.log('');
-            process.exit(exitCodes_1.EXIT_CODES.SUCCESS);
+            logger.log('');
+            process.exit(EXIT_CODES.SUCCESS);
         }
     }
     catch (error) {
-        await (0, usageTracking_1.trackCommandMetadataUsage)('clone-app', { successful: false }, derivedAccountId);
-        SpinniesManager_1.default.fail('cloneApp', {
-            text: (0, lang_1.i18n)(`commands.project.subcommands.cloneApp.cloneStatus.failure`),
+        await trackCommandMetadataUsage('clone-app', { successful: false }, derivedAccountId);
+        SpinniesManager.fail('cloneApp', {
+            text: i18n(`commands.project.subcommands.cloneApp.cloneStatus.failure`),
             failColor: 'white',
         });
         // Migrations endpoints return a response object with an errors property. The errors property contains an array of errors.
@@ -115,35 +110,35 @@ async function handler(args) {
             typeof error === 'object' &&
             'errors' in error &&
             Array.isArray(error.errors)) {
-            error.errors.forEach(e => (0, errorHandlers_1.logError)(e, new errorHandlers_1.ApiErrorContext({ accountId: derivedAccountId })));
+            error.errors.forEach(e => logError(e, new ApiErrorContext({ accountId: derivedAccountId })));
         }
         else {
-            (0, errorHandlers_1.logError)(error, new errorHandlers_1.ApiErrorContext({ accountId: derivedAccountId }));
+            logError(error, new ApiErrorContext({ accountId: derivedAccountId }));
         }
     }
-    await (0, usageTracking_1.trackCommandMetadataUsage)('clone-app', { successful: true }, derivedAccountId);
-    process.exit(exitCodes_1.EXIT_CODES.SUCCESS);
+    await trackCommandMetadataUsage('clone-app', { successful: true }, derivedAccountId);
+    process.exit(EXIT_CODES.SUCCESS);
 }
 function cloneAppBuilder(yargs) {
     yargs.options({
         dest: {
-            describe: (0, lang_1.i18n)(`commands.project.subcommands.cloneApp.options.dest.describe`),
+            describe: i18n(`commands.project.subcommands.cloneApp.options.dest.describe`),
             type: 'string',
         },
         'app-id': {
-            describe: (0, lang_1.i18n)(`commands.project.subcommands.cloneApp.options.appId.describe`),
+            describe: i18n(`commands.project.subcommands.cloneApp.options.appId.describe`),
             type: 'number',
         },
     });
     yargs.example([
         [
             '$0 project clone-app',
-            (0, lang_1.i18n)(`commands.project.subcommands.cloneApp.examples.default`),
+            i18n(`commands.project.subcommands.cloneApp.examples.default`),
         ],
     ]);
     return yargs;
 }
-const builder = (0, yargsUtils_1.makeYargsBuilder)(cloneAppBuilder, command, describe, {
+const builder = makeYargsBuilder(cloneAppBuilder, command, describe, {
     useGlobalOptions: true,
     useAccountOptions: true,
     useConfigOptions: true,
@@ -156,4 +151,4 @@ const cloneAppCommand = {
     builder,
     deprecated,
 };
-exports.default = cloneAppCommand;
+export default cloneAppCommand;

package/commands/project/create.d.ts

@@ -1,10 +1,4 @@
-import { RepoPath } from '@hubspot/local-dev-lib/types/Github';
-import { AccountArgs, CommonArgs, ConfigArgs, EnvironmentArgs, YargsCommandModule } from '../../types/Yargs';
-type ProjectCreateArgs = CommonArgs & ConfigArgs & AccountArgs & EnvironmentArgs & {
-    name?: string;
-    dest?: string;
-    templateSource?: RepoPath;
-    template?: string;
-};
+import { YargsCommandModule } from '../../types/Yargs.js';
+import { ProjectCreateArgs } from '../../lib/projects/create/index.js';
 declare const projectCreateCommand: YargsCommandModule<unknown, ProjectCreateArgs>;
 export default projectCreateCommand;