@hubspot/project-parsing-lib 0.10.2 → 0.10.3-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/project-parsing-lib",
-    "version": "0.10.2",
+    "version": "0.10.3-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.d.ts

@@ -4,7 +4,7 @@ export declare function translate(translationContext: TranslationContext, transl
 export declare function translateForLocalDev(translationContext: TranslationContext, translationOptions?: TranslationOptionsLocalDev): Promise<IntermediateRepresentationLocalDev>;
 export { isTranslationError } from './lib/errors';
 export { IntermediateRepresentation, IntermediateRepresentationNode, IntermediateRepresentationLocalDev, IntermediateRepresentationNodeLocalDev, TranslationContext, };
-export { getHsProfileFilename } from './lib/profiles';
+export { getHsProfileFilename, validateProfileVariables } from './lib/profiles';
 export { loadHsProfileFile, getAllHsProfiles, projectContainsHsMetaFiles, } from './lib/files';
 export { migrate } from './lib/migrate';
 export { validateUid, coerceToValidUid } from './lib/uid';

package/src/index.js

@@ -1,6 +1,6 @@
 "use strict";
 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.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.validateProfileVariables = exports.getHsProfileFilename = exports.isTranslationError = void 0;
 exports.translate = translate;
 exports.translateForLocalDev = translateForLocalDev;
 const files_1 = require("./lib/files");
@@ -59,6 +59,7 @@ var errors_1 = require("./lib/errors");
 Object.defineProperty(exports, "isTranslationError", { enumerable: true, get: function () { return errors_1.isTranslationError; } });
 var profiles_1 = require("./lib/profiles");
 Object.defineProperty(exports, "getHsProfileFilename", { enumerable: true, get: function () { return profiles_1.getHsProfileFilename; } });
+Object.defineProperty(exports, "validateProfileVariables", { enumerable: true, get: function () { return profiles_1.validateProfileVariables; } });
 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; } });

package/src/lib/profiles.d.ts

@@ -3,4 +3,8 @@ export declare function getIsProfileFile(filename: string): boolean;
 export declare function getHsProfileFilename(profileName: string): string;
 export declare function getHsProfileName(profileFilename: string): string;
 export declare function getHsProfileVariables(hsProfileContents: HsProfileFile): HSProfileVariables;
+export declare function validateProfileVariables(profileVariables: HSProfileVariables, filename: string): {
+    success: boolean;
+    errors: string[];
+};
 export declare function applyHsProfileVariables(fileParseResults: FileParseResult[], hsProfileContents: HsProfileFile): FileParseResult[];

package/src/lib/profiles.js

@@ -4,6 +4,7 @@ exports.getIsProfileFile = getIsProfileFile;
 exports.getHsProfileFilename = getHsProfileFilename;
 exports.getHsProfileName = getHsProfileName;
 exports.getHsProfileVariables = getHsProfileVariables;
+exports.validateProfileVariables = validateProfileVariables;
 exports.applyHsProfileVariables = applyHsProfileVariables;
 const constants_1 = require("./constants");
 const copy_1 = require("../lang/copy");
@@ -25,15 +26,38 @@ function getHsProfileVariables(hsProfileContents) {
         !Array.isArray(hsProfileContents.variables);
     return profileVariablesAreValid ? hsProfileContents.variables : {};
 }
+function validateProfileVariables(profileVariables, filename) {
+    const errors = [];
+    Object.entries(profileVariables).forEach(([key, value]) => {
+        try {
+            validateProfileVariable(typeof value, key, filename);
+        }
+        catch (e) {
+            if (e instanceof Error) {
+                errors.push(e.message);
+            }
+            else {
+                errors.push(`${e}`);
+            }
+        }
+    });
+    return {
+        success: errors.length === 0,
+        errors,
+    };
+}
+function validateProfileVariable(profileVariableType, key, file) {
+    if (profileVariableType === 'undefined') {
+        throw new Error(copy_1.errorMessages.profile.missingValue(key, file));
+    }
+    if (!['string', 'number', 'boolean'].includes(profileVariableType)) {
+        throw new Error(copy_1.errorMessages.profile.invalidValue(key));
+    }
+}
 function interpolate(file, template, profileVariables) {
     return template.replace(profileInsertRegex, (__match, key) => {
         const profileVariableType = typeof profileVariables[key];
-        if (profileVariableType === 'undefined') {
-            throw new Error(copy_1.errorMessages.profile.missingValue(key, file));
-        }
-        if (!['string', 'number', 'boolean'].includes(profileVariableType)) {
-            throw new Error(copy_1.errorMessages.profile.invalidValue(key));
-        }
+        validateProfileVariable(profileVariableType, key, file);
         return String(profileVariables[key]);
     });
 }