@blinkk/selective-edit/dist/selective/validationRules.d.ts

Selective structured text editor.

import { ValidationLevel } from './validation';
import { Base } from '../mixins';
import { ClassManager } from '../utility/classes';
import { Types } from './types';
export interface AllowExcludeRuleConfig {
    message?: string;
    pattern?: string;
    values?: Array<string | RegExp>;
}
export interface MinMaxRuleConfig {
    message?: string;
    value: number;
}
export interface RuleConfig {
    level?: ValidationLevel;
    message?: string;
    type: string;
}
/**
 * Validation rules define the validation on the editor fields.
 *
 * Each field will create an instance of the validation
 * rule based on the validation definitions in the field config.
 */
export interface RuleComponent {
    /**
     * Given the value, should it be able to add new values?
     *
     * Used when dealing with a list to control if the user can
     * add more items.
     *
     * @param value Current value of the field.
     */
    allowAdd(value: any): boolean;
    /**
     * Given the value, should it be able to remove new values?
     *
     * Used when dealing with a list to control if the user can
     * remove more items.
     *
     * @param value Current value of the field.
     */
    allowRemove(value: any): boolean;
    /**
     * Does the rule make the value required?
     *
     * The UI needs to be able to mark fields that are required
     * without needing to show the entire error state.
     *
     * If a validation rule makes it required, this allows the
     * UI to flag the field for the user without a full error
     * display.
     */
    isRequired: boolean;
    /**
     * Validation level used if the validation fails.
     */
    level: ValidationLevel;
    /**
     * Validates the field using the current value.
     *
     * If there is an error with the validation, return an error
     * message string to be displayed to the user.
     *
     * @param value Current value of the field.
     */
    validate(value: any): string | null;
}
export declare type RuleConstructor = (types: Types) => RuleComponent;
export declare class Rules {
    zoneToRules: Record<string, Array<RuleComponent>>;
    types: ClassManager<RuleConstructor, RuleComponent>;
    constructor(ruleTypes: ClassManager<RuleConstructor, RuleComponent>);
    addRuleFromConfig(ruleConfig: RuleConfig, zoneKey?: string): void;
    getRulesForZone(zoneKey?: string): Array<RuleComponent>;
    get zones(): Array<string>;
}
export declare class Rule extends Base implements RuleComponent {
    config: RuleConfig;
    defaultMessage: string;
    defaultLevel: ValidationLevel;
    constructor(config: RuleConfig);
    /**
     * Default to allowing adding.
     *
     * @param value Current value of the field.
     */
    allowAdd(value: any): boolean;
    /**
     * Default to allowing removal.
     *
     * @param value Current value of the field.
     */
    allowRemove(value: any): boolean;
    /**
     * Does the rule make the value required?
     *
     * By default, a validation rule does not make the value required.
     */
    get isRequired(): boolean;
    /**
     * Validation level to use if the validation fails.
     */
    get level(): ValidationLevel;
    /**
     * Error message from the config or fall back to the default.
     */
    get message(): string;
    validate(value: any): string | null;
}