@decaf-ts/decorator-validation 1.6.2 → 1.6.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/decorator-validation.cjs +1016 -1164
- package/dist/decorator-validation.esm.cjs +971 -1134
- package/lib/constants/index.cjs +18 -0
- package/lib/constants/index.d.ts +1 -0
- package/lib/constants/validation.cjs +14 -0
- package/lib/constants/validation.d.ts +10 -0
- package/lib/esm/constants/index.d.ts +1 -0
- package/lib/esm/constants/index.js +2 -0
- package/lib/esm/constants/validation.d.ts +10 -0
- package/lib/esm/constants/validation.js +11 -0
- package/lib/esm/index.d.ts +37 -5
- package/lib/esm/index.js +38 -6
- package/lib/esm/model/Model.d.ts +29 -100
- package/lib/esm/model/Model.js +37 -104
- package/lib/esm/model/constants.d.ts +3 -3
- package/lib/esm/model/constants.js +4 -4
- package/lib/esm/model/construction.d.ts +3 -3
- package/lib/esm/model/construction.js +4 -4
- package/lib/esm/model/decorators.d.ts +4 -4
- package/lib/esm/model/decorators.js +5 -6
- package/lib/esm/model/types.d.ts +11 -30
- package/lib/esm/model/types.js +1 -1
- package/lib/esm/model/validation.d.ts +2 -2
- package/lib/esm/model/validation.js +18 -7
- package/lib/esm/utils/constants.d.ts +9 -27
- package/lib/esm/utils/constants.js +10 -28
- package/lib/esm/utils/dates.d.ts +16 -26
- package/lib/esm/utils/dates.js +17 -27
- package/lib/esm/utils/decorators.d.ts +0 -41
- package/lib/esm/utils/decorators.js +1 -42
- package/lib/esm/utils/hashing.d.ts +6 -50
- package/lib/esm/utils/hashing.js +5 -49
- package/lib/esm/utils/index.d.ts +0 -1
- package/lib/esm/utils/index.js +1 -2
- package/lib/esm/utils/registry.d.ts +2 -2
- package/lib/esm/utils/registry.js +1 -1
- package/lib/esm/utils/serialization.d.ts +1 -1
- package/lib/esm/utils/serialization.js +2 -2
- package/lib/esm/utils/strings.d.ts +4 -4
- package/lib/esm/utils/strings.js +5 -5
- package/lib/esm/utils/types.d.ts +16 -123
- package/lib/esm/utils/types.js +1 -1
- package/lib/esm/validation/Validators/DateValidator.d.ts +8 -40
- package/lib/esm/validation/Validators/DateValidator.js +9 -41
- package/lib/esm/validation/Validators/DiffValidator.d.ts +27 -0
- package/lib/esm/validation/Validators/DiffValidator.js +58 -0
- package/lib/esm/validation/Validators/EmailValidator.d.ts +7 -39
- package/lib/esm/validation/Validators/EmailValidator.js +8 -40
- package/lib/esm/validation/Validators/EqualsValidator.d.ts +27 -0
- package/lib/esm/validation/Validators/EqualsValidator.js +63 -0
- package/lib/esm/validation/Validators/GreaterThanOrEqualValidator.d.ts +27 -0
- package/lib/esm/validation/Validators/GreaterThanOrEqualValidator.js +65 -0
- package/lib/esm/validation/Validators/GreaterThanValidator.d.ts +27 -0
- package/lib/esm/validation/Validators/GreaterThanValidator.js +62 -0
- package/lib/esm/validation/Validators/LessThanOrEqualValidator.d.ts +27 -0
- package/lib/esm/validation/Validators/LessThanOrEqualValidator.js +65 -0
- package/lib/esm/validation/Validators/LessThanValidator.d.ts +27 -0
- package/lib/esm/validation/Validators/LessThanValidator.js +62 -0
- package/lib/esm/validation/Validators/ListValidator.d.ts +6 -44
- package/lib/esm/validation/Validators/ListValidator.js +7 -45
- package/lib/esm/validation/Validators/MaxValidator.d.ts +6 -52
- package/lib/esm/validation/Validators/MaxValidator.js +7 -53
- package/lib/esm/validation/Validators/MinValidator.d.ts +6 -52
- package/lib/esm/validation/Validators/MinValidator.js +7 -53
- package/lib/esm/validation/Validators/PatternValidator.d.ts +9 -75
- package/lib/esm/validation/Validators/PatternValidator.js +10 -76
- package/lib/esm/validation/Validators/RequiredValidator.d.ts +6 -52
- package/lib/esm/validation/Validators/RequiredValidator.js +7 -53
- package/lib/esm/validation/Validators/TypeValidator.d.ts +6 -60
- package/lib/esm/validation/Validators/TypeValidator.js +7 -69
- package/lib/esm/validation/Validators/URLValidator.d.ts +7 -41
- package/lib/esm/validation/Validators/URLValidator.js +8 -42
- package/lib/esm/validation/Validators/Validator.d.ts +17 -77
- package/lib/esm/validation/Validators/Validator.js +11 -68
- package/lib/esm/validation/Validators/ValidatorRegistry.d.ts +7 -1
- package/lib/esm/validation/Validators/ValidatorRegistry.js +11 -4
- package/lib/esm/validation/Validators/constants.d.ts +41 -0
- package/lib/esm/validation/Validators/constants.js +43 -1
- package/lib/esm/validation/Validators/index.d.ts +7 -0
- package/lib/esm/validation/Validators/index.js +8 -1
- package/lib/esm/validation/Validators/utils.d.ts +52 -0
- package/lib/esm/validation/Validators/utils.js +174 -0
- package/lib/esm/validation/decorators.d.ts +124 -50
- package/lib/esm/validation/decorators.js +173 -102
- package/lib/esm/validation/types.d.ts +31 -146
- package/lib/esm/validation/types.js +1 -1
- package/lib/index.cjs +39 -7
- package/lib/index.d.ts +37 -5
- package/lib/model/Model.cjs +39 -104
- package/lib/model/Model.d.ts +29 -100
- package/lib/model/constants.cjs +4 -4
- package/lib/model/constants.d.ts +3 -3
- package/lib/model/construction.cjs +4 -4
- package/lib/model/construction.d.ts +3 -3
- package/lib/model/decorators.cjs +5 -6
- package/lib/model/decorators.d.ts +4 -4
- package/lib/model/types.cjs +1 -1
- package/lib/model/types.d.ts +11 -30
- package/lib/model/validation.cjs +25 -14
- package/lib/model/validation.d.ts +2 -2
- package/lib/utils/constants.cjs +11 -29
- package/lib/utils/constants.d.ts +9 -27
- package/lib/utils/dates.cjs +17 -27
- package/lib/utils/dates.d.ts +16 -26
- package/lib/utils/decorators.cjs +1 -42
- package/lib/utils/decorators.d.ts +0 -41
- package/lib/utils/hashing.cjs +5 -49
- package/lib/utils/hashing.d.ts +6 -50
- package/lib/utils/index.cjs +1 -2
- package/lib/utils/index.d.ts +0 -1
- package/lib/utils/registry.cjs +1 -1
- package/lib/utils/registry.d.ts +2 -2
- package/lib/utils/serialization.cjs +2 -2
- package/lib/utils/serialization.d.ts +1 -1
- package/lib/utils/strings.cjs +5 -5
- package/lib/utils/strings.d.ts +4 -4
- package/lib/utils/types.cjs +1 -1
- package/lib/utils/types.d.ts +16 -123
- package/lib/validation/Validators/DateValidator.cjs +9 -41
- package/lib/validation/Validators/DateValidator.d.ts +8 -40
- package/lib/validation/Validators/DiffValidator.cjs +61 -0
- package/lib/validation/Validators/DiffValidator.d.ts +27 -0
- package/lib/validation/Validators/EmailValidator.cjs +8 -40
- package/lib/validation/Validators/EmailValidator.d.ts +7 -39
- package/lib/validation/Validators/EqualsValidator.cjs +66 -0
- package/lib/validation/Validators/EqualsValidator.d.ts +27 -0
- package/lib/validation/Validators/GreaterThanOrEqualValidator.cjs +68 -0
- package/lib/validation/Validators/GreaterThanOrEqualValidator.d.ts +27 -0
- package/lib/validation/Validators/GreaterThanValidator.cjs +65 -0
- package/lib/validation/Validators/GreaterThanValidator.d.ts +27 -0
- package/lib/validation/Validators/LessThanOrEqualValidator.cjs +68 -0
- package/lib/validation/Validators/LessThanOrEqualValidator.d.ts +27 -0
- package/lib/validation/Validators/LessThanValidator.cjs +65 -0
- package/lib/validation/Validators/LessThanValidator.d.ts +27 -0
- package/lib/validation/Validators/ListValidator.cjs +7 -45
- package/lib/validation/Validators/ListValidator.d.ts +6 -44
- package/lib/validation/Validators/MaxValidator.cjs +7 -53
- package/lib/validation/Validators/MaxValidator.d.ts +6 -52
- package/lib/validation/Validators/MinValidator.cjs +7 -53
- package/lib/validation/Validators/MinValidator.d.ts +6 -52
- package/lib/validation/Validators/PatternValidator.cjs +10 -76
- package/lib/validation/Validators/PatternValidator.d.ts +9 -75
- package/lib/validation/Validators/RequiredValidator.cjs +7 -53
- package/lib/validation/Validators/RequiredValidator.d.ts +6 -52
- package/lib/validation/Validators/TypeValidator.cjs +7 -69
- package/lib/validation/Validators/TypeValidator.d.ts +6 -60
- package/lib/validation/Validators/URLValidator.cjs +8 -42
- package/lib/validation/Validators/URLValidator.d.ts +7 -41
- package/lib/validation/Validators/Validator.cjs +11 -68
- package/lib/validation/Validators/Validator.d.ts +17 -77
- package/lib/validation/Validators/ValidatorRegistry.cjs +12 -4
- package/lib/validation/Validators/ValidatorRegistry.d.ts +7 -1
- package/lib/validation/Validators/constants.cjs +44 -2
- package/lib/validation/Validators/constants.d.ts +41 -0
- package/lib/validation/Validators/index.cjs +8 -1
- package/lib/validation/Validators/index.d.ts +7 -0
- package/lib/validation/Validators/utils.cjs +180 -0
- package/lib/validation/Validators/utils.d.ts +52 -0
- package/lib/validation/decorators.cjs +179 -102
- package/lib/validation/decorators.d.ts +124 -50
- package/lib/validation/types.cjs +1 -1
- package/lib/validation/types.d.ts +31 -146
- package/package.json +1 -1
- package/lib/esm/utils/Decoration.d.ts +0 -123
- package/lib/esm/utils/Decoration.js +0 -188
- package/lib/utils/Decoration.cjs +0 -192
- package/lib/utils/Decoration.d.ts +0 -123
|
@@ -6,8 +6,8 @@
|
|
|
6
6
|
* @return {string} formatted string
|
|
7
7
|
*
|
|
8
8
|
* @function stringFormat
|
|
9
|
-
* @memberOf module:decorator-validation
|
|
10
|
-
* @category
|
|
9
|
+
* @memberOf module:decorator-validation.Utils.Format
|
|
10
|
+
* @category Format
|
|
11
11
|
*/
|
|
12
12
|
export declare function stringFormat(string: string, ...args: (string | number)[]): string;
|
|
13
13
|
/**
|
|
@@ -19,7 +19,7 @@ export declare function stringFormat(string: string, ...args: (string | number)[
|
|
|
19
19
|
* @return {string} formatted string
|
|
20
20
|
*
|
|
21
21
|
* @function sf
|
|
22
|
-
* @memberOf module:decorator-validation
|
|
23
|
-
* @category
|
|
22
|
+
* @memberOf module:decorator-validation.Utils.Format
|
|
23
|
+
* @category Format
|
|
24
24
|
*/
|
|
25
25
|
export declare const sf: typeof stringFormat;
|
package/lib/esm/utils/strings.js
CHANGED
|
@@ -6,8 +6,8 @@
|
|
|
6
6
|
* @return {string} formatted string
|
|
7
7
|
*
|
|
8
8
|
* @function stringFormat
|
|
9
|
-
* @memberOf module:decorator-validation
|
|
10
|
-
* @category
|
|
9
|
+
* @memberOf module:decorator-validation.Utils.Format
|
|
10
|
+
* @category Format
|
|
11
11
|
*/
|
|
12
12
|
export function stringFormat(string, ...args) {
|
|
13
13
|
return string.replace(/{(\d+)}/g, function (match, number) {
|
|
@@ -25,8 +25,8 @@ export function stringFormat(string, ...args) {
|
|
|
25
25
|
* @return {string} formatted string
|
|
26
26
|
*
|
|
27
27
|
* @function sf
|
|
28
|
-
* @memberOf module:decorator-validation
|
|
29
|
-
* @category
|
|
28
|
+
* @memberOf module:decorator-validation.Utils.Format
|
|
29
|
+
* @category Format
|
|
30
30
|
*/
|
|
31
31
|
export const sf = stringFormat;
|
|
32
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
32
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic3RyaW5ncy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy91dGlscy9zdHJpbmdzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOzs7Ozs7Ozs7O0dBVUc7QUFDSCxNQUFNLFVBQVUsWUFBWSxDQUFDLE1BQWMsRUFBRSxHQUFHLElBQXlCO0lBQ3ZFLE9BQU8sTUFBTSxDQUFDLE9BQU8sQ0FBQyxVQUFVLEVBQUUsVUFBVSxLQUFLLEVBQUUsTUFBTTtRQUN2RCxPQUFPLE9BQU8sSUFBSSxDQUFDLE1BQU0sQ0FBQyxLQUFLLFdBQVc7WUFDeEMsQ0FBQyxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsQ0FBQyxRQUFRLEVBQUU7WUFDekIsQ0FBQyxDQUFDLFdBQVcsQ0FBQztJQUNsQixDQUFDLENBQUMsQ0FBQztBQUNMLENBQUM7QUFFRDs7Ozs7Ozs7Ozs7R0FXRztBQUNILE1BQU0sQ0FBQyxNQUFNLEVBQUUsR0FBRyxZQUFZLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyIvKipcbiAqIEBzdW1tYXJ5IFV0aWwgZnVuY3Rpb24gdG8gcHJvdmlkZSBzdHJpbmcgZm9ybWF0IGZ1bmN0aW9uYWxpdHkgc2ltaWxhciB0byBDIydzIHN0cmluZy5mb3JtYXRcbiAqXG4gKiBAcGFyYW0ge3N0cmluZ30gc3RyaW5nXG4gKiBAcGFyYW0ge0FycmF5PHN0cmluZyB8IG51bWJlcj59IFthcmdzXSByZXBsYWNlbWVudHMgbWFkZSBieSBvcmRlciBvZiBhcHBlYXJhbmNlIChyZXBsYWNlbWVudDAgd2lsIHJlcGxhY2UgezB9IGFuZCBzbyBvbilcbiAqIEByZXR1cm4ge3N0cmluZ30gZm9ybWF0dGVkIHN0cmluZ1xuICpcbiAqIEBmdW5jdGlvbiBzdHJpbmdGb3JtYXRcbiAqIEBtZW1iZXJPZiBtb2R1bGU6ZGVjb3JhdG9yLXZhbGlkYXRpb24uVXRpbHMuRm9ybWF0XG4gKiBAY2F0ZWdvcnkgRm9ybWF0XG4gKi9cbmV4cG9ydCBmdW5jdGlvbiBzdHJpbmdGb3JtYXQoc3RyaW5nOiBzdHJpbmcsIC4uLmFyZ3M6IChzdHJpbmcgfCBudW1iZXIpW10pIHtcbiAgcmV0dXJuIHN0cmluZy5yZXBsYWNlKC97KFxcZCspfS9nLCBmdW5jdGlvbiAobWF0Y2gsIG51bWJlcikge1xuICAgIHJldHVybiB0eXBlb2YgYXJnc1tudW1iZXJdICE9PSBcInVuZGVmaW5lZFwiXG4gICAgICA/IGFyZ3NbbnVtYmVyXS50b1N0cmluZygpXG4gICAgICA6IFwidW5kZWZpbmVkXCI7XG4gIH0pO1xufVxuXG4vKipcbiAqIEBzdW1tYXJ5IFV0aWwgZnVuY3Rpb24gdG8gcHJvdmlkZSBzdHJpbmcgZm9ybWF0IGZ1bmN0aW9uYWxpdHkgc2ltaWxhciB0byBDIydzIHN0cmluZy5mb3JtYXRcbiAqIEBkZXNjcmlwdGlvbiBhbGlhcyBmb3Ige0BsaW5rIHN0cmluZ0Zvcm1hdH1cbiAqXG4gKiBAcGFyYW0ge3N0cmluZ30gc3RyaW5nXG4gKiBAcGFyYW0ge3N0cmluZ30gYXJncyByZXBsYWNlbWVudHMgbWFkZSBieSBvcmRlciBvZiBhcHBlYXJhbmNlIChyZXBsYWNlbWVudDAgd2lsIHJlcGxhY2UgezB9IGFuZCBzbyBvbilcbiAqIEByZXR1cm4ge3N0cmluZ30gZm9ybWF0dGVkIHN0cmluZ1xuICpcbiAqIEBmdW5jdGlvbiBzZlxuICogQG1lbWJlck9mIG1vZHVsZTpkZWNvcmF0b3ItdmFsaWRhdGlvbi5VdGlscy5Gb3JtYXRcbiAqIEBjYXRlZ29yeSBGb3JtYXRcbiAqL1xuZXhwb3J0IGNvbnN0IHNmID0gc3RyaW5nRm9ybWF0O1xuIl19
|
package/lib/esm/utils/types.d.ts
CHANGED
|
@@ -1,136 +1,29 @@
|
|
|
1
1
|
import { Model } from "../model";
|
|
2
2
|
/**
|
|
3
|
-
* @
|
|
4
|
-
* @summary Represents the build stage of the decoration builder, providing the ability to apply
|
|
5
|
-
* the configured decorator to a target. This is the final stage in the builder chain.
|
|
3
|
+
* @summary Helper in serialization
|
|
6
4
|
*
|
|
7
|
-
* @interface
|
|
8
|
-
* @
|
|
9
|
-
* @category Model
|
|
5
|
+
* @interface Serializer
|
|
6
|
+
* @category Serialization
|
|
10
7
|
*/
|
|
11
|
-
export interface
|
|
8
|
+
export interface Serializer<T extends Model> {
|
|
12
9
|
/**
|
|
13
|
-
* @
|
|
14
|
-
* @
|
|
15
|
-
* property, or method.
|
|
10
|
+
* @summary Serializes a model
|
|
11
|
+
* @param {T} model
|
|
16
12
|
*
|
|
17
|
-
* @
|
|
18
|
-
|
|
19
|
-
apply(): (target: object, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;
|
|
20
|
-
}
|
|
21
|
-
/**
|
|
22
|
-
* @description Interface for the extension stage of the decoration builder pattern
|
|
23
|
-
* @summary Represents the extension stage of the decoration builder, providing the ability to add
|
|
24
|
-
* additional decorators to the existing configuration.
|
|
25
|
-
*
|
|
26
|
-
* @interface DecorationBuilderEnd
|
|
27
|
-
* @memberOf module:decorator-validation
|
|
28
|
-
* @category Model
|
|
29
|
-
*/
|
|
30
|
-
export interface DecorationBuilderEnd {
|
|
31
|
-
/**
|
|
32
|
-
* @description Adds additional decorators to the existing configuration
|
|
33
|
-
* @summary Extends the current decorator configuration with additional decorators.
|
|
34
|
-
* This is useful for adding behavior to existing decorators.
|
|
13
|
+
* @param args
|
|
14
|
+
* @method
|
|
35
15
|
*
|
|
36
|
-
* @
|
|
37
|
-
* @returns {DecorationBuilderBuild} The build stage of the builder pattern
|
|
38
|
-
*/
|
|
39
|
-
extend(...decorators: (ClassDecorator | PropertyDecorator | MethodDecorator)[]): DecorationBuilderBuild;
|
|
40
|
-
}
|
|
41
|
-
/**
|
|
42
|
-
* @description Interface for the middle stage of the decoration builder pattern
|
|
43
|
-
* @summary Represents the middle stage of the decoration builder, extending the end stage
|
|
44
|
-
* and providing the ability to define the primary decorators for the configuration.
|
|
45
|
-
*
|
|
46
|
-
* @interface DecorationBuilderMid
|
|
47
|
-
* @memberOf module:decorator-validation
|
|
48
|
-
* @category Model
|
|
49
|
-
*/
|
|
50
|
-
export interface DecorationBuilderMid extends DecorationBuilderEnd {
|
|
51
|
-
/**
|
|
52
|
-
* @description Defines the primary decorators for the configuration
|
|
53
|
-
* @summary Sets the main decorators for the current context. This is typically
|
|
54
|
-
* called after specifying the key with the 'for' method.
|
|
16
|
+
* @throws {Error}
|
|
55
17
|
*/
|
|
56
|
-
|
|
57
|
-
}
|
|
58
|
-
/**
|
|
59
|
-
* @description Interface for the starting stage of the decoration builder pattern
|
|
60
|
-
* @summary Represents the initial stage of the decoration builder, providing the entry point
|
|
61
|
-
* for the builder pattern by specifying the key for the decorator.
|
|
62
|
-
*
|
|
63
|
-
* @interface DecorationBuilderStart
|
|
64
|
-
* @memberOf module:decorator-validation
|
|
65
|
-
* @category Model
|
|
66
|
-
*/
|
|
67
|
-
export interface DecorationBuilderStart {
|
|
18
|
+
serialize(model: T, ...args: any[]): string;
|
|
68
19
|
/**
|
|
69
|
-
* @
|
|
70
|
-
* @
|
|
71
|
-
* the decorator in the decoration registry.
|
|
20
|
+
* @summary Rebuilds a model from serialization
|
|
21
|
+
* @param {string} str
|
|
72
22
|
*
|
|
73
|
-
* @param
|
|
74
|
-
* @
|
|
75
|
-
*/
|
|
76
|
-
for(id: string): DecorationBuilderMid;
|
|
77
|
-
}
|
|
78
|
-
/**
|
|
79
|
-
* @description Comprehensive interface for the complete decoration builder pattern
|
|
80
|
-
* @summary A unified interface that combines all stages of the decoration builder pattern,
|
|
81
|
-
* providing a complete API for creating, configuring, and applying decorators.
|
|
82
|
-
* This interface is implemented by the Decoration class.
|
|
83
|
-
*
|
|
84
|
-
* @interface IDecorationBuilder
|
|
85
|
-
* @memberOf module:decorator-validation
|
|
86
|
-
* @category Model
|
|
87
|
-
*/
|
|
88
|
-
export interface IDecorationBuilder extends DecorationBuilderStart, DecorationBuilderMid, DecorationBuilderEnd, DecorationBuilderBuild {
|
|
89
|
-
}
|
|
90
|
-
/**
|
|
91
|
-
* @description Type definition for a function that resolves the flavour for a target
|
|
92
|
-
* @summary Defines a function type that determines the appropriate flavour for a given target object.
|
|
93
|
-
* This is used by the Decoration class to resolve which flavour of decorator to apply based on the target.
|
|
94
|
-
*
|
|
95
|
-
* @typedef {function(object): string} FlavourResolver
|
|
96
|
-
*
|
|
97
|
-
* @param {object} target - The target object to resolve the flavour for
|
|
98
|
-
* @return {string} The resolved flavour identifier
|
|
99
|
-
* @memberOf module:decorator-validation
|
|
100
|
-
* @category Model
|
|
101
|
-
*/
|
|
102
|
-
export type FlavourResolver = (target: object) => string;
|
|
103
|
-
/**
|
|
104
|
-
* @description Interface for serializing and deserializing model objects
|
|
105
|
-
* @summary Defines the contract for classes that can convert model objects to and from string representations.
|
|
106
|
-
* Serializers are used to persist models or transmit them over networks.
|
|
107
|
-
*
|
|
108
|
-
* @interface Serializer
|
|
109
|
-
* @template T Type of model that can be serialized, must extend Model
|
|
110
|
-
* @memberOf module:decorator-validation
|
|
111
|
-
* @category Model
|
|
112
|
-
*/
|
|
113
|
-
export interface Serializer<M extends Model> {
|
|
114
|
-
/**
|
|
115
|
-
* @description Converts a model object to a string representation
|
|
116
|
-
* @summary Serializes a model instance into a string format that can be stored or transmitted.
|
|
117
|
-
* Additional arguments can be provided to customize the serialization process.
|
|
118
|
-
*
|
|
119
|
-
* @param {T} model - The model instance to serialize
|
|
120
|
-
* @param {...any} args - Additional arguments for the serialization process
|
|
121
|
-
* @return {string} The serialized representation of the model
|
|
122
|
-
* @throws {Error} If the model cannot be serialized
|
|
123
|
-
*/
|
|
124
|
-
serialize(model: M, ...args: any[]): string;
|
|
125
|
-
/**
|
|
126
|
-
* @description Reconstructs a model object from its string representation
|
|
127
|
-
* @summary Deserializes a string back into a model instance.
|
|
128
|
-
* Additional arguments can be provided to customize the deserialization process.
|
|
23
|
+
* @param args
|
|
24
|
+
* @method
|
|
129
25
|
*
|
|
130
|
-
* @
|
|
131
|
-
* @param {...any} args - Additional arguments for the deserialization process
|
|
132
|
-
* @return {T} The reconstructed model instance
|
|
133
|
-
* @throws {Error} If the string cannot be deserialized into a valid model
|
|
26
|
+
* @throws {Error}
|
|
134
27
|
*/
|
|
135
|
-
deserialize(str: string, ...args: any[]):
|
|
28
|
+
deserialize(str: string, ...args: any[]): T;
|
|
136
29
|
}
|
package/lib/esm/utils/types.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
export {};
|
|
2
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
2
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvdXRpbHMvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IE1vZGVsIH0gZnJvbSBcIi4uL21vZGVsXCI7XG5cbi8qKlxuICogQHN1bW1hcnkgSGVscGVyIGluIHNlcmlhbGl6YXRpb25cbiAqXG4gKiBAaW50ZXJmYWNlIFNlcmlhbGl6ZXJcbiAqIEBjYXRlZ29yeSBTZXJpYWxpemF0aW9uXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgU2VyaWFsaXplcjxUIGV4dGVuZHMgTW9kZWw+IHtcbiAgLyoqXG4gICAqIEBzdW1tYXJ5IFNlcmlhbGl6ZXMgYSBtb2RlbFxuICAgKiBAcGFyYW0ge1R9IG1vZGVsXG4gICAqXG4gICAqIEBwYXJhbSBhcmdzXG4gICAqIEBtZXRob2RcbiAgICpcbiAgICogQHRocm93cyB7RXJyb3J9XG4gICAqL1xuICBzZXJpYWxpemUobW9kZWw6IFQsIC4uLmFyZ3M6IGFueVtdKTogc3RyaW5nO1xuXG4gIC8qKlxuICAgKiBAc3VtbWFyeSBSZWJ1aWxkcyBhIG1vZGVsIGZyb20gc2VyaWFsaXphdGlvblxuICAgKiBAcGFyYW0ge3N0cmluZ30gc3RyXG4gICAqXG4gICAqIEBwYXJhbSBhcmdzXG4gICAqIEBtZXRob2RcbiAgICpcbiAgICogQHRocm93cyB7RXJyb3J9XG4gICAqL1xuICBkZXNlcmlhbGl6ZShzdHI6IHN0cmluZywgLi4uYXJnczogYW55W10pOiBUO1xufVxuIl19
|
|
@@ -1,56 +1,24 @@
|
|
|
1
1
|
import { Validator } from "./Validator";
|
|
2
2
|
import { DateValidatorOptions } from "../types";
|
|
3
3
|
/**
|
|
4
|
-
* @
|
|
5
|
-
*
|
|
6
|
-
*
|
|
7
|
-
*
|
|
4
|
+
* @summary Date Validator
|
|
5
|
+
*
|
|
6
|
+
* @param {string} [message] defaults to {@link DEFAULT_ERROR_MESSAGES#DATE}
|
|
7
|
+
*
|
|
8
8
|
* @class DateValidator
|
|
9
9
|
* @extends Validator
|
|
10
10
|
*
|
|
11
11
|
* @category Validators
|
|
12
|
-
* @example
|
|
13
|
-
* ```typescript
|
|
14
|
-
* // Create a date validator with default error message
|
|
15
|
-
* const dateValidator = new DateValidator();
|
|
16
|
-
*
|
|
17
|
-
* // Create a date validator with custom error message
|
|
18
|
-
* const customDateValidator = new DateValidator("Please enter a valid date");
|
|
19
|
-
*
|
|
20
|
-
* // Validate a date
|
|
21
|
-
* const result = dateValidator.hasErrors(new Date()); // undefined (valid)
|
|
22
|
-
* const invalidResult = dateValidator.hasErrors("not a date"); // Returns error message (invalid)
|
|
23
|
-
* ```
|
|
24
|
-
* @mermaid
|
|
25
|
-
* sequenceDiagram
|
|
26
|
-
* participant C as Client
|
|
27
|
-
* participant V as DateValidator
|
|
28
|
-
*
|
|
29
|
-
* C->>V: new DateValidator(message)
|
|
30
|
-
* C->>V: hasErrors(value, options)
|
|
31
|
-
* alt value is undefined
|
|
32
|
-
* V-->>C: undefined (valid)
|
|
33
|
-
* else value is string
|
|
34
|
-
* V->>V: Convert to Date
|
|
35
|
-
* end
|
|
36
|
-
* alt Date is invalid (NaN)
|
|
37
|
-
* V-->>C: Error message
|
|
38
|
-
* else Date is valid
|
|
39
|
-
* V-->>C: undefined (valid)
|
|
40
|
-
* end
|
|
41
12
|
*/
|
|
42
13
|
export declare class DateValidator extends Validator<DateValidatorOptions> {
|
|
43
14
|
constructor(message?: string);
|
|
44
15
|
/**
|
|
45
|
-
* @
|
|
46
|
-
* @summary Validates that the given value is a valid date. If the value is a string,
|
|
47
|
-
* it attempts to convert it to a Date object. Returns an error message if the date is invalid,
|
|
48
|
-
* or undefined if the date is valid or if the value is undefined.
|
|
16
|
+
* @summary Validates a model
|
|
49
17
|
*
|
|
50
|
-
* @param {Date | string} value
|
|
51
|
-
* @param {DateValidatorOptions} [options
|
|
18
|
+
* @param {Date | string} value
|
|
19
|
+
* @param {DateValidatorOptions} [options]
|
|
52
20
|
*
|
|
53
|
-
* @return {string | undefined}
|
|
21
|
+
* @return {string | undefined}
|
|
54
22
|
*
|
|
55
23
|
* @override
|
|
56
24
|
*
|
|
@@ -11,58 +11,26 @@ import { Validator } from "./Validator";
|
|
|
11
11
|
import { DEFAULT_ERROR_MESSAGES, ValidationKeys } from "./constants";
|
|
12
12
|
import { validator } from "./decorators";
|
|
13
13
|
/**
|
|
14
|
-
* @
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
14
|
+
* @summary Date Validator
|
|
15
|
+
*
|
|
16
|
+
* @param {string} [message] defaults to {@link DEFAULT_ERROR_MESSAGES#DATE}
|
|
17
|
+
*
|
|
18
18
|
* @class DateValidator
|
|
19
19
|
* @extends Validator
|
|
20
20
|
*
|
|
21
21
|
* @category Validators
|
|
22
|
-
* @example
|
|
23
|
-
* ```typescript
|
|
24
|
-
* // Create a date validator with default error message
|
|
25
|
-
* const dateValidator = new DateValidator();
|
|
26
|
-
*
|
|
27
|
-
* // Create a date validator with custom error message
|
|
28
|
-
* const customDateValidator = new DateValidator("Please enter a valid date");
|
|
29
|
-
*
|
|
30
|
-
* // Validate a date
|
|
31
|
-
* const result = dateValidator.hasErrors(new Date()); // undefined (valid)
|
|
32
|
-
* const invalidResult = dateValidator.hasErrors("not a date"); // Returns error message (invalid)
|
|
33
|
-
* ```
|
|
34
|
-
* @mermaid
|
|
35
|
-
* sequenceDiagram
|
|
36
|
-
* participant C as Client
|
|
37
|
-
* participant V as DateValidator
|
|
38
|
-
*
|
|
39
|
-
* C->>V: new DateValidator(message)
|
|
40
|
-
* C->>V: hasErrors(value, options)
|
|
41
|
-
* alt value is undefined
|
|
42
|
-
* V-->>C: undefined (valid)
|
|
43
|
-
* else value is string
|
|
44
|
-
* V->>V: Convert to Date
|
|
45
|
-
* end
|
|
46
|
-
* alt Date is invalid (NaN)
|
|
47
|
-
* V-->>C: Error message
|
|
48
|
-
* else Date is valid
|
|
49
|
-
* V-->>C: undefined (valid)
|
|
50
|
-
* end
|
|
51
22
|
*/
|
|
52
23
|
let DateValidator = class DateValidator extends Validator {
|
|
53
24
|
constructor(message = DEFAULT_ERROR_MESSAGES.DATE) {
|
|
54
25
|
super(message, Number.name, Date.name, String.name);
|
|
55
26
|
}
|
|
56
27
|
/**
|
|
57
|
-
* @
|
|
58
|
-
* @summary Validates that the given value is a valid date. If the value is a string,
|
|
59
|
-
* it attempts to convert it to a Date object. Returns an error message if the date is invalid,
|
|
60
|
-
* or undefined if the date is valid or if the value is undefined.
|
|
28
|
+
* @summary Validates a model
|
|
61
29
|
*
|
|
62
|
-
* @param {Date | string} value
|
|
63
|
-
* @param {DateValidatorOptions} [options
|
|
30
|
+
* @param {Date | string} value
|
|
31
|
+
* @param {DateValidatorOptions} [options]
|
|
64
32
|
*
|
|
65
|
-
* @return {string | undefined}
|
|
33
|
+
* @return {string | undefined}
|
|
66
34
|
*
|
|
67
35
|
* @override
|
|
68
36
|
*
|
|
@@ -84,4 +52,4 @@ DateValidator = __decorate([
|
|
|
84
52
|
__metadata("design:paramtypes", [String])
|
|
85
53
|
], DateValidator);
|
|
86
54
|
export { DateValidator };
|
|
87
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
55
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRGF0ZVZhbGlkYXRvci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy92YWxpZGF0aW9uL1ZhbGlkYXRvcnMvRGF0ZVZhbGlkYXRvci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7QUFBQSxPQUFPLEVBQUUsU0FBUyxFQUFFLE1BQU0sYUFBYSxDQUFDO0FBQ3hDLE9BQU8sRUFBRSxzQkFBc0IsRUFBRSxjQUFjLEVBQUUsTUFBTSxhQUFhLENBQUM7QUFDckUsT0FBTyxFQUFFLFNBQVMsRUFBRSxNQUFNLGNBQWMsQ0FBQztBQUd6Qzs7Ozs7Ozs7O0dBU0c7QUFFSSxJQUFNLGFBQWEsR0FBbkIsTUFBTSxhQUFjLFNBQVEsU0FBK0I7SUFDaEUsWUFBWSxVQUFrQixzQkFBc0IsQ0FBQyxJQUFJO1FBQ3ZELEtBQUssQ0FBQyxPQUFPLEVBQUUsTUFBTSxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsSUFBSSxFQUFFLE1BQU0sQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUN0RCxDQUFDO0lBRUQ7Ozs7Ozs7Ozs7O09BV0c7SUFDSSxTQUFTLENBQ2QsS0FBb0IsRUFDcEIsVUFBZ0MsRUFBRTtRQUVsQyxJQUFJLEtBQUssS0FBSyxTQUFTO1lBQUUsT0FBTztRQUVoQyxJQUFJLE9BQU8sS0FBSyxLQUFLLFFBQVE7WUFBRSxLQUFLLEdBQUcsSUFBSSxJQUFJLENBQUMsS0FBSyxDQUFDLENBQUM7UUFFdkQsSUFBSSxNQUFNLENBQUMsS0FBSyxDQUFDLEtBQUssQ0FBQyxPQUFPLEVBQUUsQ0FBQyxFQUFFLENBQUM7WUFDbEMsTUFBTSxFQUFFLE9BQU8sR0FBRyxFQUFFLEVBQUUsR0FBRyxPQUFPLENBQUM7WUFDakMsT0FBTyxJQUFJLENBQUMsVUFBVSxDQUFDLE9BQU8sSUFBSSxJQUFJLENBQUMsT0FBTyxDQUFDLENBQUM7UUFDbEQsQ0FBQztJQUNILENBQUM7Q0FDRixDQUFBO0FBOUJZLGFBQWE7SUFEekIsU0FBUyxDQUFDLGNBQWMsQ0FBQyxJQUFJLENBQUM7O0dBQ2xCLGFBQWEsQ0E4QnpCIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgVmFsaWRhdG9yIH0gZnJvbSBcIi4vVmFsaWRhdG9yXCI7XG5pbXBvcnQgeyBERUZBVUxUX0VSUk9SX01FU1NBR0VTLCBWYWxpZGF0aW9uS2V5cyB9IGZyb20gXCIuL2NvbnN0YW50c1wiO1xuaW1wb3J0IHsgdmFsaWRhdG9yIH0gZnJvbSBcIi4vZGVjb3JhdG9yc1wiO1xuaW1wb3J0IHsgRGF0ZVZhbGlkYXRvck9wdGlvbnMgfSBmcm9tIFwiLi4vdHlwZXNcIjtcblxuLyoqXG4gKiBAc3VtbWFyeSBEYXRlIFZhbGlkYXRvclxuICpcbiAqIEBwYXJhbSB7c3RyaW5nfSBbbWVzc2FnZV0gZGVmYXVsdHMgdG8ge0BsaW5rIERFRkFVTFRfRVJST1JfTUVTU0FHRVMjREFURX1cbiAqXG4gKiBAY2xhc3MgRGF0ZVZhbGlkYXRvclxuICogQGV4dGVuZHMgVmFsaWRhdG9yXG4gKlxuICogQGNhdGVnb3J5IFZhbGlkYXRvcnNcbiAqL1xuQHZhbGlkYXRvcihWYWxpZGF0aW9uS2V5cy5EQVRFKVxuZXhwb3J0IGNsYXNzIERhdGVWYWxpZGF0b3IgZXh0ZW5kcyBWYWxpZGF0b3I8RGF0ZVZhbGlkYXRvck9wdGlvbnM+IHtcbiAgY29uc3RydWN0b3IobWVzc2FnZTogc3RyaW5nID0gREVGQVVMVF9FUlJPUl9NRVNTQUdFUy5EQVRFKSB7XG4gICAgc3VwZXIobWVzc2FnZSwgTnVtYmVyLm5hbWUsIERhdGUubmFtZSwgU3RyaW5nLm5hbWUpO1xuICB9XG5cbiAgLyoqXG4gICAqIEBzdW1tYXJ5IFZhbGlkYXRlcyBhIG1vZGVsXG4gICAqXG4gICAqIEBwYXJhbSB7RGF0ZSB8IHN0cmluZ30gdmFsdWVcbiAgICogQHBhcmFtIHtEYXRlVmFsaWRhdG9yT3B0aW9uc30gW29wdGlvbnNdXG4gICAqXG4gICAqIEByZXR1cm4ge3N0cmluZyB8IHVuZGVmaW5lZH1cbiAgICpcbiAgICogQG92ZXJyaWRlXG4gICAqXG4gICAqIEBzZWUgVmFsaWRhdG9yI2hhc0Vycm9yc1xuICAgKi9cbiAgcHVibGljIGhhc0Vycm9ycyhcbiAgICB2YWx1ZTogRGF0ZSB8IHN0cmluZyxcbiAgICBvcHRpb25zOiBEYXRlVmFsaWRhdG9yT3B0aW9ucyA9IHt9XG4gICk6IHN0cmluZyB8IHVuZGVmaW5lZCB7XG4gICAgaWYgKHZhbHVlID09PSB1bmRlZmluZWQpIHJldHVybjtcblxuICAgIGlmICh0eXBlb2YgdmFsdWUgPT09IFwic3RyaW5nXCIpIHZhbHVlID0gbmV3IERhdGUodmFsdWUpO1xuXG4gICAgaWYgKE51bWJlci5pc05hTih2YWx1ZS5nZXREYXRlKCkpKSB7XG4gICAgICBjb25zdCB7IG1lc3NhZ2UgPSBcIlwiIH0gPSBvcHRpb25zO1xuICAgICAgcmV0dXJuIHRoaXMuZ2V0TWVzc2FnZShtZXNzYWdlIHx8IHRoaXMubWVzc2FnZSk7XG4gICAgfVxuICB9XG59XG4iXX0=
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { Validator } from "./Validator";
|
|
2
|
+
import type { ComparisonValidatorOptions } from "../types";
|
|
3
|
+
/**
|
|
4
|
+
* @summary Diff Validator
|
|
5
|
+
*
|
|
6
|
+
* @param {string} [message] defaults to {@link DEFAULT_ERROR_MESSAGES#DiffValidator}
|
|
7
|
+
*
|
|
8
|
+
* @class DiffValidator
|
|
9
|
+
* @extends Validator
|
|
10
|
+
*
|
|
11
|
+
* @category Validators
|
|
12
|
+
*/
|
|
13
|
+
export declare class DiffValidator extends Validator<ComparisonValidatorOptions> {
|
|
14
|
+
constructor(message?: string);
|
|
15
|
+
/**
|
|
16
|
+
* @summary Validates a model
|
|
17
|
+
*
|
|
18
|
+
* @param {string} value
|
|
19
|
+
* @param {ComparisonValidatorOptions} options
|
|
20
|
+
*
|
|
21
|
+
* @return {string | undefined}
|
|
22
|
+
*
|
|
23
|
+
* @override
|
|
24
|
+
* @see Validator#hasErrors
|
|
25
|
+
*/
|
|
26
|
+
hasErrors(value: any, options: ComparisonValidatorOptions, instance: any): string | undefined;
|
|
27
|
+
}
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
2
|
+
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
3
|
+
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
4
|
+
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
|
|
5
|
+
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
6
|
+
};
|
|
7
|
+
var __metadata = (this && this.__metadata) || function (k, v) {
|
|
8
|
+
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
9
|
+
};
|
|
10
|
+
import { Validator } from "./Validator";
|
|
11
|
+
import { DEFAULT_ERROR_MESSAGES, ValidationKeys } from "./constants";
|
|
12
|
+
import { validator } from "./decorators";
|
|
13
|
+
import { isEqual } from "@decaf-ts/reflection";
|
|
14
|
+
import { getValueByPath } from "./utils";
|
|
15
|
+
/**
|
|
16
|
+
* @summary Diff Validator
|
|
17
|
+
*
|
|
18
|
+
* @param {string} [message] defaults to {@link DEFAULT_ERROR_MESSAGES#DiffValidator}
|
|
19
|
+
*
|
|
20
|
+
* @class DiffValidator
|
|
21
|
+
* @extends Validator
|
|
22
|
+
*
|
|
23
|
+
* @category Validators
|
|
24
|
+
*/
|
|
25
|
+
let DiffValidator = class DiffValidator extends Validator {
|
|
26
|
+
constructor(message = DEFAULT_ERROR_MESSAGES.DIFF) {
|
|
27
|
+
super(message);
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* @summary Validates a model
|
|
31
|
+
*
|
|
32
|
+
* @param {string} value
|
|
33
|
+
* @param {ComparisonValidatorOptions} options
|
|
34
|
+
*
|
|
35
|
+
* @return {string | undefined}
|
|
36
|
+
*
|
|
37
|
+
* @override
|
|
38
|
+
* @see Validator#hasErrors
|
|
39
|
+
*/
|
|
40
|
+
hasErrors(value, options, instance) {
|
|
41
|
+
let comparisonPropertyValue;
|
|
42
|
+
try {
|
|
43
|
+
comparisonPropertyValue = getValueByPath(instance, options.propertyToCompare);
|
|
44
|
+
}
|
|
45
|
+
catch (e) {
|
|
46
|
+
return this.getMessage(e.message || this.message);
|
|
47
|
+
}
|
|
48
|
+
return isEqual(value, comparisonPropertyValue)
|
|
49
|
+
? this.getMessage(options.message || this.message, options.propertyToCompare)
|
|
50
|
+
: undefined;
|
|
51
|
+
}
|
|
52
|
+
};
|
|
53
|
+
DiffValidator = __decorate([
|
|
54
|
+
validator(ValidationKeys.DIFF),
|
|
55
|
+
__metadata("design:paramtypes", [String])
|
|
56
|
+
], DiffValidator);
|
|
57
|
+
export { DiffValidator };
|
|
58
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRGlmZlZhbGlkYXRvci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy92YWxpZGF0aW9uL1ZhbGlkYXRvcnMvRGlmZlZhbGlkYXRvci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7QUFBQSxPQUFPLEVBQUUsU0FBUyxFQUFFLE1BQU0sYUFBYSxDQUFDO0FBQ3hDLE9BQU8sRUFBRSxzQkFBc0IsRUFBRSxjQUFjLEVBQUUsTUFBTSxhQUFhLENBQUM7QUFDckUsT0FBTyxFQUFFLFNBQVMsRUFBRSxNQUFNLGNBQWMsQ0FBQztBQUV6QyxPQUFPLEVBQUUsT0FBTyxFQUFFLE1BQU0sc0JBQXNCLENBQUM7QUFDL0MsT0FBTyxFQUFFLGNBQWMsRUFBRSxNQUFNLFNBQVMsQ0FBQztBQUV6Qzs7Ozs7Ozs7O0dBU0c7QUFFSSxJQUFNLGFBQWEsR0FBbkIsTUFBTSxhQUFjLFNBQVEsU0FBcUM7SUFDdEUsWUFBWSxVQUFrQixzQkFBc0IsQ0FBQyxJQUFJO1FBQ3ZELEtBQUssQ0FBQyxPQUFPLENBQUMsQ0FBQztJQUNqQixDQUFDO0lBRUQ7Ozs7Ozs7Ozs7T0FVRztJQUNJLFNBQVMsQ0FDZCxLQUFVLEVBQ1YsT0FBbUMsRUFDbkMsUUFBYTtRQUViLElBQUksdUJBQTRCLENBQUM7UUFDakMsSUFBSSxDQUFDO1lBQ0gsdUJBQXVCLEdBQUcsY0FBYyxDQUN0QyxRQUFRLEVBQ1IsT0FBTyxDQUFDLGlCQUFpQixDQUMxQixDQUFDO1FBQ0osQ0FBQztRQUFDLE9BQU8sQ0FBTSxFQUFFLENBQUM7WUFDaEIsT0FBTyxJQUFJLENBQUMsVUFBVSxDQUFDLENBQUMsQ0FBQyxPQUFPLElBQUksSUFBSSxDQUFDLE9BQU8sQ0FBQyxDQUFDO1FBQ3BELENBQUM7UUFFRCxPQUFPLE9BQU8sQ0FBQyxLQUFLLEVBQUUsdUJBQXVCLENBQUM7WUFDNUMsQ0FBQyxDQUFDLElBQUksQ0FBQyxVQUFVLENBQ2IsT0FBTyxDQUFDLE9BQU8sSUFBSSxJQUFJLENBQUMsT0FBTyxFQUMvQixPQUFPLENBQUMsaUJBQWlCLENBQzFCO1lBQ0gsQ0FBQyxDQUFDLFNBQVMsQ0FBQztJQUNoQixDQUFDO0NBQ0YsQ0FBQTtBQXRDWSxhQUFhO0lBRHpCLFNBQVMsQ0FBQyxjQUFjLENBQUMsSUFBSSxDQUFDOztHQUNsQixhQUFhLENBc0N6QiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IFZhbGlkYXRvciB9IGZyb20gXCIuL1ZhbGlkYXRvclwiO1xuaW1wb3J0IHsgREVGQVVMVF9FUlJPUl9NRVNTQUdFUywgVmFsaWRhdGlvbktleXMgfSBmcm9tIFwiLi9jb25zdGFudHNcIjtcbmltcG9ydCB7IHZhbGlkYXRvciB9IGZyb20gXCIuL2RlY29yYXRvcnNcIjtcbmltcG9ydCB0eXBlIHsgQ29tcGFyaXNvblZhbGlkYXRvck9wdGlvbnMgfSBmcm9tIFwiLi4vdHlwZXNcIjtcbmltcG9ydCB7IGlzRXF1YWwgfSBmcm9tIFwiQGRlY2FmLXRzL3JlZmxlY3Rpb25cIjtcbmltcG9ydCB7IGdldFZhbHVlQnlQYXRoIH0gZnJvbSBcIi4vdXRpbHNcIjtcblxuLyoqXG4gKiBAc3VtbWFyeSBEaWZmIFZhbGlkYXRvclxuICpcbiAqIEBwYXJhbSB7c3RyaW5nfSBbbWVzc2FnZV0gZGVmYXVsdHMgdG8ge0BsaW5rIERFRkFVTFRfRVJST1JfTUVTU0FHRVMjRGlmZlZhbGlkYXRvcn1cbiAqXG4gKiBAY2xhc3MgRGlmZlZhbGlkYXRvclxuICogQGV4dGVuZHMgVmFsaWRhdG9yXG4gKlxuICogQGNhdGVnb3J5IFZhbGlkYXRvcnNcbiAqL1xuQHZhbGlkYXRvcihWYWxpZGF0aW9uS2V5cy5ESUZGKVxuZXhwb3J0IGNsYXNzIERpZmZWYWxpZGF0b3IgZXh0ZW5kcyBWYWxpZGF0b3I8Q29tcGFyaXNvblZhbGlkYXRvck9wdGlvbnM+IHtcbiAgY29uc3RydWN0b3IobWVzc2FnZTogc3RyaW5nID0gREVGQVVMVF9FUlJPUl9NRVNTQUdFUy5ESUZGKSB7XG4gICAgc3VwZXIobWVzc2FnZSk7XG4gIH1cblxuICAvKipcbiAgICogQHN1bW1hcnkgVmFsaWRhdGVzIGEgbW9kZWxcbiAgICpcbiAgICogQHBhcmFtIHtzdHJpbmd9IHZhbHVlXG4gICAqIEBwYXJhbSB7Q29tcGFyaXNvblZhbGlkYXRvck9wdGlvbnN9IG9wdGlvbnNcbiAgICpcbiAgICogQHJldHVybiB7c3RyaW5nIHwgdW5kZWZpbmVkfVxuICAgKlxuICAgKiBAb3ZlcnJpZGVcbiAgICogQHNlZSBWYWxpZGF0b3IjaGFzRXJyb3JzXG4gICAqL1xuICBwdWJsaWMgaGFzRXJyb3JzKFxuICAgIHZhbHVlOiBhbnksXG4gICAgb3B0aW9uczogQ29tcGFyaXNvblZhbGlkYXRvck9wdGlvbnMsXG4gICAgaW5zdGFuY2U6IGFueVxuICApOiBzdHJpbmcgfCB1bmRlZmluZWQge1xuICAgIGxldCBjb21wYXJpc29uUHJvcGVydHlWYWx1ZTogYW55O1xuICAgIHRyeSB7XG4gICAgICBjb21wYXJpc29uUHJvcGVydHlWYWx1ZSA9IGdldFZhbHVlQnlQYXRoKFxuICAgICAgICBpbnN0YW5jZSxcbiAgICAgICAgb3B0aW9ucy5wcm9wZXJ0eVRvQ29tcGFyZVxuICAgICAgKTtcbiAgICB9IGNhdGNoIChlOiBhbnkpIHtcbiAgICAgIHJldHVybiB0aGlzLmdldE1lc3NhZ2UoZS5tZXNzYWdlIHx8IHRoaXMubWVzc2FnZSk7XG4gICAgfVxuXG4gICAgcmV0dXJuIGlzRXF1YWwodmFsdWUsIGNvbXBhcmlzb25Qcm9wZXJ0eVZhbHVlKVxuICAgICAgPyB0aGlzLmdldE1lc3NhZ2UoXG4gICAgICAgICAgb3B0aW9ucy5tZXNzYWdlIHx8IHRoaXMubWVzc2FnZSxcbiAgICAgICAgICBvcHRpb25zLnByb3BlcnR5VG9Db21wYXJlXG4gICAgICAgIClcbiAgICAgIDogdW5kZWZpbmVkO1xuICB9XG59XG4iXX0=
|
|
@@ -1,60 +1,28 @@
|
|
|
1
1
|
import { PatternValidator } from "./PatternValidator";
|
|
2
2
|
import { PatternValidatorOptions } from "../types";
|
|
3
3
|
/**
|
|
4
|
-
* @
|
|
5
|
-
* @summary The EmailValidator checks if a string matches a standard email address pattern.
|
|
6
|
-
* It extends the PatternValidator and uses a predefined email regex pattern to validate email addresses.
|
|
7
|
-
* This validator is typically used with the @email decorator.
|
|
4
|
+
* @summary Email Validator
|
|
8
5
|
*
|
|
9
|
-
* @param {string} [message]
|
|
6
|
+
* @param {string} [message] defaults to {@link DEFAULT_ERROR_MESSAGES#EMAIL}
|
|
10
7
|
*
|
|
11
8
|
* @class EmailValidator
|
|
12
9
|
* @extends PatternValidator
|
|
13
10
|
*
|
|
14
|
-
* @example
|
|
15
|
-
* ```typescript
|
|
16
|
-
* // Create an email validator with default error message
|
|
17
|
-
* const emailValidator = new EmailValidator();
|
|
18
|
-
*
|
|
19
|
-
* // Create an email validator with custom error message
|
|
20
|
-
* const customEmailValidator = new EmailValidator("Please enter a valid email address");
|
|
21
|
-
*
|
|
22
|
-
* // Validate an email
|
|
23
|
-
* const result = emailValidator.hasErrors("user@example.com"); // undefined (valid)
|
|
24
|
-
* const invalidResult = emailValidator.hasErrors("invalid-email"); // Returns error message (invalid)
|
|
25
|
-
* ```
|
|
26
|
-
*
|
|
27
|
-
* @mermaid
|
|
28
|
-
* sequenceDiagram
|
|
29
|
-
* participant C as Client
|
|
30
|
-
* participant E as EmailValidator
|
|
31
|
-
* participant P as PatternValidator
|
|
32
|
-
*
|
|
33
|
-
* C->>E: new EmailValidator(message)
|
|
34
|
-
* E->>P: super(message)
|
|
35
|
-
* C->>E: hasErrors(value, options)
|
|
36
|
-
* E->>P: super.hasErrors(value, options with EMAIL pattern)
|
|
37
|
-
* P-->>E: validation result
|
|
38
|
-
* E-->>C: validation result
|
|
39
|
-
*
|
|
40
11
|
* @category Validators
|
|
41
12
|
*/
|
|
42
13
|
export declare class EmailValidator extends PatternValidator {
|
|
43
14
|
constructor(message?: string);
|
|
44
15
|
/**
|
|
45
|
-
* @
|
|
46
|
-
* @summary Validates that the provided string matches the email pattern.
|
|
47
|
-
* This method extends the PatternValidator's hasErrors method by ensuring
|
|
48
|
-
* the email pattern is used, even if not explicitly provided in the options.
|
|
16
|
+
* @summary Validates a model
|
|
49
17
|
*
|
|
50
|
-
* @param {string} value
|
|
51
|
-
* @param {PatternValidatorOptions} [options
|
|
18
|
+
* @param {string} value
|
|
19
|
+
* @param {PatternValidatorOptions} [options]
|
|
52
20
|
*
|
|
53
|
-
* @return {string | undefined}
|
|
21
|
+
* @return {string | undefined}
|
|
54
22
|
*
|
|
55
23
|
* @override
|
|
56
24
|
*
|
|
57
|
-
* @see
|
|
25
|
+
* @see Validator#hasErrors
|
|
58
26
|
*/
|
|
59
27
|
hasErrors(value: string, options?: PatternValidatorOptions): string | undefined;
|
|
60
28
|
}
|
|
@@ -11,42 +11,13 @@ import { DEFAULT_ERROR_MESSAGES, DEFAULT_PATTERNS, ValidationKeys, } from "./con
|
|
|
11
11
|
import { PatternValidator } from "./PatternValidator";
|
|
12
12
|
import { validator } from "./decorators";
|
|
13
13
|
/**
|
|
14
|
-
* @
|
|
15
|
-
* @summary The EmailValidator checks if a string matches a standard email address pattern.
|
|
16
|
-
* It extends the PatternValidator and uses a predefined email regex pattern to validate email addresses.
|
|
17
|
-
* This validator is typically used with the @email decorator.
|
|
14
|
+
* @summary Email Validator
|
|
18
15
|
*
|
|
19
|
-
* @param {string} [message]
|
|
16
|
+
* @param {string} [message] defaults to {@link DEFAULT_ERROR_MESSAGES#EMAIL}
|
|
20
17
|
*
|
|
21
18
|
* @class EmailValidator
|
|
22
19
|
* @extends PatternValidator
|
|
23
20
|
*
|
|
24
|
-
* @example
|
|
25
|
-
* ```typescript
|
|
26
|
-
* // Create an email validator with default error message
|
|
27
|
-
* const emailValidator = new EmailValidator();
|
|
28
|
-
*
|
|
29
|
-
* // Create an email validator with custom error message
|
|
30
|
-
* const customEmailValidator = new EmailValidator("Please enter a valid email address");
|
|
31
|
-
*
|
|
32
|
-
* // Validate an email
|
|
33
|
-
* const result = emailValidator.hasErrors("user@example.com"); // undefined (valid)
|
|
34
|
-
* const invalidResult = emailValidator.hasErrors("invalid-email"); // Returns error message (invalid)
|
|
35
|
-
* ```
|
|
36
|
-
*
|
|
37
|
-
* @mermaid
|
|
38
|
-
* sequenceDiagram
|
|
39
|
-
* participant C as Client
|
|
40
|
-
* participant E as EmailValidator
|
|
41
|
-
* participant P as PatternValidator
|
|
42
|
-
*
|
|
43
|
-
* C->>E: new EmailValidator(message)
|
|
44
|
-
* E->>P: super(message)
|
|
45
|
-
* C->>E: hasErrors(value, options)
|
|
46
|
-
* E->>P: super.hasErrors(value, options with EMAIL pattern)
|
|
47
|
-
* P-->>E: validation result
|
|
48
|
-
* E-->>C: validation result
|
|
49
|
-
*
|
|
50
21
|
* @category Validators
|
|
51
22
|
*/
|
|
52
23
|
let EmailValidator = class EmailValidator extends PatternValidator {
|
|
@@ -54,19 +25,16 @@ let EmailValidator = class EmailValidator extends PatternValidator {
|
|
|
54
25
|
super(message);
|
|
55
26
|
}
|
|
56
27
|
/**
|
|
57
|
-
* @
|
|
58
|
-
* @summary Validates that the provided string matches the email pattern.
|
|
59
|
-
* This method extends the PatternValidator's hasErrors method by ensuring
|
|
60
|
-
* the email pattern is used, even if not explicitly provided in the options.
|
|
28
|
+
* @summary Validates a model
|
|
61
29
|
*
|
|
62
|
-
* @param {string} value
|
|
63
|
-
* @param {PatternValidatorOptions} [options
|
|
30
|
+
* @param {string} value
|
|
31
|
+
* @param {PatternValidatorOptions} [options]
|
|
64
32
|
*
|
|
65
|
-
* @return {string | undefined}
|
|
33
|
+
* @return {string | undefined}
|
|
66
34
|
*
|
|
67
35
|
* @override
|
|
68
36
|
*
|
|
69
|
-
* @see
|
|
37
|
+
* @see Validator#hasErrors
|
|
70
38
|
*/
|
|
71
39
|
hasErrors(value, options = {}) {
|
|
72
40
|
return super.hasErrors(value, {
|
|
@@ -80,4 +48,4 @@ EmailValidator = __decorate([
|
|
|
80
48
|
__metadata("design:paramtypes", [String])
|
|
81
49
|
], EmailValidator);
|
|
82
50
|
export { EmailValidator };
|
|
83
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
51
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRW1haWxWYWxpZGF0b3IuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvdmFsaWRhdGlvbi9WYWxpZGF0b3JzL0VtYWlsVmFsaWRhdG9yLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7OztBQUFBLE9BQU8sRUFDTCxzQkFBc0IsRUFDdEIsZ0JBQWdCLEVBQ2hCLGNBQWMsR0FDZixNQUFNLGFBQWEsQ0FBQztBQUNyQixPQUFPLEVBQUUsZ0JBQWdCLEVBQUUsTUFBTSxvQkFBb0IsQ0FBQztBQUN0RCxPQUFPLEVBQUUsU0FBUyxFQUFFLE1BQU0sY0FBYyxDQUFDO0FBR3pDOzs7Ozs7Ozs7R0FTRztBQUVJLElBQU0sY0FBYyxHQUFwQixNQUFNLGNBQWUsU0FBUSxnQkFBZ0I7SUFDbEQsWUFBWSxVQUFrQixzQkFBc0IsQ0FBQyxLQUFLO1FBQ3hELEtBQUssQ0FBQyxPQUFPLENBQUMsQ0FBQztJQUNqQixDQUFDO0lBRUQ7Ozs7Ozs7Ozs7O09BV0c7SUFDSSxTQUFTLENBQ2QsS0FBYSxFQUNiLFVBQW1DLEVBQUU7UUFFckMsT0FBTyxLQUFLLENBQUMsU0FBUyxDQUFDLEtBQUssRUFBRTtZQUM1QixHQUFHLE9BQU87WUFDVixPQUFPLEVBQUUsT0FBTyxFQUFFLE9BQU8sSUFBSSxnQkFBZ0IsQ0FBQyxLQUFLO1NBQ3BELENBQUMsQ0FBQztJQUNMLENBQUM7Q0FDRixDQUFBO0FBMUJZLGNBQWM7SUFEMUIsU0FBUyxDQUFDLGNBQWMsQ0FBQyxLQUFLLENBQUM7O0dBQ25CLGNBQWMsQ0EwQjFCIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHtcbiAgREVGQVVMVF9FUlJPUl9NRVNTQUdFUyxcbiAgREVGQVVMVF9QQVRURVJOUyxcbiAgVmFsaWRhdGlvbktleXMsXG59IGZyb20gXCIuL2NvbnN0YW50c1wiO1xuaW1wb3J0IHsgUGF0dGVyblZhbGlkYXRvciB9IGZyb20gXCIuL1BhdHRlcm5WYWxpZGF0b3JcIjtcbmltcG9ydCB7IHZhbGlkYXRvciB9IGZyb20gXCIuL2RlY29yYXRvcnNcIjtcbmltcG9ydCB7IFBhdHRlcm5WYWxpZGF0b3JPcHRpb25zIH0gZnJvbSBcIi4uL3R5cGVzXCI7XG5cbi8qKlxuICogQHN1bW1hcnkgRW1haWwgVmFsaWRhdG9yXG4gKlxuICogQHBhcmFtIHtzdHJpbmd9IFttZXNzYWdlXSBkZWZhdWx0cyB0byB7QGxpbmsgREVGQVVMVF9FUlJPUl9NRVNTQUdFUyNFTUFJTH1cbiAqXG4gKiBAY2xhc3MgRW1haWxWYWxpZGF0b3JcbiAqIEBleHRlbmRzIFBhdHRlcm5WYWxpZGF0b3JcbiAqXG4gKiBAY2F0ZWdvcnkgVmFsaWRhdG9yc1xuICovXG5AdmFsaWRhdG9yKFZhbGlkYXRpb25LZXlzLkVNQUlMKVxuZXhwb3J0IGNsYXNzIEVtYWlsVmFsaWRhdG9yIGV4dGVuZHMgUGF0dGVyblZhbGlkYXRvciB7XG4gIGNvbnN0cnVjdG9yKG1lc3NhZ2U6IHN0cmluZyA9IERFRkFVTFRfRVJST1JfTUVTU0FHRVMuRU1BSUwpIHtcbiAgICBzdXBlcihtZXNzYWdlKTtcbiAgfVxuXG4gIC8qKlxuICAgKiBAc3VtbWFyeSBWYWxpZGF0ZXMgYSBtb2RlbFxuICAgKlxuICAgKiBAcGFyYW0ge3N0cmluZ30gdmFsdWVcbiAgICogQHBhcmFtIHtQYXR0ZXJuVmFsaWRhdG9yT3B0aW9uc30gW29wdGlvbnNdXG4gICAqXG4gICAqIEByZXR1cm4ge3N0cmluZyB8IHVuZGVmaW5lZH1cbiAgICpcbiAgICogQG92ZXJyaWRlXG4gICAqXG4gICAqIEBzZWUgVmFsaWRhdG9yI2hhc0Vycm9yc1xuICAgKi9cbiAgcHVibGljIGhhc0Vycm9ycyhcbiAgICB2YWx1ZTogc3RyaW5nLFxuICAgIG9wdGlvbnM6IFBhdHRlcm5WYWxpZGF0b3JPcHRpb25zID0ge31cbiAgKTogc3RyaW5nIHwgdW5kZWZpbmVkIHtcbiAgICByZXR1cm4gc3VwZXIuaGFzRXJyb3JzKHZhbHVlLCB7XG4gICAgICAuLi5vcHRpb25zLFxuICAgICAgcGF0dGVybjogb3B0aW9ucz8ucGF0dGVybiB8fCBERUZBVUxUX1BBVFRFUk5TLkVNQUlMLFxuICAgIH0pO1xuICB9XG59XG4iXX0=
|