chore: adds property validators

README.md

@@ -9,6 +9,7 @@
 - [Источник данных](#Источник-данных)
 - [Модель](#Модель)
 - [Свойства](#Свойства)
+- [Валидаторы](#Валидаторы)
 - [Репозиторий](#Репозиторий)
 - [Фильтрация](#Фильтрация)
 - [Связи](#Связи)
@@ -221,6 +222,7 @@ schema.defineModel({
 - `columnType: string` тип колонки (определяется адаптером)
 - `required: boolean` объявить свойство обязательным
 - `default: any` значение по умолчанию
+- `validate: string | array | object` см. [Валидаторы](#Валидаторы)
 
 **Примеры**
 
@@ -274,6 +276,35 @@ schema.defineModel({
 });
 ```
 
+## Валидаторы
+
+Кроме проверки типа, более конкретные условия можно задать с помощью
+валидаторов, через которые будет проходить значение перед записью в базу.
+
+- `minLength: string` минимальная длинна строки или массива
+- `maxLength: string` максимальная длинна строки или массива
+
+**Пример**
+
+Валидаторы указываются в объявлении свойства модели параметром
+`validate`, который принимает объект с названиями валидаторов
+и их настройками.
+
+```js
+schema.defineModel({
+  name: 'user',
+  properties: {
+    name: {
+      type: DataType.STRING,
+      validate: { // валидаторы свойства "name"
+        minLength: 2, // минимальная длинна строки
+        maxLength: 24, // максимальная длинна строки
+      },
+    },
+  },
+});
+```
+
 ## Репозиторий
 
 Выполняет операции чтения и записи документов определенной модели.

docs/assets/navigation.js

@@ -1 +1 @@
-window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA6WZa2/bNhSG/4s+B8satN2Wb07iYkbr2FCdFsEwBJx0YrOlSI08KqIO+++FbMuSeDmk0a9+3/Pwcng5lP/6L0N4wew6u2PINm0N2UVWM9xl1xnIpjKX/e+/7LAS2UX2lcsyu/79/4shEgqlGSq9YXoL6IW4ljAvB8GQK+kDjbUwYVayGkEPwYVgxoC5PArTyFdXntgPipUE4SAncHLYcoO6DZJ6A8W6AaHk1mxUDkaJb75+ORaK1+XUqEYXcAfPXPJuRj8xwcsuRS6btJPtnOzhaXA9FPEdB1GaW8EaAxulhMuzHRTtT2aWTLbhWbUMEdZKAoka6RRpIQvRlEAN0rHQvG9dsmZ621Qgca61L8k+VwJ1VcN+Y39iogEa7Vop/lKVILqV95F1y+O7b05dTxKRWOquJ048LeAH5MKEmFPXGdRob8/bk/cKF1UtoEsylIGMeUwUs88stWRdD0nUJdC4qYFirTWvmG7fQ2uSZpX20y2pGjRySG2IsFPt5PAMGmQBkePL76PJh/s1bQCUm26lVoaj8t0Hg5ZGCN8srocifix2UDGXcvidjBS8IE9ry0CxPu9AkyzLQFYgsjwYBwqXCPqZFV350atTxNWbtyPErZIGdVNMsj+CjHQKs9JER3qRAsxku/rnCxQ4ELCt96M4Clb0r3/89urNla+EGpaqzfJYYtS7+bvZw4fN0zpfLGf549P7+ePTOl+t5/nm8el+tpzbbUQDoi16ajGnEY8nxh2XTTZvrMU5AsFJd88ZtChHMERwhnb8ORrdCHE8XdvwPPldMfaxJgxjHUMCcSWJfNp6jLcoQSLH1ub0v0fjx9WlAxmLURJCRa0IW4/xTuWZDToJaYTgVFtyEm1ReimLMhZ9DwahJGfbY4lSla6Y4N+hpPa035XOpnvtt8Xo0xLRhk7VOKvLHxMPUoAxOfzbcA2lm6qQL8of6k8HOUgxyppp5EzcOFv1JCQSPnPcqQbd8dl6lKdEm3BXBmwpdOd47Pp2+C7Uldy+liIhP9lqX8Xes8rJ5Rmhib2YnORJQycifq7NhIEnREb7cHrl+LeLrSfyiAv4/DvdjViyOo5dsjpGnj7Bwn0O+eL8QyYosu04n+mZDa8pRh69XmzeSIpSQodd8ilXsJrj/oYaEM+NLPaP2ctBnXLevh4jhOr2BtReQi8SAHjZX42H58t0+w8gx0QAt4C3qPR0Nw+okUxDyO/5E170s76N3n/6u2nXHcuPHDkIFDe3kyfpgDgoZOi60WC/JseAQScwBgQUSCfP9lA4LreNYDqwIkcyBUHN5bb7C2ALL951OXU4qL9/AK5YS0UPGgAA"
+window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA6WZ227bOBCG30XXwWYbtN3d3DmOixqtY0N1WgRFEbDSxGZLkVqSKqIu9t0LWZZF8TCk0Vv9/3w8DA9D+/N/mYZnnV1nt0STbVtDdpHVRO+z6wx4U6nL4fsfe12x7CL7TnmZXf/9/8UYCYWQRAu5JXIH2gtxLWFeDoxoKrgPZGphwqwktQY5BheMKAXq8ihMI19ceWLfC1IihF5O4OSwo0rLNkgaDBjrBpjgO7UVOSjBfvj65VgwXpdTJRpZwC08UU67Gf1IGC27FLls1I62c7KHp8H1YMQ3FFip5ow0CrZCMJdnOzDaW6JWhLfhWbUMEdaaA4oydIy05AVrSsAG6Vhw3o8uWTO5ayrgeiGlL8k+VwJ1XcNhY38krAEc7Vox/kqUwLqV94F0y+Onb05dTxIRWequJ048LeB7TZkKMaeuM6jR3p63J++EXlY1gy7JUAYy5jFhzCGz2JJ1PShRloDjpgaMtZG0IrJ9B61KmlXcj7ckapCaQmpDiD2hnfZkDh+vQSvGz+EJJPACIsej34eT+/s7bYIwN95KLRTVwjcho5ZGCE+t68GIH4o9VMSl9N/RSEYL9DawDBjr0x4kyrIMaIXDy944UijXIJ9I0ZU3gzpFXL16bSDmgistm2KSfQNi6BhmLZGODCIGmPF2/fUbFHok6LY+jOIoWNF//vPXi1dXvhJtXKo2y2OJUW8Xb2b377ePm3y5muUPj+8WD4+bfL1Z5NuHx7vZamG3EQ2Ituip9ZxGPJ4Y1yzLbJ6pxTlMg5PugTNqUQ4jWoMztOPnaHTD2HCyhufJ74qxjzVnGOsYEohrjuTT1mO8ZQlcU93anOF7NN6sXh2IKUZJGipsRdh6jHcq/2zQSUgjBKfakpNoy9JLWZax6DtQGkp0tj2WKFXIijD6E0psT/td6Wy8135bjD4tQW3oVI2zuvwRds8ZKJXDvw2VULqpCvmi/LG+dZCjFKNsiNSUsBtnq56ERMInqvei0e74bD3KE6xNuCsDthS6czx2fet/d+pKel9LkZDfbHWoYu9I5eTyjNDEXkxO8qShIxG/12bCwBMio304vaL828XWE3nIBXz+ne5GrEgdx65InUo+vougP2/cVPttZ9LNKt3Ldcr0OHEu+EGKgY++GH/6JA3nMOSL8/uViZFtx/lMz+rwmmJk4zVn8wwpSgkd/smnfkFqqg839oh4anhxWISXozrlvH5pIpjozgqovYRBRADwfCgV+ufc9DgcQY4JAe5Az7WQ09NtRBkyDkH/P5nwon+j2OjDT6037aZj+ZGGA0FRNZ9s/hHRK2joppFgv65NwKgjGAUMCo0nz/ZgOMp3DSMysCINGYNoSfmu+8tlB8/edTl1OKgvvwBP4V6kfxsAAA=="

docs/modules.html

@@ -22,6 +22,7 @@
 <a href="classes/OrderClauseTool.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Order<wbr/>Clause<wbr/>Tool</span></a>
 <a href="classes/PrimaryKeysDefinitionValidator.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Primary<wbr/>Keys<wbr/>Definition<wbr/>Validator</span></a>
 <a href="classes/PropertiesDefinitionValidator.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Properties<wbr/>Definition<wbr/>Validator</span></a>
+<a href="classes/PropertyValidatorRegistry.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Property<wbr/>Validator<wbr/>Registry</span></a>
 <a href="classes/ReferencesManyResolver.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>References<wbr/>Many<wbr/>Resolver</span></a>
 <a href="classes/RelationsDefinitionValidator.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Relations<wbr/>Definition<wbr/>Validator</span></a>
 <a href="classes/Repository.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Repository</span></a>
@@ -64,6 +65,9 @@
 <a href="types/PropertiesClause.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Properties<wbr/>Clause</span></a>
 <a href="types/PropertyDefinition.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Property<wbr/>Definition</span></a>
 <a href="types/PropertyDefinitionMap.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Property<wbr/>Definition<wbr/>Map</span></a>
+<a href="types/PropertyValidateOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Property<wbr/>Validate<wbr/>Options</span></a>
+<a href="types/PropertyValidator.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Property<wbr/>Validator</span></a>
+<a href="types/PropertyValidatorContext.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Property<wbr/>Validator<wbr/>Context</span></a>
 <a href="types/ReferencesManyDefinition.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>References<wbr/>Many<wbr/>Definition</span></a>
 <a href="types/RelationDefinition.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Relation<wbr/>Definition</span></a>
 <a href="types/RelationDefinitionMap.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Relation<wbr/>Definition<wbr/>Map</span></a>

package.json

@@ -37,7 +37,7 @@
   },
   "devDependencies": {
     "@commitlint/cli": "^18.6.1",
-    "@commitlint/config-conventional": "^18.6.1",
+    "@commitlint/config-conventional": "^18.6.2",
     "@types/chai": "^4.3.11",
     "@types/chai-as-promised": "^7.1.8",
     "@types/mocha": "^10.0.6",

src/adapter/decorator/data-validation-decorator.js

@@ -21,32 +21,40 @@ export class DataValidationDecorator extends Service {
       );
 
     const create = adapter.create;
-    adapter.create = function (modelName, modelData, filter) {
-      this.getService(ModelDataValidator).validate(modelName, modelData);
+    adapter.create = async function (modelName, modelData, filter) {
+      await this.getService(ModelDataValidator).validate(modelName, modelData);
       return create.call(this, modelName, modelData, filter);
     };
 
     const replaceById = adapter.replaceById;
-    adapter.replaceById = function (modelName, id, modelData, filter) {
-      this.getService(ModelDataValidator).validate(modelName, modelData);
+    adapter.replaceById = async function (modelName, id, modelData, filter) {
+      await this.getService(ModelDataValidator).validate(modelName, modelData);
       return replaceById.call(this, modelName, id, modelData, filter);
     };
 
     const replaceOrCreate = adapter.replaceOrCreate;
-    adapter.replaceOrCreate = function (modelName, modelData, filter) {
-      this.getService(ModelDataValidator).validate(modelName, modelData);
+    adapter.replaceOrCreate = async function (modelName, modelData, filter) {
+      await this.getService(ModelDataValidator).validate(modelName, modelData);
       return replaceOrCreate.call(this, modelName, modelData, filter);
     };
 
     const patch = adapter.patch;
-    adapter.patch = function (modelName, modelData, where) {
-      this.getService(ModelDataValidator).validate(modelName, modelData, true);
+    adapter.patch = async function (modelName, modelData, where) {
+      await this.getService(ModelDataValidator).validate(
+        modelName,
+        modelData,
+        true,
+      );
       return patch.call(this, modelName, modelData, where);
     };
 
     const patchById = adapter.patchById;
-    adapter.patchById = function (modelName, id, modelData, filter) {
-      this.getService(ModelDataValidator).validate(modelName, modelData, true);
+    adapter.patchById = async function (modelName, id, modelData, filter) {
+      await this.getService(ModelDataValidator).validate(
+        modelName,
+        modelData,
+        true,
+      );
       return patchById.call(this, modelName, id, modelData, filter);
     };
   }

src/adapter/decorator/data-validation-decorator.spec.js

@@ -74,4 +74,44 @@ describe('DataValidationDecorator', function () {
     expect(V.validate).to.be.called.once;
     expect(V.validate).to.be.called.with.exactly('model', data, true);
   });
+
+  it('waits the validator execution in the "create" method', async function () {
+    const schema = new Schema();
+    schema.defineModel({name: 'model'});
+    const adapter = S.getService(TestAdapter);
+    const validator = S.getService(ModelDataValidator);
+    validator.validate = () => Promise.reject('rejected');
+    const promise = adapter.create('model', {});
+    await expect(promise).to.be.rejectedWith('rejected');
+  });
+
+  it('waits the validator execution in the "replaceById" method', async function () {
+    const schema = new Schema();
+    schema.defineModel({name: 'model'});
+    const adapter = S.getService(TestAdapter);
+    const validator = S.getService(ModelDataValidator);
+    validator.validate = () => Promise.reject('rejected');
+    const promise = adapter.replaceById('model', 1, {});
+    await expect(promise).to.be.rejectedWith('rejected');
+  });
+
+  it('waits the validator execution in the "replaceOrCreate" method', async function () {
+    const schema = new Schema();
+    schema.defineModel({name: 'model'});
+    const adapter = S.getService(TestAdapter);
+    const validator = S.getService(ModelDataValidator);
+    validator.validate = () => Promise.reject('rejected');
+    const promise = adapter.replaceOrCreate('model', {});
+    await expect(promise).to.be.rejectedWith('rejected');
+  });
+
+  it('waits the validator execution in the "patchById" method', async function () {
+    const schema = new Schema();
+    schema.defineModel({name: 'model'});
+    const adapter = S.getService(TestAdapter);
+    const validator = S.getService(ModelDataValidator);
+    validator.validate = () => Promise.reject('rejected');
+    const promise = adapter.patchById('model', 1, {});
+    await expect(promise).to.be.rejectedWith('rejected');
+  });
 });

src/definition/model/model-data-validator.d.ts

@@ -1,6 +1,5 @@
 import {ModelData} from '../../types.js';
 import {Service} from '@e22m4u/js-service';
-import {PropertyDefinition} from './properties/index.js';
 
 /**
  * Model data validator.
@@ -13,20 +12,9 @@ export declare class ModelDataValidator extends Service {
    * @param modelData
    * @param isPartial
    */
-  validate(modelName: string, modelData: ModelData, isPartial?: boolean): void;
-
-  /**
-   * Validate property value.
-   *
-   * @param modelName
-   * @param propName
-   * @param propDef
-   * @param propValue
-   */
-  validatePropertyValue(
+  validate(
     modelName: string,
-    propName: string,
-    propDef: PropertyDefinition,
-    propValue: unknown,
-  ): void;
+    modelData: ModelData,
+    isPartial?: boolean,
+  ): Promise<void>;
 }

src/definition/model/model-data-validator.js

@@ -3,6 +3,7 @@ import {DataType} from './properties/index.js';
 import {getCtorName} from '../../utils/index.js';
 import {isPureObject} from '../../utils/index.js';
 import {InvalidArgumentError} from '../../errors/index.js';
+import {PropertyValidatorRegistry} from './properties/index.js';
 import {ModelDefinitionUtils} from './model-definition-utils.js';
 
 /**
@@ -15,8 +16,9 @@ export class ModelDataValidator extends Service {
    * @param {string} modelName
    * @param {object} modelData
    * @param {boolean} isPartial
+   * @returns {Promise<void>}
    */
-  validate(modelName, modelData, isPartial = false) {
+  async validate(modelName, modelData, isPartial = false) {
     if (!isPureObject(modelData))
       throw new InvalidArgumentError(
         'The data of the model %v should be an Object, but %v given.',
@@ -28,16 +30,16 @@ export class ModelDataValidator extends Service {
         ModelDefinitionUtils,
       ).getPropertiesDefinitionInBaseModelHierarchy(modelName);
     const propNames = Object.keys(isPartial ? modelData : propDefs);
-    propNames.forEach(propName => {
+    for (const propName of propNames) {
       const propDef = propDefs[propName];
-      if (!propDef) return;
-      this._validatePropertyValue(
+      if (!propDef) continue;
+      await this._validatePropertyValue(
         modelName,
         propName,
         propDef,
         modelData[propName],
       );
-    });
+    }
   }
 
   /**
@@ -47,8 +49,9 @@ export class ModelDataValidator extends Service {
    * @param {string} propName
    * @param {string|object} propDef
    * @param {*} propValue
+   * @returns {Promise<void>}
    */
-  _validatePropertyValue(modelName, propName, propDef, propValue) {
+  async _validatePropertyValue(modelName, propName, propDef, propValue) {
     // undefined and null
     if (propValue == null) {
       const isRequired =
@@ -62,7 +65,19 @@ export class ModelDataValidator extends Service {
       );
     }
     // DataType
-    this._validatePropertyValueType(modelName, propName, propDef, propValue);
+    await this._validatePropertyValueType(
+      modelName,
+      propName,
+      propDef,
+      propValue,
+    );
+    // PropertyValidators
+    await this._validateByPropertyValidators(
+      modelName,
+      propName,
+      propDef,
+      propValue,
+    );
   }
 
   /**
@@ -73,9 +88,9 @@ export class ModelDataValidator extends Service {
    * @param {string|object} propDef
    * @param {*} propValue
    * @param {boolean} isArrayValue
-   * @returns {void}
+   * @returns {Promise<void>}
    */
-  _validatePropertyValueType(
+  async _validatePropertyValueType(
     modelName,
     propName,
     propDef,
@@ -123,7 +138,7 @@ export class ModelDataValidator extends Service {
       // ARRAY
       case DataType.ARRAY:
         if (!Array.isArray(propValue)) throw createError('an Array');
-        propValue.forEach(value =>
+        const arrayItemsValidationPromises = propValue.map(async value =>
           this._validatePropertyValueType(
             modelName,
             propName,
@@ -132,13 +147,74 @@ export class ModelDataValidator extends Service {
             true,
           ),
         );
+        await Promise.all(arrayItemsValidationPromises);
         break;
       // OBJECT
       case DataType.OBJECT:
         if (!isPureObject(propValue)) throw createError('an Object');
         if (typeof propDef === 'object' && propDef.model)
-          this.validate(propDef.model, propValue);
+          await this.validate(propDef.model, propValue);
         break;
     }
   }
+
+  /**
+   * Validate by property validators.
+   *
+   * @param {string} modelName
+   * @param {string} propName
+   * @param {string|object} propDef
+   * @param {*} propValue
+   * @returns {Promise<void>}
+   */
+  async _validateByPropertyValidators(modelName, propName, propDef, propValue) {
+    if (typeof propDef === 'string' || propDef.validate == null) return;
+    const options = propDef.validate;
+    const propertyValidatorRegistry = this.getService(
+      PropertyValidatorRegistry,
+    );
+    const createError = validatorName =>
+      new InvalidArgumentError(
+        'The property %v of the model %v has an invalid value %v ' +
+          'that caught by the validator %v.',
+        propName,
+        modelName,
+        propValue,
+        validatorName,
+      );
+    const container = this.container;
+    const validateBy = async (validatorName, validatorOptions = undefined) => {
+      const validator = propertyValidatorRegistry.getValidator(validatorName);
+      const context = {validatorName, modelName, propName, propDef, container};
+      const valid = await validator(propValue, validatorOptions, context);
+      if (valid !== true) throw createError(validatorName);
+    };
+    if (options && typeof options === 'string') {
+      await validateBy(options);
+    } else if (Array.isArray(options)) {
+      const validationPromises = options.map(validatorName =>
+        validateBy(validatorName),
+      );
+      await Promise.all(validationPromises);
+    } else if (options !== null && typeof options === 'object') {
+      const validationPromises = [];
+      Object.keys(options).forEach(validatorName => {
+        if (Object.prototype.hasOwnProperty.call(options, validatorName)) {
+          const validatorOptions = options[validatorName];
+          const validationPromise = validateBy(validatorName, validatorOptions);
+          validationPromises.push(validationPromise);
+        }
+      });
+      await Promise.all(validationPromises);
+    } else {
+      throw new InvalidArgumentError(
+        'The provided option "validate" of the property %v in the model %v ' +
+          'should be a non-empty String, an Array of String or an Object, ' +
+          'but %v given.',
+        propName,
+        modelName,
+        options,
+      );
+    }
+  }
 }

src/definition/model/properties/index.d.ts

@@ -1,4 +1,5 @@
 export * from './data-type.js';
 export * from './property-definition.js';
+export * from './property-validator/index.js';
 export * from './properties-definition-validator.js';
 export * from './primary-keys-definition-validator.js';

src/definition/model/properties/index.js

@@ -1,4 +1,5 @@
 export * from './data-type.js';
 export * from './property-definition.js';
+export * from './property-validator/index.js';
 export * from './properties-definition-validator.js';
 export * from './primary-keys-definition-validator.js';