@hubspot/cli 6.2.1 → 6.2.2-beta.0

package/commands/create/website-theme.js

@@ -1,20 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
 const { cloneGithubRepo } = require('@hubspot/local-dev-lib/github');
 const { getIsInProject } = require('../../lib/projects');
-
 const PROJECT_BOILERPLATE_BRANCH = 'cms-boilerplate-developer-projects';
-
 module.exports = {
-  dest: ({ name, assetType }) => name || assetType,
-  execute: async ({ dest, assetType, options }) => {
-    const isInProject = await getIsInProject(dest);
-
-    if (isInProject) {
-      options.branch = PROJECT_BOILERPLATE_BRANCH;
-    }
-    cloneGithubRepo('HubSpot/cms-theme-boilerplate', dest, {
-      type: assetType,
-      sourceDir: 'src',
-      ...options,
-    });
-  },
+    dest: ({ name, assetType }) => name || assetType,
+    execute: async ({ dest, assetType, options }) => {
+        const isInProject = await getIsInProject(dest);
+        if (isInProject) {
+            options.branch = PROJECT_BOILERPLATE_BRANCH;
+        }
+        cloneGithubRepo('HubSpot/cms-theme-boilerplate', dest, {
+            type: assetType,
+            sourceDir: 'src',
+            ...options,
+        });
+    },
 };

package/commands/create.d.ts

@@ -0,0 +1,24 @@
+/**
+ * To add a new asset type: See vue-app.js for a simple example
+ * 1. Create a new file under the `create` directory with the command name being the name of the file
+ * 2. The file _must_ export a `dest` function and an `execute` function.  See below for details
+ * Note: No changes should be needed to this file when adding new types, unless you need new functionality
+ *
+ * @export {(Data) => String} dest - A function returning the destination of the asset we are creating
+ * @export {(Data) => Object=} execute - The code called once all other checks pass. This should contain the logic
+ *                                       for handling your command.  Optionally return an object containing KV pairs
+ *                                       of any context or data you want passed along to usage tracking
+ * @export {Boolean=} hidden - If true, the command will not show up in --help
+ * @export {(Data) => Boolean=} validate - If provided, return true if it passes validation, false otherwise.
+ *                                         If not provided, validation will automatically succeed
+ *
+ * The Data object contains
+ * {
+ *   assetType: String - Type of the asset (e.g. api-sample, react-app, template)
+ *   name:      String - Filename of the asset
+ *   dest:      String - The path specified by the user on where to create the asset
+ *   internal:  Boolean - A flag for retrieving the internal spec for the asset type
+ *   options:   Object - The options object passed to the command by Yargs
+ * }
+ */
+export {};

package/commands/create.js

@@ -1,3 +1,5 @@
+"use strict";
+// @ts-nocheck
 /**
  * To add a new asset type: See vue-app.js for a simple example
  * 1. Create a new file under the `create` directory with the command name being the name of the file
@@ -21,7 +23,7 @@
  *   options:   Object - The options object passed to the command by Yargs
  * }
  */
-
+Object.defineProperty(exports, "__esModule", { value: true });
 const fs = require('fs-extra');
 const { logError } = require('../lib/errorHandlers/index');
 const { logger } = require('@hubspot/local-dev-lib/logger');
@@ -31,90 +33,73 @@ const { resolveLocalPath } = require('../lib/filesystem');
 const { trackCommandUsage } = require('../lib/usageTracking');
 const assets = require('./create/index');
 const { i18n } = require('../lib/lang');
-
 const i18nKey = 'commands.create';
-
 const SUPPORTED_ASSET_TYPES = Object.keys(assets)
-  .filter(t => !assets[t].hidden)
-  .join(', ');
-
+    .filter(t => !assets[t].hidden)
+    .join(', ');
 exports.command = 'create <type> [name] [dest] [--internal]';
 exports.describe = i18n(`${i18nKey}.describe`, {
-  supportedAssetTypes: SUPPORTED_ASSET_TYPES,
+    supportedAssetTypes: SUPPORTED_ASSET_TYPES,
 });
-
-exports.handler = async options => {
-  let { type: assetType, name, dest, internal: getInternalVersion } = options;
-
-  setLogLevel(options);
-  logDebugInfo(options);
-  assetType = typeof assetType === 'string' && assetType.toLowerCase();
-
-  if (assetType === 'global-partial') {
-    logger.error(
-      i18n(`${i18nKey}.errors.deprecatedAssetType`, {
-        assetType,
-        newCommand: 'hs create template',
-        type: 'global partial',
-      })
-    );
-    return;
-  }
-
-  if (!assetType || !assets[assetType]) {
-    logger.error(
-      i18n(`${i18nKey}.errors.unsupportedAssetType`, {
-        assetType,
-        supportedAssetTypes: SUPPORTED_ASSET_TYPES,
-      })
-    );
-    return;
-  }
-
-  const asset = assets[assetType];
-  const argsToPass = { assetType, name, dest, getInternalVersion, options };
-  dest = argsToPass.dest = resolveLocalPath(asset.dest(argsToPass));
-
-  trackCommandUsage('create', { assetType }, getAccountId(options));
-
-  try {
-    await fs.ensureDir(dest);
-  } catch (e) {
-    logger.error(
-      i18n(`${i18nKey}.errors.unusablePath`, {
-        path: dest,
-      })
-    );
-    logError(e, {
-      filepath: dest,
-      operation: 'write',
-    });
-    return;
-  }
-
-  if (asset.validate && !asset.validate(argsToPass)) return;
-
-  await asset.execute(argsToPass);
+exports.handler = async (options) => {
+    let { type: assetType, dest } = options;
+    const { name, internal: getInternalVersion } = options;
+    setLogLevel(options);
+    logDebugInfo(options);
+    assetType = typeof assetType === 'string' && assetType.toLowerCase();
+    if (assetType === 'global-partial') {
+        logger.error(i18n(`${i18nKey}.errors.deprecatedAssetType`, {
+            assetType,
+            newCommand: 'hs create template',
+            type: 'global partial',
+        }));
+        return;
+    }
+    if (!assetType || !assets[assetType]) {
+        logger.error(i18n(`${i18nKey}.errors.unsupportedAssetType`, {
+            assetType,
+            supportedAssetTypes: SUPPORTED_ASSET_TYPES,
+        }));
+        return;
+    }
+    const asset = assets[assetType];
+    const argsToPass = { assetType, name, dest, getInternalVersion, options };
+    dest = argsToPass.dest = resolveLocalPath(asset.dest(argsToPass));
+    trackCommandUsage('create', { assetType }, getAccountId(options));
+    try {
+        await fs.ensureDir(dest);
+    }
+    catch (e) {
+        logger.error(i18n(`${i18nKey}.errors.unusablePath`, {
+            path: dest,
+        }));
+        logError(e, {
+            filepath: dest,
+            operation: 'write',
+        });
+        return;
+    }
+    if (asset.validate && !asset.validate(argsToPass))
+        return;
+    await asset.execute(argsToPass);
 };
-
 exports.builder = yargs => {
-  yargs.positional('type', {
-    describe: i18n(`${i18nKey}.positionals.type.describe`),
-    type: 'string',
-  });
-  yargs.positional('name', {
-    describe: i18n(`${i18nKey}.positionals.name.describe`),
-    type: 'string',
-  });
-  yargs.positional('dest', {
-    describe: i18n(`${i18nKey}.positionals.dest.describe`),
-    type: 'string',
-  });
-  yargs.option('internal', {
-    describe: 'Internal HubSpot version of creation command',
-    type: 'boolean',
-    hidden: true,
-  });
-
-  return yargs;
+    yargs.positional('type', {
+        describe: i18n(`${i18nKey}.positionals.type.describe`),
+        type: 'string',
+    });
+    yargs.positional('name', {
+        describe: i18n(`${i18nKey}.positionals.name.describe`),
+        type: 'string',
+    });
+    yargs.positional('dest', {
+        describe: i18n(`${i18nKey}.positionals.dest.describe`),
+        type: 'string',
+    });
+    yargs.option('internal', {
+        describe: 'Internal HubSpot version of creation command',
+        type: 'boolean',
+        hidden: true,
+    });
+    return yargs;
 };

package/commands/customObject/create.d.ts

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

package/commands/customObject/create.js

@@ -1,60 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { logError } = require('../../lib/errorHandlers/index');
 const { getAbsoluteFilePath } = require('@hubspot/local-dev-lib/path');
-const {
-  checkAndConvertToJson,
-  loadAndValidateOptions,
-} = require('../../lib/validation');
+const { checkAndConvertToJson, loadAndValidateOptions, } = require('../../lib/validation');
 const { trackCommandUsage } = require('../../lib/usageTracking');
 const { getAccountId } = require('../../lib/commonOpts');
-const {
-  batchCreateObjects,
-} = require('@hubspot/local-dev-lib/api/customObjects');
+const { batchCreateObjects, } = require('@hubspot/local-dev-lib/api/customObjects');
 const { i18n } = require('../../lib/lang');
-
 const i18nKey = 'commands.customObject.subcommands.create';
 const { EXIT_CODES } = require('../../lib/enums/exitCodes');
-
 exports.command = 'create <name> <definition>';
 exports.describe = i18n(`${i18nKey}.describe`);
-
-exports.handler = async options => {
-  const { definition, name } = options;
-
-  await loadAndValidateOptions(options);
-
-  const accountId = getAccountId(options);
-
-  trackCommandUsage('custom-object-batch-create', null, accountId);
-
-  const filePath = getAbsoluteFilePath(definition);
-  const objectJson = checkAndConvertToJson(filePath);
-
-  if (!objectJson) {
-    process.exit(EXIT_CODES.ERROR);
-  }
-
-  try {
-    await batchCreateObjects(accountId, name, objectJson);
-    logger.success(i18n(`${i18nKey}.success.objectsCreated`));
-  } catch (e) {
-    logError(e, { accountId });
-    logger.error(
-      i18n(`${i18nKey}.errors.creationFailed`, {
-        definition,
-      })
-    );
-  }
+exports.handler = async (options) => {
+    const { definition, name } = options;
+    await loadAndValidateOptions(options);
+    const accountId = getAccountId(options);
+    trackCommandUsage('custom-object-batch-create', null, accountId);
+    const filePath = getAbsoluteFilePath(definition);
+    const objectJson = checkAndConvertToJson(filePath);
+    if (!objectJson) {
+        process.exit(EXIT_CODES.ERROR);
+    }
+    try {
+        await batchCreateObjects(accountId, name, objectJson);
+        logger.success(i18n(`${i18nKey}.success.objectsCreated`));
+    }
+    catch (e) {
+        logError(e, { accountId });
+        logger.error(i18n(`${i18nKey}.errors.creationFailed`, {
+            definition,
+        }));
+    }
 };
-
 exports.builder = yargs => {
-  yargs.positional('name', {
-    describe: i18n(`${i18nKey}.positionals.name.describe`),
-    type: 'string',
-  });
-
-  yargs.positional('definition', {
-    describe: i18n(`${i18nKey}.positionals.definition.describe`),
-    type: 'string',
-  });
+    yargs.positional('name', {
+        describe: i18n(`${i18nKey}.positionals.name.describe`),
+        type: 'string',
+    });
+    yargs.positional('definition', {
+        describe: i18n(`${i18nKey}.positionals.definition.describe`),
+        type: 'string',
+    });
 };

package/commands/customObject/schema/create.d.ts

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

package/commands/customObject/schema/create.js

@@ -1,83 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { logError } = require('../../../lib/errorHandlers/index');
 const { getAbsoluteFilePath } = require('@hubspot/local-dev-lib/path');
-const {
-  checkAndConvertToJson,
-  loadAndValidateOptions,
-} = require('../../../lib/validation');
+const { checkAndConvertToJson, loadAndValidateOptions, } = require('../../../lib/validation');
 const { trackCommandUsage } = require('../../../lib/usageTracking');
 const { addTestingOptions, getAccountId } = require('../../../lib/commonOpts');
-const {
-  getEnv,
-  isConfigFlagEnabled,
-} = require('@hubspot/local-dev-lib/config');
-const {
-  ENVIRONMENTS,
-} = require('@hubspot/local-dev-lib/constants/environments');
+const { getEnv, isConfigFlagEnabled, } = require('@hubspot/local-dev-lib/config');
+const { ENVIRONMENTS, } = require('@hubspot/local-dev-lib/constants/environments');
 const { CONFIG_FLAGS } = require('../../../lib/constants');
-const {
-  createObjectSchema,
-} = require('@hubspot/local-dev-lib/api/customObjects');
-const {
-  createSchema: createSchemaFromHubFile,
-} = require('@hubspot/local-dev-lib/api/fileTransport');
+const { createObjectSchema, } = require('@hubspot/local-dev-lib/api/customObjects');
+const { createSchema: createSchemaFromHubFile, } = require('@hubspot/local-dev-lib/api/fileTransport');
 const { getHubSpotWebsiteOrigin } = require('@hubspot/local-dev-lib/urls');
 const { i18n } = require('../../../lib/lang');
-
 const i18nKey = 'commands.customObject.subcommands.schema.subcommands.create';
 const { EXIT_CODES } = require('../../../lib/enums/exitCodes');
-
 exports.command = 'create <definition>';
 exports.describe = i18n(`${i18nKey}.describe`);
-
-exports.handler = async options => {
-  const { definition } = options;
-
-  await loadAndValidateOptions(options);
-
-  const accountId = getAccountId(options);
-
-  trackCommandUsage('custom-object-schema-create', null, accountId);
-
-  const filePath = getAbsoluteFilePath(definition);
-  const schemaJson = checkAndConvertToJson(filePath);
-  if (!schemaJson) {
-    process.exit(EXIT_CODES.ERROR);
-  }
-
-  try {
-    if (isConfigFlagEnabled(CONFIG_FLAGS.USE_CUSTOM_OBJECT_HUBFILE)) {
-      await createSchemaFromHubFile(accountId, filePath);
-      logger.success(
-        i18n(`${i18nKey}.success.schemaCreated`, {
-          accountId,
-        })
-      );
-    } else {
-      const { data } = await createObjectSchema(accountId, schemaJson);
-      logger.success(
-        i18n(`${i18nKey}.success.schemaViewable`, {
-          url: `${getHubSpotWebsiteOrigin(
-            getEnv() === 'qa' ? ENVIRONMENTS.QA : ENVIRONMENTS.PROD
-          )}/contacts/${accountId}/objects/${data.objectTypeId}`,
-        })
-      );
+exports.handler = async (options) => {
+    const { definition } = options;
+    await loadAndValidateOptions(options);
+    const accountId = getAccountId(options);
+    trackCommandUsage('custom-object-schema-create', null, accountId);
+    const filePath = getAbsoluteFilePath(definition);
+    const schemaJson = checkAndConvertToJson(filePath);
+    if (!schemaJson) {
+        process.exit(EXIT_CODES.ERROR);
+    }
+    try {
+        if (isConfigFlagEnabled(CONFIG_FLAGS.USE_CUSTOM_OBJECT_HUBFILE)) {
+            await createSchemaFromHubFile(accountId, filePath);
+            logger.success(i18n(`${i18nKey}.success.schemaCreated`, {
+                accountId,
+            }));
+        }
+        else {
+            const { data } = await createObjectSchema(accountId, schemaJson);
+            logger.success(i18n(`${i18nKey}.success.schemaViewable`, {
+                url: `${getHubSpotWebsiteOrigin(getEnv() === 'qa' ? ENVIRONMENTS.QA : ENVIRONMENTS.PROD)}/contacts/${accountId}/objects/${data.objectTypeId}`,
+            }));
+        }
+    }
+    catch (e) {
+        logError(e, { accountId });
+        logger.error(i18n(`${i18nKey}.errors.creationFailed`, {
+            definition,
+        }));
     }
-  } catch (e) {
-    logError(e, { accountId });
-    logger.error(
-      i18n(`${i18nKey}.errors.creationFailed`, {
-        definition,
-      })
-    );
-  }
 };
-
 exports.builder = yargs => {
-  addTestingOptions(yargs);
-
-  yargs.positional('definition', {
-    describe: i18n(`${i18nKey}.positionals.definition.describe`),
-    type: 'string',
-  });
+    addTestingOptions(yargs);
+    yargs.positional('definition', {
+        describe: i18n(`${i18nKey}.positionals.definition.describe`),
+        type: 'string',
+    });
 };

package/commands/customObject/schema/delete.d.ts

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

package/commands/customObject/schema/delete.js

@@ -1,51 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { loadAndValidateOptions } = require('../../../lib/validation');
 const { trackCommandUsage } = require('../../../lib/usageTracking');
 const { getAccountId } = require('../../../lib/commonOpts');
-const {
-  deleteObjectSchema,
-} = require('@hubspot/local-dev-lib/api/customObjects');
+const { deleteObjectSchema, } = require('@hubspot/local-dev-lib/api/customObjects');
 const { i18n } = require('../../../lib/lang');
 const { logError } = require('../../../lib/errorHandlers');
-
 const i18nKey = 'commands.customObject.subcommands.schema.subcommands.delete';
-
 exports.command = 'delete <name>';
 exports.describe = i18n(`${i18nKey}.describe`);
-
-exports.handler = async options => {
-  let { name } = options;
-
-  await loadAndValidateOptions(options);
-
-  const accountId = getAccountId(options);
-
-  trackCommandUsage('custom-object-schema-delete', null, accountId);
-
-  try {
-    await deleteObjectSchema(accountId, name);
-    logger.success(
-      i18n(`${i18nKey}.success.delete`, {
-        name,
-      })
-    );
-  } catch (e) {
-    logError(e);
-    logger.error(
-      i18n(`${i18nKey}.errors.delete`, {
-        name,
-      })
-    );
-  }
+exports.handler = async (options) => {
+    const { name } = options;
+    await loadAndValidateOptions(options);
+    const accountId = getAccountId(options);
+    trackCommandUsage('custom-object-schema-delete', null, accountId);
+    try {
+        await deleteObjectSchema(accountId, name);
+        logger.success(i18n(`${i18nKey}.success.delete`, {
+            name,
+        }));
+    }
+    catch (e) {
+        logError(e);
+        logger.error(i18n(`${i18nKey}.errors.delete`, {
+            name,
+        }));
+    }
 };
-
 exports.builder = yargs => {
-  yargs.example([
-    ['$0 schema delete schemaName', i18n(`${i18nKey}.examples.default`)],
-  ]);
-
-  yargs.positional('name', {
-    describe: i18n(`${i18nKey}.positionals.name.describe`),
-    type: 'string',
-  });
+    yargs.example([
+        ['$0 schema delete schemaName', i18n(`${i18nKey}.examples.default`)],
+    ]);
+    yargs.positional('name', {
+        describe: i18n(`${i18nKey}.positionals.name.describe`),
+        type: 'string',
+    });
 };

package/commands/customObject/schema/fetch-all.d.ts

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

package/commands/customObject/schema/fetch-all.js

@@ -1,52 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { loadAndValidateOptions } = require('../../../lib/validation');
 const { trackCommandUsage } = require('../../../lib/usageTracking');
 const { getAccountId } = require('../../../lib/commonOpts');
-const {
-  downloadSchemas,
-  getResolvedPath,
-} = require('@hubspot/local-dev-lib/customObjects');
+const { downloadSchemas, getResolvedPath, } = require('@hubspot/local-dev-lib/customObjects');
 const { i18n } = require('../../../lib/lang');
 const { logSchemas } = require('../../../lib/schema');
 const { logError } = require('../../../lib/errorHandlers');
-
 const i18nKey = 'commands.customObject.subcommands.schema.subcommands.fetchAll';
-
 exports.command = 'fetch-all [dest]';
 exports.describe = i18n(`${i18nKey}.describe`);
-
-exports.handler = async options => {
-  await loadAndValidateOptions(options);
-
-  const accountId = getAccountId(options);
-
-  trackCommandUsage('custom-object-schema-fetch-all', null, accountId);
-
-  try {
-    const schemas = await downloadSchemas(accountId, options.dest);
-    logSchemas(schemas);
-    logger.success(
-      i18n(`${i18nKey}.success.fetch`, {
-        path: getResolvedPath(options.dest),
-      })
-    );
-  } catch (e) {
-    logError(e);
-    logger.error(i18n(`${i18nKey}.errors.fetch`));
-  }
+exports.handler = async (options) => {
+    await loadAndValidateOptions(options);
+    const accountId = getAccountId(options);
+    trackCommandUsage('custom-object-schema-fetch-all', null, accountId);
+    try {
+        const schemas = await downloadSchemas(accountId, options.dest);
+        logSchemas(schemas);
+        logger.success(i18n(`${i18nKey}.success.fetch`, {
+            path: getResolvedPath(options.dest),
+        }));
+    }
+    catch (e) {
+        logError(e);
+        logger.error(i18n(`${i18nKey}.errors.fetch`));
+    }
 };
-
 exports.builder = yargs => {
-  yargs.example([
-    ['$0 custom-object schema fetch-all', i18n(`${i18nKey}.examples.default`)],
-    [
-      '$0 custom-object schema fetch-all my/folder',
-      i18n(`${i18nKey}.examples.specifyPath`),
-    ],
-  ]);
-
-  yargs.positional('dest', {
-    describe: i18n(`${i18nKey}.positionals.dest.describe`),
-    type: 'string',
-  });
+    yargs.example([
+        ['$0 custom-object schema fetch-all', i18n(`${i18nKey}.examples.default`)],
+        [
+            '$0 custom-object schema fetch-all my/folder',
+            i18n(`${i18nKey}.examples.specifyPath`),
+        ],
+    ]);
+    yargs.positional('dest', {
+        describe: i18n(`${i18nKey}.positionals.dest.describe`),
+        type: 'string',
+    });
 };

package/commands/customObject/schema/fetch.d.ts

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