@hubspot/local-dev-lib 0.6.1-experimental.0 → 0.6.3-experimental.0

package/lib/cms/modules.js

@@ -1,20 +1,14 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isModuleHTMLFile = exports.retrieveDefaultModule = exports.createModule = exports.validateSrcAndDestPaths = exports.ValidationIds = void 0;
-const path_1 = __importDefault(require("path"));
-const fs_extra_1 = __importDefault(require("fs-extra"));
-const path_2 = require("../path");
-const fs_1 = require("../fs");
-const github_1 = require("../github");
-const logger_1 = require("../logger");
-const modules_1 = require("../../utils/cms/modules");
-const lang_1 = require("../../utils/lang");
+import path from 'path';
+import fs from 'fs-extra';
+import { getCwd } from '../path.js';
+import { walk } from '../fs.js';
+import { listGithubRepoContents, cloneGithubRepo } from '../github.js';
+import { logger } from '../logger.js';
+import { isPathInput, isModuleFolder, isModuleFolderChild, } from '../../utils/cms/modules.js';
+import { i18n } from '../../utils/lang.js';
 const i18nKey = 'lib.cms.modules';
 // Ids for testing
-exports.ValidationIds = {
+export const ValidationIds = {
     SRC_REQUIRED: 'SRC_REQUIRED',
     DEST_REQUIRED: 'DEST_REQUIRED',
     MODULE_FOLDER_REQUIRED: 'MODULE_FOLDER_REQUIRED',
@@ -22,13 +16,13 @@ exports.ValidationIds = {
     MODULE_NESTING: 'MODULE_NESTING',
 };
 const getValidationResult = (id, message) => ({ id, message });
-async function validateSrcAndDestPaths(src, dest) {
+export async function validateSrcAndDestPaths(src, dest) {
     const results = [];
-    if (!(0, modules_1.isPathInput)(src)) {
-        results.push(getValidationResult(exports.ValidationIds.SRC_REQUIRED, '`src` is required.'));
+    if (!isPathInput(src)) {
+        results.push(getValidationResult(ValidationIds.SRC_REQUIRED, '`src` is required.'));
     }
-    if (!(0, modules_1.isPathInput)(dest)) {
-        results.push(getValidationResult(exports.ValidationIds.DEST_REQUIRED, '`dest` is required.'));
+    if (!isPathInput(dest)) {
+        results.push(getValidationResult(ValidationIds.DEST_REQUIRED, '`dest` is required.'));
     }
     if (results.length || !src || !dest) {
         return results;
@@ -36,37 +30,36 @@ async function validateSrcAndDestPaths(src, dest) {
     const [_src, _dest] = [src, dest].map(inputPath => {
         const result = { ...inputPath };
         if (result.isLocal) {
-            result.path = path_1.default.resolve((0, path_2.getCwd)(), result.path);
+            result.path = path.resolve(getCwd(), result.path);
         }
         else if (result.isHubSpot) {
-            result.path = path_1.default.posix.normalize(result.path);
+            result.path = path.posix.normalize(result.path);
         }
         return result;
     });
     // src is a .module folder and dest is within a module. (Nesting)
     // e.g. `upload foo.module bar.module/zzz`
-    if ((0, modules_1.isModuleFolder)(_src) && (0, modules_1.isModuleFolderChild)(_dest)) {
-        return results.concat(getValidationResult(exports.ValidationIds.MODULE_TO_MODULE_NESTING, '`src` is a module path and `dest` is within a module.'));
+    if (isModuleFolder(_src) && isModuleFolderChild(_dest)) {
+        return results.concat(getValidationResult(ValidationIds.MODULE_TO_MODULE_NESTING, '`src` is a module path and `dest` is within a module.'));
     }
     // src is a .module folder but dest is not
     // e.g. `upload foo.module bar`
-    if ((0, modules_1.isModuleFolder)(_src) && !(0, modules_1.isModuleFolder)(_dest)) {
-        return results.concat(getValidationResult(exports.ValidationIds.MODULE_FOLDER_REQUIRED, '`src` is a module path but `dest` is not.'));
+    if (isModuleFolder(_src) && !isModuleFolder(_dest)) {
+        return results.concat(getValidationResult(ValidationIds.MODULE_FOLDER_REQUIRED, '`src` is a module path but `dest` is not.'));
     }
     // src is a folder that includes modules and dest is within a module. (Nesting)
-    if (_src.isLocal && (0, modules_1.isModuleFolderChild)(_dest)) {
-        const stat = await fs_extra_1.default.stat(_src.path);
+    if (_src.isLocal && isModuleFolderChild(_dest)) {
+        const stat = await fs.stat(_src.path);
         if (stat.isDirectory()) {
-            const files = await (0, fs_1.walk)(_src.path);
-            const srcHasModulesChildren = files.some(file => (0, modules_1.isModuleFolderChild)({ ..._src, path: file }));
+            const files = await walk(_src.path);
+            const srcHasModulesChildren = files.some(file => isModuleFolderChild({ ..._src, path: file }));
             if (srcHasModulesChildren) {
-                return results.concat(getValidationResult(exports.ValidationIds.MODULE_NESTING, '`src` contains modules and `dest` is within a module.'));
+                return results.concat(getValidationResult(ValidationIds.MODULE_NESTING, '`src` contains modules and `dest` is within a module.'));
             }
         }
     }
     return results;
 }
-exports.validateSrcAndDestPaths = validateSrcAndDestPaths;
 /* createModule() helper
  * Takes a file and uses the constants above to transform the contents
  */
@@ -85,25 +78,25 @@ const MODULE_STRING_TRANSFORMATIONS = [
 ];
 const updateFileContents = async (file, metaData, getInternalVersion) => {
     try {
-        let fileContents = await fs_extra_1.default.readFile(file, 'utf8'); // returns Promise
+        let fileContents = await fs.readFile(file, 'utf8'); // returns Promise
         MODULE_STRING_TRANSFORMATIONS.forEach(entry => {
             const replacementString = getInternalVersion
                 ? entry.string
                 : entry.fallback;
             fileContents = fileContents.replace(entry.regex, replacementString);
         });
-        await fs_extra_1.default.writeFile(file, fileContents, 'utf8');
-        await fs_extra_1.default.appendFile(file, 'export const meta = ' + JSON.stringify(metaData, null, ' '));
+        await fs.writeFile(file, fileContents, 'utf8');
+        await fs.appendFile(file, 'export const meta = ' + JSON.stringify(metaData, null, ' '));
     }
     catch (error) {
         const { message } = error;
-        throw new Error((0, lang_1.i18n)(`${i18nKey}.createModule.errors.fileUpdateFailure`, {
+        throw new Error(i18n(`${i18nKey}.createModule.errors.fileUpdateFailure`, {
             path: file,
             errorMessage: message,
         }));
     }
 };
-async function createModule(moduleDefinition, name, dest, getInternalVersion, options = {
+export async function createModule(moduleDefinition, name, dest, getInternalVersion, options = {
     allowExistingDir: false,
 }) {
     const { moduleLabel, contentTypes, global, reactType: isReactModule, availableForNewContent, } = moduleDefinition;
@@ -122,26 +115,26 @@ async function createModule(moduleDefinition, name, dest, getInternalVersion, op
     };
     const folderName = name.endsWith('.module') ? name : `${name}.module`;
     const destPath = !isReactModule
-        ? path_1.default.join(dest, folderName)
-        : path_1.default.join(dest, `${name}`);
-    if (!options.allowExistingDir && fs_extra_1.default.existsSync(destPath)) {
-        throw new Error((0, lang_1.i18n)(`${i18nKey}.createModule.errors.pathExists`, {
+        ? path.join(dest, folderName)
+        : path.join(dest, `${name}`);
+    if (!options.allowExistingDir && fs.existsSync(destPath)) {
+        throw new Error(i18n(`${i18nKey}.createModule.errors.pathExists`, {
             path: destPath,
         }));
     }
     else {
-        logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.createModule.creatingPath`, {
+        logger.log(i18n(`${i18nKey}.createModule.creatingPath`, {
             path: destPath,
         }));
-        fs_extra_1.default.ensureDirSync(destPath);
+        fs.ensureDirSync(destPath);
     }
-    logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.createModule.creatingModule`, {
+    logger.log(i18n(`${i18nKey}.createModule.creatingModule`, {
         path: destPath,
     }));
     // Filter out certain fetched files from the response
     const moduleFileFilter = (src) => {
         const emailEnabled = moduleDefinition.contentTypes.includes('EMAIL');
-        switch (path_1.default.basename(src)) {
+        switch (path.basename(src)) {
             case 'meta.json':
                 return false;
             case 'module.js':
@@ -158,23 +151,23 @@ async function createModule(moduleDefinition, name, dest, getInternalVersion, op
         ? 'Sample.module'
         : 'SampleReactModule';
     const sourceDir = `modules/${sampleAssetPath}`;
-    await (0, github_1.cloneGithubRepo)('HubSpot/cms-sample-assets', destPath, {
+    await cloneGithubRepo('HubSpot/cms-sample-assets', destPath, {
         sourceDir,
     });
-    const files = await (0, fs_1.walk)(destPath);
+    const files = await walk(destPath);
     files
         .filter(filePath => !moduleFileFilter(filePath))
         .forEach(filePath => {
-        fs_extra_1.default.unlinkSync(filePath);
+        fs.unlinkSync(filePath);
     });
     if (!getInternalVersion) {
-        fs_extra_1.default.removeSync(path_1.default.join(destPath, 'stories'));
-        fs_extra_1.default.removeSync(path_1.default.join(destPath, 'tests'));
+        fs.removeSync(path.join(destPath, 'stories'));
+        fs.removeSync(path.join(destPath, 'tests'));
     }
     // Get and write the metafiles
-    const metaFiles = files.filter(filePath => path_1.default.basename(filePath) === 'meta.json');
+    const metaFiles = files.filter(filePath => path.basename(filePath) === 'meta.json');
     metaFiles.forEach(metaFile => {
-        fs_extra_1.default.writeJSONSync(metaFile, moduleMetaData, {
+        fs.writeJSONSync(metaFile, moduleMetaData, {
             spaces: 2,
         });
     });
@@ -183,19 +176,16 @@ async function createModule(moduleDefinition, name, dest, getInternalVersion, op
         await updateFileContents(`${destPath}/index.tsx`, moduleMetaData, getInternalVersion);
     }
 }
-exports.createModule = createModule;
-async function retrieveDefaultModule(name, dest) {
+export async function retrieveDefaultModule(name, dest) {
     if (!name) {
-        const defaultReactModules = await (0, github_1.listGithubRepoContents)('HubSpot/cms-react', 'default-react-modules/src/components/modules/', 'dir');
+        const defaultReactModules = await listGithubRepoContents('HubSpot/cms-react', 'default-react-modules/src/components/modules/', 'dir');
         return defaultReactModules;
     }
     if (dest) {
-        await (0, github_1.cloneGithubRepo)('HubSpot/cms-react', dest, {
+        await cloneGithubRepo('HubSpot/cms-react', dest, {
             sourceDir: `default-react-modules/src/components/modules/${name}`,
         });
     }
 }
-exports.retrieveDefaultModule = retrieveDefaultModule;
 const MODULE_HTML_EXTENSION_REGEX = new RegExp(/\.module(?:\/|\\)module\.html$/);
-const isModuleHTMLFile = (filePath) => MODULE_HTML_EXTENSION_REGEX.test(filePath);
-exports.isModuleHTMLFile = isModuleHTMLFile;
+export const isModuleHTMLFile = (filePath) => MODULE_HTML_EXTENSION_REGEX.test(filePath);

package/lib/cms/processFieldsJs.js

@@ -1,20 +1,13 @@
-"use strict";
 /* eslint-disable @typescript-eslint/no-explicit-any */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = __importDefault(require("path"));
-const fs_1 = __importDefault(require("fs"));
-const semver_1 = __importDefault(require("semver"));
-const url_1 = require("url");
-const path_2 = require("../path");
-const lang_1 = require("../../utils/lang");
+import path from 'path';
+import fs from 'fs';
+import { pathToFileURL } from 'url';
+import { i18n } from '../../utils/lang.js';
 const i18nKey = 'lib.cms.processFieldsJs';
 const { dirName, fieldOptions, filePath, writeDir } = process.env;
-const baseName = path_1.default.basename(filePath);
+const baseName = path.basename(filePath);
 //TODO - Figure out agnostic logging
-console.info((0, lang_1.i18n)(`${i18nKey}.converting`, {
+console.info(i18n(`${i18nKey}.converting`, {
     src: dirName + `/${baseName}`,
     dest: dirName + '/fields.json',
 }));
@@ -30,26 +23,26 @@ const fieldsPromise = dynamicImport(filePath).catch(e => {
 fieldsPromise.then(fieldsFunc => {
     const fieldsFuncType = typeof fieldsFunc;
     if (fieldsFuncType !== 'function') {
-        throw new Error((0, lang_1.i18n)(`${i18nKey}.errors.notFunction`, {
+        throw new Error(i18n(`${i18nKey}.errors.notFunction`, {
             path: filePath,
             returned: fieldsFuncType,
         }));
     }
     return Promise.resolve(fieldsFunc(fieldOptions)).then(fields => {
         if (!Array.isArray(fields)) {
-            throw new Error((0, lang_1.i18n)(`${i18nKey}.errors.notArray`, {
+            throw new Error(i18n(`${i18nKey}.errors.notArray`, {
                 path: filePath,
                 returned: typeof fields,
             }));
         }
-        const finalPath = path_1.default.join(writeDir, '/fields.json');
+        const finalPath = path.join(writeDir, '/fields.json');
         return fieldsArrayToJson(fields).then(json => {
-            if (!fs_1.default.existsSync(writeDir)) {
-                fs_1.default.mkdirSync(writeDir, { recursive: true });
+            if (!fs.existsSync(writeDir)) {
+                fs.mkdirSync(writeDir, { recursive: true });
             }
-            fs_1.default.writeFileSync(finalPath, json);
+            fs.writeFileSync(finalPath, json);
             //TODO - Figure out agnostic logging
-            console.log((0, lang_1.i18n)(`${i18nKey}.converted`, {
+            console.log(i18n(`${i18nKey}.converted`, {
                 src: dirName + `/${baseName}`,
                 dest: dirName + '/fields.json',
             }));
@@ -79,19 +72,11 @@ async function fieldsArrayToJson(fields) {
     return JSON.stringify(jsonFields, null, 2);
 }
 /**
- * Takes in a path to a javascript file and either dynamically imports it or requires it, and returns, depending on node version.
+ * Takes in a path to a javascript file and dynamically imports it.
  * @param {string} filePath - Path to javascript file
- * @returns {Promise | undefined} - Returns _default_ exported content if ESM, or exported module content if CJS, or undefined if node version < 13.2 and file is .mjs.
+ * @returns {Promise} - Returns _default_ exported content if ESM, or exported module content if CJS.
  */
 async function dynamicImport(filePath) {
-    if (semver_1.default.gte(process.version, '13.2.0')) {
-        const exported = await new Function(`return import("${(0, url_1.pathToFileURL)(filePath)}")`)();
-        return exported.default;
-    }
-    else {
-        if ((0, path_2.getExt)(filePath) == 'mjs') {
-            throw new Error((0, lang_1.i18n)(`${i18nKey}.errors.invalidMjsFile`));
-        }
-        return require(filePath);
-    }
+    const exported = await import(pathToFileURL(filePath).href);
+    return exported.default || exported;
 }

package/lib/cms/templates.js

@@ -1,20 +1,14 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TEMPLATE_TYPES = exports.createTemplate = exports.isCodedFile = exports.getAnnotationValue = exports.ANNOTATION_KEYS = void 0;
-const fs_extra_1 = __importDefault(require("fs-extra"));
-const path_1 = __importDefault(require("path"));
-const github_1 = require("../github");
-const logger_1 = require("../logger");
-const lang_1 = require("../../utils/lang");
+import fs from 'fs-extra';
+import path from 'path';
+import { cloneGithubRepo } from '../github.js';
+import { logger } from '../logger.js';
+import { i18n } from '../../utils/lang.js';
 const i18nKey = 'lib.cms.templates';
 // Matches the .html file extension, excluding module.html
 const TEMPLATE_EXTENSION_REGEX = new RegExp(/(?<!module)\.html$/);
 // Matches an annotation value, ending at space, newline, or end of string
 const ANNOTATION_VALUE_REGEX = ':\\s?([\\S|\\s]*?)(\n|$)';
-exports.ANNOTATION_KEYS = {
+export const ANNOTATION_KEYS = {
     isAvailableForNewContent: 'isAvailableForNewContent',
     templateType: 'templateType',
     label: 'label',
@@ -22,20 +16,18 @@ exports.ANNOTATION_KEYS = {
     // 'description' is specific to Sections
     description: 'description',
 };
-function getAnnotationValue(annotations, key) {
+export function getAnnotationValue(annotations, key) {
     const valueRegex = new RegExp(`${key}${ANNOTATION_VALUE_REGEX}`);
     const match = annotations.match(valueRegex);
     return match ? match[1].trim() : null;
 }
-exports.getAnnotationValue = getAnnotationValue;
 /*
  * Returns true if:
  * .html extension (ignoring module.html)
  */
-function isCodedFile(filePath) {
+export function isCodedFile(filePath) {
     return TEMPLATE_EXTENSION_REGEX.test(filePath);
 }
-exports.isCodedFile = isCodedFile;
 const ASSET_PATHS = {
     'page-template': 'templates/page-template.html',
     partial: 'templates/partial.html',
@@ -46,26 +38,25 @@ const ASSET_PATHS = {
     'search-template': 'templates/search-template.html',
     section: 'templates/section.html',
 };
-async function createTemplate(name, dest, type = 'page-template', options = { allowExisting: false }) {
+export async function createTemplate(name, dest, type = 'page-template', options = { allowExisting: false }) {
     const assetPath = ASSET_PATHS[type];
     const filename = name.endsWith('.html') ? name : `${name}.html`;
-    const filePath = path_1.default.join(dest, filename);
-    if (!options.allowExisting && fs_extra_1.default.existsSync(filePath)) {
-        throw new Error((0, lang_1.i18n)(`${i18nKey}.createTemplate.errors.pathExists`, {
+    const filePath = path.join(dest, filename);
+    if (!options.allowExisting && fs.existsSync(filePath)) {
+        throw new Error(i18n(`${i18nKey}.createTemplate.errors.pathExists`, {
             path: filePath,
         }));
     }
-    logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.createTemplate.creatingPath`, { path: dest }));
-    fs_extra_1.default.mkdirp(dest);
-    logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.createTemplate.creatingFile`, {
+    logger.debug(i18n(`${i18nKey}.createTemplate.creatingPath`, { path: dest }));
+    fs.mkdirp(dest);
+    logger.log(i18n(`${i18nKey}.createTemplate.creatingFile`, {
         path: filePath,
     }));
-    await (0, github_1.cloneGithubRepo)('HubSpot/cms-sample-assets', filePath, {
+    await cloneGithubRepo('HubSpot/cms-sample-assets', filePath, {
         sourceDir: assetPath,
     });
 }
-exports.createTemplate = createTemplate;
-exports.TEMPLATE_TYPES = {
+export const TEMPLATE_TYPES = {
     unmapped: 0,
     email_base_template: 1,
     email: 2,

package/lib/cms/themes.js

@@ -1,20 +1,13 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getThemePreviewUrl = exports.getThemeJSONPath = void 0;
-const findup_sync_1 = __importDefault(require("findup-sync"));
-const urls_1 = require("../urls");
-const environments_1 = require("../../constants/environments");
-const config_1 = require("../../config");
-function getThemeJSONPath(path) {
-    return (0, findup_sync_1.default)('theme.json', {
+import findup from 'findup-sync';
+import { getHubSpotWebsiteOrigin } from '../urls.js';
+import { ENVIRONMENTS } from '../../constants/environments.js';
+import { getConfigAccountEnvironment } from '../../config/index.js';
+export function getThemeJSONPath(path) {
+    return findup('theme.json', {
         cwd: path,
         nocase: true,
     });
 }
-exports.getThemeJSONPath = getThemeJSONPath;
 function getThemeNameFromPath(filePath) {
     const themeJSONPath = getThemeJSONPath(filePath);
     if (!themeJSONPath)
@@ -24,13 +17,12 @@ function getThemeNameFromPath(filePath) {
         return;
     return pathParts[pathParts.length - 2];
 }
-function getThemePreviewUrl(filePath, accountId) {
+export function getThemePreviewUrl(filePath, accountId) {
     const themeName = getThemeNameFromPath(filePath);
     if (!themeName)
         return;
-    const baseUrl = (0, urls_1.getHubSpotWebsiteOrigin)((0, config_1.getConfigAccountEnvironment)(accountId) === 'qa'
-        ? environments_1.ENVIRONMENTS.QA
-        : environments_1.ENVIRONMENTS.PROD);
+    const baseUrl = getHubSpotWebsiteOrigin(getConfigAccountEnvironment(accountId) === 'qa'
+        ? ENVIRONMENTS.QA
+        : ENVIRONMENTS.PROD);
     return `${baseUrl}/theme-previewer/${accountId}/edit/${encodeURIComponent(themeName)}`;
 }
-exports.getThemePreviewUrl = getThemePreviewUrl;

package/lib/cms/uploadFolder.d.ts

@@ -1,7 +1,7 @@
-import { FieldsJs } from './handleFieldsJS';
-import { FileMapperInputOptions } from '../../types/Files';
-import { UploadFolderResults, CommandOptions, FilePathsByType } from '../../types/Files';
-import { CmsPublishMode } from '../../types/Files';
+import { FieldsJs } from './handleFieldsJS.js';
+import { FileMapperInputOptions } from '../../types/Files.js';
+import { UploadFolderResults, CommandOptions, FilePathsByType } from '../../types/Files.js';
+import { CmsPublishMode } from '../../types/Files.js';
 export declare function getFilesByType(filePaths: Array<string>, projectDir: string, rootWriteDir: string | null, commandOptions: CommandOptions): Promise<[FilePathsByType, Array<FieldsJs>]>;
 export declare function uploadFolder(accountId: number, src: string, dest: string, fileMapperOptions: FileMapperInputOptions, commandOptions?: CommandOptions, filePaths?: Array<string>, cmsPublishMode?: CmsPublishMode | null): Promise<Array<UploadFolderResults>>;
 export declare function hasUploadErrors(results: Array<UploadFolderResults>): boolean;