remult 0.27.22 → 0.27.23-next.1

package/esm/index.js

@@ -5,6 +5,7 @@ export { getEntityRef } from './src/remult3/getEntityRef.js';
 export { Field, Fields, Relations, } from './src/remult3/Fields.js';
 export { IdEntity } from './src/remult3/IdEntity.js';
 export { describeClass, describeBackendMethods, describeEntity, } from './src/remult3/classDescribers.js';
+export { EntityError, } from './src/data-interfaces.js'; //V
 export { RestDataProvider } from './src/data-providers/rest-data-provider.js'; //V
 export { InMemoryDataProvider } from './src/data-providers/in-memory-database.js'; //V
 export { SqlDatabase } from './src/data-providers/sql-database.js'; //V

package/esm/server/remult-api-server.js

@@ -833,10 +833,11 @@ class ResponseBridgeToDataApiResponse {
                 url: this.genReq?.url,
                 method: this.genReq?.method,
             });
-            this.setStatus(httpStatusCode).json(body);
+            const json = { ...body, message: body.message };
+            this.setStatus(httpStatusCode).json(json);
         };
         await this.handleError?.({
-            httpStatusCode,
+            httpStatusCode: httpStatusCode,
             req: this.req,
             entity,
             exception,

package/esm/src/data-api.js

@@ -1,4 +1,5 @@
 import { doTransaction } from './context.js';
+import { EntityError } from './data-interfaces.js';
 import { findOptionsToJson, liveQueryAction, } from './data-providers/rest-data-provider.js';
 import { Filter, buildFilterFromRequestParameters, customUrlToken, } from './filter/filter-interfaces.js';
 import { getRelationFieldInfo } from './remult3/relationInfoMember.js';
@@ -490,7 +491,10 @@ export function determineSort(sortUrlParm, dirUrlParam) {
     return result;
 }
 export function serializeError(data) {
-    if (data instanceof TypeError) {
+    if (data instanceof EntityError) {
+        data = { message: data.message, modelState: data.modelState };
+    }
+    else if (data instanceof Error) {
         data = { message: data.message, stack: data.stack };
     }
     let x = JSON.parse(JSON.stringify(data));

package/esm/src/data-interfaces.js

@@ -9,3 +9,13 @@ export function extractSort(sort) {
     }
     return sort;
 }
+export class EntityError extends Error {
+    constructor(errorInfo) {
+        super(errorInfo.message);
+        Object.assign(this, errorInfo);
+    }
+    modelState;
+    stack;
+    exception;
+    httpStatusCode;
+}

package/esm/src/remult3/RepositoryImplementation.js

@@ -5,6 +5,7 @@ import { Filter } from '../filter/filter-interfaces.js';
 import { Sort } from '../sort.js';
 import { GroupByForApiKey, } from './remult3.js';
 import { assign } from '../../assign.js';
+import { EntityError, } from '../data-interfaces.js';
 import { ValueConverters } from '../valueConverters.js';
 import { findOptionsToJson } from '../data-providers/rest-data-provider.js';
 import { remult as defaultRemult } from '../remult-proxy.js';
@@ -1194,7 +1195,7 @@ class rowHelperBase {
                 }
             }
         }
-        return error;
+        return new EntityError(error);
     }
     catchSaveErrors(err) {
         let e = err;
@@ -1987,12 +1988,12 @@ export class columnDefsImpl {
                         }
                         catch (err) {
                             const error = `${String(prop)} failed for value ${args?.[0]}. Error: ${typeof err === 'string' ? err : err.message}`;
-                            throw {
+                            throw new EntityError({
                                 message: this.caption + ': ' + error,
                                 modelState: {
                                     [this.key]: error,
                                 },
-                            };
+                            });
                         }
                     };
                 }

package/esm/src/remult3/remult3.js

@@ -17,6 +17,8 @@ const wnn = [
 export const flags = {
     error500RetryCount: 4,
 };
+//p1 - make error info an actual error, important for exception handling, and also for auth.js errors that were mistic
+//p1 - add validators min,max,between(range)
 //p1 - allow experimental route registration on remult server, with at least get route, and support redirect, read header and set header - (and the existing get html etc...)
 //p2 - add parameter all to deleteMany, and updateMany
 //p2  filter.apply ApiPreFilter

package/esm/src/validators.js

@@ -1,8 +1,17 @@
 import { getRelationFieldInfo } from '../internals.js';
+/**
+ * Class containing various field validators.
+ */
 export class Validators {
+    /**
+     * Validator to check if a value is required (not null or empty).
+     */
     static required = createValidator(async (_, e) => !e.valueIsNull() &&
         e.value !== '' &&
         (e.value !== undefined || getRelationFieldInfo(e.metadata) !== undefined), 'Should not be empty');
+    /**
+     * Validator to ensure a value is unique in the database.
+     */
     static unique = createValidator(async (_, e) => {
         if (!e.entityRef)
             throw 'unique validation may only work on columns that are attached to an entity';
@@ -16,6 +25,7 @@ export class Validators {
     }, 'already exists');
     /**
      * @deprecated use `unique` instead - it also runs only on the backend
+     * Validator to ensure a value is unique on the backend.
      */
     static uniqueOnBackend = createValidator(async (_, e) => {
         if (e.isBackend() && (e.isNew || e.valueChanged())) {
@@ -26,9 +36,21 @@ export class Validators {
         else
             return true;
     }, Validators.unique.defaultMessage);
+    /**
+     * Validator to check if a value matches a given regular expression.
+     */
     static regex = createValueValidatorWithArgs((val, regex) => regex.test(val));
+    /**
+     * Validator to check if a value is a valid email address.
+     */
     static email = createValueValidator((val) => /^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(val), 'Invalid Email');
+    /**
+     * Validator to check if a value is a valid URL.
+     */
     static url = createValueValidator((val) => !!new URL(val), 'Invalid Url');
+    /**
+     * Validator to check if a value is one of the specified values.
+     */
     static in = createValueValidatorWithArgs((val, values) => values.includes(val), (values) => `Value must be one of: ${values
         .map((y) => typeof y === 'object'
         ? y?.['id'] !== undefined
@@ -36,8 +58,17 @@ export class Validators {
             : y?.toString()
         : y)
         .join(', ')}`);
+    /**
+     * Validator to check if a value is not null.
+     */
     static notNull = createValueValidator((val) => val != null, 'Should not be null');
+    /**
+     * Validator to check if a value exists in a given enum.
+     */
     static enum = createValueValidatorWithArgs((value, enumObj) => Object.values(enumObj).includes(value), (enumObj) => `Value must be one of ${getEnumValues(enumObj).join(', ')}`);
+    /**
+     * Validator to check if a related value exists in the database.
+     */
     static relationExists = createValidator(async (_, e) => {
         if (e.valueIsNull())
             return true;
@@ -45,10 +76,27 @@ export class Validators {
             return true;
         return Boolean(await e.load());
     }, 'Relation value does not exist');
+    /**
+     * Validator to check if a value is greater than or equal to a minimum value.
+     */
+    static min = createValueValidatorWithArgs((val, minValue) => val >= minValue, (minValue) => `Value must be bigger than or equal to ${minValue}`);
+    /**
+     * Validator to check if a value is less than or equal to a maximum value.
+     */
+    static max = createValueValidatorWithArgs((val, maxValue) => val <= maxValue, (maxValue) => `Value must be smaller than or equal to ${maxValue}`);
+    /**
+     * Validator to check if a string's length is less than or equal to a maximum length.
+     */
     static maxLength = createValueValidatorWithArgs((val, maxLength) => val.length <= maxLength, (maxLength) => `Value must be at most ${maxLength} characters`);
+    /**
+     * Validator to check if a string's length is greater than or equal to a minimum length.
+     */
     static minLength = createValueValidatorWithArgs((val, minLength) => val.length >= minLength, (maxLength) => `Value must be at least ${maxLength} characters`);
     static defaultMessage = 'Invalid value';
 }
+/**
+ * Function to create a validator with a custom validation function.
+ */
 export function createValidator(validate, defaultMessage) {
     const validation = async (entity, e, message) => {
         const valid = await validate(entity, e);
@@ -85,9 +133,15 @@ export function createValidator(validate, defaultMessage) {
         withMessage: (message) => async (entity, e) => result(entity, e, message),
     });
 }
+/**
+ * Function to create a value validator.
+ */
 export function valueValidator(validate, defaultMessage) {
     return (entity, e) => validate(e.value) || defaultMessage || false;
 }
+/**
+ * Function to create a value validator with arguments.
+ */
 export function createValueValidator(validate, defaultMessage) {
     return createValidator((_, e) => {
         if (e.value === undefined || e.value === null)
@@ -95,6 +149,9 @@ export function createValueValidator(validate, defaultMessage) {
         return validate(e.value);
     }, defaultMessage);
 }
+/**
+ * Function to create a value validator with arguments and a custom message.
+ */
 export function createValueValidatorWithArgs(validate, defaultMessage) {
     const result = createValidatorWithArgsInternal((_, e, args) => {
         if (e.value === undefined || e.value === null)
@@ -111,6 +168,9 @@ export function createValueValidatorWithArgs(validate, defaultMessage) {
         },
     });
 }
+/**
+ * Function to create a validator with arguments and a custom message.
+ */
 export function createValidatorWithArgs(validate, defaultMessage) {
     return createValidatorWithArgsInternal(validate, defaultMessage);
 }
@@ -141,6 +201,9 @@ function createValidatorWithArgsInternal(validate, defaultMessage, isValueValida
         },
     });
 }
+/**
+ * Function to get the values of an enum.
+ */
 export function getEnumValues(enumObj) {
     return Object.values(enumObj).filter((x) => typeof enumObj[x] !== 'number');
 }

package/index.d.ts

@@ -11,7 +11,7 @@ export { Field, Fields, StringFieldOptions, Relations, } from './src/remult3/Fie
 export { IdEntity } from './src/remult3/IdEntity.js';
 export { describeClass, describeBackendMethods, describeEntity, } from './src/remult3/classDescribers.js';
 export { EntityOptions, PreprocessFilterEvent } from './src/entity.js';
-export { DataProvider, EntityDataProvider, EntityDataProviderGroupByOptions, EntityDataProviderFindOptions, ErrorInfo, RestDataProviderHttpProvider, } from './src/data-interfaces.js';
+export { DataProvider, EntityDataProvider, EntityDataProviderGroupByOptions, EntityDataProviderFindOptions, ErrorInfo, EntityError, RestDataProviderHttpProvider, } from './src/data-interfaces.js';
 export { SqlCommand, SqlCommandWithParameters, SqlImplementation, SqlResult, } from './src/sql-command.js';
 export { FieldMetadata, FieldOptions, FieldValidator, ValueConverter, ValueListItem, // reconsider, maybe it should go to remult angular as the abstraction ?
 ValueOrExpression, } from './src/column-interfaces.js';

package/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SubscriptionChannel = exports.InMemoryLiveQueryStorage = exports.remult = exports.ValueConverters = exports.createValueValidator = exports.createValueValidatorWithArgs = exports.createValidatorWithArgs = exports.createValidator = exports.valueValidator = exports.Validators = exports.UrlBuilder = exports.Filter = exports.CompoundIdField = exports.Sort = exports.EventSource = exports.isBackend = exports.withRemult = exports.Remult = exports.Allow = exports.ForbiddenError = exports.ProgressListener = exports.BackendMethod = exports.Controller = exports.JsonEntityIndexedDbStorage = exports.JsonEntityOpfsStorage = exports.JsonDataProvider = exports.dbNamesOf = exports.CustomSqlFilterBuilder = exports.SqlDatabase = exports.InMemoryDataProvider = exports.RestDataProvider = exports.describeEntity = exports.describeBackendMethods = exports.describeClass = exports.IdEntity = exports.Relations = exports.Fields = exports.Field = exports.getEntityRef = exports.Entity = exports.CaptionTransformer = exports.ValueListInfo = exports.getValueList = exports.ValueListFieldType = exports.getFields = exports.FieldType = exports.ControllerBase = exports.EntityBase = exports.ArrayEntityDataProvider = void 0;
+exports.SubscriptionChannel = exports.InMemoryLiveQueryStorage = exports.remult = exports.ValueConverters = exports.createValueValidator = exports.createValueValidatorWithArgs = exports.createValidatorWithArgs = exports.createValidator = exports.valueValidator = exports.Validators = exports.UrlBuilder = exports.Filter = exports.CompoundIdField = exports.Sort = exports.EventSource = exports.isBackend = exports.withRemult = exports.Remult = exports.Allow = exports.ForbiddenError = exports.ProgressListener = exports.BackendMethod = exports.Controller = exports.JsonEntityIndexedDbStorage = exports.JsonEntityOpfsStorage = exports.JsonDataProvider = exports.dbNamesOf = exports.CustomSqlFilterBuilder = exports.SqlDatabase = exports.InMemoryDataProvider = exports.RestDataProvider = exports.EntityError = exports.describeEntity = exports.describeBackendMethods = exports.describeClass = exports.IdEntity = exports.Relations = exports.Fields = exports.Field = exports.getEntityRef = exports.Entity = exports.CaptionTransformer = exports.ValueListInfo = exports.getValueList = exports.ValueListFieldType = exports.getFields = exports.FieldType = exports.ControllerBase = exports.EntityBase = exports.ArrayEntityDataProvider = void 0;
 exports.repo = repo;
 var array_entity_data_provider_js_1 = require("./src/data-providers/array-entity-data-provider.js");
 Object.defineProperty(exports, "ArrayEntityDataProvider", { enumerable: true, get: function () { return array_entity_data_provider_js_1.ArrayEntityDataProvider; } });
@@ -27,6 +27,8 @@ var classDescribers_js_1 = require("./src/remult3/classDescribers.js");
 Object.defineProperty(exports, "describeClass", { enumerable: true, get: function () { return classDescribers_js_1.describeClass; } });
 Object.defineProperty(exports, "describeBackendMethods", { enumerable: true, get: function () { return classDescribers_js_1.describeBackendMethods; } });
 Object.defineProperty(exports, "describeEntity", { enumerable: true, get: function () { return classDescribers_js_1.describeEntity; } });
+var data_interfaces_js_1 = require("./src/data-interfaces.js"); //V
+Object.defineProperty(exports, "EntityError", { enumerable: true, get: function () { return data_interfaces_js_1.EntityError; } });
 var rest_data_provider_js_1 = require("./src/data-providers/rest-data-provider.js"); //V
 Object.defineProperty(exports, "RestDataProvider", { enumerable: true, get: function () { return rest_data_provider_js_1.RestDataProvider; } });
 var in_memory_database_js_1 = require("./src/data-providers/in-memory-database.js"); //V

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "remult",
-    "version": "0.27.22",
+    "version": "0.27.23-next.1",
     "description": "A CRUD framework for full-stack TypeScript",
     "homepage": "https://remult.dev",
     "repository": {

package/server/remult-api-server.js

@@ -1195,7 +1195,8 @@ var ResponseBridgeToDataApiResponse = /** @class */ (function () {
                                 url: (_b = _this.genReq) === null || _b === void 0 ? void 0 : _b.url,
                                 method: (_c = _this.genReq) === null || _c === void 0 ? void 0 : _c.method,
                             });
-                            _this.setStatus(httpStatusCode).json(body);
+                            var json = tslib_1.__assign(tslib_1.__assign({}, body), { message: body.message });
+                            _this.setStatus(httpStatusCode).json(json);
                         };
                         return [4 /*yield*/, ((_a = this.handleError) === null || _a === void 0 ? void 0 : _a.call(this, {
                                 httpStatusCode: httpStatusCode,

package/src/data-api.d.ts

@@ -1,5 +1,5 @@
 import type { Remult } from './context.js';
-import type { ErrorInfo } from './data-interfaces.js';
+import { type ErrorInfo } from './data-interfaces.js';
 import { type EntityMetadata, type FindOptions, type Repository } from './remult3/remult3.js';
 import type { rowHelperImplementation } from './remult3/RepositoryImplementation.js';
 export declare class DataApi<T = unknown> {

package/src/data-api.js

@@ -5,6 +5,7 @@ exports.determineSort = determineSort;
 exports.serializeError = serializeError;
 var tslib_1 = require("tslib");
 var context_js_1 = require("./context.js");
+var data_interfaces_js_1 = require("./data-interfaces.js");
 var rest_data_provider_js_1 = require("./data-providers/rest-data-provider.js");
 var filter_interfaces_js_1 = require("./filter/filter-interfaces.js");
 var relationInfoMember_js_1 = require("./remult3/relationInfoMember.js");
@@ -1005,7 +1006,10 @@ function determineSort(sortUrlParm, dirUrlParam) {
     return result;
 }
 function serializeError(data) {
-    if (data instanceof TypeError) {
+    if (data instanceof data_interfaces_js_1.EntityError) {
+        data = { message: data.message, modelState: data.modelState };
+    }
+    else if (data instanceof Error) {
         data = { message: data.message, stack: data.stack };
     }
     var x = JSON.parse(JSON.stringify(data));

package/src/data-interfaces.d.ts

@@ -67,3 +67,12 @@ export interface ErrorInfo<entityType = unknown> {
     exception?: any;
     httpStatusCode?: number;
 }
+export declare class EntityError<entityType = unknown> extends Error implements ErrorInfo<entityType> {
+    constructor(errorInfo: ErrorInfo<entityType>);
+    modelState?: {
+        [Properties in keyof Partial<MembersOnly<entityType>>]?: string;
+    };
+    stack?: string;
+    exception?: any;
+    httpStatusCode?: number;
+}

package/src/data-interfaces.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntityError = void 0;
 exports.extractSort = extractSort;
+var tslib_1 = require("tslib");
 var sort_js_1 = require("./sort.js");
 function extractSort(sort) {
     if (sort instanceof Array) {
@@ -12,3 +14,13 @@ function extractSort(sort) {
     }
     return sort;
 }
+var EntityError = /** @class */ (function (_super) {
+    tslib_1.__extends(EntityError, _super);
+    function EntityError(errorInfo) {
+        var _this = _super.call(this, errorInfo.message) || this;
+        Object.assign(_this, errorInfo);
+        return _this;
+    }
+    return EntityError;
+}(Error));
+exports.EntityError = EntityError;

package/src/remult3/RepositoryImplementation.d.ts

@@ -7,7 +7,7 @@ import { Filter } from '../filter/filter-interfaces.js';
 import { type GroupByOptions, type GroupByResult, type ControllerRef, type ControllerRefForControllerBase, type EntityFilter, type EntityMetadata, type EntityOrderBy, type EntityRef, type EntityRefForEntityBase, type FieldRef, type FieldsMetadata, type FieldsRef, type FieldsRefForEntityBase, type FindFirstOptions, type FindFirstOptionsBase, type FindOptions, type IdMetadata, type LiveQuery, type LoadOptions, type MembersOnly, type NumericKeys, type Repository, type RepositoryRelations, type Subscribable, type idType } from './remult3.js';
 import type { QueryOptions, RefSubscriber, UpsertOptions } from './remult3.js';
 import type { entityEventListener } from '../__EntityValueProvider.js';
-import type { DataProvider, EntityDataProvider, EntityDataProviderGroupByOptions, EntityDataProviderFindOptions, ErrorInfo } from '../data-interfaces.js';
+import { type DataProvider, type EntityDataProvider, type EntityDataProviderGroupByOptions, type EntityDataProviderFindOptions, type ErrorInfo, EntityError } from '../data-interfaces.js';
 import type { Unsubscribe } from '../live-query/SubscriptionChannel.js';
 import { RelationLoader } from './relation-loader.js';
 import { type RepositoryInternal, getInternalKey } from './repository-internals.js';
@@ -114,7 +114,7 @@ declare abstract class rowHelperBase<T> {
         [key: string]: string | undefined;
     };
     protected __assertValidity(): void;
-    buildErrorInfoObject(): ErrorInfo<unknown>;
+    buildErrorInfoObject(): EntityError<unknown>;
     abstract get fields(): FieldsRef<T>;
     catchSaveErrors(err: any): any;
     __clearErrorsAndReportChanged(): void;
@@ -124,7 +124,7 @@ declare abstract class rowHelperBase<T> {
     originalValues: any;
     saveOriginalData(): void;
     saveMoreOriginalData(): void;
-    validate(): Promise<ErrorInfo<unknown> | undefined>;
+    validate(): Promise<EntityError<unknown> | undefined>;
     __validateEntity(): Promise<void>;
     __performColumnAndEntityValidations(): Promise<void>;
     toApiJson(includeRelatedEntities?: boolean, notJustApi?: boolean): any;

package/src/remult3/RepositoryImplementation.js

@@ -21,6 +21,7 @@ var filter_interfaces_js_1 = require("../filter/filter-interfaces.js");
 var sort_js_1 = require("../sort.js");
 var remult3_js_1 = require("./remult3.js");
 var assign_js_1 = require("../../assign.js");
+var data_interfaces_js_1 = require("../data-interfaces.js");
 var valueConverters_js_1 = require("../valueConverters.js");
 var rest_data_provider_js_1 = require("../data-providers/rest-data-provider.js");
 var remult_proxy_js_1 = require("../remult-proxy.js");
@@ -1966,7 +1967,7 @@ var rowHelperBase = /** @class */ (function () {
                 finally { if (e_29) throw e_29.error; }
             }
         }
-        return error;
+        return new data_interfaces_js_1.EntityError(error);
     };
     rowHelperBase.prototype.catchSaveErrors = function (err) {
         var _this = this;
@@ -3377,12 +3378,12 @@ var columnDefsImpl = /** @class */ (function () {
                         }
                         catch (err) {
                             var error = "".concat(String(prop), " failed for value ").concat(args === null || args === void 0 ? void 0 : args[0], ". Error: ").concat(typeof err === 'string' ? err : err.message);
-                            throw {
+                            throw new data_interfaces_js_1.EntityError({
                                 message: _this.caption + ': ' + error,
                                 modelState: (_a = {},
                                     _a[_this.key] = error,
                                     _a),
-                            };
+                            });
                         }
                     };
                 }

package/src/remult3/remult3.js

@@ -20,6 +20,8 @@ var wnn = [
 exports.flags = {
     error500RetryCount: 4,
 };
+//p1 - make error info an actual error, important for exception handling, and also for auth.js errors that were mistic
+//p1 - add validators min,max,between(range)
 //p1 - allow experimental route registration on remult server, with at least get route, and support redirect, read header and set header - (and the existing get html etc...)
 //p2 - add parameter all to deleteMany, and updateMany
 //p2  filter.apply ApiPreFilter

package/src/validators.d.ts

@@ -1,50 +1,129 @@
 import type { FieldValidator } from './column-interfaces.js';
 import type { ValidateFieldEvent } from './remult3/remult3.js';
+/**
+ * Class containing various field validators.
+ */
 export declare class Validators {
+    /**
+     * Validator to check if a value is required (not null or empty).
+     */
     static required: Validator<unknown>;
+    /**
+     * Validator to ensure a value is unique in the database.
+     */
     static unique: Validator<unknown>;
     /**
      * @deprecated use `unique` instead - it also runs only on the backend
+     * Validator to ensure a value is unique on the backend.
      */
     static uniqueOnBackend: Validator<unknown>;
+    /**
+     * Validator to check if a value matches a given regular expression.
+     */
     static regex: ValidatorWithArgs<string, RegExp> & {
         defaultMessage: ValueValidationMessage<RegExp>;
     };
+    /**
+     * Validator to check if a value is a valid email address.
+     */
     static email: Validator<string>;
+    /**
+     * Validator to check if a value is a valid URL.
+     */
     static url: Validator<string>;
+    /**
+     * Validator to check if a value is one of the specified values.
+     */
     static in: <T>(value: readonly T[], withMessage?: ValueValidationMessage<T[]>) => FieldValidator<unknown, T> & {
         withMessage: ValueValidationMessage<T[]>;
     };
+    /**
+     * Validator to check if a value is not null.
+     */
     static notNull: Validator<unknown>;
+    /**
+     * Validator to check if a value exists in a given enum.
+     */
     static enum: ValidatorWithArgs<unknown, unknown> & {
         defaultMessage: ValueValidationMessage<unknown>;
     };
+    /**
+     * Validator to check if a related value exists in the database.
+     */
     static relationExists: Validator<unknown>;
+    /**
+     * Validator to check if a value is greater than or equal to a minimum value.
+     */
+    static min: ValidatorWithArgs<number, number> & {
+        defaultMessage: ValueValidationMessage<number>;
+    };
+    /**
+     * Validator to check if a value is less than or equal to a maximum value.
+     */
+    static max: ValidatorWithArgs<number, number> & {
+        defaultMessage: ValueValidationMessage<number>;
+    };
+    /**
+     * Validator to check if a string's length is less than or equal to a maximum length.
+     */
     static maxLength: ValidatorWithArgs<string, number> & {
         defaultMessage: ValueValidationMessage<number>;
     };
+    /**
+     * Validator to check if a string's length is greater than or equal to a minimum length.
+     */
     static minLength: ValidatorWithArgs<string, number> & {
         defaultMessage: ValueValidationMessage<number>;
     };
     static defaultMessage: string;
 }
+/**
+ * Type representing a field validator with an optional message.
+ */
 export type Validator<valueType> = FieldValidator<unknown, valueType> & ((message?: ValidationMessage<valueType, undefined>) => FieldValidator<unknown, valueType>) & {
     defaultMessage: ValidationMessage<valueType, undefined>;
     /**
-     * @deprecated  use (message:string) instead - for example: Validators.required("Is needed")
+     * @deprecated use (message:string) instead - for example: Validators.required("Is needed")
      */
     withMessage(message: ValidationMessage<valueType, undefined>): FieldValidator<unknown, valueType>;
 };
+/**
+ * Function to create a validator with a custom validation function.
+ */
 export declare function createValidator<valueType>(validate: (entity: any, e: ValidateFieldEvent<any, valueType>) => Promise<boolean | string> | boolean | string, defaultMessage?: ValidationMessage<valueType, undefined>): Validator<valueType>;
+/**
+ * Function to create a value validator.
+ */
 export declare function valueValidator<valueType>(validate: (value: valueType) => boolean | string | Promise<boolean | string>, defaultMessage?: string): (entity: any, e: ValidateFieldEvent<any, valueType>) => string | boolean | Promise<string | boolean>;
+/**
+ * Function to create a value validator with arguments.
+ */
 export declare function createValueValidator<valueType>(validate: (value: valueType) => boolean | string | Promise<boolean | string>, defaultMessage?: ValidationMessage<valueType, undefined>): Validator<valueType>;
+/**
+ * Function to create a value validator with arguments and a custom message.
+ */
 export declare function createValueValidatorWithArgs<valueType, argsType>(validate: (value: valueType, args: argsType) => boolean | string | Promise<boolean | string>, defaultMessage?: ValueValidationMessage<argsType>): ValidatorWithArgs<valueType, argsType> & {
     defaultMessage: ValueValidationMessage<argsType>;
 };
+/**
+ * Type representing a validation message that can be a string or a function.
+ */
 export type ValueValidationMessage<argsType> = string | ((args: argsType) => string);
+/**
+ * Type representing a validation message with additional parameters.
+ */
 export type ValidationMessage<valueType, argsType> = string | ((entity: any, event: ValidateFieldEvent<any, valueType>, args: argsType) => string);
+/**
+ * Type representing a validator with arguments.
+ */
 export type ValidatorWithArgs<valueType, argsType> = (args: argsType, message?: ValidationMessage<valueType, argsType>) => FieldValidator<unknown, valueType>;
+/**
+ * Function to create a validator with arguments and a custom message.
+ */
 export declare function createValidatorWithArgs<valueType, argsType>(validate: (entity: any, e: ValidateFieldEvent<any, valueType>, args: argsType) => Promise<boolean | string> | boolean | string, defaultMessage: ValidationMessage<valueType, argsType>): ValidatorWithArgs<valueType, argsType> & {
     defaultMessage: ValidationMessage<valueType, argsType>;
 };
+/**
+ * Function to get the values of an enum.
+ */
 export declare function getEnumValues<theEnum>(enumObj: theEnum): any[];

package/src/validators.js

@@ -9,11 +9,17 @@ exports.createValidatorWithArgs = createValidatorWithArgs;
 exports.getEnumValues = getEnumValues;
 var tslib_1 = require("tslib");
 var internals_js_1 = require("../internals.js");
+/**
+ * Class containing various field validators.
+ */
 var Validators = /** @class */ (function () {
     function Validators() {
     }
     var _a;
     _a = Validators;
+    /**
+     * Validator to check if a value is required (not null or empty).
+     */
     Validators.required = createValidator(function (_, e) { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
         return tslib_1.__generator(_a, function (_b) {
             return [2 /*return*/, !e.valueIsNull() &&
@@ -21,6 +27,9 @@ var Validators = /** @class */ (function () {
                     (e.value !== undefined || (0, internals_js_1.getRelationFieldInfo)(e.metadata) !== undefined)];
         });
     }); }, 'Should not be empty');
+    /**
+     * Validator to ensure a value is unique in the database.
+     */
     Validators.unique = createValidator(function (_, e) { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
         var _b;
         return tslib_1.__generator(_a, function (_c) {
@@ -39,6 +48,7 @@ var Validators = /** @class */ (function () {
     }); }, 'already exists');
     /**
      * @deprecated use `unique` instead - it also runs only on the backend
+     * Validator to ensure a value is unique on the backend.
      */
     Validators.uniqueOnBackend = createValidator(function (_, e) { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
         var _b;
@@ -54,11 +64,23 @@ var Validators = /** @class */ (function () {
             }
         });
     }); }, _a.unique.defaultMessage);
+    /**
+     * Validator to check if a value matches a given regular expression.
+     */
     Validators.regex = createValueValidatorWithArgs(function (val, regex) {
         return regex.test(val);
     });
+    /**
+     * Validator to check if a value is a valid email address.
+     */
     Validators.email = createValueValidator(function (val) { return /^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(val); }, 'Invalid Email');
+    /**
+     * Validator to check if a value is a valid URL.
+     */
     Validators.url = createValueValidator(function (val) { return !!new URL(val); }, 'Invalid Url');
+    /**
+     * Validator to check if a value is one of the specified values.
+     */
     Validators.in = createValueValidatorWithArgs(function (val, values) { return values.includes(val); }, function (values) {
         return "Value must be one of: ".concat(values
             .map(function (y) {
@@ -70,10 +92,19 @@ var Validators = /** @class */ (function () {
         })
             .join(', '));
     });
+    /**
+     * Validator to check if a value is not null.
+     */
     Validators.notNull = createValueValidator(function (val) { return val != null; }, 'Should not be null');
+    /**
+     * Validator to check if a value exists in a given enum.
+     */
     Validators.enum = createValueValidatorWithArgs(function (value, enumObj) { return Object.values(enumObj).includes(value); }, function (enumObj) {
         return "Value must be one of ".concat(getEnumValues(enumObj).join(', '));
     });
+    /**
+     * Validator to check if a related value exists in the database.
+     */
     Validators.relationExists = createValidator(function (_, e) { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
         var _b;
         return tslib_1.__generator(_a, function (_c) {
@@ -89,12 +120,29 @@ var Validators = /** @class */ (function () {
             }
         });
     }); }, 'Relation value does not exist');
+    /**
+     * Validator to check if a value is greater than or equal to a minimum value.
+     */
+    Validators.min = createValueValidatorWithArgs(function (val, minValue) { return val >= minValue; }, function (minValue) { return "Value must be bigger than or equal to ".concat(minValue); });
+    /**
+     * Validator to check if a value is less than or equal to a maximum value.
+     */
+    Validators.max = createValueValidatorWithArgs(function (val, maxValue) { return val <= maxValue; }, function (maxValue) { return "Value must be smaller than or equal to ".concat(maxValue); });
+    /**
+     * Validator to check if a string's length is less than or equal to a maximum length.
+     */
     Validators.maxLength = createValueValidatorWithArgs(function (val, maxLength) { return val.length <= maxLength; }, function (maxLength) { return "Value must be at most ".concat(maxLength, " characters"); });
+    /**
+     * Validator to check if a string's length is greater than or equal to a minimum length.
+     */
     Validators.minLength = createValueValidatorWithArgs(function (val, minLength) { return val.length >= minLength; }, function (maxLength) { return "Value must be at least ".concat(maxLength, " characters"); });
     Validators.defaultMessage = 'Invalid value';
     return Validators;
 }());
 exports.Validators = Validators;
+/**
+ * Function to create a validator with a custom validation function.
+ */
 function createValidator(validate, defaultMessage) {
     var _this = this;
     var validation = function (entity, e, message) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
@@ -149,11 +197,17 @@ function createValidator(validate, defaultMessage) {
         },
     });
 }
+/**
+ * Function to create a value validator.
+ */
 function valueValidator(validate, defaultMessage) {
     return function (entity, e) {
         return validate(e.value) || defaultMessage || false;
     };
 }
+/**
+ * Function to create a value validator with arguments.
+ */
 function createValueValidator(validate, defaultMessage) {
     return createValidator(function (_, e) {
         if (e.value === undefined || e.value === null)
@@ -161,6 +215,9 @@ function createValueValidator(validate, defaultMessage) {
         return validate(e.value);
     }, defaultMessage);
 }
+/**
+ * Function to create a value validator with arguments and a custom message.
+ */
 function createValueValidatorWithArgs(validate, defaultMessage) {
     var result = createValidatorWithArgsInternal(function (_, e, args) {
         if (e.value === undefined || e.value === null)
@@ -179,6 +236,9 @@ function createValueValidatorWithArgs(validate, defaultMessage) {
         },
     });
 }
+/**
+ * Function to create a validator with arguments and a custom message.
+ */
 function createValidatorWithArgs(validate, defaultMessage) {
     return createValidatorWithArgsInternal(validate, defaultMessage);
 }
@@ -221,6 +281,9 @@ function createValidatorWithArgsInternal(validate, defaultMessage, isValueValida
         },
     });
 }
+/**
+ * Function to get the values of an enum.
+ */
 function getEnumValues(enumObj) {
     return Object.values(enumObj).filter(function (x) { return typeof enumObj[x] !== 'number'; });
 }