@hubspot/local-dev-lib 4.0.4 → 5.0.0-beta.1

package/lib/cms/watch.js

@@ -1,48 +1,42 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.watch = void 0;
-const path_1 = __importDefault(require("path"));
-const chokidar_1 = __importDefault(require("chokidar"));
-const p_queue_1 = __importDefault(require("p-queue"));
-const debounce_1 = __importDefault(require("debounce"));
-const handleFieldsJS_1 = require("./handleFieldsJS");
-const uploadFolder_1 = require("./uploadFolder");
-const ignoreRules_1 = require("../ignoreRules");
-const fileMapper_1 = require("../fileMapper");
-const fileMapper_2 = require("../../api/fileMapper");
-const escapeRegExp_1 = require("../escapeRegExp");
-const path_2 = require("../path");
-const notify_1 = require("../notify");
-const themes_1 = require("./themes");
-const logger_1 = require("../logger");
-const lang_1 = require("../../utils/lang");
-const HubSpotHttpError_1 = require("../../models/HubSpotHttpError");
-const errors_1 = require("../../errors");
+import path from 'path';
+import chokidar from 'chokidar';
+import PQueue from 'p-queue';
+import debounce from 'debounce';
+import { isConvertableFieldJs, FieldsJs } from './handleFieldsJS.js';
+import { uploadFolder } from './uploadFolder.js';
+import { shouldIgnoreFile, ignoreFile } from '../ignoreRules.js';
+import { getFileMapperQueryValues } from '../fileMapper.js';
+import { upload, deleteFile } from '../../api/fileMapper.js';
+import { escapeRegExp } from '../escapeRegExp.js';
+import { convertToUnixPath, isAllowedExtension, getCwd } from '../path.js';
+import { triggerNotify } from '../notify.js';
+import { getThemePreviewUrl, getThemeJSONPath } from './themes.js';
+import { logger } from '../logger.js';
+import { i18n } from '../../utils/lang.js';
+import { HubSpotHttpError } from '../../models/HubSpotHttpError.js';
+import { isHubSpotHttpError } from '../../errors/index.js';
 const i18nKey = 'lib.cms.watch';
-const queue = new p_queue_1.default({
+const queue = new PQueue({
     concurrency: 10,
 });
 function _notifyOfThemePreview(filePath, accountId) {
     if (queue.size > 0)
         return;
-    const previewUrl = (0, themes_1.getThemePreviewUrl)(filePath, accountId);
+    const previewUrl = getThemePreviewUrl(filePath, accountId);
     if (!previewUrl)
         return;
-    logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.notifyOfThemePreview`, {
+    logger.log(i18n(`${i18nKey}.notifyOfThemePreview`, {
         previewUrl,
     }));
 }
-const notifyOfThemePreview = (0, debounce_1.default)(_notifyOfThemePreview, 1000);
+const notifyOfThemePreview = debounce(_notifyOfThemePreview, 1000);
 const defaultOnUploadFileError = (file, dest, accountId) => (error) => {
-    const uploadFailedMessage = (0, lang_1.i18n)(`${i18nKey}.uploadFailed`, {
+    const uploadFailedMessage = i18n(`${i18nKey}.uploadFailed`, {
         file,
         dest,
     });
-    logger_1.logger.debug(uploadFailedMessage);
-    throw new HubSpotHttpError_1.HubSpotHttpError(uploadFailedMessage, {
+    logger.debug(uploadFailedMessage);
+    throw new HubSpotHttpError(uploadFailedMessage, {
         cause: error,
     }, {
         accountId,
@@ -52,61 +46,61 @@ const defaultOnUploadFileError = (file, dest, accountId) => (error) => {
 };
 async function uploadFile(accountId, file, dest, options, cmsPublishMode = null, onUploadFileError = defaultOnUploadFileError) {
     const src = options.src;
-    const absoluteSrcPath = path_1.default.resolve((0, path_2.getCwd)(), file);
-    const themeJsonPath = (0, themes_1.getThemeJSONPath)(absoluteSrcPath);
+    const absoluteSrcPath = path.resolve(getCwd(), file);
+    const themeJsonPath = getThemeJSONPath(absoluteSrcPath);
     const projectRoot = themeJsonPath
-        ? path_1.default.dirname(themeJsonPath)
-        : path_1.default.dirname((0, path_2.getCwd)());
-    const convertFields = (0, handleFieldsJS_1.isConvertableFieldJs)(src, file, options.commandOptions.convertFields);
-    if (!(0, path_2.isAllowedExtension)(file) && !convertFields) {
-        logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.skipUnsupportedExtension`, { file }));
+        ? path.dirname(themeJsonPath)
+        : path.dirname(getCwd());
+    const convertFields = isConvertableFieldJs(src, file, options.commandOptions.convertFields);
+    if (!isAllowedExtension(file) && !convertFields) {
+        logger.debug(i18n(`${i18nKey}.skipUnsupportedExtension`, { file }));
         return;
     }
-    if ((0, ignoreRules_1.shouldIgnoreFile)(file)) {
-        logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.skipIgnoreRule`, { file }));
+    if (shouldIgnoreFile(file)) {
+        logger.debug(i18n(`${i18nKey}.skipIgnoreRule`, { file }));
         return;
     }
     let fieldsJs = undefined;
     if (convertFields) {
-        fieldsJs = await new handleFieldsJS_1.FieldsJs(projectRoot, absoluteSrcPath, undefined, options.fieldOptions).init();
+        fieldsJs = await new FieldsJs(projectRoot, absoluteSrcPath, undefined, options.fieldOptions).init();
         if (fieldsJs.rejected)
             return;
         // Ensures that the dest path is a .json. The user might pass '.js' accidentally - this ensures it just works.
-        dest = (0, path_2.convertToUnixPath)(path_1.default.join(path_1.default.dirname(dest), 'fields.json'));
+        dest = convertToUnixPath(path.join(path.dirname(dest), 'fields.json'));
     }
     const fileToUpload = convertFields && fieldsJs?.outputPath ? fieldsJs.outputPath : file;
-    logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.uploadAttempt`, { file, dest }));
-    const apiOptions = (0, fileMapper_1.getFileMapperQueryValues)(cmsPublishMode, options);
+    logger.debug(i18n(`${i18nKey}.uploadAttempt`, { file, dest }));
+    const apiOptions = getFileMapperQueryValues(cmsPublishMode, options);
     queue.add(() => {
-        return (0, fileMapper_2.upload)(accountId, fileToUpload, dest, apiOptions)
+        return upload(accountId, fileToUpload, dest, apiOptions)
             .then(() => {
-            logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.uploadSuccess`, { file, dest }));
+            logger.log(i18n(`${i18nKey}.uploadSuccess`, { file, dest }));
             notifyOfThemePreview(file, accountId);
         })
             .catch(() => {
-            logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.uploadFailed`, { file, dest }));
-            logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.uploadRetry`, { file, dest }));
-            return (0, fileMapper_2.upload)(accountId, file, dest, apiOptions).catch(onUploadFileError(file, dest, accountId));
+            logger.debug(i18n(`${i18nKey}.uploadFailed`, { file, dest }));
+            logger.debug(i18n(`${i18nKey}.uploadRetry`, { file, dest }));
+            return upload(accountId, file, dest, apiOptions).catch(onUploadFileError(file, dest, accountId));
         });
     });
 }
 async function deleteRemoteFile(accountId, filePath, remoteFilePath) {
-    if ((0, ignoreRules_1.shouldIgnoreFile)(filePath)) {
-        logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.skipIgnoreRule`, { file: filePath }));
+    if (shouldIgnoreFile(filePath)) {
+        logger.debug(i18n(`${i18nKey}.skipIgnoreRule`, { file: filePath }));
         return;
     }
-    logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.deleteAttempt`, { remoteFilePath }));
+    logger.debug(i18n(`${i18nKey}.deleteAttempt`, { remoteFilePath }));
     return queue.add(() => {
-        return (0, fileMapper_2.deleteFile)(accountId, remoteFilePath)
+        return deleteFile(accountId, remoteFilePath)
             .then(() => {
-            logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.deleteSuccess`, { remoteFilePath }));
+            logger.log(i18n(`${i18nKey}.deleteSuccess`, { remoteFilePath }));
             notifyOfThemePreview(filePath, accountId);
         })
             .catch(error => {
-            logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.deleteFailed`, {
+            logger.debug(i18n(`${i18nKey}.deleteFailed`, {
                 remoteFilePath,
             }));
-            if ((0, errors_1.isHubSpotHttpError)(error)) {
+            if (isHubSpotHttpError(error)) {
                 error.updateContext({
                     accountId,
                     request: remoteFilePath,
@@ -116,23 +110,23 @@ async function deleteRemoteFile(accountId, filePath, remoteFilePath) {
         });
     });
 }
-function watch(accountId, src, dest, { cmsPublishMode, remove, disableInitial, notify, commandOptions, filePaths, }, postInitialUploadCallback = null, onUploadFolderError, onQueueAddError, onUploadFileError) {
-    const regex = new RegExp(`^${(0, escapeRegExp_1.escapeRegExp)(src)}`);
+export function watch(accountId, src, dest, { cmsPublishMode, remove, disableInitial, notify, commandOptions, filePaths, }, postInitialUploadCallback = null, onUploadFolderError, onQueueAddError, onUploadFileError) {
+    const regex = new RegExp(`^${escapeRegExp(src)}`);
     if (notify) {
-        (0, ignoreRules_1.ignoreFile)(notify);
+        ignoreFile(notify);
     }
-    const watcher = chokidar_1.default.watch(src, {
+    const watcher = chokidar.watch(src, {
         ignoreInitial: true,
-        ignored: (file) => (0, ignoreRules_1.shouldIgnoreFile)(file),
+        ignored: (file) => shouldIgnoreFile(file),
     });
     function getDesignManagerPath(file) {
         const relativePath = file.replace(regex, '');
-        return (0, path_2.convertToUnixPath)(path_1.default.join(dest, relativePath));
+        return convertToUnixPath(path.join(dest, relativePath));
     }
     if (!disableInitial) {
         // Use uploadFolder so that failures of initial upload are retried
-        const uploadFolderPromise = (0, uploadFolder_1.uploadFolder)(accountId, src, dest, {}, commandOptions, filePaths, cmsPublishMode || null).then(result => {
-            logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.folderUploadSuccess`, {
+        const uploadFolderPromise = uploadFolder(accountId, src, dest, {}, commandOptions, filePaths, cmsPublishMode || null).then(result => {
+            logger.log(i18n(`${i18nKey}.folderUploadSuccess`, {
                 src,
                 dest,
                 accountId,
@@ -146,7 +140,7 @@ function watch(accountId, src, dest, { cmsPublishMode, remove, disableInitial, n
         }
     }
     watcher.on('ready', () => {
-        logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.ready`, { src }));
+        logger.log(i18n(`${i18nKey}.ready`, { src }));
     });
     watcher.on('add', async (filePath) => {
         const destPath = getDesignManagerPath(filePath);
@@ -154,26 +148,26 @@ function watch(accountId, src, dest, { cmsPublishMode, remove, disableInitial, n
             src,
             commandOptions,
         }, cmsPublishMode, onUploadFileError);
-        (0, notify_1.triggerNotify)(notify, 'Added', filePath, uploadPromise);
+        triggerNotify(notify, 'Added', filePath, uploadPromise);
     });
     if (remove) {
         const deleteFileOrFolder = (type) => (filePath) => {
             // If it's a fields.js file that is in a module folder or the root, then ignore because it will not exist on the server.
-            if ((0, handleFieldsJS_1.isConvertableFieldJs)(src, filePath, commandOptions.convertFields)) {
+            if (isConvertableFieldJs(src, filePath, commandOptions.convertFields)) {
                 return;
             }
             const remotePath = getDesignManagerPath(filePath);
-            if ((0, ignoreRules_1.shouldIgnoreFile)(filePath)) {
-                logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.skipIgnoreRule`, { file: filePath }));
+            if (shouldIgnoreFile(filePath)) {
+                logger.debug(i18n(`${i18nKey}.skipIgnoreRule`, { file: filePath }));
                 return;
             }
-            logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.deleteAttemptWithType`, {
+            logger.debug(i18n(`${i18nKey}.deleteAttemptWithType`, {
                 type,
                 remoteFilePath: remotePath,
             }));
             const queueAddPromise = queue.add(() => {
                 const deletePromise = deleteRemoteFile(accountId, filePath, remotePath).then(() => {
-                    logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.deleteSuccessWithType`, {
+                    logger.log(i18n(`${i18nKey}.deleteSuccessWithType`, {
                         type,
                         remoteFilePath: remotePath,
                     }));
@@ -181,7 +175,7 @@ function watch(accountId, src, dest, { cmsPublishMode, remove, disableInitial, n
                 if (onQueueAddError) {
                     queueAddPromise.catch(onQueueAddError);
                 }
-                (0, notify_1.triggerNotify)(notify, 'Removed', filePath, deletePromise);
+                triggerNotify(notify, 'Removed', filePath, deletePromise);
                 return deletePromise;
             });
         };
@@ -194,8 +188,7 @@ function watch(accountId, src, dest, { cmsPublishMode, remove, disableInitial, n
             src,
             commandOptions,
         }, cmsPublishMode, onUploadFileError);
-        (0, notify_1.triggerNotify)(notify, 'Changed', filePath, uploadPromise);
+        triggerNotify(notify, 'Changed', filePath, uploadPromise);
     });
     return watcher;
 }
-exports.watch = watch;

package/lib/crm.d.ts

@@ -1,4 +1,4 @@
-import { ImportRequest } from '../types/Crm';
+import { ImportRequest } from '../types/Crm.js';
 export declare function getImportDataRequest(fileName: string): {
     importRequest: ImportRequest;
     dataFileNames: string[];

package/lib/crm.js

@@ -1,48 +1,40 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateImportRequestFile = exports.getImportDataRequest = void 0;
-const path_1 = __importDefault(require("path"));
-const path_2 = require("./path");
-const fs_extra_1 = __importDefault(require("fs-extra"));
-const lang_1 = require("../utils/lang");
-function getImportDataRequest(fileName) {
+import path from 'path';
+import { getCwd } from './path.js';
+import fs from 'fs-extra';
+import { i18n } from '../utils/lang.js';
+export function getImportDataRequest(fileName) {
     validateImportRequestFile(fileName);
-    const importRequest = fs_extra_1.default.readJsonSync(path_1.default.resolve((0, path_2.getCwd)(), fileName));
+    const importRequest = fs.readJsonSync(path.resolve(getCwd(), fileName));
     const dataFileNames = importRequest.files.map(file => file.fileName);
     // allow relative paths in the provided import request
     importRequest.files = importRequest.files.map(file => ({
         ...file,
-        fileName: path_1.default.basename(file.fileName),
+        fileName: path.basename(file.fileName),
     }));
     if (dataFileNames.length === 0) {
-        throw new Error((0, lang_1.i18n)('lib.crm.importData.errors.noFiles'));
+        throw new Error(i18n('lib.crm.importData.errors.noFiles'));
     }
     dataFileNames.forEach(fileName => {
         if (!fileExists(fileName)) {
-            throw new Error((0, lang_1.i18n)('lib.crm.importData.errors.fileNotFound', { fileName }));
+            throw new Error(i18n('lib.crm.importData.errors.fileNotFound', { fileName }));
         }
     });
     return { importRequest, dataFileNames };
 }
-exports.getImportDataRequest = getImportDataRequest;
-function validateImportRequestFile(fileName) {
+export function validateImportRequestFile(fileName) {
     if (!fileExists(fileName)) {
-        throw new Error((0, lang_1.i18n)('lib.crm.importData.errors.fileNotFound', { fileName }));
+        throw new Error(i18n('lib.crm.importData.errors.fileNotFound', { fileName }));
     }
-    if (path_1.default.extname(fileName) !== '.json') {
-        throw new Error((0, lang_1.i18n)('lib.crm.importData.errors.notJson'));
+    if (path.extname(fileName) !== '.json') {
+        throw new Error(i18n('lib.crm.importData.errors.notJson'));
     }
 }
-exports.validateImportRequestFile = validateImportRequestFile;
 function fileExists(_path) {
     try {
-        const absoluteSrcPath = path_1.default.resolve((0, path_2.getCwd)(), _path);
+        const absoluteSrcPath = path.resolve(getCwd(), _path);
         if (!absoluteSrcPath)
             return false;
-        const stats = fs_extra_1.default.statSync(absoluteSrcPath);
+        const stats = fs.statSync(absoluteSrcPath);
         const isFile = stats.isFile();
         if (!isFile) {
             return false;

package/lib/customObjects.d.ts

@@ -1,4 +1,4 @@
-import { Schema } from '../types/Schemas';
+import { Schema } from '../types/Schemas.js';
 export declare function getResolvedPath(dest?: string, name?: string): string;
 export declare function writeSchemaToDisk(schema: Schema, dest?: string): Promise<void>;
 export declare function downloadSchemas(accountId: number, dest?: string): Promise<Array<Schema>>;

package/lib/customObjects.js

@@ -1,29 +1,21 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.downloadSchema = exports.downloadSchemas = exports.writeSchemaToDisk = exports.getResolvedPath = void 0;
-const fs_extra_1 = __importDefault(require("fs-extra"));
-const path_1 = __importDefault(require("path"));
-const prettier_1 = __importDefault(require("prettier"));
-const path_2 = require("../lib/path");
-const customObjects_1 = require("../api/customObjects");
-function getResolvedPath(dest, name) {
+import fs from 'fs-extra';
+import path from 'path';
+import { getCwd } from '../lib/path.js';
+import { fetchObjectSchemas, fetchObjectSchema } from '../api/customObjects.js';
+import { format } from 'prettier';
+export function getResolvedPath(dest, name) {
     if (name)
-        return path_1.default.resolve((0, path_2.getCwd)(), dest || '', `${name}.json`);
-    return path_1.default.resolve((0, path_2.getCwd)(), dest || '');
+        return path.resolve(getCwd(), dest || '', `${name}.json`);
+    return path.resolve(getCwd(), dest || '');
 }
-exports.getResolvedPath = getResolvedPath;
-async function writeSchemaToDisk(schema, dest) {
-    const formattedSchema = await prettier_1.default.format(JSON.stringify(schema), {
+export async function writeSchemaToDisk(schema, dest) {
+    const formattedSchema = await format(JSON.stringify(schema), {
         parser: 'json',
     });
-    fs_extra_1.default.outputFileSync(getResolvedPath(dest, schema.name), formattedSchema);
+    fs.outputFileSync(getResolvedPath(dest, schema.name), formattedSchema);
 }
-exports.writeSchemaToDisk = writeSchemaToDisk;
-async function downloadSchemas(accountId, dest) {
-    const axiosResponse = await (0, customObjects_1.fetchObjectSchemas)(accountId);
+export async function downloadSchemas(accountId, dest) {
+    const axiosResponse = await fetchObjectSchemas(accountId);
     const response = axiosResponse.data;
     if (response.results.length) {
         for (const schema of response.results) {
@@ -32,11 +24,9 @@ async function downloadSchemas(accountId, dest) {
     }
     return response.results;
 }
-exports.downloadSchemas = downloadSchemas;
-async function downloadSchema(accountId, schemaObjectType, dest) {
-    const axiosResponse = await (0, customObjects_1.fetchObjectSchema)(accountId, schemaObjectType);
+export async function downloadSchema(accountId, schemaObjectType, dest) {
+    const axiosResponse = await fetchObjectSchema(accountId, schemaObjectType);
     const response = axiosResponse.data;
     await writeSchemaToDisk(response, dest);
     return response;
 }
-exports.downloadSchema = downloadSchema;

package/lib/environment.d.ts

@@ -1,2 +1,2 @@
-import { Environment } from '../types/Config';
+import { Environment } from '../types/Accounts.js';
 export declare function getValidEnv(env?: string | null, maskedProductionValue?: Environment): Environment;

package/lib/environment.js

@@ -1,16 +1,10 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getValidEnv = void 0;
-const environments_1 = require("../constants/environments");
-function getValidEnv(env, maskedProductionValue) {
+import { ENVIRONMENTS } from '../constants/environments.js';
+export function getValidEnv(env, maskedProductionValue) {
     const prodValue = typeof maskedProductionValue === 'string'
         ? maskedProductionValue
-        : environments_1.ENVIRONMENTS.PROD;
-    const returnVal = typeof env &&
-        typeof env === 'string' &&
-        env.toLowerCase() === environments_1.ENVIRONMENTS.QA
-        ? environments_1.ENVIRONMENTS.QA
+        : ENVIRONMENTS.PROD;
+    const returnVal = env && typeof env === 'string' && env.toLowerCase() === ENVIRONMENTS.QA
+        ? ENVIRONMENTS.QA
         : prodValue;
     return returnVal;
 }
-exports.getValidEnv = getValidEnv;

package/lib/escapeRegExp.js

@@ -1,7 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.escapeRegExp = void 0;
-function escapeRegExp(string) {
+export function escapeRegExp(string) {
     return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
 }
-exports.escapeRegExp = escapeRegExp;