@ng-formworks/core 19.6.3 → 20.6.4

package/lib/shared/json.validators.d.ts

@@ -1,441 +0,0 @@
-import { AbstractControl, ValidationErrors, ValidatorFn } from '@angular/forms';
-import { JsonSchemaFormatNames } from './format-regex.constants';
-import { AsyncIValidatorFn, IValidatorFn, SchemaPrimitiveType } from './validator.functions';
-/**
- * 'JsonValidators' class
- *
- * Provides an extended set of validators to be used by form controls,
- * compatible with standard JSON Schema validation options.
- * http://json-schema.org/latest/json-schema-validation.html
- *
- * Note: This library is designed as a drop-in replacement for the Angular
- * Validators library, and except for one small breaking change to the 'pattern'
- * validator (described below) it can even be imported as a substitute, like so:
- *
- *   import { JsonValidators as Validators } from 'json-validators';
- *
- * and it should work with existing code as a complete replacement.
- *
- * The one exception is the 'pattern' validator, which has been changed to
- * matche partial values by default (the standard 'pattern' validator wrapped
- * all patterns in '^' and '$', forcing them to always match an entire value).
- * However, the old behavior can be restored by simply adding '^' and '$'
- * around your patterns, or by passing an optional second parameter of TRUE.
- * This change is to make the 'pattern' validator match the behavior of a
- * JSON Schema pattern, which allows partial matches, rather than the behavior
- * of an HTML input control pattern, which does not.
- *
- * This library replaces Angular's validators and combination functions
- * with the following validators and transformation functions:
- *
- * Validators:
- *   For all formControls:     required (*), type, enum, const
- *   For text formControls:    minLength (*), maxLength (*), pattern (*), format
- *   For numeric formControls: maximum, exclusiveMaximum,
- *                             minimum, exclusiveMinimum, multipleOf
- *   For formGroup objects:    minProperties, maxProperties, dependencies
- *   For formArray arrays:     minItems, maxItems, uniqueItems, contains
- *   Not used by JSON Schema:  min (*), max (*), requiredTrue (*), email (*)
- * (Validators originally included with Angular are maked with (*).)
- *
- * NOTE / TODO: The dependencies validator is not complete.
- * NOTE / TODO: The contains validator is not complete.
- *
- * Validators not used by JSON Schema (but included for compatibility)
- * and their JSON Schema equivalents:
- *
- *   Angular validator | JSON Schema equivalent
- *   ------------------|-----------------------
- *     min(number)     |   minimum(number)
- *     max(number)     |   maximum(number)
- *     requiredTrue()  |   const(true)
- *     email()         |   format('email')
- *
- * Validator transformation functions:
- *   composeAnyOf, composeOneOf, composeAllOf, composeNot
- * (Angular's original combination funciton, 'compose', is also included for
- * backward compatibility, though it is functionally equivalent to composeAllOf,
- * asside from its more generic error message.)
- *
- * All validators have also been extended to accept an optional second argument
- * which, if passed a TRUE value, causes the validator to perform the opposite
- * of its original finction. (This is used internally to enable 'not' and
- * 'composeOneOf' to function and return useful error messages.)
- *
- * The 'required' validator has also been overloaded so that if called with
- * a boolean parameter (or no parameters) it returns the original validator
- * function (rather than executing it). However, if it is called with an
- * AbstractControl parameter (as was previously required), it behaves
- * exactly as before.
- *
- * This enables all validators (including 'required') to be constructed in
- * exactly the same way, so they can be automatically applied using the
- * equivalent key names and values taken directly from a JSON Schema.
- *
- * This source code is partially derived from Angular,
- * which is Copyright (c) 2014-2017 Google, Inc.
- * Use of this source code is therefore governed by the same MIT-style license
- * that can be found in the LICENSE file at https://angular.io/license
- *
- * Original Angular Validators:
- * https://github.com/angular/angular/blob/master/packages/forms/src/validators.ts
- */
-export declare class JsonValidators {
-    /**
-     * Validator functions:
-     *
-     * For all formControls:     required, type, enum, const
-     * For text formControls:    minLength, maxLength, pattern, format
-     * For numeric formControls: maximum, exclusiveMaximum,
-     *                           minimum, exclusiveMinimum, multipleOf
-     * For formGroup objects:    minProperties, maxProperties, dependencies
-     * For formArray arrays:     minItems, maxItems, uniqueItems, contains
-     *
-     * TODO: finish dependencies validator
-     */
-    /**
-     * 'required' validator
-     *
-     * This validator is overloaded, compared to the default required validator.
-     * If called with no parameters, or TRUE, this validator returns the
-     * 'required' validator function (rather than executing it). This matches
-     * the behavior of all other validators in this library.
-     *
-     * If this validator is called with an AbstractControl parameter
-     * (as was previously required) it behaves the same as Angular's default
-     * required validator, and returns an error if the control is empty.
-     *
-     * Old behavior: (if input type = AbstractControl)
-     * // {AbstractControl} control - required control
-     * // {{[key: string]: boolean}} - returns error message if no input
-     *
-     * New behavior: (if no input, or input type = boolean)
-     * // {boolean = true} required? - true to validate, false to disable
-     * // {IValidatorFn} - returns the 'required' validator function itself
-     */
-    static required(input: AbstractControl): ValidationErrors | null;
-    static required(input?: boolean): IValidatorFn;
-    /**
-     * 'type' validator
-     *
-     * Requires a control to only accept values of a specified type,
-     * or one of an array of types.
-     *
-     * Note: SchemaPrimitiveType = 'string'|'number'|'integer'|'boolean'|'null'
-     *
-     * // {SchemaPrimitiveType|SchemaPrimitiveType[]} type - type(s) to accept
-     * // {IValidatorFn}
-     */
-    static type(requiredType: SchemaPrimitiveType | SchemaPrimitiveType[]): IValidatorFn;
-    /**
-     * 'enum' validator
-     *
-     * Requires a control to have a value from an enumerated list of values.
-     *
-     * Converts types as needed to allow string inputs to still correctly
-     * match number, boolean, and null enum values.
-     *
-     * // {any[]} allowedValues - array of acceptable values
-     * // {IValidatorFn}
-     */
-    static enum(allowedValues: any[]): IValidatorFn;
-    /**
-     * 'const' validator
-     *
-     * Requires a control to have a specific value.
-     *
-     * Converts types as needed to allow string inputs to still correctly
-     * match number, boolean, and null values.
-     *
-     * TODO: modify to work with objects
-     *
-     * // {any[]} requiredValue - required value
-     * // {IValidatorFn}
-     */
-    static const(requiredValue: any): IValidatorFn;
-    /**
-     * 'minLength' validator
-     *
-     * Requires a control's text value to be greater than a specified length.
-     *
-     * // {number} minimumLength - minimum allowed string length
-     * // {boolean = false} invert - instead return error object only if valid
-     * // {IValidatorFn}
-     */
-    static minLength(minimumLength: number): IValidatorFn;
-    /**
-     * 'maxLength' validator
-     *
-     * Requires a control's text value to be less than a specified length.
-     *
-     * // {number} maximumLength - maximum allowed string length
-     * // {boolean = false} invert - instead return error object only if valid
-     * // {IValidatorFn}
-     */
-    static maxLength(maximumLength: number): IValidatorFn;
-    /**
-     * 'pattern' validator
-     *
-     * Note: NOT the same as Angular's default pattern validator.
-     *
-     * Requires a control's value to match a specified regular expression pattern.
-     *
-     * This validator changes the behavior of default pattern validator
-     * by replacing RegExp(`^${pattern}$`) with RegExp(`${pattern}`),
-     * which allows for partial matches.
-     *
-     * To return to the default funcitonality, and match the entire string,
-     * pass TRUE as the optional second parameter.
-     *
-     * // {string} pattern - regular expression pattern
-     * // {boolean = false} wholeString - match whole value string?
-     * // {IValidatorFn}
-     */
-    static pattern(pattern: string | RegExp, wholeString?: boolean): IValidatorFn;
-    /**
-     * 'format' validator
-     *
-     * Requires a control to have a value of a certain format.
-     *
-     * This validator currently checks the following formsts:
-     *   date, time, date-time, email, hostname, ipv4, ipv6,
-     *   uri, uri-reference, uri-template, url, uuid, color,
-     *   json-pointer, relative-json-pointer,duration, regex
-     *
-     * Fast format regular expressions copied from AJV:
-     * https://github.com/epoberezkin/ajv/blob/master/lib/compile/formats.js
-     *
-     * // {JsonSchemaFormatNames} requiredFormat - format to check
-     * // {IValidatorFn}
-     */
-    static format(requiredFormat: JsonSchemaFormatNames): IValidatorFn;
-    /**
-     * 'minimum' validator
-     *
-     * Requires a control's numeric value to be greater than or equal to
-     * a minimum amount.
-     *
-     * Any non-numeric value is also valid (according to the HTML forms spec,
-     * a non-numeric value doesn't have a minimum).
-     * https://www.w3.org/TR/html5/forms.html#attr-input-max
-     *
-     * // {number} minimum - minimum allowed value
-     * // {IValidatorFn}
-     */
-    static minimum(minimumValue: number): IValidatorFn;
-    /**
-     * 'exclusiveMinimum' validator
-     *
-     * Requires a control's numeric value to be less than a maximum amount.
-     *
-     * Any non-numeric value is also valid (according to the HTML forms spec,
-     * a non-numeric value doesn't have a maximum).
-     * https://www.w3.org/TR/html5/forms.html#attr-input-max
-     *
-     * // {number} exclusiveMinimumValue - maximum allowed value
-     * // {IValidatorFn}
-     */
-    static exclusiveMinimum(exclusiveMinimumValue: number): IValidatorFn;
-    /**
-     * 'maximum' validator
-     *
-     * Requires a control's numeric value to be less than or equal to
-     * a maximum amount.
-     *
-     * Any non-numeric value is also valid (according to the HTML forms spec,
-     * a non-numeric value doesn't have a maximum).
-     * https://www.w3.org/TR/html5/forms.html#attr-input-max
-     *
-     * // {number} maximumValue - maximum allowed value
-     * // {IValidatorFn}
-     */
-    static maximum(maximumValue: number): IValidatorFn;
-    /**
-     * 'exclusiveMaximum' validator
-     *
-     * Requires a control's numeric value to be less than a maximum amount.
-     *
-     * Any non-numeric value is also valid (according to the HTML forms spec,
-     * a non-numeric value doesn't have a maximum).
-     * https://www.w3.org/TR/html5/forms.html#attr-input-max
-     *
-     * // {number} exclusiveMaximumValue - maximum allowed value
-     * // {IValidatorFn}
-     */
-    static exclusiveMaximum(exclusiveMaximumValue: number): IValidatorFn;
-    /**
-     * 'multipleOf' validator
-     *
-     * Requires a control to have a numeric value that is a multiple
-     * of a specified number.
-     *
-     * // {number} multipleOfValue - number value must be a multiple of
-     * // {IValidatorFn}
-     */
-    static multipleOf(multipleOfValue: number): IValidatorFn;
-    /**
-     * 'minProperties' validator
-     *
-     * Requires a form group to have a minimum number of properties (i.e. have
-     * values entered in a minimum number of controls within the group).
-     *
-     * // {number} minimumProperties - minimum number of properties allowed
-     * // {IValidatorFn}
-     */
-    static minProperties(minimumProperties: number): IValidatorFn;
-    /**
-     * 'maxProperties' validator
-     *
-     * Requires a form group to have a maximum number of properties (i.e. have
-     * values entered in a maximum number of controls within the group).
-     *
-     * Note: Has no effect if the form group does not contain more than the
-     * maximum number of controls.
-     *
-     * // {number} maximumProperties - maximum number of properties allowed
-     * // {IValidatorFn}
-     */
-    static maxProperties(maximumProperties: number): IValidatorFn;
-    /**
-     * 'dependencies' validator
-     *
-     * Requires the controls in a form group to meet additional validation
-     * criteria, depending on the values of other controls in the group.
-     *
-     * Examples:
-     * https://spacetelescope.github.io/understanding-json-schema/reference/object.html#dependencies
-     *
-     * // {any} dependencies - required dependencies
-     * // {IValidatorFn}
-     */
-    static dependencies(dependencies: any): IValidatorFn;
-    /**
-     * 'minItems' validator
-     *
-     * Requires a form array to have a minimum number of values.
-     *
-     * // {number} minimumItems - minimum number of items allowed
-     * // {IValidatorFn}
-     */
-    static minItems(minimumItems: number): IValidatorFn;
-    /**
-     * 'maxItems' validator
-     *
-     * Requires a form array to have a maximum number of values.
-     *
-     * // {number} maximumItems - maximum number of items allowed
-     * // {IValidatorFn}
-     */
-    static maxItems(maximumItems: number): IValidatorFn;
-    /**
-     * 'uniqueItems' validator
-     *
-     * Requires values in a form array to be unique.
-     *
-     * // {boolean = true} unique? - true to validate, false to disable
-     * // {IValidatorFn}
-     */
-    static uniqueItems(unique?: boolean): IValidatorFn;
-    /**
-     * 'contains' validator
-     *
-     * TODO: Complete this validator
-     *
-     * Requires values in a form array to be unique.
-     *
-     * // {boolean = true} unique? - true to validate, false to disable
-     * // {IValidatorFn}
-     */
-    static contains(requiredItem?: boolean): IValidatorFn;
-    /**
-     * No-op validator. Included for backward compatibility.
-     */
-    static nullValidator(control: AbstractControl): ValidationErrors | null;
-    /**
-     * Validator transformation functions:
-     * composeAnyOf, composeOneOf, composeAllOf, composeNot,
-     * compose, composeAsync
-     *
-     * TODO: Add composeAnyOfAsync, composeOneOfAsync,
-     *           composeAllOfAsync, composeNotAsync
-     */
-    /**
-     * 'composeAnyOf' validator combination function
-     *
-     * Accepts an array of validators and returns a single validator that
-     * evaluates to valid if any one or more of the submitted validators are
-     * valid. If every validator is invalid, it returns combined errors from
-     * all validators.
-     *
-     * // {IValidatorFn[]} validators - array of validators to combine
-     * // {IValidatorFn} - single combined validator function
-     */
-    static composeAnyOf(validators: IValidatorFn[]): IValidatorFn;
-    /**
-     * 'composeOneOf' validator combination function
-     *
-     * Accepts an array of validators and returns a single validator that
-     * evaluates to valid only if exactly one of the submitted validators
-     * is valid. Otherwise returns combined information from all validators,
-     * both valid and invalid.
-     *
-     * // {IValidatorFn[]} validators - array of validators to combine
-     * // {IValidatorFn} - single combined validator function
-     */
-    static composeOneOf(validators: IValidatorFn[]): IValidatorFn;
-    /**
-     * 'composeAllOf' validator combination function
-     *
-     * Accepts an array of validators and returns a single validator that
-     * evaluates to valid only if all the submitted validators are individually
-     * valid. Otherwise it returns combined errors from all invalid validators.
-     *
-     * // {IValidatorFn[]} validators - array of validators to combine
-     * // {IValidatorFn} - single combined validator function
-     */
-    static composeAllOf(validators: IValidatorFn[]): IValidatorFn;
-    /**
-     * 'composeNot' validator inversion function
-     *
-     * Accepts a single validator function and inverts its result.
-     * Returns valid if the submitted validator is invalid, and
-     * returns invalid if the submitted validator is valid.
-     * (Note: this function can itself be inverted
-     *   - e.g. composeNot(composeNot(validator)) -
-     *   but this can be confusing and is therefore not recommended.)
-     *
-     * // {IValidatorFn[]} validators - validator(s) to invert
-     * // {IValidatorFn} - new validator function that returns opposite result
-     */
-    static composeNot(validator: IValidatorFn): IValidatorFn;
-    /**
-     * 'compose' validator combination function
-     *
-     * // {IValidatorFn[]} validators - array of validators to combine
-     * // {IValidatorFn} - single combined validator function
-     */
-    static compose(validators: IValidatorFn[]): IValidatorFn;
-    /**
-     * 'composeAsync' async validator combination function
-     *
-     * // {AsyncIValidatorFn[]} async validators - array of async validators
-     * // {AsyncIValidatorFn} - single combined async validator function
-     */
-    static composeAsync(validators: AsyncIValidatorFn[]): AsyncIValidatorFn;
-    /**
-     * Validator that requires controls to have a value greater than a number.
-     */
-    static min(min: number): ValidatorFn;
-    /**
-     * Validator that requires controls to have a value less than a number.
-     */
-    static max(max: number): ValidatorFn;
-    /**
-     * Validator that requires control value to be true.
-     */
-    static requiredTrue(control: AbstractControl): ValidationErrors | null;
-    /**
-     * Validator that performs email validation.
-     */
-    static email(control: AbstractControl): ValidationErrors | null;
-}