@hubspot/cli 6.2.0 → 6.2.2-experimental.0

package/lib/projectLogsManager.js

@@ -1,143 +1,89 @@
+"use strict";
 const { getProjectConfig, ensureProjectExists } = require('./projects');
-const {
-  fetchProjectComponentsMetadata,
-} = require('@hubspot/local-dev-lib/api/projects');
+const { fetchProjectComponentsMetadata, } = require('@hubspot/local-dev-lib/api/projects');
 const { i18n } = require('./lang');
 const { uiLink } = require('./ui');
-
 const i18nKey = 'commands.project.subcommands.logs';
-
 class ProjectLogsManager {
-  reset() {
-    Object.keys(this).forEach(key => {
-      if (Object.hasOwn(this, key)) {
-        this[key] = undefined;
-      }
-    });
-  }
-
-  async init(accountId) {
-    const { projectConfig } = await getProjectConfig();
-
-    if (!projectConfig || !projectConfig.name) {
-      throw new Error(i18n(`${i18nKey}.errors.noProjectConfig`));
+    reset() {
+        Object.keys(this).forEach(key => {
+            if (Object.hasOwn(this, key)) {
+                this[key] = undefined;
+            }
+        });
     }
-
-    const { name: projectName } = projectConfig;
-
-    this.projectName = projectName;
-    this.accountId = accountId;
-    this.functions = [];
-
-    const { project } = await ensureProjectExists(
-      this.accountId,
-      this.projectName,
-      {
-        allowCreate: false,
-      }
-    );
-
-    if (
-      !project ||
-      !project.deployedBuild ||
-      !project.deployedBuild.subbuildStatuses
-    ) {
-      throw new Error(i18n(`${i18nKey}.errors.failedToFetchProjectDetails`));
-    }
-
-    this.projectId = project.id;
-    await this.fetchFunctionDetails();
-  }
-
-  async fetchFunctionDetails() {
-    if (!this.projectId) {
-      throw new Error(i18n(`${i18nKey}.errors.noProjectConfig`));
-    }
-
-    const {
-      data: { topLevelComponentMetadata },
-    } = await fetchProjectComponentsMetadata(this.accountId, this.projectId);
-
-    const apps = topLevelComponentMetadata.filter(componentMetadata => {
-      const { type } = componentMetadata;
-      return type && type.name === 'PRIVATE_APP';
-    });
-
-    if (!this.functions) {
-      this.functions = [];
-    }
-
-    apps.forEach(app => {
-      this.functions.push(
-        ...app.featureComponents.filter(
-          component => component.type.name === 'APP_FUNCTION'
-        )
-      );
-    });
-
-    if (this.functions.length === 0) {
-      throw new Error(
-        i18n(`${i18nKey}.errors.noFunctionsInProject`, {
-          link: uiLink(
-            i18n(`${i18nKey}.errors.noFunctionsLinkText`),
-            'https://developers.hubspot.com/docs/platform/serverless-functions'
-          ),
-        })
-      );
-    }
-  }
-
-  getFunctionNames() {
-    if (!this.functions) {
-      return [];
-    }
-    return this.functions.map(
-      serverlessFunction => serverlessFunction.componentName
-    );
-  }
-
-  setFunction(functionName) {
-    if (!this.functions) {
-      throw new Error(
-        i18n(`${i18nKey}.errors.noFunctionsInProject`, {
-          link: uiLink(
-            i18n(`${i18nKey}.errors.noFunctionsLinkText`),
-            'https://developers.hubspot.com/docs/platform/serverless-functions'
-          ),
-        }),
-        {
-          projectName: this.projectName,
+    async init(accountId) {
+        const { projectConfig } = await getProjectConfig();
+        if (!projectConfig || !projectConfig.name) {
+            throw new Error(i18n(`${i18nKey}.errors.noProjectConfig`));
+        }
+        const { name: projectName } = projectConfig;
+        this.projectName = projectName;
+        this.accountId = accountId;
+        this.functions = [];
+        const { project } = await ensureProjectExists(this.accountId, this.projectName, {
+            allowCreate: false,
+        });
+        if (!project ||
+            !project.deployedBuild ||
+            !project.deployedBuild.subbuildStatuses) {
+            throw new Error(i18n(`${i18nKey}.errors.failedToFetchProjectDetails`));
         }
-      );
+        this.projectId = project.id;
+        await this.fetchFunctionDetails();
     }
-
-    this.selectedFunction = this.functions.find(
-      serverlessFunction => serverlessFunction.componentName === functionName
-    );
-
-    if (!this.selectedFunction) {
-      throw new Error(
-        i18n(`${i18nKey}.errors.noFunctionWithName`, { name: functionName })
-      );
+    async fetchFunctionDetails() {
+        if (!this.projectId) {
+            throw new Error(i18n(`${i18nKey}.errors.noProjectConfig`));
+        }
+        const { data: { topLevelComponentMetadata }, } = await fetchProjectComponentsMetadata(this.accountId, this.projectId);
+        const apps = topLevelComponentMetadata.filter(componentMetadata => {
+            const { type } = componentMetadata;
+            return type && type.name === 'PRIVATE_APP';
+        });
+        if (!this.functions) {
+            this.functions = [];
+        }
+        apps.forEach(app => {
+            this.functions.push(...app.featureComponents.filter(component => component.type.name === 'APP_FUNCTION'));
+        });
+        if (this.functions.length === 0) {
+            throw new Error(i18n(`${i18nKey}.errors.noFunctionsInProject`, {
+                link: uiLink(i18n(`${i18nKey}.errors.noFunctionsLinkText`), 'https://developers.hubspot.com/docs/platform/serverless-functions'),
+            }));
+        }
     }
-
-    this.functionName = functionName;
-
-    if (!this.selectedFunction.deployOutput) {
-      throw new Error(
-        i18n(`${i18nKey}.errors.functionNotDeployed`, { name: functionName })
-      );
+    getFunctionNames() {
+        if (!this.functions) {
+            return [];
+        }
+        return this.functions.map(serverlessFunction => serverlessFunction.componentName);
     }
-    this.appId = this.selectedFunction.deployOutput.appId;
-
-    if (this.selectedFunction.deployOutput.endpoint) {
-      this.endpointName = this.selectedFunction.deployOutput.endpoint.path;
-      this.method = this.selectedFunction.deployOutput.endpoint.method;
-      this.isPublicFunction = true;
-    } else {
-      this.isPublicFunction = false;
+    setFunction(functionName) {
+        if (!this.functions) {
+            throw new Error(i18n(`${i18nKey}.errors.noFunctionsInProject`, {
+                link: uiLink(i18n(`${i18nKey}.errors.noFunctionsLinkText`), 'https://developers.hubspot.com/docs/platform/serverless-functions'),
+            }), {
+                projectName: this.projectName,
+            });
+        }
+        this.selectedFunction = this.functions.find(serverlessFunction => serverlessFunction.componentName === functionName);
+        if (!this.selectedFunction) {
+            throw new Error(i18n(`${i18nKey}.errors.noFunctionWithName`, { name: functionName }));
+        }
+        this.functionName = functionName;
+        if (!this.selectedFunction.deployOutput) {
+            throw new Error(i18n(`${i18nKey}.errors.functionNotDeployed`, { name: functionName }));
+        }
+        this.appId = this.selectedFunction.deployOutput.appId;
+        if (this.selectedFunction.deployOutput.endpoint) {
+            this.endpointName = this.selectedFunction.deployOutput.endpoint.path;
+            this.method = this.selectedFunction.deployOutput.endpoint.method;
+            this.isPublicFunction = true;
+        }
+        else {
+            this.isPublicFunction = false;
+        }
     }
-  }
 }
-
 module.exports = new ProjectLogsManager();

package/lib/projectStructure.d.ts

@@ -0,0 +1,13 @@
+export const CONFIG_FILES: {
+    "private-app": string;
+    "public-app": string;
+    "hubl-theme": string;
+};
+export const COMPONENT_TYPES: Readonly<{
+    privateApp: "private-app";
+    publicApp: "public-app";
+    hublTheme: "hubl-theme";
+}>;
+export function findProjectComponents(projectSourceDir: any): Promise<any[]>;
+export function getAppCardConfigs(appConfig: any, appPath: any): any[];
+export function getProjectComponentTypes(components: any): {};

package/lib/projectStructure.js

@@ -1,136 +1,114 @@
+"use strict";
 const fs = require('fs');
 const path = require('path');
 const { walk } = require('@hubspot/local-dev-lib/fs');
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { logError } = require('./errorHandlers/index');
-
 const COMPONENT_TYPES = Object.freeze({
-  privateApp: 'private-app',
-  publicApp: 'public-app',
-  hublTheme: 'hubl-theme',
+    privateApp: 'private-app',
+    publicApp: 'public-app',
+    hublTheme: 'hubl-theme',
 });
-
 const CONFIG_FILES = {
-  [COMPONENT_TYPES.privateApp]: 'app.json',
-  [COMPONENT_TYPES.publicApp]: 'public-app.json',
-  [COMPONENT_TYPES.hublTheme]: 'theme.json',
+    [COMPONENT_TYPES.privateApp]: 'app.json',
+    [COMPONENT_TYPES.publicApp]: 'public-app.json',
+    [COMPONENT_TYPES.hublTheme]: 'theme.json',
 };
-
 function getTypeFromConfigFile(configFile) {
-  for (let key in CONFIG_FILES) {
-    if (CONFIG_FILES[key] === configFile) {
-      return key;
+    for (let key in CONFIG_FILES) {
+        if (CONFIG_FILES[key] === configFile) {
+            return key;
+        }
     }
-  }
-  return null;
+    return null;
 }
-
 function loadConfigFile(configPath) {
-  if (configPath) {
-    try {
-      const source = fs.readFileSync(configPath);
-      const parsedConfig = JSON.parse(source);
-      return parsedConfig;
-    } catch (e) {
-      logger.debug(e);
+    if (configPath) {
+        try {
+            const source = fs.readFileSync(configPath);
+            const parsedConfig = JSON.parse(source);
+            return parsedConfig;
+        }
+        catch (e) {
+            logger.debug(e);
+        }
     }
-  }
-  return null;
+    return null;
 }
-
 function getAppCardConfigs(appConfig, appPath) {
-  let cardConfigs = [];
-  let cards;
-
-  if (appConfig && appConfig.extensions && appConfig.extensions.crm) {
-    cards = appConfig.extensions.crm.cards;
-  }
-
-  if (cards) {
-    cards.forEach(({ file }) => {
-      if (typeof file === 'string') {
-        const cardConfigPath = path.join(appPath, file);
-        const cardConfig = loadConfigFile(cardConfigPath);
-
-        if (cardConfig) {
-          cardConfigs.push(cardConfig);
-        }
-      }
-    });
-  }
-
-  return cardConfigs;
+    let cardConfigs = [];
+    let cards;
+    if (appConfig && appConfig.extensions && appConfig.extensions.crm) {
+        cards = appConfig.extensions.crm.cards;
+    }
+    if (cards) {
+        cards.forEach(({ file }) => {
+            if (typeof file === 'string') {
+                const cardConfigPath = path.join(appPath, file);
+                const cardConfig = loadConfigFile(cardConfigPath);
+                if (cardConfig) {
+                    cardConfigs.push(cardConfig);
+                }
+            }
+        });
+    }
+    return cardConfigs;
 }
-
 function getIsLegacyApp(appConfig, appPath) {
-  const cardConfigs = getAppCardConfigs(appConfig, appPath);
-
-  if (!cardConfigs.length) {
-    // Assume any app that does not have any cards is not legacy
-    return false;
-  }
-
-  let hasAnyReactExtensions = false;
-
-  cardConfigs.forEach(cardConfig => {
-    if (!hasAnyReactExtensions) {
-      const isReactExtension =
-        cardConfig &&
-        !!cardConfig.data &&
-        !!cardConfig.data.module &&
-        !!cardConfig.data.module.file;
-
-      hasAnyReactExtensions = isReactExtension;
+    const cardConfigs = getAppCardConfigs(appConfig, appPath);
+    if (!cardConfigs.length) {
+        // Assume any app that does not have any cards is not legacy
+        return false;
     }
-  });
-
-  return !hasAnyReactExtensions;
+    let hasAnyReactExtensions = false;
+    cardConfigs.forEach(cardConfig => {
+        if (!hasAnyReactExtensions) {
+            const isReactExtension = cardConfig &&
+                !!cardConfig.data &&
+                !!cardConfig.data.module &&
+                !!cardConfig.data.module.file;
+            hasAnyReactExtensions = isReactExtension;
+        }
+    });
+    return !hasAnyReactExtensions;
 }
-
 async function findProjectComponents(projectSourceDir) {
-  const components = [];
-  let projectFiles = [];
-
-  try {
-    projectFiles = await walk(projectSourceDir);
-  } catch (e) {
-    logError(e);
-  }
-
-  projectFiles.forEach(projectFile => {
-    // Find app components
-    const { base, dir } = path.parse(projectFile);
-
-    if (Object.values(CONFIG_FILES).includes(base)) {
-      const parsedAppConfig = loadConfigFile(projectFile);
-
-      if (parsedAppConfig) {
-        const isLegacy = getIsLegacyApp(parsedAppConfig, dir);
-        const isHublTheme = base === CONFIG_FILES[COMPONENT_TYPES.hublTheme];
-
-        components.push({
-          type: getTypeFromConfigFile(base),
-          config: parsedAppConfig,
-          runnable: !isLegacy && !isHublTheme,
-          path: dir,
-        });
-      }
+    const components = [];
+    let projectFiles = [];
+    try {
+        projectFiles = await walk(projectSourceDir);
+    }
+    catch (e) {
+        logError(e);
     }
-  });
-
-  return components;
+    projectFiles.forEach(projectFile => {
+        // Find app components
+        const { base, dir } = path.parse(projectFile);
+        if (Object.values(CONFIG_FILES).includes(base)) {
+            const parsedAppConfig = loadConfigFile(projectFile);
+            if (parsedAppConfig) {
+                const isLegacy = getIsLegacyApp(parsedAppConfig, dir);
+                const isHublTheme = base === CONFIG_FILES[COMPONENT_TYPES.hublTheme];
+                components.push({
+                    type: getTypeFromConfigFile(base),
+                    config: parsedAppConfig,
+                    runnable: !isLegacy && !isHublTheme,
+                    path: dir,
+                });
+            }
+        }
+    });
+    return components;
 }
-
 function getProjectComponentTypes(components) {
-  const projectContents = {};
-  components.forEach(({ type }) => (projectContents[type] = true));
-  return projectContents;
+    const projectContents = {};
+    components.forEach(({ type }) => (projectContents[type] = true));
+    return projectContents;
 }
-
 module.exports = {
-  CONFIG_FILES,
-  COMPONENT_TYPES,
-  findProjectComponents,
-  getAppCardConfigs,
-  getProjectComponentTypes,
+    CONFIG_FILES,
+    COMPONENT_TYPES,
+    findProjectComponents,
+    getAppCardConfigs,
+    getProjectComponentTypes,
 };

package/lib/projects.d.ts

@@ -0,0 +1,40 @@
+export function writeProjectConfig(configPath: any, config: any): boolean;
+export function getProjectConfig(_dir: any): Promise<{
+    projectConfig: null;
+    projectDir: null;
+} | {
+    projectDir: string;
+    projectConfig: any;
+} | undefined>;
+export function getIsInProject(_dir: any): boolean;
+export function pollProjectBuildAndDeploy(accountId: any, projectConfig: any, tempFile: any, buildId: any, silenceLogs?: boolean): Promise<{
+    succeeded: boolean;
+    buildId: any;
+    buildResult: any;
+    deployResult: null;
+}>;
+export function handleProjectUpload(accountId: any, projectConfig: any, projectDir: any, callbackFunc: any, uploadMessage: any): Promise<any>;
+export function createProjectConfig(projectPath: any, projectName: any, template: any, templateSource: any, githubRef: any): Promise<boolean>;
+export function validateProjectConfig(projectConfig: any, projectDir: any): undefined;
+export function getProjectHomeUrl(accountId: any): string;
+export function getProjectDetailUrl(projectName: any, accountId: any): string | undefined;
+export function getProjectBuildDetailUrl(projectName: any, buildId: any, accountId: any): string | undefined;
+export function pollBuildStatus(accountId: any, taskName: any, taskId: any, deployedBuildId?: null, silenceLogs?: boolean): Promise<any>;
+export function pollDeployStatus(accountId: any, taskName: any, taskId: any, deployedBuildId?: null, silenceLogs?: boolean): Promise<any>;
+export function ensureProjectExists(accountId: any, projectName: any, { forceCreate, allowCreate, noLogs, withPolling, uploadCommand, }?: {
+    forceCreate?: boolean | undefined;
+    allowCreate?: boolean | undefined;
+    noLogs?: boolean | undefined;
+    withPolling?: boolean | undefined;
+    uploadCommand?: boolean | undefined;
+}): Promise<void | {
+    projectExists: boolean;
+    project: any;
+} | {
+    projectExists: boolean;
+    project?: undefined;
+}>;
+export function logFeedbackMessage(buildId: any): void;
+export function createProjectComponent(component: any, name: any, projectComponentsVersion: any): Promise<void>;
+export function displayWarnLogs(accountId: any, projectName: any, taskId: any, isDeploy?: boolean): Promise<void>;
+export function getProjectComponentsByVersion(projectComponentsVersion: any): Promise<any>;