@hubspot/local-dev-lib 0.2.1-experimental.1 → 0.2.2-experimental.0

package/config/environment.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadConfigFromEnvironment = void 0;
+const logger_1 = require("../lib/logger");
+const environments_1 = require("../constants/environments");
+const auth_1 = require("../constants/auth");
+const configUtils_1 = require("./configUtils");
+const environment_1 = require("../lib/environment");
+const lang_1 = require("../utils/lang");
+const i18nKey = 'config.environment';
+function getConfigVariablesFromEnv() {
+    const env = process.env;
+    return {
+        apiKey: env[environments_1.ENVIRONMENT_VARIABLES.HUBSPOT_API_KEY],
+        clientId: env[environments_1.ENVIRONMENT_VARIABLES.HUBSPOT_CLIENT_ID],
+        clientSecret: env[environments_1.ENVIRONMENT_VARIABLES.HUBSPOT_CLIENT_SECRET],
+        personalAccessKey: env[environments_1.ENVIRONMENT_VARIABLES.HUBSPOT_PERSONAL_ACCESS_KEY],
+        accountId: parseInt(env[environments_1.ENVIRONMENT_VARIABLES.HUBSPOT_ACCOUNT_ID], 10),
+        refreshToken: env[environments_1.ENVIRONMENT_VARIABLES.HUBSPOT_REFRESH_TOKEN],
+        env: (0, environment_1.getValidEnv)(env[environments_1.ENVIRONMENT_VARIABLES.HUBSPOT_ENVIRONMENT]),
+    };
+}
+function loadConfigFromEnvironment() {
+    const { apiKey, clientId, clientSecret, personalAccessKey, accountId, refreshToken, env, } = getConfigVariablesFromEnv();
+    if (!accountId) {
+        logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.loadConfig.missingAccountId`));
+        return null;
+    }
+    if (!env) {
+        logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.loadConfig.missingEnv`));
+        return null;
+    }
+    if (personalAccessKey) {
+        return (0, configUtils_1.generateConfig)(auth_1.PERSONAL_ACCESS_KEY_AUTH_METHOD.value, {
+            accountId,
+            personalAccessKey,
+            env,
+        });
+    }
+    else if (clientId && clientSecret && refreshToken) {
+        return (0, configUtils_1.generateConfig)(auth_1.OAUTH_AUTH_METHOD.value, {
+            accountId,
+            clientId,
+            clientSecret,
+            refreshToken,
+            scopes: auth_1.OAUTH_SCOPES.map((scope) => scope.value),
+            env,
+        });
+    }
+    else if (apiKey) {
+        return (0, configUtils_1.generateConfig)(auth_1.API_KEY_AUTH_METHOD.value, {
+            accountId,
+            apiKey,
+            env,
+        });
+    }
+    logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.loadConfig.unknownAuthType`));
+    return null;
+}
+exports.loadConfigFromEnvironment = loadConfigFromEnvironment;

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,27 +1,43 @@
-import { HubSpotConfigAccount } from '../types/Accounts';
-import { HubSpotConfig, ConfigFlag } from '../types/Config';
+import * as config_DEPRECATED from './config_DEPRECATED';
+import { CLIConfig_NEW, CLIConfig } from '../types/Config';
+import { CLIOptions, WriteConfigOptions } from '../types/CLIOptions';
+import { AccountType, CLIAccount, CLIAccount_NEW, CLIAccount_DEPRECATED, FlatAccountFields } from '../types/Accounts';
 import { CmsPublishMode } from '../types/Files';
-import { Environment } from '../types/Config';
-export declare function localConfigFileExists(): boolean;
-export declare function globalConfigFileExists(): boolean;
-export declare function getConfigFilePath(): string;
-export declare function getConfig(): HubSpotConfig;
-export declare function isConfigValid(): boolean;
-export declare function createEmptyConfigFile(useGlobalConfig?: boolean): void;
+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;
+}, 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, useHiddenConfig?: boolean): string | null;
+export declare function configFileExists(useHiddenConfig?: boolean, path?: string): 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;
+export declare function updateDefaultAccount(nameOrId: string | number): void;
+export declare function renameAccount(currentName: string, newName: string): Promise<void>;
+export declare function getAccountId(nameOrId?: string | number): number | null;
+export declare function removeSandboxAccountFromConfig(nameOrId: string | number): boolean;
+export declare function deleteAccount(accountName: string): Promise<void | boolean>;
+export declare function updateHttpTimeout(timeout: string): void;
+export declare function updateAllowUsageTracking(isEnabled: boolean): void;
 export declare function deleteConfigFile(): void;
-export declare function getConfigAccountById(accountId: number): HubSpotConfigAccount;
-export declare function getConfigAccountByName(accountName: string): HubSpotConfigAccount;
-export declare function getConfigAccountIfExists(identifier: number | string): HubSpotConfigAccount | undefined;
-export declare function getConfigDefaultAccount(): HubSpotConfigAccount;
-export declare function getConfigDefaultAccountIfExists(): HubSpotConfigAccount | undefined;
-export declare function getAllConfigAccounts(): HubSpotConfigAccount[];
-export declare function getConfigAccountEnvironment(identifier?: number | string): Environment;
-export declare function addConfigAccount(accountToAdd: HubSpotConfigAccount): void;
-export declare function updateConfigAccount(updatedAccount: HubSpotConfigAccount): void;
-export declare function setConfigAccountAsDefault(identifier: number | string): void;
-export declare function renameConfigAccount(currentName: string, newName: string): void;
-export declare function removeAccountFromConfig(accountId: number): void;
-export declare function updateHttpTimeout(timeout: string | number): void;
-export declare function updateAllowUsageTracking(isAllowed: boolean): void;
-export declare function updateDefaultCmsPublishMode(cmsPublishMode: CmsPublishMode): void;
-export declare function isConfigFlagEnabled(flag: ConfigFlag, defaultValue?: boolean): boolean;
+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 function getConfigDefaultAccount(): string | number | null | undefined;
+export declare function getConfigAccounts(): Array<CLIAccount_NEW> | Array<CLIAccount_DEPRECATED> | null | undefined;
+export declare function updateDefaultCmsPublishMode(cmsPublishMode: CmsPublishMode): void | CLIConfig_NEW | null;
+export declare function getCWDAccountOverride(): string | number | null | undefined;
+export declare function getDefaultAccountOverrideFilePath(): string | null | undefined;
+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;