@e22m4u/js-repository 0.3.3 → 0.5.0

package/src/definition/model/model-definition-utils.js

@@ -317,7 +317,7 @@ export class ModelDefinitionUtils extends Service {
     ) {
       throw new InvalidArgumentError(
         'The argument "propDef" of the ModelDefinitionUtils.getDataTypeFromPropertyDefinition ' +
-          'should be an Object or the DataType enum, but %v given.',
+          'should be an Object or the DataType enum, but %v was given.',
         propDef,
       );
     }
@@ -326,7 +326,7 @@ export class ModelDefinitionUtils extends Service {
     if (!Object.values(DataType).includes(dataType))
       throw new InvalidArgumentError(
         'The given Object to the ModelDefinitionUtils.getDataTypeFromPropertyDefinition ' +
-          'should have the "type" property with one of values: %l, but %v given.',
+          'should have the "type" property with one of values: %l, but %v was given.',
         Object.values(DataType),
         propDef.type,
       );
@@ -467,7 +467,7 @@ export class ModelDefinitionUtils extends Service {
     if (!modelData || typeof modelData !== 'object' || Array.isArray(modelData))
       throw new InvalidArgumentError(
         'The second argument of ModelDefinitionUtils.excludeObjectKeysByRelationNames ' +
-          'should be an Object, but %v given.',
+          'should be an Object, but %v was given.',
         modelData,
       );
     const relDefs = this.getRelationsDefinitionInBaseModelHierarchy(modelName);
@@ -487,14 +487,14 @@ export class ModelDefinitionUtils extends Service {
       throw new InvalidArgumentError(
         'Parameter "modelName" of ' +
           'ModelDefinitionUtils.getModelNameOfPropertyValueIfDefined ' +
-          'requires a non-empty String, but %v given.',
+          'requires a non-empty String, but %v was given.',
         modelName,
       );
     if (!propertyName || typeof propertyName !== 'string')
       throw new InvalidArgumentError(
         'Parameter "propertyName" of ' +
           'ModelDefinitionUtils.getModelNameOfPropertyValueIfDefined ' +
-          'requires a non-empty String, but %v given.',
+          'requires a non-empty String, but %v was given.',
         propertyName,
       );
     // если определение свойства не найдено,

package/src/definition/model/model-definition-utils.spec.js

@@ -1224,7 +1224,7 @@ describe('ModelDefinitionUtils', function () {
       const error = v =>
         format(
           'The argument "propDef" of the ModelDefinitionUtils.getDataTypeFromPropertyDefinition ' +
-            'should be an Object or the DataType enum, but %s given.',
+            'should be an Object or the DataType enum, but %s was given.',
           v,
         );
       expect(throwable('str')).to.throw(error('"str"'));
@@ -1247,7 +1247,7 @@ describe('ModelDefinitionUtils', function () {
       const error = v =>
         format(
           'The given Object to the ModelDefinitionUtils.getDataTypeFromPropertyDefinition ' +
-            'should have the "type" property with one of values: %l, but %s given.',
+            'should have the "type" property with one of values: %l, but %s was given.',
           Object.values(DataType),
           v,
         );
@@ -1927,7 +1927,7 @@ describe('ModelDefinitionUtils', function () {
       const error = v =>
         format(
           'The second argument of ModelDefinitionUtils.excludeObjectKeysByRelationNames ' +
-            'should be an Object, but %s given.',
+            'should be an Object, but %s was given.',
           v,
         );
       expect(throwable('')).to.throw(error('""'));
@@ -1968,7 +1968,7 @@ describe('ModelDefinitionUtils', function () {
           format(
             'Parameter "modelName" of ' +
               'ModelDefinitionUtils.getModelNameOfPropertyValueIfDefined ' +
-              'requires a non-empty String, but %s given.',
+              'requires a non-empty String, but %s was given.',
             v,
           );
         expect(throwable('')).to.throw(error('""'));
@@ -1997,7 +1997,7 @@ describe('ModelDefinitionUtils', function () {
           format(
             'Parameter "propertyName" of ' +
               'ModelDefinitionUtils.getModelNameOfPropertyValueIfDefined ' +
-              'requires a non-empty String, but %s given.',
+              'requires a non-empty String, but %s was given.',
             v,
           );
         expect(throwable('')).to.throw(error('""'));
@@ -2050,7 +2050,7 @@ describe('ModelDefinitionUtils', function () {
           format(
             'Parameter "modelName" of ' +
               'ModelDefinitionUtils.getModelNameOfPropertyValueIfDefined ' +
-              'requires a non-empty String, but %s given.',
+              'requires a non-empty String, but %s was given.',
             v,
           );
         expect(throwable('')).to.throw(error('""'));
@@ -2081,7 +2081,7 @@ describe('ModelDefinitionUtils', function () {
           format(
             'Parameter "propertyName" of ' +
               'ModelDefinitionUtils.getModelNameOfPropertyValueIfDefined ' +
-              'requires a non-empty String, but %s given.',
+              'requires a non-empty String, but %s was given.',
             v,
           );
         expect(throwable('')).to.throw(error('""'));

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

@@ -15,33 +15,33 @@ export class ModelDefinitionValidator extends Service {
   validate(modelDef) {
     if (!modelDef || typeof modelDef !== 'object' || Array.isArray(modelDef))
       throw new InvalidArgumentError(
-        'The model definition should be an Object, but %v given.',
+        'The model definition should be an Object, but %v was given.',
         modelDef,
       );
     if (!modelDef.name || typeof modelDef.name !== 'string')
       throw new InvalidArgumentError(
         'The model definition requires the option "name" ' +
-          'as a non-empty String, but %v given.',
+          'as a non-empty String, but %v was given.',
         modelDef.name,
       );
     if (modelDef.datasource && typeof modelDef.datasource !== 'string')
       throw new InvalidArgumentError(
         'The provided option "datasource" of the model %v ' +
-          'should be a String, but %v given.',
+          'should be a String, but %v was given.',
         modelDef.name,
         modelDef.datasource,
       );
     if (modelDef.base && typeof modelDef.base !== 'string')
       throw new InvalidArgumentError(
         'The provided option "base" of the model %v ' +
-          'should be a String, but %v given.',
+          'should be a String, but %v was given.',
         modelDef.name,
         modelDef.base,
       );
     if (modelDef.tableName && typeof modelDef.tableName !== 'string')
       throw new InvalidArgumentError(
         'The provided option "tableName" of the model %v ' +
-          'should be a String, but %v given.',
+          'should be a String, but %v was given.',
         modelDef.name,
         modelDef.tableName,
       );
@@ -52,7 +52,7 @@ export class ModelDefinitionValidator extends Service {
       ) {
         throw new InvalidArgumentError(
           'The provided option "properties" of the model %v ' +
-            'should be an Object, but %v given.',
+            'should be an Object, but %v was given.',
           modelDef.name,
           modelDef.properties,
         );
@@ -69,7 +69,7 @@ export class ModelDefinitionValidator extends Service {
       ) {
         throw new InvalidArgumentError(
           'The provided option "relations" of the model %v ' +
-            'should be an Object, but %v given.',
+            'should be an Object, but %v was given.',
           modelDef.name,
           modelDef.relations,
         );

package/src/definition/model/model-definition-validator.spec.js

@@ -17,7 +17,10 @@ describe('ModelDefinitionValidator', function () {
     it('requires the given definition to be an object', function () {
       const validate = v => () => S.validate(v);
       const error = v =>
-        format('The model definition should be an Object, but %s given.', v);
+        format(
+          'The model definition should be an Object, but %s was given.',
+          v,
+        );
       expect(validate('str')).to.throw(error('"str"'));
       expect(validate(10)).to.throw(error('10'));
       expect(validate(true)).to.throw(error('true'));
@@ -33,7 +36,7 @@ describe('ModelDefinitionValidator', function () {
       const error = v =>
         format(
           'The model definition requires the option "name" ' +
-            'as a non-empty String, but %s given.',
+            'as a non-empty String, but %s was given.',
           v,
         );
       expect(validate('')).to.throw(error('""'));
@@ -52,7 +55,7 @@ describe('ModelDefinitionValidator', function () {
       const error = v =>
         format(
           'The provided option "datasource" of the model "model" ' +
-            'should be a String, but %s given.',
+            'should be a String, but %s was given.',
           v,
         );
       expect(validate(10)).to.throw(error('10'));
@@ -67,7 +70,7 @@ describe('ModelDefinitionValidator', function () {
       const error = v =>
         format(
           'The provided option "base" of the model "model" ' +
-            'should be a String, but %s given.',
+            'should be a String, but %s was given.',
           v,
         );
       expect(validate(10)).to.throw(error('10'));
@@ -82,7 +85,7 @@ describe('ModelDefinitionValidator', function () {
       const error = v =>
         format(
           'The provided option "tableName" of the model "model" ' +
-            'should be a String, but %s given.',
+            'should be a String, but %s was given.',
           v,
         );
       expect(validate(10)).to.throw(error('10'));
@@ -97,7 +100,7 @@ describe('ModelDefinitionValidator', function () {
       const error = v =>
         format(
           'The provided option "properties" of the model "model" ' +
-            'should be an Object, but %s given.',
+            'should be an Object, but %s was given.',
           v,
         );
       expect(validate('str')).to.throw(error('"str"'));
@@ -112,7 +115,7 @@ describe('ModelDefinitionValidator', function () {
       const error = v =>
         format(
           'The provided option "relations" of the model "model" ' +
-            'should be an Object, but %s given.',
+            'should be an Object, but %s was given.',
           v,
         );
       expect(validate('str')).to.throw(error('"str"'));

package/src/definition/model/properties/properties-definition-validator.js

@@ -21,13 +21,13 @@ export class PropertiesDefinitionValidator extends Service {
     if (!modelName || typeof modelName !== 'string')
       throw new InvalidArgumentError(
         'The first argument of PropertiesDefinitionValidator.validate ' +
-          'should be a non-empty String, but %v given.',
+          'should be a non-empty String, but %v was given.',
         modelName,
       );
     if (!propDefs || typeof propDefs !== 'object' || Array.isArray(propDefs)) {
       throw new InvalidArgumentError(
         'The provided option "properties" of the model %v ' +
-          'should be an Object, but %v given.',
+          'should be an Object, but %v was given.',
         modelName,
         propDefs,
       );
@@ -54,20 +54,20 @@ export class PropertiesDefinitionValidator extends Service {
     if (!modelName || typeof modelName !== 'string')
       throw new InvalidArgumentError(
         'The first argument of PropertiesDefinitionValidator._validateProperty ' +
-          'should be a non-empty String, but %v given.',
+          'should be a non-empty String, but %v was given.',
         modelName,
       );
     if (!propName || typeof propName !== 'string')
       throw new InvalidArgumentError(
         'The property name of the model %v should be ' +
-          'a non-empty String, but %v given.',
+          'a non-empty String, but %v was given.',
         modelName,
         propName,
       );
     if (!propDef)
       throw new InvalidArgumentError(
         'The property %v of the model %v should have ' +
-          'a property definition, but %v given.',
+          'a property definition, but %v was given.',
         propName,
         modelName,
         propDef,
@@ -76,7 +76,7 @@ export class PropertiesDefinitionValidator extends Service {
       if (!Object.values(Type).includes(propDef))
         throw new InvalidArgumentError(
           'In case of a short property definition, the property %v ' +
-            'of the model %v should have one of data types: %l, but %v given.',
+            'of the model %v should have one of data types: %l, but %v was given.',
           propName,
           modelName,
           Object.values(Type),
@@ -87,7 +87,7 @@ export class PropertiesDefinitionValidator extends Service {
     if (!propDef || typeof propDef !== 'object' || Array.isArray(propDef)) {
       throw new InvalidArgumentError(
         'In case of a full property definition, the property %v ' +
-          'of the model %v should be an Object, but %v given.',
+          'of the model %v should be an Object, but %v was given.',
         propName,
         modelName,
         propDef,
@@ -96,7 +96,7 @@ export class PropertiesDefinitionValidator extends Service {
     if (!propDef.type || !Object.values(Type).includes(propDef.type))
       throw new InvalidArgumentError(
         'The property %v of the model %v requires the option "type" ' +
-          'to have one of data types: %l, but %v given.',
+          'to have one of data types: %l, but %v was given.',
         propName,
         modelName,
         Object.values(Type),
@@ -105,7 +105,7 @@ export class PropertiesDefinitionValidator extends Service {
     if (propDef.itemType && !Object.values(Type).includes(propDef.itemType)) {
       throw new InvalidArgumentError(
         'The provided option "itemType" of the property %v in the model %v ' +
-          'should have one of data types: %l, but %v given.',
+          'should have one of data types: %l, but %v was given.',
         propName,
         modelName,
         Object.values(Type),
@@ -115,7 +115,7 @@ export class PropertiesDefinitionValidator extends Service {
     if (propDef.itemModel && typeof propDef.itemModel !== 'string') {
       throw new InvalidArgumentError(
         'The provided option "itemModel" of the property %v in the model %v ' +
-          'should be a String, but %v given.',
+          'should be a String, but %v was given.',
         propName,
         modelName,
         propDef.itemModel,
@@ -124,7 +124,7 @@ export class PropertiesDefinitionValidator extends Service {
     if (propDef.model && typeof propDef.model !== 'string')
       throw new InvalidArgumentError(
         'The provided option "model" of the property %v in the model %v ' +
-          'should be a String, but %v given.',
+          'should be a String, but %v was given.',
         propName,
         modelName,
         propDef.model,
@@ -132,7 +132,7 @@ export class PropertiesDefinitionValidator extends Service {
     if (propDef.primaryKey && typeof propDef.primaryKey !== 'boolean')
       throw new InvalidArgumentError(
         'The provided option "primaryKey" of the property %v in the model %v ' +
-          'should be a Boolean, but %v given.',
+          'should be a Boolean, but %v was given.',
         propName,
         modelName,
         propDef.primaryKey,
@@ -140,7 +140,7 @@ export class PropertiesDefinitionValidator extends Service {
     if (propDef.columnName && typeof propDef.columnName !== 'string')
       throw new InvalidArgumentError(
         'The provided option "columnName" of the property %v in the model %v ' +
-          'should be a String, but %v given.',
+          'should be a String, but %v was given.',
         propName,
         modelName,
         propDef.columnName,
@@ -148,7 +148,7 @@ export class PropertiesDefinitionValidator extends Service {
     if (propDef.columnType && typeof propDef.columnType !== 'string')
       throw new InvalidArgumentError(
         'The provided option "columnType" of the property %v in the model %v ' +
-          'should be a String, but %v given.',
+          'should be a String, but %v was given.',
         propName,
         modelName,
         propDef.columnType,
@@ -156,7 +156,7 @@ export class PropertiesDefinitionValidator extends Service {
     if (propDef.required && typeof propDef.required !== 'boolean')
       throw new InvalidArgumentError(
         'The provided option "required" of the property %v in the model %v ' +
-          'should be a Boolean, but %v given.',
+          'should be a Boolean, but %v was given.',
         propName,
         modelName,
         propDef.required,
@@ -228,92 +228,167 @@ export class PropertiesDefinitionValidator extends Service {
         propName,
         modelName,
       );
+    // если определена опция "validate", то проверяется значение
+    // опции, которое может являться строкой, массивом или объектом
     if (propDef.validate != null) {
       const propertyValidatorRegistry = this.getService(
         PropertyValidatorRegistry,
       );
+      // если опция "validate" содержит строку, то проверяется
+      // наличие зарегистрированного валидатора по названию
       if (propDef.validate && typeof propDef.validate === 'string') {
+        // если название валидатора не зарегистрировано,
+        // то выбрасывается ошибка
         if (!propertyValidatorRegistry.hasValidator(propDef.validate))
           throw new InvalidArgumentError(
             'The property validator %v is not found.',
             propDef.validate,
           );
-      } else if (Array.isArray(propDef.validate)) {
-        for (const validatorName of propDef.validate) {
-          if (typeof validatorName !== 'string')
+      }
+      // если опция "validate" содержит функцию, то данная функция
+      // воспринимается как пользовательский валидатор
+      else if (propDef.validate && typeof propDef.validate === 'function') {
+        // (допустимо)
+      }
+      // если опция "validate" содержит массив, то проверяется
+      // каждый элемент массива
+      else if (Array.isArray(propDef.validate)) {
+        for (const validatorOrName of propDef.validate) {
+          // если элемент массива является строкой, то проверяется
+          // наличие зарегистрированного валидатора по названию
+          if (validatorOrName && typeof validatorOrName === 'string') {
+            if (!propertyValidatorRegistry.hasValidator(validatorOrName))
+              throw new InvalidArgumentError(
+                'The property validator %v is not found.',
+                validatorOrName,
+              );
+          }
+          // если элемент массива является функцией, то данная функция
+          // воспринимается как пользовательский валидатор
+          else if (validatorOrName && typeof validatorOrName === 'function') {
+            // (допустимо)
+          }
+          // если элемент массива не является названием зарегистрированного
+          // валидатора или функцией-валидатором, то выбрасывается ошибка
+          else {
             throw new InvalidArgumentError(
-              'The provided option "validate" of the property %v in the model %v ' +
-                'has an Array value that should have a non-empty String, ' +
-                'but %v given.',
+              'The provided option "validate" for the property %v in the model %v ' +
+                'has an Array value that should contain validator names or validator ' +
+                'functions, but %v was given.',
               propName,
               modelName,
-              validatorName,
-            );
-          if (!propertyValidatorRegistry.hasValidator(validatorName))
-            throw new InvalidArgumentError(
-              'The property validator %v is not found.',
-              validatorName,
+              validatorOrName,
             );
+          }
         }
-      } else if (typeof propDef.validate === 'object') {
-        for (const validatorName in propDef.validate) {
+      }
+      // если опция "validate" содержит объект, то проверяются ключи данного
+      // объекта, которые должны являться названиями зарегистрированных
+      // валидаторов, а значения их аргументами
+      else if (typeof propDef.validate === 'object') {
+        Object.keys(propDef.validate).forEach(validatorName => {
+          // если ключ объекта не является названием зарегистрированного
+          // валидатора, то выбрасывается ошибка
           if (!propertyValidatorRegistry.hasValidator(validatorName))
             throw new InvalidArgumentError(
               'The property validator %v is not found.',
               validatorName,
             );
-        }
-      } else {
+        });
+      }
+      // если опция "validate" не является не пустой строкой, функцией,
+      // массивом и объектом, то выбрасывается ошибка
+      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.',
+          'The provided option "validate" for the property %v in the model %v ' +
+            'should be either a validator name, a validator function, an array ' +
+            'of validator names or functions, or an object mapping validator ' +
+            'names to their arguments, but %v was given.',
           propName,
           modelName,
           propDef.validate,
         );
       }
     }
+    // если определена опция "transform", то проверяется значение
+    // опции, которое может являться строкой, массивом или объектом
     if (propDef.transform != null) {
       const propertyTransformerRegistry = this.getService(
         PropertyTransformerRegistry,
       );
+      // если опция "transform" содержит строку, то проверяется
+      // наличие зарегистрированного трансформера по названию
       if (propDef.transform && typeof propDef.transform === 'string') {
+        // если название трансформера не зарегистрировано,
+        // то выбрасывается ошибка
         if (!propertyTransformerRegistry.hasTransformer(propDef.transform))
           throw new InvalidArgumentError(
             'The property transformer %v is not found.',
             propDef.transform,
           );
-      } else if (Array.isArray(propDef.transform)) {
-        for (const transformerName of propDef.transform) {
-          if (typeof transformerName !== 'string')
+      }
+      // если опция "transform" содержит функцию, то данная функция
+      // воспринимается как пользовательский трансформер
+      else if (propDef.transform && typeof propDef.transform === 'function') {
+        // (допустимо)
+      }
+      // если опция "transform" содержит массив, то проверяется
+      // каждый элемент массива
+      else if (Array.isArray(propDef.transform)) {
+        for (const transformerOrName of propDef.transform) {
+          // если элемент массива является строкой, то проверяется
+          // наличие зарегистрированного трансформера по названию
+          if (transformerOrName && typeof transformerOrName === 'string') {
+            if (!propertyTransformerRegistry.hasTransformer(transformerOrName))
+              throw new InvalidArgumentError(
+                'The property transformer %v is not found.',
+                transformerOrName,
+              );
+          }
+          // если элемент массива является функцией, то данная функция
+          // воспринимается как пользовательский трансформер
+          else if (
+            transformerOrName &&
+            typeof transformerOrName === 'function'
+          ) {
+            // (допустимо)
+          }
+          // если элемент массива не является названием зарегистрированного
+          // трансформера или функцией-трансформером, то выбрасывается ошибка
+          else {
             throw new InvalidArgumentError(
-              'The provided option "transform" of the property %v in the model %v ' +
-                'has an Array value that should have a non-empty String, ' +
-                'but %v given.',
+              'The provided option "transform" for the property %v in the model %v ' +
+                'has an Array value that should contain transformer names or transformer ' +
+                'functions, but %v was given.',
               propName,
               modelName,
-              transformerName,
-            );
-          if (!propertyTransformerRegistry.hasTransformer(transformerName))
-            throw new InvalidArgumentError(
-              'The property transformer %v is not found.',
-              transformerName,
+              transformerOrName,
             );
+          }
         }
-      } else if (typeof propDef.transform === 'object') {
-        for (const transformerName in propDef.transform) {
+      }
+      // если опция "transform" содержит объект, то проверяются ключи данного
+      // объекта, которые должны являться названиями зарегистрированных
+      // трансформеров, а значения их аргументами
+      else if (typeof propDef.transform === 'object') {
+        Object.keys(propDef.transform).forEach(transformerName => {
+          // если ключ объекта не является названием зарегистрированного
+          // валидатора, то выбрасывается ошибка
           if (!propertyTransformerRegistry.hasTransformer(transformerName))
             throw new InvalidArgumentError(
               'The property transformer %v is not found.',
               transformerName,
             );
-        }
-      } else {
+        });
+      }
+      // если опция "transform" не является не пустой строкой, функцией,
+      // массивом и объектом, то выбрасывается ошибка
+      else {
         throw new InvalidArgumentError(
-          'The provided option "transform" of the property %v in the model %v ' +
-            'should be a non-empty String, an Array of String or an Object, ' +
-            'but %v given.',
+          'The provided option "transform" for the property %v in the model %v ' +
+            'should be either a transformer name, a transformer function, an array ' +
+            'of transformer names or functions, or an object mapping transformer ' +
+            'names to their arguments, but %v was given.',
           propName,
           modelName,
           propDef.transform,
@@ -327,7 +402,7 @@ export class PropertiesDefinitionValidator extends Service {
       ) {
         throw new InvalidArgumentError(
           'The provided option "unique" of the property %v in the model %v ' +
-            'should be a Boolean or one of values: %l, but %v given.',
+            'should be a Boolean or one of values: %l, but %v was given.',
           propName,
           modelName,
           Object.values(PropertyUniqueness),