@hubspot/cli 7.2.0-experimental.0 → 7.2.0

package/commands/remove.d.ts

@@ -1 +1,10 @@
+import { Argv, ArgumentsCamelCase } from 'yargs';
+import { AccountArgs, CommonArgs, ConfigArgs, EnvironmentArgs } from '../types/Yargs';
+export declare const command = "remove <path>";
+export declare const describe: string;
+type RemoveArgs = CommonArgs & ConfigArgs & EnvironmentArgs & AccountArgs & {
+    path: string;
+};
+export declare function handler(args: ArgumentsCamelCase<RemoveArgs>): Promise<void>;
+export declare function builder(yargs: Argv): Argv<RemoveArgs>;
 export {};

package/commands/remove.js

@@ -1,41 +1,43 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-// @ts-nocheck
-const { deleteFile } = require('@hubspot/local-dev-lib/api/fileMapper');
-const { logger } = require('@hubspot/local-dev-lib/logger');
-const { logError, ApiErrorContext } = require('../lib/errorHandlers/index');
-const { addConfigOptions, addAccountOptions, addUseEnvironmentOptions, addGlobalOptions, } = require('../lib/commonOpts');
-const { trackCommandUsage } = require('../lib/usageTracking');
-const { i18n } = require('../lib/lang');
+exports.describe = exports.command = void 0;
+exports.handler = handler;
+exports.builder = builder;
+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 commonOpts_1 = require("../lib/commonOpts");
+const usageTracking_1 = require("../lib/usageTracking");
+const lang_1 = require("../lib/lang");
 const i18nKey = 'commands.remove';
 exports.command = 'remove <path>';
-exports.describe = i18n(`${i18nKey}.describe`);
-exports.handler = async (options) => {
-    const { path: hsPath, derivedAccountId } = options;
-    trackCommandUsage('remove', null, derivedAccountId);
+exports.describe = (0, lang_1.i18n)(`${i18nKey}.describe`);
+async function handler(args) {
+    const { path: hsPath, derivedAccountId } = args;
+    (0, usageTracking_1.trackCommandUsage)('remove', undefined, derivedAccountId);
     try {
-        await deleteFile(derivedAccountId, hsPath);
-        logger.log(i18n(`${i18nKey}.deleted`, { accountId: derivedAccountId, path: hsPath }));
+        await (0, fileMapper_1.deleteFile)(derivedAccountId, hsPath);
+        logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.deleted`, { accountId: derivedAccountId, path: hsPath }));
     }
     catch (error) {
-        logger.error(i18n(`${i18nKey}.errors.deleteFailed`, {
+        logger_1.logger.error((0, lang_1.i18n)(`${i18nKey}.errors.deleteFailed`, {
             accountId: derivedAccountId,
             path: hsPath,
         }));
-        logError(error, new ApiErrorContext({
+        (0, index_1.logError)(error, new index_1.ApiErrorContext({
             accountId: derivedAccountId,
             request: hsPath,
         }));
     }
-};
-exports.builder = yargs => {
+}
+function builder(yargs) {
+    (0, commonOpts_1.addConfigOptions)(yargs);
+    (0, commonOpts_1.addAccountOptions)(yargs);
+    (0, commonOpts_1.addUseEnvironmentOptions)(yargs);
+    (0, commonOpts_1.addGlobalOptions)(yargs);
     yargs.positional('path', {
-        describe: i18n(`${i18nKey}.positionals.path.describe`),
+        describe: (0, lang_1.i18n)(`${i18nKey}.positionals.path.describe`),
         type: 'string',
     });
-    addConfigOptions(yargs);
-    addAccountOptions(yargs);
-    addUseEnvironmentOptions(yargs);
-    addGlobalOptions(yargs);
     return yargs;
-};
+}

package/lang/en.lyaml

@@ -72,6 +72,9 @@ en:
           describe: "Print information about the default account, or about the account specified with the \"account\" option."
           errors:
             notUsingPersonalAccessKey: "This command currently only supports fetching scopes for the personal access key auth type."
+          options:
+            account:
+              describe: "Account name or id to show info for"
           examples:
             default: "Print information for the default account"
             idBased: "Print information for the account with accountId equal to \"1234567\""
@@ -91,14 +94,14 @@ en:
             other: "Remove {{ count }} inactive accounts from the CLI config?"
           removeSuccess: "Removed {{ accountName }} from the CLI config."
     auth:
-      describe: "Configure authentication for your HubSpot account. This will update the {{ configName }} file that stores your account information."
+      describe: "Configure authentication for your HubSpot account."
+      verboseDescribe: "Configure authentication for a HubSpot account. This will update the {{ configName }} file that stores your account information.\n\nThe recommended authentication method is {{#bold}}{{ authMethod }}{{/bold}}, which uses an access token tied to a specific user account."
       errors:
         noConfigFileFound: "No config file was found. To create a new config file, use the \"hs init\" command."
         unsupportedAuthType: "Unsupported auth type: {{ type }}. The only supported authentication protocols are {{ supportedProtocols }}."
       options:
         authType:
-          describe: "Authentication mechanism"
-          defaultDescription: "\"{{ authMethod }}\": An access token tied to a specific user account. This is the recommended way of authenticating with local development tools."
+          describe: "Authentication method"
         account:
           describe: "HubSpot account to authenticate"
       success:
@@ -446,11 +449,11 @@ en:
           success:
             fetch: "Downloaded HubDB table {{ tableId }} to {{ path }}"
     init:
-      describe: "Configure authentication for your HubSpot account. This will create a {{ configName }} file to store your account information."
+      describe: "Create a CLI config file and configure authentication for your HubSpot account."
+      verboseDescribe: "Configure authentication for a HubSpot account. This will create a {{ configName }} file to store your account information. To configure authentication for additional accounts, run {{ command }}.\n\nThe recommended authentication method is {{#bold}}{{ authMethod }}{{/bold}}, which uses an access token tied to a specific user account."
       options:
         authType:
-          describe: "Authentication mechanism"
-          defaultDescription: "\"{{ authMethod }}\":  An access token tied to a specific user account. This is the recommended way of authenticating with local development tools."
+          describe: "Authentication method"
         account:
           describe: "HubSpot account to authenticate"
         useHiddenConfig:
@@ -529,6 +532,7 @@ en:
             noAccountsInConfig: "No accounts found in your config. Run {{ authCommand }} to configure a HubSpot account with the CLI."
             invalidProjectComponents: "Projects cannot contain both private and public apps. Move your apps to separate projects before attempting local development."
             noRunnableComponents: "No supported components were found in this project. Run {{ command }} to see a list of available components and add one to your project."
+            invalidUnifiedAppsAccount: "Local development of Unified Apps is currently only supported in standard and developer accounts. Target a standard or developer account with {{ authCommand }} and try again."
           examples:
             default: "Start local dev for the current project"
         create:

package/lib/DevServerManagerV2.d.ts

@@ -0,0 +1,34 @@
+import { ProjectConfig } from '../types/Projects';
+import { IntermediateRepresentationNodeLocalDev } from '@hubspot/project-parsing-lib/src/lib/types';
+type DevServerInterface = {
+    setup?: Function;
+    start?: (options: object) => Promise<void>;
+    fileChange?: (filePath: string, event: string) => Promise<void>;
+    cleanup?: () => Promise<void>;
+};
+declare class DevServerManagerV2 {
+    private initialized;
+    private started;
+    private devServers;
+    constructor();
+    iterateDevServers(callback: (serverInterface: DevServerInterface) => Promise<void>): Promise<void>;
+    setup({ projectNodes, onUploadRequired, accountId, setActiveApp, }: {
+        projectNodes: {
+            [key: string]: IntermediateRepresentationNodeLocalDev;
+        };
+        onUploadRequired: () => void;
+        accountId: number;
+        setActiveApp: (appUid: string | undefined) => Promise<void>;
+    }): Promise<void>;
+    start({ accountId, projectConfig, }: {
+        accountId: number;
+        projectConfig: ProjectConfig;
+    }): Promise<void>;
+    fileChange({ filePath, event, }: {
+        filePath: string;
+        event: string;
+    }): Promise<void>;
+    cleanup(): Promise<void>;
+}
+declare const Manager: DevServerManagerV2;
+export default Manager;

package/lib/DevServerManagerV2.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const logger_1 = require("@hubspot/local-dev-lib/logger");
+const lang_1 = require("./lang");
+const promptUtils_1 = require("./prompts/promptUtils");
+const ui_extensions_dev_server_1 = require("@hubspot/ui-extensions-dev-server");
+const portManager_1 = require("@hubspot/local-dev-lib/portManager");
+const urls_1 = require("@hubspot/local-dev-lib/urls");
+const config_1 = require("@hubspot/local-dev-lib/config");
+const i18nKey = 'lib.DevServerManager';
+class DevServerManagerV2 {
+    initialized;
+    started;
+    devServers;
+    constructor() {
+        this.initialized = false;
+        this.started = false;
+        this.devServers = [ui_extensions_dev_server_1.DevModeUnifiedInterface];
+    }
+    async iterateDevServers(callback) {
+        await Promise.all(this.devServers.map(devServer => callback(devServer)));
+    }
+    async setup({ projectNodes, onUploadRequired, accountId, setActiveApp, }) {
+        let env;
+        const accountConfig = (0, config_1.getAccountConfig)(accountId);
+        if (accountConfig) {
+            env = accountConfig.env;
+        }
+        await (0, portManager_1.startPortManagerServer)();
+        await this.iterateDevServers(async (serverInterface) => {
+            if (serverInterface.setup) {
+                await serverInterface.setup({
+                    components: projectNodes,
+                    onUploadRequired,
+                    promptUser: promptUtils_1.promptUser,
+                    logger: logger_1.logger,
+                    urls: {
+                        api: (0, urls_1.getHubSpotApiOrigin)(env),
+                        web: (0, urls_1.getHubSpotWebsiteOrigin)(env),
+                    },
+                    setActiveApp,
+                });
+            }
+        });
+        this.initialized = true;
+    }
+    async start({ accountId, projectConfig, }) {
+        if (this.initialized) {
+            await this.iterateDevServers(async (serverInterface) => {
+                if (serverInterface.start) {
+                    await serverInterface.start({
+                        accountId,
+                        projectConfig,
+                        requestPorts: portManager_1.requestPorts,
+                    });
+                }
+            });
+        }
+        else {
+            throw new Error((0, lang_1.i18n)(`${i18nKey}.notInitialized`));
+        }
+        this.started = true;
+    }
+    async fileChange({ filePath, event, }) {
+        if (this.started) {
+            this.iterateDevServers(async (serverInterface) => {
+                if (serverInterface.fileChange) {
+                    await serverInterface.fileChange(filePath, event);
+                }
+            });
+        }
+    }
+    async cleanup() {
+        if (this.started) {
+            await this.iterateDevServers(async (serverInterface) => {
+                if (serverInterface.cleanup) {
+                    await serverInterface.cleanup();
+                }
+            });
+            await (0, portManager_1.stopPortManagerServer)();
+        }
+    }
+}
+const Manager = new DevServerManagerV2();
+exports.default = Manager;

package/lib/LocalDevManagerV2.d.ts

@@ -0,0 +1,64 @@
+import { FSWatcher } from 'chokidar';
+import { Build } from '@hubspot/local-dev-lib/types/Build';
+import { PublicApp } from '@hubspot/local-dev-lib/types/Apps';
+import { Environment } from '@hubspot/local-dev-lib/types/Config';
+import { ProjectConfig } from '../types/Projects';
+import { IntermediateRepresentationNodeLocalDev } from '@hubspot/project-parsing-lib/src/lib/types';
+import { AppIRNode } from '../types/ProjectComponents';
+type LocalDevManagerConstructorOptions = {
+    targetProjectAccountId: number;
+    targetTestingAccountId: number;
+    projectConfig: ProjectConfig;
+    projectDir: string;
+    projectId: number;
+    debug?: boolean;
+    deployedBuild?: Build;
+    isGithubLinked: boolean;
+    projectNodes: {
+        [key: string]: IntermediateRepresentationNodeLocalDev;
+    };
+    env: Environment;
+};
+declare class LocalDevManagerV2 {
+    targetProjectAccountId: number;
+    targetTestingAccountId: number;
+    projectConfig: ProjectConfig;
+    projectDir: string;
+    projectId: number;
+    debug: boolean;
+    deployedBuild?: Build;
+    isGithubLinked: boolean;
+    watcher: FSWatcher | null;
+    uploadWarnings: {
+        [key: string]: boolean;
+    };
+    projectNodes: {
+        [key: string]: IntermediateRepresentationNodeLocalDev;
+    };
+    activeApp: AppIRNode | null;
+    activePublicAppData: PublicApp | null;
+    env: Environment;
+    publicAppActiveInstalls: number | null;
+    projectSourceDir: string;
+    mostRecentUploadWarning: string | null;
+    constructor(options: LocalDevManagerConstructorOptions);
+    setActiveApp(appUid?: string): Promise<void>;
+    setActivePublicAppData(): Promise<void>;
+    checkActivePublicAppInstalls(): Promise<void>;
+    start(): Promise<void>;
+    stop(showProgress?: boolean): Promise<void>;
+    checkPublicAppInstallation(): Promise<void>;
+    updateKeypressListeners(): void;
+    getUploadCommand(): string;
+    logUploadWarning(reason?: string): void;
+    monitorConsoleOutput(): void;
+    compareLocalProjectToDeployed(): void;
+    startWatching(): void;
+    stopWatching(): Promise<void>;
+    handleWatchEvent(filePath: string, event: string, configPaths: string[]): void;
+    devServerSetup(): Promise<boolean>;
+    devServerStart(): Promise<void>;
+    devServerFileChange(filePath: string, event: string): void;
+    devServerCleanup(): Promise<boolean>;
+}
+export default LocalDevManagerV2;