@hubspot/cli 6.2.0 → 6.2.2-experimental.0

package/commands/watch.js

@@ -1,18 +1,10 @@
+"use strict";
 const fs = require('fs');
 const path = require('path');
-
 const { watch } = require('@hubspot/local-dev-lib/cms/watch');
 const { getCwd } = require('@hubspot/local-dev-lib/path');
 const { logger } = require('@hubspot/local-dev-lib/logger');
-
-const {
-  addConfigOptions,
-  addAccountOptions,
-  addModeOptions,
-  addUseEnvironmentOptions,
-  getAccountId,
-  getMode,
-} = require('../lib/commonOpts');
+const { addConfigOptions, addAccountOptions, addModeOptions, addUseEnvironmentOptions, getAccountId, getMode, } = require('../lib/commonOpts');
 const { uploadPrompt } = require('../lib/prompts/uploadPrompt');
 const { validateMode, loadAndValidateOptions } = require('../lib/validation');
 const { trackCommandUsage } = require('../lib/usageTracking');
@@ -20,172 +12,134 @@ const { i18n } = require('../lib/lang');
 const { getUploadableFileList } = require('../lib/upload');
 const { logError, ApiErrorContext } = require('../lib/errorHandlers/index');
 const i18nKey = 'commands.watch';
-
 const { EXIT_CODES } = require('../lib/enums/exitCodes');
-
 exports.command = 'watch [--src] [--dest]';
 exports.describe = i18n(`${i18nKey}.describe`);
-
-exports.handler = async options => {
-  const { remove, initialUpload, disableInitial, notify } = options;
-
-  await loadAndValidateOptions(options);
-
-  if (!validateMode(options)) {
-    process.exit(EXIT_CODES.ERROR);
-  }
-
-  const accountId = getAccountId(options);
-  const mode = getMode(options);
-
-  const uploadPromptAnswers = await uploadPrompt(options);
-
-  const src = options.src || uploadPromptAnswers.src;
-  const dest = options.dest || uploadPromptAnswers.dest;
-
-  const absoluteSrcPath = path.resolve(getCwd(), src);
-  try {
-    const stats = fs.statSync(absoluteSrcPath);
-    if (!stats.isDirectory()) {
-      logger.log(
-        i18n(`${i18nKey}.errors.invalidPath`, {
-          path: src,
-        })
-      );
-      return;
+exports.handler = async (options) => {
+    const { remove, initialUpload, disableInitial, notify } = options;
+    await loadAndValidateOptions(options);
+    if (!validateMode(options)) {
+        process.exit(EXIT_CODES.ERROR);
     }
-  } catch (e) {
-    logger.log(
-      i18n(`${i18nKey}.errors.invalidPath`, {
-        path: src,
-      })
-    );
-    return;
-  }
-
-  if (!dest) {
-    logger.log(i18n(`${i18nKey}.errors.destinationRequired`));
-    return;
-  }
-
-  let filesToUpload = [];
-
-  if (disableInitial) {
-    logger.info(i18n(`${i18nKey}.warnings.disableInitial`));
-  } else if (!initialUpload) {
-    logger.info(i18n(`${i18nKey}.warnings.notUploaded`, { path: src }));
-    logger.info(i18n(`${i18nKey}.warnings.initialUpload`));
-  }
-
-  if (initialUpload) {
-    filesToUpload = await getUploadableFileList(
-      absoluteSrcPath,
-      options.convertFields
-    );
-  }
-
-  trackCommandUsage('watch', { mode }, accountId);
-
-  const postInitialUploadCallback = null;
-  const onUploadFolderError = error => {
-    logger.error(
-      i18n(`${i18nKey}.errors.folderFailed`, {
-        src,
-        dest,
-        accountId,
-      })
-    );
-    logError(error, {
-      accountId,
-    });
-  };
-  const onQueueAddError = null;
-  const onUploadFileError = (file, dest, accountId) => error => {
-    logger.error(
-      i18n(`${i18nKey}.errors.fileFailed`, {
-        file,
-        dest,
-        accountId,
-      })
-    );
-    logError(
-      error,
-      new ApiErrorContext({
-        accountId,
-        request: dest,
-        payload: file,
-      })
-    );
-  };
-  watch(
-    accountId,
-    absoluteSrcPath,
-    dest,
-    {
-      mode,
-      remove,
-      disableInitial: initialUpload ? false : true,
-      notify,
-      commandOptions: options,
-      filePaths: filesToUpload,
-    },
-    postInitialUploadCallback,
-    onUploadFolderError,
-    onQueueAddError,
-    onUploadFileError
-  );
+    const accountId = getAccountId(options);
+    const mode = getMode(options);
+    const uploadPromptAnswers = await uploadPrompt(options);
+    const src = options.src || uploadPromptAnswers.src;
+    const dest = options.dest || uploadPromptAnswers.dest;
+    const absoluteSrcPath = path.resolve(getCwd(), src);
+    try {
+        const stats = fs.statSync(absoluteSrcPath);
+        if (!stats.isDirectory()) {
+            logger.log(i18n(`${i18nKey}.errors.invalidPath`, {
+                path: src,
+            }));
+            return;
+        }
+    }
+    catch (e) {
+        logger.log(i18n(`${i18nKey}.errors.invalidPath`, {
+            path: src,
+        }));
+        return;
+    }
+    if (!dest) {
+        logger.log(i18n(`${i18nKey}.errors.destinationRequired`));
+        return;
+    }
+    let filesToUpload = [];
+    if (disableInitial) {
+        logger.info(i18n(`${i18nKey}.warnings.disableInitial`));
+    }
+    else if (!initialUpload) {
+        logger.info(i18n(`${i18nKey}.warnings.notUploaded`, { path: src }));
+        logger.info(i18n(`${i18nKey}.warnings.initialUpload`));
+    }
+    if (initialUpload) {
+        filesToUpload = await getUploadableFileList(absoluteSrcPath, options.convertFields);
+    }
+    trackCommandUsage('watch', { mode }, accountId);
+    const postInitialUploadCallback = null;
+    const onUploadFolderError = error => {
+        logger.error(i18n(`${i18nKey}.errors.folderFailed`, {
+            src,
+            dest,
+            accountId,
+        }));
+        logError(error, {
+            accountId,
+        });
+    };
+    const onQueueAddError = null;
+    const onUploadFileError = (file, dest, accountId) => error => {
+        logger.error(i18n(`${i18nKey}.errors.fileFailed`, {
+            file,
+            dest,
+            accountId,
+        }));
+        logError(error, new ApiErrorContext({
+            accountId,
+            request: dest,
+            payload: file,
+        }));
+    };
+    watch(accountId, absoluteSrcPath, dest, {
+        mode,
+        remove,
+        disableInitial: initialUpload ? false : true,
+        notify,
+        commandOptions: options,
+        filePaths: filesToUpload,
+    }, postInitialUploadCallback, onUploadFolderError, onQueueAddError, onUploadFileError);
 };
-
 exports.builder = yargs => {
-  addConfigOptions(yargs);
-  addAccountOptions(yargs);
-  addModeOptions(yargs, { write: true });
-  addUseEnvironmentOptions(yargs);
-
-  yargs.positional('src', {
-    describe: i18n(`${i18nKey}.positionals.src.describe`),
-    type: 'string',
-  });
-  yargs.positional('dest', {
-    describe: i18n(`${i18nKey}.positionals.dest.describe`),
-    type: 'string',
-  });
-  yargs.option('fieldOptions', {
-    describe: i18n(`${i18nKey}.options.options.describe`),
-    type: 'array',
-    default: [''],
-    hidden: true,
-  });
-  yargs.option('remove', {
-    alias: 'r',
-    describe: i18n(`${i18nKey}.options.remove.describe`),
-    type: 'boolean',
-  });
-  yargs.option('initial-upload', {
-    alias: 'i',
-    describe: i18n(`${i18nKey}.options.initialUpload.describe`),
-    type: 'boolean',
-  });
-  yargs.option('disable-initial', {
-    describe: i18n(`${i18nKey}.options.disableInitial.describe`),
-    type: 'boolean',
-    hidden: true,
-  });
-  yargs.option('notify', {
-    alias: 'n',
-    describe: i18n(`${i18nKey}.options.notify.describe`),
-    type: 'string',
-    requiresArg: true,
-  });
-  yargs.option('convertFields', {
-    describe: i18n(`${i18nKey}.options.convertFields.describe`),
-    type: 'boolean',
-    default: false,
-  });
-  yargs.option('saveOutput', {
-    describe: i18n(`${i18nKey}.options.saveOutput.describe`),
-    type: 'boolean',
-    default: false,
-  });
-  return yargs;
+    addConfigOptions(yargs);
+    addAccountOptions(yargs);
+    addModeOptions(yargs, { write: true });
+    addUseEnvironmentOptions(yargs);
+    yargs.positional('src', {
+        describe: i18n(`${i18nKey}.positionals.src.describe`),
+        type: 'string',
+    });
+    yargs.positional('dest', {
+        describe: i18n(`${i18nKey}.positionals.dest.describe`),
+        type: 'string',
+    });
+    yargs.option('fieldOptions', {
+        describe: i18n(`${i18nKey}.options.options.describe`),
+        type: 'array',
+        default: [''],
+        hidden: true,
+    });
+    yargs.option('remove', {
+        alias: 'r',
+        describe: i18n(`${i18nKey}.options.remove.describe`),
+        type: 'boolean',
+    });
+    yargs.option('initial-upload', {
+        alias: 'i',
+        describe: i18n(`${i18nKey}.options.initialUpload.describe`),
+        type: 'boolean',
+    });
+    yargs.option('disable-initial', {
+        describe: i18n(`${i18nKey}.options.disableInitial.describe`),
+        type: 'boolean',
+        hidden: true,
+    });
+    yargs.option('notify', {
+        alias: 'n',
+        describe: i18n(`${i18nKey}.options.notify.describe`),
+        type: 'string',
+        requiresArg: true,
+    });
+    yargs.option('convertFields', {
+        describe: i18n(`${i18nKey}.options.convertFields.describe`),
+        type: 'boolean',
+        default: false,
+    });
+    yargs.option('saveOutput', {
+        describe: i18n(`${i18nKey}.options.saveOutput.describe`),
+        type: 'boolean',
+        default: false,
+    });
+    return yargs;
 };

package/lang/en.lyaml

@@ -183,8 +183,6 @@ en:
             noSamples: "Currently there are no samples available, please, try again later."
           info:
             sampleChosen: "You've chosen {{ sampleType }} sample written on {{ sampleLanguage }} language"
-          loading:
-            apiSamples: "Loading available API samples"
           success:
             sampleCreated: "Please, follow {{ filePath }}/README.md to find out how to run the sample"
         module:
@@ -335,7 +333,8 @@ en:
             notFunctionsFolder: "Specified path {{ functionPath }} is not a .functions folder."
           examples:
             default: "Build and deploy a new bundle for all functions within the myFunctionFolder.functions folder"
-          loading: "Building and deploying bundle for \"{{ functionPath }}\" on account \"{{ accountId }}\".\n"
+          loading: "Building and deploying bundle for \"{{ functionPath }}\" on {{ account }}"
+          loadingFailed: "Failed to build and deploy bundle for \"{{ functionPath }}\" on {{ account }}"
           positionals:
             path:
               describe: "Path to .functions folder"

package/lib/DevServerManager.d.ts

@@ -0,0 +1,35 @@
+declare const _exports: DevServerManager;
+export = _exports;
+declare class DevServerManager {
+    initialized: boolean;
+    started: boolean;
+    componentsByType: {};
+    server: any;
+    path: any;
+    devServers: {
+        [x: string]: {
+            componentType: "private-app";
+            serverInterface: import("@hubspot/ui-extensions-dev-server").DevModeInterfaceNonSingleton;
+        } | {
+            componentType: "public-app";
+            serverInterface: import("@hubspot/ui-extensions-dev-server").DevModeInterfaceNonSingleton;
+        };
+    };
+    iterateDevServers(callback: any): Promise<void>;
+    arrangeComponentsByType(components: any): any;
+    setup({ components, onUploadRequired, accountId, setActiveApp }: {
+        components: any;
+        onUploadRequired: any;
+        accountId: any;
+        setActiveApp: any;
+    }): Promise<void>;
+    start({ accountId, projectConfig }: {
+        accountId: any;
+        projectConfig: any;
+    }): Promise<void>;
+    fileChange({ filePath, event }: {
+        filePath: any;
+        event: any;
+    }): void;
+    cleanup(): Promise<void>;
+}

package/lib/DevServerManager.js

@@ -1,144 +1,117 @@
+"use strict";
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { COMPONENT_TYPES } = require('./projectStructure');
 const { i18n } = require('./lang');
 const { promptUser } = require('./prompts/promptUtils');
 const { DevModeInterface } = require('@hubspot/ui-extensions-dev-server');
-const {
-  startPortManagerServer,
-  portManagerHasActiveServers,
-  stopPortManagerServer,
-  requestPorts,
-} = require('@hubspot/local-dev-lib/portManager');
-const {
-  getHubSpotApiOrigin,
-  getHubSpotWebsiteOrigin,
-} = require('@hubspot/local-dev-lib/urls');
+const { startPortManagerServer, portManagerHasActiveServers, stopPortManagerServer, requestPorts, } = require('@hubspot/local-dev-lib/portManager');
+const { getHubSpotApiOrigin, getHubSpotWebsiteOrigin, } = require('@hubspot/local-dev-lib/urls');
 const { getAccountConfig } = require('@hubspot/local-dev-lib/config');
-
 const i18nKey = 'lib.DevServerManager';
-
 const SERVER_KEYS = {
-  privateApp: 'privateApp',
-  publicApp: 'publicApp',
+    privateApp: 'privateApp',
+    publicApp: 'publicApp',
 };
-
 class DevServerManager {
-  constructor() {
-    this.initialized = false;
-    this.started = false;
-    this.componentsByType = {};
-    this.server = null;
-    this.path = null;
-    this.devServers = {
-      [SERVER_KEYS.privateApp]: {
-        componentType: COMPONENT_TYPES.privateApp,
-        serverInterface: DevModeInterface,
-      },
-      [SERVER_KEYS.publicApp]: {
-        componentType: COMPONENT_TYPES.publicApp,
-        serverInterface: DevModeInterface,
-      },
-    };
-  }
-
-  async iterateDevServers(callback) {
-    const serverKeys = Object.keys(this.devServers);
-
-    for (let i = 0; i < serverKeys.length; i++) {
-      const serverKey = serverKeys[i];
-      const devServer = this.devServers[serverKey];
-
-      const compatibleComponents =
-        this.componentsByType[devServer.componentType] || {};
-
-      if (Object.keys(compatibleComponents).length) {
-        await callback(devServer.serverInterface, compatibleComponents);
-      } else {
-        logger.debug(i18n(`${i18nKey}.noCompatibleComponents`, { serverKey }));
-      }
-    }
-  }
-
-  arrangeComponentsByType(components) {
-    return components.reduce((acc, component) => {
-      if (!acc[component.type]) {
-        acc[component.type] = {};
-      }
-
-      acc[component.type][component.config.name] = component;
-
-      return acc;
-    }, {});
-  }
-
-  async setup({ components, onUploadRequired, accountId, setActiveApp }) {
-    this.componentsByType = this.arrangeComponentsByType(components);
-    const { env } = getAccountConfig(accountId);
-    await startPortManagerServer();
-    await this.iterateDevServers(
-      async (serverInterface, compatibleComponents) => {
-        if (serverInterface.setup) {
-          await serverInterface.setup({
-            components: compatibleComponents,
-            onUploadRequired,
-            promptUser,
-            logger,
-            urls: {
-              api: getHubSpotApiOrigin(env),
-              web: getHubSpotWebsiteOrigin(env),
+    constructor() {
+        this.initialized = false;
+        this.started = false;
+        this.componentsByType = {};
+        this.server = null;
+        this.path = null;
+        this.devServers = {
+            [SERVER_KEYS.privateApp]: {
+                componentType: COMPONENT_TYPES.privateApp,
+                serverInterface: DevModeInterface,
+            },
+            [SERVER_KEYS.publicApp]: {
+                componentType: COMPONENT_TYPES.publicApp,
+                serverInterface: DevModeInterface,
             },
-            setActiveApp,
-          });
+        };
+    }
+    async iterateDevServers(callback) {
+        const serverKeys = Object.keys(this.devServers);
+        for (let i = 0; i < serverKeys.length; i++) {
+            const serverKey = serverKeys[i];
+            const devServer = this.devServers[serverKey];
+            const compatibleComponents = this.componentsByType[devServer.componentType] || {};
+            if (Object.keys(compatibleComponents).length) {
+                await callback(devServer.serverInterface, compatibleComponents);
+            }
+            else {
+                logger.debug(i18n(`${i18nKey}.noCompatibleComponents`, { serverKey }));
+            }
+        }
+    }
+    arrangeComponentsByType(components) {
+        return components.reduce((acc, component) => {
+            if (!acc[component.type]) {
+                acc[component.type] = {};
+            }
+            acc[component.type][component.config.name] = component;
+            return acc;
+        }, {});
+    }
+    async setup({ components, onUploadRequired, accountId, setActiveApp }) {
+        this.componentsByType = this.arrangeComponentsByType(components);
+        const { env } = getAccountConfig(accountId);
+        await startPortManagerServer();
+        await this.iterateDevServers(async (serverInterface, compatibleComponents) => {
+            if (serverInterface.setup) {
+                await serverInterface.setup({
+                    components: compatibleComponents,
+                    onUploadRequired,
+                    promptUser,
+                    logger,
+                    urls: {
+                        api: getHubSpotApiOrigin(env),
+                        web: 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,
+                    });
+                }
+            });
         }
-      }
-    );
-
-    this.initialized = true;
-  }
-
-  async start({ accountId, projectConfig }) {
-    if (this.initialized) {
-      await this.iterateDevServers(async serverInterface => {
-        if (serverInterface.start) {
-          await serverInterface.start({
-            accountId,
-            projectConfig,
-            requestPorts,
-          });
+        else {
+            throw new Error(i18n(`${i18nKey}.notInitialized`));
         }
-      });
-    } else {
-      throw new Error(i18n(`${i18nKey}.notInitialized`));
+        this.started = true;
     }
-
-    this.started = true;
-  }
-
-  fileChange({ filePath, event }) {
-    if (this.started) {
-      this.iterateDevServers(async serverInterface => {
-        if (serverInterface.fileChange) {
-          await serverInterface.fileChange(filePath, event);
+    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();
+    async cleanup() {
+        if (this.started) {
+            await this.iterateDevServers(async (serverInterface) => {
+                if (serverInterface.cleanup) {
+                    await serverInterface.cleanup();
+                }
+            });
+            const hasActiveServers = await portManagerHasActiveServers();
+            if (!hasActiveServers) {
+                await stopPortManagerServer();
+            }
         }
-      });
-
-      const hasActiveServers = await portManagerHasActiveServers();
-
-      if (!hasActiveServers) {
-        await stopPortManagerServer();
-      }
     }
-  }
 }
-
 module.exports = new DevServerManager();

package/lib/LocalDevManager.d.ts

@@ -0,0 +1,41 @@
+export = LocalDevManager;
+declare class LocalDevManager {
+    constructor(options: any);
+    targetAccountId: any;
+    targetProjectAccountId: any;
+    projectConfig: any;
+    projectDir: any;
+    projectId: any;
+    debug: any;
+    deployedBuild: any;
+    isGithubLinked: any;
+    watcher: chokidar.FSWatcher | null;
+    uploadWarnings: {};
+    runnableComponents: any;
+    activeApp: any;
+    activePublicAppData: any;
+    env: any;
+    publicAppActiveInstalls: number | null;
+    projectSourceDir: string;
+    setActiveApp(appUid: any): Promise<void>;
+    setActivePublicAppData(): Promise<void>;
+    checkActivePublicAppInstalls(): Promise<void>;
+    start(): Promise<void>;
+    stop(showProgress?: boolean): Promise<void>;
+    getActiveAppInstallationData(): Promise<import("@hubspot/local-dev-lib/types/Apps").PublicAppInstallationData>;
+    checkPublicAppInstallation(): Promise<void>;
+    updateKeypressListeners(): void;
+    getUploadCommand(): string;
+    logUploadWarning(reason: any): void;
+    mostRecentUploadWarning: any;
+    monitorConsoleOutput(): void;
+    compareLocalProjectToDeployed(): void;
+    startWatching(): void;
+    stopWatching(): Promise<void>;
+    handleWatchEvent(filePath: any, event: any, configPaths: any): void;
+    devServerSetup(): Promise<boolean>;
+    devServerStart(): Promise<void>;
+    devServerFileChange(filePath: any, event: any): void;
+    devServerCleanup(): Promise<boolean>;
+}
+import chokidar = require("chokidar");