@e22m4u/js-repository 0.8.6 → 0.8.8

package/src/filter/include-clause-tool.js

@@ -151,7 +151,7 @@ export class IncludeClauseTool extends Service {
           break;
         default:
           throw new InvalidArgumentError(
-            'The relation type %v does not have an inclusion resolver.',
+            'Relation type %v does not have an inclusion resolver.',
             relDef.type,
           );
       }
@@ -190,7 +190,7 @@ export class IncludeClauseTool extends Service {
       );
       if (duplicateNames.length) {
         throw new InvalidArgumentError(
-          'The provided option "include" has duplicates of %v.',
+          'Option "include" has duplicates of %v.',
           duplicateNames[0],
         );
       }
@@ -200,7 +200,7 @@ export class IncludeClauseTool extends Service {
         // {relation: 'name', scope: {}}
         if (!clause.relation || typeof clause.relation !== 'string') {
           throw new InvalidArgumentError(
-            'The provided option "relation" should be ' +
+            'Option "relation" must be ' +
               'a non-empty String, but %v was given.',
             clause.relation,
           );
@@ -221,7 +221,7 @@ export class IncludeClauseTool extends Service {
     } else {
       // unsupported
       throw new InvalidArgumentError(
-        'The provided option "include" should have a non-empty String, ' +
+        'Option "include" must have a non-empty String, ' +
           'an Object or an Array, but %v was given.',
         clause,
       );
@@ -239,7 +239,7 @@ export class IncludeClauseTool extends Service {
     }
     if (typeof clause !== 'object' || Array.isArray(clause)) {
       throw new InvalidArgumentError(
-        'The provided option "scope" should be an Object, but %v was given.',
+        'Option "scope" must be an Object, but %v was given.',
         clause,
       );
     }
@@ -296,7 +296,7 @@ export class IncludeClauseTool extends Service {
       );
       if (duplicateNames.length) {
         throw new InvalidArgumentError(
-          'The provided option "include" has duplicates of %v.',
+          'Option "include" has duplicates of %v.',
           duplicateNames[0],
         );
       }
@@ -306,7 +306,7 @@ export class IncludeClauseTool extends Service {
         // {relation: 'name', scope: {...}}
         if (!clause.relation || typeof clause.relation !== 'string') {
           throw new InvalidArgumentError(
-            'The provided option "relation" should be ' +
+            'Option "relation" must be ' +
               'a non-empty String, but %v was given.',
             clause.relation,
           );
@@ -335,7 +335,7 @@ export class IncludeClauseTool extends Service {
     } else {
       // unsupported
       throw new InvalidArgumentError(
-        'The provided option "include" should have a non-empty String, ' +
+        'Option "include" must have a non-empty String, ' +
           'an Object or an Array, but %v was given.',
         clause,
       );
@@ -355,7 +355,7 @@ export class IncludeClauseTool extends Service {
     }
     if (typeof clause !== 'object' || Array.isArray(clause)) {
       throw new InvalidArgumentError(
-        'The provided option "scope" should be an Object, but %v was given.',
+        'Option "scope" must be an Object, but %v was given.',
         clause,
       );
     }

package/src/filter/include-clause-tool.spec.js

@@ -40,7 +40,7 @@ describe('IncludeClauseTool', function () {
       const throwable = v => () => IncludeClauseTool.validateIncludeClause(v);
       const createError = v =>
         format(
-          'The provided option "include" should have a non-empty String, ' +
+          'Option "include" must have a non-empty String, ' +
             'an Object or an Array, but %v was given.',
           v,
         );
@@ -80,7 +80,7 @@ describe('IncludeClauseTool', function () {
 
     it('throws an error for duplicates', function () {
       const validate = v => () => IncludeClauseTool.validateIncludeClause(v);
-      const error = 'The provided option "include" has duplicates of "foo".';
+      const error = 'Option "include" has duplicates of "foo".';
       const clauses = [
         ['foo', 'foo'],
         [['foo'], 'foo'],
@@ -104,7 +104,7 @@ describe('IncludeClauseTool', function () {
       const throwable = v => () => IncludeClauseTool.normalizeIncludeClause(v);
       const createError = v =>
         format(
-          'The provided option "include" should have a non-empty String, ' +
+          'Option "include" must have a non-empty String, ' +
             'an Object or an Array, but %v was given.',
           v,
         );
@@ -144,7 +144,7 @@ describe('IncludeClauseTool', function () {
 
     it('throws an error for duplicates', function () {
       const validate = v => () => IncludeClauseTool.normalizeIncludeClause(v);
-      const error = 'The provided option "include" has duplicates of "foo".';
+      const error = 'Option "include" has duplicates of "foo".';
       const clauses = [
         ['foo', 'foo'],
         [['foo'], 'foo'],

package/src/filter/operator-clause-tool.js

@@ -68,8 +68,7 @@ export class OperatorClauseTool extends Service {
   testAll(clause, value) {
     if (!clause || typeof clause !== 'object' || Array.isArray(clause)) {
       throw new InvalidArgumentError(
-        'The first argument of OperatorUtils.testAll ' +
-          'should be an Object, but %v was given.',
+        'Parameter "clause" must be an Object, but %v was given.',
         clause,
       );
     }
@@ -135,10 +134,9 @@ export class OperatorClauseTool extends Service {
    * @returns {boolean|undefined}
    */
   testEqNeq(clause, value) {
-    if (!clause || typeof clause !== 'object') {
+    if (!clause || typeof clause !== 'object' || Array.isArray(clause)) {
       throw new InvalidArgumentError(
-        'The first argument of OperatorUtils.testEqNeq ' +
-          'should be an Object, but %v was given.',
+        'Parameter "clause" must be an Object, but %v was given.',
         clause,
       );
     }
@@ -186,10 +184,9 @@ export class OperatorClauseTool extends Service {
    * @returns {boolean|undefined}
    */
   testGtLt(clause, value) {
-    if (!clause || typeof clause !== 'object') {
+    if (!clause || typeof clause !== 'object' || Array.isArray(clause)) {
       throw new InvalidArgumentError(
-        'The first argument of OperatorUtils.testGtLt ' +
-          'should be an Object, but %v was given.',
+        'Parameter "clause" must be an Object, but %v was given.',
         clause,
       );
     }
@@ -222,10 +219,9 @@ export class OperatorClauseTool extends Service {
    * @returns {boolean|undefined}
    */
   testInq(clause, value) {
-    if (!clause || typeof clause !== 'object') {
+    if (!clause || typeof clause !== 'object' || Array.isArray(clause)) {
       throw new InvalidArgumentError(
-        'The first argument of OperatorUtils.testInq ' +
-          'should be an Object, but %v was given.',
+        'Parameter "clause" must be an Object, but %v was given.',
         clause,
       );
     }
@@ -261,10 +257,9 @@ export class OperatorClauseTool extends Service {
    * @returns {boolean|undefined}
    */
   testNin(clause, value) {
-    if (!clause || typeof clause !== 'object') {
+    if (!clause || typeof clause !== 'object' || Array.isArray(clause)) {
       throw new InvalidArgumentError(
-        'The first argument of OperatorUtils.testNin ' +
-          'should be an Object, but %v was given.',
+        'Parameter "clause" must be an Object, but %v was given.',
         clause,
       );
     }
@@ -297,10 +292,9 @@ export class OperatorClauseTool extends Service {
    * @returns {boolean|undefined}
    */
   testBetween(clause, value) {
-    if (!clause || typeof clause !== 'object') {
+    if (!clause || typeof clause !== 'object' || Array.isArray(clause)) {
       throw new InvalidArgumentError(
-        'The first argument of OperatorUtils.testBetween ' +
-          'should be an Object, but %v was given.',
+        'Parameter "clause" must be an Object, but %v was given.',
         clause,
       );
     }
@@ -334,10 +328,9 @@ export class OperatorClauseTool extends Service {
    * @returns {boolean|undefined}
    */
   testExists(clause, value) {
-    if (!clause || typeof clause !== 'object') {
+    if (!clause || typeof clause !== 'object' || Array.isArray(clause)) {
       throw new InvalidArgumentError(
-        'The first argument of OperatorUtils.testExists ' +
-          'should be an Object, but %v was given.',
+        'Parameter "clause" must be an Object, but %v was given.',
         clause,
       );
     }
@@ -370,8 +363,7 @@ export class OperatorClauseTool extends Service {
   testLike(clause, value) {
     if (!clause || typeof clause !== 'object' || Array.isArray(clause)) {
       throw new InvalidArgumentError(
-        'The first argument of OperatorUtils.testLike ' +
-          'should be an Object, but %v was given.',
+        'Parameter "clause" must be an Object, but %v was given.',
         clause,
       );
     }
@@ -400,8 +392,7 @@ export class OperatorClauseTool extends Service {
   testNlike(clause, value) {
     if (!clause || typeof clause !== 'object' || Array.isArray(clause)) {
       throw new InvalidArgumentError(
-        'The first argument of OperatorUtils.testNlike ' +
-          'should be an Object, but %v was given.',
+        'Parameter "clause" must be an Object, but %v was given.',
         clause,
       );
     }
@@ -430,8 +421,7 @@ export class OperatorClauseTool extends Service {
   testIlike(clause, value) {
     if (!clause || typeof clause !== 'object' || Array.isArray(clause)) {
       throw new InvalidArgumentError(
-        'The first argument of OperatorUtils.testIlike ' +
-          'should be an Object, but %v was given.',
+        'Parameter "clause" must be an Object, but %v was given.',
         clause,
       );
     }
@@ -460,8 +450,7 @@ export class OperatorClauseTool extends Service {
   testNilike(clause, value) {
     if (!clause || typeof clause !== 'object' || Array.isArray(clause)) {
       throw new InvalidArgumentError(
-        'The first argument of OperatorUtils.testNilike ' +
-          'should be an Object, but %v was given.',
+        'Parameter "clause" must be an Object, but %v was given.',
         clause,
       );
     }
@@ -500,10 +489,9 @@ export class OperatorClauseTool extends Service {
    * @returns {boolean|undefined}
    */
   testRegexp(clause, value) {
-    if (!clause || typeof clause !== 'object') {
+    if (!clause || typeof clause !== 'object' || Array.isArray(clause)) {
       throw new InvalidArgumentError(
-        'The first argument of OperatorUtils.testRegexp ' +
-          'should be an Object, but %v was given.',
+        'Parameter "clause" must be an Object, but %v was given.',
         clause,
       );
     }
@@ -521,7 +509,7 @@ export class OperatorClauseTool extends Service {
       const flags = clause.flags || undefined;
       if (flags && typeof flags !== 'string') {
         throw new InvalidArgumentError(
-          'RegExp flags should be a String, but %v was given.',
+          'RegExp flags must be a String, but %v was given.',
           clause.flags,
         );
       }

package/src/filter/operator-clause-tool.spec.js

@@ -203,11 +203,10 @@ describe('OperatorClauseTool', function () {
       expect(S.testAll({foo: 'bar'}, 'value')).to.be.undefined;
     });
 
-    it('should throws an error if a first argument is not an object', function () {
+    it('should throws an error if the parameter "clause" is not an object', function () {
       const throwable = () => S.testAll(10);
       expect(throwable).to.throw(
-        'The first argument of OperatorUtils.testAll ' +
-          'should be an Object, but 10 was given.',
+        'Parameter "clause" must be an Object, but 10 was given.',
       );
     });
   });
@@ -218,11 +217,10 @@ describe('OperatorClauseTool', function () {
       expect(result).to.be.undefined;
     });
 
-    it('throws an error if a first argument is not an object', function () {
+    it('throws an error if the parameter "clause" is not an object', function () {
       const throwable = () => S.testEqNeq(10);
       expect(throwable).to.throw(
-        'The first argument of OperatorUtils.testEqNeq ' +
-          'should be an Object, but 10 was given.',
+        'Parameter "clause" must be an Object, but 10 was given.',
       );
     });
 
@@ -353,11 +351,10 @@ describe('OperatorClauseTool', function () {
       expect(result).to.be.undefined;
     });
 
-    it('throws an error if a first argument is not an object', function () {
+    it('throws an error if the parameter "clause" is not an object', function () {
       const throwable = () => S.testGtLt(10);
       expect(throwable).to.throw(
-        'The first argument of OperatorUtils.testGtLt ' +
-          'should be an Object, but 10 was given.',
+        'Parameter "clause" must be an Object, but 10 was given.',
       );
     });
 
@@ -550,11 +547,10 @@ describe('OperatorClauseTool', function () {
       expect(S.testInq(clause, [5, 6])).to.be.false;
     });
 
-    it('throws an error if a first argument is not an object', function () {
+    it('throws an error if the parameter "clause" is not an object', function () {
       const throwable = () => S.testInq(10);
       expect(throwable).to.throw(
-        'The first argument of OperatorUtils.testInq ' +
-          'should be an Object, but 10 was given.',
+        'Parameter "clause" must be an Object, but 10 was given.',
       );
     });
 
@@ -628,11 +624,10 @@ describe('OperatorClauseTool', function () {
       expect(S.testNin(clause, [5, 6])).to.be.true;
     });
 
-    it('throws an error if a first argument is not an object', function () {
+    it('throws an error if the parameter "clause" is not an object', function () {
       const throwable = () => S.testNin(10);
       expect(throwable).to.throw(
-        'The first argument of OperatorUtils.testNin ' +
-          'should be an Object, but 10 was given.',
+        'Parameter "clause" must be an Object, but 10 was given.',
       );
     });
 
@@ -697,11 +692,10 @@ describe('OperatorClauseTool', function () {
       expect(S.testBetween({between: [-2, 2]}, {})).to.be.false;
     });
 
-    it('throws an error if a first argument is not an object', function () {
+    it('throws an error if the parameter "clause" is not an object', function () {
       const throwable = () => S.testBetween(10);
       expect(throwable).to.throw(
-        'The first argument of OperatorUtils.testBetween ' +
-          'should be an Object, but 10 was given.',
+        'Parameter "clause" must be an Object, but 10 was given.',
       );
     });
 
@@ -754,11 +748,10 @@ describe('OperatorClauseTool', function () {
       expect(result).to.be.undefined;
     });
 
-    it('throws an error if a first argument is not an object', function () {
+    it('throws an error if the parameter "clause" is not an object', function () {
       const throwable = () => S.testExists(10);
       expect(throwable).to.throw(
-        'The first argument of OperatorUtils.testExists ' +
-          'should be an Object, but 10 was given.',
+        'Parameter "clause" must be an Object, but 10 was given.',
       );
     });
 
@@ -874,11 +867,7 @@ describe('OperatorClauseTool', function () {
         S.testLike(v);
       };
       const error = s =>
-        format(
-          'The first argument of OperatorUtils.testLike ' +
-            'should be an Object, but %s was given.',
-          s,
-        );
+        format('Parameter "clause" must be an Object, but %s was given.', s);
       expect(throwable('str')).to.throw(error('"str"'));
       expect(throwable('')).to.throw(error('""'));
       expect(throwable(10)).to.throw(error('10'));
@@ -897,7 +886,7 @@ describe('OperatorClauseTool', function () {
       };
       const error = s =>
         format(
-          'Condition of {like: ...} should have a String, but %s was given.',
+          'Condition of {like: ...} must have a String, but %s was given.',
           s,
         );
       expect(throwable(10)).to.throw(error('10'));
@@ -969,11 +958,7 @@ describe('OperatorClauseTool', function () {
         S.testNlike(v);
       };
       const error = s =>
-        format(
-          'The first argument of OperatorUtils.testNlike ' +
-            'should be an Object, but %s was given.',
-          s,
-        );
+        format('Parameter "clause" must be an Object, but %s was given.', s);
       expect(throwable('str')).to.throw(error('"str"'));
       expect(throwable('')).to.throw(error('""'));
       expect(throwable(10)).to.throw(error('10'));
@@ -992,7 +977,7 @@ describe('OperatorClauseTool', function () {
       };
       const error = s =>
         format(
-          'Condition of {nlike: ...} should have a String, but %s was given.',
+          'Condition of {nlike: ...} must have a String, but %s was given.',
           s,
         );
       expect(throwable(10)).to.throw(error('10'));
@@ -1062,11 +1047,7 @@ describe('OperatorClauseTool', function () {
         S.testIlike(v);
       };
       const error = s =>
-        format(
-          'The first argument of OperatorUtils.testIlike ' +
-            'should be an Object, but %s was given.',
-          s,
-        );
+        format('Parameter "clause" must be an Object, but %s was given.', s);
       expect(throwable('str')).to.throw(error('"str"'));
       expect(throwable('')).to.throw(error('""'));
       expect(throwable(10)).to.throw(error('10'));
@@ -1085,7 +1066,7 @@ describe('OperatorClauseTool', function () {
       };
       const error = s =>
         format(
-          'Condition of {ilike: ...} should have a String, but %s was given.',
+          'Condition of {ilike: ...} must have a String, but %s was given.',
           s,
         );
       expect(throwable(10)).to.throw(error('10'));
@@ -1158,11 +1139,7 @@ describe('OperatorClauseTool', function () {
         S.testNilike(v);
       };
       const error = s =>
-        format(
-          'The first argument of OperatorUtils.testNilike ' +
-            'should be an Object, but %s was given.',
-          s,
-        );
+        format('Parameter "clause" must be an Object, but %s was given.', s);
       expect(throwable('str')).to.throw(error('"str"'));
       expect(throwable('')).to.throw(error('""'));
       expect(throwable(10)).to.throw(error('10'));
@@ -1181,7 +1158,7 @@ describe('OperatorClauseTool', function () {
       };
       const error = s =>
         format(
-          'Condition of {nilike: ...} should have a String, but %s was given.',
+          'Condition of {nilike: ...} must have a String, but %s was given.',
           s,
         );
       expect(throwable(10)).to.throw(error('10'));
@@ -1264,11 +1241,10 @@ describe('OperatorClauseTool', function () {
       expect(S.testRegexp({regexp: 'Val.+', flags: 'i'}, 'value')).to.be.true;
     });
 
-    it('throws an error if a first argument is not an object', function () {
+    it('throws an error if the parameter "clause" is not an object', function () {
       const throwable = () => S.testRegexp(10);
       expect(throwable).to.throw(
-        'The first argument of OperatorUtils.testRegexp ' +
-          'should be an Object, but 10 was given.',
+        'Parameter "clause" must be an Object, but 10 was given.',
       );
     });
 
@@ -1294,7 +1270,7 @@ describe('OperatorClauseTool', function () {
       const throwable = v => () =>
         S.testRegexp({regexp: 'Val.+', flags: v}, 'val');
       const error = v =>
-        format('RegExp flags should be a String, but %s was given.', v);
+        format('RegExp flags must be a String, but %s was given.', v);
       expect(throwable(10)).to.throw(error('10'));
       expect(throwable(true)).to.throw(error('true'));
       expect(throwable([])).to.throw(error('Array'));

package/src/filter/order-clause-tool.js

@@ -13,33 +13,47 @@ export class OrderClauseTool extends Service {
    * @param {string|string[]|undefined} clause
    */
   sort(entities, clause) {
+    if (!Array.isArray(entities)) {
+      throw new InvalidArgumentError(
+        'Parameter "entities" must be an Array, but %v was given.',
+        entities,
+      );
+    }
     if (clause == null) {
       return;
     }
-    if (Array.isArray(clause) === false) {
-      clause = [clause];
+    const isArrayClause = Array.isArray(clause);
+    if (!clause || (typeof clause !== 'string' && !isArrayClause)) {
+      throw new InvalidArgumentError(
+        'Option "order" must be a non-empty String or an Array ' +
+          'of non-empty String, but %v was given.',
+        clause,
+      );
     }
-    if (!clause.length) {
+    if (!isArrayClause) {
+      clause = [clause];
+    } else if (!clause.length) {
       return;
     }
     const mapping = [];
-    clause.forEach((key, index) => {
-      if (!key || typeof key !== 'string') {
+    clause.forEach((element, index) => {
+      if (!element || typeof element !== 'string') {
         throw new InvalidArgumentError(
-          'The provided option "order" should be a non-empty String ' +
-            'or an Array of non-empty String, but %v was given.',
-          key,
+          'Element %d of the option "order" must be a non-empty String, ' +
+            'but %v was given.',
+          index,
+          element,
         );
       }
       let reverse = 1;
-      const matches = key.match(/\s+(A|DE)SC$/i);
+      const matches = element.match(/\s+(A|DE)SC$/i);
       if (matches) {
-        key = key.replace(/\s+(A|DE)SC/i, '');
+        element = element.replace(/\s+(A|DE)SC/i, '');
         if (matches[1].toLowerCase() === 'de') {
           reverse = -1;
         }
       }
-      mapping[index] = {key: key, reverse};
+      mapping[index] = {key: element, reverse};
     });
     entities.sort(compareFn.bind(mapping));
   }
@@ -53,18 +67,24 @@ export class OrderClauseTool extends Service {
     if (clause == null) {
       return;
     }
-    if (Array.isArray(clause) === false) {
-      clause = [clause];
+    const isArrayClause = Array.isArray(clause);
+    if (!clause || (typeof clause !== 'string' && !isArrayClause)) {
+      throw new InvalidArgumentError(
+        'Option "order" must be a non-empty String or an Array ' +
+          'of non-empty String, but %v was given.',
+        clause,
+      );
     }
-    if (!clause.length) {
+    if (!isArrayClause || !clause.length) {
       return;
     }
-    clause.forEach(field => {
-      if (!field || typeof field !== 'string') {
+    clause.forEach((element, index) => {
+      if (!element || typeof element !== 'string') {
         throw new InvalidArgumentError(
-          'The provided option "order" should be a non-empty String ' +
-            'or an Array of non-empty String, but %v was given.',
-          field,
+          'Element %d of the option "order" must be a non-empty String, ' +
+            'but %v was given.',
+          index,
+          element,
         );
       }
     });
@@ -80,18 +100,26 @@ export class OrderClauseTool extends Service {
     if (clause == null) {
       return;
     }
-    if (Array.isArray(clause) === false) {
-      clause = [clause];
+    const isArrayClause = Array.isArray(clause);
+    if (!clause || (typeof clause !== 'string' && !isArrayClause)) {
+      throw new InvalidArgumentError(
+        'Option "order" must be a non-empty String or an Array ' +
+          'of non-empty String, but %v was given.',
+        clause,
+      );
     }
-    if (!clause.length) {
+    if (!isArrayClause) {
+      return [clause];
+    } else if (!clause.length) {
       return;
     }
-    clause.forEach(field => {
-      if (!field || typeof field !== 'string') {
+    clause.forEach((element, index) => {
+      if (!element || typeof element !== 'string') {
         throw new InvalidArgumentError(
-          'The provided option "order" should be a non-empty String ' +
-            'or an Array of non-empty String, but %v was given.',
-          field,
+          'Element %d of the option "order" must be a non-empty String, ' +
+            'but %v was given.',
+          index,
+          element,
         );
       }
     });