@hubspot/project-parsing-lib 0.6.1 → 0.8.0-beta.0

package/package.json

@@ -1,11 +1,11 @@
 {
     "name": "@hubspot/project-parsing-lib",
-    "version": "0.6.1",
+    "version": "0.8.0-beta.0",
     "description": "Parsing library for converting projects directory structures to their intermediate representation",
     "license": "Apache-2.0",
     "main": "src/index.js",
     "devDependencies": {
-        "@hubspot/local-dev-lib": "^3.16.0",
+        "@hubspot/local-dev-lib": "^3.17.0",
         "@inquirer/prompts": "^7.1.0",
         "@types/jest": "^29.5.14",
         "@types/semver": "^7.5.8",

package/src/index.d.ts

@@ -16,3 +16,4 @@ export { metafileExtension, hsProjectJsonFilename } from './lib/constants';
 export { Components } from './lib/types';
 export { AjvErrorKeyword } from './lib/errors';
 export { getInvalidJsonError, getMissingTypeError, getMissingConfigError, getMissingAccountIdError, getMissingRequiredFieldError, getFailedToFetchSchemasError, getUnsupportedTypeError, } from './lang/copy';
+export { migrateThemes, getProjectThemeDetails } from './lib/migrateThemes';

package/src/index.js

@@ -3,14 +3,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getUnsupportedTypeError = exports.getFailedToFetchSchemasError = exports.getMissingRequiredFieldError = exports.getMissingAccountIdError = exports.getMissingConfigError = exports.getMissingTypeError = exports.getInvalidJsonError = exports.AjvErrorKeyword = exports.hsProjectJsonFilename = exports.metafileExtension = exports.createAjvInstance = exports.getIntermediateRepresentationSchema = exports.mapToInternalType = exports.mapToUserFriendlyName = exports.validateUid = exports.migrate = exports.projectContainsHsMetaFiles = exports.getAllHsProfiles = exports.loadHsProfileFile = exports.getHsProfileFilename = exports.isTranslationError = void 0;
+exports.getProjectThemeDetails = exports.migrateThemes = exports.getUnsupportedTypeError = exports.getFailedToFetchSchemasError = exports.getMissingRequiredFieldError = exports.getMissingAccountIdError = exports.getMissingConfigError = exports.getMissingTypeError = exports.getInvalidJsonError = exports.AjvErrorKeyword = exports.hsProjectJsonFilename = exports.metafileExtension = exports.createAjvInstance = exports.getIntermediateRepresentationSchema = exports.mapToInternalType = exports.mapToUserFriendlyName = exports.validateUid = exports.migrate = exports.projectContainsHsMetaFiles = exports.getAllHsProfiles = exports.loadHsProfileFile = exports.getHsProfileFilename = exports.isTranslationError = void 0;
 exports.translate = translate;
 exports.translateForLocalDev = translateForLocalDev;
+const isDeepEqual_1 = require("@hubspot/local-dev-lib/isDeepEqual");
 const files_1 = require("./lib/files");
 const validation_1 = require("./lib/validation");
 const transform_1 = require("./lib/transform");
 const copy_1 = require("./lang/copy");
-const utils_1 = require("./lib/utils");
 const path_1 = __importDefault(require("path"));
 const defaultOptions = {
     skipValidation: false,
@@ -49,7 +49,7 @@ async function translateForLocalDev(translationContext, translationOptions) {
         if (translationOptions?.projectNodesAtLastUpload) {
             const componentAtLastUpload = translationOptions.projectNodesAtLastUpload[uid];
             if (componentAtLastUpload) {
-                configUpdatedSinceLastUpload = !(0, utils_1.isDeepEqual)(component.config, componentAtLastUpload.config);
+                configUpdatedSinceLastUpload = !(0, isDeepEqual_1.isDeepEqual)(component.config, componentAtLastUpload.config);
             }
             else {
                 // Component is net new
@@ -104,3 +104,6 @@ Object.defineProperty(exports, "getMissingAccountIdError", { enumerable: true, g
 Object.defineProperty(exports, "getMissingRequiredFieldError", { enumerable: true, get: function () { return copy_2.getMissingRequiredFieldError; } });
 Object.defineProperty(exports, "getFailedToFetchSchemasError", { enumerable: true, get: function () { return copy_2.getFailedToFetchSchemasError; } });
 Object.defineProperty(exports, "getUnsupportedTypeError", { enumerable: true, get: function () { return copy_2.getUnsupportedTypeError; } });
+var migrateThemes_1 = require("./lib/migrateThemes");
+Object.defineProperty(exports, "migrateThemes", { enumerable: true, get: function () { return migrateThemes_1.migrateThemes; } });
+Object.defineProperty(exports, "getProjectThemeDetails", { enumerable: true, get: function () { return migrateThemes_1.getProjectThemeDetails; } });

package/src/lib/constants.d.ts

@@ -3,7 +3,7 @@ export declare const ThemeKey = "theme";
 export declare const ReactThemeKey = "react-theme";
 export declare const AppEventsKey = "app-event";
 export declare const AppFunctionsKey = "app-function";
-export declare const AppHomeKey = "home";
+export declare const PagesKey = "page";
 export declare const AppObjectKey = "app-object";
 export declare const AppObjectAssociationKey = "app-object-association";
 export declare const CallingKey = "calling";

package/src/lib/constants.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.allowedSubComponentDirectories = exports.allowedComponentDirectories = exports.ProjectStructure = exports.allowedReactThemeSubComponentsDirs = exports.allowedThemeSubComponentsDirs = exports.allowedAppSubComponentsDirs = exports.packageLockJson = exports.packageJson = exports.hsProjectJsonFilename = exports.profileFilePrefix = exports.metafileExtension = exports.internalTypeToUserFacing = exports.userFacingToInternalType = exports.Components = exports.AutoGeneratedComponentTypes = exports.AppFunctionsPackageKey = exports.WorkflowActionsKey = exports.WebhooksKey = exports.VideoConferencingKey = exports.TelemetryKey = exports.SettingsKey = exports.MediaBridgeKey = exports.MCPRegistryKey = exports.MarketingEventsKey = exports.SCIMKey = exports.CardsKey = exports.CallingKey = exports.AppObjectAssociationKey = exports.AppObjectKey = exports.AppHomeKey = exports.AppFunctionsKey = exports.AppEventsKey = exports.ReactThemeKey = exports.ThemeKey = exports.AppKey = void 0;
+exports.allowedSubComponentDirectories = exports.allowedComponentDirectories = exports.ProjectStructure = exports.allowedReactThemeSubComponentsDirs = exports.allowedThemeSubComponentsDirs = exports.allowedAppSubComponentsDirs = exports.packageLockJson = exports.packageJson = exports.hsProjectJsonFilename = exports.profileFilePrefix = exports.metafileExtension = exports.internalTypeToUserFacing = exports.userFacingToInternalType = exports.Components = exports.AutoGeneratedComponentTypes = exports.AppFunctionsPackageKey = exports.WorkflowActionsKey = exports.WebhooksKey = exports.VideoConferencingKey = exports.TelemetryKey = exports.SettingsKey = exports.MediaBridgeKey = exports.MCPRegistryKey = exports.MarketingEventsKey = exports.SCIMKey = exports.CardsKey = exports.CallingKey = exports.AppObjectAssociationKey = exports.AppObjectKey = exports.PagesKey = exports.AppFunctionsKey = exports.AppEventsKey = exports.ReactThemeKey = exports.ThemeKey = exports.AppKey = void 0;
 // Top Level Component types
 const path = __importStar(require("path"));
 // Component types
@@ -43,7 +43,7 @@ exports.ReactThemeKey = 'react-theme';
 // Sub-Component types
 exports.AppEventsKey = 'app-event';
 exports.AppFunctionsKey = 'app-function';
-exports.AppHomeKey = 'home';
+exports.PagesKey = 'page';
 exports.AppObjectKey = 'app-object';
 exports.AppObjectAssociationKey = 'app-object-association';
 exports.CallingKey = 'calling';
@@ -89,11 +89,11 @@ exports.Components = {
         ...SubComponentFields,
         userFriendlyName: 'App Object Association',
     },
-    [exports.AppHomeKey]: {
-        dir: exports.AppHomeKey,
+    [exports.PagesKey]: {
+        dir: 'pages',
         parentComponent: exports.AppKey,
         ...SubComponentFields,
-        userFriendlyName: 'App Home',
+        userFriendlyName: 'Page',
         singularComponent: true,
     },
     [exports.ThemeKey]: {

package/src/lib/migrate.js

@@ -10,6 +10,7 @@ const fs_2 = __importDefault(require("fs"));
 const transform_1 = require("./transform");
 const constants_1 = require("./constants");
 const index_1 = require("../index");
+const utils_1 = require("./utils");
 const IR_FILENAME = 'ir.json';
 const filesDirectory = 'files';
 const OUTPUT_IR_FILE = 'FULL_IR.json';
@@ -23,7 +24,7 @@ async function migrate(inputDir, outputDir) {
     }
     let hsProjectJson;
     try {
-        hsProjectJson = loadJsonFile(hsProjectJsonPath);
+        hsProjectJson = (0, utils_1.loadJsonFile)(hsProjectJsonPath);
     }
     catch (e) {
         throw new Error(`Error parsing ${constants_1.hsProjectJsonFilename}: ${e}`);
@@ -38,7 +39,7 @@ async function migrate(inputDir, outputDir) {
             return;
         }
         const irDirName = path_1.default.dirname(filename);
-        const IR = loadJsonFile(filename);
+        const IR = (0, utils_1.loadJsonFile)(filename);
         const { metaFilePath } = IR;
         const projectConfig = convertIRToProjectConfig(IR);
         const fullOutputPath = path_1.default.join(sourceCodeOutputDir, getTargetDirectoryFromComponentType(projectConfig.type));
@@ -71,11 +72,6 @@ function isIRFile(filename) {
     const { base } = path_1.default.parse(filename);
     return base.toLowerCase() === IR_FILENAME;
 }
-function loadJsonFile(filename) {
-    return JSON.parse(fs_2.default.readFileSync(filename, {
-        encoding: 'utf-8',
-    }));
-}
 function convertIRToProjectConfig(IR) {
     const { config, uid, componentType } = IR;
     return {

package/src/lib/migrateThemes.d.ts

@@ -0,0 +1,25 @@
+type ThemeDetails = {
+    configFilepath: string;
+    themePath: string;
+    themeConfig: {
+        secret_names?: string[];
+    };
+};
+type ReactThemeDetails = {
+    configFilepath: string;
+    themePath: string;
+    themeConfig: {
+        secretNames?: string[];
+    };
+};
+type ProjectThemeDetails = {
+    legacyThemeDetails: ThemeDetails[];
+    legacyReactThemeDetails: ReactThemeDetails[];
+};
+export declare function getProjectThemeDetails(projectSourceDir: string): Promise<ProjectThemeDetails>;
+export declare function migrateThemes(projectDir: string, projectSourceDir: string): Promise<{
+    legacyThemeDetails: ThemeDetails[];
+    legacyReactThemeDetails: ReactThemeDetails[];
+    migrated: boolean;
+}>;
+export {};

package/src/lib/migrateThemes.js

@@ -0,0 +1,113 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProjectThemeDetails = getProjectThemeDetails;
+exports.migrateThemes = migrateThemes;
+const fs_1 = __importDefault(require("fs"));
+const os_1 = __importDefault(require("os"));
+const path_1 = __importDefault(require("path"));
+const util_1 = require("util");
+const fs_2 = require("@hubspot/local-dev-lib/fs");
+const constants_1 = require("./constants");
+const utils_1 = require("./utils");
+const mkdtempAsync = (0, util_1.promisify)(fs_1.default.mkdtemp);
+const LEGACY_THEME_CONFIG = 'theme.json';
+const LEGACY_REACT_THEME_CONFIG = 'cms-assets.json';
+async function getProjectThemeDetails(projectSourceDir) {
+    const files = await (0, fs_2.walk)(projectSourceDir, ['node_modules']);
+    const legacyThemeDetails = [];
+    const legacyReactThemeDetails = [];
+    files.forEach((filename) => {
+        const isLegacyThemeConfig = filename.endsWith(LEGACY_THEME_CONFIG);
+        const isLegacyReactThemeConfig = filename.endsWith(LEGACY_REACT_THEME_CONFIG);
+        if (isLegacyThemeConfig || isLegacyReactThemeConfig) {
+            const parsedConfig = (0, utils_1.loadJsonFile)(filename);
+            const themeDetails = {
+                configFilepath: filename,
+                themePath: path_1.default.dirname(filename),
+                themeConfig: parsedConfig,
+            };
+            if (isLegacyThemeConfig) {
+                legacyThemeDetails.push(themeDetails);
+            }
+            else {
+                legacyReactThemeDetails.push(themeDetails);
+            }
+        }
+    });
+    return {
+        legacyThemeDetails,
+        legacyReactThemeDetails,
+    };
+}
+function buildNewTheme(componentKey, migratedProjectTempDir, themeDetails) {
+    const themeName = path_1.default.basename(themeDetails.themePath);
+    const componentDir = path_1.default.join(migratedProjectTempDir, componentKey);
+    const newThemeDir = path_1.default.join(componentDir, themeName);
+    fs_1.default.cpSync(themeDetails.themePath, newThemeDir, {
+        recursive: true,
+    });
+    const newThemeConfig = {
+        uid: themeName,
+        type: componentKey,
+        config: {
+            themePath: themeName,
+            secretNames: [],
+        },
+    };
+    // Remove secrets from the legacy theme config if they exist & move them to the new theme config
+    let updatedLegacyThemeConfig;
+    if ('secret_names' in themeDetails.themeConfig) {
+        const { secret_names, ...configWithoutSecrets } = themeDetails.themeConfig;
+        if (secret_names) {
+            newThemeConfig.config.secretNames = secret_names;
+            updatedLegacyThemeConfig = configWithoutSecrets;
+        }
+    }
+    else if ('secretNames' in themeDetails.themeConfig) {
+        const { secretNames, ...configWithoutSecrets } = themeDetails.themeConfig;
+        if (secretNames) {
+            newThemeConfig.config.secretNames = secretNames;
+            updatedLegacyThemeConfig = configWithoutSecrets;
+        }
+    }
+    if (updatedLegacyThemeConfig) {
+        const newLegacyConfigFilepath = path_1.default.join(newThemeDir, path_1.default.basename(themeDetails.configFilepath));
+        fs_1.default.writeFileSync(newLegacyConfigFilepath, JSON.stringify(updatedLegacyThemeConfig, null, 2));
+    }
+    fs_1.default.writeFileSync(path_1.default.join(componentDir, `${themeName}${constants_1.metafileExtension}`), JSON.stringify(newThemeConfig, null, 2));
+}
+async function migrateThemes(projectDir, projectSourceDir) {
+    const { legacyThemeDetails, legacyReactThemeDetails, } = await getProjectThemeDetails(projectSourceDir);
+    // Migrate the project to a temporary directory to avoid file conflicts in the original project
+    const migratedProjectTempDir = await mkdtempAsync(path_1.default.join(os_1.default.tmpdir(), 'hubspot-migrated-project-'));
+    legacyThemeDetails.forEach(themeDetails => {
+        buildNewTheme(constants_1.ThemeKey, migratedProjectTempDir, themeDetails);
+    });
+    legacyReactThemeDetails.forEach(themeDetails => {
+        buildNewTheme(constants_1.ReactThemeKey, migratedProjectTempDir, themeDetails);
+    });
+    // Copy the rest of the project files to the temp directory
+    fs_1.default.cpSync(projectSourceDir, migratedProjectTempDir, {
+        recursive: true,
+        filter: src => {
+            return (!legacyThemeDetails.some(file => src.includes(file.themePath)) &&
+                !legacyReactThemeDetails.some(file => src.includes(file.themePath)));
+        },
+    });
+    // Archive the legacy theme files
+    const archiveDest = path_1.default.join(projectDir, 'archive');
+    fs_1.default.renameSync(projectSourceDir, archiveDest);
+    // Copy the new theme config files to the project source directory
+    fs_1.default.cpSync(migratedProjectTempDir, projectSourceDir, {
+        recursive: true,
+    });
+    fs_1.default.rmSync(migratedProjectTempDir, { recursive: true });
+    return {
+        legacyThemeDetails,
+        legacyReactThemeDetails,
+        migrated: true,
+    };
+}

package/src/lib/utils.d.ts

@@ -1 +1 @@
-export declare function isDeepEqual(object1: unknown, object2: unknown): boolean;
+export declare function loadJsonFile(filename: string): any;

package/src/lib/utils.js

@@ -1,29 +1,12 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isDeepEqual = isDeepEqual;
-function isDeepEqual(object1, object2) {
-    if (object1 === object2) {
-        return true;
-    }
-    if (object1 === null ||
-        object2 === null ||
-        typeof object1 !== 'object' ||
-        typeof object2 !== 'object') {
-        return object1 === object2;
-    }
-    if (typeof object1 !== typeof object2) {
-        return false;
-    }
-    const objKeys1 = Object.keys(object1);
-    const objKeys2 = Object.keys(object2);
-    if (objKeys1.length !== objKeys2.length)
-        return false;
-    for (const key of objKeys1) {
-        const value1 = object1[key];
-        const value2 = object2[key];
-        if (!isDeepEqual(value1, value2)) {
-            return false;
-        }
-    }
-    return true;
+exports.loadJsonFile = loadJsonFile;
+const fs_1 = __importDefault(require("fs"));
+function loadJsonFile(filename) {
+    return JSON.parse(fs_1.default.readFileSync(filename, {
+        encoding: 'utf-8',
+    }));
 }