@hubspot/project-parsing-lib 0.9.0 → 0.10.0-beta.0

package/package.json

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

package/src/lang/copy.d.ts

@@ -31,6 +31,7 @@ export declare const errorMessages: {
         unsupportedType: (type: string) => string;
         errorWithField: (field: string, error: string | undefined) => string;
         invalidJson: string;
+        unexpectedToplevelFields: (unexpectedFields: string) => string;
         wrongDirectoryForComponent: (directory: string, componentType: string, componentMetadata: ComponentMetadata, correctDir: string) => string;
     };
     migrateThemes: {

package/src/lang/copy.js

@@ -42,6 +42,7 @@ exports.errorMessages = {
         unsupportedType: (type) => `Unsupported type: ${(0, transform_1.mapToUserFacingType)(type)}`,
         errorWithField: (field, error) => `${field}: ${error || 'Unknown error'}`,
         invalidJson: 'Invalid JSON',
+        unexpectedToplevelFields: (unexpectedFields) => `Unexpected top-level properties found: ${unexpectedFields}`,
         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`,
     },
     migrateThemes: {

package/src/lib/constants.d.ts

@@ -1,3 +1,4 @@
+import { Components as ComponentsTopLevel } from './types';
 export declare const AppKey = "app";
 export declare const ThemeKey = "theme";
 export declare const CmsAssetsKey = "cms-assets";
@@ -16,6 +17,7 @@ export declare const SettingsKey = "settings";
 export declare const TelemetryKey = "telemetry";
 export declare const VideoConferencingKey = "video-conferencing";
 export declare const WebhooksKey = "webhooks";
+export declare const WebhooksJournalKey = "webhooks-journal";
 export declare const WorkflowActionsKey = "workflow-action";
 export declare const AppFunctionsPackageKey = "serverless-package";
 export declare const AutoGeneratedComponentTypes: string[];
@@ -52,3 +54,4 @@ export declare const ProfileVariableTypes: {
     readonly PROFILE_STRING: "PROFILE_STRING";
     readonly PROFILE_BOOLEAN: "PROFILE_BOOLEAN";
 };
+export declare const allowedTopLevelFields: Set<keyof ComponentsTopLevel>;

package/src/lib/constants.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProfileVariableTypes = exports.allowedSubComponentDirectories = exports.allowedComponentDirectories = exports.ProjectStructure = exports.allowedCmsAssetSubComponentDirs = 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.TelemetryKey = exports.SettingsKey = exports.MediaBridgeKey = exports.MCPRegistryKey = exports.MarketingEventsKey = exports.SCIMKey = exports.CardsKey = exports.CallingKey = exports.AppObjectAssociationKey = exports.AppObjectKey = exports.PagesKey = exports.AppFunctionsKey = exports.AppEventsKey = exports.CmsAssetsKey = exports.ThemeKey = exports.AppKey = void 0;
+exports.allowedTopLevelFields = exports.ProfileVariableTypes = exports.allowedSubComponentDirectories = exports.allowedComponentDirectories = exports.ProjectStructure = exports.allowedCmsAssetSubComponentDirs = 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.WebhooksJournalKey = exports.WebhooksKey = exports.VideoConferencingKey = exports.TelemetryKey = exports.SettingsKey = exports.MediaBridgeKey = exports.MCPRegistryKey = exports.MarketingEventsKey = exports.SCIMKey = exports.CardsKey = exports.CallingKey = exports.AppObjectAssociationKey = exports.AppObjectKey = exports.PagesKey = exports.AppFunctionsKey = exports.AppEventsKey = exports.CmsAssetsKey = exports.ThemeKey = exports.AppKey = void 0;
 // Top Level Component types
 const path = __importStar(require("path"));
 // Component types
@@ -56,6 +56,7 @@ exports.SettingsKey = 'settings';
 exports.TelemetryKey = 'telemetry';
 exports.VideoConferencingKey = 'video-conferencing';
 exports.WebhooksKey = 'webhooks';
+exports.WebhooksJournalKey = 'webhooks-journal';
 exports.WorkflowActionsKey = 'workflow-action';
 // Auto-generated component types
 exports.AppFunctionsPackageKey = 'serverless-package';
@@ -170,6 +171,13 @@ exports.Components = {
         ...SubComponentFields,
         singularComponent: true,
     },
+    [exports.WebhooksJournalKey]: {
+        dir: exports.WebhooksJournalKey,
+        parentComponent: exports.AppKey,
+        userFriendlyName: 'Webhooks Journal',
+        ...SubComponentFields,
+        singularComponent: true,
+    },
     [exports.WorkflowActionsKey]: {
         dir: 'workflow-actions',
         parentComponent: exports.AppKey,
@@ -230,3 +238,9 @@ exports.ProfileVariableTypes = {
     PROFILE_STRING: 'PROFILE_STRING',
     PROFILE_BOOLEAN: 'PROFILE_BOOLEAN',
 };
+exports.allowedTopLevelFields = new Set([
+    'uid',
+    'type',
+    'config',
+    'dependencies',
+]);

package/src/lib/files.js

@@ -107,6 +107,17 @@ function parseFile(fileLoadResult) {
     catch (_e) {
         fileLoadResult.errors?.push(copy_1.errorMessages.validation.invalidJson);
     }
+    // Validate top-level fields (only uid, type, and config are expected)
+    if (parsedFileContents &&
+        typeof parsedFileContents === 'object' &&
+        !Array.isArray(parsedFileContents)) {
+        const actualFields = Object.keys(parsedFileContents);
+        const unexpectedFields = actualFields.filter(field => !constants_1.allowedTopLevelFields.has(field));
+        if (unexpectedFields.length > 0) {
+            const unexpectedFieldsList = unexpectedFields.join(', ');
+            fileLoadResult.errors?.push(copy_1.errorMessages.validation.unexpectedToplevelFields(unexpectedFieldsList));
+        }
+    }
     return { ...fileLoadResult, content: parsedFileContents };
 }
 async function projectContainsHsMetaFiles(projectSourceDir) {