@hubspot/project-parsing-lib 0.2.1 → 0.2.2

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/project-parsing-lib",
-    "version": "0.2.1",
+    "version": "0.2.2",
     "description": "Parsing library for converting projects directory structures to their intermediate representation",
     "license": "Apache-2.0",
     "main": "src/index.js",
@@ -39,7 +39,7 @@
         "release": "yarn ts-node ./scripts/release.ts release",
         "reset-north-star": "git submodule update --init",
         "acceptance-test": "yarn --cwd=./acceptance-tests test",
-        "update-north-star": "git submodule update --remote --merge"
+        "update-north-star": "git submodule update --remote"
     },
     "engines": {
         "node": ">=18"

package/src/lib/constants.d.ts

@@ -5,6 +5,7 @@ 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 SCIMKey = "scim";
 export declare const SettingsKey = "settings";
 export declare const MarketingEventsKey = "marketing-event";
 export declare const MediaBridgeKey = "media-bridge";

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.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;
+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;
 // Top Level Component types
 const path = __importStar(require("path"));
 // Component types
@@ -45,6 +45,7 @@ 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';
@@ -108,6 +109,13 @@ exports.Components = {
         userFriendlyName: 'App Function',
         ...SubComponentFields,
     },
+    [exports.SCIMKey]: {
+        dir: exports.SCIMKey,
+        parentComponent: exports.AppKey,
+        userFriendlyName: 'SCIM',
+        singularComponent: true,
+        ...SubComponentFields,
+    },
     [exports.SettingsKey]: {
         dir: 'settings',
         parentComponent: exports.AppKey,
@@ -153,9 +161,9 @@ exports.Components = {
         ...SubComponentFields,
     },
 };
-const internalAppKey = 'APPLICATION';
 exports.userFacingToInternalType = {
-    [exports.AppKey]: internalAppKey,
+    [exports.AppKey]: 'APPLICATION',
+    [exports.SCIMKey]: 'SCIM_INTEGRATION',
 };
 exports.internalTypeToUserFacing = Object.fromEntries(Object.entries(exports.userFacingToInternalType).map(([key, value]) => [value, key]));
 exports.metafileExtension = '-hsmeta.json';

package/src/lib/files.d.ts

@@ -1,5 +1,13 @@
 import { FileParseResult, TranslationContext, HsProfileFile } from './types';
+type MetaFileLocation = {
+    file: string;
+    parentDirectory?: string;
+};
 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[]>;
+export declare function locateHsMetaFiles(projectSourceDir: string, options?: {
+    silent: boolean;
+}): Promise<MetaFileLocation[]>;
 export declare function projectContainsHsMetaFiles(projectSourceDir: string): Promise<boolean>;
+export {};

package/src/lib/files.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadHsProfileFile = loadHsProfileFile;
 exports.getAllHsProfiles = getAllHsProfiles;
 exports.loadHsMetaFiles = loadHsMetaFiles;
+exports.locateHsMetaFiles = locateHsMetaFiles;
 exports.projectContainsHsMetaFiles = projectContainsHsMetaFiles;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
@@ -45,7 +46,7 @@ async function loadHsMetaFiles(translationContext) {
     const metaFiles = await locateHsMetaFiles(translationContext.projectSourceDir);
     return parseHsMetaFiles(metaFiles, translationContext);
 }
-async function locateHsMetaFiles(projectSourceDir) {
+async function locateHsMetaFiles(projectSourceDir, options = { silent: false }) {
     return (await (0, fs_2.walk)(projectSourceDir, ['node_modules'])).reduce((metaFiles, file) => {
         if (!file.endsWith(constants_1.metafileExtension)) {
             return metaFiles;
@@ -60,7 +61,9 @@ async function locateHsMetaFiles(projectSourceDir) {
             metaFiles.push({ file, parentDirectory });
         }
         else {
-            logger_1.logger.warn(copy_1.logMessages.files.skippingPath(pathRelativeToProjectSrcDir));
+            if (!options.silent) {
+                logger_1.logger.warn(copy_1.logMessages.files.skippingPath(pathRelativeToProjectSrcDir));
+            }
         }
         return metaFiles;
     }, []);

package/src/lib/project.d.ts

@@ -0,0 +1,13 @@
+export interface ComponentMetadata {
+    count: number;
+    maxCount: number;
+    hsMetaFiles: string[];
+}
+export interface ComponentMetadataMap {
+    [componentType: string]: ComponentMetadata;
+}
+export interface ProjectMetadata {
+    hsMetaFiles: string[];
+    components: ComponentMetadataMap;
+}
+export declare function getProjectMetadata(projectSrcDir: string): Promise<ProjectMetadata>;

package/src/lib/project.js

@@ -0,0 +1,31 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProjectMetadata = getProjectMetadata;
+const constants_1 = require("./constants");
+const files_1 = require("./files");
+const path_1 = __importDefault(require("path"));
+async function getProjectMetadata(projectSrcDir) {
+    const hsMetaFiles = [];
+    const components = {};
+    const metafiles = await (0, files_1.locateHsMetaFiles)(projectSrcDir, { silent: true });
+    Object.keys(constants_1.Components).forEach(componentType => {
+        const { parentComponent, singularComponent, dir } = constants_1.Components[componentType];
+        const componentPath = path_1.default.join(projectSrcDir, parentComponent ? path_1.default.join(parentComponent, dir) : dir);
+        const metaFilesByType = metafiles
+            .filter(metafile => path_1.default.parse(metafile.file).dir === componentPath)
+            .map(metaFile => metaFile.file);
+        hsMetaFiles.push(...metaFilesByType);
+        components[componentType] = {
+            hsMetaFiles: metaFilesByType,
+            count: metaFilesByType.length,
+            maxCount: singularComponent ? 1 : Infinity,
+        };
+    });
+    return {
+        hsMetaFiles,
+        components,
+    };
+}