@hubspot/project-parsing-lib 0.2.0-beta.0 → 0.2.0-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/project-parsing-lib",
-    "version": "0.2.0-beta.0",
+    "version": "0.2.0-beta.1",
     "description": "Parsing library for converting projects directory structures to their intermediate representation",
     "license": "Apache-2.0",
     "main": "src/index.js",
@@ -33,7 +33,7 @@
         "build": "ts-node ./scripts/build.ts",
         "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",
+        "local-dev": "yarn build && cd dist && yarn link && cd .. && 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",

package/src/index.d.ts

@@ -1,9 +1,11 @@
 import { IntermediateRepresentation, IntermediateRepresentationNode, IntermediateRepresentationLocalDev, TranslationContext, TranslationOptions, IntermediateRepresentationNodeLocalDev } from './lib/types';
 import { ValidateFunction, AnySchema, ErrorObject } from 'ajv/dist/2020';
 export declare function translate(translationContext: TranslationContext, translationOptions?: TranslationOptions): Promise<IntermediateRepresentation>;
-export declare function translateForLocalDev(translationContext: TranslationContext): Promise<IntermediateRepresentationLocalDev>;
+export declare function translateForLocalDev(translationContext: TranslationContext, translationOptions?: Pick<TranslationOptions, 'profile'>): Promise<IntermediateRepresentationLocalDev>;
 export { isTranslationError } from './lib/errors';
 export { IntermediateRepresentation, IntermediateRepresentationNode, IntermediateRepresentationLocalDev, IntermediateRepresentationNodeLocalDev, TranslationContext, };
+export { getHsProfileFilename } from './lib/profiles';
+export { loadHsProfileFile, getAllHsProfiles } from './lib/files';
 export { migrate } from './lib/migrate';
 export { validateUid } from './lib/uid';
 export { mapToUserFriendlyName, mapToInternalType } from './lib/transform';

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.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.validateUid = exports.migrate = exports.isTranslationError = void 0;
+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.validateUid = exports.migrate = exports.getAllHsProfiles = exports.loadHsProfileFile = exports.getHsProfileFilename = exports.isTranslationError = void 0;
 exports.translate = translate;
 exports.translateForLocalDev = translateForLocalDev;
 const files_1 = require("./lib/files");
@@ -20,7 +20,11 @@ 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, translationContext);
+    let hsProfileContents;
+    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, skipValidation);
     // Remove once extensions and serverless functions are supported
     if (!skipValidation) {
@@ -28,8 +32,11 @@ async function translate(translationContext, translationOptions = defaultOptions
     }
     return intermediateRepresentation;
 }
-async function translateForLocalDev(translationContext) {
-    const IR = await translate(translationContext, { skipValidation: true });
+async function translateForLocalDev(translationContext, translationOptions) {
+    const IR = await translate(translationContext, {
+        skipValidation: true,
+        profile: translationOptions?.profile,
+    });
     const localDevIr = {
         intermediateNodesIndexedByUid: {},
     };
@@ -48,6 +55,11 @@ async function translateForLocalDev(translationContext) {
 }
 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; } });
+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; } });
 var migrate_1 = require("./lib/migrate");
 Object.defineProperty(exports, "migrate", { enumerable: true, get: function () { return migrate_1.migrate; } });
 var uid_1 = require("./lib/uid");

package/src/lang/copy.d.ts

@@ -12,6 +12,12 @@ export declare const errorMessages: {
         noPackageJsonForServerless: (appFunctionsPackageFile: string) => string;
         fileContentMissingFor: (file: string) => string;
     };
+    profile: {
+        noProfileSpecified: string;
+        failedToLoadHsProfile: (profile: string) => string;
+        missingValue: (key: string, file: string) => string;
+        invalidValue: (key: string) => string;
+    };
     validation: {
         errorWithFileHeader: (file: string, errors: string[]) => string;
         missingRequiredField: (field: string) => string;

package/src/lang/copy.js

@@ -23,6 +23,12 @@ exports.errorMessages = {
         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}`,
     },
+    profile: {
+        noProfileSpecified: 'No profile specified',
+        failedToLoadHsProfile: (profile) => `Failed to load profile ${profile}`,
+        missingValue: (key, file) => `Missing value for ${key} in ${file}. Add ${key} to your profile variables.`,
+        invalidValue: (key) => `Invalid value for ${key}. Value must be a string, number, or boolean.`,
+    },
     validation: {
         errorWithFileHeader: (file, errors) => `\n\nEncountered the following errors for ${file}:\n\t- ${errors.join('\n\t- ')}`,
         missingRequiredField: (field) => `Missing required field: '${field}'`,

package/src/lib/constants.d.ts

@@ -27,6 +27,7 @@ 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 profileFilePrefix = "hsprofile";
 export declare const hsProjectJsonFilename = "hsproject.json";
 export declare const packageJson = "package.json";
 export declare const packageLockJson = "package-lock.json";

package/src/lib/constants.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.allowedSubComponentDirectories = exports.allowedComponentDirectories = exports.ProjectStructure = exports.allowedThemeSubComponentsDirs = exports.allowedAppSubComponentsDirs = exports.packageLockJson = exports.packageJson = exports.hsProjectJsonFilename = 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;
+exports.allowedSubComponentDirectories = exports.allowedComponentDirectories = exports.ProjectStructure = 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.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
@@ -159,6 +159,7 @@ exports.userFacingToInternalType = {
 };
 exports.internalTypeToUserFacing = Object.fromEntries(Object.entries(exports.userFacingToInternalType).map(([key, value]) => [value, key]));
 exports.metafileExtension = '-hsmeta.json';
+exports.profileFilePrefix = 'hsprofile';
 exports.hsProjectJsonFilename = 'hsproject.json';
 exports.packageJson = 'package.json';
 exports.packageLockJson = 'package-lock.json';

package/src/lib/files.d.ts

@@ -1,2 +1,4 @@
-import { FileParseResult, TranslationContext } from './types';
+import { FileParseResult, TranslationContext, HsProfileFile } from './types';
+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[]>;

package/src/lib/files.js

@@ -3,20 +3,50 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadHsProfileFile = loadHsProfileFile;
+exports.getAllHsProfiles = getAllHsProfiles;
 exports.loadHsMetaFiles = loadHsMetaFiles;
-const fs_1 = require("@hubspot/local-dev-lib/fs");
+const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
+const fs_2 = require("@hubspot/local-dev-lib/fs");
 const constants_1 = require("./constants");
-const fs_2 = __importDefault(require("fs"));
 const copy_1 = require("../lang/copy");
 const logger_1 = require("@hubspot/local-dev-lib/logger");
+const profiles_1 = require("./profiles");
+function loadHsProfileFile(projectSourceDir, profile) {
+    if (!profile) {
+        throw new Error(copy_1.errorMessages.profile.noProfileSpecified);
+    }
+    const profileFile = (0, profiles_1.getHsProfileFilename)(profile);
+    const profileFilepath = path_1.default.join(projectSourceDir, profileFile);
+    let hsProfile;
+    try {
+        hsProfile = JSON.parse(fs_1.default.readFileSync(profileFilepath, 'utf8'));
+    }
+    catch (_e) {
+        throw new Error(copy_1.errorMessages.profile.failedToLoadHsProfile(profileFile));
+    }
+    return hsProfile;
+}
+function getAllHsProfiles(projectSourceDir) {
+    return new Promise((resolve, _reject) => {
+        fs_1.default.readdir(projectSourceDir, { recursive: false, withFileTypes: true }, (err, files) => {
+            if (err) {
+                return resolve([]);
+            }
+            return resolve(files
+                .filter(file => file.isFile() && (0, profiles_1.getIsProfileFile)(file.name))
+                .map(file => (0, profiles_1.getHsProfileName)(file.name)));
+        });
+    });
+}
 async function loadHsMetaFiles(translationContext) {
     const metaFiles = await locateHsMetaFiles(translationContext);
     return parseHsMetaFiles(metaFiles, translationContext);
 }
 async function locateHsMetaFiles(translationContext) {
     const { projectSourceDir } = translationContext;
-    return (await (0, fs_1.walk)(projectSourceDir, ['node_modules'])).reduce((metaFiles, file) => {
+    return (await (0, fs_2.walk)(projectSourceDir, ['node_modules'])).reduce((metaFiles, file) => {
         if (!file.endsWith(constants_1.metafileExtension)) {
             return metaFiles;
         }
@@ -45,7 +75,7 @@ function loadFile(metaFileLocation, translationContext) {
     const { projectSourceDir } = translationContext;
     return new Promise(async (resolve) => {
         const { file, parentDirectory } = metaFileLocation;
-        fs_2.default.readFile(file, 'utf-8', (err, content) => {
+        fs_1.default.readFile(file, 'utf-8', (err, content) => {
             if (err) {
                 return resolve({
                     file,

package/src/lib/profiles.d.ts

@@ -0,0 +1,5 @@
+import { FileParseResult, HsProfileFile } from './types';
+export declare function getIsProfileFile(filename: string): boolean;
+export declare function getHsProfileFilename(profileName: string): string;
+export declare function getHsProfileName(profileFilename: string): string;
+export declare function applyHsProfileVariables(fileParseResults: FileParseResult[], hsProfileContents: HsProfileFile): FileParseResult[];

package/src/lib/profiles.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getIsProfileFile = getIsProfileFile;
+exports.getHsProfileFilename = getHsProfileFilename;
+exports.getHsProfileName = getHsProfileName;
+exports.applyHsProfileVariables = applyHsProfileVariables;
+const constants_1 = require("./constants");
+const copy_1 = require("../lang/copy");
+const profileFilenameRegex = new RegExp(`^${constants_1.profileFilePrefix}\\.([^.]+)\\.json$`);
+const profileInsertRegex = /\${(.*?)}/g;
+function getIsProfileFile(filename) {
+    return profileFilenameRegex.test(filename);
+}
+function getHsProfileFilename(profileName) {
+    return `${constants_1.profileFilePrefix}.${profileName}.json`;
+}
+function getHsProfileName(profileFilename) {
+    const match = profileFilename.match(profileFilenameRegex);
+    return match ? match[1] : '';
+}
+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));
+        }
+        return String(profileVariables[key]);
+    });
+}
+function applyHsProfileVariables(fileParseResults, hsProfileContents) {
+    const profileVariables = hsProfileContents?.variables &&
+        typeof hsProfileContents.variables === 'object' &&
+        !Array.isArray(hsProfileContents.variables)
+        ? hsProfileContents.variables
+        : {};
+    return fileParseResults.map(fileParseResult => {
+        const { content, file } = fileParseResult;
+        if (content && content.config) {
+            let interpolatedConfig = content.config;
+            interpolatedConfig = JSON.parse(interpolate(file, JSON.stringify(content.config), profileVariables));
+            if (interpolatedConfig) {
+                return {
+                    ...fileParseResult,
+                    content: {
+                        ...content,
+                        config: interpolatedConfig,
+                    },
+                };
+            }
+        }
+        return fileParseResult;
+    });
+}

package/src/lib/transform.d.ts

@@ -1,8 +1,8 @@
-import { Dependencies, FileParseResult, IntermediateRepresentation, Transformation, TranslationContext } from './types';
+import { Dependencies, FileParseResult, HsProfileFile, 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[], translationContext: TranslationContext): Transformation[];
+export declare function transform(fileParseResults: FileParseResult[], translationContext: TranslationContext, hsProfileContents?: HsProfileFile): Transformation[];
 export declare function getIntermediateRepresentation(transformations: Transformation[], skipValidation: boolean | undefined): IntermediateRepresentation;
 export declare function generateServerlessPackageComponent(appFunctionsDirectory: string, translationContext: TranslationContext, componentDeps: Dependencies): {
     uid: string;

package/src/lib/transform.js

@@ -9,6 +9,7 @@ exports.mapToUserFriendlyName = mapToUserFriendlyName;
 exports.transform = transform;
 exports.getIntermediateRepresentation = getIntermediateRepresentation;
 exports.generateServerlessPackageComponent = generateServerlessPackageComponent;
+const profiles_1 = require("./profiles");
 const constants_1 = require("./constants");
 const copy_1 = require("../lang/copy");
 const path_1 = __importDefault(require("path"));
@@ -47,12 +48,16 @@ function mapToUserFacingType(type) {
 function mapToUserFriendlyName(internalType) {
     return constants_1.Components[mapToUserFacingType(internalType)]?.userFriendlyName || '';
 }
-function transform(fileParseResults, translationContext) {
+function transform(fileParseResults, translationContext, hsProfileContents) {
     const parentTypes = Object.keys(constants_1.ProjectStructure);
     const parentComponents = {};
     const allAppObjects = [];
     let appUid = '';
     let appFunctionsDirectory;
+    // Apply the profile variable overrides to the config
+    if (hsProfileContents) {
+        fileParseResults = (0, profiles_1.applyHsProfileVariables)(fileParseResults, hsProfileContents);
+    }
     // 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)) {

package/src/lib/types.d.ts

@@ -56,4 +56,11 @@ export interface TranslationContext {
 }
 export interface TranslationOptions {
     skipValidation?: boolean;
+    profile?: string;
+}
+export interface HsProfileFile {
+    accountId: number;
+    variables?: {
+        [key: string]: string | number | boolean;
+    };
 }