chore: update config flags and state vars (#362)

Author: brandenrodgers

config/__tests__/migrate.test.ts

@@ -12,11 +12,8 @@ import {
 import { HubSpotConfig } from '../../types/Config';
 import { readConfigFile, writeConfigFile } from '../utils';
 import {
-  DEFAULT_CMS_PUBLISH_MODE,
-  HTTP_TIMEOUT,
+  CONFIG_FLAGS,
   ENV,
-  HTTP_USE_LOCALHOST,
-  ALLOW_USAGE_TRACKING,
   DEFAULT_ACCOUNT,
   ARCHIVED_HUBSPOT_CONFIG_YAML_FILE_NAME,
 } from '../../constants/config';
@@ -134,12 +131,12 @@ describe('config/migrate', () => {
       expect(result.configWithMergedProperties).toEqual(toConfig);
       expect(result.conflicts).toHaveLength(6);
       expect(result.conflicts).toContainEqual({
-        property: DEFAULT_CMS_PUBLISH_MODE,
+        property: CONFIG_FLAGS.DEFAULT_CMS_PUBLISH_MODE,
         oldValue: 'draft',
         newValue: 'publish',
       });
       expect(result.conflicts).toContainEqual({
-        property: HTTP_TIMEOUT,
+        property: CONFIG_FLAGS.HTTP_TIMEOUT,
         oldValue: 5000,
         newValue: 3000,
       });
@@ -149,12 +146,12 @@ describe('config/migrate', () => {
         newValue: ENVIRONMENTS.QA,
       });
       expect(result.conflicts).toContainEqual({
-        property: HTTP_USE_LOCALHOST,
+        property: CONFIG_FLAGS.HTTP_USE_LOCALHOST,
         oldValue: false,
         newValue: true,
       });
       expect(result.conflicts).toContainEqual({
-        property: ALLOW_USAGE_TRACKING,
+        property: CONFIG_FLAGS.ALLOW_USAGE_TRACKING,
         oldValue: true,
         newValue: false,
       });

config/index.ts

@@ -7,6 +7,7 @@ import {
   GLOBAL_CONFIG_PATH,
   HUBSPOT_CONFIG_OPERATIONS,
   MIN_HTTP_TIMEOUT,
+  HUBSPOT_CONFIG_ERROR_TYPES,
   ENVIRONMENT_VARIABLES,
 } from '../constants/config';
 import { HubSpotConfigAccount } from '../types/Accounts';
@@ -37,7 +38,6 @@ import { i18n } from '../utils/lang';
 import { getDefaultAccountOverrideAccountId } from './defaultAccountOverride';
 import { getValidEnv } from '../lib/environment';
 import { HubSpotConfigError } from '../models/HubSpotConfigError';
-import { HUBSPOT_CONFIG_ERROR_TYPES } from '../constants/config';
 import { isDeepEqual } from '../lib/isDeepEqual';
 import { getCwd } from '../lib/path';
 

config/migrate.ts

@@ -3,15 +3,10 @@ import fs from 'fs';
 import { HubSpotConfig } from '../types/Config';
 import { createEmptyConfigFile, getGlobalConfigFilePath } from './index';
 import {
-  DEFAULT_CMS_PUBLISH_MODE,
-  HTTP_TIMEOUT,
   ENV,
-  HTTP_USE_LOCALHOST,
-  ALLOW_USAGE_TRACKING,
   DEFAULT_ACCOUNT,
-  AUTO_OPEN_BROWSER,
-  ALLOW_AUTO_UPDATES,
   ARCHIVED_HUBSPOT_CONFIG_YAML_FILE_NAME,
+  CONFIG_FLAGS,
 } from '../constants/config';
 import { parseConfig, readConfigFile, writeConfigFile } from './utils';
 import { ValueOf } from '../types/Utils';
@@ -77,13 +72,13 @@ export function mergeConfigProperties(
     toConfig.defaultAccount ||= fromConfig.defaultAccount;
 
     const propertiesToCheck = [
-      DEFAULT_CMS_PUBLISH_MODE,
-      HTTP_TIMEOUT,
+      CONFIG_FLAGS.DEFAULT_CMS_PUBLISH_MODE,
+      CONFIG_FLAGS.HTTP_TIMEOUT,
+      CONFIG_FLAGS.HTTP_USE_LOCALHOST,
+      CONFIG_FLAGS.ALLOW_USAGE_TRACKING,
+      CONFIG_FLAGS.AUTO_OPEN_BROWSER,
+      CONFIG_FLAGS.ALLOW_AUTO_UPDATES,
       ENV,
-      HTTP_USE_LOCALHOST,
-      ALLOW_USAGE_TRACKING,
-      AUTO_OPEN_BROWSER,
-      ALLOW_AUTO_UPDATES,
       DEFAULT_ACCOUNT,
     ] as const;
 

config/state.ts

@@ -4,12 +4,12 @@ import { i18n } from '../utils/lang';
 import { STATE_FILE_PATH } from '../constants/config';
 import { logger } from '../lib/logger';
 import { HubSpotState } from '../types/Config';
-import { MCP_TOTAL_TOOL_CALLS_STATE } from '../constants/config';
+import { STATE_FLAGS } from '../constants/config';
 
 const i18nKey = 'config.state';
 
 const DEFAULT_STATE: HubSpotState = {
-  [MCP_TOTAL_TOOL_CALLS_STATE]: 0,
+  [STATE_FLAGS.MCP_TOTAL_TOOL_CALLS]: 0,
 };
 
 function ensureCLIDirectory(): void {

constants/config.ts

@@ -28,18 +28,37 @@ export const DEFAULT_ACCOUNT_OVERRIDE_ERROR_INVALID_ID =
 export const DEFAULT_ACCOUNT_OVERRIDE_ERROR_ACCOUNT_NOT_FOUND =
   'DEFAULT_ACCOUNT_OVERRIDE_ERROR_ACCOUNT_NOT_FOUND';
 
+/**
+ * @deprecated Use CONFIG_FLAGS.DEFAULT_CMS_PUBLISH_MODE instead
+ */
 export const DEFAULT_CMS_PUBLISH_MODE = 'defaultCmsPublishMode';
+/**
+ * @deprecated Use CONFIG_FLAGS.HTTP_TIMEOUT instead
+ */
 export const HTTP_TIMEOUT = 'httpTimeout';
-export const ENV = 'env';
+/**
+ * @deprecated Use CONFIG_FLAGS.HTTP_USE_LOCALHOST instead
+ */
 export const HTTP_USE_LOCALHOST = 'httpUseLocalhost';
+/**
+ * @deprecated Use CONFIG_FLAGS.ALLOW_USAGE_TRACKING instead
+ */
 export const ALLOW_USAGE_TRACKING = 'allowUsageTracking';
+/**
+ * @deprecated Use CONFIG_FLAGS.AUTO_OPEN_BROWSER instead
+ */
 export const AUTO_OPEN_BROWSER = 'autoOpenBrowser';
+/**
+ * @deprecated Use CONFIG_FLAGS.ALLOW_AUTO_UPDATES instead
+ */
 export const ALLOW_AUTO_UPDATES = 'allowAutoUpdates';
+export const ENV = 'env';
 export const DEFAULT_ACCOUNT = 'defaultAccount';
 export const DEFAULT_PORTAL = 'defaultPortal';
-
 export const MIN_HTTP_TIMEOUT = 3000;
-
+/**
+ * @deprecated Use STATE_FLAGS.MCP_TOTAL_TOOL_CALLS instead
+ */
 export const MCP_TOTAL_TOOL_CALLS_STATE = 'mcpTotalToolCalls';
 
 export const HUBSPOT_ACCOUNT_TYPES = {
@@ -58,9 +77,18 @@ export const HUBSPOT_ACCOUNT_TYPE_STRINGS = {
   STANDARD: i18n('lib.accountTypes.standard'),
 } as const;
 
+export const STATE_FLAGS = {
+  MCP_TOTAL_TOOL_CALLS: 'mcpTotalToolCalls',
+} as const;
+
 export const CONFIG_FLAGS = {
+  DEFAULT_CMS_PUBLISH_MODE: 'defaultCmsPublishMode',
   USE_CUSTOM_OBJECT_HUBFILE: 'useCustomObjectHubfile',
   HTTP_USE_LOCALHOST: 'httpUseLocalhost',
+  HTTP_TIMEOUT: 'httpTimeout',
+  ALLOW_AUTO_UPDATES: 'allowAutoUpdates',
+  ALLOW_USAGE_TRACKING: 'allowUsageTracking',
+  AUTO_OPEN_BROWSER: 'autoOpenBrowser',
 } as const;
 
 export const ENVIRONMENT_VARIABLES = {