topkat-utils 1.0.34 → 1.0.37

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+### v1.0.37
+* add generateObjectId
+* cleaning and typing improvements
+
+### v1.0.35
+* fix in asArray typing
+
 ### v1.0.32
 * safer generateToken
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "topkat-utils",
-  "version": "1.0.34",
+  "version": "1.0.37",
   "type": "module",
   "private": false,
   "description": "UTILS BIG TIME",

package/utils.d.ts

@@ -5,6 +5,9 @@ declare const arrayUniqueValue: typeof noDuplicateFilter;
 declare const JSONstringyParse: (o: any) => any;
 declare const removeUndefinedKeys: typeof objFilterUndefinedRecursive;
 declare type Color = [number, number, number];
+declare type ObjectGeneric = {
+    [k: string]: any;
+};
 declare type BaseTypes = 'objectId' | 'dateInt6' | 'dateInt' | 'dateInt8' | 'dateInt12' | 'time' | 'humanReadableTimestamp' | 'date' | 'dateObject' | 'array' | 'object' | 'buffer' | 'string' | 'function' | 'boolean' | 'number' | 'bigint' | 'year' | 'email';
 /** Round with custom number of decimals (default:0) */
 declare function round(number: number, decimals?: number): number;
@@ -23,7 +26,7 @@ declare function moyenne(array: number[], nbOfDecimals?: number): number;
 /** Clean output for outside world. All undefined / null / NaN / Infinity values are changed to '-' */
 declare function cln(val: any, replacerInCaseItIsUndefinNaN?: string): any;
 /** length default 2, shortcut for 1 to 01 */
-declare function pad(numberOrStr: any, length?: number): string;
+declare function pad(numberOrStr: number | string, length?: number): string;
 /** return the number or the closest number of the range
  * * nb min max  => returns
  * * 7  5   10   => 7 // in the range
@@ -31,19 +34,20 @@ declare function pad(numberOrStr: any, length?: number): string;
  * * 99 5   10   => 10// above the max value
  */
 declare function minMax(nb: number, min: number, max: number): number;
-declare function tryCatch(callback: any, onErr?: Function): Promise<any>;
+declare function tryCatch(callback: Function, onErr?: Function): Promise<any>;
 /** minLength 8 if unique
 * @param {Number} length default: 20
 * @param {Boolean} unique default: true. Generate a real unique token base on the date. min length will be min 8 in this case
 * @param {string} mode one of ['alphanumeric', 'hexadecimal']
 * NOTE: to generate a mongoDB Random Id, use the params: 24, true, 'hexadecimal'
 */
-declare function generateToken(length?: number, unique?: boolean, mode?: string): any;
+declare function generateToken(length?: number, unique?: boolean, mode?: 'alphanumeric' | 'hexadecimal'): any;
+declare function generateObjectId(): any;
 /** Useful to join differents bits of url with normalizing slashes
  * * urlPathJoin('https://', 'www.kikou.lol/', '/user', '//2//') => https://www.kikou.lol/user/2/
  * * urlPathJoin('http:/', 'kikou.lol') => https://www.kikou.lol
  */
-declare function urlPathJoin(...bits: any[]): string;
+declare function urlPathJoin(...bits: string[]): string;
 /** path shall always be sorted before using in express
  *  to avoid a generic route like /* to catch a specific one like /bonjour
  *
@@ -52,15 +56,18 @@ declare function urlPathJoin(...bits: any[]): string;
  * @return {Array} urls modified
  */
 declare function sortUrlsByDeepnessInArrayOrObject(urlObjOrArr: any, propInObjectOrIndexInArray: any): any;
-/**
- * Replace variables in a string like: `Hello {{userName}}!`
+declare type MiniTemplaterOptions = {
+    valueWhenNotSet?: string;
+    regexp?: RegExp;
+};
+/** Replace variables in a string like: `Hello {{userName}}!`
  * @param {String} content
  * @param {Object} varz object with key => value === toReplace => replacer
  * @param {Object} options
  * * valueWhenNotSet => replacer for undefined values. Default: ''
  * * regexp          => must be 'g' and first capturing group matching the value to replace. Default: /{{\s*([^}]*)\s*}}/g
  */
-declare function miniTemplater(content: any, varz: any, options: any): any;
+declare function miniTemplater(content: string, varz: ObjectGeneric, options?: MiniTemplaterOptions): string;
 /**
  *
  * @param {Object} object main object
@@ -68,7 +75,7 @@ declare function miniTemplater(content: any, varz: any, options: any): any;
  * @param {Boolean} isMask default: true; determine the behavior of the function. If is mask, selected fields will not appear in the resulting object. If it's a select, only selected fields will appear.
  * @param {Boolean} deleteKeysInsteadOfReturningAnewObject default:false; modify the existing object instead of creating a new instance
  */
-declare function simpleObjectMaskOrSelect(object: any, maskedOrSelectedFields: any, isMask?: boolean, deleteKeysInsteadOfReturningAnewObject?: boolean): any;
+declare function simpleObjectMaskOrSelect(object: ObjectGeneric, maskedOrSelectedFields: string[], isMask?: boolean, deleteKeysInsteadOfReturningAnewObject?: boolean): ObjectGeneric;
 /** READ ONLY, output a parsed version of process.env
  * use it like ENV().myVar
  */
@@ -128,23 +135,23 @@ declare function registerConfig(customConfig: any): void;
  * @param {Object} obj object to test against
  * @param {string} addr `a.b.c.0.1` will test if myObject has props a that has prop b. Work wit arrays as well (like `arr.0`)
  */
-declare function has(obj: object, addr: string): boolean;
+declare function has(obj: ObjectGeneric, addr: string): boolean;
 /** Find address in an object "a.b.c" IN { a : { b : {c : 'blah' }}} RETURNS 'blah'
  * @param {object} obj
  * @param {string} addr accept syntax like "obj.subItem.[0].sub2" OR "obj.subItem.0.sub2" OR "obj.subItem[0].sub2"
  * @returns {any} the last item of the chain OR undefined if not found
  */
-declare function findByAddress(obj: object, addr: string): any;
+declare function findByAddress(obj: ObjectGeneric, addr: string): any;
 /** Enforce writing subItems. Eg: user.name.blah will ensure all are set until the writing of the last item
  * NOTE: doesn't work with arrays
  */
-declare function objForceWrite(obj: object, addr: string, item: any): void;
+declare function objForceWrite(obj: ObjectGeneric, addr: string, item: any): void;
 /** Enforce writing subItems, only if obj.addr is empty.
  * Eg: user.name.blah will ensure all are set until the writing of the last item
  * if user.name.blah has a value it will not change it.
  * NOTE: doesn't work with arrays
  */
-declare function objForceWriteIfNotSet(obj: object, addr: string, item: any): void;
+declare function objForceWriteIfNotSet(obj: ObjectGeneric, addr: string, item: any): void;
 /** Merge mixins into class. Use it in the constructor like: mergeMixins(this, {myMixin: true}) */
 declare function mergeMixins(that: any, ...mixins: any[]): void;
 /** If a string is provided, return it as array else return the value */
@@ -152,12 +159,11 @@ declare function strAsArray(arrOrStr: any): any;
 /** If not an array provided, return the array with the value
  * /!\ NOTE /!\ In case the value is null or undefined, it will return that value
  */
-declare function asArray<T extends undefined | null>(item: T): T;
-declare function asArray<T extends string | number | boolean | any[] | object>(item: T): T[];
+declare function asArray<T extends any[] | any>(item: T): T extends undefined ? undefined : T extends any[] ? T : T[];
 /** Array comparison
  * @return {object} { inCommon, notInB, notInA }
  */
-declare function compareArrays(arrayA?: any[], arrayB?: any[], compare?: (a: any, b: any) => boolean): {
+declare function compareArrays(arrayA: any[], arrayB: any[], compare?: (a: any, b: any) => boolean): {
     inCommon: any[];
     notInB: any[];
     notInA: any[];
@@ -447,12 +453,12 @@ declare function isValid(...paramsToValidate: any[]): boolean;
 declare function isType(value: any, type: BaseTypes): boolean;
 declare function validatorReturnErrArray(...paramsToValidate: ValidatorObject[]): [string?, number?, object?];
 declare function isEmpty(objOrArr: object | any[] | string | null | undefined): boolean;
-declare function getDateAsInt12(dateAllFormat?: Date | string | number, errIfNotValid?: any): number;
+declare function getDateAsInt12(dateAllFormat?: Date | string | number, errIfNotValid?: any): string;
 declare function humanReadableTimestamp(dateAllFormat: any): number;
 /** format for 6/8/2018 => 20180806
  * @param dateAllFormat multiple format allowed 2012, 20120101, 201201011200, new Date(), "2019-12-08T16:19:10.341Z" and all string that new Date() can parse
  */
-declare function getDateAsInt(dateAllFormat?: Date | string | number, errIfNotValid$?: boolean, withHoursAndMinutes$?: boolean): number;
+declare function getDateAsInt(dateAllFormat?: Date | string | number, errIfNotValid$?: boolean, withHoursAndMinutes$?: boolean): string;
 declare function getMonthAsInt(dateAllFormat?: Date | string | number): number;
 /**
  * @param dateAllFormat multiple format allowed 2012, 20120101, 201201011200, new Date(), "2019-12-08T16:19:10.341Z" and all string that new Date() can parse
@@ -482,7 +488,7 @@ declare function getTimeAsInt(timeOrDateInt?: any): number | "dateInvalid";
  * @param {timeInt|dateInt12} Eg: 2222 OR 201201012222. Default, actual dateInt12
  * @param {String} separator default: ":"
  */
-declare function getIntAsTime(intOrDateTimeInt?: number, separator?: string): string;
+declare function getIntAsTime(intOrDateTimeInt?: string, separator?: string): string;
 declare function isTimeStringValid(timeStr: any, outputAnError$?: boolean): boolean;
 declare function getDuration(startDate: any, endDate: any, inMinutes?: boolean): number | number[];
 /** compare two object with DATE INT, if they overlap return true
@@ -494,50 +500,28 @@ declare function getDuration(startDate: any, endDate: any, inMinutes?: boolean):
  * @param {Boolean} strict$ if true,
  */
 declare function doDateOverlap(event1: any, event2: any, fieldNameForStartDate$?: string, fieldNameForEndDate$?: string, allowNull$?: boolean, strict$?: boolean): boolean;
-/** Get all dates at specified days between two dates
- * @param daysArray [0,1,2,3,4,5,6]
- * @param {*} startDate all format
- * @param {*} endDate all format
- * @param {'int'|'object'} outputFormat default: int
- */
-declare function getDatesForDaysArrayBetweenTwoDates(daysArray: any, startDate: any, endDate: any, outputFormat?: string): (number | Date)[];
-declare function getEndTimeFromDurationAndStartTime(startTime: any, duration: any): {
-    days: number;
-    time: string;
-};
-declare function getDate12FromDateAndTime(dateAllFormat: Date | string | number, timeAllFormat: any): any;
-declare function eachDayOfInterval(startDateAllFormat: any, endDateAllFormat: any, outputFormat?: string): (number | Date)[];
-declare function eachMonthOfInterval(startDateAllFormat: any, endDateAllFormat: any): any[];
-declare function isSunday(dateAllFormat?: Date | string | number): boolean;
-declare function isMonday(dateAllFormat?: Date | string | number): boolean;
-declare function isTuesday(dateAllFormat?: Date | string | number): boolean;
-declare function isWednesday(dateAllFormat?: Date | string | number): boolean;
-declare function isThursday(dateAllFormat?: Date | string | number): boolean;
-declare function isFriday(dateAllFormat?: Date | string | number): boolean;
-declare function isSaturday(dateAllFormat?: Date | string | number): boolean;
-declare function isWeekend(dateAllFormat?: Date | string | number): boolean;
 declare function nextWeekDay(fromDate: any, weekDayInt?: 0 | 1 | 2 | 3 | 4 | 5 | 6, outputFormat?: 'dateInt8' | 'dateInt12' | 'humanReadableTimestamp', sameDayAllowed?: boolean): number;
 declare function nextWeekDay(fromDate: any, weekDayInt?: 0 | 1 | 2 | 3 | 4 | 5 | 6, outputFormat?: 'date', sameDayAllowed?: boolean): Date;
 /**
  * @param {String} outputFormat dateInt, dateInt8, dateInt12, date, humanReadableTimestamp, int (dateInt8)
  */
-declare function addDays(dateAllFormat?: Date | string | number, numberOfDays?: number, outputFormat?: string): number | Date;
+declare function addDays(dateAllFormat?: Date | string | number, numberOfDays?: number, outputFormat?: string): string | number | Date;
 /**
  * @param {String} outputFormat dateInt, dateInt8, dateInt12, date, humanReadableTimestamp, int (dateInt8)
  */
-declare function addMinutes(dateAllFormat?: Date | string | number, numberOfMinutes?: number, outputFormat?: string): number | Date;
+declare function addMinutes(dateAllFormat?: Date | string | number, numberOfMinutes?: number, outputFormat?: string): string | number | Date;
 /**
  * @param {String} outputFormat dateInt, dateInt8, dateInt12, date, humanReadableTimestamp, int (dateInt8)
  */
-declare function addHours(dateAllFormat?: Date | string | number, numberOfHours?: number, outputFormat?: string): number | Date;
+declare function addHours(dateAllFormat?: Date | string | number, numberOfHours?: number, outputFormat?: string): string | number | Date;
 /**
  * @param {String} outputFormat dateInt, dateInt8, dateInt12, date, humanReadableTimestamp, int (dateInt8)
  */
-declare function addMonths(dateAllFormat?: Date | string | number, numberOfMonths?: number, outputFormat?: string): number | Date;
+declare function addMonths(dateAllFormat?: Date | string | number, numberOfMonths?: number, outputFormat?: string): string | number | Date;
 /**
  * @param {String} outputFormat dateInt, dateInt8, dateInt12, date, humanReadableTimestamp, int (dateInt8)
  */
-declare function addYears(dateAllFormat?: Date | string | number, numberOfYears?: number, outputFormat?: string): number | Date;
+declare function addYears(dateAllFormat?: Date | string | number, numberOfYears?: number, outputFormat?: string): string | number | Date;
 declare function getDayOfMonth(dateAllFormat?: Date | string | number): any;
 declare function getYear(dateAllFormat?: Date | string | number): any;
 declare function getHours(dateAllFormat?: Date | string | number): any;
@@ -545,40 +529,17 @@ declare function getMinutes(dateAllFormat?: Date | string | number): any;
 /**
  * @param {String} outputFormat dateInt, dateInt8, dateInt12, date, humanReadableTimestamp, int (dateInt8)
  */
-declare function lastDayOfMonth(dateAllFormat?: Date | string | number, outputFormat?: string): number | Date;
+declare function lastDayOfMonth(dateAllFormat?: Date | string | number, outputFormat?: string): string | number | Date;
 /**
  * @param {String} outputFormat dateInt, dateInt8, dateInt12, date, humanReadableTimestamp, int (dateInt8)
  */
-declare function firstDayOfMonth(dateAllFormat?: Date | string | number, outputFormat?: string): number | Date;
+declare function firstDayOfMonth(dateAllFormat?: Date | string | number, outputFormat?: string): string | number | Date;
 declare function differenceInMilliseconds(startDateAllFormat: any, endDateAllFormat: any): number;
 declare function differenceInSeconds(startDateAllFormat: any, endDateAllFormat: any): number;
 declare function differenceInMinutes(startDateAllFormat: any, endDateAllFormat: any): number;
 declare function differenceInHours(startDateAllFormat: any, endDateAllFormat: any): number;
 declare function differenceInDays(startDateAllFormat: any, endDateAllFormat: any): number;
 declare function differenceInWeeks(startDateAllFormat: any, endDateAllFormat: any): number;
-declare function differenceInMonths(startDateAllFormat: any, endDateAllFormat: any): number;
-/** Will check if that date exists, and if not, this will
- * Usefull for monthly subscription or reccuring month dates
- * @param {any} dateAllFormat default: new Date()
- * @returns {Date} Date object
- */
-declare function getClosestExistingDateOfMonth(dateAllFormat?: Date | string | number): any;
-/** Compute the best possible date for next month same day
- * Usefull for monthly subscription or reccuring month dates
- * @param {any} dateAllFormat default: new Date()
- * @param {Boolean} onlyFuture if true return the future date relative to any date in the past, else, it return the next month date possible relative to the dateAllFormat
- * @returns {Date} Date object
- */
-declare function getNextMonthlyDate(dateAllFormat?: Date | string | number, onlyFuture?: boolean): any;
-declare function getHolidayReferenceYear(dateAllFormat: Date | string | number): number;
-/**
- * @param {String} outputFormat dateInt, dateInt8, dateInt12, date, humanReadableTimestamp, int (dateInt8)
- */
-declare function getFirstDayOfHolidayReferenceYear(dateAllFormat: Date | string | number, outputFormat?: string): number | Date;
-/**
- * @param {String} outputFormat dateInt, dateInt8, dateInt12, date, humanReadableTimestamp, int (dateInt8)
- */
-declare function getLastDayOfHolidayReferenceYear(dateAllFormat: Date | string | number, outputFormat?: string): number | Date;
 /**
 // console colored output
 // * console.log(C.green(C.dim('Hey bro !')))
@@ -715,6 +676,7 @@ declare const _: {
     sortUrlsByDeepnessInArrayOrObject: typeof sortUrlsByDeepnessInArrayOrObject;
     urlPathJoin: typeof urlPathJoin;
     miniTemplater: typeof miniTemplater;
+    generateObjectId: typeof generateObjectId;
     isBetween: typeof isBetween;
     simpleObjectMaskOrSelect: typeof simpleObjectMaskOrSelect;
     ENV: typeof ENV;
@@ -824,18 +786,7 @@ declare const _: {
     isTimeStringValid: typeof isTimeStringValid;
     getDuration: typeof getDuration;
     doDateOverlap: typeof doDateOverlap;
-    getDatesForDaysArrayBetweenTwoDates: typeof getDatesForDaysArrayBetweenTwoDates;
-    getEndTimeFromDurationAndStartTime: typeof getEndTimeFromDurationAndStartTime;
-    getDate12FromDateAndTime: typeof getDate12FromDateAndTime;
     getMonthAsInt: typeof getMonthAsInt;
-    isSunday: typeof isSunday;
-    isMonday: typeof isMonday;
-    isTuesday: typeof isTuesday;
-    isWednesday: typeof isWednesday;
-    isThursday: typeof isThursday;
-    isFriday: typeof isFriday;
-    isSaturday: typeof isSaturday;
-    isWeekend: typeof isWeekend;
     nextWeekDay: typeof nextWeekDay;
     addMinutes: typeof addMinutes;
     addHours: typeof addHours;
@@ -848,20 +799,12 @@ declare const _: {
     getMinutes: typeof getMinutes;
     firstDayOfMonth: typeof firstDayOfMonth;
     lastDayOfMonth: typeof lastDayOfMonth;
-    eachDayOfInterval: typeof eachDayOfInterval;
-    eachMonthOfInterval: typeof eachMonthOfInterval;
     differenceInMilliseconds: typeof differenceInMilliseconds;
     differenceInSeconds: typeof differenceInSeconds;
     differenceInMinutes: typeof differenceInMinutes;
     differenceInHours: typeof differenceInHours;
     differenceInDays: typeof differenceInDays;
     differenceInWeeks: typeof differenceInWeeks;
-    differenceInMonths: typeof differenceInMonths;
-    getClosestExistingDateOfMonth: typeof getClosestExistingDateOfMonth;
-    getNextMonthlyDate: typeof getNextMonthlyDate;
-    getHolidayReferenceYear: typeof getHolidayReferenceYear;
-    getFirstDayOfHolidayReferenceYear: typeof getFirstDayOfHolidayReferenceYear;
-    getLastDayOfHolidayReferenceYear: typeof getLastDayOfHolidayReferenceYear;
     getDateAsArrayFormatted: typeof dateArray;
     getDateAsArray: typeof dateStringToArray;
     convertDateAsInt: typeof getDateAsInt;
@@ -927,6 +870,6 @@ declare const _: {
     tryCatch: typeof tryCatch;
 };
 export default _;
-export { round, random, cln, pad, int, minMax, generateToken, moyenne, average, sumArray, sortUrlsByDeepnessInArrayOrObject, urlPathJoin, miniTemplater, isBetween, simpleObjectMaskOrSelect, ENV, parseBool, registerConfig, configFn, findByAddress, objForceWrite, objForceWriteIfNotSet, strAsArray, asArray, compareArrays, getArrayInCommon, getArrayDiff, getNotInArrayA, noDuplicateFilter, arrayCount, arrayToObjectSorted, pushIfNotExist, isNotEmptyArray, randomItemInArray, arrayUniqueValue, deepClone, cloneObject, JSONstringyParse, has, isObject, mergeDeep, flattenObject, unflattenObject, recursiveGenericFunction, recursiveGenericFunctionSync, findByAddressAll, objFilterUndefined, readOnly, reassignForbidden, readOnlyForAll, mergeDeepOverrideArrays, mergeDeepConfigurable, objFilterUndefinedRecursive, removeUndefinedKeys, // alias
+export { round, random, cln, pad, int, minMax, generateToken, moyenne, average, sumArray, sortUrlsByDeepnessInArrayOrObject, urlPathJoin, miniTemplater, generateObjectId, isBetween, simpleObjectMaskOrSelect, ENV, parseBool, registerConfig, configFn, findByAddress, objForceWrite, objForceWriteIfNotSet, strAsArray, asArray, compareArrays, getArrayInCommon, getArrayDiff, getNotInArrayA, noDuplicateFilter, arrayCount, arrayToObjectSorted, pushIfNotExist, isNotEmptyArray, randomItemInArray, arrayUniqueValue, deepClone, cloneObject, JSONstringyParse, has, isObject, mergeDeep, flattenObject, unflattenObject, recursiveGenericFunction, recursiveGenericFunctionSync, findByAddressAll, objFilterUndefined, readOnly, reassignForbidden, readOnlyForAll, mergeDeepOverrideArrays, mergeDeepConfigurable, objFilterUndefinedRecursive, removeUndefinedKeys, // alias
 sortObjKeyAccordingToValue, ensureObjectProp, filterKeys, deleteByAddress, ensureIsArrayAndPush, removeCircularJSONstringify, isset, cleanStackTrace, shuffleArray, shuffleArray as randomizeArray, round2, camelCase, snakeCase, kebabCase, kebabCase as dashCase, snakeCase as underscoreCase, titleCase, pascalCase, lowerCase, upperCase, capitalize1st, camelCaseToWords, firstMatch, allMatches, getValuesBetweenSeparator, getValuesBetweenStrings, escapeRegexp, validator, validator as required, // alias for readability
-validatorReturnErrArray, assert, restTestMini, isValid, isType, isDateObject, issetOr, isEmptyOrNotSet, errIfNotSet, err500IfNotSet, errIfEmptyOrNotSet, err500IfEmptyOrNotSet, errXXXIfNotSet, isEmpty, checkAllObjectValuesAreEmpty, checkCtxIntegrity, issetOr as orIsset, getDateAsInt12, humanReadableTimestamp, getDateAsInt, getDateAsObject, isDateIntOrStringValid, isDateIsoOrObjectValid, dateStringToArray, dateArray, dateArrayInt, dateFormatted as dateSlash, dateFormatted, dateOffset, getTimeAsInt, getIntAsTime, isTimeStringValid, getDuration, doDateOverlap, getDatesForDaysArrayBetweenTwoDates, getEndTimeFromDurationAndStartTime, getDate12FromDateAndTime, getMonthAsInt, isSunday, isMonday, isTuesday, isWednesday, isThursday, isFriday, isSaturday, isWeekend, nextWeekDay, addMinutes, addHours, addDays, addMonths, addYears, getYear, getDayOfMonth, getHours, getMinutes, firstDayOfMonth, lastDayOfMonth, eachDayOfInterval, eachMonthOfInterval, differenceInMilliseconds, differenceInSeconds, differenceInMinutes, differenceInHours, differenceInDays, differenceInWeeks, differenceInMonths, getClosestExistingDateOfMonth, getNextMonthlyDate, getHolidayReferenceYear, getFirstDayOfHolidayReferenceYear, getLastDayOfHolidayReferenceYear, getDateAsInt as convertDateAsInt, getDateAsObject as convertDateAsObject, C, cliProgressBar, cliLoadingSpinner, convertAccentedCharacters, executeInDelayedLoop, timeout, runAsync, waitUntilTrue, transaction, waitForTransaction, getId, mergeMixins, mongoFilterMerger, mongoPush, tryCatch, };
+validatorReturnErrArray, assert, restTestMini, isValid, isType, isDateObject, issetOr, isEmptyOrNotSet, errIfNotSet, err500IfNotSet, errIfEmptyOrNotSet, err500IfEmptyOrNotSet, errXXXIfNotSet, isEmpty, checkAllObjectValuesAreEmpty, checkCtxIntegrity, issetOr as orIsset, getDateAsInt12, humanReadableTimestamp, getDateAsInt, getDateAsObject, isDateIntOrStringValid, isDateIsoOrObjectValid, dateStringToArray, dateArray, dateArrayInt, dateFormatted as dateSlash, dateFormatted, dateOffset, getTimeAsInt, getIntAsTime, isTimeStringValid, getDuration, doDateOverlap, getMonthAsInt, nextWeekDay, addMinutes, addHours, addDays, addMonths, addYears, getYear, getDayOfMonth, getHours, getMinutes, firstDayOfMonth, lastDayOfMonth, differenceInMilliseconds, differenceInSeconds, differenceInMinutes, differenceInHours, differenceInDays, differenceInWeeks, getDateAsInt as convertDateAsInt, getDateAsObject as convertDateAsObject, C, cliProgressBar, cliLoadingSpinner, convertAccentedCharacters, executeInDelayedLoop, timeout, runAsync, waitUntilTrue, transaction, waitForTransaction, getId, mergeMixins, mongoFilterMerger, mongoPush, tryCatch, };

package/utils.js

@@ -61,12 +61,14 @@ function generateToken(length = 20, unique = true, mode = 'alphanumeric') {
         while (token.length < length)
             token += Math.random().toString(charConvNumeric).substr(2, 1); // char alphaNumeric aléatoire
     } while (generatedTokens.includes(token));
-    if (lastTs < tokenTs) {
+    if (lastTs < tokenTs)
         generatedTokens = []; // reset generated token on new timestamp because cannot collide
-    }
     generatedTokens.push(token);
     return token;
 }
+function generateObjectId() {
+    return generateToken(24, true, 'hexadecimal');
+}
 /** Useful to join differents bits of url with normalizing slashes
  * * urlPathJoin('https://', 'www.kikou.lol/', '/user', '//2//') => https://www.kikou.lol/user/2/
  * * urlPathJoin('http:/', 'kikou.lol') => https://www.kikou.lol
@@ -103,15 +105,14 @@ function sortUrlsByDeepnessInArrayOrObject(urlObjOrArr, propInObjectOrIndexInArr
             bUrl.length - aUrl.length; // help separating / vs /blah
     });
 }
-/**
- * Replace variables in a string like: `Hello {{userName}}!`
+/** Replace variables in a string like: `Hello {{userName}}!`
  * @param {String} content
  * @param {Object} varz object with key => value === toReplace => replacer
  * @param {Object} options
  * * valueWhenNotSet => replacer for undefined values. Default: ''
  * * regexp          => must be 'g' and first capturing group matching the value to replace. Default: /{{\s*([^}]*)\s*}}/g
  */
-function miniTemplater(content, varz, options) {
+function miniTemplater(content, varz, options = {}) {
     options = {
         valueWhenNotSet: '',
         regexp: /{{\s*([^}]*)\s*}}/g,
@@ -344,13 +345,16 @@ function mergeMixins(that, ...mixins) {
 function strAsArray(arrOrStr) {
     return typeof arrOrStr === 'string' ? [arrOrStr] : arrOrStr;
 }
+/** If not an array provided, return the array with the value
+ * /!\ NOTE /!\ In case the value is null or undefined, it will return that value
+ */
 function asArray(item) {
-    return typeof item === 'undefined' ? item : Array.isArray(item) ? item : [item];
+    return (typeof item === 'undefined' ? item : Array.isArray(item) ? item : [item]);
 }
 /** Array comparison
  * @return {object} { inCommon, notInB, notInA }
  */
-function compareArrays(arrayA = [], arrayB = [], compare = (a, b) => a === b) {
+function compareArrays(arrayA, arrayB, compare = (a, b) => a === b) {
     return {
         inCommon: getArrayInCommon(arrayA, arrayB, compare),
         notInB: getNotInArrayA(arrayB, arrayA, compare),
@@ -1003,9 +1007,6 @@ function validator(...paramsToValidate) {
 }
 const restTestMini = {
     reset() {
-        restTestMini.nbSuccess = 0;
-        restTestMini.nbError = 0;
-        restTestMini.lastErrors = [];
     },
     printStats() {
         // TODO print last errz
@@ -1220,7 +1221,12 @@ function humanReadableTimestamp(dateAllFormat) {
  */
 function getDateAsInt(dateAllFormat = new Date(), errIfNotValid$ = false, withHoursAndMinutes$ = false) {
     let dateInt;
-    if (isDateIntOrStringValid(dateAllFormat)) {
+    if (typeof dateAllFormat === 'string' && dateAllFormat.includes('/')) {
+        // 01/01/2020 format
+        const [d, m, y] = dateAllFormat.split('/');
+        return y + m.toString().padStart(2, '0') + d.toString().padStart(2, '0');
+    }
+    else if (isDateIntOrStringValid(dateAllFormat)) {
         // we can pass an int or string format (20180106)
         dateInt = (dateAllFormat + '00000000').substr(0, 12); // add default 000000 for "month days minutes:sec" if not set
     }
@@ -1406,92 +1412,6 @@ function doDateOverlap(event1, event2, fieldNameForStartDate$ = 'startDate', fie
         return (!event2[fieldNameForEndDate$] || event1[fieldNameForStartDate$] < event2[fieldNameForEndDate$]) && (!event1[fieldNameForEndDate$] || event1[fieldNameForEndDate$] > event2[fieldNameForStartDate$]);
     return (!event2[fieldNameForEndDate$] || event1[fieldNameForStartDate$] <= event2[fieldNameForEndDate$]) && (!event1[fieldNameForEndDate$] || event1[fieldNameForEndDate$] >= event2[fieldNameForStartDate$]);
 }
-/** Get all dates at specified days between two dates
- * @param daysArray [0,1,2,3,4,5,6]
- * @param {*} startDate all format
- * @param {*} endDate all format
- * @param {'int'|'object'} outputFormat default: int
- */
-function getDatesForDaysArrayBetweenTwoDates(daysArray, startDate, endDate, outputFormat = 'int') {
-    const dateArr = [];
-    let actualDate = getDateAsObject(startDate);
-    endDate = getDateAsObject(endDate);
-    while (actualDate <= endDate) {
-        if (daysArray.includes(actualDate.getUTCDay()))
-            dateArr.push(getDateAsObject(actualDate)); // cloned
-        actualDate.setUTCDate(actualDate.getUTCDate() + 1);
-    }
-    return dateArr.map(d => getDateAs(d, outputFormat));
-}
-function getEndTimeFromDurationAndStartTime(startTime, duration) {
-    const timeArr = startTime.split(':').map(n => parseInt(n));
-    let endTime = (timeArr[0] * 60 + timeArr[1]) + duration;
-    return {
-        days: Math.floor(endTime / 1440),
-        time: pad(Math.floor((endTime % 1440) / 60)) + ':' + pad(endTime % 60)
-    };
-}
-function getDate12FromDateAndTime(dateAllFormat, timeAllFormat) {
-    if (typeof dateAllFormat !== 'number' || dateAllFormat > 99991231 || dateAllFormat < 0)
-        dateAllFormat = getDateAsInt(dateAllFormat);
-    if (typeof timeAllFormat !== 'number' || timeAllFormat > 2359 || timeAllFormat < 0)
-        timeAllFormat = getTimeAsInt(timeAllFormat);
-    return dateAllFormat * 10000 + timeAllFormat;
-}
-function eachDayOfInterval(startDateAllFormat, endDateAllFormat, outputFormat = 'int') {
-    const start = getDateAsObject(startDateAllFormat);
-    const end = getDateAsObject(endDateAllFormat);
-    let days = [];
-    let current = new Date();
-    current.setTime(start.getTime());
-    while (current <= end) {
-        days.push(new Date(current.getTime()));
-        current.setTime(current.getTime() + 1000 * 60 * 60 * 24);
-    }
-    return days.map(d => getDateAs(d, outputFormat));
-}
-function eachMonthOfInterval(startDateAllFormat, endDateAllFormat) {
-    const months = [];
-    const current = firstDayOfMonth(startDateAllFormat, 'Object');
-    const end = firstDayOfMonth(endDateAllFormat, 'Object');
-    while (current <= end) {
-        months.push(getMonthAsInt(current));
-        current.setUTCMonth(current.getUTCMonth() + 1);
-    }
-    return months;
-}
-function isSunday(dateAllFormat = getDateAsInt()) {
-    let date = getDateAsObject(dateAllFormat);
-    return date.getUTCDay() === 0;
-}
-function isMonday(dateAllFormat = getDateAsInt()) {
-    let date = getDateAsObject(dateAllFormat);
-    return date.getUTCDay() === 1;
-}
-function isTuesday(dateAllFormat = getDateAsInt()) {
-    let date = getDateAsObject(dateAllFormat);
-    return date.getUTCDay() === 2;
-}
-function isWednesday(dateAllFormat = getDateAsInt()) {
-    let date = getDateAsObject(dateAllFormat);
-    return date.getUTCDay() === 3;
-}
-function isThursday(dateAllFormat = getDateAsInt()) {
-    let date = getDateAsObject(dateAllFormat);
-    return date.getUTCDay() === 4;
-}
-function isFriday(dateAllFormat = getDateAsInt()) {
-    let date = getDateAsObject(dateAllFormat);
-    return date.getUTCDay() === 5;
-}
-function isSaturday(dateAllFormat = getDateAsInt()) {
-    let date = getDateAsObject(dateAllFormat);
-    return date.getUTCDay() === 6;
-}
-function isWeekend(dateAllFormat = getDateAsInt()) {
-    let date = getDateAsObject(dateAllFormat);
-    return date.getUTCDay() === 6 || date.getUTCDay() === 0;
-}
 function nextWeekDay(fromDate, weekDayInt, outputFormat = 'date', sameDayAllowed = false) {
     const date = getDateAsObject(fromDate);
     if (!isset(weekDayInt))
@@ -1603,103 +1523,6 @@ function differenceInDays(startDateAllFormat, endDateAllFormat) {
 function differenceInWeeks(startDateAllFormat, endDateAllFormat) {
     return differenceInDays(startDateAllFormat, endDateAllFormat) / 7;
 }
-function differenceInMonths(startDateAllFormat, endDateAllFormat) {
-    const startDate = getDateAsInt(startDateAllFormat);
-    const endDate = getDateAsInt(endDateAllFormat);
-    const monthesForStart = parseInt(getYear(startDate)) * 12 + parseInt(getMonthForHuman(startDate));
-    const monthesForEnd = parseInt(getYear(endDate)) * 12 + parseInt(getMonthForHuman(endDate));
-    if (monthesForStart === monthesForEnd) {
-        const firstDay = firstDayOfMonth(startDate);
-        const lastDay = lastDayOfMonth(endDate);
-        const differenceBetweenStartAndEnd = differenceInDays(startDate, endDate);
-        const numberOfDaysInMonth = differenceInDays(firstDay, lastDay);
-        return round(differenceBetweenStartAndEnd / numberOfDaysInMonth, 2);
-    }
-    const firstDayOfStartDateMonth = firstDayOfMonth(startDate);
-    const lastDayOfStartDateMonth = lastDayOfMonth(startDate);
-    const firstDayOfEndDateMonth = firstDayOfMonth(endDate);
-    const lastDayOfEndDateMonth = lastDayOfMonth(endDate);
-    const differenceBetweenStartDateAndEndOfStartMonth = differenceInDays(startDate, lastDayOfStartDateMonth);
-    const differenceBetweenStartOfEndMonthAndEndDate = differenceInDays(firstDayOfEndDateMonth, endDate);
-    const numberOfDaysInStartMonth = differenceInDays(firstDayOfStartDateMonth, lastDayOfStartDateMonth);
-    const numberOfDaysInEndMonth = differenceInDays(firstDayOfEndDateMonth, lastDayOfEndDateMonth);
-    return round(monthesForEnd - monthesForStart - 1 + differenceBetweenStartDateAndEndOfStartMonth / numberOfDaysInStartMonth + differenceBetweenStartOfEndMonthAndEndDate / numberOfDaysInEndMonth, 2);
-}
-/** Will check if that date exists, and if not, this will
- * Usefull for monthly subscription or reccuring month dates
- * @param {any} dateAllFormat default: new Date()
- * @returns {Date} Date object
- */
-function getClosestExistingDateOfMonth(dateAllFormat = getDateAsInt()) {
-    let [day, month, year] = dateArrayInt(dateAllFormat);
-    const zeroBasedMonth = minMax(month - 1, 0, 11);
-    if (!isBetween(month, 1, 12))
-        console.error('Wrong month provided for getClosestExistingDateOfMonth: ' + month + ' Shall be between 1-12. Converted to ' + zeroBasedMonth);
-    let dayNb = minMax(day, 1, 31);
-    let date;
-    let increment = dayNb < 1;
-    let tooMuchRecursionCount = 0;
-    do
-        date = new Date(year, zeroBasedMonth, (increment ? dayNb++ : dayNb--), 12);
-    while (date.getUTCMonth() !== zeroBasedMonth && tooMuchRecursionCount < 99);
-    if (tooMuchRecursionCount)
-        throw new dataValidationUtilErrorHandler(`tooMuchRecursionCount`, 500, { origin: 'getClosestExistingDateOfMonth', day, month, year });
-    return date;
-}
-/** Compute the best possible date for next month same day
- * Usefull for monthly subscription or reccuring month dates
- * @param {any} dateAllFormat default: new Date()
- * @param {Boolean} onlyFuture if true return the future date relative to any date in the past, else, it return the next month date possible relative to the dateAllFormat
- * @returns {Date} Date object
- */
-function getNextMonthlyDate(dateAllFormat = getDateAsInt(), onlyFuture = false) {
-    let [day, month, year] = dateArrayInt(dateAllFormat);
-    day = minMax(day, 1, 31);
-    month = minMax(month, 1, 12);
-    err422IfNotSet({ year, month, day });
-    const isDatePast = getDateAsInt(dateAllFormat) <= getDateAsInt();
-    if (onlyFuture && isDatePast) {
-        let [, todayMonth, todayYear] = dateArrayInt();
-        month = todayMonth;
-        year = todayYear;
-    }
-    let nextMonth;
-    if (month === 12) {
-        nextMonth = 1;
-        year++;
-    }
-    else
-        nextMonth = month + 1;
-    return getClosestExistingDateOfMonth(new Date(year, nextMonth - 1, day));
-}
-function getHolidayReferenceYear(dateAllFormat) {
-    let date = getDateAsObject(dateAllFormat);
-    if (date.getUTCMonth() > 4)
-        return date.getUTCFullYear();
-    return date.getUTCFullYear() - 1;
-}
-/**
- * @param {String} outputFormat dateInt, dateInt8, dateInt12, date, humanReadableTimestamp, int (dateInt8)
- */
-function getFirstDayOfHolidayReferenceYear(dateAllFormat, outputFormat = 'int') {
-    const date = getDateAsObject(dateAllFormat);
-    let year = date.getUTCFullYear();
-    if (date.getUTCMonth() < 4)
-        year = date.getUTCFullYear() - 1;
-    const firstDayAsInt = year + '0601';
-    return getDateAs(firstDayAsInt, outputFormat);
-}
-/**
- * @param {String} outputFormat dateInt, dateInt8, dateInt12, date, humanReadableTimestamp, int (dateInt8)
- */
-function getLastDayOfHolidayReferenceYear(dateAllFormat, outputFormat = 'int') {
-    let date = getDateAsObject(dateAllFormat);
-    let year = date.getUTCFullYear() + 1;
-    if (date.getUTCMonth() < 4)
-        year = date.getUTCFullYear();
-    const firstDayAsInt = year + '0531';
-    return getDateAs(firstDayAsInt, outputFormat);
-}
 /**
  * @param {String} outputDateFormat dateInt, dateInt8, dateInt12, date, humanReadableTimestamp, int (dateInt8)
  */
@@ -2243,6 +2066,7 @@ const _ = {
     sortUrlsByDeepnessInArrayOrObject,
     urlPathJoin,
     miniTemplater,
+    generateObjectId,
     isBetween,
     simpleObjectMaskOrSelect,
     ENV,
@@ -2349,18 +2173,7 @@ const _ = {
     isTimeStringValid,
     getDuration,
     doDateOverlap,
-    getDatesForDaysArrayBetweenTwoDates,
-    getEndTimeFromDurationAndStartTime,
-    getDate12FromDateAndTime,
     getMonthAsInt,
-    isSunday,
-    isMonday,
-    isTuesday,
-    isWednesday,
-    isThursday,
-    isFriday,
-    isSaturday,
-    isWeekend,
     nextWeekDay,
     addMinutes,
     addHours,
@@ -2373,20 +2186,12 @@ const _ = {
     getMinutes,
     firstDayOfMonth,
     lastDayOfMonth,
-    eachDayOfInterval,
-    eachMonthOfInterval,
     differenceInMilliseconds,
     differenceInSeconds,
     differenceInMinutes,
     differenceInHours,
     differenceInDays,
     differenceInWeeks,
-    differenceInMonths,
-    getClosestExistingDateOfMonth,
-    getNextMonthlyDate,
-    getHolidayReferenceYear,
-    getFirstDayOfHolidayReferenceYear,
-    getLastDayOfHolidayReferenceYear,
     // ALIASES
     getDateAsArrayFormatted: dateArray,
     getDateAsArray: dateStringToArray,
@@ -2417,7 +2222,7 @@ const _ = {
 export default _;
 export { round, random, cln, pad, 
 // ALIASES
-int, minMax, generateToken, moyenne, average, sumArray, sortUrlsByDeepnessInArrayOrObject, urlPathJoin, miniTemplater, isBetween, simpleObjectMaskOrSelect, ENV, parseBool, registerConfig, configFn, findByAddress, objForceWrite, objForceWriteIfNotSet, strAsArray, asArray, compareArrays, getArrayInCommon, getArrayDiff, getNotInArrayA, noDuplicateFilter, arrayCount, arrayToObjectSorted, pushIfNotExist, isNotEmptyArray, randomItemInArray, 
+int, minMax, generateToken, moyenne, average, sumArray, sortUrlsByDeepnessInArrayOrObject, urlPathJoin, miniTemplater, generateObjectId, isBetween, simpleObjectMaskOrSelect, ENV, parseBool, registerConfig, configFn, findByAddress, objForceWrite, objForceWriteIfNotSet, strAsArray, asArray, compareArrays, getArrayInCommon, getArrayDiff, getNotInArrayA, noDuplicateFilter, arrayCount, arrayToObjectSorted, pushIfNotExist, isNotEmptyArray, randomItemInArray, 
 //allias
 arrayUniqueValue, deepClone, cloneObject, JSONstringyParse, has, isObject, mergeDeep, flattenObject, unflattenObject, recursiveGenericFunction, recursiveGenericFunctionSync, findByAddressAll, objFilterUndefined, readOnly, reassignForbidden, readOnlyForAll, mergeDeepOverrideArrays, mergeDeepConfigurable, objFilterUndefinedRecursive, removeUndefinedKeys, // alias
 sortObjKeyAccordingToValue, ensureObjectProp, filterKeys, deleteByAddress, ensureIsArrayAndPush, removeCircularJSONstringify, isset, cleanStackTrace, shuffleArray, shuffleArray as randomizeArray, round2, camelCase, snakeCase, kebabCase, kebabCase as dashCase, snakeCase as underscoreCase, titleCase, pascalCase, lowerCase, upperCase, capitalize1st, camelCaseToWords, firstMatch, allMatches, getValuesBetweenSeparator, getValuesBetweenStrings, escapeRegexp, validator, validator as required, // alias for readability
@@ -2427,7 +2232,7 @@ issetOr as orIsset,
 // DATE
 getDateAsInt12, humanReadableTimestamp, getDateAsInt, getDateAsObject, isDateIntOrStringValid, isDateIsoOrObjectValid, dateStringToArray, dateArray, dateArrayInt, dateFormatted as dateSlash, dateFormatted, dateOffset, getTimeAsInt, getIntAsTime, isTimeStringValid, 
 // isDateObject <= see validator.js
-getDuration, doDateOverlap, getDatesForDaysArrayBetweenTwoDates, getEndTimeFromDurationAndStartTime, getDate12FromDateAndTime, getMonthAsInt, isSunday, isMonday, isTuesday, isWednesday, isThursday, isFriday, isSaturday, isWeekend, nextWeekDay, addMinutes, addHours, addDays, addMonths, addYears, getYear, getDayOfMonth, getHours, getMinutes, firstDayOfMonth, lastDayOfMonth, eachDayOfInterval, eachMonthOfInterval, differenceInMilliseconds, differenceInSeconds, differenceInMinutes, differenceInHours, differenceInDays, differenceInWeeks, differenceInMonths, getClosestExistingDateOfMonth, getNextMonthlyDate, getHolidayReferenceYear, getFirstDayOfHolidayReferenceYear, getLastDayOfHolidayReferenceYear, 
+getDuration, doDateOverlap, getMonthAsInt, nextWeekDay, addMinutes, addHours, addDays, addMonths, addYears, getYear, getDayOfMonth, getHours, getMinutes, firstDayOfMonth, lastDayOfMonth, differenceInMilliseconds, differenceInSeconds, differenceInMinutes, differenceInHours, differenceInDays, differenceInWeeks, 
 // ALIASES
 getDateAsInt as convertDateAsInt, getDateAsObject as convertDateAsObject, 
 // LOGGER