@hubspot/project-parsing-lib 0.2.0 → 0.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/project-parsing-lib",
-    "version": "0.2.0",
+    "version": "0.2.1",
     "description": "Parsing library for converting projects directory structures to their intermediate representation",
     "license": "Apache-2.0",
     "main": "src/index.js",
@@ -37,6 +37,7 @@
         "prettier:write": "prettier ./src/** --write",
         "test": "NODE_NO_WARNINGS=1 node --experimental-vm-modules ./node_modules/.bin/jest",
         "release": "yarn ts-node ./scripts/release.ts release",
+        "reset-north-star": "git submodule update --init",
         "acceptance-test": "yarn --cwd=./acceptance-tests test",
         "update-north-star": "git submodule update --remote --merge"
     },

package/src/index.d.ts

@@ -5,7 +5,7 @@ export declare function translateForLocalDev(translationContext: TranslationCont
 export { isTranslationError } from './lib/errors';
 export { IntermediateRepresentation, IntermediateRepresentationNode, IntermediateRepresentationLocalDev, IntermediateRepresentationNodeLocalDev, TranslationContext, };
 export { getHsProfileFilename } from './lib/profiles';
-export { loadHsProfileFile, getAllHsProfiles } from './lib/files';
+export { loadHsProfileFile, getAllHsProfiles, projectContainsHsMetaFiles, } from './lib/files';
 export { migrate } from './lib/migrate';
 export { validateUid } from './lib/uid';
 export { mapToUserFriendlyName, mapToInternalType } from './lib/transform';

package/src/index.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.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.getAllHsProfiles = exports.loadHsProfileFile = exports.getHsProfileFilename = exports.isTranslationError = void 0;
+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 files_1 = require("./lib/files");
@@ -60,6 +60,7 @@ Object.defineProperty(exports, "getHsProfileFilename", { enumerable: true, get:
 var files_2 = require("./lib/files");
 Object.defineProperty(exports, "loadHsProfileFile", { enumerable: true, get: function () { return files_2.loadHsProfileFile; } });
 Object.defineProperty(exports, "getAllHsProfiles", { enumerable: true, get: function () { return files_2.getAllHsProfiles; } });
+Object.defineProperty(exports, "projectContainsHsMetaFiles", { enumerable: true, get: function () { return files_2.projectContainsHsMetaFiles; } });
 var migrate_1 = require("./lib/migrate");
 Object.defineProperty(exports, "migrate", { enumerable: true, get: function () { return migrate_1.migrate; } });
 var uid_1 = require("./lib/uid");

package/src/lang/copy.js

@@ -39,7 +39,7 @@ exports.errorMessages = {
         missingType: `Missing required field: 'type'`,
         missingConfig: `Missing required field: 'config'`,
         unsupportedType: (type) => `Unsupported type: ${(0, transform_1.mapToUserFacingType)(type)}`,
-        errorWithField: (field, error) => `Error with ${field}: ${error || 'Unknown error'}`,
+        errorWithField: (field, error) => `${field}: ${error || 'Unknown error'}`,
         invalidJson: 'Invalid JSON',
         wrongDirectoryForComponent: (directory, componentType, componentMetadata, correctDir) => `The directory '${directory}' is incorrect for type '${componentType}'. ${componentMetadata.userFriendlyName} ${componentMetadata.userFriendlyTypePlural} should only be placed in the '${correctDir}' directory`,
     },

package/src/lib/errors.d.ts

@@ -8,6 +8,7 @@ export declare class TranslationError extends Error {
     constructor(message: string, transformations: Transformation[], errors: (ErrorObject[] | null | undefined)[], translationContext: TranslationContext);
     toString(): string;
 }
+export declare function extractDotNotationValueFromTransformation(dotNotation: string, transformation: Transformation): unknown;
 export declare const AjvErrorKeyword: {
     AdditionalItems: string;
     AdditionalProperties: string;

package/src/lib/errors.js

@@ -6,8 +6,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AjvErrorKeyword = exports.TranslationError = void 0;
 exports.isTranslationError = isTranslationError;
 exports.compileError = compileError;
+exports.extractDotNotationValueFromTransformation = extractDotNotationValueFromTransformation;
 const copy_1 = require("../lang/copy");
 const path_1 = __importDefault(require("path"));
+const logger_1 = require("@hubspot/local-dev-lib/logger");
 function isTranslationError(error) {
     return error instanceof TranslationError;
 }
@@ -33,9 +35,11 @@ class TranslationError extends Error {
             if (errors.length === 0) {
                 return null;
             }
-            return copy_1.errorMessages.validation.errorWithFileHeader(path_1.default.join(this.translationContext.projectSourceDir, file), errors);
+            const projectRoot = path_1.default.dirname(path_1.default.dirname(this.translationContext.projectSourceDir));
+            const relativePath = path_1.default.relative(projectRoot, path_1.default.join(this.translationContext.projectSourceDir, file));
+            return copy_1.errorMessages.validation.errorWithFileHeader(relativePath, errors);
         });
-        return `${this.message}: ${listOfErrors
+        return `${this.message}:${listOfErrors
             .filter(error => error !== null)
             .join('')}`;
     }
@@ -61,16 +65,16 @@ function compileTranslationErrors(transformation, schemaErrors) {
     // If there is a one of error, we need to preprocess the errors to group them by instancePath and keyword
     // This allows us to group data from the errors that correspond to the same field
     if (hasOneOfErrors) {
-        errors.push(...preprocessSpecialErrors(schemaErrors));
+        errors.push(...preprocessSpecialErrors(schemaErrors, transformation));
     }
     else {
         schemaErrors?.forEach(error => {
-            errors.push(generateErrorMessage(error));
+            errors.push(generateErrorMessage(error, transformation));
         });
     }
     return { file, errors };
 }
-function preprocessSpecialErrors(schemaErrors) {
+function preprocessSpecialErrors(schemaErrors, transformation) {
     const errors = [];
     const preprocessedErrors = {};
     schemaErrors?.forEach(error => {
@@ -94,11 +98,11 @@ function preprocessSpecialErrors(schemaErrors) {
             }
             return cur;
         });
-        errors.push(generateErrorMessage(newValue));
+        errors.push(generateErrorMessage(newValue, transformation));
     });
     return errors;
 }
-function generateErrorMessage(error) {
+function generateErrorMessage(error, transformation) {
     const errorPath = generateDotNotationPath(error);
     const errorMessage = copy_1.errorMessages.validation.errorWithField(errorPath, error.message);
     const params = Object.entries(error.params);
@@ -112,7 +116,11 @@ function generateErrorMessage(error) {
         return copy_1.errorMessages.validation.missingRequiredField(`${errorPath}.${error.params.missingProperty}`);
     }
     else if (isTypeError(error)) {
-        return copy_1.errorMessages.validation.errorWithField(generateDotNotationPath(error), error.message);
+        const dotNotationPath = generateDotNotationPath(error);
+        const value = extractDotNotationValueFromTransformation(dotNotationPath, transformation);
+        return copy_1.errorMessages.validation.errorWithField(value !== undefined
+            ? `Value (${value}) in ${dotNotationPath}`
+            : dotNotationPath, error.message);
     }
     // Default case, it is not an error we know how to deal with
     return `${errorMessage} ${additionalContext.length > 0
@@ -134,23 +142,47 @@ function mergeEnumErrors(cur, next) {
         },
     };
 }
-const JSON_SCHEMA_VALIDATION_KEYWORDS = {
-    required: 'required',
-    type: 'type',
-    oneOf: 'oneOf',
-    enum: 'enum',
-};
+function extractDotNotationValueFromTransformation(dotNotation, transformation) {
+    try {
+        const parts = dotNotation.split('.');
+        if (!transformation?.fileParseResult?.content || parts.length === 0) {
+            return undefined;
+        }
+        let value = transformation.fileParseResult.content;
+        // Traverse the nested objects and lists to get the end value
+        parts.forEach(item => {
+            // @ts-expect-error value is unknown since it is user generated config
+            const newValue = value[item];
+            if (newValue &&
+                typeof newValue === 'object' &&
+                !Array.isArray(newValue)) {
+                value = Object.assign(Object.create(null), newValue);
+            }
+            else {
+                value = newValue;
+            }
+        });
+        // If the value is an object/array, stringify the value so it doesn't log as [object Object] or '' for array
+        if (typeof value === 'object' && !!value) {
+            return JSON.stringify(value);
+        }
+        return value;
+    }
+    catch (e) {
+        logger_1.logger.debug('Unable to parse dot notation path to located value', e);
+    }
+}
 function isOneOfError(error) {
-    return error.keyword === JSON_SCHEMA_VALIDATION_KEYWORDS.oneOf;
+    return error.keyword === exports.AjvErrorKeyword.OneOf;
 }
 function isRequiredError(error) {
-    return error.keyword === JSON_SCHEMA_VALIDATION_KEYWORDS.required;
+    return error.keyword === exports.AjvErrorKeyword.Required;
 }
 function isEnumError(error) {
-    return error.keyword === JSON_SCHEMA_VALIDATION_KEYWORDS.enum;
+    return error.keyword === exports.AjvErrorKeyword.Enum;
 }
 function isTypeError(error) {
-    return error.keyword === JSON_SCHEMA_VALIDATION_KEYWORDS.type;
+    return error.keyword === exports.AjvErrorKeyword.Type;
 }
 exports.AjvErrorKeyword = {
     AdditionalItems: 'additionalItems',

package/src/lib/files.d.ts

@@ -2,3 +2,4 @@ import { FileParseResult, TranslationContext, HsProfileFile } from './types';
 export declare function loadHsProfileFile(projectSourceDir: string, profile: string): HsProfileFile;
 export declare function getAllHsProfiles(projectSourceDir: string): Promise<string[]>;
 export declare function loadHsMetaFiles(translationContext: TranslationContext): Promise<FileParseResult[]>;
+export declare function projectContainsHsMetaFiles(projectSourceDir: string): Promise<boolean>;

package/src/lib/files.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadHsProfileFile = loadHsProfileFile;
 exports.getAllHsProfiles = getAllHsProfiles;
 exports.loadHsMetaFiles = loadHsMetaFiles;
+exports.projectContainsHsMetaFiles = projectContainsHsMetaFiles;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const fs_2 = require("@hubspot/local-dev-lib/fs");
@@ -41,11 +42,10 @@ function getAllHsProfiles(projectSourceDir) {
     });
 }
 async function loadHsMetaFiles(translationContext) {
-    const metaFiles = await locateHsMetaFiles(translationContext);
+    const metaFiles = await locateHsMetaFiles(translationContext.projectSourceDir);
     return parseHsMetaFiles(metaFiles, translationContext);
 }
-async function locateHsMetaFiles(translationContext) {
-    const { projectSourceDir } = translationContext;
+async function locateHsMetaFiles(projectSourceDir) {
     return (await (0, fs_2.walk)(projectSourceDir, ['node_modules'])).reduce((metaFiles, file) => {
         if (!file.endsWith(constants_1.metafileExtension)) {
             return metaFiles;
@@ -105,3 +105,7 @@ function parseFile(fileLoadResult) {
     }
     return { ...fileLoadResult, content: parsedFileContents };
 }
+async function projectContainsHsMetaFiles(projectSourceDir) {
+    const hsMetaFiles = (await (0, fs_2.walk)(projectSourceDir, ['node_modules'])).filter(file => file.endsWith(constants_1.metafileExtension));
+    return hsMetaFiles.length > 0;
+}