@hubspot/project-parsing-lib 0.18.0 → 0.19.0-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/project-parsing-lib",
-    "version": "0.18.0",
+    "version": "0.19.0-beta.0",
     "description": "Parsing library for converting projects directory structures to their intermediate representation",
     "license": "Apache-2.0",
     "type": "module",
@@ -107,7 +107,7 @@
         }
     },
     "devDependencies": {
-        "@hubspot/npm-scripts": "0.0.6",
+        "@hubspot/npm-scripts": "0.3.0",
         "@inquirer/prompts": "^7.1.0",
         "@types/node": "^24.9.0",
         "@types/npm-packlist": "7.0.3",
@@ -126,7 +126,7 @@
         "vitest": "^2.1.9"
     },
     "dependencies": {
-        "@hubspot/local-dev-lib": "4.0.4",
+        "@hubspot/local-dev-lib": "5.9.0",
         "@npmcli/map-workspaces": "4.0.2",
         "ajv": "8.18.0",
         "ajv-formats": "3.0.1",
@@ -136,6 +136,11 @@
     "resolutions": {
         "ajv-formats/ajv": "8.18.0"
     },
+    "overrides": {
+        "ajv-formats": {
+            "ajv": "8.18.0"
+        }
+    },
     "scripts": {
         "build": "tsx ./scripts/build.ts",
         "lint": "echo 'Linting is disabled for Blazar'",

package/src/exports/translate.d.ts

@@ -1,3 +1,4 @@
 export { translate, translateForLocalDev } from '../lib/translate.js';
+export type { TranslateResult, TranslateForLocalDevResult, } from '../lib/translate.js';
 export { isTranslationError, type TranslationError } from '../lib/errors.js';
 export type { IntermediateRepresentation, IntermediateRepresentationLocalDev, IntermediateRepresentationNodeLocalDev, IntermediateRepresentationNode, TranslationContext, TranslationOptions, TranslationOptionsLocalDev, ComponentMeta, ComponentPermissions, } from '../lib/types.js';

package/src/lang/copy.d.ts

@@ -49,9 +49,6 @@ export declare function getMissingRequiredFieldError(field: string): string;
 export declare function getFailedToFetchSchemasError(): string;
 export declare function getUnsupportedTypeError(type: string): string;
 export declare const logMessages: {
-    files: {
-        skippingPath: (path: string) => string;
-    };
     workspaces: {
         cannotAccessDirectory: (dir: string, e: unknown) => string;
     };

package/src/lang/copy.js

@@ -64,9 +64,6 @@ export function getUnsupportedTypeError(type) {
     return errorMessages.validation.unsupportedType(type);
 }
 export const logMessages = {
-    files: {
-        skippingPath: (path) => `Skipping ${path} as it is not in a valid directory`,
-    },
     workspaces: {
         cannotAccessDirectory: (dir, e) => `Cannot access directory ${dir}: ${e}`,
     },

package/src/lib/files.d.ts

@@ -1,13 +1,19 @@
-import { FileParseResult, TranslationContext, HsProfileFile } from './types.js';
+import { FileParseResult, HsProfileFile, TranslationContext } from './types.js';
 export type MetaFileLocation = {
     file: string;
     parentDirectory?: string;
 };
 export declare function loadHsProfileFile(projectSourceDir: string, profile: string): HsProfileFile;
 export declare function getAllHsProfiles(projectSourceDir: string): Promise<string[]>;
-export declare function loadHsMetaFiles(translationContext: TranslationContext): Promise<FileParseResult[]>;
-export declare function locateHsMetaFiles(projectSourceDir: string, options?: {
-    silent: boolean;
-}): Promise<MetaFileLocation[]>;
+export type LoadHsMetaFilesResult = {
+    results: FileParseResult[];
+    skippedFiles: string[];
+};
+export declare function loadHsMetaFiles(translationContext: TranslationContext): Promise<LoadHsMetaFilesResult>;
+export type LocateHsMetaFilesResult = {
+    metaFiles: MetaFileLocation[];
+    skippedFiles: string[];
+};
+export declare function locateHsMetaFiles(projectSourceDir: string): Promise<LocateHsMetaFilesResult>;
 export declare function projectContainsHsMetaFiles(projectSourceDir: string): Promise<boolean>;
 export declare function convertPathToPosixPath(filepath: string): string;

package/src/lib/files.js

@@ -1,9 +1,8 @@
 import fs from 'fs';
 import path from 'path';
 import { walk } from '@hubspot/local-dev-lib/fs';
-import { ALLOWED_COMPONENT_DIRECTORIES, ALLOWED_SUB_COMPONENT_DIRECTORIES, METAFILE_EXTENSION, ALLOWED_TOP_LEVEL_FIELDS, } from './constants.js';
-import { errorMessages, logMessages } from '../lang/copy.js';
-import { logger } from '@hubspot/local-dev-lib/logger';
+import { ALLOWED_COMPONENT_DIRECTORIES, ALLOWED_SUB_COMPONENT_DIRECTORIES, ALLOWED_TOP_LEVEL_FIELDS, METAFILE_EXTENSION, } from './constants.js';
+import { errorMessages } from '../lang/copy.js';
 import { getHsProfileFilename, getHsProfileName, getIsProfileFile, } from './profiles.js';
 export function loadHsProfileFile(projectSourceDir, profile) {
     if (!profile) {
@@ -33,13 +32,19 @@ export function getAllHsProfiles(projectSourceDir) {
     });
 }
 export async function loadHsMetaFiles(translationContext) {
-    const metaFiles = await locateHsMetaFiles(translationContext.projectSourceDir);
-    return parseHsMetaFiles(metaFiles, translationContext);
+    const { metaFiles, skippedFiles } = await locateHsMetaFiles(translationContext.projectSourceDir);
+    return {
+        results: await parseHsMetaFiles(metaFiles, translationContext),
+        skippedFiles,
+    };
 }
-export async function locateHsMetaFiles(projectSourceDir, options = { silent: false }) {
-    return (await walk(projectSourceDir, ['node_modules'])).reduce((metaFiles, file) => {
+export async function locateHsMetaFiles(projectSourceDir) {
+    const metaFiles = [];
+    const skippedFiles = [];
+    const metaFileCandidates = await walk(projectSourceDir, ['node_modules']);
+    for (const file of metaFileCandidates) {
         if (!file.endsWith(METAFILE_EXTENSION)) {
-            return metaFiles;
+            continue;
         }
         const pathRelativeToProjectSrcDir = path.relative(projectSourceDir, file);
         const { dir: metaFileDir } = path.parse(pathRelativeToProjectSrcDir);
@@ -51,12 +56,10 @@ export async function locateHsMetaFiles(projectSourceDir, options = { silent: fa
             metaFiles.push({ file, parentDirectory });
         }
         else {
-            if (!options.silent) {
-                logger.warn(logMessages.files.skippingPath(pathRelativeToProjectSrcDir));
-            }
+            skippedFiles.push(pathRelativeToProjectSrcDir);
         }
-        return metaFiles;
-    }, []);
+    }
+    return { metaFiles, skippedFiles };
 }
 async function parseHsMetaFiles(metaFileLocations, translationContext) {
     const fileLoadResults = await Promise.all(metaFileLocations.map(fileLocation => {

package/src/lib/profiles.js

@@ -95,15 +95,18 @@ export function applyHsProfileVariables(fileParseResults, hsProfileContents) {
     const profileVariables = getHsProfileVariables(hsProfileContents);
     return fileParseResults.map(fileParseResult => {
         const { content, file } = fileParseResult;
-        // Only process files that have content with a config section
-        if (!content?.config) {
+        if (!content) {
             return fileParseResult;
         }
-        const configWithVariablesReplaced = replaceVariablesInValue(content.config, file, profileVariables);
+        const uidWithVariablesReplaced = interpolate(file, content.uid, profileVariables);
+        const configWithVariablesReplaced = content.config
+            ? replaceVariablesInValue(content.config, file, profileVariables)
+            : content.config;
         return {
             ...fileParseResult,
             content: {
                 ...content,
+                uid: uidWithVariablesReplaced,
                 config: configWithVariablesReplaced,
             },
         };

package/src/lib/project.js

@@ -7,7 +7,7 @@ export async function getProjectMetadata(projectSrcDir) {
     const components = {};
     let metafiles = [];
     if (fs.existsSync(projectSrcDir)) {
-        metafiles = await locateHsMetaFiles(projectSrcDir, { silent: true });
+        ({ metaFiles: metafiles } = await locateHsMetaFiles(projectSrcDir));
     }
     const seenComponentPaths = new Map();
     Object.keys(Components).forEach(componentType => {

package/src/lib/translate.d.ts

@@ -1,3 +1,11 @@
 import { IntermediateRepresentation, IntermediateRepresentationLocalDev, TranslationContext, TranslationOptions, TranslationOptionsLocalDev } from './types.js';
-export declare function translate(translationContext: TranslationContext, translationOptions?: TranslationOptions): Promise<IntermediateRepresentation>;
-export declare function translateForLocalDev(translationContext: TranslationContext, translationOptions?: TranslationOptionsLocalDev): Promise<IntermediateRepresentationLocalDev>;
+export interface TranslateResult {
+    intermediateRepresentation: IntermediateRepresentation;
+    skippedHsMetaFiles: string[];
+}
+export interface TranslateForLocalDevResult {
+    intermediateRepresentation: IntermediateRepresentationLocalDev;
+    skippedHsMetaFiles: string[];
+}
+export declare function translate(translationContext: TranslationContext, translationOptions?: TranslationOptions): Promise<TranslateResult>;
+export declare function translateForLocalDev(translationContext: TranslationContext, translationOptions?: TranslationOptionsLocalDev): Promise<TranslateForLocalDevResult>;

package/src/lib/translate.js

@@ -13,7 +13,7 @@ export async function translate(translationContext, translationOptions = default
         !isSupportedPlatformVersion(translationContext.platformVersion)) {
         throw new Error(errorMessages.project.unsupportedPlatformVersion(translationContext.platformVersion));
     }
-    const metafileContents = await loadHsMetaFiles(translationContext);
+    const { results: metafileContents, skippedFiles } = await loadHsMetaFiles(translationContext);
     if (metafileContents.length === 0) {
         throw new Error(errorMessages.project.noHsMetaFiles);
     }
@@ -27,7 +27,7 @@ export async function translate(translationContext, translationOptions = default
     if (!skipValidation) {
         await validateIntermediateRepresentation(intermediateRepresentation, transformations, translationContext);
     }
-    return intermediateRepresentation;
+    return { intermediateRepresentation, skippedHsMetaFiles: skippedFiles };
 }
 export async function translateForLocalDev(translationContext, translationOptions) {
     const { skipValidation, profile, projectNodesAtLastUpload } = translationOptions || {};
@@ -35,7 +35,7 @@ export async function translateForLocalDev(translationContext, translationOption
         !isSupportedPlatformVersion(translationContext.platformVersion)) {
         throw new Error(errorMessages.project.unsupportedPlatformVersion(translationContext.platformVersion));
     }
-    const metafileContents = await loadHsMetaFiles(translationContext);
+    const { results: metafileContents, skippedFiles } = await loadHsMetaFiles(translationContext);
     if (metafileContents.length === 0) {
         throw new Error(errorMessages.project.noHsMetaFiles);
     }
@@ -53,10 +53,13 @@ export async function translateForLocalDev(translationContext, translationOption
     }
     const profileData = getLocalDevProfileData(baseIntermediateRepresentation.profileData?.vars.profileVariables);
     return {
-        intermediateNodesIndexedByUid: {
-            ...projectNodes,
-            ...projectNodesWithErrors,
+        intermediateRepresentation: {
+            intermediateNodesIndexedByUid: {
+                ...projectNodes,
+                ...projectNodesWithErrors,
+            },
+            profileData,
         },
-        profileData,
+        skippedHsMetaFiles: skippedFiles,
     };
 }