@hubspot/local-dev-lib 2.1.1 → 2.1.2-beta.0

package/LICENSE

@@ -0,0 +1,12 @@
+Copyright 2019  HubSpot, Inc.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,17 @@
+# hubspot/local-dev-lib
+
+Provides library functionality for HubSpot local development tooling, including the [HubSpot CLI](https://github.com/HubSpot/hubspot-cli).
+
+**NOTE:** This library is intended to replace the deprecated [@hubspot/cli-lib](https://github.com/HubSpot/cli-lib) library.
+
+## Overview
+
+This library contains utils that facilitate interactions with HubSpot. It is consumed by the [HubSpot CLI](https://github.com/HubSpot/hubspot-cli) as well as other HubSpot development tooling. Major exports include:
+
+- Config utils for managing HubSpot account configuration and access keys ([docs](./config/README.md))
+- API utils to interact with HubSpot assets such as Design Manager and Developer Projects ([docs](./api/README.md))
+- Utils to navigate the local filesystem, parse common HubSpot files, interact with common HubSpot objects, and connect with GitHub ([docs](./lib/README.md))
+
+## Contributing
+
+For more information on developing, see the [Contributing Guide](CONTRIBUTING.md).

package/config/CLIConfiguration.d.ts

@@ -20,16 +20,17 @@ declare class _CLIConfiguration {
     getAccountId(nameOrId?: string | number): number | null;
     getDefaultAccount(): string | number | null;
     getResolvedDefaultAccountForCWD(nameOrId: string | number): CLIAccount_NEW | null;
-    getConfigAccountIndex(accountId: number): number;
+    getAccountIndex(accountId: number): number;
     getConfigForAccount(accountId?: number): CLIAccount_NEW | null;
+    getConfigAccounts(): Array<CLIAccount_NEW> | null;
     isAccountInConfig(nameOrId: string | number): boolean;
     getAndLoadConfigIfNeeded(options?: CLIOptions): CLIConfig_NEW;
     getEnv(nameOrId?: string | number): Environment;
-    getAccountType(accountType?: AccountType, sandboxAccountType?: string | null): AccountType;
+    getAccountType(accountType?: AccountType | null, sandboxAccountType?: string | null): AccountType;
     /**
      * @throws {Error}
      */
-    updateAccount(updatedAccountFields: Partial<FlatAccountFields_NEW>, writeUpdate?: boolean): FlatAccountFields_NEW | null;
+    addOrUpdateAccount(updatedAccountFields: Partial<FlatAccountFields_NEW>, writeUpdate?: boolean): FlatAccountFields_NEW | null;
     /**
      * @throws {Error}
      */

package/config/CLIConfiguration.js

@@ -116,7 +116,7 @@ class _CLIConfiguration {
                 return false;
             }
             if (accountConfig.name) {
-                if (accountNamesMap[accountConfig.name]) {
+                if (accountNamesMap[accountConfig.name.toLowerCase()]) {
                     logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.validate.duplicateAccountNames`, {
                         accountName: accountConfig.name,
                     }));
@@ -131,7 +131,7 @@ class _CLIConfiguration {
                 accountNamesMap[accountConfig.name] = true;
             }
             if (!accountConfig.accountType) {
-                this.updateAccount({
+                this.addOrUpdateAccount({
                     ...accountConfig,
                     accountId: accountConfig.accountId,
                     accountType: this.getAccountType(undefined, accountConfig.sandboxAccountType),
@@ -194,19 +194,30 @@ class _CLIConfiguration {
     getResolvedDefaultAccountForCWD(nameOrId) {
         return this.getAccount(nameOrId);
     }
-    getConfigAccountIndex(accountId) {
+    getAccountIndex(accountId) {
         return this.config
             ? this.config.accounts.findIndex(account => account.accountId === accountId)
             : -1;
     }
     getConfigForAccount(accountId) {
         if (this.config) {
-            this.config.accounts.find(account => account.accountId === accountId) ||
-                null;
+            return (this.config.accounts.find(account => account.accountId === accountId) ||
+                null);
+        }
+        return null;
+    }
+    getConfigAccounts() {
+        if (this.config) {
+            return this.config.accounts || null;
         }
         return null;
     }
     isAccountInConfig(nameOrId) {
+        if (typeof nameOrId === 'string') {
+            return (!!this.config &&
+                this.config.accounts &&
+                !!this.getAccountId(nameOrId.toLowerCase()));
+        }
         return (!!this.config && this.config.accounts && !!this.getAccountId(nameOrId));
     }
     getAndLoadConfigIfNeeded(options) {
@@ -246,7 +257,7 @@ class _CLIConfiguration {
     /**
      * @throws {Error}
      */
-    updateAccount(updatedAccountFields, writeUpdate = true) {
+    addOrUpdateAccount(updatedAccountFields, writeUpdate = true) {
         const { accountId, accountType, apiKey, authType, clientId, clientSecret, defaultMode, env, name, parentAccountId, personalAccessKey, sandboxAccountType, scopes, tokenInfo, } = updatedAccountFields;
         if (!accountId) {
             throw new Error((0, lang_1.i18n)(`${i18nKey}.updateAccount.errors.accountIdRequired`));
@@ -255,8 +266,11 @@ class _CLIConfiguration {
             logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.updateAccount.noConfigToUpdate`));
             return null;
         }
+        // Check whether the account is already listed in the config.yml file.
         const currentAccountConfig = this.getAccount(accountId);
+        // For accounts that are already in the config.yml file, sets the auth property.
         let auth = (currentAccountConfig && currentAccountConfig.auth) || {};
+        // For accounts not already in the config.yml file, sets the auth property.
         if (clientId || clientSecret || scopes || tokenInfo) {
             auth = {
                 ...(currentAccountConfig ? currentAccountConfig.auth : {}),
@@ -279,6 +293,7 @@ class _CLIConfiguration {
         }
         const updatedEnv = (0, environment_2.getValidEnv)(env || (currentAccountConfig && currentAccountConfig.env));
         const updatedDefaultMode = defaultMode && defaultMode.toLowerCase();
+        const updatedAccountType = accountType || (currentAccountConfig && currentAccountConfig.accountType);
         safelyApplyUpdates('name', name);
         safelyApplyUpdates('env', updatedEnv);
         safelyApplyUpdates('accountId', accountId);
@@ -294,24 +309,29 @@ class _CLIConfiguration {
         safelyApplyUpdates('personalAccessKey', personalAccessKey);
         // Deprecating sandboxAccountType in favor of the more generic accountType
         safelyApplyUpdates('sandboxAccountType', sandboxAccountType);
-        safelyApplyUpdates('accountType', this.getAccountType(accountType, sandboxAccountType));
+        safelyApplyUpdates('accountType', this.getAccountType(updatedAccountType, sandboxAccountType));
         safelyApplyUpdates('parentAccountId', parentAccountId);
         const completedAccountConfig = nextAccountConfig;
+        if (!Object.hasOwn(this.config, 'accounts')) {
+            this.config.accounts = [];
+        }
         if (currentAccountConfig) {
             logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.updateAccount.updating`, {
                 accountId,
             }));
-            const index = this.getConfigAccountIndex(accountId);
-            this.config.accounts[index] = completedAccountConfig;
-            logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.updateAccount.addingConfigEntry`, {
-                accountId,
-            }));
-            if (this.config.accounts) {
+            const index = this.getAccountIndex(accountId);
+            if (index < 0) {
                 this.config.accounts.push(completedAccountConfig);
             }
             else {
-                this.config.accounts = [completedAccountConfig];
+                this.config.accounts[index] = completedAccountConfig;
             }
+            logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.updateAccount.addingConfigEntry`, {
+                accountId,
+            }));
+        }
+        else {
+            this.config.accounts.push(completedAccountConfig);
         }
         if (writeUpdate) {
             this.write();
@@ -350,7 +370,12 @@ class _CLIConfiguration {
             }));
         }
         if (accountId) {
-            this.updateAccount({ accountId, name: newName, env: this.getEnv() });
+            this.addOrUpdateAccount({
+                accountId,
+                name: newName,
+                env: this.getEnv(),
+                accountType: accountConfigToRename.accountType,
+            });
         }
         if (accountConfigToRename.name === this.getDefaultAccount()) {
             this.updateDefaultAccount(newName);
@@ -374,7 +399,7 @@ class _CLIConfiguration {
         const accountConfig = this.getAccount(accountId);
         if (accountConfig) {
             logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.removeAccountFromConfig.deleting`, { accountId }));
-            const index = this.getConfigAccountIndex(accountId);
+            const index = this.getAccountIndex(accountId);
             this.config.accounts.splice(index, 1);
             if (this.getDefaultAccount() === accountConfig.name) {
                 removedAccountIsDefault = true;

package/config/getAccountIdentifier.d.ts

@@ -0,0 +1,2 @@
+import { GenericAccount } from '../types/Accounts';
+export declare function getAccountIdentifier(account?: GenericAccount | null): number | undefined;

package/config/getAccountIdentifier.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAccountIdentifier = void 0;
+function getAccountIdentifier(account) {
+    if (!account) {
+        return undefined;
+    }
+    else if (Object.hasOwn(account, 'portalId')) {
+        return account.portalId;
+    }
+    else if (Object.hasOwn(account, 'accountId')) {
+        return account.accountId;
+    }
+}
+exports.getAccountIdentifier = getAccountIdentifier;

package/config/index.d.ts

@@ -1,18 +1,20 @@
 import * as config_DEPRECATED from './config_DEPRECATED';
-import { CLIConfig } from '../types/Config';
+import { CLIConfig_NEW, CLIConfig } from '../types/Config';
 import { CLIOptions, WriteConfigOptions } from '../types/CLIOptions';
-import { AccountType, CLIAccount, FlatAccountFields } from '../types/Accounts';
+import { AccountType, CLIAccount, CLIAccount_NEW, CLIAccount_DEPRECATED, FlatAccountFields } from '../types/Accounts';
+import { Mode } from '../types/Files';
 export declare function loadConfig(path: string, options?: CLIOptions): CLIConfig | null;
 export declare function getAndLoadConfigIfNeeded(options?: CLIOptions): Partial<CLIConfig> | null;
 export declare function validateConfig(): boolean;
 export declare function loadConfigFromEnvironment(): boolean;
 export declare function createEmptyConfigFile(options?: {
     path?: string;
-}, useRootConfig?: boolean): void;
+}, useHiddenConfig?: boolean): void;
 export declare function deleteEmptyConfigFile(): void;
 export declare function getConfig(): CLIConfig | null;
 export declare function writeConfig(options?: WriteConfigOptions): void;
-export declare function getConfigPath(path?: string): string | null;
+export declare function getConfigPath(path?: string, useHiddenConfig?: boolean): string | null;
+export declare function configFileExists(useHiddenConfig?: boolean): boolean;
 export declare function getAccountConfig(accountId?: number): CLIAccount | null;
 export declare function accountNameExistsInConfig(name: string): boolean;
 export declare function updateAccountConfig(configOptions: Partial<FlatAccountFields>): FlatAccountFields | null;
@@ -28,12 +30,12 @@ export declare function isConfigFlagEnabled(flag: keyof CLIConfig): boolean;
 export declare function isTrackingAllowed(): boolean;
 export declare function getEnv(nameOrId?: string | number): import("../types/Config").Environment;
 export declare function getAccountType(accountType?: AccountType, sandboxAccountType?: string | null): AccountType;
-export declare const getConfigAccounts: typeof config_DEPRECATED.getConfigAccounts;
-export declare const getConfigDefaultAccount: typeof config_DEPRECATED.getConfigDefaultAccount;
+export declare function getConfigDefaultAccount(): string | number | null | undefined;
+export declare function getConfigAccounts(): Array<CLIAccount_NEW> | Array<CLIAccount_DEPRECATED> | null | undefined;
+export declare function updateDefaultMode(mode: Mode): void | CLIConfig_NEW | null;
 export declare const getConfigAccountId: typeof config_DEPRECATED.getConfigAccountId;
 export declare const getOrderedAccount: typeof config_DEPRECATED.getOrderedAccount;
 export declare const getOrderedConfig: typeof config_DEPRECATED.getOrderedConfig;
 export declare const setConfig: typeof config_DEPRECATED.setConfig;
 export declare const setConfigPath: typeof config_DEPRECATED.setConfigPath;
 export declare const findConfig: typeof config_DEPRECATED.findConfig;
-export declare const updateDefaultMode: typeof config_DEPRECATED.updateDefaultMode;

package/config/index.js

@@ -23,11 +23,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateDefaultMode = exports.findConfig = exports.setConfigPath = exports.setConfig = exports.getOrderedConfig = exports.getOrderedAccount = exports.getConfigAccountId = exports.getConfigDefaultAccount = exports.getConfigAccounts = exports.getAccountType = exports.getEnv = exports.isTrackingAllowed = exports.isConfigFlagEnabled = exports.deleteConfigFile = exports.updateAllowUsageTracking = exports.updateHttpTimeout = exports.deleteAccount = exports.removeSandboxAccountFromConfig = exports.getAccountId = exports.renameAccount = exports.updateDefaultAccount = exports.updateAccountConfig = exports.accountNameExistsInConfig = exports.getAccountConfig = exports.getConfigPath = exports.writeConfig = exports.getConfig = exports.deleteEmptyConfigFile = exports.createEmptyConfigFile = exports.loadConfigFromEnvironment = exports.validateConfig = exports.getAndLoadConfigIfNeeded = exports.loadConfig = void 0;
+exports.findConfig = exports.setConfigPath = exports.setConfig = exports.getOrderedConfig = exports.getOrderedAccount = exports.getConfigAccountId = exports.updateDefaultMode = exports.getConfigAccounts = exports.getConfigDefaultAccount = exports.getAccountType = exports.getEnv = exports.isTrackingAllowed = exports.isConfigFlagEnabled = exports.deleteConfigFile = exports.updateAllowUsageTracking = exports.updateHttpTimeout = exports.deleteAccount = exports.removeSandboxAccountFromConfig = exports.getAccountId = exports.renameAccount = exports.updateDefaultAccount = exports.updateAccountConfig = exports.accountNameExistsInConfig = exports.getAccountConfig = exports.configFileExists = exports.getConfigPath = exports.writeConfig = exports.getConfig = exports.deleteEmptyConfigFile = exports.createEmptyConfigFile = exports.loadConfigFromEnvironment = exports.validateConfig = exports.getAndLoadConfigIfNeeded = exports.loadConfig = void 0;
 const config_DEPRECATED = __importStar(require("./config_DEPRECATED"));
 const CLIConfiguration_1 = require("./CLIConfiguration");
 const configFile_1 = require("./configFile");
-const getAccountIdentifier_1 = require("../utils/getAccountIdentifier");
+const getAccountIdentifier_1 = require("./getAccountIdentifier");
 // Use new config if it exists
 function loadConfig(path, options = {}) {
     // Attempt to load the root config
@@ -58,8 +58,8 @@ function loadConfigFromEnvironment() {
     return Boolean(config_DEPRECATED.loadConfigFromEnvironment());
 }
 exports.loadConfigFromEnvironment = loadConfigFromEnvironment;
-function createEmptyConfigFile(options = {}, useRootConfig = false) {
-    if (useRootConfig) {
+function createEmptyConfigFile(options = {}, useHiddenConfig = false) {
+    if (useHiddenConfig) {
         CLIConfiguration_1.CLIConfiguration.write({ accounts: [] });
     }
     else {
@@ -93,13 +93,19 @@ function writeConfig(options = {}) {
     }
 }
 exports.writeConfig = writeConfig;
-function getConfigPath(path) {
-    if (CLIConfiguration_1.CLIConfiguration.isActive()) {
+function getConfigPath(path, useHiddenConfig = false) {
+    if (useHiddenConfig || CLIConfiguration_1.CLIConfiguration.isActive()) {
         return (0, configFile_1.getConfigFilePath)();
     }
     return config_DEPRECATED.getConfigPath(path);
 }
 exports.getConfigPath = getConfigPath;
+function configFileExists(useHiddenConfig) {
+    return useHiddenConfig
+        ? (0, configFile_1.configFileExists)()
+        : Boolean(config_DEPRECATED.getConfigPath());
+}
+exports.configFileExists = configFileExists;
 function getAccountConfig(accountId) {
     if (CLIConfiguration_1.CLIConfiguration.isActive()) {
         return CLIConfiguration_1.CLIConfiguration.getConfigForAccount(accountId);
@@ -117,7 +123,7 @@ exports.accountNameExistsInConfig = accountNameExistsInConfig;
 function updateAccountConfig(configOptions) {
     const accountIdentifier = (0, getAccountIdentifier_1.getAccountIdentifier)(configOptions);
     if (CLIConfiguration_1.CLIConfiguration.isActive()) {
-        return CLIConfiguration_1.CLIConfiguration.updateAccount({
+        return CLIConfiguration_1.CLIConfiguration.addOrUpdateAccount({
             ...configOptions,
             accountId: accountIdentifier,
         });
@@ -224,13 +230,31 @@ function getAccountType(accountType, sandboxAccountType) {
     return config_DEPRECATED.getAccountType(accountType, sandboxAccountType);
 }
 exports.getAccountType = getAccountType;
-// These functions are either not supported or have breaking changes with the new config setup
-exports.getConfigAccounts = config_DEPRECATED.getConfigAccounts;
-exports.getConfigDefaultAccount = config_DEPRECATED.getConfigDefaultAccount;
+function getConfigDefaultAccount() {
+    if (CLIConfiguration_1.CLIConfiguration.isActive()) {
+        return CLIConfiguration_1.CLIConfiguration.getDefaultAccount();
+    }
+    return config_DEPRECATED.getConfigDefaultAccount();
+}
+exports.getConfigDefaultAccount = getConfigDefaultAccount;
+function getConfigAccounts() {
+    if (CLIConfiguration_1.CLIConfiguration.isActive()) {
+        return CLIConfiguration_1.CLIConfiguration.getConfigAccounts();
+    }
+    return config_DEPRECATED.getConfigAccounts();
+}
+exports.getConfigAccounts = getConfigAccounts;
+function updateDefaultMode(mode) {
+    if (CLIConfiguration_1.CLIConfiguration.isActive()) {
+        return CLIConfiguration_1.CLIConfiguration.updateDefaultMode(mode);
+    }
+    return config_DEPRECATED.updateDefaultMode(mode);
+}
+exports.updateDefaultMode = updateDefaultMode;
+// These functions are not supported with the new config setup
 exports.getConfigAccountId = config_DEPRECATED.getConfigAccountId;
 exports.getOrderedAccount = config_DEPRECATED.getOrderedAccount;
 exports.getOrderedConfig = config_DEPRECATED.getOrderedConfig;
 exports.setConfig = config_DEPRECATED.setConfig;
 exports.setConfigPath = config_DEPRECATED.setConfigPath;
 exports.findConfig = config_DEPRECATED.findConfig;
-exports.updateDefaultMode = config_DEPRECATED.updateDefaultMode;

package/constants/config.d.ts

@@ -1,5 +1,5 @@
 export declare const DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME = "hubspot.config.yml";
-export declare const HUBSPOT_CONFIGURATION_FOLDER = ".hubspot";
+export declare const HUBSPOT_CONFIGURATION_FOLDER = ".hubspot-cli";
 export declare const HUBSPOT_CONFIGURATION_FILE = "config.yml";
 export declare const MIN_HTTP_TIMEOUT = 3000;
 export declare const HUBSPOT_ACCOUNT_TYPES: {

package/constants/config.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.HUBSPOT_ACCOUNT_TYPE_STRINGS = exports.HUBSPOT_ACCOUNT_TYPES = exports.MIN_HTTP_TIMEOUT = exports.HUBSPOT_CONFIGURATION_FILE = exports.HUBSPOT_CONFIGURATION_FOLDER = exports.DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME = void 0;
 const lang_1 = require("../utils/lang");
 exports.DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME = 'hubspot.config.yml';
-exports.HUBSPOT_CONFIGURATION_FOLDER = '.hubspot';
+exports.HUBSPOT_CONFIGURATION_FOLDER = '.hubspot-cli';
 exports.HUBSPOT_CONFIGURATION_FILE = 'config.yml';
 exports.MIN_HTTP_TIMEOUT = 3000;
 exports.HUBSPOT_ACCOUNT_TYPES = {