@hubspot/cli 7.1.1 → 7.2.0-beta.0

package/package.json

@@ -1,15 +1,15 @@
 {
     "name": "@hubspot/cli",
-    "version": "7.1.1",
+    "version": "7.2.0-beta.0",
     "description": "The official CLI for developing on HubSpot",
     "license": "Apache-2.0",
     "repository": "https://github.com/HubSpot/hubspot-cli",
     "dependencies": {
-        "@hubspot/local-dev-lib": "3.3.1",
-        "@hubspot/project-parsing-lib": "0.0.4",
+        "@hubspot/local-dev-lib": "3.3.2",
+        "@hubspot/project-parsing-lib": "0.1.1",
         "@hubspot/serverless-dev-runtime": "7.0.2",
         "@hubspot/theme-preview-dev-server": "0.0.10",
-        "@hubspot/ui-extensions-dev-server": "0.8.42",
+        "@hubspot/ui-extensions-dev-server": "0.8.48",
         "archiver": "7.0.1",
         "chalk": "4.1.2",
         "chokidar": "3.6.0",
@@ -32,6 +32,7 @@
     },
     "devDependencies": {
         "@types/archiver": "^6.0.3",
+        "@types/cli-progress": "^3.11.6",
         "@types/express": "^5.0.0",
         "@types/findup-sync": "^4.0.5",
         "@types/fs-extra": "^11.0.4",
@@ -64,7 +65,7 @@
         "lint": "eslint . && prettier --list-different ./**/*.{js,json}",
         "list-all-commands": "yarn ts-node ./scripts/get-all-commands.ts",
         "prettier:write": "prettier --write ./**/*.{ts,js,json}",
-        "test": "jest",
+        "test": "yarn node --experimental-vm-modules $(yarn bin jest)",
         "test-cli": "yarn build && yarn --cwd 'acceptance-tests' test-ci",
         "test-cli-debug": "yarn build && yarn --cwd 'acceptance-tests' test-debug",
         "test-cli-qa": "yarn build && yarn --cwd 'acceptance-tests' test-qa",

package/types/ProjectComponents.d.ts

@@ -0,0 +1,38 @@
+import { IntermediateRepresentationNodeLocalDev } from '@hubspot/project-parsing-lib/src/lib/types';
+import { IR_COMPONENT_TYPES, APP_DISTRIBUTION_TYPES, APP_AUTH_TYPES } from '../lib/constants';
+import { ValueOf } from '@hubspot/local-dev-lib/types/Utils';
+type AppDistributionType = ValueOf<typeof APP_DISTRIBUTION_TYPES>;
+type AppAuthType = ValueOf<typeof APP_AUTH_TYPES>;
+type AppConfig = {
+    description: string;
+    name: string;
+    logo: string;
+    distribution: AppDistributionType;
+    auth: {
+        type: AppAuthType;
+        redirectUrls: string[];
+        requiredScopes: string[];
+        optionalScopes: string[];
+        conditionallyRequiredScopes: string[];
+    };
+};
+type CardConfig = {
+    name: string;
+    description: string;
+    previewImage: {
+        file: string;
+        altText: string;
+    };
+    entrypoint: string;
+    location: string;
+    objectTypes: string[];
+};
+export interface AppIRNode extends IntermediateRepresentationNodeLocalDev {
+    componentType: typeof IR_COMPONENT_TYPES.APPLICATION;
+    config: AppConfig;
+}
+export interface CardIRNode extends IntermediateRepresentationNodeLocalDev {
+    componentType: typeof IR_COMPONENT_TYPES.CARD;
+    config: CardConfig;
+}
+export {};

package/types/ProjectComponents.js

@@ -0,0 +1,3 @@
+"use strict";
+// These types are for Unified Apps and projects on platform version 2025.1 and above
+Object.defineProperty(exports, "__esModule", { value: true });

package/types/Projects.d.ts

@@ -7,8 +7,8 @@ export type ProjectTemplate = {
     insertPath: string;
 };
 export type ComponentTemplate = {
-    label: string;
     path: string;
+    label: string;
     insertPath: string;
 };
 export type ProjectConfig = {
@@ -32,11 +32,6 @@ export type ProjectPollStatusFunctionText = {
     TYPE_KEY: string;
     SUBTASK_NAME_KEY: string;
 };
-export type ProjectAddComponentData = {
-    path: string;
-    label: string;
-    insertPath: string;
-};
 export type ProjectTemplateRepoConfig = {
     projects?: ProjectTemplate[];
     components?: ComponentTemplate[];

package/types/Prompts.d.ts

@@ -1,3 +1,4 @@
+import { DeveloperTestAccount } from '@hubspot/local-dev-lib/types/developerTestAccounts';
 export type GenericPromptResponse = {
     [key: string]: any;
 };
@@ -22,4 +23,10 @@ export type PromptConfig<T extends GenericPromptResponse> = {
     mask?: string;
     filter?: (input: string) => string;
 };
+export type ProjectDevTargetAccountPromptResponse = {
+    targetAccountId: number | null;
+    createNestedAccount: boolean;
+    parentAccountId?: number | null;
+    notInConfigAccount?: DeveloperTestAccount | null;
+};
 export {};

package/types/Sandboxes.d.ts

@@ -1,3 +1,5 @@
+import { HUBSPOT_ACCOUNT_TYPES } from '@hubspot/local-dev-lib/constants/config';
 export type SandboxSyncTask = {
     type: string;
 };
+export type SandboxAccountType = typeof HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX | typeof HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX;

package/types/Yargs.d.ts

@@ -9,6 +9,21 @@ export type ConfigArgs = {
     c?: string;
     config?: string;
 };
+export type AccountArgs = {
+    a?: string;
+    account?: string;
+};
+export type EnvironmentArgs = {
+    'use-env'?: string;
+};
+export type OverwriteArgs = Options & {
+    o?: boolean;
+    overwrite?: boolean;
+};
 export type StringArgType = Options & {
     type: 'string';
 };
+export type ProjectDevArgs = CommonArgs & ConfigArgs & EnvironmentArgs;
+export type TestingArgs = {
+    qa?: boolean;
+};

package/commands/project/dev.d.ts

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

package/commands/project/dev.js

@@ -1,146 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-// @ts-nocheck
-const { addAccountOptions, addConfigOptions, addUseEnvironmentOptions, addTestingOptions, } = require('../../lib/commonOpts');
-const { trackCommandUsage } = require('../../lib/usageTracking');
-const { handleExit } = require('../../lib/process');
-const { i18n } = require('../../lib/lang');
-const { logger } = require('@hubspot/local-dev-lib/logger');
-const { getConfigAccounts, getAccountConfig, getEnv, } = require('@hubspot/local-dev-lib/config');
-const { getProjectConfig, ensureProjectExists, validateProjectConfig, } = require('../../lib/projects');
-const { EXIT_CODES } = require('../../lib/enums/exitCodes');
-const { uiBetaTag, uiCommandReference, uiLink } = require('../../lib/ui');
-const SpinniesManager = require('../../lib/ui/SpinniesManager');
-const LocalDevManager = require('../../lib/LocalDevManager');
-const { isSandbox, isDeveloperTestAccount, isStandardAccount, isAppDeveloperAccount, } = require('../../lib/accountTypes');
-const { getValidEnv } = require('@hubspot/local-dev-lib/environment');
-const { ComponentTypes } = require('../../types/Projects');
-const { findProjectComponents, getProjectComponentTypes, } = require('../../lib/projects/structure');
-const { confirmDefaultAccountIsTarget, suggestRecommendedNestedAccount, checkIfDefaultAccountIsSupported, createSandboxForLocalDev, createDeveloperTestAccountForLocalDev, createNewProjectForLocalDev, createInitialBuildForNewProject, useExistingDevTestAccount, checkIfAccountFlagIsSupported, checkIfParentAccountIsAuthed, } = require('../../lib/localDev');
-const i18nKey = 'commands.project.subcommands.dev';
-exports.command = 'dev';
-exports.describe = uiBetaTag(i18n(`${i18nKey}.describe`), false);
-exports.handler = async (options) => {
-    const { derivedAccountId, providedAccountId } = options;
-    const accountConfig = getAccountConfig(derivedAccountId);
-    const env = getValidEnv(getEnv(derivedAccountId));
-    trackCommandUsage('project-dev', null, derivedAccountId);
-    const { projectConfig, projectDir } = await getProjectConfig();
-    uiBetaTag(i18n(`${i18nKey}.logs.betaMessage`));
-    logger.log(uiLink(i18n(`${i18nKey}.logs.learnMoreLocalDevServer`), 'https://developers.hubspot.com/docs/platform/project-cli-commands#start-a-local-development-server'));
-    if (!projectConfig) {
-        logger.error(i18n(`${i18nKey}.errors.noProjectConfig`));
-        process.exit(EXIT_CODES.ERROR);
-    }
-    validateProjectConfig(projectConfig, projectDir);
-    const components = await findProjectComponents(projectDir);
-    const runnableComponents = components.filter(component => component.runnable);
-    const componentTypes = getProjectComponentTypes(runnableComponents);
-    const hasPrivateApps = !!componentTypes[ComponentTypes.PrivateApp];
-    const hasPublicApps = !!componentTypes[ComponentTypes.PublicApp];
-    if (runnableComponents.length === 0) {
-        logger.error(i18n(`${i18nKey}.errors.noRunnableComponents`, {
-            projectDir,
-            command: uiCommandReference('hs project add'),
-        }));
-        process.exit(EXIT_CODES.SUCCESS);
-    }
-    else if (hasPrivateApps && hasPublicApps) {
-        logger.error(i18n(`${i18nKey}.errors.invalidProjectComponents`));
-        process.exit(EXIT_CODES.SUCCESS);
-    }
-    const accounts = getConfigAccounts();
-    const defaultAccountIsRecommendedType = isDeveloperTestAccount(accountConfig) ||
-        (!hasPublicApps && isSandbox(accountConfig));
-    // targetProjectAccountId and targetTestingAccountId are set to null if --account flag is not provided.
-    // By setting them to null, we can later check if they need to be assigned based on the default account configuration and the type of app.
-    let targetProjectAccountId = providedAccountId ? derivedAccountId : null;
-    // The account that we are locally testing against
-    let targetTestingAccountId = providedAccountId ? derivedAccountId : null;
-    // Check that the default account or flag option is valid for the type of app in this project
-    if (providedAccountId) {
-        checkIfAccountFlagIsSupported(accountConfig, hasPublicApps);
-        if (hasPublicApps) {
-            targetProjectAccountId = accountConfig.parentAccountId;
-        }
-    }
-    else {
-        checkIfDefaultAccountIsSupported(accountConfig, hasPublicApps);
-    }
-    // The user is targeting an account type that we recommend developing on
-    if (!targetProjectAccountId && defaultAccountIsRecommendedType) {
-        targetTestingAccountId = derivedAccountId;
-        await confirmDefaultAccountIsTarget(accountConfig, hasPublicApps);
-        if (hasPublicApps) {
-            checkIfParentAccountIsAuthed(accountConfig);
-            targetProjectAccountId = accountConfig.parentAccountId;
-        }
-        else {
-            targetProjectAccountId = derivedAccountId;
-        }
-    }
-    let createNewSandbox = false;
-    let createNewDeveloperTestAccount = false;
-    if (!targetProjectAccountId) {
-        const { targetAccountId, parentAccountId, createNestedAccount, notInConfigAccount, } = await suggestRecommendedNestedAccount(accounts, accountConfig, hasPublicApps);
-        targetProjectAccountId = hasPublicApps ? parentAccountId : targetAccountId;
-        targetTestingAccountId = targetAccountId;
-        // Only used for developer test accounts that are not yet in the config
-        if (notInConfigAccount) {
-            await useExistingDevTestAccount(env, notInConfigAccount);
-        }
-        createNewSandbox = isStandardAccount(accountConfig) && createNestedAccount;
-        createNewDeveloperTestAccount =
-            isAppDeveloperAccount(accountConfig) && createNestedAccount;
-    }
-    if (createNewSandbox) {
-        targetProjectAccountId = await createSandboxForLocalDev(derivedAccountId, accountConfig, env);
-        // We will be running our tests against this new sandbox account
-        targetTestingAccountId = targetProjectAccountId;
-    }
-    if (createNewDeveloperTestAccount) {
-        targetTestingAccountId = await createDeveloperTestAccountForLocalDev(derivedAccountId, accountConfig, env);
-        targetProjectAccountId = derivedAccountId;
-    }
-    // eslint-disable-next-line prefer-const
-    let { projectExists, project } = await ensureProjectExists(targetProjectAccountId, projectConfig.name, {
-        allowCreate: false,
-        noLogs: true,
-        withPolling: createNewSandbox,
-    });
-    let deployedBuild;
-    let isGithubLinked;
-    SpinniesManager.init();
-    if (projectExists) {
-        deployedBuild = project.deployedBuild;
-        isGithubLinked =
-            project.sourceIntegration &&
-                project.sourceIntegration.source === 'GITHUB';
-    }
-    else {
-        project = await createNewProjectForLocalDev(projectConfig, targetProjectAccountId, createNewSandbox, hasPublicApps);
-        deployedBuild = await createInitialBuildForNewProject(projectConfig, projectDir, targetProjectAccountId);
-    }
-    const LocalDev = new LocalDevManager({
-        runnableComponents,
-        debug: options.debug,
-        deployedBuild,
-        isGithubLinked,
-        parentAccountId: targetProjectAccountId,
-        projectConfig,
-        projectDir,
-        projectId: project.id,
-        targetAccountId: targetTestingAccountId,
-        env,
-    });
-    await LocalDev.start();
-    handleExit(({ isSIGHUP }) => LocalDev.stop(!isSIGHUP));
-};
-exports.builder = yargs => {
-    addConfigOptions(yargs);
-    addAccountOptions(yargs);
-    addUseEnvironmentOptions(yargs);
-    addTestingOptions(yargs);
-    yargs.example([['$0 project dev', i18n(`${i18nKey}.examples.default`)]]);
-    return yargs;
-};

package/commands/secret/listSecrets.d.ts

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

package/commands/secret/listSecrets.js

@@ -1,39 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-// @ts-nocheck
-const { logger } = require('@hubspot/local-dev-lib/logger');
-const { logError, ApiErrorContext } = require('../../lib/errorHandlers/index');
-const { fetchSecrets } = require('@hubspot/local-dev-lib/api/secrets');
-const { trackCommandUsage } = require('../../lib/usageTracking');
-const { uiAccountDescription } = require('../../lib/ui');
-const { addConfigOptions, addAccountOptions, addUseEnvironmentOptions, } = require('../../lib/commonOpts');
-const { i18n } = require('../../lib/lang');
-const i18nKey = 'commands.secret.subcommands.list';
-exports.command = 'list';
-exports.describe = i18n(`${i18nKey}.describe`);
-exports.handler = async (options) => {
-    const { derivedAccountId } = options;
-    trackCommandUsage('secrets-list', null, derivedAccountId);
-    try {
-        const { data: { results }, } = await fetchSecrets(derivedAccountId);
-        const groupLabel = i18n(`${i18nKey}.groupLabel`, {
-            accountIdentifier: uiAccountDescription(derivedAccountId),
-        });
-        logger.group(groupLabel);
-        results.forEach(secret => logger.log(secret));
-        logger.groupEnd(groupLabel);
-    }
-    catch (err) {
-        logger.error(i18n(`${i18nKey}.errors.list`));
-        logError(err, new ApiErrorContext({
-            request: 'add secret',
-            accountId: derivedAccountId,
-        }));
-    }
-};
-exports.builder = yargs => {
-    addConfigOptions(yargs);
-    addAccountOptions(yargs);
-    addUseEnvironmentOptions(yargs);
-    return yargs;
-};