@evolis/evolis-library 1.0.6 → 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Alexis Lecomte
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,130 @@
+# Evolis Library
+A simple package that groups together frequently used functions in front-end and in back-end at Evolis.
+
+## 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.
+
+## 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):
+
+`$ 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
+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*
+
+## License
+
+[MIT](https://github.com/EmpireDemocratiqueDuPoulpe/evolis-library/blob/main/LICENSE).

package/checkers.js

@@ -81,7 +81,7 @@ function isBlankString(value) {
  * @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} [includeEndpoint=true] - Include the min and max bounds in the range
+ * @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.
  *
@@ -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
  *****************************************************/
@@ -192,25 +202,26 @@ export const passwordRules = {
 };
 
 /**
- * @function isEmail
- *
+ * @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 = passwordRules) {
+function isPasswordSafe(password, rules) {
+	const usedRules = rules ? { ...passwordRules, ...rules } : passwordRules;
+
 	if (isArray(password)) {
-		return password.every(pwd => isPasswordSafe(pwd, rules));
+		return password.every(pwd => isPasswordSafe(pwd, usedRules));
 	}
 
 	let regex = "";
 
-	if (rules.mustContain.lowerCase) regex += "(?=.*[a-z])";
-	if (rules.mustContain.upperCase) regex += "(?=.*[A-Z])";
-	if (rules.mustContain.digit) regex += "(?=.*[0-9])";
-	if (rules.mustContain.special) regex += `(?=.*[\\"'!?@#$£%^&:;<>\\[\\]()\\\\\\-_+=*.])`;
-	regex += `.{${rules.minLength},}$`;
+	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);
@@ -225,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,30 @@ 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;
+}
+
 /* ---- Date ------------------------------------ */
 /**
  * @function dayDifference
@@ -33,7 +57,7 @@ function dayDifference(start, end) {
 /**
  * @function padLeft
  *
- * @param {*} value - The array to pad
+ * @param {*} value - The value to pad
  * @param {string} [pad="00"] - With what to pad
  * @returns {string} The padded string
  *
@@ -51,6 +75,4 @@ function padLeft(value, pad = "00") {
  * Export
  *****************************************************/
 
-export default {
-	dayDifference, padLeft
-};
+export default { shuffle, dayDifference, padLeft };

package/package.json

@@ -1,28 +1,28 @@
-{
-  "name": "@evolis/evolis-library",
-  "version": "1.0.6",
-  "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.0",
+  "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": {}
+}