@hubspot/project-parsing-lib 0.0.4 → 0.0.5

package/package.json

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

package/src/index.js

@@ -6,16 +6,17 @@ const files_1 = require("./lib/files");
 const validation_1 = require("./lib/validation");
 const transform_1 = require("./lib/transform");
 const errors_1 = require("./lib/errors");
+const copy_1 = require("./lang/copy");
 async function translate(translationContext) {
     const metafileContents = await (0, files_1.loadHsMetaFiles)(translationContext);
     if (metafileContents.length === 0) {
-        throw new Error('No *-hsmeta.json files found, make sure you are inside a project');
+        throw new Error(copy_1.errorMessages.project.noHsMetaFiles);
     }
     const transformation = (0, transform_1.transform)(metafileContents);
     const intermediateRepresentation = (0, transform_1.getIntermediateRepresentation)(transformation);
     const { valid, errors } = await (0, validation_1.validateIntermediateRepresentation)(intermediateRepresentation, transformation, translationContext);
     if (!valid) {
-        throw new errors_1.TranslationError('Failed to translate project', errors);
+        throw new errors_1.TranslationError(copy_1.errorMessages.project.failedToTranslateProject, errors);
     }
     return intermediateRepresentation;
 }

package/src/lang/copy.d.ts

@@ -0,0 +1,24 @@
+export declare const errorMessages: {
+    api: {
+        failedToFetchSchemas: string;
+    };
+    project: {
+        noHsMetaFiles: string;
+        failedToTranslateProject: string;
+        duplicateUid: (uid: string, files: string[]) => string;
+    };
+    file: {
+        errorWithFileHeader: (file: string) => string;
+        missingRequiredField: (field: string) => string;
+        missingUid: string;
+        missingType: string;
+        unsupportedType: (type: string) => string;
+        errorWithField: (field: string, error: string | undefined) => string;
+        invalidJson: string;
+    };
+};
+export declare const logMessages: {
+    files: {
+        skippingPath: (path: string) => string;
+    };
+};

package/src/lang/copy.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logMessages = exports.errorMessages = void 0;
+exports.errorMessages = {
+    api: {
+        failedToFetchSchemas: 'Failed to fetch schemas',
+    },
+    project: {
+        noHsMetaFiles: 'No *-hsmeta.json files found, make sure you are inside a project',
+        failedToTranslateProject: 'Failed to translate project',
+        duplicateUid: (uid, files) => `Duplicate uid '${uid}' found in ${files.join(', ')}`,
+    },
+    file: {
+        errorWithFileHeader: (file) => `Encountered the following errors for ${file}:`,
+        missingRequiredField: (field) => `Missing required field: '${field}'`,
+        missingUid: `Missing required field: 'uid'`,
+        missingType: `Missing required field: 'type'`,
+        unsupportedType: (type) => `Unsupported type: ${type.toLowerCase()}`,
+        errorWithField: (field, error) => `Error with ${field}: ${error || 'Unknown error'}`,
+        invalidJson: 'Invalid JSON',
+    },
+};
+exports.logMessages = {
+    files: {
+        skippingPath: (path) => `Skipping ${path} as it is not in a valid directory`,
+    },
+};

package/src/lib/constants.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.allowedSubComponentDirectories = exports.allowedComponentDirectories = exports.ProjectStructure = exports.allowedThemeSubComponentsDirs = exports.allowedAppSubComponentsDirs = exports.metafileExtension = exports.externalTypeToInternalType = exports.Components = exports.WorkflowActionsKey = exports.WebhooksKey = exports.VideoConferencingKey = exports.TimelineEventsKey = exports.MediaBridgeKey = exports.MarketingEventsKey = exports.FunctionsKey = exports.CardsKey = exports.CallingKey = exports.ThemeKey = exports.AppKey = void 0;
 // Top Level Component types

package/src/lib/errors.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.TranslationError = void 0;
 exports.isTranslationError = isTranslationError;
 exports.compileError = compileError;
+const copy_1 = require("../lang/copy");
 class TranslationError extends Error {
     errors;
     constructor(message, errors) {
@@ -22,7 +23,7 @@ function compileError(validatedTransformation) {
     const { fileParseResult } = validatedTransformation;
     const { errors, file: filePath } = fileParseResult;
     return {
-        message: `Encountered the following errors for ${filePath}:`,
+        message: copy_1.errorMessages.file.errorWithFileHeader(filePath),
         errors,
     };
 }

package/src/lib/files.js

@@ -8,6 +8,8 @@ const fs_1 = require("@hubspot/local-dev-lib/fs");
 const path_1 = __importDefault(require("path"));
 const constants_1 = require("./constants");
 const fs_2 = __importDefault(require("fs"));
+const copy_1 = require("../lang/copy");
+const logger_1 = require("@hubspot/local-dev-lib/logger");
 async function loadHsMetaFiles(translationContext) {
     const metaFiles = await locateHsMetaFiles(translationContext);
     return parseHsMetaFiles(metaFiles, translationContext);
@@ -28,7 +30,7 @@ async function locateHsMetaFiles(translationContext) {
             metaFiles.push({ file, parentDirectory });
         }
         else {
-            console.warn(`Skipping ${pathRelativeToProjectSrcDir} as it is not in a valid directory`);
+            logger_1.logger.warn(copy_1.logMessages.files.skippingPath(pathRelativeToProjectSrcDir));
         }
         return metaFiles;
     }, []);
@@ -69,7 +71,7 @@ function parseFile(fileLoadResult) {
         parsedFileContents = JSON.parse(fileLoadResult.content);
     }
     catch (_e) {
-        fileLoadResult.errors?.push('Invalid JSON');
+        fileLoadResult.errors?.push(copy_1.errorMessages.file.invalidJson);
     }
     return { ...fileLoadResult, content: parsedFileContents };
 }

package/src/lib/schemas.js

@@ -3,12 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getIntermediateRepresentationSchema = getIntermediateRepresentationSchema;
 const http_1 = require("@hubspot/local-dev-lib/http");
 const index_1 = require("@hubspot/local-dev-lib/errors/index");
+const copy_1 = require("../lang/copy");
 async function getIntermediateRepresentationSchema(translationContext) {
     try {
-        const { accountId } = translationContext;
+        const { accountId, platformVersion } = translationContext;
         const { data } = await http_1.http.get(accountId, {
-            // TODO: update this to use the real platform version
-            url: `project-components-external/project-schemas/v3?platformVersion=testing`,
+            url: `project-components-external/project-schemas/v3/${platformVersion}`,
         });
         return data;
     }
@@ -16,6 +16,6 @@ async function getIntermediateRepresentationSchema(translationContext) {
         if ((0, index_1.isHubSpotHttpError)(e)) {
             throw e;
         }
-        throw new Error('Failed to fetch schemas', { cause: e });
+        throw new Error(copy_1.errorMessages.api.failedToFetchSchemas, { cause: e });
     }
 }

package/src/lib/transform.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.transform = transform;
 exports.getIntermediateRepresentation = getIntermediateRepresentation;
 const constants_1 = require("./constants");
+const copy_1 = require("../lang/copy");
 function calculateComponentDeps(fileValidationResult, parentComponents) {
     return {
         ...fileValidationResult.content?.dependencies,
@@ -38,6 +39,7 @@ function transform(fileParseResults) {
                 config,
                 componentType: mapToInternalType(type),
                 componentDeps: calculateComponentDeps(currentFile, parentComponents),
+                metaFilePath: currentFile.file,
                 files: {},
             },
             fileParseResult: currentFile,
@@ -51,7 +53,7 @@ function getIntermediateRepresentation(transformations) {
             const duplicates = transformations
                 .filter(t => t.intermediateRepresentation?.uid === uid)
                 .map(t => t.fileParseResult.file);
-            throw new Error(`Duplicate uid '${uid}' found in ${duplicates.join(', ')}`);
+            throw new Error(copy_1.errorMessages.project.duplicateUid(uid, duplicates));
         }
         return {
             ...acc,

package/src/lib/types.d.ts

@@ -18,6 +18,7 @@ export interface FileParseResult extends FileActionResult {
 export interface IntermediateRepresentationNode {
     componentType: string;
     componentDeps: Record<string, string>;
+    metaFilePath: string;
     uid: string;
     config: unknown;
     files: unknown;

package/src/lib/validation.js

@@ -7,15 +7,19 @@ exports.validateIntermediateRepresentation = validateIntermediateRepresentation;
 const schemas_1 = require("./schemas");
 const ajv_draft_04_1 = __importDefault(require("ajv-draft-04"));
 const errors_1 = require("./errors");
+const copy_1 = require("../lang/copy");
 async function validateIntermediateRepresentation(intermediateRepresentation, transformation, translationContext) {
     const schema = await (0, schemas_1.getIntermediateRepresentationSchema)(translationContext);
     const results = Object.values(intermediateRepresentation.intermediateNodesIndexedByUid).map((irNode, index) => {
         const ajv = new ajv_draft_04_1.default({ allErrors: true });
         if (!irNode.uid) {
-            transformation[index].fileParseResult.errors.push(`Missing required field: 'uid'`);
+            transformation[index].fileParseResult.errors.push(copy_1.errorMessages.file.missingUid);
         }
         if (!schema[irNode.componentType]) {
-            transformation[index].fileParseResult.errors.push(`Unsupported 'type': '${irNode.componentType.toLowerCase()}'`);
+            if (!irNode.componentType) {
+                transformation[index].fileParseResult.errors.push(copy_1.errorMessages.file.missingType);
+            }
+            transformation[index].fileParseResult.errors.push(copy_1.errorMessages.file.unsupportedType(irNode.componentType));
             return {
                 valid: false,
                 errors: (0, errors_1.compileError)(transformation[index]),
@@ -73,7 +77,7 @@ const missingRequiredFieldRegex = /must have required property '(.+)'/;
 function generateErrorMessage(path, error) {
     let errorMessage = '';
     const dotNotationPath = path.length === 0 || path[0] === '' ? 'Root Level' : path.join('.');
-    errorMessage = `Error with ${dotNotationPath}: ${error.message}`;
+    errorMessage = copy_1.errorMessages.file.errorWithField(dotNotationPath, error.message);
     const params = Object.entries(error.params);
     if (params.length > 0) {
         const additionalContext = params
@@ -83,7 +87,7 @@ function generateErrorMessage(path, error) {
             missingRequiredFieldRegex.test(error.message) &&
             error.params) {
             // TODO: This error message doesn't work well for nested objects, it makes it seem like the field is missing from the root object
-            return `Missing required field: '${error.params.missingProperty}'`;
+            return copy_1.errorMessages.file.missingRequiredField(error.params.missingProperty);
         }
         errorMessage += `${additionalContext.length > 0
             ? `\n\t\t-  ${additionalContext.join('\n\t\t- ')}`