@decaf-ts/db-decorators 0.6.0 → 0.6.2

package/lib/validation/validators/TimestampValidator.cjs

@@ -13,21 +13,55 @@ exports.TimestampValidator = void 0;
 const decorator_validation_1 = require("@decaf-ts/decorator-validation");
 const constants_1 = require("./../constants.cjs");
 /**
- * @summary Validates the update of a timestamp
- *
+ * @description A validator that ensures timestamp values are only updated with newer timestamps.
+ * @summary Validates the update of a timestamp by comparing the new timestamp with the old one, ensuring the new timestamp is more recent.
+ * @param {Date|string|number} value - The timestamp value to validate
+ * @param {Date|string|number} oldValue - The previous timestamp to compare against
+ * @param {string} [message] - Optional custom error message
  * @class TimestampValidator
- * @extends Validator
+ * @example
+ * // Using TimestampValidator with a timestamp property
+ * class Document {
+ *   @timestamp()
+ *   updatedAt: Date;
+ *
+ *   title: string;
+ *
+ *   constructor(title: string) {
+ *     this.title = title;
+ *     this.updatedAt = new Date();
+ *   }
+ * }
  *
+ * // This will trigger validation error when trying to update with an older timestamp
+ * const doc = new Document('My Document');
+ * const oldDate = new Date(2020, 0, 1);
+ * doc.updatedAt = oldDate; // Will be prevented by TimestampValidator
  * @category Validators
  */
 let TimestampValidator = class TimestampValidator extends decorator_validation_1.Validator {
     constructor() {
         super(constants_1.DEFAULT_ERROR_MESSAGES.TIMESTAMP.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 timestamp 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 Validates that a timestamp is newer than its previous value.
+     * @summary Checks if a timestamp has been updated with a more recent value by converting both values to Date objects and comparing them.
+     * @param {Date|string|number} value - The new timestamp value to validate
+     * @param {Date|string|number} oldValue - The original timestamp to compare against
+     * @param {string} [message] - Optional custom error message to override the default
+     * @return {string | undefined} An error message if validation fails (new timestamp is not newer), undefined otherwise
+     */
     updateHasErrors(value, oldValue, message) {
         if (value === undefined)
             return;
@@ -48,4 +82,4 @@ exports.TimestampValidator = TimestampValidator = __decorate([
     (0, decorator_validation_1.validator)(constants_1.UpdateValidationKeys.TIMESTAMP),
     __metadata("design:paramtypes", [])
 ], TimestampValidator);
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiVGltZXN0YW1wVmFsaWRhdG9yLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3ZhbGlkYXRpb24vdmFsaWRhdG9ycy9UaW1lc3RhbXBWYWxpZGF0b3IudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7O0FBQUEseUVBQXNFO0FBQ3RFLGtEQUE0RTtBQUU1RTs7Ozs7OztHQU9HO0FBRUksSUFBTSxrQkFBa0IsR0FBeEIsTUFBTSxrQkFBbUIsU0FBUSxnQ0FBUztJQUMvQztRQUNFLEtBQUssQ0FBQyxrQ0FBc0IsQ0FBQyxTQUFTLENBQUMsT0FBTyxDQUFDLENBQUM7SUFDbEQsQ0FBQztJQUVELDZEQUE2RDtJQUM3RCxTQUFTLENBQUMsS0FBVSxFQUFFLEdBQUcsSUFBVztRQUNsQyxPQUFPLFNBQVMsQ0FBQztJQUNuQixDQUFDO0lBRU0sZUFBZSxDQUNwQixLQUE2QixFQUM3QixRQUFnQyxFQUNoQyxPQUFnQjtRQUVoQixJQUFJLEtBQUssS0FBSyxTQUFTO1lBQUUsT0FBTztRQUVoQyxPQUFPLEdBQUcsT0FBTyxJQUFJLElBQUksQ0FBQyxVQUFVLENBQUMsT0FBTyxJQUFJLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUU5RCxJQUFJLENBQUM7WUFDSCxLQUFLLEdBQUcsSUFBSSxJQUFJLENBQUMsS0FBSyxDQUFDLENBQUM7WUFDeEIsUUFBUSxHQUFHLElBQUksSUFBSSxDQUFDLFFBQVEsQ0FBQyxDQUFDO1lBQzlCLDZEQUE2RDtRQUMvRCxDQUFDO1FBQUMsT0FBTyxDQUFDLEVBQUUsQ0FBQztZQUNYLE9BQU8sT0FBTyxDQUFDO1FBQ2pCLENBQUM7UUFFRCxPQUFPLEtBQUssSUFBSSxRQUFRLENBQUMsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUMsU0FBUyxDQUFDO0lBQ2pELENBQUM7Q0FDRixDQUFBO0FBN0JZLGdEQUFrQjs2QkFBbEIsa0JBQWtCO0lBRDlCLElBQUEsZ0NBQVMsRUFBQyxnQ0FBb0IsQ0FBQyxTQUFTLENBQUM7O0dBQzdCLGtCQUFrQixDQTZCOUIiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyB2YWxpZGF0b3IsIFZhbGlkYXRvciB9IGZyb20gXCJAZGVjYWYtdHMvZGVjb3JhdG9yLXZhbGlkYXRpb25cIjtcbmltcG9ydCB7IERFRkFVTFRfRVJST1JfTUVTU0FHRVMsIFVwZGF0ZVZhbGlkYXRpb25LZXlzIH0gZnJvbSBcIi4uL2NvbnN0YW50c1wiO1xuXG4vKipcbiAqIEBzdW1tYXJ5IFZhbGlkYXRlcyB0aGUgdXBkYXRlIG9mIGEgdGltZXN0YW1wXG4gKlxuICogQGNsYXNzIFRpbWVzdGFtcFZhbGlkYXRvclxuICogQGV4dGVuZHMgVmFsaWRhdG9yXG4gKlxuICogQGNhdGVnb3J5IFZhbGlkYXRvcnNcbiAqL1xuQHZhbGlkYXRvcihVcGRhdGVWYWxpZGF0aW9uS2V5cy5USU1FU1RBTVApXG5leHBvcnQgY2xhc3MgVGltZXN0YW1wVmFsaWRhdG9yIGV4dGVuZHMgVmFsaWRhdG9yIHtcbiAgY29uc3RydWN0b3IoKSB7XG4gICAgc3VwZXIoREVGQVVMVF9FUlJPUl9NRVNTQUdFUy5USU1FU1RBTVAuSU5WQUxJRCk7XG4gIH1cblxuICAvLyBlc2xpbnQtZGlzYWJsZS1uZXh0LWxpbmUgQHR5cGVzY3JpcHQtZXNsaW50L25vLXVudXNlZC12YXJzXG4gIGhhc0Vycm9ycyh2YWx1ZTogYW55LCAuLi5hcmdzOiBhbnlbXSk6IHN0cmluZyB8IHVuZGVmaW5lZCB7XG4gICAgcmV0dXJuIHVuZGVmaW5lZDtcbiAgfVxuXG4gIHB1YmxpYyB1cGRhdGVIYXNFcnJvcnMoXG4gICAgdmFsdWU6IERhdGUgfCBzdHJpbmcgfCBudW1iZXIsXG4gICAgb2xkVmFsdWU6IERhdGUgfCBzdHJpbmcgfCBudW1iZXIsXG4gICAgbWVzc2FnZT86IHN0cmluZ1xuICApOiBzdHJpbmcgfCB1bmRlZmluZWQge1xuICAgIGlmICh2YWx1ZSA9PT0gdW5kZWZpbmVkKSByZXR1cm47XG5cbiAgICBtZXNzYWdlID0gbWVzc2FnZSB8fCB0aGlzLmdldE1lc3NhZ2UobWVzc2FnZSB8fCB0aGlzLm1lc3NhZ2UpO1xuXG4gICAgdHJ5IHtcbiAgICAgIHZhbHVlID0gbmV3IERhdGUodmFsdWUpO1xuICAgICAgb2xkVmFsdWUgPSBuZXcgRGF0ZShvbGRWYWx1ZSk7XG4gICAgICAvLyBlc2xpbnQtZGlzYWJsZS1uZXh0LWxpbmUgQHR5cGVzY3JpcHQtZXNsaW50L25vLXVudXNlZC12YXJzXG4gICAgfSBjYXRjaCAoZSkge1xuICAgICAgcmV0dXJuIG1lc3NhZ2U7XG4gICAgfVxuXG4gICAgcmV0dXJuIHZhbHVlIDw9IG9sZFZhbHVlID8gbWVzc2FnZSA6IHVuZGVmaW5lZDtcbiAgfVxufVxuIl19
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiVGltZXN0YW1wVmFsaWRhdG9yLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3ZhbGlkYXRpb24vdmFsaWRhdG9ycy9UaW1lc3RhbXBWYWxpZGF0b3IudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7O0FBQUEseUVBQXNFO0FBQ3RFLGtEQUE0RTtBQUU1RTs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7R0EwQkc7QUFFSSxJQUFNLGtCQUFrQixHQUF4QixNQUFNLGtCQUFtQixTQUFRLGdDQUFTO0lBQy9DO1FBQ0UsS0FBSyxDQUFDLGtDQUFzQixDQUFDLFNBQVMsQ0FBQyxPQUFPLENBQUMsQ0FBQztJQUNsRCxDQUFDO0lBRUQ7Ozs7OztPQU1HO0lBQ0gsNkRBQTZEO0lBQzdELFNBQVMsQ0FBQyxLQUFVLEVBQUUsR0FBRyxJQUFXO1FBQ2xDLE9BQU8sU0FBUyxDQUFDO0lBQ25CLENBQUM7SUFFRDs7Ozs7OztPQU9HO0lBQ0ksZUFBZSxDQUNwQixLQUE2QixFQUM3QixRQUFnQyxFQUNoQyxPQUFnQjtRQUVoQixJQUFJLEtBQUssS0FBSyxTQUFTO1lBQUUsT0FBTztRQUVoQyxPQUFPLEdBQUcsT0FBTyxJQUFJLElBQUksQ0FBQyxVQUFVLENBQUMsT0FBTyxJQUFJLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUU5RCxJQUFJLENBQUM7WUFDSCxLQUFLLEdBQUcsSUFBSSxJQUFJLENBQUMsS0FBSyxDQUFDLENBQUM7WUFDeEIsUUFBUSxHQUFHLElBQUksSUFBSSxDQUFDLFFBQVEsQ0FBQyxDQUFDO1lBQzlCLDZEQUE2RDtRQUMvRCxDQUFDO1FBQUMsT0FBTyxDQUFDLEVBQUUsQ0FBQztZQUNYLE9BQU8sT0FBTyxDQUFDO1FBQ2pCLENBQUM7UUFFRCxPQUFPLEtBQUssSUFBSSxRQUFRLENBQUMsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUMsU0FBUyxDQUFDO0lBQ2pELENBQUM7Q0FDRixDQUFBO0FBNUNZLGdEQUFrQjs2QkFBbEIsa0JBQWtCO0lBRDlCLElBQUEsZ0NBQVMsRUFBQyxnQ0FBb0IsQ0FBQyxTQUFTLENBQUM7O0dBQzdCLGtCQUFrQixDQTRDOUIiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyB2YWxpZGF0b3IsIFZhbGlkYXRvciB9IGZyb20gXCJAZGVjYWYtdHMvZGVjb3JhdG9yLXZhbGlkYXRpb25cIjtcbmltcG9ydCB7IERFRkFVTFRfRVJST1JfTUVTU0FHRVMsIFVwZGF0ZVZhbGlkYXRpb25LZXlzIH0gZnJvbSBcIi4uL2NvbnN0YW50c1wiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBBIHZhbGlkYXRvciB0aGF0IGVuc3VyZXMgdGltZXN0YW1wIHZhbHVlcyBhcmUgb25seSB1cGRhdGVkIHdpdGggbmV3ZXIgdGltZXN0YW1wcy5cbiAqIEBzdW1tYXJ5IFZhbGlkYXRlcyB0aGUgdXBkYXRlIG9mIGEgdGltZXN0YW1wIGJ5IGNvbXBhcmluZyB0aGUgbmV3IHRpbWVzdGFtcCB3aXRoIHRoZSBvbGQgb25lLCBlbnN1cmluZyB0aGUgbmV3IHRpbWVzdGFtcCBpcyBtb3JlIHJlY2VudC5cbiAqIEBwYXJhbSB7RGF0ZXxzdHJpbmd8bnVtYmVyfSB2YWx1ZSAtIFRoZSB0aW1lc3RhbXAgdmFsdWUgdG8gdmFsaWRhdGVcbiAqIEBwYXJhbSB7RGF0ZXxzdHJpbmd8bnVtYmVyfSBvbGRWYWx1ZSAtIFRoZSBwcmV2aW91cyB0aW1lc3RhbXAgdG8gY29tcGFyZSBhZ2FpbnN0XG4gKiBAcGFyYW0ge3N0cmluZ30gW21lc3NhZ2VdIC0gT3B0aW9uYWwgY3VzdG9tIGVycm9yIG1lc3NhZ2VcbiAqIEBjbGFzcyBUaW1lc3RhbXBWYWxpZGF0b3JcbiAqIEBleGFtcGxlXG4gKiAvLyBVc2luZyBUaW1lc3RhbXBWYWxpZGF0b3Igd2l0aCBhIHRpbWVzdGFtcCBwcm9wZXJ0eVxuICogY2xhc3MgRG9jdW1lbnQge1xuICogICBAdGltZXN0YW1wKClcbiAqICAgdXBkYXRlZEF0OiBEYXRlO1xuICogICBcbiAqICAgdGl0bGU6IHN0cmluZztcbiAqICAgXG4gKiAgIGNvbnN0cnVjdG9yKHRpdGxlOiBzdHJpbmcpIHtcbiAqICAgICB0aGlzLnRpdGxlID0gdGl0bGU7XG4gKiAgICAgdGhpcy51cGRhdGVkQXQgPSBuZXcgRGF0ZSgpO1xuICogICB9XG4gKiB9XG4gKiBcbiAqIC8vIFRoaXMgd2lsbCB0cmlnZ2VyIHZhbGlkYXRpb24gZXJyb3Igd2hlbiB0cnlpbmcgdG8gdXBkYXRlIHdpdGggYW4gb2xkZXIgdGltZXN0YW1wXG4gKiBjb25zdCBkb2MgPSBuZXcgRG9jdW1lbnQoJ015IERvY3VtZW50Jyk7XG4gKiBjb25zdCBvbGREYXRlID0gbmV3IERhdGUoMjAyMCwgMCwgMSk7XG4gKiBkb2MudXBkYXRlZEF0ID0gb2xkRGF0ZTsgLy8gV2lsbCBiZSBwcmV2ZW50ZWQgYnkgVGltZXN0YW1wVmFsaWRhdG9yXG4gKiBAY2F0ZWdvcnkgVmFsaWRhdG9yc1xuICovXG5AdmFsaWRhdG9yKFVwZGF0ZVZhbGlkYXRpb25LZXlzLlRJTUVTVEFNUClcbmV4cG9ydCBjbGFzcyBUaW1lc3RhbXBWYWxpZGF0b3IgZXh0ZW5kcyBWYWxpZGF0b3Ige1xuICBjb25zdHJ1Y3RvcigpIHtcbiAgICBzdXBlcihERUZBVUxUX0VSUk9SX01FU1NBR0VTLlRJTUVTVEFNUC5JTlZBTElEKTtcbiAgfVxuXG4gIC8qKlxuICAgKiBAZGVzY3JpcHRpb24gSW1wbGVtZW50YXRpb24gb2YgdGhlIGJhc2UgdmFsaWRhdG9yJ3MgaGFzRXJyb3JzIG1ldGhvZC5cbiAgICogQHN1bW1hcnkgVGhpcyBtZXRob2QgaXMgcmVxdWlyZWQgYnkgdGhlIFZhbGlkYXRvciBpbnRlcmZhY2UgYnV0IG5vdCB1c2VkIGluIHRoaXMgdmFsaWRhdG9yIGFzIHZhbGlkYXRpb24gb25seSBoYXBwZW5zIGR1cmluZyB1cGRhdGVzLlxuICAgKiBAcGFyYW0ge2FueX0gdmFsdWUgLSBUaGUgdGltZXN0YW1wIHZhbHVlIHRvIHZhbGlkYXRlXG4gICAqIEBwYXJhbSB7YW55W119IGFyZ3MgLSBBZGRpdGlvbmFsIGFyZ3VtZW50c1xuICAgKiBAcmV0dXJuIHtzdHJpbmcgfCB1bmRlZmluZWR9IEFsd2F5cyByZXR1cm5zIHVuZGVmaW5lZCBhcyB0aGlzIHZhbGlkYXRvciBvbmx5IHdvcmtzIGR1cmluZyB1cGRhdGVzXG4gICAqL1xuICAvLyBlc2xpbnQtZGlzYWJsZS1uZXh0LWxpbmUgQHR5cGVzY3JpcHQtZXNsaW50L25vLXVudXNlZC12YXJzXG4gIGhhc0Vycm9ycyh2YWx1ZTogYW55LCAuLi5hcmdzOiBhbnlbXSk6IHN0cmluZyB8IHVuZGVmaW5lZCB7XG4gICAgcmV0dXJuIHVuZGVmaW5lZDtcbiAgfVxuXG4gIC8qKlxuICAgKiBAZGVzY3JpcHRpb24gVmFsaWRhdGVzIHRoYXQgYSB0aW1lc3RhbXAgaXMgbmV3ZXIgdGhhbiBpdHMgcHJldmlvdXMgdmFsdWUuXG4gICAqIEBzdW1tYXJ5IENoZWNrcyBpZiBhIHRpbWVzdGFtcCBoYXMgYmVlbiB1cGRhdGVkIHdpdGggYSBtb3JlIHJlY2VudCB2YWx1ZSBieSBjb252ZXJ0aW5nIGJvdGggdmFsdWVzIHRvIERhdGUgb2JqZWN0cyBhbmQgY29tcGFyaW5nIHRoZW0uXG4gICAqIEBwYXJhbSB7RGF0ZXxzdHJpbmd8bnVtYmVyfSB2YWx1ZSAtIFRoZSBuZXcgdGltZXN0YW1wIHZhbHVlIHRvIHZhbGlkYXRlXG4gICAqIEBwYXJhbSB7RGF0ZXxzdHJpbmd8bnVtYmVyfSBvbGRWYWx1ZSAtIFRoZSBvcmlnaW5hbCB0aW1lc3RhbXAgdG8gY29tcGFyZSBhZ2FpbnN0XG4gICAqIEBwYXJhbSB7c3RyaW5nfSBbbWVzc2FnZV0gLSBPcHRpb25hbCBjdXN0b20gZXJyb3IgbWVzc2FnZSB0byBvdmVycmlkZSB0aGUgZGVmYXVsdFxuICAgKiBAcmV0dXJuIHtzdHJpbmcgfCB1bmRlZmluZWR9IEFuIGVycm9yIG1lc3NhZ2UgaWYgdmFsaWRhdGlvbiBmYWlscyAobmV3IHRpbWVzdGFtcCBpcyBub3QgbmV3ZXIpLCB1bmRlZmluZWQgb3RoZXJ3aXNlXG4gICAqL1xuICBwdWJsaWMgdXBkYXRlSGFzRXJyb3JzKFxuICAgIHZhbHVlOiBEYXRlIHwgc3RyaW5nIHwgbnVtYmVyLFxuICAgIG9sZFZhbHVlOiBEYXRlIHwgc3RyaW5nIHwgbnVtYmVyLFxuICAgIG1lc3NhZ2U/OiBzdHJpbmdcbiAgKTogc3RyaW5nIHwgdW5kZWZpbmVkIHtcbiAgICBpZiAodmFsdWUgPT09IHVuZGVmaW5lZCkgcmV0dXJuO1xuXG4gICAgbWVzc2FnZSA9IG1lc3NhZ2UgfHwgdGhpcy5nZXRNZXNzYWdlKG1lc3NhZ2UgfHwgdGhpcy5tZXNzYWdlKTtcblxuICAgIHRyeSB7XG4gICAgICB2YWx1ZSA9IG5ldyBEYXRlKHZhbHVlKTtcbiAgICAgIG9sZFZhbHVlID0gbmV3IERhdGUob2xkVmFsdWUpO1xuICAgICAgLy8gZXNsaW50LWRpc2FibGUtbmV4dC1saW5lIEB0eXBlc2NyaXB0LWVzbGludC9uby11bnVzZWQtdmFyc1xuICAgIH0gY2F0Y2ggKGUpIHtcbiAgICAgIHJldHVybiBtZXNzYWdlO1xuICAgIH1cblxuICAgIHJldHVybiB2YWx1ZSA8PSBvbGRWYWx1ZSA/IG1lc3NhZ2UgOiB1bmRlZmluZWQ7XG4gIH1cbn1cbiJdfQ==

package/lib/validation/validators/TimestampValidator.d.ts

@@ -1,14 +1,48 @@
 import { Validator } from "@decaf-ts/decorator-validation";
 /**
- * @summary Validates the update of a timestamp
- *
+ * @description A validator that ensures timestamp values are only updated with newer timestamps.
+ * @summary Validates the update of a timestamp by comparing the new timestamp with the old one, ensuring the new timestamp is more recent.
+ * @param {Date|string|number} value - The timestamp value to validate
+ * @param {Date|string|number} oldValue - The previous timestamp to compare against
+ * @param {string} [message] - Optional custom error message
  * @class TimestampValidator
- * @extends Validator
+ * @example
+ * // Using TimestampValidator with a timestamp property
+ * class Document {
+ *   @timestamp()
+ *   updatedAt: Date;
+ *
+ *   title: string;
+ *
+ *   constructor(title: string) {
+ *     this.title = title;
+ *     this.updatedAt = new Date();
+ *   }
+ * }
  *
+ * // This will trigger validation error when trying to update with an older timestamp
+ * const doc = new Document('My Document');
+ * const oldDate = new Date(2020, 0, 1);
+ * doc.updatedAt = oldDate; // Will be prevented by TimestampValidator
  * @category Validators
  */
 export declare class TimestampValidator extends Validator {
     constructor();
+    /**
+     * @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 timestamp value to validate
+     * @param {any[]} args - Additional arguments
+     * @return {string | undefined} Always returns undefined as this validator only works during updates
+     */
     hasErrors(value: any, ...args: any[]): string | undefined;
+    /**
+     * @description Validates that a timestamp is newer than its previous value.
+     * @summary Checks if a timestamp has been updated with a more recent value by converting both values to Date objects and comparing them.
+     * @param {Date|string|number} value - The new timestamp value to validate
+     * @param {Date|string|number} oldValue - The original timestamp to compare against
+     * @param {string} [message] - Optional custom error message to override the default
+     * @return {string | undefined} An error message if validation fails (new timestamp is not newer), undefined otherwise
+     */
     updateHasErrors(value: Date | string | number, oldValue: Date | string | number, message?: string): string | undefined;
 }

package/lib/validation/validators/UpdateValidator.cjs

@@ -3,15 +3,30 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.UpdateValidator = void 0;
 const decorator_validation_1 = require("@decaf-ts/decorator-validation");
 /**
- * @summary Base class for an Update validator
- *
- * @param {string} [message] error message. defaults to {@link DecoratorMessages#DEFAULT}
- * @param {string[]} [acceptedTypes] the accepted value types by the decorator
- *
+ * @description Abstract base class for validators that compare new values with old values during updates.
+ * @summary Base class for an Update validator that provides a framework for implementing validation logic that compares a new value with its previous state.
+ * @param {string} [message] - Error message. Defaults to {@link DecoratorMessages#DEFAULT}
+ * @param {string[]} [acceptedTypes] - The accepted value types by the decorator
  * @class UpdateValidator
- * @abstract
- * @extends Validator
+ * @example
+ * // Extending UpdateValidator to create a custom validator
+ * class MyCustomValidator extends UpdateValidator {
+ *   constructor() {
+ *     super("Custom validation failed");
+ *   }
+ *
+ *   public updateHasErrors(value: any, oldValue: any): string | undefined {
+ *     // Custom validation logic
+ *     if (value === oldValue) {
+ *       return this.message;
+ *     }
+ *     return undefined;
+ *   }
  *
+ *   hasErrors(value: any): string | undefined {
+ *     return undefined; // Not used for update validators
+ *   }
+ * }
  * @category Validators
  */
 class UpdateValidator extends decorator_validation_1.Validator {
@@ -20,4 +35,4 @@ class UpdateValidator extends decorator_validation_1.Validator {
     }
 }
 exports.UpdateValidator = UpdateValidator;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiVXBkYXRlVmFsaWRhdG9yLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3ZhbGlkYXRpb24vdmFsaWRhdG9ycy9VcGRhdGVWYWxpZGF0b3IudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEseUVBR3dDO0FBRXhDOzs7Ozs7Ozs7OztHQVdHO0FBQ0gsTUFBc0IsZUFBZ0IsU0FBUSxnQ0FBUztJQUNyRCxZQUNFLFVBQWtCLDZDQUFpQixDQUFDLE9BQU8sRUFDM0MsR0FBRyxhQUF1QjtRQUUxQixLQUFLLENBQUMsT0FBTyxFQUFFLEdBQUcsYUFBYSxDQUFDLENBQUM7SUFDbkMsQ0FBQztDQWFGO0FBbkJELDBDQW1CQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7XG4gIERFRkFVTFRfRVJST1JfTUVTU0FHRVMgYXMgRGVjb3JhdG9yTWVzc2FnZXMsXG4gIFZhbGlkYXRvcixcbn0gZnJvbSBcIkBkZWNhZi10cy9kZWNvcmF0b3ItdmFsaWRhdGlvblwiO1xuXG4vKipcbiAqIEBzdW1tYXJ5IEJhc2UgY2xhc3MgZm9yIGFuIFVwZGF0ZSB2YWxpZGF0b3JcbiAqXG4gKiBAcGFyYW0ge3N0cmluZ30gW21lc3NhZ2VdIGVycm9yIG1lc3NhZ2UuIGRlZmF1bHRzIHRvIHtAbGluayBEZWNvcmF0b3JNZXNzYWdlcyNERUZBVUxUfVxuICogQHBhcmFtIHtzdHJpbmdbXX0gW2FjY2VwdGVkVHlwZXNdIHRoZSBhY2NlcHRlZCB2YWx1ZSB0eXBlcyBieSB0aGUgZGVjb3JhdG9yXG4gKlxuICogQGNsYXNzIFVwZGF0ZVZhbGlkYXRvclxuICogQGFic3RyYWN0XG4gKiBAZXh0ZW5kcyBWYWxpZGF0b3JcbiAqXG4gKiBAY2F0ZWdvcnkgVmFsaWRhdG9yc1xuICovXG5leHBvcnQgYWJzdHJhY3QgY2xhc3MgVXBkYXRlVmFsaWRhdG9yIGV4dGVuZHMgVmFsaWRhdG9yIHtcbiAgcHJvdGVjdGVkIGNvbnN0cnVjdG9yKFxuICAgIG1lc3NhZ2U6IHN0cmluZyA9IERlY29yYXRvck1lc3NhZ2VzLkRFRkFVTFQsXG4gICAgLi4uYWNjZXB0ZWRUeXBlczogc3RyaW5nW11cbiAgKSB7XG4gICAgc3VwZXIobWVzc2FnZSwgLi4uYWNjZXB0ZWRUeXBlcyk7XG4gIH1cblxuICAvKipcbiAgICogQHN1bW1hcnkgdmFsaWRhdGVzIGEgdmFsdWUgYnkgY29tcGFyaW5nIHRvIGl0cyBvbGQgdmVyc2lvblxuICAgKiBAcGFyYW0ge2FueX0gdmFsdWVcbiAgICogQHBhcmFtIHthbnl9IG9sZFZhbHVlXG4gICAqIEBwYXJhbSB7YW55W119IGFyZ3NcbiAgICovXG4gIHB1YmxpYyBhYnN0cmFjdCB1cGRhdGVIYXNFcnJvcnMoXG4gICAgdmFsdWU6IGFueSxcbiAgICBvbGRWYWx1ZTogYW55LFxuICAgIC4uLmFyZ3M6IGFueVtdXG4gICk6IHN0cmluZyB8IHVuZGVmaW5lZDtcbn1cbiJdfQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiVXBkYXRlVmFsaWRhdG9yLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3ZhbGlkYXRpb24vdmFsaWRhdG9ycy9VcGRhdGVWYWxpZGF0b3IudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEseUVBR3dDO0FBRXhDOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQTBCRztBQUNILE1BQXNCLGVBQWdCLFNBQVEsZ0NBQVM7SUFDckQsWUFDRSxVQUFrQiw2Q0FBaUIsQ0FBQyxPQUFPLEVBQzNDLEdBQUcsYUFBdUI7UUFFMUIsS0FBSyxDQUFDLE9BQU8sRUFBRSxHQUFHLGFBQWEsQ0FBQyxDQUFDO0lBQ25DLENBQUM7Q0FlRjtBQXJCRCwwQ0FxQkMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQge1xuICBERUZBVUxUX0VSUk9SX01FU1NBR0VTIGFzIERlY29yYXRvck1lc3NhZ2VzLFxuICBWYWxpZGF0b3IsXG59IGZyb20gXCJAZGVjYWYtdHMvZGVjb3JhdG9yLXZhbGlkYXRpb25cIjtcblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gQWJzdHJhY3QgYmFzZSBjbGFzcyBmb3IgdmFsaWRhdG9ycyB0aGF0IGNvbXBhcmUgbmV3IHZhbHVlcyB3aXRoIG9sZCB2YWx1ZXMgZHVyaW5nIHVwZGF0ZXMuXG4gKiBAc3VtbWFyeSBCYXNlIGNsYXNzIGZvciBhbiBVcGRhdGUgdmFsaWRhdG9yIHRoYXQgcHJvdmlkZXMgYSBmcmFtZXdvcmsgZm9yIGltcGxlbWVudGluZyB2YWxpZGF0aW9uIGxvZ2ljIHRoYXQgY29tcGFyZXMgYSBuZXcgdmFsdWUgd2l0aCBpdHMgcHJldmlvdXMgc3RhdGUuXG4gKiBAcGFyYW0ge3N0cmluZ30gW21lc3NhZ2VdIC0gRXJyb3IgbWVzc2FnZS4gRGVmYXVsdHMgdG8ge0BsaW5rIERlY29yYXRvck1lc3NhZ2VzI0RFRkFVTFR9XG4gKiBAcGFyYW0ge3N0cmluZ1tdfSBbYWNjZXB0ZWRUeXBlc10gLSBUaGUgYWNjZXB0ZWQgdmFsdWUgdHlwZXMgYnkgdGhlIGRlY29yYXRvclxuICogQGNsYXNzIFVwZGF0ZVZhbGlkYXRvclxuICogQGV4YW1wbGVcbiAqIC8vIEV4dGVuZGluZyBVcGRhdGVWYWxpZGF0b3IgdG8gY3JlYXRlIGEgY3VzdG9tIHZhbGlkYXRvclxuICogY2xhc3MgTXlDdXN0b21WYWxpZGF0b3IgZXh0ZW5kcyBVcGRhdGVWYWxpZGF0b3Ige1xuICogICBjb25zdHJ1Y3RvcigpIHtcbiAqICAgICBzdXBlcihcIkN1c3RvbSB2YWxpZGF0aW9uIGZhaWxlZFwiKTtcbiAqICAgfVxuICogICBcbiAqICAgcHVibGljIHVwZGF0ZUhhc0Vycm9ycyh2YWx1ZTogYW55LCBvbGRWYWx1ZTogYW55KTogc3RyaW5nIHwgdW5kZWZpbmVkIHtcbiAqICAgICAvLyBDdXN0b20gdmFsaWRhdGlvbiBsb2dpY1xuICogICAgIGlmICh2YWx1ZSA9PT0gb2xkVmFsdWUpIHtcbiAqICAgICAgIHJldHVybiB0aGlzLm1lc3NhZ2U7XG4gKiAgICAgfVxuICogICAgIHJldHVybiB1bmRlZmluZWQ7XG4gKiAgIH1cbiAqICAgXG4gKiAgIGhhc0Vycm9ycyh2YWx1ZTogYW55KTogc3RyaW5nIHwgdW5kZWZpbmVkIHtcbiAqICAgICByZXR1cm4gdW5kZWZpbmVkOyAvLyBOb3QgdXNlZCBmb3IgdXBkYXRlIHZhbGlkYXRvcnNcbiAqICAgfVxuICogfVxuICogQGNhdGVnb3J5IFZhbGlkYXRvcnNcbiAqL1xuZXhwb3J0IGFic3RyYWN0IGNsYXNzIFVwZGF0ZVZhbGlkYXRvciBleHRlbmRzIFZhbGlkYXRvciB7XG4gIHByb3RlY3RlZCBjb25zdHJ1Y3RvcihcbiAgICBtZXNzYWdlOiBzdHJpbmcgPSBEZWNvcmF0b3JNZXNzYWdlcy5ERUZBVUxULFxuICAgIC4uLmFjY2VwdGVkVHlwZXM6IHN0cmluZ1tdXG4gICkge1xuICAgIHN1cGVyKG1lc3NhZ2UsIC4uLmFjY2VwdGVkVHlwZXMpO1xuICB9XG5cbiAgLyoqXG4gICAqIEBkZXNjcmlwdGlvbiBBYnN0cmFjdCBtZXRob2QgdGhhdCBtdXN0IGJlIGltcGxlbWVudGVkIGJ5IHN1YmNsYXNzZXMgdG8gcGVyZm9ybSB1cGRhdGUgdmFsaWRhdGlvbi5cbiAgICogQHN1bW1hcnkgVmFsaWRhdGVzIGEgdmFsdWUgYnkgY29tcGFyaW5nIGl0IHRvIGl0cyBvbGQgdmVyc2lvbiB0byBkZXRlcm1pbmUgaWYgdGhlIHVwZGF0ZSBpcyB2YWxpZC5cbiAgICogQHBhcmFtIHthbnl9IHZhbHVlIC0gVGhlIG5ldyB2YWx1ZSB0byB2YWxpZGF0ZVxuICAgKiBAcGFyYW0ge2FueX0gb2xkVmFsdWUgLSBUaGUgcHJldmlvdXMgdmFsdWUgdG8gY29tcGFyZSBhZ2FpbnN0XG4gICAqIEBwYXJhbSB7YW55W119IGFyZ3MgLSBBZGRpdGlvbmFsIGFyZ3VtZW50cyB0aGF0IG1heSBiZSBuZWVkZWQgZm9yIHZhbGlkYXRpb25cbiAgICogQHJldHVybiB7c3RyaW5nIHwgdW5kZWZpbmVkfSBBbiBlcnJvciBtZXNzYWdlIGlmIHZhbGlkYXRpb24gZmFpbHMsIHVuZGVmaW5lZCBpZiB2YWxpZGF0aW9uIHBhc3Nlc1xuICAgKi9cbiAgcHVibGljIGFic3RyYWN0IHVwZGF0ZUhhc0Vycm9ycyhcbiAgICB2YWx1ZTogYW55LFxuICAgIG9sZFZhbHVlOiBhbnksXG4gICAgLi4uYXJnczogYW55W11cbiAgKTogc3RyaW5nIHwgdW5kZWZpbmVkO1xufVxuIl19

package/lib/validation/validators/UpdateValidator.d.ts

@@ -1,23 +1,40 @@
 import { Validator } from "@decaf-ts/decorator-validation";
 /**
- * @summary Base class for an Update validator
- *
- * @param {string} [message] error message. defaults to {@link DecoratorMessages#DEFAULT}
- * @param {string[]} [acceptedTypes] the accepted value types by the decorator
- *
+ * @description Abstract base class for validators that compare new values with old values during updates.
+ * @summary Base class for an Update validator that provides a framework for implementing validation logic that compares a new value with its previous state.
+ * @param {string} [message] - Error message. Defaults to {@link DecoratorMessages#DEFAULT}
+ * @param {string[]} [acceptedTypes] - The accepted value types by the decorator
  * @class UpdateValidator
- * @abstract
- * @extends Validator
+ * @example
+ * // Extending UpdateValidator to create a custom validator
+ * class MyCustomValidator extends UpdateValidator {
+ *   constructor() {
+ *     super("Custom validation failed");
+ *   }
+ *
+ *   public updateHasErrors(value: any, oldValue: any): string | undefined {
+ *     // Custom validation logic
+ *     if (value === oldValue) {
+ *       return this.message;
+ *     }
+ *     return undefined;
+ *   }
  *
+ *   hasErrors(value: any): string | undefined {
+ *     return undefined; // Not used for update validators
+ *   }
+ * }
  * @category Validators
  */
 export declare abstract class UpdateValidator extends Validator {
     protected constructor(message?: string, ...acceptedTypes: string[]);
     /**
-     * @summary validates a value by comparing to its old version
-     * @param {any} value
-     * @param {any} oldValue
-     * @param {any[]} args
+     * @description Abstract method that must be implemented by subclasses to perform update validation.
+     * @summary Validates a value by comparing it to its old version to determine if the update is valid.
+     * @param {any} value - The new value to validate
+     * @param {any} oldValue - The previous value to compare against
+     * @param {any[]} args - Additional arguments that may be needed for validation
+     * @return {string | undefined} An error message if validation fails, undefined if validation passes
      */
     abstract updateHasErrors(value: any, oldValue: any, ...args: any[]): string | undefined;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decaf-ts/db-decorators",
-  "version": "0.6.0",
+  "version": "0.6.2",
   "description": "Agnostic database decorators and repository",
   "type": "module",
   "exports": {
@@ -67,7 +67,7 @@
     "ts"
   ],
   "author": "Tiago Venceslau",
-  "license": "LGPL-3.0-or-later",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/decaf-ts/db-decorators/issues"
   },