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

package/config/utils.d.ts

@@ -1,70 +0,0 @@
-import { ACCOUNT_IDENTIFIERS } from '../constants/config';
-import { HubSpotConfig, DeprecatedHubSpotConfigFields } from '../types/Config';
-import { HubSpotConfigAccount, AccountType, TokenInfo } from '../types/Accounts';
-import { ValueOf } from '../types/Utils';
-export declare function getGlobalConfigFilePath(): string;
-export declare function getLocalConfigFilePath(): string | null;
-export declare function getLocalConfigDefaultFilePath(): string;
-export declare function getConfigPathEnvironmentVariables(): {
-    useEnvironmentConfig: boolean;
-    configFilePathFromEnvironment: string | undefined;
-};
-export declare function readConfigFile(configPath: string): string;
-export declare function removeUndefinedFieldsFromConfigAccount<T extends HubSpotConfigAccount | Partial<HubSpotConfigAccount> = HubSpotConfigAccount>(account: T): T;
-export declare function formatConfigForWrite(config: HubSpotConfig): {
-    accounts: ({
-        personalAccessKey: string;
-        auth: {
-            tokenInfo: TokenInfo;
-        };
-        accountType?: AccountType | undefined;
-        defaultCmsPublishMode?: import("../types/Files").CmsPublishMode | undefined;
-        parentAccountId?: number | undefined;
-        name: string;
-        accountId: number;
-        env: import("../types/Config").Environment;
-        authType: "apikey" | "oauth2" | "personalaccesskey";
-    } | {
-        auth: {
-            clientId: string;
-            clientSecret: string;
-            scopes: string[];
-            tokenInfo: TokenInfo;
-        };
-        accountType?: AccountType | undefined;
-        defaultCmsPublishMode?: import("../types/Files").CmsPublishMode | undefined;
-        parentAccountId?: number | undefined;
-        name: string;
-        accountId: number;
-        env: import("../types/Config").Environment;
-        authType: "apikey" | "oauth2" | "personalaccesskey";
-    } | {
-        apiKey: string;
-        accountType?: AccountType | undefined;
-        defaultCmsPublishMode?: import("../types/Files").CmsPublishMode | undefined;
-        parentAccountId?: number | undefined;
-        name: string;
-        accountId: number;
-        env: import("../types/Config").Environment;
-        authType: "apikey" | "oauth2" | "personalaccesskey";
-    })[];
-    env?: import("../types/Config").Environment | undefined;
-    httpUseLocalhost?: boolean | undefined;
-    useCustomObjectHubfile?: boolean | undefined;
-    defaultCmsPublishMode: import("../types/Files").CmsPublishMode | undefined;
-    httpTimeout: number | undefined;
-    allowUsageTracking: boolean | undefined;
-    defaultAccount?: number | undefined;
-};
-export declare function writeConfigFile(config: HubSpotConfig, configPath: string): void;
-export declare function normalizeParsedConfig(parsedConfig: HubSpotConfig & DeprecatedHubSpotConfigFields): HubSpotConfig;
-export declare function parseConfig(configSource: string): HubSpotConfig;
-export declare function buildConfigFromEnvironment(): HubSpotConfig;
-export declare function getAccountIdentifierAndType(accountIdentifier: string | number): {
-    identifier: string | number;
-    identifierType: ValueOf<typeof ACCOUNT_IDENTIFIERS>;
-};
-export declare function getConfigAccountByIdentifier(accounts: Array<HubSpotConfigAccount>, identifierFieldName: ValueOf<typeof ACCOUNT_IDENTIFIERS>, identifier: string | number): HubSpotConfigAccount | undefined;
-export declare function getConfigAccountByInferredIdentifier(accounts: Array<HubSpotConfigAccount>, accountIdentifier: string | number): HubSpotConfigAccount | undefined;
-export declare function getConfigAccountIndexById(accounts: Array<HubSpotConfigAccount>, id: number): number;
-export declare function isConfigAccountValid(account: Partial<HubSpotConfigAccount>): boolean;

package/config/utils.js

@@ -1,328 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isConfigAccountValid = exports.getConfigAccountIndexById = exports.getConfigAccountByInferredIdentifier = exports.getConfigAccountByIdentifier = exports.getAccountIdentifierAndType = exports.buildConfigFromEnvironment = exports.parseConfig = exports.normalizeParsedConfig = exports.writeConfigFile = exports.formatConfigForWrite = exports.removeUndefinedFieldsFromConfigAccount = exports.readConfigFile = exports.getConfigPathEnvironmentVariables = exports.getLocalConfigDefaultFilePath = exports.getLocalConfigFilePath = exports.getGlobalConfigFilePath = void 0;
-const path_1 = __importDefault(require("path"));
-const os_1 = __importDefault(require("os"));
-const fs_extra_1 = __importDefault(require("fs-extra"));
-const js_yaml_1 = __importDefault(require("js-yaml"));
-const findup_sync_1 = __importDefault(require("findup-sync"));
-const config_1 = require("../constants/config");
-const auth_1 = require("../constants/auth");
-const FileSystemError_1 = require("../models/FileSystemError");
-const logger_1 = require("../lib/logger");
-const environment_1 = require("../lib/environment");
-const path_2 = require("../lib/path");
-const files_1 = require("../constants/files");
-const lang_1 = require("../utils/lang");
-function getGlobalConfigFilePath() {
-    return path_1.default.join(os_1.default.homedir(), config_1.HUBSPOT_CONFIGURATION_FOLDER, config_1.HUBSPOT_CONFIGURATION_FILE);
-}
-exports.getGlobalConfigFilePath = getGlobalConfigFilePath;
-function getLocalConfigFilePath() {
-    return (0, findup_sync_1.default)([
-        config_1.DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME,
-        config_1.DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME.replace('.yml', '.yaml'),
-    ]);
-}
-exports.getLocalConfigFilePath = getLocalConfigFilePath;
-function getLocalConfigDefaultFilePath() {
-    return `${(0, path_2.getCwd)()}/${config_1.DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME}`;
-}
-exports.getLocalConfigDefaultFilePath = getLocalConfigDefaultFilePath;
-function getConfigPathEnvironmentVariables() {
-    const configFilePathFromEnvironment = process.env[config_1.ENVIRONMENT_VARIABLES.HUBSPOT_CONFIG_PATH];
-    const useEnvironmentConfig = process.env[config_1.ENVIRONMENT_VARIABLES.USE_ENVIRONMENT_HUBSPOT_CONFIG] ===
-        'true';
-    if (configFilePathFromEnvironment && useEnvironmentConfig) {
-        throw new Error((0, lang_1.i18n)('config.utils.getConfigPathEnvironmentVariables.invalidEnvironmentVariables'));
-    }
-    return {
-        configFilePathFromEnvironment,
-        useEnvironmentConfig,
-    };
-}
-exports.getConfigPathEnvironmentVariables = getConfigPathEnvironmentVariables;
-function readConfigFile(configPath) {
-    let source = '';
-    try {
-        source = fs_extra_1.default.readFileSync(configPath).toString();
-    }
-    catch (err) {
-        throw new FileSystemError_1.FileSystemError({ cause: err }, {
-            filepath: configPath,
-            operation: 'read',
-        });
-    }
-    return source;
-}
-exports.readConfigFile = readConfigFile;
-function removeUndefinedFieldsFromConfigAccount(account) {
-    Object.keys(account).forEach(k => {
-        const key = k;
-        if (account[key] === undefined) {
-            delete account[key];
-        }
-    });
-    if ('auth' in account && account.auth) {
-        if (account.authType === auth_1.OAUTH_AUTH_METHOD.value) {
-            Object.keys(account.auth).forEach(k => {
-                const key = k;
-                if (account.auth?.[key] === undefined) {
-                    delete account.auth?.[key];
-                }
-            });
-        }
-        if ('tokenInfo' in account.auth &&
-            typeof account.auth.tokenInfo === 'object') {
-            Object.keys(account.auth.tokenInfo).forEach(k => {
-                const key = k;
-                if (account.auth?.tokenInfo[key] === undefined) {
-                    delete account.auth?.tokenInfo[key];
-                }
-            });
-        }
-    }
-    return account;
-}
-exports.removeUndefinedFieldsFromConfigAccount = removeUndefinedFieldsFromConfigAccount;
-// Ensure written config files have fields in a consistent order
-function formatConfigForWrite(config) {
-    const { defaultAccount, defaultCmsPublishMode, httpTimeout, allowUsageTracking, accounts, ...rest } = config;
-    const orderedConfig = {
-        ...(defaultAccount && { defaultAccount }),
-        defaultCmsPublishMode,
-        httpTimeout,
-        allowUsageTracking,
-        ...rest,
-        accounts: accounts.map(account => {
-            const { name, accountId, env, authType, ...rest } = account;
-            return {
-                name,
-                accountId,
-                env,
-                authType,
-                ...rest,
-            };
-        }),
-    };
-    return removeUndefinedFieldsFromConfigAccount(orderedConfig);
-}
-exports.formatConfigForWrite = formatConfigForWrite;
-function writeConfigFile(config, configPath) {
-    const source = js_yaml_1.default.dump(JSON.parse(JSON.stringify(formatConfigForWrite(config), null, 2)));
-    try {
-        fs_extra_1.default.ensureFileSync(configPath);
-        fs_extra_1.default.writeFileSync(configPath, source);
-    }
-    catch (err) {
-        throw new FileSystemError_1.FileSystemError({ cause: err }, {
-            filepath: configPath,
-            operation: 'write',
-        });
-    }
-}
-exports.writeConfigFile = writeConfigFile;
-function getAccountType(sandboxAccountType) {
-    if (sandboxAccountType) {
-        if (sandboxAccountType.toUpperCase() === 'DEVELOPER') {
-            return config_1.HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX;
-        }
-        if (sandboxAccountType.toUpperCase() === 'STANDARD') {
-            return config_1.HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX;
-        }
-    }
-    return config_1.HUBSPOT_ACCOUNT_TYPES.STANDARD;
-}
-function normalizeParsedConfig(parsedConfig) {
-    if (parsedConfig.portals) {
-        parsedConfig.accounts = parsedConfig.portals.map(account => {
-            if (account.portalId) {
-                account.accountId = account.portalId;
-                delete account.portalId;
-            }
-            if (!account.accountType) {
-                account.accountType = getAccountType(account.sandboxAccountType);
-                delete account.sandboxAccountType;
-            }
-            return account;
-        });
-        delete parsedConfig.portals;
-    }
-    if (parsedConfig.defaultPortal) {
-        const defaultAccount = getConfigAccountByInferredIdentifier(parsedConfig.accounts, parsedConfig.defaultPortal);
-        if (defaultAccount) {
-            parsedConfig.defaultAccount = defaultAccount.accountId;
-        }
-        delete parsedConfig.defaultPortal;
-    }
-    if (parsedConfig.defaultMode) {
-        parsedConfig.defaultCmsPublishMode = parsedConfig.defaultMode;
-        delete parsedConfig.defaultMode;
-    }
-    return parsedConfig;
-}
-exports.normalizeParsedConfig = normalizeParsedConfig;
-function parseConfig(configSource) {
-    let parsedYaml;
-    try {
-        parsedYaml = js_yaml_1.default.load(configSource);
-    }
-    catch (err) {
-        throw new Error((0, lang_1.i18n)('config.utils.parseConfig.error'), { cause: err });
-    }
-    return normalizeParsedConfig(parsedYaml);
-}
-exports.parseConfig = parseConfig;
-function buildConfigFromEnvironment() {
-    const apiKey = process.env[config_1.ENVIRONMENT_VARIABLES.HUBSPOT_API_KEY];
-    const clientId = process.env[config_1.ENVIRONMENT_VARIABLES.HUBSPOT_CLIENT_ID];
-    const clientSecret = process.env[config_1.ENVIRONMENT_VARIABLES.HUBSPOT_CLIENT_SECRET];
-    const personalAccessKey = process.env[config_1.ENVIRONMENT_VARIABLES.HUBSPOT_PERSONAL_ACCESS_KEY];
-    const accountIdVar = process.env[config_1.ENVIRONMENT_VARIABLES.HUBSPOT_ACCOUNT_ID] ||
-        process.env[config_1.ENVIRONMENT_VARIABLES.HUBSPOT_PORTAL_ID];
-    const refreshToken = process.env[config_1.ENVIRONMENT_VARIABLES.HUBSPOT_REFRESH_TOKEN];
-    const hubspotEnvironment = process.env[config_1.ENVIRONMENT_VARIABLES.HUBSPOT_ENVIRONMENT];
-    const httpTimeoutVar = process.env[config_1.ENVIRONMENT_VARIABLES.HTTP_TIMEOUT];
-    const httpUseLocalhostVar = process.env[config_1.ENVIRONMENT_VARIABLES.HTTP_USE_LOCALHOST];
-    const allowUsageTrackingVar = process.env[config_1.ENVIRONMENT_VARIABLES.ALLOW_USAGE_TRACKING];
-    const defaultCmsPublishModeVar = process.env[config_1.ENVIRONMENT_VARIABLES.DEFAULT_CMS_PUBLISH_MODE];
-    if (!accountIdVar) {
-        throw new Error((0, lang_1.i18n)('config.utils.buildConfigFromEnvironment.missingAccountId'));
-    }
-    const accountId = parseInt(accountIdVar);
-    const httpTimeout = httpTimeoutVar ? parseInt(httpTimeoutVar) : undefined;
-    const httpUseLocalhost = httpUseLocalhostVar
-        ? httpUseLocalhostVar === 'true'
-        : undefined;
-    const allowUsageTracking = allowUsageTrackingVar
-        ? allowUsageTrackingVar === 'true'
-        : undefined;
-    const defaultCmsPublishMode = defaultCmsPublishModeVar === files_1.CMS_PUBLISH_MODE.draft ||
-        defaultCmsPublishModeVar === files_1.CMS_PUBLISH_MODE.publish
-        ? defaultCmsPublishModeVar
-        : undefined;
-    const env = (0, environment_1.getValidEnv)(hubspotEnvironment);
-    let account;
-    if (personalAccessKey) {
-        account = {
-            authType: auth_1.PERSONAL_ACCESS_KEY_AUTH_METHOD.value,
-            accountId,
-            personalAccessKey,
-            env,
-            name: accountIdVar,
-            auth: {
-                tokenInfo: {},
-            },
-        };
-    }
-    else if (clientId && clientSecret && refreshToken) {
-        account = {
-            authType: auth_1.OAUTH_AUTH_METHOD.value,
-            accountId,
-            auth: {
-                clientId,
-                clientSecret,
-                scopes: auth_1.OAUTH_SCOPES.map((scope) => scope.value),
-                tokenInfo: {
-                    refreshToken,
-                },
-            },
-            env,
-            name: accountIdVar,
-        };
-    }
-    else if (apiKey) {
-        account = {
-            authType: auth_1.API_KEY_AUTH_METHOD.value,
-            accountId,
-            apiKey,
-            env,
-            name: accountIdVar,
-        };
-    }
-    else {
-        throw new Error((0, lang_1.i18n)('config.utils.buildConfigFromEnvironment.invalidAuthType'));
-    }
-    return {
-        accounts: [account],
-        defaultAccount: accountId,
-        httpTimeout,
-        httpUseLocalhost,
-        allowUsageTracking,
-        defaultCmsPublishMode,
-    };
-}
-exports.buildConfigFromEnvironment = buildConfigFromEnvironment;
-function getAccountIdentifierAndType(accountIdentifier) {
-    const identifierAsNumber = typeof accountIdentifier === 'number'
-        ? accountIdentifier
-        : parseInt(accountIdentifier);
-    const isId = !isNaN(identifierAsNumber);
-    return {
-        identifier: isId ? identifierAsNumber : accountIdentifier,
-        identifierType: isId
-            ? config_1.ACCOUNT_IDENTIFIERS.ACCOUNT_ID
-            : config_1.ACCOUNT_IDENTIFIERS.NAME,
-    };
-}
-exports.getAccountIdentifierAndType = getAccountIdentifierAndType;
-function getConfigAccountByIdentifier(accounts, identifierFieldName, identifier) {
-    return accounts.find(account => account[identifierFieldName] === identifier);
-}
-exports.getConfigAccountByIdentifier = getConfigAccountByIdentifier;
-function getConfigAccountByInferredIdentifier(accounts, accountIdentifier) {
-    const { identifier, identifierType } = getAccountIdentifierAndType(accountIdentifier);
-    return accounts.find(account => account[identifierType] === identifier);
-}
-exports.getConfigAccountByInferredIdentifier = getConfigAccountByInferredIdentifier;
-function getConfigAccountIndexById(accounts, id) {
-    return accounts.findIndex(account => account.accountId === id);
-}
-exports.getConfigAccountIndexById = getConfigAccountIndexById;
-function isConfigAccountValid(account) {
-    if (!account || typeof account !== 'object') {
-        logger_1.logger.debug((0, lang_1.i18n)('config.utils.isConfigAccountValid.missingAccount'));
-        return false;
-    }
-    if (!account.accountId) {
-        logger_1.logger.debug((0, lang_1.i18n)('config.utils.isConfigAccountValid.missingAccountId'));
-        return false;
-    }
-    if (!account.authType) {
-        logger_1.logger.debug((0, lang_1.i18n)('config.utils.isConfigAccountValid.missingAuthType', {
-            accountId: account.accountId,
-        }));
-        return false;
-    }
-    let valid = false;
-    if (account.authType === auth_1.PERSONAL_ACCESS_KEY_AUTH_METHOD.value) {
-        valid =
-            'personalAccessKey' in account && Boolean(account.personalAccessKey);
-        if (!valid) {
-            logger_1.logger.debug((0, lang_1.i18n)('config.utils.isConfigAccountValid.missingPersonalAccessKey', {
-                accountId: account.accountId,
-            }));
-        }
-    }
-    if (account.authType === auth_1.OAUTH_AUTH_METHOD.value) {
-        valid = 'auth' in account && Boolean(account.auth);
-        if (!valid) {
-            logger_1.logger.debug((0, lang_1.i18n)('config.utils.isConfigAccountValid.missingAuth', {
-                accountId: account.accountId,
-            }));
-        }
-    }
-    if (account.authType === auth_1.API_KEY_AUTH_METHOD.value) {
-        valid = 'apiKey' in account && Boolean(account.apiKey);
-        if (!valid) {
-            logger_1.logger.debug((0, lang_1.i18n)('config.utils.isConfigAccountValid.missingApiKey', {
-                accountId: account.accountId,
-            }));
-        }
-    }
-    return valid;
-}
-exports.isConfigAccountValid = isConfigAccountValid;