@decaf-ts/db-decorators
Version:
Agnostic database decorators and repository
78 lines • 8.61 kB
JavaScript
;
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
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;
return c > 3 && r && Object.defineProperty(target, key, r), r;
};
var __metadata = (this && this.__metadata) || function (k, v) {
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.ReadOnlyValidator = void 0;
const decorator_validation_1 = require("@decaf-ts/decorator-validation");
const constants_1 = require("./../constants.cjs");
const reflection_1 = require("@decaf-ts/reflection");
/**
* @description A validator that ensures properties marked as readonly cannot be modified during updates.
* @summary Validator for the {@link readonly} decorator that checks if a value has been changed during an update operation. It compares the new value with the old value and returns an error message if they are not equal.
* @param {any} value - The value to be validated
* @param {any} oldValue - The previous value to compare against
* @param {string} [message] - Optional custom error message
* @class ReadOnlyValidator
* @example
* // Using ReadOnlyValidator with a readonly property
* class User {
* @readonly()
* id: string;
*
* name: string;
*
* constructor(id: string, name: string) {
* this.id = id;
* this.name = name;
* }
* }
*
* // This will trigger validation error when trying to update
* const user = new User('123', 'John');
* user.id = '456'; // Will be prevented by ReadOnlyValidator
* @category Validators
*/
let ReadOnlyValidator = class ReadOnlyValidator extends decorator_validation_1.Validator {
constructor() {
super(constants_1.DEFAULT_ERROR_MESSAGES.READONLY.INVALID);
}
/**
* @description Implementation of the base validator's hasErrors method.
* @summary This method is required by the Validator interface but not used in this validator as validation only happens during updates.
* @param {any} value - The value to validate
* @param {any[]} args - Additional arguments
* @return {string | undefined} Always returns undefined as this validator only works during updates
*/
// eslint-disable-next-line @typescript-eslint/no-unused-vars
hasErrors(value, ...args) {
return undefined;
}
/**
* @description Checks if a value has been modified during an update operation.
* @summary Validates a value has not changed by comparing it with the previous value using deep equality.
* @param {any} value - The new value to validate
* @param {any} oldValue - The original value to compare against
* @param {string} [message] - Optional custom error message to override the default
* @return {string | undefined} An error message if validation fails, undefined otherwise
*/
updateHasErrors(value, oldValue, message) {
if (value === undefined)
return;
return (0, reflection_1.isEqual)(value, oldValue)
? undefined
: this.getMessage(message || this.message);
}
};
exports.ReadOnlyValidator = ReadOnlyValidator;
exports.ReadOnlyValidator = ReadOnlyValidator = __decorate([
(0, decorator_validation_1.validator)(constants_1.UpdateValidationKeys.READONLY),
__metadata("design:paramtypes", [])
], ReadOnlyValidator);
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUmVhZE9ubHlWYWxpZGF0b3IuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvdmFsaWRhdGlvbi92YWxpZGF0b3JzL1JlYWRPbmx5VmFsaWRhdG9yLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7OztBQUFBLHlFQUFzRTtBQUN0RSxrREFBNEU7QUFDNUUscURBQStDO0FBRS9DOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0dBeUJHO0FBRUksSUFBTSxpQkFBaUIsR0FBdkIsTUFBTSxpQkFBa0IsU0FBUSxnQ0FBUztJQUM5QztRQUNFLEtBQUssQ0FBQyxrQ0FBc0IsQ0FBQyxRQUFRLENBQUMsT0FBTyxDQUFDLENBQUM7SUFDakQsQ0FBQztJQUVEOzs7Ozs7T0FNRztJQUNILDZEQUE2RDtJQUM3RCxTQUFTLENBQUMsS0FBVSxFQUFFLEdBQUcsSUFBVztRQUNsQyxPQUFPLFNBQVMsQ0FBQztJQUNuQixDQUFDO0lBRUQ7Ozs7Ozs7T0FPRztJQUNJLGVBQWUsQ0FDcEIsS0FBVSxFQUNWLFFBQWEsRUFDYixPQUFnQjtRQUVoQixJQUFJLEtBQUssS0FBSyxTQUFTO1lBQUUsT0FBTztRQUVoQyxPQUFPLElBQUEsb0JBQU8sRUFBQyxLQUFLLEVBQUUsUUFBUSxDQUFDO1lBQzdCLENBQUMsQ0FBQyxTQUFTO1lBQ1gsQ0FBQyxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsT0FBTyxJQUFJLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQztJQUMvQyxDQUFDO0NBQ0YsQ0FBQTtBQXBDWSw4Q0FBaUI7NEJBQWpCLGlCQUFpQjtJQUQ3QixJQUFBLGdDQUFTLEVBQUMsZ0NBQW9CLENBQUMsUUFBUSxDQUFDOztHQUM1QixpQkFBaUIsQ0FvQzdCIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgdmFsaWRhdG9yLCBWYWxpZGF0b3IgfSBmcm9tIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCI7XG5pbXBvcnQgeyBERUZBVUxUX0VSUk9SX01FU1NBR0VTLCBVcGRhdGVWYWxpZGF0aW9uS2V5cyB9IGZyb20gXCIuLi9jb25zdGFudHNcIjtcbmltcG9ydCB7IGlzRXF1YWwgfSBmcm9tIFwiQGRlY2FmLXRzL3JlZmxlY3Rpb25cIjtcblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gQSB2YWxpZGF0b3IgdGhhdCBlbnN1cmVzIHByb3BlcnRpZXMgbWFya2VkIGFzIHJlYWRvbmx5IGNhbm5vdCBiZSBtb2RpZmllZCBkdXJpbmcgdXBkYXRlcy5cbiAqIEBzdW1tYXJ5IFZhbGlkYXRvciBmb3IgdGhlIHtAbGluayByZWFkb25seX0gZGVjb3JhdG9yIHRoYXQgY2hlY2tzIGlmIGEgdmFsdWUgaGFzIGJlZW4gY2hhbmdlZCBkdXJpbmcgYW4gdXBkYXRlIG9wZXJhdGlvbi4gSXQgY29tcGFyZXMgdGhlIG5ldyB2YWx1ZSB3aXRoIHRoZSBvbGQgdmFsdWUgYW5kIHJldHVybnMgYW4gZXJyb3IgbWVzc2FnZSBpZiB0aGV5IGFyZSBub3QgZXF1YWwuXG4gKiBAcGFyYW0ge2FueX0gdmFsdWUgLSBUaGUgdmFsdWUgdG8gYmUgdmFsaWRhdGVkXG4gKiBAcGFyYW0ge2FueX0gb2xkVmFsdWUgLSBUaGUgcHJldmlvdXMgdmFsdWUgdG8gY29tcGFyZSBhZ2FpbnN0XG4gKiBAcGFyYW0ge3N0cmluZ30gW21lc3NhZ2VdIC0gT3B0aW9uYWwgY3VzdG9tIGVycm9yIG1lc3NhZ2VcbiAqIEBjbGFzcyBSZWFkT25seVZhbGlkYXRvclxuICogQGV4YW1wbGVcbiAqIC8vIFVzaW5nIFJlYWRPbmx5VmFsaWRhdG9yIHdpdGggYSByZWFkb25seSBwcm9wZXJ0eVxuICogY2xhc3MgVXNlciB7XG4gKiAgIEByZWFkb25seSgpXG4gKiAgIGlkOiBzdHJpbmc7XG4gKiAgIFxuICogICBuYW1lOiBzdHJpbmc7XG4gKiAgIFxuICogICBjb25zdHJ1Y3RvcihpZDogc3RyaW5nLCBuYW1lOiBzdHJpbmcpIHtcbiAqICAgICB0aGlzLmlkID0gaWQ7XG4gKiAgICAgdGhpcy5uYW1lID0gbmFtZTtcbiAqICAgfVxuICogfVxuICogXG4gKiAvLyBUaGlzIHdpbGwgdHJpZ2dlciB2YWxpZGF0aW9uIGVycm9yIHdoZW4gdHJ5aW5nIHRvIHVwZGF0ZVxuICogY29uc3QgdXNlciA9IG5ldyBVc2VyKCcxMjMnLCAnSm9obicpO1xuICogdXNlci5pZCA9ICc0NTYnOyAvLyBXaWxsIGJlIHByZXZlbnRlZCBieSBSZWFkT25seVZhbGlkYXRvclxuICogQGNhdGVnb3J5IFZhbGlkYXRvcnNcbiAqL1xuQHZhbGlkYXRvcihVcGRhdGVWYWxpZGF0aW9uS2V5cy5SRUFET05MWSlcbmV4cG9ydCBjbGFzcyBSZWFkT25seVZhbGlkYXRvciBleHRlbmRzIFZhbGlkYXRvciB7XG4gIGNvbnN0cnVjdG9yKCkge1xuICAgIHN1cGVyKERFRkFVTFRfRVJST1JfTUVTU0FHRVMuUkVBRE9OTFkuSU5WQUxJRCk7XG4gIH1cblxuICAvKipcbiAgICogQGRlc2NyaXB0aW9uIEltcGxlbWVudGF0aW9uIG9mIHRoZSBiYXNlIHZhbGlkYXRvcidzIGhhc0Vycm9ycyBtZXRob2QuXG4gICAqIEBzdW1tYXJ5IFRoaXMgbWV0aG9kIGlzIHJlcXVpcmVkIGJ5IHRoZSBWYWxpZGF0b3IgaW50ZXJmYWNlIGJ1dCBub3QgdXNlZCBpbiB0aGlzIHZhbGlkYXRvciBhcyB2YWxpZGF0aW9uIG9ubHkgaGFwcGVucyBkdXJpbmcgdXBkYXRlcy5cbiAgICogQHBhcmFtIHthbnl9IHZhbHVlIC0gVGhlIHZhbHVlIHRvIHZhbGlkYXRlXG4gICAqIEBwYXJhbSB7YW55W119IGFyZ3MgLSBBZGRpdGlvbmFsIGFyZ3VtZW50c1xuICAgKiBAcmV0dXJuIHtzdHJpbmcgfCB1bmRlZmluZWR9IEFsd2F5cyByZXR1cm5zIHVuZGVmaW5lZCBhcyB0aGlzIHZhbGlkYXRvciBvbmx5IHdvcmtzIGR1cmluZyB1cGRhdGVzXG4gICAqL1xuICAvLyBlc2xpbnQtZGlzYWJsZS1uZXh0LWxpbmUgQHR5cGVzY3JpcHQtZXNsaW50L25vLXVudXNlZC12YXJzXG4gIGhhc0Vycm9ycyh2YWx1ZTogYW55LCAuLi5hcmdzOiBhbnlbXSk6IHN0cmluZyB8IHVuZGVmaW5lZCB7XG4gICAgcmV0dXJuIHVuZGVmaW5lZDtcbiAgfVxuXG4gIC8qKlxuICAgKiBAZGVzY3JpcHRpb24gQ2hlY2tzIGlmIGEgdmFsdWUgaGFzIGJlZW4gbW9kaWZpZWQgZHVyaW5nIGFuIHVwZGF0ZSBvcGVyYXRpb24uXG4gICAqIEBzdW1tYXJ5IFZhbGlkYXRlcyBhIHZhbHVlIGhhcyBub3QgY2hhbmdlZCBieSBjb21wYXJpbmcgaXQgd2l0aCB0aGUgcHJldmlvdXMgdmFsdWUgdXNpbmcgZGVlcCBlcXVhbGl0eS5cbiAgICogQHBhcmFtIHthbnl9IHZhbHVlIC0gVGhlIG5ldyB2YWx1ZSB0byB2YWxpZGF0ZVxuICAgKiBAcGFyYW0ge2FueX0gb2xkVmFsdWUgLSBUaGUgb3JpZ2luYWwgdmFsdWUgdG8gY29tcGFyZSBhZ2FpbnN0XG4gICAqIEBwYXJhbSB7c3RyaW5nfSBbbWVzc2FnZV0gLSBPcHRpb25hbCBjdXN0b20gZXJyb3IgbWVzc2FnZSB0byBvdmVycmlkZSB0aGUgZGVmYXVsdFxuICAgKiBAcmV0dXJuIHtzdHJpbmcgfCB1bmRlZmluZWR9IEFuIGVycm9yIG1lc3NhZ2UgaWYgdmFsaWRhdGlvbiBmYWlscywgdW5kZWZpbmVkIG90aGVyd2lzZVxuICAgKi9cbiAgcHVibGljIHVwZGF0ZUhhc0Vycm9ycyhcbiAgICB2YWx1ZTogYW55LFxuICAgIG9sZFZhbHVlOiBhbnksXG4gICAgbWVzc2FnZT86IHN0cmluZyxcbiAgKTogc3RyaW5nIHwgdW5kZWZpbmVkIHtcbiAgICBpZiAodmFsdWUgPT09IHVuZGVmaW5lZCkgcmV0dXJuO1xuXG4gICAgcmV0dXJuIGlzRXF1YWwodmFsdWUsIG9sZFZhbHVlKVxuICAgICAgPyB1bmRlZmluZWRcbiAgICAgIDogdGhpcy5nZXRNZXNzYWdlKG1lc3NhZ2UgfHwgdGhpcy5tZXNzYWdlKTtcbiAgfVxufVxuIl19