@hubspot/cli 7.8.12-experimental.0 → 7.8.12-experimental.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (244) hide show
  1. package/bin/cli.js +31 -25
  2. package/commands/__tests__/auth.test.js +5 -0
  3. package/commands/__tests__/doctor.test.js +16 -16
  4. package/commands/account/clean.js +18 -27
  5. package/commands/account/createOverride.js +13 -31
  6. package/commands/account/info.js +20 -31
  7. package/commands/account/list.js +16 -22
  8. package/commands/account/remove.js +12 -20
  9. package/commands/account/removeOverride.js +11 -21
  10. package/commands/account/rename.js +6 -9
  11. package/commands/account/use.js +12 -26
  12. package/commands/account.js +2 -2
  13. package/commands/app/__tests__/migrate.test.js +5 -5
  14. package/commands/app/migrate.js +13 -18
  15. package/commands/app.js +1 -6
  16. package/commands/auth.d.ts +1 -0
  17. package/commands/auth.js +16 -7
  18. package/commands/cms/convertFields.js +7 -9
  19. package/commands/cms/getReactModule.js +9 -14
  20. package/commands/cms/lighthouseScore.js +33 -36
  21. package/commands/cms.js +2 -2
  22. package/commands/completion.js +3 -3
  23. package/commands/config/set.d.ts +1 -1
  24. package/commands/config/set.js +64 -36
  25. package/commands/config.js +2 -2
  26. package/commands/create.js +2 -2
  27. package/commands/customObject/create.js +10 -12
  28. package/commands/customObject/schema/create.js +9 -11
  29. package/commands/customObject/schema/delete.js +16 -16
  30. package/commands/customObject/schema/fetch-all.js +12 -11
  31. package/commands/customObject/schema/fetch.js +15 -15
  32. package/commands/customObject/schema/list.js +4 -4
  33. package/commands/customObject/schema/update.js +13 -13
  34. package/commands/customObject/schema.js +2 -2
  35. package/commands/customObject.js +6 -7
  36. package/commands/doctor.js +8 -11
  37. package/commands/feedback.js +6 -11
  38. package/commands/fetch.js +8 -8
  39. package/commands/filemanager/fetch.js +7 -7
  40. package/commands/filemanager/upload.js +15 -34
  41. package/commands/filemanager.js +2 -2
  42. package/commands/function/deploy.js +11 -29
  43. package/commands/function/list.js +8 -8
  44. package/commands/function/server.js +9 -11
  45. package/commands/function.d.ts +1 -1
  46. package/commands/function.js +2 -2
  47. package/commands/getStarted.js +2 -2
  48. package/commands/hubdb/clear.js +7 -15
  49. package/commands/hubdb/create.js +9 -15
  50. package/commands/hubdb/delete.js +8 -15
  51. package/commands/hubdb/fetch.js +6 -9
  52. package/commands/hubdb.d.ts +1 -1
  53. package/commands/hubdb.js +2 -2
  54. package/commands/init.js +2 -3
  55. package/commands/lint.js +16 -16
  56. package/commands/list.js +8 -14
  57. package/commands/logs.js +14 -20
  58. package/commands/mv.js +6 -17
  59. package/commands/open.js +5 -5
  60. package/commands/project/__tests__/add.test.js +4 -2
  61. package/commands/project/__tests__/deploy.test.js +3 -4
  62. package/commands/project/__tests__/installDeps.test.js +8 -8
  63. package/commands/project/__tests__/logs.test.js +1 -1
  64. package/commands/project/__tests__/migrate.test.js +5 -5
  65. package/commands/project/__tests__/migrateApp.test.js +2 -5
  66. package/commands/project/__tests__/validate.test.js +98 -0
  67. package/commands/project/add.js +3 -3
  68. package/commands/project/cloneApp.js +14 -19
  69. package/commands/project/create.js +0 -1
  70. package/commands/project/deploy.js +3 -3
  71. package/commands/project/dev/deprecatedFlow.js +7 -16
  72. package/commands/project/dev/index.js +14 -12
  73. package/commands/project/dev/unifiedFlow.js +3 -1
  74. package/commands/project/download.js +10 -13
  75. package/commands/project/installDeps.js +8 -8
  76. package/commands/project/listBuilds.js +11 -20
  77. package/commands/project/logs.js +21 -24
  78. package/commands/project/migrateApp.js +9 -15
  79. package/commands/project/open.js +6 -13
  80. package/commands/project/upload.d.ts +2 -2
  81. package/commands/project/upload.js +17 -26
  82. package/commands/project/validate.js +6 -6
  83. package/commands/project/watch.js +13 -22
  84. package/commands/project.js +2 -2
  85. package/commands/sandbox/__tests__/create.test.js +5 -5
  86. package/commands/sandbox/create.js +22 -32
  87. package/commands/sandbox/delete.js +38 -63
  88. package/commands/sandbox.js +2 -2
  89. package/commands/secret/addSecret.js +7 -17
  90. package/commands/secret/deleteSecret.js +10 -20
  91. package/commands/secret/listSecret.js +8 -10
  92. package/commands/secret/updateSecret.js +9 -17
  93. package/commands/secret.js +2 -2
  94. package/commands/testAccount/__tests__/delete.test.js +2 -4
  95. package/commands/testAccount/create.js +0 -3
  96. package/commands/testAccount/delete.d.ts +4 -3
  97. package/commands/testAccount/delete.js +155 -14
  98. package/commands/theme/preview.js +1 -4
  99. package/lang/en.d.ts +310 -124
  100. package/lang/en.js +351 -169
  101. package/lang/en.lyaml +2 -2
  102. package/lib/__tests__/buildAccount.test.js +2 -1
  103. package/lib/__tests__/commonOpts.test.js +1 -1
  104. package/lib/__tests__/dependencyManagement.test.js +1 -1
  105. package/lib/__tests__/developerTestAccounts.test.js +3 -3
  106. package/lib/__tests__/npm.test.js +1 -1
  107. package/lib/__tests__/oauth.test.js +4 -4
  108. package/lib/__tests__/process.test.js +10 -5
  109. package/lib/__tests__/sandboxSync.test.js +8 -8
  110. package/lib/__tests__/sandboxes.test.js +8 -8
  111. package/lib/__tests__/serverlessLogs.test.js +1 -1
  112. package/lib/__tests__/usageTracking.test.js +5 -5
  113. package/lib/__tests__/validation.test.js +2 -1
  114. package/lib/__tests__/yargsUtils.test.js +83 -9
  115. package/lib/app/__tests__/migrate.test.js +5 -5
  116. package/lib/app/__tests__/migrate_legacy.test.js +1 -1
  117. package/lib/app/migrate.js +1 -1
  118. package/lib/app/migrate_legacy.js +20 -24
  119. package/lib/buildAccount.js +25 -57
  120. package/lib/commonOpts.d.ts +1 -1
  121. package/lib/commonOpts.js +25 -22
  122. package/lib/configOptions.js +7 -0
  123. package/lib/constants.d.ts +6 -1
  124. package/lib/constants.js +10 -1
  125. package/lib/dependencyManagement.js +9 -27
  126. package/lib/developerTestAccounts.js +9 -23
  127. package/lib/doctor/Diagnosis.js +11 -23
  128. package/lib/doctor/DiagnosticInfoBuilder.js +12 -11
  129. package/lib/doctor/Doctor.js +42 -90
  130. package/lib/doctor/__tests__/Doctor.test.js +4 -4
  131. package/lib/errorHandlers/index.js +12 -20
  132. package/lib/errorHandlers/suppressError.js +11 -18
  133. package/lib/lang.js +6 -5
  134. package/lib/links.js +4 -4
  135. package/lib/middleware/__test__/commandTargetingUtils.test.js +99 -0
  136. package/lib/middleware/__test__/configMiddleware.test.js +11 -11
  137. package/lib/middleware/__test__/yargsChecksMiddleware.test.js +6 -8
  138. package/lib/middleware/commandTargetingUtils.d.ts +8 -0
  139. package/lib/middleware/commandTargetingUtils.js +78 -0
  140. package/lib/middleware/configMiddleware.d.ts +1 -1
  141. package/lib/middleware/configMiddleware.js +21 -81
  142. package/lib/middleware/gitMiddleware.js +5 -1
  143. package/lib/middleware/notificationsMiddleware.js +5 -11
  144. package/lib/middleware/yargsChecksMiddleware.js +6 -9
  145. package/lib/npm.js +2 -2
  146. package/lib/oauth.js +5 -5
  147. package/lib/process.js +5 -4
  148. package/lib/projectProfiles.d.ts +1 -1
  149. package/lib/projectProfiles.js +2 -10
  150. package/lib/projects/__tests__/AppDevModeInterface.test.js +14 -34
  151. package/lib/projects/__tests__/LocalDevWebsocketServer.test.js +70 -39
  152. package/lib/projects/__tests__/localDevProjectHelpers.test.js +2 -0
  153. package/lib/projects/__tests__/platformVersion.test.js +8 -8
  154. package/lib/projects/__tests__/projects.test.js +12 -12
  155. package/lib/projects/__tests__/structure.test.js +3 -3
  156. package/lib/projects/__tests__/upload.test.d.ts +1 -0
  157. package/lib/projects/__tests__/upload.test.js +82 -0
  158. package/lib/projects/add/__tests__/legacyAddComponent.test.js +6 -6
  159. package/lib/projects/add/__tests__/v3AddComponent.test.js +4 -4
  160. package/lib/projects/create/__tests__/legacy.test.js +5 -5
  161. package/lib/projects/create/__tests__/v3.test.js +1 -1
  162. package/lib/projects/create/index.js +2 -2
  163. package/lib/projects/create/legacy.js +2 -2
  164. package/lib/projects/create/v3.js +2 -2
  165. package/lib/projects/localDev/AppDevModeInterface.d.ts +2 -0
  166. package/lib/projects/localDev/AppDevModeInterface.js +22 -20
  167. package/lib/projects/localDev/LocalDevLogger.js +10 -11
  168. package/lib/projects/localDev/LocalDevManager.js +4 -5
  169. package/lib/projects/localDev/LocalDevWebsocketServer.d.ts +0 -1
  170. package/lib/projects/localDev/LocalDevWebsocketServer.js +7 -10
  171. package/lib/projects/localDev/helpers/project.d.ts +1 -0
  172. package/lib/projects/localDev/helpers/project.js +37 -0
  173. package/lib/projects/platformVersion.d.ts +1 -1
  174. package/lib/projects/platformVersion.js +1 -1
  175. package/lib/projects/structure.d.ts +2 -2
  176. package/lib/projects/structure.js +6 -6
  177. package/lib/projects/upload.d.ts +2 -3
  178. package/lib/projects/upload.js +17 -9
  179. package/lib/prompts/__tests__/downloadProjectPrompt.test.js +1 -0
  180. package/lib/prompts/accountNamePrompt.js +14 -19
  181. package/lib/prompts/accountsPrompt.js +2 -2
  182. package/lib/prompts/cmsFieldPrompt.js +2 -2
  183. package/lib/prompts/createApiSamplePrompt.js +5 -5
  184. package/lib/prompts/createDeveloperTestAccountConfigPrompt.js +10 -1
  185. package/lib/prompts/createFunctionPrompt.js +14 -14
  186. package/lib/prompts/createModulePrompt.js +9 -9
  187. package/lib/prompts/createTemplatePrompt.js +2 -2
  188. package/lib/prompts/downloadProjectPrompt.js +5 -8
  189. package/lib/prompts/personalAccessKeyPrompt.js +3 -3
  190. package/lib/prompts/previewPrompt.js +6 -6
  191. package/lib/prompts/projectAddPrompt.js +6 -0
  192. package/lib/prompts/projectDevTargetAccountPrompt.js +20 -32
  193. package/lib/prompts/projectNamePrompt.js +4 -8
  194. package/lib/prompts/projectsLogsPrompt.js +2 -4
  195. package/lib/prompts/promptUtils.js +27 -9
  196. package/lib/prompts/sandboxesPrompt.js +7 -7
  197. package/lib/prompts/secretPrompt.js +3 -3
  198. package/lib/prompts/selectAppPrompt.js +3 -3
  199. package/lib/prompts/selectHubDBTablePrompt.js +9 -13
  200. package/lib/prompts/selectPublicAppForMigrationPrompt.js +15 -19
  201. package/lib/prompts/setAsDefaultAccountPrompt.js +4 -8
  202. package/lib/prompts/uploadPrompt.js +5 -5
  203. package/lib/sandboxSync.js +24 -41
  204. package/lib/sandboxes.js +19 -47
  205. package/lib/schema.js +3 -3
  206. package/lib/serverlessLogs.js +11 -13
  207. package/lib/theme/__tests__/migrate.test.js +3 -3
  208. package/lib/theme/migrate.js +2 -2
  209. package/lib/ui/SpinniesManager.d.ts +2 -0
  210. package/lib/ui/SpinniesManager.js +7 -0
  211. package/lib/ui/boxen.js +1 -2
  212. package/lib/ui/git.js +13 -10
  213. package/lib/ui/index.d.ts +4 -0
  214. package/lib/ui/index.js +47 -38
  215. package/lib/ui/serverlessFunctionLogs.js +9 -7
  216. package/lib/ui/uiMessages.d.ts +68 -0
  217. package/lib/ui/uiMessages.js +71 -0
  218. package/lib/usageTracking.js +7 -7
  219. package/lib/validation.js +20 -23
  220. package/lib/yargsUtils.d.ts +1 -1
  221. package/lib/yargsUtils.js +12 -5
  222. package/mcp-server/tools/cms/HsCreateModuleTool.d.ts +2 -2
  223. package/mcp-server/tools/index.js +4 -0
  224. package/mcp-server/tools/project/GetApiUsagePatternsByAppIdTool.d.ts +23 -0
  225. package/mcp-server/tools/project/GetApiUsagePatternsByAppIdTool.js +68 -0
  226. package/mcp-server/tools/project/GetApplicationInfoTool.d.ts +11 -0
  227. package/mcp-server/tools/project/GetApplicationInfoTool.js +49 -0
  228. package/mcp-server/tools/project/GetConfigValuesTool.js +2 -2
  229. package/mcp-server/tools/project/GuidedWalkthroughTool.d.ts +2 -2
  230. package/mcp-server/tools/project/__tests__/GetApiUsagePatternsByAppIdTool.test.d.ts +1 -0
  231. package/mcp-server/tools/project/__tests__/GetApiUsagePatternsByAppIdTool.test.js +169 -0
  232. package/mcp-server/tools/project/__tests__/GetApplicationInfoTool.test.d.ts +1 -0
  233. package/mcp-server/tools/project/__tests__/GetApplicationInfoTool.test.js +115 -0
  234. package/mcp-server/utils/toolUsageTracking.js +2 -2
  235. package/package.json +6 -6
  236. package/types/Yargs.d.ts +1 -1
  237. package/commands/app/__tests__/install.test.js +0 -47
  238. package/commands/app/install.d.ts +0 -8
  239. package/commands/app/install.js +0 -122
  240. package/lib/middleware/__test__/utils.test.js +0 -51
  241. package/lib/middleware/utils.d.ts +0 -8
  242. package/lib/middleware/utils.js +0 -14
  243. /package/commands/{app/__tests__/install.test.d.ts → project/__tests__/validate.test.d.ts} +0 -0
  244. /package/lib/middleware/__test__/{utils.test.d.ts → commandTargetingUtils.test.d.ts} +0 -0
package/lib/validation.js CHANGED
@@ -1,6 +1,6 @@
1
1
  import * as fs from 'fs';
2
2
  import * as path from 'path';
3
- import { logger } from '@hubspot/local-dev-lib/logger';
3
+ import { uiLogger } from '../lib/ui/logger.js';
4
4
  import { CMS_PUBLISH_MODE } from '@hubspot/local-dev-lib/constants/files';
5
5
  import { API_KEY_AUTH_METHOD, OAUTH_AUTH_METHOD, PERSONAL_ACCESS_KEY_AUTH_METHOD, } from '@hubspot/local-dev-lib/constants/auth';
6
6
  import { commaSeparatedValues } from '@hubspot/local-dev-lib/text';
@@ -10,43 +10,43 @@ import { accessTokenForPersonalAccessKey } from '@hubspot/local-dev-lib/personal
10
10
  import { getAbsoluteFilePath, getCwd, getExt, } from '@hubspot/local-dev-lib/path';
11
11
  import { getCmsPublishMode } from './commonOpts.js';
12
12
  import { logError } from './errorHandlers/index.js';
13
+ import { lib } from '../lang/en.js';
13
14
  export async function validateAccount(options) {
14
15
  const { derivedAccountId, userProvidedAccount } = options;
15
16
  const accountId = getAccountId(derivedAccountId);
16
17
  if (!accountId) {
17
18
  if (userProvidedAccount) {
18
- logger.error(`The account "${userProvidedAccount}" could not be found in the config`);
19
+ uiLogger.error(lib.validation.accountNotFoundInConfig(userProvidedAccount));
19
20
  }
20
21
  else {
21
- logger.error('An account needs to be supplied either via "--account" or through setting a "defaultPortal"');
22
+ uiLogger.error(lib.validation.accountRequired);
22
23
  }
23
24
  return false;
24
25
  }
25
26
  if (userProvidedAccount && loadConfigFromEnvironment()) {
26
- throw new Error('Cannot specify an account when environment variables are supplied. Please unset the environment variables or do not use the "--account" flag.');
27
+ throw new Error(lib.validation.userProvidedAccount);
27
28
  }
28
29
  const accountConfig = getAccountConfig(accountId);
29
30
  if (!accountConfig) {
30
- logger.error(`The account ${accountId} has not been configured`);
31
+ uiLogger.error(lib.validation.accountNotConfigured(accountId));
31
32
  return false;
32
33
  }
33
34
  const { authType, auth, apiKey, personalAccessKey } = accountConfig;
34
35
  if (typeof authType === 'string' && authType !== authType.toLowerCase()) {
35
- logger.error(`Invalid "authType" value "${authType}" for account "${accountId}" in config file: ${getConfigPath()}. Valid values are ${commaSeparatedValues([
36
+ uiLogger.error(lib.validation.invalidAuthType(authType, accountId, getConfigPath() || '', commaSeparatedValues([
36
37
  PERSONAL_ACCESS_KEY_AUTH_METHOD,
37
38
  OAUTH_AUTH_METHOD,
38
39
  API_KEY_AUTH_METHOD,
39
- ].map(method => method.value))}.`);
40
+ ].map(method => method.value))));
40
41
  }
41
42
  if (authType === 'oauth2') {
42
43
  if (typeof auth !== 'object') {
43
- logger.error(`The OAuth2 auth configuration for account ${accountId} is missing`);
44
+ uiLogger.error(lib.validation.oauth2ConfigMissing(accountId));
44
45
  return false;
45
46
  }
46
47
  const { clientId, clientSecret, tokenInfo } = auth;
47
48
  if (!clientId || !clientSecret || !tokenInfo || !tokenInfo.refreshToken) {
48
- logger.error(`The OAuth2 configuration for account ${accountId} is incorrect`);
49
- logger.error('Run "hs auth --type=oauth2" to reauthenticate');
49
+ uiLogger.error(lib.validation.oauth2ConfigIncorrect(accountId));
50
50
  return false;
51
51
  }
52
52
  const oauth = getOauthManager(accountId, accountConfig);
@@ -56,7 +56,7 @@ export async function validateAccount(options) {
56
56
  accessToken = await oauth.accessToken();
57
57
  }
58
58
  if (!accessToken) {
59
- logger.error(`The OAuth2 access token could not be found for accountId ${accountId}`);
59
+ uiLogger.error(lib.validation.oauth2AccessTokenNotFound(accountId));
60
60
  return false;
61
61
  }
62
62
  }
@@ -67,13 +67,13 @@ export async function validateAccount(options) {
67
67
  }
68
68
  else if (authType === 'personalaccesskey') {
69
69
  if (!personalAccessKey) {
70
- logger.error(`The account "${accountId}" is configured to use a access key for authentication and is missing a "personalAccessKey" in the configuration file`);
70
+ uiLogger.error(lib.validation.personalAccessKeyMissing(accountId));
71
71
  return false;
72
72
  }
73
73
  try {
74
74
  const accessToken = await accessTokenForPersonalAccessKey(accountId);
75
75
  if (!accessToken) {
76
- logger.error(`An OAuth2 access token for account "${accountId} could not be retrieved using the "personalAccessKey" provided`);
76
+ uiLogger.error(lib.validation.personalAccessKeyTokenRetrievalFailed(accountId));
77
77
  return false;
78
78
  }
79
79
  }
@@ -83,7 +83,7 @@ export async function validateAccount(options) {
83
83
  }
84
84
  }
85
85
  else if (!apiKey) {
86
- logger.error(`The accountId ${accountId} is missing authentication configuration`);
86
+ uiLogger.error(lib.validation.authConfigurationMissing(accountId));
87
87
  return false;
88
88
  }
89
89
  return true;
@@ -93,15 +93,12 @@ export function validateCmsPublishMode(options) {
93
93
  if (CMS_PUBLISH_MODE[cmsPublishMode]) {
94
94
  return true;
95
95
  }
96
- const modesMessage = `Available CMS publish modes are: ${Object.values(CMS_PUBLISH_MODE).join(', ')}.`;
96
+ const modesMessage = lib.validation.availableCMSModes(Object.values(CMS_PUBLISH_MODE).join(', '));
97
97
  if (cmsPublishMode != null) {
98
- logger.error([
99
- `The CMS publish mode "${cmsPublishMode}" is invalid.`,
100
- modesMessage,
101
- ].join(' '));
98
+ uiLogger.error(lib.validation.invalidCmsPublishMode(cmsPublishMode, modesMessage));
102
99
  }
103
100
  else {
104
- logger.error(['The CMS publish mode option is missing.', modesMessage].join(' '));
101
+ uiLogger.error(lib.validation.missingCmsPublishMode(modesMessage));
105
102
  }
106
103
  return false;
107
104
  }
@@ -124,11 +121,11 @@ export function fileExists(_path) {
124
121
  export function checkAndConvertToJson(_path) {
125
122
  const filePath = getAbsoluteFilePath(_path);
126
123
  if (!fileExists(filePath)) {
127
- logger.error(`The path "${_path}" is not a path to a file`);
124
+ uiLogger.error(lib.validation.pathNotFile(_path));
128
125
  return null;
129
126
  }
130
127
  if (getExt(_path) !== 'json') {
131
- logger.error(`The file "${_path}" must be a valid JSON file`);
128
+ uiLogger.error(lib.validation.fileNotJson(_path));
132
129
  return null;
133
130
  }
134
131
  let result;
@@ -136,7 +133,7 @@ export function checkAndConvertToJson(_path) {
136
133
  result = JSON.parse(fs.readFileSync(filePath, 'utf-8'));
137
134
  }
138
135
  catch (e) {
139
- logger.error(`The file "${_path}" contains invalid JSON`);
136
+ uiLogger.error(lib.validation.fileInvalidJson(_path));
140
137
  result = null;
141
138
  }
142
139
  return result;
@@ -13,4 +13,4 @@ export declare function makeYargsBuilder<T>(callback: (yargs: Argv) => Argv<T>,
13
13
  };
14
14
  useJSONOutputOptions?: boolean;
15
15
  }): (yargs: Argv) => Promise<Argv<T>>;
16
- export declare function getExclusiveConflicts(options: string[]): Record<string, string[]>;
16
+ export declare function strictEnforceBoolean(rawArgs: string[], booleanOptions: string[]): boolean;
package/lib/yargsUtils.js CHANGED
@@ -1,5 +1,6 @@
1
1
  import { addCustomHelpOutput, addTestingOptions, addAccountOptions, addConfigOptions, addGlobalOptions, addUseEnvironmentOptions, addCmsPublishModeOptions, addJSONOutputOptions, } from './commonOpts.js';
2
2
  import { hasFlag } from './utils/hasFlag.js';
3
+ import { commands } from '../lang/en.js';
3
4
  // Re-export for backwards compatibility
4
5
  export { hasFlag };
5
6
  export function makeYargsBuilder(callback, command, describe, options = {}) {
@@ -34,9 +35,15 @@ export function makeYargsBuilder(callback, command, describe, options = {}) {
34
35
  return result;
35
36
  };
36
37
  }
37
- export function getExclusiveConflicts(options) {
38
- return options.reduce((acc, curr) => {
39
- acc[curr] = options.filter(s => s !== curr);
40
- return acc;
41
- }, {});
38
+ export function strictEnforceBoolean(rawArgs, booleanOptions) {
39
+ for (const option of booleanOptions) {
40
+ const argIndex = rawArgs.findIndex(arg => arg.startsWith(`--${option}=`));
41
+ if (argIndex !== -1) {
42
+ const value = rawArgs[argIndex].split('=')[1];
43
+ if (value && !['true', 'false'].includes(value.toLowerCase())) {
44
+ throw new Error(commands.config.subcommands.set.errors.invalidBoolean(option, value));
45
+ }
46
+ }
47
+ }
48
+ return true;
42
49
  }
@@ -13,19 +13,19 @@ declare const inputSchemaZodObject: z.ZodObject<{
13
13
  }, "strip", z.ZodTypeAny, {
14
14
  absoluteCurrentWorkingDirectory: string;
15
15
  dest?: string | undefined;
16
- global?: boolean | undefined;
17
16
  moduleLabel?: string | undefined;
18
17
  reactType?: boolean | undefined;
19
18
  contentTypes?: string | undefined;
19
+ global?: boolean | undefined;
20
20
  availableForNewContent?: boolean | undefined;
21
21
  userSuppliedName?: string | undefined;
22
22
  }, {
23
23
  absoluteCurrentWorkingDirectory: string;
24
24
  dest?: string | undefined;
25
- global?: boolean | undefined;
26
25
  moduleLabel?: string | undefined;
27
26
  reactType?: boolean | undefined;
28
27
  contentTypes?: string | undefined;
28
+ global?: boolean | undefined;
29
29
  availableForNewContent?: boolean | undefined;
30
30
  userSuppliedName?: string | undefined;
31
31
  }>;
@@ -7,6 +7,8 @@ import { ValidateProjectTool } from './project/ValidateProjectTool.js';
7
7
  import { GetConfigValuesTool } from './project/GetConfigValuesTool.js';
8
8
  import { DocsSearchTool } from './project/DocsSearchTool.js';
9
9
  import { DocFetchTool } from './project/DocFetchTool.js';
10
+ import { GetApiUsagePatternsByAppIdTool } from './project/GetApiUsagePatternsByAppIdTool.js';
11
+ import { GetApplicationInfoTool } from './project/GetApplicationInfoTool.js';
10
12
  import { HsListTool } from './cms/HsListTool.js';
11
13
  import { HsCreateModuleTool } from './cms/HsCreateModuleTool.js';
12
14
  import { HsCreateTemplateTool } from './cms/HsCreateTemplateTool.js';
@@ -24,6 +26,8 @@ export function registerProjectTools(mcpServer) {
24
26
  new GetConfigValuesTool(mcpServer).register(),
25
27
  new DocsSearchTool(mcpServer).register(),
26
28
  new DocFetchTool(mcpServer).register(),
29
+ new GetApiUsagePatternsByAppIdTool(mcpServer).register(),
30
+ new GetApplicationInfoTool(mcpServer).register(),
27
31
  ];
28
32
  }
29
33
  export function registerCmsTools(mcpServer) {
@@ -0,0 +1,23 @@
1
+ import { TextContentResponse, Tool } from '../../types.js';
2
+ import { McpServer, RegisteredTool } from '@modelcontextprotocol/sdk/server/mcp.js';
3
+ import { z } from 'zod';
4
+ declare const inputSchemaZodObject: z.ZodObject<{
5
+ appId: z.ZodString;
6
+ startDate: z.ZodOptional<z.ZodString>;
7
+ endDate: z.ZodOptional<z.ZodString>;
8
+ }, "strip", z.ZodTypeAny, {
9
+ appId: string;
10
+ startDate?: string | undefined;
11
+ endDate?: string | undefined;
12
+ }, {
13
+ appId: string;
14
+ startDate?: string | undefined;
15
+ endDate?: string | undefined;
16
+ }>;
17
+ export type GetApiUsagePatternsByAppIdInputSchema = z.infer<typeof inputSchemaZodObject>;
18
+ export declare class GetApiUsagePatternsByAppIdTool extends Tool<GetApiUsagePatternsByAppIdInputSchema> {
19
+ constructor(mcpServer: McpServer);
20
+ handler({ appId, startDate, endDate, }: GetApiUsagePatternsByAppIdInputSchema): Promise<TextContentResponse>;
21
+ register(): RegisteredTool;
22
+ }
23
+ export {};
@@ -0,0 +1,68 @@
1
+ import { Tool } from '../../types.js';
2
+ import { z } from 'zod';
3
+ import { trackToolUsage } from '../../utils/toolUsageTracking.js';
4
+ import { http } from '@hubspot/local-dev-lib/http';
5
+ import { formatTextContents } from '../../utils/content.js';
6
+ import { isHubSpotHttpError } from '@hubspot/local-dev-lib/errors/index';
7
+ import { getAccountId } from '@hubspot/local-dev-lib/config';
8
+ const inputSchema = {
9
+ appId: z
10
+ .string()
11
+ .regex(/^\d+$/, 'App ID must be a numeric string')
12
+ .describe('The numeric app ID as a string (e.g., "3003909"). Use get-applications-info to find available app IDs.'),
13
+ startDate: z
14
+ .string()
15
+ .regex(/^\d{4}-\d{2}-\d{2}$/, 'Start date must be in YYYY-MM-DD format')
16
+ .optional()
17
+ .describe('Start date for the usage patterns query in ISO 8601 format (e.g., 2025-01-01).'),
18
+ endDate: z
19
+ .string()
20
+ .regex(/^\d{4}-\d{2}-\d{2}$/, 'End date must be in YYYY-MM-DD format')
21
+ .optional()
22
+ .describe('End date for the usage patterns query in ISO 8601 format (e.g., 2025-12-31).'),
23
+ };
24
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
25
+ const inputSchemaZodObject = z.object({ ...inputSchema });
26
+ const toolName = 'get-api-usage-patterns-by-app-id';
27
+ export class GetApiUsagePatternsByAppIdTool extends Tool {
28
+ constructor(mcpServer) {
29
+ super(mcpServer);
30
+ }
31
+ async handler({ appId, startDate, endDate, }) {
32
+ await trackToolUsage(toolName);
33
+ try {
34
+ // Get account ID from CLI config
35
+ const accountId = getAccountId();
36
+ if (!accountId) {
37
+ const authErrorMessage = `No account ID found. Please run \`hs account auth\` to configure an account, or set a default account with \`hs account use <account>\``;
38
+ return formatTextContents(authErrorMessage);
39
+ }
40
+ const response = await http.get(accountId, {
41
+ url: `app/feature/utilization/public/v3/insights/app/${appId}/usage-patterns`,
42
+ params: {
43
+ ...(startDate && { startDate }),
44
+ ...(endDate && { endDate }),
45
+ },
46
+ });
47
+ // Format the response for display
48
+ const { data } = response;
49
+ const formattedResult = JSON.stringify(data, null, 2);
50
+ return formatTextContents(formattedResult);
51
+ }
52
+ catch (error) {
53
+ if (isHubSpotHttpError(error)) {
54
+ // Handle HubSpot-specific HTTP errors
55
+ return formatTextContents(error.toString());
56
+ }
57
+ const errorMessage = `${error instanceof Error ? error.message : String(error)}`;
58
+ return formatTextContents(errorMessage);
59
+ }
60
+ }
61
+ register() {
62
+ return this.mcpServer.registerTool(toolName, {
63
+ title: 'Get API Usage Patterns by App ID',
64
+ description: 'Retrieves detailed API usage pattern analytics for a specific HubSpot application. Requires an appId (string) to identify the target application. Optionally accepts startDate and endDate parameters in YYYY-MM-DD format to filter results within a specific time range. Returns patternSummaries object containing usage statistics including portalPercentage (percentage of portals using this pattern) and numOfPortals (total count of portals) for different usage patterns. This data helps analyze how the application is being used across different HubSpot portals and can inform optimization decisions.',
65
+ inputSchema,
66
+ }, this.handler);
67
+ }
68
+ }
@@ -0,0 +1,11 @@
1
+ import { TextContentResponse, Tool } from '../../types.js';
2
+ import { McpServer, RegisteredTool } from '@modelcontextprotocol/sdk/server/mcp.js';
3
+ import { z } from 'zod';
4
+ declare const inputSchemaZodObject: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
5
+ export type GetApplicationInfoInputSchema = z.infer<typeof inputSchemaZodObject>;
6
+ export declare class GetApplicationInfoTool extends Tool<GetApplicationInfoInputSchema> {
7
+ constructor(mcpServer: McpServer);
8
+ handler({}: GetApplicationInfoInputSchema): Promise<TextContentResponse>;
9
+ register(): RegisteredTool;
10
+ }
11
+ export {};
@@ -0,0 +1,49 @@
1
+ import { Tool } from '../../types.js';
2
+ import { z } from 'zod';
3
+ import { trackToolUsage } from '../../utils/toolUsageTracking.js';
4
+ import { http } from '@hubspot/local-dev-lib/http';
5
+ import { formatTextContents } from '../../utils/content.js';
6
+ import { isHubSpotHttpError } from '@hubspot/local-dev-lib/errors/index';
7
+ import { getAccountId } from '@hubspot/local-dev-lib/config';
8
+ const inputSchema = {};
9
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
10
+ const inputSchemaZodObject = z.object({ ...inputSchema });
11
+ const toolName = 'get-applications-info';
12
+ export class GetApplicationInfoTool extends Tool {
13
+ constructor(mcpServer) {
14
+ super(mcpServer);
15
+ }
16
+ async handler({}) {
17
+ await trackToolUsage(toolName);
18
+ try {
19
+ // Get account ID from CLI config
20
+ const accountId = getAccountId();
21
+ if (!accountId) {
22
+ const authErrorMessage = `No account ID found. Please run \`hs account auth\` to configure an account, or set a default account with \`hs account use <account>\``;
23
+ return formatTextContents(authErrorMessage);
24
+ }
25
+ const response = await http.get(accountId, {
26
+ url: `app/feature/utilization/public/v3/insights/apps`,
27
+ });
28
+ // Format the response for display
29
+ const { data } = response;
30
+ const formattedResult = JSON.stringify(data, null, 2);
31
+ return formatTextContents(formattedResult);
32
+ }
33
+ catch (error) {
34
+ if (isHubSpotHttpError(error)) {
35
+ // Handle HubSpot-specific HTTP errors
36
+ return formatTextContents(error.toString());
37
+ }
38
+ const errorMessage = `${error instanceof Error ? error.message : String(error)}`;
39
+ return formatTextContents(errorMessage);
40
+ }
41
+ }
42
+ register() {
43
+ return this.mcpServer.registerTool(toolName, {
44
+ title: 'Get Applications Information',
45
+ description: 'Retrieves a list of all HubSpot applications available in the current account. Returns an array of applications, where each application contains an appId (numeric identifier) and appName (string). This information is useful for identifying available applications before using other tools that require specific application IDs, such as getting API usage patterns. No input parameters are required - this tool fetches all applications from the HubSpot Insights API.',
46
+ inputSchema,
47
+ }, this.handler);
48
+ }
49
+ }
@@ -3,7 +3,7 @@ import { z } from 'zod';
3
3
  import { formatTextContents } from '../../utils/content.js';
4
4
  import { absoluteCurrentWorkingDirectory } from './constants.js';
5
5
  import { getIntermediateRepresentationSchema, mapToInternalType, } from '@hubspot/project-parsing-lib';
6
- import { useV3Api } from '../../../lib/projects/platformVersion.js';
6
+ import { isV2Project } from '../../../lib/projects/platformVersion.js';
7
7
  import { getAccountIdFromCliConfig } from '../../utils/cliConfig.js';
8
8
  const inputSchema = {
9
9
  absoluteCurrentWorkingDirectory,
@@ -25,7 +25,7 @@ export class GetConfigValuesTool extends Tool {
25
25
  }
26
26
  async handler({ absoluteCurrentWorkingDirectory, platformVersion, featureType, }) {
27
27
  try {
28
- if (!useV3Api(platformVersion)) {
28
+ if (!isV2Project(platformVersion)) {
29
29
  return formatTextContents(`Can only be used on projects with a minimum platformVersion of 2025.2`);
30
30
  }
31
31
  const accountId = getAccountIdFromCliConfig(absoluteCurrentWorkingDirectory);
@@ -4,9 +4,9 @@ import { z } from 'zod';
4
4
  declare const inputSchemaZodObject: z.ZodObject<{
5
5
  command: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"hs init">, z.ZodLiteral<"hs auth">, z.ZodLiteral<"hs project create">, z.ZodLiteral<"hs project upload">]>>;
6
6
  }, "strip", z.ZodTypeAny, {
7
- command?: "hs auth" | "hs project upload" | "hs project create" | "hs init" | undefined;
7
+ command?: "hs auth" | "hs project create" | "hs project upload" | "hs init" | undefined;
8
8
  }, {
9
- command?: "hs auth" | "hs project upload" | "hs project create" | "hs init" | undefined;
9
+ command?: "hs auth" | "hs project create" | "hs project upload" | "hs init" | undefined;
10
10
  }>;
11
11
  type InputSchemaType = z.infer<typeof inputSchemaZodObject>;
12
12
  export declare class GuidedWalkthroughTool extends Tool<InputSchemaType> {
@@ -0,0 +1,169 @@
1
+ import { GetApiUsagePatternsByAppIdTool } from '../GetApiUsagePatternsByAppIdTool.js';
2
+ import { z } from 'zod';
3
+ import { getAccountId } from '@hubspot/local-dev-lib/config';
4
+ import { http } from '@hubspot/local-dev-lib/http';
5
+ import { isHubSpotHttpError } from '@hubspot/local-dev-lib/errors/index';
6
+ vi.mock('@modelcontextprotocol/sdk/server/mcp.js');
7
+ vi.mock('../../../utils/toolUsageTracking');
8
+ vi.mock('@hubspot/local-dev-lib/http');
9
+ vi.mock('@hubspot/local-dev-lib/errors/index');
10
+ vi.mock('@hubspot/local-dev-lib/config');
11
+ const mockGetAccountId = getAccountId;
12
+ const mockHttp = http;
13
+ const mockIsHubSpotHttpError = isHubSpotHttpError;
14
+ describe('mcp-server/tools/project/GetApiUsagePatternsByAppIdTool', () => {
15
+ let mockMcpServer;
16
+ let tool;
17
+ let mockRegisteredTool;
18
+ beforeEach(() => {
19
+ vi.clearAllMocks();
20
+ // @ts-expect-error Not mocking the whole thing
21
+ mockMcpServer = {
22
+ registerTool: vi.fn(),
23
+ };
24
+ mockRegisteredTool = {};
25
+ mockMcpServer.registerTool.mockReturnValue(mockRegisteredTool);
26
+ tool = new GetApiUsagePatternsByAppIdTool(mockMcpServer);
27
+ });
28
+ describe('register', () => {
29
+ it('should register tool with correct parameters', () => {
30
+ const result = tool.register();
31
+ expect(mockMcpServer.registerTool).toHaveBeenCalledWith('get-api-usage-patterns-by-app-id', {
32
+ title: 'Get API Usage Patterns by App ID',
33
+ description: 'Retrieves detailed API usage pattern analytics for a specific HubSpot application. Requires an appId (string) to identify the target application. Optionally accepts startDate and endDate parameters in YYYY-MM-DD format to filter results within a specific time range. Returns patternSummaries object containing usage statistics including portalPercentage (percentage of portals using this pattern) and numOfPortals (total count of portals) for different usage patterns. This data helps analyze how the application is being used across different HubSpot portals and can inform optimization decisions.',
34
+ inputSchema: expect.objectContaining({
35
+ appId: expect.objectContaining({
36
+ describe: expect.any(Function),
37
+ }),
38
+ startDate: expect.objectContaining({
39
+ optional: expect.any(Function),
40
+ }),
41
+ endDate: expect.objectContaining({
42
+ optional: expect.any(Function),
43
+ }),
44
+ }),
45
+ }, tool.handler);
46
+ expect(result).toBe(mockRegisteredTool);
47
+ });
48
+ });
49
+ describe('input validation', () => {
50
+ const inputSchema = z.object({
51
+ appId: z
52
+ .string()
53
+ .describe('The application ID to get API usage patterns for.'),
54
+ startDate: z
55
+ .string()
56
+ .regex(/^\d{4}-\d{2}-\d{2}$/, 'Start date must be in YYYY-MM-DD format')
57
+ .optional()
58
+ .describe('Start date for the usage patterns query in ISO 8601 format (e.g., 2025-01-01).'),
59
+ endDate: z
60
+ .string()
61
+ .regex(/^\d{4}-\d{2}-\d{2}$/, 'End date must be in YYYY-MM-DD format')
62
+ .optional()
63
+ .describe('End date for the usage patterns query in ISO 8601 format (e.g., 2025-12-31).'),
64
+ });
65
+ it('should validate date format correctly', () => {
66
+ const validInput = {
67
+ appId: '12345',
68
+ startDate: '2025-01-01',
69
+ endDate: '2025-12-31',
70
+ };
71
+ const invalidInput = {
72
+ appId: '12345',
73
+ startDate: '2025-1-1',
74
+ endDate: '2025-12-31T00:00:00Z',
75
+ };
76
+ expect(() => inputSchema.parse(validInput)).not.toThrow();
77
+ expect(() => inputSchema.parse(invalidInput)).toThrow();
78
+ });
79
+ });
80
+ describe('handler', () => {
81
+ const input = {
82
+ appId: '12345',
83
+ startDate: '2025-01-01',
84
+ endDate: '2025-12-31',
85
+ };
86
+ beforeEach(() => {
87
+ mockGetAccountId.mockReturnValue(123456789);
88
+ mockIsHubSpotHttpError.mockReturnValue(false);
89
+ });
90
+ it('should return API usage patterns successfully', async () => {
91
+ const mockResponse = {
92
+ data: {
93
+ patternSummaries: {
94
+ additionalProp1: {
95
+ portalPercentage: 25.5,
96
+ numOfPortals: 150,
97
+ },
98
+ additionalProp2: {
99
+ portalPercentage: 18.2,
100
+ numOfPortals: 89,
101
+ },
102
+ additionalProp3: {
103
+ portalPercentage: 32.1,
104
+ numOfPortals: 201,
105
+ },
106
+ },
107
+ },
108
+ status: 200,
109
+ statusText: 'OK',
110
+ headers: {},
111
+ config: { headers: {} },
112
+ };
113
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
114
+ mockHttp.get.mockResolvedValue(mockResponse);
115
+ const result = await tool.handler(input);
116
+ expect(mockGetAccountId).toHaveBeenCalledWith();
117
+ expect(mockHttp.get).toHaveBeenCalledWith(123456789, {
118
+ url: 'app/feature/utilization/public/v3/insights/app/12345/usage-patterns',
119
+ params: {
120
+ startDate: '2025-01-01',
121
+ endDate: '2025-12-31',
122
+ },
123
+ });
124
+ expect(result).toEqual({
125
+ content: [
126
+ {
127
+ type: 'text',
128
+ text: JSON.stringify(mockResponse.data, null, 2),
129
+ },
130
+ ],
131
+ });
132
+ });
133
+ it('should return error when account ID cannot be determined', async () => {
134
+ mockGetAccountId.mockReturnValue(null);
135
+ const result = await tool.handler(input);
136
+ expect(result).toEqual({
137
+ content: [
138
+ {
139
+ type: 'text',
140
+ text: 'No account ID found. Please run `hs account auth` to configure an account, or set a default account with `hs account use <account>`',
141
+ },
142
+ ],
143
+ });
144
+ expect(mockHttp.get).not.toHaveBeenCalled();
145
+ });
146
+ it('should handle empty usage patterns response', async () => {
147
+ const mockResponse = {
148
+ data: {
149
+ patternSummaries: {},
150
+ },
151
+ status: 200,
152
+ statusText: 'OK',
153
+ headers: {},
154
+ config: { headers: {} },
155
+ };
156
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
157
+ mockHttp.get.mockResolvedValue(mockResponse);
158
+ const result = await tool.handler(input);
159
+ expect(result).toEqual({
160
+ content: [
161
+ {
162
+ type: 'text',
163
+ text: JSON.stringify(mockResponse.data, null, 2),
164
+ },
165
+ ],
166
+ });
167
+ });
168
+ });
169
+ });