@hubspot/local-dev-lib 0.7.5-experimental.0 → 0.7.6-experimental.0

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.
package/api/projects.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { HubSpotPromise, QueryParams } from '../types/Http.js';
2
- import { Project, FetchProjectResponse, UploadProjectResponse, ProjectSettings, FetchPlatformVersionResponse, WarnLogsResponse, UploadIRResponse, Release, FetchListReleasesResponse } from '../types/Project.js';
2
+ import { Project, FetchProjectResponse, UploadProjectResponse, ProjectSettings, FetchPlatformVersionResponse, WarnLogsResponse, UploadIRResponse } from '../types/Project.js';
3
3
  import { Build, FetchProjectBuildsResponse } from '../types/Build.js';
4
4
  import { ComponentStructureResponse, ProjectComponentsMetadata } from '../types/ComponentStructure.js';
5
5
  import { Deploy, ProjectDeployResponse, ProjectDeployResponseV1 } from '../types/Deploy.js';
@@ -31,9 +31,6 @@ export declare function deleteFileFromBuild(accountId: number, projectName: stri
31
31
  export declare function cancelStagedBuild(accountId: number, projectName: string): HubSpotPromise<void>;
32
32
  export declare function fetchBuildWarnLogs(accountId: number, projectName: string, buildId: number): HubSpotPromise<WarnLogsResponse>;
33
33
  export declare function fetchDeployWarnLogs(accountId: number, projectName: string, deployId: number): HubSpotPromise<WarnLogsResponse>;
34
- export declare function createRelease(accountId: number, projectName: string, buildId: number): HubSpotPromise<Release>;
35
- export declare function listReleases(accountId: number, projectName: string, params?: QueryParams): HubSpotPromise<FetchListReleasesResponse>;
36
- export declare function getReleaseInfo(accountId: number, projectName: string, releaseTag: string): HubSpotPromise<Release>;
37
34
  /**
38
35
  * @deprecated
39
36
  */
package/api/projects.js CHANGED
@@ -202,23 +202,6 @@ export function fetchDeployWarnLogs(accountId, projectName, deployId) {
202
202
  url: `${PROJECTS_LOGS_API_PATH}/logs/projects/${encodeURIComponent(projectName)}/deploys/${deployId}/combined/warn`,
203
203
  });
204
204
  }
205
- export function createRelease(accountId, projectName, buildId) {
206
- return http.post(accountId, {
207
- url: `${PROJECTS_API_PATH}/${encodeURIComponent(projectName)}/releases`,
208
- data: { buildId },
209
- });
210
- }
211
- export function listReleases(accountId, projectName, params = {}) {
212
- return http.get(accountId, {
213
- url: `${PROJECTS_API_PATH}/${encodeURIComponent(projectName)}/releases`,
214
- params,
215
- });
216
- }
217
- export function getReleaseInfo(accountId, projectName, releaseTag) {
218
- return http.get(accountId, {
219
- url: `${PROJECTS_API_PATH}/${encodeURIComponent(projectName)}/releases/${encodeURIComponent(releaseTag)}`,
220
- });
221
- }
222
205
  /**
223
206
  * @deprecated
224
207
  */
@@ -1,8 +1,5 @@
1
1
  import { SandboxPersonalAccessKey, SandboxResponse, SandboxUsageLimitsResponse, V2Sandbox } from '../types/Sandbox.js';
2
2
  import { HubSpotPromise } from '../types/Http.js';
3
- /**
4
- * @deprecated Use createV2Sandbox instead
5
- */
6
3
  export declare function createSandbox(accountId: number, name: string, type: 1 | 2): HubSpotPromise<SandboxResponse>;
7
4
  export declare function deleteSandbox(parentAccountId: number, sandboxAccountId: number): HubSpotPromise<void>;
8
5
  export declare function getSandboxUsageLimits(parentAccountId: number): HubSpotPromise<SandboxUsageLimitsResponse>;
@@ -2,10 +2,6 @@ import { http } from '../http/index.js';
2
2
  import { SANDBOX_TIMEOUT } from '../constants/api.js';
3
3
  const SANDBOX_API_PATH = 'sandbox-hubs/v1';
4
4
  const SANDBOX_API_PATH_V2 = 'sandbox-hubs/v2';
5
- /* TODO: Delete createSandbox in the next major release (as of 2/20/2026) */
6
- /**
7
- * @deprecated Use createV2Sandbox instead
8
- */
9
5
  export function createSandbox(accountId, name, type) {
10
6
  return http.post(accountId, {
11
7
  data: { name, type, generatePersonalAccessKey: true }, // For CLI, generatePersonalAccessKey will always be true since we'll be saving the entry to the config
@@ -1,10 +1,4 @@
1
1
  import { InitiateSyncResponse, FetchTypesResponse, TaskRequestData } from '../types/Sandbox.js';
2
2
  import { HubSpotPromise } from '../types/Http.js';
3
- /**
4
- * @deprecated Sync functionality has been deprecated and will be removed in a future release.
5
- */
6
3
  export declare function initiateSync(fromHubId: number, toHubId: number, tasks: Array<TaskRequestData>, sandboxHubId: number): HubSpotPromise<InitiateSyncResponse>;
7
- /**
8
- * @deprecated
9
- */
10
4
  export declare function fetchTypes(accountId: number, toHubId: number): HubSpotPromise<FetchTypesResponse>;
@@ -1,10 +1,6 @@
1
1
  import { http } from '../http/index.js';
2
2
  import { SANDBOX_TIMEOUT } from '../constants/api.js';
3
3
  const SANDBOXES_SYNC_API_PATH = 'sandboxes-sync/v1';
4
- /* TODO: Delete this entire file in the next major release (as of 2/20/2026) */
5
- /**
6
- * @deprecated Sync functionality has been deprecated and will be removed in a future release.
7
- */
8
4
  export async function initiateSync(fromHubId, toHubId, tasks, sandboxHubId) {
9
5
  return http.post(fromHubId, {
10
6
  data: {
@@ -18,9 +14,6 @@ export async function initiateSync(fromHubId, toHubId, tasks, sandboxHubId) {
18
14
  url: `${SANDBOXES_SYNC_API_PATH}/tasks/initiate/async`,
19
15
  });
20
16
  }
21
- /**
22
- * @deprecated
23
- */
24
17
  export async function fetchTypes(accountId, toHubId) {
25
18
  return http.get(accountId, {
26
19
  url: `${SANDBOXES_SYNC_API_PATH}/types${toHubId ? `?toHubId=${toHubId}` : ''}`,
@@ -1,3 +1,4 @@
1
1
  import { HubSpotConfigAccount } from '../types/Accounts.js';
2
2
  export declare function getDefaultAccountOverrideAccountId(accounts: Array<HubSpotConfigAccount>): number | null;
3
+ export declare function removeDefaultAccountOverrideFile(): void;
3
4
  export declare function getDefaultAccountOverrideFilePath(): string | null;
@@ -40,6 +40,21 @@ export function getDefaultAccountOverrideAccountId(accounts) {
40
40
  }
41
41
  return account.accountId;
42
42
  }
43
+ export function removeDefaultAccountOverrideFile() {
44
+ const filePath = getDefaultAccountOverrideFilePath();
45
+ if (!filePath) {
46
+ return;
47
+ }
48
+ try {
49
+ fs.unlinkSync(filePath);
50
+ }
51
+ catch (e) {
52
+ throw new FileSystemError({ cause: e }, {
53
+ filepath: filePath,
54
+ operation: 'write',
55
+ });
56
+ }
57
+ }
43
58
  export function getDefaultAccountOverrideFilePath() {
44
59
  return findup([DEFAULT_ACCOUNT_OVERRIDE_FILE_NAME], {
45
60
  cwd: getCwd(),
@@ -0,0 +1,4 @@
1
+ import { HsSettingsFile } from '../types/HsSettings.js';
2
+ export declare function getHsSettingsFilePath(): string | null;
3
+ export declare function getHsSettingsFileIfExists(): HsSettingsFile | null;
4
+ export declare function writeHsSettingsFile(settingsFile: HsSettingsFile): void;
@@ -0,0 +1,57 @@
1
+ import findupSync from 'findup-sync';
2
+ import fs from 'fs';
3
+ import path from 'path';
4
+ import { HS_FOLDER, HS_README_FILENAME, HS_SETTINGS_FILENAME, } from '../constants/config.js';
5
+ import { getCwd } from '../lib/path.js';
6
+ import { FileSystemError } from '../models/FileSystemError.js';
7
+ const HS_README_CONTENTS = `Why do I have a folder named ".hs" in my project?
8
+ The ".hs" folder is created when you link a directory to a HubSpot project.
9
+
10
+ What does the "settings.json" file contain?
11
+ The "settings.json" file contains:
12
+ - The ID(s) of the HubSpot account(s) that you linked ("accounts")
13
+ - The ID of the HubSpot account that you set as the default for this directory ("linkedDefaultAccount")
14
+
15
+ Should I commit the ".hs" folder?
16
+ No, the ".hs" folder should not be committed to version control. It is automatically added to your .gitignore file when the directory is linked.
17
+ `;
18
+ export function getHsSettingsFilePath() {
19
+ return findupSync([`${HS_FOLDER}/${HS_SETTINGS_FILENAME}`], {
20
+ cwd: getCwd(),
21
+ });
22
+ }
23
+ export function getHsSettingsFileIfExists() {
24
+ const hsSettingsFilePath = getHsSettingsFilePath();
25
+ if (!hsSettingsFilePath) {
26
+ return null;
27
+ }
28
+ let hsSettingsFile;
29
+ try {
30
+ hsSettingsFile = JSON.parse(fs.readFileSync(hsSettingsFilePath, 'utf-8'));
31
+ }
32
+ catch (e) {
33
+ throw new FileSystemError({ cause: e }, {
34
+ filepath: hsSettingsFilePath,
35
+ operation: 'read',
36
+ });
37
+ }
38
+ return hsSettingsFile;
39
+ }
40
+ export function writeHsSettingsFile(settingsFile) {
41
+ const dir = getCwd();
42
+ const hsFolderPath = path.join(dir, HS_FOLDER);
43
+ const isFirstScaffold = !fs.existsSync(hsFolderPath);
44
+ try {
45
+ fs.mkdirSync(hsFolderPath, { recursive: true });
46
+ fs.writeFileSync(path.join(dir, HS_FOLDER, HS_SETTINGS_FILENAME), JSON.stringify(settingsFile, null, 2), 'utf8');
47
+ if (isFirstScaffold) {
48
+ fs.writeFileSync(path.join(hsFolderPath, HS_README_FILENAME), HS_README_CONTENTS, 'utf8');
49
+ }
50
+ }
51
+ catch (err) {
52
+ throw new FileSystemError({ cause: err }, {
53
+ filepath: dir,
54
+ operation: 'write',
55
+ });
56
+ }
57
+ }
package/config/index.d.ts CHANGED
@@ -18,6 +18,7 @@ export declare function getConfigAccountIfExists(identifier: number | string): H
18
18
  export declare function getConfigDefaultAccount(): HubSpotConfigAccount;
19
19
  export declare function getConfigDefaultAccountIfExists(): HubSpotConfigAccount | undefined;
20
20
  export declare function getAllConfigAccounts(): HubSpotConfigAccount[];
21
+ export declare function getLinkedOrAllConfigAccounts(): HubSpotConfigAccount[];
21
22
  export declare function getConfigAccountEnvironment(identifier: number | string): Environment;
22
23
  export declare function addConfigAccount(accountToAdd: HubSpotConfigAccount): void;
23
24
  export declare function updateConfigAccount(updatedAccount: HubSpotConfigAccount): void;
package/config/index.js CHANGED
@@ -11,6 +11,7 @@ import { HubSpotConfigError } from '../models/HubSpotConfigError.js';
11
11
  import { HUBSPOT_CONFIG_ERROR_TYPES } from '../constants/config.js';
12
12
  import { isDeepEqual } from '../lib/isDeepEqual.js';
13
13
  import { getCwd } from '../lib/path.js';
14
+ import { getHsSettingsFileIfExists } from './hsSettings.js';
14
15
  const EMPTY_CONFIG = { accounts: [] };
15
16
  export function getGlobalConfigFilePath() {
16
17
  return GLOBAL_CONFIG_PATH;
@@ -152,11 +153,17 @@ export function getConfigAccountIfExists(identifier) {
152
153
  export function getConfigDefaultAccount() {
153
154
  const { accounts, defaultAccount } = getConfig();
154
155
  let defaultAccountToUse = defaultAccount;
155
- const currentConfigPath = getConfigFilePath();
156
- const globalConfigPath = getGlobalConfigFilePath();
157
- if (currentConfigPath === globalConfigPath && globalConfigFileExists()) {
158
- const defaultAccountOverrideAccountId = getDefaultAccountOverrideAccountId(accounts);
159
- defaultAccountToUse = defaultAccountOverrideAccountId || defaultAccount;
156
+ const hsSettingsFile = getHsSettingsFileIfExists();
157
+ if (hsSettingsFile && hsSettingsFile.localDefaultAccount) {
158
+ defaultAccountToUse = hsSettingsFile.localDefaultAccount;
159
+ }
160
+ else {
161
+ const currentConfigPath = getConfigFilePath();
162
+ const globalConfigPath = getGlobalConfigFilePath();
163
+ if (currentConfigPath === globalConfigPath && globalConfigFileExists()) {
164
+ const defaultAccountOverrideAccountId = getDefaultAccountOverrideAccountId(accounts);
165
+ defaultAccountToUse = defaultAccountOverrideAccountId || defaultAccount;
166
+ }
160
167
  }
161
168
  if (!defaultAccountToUse) {
162
169
  throw new HubSpotConfigError(i18n('config.getConfigDefaultAccount.fieldMissingError'), HUBSPOT_CONFIG_ERROR_TYPES.NO_DEFAULT_ACCOUNT, HUBSPOT_CONFIG_OPERATIONS.READ);
@@ -172,12 +179,17 @@ export function getConfigDefaultAccount() {
172
179
  export function getConfigDefaultAccountIfExists() {
173
180
  const { accounts, defaultAccount } = getConfig();
174
181
  let defaultAccountToUse = defaultAccount;
175
- // Only check for default account override if we're using the global config
176
- const currentConfigPath = getConfigFilePath();
177
- const globalConfigPath = getGlobalConfigFilePath();
178
- if (currentConfigPath === globalConfigPath && globalConfigFileExists()) {
179
- const defaultAccountOverrideAccountId = getDefaultAccountOverrideAccountId(accounts);
180
- defaultAccountToUse = defaultAccountOverrideAccountId || defaultAccount;
182
+ const hsSettingsFile = getHsSettingsFileIfExists();
183
+ if (hsSettingsFile && hsSettingsFile.localDefaultAccount) {
184
+ defaultAccountToUse = hsSettingsFile.localDefaultAccount;
185
+ }
186
+ else {
187
+ const currentConfigPath = getConfigFilePath();
188
+ const globalConfigPath = getGlobalConfigFilePath();
189
+ if (currentConfigPath === globalConfigPath && globalConfigFileExists()) {
190
+ const defaultAccountOverrideAccountId = getDefaultAccountOverrideAccountId(accounts);
191
+ defaultAccountToUse = defaultAccountOverrideAccountId || defaultAccount;
192
+ }
181
193
  }
182
194
  if (!defaultAccountToUse) {
183
195
  return;
@@ -189,6 +201,14 @@ export function getAllConfigAccounts() {
189
201
  const { accounts } = getConfig();
190
202
  return accounts;
191
203
  }
204
+ export function getLinkedOrAllConfigAccounts() {
205
+ const { accounts } = getConfig();
206
+ const hsSettingsFile = getHsSettingsFileIfExists();
207
+ if (!hsSettingsFile || hsSettingsFile.accounts.length === 0) {
208
+ return accounts;
209
+ }
210
+ return accounts.filter(a => hsSettingsFile.accounts.includes(a.accountId));
211
+ }
192
212
  export function getConfigAccountEnvironment(identifier) {
193
213
  const config = getConfig();
194
214
  const account = getConfigAccountByInferredIdentifier(config.accounts, identifier);
@@ -102,3 +102,7 @@ export declare const HUBSPOT_CONFIG_OPERATIONS: {
102
102
  readonly WRITE: "WRITE";
103
103
  readonly DELETE: "DELETE";
104
104
  };
105
+ export declare const HS_FOLDER = ".hs";
106
+ export declare const HS_SETTINGS_FILENAME = "settings.json";
107
+ export declare const HS_README_FILENAME = "README.txt";
108
+ export declare const DEFAULT_HS_SETTINGS_PATH = ".hs/settings.json";
@@ -105,3 +105,7 @@ export const HUBSPOT_CONFIG_OPERATIONS = {
105
105
  WRITE: 'WRITE',
106
106
  DELETE: 'DELETE',
107
107
  };
108
+ export const HS_FOLDER = '.hs';
109
+ export const HS_SETTINGS_FILENAME = 'settings.json';
110
+ export const HS_README_FILENAME = 'README.txt';
111
+ export const DEFAULT_HS_SETTINGS_PATH = `${HS_FOLDER}/${HS_SETTINGS_FILENAME}`;
@@ -9,6 +9,5 @@ export declare const PLATFORM_VERSIONS: {
9
9
  v2025_1: string;
10
10
  v2025_2: string;
11
11
  v2026_03_beta: string;
12
- v2026_03: string;
13
12
  unstable: string;
14
13
  };
@@ -9,6 +9,5 @@ export const PLATFORM_VERSIONS = {
9
9
  v2025_1: '2025.1',
10
10
  v2025_2: '2025.2',
11
11
  v2026_03_beta: '2026.03-beta',
12
- v2026_03: '2026.03',
13
12
  unstable: 'unstable',
14
13
  };
@@ -1,3 +1,4 @@
1
1
  import { GitInclusionResult } from '../types/Config.js';
2
2
  export declare function checkAndAddConfigToGitignore(configPath: string): void;
3
+ export declare function checkAndAddHsFolderToGitignore(settingsPath: string): void;
3
4
  export declare function checkGitInclusion(configPath: string): GitInclusionResult;
package/lib/gitignore.js CHANGED
@@ -1,7 +1,7 @@
1
1
  import fs from 'fs-extra';
2
2
  import path from 'path';
3
3
  import { isConfigPathInGitRepo, getGitignoreFiles, configFilenameIsIgnoredByGitignore, } from '../utils/git.js';
4
- import { DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME } from '../constants/config.js';
4
+ import { DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME, HS_FOLDER, } from '../constants/config.js';
5
5
  import { i18n } from '../utils/lang.js';
6
6
  const i18nKey = 'lib.gitignore';
7
7
  const GITIGNORE_FILE = '.gitignore';
@@ -23,6 +23,27 @@ export function checkAndAddConfigToGitignore(configPath) {
23
23
  throw new Error(i18n(`${i18nKey}.errors.configIgnore`), { cause: e });
24
24
  }
25
25
  }
26
+ export function checkAndAddHsFolderToGitignore(settingsPath) {
27
+ try {
28
+ const hsDirPath = path.resolve(path.dirname(settingsPath));
29
+ const { configIgnored, gitignoreFiles } = checkGitInclusion(hsDirPath);
30
+ if (configIgnored)
31
+ return;
32
+ let gitignoreFilePath = gitignoreFiles && gitignoreFiles.length ? gitignoreFiles[0] : null;
33
+ if (!gitignoreFilePath) {
34
+ gitignoreFilePath = path.join(path.dirname(hsDirPath), GITIGNORE_FILE);
35
+ fs.writeFileSync(gitignoreFilePath, '');
36
+ }
37
+ const gitignoreContents = fs.readFileSync(gitignoreFilePath).toString();
38
+ if (gitignoreContents.includes(HS_FOLDER))
39
+ return;
40
+ const updatedContents = `${gitignoreContents.trim()}\n\n# HubSpot link folder\n${HS_FOLDER}\n`;
41
+ fs.writeFileSync(gitignoreFilePath, updatedContents);
42
+ }
43
+ catch (e) {
44
+ throw new Error(i18n(`${i18nKey}.errors.configIgnore`), { cause: e });
45
+ }
46
+ }
26
47
  export function checkGitInclusion(configPath) {
27
48
  const result = {
28
49
  inGit: false,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hubspot/local-dev-lib",
3
- "version": "0.7.5-experimental.0",
3
+ "version": "0.7.6-experimental.0",
4
4
  "type": "module",
5
5
  "description": "Provides library functionality for HubSpot local development tooling, including the HubSpot CLI",
6
6
  "repository": {
@@ -55,6 +55,7 @@
55
55
  "./config/defaultAccountOverride": "./config/defaultAccountOverride.js",
56
56
  "./config/migrate": "./config/migrate.js",
57
57
  "./config/state": "./config/state.js",
58
+ "./config/hsSettings": "./config/hsSettings.js",
58
59
  "./config": "./config/index.js",
59
60
  "./constants/*": "./constants/*.js",
60
61
  "./enums/*": "./enums/*.js",
@@ -0,0 +1,4 @@
1
+ export type HsSettingsFile = {
2
+ localDefaultAccount: number | undefined;
3
+ accounts: number[];
4
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -1,8 +1,6 @@
1
1
  import type { Build } from './Build.js';
2
2
  import { GithubSourceData } from './Github.js';
3
3
  import { ProjectLog } from './ProjectLog.js';
4
- import { ValueOf } from './Utils.js';
5
- import { SUBBUILD_TYPES } from '../enums/build.js';
6
4
  export type Project = {
7
5
  createdAt: number;
8
6
  deletedAt: number;
@@ -50,22 +48,3 @@ export type FetchPlatformVersionResponse = {
50
48
  export type WarnLogsResponse = {
51
49
  logs: Array<ProjectLog>;
52
50
  };
53
- export type Release = {
54
- releaseTag: string;
55
- buildId: number;
56
- createdAt: string;
57
- components?: Array<{
58
- buildType: ValueOf<typeof SUBBUILD_TYPES>;
59
- buildName?: string;
60
- rootPath?: string;
61
- id?: string;
62
- }>;
63
- };
64
- export type FetchListReleasesResponse = {
65
- results: Array<Release>;
66
- paging: {
67
- next: {
68
- after: string;
69
- };
70
- };
71
- };
@@ -138,9 +138,6 @@ export type V2Sandbox = {
138
138
  updatedAt?: string;
139
139
  updatedByUser?: User | null;
140
140
  };
141
- /**
142
- * @deprecated This type is deprecated and will be removed in the next major release.
143
- */
144
141
  export type SandboxResponse = {
145
142
  sandbox: Sandbox;
146
143
  personalAccessKey: string;
@@ -179,9 +176,6 @@ export type SandboxType = {
179
176
  groupType: string;
180
177
  syncMandatory: boolean;
181
178
  };
182
- /**
183
- * @deprecated This type is deprecated and will be removed in the next major release.
184
- */
185
179
  export type FetchTypesResponse = {
186
180
  results: Array<SandboxType>;
187
181
  };