@hubspot/project-parsing-lib 0.1.11 → 0.2.0-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/project-parsing-lib",
-    "version": "0.1.11",
+    "version": "0.2.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/index.d.ts

@@ -1,4 +1,5 @@
 import { IntermediateRepresentation, IntermediateRepresentationNode, IntermediateRepresentationLocalDev, TranslationContext, TranslationOptions, IntermediateRepresentationNodeLocalDev } from './lib/types';
+import { ValidateFunction, AnySchema, ErrorObject } from 'ajv/dist/2020';
 export declare function translate(translationContext: TranslationContext, translationOptions?: TranslationOptions): Promise<IntermediateRepresentation>;
 export declare function translateForLocalDev(translationContext: TranslationContext): Promise<IntermediateRepresentationLocalDev>;
 export { isTranslationError } from './lib/errors';
@@ -7,3 +8,9 @@ export { migrate } from './lib/migrate';
 export { validateUid } from './lib/uid';
 export { mapToUserFriendlyName, mapToInternalType } from './lib/transform';
 export { getIntermediateRepresentationSchema } from './lib/schemas';
+export { createAjvInstance } from './lib/validation';
+export { ValidateFunction, AnySchema, ErrorObject };
+export { metafileExtension, hsProjectJsonFilename } from './lib/constants';
+export { Components } from './lib/types';
+export { AjvErrorKeyword } from './lib/errors';
+export { getInvalidJsonError, getMissingTypeError, getMissingConfigError, getMissingAccountIdError, getMissingRequiredFieldError, getFailedToFetchSchemasError, getUnsupportedTypeError, } from './lang/copy';

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.getIntermediateRepresentationSchema = exports.mapToInternalType = exports.mapToUserFriendlyName = exports.validateUid = exports.migrate = exports.isTranslationError = void 0;
+exports.getUnsupportedTypeError = exports.getFailedToFetchSchemasError = exports.getMissingRequiredFieldError = exports.getMissingAccountIdError = exports.getMissingConfigError = exports.getMissingTypeError = exports.getInvalidJsonError = exports.AjvErrorKeyword = exports.hsProjectJsonFilename = exports.metafileExtension = exports.createAjvInstance = exports.getIntermediateRepresentationSchema = exports.mapToInternalType = exports.mapToUserFriendlyName = exports.validateUid = exports.migrate = exports.isTranslationError = void 0;
 exports.translate = translate;
 exports.translateForLocalDev = translateForLocalDev;
 const files_1 = require("./lib/files");
@@ -57,3 +57,18 @@ Object.defineProperty(exports, "mapToUserFriendlyName", { enumerable: true, get:
 Object.defineProperty(exports, "mapToInternalType", { enumerable: true, get: function () { return transform_2.mapToInternalType; } });
 var schemas_1 = require("./lib/schemas");
 Object.defineProperty(exports, "getIntermediateRepresentationSchema", { enumerable: true, get: function () { return schemas_1.getIntermediateRepresentationSchema; } });
+var validation_2 = require("./lib/validation");
+Object.defineProperty(exports, "createAjvInstance", { enumerable: true, get: function () { return validation_2.createAjvInstance; } });
+var constants_1 = require("./lib/constants");
+Object.defineProperty(exports, "metafileExtension", { enumerable: true, get: function () { return constants_1.metafileExtension; } });
+Object.defineProperty(exports, "hsProjectJsonFilename", { enumerable: true, get: function () { return constants_1.hsProjectJsonFilename; } });
+var errors_2 = require("./lib/errors");
+Object.defineProperty(exports, "AjvErrorKeyword", { enumerable: true, get: function () { return errors_2.AjvErrorKeyword; } });
+var copy_2 = require("./lang/copy");
+Object.defineProperty(exports, "getInvalidJsonError", { enumerable: true, get: function () { return copy_2.getInvalidJsonError; } });
+Object.defineProperty(exports, "getMissingTypeError", { enumerable: true, get: function () { return copy_2.getMissingTypeError; } });
+Object.defineProperty(exports, "getMissingConfigError", { enumerable: true, get: function () { return copy_2.getMissingConfigError; } });
+Object.defineProperty(exports, "getMissingAccountIdError", { enumerable: true, get: function () { return copy_2.getMissingAccountIdError; } });
+Object.defineProperty(exports, "getMissingRequiredFieldError", { enumerable: true, get: function () { return copy_2.getMissingRequiredFieldError; } });
+Object.defineProperty(exports, "getFailedToFetchSchemasError", { enumerable: true, get: function () { return copy_2.getFailedToFetchSchemasError; } });
+Object.defineProperty(exports, "getUnsupportedTypeError", { enumerable: true, get: function () { return copy_2.getUnsupportedTypeError; } });

package/src/lang/copy.d.ts

@@ -27,6 +27,13 @@ export declare const errorMessages: {
         wrongDirectoryForComponent: (directory: string, componentType: string, componentMetadata: ComponentMetadata, correctDir: string) => string;
     };
 };
+export declare function getInvalidJsonError(): string;
+export declare function getMissingTypeError(): string;
+export declare function getMissingConfigError(): string;
+export declare function getMissingAccountIdError(): string;
+export declare function getMissingRequiredFieldError(field: string): string;
+export declare function getFailedToFetchSchemasError(): string;
+export declare function getUnsupportedTypeError(type: string): string;
 export declare const logMessages: {
     files: {
         skippingPath: (path: string) => string;

package/src/lang/copy.js

@@ -1,6 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.logMessages = exports.errorMessages = void 0;
+exports.getInvalidJsonError = getInvalidJsonError;
+exports.getMissingTypeError = getMissingTypeError;
+exports.getMissingConfigError = getMissingConfigError;
+exports.getMissingAccountIdError = getMissingAccountIdError;
+exports.getMissingRequiredFieldError = getMissingRequiredFieldError;
+exports.getFailedToFetchSchemasError = getFailedToFetchSchemasError;
+exports.getUnsupportedTypeError = getUnsupportedTypeError;
 const constants_1 = require("../lib/constants");
 const transform_1 = require("../lib/transform");
 exports.errorMessages = {
@@ -31,6 +38,27 @@ exports.errorMessages = {
         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`,
     },
 };
+function getInvalidJsonError() {
+    return exports.errorMessages.validation.invalidJson;
+}
+function getMissingTypeError() {
+    return exports.errorMessages.validation.missingType;
+}
+function getMissingConfigError() {
+    return exports.errorMessages.validation.missingConfig;
+}
+function getMissingAccountIdError() {
+    return exports.errorMessages.api.accountIdIsRequiredToFetchSchemas;
+}
+function getMissingRequiredFieldError(field) {
+    return exports.errorMessages.validation.missingRequiredField(field);
+}
+function getFailedToFetchSchemasError() {
+    return exports.errorMessages.api.failedToFetchSchemas;
+}
+function getUnsupportedTypeError(type) {
+    return exports.errorMessages.validation.unsupportedType(type);
+}
 exports.logMessages = {
     files: {
         skippingPath: (path) => `Skipping ${path} as it is not in a valid directory`,

package/src/lib/constants.d.ts

@@ -27,6 +27,7 @@ export declare const Components: Record<string, ComponentMetadata>;
 export declare const userFacingToInternalType: Record<string, string>;
 export declare const internalTypeToUserFacing: Record<string, string>;
 export declare const metafileExtension = "-hsmeta.json";
+export declare const hsProjectJsonFilename = "hsproject.json";
 export declare const packageJson = "package.json";
 export declare const packageLockJson = "package-lock.json";
 export declare const allowedAppSubComponentsDirs: string[];

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.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.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;
 // Top Level Component types
 const path = __importStar(require("path"));
 // Component types
@@ -159,6 +159,7 @@ exports.userFacingToInternalType = {
 };
 exports.internalTypeToUserFacing = Object.fromEntries(Object.entries(exports.userFacingToInternalType).map(([key, value]) => [value, key]));
 exports.metafileExtension = '-hsmeta.json';
+exports.hsProjectJsonFilename = 'hsproject.json';
 exports.packageJson = 'package.json';
 exports.packageLockJson = 'package-lock.json';
 function getSubComponentDirsForParentType(parentComponent) {

package/src/lib/errors.d.ts

@@ -8,3 +8,24 @@ export declare class TranslationError extends Error {
     constructor(message: string, transformations: Transformation[], errors: (ErrorObject[] | null | undefined)[], translationContext: TranslationContext);
     toString(): string;
 }
+export declare const AjvErrorKeyword: {
+    AdditionalItems: string;
+    AdditionalProperties: string;
+    Dependencies: string;
+    Enum: string;
+    ExclusiveMaximum: string;
+    ExclusiveMinimum: string;
+    Maximum: string;
+    MaxItems: string;
+    MaxLength: string;
+    MaxProperties: string;
+    Minimum: string;
+    MinItems: string;
+    MinLength: string;
+    MinProperties: string;
+    MultipleOf: string;
+    OneOf: string;
+    Pattern: string;
+    Required: string;
+    Type: string;
+};

package/src/lib/errors.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.TranslationError = void 0;
+exports.AjvErrorKeyword = exports.TranslationError = void 0;
 exports.isTranslationError = isTranslationError;
 exports.compileError = compileError;
 const copy_1 = require("../lang/copy");
@@ -152,3 +152,24 @@ function isEnumError(error) {
 function isTypeError(error) {
     return error.keyword === JSON_SCHEMA_VALIDATION_KEYWORDS.type;
 }
+exports.AjvErrorKeyword = {
+    AdditionalItems: 'additionalItems',
+    AdditionalProperties: 'additionalProperties',
+    Dependencies: 'dependencies',
+    Enum: 'enum',
+    ExclusiveMaximum: 'exclusiveMaximum',
+    ExclusiveMinimum: 'exclusiveMinimum',
+    Maximum: 'maximum',
+    MaxItems: 'maxItems',
+    MaxLength: 'maxLength',
+    MaxProperties: 'maxProperties',
+    Minimum: 'minimum',
+    MinItems: 'minItems',
+    MinLength: 'minLength',
+    MinProperties: 'minProperties',
+    MultipleOf: 'multipleOf',
+    OneOf: 'oneOf',
+    Pattern: 'pattern',
+    Required: 'required',
+    Type: 'type',
+};

package/src/lib/migrate.js

@@ -12,22 +12,21 @@ const constants_1 = require("./constants");
 const index_1 = require("../index");
 const IR_FILENAME = 'ir.json';
 const filesDirectory = 'files';
-const hsProjectJsonFilename = 'hsproject.json';
 const OUTPUT_IR_FILE = 'FULL_IR.json';
 async function migrate(inputDir, outputDir) {
     if (!fs_2.default.existsSync(inputDir)) {
         throw new Error(`Input directory ${inputDir} does not exist`);
     }
-    const hsProjectJsonPath = path_1.default.join(inputDir, hsProjectJsonFilename);
+    const hsProjectJsonPath = path_1.default.join(inputDir, constants_1.hsProjectJsonFilename);
     if (!fs_2.default.existsSync(hsProjectJsonPath)) {
-        throw new Error(`hsproject.json file does not exist in ${inputDir}`);
+        throw new Error(`${constants_1.hsProjectJsonFilename} file does not exist in ${inputDir}`);
     }
     let hsProjectJson;
     try {
         hsProjectJson = loadJsonFile(hsProjectJsonPath);
     }
     catch (e) {
-        throw new Error(`Error parsing hsproject.json: ${e}`);
+        throw new Error(`Error parsing ${constants_1.hsProjectJsonFilename}: ${e}`);
     }
     const files = await (0, fs_1.walk)(inputDir);
     const sourceCodeOutputDir = path_1.default.join(outputDir, 'src');

package/src/lib/validation.d.ts

@@ -1,5 +1,5 @@
 import { CompiledError, IntermediateRepresentation, Transformation, TranslationContext } from './types';
-import { ValidateFunction } from 'ajv/dist/2020';
+import Ajv, { ValidateFunction } from 'ajv/dist/2020';
 export type ValidResult = {
     valid: true;
     errors?: null;
@@ -10,4 +10,5 @@ export type ValidationResults = {
     errors?: CompiledError;
     schemaValidationErrors?: ValidateFunction['errors'];
 } | ValidResult;
+export declare function createAjvInstance(): Ajv;
 export declare function validateIntermediateRepresentation(intermediateRepresentation: IntermediateRepresentation, transformation: Transformation[], translationContext: TranslationContext): Promise<ValidResult>;

package/src/lib/validation.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.createAjvInstance = createAjvInstance;
 exports.validateIntermediateRepresentation = validateIntermediateRepresentation;
 const schemas_1 = require("./schemas");
 const _2020_1 = __importDefault(require("ajv/dist/2020"));
@@ -13,6 +14,11 @@ const path_1 = __importDefault(require("path"));
 const transform_1 = require("./transform");
 const ajv_formats_1 = __importDefault(require("ajv-formats"));
 const uid_1 = require("./uid");
+function createAjvInstance() {
+    const ajv = new _2020_1.default({ allErrors: true });
+    (0, ajv_formats_1.default)(ajv);
+    return ajv;
+}
 function validateIntermediateRepresentationNode(schema, transformation, irNode, index, translationContext) {
     if (constants_1.AutoGeneratedComponentTypes.includes((0, transform_1.mapToUserFacingType)(irNode.componentType))) {
         // Skip validation for auto-generated components
@@ -26,8 +32,7 @@ function validateIntermediateRepresentationNode(schema, transformation, irNode,
             errors: (0, errors_1.compileError)(transformation[index]),
         };
     }
-    const ajv = new _2020_1.default({ allErrors: true });
-    (0, ajv_formats_1.default)(ajv);
+    const ajv = createAjvInstance();
     let shouldSkipValidation = false;
     if (!irNode.uid) {
         transformation[index].fileParseResult.errors.push(copy_1.errorMessages.validation.missingUid);