@evolis/evolis-library 1.0.7 → 1.1.1-b

package/README.md

@@ -14,6 +14,7 @@ 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:
@@ -75,6 +76,7 @@ Then use one of these functions:
 
 ## convert.js
 Import it into your script using:
+
 `import { convert } from "@evolis/evolis-library";`
 
 Then use one of these functions:
@@ -94,9 +96,12 @@ Then use one of these functions:
 	- 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*
+  - 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.*
@@ -104,9 +109,10 @@ Then use one of these functions:
 	- 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:

package/checkers.js

@@ -150,6 +150,16 @@ 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
  *****************************************************/
@@ -226,7 +236,7 @@ export default {
 	isString, isEmptyString, isBlankString, strInRange,
 	isNumber, isFloat,
 	isArray,
-	isDate,
+	isDate, isMySQLDate,
 	isEmail,
 	isPasswordSafe
 };

package/converters.js

@@ -107,6 +107,32 @@ function timeStrToDate(time, format = "hh:mm") {
 	return now;
 }
 
+/**
+ * @function secondsToReadable
+ *
+ * @param {number} seconds - Seconds to convert
+ * @returns {string} The converted seconds and epoch
+ *
+ * @example
+ * secondsToReadable(120) // return "2 minutes"
+ * secondsToReadable(3600) // return "1 heure"
+ */
+function secondsToReadable(seconds) {
+	const epochs = { "années": 31536000, "mois": 2592000, "jours": 86400, "heures": 3600, "minutes": 60, "secondes": 1 };
+	const singular = { "années": "ans", "mois": "mois", "jours": "jour", "heures": "heure", "minutes": "minute", "secondes": "seconde" };
+	const epoch = Object.entries(epochs).filter(([, value]) => seconds >= value).shift();
+	const readable = {
+		epoch: epoch[0],
+		interval: Math.trunc(seconds / epoch[1])
+	};
+
+	if (readable.interval === 1) {
+		readable.epoch = singular[readable.epoch];
+	}
+
+	return `${readable.interval} ${readable.epoch}`;
+}
+
 /**
  * @function toDate
  *
@@ -159,6 +185,6 @@ function bytesToReadable(bytes, decimals = 2) {
 
 export default {
 	arrayToSerialComma,
-	dateToString, dateToTimeString, dateToFieldString, timeStrToDate, toDate,
+	dateToString, dateToTimeString, dateToFieldString, timeStrToDate, secondsToReadable, toDate,
 	bytesToReadable
 };

package/functions.js

@@ -10,6 +10,50 @@ import checkers from "./checkers.js";
  * Functions
  *****************************************************/
 
+/* ---- Array ----------------------------------- */
+/**
+ * @function shuffle
+ *
+ * @param {Array<*>} array - The array to shuffle
+ * @returns {Array<*>} The shuffled array
+ *
+ * @example
+ * shuffle([1, 2, 3]) // return [2, 1, 3] or [3, 2, 1] or [1, 3, 2] or ...
+ */
+function shuffle(array) {
+	let arr = [...array], length = array.length, element, cache;
+
+	while (length) {
+		element = Math.floor(Math.random() * length--);
+
+		cache = arr[length];
+		arr[length] = arr[element];
+		arr[element] = cache;
+	}
+
+	return arr;
+}
+
+/**
+ * @function deepEqual
+ *
+ * @param {Object} obj1 - First object
+ * @param {Object} obj2 - Second object
+ * @returns {Boolean} Are the two objects deeply equal ?
+ *
+ * @example
+ * deepEqual({id: 1, title: "skibidi wap-pa-pa"}, {title: "skibidi wap-pa-pa", id: 1}) // return true
+ * deepEqual({id: 7, title: "skibidi wap-pa-pa"}, {title: "skibidi woosh-oosh-oosh", id: 1}) // return false
+ */
+function deepEqual(obj1, obj2) {
+	if (typeof obj1 === "object" && Object.keys(obj1).length > 0) {
+		return Object.keys(obj1).length === Object.keys(obj2).length &&
+			Object.keys(obj1).every(prop => deepEqual(obj1[prop], obj2[prop]));
+	} else {
+		return obj1 === obj2;
+	}
+}
+
 /* ---- Date ------------------------------------ */
 /**
  * @function dayDifference
@@ -51,6 +95,4 @@ function padLeft(value, pad = "00") {
  * Export
  *****************************************************/
 
-export default {
-	dayDifference, padLeft
-};
+export default { shuffle, deepEqual, dayDifference, padLeft };

package/package.json

@@ -1,28 +1,28 @@
-{
-  "name": "@evolis/evolis-library",
-  "version": "1.0.7",
-  "description": "Dependencies used both in Evolis API and Evolis UI",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/EmpireDemocratiqueDuPoulpe/evolis-library.git"
-  },
-  "main": "index.js",
-  "type": "module",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "keywords": [
-    "evolis",
-    "library"
-  ],
-  "author": "EmpireDemocratiqueDuPoulpe",
-  "license": "MIT",
-  "devDependencies": {
-    "eslint": "^7.30.0"
-  },
-  "bugs": {
-    "url": "https://github.com/EmpireDemocratiqueDuPoulpe/evolis-library/issues"
-  },
-  "homepage": "https://github.com/EmpireDemocratiqueDuPoulpe/evolis-library#readme",
-  "dependencies": {}
-}
+{
+  "name": "@evolis/evolis-library",
+  "version": "1.1.1b",
+  "description": "Dependencies used both in Evolis API and Evolis UI",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/EmpireDemocratiqueDuPoulpe/evolis-library.git"
+  },
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "evolis",
+    "library"
+  ],
+  "author": "EmpireDemocratiqueDuPoulpe",
+  "license": "MIT",
+  "devDependencies": {
+    "eslint": "^7.30.0"
+  },
+  "bugs": {
+    "url": "https://github.com/EmpireDemocratiqueDuPoulpe/evolis-library/issues"
+  },
+  "homepage": "https://github.com/EmpireDemocratiqueDuPoulpe/evolis-library#readme",
+  "dependencies": {}
+}