@evolis/evolis-library 1.1.0 → 1.2.1

package/README.md

@@ -3,6 +3,7 @@ A simple package that groups together frequently used functions in front-end and
 
 ## Note
 This package is marked as public and you can use it under the MIT license. But most of this stuff may be useless to you and you can probably find another good library that fits your needs.
+> Warning: Breaking changes since 1.2.0
 
 ## Install
 This is a  [Node.js](https://nodejs.org/en/)  module available through the  [npm registry](https://www.npmjs.com/). Installation is done using the  [`npm install`  command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
@@ -10,120 +11,137 @@ This is a  [Node.js](https://nodejs.org/en/)  module available through the  [npm
 `$ npm install --save @evolis/evolis-library`
 
 ## Usage
-This module is divided into three sub-modules: `check`, `convert` and `functions`.
-
-## check.js
-Import it into your script using:
-
-`import { check } from "@evolis/evolis-library";`
-
-Then use one of these functions:
-- **isDefined(value: any)**
-	- value: The value to test
-	- *return: true if the value is not undefined or null*
-- **atLeastOneOf(values: [any])**
-	- value: The values to test
-	- *return: true if at least one of the values is not undefined or null*
-- **isString(value: any)**
-	- value: The value to test
-	- *return: true if the value is a string*
-- **isEmptyString(value: any)**
-	- value: The value to test
-	- *return: true if the value is a string and if its empty*
-- **isBlankString(value: any)**
-	- value: The value to test
-	- *return: true if the value is a string and if its blank*
-- **strInRange(value: any|[any], [min]: Number, [max]: Number, [includeBounds]: Bool, [canBeNull]: Bool)**
-	- value: The value(s) to test
-	- [min]: Minimum string length (default: null)
-	- [max]: Maximum string length (default: null)
-	- [includeBounds]: Include the min and max bounds in the range (default: true)
-	- [canBeNull]: Authorize or not the string to be null or undefined (default: false)
-	- *return: true if the value is a string between min and max or if it's an undefined/null with canBeNull set at true*
-- **isNumber(value: any, [parse]: Bool)**
-	- value: The value to test
-	- [parse]: If set to true, the function will parse the value to find a integer (base 10) (default: true)
-	- *return: true if the value is a number*
-- **isFloat(value: any, [parse]: Bool)**
-	- value: The value to test
-	- [parse]: If set to true, the function will parse the value to find a float (default: true)
-	- *return: true if the value is a float*
-- **isArray(value: any)**
-	- value: The value to test
-	- *return: true if the value is an array*
-- **isDate(value: any)**
-	- value: The value to test
-	- *return: true if the value is a valid date*
-- **isEmail(value: any)**
-	- value: The value to test
-	- *return: true if the value is a string containing a valid email address*
-- **isPasswordSafe(value: any|[any])**
-	- value: The value(s) to test
-	- rules: Object with these properties:
-		 ```js
-		 {
-			 mustContain: {
-				 lowerCase: true|false (default: true),
-				 upperCase: true|false (default: true),
-				 digit: true|false (default: true),
-				 special: true|false (default: true),
-			 },
-			 minLength: Number (default: 8)
-		 }
-		 ```
-	- *return: true if the value is a safe password*
-
-
-## convert.js
+This module is divided into six sub-modules with "Evo" as prefix: `EvoArray`, `EvoDate`, `EvoMisc`, `EvoNumber`, `EvoObject` and `EvoString`.
 Import it into your script using:
 
-`import { convert } from "@evolis/evolis-library";`
-
-Then use one of these functions:
-- **arrayToSerialComma(array: Array)**
-	- array: The array to convert
-	- *return: A string formatted as a serial comma*
-- **dateToString(date: Date, [withTime]: Bool, [locale]: String)**
-	- date: The value to convert
-	- [withTime]: Include time in the result (default: true)
-	- [locale]: The locale used in the conversion. It may changed the returned string format (default: "fr-FR")
-	- *return: A date formatted like "dd/MM/yyyy [hh:mm:ss]"*
-- **dateToTimeString(date: Date, [locale]: String)**
-	- date: The date to convert
-	- [locale]: The locale used in the conversion. It may changed the returned string format (default: "fr-FR")
-	- *return: A date formatted like "hh:mm:ss"*
-- **dateToFieldString(date: Date)**
-	- date: The value to convert
-	- *return: A date formatted like "yyyy-MM-dd"*
-- **timeStrToDate(time: String, [format]: String)**
-  - time: The date to convert
-  - [format]: The format used for conversion (default: "hh:mm")
-  - *return: A date object filled with the time string provided*
-- **secondsToReadable(seconds: Number)**
-	- seconds: Seconds to convert
-	- *return: The converted seconds and epoch*
-- **toDate(d: any)**
-	- s: The thing to convert
-	- *return: A date object, null/undefined if the provided value is null/undefined and NaN if it's not convertible.*
-- **bytesToReadable(bytes: Number, [decimals]: Number)**
-	- bytes: Bytes to convert
-	- [decimals]: How many decimals (default: 2)
-	- *return: The converted bytes size to the closest unit*
-
-## functions.js
-Import it into your script using:
-
-`import { functions } from "@evolis/evolis-library";`
-
-Then use one of these functions:
-- **dayDifference(start: Date, end: Date)**
-	- start: Start date
-	- end: End date
-	- *return: How many days between these two dates*
-- **padLeft(value: any,  [pad]: String)**
-	- value: The value to pad
-	- [pad]: With what to pad (default: "00")
-	- *return: The padded string*
+`import { EvoArray, EvoMisc, ... } from "@evolis/evolis-library";`
+
+## EvoArray
+- ### Checkers
+  - **isArray(value: any)**
+    - value: The value to test
+    - *return: true if the value is an array*
+  - **isDeepEqual(array1: Array, array2: Array, [sortBy]: String)**
+    - array1: First array
+    - array2: Second array
+    - [sortBy]: Property name used to sort objects in the array. Two identical arrays in different order will not be equal (default: null)
+    - *return: true if the value is an array*
+- ### Converters
+  - **toSerialComma(array: Array)**
+    - array: The array to convert
+    - *return: A string formatted as a serial comma*
+- ### Functions
+  - **shuffle(array: Array)**
+    - array: The array to shuffle
+		- *return: The shuffled array*
+
+## EvoDate
+- ### Checkers
+  - **isDate(value: any)**
+    - value: The value to test
+    - *return: true if the value is a valid date*
+  - **isMySQLDate(value: any)**
+    - value: The value to test
+    - *return: true if the value is a string with the valid MySQL date format (yyyy-mm-dd)*
+- ### Converters
+  - **toDate(d: any)**
+    - s: The thing to convert
+    - *return: A date object, null/undefined if the provided value is null/undefined and NaN if it's not convertible.*
+  - **toString(date: Date, [withTime]: Bool, [locale]: String)**
+    - date: The value to convert
+    - [withTime]: Include time in the result (default: true)
+    - [locale]: The locale used in the conversion. It may changed the returned string format (default: "fr-FR")
+    - *return: A date formatted like "dd/MM/yyyy [hh:mm:ss]"*
+  - **toTimeString(date: Date, [locale]: String)**
+    - date: The date to convert
+    - [locale]: The locale used in the conversion. It may changed the returned string format (default: "fr-FR")
+    - *return: A date formatted like "hh:mm:ss"*
+  - **toFieldString(date: Date)**
+    - date: The value to convert
+    - *return: A date formatted like "yyyy-MM-dd"*
+  - **timeStrToDate(time: String, [format]: String)**
+    - time: The date to convert
+    - [format]: The format used for conversion (default: "hh:mm")
+    - *return: A date object filled with the time string provided*
+  - **secondsToReadable(seconds: Number)**
+    - seconds: Seconds to convert
+    - *return: The converted seconds and epoch*
+- ### Functions
+  - **dayDiff(start: Date, end: Date)**
+    - start: Start date
+    - end: End date
+    - *return: How many days between these two dates*
+
+## EvoMisc
+- ### Checkers
+  - **isDefined(value: any)**
+    - value: The value to test
+    - *return: true if the value is not undefined or null*
+  - **isEmail(value: any)**
+    - value: The value to test
+    - *return: true if the value is a string containing a valid email address*
+  - **isPasswordSafe(value: any|[any])**
+    - value: The value(s) to test
+    - rules: Object with these properties:
+       ```js
+       {
+        mustContain: {
+          lowerCase: true|false (default: true),
+          upperCase: true|false (default: true),
+          digit: true|false (default: true),
+          special: true|false (default: true),
+        },
+        minLength: Number (default: 8)
+       }
+       ```
+    - *return: true if the value is a safe password*
+- ### Converters
+  - **bytesToReadable(bytes: Number, [decimals]: Number)**
+    - bytes: Bytes to convert
+    - [decimals]: How many decimals (default: 2)
+    - *return: The converted bytes size to the closest unit*
+- ### Functions
+  - **padLeft(value: any,  [pad]: String)**
+	  - value: The value to pad
+	  - [pad]: With what to pad (default: "00")
+	  - *return: The padded string*
+
+## EvoNumber
+- ### Checkers
+  - **isNumber(value: any, [parse]: Bool)**
+	  - value: The value to test
+	  - [parse]: If set to true, the function will parse the value to find a integer (base 10) (default: false)
+	  - *return: true if the value is a number*
+  - **isFloat(value: any, [parse]: Bool)**
+    - value: The value to test
+    - [parse]: If set to true, the function will parse the value to find a float (default: false)
+    - *return: true if the value is a float*
+
+## EvoObject
+- ### Checkers
+	- **isDeepEqual(obj1: Object, obj2: Object)**
+		- obj1: First object
+		- obj2: Second object
+		- *return: true if the two objects are deeply equal*
+
+## EvoString
+- ### Checkers
+  - **isString(value: any)**
+	  - value: The value to test
+	  - *return: true if the value is a string*
+  - **isEmpty(value: any)**
+	  - value: The value to test
+	  - *return: true if the value is a string and if its empty*
+  - **isBlank(value: any)**
+	  - value: The value to test
+	  - *return: true if the value is a string and if its blank*
+  - **inRange(value: any|[any], [min]: Number, [max]: Number, [includeBounds]: Bool, [canBeNull]: Bool)**
+	  - value: The value(s) to test
+	  - [min]: Minimum string length (default: null)
+	  - [max]: Maximum string length (default: null)
+	  - [includeBounds]: Include the min and max bounds in the range (default: true)
+	  - [canBeNull]: Authorize or not the string to be null or undefined (default: false)
+	  - *return: true if the value is a string between min and max or if it's an undefined/null with canBeNull set at true*
 
 ## License
 

package/index.js

@@ -1,3 +1,6 @@
-export { default as check } from "./checkers.js";
-export { default as convert } from "./converters.js";
-export { default as functions } from "./functions.js";
+export { default as EvoArray } from "./EvoArray.js";
+export { default as EvoDate } from "./EvoDate.js";
+export { default as EvoMisc } from "./EvoMisc.js";
+export { default as EvoNumber } from "./EvoNumber.js";
+export { default as EvoObject } from "./EvoObject.js";
+export { default as EvoString } from "./EvoString.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@evolis/evolis-library",
-  "version": "1.1.0",
+  "version": "1.2.1",
   "description": "Dependencies used both in Evolis API and Evolis UI",
   "repository": {
     "type": "git",

package/checkers.js

@@ -1,242 +0,0 @@
-/**
- * @module checkers
- * @author EmpireDemocratiqueDuPoulpe
- * @version 1.0.4
- * @license MIT
- */
-
-/*****************************************************
- * Type checkers
- *****************************************************/
-
-/* ---- Global ---------------------------------- */
-/**
- * @function isDefined
- *
- * @param {*} value - The value to test
- * @returns {Boolean} Return true if the value is not undefined or null
- *
- * @example
- * isDefined("") // return true
- * isDefined(65) // return true
- * isDefined(false) // return true
- * isDefined(null) // return false
- * isDefined(undefined) // return false
- */
-function isDefined(value) {
-	return value !== undefined && value !== null;
-}
-
-/**
- * @function atLeastOneOf
- *
- * @param {Array<*>} values - The values to test
- * @returns {Boolean} Return true if at least one of the values is not undefined or null
- *
- * @example
- * atLeastOneOf([null, null, ""]) // return true
- * atLeastOneOf([]) // return false
- */
-function atLeastOneOf(values) {
-	return values.some(value => isDefined(value));
-}
-
-/* ---- String ---------------------------------- */
-/**
- * @function isString
- *
- * @param {any} value - The value to test
- * @returns {boolean} Return true if the value is a string
- */
-function isString(value) {
-	return Object.prototype.toString.call(value) === "[object String]";
-}
-
-/**
- * @function isEmptyString
- *
- * @param {any} value - The value to test
- * @returns {boolean} Return true if the value is a string and if its empty
- */
-function isEmptyString(value) {
-	return value === "";
-}
-
-/**
- * @function isBlankString
- *
- * @param {any} value - The value to test
- * @returns {boolean} Return true if the value is a string and if its blank
- *
- * @example
- * isBlankString(" "); // return true
- */
-function isBlankString(value) {
-	return isString(value) && value.trim().length === 0;
-}
-
-/**
- * @function strInRange
- *
- * @param {*|Array<*>} value - The value to test
- * @param {Number} min - The minimum length of the string (nullable)
- * @param {Number} max - The maximum length of the string (nullable)
- * @param {Boolean} [includeBounds=true] - Include the min and max bounds in the range
- * @param {Boolean} [canBeNull=false] - Authorize or not the string to be null or undefined
- * @returns {Boolean} Return true if the value is a string between min and max or if it's an undefined/null with canBeNull set at true.
- *
- * @example
- * strInRange("never gonna give you up", null, 100); // return true
- * strInRange("oof", 5); // return false
- */
-function strInRange(value, min, max, includeBounds = true, canBeNull = false) {
-	if (isArray(value)) {
-		return value.every(s => strInRange(s, min, max, includeBounds, canBeNull));
-	}
-
-	return isDefined(value)
-		? isString(value)
-			? includeBounds
-				? (isDefined(min) ? value.length >= min : true) && (isDefined(max) ? value.length <= max : true)
-				: (isDefined(min) ? value.length > min : true) && (isDefined(max) ? value.length < max : true)
-			: false
-		: canBeNull;
-}
-
-/* ---- Number ---------------------------------- */
-/**
- * @function isNumber
- *
- * @param {any} value - The value to test
- * @param {boolean} [parse=true] - If set to true, the function will parse the value to find a integer (base 10)
- * @returns {boolean} Return true if the value is a number
- */
-function isNumber(value, parse = true) {
-	const val = parse ? (isString(value) ? parseInt(value, 10) : value) : value;
-	return typeof val === "number" && !isNaN(val);
-}
-
-/**
- * @function isFloat
- *
- * @param {any} value - The value to test
- * @param {boolean} [parse=true] - If set to true, the function will parse the value to find a float
- * @returns {boolean} Return true if the value is a float
- */
-function isFloat(value, parse = true) {
-	const val = parse ? (isString(value) ? parseFloat(value) : value) : value;
-	return typeof val === "number" && !isNaN(val);
-}
-
-/* ---- Array ----------------------------------- */
-/**
- * @function isArray
- *
- * @param {any} value - The value to test
- * @returns {boolean} Return true if the value is an array
- */
-function isArray(value) {
-	return Array.isArray(value);
-}
-
-/* ---- Date ------------------------------------ */
-/**
- * @function isDate
- *
- * @param {any} value - The value to test
- * @returns {boolean} Return true if the value is a valid date
- */
-function isDate(value) {
-	return Object.prototype.toString.call(value) === "[object Date]" && !!value.getDate();
-}
-
-/**
- * @function isMySQLDate
- *
- * @param {any} value - The value to test
- * @returns {boolean} Return true if the value is a string with the valid MySQL date format (yyyy-mm-dd)
- */
-function isMySQLDate(value) {
-	return isString(value) && !isBlankString(value) && /^\d{4}-\d{1,2}-\d{1,2}$/.test(value);
-}
-
-/*****************************************************
- * Regex checkers
- *****************************************************/
-
-/* ---- E-mail ---------------------------------- */
-/**
- * @function isEmail
- *
- * @param {any} value - The value to test
- * @returns {boolean} Return true if the value is a string containing a valid email address
- */
-function isEmail(value) {
-	return /^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(value);
-}
-
-/* ---- Passwords ------------------------------- */
-/**
- * @typedef {Object} PasswordRules
- *
- * @property {object} mustContain - What type of character the password must contain
- * @property {boolean} [mustContain.lowerCase] - Must contain at least one lower cased character
- * @property {boolean} [mustContain.upperCase] - Must contain at least one upper cased character
- * @property {boolean} [mustContain.digit] - Must contain at least one number
- * @property {boolean} [mustContain.special] - Must contain at least one special character
- * @property {number} minLength - The minimal length
- */
-
-/**
- * @const
- * @type {PasswordRules}
- */
-export const passwordRules = {
-	mustContain: {
-		lowerCase: true,
-		upperCase: true,
-		digit: true,
-		special: true
-	},
-	minLength: 8
-};
-
-/**
- * @function isPasswordSafe
- *
- * @param {string|Array} password - One or multiple passwords
- * @param {PasswordRules} [rules] - An object that describe security rules to follow
- * @returns {boolean} Return true if the value is a safe password
- */
-function isPasswordSafe(password, rules) {
-	const usedRules = rules ? { ...passwordRules, ...rules } : passwordRules;
-
-	if (isArray(password)) {
-		return password.every(pwd => isPasswordSafe(pwd, usedRules));
-	}
-
-	let regex = "";
-
-	if (usedRules.mustContain.lowerCase) regex += "(?=.*[a-z])";
-	if (usedRules.mustContain.upperCase) regex += "(?=.*[A-Z])";
-	if (usedRules.mustContain.digit) regex += "(?=.*[0-9])";
-	if (usedRules.mustContain.special) regex += `(?=.*[\\"'!?@#$£%^&:;<>\\[\\]()\\\\\\-_+=*.])`;
-	regex += `.{${usedRules.minLength},}$`;
-
-	const strongPwd = new RegExp(regex);
-	return strongPwd.test(password);
-}
-
-/*****************************************************
- * Export
- *****************************************************/
-
-export default {
-	isDefined, atLeastOneOf,
-	isString, isEmptyString, isBlankString, strInRange,
-	isNumber, isFloat,
-	isArray,
-	isDate, isMySQLDate,
-	isEmail,
-	isPasswordSafe
-};