@hubspot/cli 7.7.0-experimental.2 → 7.7.0

package/mcp-server/tools/GenerateCardComponentTool.js

@@ -1,146 +0,0 @@
-import { MCPTool } from "mcp-framework";
-import { z } from "zod";
-class GenerateCardComponentTool extends MCPTool {
-    name = "generateCardComponent";
-    description = "Generates a complete card sub-component including configuration, package.json, and React JSX implementation. Cards live within apps and depend on app authentication.";
-    schema = {
-        cardName: {
-            type: z.string(),
-            description: "Name of the card (used for file naming and component names)",
-        },
-        uid: {
-            type: z.string(),
-            description: "Unique identifier for the card component (must be unique per-project)",
-        },
-        displayName: {
-            type: z.string().optional(),
-            description: "Display name of the card. Defaults to cardName",
-        },
-        location: {
-            type: z.string().optional(),
-            description: "Card location/placement. Defaults to 'crm.record.tab'",
-        },
-        objectTypes: {
-            type: z.array(z.string()).optional(),
-            description: "CRM object types this card should appear on (e.g., ['contacts', 'companies']). Defaults to ['contacts']",
-        },
-        componentFileName: {
-            type: z.string().optional(),
-            description: "Name for the React component file (without extension). Defaults to PascalCase of cardName",
-        },
-    };
-    async execute(input) {
-        const { cardName, uid, displayName = cardName, location = "crm.record.tab", objectTypes = ["contacts"], componentFileName = this.toPascalCase(cardName), } = input;
-        // Generate the sanitized card name for file naming
-        const sanitizedCardName = cardName.toLowerCase().replace(/\s+/g, "-");
-        const configFileName = `${sanitizedCardName}-hsmeta.json`;
-        const folderPath = "src/app/cards";
-        const reactFileName = `${componentFileName}.jsx`;
-        const entrypoint = `/app/cards/${reactFileName}`;
-        // Card configuration
-        const cardConfig = {
-            uid: uid,
-            type: "card",
-            config: {
-                name: displayName,
-                location: location,
-                entrypoint: entrypoint,
-                objectTypes: objectTypes,
-            },
-        };
-        // Package.json configuration
-        const packageJson = {
-            name: "hubspot-example-extension",
-            version: "0.1.0",
-            license: "MIT",
-            dependencies: {
-                "@hubspot/ui-extensions": "latest",
-                react: "^18.2.0",
-            },
-            devDependencies: {
-                typescript: "^5.3.3",
-            },
-        };
-        // React component implementation
-        const reactComponent = `import React from "react";
-import { Text } from "@hubspot/ui-extensions";
-import { hubspot } from "@hubspot/ui-extensions";
-
-hubspot.extend(() => <Extension />);
-
-const Extension = () => {
-  return (
-    <>
-      <Text>
-        ${displayName} - Displaying information for {objectTypes.join(', ')} records.
-      </Text>
-    </>
-  );
-};
-
-export default Extension;`;
-        return {
-            message: `Generated complete card component "${displayName}" with React implementation`,
-            files: {
-                configuration: {
-                    path: `${folderPath}/${configFileName}`,
-                    content: JSON.stringify(cardConfig, null, 2),
-                    description: "Card component configuration",
-                },
-                packageJson: {
-                    path: `${folderPath}/package.json`,
-                    content: JSON.stringify(packageJson, null, 2),
-                    description: "NPM package dependencies",
-                },
-                reactComponent: {
-                    path: `${folderPath}/${reactFileName}`,
-                    content: reactComponent,
-                    description: "React JSX component implementation",
-                },
-            },
-            folderPath: folderPath,
-            architecture: {
-                componentType: "sub-component",
-                parentComponent: "app",
-                category: "feature",
-                authenticationDependency: "Inherits authentication from parent app - no additional scopes required",
-                allowMultiple: true,
-                technology: "React JSX with @hubspot/ui-extensions",
-            },
-            instructions: [
-                `Create the directory structure: ${folderPath}/`,
-                `Create configuration file: ${folderPath}/${configFileName}`,
-                `Create package.json: ${folderPath}/package.json`,
-                `Create React component: ${folderPath}/${reactFileName}`,
-                `This is a SUB-COMPONENT that depends on the parent app's authentication`,
-                `Card will appear on: ${objectTypes.join(", ")} records at location: ${location}`,
-                `Card uid: ${uid} must be unique within your project`,
-                "You can have multiple card components within the same app",
-                "Cards inherit all authentication and permissions from their parent app",
-            ],
-            nextSteps: [
-                "1. Ensure parent app component exists with appropriate OAuth scopes for your use case",
-                "2. Create the card directory and all generated files",
-                "3. Install dependencies by running npm install in the card directory",
-                "4. Customize the React component implementation",
-                "5. Test the card appears correctly on target object types",
-                "6. Verify card can access needed HubSpot data through inherited app authentication",
-            ],
-            developmentNotes: [
-                "Cards are React-based components using @hubspot/ui-extensions",
-                "Use HubSpot UI components for consistent styling",
-                "Cards can access HubSpot context and APIs through the UI extensions framework",
-                "Entrypoint path is relative to the app directory",
-                "Package.json defines React and HubSpot UI extension dependencies",
-                "Cards inherit authentication from parent app - no separate OAuth configuration needed",
-            ],
-        };
-    }
-    toPascalCase(str) {
-        return str
-            .split(/[\s-_]+/)
-            .map((word) => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase())
-            .join("");
-    }
-}
-export default GenerateCardComponentTool;

package/mcp-server/tools/GenerateProjectConfigTool.d.ts

@@ -1,32 +0,0 @@
-import { MCPTool } from "mcp-framework";
-import { z } from "zod";
-interface GenerateProjectConfigInput {
-    projectName: string;
-    srcDir?: string;
-    platformVersion?: string;
-}
-declare class GenerateProjectConfigTool extends MCPTool<GenerateProjectConfigInput> {
-    name: string;
-    description: string;
-    schema: {
-        projectName: {
-            type: z.ZodString;
-            description: string;
-        };
-        srcDir: {
-            type: z.ZodOptional<z.ZodString>;
-            description: string;
-        };
-        platformVersion: {
-            type: z.ZodOptional<z.ZodString>;
-            description: string;
-        };
-    };
-    execute(input: GenerateProjectConfigInput): Promise<{
-        message: string;
-        config: string;
-        filename: string;
-        instructions: string[];
-    }>;
-}
-export default GenerateProjectConfigTool;

package/mcp-server/tools/GenerateProjectConfigTool.js

@@ -1,40 +0,0 @@
-import { MCPTool } from "mcp-framework";
-import { z } from "zod";
-class GenerateProjectConfigTool extends MCPTool {
-    name = "generateProjectConfig";
-    description = "Generates an hsproject.json configuration file for a developer project on the platform";
-    schema = {
-        projectName: {
-            type: z.string(),
-            description: "Name of the developer project",
-        },
-        srcDir: {
-            type: z.string().optional(),
-            description: "Directory that contains all project source code. Defaults to 'src'",
-        },
-        platformVersion: {
-            type: z.string().optional(),
-            description: "Version of the platform to use. Defaults to '2025.2'",
-        },
-    };
-    async execute(input) {
-        const { projectName, srcDir = "src", platformVersion = "2025.2" } = input;
-        const hsprojectConfig = {
-            name: projectName,
-            srcDir: srcDir,
-            platformVersion: platformVersion,
-        };
-        return {
-            message: `Generated hsproject.json configuration for project "${projectName}"`,
-            config: JSON.stringify(hsprojectConfig, null, 2),
-            filename: "hsproject.json",
-            instructions: [
-                "Place this hsproject.json file in your project's root directory",
-                "This file designates the folder as a developer project",
-                `Source code should be placed in the '${srcDir}' directory`,
-                `Project will use platform version ${platformVersion}`,
-            ],
-        };
-    }
-}
-export default GenerateProjectConfigTool;

package/mcp-server/tools/HubSpotCLIHelper.d.ts

@@ -1,24 +0,0 @@
-interface CLICheckResult {
-    isInstalled: boolean;
-    version?: string;
-    debugInfo?: {
-        command: string;
-        success: boolean;
-        output: string;
-        error?: string;
-        env?: Record<string, string | undefined>;
-    };
-}
-interface CommandResult {
-    success: boolean;
-    output: string;
-    error?: string;
-}
-export declare class HubSpotCLIHelper {
-    private execAsync;
-    checkCLIInstallation(): Promise<CLICheckResult>;
-    installCLI(): Promise<CommandResult>;
-    runCommand(command: string): Promise<CommandResult>;
-    runProjectCommand(command: string, projectPath?: string): Promise<CommandResult>;
-}
-export default HubSpotCLIHelper;

package/mcp-server/tools/HubSpotCLIHelper.js

@@ -1,110 +0,0 @@
-import { exec } from 'child_process';
-import { promisify } from 'util';
-export class HubSpotCLIHelper {
-    execAsync = promisify(exec);
-    async checkCLIInstallation() {
-        try {
-            // Run hs --version to check if CLI is installed
-            const result = await this.runCommand('hs --version');
-            const debugInfo = {
-                command: 'hs --version',
-                success: result.success,
-                output: result.output,
-                error: result.error,
-                env: {
-                    PATH: process.env.PATH,
-                    NODE_PATH: process.env.NODE_PATH,
-                    npm_config_prefix: process.env.npm_config_prefix,
-                },
-            };
-            if (result.success) {
-                // Parse version from output (typically like "@hubspot/cli/4.0.0 darwin-x64 node-v18.17.0")
-                const versionMatch = result.output.match(/@hubspot\/cli\/(\d+\.\d+\.\d+)/);
-                const version = versionMatch ? versionMatch[1] : result.output.trim();
-                return {
-                    isInstalled: true,
-                    version: version,
-                    debugInfo,
-                };
-            }
-            else {
-                return {
-                    isInstalled: false,
-                    debugInfo,
-                };
-            }
-        }
-        catch (error) {
-            return {
-                isInstalled: false,
-                debugInfo: {
-                    command: 'hs --version',
-                    success: false,
-                    output: '',
-                    error: error instanceof Error ? error.message : 'Unknown error',
-                    env: {
-                        PATH: process.env.PATH,
-                        NODE_PATH: process.env.NODE_PATH,
-                        npm_config_prefix: process.env.npm_config_prefix,
-                    },
-                },
-            };
-        }
-    }
-    async installCLI() {
-        try {
-            return await this.runCommand('npm install -g @hubspot/cli');
-        }
-        catch (error) {
-            const errorMessage = error instanceof Error ? error.message : 'Unknown error';
-            return {
-                success: false,
-                output: '',
-                error: errorMessage,
-            };
-        }
-    }
-    async runCommand(command) {
-        try {
-            // Use the same environment as the current process, including PATH
-            const result = await this.execAsync(command, {
-                env: process.env,
-                shell: '/bin/bash',
-            });
-            return {
-                success: true,
-                output: result.stdout || result.stderr || '',
-            };
-        }
-        catch (error) {
-            // Command failed (e.g., command not found, non-zero exit code)
-            const err = error;
-            return {
-                success: false,
-                output: err.stdout || '',
-                error: err.stderr || err.message || 'Command execution failed',
-            };
-        }
-    }
-    async runProjectCommand(command, projectPath = '.') {
-        try {
-            // Get absolute path to avoid any relative path issues
-            const path = await import('path');
-            const absoluteProjectPath = path.resolve(projectPath);
-            // Add debugging information about directories
-            const debugCommand = `echo "MCP Server CWD: $(pwd)" && echo "Project Path: ${absoluteProjectPath}" && ls -la "${absoluteProjectPath}" | head -5`;
-            // Change to the project directory and run command
-            const fullCommand = `cd "${absoluteProjectPath}" && ${debugCommand} && ${command}`;
-            return await this.runCommand(fullCommand);
-        }
-        catch (error) {
-            const errorMessage = error instanceof Error ? error.message : 'Unknown error';
-            return {
-                success: false,
-                output: '',
-                error: errorMessage,
-            };
-        }
-    }
-}
-export default HubSpotCLIHelper;

package/mcp-server/tools/UploadProjectTool.d.ts

@@ -1,44 +0,0 @@
-import { MCPTool } from 'mcp-framework';
-import { z } from 'zod';
-interface UploadProjectInput {
-    projectPath?: string;
-    accountId?: string;
-    autoInstallCLI?: boolean;
-}
-interface UploadResponse {
-    status: string;
-    message: string;
-    cliVersion?: string;
-    uploadOutput?: string;
-    accountId?: string;
-    projectPath?: string;
-    error?: string;
-    troubleshooting?: string[];
-    actions?: Array<{
-        action: string;
-        command: string;
-        description: string;
-    }>;
-    nextSteps?: string[];
-}
-declare class UploadProjectTool extends MCPTool<UploadProjectInput> {
-    name: string;
-    description: string;
-    private cliHelper;
-    schema: {
-        projectPath: {
-            type: z.ZodOptional<z.ZodString>;
-            description: string;
-        };
-        accountId: {
-            type: z.ZodOptional<z.ZodString>;
-            description: string;
-        };
-        autoInstallCLI: {
-            type: z.ZodOptional<z.ZodBoolean>;
-            description: string;
-        };
-    };
-    execute(input: UploadProjectInput): Promise<UploadResponse>;
-}
-export default UploadProjectTool;

package/mcp-server/tools/UploadProjectTool.js

@@ -1,166 +0,0 @@
-import { MCPTool } from 'mcp-framework';
-import { z } from 'zod';
-import HubSpotCLIHelper from './HubSpotCLIHelper.js';
-class UploadProjectTool extends MCPTool {
-    name = 'uploadProject';
-    description = 'Uploads a developer project to HubSpot using the HubSpot CLI';
-    cliHelper = new HubSpotCLIHelper();
-    schema = {
-        projectPath: {
-            type: z.string().optional(),
-            description: 'Path to the project directory. When using MCP server globally, provide the absolute path to your project (e.g., "/Users/yourname/projects/my-hubspot-project"). Defaults to "." for local usage.',
-        },
-        accountId: {
-            type: z.string().optional(),
-            description: 'HubSpot account ID to upload to. If not provided, uses CLI default or prompts',
-        },
-        autoInstallCLI: {
-            type: z.boolean().optional(),
-            description: 'Whether to automatically install HubSpot CLI if not found. Defaults to false',
-        },
-    };
-    async execute(input) {
-        // Default to current directory "." which should resolve relative to where the MCP client is running
-        const { projectPath = '.', accountId, autoInstallCLI = false } = input;
-        try {
-            // Step 1: Check if HubSpot CLI is installed
-            const cliCheckResult = await this.cliHelper.checkCLIInstallation();
-            if (!cliCheckResult.isInstalled) {
-                if (autoInstallCLI) {
-                    // Attempt to install CLI automatically
-                    const installResult = await this.cliHelper.installCLI();
-                    if (!installResult.success) {
-                        return {
-                            status: 'cli-install-failed',
-                            message: '❌ Failed to install HubSpot CLI automatically',
-                            error: installResult.error,
-                            actions: [
-                                {
-                                    action: 'install-cli-manually',
-                                    command: 'npm install -g @hubspot/cli',
-                                    description: 'Install HubSpot CLI manually',
-                                },
-                            ],
-                            troubleshooting: [
-                                'Try installing the CLI manually: npm install -g @hubspot/cli',
-                                'Ensure you have npm installed and proper permissions',
-                                'Run the upload command again after CLI installation',
-                            ],
-                        };
-                    }
-                    // Verify installation was successful
-                    const recheckResult = await this.cliHelper.checkCLIInstallation();
-                    if (!recheckResult.isInstalled) {
-                        return {
-                            status: 'cli-install-verification-failed',
-                            message: '❌ CLI installation completed but verification failed',
-                            troubleshooting: [
-                                "Try running 'hs --version' manually to verify installation",
-                                'Restart your terminal/shell session',
-                                'Check if the CLI was installed to the correct PATH',
-                            ],
-                        };
-                    }
-                }
-                else {
-                    return {
-                        status: 'cli-not-found',
-                        message: 'HubSpot CLI not found. Install it to upload projects.',
-                        error: `Debug info: ${JSON.stringify(cliCheckResult.debugInfo, null, 2)}`,
-                        actions: [
-                            {
-                                action: 'install-cli',
-                                command: 'npm install -g @hubspot/cli',
-                                description: 'Install HubSpot CLI globally',
-                            },
-                        ],
-                        nextSteps: [
-                            '1. Install HubSpot CLI globally',
-                            '2. Authenticate with your HubSpot account (hs auth)',
-                            '3. Run project upload again',
-                        ],
-                    };
-                }
-            }
-            // Step 2: Build the upload command
-            let uploadCommand = 'hs project upload';
-            if (accountId) {
-                uploadCommand += ` --account=${accountId}`;
-            }
-            // Step 3: Run project upload
-            const uploadResult = await this.cliHelper.runProjectCommand(uploadCommand, projectPath);
-            if (uploadResult.success) {
-                // Parse successful upload output
-                const output = uploadResult.output;
-                return {
-                    status: 'success',
-                    message: '✅ Project uploaded successfully to HubSpot!',
-                    cliVersion: cliCheckResult.version,
-                    uploadOutput: output,
-                    accountId: accountId,
-                    projectPath: projectPath,
-                    nextSteps: [
-                        '1. Check your HubSpot account to verify the project appears',
-                        '2. Test your components in the HubSpot environment',
-                        '3. Monitor for any runtime errors or issues',
-                        "4. Use 'hs project logs' to view application logs if needed",
-                    ],
-                };
-            }
-            else {
-                // Parse upload failure
-                const errorOutput = uploadResult.output || uploadResult.error || 'Upload failed';
-                // Check if this looks like a path issue with global MCP server
-                const isPathIssue = errorOutput.includes('Unable to locate a project configuration file') || errorOutput.includes('MCP Server CWD: /');
-                return {
-                    status: 'upload-failed',
-                    message: '❌ Project upload failed',
-                    cliVersion: cliCheckResult.version,
-                    uploadOutput: errorOutput,
-                    error: uploadResult.error,
-                    troubleshooting: [
-                        "Ensure you're authenticated: run 'hs auth' to login",
-                        'Verify your account has permission to upload projects',
-                        "Check that your project is valid: run 'hs project validate' first",
-                        'Ensure you have network connectivity to HubSpot',
-                        'Try uploading to a different account if you have access to multiple',
-                        `Working directory was: ${projectPath}`,
-                        ...(isPathIssue
-                            ? [
-                                '⚠️  PATH ISSUE DETECTED: You may be using the global MCP server',
-                                'When using global MCP server, provide the absolute path to your project:',
-                                'Example: {"projectPath": "/Users/yourname/projects/my-hubspot-project"}',
-                                'Or consider running the MCP server locally from your project directory',
-                            ]
-                            : []),
-                    ],
-                    nextSteps: [
-                        '1. Check authentication status: hs auth info',
-                        '2. Validate project first: hs project validate',
-                        ...(isPathIssue
-                            ? ['3. Provide absolute projectPath if using global MCP server']
-                            : []),
-                        '4. Review the error output above for specific issues',
-                        '5. Try the upload command again after fixing issues',
-                    ],
-                };
-            }
-        }
-        catch (error) {
-            const errorMessage = error instanceof Error ? error.message : 'Unknown error occurred';
-            return {
-                status: 'error',
-                message: 'An error occurred during project upload',
-                error: errorMessage,
-                troubleshooting: [
-                    "Ensure you're in a valid developer project directory",
-                    'Check that hsproject.json exists in the project root',
-                    'Verify HubSpot CLI is properly installed and accessible',
-                    "Try running 'hs project upload' manually to see detailed output",
-                    `Attempted project path: ${projectPath}`,
-                ],
-            };
-        }
-    }
-}
-export default UploadProjectTool;

package/mcp-server/tools/ValidateProjectTool.d.ts

@@ -1,62 +0,0 @@
-import { MCPTool } from 'mcp-framework';
-import { z } from 'zod';
-interface ValidateProjectInput {
-    autoFix?: boolean;
-    projectPath?: string;
-}
-interface ValidationResponse {
-    status: string;
-    message: string;
-    cliVersion?: string;
-    validationOutput?: string;
-    errors?: string[];
-    errorAnalysis?: Array<{
-        category: string;
-        issue: string;
-        severity: 'error' | 'warning';
-        component?: string;
-        file?: string;
-    }>;
-    suggestions?: string[];
-    nextSteps?: string[];
-    autoFixActions?: Array<{
-        action: string;
-        description: string;
-        command?: string;
-        tool?: string;
-    }>;
-    actions?: Array<{
-        action: string;
-        command: string;
-        description: string;
-    }>;
-    projectStructure?: string;
-    error?: string;
-    troubleshooting?: string[];
-}
-declare class ValidateProjectTool extends MCPTool<ValidateProjectInput> {
-    name: string;
-    description: string;
-    private cliHelper;
-    schema: {
-        autoFix: {
-            type: z.ZodOptional<z.ZodBoolean>;
-            description: string;
-        };
-        projectPath: {
-            type: z.ZodOptional<z.ZodString>;
-            description: string;
-        };
-    };
-    execute(input: ValidateProjectInput): Promise<ValidationResponse>;
-    private runProjectValidation;
-    private runCommand;
-    private parseValidationErrors;
-    private analyzeValidationErrors;
-    private extractComponentFromPath;
-    private generateFixSuggestions;
-    private extractFieldFromError;
-    private generateNextSteps;
-    private generateAutoFixActions;
-}
-export default ValidateProjectTool;