@hubspot/cli 7.7.19-experimental.1 → 7.7.19-experimental.2

package/commands/app/install.d.ts

@@ -0,0 +1,8 @@
+import { CommonArgs, ConfigArgs, AccountArgs, EnvironmentArgs, YargsCommandModule, JSONOutputArgs } from '../../types/Yargs';
+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,127 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const developerTestAccounts_1 = require("@hubspot/local-dev-lib/api/developerTestAccounts");
+const usageTracking_1 = require("../../lib/usageTracking");
+const en_1 = require("../../lang/en");
+const exitCodes_1 = require("../../lib/enums/exitCodes");
+const yargsUtils_1 = require("../../lib/yargsUtils");
+const constants_1 = require("../../lib/constants");
+const logger_1 = require("../../lib/ui/logger");
+const SpinniesManager_1 = __importDefault(require("../../lib/ui/SpinniesManager"));
+const errorHandlers_1 = require("../../lib/errorHandlers");
+const polling_1 = require("../../lib/polling");
+const config_1 = require("../../lib/projects/config");
+const upload_1 = require("../../lib/projects/upload");
+const structure_1 = require("../../lib/projects/structure");
+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;
+    (0, usageTracking_1.trackCommandUsage)('app-install', {}, derivedAccountId);
+    const jsonOutput = {};
+    let targetProjectName = projectName;
+    let targetAppUid = appUid;
+    const { projectConfig, projectDir } = await (0, config_1.getProjectConfig)();
+    if (!targetProjectName) {
+        (0, config_1.validateProjectConfig)(projectConfig, projectDir);
+        targetProjectName = projectConfig?.name;
+    }
+    if (!targetProjectName) {
+        logger_1.uiLogger.error(en_1.commands.app.subcommands.install.errors.mustSpecifyProjectName);
+        process.exit(exitCodes_1.EXIT_CODES.ERROR);
+    }
+    let isAppOauth = true;
+    if (!targetAppUid) {
+        const intermediateRepresentation = await (0, upload_1.handleTranslate)(projectDir, projectConfig, derivedAccountId, true, undefined);
+        if (intermediateRepresentation) {
+            Object.values(intermediateRepresentation.intermediateNodesIndexedByUid).forEach(node => {
+                if ((0, structure_1.isAppIRNode)(node)) {
+                    targetAppUid = node.uid;
+                    isAppOauth = node.config.auth.type === constants_1.APP_AUTH_TYPES.OAUTH;
+                }
+            });
+        }
+    }
+    if (!targetAppUid) {
+        logger_1.uiLogger.error(en_1.commands.app.subcommands.install.errors.noAppUidFound);
+        process.exit(exitCodes_1.EXIT_CODES.ERROR);
+    }
+    if (!isAppOauth) {
+        logger_1.uiLogger.error(en_1.commands.app.subcommands.install.errors.appMustBeOauth);
+        process.exit(exitCodes_1.EXIT_CODES.ERROR);
+    }
+    try {
+        const { data } = await (0, developerTestAccounts_1.installOauthAppIntoDeveloperTestAccount)(derivedAccountId, testAccountId, targetProjectName, targetAppUid);
+        if (data?.authCodes.length > 0) {
+            jsonOutput.authCode = data.authCodes[0].authCode;
+        }
+    }
+    catch (err) {
+        (0, errorHandlers_1.logError)(err);
+        process.exit(exitCodes_1.EXIT_CODES.ERROR);
+    }
+    SpinniesManager_1.default.init({
+        succeedColor: 'white',
+    });
+    SpinniesManager_1.default.add('installApp', {
+        text: en_1.commands.app.subcommands.install.polling.start,
+    });
+    let appInstallSucceeded = false;
+    try {
+        await (0, polling_1.poll)(() => (0, developerTestAccounts_1.fetchDeveloperTestAccountOauthAppInstallStatus)(derivedAccountId, targetProjectName, targetAppUid), {
+            successStates: ['SUCCESS'],
+            errorStates: [],
+        });
+        appInstallSucceeded = true;
+    }
+    catch (err) {
+        SpinniesManager_1.default.fail('installApp');
+        (0, errorHandlers_1.logError)(err);
+        process.exit(exitCodes_1.EXIT_CODES.ERROR);
+    }
+    if (!appInstallSucceeded) {
+        SpinniesManager_1.default.fail('installApp');
+        process.exit(exitCodes_1.EXIT_CODES.ERROR);
+    }
+    SpinniesManager_1.default.succeed('installApp', {
+        text: en_1.commands.app.subcommands.install.polling.success,
+    });
+    if (formatOutputAsJson) {
+        logger_1.uiLogger.json(jsonOutput);
+    }
+    process.exit(exitCodes_1.EXIT_CODES.SUCCESS);
+}
+function installAppBuilder(yargs) {
+    yargs.positional('test-account-id', {
+        describe: en_1.commands.app.subcommands.install.positionals.testAccountId,
+        required: true,
+        type: 'number',
+    });
+    yargs.option('app-uid', {
+        describe: en_1.commands.app.subcommands.install.options.appUid,
+        type: 'string',
+    });
+    yargs.option('project-name', {
+        describe: en_1.commands.app.subcommands.install.options.projectName,
+        type: 'string',
+    });
+    yargs.example('install 1234567890 --app-uid=my-app-uid --project-name=my-project', en_1.commands.app.subcommands.install.example);
+    return yargs;
+}
+const builder = (0, yargsUtils_1.makeYargsBuilder)(installAppBuilder, command, en_1.commands.app.subcommands.install.describe, {
+    useGlobalOptions: true,
+    useAccountOptions: true,
+    useConfigOptions: true,
+    useEnvironmentOptions: true,
+    useJSONOutputOptions: true,
+});
+const installAppCommand = {
+    command,
+    describe,
+    handler,
+    builder,
+};
+exports.default = installAppCommand;

package/commands/app.js

@@ -5,12 +5,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const migrate_1 = __importDefault(require("./app/migrate"));
 const secret_1 = __importDefault(require("./app/secret"));
+const install_1 = __importDefault(require("./app/install"));
 const yargsUtils_1 = require("../lib/yargsUtils");
 const command = ['app', 'apps'];
 // Keep the command hidden for now
 const describe = undefined;
 function appBuilder(yargs) {
-    yargs.command(migrate_1.default).command(secret_1.default).demandCommand(1, '');
+    yargs
+        .command(migrate_1.default)
+        .command(secret_1.default)
+        .command(install_1.default)
+        .demandCommand(1, '');
     return yargs;
 }
 const builder = (0, yargsUtils_1.makeYargsBuilder)(appBuilder, command, describe);

package/commands/testAccount/create.js

@@ -81,6 +81,9 @@ async function handler(args) {
         testAccountId = result.accountId;
     }
     catch (err) {
+        SpinniesManager_1.default.fail('createTestAccount', {
+            text: en_1.commands.testAccount.create.polling.createFailure,
+        });
         (0, errorHandlers_1.logError)(err);
         SpinniesManager_1.default.fail('createTestAccount', {
             text: en_1.commands.testAccount.create.polling.createFailure,

package/lang/en.d.ts

@@ -1502,6 +1502,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

@@ -1500,6 +1500,28 @@ exports.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 ${(0, ui_1.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 ${(0, ui_1.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/buildAccount.js

@@ -81,8 +81,8 @@ async function createDeveloperTestAccountV3(parentAccountId, testAccountConfig)
         throw new Error(en_1.lib.buildAccount.createDeveloperTestAccountV3.syncFailure);
     }
     // HACK: The status endpoint sometimes returns an early success status.
-    // Sleep for an extra 5 seconds to make sure the sync is actually complete.
-    await new Promise(resolve => setTimeout(resolve, 5000));
+    // Sleep for an extra 6 minutes to make sure the sync is actually complete.
+    await new Promise(resolve => setTimeout(resolve, 360000));
     try {
         // Attempt to generate a new personal access key for the test account now that gate sync is complete.
         const { data } = await (0, developerTestAccounts_1.generateDeveloperTestAccountPersonalAccessKey)(parentAccountId, result.accountId);

package/lib/projects/structure.d.ts

@@ -1,5 +1,5 @@
 import { ComponentTypes, Component, GenericComponentConfig, PublicAppComponentConfig, PrivateAppComponentConfig, AppCardComponentConfig } from '../../types/Projects';
-import { IntermediateRepresentationNodeLocalDev } from '@hubspot/project-parsing-lib/src/lib/types';
+import { IntermediateRepresentationNode, IntermediateRepresentationNodeLocalDev } from '@hubspot/project-parsing-lib/src/lib/types';
 import { AppIRNode } from '../../types/ProjectComponents';
 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';
 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

@@ -149,4 +149,5 @@ async function handleTranslate(projectDir, projectConfig, accountId, skipValidat
             (0, errorHandlers_1.logError)(e);
         }
     }
+    return undefined;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/cli",
-    "version": "7.7.19-experimental.1",
+    "version": "7.7.19-experimental.2",
     "description": "The official CLI for developing on HubSpot",
     "license": "Apache-2.0",
     "repository": "https://github.com/HubSpot/hubspot-cli",