-import { randomBytes, randomInt, randomUUID } from 'node:crypto';
-import { inspect } from 'node:util';
+import { getRandomValues, randomBytes, randomUUID } from 'node:crypto'
+import { env, nextTick } from 'node:process'
import {
formatDuration,
+ hoursToMinutes,
+ hoursToSeconds,
isDate,
millisecondsToHours,
millisecondsToMinutes,
millisecondsToSeconds,
- secondsToMilliseconds,
-} from 'date-fns';
-import clone from 'just-clone';
+ minutesToSeconds,
+ secondsToMilliseconds
+} from 'date-fns'
+import { is } from 'rambda'
-import { Constants } from './Constants';
-import { type TimestampedData, WebSocketCloseEventStatusString } from '../types';
+import {
+ type JsonType,
+ MapStringifyFormat,
+ type TimestampedData,
+ WebSocketCloseEventStatusString
+} from '../types/index.js'
export const logPrefix = (prefixString = ''): string => {
- return `${new Date().toLocaleString()}${prefixString}`;
-};
+ return `${new Date().toLocaleString()}${prefixString}`
+}
-export const generateUUID = (): string => {
- return randomUUID();
-};
+export const generateUUID = (): `${string}-${string}-${string}-${string}-${string}` => {
+ return randomUUID()
+}
-export const 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,
- );
-};
+export const validateUUID = (
+ uuid: `${string}-${string}-${string}-${string}-${string}`
+): uuid is `${string}-${string}-${string}-${string}-${string}` => {
+ 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)
+}
export const sleep = async (milliSeconds: number): Promise<NodeJS.Timeout> => {
- return new Promise<NodeJS.Timeout>((resolve) => setTimeout(resolve as () => void, milliSeconds));
-};
+ return await new Promise<NodeJS.Timeout>(resolve =>
+ setTimeout(resolve as () => void, milliSeconds)
+ )
+}
export const formatDurationMilliSeconds = (duration: number): string => {
- duration = convertToInt(duration);
- const days = Math.floor(duration / (24 * 3600 * 1000));
- const hours = Math.floor(millisecondsToHours(duration) - days * 24);
- const minutes = Math.floor(millisecondsToMinutes(duration) - days * 24 * 60 - hours * 60);
+ duration = convertToInt(duration)
+ if (duration < 0) {
+ throw new RangeError('Duration cannot be negative')
+ }
+ const days = Math.floor(duration / (24 * 3600 * 1000))
+ const hours = Math.floor(millisecondsToHours(duration) - days * 24)
+ const minutes = Math.floor(
+ millisecondsToMinutes(duration) - days * 24 * 60 - hoursToMinutes(hours)
+ )
const seconds = Math.floor(
- millisecondsToSeconds(duration) - days * 24 * 3600 - hours * 3600 - minutes * 60,
- );
+ millisecondsToSeconds(duration) -
+ days * 24 * 3600 -
+ hoursToSeconds(hours) -
+ minutesToSeconds(minutes)
+ )
+ if (days === 0 && hours === 0 && minutes === 0 && seconds === 0) {
+ return formatDuration({ seconds }, { zero: true })
+ }
return formatDuration({
days,
hours,
minutes,
- seconds,
- });
-};
+ seconds
+ })
+}
export const formatDurationSeconds = (duration: number): string => {
- return formatDurationMilliSeconds(secondsToMilliseconds(duration));
-};
+ return formatDurationMilliSeconds(secondsToMilliseconds(duration))
+}
-// More efficient date validation function than the one provided by date-fns
-export const isValidDate = (date: unknown): boolean => {
+// More efficient time validation function than the one provided by date-fns
+export const isValidDate = (date: Date | number | undefined): date is Date | number => {
if (typeof date === 'number') {
- return !isNaN(date);
+ return !isNaN(date)
} else if (isDate(date)) {
- return !isNaN((date as Date).getTime());
+ return !isNaN(date.getTime())
}
- return false;
-};
+ return false
+}
export const convertToDate = (
- value: Date | string | number | null | undefined,
-): Date | null | undefined => {
- if (isNullOrUndefined(value)) {
- return value as null | undefined;
+ value: Date | string | number | undefined | null
+): Date | undefined => {
+ if (value == null) {
+ return undefined
}
- if (value instanceof Date) {
- return value;
+ if (isDate(value)) {
+ return value
}
- if (isString(value) || typeof value === 'number') {
- return new Date(value!);
+ if (typeof value === 'string' || typeof value === 'number') {
+ const valueToDate = new Date(value)
+ if (isNaN(valueToDate.getTime())) {
+ throw new Error(`Cannot convert to date: '${value}'`)
+ }
+ return valueToDate
}
- return null;
-};
+}
export const convertToInt = (value: unknown): number => {
- if (!value) {
- return 0;
+ if (value == null) {
+ return 0
}
- let changedValue: number = value as number;
if (Number.isSafeInteger(value)) {
- return value as number;
+ return value as number
}
if (typeof value === 'number') {
- return Math.trunc(value);
+ return Math.trunc(value)
}
- if (isString(value)) {
- changedValue = parseInt(value as string);
+ let changedValue: number = value as number
+ if (typeof value === 'string') {
+ changedValue = parseInt(value)
}
if (isNaN(changedValue)) {
- // eslint-disable-next-line @typescript-eslint/no-base-to-string
- throw new Error(`Cannot convert to integer: ${value.toString()}`);
+ throw new Error(`Cannot convert to integer: '${String(value)}'`)
}
- return changedValue;
-};
+ return changedValue
+}
export const convertToFloat = (value: unknown): number => {
- if (!value) {
- return 0;
+ if (value == null) {
+ return 0
}
- let changedValue: number = value as number;
- if (isString(value)) {
- changedValue = parseFloat(value as string);
+ let changedValue: number = value as number
+ if (typeof value === 'string') {
+ changedValue = parseFloat(value)
}
if (isNaN(changedValue)) {
- // eslint-disable-next-line @typescript-eslint/no-base-to-string
- throw new Error(`Cannot convert to float: ${value.toString()}`);
+ throw new Error(`Cannot convert to float: '${String(value)}'`)
}
- return changedValue;
-};
+ return changedValue
+}
export const convertToBoolean = (value: unknown): boolean => {
- let result = false;
- if (value) {
+ let result = false
+ if (value != null) {
// Check the type
if (typeof value === 'boolean') {
- return value;
- } else if (isString(value) && ((value as string).toLowerCase() === 'true' || value === '1')) {
- result = true;
+ return value
+ } else if (typeof value === 'string' && (value.toLowerCase() === 'true' || value === '1')) {
+ result = true
} else if (typeof value === 'number' && value === 1) {
- result = true;
+ result = true
}
}
- return result;
-};
+ return result
+}
export const getRandomFloat = (max = Number.MAX_VALUE, min = 0): number => {
if (max < min) {
- throw new RangeError('Invalid interval');
+ throw new RangeError('Invalid interval')
}
if (max - min === Infinity) {
- throw new RangeError('Invalid interval');
+ throw new RangeError('Invalid interval')
}
- return (randomBytes(4).readUInt32LE() / 0xffffffff) * (max - min) + min;
-};
-
-export const getRandomInteger = (max = Constants.MAX_RANDOM_INTEGER, min = 0): number => {
- max = Math.floor(max);
- if (!isNullOrUndefined(min) && min !== 0) {
- min = Math.ceil(min);
- return Math.floor(randomInt(min, max + 1));
- }
- return Math.floor(randomInt(max + 1));
-};
+ return (randomBytes(4).readUInt32LE() / 0xffffffff) * (max - min) + min
+}
/**
* Rounds the given number to the given scale.
* @returns The rounded number.
*/
export const roundTo = (numberValue: number, scale: number): number => {
- const roundPower = Math.pow(10, scale);
- return Math.round(numberValue * roundPower * (1 + Number.EPSILON)) / roundPower;
-};
+ const roundPower = Math.pow(10, scale)
+ return Math.round(numberValue * roundPower * (1 + Number.EPSILON)) / roundPower
+}
export const getRandomFloatRounded = (max = Number.MAX_VALUE, min = 0, scale = 2): number => {
- if (min) {
- return roundTo(getRandomFloat(max, min), scale);
+ if (min !== 0) {
+ return roundTo(getRandomFloat(max, min), scale)
}
- return roundTo(getRandomFloat(max), scale);
-};
+ return roundTo(getRandomFloat(max), scale)
+}
export const getRandomFloatFluctuatedRounded = (
staticValue: number,
fluctuationPercent: number,
- scale = 2,
+ scale = 2
): number => {
if (fluctuationPercent < 0 || fluctuationPercent > 100) {
throw new RangeError(
- `Fluctuation percent must be between 0 and 100. Actual value: ${fluctuationPercent}`,
- );
+ `Fluctuation percent must be between 0 and 100. Actual value: ${fluctuationPercent}`
+ )
}
if (fluctuationPercent === 0) {
- return roundTo(staticValue, scale);
+ return roundTo(staticValue, scale)
}
- const fluctuationRatio = fluctuationPercent / 100;
+ const fluctuationRatio = fluctuationPercent / 100
return getRandomFloatRounded(
staticValue * (1 + fluctuationRatio),
staticValue * (1 - fluctuationRatio),
- scale,
- );
-};
-
-export const extractTimeSeriesValues = (timeSeries: Array<TimestampedData>): number[] => {
- return timeSeries.map((timeSeriesItem) => timeSeriesItem.value);
-};
-
-export const isObject = (item: unknown): boolean => {
- return (
- isNullOrUndefined(item) === false && typeof item === 'object' && Array.isArray(item) === false
- );
-};
-
-export const cloneObject = <T extends object>(object: T): T => {
- return clone<T>(object);
-};
-
-export const hasOwnProp = (object: unknown, property: PropertyKey): boolean => {
- return isObject(object) && Object.hasOwn(object as object, property);
-};
-
-export const isCFEnvironment = (): boolean => {
- return !isNullOrUndefined(process.env.VCAP_APPLICATION);
-};
-
-export const isIterable = <T>(obj: T): boolean => {
- return !isNullOrUndefined(obj) ? typeof obj[Symbol.iterator as keyof T] === 'function' : false;
-};
+ scale
+ )
+}
-const isString = (value: unknown): boolean => {
- return typeof value === 'string';
-};
+export const extractTimeSeriesValues = (timeSeries: TimestampedData[]): number[] => {
+ return timeSeries.map(timeSeriesItem => timeSeriesItem.value)
+}
-export const isEmptyString = (value: unknown): boolean => {
- return isNullOrUndefined(value) || (isString(value) && (value as string).trim().length === 0);
-};
+export const clone = <T>(object: T): T => {
+ return structuredClone<T>(object)
+}
-export const isNotEmptyString = (value: unknown): boolean => {
- return isString(value) && (value as string).trim().length > 0;
-};
+/**
+ * Detects whether the given value is an asynchronous function or not.
+ *
+ * @param fn - Unknown value.
+ * @returns `true` if `fn` was an asynchronous function, otherwise `false`.
+ * @internal
+ */
+export const isAsyncFunction = (fn: unknown): fn is (...args: unknown[]) => Promise<unknown> => {
+ return is(Function, fn) && fn.constructor.name === 'AsyncFunction'
+}
-export const isUndefined = (value: unknown): boolean => {
- return value === undefined;
-};
+export const isObject = (value: unknown): value is object => {
+ return value != null && !Array.isArray(value) && is(Object, value)
+}
-export const isNullOrUndefined = (value: unknown): boolean => {
- // eslint-disable-next-line eqeqeq, no-eq-null
- return value == null;
-};
+export const hasOwnProp = (value: unknown, property: PropertyKey): boolean => {
+ return isObject(value) && Object.hasOwn(value, property)
+}
-export const isEmptyArray = (object: unknown): boolean => {
- return Array.isArray(object) && object.length === 0;
-};
+export const isCFEnvironment = (): boolean => {
+ return env.VCAP_APPLICATION != null
+}
-export const isNotEmptyArray = (object: unknown): boolean => {
- return Array.isArray(object) && object.length > 0;
-};
+export const isNotEmptyString = (value: unknown): value is string => {
+ return typeof value === 'string' && value.trim().length > 0
+}
-export const isEmptyObject = (obj: object): boolean => {
- 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;
-};
+export const isNotEmptyArray = (value: unknown): value is unknown[] => {
+ return Array.isArray(value) && value.length > 0
+}
export const insertAt = (str: string, subStr: string, pos: number): string =>
- `${str.slice(0, pos)}${subStr}${str.slice(pos)}`;
+ `${str.slice(0, pos)}${subStr}${str.slice(pos)}`
/**
* Computes the retry delay in milliseconds using an exponential backoff algorithm.
*
* @param retryNumber - the number of retries that have already been attempted
+ * @param delayFactor - the base delay factor in milliseconds
* @returns delay in milliseconds
*/
-export const exponentialDelay = (retryNumber = 0, maxDelayRatio = 0.2): number => {
- const delay = Math.pow(2, retryNumber) * 100;
- const randomSum = delay * maxDelayRatio * secureRandom(); // 0-20% of the delay
- return delay + randomSum;
-};
-
-const isPromisePending = (promise: Promise<unknown>): boolean => {
- return inspect(promise).includes('pending');
-};
-
-export const promiseWithTimeout = async <T>(
- promise: Promise<T>,
- timeoutMs: number,
- timeoutError: Error,
- timeoutCallback: () => void = () => {
- /* This is intentional */
- },
-): Promise<T> => {
- // Create a timeout promise that rejects in timeout milliseconds
- const timeoutPromise = new Promise<never>((_, reject) => {
- setTimeout(() => {
- if (isPromisePending(promise)) {
- timeoutCallback();
- // FIXME: The original promise shall be canceled
- }
- reject(timeoutError);
- }, timeoutMs);
- });
-
- // Returns a race between timeout promise and the passed promise
- return Promise.race<T>([promise, timeoutPromise]);
-};
+export const exponentialDelay = (retryNumber = 0, delayFactor = 100): number => {
+ const delay = Math.pow(2, retryNumber) * delayFactor
+ const randomSum = delay * 0.2 * secureRandom() // 0-20% of the delay
+ return delay + randomSum
+}
/**
* Generates a cryptographically secure random number in the [0,1[ range
*
- * @returns
+ * @returns A number in the [0,1[ range
*/
export const secureRandom = (): number => {
- return randomBytes(4).readUInt32LE() / 0x100000000;
-};
-
-export const JSONStringifyWithMapSupport = (
- obj: Record<string, unknown> | Record<string, unknown>[] | Map<unknown, unknown>,
- space?: number,
-): string => {
+ return getRandomValues(new Uint32Array(1))[0] / 0x100000000
+}
+
+export const JSONStringify = <
+ T extends
+ | JsonType
+ | Array<Record<string, unknown>>
+ | Set<Record<string, unknown>>
+ | Map<string, Record<string, unknown>>
+>(
+ object: T,
+ space?: string | number,
+ mapFormat?: MapStringifyFormat
+ ): string => {
return JSON.stringify(
- obj,
+ object,
(_, value: Record<string, unknown>) => {
- if (value instanceof Map) {
- return {
- dataType: 'Map',
- value: [...value],
- };
+ if (is(Map, value)) {
+ switch (mapFormat) {
+ case MapStringifyFormat.object:
+ return { ...Object.fromEntries<Map<string, Record<string, unknown>>>(value.entries()) }
+ case MapStringifyFormat.array:
+ default:
+ return [...value]
+ }
+ } else if (is(Set, value)) {
+ return [...value] as JsonType[]
}
- return value;
+ return value
},
- space,
- );
-};
+ space
+ )
+}
/**
* Converts websocket error code to human readable string message
*/
export const getWebSocketCloseEventStatusString = (code: number): string => {
if (code >= 0 && code <= 999) {
- return '(Unused)';
+ return '(Unused)'
} else if (code >= 1016) {
if (code <= 1999) {
- return '(For WebSocket standard)';
+ return '(For WebSocket standard)'
} else if (code <= 2999) {
- return '(For WebSocket extensions)';
+ return '(For WebSocket extensions)'
} else if (code <= 3999) {
- return '(For libraries and frameworks)';
+ return '(For libraries and frameworks)'
} else if (code <= 4999) {
- return '(For applications)';
+ return '(For applications)'
}
}
if (
- !isUndefined(
- WebSocketCloseEventStatusString[code as keyof typeof WebSocketCloseEventStatusString],
- )
+ // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+ WebSocketCloseEventStatusString[code as keyof typeof WebSocketCloseEventStatusString] != null
) {
- return WebSocketCloseEventStatusString[code as keyof typeof WebSocketCloseEventStatusString];
+ return WebSocketCloseEventStatusString[code as keyof typeof WebSocketCloseEventStatusString]
+ }
+ return '(Unknown)'
+}
+
+export const isArraySorted = <T>(array: T[], compareFn: (a: T, b: T) => number): boolean => {
+ for (let index = 0; index < array.length - 1; ++index) {
+ if (compareFn(array[index], array[index + 1]) > 0) {
+ return false
+ }
}
- return '(Unknown)';
-};
+ return true
+}
+
+export const throwErrorInNextTick = (error: Error): void => {
+ nextTick(() => {
+ throw error
+ })
+}
repositories / e-mobility-charging-stations-simulator.git / blobdiff