definition-generator-framework 1.12.3 → 1.12.5

package/dist/helpers/validator/custom-validator-helper/custom-validator.helper.spec.js

@@ -0,0 +1,173 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AssetComponentName = void 0;
+const joi_1 = __importDefault(require("joi"));
+const joi_custom_validators_1 = require("../joi-custom-validators");
+const mocks_1 = require("../../../_mocks/mocks");
+const raw_definition_helper_1 = require("../../raw-definition-helper/raw-definition.helper");
+const custom_validator_helper_1 = require("./custom-validator.helper");
+const context_1 = require("../../../framework/context");
+const definition_store_1 = require("../../../framework/definition-store");
+joi_custom_validators_1.JoiCustomValidators.decorate(joi_1.default, { existsSync: (path) => path !== 'D:/test/false/path.png' });
+exports.AssetComponentName = 'ASSET';
+class Asset {
+    static { this.$meta = {
+        componentName: exports.AssetComponentName
+    }; }
+    async process() { }
+}
+class AssetGroup {
+    static { this.$meta = {
+        componentName: 'ASSET-GROUP'
+    }; }
+    async process() { }
+}
+function getSimpleRawDefinition(value, offset = 1) {
+    return {
+        componentName: exports.AssetComponentName,
+        location: mocks_1.SampleLocation1,
+        parsedStructure: {
+            line: mocks_1.SampleLocation1.line + offset,
+            rawData: {
+                value: {
+                    rawData: value,
+                    line: mocks_1.SampleLocation1.line + offset
+                }
+            }
+        }
+    };
+}
+function getFlatRawDefinition(value, offset = 1) {
+    return {
+        componentName: exports.AssetComponentName,
+        location: mocks_1.SampleLocation1,
+        parsedStructure: {
+            line: mocks_1.SampleLocation1.line + offset,
+            rawData: value
+        }
+    };
+}
+describe('JOI CUSTOM VALIDATORS', () => {
+    beforeEach(() => {
+        context_1.Context.config.projectRoot = 'D:/';
+        custom_validator_helper_1.CustomValidatorHelper['duplicateHelpers'] = new Map();
+    });
+    describe('Variable Name', () => {
+        let schema = joi_1.default.object().keys({
+            value: joi_1.default.string().required()
+        });
+        test('valid data', () => {
+            let rawDefinition = getSimpleRawDefinition('test');
+            let { value, error } = schema.validate(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition), {
+                abortEarly: false,
+                context: rawDefinition
+            });
+            expect(value).toEqual({ value: 'test' });
+            expect(error).toEqual(undefined);
+        });
+        test('different groups should not create duplicates', () => {
+            let schema2 = joi_1.default.object().keys({
+                value: joi_1.default.string().required()
+            });
+            let rawDefinition1 = getSimpleRawDefinition('test', 1);
+            let rawDefinition2 = getSimpleRawDefinition('test', 2);
+            schema.validate(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition1), { abortEarly: false, context: rawDefinition1 });
+            schema2.validate(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition2), { abortEarly: false, context: rawDefinition2 });
+            (0, mocks_1.resetContext)();
+            custom_validator_helper_1.CustomValidatorHelper.logDuplicates();
+            expect(context_1.Context.errorLogs).toStrictEqual([]);
+        });
+    });
+    describe('Reference', () => {
+        let schema = joi_1.default.object().keys({
+            value: joi_1.default.string().reference(Asset).required()
+        });
+        let multipleSchema = joi_1.default.object().keys({
+            value: joi_1.default.string().reference([AssetGroup, Asset]).required()
+        });
+        test('valid data', () => {
+            let rawDefinition = getSimpleRawDefinition('test');
+            definition_store_1.DefinitionStore['setRawDefinition'](Asset, 'test', rawDefinition);
+            let { value, error } = schema.validate(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition), {
+                abortEarly: false,
+                context: rawDefinition
+            });
+            expect(value).toEqual({ value: 'test' });
+            expect(error).toEqual(undefined);
+        });
+        test('multiple reference', () => {
+            let rawDefinition = getSimpleRawDefinition('test');
+            definition_store_1.DefinitionStore['setRawDefinition'](Asset, 'test', rawDefinition);
+            let { value, error } = multipleSchema.validate(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition), {
+                abortEarly: false,
+                context: rawDefinition
+            });
+            expect(value).toEqual({ value: 'test' });
+            expect(error).toEqual(undefined);
+        });
+        test('primitive valid data', () => {
+            let rawDefinition = getFlatRawDefinition('test');
+            let primitiveSchema = joi_1.default.string().reference(Asset).required();
+            definition_store_1.DefinitionStore['setRawDefinition'](Asset, 'test', rawDefinition);
+            let { value, error } = primitiveSchema.validate(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition), {
+                abortEarly: false,
+                context: rawDefinition
+            });
+            expect(value).toEqual('test');
+            expect(error).toEqual(undefined);
+        });
+    });
+    describe('Path', () => {
+        let schema = joi_1.default.object().keys({
+            value: joi_1.default.string().path().required()
+        });
+        test('valid data', () => {
+            let rawDefinition = getSimpleRawDefinition('images/test.png');
+            let { value, error } = schema.validate(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition), {
+                abortEarly: false,
+                context: rawDefinition
+            });
+            expect(value).toEqual({ value: '.test/images/test.png' });
+            expect(error).toEqual(undefined);
+        });
+        test('should detect files not existing, invalid url', () => {
+            let rawDefinition = getSimpleRawDefinition('invalid data');
+            let { error } = schema.validate(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition), { abortEarly: false, context: rawDefinition });
+            expect(error?.details).toStrictEqual([
+                {
+                    message: '"value" with value "invalid data" fails to match the required pattern: /^[\\S]+$/',
+                    path: ['value'],
+                    type: 'string.pattern.base',
+                    context: {
+                        name: undefined,
+                        regex: /^[\S]+$/,
+                        value: 'invalid data',
+                        label: 'value',
+                        key: 'value'
+                    }
+                }
+            ]);
+        });
+        test('should detect files not existing, missing file', () => {
+            let rawDefinition = getSimpleRawDefinition('false/path.png');
+            let { error } = schema.validate(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition), { abortEarly: false, context: rawDefinition });
+            expect(error?.details).toStrictEqual([
+                {
+                    message: '"value" failed custom validation because No file is found in the path: "D:/test/false/path.png"',
+                    path: ['value'],
+                    type: 'any.custom',
+                    context: {
+                        error: new Error('No file is found in the path: "D:/test/false/path.png"'),
+                        label: 'value',
+                        value: 'false/path.png',
+                        key: 'value'
+                    }
+                }
+            ]);
+        });
+    });
+});
+//# sourceMappingURL=custom-validator.helper.spec.js.map

package/dist/helpers/validator/joi-custom-validators.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/helpers/validator/joi-custom-validators.spec.js

@@ -0,0 +1,260 @@
+"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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Joi = __importStar(require("joi"));
+const joi_custom_validators_1 = require("./joi-custom-validators");
+const mocks_1 = require("../../_mocks/mocks");
+const raw_definition_helper_1 = require("../raw-definition-helper/raw-definition.helper");
+joi_custom_validators_1.JoiCustomValidators.decorate({ existsSync: (path) => path !== 'D:/test/false/path.png' });
+const DefinitionType = 'ASSET';
+class Asset {
+    static { this.$meta = {
+        definitionName: DefinitionType
+    }; }
+    async process() { }
+}
+class AssetGroup {
+    static { this.$meta = {
+        definitionName: 'ASSET-GROUP'
+    }; }
+    async process() { }
+}
+function getSimpleRawDefinition(value, offset = 1) {
+    return {
+        type: DefinitionType,
+        location: mocks_1.SampleLocation1,
+        parsedStructure: {
+            line: mocks_1.SampleLocation1.line + offset,
+            rawData: {
+                value: {
+                    rawData: value,
+                    line: mocks_1.SampleLocation1.line + offset
+                }
+            }
+        }
+    };
+}
+function getFlatRawDefinition(value, offset = 1) {
+    return {
+        type: DefinitionType,
+        location: mocks_1.SampleLocation1,
+        parsedStructure: {
+            line: mocks_1.SampleLocation1.line + offset,
+            rawData: value
+        }
+    };
+}
+describe('JOI CUSTOM VALIDATORS', () => {
+    beforeEach(() => {
+        let validators = joi_custom_validators_1.JoiCustomValidators;
+        validators.rootDirectory = 'D:/';
+        validators.definitionNames = new Map();
+        validators.duplicateHelpers = new Map();
+    });
+    describe('Variable Name', () => {
+        let schema = Joi.object().keys({
+            value: Joi.string().uniqueNameGroup(Asset).required()
+        });
+        test('valid data', () => {
+            let rawDefinition = getSimpleRawDefinition('test');
+            let { value, error } = schema.validate(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition), {
+                abortEarly: false,
+                context: rawDefinition
+            });
+            expect(value).toEqual({ value: 'assetTest' });
+            expect(error).toEqual(undefined);
+        });
+        test('invalid data', () => {
+            let rawDefinition = getSimpleRawDefinition('invalid data');
+            let { error } = schema.validate(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition), { abortEarly: false, context: rawDefinition });
+            expect(error?.details).toStrictEqual([
+                {
+                    message: '"value" with value "invalid data" fails to match the required pattern: /^[a-z]+([a-zA-Z0-9]+)*$/',
+                    path: [],
+                    type: 'string.pattern.base',
+                    context: {
+                        name: undefined,
+                        regex: /^[a-z]+([a-zA-Z0-9]+)*$/,
+                        value: 'invalid data',
+                        label: 'value',
+                        key: 'value'
+                    }
+                }
+            ]);
+        });
+        test('should detect duplicate variable names', () => {
+            let rawDefinition1 = getSimpleRawDefinition('test', 1);
+            let rawDefinition2 = getSimpleRawDefinition('test', 2);
+            schema.validate(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition1), { abortEarly: false, context: rawDefinition1 });
+            schema.validate(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition2), { abortEarly: false, context: rawDefinition2 });
+            let context = (0, mocks_1.getMockContext)();
+            joi_custom_validators_1.JoiCustomValidators.logDuplicates(context);
+            expect(context.errorLogs).toStrictEqual([
+                {
+                    description: 'Value should be singular! Group: "ASSET", Value: "test"',
+                    location: { line: mocks_1.SampleLocation1.line + 1, path: 'D:/test/file-1.md' }
+                },
+                {
+                    description: 'Value should be singular! Group: "ASSET", Value: "test"',
+                    location: { line: mocks_1.SampleLocation1.line + 2, path: 'D:/test/file-1.md' }
+                }
+            ]);
+        });
+        test('different groups should not create duplicates', () => {
+            let schema2 = Joi.object().keys({
+                value: Joi.string().uniqueNameGroup(AssetGroup).required()
+            });
+            let rawDefinition1 = getSimpleRawDefinition('test', 1);
+            let rawDefinition2 = getSimpleRawDefinition('test', 2);
+            schema.validate(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition1), { abortEarly: false, context: rawDefinition1 });
+            schema2.validate(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition2), { abortEarly: false, context: rawDefinition2 });
+            let context = (0, mocks_1.getMockContext)();
+            joi_custom_validators_1.JoiCustomValidators.logDuplicates(context);
+            expect(context.errorLogs).toStrictEqual([]);
+        });
+    });
+    describe('Reference', () => {
+        let schema = Joi.object().keys({
+            value: Joi.string().reference(Asset).required()
+        });
+        let multipleSchema = Joi.object().keys({
+            value: Joi.string().reference([AssetGroup, Asset]).required()
+        });
+        test('valid data', () => {
+            let rawDefinition = getSimpleRawDefinition('test');
+            let validators = joi_custom_validators_1.JoiCustomValidators;
+            validators.getDefinitionNames(DefinitionType).add('test');
+            let { value, error } = schema.validate(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition), {
+                abortEarly: false,
+                context: rawDefinition
+            });
+            expect(value).toEqual({ value: 'assetTest' });
+            expect(error).toEqual(undefined);
+        });
+        test('multiple reference', () => {
+            let rawDefinition = getSimpleRawDefinition('test');
+            let validators = joi_custom_validators_1.JoiCustomValidators;
+            validators.getDefinitionNames(DefinitionType).add('test');
+            let { value, error } = multipleSchema.validate(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition), {
+                abortEarly: false,
+                context: rawDefinition
+            });
+            expect(value).toEqual({ value: 'assetTest' });
+            expect(error).toEqual(undefined);
+        });
+        test('primitive valid data', () => {
+            let rawDefinition = getFlatRawDefinition('test');
+            let primitiveSchema = Joi.string().reference(Asset).required();
+            let validators = joi_custom_validators_1.JoiCustomValidators;
+            validators.getDefinitionNames(DefinitionType).add('test');
+            let { value, error } = primitiveSchema.validate(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition), {
+                abortEarly: false,
+                context: rawDefinition
+            });
+            expect(value).toEqual('assetTest');
+            expect(error).toEqual(undefined);
+        });
+        test('should detect non existing references', () => {
+            let rawDefinition = getSimpleRawDefinition('test');
+            let { error } = schema.validate(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition), { abortEarly: false, context: rawDefinition });
+            expect(error?.details).toEqual([
+                {
+                    context: {
+                        key: 'value',
+                        label: 'value',
+                        value: 'test'
+                    },
+                    message: 'There is no definition found for "test" in name field: "ASSET"',
+                    path: ['value'],
+                    type: 'any.custom'
+                }
+            ]);
+        });
+        test('should detect non existing multiple references', () => {
+            let rawDefinition = getSimpleRawDefinition('test');
+            let { error } = multipleSchema.validate(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition), {
+                abortEarly: false,
+                context: rawDefinition
+            });
+            expect(error?.details).toEqual([
+                {
+                    context: {
+                        key: 'value',
+                        label: 'value',
+                        value: 'test'
+                    },
+                    message: 'There is no definition found for "test" in name field: "ASSET-GROUP, ASSET"',
+                    path: ['value'],
+                    type: 'any.custom'
+                }
+            ]);
+        });
+    });
+    describe('Path', () => {
+        let schema = Joi.object().keys({
+            value: Joi.string().path().required()
+        });
+        test('valid data', () => {
+            let rawDefinition = getSimpleRawDefinition('images/test.png');
+            let { value, error } = schema.validate(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition), {
+                abortEarly: false,
+                context: rawDefinition
+            });
+            expect(value).toEqual({ value: '.test/images/test.png' });
+            expect(error).toEqual(undefined);
+        });
+        test('should detect files not existing', () => {
+            let rawDefinition = getSimpleRawDefinition('invalid data');
+            let { error } = schema.validate(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition), { abortEarly: false, context: rawDefinition });
+            expect(error?.details).toStrictEqual([
+                {
+                    message: '"value" with value "invalid data" fails to match the required pattern: /^[\\S]+$/',
+                    path: ['value'],
+                    type: 'string.pattern.base',
+                    context: {
+                        name: undefined,
+                        regex: /^[\S]+$/,
+                        value: 'invalid data',
+                        label: 'value',
+                        key: 'value'
+                    }
+                }
+            ]);
+        });
+        test('should detect files not existing', () => {
+            let rawDefinition = getSimpleRawDefinition('false/path.png');
+            let { error } = schema.validate(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition), { abortEarly: false, context: rawDefinition });
+            expect(error?.details).toStrictEqual([
+                {
+                    message: 'No file is found in the path: "false/path.png"',
+                    path: ['value'],
+                    type: 'any.custom',
+                    context: { label: 'value', value: 'false/path.png', key: 'value' }
+                }
+            ]);
+        });
+    });
+});
+//# sourceMappingURL=joi-custom-validators.spec.js.map

package/dist/helpers/validator/validator.spec.d.ts

@@ -0,0 +1 @@
+export {};