@hubspot/cli 7.4.0-experimental.0 → 7.4.0

package/lib/middleware/fireAlarmMiddleware.js

@@ -0,0 +1,137 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkFireAlarms = checkFireAlarms;
+const chalk_1 = __importDefault(require("chalk"));
+const fireAlarm_1 = require("@hubspot/local-dev-lib/api/fireAlarm");
+const logger_1 = require("@hubspot/local-dev-lib/logger");
+const errorHandlers_1 = require("../errorHandlers");
+const package_json_1 = __importDefault(require("../../package.json"));
+const ui_1 = require("../ui");
+const lang_1 = require("../lang");
+/*
+ * Versions can be formatted like this:
+ * =7.2.2 -> targets the exact version 7.2.2
+ * =7.2.* -> targets all versions with a major of 7 and a minor of 2
+ * =7.* -> targets all versions with a major of 7
+ * =* -> targets all versions
+ * <=7.2.2 -> targets all versions equal to or less than 7.2.2
+ * <=7.2.* -> targets all versions equal to or less than 7.2
+ */
+const WILDCARD = '*';
+function isVersionTargeted(version, targetVersionString) {
+    // Assume we're targeting no versions if no version string is found
+    // Target all versions using the * wildcard
+    if (!targetVersionString) {
+        return false;
+    }
+    // Only support version targeting for the <= or = operator
+    if (!targetVersionString.startsWith('<=') &&
+        !targetVersionString.startsWith('=')) {
+        return false;
+    }
+    const targetVersion = targetVersionString.substring(targetVersionString.indexOf('=') + 1);
+    // Only allow exact version matching for tagged CLI releases (like -beta)
+    if (version.includes('-') || targetVersionString.includes('-')) {
+        if (!targetVersionString.startsWith('=')) {
+            return false;
+        }
+        return version === targetVersion;
+    }
+    const targetVersionParts = targetVersion.split('.');
+    const versionParts = version.split('.');
+    // Require the wildcard to be explicitly set to target all versions
+    if (versionParts.length < 3 &&
+        versionParts[versionParts.length - 1] !== WILDCARD) {
+        return false;
+    }
+    // Don't allow the less than or equal to operator to be used with the wildcard
+    // in the major version part (e.g. <=*)
+    if (targetVersionString.startsWith('<=') && versionParts[0] === WILDCARD) {
+        return false;
+    }
+    let targetAnyVersion = false;
+    return targetVersionParts.every((targetPart, i) => {
+        const versionPart = versionParts[i];
+        // Support generic version targeting (like 1.2.*)
+        if (targetPart === WILDCARD || targetAnyVersion) {
+            targetAnyVersion = true;
+            return true;
+        }
+        // Double check that the target part is a number
+        if (isNaN(Number(targetPart))) {
+            return false;
+        }
+        return targetVersionString.startsWith('<=')
+            ? Number(versionPart) <= Number(targetPart)
+            : Number(versionPart) === Number(targetPart);
+    });
+}
+function isCommandTargeted(command, targetCommandsString) {
+    // Require the wildcard to be explicitly set to target all commands
+    if (!targetCommandsString) {
+        return false;
+    }
+    if (targetCommandsString === WILDCARD) {
+        return true;
+    }
+    const targetCommands = targetCommandsString.split(',');
+    return targetCommands.some(cmd => command.startsWith(cmd));
+}
+function filterFireAlarm(fireAlarm, command, version) {
+    const commandIsTargeted = isCommandTargeted(command, fireAlarm.querySelector);
+    const versionIsTargeted = isVersionTargeted(version, fireAlarm.urlRegexPattern);
+    return commandIsTargeted && versionIsTargeted;
+}
+async function getFireAlarms(accountId, command, version) {
+    let relevantAlarms = [];
+    try {
+        const { data: fireAlarms } = await (0, fireAlarm_1.fetchFireAlarms)(accountId);
+        relevantAlarms = fireAlarms.filter(fireAlarm => filterFireAlarm(fireAlarm, command, version));
+    }
+    catch (error) {
+        (0, errorHandlers_1.debugError)(error);
+    }
+    return relevantAlarms;
+}
+async function logFireAlarms(accountId, command, version) {
+    const alarms = await getFireAlarms(accountId, command, version);
+    if (alarms.length > 0) {
+        const notifications = alarms.reduce((acc, alarm) => {
+            if (alarm.title && alarm.message) {
+                return (acc +
+                    `${acc.length > 0 ? '\n\n' : ''}${chalk_1.default.bold(alarm.title)}\n${alarm.message}`);
+            }
+            return acc;
+        }, '');
+        let boxen;
+        try {
+            // The boxen package is exported as a module, so we have to use a dynamic import
+            boxen = (await import('boxen')).default;
+        }
+        catch (error) {
+            logger_1.logger.debug(`${(0, lang_1.i18n)('lib.middleware.fireAlarm.failedToLoadBoxen')}`);
+            return;
+        }
+        logger_1.logger.log(boxen(notifications, {
+            title: 'Notifications',
+            titleAlignment: 'left',
+            borderColor: ui_1.UI_COLORS.MARIGOLD,
+            margin: 1,
+            padding: 1,
+            textAlignment: 'left',
+            borderStyle: 'round',
+        }));
+    }
+}
+async function checkFireAlarms(args) {
+    const { derivedAccountId } = args;
+    try {
+        await logFireAlarms(derivedAccountId, args._.join(' '), package_json_1.default.version);
+    }
+    catch (error) {
+        (0, errorHandlers_1.debugError)(error);
+    }
+}

package/lib/middleware/gitMiddleware.d.ts

@@ -0,0 +1,2 @@
+import { Arguments } from 'yargs';
+export declare function checkAndWarnGitInclusionMiddleware(argv: Arguments): void;

package/lib/middleware/gitMiddleware.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkAndWarnGitInclusionMiddleware = checkAndWarnGitInclusionMiddleware;
+const config_1 = require("@hubspot/local-dev-lib/config");
+const git_1 = require("../ui/git");
+function checkAndWarnGitInclusionMiddleware(argv) {
+    // Skip this when no command is provided
+    if (argv._.length) {
+        const configPath = (0, config_1.getConfigPath)();
+        if (configPath) {
+            (0, git_1.checkAndWarnGitInclusion)(configPath);
+        }
+    }
+}

package/lib/middleware/notificationsMiddleware.d.ts

@@ -0,0 +1 @@
+export declare function notifyAboutUpdates(): void;

package/lib/middleware/notificationsMiddleware.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.notifyAboutUpdates = notifyAboutUpdates;
+// Update-notifier is CommonJS, so we need to use require
+const updateNotifier = require('update-notifier');
+const chalk = require('chalk');
+const pkg = require('../../package.json');
+const { UI_COLORS, uiCommandReference } = require('../ui');
+const { i18n } = require('../lang');
+const notifier = updateNotifier({
+    pkg: { ...pkg, name: '@hubspot/cli' },
+    distTag: 'latest',
+    shouldNotifyInNpmScript: true,
+});
+const CMS_CLI_PACKAGE_NAME = '@hubspot/cms-cli';
+function notifyAboutUpdates() {
+    notifier.notify({
+        message: pkg.name === CMS_CLI_PACKAGE_NAME
+            ? i18n(`commands.generalErrors.updateNotify.cmsUpdateNotification`, {
+                packageName: CMS_CLI_PACKAGE_NAME,
+                updateCommand: uiCommandReference('{updateCommand}'),
+            })
+            : i18n(`commands.generalErrors.updateNotify.cliUpdateNotification`, {
+                updateCommand: uiCommandReference('{updateCommand}'),
+            }),
+        defer: false,
+        boxenOptions: {
+            borderColor: UI_COLORS.MARIGOLD_DARK,
+            margin: 1,
+            padding: 1,
+            textAlignment: 'center',
+            borderStyle: 'round',
+            title: pkg.name === CMS_CLI_PACKAGE_NAME
+                ? null
+                : chalk.bold(i18n(`commands.generalErrors.updateNotify.notifyTitle`)),
+        },
+    });
+}

package/lib/middleware/requestMiddleware.d.ts

@@ -0,0 +1 @@
+export declare function setRequestHeaders(): void;

package/lib/middleware/requestMiddleware.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setRequestHeaders = setRequestHeaders;
+const http_1 = require("@hubspot/local-dev-lib/http");
+const package_json_1 = __importDefault(require("../../package.json"));
+function setRequestHeaders() {
+    (0, http_1.addUserAgentHeader)('HubSpot CLI', package_json_1.default.version);
+}

package/lib/middleware/utils.d.ts

@@ -0,0 +1,8 @@
+type TargetCommandMap = {
+    [key: string]: {
+        target?: boolean;
+        subCommands?: TargetCommandMap;
+    };
+};
+export declare function isTargetedCommand(commandParts: (string | number)[], targetCommandMap: TargetCommandMap): boolean;
+export {};

package/lib/middleware/utils.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isTargetedCommand = isTargetedCommand;
+function isTargetedCommand(commandParts, targetCommandMap) {
+    const currentCommand = commandParts[0];
+    if (!targetCommandMap[currentCommand]) {
+        return false;
+    }
+    if (targetCommandMap[currentCommand].target) {
+        return true;
+    }
+    const subCommands = targetCommandMap[currentCommand].subCommands || {};
+    if (commandParts.length > 1) {
+        return isTargetedCommand(commandParts.slice(1), subCommands);
+    }
+    return false;
+}

package/lib/middleware/yargsChecksMiddleware.d.ts

@@ -0,0 +1,4 @@
+import { Arguments } from 'yargs';
+export declare function performChecks(argv: Arguments<{
+    src?: string;
+}>): boolean;

package/lib/middleware/yargsChecksMiddleware.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.performChecks = performChecks;
+const logger_1 = require("@hubspot/local-dev-lib/logger");
+const exitCodes_1 = require("../enums/exitCodes");
+const lang_1 = require("../lang");
+const projects_1 = require("../projects");
+const utils_1 = require("./utils");
+const UPLOAD_AND_WATCH_COMMANDS = {
+    upload: { target: true },
+    watch: { target: true },
+};
+function performChecks(argv) {
+    // Require "project" command when running upload/watch inside of a project
+    if ((0, utils_1.isTargetedCommand)(argv._, UPLOAD_AND_WATCH_COMMANDS) &&
+        (0, projects_1.getIsInProject)(argv.src)) {
+        logger_1.logger.error((0, lang_1.i18n)(`commands.generalErrors.srcIsProject`, {
+            src: argv.src || './',
+            command: argv._.join(' '),
+        }));
+        process.exit(exitCodes_1.EXIT_CODES.ERROR);
+    }
+    return true;
+}

package/lib/projects/ProjectLogsManager.d.ts

@@ -14,7 +14,7 @@ declare class _ProjectLogsManager {
     init(accountId: number): Promise<void>;
     fetchFunctionDetails(): Promise<void>;
     getFunctionNames(): string[];
-    setFunction(functionName: string): void;
+    setFunction(functionName?: string): void;
 }
 export declare const ProjectLogsManager: _ProjectLogsManager;
 export {};

package/lib/projects/ProjectLogsManager.js

@@ -79,7 +79,7 @@ class _ProjectLogsManager {
         return this.functions.map(serverlessFunction => serverlessFunction.componentName);
     }
     setFunction(functionName) {
-        if (!(this.functions.length > 0)) {
+        if (!functionName || this.functions.length === 0) {
             throw new Error((0, lang_1.i18n)(`${i18nKey}.errors.noFunctionsInProject`, {
                 link: (0, ui_1.uiLink)((0, lang_1.i18n)(`${i18nKey}.errors.noFunctionsLinkText`), 'https://developers.hubspot.com/docs/platform/serverless-functions'),
             }));

package/lib/projects/index.d.ts

@@ -6,7 +6,7 @@ export declare function getProjectConfig(dir?: string): Promise<{
     projectDir: string | null;
     projectConfig: ProjectConfig | null;
 }>;
-export declare function validateProjectConfig(projectConfig: ProjectConfig | null, projectDir: string | null): void;
+export declare function validateProjectConfig(projectConfig: ProjectConfig | null, projectDir: string | null): asserts projectConfig is ProjectConfig;
 export declare function ensureProjectExists(accountId: number, projectName: string, { forceCreate, allowCreate, noLogs, withPolling, uploadCommand, }?: {
     forceCreate?: boolean | undefined;
     allowCreate?: boolean | undefined;

package/lib/projects/structure.d.ts

@@ -1,6 +1,6 @@
 import { ComponentTypes, Component, GenericComponentConfig, PublicAppComponentConfig, PrivateAppComponentConfig, AppCardComponentConfig } from '../../types/Projects';
 import { IntermediateRepresentationNodeLocalDev } from '@hubspot/project-parsing-lib/src/lib/types';
-import { AppIRNode, CardIRNode } from '../../types/ProjectComponents';
+import { AppIRNode } from '../../types/ProjectComponents';
 export declare const CONFIG_FILES: {
     [k in ComponentTypes]: string;
 };
@@ -16,4 +16,3 @@ export declare function getComponentUid(component?: Component | null): string |
 export declare function componentIsApp(component?: Component | null): component is Component<PublicAppComponentConfig | PrivateAppComponentConfig>;
 export declare function componentIsPublicApp(component?: Component | null): component is Component<PublicAppComponentConfig>;
 export declare function isAppIRNode(component: IntermediateRepresentationNodeLocalDev): component is AppIRNode;
-export declare function isCardIRNode(component: IntermediateRepresentationNodeLocalDev): component is CardIRNode;

package/lib/projects/structure.js

@@ -44,7 +44,6 @@ exports.getComponentUid = getComponentUid;
 exports.componentIsApp = componentIsApp;
 exports.componentIsPublicApp = componentIsPublicApp;
 exports.isAppIRNode = isAppIRNode;
-exports.isCardIRNode = isCardIRNode;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const fs_1 = require("@hubspot/local-dev-lib/fs");
@@ -175,6 +174,3 @@ function componentIsPublicApp(component) {
 function isAppIRNode(component) {
     return component.componentType === constants_1.IR_COMPONENT_TYPES.APPLICATION;
 }
-function isCardIRNode(component) {
-    return component.componentType === constants_1.IR_COMPONENT_TYPES.CARD;
-}

package/lib/projects/upload.d.ts

@@ -1,6 +1,6 @@
 import { FileResult } from 'tmp';
 import { ProjectConfig } from '../../types/Projects';
-type ProjectUploadCallbackFunction<T> = (accountId: number, projectConfig: ProjectConfig, tempFile: FileResult, buildId?: number) => Promise<T>;
+type ProjectUploadCallbackFunction<T> = (accountId: number, projectConfig: ProjectConfig, tempFile: FileResult, buildId: number) => Promise<T>;
 type ProjectUploadResult<T> = {
     result?: T;
     uploadError?: unknown;

package/lib/ui/SpinniesManager.d.ts

@@ -22,7 +22,7 @@ declare class SpinniesManager {
     succeed(name: string, options?: Partial<SpinnerState>): SpinnerState;
     fail(name: string, options?: Partial<SpinnerState>): SpinnerState;
     remove(name: string): SpinnerState;
-    stopAll(newStatus?: typeof VALID_STATUSES[number]): {
+    stopAll(newStatus?: (typeof VALID_STATUSES)[number]): {
         [key: string]: SpinnerState;
     };
     private hasAnySpinners;

package/lib/ui/index.d.ts

@@ -15,3 +15,4 @@ export declare function uiDeprecatedTag(message: string, log?: boolean): string
 export declare function uiCommandDisabledBanner(command: string, url?: string, message?: string): void;
 export declare function uiDeprecatedDescription(message: string, command: string, url?: string): string | undefined;
 export declare function uiDeprecatedMessage(command: string, url?: string, message?: string): void;
+export declare function indent(level: number): string;

package/lib/ui/index.js

@@ -15,6 +15,7 @@ exports.uiDeprecatedTag = uiDeprecatedTag;
 exports.uiCommandDisabledBanner = uiCommandDisabledBanner;
 exports.uiDeprecatedDescription = uiDeprecatedDescription;
 exports.uiDeprecatedMessage = uiDeprecatedMessage;
+exports.indent = indent;
 const chalk_1 = __importDefault(require("chalk"));
 const config_1 = require("@hubspot/local-dev-lib/config");
 const logger_1 = require("@hubspot/local-dev-lib/logger");
@@ -148,3 +149,7 @@ function uiDeprecatedMessage(command, url, message) {
     uiDeprecatedTag(tag);
     logger_1.logger.log();
 }
+function indent(level) {
+    const indentation = '  ';
+    return indentation.repeat(level);
+}

package/lib/ui/spinniesUtils.d.ts

@@ -6,14 +6,14 @@ export type Spinner = {
 };
 export type SpinnerOptions = {
     text?: string;
-    status?: typeof VALID_STATUSES[number];
+    status?: (typeof VALID_STATUSES)[number];
     indent?: number;
     spinner?: Partial<Spinner>;
     disableSpins?: boolean;
-    color?: typeof VALID_COLORS[number];
-    spinnerColor?: typeof VALID_COLORS[number];
-    succeedColor?: typeof VALID_COLORS[number];
-    failColor?: typeof VALID_COLORS[number];
+    color?: (typeof VALID_COLORS)[number];
+    spinnerColor?: (typeof VALID_COLORS)[number];
+    succeedColor?: (typeof VALID_COLORS)[number];
+    failColor?: (typeof VALID_COLORS)[number];
     succeedPrefix?: string;
     failPrefix?: string;
 };

package/package.json

@@ -1,16 +1,17 @@
 {
     "name": "@hubspot/cli",
-    "version": "7.4.0-experimental.0",
+    "version": "7.4.0",
     "description": "The official CLI for developing on HubSpot",
     "license": "Apache-2.0",
     "repository": "https://github.com/HubSpot/hubspot-cli",
     "dependencies": {
-        "@hubspot/local-dev-lib": "0.3.0-experimental.0",
-        "@hubspot/project-parsing-lib": "0.1.4",
+        "@hubspot/local-dev-lib": "3.5.2",
+        "@hubspot/project-parsing-lib": "0.1.7",
         "@hubspot/serverless-dev-runtime": "7.0.2",
         "@hubspot/theme-preview-dev-server": "0.0.10",
         "@hubspot/ui-extensions-dev-server": "0.8.52",
         "archiver": "7.0.1",
+        "boxen": "8.0.1",
         "chalk": "4.1.2",
         "chokidar": "3.6.0",
         "cli-cursor": "3.1.0",
@@ -41,7 +42,7 @@
         "@types/semver": "^7.5.8",
         "@types/tmp": "^0.2.6",
         "@types/yargs": "^17.0.33",
-        "@typescript-eslint/eslint-plugin": "^8.11.0",
+        "@typescript-eslint/eslint-plugin": "8.29.0",
         "@typescript-eslint/parser": "^8.11.0",
         "axios": "^1.7.2",
         "eslint": "^8.56.0",
@@ -62,9 +63,9 @@
     },
     "scripts": {
         "build": "ts-node ./scripts/build.ts",
-        "lint": "eslint . && prettier --list-different ./**/*.{js,json}",
+        "lint": "eslint . && prettier --list-different './**/*.{ts,js,json}'",
         "list-all-commands": "yarn ts-node ./scripts/get-all-commands.ts",
-        "prettier:write": "prettier --write ./**/*.{ts,js,json}",
+        "prettier:write": "prettier --write './**/*.{ts,js,json}'",
         "test": "yarn node --experimental-vm-modules $(yarn bin jest)",
         "test-cli": "yarn build && yarn --cwd 'acceptance-tests' test-ci",
         "test-cli-debug": "yarn build && yarn --cwd 'acceptance-tests' test-debug",

package/types/ProjectComponents.d.ts

@@ -16,23 +16,8 @@ type AppConfig = {
         conditionallyRequiredScopes: string[];
     };
 };
-type CardConfig = {
-    name: string;
-    description: string;
-    previewImage: {
-        file: string;
-        altText: string;
-    };
-    entrypoint: string;
-    location: string;
-    objectTypes: string[];
-};
 export interface AppIRNode extends IntermediateRepresentationNodeLocalDev {
     componentType: typeof IR_COMPONENT_TYPES.APPLICATION;
     config: AppConfig;
 }
-export interface CardIRNode extends IntermediateRepresentationNodeLocalDev {
-    componentType: typeof IR_COMPONENT_TYPES.CARD;
-    config: CardConfig;
-}
 export {};