@nattyjs/validation-decorators 0.0.1-beta.0

package/dist/index.d.ts

@@ -0,0 +1,404 @@
+interface BaseValidatorConfig {
+    message?: string;
+    conditionalExpression?: Function;
+    messageKey?: string;
+}
+
+interface ArrayConfig extends BaseValidatorConfig {
+    matchValues?: any[];
+}
+
+declare function allOf(config?: ArrayConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+interface RequiredConfig extends BaseValidatorConfig {
+}
+
+declare function required(config?: RequiredConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare enum NumericValueType {
+    PositiveNumber = 1,
+    NegativeNumber = 2,
+    Both = 3
+}
+
+interface NumericConfig extends BaseValidatorConfig {
+    allowDecimal?: boolean;
+    acceptValue?: NumericValueType;
+    isFormat?: boolean;
+    digitsInfo?: string;
+    persistZero?: boolean;
+}
+
+declare function numeric(config?: NumericConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+interface AlphaConfig extends BaseValidatorConfig {
+    allowWhiteSpace?: boolean;
+    locale?: string;
+    allowCharacters?: string;
+}
+
+declare function alpha(config?: AlphaConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function alphaNumeric(config?: AlphaConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function ascii(config?: BaseValidatorConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+interface ContainsConfig extends BaseValidatorConfig {
+    value?: string;
+    values?: any[];
+}
+
+declare function contains(config: ContainsConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+interface CreditCardConfig extends BaseValidatorConfig {
+    creditCardTypes?: string[];
+    fieldName?: string;
+}
+
+declare function creditCard(config: CreditCardConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function cusip(config?: BaseValidatorConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function dataUri(config?: BaseValidatorConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function date(config?: BaseValidatorConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+interface FieldConfig extends BaseValidatorConfig {
+    fieldName?: string;
+}
+
+interface DifferentConfig extends FieldConfig {
+}
+
+declare function different(config: DifferentConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+interface DigitConfig extends BaseValidatorConfig {
+}
+
+declare function digit(config?: DigitConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+interface EmailConfig extends BaseValidatorConfig {
+}
+
+declare function email(config?: EmailConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+interface DefaultConfig extends BaseValidatorConfig {
+    value?: string;
+}
+
+interface StringValueConfig extends DefaultConfig {
+    values?: any[];
+}
+
+declare function endsWith(config: StringValueConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function even(config?: BaseValidatorConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+interface ExtensionConfig extends BaseValidatorConfig {
+    extensions?: string[];
+    isExcludeExtensions?: boolean;
+}
+
+declare function extension(config: ExtensionConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+interface FactorConfig extends BaseValidatorConfig {
+    dividend?: number;
+    fieldName?: string;
+}
+
+declare function factor(config?: FactorConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+interface RelationalOperatorConfig extends BaseValidatorConfig {
+    fieldName?: string;
+    value?: any;
+    isArrayControl?: boolean;
+}
+
+declare function greaterThanEqualTo(config: RelationalOperatorConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function greaterThan(config: RelationalOperatorConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+interface MessageConfig extends BaseValidatorConfig {
+}
+
+declare function hexColor(config?: MessageConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare enum IpVersion {
+    V4 = 1,
+    V6 = 2,
+    AnyOne = 3
+}
+
+interface IpConfig extends BaseValidatorConfig {
+    version?: IpVersion;
+    isCidr?: boolean;
+}
+
+declare function ip(config?: IpConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function json(config?: DefaultConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function latitude(config?: BaseValidatorConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function latLong(config?: BaseValidatorConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function leapYear(config?: BaseValidatorConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function lessThanEqualTo(config: RelationalOperatorConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function lessThan(config: RelationalOperatorConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function longitude(config?: BaseValidatorConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function lowerCase(config?: MessageConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function mac(config?: BaseValidatorConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+interface DateConfig extends BaseValidatorConfig {
+    value?: Date | string;
+    fieldName?: string;
+    allowISODate?: boolean;
+}
+
+interface MaxDateConfig extends DateConfig {
+    operator?: "<" | "<=";
+}
+
+declare function maxDate(config: MaxDateConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+interface NumberConfig extends BaseValidatorConfig {
+    value?: number;
+}
+
+declare function maxLength(config: NumberConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function maxNumber(config: NumberConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+interface TimeRelationConfig extends BaseValidatorConfig {
+    value?: string;
+    fieldName?: string;
+    allowSeconds?: boolean;
+}
+interface MinTimeConfig extends TimeRelationConfig {
+    operator?: ">" | ">=";
+}
+interface MaxTimeConfig extends TimeRelationConfig {
+    operator?: "<" | "<=";
+}
+
+declare function maxTime(config: MaxTimeConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+interface MinDateConfig extends DateConfig {
+    operator?: ">" | ">=";
+}
+
+declare function minDate(config: MinDateConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function minLength(config: NumberConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function minNumber(config: NumberConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function minTime(config: MinTimeConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function noneOf(config?: ArrayConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function notEmpty(config?: BaseValidatorConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function odd(config?: BaseValidatorConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function oneOf(config?: ArrayConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+interface PasswordValidation {
+    digit?: boolean;
+    alphabet?: boolean;
+    contains?: string;
+    lowerCase?: boolean;
+    upperCase?: boolean;
+    specialCharacter?: boolean;
+    minLength?: number;
+    maxLength?: number;
+}
+interface PasswordValidationMessage {
+    digit?: string;
+    alphabet?: string;
+    contains?: string;
+    lowerCase?: string;
+    upperCase?: string;
+    specialCharacter?: string;
+    minLength?: string;
+    maxLength?: string;
+}
+
+interface PasswordConfig {
+    validation?: PasswordValidation;
+    conditionalExpression?: string | Function;
+    message?: PasswordValidationMessage | string;
+    messageKey?: PasswordValidationMessage | string;
+}
+
+declare function password(config: PasswordConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+interface PatternConfig extends BaseValidatorConfig {
+    expression?: {
+        [key: string]: RegExp;
+    };
+}
+
+declare function pattern(config: PatternConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function port(config?: BaseValidatorConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function primeNumber(config?: BaseValidatorConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+interface RangeConfig extends BaseValidatorConfig {
+    minimumNumber?: number;
+    maximumNumber?: number;
+}
+
+declare function range(config: RangeConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function requiredTrue(config?: RequiredConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+interface StringComparisonConfig extends DefaultConfig {
+    isRestrict?: boolean;
+    values?: any[];
+}
+
+declare function startsWith(config: StringComparisonConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function upperCase(config?: MessageConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare enum UrlValidationType {
+    FQDN = 1,
+    LocalHost = 2,
+    IntranetServer = 3
+}
+
+interface UrlConfig extends BaseValidatorConfig {
+    urlValidationType?: UrlValidationType;
+}
+
+declare function url(config?: UrlConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function blacklist(chars: string): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function escape(): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function ltrim(): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function prefix(text: string): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function rtrim(): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function stripLow(keepNewLines?: boolean): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function suffix(text: string): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function toBoolean(strict?: boolean): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function toDate(): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function toInt(radix?: number): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function toString(): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function trim(): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+declare function whitelist(chars: string): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+interface SanitizeConfig {
+    custom: Function;
+}
+
+declare function sanitize(config: SanitizeConfig): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+interface Type<T> extends Function {
+    new (...args: any[]): T;
+}
+
+interface PropConfig$1 {
+    type?: Type<any>;
+    isArrayType?: boolean;
+}
+
+declare function prop(config?: PropConfig$1): (target: any, propertyKey: string, parameterIndex?: any) => void;
+
+interface DecoratorParams {
+    target: Function;
+    propertyKey?: string;
+    descriptor?: PropertyDescriptor;
+}
+
+interface ModelConfig {
+    tableName?: string;
+}
+
+interface DbFieldConfig {
+    name?: string;
+    type?: number;
+    defaultValue?: any;
+    isPrimaryKey?: boolean;
+    foreignKey?: any;
+    oneToMany?: FieldRelationConfig;
+    oneToOne?: FieldRelationConfig;
+}
+interface FieldRelationConfig {
+    model: any;
+    foreignKey: string;
+}
+
+interface PropConfig {
+    db?: DbFieldConfig;
+}
+
+interface PropertyDecoratorConfig {
+    decoratorParams: DecoratorParams;
+    validatorConfig?: any;
+    propConfig?: PropConfig;
+    modelConfig?: ModelConfig;
+    sanitizerConfig?: {
+        name: string;
+        config: any;
+        sanitizer: Function;
+    };
+}
+
+declare const decoratorRegistrationCaller: {
+    register: (config: PropertyDecoratorConfig) => {};
+};
+
+type ValidatorFn = null | {
+    [key: string]: any;
+};
+
+interface ValidatorParams {
+    root: any;
+    current: any;
+    value: any;
+}
+
+declare function requiredValidator(config: RequiredConfig, params: ValidatorParams): ValidatorFn;
+
+declare const ControlValidators: {
+    required: typeof requiredValidator;
+};
+
+interface FormConfig {
+    errorMessage?: ErrorMessage;
+    dateConfig?: {
+        seperator?: string;
+        format?: 'mdy' | 'dmy' | 'ymd';
+    };
+}
+interface ErrorMessage {
+    validator?: {
+        [key: string]: string;
+    };
+}
+
+declare const validationForms: {
+    formConfig: FormConfig;
+    configure(config: FormConfig): void;
+};
+
+export { ControlValidators, FormConfig, NumericValueType, RequiredConfig, ValidatorFn, allOf as decoratorAllOfValidation, alphaNumeric as decoratorAlphaNumericValidation, alpha as decoratorAlphaValidation, ascii as decoratorAsciiValidation, blacklist as decoratorBlacklistSanitizer, contains as decoratorContainsValidation, creditCard as decoratorCreditCardValidation, cusip as decoratorCusipValidation, dataUri as decoratorDataUriValidation, date as decoratorDateValidation, different as decoratorDifferentValdiation, digit as decoratorDigitValidation, email as decoratorEmailValidation, endsWith as decoratorEndsWithValidation, escape as decoratorEscapeSanitizer, even as decoratorEvenValidation, extension as decoratorExtensionValidation, factor as decoratorFactorValidation, greaterThanEqualTo as decoratorGreaterThanEqualToValidation, greaterThan as decoratorGreaterThanValidation, hexColor as decoratorHexColorValidation, ip as decoratorIpValidation, json as decoratorJsonValidation, latLong as decoratorLatLongValidation, latitude as decoratorLatitudeValdiation, leapYear as decoratorLeapYearValidation, lessThanEqualTo as decoratorLessThanEqualToValidation, lessThan as decoratorLessThanValidation, longitude as decoratorLongitudeValidation, lowerCase as decoratorLowercaseValidation, ltrim as decoratorLtrimSanitizer, mac as decoratorMacValidation, maxDate as decoratorMaxDateValidation, maxLength as decoratorMaxLengthValidation, maxNumber as decoratorMaxNumberValidation, maxTime as decoratorMaxTimeValidation, minDate as decoratorMinDateValidation, minLength as decoratorMinLengthValidation, minNumber as decoratorMinNumberValidation, minTime as decoratorMinTimeValidation, noneOf as decoratorNoneOfValidation, notEmpty as decoratorNotEmptyValidation, numeric as decoratorNumericValidation, odd as decoratorOddValidation, oneOf as decoratorOneOfValidation, password as decoratorPasswordValdiation, pattern as decoratorPatternValidation, port as decoratorPortValidation, prefix as decoratorPrefixSanitizer, primeNumber as decoratorPrimeNumberValidation, range as decoratorRangeValidation, decoratorRegistrationCaller, requiredTrue as decoratorRequiredTrueValidation, required as decoratorRequiredValidation, rtrim as decoratorRtrimSanitizer, sanitize as decoratorSanitizeSanitizer, startsWith as decoratorStartsWithValidation, stripLow as decoratorStripLowSanitizer, suffix as decoratorSuffixSanitizer, toBoolean as decoratorToBooleanSanitizer, toDate as decoratorToDateSanitizer, toInt as decoratorToIntSanitizer, toString as decoratorToStringSanitizer, trim as decoratorTrimSanitizer, upperCase as decoratorUpperCaseValidation, url as decoratorUrlValidation, whitelist as decoratorWhitelistSanitizer, prop, validationForms };