@hubspot/project-parsing-lib 0.9.0 → 0.10.0-beta.1

package/package.json

@@ -1,11 +1,12 @@
 {
     "name": "@hubspot/project-parsing-lib",
-    "version": "0.9.0",
+    "version": "0.10.0-beta.1",
     "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.18.0",
+        "@hubspot/npm-scripts": "0.0.4",
         "@inquirer/prompts": "^7.1.0",
         "@types/jest": "^29.5.14",
         "@types/semver": "^7.5.8",
@@ -19,7 +20,7 @@
         "prettier": "^1.19.1",
         "semver": "^7.6.3",
         "ts-jest": "^29.2.5",
-        "ts-node": "^10.9.2",
+        "tsx": "^4.20.5",
         "typescript": "^5.6.2"
     },
     "dependencies": {
@@ -30,13 +31,14 @@
         "@hubspot/local-dev-lib": "^3.16.0"
     },
     "scripts": {
-        "build": "ts-node ./scripts/build.ts",
+        "build": "tsx ./scripts/build.ts",
         "lint": "echo 'Linting is disabled for Blazar'",
         "lint:local": "eslint --max-warnings=0 . && prettier ./src/** --check",
         "local-dev": "yarn build && cd dist && yarn link && cd .. && tsc --watch --rootDir . --outdir dist",
+        "local-link": "hubspot-linking",
         "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",
+        "release": "tsx ./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"

package/src/index.js

@@ -21,11 +21,11 @@ async function translate(translationContext, translationOptions = defaultOptions
     if (translationOptions.profile) {
         hsProfileContents = (0, files_1.loadHsProfileFile)(translationContext.projectSourceDir, translationOptions.profile);
     }
-    const transformation = (0, transform_1.transform)(metafileContents, translationContext, hsProfileContents);
-    const intermediateRepresentation = (0, transform_1.getIntermediateRepresentation)(transformation, hsProfileContents, skipValidation);
+    const transformations = (0, transform_1.transform)(metafileContents, translationContext, hsProfileContents);
+    const intermediateRepresentation = (0, transform_1.getIntermediateRepresentation)(transformations, hsProfileContents, skipValidation);
     // Remove once extensions and serverless functions are supported
     if (!skipValidation) {
-        await (0, validation_1.validateIntermediateRepresentation)(intermediateRepresentation, transformation, translationContext);
+        await (0, validation_1.validateIntermediateRepresentation)(intermediateRepresentation, transformations, translationContext);
     }
     return intermediateRepresentation;
 }

package/src/lang/copy.d.ts

@@ -31,6 +31,7 @@ export declare const errorMessages: {
         unsupportedType: (type: string) => string;
         errorWithField: (field: string, error: string | undefined) => string;
         invalidJson: string;
+        unexpectedToplevelFields: (unexpectedFields: string) => string;
         wrongDirectoryForComponent: (directory: string, componentType: string, componentMetadata: ComponentMetadata, correctDir: string) => string;
     };
     migrateThemes: {

package/src/lang/copy.js

@@ -42,6 +42,7 @@ exports.errorMessages = {
         unsupportedType: (type) => `Unsupported type: ${(0, transform_1.mapToUserFacingType)(type)}`,
         errorWithField: (field, error) => `${field}: ${error || 'Unknown error'}`,
         invalidJson: 'Invalid JSON',
+        unexpectedToplevelFields: (unexpectedFields) => `Unexpected top-level properties found: ${unexpectedFields}`,
         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`,
     },
     migrateThemes: {

package/src/lib/constants.d.ts

@@ -1,3 +1,4 @@
+import { Components as ComponentsTopLevel } from './types';
 export declare const AppKey = "app";
 export declare const ThemeKey = "theme";
 export declare const CmsAssetsKey = "cms-assets";
@@ -16,6 +17,7 @@ export declare const SettingsKey = "settings";
 export declare const TelemetryKey = "telemetry";
 export declare const VideoConferencingKey = "video-conferencing";
 export declare const WebhooksKey = "webhooks";
+export declare const WebhooksJournalKey = "webhooks-journal";
 export declare const WorkflowActionsKey = "workflow-action";
 export declare const AppFunctionsPackageKey = "serverless-package";
 export declare const AutoGeneratedComponentTypes: string[];
@@ -52,3 +54,4 @@ export declare const ProfileVariableTypes: {
     readonly PROFILE_STRING: "PROFILE_STRING";
     readonly PROFILE_BOOLEAN: "PROFILE_BOOLEAN";
 };
+export declare const allowedTopLevelFields: Set<keyof ComponentsTopLevel>;

package/src/lib/constants.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProfileVariableTypes = exports.allowedSubComponentDirectories = exports.allowedComponentDirectories = exports.ProjectStructure = exports.allowedCmsAssetSubComponentDirs = 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.CmsAssetsKey = exports.ThemeKey = exports.AppKey = void 0;
+exports.allowedTopLevelFields = exports.ProfileVariableTypes = exports.allowedSubComponentDirectories = exports.allowedComponentDirectories = exports.ProjectStructure = exports.allowedCmsAssetSubComponentDirs = 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.WebhooksJournalKey = 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.CmsAssetsKey = exports.ThemeKey = exports.AppKey = void 0;
 // Top Level Component types
 const path = __importStar(require("path"));
 // Component types
@@ -56,6 +56,7 @@ exports.SettingsKey = 'settings';
 exports.TelemetryKey = 'telemetry';
 exports.VideoConferencingKey = 'video-conferencing';
 exports.WebhooksKey = 'webhooks';
+exports.WebhooksJournalKey = 'webhooks-journal';
 exports.WorkflowActionsKey = 'workflow-action';
 // Auto-generated component types
 exports.AppFunctionsPackageKey = 'serverless-package';
@@ -170,6 +171,13 @@ exports.Components = {
         ...SubComponentFields,
         singularComponent: true,
     },
+    [exports.WebhooksJournalKey]: {
+        dir: exports.WebhooksJournalKey,
+        parentComponent: exports.AppKey,
+        userFriendlyName: 'Webhooks Journal',
+        ...SubComponentFields,
+        singularComponent: true,
+    },
     [exports.WorkflowActionsKey]: {
         dir: 'workflow-actions',
         parentComponent: exports.AppKey,
@@ -230,3 +238,9 @@ exports.ProfileVariableTypes = {
     PROFILE_STRING: 'PROFILE_STRING',
     PROFILE_BOOLEAN: 'PROFILE_BOOLEAN',
 };
+exports.allowedTopLevelFields = new Set([
+    'uid',
+    'type',
+    'config',
+    'dependencies',
+]);

package/src/lib/files.js

@@ -107,6 +107,17 @@ function parseFile(fileLoadResult) {
     catch (_e) {
         fileLoadResult.errors?.push(copy_1.errorMessages.validation.invalidJson);
     }
+    // Validate top-level fields (only uid, type, and config are expected)
+    if (parsedFileContents &&
+        typeof parsedFileContents === 'object' &&
+        !Array.isArray(parsedFileContents)) {
+        const actualFields = Object.keys(parsedFileContents);
+        const unexpectedFields = actualFields.filter(field => !constants_1.allowedTopLevelFields.has(field));
+        if (unexpectedFields.length > 0) {
+            const unexpectedFieldsList = unexpectedFields.join(', ');
+            fileLoadResult.errors?.push(copy_1.errorMessages.validation.unexpectedToplevelFields(unexpectedFieldsList));
+        }
+    }
     return { ...fileLoadResult, content: parsedFileContents };
 }
 async function projectContainsHsMetaFiles(projectSourceDir) {

package/src/lib/transform.d.ts

@@ -2,6 +2,7 @@ import { Dependencies, FileParseResult, HsProfileFile, IntermediateRepresentatio
 export declare function mapToInternalType(type: string): string;
 export declare function mapToUserFacingType(type: string): string;
 export declare function mapToUserFriendlyName(internalType: string): string;
+export declare function findTransformationByUid(transformations: Transformation[], uid: string): Transformation | undefined;
 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[];

package/src/lib/transform.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.mapToInternalType = mapToInternalType;
 exports.mapToUserFacingType = mapToUserFacingType;
 exports.mapToUserFriendlyName = mapToUserFriendlyName;
+exports.findTransformationByUid = findTransformationByUid;
 exports.transform = transform;
 exports.getIntermediateRepresentation = getIntermediateRepresentation;
 exports.getParsingErrors = getParsingErrors;
@@ -59,6 +60,9 @@ function mapToUserFacingType(type) {
 function mapToUserFriendlyName(internalType) {
     return constants_1.Components[mapToUserFacingType(internalType)]?.userFriendlyName || '';
 }
+function findTransformationByUid(transformations, uid) {
+    return transformations.find(t => t.intermediateRepresentation?.uid === uid);
+}
 function transform(fileParseResults, translationContext, hsProfileContents) {
     const parentTypes = Object.keys(constants_1.ProjectStructure);
     const parentComponents = {};

package/src/lib/validation.d.ts

@@ -11,4 +11,4 @@ export type ValidationResults = {
     schemaValidationErrors?: ValidateFunction['errors'];
 } | ValidResult;
 export declare function createAjvInstance(): Ajv;
-export declare function validateIntermediateRepresentation(intermediateRepresentation: IntermediateRepresentation, transformation: Transformation[], translationContext: TranslationContext): Promise<ValidResult>;
+export declare function validateIntermediateRepresentation(intermediateRepresentation: IntermediateRepresentation, transformations: Transformation[], translationContext: TranslationContext): Promise<ValidResult>;

package/src/lib/validation.js

@@ -19,41 +19,41 @@ function createAjvInstance() {
     (0, ajv_formats_1.default)(ajv);
     return ajv;
 }
-function validateIntermediateRepresentationNode(schema, transformation, irNode, index, translationContext) {
+function validateIntermediateRepresentationNode(schema, transformation, irNode, translationContext) {
     if (constants_1.AutoGeneratedComponentTypes.includes((0, transform_1.mapToUserFacingType)(irNode.componentType))) {
         // Skip validation for auto-generated components
         return {
             valid: true,
         };
     }
-    if (transformation[index].fileParseResult.errors.length > 0) {
+    if (transformation.fileParseResult.errors.length > 0) {
         return {
             valid: false,
-            errors: (0, errors_1.compileError)(transformation[index]),
+            errors: (0, errors_1.compileError)(transformation),
         };
     }
     const ajv = createAjvInstance();
     let shouldSkipValidation = false;
     if (!irNode.uid) {
-        transformation[index].fileParseResult.errors.push(copy_1.errorMessages.validation.missingUid);
+        transformation.fileParseResult.errors.push(copy_1.errorMessages.validation.missingUid);
     }
     else {
         const uidValidationResult = (0, uid_1.validateUid)(irNode.uid);
         if (uidValidationResult) {
-            transformation[index].fileParseResult.errors.push(uidValidationResult);
+            transformation.fileParseResult.errors.push(uidValidationResult);
         }
     }
     if (!irNode.config) {
-        transformation[index].fileParseResult.errors.push(copy_1.errorMessages.validation.missingConfig);
+        transformation.fileParseResult.errors.push(copy_1.errorMessages.validation.missingConfig);
         // If there is no config block, there is nothing to validation
         shouldSkipValidation = true;
     }
     if (!schema[irNode.componentType]) {
         if (!irNode.componentType) {
-            transformation[index].fileParseResult.errors.push(copy_1.errorMessages.validation.missingType);
+            transformation.fileParseResult.errors.push(copy_1.errorMessages.validation.missingType);
         }
         else {
-            transformation[index].fileParseResult.errors.push(copy_1.errorMessages.validation.unsupportedType(irNode.componentType));
+            transformation.fileParseResult.errors.push(copy_1.errorMessages.validation.unsupportedType(irNode.componentType));
         }
         // If there is no schema for the component type, there is no way to validate
         shouldSkipValidation = true;
@@ -65,21 +65,23 @@ function validateIntermediateRepresentationNode(schema, transformation, irNode,
             ? constants_1.Components[component.parentComponent].dir
             : '';
         const expectedLocation = path_1.default.join(expectedParentDir, component.dir);
-        const actualLocation = path_1.default.dirname(transformation[index].fileParseResult.file);
+        const actualLocation = path_1.default.dirname(transformation.fileParseResult.file);
         if (expectedLocation !== actualLocation) {
-            transformation[index].fileParseResult.errors.push(copy_1.errorMessages.validation.wrongDirectoryForComponent(actualLocation, userFacingType, component, path_1.default.join(translationContext.projectSourceDir, expectedLocation)));
+            transformation.fileParseResult.errors.push(copy_1.errorMessages.validation.wrongDirectoryForComponent(actualLocation, userFacingType, component, path_1.default.join(translationContext.projectSourceDir, expectedLocation)));
         }
     }
     if (shouldSkipValidation) {
         return {
             valid: false,
-            errors: (0, errors_1.compileError)(transformation[index]),
+            errors: (0, errors_1.compileError)(transformation),
         };
     }
+    console.log('schema[irNode.componentType]', schema[irNode.componentType]);
+    console.log('irNode.config', irNode.config);
     const validate = ajv.compile(schema[irNode.componentType]);
     const valid = validate(irNode.config);
     if (valid) {
-        const { errors } = transformation[index].fileParseResult;
+        const { errors } = transformation.fileParseResult;
         // Even through it passed the schema validation, it may have had other errors along the way
         return errors.length === 0
             ? {
@@ -87,7 +89,7 @@ function validateIntermediateRepresentationNode(schema, transformation, irNode,
             }
             : {
                 valid: false,
-                errors: (0, errors_1.compileError)(transformation[index]),
+                errors: (0, errors_1.compileError)(transformation),
             };
     }
     return {
@@ -95,11 +97,11 @@ function validateIntermediateRepresentationNode(schema, transformation, irNode,
         schemaValidationErrors: validate.errors,
     };
 }
-async function validateIntermediateRepresentation(intermediateRepresentation, transformation, translationContext) {
-    const hasAnyFileParseErrors = transformation.some(t => t.fileParseResult.errors.length > 0);
+async function validateIntermediateRepresentation(intermediateRepresentation, transformations, translationContext) {
+    const hasAnyFileParseErrors = transformations.some(t => t.fileParseResult.errors.length > 0);
     const schema = await (0, schemas_1.getIntermediateRepresentationSchema)(translationContext);
     const potentialDuplicatesByComponent = {};
-    const results = Object.values(intermediateRepresentation.intermediateNodesIndexedByUid).map((irNode, index) => {
+    const results = Object.values(intermediateRepresentation.intermediateNodesIndexedByUid).map(irNode => {
         const userFacingType = (0, transform_1.mapToUserFacingType)(irNode.componentType);
         const component = constants_1.Components[userFacingType];
         if (component && component.singularComponent) {
@@ -107,7 +109,11 @@ async function validateIntermediateRepresentation(intermediateRepresentation, tr
                 ? [...potentialDuplicatesByComponent[userFacingType], irNode]
                 : [irNode];
         }
-        return validateIntermediateRepresentationNode(schema, transformation, irNode, index, translationContext);
+        const transformation = (0, transform_1.findTransformationByUid)(transformations, irNode.uid);
+        if (!transformation) {
+            return { valid: false, errors: [copy_1.errorMessages.validation.missingUid] };
+        }
+        return validateIntermediateRepresentationNode(schema, transformation, irNode, translationContext);
     });
     let hasDuplicates = false;
     Object.entries(potentialDuplicatesByComponent).forEach(([componentType, potentialDuplicates]) => {
@@ -116,9 +122,10 @@ async function validateIntermediateRepresentation(intermediateRepresentation, tr
         }
         hasDuplicates = true;
         potentialDuplicates.forEach(duplicate => {
-            transformation
-                .find(transform => transform.intermediateRepresentation?.uid === duplicate.uid)
-                ?.fileParseResult.errors.push(copy_1.errorMessages.project.duplicateComponent(componentType));
+            const potentialDuplicateTransformation = (0, transform_1.findTransformationByUid)(transformations, duplicate.uid);
+            if (potentialDuplicateTransformation) {
+                potentialDuplicateTransformation.fileParseResult.errors.push(copy_1.errorMessages.project.duplicateComponent(componentType));
+            }
         });
     });
     const valid = !hasAnyFileParseErrors &&
@@ -129,6 +136,6 @@ async function validateIntermediateRepresentation(intermediateRepresentation, tr
             valid,
         };
     }
-    const schemaValidationErrors = results.map(result => result.schemaValidationErrors);
-    throw new errors_1.TranslationError(copy_1.errorMessages.project.failedToTranslateProject, transformation, schemaValidationErrors, translationContext);
+    const schemaValidationErrors = results.map(result => 'schemaValidationErrors' in result ? result.schemaValidationErrors : null);
+    throw new errors_1.TranslationError(copy_1.errorMessages.project.failedToTranslateProject, transformations, schemaValidationErrors, translationContext);
 }