@hubspot/cli 7.7.0-experimental.2 → 7.7.0

package/commands/project.js

@@ -1,57 +1,49 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const lang_1 = require("../lib/lang");
-const ui_1 = require("../lib/ui");
-const deploy_1 = __importDefault(require("./project/deploy"));
-const create_1 = __importDefault(require("./project/create"));
-const upload_1 = __importDefault(require("./project/upload"));
-const listBuilds_1 = __importDefault(require("./project/listBuilds"));
-const logs_1 = __importDefault(require("./project/logs"));
-const watch_1 = __importDefault(require("./project/watch"));
-const download_1 = __importDefault(require("./project/download"));
-const open_1 = __importDefault(require("./project/open"));
-const dev_1 = __importDefault(require("./project/dev"));
-const add_1 = __importDefault(require("./project/add"));
-const migrate_1 = __importDefault(require("./project/migrate"));
-const migrateApp_1 = __importDefault(require("./project/migrateApp"));
-const cloneApp_1 = __importDefault(require("./project/cloneApp"));
-const installDeps_1 = __importDefault(require("./project/installDeps"));
-const profile_1 = __importDefault(require("./project/profile"));
-const validate_1 = __importDefault(require("./project/validate"));
-const yargsUtils_1 = require("../lib/yargsUtils");
+import { i18n } from '../lib/lang.js';
+import deploy from './project/deploy.js';
+import create from './project/create.js';
+import upload from './project/upload.js';
+import listBuilds from './project/listBuilds.js';
+import logs from './project/logs.js';
+import watch from './project/watch.js';
+import download from './project/download.js';
+import open from './project/open.js';
+import dev from './project/dev/index.js';
+import add from './project/add.js';
+import migrate from './project/migrate.js';
+import migrateApp from './project/migrateApp.js';
+import cloneApp from './project/cloneApp.js';
+import installDeps from './project/installDeps.js';
+import profile from './project/profile.js';
+import projectValidate from './project/validate.js';
+import { makeYargsBuilder } from '../lib/yargsUtils.js';
 const command = ['project', 'projects'];
-const describe = (0, ui_1.uiBetaTag)((0, lang_1.i18n)(`commands.project.describe`), false);
+const describe = i18n(`commands.project.describe`);
 function projectBuilder(yargs) {
     yargs
-        .command(create_1.default)
-        .command(add_1.default)
-        .command(watch_1.default)
-        .command(dev_1.default)
-        .command(upload_1.default)
-        .command(deploy_1.default)
-        .command(logs_1.default)
-        .command(listBuilds_1.default)
-        .command(download_1.default)
-        .command(open_1.default)
-        .command(migrateApp_1.default)
-        .command(migrate_1.default)
-        .command(cloneApp_1.default)
-        .command(installDeps_1.default)
-        .command(profile_1.default)
-        .command(validate_1.default)
+        .command(create)
+        .command(add)
+        .command(watch)
+        .command(dev)
+        .command(upload)
+        .command(deploy)
+        .command(logs)
+        .command(listBuilds)
+        .command(download)
+        .command(open)
+        .command(migrateApp)
+        .command(migrate)
+        .command(cloneApp)
+        .command(installDeps)
+        .command(profile)
+        .command(projectValidate)
         .demandCommand(1, '');
     return yargs;
 }
-const builder = (0, yargsUtils_1.makeYargsBuilder)(projectBuilder, command, describe);
+const builder = makeYargsBuilder(projectBuilder, command, describe);
 const projectCommand = {
     command,
     describe,
     builder,
     handler: () => { },
 };
-exports.default = projectCommand;
-// TODO Remove this legacy export once we've migrated all commands to TS
-module.exports = projectCommand;
+export default projectCommand;

package/commands/remove.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 RemoveArgs = CommonArgs & ConfigArgs & EnvironmentArgs & AccountArgs & {
     path: string;
 };

package/commands/remove.js

@@ -1,29 +1,21 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const fileMapper_1 = require("@hubspot/local-dev-lib/api/fileMapper");
-const logger_1 = require("@hubspot/local-dev-lib/logger");
-const index_1 = require("../lib/errorHandlers/index");
-const usageTracking_1 = require("../lib/usageTracking");
-const lang_1 = require("../lib/lang");
-const yargsUtils_1 = require("../lib/yargsUtils");
+import { deleteFile } from '@hubspot/local-dev-lib/api/fileMapper';
+import { logError, ApiErrorContext } from '../lib/errorHandlers/index.js';
+import { trackCommandUsage } from '../lib/usageTracking.js';
+import { commands } from '../lang/en.js';
+import { makeYargsBuilder } from '../lib/yargsUtils.js';
+import { uiLogger } from '../lib/ui/logger.js';
 const command = 'remove <path>';
-const describe = (0, lang_1.i18n)(`commands.remove.describe`);
+const describe = commands.remove.describe;
 async function handler(args) {
     const { path: hsPath, derivedAccountId } = args;
-    (0, usageTracking_1.trackCommandUsage)('remove', undefined, derivedAccountId);
+    trackCommandUsage('remove', undefined, derivedAccountId);
     try {
-        await (0, fileMapper_1.deleteFile)(derivedAccountId, hsPath);
-        logger_1.logger.log((0, lang_1.i18n)(`commands.remove.deleted`, {
-            accountId: derivedAccountId,
-            path: hsPath,
-        }));
+        await deleteFile(derivedAccountId, hsPath);
+        uiLogger.log(commands.remove.deleted(hsPath, derivedAccountId));
     }
     catch (error) {
-        logger_1.logger.error((0, lang_1.i18n)(`commands.remove.errors.deleteFailed`, {
-            accountId: derivedAccountId,
-            path: hsPath,
-        }));
-        (0, index_1.logError)(error, new index_1.ApiErrorContext({
+        uiLogger.error(commands.remove.errors.deleteFailed(hsPath, derivedAccountId));
+        logError(error, new ApiErrorContext({
             accountId: derivedAccountId,
             request: hsPath,
         }));
@@ -31,12 +23,12 @@ async function handler(args) {
 }
 function cmsRemoveBuilder(yargs) {
     yargs.positional('path', {
-        describe: (0, lang_1.i18n)(`commands.remove.positionals.path.describe`),
+        describe: commands.remove.positionals.path,
         type: 'string',
     });
     return yargs;
 }
-const builder = (0, yargsUtils_1.makeYargsBuilder)(cmsRemoveBuilder, command, describe, {
+const builder = makeYargsBuilder(cmsRemoveBuilder, command, describe, {
     useGlobalOptions: true,
     useConfigOptions: true,
     useAccountOptions: true,
@@ -48,6 +40,4 @@ const cmsRemoveCommand = {
     handler,
     builder,
 };
-exports.default = cmsRemoveCommand;
-// TODO Remove this legacy export once we've migrated all commands to TS
-module.exports = cmsRemoveCommand;
+export default cmsRemoveCommand;

package/commands/sandbox/__tests__/create.test.d.ts

@@ -0,0 +1 @@
+export {};

package/commands/sandbox/__tests__/create.test.js

@@ -0,0 +1,238 @@
+import yargs from 'yargs';
+import { addAccountOptions, addConfigOptions, addUseEnvironmentOptions, addTestingOptions, } from '../../../lib/commonOpts.js';
+import sandboxCreateCommand from '../create.js';
+import { hasFeature } from '../../../lib/hasFeature.js';
+import * as sandboxPrompts from '../../../lib/prompts/sandboxesPrompt.js';
+import * as accountNamePrompt from '../../../lib/prompts/accountNamePrompt.js';
+import * as configUtils from '@hubspot/local-dev-lib/config';
+import * as promptUtils from '../../../lib/prompts/promptUtils.js';
+import { trackCommandUsage } from '../../../lib/usageTracking.js';
+import { HUBSPOT_ACCOUNT_TYPES } from '@hubspot/local-dev-lib/constants/config';
+import * as buildAccount from '../../../lib/buildAccount.js';
+import { EXIT_CODES } from '../../../lib/enums/exitCodes.js';
+import { logger } from '@hubspot/local-dev-lib/logger';
+import * as sandboxesLib from '../../../lib/sandboxes.js';
+import * as sandboxSync from '../../../lib/sandboxSync.js';
+import { vi } from 'vitest';
+vi.mock('@hubspot/local-dev-lib/logger');
+vi.mock('@hubspot/local-dev-lib/config');
+vi.mock('../../../lib/commonOpts');
+vi.mock('../../../lib/hasFeature');
+vi.mock('../../../lib/prompts/sandboxesPrompt');
+vi.mock('../../../lib/prompts/promptUtils');
+vi.mock('../../../lib/prompts/accountNamePrompt');
+vi.mock('../../../lib/sandboxes');
+vi.mock('../../../lib/usageTracking');
+vi.mock('../../../lib/buildAccount');
+vi.mock('../../../lib/sandboxes');
+vi.mock('../../../lib/commonOpts');
+const getAccountConfigSpy = vi.spyOn(configUtils, 'getAccountConfig');
+const promptUserSpy = vi.spyOn(promptUtils, 'promptUser');
+const sandboxTypePromptSpy = vi.spyOn(sandboxPrompts, 'sandboxTypePrompt');
+const processExitSpy = vi.spyOn(process, 'exit');
+const buildSandboxSpy = vi.spyOn(buildAccount, 'buildSandbox');
+const buildV2SandboxSpy = vi.spyOn(buildAccount, 'buildV2Sandbox');
+const getAvailableSyncTypesSpy = vi.spyOn(sandboxesLib, 'getAvailableSyncTypes');
+const syncSandboxSpy = vi.spyOn(sandboxSync, 'syncSandbox');
+const validateSandboxUsageLimitsSpy = vi.spyOn(sandboxesLib, 'validateSandboxUsageLimits');
+const hubspotAccountNamePromptSpy = vi.spyOn(accountNamePrompt, 'hubspotAccountNamePrompt');
+const mockedHasFeatureV2Sandboxes = hasFeature;
+const mockedHasFeatureV2Cli = hasFeature;
+describe('commands/sandbox/create', () => {
+    const yargsMock = yargs;
+    describe('command', () => {
+        it('should have the correct command structure', () => {
+            expect(sandboxCreateCommand.command).toEqual('create');
+        });
+    });
+    describe('describe', () => {
+        it('should provide a description', () => {
+            expect(sandboxCreateCommand.describe).toBeDefined();
+        });
+    });
+    describe('builder', () => {
+        it('should support the correct options', () => {
+            sandboxCreateCommand.builder(yargsMock);
+            expect(yargsMock.example).toHaveBeenCalledTimes(1);
+            expect(addTestingOptions).toHaveBeenCalledTimes(1);
+            expect(addTestingOptions).toHaveBeenCalledWith(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);
+        });
+    });
+    describe('handler', () => {
+        let args;
+        const sandboxNameFromPrompt = 'sandbox name from prompt';
+        const mockSandbox = {
+            sandboxHubId: 56789,
+            parentHubId: 123456,
+            createdAt: '2025-01-01',
+            type: 'DEVELOPER',
+            archived: false,
+            version: 'V1',
+            status: 'PENDING',
+            name: 'Test Sandbox',
+            domain: 'test-sandbox.hubspot.com',
+            createdByUser: {
+                userId: 11111,
+                email: 'test@test.com',
+                firstName: 'Test',
+                lastName: 'User',
+            },
+        };
+        beforeEach(() => {
+            args = {
+                derivedAccountId: 1234567890,
+            };
+            getAccountConfigSpy.mockReturnValue({
+                accountType: HUBSPOT_ACCOUNT_TYPES.STANDARD,
+                env: 'prod',
+            });
+            hubspotAccountNamePromptSpy.mockResolvedValue({
+                name: sandboxNameFromPrompt,
+            });
+            sandboxTypePromptSpy.mockResolvedValue({
+                type: HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX,
+            });
+            promptUserSpy.mockResolvedValue({
+                contactRecordsSyncPrompt: false,
+            });
+            validateSandboxUsageLimitsSpy.mockResolvedValue(undefined);
+            mockedHasFeatureV2Sandboxes.mockResolvedValue(false);
+            mockedHasFeatureV2Cli.mockResolvedValue(false);
+            buildSandboxSpy.mockResolvedValue({
+                sandbox: mockSandbox,
+                personalAccessKey: 'mock-personal-access-key',
+                name: sandboxNameFromPrompt,
+            });
+            buildV2SandboxSpy.mockResolvedValue({
+                sandbox: { ...mockSandbox, version: 'V2' },
+            });
+            getAvailableSyncTypesSpy.mockResolvedValue([
+                { type: 'object-schemas' },
+                { type: 'workflows' },
+            ]);
+            syncSandboxSpy.mockResolvedValue(undefined);
+            // Spy on process.exit so our tests don't close when it's called
+            // @ts-expect-error Doesn't match the actual signature because then the linter complains about unused variables
+            processExitSpy.mockImplementation(() => { });
+        });
+        it('should load the account config for the correct account id', async () => {
+            await sandboxCreateCommand.handler(args);
+            expect(getAccountConfigSpy).toHaveBeenCalledTimes(2); // 1st is for parent account, 2nd is for sandbox account
+            expect(getAccountConfigSpy).toHaveBeenCalledWith(args.derivedAccountId);
+        });
+        it('should track the command usage', async () => {
+            await sandboxCreateCommand.handler(args);
+            expect(trackCommandUsage).toHaveBeenCalledTimes(1);
+            expect(trackCommandUsage).toHaveBeenCalledWith('sandbox-create', {}, args.derivedAccountId);
+        });
+        it('should validate sandbox usage limits', async () => {
+            await sandboxCreateCommand.handler(args);
+            expect(validateSandboxUsageLimitsSpy).toHaveBeenCalledTimes(1);
+            expect(validateSandboxUsageLimitsSpy).toHaveBeenCalledWith({
+                accountType: HUBSPOT_ACCOUNT_TYPES.STANDARD,
+                env: 'prod',
+            }, HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX, 'prod');
+        });
+        it('should prompt for the sandbox type if no type is provided in options', async () => {
+            await sandboxCreateCommand.handler(args);
+            expect(sandboxTypePromptSpy).toHaveBeenCalledTimes(1);
+        });
+        it('should not prompt for the sandbox type if type is provided in options', async () => {
+            await sandboxCreateCommand.handler({
+                ...args,
+                type: 'developer',
+            });
+            expect(sandboxTypePromptSpy).toHaveBeenCalledTimes(0);
+        });
+        it('should not prompt for contact records sync if the sandbox type is developer', async () => {
+            await sandboxCreateCommand.handler({
+                ...args,
+                type: 'developer',
+            });
+            expect(promptUserSpy).toHaveBeenCalledTimes(0);
+        });
+        it('should prompt for the contact records sync if the sandbox type is standard', async () => {
+            await sandboxCreateCommand.handler({
+                ...args,
+                type: 'standard',
+            });
+            expect(promptUserSpy).toHaveBeenCalledTimes(1);
+        });
+        it('should build a v1 sandbox if the parent account is not ungated for sandboxes:v2:enabled and not ungated for sandboxes:v2:cliEnabled', async () => {
+            await sandboxCreateCommand.handler(args);
+            expect(buildSandboxSpy).toHaveBeenCalledTimes(1);
+            expect(buildSandboxSpy).toHaveBeenCalledWith(sandboxNameFromPrompt, {
+                accountType: HUBSPOT_ACCOUNT_TYPES.STANDARD,
+                env: 'prod',
+            }, HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX, 'prod', undefined // force
+            );
+            expect(getAvailableSyncTypesSpy).toHaveBeenCalledTimes(1);
+            expect(syncSandboxSpy).toHaveBeenCalledTimes(1);
+        });
+        it('should build a v1 sandbox if the parent account is ungated for sandboxes:v2:enabled but not ungated for sandboxes:v2:cliEnabled', async () => {
+            mockedHasFeatureV2Sandboxes.mockResolvedValue(true);
+            mockedHasFeatureV2Cli.mockResolvedValue(false);
+            await sandboxCreateCommand.handler(args);
+            expect(buildSandboxSpy).toHaveBeenCalledTimes(1);
+            expect(buildSandboxSpy).toHaveBeenCalledWith(sandboxNameFromPrompt, {
+                accountType: HUBSPOT_ACCOUNT_TYPES.STANDARD,
+                env: 'prod',
+            }, HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX, 'prod', undefined // force
+            );
+            expect(getAvailableSyncTypesSpy).toHaveBeenCalledTimes(1);
+            expect(syncSandboxSpy).toHaveBeenCalledTimes(1);
+        });
+        it('should build a v2 sandbox if the parent account is ungated for both sandboxes:v2:enabled and sandboxes:v2:cliEnabled', async () => {
+            mockedHasFeatureV2Sandboxes.mockResolvedValue(true);
+            mockedHasFeatureV2Cli.mockResolvedValue(true);
+            await sandboxCreateCommand.handler(args);
+            expect(buildV2SandboxSpy).toHaveBeenCalledTimes(1);
+            expect(buildV2SandboxSpy).toHaveBeenCalledWith(sandboxNameFromPrompt, {
+                accountType: HUBSPOT_ACCOUNT_TYPES.STANDARD,
+                env: 'prod',
+            }, HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX, false, // syncObjectRecords
+            'prod', undefined // force
+            );
+        });
+        it('should log an error and exit when force is used and invalid sandbox type is provided', async () => {
+            await sandboxCreateCommand.handler({
+                ...args,
+                name: sandboxNameFromPrompt,
+                type: 'invalid',
+                force: true,
+            });
+            expect(logger.error).toHaveBeenCalledTimes(1);
+            expect(processExitSpy).toHaveBeenCalled();
+            expect(processExitSpy).toHaveBeenCalledWith(EXIT_CODES.ERROR);
+        });
+        it('should log an error and exit when force is used and no sandbox name is provided', async () => {
+            await sandboxCreateCommand.handler({
+                ...args,
+                type: 'standard',
+                force: true,
+            });
+            expect(logger.error).toHaveBeenCalled();
+            expect(processExitSpy).toHaveBeenCalled();
+            expect(processExitSpy).toHaveBeenCalledWith(EXIT_CODES.ERROR);
+        });
+        it('should error out if the default account type is not standard', async () => {
+            getAccountConfigSpy.mockReturnValue({
+                accountType: HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX,
+                env: 'prod',
+            });
+            await sandboxCreateCommand.handler({
+                ...args,
+                type: 'developer',
+            });
+            expect(logger.error).toHaveBeenCalled();
+            expect(processExitSpy).toHaveBeenCalled();
+            expect(processExitSpy).toHaveBeenCalledWith(EXIT_CODES.ERROR);
+        });
+    });
+});

package/commands/sandbox/__tests__/delete.test.d.ts

@@ -0,0 +1 @@
+export {};

package/commands/sandbox/__tests__/delete.test.js

@@ -0,0 +1,31 @@
+import yargs from 'yargs';
+import { addAccountOptions, addConfigOptions, addUseEnvironmentOptions, addTestingOptions, } from '../../../lib/commonOpts.js';
+import sandboxDeleteCommand from '../delete.js';
+vi.mock('../../../lib/commonOpts');
+describe('commands/sandbox/delete', () => {
+    const yargsMock = yargs;
+    describe('command', () => {
+        it('should have the correct command structure', () => {
+            expect(sandboxDeleteCommand.command).toEqual('delete');
+        });
+    });
+    describe('describe', () => {
+        it('should provide a description', () => {
+            expect(sandboxDeleteCommand.describe).toBeDefined();
+        });
+    });
+    describe('builder', () => {
+        it('should support the correct options', () => {
+            sandboxDeleteCommand.builder(yargsMock);
+            expect(yargsMock.example).toHaveBeenCalledTimes(1);
+            expect(addTestingOptions).toHaveBeenCalledTimes(1);
+            expect(addTestingOptions).toHaveBeenCalledWith(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);
+        });
+    });
+});

package/commands/sandbox/create.d.ts

@@ -1,5 +1,5 @@
-import { CommonArgs, ConfigArgs, AccountArgs, EnvironmentArgs, TestingArgs, YargsCommandModule } from '../../types/Yargs';
-type SandboxCreateArgs = CommonArgs & ConfigArgs & AccountArgs & EnvironmentArgs & TestingArgs & {
+import { CommonArgs, ConfigArgs, AccountArgs, EnvironmentArgs, TestingArgs, YargsCommandModule } from '../../types/Yargs.js';
+export type SandboxCreateArgs = CommonArgs & ConfigArgs & AccountArgs & EnvironmentArgs & TestingArgs & {
     name?: string;
     force?: boolean;
     type?: string;