@decaf-ts/decorator-validation 1.7.6 → 1.7.8
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 +632 -259
- package/dist/decorator-validation.esm.cjs +625 -260
- package/lib/constants/validation.cjs +3 -2
- package/lib/constants/validation.d.ts +1 -0
- package/lib/esm/constants/validation.d.ts +1 -0
- package/lib/esm/constants/validation.js +2 -1
- package/lib/esm/index.d.ts +1 -1
- package/lib/esm/index.js +1 -1
- package/lib/esm/mcp/ModelContextProtocol.d.ts +14 -22
- package/lib/esm/mcp/ModelContextProtocol.js +55 -51
- package/lib/esm/model/Model.d.ts +11 -8
- package/lib/esm/model/Model.js +12 -6
- package/lib/esm/model/decorators.js +1 -1
- package/lib/esm/model/types.d.ts +37 -9
- package/lib/esm/model/types.js +1 -1
- package/lib/esm/model/utils.d.ts +14 -1
- package/lib/esm/model/utils.js +15 -1
- package/lib/esm/model/validation.d.ts +107 -5
- package/lib/esm/model/validation.js +329 -124
- package/lib/esm/types/index.d.ts +1 -0
- package/lib/esm/types/index.js +2 -0
- package/lib/esm/types/validation.d.ts +25 -0
- package/lib/esm/types/validation.js +2 -0
- package/lib/esm/utils/Decoration.js +4 -6
- package/lib/esm/validation/Validators/AsyncValidator.d.ts +72 -0
- package/lib/esm/validation/Validators/AsyncValidator.js +61 -0
- package/lib/esm/validation/Validators/BaseValidator.d.ts +118 -0
- package/lib/esm/validation/Validators/BaseValidator.js +117 -0
- package/lib/esm/validation/Validators/ListValidator.js +2 -2
- package/lib/esm/validation/Validators/MinLengthValidator.d.ts +1 -1
- package/lib/esm/validation/Validators/MinLengthValidator.js +2 -2
- package/lib/esm/validation/Validators/TypeValidator.js +1 -1
- package/lib/esm/validation/Validators/Validator.d.ts +28 -68
- package/lib/esm/validation/Validators/Validator.js +30 -86
- package/lib/esm/validation/Validators/constants.d.ts +12 -11
- package/lib/esm/validation/Validators/constants.js +14 -12
- package/lib/esm/validation/Validators/index.d.ts +1 -0
- package/lib/esm/validation/Validators/index.js +2 -1
- package/lib/esm/validation/decorators.d.ts +2 -1
- package/lib/esm/validation/decorators.js +31 -8
- package/lib/esm/validation/types.d.ts +19 -0
- package/lib/esm/validation/types.js +1 -1
- package/lib/index.cjs +1 -1
- package/lib/index.d.ts +1 -1
- package/lib/mcp/ModelContextProtocol.cjs +55 -51
- package/lib/mcp/ModelContextProtocol.d.ts +14 -22
- package/lib/model/Model.cjs +11 -5
- package/lib/model/Model.d.ts +11 -8
- package/lib/model/decorators.cjs +1 -1
- package/lib/model/types.cjs +1 -1
- package/lib/model/types.d.ts +37 -9
- package/lib/model/utils.cjs +16 -1
- package/lib/model/utils.d.ts +14 -1
- package/lib/model/validation.cjs +334 -125
- package/lib/model/validation.d.ts +107 -5
- package/lib/types/index.cjs +18 -0
- package/lib/types/index.d.ts +1 -0
- package/lib/types/validation.cjs +3 -0
- package/lib/types/validation.d.ts +25 -0
- package/lib/utils/Decoration.cjs +4 -6
- package/lib/validation/Validators/AsyncValidator.cjs +65 -0
- package/lib/validation/Validators/AsyncValidator.d.ts +72 -0
- package/lib/validation/Validators/BaseValidator.cjs +121 -0
- package/lib/validation/Validators/BaseValidator.d.ts +118 -0
- package/lib/validation/Validators/ListValidator.cjs +2 -2
- package/lib/validation/Validators/MinLengthValidator.cjs +2 -2
- package/lib/validation/Validators/MinLengthValidator.d.ts +1 -1
- package/lib/validation/Validators/TypeValidator.cjs +1 -1
- package/lib/validation/Validators/Validator.cjs +30 -86
- package/lib/validation/Validators/Validator.d.ts +28 -68
- package/lib/validation/Validators/constants.cjs +14 -12
- package/lib/validation/Validators/constants.d.ts +12 -11
- package/lib/validation/Validators/index.cjs +2 -1
- package/lib/validation/Validators/index.d.ts +1 -0
- package/lib/validation/decorators.cjs +32 -8
- package/lib/validation/decorators.d.ts +2 -1
- package/lib/validation/types.cjs +1 -1
- package/lib/validation/types.d.ts +19 -0
- package/package.json +1 -1
|
@@ -98,4 +98,4 @@ export function serializedBy(serializer, ...args) {
|
|
|
98
98
|
export function description(description) {
|
|
99
99
|
return metadata(Model.key(ModelKeys.DESCRIPTION), description);
|
|
100
100
|
}
|
|
101
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
101
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGVjb3JhdG9ycy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9tb2RlbC9kZWNvcmF0b3JzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxrQkFBa0IsRUFBRSxTQUFTLEVBQUUsMEJBQXVCO0FBQy9ELE9BQU8sRUFBRSxTQUFTLEVBQUUsZ0NBQTJCO0FBQy9DLE9BQU8sRUFBRSxLQUFLLEVBQUUsbUJBQWdCO0FBQ2hDLE9BQU8sRUFBRSxRQUFRLEVBQUUsTUFBTSxzQkFBc0IsQ0FBQztBQVVoRDs7Ozs7Ozs7Ozs7Ozs7R0FjRztBQUNILE1BQU0sVUFBVSxLQUFLLENBQUMsZ0JBQW1DO0lBQ3ZELE9BQU8sQ0FBQyxDQUFDLFFBQWEsRUFBRSxFQUFFO1FBQ3hCLGdDQUFnQztRQUNoQyxNQUFNLGNBQWMsR0FBUSxVQUFVLEdBQUcsSUFBVztZQUNsRCxNQUFNLFFBQVEsR0FBZ0MsU0FBUyxDQUNyRCxRQUFRLEVBQ1IsR0FBRyxJQUFJLENBQ1IsQ0FBQztZQUNGLGtCQUFrQixDQUFDLFFBQVEsQ0FBQyxDQUFDO1lBQzdCLDJFQUEyRTtZQUMzRSxNQUFNLE9BQU8sR0FBRyxLQUFLLENBQUMsVUFBVSxFQUFFLENBQUM7WUFDbkMsSUFBSSxPQUFPO2dCQUFFLE9BQU8sQ0FBQyxRQUFRLEVBQUUsSUFBSSxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUMsQ0FBQztZQUVsRSxRQUFRLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxTQUFTLENBQUMsS0FBSyxDQUFDLEVBQUUsUUFBUSxDQUFDLElBQUksQ0FBQyxDQUFDLFFBQVEsQ0FBQyxXQUFXLENBQUMsQ0FBQztZQUUxRSxJQUFJLGdCQUFnQjtnQkFBRSxnQkFBZ0IsQ0FBQyxRQUFRLEVBQUUsR0FBRyxJQUFJLENBQUMsQ0FBQztZQUUxRCxPQUFPLFFBQVEsQ0FBQztRQUNsQixDQUFDLENBQUM7UUFFRixvREFBb0Q7UUFDcEQsY0FBYyxDQUFDLFNBQVMsR0FBRyxRQUFRLENBQUMsU0FBUyxDQUFDO1FBRTlDLE9BQU8sQ0FBQyxlQUFlLENBQUMsUUFBUSxDQUFDLENBQUMsT0FBTyxDQUFDLENBQUMsR0FBRyxFQUFFLEVBQUU7WUFDaEQsT0FBTyxDQUFDLGNBQWMsQ0FDcEIsR0FBRyxFQUNILE9BQU8sQ0FBQyxXQUFXLENBQUMsR0FBRyxFQUFFLFFBQVEsQ0FBQyxFQUNsQyxjQUFjLENBQ2YsQ0FBQztRQUNKLENBQUMsQ0FBQyxDQUFDO1FBQ0gseURBQXlEO1FBQ3pELE1BQU0sQ0FBQyxjQUFjLENBQUMsY0FBYyxFQUFFLE1BQU0sRUFBRTtZQUM1QyxRQUFRLEVBQUUsS0FBSztZQUNmLFVBQVUsRUFBRSxJQUFJO1lBQ2hCLFlBQVksRUFBRSxLQUFLO1lBQ25CLEtBQUssRUFBRSxRQUFRLENBQUMsU0FBUyxDQUFDLFdBQVcsQ0FBQyxJQUFJO1NBQzNDLENBQUMsQ0FBQztRQUVILFFBQVEsQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLFNBQVMsQ0FBQyxLQUFLLENBQUMsRUFBRSxRQUFRLENBQUMsSUFBSSxDQUFDLENBQUMsUUFBUSxDQUFDLENBQUM7UUFFOUQsS0FBSyxDQUFDLFFBQVEsQ0FBQyxjQUFjLEVBQUUsUUFBUSxDQUFDLElBQUksQ0FBQyxDQUFDO1FBRTlDLGtEQUFrRDtRQUNsRCxPQUFPLGNBQWMsQ0FBQztJQUN4QixDQUFDLENBQVEsQ0FBQztBQUNaLENBQUM7QUFFRDs7Ozs7Ozs7Ozs7Ozs7R0FjRztBQUNILE1BQU0sVUFBVSxRQUFRLENBQUMsU0FBaUIsRUFBRSxHQUFHLElBQVc7SUFDeEQsT0FBTyxRQUFRLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxTQUFTLENBQUMsT0FBTyxDQUFDLEVBQUU7UUFDNUMsU0FBUyxFQUFFLFNBQVM7UUFDcEIsSUFBSSxFQUFFLElBQUk7S0FDWCxDQUFDLENBQUM7QUFDTCxDQUFDO0FBRUQ7Ozs7Ozs7O0dBUUc7QUFDSCxNQUFNLFVBQVUsWUFBWSxDQUFDLFVBQWtCLEVBQUUsR0FBRyxJQUFXO0lBQzdELE9BQU8sUUFBUSxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQUMsU0FBUyxDQUFDLGFBQWEsQ0FBQyxFQUFFO1FBQ2xELFVBQVUsRUFBRSxVQUFVO1FBQ3RCLElBQUksRUFBRSxJQUFJO0tBQ1gsQ0FBQyxDQUFDO0FBQ0wsQ0FBQztBQUVEOzs7Ozs7OztHQVFHO0FBQ0gsTUFBTSxVQUFVLFdBQVcsQ0FBQyxXQUFtQjtJQUM3QyxPQUFPLFFBQVEsQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLFNBQVMsQ0FBQyxXQUFXLENBQUMsRUFBRSxXQUFXLENBQUMsQ0FBQztBQUNqRSxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgYmluZE1vZGVsUHJvdG90eXBlLCBjb25zdHJ1Y3QgfSBmcm9tIFwiLi9jb25zdHJ1Y3Rpb25cIjtcbmltcG9ydCB7IE1vZGVsS2V5cyB9IGZyb20gXCIuLi91dGlscy9jb25zdGFudHNcIjtcbmltcG9ydCB7IE1vZGVsIH0gZnJvbSBcIi4vTW9kZWxcIjtcbmltcG9ydCB7IG1ldGFkYXRhIH0gZnJvbSBcIkBkZWNhZi10cy9yZWZsZWN0aW9uXCI7XG5cbi8qKlxuICogQHN1bW1hcnkgZGVmaW5lcyB0aGUgdHBlIG9zIGFuIEluc3RhbmNlQ2FsbGJhY2sgZnVuY3Rpb25cbiAqXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmRlY29yYXRvci12YWxpZGF0aW9uXG4gKiBAY2F0ZWdvcnkgTW9kZWxcbiAqL1xuZXhwb3J0IHR5cGUgSW5zdGFuY2VDYWxsYmFjayA9IChpbnN0YW5jZTogYW55LCAuLi5hcmdzOiBhbnlbXSkgPT4gdm9pZDtcblxuLyoqXG4gKiBAc3VtbWFyeSBEZWZpbmVzIGEgY2xhc3MgYXMgYSBNb2RlbCBjbGFzc1xuICogQGRlc2NyaXB0aW9uXG4gKlxuICogLSBSZWdpc3RlcnMgdGhlIGNsYXNzIHVuZGVyIHRoZSBtb2RlbCByZWdpc3RyeSBzbyBpdCBjYW4gYmUgZWFzaWx5IHJlYnVpbHQ7XG4gKiAtIE92ZXJyaWRlcyB0aGUgY2xhc3MgY29uc3RydWN0b3I7XG4gKiAtIFJ1bnMgdGhlIGdsb2JhbCB7QGxpbmsgTW9kZWxCdWlsZGVyRnVuY3Rpb259IGlmIGRlZmluZWQ7XG4gKiAtIFJ1bnMgdGhlIG9wdGlvbmFsIHtAbGluayBJbnN0YW5jZUNhbGxiYWNrfSBpZiBwcm92aWRlZDtcbiAqXG4gKiBAcGFyYW0ge0luc3RhbmNlQ2FsbGJhY2t9IFtpbnN0YW5jZUNhbGxiYWNrXSBvcHRpb25hbCBjYWxsYmFjayB0aGF0IHdpbGwgYmUgY2FsbGVkIHdpdGggdGhlIGluc3RhbmNlIHVwb24gaW5zdGFudGlhdGlvbi4gZGVmYXVsdHMgdG8gdW5kZWZpbmVkXG4gKlxuICogQGZ1bmN0aW9uIG1vZGVsXG4gKlxuICogQGNhdGVnb3J5IENsYXNzIERlY29yYXRvcnNcbiAqL1xuZXhwb3J0IGZ1bmN0aW9uIG1vZGVsKGluc3RhbmNlQ2FsbGJhY2s/OiBJbnN0YW5jZUNhbGxiYWNrKSB7XG4gIHJldHVybiAoKG9yaWdpbmFsOiBhbnkpID0+IHtcbiAgICAvLyB0aGUgbmV3IGNvbnN0cnVjdG9yIGJlaGF2aW91clxuICAgIGNvbnN0IG5ld0NvbnN0cnVjdG9yOiBhbnkgPSBmdW5jdGlvbiAoLi4uYXJnczogYW55W10pIHtcbiAgICAgIGNvbnN0IGluc3RhbmNlOiBSZXR1cm5UeXBlPHR5cGVvZiBvcmlnaW5hbD4gPSBjb25zdHJ1Y3QoXG4gICAgICAgIG9yaWdpbmFsLFxuICAgICAgICAuLi5hcmdzXG4gICAgICApO1xuICAgICAgYmluZE1vZGVsUHJvdG90eXBlKGluc3RhbmNlKTtcbiAgICAgIC8vIHJ1biBhIGJ1aWxkZXIgZnVuY3Rpb24gaWYgZGVmaW5lZCB3aXRoIHRoZSBmaXJzdCBhcmd1bWVudCAoVGhlIE1vZGVsQXJnKVxuICAgICAgY29uc3QgYnVpbGRlciA9IE1vZGVsLmdldEJ1aWxkZXIoKTtcbiAgICAgIGlmIChidWlsZGVyKSBidWlsZGVyKGluc3RhbmNlLCBhcmdzLmxlbmd0aCA/IGFyZ3NbMF0gOiB1bmRlZmluZWQpO1xuXG4gICAgICBtZXRhZGF0YShNb2RlbC5rZXkoTW9kZWxLZXlzLk1PREVMKSwgb3JpZ2luYWwubmFtZSkoaW5zdGFuY2UuY29uc3RydWN0b3IpO1xuXG4gICAgICBpZiAoaW5zdGFuY2VDYWxsYmFjaykgaW5zdGFuY2VDYWxsYmFjayhpbnN0YW5jZSwgLi4uYXJncyk7XG5cbiAgICAgIHJldHVybiBpbnN0YW5jZTtcbiAgICB9O1xuXG4gICAgLy8gY29weSBwcm90b3R5cGUgc28gaW5zdGFuY2VvZiBvcGVyYXRvciBzdGlsbCB3b3Jrc1xuICAgIG5ld0NvbnN0cnVjdG9yLnByb3RvdHlwZSA9IG9yaWdpbmFsLnByb3RvdHlwZTtcblxuICAgIFJlZmxlY3QuZ2V0TWV0YWRhdGFLZXlzKG9yaWdpbmFsKS5mb3JFYWNoKChrZXkpID0+IHtcbiAgICAgIFJlZmxlY3QuZGVmaW5lTWV0YWRhdGEoXG4gICAgICAgIGtleSxcbiAgICAgICAgUmVmbGVjdC5nZXRNZXRhZGF0YShrZXksIG9yaWdpbmFsKSxcbiAgICAgICAgbmV3Q29uc3RydWN0b3JcbiAgICAgICk7XG4gICAgfSk7XG4gICAgLy8gU2V0cyB0aGUgcHJvcGVyIGNvbnN0cnVjdG9yIG5hbWUgZm9yIHR5cGUgdmVyaWZpY2F0aW9uXG4gICAgT2JqZWN0LmRlZmluZVByb3BlcnR5KG5ld0NvbnN0cnVjdG9yLCBcIm5hbWVcIiwge1xuICAgICAgd3JpdGFibGU6IGZhbHNlLFxuICAgICAgZW51bWVyYWJsZTogdHJ1ZSxcbiAgICAgIGNvbmZpZ3VyYWJsZTogZmFsc2UsXG4gICAgICB2YWx1ZTogb3JpZ2luYWwucHJvdG90eXBlLmNvbnN0cnVjdG9yLm5hbWUsXG4gICAgfSk7XG5cbiAgICBtZXRhZGF0YShNb2RlbC5rZXkoTW9kZWxLZXlzLk1PREVMKSwgb3JpZ2luYWwubmFtZSkob3JpZ2luYWwpO1xuXG4gICAgTW9kZWwucmVnaXN0ZXIobmV3Q29uc3RydWN0b3IsIG9yaWdpbmFsLm5hbWUpO1xuXG4gICAgLy8gcmV0dXJuIG5ldyBjb25zdHJ1Y3RvciAod2lsbCBvdmVycmlkZSBvcmlnaW5hbClcbiAgICByZXR1cm4gbmV3Q29uc3RydWN0b3I7XG4gIH0pIGFzIGFueTtcbn1cblxuLyoqXG4gKiBAc3VtbWFyeSBEZWZpbmVzIHRoZSBoYXNoaW5nIGFsZ29yaXRobSB0byB1c2Ugb24gdGhlIG1vZGVsXG4gKiBAZGVzY3JpcHRpb25cbiAqXG4gKiAtIFJlZ2lzdGVycyB0aGUgY2xhc3MgdW5kZXIgdGhlIG1vZGVsIHJlZ2lzdHJ5IHNvIGl0IGNhbiBiZSBlYXNpbHkgcmVidWlsdDtcbiAqIC0gT3ZlcnJpZGVzIHRoZSBjbGFzcyBjb25zdHJ1Y3RvcjtcbiAqIC0gUnVucyB0aGUgZ2xvYmFsIHtAbGluayBNb2RlbEJ1aWxkZXJGdW5jdGlvbn0gaWYgZGVmaW5lZDtcbiAqIC0gUnVucyB0aGUgb3B0aW9uYWwge0BsaW5rIEluc3RhbmNlQ2FsbGJhY2t9IGlmIHByb3ZpZGVkO1xuICpcbiAqIEBwYXJhbSB7c3RyaW5nfSBhbGdvcml0aG0gdGhlIGFsZ29yaXRobSB0byB1c2VcbiAqXG4gKiBAZnVuY3Rpb24gaGFzaGVkQnlcbiAqXG4gKiBAY2F0ZWdvcnkgQ2xhc3MgRGVjb3JhdG9yc1xuICovXG5leHBvcnQgZnVuY3Rpb24gaGFzaGVkQnkoYWxnb3JpdGhtOiBzdHJpbmcsIC4uLmFyZ3M6IGFueVtdKSB7XG4gIHJldHVybiBtZXRhZGF0YShNb2RlbC5rZXkoTW9kZWxLZXlzLkhBU0hJTkcpLCB7XG4gICAgYWxnb3JpdGhtOiBhbGdvcml0aG0sXG4gICAgYXJnczogYXJncyxcbiAgfSk7XG59XG5cbi8qKlxuICogQHN1bW1hcnkgRGVmaW5lcyB0aGUgc2VyaWFsaXphdGlvbiBhbGdvcml0aG0gdG8gdXNlIG9uIHRoZSBtb2RlbFxuICpcbiAqIEBwYXJhbSB7c3RyaW5nfSBzZXJpYWxpemVyIHRoZSBhbGdvcml0aG0gdG8gdXNlXG4gKlxuICogQGZ1bmN0aW9uIHNlcmlhbGl6ZWRCeVxuICpcbiAqIEBjYXRlZ29yeSBDbGFzcyBEZWNvcmF0b3JzXG4gKi9cbmV4cG9ydCBmdW5jdGlvbiBzZXJpYWxpemVkQnkoc2VyaWFsaXplcjogc3RyaW5nLCAuLi5hcmdzOiBhbnlbXSkge1xuICByZXR1cm4gbWV0YWRhdGEoTW9kZWwua2V5KE1vZGVsS2V5cy5TRVJJQUxJWkFUSU9OKSwge1xuICAgIHNlcmlhbGl6ZXI6IHNlcmlhbGl6ZXIsXG4gICAgYXJnczogYXJncyxcbiAgfSk7XG59XG5cbi8qKlxuICogQHN1bW1hcnkgQXBwbGllcyBkZXNjcmlwdGl2ZSBtZXRhZGF0YSB0byBhIGNsYXNzLCBwcm9wZXJ0eSBvciBtZXRob2RcbiAqXG4gKiBAcGFyYW0ge3N0cmluZ30gZGVzY3JpcHRpb24gdGhlIGRlc2NyaXB0aW9uIHRvIGFwcGx5XG4gKlxuICogQGZ1bmN0aW9uIGRlc2NyaXB0aW9uXG4gKlxuICogQGNhdGVnb3J5IERlY29yYXRvcnNcbiAqL1xuZXhwb3J0IGZ1bmN0aW9uIGRlc2NyaXB0aW9uKGRlc2NyaXB0aW9uOiBzdHJpbmcpIHtcbiAgcmV0dXJuIG1ldGFkYXRhKE1vZGVsLmtleShNb2RlbEtleXMuREVTQ1JJUFRJT04pLCBkZXNjcmlwdGlvbik7XG59XG4iXX0=
|
package/lib/esm/model/types.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { ConditionalAsync } from "../types";
|
|
1
2
|
import { ModelErrorDefinition } from "./ModelErrorDefinition";
|
|
2
3
|
import { Model } from "./Model";
|
|
3
4
|
/**
|
|
@@ -46,21 +47,48 @@ export type ModelConstructor<T extends Model> = {
|
|
|
46
47
|
new (model?: ModelArg<T>, ...args: any[]): T;
|
|
47
48
|
};
|
|
48
49
|
/**
|
|
49
|
-
* @description Interface for objects that can be validated
|
|
50
|
-
* @summary Defines the Validation API for
|
|
50
|
+
* @description Interface for objects that can be validated.
|
|
51
|
+
* @summary Defines the Validation API for validation behavior on models, supporting both synchronous and asynchronous validations.
|
|
52
|
+
* Implementers must provide a `hasErrors` method that performs the validation and returns either validation errors or undefined if validation passes.
|
|
53
|
+
*
|
|
54
|
+
* @template Async - A boolean flag indicating whether the validation is asynchronous (`true`) or synchronous (`false`).
|
|
55
|
+
*
|
|
56
|
+
* @param {any[]} [args] - Optional arguments to control validation behavior passed to the validation method.
|
|
57
|
+
*
|
|
51
58
|
* @interface Validatable
|
|
52
|
-
* @memberOf module:decorator-validation
|
|
53
59
|
* @category Model
|
|
60
|
+
* @memberOf module:decorator-validation
|
|
61
|
+
*
|
|
62
|
+
* @example
|
|
63
|
+
* ```typescript
|
|
64
|
+
* // Synchronous validation example
|
|
65
|
+
* class SyncModel implements Validatable<false> {
|
|
66
|
+
* hasErrors(...args: any[]): ModelErrorDefinition | undefined {
|
|
67
|
+
* // perform synchronous validation logic
|
|
68
|
+
* return undefined; // or return errors if invalid
|
|
69
|
+
* }
|
|
70
|
+
* }
|
|
71
|
+
*
|
|
72
|
+
* // Asynchronous validation example
|
|
73
|
+
* class AsyncModel implements Validatable<true> {
|
|
74
|
+
* async hasErrors(...args: any[]): Promise<ModelErrorDefinition | undefined> {
|
|
75
|
+
* // perform asynchronous validation logic
|
|
76
|
+
* return undefined; // or return errors if invalid
|
|
77
|
+
* }
|
|
78
|
+
* }
|
|
79
|
+
* ```
|
|
54
80
|
*/
|
|
55
|
-
export interface Validatable {
|
|
81
|
+
export interface Validatable<Async extends boolean = false> {
|
|
56
82
|
/**
|
|
57
|
-
* @description Validates the object against its validation rules
|
|
58
|
-
* @summary Validates the model and returns the {@link ModelErrorDefinition} if any errors exist
|
|
59
|
-
*
|
|
60
|
-
* @
|
|
83
|
+
* @description Validates the object against its validation rules.
|
|
84
|
+
* @summary Validates the model and returns the {@link ModelErrorDefinition} if any errors exist, or `undefined` if no errors.
|
|
85
|
+
*
|
|
86
|
+
* @param {any[]} [args] - Optional arguments that may influence validation logic.
|
|
87
|
+
* @return {ConditionalAsync<Async, ModelErrorDefinition | undefined>} Validation errors or undefined, conditionally wrapped in a Promise if asynchronous.
|
|
88
|
+
*
|
|
61
89
|
* @method
|
|
62
90
|
*/
|
|
63
|
-
hasErrors(...args: any[]): ModelErrorDefinition | undefined
|
|
91
|
+
hasErrors(...args: any[]): ConditionalAsync<Async, ModelErrorDefinition | undefined>;
|
|
64
92
|
}
|
|
65
93
|
/**
|
|
66
94
|
* @description Interface for objects that can be serialized to string
|
package/lib/esm/model/types.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
export {};
|
|
2
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
2
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvbW9kZWwvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB0eXBlIHsgQ29uZGl0aW9uYWxBc3luYyB9IGZyb20gXCIuLi90eXBlc1wiO1xuaW1wb3J0IHsgTW9kZWxFcnJvckRlZmluaXRpb24gfSBmcm9tIFwiLi9Nb2RlbEVycm9yRGVmaW5pdGlvblwiO1xuaW1wb3J0IHsgTW9kZWwgfSBmcm9tIFwiLi9Nb2RlbFwiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBGdW5jdGlvbiB0eXBlIGZvciBidWlsZGluZyBtb2RlbCBpbnN0YW5jZXMgZnJvbSBvYmplY3RzXG4gKiBAc3VtbWFyeSBUeXBlIGRlZmluaXRpb24gZm9yIGEgbW9kZWwgYnVpbGRlciBmdW5jdGlvbiB0aGF0IHBvcHVsYXRlcyBtb2RlbCBwcm9wZXJ0aWVzXG4gKiBAdGVtcGxhdGUgVFxuICogQHBhcmFtIHtUfSBzZWxmIC0gVGhlIHRhcmdldCBtb2RlbCBpbnN0YW5jZSB0byBwb3B1bGF0ZVxuICogQHBhcmFtIHtUIHwgUmVjb3JkPHN0cmluZywgYW55Pn0gW29ial0gLSBUaGUgc291cmNlIG9iamVjdCBjb250YWluaW5nIHByb3BlcnRpZXMgdG8gY29weVxuICogQHJldHVybiB7VH0gLSBUaGUgcG9wdWxhdGVkIG1vZGVsIGluc3RhbmNlXG4gKiBAdHlwZWRlZiBNb2RlbEJ1aWxkZXJGdW5jdGlvblxuICogQG1lbWJlck9mIG1vZHVsZTpkZWNvcmF0b3ItdmFsaWRhdGlvblxuICovXG5leHBvcnQgdHlwZSBNb2RlbEJ1aWxkZXJGdW5jdGlvbiA9IDxUIGV4dGVuZHMgTW9kZWw+KFxuICBzZWxmOiBULFxuICBvYmo/OiBUIHwgUmVjb3JkPHN0cmluZywgYW55PlxuKSA9PiBUO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBUeXBlIHJlcHJlc2VudGluZyB2YWxpZCBhcmd1bWVudCB0eXBlcyBmb3IgbW9kZWwgY29uc3RydWN0b3JzXG4gKiBAc3VtbWFyeSBEZWZpbml0aW9uIG9mIGEgTW9kZWwgQ29uc3RydWN0b3IgQXJndW1lbnQgdGhhdCBjYW4gYmUgYSBjb21wbGV0ZSBtb2RlbCwgcGFydGlhbCBtb2RlbCwgb3IgcGxhaW4gb2JqZWN0XG4gKiBAdGVtcGxhdGUgVFxuICogQHR5cGVkZWYgTW9kZWxBcmdcbiAqIEBtZW1iZXJPZiBtb2R1bGU6ZGVjb3JhdG9yLXZhbGlkYXRpb25cbiAqIEBzZWUgTW9kZWxDb25zdHJ1Y3RvclxuICovXG5leHBvcnQgdHlwZSBNb2RlbEFyZzxUPiA9IFQgfCBQYXJ0aWFsPFQ+IHwgUmVjb3JkPHN0cmluZywgYW55PjtcblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gR2VuZXJpYyB0eXBlIGZvciBjbGFzcyBjb25zdHJ1Y3RvciBmdW5jdGlvbnNcbiAqIEBzdW1tYXJ5IERlZmluaXRpb24gb2YgYSBDbGFzcyBDb25zdHJ1Y3RvciB0aGF0IGNhbiBjcmVhdGUgaW5zdGFuY2VzIG9mIGEgc3BlY2lmaWVkIHR5cGVcbiAqIEB0ZW1wbGF0ZSBUXG4gKiBAcGFyYW0ge2FueVtdfSBbYXJnc10gLSBDb25zdHJ1Y3RvciBhcmd1bWVudHNcbiAqIEByZXR1cm4ge1R9IC0gQW4gaW5zdGFuY2Ugb2YgdGhlIGNsYXNzXG4gKiBAdHlwZWRlZiBDb25zdHJ1Y3RvclxuICogQG1lbWJlck9mIG1vZHVsZTpkZWNvcmF0b3ItdmFsaWRhdGlvblxuICovXG5leHBvcnQgdHlwZSBDb25zdHJ1Y3RvcjxUPiA9IHtcbiAgbmV3ICguLi5hcmdzOiBhbnlbXSk6IFQ7XG59O1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBTcGVjaWFsaXplZCBjb25zdHJ1Y3RvciB0eXBlIGZvciBNb2RlbCBjbGFzc2VzXG4gKiBAc3VtbWFyeSBEZWZpbml0aW9uIG9mIGEgTW9kZWwgQ29uc3RydWN0b3IgdGhhdCBjcmVhdGVzIGluc3RhbmNlcyBvZiBNb2RlbCBzdWJjbGFzc2VzXG4gKiBAdGVtcGxhdGUgVFxuICogQHBhcmFtIHtNb2RlbEFyZzxUPn0gW21vZGVsXSAtIEluaXRpYWwgZGF0YSB0byBwb3B1bGF0ZSB0aGUgbW9kZWwgd2l0aFxuICogQHBhcmFtIHthbnlbXX0gW2FyZ3NdIC0gQWRkaXRpb25hbCBjb25zdHJ1Y3RvciBhcmd1bWVudHNcbiAqIEByZXR1cm4ge1R9IC0gQW4gaW5zdGFuY2Ugb2YgdGhlIG1vZGVsIGNsYXNzXG4gKiBAdHlwZWRlZiBNb2RlbENvbnN0cnVjdG9yXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmRlY29yYXRvci12YWxpZGF0aW9uXG4gKi9cbmV4cG9ydCB0eXBlIE1vZGVsQ29uc3RydWN0b3I8VCBleHRlbmRzIE1vZGVsPiA9IHtcbiAgbmV3IChtb2RlbD86IE1vZGVsQXJnPFQ+LCAuLi5hcmdzOiBhbnlbXSk6IFQ7XG59O1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBJbnRlcmZhY2UgZm9yIG9iamVjdHMgdGhhdCBjYW4gYmUgdmFsaWRhdGVkLlxuICogQHN1bW1hcnkgRGVmaW5lcyB0aGUgVmFsaWRhdGlvbiBBUEkgZm9yIHZhbGlkYXRpb24gYmVoYXZpb3Igb24gbW9kZWxzLCBzdXBwb3J0aW5nIGJvdGggc3luY2hyb25vdXMgYW5kIGFzeW5jaHJvbm91cyB2YWxpZGF0aW9ucy5cbiAqIEltcGxlbWVudGVycyBtdXN0IHByb3ZpZGUgYSBgaGFzRXJyb3JzYCBtZXRob2QgdGhhdCBwZXJmb3JtcyB0aGUgdmFsaWRhdGlvbiBhbmQgcmV0dXJucyBlaXRoZXIgdmFsaWRhdGlvbiBlcnJvcnMgb3IgdW5kZWZpbmVkIGlmIHZhbGlkYXRpb24gcGFzc2VzLlxuICpcbiAqIEB0ZW1wbGF0ZSBBc3luYyAtIEEgYm9vbGVhbiBmbGFnIGluZGljYXRpbmcgd2hldGhlciB0aGUgdmFsaWRhdGlvbiBpcyBhc3luY2hyb25vdXMgKGB0cnVlYCkgb3Igc3luY2hyb25vdXMgKGBmYWxzZWApLlxuICpcbiAqIEBwYXJhbSB7YW55W119IFthcmdzXSAtIE9wdGlvbmFsIGFyZ3VtZW50cyB0byBjb250cm9sIHZhbGlkYXRpb24gYmVoYXZpb3IgcGFzc2VkIHRvIHRoZSB2YWxpZGF0aW9uIG1ldGhvZC5cbiAqXG4gKiBAaW50ZXJmYWNlIFZhbGlkYXRhYmxlXG4gKiBAY2F0ZWdvcnkgTW9kZWxcbiAqIEBtZW1iZXJPZiBtb2R1bGU6ZGVjb3JhdG9yLXZhbGlkYXRpb25cbiAqXG4gKiBAZXhhbXBsZVxuICogYGBgdHlwZXNjcmlwdFxuICogLy8gU3luY2hyb25vdXMgdmFsaWRhdGlvbiBleGFtcGxlXG4gKiBjbGFzcyBTeW5jTW9kZWwgaW1wbGVtZW50cyBWYWxpZGF0YWJsZTxmYWxzZT4ge1xuICogICBoYXNFcnJvcnMoLi4uYXJnczogYW55W10pOiBNb2RlbEVycm9yRGVmaW5pdGlvbiB8IHVuZGVmaW5lZCB7XG4gKiAgICAgLy8gcGVyZm9ybSBzeW5jaHJvbm91cyB2YWxpZGF0aW9uIGxvZ2ljXG4gKiAgICAgcmV0dXJuIHVuZGVmaW5lZDsgLy8gb3IgcmV0dXJuIGVycm9ycyBpZiBpbnZhbGlkXG4gKiAgIH1cbiAqIH1cbiAqXG4gKiAvLyBBc3luY2hyb25vdXMgdmFsaWRhdGlvbiBleGFtcGxlXG4gKiBjbGFzcyBBc3luY01vZGVsIGltcGxlbWVudHMgVmFsaWRhdGFibGU8dHJ1ZT4ge1xuICogICBhc3luYyBoYXNFcnJvcnMoLi4uYXJnczogYW55W10pOiBQcm9taXNlPE1vZGVsRXJyb3JEZWZpbml0aW9uIHwgdW5kZWZpbmVkPiB7XG4gKiAgICAgLy8gcGVyZm9ybSBhc3luY2hyb25vdXMgdmFsaWRhdGlvbiBsb2dpY1xuICogICAgIHJldHVybiB1bmRlZmluZWQ7IC8vIG9yIHJldHVybiBlcnJvcnMgaWYgaW52YWxpZFxuICogICB9XG4gKiB9XG4gKiBgYGBcbiAqL1xuZXhwb3J0IGludGVyZmFjZSBWYWxpZGF0YWJsZTxBc3luYyBleHRlbmRzIGJvb2xlYW4gPSBmYWxzZT4ge1xuICAvKipcbiAgICogQGRlc2NyaXB0aW9uIFZhbGlkYXRlcyB0aGUgb2JqZWN0IGFnYWluc3QgaXRzIHZhbGlkYXRpb24gcnVsZXMuXG4gICAqIEBzdW1tYXJ5IFZhbGlkYXRlcyB0aGUgbW9kZWwgYW5kIHJldHVybnMgdGhlIHtAbGluayBNb2RlbEVycm9yRGVmaW5pdGlvbn0gaWYgYW55IGVycm9ycyBleGlzdCwgb3IgYHVuZGVmaW5lZGAgaWYgbm8gZXJyb3JzLlxuICAgKlxuICAgKiBAcGFyYW0ge2FueVtdfSBbYXJnc10gLSBPcHRpb25hbCBhcmd1bWVudHMgdGhhdCBtYXkgaW5mbHVlbmNlIHZhbGlkYXRpb24gbG9naWMuXG4gICAqIEByZXR1cm4ge0NvbmRpdGlvbmFsQXN5bmM8QXN5bmMsIE1vZGVsRXJyb3JEZWZpbml0aW9uIHwgdW5kZWZpbmVkPn0gVmFsaWRhdGlvbiBlcnJvcnMgb3IgdW5kZWZpbmVkLCBjb25kaXRpb25hbGx5IHdyYXBwZWQgaW4gYSBQcm9taXNlIGlmIGFzeW5jaHJvbm91cy5cbiAgICpcbiAgICogQG1ldGhvZFxuICAgKi9cbiAgaGFzRXJyb3JzKFxuICAgIC4uLmFyZ3M6IGFueVtdXG4gICk6IENvbmRpdGlvbmFsQXN5bmM8QXN5bmMsIE1vZGVsRXJyb3JEZWZpbml0aW9uIHwgdW5kZWZpbmVkPjtcbn1cblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gSW50ZXJmYWNlIGZvciBvYmplY3RzIHRoYXQgY2FuIGJlIHNlcmlhbGl6ZWQgdG8gc3RyaW5nXG4gKiBAc3VtbWFyeSBEZWZpbmVzIHRoZSBzZXJpYWxpemF0aW9uIEFQSSBmb3IgbW9kZWwgb2JqZWN0c1xuICogQGludGVyZmFjZSBTZXJpYWxpemFibGVcbiAqIEBtZW1iZXJPZiBtb2R1bGU6ZGVjb3JhdG9yLXZhbGlkYXRpb25cbiAqIEBjYXRlZ29yeSBNb2RlbFxuICovXG5leHBvcnQgaW50ZXJmYWNlIFNlcmlhbGl6YWJsZSB7XG4gIC8qKlxuICAgKiBAZGVzY3JpcHRpb24gQ29udmVydHMgdGhlIG9iamVjdCB0byBhIHNlcmlhbGl6ZWQgc3RyaW5nIHJlcHJlc2VudGF0aW9uXG4gICAqIEBzdW1tYXJ5IFNlcmlhbGl6ZXMgdGhlIG1vZGVsIHRvIGEgc3RyaW5nIGZvcm1hdFxuICAgKiBAcmV0dXJuIHtzdHJpbmd9IC0gVGhlIHNlcmlhbGl6ZWQgc3RyaW5nIHJlcHJlc2VudGF0aW9uXG4gICAqIEBtZXRob2RcbiAgICovXG4gIHNlcmlhbGl6ZSgpOiBzdHJpbmc7XG59XG5cbi8qKlxuICogQGRlc2NyaXB0aW9uIEludGVyZmFjZSBmb3Igb2JqZWN0cyB0aGF0IGNhbiBnZW5lcmF0ZSBhIGhhc2ggcmVwcmVzZW50YXRpb25cbiAqIEBzdW1tYXJ5IERlZmluZXMgdGhlIGhhc2hpbmcgQVBJIGZvciBtb2RlbCBvYmplY3RzXG4gKiBAaW50ZXJmYWNlIEhhc2hhYmxlXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmRlY29yYXRvci12YWxpZGF0aW9uXG4gKiBAY2F0ZWdvcnkgTW9kZWxcbiAqL1xuZXhwb3J0IGludGVyZmFjZSBIYXNoYWJsZSB7XG4gIC8qKlxuICAgKiBAZGVzY3JpcHRpb24gR2VuZXJhdGVzIGEgdW5pcXVlIGhhc2ggc3RyaW5nIGZvciB0aGUgb2JqZWN0XG4gICAqIEBzdW1tYXJ5IENyZWF0ZXMgYSBoYXNoIHN0cmluZyByZXByZXNlbnRhdGlvbiBvZiB0aGUgb2JqZWN0XG4gICAqIEByZXR1cm4ge3N0cmluZ30gLSBIYXNoIHZhbHVlIHJlcHJlc2VudGluZyB0aGUgb2JqZWN0XG4gICAqIEBtZXRob2RcbiAgICovXG4gIGhhc2goKTogc3RyaW5nO1xufVxuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBJbnRlcmZhY2UgZm9yIG9iamVjdHMgdGhhdCBjYW4gYmUgY29tcGFyZWQgd2l0aCBvdGhlciBvYmplY3RzXG4gKiBAc3VtbWFyeSBEZWZpbmVzIHRoZSBlcXVhbGl0eSBjb21wYXJpc29uIEFQSSBmb3IgbW9kZWwgb2JqZWN0c1xuICogQHRlbXBsYXRlIFRcbiAqIEBpbnRlcmZhY2UgQ29tcGFyYWJsZVxuICogQG1lbWJlck9mIG1vZHVsZTpkZWNvcmF0b3ItdmFsaWRhdGlvblxuICogQGNhdGVnb3J5IE1vZGVsXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgQ29tcGFyYWJsZTxUPiB7XG4gIC8qKlxuICAgKiBAZGVzY3JpcHRpb24gRGV0ZXJtaW5lcyBpZiB0aGlzIG9iamVjdCBpcyBlcXVhbCB0byBhbm90aGVyIG9iamVjdFxuICAgKiBAc3VtbWFyeSBDb21wYXJlcyB0aGlzIG9iamVjdCB3aXRoIGFub3RoZXIgZm9yIGVxdWFsaXR5XG4gICAqIEBwYXJhbSB7VH0gb3RoZXIgLSBUaGUgb2JqZWN0IHRvIGNvbXBhcmUgd2l0aFxuICAgKiBAcGFyYW0ge2FueVtdfSBbYXJnc10gLSBBZGRpdGlvbmFsIGFyZ3VtZW50cyBmb3IgY29tcGFyaXNvblxuICAgKiBAcmV0dXJuIHtib29sZWFufSAtIFRydWUgaWYgdGhlIG9iamVjdHMgYXJlIGVxdWFsLCBmYWxzZSBvdGhlcndpc2VcbiAgICogQG1ldGhvZFxuICAgKi9cbiAgZXF1YWxzKG90aGVyOiBULCAuLi5hcmdzOiBhbnlbXSk6IGJvb2xlYW47XG59XG4iXX0=
|
package/lib/esm/model/utils.d.ts
CHANGED
|
@@ -1,3 +1,16 @@
|
|
|
1
|
-
import
|
|
1
|
+
import { ConditionalAsync } from "../types";
|
|
2
|
+
import { Model } from "./Model";
|
|
2
3
|
export declare function getModelKey(str: string): string;
|
|
3
4
|
export declare function getMetadata<M extends Model>(model: M): any;
|
|
5
|
+
/**
|
|
6
|
+
* Wraps a value in a Promise if the `async` flag is true.
|
|
7
|
+
*
|
|
8
|
+
* @template T - The type of the value being wrapped.
|
|
9
|
+
* @template Async - A boolean type that determines if the result should be wrapped in a Promise.
|
|
10
|
+
*
|
|
11
|
+
* @param value - The value to return directly or wrap in a Promise.
|
|
12
|
+
* @param async - If true, the value is wrapped in a resolved Promise. If false or undefined, the value is returned as-is.
|
|
13
|
+
*
|
|
14
|
+
* @returns The original value or a Promise resolving to it, depending on the `async` flag.
|
|
15
|
+
*/
|
|
16
|
+
export declare function toConditionalPromise<T, Async extends boolean>(value: T, async?: Async): ConditionalAsync<Async, T>;
|
package/lib/esm/model/utils.js
CHANGED
|
@@ -8,4 +8,18 @@ export function getMetadata(model) {
|
|
|
8
8
|
throw new Error("could not find metadata for provided " + model.constructor.name);
|
|
9
9
|
return metadata;
|
|
10
10
|
}
|
|
11
|
-
|
|
11
|
+
/**
|
|
12
|
+
* Wraps a value in a Promise if the `async` flag is true.
|
|
13
|
+
*
|
|
14
|
+
* @template T - The type of the value being wrapped.
|
|
15
|
+
* @template Async - A boolean type that determines if the result should be wrapped in a Promise.
|
|
16
|
+
*
|
|
17
|
+
* @param value - The value to return directly or wrap in a Promise.
|
|
18
|
+
* @param async - If true, the value is wrapped in a resolved Promise. If false or undefined, the value is returned as-is.
|
|
19
|
+
*
|
|
20
|
+
* @returns The original value or a Promise resolving to it, depending on the `async` flag.
|
|
21
|
+
*/
|
|
22
|
+
export function toConditionalPromise(value, async) {
|
|
23
|
+
return (async ? Promise.resolve(value) : value);
|
|
24
|
+
}
|
|
25
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvbW9kZWwvdXRpbHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLFNBQVMsRUFBRSxnQ0FBMkI7QUFJL0MsTUFBTSxVQUFVLFdBQVcsQ0FBQyxHQUFXO0lBQ3JDLE9BQU8sU0FBUyxDQUFDLE9BQU8sR0FBRyxHQUFHLENBQUM7QUFDakMsQ0FBQztBQUVELE1BQU0sVUFBVSxXQUFXLENBQWtCLEtBQVE7SUFDbkQsTUFBTSxRQUFRLEdBQUcsT0FBTyxDQUFDLFdBQVcsQ0FDbEMsV0FBVyxDQUFDLFNBQVMsQ0FBQyxLQUFLLENBQUMsRUFDNUIsS0FBSyxDQUFDLFdBQVcsQ0FDbEIsQ0FBQztJQUNGLElBQUksQ0FBQyxRQUFRO1FBQ1gsTUFBTSxJQUFJLEtBQUssQ0FDYix1Q0FBdUMsR0FBRyxLQUFLLENBQUMsV0FBVyxDQUFDLElBQUksQ0FDakUsQ0FBQztJQUNKLE9BQU8sUUFBUSxDQUFDO0FBQ2xCLENBQUM7QUFFRDs7Ozs7Ozs7OztHQVVHO0FBQ0gsTUFBTSxVQUFVLG9CQUFvQixDQUNsQyxLQUFRLEVBQ1IsS0FBYTtJQUViLE9BQU8sQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBK0IsQ0FBQztBQUNoRixDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgTW9kZWxLZXlzIH0gZnJvbSBcIi4uL3V0aWxzL2NvbnN0YW50c1wiO1xuaW1wb3J0IHsgQ29uZGl0aW9uYWxBc3luYyB9IGZyb20gXCIuLi90eXBlc1wiO1xuaW1wb3J0IHsgTW9kZWwgfSBmcm9tIFwiLi9Nb2RlbFwiO1xuXG5leHBvcnQgZnVuY3Rpb24gZ2V0TW9kZWxLZXkoc3RyOiBzdHJpbmcpIHtcbiAgcmV0dXJuIE1vZGVsS2V5cy5SRUZMRUNUICsgc3RyO1xufVxuXG5leHBvcnQgZnVuY3Rpb24gZ2V0TWV0YWRhdGE8TSBleHRlbmRzIE1vZGVsPihtb2RlbDogTSkge1xuICBjb25zdCBtZXRhZGF0YSA9IFJlZmxlY3QuZ2V0TWV0YWRhdGEoXG4gICAgZ2V0TW9kZWxLZXkoTW9kZWxLZXlzLk1PREVMKSxcbiAgICBtb2RlbC5jb25zdHJ1Y3RvclxuICApO1xuICBpZiAoIW1ldGFkYXRhKVxuICAgIHRocm93IG5ldyBFcnJvcihcbiAgICAgIFwiY291bGQgbm90IGZpbmQgbWV0YWRhdGEgZm9yIHByb3ZpZGVkIFwiICsgbW9kZWwuY29uc3RydWN0b3IubmFtZVxuICAgICk7XG4gIHJldHVybiBtZXRhZGF0YTtcbn1cblxuLyoqXG4gKiBXcmFwcyBhIHZhbHVlIGluIGEgUHJvbWlzZSBpZiB0aGUgYGFzeW5jYCBmbGFnIGlzIHRydWUuXG4gKlxuICogQHRlbXBsYXRlIFQgLSBUaGUgdHlwZSBvZiB0aGUgdmFsdWUgYmVpbmcgd3JhcHBlZC5cbiAqIEB0ZW1wbGF0ZSBBc3luYyAtIEEgYm9vbGVhbiB0eXBlIHRoYXQgZGV0ZXJtaW5lcyBpZiB0aGUgcmVzdWx0IHNob3VsZCBiZSB3cmFwcGVkIGluIGEgUHJvbWlzZS5cbiAqXG4gKiBAcGFyYW0gdmFsdWUgLSBUaGUgdmFsdWUgdG8gcmV0dXJuIGRpcmVjdGx5IG9yIHdyYXAgaW4gYSBQcm9taXNlLlxuICogQHBhcmFtIGFzeW5jIC0gSWYgdHJ1ZSwgdGhlIHZhbHVlIGlzIHdyYXBwZWQgaW4gYSByZXNvbHZlZCBQcm9taXNlLiBJZiBmYWxzZSBvciB1bmRlZmluZWQsIHRoZSB2YWx1ZSBpcyByZXR1cm5lZCBhcy1pcy5cbiAqXG4gKiBAcmV0dXJucyBUaGUgb3JpZ2luYWwgdmFsdWUgb3IgYSBQcm9taXNlIHJlc29sdmluZyB0byBpdCwgZGVwZW5kaW5nIG9uIHRoZSBgYXN5bmNgIGZsYWcuXG4gKi9cbmV4cG9ydCBmdW5jdGlvbiB0b0NvbmRpdGlvbmFsUHJvbWlzZTxULCBBc3luYyBleHRlbmRzIGJvb2xlYW4+KFxuICB2YWx1ZTogVCxcbiAgYXN5bmM/OiBBc3luY1xuKTogQ29uZGl0aW9uYWxBc3luYzxBc3luYywgVD4ge1xuICByZXR1cm4gKGFzeW5jID8gUHJvbWlzZS5yZXNvbHZlKHZhbHVlKSA6IHZhbHVlKSBhcyBDb25kaXRpb25hbEFzeW5jPEFzeW5jLCBUPjtcbn1cbiJdfQ==
|
|
@@ -1,14 +1,116 @@
|
|
|
1
1
|
import { ModelErrorDefinition } from "./ModelErrorDefinition";
|
|
2
2
|
import { Model } from "./Model";
|
|
3
|
+
import { ValidationPropertyDecoratorDefinition } from "../validation";
|
|
4
|
+
import { ConditionalAsync, DecoratorMetadataAsync } from "../types";
|
|
3
5
|
/**
|
|
4
|
-
*
|
|
6
|
+
* Retrieves the validation metadata decorators associated with a specific property of a model,
|
|
7
|
+
* using the reflective metadata key.
|
|
5
8
|
*
|
|
6
|
-
* @
|
|
7
|
-
* @
|
|
8
|
-
* @
|
|
9
|
+
* @param model - The model instance or class containing the decorated property.
|
|
10
|
+
* @param {string} prop - The name of the property whose decorators should be retrieved.
|
|
11
|
+
* @param {string} reflectKey - The metadata key used to retrieve the decorators.
|
|
12
|
+
* Defaults to `ValidationKeys.REFLECT`.
|
|
9
13
|
*
|
|
14
|
+
* @returns The validation decorators applied to the property
|
|
15
|
+
*/
|
|
16
|
+
export declare function getValidationDecorators(model: Record<string, any>, prop: string, reflectKey?: string): ValidationPropertyDecoratorDefinition;
|
|
17
|
+
/**
|
|
18
|
+
* @description
|
|
19
|
+
* Retrieves all validatable property decorators from a given model, excluding specified properties.
|
|
20
|
+
*
|
|
21
|
+
* @summary
|
|
22
|
+
* Iterates through the own enumerable properties of a model instance, filtering out any properties
|
|
23
|
+
* listed in the `propsToIgnore` array. For each remaining property, it checks whether validation
|
|
24
|
+
* decorators are present using `getValidationDecorators`, and if so, collects them in the result array.
|
|
25
|
+
*
|
|
26
|
+
* @template M - A generic parameter extending the `Model` class, representing the model type being inspected.
|
|
27
|
+
*
|
|
28
|
+
* @param {M} model - An instance of a class extending `Model` from which validatable properties will be extracted.
|
|
29
|
+
* @param {string[]} propsToIgnore - An array of property names that should be excluded from validation inspection.
|
|
30
|
+
*
|
|
31
|
+
* @return {ValidationPropertyDecoratorDefinition[]} An array of validation decorator definitions
|
|
32
|
+
* associated with the model's properties, excluding those listed in `propsToIgnore`.
|
|
33
|
+
*
|
|
34
|
+
* @function getValidatableProperties
|
|
35
|
+
*/
|
|
36
|
+
export declare function getValidatableProperties<M extends Model>(model: M, propsToIgnore: string[]): ValidationPropertyDecoratorDefinition[];
|
|
37
|
+
export declare function validateDecorator<M extends Model, Async extends boolean = false>(model: M, value: any, decorator: DecoratorMetadataAsync, async?: Async): ConditionalAsync<Async, string | undefined>;
|
|
38
|
+
/**
|
|
39
|
+
* @description
|
|
40
|
+
* Executes validation logic for a set of decorators applied to a model's property, handling both
|
|
41
|
+
* synchronous and asynchronous validations, including support for nested validations and lists.
|
|
42
|
+
*
|
|
43
|
+
* @summary
|
|
44
|
+
* Iterates over an array of decorator metadata objects and applies each validation rule to the
|
|
45
|
+
* provided value. For list decorators (`ValidationKeys.LIST`), it performs element-wise validation,
|
|
46
|
+
* supporting nested model validation and type checks. If the `async` flag is set, asynchronous
|
|
47
|
+
* validation is supported using `Promise.all`. The result is a record mapping validation keys to
|
|
48
|
+
* error messages, or `undefined` if no errors are found.
|
|
49
|
+
*
|
|
50
|
+
* @template M - A type parameter extending `Model`, representing the model type being validated.
|
|
51
|
+
* @template Async - A boolean indicating whether validation should be performed asynchronously.
|
|
52
|
+
*
|
|
53
|
+
* @param {M} model - The model instance that the validation is associated with.
|
|
54
|
+
* @param {any} value - The value to be validated against the provided decorators.
|
|
55
|
+
* @param {DecoratorMetadataAsync[]} decorators - An array of metadata objects representing validation decorators.
|
|
56
|
+
* @param {Async} [async] - Optional flag indicating whether validation should be performed asynchronously.
|
|
57
|
+
*
|
|
58
|
+
* @return {ConditionalAsync<Async, Record<string, string>> | undefined}
|
|
59
|
+
* Returns either a record of validation errors (keyed by the decorator key) or `undefined` if no errors are found.
|
|
60
|
+
* If `async` is true, the return value is a Promise resolving to the same structure.
|
|
61
|
+
*
|
|
62
|
+
* @function validateDecorators
|
|
63
|
+
*/
|
|
64
|
+
export declare function validateDecorators<M extends Model, Async extends boolean = false>(model: M, value: any, decorators: DecoratorMetadataAsync[], async?: Async): ConditionalAsync<Async, Record<string, string> | undefined>;
|
|
65
|
+
/**
|
|
10
66
|
* @function validate
|
|
67
|
+
* @template M
|
|
68
|
+
* @template Async
|
|
11
69
|
* @memberOf module:decorator-validation
|
|
12
70
|
* @category Model
|
|
71
|
+
*
|
|
72
|
+
* @description
|
|
73
|
+
* Validates the properties of a {@link Model} instance using registered decorators.
|
|
74
|
+
* Supports both synchronous and asynchronous validation flows, depending on the `async` flag.
|
|
75
|
+
*
|
|
76
|
+
* @summary
|
|
77
|
+
* This function inspects a given model object, identifies decorated properties that require validation,
|
|
78
|
+
* and applies the corresponding validation rules. It also supports nested model validation and gracefully
|
|
79
|
+
* merges any validation errors. For collections (Array/Set), it enforces the presence of the `@list` decorator
|
|
80
|
+
* and checks the type of elements. If a property is a nested model, it will call `hasErrors` on it and flatten
|
|
81
|
+
* the nested error keys using dot notation.
|
|
82
|
+
*
|
|
83
|
+
* @param {M} model - The model instance to be validated. Must extend from {@link Model}.
|
|
84
|
+
* @param {Async} [async] - A flag indicating whether validation should be asynchronous.
|
|
85
|
+
* @param {...string} propsToIgnore - A variadic list of property names that should be skipped during validation.
|
|
86
|
+
*
|
|
87
|
+
* @returns {ConditionalAsync<Async, ModelErrorDefinition | undefined>}
|
|
88
|
+
* Returns either a {@link ModelErrorDefinition} containing validation errors,
|
|
89
|
+
* or `undefined` if no errors are found. When `async` is `true`, returns a Promise.
|
|
90
|
+
*
|
|
91
|
+
* @see {@link Model}
|
|
92
|
+
* @see {@link ModelErrorDefinition}
|
|
93
|
+
* @see {@link validateDecorators}
|
|
94
|
+
* @see {@link getValidatableProperties}
|
|
95
|
+
*
|
|
96
|
+
* @mermaid
|
|
97
|
+
* sequenceDiagram
|
|
98
|
+
* participant Caller
|
|
99
|
+
* participant validate
|
|
100
|
+
* participant getValidatableProperties
|
|
101
|
+
* participant validateDecorators
|
|
102
|
+
* participant ModelInstance
|
|
103
|
+
* Caller->>validate: call with obj, async, propsToIgnore
|
|
104
|
+
* validate->>getValidatableProperties: retrieve decorated props
|
|
105
|
+
* loop for each property
|
|
106
|
+
* validate->>validateDecorators: validate using decorators
|
|
107
|
+
* alt is nested model
|
|
108
|
+
* validate->>ModelInstance: call hasErrors()
|
|
109
|
+
* end
|
|
110
|
+
* end
|
|
111
|
+
* alt async
|
|
112
|
+
* validate->>validate: Promise.allSettled for errors
|
|
113
|
+
* end
|
|
114
|
+
* validate-->>Caller: return ModelErrorDefinition | undefined
|
|
13
115
|
*/
|
|
14
|
-
export declare function validate<M extends Model>(
|
|
116
|
+
export declare function validate<M extends Model<boolean>, Async extends boolean = false>(model: M, async: Async, ...propsToIgnore: string[]): ConditionalAsync<Async, ModelErrorDefinition | undefined>;
|