@hubspot/local-dev-lib 0.5.0-experimental.2 → 0.5.0-experimental.3

package/config/state.d.ts

@@ -1,3 +1,3 @@
-import { CLIState } from '../types/Config';
-export declare function getStateValue<K extends keyof CLIState>(key: K): CLIState[K];
-export declare function setStateValue<K extends keyof CLIState>(key: K, value: CLIState[K]): void;
+import { HubSpotState } from '../types/Config';
+export declare function getStateValue<K extends keyof HubSpotState>(key: K): HubSpotState[K];
+export declare function setStateValue<K extends keyof HubSpotState>(key: K, value: HubSpotState[K]): void;

package/config/state.js

@@ -29,9 +29,10 @@ const path = __importStar(require("path"));
 const lang_1 = require("../utils/lang");
 const config_1 = require("../constants/config");
 const logger_1 = require("../lib/logger");
+const config_2 = require("../constants/config");
 const i18nKey = 'config.state';
 const DEFAULT_STATE = {
-    mcpTotalToolCalls: 0,
+    [config_2.MCP_TOTAL_TOOL_CALLS_STATE]: 0,
 };
 function ensureCLIDirectory() {
     try {
@@ -46,19 +47,41 @@ function ensureCLIDirectory() {
         }));
     }
 }
+function sanitizeAndMerge(parsed) {
+    if (!parsed || typeof parsed !== 'object' || Array.isArray(parsed)) {
+        return structuredClone(DEFAULT_STATE);
+    }
+    const state = parsed;
+    const result = structuredClone(DEFAULT_STATE);
+    for (const key in DEFAULT_STATE) {
+        const typedKey = key;
+        if (key in state &&
+            typeof state[typedKey] === typeof DEFAULT_STATE[typedKey]) {
+            result[typedKey] = state[typedKey];
+        }
+        // keys not in parsed file remain as DEFAULT values
+    }
+    return result;
+}
 function getCurrentState() {
     try {
-        if (fs.existsSync(config_1.STATE_FILE_PATH)) {
-            const data = fs.readFileSync(config_1.STATE_FILE_PATH, 'utf-8');
-            return JSON.parse(data);
+        if (!fs.existsSync(config_1.STATE_FILE_PATH)) {
+            return structuredClone(DEFAULT_STATE);
         }
+        const data = fs.readFileSync(config_1.STATE_FILE_PATH, 'utf-8');
+        if (!data?.trim()) {
+            logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.getCurrentState.debug.emptyStateFile`));
+            return structuredClone(DEFAULT_STATE);
+        }
+        const parsed = JSON.parse(data);
+        return sanitizeAndMerge(parsed);
     }
     catch (error) {
-        throw new Error((0, lang_1.i18n)(`${i18nKey}.getCurrentState.errors.errorReading`, {
+        logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.getCurrentState.errors.errorReading`, {
             error: error instanceof Error ? error.message : String(error),
         }));
+        return structuredClone(DEFAULT_STATE);
     }
-    return DEFAULT_STATE;
 }
 function getStateValue(key) {
     ensureCLIDirectory();
@@ -68,13 +91,7 @@ function getStateValue(key) {
 exports.getStateValue = getStateValue;
 function setStateValue(key, value) {
     ensureCLIDirectory();
-    let currentState = DEFAULT_STATE;
-    try {
-        currentState = getCurrentState();
-    }
-    catch (error) {
-        logger_1.logger.debug(error);
-    }
+    const currentState = getCurrentState();
     const newState = { ...currentState, [key]: value };
     try {
         fs.writeFileSync(config_1.STATE_FILE_PATH, JSON.stringify(newState, null, 2), 'utf-8');

package/constants/config.d.ts

@@ -18,6 +18,7 @@ export declare const ALLOW_AUTO_UPDATES = "allowAutoUpdates";
 export declare const DEFAULT_ACCOUNT = "defaultAccount";
 export declare const DEFAULT_PORTAL = "defaultPortal";
 export declare const MIN_HTTP_TIMEOUT = 3000;
+export declare const MCP_TOTAL_TOOL_CALLS_STATE = "mcpTotalToolCalls";
 export declare const HUBSPOT_ACCOUNT_TYPES: {
     readonly DEVELOPMENT_SANDBOX: "DEVELOPMENT_SANDBOX";
     readonly DEVELOPER_TEST: "DEVELOPER_TEST";

package/constants/config.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HUBSPOT_CONFIG_OPERATIONS = exports.HUBSPOT_CONFIG_ERROR_TYPES = exports.ACCOUNT_IDENTIFIERS = exports.ENVIRONMENT_VARIABLES = exports.CONFIG_FLAGS = exports.HUBSPOT_ACCOUNT_TYPE_STRINGS = exports.HUBSPOT_ACCOUNT_TYPES = exports.MIN_HTTP_TIMEOUT = exports.DEFAULT_PORTAL = exports.DEFAULT_ACCOUNT = exports.ALLOW_AUTO_UPDATES = exports.AUTO_OPEN_BROWSER = exports.ALLOW_USAGE_TRACKING = exports.HTTP_USE_LOCALHOST = exports.ENV = exports.HTTP_TIMEOUT = exports.DEFAULT_CMS_PUBLISH_MODE = exports.DEFAULT_ACCOUNT_OVERRIDE_ERROR_ACCOUNT_NOT_FOUND = exports.DEFAULT_ACCOUNT_OVERRIDE_ERROR_INVALID_ID = exports.DEFAULT_ACCOUNT_OVERRIDE_FILE_NAME = exports.STATE_FILE_PATH = exports.GLOBAL_CONFIG_PATH = exports.HUBSPOT_STATE_FILE = exports.HUBSPOT_CONFIGURATION_FILE = exports.HUBSPOT_CONFIGURATION_FOLDER = exports.ARCHIVED_HUBSPOT_CONFIG_YAML_FILE_NAME = exports.DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME = void 0;
+exports.HUBSPOT_CONFIG_OPERATIONS = exports.HUBSPOT_CONFIG_ERROR_TYPES = exports.ACCOUNT_IDENTIFIERS = exports.ENVIRONMENT_VARIABLES = exports.CONFIG_FLAGS = exports.HUBSPOT_ACCOUNT_TYPE_STRINGS = exports.HUBSPOT_ACCOUNT_TYPES = exports.MCP_TOTAL_TOOL_CALLS_STATE = exports.MIN_HTTP_TIMEOUT = exports.DEFAULT_PORTAL = exports.DEFAULT_ACCOUNT = exports.ALLOW_AUTO_UPDATES = exports.AUTO_OPEN_BROWSER = exports.ALLOW_USAGE_TRACKING = exports.HTTP_USE_LOCALHOST = exports.ENV = exports.HTTP_TIMEOUT = exports.DEFAULT_CMS_PUBLISH_MODE = exports.DEFAULT_ACCOUNT_OVERRIDE_ERROR_ACCOUNT_NOT_FOUND = exports.DEFAULT_ACCOUNT_OVERRIDE_ERROR_INVALID_ID = exports.DEFAULT_ACCOUNT_OVERRIDE_FILE_NAME = exports.STATE_FILE_PATH = exports.GLOBAL_CONFIG_PATH = exports.HUBSPOT_STATE_FILE = exports.HUBSPOT_CONFIGURATION_FILE = exports.HUBSPOT_CONFIGURATION_FOLDER = exports.ARCHIVED_HUBSPOT_CONFIG_YAML_FILE_NAME = exports.DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME = void 0;
 const lang_1 = require("../utils/lang");
 const path_1 = __importDefault(require("path"));
 const os_1 = __importDefault(require("os"));
@@ -27,6 +27,7 @@ exports.ALLOW_AUTO_UPDATES = 'allowAutoUpdates';
 exports.DEFAULT_ACCOUNT = 'defaultAccount';
 exports.DEFAULT_PORTAL = 'defaultPortal';
 exports.MIN_HTTP_TIMEOUT = 3000;
+exports.MCP_TOTAL_TOOL_CALLS_STATE = 'mcpTotalToolCalls';
 exports.HUBSPOT_ACCOUNT_TYPES = {
     DEVELOPMENT_SANDBOX: 'DEVELOPMENT_SANDBOX',
     DEVELOPER_TEST: 'DEVELOPER_TEST',

package/http/index.js

@@ -42,22 +42,29 @@ const HubSpotHttpError_1 = require("../models/HubSpotHttpError");
 const auth_1 = require("../constants/auth");
 const localDevAuth_1 = require("../api/localDevAuth");
 const util = __importStar(require("util"));
+const trackUsage_1 = require("../lib/trackUsage");
 const i18nKey = 'http.index';
+const IGNORE_URLS_NETWORK_DEBUG = [
+    localDevAuth_1.LOCALDEVAUTH_ACCESS_TOKEN_PATH,
+    trackUsage_1.CMS_CLI_USAGE_PATH,
+    trackUsage_1.VSCODE_USAGE_PATH,
+];
 function logRequest(response) {
     try {
-        if (process.env.HUBSPOT_NETWORK_LOGGING) {
-            if (response.config.url === localDevAuth_1.LOCALDEVAUTH_ACCESS_TOKEN_PATH) {
-                // Don't log access tokens
-                return;
-            }
-            logger_1.logger.debug(util.inspect({
-                method: response.config.method,
-                baseURL: response.config.baseURL,
-                url: response.config.url,
-                data: response.data,
-                status: response.status,
-            }, false, null, true));
+        if (!process.env.HUBSPOT_NETWORK_LOGGING) {
+            return;
+        }
+        if (response?.config?.url &&
+            IGNORE_URLS_NETWORK_DEBUG.includes(response.config.url)) {
+            return;
         }
+        logger_1.logger.debug(util.inspect({
+            method: response.config.method,
+            baseURL: response.config.baseURL,
+            url: response.config.url,
+            data: response.data,
+            status: response.status,
+        }, false, null, true));
     }
     catch (error) {
         // Ignore any errors that occur while logging the response

package/lang/en.json

@@ -344,6 +344,9 @@
         }
       },
       "getCurrentState": {
+        "debug": {
+          "emptyStateFile": "State file is empty, using default state"
+        },
         "errors": {
           "errorReading": "Error reading CLI state, using defaults: {{ error }}"
         }

package/lib/portManager.js

@@ -7,11 +7,10 @@ exports.portManagerHasActiveServers = exports.deleteServerInstance = exports.get
 const axios_1 = __importDefault(require("axios"));
 const PortManagerServer_1 = require("../utils/PortManagerServer");
 const ports_1 = require("../constants/ports");
-const detectPort_1 = require("../utils/detectPort");
 const logger_1 = require("./logger");
 exports.BASE_URL = `http://localhost:${ports_1.PORT_MANAGER_SERVER_PORT}`;
 async function isPortManagerPortAvailable() {
-    return ((await (0, detectPort_1.detectPort)(ports_1.PORT_MANAGER_SERVER_PORT)) === ports_1.PORT_MANAGER_SERVER_PORT);
+    return PortManagerServer_1.PortManagerServer.portAvailable();
 }
 exports.isPortManagerPortAvailable = isPortManagerPortAvailable;
 async function isPortManagerServerRunning() {

package/lib/trackUsage.d.ts

@@ -1 +1,3 @@
+export declare const CMS_CLI_USAGE_PATH: string;
+export declare const VSCODE_USAGE_PATH: string;
 export declare function trackUsage(eventName: string, eventClass: string, meta?: {}, accountId?: number): Promise<void>;

package/lib/trackUsage.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.trackUsage = void 0;
+exports.trackUsage = exports.VSCODE_USAGE_PATH = exports.CMS_CLI_USAGE_PATH = void 0;
 const axios_1 = __importDefault(require("axios"));
 const getAxiosConfig_1 = require("../http/getAxiosConfig");
 const logger_1 = require("./logger");
@@ -13,6 +13,8 @@ const fileMapper_1 = require("../api/fileMapper");
 const lang_1 = require("../utils/lang");
 const environment_1 = require("./environment");
 const i18nKey = 'lib.trackUsage';
+exports.CMS_CLI_USAGE_PATH = `${fileMapper_1.FILE_MAPPER_API_PATH}/cms-cli-usage`;
+exports.VSCODE_USAGE_PATH = `${fileMapper_1.FILE_MAPPER_API_PATH}/vscode-extension-usage`;
 async function trackUsage(eventName, eventClass, meta = {}, accountId) {
     const usageEvent = {
         accountId,
@@ -24,18 +26,17 @@ async function trackUsage(eventName, eventClass, meta = {}, accountId) {
         VSCODE_EXTENSION_INTERACTION: 'vscode-extension-interaction',
         CLI_INTERACTION: 'cli-interaction',
     };
-    let analyticsEndpoint;
+    let path = fileMapper_1.FILE_MAPPER_API_PATH;
     switch (eventName) {
         case EVENT_TYPES.CLI_INTERACTION:
-            analyticsEndpoint = 'cms-cli-usage';
+            path = exports.CMS_CLI_USAGE_PATH;
             break;
         case EVENT_TYPES.VSCODE_EXTENSION_INTERACTION:
-            analyticsEndpoint = 'vscode-extension-usage';
+            path = exports.VSCODE_USAGE_PATH;
             break;
         default:
             logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.invalidEvent`, { eventName }));
     }
-    const path = `${fileMapper_1.FILE_MAPPER_API_PATH}/${analyticsEndpoint}`;
     const account = accountId && (0, config_1.getConfigAccountById)(accountId);
     if (account && account.authType === 'personalaccesskey') {
         logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.sendingEventAuthenticated`));

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/local-dev-lib",
-    "version": "0.5.0-experimental.2",
+    "version": "0.5.0-experimental.3",
     "description": "Provides library functionality for HubSpot local development tooling, including the HubSpot CLI",
     "repository": {
         "type": "git",

package/types/Config.d.ts

@@ -29,7 +29,7 @@ export type GitInclusionResult = {
     gitignoreFiles: Array<string>;
 };
 export type ConfigFlag = ValueOf<typeof CONFIG_FLAGS>;
-export type CLIState = {
+export type HubSpotState = {
     mcpTotalToolCalls: number;
 };
 export type HubSpotConfigErrorType = ValueOf<typeof HUBSPOT_CONFIG_ERROR_TYPES>;

package/utils/PortManagerServer.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
-import { Express, Request, Response } from 'express';
+import { Express } from 'express';
 import { Server } from 'http';
-import { RequestPortsData, ServerPortMap } from '../types/PortManager';
+import { ServerPortMap } from '../types/PortManager';
 export declare const HEALTH_CHECK_PATH = "/port-manager-health-check";
 export declare const SERVICE_HEALTHY = "OK";
 declare class _PortManagerServer {
@@ -10,19 +10,18 @@ declare class _PortManagerServer {
     serverPortMap: ServerPortMap;
     constructor();
     init(): Promise<void>;
-    reset(): void;
-    listen(): Promise<Server>;
-    setupRoutes(): void;
-    setPort(instanceId: string, port: number): void;
-    deletePort(instanceId: string): void;
-    send404(res: Response, instanceId: string): void;
-    getServers: (req: Request, res: Response) => Promise<void>;
-    getServerPortByInstanceId: (req: Request, res: Response) => void;
-    assignPortsToServers: (req: Request<never, never, {
-        portData: Array<RequestPortsData>;
-    }>, res: Response) => Promise<void>;
-    deleteServerInstance: (req: Request, res: Response) => void;
-    closeServer: (req: Request, res: Response) => void;
+    private reset;
+    portAvailable(): Promise<boolean>;
+    private listen;
+    private setupRoutes;
+    private setPort;
+    private deletePort;
+    private send404;
+    private getServers;
+    private getServerPortByInstanceId;
+    private assignPortsToServers;
+    private deleteServerInstance;
+    private closeServer;
 }
 export declare const PortManagerServer: _PortManagerServer;
 export {};

package/utils/PortManagerServer.js

@@ -8,7 +8,6 @@ const express_1 = __importDefault(require("express"));
 const cors_1 = __importDefault(require("cors"));
 const detectPort_1 = require("./detectPort");
 const ports_1 = require("../constants/ports");
-const errors_1 = require("../errors");
 const logger_1 = require("../lib/logger");
 const lang_1 = require("./lang");
 const i18nKey = 'utils.PortManagerServer';
@@ -22,6 +21,11 @@ class _PortManagerServer {
         this.serverPortMap = {};
     }
     async init() {
+        if (!(await this.portAvailable())) {
+            throw new Error((0, lang_1.i18n)(`${i18nKey}.errors.portInUse`, {
+                port: ports_1.PORT_MANAGER_SERVER_PORT,
+            }));
+        }
         if (this.app) {
             throw new Error((0, lang_1.i18n)(`${i18nKey}.errors.duplicateInstance`));
         }
@@ -29,24 +33,17 @@ class _PortManagerServer {
         this.app.use(express_1.default.json());
         this.app.use((0, cors_1.default)());
         this.setupRoutes();
-        try {
-            this.server = await this.listen();
-            logger_1.logger.debug(this.server);
-        }
-        catch (e) {
-            if ((0, errors_1.isSystemError)(e) && e.code === 'EADDRINUSE') {
-                throw new Error((0, lang_1.i18n)(`${i18nKey}.errors.portInUse`, {
-                    port: ports_1.PORT_MANAGER_SERVER_PORT,
-                }), { cause: e });
-            }
-            throw e;
-        }
+        this.server = await this.listen();
+        logger_1.logger.debug(this.server);
     }
     reset() {
         this.app = undefined;
         this.server = undefined;
         this.serverPortMap = {};
     }
+    async portAvailable() {
+        return ((await (0, detectPort_1.detectPort)(ports_1.PORT_MANAGER_SERVER_PORT)) === ports_1.PORT_MANAGER_SERVER_PORT);
+    }
     listen() {
         return new Promise((resolve, reject) => {
             const server = this.app.listen(ports_1.PORT_MANAGER_SERVER_PORT, () => {