X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FUtils.ts;h=94fa3d186e432712238ceee87e7f3491244cb5b7;hb=953d6b028e82d6997897802afefbb4ce0d225dee;hp=9486ca0972b46febddae58d0268a052fcd4199c8;hpb=479f37587d3341fc99ccbc79a7738f7a6847e713;p=e-mobility-charging-stations-simulator.git diff --git a/src/utils/Utils.ts b/src/utils/Utils.ts index 9486ca09..94fa3d18 100644 --- a/src/utils/Utils.ts +++ b/src/utils/Utils.ts @@ -1,5 +1,8 @@ import crypto from 'crypto'; -import { v4 as uuid } from 'uuid'; + +import clone from 'just-clone'; + +import { WebSocketCloseEventStatusString } from '../types/WebSocket'; export default class Utils { private constructor() { @@ -11,7 +14,13 @@ export default class Utils { } public static generateUUID(): string { - return uuid(); + return crypto.randomUUID(); + } + + public static validateUUID(uuid: string): boolean { + return /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.test( + uuid + ); } public static async sleep(milliSeconds: number): Promise { @@ -43,65 +52,75 @@ export default class Utils { return Utils.formatDurationMilliSeconds(duration * 1000); } - public static convertToDate(value: unknown): Date { - // Check - if (!value) { - return value as Date; + public static convertToDate( + value: Date | string | number | null | undefined + ): Date | null | undefined { + if (Utils.isNullOrUndefined(value)) { + return value as null | undefined; + } + if (value instanceof Date) { + return value; } - // Check Type - if (!(value instanceof Date)) { - return new Date(value as string); + if (Utils.isString(value) || typeof value === 'number') { + return new Date(value); } - return value; + return null; } public static convertToInt(value: unknown): number { - let changedValue: number = value as number; if (!value) { return 0; } + let changedValue: number = value as number; if (Number.isSafeInteger(value)) { return value as number; } - // Check + if (typeof value === 'number') { + return Math.trunc(value); + } if (Utils.isString(value)) { - // Create Object changedValue = parseInt(value as string); } + if (isNaN(changedValue)) { + throw new Error(`Cannot convert to integer: ${value.toString()}`); + } return changedValue; } public static convertToFloat(value: unknown): number { - let changedValue: number = value as number; if (!value) { return 0; } - // Check + let changedValue: number = value as number; if (Utils.isString(value)) { - // Create Object changedValue = parseFloat(value as string); } + if (isNaN(changedValue)) { + throw new Error(`Cannot convert to float: ${value.toString()}`); + } return changedValue; } public static convertToBoolean(value: unknown): boolean { let result = false; - // Check boolean if (value) { // Check the type if (typeof value === 'boolean') { - // Already a boolean - result = value; - } else { - // Convert - result = value === 'true'; + return value; + } else if ( + Utils.isString(value) && + ((value as string).toLowerCase() === 'true' || value === '1') + ) { + result = true; + } else if (typeof value === 'number' && value === 1) { + result = true; } } return result; } - public static getRandomFloat(max: number, min = 0, negative = false): number { - if (max < min || min < 0 || max < 0) { + public static getRandomFloat(max = Number.MAX_VALUE, min = 0, negative = false): number { + if (max < min || max < 0 || min < 0) { throw new RangeError('Invalid interval'); } const randomPositiveFloat = crypto.randomBytes(4).readUInt32LE() / 0xffffffff; @@ -109,15 +128,12 @@ export default class Utils { return sign * (randomPositiveFloat * (max - min) + min); } - public static getRandomInteger(max: number, min = 0): number { - if (max < 0) { + public static getRandomInteger(max = Number.MAX_SAFE_INTEGER, min = 0): number { + if (max < min || max < 0 || min < 0) { throw new RangeError('Invalid interval'); } max = Math.floor(max); - if (min) { - if (max < min || min < 0) { - throw new RangeError('Invalid interval'); - } + if (!Utils.isNullOrUndefined(min) && min !== 0) { min = Math.ceil(min); return Math.floor(Utils.secureRandom() * (max - min + 1)) + min; } @@ -134,7 +150,7 @@ export default class Utils { return Math.trunc(numberValue * truncPower) / truncPower; } - public static getRandomFloatRounded(max: number, min = 0, scale = 2): number { + public static getRandomFloatRounded(max = Number.MAX_VALUE, min = 0, scale = 2): number { if (min) { return Utils.roundTo(Utils.getRandomFloat(max, min), scale); } @@ -157,8 +173,12 @@ export default class Utils { ); } - public static cloneObject(object: T): T { - return JSON.parse(JSON.stringify(object)) as T; + public static isObject(item: unknown): boolean { + return item && typeof item === 'object' && Array.isArray(item) === false; + } + + public static cloneObject(object: T): T { + return clone(object); } public static isIterable(obj: T): boolean { @@ -170,7 +190,7 @@ export default class Utils { } public static isEmptyString(value: unknown): boolean { - return Utils.isString(value) && (value as string).length === 0; + return Utils.isString(value) && (value as string).trim().length === 0; } public static isUndefined(value: unknown): boolean { @@ -182,25 +202,33 @@ export default class Utils { return value == null ? true : false; } - public static isEmptyArray(object: unknown): boolean { - if (!object) { + public static isEmptyArray(object: unknown | unknown[]): boolean { + if (!Array.isArray(object)) { return true; } - if (Array.isArray(object) && object.length > 0) { + if (object.length > 0) { return false; } return true; } public static isEmptyObject(obj: object): boolean { - return !Object.keys(obj).length; + if (obj?.constructor !== Object) { + return false; + } + // Iterates over the keys of an object, if + // any exist, return false. + for (const _ in obj) { + return false; + } + return true; } public static insertAt = (str: string, subStr: string, pos: number): string => `${str.slice(0, pos)}${subStr}${str.slice(pos)}`; /** - * @param [retryNumber=0] + * @param retryNumber - the number of retries that have already been attempted * @returns delay in milliseconds */ public static exponentialDelay(retryNumber = 0): number { @@ -237,4 +265,49 @@ export default class Utils { public static secureRandom(): number { return crypto.randomBytes(4).readUInt32LE() / 0x100000000; } + + public static JSONStringifyWithMapSupport( + obj: Record | Record[] | Map, + space?: number + ): string { + return JSON.stringify( + obj, + (key, value: Record) => { + if (value instanceof Map) { + return { + dataType: 'Map', + value: [...value], + }; + } + return value; + }, + space + ); + } + + /** + * Convert websocket error code to human readable string message + * + * @param code - websocket error code + * @returns human readable string message + */ + public static getWebSocketCloseEventStatusString(code: number): string { + if (code >= 0 && code <= 999) { + return '(Unused)'; + } else if (code >= 1016) { + if (code <= 1999) { + return '(For WebSocket standard)'; + } else if (code <= 2999) { + return '(For WebSocket extensions)'; + } else if (code <= 3999) { + return '(For libraries and frameworks)'; + } else if (code <= 4999) { + return '(For applications)'; + } + } + if (!Utils.isUndefined(WebSocketCloseEventStatusString[code])) { + return WebSocketCloseEventStatusString[code] as string; + } + return '(Unknown)'; + } }