@bbn/bbn 1.0.59 → 1.0.61

package/dist/fn/object/unique.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Removes duplicate values from an array.
+ *
+ * Takes an input array and returns a new array without duplicate values.
+ *
+ * @method   unique
+ * @global
+ * @example
+ * ```javascript
+ * bbn.fn.unique(["a", "b", "a", "b", "a", "b", "c", "c", "d"]);
+ * // ["a", "b", "c", "d"]
+ * ```
+ * @memberof bbn.fn
+ * @param    {Array} arr
+ * @returns  {Array}
+ */
+declare const unique: (arr: any[]) => any[];
+export { unique };

package/dist/fn/object/unique.js

@@ -0,0 +1,22 @@
+/**
+ * Removes duplicate values from an array.
+ *
+ * Takes an input array and returns a new array without duplicate values.
+ *
+ * @method   unique
+ * @global
+ * @example
+ * ```javascript
+ * bbn.fn.unique(["a", "b", "a", "b", "a", "b", "c", "c", "d"]);
+ * // ["a", "b", "c", "d"]
+ * ```
+ * @memberof bbn.fn
+ * @param    {Array} arr
+ * @returns  {Array}
+ */
+const unique = function (arr) {
+    return arr.filter(function (el, index, ar) {
+        return index === ar.indexOf(el);
+    });
+};
+export { unique };

package/dist/fn/string/baseName.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Returns the name of the element indicated by path given to it as an argument.
+ *
+ * @method   baseName
+ * @global
+ *
+ * @example
+ * ```javascript
+ * // "file.png"
+ * bbn.fn.baseName('folder/other_folder/file.png');
+ * ```
+ * @example
+ * ```javascript
+ * // "file"
+ * bbn.fn.baseName('folder/other_folder/file.png', '.png');
+ * ```
+ *
+ * @memberof bbn.fn
+ * @param    {String} path   The path from which the basename must be extracted
+ * @param    {String} suffix An optional suffix that will be removed from the basename
+ * @returns  {String} The basename of path
+ */
+declare const baseName: (path: string, suffix?: string) => string;
+export { baseName };

package/dist/fn/string/baseName.js

@@ -0,0 +1,39 @@
+import { isString } from "../type/isString";
+import { substr } from "./substr";
+/**
+ * Returns the name of the element indicated by path given to it as an argument.
+ *
+ * @method   baseName
+ * @global
+ *
+ * @example
+ * ```javascript
+ * // "file.png"
+ * bbn.fn.baseName('folder/other_folder/file.png');
+ * ```
+ * @example
+ * ```javascript
+ * // "file"
+ * bbn.fn.baseName('folder/other_folder/file.png', '.png');
+ * ```
+ *
+ * @memberof bbn.fn
+ * @param    {String} path   The path from which the basename must be extracted
+ * @param    {String} suffix An optional suffix that will be removed from the basename
+ * @returns  {String} The basename of path
+ */
+const baseName = function (path, suffix) {
+    if (path && isString(path)) {
+        let bits = path.split("/");
+        let res = bits.pop();
+        if (!suffix) {
+            return res;
+        }
+        let len = suffix.length;
+        if (res && substr(res, -len) === suffix) {
+            return substr(res, 0, res.length - len);
+        }
+    }
+    return "";
+};
+export { baseName };

package/dist/fn/string/br2nl.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Replaces the html <br> tag with new line characters '\ n' if present in the string.
+ *
+ * @method   br2nl
+ * @global
+ *
+ * @example
+ * ```javascript
+ * //"hello
+ * //world!"
+ * bbn.fn.br2nl('hello <br> world!')
+ * ```
+ *
+ * @memberof bbn.fn
+ * @param    string st
+ * @returns  {String}
+ */
+declare const br2nl: (st: any) => string;
+export { br2nl };

package/dist/fn/string/br2nl.js

@@ -0,0 +1,22 @@
+import { replaceAll } from "./replaceAll";
+/**
+ * Replaces the html <br> tag with new line characters '\ n' if present in the string.
+ *
+ * @method   br2nl
+ * @global
+ *
+ * @example
+ * ```javascript
+ * //"hello
+ * //world!"
+ * bbn.fn.br2nl('hello <br> world!')
+ * ```
+ *
+ * @memberof bbn.fn
+ * @param    string st
+ * @returns  {String}
+ */
+const br2nl = function (st) {
+    return replaceAll("<br />", "\n", replaceAll("<br/>", "\n", replaceAll("<br>", "\n", st)));
+};
+export { br2nl };

package/dist/fn/string/camelToCss.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Returns the string passed as an argument in camelize mode for css.
+ *
+ * @method   camelToCss
+ * @global
+ *
+ * @example
+ * ```javascript
+ * //"this-is-a-test"
+ * bbn.fn.camelToCss("thisIsATest");
+ * ```
+ *
+ * @memberof bbn.fn
+ * @param   {String} str
+ * @returns {String}
+ */
+declare const camelToCss: (str: any) => any;
+export { camelToCss };

package/dist/fn/string/camelToCss.js

@@ -0,0 +1,26 @@
+/**
+ * Returns the string passed as an argument in camelize mode for css.
+ *
+ * @method   camelToCss
+ * @global
+ *
+ * @example
+ * ```javascript
+ * //"this-is-a-test"
+ * bbn.fn.camelToCss("thisIsATest");
+ * ```
+ *
+ * @memberof bbn.fn
+ * @param   {String} str
+ * @returns {String}
+ */
+const camelToCss = function (str) {
+    return str
+        .replace(/([A-Z])/g, function (st) {
+        return "-" + st.toLowerCase();
+    })
+        .replace("/^./", function (st) {
+        return st.toLowerCase();
+    });
+};
+export { camelToCss };

package/dist/fn/string/camelize.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Returns the string passed as an argument in camelize mode.
+ *
+ * A string can be separated for example by a underscore, a dash or space;
+ * so the camelize function will automatically convert them to a single string.
+ *
+ * @method   camelize
+ * @global
+ *
+ * @example
+ * ```javascript
+ * //"thisIsATest"
+ * bbn.fn.camelize("this_is-a test");
+ * ```
+ * @memberof bbn.fn
+ * @param    {String} str
+ * @returns  {String}
+ */
+declare const camelize: (str: any) => any;
+export { camelize };

package/dist/fn/string/camelize.js

@@ -0,0 +1,27 @@
+/**
+ * Returns the string passed as an argument in camelize mode.
+ *
+ * A string can be separated for example by a underscore, a dash or space;
+ * so the camelize function will automatically convert them to a single string.
+ *
+ * @method   camelize
+ * @global
+ *
+ * @example
+ * ```javascript
+ * //"thisIsATest"
+ * bbn.fn.camelize("this_is-a test");
+ * ```
+ * @memberof bbn.fn
+ * @param    {String} str
+ * @returns  {String}
+ */
+const camelize = function (str) {
+    return str.replace(/^([A-Z])|[\s-](\w)/g, function (match, p1, p2, offset) {
+        if (p2) {
+            return p2.toUpperCase();
+        }
+        return p1.toLowerCase();
+    });
+};
+export { camelize };

package/dist/fn/string/correctCase.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Converts the first character of the string to uppercase.
+ *
+ * @method   correctCase
+ * @global
+ *
+ * @example
+ * ```javascript
+ * //"This is a test"
+ * bbn.fn.correctCase("this is a test");
+ * ```
+ *
+ * @memberof bbn.fn
+ * @param    {STring} str
+ * @returns  {String}
+ */
+declare const correctCase: (str: any) => any;
+export { correctCase };

package/dist/fn/string/correctCase.js

@@ -0,0 +1,20 @@
+/**
+ * Converts the first character of the string to uppercase.
+ *
+ * @method   correctCase
+ * @global
+ *
+ * @example
+ * ```javascript
+ * //"This is a test"
+ * bbn.fn.correctCase("this is a test");
+ * ```
+ *
+ * @memberof bbn.fn
+ * @param    {STring} str
+ * @returns  {String}
+ */
+const correctCase = function (str) {
+    return str.replace(/[A-z]{1}/, (c) => c.toUpperCase());
+};
+export { correctCase };

package/dist/fn/string/crc32.d.ts

@@ -0,0 +1,2 @@
+declare const crc32: (str: any) => number;
+export { crc32 };

package/dist/fn/string/crc32.js

@@ -0,0 +1,20 @@
+/**
+ * CRC32 implementation.
+ */
+const crc32Table = [];
+for (let i = 0; i < 256; i++) {
+    let c = i;
+    for (let j = 0; j < 8; j++) {
+        c = c & 1 ? 0xedb88320 ^ (c >>> 1) : c >>> 1;
+    }
+    crc32Table.push(c);
+}
+const crc32 = function (str) {
+    let crc = 0 ^ -1;
+    for (let i = 0; i < str.length; i++) {
+        const charCode = str.charCodeAt(i);
+        crc = (crc >>> 8) ^ crc32Table[(crc ^ charCode) & 0xff];
+    }
+    return (crc ^ -1) >>> 0; // Make sure the result is a 32-bit positive integer
+};
+export { crc32 };

package/dist/fn/string/dirName.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Returns the path of the folder containing the last hierarchical element of the path.
+ *
+ * @method   dirName
+ * @global
+ *
+ * @example
+ * ```javascript
+ * //"folder/other_folder"
+ * bbn.fn.dirName('folder/other_folder/file');
+ * ```
+ * @memberof bbn.fn
+ * @param    {String} path
+ * @returns  {String} path of the folder
+ */
+declare const dirName: (path: any) => string;
+export { dirName };

package/dist/fn/string/dirName.js

@@ -0,0 +1,33 @@
+import { isString } from "../type/isString";
+import { substr } from "./substr";
+/**
+ * Returns the path of the folder containing the last hierarchical element of the path.
+ *
+ * @method   dirName
+ * @global
+ *
+ * @example
+ * ```javascript
+ * //"folder/other_folder"
+ * bbn.fn.dirName('folder/other_folder/file');
+ * ```
+ * @memberof bbn.fn
+ * @param    {String} path
+ * @returns  {String} path of the folder
+ */
+const dirName = function (path) {
+    if (isString(path) && path) {
+        while (substr(path, path.length - 1) === "/") {
+            path = substr(path, 0, path.length - 1);
+        }
+        let pos = path.lastIndexOf("/");
+        if (pos > 0) {
+            return substr(path, 0, pos);
+        }
+        if (pos === 0) {
+            return "/";
+        }
+    }
+    return "";
+};
+export { dirName };

package/dist/fn/string/escapeDquotes.d.ts

@@ -0,0 +1,2 @@
+declare const escapeDquotes: (str: any) => any;
+export { escapeDquotes };

package/dist/fn/string/escapeDquotes.js

@@ -0,0 +1,8 @@
+import { isString } from "../type/isString";
+const escapeDquotes = function (str) {
+    if (!isString(str)) {
+        return str;
+    }
+    return str.replace(/"/g, '\\"');
+};
+export { escapeDquotes };

package/dist/fn/string/escapeRegExp.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Returns a string escaped.
+ *
+ * To escape the string by reducing the ambiguity between quotation marks and other characters used.
+ *
+ * @method   escapeRegExp
+ * @global
+ *
+ * @example
+ * ```javascript
+ * //"this\/is\/a\/test\/string"
+ * bbn.fn.escapeRegExp("this/is/a/test/string");
+ * ```
+ * @memberof bbn.fn
+ * @param    {String} str
+ * @returns  {String} string with escape
+ */
+declare const escapeRegExp: (str: any) => any;
+export { escapeRegExp };

package/dist/fn/string/escapeRegExp.js

@@ -0,0 +1,21 @@
+/**
+ * Returns a string escaped.
+ *
+ * To escape the string by reducing the ambiguity between quotation marks and other characters used.
+ *
+ * @method   escapeRegExp
+ * @global
+ *
+ * @example
+ * ```javascript
+ * //"this\/is\/a\/test\/string"
+ * bbn.fn.escapeRegExp("this/is/a/test/string");
+ * ```
+ * @memberof bbn.fn
+ * @param    {String} str
+ * @returns  {String} string with escape
+ */
+const escapeRegExp = function (str) {
+    return str.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, "\\$&");
+};
+export { escapeRegExp };

package/dist/fn/string/escapeSquotes.d.ts

@@ -0,0 +1,2 @@
+declare const escapeSquotes: (str: any) => any;
+export { escapeSquotes };

package/dist/fn/string/escapeSquotes.js

@@ -0,0 +1,8 @@
+import { isString } from '../type/isString';
+const escapeSquotes = function (str) {
+    if (!isString(str)) {
+        return str;
+    }
+    return str.replace(/'/g, "\\'");
+};
+export { escapeSquotes };

package/dist/fn/string/escapeTicks.d.ts

@@ -0,0 +1,2 @@
+declare const escapeTicks: (str: any) => any;
+export { escapeTicks };

package/dist/fn/string/escapeTicks.js

@@ -0,0 +1,8 @@
+import { isString } from '../type/isString';
+const escapeTicks = function (str) {
+    if (!isString(str)) {
+        return str;
+    }
+    return str.replace(/`/g, '\\`');
+};
+export { escapeTicks };

package/dist/fn/string/escapeUrl.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Escapes a URL or a file path, optionally adding parameters (get type, to append to the URL without the first separator).
+ *
+ * @param {*} url
+ * @param {*} params
+ * @returns
+ */
+declare const escapeUrl: (url: any, params: any) => string;
+export { escapeUrl };

package/dist/fn/string/escapeUrl.js

@@ -0,0 +1,47 @@
+import { each } from "../loop/each";
+import { dirName } from "./dirName";
+import { baseName } from "./baseName";
+import { isString } from "../type/isString";
+/**
+ * Escapes a URL or a file path, optionally adding parameters (get type, to append to the URL without the first separator).
+ *
+ * @param {*} url
+ * @param {*} params
+ * @returns
+ */
+const escapeUrl = function (url, params) {
+    let st = "";
+    if (url.match("^(http|https)://")) {
+        st += "http";
+        url = url.substring(4);
+        if (url.substr(0, 1) === "s") {
+            st += "s";
+            url = url.substring(1);
+        }
+        st += "://";
+        url = url.substring(3);
+    }
+    each(dirName(url).split("/"), (a) => {
+        st += encodeURIComponent(a) + "/";
+    });
+    let base = baseName(url);
+    let sep = "?";
+    let existingParams = "";
+    if (base.indexOf(sep)) {
+        let tmp = base.split("?");
+        sep = "&";
+        existingParams = "?" + tmp[1];
+        base = tmp[0];
+    }
+    if (params && isString(params)) {
+        if (params.match("^(\\&|\\?)")) {
+            params = params.substring(1);
+        }
+        params = sep + params;
+    }
+    else {
+        params = "";
+    }
+    return st + encodeURIComponent(base) + existingParams + params;
+};
+export { escapeUrl };

package/dist/fn/string/fileExt.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Gets the extension from a file's name.
+ *
+ * The extension is returned in lower case; if the filename has no extension
+ * or is not valid it will return an empty string.
+ *
+ * @method   fileExt
+ * @global
+ *
+ * @example
+ * ```javascript
+ * // "txt"
+ * bbn.fn.fileExt('my_file.txt')
+ * ```
+ *
+ * @example
+ * ```javascript
+ * // "txt"
+ * bbn.fn.fileExt('MY_FILE.TXT')
+ * ```
+ *
+ * @example
+ * ```javascript
+ * // ""
+ * bbn.fn.fileExt('MY_FILE')
+ * ```
+ *
+ * @example
+ * ```javascript
+ * // ""
+ * bbn.fn.fileExt('.MY_FILE')
+ * ```
+ *
+ * @param   {String} filename
+ * @returns {String} The file's extension
+ */
+declare const fileExt: (filename: any) => any;
+export { fileExt };

package/dist/fn/string/fileExt.js

@@ -0,0 +1,47 @@
+import { isString } from "../type/isString";
+/**
+ * Gets the extension from a file's name.
+ *
+ * The extension is returned in lower case; if the filename has no extension
+ * or is not valid it will return an empty string.
+ *
+ * @method   fileExt
+ * @global
+ *
+ * @example
+ * ```javascript
+ * // "txt"
+ * bbn.fn.fileExt('my_file.txt')
+ * ```
+ *
+ * @example
+ * ```javascript
+ * // "txt"
+ * bbn.fn.fileExt('MY_FILE.TXT')
+ * ```
+ *
+ * @example
+ * ```javascript
+ * // ""
+ * bbn.fn.fileExt('MY_FILE')
+ * ```
+ *
+ * @example
+ * ```javascript
+ * // ""
+ * bbn.fn.fileExt('.MY_FILE')
+ * ```
+ *
+ * @param   {String} filename
+ * @returns {String} The file's extension
+ */
+const fileExt = function (filename) {
+    if (filename && isString(filename)) {
+        let bits = filename.split(".");
+        if (bits[0] && bits.length > 1) {
+            return bits[bits.length - 1].toLowerCase();
+        }
+    }
+    return "";
+};
+export { fileExt };

package/dist/fn/string/format.d.ts

@@ -0,0 +1,2 @@
+declare const format: (str: any) => any;
+export { format };

package/dist/fn/string/format.js

@@ -0,0 +1,14 @@
+import { checkType } from '../type/checkType';
+const format = function (str) {
+    let args = Array.prototype.slice.call(arguments, 1);
+    if (args.length) {
+        let i = 0;
+        return str.replace(/\%([d|s])/g, (match, type) => {
+            let tmp = args[i++];
+            checkType(tmp, type === 'd' ? 'number' : 'string', bbn._("The value doesn't correspond to the format"));
+            return tmp;
+        });
+    }
+    return str;
+};
+export { format };

package/dist/fn/string/formatBytes.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Formats the value given in bytes.
+ * @method   formatBytes
+ * @global
+ * @example
+ * //"52.23 MB"
+ * ``` javascript
+ * bbn.fn.formatBytes(54764654);
+ * ```
+ * @memberof bbn.fn
+ * @returns  {String}
+ */
+declare const formatBytes: (bytes: any, decimals?: number) => string;
+export { formatBytes };

package/dist/fn/string/formatBytes.js

@@ -0,0 +1,20 @@
+/**
+ * Formats the value given in bytes.
+ * @method   formatBytes
+ * @global
+ * @example
+ * //"52.23 MB"
+ * ``` javascript
+ * bbn.fn.formatBytes(54764654);
+ * ```
+ * @memberof bbn.fn
+ * @returns  {String}
+ */
+const formatBytes = function (bytes, decimals = 2) {
+    if (!bytes) {
+        return '0 B';
+    }
+    const k = 1024, s = ['B', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'], i = Math.floor(Math.log(bytes) / Math.log(k));
+    return parseFloat((bytes / Math.pow(k, i)).toFixed(decimals < 0 ? 0 : decimals)) + ' ' + s[i];
+};
+export { formatBytes };

package/dist/fn/string/formatSize.d.ts

@@ -0,0 +1,2 @@
+declare const formatSize: (st: any, noValid: any) => any;
+export { formatSize };

package/dist/fn/string/formatSize.js

@@ -0,0 +1,12 @@
+import { isNumber } from '../type/isNumber';
+import { isString } from '../type/isString';
+const formatSize = function (st, noValid) {
+    if (isNumber(st)) {
+        return st + 'px';
+    }
+    if (isString(st)) {
+        return st;
+    }
+    return noValid ? false : 'auto';
+};
+export { formatSize };