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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/project-parsing-lib",
-    "version": "0.17.0-beta.0",
+    "version": "0.18.0-beta.0",
     "description": "Parsing library for converting projects directory structures to their intermediate representation",
     "license": "Apache-2.0",
     "type": "module",

package/src/exports/projects.d.ts

@@ -1,4 +1,4 @@
 export { getProjectMetadata } from '../lib/project.js';
 export { projectContainsHsMetaFiles } from '../lib/files.js';
 export type { ProjectMetadata } from '../lib/project.js';
-export { LATEST_SUPPORTED_PLATFORM_VERSION, isSupportedPlatformVersion, isLegacyProject, } from '../lib/platformVersion.js';
+export { LATEST_SUPPORTED_PLATFORM_VERSION, isSupportedPlatformVersion, isLegacyProject, supportsComponentPermissions, } from '../lib/platformVersion.js';

package/src/exports/projects.js

@@ -1,3 +1,3 @@
 export { getProjectMetadata } from '../lib/project.js';
 export { projectContainsHsMetaFiles } from '../lib/files.js';
-export { LATEST_SUPPORTED_PLATFORM_VERSION, isSupportedPlatformVersion, isLegacyProject, } from '../lib/platformVersion.js';
+export { LATEST_SUPPORTED_PLATFORM_VERSION, isSupportedPlatformVersion, isLegacyProject, supportsComponentPermissions, } from '../lib/platformVersion.js';

package/src/exports/translate.d.ts

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

package/src/lang/copy.d.ts

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

package/src/lang/copy.js

@@ -34,6 +34,7 @@ export const errorMessages = {
         unsupportedType: (type) => `Unsupported type: ${mapToUserFacingType(type)}`,
         errorWithField: (field, error) => `${field}: ${error || 'Unknown error'}`,
         invalidJson: 'Invalid JSON',
+        permissionsNotSupported: (platformVersion) => `The "permissions" field is not supported on platform version "${platformVersion}". Upgrade to "2026.09" or later to use component-level permissions.`,
         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`,
     },

package/src/lib/constants.js

@@ -231,4 +231,5 @@ export const ALLOWED_TOP_LEVEL_FIELDS = new Set([
     'type',
     'config',
     'dependencies',
+    'permissions',
 ]);

package/src/lib/platformVersion.d.ts

@@ -1,3 +1,4 @@
 export declare const LATEST_SUPPORTED_PLATFORM_VERSION: string;
 export declare function isSupportedPlatformVersion(platformVersion?: string | null): boolean;
 export declare function isLegacyProject(platformVersion?: string | null): boolean;
+export declare function supportsComponentPermissions(platformVersion: string): boolean;

package/src/lib/platformVersion.js

@@ -18,3 +18,13 @@ export function isLegacyProject(platformVersion) {
         return false;
     return [PLATFORM_VERSIONS.v2023_2, PLATFORM_VERSIONS.v2025_1].includes(platformVersion);
 }
+const PRE_PERMISSIONS_VERSIONS = new Set([
+    PLATFORM_VERSIONS.v2023_2,
+    PLATFORM_VERSIONS.v2025_1,
+    PLATFORM_VERSIONS.v2025_2,
+    PLATFORM_VERSIONS.v2026_03_BETA,
+    PLATFORM_VERSIONS.v2026_03,
+]);
+export function supportsComponentPermissions(platformVersion) {
+    return !PRE_PERMISSIONS_VERSIONS.has(platformVersion);
+}

package/src/lib/transform.js

@@ -7,11 +7,13 @@ import { errorMessages } from '../lang/copy.js';
 import { getJavaNumberType } from './utils.js';
 import { convertPathToPosixPath } from './files.js';
 function calculateComponentDeps(fileValidationResult, parentComponents, appObjects, appFunctionsPackageUid) {
-    let dependencies = {};
-    // If there are dependencies in the config file, pass them through
-    if (!fileValidationResult.content?.dependencies) {
-        dependencies = { ...fileValidationResult.content?.dependencies };
-    }
+    // Pass through any developer-authored dependencies declared in the hsmeta
+    // file. Framework-injected structural dependencies (app, allAppObjects,
+    // serverlessPackage) are layered on top below and take precedence over any
+    // authored value for those reserved keys.
+    const 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 (Components[type]?.parentComponent === APP_KEY) {
@@ -95,7 +97,7 @@ export function transform(fileParseResults, translationContext, hsProfileContent
                 fileParseResult: currentFile,
             };
         }
-        const { config, uid, type } = currentFile.content;
+        const { config, uid, type, permissions } = currentFile.content;
         const { dependencies, errors } = calculateComponentDeps(currentFile, parentComponents, allAppObjects, serverlessPackageUid);
         if (errors) {
             currentFile.errors?.push(...errors);
@@ -108,6 +110,7 @@ export function transform(fileParseResults, translationContext, hsProfileContent
                 componentDeps: dependencies,
                 metaFilePath: convertPathToPosixPath(currentFile.file),
                 files: {},
+                ...(permissions ? { permissions } : {}),
             },
             fileParseResult: currentFile,
         };

package/src/lib/types.d.ts

@@ -1,10 +1,16 @@
 import type { ErrorObject } from 'ajv';
 export type Dependencies = Record<string, string | string[]>;
+export interface ComponentPermissions {
+    requiredScopes?: string[];
+    optionalScopes?: string[];
+    conditionallyRequiredScopes?: string[];
+}
 export interface ComponentMeta {
     uid: string;
     type: string;
     config: unknown;
     dependencies?: Dependencies;
+    permissions?: ComponentPermissions;
 }
 export interface FileActionResult {
     file: string;
@@ -24,6 +30,7 @@ export interface IntermediateRepresentationNode {
     uid: string;
     config: unknown;
     files: unknown;
+    permissions?: ComponentPermissions;
 }
 export type BEProfileVariableType = 'PROFILE_INT' | 'PROFILE_LONG' | 'PROFILE_STRING' | 'PROFILE_BOOLEAN';
 export interface BEProfileVariables {

package/src/lib/validation.js

@@ -5,6 +5,7 @@ import { errorMessages } from '../lang/copy.js';
 import { AUTO_GENERATED_COMPONENT_TYPES, Components } from './constants.js';
 import path from 'path';
 import { findTransformationByUid, mapToUserFacingType } from './transform.js';
+import { supportsComponentPermissions } from './platformVersion.js';
 import { validateUid } from './uid.js';
 // ajv-formats does not play nicely with ESM and TS
 import addFormatsModule from 'ajv-formats';
@@ -47,6 +48,10 @@ function validateIntermediateRepresentationNode(schema, transformation, irNode,
         // If there is no config block, there is nothing to validation
         shouldSkipValidation = true;
     }
+    if (irNode.permissions &&
+        !supportsComponentPermissions(translationContext.platformVersion)) {
+        transformation.fileParseResult.errors.push(errorMessages.validation.permissionsNotSupported(translationContext.platformVersion));
+    }
     if (!schema[irNode.componentType]) {
         if (!irNode.componentType) {
             transformation.fileParseResult.errors.push(errorMessages.validation.missingType);