topkat-utils 1.1.14 → 1.2.1

package/src/object-utils.ts

@@ -1,12 +1,12 @@
 //----------------------------------------
 // OBJECT UTILS
 //----------------------------------------
-import { ObjectGeneric } from "./private/types"
+import { ObjectGeneric } from "./types"
 import { err500IfNotSet } from "./error-utils"
 import { recursiveGenericFunctionSync } from "./loop-utils"
 import { isset } from "./isset"
 import { isObject } from "./is-object"
-import { dataValidationUtilErrorHandler } from "./private/error-handler"
+import { DescriptiveError } from "./error-utils"
 
 /**
  * 
@@ -97,7 +97,7 @@ export function objForceWrite(obj: ObjectGeneric, addr: string, item) {
             const nextChunk = chunks[i + 1]
             if (isset(nextChunk) && nextChunk.startsWith('[')) lastItem[chunk] = []
             else lastItem[chunk] = {}
-        } else if (typeof lastItem[chunk] !== 'object') throw new dataValidationUtilErrorHandler(`itemNotTypeObjectOrArrayInAddrChainForObjForceWrite`, 500, { origin: 'Validator', chunks, actualValueOfItem: lastItem[chunk], actualChunk: chunk })
+        } else if (typeof lastItem[chunk] !== 'object') throw new DescriptiveError(`itemNotTypeObjectOrArrayInAddrChainForObjForceWrite`, { code: 500, origin: 'Validator', chunks, actualValueOfItem: lastItem[chunk], actualChunk: chunk })
         lastItem = lastItem[chunk]
     })
 }
@@ -191,7 +191,7 @@ export function objFilterUndefined(o) {
 
 /** Lock all 1st level props of an object to read only */
 export function readOnly(o) {
-    const throwErr = () => { throw new dataValidationUtilErrorHandler('Cannot modify object that is read only', 500) }
+    const throwErr = () => { throw new DescriptiveError('Cannot modify object that is read only', { code: 500 }) }
     return new Proxy(o, {
         set: throwErr,
         defineProperty: throwErr,
@@ -203,14 +203,14 @@ export function readOnly(o) {
 export function reassignForbidden(o) {
     return new Proxy(o, {
         defineProperty: function (that, key, value) {
-            if (key in that) throw new dataValidationUtilErrorHandler(`Cannot reassign the property ${key.toString()} of this object`, 500)
+            if (key in that) throw new DescriptiveError(`Cannot reassign the property ${key.toString()} of this object`, { code: 500 })
             else {
                 that[key] = value
                 return true
             }
         },
         deleteProperty: function (_, key) {
-            throw new dataValidationUtilErrorHandler(`Cannot delete the property ${key.toString()} of this object`, 500)
+            throw new DescriptiveError(`Cannot delete the property ${key.toString()} of this object`, { code: 500 })
         }
     })
 }

package/src/string-utils.ts

@@ -2,7 +2,7 @@
 // STRING UTILS
 //----------------------------------------
 import { err500IfEmptyOrNotSet } from "./error-utils"
-import { ObjectGeneric } from "./private/types"
+import { ObjectGeneric } from "./types"
 import { isset } from "./isset"
 
 /**Eg: camelCase */

package/src/tests-utils.ts

@@ -5,7 +5,7 @@ import { C } from "./logger-utils"
 import { ValidatorObject } from "./validation-utils"
 import { isset } from "./isset"
 import { validatorReturnErrArray } from "./validation-utils"
-import { Override } from "./private/types"
+import { Override } from "./types"
 import { isObject } from "./is-object"
 
 export const restTestMini = {
@@ -55,7 +55,7 @@ export function assert(description: string, value: any, validatorObject?: Overri
         else if (isset(validatorObject)) validatorObjReal.eq = validatorObject
 
         const issetCheck = !isset(validatorObjReal) // isEmpty()
-        const [errMsg, , extraInfos] = validatorReturnErrArray(validatorObjReal)
+        const [errMsg, extraInfos] = validatorReturnErrArray(validatorObjReal)
         const msg2 = description + ` ${issetCheck ? 'isset' : `${JSON.stringify(validatorObject)}`}`
         if (isset(errMsg)) {
             const err = msg2 + `\n    ${errMsg}\n    ${JSON.stringify(extraInfos)}`

package/src/timer-utils.ts

@@ -3,7 +3,7 @@
 // TIMEOUT UTILS
 //----------------------------------------
 import { cliProgressBar, C } from "./logger-utils"
-import { dataValidationUtilErrorHandler } from "./private/error-handler"
+import { DescriptiveError } from "./error-utils"
 
 
 export async function timeout(ms, fn = () => { }) { return new Promise(res => setTimeout(res, ms)).then(fn) }
@@ -29,7 +29,7 @@ export async function waitUntilTrue(callback, timeoutSec = 10, errorAfterNSecond
         await timeout(300)
     }
     if (cliOutput) process.stdout.write(`\n`)
-    if (!generalTimeout && errorAfterNSeconds) throw new dataValidationUtilErrorHandler(errMess, 500)
+    if (!generalTimeout && errorAfterNSeconds) throw new DescriptiveError(errMess, { code: 500 })
 }
 
 

package/src/validation-utils.ts

@@ -1,12 +1,12 @@
 //----------------------------------------
 // VALIDATION UTILS
 //----------------------------------------
-import { dataValidationUtilErrorHandler } from "./private/error-handler"
 import { isset } from "./isset"
 import { isDateIsoOrObjectValid, isDateIntOrStringValid, isTimeStringValid } from "./date-utils"
 import { asArray } from "./array-utils"
 import { configFn } from "./config"
 import { isEmpty } from "./is-empty"
+import { DescriptiveError } from "./error-utils"
 import { removeCircularJSONstringify } from "./remove-circular-json-stringify"
 
 export type BaseTypes = 'objectId' | 'dateInt6' | 'dateInt' | 'dateInt8' | 'dateInt12' | 'time' | 'humanReadableTimestamp' | 'date' | 'dateObject' | 'array' | 'object' | 'buffer' | 'string' | 'function' | 'boolean' | 'number' | 'bigint' | 'year' | 'email' | 'any'
@@ -22,7 +22,7 @@ export function checkAllObjectValuesAreEmpty(o) { return Object.values(o).every(
 
 /** Throw an error in case data passed is not a valid ctx */
 export function checkCtxIntegrity(ctx) {
-    if (!isset(ctx) || !isset(ctx.user)) throw new dataValidationUtilErrorHandler('ctxNotSet', 500)
+    if (!isset(ctx) || !isset(ctx.user)) throw new DescriptiveError('ctxNotSet', { code: 500 })
 }
 
 /**
@@ -90,7 +90,7 @@ export type ValidatorObject = {
 }
 export function validator(...paramsToValidate: ValidatorObject[]) {
     const errArray = validatorReturnErrArray(...paramsToValidate)
-    if (errArray.length) throw new dataValidationUtilErrorHandler(...errArray)
+    if (errArray.length) throw new DescriptiveError(...errArray)
 }
 
 
@@ -107,13 +107,13 @@ export function isValid(...paramsToValidate) {
  */
 export function isType(value, type: BaseTypes) { return isValid({ name: 'Is type check', value, type }) }
 
-export function validatorReturnErrArray(...paramsToValidate: ValidatorObject[]): [string?, number?, object?] {
+export function validatorReturnErrArray(...paramsToValidate: ValidatorObject[]): [string?, object?] {
     let paramsFormatted: ValidatorObject[] = []
 
     // support for multiple names with multiple values for one rule. Eg: {name: [{startDate:'20180101'}, {endDate:'20180101'}], type: 'dateInt8'}
     paramsToValidate.forEach(param => {
         if (typeof param !== 'object' || Array.isArray(param))
-            throw new dataValidationUtilErrorHandler(`wrongTypeForDataValidatorArgument`, 500, { origin: 'Generic validator', expectedType: 'object', actualType: Array.isArray(param) ? 'array' : typeof param })
+            throw new DescriptiveError(`wrongTypeForDataValidatorArgument`, { code: 500, origin: 'Generic validator', expectedType: 'object', actualType: Array.isArray(param) ? 'array' : typeof param })
 
         // parse => name: {myVar1: 'blah, myvar2: myvar2}
         if (typeof param.name === 'object' && !Array.isArray(param.name))
@@ -127,12 +127,12 @@ export function validatorReturnErrArray(...paramsToValidate: ValidatorObject[]):
         let optional = paramObj.optional || false
         let emptyAllowed = optional || paramObj.emptyAllowed || false
         if (paramObj.isset === false) paramObj.mustNotBeSet = true // ALIAS 
-        const errMess = (msg, extraInfos = {}, errCode = 422): [string, number, object] => [msg, errCode, { origin: 'Generic validator', varName: name, gotValue: isset(value) && isset(value.data) && isset(value.data.data) ? { ...value, data: 'Buffer' } : value, ...extraInfos }]
+        const errMess = (msg, extraInfos = {}, errCode = 422): [string, object] => [msg, { code: errCode, origin: 'Generic validator', varName: name, gotValue: isset(value) && isset(value.data) && isset(value.data.data) ? { ...value, data: 'Buffer' } : value, ...extraInfos }]
 
         // accept syntax { 'myVar.var2': myVar.var2, ... }
         if (!isset(name)) {
             name = Object.keys(paramObj).find(param => !['in', 'eq', 'lte', 'gte', 'name', 'value', 'type', 'regexp', 'minLength', 'maxLength', 'optional', 'emptyAllowed', 'mustNotBeSet', 'includes', 'length'].includes(param))
-            if (isset(name)) value = paramObj[name] // throw new dataValidationUtilErrorHandler('noNameProvidedForDataValidator', 500, { origin: 'Generic validator', });
+            if (isset(name)) value = paramObj[name]
         }
         // if nameString ends by $ sign it is optional
         if (isset(name) && /.*\$$/.test(name)) {
@@ -183,7 +183,7 @@ export function validatorReturnErrArray(...paramsToValidate: ValidatorObject[]):
                     //...Object.keys(configFn().customTypes)
                 ]
 
-                if (!allTypes.includes(type)) throw new dataValidationUtilErrorHandler('typeDoNotExist', 500, { type })
+                if (!allTypes.includes(type)) throw new DescriptiveError('typeDoNotExist', { code: 500, type })
 
                 const basicTypeCheck = {
                     objectId: val => /^[0-9a-fA-F-]{24,}$/.test(val), // "0c65940b-6b0c-4dd8-9c7a-7c5fe1ba907a"

package/src/private/error-handler.ts

@@ -1,21 +0,0 @@
-export class dataValidationUtilErrorHandler extends Error {
-    fromDataValidation: boolean
-    code: number
-    extraInfos: object
-    msg: string
-    errorDescription: { [k: string]: any }
-    constructor(msg, code, extraInfos?) {
-        super(msg)
-        this.message = msg
-        this.msg = msg
-        this.name = `${code} ${msg}`
-        this.fromDataValidation = true // will be catched by express error handler
-        this.code = code
-        this.extraInfos = extraInfos
-        this.errorDescription = {
-            msg,
-            code,
-            ...extraInfos,
-        }
-    }
-}