definition-generator-framework 1.13.1 → 2.0.0-rc1

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

@@ -1,304 +0,0 @@
-'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.d.ts

@@ -1,21 +0,0 @@
-import Joi from 'joi';
-import { RawDefinition } from '../../framework/interfaces';
-export interface GroupDefinition {
-    name: string;
-    group: string[];
-}
-export interface ValidationContext {
-    readonly rawDefinition: RawDefinition;
-    failSilently?: boolean;
-}
-export interface ValidatedItem<T> {
-    readonly definition: T;
-    readonly rawDefinition: RawDefinition;
-}
-export declare class Validator {
-    static definitionToRawDefintion: Map<any, RawDefinition>;
-    static getRawDefinitions(componentName: string): RawDefinition[];
-    static validateAndConvert<T>(componentName: string, schema: Joi.AnySchema): ValidatedItem<T>[];
-    static validateAndConvertSingular<T>(componentName: string, schema: Joi.AnySchema): ValidatedItem<T> | undefined;
-    private static validate;
-}

package/dist/helpers/validator/validator.js

@@ -1,74 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Validator = void 0;
-const context_1 = require("../../framework/context");
-const raw_definition_helper_1 = require("../raw-definition-helper/raw-definition.helper");
-class Validator {
-    static { this.definitionToRawDefintion = new Map(); }
-    // Cache the definitions
-    static getRawDefinitions(componentName) {
-        return context_1.Context.rawDefinitions.filter(rawDefinition => rawDefinition.componentName === componentName);
-    }
-    static validateAndConvert(componentName, schema) {
-        return this.getRawDefinitions(componentName)
-            .map(rawDefinition => {
-            let definition = this.validate(rawDefinition, schema);
-            this.definitionToRawDefintion.set(definition, rawDefinition);
-            if (definition) {
-                return {
-                    definition,
-                    rawDefinition
-                };
-            }
-        })
-            .filter(validatedItem => validatedItem);
-    }
-    static validateAndConvertSingular(componentName, schema) {
-        let validatedItems = this.validateAndConvert(componentName, schema);
-        if (validatedItems.length === 0) {
-            if (context_1.Context.successful) {
-                let errorLog = {
-                    description: `Singleton definition has no declared entry "${componentName}"`,
-                    location: { line: 0, path: '*' }
-                };
-                context_1.Context.addErrorLog(errorLog, 'lowPriority');
-            }
-        }
-        else if (validatedItems.length > 1) {
-            context_1.Context.rawDefinitions
-                .filter(rawDefinition => rawDefinition.componentName === componentName)
-                .forEach(rawDefinition => {
-                let errorLog = {
-                    description: `Only one definition can be defined for "${componentName}"`,
-                    location: rawDefinition.location
-                };
-                context_1.Context.addErrorLog(errorLog, 'lowPriority');
-            });
-        }
-        else {
-            return validatedItems[0];
-        }
-    }
-    static validate(rawDefinition, schema) {
-        let context = { rawDefinition, failSilently: false };
-        let { value, error } = schema.validate(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition), {
-            abortEarly: false,
-            context
-        });
-        if (error?.details) {
-            let errors = error.details.reverse().map(errorDetail => ({
-                description: errorDetail.message,
-                location: {
-                    line: raw_definition_helper_1.RawDefinitionHelper.findLine(rawDefinition, errorDetail.path),
-                    path: rawDefinition.location.path
-                }
-            }));
-            context_1.Context.addErrorLog(errors.reverse());
-        }
-        else if (!context.failSilently) {
-            return value;
-        }
-    }
-}
-exports.Validator = Validator;
-//# sourceMappingURL=validator.js.map

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

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