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

package/config/configFile.js

@@ -0,0 +1,100 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.writeConfigToFile = exports.loadConfigFromFile = exports.parseConfig = exports.readConfigFile = exports.deleteConfigFile = exports.configFileIsBlank = exports.configFileExists = exports.getConfigFilePath = void 0;
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const js_yaml_1 = __importDefault(require("js-yaml"));
+const logger_1 = require("../lib/logger");
+const config_1 = require("../constants/config");
+const configUtils_1 = require("./configUtils");
+const lang_1 = require("../utils/lang");
+const FileSystemError_1 = require("../models/FileSystemError");
+const i18nKey = 'config.configFile';
+function getConfigFilePath() {
+    return config_1.GLOBAL_CONFIG_PATH;
+}
+exports.getConfigFilePath = getConfigFilePath;
+function configFileExists() {
+    const configPath = getConfigFilePath();
+    return !!configPath && fs_extra_1.default.existsSync(configPath);
+}
+exports.configFileExists = configFileExists;
+function configFileIsBlank() {
+    const configPath = getConfigFilePath();
+    return !!configPath && fs_extra_1.default.readFileSync(configPath).length === 0;
+}
+exports.configFileIsBlank = configFileIsBlank;
+function deleteConfigFile() {
+    const configPath = getConfigFilePath();
+    fs_extra_1.default.unlinkSync(configPath);
+}
+exports.deleteConfigFile = deleteConfigFile;
+/**
+ * @throws {Error}
+ */
+function readConfigFile(configPath) {
+    let source = '';
+    try {
+        source = fs_extra_1.default.readFileSync(configPath).toString();
+    }
+    catch (err) {
+        logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.errorReading`, { configPath }));
+        throw new FileSystemError_1.FileSystemError({ cause: err }, {
+            filepath: configPath,
+            operation: 'read',
+        });
+    }
+    return source;
+}
+exports.readConfigFile = readConfigFile;
+/**
+ * @throws {Error}
+ */
+function parseConfig(configSource) {
+    let parsed;
+    try {
+        parsed = js_yaml_1.default.load(configSource);
+    }
+    catch (err) {
+        throw new Error((0, lang_1.i18n)(`${i18nKey}.errors.parsing`), { cause: err });
+    }
+    return parsed;
+}
+exports.parseConfig = parseConfig;
+/**
+ * @throws {Error}
+ */
+function loadConfigFromFile() {
+    const configPath = getConfigFilePath();
+    if (configPath) {
+        const source = readConfigFile(configPath);
+        if (!source) {
+            return null;
+        }
+        return parseConfig(source);
+    }
+    logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.errorLoading`, { configPath }));
+    return null;
+}
+exports.loadConfigFromFile = loadConfigFromFile;
+/**
+ * @throws {Error}
+ */
+function writeConfigToFile(config) {
+    const source = js_yaml_1.default.dump(JSON.parse(JSON.stringify((0, configUtils_1.getOrderedConfig)(config), null, 2)));
+    const configPath = getConfigFilePath();
+    try {
+        fs_extra_1.default.ensureFileSync(configPath);
+        fs_extra_1.default.writeFileSync(configPath, source);
+        logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.writeSuccess`, { configPath }));
+    }
+    catch (err) {
+        throw new FileSystemError_1.FileSystemError({ cause: err }, {
+            filepath: configPath,
+            operation: 'write',
+        });
+    }
+}
+exports.writeConfigToFile = writeConfigToFile;

package/config/configUtils.d.ts

@@ -0,0 +1,5 @@
+import { CLIConfig_NEW } from '../types/Config';
+import { AuthType, CLIAccount_NEW, PersonalAccessKeyOptions, OAuthOptions, APIKeyOptions } from '../types/Accounts';
+export declare function getOrderedAccount(unorderedAccount: CLIAccount_NEW): CLIAccount_NEW;
+export declare function getOrderedConfig(unorderedConfig: CLIConfig_NEW): CLIConfig_NEW;
+export declare function generateConfig(type: AuthType, options: PersonalAccessKeyOptions | OAuthOptions | APIKeyOptions): CLIConfig_NEW | null;

package/config/configUtils.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateConfig = exports.getOrderedConfig = exports.getOrderedAccount = void 0;
+const logger_1 = require("../lib/logger");
+const auth_1 = require("../constants/auth");
+const lang_1 = require("../utils/lang");
+const i18nKey = 'config.configUtils';
+function getOrderedAccount(unorderedAccount) {
+    const { name, accountId, env, authType, ...rest } = unorderedAccount;
+    return {
+        name,
+        accountId,
+        env,
+        authType,
+        ...rest,
+    };
+}
+exports.getOrderedAccount = getOrderedAccount;
+function getOrderedConfig(unorderedConfig) {
+    const { defaultAccount, defaultCmsPublishMode, httpTimeout, allowUsageTracking, accounts, ...rest } = unorderedConfig;
+    return {
+        ...(defaultAccount && { defaultAccount }),
+        defaultCmsPublishMode,
+        httpTimeout,
+        allowUsageTracking,
+        ...rest,
+        accounts: accounts.map(getOrderedAccount),
+    };
+}
+exports.getOrderedConfig = getOrderedConfig;
+function generatePersonalAccessKeyAccountConfig({ accountId, personalAccessKey, env, }) {
+    return {
+        authType: auth_1.PERSONAL_ACCESS_KEY_AUTH_METHOD.value,
+        accountId,
+        personalAccessKey,
+        env,
+    };
+}
+function generateOauthAccountConfig({ accountId, clientId, clientSecret, refreshToken, scopes, env, }) {
+    return {
+        authType: auth_1.OAUTH_AUTH_METHOD.value,
+        accountId,
+        auth: {
+            clientId,
+            clientSecret,
+            scopes,
+            tokenInfo: {
+                refreshToken,
+            },
+        },
+        env,
+    };
+}
+function generateApiKeyAccountConfig({ accountId, apiKey, env, }) {
+    return {
+        authType: auth_1.API_KEY_AUTH_METHOD.value,
+        accountId,
+        apiKey,
+        env,
+    };
+}
+function generateConfig(type, options) {
+    if (!options) {
+        return null;
+    }
+    const config = { accounts: [] };
+    let configAccount;
+    switch (type) {
+        case auth_1.API_KEY_AUTH_METHOD.value:
+            configAccount = generateApiKeyAccountConfig(options);
+            break;
+        case auth_1.PERSONAL_ACCESS_KEY_AUTH_METHOD.value:
+            configAccount = generatePersonalAccessKeyAccountConfig(options);
+            break;
+        case auth_1.OAUTH_AUTH_METHOD.value:
+            configAccount = generateOauthAccountConfig(options);
+            break;
+        default:
+            logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.unknownType`, { type }));
+            return null;
+    }
+    if (configAccount) {
+        config.accounts.push(configAccount);
+    }
+    return config;
+}
+exports.generateConfig = generateConfig;

package/config/config_DEPRECATED.d.ts

@@ -0,0 +1,76 @@
+import { CLIConfig_DEPRECATED, Environment } from '../types/Config';
+import { AccountType, CLIAccount_DEPRECATED, FlatAccountFields_DEPRECATED, UpdateAccountConfigOptions } from '../types/Accounts';
+import { CmsPublishMode } from '../types/Files';
+import { CLIOptions, WriteConfigOptions } from '../types/CLIOptions';
+export declare const getConfig: () => CLIConfig_DEPRECATED | null;
+export declare function setConfig(updatedConfig?: CLIConfig_DEPRECATED): CLIConfig_DEPRECATED | null;
+export declare function getConfigAccounts(config?: CLIConfig_DEPRECATED): Array<CLIAccount_DEPRECATED> | undefined;
+export declare function getConfigDefaultAccount(config?: CLIConfig_DEPRECATED): string | number | undefined;
+export declare function getConfigAccountId(account: CLIAccount_DEPRECATED): number | undefined;
+export declare function setConfigPath(path: string | null): string | null;
+export declare function getConfigPath(path?: string | null): string | null;
+export declare function validateConfig(): boolean;
+export declare function accountNameExistsInConfig(name: string): boolean;
+export declare function getOrderedAccount(unorderedAccount: CLIAccount_DEPRECATED): CLIAccount_DEPRECATED;
+export declare function getOrderedConfig(unorderedConfig: CLIConfig_DEPRECATED): {
+    portals: CLIAccount_DEPRECATED[];
+    defaultMode?: CmsPublishMode | undefined;
+    env?: Environment | undefined;
+    httpUseLocalhost?: boolean | undefined;
+    defaultCmsPublishMode: CmsPublishMode | undefined;
+    httpTimeout: number | undefined;
+    allowUsageTracking: boolean | undefined;
+    defaultPortal?: string | number | undefined;
+};
+export declare function writeConfig(options?: WriteConfigOptions): void;
+export declare function loadConfig(path?: string, options?: CLIOptions): CLIConfig_DEPRECATED | null;
+export declare function isTrackingAllowed(): boolean;
+export declare function getAndLoadConfigIfNeeded(options?: {}): Partial<CLIConfig_DEPRECATED>;
+export declare function findConfig(directory: string): string | null;
+export declare function getEnv(nameOrId?: string | number): Environment;
+export declare function getAccountType(accountType?: AccountType, sandboxAccountType?: string | null): AccountType;
+export declare function getAccountConfig(accountId: number | undefined): CLIAccount_DEPRECATED | undefined;
+export declare function getAccountId(nameOrId?: string | number): number | undefined;
+/**
+ * @throws {Error}
+ */
+export declare function removeSandboxAccountFromConfig(nameOrId: string | number): boolean;
+/**
+ * @throws {Error}
+ */
+export declare function updateAccountConfig(configOptions: UpdateAccountConfigOptions): FlatAccountFields_DEPRECATED;
+/**
+ * @throws {Error}
+ */
+export declare function updateDefaultAccount(defaultAccount: string | number): void;
+/**
+ * @throws {Error}
+ */
+export declare function updateDefaultCmsPublishMode(defaultCmsPublishMode: CmsPublishMode): void;
+/**
+ * @throws {Error}
+ */
+export declare function updateHttpTimeout(timeout: string): void;
+/**
+ * @throws {Error}
+ */
+export declare function updateAllowUsageTracking(isEnabled: boolean): void;
+/**
+ * @throws {Error}
+ */
+export declare function renameAccount(currentName: string, newName: string): Promise<void>;
+/**
+ * @throws {Error}
+ */
+export declare function deleteAccount(accountName: string): Promise<void>;
+export declare function createEmptyConfigFile({ path }?: {
+    path?: string;
+}): void;
+export declare function deleteEmptyConfigFile(): void;
+export declare function deleteConfigFile(): void;
+export declare function loadConfigFromEnvironment({ useEnv, }?: {
+    useEnv?: boolean;
+}): {
+    portals: Array<CLIAccount_DEPRECATED>;
+} | undefined;
+export declare function isConfigFlagEnabled(flag: keyof CLIConfig_DEPRECATED): boolean;