@hubspot/local-dev-lib 0.3.4 → 0.3.5

package/lang/en.json

@@ -83,9 +83,7 @@
                     "creatingPath": "Creating {{ path }}",
                     "errors": {
                         "pathExists": "The {{ path }} path already exists",
-                        "failedToWriteMeta": "There was an problem writing the module's meta data at {{ path }}",
-                        "fileReadFailure": "Failed to read file at {{ path }}",
-                        "failedToWrite": "failed to write to file at {{ path }}"
+                        "fileUpdateFailure": "There was a problem updating the modules files at {{ path }}: {{ errorMessage }}"
                     }
                 },
                 "retrieveDefaultModule": {

package/lang/lang/en.json

@@ -83,9 +83,7 @@
           "creatingPath": "Creating {{ path }}",
           "errors": {
             "pathExists": "The {{ path }} path already exists",
-            "failedToWriteMeta": "There was an problem writing the module's meta data at {{ path }}",
-            "fileReadFailure": "Failed to read file at {{ path }}",
-            "failedToWrite": "failed to write to file at {{ path }}"
+            "fileUpdateFailure": "There was a problem updating the modules files at {{ path }}: {{ errorMessage }}"
           }
         },
         "retrieveDefaultModule": {

package/lib/cms/handleFieldsJS.js

@@ -8,7 +8,7 @@ const fs_extra_1 = __importDefault(require("fs-extra"));
 const os_1 = __importDefault(require("os"));
 const path_1 = __importDefault(require("path"));
 const child_process_1 = require("child_process");
-const escapeRegExp_1 = require("../../utils/escapeRegExp");
+const escapeRegExp_1 = require("../escapeRegExp");
 const modules_1 = require("../../utils/cms/modules");
 const logger_1 = require("../logging/logger");
 const standardErrors_1 = require("../../errors/standardErrors");

package/lib/cms/modules.js

@@ -84,40 +84,43 @@ const MODULE_STRING_TRANSFORMATIONS = [
         fallback: '',
     },
 ];
-const transformFileContents = (file, metaData, getInternalVersion) => {
-    fs_extra_1.default.readFile(file, 'utf8', (err, data) => {
-        if (err) {
-            (0, standardErrors_1.throwErrorWithMessage)(`${i18nKey}.createModule.errors.fileReadFailure`, {
-                path: file,
-            });
-        }
-        let results = data;
+const updateFileContents = async (file, metaData, getInternalVersion) => {
+    try {
+        let fileContents = await fs_extra_1.default.readFile(file, 'utf8'); // returns Promise
         MODULE_STRING_TRANSFORMATIONS.forEach(entry => {
             const replacementString = getInternalVersion
                 ? entry.string
                 : entry.fallback;
-            results = results.replace(entry.regex, replacementString);
-        });
-        fs_extra_1.default.writeFile(file, results, 'utf8', err => {
-            if (err) {
-                (0, standardErrors_1.throwErrorWithMessage)(`${i18nKey}.createModule.errors.failedToWrite`, {
-                    path: file,
-                });
-            }
+            fileContents = fileContents.replace(entry.regex, replacementString);
         });
-        fs_extra_1.default.appendFile(file, 'export const meta = ' + JSON.stringify(metaData, null, ' '), err => {
-            if (err) {
-                (0, standardErrors_1.throwErrorWithMessage)(`${i18nKey}.createModule.errors.failedToWrite`, {
-                    path: file,
-                });
-            }
+        await fs_extra_1.default.writeFile(file, fileContents, 'utf8');
+        await fs_extra_1.default.appendFile(file, 'export const meta = ' + JSON.stringify(metaData, null, ' '));
+    }
+    catch (error) {
+        const { message } = error;
+        (0, standardErrors_1.throwErrorWithMessage)(`${i18nKey}.createModule.errors.fileUpdateFailure`, {
+            path: file,
+            errorMessage: message,
         });
-    });
+    }
 };
 async function createModule(moduleDefinition, name, dest, getInternalVersion, options = {
     allowExistingDir: false,
 }) {
-    const { reactType: isReactModule } = moduleDefinition;
+    const { moduleLabel, contentTypes, global, reactType: isReactModule, } = moduleDefinition;
+    const moduleMetaData = {
+        label: moduleLabel,
+        css_assets: [],
+        external_js: [],
+        global: global,
+        help_text: '',
+        host_template_types: contentTypes,
+        js_assets: [],
+        other_assets: [],
+        smart_type: 'NOT_SMART',
+        tags: [],
+        is_available_for_new_content: false,
+    };
     const folderName = name.endsWith('.module') ? name : `${name}.module`;
     const destPath = !isReactModule
         ? path_1.default.join(dest, folderName)
@@ -136,34 +139,12 @@ async function createModule(moduleDefinition, name, dest, getInternalVersion, op
     logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.createModule.creatingModule`, {
         path: destPath,
     }));
-    // Write module meta
-    const writeModuleMeta = ({ moduleLabel, contentTypes, global, reactType }, dest) => {
-        const metaData = {
-            label: moduleLabel,
-            css_assets: [],
-            external_js: [],
-            global: global,
-            help_text: '',
-            host_template_types: contentTypes,
-            js_assets: [],
-            other_assets: [],
-            smart_type: 'NOT_SMART',
-            tags: [],
-            is_available_for_new_content: false,
-        };
-        if (!reactType) {
-            fs_extra_1.default.writeJSONSync(dest, metaData, { spaces: 2 });
-        }
-        else {
-            transformFileContents(`${dest}/index.tsx`, metaData, getInternalVersion);
-        }
-    };
-    // Filter out ceratin fetched files from the response
+    // Filter out certain fetched files from the response
     const moduleFileFilter = (src, dest) => {
         const emailEnabled = moduleDefinition.contentTypes.includes('EMAIL');
         switch (path_1.default.basename(src)) {
             case 'meta.json':
-                writeModuleMeta(moduleDefinition, dest);
+                fs_extra_1.default.writeJSONSync(dest, moduleMetaData, { spaces: 2 }); // writing a meta.json file to standard HubL modules
                 return false;
             case 'module.js':
             case 'module.css':
@@ -187,17 +168,17 @@ async function createModule(moduleDefinition, name, dest, getInternalVersion, op
         ? 'Sample.module'
         : 'SampleReactModule';
     await (0, github_1.downloadGithubRepoContents)('HubSpot/cms-sample-assets', `modules/${sampleAssetPath}`, destPath, '', moduleFileFilter);
-    // Mutating React module files after fetch
+    // Updating React module files after fetch
     if (isReactModule) {
-        writeModuleMeta(moduleDefinition, destPath);
+        await updateFileContents(`${destPath}/index.tsx`, moduleMetaData, getInternalVersion);
     }
 }
 exports.createModule = createModule;
 async function retrieveDefaultModule(name, dest) {
     if (!name) {
-        const defaultReactModules = await (0, github_1.listGithubRepoContents)('HubSpot/cms-sample-assets', 'modules/', 'dir');
+        const defaultReactModules = await (0, github_1.listGithubRepoContents)('HubSpot/cms-react', 'default-react-modules/src/components/modules/', 'dir');
         return defaultReactModules;
     }
-    await (0, github_1.downloadGithubRepoContents)('HubSpot/cms-sample-assets', `modules/${name}`, dest);
+    await (0, github_1.downloadGithubRepoContents)('HubSpot/cms-react', `default-react-modules/src/components/modules/${name}`, dest);
 }
 exports.retrieveDefaultModule = retrieveDefaultModule;

package/lib/cms/uploadFolder.d.ts

@@ -1,3 +1,4 @@
+import { AxiosError } from 'axios';
 import { FieldsJs } from './handleFieldsJS';
 import { FileMapperInputOptions } from '../../types/Files';
 import { UploadFolderResults } from '../../types/Files';
@@ -6,6 +7,11 @@ type CommandOptions = {
     convertFields?: boolean;
     fieldOptions?: string;
     saveOutput?: boolean;
+    onAttemptCallback?: (file: string | undefined, destPath: string) => void;
+    onSuccessCallback?: (file: string | undefined, destPath: string) => void;
+    onFirstErrorCallback?: (file: string, destPath: string, error: AxiosError) => void;
+    onRetryCallback?: (file: string, destPath: string) => void;
+    onFinalErrorCallback?: (accountId: number, file: string, destPath: string, error: AxiosError) => void;
 };
 type FilePathsByType = {
     [key: string]: Array<string>;

package/lib/cms/uploadFolder.js

@@ -10,7 +10,7 @@ const handleFieldsJS_1 = require("./handleFieldsJS");
 const fileMapper_1 = require("../fileMapper");
 const fileMapper_2 = require("../../api/fileMapper");
 const modules_1 = require("../../utils/cms/modules");
-const escapeRegExp_1 = require("../../utils/escapeRegExp");
+const escapeRegExp_1 = require("../escapeRegExp");
 const path_2 = require("../path");
 const standardErrors_1 = require("../../errors/standardErrors");
 const apiErrors_1 = require("../../errors/apiErrors");
@@ -76,8 +76,39 @@ async function getFilesByType(filePaths, projectDir, rootWriteDir, commandOption
     return [filePathsByType, fieldsJsObjects];
 }
 exports.getFilesByType = getFilesByType;
+const defaultUploadAttemptCallback = (file, destPath) => logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.uploadFolder.attempt`, {
+    file: file || '',
+    destPath,
+}));
+const defaultUploadSuccessCallback = (file, destPath) => logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.uploadFolder.success`, {
+    file: file || '',
+    destPath,
+}));
+const defaultUploadFirstErrorCallback = (file, destPath, error) => {
+    logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.uploadFolder.failed`, { file, destPath }));
+    if (error.response && error.response.data) {
+        logger_1.logger.debug(error.response.data);
+    }
+    else {
+        logger_1.logger.debug(error.message);
+    }
+};
+const defaultUploadRetryCallback = (file, destPath) => logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.uploadFolder.retry`, { file, destPath }));
+const defaultUploadFinalErrorCallback = (accountId, file, destPath, error) => {
+    logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.uploadFolder.retryFailed`, { file, destPath }));
+    (0, apiErrors_1.throwApiUploadError)(error, {
+        accountId,
+        request: destPath,
+        payload: file,
+    });
+};
 async function uploadFolder(accountId, src, dest, fileMapperOptions, commandOptions = {}, filePaths = [], mode = null) {
-    const { saveOutput, convertFields } = commandOptions;
+    const { saveOutput, convertFields, onAttemptCallback, onSuccessCallback, onFirstErrorCallback, onRetryCallback, onFinalErrorCallback } = commandOptions;
+    const _onAttemptCallback = onAttemptCallback || defaultUploadAttemptCallback;
+    const _onSuccessCallback = onSuccessCallback || defaultUploadSuccessCallback;
+    const _onFirstErrorCallback = onFirstErrorCallback || defaultUploadFirstErrorCallback;
+    const _onRetryCallback = onRetryCallback || defaultUploadRetryCallback;
+    const _onFinalErrorCallback = onFinalErrorCallback || defaultUploadFinalErrorCallback;
     const tmpDir = convertFields
         ? (0, handleFieldsJS_1.createTmpDirSync)('hubspot-temp-fieldsjs-output-')
         : null;
@@ -103,29 +134,17 @@ async function uploadFolder(accountId, src, dest, fileMapperOptions, commandOpti
         const relativePath = file.replace(fieldsJsFileInfo ? tmpDirRegex : regex, '');
         const destPath = (0, path_2.convertToUnixPath)(path_1.default.join(dest, relativePath));
         return async () => {
-            logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.uploadFolder.attempt`, {
-                file: originalFilePath || '',
-                destPath,
-            }));
+            _onAttemptCallback(originalFilePath, destPath);
             try {
                 await (0, fileMapper_2.upload)(accountId, file, destPath, apiOptions);
-                logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.uploadFolder.success`, {
-                    file: originalFilePath || '',
-                    destPath,
-                }));
+                _onSuccessCallback(originalFilePath, destPath);
             }
             catch (err) {
                 const error = err;
                 if ((0, standardErrors_1.isFatalError)(error)) {
                     throw error;
                 }
-                logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.uploadFolder.failed`, { file, destPath }));
-                if (error.response && error.response.data) {
-                    logger_1.logger.debug(error.response.data);
-                }
-                else {
-                    logger_1.logger.debug(error.message);
-                }
+                _onFirstErrorCallback(file, destPath, error);
                 failures.push({
                     file,
                     destPath,
@@ -140,13 +159,10 @@ async function uploadFolder(accountId, src, dest, fileMapperOptions, commandOpti
     const results = await queue
         .addAll(failures.map(({ file, destPath }) => {
         return async () => {
-            logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.uploadFolder.retry`, { file, destPath }));
+            _onRetryCallback(file, destPath);
             try {
                 await (0, fileMapper_2.upload)(accountId, file, destPath, apiOptions);
-                logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.uploadFolder.success`, {
-                    file,
-                    destPath,
-                }));
+                _onSuccessCallback(file, destPath);
                 return {
                     resultType: files_1.FILE_UPLOAD_RESULT_TYPES.SUCCESS,
                     error: null,
@@ -154,16 +170,16 @@ async function uploadFolder(accountId, src, dest, fileMapperOptions, commandOpti
                 };
             }
             catch (err) {
-                logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.uploadFolder.retryFailed`, { file, destPath }));
                 const error = err;
                 if ((0, standardErrors_1.isFatalError)(error)) {
                     throw error;
                 }
-                (0, apiErrors_1.throwApiUploadError)(error, {
-                    accountId,
-                    request: destPath,
-                    payload: file,
-                });
+                _onFinalErrorCallback(accountId, file, destPath, error);
+                return {
+                    resultType: files_1.FILE_UPLOAD_RESULT_TYPES.FAILURE,
+                    error,
+                    file,
+                };
             }
         };
     }))

package/lib/cms/watch.js

@@ -14,9 +14,9 @@ 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("../../utils/escapeRegExp");
+const escapeRegExp_1 = require("../escapeRegExp");
 const path_2 = require("../path");
-const notify_1 = require("../../utils/notify");
+const notify_1 = require("../notify");
 const themes_1 = require("./themes");
 const logger_1 = require("../logging/logger");
 const lang_1 = require("../../utils/lang");

package/lib/fileManager.js

@@ -12,7 +12,7 @@ const fs_1 = require("./fs");
 const logger_1 = require("./logging/logger");
 const ignoreRules_1 = require("./ignoreRules");
 const http_1 = __importDefault(require("../http"));
-const escapeRegExp_1 = require("../utils/escapeRegExp");
+const escapeRegExp_1 = require("./escapeRegExp");
 const path_2 = require("./path");
 const apiErrors_1 = require("../errors/apiErrors");
 const standardErrors_1 = require("../errors/standardErrors");

package/lib/personalAccessKey.d.ts

@@ -5,10 +5,16 @@ type AccessToken = {
     accessToken: string;
     expiresAt: string;
     scopeGroups: Array<string>;
+    enabledFeatures?: {
+        [key: string]: number;
+    };
     encodedOAuthRefreshToken: string;
     hubName: string;
 };
 export declare function getAccessToken(personalAccessKey: string, env?: Environment, accountId?: number): Promise<AccessToken>;
 export declare function accessTokenForPersonalAccessKey(accountId: number): Promise<string | undefined>;
+export declare function enabledFeaturesForPersonalAccessKey(accountId: number): Promise<{
+    [key: string]: number;
+} | undefined>;
 export declare function updateConfigWithAccessToken(token: AccessToken, personalAccessKey: string, env?: Environment, name?: string, makeDefault?: boolean): Promise<CLIAccount | null>;
 export {};

package/lib/personalAccessKey.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateConfigWithAccessToken = exports.accessTokenForPersonalAccessKey = exports.getAccessToken = void 0;
+exports.updateConfigWithAccessToken = exports.enabledFeaturesForPersonalAccessKey = exports.accessTokenForPersonalAccessKey = exports.getAccessToken = void 0;
 const moment_1 = __importDefault(require("moment"));
 const environments_1 = require("../constants/environments");
 const auth_1 = require("../constants/auth");
@@ -37,13 +37,15 @@ async function getAccessToken(personalAccessKey, env = environments_1.ENVIRONMEN
         accessToken: response.oauthAccessToken,
         expiresAt: (0, moment_1.default)(response.expiresAtMillis).toISOString(),
         scopeGroups: response.scopeGroups,
+        enabledFeatures: response.enabledFeatures,
         encodedOAuthRefreshToken: response.encodedOAuthRefreshToken,
         hubName: response.hubName,
     };
 }
 exports.getAccessToken = getAccessToken;
 async function refreshAccessToken(personalAccessKey, env = environments_1.ENVIRONMENTS.PROD, accountId) {
-    const { accessToken, expiresAt } = await getAccessToken(personalAccessKey, env, accountId);
+    const accessTokenResponse = await getAccessToken(personalAccessKey, env, accountId);
+    const { accessToken, expiresAt } = accessTokenResponse;
     const config = (0, config_1.getAccountConfig)(accountId);
     (0, config_1.updateAccountConfig)({
         env,
@@ -55,20 +57,20 @@ async function refreshAccessToken(personalAccessKey, env = environments_1.ENVIRO
         },
     });
     (0, config_1.writeConfig)();
-    return accessToken;
+    return accessTokenResponse;
 }
 async function getNewAccessToken(accountId, personalAccessKey, expiresAt, env) {
     const key = getRefreshKey(personalAccessKey, expiresAt);
     if (refreshRequests.has(key)) {
         return refreshRequests.get(key);
     }
-    let accessToken;
+    let accessTokenResponse;
     try {
         const refreshAccessPromise = refreshAccessToken(personalAccessKey, env, accountId);
         if (key) {
             refreshRequests.set(key, refreshAccessPromise);
         }
-        accessToken = await refreshAccessPromise;
+        accessTokenResponse = await refreshAccessPromise;
     }
     catch (e) {
         if (key) {
@@ -76,7 +78,7 @@ async function getNewAccessToken(accountId, personalAccessKey, expiresAt, env) {
         }
         throw e;
     }
-    return accessToken;
+    return accessTokenResponse;
 }
 async function accessTokenForPersonalAccessKey(accountId) {
     const account = (0, config_1.getAccountConfig)(accountId);
@@ -88,11 +90,22 @@ async function accessTokenForPersonalAccessKey(accountId) {
     const authDataExists = authTokenInfo && auth?.tokenInfo?.accessToken;
     if (!authDataExists ||
         (0, moment_1.default)().add(5, 'minutes').isAfter((0, moment_1.default)(authTokenInfo.expiresAt))) {
-        return getNewAccessToken(accountId, personalAccessKey, authTokenInfo && authTokenInfo.expiresAt, env);
+        return getNewAccessToken(accountId, personalAccessKey, authTokenInfo && authTokenInfo.expiresAt, env).then(tokenInfo => tokenInfo.accessToken);
     }
     return auth?.tokenInfo?.accessToken;
 }
 exports.accessTokenForPersonalAccessKey = accessTokenForPersonalAccessKey;
+async function enabledFeaturesForPersonalAccessKey(accountId) {
+    const account = (0, config_1.getAccountConfig)(accountId);
+    if (!account) {
+        (0, standardErrors_1.throwErrorWithMessage)(`${i18nKey}.errors.accountNotFound`, { accountId });
+    }
+    const { auth, personalAccessKey, env } = account;
+    const authTokenInfo = auth && auth.tokenInfo;
+    const accessTokenResponse = await getNewAccessToken(accountId, personalAccessKey, authTokenInfo && authTokenInfo.expiresAt, env);
+    return accessTokenResponse?.enabledFeatures;
+}
+exports.enabledFeaturesForPersonalAccessKey = enabledFeaturesForPersonalAccessKey;
 async function updateConfigWithAccessToken(token, personalAccessKey, env, name, makeDefault = false) {
     const { portalId, accessToken, expiresAt } = token;
     const accountEnv = env || (0, config_1.getEnv)(name);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/local-dev-lib",
-    "version": "0.3.4",
+    "version": "0.3.5",
     "description": "Provides library functionality for HubSpot local development tooling, including the HubSpot CLI",
     "main": "lib/index.js",
     "repository": {