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

package/config/utils.js

@@ -0,0 +1,328 @@
+"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;

package/constants/config.d.ts

@@ -1,4 +1,45 @@
 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 = ".hscli";
 export declare const HUBSPOT_CONFIGURATION_FILE = "config.yml";
+export declare const DEFAULT_ACCOUNT_OVERRIDE_FILE_NAME = ".hsaccount";
+export declare const DEFAULT_ACCOUNT_OVERRIDE_ERROR_INVALID_ID = "DEFAULT_ACCOUNT_OVERRIDE_ERROR_INVALID_ID";
+export declare const DEFAULT_ACCOUNT_OVERRIDE_ERROR_ACCOUNT_NOT_FOUND = "DEFAULT_ACCOUNT_OVERRIDE_ERROR_ACCOUNT_NOT_FOUND";
 export declare const MIN_HTTP_TIMEOUT = 3000;
+export declare const HUBSPOT_ACCOUNT_TYPES: {
+    readonly DEVELOPMENT_SANDBOX: "DEVELOPMENT_SANDBOX";
+    readonly DEVELOPER_TEST: "DEVELOPER_TEST";
+    readonly APP_DEVELOPER: "APP_DEVELOPER";
+    readonly STANDARD_SANDBOX: "STANDARD_SANDBOX";
+    readonly STANDARD: "STANDARD";
+};
+export declare const HUBSPOT_ACCOUNT_TYPE_STRINGS: {
+    readonly DEVELOPMENT_SANDBOX: string;
+    readonly STANDARD_SANDBOX: string;
+    readonly DEVELOPER_TEST: string;
+    readonly APP_DEVELOPER: string;
+    readonly STANDARD: string;
+};
+export declare const CONFIG_FLAGS: {
+    readonly USE_CUSTOM_OBJECT_HUBFILE: "useCustomObjectHubfile";
+    readonly HTTP_USE_LOCALHOST: "httpUseLocalhost";
+};
+export declare const ENVIRONMENT_VARIABLES: {
+    readonly HUBSPOT_API_KEY: "HUBSPOT_API_KEY";
+    readonly HUBSPOT_CLIENT_ID: "HUBSPOT_CLIENT_ID";
+    readonly HUBSPOT_CLIENT_SECRET: "HUBSPOT_CLIENT_SECRET";
+    readonly HUBSPOT_PERSONAL_ACCESS_KEY: "HUBSPOT_PERSONAL_ACCESS_KEY";
+    readonly HUBSPOT_ACCOUNT_ID: "HUBSPOT_ACCOUNT_ID";
+    readonly HUBSPOT_PORTAL_ID: "HUBSPOT_PORTAL_ID";
+    readonly HUBSPOT_REFRESH_TOKEN: "HUBSPOT_REFRESH_TOKEN";
+    readonly HUBSPOT_ENVIRONMENT: "HUBSPOT_ENVIRONMENT";
+    readonly HTTP_TIMEOUT: "HTTP_TIMEOUT";
+    readonly HTTP_USE_LOCALHOST: "HTTP_USE_LOCALHOST";
+    readonly ALLOW_USAGE_TRACKING: "ALLOW_USAGE_TRACKING";
+    readonly DEFAULT_CMS_PUBLISH_MODE: "DEFUALT_CMS_PUBLISH_MODE";
+    readonly USE_ENVIRONMENT_HUBSPOT_CONFIG: "USE_ENVIRONMENT_HUBSPOT_CONFIG";
+    readonly HUBSPOT_CONFIG_PATH: "HUBSPOT_CONFIG_PATH";
+};
+export declare const ACCOUNT_IDENTIFIERS: {
+    readonly ACCOUNT_ID: "accountId";
+    readonly NAME: "name";
+};

package/constants/config.js

@@ -1,8 +1,49 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MIN_HTTP_TIMEOUT = exports.HUBSPOT_CONFIGURATION_FILE = exports.HUBSPOT_CONFIGURATION_FOLDER = exports.DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME = void 0;
-// NOTE this is the legacy config file name (We still need to keep it around though)
+exports.ACCOUNT_IDENTIFIERS = exports.ENVIRONMENT_VARIABLES = exports.CONFIG_FLAGS = exports.HUBSPOT_ACCOUNT_TYPE_STRINGS = exports.HUBSPOT_ACCOUNT_TYPES = exports.MIN_HTTP_TIMEOUT = exports.DEFAULT_ACCOUNT_OVERRIDE_ERROR_ACCOUNT_NOT_FOUND = exports.DEFAULT_ACCOUNT_OVERRIDE_ERROR_INVALID_ID = exports.DEFAULT_ACCOUNT_OVERRIDE_FILE_NAME = 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 = '.hscli';
 exports.HUBSPOT_CONFIGURATION_FILE = 'config.yml';
+exports.DEFAULT_ACCOUNT_OVERRIDE_FILE_NAME = '.hsaccount';
+exports.DEFAULT_ACCOUNT_OVERRIDE_ERROR_INVALID_ID = 'DEFAULT_ACCOUNT_OVERRIDE_ERROR_INVALID_ID';
+exports.DEFAULT_ACCOUNT_OVERRIDE_ERROR_ACCOUNT_NOT_FOUND = 'DEFAULT_ACCOUNT_OVERRIDE_ERROR_ACCOUNT_NOT_FOUND';
 exports.MIN_HTTP_TIMEOUT = 3000;
+exports.HUBSPOT_ACCOUNT_TYPES = {
+    DEVELOPMENT_SANDBOX: 'DEVELOPMENT_SANDBOX',
+    DEVELOPER_TEST: 'DEVELOPER_TEST',
+    APP_DEVELOPER: 'APP_DEVELOPER',
+    STANDARD_SANDBOX: 'STANDARD_SANDBOX',
+    STANDARD: 'STANDARD',
+};
+exports.HUBSPOT_ACCOUNT_TYPE_STRINGS = {
+    DEVELOPMENT_SANDBOX: (0, lang_1.i18n)('lib.accountTypes.developmentSandbox'),
+    STANDARD_SANDBOX: (0, lang_1.i18n)('lib.accountTypes.standardSandbox'),
+    DEVELOPER_TEST: (0, lang_1.i18n)('lib.accountTypes.developerTest'),
+    APP_DEVELOPER: (0, lang_1.i18n)('lib.accountTypes.appDeveloper'),
+    STANDARD: (0, lang_1.i18n)('lib.accountTypes.standard'),
+};
+exports.CONFIG_FLAGS = {
+    USE_CUSTOM_OBJECT_HUBFILE: 'useCustomObjectHubfile',
+    HTTP_USE_LOCALHOST: 'httpUseLocalhost',
+};
+exports.ENVIRONMENT_VARIABLES = {
+    HUBSPOT_API_KEY: 'HUBSPOT_API_KEY',
+    HUBSPOT_CLIENT_ID: 'HUBSPOT_CLIENT_ID',
+    HUBSPOT_CLIENT_SECRET: 'HUBSPOT_CLIENT_SECRET',
+    HUBSPOT_PERSONAL_ACCESS_KEY: 'HUBSPOT_PERSONAL_ACCESS_KEY',
+    HUBSPOT_ACCOUNT_ID: 'HUBSPOT_ACCOUNT_ID',
+    HUBSPOT_PORTAL_ID: 'HUBSPOT_PORTAL_ID',
+    HUBSPOT_REFRESH_TOKEN: 'HUBSPOT_REFRESH_TOKEN',
+    HUBSPOT_ENVIRONMENT: 'HUBSPOT_ENVIRONMENT',
+    HTTP_TIMEOUT: 'HTTP_TIMEOUT',
+    HTTP_USE_LOCALHOST: 'HTTP_USE_LOCALHOST',
+    ALLOW_USAGE_TRACKING: 'ALLOW_USAGE_TRACKING',
+    DEFAULT_CMS_PUBLISH_MODE: 'DEFUALT_CMS_PUBLISH_MODE',
+    USE_ENVIRONMENT_HUBSPOT_CONFIG: 'USE_ENVIRONMENT_HUBSPOT_CONFIG',
+    HUBSPOT_CONFIG_PATH: 'HUBSPOT_CONFIG_PATH',
+};
+exports.ACCOUNT_IDENTIFIERS = {
+    ACCOUNT_ID: 'accountId',
+    NAME: 'name',
+};

package/constants/environments.d.ts

@@ -2,13 +2,3 @@ export declare const ENVIRONMENTS: {
     readonly PROD: "prod";
     readonly QA: "qa";
 };
-export declare const ENVIRONMENT_VARIABLES: {
-    readonly HUBSPOT_API_KEY: "HUBSPOT_API_KEY";
-    readonly HUBSPOT_CLIENT_ID: "HUBSPOT_CLIENT_ID";
-    readonly HUBSPOT_CLIENT_SECRET: "HUBSPOT_CLIENT_SECRET";
-    readonly HUBSPOT_PERSONAL_ACCESS_KEY: "HUBSPOT_PERSONAL_ACCESS_KEY";
-    readonly HUBSPOT_ACCOUNT_ID: "HUBSPOT_ACCOUNT_ID";
-    readonly HUBSPOT_PORTAL_ID: "HUBSPOT_PORTAL_ID";
-    readonly HUBSPOT_REFRESH_TOKEN: "HUBSPOT_REFRESH_TOKEN";
-    readonly HUBSPOT_ENVIRONMENT: "HUBSPOT_ENVIRONMENT";
-};

package/constants/environments.js

@@ -1,17 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ENVIRONMENT_VARIABLES = exports.ENVIRONMENTS = void 0;
+exports.ENVIRONMENTS = void 0;
 exports.ENVIRONMENTS = {
     PROD: 'prod',
     QA: 'qa',
 };
-exports.ENVIRONMENT_VARIABLES = {
-    HUBSPOT_API_KEY: 'HUBSPOT_API_KEY',
-    HUBSPOT_CLIENT_ID: 'HUBSPOT_CLIENT_ID',
-    HUBSPOT_CLIENT_SECRET: 'HUBSPOT_CLIENT_SECRET',
-    HUBSPOT_PERSONAL_ACCESS_KEY: 'HUBSPOT_PERSONAL_ACCESS_KEY',
-    HUBSPOT_ACCOUNT_ID: 'HUBSPOT_ACCOUNT_ID',
-    HUBSPOT_PORTAL_ID: 'HUBSPOT_PORTAL_ID',
-    HUBSPOT_REFRESH_TOKEN: 'HUBSPOT_REFRESH_TOKEN',
-    HUBSPOT_ENVIRONMENT: 'HUBSPOT_ENVIRONMENT',
-};

package/constants/extensions.d.ts

@@ -1,4 +1,6 @@
 export declare const ALLOWED_EXTENSIONS: Set<string>;
+export declare const JSR_ALLOWED_EXTENSIONS: Set<string>;
 export declare const HUBL_EXTENSIONS: Set<string>;
 export declare const MODULE_EXTENSION = "module";
 export declare const FUNCTIONS_EXTENSION = "functions";
+export declare const FOLDER_DOT_EXTENSIONS: string[];

package/constants/extensions.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FUNCTIONS_EXTENSION = exports.MODULE_EXTENSION = exports.HUBL_EXTENSIONS = exports.ALLOWED_EXTENSIONS = void 0;
+exports.FOLDER_DOT_EXTENSIONS = exports.FUNCTIONS_EXTENSION = exports.MODULE_EXTENSION = exports.HUBL_EXTENSIONS = exports.JSR_ALLOWED_EXTENSIONS = exports.ALLOWED_EXTENSIONS = void 0;
 exports.ALLOWED_EXTENSIONS = new Set([
     'css',
     'js',
@@ -21,6 +21,8 @@ exports.ALLOWED_EXTENSIONS = new Set([
     'woff2',
     'graphql',
 ]);
+exports.JSR_ALLOWED_EXTENSIONS = new Set(['jsx', 'tsx', 'ts']);
 exports.HUBL_EXTENSIONS = new Set(['css', 'html', 'js']);
 exports.MODULE_EXTENSION = 'module';
 exports.FUNCTIONS_EXTENSION = 'functions';
+exports.FOLDER_DOT_EXTENSIONS = [exports.FUNCTIONS_EXTENSION, exports.MODULE_EXTENSION];

package/constants/files.d.ts

@@ -3,11 +3,11 @@ export declare const STAT_TYPES: {
     readonly SYMBOLIC_LINK: "symlink";
     readonly DIRECTORY: "dir";
 };
-export declare const MODE: {
+export declare const CMS_PUBLISH_MODE: {
     readonly draft: "draft";
     readonly publish: "publish";
 };
-export declare const DEFAULT_MODE: "publish";
+export declare const DEFAULT_CMS_PUBLISH_MODE: "publish";
 export declare const FILE_UPLOAD_RESULT_TYPES: {
     readonly SUCCESS: "SUCCESS";
     readonly FAILURE: "FAILURE";

package/constants/files.js

@@ -1,16 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FILE_TYPES = exports.FILE_UPLOAD_RESULT_TYPES = exports.DEFAULT_MODE = exports.MODE = exports.STAT_TYPES = void 0;
+exports.FILE_TYPES = exports.FILE_UPLOAD_RESULT_TYPES = exports.DEFAULT_CMS_PUBLISH_MODE = exports.CMS_PUBLISH_MODE = exports.STAT_TYPES = void 0;
 exports.STAT_TYPES = {
     FILE: 'file',
     SYMBOLIC_LINK: 'symlink',
     DIRECTORY: 'dir',
 };
-exports.MODE = {
+exports.CMS_PUBLISH_MODE = {
     draft: 'draft',
     publish: 'publish',
 };
-exports.DEFAULT_MODE = exports.MODE.publish;
+exports.DEFAULT_CMS_PUBLISH_MODE = exports.CMS_PUBLISH_MODE.publish;
 exports.FILE_UPLOAD_RESULT_TYPES = {
     SUCCESS: 'SUCCESS',
     FAILURE: 'FAILURE',

package/errors/errors_DEPRECATED.d.ts

@@ -1,7 +1,3 @@
-import { BaseError, FileSystemErrorContext } from '../types/Error';
-type ErrorContext = {
-    accountId?: number;
-};
+import { BaseError, FileSystemErrorContext, ErrorContext } from '../types/Error';
 export declare function logErrorInstance(error: BaseError, context?: ErrorContext): void;
 export declare function logFileSystemErrorInstance(error: BaseError, context: FileSystemErrorContext): void;
-export {};

package/errors/errors_DEPRECATED.js

@@ -37,10 +37,10 @@ function logErrorInstance(error, context) {
 exports.logErrorInstance = logErrorInstance;
 function logFileSystemErrorInstance(error, context) {
     let fileAction = '';
-    if (context.read) {
+    if (context.operation === 'read') {
         fileAction = 'reading from';
     }
-    else if (context.write) {
+    else if (context.operation === 'write') {
         fileAction = 'writing to';
     }
     else {

package/errors/index.d.ts

@@ -0,0 +1,18 @@
+import { HubSpotHttpError } from '../models/HubSpotHttpError';
+import { BaseError } from '../types/Error';
+import { FileSystemError } from '../models/FileSystemError';
+export declare function isSpecifiedError(err: unknown, { statusCode, category, subCategory, errorType, code, }: {
+    statusCode?: number;
+    category?: string;
+    subCategory?: string;
+    errorType?: string;
+    code?: string;
+}): err is HubSpotHttpError;
+export declare function isMissingScopeError(err: unknown): err is HubSpotHttpError;
+export declare function isGatingError(err: unknown): err is HubSpotHttpError;
+export declare function isTimeoutError(err: unknown): err is HubSpotHttpError;
+export declare function isAuthError(err: unknown): err is HubSpotHttpError;
+export declare function isValidationError(err: unknown): boolean;
+export declare function isHubSpotHttpError(error?: unknown): error is HubSpotHttpError;
+export declare function isSystemError(err: unknown): err is BaseError;
+export declare function isFileSystemError(err: unknown): err is FileSystemError;

package/errors/index.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isFileSystemError = exports.isSystemError = exports.isHubSpotHttpError = exports.isValidationError = exports.isAuthError = exports.isTimeoutError = exports.isGatingError = exports.isMissingScopeError = exports.isSpecifiedError = void 0;
+const HubSpotHttpError_1 = require("../models/HubSpotHttpError");
+const FileSystemError_1 = require("../models/FileSystemError");
+function isSpecifiedError(err, { statusCode, category, subCategory, errorType, code, }) {
+    if (!isHubSpotHttpError(err)) {
+        return false;
+    }
+    const { data, status, code: actualCode } = err;
+    const statusCodeMatchesError = !statusCode || status === statusCode;
+    const categoryMatchesError = !category || data?.category === category;
+    const subCategoryMatchesError = !subCategory || data?.subCategory === subCategory;
+    const errorTypeMatchesError = !errorType || data?.errorType === errorType;
+    const codeMatchesError = !code || actualCode === code;
+    return (statusCodeMatchesError &&
+        categoryMatchesError &&
+        subCategoryMatchesError &&
+        errorTypeMatchesError &&
+        codeMatchesError);
+}
+exports.isSpecifiedError = isSpecifiedError;
+function isMissingScopeError(err) {
+    return isSpecifiedError(err, { statusCode: 403, category: 'MISSING_SCOPES' });
+}
+exports.isMissingScopeError = isMissingScopeError;
+function isGatingError(err) {
+    return isSpecifiedError(err, { statusCode: 403, category: 'GATED' });
+}
+exports.isGatingError = isGatingError;
+function isTimeoutError(err) {
+    return isSpecifiedError(err, { code: 'ETIMEDOUT' });
+}
+exports.isTimeoutError = isTimeoutError;
+function isAuthError(err) {
+    return (isSpecifiedError(err, { statusCode: 401 }) ||
+        isSpecifiedError(err, { statusCode: 403 }));
+}
+exports.isAuthError = isAuthError;
+function isValidationError(err) {
+    return (isHubSpotHttpError(err) &&
+        isSpecifiedError(err, { statusCode: 400 }) &&
+        !!(err?.data?.message || !!err.data?.errors));
+}
+exports.isValidationError = isValidationError;
+function isHubSpotHttpError(error) {
+    return !!error && error instanceof HubSpotHttpError_1.HubSpotHttpError;
+}
+exports.isHubSpotHttpError = isHubSpotHttpError;
+function isSystemError(err) {
+    return (err instanceof Error &&
+        'errno' in err &&
+        err.errno != null &&
+        'code' in err &&
+        err.code != null &&
+        'syscall' in err &&
+        err.syscall != null);
+}
+exports.isSystemError = isSystemError;
+function isFileSystemError(err) {
+    return err instanceof FileSystemError_1.FileSystemError;
+}
+exports.isFileSystemError = isFileSystemError;

package/http/addQueryParams.d.ts

@@ -0,0 +1,2 @@
+import { HttpOptions, QueryParams } from '../types/Http';
+export declare function addQueryParams(configOptions: HttpOptions, queryParams?: QueryParams): HttpOptions;

package/http/addQueryParams.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addQueryParams = void 0;
+function addQueryParams(configOptions, queryParams = {}) {
+    const { params } = configOptions;
+    return {
+        ...configOptions,
+        params: {
+            ...queryParams,
+            ...params,
+        },
+    };
+}
+exports.addQueryParams = addQueryParams;

package/http/getAxiosConfig.d.ts

@@ -1,6 +1,9 @@
-import { AxiosConfigOptions } from '../types/Http';
+import { HttpOptions } from '../types/Http';
 import { AxiosRequestConfig } from 'axios';
-export declare const DEFAULT_USER_AGENT_HEADERS: {
+export declare const USER_AGENTS: {
+    [key: string]: string;
+};
+export declare function getDefaultUserAgentHeader(): {
     'User-Agent': string;
 };
-export declare function getAxiosConfig(options: AxiosConfigOptions): AxiosRequestConfig;
+export declare function getAxiosConfig(options: HttpOptions): AxiosRequestConfig;