@hubspot/project-parsing-lib 0.0.5 → 0.0.6-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/project-parsing-lib",
-    "version": "0.0.5",
+    "version": "0.0.6-beta.0",
     "description": "Parsing library for converting projects directory structures to their intermediate representation",
     "license": "Apache-2.0",
     "main": "src/index.js",

package/src/index.d.ts

@@ -1,3 +1,3 @@
-import { IntermediateRepresentation, TranslationContext } from './lib/types';
-export declare function translate(translationContext: TranslationContext): Promise<IntermediateRepresentation>;
+import { IntermediateRepresentation, TranslationContext, TranslationOptions } from './lib/types';
+export declare function translate(translationContext: TranslationContext, translationOptions?: TranslationOptions): Promise<IntermediateRepresentation>;
 export { isTranslationError } from './lib/errors';

package/src/index.js

@@ -7,16 +7,22 @@ const validation_1 = require("./lib/validation");
 const transform_1 = require("./lib/transform");
 const errors_1 = require("./lib/errors");
 const copy_1 = require("./lang/copy");
-async function translate(translationContext) {
+const defaultOptions = {
+    skipValidation: false,
+};
+async function translate(translationContext, translationOptions = defaultOptions) {
+    const { skipValidation } = translationOptions;
     const metafileContents = await (0, files_1.loadHsMetaFiles)(translationContext);
     if (metafileContents.length === 0) {
         throw new Error(copy_1.errorMessages.project.noHsMetaFiles);
     }
     const transformation = (0, transform_1.transform)(metafileContents);
     const intermediateRepresentation = (0, transform_1.getIntermediateRepresentation)(transformation);
-    const { valid, errors } = await (0, validation_1.validateIntermediateRepresentation)(intermediateRepresentation, transformation, translationContext);
-    if (!valid) {
-        throw new errors_1.TranslationError(copy_1.errorMessages.project.failedToTranslateProject, errors);
+    if (!skipValidation) {
+        const { valid, errors } = await (0, validation_1.validateIntermediateRepresentation)(intermediateRepresentation, transformation, translationContext);
+        if (!valid) {
+            throw new errors_1.TranslationError(copy_1.errorMessages.project.failedToTranslateProject, errors);
+        }
     }
     return intermediateRepresentation;
 }

package/src/lib/constants.d.ts

@@ -1,5 +1,7 @@
 export declare const AppKey = "app";
 export declare const ThemeKey = "theme";
+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";

package/src/lib/constants.js

@@ -33,13 +33,15 @@ 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.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;
+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.AppObjectAssociationKey = exports.AppObjectKey = 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.AppObjectKey = 'app-object';
+exports.AppObjectAssociationKey = 'app-object-association';
 exports.CallingKey = 'calling';
 exports.CardsKey = 'card';
 exports.FunctionsKey = 'function';
@@ -54,6 +56,14 @@ exports.Components = {
         dir: exports.AppKey,
         isToplevel: true,
     },
+    [exports.AppObjectKey]: {
+        dir: 'app-objects',
+        parentComponent: exports.AppKey,
+    },
+    [exports.AppObjectAssociationKey]: {
+        dir: 'app-object-associations',
+        parentComponent: exports.AppKey,
+    },
     [exports.ThemeKey]: {
         dir: exports.ThemeKey,
         isToplevel: true,

package/src/lib/transform.js

@@ -4,29 +4,41 @@ exports.transform = transform;
 exports.getIntermediateRepresentation = getIntermediateRepresentation;
 const constants_1 = require("./constants");
 const copy_1 = require("../lang/copy");
-function calculateComponentDeps(fileValidationResult, parentComponents) {
-    return {
-        ...fileValidationResult.content?.dependencies,
-        // If the file has a parent, add it as a dependency
-        ...(fileValidationResult.parentDirectory
-            ? {
-                app: parentComponents[fileValidationResult.parentDirectory],
-            }
-            : {}),
-    };
+function calculateComponentDeps(fileValidationResult, parentComponents, appObjects) {
+    let dependencies = {};
+    // If there are dependencies in the config file, pass them through
+    if (!fileValidationResult.content?.dependencies) {
+        dependencies = { ...fileValidationResult.content?.dependencies };
+    }
+    const { type } = fileValidationResult.content;
+    // If the component is a child of the App component, add the app and appObjects as dependencies
+    if (constants_1.Components[type]?.parentComponent === constants_1.AppKey) {
+        const parentUid = parentComponents[fileValidationResult.parentDirectory];
+        if (parentUid) {
+            dependencies.app = parentUid;
+        }
+        if (type !== constants_1.AppObjectKey) {
+            dependencies.allAppObjects = appObjects;
+        }
+    }
+    return dependencies;
 }
 function mapToInternalType(type) {
     return (constants_1.externalTypeToInternalType[type] || type || '').toUpperCase();
 }
 function transform(fileParseResults) {
     const parentTypes = Object.keys(constants_1.ProjectStructure);
+    const parentComponents = {};
+    const appObjects = [];
     // Compute the parent components, so we can add them as dependencies to the child components
-    const parentComponents = fileParseResults.reduce((acc, file) => {
+    fileParseResults.forEach(file => {
         if (file.content?.type && parentTypes.includes(file.content.type)) {
-            acc[file.content.type] = file.content.uid;
+            parentComponents[file.content.type] = file.content.uid;
         }
-        return acc;
-    }, {});
+        if (file.content?.type === constants_1.AppObjectKey) {
+            appObjects.push(file.content.uid);
+        }
+    });
     return fileParseResults.map((currentFile) => {
         if (!currentFile.content) {
             currentFile.errors?.push(`File content is missing for ${currentFile.file}`);
@@ -38,7 +50,7 @@ function transform(fileParseResults) {
                 uid,
                 config,
                 componentType: mapToInternalType(type),
-                componentDeps: calculateComponentDeps(currentFile, parentComponents),
+                componentDeps: calculateComponentDeps(currentFile, parentComponents, appObjects),
                 metaFilePath: currentFile.file,
                 files: {},
             },

package/src/lib/types.d.ts

@@ -1,8 +1,9 @@
+export type Dependencies = Record<string, string | string[]>;
 export interface Components {
     uid: string;
     type: string;
     config: unknown;
-    dependencies?: Record<string, unknown>;
+    dependencies?: Dependencies;
 }
 export interface FileActionResult {
     file: string;
@@ -17,7 +18,7 @@ export interface FileParseResult extends FileActionResult {
 }
 export interface IntermediateRepresentationNode {
     componentType: string;
-    componentDeps: Record<string, string>;
+    componentDeps: Dependencies;
     metaFilePath: string;
     uid: string;
     config: unknown;
@@ -41,3 +42,6 @@ export interface TranslationContext {
     platformVersion: string;
     accountId: number;
 }
+export interface TranslationOptions {
+    skipValidation?: boolean;
+}