@hubspot/cli 7.8.10-experimental.0 → 7.8.12-experimental.0

package/commands/app/__tests__/install.test.d.ts

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

package/commands/app/__tests__/install.test.js

@@ -0,0 +1,47 @@
+import yargs from 'yargs';
+import { addAccountOptions, addConfigOptions, addUseEnvironmentOptions, addGlobalOptions, addJSONOutputOptions, } from '../../../lib/commonOpts.js';
+import installCommand from '../install.js';
+vi.mock('../../../lib/commonOpts');
+describe('commands/app/install', () => {
+    const yargsMock = yargs;
+    describe('command', () => {
+        it('should have the correct command structure', () => {
+            expect(installCommand.command).toEqual('install <test-account-id>');
+        });
+    });
+    describe('describe', () => {
+        it('should provide a description', () => {
+            expect(installCommand.describe).not.toBeDefined();
+        });
+    });
+    describe('builder', () => {
+        it('should support the correct options', () => {
+            installCommand.builder(yargsMock);
+            expect(addGlobalOptions).toHaveBeenCalledTimes(1);
+            expect(addGlobalOptions).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);
+            expect(addJSONOutputOptions).toHaveBeenCalledTimes(1);
+            expect(addJSONOutputOptions).toHaveBeenCalledWith(yargsMock);
+            expect(yargsMock.positional).toHaveBeenCalledTimes(1);
+            expect(yargsMock.positional).toHaveBeenCalledWith('test-account-id', expect.objectContaining({
+                type: 'number',
+                required: true,
+                describe: expect.any(String),
+            }));
+            expect(yargsMock.option).toHaveBeenCalledTimes(2);
+            expect(yargsMock.option).toHaveBeenCalledWith('app-uid', expect.objectContaining({
+                type: 'string',
+                describe: expect.any(String),
+            }));
+            expect(yargsMock.option).toHaveBeenCalledWith('project-name', expect.objectContaining({
+                type: 'string',
+                describe: expect.any(String),
+            }));
+        });
+    });
+});

package/commands/app/install.d.ts

@@ -0,0 +1,8 @@
+import { CommonArgs, ConfigArgs, AccountArgs, EnvironmentArgs, YargsCommandModule, JSONOutputArgs } from '../../types/Yargs.js';
+type InstallAppArgs = CommonArgs & ConfigArgs & AccountArgs & EnvironmentArgs & JSONOutputArgs & {
+    appUid?: string;
+    projectName?: string;
+    testAccountId: number;
+};
+declare const installAppCommand: YargsCommandModule<unknown, InstallAppArgs>;
+export default installAppCommand;

package/commands/app/install.js

@@ -0,0 +1,122 @@
+import { fetchDeveloperTestAccountOauthAppInstallStatus, installOauthAppIntoDeveloperTestAccount, } from '@hubspot/local-dev-lib/api/developerTestAccounts';
+import { trackCommandUsage } from '../../lib/usageTracking.js';
+import { commands } from '../../lang/en.js';
+import { EXIT_CODES } from '../../lib/enums/exitCodes.js';
+import { makeYargsBuilder } from '../../lib/yargsUtils.js';
+import { APP_AUTH_TYPES } from '../../lib/constants.js';
+import { uiLogger } from '../../lib/ui/logger.js';
+import SpinniesManager from '../../lib/ui/SpinniesManager.js';
+import { poll } from '../../lib/polling.js';
+import { getProjectConfig, validateProjectConfig, } from '../../lib/projects/config.js';
+import { handleTranslate } from '../../lib/projects/upload.js';
+import { isAppIRNode } from '../../lib/projects/structure.js';
+import { logError } from '../../lib/errorHandlers/index.js';
+const command = 'install <test-account-id>';
+const describe = undefined; // commands.app.subcommands.install.describe;
+async function handler(args) {
+    const { derivedAccountId, appUid, projectName, testAccountId, formatOutputAsJson, } = args;
+    trackCommandUsage('app-install', {}, derivedAccountId);
+    const jsonOutput = {};
+    let targetProjectName = projectName;
+    let targetAppUid = appUid;
+    const { projectConfig, projectDir } = await getProjectConfig();
+    if (!targetProjectName) {
+        validateProjectConfig(projectConfig, projectDir);
+        targetProjectName = projectConfig?.name;
+    }
+    if (!targetProjectName) {
+        uiLogger.error(commands.app.subcommands.install.errors.mustSpecifyProjectName);
+        process.exit(EXIT_CODES.ERROR);
+    }
+    let isAppOauth = true;
+    if (!targetAppUid) {
+        const intermediateRepresentation = await handleTranslate(projectDir, projectConfig, derivedAccountId, true, undefined);
+        if (intermediateRepresentation) {
+            Object.values(intermediateRepresentation.intermediateNodesIndexedByUid).forEach(node => {
+                if (isAppIRNode(node)) {
+                    targetAppUid = node.uid;
+                    isAppOauth = node.config.auth.type === APP_AUTH_TYPES.OAUTH;
+                }
+            });
+        }
+    }
+    if (!targetAppUid) {
+        uiLogger.error(commands.app.subcommands.install.errors.noAppUidFound);
+        process.exit(EXIT_CODES.ERROR);
+    }
+    if (!isAppOauth) {
+        uiLogger.error(commands.app.subcommands.install.errors.appMustBeOauth);
+        process.exit(EXIT_CODES.ERROR);
+    }
+    try {
+        const { data } = await installOauthAppIntoDeveloperTestAccount(derivedAccountId, testAccountId, targetProjectName, targetAppUid);
+        if (data?.authCodes.length > 0) {
+            jsonOutput.authCode = data.authCodes[0].authCode;
+        }
+    }
+    catch (err) {
+        logError(err);
+        process.exit(EXIT_CODES.ERROR);
+    }
+    SpinniesManager.init({
+        succeedColor: 'white',
+    });
+    SpinniesManager.add('installApp', {
+        text: commands.app.subcommands.install.polling.start,
+    });
+    let appInstallSucceeded = false;
+    try {
+        await poll(() => fetchDeveloperTestAccountOauthAppInstallStatus(derivedAccountId, targetProjectName, targetAppUid), {
+            successStates: ['SUCCESS'],
+            errorStates: [],
+        });
+        appInstallSucceeded = true;
+    }
+    catch (err) {
+        SpinniesManager.fail('installApp');
+        logError(err);
+        process.exit(EXIT_CODES.ERROR);
+    }
+    if (!appInstallSucceeded) {
+        SpinniesManager.fail('installApp');
+        process.exit(EXIT_CODES.ERROR);
+    }
+    SpinniesManager.succeed('installApp', {
+        text: commands.app.subcommands.install.polling.success,
+    });
+    if (formatOutputAsJson) {
+        uiLogger.json(jsonOutput);
+    }
+    process.exit(EXIT_CODES.SUCCESS);
+}
+function installAppBuilder(yargs) {
+    yargs.positional('test-account-id', {
+        describe: commands.app.subcommands.install.positionals.testAccountId,
+        required: true,
+        type: 'number',
+    });
+    yargs.option('app-uid', {
+        describe: commands.app.subcommands.install.options.appUid,
+        type: 'string',
+    });
+    yargs.option('project-name', {
+        describe: commands.app.subcommands.install.options.projectName,
+        type: 'string',
+    });
+    yargs.example('install 1234567890 --app-uid=my-app-uid --project-name=my-project', commands.app.subcommands.install.example);
+    return yargs;
+}
+const builder = makeYargsBuilder(installAppBuilder, command, commands.app.subcommands.install.describe, {
+    useGlobalOptions: true,
+    useAccountOptions: true,
+    useConfigOptions: true,
+    useEnvironmentOptions: true,
+    useJSONOutputOptions: true,
+});
+const installAppCommand = {
+    command,
+    describe,
+    handler,
+    builder,
+};
+export default installAppCommand;

package/commands/app.js

@@ -1,11 +1,16 @@
 import migrateCommand from './app/migrate.js';
 import appSecretCommand from './app/secret.js';
+import installAppCommand from './app/install.js';
 import { makeYargsBuilder } from '../lib/yargsUtils.js';
 import { commands } from '../lang/en.js';
 const command = ['app', 'apps'];
 const describe = commands.app.describe;
 function appBuilder(yargs) {
-    yargs.command(migrateCommand).command(appSecretCommand).demandCommand(1, '');
+    yargs
+        .command(migrateCommand)
+        .command(appSecretCommand)
+        .command(installAppCommand)
+        .demandCommand(1, '');
     return yargs;
 }
 const builder = makeYargsBuilder(appBuilder, command, describe);

package/commands/customObject.js

@@ -8,7 +8,7 @@ const command = ['custom-object', 'custom-objects', 'co'];
 const describe = uiBetaTag(i18n(`commands.customObject.describe`), false);
 function logBetaMessage() {
     uiBetaTag(i18n(`commands.customObject.betaMessage`));
-    logger.log(uiLink(i18n(`commands.customObject.seeMoreLink`), 'https://developers.hubspot.com/docs/api/crm/crm-custom-objects'));
+    logger.log(uiLink(i18n(`commands.customObject.seeMoreLink`), 'https://developers.hubspot.com/docs/api-reference/crm-custom-objects-v3/guide#custom-objects-api-guide'));
     logger.log();
 }
 function customObjectBuilder(yargs) {

package/commands/project/upload.d.ts

@@ -1,5 +1,5 @@
-import { CommonArgs, JSONOutputArgs, YargsCommandModule } from '../../types/Yargs.js';
-type ProjectUploadArgs = CommonArgs & JSONOutputArgs & {
+import { CommonArgs, EnvironmentArgs, JSONOutputArgs, YargsCommandModule } from '../../types/Yargs.js';
+type ProjectUploadArgs = CommonArgs & JSONOutputArgs & EnvironmentArgs & {
     forceCreate: boolean;
     message: string;
     m: string;

package/commands/project/upload.js

@@ -25,7 +25,7 @@ async function handler(args) {
     validateProjectConfig(projectConfig, projectDir);
     let targetAccountId;
     if (useV3Api(projectConfig.platformVersion)) {
-        targetAccountId = await loadAndValidateProfile(projectConfig, projectDir, profile);
+        targetAccountId = await loadAndValidateProfile(projectConfig, projectDir, profile, args.useEnv);
     }
     targetAccountId = targetAccountId || derivedAccountId;
     const accountConfig = getAccountConfig(targetAccountId);

package/commands/testAccount/create.js

@@ -75,6 +75,9 @@ async function handler(args) {
         resultJson.personalAccessKey = createResult.personalAccessKey;
     }
     catch (err) {
+        SpinniesManager.fail('createTestAccount', {
+            text: commands.testAccount.create.polling.createFailure,
+        });
         logError(err);
         SpinniesManager.fail('createTestAccount', {
             text: commands.testAccount.create.polling.createFailure,

package/lang/en.d.ts

@@ -1557,6 +1557,28 @@ ${string}`;
     readonly app: {
         readonly describe: "Commands for managing apps.";
         readonly subcommands: {
+            readonly install: {
+                readonly describe: "Install an OAuth app into a test account.";
+                readonly options: {
+                    readonly appUid: "The uid of the app to install";
+                    readonly projectName: "The name of the project that contains the app";
+                };
+                readonly positionals: {
+                    readonly testAccountId: "The id of the test account to install the app into";
+                };
+                readonly errors: {
+                    readonly mustSpecifyProjectName: `You must specify a project name. Use the ${string} flag to specify the project name or run this command from within a project directory.`;
+                    readonly noAppUidFound: `No app uid found. Please specify the app uid with the ${string} flag or run this command from within a project that contains an app.`;
+                    readonly appMustBeOauth: "This command only supports installing oauth apps. Please specify an app with oauth auth type.";
+                };
+                readonly polling: {
+                    readonly start: "Installing app...";
+                    readonly success: "App installed successfully";
+                    readonly failure: "App installation failed";
+                    readonly error: "Error installing app";
+                };
+                readonly example: "Install the app with uid my-app-uid from the project named \"my-project\" into the target account with id 1234567890";
+            };
             readonly secret: {
                 readonly describe: "Commands for managing secrets.";
                 readonly subcommands: {

package/lang/en.js

@@ -1555,6 +1555,28 @@ export const commands = {
     app: {
         describe: 'Commands for managing apps.',
         subcommands: {
+            install: {
+                describe: 'Install an OAuth app into a test account.',
+                options: {
+                    appUid: 'The uid of the app to install',
+                    projectName: 'The name of the project that contains the app',
+                },
+                positionals: {
+                    testAccountId: 'The id of the test account to install the app into',
+                },
+                errors: {
+                    mustSpecifyProjectName: `You must specify a project name. Use the ${uiCommandReference('--project-name')} flag to specify the project name or run this command from within a project directory.`,
+                    noAppUidFound: `No app uid found. Please specify the app uid with the ${uiCommandReference('--app-uid')} flag or run this command from within a project that contains an app.`,
+                    appMustBeOauth: 'This command only supports installing oauth apps. Please specify an app with oauth auth type.',
+                },
+                polling: {
+                    start: 'Installing app...',
+                    success: 'App installed successfully',
+                    failure: 'App installation failed',
+                    error: 'Error installing app',
+                },
+                example: 'Install the app with uid my-app-uid from the project named "my-project" into the target account with id 1234567890',
+            },
             secret: {
                 describe: 'Commands for managing secrets.',
                 subcommands: {

package/lib/errorHandlers/suppressError.js

@@ -23,7 +23,7 @@ function createPlatformVersionError(err, subCategory) {
     }));
     logger.log(i18n(`lib.errorHandlers.suppressErrors.platformVersionErrors.updateProject`));
     logger.log(i18n(`lib.errorHandlers.suppressErrors.platformVersionErrors.betaLink`, {
-        docsLink: uiLink(i18n(`lib.errorHandlers.suppressErrors.platformVersionErrors.docsLink`), 'https://developers.hubspot.com/docs/platform/platform-versioning'),
+        docsLink: uiLink(i18n(`lib.errorHandlers.suppressErrors.platformVersionErrors.docsLink`), 'https://developers.hubspot.com/docs/developer-tooling/platform/versioning'),
     }));
     uiLine();
 }

package/lib/projectProfiles.d.ts

@@ -4,4 +4,4 @@ export declare function logProfileHeader(profileName: string): void;
 export declare function logProfileFooter(profile: HsProfileFile, includeVariables?: boolean): void;
 export declare function loadProfile(projectConfig: ProjectConfig | null, projectDir: string | null, profileName: string): HsProfileFile | undefined;
 export declare function exitIfUsingProfiles(projectConfig: ProjectConfig | null, projectDir: string | null): Promise<void>;
-export declare function loadAndValidateProfile(projectConfig: ProjectConfig | null, projectDir: string | null, argsProfile: string | undefined): Promise<number | undefined>;
+export declare function loadAndValidateProfile(projectConfig: ProjectConfig | null, projectDir: string | null, argsProfile: string | undefined, useEnv?: boolean): Promise<number | undefined>;

package/lib/projectProfiles.js

@@ -38,7 +38,12 @@ export function loadProfile(projectConfig, projectDir, profileName) {
             uiLogger.error(lib.projectProfiles.loadProfile.errors.missingAccountId(profileFilename));
             return;
         }
-        return profile;
+        return {
+            ...profile,
+            accountId: process.env.HUBSPOT_ACCOUNT_ID
+                ? Number(process.env.HUBSPOT_ACCOUNT_ID)
+                : profile.accountId,
+        };
     }
     catch (e) {
         uiLogger.error(lib.projectProfiles.loadProfile.errors.failedToLoadProfile(profileFilename));
@@ -54,7 +59,7 @@ export async function exitIfUsingProfiles(projectConfig, projectDir) {
         }
     }
 }
-export async function loadAndValidateProfile(projectConfig, projectDir, argsProfile) {
+export async function loadAndValidateProfile(projectConfig, projectDir, argsProfile, useEnv = false) {
     if (argsProfile) {
         logProfileHeader(argsProfile);
         const profile = loadProfile(projectConfig, projectDir, argsProfile);
@@ -63,6 +68,9 @@ export async function loadAndValidateProfile(projectConfig, projectDir, argsProf
             process.exit(EXIT_CODES.ERROR);
         }
         logProfileFooter(profile, true);
+        if (useEnv) {
+            return Number(process.env.HUBSPOT_ACCOUNT_ID);
+        }
         return profile.accountId;
     }
     else {

package/lib/projects/structure.d.ts

@@ -1,5 +1,5 @@
 import { ComponentTypes, Component, GenericComponentConfig, PublicAppComponentConfig, PrivateAppComponentConfig, AppCardComponentConfig } from '../../types/Projects.js';
-import { IntermediateRepresentationNodeLocalDev } from '@hubspot/project-parsing-lib/src/lib/types.js';
+import { IntermediateRepresentationNode, IntermediateRepresentationNodeLocalDev } from '@hubspot/project-parsing-lib/src/lib/types.js';
 import { AppIRNode } from '../../types/ProjectComponents.js';
 export declare const CONFIG_FILES: {
     [k in ComponentTypes]: string;
@@ -15,4 +15,4 @@ export declare function getProjectComponentTypes(components: Array<Component>):
 export declare function getComponentUid(component?: Component | null): string | null;
 export declare function componentIsApp(component?: Component | null): component is Component<PublicAppComponentConfig | PrivateAppComponentConfig>;
 export declare function componentIsPublicApp(component?: Component | null): component is Component<PublicAppComponentConfig>;
-export declare function isAppIRNode(component: IntermediateRepresentationNodeLocalDev): component is AppIRNode;
+export declare function isAppIRNode(component: IntermediateRepresentationNodeLocalDev | IntermediateRepresentationNode): component is AppIRNode;

package/lib/projects/upload.d.ts

@@ -1,4 +1,5 @@
 import { FileResult } from 'tmp';
+import { IntermediateRepresentation } from '@hubspot/project-parsing-lib';
 import { ProjectConfig } from '../../types/Projects.js';
 type ProjectUploadCallbackFunction<T> = (accountId: number, projectConfig: ProjectConfig, tempFile: FileResult, buildId: number) => Promise<T>;
 type ProjectUploadResult<T> = {
@@ -20,5 +21,5 @@ type HandleProjectUploadArg<T> = {
 export declare function handleProjectUpload<T>({ accountId, projectConfig, projectDir, callbackFunc, profile, uploadMessage, forceCreate, isUploadCommand, sendIR, skipValidation, }: HandleProjectUploadArg<T>): Promise<ProjectUploadResult<T>>;
 export declare function validateSourceDirectory(srcDir: string, projectConfig: ProjectConfig): void;
 export declare function validateNoHSMetaMismatch(srcDir: string, projectConfig: ProjectConfig): Promise<void>;
-export declare function handleTranslate(projectDir: string, projectConfig: ProjectConfig, accountId: number, skipValidation: boolean, profile: string | undefined): Promise<unknown>;
+export declare function handleTranslate(projectDir: string, projectConfig: ProjectConfig, accountId: number, skipValidation: boolean, profile: string | undefined): Promise<IntermediateRepresentation | undefined>;
 export {};

package/lib/projects/upload.js

@@ -133,4 +133,5 @@ export async function handleTranslate(projectDir, projectConfig, accountId, skip
         }
         throw e;
     }
+    return undefined;
 }

package/package.json

@@ -1,13 +1,13 @@
 {
     "name": "@hubspot/cli",
-    "version": "7.8.10-experimental.0",
+    "version": "7.8.12-experimental.0",
     "description": "The official CLI for developing on HubSpot",
     "license": "Apache-2.0",
     "repository": "https://github.com/HubSpot/hubspot-cli",
     "type": "module",
     "dependencies": {
         "@hubspot/local-dev-lib": "3.19.1",
-        "@hubspot/project-parsing-lib": "0.0.30-experimental.0",
+        "@hubspot/project-parsing-lib": "0.8.6",
         "@hubspot/serverless-dev-runtime": "7.0.6",
         "@hubspot/theme-preview-dev-server": "0.0.10",
         "@hubspot/ui-extensions-dev-server": "0.10.0",

package/types/Yargs.d.ts

@@ -15,7 +15,7 @@ export type AccountArgs = {
     account?: string;
 };
 export type EnvironmentArgs = {
-    'use-env'?: string;
+    'use-env'?: boolean;
 };
 export type OverwriteArgs = Options & {
     o?: boolean;