@hubspot/cli 8.0.10-experimental.6 → 8.0.10-experimental.7

package/commands/sandbox/delete.js

@@ -0,0 +1,189 @@
+import { uiLogger } from '../../lib/ui/logger.js';
+import { isSpecifiedError } from '@hubspot/local-dev-lib/errors/index';
+import { deleteSandbox } from '@hubspot/local-dev-lib/api/sandboxHubs';
+import { getConfigAccountEnvironment, removeAccountFromConfig, setConfigAccountAsDefault, getAllConfigAccounts, getConfigAccountIfExists, getConfigDefaultAccountIfExists, } from '@hubspot/local-dev-lib/config';
+import { getHubSpotWebsiteOrigin } from '@hubspot/local-dev-lib/urls';
+import { getValidEnv } from '@hubspot/local-dev-lib/environment';
+import { trackCommandUsage } from '../../lib/usageTracking.js';
+import { logError, debugError } from '../../lib/errorHandlers/index.js';
+import { commands } from '../../lang/en.js';
+import { deleteSandboxPrompt } from '../../lib/prompts/sandboxesPrompt.js';
+import { selectAccountFromConfig } from '../../lib/prompts/accountsPrompt.js';
+import { EXIT_CODES } from '../../lib/enums/exitCodes.js';
+import { promptUser } from '../../lib/prompts/promptUtils.js';
+import { uiAuthCommandReference, uiBetaTag } from '../../lib/ui/index.js';
+import { makeYargsBuilder } from '../../lib/yargsUtils.js';
+const command = 'delete';
+const describe = uiBetaTag(commands.sandbox.subcommands.delete.describe, false);
+async function handler(args) {
+    const { userProvidedAccount, derivedAccountId, force } = args;
+    trackCommandUsage('sandbox-delete', {}, derivedAccountId);
+    let accountPrompt;
+    if (!userProvidedAccount) {
+        if (!force) {
+            accountPrompt = await deleteSandboxPrompt();
+        }
+        else {
+            // Account is required, throw error if force flag is present and no account is specified
+            uiLogger.log('');
+            uiLogger.error(commands.sandbox.subcommands.delete.failure.noAccount);
+            process.exit(EXIT_CODES.ERROR);
+        }
+        if (!accountPrompt) {
+            uiLogger.log('');
+            uiLogger.error(commands.sandbox.subcommands.delete.failure.noSandboxAccounts);
+            process.exit(EXIT_CODES.ERROR);
+        }
+    }
+    const accountIdentifier = userProvidedAccount || accountPrompt.account;
+    const sandboxAccount = getConfigAccountIfExists(accountIdentifier);
+    if (!sandboxAccount) {
+        uiLogger.error(commands.sandbox.subcommands.delete.failure.noSandboxAccountId);
+        process.exit(EXIT_CODES.ERROR);
+    }
+    const sandboxAccountId = sandboxAccount.accountId;
+    const defaultAccount = getConfigDefaultAccountIfExists();
+    const isDefaultAccount = sandboxAccountId === defaultAccount?.accountId;
+    const baseUrl = getHubSpotWebsiteOrigin(getValidEnv(getConfigAccountEnvironment(sandboxAccountId)));
+    let parentAccountId;
+    const accountsList = getAllConfigAccounts() || [];
+    for (const portal of accountsList) {
+        if (portal.accountId === sandboxAccountId) {
+            if (portal.parentAccountId) {
+                parentAccountId = portal.parentAccountId;
+            }
+            else if (!force) {
+                const parentAccountPrompt = await deleteSandboxPrompt(true);
+                if (!parentAccountPrompt) {
+                    uiLogger.error(commands.sandbox.subcommands.delete.failure.noParentAccount);
+                    process.exit(EXIT_CODES.ERROR);
+                }
+                const parentAccount = getConfigAccountIfExists(parentAccountPrompt.account);
+                parentAccountId = parentAccount?.accountId;
+            }
+            else {
+                uiLogger.error(commands.sandbox.subcommands.delete.failure.noParentAccount);
+                process.exit(EXIT_CODES.ERROR);
+            }
+        }
+    }
+    const url = `${baseUrl}/sandboxes/${parentAccountId}`;
+    const command = uiAuthCommandReference({
+        accountId: parentAccountId || undefined,
+        qa: getConfigAccountEnvironment(sandboxAccountId) === 'qa',
+    });
+    if (parentAccountId && !getConfigAccountIfExists(parentAccountId)) {
+        uiLogger.log('');
+        uiLogger.error(commands.sandbox.subcommands.delete.failure.noParentPortalAvailable(command, url));
+        uiLogger.log('');
+        process.exit(EXIT_CODES.ERROR);
+    }
+    uiLogger.debug(commands.sandbox.subcommands.delete.debug.deleting(sandboxAccountId));
+    if (isDefaultAccount) {
+        uiLogger.info(commands.sandbox.subcommands.delete.defaultAccountWarning(sandboxAccountId));
+        uiLogger.log('');
+    }
+    try {
+        if (!force) {
+            const { confirmSandboxDeletePrompt: confirmed } = await promptUser([
+                {
+                    name: 'confirmSandboxDeletePrompt',
+                    type: 'confirm',
+                    message: commands.sandbox.subcommands.delete.confirm(sandboxAccountId),
+                },
+            ]);
+            if (!confirmed) {
+                process.exit(EXIT_CODES.SUCCESS);
+            }
+        }
+        await deleteSandbox(parentAccountId, sandboxAccountId);
+        uiLogger.log('');
+        uiLogger.success(isDefaultAccount
+            ? commands.sandbox.subcommands.delete.success.deleteDefault(userProvidedAccount || accountPrompt.account, sandboxAccountId)
+            : commands.sandbox.subcommands.delete.success.delete(userProvidedAccount || accountPrompt.account, sandboxAccountId));
+        uiLogger.log('');
+        removeAccountFromConfig(sandboxAccountId);
+        if (isDefaultAccount && !force) {
+            const newDefaultAccount = await selectAccountFromConfig();
+            setConfigAccountAsDefault(newDefaultAccount);
+        }
+        else if (isDefaultAccount && force) {
+            // If force is specified, skip prompt and set the parent account id as the default account
+            setConfigAccountAsDefault(parentAccountId);
+        }
+        process.exit(EXIT_CODES.SUCCESS);
+    }
+    catch (err) {
+        debugError(err);
+        if (isSpecifiedError(err, { statusCode: 401 })) {
+            // Intercept invalid key error
+            // This command uses the parent portal PAK to delete a sandbox, so we must specify which account needs a new key
+            uiLogger.log('');
+            uiLogger.error(commands.sandbox.subcommands.delete.failure.invalidKey(parentAccountId));
+        }
+        else if (isSpecifiedError(err, {
+            statusCode: 403,
+            category: 'BANNED',
+            subCategory: 'SandboxErrors.USER_ACCESS_NOT_ALLOWED',
+        })) {
+            uiLogger.log('');
+            uiLogger.error(commands.sandbox.subcommands.delete.failure.invalidUser(sandboxAccountId, parentAccountId));
+            uiLogger.log('');
+        }
+        else if (isSpecifiedError(err, {
+            statusCode: 404,
+            category: 'OBJECT_NOT_FOUND',
+            subCategory: 'SandboxErrors.SANDBOX_NOT_FOUND',
+        })) {
+            uiLogger.log('');
+            uiLogger.warn(commands.sandbox.subcommands.delete.failure.objectNotFound(sandboxAccountId));
+            uiLogger.log('');
+            removeAccountFromConfig(sandboxAccountId);
+            if (isDefaultAccount && !force) {
+                const newDefaultAccount = await selectAccountFromConfig();
+                setConfigAccountAsDefault(newDefaultAccount);
+            }
+            else if (isDefaultAccount) {
+                // If force is specified, skip prompt and set the parent account id as the default account
+                setConfigAccountAsDefault(parentAccountId);
+            }
+            process.exit(EXIT_CODES.SUCCESS);
+        }
+        else {
+            logError(err);
+        }
+        process.exit(EXIT_CODES.ERROR);
+    }
+}
+function sandboxDeleteBuilder(yargs) {
+    yargs.option('account', {
+        describe: commands.sandbox.subcommands.delete.options.account.describe,
+        type: 'string',
+    });
+    yargs.option('force', {
+        type: 'boolean',
+        alias: 'f',
+        describe: commands.sandbox.subcommands.delete.options.force.describe,
+    });
+    yargs.example([
+        [
+            '$0 sandbox delete --account=MySandboxAccount',
+            commands.sandbox.subcommands.delete.examples.default,
+        ],
+    ]);
+    return yargs;
+}
+const builder = makeYargsBuilder(sandboxDeleteBuilder, command, describe, {
+    useGlobalOptions: true,
+    useConfigOptions: true,
+    useAccountOptions: true,
+    useEnvironmentOptions: true,
+    useTestingOptions: true,
+});
+const sandboxDeleteCommand = {
+    command,
+    describe,
+    handler,
+    builder,
+};
+export default sandboxDeleteCommand;

package/commands/sandbox.d.ts

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

package/commands/sandbox.js

@@ -0,0 +1,19 @@
+import { commands } from '../lang/en.js';
+import { uiBetaTag } from '../lib/ui/index.js';
+import create from './sandbox/create.js';
+import del from './sandbox/delete.js';
+import { makeYargsBuilder } from '../lib/yargsUtils.js';
+const command = ['sandbox', 'sandboxes'];
+const describe = uiBetaTag(commands.sandbox.describe, false);
+function sandboxBuilder(yargs) {
+    yargs.command(create).command(del).demandCommand(1, '');
+    return yargs;
+}
+const builder = makeYargsBuilder(sandboxBuilder, command, describe);
+const sandboxCommand = {
+    command,
+    describe,
+    builder,
+    handler: () => { },
+};
+export default sandboxCommand;

package/commands/secret/addSecret.d.ts

@@ -0,0 +1,6 @@
+import { CommonArgs, ConfigArgs, AccountArgs, EnvironmentArgs, YargsCommandModule } from '../../types/Yargs.js';
+type AddSecretArgs = CommonArgs & ConfigArgs & AccountArgs & EnvironmentArgs & {
+    name?: string;
+};
+declare const addSecretCommand: YargsCommandModule<unknown, AddSecretArgs>;
+export default addSecretCommand;

package/commands/secret/addSecret.js

@@ -0,0 +1,58 @@
+import { addSecret, fetchSecrets } from '@hubspot/local-dev-lib/api/secrets';
+import { logError, ApiErrorContext } from '../../lib/errorHandlers/index.js';
+import { trackCommandUsage } from '../../lib/usageTracking.js';
+import { secretValuePrompt, secretNamePrompt, } from '../../lib/prompts/secretPrompt.js';
+import { commands } from '../../lang/en.js';
+import { uiLogger } from '../../lib/ui/logger.js';
+import { EXIT_CODES } from '../../lib/enums/exitCodes.js';
+import { makeYargsBuilder } from '../../lib/yargsUtils.js';
+const command = 'add [name]';
+const describe = commands.secret.subcommands.add.describe;
+async function handler(args) {
+    const { name, derivedAccountId } = args;
+    let secretName = name;
+    trackCommandUsage('secrets-add', {}, derivedAccountId);
+    try {
+        if (!secretName) {
+            const { secretName: name } = await secretNamePrompt();
+            secretName = name;
+        }
+        const { data: { results: secrets }, } = await fetchSecrets(derivedAccountId);
+        if (secrets.includes(secretName)) {
+            uiLogger.error(commands.secret.subcommands.add.errors.alreadyExists(secretName));
+            return process.exit(EXIT_CODES.ERROR);
+        }
+        const { secretValue } = await secretValuePrompt();
+        await addSecret(derivedAccountId, secretName, secretValue);
+        uiLogger.success(commands.secret.subcommands.add.success.add(secretName, derivedAccountId));
+    }
+    catch (err) {
+        uiLogger.error(commands.secret.subcommands.add.errors.add(secretName || ''));
+        logError(err, new ApiErrorContext({
+            request: 'add secret',
+            accountId: derivedAccountId,
+        }));
+        return process.exit(EXIT_CODES.ERROR);
+    }
+    process.exit(EXIT_CODES.SUCCESS);
+}
+function addSecretBuilder(yargs) {
+    yargs.positional('name', {
+        describe: commands.secret.subcommands.add.positionals.name.describe,
+        type: 'string',
+    });
+    return yargs;
+}
+const builder = makeYargsBuilder(addSecretBuilder, command, describe, {
+    useGlobalOptions: true,
+    useConfigOptions: true,
+    useAccountOptions: true,
+    useEnvironmentOptions: true,
+});
+const addSecretCommand = {
+    command,
+    describe,
+    handler,
+    builder,
+};
+export default addSecretCommand;

package/commands/secret/deleteSecret.d.ts

@@ -0,0 +1,7 @@
+import { CommonArgs, ConfigArgs, AccountArgs, EnvironmentArgs, YargsCommandModule } from '../../types/Yargs.js';
+type DeleteSecretArgs = CommonArgs & ConfigArgs & AccountArgs & EnvironmentArgs & {
+    name?: string;
+    force?: boolean;
+};
+declare const deleteSecretCommand: YargsCommandModule<unknown, DeleteSecretArgs>;
+export default deleteSecretCommand;

package/commands/secret/deleteSecret.js

@@ -0,0 +1,71 @@
+import { deleteSecret, fetchSecrets } from '@hubspot/local-dev-lib/api/secrets';
+import { secretListPrompt } from '../../lib/prompts/secretPrompt.js';
+import { confirmPrompt } from '../../lib/prompts/promptUtils.js';
+import { EXIT_CODES } from '../../lib/enums/exitCodes.js';
+import { ApiErrorContext, logError } from '../../lib/errorHandlers/index.js';
+import { trackCommandUsage } from '../../lib/usageTracking.js';
+import { commands } from './../../lang/en.js';
+import { uiLogger } from '../../lib/ui/logger.js';
+import { makeYargsBuilder } from '../../lib/yargsUtils.js';
+const command = 'delete [name]';
+const describe = commands.secret.subcommands.delete.describe;
+async function handler(args) {
+    const { name, derivedAccountId, force } = args;
+    let secretName = name;
+    trackCommandUsage('secrets-delete', {}, derivedAccountId);
+    try {
+        const { data: { results: secrets }, } = await fetchSecrets(derivedAccountId);
+        if (secretName && !secrets.includes(secretName)) {
+            uiLogger.error(commands.secret.subcommands.delete.errors.noSecret(secretName));
+            process.exit(EXIT_CODES.ERROR);
+        }
+        if (!secretName) {
+            const { secretToModify } = await secretListPrompt(secrets, commands.secret.subcommands.delete.selectSecret);
+            secretName = secretToModify;
+        }
+        const confirmDelete = force ||
+            (await confirmPrompt(commands.secret.subcommands.delete.confirmDelete(secretName), {
+                defaultAnswer: false,
+            }));
+        if (!confirmDelete) {
+            uiLogger.success(commands.secret.subcommands.delete.deleteCanceled);
+            process.exit(EXIT_CODES.SUCCESS);
+        }
+        await deleteSecret(derivedAccountId, secretName);
+        uiLogger.success(commands.secret.subcommands.delete.success.delete(secretName, derivedAccountId));
+    }
+    catch (err) {
+        if (secretName) {
+            uiLogger.error(commands.secret.subcommands.delete.errors.delete(secretName));
+        }
+        logError(err, new ApiErrorContext({
+            request: 'delete a secret',
+            accountId: derivedAccountId,
+        }));
+    }
+}
+function deleteSecretBuilder(yargs) {
+    yargs
+        .positional('name', {
+        describe: commands.secret.subcommands.delete.positionals.name.describe,
+        type: 'string',
+    })
+        .options('force', {
+        describe: 'Force the deletion',
+        type: 'boolean',
+    });
+    return yargs;
+}
+const builder = makeYargsBuilder(deleteSecretBuilder, command, describe, {
+    useGlobalOptions: true,
+    useConfigOptions: true,
+    useAccountOptions: true,
+    useEnvironmentOptions: true,
+});
+const deleteSecretCommand = {
+    command,
+    describe,
+    handler,
+    builder,
+};
+export default deleteSecretCommand;

package/commands/secret/listSecret.d.ts

@@ -0,0 +1,4 @@
+import { CommonArgs, ConfigArgs, AccountArgs, EnvironmentArgs, YargsCommandModule } from '../../types/Yargs.js';
+type ListSecretArgs = CommonArgs & ConfigArgs & AccountArgs & EnvironmentArgs;
+declare const listSecretCommand: YargsCommandModule<unknown, ListSecretArgs>;
+export default listSecretCommand;

package/commands/secret/listSecret.js

@@ -0,0 +1,43 @@
+import { fetchSecrets } from '@hubspot/local-dev-lib/api/secrets';
+import { logError, ApiErrorContext } from '../../lib/errorHandlers/index.js';
+import { trackCommandUsage } from '../../lib/usageTracking.js';
+import { uiAccountDescription } from '../../lib/ui/index.js';
+import { commands } from '../../lang/en.js';
+import { uiLogger } from '../../lib/ui/logger.js';
+import { makeYargsBuilder } from '../../lib/yargsUtils.js';
+const command = 'list';
+const describe = commands.secret.subcommands.list.describe;
+async function handler(args) {
+    const { derivedAccountId } = args;
+    trackCommandUsage('secrets-list', {}, derivedAccountId);
+    try {
+        const { data: { results }, } = await fetchSecrets(derivedAccountId);
+        const groupLabel = commands.secret.subcommands.list.groupLabel(uiAccountDescription(derivedAccountId));
+        uiLogger.group(groupLabel);
+        results.forEach(secret => uiLogger.log(secret));
+        uiLogger.groupEnd();
+    }
+    catch (err) {
+        uiLogger.error(commands.secret.subcommands.list.errors.list);
+        logError(err, new ApiErrorContext({
+            request: 'add secret',
+            accountId: derivedAccountId,
+        }));
+    }
+}
+function listSecretBuilder(yargs) {
+    return yargs;
+}
+const builder = makeYargsBuilder(listSecretBuilder, command, describe, {
+    useGlobalOptions: true,
+    useConfigOptions: true,
+    useAccountOptions: true,
+    useEnvironmentOptions: true,
+});
+const listSecretCommand = {
+    command,
+    describe,
+    handler,
+    builder,
+};
+export default listSecretCommand;

package/commands/secret/updateSecret.d.ts

@@ -0,0 +1,6 @@
+import { CommonArgs, ConfigArgs, AccountArgs, EnvironmentArgs, YargsCommandModule } from '../../types/Yargs.js';
+type UpdateSecretArgs = CommonArgs & ConfigArgs & AccountArgs & EnvironmentArgs & {
+    name?: string;
+};
+declare const updateSecretCommand: YargsCommandModule<unknown, UpdateSecretArgs>;
+export default updateSecretCommand;

package/commands/secret/updateSecret.js

@@ -0,0 +1,57 @@
+import { updateSecret, fetchSecrets } from '@hubspot/local-dev-lib/api/secrets';
+import { EXIT_CODES } from '../../lib/enums/exitCodes.js';
+import { ApiErrorContext, logError } from '../../lib/errorHandlers/index.js';
+import { trackCommandUsage } from '../../lib/usageTracking.js';
+import { secretValuePrompt, secretListPrompt, } from '../../lib/prompts/secretPrompt.js';
+import { commands } from '../../lang/en.js';
+import { uiLogger } from '../../lib/ui/logger.js';
+import { makeYargsBuilder } from '../../lib/yargsUtils.js';
+const command = 'update [name]';
+const describe = commands.secret.subcommands.update.describe;
+async function handler(args) {
+    const { name, derivedAccountId } = args;
+    let secretName = name;
+    trackCommandUsage('secrets-update', {}, derivedAccountId);
+    try {
+        const { data: { results: secrets }, } = await fetchSecrets(derivedAccountId);
+        if (secretName && !secrets.includes(secretName)) {
+            uiLogger.error(commands.secret.subcommands.update.errors.noSecret(secretName));
+            process.exit(EXIT_CODES.ERROR);
+        }
+        if (!secretName) {
+            const { secretToModify } = await secretListPrompt(secrets, commands.secret.subcommands.update.selectSecret);
+            secretName = secretToModify;
+        }
+        const { secretValue } = await secretValuePrompt();
+        await updateSecret(derivedAccountId, secretName, secretValue);
+        uiLogger.success(commands.secret.subcommands.update.success.update(secretName, derivedAccountId));
+        uiLogger.log(commands.secret.subcommands.update.success.updateExplanation);
+    }
+    catch (err) {
+        uiLogger.error(commands.secret.subcommands.update.errors.update(secretName || ''));
+        logError(err, new ApiErrorContext({
+            request: 'update secret',
+            accountId: derivedAccountId,
+        }));
+    }
+}
+function updateSecretBuilder(yargs) {
+    yargs.positional('name', {
+        describe: commands.secret.subcommands.update.positionals.name.describe,
+        type: 'string',
+    });
+    return yargs;
+}
+const builder = makeYargsBuilder(updateSecretBuilder, command, describe, {
+    useGlobalOptions: true,
+    useConfigOptions: true,
+    useAccountOptions: true,
+    useEnvironmentOptions: true,
+});
+const updateSecretCommand = {
+    command,
+    describe,
+    handler,
+    builder,
+};
+export default updateSecretCommand;

package/commands/secret.d.ts

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

package/commands/secret.js

@@ -0,0 +1,25 @@
+import addSecretCommand from './secret/addSecret.js';
+import listSecretCommand from './secret/listSecret.js';
+import deleteSecretCommand from './secret/deleteSecret.js';
+import updateSecretCommand from './secret/updateSecret.js';
+import { commands } from '../lang/en.js';
+import { makeYargsBuilder } from '../lib/yargsUtils.js';
+const command = ['secret', 'secrets'];
+const describe = commands.secret.describe;
+function secretBuilder(yargs) {
+    yargs
+        .command(listSecretCommand)
+        .command(addSecretCommand)
+        .command(updateSecretCommand)
+        .command(deleteSecretCommand)
+        .demandCommand(1, '');
+    return yargs;
+}
+const builder = makeYargsBuilder(secretBuilder, command, describe);
+const secretCommand = {
+    command,
+    describe,
+    builder,
+    handler: () => { },
+};
+export default secretCommand;

package/commands/testAccount/create.d.ts

@@ -0,0 +1,15 @@
+import { AccountLevel } from '@hubspot/local-dev-lib/types/developerTestAccounts.js';
+import { CommonArgs, ConfigArgs, AccountArgs, TestingArgs, YargsCommandModule, EnvironmentArgs, JSONOutputArgs } from '../../types/Yargs.js';
+type CreateTestAccountArgs = CommonArgs & AccountArgs & ConfigArgs & TestingArgs & EnvironmentArgs & JSONOutputArgs & {
+    configPath?: string;
+    name?: string;
+    description?: string;
+    marketingLevel?: AccountLevel;
+    opsLevel?: AccountLevel;
+    serviceLevel?: AccountLevel;
+    salesLevel?: AccountLevel;
+    contentLevel?: AccountLevel;
+    commerceLevel?: AccountLevel;
+};
+declare const createTestAccountCommand: YargsCommandModule<unknown, CreateTestAccountArgs>;
+export default createTestAccountCommand;