fix: update typings

Author: Harrison Ifeanyichukwu

src/@types/index.d.ts

@@ -25,7 +25,7 @@ import ChoiceRule, { ChoiceOptions } from './rules/ChoiceRule';
 import BaseRule, {
   BaseOptions,
   SuccessOrErrorMessage,
-  DBCheck
+  ModelDBCheck
 } from './rules/BaseRule';
 import {
   FileRule,
@@ -216,7 +216,19 @@ export interface ResolvedRule<F extends string> {
 
   filters: Filters;
 
-  checks: DBCheck<F>[];
+  /**
+   * defines a list of database integrity checks to perform on the field value(s)
+   */
+  // note: this should be left as it to avoid typescript complaints
+  checks: Array<
+    | (<N extends Handler<F> = Handler<F>>(
+        value: DataValue,
+        index: number,
+        data: Data<F>,
+        handler: N
+      ) => Promise<DataValue> | DataValue)
+    | ModelDBCheck
+  >;
 
   /**
    * computes and return a new value for the field. it accepts two arguments

src/@types/rules/BaseRule.d.ts

@@ -13,14 +13,16 @@ export interface ModelDBCheck {
   err?: string;
 }
 
-export type DBCheckCallback<F extends string> = (
-  value: DataValue,
-  index: number,
-  data: Data<F>,
-  handler: Handler<F>
-) => Promise<SuccessOrErrorMessage> | SuccessOrErrorMessage;
+// export type DBCheckCallback<F extends string, N extends Handler<F>> = (
+//   value: DataValue,
+//   index: number,
+//   data: Data<F>,
+//   handler: N
+// ) => Promise<SuccessOrErrorMessage> | SuccessOrErrorMessage;
 
-export type DBCheck<F extends string> = DBCheckCallback<F> | ModelDBCheck;
+// export type DBCheck<F extends string, N extends Handler<F>> =
+//   | DBCheckCallback<F, N>
+//   | ModelDBCheck;
 
 export interface ShouldMatchObject<F extends string> {
   /**
@@ -87,7 +89,23 @@ export default interface BaseRule<F extends string> {
   /**
    * defines a list of database integrity checks to perform on the field value(s)
    */
-  checks?: DBCheck<F> | DBCheck<F>[];
+  checks?:
+    | (<N extends Handler<F> = Handler<F>>(
+        value: DataValue,
+        index: number,
+        data: Data<F>,
+        handler: N
+      ) => Promise<DataValue> | DataValue)
+    | ModelDBCheck
+    | Array<
+        | (<N extends Handler<F> = Handler<F>>(
+            value: DataValue,
+            index: number,
+            data: Data<F>,
+            handler: N
+          ) => Promise<DataValue> | DataValue)
+        | ModelDBCheck
+      >;
 
   /**
    * computes and return a new value for the field. it accepts two arguments

src/Common.ts

@@ -2,7 +2,7 @@ import { ErrorBag, Options } from './@types';
 import { isNumeric } from '@forensic-js/utils';
 import { replaceCallback } from '@forensic-js/regex';
 import StateException from './Exceptions/StateException';
-import { DBCheck } from './@types/rules/BaseRule';
+import { ModelDBCheck } from './@types/rules/BaseRule';
 
 export default class Common<F extends string = string> {
   protected errors: ErrorBag<F> = {} as ErrorBag<F>;
@@ -11,7 +11,7 @@ export default class Common<F extends string = string> {
 
   protected field: string = '';
 
-  protected options: Options<F> | DBCheck<F> = {};
+  protected options: Options<F> | ModelDBCheck = {};
 
   protected index: number = 0;
 
@@ -24,7 +24,11 @@ export default class Common<F extends string = string> {
    * @param options validation options
    * @param index field value index
    */
-  reset(field: string, options: Options<F> | DBCheck<F>, index: number): this {
+  reset(
+    field: string,
+    options: Options<F> | ModelDBCheck,
+    index: number
+  ): this {
     this.field = field;
     this.options = options;
     this.index = index;

src/Handler.ts

@@ -61,7 +61,7 @@ import {
   ordinalize,
   capitalize
 } from 'inflection';
-import { DBCheckType, DBCheck, ModelDBCheck } from './@types/rules/BaseRule';
+import { DBCheckType, ModelDBCheck } from './@types/rules/BaseRule';
 
 const globalConfig = {
   dbModel: DB_MODELS.NOSQL,
@@ -310,9 +310,10 @@ export default class Handler<F extends string = string> {
     required: boolean,
     field: string,
     value: DataValue,
-    checks: DBCheck<F>[],
+    rules: ResolvedRule<F>,
     index: number
   ) {
+    const { checks } = rules;
     for (const check of checks) {
       if (isCallable(check)) {
         const result = await check(value, index, this.data, this);
@@ -350,7 +351,9 @@ export default class Handler<F extends string = string> {
    */
   private async validateDBChecks(fields: string[], required: boolean) {
     for (const field of fields) {
-      const { checks, type } = this.resolvedRules[field] as ResolvedRule<F>;
+      const rules = this.resolvedRules[field] as ResolvedRule<F>;
+      const { checks, type } = rules;
+
       if (checks.length > 0) {
         const values = makeArray<DataValue>(this.data[field]);
 
@@ -363,7 +366,7 @@ export default class Handler<F extends string = string> {
             required,
             field,
             value === null ? '' : value.toString(),
-            checks,
+            rules,
             i
           );
         }
@@ -942,7 +945,7 @@ export default class Handler<F extends string = string> {
       requiredIf: pickValue('requiredIf', rule, undefined),
       options: pickObject('options', rule),
       filters: pickObject('filters', rule),
-      checks: makeArray(rule.checks as DBCheck<F>[]),
+      checks: rule.checks ? makeArray(rule.checks) : [],
       postCompute: pickValue('postCompute', rule, undefined),
       postValidate: pickValue('postValidate', rule, undefined)
     };