fix: fix typings

Author: Harrison Ifeanyichukwu

src/@types/index.d.ts

@@ -22,7 +22,11 @@ import {
 } from './rules/NumberRules';
 import RangeRule, { RangeOptions } from './rules/RangeRule';
 import ChoiceRule, { ChoiceOptions } from './rules/ChoiceRule';
-import BaseRule, { BaseOptions, SuccessOrErrorMessage } from './rules/BaseRule';
+import BaseRule, {
+  BaseOptions,
+  SuccessOrErrorMessage,
+  DBCheck
+} from './rules/BaseRule';
 import {
   FileRule,
   ImageFileRule,
@@ -107,8 +111,6 @@ export type DataType =
   | 'document'
   | 'archive';
 
-export type DBCheckType = 'exists' | 'notExists';
-
 export type RequiredIf<F extends string> =
   | {
       if: 'checked' | 'notChecked';
@@ -168,25 +170,6 @@ export type Options<F extends string> =
   | PhoneNumberOptions<F>
   | PasswordOptions<F>;
 
-export interface ModelDBCheck {
-  if: DBCheckType;
-  model: object;
-  field?: string;
-  query?: object;
-  err?: string;
-}
-export interface CallbackDBCheck<F extends string> {
-  if: DBCheckType;
-  callback: (
-    value: DataValue,
-    index: number,
-    data: Data<F>,
-    handler: Handler<F>
-  ) => Promise<SuccessOrErrorMessage> | SuccessOrErrorMessage;
-  err?: string;
-}
-export type DBCheck<F extends string> = CallbackDBCheck<F> | ModelDBCheck;
-
 export type Rule<F extends string> =
   | BooleanRule<F>
   | CheckboxRule<F>

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

@@ -1,8 +1,27 @@
-import { DataValue, RequiredIf, Filters, DBCheck, DataType, Data } from '..';
+import { DataValue, RequiredIf, Filters, DataType, Data } from '..';
 import Handler from '../../Handler';
 
 export type SuccessOrErrorMessage = boolean | string;
 
+export type DBCheckType = 'exists' | 'notExists';
+
+export interface ModelDBCheck {
+  if: DBCheckType;
+  model: object;
+  field?: string;
+  query?: object;
+  err?: string;
+}
+
+export type DBCheckCallback<F extends string> = (
+  value: DataValue,
+  index: number,
+  data: Data<F>,
+  handler: Handler<F>
+) => Promise<SuccessOrErrorMessage> | SuccessOrErrorMessage;
+
+export type DBCheck<F extends string> = DBCheckCallback<F> | ModelDBCheck;
+
 export interface ShouldMatchObject<F extends string> {
   /**
    * the target field

src/Common.ts

@@ -1,7 +1,8 @@
-import { ErrorBag, DBCheck, Options } from './@types';
+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';
 
 export default class Common<F extends string = string> {
   protected errors: ErrorBag<F> = {} as ErrorBag<F>;

src/DBChecker.ts

@@ -1,7 +1,8 @@
 import Common from './Common';
-import { DataValue, ModelDBCheck, ResolvedRules, DataType } from './@types';
+import { DataValue, DataType } from './@types';
 import { DB_MODELS } from './Constants';
 import { pickValue, applyCase } from '@forensic-js/utils';
+import { ModelDBCheck } from './@types/rules/BaseRule';
 
 export default class DBChecker<F extends string = string> extends Common<F> {
   private dbModel: number;

src/Handler.ts

@@ -12,10 +12,6 @@ import {
   Options,
   ErrorBag,
   RequiredIf,
-  DBCheck,
-  CallbackDBCheck,
-  ModelDBCheck,
-  DBCheckType,
   Data
 } from './@types';
 import { DB_MODELS } from './Constants';
@@ -65,13 +61,14 @@ import {
   ordinalize,
   capitalize
 } from 'inflection';
+import { DBCheckType, DBCheck, ModelDBCheck } from './@types/rules/BaseRule';
 
 const globalConfig = {
   dbModel: DB_MODELS.NOSQL,
   dbCaseStyle: CASE_STYLES.CAMEL_CASE
 };
 
-export default class Handler<F extends string = string, Exports = Data<F>> {
+export default class Handler<F extends string = string> {
   /**
    * supported database models
    */
@@ -317,13 +314,8 @@ export default class Handler<F extends string = string, Exports = Data<F>> {
     index: number
   ) {
     for (const check of checks) {
-      if (isTypeOf<CallbackDBCheck<F>>('callback', check)) {
-        const result = await check.callback(
-          value,
-          index,
-          this.data,
-          this as any
-        );
+      if (isCallable(check)) {
+        const result = await check(value, index, this.data, this);
         if (result !== true) {
           return this.setError(
             field,
@@ -339,7 +331,7 @@ export default class Handler<F extends string = string, Exports = Data<F>> {
           required,
           field,
           value,
-          check as ModelDBCheck,
+          check,
           index
         );
         if (this.dbChecker.fails()) {
@@ -1239,8 +1231,8 @@ export default class Handler<F extends string = string, Exports = Data<F>> {
   /**
    * creates and returns a model instance, that can be exported
    */
-  model(): Model<F, Exports> {
-    return new Model<F, Exports>(this);
+  model(): Model<F> {
+    return new Model<F>(this);
   }
 
   /**

src/Model.ts

@@ -2,14 +2,14 @@ import { expandProperty, applyCase } from '@forensic-js/utils';
 import Handler from './Handler';
 import { Data } from './@types';
 
-export default class Model<F extends string = string, Exports = Data<F>> {
+export default class Model<F extends string = string> {
   private handler: Handler<F>;
 
   private fieldsToSkip: string[] = [];
 
   private fieldsToRename: { [old: string]: string } = {};
 
-  constructor(handler: Handler<F, Exports>) {
+  constructor(handler: Handler<F>) {
     this.handler = handler;
   }
 
@@ -37,7 +37,9 @@ export default class Model<F extends string = string, Exports = Data<F>> {
    * @param fields object of field old name to new name value pairs
    */
   renameFields(fields: { [oldName: string]: string }) {
-    Object.keys(fields).forEach(oldName => (this.fieldsToRename[oldName] = fields[oldName]));
+    Object.keys(fields).forEach(
+      oldName => (this.fieldsToRename[oldName] = fields[oldName])
+    );
     return this;
   }
 
@@ -46,20 +48,29 @@ export default class Model<F extends string = string, Exports = Data<F>> {
    * @param target model to export data to
    * @param expandProperties boolean indicating if properties should be expanding
    */
-  export<T extends object>(target: T = {} as T, expandProperties: boolean = true): T & Exports {
+  export<T extends object>(
+    target: T = {} as T,
+    expandProperties: boolean = true
+  ): T & Data<F> {
     const { handler, fieldsToSkip, fieldsToRename } = this;
     Object.keys(handler.data).forEach(field => {
       if (!fieldsToSkip.includes(field)) {
         const newName = fieldsToRename[field] || field;
         const value = handler.data[field];
 
         if (expandProperties) {
-          expandProperty(target, newName, value, undefined, handler.getDBCaseStyle());
+          expandProperty(
+            target,
+            newName,
+            value,
+            undefined,
+            handler.getDBCaseStyle()
+          );
         } else {
           target[applyCase(newName, handler.getDBCaseStyle())] = value;
         }
       }
     });
-    return target as T & Exports;
+    return target as T & Data<F>;
   }
 }

tests/Handler.spec.ts

@@ -1402,16 +1402,10 @@ describe('Handler Module', function() {
       const callback = jest.fn(async () => true);
       handler.setRules({
         firstName: {
-          checks: {
-            if: 'exists',
-            callback
-          }
+          checks: callback
         },
         email: {
-          checks: {
-            if: 'exists',
-            callback: async () => false
-          }
+          checks: async () => false
         }
       });