definition-generator-framework 1.13.0 → 2.0.0-rc0

package/dist/helpers/raw-definition-helper/raw-definition.helper.spec.js

@@ -1,143 +0,0 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', { value: true });
-const mocks_1 = require('../../_mocks/mocks');
-const raw_definition_helper_1 = require('./raw-definition.helper');
-const ComponentName = 'ASSET';
-describe('RAW DEFINITION HELPER', () => {
-  describe('Find Parsed Structure', () => {
-    test('nested definition', () => {
-      let rawDefinition = {
-        componentName: ComponentName,
-        location: mocks_1.SampleLocation1,
-        parsedStructure: {
-          line: mocks_1.SampleLocation1.line + 1,
-          rawData: {
-            obj1: {
-              line: mocks_1.SampleLocation1.line + 2,
-              rawData: [
-                {
-                  line: mocks_1.SampleLocation1.line + 3,
-                  rawData: {
-                    obj2: {
-                      line: mocks_1.SampleLocation1.line + 4,
-                      rawData: 'test data'
-                    }
-                  }
-                }
-              ]
-            }
-          }
-        }
-      };
-      expect(raw_definition_helper_1.RawDefinitionHelper.findLine(rawDefinition, [])).toEqual(mocks_1.SampleLocation1.line + 1);
-      expect(raw_definition_helper_1.RawDefinitionHelper.findLine(rawDefinition, ['obj1'])).toEqual(
-        mocks_1.SampleLocation1.line + 2
-      );
-      expect(raw_definition_helper_1.RawDefinitionHelper.findLine(rawDefinition, ['obj1', 0])).toEqual(
-        mocks_1.SampleLocation1.line + 3
-      );
-      expect(raw_definition_helper_1.RawDefinitionHelper.findLine(rawDefinition, ['obj1', 0, 'obj2'])).toEqual(
-        mocks_1.SampleLocation1.line + 4
-      );
-      expect(raw_definition_helper_1.RawDefinitionHelper.findLine(rawDefinition, ['notExists'])).toEqual(
-        mocks_1.SampleLocation1.line + 1
-      );
-    });
-  });
-  describe('Flattening', () => {
-    test('primitive', () => {
-      let rawDefinition = {
-        componentName: ComponentName,
-        location: mocks_1.SampleLocation1,
-        parsedStructure: {
-          line: 0,
-          rawData: 'test'
-        }
-      };
-      let expected = 'test';
-      expect(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition)).toStrictEqual(expected);
-    });
-    test('array', () => {
-      let rawDefinition = {
-        componentName: ComponentName,
-        location: mocks_1.SampleLocation1,
-        parsedStructure: {
-          line: 0,
-          rawData: [
-            {
-              line: 0,
-              rawData: [
-                {
-                  line: 0,
-                  rawData: 'orange'
-                },
-                {
-                  line: 0,
-                  rawData: 'banana'
-                }
-              ]
-            },
-            {
-              line: 0,
-              rawData: [
-                {
-                  line: 0,
-                  rawData: '1'
-                },
-                {
-                  line: 0,
-                  rawData: '2'
-                }
-              ]
-            }
-          ]
-        }
-      };
-      let expected = [
-        ['orange', 'banana'],
-        ['1', '2']
-      ];
-      expect(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition)).toStrictEqual(expected);
-    });
-    test('object', () => {
-      let rawDefinition = {
-        componentName: ComponentName,
-        location: mocks_1.SampleLocation1,
-        parsedStructure: {
-          line: 0,
-          rawData: {
-            array1: {
-              line: 0,
-              rawData: [
-                {
-                  line: 0,
-                  rawData: 'apple'
-                },
-                {
-                  line: 0,
-                  rawData: 'orange'
-                }
-              ]
-            },
-            array2: {
-              line: 0,
-              rawData: [
-                {
-                  line: 0,
-                  rawData: 'xWing'
-                },
-                {
-                  line: 0,
-                  rawData: 'tieFighter'
-                }
-              ]
-            }
-          }
-        }
-      };
-      let expected = { array1: ['apple', 'orange'], array2: ['xWing', 'tieFighter'] };
-      expect(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition)).toStrictEqual(expected);
-    });
-  });
-});
-//# sourceMappingURL=raw-definition.helper.spec.js.map

package/dist/helpers/raw-definition-helper/raw-definition.helper.test.d.ts

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

package/dist/helpers/raw-definition-helper/raw-definition.helper.test.js

@@ -1,136 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const vitest_1 = require("vitest");
-const mocks_1 = require("../../_mocks/mocks");
-const raw_definition_helper_1 = require("./raw-definition.helper");
-const ComponentName = 'ASSET';
-(0, vitest_1.describe)('RAW DEFINITION HELPER', () => {
-    (0, vitest_1.describe)('Find Parsed Structure', () => {
-        (0, vitest_1.test)('nested definition', () => {
-            let rawDefinition = {
-                componentName: ComponentName,
-                location: mocks_1.SampleLocation1,
-                parsedStructure: {
-                    line: mocks_1.SampleLocation1.line + 1,
-                    rawData: {
-                        obj1: {
-                            line: mocks_1.SampleLocation1.line + 2,
-                            rawData: [
-                                {
-                                    line: mocks_1.SampleLocation1.line + 3,
-                                    rawData: {
-                                        obj2: {
-                                            line: mocks_1.SampleLocation1.line + 4,
-                                            rawData: 'test data'
-                                        }
-                                    }
-                                }
-                            ]
-                        }
-                    }
-                }
-            };
-            (0, vitest_1.expect)(raw_definition_helper_1.RawDefinitionHelper.findLine(rawDefinition, [])).toEqual(mocks_1.SampleLocation1.line + 1);
-            (0, vitest_1.expect)(raw_definition_helper_1.RawDefinitionHelper.findLine(rawDefinition, ['obj1'])).toEqual(mocks_1.SampleLocation1.line + 2);
-            (0, vitest_1.expect)(raw_definition_helper_1.RawDefinitionHelper.findLine(rawDefinition, ['obj1', 0])).toEqual(mocks_1.SampleLocation1.line + 3);
-            (0, vitest_1.expect)(raw_definition_helper_1.RawDefinitionHelper.findLine(rawDefinition, ['obj1', 0, 'obj2'])).toEqual(mocks_1.SampleLocation1.line + 4);
-            (0, vitest_1.expect)(raw_definition_helper_1.RawDefinitionHelper.findLine(rawDefinition, ['notExists'])).toEqual(mocks_1.SampleLocation1.line + 1);
-        });
-    });
-    (0, vitest_1.describe)('Flattening', () => {
-        (0, vitest_1.test)('primitive', () => {
-            let rawDefinition = {
-                componentName: ComponentName,
-                location: mocks_1.SampleLocation1,
-                parsedStructure: {
-                    line: 0,
-                    rawData: 'test'
-                }
-            };
-            let expected = 'test';
-            (0, vitest_1.expect)(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition)).toStrictEqual(expected);
-        });
-        (0, vitest_1.test)('array', () => {
-            let rawDefinition = {
-                componentName: ComponentName,
-                location: mocks_1.SampleLocation1,
-                parsedStructure: {
-                    line: 0,
-                    rawData: [
-                        {
-                            line: 0,
-                            rawData: [
-                                {
-                                    line: 0,
-                                    rawData: 'orange'
-                                },
-                                {
-                                    line: 0,
-                                    rawData: 'banana'
-                                }
-                            ]
-                        },
-                        {
-                            line: 0,
-                            rawData: [
-                                {
-                                    line: 0,
-                                    rawData: '1'
-                                },
-                                {
-                                    line: 0,
-                                    rawData: '2'
-                                }
-                            ]
-                        }
-                    ]
-                }
-            };
-            let expected = [
-                ['orange', 'banana'],
-                ['1', '2']
-            ];
-            (0, vitest_1.expect)(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition)).toStrictEqual(expected);
-        });
-        (0, vitest_1.test)('object', () => {
-            let rawDefinition = {
-                componentName: ComponentName,
-                location: mocks_1.SampleLocation1,
-                parsedStructure: {
-                    line: 0,
-                    rawData: {
-                        array1: {
-                            line: 0,
-                            rawData: [
-                                {
-                                    line: 0,
-                                    rawData: 'apple'
-                                },
-                                {
-                                    line: 0,
-                                    rawData: 'orange'
-                                }
-                            ]
-                        },
-                        array2: {
-                            line: 0,
-                            rawData: [
-                                {
-                                    line: 0,
-                                    rawData: 'xWing'
-                                },
-                                {
-                                    line: 0,
-                                    rawData: 'tieFighter'
-                                }
-                            ]
-                        }
-                    }
-                }
-            };
-            let expected = { array1: ['apple', 'orange'], array2: ['xWing', 'tieFighter'] };
-            (0, vitest_1.expect)(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition)).toStrictEqual(expected);
-        });
-    });
-});
-//# sourceMappingURL=raw-definition.helper.test.js.map

package/dist/helpers/validator/custom-validator-helper/custom-validator.helper.d.ts

@@ -1,16 +0,0 @@
-import Joi from 'joi';
-import { DefinitionComponentClassType } from '../../../decorators/definition-component';
-import { RawDefinition } from '../../../framework/interfaces';
-import { DuplicateHelper } from '../../duplicate-helper/duplicate-helper';
-export declare class CustomValidatorHelper {
-    private static duplicateHelpers;
-    static logDuplicates(): void;
-    static getDefinitionComponentName(definitionComponentClass: DefinitionComponentClassType<any>): string;
-    static getDefinitionComponentNamesFromArray(definitionComponentClasses: DefinitionComponentClassType<any> | DefinitionComponentClassType<any>[]): string[];
-    static getValidationState(helpers: Joi.CustomHelpers): 'notValid' | 'valid';
-    static getPathAndRawDefinition(helpers: Joi.CustomHelpers): {
-        path: string[];
-        rawDefinition: RawDefinition;
-    };
-    static getDuplicateHelper(componentName: string): DuplicateHelper;
-}

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

@@ -1,48 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CustomValidatorHelper = void 0;
-const helpers_lib_1 = require("helpers-lib");
-const duplicate_helper_1 = require("../../duplicate-helper/duplicate-helper");
-class CustomValidatorHelper {
-    static { this.duplicateHelpers = new Map(); }
-    static logDuplicates() {
-        this.duplicateHelpers.forEach(duplicateHelper => duplicateHelper.logDuplicateErrors());
-    }
-    static getDefinitionComponentName(definitionComponentClass) {
-        return definitionComponentClass.$meta.componentName;
-    }
-    static getDefinitionComponentNamesFromArray(definitionComponentClasses) {
-        return helpers_lib_1.Comparator.isArray(definitionComponentClasses)
-            ? definitionComponentClasses.map(definitionComponentClass => this.getDefinitionComponentName(definitionComponentClass))
-            : [this.getDefinitionComponentName(definitionComponentClasses)];
-    }
-    static getValidationState(helpers) {
-        if (!helpers.state.path) {
-            return 'notValid';
-        }
-        else if (helpers.state.path.length === 0) {
-            return 'valid';
-        }
-        else if (helpers.state.path[0] !== undefined && helpers.prefs.context.rawDefinition) {
-            return 'valid';
-        }
-        else {
-            return 'notValid';
-        }
-    }
-    static getPathAndRawDefinition(helpers) {
-        let path = helpers.state.path;
-        let rawDefinition = helpers.prefs.context.rawDefinition;
-        return { path, rawDefinition };
-    }
-    static getDuplicateHelper(componentName) {
-        let duplicateHelper = this.duplicateHelpers.get(componentName);
-        if (!duplicateHelper) {
-            duplicateHelper = new duplicate_helper_1.DuplicateHelper(componentName);
-            this.duplicateHelpers.set(componentName, duplicateHelper);
-        }
-        return duplicateHelper;
-    }
-}
-exports.CustomValidatorHelper = CustomValidatorHelper;
-//# sourceMappingURL=custom-validator.helper.js.map

package/dist/helpers/validator/custom-validator-helper/custom-validator.helper.spec.d.ts

@@ -1 +0,0 @@
-export declare const AssetComponentName = 'ASSET';

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

@@ -1,191 +0,0 @@
-'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/custom-validator-helper/custom-validator.helper.test.d.ts

@@ -1 +0,0 @@
-export declare const AssetComponentName = "ASSET";