mirror of
https://github.com/wassname/DefinitelyTyped.git
synced 2026-09-09 11:13:57 +08:00
DanilF - Regenerated .d.ts for v0.2.0 of decorum library.
This commit is contained in:
DanilF
@@ -8,8 +8,12 @@ import {Length} from 'decorum';
|
||||
import {FieldName} from 'decorum';
|
||||
import {Validation} from 'decorum';
|
||||
import {Pattern} from 'decorum';
|
||||
import {Alpha} from 'decorum';
|
||||
import {AlphaNumeric} from 'decorum';
|
||||
import {Validator} from 'decorum';
|
||||
import {BaseValidator} from 'decorum';
|
||||
import {IMessageOpts} from 'decorum';
|
||||
import {MessageHandlers} from 'decorum';
|
||||
|
||||
class MyModel {
|
||||
@FieldName('User name')
|
||||
@@ -39,6 +43,12 @@ class MyModel {
|
||||
|
||||
@Length(6, 'Alias must be 6 characters long')
|
||||
alias: string;
|
||||
|
||||
@Alpha((opts: IMessageOpts) => 'Message overridden for field ' + opts.property + ' with friendly name ' + opts.friendlyName)
|
||||
alpha: string;
|
||||
|
||||
@AlphaNumeric((opts: IMessageOpts) => 'Message overridden for field ' + opts.property + ' with friendly name ' + opts.friendlyName)
|
||||
alphaNumeric: string;
|
||||
}
|
||||
|
||||
// ES6-style
|
||||
@@ -48,9 +58,9 @@ class MyController {
|
||||
|
||||
doStuff(): void {
|
||||
var opts = this.validator.getValidationOptions('alias');
|
||||
var fieldName = opts.getFieldName();
|
||||
var fieldName = opts.getFriendlyName();
|
||||
var errs = opts.validateValue('foo', this.model);
|
||||
opts.setFieldName('Foo');
|
||||
opts.setFriendlyName('Foo');
|
||||
opts.addValidator(null);
|
||||
var validators = opts.getValidators();
|
||||
}
|
||||
@@ -74,10 +84,11 @@ function MyOtherModel() {
|
||||
|
||||
Validator.decorate(MyOtherModel, {
|
||||
foo: [
|
||||
Required()
|
||||
decorum.Required()
|
||||
],
|
||||
bar: [
|
||||
Pattern(/^[a-z][0-9]$/i)
|
||||
decorum.Pattern(/^[a-z][0-9]$/i),
|
||||
decorum.FieldName('My bar')
|
||||
]
|
||||
});
|
||||
|
||||
@@ -91,12 +102,14 @@ class MyValidator extends BaseValidator {
|
||||
return false;
|
||||
}
|
||||
|
||||
getMessage(fieldName: string, fieldValue: any): string {
|
||||
return 'No!';
|
||||
getMessage(opts: IMessageOpts): string {
|
||||
return opts.friendlyName + ' is not a valid thing because of value ' + opts.value + '! Fyi... its property name is ' + opts.property;
|
||||
}
|
||||
|
||||
isValid(value: any, model: any): boolean {
|
||||
return false;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
// Message overrides
|
||||
MessageHandlers['alpha'] = (opts: IMessageOpts) => 'The value ' + opts.value + ' for property ' + opts.property + ' is invalid!';
|
||||
|
||||
Vendored
+263
-119
@@ -1,72 +1,90 @@
|
||||
// Type definitions for Decorum JS v0.1.2
|
||||
// Type definitions for Decorum JS v0.2.0
|
||||
// Project: https://github.com/dflor003/decorum
|
||||
// Definitions by: Danil Flores <https://github.com/dflor003>
|
||||
// Definitions: https://github.com/borisyankov/DefinitelyTyped
|
||||
|
||||
declare module 'decorum' {
|
||||
export = decorum;
|
||||
}
|
||||
|
||||
declare namespace decorum {
|
||||
/**
|
||||
* A generic custom validation. Takes a predicate that will receive the proposed value as the first parameter and the
|
||||
* current model state as the second.
|
||||
* A generic custom validation. Takes a predicate that will receive the proposed value as the first parameter and
|
||||
* the current model state as the second.
|
||||
* @param message The message to display when the predicate fails.
|
||||
* @param predicate A lambda expression/function that determines if the value is valid. If it returns a falsy value, the
|
||||
* field will be considered invalid and will return the passed error message upon validation.
|
||||
* @param predicate A lambda expression/function that determines if the value is valid. If it returns a falsy
|
||||
* value, the field will be considered invalid and will return the passed error message upon validation.
|
||||
* @returns {function(Object, string): void} A field validation decorator.
|
||||
*/
|
||||
export function Validation<TModel>(message: string, predicate: (value: any, model: TModel) => boolean): PropertyDecorator;
|
||||
export function Validation<TModel>(message: string | MessageHandler<CustomValidator<TModel>>, predicate: (value: any, model: TModel) => boolean): PropertyDecorator;
|
||||
|
||||
/**
|
||||
* Validate's that the field is a valid email address. The format used is the same as the webkit browser's internal
|
||||
* email validation format. For looser or stricter formats, use your own validation based on the @Pattern decorator.
|
||||
* @param message [Optional] Overrides the default validation error message.
|
||||
* @returns {function(Object, string): void} A field validation decorator.
|
||||
*/
|
||||
export function Email(message?: string): PropertyDecorator;
|
||||
* Validate's that the field is a valid email address. The format used is the same as the webkit browser's internal
|
||||
* email validation format. For looser or stricter formats, use your own validation based on the @Pattern decorator.
|
||||
* @param message [Optional] Overrides the default validation error message.
|
||||
* @returns {function(Object, string): void} A field validation decorator.
|
||||
*/
|
||||
export function Email(message?: string | MessageHandler<EmailValidator>): PropertyDecorator;
|
||||
|
||||
/**
|
||||
* Sets the field's "friendly" name in validation error messages.
|
||||
* @param name The field's friendly name
|
||||
* @returns {function(Object, string): void} A field validation decorator.
|
||||
*/
|
||||
* Sets the field's "friendly" name in validation error messages.
|
||||
* @param name The field's friendly name
|
||||
* @returns {function(Object, string): void} A field validation decorator.
|
||||
*/
|
||||
export function FieldName(name: string): PropertyDecorator;
|
||||
|
||||
/**
|
||||
* Validate's a field's EXACT length. Validation fails if the field is not EXACTLY the length passed.
|
||||
* @param length The exact length the field must be.
|
||||
* @param message [Optional] Overrides the default validation error message.
|
||||
* @returns {function(Object, string): void} A field validation decorator.
|
||||
*/
|
||||
export function Length(length: number, message?: string): PropertyDecorator;
|
||||
* Validate's a field's EXACT length. Validation fails if the field is not EXACTLY the length passed.
|
||||
* @param length The exact length the field must be.
|
||||
* @param message [Optional] Overrides the default validation error message.
|
||||
* @returns {function(Object, string): void} A field validation decorator.
|
||||
*/
|
||||
export function Length(length: number, message?: string | MessageHandler<LengthValidator>): PropertyDecorator;
|
||||
|
||||
/**
|
||||
* Validates a field's maximum length.
|
||||
* @param maxLength The field's maximum length. Must be a positive integer greater than 1.
|
||||
* @param message [Optional] Overrides the default validation error message.
|
||||
* @returns {function(Object, string): void} A field validation decorator.
|
||||
*/
|
||||
export function MaxLength(maxLength: number, message?: string): PropertyDecorator;
|
||||
* Validates a field's maximum length.
|
||||
* @param maxLength The field's maximum length. Must be a positive integer greater than 1.
|
||||
* @param message [Optional] Overrides the default validation error message.
|
||||
* @returns {function(Object, string): void} A field validation decorator.
|
||||
*/
|
||||
export function MaxLength(maxLength: number, message?: string | MessageHandler<MaxLengthValidator>): PropertyDecorator;
|
||||
|
||||
/**
|
||||
* Validates the field's minimum length.
|
||||
* @param minLength The field's minimum length. Must be a positive integer greater than 0
|
||||
* @param message [Optional] Overrides the default validation error message.
|
||||
* @returns {function(Object, string): void} A field validation decorator.
|
||||
*/
|
||||
export function MinLength(minLength: number, message?: string): PropertyDecorator;
|
||||
* Validates the field's minimum length.
|
||||
* @param minLength The field's minimum length. Must be a positive integer greater than 0
|
||||
* @param message [Optional] Overrides the default validation error message.
|
||||
* @returns {function(Object, string): void} A field validation decorator.
|
||||
*/
|
||||
export function MinLength(minLength: number, message?: string | MessageHandler<MinLengthValidator>): PropertyDecorator;
|
||||
|
||||
/**
|
||||
* Validates the field against a regular expression pattern.
|
||||
* @param regex The regex to validate against. Should be a valid JavaScript {RegExp} instance.
|
||||
* @param message [Optional] Overrides the default validation error message.
|
||||
* @returns {function(Object, string): void} A field validation decorator.
|
||||
*/
|
||||
export function Pattern(regex: RegExp, message?: string): PropertyDecorator;
|
||||
* Validates the field against a regular expression pattern.
|
||||
* @param regex The regex to validate against. Should be a valid JavaScript {RegExp} instance.
|
||||
* @param message [Optional] Overrides the default validation error message.
|
||||
* @returns {function(Object, string): void} A field validation decorator.
|
||||
*/
|
||||
export function Pattern(regex: RegExp, message?: string | MessageHandler<PatternValidator>): PropertyDecorator;
|
||||
|
||||
/**
|
||||
* Marks the field as required.
|
||||
* @param message [Optional] Overrides the default validation error message.
|
||||
* @returns {function(Object, string): void} A field validation decorator.
|
||||
*/
|
||||
export function Required(message?: string): PropertyDecorator;
|
||||
* Marks the field as required.
|
||||
* @param message [Optional] Overrides the default validation error message.
|
||||
* @returns {function(Object, string): void} A field validation decorator.
|
||||
*/
|
||||
export function Required(message?: string | MessageHandler<RequiredFieldValidator>): PropertyDecorator;
|
||||
|
||||
/**
|
||||
* Validates that a given field only contains alpha values.
|
||||
* @param message [Optional] Overrides the default validation error message.
|
||||
* @returns {function(Object, string): void} A field validation decorator.
|
||||
*/
|
||||
export function Alpha(message?: string | MessageHandler<PatternValidator>): PropertyDecorator;
|
||||
|
||||
/**
|
||||
* Validates that a given field only contains alphanumeric values.
|
||||
* @param message [Optional] Overrides the default validation error message.
|
||||
* @returns {function(Object, string): void} A field validation decorator.
|
||||
*/
|
||||
export function AlphaNumeric(message?: string | MessageHandler<PatternValidator>): PropertyDecorator;
|
||||
|
||||
/**
|
||||
* A map from field name to array of field validation decorators.
|
||||
@@ -96,11 +114,20 @@ declare module 'decorum' {
|
||||
static decorate(objectType: any, definitions: ValidationDefinitions): void;
|
||||
|
||||
/**
|
||||
* Creates an anonymous validator, immediately validates the model, and returns any validation errors on the model
|
||||
* as a result.
|
||||
* Creates an anonymous validator, immediately validates the model, and returns any validation errors on the
|
||||
* model as a result.
|
||||
* @param model The model to validate.
|
||||
*/
|
||||
static validate(model: any): IValidationResult;
|
||||
|
||||
/**
|
||||
* Adds a validator to the given object prototype for the given property. Meant to be used inside of validation
|
||||
* decorators to inject the validation onto the object property.
|
||||
* @param targetPrototype A valid object prototype to add to.
|
||||
* @param property The property to add the validator for.
|
||||
* @param validator The validator to add.
|
||||
*/
|
||||
static addValidator(targetPrototype: Object, property: string, validator: BaseValidator): void;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -167,48 +194,222 @@ declare module 'decorum' {
|
||||
validateField(fieldKey: string, proposedValue?: any): string[];
|
||||
|
||||
/**
|
||||
* Validate the entire model and return a result that indicates whether the model is valid or not and any errors
|
||||
* Validate the entire model and return a result that indicates whether the model is valid or not and any
|
||||
* errors
|
||||
* that have occurred in an object indexed by field name on the model.
|
||||
* @returns {IValidationResult} An object that contains whether the model is valid or not and errors by field name.
|
||||
* @returns {IValidationResult} An object that contains whether the model is valid or not and errors by field
|
||||
* name.
|
||||
*/
|
||||
validate(): IValidationResult;
|
||||
}
|
||||
|
||||
/**
|
||||
* Callback invoked when a validation needs to return an error. Parameters include field name,
|
||||
* field value, and any other properties relating to the field validation itself.
|
||||
* Callback invoked when a validation needs to return an error. The first parameter is an object
|
||||
* wrapping metadata about the field such as the field name, friendly name, value, etc.
|
||||
* The second parameter is the validator instance that triggered the error.
|
||||
*/
|
||||
export type MessageHandler = (fieldName: string, fieldValue: any, ...args: any[]) => string;
|
||||
export interface MessageHandler<TValidator extends BaseValidator> {
|
||||
(opts: IMessageOpts, validator: TValidator): string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Options passed to a field to aid in generating a message. Contains data about
|
||||
* the field such as name, friendly name, and value.
|
||||
*/
|
||||
export interface IMessageOpts {
|
||||
/**
|
||||
* The property name from the model. I.e. 'emailAddress', 'username', etc.
|
||||
*/
|
||||
property: string;
|
||||
|
||||
/**
|
||||
* The friendly name for the field. I.e. 'Email address', 'Password Confirmation', etc.
|
||||
*/
|
||||
friendlyName: string;
|
||||
|
||||
/**
|
||||
* The current value of the field at the time the validation error was generated.
|
||||
*/
|
||||
value: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* A map of validation "key" (unique name for a given type of validation) to message handler callback.
|
||||
*/
|
||||
export interface IMessageHandlerMap {
|
||||
[key: string]: MessageHandler;
|
||||
[key: string]: MessageHandler<any>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Mechanism for overriding validation errors to provide for custom or localized error messages.
|
||||
* @type {{IMessageHandlerMap}}
|
||||
*/
|
||||
let MessageHandlers: IMessageHandlerMap;
|
||||
export let MessageHandlers: IMessageHandlerMap;
|
||||
|
||||
/**
|
||||
* Custom validation class.
|
||||
*/
|
||||
export class CustomValidator<TModel> extends BaseValidator {
|
||||
constructor(predicate: (value: any, model: TModel) => boolean, message: string | MessageHandler<CustomValidator<TModel>>);
|
||||
|
||||
getMessage(opts: IMessageOpts): string;
|
||||
|
||||
isValid(value: any, model: any): boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* An email validator.
|
||||
*/
|
||||
export class EmailValidator extends PatternValidator {
|
||||
static EmailRegex: RegExp;
|
||||
|
||||
constructor(message?: string | MessageHandler<EmailValidator>);
|
||||
|
||||
getMessage(opts: IMessageOpts): string;
|
||||
|
||||
getKey(): string;
|
||||
}
|
||||
|
||||
/**
|
||||
* An exact length validator.
|
||||
*/
|
||||
export class LengthValidator extends BaseValidator {
|
||||
length: number;
|
||||
|
||||
constructor(length: number, message?: string | MessageHandler<LengthValidator>);
|
||||
|
||||
getMessage(opts: IMessageOpts): string;
|
||||
|
||||
isValid(value: any): boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* A maximum length validator.
|
||||
*/
|
||||
export class MaxLengthValidator extends BaseValidator {
|
||||
maxLength: number;
|
||||
|
||||
constructor(maxLength: number, message?: string | MessageHandler<MaxLengthValidator>);
|
||||
|
||||
getMessage(opts: IMessageOpts): string;
|
||||
|
||||
isValid(value: string): boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* A minimum length validator.
|
||||
*/
|
||||
export class MinLengthValidator extends BaseValidator {
|
||||
minLength: number;
|
||||
|
||||
constructor(minLength: number, message?: string | MessageHandler<MinLengthValidator>);
|
||||
|
||||
getMessage(opts: IMessageOpts): string;
|
||||
|
||||
isValid(value: string): boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* A regular expression validator.
|
||||
*/
|
||||
export class PatternValidator extends BaseValidator {
|
||||
pattern: RegExp;
|
||||
|
||||
constructor(pattern: RegExp, message?: string | MessageHandler<PatternValidator>);
|
||||
|
||||
getMessage(opts: IMessageOpts): string;
|
||||
|
||||
isValid(value: any): boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* A field requiredness validator.
|
||||
*/
|
||||
export class RequiredFieldValidator extends BaseValidator {
|
||||
constructor(message?: string | MessageHandler<RequiredFieldValidator>);
|
||||
|
||||
validatesEmptyValue(): boolean;
|
||||
|
||||
getMessage(opts: IMessageOpts): string;
|
||||
|
||||
isValid(value: any): boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* Base abstract class for all validators. Methods that must be overridden:
|
||||
* getMessage(...) - Get error message to return when field is invalid.
|
||||
* isValid(...) - Check validity of field given proposed value and the rest of the model.
|
||||
*/
|
||||
export abstract class BaseValidator {
|
||||
/**
|
||||
* Initializes the {BaseValidator}
|
||||
* @param validatorKey A unique "key" by which to identify this field validator i.e. length, maxlength,
|
||||
* required. Should be a valid JS property name.
|
||||
* @param message A custom error message to return. Should be passed down from concrete class' constructors to
|
||||
* enable customizing error messages.
|
||||
*/
|
||||
constructor(validatorKey: string, message: string | MessageHandler<any>);
|
||||
|
||||
/**
|
||||
* Returns true if the validator instance was passed a custom error message.
|
||||
*/
|
||||
hasCustomMessage: boolean;
|
||||
|
||||
/**
|
||||
* Check whether this validator should process an "empty" value (i.e. null, undefined, empty string). Override
|
||||
* this in derived classes to skip validators if the field value hasn't been set. Things like email, min/max
|
||||
* length, and pattern should return false for this to ensure they don't get fired when the model is initially
|
||||
* empty before a user has had a chance to input a value. Things like required should override this to true so
|
||||
* that they are fired for empty values. Base implementation defaults to false
|
||||
* @returns {boolean}
|
||||
*/
|
||||
validatesEmptyValue(): boolean;
|
||||
|
||||
/**
|
||||
* Gets the custom error message set on this validator.
|
||||
* @param opts Metadata about the field such as name and friendly name.
|
||||
* @returns {string} The custom error message or null if none has been set.
|
||||
*/
|
||||
getCustomMessage(opts: IMessageOpts): string;
|
||||
|
||||
/**
|
||||
* Gets the unique name for this validator.
|
||||
* @returns {string} The unique name for this validator.
|
||||
*/
|
||||
getKey(): string;
|
||||
|
||||
/**
|
||||
* [Abstract] Gets the error message to display when a field fails validation by this validator.
|
||||
* @param opts Metadata about the field such as name and friendly name.
|
||||
*/
|
||||
abstract getMessage(opts: IMessageOpts): string;
|
||||
|
||||
/**
|
||||
* [Abstract] Checks the passed value for validity.
|
||||
* @param value The field's proposed value.
|
||||
* @param model The rest of the model if cross-field validity checks are necessary.
|
||||
*/
|
||||
abstract isValid(value: any, model: any): boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* Validation options for a given field including actual validators and meta data such as the field name.
|
||||
*/
|
||||
export class FieldOptions {
|
||||
constructor(property: string);
|
||||
|
||||
/**
|
||||
* Gets the "friendly" name of the field for use in validation error messages. Defaults to just "Field".
|
||||
* @returns {string}
|
||||
*/
|
||||
getFieldName(): string;
|
||||
getFriendlyName(): string;
|
||||
|
||||
/**
|
||||
* Sets the "friendly" name of the field for use in validation error messages. This name will be used in the text
|
||||
* of validation errors.
|
||||
* Sets the "friendly" name of the field for use in validation error messages. This name will be used in the
|
||||
* text of validation errors.
|
||||
* @param name The new name to set.
|
||||
*/
|
||||
setFieldName(name: string): void;
|
||||
setFriendlyName(name: string): void;
|
||||
|
||||
/**
|
||||
* Add a validator to the list of validators for this field.
|
||||
@@ -223,70 +424,13 @@ declare module 'decorum' {
|
||||
getValidators(): BaseValidator[];
|
||||
|
||||
/**
|
||||
* Runs through all of the validators for the field given a particular value and returns any validation errors that
|
||||
* may have occurred.
|
||||
* Runs through all of the validators for the field given a particular value and returns any validation errors
|
||||
* that may have occurred.
|
||||
* @param value The value to validate.
|
||||
* @param model The rest of the model. Used in custom cross-field validations.
|
||||
* @returns {string[]} Any validation errors that may have occurred or an empty array if the value passed is valid
|
||||
* for the field.
|
||||
* @returns {string[]} Any validation errors that may have occurred or an empty array if the value passed is
|
||||
* valid for the field.
|
||||
*/
|
||||
validateValue(value: any, model: any): string[];
|
||||
}
|
||||
|
||||
/**
|
||||
* Base abstract class for all validators. Methods that must be overridden:
|
||||
* getMessage(...) - Get error message to return when field is invalid.
|
||||
* isValid(...) - Check validity of field given proposed value and the rest of the model.
|
||||
*/
|
||||
abstract class BaseValidator {
|
||||
/**
|
||||
* Initializes the {BaseValidator}
|
||||
* @param validatorKey A unique "key" by which to identify this field validator i.e. length, maxlength, required.
|
||||
* Should be a valid JS property name.
|
||||
* @param message A custom error message to return. Should be passed down from concrete class' constructors to enable
|
||||
* customizing error messages.
|
||||
*/
|
||||
constructor(validatorKey: string, message: string);
|
||||
|
||||
/**
|
||||
* Returns true if the validator instance was passed a custom error message.
|
||||
*/
|
||||
hasCustomMessage: boolean;
|
||||
|
||||
/**
|
||||
* Check whether this validator should process an "empty" value (i.e. null, undefined, empty string). Override
|
||||
* this in derived classes to skip validators if the field value hasn't been set. Things like email, min/max length,
|
||||
* and pattern should return false for this to ensure they don't get fired when the model is initially empty
|
||||
* before a user has had a chance to input a value. Things like required should override this to true so that
|
||||
* they are fired for empty values. Base implementation defaults to false
|
||||
* @returns {boolean}
|
||||
*/
|
||||
validatesEmptyValue(): boolean;
|
||||
|
||||
/**
|
||||
* Gets the custom error message set on this validator.
|
||||
* @returns {string} The custom error message or null if none has been set.
|
||||
*/
|
||||
getCustomMessage(): string;
|
||||
|
||||
/**
|
||||
* Gets the unique name for this validator.
|
||||
* @returns {string} The unique name for this validator.
|
||||
*/
|
||||
getKey(): string;
|
||||
|
||||
/**
|
||||
* [Abstract] Gets the error message to display when a field fails validation by this validator.
|
||||
* @param fieldName The "friendly" name set for the field.
|
||||
* @param fieldValue The field's current value.
|
||||
*/
|
||||
abstract getMessage(fieldName: string, fieldValue: any): string;
|
||||
|
||||
/**
|
||||
* [Abstract] Checks the passed value for validity.
|
||||
* @param value The field's proposed value.
|
||||
* @param model The rest of the model if cross-field validity checks are necessary.
|
||||
*/
|
||||
abstract isValid(value: any, model: any): boolean;
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user