@hubspot/cli 6.2.0 → 6.2.2-experimental.0

package/lib/ui/table.js

@@ -1,70 +1,62 @@
+"use strict";
 const chalk = require('chalk');
 const { table } = require('table');
-
 function isObject(item) {
-  return item && typeof item === 'object' && !Array.isArray(item);
+    return item && typeof item === 'object' && !Array.isArray(item);
 }
-
 function mergeDeep(target, ...sources) {
-  if (!sources.length) return target;
-  const source = sources.shift();
-
-  if (isObject(target) && source && isObject(source)) {
-    for (const key in source) {
-      if (isObject(source[key])) {
-        if (!target[key]) Object.assign(target, { [key]: {} });
-        mergeDeep(target[key], source[key]);
-      } else {
-        Object.assign(target, { [key]: source[key] });
-      }
+    if (!sources.length)
+        return target;
+    const source = sources.shift();
+    if (isObject(target) && source && isObject(source)) {
+        for (const key in source) {
+            if (isObject(source[key])) {
+                if (!target[key])
+                    Object.assign(target, { [key]: {} });
+                mergeDeep(target[key], source[key]);
+            }
+            else {
+                Object.assign(target, { [key]: source[key] });
+            }
+        }
     }
-  }
-
-  return mergeDeep(target, ...sources);
+    return mergeDeep(target, ...sources);
 }
-
 const tableConfigDefaults = {
-  singleLine: true,
-  border: {
-    topBody: '',
-    topJoin: '',
-    topLeft: '',
-    topRight: '',
-
-    bottomBody: '',
-    bottomJoin: '',
-    bottomLeft: '',
-    bottomRight: '',
-
-    bodyLeft: '',
-    bodyRight: '',
-    bodyJoin: '',
-
-    joinBody: '',
-    joinLeft: '',
-    joinRight: '',
-    joinJoin: '',
-  },
-  columnDefault: {
-    paddingLeft: 0,
-    paddingRight: 1,
-  },
-  drawHorizontalLine: () => {
-    return false;
-  },
+    singleLine: true,
+    border: {
+        topBody: '',
+        topJoin: '',
+        topLeft: '',
+        topRight: '',
+        bottomBody: '',
+        bottomJoin: '',
+        bottomLeft: '',
+        bottomRight: '',
+        bodyLeft: '',
+        bodyRight: '',
+        bodyJoin: '',
+        joinBody: '',
+        joinLeft: '',
+        joinRight: '',
+        joinJoin: '',
+    },
+    columnDefault: {
+        paddingLeft: 0,
+        paddingRight: 1,
+    },
+    drawHorizontalLine: () => {
+        return false;
+    },
 };
-
 function getTableContents(tableData = [], tableConfig = {}) {
-  const mergedConfig = mergeDeep({}, tableConfigDefaults, tableConfig);
-
-  return table(tableData, mergedConfig);
+    const mergedConfig = mergeDeep({}, tableConfigDefaults, tableConfig);
+    return table(tableData, mergedConfig);
 }
-
 function getTableHeader(headerItems) {
-  return headerItems.map(headerItem => chalk.bold(headerItem));
+    return headerItems.map(headerItem => chalk.bold(headerItem));
 }
-
 module.exports = {
-  getTableContents,
-  getTableHeader,
+    getTableContents,
+    getTableHeader,
 };

package/lib/upload.d.ts

@@ -0,0 +1 @@
+export function getUploadableFileList(src: any, convertFields: any): Promise<any[]>;

package/lib/upload.js

@@ -1,58 +1,53 @@
+"use strict";
 const path = require('path');
 const { walk } = require('@hubspot/local-dev-lib/fs');
 const { createIgnoreFilter } = require('@hubspot/local-dev-lib/ignoreRules');
 const { fieldsJsPrompt } = require('../lib/prompts/cmsFieldPrompt');
 const { isAllowedExtension } = require('@hubspot/local-dev-lib/path');
-const {
-  isConvertableFieldJs,
-} = require('@hubspot/local-dev-lib/cms/handleFieldsJS');
+const { isConvertableFieldJs, } = require('@hubspot/local-dev-lib/cms/handleFieldsJS');
 const { logError } = require('./errorHandlers/index');
-
 /*
  * Walks the src folder for files, filters them based on ignore filter.
  * If convertFields is true then will check for any JS fields conflicts (i.e., JS fields file and fields.json file) and prompt to resolve
  */
 const getUploadableFileList = async (src, convertFields) => {
-  let filePaths = [];
-  try {
-    filePaths = await walk(src);
-  } catch (e) {
-    logError(e);
-  }
-  const allowedFiles = filePaths
-    .filter(file => {
-      if (!isAllowedExtension(file)) {
-        return false;
-      }
-      return true;
+    let filePaths = [];
+    try {
+        filePaths = await walk(src);
+    }
+    catch (e) {
+        logError(e);
+    }
+    const allowedFiles = filePaths
+        .filter(file => {
+        if (!isAllowedExtension(file)) {
+            return false;
+        }
+        return true;
     })
-    .filter(createIgnoreFilter());
-  if (!convertFields) {
-    return allowedFiles;
-  }
-
-  let uploadableFiles = [];
-  let skipFiles = [];
-  for (const filePath of allowedFiles) {
-    const fileName = path.basename(filePath);
-    if (skipFiles.includes(filePath)) continue;
-    const isConvertable = isConvertableFieldJs(src, filePath, convertFields);
-    if (isConvertable || fileName == 'fields.json') {
-      // This prompt checks if there are multiple field files in the folder and gets user to choose.
-      const [choice, updatedSkipFiles] = await fieldsJsPrompt(
-        filePath,
-        src,
-        skipFiles
-      );
-      skipFiles = updatedSkipFiles;
-      // If they chose something other than the current file, move on.
-      if (choice !== filePath) continue;
+        .filter(createIgnoreFilter());
+    if (!convertFields) {
+        return allowedFiles;
+    }
+    let uploadableFiles = [];
+    let skipFiles = [];
+    for (const filePath of allowedFiles) {
+        const fileName = path.basename(filePath);
+        if (skipFiles.includes(filePath))
+            continue;
+        const isConvertable = isConvertableFieldJs(src, filePath, convertFields);
+        if (isConvertable || fileName == 'fields.json') {
+            // This prompt checks if there are multiple field files in the folder and gets user to choose.
+            const [choice, updatedSkipFiles] = await fieldsJsPrompt(filePath, src, skipFiles);
+            skipFiles = updatedSkipFiles;
+            // If they chose something other than the current file, move on.
+            if (choice !== filePath)
+                continue;
+        }
+        uploadableFiles.push(filePath);
     }
-    uploadableFiles.push(filePath);
-  }
-  return uploadableFiles;
+    return uploadableFiles;
 };
-
 module.exports = {
-  getUploadableFileList,
+    getUploadableFileList,
 };

package/lib/usageTracking.d.ts

@@ -0,0 +1,6 @@
+export function trackCommandUsage(command: any, meta: {} | undefined, accountId: any): void;
+export function trackHelpUsage(command: any): Promise<void>;
+export function addHelpUsageTracking(program: any, command: any): void;
+export function trackConvertFieldsUsage(command: any): Promise<void>;
+export function trackAuthAction(command: any, authType: any, step: any, accountId: any): Promise<void>;
+export function trackCommandMetadataUsage(command: any, meta: {} | undefined, accountId: any): void;

package/lib/usageTracking.js

@@ -1,16 +1,11 @@
+"use strict";
 const { trackUsage } = require('@hubspot/local-dev-lib/trackUsage');
-const {
-  isTrackingAllowed,
-  getAccountConfig,
-} = require('@hubspot/local-dev-lib/config');
-const {
-  API_KEY_AUTH_METHOD,
-} = require('@hubspot/local-dev-lib/constants/auth');
+const { isTrackingAllowed, getAccountConfig, } = require('@hubspot/local-dev-lib/config');
+const { API_KEY_AUTH_METHOD, } = require('@hubspot/local-dev-lib/constants/auth');
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { version } = require('../package.json');
 const { getPlatform } = require('./environment');
 const { setLogLevel } = require('./commonOpts');
-
 /* **
 Available tracking meta properties
 
@@ -29,172 +24,153 @@ Available tracking meta properties
   - successful: "Whether or not the CLI interaction was successful"
 
 */
-
 const EventClass = {
-  USAGE: 'USAGE',
-  INTERACTION: 'INTERACTION',
-  VIEW: 'VIEW',
-  ACTIVATION: 'ACTIVATION',
+    USAGE: 'USAGE',
+    INTERACTION: 'INTERACTION',
+    VIEW: 'VIEW',
+    ACTIVATION: 'ACTIVATION',
 };
-
 const getNodeVersionData = () => ({
-  nodeVersion: process.version,
-  nodeMajorVersion: (process.version || '').split('.')[0],
+    nodeVersion: process.version,
+    nodeMajorVersion: (process.version || '').split('.')[0],
 });
-
 function trackCommandUsage(command, meta = {}, accountId) {
-  if (!isTrackingAllowed()) {
-    return;
-  }
-  logger.debug('Attempting to track usage of "%s" command', command);
-  let authType = 'unknown';
-  if (accountId) {
-    const accountConfig = getAccountConfig(accountId);
-    authType =
-      accountConfig && accountConfig.authType
-        ? accountConfig.authType
-        : API_KEY_AUTH_METHOD.value;
-  }
-  setImmediate(async () => {
-    const usageTrackingEvent = {
-      action: 'cli-command',
-      os: getPlatform(),
-      ...getNodeVersionData(),
-      version,
-      command,
-      authType,
-      ...meta,
-    };
-    try {
-      await trackUsage(
-        'cli-interaction',
-        EventClass.INTERACTION,
-        usageTrackingEvent,
-        accountId
-      );
-      logger.debug('Sent usage tracking command event: %o', usageTrackingEvent);
-    } catch (e) {
-      logger.debug('Usage tracking failed: %s', e.message);
+    if (!isTrackingAllowed()) {
+        return;
     }
-  });
+    logger.debug('Attempting to track usage of "%s" command', command);
+    let authType = 'unknown';
+    if (accountId) {
+        const accountConfig = getAccountConfig(accountId);
+        authType =
+            accountConfig && accountConfig.authType
+                ? accountConfig.authType
+                : API_KEY_AUTH_METHOD.value;
+    }
+    setImmediate(async () => {
+        const usageTrackingEvent = {
+            action: 'cli-command',
+            os: getPlatform(),
+            ...getNodeVersionData(),
+            version,
+            command,
+            authType,
+            ...meta,
+        };
+        try {
+            await trackUsage('cli-interaction', EventClass.INTERACTION, usageTrackingEvent, accountId);
+            logger.debug('Sent usage tracking command event: %o', usageTrackingEvent);
+        }
+        catch (e) {
+            logger.debug('Usage tracking failed: %s', e.message);
+        }
+    });
 }
-
 async function trackHelpUsage(command) {
-  if (!isTrackingAllowed()) {
-    return;
-  }
-  try {
-    if (command) {
-      logger.debug('Tracking help usage of "%s" sub-command', command);
-    } else {
-      logger.debug('Tracking help usage of main command');
+    if (!isTrackingAllowed()) {
+        return;
+    }
+    try {
+        if (command) {
+            logger.debug('Tracking help usage of "%s" sub-command', command);
+        }
+        else {
+            logger.debug('Tracking help usage of main command');
+        }
+        await trackUsage('cli-interaction', EventClass.INTERACTION, {
+            action: 'cli-help',
+            os: getPlatform(),
+            ...getNodeVersionData(),
+            version,
+            command,
+        });
+    }
+    catch (e) {
+        logger.debug('Usage tracking failed: %s', e.message);
     }
-    await trackUsage('cli-interaction', EventClass.INTERACTION, {
-      action: 'cli-help',
-      os: getPlatform(),
-      ...getNodeVersionData(),
-      version,
-      command,
-    });
-  } catch (e) {
-    logger.debug('Usage tracking failed: %s', e.message);
-  }
 }
-
 async function trackConvertFieldsUsage(command) {
-  if (!isTrackingAllowed()) {
-    return;
-  }
-  try {
-    logger.debug('Attempting to track usage of "%s" command', command);
-    await trackUsage('cli-interaction', EventClass.INTERACTION, {
-      action: 'cli-process-fields',
-      os: getPlatform(),
-      ...getNodeVersionData(),
-      version,
-      command,
-    });
-  } catch (e) {
-    logger.debug('Usage tracking failed: %s', e.message);
-  }
+    if (!isTrackingAllowed()) {
+        return;
+    }
+    try {
+        logger.debug('Attempting to track usage of "%s" command', command);
+        await trackUsage('cli-interaction', EventClass.INTERACTION, {
+            action: 'cli-process-fields',
+            os: getPlatform(),
+            ...getNodeVersionData(),
+            version,
+            command,
+        });
+    }
+    catch (e) {
+        logger.debug('Usage tracking failed: %s', e.message);
+    }
 }
-
 const addHelpUsageTracking = (program, command) => {
-  program.on('--help', () => {
-    setLogLevel(program);
-    trackHelpUsage(command);
-  });
+    program.on('--help', () => {
+        setLogLevel(program);
+        trackHelpUsage(command);
+    });
 };
-
 const trackAuthAction = async (command, authType, step, accountId) => {
-  if (!isTrackingAllowed()) {
-    return;
-  }
-  const usageTrackingEvent = {
-    action: 'cli-auth',
-    os: getPlatform(),
-    ...getNodeVersionData(),
-    version,
-    command,
-    authType,
-    step,
-  };
-  try {
-    await trackUsage(
-      'cli-interaction',
-      EventClass.INTERACTION,
-      usageTrackingEvent,
-      accountId
-    );
-
-    logger.debug('Sent usage tracking command event: %o', usageTrackingEvent);
-  } catch (e) {
-    logger.debug('Auth action tracking failed: %s', e.message);
-  }
-};
-
-function trackCommandMetadataUsage(command, meta = {}, accountId) {
-  if (!isTrackingAllowed()) {
-    return;
-  }
-  logger.debug('Attempting to track metadata usage of "%s" command', command);
-  let authType = 'unknown';
-  if (accountId) {
-    const accountConfig = getAccountConfig(accountId);
-    authType =
-      accountConfig && accountConfig.authType
-        ? accountConfig.authType
-        : API_KEY_AUTH_METHOD.value;
-  }
-  setImmediate(async () => {
+    if (!isTrackingAllowed()) {
+        return;
+    }
     const usageTrackingEvent = {
-      action: 'cli-command-metadata',
-      os: getPlatform(),
-      ...getNodeVersionData(),
-      version,
-      command,
-      authType,
-      ...meta,
+        action: 'cli-auth',
+        os: getPlatform(),
+        ...getNodeVersionData(),
+        version,
+        command,
+        authType,
+        step,
     };
     try {
-      await trackUsage(
-        'cli-interaction',
-        EventClass.INTERACTION,
-        usageTrackingEvent,
-        accountId
-      );
-      logger.debug('Sent usage tracking command event: %o', usageTrackingEvent);
-    } catch (e) {
-      logger.debug('Metadata usage tracking failed: %s', e.message);
+        await trackUsage('cli-interaction', EventClass.INTERACTION, usageTrackingEvent, accountId);
+        logger.debug('Sent usage tracking command event: %o', usageTrackingEvent);
+    }
+    catch (e) {
+        logger.debug('Auth action tracking failed: %s', e.message);
     }
-  });
+};
+function trackCommandMetadataUsage(command, meta = {}, accountId) {
+    if (!isTrackingAllowed()) {
+        return;
+    }
+    logger.debug('Attempting to track metadata usage of "%s" command', command);
+    let authType = 'unknown';
+    if (accountId) {
+        const accountConfig = getAccountConfig(accountId);
+        authType =
+            accountConfig && accountConfig.authType
+                ? accountConfig.authType
+                : API_KEY_AUTH_METHOD.value;
+    }
+    setImmediate(async () => {
+        const usageTrackingEvent = {
+            action: 'cli-command-metadata',
+            os: getPlatform(),
+            ...getNodeVersionData(),
+            version,
+            command,
+            authType,
+            ...meta,
+        };
+        try {
+            await trackUsage('cli-interaction', EventClass.INTERACTION, usageTrackingEvent, accountId);
+            logger.debug('Sent usage tracking command event: %o', usageTrackingEvent);
+        }
+        catch (e) {
+            logger.debug('Metadata usage tracking failed: %s', e.message);
+        }
+    });
 }
-
 module.exports = {
-  trackCommandUsage,
-  trackHelpUsage,
-  addHelpUsageTracking,
-  trackConvertFieldsUsage,
-  trackAuthAction,
-  trackCommandMetadataUsage,
+    trackCommandUsage,
+    trackHelpUsage,
+    addHelpUsageTracking,
+    trackConvertFieldsUsage,
+    trackAuthAction,
+    trackCommandMetadataUsage,
 };

package/lib/validation.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @param {object} command options
+ * @returns {boolean}
+ */
+export function validateMode(options: any): boolean;
+/**
+ * Validate that an account was passed to the command and that the account's configuration is valid
+ *
+ *
+ * @param {object} command options
+ * @returns {boolean}
+ */
+export function validateAccount(options: any): boolean;
+export function checkAndConvertToJson(_path: any): any;
+export function fileExists(_path: any): boolean;
+export function loadAndValidateOptions(options: any, shouldValidateAccount?: boolean): Promise<void>;