@hubspot/project-parsing-lib 0.0.1 → 0.0.3-experimental.0

package/package.json

@@ -1,10 +1,11 @@
 {
     "name": "@hubspot/project-parsing-lib",
-    "version": "0.0.1",
+    "version": "0.0.3-experimental.0",
     "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.1.0",
         "@inquirer/prompts": "^7.1.0",
         "@types/jest": "^29.5.14",
         "@types/semver": "^7.5.8",
@@ -22,17 +23,21 @@
         "typescript": "^5.6.2"
     },
     "dependencies": {
-        "@hubspot/local-dev-lib": "^3.1.0",
         "ajv": "^8.17.1",
         "ajv-draft-04": "^1.0.0"
     },
+    "peerDependencies": {
+        "@hubspot/local-dev-lib": "^3.1.0"
+    },
     "scripts": {
         "build": "ts-node ./scripts/build.ts",
         "lint": "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",
-        "release": "yarn ts-node ./scripts/release.ts release"
+        "release": "yarn ts-node ./scripts/release.ts release",
+        "acceptance-test": "yarn --cwd=./acceptance-tests test",
+        "update-north-star": "git submodule update --remote --merge"
     },
     "engines": {
         "node": ">=18"

package/src/lib/constants.d.ts

@@ -15,6 +15,7 @@ interface ComponentMetadata {
     parentComponent?: string;
 }
 export declare const Components: Record<string, ComponentMetadata>;
+export declare const externalTypeToInternalType: Record<string, string>;
 export declare const metafileExtension = "-hsmeta.json";
 export declare const allowedAppSubComponentsDirs: string[];
 export declare const allowedThemeSubComponentsDirs: string[];

package/src/lib/constants.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.allowedSubComponentDirectories = exports.allowedComponentDirectories = exports.ProjectStructure = exports.allowedThemeSubComponentsDirs = exports.allowedAppSubComponentsDirs = exports.metafileExtension = 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;
+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
 const path = __importStar(require("path"));
 // Component types
@@ -85,6 +85,9 @@ exports.Components = {
         parentComponent: exports.AppKey,
     },
 };
+exports.externalTypeToInternalType = {
+    [exports.AppKey]: 'application',
+};
 exports.metafileExtension = '-hsmeta.json';
 function getSubComponentDirsForParentType(parentComponent) {
     return Object.values(exports.Components).reduce((acc, item) => {

package/src/lib/files.js

@@ -15,21 +15,17 @@ async function loadHsMetaFiles(translationContext) {
 async function locateHsMetaFiles(translationContext) {
     const { projectSourceDir } = translationContext;
     return (await (0, fs_1.walk)(projectSourceDir, ['node_modules'])).reduce((metaFiles, file) => {
-        // Ignore the node_modules directory
-        if (file.includes('node_modules')) {
+        if (!file.endsWith(constants_1.metafileExtension)) {
             return metaFiles;
         }
         const pathRelativeToProjectSrcDir = path_1.default.relative(projectSourceDir, file);
-        if (!pathRelativeToProjectSrcDir.endsWith(constants_1.metafileExtension)) {
-            return metaFiles;
-        }
         const { dir: metaFileDir } = path_1.default.parse(pathRelativeToProjectSrcDir);
-        const parent = metaFileDir.split(path_1.default.sep)[0];
+        const parentDirectory = metaFileDir.split(path_1.default.sep)[0];
         if (constants_1.allowedComponentDirectories.includes(metaFileDir)) {
             metaFiles.push({ file });
         }
         else if (constants_1.allowedSubComponentDirectories.includes(metaFileDir)) {
-            metaFiles.push({ file, parent });
+            metaFiles.push({ file, parentDirectory });
         }
         else {
             console.warn(`Skipping ${pathRelativeToProjectSrcDir} as it is not in a valid directory`);
@@ -46,7 +42,7 @@ async function parseHsMetaFiles(metaFileLocations, translationContext) {
 function loadFile(metaFileLocation, translationContext) {
     const { projectSourceDir } = translationContext;
     return new Promise(async (resolve) => {
-        const { file, parent } = metaFileLocation;
+        const { file, parentDirectory } = metaFileLocation;
         fs_2.default.readFile(file, 'utf-8', (err, content) => {
             if (err) {
                 return resolve({
@@ -57,7 +53,7 @@ function loadFile(metaFileLocation, translationContext) {
             resolve({
                 file: path_1.default.relative(projectSourceDir, file),
                 content,
-                parent,
+                parentDirectory,
                 errors: [],
             });
         });

package/src/lib/schemas.js

@@ -2,9 +2,8 @@
 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");
 async function getIntermediateRepresentationSchema(translationContext) {
-    // This is just a placeholder that resolves the hardcoded object until we
-    // implement the actual logic to load the schemas from the backend
     try {
         const { accountId } = translationContext;
         const { data } = await http_1.http.get(accountId, {
@@ -14,6 +13,9 @@ async function getIntermediateRepresentationSchema(translationContext) {
         return data;
     }
     catch (e) {
+        if ((0, index_1.isHubSpotHttpError)(e)) {
+            throw e;
+        }
         throw new Error('Failed to fetch schemas', { cause: e });
     }
 }

package/src/lib/transform.js

@@ -7,11 +7,16 @@ function calculateComponentDeps(fileValidationResult, parentComponents) {
     return {
         ...fileValidationResult.content?.dependencies,
         // If the file has a parent, add it as a dependency
-        ...(fileValidationResult.parent
-            ? { upstreamBuildArtifact: parentComponents[fileValidationResult.parent] }
+        ...(fileValidationResult.parentDirectory
+            ? {
+                app: parentComponents[fileValidationResult.parentDirectory],
+            }
             : {}),
     };
 }
+function mapToInternalType(type) {
+    return (constants_1.externalTypeToInternalType[type] || type || '').toUpperCase();
+}
 function transform(fileParseResults) {
     const parentTypes = Object.keys(constants_1.ProjectStructure);
     // Compute the parent components, so we can add them as dependencies to the child components
@@ -26,12 +31,12 @@ function transform(fileParseResults) {
             currentFile.errors?.push(`File content is missing for ${currentFile.file}`);
             return { intermediateRepresentation: null, fileParseResult: currentFile };
         }
-        const { config, uid } = currentFile.content;
+        const { config, uid, type } = currentFile.content;
         return {
             intermediateRepresentation: {
                 uid,
                 config,
-                componentType: currentFile.content?.type.toUpperCase() || '',
+                componentType: mapToInternalType(type),
                 componentDeps: calculateComponentDeps(currentFile, parentComponents),
                 files: {},
             },
@@ -41,10 +46,16 @@ function transform(fileParseResults) {
 }
 function getIntermediateRepresentation(transformations) {
     const nodes = transformations.reduce((acc, current) => {
+        const { uid } = current.intermediateRepresentation;
+        if (acc[uid]) {
+            const duplicates = transformations
+                .filter(t => t.intermediateRepresentation?.uid === uid)
+                .map(t => t.fileParseResult.file);
+            throw new Error(`Duplicate uid '${uid}' found in ${duplicates.join(', ')}`);
+        }
         return {
             ...acc,
-            [current.intermediateRepresentation
-                .uid]: current.intermediateRepresentation,
+            [uid]: current.intermediateRepresentation,
         };
     }, {});
     return {

package/src/lib/types.d.ts

@@ -6,7 +6,7 @@ export interface Components {
 }
 export interface FileActionResult {
     file: string;
-    parent?: string;
+    parentDirectory?: string;
     errors: string[];
 }
 export interface FileLoadResult extends FileActionResult {