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

package/src/lib/constants.js

@@ -1,191 +1,245 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-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.SCIMKey = exports.CardsKey = exports.CallingKey = exports.AppObjectAssociationKey = exports.AppObjectKey = exports.AppFunctionsKey = exports.ThemeKey = exports.AppKey = void 0;
+// Project Platform Versions
+export const PLATFORM_VERSIONS = {
+    v2023_2: '2023.2',
+    v2025_1: '2025.1',
+    v2025_2: '2025.2',
+    v2026_03_BETA: '2026.03-beta',
+    v2026_03: '2026.03',
+    v2026_09_BETA: '2026.09-beta',
+    UNSTABLE: 'unstable',
+};
 // Top Level Component types
-const path = __importStar(require("path"));
+import * as path from 'path';
 // Component types
-exports.AppKey = 'app';
-exports.ThemeKey = 'theme';
+export const APP_KEY = 'app';
+export const THEME_KEY = 'theme';
+export const CMS_ASSETS_KEY = 'cms-assets';
 // Sub-Component types
-exports.AppFunctionsKey = 'app-function';
-exports.AppObjectKey = 'app-object';
-exports.AppObjectAssociationKey = 'app-object-association';
-exports.CallingKey = 'calling';
-exports.CardsKey = 'card';
-exports.SCIMKey = 'scim';
-exports.SettingsKey = 'settings';
-exports.MarketingEventsKey = 'marketing-event';
-exports.MediaBridgeKey = 'media-bridge';
-exports.TimelineEventsKey = 'timeline-event';
-exports.VideoConferencingKey = 'video-conferencing';
-exports.WebhooksKey = 'webhooks';
-exports.WorkflowActionsKey = 'workflow-action';
+export const APP_EVENTS_KEY = 'app-event';
+export const APP_FUNCTIONS_KEY = 'app-function';
+export const PAGE_KEY = 'page';
+export const PAGES_KEY = 'pages';
+export const APP_OBJECT_KEY = 'app-object';
+export const APP_OBJECT_ASSOCIATION_KEY = 'app-object-association';
+export const CALLING_KEY = 'calling';
+export const CARDS_KEY = 'card';
+export const SCIM_KEY = 'scim';
+export const MARKETING_EVENTS_KEY = 'marketing-event';
+export const MCP_SERVER_KEY = 'mcp-server';
+export const MEDIA_BRIDGE_KEY = 'media-bridge';
+export const SETTINGS_KEY = 'settings';
+export const TELEMETRY_KEY = 'telemetry';
+export const VIDEO_CONFERENCING_KEY = 'video-conferencing';
+export const WEBHOOKS_KEY = 'webhooks';
+export const WEBHOOKS_JOURNAL_KEY = 'webhooks-journal';
+export const WORKFLOW_ACTIONS_KEY = 'workflow-action';
+export const ACTIONS_KEY = 'action';
+export const BREEZE_TOOL_KEY = 'breeze-tool';
 // Auto-generated component types
-exports.AppFunctionsPackageKey = 'serverless-package';
-exports.AutoGeneratedComponentTypes = [exports.AppFunctionsPackageKey];
-const TopLevelComponentFields = {
+export const APP_FUNCTIONS_PACKAGE_KEY = 'serverless-package';
+export const AUTO_GENERATED_COMPONENT_TYPES = [APP_FUNCTIONS_PACKAGE_KEY];
+const TOP_LEVEL_COMPONENT_FIELDS = {
     isToplevel: true,
     userFriendlyType: 'component',
     userFriendlyTypePlural: 'components',
 };
-const SubComponentFields = {
+const SUB_COMPONENT_FIELDS = {
     isToplevel: false,
     userFriendlyType: 'feature',
     userFriendlyTypePlural: 'features',
 };
-exports.Components = {
-    [exports.AppKey]: {
-        dir: exports.AppKey,
+const PAGE_COMPONENT = {
+    dir: 'pages',
+    parentComponent: APP_KEY,
+    ...SUB_COMPONENT_FIELDS,
+    userFriendlyName: 'Page',
+    singularComponent: true,
+};
+// Breeze components share a `breeze/` group directory so future breeze features
+// (e.g. breeze/skills, breeze/subagents) can sit alongside breeze/tools.
+const BREEZE_COMPONENT_DIR = 'breeze';
+export const Components = {
+    [APP_KEY]: {
+        dir: APP_KEY,
         userFriendlyName: 'App',
-        ...TopLevelComponentFields,
+        ...TOP_LEVEL_COMPONENT_FIELDS,
         singularComponent: true,
     },
-    [exports.AppObjectKey]: {
+    [APP_OBJECT_KEY]: {
         dir: 'app-objects',
-        parentComponent: exports.AppKey,
-        ...SubComponentFields,
+        parentComponent: APP_KEY,
+        ...SUB_COMPONENT_FIELDS,
         userFriendlyName: 'App Object',
     },
-    [exports.AppObjectAssociationKey]: {
+    [APP_OBJECT_ASSOCIATION_KEY]: {
         dir: 'app-object-associations',
-        parentComponent: exports.AppKey,
-        ...SubComponentFields,
+        parentComponent: APP_KEY,
+        ...SUB_COMPONENT_FIELDS,
         userFriendlyName: 'App Object Association',
     },
-    [exports.ThemeKey]: {
-        dir: exports.ThemeKey,
+    [PAGE_KEY]: PAGE_COMPONENT,
+    [PAGES_KEY]: PAGE_COMPONENT,
+    [THEME_KEY]: {
+        dir: THEME_KEY,
         userFriendlyName: 'Theme',
-        ...TopLevelComponentFields,
+        ...TOP_LEVEL_COMPONENT_FIELDS,
+    },
+    [CMS_ASSETS_KEY]: {
+        dir: CMS_ASSETS_KEY,
+        userFriendlyName: 'CMS Asset',
+        ...TOP_LEVEL_COMPONENT_FIELDS,
     },
-    [exports.CallingKey]: {
-        dir: exports.CallingKey,
-        parentComponent: exports.AppKey,
+    [CALLING_KEY]: {
+        dir: CALLING_KEY,
+        parentComponent: APP_KEY,
         userFriendlyName: 'Calling',
-        ...SubComponentFields,
+        ...SUB_COMPONENT_FIELDS,
         singularComponent: true,
     },
-    [exports.CardsKey]: {
+    [CARDS_KEY]: {
         dir: 'cards',
-        parentComponent: exports.AppKey,
+        parentComponent: APP_KEY,
         userFriendlyName: 'Card',
-        ...SubComponentFields,
+        ...SUB_COMPONENT_FIELDS,
     },
-    [exports.AppFunctionsKey]: {
+    [APP_FUNCTIONS_KEY]: {
         dir: 'functions',
-        parentComponent: exports.AppKey,
+        parentComponent: APP_KEY,
         userFriendlyName: 'App Function',
-        ...SubComponentFields,
+        ...SUB_COMPONENT_FIELDS,
     },
-    [exports.SCIMKey]: {
-        dir: exports.SCIMKey,
-        parentComponent: exports.AppKey,
+    [SCIM_KEY]: {
+        dir: SCIM_KEY,
+        parentComponent: APP_KEY,
         userFriendlyName: 'SCIM',
         singularComponent: true,
-        ...SubComponentFields,
+        ...SUB_COMPONENT_FIELDS,
     },
-    [exports.SettingsKey]: {
+    [SETTINGS_KEY]: {
         dir: 'settings',
-        parentComponent: exports.AppKey,
+        parentComponent: APP_KEY,
         userFriendlyName: 'Settings Extension',
-        ...SubComponentFields,
+        ...SUB_COMPONENT_FIELDS,
         singularComponent: true,
     },
-    [exports.MarketingEventsKey]: {
+    [MARKETING_EVENTS_KEY]: {
         dir: 'marketing-events',
-        parentComponent: exports.AppKey,
+        parentComponent: APP_KEY,
         userFriendlyName: 'Marketing Event',
-        ...SubComponentFields,
+        ...SUB_COMPONENT_FIELDS,
     },
-    MediaBridgeKey: {
-        dir: exports.MediaBridgeKey,
-        parentComponent: exports.AppKey,
+    [MEDIA_BRIDGE_KEY]: {
+        dir: MEDIA_BRIDGE_KEY,
+        parentComponent: APP_KEY,
         userFriendlyName: 'Media Bridge',
-        ...SubComponentFields,
+        ...SUB_COMPONENT_FIELDS,
     },
-    [exports.TimelineEventsKey]: {
-        dir: 'timeline-events',
-        parentComponent: exports.AppKey,
-        userFriendlyName: 'Timeline Event',
-        ...SubComponentFields,
+    [APP_EVENTS_KEY]: {
+        dir: 'app-events',
+        parentComponent: APP_KEY,
+        userFriendlyName: 'App Event',
+        ...SUB_COMPONENT_FIELDS,
     },
-    [exports.VideoConferencingKey]: {
-        dir: exports.VideoConferencingKey,
-        parentComponent: exports.AppKey,
+    [VIDEO_CONFERENCING_KEY]: {
+        dir: VIDEO_CONFERENCING_KEY,
+        parentComponent: APP_KEY,
         userFriendlyName: 'Video Conferencing',
-        ...SubComponentFields,
+        ...SUB_COMPONENT_FIELDS,
     },
-    [exports.WebhooksKey]: {
-        dir: exports.WebhooksKey,
-        parentComponent: exports.AppKey,
+    [WEBHOOKS_KEY]: {
+        dir: WEBHOOKS_KEY,
+        parentComponent: APP_KEY,
         userFriendlyName: 'Webhooks',
-        ...SubComponentFields,
+        ...SUB_COMPONENT_FIELDS,
         singularComponent: true,
     },
-    [exports.WorkflowActionsKey]: {
+    [WEBHOOKS_JOURNAL_KEY]: {
+        dir: WEBHOOKS_JOURNAL_KEY,
+        parentComponent: APP_KEY,
+        userFriendlyName: 'Webhooks Journal',
+        ...SUB_COMPONENT_FIELDS,
+        singularComponent: true,
+    },
+    [WORKFLOW_ACTIONS_KEY]: {
         dir: 'workflow-actions',
-        parentComponent: exports.AppKey,
+        parentComponent: APP_KEY,
         userFriendlyName: 'Workflow Action',
-        ...SubComponentFields,
+        ...SUB_COMPONENT_FIELDS,
+    },
+    [ACTIONS_KEY]: {
+        dir: 'actions',
+        parentComponent: APP_KEY,
+        userFriendlyName: 'Action',
+        ...SUB_COMPONENT_FIELDS,
+    },
+    [TELEMETRY_KEY]: {
+        dir: TELEMETRY_KEY,
+        parentComponent: APP_KEY,
+        userFriendlyName: 'Telemetry',
+        singularComponent: true,
+        ...SUB_COMPONENT_FIELDS,
+    },
+    [MCP_SERVER_KEY]: {
+        dir: MCP_SERVER_KEY,
+        parentComponent: APP_KEY,
+        userFriendlyName: 'MCP Server',
+        singularComponent: true,
+        ...SUB_COMPONENT_FIELDS,
+    },
+    [BREEZE_TOOL_KEY]: {
+        dir: `${BREEZE_COMPONENT_DIR}/tools`,
+        parentComponent: APP_KEY,
+        userFriendlyName: 'Breeze Tool',
+        ...SUB_COMPONENT_FIELDS,
     },
 };
-exports.userFacingToInternalType = {
-    [exports.AppKey]: 'APPLICATION',
-    [exports.SCIMKey]: 'SCIM_INTEGRATION',
+export const USER_FACING_TO_INTERNAL_TYPE = {
+    [APP_KEY]: 'APPLICATION',
+    [SCIM_KEY]: 'SCIM_INTEGRATION',
+    [TELEMETRY_KEY]: 'TELEMETRY_CONFIG',
+    [CMS_ASSETS_KEY]: 'REACT_THEME',
+    [PAGES_KEY]: 'PAGE',
 };
-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';
+export const INTERNAL_TYPE_TO_USER_FACING = Object.fromEntries(Object.entries(USER_FACING_TO_INTERNAL_TYPE).map(([key, value]) => [
+    value,
+    key,
+]));
+export const METAFILE_EXTENSION = '-hsmeta.json';
+export const PROFILE_FILE_PREFIX = 'hsprofile';
+export const HS_PROJECT_JSON_FILENAME = 'hsproject.json';
+export const PACKAGE_JSON = 'package.json';
+export const PACKAGE_LOCK_JSON = 'package-lock.json';
 function getSubComponentDirsForParentType(parentComponent) {
-    return Object.values(exports.Components).reduce((acc, item) => {
+    return Object.values(Components).reduce((acc, item) => {
         if (item.parentComponent === parentComponent) {
             acc.push(item.dir);
         }
         return acc;
     }, []);
 }
-exports.allowedAppSubComponentsDirs = getSubComponentDirsForParentType(exports.AppKey);
-exports.allowedThemeSubComponentsDirs = getSubComponentDirsForParentType(exports.ThemeKey);
-exports.ProjectStructure = {
-    [exports.AppKey]: exports.allowedAppSubComponentsDirs,
-    [exports.ThemeKey]: exports.allowedThemeSubComponentsDirs,
+export const ALLOWED_APP_SUB_COMPONENTS_DIRS = getSubComponentDirsForParentType(APP_KEY);
+export const ALLOWED_THEME_SUB_COMPONENTS_DIRS = getSubComponentDirsForParentType(THEME_KEY);
+export const ALLOWED_CMS_ASSET_SUB_COMPONENT_DIRS = getSubComponentDirsForParentType(CMS_ASSETS_KEY);
+export const PROJECT_STRUCTURE = {
+    [APP_KEY]: ALLOWED_APP_SUB_COMPONENTS_DIRS,
+    [THEME_KEY]: ALLOWED_THEME_SUB_COMPONENTS_DIRS,
+    [CMS_ASSETS_KEY]: ALLOWED_CMS_ASSET_SUB_COMPONENT_DIRS,
 };
-exports.allowedComponentDirectories = Object.keys(exports.ProjectStructure);
-exports.allowedSubComponentDirectories = Object.entries(exports.ProjectStructure)
+export const ALLOWED_COMPONENT_DIRECTORIES = Object.keys(PROJECT_STRUCTURE);
+export const ALLOWED_SUB_COMPONENT_DIRECTORIES = Object.entries(PROJECT_STRUCTURE)
     .map(([key, value]) => value.map((value) => path.join(key, value)))
     .flat();
+// Profile variable types
+export const PROFILE_VARIABLE_TYPES = {
+    PROFILE_INT: 'PROFILE_INT',
+    PROFILE_LONG: 'PROFILE_LONG',
+    PROFILE_STRING: 'PROFILE_STRING',
+    PROFILE_BOOLEAN: 'PROFILE_BOOLEAN',
+};
+export const ALLOWED_TOP_LEVEL_FIELDS = new Set([
+    'uid',
+    'type',
+    'config',
+    'dependencies',
+    'permissions',
+]);

package/src/lib/errors.d.ts

@@ -1,12 +1,12 @@
-import { CompiledError, Transformation, TranslationContext } from './types';
-import { ErrorObject } from 'ajv/dist/2020';
+import { CompiledError, Transformation, TranslationContext } from './types.js';
+import type { ErrorObject } from 'ajv';
 export declare function isTranslationError(error: unknown): error is TranslationError;
 export declare function compileError(validatedTransformation: Transformation): CompiledError;
 export declare class TranslationError extends Error {
     private errors;
     private translationContext;
     constructor(message: string, transformations: Transformation[], errors: (ErrorObject[] | null | undefined)[], translationContext: TranslationContext);
-    toString(): string;
+    toString(includeMessage?: boolean): string;
 }
 export declare function extractDotNotationValueFromTransformation(dotNotation: string, transformation: Transformation): unknown;
 export declare const AjvErrorKeyword: {

package/src/lib/errors.js

@@ -1,26 +1,17 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AjvErrorKeyword = exports.TranslationError = void 0;
-exports.isTranslationError = isTranslationError;
-exports.compileError = compileError;
-exports.extractDotNotationValueFromTransformation = extractDotNotationValueFromTransformation;
-const copy_1 = require("../lang/copy");
-const path_1 = __importDefault(require("path"));
-const logger_1 = require("@hubspot/local-dev-lib/logger");
-function isTranslationError(error) {
+import { errorMessages } from '../lang/copy.js';
+import path from 'path';
+import { logger } from '@hubspot/local-dev-lib/logger';
+export function isTranslationError(error) {
     return error instanceof TranslationError;
 }
-function compileError(validatedTransformation) {
+export function compileError(validatedTransformation) {
     const { fileParseResult } = validatedTransformation;
     const { errors } = fileParseResult;
     return {
         errors,
     };
 }
-class TranslationError extends Error {
+export class TranslationError extends Error {
     errors = [];
     translationContext;
     constructor(message, transformations, errors, translationContext) {
@@ -30,21 +21,22 @@ class TranslationError extends Error {
         this.errors = transformations.map((transformation, index) => compileTranslationErrors(transformation, errors[index]));
     }
     // Returns a formatted string for all the errors in all the files
-    toString() {
+    toString(includeMessage = true) {
         const listOfErrors = this.errors.map(({ file, errors }) => {
             if (errors.length === 0) {
                 return null;
             }
-            const projectRoot = path_1.default.dirname(path_1.default.dirname(this.translationContext.projectSourceDir));
-            const relativePath = path_1.default.relative(projectRoot, path_1.default.join(this.translationContext.projectSourceDir, file));
-            return copy_1.errorMessages.validation.errorWithFileHeader(relativePath, errors);
+            const projectRoot = path.dirname(path.dirname(this.translationContext.projectSourceDir));
+            const relativePath = path.relative(projectRoot, path.join(this.translationContext.projectSourceDir, file));
+            return errorMessages.validation.errorWithFileHeader(relativePath, errors);
         });
-        return `${this.message}:${listOfErrors
-            .filter(error => error !== null)
-            .join('')}`;
+        const errorString = listOfErrors.filter(error => error !== null).join('');
+        if (includeMessage) {
+            return `${this.message}:${errorString}`;
+        }
+        return errorString.trimStart();
     }
 }
-exports.TranslationError = TranslationError;
 function generateDotNotationPath(error) {
     const { instancePath } = error;
     const errorPath = instancePath
@@ -104,7 +96,7 @@ function preprocessSpecialErrors(schemaErrors, transformation) {
 }
 function generateErrorMessage(error, transformation) {
     const errorPath = generateDotNotationPath(error);
-    const errorMessage = copy_1.errorMessages.validation.errorWithField(errorPath, error.message);
+    const errorMessage = errorMessages.validation.errorWithField(errorPath, error.message);
     const params = Object.entries(error.params);
     if (params.length === 0) {
         return errorMessage;
@@ -113,12 +105,12 @@ function generateErrorMessage(error, transformation) {
         .filter(([_, value]) => value)
         .map(([key, value]) => `${key}: ${Array.isArray(value) ? value.join(', ') : value}`);
     if (isRequiredError(error)) {
-        return copy_1.errorMessages.validation.missingRequiredField(`${errorPath}.${error.params.missingProperty}`);
+        return errorMessages.validation.missingRequiredField(`${errorPath}.${error.params.missingProperty}`);
     }
     else if (isTypeError(error)) {
         const dotNotationPath = generateDotNotationPath(error);
         const value = extractDotNotationValueFromTransformation(dotNotationPath, transformation);
-        return copy_1.errorMessages.validation.errorWithField(value !== undefined
+        return errorMessages.validation.errorWithField(value !== undefined
             ? `Value (${value}) in ${dotNotationPath}`
             : dotNotationPath, error.message);
     }
@@ -142,7 +134,7 @@ function mergeEnumErrors(cur, next) {
         },
     };
 }
-function extractDotNotationValueFromTransformation(dotNotation, transformation) {
+export function extractDotNotationValueFromTransformation(dotNotation, transformation) {
     try {
         const parts = dotNotation.split('.');
         if (!transformation?.fileParseResult?.content || parts.length === 0) {
@@ -169,22 +161,22 @@ function extractDotNotationValueFromTransformation(dotNotation, transformation)
         return value;
     }
     catch (e) {
-        logger_1.logger.debug('Unable to parse dot notation path to located value', e);
+        logger.debug('Unable to parse dot notation path to located value', e);
     }
 }
 function isOneOfError(error) {
-    return error.keyword === exports.AjvErrorKeyword.OneOf;
+    return error.keyword === AjvErrorKeyword.OneOf;
 }
 function isRequiredError(error) {
-    return error.keyword === exports.AjvErrorKeyword.Required;
+    return error.keyword === AjvErrorKeyword.Required;
 }
 function isEnumError(error) {
-    return error.keyword === exports.AjvErrorKeyword.Enum;
+    return error.keyword === AjvErrorKeyword.Enum;
 }
 function isTypeError(error) {
-    return error.keyword === exports.AjvErrorKeyword.Type;
+    return error.keyword === AjvErrorKeyword.Type;
 }
-exports.AjvErrorKeyword = {
+export const AjvErrorKeyword = {
     AdditionalItems: 'additionalItems',
     AdditionalProperties: 'additionalProperties',
     Dependencies: 'dependencies',

package/src/lib/files.d.ts

@@ -1,5 +1,5 @@
-import { FileParseResult, TranslationContext, HsProfileFile } from './types';
-type MetaFileLocation = {
+import { FileParseResult, TranslationContext, HsProfileFile } from './types.js';
+export type MetaFileLocation = {
     file: string;
     parentDirectory?: string;
 };
@@ -10,4 +10,4 @@ export declare function locateHsMetaFiles(projectSourceDir: string, options?: {
     silent: boolean;
 }): Promise<MetaFileLocation[]>;
 export declare function projectContainsHsMetaFiles(projectSourceDir: string): Promise<boolean>;
-export {};
+export declare function convertPathToPosixPath(filepath: string): string;