@hubspot/project-parsing-lib 0.1.4 → 0.1.6-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/project-parsing-lib",
-    "version": "0.1.4",
+    "version": "0.1.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

@@ -5,3 +5,4 @@ export { isTranslationError } from './lib/errors';
 export { IntermediateRepresentation, IntermediateRepresentationNode, IntermediateRepresentationLocalDev, IntermediateRepresentationNodeLocalDev, TranslationContext, };
 export { migrate } from './lib/migrate';
 export { validateUid } from './lib/uid';
+export { mapToUserFriendlyName } from './lib/transform';

package/src/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateUid = exports.migrate = exports.isTranslationError = void 0;
+exports.mapToUserFriendlyName = exports.validateUid = exports.migrate = exports.isTranslationError = void 0;
 exports.translate = translate;
 exports.translateForLocalDev = translateForLocalDev;
 const files_1 = require("./lib/files");
@@ -52,3 +52,5 @@ var migrate_1 = require("./lib/migrate");
 Object.defineProperty(exports, "migrate", { enumerable: true, get: function () { return migrate_1.migrate; } });
 var uid_1 = require("./lib/uid");
 Object.defineProperty(exports, "validateUid", { enumerable: true, get: function () { return uid_1.validateUid; } });
+var transform_2 = require("./lib/transform");
+Object.defineProperty(exports, "mapToUserFriendlyName", { enumerable: true, get: function () { return transform_2.mapToUserFriendlyName; } });

package/src/lang/copy.js

@@ -16,7 +16,7 @@ exports.errorMessages = {
         missingRequiredField: (field) => `Missing required field: '${field}'`,
         missingUid: `Missing required field: 'uid'`,
         emptyUid: `'uid' must be at least one character long`,
-        invalidUid: `'uid' must be lowercase and contain only numbers and underscores`,
+        invalidUid: `'uid' should be in lowercase, using only letters, numbers, and underscores. For example: app_id_123`,
         uidTooLong: `'uid' must be 64 characters or less`,
         missingType: `Missing required field: 'type'`,
         missingConfig: `Missing required field: 'config'`,

package/src/lib/transform.d.ts

@@ -1,4 +1,5 @@
 import { FileParseResult, IntermediateRepresentation, Transformation } from './types';
 export declare function mapToUserFacingType(type: string): string;
+export declare function mapToUserFriendlyName(internalType: string): string;
 export declare function transform(fileParseResults: FileParseResult[]): Transformation[];
 export declare function getIntermediateRepresentation(transformations: Transformation[], skipValidation: boolean | undefined): IntermediateRepresentation;

package/src/lib/transform.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.mapToUserFacingType = mapToUserFacingType;
+exports.mapToUserFriendlyName = mapToUserFriendlyName;
 exports.transform = transform;
 exports.getIntermediateRepresentation = getIntermediateRepresentation;
 const constants_1 = require("./constants");
@@ -33,6 +34,9 @@ function mapToUserFacingType(type) {
         .toLowerCase()
         .replace(/_/g, '-');
 }
+function mapToUserFriendlyName(internalType) {
+    return constants_1.Components[mapToUserFacingType(internalType)]?.userFriendlyName || '';
+}
 function transform(fileParseResults) {
     const parentTypes = Object.keys(constants_1.ProjectStructure);
     const parentComponents = {};