@hubspot/project-parsing-lib 0.8.6-beta.0 → 0.9.0-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/project-parsing-lib",
-    "version": "0.8.6-beta.0",
+    "version": "0.9.0-beta.0",
     "description": "Parsing library for converting projects directory structures to their intermediate representation",
     "license": "Apache-2.0",
     "main": "src/index.js",

package/src/index.js

@@ -1,17 +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.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.coerceToValidUid = 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 path_1 = __importDefault(require("path"));
+const localDev_1 = require("./lib/localDev");
 const defaultOptions = {
     skipValidation: false,
 };
@@ -34,43 +30,30 @@ async function translate(translationContext, translationOptions = defaultOptions
     return intermediateRepresentation;
 }
 async function translateForLocalDev(translationContext, translationOptions) {
-    const IR = await translate(translationContext, {
-        skipValidation: true,
-        profile: translationOptions?.profile,
-    });
-    const localDevIr = {
-        intermediateNodesIndexedByUid: {},
-        profileData: {},
-    };
-    Object.entries(IR.intermediateNodesIndexedByUid).forEach(([uid, node]) => {
-        const component = IR.intermediateNodesIndexedByUid[uid];
-        const componentConfigPath = path_1.default.join(translationContext.projectSourceDir, component.metaFilePath);
-        let configUpdatedSinceLastUpload = false;
-        if (translationOptions?.projectNodesAtLastUpload) {
-            const componentAtLastUpload = translationOptions.projectNodesAtLastUpload[uid];
-            if (componentAtLastUpload) {
-                configUpdatedSinceLastUpload = !(0, isDeepEqual_1.isDeepEqual)(component.config, componentAtLastUpload.config);
-            }
-            else {
-                // Component is net new
-                configUpdatedSinceLastUpload = true;
-            }
-        }
-        localDevIr.intermediateNodesIndexedByUid[uid] = {
-            ...node,
-            localDev: {
-                componentRoot: path_1.default.dirname(componentConfigPath),
-                componentConfigPath,
-                configUpdatedSinceLastUpload,
-            },
-        };
-    });
-    if (IR.profileData?.vars.profileVariables) {
-        Object.entries(IR.profileData.vars.profileVariables).forEach(([key, value]) => {
-            localDevIr.profileData[key] = value.value;
-        });
+    const metafileContents = await (0, files_1.loadHsMetaFiles)(translationContext);
+    if (metafileContents.length === 0) {
+        throw new Error(copy_1.errorMessages.project.noHsMetaFiles);
     }
-    return localDevIr;
+    let hsProfileContents;
+    if (translationOptions?.profile) {
+        hsProfileContents = (0, files_1.loadHsProfileFile)(translationContext.projectSourceDir, translationOptions.profile);
+    }
+    const transformation = (0, transform_1.transform)(metafileContents, translationContext, hsProfileContents);
+    const baseIntermediateRepresentation = (0, transform_1.getIntermediateRepresentation)(transformation, hsProfileContents, true);
+    const parsingErrors = (0, transform_1.getParsingErrors)(transformation);
+    const projectNodes = (0, localDev_1.getLocalDevProjectNodes)(baseIntermediateRepresentation.intermediateNodesIndexedByUid, translationContext.projectSourceDir, translationOptions?.projectNodesAtLastUpload);
+    let projectNodesWithErrors = {};
+    if (translationOptions?.projectNodesAtLastUpload) {
+        projectNodesWithErrors = (0, localDev_1.getRemovedNodesAndNodesWithErrors)(baseIntermediateRepresentation.intermediateNodesIndexedByUid, translationOptions.projectNodesAtLastUpload, parsingErrors);
+    }
+    const profileData = (0, localDev_1.getLocalDevProfileData)(baseIntermediateRepresentation.profileData?.vars.profileVariables);
+    return {
+        intermediateNodesIndexedByUid: {
+            ...projectNodes,
+            ...projectNodesWithErrors,
+        },
+        profileData,
+    };
 }
 var errors_1 = require("./lib/errors");
 Object.defineProperty(exports, "isTranslationError", { enumerable: true, get: function () { return errors_1.isTranslationError; } });

package/src/lib/localDev.d.ts

@@ -0,0 +1,4 @@
+import { BEProfileVariables, HSProfileVariables, IntermediateRepresentationNode, IntermediateRepresentationNodeLocalDev, FileParseResult } from './types';
+export declare function getLocalDevProjectNodes(intermediateNodesIndexedByUid: Record<string, IntermediateRepresentationNode>, projectSourceDir: string, projectNodesAtLastUpload?: Record<string, IntermediateRepresentationNodeLocalDev>): Record<string, IntermediateRepresentationNodeLocalDev>;
+export declare function getRemovedNodesAndNodesWithErrors(intermediateNodesIndexedByUid: Record<string, IntermediateRepresentationNode>, projectNodesAtLastUpload: Record<string, IntermediateRepresentationNodeLocalDev>, parsingErrors: FileParseResult[]): Record<string, IntermediateRepresentationNodeLocalDev>;
+export declare function getLocalDevProfileData(profileVariables?: BEProfileVariables): HSProfileVariables;

package/src/lib/localDev.js

@@ -0,0 +1,80 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLocalDevProjectNodes = getLocalDevProjectNodes;
+exports.getRemovedNodesAndNodesWithErrors = getRemovedNodesAndNodesWithErrors;
+exports.getLocalDevProfileData = getLocalDevProfileData;
+const path_1 = __importDefault(require("path"));
+const isDeepEqual_1 = require("@hubspot/local-dev-lib/isDeepEqual");
+function getLocalDevProjectNodes(intermediateNodesIndexedByUid, projectSourceDir, projectNodesAtLastUpload) {
+    const localDevProjectNodes = {};
+    Object.entries(intermediateNodesIndexedByUid).forEach(([uid, node]) => {
+        const component = intermediateNodesIndexedByUid[uid];
+        const componentConfigPath = path_1.default.join(projectSourceDir, component.metaFilePath);
+        let configUpdatedSinceLastUpload = false;
+        if (projectNodesAtLastUpload) {
+            const componentAtLastUpload = projectNodesAtLastUpload[uid];
+            if (componentAtLastUpload) {
+                configUpdatedSinceLastUpload = !(0, isDeepEqual_1.isDeepEqual)(component.config, componentAtLastUpload.config);
+            }
+            else {
+                // Component is net new
+                configUpdatedSinceLastUpload = true;
+            }
+        }
+        localDevProjectNodes[uid] = {
+            ...node,
+            localDev: {
+                componentRoot: path_1.default.dirname(componentConfigPath),
+                componentConfigPath,
+                configUpdatedSinceLastUpload,
+                removed: false,
+                parsingErrors: [],
+            },
+        };
+    });
+    return localDevProjectNodes;
+}
+function getRemovedNodesAndNodesWithErrors(intermediateNodesIndexedByUid, projectNodesAtLastUpload, parsingErrors) {
+    const nodesWithErrors = {};
+    Object.entries(projectNodesAtLastUpload).forEach(([uid, node]) => {
+        // Node is still in the project
+        if (intermediateNodesIndexedByUid[uid]) {
+            return;
+            // Node has parsing errors but was not removed
+        }
+        const errorForNode = parsingErrors.find(error => error.file === node.metaFilePath);
+        if (errorForNode) {
+            nodesWithErrors[uid] = {
+                ...node,
+                localDev: {
+                    ...node.localDev,
+                    parsingErrors: errorForNode.errors,
+                },
+            };
+            //  Node was removed since the last upload
+        }
+        else {
+            nodesWithErrors[uid] = {
+                ...node,
+                localDev: {
+                    ...node.localDev,
+                    removed: true,
+                },
+            };
+        }
+    });
+    return nodesWithErrors;
+}
+function getLocalDevProfileData(profileVariables) {
+    if (!profileVariables) {
+        return {};
+    }
+    const localDevProfileData = {};
+    Object.entries(profileVariables).forEach(([key, value]) => {
+        localDevProfileData[key] = value.value;
+    });
+    return localDevProfileData;
+}

package/src/lib/transform.d.ts

@@ -4,6 +4,7 @@ export declare function mapToUserFacingType(type: string): string;
 export declare function mapToUserFriendlyName(internalType: string): string;
 export declare function transform(fileParseResults: FileParseResult[], translationContext: TranslationContext, hsProfileContents?: HsProfileFile): Transformation[];
 export declare function getIntermediateRepresentation(transformations: Transformation[], hsProfileContents?: HsProfileFile, skipValidation?: boolean): IntermediateRepresentation;
+export declare function getParsingErrors(transformations: Transformation[]): FileParseResult[];
 export declare function generateServerlessPackageComponent(appFunctionsDirectory: string, translationContext: TranslationContext, componentDeps: Dependencies): {
     uid: string;
     transformation: Transformation;

package/src/lib/transform.js

@@ -8,6 +8,7 @@ exports.mapToUserFacingType = mapToUserFacingType;
 exports.mapToUserFriendlyName = mapToUserFriendlyName;
 exports.transform = transform;
 exports.getIntermediateRepresentation = getIntermediateRepresentation;
+exports.getParsingErrors = getParsingErrors;
 exports.generateServerlessPackageComponent = generateServerlessPackageComponent;
 const path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));
@@ -154,6 +155,11 @@ function getIntermediateRepresentation(transformations, hsProfileContents, skipV
         profileData,
     };
 }
+function getParsingErrors(transformations) {
+    return transformations
+        .filter(t => t.fileParseResult.errors.length > 0)
+        .map(t => t.fileParseResult);
+}
 function getProfileData(hsProfileContents) {
     const profileVariablesForBE = {};
     if (hsProfileContents && hsProfileContents.variables) {

package/src/lib/types.d.ts

@@ -47,6 +47,8 @@ export interface IntermediateRepresentationNodeLocalDev extends IntermediateRepr
         componentRoot: string;
         componentConfigPath: string;
         configUpdatedSinceLastUpload: boolean;
+        removed: boolean;
+        parsingErrors: string[];
     };
 }
 export interface IntermediateRepresentationLocalDev {
@@ -72,7 +74,7 @@ export interface TranslationOptions {
     skipValidation?: boolean;
     profile?: string;
 }
-export interface TranslationOptionsLocalDev extends TranslationOptions {
+export interface TranslationOptionsLocalDev extends Omit<TranslationOptions, 'skipValidation'> {
     projectNodesAtLastUpload?: {
         [key: string]: IntermediateRepresentationNodeLocalDev;
     };