@hubspot/local-dev-lib 5.3.3 → 5.4.0-beta.0

package/config/defaultAccountOverride.d.ts

@@ -1,3 +1,4 @@
 import { HubSpotConfigAccount } from '../types/Accounts.js';
 export declare function getDefaultAccountOverrideAccountId(accounts: Array<HubSpotConfigAccount>): number | null;
+export declare function removeDefaultAccountOverrideFile(): void;
 export declare function getDefaultAccountOverrideFilePath(): string | null;

package/config/defaultAccountOverride.js

@@ -40,6 +40,21 @@ export function getDefaultAccountOverrideAccountId(accounts) {
     }
     return account.accountId;
 }
+export function removeDefaultAccountOverrideFile() {
+    const filePath = getDefaultAccountOverrideFilePath();
+    if (!filePath) {
+        return;
+    }
+    try {
+        fs.unlinkSync(filePath);
+    }
+    catch (e) {
+        throw new FileSystemError({ cause: e }, {
+            filepath: filePath,
+            operation: 'write',
+        });
+    }
+}
 export function getDefaultAccountOverrideFilePath() {
     return findup([DEFAULT_ACCOUNT_OVERRIDE_FILE_NAME], {
         cwd: getCwd(),

package/config/hsSettings.d.ts

@@ -0,0 +1,4 @@
+import { HsSettingsFile } from '../types/HsSettings.js';
+export declare function getHsSettingsFilePath(): string | null;
+export declare function getHsSettingsFileIfExists(): HsSettingsFile | null;
+export declare function writeHsSettingsFile(settingsFile: HsSettingsFile): void;

package/config/hsSettings.js

@@ -0,0 +1,55 @@
+import findupSync from 'findup-sync';
+import fs from 'fs';
+import path from 'path';
+import { HS_FOLDER, HS_README_FILENAME, HS_SETTINGS_FILENAME, } from '../constants/config.js';
+import { getCwd } from '../lib/path.js';
+import { FileSystemError } from '../models/FileSystemError.js';
+const HS_README_CONTENTS = `Why do I have a folder named ".hs" in my project?
+The ".hs" folder is created when you link a directory to a HubSpot project.
+
+What does the "settings.json" file contain?
+The "settings.json" file contains:
+- The ID(s) of the HubSpot account(s) that you linked ("accounts")
+- The ID of the HubSpot account that you set as the default for this directory ("linkedDefaultAccount")
+
+Should I commit the ".hs" folder?
+No, the ".hs" folder should not be committed to version control. It is automatically added to your .gitignore file when the directory is linked.
+`;
+export function getHsSettingsFilePath() {
+    return findupSync([`${HS_FOLDER}/${HS_SETTINGS_FILENAME}`], {
+        cwd: getCwd(),
+    });
+}
+export function getHsSettingsFileIfExists() {
+    const hsSettingsFilePath = getHsSettingsFilePath();
+    if (!hsSettingsFilePath) {
+        return null;
+    }
+    try {
+        return JSON.parse(fs.readFileSync(hsSettingsFilePath, 'utf-8'));
+    }
+    catch (e) {
+        throw new FileSystemError({ cause: e }, {
+            filepath: hsSettingsFilePath,
+            operation: 'read',
+        });
+    }
+}
+export function writeHsSettingsFile(settingsFile) {
+    const dir = getCwd();
+    const hsFolderPath = path.join(dir, HS_FOLDER);
+    const isFirstScaffold = !fs.existsSync(hsFolderPath);
+    try {
+        fs.mkdirSync(hsFolderPath, { recursive: true });
+        fs.writeFileSync(path.join(dir, HS_FOLDER, HS_SETTINGS_FILENAME), JSON.stringify(settingsFile, null, 2), 'utf8');
+        if (isFirstScaffold) {
+            fs.writeFileSync(path.join(hsFolderPath, HS_README_FILENAME), HS_README_CONTENTS, 'utf8');
+        }
+    }
+    catch (err) {
+        throw new FileSystemError({ cause: err }, {
+            filepath: dir,
+            operation: 'write',
+        });
+    }
+}

package/config/index.d.ts

@@ -18,6 +18,7 @@ export declare function getConfigAccountIfExists(identifier: number | string): H
 export declare function getConfigDefaultAccount(): HubSpotConfigAccount;
 export declare function getConfigDefaultAccountIfExists(): HubSpotConfigAccount | undefined;
 export declare function getAllConfigAccounts(): HubSpotConfigAccount[];
+export declare function getLinkedOrAllConfigAccounts(): HubSpotConfigAccount[];
 export declare function getConfigAccountEnvironment(identifier: number | string): Environment;
 export declare function addConfigAccount(accountToAdd: HubSpotConfigAccount): void;
 export declare function updateConfigAccount(updatedAccount: HubSpotConfigAccount): void;

package/config/index.js

@@ -11,6 +11,7 @@ import { HubSpotConfigError } from '../models/HubSpotConfigError.js';
 import { HUBSPOT_CONFIG_ERROR_TYPES } from '../constants/config.js';
 import { isDeepEqual } from '../lib/isDeepEqual.js';
 import { getCwd } from '../lib/path.js';
+import { getHsSettingsFileIfExists } from './hsSettings.js';
 const EMPTY_CONFIG = { accounts: [] };
 export function getGlobalConfigFilePath() {
     return GLOBAL_CONFIG_PATH;
@@ -152,11 +153,17 @@ export function getConfigAccountIfExists(identifier) {
 export function getConfigDefaultAccount() {
     const { accounts, defaultAccount } = getConfig();
     let defaultAccountToUse = defaultAccount;
-    const currentConfigPath = getConfigFilePath();
-    const globalConfigPath = getGlobalConfigFilePath();
-    if (currentConfigPath === globalConfigPath && globalConfigFileExists()) {
-        const defaultAccountOverrideAccountId = getDefaultAccountOverrideAccountId(accounts);
-        defaultAccountToUse = defaultAccountOverrideAccountId || defaultAccount;
+    const hsSettingsFile = getHsSettingsFileIfExists();
+    if (hsSettingsFile && hsSettingsFile.localDefaultAccount) {
+        defaultAccountToUse = hsSettingsFile.localDefaultAccount;
+    }
+    else {
+        const currentConfigPath = getConfigFilePath();
+        const globalConfigPath = getGlobalConfigFilePath();
+        if (currentConfigPath === globalConfigPath && globalConfigFileExists()) {
+            const defaultAccountOverrideAccountId = getDefaultAccountOverrideAccountId(accounts);
+            defaultAccountToUse = defaultAccountOverrideAccountId || defaultAccount;
+        }
     }
     if (!defaultAccountToUse) {
         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() {
 export function getConfigDefaultAccountIfExists() {
     const { accounts, defaultAccount } = getConfig();
     let defaultAccountToUse = defaultAccount;
-    // Only check for default account override if we're using the global config
-    const currentConfigPath = getConfigFilePath();
-    const globalConfigPath = getGlobalConfigFilePath();
-    if (currentConfigPath === globalConfigPath && globalConfigFileExists()) {
-        const defaultAccountOverrideAccountId = getDefaultAccountOverrideAccountId(accounts);
-        defaultAccountToUse = defaultAccountOverrideAccountId || defaultAccount;
+    const hsSettingsFile = getHsSettingsFileIfExists();
+    if (hsSettingsFile && hsSettingsFile.localDefaultAccount) {
+        defaultAccountToUse = hsSettingsFile.localDefaultAccount;
+    }
+    else {
+        const currentConfigPath = getConfigFilePath();
+        const globalConfigPath = getGlobalConfigFilePath();
+        if (currentConfigPath === globalConfigPath && globalConfigFileExists()) {
+            const defaultAccountOverrideAccountId = getDefaultAccountOverrideAccountId(accounts);
+            defaultAccountToUse = defaultAccountOverrideAccountId || defaultAccount;
+        }
     }
     if (!defaultAccountToUse) {
         return;
@@ -189,6 +201,14 @@ export function getAllConfigAccounts() {
     const { accounts } = getConfig();
     return accounts;
 }
+export function getLinkedOrAllConfigAccounts() {
+    const { accounts } = getConfig();
+    const hsSettingsFile = getHsSettingsFileIfExists();
+    if (!hsSettingsFile || hsSettingsFile.accounts.length === 0) {
+        return accounts;
+    }
+    return accounts.filter(a => hsSettingsFile.accounts.includes(a.accountId));
+}
 export function getConfigAccountEnvironment(identifier) {
     const config = getConfig();
     const account = getConfigAccountByInferredIdentifier(config.accounts, identifier);

package/constants/config.d.ts

@@ -103,3 +103,11 @@ export declare const HUBSPOT_CONFIG_OPERATIONS: {
     readonly WRITE: "WRITE";
     readonly DELETE: "DELETE";
 };
+export declare const HS_FOLDER = ".hs";
+export declare const HS_SETTINGS_FILENAME = "settings.json";
+export declare const HS_README_FILENAME = "README.txt";
+export declare const DEFAULT_HS_SETTINGS_PATH = ".hs/settings.json";
+export declare const EMPTY_HS_SETTINGS_FILE: {
+    localDefaultAccount: undefined;
+    accounts: never[];
+};

package/constants/config.js

@@ -106,3 +106,11 @@ export const HUBSPOT_CONFIG_OPERATIONS = {
     WRITE: 'WRITE',
     DELETE: 'DELETE',
 };
+export const HS_FOLDER = '.hs';
+export const HS_SETTINGS_FILENAME = 'settings.json';
+export const HS_README_FILENAME = 'README.txt';
+export const DEFAULT_HS_SETTINGS_PATH = `${HS_FOLDER}/${HS_SETTINGS_FILENAME}`;
+export const EMPTY_HS_SETTINGS_FILE = {
+    localDefaultAccount: undefined,
+    accounts: [],
+};

package/lib/gitignore.d.ts

@@ -1,3 +1,4 @@
 import { GitInclusionResult } from '../types/Config.js';
 export declare function checkAndAddConfigToGitignore(configPath: string): void;
+export declare function checkAndAddHsFolderToGitignore(settingsPath: string): void;
 export declare function checkGitInclusion(configPath: string): GitInclusionResult;

package/lib/gitignore.js

@@ -1,7 +1,7 @@
 import fs from 'fs-extra';
 import path from 'path';
 import { isConfigPathInGitRepo, getGitignoreFiles, configFilenameIsIgnoredByGitignore, } from '../utils/git.js';
-import { DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME } from '../constants/config.js';
+import { DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME, HS_FOLDER, } from '../constants/config.js';
 import { i18n } from '../utils/lang.js';
 const i18nKey = 'lib.gitignore';
 const GITIGNORE_FILE = '.gitignore';
@@ -23,6 +23,27 @@ export function checkAndAddConfigToGitignore(configPath) {
         throw new Error(i18n(`${i18nKey}.errors.configIgnore`), { cause: e });
     }
 }
+export function checkAndAddHsFolderToGitignore(settingsPath) {
+    try {
+        const hsDirPath = path.resolve(path.dirname(settingsPath));
+        const { configIgnored, gitignoreFiles } = checkGitInclusion(hsDirPath);
+        if (configIgnored)
+            return;
+        let gitignoreFilePath = gitignoreFiles && gitignoreFiles.length ? gitignoreFiles[0] : null;
+        if (!gitignoreFilePath) {
+            gitignoreFilePath = path.join(path.dirname(hsDirPath), GITIGNORE_FILE);
+            fs.writeFileSync(gitignoreFilePath, '');
+        }
+        const gitignoreContents = fs.readFileSync(gitignoreFilePath).toString();
+        if (gitignoreContents.includes(HS_FOLDER))
+            return;
+        const updatedContents = `${gitignoreContents.trim()}\n\n# HubSpot link folder\n${HS_FOLDER}\n`;
+        fs.writeFileSync(gitignoreFilePath, updatedContents);
+    }
+    catch (e) {
+        throw new Error(i18n(`${i18nKey}.errors.configIgnore`), { cause: e });
+    }
+}
 export function checkGitInclusion(configPath) {
     const result = {
         inGit: false,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/local-dev-lib",
-    "version": "5.3.3",
+    "version": "5.4.0-beta.0",
     "type": "module",
     "description": "Provides library functionality for HubSpot local development tooling, including the HubSpot CLI",
     "files": [
@@ -59,6 +59,7 @@
         "./config/defaultAccountOverride": "./config/defaultAccountOverride.js",
         "./config/migrate": "./config/migrate.js",
         "./config/state": "./config/state.js",
+        "./config/hsSettings": "./config/hsSettings.js",
         "./config": "./config/index.js",
         "./constants/*": "./constants/*.js",
         "./enums/*": "./enums/*.js",

package/types/HsSettings.d.ts

@@ -0,0 +1,4 @@
+export type HsSettingsFile = {
+    localDefaultAccount: number | undefined;
+    accounts: number[];
+};

package/types/HsSettings.js

@@ -0,0 +1 @@
+export {};