definition-generator-framework 1.13.1 → 2.0.0-rc1

package/dist/helpers/validator/custom-validators/path.custom-validator.js

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PathCustomValidator = void 0;
-const context_1 = require("../../../framework/context");
-const custom_validator_helper_1 = require("../custom-validator-helper/custom-validator.helper");
-class PathCustomValidator {
-    constructor(fs) {
-        this.fs = fs;
-        this.regex = /^[\S]+$/;
-        this.validate = (value, helpers) => {
-            let validationState = custom_validator_helper_1.CustomValidatorHelper.getValidationState(helpers);
-            if (validationState === 'valid') {
-                let { rawDefinition } = custom_validator_helper_1.CustomValidatorHelper.getPathAndRawDefinition(helpers);
-                let pathPrefix = rawDefinition.location.path.substring(0, rawDefinition.location.path.lastIndexOf('/') + 1);
-                value = pathPrefix + value;
-                if (!this.fs.existsSync(value)) {
-                    throw new Error(`No file is found in the path: "${value}"`);
-                }
-                else {
-                    return value.replace(context_1.Context.config.projectRoot, '.');
-                }
-            }
-            else {
-                throw new Error(`Internal Error; joi validation context for path validator: Path: "${helpers.state.path}", RawDefinition: "${JSON.stringify(helpers.prefs.context.rawDefinition)}"`);
-            }
-        };
-    }
-}
-exports.PathCustomValidator = PathCustomValidator;
-//# sourceMappingURL=path.custom-validator.js.map

package/dist/helpers/validator/custom-validators/position-on-sprite.d.ts

@@ -1,14 +0,0 @@
-import Joi, { ErrorReport } from 'joi';
-import { RawSpriteDefinition } from '../../../pre-made-components/assets/1-sprite';
-import { CustomObjectValidator } from '../joi-custom-validators';
-export interface PositionOnSpriteValidationOptions {
-    selectSpriteDefinition: (value: any) => RawSpriteDefinition;
-    positionsJsonPath: string | string[];
-    includeRotationFromAnchor?: boolean;
-    checkIfPositionIsOnSprite?: boolean;
-}
-export declare class PositionOnSpriteCustomValidator implements CustomObjectValidator {
-    private options;
-    readonly validate: (value: string, helpers: Joi.CustomHelpers) => any | ErrorReport;
-    constructor(options: PositionOnSpriteValidationOptions);
-}

package/dist/helpers/validator/custom-validators/position-on-sprite.js

@@ -1,44 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PositionOnSpriteCustomValidator = void 0;
-const helpers_lib_1 = require("helpers-lib");
-const jsonpath_plus_1 = require("jsonpath-plus");
-const sprite_validation_helper_1 = require("./helpers/sprite-validation.helper");
-class PositionOnSpriteCustomValidator {
-    constructor(options) {
-        this.options = options;
-        this.validate = (value, helpers) => {
-            let spriteDefinition = this.options.selectSpriteDefinition(value);
-            if (!spriteDefinition) {
-                throw new Error(`positionOnSprite - callback function did not return sprite definition.`);
-            }
-            let spriteValidationHelper = new sprite_validation_helper_1.SpriteValidationHelper(spriteDefinition.url.size, spriteDefinition.anchor, spriteDefinition.scale, this.options.checkIfPositionIsOnSprite);
-            let positionsJsonPaths = Array.isArray(this.options.positionsJsonPath)
-                ? this.options.positionsJsonPath
-                : [this.options.positionsJsonPath];
-            positionsJsonPaths.forEach(jsonPath => (0, jsonpath_plus_1.JSONPath)({ json: value, path: jsonPath }).forEach((item) => {
-                if (!helpers_lib_1.Comparator.isObject(item)) {
-                    throw new Error(`positionOnSprite, positions json path returned a non-object result. Value: "${item}".`);
-                }
-                else if (!helpers_lib_1.Comparator.isNumber(item.x) || !helpers_lib_1.Comparator.isNumber(item.y)) {
-                    throw new Error(`positionOnSprite, positions json path returned a non-vec2 result. Value: "${item}".`);
-                }
-                let positionFromAnchor = spriteValidationHelper.convertPositionToSpriteAnchor(item);
-                positionFromAnchor = { x: Math.round(positionFromAnchor.x), y: Math.round(positionFromAnchor.y) };
-                if (this.options.includeRotationFromAnchor) {
-                    item.rotationFromAnchor = spriteValidationHelper.getRotationFromAnchor(positionFromAnchor);
-                    item.positionFromAnchor = positionFromAnchor;
-                    delete item.x;
-                    delete item.y;
-                }
-                else {
-                    item.x = positionFromAnchor.x;
-                    item.y = positionFromAnchor.y;
-                }
-            }));
-            return value;
-        };
-    }
-}
-exports.PositionOnSpriteCustomValidator = PositionOnSpriteCustomValidator;
-//# sourceMappingURL=position-on-sprite.js.map

package/dist/helpers/validator/custom-validators/reference.custom-validator.d.ts

@@ -1,22 +0,0 @@
-import Joi, { ErrorReport } from 'joi';
-import { DefinitionComponentClassType } from '../../../decorators/definition-component';
-import { CustomStringValidator, ReferenceCustomValidatorOptions } from '../joi-custom-validators';
-declare abstract class ReferenceCustomValidatorBase implements CustomStringValidator {
-    protected options?: ReferenceCustomValidatorOptions | undefined;
-    readonly regex: RegExp;
-    abstract readonly validate: Joi.CustomValidator<any, any>;
-    protected constructor(options?: ReferenceCustomValidatorOptions | undefined);
-    protected validatePropertyExistence(referencedComponent: DefinitionComponentClassType<any>, definitionName: string, options?: ReferenceCustomValidatorOptions): void;
-}
-export declare class ReferenceCustomValidator extends ReferenceCustomValidatorBase {
-    readonly validate: (value: string, helpers: Joi.CustomHelpers) => any | ErrorReport;
-    private includeType;
-    private referencedComponents;
-    constructor(definitionComponentClasses: DefinitionComponentClassType<any> | DefinitionComponentClassType<any>[], options?: ReferenceCustomValidatorOptions);
-}
-export declare class LazyReferenceCustomValidator extends ReferenceCustomValidatorBase {
-    private componentName;
-    readonly validate: (value: string, helpers: Joi.CustomHelpers) => any | ErrorReport;
-    constructor(componentName: string, options?: ReferenceCustomValidatorOptions);
-}
-export {};

package/dist/helpers/validator/custom-validators/reference.custom-validator.js

@@ -1,123 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LazyReferenceCustomValidator = exports.ReferenceCustomValidator = void 0;
-const helpers_lib_1 = require("helpers-lib");
-const context_1 = require("../../../framework/context");
-const definition_store_1 = require("../../../framework/definition-store");
-const raw_definition_helper_1 = require("../../raw-definition-helper/raw-definition.helper");
-const custom_validator_helper_1 = require("../custom-validator-helper/custom-validator.helper");
-class ReferenceCustomValidatorBase {
-    constructor(options) {
-        this.options = options;
-        this.regex = /^[a-z]+([a-zA-Z0-9]+)*$/;
-    }
-    validatePropertyExistence(referencedComponent, definitionName, options) {
-        if (options?.additionalValidation) {
-            let rawDefinition = definition_store_1.DefinitionStore['getRawDefinition'](referencedComponent, definitionName);
-            let flattenedRawDefinition = rawDefinition ? raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition) : undefined;
-            let validation = options.additionalValidation.validate(flattenedRawDefinition);
-            if (validation.error) {
-                throw new Error(validation.error.message);
-            }
-        }
-    }
-}
-class ReferenceCustomValidator extends ReferenceCustomValidatorBase {
-    constructor(definitionComponentClasses, options) {
-        super(options);
-        this.validate = (value, helpers) => {
-            let validationState = custom_validator_helper_1.CustomValidatorHelper.getValidationState(helpers);
-            if (validationState === 'valid') {
-                let referencedComponent = this.referencedComponents.find(component => definition_store_1.DefinitionStore.getDefinition(component, value));
-                if (!referencedComponent) {
-                    let referencedComponentRawDefinitionExists = this.referencedComponents.find(component => definition_store_1.DefinitionStore['isRawDefinitionExists'](component, value));
-                    if (referencedComponentRawDefinitionExists) {
-                        // If referenced definition is failed its own validation, there should be no additional error
-                        helpers.prefs.context.failSilently = true;
-                    }
-                    else {
-                        throw new Error(`There is no "${this.referencedComponents
-                            .map(component => custom_validator_helper_1.CustomValidatorHelper.getDefinitionComponentName(component))
-                            .join(' or ')}" definition found for "${value}"`);
-                    }
-                }
-                else {
-                    this.validatePropertyExistence(referencedComponent, value, this.options);
-                    if (this.includeType) {
-                        return {
-                            value,
-                            type: custom_validator_helper_1.CustomValidatorHelper.getDefinitionComponentName(referencedComponent)
-                        };
-                    }
-                    else {
-                        return value;
-                    }
-                }
-            }
-            else {
-                throw new Error(`Internal Error; joi validation context for reference validator: Path: "${helpers.state.path}", RawDefinition: "${JSON.stringify(helpers.prefs.context)}"`);
-            }
-        };
-        this.referencedComponents = [];
-        if (helpers_lib_1.Comparator.isArray(definitionComponentClasses)) {
-            this.includeType = true;
-            this.referencedComponents = definitionComponentClasses;
-        }
-        else {
-            this.includeType = false;
-            this.referencedComponents = [definitionComponentClasses];
-        }
-    }
-}
-exports.ReferenceCustomValidator = ReferenceCustomValidator;
-class LazyReferenceCustomValidator extends ReferenceCustomValidatorBase {
-    constructor(componentName, options) {
-        super(options);
-        this.componentName = componentName;
-        this.validate = (value, helpers) => {
-            if (!context_1.Context.componentInProgressData) {
-                helpers_lib_1.ConsoleHelper.log('Unexpected error: Lazy reference validation has been called outside of the validation cycle.', 'red');
-            }
-            else if (!context_1.Context.componentInProgressData.meta.keyName) {
-                helpers_lib_1.ConsoleHelper.log('Lazy reference can only be used for definitions with key name defined.', 'red');
-            }
-            else if (context_1.Context.componentInProgressData.meta.componentName !== this.componentName) {
-                helpers_lib_1.ConsoleHelper.log(`Lazy reference can only be used for self referencing. It is used under: "${this.componentName}"`, 'red');
-            }
-            else if (context_1.Context.componentInProgressData.meta.singleton) {
-                helpers_lib_1.ConsoleHelper.log(`Lazy reference cannot be used for singleton components. It is used under: "${this.componentName}"`, 'red');
-            }
-            else {
-                let rootDefinition = helpers.state.ancestors.at(-1);
-                let definitionId = rootDefinition[context_1.Context.componentInProgressData.meta.keyName];
-                if (!definitionId) {
-                    helpers_lib_1.ConsoleHelper.log(`Unexpected error: definitionId cannot be retrieved by keyname.`, 'red');
-                }
-                else {
-                    if (!context_1.Context.componentInProgressData.idToReferencesMap.has(definitionId)) {
-                        context_1.Context.componentInProgressData.idToReferencesMap.set(definitionId, new Set());
-                    }
-                    let references = context_1.Context.componentInProgressData.idToReferencesMap.get(definitionId);
-                    references.add(value);
-                }
-            }
-            let referencedComponent = definition_store_1.DefinitionStore['getComponentClass'](this.componentName);
-            let validationState = custom_validator_helper_1.CustomValidatorHelper.getValidationState(helpers);
-            if (validationState === 'valid') {
-                let referencedComponentRawDefinitionExists = definition_store_1.DefinitionStore['isRawDefinitionExists'](referencedComponent, value);
-                if (!referencedComponentRawDefinitionExists) {
-                    throw new Error(`There is no "${this.componentName}" definition found for "${value}"`);
-                }
-                else {
-                    this.validatePropertyExistence(referencedComponent, value, this.options);
-                    return value;
-                }
-            }
-            else {
-                throw new Error(`Internal Error; joi validation context for reference validator: Path: "${helpers.state.path}", RawDefinition: "${JSON.stringify(helpers.prefs.context)}"`);
-            }
-        };
-    }
-}
-exports.LazyReferenceCustomValidator = LazyReferenceCustomValidator;
-//# sourceMappingURL=reference.custom-validator.js.map

package/dist/helpers/validator/custom-validators/sprite.custom-validator.d.ts

@@ -1,14 +0,0 @@
-import { Vec2 } from 'helpers-lib';
-import Joi, { ErrorReport } from 'joi';
-import { FileSystem } from '../../../framework/interfaces';
-import { CustomStringValidator } from '../joi-custom-validators';
-export interface ValidatedSpriteUrl {
-    readonly url: string;
-    readonly size: Vec2;
-}
-export declare class SpriteCustomValidator implements CustomStringValidator {
-    private fs;
-    readonly regex: RegExp;
-    readonly validate: (value: string, helpers: Joi.CustomHelpers) => any | ErrorReport;
-    constructor(fs: FileSystem);
-}

package/dist/helpers/validator/custom-validators/sprite.custom-validator.js

@@ -1,43 +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.SpriteCustomValidator = void 0;
-const image_size_1 = __importDefault(require("image-size"));
-const context_1 = require("../../../framework/context");
-const custom_validator_helper_1 = require("../custom-validator-helper/custom-validator.helper");
-class SpriteCustomValidator {
-    constructor(fs) {
-        this.fs = fs;
-        this.regex = /^[\S]+$/;
-        this.validate = (value, helpers) => {
-            let validationState = custom_validator_helper_1.CustomValidatorHelper.getValidationState(helpers);
-            if (validationState === 'valid') {
-                let { rawDefinition } = custom_validator_helper_1.CustomValidatorHelper.getPathAndRawDefinition(helpers);
-                let pathPrefix = rawDefinition.location.path.substring(0, rawDefinition.location.path.lastIndexOf('/') + 1);
-                value = pathPrefix + value;
-                if (!this.fs.existsSync(value)) {
-                    throw new Error(`No file is found in the path: "${value}"`);
-                }
-                else {
-                    try {
-                        let size = (0, image_size_1.default)(value);
-                        return {
-                            url: value.replace(context_1.Context.config.projectRoot, '.'),
-                            size: { x: size.width, y: size.height }
-                        };
-                    }
-                    catch {
-                        throw new Error(`The file in the path "${value}" is not an image`);
-                    }
-                }
-            }
-            else {
-                throw new Error(`Internal Error; joi validation context for image validator: Path: "${helpers.state.path}", RawDefinition: "${JSON.stringify(helpers.prefs.context.rawDefinition)}"`);
-            }
-        };
-    }
-}
-exports.SpriteCustomValidator = SpriteCustomValidator;
-//# sourceMappingURL=sprite.custom-validator.js.map

package/dist/helpers/validator/custom-validators/unique-name-group.custom-validator.d.ts

@@ -1,9 +0,0 @@
-import Joi, { ErrorReport } from 'joi';
-import { CustomValidator } from '../joi-custom-validators';
-import { DefinitionComponentClassType } from '../../../framework/definition-component';
-export declare class UniqueNameGroupCustomValidator implements CustomValidator {
-  private definitionComponentClass;
-  readonly regex: RegExp;
-  readonly validate: (value: string, helpers: Joi.CustomHelpers) => any | ErrorReport;
-  constructor(definitionComponentClass: DefinitionComponentClassType<any>);
-}

package/dist/helpers/validator/custom-validators/unique-name-group.custom-validator.js

@@ -1,33 +0,0 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', { value: true });
-exports.UniqueNameGroupCustomValidator = void 0;
-const common_functions_1 = require('../../common-functions/common-functions');
-const raw_definition_helper_1 = require('../../raw-definition-helper/raw-definition.helper');
-const custom_validator_helper_1 = require('../custom-validator-helper/custom-validator.helper');
-class UniqueNameGroupCustomValidator {
-  constructor(definitionComponentClass) {
-    this.definitionComponentClass = definitionComponentClass;
-    this.regex = /^[a-z]+([a-zA-Z0-9]+)*$/;
-    this.validate = (value, helpers) => {
-      let componentName = this.definitionComponentClass.$meta.componentName;
-      let validationState = custom_validator_helper_1.CustomValidatorHelper.getValidationState(helpers);
-      if (validationState === 'valid') {
-        let { path, rawDefinition } = custom_validator_helper_1.CustomValidatorHelper.getPathAndRawDefinition(helpers);
-        let duplicateHelper = custom_validator_helper_1.CustomValidatorHelper.getDuplicateHelper(componentName);
-        duplicateHelper.newEntry(value, {
-          line: raw_definition_helper_1.RawDefinitionHelper.findLine(rawDefinition, path),
-          path: rawDefinition.location.path
-        });
-        return common_functions_1.CommonFunctions.decorateDefinitionName(value, componentName);
-      } else if (validationState === 'registerLoop') {
-        custom_validator_helper_1.CustomValidatorHelper.getDefinitionNames(componentName).add(value);
-      } else {
-        throw new Error(
-          `Internal Error; joi validation context for uniqueNameGroup validator: Path: "${helpers.state.path}", RawDefinition: "${JSON.stringify(helpers.prefs.context)}"`
-        );
-      }
-    };
-  }
-}
-exports.UniqueNameGroupCustomValidator = UniqueNameGroupCustomValidator;
-//# sourceMappingURL=unique-name-group.custom-validator.js.map

package/dist/helpers/validator/custom-validators/unique.custom-validator.d.ts

@@ -1,8 +0,0 @@
-import Joi, { ErrorReport } from 'joi';
-import { CustomStringValidator } from '../joi-custom-validators';
-export declare class UniqueCustomValidator implements CustomStringValidator {
-    private nameSpace;
-    readonly regex: RegExp;
-    readonly validate: (value: string, helpers: Joi.CustomHelpers) => any | ErrorReport;
-    constructor(nameSpace: Set<string>);
-}

package/dist/helpers/validator/custom-validators/unique.custom-validator.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UniqueCustomValidator = void 0;
-class UniqueCustomValidator {
-    constructor(nameSpace) {
-        this.nameSpace = nameSpace;
-        this.regex = /^[\S]+$/;
-        this.validate = (value, helpers) => {
-            if (this.nameSpace.has(value)) {
-                throw new Error(`Value "${value}" is not unique in the name space: "${Array.from(this.nameSpace).join(', ')}"`);
-            }
-            else {
-                this.nameSpace.add(value);
-                return value;
-            }
-        };
-    }
-}
-exports.UniqueCustomValidator = UniqueCustomValidator;
-//# sourceMappingURL=unique.custom-validator.js.map

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

@@ -1,33 +0,0 @@
-import Joi from 'joi';
-import { DefinitionComponentClassType } from '../../decorators/definition-component';
-import { FileSystem } from '../../framework/interfaces';
-import { PositionOnSpriteValidationOptions } from './custom-validators/position-on-sprite';
-export interface CustomStringValidator {
-    readonly regex: RegExp;
-    readonly validate: Joi.CustomValidator<any, any>;
-}
-export interface CustomObjectValidator {
-    readonly validate: Joi.CustomValidator<any, any>;
-}
-export interface ReferenceCustomValidatorOptions {
-    additionalValidation?: Joi.Schema;
-}
-declare module 'joi' {
-    interface StringSchema {
-        unique(nameSpace: Set<string>): Joi.StringSchema;
-        path(): Joi.StringSchema;
-        sprite(): Joi.StringSchema;
-        reference(definitionComponentClass: DefinitionComponentClassType<any> | DefinitionComponentClassType<any>[], options?: ReferenceCustomValidatorOptions): Joi.StringSchema;
-        lazyReference(componentName: string, options?: ReferenceCustomValidatorOptions): Joi.StringSchema;
-    }
-    interface ObjectSchema {
-        /**
-         * Converts the values to relative position from anchor on sprite.
-         */
-        positionOnSprite(options: PositionOnSpriteValidationOptions): Joi.ObjectSchema;
-    }
-}
-export declare class JoiCustomValidators {
-    static decorate(joi: object, fs: FileSystem): void;
-    private static defineCustomStringValidator;
-}

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

@@ -1,54 +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.JoiCustomValidators = void 0;
-const joi_1 = __importDefault(require("joi"));
-const path_custom_validator_1 = require("./custom-validators/path.custom-validator");
-const position_on_sprite_1 = require("./custom-validators/position-on-sprite");
-const reference_custom_validator_1 = require("./custom-validators/reference.custom-validator");
-const sprite_custom_validator_1 = require("./custom-validators/sprite.custom-validator");
-const unique_custom_validator_1 = require("./custom-validators/unique.custom-validator");
-class JoiCustomValidators {
-    static decorate(joi, fs) {
-        // @ts-ignore
-        joi.string().__proto__.unique = function (nameSpace) {
-            let uniqueCustomValidator = new unique_custom_validator_1.UniqueCustomValidator(nameSpace);
-            return JoiCustomValidators.defineCustomStringValidator(this, uniqueCustomValidator);
-        };
-        // @ts-ignore
-        joi.string().__proto__.path = function () {
-            let pathCustomValidator = new path_custom_validator_1.PathCustomValidator(fs);
-            return JoiCustomValidators.defineCustomStringValidator(this, pathCustomValidator);
-        };
-        // @ts-ignore
-        joi.string().__proto__.sprite = function () {
-            let spriteCustomValidator = new sprite_custom_validator_1.SpriteCustomValidator(fs);
-            return JoiCustomValidators.defineCustomStringValidator(this, spriteCustomValidator);
-        };
-        // @ts-ignore
-        joi.string().__proto__.reference = function (definitionComponentClasses, options) {
-            let referenceCustomValidator = new reference_custom_validator_1.ReferenceCustomValidator(definitionComponentClasses, options);
-            return JoiCustomValidators.defineCustomStringValidator(this, referenceCustomValidator);
-        };
-        // @ts-ignore
-        joi.string().__proto__.lazyReference = function (componentName, options) {
-            let lazyReferenceCustomValidator = new reference_custom_validator_1.LazyReferenceCustomValidator(componentName, options);
-            return JoiCustomValidators.defineCustomStringValidator(this, lazyReferenceCustomValidator);
-        };
-        // @ts-ignore
-        joi.object().__proto__.positionOnSprite = function (options) {
-            let positionOnSpriteValidator = new position_on_sprite_1.PositionOnSpriteCustomValidator(options);
-            return this.custom(positionOnSpriteValidator.validate);
-        };
-        if (joi !== joi_1.default) {
-            this.decorate(joi_1.default, fs);
-        }
-    }
-    static defineCustomStringValidator(schema, customValidator) {
-        return schema.regex(customValidator.regex).custom(customValidator.validate);
-    }
-}
-exports.JoiCustomValidators = JoiCustomValidators;
-//# sourceMappingURL=joi-custom-validators.js.map

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

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