@hubspot/project-parsing-lib 0.1.8 → 0.1.9-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/project-parsing-lib",
-    "version": "0.1.8",
+    "version": "0.1.9-beta.0",
     "description": "Parsing library for converting projects directory structures to their intermediate representation",
     "license": "Apache-2.0",
     "main": "src/index.js",
@@ -31,7 +31,8 @@
     },
     "scripts": {
         "build": "ts-node ./scripts/build.ts",
-        "lint": "eslint --max-warnings=0 . && prettier ./src/** --check",
+        "lint": "echo 'Linting is disabled for Blazar'",
+        "lint:local": "eslint --max-warnings=0 . && prettier ./src/** --check",
         "local-dev": "yarn build && yarn link --cwd=./dist && tsc --watch --rootDir . --outdir dist",
         "prettier:write": "prettier ./src/** --write",
         "test": "NODE_NO_WARNINGS=1 node --experimental-vm-modules ./node_modules/.bin/jest",

package/src/index.d.ts

@@ -5,4 +5,5 @@ export { isTranslationError } from './lib/errors';
 export { IntermediateRepresentation, IntermediateRepresentationNode, IntermediateRepresentationLocalDev, IntermediateRepresentationNodeLocalDev, TranslationContext, };
 export { migrate } from './lib/migrate';
 export { validateUid } from './lib/uid';
-export { mapToUserFriendlyName } from './lib/transform';
+export { mapToUserFriendlyName, mapToInternalType } from './lib/transform';
+export { getIntermediateRepresentationSchema } from './lib/schemas';

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.mapToUserFriendlyName = exports.validateUid = exports.migrate = exports.isTranslationError = void 0;
+exports.getIntermediateRepresentationSchema = exports.mapToInternalType = exports.mapToUserFriendlyName = exports.validateUid = exports.migrate = exports.isTranslationError = void 0;
 exports.translate = translate;
 exports.translateForLocalDev = translateForLocalDev;
 const files_1 = require("./lib/files");
@@ -20,7 +20,7 @@ async function translate(translationContext, translationOptions = defaultOptions
     if (metafileContents.length === 0) {
         throw new Error(copy_1.errorMessages.project.noHsMetaFiles);
     }
-    const transformation = (0, transform_1.transform)(metafileContents);
+    const transformation = (0, transform_1.transform)(metafileContents, translationContext);
     const intermediateRepresentation = (0, transform_1.getIntermediateRepresentation)(transformation, skipValidation);
     // Remove once extensions and serverless functions are supported
     if (!skipValidation) {
@@ -54,3 +54,6 @@ var uid_1 = require("./lib/uid");
 Object.defineProperty(exports, "validateUid", { enumerable: true, get: function () { return uid_1.validateUid; } });
 var transform_2 = require("./lib/transform");
 Object.defineProperty(exports, "mapToUserFriendlyName", { enumerable: true, get: function () { return transform_2.mapToUserFriendlyName; } });
+Object.defineProperty(exports, "mapToInternalType", { enumerable: true, get: function () { return transform_2.mapToInternalType; } });
+var schemas_1 = require("./lib/schemas");
+Object.defineProperty(exports, "getIntermediateRepresentationSchema", { enumerable: true, get: function () { return schemas_1.getIntermediateRepresentationSchema; } });

package/src/lang/copy.d.ts

@@ -9,6 +9,8 @@ export declare const errorMessages: {
         failedToTranslateProject: string;
         duplicateUid: (uid: string, files: string[]) => string;
         duplicateComponent: (componentType: string) => string;
+        noPackageJsonForServerless: (appFunctionsPackageFile: string) => string;
+        fileContentMissingFor: (file: string) => string;
     };
     validation: {
         errorWithFileHeader: (file: string, errors: string[]) => string;

package/src/lang/copy.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.logMessages = exports.errorMessages = void 0;
+const constants_1 = require("../lib/constants");
+const transform_1 = require("../lib/transform");
 exports.errorMessages = {
     api: {
         failedToFetchSchemas: 'Failed to fetch schemas',
@@ -11,6 +13,8 @@ exports.errorMessages = {
         failedToTranslateProject: 'Project validation failed',
         duplicateUid: (uid, files) => `Duplicate uid '${uid}' found in:\n- ${files.join('\n- ')}`,
         duplicateComponent: (componentType) => `Only one ${componentType} component is allowed`,
+        noPackageJsonForServerless: (appFunctionsPackageFile) => `${appFunctionsPackageFile} does not exist. ${constants_1.Components[constants_1.AppFunctionsKey].userFriendlyName} requires a ${constants_1.packageJson} file to exist in this location`,
+        fileContentMissingFor: (file) => `File content is missing for ${file}`,
     },
     validation: {
         errorWithFileHeader: (file, errors) => `\n\nEncountered the following errors for ${file}:\n\t- ${errors.join('\n\t- ')}`,
@@ -21,7 +25,7 @@ exports.errorMessages = {
         uidTooLong: `'uid' must be 64 characters or less`,
         missingType: `Missing required field: 'type'`,
         missingConfig: `Missing required field: 'config'`,
-        unsupportedType: (type) => `Unsupported type: ${type.toLowerCase()}`,
+        unsupportedType: (type) => `Unsupported type: ${(0, transform_1.mapToUserFacingType)(type)}`,
         errorWithField: (field, error) => `Error with ${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/constants.d.ts

@@ -1,10 +1,10 @@
 export declare const AppKey = "app";
 export declare const ThemeKey = "theme";
+export declare const AppFunctionsKey = "app-function";
 export declare const AppObjectKey = "app-object";
 export declare const AppObjectAssociationKey = "app-object-association";
 export declare const CallingKey = "calling";
 export declare const CardsKey = "card";
-export declare const FunctionsKey = "function";
 export declare const SettingsKey = "settings";
 export declare const MarketingEventsKey = "marketing-event";
 export declare const MediaBridgeKey = "media-bridge";
@@ -12,6 +12,8 @@ export declare const TimelineEventsKey = "timeline-event";
 export declare const VideoConferencingKey = "video-conferencing";
 export declare const WebhooksKey = "webhooks";
 export declare const WorkflowActionsKey = "workflow-action";
+export declare const AppFunctionsPackageKey = "serverless-package";
+export declare const AutoGeneratedComponentTypes: string[];
 export interface ComponentMetadata {
     dir: string;
     isToplevel: boolean;
@@ -25,6 +27,8 @@ export declare const Components: Record<string, ComponentMetadata>;
 export declare const userFacingToInternalType: Record<string, string>;
 export declare const internalTypeToUserFacing: Record<string, string>;
 export declare const metafileExtension = "-hsmeta.json";
+export declare const packageJson = "package.json";
+export declare const packageLockJson = "package-lock.json";
 export declare const allowedAppSubComponentsDirs: string[];
 export declare const allowedThemeSubComponentsDirs: string[];
 export declare const ProjectStructure: {

package/src/lib/constants.js

@@ -33,18 +33,18 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.allowedSubComponentDirectories = exports.allowedComponentDirectories = exports.ProjectStructure = exports.allowedThemeSubComponentsDirs = exports.allowedAppSubComponentsDirs = exports.metafileExtension = exports.internalTypeToUserFacing = exports.userFacingToInternalType = exports.Components = exports.WorkflowActionsKey = exports.WebhooksKey = exports.VideoConferencingKey = exports.TimelineEventsKey = exports.MediaBridgeKey = exports.MarketingEventsKey = exports.SettingsKey = exports.FunctionsKey = exports.CardsKey = exports.CallingKey = exports.AppObjectAssociationKey = exports.AppObjectKey = exports.ThemeKey = exports.AppKey = void 0;
+exports.allowedSubComponentDirectories = exports.allowedComponentDirectories = exports.ProjectStructure = exports.allowedThemeSubComponentsDirs = exports.allowedAppSubComponentsDirs = exports.packageLockJson = exports.packageJson = exports.metafileExtension = exports.internalTypeToUserFacing = exports.userFacingToInternalType = exports.Components = exports.AutoGeneratedComponentTypes = exports.AppFunctionsPackageKey = exports.WorkflowActionsKey = exports.WebhooksKey = exports.VideoConferencingKey = exports.TimelineEventsKey = exports.MediaBridgeKey = exports.MarketingEventsKey = exports.SettingsKey = exports.CardsKey = exports.CallingKey = exports.AppObjectAssociationKey = exports.AppObjectKey = exports.AppFunctionsKey = exports.ThemeKey = exports.AppKey = void 0;
 // Top Level Component types
 const path = __importStar(require("path"));
 // Component types
 exports.AppKey = 'app';
 exports.ThemeKey = 'theme';
 // Sub-Component types
+exports.AppFunctionsKey = 'app-function';
 exports.AppObjectKey = 'app-object';
 exports.AppObjectAssociationKey = 'app-object-association';
 exports.CallingKey = 'calling';
 exports.CardsKey = 'card';
-exports.FunctionsKey = 'function';
 exports.SettingsKey = 'settings';
 exports.MarketingEventsKey = 'marketing-event';
 exports.MediaBridgeKey = 'media-bridge';
@@ -52,6 +52,9 @@ exports.TimelineEventsKey = 'timeline-event';
 exports.VideoConferencingKey = 'video-conferencing';
 exports.WebhooksKey = 'webhooks';
 exports.WorkflowActionsKey = 'workflow-action';
+// Auto-generated component types
+exports.AppFunctionsPackageKey = 'serverless-package';
+exports.AutoGeneratedComponentTypes = [exports.AppFunctionsPackageKey];
 const TopLevelComponentFields = {
     isToplevel: true,
     userFriendlyType: 'component',
@@ -99,10 +102,10 @@ exports.Components = {
         userFriendlyName: 'Card',
         ...SubComponentFields,
     },
-    [exports.FunctionsKey]: {
+    [exports.AppFunctionsKey]: {
         dir: 'functions',
         parentComponent: exports.AppKey,
-        userFriendlyName: 'Function',
+        userFriendlyName: 'App Function',
         ...SubComponentFields,
     },
     [exports.SettingsKey]: {
@@ -156,6 +159,8 @@ exports.userFacingToInternalType = {
 };
 exports.internalTypeToUserFacing = Object.fromEntries(Object.entries(exports.userFacingToInternalType).map(([key, value]) => [value, key]));
 exports.metafileExtension = '-hsmeta.json';
+exports.packageJson = 'package.json';
+exports.packageLockJson = 'package-lock.json';
 function getSubComponentDirsForParentType(parentComponent) {
     return Object.values(exports.Components).reduce((acc, item) => {
         if (item.parentComponent === parentComponent) {

package/src/lib/transform.d.ts

@@ -1,5 +1,10 @@
-import { FileParseResult, IntermediateRepresentation, Transformation } from './types';
+import { Dependencies, FileParseResult, IntermediateRepresentation, Transformation, TranslationContext } from './types';
+export declare function mapToInternalType(type: string): string;
 export declare function mapToUserFacingType(type: string): string;
 export declare function mapToUserFriendlyName(internalType: string): string;
-export declare function transform(fileParseResults: FileParseResult[]): Transformation[];
+export declare function transform(fileParseResults: FileParseResult[], translationContext: TranslationContext): Transformation[];
 export declare function getIntermediateRepresentation(transformations: Transformation[], skipValidation: boolean | undefined): IntermediateRepresentation;
+export declare function generateServerlessPackageComponent(appFunctionsDirectory: string, translationContext: TranslationContext, componentDeps: Dependencies): {
+    uid: string;
+    transformation: Transformation;
+};

package/src/lib/transform.js

@@ -1,12 +1,19 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapToInternalType = mapToInternalType;
 exports.mapToUserFacingType = mapToUserFacingType;
 exports.mapToUserFriendlyName = mapToUserFriendlyName;
 exports.transform = transform;
 exports.getIntermediateRepresentation = getIntermediateRepresentation;
+exports.generateServerlessPackageComponent = generateServerlessPackageComponent;
 const constants_1 = require("./constants");
 const copy_1 = require("../lang/copy");
-function calculateComponentDeps(fileValidationResult, parentComponents, appObjects) {
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+function calculateComponentDeps(fileValidationResult, parentComponents, appObjects, appFunctionsPackageUid) {
     let dependencies = {};
     // If there are dependencies in the config file, pass them through
     if (!fileValidationResult.content?.dependencies) {
@@ -22,6 +29,9 @@ function calculateComponentDeps(fileValidationResult, parentComponents, appObjec
         if (type !== constants_1.AppObjectKey) {
             dependencies.allAppObjects = appObjects;
         }
+        if (type === constants_1.AppFunctionsKey && appFunctionsPackageUid) {
+            dependencies.serverlessPackage = appFunctionsPackageUid;
+        }
     }
     return dependencies;
 }
@@ -37,23 +47,44 @@ function mapToUserFacingType(type) {
 function mapToUserFriendlyName(internalType) {
     return constants_1.Components[mapToUserFacingType(internalType)]?.userFriendlyName || '';
 }
-function transform(fileParseResults) {
+function transform(fileParseResults, translationContext) {
     const parentTypes = Object.keys(constants_1.ProjectStructure);
     const parentComponents = {};
-    const appObjects = [];
+    const allAppObjects = [];
+    let appUid = '';
+    let appFunctionsDirectory;
     // Compute the parent components, so we can add them as dependencies to the child components
     fileParseResults.forEach(file => {
         if (file.content?.type && parentTypes.includes(file.content.type)) {
+            if (file.content.type === constants_1.AppKey) {
+                appUid = file.content.uid;
+            }
             parentComponents[file.content.type] = file.content.uid;
         }
         if (file.content?.type === constants_1.AppObjectKey) {
-            appObjects.push(file.content.uid);
+            allAppObjects.push(file.content.uid);
+        }
+        if (file.content?.type === constants_1.AppFunctionsKey) {
+            appFunctionsDirectory = path_1.default.dirname(file.file);
         }
     });
-    return fileParseResults.map((currentFile) => {
+    const autoGeneratedComponents = [];
+    let serverlessPackageUid;
+    if (appFunctionsDirectory) {
+        const { uid, transformation } = generateServerlessPackageComponent(appFunctionsDirectory, translationContext, {
+            app: appUid,
+            allAppObjects,
+        });
+        serverlessPackageUid = uid;
+        autoGeneratedComponents.push(transformation);
+    }
+    const transformations = fileParseResults.map((currentFile) => {
         if (!currentFile.content) {
-            currentFile.errors?.push(`File content is missing for ${currentFile.file}`);
-            return { intermediateRepresentation: null, fileParseResult: currentFile };
+            currentFile.errors?.push(copy_1.errorMessages.project.fileContentMissingFor(currentFile.file));
+            return {
+                intermediateRepresentation: null,
+                fileParseResult: currentFile,
+            };
         }
         const { config, uid, type } = currentFile.content;
         return {
@@ -61,13 +92,14 @@ function transform(fileParseResults) {
                 uid,
                 config,
                 componentType: mapToInternalType(type),
-                componentDeps: calculateComponentDeps(currentFile, parentComponents, appObjects),
+                componentDeps: calculateComponentDeps(currentFile, parentComponents, allAppObjects, serverlessPackageUid),
                 metaFilePath: currentFile.file,
                 files: {},
             },
             fileParseResult: currentFile,
         };
     });
+    return [...autoGeneratedComponents, ...transformations];
 }
 function getIntermediateRepresentation(transformations, skipValidation) {
     const nodes = transformations.reduce((acc, current) => {
@@ -99,3 +131,35 @@ function getIntermediateRepresentation(transformations, skipValidation) {
         intermediateNodesIndexedByUid: nodes,
     };
 }
+function generateServerlessPackageComponent(appFunctionsDirectory, translationContext, componentDeps) {
+    const packageFile = path_1.default.join(appFunctionsDirectory, constants_1.packageJson);
+    const packageLockFile = path_1.default.join(appFunctionsDirectory, constants_1.packageLockJson);
+    const { projectSourceDir } = translationContext;
+    const appFunctionsPackageFile = path_1.default.join(projectSourceDir, packageFile);
+    if (!fs_1.default.existsSync(appFunctionsPackageFile)) {
+        throw new Error(copy_1.errorMessages.project.noPackageJsonForServerless(appFunctionsPackageFile));
+    }
+    const uid = `hubspot-serverless-package-uid`;
+    return {
+        uid,
+        transformation: {
+            fileParseResult: {
+                file: '',
+                errors: [],
+            },
+            intermediateRepresentation: {
+                uid,
+                componentType: mapToInternalType(constants_1.AppFunctionsPackageKey),
+                config: {
+                    packageFile,
+                    packageLockfile: fs_1.default.existsSync(path_1.default.join(projectSourceDir, packageLockFile))
+                        ? packageLockFile
+                        : undefined,
+                },
+                componentDeps,
+                metaFilePath: packageFile,
+                files: {},
+            },
+        },
+    };
+}

package/src/lib/validation.js

@@ -14,6 +14,12 @@ const transform_1 = require("./transform");
 const ajv_formats_1 = __importDefault(require("ajv-formats"));
 const uid_1 = require("./uid");
 function validateIntermediateRepresentationNode(schema, transformation, irNode, index, 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) {
         return {
             valid: false,