@researchdatabox/sails-ng-common 0.0.1-beta.8936

package/dist/src/validation/form.model.d.ts

@@ -0,0 +1,247 @@
+import { LineagePath, LineagePaths } from "../config/names/naming-helpers";
+/**
+ * The parameters for a validator error.
+ *
+ * These can be used with the translation message id to create the translated text.
+ *
+ * For example:
+ * {actual: 2, requiredThreshold: 3}
+ */
+export type FormValidatorErrorParams = {
+    [key: string]: unknown;
+};
+/**
+ * The map of validation errors.
+ *
+ * Typically, has a property that is the validation class, e.g. 'min', and
+ * value is a dictionary of message and params that are arbitrary values
+ * that can be used to render an error message template.
+ *
+ * This is similar to FormValidatorComponentErrors, but with the class as the key in a parent object.
+ *
+ * This is similar to the angular form ValidationErrors type.
+ */
+export type FormValidatorErrors = {
+    [key: string]: {
+        message: string;
+        params: FormValidatorErrorParams;
+    };
+};
+/**
+ * The map of validator config.
+ * The config is different for each validator.
+ */
+export type FormValidatorCreateConfig = {
+    class?: string;
+    message?: string;
+    [key: string]: unknown;
+};
+/**
+ * The interface that a form control must implement to be validated by a validator function.
+ * Some form controls are a collection of controls, these must provide a way to access the controls they contain.
+ *
+ * This is similar to the angular AbstractControl class, with only the properties needed for validation.
+ *
+ * @see https://angular.dev/api/forms/AbstractControl
+ */
+export interface FormValidatorControl {
+    /**
+     * The value of the control.
+     * @see https://angular.dev/api/forms/AbstractControl#value
+     */
+    value: unknown;
+    /**
+     * Get the descendant control that matches the path.
+     * @see https://angular.dev/api/forms/AbstractControl#get
+     * @param path
+     */
+    get<P extends string | LineagePath>(path: P): FormValidatorControl | null;
+}
+/**
+ * A simple form validator control that can be used on the server-side to mimic client-side controls.
+ *
+ * Do not use this on the client-side.
+ */
+export declare class SimpleServerFormValidatorControl implements FormValidatorControl {
+    value: unknown;
+    constructor(value: unknown);
+    get<P extends string | LineagePath>(path: P): FormValidatorControl | null;
+}
+/**
+ * The validator function.
+ *
+ * Accepts an AbstractControl and returns either validation errors or no errors (null).
+ *
+ * This is similar to the angular form ValidatorFn interface.
+ */
+export interface FormValidatorFn {
+    (control: FormValidatorControl): FormValidatorErrors | null;
+}
+/**
+ * The validation function creator.
+ *
+ * Takes one config argument, which contains config for the specific validator.
+ *
+ * Returns a form validator function.
+ */
+export type FormValidatorCreateFn = (config: FormValidatorCreateConfig | null | undefined) => FormValidatorFn;
+/**
+ * The definition of a validator for a form or a form control.
+ */
+export interface FormValidatorDefinition {
+    /**
+     * The unique name of the form validator.
+     */
+    class: string;
+    /**
+     * The message id to display when the validator fails.
+     */
+    message: string;
+    /**
+     * The validation function creator.
+     */
+    create: FormValidatorCreateFn;
+}
+/**
+ * The configuration block for a validator for a form or a form control.
+ */
+export interface FormValidatorConfig {
+    /**
+     * The 'class' key used to reference one validator definition.
+     * The optional message and config will be applied to the validator definition with this class.
+     */
+    class: string;
+    /**
+     * The optional message id to display when the validator fails.
+     * This is only needed if the message to show is different to the validator definition.
+     */
+    message?: string;
+    /**
+     * The optional validator config.
+     * Can be left out if the validator takes no config.
+     */
+    config?: FormValidatorCreateConfig;
+    /**
+     * Zero or more validation group names this validator belongs to.
+     *
+     * Validation groups make it easier to run a subset of validators on a form.
+     * The validator will be enabled if any of the groups it is part of are enabled.
+     *
+     * Note that a validation group with 'initialMembership: "all"' will include all validators (that aren't excluded),
+     * even if the validators do not include the group name.
+     */
+    groups?: FormFieldValidationGroup;
+}
+/**
+ * One validator error.
+ */
+export interface FormValidatorComponentErrors {
+    /**
+     * The message id for the validator.
+     */
+    message: string;
+    /**
+     * The class of the validator.
+     */
+    class: string;
+    /**
+     * The params for rendering the translated message.
+     */
+    params: FormValidatorErrorParams;
+}
+/**
+ * Form or form control errors from a validator.
+ *
+ * Controls can be nested, so validation errors can be nested.
+ * The nesting is how the client-side is able to reveal a form field when
+ * a link in the validation summary is clicked.
+ *
+ * If all errors arrays are empty, then the validation summary is treated as 'form is valid'.
+ */
+export interface FormValidatorSummaryErrors {
+    /**
+     * The id of the form control.
+     *
+     * This is used on the client-side for linking to the form control to reveal it.
+     * If this is not available, the validation error is rendered with the form field label and with no link.
+     */
+    id: string | null;
+    /**
+     * The message id for the form control label.
+     *
+     * This is passed to the translation service to get the label text.
+     * If this is not available, the id is used, otherwise a default label is used.
+     */
+    message: string | null;
+    /**
+     * The validation errors for the form control.
+     *
+     * These are rendered using the translation service - the message id can use the params to calculate the text to show.
+     * If there are no errors, then the form field is not shown in the error summary.
+     */
+    errors: FormValidatorComponentErrors[];
+    /**
+     * The lineage paths to this form control.
+     *
+     * This enables revealing the parents, to be able to navigate to the form control.
+     */
+    lineagePaths: LineagePaths;
+}
+/**
+ * Form validation groups, where the key is the name, and the value is the definition.
+ */
+export interface FormValidationGroups {
+    /**
+     * The key is the name of the validation group.
+     */
+    [key: string]: FormValidationGroup;
+}
+/**
+ * A form validation group,
+ * which describes the purpose or usage of the group and the initial membership of the group.
+ */
+export interface FormValidationGroup {
+    /**
+     * A short description of the purpose or usage of the validation group.
+     */
+    description: string;
+    /**
+     * The approach this validation group uses to specify which validators are included.
+     *
+     * Default is "none".
+     */
+    initialMembership?: FormValidationGroupMembership;
+}
+/**
+ * The available form validation group membership approaches.
+ *
+ * Options:
+ * - 'all': Every known / available validator.
+ * - 'none': An empty array / no validators.
+ */
+export declare const formValidationGroupMembership: readonly ["all", "none"];
+/**
+ * The type for the available form validation group membership approaches.
+ */
+export type FormValidationGroupMembership = typeof formValidationGroupMembership[number];
+/**
+ * Specify the validation groups to include or exclude.
+ * All the validation groups used here must also be present in the form top-level validationGroups property.
+ * The groups will be added or removed from some list of validation groups.
+ */
+export interface FormFieldValidationGroup {
+    /**
+     * A list of the validation groups to include / add / enable.
+     *
+     * Default is empty array.
+     * Use when a validator should be included in a group with initial membership of none.
+     */
+    include?: string[];
+    /**
+     * A list of the validation groups to exclude / remove / disable.
+     *
+     * Default is empty array.
+     * Use when a validator should be excluded from a group with initial membership of all.
+     */
+    exclude?: string[];
+}

package/dist/src/validation/form.model.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formValidationGroupMembership = exports.SimpleServerFormValidatorControl = void 0;
+const lodash_1 = require("lodash");
+/**
+ * A simple form validator control that can be used on the server-side to mimic client-side controls.
+ *
+ * Do not use this on the client-side.
+ */
+class SimpleServerFormValidatorControl {
+    value;
+    constructor(value) {
+        this.value = value;
+    }
+    get(path) {
+        const result = (0, lodash_1.get)(this.value, path) ?? null;
+        // For debugging:
+        // console.debug(`SimpleServerFormValidatorControl.get path ${JSON.stringify(path)} with result ${JSON.stringify(result)} from value ${JSON.stringify(this.value)}`);
+        return result;
+    }
+}
+exports.SimpleServerFormValidatorControl = SimpleServerFormValidatorControl;
+/**
+ * The available form validation group membership approaches.
+ *
+ * Options:
+ * - 'all': Every known / available validator.
+ * - 'none': An empty array / no validators.
+ */
+exports.formValidationGroupMembership = ["all", "none"];
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZm9ybS5tb2RlbC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy92YWxpZGF0aW9uL2Zvcm0ubW9kZWwudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEsbUNBQXFDO0FBOERyQzs7OztHQUlHO0FBQ0gsTUFBYSxnQ0FBZ0M7SUFDekMsS0FBSyxDQUFVO0lBRWYsWUFBWSxLQUFjO1FBQ3RCLElBQUksQ0FBQyxLQUFLLEdBQUcsS0FBSyxDQUFDO0lBQ3ZCLENBQUM7SUFFRCxHQUFHLENBQWlDLElBQU87UUFDdkMsTUFBTSxNQUFNLEdBQUcsSUFBQSxZQUFJLEVBQUMsSUFBSSxDQUFDLEtBQUssRUFBRSxJQUFJLENBQUMsSUFBSSxJQUFJLENBQUM7UUFFOUMsaUJBQWlCO1FBQ2pCLHFLQUFxSztRQUVySyxPQUFPLE1BQU0sQ0FBQztJQUNsQixDQUFDO0NBQ0o7QUFmRCw0RUFlQztBQTJKRDs7Ozs7O0dBTUc7QUFDVSxRQUFBLDZCQUE2QixHQUFHLENBQUMsS0FBSyxFQUFFLE1BQU0sQ0FBVSxDQUFDIn0=

package/dist/src/validation/helpers.d.ts

@@ -0,0 +1,14 @@
+import { FormValidatorCreateConfig } from "./form.model";
+/**
+ * Extract the length property in case it's an array or a string.
+ * Extract the size property in case it's a set.
+ * Return null else.
+ * @param value Either an array, set or undefined.
+ */
+export declare function formValidatorLengthOrSize(value: null | string | unknown[] | Set<unknown> | unknown): number | null;
+export declare function formValidatorGetDefinitionItem(config: FormValidatorCreateConfig | null | undefined, key: string, defaultValue?: unknown): unknown;
+export declare function formValidatorGetDefinitionString(config: FormValidatorCreateConfig | null | undefined, key: string, defaultValue?: string | undefined): string;
+export declare function formValidatorGetDefinitionNumber(config: FormValidatorCreateConfig | null | undefined, key: string, defaultValue?: string | undefined): number;
+export declare function formValidatorGetDefinitionBoolean(config: FormValidatorCreateConfig | null | undefined, key: string, defaultValue?: boolean | undefined): boolean;
+export declare function formValidatorGetDefinitionRegexp(config: FormValidatorCreateConfig | null | undefined, key: string, defaultValue?: RegExp | undefined): RegExp;
+export declare function formValidatorGetDefinitionArray(config: FormValidatorCreateConfig | null | undefined, key: string, defaultValue?: unknown[] | undefined): unknown[];

package/dist/src/validation/helpers.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formValidatorLengthOrSize = formValidatorLengthOrSize;
+exports.formValidatorGetDefinitionItem = formValidatorGetDefinitionItem;
+exports.formValidatorGetDefinitionString = formValidatorGetDefinitionString;
+exports.formValidatorGetDefinitionNumber = formValidatorGetDefinitionNumber;
+exports.formValidatorGetDefinitionBoolean = formValidatorGetDefinitionBoolean;
+exports.formValidatorGetDefinitionRegexp = formValidatorGetDefinitionRegexp;
+exports.formValidatorGetDefinitionArray = formValidatorGetDefinitionArray;
+const lodash_1 = require("lodash");
+const helpers_1 = require("../config/helpers");
+/**
+ * Extract the length property in case it's an array or a string.
+ * Extract the size property in case it's a set.
+ * Return null else.
+ * @param value Either an array, set or undefined.
+ */
+function formValidatorLengthOrSize(value) {
+    if (value === null || value === undefined) {
+        return null;
+    }
+    else if (Array.isArray(value) || typeof value === "string") {
+        return value.length;
+    }
+    else if (value instanceof Set) {
+        return value.size;
+    }
+    return null;
+}
+function formValidatorGetDefinitionItem(config, key, defaultValue = undefined) {
+    const value = (0, lodash_1.get)(config ?? {}, key, defaultValue);
+    if (value === undefined) {
+        throw new Error(`Must define '${key}' in validator config.`);
+    }
+    return value;
+}
+function formValidatorGetDefinitionString(config, key, defaultValue = undefined) {
+    const value = formValidatorGetDefinitionItem(config, key, defaultValue);
+    return value?.toString() ?? "";
+}
+function formValidatorGetDefinitionNumber(config, key, defaultValue = undefined) {
+    const value = formValidatorGetDefinitionItem(config, key, defaultValue);
+    const valueString = value?.toString() ?? "";
+    const valueNumber = parseFloat(valueString);
+    if (isNaN(valueNumber)) {
+        throw new Error(`Invalid numeric value '${value}' for key '${key}' in validator config.`);
+    }
+    return valueNumber;
+}
+function formValidatorGetDefinitionBoolean(config, key, defaultValue = undefined) {
+    const value = formValidatorGetDefinitionItem(config, key, defaultValue);
+    return (0, helpers_1.toBoolean)(value);
+}
+function formValidatorGetDefinitionRegexp(config, key, defaultValue = undefined) {
+    const value = formValidatorGetDefinitionItem(config, key, defaultValue);
+    if (value instanceof RegExp) {
+        return value;
+    }
+    return new RegExp(value?.toString() ?? "");
+}
+function formValidatorGetDefinitionArray(config, key, defaultValue = undefined) {
+    const value = formValidatorGetDefinitionItem(config, key, defaultValue);
+    if (Array.isArray(value)) {
+        return value;
+    }
+    throw new Error(`Invalid array value '${value}' for key '${key}' in validator config.`);
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaGVscGVycy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy92YWxpZGF0aW9uL2hlbHBlcnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFXQSw4REFVQztBQUVELHdFQVVDO0FBRUQsNEVBT0M7QUFFRCw0RUFZQztBQUVELDhFQU9DO0FBRUQsNEVBVUM7QUFFRCwwRUFVQztBQXpGRCxtQ0FBbUM7QUFFbkMsK0NBQTRDO0FBRzVDOzs7OztHQUtHO0FBQ0gsU0FBZ0IseUJBQXlCLENBQUMsS0FBeUQ7SUFDakcsSUFBSSxLQUFLLEtBQUssSUFBSSxJQUFJLEtBQUssS0FBSyxTQUFTLEVBQUUsQ0FBQztRQUMxQyxPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7U0FBTSxJQUFJLEtBQUssQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFDLElBQUksT0FBTyxLQUFLLEtBQUssUUFBUSxFQUFFLENBQUM7UUFDN0QsT0FBTyxLQUFLLENBQUMsTUFBTSxDQUFDO0lBQ3RCLENBQUM7U0FBTSxJQUFJLEtBQUssWUFBWSxHQUFHLEVBQUUsQ0FBQztRQUNoQyxPQUFPLEtBQUssQ0FBQyxJQUFJLENBQUM7SUFDcEIsQ0FBQztJQUVELE9BQU8sSUFBSSxDQUFDO0FBQ2QsQ0FBQztBQUVELFNBQWdCLDhCQUE4QixDQUM1QyxNQUFvRCxFQUNwRCxHQUFXLEVBQ1gsZUFBd0IsU0FBUztJQUVqQyxNQUFNLEtBQUssR0FBRyxJQUFBLFlBQUksRUFBQyxNQUFNLElBQUksRUFBRSxFQUFFLEdBQUcsRUFBRSxZQUFZLENBQUMsQ0FBQztJQUNwRCxJQUFJLEtBQUssS0FBSyxTQUFTLEVBQUUsQ0FBQztRQUN4QixNQUFNLElBQUksS0FBSyxDQUFDLGdCQUFnQixHQUFHLHdCQUF3QixDQUFDLENBQUM7SUFDL0QsQ0FBQztJQUNELE9BQU8sS0FBSyxDQUFDO0FBQ2YsQ0FBQztBQUVELFNBQWdCLGdDQUFnQyxDQUM5QyxNQUFvRCxFQUNwRCxHQUFXLEVBQ1gsZUFBbUMsU0FBUztJQUU1QyxNQUFNLEtBQUssR0FBRyw4QkFBOEIsQ0FBQyxNQUFNLEVBQUUsR0FBRyxFQUFFLFlBQVksQ0FBQyxDQUFDO0lBQ3hFLE9BQU8sS0FBSyxFQUFFLFFBQVEsRUFBRSxJQUFJLEVBQUUsQ0FBQztBQUNqQyxDQUFDO0FBRUQsU0FBZ0IsZ0NBQWdDLENBQzlDLE1BQW9ELEVBQ3BELEdBQVcsRUFDWCxlQUFtQyxTQUFTO0lBRTVDLE1BQU0sS0FBSyxHQUFHLDhCQUE4QixDQUFDLE1BQU0sRUFBRSxHQUFHLEVBQUUsWUFBWSxDQUFDLENBQUM7SUFDeEUsTUFBTSxXQUFXLEdBQUcsS0FBSyxFQUFFLFFBQVEsRUFBRSxJQUFJLEVBQUUsQ0FBQztJQUM1QyxNQUFNLFdBQVcsR0FBRyxVQUFVLENBQUMsV0FBVyxDQUFDLENBQUM7SUFDNUMsSUFBSSxLQUFLLENBQUMsV0FBVyxDQUFDLEVBQUUsQ0FBQztRQUN2QixNQUFNLElBQUksS0FBSyxDQUFDLDBCQUEwQixLQUFLLGNBQWMsR0FBRyx3QkFBd0IsQ0FBQyxDQUFDO0lBQzVGLENBQUM7SUFDRCxPQUFPLFdBQVcsQ0FBQztBQUNyQixDQUFDO0FBRUQsU0FBZ0IsaUNBQWlDLENBQy9DLE1BQW9ELEVBQ3BELEdBQVcsRUFDWCxlQUFvQyxTQUFTO0lBRTdDLE1BQU0sS0FBSyxHQUFHLDhCQUE4QixDQUFDLE1BQU0sRUFBRSxHQUFHLEVBQUUsWUFBWSxDQUFDLENBQUM7SUFDeEUsT0FBTyxJQUFBLG1CQUFTLEVBQUMsS0FBSyxDQUFDLENBQUM7QUFDMUIsQ0FBQztBQUVELFNBQWdCLGdDQUFnQyxDQUM5QyxNQUFvRCxFQUNwRCxHQUFXLEVBQ1gsZUFBbUMsU0FBUztJQUU1QyxNQUFNLEtBQUssR0FBRyw4QkFBOEIsQ0FBQyxNQUFNLEVBQUUsR0FBRyxFQUFFLFlBQVksQ0FBQyxDQUFDO0lBQ3hFLElBQUksS0FBSyxZQUFZLE1BQU0sRUFBRSxDQUFDO1FBQzVCLE9BQU8sS0FBSyxDQUFDO0lBQ2YsQ0FBQztJQUNELE9BQU8sSUFBSSxNQUFNLENBQUMsS0FBSyxFQUFFLFFBQVEsRUFBRSxJQUFJLEVBQUUsQ0FBQyxDQUFDO0FBQzdDLENBQUM7QUFFRCxTQUFnQiwrQkFBK0IsQ0FDN0MsTUFBb0QsRUFDcEQsR0FBVyxFQUNYLGVBQXNDLFNBQVM7SUFFL0MsTUFBTSxLQUFLLEdBQUcsOEJBQThCLENBQUMsTUFBTSxFQUFFLEdBQUcsRUFBRSxZQUFZLENBQUMsQ0FBQztJQUN4RSxJQUFJLEtBQUssQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFDLEVBQUUsQ0FBQztRQUN6QixPQUFPLEtBQUssQ0FBQztJQUNmLENBQUM7SUFDRCxNQUFNLElBQUksS0FBSyxDQUFDLHdCQUF3QixLQUFLLGNBQWMsR0FBRyx3QkFBd0IsQ0FBQyxDQUFDO0FBQzFGLENBQUMifQ==

package/dist/src/validation/validators-support.d.ts

@@ -0,0 +1,41 @@
+import { FormValidationGroups, FormValidatorComponentErrors, FormValidatorConfig, FormValidatorDefinition, FormValidatorErrors, FormValidatorFn } from "./form.model";
+export declare class ValidatorsSupport {
+    /**
+     * Create validator definition mapping from the validator definitions.
+     * @param definition The form validator definitions.
+     */
+    createValidatorDefinitionMapping(definition: FormValidatorDefinition[] | null | undefined): Map<string, FormValidatorDefinition>;
+    /**
+     * Create form validator instances from the validator definition mapping.
+     * @param defMap The validator definition mapping.
+     * @param config The form validator config blocks.
+     */
+    createFormValidatorInstancesFromMapping(defMap: Map<string, FormValidatorDefinition>, config: FormValidatorConfig[] | null | undefined): FormValidatorFn[];
+    /**
+     * Create instances of the given form validators.
+     *
+     * @param definition The form validator definitions.
+     * @param config The form validator config blocks.
+     */
+    createFormValidatorInstances(definition: FormValidatorDefinition[] | null | undefined, config: FormValidatorConfig[] | null | undefined): FormValidatorFn[];
+    /**
+     * Get the form validator errors for a component's control.
+     * @param errors The control's errors.
+     */
+    getFormValidatorComponentErrors(errors: FormValidatorErrors | null): FormValidatorComponentErrors[];
+    checkValidationGroups(availableGroups: FormValidationGroups, enabledGroupNames: string[]): void;
+    /**
+     * Is the component model validator enabled?
+     * @param availableGroups All available validation groups in this form.
+     * @param enabledGroupNames The currently enabled validation groups.
+     * @param validator The validator config for a component's model.
+     */
+    isValidatorEnabled(availableGroups: FormValidationGroups, enabledGroupNames: string[], validator: FormValidatorConfig): boolean;
+    /**
+     * Get the enabled validators.
+     * @param availableGroups All available validation groups in this form.
+     * @param enabledGroups The currently enabled validation groups.
+     * @param validators All available validators in this form.
+     */
+    enabledValidators(availableGroups: FormValidationGroups, enabledGroups: string[], validators: FormValidatorConfig[]): FormValidatorConfig[];
+}

package/dist/src/validation/validators-support.js

@@ -0,0 +1,141 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidatorsSupport = void 0;
+const form_types_model_1 = require("../config/form-types.model");
+class ValidatorsSupport {
+    /**
+     * Create validator definition mapping from the validator definitions.
+     * @param definition The form validator definitions.
+     */
+    createValidatorDefinitionMapping(definition) {
+        const defMap = new Map();
+        for (const definitionItem of (definition ?? [])) {
+            if (!(0, form_types_model_1.isTypeFormValidatorDefinition)(definitionItem)) {
+                throw new Error(`Validator definition does not have valid 'class', 'message', and 'create' properties: ${JSON.stringify(definitionItem)}`);
+            }
+            const validatorClass = definitionItem?.class;
+            const message = definitionItem?.message;
+            if (defMap.has(validatorClass)) {
+                const messages = [message, defMap.get(validatorClass)?.message];
+                throw new Error(`Duplicate validator class '${validatorClass}' - the validator classes must be unique. `
+                    + `To help you find the duplicates, these are the messages of the duplicates: '${messages.join(", ")}'.`);
+            }
+            defMap.set(validatorClass, definitionItem);
+        }
+        return defMap;
+    }
+    /**
+     * Create form validator instances from the validator definition mapping.
+     * @param defMap The validator definition mapping.
+     * @param config The form validator config blocks.
+     */
+    createFormValidatorInstancesFromMapping(defMap, config) {
+        const result = [];
+        for (const validatorConfigItem of (config ?? [])) {
+            const validatorClass = validatorConfigItem?.class;
+            const def = defMap.get(validatorClass);
+            if (!def) {
+                throw new Error(`No validator definition with class '${validatorClass}', `
+                    + `the available validators are: '${Array.from(defMap.keys()).sort().join(", ")}'.`);
+            }
+            const message = validatorConfigItem?.message ?? def.message;
+            const item = def.create({ class: validatorClass, message: message, ...(validatorConfigItem?.config ?? {}) });
+            // for debugging:
+            // const getter = function (path: string | LineagePath) {
+            //     return path as any
+            // };
+            // const examples = {
+            //     'empty': item({value: null, get: getter}),
+            //     'filled': item({value: "some-value", get: getter})
+            // };
+            // console.log(`createFormValidatorInstancesFromMapping validatorClass ${validatorClass} validatorConfigItem ${JSON.stringify(validatorConfigItem)} examples ${JSON.stringify(examples)}`);
+            result.push(item);
+        }
+        return result;
+    }
+    /**
+     * Create instances of the given form validators.
+     *
+     * @param definition The form validator definitions.
+     * @param config The form validator config blocks.
+     */
+    createFormValidatorInstances(definition, config) {
+        const defMap = this.createValidatorDefinitionMapping(definition);
+        return this.createFormValidatorInstancesFromMapping(defMap, config);
+    }
+    /**
+     * Get the form validator errors for a component's control.
+     * @param errors The control's errors.
+     */
+    getFormValidatorComponentErrors(errors) {
+        return Object.entries(errors ?? {}).map(([key, item]) => ({
+            class: key,
+            message: item.message ?? null,
+            params: { ...item.params },
+        })) ?? [];
+    }
+    checkValidationGroups(availableGroups, enabledGroupNames) {
+        const availableGroupNames = Object.keys(availableGroups);
+        const unknownGroups = enabledGroupNames.filter(g => !availableGroupNames.includes(g));
+        if (unknownGroups.length > 0) {
+            throw new Error(`Unknown enabled validation groups ${JSON.stringify(unknownGroups)}.`);
+        }
+    }
+    /**
+     * Is the component model validator enabled?
+     * @param availableGroups All available validation groups in this form.
+     * @param enabledGroupNames The currently enabled validation groups.
+     * @param validator The validator config for a component's model.
+     */
+    isValidatorEnabled(availableGroups, enabledGroupNames, validator) {
+        if (Object.keys(availableGroups).length === 0) {
+            // If there are no validation groups, all validators are enabled.
+            return true;
+        }
+        if (enabledGroupNames.length === 0) {
+            // If there are no validation groups enabled, all validators are enabled.
+            return true;
+        }
+        this.checkValidationGroups(availableGroups, enabledGroupNames);
+        // Check each validation group to see if the validator is enabled.
+        // A validator must pass at least one of the group checks to be enabled.
+        const includes = validator?.groups?.include ?? [];
+        this.checkValidationGroups(availableGroups, includes);
+        const excludes = validator?.groups?.exclude ?? [];
+        this.checkValidationGroups(availableGroups, excludes);
+        for (const [groupKey, groupConfig] of Object.entries(availableGroups)) {
+            const membership = groupConfig?.initialMembership ?? "none";
+            if (!enabledGroupNames?.includes(groupKey)) {
+                // Group is not enabled, so move on.
+                continue;
+            }
+            if (excludes.includes(groupKey)) {
+                // Validator excludes this group, so move on.
+                continue;
+            }
+            if (membership === "all" && !excludes.includes(groupKey)) {
+                // Validator is enabled.
+                // Group is enabled, starts with all validators, and validator does not exclude it.
+                return true;
+            }
+            if (membership === "none" && includes.includes(groupKey)) {
+                // Validator is enabled.
+                // Group is enabled, starts with no validators, and validator includes it.
+                return true;
+            }
+        }
+        // Validator was not included in any group, so it is disabled.
+        return false;
+    }
+    /**
+     * Get the enabled validators.
+     * @param availableGroups All available validation groups in this form.
+     * @param enabledGroups The currently enabled validation groups.
+     * @param validators All available validators in this form.
+     */
+    enabledValidators(availableGroups, enabledGroups, validators) {
+        return (validators ?? []).filter(validator => this.isValidatorEnabled(availableGroups, enabledGroups, validator));
+    }
+}
+exports.ValidatorsSupport = ValidatorsSupport;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidmFsaWRhdG9ycy1zdXBwb3J0LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3ZhbGlkYXRpb24vdmFsaWRhdG9ycy1zdXBwb3J0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQU1BLGlFQUF5RTtBQUV6RSxNQUFhLGlCQUFpQjtJQUMxQjs7O09BR0c7SUFDSSxnQ0FBZ0MsQ0FDbkMsVUFBd0Q7UUFFeEQsTUFBTSxNQUFNLEdBQUcsSUFBSSxHQUFHLEVBQW1DLENBQUM7UUFDMUQsS0FBSyxNQUFNLGNBQWMsSUFBSSxDQUFDLFVBQVUsSUFBSSxFQUFFLENBQUMsRUFBRSxDQUFDO1lBQzlDLElBQUksQ0FBQyxJQUFBLGdEQUE2QixFQUFDLGNBQWMsQ0FBQyxFQUFFLENBQUM7Z0JBQ2pELE1BQU0sSUFBSSxLQUFLLENBQUMseUZBQXlGLElBQUksQ0FBQyxTQUFTLENBQUMsY0FBYyxDQUFDLEVBQUUsQ0FBQyxDQUFDO1lBQy9JLENBQUM7WUFDRCxNQUFNLGNBQWMsR0FBRyxjQUFjLEVBQUUsS0FBSyxDQUFDO1lBQzdDLE1BQU0sT0FBTyxHQUFHLGNBQWMsRUFBRSxPQUFPLENBQUM7WUFDeEMsSUFBSSxNQUFNLENBQUMsR0FBRyxDQUFDLGNBQWMsQ0FBQyxFQUFFLENBQUM7Z0JBQzdCLE1BQU0sUUFBUSxHQUFHLENBQUMsT0FBTyxFQUFFLE1BQU0sQ0FBQyxHQUFHLENBQUMsY0FBYyxDQUFDLEVBQUUsT0FBTyxDQUFDLENBQUM7Z0JBQ2hFLE1BQU0sSUFBSSxLQUFLLENBQUMsOEJBQThCLGNBQWMsNENBQTRDO3NCQUNsRywrRUFBK0UsUUFBUSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7WUFDbEgsQ0FBQztZQUNELE1BQU0sQ0FBQyxHQUFHLENBQUMsY0FBYyxFQUFFLGNBQWMsQ0FBQyxDQUFDO1FBQy9DLENBQUM7UUFDRCxPQUFPLE1BQU0sQ0FBQztJQUNsQixDQUFDO0lBRUQ7Ozs7T0FJRztJQUNJLHVDQUF1QyxDQUMxQyxNQUE0QyxFQUM1QyxNQUFnRDtRQUVoRCxNQUFNLE1BQU0sR0FBc0IsRUFBRSxDQUFDO1FBQ3JDLEtBQUssTUFBTSxtQkFBbUIsSUFBSSxDQUFDLE1BQU0sSUFBSSxFQUFFLENBQUMsRUFBRSxDQUFDO1lBQy9DLE1BQU0sY0FBYyxHQUFHLG1CQUFtQixFQUFFLEtBQUssQ0FBQztZQUNsRCxNQUFNLEdBQUcsR0FBRyxNQUFNLENBQUMsR0FBRyxDQUFDLGNBQWMsQ0FBQyxDQUFDO1lBQ3ZDLElBQUksQ0FBQyxHQUFHLEVBQUUsQ0FBQztnQkFDUCxNQUFNLElBQUksS0FBSyxDQUFDLHVDQUF1QyxjQUFjLEtBQUs7c0JBQ3BFLGtDQUFrQyxLQUFLLENBQUMsSUFBSSxDQUFDLE1BQU0sQ0FBQyxJQUFJLEVBQUUsQ0FBQyxDQUFDLElBQUksRUFBRSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7WUFDN0YsQ0FBQztZQUNELE1BQU0sT0FBTyxHQUFHLG1CQUFtQixFQUFFLE9BQU8sSUFBSSxHQUFHLENBQUMsT0FBTyxDQUFDO1lBQzVELE1BQU0sSUFBSSxHQUFHLEdBQUcsQ0FBQyxNQUFNLENBQUMsRUFBQyxLQUFLLEVBQUUsY0FBYyxFQUFFLE9BQU8sRUFBRSxPQUFPLEVBQUUsR0FBRyxDQUFDLG1CQUFtQixFQUFFLE1BQU0sSUFBSSxFQUFFLENBQUMsRUFBQyxDQUFDLENBQUM7WUFFM0csaUJBQWlCO1lBQ2pCLHlEQUF5RDtZQUN6RCx5QkFBeUI7WUFDekIsS0FBSztZQUNMLHFCQUFxQjtZQUNyQixpREFBaUQ7WUFDakQseURBQXlEO1lBQ3pELEtBQUs7WUFDTCwyTEFBMkw7WUFFM0wsTUFBTSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUN0QixDQUFDO1FBQ0QsT0FBTyxNQUFNLENBQUM7SUFDbEIsQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0ksNEJBQTRCLENBQy9CLFVBQXdELEVBQ3hELE1BQWdEO1FBRWhELE1BQU0sTUFBTSxHQUFHLElBQUksQ0FBQyxnQ0FBZ0MsQ0FBQyxVQUFVLENBQUMsQ0FBQztRQUNqRSxPQUFPLElBQUksQ0FBQyx1Q0FBdUMsQ0FBQyxNQUFNLEVBQUUsTUFBTSxDQUFDLENBQUM7SUFDeEUsQ0FBQztJQUVEOzs7T0FHRztJQUNJLCtCQUErQixDQUFDLE1BQWtDO1FBQ3JFLE9BQU8sTUFBTSxDQUFDLE9BQU8sQ0FBQyxNQUFNLElBQUksRUFBRSxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxHQUFHLEVBQUUsSUFBSSxDQUFDLEVBQUUsRUFBRSxDQUFDLENBQUM7WUFDbEQsS0FBSyxFQUFFLEdBQUc7WUFDVixPQUFPLEVBQUUsSUFBSSxDQUFDLE9BQU8sSUFBSSxJQUFJO1lBQzdCLE1BQU0sRUFBRSxFQUFDLEdBQUcsSUFBSSxDQUFDLE1BQU0sRUFBQztTQUMzQixDQUFDLENBQUMsSUFBSSxFQUFFLENBQUM7SUFDbEIsQ0FBQztJQUVJLHFCQUFxQixDQUFDLGVBQXFDLEVBQUUsaUJBQTJCO1FBQzdGLE1BQU0sbUJBQW1CLEdBQUcsTUFBTSxDQUFDLElBQUksQ0FBQyxlQUFlLENBQUMsQ0FBQztRQUN6RCxNQUFNLGFBQWEsR0FBRyxpQkFBaUIsQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxDQUFDLG1CQUFtQixDQUFDLFFBQVEsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO1FBQ3RGLElBQUksYUFBYSxDQUFDLE1BQU0sR0FBRyxDQUFDLEVBQUUsQ0FBQztZQUM3QixNQUFNLElBQUksS0FBSyxDQUFDLHFDQUFxQyxJQUFJLENBQUMsU0FBUyxDQUFDLGFBQWEsQ0FBQyxHQUFHLENBQUMsQ0FBQTtRQUN4RixDQUFDO0lBQ0gsQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0ksa0JBQWtCLENBQUMsZUFBcUMsRUFBRSxpQkFBMkIsRUFBRSxTQUE4QjtRQUMxSCxJQUFJLE1BQU0sQ0FBQyxJQUFJLENBQUMsZUFBZSxDQUFDLENBQUMsTUFBTSxLQUFLLENBQUMsRUFBRSxDQUFDO1lBQzlDLGlFQUFpRTtZQUNqRSxPQUFPLElBQUksQ0FBQztRQUNkLENBQUM7UUFDRCxJQUFJLGlCQUFpQixDQUFDLE1BQU0sS0FBSyxDQUFDLEVBQUUsQ0FBQztZQUNuQyx5RUFBeUU7WUFDekUsT0FBTyxJQUFJLENBQUM7UUFDZCxDQUFDO1FBRUQsSUFBSSxDQUFDLHFCQUFxQixDQUFDLGVBQWUsRUFBRSxpQkFBaUIsQ0FBQyxDQUFDO1FBRS9ELGtFQUFrRTtRQUNsRSx3RUFBd0U7UUFDeEUsTUFBTSxRQUFRLEdBQUcsU0FBUyxFQUFFLE1BQU0sRUFBRSxPQUFPLElBQUksRUFBRSxDQUFDO1FBQ2xELElBQUksQ0FBQyxxQkFBcUIsQ0FBQyxlQUFlLEVBQUUsUUFBUSxDQUFDLENBQUM7UUFFdEQsTUFBTSxRQUFRLEdBQUcsU0FBUyxFQUFFLE1BQU0sRUFBRSxPQUFPLElBQUksRUFBRSxDQUFDO1FBQ2xELElBQUksQ0FBQyxxQkFBcUIsQ0FBQyxlQUFlLEVBQUUsUUFBUSxDQUFDLENBQUM7UUFFdEQsS0FBSyxNQUFNLENBQUMsUUFBUSxFQUFFLFdBQVcsQ0FBQyxJQUFJLE1BQU0sQ0FBQyxPQUFPLENBQUMsZUFBZSxDQUFDLEVBQUUsQ0FBQztZQUN0RSxNQUFNLFVBQVUsR0FBRyxXQUFXLEVBQUUsaUJBQWlCLElBQUksTUFBTSxDQUFDO1lBRTVELElBQUksQ0FBQyxpQkFBaUIsRUFBRSxRQUFRLENBQUMsUUFBUSxDQUFDLEVBQUUsQ0FBQztnQkFDM0Msb0NBQW9DO2dCQUNwQyxTQUFTO1lBQ1gsQ0FBQztZQUVELElBQUksUUFBUSxDQUFDLFFBQVEsQ0FBQyxRQUFRLENBQUMsRUFBRSxDQUFDO2dCQUNoQyw2Q0FBNkM7Z0JBQzdDLFNBQVM7WUFDWCxDQUFDO1lBRUQsSUFBSSxVQUFVLEtBQUssS0FBSyxJQUFJLENBQUMsUUFBUSxDQUFDLFFBQVEsQ0FBQyxRQUFRLENBQUMsRUFBRSxDQUFDO2dCQUN6RCx3QkFBd0I7Z0JBQ3hCLG1GQUFtRjtnQkFDbkYsT0FBTyxJQUFJLENBQUM7WUFDZCxDQUFDO1lBRUQsSUFBSSxVQUFVLEtBQUssTUFBTSxJQUFJLFFBQVEsQ0FBQyxRQUFRLENBQUMsUUFBUSxDQUFDLEVBQUUsQ0FBQztnQkFDekQsd0JBQXdCO2dCQUN4QiwwRUFBMEU7Z0JBQzFFLE9BQU8sSUFBSSxDQUFDO1lBQ2QsQ0FBQztRQUNILENBQUM7UUFDRCw4REFBOEQ7UUFDOUQsT0FBTyxLQUFLLENBQUM7SUFDZixDQUFDO0lBRUM7Ozs7O09BS0c7SUFDSSxpQkFBaUIsQ0FBQyxlQUFxQyxFQUFFLGFBQXVCLEVBQUUsVUFBaUM7UUFDdEgsT0FBTyxDQUFDLFVBQVUsSUFBSSxFQUFFLENBQUMsQ0FBQyxNQUFNLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxJQUFJLENBQUMsa0JBQWtCLENBQUMsZUFBZSxFQUFFLGFBQWEsRUFBRSxTQUFTLENBQUMsQ0FBQyxDQUFDO0lBQ3RILENBQUM7Q0FDSjtBQTlKRCw4Q0E4SkMifQ==

package/dist/src/validation/validators.d.ts

@@ -0,0 +1,23 @@
+import { FormValidatorDefinition } from "./form.model";
+/**
+ * A regular expression for validating an email address.
+ *
+ * Based on the angular email validation regex. MIT-style license https://angular.dev/license
+ */
+export declare const FORM_VALIDATOR_EMAIL_REGEXP: RegExp;
+/**
+ * Definitions of shared form validators.
+ *
+ * These can be used on both server-side and client-side. The server provides them to the client.
+ * These are the shared / common definitions.
+ * ReDBox implementations can modify these validation definitions or add more.
+ *
+ * The validators are based on:
+ * angular built-in validators: https://github.com/angular/angular/blob/5105fd6f05f01f04873ab1c87d64079fd8519ad4/packages/forms/src/validators.ts
+ * formly schema: https://github.com/ngx-formly/ngx-formly/blob/a2f7901b6c0895aee63b4b5fe748fc5ec0ad5475/src/core/src/lib/models/fieldconfig.ts
+ *
+ * These validation definitions need to be on the server-side, and provided to the client-side from the server.
+ * There are two sets of validator definitions - 1) shared / common definitions in the core; 2) definitions specific to a client.
+ *    These two set of definitions need to be merged and provided by the server to the client.
+ */
+export declare const formValidatorsSharedDefinitions: FormValidatorDefinition[];