@evolis/evolis-library 1.0.6

package/.eslintrc.json

@@ -0,0 +1,17 @@
+{
+    "env": {
+        "browser": true,
+        "es2021": true
+    },
+    "extends": "eslint:recommended",
+    "parserOptions": {
+        "ecmaVersion": 12,
+        "sourceType": "module"
+    },
+    "rules": {
+        "indent": [ "error", "tab" ],
+        "linebreak-style": [ "error", "windows" ],
+        "quotes": [ "error", "double" ],
+        "semi": [ "error", "always" ]
+    }
+}

package/checkers.js

@@ -0,0 +1,231 @@
+/**
+ * @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} [includeEndpoint=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();
+}
+
+/*****************************************************
+ * 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 isEmail
+ *
+ *
+ * @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) {
+	if (isArray(password)) {
+		return password.every(pwd => isPasswordSafe(pwd, rules));
+	}
+
+	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},}$`;
+
+	const strongPwd = new RegExp(regex);
+	return strongPwd.test(password);
+}
+
+/*****************************************************
+ * Export
+ *****************************************************/
+
+export default {
+	isDefined, atLeastOneOf,
+	isString, isEmptyString, isBlankString, strInRange,
+	isNumber, isFloat,
+	isArray,
+	isDate,
+	isEmail,
+	isPasswordSafe
+};

package/converters.js

@@ -0,0 +1,164 @@
+/**
+ * @module converters
+ * @author EmpireDemocratiqueDuPoulpe
+ * @version 1.0.6
+ * @license MIT
+ */
+import checkers from "./checkers.js";
+import functions from "./functions.js";
+
+/*****************************************************
+ * Converters
+ *****************************************************/
+
+/* ---- Array ----------------------------------- */
+/**
+ * @function arrayToSerialComma
+ *
+ * @param {Array<*>} array - The array to convert
+ * @returns {string} A string formatted as a serial comma
+ *
+ * @example
+ * arrayToSerialComma([]) // return ""
+ * arrayToSerialComma(["one", 2, "three"]) // return "one, 2, three"
+ */
+function arrayToSerialComma(array) {
+	return checkers.isArray(array) && array.length > 0
+		? array.length === 1
+			? array[0]
+			: `${array.slice(0, -1).join(", ")} et ${array.slice(-1)}`
+		: "";
+}
+
+/* ---- Date ------------------------------------ */
+/**
+ * @function dateToString
+ *
+ * @param {Date} date - The date to convert
+ * @param {Boolean} [withTime=true] - Include time in the result
+ * @param {string} [locale="fr-FR"] - The locale used in the conversion. It may changed the returned string format
+ * @returns {string} A date formatted like "dd/MM/yyyy [hh:mm:ss]"
+ *
+ * @example
+ * dateToString(new Date()) // return "13/07/2021, 14:59:48"
+ */
+function dateToString(date, withTime = true, locale = "fr-FR") {
+	return withTime ? date.toLocaleString(locale) : date.toLocaleDateString(locale);
+}
+
+/**
+ * @function dateToTimeString
+ *
+ * @param {Date} date - The date to convert
+ * @param {string} [locale="fr-FR"] - The locale used in the conversion. It may changed the returned string format
+ * @returns {string} A date formatted like "hh:mm:ss"
+ *
+ * @example
+ * dateToTimeString(new Date()) // return "14:59:48"
+ */
+function dateToTimeString(date, locale = "fr-FR") {
+	return date.toLocaleTimeString(locale);
+}
+
+/**
+ * @function dateToFieldString
+ *
+ * @param {Date} date - The date to convert
+ * @returns {string} A date formatted like "yyyy-MM-dd"
+ *
+ * @example
+ * dateToFieldString(new Date()) // return "2021-07-13"
+ */
+function dateToFieldString(date) {
+	return checkers.isDate(date)
+		? `${date.getFullYear()}-${functions.padLeft(date.getMonth() + 1)}-${functions.padLeft(date.getDate())}`
+		: null;
+}
+
+/**
+ * @function timeStrToDate
+ *
+ * @param {string} time - The time to convert
+ * @param {string} [format="hh:mm"] - The format used for conversion
+ * @returns {Date} A date object filled with the time string provided
+ * @throws {Error} In case of invalid format/time string
+ *
+ * @example
+ * timeStrToDate("12:57") // works
+ * timeStrToDate("9:21") // works
+ * timeStrToDate("9::21") // error
+ */
+function timeStrToDate(time, format = "hh:mm") {
+	if (!checkers.isString(time) || !checkers.isString(format)) return null;
+
+	const now = new Date();
+	const timeSplit = time.split(":");
+	const formatSplit = format.split(":");
+
+	formatSplit.forEach((f, index) => {
+		if (index >= timeSplit.length) throw Error("timeStrToDate - Invalid format");
+		const t = parseInt(timeSplit[index], 10);
+
+		if (f === "hh") now.setHours(t);
+		else if (f === "mm") now.setMinutes(t);
+		else if (f === "ss") now.setSeconds(t);
+	});
+
+	return now;
+}
+
+/**
+ * @function toDate
+ *
+ * @param {*} d - The thing to convert
+ * @returns {Date|null|undefined|NaN} A date object, null/undefined if the provided value is null/undefined and NaN if it's not convertible.
+ *
+ * @example
+ * toDate(null) // return null
+ * toDate(new Date().toISOString()) // return a Date object
+ */
+function toDate(d) {
+	return (
+		d === null ? d :
+			d === undefined ? d :
+				d.constructor === Date ? d :
+					d.constructor === Array ? new Date(d[0],d[1],d[2]) :
+						d.constructor === Number ? new Date(d) :
+							d.constructor === String ? new Date(d) :
+								typeof d === "object" ? new Date(d.year,d.month,d.date) :
+									NaN
+	);
+}
+
+/* ---- Bytes ----------------------------------- */
+/**
+ * @function bytesToReadable
+ *
+ * @param {number} bytes - Bytes to convert
+ * @param {number} [decimals=2] - How many decimals
+ * @returns {string} The converted bytes size to the closest unit
+ *
+ * @example
+ * bytesToReadable(8000000) // return "7.63 MB"
+ * bytesToReadable(8000000, 0) // return "8 MB"
+ */
+function bytesToReadable(bytes, decimals = 2) {
+	if (bytes === 0) return "0 Bytes";
+
+	const k = 1024;
+	const dm = decimals < 0 ? 0 : decimals;
+	const sizes = ["Bytes", "KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB"];
+
+	const i = Math.floor(Math.log(bytes) / Math.log(k));
+	return `${parseFloat((bytes / Math.pow(k, i)).toFixed(dm))} ${sizes[i]}`;
+}
+
+/*****************************************************
+ * Export
+ *****************************************************/
+
+export default {
+	arrayToSerialComma,
+	dateToString, dateToTimeString, dateToFieldString, timeStrToDate, toDate,
+	bytesToReadable
+};

package/functions.js

@@ -0,0 +1,56 @@
+/**
+ * @module functions
+ * @author EmpireDemocratiqueDuPoulpe
+ * @version 1.0.5
+ * @license MIT
+ */
+import checkers from "./checkers.js";
+
+/*****************************************************
+ * Functions
+ *****************************************************/
+
+/* ---- Date ------------------------------------ */
+/**
+ * @function dayDifference
+ *
+ * @param {Date} start - Start date
+ * @param {Date} end - End date
+ * @returns {Number} How many days between these two dates
+ *
+ * @example
+ * dayDifference(new Date("07/14/2021"), new Date("07/18/2021")) // return 4
+ * dayDifference(new Date("07/14/2021"), new Date("07/01/2021")) // return -13
+ */
+function dayDifference(start, end) {
+	start.setHours(0, 0, 0, 0);
+	end.setHours(0, 0, 0, 0);
+
+	return Math.round((end.getTime() - start.getTime()) / (1000 * 3600 * 24));
+}
+
+/* ---- Other ----------------------------------- */
+/**
+ * @function padLeft
+ *
+ * @param {*} value - The array to pad
+ * @param {string} [pad="00"] - With what to pad
+ * @returns {string} The padded string
+ *
+ * @example
+ * padLeft(5, "000") // return "005"
+ * padLeft("796", "00") // return "796"
+ */
+function padLeft(value, pad = "00") {
+	return checkers.isDefined(value)
+		? (value.toString.length >= pad.length) ? value : (pad + value).slice(-pad.length)
+		: pad;
+}
+
+/*****************************************************
+ * Export
+ *****************************************************/
+
+export default {
+	dayDifference, padLeft
+};

package/index.js

@@ -0,0 +1,3 @@
+export { default as check } from "./checkers.js";
+export { default as convert } from "./converters.js";
+export { default as functions } from "./functions.js";

package/package.json

@@ -0,0 +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": {}
+}