shopware / platform

import type ChangesetGenerator from 'src/core/data/changeset-generator.data';

import type EntityDefinition from 'src/core/data/entity-definition.data';

import type ErrorResolver from 'src/core/data/error-resolver.data';

import type EntityDefinitionFactory from 'src/core/factory/entity-definition.factory';

/**

 * @module app/entity-validation-service

 */

/**

 * @private

 */

export type ValidationError = {

    code: string,

    source: {

        pointer: string

    }

}

/**

 * @private

 */

// eslint-disable-next-line @typescript-eslint/no-explicit-any,max-len,sw-deprecation-rules/private-feature-declarations

export type CustomValidator = (errors: ValidationError[], entity: Entity<any>, definition: EntityDefinition) => ValidationError[];

/**

 * A service for client side validation of entities

 * @private

 */

export default class EntityValidationService {

    private entityDefinitionFactory: typeof EntityDefinitionFactory;

    private changesetGenerator: ChangesetGenerator;

    private errorResolver: ErrorResolver;

    public static readonly ERROR_CODE_REQUIRED = 'c1051bb4-d103-4f74-8988-acbcafc7fdc3';

    constructor(

        entityDefinitionFactory: typeof EntityDefinitionFactory,

        changesetGenerator: ChangesetGenerator,

        errorResolver: ErrorResolver,

    ) {

        this.entityDefinitionFactory = entityDefinitionFactory;

        this.changesetGenerator = changesetGenerator;

        this.errorResolver = errorResolver;

    }

    public static createRequiredError(fieldPointer: string): ValidationError {

        return {

            code: EntityValidationService.ERROR_CODE_REQUIRED,

            source: {

                pointer: fieldPointer,

            },

        };

    }

    /**

     * Validates an entity and returns true if it is valid.

     * Found errors are reported to the internal error resolver and

     * displayed by looking into the error Store (is done automatically for most sw-fields).

     *

     * A CustomValidator callback can be provided to modify or add to the found errors.

     */

    // eslint-disable-next-line @typescript-eslint/no-explicit-any

    public validate(entity: Entity<any>, customValidator: CustomValidator | undefined): boolean {

        // eslint-disable-next-line max-len

        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment,@typescript-eslint/no-unsafe-member-access,@typescript-eslint/no-unsafe-call

        const entityName = entity.getEntityName();

        const definition = this.entityDefinitionFactory.get(entityName);

        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment

        const { changes } = this.changesetGenerator.generate(entity);

        let errors: ValidationError[] = [];

        // check for required fields

        const requiredFields = definition.getRequiredFields() as Record<string, never>;

        errors.push(...this.getRequiredErrors(entity, requiredFields));

        // run custom validator

        if (customValidator !== undefined) {

            errors = customValidator(errors, entity, definition);

        }

        // report errors

        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment

        this.errorResolver.handleWriteErrors({ errors }, [{ entity, changes }]);

        return errors.length < 1;

    }

}