@e22m4u/js-repository 0.0.32 → 0.0.34

package/src/filter/{filter.d.ts → filter-clause.d.ts}

@@ -1,9 +1,9 @@
 import {ModelData} from '../types.js';
 
 /**
- * Filter.
+ * Filter clause.
  */
-export declare type Filter = {
+export declare type FilterClause = {
   where?: WhereClause;
   order?: OrderClause;
   limit?: number;
@@ -13,9 +13,9 @@ export declare type Filter = {
 };
 
 /**
- * Item filter.
+ * Item filter clause.
  */
-export declare type ItemFilter = Pick<Filter, 'fields' | 'include'>;
+export declare type ItemFilterClause = Pick<FilterClause, 'fields' | 'include'>;
 
 /**
  * Where clause.
@@ -45,20 +45,20 @@ export declare type ItemFilter = Pick<Filter, 'fields' | 'include'>;
  * ```
  */
 export declare type WhereClause =
-  | FunctionClause
+  | PredicateClause
   | PropertiesClause
   | AndClause
   | OrClause;
 
 /**
- * Function clause.
+ * Predicate clause.
  *
  * @example
  * ```ts
  * (value) => value.featured === true;
  * ```
  */
-export type FunctionClause = (value: ModelData) => boolean;
+export type PredicateClause = (value: ModelData) => boolean;
 
 /**
  * Properties clause.
@@ -136,7 +136,7 @@ export declare type OperatorClause = {
  * ```
  */
 export interface AndClause {
-  and: WhereClause[];
+  and?: WhereClause[];
 }
 
 /**
@@ -150,7 +150,7 @@ export interface AndClause {
  * ```
  */
 export interface OrClause {
-  or: WhereClause[];
+  or?: WhereClause[];
 }
 
 /**
@@ -331,5 +331,5 @@ export declare type NestedIncludeClause = {
  */
 export declare type NormalizedIncludeClause = {
   relation: string;
-  scope?: Filter;
+  scope?: FilterClause;
 };

package/src/filter/include-clause-tool.d.ts

@@ -1,8 +1,8 @@
-import {Filter} from './filter.js';
 import {ModelData} from '../types.js';
-import {IncludeClause} from './filter.js';
 import {Service} from '@e22m4u/js-service';
-import {NormalizedIncludeClause} from './filter.js';
+import {FilterClause} from './filter-clause.js';
+import {IncludeClause} from './filter-clause.js';
+import {NormalizedIncludeClause} from './filter-clause.js';
 
 /**
  * Include clause tool.
@@ -33,7 +33,7 @@ export declare class IncludeClauseTool extends Service {
    *
    * @param clause
    */
-  static validateScopeClause(clause: Filter | undefined): void;
+  static validateScopeClause(clause: FilterClause | undefined): void;
 
   /**
    * Normalize include clause.
@@ -49,5 +49,7 @@ export declare class IncludeClauseTool extends Service {
    *
    * @param clause
    */
-  static normalizeScopeClause(clause: Filter | undefined): Filter | undefined;
+  static normalizeScopeClause(
+    clause: FilterClause | undefined,
+  ): FilterClause | undefined;
 }

package/src/filter/index.d.ts

@@ -1,4 +1,4 @@
-export * from './filter.js';
+export * from './filter-clause.js';
 export * from './slice-clause-tool.js';
 export * from './order-clause-tool.js';
 export * from './where-clause-tool.js';

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

@@ -504,7 +504,7 @@ export class OperatorClauseTool extends Service {
       const flags = clause.flags || undefined;
       if (flags && typeof flags !== 'string')
         throw new InvalidArgumentError(
-          'RegExp flags must be a String, but %v given.',
+          'RegExp flags should be a String, but %v given.',
           clause.flags,
         );
       if (!value || typeof value !== 'string') return false;

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

@@ -1049,7 +1049,7 @@ describe('OperatorClauseTool', function () {
       const throwable = v => () =>
         S.testRegexp({regexp: 'Val.+', flags: v}, 'val');
       const error = v =>
-        format('RegExp flags must be a String, but %s given.', v);
+        format('RegExp flags should be a String, but %s 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.d.ts

@@ -1,6 +1,6 @@
 import {ModelData} from '../types.js';
-import {OrderClause} from './filter.js';
 import {Service} from '@e22m4u/js-service';
+import {OrderClause} from './filter-clause.js';
 
 /**
  * Order clause tool.

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

@@ -13,14 +13,15 @@ export class OrderClauseTool extends Service {
    * @param {string|string[]|undefined} clause
    */
   sort(entities, clause) {
-    if (!clause) return;
-    if (!Array.isArray(clause)) clause = [clause];
+    if (clause == null) return;
+    if (Array.isArray(clause) === false) clause = [clause];
+    if (!clause.length) return;
     const mapping = [];
     clause.forEach((key, index) => {
-      if (typeof key !== 'string')
+      if (!key || typeof key !== 'string')
         throw new InvalidArgumentError(
-          'The provided option "order" should be a String ' +
-            'or an Array of String, but %v given.',
+          'The provided option "order" should be a non-empty String ' +
+            'or an Array of non-empty String, but %v given.',
           key,
         );
       let reverse = 1;
@@ -40,14 +41,15 @@ export class OrderClauseTool extends Service {
    * @param {string|string[]|undefined} clause
    */
   static validateOrderClause(clause) {
-    if (!clause) return;
-    const tempClause = Array.isArray(clause) ? clause : [clause];
-    tempClause.forEach(key => {
-      if (!key || typeof key !== 'string')
+    if (clause == null) return;
+    if (Array.isArray(clause) === false) clause = [clause];
+    if (!clause.length) return;
+    clause.forEach(field => {
+      if (!field || typeof field !== 'string')
         throw new InvalidArgumentError(
           'The provided option "order" should be a non-empty String ' +
-            'or an Array of String, but %v given.',
-          key,
+            'or an Array of non-empty String, but %v given.',
+          field,
         );
     });
   }
@@ -59,14 +61,15 @@ export class OrderClauseTool extends Service {
    * @returns {string[]|undefined}
    */
   static normalizeOrderClause(clause) {
-    if (!clause) return;
-    clause = Array.isArray(clause) ? clause : [clause];
-    clause.forEach(key => {
-      if (!key || typeof key !== 'string')
+    if (clause == null) return;
+    if (Array.isArray(clause) === false) clause = [clause];
+    if (!clause.length) return;
+    clause.forEach(field => {
+      if (!field || typeof field !== 'string')
         throw new InvalidArgumentError(
           'The provided option "order" should be a non-empty String ' +
-            'or an Array of String, but %v given.',
-          key,
+            'or an Array of non-empty String, but %v given.',
+          field,
         );
     });
     return clause;